# XBRL Registry Specification 1.0

## Recommendation 22 June 2009

Copyright ©2009 XBRL International Inc., All Rights Reserved.

This version:
  <http://www.xbrl.org/Specification/registry/REC-2009-06-22/registry-REC-2009-06-22.html>
Editor:
  Geoff Shuetrim, Galexy <geoff@galexy.net>

## Status

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.

## Abstract

This specification is defines a syntax for an XML document that contains location information about entries in a registry.

# 1 Introduction

This specification is defines a syntax for an XML document that contains location information about entries in a registry.

## 1.1 Background

This specification is intended to support the creation maintenance and publication of XBRL-related registries, including the XBRL function registry.

## 1.2 Relationship to other work

This specification does not depend on any other XBRL specification.

## 1.3 Language independence

The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.

## 1.4 Terminology

This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.

## 1.5 Document conventions (non-normative)

Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].

## 1.6 Namespaces and namespace prefixes

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.

Table 1: Namespaces and namespace prefixes

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`

# 2 Syntax

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 .

## 2.1 Attributes in the XML namespace

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].

## 2.2 Element: registry

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

### 2.2.1 Element: lastUpdated

The `<reg:lastUpdated>` element contains a `@moment` attribute whose value is the instant on which an entry in the registry was last updated.

### 2.2.2 Element: name

The `<reg:name>` element contains the name of the registry.

### 2.2.3 Element: documentation

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.

### 2.2.4 Element: entry

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.

#### 2.2.4.1 Element: added

The `<reg:added>` element contains a `@moment` attribute whose value is the instant on which an entry in the registry was last updated.

#### 2.2.4.2 Element: status

The `<reg:status>` element contains one of the following values to indicate a particular status of the entry in the registry:

- `IWD` - Internal working draft
- `DPWD` - Draft public working draft
- `PWD` - Public working draft
- `CR` - Candidate recommendation
- `REC` - 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.

#### 2.2.4.3 Element: url

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.

## 2.3 Element: owner

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.

### 2.3.1 Element: name

The `<reg:name>` element contains the name of the owner.

### 2.3.2 Element: affiliation

The `<reg:affiliation>` element contains the affiliation of the owner.

### 2.3.3 Element: email

The `<reg:email>` element contains the email address of the owner.

### 2.3.4 Element: assumedOwnership

The `<reg:assumedOwnership>` element contains a `@moment` attribute that is the instant that the owner assumed ownership of the resource.

### 2.3.5 Element: relinquishedOwnership

The `<reg:relinquishedOwnership>` element contains a `@moment` attribute that is the instant that the owner relinquished ownership of the resource.

## 2.4 Element: revision

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.

## 2.5 Element: test

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.

# Appendix A Normative schema

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:

1. While any schema is the most current RECOMMENDED version and until it is superseded by any additional errata corrections a non-normative version will reside on the web in the directory `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.
2. A non-normative version of each schema as corrected by any update to the RECOMMENDATION will be archived in perpetuity on the web in a directory that will contain a unique identification indicating the date of the update.

