◇◆
Introduction to Attributes
This section describes each attribute used in the Tag Sets in alphabetical order
of their tag names (i.e., attribute type names). The tag name is the shorter machine-readable
name used in tagged documents, XML vocabularies, and by software; for example, the
tag name
“@dsep” is used for the
attribute named “Decimal Separator”.
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):
Description (untitled)
|
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.
|
---|---|
Usage/Remarks
|
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
journal article 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 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 the NISO STS
Tag Suite, NISO JATS, or BITS; the Attribute Value Table also explains the meaning of each value.
Attributes defined in PUBLIC tag sets that have been incorporated into one of the
NISO STS Tag Sets or base Suite (such as the MathML Tag Set) do not have their values
explained, since those values are not controlled by NISO STS 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 with 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.
|
Example
|
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.
|