Copyright © XBRL International Inc., All Rights Reserved.
Circulation of this Candidate Recommendation is unrestricted. This document is normative. Other documents may supersede this document. Recipients are invited to submit comments to oim@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
1 Introduction
1.1 Terminology
2 Definitions
2.1 SQName
2.2 Unit string representation
A References
B Intellectual property status (non-normative)
C Document History (non-normative)
D Errata Corrections incorporated in this document
1 Examples of standard string representation of units
The XBRL Open Information Model provides a syntax-independent definition of the content of an XBRL report. A number of alternative syntaxes are defined as concrete representations of the model. In order to achieve consistency between these representations, this document provides a number of definitions which may be used across these different formats.
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].
The keywords expanded name, NCName and QName are to be interpreted as described in the XML Names specification [XML Names].
The keywords Unit Core Aspect are to be interpreted as described in the Open Information Model [OIM].
The Open Information Model makes extensive use of expanded names ([XML Names]) to provide globally unique identifiers. These are a namespace URI/localname pair. In order to reduce size and improve readability, it is convenient to use a QName-like mechanism for representing these (and some other) values, where the globally unique namespace-URI is replaced with a compact, document-scoped prefix. The mechanism used is referred to as an SQName ("Simplified QName").
An SQName is a compact, colon-separated represention of a URI/value pair, where a short, document-scoped, prefix is used to represent the URI.
An SQName has the following format:
prefix:localname
The prefix MUST be a valid NCName and MUST correspond to a key in the prefix map, and the namespace URI for identifier is taken from the corresponding value in the map.
Unlike QNames, the localname may be any string, including those containing the colon (":") character; the prefix and localname in an SQName are separated by the first colon character. Where an SQName is used to represent an expanded name, the localname will be a valid NCName.
A prefix map is a set of prefix/URI pairs that is used to resolve the prefix component of an SQName to a URI. The location and format of a prefix map is defined by the representation in which it is used, but it MUST conform to the following constraints:
SQNames are similar to QNames appearing within XML documents, but have the following differences, intended to make consumption simpler:
The Unit Core Aspect defines units in terms of the combination of QNames by defining a list of numerators and a list of denominators. Reflecting this in concrete representations can be somewhat cumbersome, particularly as analysis the structure of units is expected to be a relatively uncommon operation compared to simply comparing units for equivalence, or rendering them to a user.
This section defines a standardised string representation for units, allowing units to be captured using a single, simple string value. This has the property that, provided that a consistent set of namespace prefixes are used, a given unit will have the single representation meaning that equivalence of units can be determined by a simple string comparison.
This representation is obtained as follows:
Whitespace is not permitted anywhere in the string representation, and the use of SQNames ensures that a 1:1 mapping between prefixes and namespaces is available thus ensuring that equivalent units appearing within the same document are represented with the same string.
Lexicograhic order means ordered based on comparison of Unicode code point values of each character.
The following list show a set of valid unit string representations.
iso4217:EURiso4217:EUR/xbrli:sharesutr:m*utr:mutr:kg/(utr:m*utr:m)(utr:m*utr:m*utr:m)/utr:SThis 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).
| Date | Author | Details |
|---|---|---|
| 14 December 2016 | Paul Warren |
Candidate Recommendation. The contents of this specification were previously included in Public Working Drafts of the xBRL-JSON and OIM specifications. |
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 Specification Maintenance Working Group (SWG) up to and including 14 December 2016. 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.