You can use the Tag Library as a reference to look up XML tags and how to use them; to browse around and familiarize yourself
with this Tag Set; to see examples of correct or recommended usage; and even to find guidance for how to implement software
to handle documents that are marked up using this Tag Set.
In all Tag Library sections except
the “Document Hierarchy Diagrams”, when the text mentions a
specific element, attribute, or parameter entity, the name is linked to the page
that describes that item. This makes it easy to access related information.
The following Tag Library sections are generally useful; the remaining sections are written
for implementors and people modifying or installing the Tag Set.
Document Hierarchy Diagrams section illustrates portions of the
Tag Set’s structure that are nested or that have complex structures. This
information can also be gleaned on each Element page under the heading “Model
Description”. The diagrams use some special symbols that are described
Common Tagging Practice section contains descriptions of more
general issues on how to use this Tag Set. For example, affiliations and keywords involve
numerous elements, attributes, and general design choices. These are discussed in special
sections, rather than under some particular related element(s). These sections are
important for learning to use this Tag Set well, and links to them are provided from
elements and attributes to which they are especially relevant.
Element Context Table has an alphabetical list of available
elements. For each one, it shows all the elements that can directly contain it. This is a
great way to find out whether a certain element can be used in a certain context. This
information can also be gleaned on each Element page under the heading “This
element may be contained in”.
Index section works like the index at the
back of many books. You can use it to find where a given item or topic is discussed. The
index lists elements, attributes, and discussion topics under many related names and
descriptions, so if you don’t know the exact tag name to use for something, try
looking in the index under various related words, and you will most likely find a
reference to the applicable tag or attribute.
These pages start out with the XML name of the element they describe, followed by a more English-like, descriptive name and
a definition. Many elements also have remarks that give further details, a discussion of best practice, notes that may be
helpful to users that need to convert data into this Tag Set from other sources, and cross-references.
There is also a description of exactly what elements are allowed within the element and in what combinations. This information
is provided in three forms:
- “Content Model”
— the “raw” content model in XML syntax. This may contain parameters entities, of the form “%name;”, which often stand in
for commonly-used lists of elements. Users not familiar with formal XML (DTD) syntax will likely prefer the “Expanded Content
Model” or the “Description”.
- “Expanded Content Model”
— the content model with all parameter entities expanded to their ultimate values. This list directly shows all the elements
that the described element can contain, and in what combination.
— a text description of the allowable content, which is much longer than the
content models, but should be readily understandable without having to learn the details of content models and their punctuation.
These descriptions often refer to categories of elements, such as “the address elements”. These categories correspond to
parameter entities that are shown in the “raw” content model, and are re-used in many places.
For many elements, the “Document Hierarchy Diagrams” provides a fourth descriptive form. This form is described below.
Most element pages include specific examples that show how the element can be used, including any relevant context. These
examples have all been tested and validated; however, portions are often left out or replaced by “...” to keep examples manageable.
In addition, the most relevant parts of examples are highlighted so they are easy to find.
For more details see the Introduction to Elements section.
Attribute pages are organized very much like element pages. However, because an attribute cannot have sub-elements, the description
instead tells which elements can use the attribute, what kind of attribute it is, and what the permitted and default values
are (the default value is used when the attribute is not specified at all on a particular instance of an element).
Some common kinds of attributes are:
An XML identifier (ID)
This kind of attribute must have a value that is an XML NAME, which can consist of XML name characters (alphabetical characters,
digits, period, underscore, and hyphen), and cannot start with a digit. Every ID
attribute value in a single document must be unique and provides a way to link or refer to its element (for example, using
attributes are generally named @id
An identifier (IDREF)
This kind of attribute must have a value that is the same as some ID
value in the same document. IDREF
s appear on elements that refer to other elements such as <xref>
attributes are generally named @rid
. Some @rid
attributes are of type IDREFS
, which is simply a space-separated list of IDREF
Text, numbers, or special characters (CDATA)
These attributes can take any string value at all. If the attribute value is surrounded by single quotes, then single quotes
cannot appear inside; if the attribute value is surrounded by double quotes, then double quotes cannot appear inside. In either
case, the prohibited character can instead be represented by an XML character reference such as “'”. XML elements cannot
be placed within attribute values.
There are many attributes whose names end in “-type”. They are generally CDATA attributes as described above. They are typically assigned tokens as values, containing no spaces. Typically if there are
spaces in the value, they separate multiple independent tokens, all of which apply. For example, some element might be both
of type “important” and “normative”, and be given type “important normative”. In many cases, the Tag Library gives suggested values for such attributes. Unless specifically stated otherwise, those
values are not the only values permitted.
Finally, there may be a “Restrictions” section that specifies if the attribute must always be specified or is optional.
For more details see the Introduction to
These diagrams illustrate portions of the hierarchical (nested) structure of this Tag
Set. Each diagram has one element “root” and may illustrate the structures
of several additional elements. For each element illustrated, its name appears in a box on
the left, with lines to boxes for each of its possible child-elements, which are in a
column on the right.
Boxes for child elements can have names and/or symbols within. If the box has merely
“...”, it means that the actual content has been omitted, to save space
or improve clarity. If it has merely an icon of a page with lines, it stands for text
content rather than an actual element.
If a box has an element name, then symbols at the left end of the box indicate whether
that element is required and/or repeatable. These symbols are called “occurrence
means that the item is optional (zero or one)
means that the item may occur any number of times (zero or more)
means that the item must occur at least once, but may occur any number of
times (one or more)
a thick vertical bar on the left of the box
means that the item is the “document element”: the top-most
element, such as <article> or <book> and is
means that the item must occur exactly once
The symbols at the right end of a box have these meanings:
˜ (a tilde)
means that the item may have attribute
a thick vertical bar on the right of the box
means that the item is expanded elsewhere (For example, if an element is
permitted in multiple places within a certain parent element, there is little
point in repeating its information many times.
The lines that connect a box to boxes on its left may either be squared-off or direct
(angled) lines. The former indicates that the boxes to the right must occur in the order
shown; the latter indicates that any order is permitted.
For more details see the Introduction to
Document Hierarchy Diagrams section.