◇◆
Introduction to Elements
Each element in the Tag Set and the XHTML-inspired table model are described in this
Tag Library. A separate Tag Library describing the OASIS Exchange CALS Table model
is available at: https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/index.html
The elements in this Tag Library are described in alphabetical
order by their tag names (i.e., element type names). The tag name is the shorter
machine-readable name used in XML tagged documents, DTDs and schemas, and (typically)
by
software; for example, the tag name <p> is
used for the element named Paragraph.
Content of an Element Page
Each element is described in a single page that displays:
- The element’s tag name followed by its longer descriptive name (all on one line), and
- Sections describing aspects of the element and its usage. Not all elements will show all sections.
The sections within the page always appear in the following order (if present):
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 the rationale
for an element and how the element may be used.
|
||||||||
---|---|---|---|---|---|---|---|---|---|
Usage/Remarks
|
Provides additional information about the element, explanations of similar or
contrasting elements, or instructions for element usage. (See also Related Elements described below.)
Best practice notes are identified with a heading such as “Best Practice” or “Common
Practice” and have a colored background for emphasis.
More complex “Usage/Remarks” sections may contain folded (collapsed) subsections.
Instructions on navigating in this document, including opening and closing collapsed
sections, appear in Navigation.
Conversion Notes and Technical Notes are explicit and sometimes
very technical instructions to people who are mapping between documents
tagged according to this Tag Set and those tagged according to other tag sets; building
conversion software to convert between another tag set and one written
from this Suite; or producing products based on this Suite. These notes may be more
technical than a general reader will need.
Authoring Notes are usage instructions aimed at persons writing or editing journal
articles according to this Tag Set.
Implementor’s Notes are instructions written to persons creating or
maintaining DTDs or schemas based on the Suite.
|
||||||||
Related Elements
|
Contains information about elements associated with or confused with the current element.
For some complex structures, such as two-part definition lists (<def-list>), this section describes all the elements that may make up such a list.
|
||||||||
Attributes
|
All of the attributes, if any, available on an element are listed in the order:
Each line contains the attribute name as it appears in this Tag Set. If you hover
over the name, a more descriptive name appears. If the attribute is required, has
a default value, or has a fixed value, then that is noted after the name. Each attribute
is linked to its description in the Attribute
Section of the Tag Library.
|
||||||||
Models and Context
|
The “Models and Context” section provides information on what is allowed inside this
element and where the element may be used.
|
||||||||
Tagged Sample(s)
|
Provides excerpts of tagged XML documents, 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.
|
||||||||
Related Resources
|
Provides pointers both to external information sources and to other parts of the Tag
Library that contain information relevant to this structure.
|