Copyright ©2009 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.
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 Attributes in the XML namespace
2.2 Element: registry
2.2.1 Element: lastUpdated
2.2.2 Element: name
2.2.3 Element: documentation
2.2.4 Element: entry
2.2.4.1 Element: added
2.2.4.2 Element: status
2.2.4.3 Element: url
2.3 Element: owner
2.3.1 Element: name
2.3.2 Element: affiliation
2.3.3 Element: email
2.3.4 Element: assumedOwnership
2.3.5 Element: relinquishedOwnership
2.4 Element: revision
2.5 Element: test
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
This specification is defines a syntax for an XML document that contains location information about entries in a registry.
This specification is intended to support the creation maintenance and publication of XBRL-related registries, including the XBRL function registry.
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 |
|---|---|
reg
|
http://xbrl.org/2008/registry
|
rege
|
http://xbrl.org/2008/registry/error
|
xml
|
http://www.w3.org/XML/1998/namespace
|
xlink
|
http://www.w3.org/1999/xlink
|
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 .
Any attribute in the XML namespace (http://www.w3.org/XML/1998/namespace) MAY be
used on any element within a registry or within an XML
resource that is referenced by a registry entry.
The
@xml:lang attribute MAY be used to indicate the language used to express
information in the registry, as per the XML Specification [XML].
The
@xml:base attribute MAY be used when resolving URIs
as per the XML Base Specification [XMLBASE].
The
<reg:registry>
element
is the root element of a registry.
A registry is a
<reg:registry>
element
containing a list of zero or more registry entries
The
<reg:lastUpdated>
element
contains a
@moment attribute whose value is the
instant on which an entry in the registry was last updated.
The
<reg:documentation>
element
contains either a URL that resolves to documentation of the registry or it contains
XHTML [XHTML] markup documenting the registry.
If the documentation is provided as a URL, then the URL is specified using a
<reg:url>
element that follows the syntax rules specified in
Section
2.2.4.3.
The
<reg:entry>
element
is an abstract element that serves as a placeholder for concrete
registry entries.
A registry entry is an element in the substitution group
for the
<reg:entry>
element that is a child of a
a registry.
The
<reg:added>
element
contains a
@moment attribute whose value is the
instant on which an entry in the registry was last updated.
The
<reg:status>
element
contains one of the following values to indicate a particular status
of the entry in the registry:
IWD - Internal working draftDPWD - Draft public working draftPWD - Public working draftCR - Candidate recommendationREC - Recommendation
When published in the public domain, a registry MUST only contain
entries that have a status of PWD, CR
or REC. All other entries will be removed from the registry
prior to publication.
The
<reg:url>
element
contains an
@xlink:type attribute that equals simple and
an
@xlink:href attribute that contains a URI that MUST
resolve to the resource that identified by the registry entry.
The
<reg:url>
element MAY contain string content documenting
the nature of the resource that the URL is linking to.
Registry entries can include a list of one or more owners.
The
<reg:owner>
element
contains information about an owner of a resource that can have
registry entry.
The mandatory
@id attribute on a
<reg:owner>
element
is used to reference the owner from the revision history for a resource that
is referenced by a registry entry.
The
<reg:assumedOwnership>
element
contains a
@moment attribute that is the instant that the owner
assumed ownership of the resource.
The
<reg:relinquishedOwnership>
element
contains a
@moment attribute that is the instant that the owner
relinquished ownership of the resource.
The
<reg:revision>
element
contains information about a revision to a resource that can have
registry entry.
A
<reg:revision>
element
contains either a URL that resolves to documentation of the registry or it contains
XHTML [XHTML] markup documenting the nature of the revision.
All
<reg:revision>
elements have an
@on attribute that records
the moment at which the revision was finalised.
All
<reg:revision>
elements have a
@by attribute
that contains an IDREF to the ID of the owner responsible for making the revision.
The
<reg:test>
element
is abstract.
All conformance suite test resources that are referenced
from within the XML resources that have entries in an XBRL registry
MUST be in the substitution group for the
<reg:test>
element.
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/registry.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 FWG.
| Date | Author | Details |
|---|---|---|
| 17 January 2008 | Geoff Shuetrim |
First internal working draft created. |
| 29 January 2008 | Geoff Shuetrim |
Incorporated element definitions and explanations based on the normative schema. |
| 30 January 2008 | Geoff Shuetrim |
Fixed XML Schema errors for simple content model type definitions. Fixed the incorrect element name for the child elements in the owners content model. |
| 31 January 2008 | Geoff Shuetrim |
Adapted hyperlinks to use XLink simple link syntax. |
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 FWG up to and including 22 June 2009. 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.