The presentation of this document has been augmented to identify changes from a previous version. Three kinds of changes are highlighted: new, added text, changed text, and deleted text.
Copyright © 2002 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document use, and software licensing rules apply.
This draft is for public discussion.
XML namespaces provide a simple method for qualifying element and attribute names used in Extensible Markup Language documents by associating them with namespaces identified by URI references.
This document is the first draft of a new 1.1 revision of the Namespaces in XML specification. It will incorporate several errata to the 1.0 specification, and one substantive change: the provision of a mechanism to "undeclare" prefixes. This document does not yet incorporate the errata; they will be added in a future draft. There is a requirements document for this revision [Requirements].
This is a W3C Working Draft for review by W3C Members and other interested parties. It has been produced as part of the XML Activity. It is a draft document and may be updated, replaced or made obsolete by other documents at any time. It is inappropriate to use W3C Working Drafts as reference material or to cite them as other than "work in progress".
This is work in progress and does not imply endorsement by the W3C membership. A list of current W3C Recommendations and other technical documents, including Working Drafts and Notes, can be found at http://www.w3.org/TR.
Comments and discussion on this document should be sent to firstname.lastname@example.org.
1 Motivation and Summary
1.1 A Note on Notation and Usage
2 Declaring Namespaces
3 Qualified Names
4 Using Qualified Names
5 Applying Namespaces to Elements and Attributes
5.1 Namespace Scoping
5.2 Namespace Defaulting
5.3 Uniqueness of Attributes
6 Conformance of Documents
A The Internal Structure of XML Namespaces (Non-Normative)
A.1 The Insufficiency of the Traditional Namespace
A.2 XML Namespace Partitions
A.3 Expanded Element Types and Attribute Names
A.4 Unique Expanded Attribute Names
B Acknowledgements (Non-Normative)
We envision applications of Extensible Markup Language (XML) where a single XML document may contain elements and attributes (here referred to as a "markup vocabulary") that are defined for and used by multiple software modules. One motivation for this is modularity; if such a markup vocabulary exists which is well-understood and for which there is useful software available, it is better to re-use this markup rather than re-invent it.
Such documents, containing multiple markup vocabularies, pose problems of recognition and collision. Software modules need to be able to recognize the tags and attributes which they are designed to process, even in the face of "collisions" occurring when markup intended for some other software package uses the same element type or attribute name.
These considerations require that document constructs should have universal names, whose scope extends beyond their containing document. This specification describes a mechanism, XML namespaces, which accomplishes this.
[Definition: An XML namespace is a collection of names, identified by a URI reference [RFC2396], which are used in XML documents as element types and attribute names. ] XML namespaces differ from the "namespaces" conventionally used in computing disciplines in that the XML version has internal structure and is not, mathematically speaking, a set. These issues are discussed in A The Internal Structure of XML Namespaces.
[Definition: URI references which identify namespaces are considered identical when they are exactly the same character-for-character.] Note that URI references which are not identical in this sense may in fact be functionally equivalent. Examples include URI references which differ only in case, or which are in external entities which have different effective base URIs.
Names from XML namespaces may appear as qualified names, which contain a single colon, separating the name into a namespace prefix and a local part. The prefix, which is mapped to a URI reference, selects a namespace. The combination of the universally managed URI namespace and the document's own namespace produces identifiers that are universally unique. Mechanisms are provided for prefix scoping and defaulting.
URI references can contain characters not allowed in names, so cannot be used directly as namespace prefixes. Therefore, the namespace prefix serves as a proxy for a URI reference. An attribute-based syntax described below is used to declare the association of the namespace prefix with a URI reference; software which supports this namespace proposal must recognize and act on these declarations and prefixes.
Note that many of the nonterminals in the productions in this specification are defined not here but in the XML specification [XML]. When nonterminals defined here have the same names as nonterminals defined in the XML specification, the productions here in all cases match a subset of the strings matched by the corresponding ones there.
In this document's productions,
NSC is a "Namespace Constraint",
one of the rules that documents conforming to this specification must follow.
Note that all Internet domain names used in
examples, with the exception of
w3.org, are selected
at random and should not be taken as having any import.
[Definition: A namespace is declared using a family of reserved attributes. Such an attribute's name must either be xmlns or have xmlns: as a prefix. These attributes, like any other XML attributes, may be provided directly or by default. ]
|||::=||[NSC: Leading "XML"]|
|||::=||/* An XML Name, minus the ":" */|
[Definition: The attribute's value, a URI reference, is the namespace name identifying the namespace.] The namespace name, to serve its intended purpose, should have the characteristics of uniqueness and persistence. It is not a goal that it be directly usable for retrieval of a schema (if any exists). An example of a syntax that is designed with these goals in mind is that for Uniform Resource Names [RFC2141]. However, it should be noted that ordinary URLs can be managed in such a way as to achieve these same goals.
[Definition: If the attribute name matches PrefixedAttName, then the NCName gives the namespace prefix, used to associate element and attribute names with the namespace name in the attribute value in the scope of the element to which the declaration is attached.] The attribute value may be an empty string.
[Definition: If the attribute name matches DefaultAttName, then the namespace name in the attribute value is that of the default namespace in the scope of the element to which the declaration is attached.] The attribute value may an empty string. Default namespaces and overriding of declarations are discussed in 5 Applying Namespaces to Elements and Attributes.
An example namespace declaration, which associates the
namespace prefix edi with the namespace name
<x xmlns:edi='http://ecommerce.org/schema'> <!-- the "edi" prefix is bound to http://ecommerce.org/schema for the "x" element and contents --> </x>
[Definition: In XML documents conforming to this specification, some names (constructs corresponding to the nonterminal Name) may be given as qualified names, defined as follows: ]
The Prefix provides the namespace prefix part of the qualified name, and must be associated with a namespace URI reference in a namespace declaration. [Definition: The LocalPart provides the local part of the qualified name.]
Note that the prefix functions only as a placeholder for a namespace name. Applications should use the namespace name, not the prefix, in constructing names whose scope extends beyond the containing document.
In XML documents conforming to this specification, element types are given as qualified names, as follows:
|||::=||[NSC: Prefix Declared]|
|||::=||[NSC: Prefix Declared]|
|||::=||[NSC: Prefix Declared]|
An example of a qualified name serving as an element type:
<x xmlns:edi='http://ecommerce.org/schema'> <!-- the 'price' element's namespace is http://ecommerce.org/schema --> <edi:price units='Euro'>32.18</edi:price> </x>
Attributes are either namespace declarations or their names are given as qualified names:
|[NSC: Prefix Declared]|
An example of a qualified name serving as an attribute name:
<x xmlns:edi='http://ecommerce.org/schema'> <!-- the 'taxClass' attribute's namespace is http://ecommerce.org/schema --> <lineItem edi:taxClass="exempt">Baby food</lineItem> </x>
Namespace constraint: Prefix Declared
The namespace prefix, unless it is
xmlns, must have been
declared in a namespace declaration
attribute in either the start-tag of the element where the prefix
is used or in an an ancestor element (i.e. an element in whose
prefixed markup occurs).
Furthermore, the attribute value in the innermost such declaration
must not be empty.
xml is by definition bound to the
xmlns is used only for namespace bindings
and is not itself bound to any namespace name.
This constraint may lead to operational difficulties in the case where the namespace declaration attribute is provided, not directly in the XML document entity, but via a default attribute declared in an external entity. Such declarations may not be read by software which is based on a non-validating XML processor. Many XML applications, presumably including namespace-sensitive ones, fail to require validating processors. For correct operation with such applications, namespace declarations must be provided either directly or via default attributes declared in the internal subset of the DTD.
Element names and attribute types are also given as qualified names when they appear in declarations in the DTD:
The namespace declaration is considered to apply to the element where it is specified and to all elements within the content of that element, unless overridden by another namespace declaration with the same NSAttName part:
<?xml version="1.0"?> <!-- all elements here are explicitly in the HTML namespace --> <html:html xmlns:html='http://www.w3.org/TR/REC-html40'> <html:head><html:title>Frobnostication</html:title></html:head> <html:body><html:p>Moved to <html:a href='http://frob.com'>here.</html:a></html:p></html:body> </html:html>
Multiple namespace prefixes can be declared as attributes of a single element, as shown in this example:
<?xml version="1.0"?> <!-- both namespace prefixes are available throughout --> <bk:book xmlns:bk='urn:loc.gov:books' xmlns:isbn='urn:ISBN:0-395-36341-6'> <bk:title>Cheaper by the Dozen</bk:title> <isbn:number>1568491379</isbn:number> </bk:book>
The attribute value in a namespace declaration for a prefix may be empty. This has the effect, within the scope of the declaration, of removing any association of the prefix with a namespace name. Further declarations may re-declare the prefix again:
<?xml version="1.0"?> <x xmlns:n1="http://www.w3.org"> <n1:a/> <!-- legal; the prefix n1 is bound to http://www.w3.org --> <x xmlns:n1=""> <n1:a/> <!-- illegal; the prefix n1 is not bound here --> <x xmlns:n1="http://www.w3.org"> <n1:a/> <!-- legal; the prefix n1 is bound again --> </x> </x> </x>
A default namespace is considered to apply to the element where it is declared (if that element has no namespace prefix), and to all elements with no prefix within the content of that element. If the URI reference in a default namespace declaration is empty, then unprefixed elements in the scope of the declaration are not considered to be in any namespace. Note that default namespaces do not apply directly to attributes.
<?xml version="1.0"?> <!-- elements are in the HTML namespace, in this case by default --> <html xmlns='http://www.w3.org/TR/REC-html40'> <head><title>Frobnostication</title></head> <body><p>Moved to <a href='http://frob.com'>here</a>.</p></body> </html>
<?xml version="1.0"?> <!-- unprefixed element types are from "books" --> <book xmlns='urn:loc.gov:books' xmlns:isbn='urn:ISBN:0-395-36341-6'> <title>Cheaper by the Dozen</title> <isbn:number>1568491379</isbn:number> </book>
A larger example of namespace scoping:
<?xml version="1.0"?> <!-- initially, the default namespace is "books" --> <book xmlns='urn:loc.gov:books' xmlns:isbn='urn:ISBN:0-395-36341-6'> <title>Cheaper by the Dozen</title> <isbn:number>1568491379</isbn:number> <notes> <!-- make HTML the default namespace for some commentary --> <p xmlns='urn:w3-org-ns:HTML'> This is a <i>funny</i> book! </p> </notes> </book>
The default namespace can be set to the empty string. This has the same effect, within the scope of the declaration, of there being no default namespace.
<?xml version='1.0'?> <Beers> <!-- the default namespace is now that of HTML --> <table xmlns='http://www.w3.org/TR/REC-html40'> <th><td>Name</td><td>Origin</td><td>Description</td></th> <tr> <!-- no default namespace inside table cells --> <td><brandName xmlns="">Huntsman</brandName></td> <td><origin xmlns="">Bath, UK</origin></td> <td> <details xmlns=""><class>Bitter</class><hop>Fuggles</hop> <pro>Wonderful hop, light alcohol, good summer beer</pro> <con>Fragile; excessive variance pub to pub</con> </details> </td> </tr> </table> </Beers>
In XML documents conforming to this specification, no tag may contain two attributes which:
have identical names, or
have qualified names with the same local part and with prefixes which have been bound to namespace names that are identical.
For example, each of the
bad start-tags is illegal in the
<!-- http://www.w3.org is bound to n1 and n2 --> <x xmlns:n1="http://www.w3.org" xmlns:n2="http://www.w3.org" > <bad a="1" a="2" /> <bad n1:a="1" n2:a="2" /> </x>
However, each of the following is legal, the second because the default namespace does not apply to attribute names:
<!-- http://www.w3.org is bound to n1 and is the default --> <x xmlns:n1="http://www.w3.org" xmlns="http://www.w3.org" > <good a="1" b="2" /> <good a="1" n1:a="2" /> </x>
In XML documents which conform to this specification, element types and attribute names must match the production for QName and must satisfy the "Namespace Constraints".
An XML document conforms to this specification if all other tokens in the document which are required, for XML conformance, to match the XML production for Name, match this specification's production for NCName.
The effect of conformance is that in such a document:
All element types and attribute names contain either zero or one colon.
No entity names, PI targets, or notation names contain any colons.
Strictly speaking, attribute values declared to be of types ID, IDREF(S), ENTITY(IES), and NOTATION are also Names, and thus should be colon-free. However, the declared type of attribute values is only available to processors which read markup declarations, for example validating processors. Thus, unless the use of a validating processor has been specified, there can be no assurance that the contents of attribute values have been checked for conformance to this specification.
In the computing disciplines, the term "namespace" conventionally refers to a set of names, i.e. a collection containing no duplicates. However, treating the names used in XML markup as such a namespace would greatly impair their usefulness. The primary use of such names in XML documents is to enable identification of logical structures in documents by software modules such as query processors, stylesheet-driven rendering engines, and schema-driven validators. Consider the following example:
<section><title>Book-Signing Event</title> <signing> <author title="Mr" name="Vikram Seth" /> <book title="A Suitable Boy" price="$22.95" /></signing> <signing> <author title="Dr" name="Oliver Sacks" /> <book title="The Island of the Color-Blind" price="$12.95" /></signing> </section>
In this example, there are three occurrences of the name
within markup, and the name alone clearly provides insufficient information
to allow correct processing by a software module.
Another problematic area comes from the use of "global" attributes, as illustrated by this example, a fragment of an XML document which is to be displayed using a CSS stylesheet:
<RESERVATION> <NAME HTML:CLASS="largeSansSerif">Layman, A</NAME> <SEAT CLASS="Y" HTML:CLASS="reallyImportant">33B</SEAT> <DEPARTURE>1997-05-24T07:55:00+1</DEPARTURE></RESERVATION>
In this case, the
CLASS attribute, which describes the fare basis
and takes values such as "J", "Y", and "C", is distinct at all semantic levels
HTML:CLASS attribute, which
is used to
simulate syntactic richness in HTML, as a means of overcoming the
limited element repertoire by subclassing.
XML 1.0 does not provide a built-in way to declare "global" attributes;
items such as the HTML
CLASS attribute are global only in their
prose description and their interpretation by HTML applications.
However, such attributes, an important distinguishing feature of which is that
their names are unique, are commonly observed to occur in a variety of
In order to support the goal of making both qualified and unqualified names useful in meeting their intended purpose, we identify the names appearing in an XML namespace as belonging to one of several disjoint traditional (i.e. set-structured) namespaces, called namespace partitions. The partitions are:
All element types in an XML namespace appear in this partition. Each has a unique local part; the combination of the namespace name and the local part uniquely identifies the element type.
This partition contains the names of all attributes which are defined, in this namespace, to be global. The only required characteristic of a global attribute is that its name be unique in the global attribute partition. This specification makes no assertions as to the proper usage of such attributes. The combination of the namespace name and the attribute name uniquely identifies the global attribute.
Each type in the All Element Types Partition has an associated namespace in which appear the names of the unqualified attributes that are provided for that element. This is a traditional namespace because the appearance of duplicate attribute names on an element is forbidden by XML 1.0. The combination of the attribute name with the element's type and namespace name uniquely identifies each unqualified attribute.
In XML documents conforming to this specification, the names of all qualified (prefixed) attributes are assigned to the global attribute partition, and the names of all unqualified attributes are assigned to the appropriate per-element-type partition.
For convenience in specifying rules and in making comparisons, we define an expanded form, expressed here in XML element syntax, for each element type and attribute name in an XML document.
type is expressed as an empty XML element of type
It has a required
type attribute which
gives the type's LocalPart, and an optional
ns attribute which, if the element is qualified, gives its
attribute name is expressed as an empty XML element of type
It has a required
name attribute which gives the name.
If the attribute is global, it has a required
which gives the namespace name;
otherwise, it has a required attribute
gives the type of the attached element, and an optional attribute
elns which gives the namespace name, if known, of the
Slight variations on the examples given above will illustrate the working of expanded element types and attribute names. The following two fragments are each followed by a table showing the expansion of the names:
<!-- 1 --> <section xmlns='urn:com:books-r-us'> <!-- 2 --> <title>Book-Signing Event</title> <!-- 3 --> <signing> <!-- 4 --> <author title="Mr" name="Vikram Seth" /> <!-- 5 --> <book title="A Suitable Boy" price="$22.95" /> </signing> </section>
The names would expand as follows:
|1||section||<ExpEType type="section" ns="urn:com:books-r-us" />|
|2||title||<ExpEType type="title" ns="urn:com:books-r-us" />|
|3||signing||<ExpEType type="signing" ns="urn:com:books-r-us" />|
|4||author||<ExpEType type="author" ns="urn:com:books-r-us" />|
|4||title||<ExpAName name='title' eltype="author" elns="urn:com:books-r-us" />|
|4||name||<ExpAName name='name' eltype="author" elns="urn:com:books-r-us" />|
|5||book||<ExpEType type="book" ns="urn:com:books-r-us" />|
|5||title||<ExpAName name='title' eltype="book" elns="urn:com:books-r-us" />|
|5||price||<ExpAName name='price' eltype="book" elns="urn:com:books-r-us" />|
<!-- 1 --> <RESERVATION xmlns:HTML="http://www.w3.org/TR/REC-html40"> <!-- 2 --> <NAME HTML:CLASS="largeSansSerif">Layman, A</NAME> <!-- 3 --> <SEAT CLASS="Y" HTML:CLASS="largeMonotype">33B</SEAT> <!-- 4 --> <HTML:A HREF='/cgi-bin/ResStatus'>Check Status</HTML:A> <!-- 5 --> <DEPARTURE>1997-05-24T07:55:00+1</DEPARTURE></RESERVATION>
|1||RESERVATION||<ExpEType type="RESERVATION" />|
|2||NAME||<ExpEType type="NAME" />|
|2||HTML:CLASS||<ExpAName name="CLASS" ns=http://www.w3.org/TR/REC-html40 />|
|3||SEAT||<ExpEType type="SEAT" />|
|3||CLASS||<ExpAName name="CLASS" eltype="SEAT">|
|3||HTML:CLASS||<ExpAName name="CLASS" ns="http://www.w3.org/TR/REC-html40" />|
|4||HTML:A||<ExpEType type="A" ns="http://www.w3.org/TR/REC-html40" />|
|4||HREF||<ExpAName name="HREF" eltype="A" elns="http://www.w3.org/TR/REC-html40" />|
|5||DEPARTURE||<ExpEType type="DEPARTURE" />|
The constraint expressed by 5.3 Uniqueness of Attributes above may straightforwardly be implemented by requiring that no element have two attributes whose expanded names are equivalent, i.e. have the same attribute-value pairs.
This work reflects input from a very large number of people, including especially the members of the World Wide Web Consortium XML Working Group and Special Interest Group and the participants in the W3C Metadata Activity. The contributions of Charles Frankston of Microsoft were particularly valuable.