20.3. XML Syntax
For each section of this reference that maps directly to an XML
language structure, an informal syntax reference describes theat
structure's form. The following conventions are used
with these syntax blocks:
Format
|
Meaning
|
DOCTYPE
|
Bold text indicates literal characters that must appear as written
within the document (e.g., DOCTYPE).
|
encoding-name
|
Italicized text indicates that the user must replace the text with
real data. The item indicates what type of data should be inserted
(e.g., encoding-name = en-us).
|
|
|
The vertical bar | indicates that only one out of a list of possible
values can be selected.
|
[ ]
|
Square brackets indicate that a particular portion of the syntax is
optional.
|
20.3.1. Global Syntax Structures
Every XML document is broken into two primary sections: the
prolog and the document
element. A few documents may also have comments
or processing instructions that follow the root element in a sort of
epilog (an unofficial term). The prolog contains
structural information about the particular type of XML document you
are writing, including the XML declaration and document type
declaration. The prolog is optional, and if a document does not need
to be validated against a DTD, it can be omitted completely. The only
required structure in a well-formed XML document is the top-level
document element itself.
The following syntax structures are common to the
entire XML document. Unless otherwise noted within a subsequent
reference item, the following structures can appear anywhere within
an XML document.
Besides
user-defined entity references, XML includes the five named entity
references shown in Table 20-1 that can be used
without being declared. These references are a subset of those
available in HTML documents.
Table 20-1. Predefined entities The < and &
entities must be used wherever < or
& appear in document content. The
> entity is frequently used wherever
> appears in document content, but is only
mandatory to avoid putting the sequence ]]>
into content. ' and
" are generally used only within
attribute values to avoid conflicts between the value and the quotes
used to contain the value.
Though the parser must recognize these entities regardless of whether
they have been declared, you can declare them in your DTD without
generating errors.
The presence of these "special"
predefined entities creates a conundrum within an XML document.
Because it is possible to use these references without declaring
them, it is possible to have a valid XML document that includes
references to entities that were never declared. The XML
specification actually encourages document authors to declare these
entities to maintain the integrity of the entity
declaration-reference rule. In practical terms, declaring these
entities only adds unnecessary complexity to your document.
CDATA (Character Data) Sections | |
<![CDATA[unescaped character & markup data]]>
| |
XML documents consist of markup
and character data. The < or
& characters cannot be included inside normal
character data without using a character or entity reference, such as
& or &. By
using a reference, the resulting < and
& characters are not recognized as markup by
the parser, but will become part of the data stream to the
parser's client application.
For large blocks of character data--particularly if the data
contains markup, such as an HTML or XML fragment--the
CDATA section can be used. Within a
CDATA block, every character between the opening
and closing tag is considered character data. Thus, special
characters can be included in a CDATA section with
impunity, except for the CDATA closing sequence,
]]>.
CDATA sections are very useful for tasks such as
enclosing XML or HTML documents inside of tutorials explaining how to
use markup, but it is difficult to process the contents of
CDATA sections using XSLT, the DOM, or SAX as
anything other than text.
NOTE:
CDATA sections cannot be nested. The character
sequence ]]> cannot appear within data that is
being escaped, or the CDATA block will be closed
prematurely. This situation should not be a problem ordinarily, but
if an application includes XML documents as unparsed character data,
it is important to be aware of this constraint. If it is necessary to
include the CDATA closing sequence in the data,
close the open CDATA section, include the closing
characters using character references to escape them, then reopen the
CDATA section to contain the rest of the character
data.
An XML entity can best be
understood as a macro replacement facility, in which the replacement
can be either parsed (the text becomes part of the XML document) or
unparsed. If unparsed, the entity declaration points to external
binary data that cannot be parsed. Additionally, the replacement text
for parsed entities can come from a string or the contents of an
external file. During parsing, a parsed entity reference is replaced
by the substitution text that is specified in the entity declaration.
The replacement text is then reparsed until no more entity or
character references remain.
To simplify document parsing, two distinct types
of entities are used in different situations: general and parameter.
The basic syntax for referencing both entity types is almost
identical, but specific rules apply to where each type can be used.
Parameter Entity References |
|
When an XML parser encounters a parameter entity reference within a
document's DTD, it replaces the reference with the
entity's text. Whether the replacement text is
included as a literal or included from an external entity, the parser
continues parsing the replacement text as if it had always been a
part of the document. This parsing has interesting implications for
nested entity references:
<!ENTITY % YEAR "2001">
<!ENTITY COPYRIGHT "© %YEAR;">
. . .
<copyright_notice>©RIGHT;</copyright_notice>
After the necessary entity replacements are made, the previous
example would yield the following canonical element:
<copyright_notice>© 2001</copyright_notice>
WARNING:
XML treats parameter entity references
differently depending on where they appear within the DTD. References
within the literal value of an entity declaration (such as
Copyright © %YEAR;) are valid only as
part of the external subset. Within the internal subset, parameter
entity references may occur only where a complete markup declaration
could exist. In other words, within the internal subset, parameter
references can be used only to include complete markup declarations.
Parameter entity references are recognized only within the DTD;
therefore, the % character has no significance
within character data and does not need to be escaped.
Comments can appear anywhere in your document or DTD, outside of
other markup tags. XML parsers are not required to preserve contents
of comment blocks, so they should be used only to store information
that is not a part of your application. In reality, most information
you might consider storing in a comment block probably should be made
an official part of your XML application. Rather than storing data
that will be read and acted on by an application in a comment, as is
frequently done in HTML documents, you should store it within the
element structure of the actual XML document. Enhancing the
readability of a complex DTD or temporarily disabling blocks of
markup are effective uses of comments.
NOTE:
The character sequence -- cannot be included
within a comment block, except as part of the tag closing text.
Because comments cannot be nested, commenting out a comment block is
impossible. If large blocks of markup that include comments must be
temporarily disabled, consider wrapping them in a
CDATA section to cause the parser to read them as
simple text instead of markup.
Processing instructions provide an escape mechanism that allows an
XML application to include instructions to an XML processor that are
not part of the XML markup or character data. The processing
instruction target can be any legal XML name, except
xml in any combination of upper- and lowercase
(see Chapter 2). Linking to a stylesheet to
provide formatting instructions for a document is a common use of
this mechanism. According to the principles of XML, formatting
instructions should remain separate from the actual content of a
document, but some mechanism must associate the two. Processing
instructions are significant only to applications that recognize
them.
The notation facility can indicate exactly what type of processing
instruction is included, and each individual XML application must
decide what to do with the additional data. No action is required by
an XML parser when it recognizes that a particular processing
instruction matches a declared notation. When this facility is used,
applications that do not recognize the public or system identifiers
of a given processing instruction target should realize that they
could not properly interpret its data portion.
The XML declaration serves several purposes. It tells the parser what
version of the specification was used, how the document is encoded,
and whether the document is completely self-contained or has
references to external entities.
The XML declaration, if included, must be the first thing that
appears in an XML document. Nothing, except possibly a Unicode
byte-order mark, may appear before this structure's
initial < character.
20.3.2. DTD (Document Type Definition)
Chapter 2 explained the difference
between well-formed and valid documents. Well-formed documents that
include and conform to a given DTD are considered valid. Documents
that include a DTD and violate the rules of that DTD are invalid. The
DTD is comprised of the DOCTYPE declaration and
both the internal subset (declarations contained
directly within the document) and the external
subset (declarations that are included from outside the
main document).
General entities are declared within the document type definition and
then referenced within the document's text and
attribute content. When the document is parsed, the
entity's replacement text is substituted for the
entity reference. The parser then resumes parsing, starting with the
text that was just replaced.
General entities are declared within
the DTD using a superset of the syntax used to declare parameter
entities. Besides the ability to declare internal parsed entities and
external parsed entities, you can declare external unparsed entities
and associate an XML notation name with them.
Internal entities
are used when the replacement text can be efficiently stored inline
as a literal string. The replacement text within an internal entity
is included completely in the entity declaration itself, obviating
the need for an external file to contain the replacement text. This
situation closely resembles the string replacement macro facilities
found in many popular programming languages and environments:
<!ENTITY name "Replacement text">
There are two types of external entities: parsed
and unparsed. When a parsed entity is referenced, the contents of the
external entity are included in the document, and the XML parser
resumes parsing, starting with the newly included text. When an
unparsed entity is referenced, the parser supplies the application
with the unparsed entity's URI, but it does not
insert that data into the document or parse it. What to do with that
URI is up to the application. Any entity declared with an XML
notation name associated with it is an external unparsed entity, and
any references to it within the document must be made using attribute
values of type ENITITY or
ENTITIES:
<!ENTITY name SYSTEM
"system-literal">
<!ENTITY name PUBLIC
"pubid-literal" "system-literal">
The document type declaration
can include part or all of the document type definition from an
external file. This external portion of the DTD is referred to as the
external DTD subset and may contain markup declarations, conditional
sections, and parameter entity references. It must include a text
declaration if the character encoding is not UTF-8 or UTF-16:
<?xml[ version="1.0"] encoding="encoding-name"?>
This declaration (if present) would then be followed by a series of
complete DTD markup statements, including ELEMENT,
ATTLIST, ENTITY, and
NOTATION declarations, as well as conditional
sections, and processing instructions. For example:
<!ELEMENT furniture_item (desc, %extra_tags; user_tags?, parts_list,
assembly+)>
<!ATTLIST furniture_item
xmlns CDATA #FIXED "http://namespaces.oreilly.com/furniture/"
>
...
Element type declarations provide a template for
the actual element instances that appear within an XML document. The
declaration determines what type of content, if any, can be contained
within elements with the given name. The following sections describe
the various element content options available.
NOTE:
Since
namespaces are not explicitly
included in the XML 1.0 recommendation, element and attribute
declarations within a DTD must give the complete (qualified) name
that will be used in the target document. This means that if
namespace prefixes will be used in instance documents, the DTD must
declare them just as they will appear, prefixes and all. While
parameter entities may allow instance documents to use different
prefixes, this still makes complete and seamless integration of
namespaces into a DTD-based application very awkward.
Elements that are declared empty cannot contain content or nested
elements. Within the document, empty elements may use one of the
following two syntax forms:
<name [attribute="value" ...]/>
<name [attribute="value" ...]></name>
This content specifier acts as a wildcard, allowing elements of this
type to contain character data or instances of any valid element
types that are declared in the DTD.
Mixed Content Element Type | |
Element declarations that include the #PCDATA
token can include text content mixed with other nested elements that
are declared in the optional portion of the element declaration. If
the #PCDATA token is used, it is not possible to
limit the number of times or sequence in which other nested elements
are mixed with the parsed character data. If only text content is
desired, the asterisk is optional.
<!ELEMENT name (child_node_regexp)[? | * | +]> | |
XML provides a simple regular-expression syntax that can be used to
limit the order and number of child elements within a parent element.
This language includes the following operators:
Operator
|
Meaning
|
Name
|
Matches an element of the given name
|
( ... )
|
Groups expressions for processing as sets of sequences (using the
comma as a separator) or choices (using | as a separator)
|
?
|
Indicates that the preceding name or expression can occur zero or one
times at this point in the document
|
*
|
Indicates that the preceding name or expression can occur zero or
more times at this point in the document
|
+
|
Indicates that the preceding name or expression must occur one or
more times at this point in the document
|
Attribute List Declaration | |
<!ATTLIST element_name [attribute_name attribute_type default_decl]*> | |
In a valid XML document it is necessary to declare the attribute
names, types, and default values that are used with each element
type.
The attribute name must obey the rules for XML identifiers, and no
duplicate attribute names may exist within a single declaration.
Attributes
are declared as having a specific type. Depending on the declared
type, a validating XML parser will constrain the values that appear
in instances of those attributes within a document. The following
table lists the various attribute types and their meanings:
Attribute type
|
Meaning
|
CDATA
|
Simple character data.
|
ID
|
A unique ID value within the current XML document.
No two ID attribute values within a document can
have the same value, and no element can have two attributes of type
ID.
|
IDREF,
IDREFS
|
A single reference to an element ID
(IDREF) or a list of IDs
(IDREFS), separated by spaces. Every
ID token must refer to a valid
ID located somewhere within the document that
appears as the ID type
attribute's value.
|
ENTITY, ENTITIES
|
A single reference to a declared unparsed external entity
(ENTITY) or a list of references
(ENTITIES), separated by spaces.
|
NMTOKEN, NMTOKENS
|
A single name token value (NMTOKEN) or a list of
name tokens (NMTOKENS), separated by spaces.
|
The NOTATION attribute mechanism lets XML document
authors indicate that the character content of some elements obey the
rules of some formal language other than XML. The following short
sample document shows how notations might be used to specify the type
of programming language stored in the
code_fragment element:
<?xml version="1.0"?>
<!DOCTYPE code_fragment
[
<!NOTATION java_code PUBLIC "Java source code">
<!NOTATION c_code PUBLIC "C source code">
<!NOTATION perl_code PUBLIC "Perl source code">
<!ELEMENT code_fragment (#PCDATA)>
<!ATTLIST code_fragment
code_lang NOTATION (java_code | c_code | perl_code) #REQUIRED>
]>
<code_fragment code_lang="c_code">
main( ) { printf("Hello, world."); }
</code_fragment>
Enumeration Attribute Type | |
This syntax limits the possible values of the given attribute to one
of the name tokens from the provided list:
<!ELEMENT door EMPTY>
<!ATTLIST door
state (open | closed | missing) "open">
. . .
<door state="closed"/>
If an optional attribute is not present on a given element, a default
value may be provided to be passed by the XML parser to the client
application. The following table shows various forms of
the attribute default value clause and their meanings:
Default value clause
|
Explanation
|
#REQUIRED
|
A value must be provided for this attribute.
|
#IMPLIED
|
A value may or may not be provided for this attribute.
|
[#FIXED ]
"default
value"
|
If this attribute has no explicit value, the XML parser substitutes
the given default value. If the #FIXED token is
provided, this attribute's value must match the
given default value. In either case, the parent element always has an
attribute with this name.
|
The #FIXED modifier indicates that the attribute
may contain only the value given in the attribute declaration.
Although redundant, it is possible to provide an explicit attribute
value on an element when the attribute was declared as
#FIXED. The only restriction is that the attribute
value must exactly match the value given in the
#FIXED declaration.
Notation declarations are used to provide information to an XML
application about the format of the document's
unparsed content. Notations are used by unparsed external entities,
processing instructions, and some attribute values.
Notation information is not significant to the XML parser, but it is
preserved for use by the client application. The public and system
identifiers are made available to the client application so that it
may correctly interpret non-XML data and processing instructions.
 |  |  | 20.2. Annotated Sample Documents |  | 20.4. Constraints |
Copyright © 2002 O'Reilly & Associates. All rights reserved.
|