Introduction to Elements

This section describes each element in the Authoring Tag Set. Although the elements are declared in many different modules, they are described here in alphabetical order of their tag names (i.e., element type names). The tag name is the shorter machine-readable name used in tagged XML documents, the DTDs and schemas, and by parsing and editing software; for example, the tag name <p> is used for the element named Paragraph.

Each element is described by a separate HTML 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. These sections within the page always appear in the following order, although any given element description may not contain all the sections:

Definition

This segment 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

This segment (when present) provides additional information about the element, explanations of similar or contrasting elements, or instructions for element usage. (See also Related Elements described below.)

Authoring Notes are usage instructions aimed at persons writing or editing journal articles according to a tag set written from this Suite.

Implementor’s Notes are instructions written to persons creating or maintaining the Tag Set DTD or schemas, for example, information explaining that the Chemical Markup Language has not been included in this Tag Set and where and how it could be included.

Attributes

For an element that may 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 the Tag Set, then a longer, more descriptive name. Full attribute definitions are not provided; instead, each attribute is linked to its description in the Attribute Section, which follows the Element Description Section in this Tag Library.

Related Elements

This segment contains information about elements similar to or associated with the current element. For example, a <def-list> has many components: an optional title, possibly headers for both the term and definition columns, and multiple wrapper elements, each containing a single term and its definition. In order to better understand the relationship of such components, information about all of them will be provided in the Related Elements segment for each element that is part of a <def-list>.

Model Information

Content Model

The content model is a copy of the declaration for this element from the DTD, i.e., the “content” of an element as shown in XML syntax.

Description

The description is an English-language explanation of the “content” of the element, that is, what is allowed to be inside the element. This content description contains the same information in plain English that the Content Model provides in XML syntax. 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 others elements in some combination. If an element contains other elements, their names are listed here.

Context Table Segment

One of the sections of the Tag Library is a Context Table that provides information about where an element can be used. It show the context for all elements in a tabular form. This Context Table Segment lists the elements which may contain this particular element.

Tagged Example

This portion of the element description page 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 in bold.

Module (Implementor Information)

Names the base Suite module or Authoring DTD module in which the element is defined. If an element is defined only in the base Suite, the base module name is given. In those instances in which this DTD over-rides the Suite’s declaration for an element, the name of the DTD-specific over-ride module is given instead.