| | | | 
Extensible Markup Language (XML) 1.0 (Third Edition)
W3C Recommendation 04 February 2004- This version:
- http://www.w3.org/TR/2004/REC-xml-20040204
- Latest version:
- http://www.w3.org/TR/REC-xml
- Previous version:
http://www.w3.org/TR/2003/PER-xml-20031030 - Editors:
- Tim Bray, Textuality and Netscape <tbray@textuality.com>
- Jean Paoli, Microsoft <jeanpa@microsoft.com>
- C. M. Sperberg-McQueen, W3C <cmsmcq@w3.org>
- Eve Maler, Sun Microsystems, Inc. <eve.maler@east.sun.com> - Second Edition
- François Yergeau <francois@yergeau.com> - Third Edition
Please refer to the errata for this document, which may include some normative corrections. This document is also available in these non-normative formats: XML and XHTML with color-coded revision indicators. See also translations. Copyright © 2004 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark, document use and software licensing rules apply.
AbstractThe Extensible Markup Language (XML) is a subset of SGML that is completely
described in this document. Its goal is to enable generic SGML to be served,
received, and processed on the Web in the way that is now possible with HTML.
XML has been designed for ease of implementation and for interoperability
with both SGML and HTML.
Status of this DocumentThis 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
http://www.w3.org/TR/. This document is a Recommendation
of the W3C. It has been reviewed by W3C Members and other interested parties, and has been
endorsed by the Director as a W3C Recommendation. 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. This document specifies a syntax created by subsetting an existing, widely
used international text processing standard (Standard Generalized Markup Language,
ISO 8879:1986(E) as amended and corrected) for use on the World Wide Web.
It is a product of the XML Core Working Group
as part of the XML Activity.
The English version of this specification is the only normative version. However,
for translations of this document, see http://www.w3.org/2003/03/Translations/byTechnology?technology=REC-xml. This third edition is not a new version of XML. As a convenience to readers,
it incorporates the changes dictated by the accumulated errata (available at
http://www.w3.org/XML/xml-V10-2e-errata) to the Second Edition of XML 1.0, dated 6
October 2000. In addition, markup has been introduced on a significant portion of
the prescriptions of the specification, clarifying when prescriptive keywords such as
MUST, SHOULD and MAY are used
in the formal sense defined in [IETF RFC 2119]. For the convenience of readers,
an XHTML version with color-coded revision indicators is
also provided; this version highlights each change due to an erratum published in the
errata list, together with a link to the particular
erratum in that list. Most of the errata in the list provide a rationale for the change. An implementation report is available at http://www.w3.org/XML/2003/09/xml10-3e-implementation.html. Documentation of intellectual property possibly relevant to this recommendation
may be found at the Working Group's public
IPR disclosure page. Please report errors in this document to xml-editor@w3.org; archives are available.
The errata list for this third edition is available at http://www.w3.org/XML/xml-V10-3e-errata. A Test Suite is maintained to help assessing conformance to this specification.
1 IntroductionExtensible Markup Language, abbreviated XML, describes a class of data
objects called ·XML documents· and partially
describes the behavior of computer programs which process them. XML is an
application profile or restricted form of SGML, the Standard Generalized Markup
Language [ISO 8879]. By construction, XML documents are conforming
SGML documents. XML documents are made up of storage units called ·entities·,
which contain either parsed or unparsed data. Parsed data is made up of ·characters·, some of which form ·character
data·, and some of which form ·markup·.
Markup encodes a description of the document's storage layout and logical
structure. XML provides a mechanism to impose constraints on the storage layout
and logical structure. [Definition:] A software module called
an XML processor is used to read XML documents and provide access
to their content and structure. [Definition:] It
is assumed that an XML processor is doing its work on behalf of another module,
called the application. This specification describes
the required behavior of an XML processor in terms of how it must read XML
data and the information it must provide to the application.
1.1 Origin and GoalsXML was developed by an XML Working Group (originally known as the SGML
Editorial Review Board) formed under the auspices of the World Wide Web Consortium
(W3C) in 1996. It was chaired by Jon Bosak of Sun Microsystems with the active
participation of an XML Special Interest Group (previously known as the SGML
Working Group) also organized by the W3C. The membership of the XML Working
Group is given in an appendix. Dan Connolly served as the Working Group's contact with
the W3C. The design goals for XML are: - XML shall be straightforwardly usable over the Internet.
- XML shall support a wide variety of applications.
- XML shall be compatible with SGML.
- It shall be easy to write programs which process XML documents.
- The number of optional features in XML is to be kept to the absolute
minimum, ideally zero.
- XML documents should be human-legible and reasonably clear.
- The XML design should be prepared quickly.
- The design of XML shall be formal and concise.
- XML documents shall be easy to create.
- Terseness in XML markup is of minimal importance.
This specification, together with associated standards (Unicode [Unicode]
and ISO/IEC 10646 [ISO/IEC 10646] for characters, Internet RFC 3066
[IETF RFC 3066] for language identification tags, ISO 639 [ISO 639]
for language name codes, and ISO 3166 [ISO 3166] for country name codes), provides
all the information necessary to understand XML Version 1.0 and
construct computer programs to process it. This version of the XML specification may be distributed freely, as long as
all text and legal notices remain intact.
1.2 Terminology
The terminology used to describe XML documents is defined in the body of
this specification. The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, when EMPHASIZED, are to be interpreted as described in [IETF RFC 2119]. In addition, the terms defined in the following list are used in building
those definitions and in describing the actions of an XML processor: - error
- [Definition:] A violation of the rules of this specification;
results are undefined. Unless otherwise specified, failure to observe a prescription of this specification indicated by one of the keywords MUST, REQUIRED, MUST NOT, SHALL and SHALL NOT is an error. Conforming software MAY detect and report an error
and MAY recover from it.
- fatal error
- [Definition:] An error which a conforming ·XML processor· MUST detect and report to the application.
After encountering a fatal error, the processor MAY continue processing the
data to search for further errors and MAY report such errors to the application.
In order to support correction of errors, the processor MAY make unprocessed
data from the document (with intermingled character data and markup) available
to the application. Once a fatal error is detected, however, the processor
MUST NOT continue normal processing (i.e., it MUST NOT continue to pass character
data and information about the document's logical structure to the application
in the normal way).
- at user option
- [Definition:] Conforming software
MAY or MUST (depending on the modal verb in the sentence) behave as described;
if it does, it MUST provide users a means to enable or disable the behavior
described.
- validity constraint
- [Definition:] A rule which applies to
all ·valid· XML documents. Violations of validity
constraints are errors; they MUST, at user option, be reported by ·validating XML processors·.
- well-formedness constraint
- [Definition:] A rule which applies
to all ·well-formed· XML documents. Violations
of well-formedness constraints are ·fatal errors·.
- match
- [Definition:] (Of strings or names:) Two strings
or names being compared MUST be identical. Characters with multiple possible
representations in ISO/IEC 10646 (e.g. characters with both precomposed and
base+diacritic forms) match only if they have the same representation in both
strings. No
case folding is performed. (Of strings and rules in the grammar:) A string
matches a grammatical production if it belongs to the language generated by
that production. (Of content and content models:) An element matches its declaration
when it conforms in the fashion described in the constraint [VC: Element Valid].
- for compatibility
- [Definition:] Marks
a sentence describing a feature of XML included solely to ensure
that XML remains compatible with SGML.
- for interoperability
- [Definition:] Marks
a sentence describing a non-binding recommendation included to increase
the chances that XML documents can be processed by the existing installed
base of SGML processors which predate the WebSGML Adaptations Annex to ISO 8879.
2 Documents[Definition:] A data object is an XML
document if it is ·well-formed·,
as defined in this specification. A well-formed XML document MAY in addition
be ·valid· if it meets certain further constraints. Each XML document has both a logical and a physical structure. Physically,
the document is composed of units called ·entities·.
An entity MAY ·refer· to other entities to
cause their inclusion in the document. A document begins in a "root"
or ·document entity·. Logically, the document
is composed of declarations, elements, comments, character references, and
processing instructions, all of which are indicated in the document by explicit
markup. The logical and physical structures MUST nest properly, as described
in 4.3.2 Well-Formed Parsed Entities.
2.1 Well-Formed XML Documents[Definition:] A textual object is a well-formed
XML document if: - Taken as a whole, it matches the production labeled document.
- It meets all the well-formedness constraints given in this specification.
- Each of the ·parsed entities·
which is referenced directly or indirectly within the document is ·well-formed·.
Matching the document production implies that: - It contains one or more ·elements·.
- [Definition:] There is exactly one element,
called the root, or document element, no part of which appears
in the ·content· of any other element. For
all other elements, if the ·start-tag· is in
the content of another element, the ·end-tag·
is in the content of the same element. More simply stated, the elements,
delimited by start- and end-tags, nest properly within each other.
[Definition:] As a consequence of this,
for each non-root element C in the document, there is one other element P
in the document such that C is in the content of P, but
is not in the content of any other element that is in the content of P. P
is referred to as the parent of C, and C as
a child of P.
2.2 Characters
[Definition:] A parsed entity contains text,
a sequence of ·characters·, which may
represent markup or character data. [Definition:] A character
is an atomic unit of text as specified by ISO/IEC 10646:2000 [ISO/IEC 10646]. Legal characters are tab, carriage
return, line feed, and the legal characters
of Unicode and ISO/IEC 10646. The
versions of these standards cited in A.1 Normative References were
current at the time this document was prepared. New characters may be added
to these standards by amendments or new editions. Consequently, XML processors
MUST accept any character in the range specified for Char.
| Character Range | | [2] | Char | ::= | #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] | /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */ |
|
The mechanism for encoding character code points into bit patterns MAY
vary from entity to entity. All XML processors MUST accept the UTF-8 and UTF-16
encodings of Unicode 3.1
[Unicode3];
the mechanisms for signaling which of the two is in use,
or for bringing other encodings into play, are discussed later, in 4.3.3 Character Encoding in Entities. Document authors are encouraged to avoid
"compatibility characters", as defined
in section 6.8 of [Unicode] (see also D21 in section 3.6 of
[Unicode3]). The characters defined in the following ranges are also
discouraged. They are either control characters or permanently undefined Unicode
characters:
[#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF],
[#1FFFE-#x1FFFF], [#2FFFE-#x2FFFF], [#3FFFE-#x3FFFF],
[#4FFFE-#x4FFFF], [#5FFFE-#x5FFFF], [#6FFFE-#x6FFFF],
[#7FFFE-#x7FFFF], [#8FFFE-#x8FFFF], [#9FFFE-#x9FFFF],
[#AFFFE-#xAFFFF], [#BFFFE-#xBFFFF], [#CFFFE-#xCFFFF],
[#DFFFE-#xDFFFF], [#EFFFE-#xEFFFF], [#FFFFE-#xFFFFF],
[#10FFFE-#x10FFFF].
2.3 Common Syntactic Constructs
This section defines some symbols used widely in the grammar. S (white space) consists of one or more space (#x20)
characters, carriage returns, line feeds, or tabs. | White Space | | [3] | S | ::= | (#x20 | #x9 | #xD | #xA)+ |
|
Note: The presence of #xD in the above production is
maintained purely for backward compatibility with the
First Edition.
As explained in 2.11 End-of-Line Handling,
all #xD characters literally present in an XML document
are either removed or replaced by #xA characters before
any other processing is done. The only way to get a #xD character to match this production is to
use a character reference in an entity value literal. Characters are classified for convenience as letters, digits, or other
characters. A
letter consists of an alphabetic or syllabic base character or an ideographic
character. Full definitions of the specific characters in each class
are given in B Character Classes. [Definition:] A Name is a token beginning
with a letter or one of a few punctuation characters, and continuing with
letters, digits, hyphens, underscores, colons, or full stops, together known
as name characters. Names beginning with the string "xml",
or with any string which would match (('X'|'x') ('M'|'m') ('L'|'l')),
are reserved for standardization in this or future versions of this specification. Note: The
Namespaces in XML Recommendation [XML Names] assigns a meaning
to names containing colon characters. Therefore, authors should not use the
colon in XML names except for namespace purposes, but XML processors must
accept the colon as a name character. An Nmtoken (name token) is any mixture of name
characters. Literal data is any quoted string not containing the quotation mark used
as a delimiter for that string. Literals are used for specifying the content
of internal entities (EntityValue), the values
of attributes (AttValue), and external identifiers
(SystemLiteral). Note that a SystemLiteral
can be parsed without scanning for markup. | Literals | | [9] | EntityValue | ::= | '"' ([^%&"] | PEReference
| Reference)* '"' | | | | | "'" ([^%&'] | PEReference | Reference)* "'" | | [10] | AttValue | ::= | '"' ([^<&"] | Reference)*
'"' | | | | | "'" ([^<&'] | Reference)*
"'" | | [11] | SystemLiteral | ::= | ('"' [^"]* '"') | ("'" [^']* "'") | | [12] | PubidLiteral | ::= | '"' PubidChar* '"'
| "'" (PubidChar - "'")* "'" | | [13] | PubidChar | ::= | #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%] |
|
Note: Although
the EntityValue production allows the definition
of a general entity consisting of a single explicit < in the literal
(e.g., <!ENTITY mylt "<">), it is strongly advised to avoid
this practice since any reference to that entity will cause a well-formedness
error.
2.4 Character Data and Markup
·Text· consists of intermingled ·character data· and markup. [Definition:] Markup takes the form of ·start-tags·, ·end-tags·, ·empty-element tags·, ·entity references·, ·character
references·, ·comments·, ·CDATA section· delimiters, ·document
type declarations·, ·processing instructions·, XML declarations, text declarations,
and any white space that is at the top level of the document entity (that
is, outside the document element and not inside any other markup). [Definition:] All text that is not markup
constitutes the character data of the document. The ampersand character (&) and the left angle bracket (<) MUST NOT appear
in their literal form, except when used as markup delimiters, or
within a ·comment·, a ·processing
instruction·, or a ·CDATA section·.
If they are needed elsewhere, they MUST be ·escaped·
using either ·numeric character references·
or the strings "&" and "<"
respectively. The right angle bracket (>) MAY be represented using the string ">",
and MUST, ·for compatibility·, be escaped
using either ">" or a character reference when it
appears in the string "]]>" in content, when
that string is not marking the end of a ·CDATA
section·. In the content of elements, character data is any string of characters
which does not contain the start-delimiter of any markup and does not include the CDATA-section-close
delimiter, "]]>". In a CDATA section,
character data is any string of characters not including the CDATA-section-close
delimiter, "]]>". To allow attribute values to contain both single and double quotes, the
apostrophe or single-quote character (') MAY be represented as "'",
and the double-quote character (") as """. | Character Data | | [14] | CharData | ::= | [^<&]* - ([^<&]* ']]>' [^<&]*) |
|
2.5 Comments
Comments MAY appear
anywhere in a document outside other ·markup·;
in addition, they MAY appear within the document type declaration at places
allowed by the grammar. They are not part of the document's ·character
data·; an XML processor MAY, but need not, make it possible for an
application to retrieve the text of comments. ·For
compatibility·, the string "--" (double-hyphen)
MUST NOT occur within comments. Parameter
entity references MUST NOT be recognized within comments. | Comments | | [15] | Comment | ::= | '<!--' ((Char - '-') | ('-'
(Char - '-')))* '-->' |
|
An example of a comment: <!-- declarations for <head> & <body> --> Note
that the grammar does not allow a comment ending in --->. The
following example is not well-formed. <!-- B+, B, or B--->
2.6 Processing Instructions
[Definition:] Processing instructions
(PIs) allow documents to contain instructions for applications. | Processing Instructions | | [16] | PI | ::= | '<?' PITarget (S
(Char* - (Char* '?>' Char*)))? '?>' | | [17] | PITarget | ::= | Name - (('X' | 'x') ('M' |
'm') ('L' | 'l')) |
|
PIs are not part of the document's ·character
data·, but MUST be passed through to the application. The PI begins
with a target (PITarget) used to identify the application
to which the instruction is directed. The target names "XML", "xml",
and so on are reserved for standardization in this or future versions of this
specification. The XML ·Notation· mechanism
MAY be used for formal declaration of PI targets. Parameter
entity references MUST NOT be recognized within processing instructions.
2.7 CDATA Sections
[Definition:] CDATA sections MAY occur anywhere character data may occur; they are used to escape blocks
of text containing characters which would otherwise be recognized as markup.
CDATA sections begin with the string "<![CDATA["
and end with the string "]]>": Within a CDATA section, only the CDEnd string is
recognized as markup, so that left angle brackets and ampersands may occur
in their literal form; they need not (and cannot) be escaped using "<"
and "&". CDATA sections cannot nest. An example of a CDATA section, in which "<greeting>"
and "</greeting>" are recognized as ·character data·, not ·markup·: <![CDATA[<greeting>Hello, world!</greeting>]]>
2.8 Prolog and Document Type Declaration
[Definition:] XML documents SHOULD
begin with an XML declaration which specifies the version of
XML being used. For example, the following is a complete XML document, ·well-formed· but not ·valid·: <?xml version="1.0"?>
<greeting>Hello, world!</greeting> and so is this: <greeting>Hello, world!</greeting> The function of the markup in an XML document is to describe its storage and
logical structure and to associate attribute
name-value pairs with its logical structures. XML provides a mechanism, the
·document
type declaration·, to define constraints on the logical structure
and to support the use of predefined storage units. [Definition:] An XML document is valid if it has an associated
document type declaration and if the document complies with the constraints
expressed in it. The document type declaration MUST appear before the first ·element·
in the document. [Definition:] The XML document
type declaration contains or points to ·markup
declarations· that provide a grammar for a class of documents. This
grammar is known as a document type definition, or DTD. The document
type declaration can point to an external subset (a special kind of ·external entity·) containing markup declarations,
or can contain the markup declarations directly in an internal subset, or
can do both. The DTD for a document consists of both subsets taken together. [Definition:] A markup declaration
is an ·element type declaration·, an ·attribute-list declaration·, an ·entity
declaration·, or a ·notation declaration·.
These declarations MAY be contained in whole or in part within ·parameter
entities·, as described in the well-formedness and validity constraints
below. For further
information, see 4 Physical Structures. Note
that it is possible to construct a well-formed document containing a doctypedecl
that neither points to an external subset nor contains an internal subset. The markup declarations MAY be made up in whole or in part of the ·replacement text· of ·parameter
entities·. The productions later in this specification for individual
nonterminals (elementdecl, AttlistDecl,
and so on) describe the declarations after all the parameter
entities have been ·included·. Parameter
entity references are recognized anywhere in the DTD (internal and external
subsets and external parameter entities), except in literals, processing instructions,
comments, and the contents of ignored conditional sections (see 3.4 Conditional Sections).
They are also recognized in entity value literals. The use of parameter entities
in the internal subset is restricted as described below. Validity constraint: Root Element Type The Name
in the document type declaration MUST match the element type of the ·root element·. Validity constraint: Proper Declaration/PE Nesting Parameter-entity ·replacement text· MUST be properly nested with markup declarations. That is to say, if either
the first character or the last character of a markup declaration (markupdecl
above) is contained in the replacement text for a ·parameter-entity
reference·, both MUST be contained in the same replacement text. Well-formedness constraint: PEs in Internal Subset In
the internal DTD subset, ·parameter-entity references· MUST NOT occur within markup declarations; they MAY occur where markup declarations can occur.
(This does not apply to references that occur in external parameter entities
or to the external subset.) Well-formedness constraint: External Subset The external subset, if any, MUST match the production for extSubset. Well-formedness constraint: PE Between Declarations The replacement text of a parameter entity reference
in a DeclSep MUST match the production extSubsetDecl. Like the internal subset, the external subset and any external parameter
entities referenced
in a DeclSep MUST consist of a series of
complete markup declarations of the types allowed by the non-terminal symbol markupdecl, interspersed with white space or ·parameter-entity references·. However, portions of
the contents of the external subset or of these
external parameter entities MAY conditionally be ignored by using the ·conditional section· construct; this is not
allowed in the internal subset but is
allowed in external parameter entities referenced in the internal subset. The external subset and external parameter entities also differ from the
internal subset in that in them, ·parameter-entity
references· are permitted within markup declarations,
not only between markup declarations. An example of an XML document with a document type declaration: <?xml version="1.0"?>
<!DOCTYPE greeting SYSTEM "hello.dtd">
<greeting>Hello, world!</greeting> The ·system identifier· "hello.dtd"
gives the address (a URI reference) of a DTD for the document. The declarations can also be given locally, as in this example: <?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE greeting [
<!ELEMENT greeting (#PCDATA)>
]>
<greeting>Hello, world!</greeting> If both the external and internal subsets are used, the internal subset
MUST be considered to occur before the external subset.
This has the effect that entity and attribute-list declarations in the internal
subset take precedence over those in the external subset.
2.9 Standalone Document Declaration
Markup declarations can affect the content of the document, as passed from
an ·XML processor· to an application; examples
are attribute defaults and entity declarations. The standalone document declaration,
which MAY appear as a component of the XML declaration, signals whether or
not there are such declarations which appear external to the ·document
entity·
or in parameter entities. [Definition:] An external
markup declaration is defined as a markup declaration occurring in
the external subset or in a parameter entity (external or internal, the latter
being included because non-validating processors are not required to read
them). | Standalone Document Declaration | |
In a standalone document declaration, the value "yes" indicates
that there are no ·external markup declarations· which
affect the information passed from the XML processor to the application. The
value "no" indicates that there are or may be such external
markup declarations. Note that the standalone document declaration only denotes
the presence of external declarations; the presence, in a document,
of references to external entities, when those entities are internally
declared, does not change its standalone status. If there are no external markup declarations, the standalone document declaration
has no meaning. If there are external markup declarations but there is no
standalone document declaration, the value "no" is assumed. Any XML document for which standalone="no" holds can be converted
algorithmically to a standalone document, which may be desirable for some
network delivery applications. Validity constraint: Standalone Document Declaration The
standalone document declaration MUST have the value "no" if
any external markup declarations contain declarations of: - attributes with ·default· values,
if elements to which these attributes apply appear in the document without
specifications of values for these attributes, or
- entities (other than
amp,
lt,
gt,
apos,
quot), if ·references·
to those entities appear in the document, or - attributes with
tokenized types, where the
attribute appears in the document with a value such that
normalization
will produce a different value from that which would be produced
in the absence of the declaration, or
- element types with ·element content·,
if white space occurs directly within any instance of those types.
An example XML declaration with a standalone document declaration: <?xml version="1.0" standalone='yes'?>
2.10 White Space Handling
In editing XML documents, it is often convenient to use "white space"
(spaces, tabs, and blank lines)
to set apart the markup for greater readability. Such white space is typically
not intended for inclusion in the delivered version of the document. On the
other hand, "significant" white space that should be preserved
in the delivered version is common, for example in poetry and source code. An ·XML processor· MUST always pass
all characters in a document that are not markup through to the application.
A · validating XML processor· MUST also
inform the application which of these characters constitute white space appearing
in ·element content·. A special ·attribute· named xml:space MAY be attached to an element to signal an intention that in that element,
white space should be preserved by applications. In valid documents, this
attribute, like any other, MUST be ·declared·
if it is used. When declared, it MUST be given as an ·enumerated
type· whose values
are one or both of "default" and "preserve".
For example: <!ATTLIST poem xml:space (default|preserve) 'preserve'>
<!ATTLIST pre xml:space (preserve) #FIXED 'preserve'> The value "default" signals that applications' default white-space
processing modes are acceptable for this element; the value "preserve"
indicates the intent that applications preserve all the white space. This
declared intent is considered to apply to all elements within the content
of the element where it is specified, unless overridden with
another instance of the xml:space attribute. This specification does not give meaning to any value of xml:space other than "default" and "preserve". It is an error for other values to be specified; the XML processor MAY report the error or MAY recover by ignoring the attribute specification or by reporting the (erroneous) value to the application. Applications may ignore or reject erroneous values. The ·root element· of any document is considered
to have signaled no intentions as regards application space handling, unless
it provides a value for this attribute or the attribute is declared with a
default value.
2.11 End-of-Line Handling
XML ·parsed entities· are often stored
in computer files which, for editing convenience, are organized into lines.
These lines are typically separated by some combination of the characters
CARRIAGE RETURN (#xD) and LINE FEED (#xA). To
simplify the tasks of ·applications·, the
·XML
processor· MUST behave as if it normalized all line breaks in external parsed
entities (including the document entity) on input, before parsing, by translating
both the two-character sequence #xD #xA and any #xD that is not followed by
#xA to a single #xA character.
2.12 Language Identification
In document processing, it is often useful to identify the natural or formal
language in which the content is written. A special ·attribute·
named xml:lang MAY be inserted in documents to specify the language
used in the contents and attribute values of any element in an XML document.
In valid documents, this attribute, like any other, MUST be ·declared·
if it is used. The
values of the attribute are language identifiers as defined by [IETF RFC 3066], Tags
for the Identification of Languages, or its successor; in addition, the empty string MAY be specified. (Productions 33 through 38 have been removed.) For example: <p xml:lang="en">The quick brown fox jumps over the lazy dog.</p>
<p xml:lang="en-GB">What colour is it?</p>
<p xml:lang="en-US">What color is it?</p>
<sp who="Faust" desc='leise' xml:lang="de">
<l>Habe nun, ach! Philosophie,</l>
<l>Juristerei, und Medizin</l>
<l>und leider auch Theologie</l>
<l>durchaus studiert mit heißem Bemüh'n.</l>
</sp> The intent declared with xml:lang is considered to apply to
all attributes and content of the element where it is specified, unless overridden
with an instance of xml:lang on another element within that content. In particular, the empty value of xml:lang is used on an element B to override a specification of xml:lang on an enclosing element A, without specifying another language. Within B, it is considered that there is no language information available, just as if xml:lang had not been specified on B or any of its ancestors. Note: Language information may also be provided by external transport protocols (e.g. HTTP or
MIME). When available, this information may be used by XML applications, but the more local
information provided by xml:lang should be considered to override it.
A simple declaration for xml:lang might take the form xml:lang CDATA #IMPLIED but specific default values MAY also be given, if appropriate. In a collection
of French poems for English students, with glosses and notes in English, the xml:lang
attribute might be declared this way: <!ATTLIST poem xml:lang CDATA 'fr'>
<!ATTLIST gloss xml:lang CDATA 'en'>
<!ATTLIST note xml:lang CDATA 'en'>
3 Logical Structures[Definition:] Each ·XML
document· contains one or more elements, the boundaries
of which are either delimited by ·start-tags·
and ·end-tags·, or, for ·empty·
elements, by an ·empty-element tag·. Each
element has a type, identified by name, sometimes called its "generic
identifier" (GI), and MAY have a set of attribute specifications.
Each attribute specification has a ·name·
and a ·value·. This specification does not constrain the semantics, use, or (beyond syntax)
names of the element types and attributes, except that names beginning with
a match to (('X'|'x')('M'|'m')('L'|'l')) are reserved for standardization
in this or future versions of this specification. Well-formedness constraint: Element Type Match The Name
in an element's end-tag MUST match the element type in the start-tag. Validity constraint: Element Valid An element is valid
if there is a declaration matching elementdecl
where the Name matches the element type, and one of
the following holds: - The declaration matches EMPTY and the element has no ·content· (not even entity
references, comments, PIs or white space).
- The declaration matches children and the
sequence of ·child elements· belongs
to the language generated by the regular expression in the content model,
with optional white space, comments and
PIs (i.e. markup matching production [27] Misc) between the
start-tag and the first child element, between child elements, or between
the last child element and the end-tag. Note that a CDATA section containing
only white space or a reference
to an entity whose replacement text is character references expanding to white
space do not
match the nonterminal S, and
hence cannot appear in these positions; however, a
reference to an internal entity with a literal value consisting of character
references expanding to white space does match S, since its
replacement text is the white space resulting from expansion of the character
references.
- The declaration matches Mixed and the content
(after replacing
any entity references with their replacement text) consists of
·character data·,
·comments·, ·PIs· and ·child elements· whose types match names in the
content model.
- The declaration matches ANY, and the
content
(after replacing
any entity references with their replacement text)
consists of character data and ·child elements·
whose types
have been declared.
3.1 Start-Tags, End-Tags, and Empty-Element Tags[Definition:] The beginning of every non-empty
XML element is marked by a start-tag. The Name in the start- and end-tags gives the element's type. [Definition:] The Name-AttValue
pairs are referred to as the attribute specifications of the
element, [Definition:] with the Name in each pair referred to as the attribute name
and [Definition:] the content of the AttValue (the text between the ' or "
delimiters) as the attribute value. Note
that the order of attribute specifications in a start-tag or empty-element
tag is not significant. Well-formedness constraint: Unique Att Spec An attribute name
MUST NOT appear more than once in the same start-tag or empty-element tag. Validity constraint: Attribute Value Type The attribute MUST
have been declared; the value MUST be of the type declared for it. (For attribute
types, see 3.3 Attribute-List Declarations.) Well-formedness constraint: No External Entity References Attribute
values MUST NOT contain direct or indirect entity references to external entities. Well-formedness constraint: No < in Attribute Values The ·replacement text· of any entity
referred to directly or indirectly in an attribute value MUST NOT contain a <. An example of a start-tag: <termdef id="dt-dog" term="dog"> [Definition:] The end of every element that begins
with a start-tag MUST be marked by an end-tag containing a name
that echoes the element's type as given in the start-tag: | End-tag | | [42] | ETag | ::= | '</' Name S?
'>' |
|
An example of an end-tag: </termdef> [Definition:] The ·text·
between the start-tag and end-tag is called the element's content: [Definition:] An element
with no content is said to be empty. The representation
of an empty element is either a start-tag immediately followed by an end-tag,
or an empty-element tag. [Definition:] An empty-element
tag takes a special form: Empty-element tags MAY be used for any element which has no content, whether
or not it is declared using the keyword EMPTY. ·For
interoperability·, the empty-element tag SHOULD
be used, and SHOULD only be used, for elements which are declared
EMPTY. Examples of empty elements: <IMG align="left"
src="http://www.w3.org/Icons/WWW/w3c_home" />
<br></br>
<br/>
3.2 Element Type Declarations
The ·element· structure of an ·XML document· MAY, for ·validation·
purposes, be constrained using element type and attribute-list declarations.
An element type declaration constrains the element's ·content·. Element type declarations often constrain which element types can appear
as ·children· of the element. At user
option, an XML processor MAY issue a warning when a declaration mentions an
element type for which no declaration is provided, but this is not an error. [Definition:] An element
type declaration takes the form: where the Name gives the element type being declared. Validity constraint: Unique Element Type Declaration An element
type MUST NOT be declared more than once. Examples of element type declarations: <!ELEMENT br EMPTY>
<!ELEMENT p (#PCDATA|emph)* >
<!ELEMENT %name.para; %content.para; >
<!ELEMENT container ANY>
3.2.1 Element Content[Definition:] An element ·type· has element content when elements
of that type MUST contain only ·child·
elements (no character data), optionally separated by white space (characters
matching the nonterminal S). [Definition:] In this case, the constraint includes a content
model, a simple grammar governing the allowed types of the
child elements and the order in which they are allowed to appear.
The grammar is built on content particles (cps), which
consist of names, choice lists of content particles, or sequence lists of
content particles: where each Name is the type of an element which
MAY appear as a ·child·. Any content
particle in a choice list MAY appear in the ·element
content· at the location where the choice list appears in the grammar;
content particles occurring in a sequence list MUST each appear in the ·element content· in the order given in the list.
The optional character following a name or list governs whether the element
or the content particles in the list may occur one or more (+),
zero or more (*), or zero or one times (?). The
absence of such an operator means that the element or content particle MUST
appear exactly once. This syntax and meaning are identical to those used in
the productions in this specification. The content of an element matches a content model if and only if it is
possible to trace out a path through the content model, obeying the sequence,
choice, and repetition operators and matching each element in the content
against an element type in the content model. ·For
compatibility·, it is an error if the content model
allows an element to match more than one occurrence of an element type in the
content model. For more information, see E Deterministic Content Models. Validity constraint: Proper Group/PE Nesting Parameter-entity ·replacement text· MUST be properly nested with parenthesized
groups. That is to say, if either of the opening or closing parentheses in
a choice, seq, or Mixed
construct is contained in the replacement text for a ·parameter
entity·, both MUST be contained in the same replacement text. ·For interoperability·, if a parameter-entity reference
appears in a choice, seq, or Mixed construct, its replacement text SHOULD contain at
least one non-blank character, and neither the first nor last non-blank character
of the replacement text SHOULD be a connector (| or ,). Examples of element-content models: <!ELEMENT spec (front, body, back?)>
<!ELEMENT div1 (head, (p | list | note)*, div2*)>
<!ELEMENT dictionary-body (%div.mix; | %dict.mix;)*>
3.2.2 Mixed Content[Definition:] An element ·type·
has mixed content when elements of that type MAY contain character
data, optionally interspersed with ·child·
elements. In this case, the types of the child elements MAY be constrained,
but not their order or their number of occurrences: | Mixed-content Declaration | |
where the Names give the types of elements that
may appear as children. The
keyword #PCDATA derives historically from the term "parsed
character data." Validity constraint: No Duplicate Types The
same name MUST NOT appear more than once in a single mixed-content declaration. Examples of mixed content declarations: <!ELEMENT p (#PCDATA|a|ul|b|i|em)*>
<!ELEMENT p (#PCDATA | %font; | %phrase; | %special; | %form;)* >
<!ELEMENT b (#PCDATA)>
3.3 Attribute-List Declarations
·Attributes· are used to associate name-value
pairs with ·elements·. Attribute specifications
MUST NOT appear outside of ·start-tags· and ·empty-element tags·; thus, the productions used to
recognize them appear in 3.1 Start-Tags, End-Tags, and Empty-Element Tags. Attribute-list declarations
MAY be used: - To define the set of attributes pertaining to a given element type.
- To establish type constraints for these attributes.
- To provide ·default values· for
attributes.
[Definition:] Attribute-list
declarations specify the name, data type, and default value (if any)
of each attribute associated with a given element type: | Attribute-list Declaration | |
The Name in the AttlistDecl
rule is the type of an element. At user option, an XML processor MAY issue
a warning if attributes are declared for an element type not itself declared,
but this is not an error. The Name in the AttDef
rule is the name of the attribute. When more than one AttlistDecl is provided
for a given element type, the contents of all those provided are merged. When
more than one definition is provided for the same attribute of a given element
type, the first declaration is binding and later declarations are ignored. ·For interoperability,· writers of DTDs MAY choose
to provide at most one attribute-list declaration for a given element type,
at most one attribute definition for a given attribute name in an attribute-list
declaration, and at least one attribute definition in each attribute-list
declaration. For interoperability, an XML processor MAY at user option
issue a warning when more than one attribute-list declaration is provided
for a given element type, or more than one attribute definition is provided
for a given attribute, but this is not an error.
3.3.1 Attribute TypesXML attribute types are of three kinds: a string type, a set of tokenized
types, and enumerated types. The string type may take any literal string as
a value; the tokenized types have varying lexical and semantic constraints.
The validity constraints noted in the grammar are applied after the attribute
value has been normalized as described in 3.3.3 Attribute-Value Normalization. Validity constraint: ID Values of type ID MUST match the Name production. A name MUST NOT appear more than once
in an XML document as a value of this type; i.e., ID values MUST uniquely
identify the elements which bear them. Validity constraint: One ID per Element Type An element
type MUST NOT have more than one ID attribute specified. Validity constraint: ID Attribute Default An ID attribute
MUST have a declared default of #IMPLIED or #REQUIRED. Validity constraint: IDREF Values of type IDREF MUST
match the Name production, and values of type IDREFS MUST match Names; each Name MUST match the value of an ID attribute on some element in the XML document;
i.e. IDREF values MUST match the value of some ID attribute. Validity constraint: Entity Name Values of type ENTITY MUST match the Name production, values of type ENTITIES MUST match Names; each Name MUST match the name of an ·unparsed entity·
declared in the ·DTD·. Validity constraint: Name Token Values of type NMTOKEN MUST match the Nmtoken production; values of type NMTOKENS MUST match Nmtokens. [Definition:] Enumerated attributes MUST take one of a list of values
provided in the declaration. There are two kinds of enumerated types: | Enumerated Attribute Types | |
A NOTATION attribute identifies a ·notation·,
declared in the DTD with associated system and/or public identifiers, to be
used in interpreting the element to which the attribute is attached. Validity constraint: Notation Attributes Values of this type
MUST match one of the notation names
included in the declaration; all notation names in the declaration MUST be
declared. Validity constraint: One Notation Per Element Type An element type MUST NOT have more than one NOTATION
attribute specified. Validity constraint: No Notation on Empty Element ·For compatibility·,
an attribute of type NOTATION MUST NOT be declared on an element
declared EMPTY. Validity constraint: No Duplicate
Tokens The notation names in a single NotationType
attribute declaration, as well as the NmTokens in a single
Enumeration attribute declaration, MUST all be distinct. Validity constraint: Enumeration Values of this type MUST match
one of the Nmtoken tokens in the declaration. ·For interoperability,· the same Nmtoken SHOULD NOT occur more than once in the enumerated
attribute types of a single element type.
3.3.2 Attribute DefaultsAn ·attribute declaration· provides information
on whether the attribute's presence is REQUIRED, and if not, how an XML processor
is
to react if a declared attribute is absent in a document. In an attribute declaration, #REQUIRED means that the attribute
MUST always be provided, #IMPLIED that no default value is provided.
[Definition:] If
the declaration is neither #REQUIRED nor #IMPLIED, then
the AttValue value contains the declared default
value; the #FIXED keyword states that the attribute MUST always have
the default value.
When an XML processor encounters
an element
without a specification for an attribute for which it has read a default
value declaration, it MUST report the attribute with the declared default
value to the application. Validity constraint: Required Attribute If the default
declaration is the keyword #REQUIRED, then the attribute MUST be
specified for all elements of the type in the attribute-list declaration. Validity constraint: Attribute
Default Value Syntactically Correct The declared default value MUST meet the syntactic
constraints of the declared attribute type. Note that only the
syntactic constraints of the type are required here; other constraints (e.g.
that the value be the name of a declared unparsed entity, for an attribute of
type ENTITY) may come into play if the declared default value is actually used
(an element without a specification for this attribute occurs). Validity constraint: Fixed Attribute Default If an attribute
has a default value declared with the #FIXED keyword, instances of
that attribute MUST match the default value. Examples of attribute-list declarations: <!ATTLIST termdef
id ID #REQUIRED
name CDATA #IMPLIED>
<!ATTLIST list
type (bullets|ordered|glossary) "ordered">
<!ATTLIST form
method CDATA #FIXED "POST">
3.3.3 Attribute-Value NormalizationBefore the value of an attribute is passed to the application or checked
for validity, the XML processor MUST normalize the attribute value by applying
the algorithm below, or by using some other method such that the value passed
to the application is the same as that produced by the algorithm. - All line breaks MUST have been normalized on input to #xA as described
in 2.11 End-of-Line Handling, so the rest of this algorithm operates
on text normalized in this way.
- Begin with a normalized value consisting of the empty string.
- For each character, entity reference, or character reference in the
unnormalized attribute value, beginning with the first and continuing to the
last, do the following:
- For a character reference, append the referenced character to the
normalized value.
- For an entity reference, recursively apply step 3 of this algorithm
to the replacement text of the entity.
- For a white space character (#x20, #xD, #xA, #x9), append a space
character (#x20) to the normalized value.
- For another character, append the character to the normalized value.
If the attribute type is not CDATA, then the XML processor MUST further
process the normalized attribute value by discarding any leading and trailing
space (#x20) characters, and by replacing sequences of space (#x20) characters
by a single space (#x20) character. Note that if the unnormalized attribute value contains a character reference
to a white space character other than space (#x20), the normalized value contains
the referenced character itself (#xD, #xA or #x9). This contrasts with the
case where the unnormalized value contains a white space character (not a
reference), which is replaced with a space character (#x20) in the normalized
value and also contrasts with the case where the unnormalized value contains
an entity reference whose replacement text contains a white space character;
being recursively processed, the white space character is replaced with a
space character (#x20) in the normalized value. All attributes for which no declaration has been read SHOULD be treated
by a non-validating processor as if declared CDATA. It
is an error if an
·attribute
value |
|
|