NISO Z39.98-2012 — Core Modules

2.1.1.1 The document element

The document element is the root element of all Z39.98-AI Profiles.

The document element must include an xmlns attribute declaring the Z39.98-AI Core namespace and an xml:lang attribute specifying the language of the document.

Table 2. The document element

Local name	document
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Document root.
Default attribute model	Document.attrib; the xml:lang attribute required
Content model	head, body
Content model alterability	This content model is fixed, and must not be altered when activating this module.
Optionality	This element must not be omitted when activating this module.

2.1.1.2 The head element

The head element contains meta information about the complete or partial document contained in the enclosing document .

The meta information in the head element is not document content in the context of Z39.98-AI documents, but may be used for display and other purposes when rendering documents into alternate formats.

Table 3. The head element

Local name	head
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	document
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Document.attrib
Default content model	meta+
Content model alterability	The content model must allow meta elements such that the normatively requried metadata can be expressed.
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.1.1.3 The body element

The body element contains the complete or partial content of the enclosing document .

Table 4. The body element

Local name	body
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	document
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Document.attrib
Default content model	( h? & Block.class*), Section.class*
Optionality	This element must not be omitted when activating this module.

2.1.1.4 The document module - Implementations

Schema	Language
z3998-document.rng	RelaxNG

Activation of this module depends on the I18n, role, RDFa, global-classes, meta, section and Core modules also being activated.

2.1.2.1 The datatypes module - Implementations

Schema	Language
z3998-datatypes.rng	RelaxNG

The RDFa, xlink, annotation, aside, by, word, Core, cover, depth, global-classes, headings, I18n, linking, list, name, num, pagebreak, role, span, table, time, verse and word modules depends on this module being activated.

2.1.3.1 The global classes module - Implementations

Schema	Language
z3998-global-classes.rng	RelaxNG

Activation of this module depends on the Core, I18n, role, RDFa and datatypes modules also being activated.

The abbreviations, address, annotation, article, aside, bibliography, block, byline, caption, word, citation, code, cover, dialogue, dateline, definition, object, document, emph, glossary, headings, index, line, linking, list, meta, name, note, num, object, p, pagebreak, partitions, code, sent, section, span, super-subscript, table, term, time, toc, transition, verse and word modules depends on this module being activated.

2.2.1.1 The section element

The section element represents a structural division of a document.

A structural division is defined as any grouping of content that has significance to the hierarchy of the document, which can include major divisions like parts, sections, chapters, etc. or minor divisions like author biographies.

Table 8. The section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	As a parent to, or following on the sibling axis of members of Block.class
Default attribute model	Section.attrib
Default content model	( h? & ( Block.class)*), ( Section.class)*
Content model alterability	The content model must not allow more than one instance of the h heading element.
Optionality	This element must not be omitted when activating this module.

2.2.1.2 The section module - Implementations

Schema	Language
z3998-section.rng	RelaxNG

Activation of this module depends on the headings and global-classes modules also being activated.

The document module depends on this module being activated.

2.2.2.1 The article element

The article element represents an article in an electronic or print journal, magazine, news source or encyclopedia.

The simplest use for the article element is as a specialization of the section element for reproducing full articles or extracts. It is additionally possible to include head and body children for more formally structured articles.

Table 10. The article element

Local name	article
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	head, body or ( h & Block.class* & byline? & dateline?), section*
Content model alterability	The content model must not allow more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.2.2 The article head element

The article head element contains meta information about the complete or partial article contained in the enclosing article element.

The meta information in the article head element is not document content in the context of Z39.98-AI documents, but may be used for display and other purposes when rendering documents into alternate formats.

Table 11. The article head element

Local name	head
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	article
Default attribute model	Document.attrib
Default content model	meta+
Optionality	This element may be omitted when activating this module.

2.2.2.3 The article body element

The article body element contains the complete or partial content of the article .

Table 12. The article body element

Local name	body
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	article
Default attribute model	Document.attrib
Default content model	( h & Block.class* & byline? & dateline?), section*
Optionality	This element may be omitted when activating this module.

2.2.2.4 The article section element

The article section element represents a major structural division in an article .

The article section element is a specialization of the section element. It provides a content model to fit the unique requirements of article divisions.

Table 13. The article section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	article
Default attribute model	Section.attrib
Default content model	( h? & Block.class*), section*
Content model alterability	The content model must not allow more than one h element.
Optionality	This element may be omitted when activating this module.

2.2.2.5 The article module - Implementations

Schema	Language
z3998-article.rng	RelaxNG

Activation of this module depends on the global-classes, meta, headings, byline and dateline modules also being activated.

2.2.3.1 The bibliography element

The bibliography element represents a bibliography, discography, filmography or other bibliographic section.

The entries in an bibliography may be grouped into sections by topic, work, alphabetic letter or other means.

Table 15. The bibliography element

Local name	bibliography
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.3.2 The bibliography section element

The bibliography section element represents a major structural division of a bibliography .

The bibliography section element is a specialization of the section element that provides a content model to fit the unique requirements of bibliographic divisions.

The republishing of documents often requires the insertion of content that was not a part of the original source document. For example, in the case of indexes, bibliographies and other ordered sections, this requirement may take the form of placeholder sections to mark gaps in the alphabetic list of entries. To indicate that an element presents content that is a deviation from the source, the role attribute can be used with the value custom. No behaviors are defined for how a processing agent should handle sections so identified, however.

Table 16. The bibliography section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	bibliography
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.3.3 The bibliography entry element

The bibliography entry element represents a single unique entry in a bibliography .

Table 17. The bibliography entry element

