Copyright © 2010, 2011, XBRL International Inc., All Rights Reserved.
Circulation of this Recommendation is unrestricted. This document is normative. Recipients are invited to submit comments to rendering-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
The preferred label feature of presentation relationships has been a key feature in establishing networks of XBRL relationships that have multiple relationships from a source concept to label in the same base set such a concept appearing in a set of line items as each of a beginning and ending balance. However this feature has only been available in standard presentation relationships. Current use of XBRL makes extensive use of other relationships instead, such as dimensional and generic relationships, where the same semantic can not yet be expressed. This specification introduces the preferred label feature for all relationships.
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 The 'gpl:preferredLabel' attribute on arcs
A Normative schema
A.1 Generic Preferred Label 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
element-terget relationship
preferredLabel
The lack of the preferred label mechanism of presentation relationships, for base sets of other standard and generic relationships, makes it awkward to fully utilize these XBRL base sets when presentation relationships are not required. This specification provides a facility to use the preferred label mechanism on all relationships.
The XBRL 2.1 specification
[XBRL 2.1]
defines the @preferredLabel attribute for base sets of standard presentation link relationships.
This attribute can have an xsd:anyURI role value which MUST match one of the labels having the same
@xlink:role value in label linkbase.
With this attribute, a target concept of a relationship with this preferred label will be
modeled and rendered with the appropriate label instead of a default label (which is usually standard label).
This attribute is only defined for relationships of the standard presentation link.
Introduction of the XBRL Dimensions 1.0 specification [DIMENSIONS] has experienced a change in modeling of relationships to primarily utilize relationships of the standard definition link. This creates a requirement to have a similar mechanism to the preferred label of relationships of the standard presentation link that can be used in standard definition links. (This specification also provides for this feature on relationships of generic links.)
The Generic Preferred Label Specification is the specification introduces a single attribute that is equivalent
to the @preferredLabel of relationships of the standard presentation link.
The Dimensional Specification is a modelling specification that utilizes relationships of the XBRL 2.1 specification definition links [XBRL 2.1]. With this specification, users are able to model various relationships needing the preferred label feature with other relationships. For example, a primary item relationship of line items, in the standard definition link, can use the generic preferred label to distinguish between relationships from the same source primary item to target primary items that are starting and ending balance line items.
This specification depends upon the XBRL Specification [XBRL 2.1] and the XBRL Dimensions Specification [DIMENSIONS]. 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.
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 |
|---|---|
gpl |
http://xbrl.org/2013/preferred-label |
gple |
http://xbrl.org/2013/preferred-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 generic preferred label defines one attribute. The attribute is designed to be able to appear in any inter-concept or element-target relationships other than presentation link.
A element-target relationship is a relationship which could be represented by an arc whose xlink:to attribute value has a reference to any element.
This section defines one fundamental XML component declaration - that is attribute declaration. The attribute defined here will be used in most of the xlink's arc element other than presentation link.
A generic preferred label attribute is declared by the
@gpl:preferredLabel attribute.
The @gpl:preferredLabel attribute is a URI that MAY be supplied on all arcs in standard presentation,
calculation, and definition links, and in generic links, to indicate the most appropriate kind of label to use
when presenting the arc’s child concept (and element when the arc was in generic links).
When a @gpl:preferredLabel attribute is used on a relationship of a standard arc element (e.g., one of <link:presentationArc> ,
<link:calculationArc> , or <link:definitionArc> ),
the value of the @gpl:preferredLabel attribute MUST be equal to an @xlink:role attribute value on a label
resource (in a <link:labelLink> extended link) that is the target of a concept-label arc from the subject arc’s source concept.
When the @gpl:preferredLabel attribute is used on a relationship in a generic link [GENERIC LINKS],
the value of the @gpl:preferredLabel attribute MUST be equal to an @xlink:role attribute value on a generic label
resource (in a generic link extended link) [GENERIC LABELS] that is the target of a element-label arc from the subject arc’s source element.
Error code gple:missingPreferredLabel must be raised when the relationship of a standard arc's source concept, or a relationship of a generic link arc's source element, does not have a corresponding label with a matching @xlink:role.
A role-matching label SHOULD be provided for any language for which labels of other roles (such as any standard labels) are provided.
XBRL processors MAY use the value of the @gpl:preferredLabel attribute to choose between
different labels that have been associated with the one concept. This can be particularly useful when a given
concept is used in a variety of ways within a DTS. For example, cash can be used in the balance sheet and as
the starting and ending balances in a cash flow statement. Each appearance of the concept in a set of presentation
links MAY use this feature to indicate a different preferred label.
The @xlink:role attribute value on the label extended link containing the preferred label and the @xlink:role attribute value on the
extended link containing the specified arc element do not have to be equal.
Error code gple:duplicatePreferredLabel must be raised when the the same source concept or source element has multiple effective relationships in the same base set that are equivalent except for order and the target label resource. (This prevents an instance fact from appearing twice in the same set of line items, such as would be due to multiple beginning balance or total label roles).
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/2013/ - 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/2013/preferred-label.xsd.
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 Formula Working Group.