◇◆

Structure of the Tag Library

The Tag Library is organized into a number of chapters, each divided into sections (which may also be divided into further sections). Navigation around the Tag Library is through the Navigation Panel (Navbar) and through numerous direct links between related components.
The table below outlines the structure and chapters (with their subsections) of this document:
Getting Started
Basic information for first time users and reference for experienced users, this chapter describes the Tag Library document, how to navigate around the web pages of the complex document, and introductory material for the BITS Tag Set. Also includes the Hierarchy Diagrams, which are useful as introductions as well as reference.
Navigation
How to move around the Tag Library pages, using the Navigation Bar (Navbar), Navbar collapse and expand arrows, page collapse/expand diamonds, and the search facility. (See Navigation.)
Structure of Tag Library
Describes the sections of the Tag Library and what can be found in each and how to use the Tag Library to get started learning the tag set.
Introduction to the BITS Book Tag Set
This section provides basic information about the BITS Tag Set. What is the scope of the tagset? What was it designed to do? What are the top-level elements (<book> and <book-part-wrapper>) and how are they structured? (See Introduction to BITS Tag Set.)
Root Elements
Names the elements <book> and <book-part-wrapper> as the potential roots of this XML schema (DTD, XSD, and RNG). (See Root Elements.)
Hierarchy Diagrams
Tree-like graphical representations of the content of many elements. This can be a fast, visual way to determine the structure of a book, book part, or of any complex element within a book. (See Hierarchy Diagrams.)
Elements
Descriptions of the elements used in the BITS Tag Set. The elements are listed in order by tag name. (For information on how each Element page is organized, see Introduction to Elements.)
Attributes
Descriptions of the attributes in the BITS Tag Set. Attributes are listed in order by the name used in tagging documents and in the schemas. (For information on how each Attribute page is organized, see Introduction to Attributes.)
Finding Information in Tag Library
Contains two aids for locating a BITS element, an attribute or attribute value, an element’s context, and related information:
  • Index: Like a back-of-the-book Index: a list of BITS elements, attributes, parameter entities, and discussion topics linked to their Tag Library locations. The Index includes alternative words linked to the equivalent BITS term. (Non-BITS term to BITS term translation: for example, the term “author” will direct you to use the BITS element Contributor.) (Click on “Index” under “Finding Information in Tag Library” in the Navbar.)
  • Element Context Table: A table of where an element may be used. Provides, for each element, all the elements that can directly contain it. This is how to find out whether an element can be used in a particular context. (Click on “Element Context Table” under “Finding Information in Tag Library” in the Navbar.)
    Context information is also available on each Element page under the subheading “May be contained in” (within “Models and Context”).
Tagging Documents
How to use this Tag Set: descriptions and guidance for specific tagging issues. (See Tagging Documents.)
Common Tagging Practice
Essays discussing complex structures and the design choices involved in tagging, for example, affiliations or keywords, each of which involve numerous elements and attributes. These essays are important for learning to use this Tag Set well, and links to them are provided from elements and attributes to which they are especially relevant. (See Common Tagging Practice.)
Accessibility
An essay discussing Best Practice for providing access for the visually and motor impaired and how specific BITS elements and attributes can be used to meet Accessibility requirements. (See Accessibility.)
Technical Details
Provides material for implementors and people modifying or installing the Tag Set (See Technical Details.)
Parameter Entities
Names (with occasional descriptions) and contents of the parameter entities in the BITS or JATS DTD modules. (Click on “Parameter Entities” in the Navbar.)
Change History: BITS 2.0 to BITS 2.1
Describes changes made to the Tag Set from its release as BITS Version 2.0 until the current BITS Version 2.1, including the addition of new elements and/or attributes, changes in content models, changes in attribute values, etc. (See Change History: BITS 2.0 to BITS 2.1.)
Modifying this Tag Set
Description of BITS’ modular design and guidance on making new tag sets based on this Tag Set or to modifying the Suite Tag Sets. (See Modifying this Tag Set.)
About a BITS Namespace
Discussion of BITS and JATS lack of specific namespaces for their elements and attributes. For implementors needing to assign a namespace, a URI for such a namespace is provided. (See About a BITS and JATS Namespace.)
Supporting Documentation Home
The BITS Tag Set is available in three forms: an XML Document Type Definition (DTD), a W3C XML Schema (XSD), and a RELAX NG Schema (RNG). Each of these formats is available in two forms: a zipped file containing a downloadable version of the schema (often in multiple files), and a readable/browsable version in which the internal markup has been escaped.
Using the Tag Library to Learn This Tag Set
If you want to learn about the elements and the attributes in this Tag Set so you can tag documents or learn how the BITS book models are constructed, here is a good way to start.
  • Read the sections called Navigation and Structure of the Tag Library, taking particular note of what resources are available.
  • Next, if you do not know the symbols used in the Hierarchy Diagrams, read the “Key to the Near & Far® Diagrams”.
  • Scan the Hierarchy Diagrams to get a good sense of the top-level elements and their contents. (Find what is inside an <book>, now what is inside each of the large components of such as a <book-body> or the metadata <book-meta>. Keep working your way down through the hierarchy, into smaller and smaller structures.)
  • Pick an element from one of the diagrams. (Look up the element in the Elements Section to find the full element, the definition, usage notes, content allowed inside the element, where the element may be used, and a list of any attributes. Look up one of the attributes to find its full name, usage notes, potential values, and whether it has a default.)
Finally, if you are interested in conversion from a particular source:
  • Look at a book or book chapter in print or PDF (and look at the DTD/schema for the other book if there is one).
    • Can all the information you want to store from an book fit into the models shown in the diagrams?
    • Do you have, or know how to get, all the information the models require? Will that information always be available for documents that are complete and correct?
    • How difficult will it be to identify the parts of the information using the elements and attributes described in these models? Would changes to one or more models make this easier?
Terms and Definitions
Element
Elements are nouns, like “speech”, “list”, and “edition”, that represent components of books and book-parts, both the narrative matter of the book and the accompanying metadata.
Attribute
Attributes hold facts about an element, such as which type of list (e.g., numbered, bulleted, or plain) is being requested when using the List (<list>) tag, or the name of a pointer to an external file that contains an image. Each attribute has both a name (e.g., @list-type) and a value (e.g., “bullet”).
Metadata
Data about the data, for example, bibliographic information. The distinction is between metadata elements which describe a work (such as the name of the publisher or the book title) versus elements which contain the textual and graphical content of the work.
Tag Library Typographic Conventions
<alt-text> The tag name of an element (written in lower case with the entire name surrounded by “< >”)
Alternate Text Name (for a figure, etc.) The element name (long descriptive name of an element) or the descriptive name of an attribute (written in title case, with important words capitalized, and the words separated by spaces)
@name The “@” sign before a name indicates an attribute name.
must not Emphasis to stress a point