Copyright ©2011 XBRL International Inc., All Rights Reserved.
Circulation of this Working Group Note is unrestricted. Other documents may supersede this document. Recipients are invited to submit comments to email@example.com, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
This document is a Working Group Note, based on the Versioning Conformance Suite for versioning specifications - Base and Concept Basic and Concept Extended as published on the http://www.xbrl.org website on 31 July 2010. It provides important information to understand file structure and file content of the Conformance Suite and their usage.
This document provides an overview of content provided through the Versioning conformance suite. The Versioning conformance suite is modular equal to the Versioning specification itself. The file and folder conventions described in this document are valid for all versioning modules across this conformance suite.
The conformance suite is divided into two parts. The first part verifies the correct creation (folder: creation) and the second part the correct consumption (folder: consumption) of a versioning report. Creation and consumption test cases are structured by versioning module. One subfolder for each versioning module named equally as the versioning module. In the creation folder underneath each versioning module requirements as defined by the versioning requirement document are listed when applying to the specific versioning module. In the consumption part subfolders of the versioning modules are a list of error codes respectively.
Example for creation of a versioning report:
Example for consumption of a versioning report:
\trunk\versioningReport\conf\consumption\[versioning module]\[error code]\
Subfolders of the creation folder are named by the requirement number – requirement title which is derived from the XBRL Versioning Requirements [XVR].
Inside each requirement / error code subfolder is a [folder-name].xml file. This is the description of the particular test case and contains all required information to run the conformance suite test case. The xml file can be rendered in any web browser in a human readable form. The test case file provides information about the location of the versioning report and the from-DTS and to-DTS. If further information is required in the testing scenario from the application performing the test case the information required can be found within the versioning report or the narrative description within the test file. In bellows example to create a versioning report with a user defined category the test case does state the QName of the category explicitly. It is just mentioned in the narrative <description> element. The testing program has to extract this information from the referenced versioning report in order to run the test in an automated fashion. Below an example from versioning requirement caseU1504-add-change-category:
Each [folder-name].xml file provides information about fromDTS and toDTS through the <schema> elements within the file (/testcase/variation/data/schema/text() ). For the creation part of the conformance suite fromDTS and toDTS are the starting point. The expected output of the versioning report creation process is indicated through the <versioingReport> element which holds the location of the versioning report output document (/testcase/variation/result/versioningReport). Against this versioning report the output of the software can be validated in the creation part. For consuming test cases the <versiongReport> element is the starting point. When loading the versioning report the error as defined in the <name> tag should be thrown. All paths within the document are relative to the [folder-name].xml file itself.
The versioning conformance suite ALWAYS states all versioning events for the given fromDTS and toDTS even so if this contradicts the statement written in the versioning specification that "a versioning creator does not have to provide all versioning events in the versioning report". Please be also aware that the documentation which is attached to versioning events in the output report is NOT required by the versioning specification. This additional documentation is provided in generic label linkbase to make it more obvious what has been documented and what the versioning report is trying to achieve.
\trunk\versioningReport\conf\[creation/consumption]\[versioning module]\[requirement/error code]\report\[fromDTS-toDTS]-generic-linkbase.xml
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to XBRL International or XBRL organizations, except as required to translate it into languages other than English. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
This document and the information contained herein is provided on an "AS IS" basis and XBRL INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
The attention of users of this document is directed to the possibility that compliance with or adoption of XBRL International specifications may require use of an invention covered by patent rights. XBRL International shall not be responsible for identifying patents for which a license may be required by any XBRL International specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. XBRL International specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. XBRL International takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
|23 May 2011||
Document imported to XII standard specification format.
This appendix contains a list of the errata that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Versioning Working Group up to and including 23 May 2011. Hyperlinks to relevant e-mail threads may only be followed by those who have access to the relevant mailing lists. Access to internal XBRL mailing lists is restricted to members of XBRL International Inc.
No errata have been incorporated into this document.