Local name	entry
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	bibliography and section
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	( Block.class)+ | (text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.2.3.4 The bibliography module - Implementations

Schema	Language
z3998-bibliography.rng	RelaxNG

Activation of this module depends on the global-classes, headings, p and block modules also being activated.

2.2.4.1 The cover element

The cover element represents the complete cover or jacket of a print publication.

Table 19. The cover element

Local name	cover
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	spine?, frontcover?, backcover?, flaps?
Content model alterability	The cover element must contain at least one of its spine , frontcover , backcover or flaps children.
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.2.4.2 The spine element

The spine element represents the section of the cover that overlays the bound inner side of a publication.

Table 20. The spine element

Local name	spine
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	cover
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element may be omitted when activating this module.

The following model restrictions apply to this element:

2.2.4.3 The frontcover element

The frontcover element represents all content and images contained on the inside and outside of the front cover.

Table 21. The frontcover element

Local name	frontcover
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	cover
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	Block.class+
Optionality	This element may be omitted when activating this module.

2.2.4.4 The backcover element

The backcover element represents all content and images contained on the inside and outside of the back cover.

Table 22. The backcover element

Local name	backcover
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	cover
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	Block.class+
Optionality	This element may be omitted when activating this module.

2.2.4.5 The flaps element

The flaps element represents all content and images contained on the front and back jacket flaps.

Table 23. The flaps element

Local name	flaps
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	cover
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	Block.class+
Optionality	This element may be omitted when activating this module.

2.2.4.6 The cover module - Implementations

Schema	Language
z3998-cover.rng	RelaxNG

Activation of this module depends on the global-classes and datatypes modules also being activated.

2.2.5.1 The glossary element (Section)

The glossary element represents a glossary, pronunciation guide or other section that exclusively defines terms or phrases.

The Section variant is an adaptation for use including terms and definitions that have been grouped as a separate section in a work, and where the glossary contains structured groups of entries by topic, letter of the alphabet, etc.

The republishing of documents often requires the insertion of content that was not a part of the original source document. For example, in the case of indexes, bibliographies and other ordered sections, this requirement may take the form of placeholder sections to mark gaps in the alphabetic list of entries. To indicate that an element presents content that is a deviation from the source, the role attribute can be used with the value custom. No behaviors are defined for how a processing agent should handle sections so identified, however.

The greatest advantage to using the dedicated glossary element over hand-rolled solutions is the automatic association it allows when an entry contains exactly one term and one definition (which covers most glossaries and definition lists). The element is also intended to provide flexibility to accommodate the various forms definition lists take in production. A numbered definition list, for example, can be created using the Content Rendition feature's prefix attribute:

<glossary>
   <entry rend:prefix="1.">
      <term>evolution</term> — <definition>the process by which ...</definition>
   </entry>
   <entry rend:prefix="2.">
      <term>gene</term> — <definition>a segment of DNA...</definition>
   </entry>
</glossary>
        

The definitions could be turned into a variable list through use of CSS styles. Removing the em dashes and attaching a class attribute to the glossary element in the preceding example with a value of varlist, for example, would allow the creation of the following style definitions to re-flow the content:

glossary.varList > entry > term {
   display: block;
   padding-bottom: .2em
   font-weight: bold;
}

glossary.varList > entry > definition {
   display: block;
   margin-left: 2em;
}


        

Although it is recommended that the glossary element be used whenever possible, there are no restrictions against creating definition lists using other combinations of elements. The list element can simplify aspects (auto numbering, specifically), but at the price of having to explicitly link the terms and definitions in each entry. The first example above could be reformulated as a list as follows:

<list type="ordered">
   <item><term ref="def1">evolution</term> — <definition xml:id="def1">the process by which ...</definition></item>
   <item><term ref="def2">gene</term> — <definition xml:id="def2">a segment of DNA...</definition></item>
</list>
        

A variable list can also be implemented in a similar fashion with the addition of CSS styles:

<list class="varList">
   <item>
      <term ref="defn1">evolution</term>
      <definition xml:id="defn1">the process by which ...</definition>
   </item>
   <item>
      <term ref="defn2">gene</term>
      <definition xml:id="defn2">a segment of DNA...</definition>
   </item>
</list>
        

The absence of the type attribute on the list element in the preceding example outputs each item without a prefix, similar to the default formatting for glossary entries.

There are times where even more simplicity is needed. The glossary and list elements can be used for single definitions, but are typically more tagging than is needed, especially when the definition occurs in the flow of the body:

<p>
   A <term ref="defn01">gene</term> is <definition xml:id="defn01">a segment of DNA...</definition>. 
</p>
        

The convenience of using term and definition in these ways comes at the price of having to explicitly link the elements together via their ref and xml:id attributes, however.

Table 25. The glossary element (Section)

Local name	glossary
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.5.2 The glossary element (Block)

The glossary element represents a glossary, pronunciation guide or other section that exclusively defines terms or phrases.

The Block variant is an adaptation for use including terms and definitions that have been grouped within the body of a work.

The greatest advantage to using the dedicated glossary element over hand-rolled solutions is the automatic association it allows when an entry contains exactly one term and one definition (which covers most glossaries and definition lists). The element is also intended to provide flexibility to accommodate the various forms definition lists take in production. A numbered definition list, for example, can be created using the Content Rendition feature's prefix attribute:

<glossary>
   <entry rend:prefix="1.">
      <term>evolution</term> — <definition>the process by which ...</definition>
   </entry>
   <entry rend:prefix="2.">
      <term>gene</term> — <definition>a segment of DNA...</definition>
   </entry>
</glossary>
        

The definitions could be turned into a variable list through use of CSS styles. Removing the em dashes and attaching a class attribute to the glossary element in the preceding example with a value of varlist, for example, would allow the creation of the following style definitions to re-flow the content:

glossary.varList > entry > term {
   display: block;
   padding-bottom: .2em
   font-weight: bold;
}

glossary.varList > entry > definition {
   display: block;
   margin-left: 2em;
}


        

Although it is recommended that the glossary element be used whenever possible, there are no restrictions against creating definition lists using other combinations of elements. The list element can simplify aspects (auto numbering, specifically), but at the price of having to explicitly link the terms and definitions in each entry. The first example above could be reformulated as a list as follows:

<list type="ordered">
   <item><term ref="def1">evolution</term> — <definition xml:id="def1">the process by which ...</definition></item>
   <item><term ref="def2">gene</term> — <definition xml:id="def2">a segment of DNA...</definition></item>
</list>
        

A variable list can also be implemented in a similar fashion with the addition of CSS styles:

<list class="varList">
   <item>
      <term ref="defn1">evolution</term>
      <definition xml:id="defn1">the process by which ...</definition>
   </item>
   <item>
      <term ref="defn2">gene</term>
      <definition xml:id="defn2">a segment of DNA...</definition>
   </item>
</list>
        

The absence of the type attribute on the list element in the preceding example outputs each item without a prefix, similar to the default formatting for glossary entries.

There are times where even more simplicity is needed. The glossary and list elements can be used for single definitions, but are typically more tagging than is needed, especially when the definition occurs in the flow of the body:

<p>
   A <term ref="defn01">gene</term> is <definition xml:id="defn01">a segment of DNA...</definition>. 
</p>
        

The convenience of using term and definition in these ways comes at the price of having to explicitly link the elements together via their ref and xml:id attributes, however.

Table 26. The glossary element (Block)

Local name	glossary
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Usage context alterability	The content model must allow entry elements and no more than one h element.
Default attribute model	Block.attrib
Default content model	entry*
Optionality	This element must not be omitted when activating this module.

2.2.5.3 The glossary section element

The glossary section element represents a major structural division in a glossary .

The glossary section element is a specialization of the section element. It provides a content model to fit the unique requirements of glossary divisions.

Table 27. The glossary section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	glossary
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements.
Optionality	This element must not be omitted when activating this module.

2.2.5.4 The glossary entry element

The glossary entry element represents a single unique entry in a glossary .

A glossary entry must contain one or more term elements and either one or more definition elements or one or more ref elements pointing to a definition.

To facilitate the markup of glossaries, if an entry contains exactly one term and one definition an implicit association is assumed between them (i.e., the normal requirement to explicitly link the term to the definition by the ref attribute does not apply). If the entry contains mutliple term or definition elements, then the explicit association of each is required.

Table 28. The glossary entry element

Local name	entry
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	glossary , glossary and section
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.2.5.5 The glossary module - Implementations

Schema	Language
z3998-glossary.rng	RelaxNG

Activation of this module depends on the global-classes, headings, p and block modules also being activated.

2.2.6.1 The index element

The index element represents a topical reference section in a book.

The entries in an index may be grouped into sections by topic or alphabetic letter.

Table 30. The index element

Local name	index
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.6.2 The index section element

The index section element represents a major structural division of an index .

The index section element is a specialization of the section element that provides a content model to fit the unique requirements of index divisions.

The republishing of documents often requires the insertion of content that was not a part of the original source document. For example, in the case of indexes, bibliographies and other ordered sections, this requirement may take the form of placeholder sections to mark gaps in the alphabetic list of entries. To indicate that an element presents content that is a deviation from the source, the role attribute can be used with the value custom. No behaviors are defined for how a processing agent should handle sections so identified, however.

Table 31. The index section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	index
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.6.3 The index entry element

The index entry element represents a single entry in an index , including all related child entries.

The ref element can be used to link page number references back to the corresponding location in the document.

Table 32. The index entry element

Local name	entry
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	index and section
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	(( Block.class)+ | (text | Text.class | Phrase.core.class | Phrase.extern.class)+), entry*
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.2.6.4 The index module - Implementations

Schema	Language
z3998-index.rng	RelaxNG

Activation of this module depends on the global-classes, headings, p and block modules also being activated.

2.2.7.1 The frontmatter element

The frontmatter element groups the initial/preliminary sections of a document.

Frontmatter typically consists of such sections as forewords, prefaces, acknowledgements, introductions, dedications, prologues, and tables of contents.

Table 35. The frontmatter element

Local name	frontmatter
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	body
Default attribute model	Section.attrib
Default content model	section+
Optionality	This element must not be omitted when activating this module.

2.2.7.2 The bodymatter element

The bodymatter element groups the primary narrative of a document, as contrasted with preliminary material in frontmatter and supplementary information in backmatter.

Table 36. The bodymatter element

Local name	bodymatter
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	body
Default attribute model	Section.attrib
Default content model	section+
Optionality	This element must not be omitted when activating this module.

2.2.7.3 The backmatter element

The backmatter element groups supplementary sections at the end of a document.

Table 37. The backmatter element

Local name	backmatter
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	body
Default attribute model	Section.attrib
Default content model	section+
Optionality	This element must not be omitted when activating this module.

2.2.7.4 The document partitions module - Implementations

Schema	Language
z3998-partitions.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

2.2.8.1 The toc element (Section)

The toc element represents a single table of contents in a document.

The Section variant is an adaption for use when a table of contents represents a unique section of a work, such as the primary table of contents in the front matter of a book.

The term "table of contents" is a generalization encompassing all of tables of contents, tables of figures, tables of maps and similar guides to the contents of a document.

Table 39. The toc element (Section)

Local name	toc
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Section.attrib
Default content model	( h? & ( aside | block | hd | object | p | pagebreak | transition)*), (( entry* | section)+ & ( aside | block | hd | object | p | pagebreak | transition)*)
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.8.2 The toc element (Block)

The toc element represents a single table of contents in a document.

The Block variant is an adaption for use when a table of contents is embedded within another sections, such as a mini table of contents to start a section.

The term "table of contents" is a generalization encompassing all of tables of contents, tables of figures, tables of maps and similar guides to the contents of a document.

Table 40. The toc element (Block)

Local name	toc
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(( aside | block | hd | object | p | pagebreak | transition)* & ( entry | section)+)
Content model alterability	The content model must allow entry elements.
Optionality	This element must not be omitted when activating this module.

2.2.8.3 The toc entry element

The toc entry element represents a single entry in a table of contents , including all related child entries.

A toc entry typically consists of the text on the leader line followed by an optional ref element indicating the corresponding print page. The ref element can also be used to link the text of the entry directly to the location in the document when the table of contents or document does not include page numbers.

The toc block element is used to group all secondary information that falls below the leader line. It is not intended to group subentries, which should be included as children of the primary entry following the block..

Table 41. The toc entry element

Local name	entry
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	toc , section
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	(text | Text.class | Phrase.core.class | Phrase.extern.class)+, block?, entry*
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.2.8.4 The toc block element

The toc block element is used to group any ancillary information that falls under an entry's leader line (not including subentries), such as descriptions or topic lists.

Table 42. The toc block element

Local name	block
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	entry
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	( p | list | block | aside)+
Optionality	This element must not be omitted when activating this module.

2.2.8.5 The toc section element

The toc section element represents a subdivision of a table of contents .

The toc section element is a specialization of the section element that provides a content model to fit the unique requirements of table of contents divisions.

Table 43. The toc section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	toc
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	h?, entry*, section*
Content model alterability	The content model must allow entry elements and no more than one h element.
Optionality	This element must not be omitted when activating this module.

2.2.8.6 The toc aside element

The toc aside element represents a separate block of information in a toc table of contents from the main sections and entries.

The toc aside element typically represents information in the margins of a print table of contents.

Table 44. The toc aside element

Local name	aside
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	toc
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	(( Block.class)+ | (text | Text.class | Phrase.class)+) & toc?
Optionality	This element may be omitted when activating this module.

2.2.8.7 The table of contents module - Implementations

Schema	Language
z3998-toc.rng	RelaxNG

Activation of this module depends on the global-classes, headings, p, block, linking and aside modules also being activated.

2.2.9.1 The verse element

The verse element represents a non-prose passage such as a poem, song, hymn etc., with or without metrical structure.

The verse element consists of one or more lines and may lines may be broken up into division such as stanzas and cantos using the lngroup and section elements.

Table 46. The verse element

Local name	verse
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	( ln | lngroup | transition | hd)+
Optionality	This element may be omitted when activating this module.

2.2.9.2 The verse section element

The section element represents a major structural division of a verse , such as a canto.

Table 47. The verse section element

Local name	section
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	verse
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Section.attrib
Default content model	( h? & ( ln | lngroup | transition | hd)*), section*
Optionality	This element may be omitted when activating this module.

2.2.9.3 The verse module - Implementations

Schema	Language
z3998-verse.rng	RelaxNG

Activation of this module depends on the headings, line, transition, Core, I18n, RDFa, global-classes and datatypes modules also being activated.

2.3.1.1 The block element

The block element establishes an association between a group of elements.

The block element differs and is subordinate to the section element in that it is not used to represent the structural outline of a document. A block only establishes a general association, and is a semantically neutral element by default.

Attributes attached to the block reflect a general commonality amongst the children: a role attribute can be attached to express the semantic nature of the grouping; a class attribute to establish common formatting; an xml:lang attribute to indicate the language of the elements; and so forth.

If the children of the block have a strong association to a single element, the associate attribute can be used to make this relationship explicit (e.g., in a figure, that all children are connected to the image).

Associated content

Although images, tables and other objects may stand on their own in a document, typically they will include an accessible description, a caption and possibly a header.

In order to establish that other elements are carrying information about the table or image, you must tie them together using ref attributes that point to the xml:id of the central element, as in the following example:

<hd ref="galapisle">Galapagos Islands</hd>

<object xml:id="galapisle" src="island.png" />

<caption ref="galapisle">The Galapagos islands lie approximately 970km off the shore of Ecuador.</caption>
        

If you were to omit the ref attributes, the information would only be loosely associated by its order in the document (i.e., a processing agent would not be able to handle the elements as a group).

Although all of the above elements are associated through references to the object element, their semantics are still only loosely defined (i.e., the linkage is established, but not what that linkage represents). A human can intuit they represent a figure by the collected items and their use, but not so a machine.

It can also be confusing to edit a document marked up with all content within a section as siblings, because document narrative could fall both immediately before and after the figure elements making it all appear connected. Without checking for ref attributes as you edit, it wouldn't be clear if a new non-structural heading were occuring or a figure were being inserted.

To begin to bind the elements more tightly and create a figure both humans and machines can understand, the block element can be wrapped as a container. A role attribute can then be attached to further specify that all of the children constitute a figure, as in the following example:

<block role="figure">
    
    <hd ref="galapisland">Galapagos Islands</hd>
    
    <object xml:id="galapisland" src="island.png" />
    
    <caption ref="galapisland">The Galapagos islands lie approximately 970km off the shore of Ecuador.</caption>
    
</block>
        

A common question at this point is why the ref elements are still necessary. The answer is because the block element is only a general container. The role attribute provides additional semantics, but those semantics only extend to what kind of content the block represents, not how it is interrelated (but more on this shortly).

Now that the content is grouped, however, we can begin to further simplify it. To avoid the extra work of linking the child elements, an associate attribute can be attached to the block (the attribute represents an automatic ref between all the children). The IDREF that you specify in the attribute implicitly makes the references that we have so far been carrying forward, so our markup can now be more minimally represented as in the following example:

<block role="figure" associate="galap-figure">
    
    <hd>Galapagos Islands</hd>
    
    <object xml:id="galap-figure" src="island.png" />
    
    <caption>The Galapagos islands lie approximately 970km off the shore of Ecuador.</caption>
    
</block>
        

Now, when a processing agent comes across this markup it will be able to determine both that the block constitutes a figure (from the role attribute) and that the child hd and caption elements are tied to the object (from the associate attribute). We've gained much more information about the figure than we started with, and the work required to reproduce the figure has been greatly simplified (there is also no worry about accidentally forgetting a ref on any of the children).

Now that we have a compact markup model for figures, we can briefly jump back to why we cannot assume associations. Consider the following example:

<block role="figure">
    
    <object xml:id="galap-isa" src="isabella.png" />
    
    <object xml:id="galap-fer" src="fernandina.png" />
    
    <object xml:id="galap-sc" src="santa-cruz.png" />
    
    <caption>The Galapagos islands lie approximately 970km off the shore of Ecuador.</caption>
    
</block>
        

We cannot make a simple association here that all the children of the figure are tied to an object, as the figure constitutes three images sharing a caption. We likewise cannot use the associate attribute, but have to revert back to explicitly linking the caption to each of the three images it describes:

<block role="figure">
    
    <object xml:id="isa" src="isabella.png" />
    
    <object xml:id="fer" src="fernandina.png" />
    
    <object xml:id="sc" src="santa-cruz.png" />
    
    <caption ref="isa fer sc">The Galapagos islands lie approximately 970km off the shore of Ecuador.</caption>
    
</block>
        

It's this potential for varation that requires at least some level of linking in all cases, and makes it impossible to state a simple rule that would hold true for all content grouped in a block.

Fortunately, most image and table figures are not this complicated, and the simpler process of grouping in a block with the associate attribute will work the majority of the time.

Table 50. The block element

Local name	block
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.1.2 The associate attribute

The associate attribute identifies the child element of a block to which all other children are bound.

The associate attribute takes a single IDREF that must point to one of its children as a value. All the other children assume an implict reference to the element through this value, allowing the ref attribute to be omitted from them.

Table 51. The associate attribute

Local name	associate
Namespace	None
Default usage context	block, span
Default value(s)	IDREF
Optionality	This attribute must not be omitted when activating this module.

The following model restrictions apply to this attribute:

2.3.1.3 The block module - Implementations

Schema	Language
z3998-block.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

The bibliography, glossary, index and toc modules depends on this module being activated.

2.3.2.1 The address element (Block)

The address element represents both physical locations (postal, geographic, etc.) and virtual locations (http, email, ftp, etc.).

The Block variant is an adaptation for use marking multi-line addresses (e.g., postal addresses).

The role attribute optionally expresses the type of address. If omitted, the implicit value postal is assumed.

Table 53. The address element (Block)

Local name	address
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	( lngroup | ln)+
Optionality	This element must not be omitted when activating this module.

2.3.2.2 The address element (Phrase)

The address element represents both physical locations (postal, geographic, etc.) and virtual locations (http, email, ftp, etc.).

The Phrase variant is an adaptation for use for addresses that are embedded within the text flow (typically web and email addresses).

The role attribute optionally expresses the type of address. If omitted, the implicit value postal is assumed.

Table 54. The address element (Phrase)

Local name	address
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib
Default content model	(text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.2.3 The address module - Implementations

Schema	Language
z3998-address.rng	RelaxNG

Activation of this module depends on the global-classes and line modules also being activated.

2.3.3.1 The annotation element (Block)

The annotation element represents an annotation that an author, editor, publisher, or other individual or agency has added to a document.

Unless an annotation element has a role value of temporary, it must reference at least one element in the document using the ref attribute or be referenced by at least one annoref . For annotations that apply to more than one element, use a space-separated list of xml:id values in the ref attribute.

The ref attribute identifies the specific element(s) being annotated by referencing their xml:id values.

The annotation element should not be used to add descriptions, footnotes or endnotes. Refer to the description and note elements for more information.

The optional by and role attributes define the contributor of the annotation and expresses its nature:

<object xml:id="mnt" src="mnt.png" />
    <annotation ref="mnt" by="republisher" role="alteration">
        <p>This picture was originally on page 15 in the source but has been moved after the paragraph it split.</p>
    </annotation>
        

The lack of a role value indicates the annotation is general in nature; no implicit value should be assumed. The by attribute has an implicit value of author unless an ancestor element establishes a new relationship.

Notice also in the preceding example that there isn't an explicit reference to the annotation (i.e., no annoref element). As a result, the annotation establishes its relationship to the text via the ref attribute. Only temporary notes may be included with no reference to them or from them:

<annotation role="temporary">
       2010-12-24 - Markup verified to this point. Continuing after holidays. --MG
</annotation>
        

The by attribute may be omitted from temporary annotations as they must be removed from a document prior to its finalization. Where they are being used to relay production information, however, creating and assigning unique by values for staff/production roles may improve their usability. For example, a quality assurance editor could use the element to leave notes for the markup team:

<annotation role="temporary" by="qa" class="error">
        Missed merged paragraphs.
</annotation>
        

This specification does not attempt to define all the role values needed for all production contexts. New contributor and annotation types can be added as required, however.

Attaching more than one annotation to an element is permitted, but each annotation must have a unique role.

Table 57. The annotation element (Block)

Local name	annotation
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib, ref
Attribute model alterability	The attribute model must allow the ref attribute.
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.3.2 The annotation element (Phrase)

The annotation element represents an annotation that an author, editor, publisher, or other individual or agency has added to a document.

The inline inclusion of annotation elements does not influence the rendering of the annotations or reflect their appearance in a print medium; inlining allows annotations to be included as close to their referenced element as is desired. It is equally valid for Block-layer annotations to reference inline elements.

Unless an annotation element has a role value of temporary, it must reference at least one element in the document using the ref attribute or be referenced by at least one annoref . For annotations that apply to more than one element, use a space-separated list of xml:id values in the ref attribute.

The ref attribute identifies the specific element(s) being annotated by referencing their xml:id values.

The annotation element should not be used to add descriptions, footnotes or endnotes. Refer to the description and note elements for more information.

Table 58. The annotation element (Phrase)

Local name	annotation
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib, ref
Attribute model alterability	The attribute model must allow the ref attribute.
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element may be omitted when activating this module.

2.3.3.3 The annoref element

The annoref element represents a textual reference to an annotation .

By default, the text content of the annoref represents the link reference and is treated as document content. When superscripted numbers or symbols are instead used to identify the corresponding annotation, the value attribute should be used. The annoref must be an empty element when attaching a value attribute; it it not permitted to include text content and a value attribute.

The ref attribute is used to establish the link between the annoref and its associated annotation.

This element is a specialization of the ref element.

There are two means of tagging references to annotations. When a superscripted identifier is used, the value attribute is required:

<p>…it created a great chasm between my step-mother and me.<annoref ref="anno-04" value="4" /></p>
        

In the above example, the annotation identifier (the number 4) is no longer part of the document content, but can still be output and repurposed by a processing agent.

It is sometimes the case, however, that using one or more words in the content to link to the annotation is preferred to a superscripted identifier. In this case, the value attribute is omitted and the text content of the annoref becomes the linkable text:

<p>…it created a great chasm between <annoref ref="anno-04">my step-mother and me</annoref>.</p>
        

An additional benefit to tagging words instead of inserting superscripted referents is that a transformation process could automatically remove the link from the words and instead insert superscripted numbers or symbols after the element when they are needed. It would not be possible to do the reverse if only the superscripts have been tagged, however.

It is illegal to use an empty element and omit a value attribute, as in the following example, as some text content is necessary to render the link:

<p>…it created a great chasm between my step-mother and me.<annoref ref="anno-04" /></p>
        

It is also illegal to use text content together with a value attribute, as it introduces ambiguity in how to format the output:

<p>…it created a great chasm between <annoref ref="anno-04" value="4">my step-mother and me</annoref>.</p>
        

Table 59. The annoref element

Local name	annoref
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib, ref, value?
Attribute model alterability	The attribute model must allow the ref attribute.
Default content model	(empty | (text | Text.class | Phrase.core.class | Phrase.extern.class)+)
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.3.4 The annoref value attribute

The annoref value attribute provides the number or symbol that represents the current annotation reference.

The value attribute allows any text string as an identifier.

Table 60. The annoref value attribute

Local name	value
Namespace	None
Default usage context	annoref
Default value(s)	text
Optionality	This attribute must not be omitted when activating this module.

2.3.3.5 The annotation module - Implementations

Schema	Language
z3998-annotation.rng	RelaxNG

Activation of this module depends on the global-classes, datatypes, Core, I18n, RDFa and linking modules also being activated.

2.3.4.1 The aside element (Section)

The aside element represents information supplementary to the main text and/or narrative flow.

The Section variant is an adaptation for use with asides that contain structured content.

An aside typically floats separate from the main text, often in a boxed or shaded region.

The role attribute optionally expresses the semantic nature of the aside.

Table 62. The aside element (Section)

Local name	aside
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	section
Default attribute model	Section.attrib, ref
Default content model	h?, (z3998.Section.model)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.4.2 The aside element (Block)

The aside element represents information supplementary to the main text and/or narrative flow.

The Block variant is an adaptation for use with asides that contain unstructured content.

An aside typically floats separate from the main text, often in a boxed or shaded region.

The role attribute optionally expresses the semantic nature of the aside.

Table 63. The aside element (Block)

Local name	aside
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib, ref
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

2.3.4.3 The aside module - Implementations

Schema	Language
z3998-aside.rng	RelaxNG

Activation of this module depends on the global-classes, datatypes, Core, I18n and RDFa modules also being activated.

The toc module depends on this module being activated.

2.3.5.1 The byline element

The byline element represents the byline used to establish the author(s) of a news or journal article, an entry in an encyclopaedic reference, or similar.

Bylines typically occur on a separate line immediately after the headline in print articles.

Table 65. The byline element

Local name	byline
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.5.2 The byline module - Implementations

Schema	Language
z3998-byline.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

The article module depends on this module being activated.

2.3.6.1 The caption element

The caption element represents a short explanation or description accompanying a component of a publication. Captions most often occur in conjunction with illustrations, photographs, tables and diagrams.

The ref attribute identifies the component(s) to which the caption applies.

Table 67. The caption element

Local name	caption
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib, ref
Attribute model alterability	The attribute model must allow the ref attribute.
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.6.2 The caption module - Implementations

Schema	Language
z3998-caption.rng	RelaxNG

Activation of this module depends on the global-classes and linking modules also being activated.

2.3.7.1 The citation element (Block)

The citation element represents an author's acknowledgment of the original author and/or work of a directly or indirectly borrowed idea, quote or other resource. Citations typically occur in conjunction with epigraphs, quotes, illustrations, charts and diagrams.

The Block variant is an adaptation for use where the citation is offset from the quoted material.

The optional ref attribute on the citation element is used to establish an explicit association between the citation and the passage or resource it references; the placement of the citation does not, by default, imply an association with any element in the document. Some elements do provide a mechanism for implied relationships, however (see the quote element, for example). When adding citations, refer to the documentation for the element the citation is being attached to for more information.

A citation can also be linked to the work it cites by including a child ref element. A ref attribute can be attached to the nested ref element to reference a work in the current document's bibliography , for example. To reference other resources, including resources external to the current document, the xlink:href attribute must be used instead.

Table 69. The citation element (Block)

Local name	citation
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Phrase.attrib, ( ref| xlink.attrib)?
Attribute model alterability	The attribute model must allow either the ref or xlink.attrib attributes.
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

2.3.7.2 The citation element (Phrase)

The citation element represents an author's acknowledgment of the original author and/or work of a directly or indirectly borrowed idea, quote or other resource. Citations typically occur in conjunction with epigraphs, quotes, illustrations, charts and diagrams.

The Phrase variant is an adaptation for use where citations are included inline with the quoted material.

The optional ref attribute on the citation element is used to establish an explicit association between the citation and the passage or resource it references; the placement of the citation does not, by default, imply an association with any element in the document. Some elements do provide a mechanism for implied relationships, however (see the quote element, for example). When adding citations, refer to the documentation for the element the citation is being attached to for more information.

A citation can also be linked to the work it cites by including a child ref element. A ref attribute can be attached to the nested ref element to reference a work in the current document's bibliography , for example. To reference other resources, including resources external to the current document, the xlink:href attribute must be used instead.

Parentheses, brackets and other enclosing characters should be included within the citation element if they must be retained in the file. The use of CSS for appending these characters is recommended, however, for the flexibility it allows to change the characters depending on the desired output.

This element is a specialization of the ref element.

Table 70. The citation element (Phrase)

Local name	citation
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib, ( ref| xlink.attrib)?
Attribute model alterability	The attribute model must allow the ref and xlink.attrib attributes as exclusive choices.
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.7.3 The citation module - Implementations

Schema	Language
z3998-citation.rng	RelaxNG

Activation of this module depends on the global-classes and linking modules also being activated.

2.3.8.1 The code element (Block)

The code element is intended for general instances of code as found in works of fiction and similar non-technical documents, which includes computer programming code, commands and command input/output as well as representations of numeric and text coding systems, such as Morse code.

For computer programming books, manuals and specifications, specializing the code element or using a computer markup feature is recommended.

Table 72. The code element (Block)

Local name	code
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(( lngroup | ln)+ | ( p | list | block )+)
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.8.2 The lngroup element (code)

The lngroup element for code represents a grouping of ln code elements.

Lines of code may be grouped to show a section of a coded message, a computer program, methods within a program, to separate programs from sample input/output, etc.

Table 73. The lngroup element (code)

Local name	lngroup
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	code
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Block.attrib
Default content model	ln+
Content model alterability	The content model must allow ln elements.
Optionality	This element must not be omitted when activating this module.

2.3.8.3 The ln element (code)

The ln element for the code element represents a single line of code.

The lnum element can be added at the start of the ln for code examples that include line numbers.

Table 74. The ln element (code)

Local name	ln
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	code and lngroup
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Phrase.attrib
Default content model	lnum? & (text | Text.class)+
Optionality	This element must not be omitted when activating this module.

2.3.8.4 The code element (Phrase)

The code element is intended for general instances of code as found in works of fiction and similar non-technical documents, which includes computer programming code, commands and command input/output as well as representations of numeric and text coding systems, such as Morse code.

For computer programming books, manuals and specifications, specializing the code element or using a computer markup feature is recommended.

Table 75. The code element (Phrase)

Local name	code
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib
Default content model	(text | Text.class)+
Optionality	This element must not be omitted when activating this module.

2.3.8.5 The code module - Implementations

Schema	Language
z3998-code.rng	RelaxNG

Activation of this module depends on the global-classes and line modules also being activated.

2.3.9.1 The dateline element

The dateline element represents the creation date and/or time of a news article, diary entry, poem, etc.

Datelines typically occur on their own line and include a date and location. For dates and times expressed within the narrative flow of a document, refer to the time element.

Table 77. The dateline element

Local name	dateline
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.9.2 The dateline module - Implementations

Schema	Language
z3998-dateline.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

The article module depends on this module being activated.

2.3.10.1 The definition element

The definition element represents a formal description of the meaning of a word, term, phrase, or other construct.

The definition element requires an xml:id attribute with a unique identifier for linking from the associated term.

Definitions that are not part of the document content may be placed in the document head .

Table 79. The definition element

Local name	definition
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class and head
Default attribute model	Phrase.attrib
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.10.2 The definition module - Implementations

Schema	Language
z3998-definition.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

2.3.11.1 The description element (Block)

The description element represents an alternate accessible description of an image, video, table, etc.

The Block variant is an adaption for use embedding descriptions in other Block-layer elements and for grouping descriptions in Section-layer elements (for example, in the document head , where they can be referenced globally).

The description element can either contain the text content of the description or reference an external file in which it can be found via the xlink:href attribute. It is not permitted to mix both methods, however.

To ensure the description can be rendered, the description element must not include descendant elements and attributes that require a description.

Table 82. The description element (Block)

Local name	description
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(empty | ( Block.class)+ | (text | Text.class | Phrase.class)+)
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.11.2 The description element (Phrase)

The description element represents an alternate accessible description of an image, video, table, etc.

The description element can either contain the text content of the description or reference an external file in which it can be found via the xlink:href attribute. It is not permitted to mix both methods, however.

To ensure the description can be rendered, the description element must not include descendant elements and attributes that require a description.

Table 83. The description element (Phrase)

Local name	description
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib
Default content model	(text | Text.class)+
Optionality	This element must not be omitted when activating this module.

2.3.11.3 The description element (Text)

The description element represents an alternate accessible description of an image, video, table, etc.

The description element can either contain the text content of the description or reference an external file in which it can be found via the xlink:href attribute. It is not permitted to mix both methods, however.

To ensure the description can be rendered, the description element must not include descendant elements and attributes that require a description.

Table 84. The description element (Text)

Local name	description
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Text.class
Default attribute model	Text.attrib
Default content model	(text | Text.class)+
Optionality	This element must not be omitted when activating this module.

2.3.11.4 The description module - Implementations

Schema	Language
z3998-description.rng	RelaxNG

Activation of this module depends on the global-classes and linking modules also being activated.

2.3.12.1 The h element

The h element represents a structural heading.

The h element is strongly associated with the section element and its specializations. Each section typically allows zero or one h element child.

Table 86. The h element

Local name	h
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Usage context alterability	No element may allow more than one h element in its content model.
Default attribute model	Block.attrib
Default content model	( hpart | text | Text.class | Phrase.core.class | Phrase.extern.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.12.2 The hpart element

The hpart element represents a segment of a structural heading.

The hpart element is typically used to separate numeric identifiers from headings or to separate segments of headings broken onto separate lines.

Table 87. The hpart element

Local name	hpart
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	h
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Phrase.attrib
Default content model	(text | Text.class | Phrase.core.class | Phrase.extern.class)+
Optionality	This element may be omitted when activating this module.

The following model restrictions apply to this element:

2.3.12.3 The hd element

The hd element represents a free-floating heading that is not associated with the hierarchical structure of the document.

The ref attribute may be used to associate an hd element with a construct that it acts as a heading for.

Table 88. The hd element

Local name	hd
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib , ref?
Default content model	(text | Text.class | Phrase.core.class | Phrase.extern.class)+
Optionality	This element may be omitted when activating this module.

The following model restrictions apply to this element:

2.3.12.4 The headings module - Implementations

Schema	Language
z3998-headings.rng	RelaxNG

Activation of this module depends on the global-classes, datatypes and linking modules also being activated.

The article, bibliography, glossary, index, section, toc and verse modules depends on this module being activated.

2.3.13.1 The list element

The list element represents a simple list of items, either ordered or unordered.

The optional type attribute specifies the HTML-style ordered and unordered nature of the list.

By default, an unordered list is prefixed by bullets and an ordered list by numeric values. To change this behavior, refer to the Content Rendition feature's prefix attributes.

If the type attribute is omitted, then there is no default formatting.

The list element is not intended to structure semantically meaningful sets of entries as found in indexes, bibliographies and glossaries.

Table 91. The list element

Local name	list
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib, type?, start?
Attribute model alterability	The attribute model must allow the type and type attributes.
Default content model	item+
Content model alterability	The content model must allow item elements.
Optionality	This element must not be omitted when activating this module.

2.3.13.2 The list element (Phrase)

The list element represents a simple list of items, either ordered or unordered.

The Phrase variant is an adaptation for use embedding lists where the items flow together as part of the document narrative.

The optional type attribute specifies the HTML-style ordered and unordered nature of the list.

By default, an unordered list is prefixed by bullets and an ordered list by numeric values. To change this behavior, refer to the Content Rendition feature's prefix attributes.

If the type attribute is omitted, then there is no default formatting.

The list element is not intended to structure semantically meaningful sets of entries as found in indexes, bibliographies and glossaries.

Table 92. The list element (Phrase)

Local name	list
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib, type?, start?
Attribute model alterability	The attribute model must allow the type and type attributes.
Default content model	item+
Content model alterability	The content model must allow item elements.
Optionality	This element must not be omitted when activating this module.

2.3.13.3 The item element

The item element represents a single item in a list.

The number or glyph that appears before the item is typically controlled by the attributes specified on the parent list element together with the number of preceding items. The Content Rendition feature's prefix attribute allows this default behaviour to be overridden for individual items, however.

Table 93. The item element

Local name	item
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	list
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Phrase.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.13.4 The item element (Phrase)

The item element represents a single item in a list.

The number or glyph that appears before the item is typically controlled by the attributes specified on the parent list element together with the number of preceding items. The Content Rendition feature's prefix attribute allows this default behaviour to be overridden for individual items, however.

Table 94. The item element (Phrase)

Local name	item
Namespace	http://www.daisy.org/ns/z3998/authoring/
Usage context	list
Usage context alterability	This usage context is fixed, and must not be altered when activating this module.
Default attribute model	Phrase.attrib
Default content model	(text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

2.3.13.5 The type attribute

The type attribute specifies whether the items in the list are ordered or unordered.

The type attribute values imply the following semantics for the list items:

Table 95. The type attribute

Local name	type
Namespace	None
Default usage context	list
Default value(s)	'ordered'|'unordered'
Optionality	This attribute must not be omitted when activating this module.

2.3.13.6 The start attribute

The start attribute specifies the ordinal value for the first list item's prefix.

If omitted, the implicit value 1 is assumed.

This attribute is only valid when used with ordered lists (as defined by the presence and value of the type attribute).

Table 96. The start attribute

Local name	start
Namespace	None
Default usage context	list
Default value(s)	integer
Optionality	This attribute must not be omitted when activating this module.

2.3.13.7 The list module - Implementations

Schema	Language
z3998-list.rng	RelaxNG

Activation of this module depends on the global-classes and datatypes modules also being activated.

2.3.14.1 The meta element

The meta element expresses metadata information about the document, a document fragment or an external resource associated with the document.

The meta element accepts attributes from the RDFa attributes collection for capturing the metadata information.

Acceptable methods for specifying the value of a meta element include:

It is not valid to employ both methods for the same element. If no value is specified, the meta element either expresses a specialized metadata function or is a container for one or more child meta elements.

Table 98. The meta element

Local name	meta
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	head
Default attribute model	Rdfa.attrib , z3998.I18n.attrib and z3998.Core.attrib
Attribute model alterability	The attribute model must allow the RDFa attributes.
Default content model	empty | z3998.meta+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.14.2 The meta module - Implementations

Schema	Language
z3998-meta.rng	RelaxNG

Activation of this module depends on the RDFa, Core, I18n and global-classes modules also being activated.

The article and document modules depends on this module being activated.

2.3.15.1 The note element (Block)

The note element represents a single footnote or endnote.

The Block variant is an adaptation for use including notes between block elements.

Notes provide or reference sources of additional information, or acknowledge the source of a quotation or idea. In printed matter, they are usually distinguishable from annotations by their location either at the bottom of print pages, at the end of sections or in the back matter of a document.

Each note is typically referenced by a noteref or prefixed by a page location (when explicit references have been omitted from the text). If the note does not have a referent in a Z39.98-AI document, it must include a ref attribute that references back to the nearest element in the document to the content to which it applies.

The role attribute optionally expresses the semantic nature of the note. The value can be either footnote or endnote. If omitted, the implicit value footnote is assumed.

When a note is prefixed by a number or symbol, that identifier should be included using the Content Rendition feature's prefix attribute.

Table 101. The note element (Block)

Local name	note
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.15.2 The note element (Phrase)

The note element represents a single footnote or endnote.

The Phrase variant is an adaptation for use including notes inline in phrase contexts.

Notes provide or reference sources of additional information, or acknowledge the source of a quotation or idea. In printed matter, they are usually distinguishable from annotations by their location either at the bottom of print pages, at the end of sections or in the back matter of a document.

Each note is typically referenced by a noteref or prefixed by a page location (when explicit references have been omitted from the text). If the note does not have a referent in a Z39.98-AI document, it must include a ref attribute that references back to the nearest element in the document to the content to which it applies.

The role attribute optionally expresses the semantic nature of the note. The value can be either footnote or endnote. If omitted, the implicit value footnote is assumed.

When a note is prefixed by a number or symbol, that identifier should be included using the Content Rendition feature's prefix attribute.

Table 102. The note element (Phrase)

Local name	note
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib
Default content model	(text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

2.3.15.3 The noteref element

The noteref element represents a textual reference to a note .

The ref attribute is used to establish the link between the note reference and its associated note.

By default, the text content of the noteref represents the link reference and is treated as document content. When superscripted numbers or symbols are used to identify the corresponding note, the value attribute should be used. The noteref must be an empty element when attaching a value attribute; it it not permitted to include text content and a value attribute.

This element is a specialization of the ref element.

There are two means of tagging references to notes. When a superscripted identifier is used, the value attribute is required:

<p>THE following pages contain Extracts from LETTERS addressed 
    to Professor HENSLOW<noteref ref="n2" value="2" /> by C. DARWIN, Esq. … </p>
        

In the above example, the note identifier (the number 2) is no longer part of the document content, but can still be output and repurposed by a processing agent.

It is sometimes the case, however, that using one or more words in the content to link to the annotation is preferred to a superscripted identifier. In this case, the value attribute is omitted and the text content of the noteref becomes the linkable text:

<p>THE following pages contain Extracts from LETTERS addressed 
    to <noteref ref="n2">Professor HENSLOW</noteref> by C. DARWIN, Esq. … </p>
        

An additional benefit to tagging words instead of inserting superscripted referents is that a transformation process could automatically remove the link from the words and instead insert superscripted numbers or symbols after the element when they are needed. It would not be possible to do the reverse if only the superscripts have been tagged, however.

It is illegal to use an empty element and omit a value attribute, as in the following example, as some text content is necessary to render the link:

<p>THE following pages contain Extracts from LETTERS addressed 
    to Professor HENSLOW<noteref ref="n2" /> by C. DARWIN, Esq. … </p>
        

It is also illegal to use text content together with a value attribute, as it introduces ambiguity in how to format the output:

<p>THE following pages contain Extracts from LETTERS addressed 
    to <noteref ref="n2" value="2">Professor HENSLOW</noteref> by C. DARWIN, Esq. … </p>
        

Table 103. The noteref element

Local name	noteref
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib, ref, value?
Attribute model alterability	The attribute model must allow the ref attribute.
Default content model	(empty | (text | Text.class | Phrase.core.class | Phrase.extern.class)+)
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.15.4 The noteref value attribute

The noteref value attribute provides the number or symbol that represents the current note reference.

The value attribute allows any text string as an identifier.

Table 104. The noteref value attribute

Local name	value
Namespace	None
Default usage context	noteref
Default value(s)	text
Optionality	This attribute must not be omitted when activating this module.

2.3.15.5 The note module - Implementations

Schema	Language
z3998-note.rng	RelaxNG

Activation of this module depends on the global-classes and linking modules also being activated.

2.3.16.1 The object element (Block)

The object element contains a reference to an external resource, such as a graphic or video.

The Block variant is an adaptation for use embedding objects that are intended to be offset from any surrounding block elements.

The referenced resource may be an image, video, XML text, or other content, but its media type must be supported by the current profile and features in use. The optional srctype attribute carries an enumeration of the allowed media types.

The formal behavior of the object element is defined by XHTML 1.1 .

This element is a specialization of the ref element with the XLink behaviors xlink:show="embed" and xlink:actuate="onLoad".

It is not always the case that the referenced object will be available, renderable or accessible. The object element provides two mechanisms for adding fallback accessible descriptions in these cases:

Table 106. The object element (Block)

Local name	object
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	src, srctype?, Block.attrib
Attribute model alterability	The attribute model must allow the src and srctype attributes.
Default content model	(empty | ( Block.class)+ | (text | Text.class | Phrase.class)+)
Optionality	This element must not be omitted when activating this module.

2.3.16.2 The object element (Phrase)

The object element contains a reference to an external resource, such as a graphic or video.

The Phrase variant is an adaption for use embedding objects in phrasal constructs.

The referenced resource may be an image, video, XML text, or other content, but its media type must be supported by the current profile and features in use. The optional srctype attribute carries an enumeration of the allowed media types.

The formal behavior of the object element is defined by XHTML 1.1 .

This element is a specialization of the ref element with the XLink behaviors xlink:show="embed" and xlink:actuate="onLoad".

It is not always the case that the referenced object will be available, renderable or accessible. The object element provides two mechanisms for adding fallback accessible descriptions in these cases:

Table 107. The object element (Phrase)

Local name	object
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	src, srctype?, Phrase.attrib
Attribute model alterability	The attribute model must allow the src and srctype attributes.
Default content model	(empty | (text | Text.class | Phrase.class)+)
Optionality	This element may be omitted when activating this module.

2.3.16.3 The object element (Text)

The object element contains a reference to an external resource, such as a graphic or video.

The Text variant is an adaption for use representing objects at the character level.

The referenced resource may be an image, video, XML text, or other content, but its media type must be supported by the current profile and features in use. The optional srctype attribute carries an enumeration of the allowed media types.

The formal behavior of the object element is defined by XHTML 1.1 .

This element is a specialization of the ref element with the XLink behaviors xlink:show="embed" and xlink:actuate="onLoad".

It is not always the case that the referenced object will be available, renderable or accessible. The object element provides two mechanisms for adding fallback accessible descriptions in these cases:

Table 108. The object element (Text)

Local name	object
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Text.class
Default attribute model	src, srctype?, Text.attrib
Attribute model alterability	The attribute model must allow the src and srctype attributes.
Default content model	(empty | (text | Text.class)+)
Optionality	This element may be omitted when activating this module.

2.3.16.4 The object module - Implementations

Schema	Language
z3998-object.rng	RelaxNG

Activation of this module depends on the global-classes and linking modules also being activated.

The word module depends on this module being activated.

2.3.17.1 The p element

The p element represents a paragraph of text consisting of one or several sentences.

The class attribute together with a CSS stylesheet should be used to retain any formatting information specific to a paragraph, such as first line indenting.

Table 110. The p element

Local name	p
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Section.class
Default attribute model	Block.attrib
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.17.2 The paragraph module - Implementations

Schema	Language
z3998-p.rng	RelaxNG

Activation of this module depends on the global-classes module also being activated.

The bibliography, glossary, index and toc modules depends on this module being activated.

2.3.18.1 The pagebreak element

The pagebreak element represents the location of a page break in a print source.

The value attribute optionally expresses a page number associated with the page.

Table 113. The pagebreak element

Local name	pagebreak
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class , Phrase.class and Section.class
Default attribute model	Phrase.attrib, value?
Attribute model alterability	The attribute model must allow the value attribute.
Default content model	empty
Optionality	This element must not be omitted when activating this module.

2.3.18.2 The pagebreak value attribute

The pagebreak value attribute provides the numbering of the page immediately following the pagebreak element.

The value attribute allows any text string as an identifier to accommodate Arabic, roman and other sequencing conventions.

Table 114. The pagebreak value attribute

Local name	value
Namespace	None
Default usage context	pagebreak
Default value(s)	text
Optionality	This attribute must not be omitted when activating this module.

2.3.18.3 The pagebreak module - Implementations

Schema	Language
z3998-pagebreak.rng	RelaxNG

Activation of this module depends on the global-classes and datatypes modules also being activated.

2.3.19.1 The quote element (Block)

The quote element represents a quotation from a real or fictitious source.

When citing the source of a quotation, the citation must be explicitly linked to the quote by means of the ref attribute.

If a quote element contains only a single child citation element, and the citation does not contain a ref attribute or child ref element, the association between the two elements is implied.

If a quote does not contain a citation, it can still be linked to the work it is cited from by attaching a ref attribute referencing an entry in a bibliography , for example. To reference other resources, including resources external to the current document, the xlink:href attribute must be used.

The role attribute optionally expresses the semantic nature of the quote. The role value epigraph, for example, indicates the quoted passage or verse represents an epigraph for the document or section.

Table 116. The quote element (Block)

Local name	quote
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Block.class
Default attribute model	Block.attrib
Default content model	(z3998.Block.class)+ | (text | z3998.Text.class | z3998.Phrase.class)+
Optionality	This element must not be omitted when activating this module.

The following model restrictions apply to this element:

2.3.19.2 The quote element (Phrase)

The quote element represents a quotation from a real or fictitious source.

When citing the source of a quotation, the citation must be explicitly linked to the quote by means of the ref attribute.

If a quote element contains only a single child citation element, and the citation does not contain a ref attribute or child ref element, the association between the two elements is implied.

If a quote does not contain a citation, it can still be linked to the work it is cited from by attaching a ref attribute referencing an entry in a bibliography , for example. To reference other resources, including resources external to the current document, the xlink:href attribute must be used.

The role attribute optionally expresses the semantic nature of the quote. The role value epigraph, for example, indicates the quoted passage or verse represents an epigraph for the document or section.

Quotation marks should be included within the element if they must be retained in the file. The use of CSS for appending these characters is recommended, however, for the flexibility it allows to change the characters depending on the desired output.

Table 117. The quote element (Phrase)

Local name	quote
Namespace	http://www.daisy.org/ns/z3998/authoring/
Default usage context	Phrase.class
Default attribute model	Phrase.attrib
Default content model	(text | Text.class | Phrase.class)+
Optionality	This element must not be omitted when activating this module.