Copyright ©2008 XBRL International Inc., All Rights Reserved.
Circulation of this Recommendation is unrestricted. This document is normative. Recipients are invited to submit comments to lrrag@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 Link Role Registry. The Link Role Registry is an online listing of XLink role and arc role attribute values 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.
This document is an update to version 1.0 of the Link Role Registry, adding new status types and separating the structure of the registry itself from the definition of the process whereby entries may be added to, changed, or removed from the registry.
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
Normative Status of Roles in the LRR and Software
A Schema
A.1 lrr.xsd
B Sample lrr 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
ISC
IWD
LRR
LRRAG
PWD
SIPWG
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
rfc2119 terminology
XBRL provides a set of standard roles and arc roles (hereinafter generally referred to as "roles") that may appear in XBRL instances and linkbases. These include those specified in [XBRL 2.1] , [DIMENSIONS] and any additional modules that are XBRL RECOMMENDATIONs. As XBRL applications emerge, new, non-standard roles having common and useful semantics are peing proposed. The goal of the XBRL Link Role Registry (hereinafter "LRR") is to be a public, online data set that documents these non-standard roles and their usage. Additions and other changes to the LRR, 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 roles and the taxonomies that use them. This process is documented in [LRR PROCESS].
This document pertains to XBRL as defined in the XBRL Specification [XBRL 2.1] and additional modules such as [DIMENSIONS].
At the date of publication of this document it is referenced by [FRTA]. It may or may not be referenced by future updates to that document.
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.
LRR refers to the Link Role Registry that is the subject of this specification.
LRRAG refers to the Link Role Registry Approval Group.
PWD refers to a Public Working Draft of XBRL International.
Referee is either the SWG, TRTF, SIPWG, or TAPWG when performing an evaluation requested by the LRRAG.
SIPWG refers to the Software interoperability Practice Working Group set up by the BPB.
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 XSB.
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 role 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 LRR is a list of each role type and arc role type definitions augmented with additional indicators and information needed by developers.
Field | Type | Explanation | Example |
---|---|---|---|
Role URI | URI | This is the role URI being defined. |
|
Role Type | {arcrole, role} | Defines whether arc role or role. |
|
Status | {PWD, CR, REC, NIE, PROPOSED, IWD, ACK, RR} |
The XBRL International status of this role.
|
|
Authoritative Location | URI | URI of fragment in a schema where the definition resides. |
|
Version Date | Date | Effective date of this version of the role; all versions of the same role with earlier dates are effectively superseded. |
|
Requirements | XHTML mixed |
A statement of the requirements that gave
rise to this role. 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 role 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]
.
|
The label for a concept when one of the facts using that concept is presented to users as a restatement of a previous period result. |
Attributes | List of NCNames with optional namespace | For arc roles, identifies any attributes that are allowed or required; not present for roles. |
<attributes> <attribute use="required"> </attributes>
weight
</attribute> |
Version of XBRL | Token | The XBRL version for which this an extension. Note that a role could be "promoted" into a standard role in some future version of the specification. |
|
Minimum Edition Date | Date | The XBRL edition date and beyond for which this is an extension. |
|
Impacts Taxonomy Validation | Boolean |
Whether elements using this role impact XBRL
taxonomy validation in ways not captured by
roleType
or
arcRoleType
declarations.
|
|
Impacts Instance Validation | Boolean |
Whether elements using this role impact XBRL
instance validation.
|
|
Validation | XHTML mixed |
A textual or pseudocode specification of the
intended impact on XBRL validation of
instances. If Instance Validation Impact is
"optional" (i.e. the relevant field has the
value
false ) this is empty.
|
If an instance of the concept at the
source of an arc with arcrole
|
Conformance Suite | URI |
A URI locating a conformance suite
illustrating valid and invalid usage. Only
required if additional validation is
specified.
The URI need not have www.xbrl.org
as its host part.
|
|
The latest version of the LRR will be placed at a fixed
location on the xbrl.org website and will be the file at
the URL
http://www.xbrl.org/lrr/lrr.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/lrr/2008-01-22/lrr.xml
).
This is analogous to the archival convention for
specification schemas.
Once a role has the status of REC in the LRR it shall have the same normative status as any role documented in the version of the specification that it is extending.
Roles with other stati are non-normative and are provided for information only. If a role 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 roles.
Software vendors are NOT obliged to implement support for any REC role in order to continue to claim that they support the base specification.
It is expected that software vendors will make claims regarding which additional roles 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
Note that the LRR does not duplicate the information already in the usedOn and definition elements and cyclesAllowed attribute of the arcrole/roleType declaration at the authoritative location. Also note that, although the URIs in the attributes of these elements are not required to be absolute, they will be in the official LRR. This is necessary because it is available from more than one location.
To accomodate possible future expansion of the
information in the registry, both the
role
and
arcrole
elements have an open content model that allows them to
have any number of additional child elements in any
namespace.
The following is an example of an lrr (as defined by the schema in Appendix A above). It contains only a single entry each to illustrate the definition of a role and an arcrole.
<?xml version="1.0" encoding="UTF-8"?>
<
?xml-stylesheet type="text/xsl"
href="lrr2html.xsl"?
>
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 including the participants in the Link Role Registry Approval Group.
Date | Author | Details |
---|---|---|
22 July 2008 | Hugh Wallis |
|
25 July 2008 | Walter Hamscher |
Edited text that was attempting to explain that the LRR does not contain information redundant with the authoritative declaration. |
28 July 2008 | Walter Hamscher |
Removed comments and changed SUB to PROPOSED. |
29 July 2008 | Hugh Wallis |
Noted PWD was effectively deprecated due to changes in the process. Added SIPWG to Referee definition |
30 July 2008 | Hugh Wallis |
Editorial for publication as REC
Changed namespace back to
|
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 Group up to and including 31 July 2008. 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.