Introduction to Elements
This section describes each element in the TBX Tag Set in alphabetical order of their tag
names (i.e., element type names). The tag name is the shorter machine-readable name used in
tagged documents, DTD fragments and schemas, and by software; for example, the tag name
<tbx:xGraphic> is used for the element named External Graphic.
Each element is described by a separate page, where the heading for the page displays
the element’s tag name followed by its longer descriptive name. The rest of the element
description page discusses aspects of the element and its usage. The sections within an element page
always appear in the following order, although any given element page may not contain all the
sections:
Description (untitled) | Provides a narrative description of the element, that is, it “defines”
the element and may provide information on its usage. This is not intended to be a formal
dictionary definition, but more to provide information about an element and how it may be
used. |
|---|---|
Remarks | Provides additional information about the element, explanations of similar or
contrasting elements, or instructions for element usage. (See also Related Elements described below.) |
Related Elements | Contains information about elements that may be associated with or confused with the
current element. In order to help users better understand the relationship among such
components, or how to know when to use structures that may be confusing, these notes are
provided. |
Attributes | For an element that may/must take attributes, this segment contains an alphabetical list of
those attributes. Each line contains the identification for one attribute: first, the
attribute’s name as it appears in this Tag Set, then a longer, more descriptive name. Each
attribute is linked to its description in the Attribute Section, which follows the Element
Description Section in this Tag Library. |
Model Description | The description is an English-language explanation of the “content” of
the element, that is, what is allowed to be inside the element. For example, an element may
contain only text (“text, numbers, or special
characters”), other elements (for example, a title followed by a paragraph), or both
text and other elements in some combination. If an element contains other elements, their
names are listed here. |
This element may be contained in | This segment lists the contexts in which this element may be used. |
Example | Provides an excerpt of a tagged XML document, showing use of the current element.
Usually an element is shown in context, with its surrounding elements, and the current
element is highlighted. More than one example may be given, to illustrate different ways the element might be used. |