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 formula-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
This specification is an extension of the XBRL Specification [XBRL 2.1]. It specifies syntax for labels that are more flexible than those defined in the XBRL Specification. Labels in the XBRL specification are limited in that they are only useful for labelling concepts. In contrast, generic labels can be used to associate a label with any element. Generic labels provide a syntactic foundation for XBRL extension specifications.
1 Introduction
1.1 Background
1.2 Relationship to other work
1.3 Language independence
1.4 Terminology
1.5 Document conventions (non-normative)
1.6 Namespaces and namespace prefixes
2 Syntax
2.1 Generic label
2.1.1 Element-label relationships
A Normative schema
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history (non-normative)
F Errata corrections in this document
1 Namespaces and namespace prefixes
XML schema
element-label relationship
generic label
rfc2119 terminology
The XBRL Specification [XBRL 2.1] defines syntax for labels. That syntax is the label link. Labels in label links can only be used to label XBRL concepts. This restriction prevents XBRL extension specifications from using the labels defined in the XBRL Specification to label newly defined data structures.
For example, labels in label links cannot be used to label custom role declarations. Nor can they be used to provide labels for information contained in the XLink resources that will be defined in XBRL extension specifications.
To overcome this limitation, this document defines the syntax for generic labels.
Generic labels are conformant with the XBRL Specification [XBRL 2.1]. This document makes no statement about:
This specification also does not define any XLink resource roles for use with generic labels.
This specification extends the labelling capabilities of the XBRL Specification [XBRL 2.1].
This specification depends upon the XBRL Specification [XBRL 2.1]. This specification depends upon the XBRL Generic Link Specification [GENERIC LINKS]. In the event of any conflicts between this specification and the specifications upon which it depends, this specification does not prevail.
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.
Where this document refers to an XML schema, it is referring to an XML document [XML] that contains a declaration of a schema that is compliant with XML Schema [XML SCHEMA STRUCTURES].
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].
Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].
Namespace prefixes [XML NAMES] will be used
for elements and attributes in
the form ns:name where ns is the
namespace prefix and name is the local name.
Throughout this specification, the mappings
from namespace prefixes to actual namespaces is consistent
with
Table
1.
The prefix column in Table 1 is non normative. The namespace URI column is normative.
| Prefix | Namespace URI |
|---|---|
label
|
http://xbrl.org/2008/label
|
xbrlle
|
http://xbrl.org/2008/label/error
|
eg
|
http://example.com/
|
fn
|
http://www.w3.org/2005/xpath-functions
|
link
|
http://www.xbrl.org/2003/linkbase
|
xbrli
|
http://www.xbrl.org/2003/instance
|
xfi
|
http://www.xbrl.org/2008/function/instance
|
xbrldi
|
http://xbrl.org/2006/xbrldi
|
xbrldt
|
http://xbrl.org/2005/xbrldt
|
xl
|
http://www.xbrl.org/2003/XLink
|
xlink
|
http://www.w3.org/1999/xlink
|
xs
|
http://www.w3.org/2001/XMLSchema
|
xsi
|
http://www.w3.org/2001/XMLSchema-instance
|
gen
|
http://xbrl.org/2008/generic
|
variable
|
http://xbrl.org/2008/variable
|
iso4217
|
http://www.xbrl.org/2003/iso4217
|
This specification only provides a textual declaration of syntax constraints when those constraints are not expressed by the normative schema supplied with this specification.
Explanations of elements and attributes are only supplied when explanations are not already provided in other specifications.
Unless explicitly stated otherwise, a reference to a specific element MUST be read as a reference to that element or to any element in its substitution group.
A generic label is declared by a
<label:label>
element.
A generic label is an
XLink resource.
When contained within an XBRL extended link, a generic label provides documentation for the elements that it is related to by element-label relationships.
The syntax for the
<label:label>
element is defined by the normative schema supplied with this specification.
All generic label resources MUST have an
@xml:lang attribute
identifying the language used for the content of the label. The value of
the
@xml:lang attribute MUST conform to
XML language identification rules.
An element-label relationship is a relationship between an XML element and a generic label expressed by an XLink arc.
To declare an element-label relationship an XLink arc MUST:
http://xbrl.org/arcrole/2008/element-label
The arcrole value,
http://xbrl.org/arcrole/2008/element-label,
is declared in the normative schema for generic labels.
Element-label relationships MUST be expressed by generic arcs as indicated by the restrictions imposed by the arcrole declaration in the normative schema.
Undirected cycles are allowed in networks of element-label arcs, to allow sharing of label resources.
The following is the XML schema provided as part of this specification. This is normative. Non-normative versions (which should be identical to these except for appropriate comments indicating their non-normative status) are also provided as separate files for convenience of users of the specification.
NOTE: (non-normative) 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:
http://www.xbrl.org/2008/ - during the drafting process for
this specification this directory should contain a copy of the
most recent published version of the schema at
http://www.xbrl.org/2008/generic-label.xsd.
For convenience, the normative schema contains the following resource role declarations:
http://www.xbrl.org/2008/role/labelhttp://www.xbrl.org/2008/role/verboseLabelhttp://www.xbrl.org/2008/role/terseLabelhttp://www.xbrl.org/2008/role/documentationThis 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 Formula Working Group.
| Date | Author | Details |
|---|---|---|
| 18 December 2007 | Geoff Shuetrim |
First internal working draft created. |
| 25 April 2007 | Geoff Shuetrim |
Added a date to the element-reference arcrole to support easier versioning. |
| 07 May 2007 | Geoff Shuetrim |
Removed the requirement that relationships be defined in terms of the concrete arc elements that express them. This entailed also removing the element-label arcrole declaration from the normative schema. |
| 24 July 2007 | Hugh Wallis |
Edited for public working draft publication. |
| 05 November 2007 | Geoff Shuetrim |
Converted the specification to XML format. Added in the definitions and the hyperlinks to the relevant sections of the normative schema. Reinstated the element-label arcrole declaration, thus forcing all element-label relationships to be expressed with generic arcs. Eliminated the erroneous references to references instead of labels in the introduction. |
| 12 November 2007 | Geoff Shuetrim |
Linked all of the external terminology references back to bibliographic citations. |
| 31 January 2008 | Geoff Shuetrim |
Standardised the format of the hyperlinks to the normative schema. |
| 01 February 2008 | Geoff Shuetrim |
Corrected the element-label arcrole values to reflect the values in the normative schema as suggested by Masatomo Goto. |
| 15 December 2008 | Geoff Shuetrim |
Fixed formatting problems with hyperlinks. Updated references to the latest errata-corrected version of the XBRL 2.1 specification. |
| 07 February 2010 | Victor Morilla |
Added constraint on the presence of the xml:lang attribute on generic label elements. Changed status to draft proposed edited recommendation. |
| 21 March 2011 | Herm Fischer |
Changed element-label arcrole to allow undirected cycles (e.g., sharing of labels). |
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 Formula Working Group up to and including 21 March 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.
| Number | Date | Sections | Details |
|---|---|---|---|
| 1. | 07 February 2010 | Section 2.1 | Added constraint on the presence of the xml:lang attribute on generic label elements. |
| 2. | 21 March 2011 | Section 2.1.1 | Changed element-reference arcrole to allow undirected cycles (e.g., sharing of labels). |