HTTP/2 200
date: Wed, 08 Oct 2025 10:17:05 GMT
content-type: application/xml; qs=0.9
content-length: 8283
cf-ray: 98b4e2ef28bae9c3-BLR
last-modified: Fri, 09 Sep 2005 16:39:26 GMT
etag: "6ee3-400596bb5ab80-gzip"
cache-control: max-age=31536000
expires: Thu, 08 Oct 2026 10:17:05 GMT
vary: Accept-Encoding,Origin
content-encoding: gzip
access-control-allow-origin: *
x-backend: www-mirrors
x-request-id: 98b4e2ef28bae9c3
strict-transport-security: max-age=15552000; includeSubdomains; preload
content-security-policy: frame-ancestors 'self' https://cms.w3.org/ https://cms-dev.w3.org/; upgrade-insecure-requests
cf-cache-status: BYPASS
accept-ranges: bytes
set-cookie: __cf_bm=unp1NfozvYEG_r4a4rwoBlBn3FBBV.03uTB7dYCOiLI-1759918625-1.0.1.1-JGBTOPnbRh4WYhHWP4P9inPzpXZM7ATw0zUsm2ylZ6eLJ97yVNr1SRW_3Ab9vEeW2IZgLSuKpsrVhA7pzWu6kWZmQK2Shd3DSLFYQOH7BfY; path=/; expires=Wed, 08-Oct-25 10:47:05 GMT; domain=.w3.org; HttpOnly; Secure; SameSite=None
server: cloudflare
alt-svc: h3=":443"; ma=86400
]>
xml:id
Version 1.0
xml-id-&year;&MMDD;
W3C Recommendation
&day;
&month;
&year;
&xmlid;
XML
https://www.w3.org/TR/xml-id/
https://www.w3.org/TR/2005/PR-xml-id-20050712/
Jonathan Marsh
Microsoft
jmarsh@microsoft.com
Daniel Veillard
Invited Expert
daniel@veillard.com
Norman Walsh
Sun Microsystems
Norman.Walsh@Sun.COM
https://www.w3.org/2003/03/Translations/byTechnology?technology=xml-id
This section describes the status of this document at the
time of its publication. Other documents may supersede this document.
A list of current W3C publications and the latest revision of this
technical report can be found in the
W3C technical reports index at
https://www.w3.org/TR/.
This document is a Recommendation of the W3C. This document has
been developed by the
W3C XML Core Working Group
as part of the
XML
Activity.
It has been reviewed by W3C Members and other interested parties and
has been endorsed by the Director. It is a stable document and may be
used as reference material or cited as a normative reference from
another document. W3C's role in making the Recommendation is to draw
attention to the specification and to promote its widespread
deployment. This enhances the functionality and interoperability of
the Web.
The English version of this specification is the only normative
version. Translations of this document may be available.
If you have any comments on this document, send them to
public-xml-id@w3.org,
a mailing list with a
public
archive. An errata
list for this edition
is available.
This document defines the meaning of the attribute
xml:id as an ID attribute in XML documents and defines
processing of this attribute to identify IDs in the absence of
validation, without fetching external resources, and without relying
on an internal DTD subset.
This document is based upon the xml:id Version 1.0 Proposed
Recommendation of 12 July 2005. Feedback received during that review
resulted in minor editorial changes. Evidence of interoperation
between at least two implementations of this specification are
documented in the
Implementation Report.
A test suite is
also available.
This document was produced under the 5 February
2004 W3C Patent Policy. The Working Group maintains a public list of patent disclosures
relevant to this document; that page also includes instructions for
disclosing [and excluding] a patent. An individual who has actual
knowledge of a patent which the individual believes contains Essential
Claim(s) with respect to this specification should disclose the
information in accordance with section 6 of the W3C Patent Policy.
This document defines the meaning of the attribute
xml:id as an ID attribute in XML documents and defines
processing of this attribute to identify IDs in the absence of
validation, without fetching external resources, and without relying
on an internal subset.
English
July 17, 2003: First Working Draft.
March 17, 2004: Second internal Working Draft.
Introduction
and provide a mechanism
for annotating elements with unique identifiers. This mechanism
consists of declaring the type of an attribute as "ID", after which
the parser will validate that
the ID value matches the allowed lexical
form,
the value is unique within the XML document, and that
each element has at most one single unique identifier
Declarations in either the
internal or external
DTD subset of an
XML document can declare attributes to be of type ID. However,
processing the external DTD subset is optional for conformant XML
processors; and some specifications, notably ,
forbid DTDs completely, leaving no guarantee that all consumers of the
XML document will be able to successfully recognize the identifiers.
Identifiers can be declared through external mechanisms as well. Of
particular interest is which provides a
type "xs:ID" with the same uniqueness and validity constraints as XML.
However, there are no guarantees that consumers will have the
"correct" schema available, nor that they will process it if they
do.
A mechanism allowing unique element identifiers to be recognized by
all conformant XML
processors, whether they validate or not, is
desirable in making XML sub-resource linking robust.
This specification allows authors to identify elements with IDs
that can be recognized by any processor without regard to how, or if,
any internal or external declarations are available.
An additional problem is that DTD-based and XML Schema-based
identifiers are exposed through different conceptual mechanisms - the
attribute type infoset property,
and the type definition family of
properties respectively. A uniform mechanism for recognizing
identifiers is desirable.
This specification provides such a mechanism: it describes the
semantics of xml:id attributes. This specification has been
designed to be a separate layer in processing and to be compatible
with existing validation technologies. Implementors are encouraged to
support xml:id processing and to make
ID type assignment the default
behavior of their processors.
It has been a guiding principle in the design of this specification
that the result of xml:id processing should be the same
as if an appropriate declaration has been seen and used by the processor.
Terminology
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 .
An
xml:id processor is a software module that works in
conjunction with an XML
processor to provide access to the IDs in an XML document.
An
xml:id error is a non-fatal error that occurs when an
xml:id processor finds that
a document has violated the constraints of this specification.
Validation is the process of comparing an XML document (or part of
an XML document) against a grammar or set of rules to determine if the
actual structure of the document satisfies the constraints of the
grammar or the rules. Some validation technologies also perform type
assignment, determining not only if the document satisfies the
specified constraints but also determining, for example, which
(elements and/or) attributes are of type “ID”.
Although often performed together, validation and type assignment
are not the same process. A non-validating XML 1.0 processor, for
example, can perform type assignment using only declarations from the
internal subset, without ever having any information about the
structural validity of the document.
The
process of ID type assignment causes an xml:id
attribute value to be an ID. This is often achieved by making the
type of the attribute "ID" in the infoset or
post-schema-validation
infoset (PSVI), but that is
not the only possible mechanism.
Application-level processing of IDs, including which elements can
actually be addressed by which ID values, is beyond the scope of this
specification.
Syntax
Per (and ), prefixes
beginning “xml” are reserved for use by XML and XML-related
specifications. This specification licenses the use of the attribute
“xml:id” for use as a common syntax for identifiers in XML with the
semantics specified herein.
Authors of XML documents are encouraged to name their ID attributes
"carview.php?tsp=xml:id" to increase the interoperability of these identifiers on the
Web.
In namespace-aware XML processors, the "xml" prefix is bound to the
namespace name https://www.w3.org/XML/1998/namespace
as
described in Namespaces in XML (and ). Note that xml:id can be still used by
non-namespace-aware XML processors.
Processing xml:id Attributes
Each xml:id attribute is processed in the following
way:
-
The attribute's value is normalized according to the rules for
attribute-value
normalization on attributes of type ID. For more details, see
.
The infoset
normalized value property is updated
with the normalized value.
-
ID type assignment is
performed with the normalized value.
An xml:id processor
must assure that the following
constraints hold for all xml:id attributes:
-
The normalized value of the attribute is an
NCName
according to the
Namespaces in XML
Recommendation which has the same version as
the document in which this attribute occurs
(NCName
for XML 1.0, or
NCName
for XML 1.1).
-
The declared type of the attribute, if it has one, is “ID”.
All declarations for xml:id attributes
must
specify “ID” as the type of the attribute.
An xml:id processor
should assure that the following
constraint holds:
-
The values of all attributes of type “ID” (which includes all
xml:id attributes) within a document are unique.
An xml:id error occurs
for any xml:id attribute that does not satisfy the
constraints.
The xml:id processor performs
ID type assignment on all
xml:id attributes, even those that do not satisfy
the constraints.
An xml:id processor
should update the infoset
references property, as
described in Section 2.3 of , and update any
implementation-specific structures used for cross-referencing to
reflect the results of ID type assignment.
Many validation technologies impose the constraint that an XML
element can have at most one attribute of type ID. That constraint is
not imposed by xml:id processing.
This specification defines xml:id processing, but it is up to the
application to determine when such processing occurs. Users of
applications that provide facilities for modifying XML documents may
reasonably expect xml:id processing to occur whenever a change is
made to an ID value.
Informing the Application
When ID type assignment
occurs, the xml:id processor
must report the assigned
xml:id attributes
to the application. How this is reported is implementation
dependent.
-
For applications that operate conceptually on the Infoset, an
xml:id processor can use the
attribute type Infoset
property:
The xml:id processor may report the results of ID type assignment in a
DTD compatible manner by setting the attribute type infoset property of the
attribute to ID.
-
For applications that operate conceptually on the PSVI, an
xml:id processor can use the
type definition family
of PSVI properties:
The xml:id processor may
report the results of ID type assignment
in an XML Schema compatible manner by setting the PSVI
type definition property of the
attribute to xs:ID
.
-
For applications that operate on data models defined in other ways,
the mechanisms are implementation dependent:
The xml:id processor may
report the results of ID type assignment in some other way.
The key requirement is that the application be made aware of the results
of ID type assignment.
Errors
A violation of the constraints in this specification results in an
xml:id error.
Such errors are not fatal, but should
be reported by the
xml:id processor.
In the interest of interoperability, it is strongly recommended that
xml:id errors not be silently ignored.
Conformance
Conformance to xml:id
Conformance to xml:id for applications that rely on
XML
processors using validation technologies consists in the
use of the xml:id construct as explained in
and by conformance to both the constraints
of this specification and the rules of the validation technology.
Conformance to xml:id for applications that rely on
non-validating
XML
processors is defined by the recognition of xml:id
attributes as explained in
and by conformance to the constraints
of this specification.
Conformance to constraints that
“must” be assured is mandatory.
It is recommended that applications assure the other constraints as well.
This specification defines no simply optional constraints.
A document is conformant to this specification if it generates no
xml:id errors.
XML Information Set Conformance
This specification conforms to the .
The following information items must
be present in the input infosets to enable correct processing:
-
Element Information Items with
attributes property.
-
Attribute Information Items with
namespace name,
local name and
normalized value properties.
In addition, the following properties might be present in the output infoset:
-
attribute type properties on Attribute Information Items.
Extensibility
This specification is not extensible. There are no provisions for application
designers to alter the name of the xml:id attribute, the set of
attribute values that are considered IDs, the location(s) where they can
occur, or make any other extensions.
References
RFC 2119: Key
words for use in RFCs to Indicate Requirement Levels.
Internet Engineering Task Force, 1997.
Tim Bray, Jean Paoli, C.M. Sperberg-McQueen, et. al., editors.
Extensible Markup
Language (XML) 1.0 (Third Edition).
World Wide Web Consortium, 2004.
Tim Bray, Jean Paoli, C.M. Sperberg-McQueen, et. al., editors.
Extensible Markup
Language (XML) 1.1.
World Wide Web Consortium, 2004.
John Cowan and Richard Tobin, editors.
XML Information Set (Second Edition).
World Wide Web Consortium, 2004.
Tim Bray, Dave Hollander, and Andrew Layman, editors.
Namespaces in XML.
World Wide Web Consortium, 1999.
Tim Bray, Dave Hollander, Andrew Layman, and Richard Tobin, editors.
Namespaces in XML 1.1.
World Wide Web Consortium, 2004.
References
Henry S. Thompson, David Beech, Murray Maloney, Noah Mendelsohn, editors.
XML Schema Part 1:
Structures.
World Wide Web Consortium, 2001.
Martin
Gudgin, Marc Hadley, Noah Mendelsohn, et. al., editors.
SOAP Version 1.2 Part 1:
Messaging Framework. World Wide Web Consortium, 2003.
Impact on Canonicalization
The
Canonical XML
Version 1.0 specification
describes
a process
whereby attributes in the xml:
namespace are inherited in a
canonicalized document. While this produces a reasonable result with
xml:lang
or xml:space
attributes, processing
xml:id
attributes in this way is likely to produce
documents that contain
xml:id errors,
specifically xml:id
attribute values that are not unique.
This is an apparent flaw in the design of Canonical XML. The
Exclusive
XML Canonicalization Version 1.0 specification does not have
this feature and may be more appropriate for documents containing IDs.
Validation Technologies
This appendix describes how xml:id processing interacts with
selected validation technologies.
With DTD Validation
DTD authors are encouraged to use xml:id attributes when
providing identifiers for elements declared in their DTDS.
The following DTD fragment illustrates a sample
declaration for the xml:id attribute:
<!ATTLIST someElement
xml:id ID #IMPLIED
>
DTD authors are encouraged to declare attributes named
xml:id with the type ID
.
A document that uses xml:id attributes that have a declared
type other than ID
will always generate xml:id errors.
Consumers of documents validated using properly declared
xml:id attributes can recognize IDs through the attribute type property.
With XML Schema Validation
XML Schema authors are encouraged to use xml:id
attributes when providing identifiers for elements declared in their
schemas. Note that this can most easily be accomplished by importing
the schema for the XML
namespace and using the attribute declaration it contains.
The following XML Schema fragment for the XML namespace illustrates a
sample declaration for the xml:id attribute:
]]>
XML Schema authors are encouraged to declare attributes named
xml:id with the type xs:ID
.
A document that uses xml:id attributes that have a declared
type other than xs:ID
will always generate xml:id errors.
Consumers of documents validating the xml:id attributes
against an appropriate schema for the XML namespace can recognize IDs
through the type definition
family of PSVI properties.
Applications can recognize xml:id attributes as IDs by
conceptually using a Minimally
Conforming Schema Processor and the schema above.
Note that the effects of a Minimally Conforming Schema Processor,
processing the above schema, are approximated by simply looking for
attributes named xml:id, ensuring the value of such
attributes has the correct lexical form (NCName),
and the value is unique within the document.
With RELAX NG Validation
RELAX NG Grammar authors are encouraged to use xml:id
attributes when providing identifiers for elements declared in their
schemas.
The following RELAX NG fragment illustrates a
sample declaration for the xml:id attribute:
]]>
RELAX NG Grammar authors are encouraged to declare attributes named
xml:id with the type xs:ID
.
A document that uses xml:id attributes that have a declared
type other than xs:ID
will always generate xml:id errors.
Attribute Value Normalization on IDs
requires parsers to
normalize
all attribute values. Normalization expands character references, expands
entity references, and cleans up line end characters. Attributes of
type ID are subject to additional normalization rules: removing leading
and trailing space characters and replacing sequences of spaces with a single
space.
The xml:id processor has to assure that both steps of normalization
are performed all attributes named xml:id. In particular,
the parser may not have performed the additional normalization steps
required for attributes of type ID because the attribute may not be
declared or may be declared as an ID.
Consider the following document:
]>
]]>
The initial value of xml:id on doc will be
“one” because the parser knew that it was an ID. The initial value
on para will be “ two ”. Because the parser didn't know it
was an ID, it will not have performed the additional normalizations
required.
After xml:id processing, the value of the xml:id attributes
on doc and para will be “one” and “two”, respectively.
These properly normalized values will be stored in the
normalized value property in the
infoset. Performing xml:id processing changes the infoset if there
are incompletely normalized xml:id attributes.
For interoperability, document producers should use fully normalized values that are
legal NCNames
in
xml:id attributes.