Introduction to Attributes
This section describes each attribute used in the BITS Tag Set and the XHTML-inspired table model. A separate Tag Library describing the OASIS Exchange CALS Table model and its attributes is available at: https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/index.html
The attributes in this Tag Library are described in alphabetical order by their attribute names (i.e., attribute type names). The attribute name is the machine-readable name used in tagged documents, XML vocabularies, and by software; for example, the attribute name “@corresp” is used for the attribute named “Corresponding Author”.
Content of an Attribute Page
Each attribute is described by a single page, which displays:
- The attribute’s name followed by a longer descriptive name (all on one line), and
- Sections describing aspects of the attribute, its usage, and the elements to which it can be attached. Not all attributes will show all sections.
The sections within the page always appear in the following order (if present):
Contains a narrative description of the attribute. This is not a formal dictionary definition, but more an explanation of what the attribute means, what type of information it provides, or how it can be used.
Discusses expected uses for the attribute, such as when or why it might be used or how to determine its value. Also provides additional information about the attribute, such as similar or contrasting attributes, processing information, or material about the base element.
Best Practice notes are identified with a heading such as “Best Practice” or “Common Practice” and have a colored background for emphasis.
Conversion Notes are usage instructions aimed at persons converting from another book tag set to this one, for example, information concerning the problems associated with embedding TeX or LaTeX in XML and the need, therefore, to surround TeX or LaTeX with a CDATA section.
Implementor’s Notes are instructions written to persons creating or maintaining tag sets based on the BITS Tag Suite.
OPTIONAL on/REQUIRED on
These two sections list the elements that take this attribute as optional and those that require this attribute. These sections perform three functions:
If the attribute can be used in more than one way, or with several slightly different meanings on different elements, there will be more than one “OPTIONAL on” or “REQUIRED on” section.
Value and Meaning — Inside each “OPTIONAL on” or “REQUIRED on” section is an Attribute Value Table that lists the possible values of the attribute in that element context and explains selected values. When the attribute originates in BITS or JATS, the Values table also explains the meaning of each value. Attributes defined in other tag sets (such as the MathML Tag Set) do not have their values explained, since those values are not established in BITS or JATS and may change without notice.
This table typically contains two columns. Each row in the table describes one value, where:
Restriction — The last row of the table contains either the word “Restriction” or the words “Default value”. “Restriction” indicates whether the attribute must be supplied when the relevant element is used, or is optional and may be given on the element. “Default value” indicates the value of the attribute that will be used (by systems that read the schema) when the document does not supply a value.
Suggested usage — For those attributes whose value is defined as text (letters, numbers, or special characters), this Tag Set does not enforce any particular value(s), but a list of suggested values may be provided.
Provides an excerpt of a tagged XML document, showing use of the current attribute. An attribute is shown in the context of one of its elements, with the current attribute highlighted in bold.
Provides pointers both to external information sources and to other parts of the Tag Library that contain information relevant to using this attribute.