In the Authoring DTD, the topmost element (your XML “document”) is an <article>. An article is a top-level component of a journal, for example, a research article, an editorial, or a book review.
Each article is composed of one or more parts which must appear (if present) in the following order:
|
Element |
Elements are nouns, like “Speech” and “Speaker”, that represent components of journal articles, the articles themselves, and accompanying metadata. |
|
Metadata |
Metadata is data about the data, for example, bibliographic information. The distinction is between metadata elements which describe an article (such as the copyright year for the article) versus elements which contain the textual and graphical content of the article (such as a paragraph or a list). |
|
Attribute |
Attributes are name/value pairs that hold facts about an element, for example, 1) the name of a pointer to an external file that contains an image, 2) a unique identifier, so that an element may be referenced, or 3) an indication of which type of list (e.g., numbered, bulleted, or plain) is being requested when using the <list> tag. Each attribute has both a name (e.g., list-type ) and a value (e.g., “bulleted”). |
A full DTD Suite delivery package includes the Authoring DTD, the customization files for this DTD, the modules of the full Archiving and Interchange DTD Suite that have been used in this DTD, one or more complete tagged sample documents, and this documentation. The Tag Library is delivered as a set of linked HTML files. How you use the documentation will depend on what you need to learn about the modules and the DTD.
If you want to learn about the elements and the attributes in the Suite, so that you can write an article using the tag set, edit an article that is already tagged in this tag set, or learn how the journal article model is constructed, here is a good way to start.
This Tag Library contains the following sections:
|
Introduction |
This introduction to the contents of this Tag Library, to the design philosophy and intended usage of the Archiving and Interchange DTD Suite, and to the Authoring DTD |
|
Elements Section |
Definitions, tagged examples, and usage notes for each of the elements in the Authoring DTD (and the parts of the Archiving and Interchange DTD Suite used in this DTD). The element descriptions are listed in alphabetical order by tag name. (Note: Each element has two names: a “tag name” (formally called an element-type name) that is used in tagged documents, the DTDs, and by the software, and an “element name” (usually longer) that provides a fuller, more descriptive name for the benefit of human readers. For example, a tag name might be <disp-quote> with the corresponding element name Quote, Displayed or a tag name might be <verse-group> with the corresponding element name Verse Form for Poetry. |
|
Attributes Section |
Descriptions of the attributes in the DTD modules. Like elements, attributes also have two names: the shorter machine-readable one and a (usually longer) human-readable one. Attributes are listed in order by the shorter machine-readable names, for example, the attribute short name list-type instead of the more informal, easier to read: Type of List. |
|
Parameter Entity Section (For Implementors Only) |
Names (with occasional descriptions) and contents of the Parameter Entities in the DTD modules |
|
Context Table |
Listings of where each element may be used. All elements are given in a simple alphabetical list. There is a single table for the elements from all the Suite modules that are called from the DTD. The Context Table is formatted in two columns. The first column lists an element’s tag name, and the second column lists the tag names of all the elements in which the first element may occur. For example, if the first column contains the front matter element <front> and the second column contains only the article element <article>, this means that the <front> (Front Matter) element may only be used inside an <article> (Article) element. Most elements may be used inside more than one other element. For example, the element <access-date> (Access Date for Cited Work) may be used inside the <citation>, <nlm-citation>, <product>, and <related-article> elements. Note: These Context Table listings (which list where an element may be used) are the inverse of the content definition that is given as a part of each element description, which lists what can be inside the named element. |
|
Document Hierarchy Diagrams |
Tree-like graphical representations of the content of many elements. This can be a fast visual way to determine the structure of an article or of most elements within an article. |
|
Authoring DTD and Suite Naming Rules |
The naming conventions for element and attribute names, such as the use of lower case, concatenation, and abbreviations within tags |
|
Full Article Sample |
A complete article is provided in XML according to this DTD. This sample has been provided to help users better understand the DTD’s overall structure and the relationship between elements. |
|
DTD Section |
Copies of the Authoring DTD, its five DTD-specific customization modules, and the modules of the full Archiving and Interchange DTD Suite. |
|
Index By Element Name |
Index of element descriptions, alphabetically by element name (the longer, more descriptive name) |
|
Index By Tag Name |
Index of element descriptions, alphabetically by tag name (element-type name) |
| <alt-text> | The tag name of an element (Written in lower case with the entire name surrounded by “< >”) |
| Alternate Title Text (For a Figure, Etc.) | The element name (long descriptive name of an element) or the descriptive name of an attribute (Written in title case, that is, with important words capitalized, and the words separated by spaces) |
| must not | Emphasis to stress a point |