Copyright ©2011 XBRL International Inc., All Rights Reserved.
Circulation of this Recommendation is unrestricted. This document is normative. Recipients are invited to submit comments to dtram@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
This document describes the structure of the XBRL International Data Type Registry. The Data Type Registry is an online listing of data types that have been identified as potentially having wide utility. The Registry contains structured information about their purpose, usage and any intended impact on XBRL instance validation.
1 Goals
1.1 Relationship to other work
1.2 Terminology
1.3 Language
1.4 Document conventions
1.4.1 Typographic conventions
1.4.1.1 Definition notation
1.4.1.2 Footnote notation
1.4.1.3 Element and attribute notation
1.4.2 Formatting conventions
2 Data Model
3 Hosting on the XBRL.org website
4
Status of Data Types in the DTR and Implications for Software
A Schema
A.1 dtr.xsd
B Sample dtr document (non-normative)
C References
D Intellectual property status (non-normative)
E Acknowledgements (non-normative)
F Document history (non-normative)
G Errata corrections in this document
1 A normative example
2 A non-normative example
3 An example of poor usage
BPB
CR
DTR
DTRAM
ISC
IWD
PWD
SWG
TAPWG
TRTF
XSB
abstract element, bind, concept, concrete element, context, Discoverable Taxonomy Set (DTS), duplicate items, duplicate tuples, element, entity, equal, essence concept, fact, instance, item, least common ancestor, linkbase, period, taxonomy, tuple, unit, taxonomy schema, child, parent, sibling, grandparent, uncle, ancestor, XBRL instance, c-equal, p-equal, s-equal, u-equal, v-equal, x-equal, minimally conforming XBRL processor, fully conforming XBRL processor and any other terms not specifically defined elsewhere in this document but which are used and defined in the XBRL 2.1 specification.
referee
XBRL provides a set of standard data types that may appear in XBRL instances. These include those specified in [XBRL 2.1]. As XBRL applications emerge, new, non-standard data types having common and useful semantics are being proposed. The goal of the XBRL Data Type Registry (hereinafter "DTR") is to be a public, online data set that documents these non-standard data types and their usage. Additions and other changes to the DTR, like other XBRL International work products, will proceed through a series of steps whose goal is to maximise the utility and longevity of the new data types and the instances that use them. This process is documented in [DTR PROCESS].
This document pertains to XBRL as defined in the XBRL Specification [XBRL 2.1].
The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, in this specification, are to be interpreted as described in [IETF RFC 2119].
abstract element, bind, concept, concrete element, context, Discoverable Taxonomy Set (DTS), duplicate items, duplicate tuples, element, entity, equal, essence concept, fact, instance, item, least common ancestor, linkbase, period, taxonomy, tuple, unit, taxonomy schema, child, parent, sibling, grandparent, uncle, ancestor, XBRL instance, c-equal, p-equal, s-equal, u-equal, v-equal, x-equal, minimally conforming XBRL processor, fully conforming XBRL processor and any other terms not specifically defined elsewhere in this document but which are used and defined in the XBRL 2.1 specification. are as defined by [XBRL 2.1] .
BPB refers to the XBRL International Best Practices Board .
CR refers to a Candidate Recommendation of XBRL International.
ISC refers to the XBRL International Steering Committee .
IWD refers to an Internal Working Draft of XBRL International.
DTR refers to the Data Types Registry that is the subject of this specification.
DTRAM refers to the Data Types Registry Approval Manager.
PWD refers to a Public Working Draft of XBRL International.
Referee is either the SWG, TRTF or TAPWG when performing an evaluation requested by the DTRAM.
SWG refers to the XBRL International Base Specification and Maintenance Working Group.
TAPWG refers to the Taxonomy Architecture Practice Working Group set up by the BPB.
TRTF refers to the Taxonomy Review Task Force set up by the BPB.
XSB refers to the XBRL International Standards Board .
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
All documentation supporting a registry entry MUST be provided in English, and MAY be provided in additional languages.
Comments which are informative, but not essential to the understanding of the point at hand, are provided in footnotes. All footnotes are non-normative.
When referring to a specific element, it will be identified by
its namespace prefix and local name. For example, the root
element for a specification container element would be referred to as
<variable:generalVariable>
.
Attributes are also identified by their local name and, where
appropriate, their namespace prefix. Attributes are
distinguished from elements by prefixing them by an
@
symbol. Thus,
@id
refers to the attribute with the name id
.
When referring to any attribute, so long as it has a specific
namespace, the local name is replaced by an asterisk (
*
).
Thus, the notation
@xml:*
specifies any attribute
in the namespace
http://www.w3.org/XML/1998/namespace
.
The following highlighting is used for normative technical material in this document:
Text of the normative example.
The following highlighting is used for non-normative examples in this document:
Text of the helpful example.
Next paragraph of the helpful example.
Example 3 shows the formatting for non-normative examples of poor, discouraged or disallowed usage.
The example itself.
The data model of the DTR is a list of each data type definition augmented with additional indicators and information needed by developers.
Field | Type | Explanation | Example |
---|---|---|---|
Data Type Namespace | anyURI | This is the namespace of the data type being defined.
If the semantics of a data type in the registry have been changed from any earlier entry of a type with the same local name and with a status of ACK or RR (and therefore which subsequently appears with a status of NIE or RR) then it MUST have a namespace that is different from that of any earlier entry. |
|
Data Type Name | NCName | This is the local name of the data type being defined.
A data type in the registry MUST NOT have the same local name as any other type in the registry which has a status that is not NIE or RR, regardless of namespace. |
|
Status | {CR, REC, NIE, PROPOSED, ACK, RR} |
The XBRL International status of this data type.
|
|
Authoritative Location | anyURI | URI of fragment in a schema where the definition resides. |
|
Version Date | date | Effective date of this version of the data type; all versions of the same data type with earlier dates are effectively superseded. |
|
Requirements | XHTML mixed |
A statement of the requirements that gave
rise to this data type. Requirements in different
languages are distinguished using the
@xml:lang
attribute and an ISO 639 language code
[ISO].
|
|
Definition | XHTML mixed |
The meaning of the data type described in the
same way as if it were part of an XBRL
Specification. Definitions in different
languages are distinguished using the
@xml:lang
attribute and an ISO 639 language code
[ISO]
.
|
|
Version of XBRL | token | The XBRL version for which this an extension. Note that a data type could be "promoted" into a standard data type in some future version of the specification. |
|
Minimum Edition Date | date | The XBRL edition date and beyond for which this is an extension. |
|
The latest version of the DTR will be placed at a fixed
location on the xbrl.org website and will be the file at
the URL
http://www.xbrl.org/dtr/dtr.xml
.
Each version will also be permanently archived in a
subdirectory whose name contains the date on which it
became effective (e.g.
http://www.xbrl.org/dtr/2009-01-22/dtr.xml
).
This is analogous to the archival convention for
specification schemas.
The definition of any data type that has the status of REC in the DTR is normative.
The definitions of any data types with any other status are non-normative and are provided for information only. If a data type has the status of ACK it is not intended that it should ever proceed on the track to having REC status. It MAY have a status in a closed environment that imposes certain requirements on software that is customised for that particular environment, however XBRL International makes no representations whatsoever about such data types.
Software vendors are NOT obliged to implement support for any REC data type in order to continue to claim that they support the base specification.
It is expected that software vendors will make claims regarding which additional data types they support. They MUST point to successful exercise of any relevant conformance suite tests in order to substantiate such claims.
The following is the XML schema corresponding to the data model described in Section 2. It is normative. Non-normative versions (which should be identical to this except for appropriate comments indicating their non-normative status) are also provided as separate files for convenience of users of the specification.
Following the schema maintenance policy of XBRL International, it is the intent (but is not guaranteed) that the location of non-normative versions of these schemas on the web will be as follows: While any
The following is an example of a dtr (as defined by the schema in Appendix A above). It contains only a single entry to illustrate the definition of a data type.
<?xml version="1.0" encoding="UTF-8"?>
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).
This document could not have been written without the contributions of many people.
Date | Author | Details |
---|---|---|
05 July 2010 | Hugh Wallis |
Initial version based on LRR |
14 September 2010 | Hugh Wallis |
Updated to reflect comments received on the CR of 2010-07-05. |
05 January 2011 | Hugh Wallis |
Updated to clarify section 4 language prior to advancing to REC. |
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 Link Role Registry Approval Manager up to and including 22 February 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.