How To Use (Read Me First)
This Tag Library provides interactive documentation for the NISO STS Tag Sets that you can access through a Web browser. For example, these pages provide:
- alphabetical lists of element and attribute names;
- special sections such as an Element Context Table, which lists what elements each element may occur within; and
- an “Index” section that works like the index at the back of many books. You can use it to find where a given item or topic is discussed. The index lists elements, attributes, and discussion topics under many related names and descriptions, so if you don’t know the exact tag name to use for something, try looking in the index under various related words, and you will most likely find a reference to the applicable tag or attribute.
You can use the Tag Library as a reference to look up XML tags and how to use them, to browse around and familiarize yourself with these Tag Sets, to see examples of correct or recommended usage, and even to find guidance for how to implement software to handle documents that are marked up using the NISO STS Tag Sets.
At the top level of the Tag Library (shown in the colored navigation bar to your left) there are several main sections:
- How To Use (Read Me First)
- Root Elements
- General Introduction
- Selecting a Model & Schema
- Tagging Documents
- Notes for Implementors
- Document Hierarchy Diagrams
- Theme Index
- Element Context Table
Moving Around in the Tag Library
As with most Web documents, you can click on links to travel from one topic to another and use your browser’s “Back” button to backtrack through previously-visited pages. In addition, there are three navigation aids on every page:
- At the
top is a horizontal Tab Bar with links to the primary topics in the Tag Library (e.g.,
“Elements”, “Attributes”, and “Index”). Clicking on a topic tab takes the user to the introduction for that section.
- To the left is a colored vertical
Navigation Bar with links to all parts of the Tag Library, including the Tag Library’s
introduction, the primary sections discussed earlier, and the index.
- At the very bottom of each page, in the far right corner is a “Back to Top” link.
The vertical Navigation Bar is used to move within sections as well as between sections.
- If a section has subsections, a triangle () appears next to the section’s title.
- Clicking on the triangle changes it to a triangle pointing down () and opens a list of sub-topics within that main section.
- Clicking on a sub-topic goes directly to the corresponding discussion.
Elements in the Navigation Bar
Clicking on the triangle to the left of the word “Elements” will show a list of all the XML element types such as <p> and <table> that are defined in this Tag Set.
(For those not familiar with the tag name of an element, hovering over the tag name will reveal its more English-like, descriptive equivalent; for example, hovering over the “<p>” will show “Paragraph”.)
Because there are many elements, you will likely have to scroll down to find a particular one (using the scroll-bar immediately to the right of the Navigation Bar, not the main scroll-bar for the entire browser window).
Clicking on the name of an element (in pointy brackets) will take you to a page for that element, with detailed information about its use, content, and permissible contexts.
Attributes in the Navigation Bar
Similarly, clicking on the triangle before the “Attributes” section will bring up a list of all the available attributes.
An attribute that is available on many elements will list each of those elements and explain any differences in usage. This section also provides key attribute details such as whether the attribute is required or optional, and provides lists of suggested values.
Collapsing the Vertical Navigation Bar
Some users, especially those consulting the Tag Library with small devices, want to use the full width of their displays for the body of the entry. Click the “«” at the top of the navigation bar to collapse the vertical navigation bar, and the “»” at the top left of the header to re-open it.
All Element/Attribute Names Link
In all Tag Library sections except the “Document Hierarchy Diagrams”, when the text mentions a specific element, attribute, or parameter entity, the name is linked to the page that describes that item. This makes it easy to access related information.
Tag Library Sections
Names the top-level (document) elements for the NISO STS Tag Sets.
Describes the purpose, scope, extent, and original basis for the NISO STS Tag Sets.
All the element pages, arranged alphabetically.
All the attribute pages, arranged alphabetically.
Selecting a Model & Schema
Two decisions determine which of the NISO STS Tag Sets an organization chooses to use: using the Interchange Model (using only XHTML tables) versus the Extended Model (using both XHTML and OASIS Exchange CALS tables) and the choice of MathML 2.0 versus MathML 3.0. This chapter can help an organization decide.
By design, NISO STS is enabling not enforcing. This can result in multiple ways to tag the same content. The essays in this chapter offer both descriptions of some of the choices and some Best Practice tagging advice for tagging terms and definitions, tables, figures, and more.
This section explains some of the features of NISO STS that enable organizations to make their content mode accessible to the differently-abled and meet accessibility requirements.
Notes for Implementors
This section contains information for implementors of NISO STS, who need to work with the NISO STS Tag Sets beyond merely tagging or receiving NISO-STS-tagged documents. For example, such power-users may need to: make a subset or superset of one of the tag sets, integrate NISO-STS-tagged documents with other tag sets in a database, understand the complex relationship between JATS and NISO STS, add RDF-a or another linked-data mechanism to a NISO STS document, namespace a NISO STS vocabulary, or perform other technical processing.
Document Hierarchy Diagrams
This section illustrates portions of a Tag Set’s structure that are nested or that have complex structures. These diagrams are graphical representations of the information on each Element page under the heading “Model Description”. The diagrams use some special symbols that are described below.
A list of all the elements in NISO STS, arranged thematically, by the position or the function of the element, such as a back matter elements, all emphasis (highlighting) elements, and all elements dealing with notes and examples
Element Context Table
The Context Table is an alphabetical list of all the elements in these Tag Sets. For each element, it shows all the elements that can directly contain it. This is a great way to find out whether a certain element can be used in a certain context. This information is also available on each Element page under the heading “This element may be contained in”.
Works like the index at the back of many books and can be used to find where a given item or topic is discussed. The index lists elements, attributes, section titles, and discussion topics under many related names and descriptions, so if you don’t know the exact tag name to use for something, try looking in the index under various related words, and you will most likely find a reference to the applicable tag or attribute.
Each Element Page
These pages start out with the XML name of the element they describe, followed by a more English-like, descriptive name and a description. Many elements also have remarks that give further details or help distinguish this element from similar structures.
There is also a description of which elements are allowed within the element and in what combinations.
Most element pages include examples that show how the element can be used, often including some context. These examples have been tested and validated against the model; however, portions are often left out or replaced by “...” to keep examples manageable. In addition, the most relevant parts of examples are highlighted so they are easy to find.
For more details see the Introduction to Elements section.
Each Attribute Page
Attribute pages are organized very much like element pages. However, because an attribute cannot have sub-elements, the description instead tells which elements can use the attribute, what kind of attribute it is, and what the permitted and default values are (the default value is used when the attribute is not specified at all on a particular instance of an element).
Some common kinds of attributes are:
An XML identifier (ID)
This kind of attribute must have a value that is an XML NAME, which can consist of XML name characters (alphabetical characters, digits, period, underscore, and hyphen), and cannot start with a digit. Every ID attribute value in a single document must be unique and provides a way to link or refer to its element (for example, using the <xref> element). ID attributes are generally named @id.
Reference to an identifier (IDREF)
This kind of attribute must have a value that is the same as some ID value in the same document. IDREFs appear on elements (such as <xref>) that refer to other elements. IDREF attributes are generally named @rid. Some @rid attributes are of type IDREFS, which is simply a space-separated list of IDREF values.
Text, numbers, or special characters (CDATA)
These attributes can take any string value at all. If the attribute value is surrounded by single quotes, then single quotes cannot appear inside; if the attribute value is surrounded by double quotes, then double quotes cannot appear inside. In either case, the prohibited character can instead be represented by an XML character reference such as “'”. XML elements cannot be placed within attribute values.
There are many attributes whose names end in “ -type ”. They are generally CDATA attributes as described above. They are typically assigned tokens as values, containing no spaces. Typically if there are spaces in the value, they separate multiple independent tokens, all of which apply. For example, some element might be both of type “important” and “normative”, and be given type “important normative”. In many cases, the Tag Library gives suggested values for such attributes. Unless specifically stated otherwise, those values are not the only values permitted.
Finally, there may be a “Restrictions” section that specifies if the attribute must always be specified or is optional.
For more details see the Introduction to Attributes section.
The Document Hierarchy Diagrams
These diagrams illustrate portions of the hierarchical (nested) structure of a Tag Set. Each diagram has one element “root” and may illustrate the structures of several additional elements. For each element illustrated, its name appears in a box on the left, with lines to boxes for each of its possible child-elements, which are in a column on the right.
Boxes for child elements can have names and/or symbols within. If the box has merely “...”, it means that the actual content has been omitted, to save space or improve clarity. If it has an icon of a page with lines, it stands for text content rather than an actual element.
If a box has an element name, then symbols at the left end of the box indicate whether that element is required and/or repeatable. These symbols are called “occurrence indicators”:
means that the item is optional (zero or one)
means that the item may occur any number of times (zero or more)
means that the item must occur at least once, but may occur any number of times (one or more)
a thick vertical bar on the left of the box
means that the item must occur exactly once
The symbols at the right end of a box have these meanings:
˜ (a tilde)
means that the item may take one or more attributes
a thick vertical bar on the right of the box
means that the item is expanded elsewhere (For example, if an element is permitted in multiple places within a certain parent element, there is little point in repeating its information many times.)
The lines that connect a box to boxes on its right may either be squared-off or direct (angled) lines. The former indicates that the boxes to the right must occur in the order shown; the latter indicates that any order is permitted.
For more details and examples see the Document Hierarchy Diagrams section.