<schema
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:reg="http://xbrl.org/2008/registry"
xmlns:xlink="http://www.w3.org/1999/xlink" targetNamespace="http://xbrl.org/2008/registry" elementFormDefault="qualified" xsi:schemaLocation="http://www.w3.org/2001/XMLSchema http://www.w3.org/2001/XMLSchema.xsd">
<import namespace="http://www.w3.org/1999/xlink" schemaLocation="http://www.xbrl.org/2003/xlink-2003-12-31.xsd"/>
<element id="xml-registry" name="registry">
<complexType>
<sequence>
<element id="xml-last-updated" name="lastUpdated" type="reg:date.elt.type"/>
<element id="xml-name" name="name" type="reg:string.elt.type"/>
<element id="xml-documentation" name="documentation" type="reg:documentation.elt.type" minOccurs="0"/>
<sequence maxOccurs="unbounded">
<element id="xml-entry" name="entry" type="reg:entry.elt.type"/>
</sequence>
</sequence>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
</element>
<complexType name="date.elt.type">
<attributeGroup ref="reg:date.attribute.group"/>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType name="entry.elt.type">
<sequence>
<element id="xml-entry-added" name="added" type="reg:date.elt.type"/>
<!-- URL MUST be resolved against the effective xml:base to get an absolute URI -->
<element id="xml-entry-status" name="status" type="reg:status.elt.type"/>
<element id="xml-entry-url" name="url" type="reg:url.elt.type"/>
</sequence>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType name="string.elt.type">
<simpleContent>
<extension base="string">
<attributeGroup ref="reg:common.attribute.group"/>
</extension>
</simpleContent>
</complexType>
<complexType name="url.elt.type">
<simpleContent>
<extension base="string">
<attribute ref="xlink:type" use="required" fixed="simple"/>
<attribute ref="xlink:href" use="required"/>
<attributeGroup ref="reg:common.attribute.group"/>
</extension>
</simpleContent>
</complexType>
<complexType name="status.elt.type">
<simpleContent>
<extension base="reg:status.simple.type">
<attributeGroup ref="reg:common.attribute.group"/>
</extension>
</simpleContent>
</complexType>
<simpleType name="status.simple.type">
<restriction base="token">
<enumeration value="IWD"/>
<enumeration value="DPWD"/>
<enumeration value="PWD"/>
<enumeration value="CR"/>
<enumeration value="REC"/>
</restriction>
</simpleType>
<attributeGroup name="date.attribute.group">
<attribute name="moment" type="dateTime"/>
</attributeGroup>
<attributeGroup name="common.attribute.group">
<attribute name="id" type="ID"/>
<anyAttribute namespace="http://www.w3.org/XML/1998/namespace" processContents="lax"/>
</attributeGroup>
<complexType name="documentation.elt.type">
<choice>
<element name="url" type="reg:url.elt.type"/>
<any namespace="http://www.w3.org/1999/xhtml" processContents="skip" minOccurs="0" maxOccurs="unbounded"/>
</choice>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType name="owners.elt.type">
<sequence>
<element name="owner" type="reg:owner.elt.type" maxOccurs="unbounded"/>
</sequence>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType id="xml-owner" name="owner.elt.type">
<sequence>
<element id="xml-owner-name" name="name" type="reg:string.elt.type"/>
<element id="xml-owner-affiliation" name="affiliation" type="reg:string.elt.type"/>
<element id="xml-owner-email" name="email" type="reg:string.elt.type"/>
<element id="xml-owner-assumed-ownership" name="assumedOwnership" type="reg:date.elt.type"/>
<element id="xml-owner-relinquished-ownership" name="relinquishedOwnership" type="reg:date.elt.type" minOccurs="0"/>
</sequence>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType name="revisions.elt.type">
<sequence>
<element name="revision" type="reg:revision.elt.type" maxOccurs="unbounded"/>
</sequence>
<attributeGroup ref="reg:common.attribute.group"/>
</complexType>
<complexType id="xml-revision" name="revision.elt.type">
<complexContent>
<extension base="reg:documentation.elt.type">
<attribute name="on" type="dateTime"/>
<attribute name="by" type="IDREF"/>
</extension>
</complexContent>
</complexType>
<element id="xml-test" name="test" abstract="true"/>
</schema>

# Appendix B References

VARIABLES
  XBRL International Inc.. "XBRL Variables 1.0"
  Phillip Engel, Herm Fischer, Victor Morilla, Jim Richards, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
  (See http://www.xbrl.org/Specification/variables/REC-2009-06-22/variables-REC-2009-06-22.html)
XHTML
  W3C (World Wide Web Consortium). " XHTML™ 1.0 The Extensible HyperText Markup Language (Second Edition)"
  (See http://www.w3.org/TR/xhtml1/)
XML
  W3C (World Wide Web Consortium). "Extensible Markup Language (XML) 1.0 (Fourth Edition)"
  Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, Eve Maler, and François Yergeau.
  (See http://www.w3.org/TR/REC-xml/)
XML NAMES
  W3C (World Wide Web Consortium). "Namespaces in XML 1.0 (Second Edition)"
  Tim Bray, Dave Hollander, Andrew Layman, and Richard Tobin.
  (See http://www.w3.org/TR/REC-xml-names/)
XML SCHEMA STRUCTURES
  W3C (World Wide Web Consortium). "XML Schema Part 1: Structures Second Edition"
  Henry S. Thompson, David Beech, Murray Maloney, and Noah Mendelsohn.
  (See http://www.w3.org/TR/xmlschema-1/)
XMLBASE
  W3C (World Wide Web Consortium). "XML Base"
  Johnathan Marsh.
  (See http://www.w3.org/TR/xmlbase/)

# Appendix C Intellectual property status (non-normative)

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).

# Appendix D Acknowledgements (non-normative)

This document could not have been written without the contributions of many people including the participants in the FWG.

# Appendix E Document history (non-normative)

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.

# Appendix F Errata corrections in this document

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.