
xml.schema.z3998-book-1.0-latest.resources.z3998-book-single.rng Maven / Gradle / Ivy
The book schema
This driver file represents the RelaxNG implementation of the Z39.98-2012 Book Profile, and provides the schematic means of validating conformant documents.
More information about this module is available at http://www.daisy.org/z3998/2012/auth/cm/#z3998.book.module
Markus Gylling
[email protected]
This module is licensed under a Creative Commons Attribution 3.0 license, a copy of which is available at
http://creativecommons.org/licenses/by/3.0/
For complete licensing information, please refer to the LICENSE file that came with this distribution, a copy of which is also available from the DAISY web site at
www.daisy.org
2009
2010
2011
2012
DAISY Consortium
2012-12-19
MGy
Initial version.
This revision history only reflects changes to the driver file, not to any of the modules included in it.
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.
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. Refer to
Document metadata for the normative specification of required metadata in head.
The body element contains the complete or partial content of the enclosing
document .
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.
The meta content attribute must neither be empty nor contain only whitespace.
The ref element represents a reference to an internal or external entity. The referenced entity is not required to be resolvable or includable in a processing or rendering context: the ref element may point to conceptual or physical items. The ref element may employ attributes from the
xlink attributes collection to specify the nature of the hyperlink, including or excluding expressions of link activation behavior. IDREF link relationships may also be established using the
ref attribute, but not in conjunction with the xlink attributes collection.
The {ref} element must not contain descendant {ref} elements.
The ref element must neither be empty nor contain only whitespace.
The ref attribute provides a generic mechanism to establish an association between the current element and one or more other elements in the document scope. The ref attribute must contain one or more space separated references to the
IDs of the associated elements. Elements adopting the ref attribute may express constraints on the nature of the referenced elements.
The ref attribute must not reference the same ID multiple times.
Each IDREF in the ref attribute must reference the ID of another element in the document.
Elements carrying a ref attribute must not reference themselves.
The src attribute contains a URI reference to an external resource to embed in the document, in place of the current element. Only references to resources that conform to one of the types in the
srctype attribute enumeration are allowed.
The srctype attribute contains a
MediaType expression that identifies the type of resource referenced from the
src attribute. All Z39.98-AI profiles must allow the media types
image/png ,
image/jpeg and image/bmp. These three image types are jointly referred to as the "core image types". Z39.98-AI features may extend this enumeration to support additional media types. If the srctype attribute is not specified, processing agents must dereference the resource in the src attribute to identify its media type.
image/png
The referenced resource is a
PNG image .
image/jpeg
The referenced resource is a
JPEG image .
image/bmp
The referenced resource is a BMP image.
image/svg+xml
The continuation attribute provides a generic mechanism to establish a logical continuation of the current element cross one or more other elements in the document scope. The continuation attribute must contain one or more space separated references to the
IDs of the associated elements. Note that the element that carries the continuation attribute must not be referenced in this list. The order in which the references appear in the attribute value is not significant (i.e., the reference order need not match the document order of the referenced elements). Only elements with the same QName as the parent element of the attribute can be referenced (e.g., a paragraph cannot list a table as a continuation). Additionally, only elements following the current element in the document order may be referenced as continuations. Elements that are referenced as continuations must not have continuation attributes themselves. Logical connections allow for special formatting of elements when generating outputs (to establish the connection between emphasis that continues across multiple paragraphs for braille formatting, for example). When the continuation attribute has been attached to an element, all formatting instructions that apply to that element also apply to all the elements referenced in the attribute. Formatting instructions on the logical siblings, however, do not cascade. A processing agent that does not recognize logical connections must be able to process each individual element in the continuation without requiring special knowledge of the elements that came before (i.e., inheritance of formatting cannot be assumed).
The continuation attribute must not reference the same ID multiple times.
Elements referenced by a continuation attribute must be located after the referencing element (i.e., in document order).
Elements referenced by a continuation attribute must have the same QName as the referencing element.
Elements carrying a continuation attribute must not reference themselves.
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.
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.
The h element must neither be empty nor contain only whitespace.
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.
The hpart element must neither be empty nor contain only whitespace.
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.
The hd element must neither be empty nor contain only whitespace.
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
block.associate attribute can be used to make this relationship explicit (e.g., in a figure, that all children are connected to the image).
The block element must neither be empty nor contain only whitespace.
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.
The IDREF in the associate attribute must reference the ID of a child 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. When print layout has to be strictly followed in converting a document to electronic format, paragraphs may be split by other elements such as full page images. Refer to the
continuation attribute for more information on how to indicate that two p elements actually constitute a single whole.
The p element must neither be empty nor contain only whitespace.
The transition element represents context changes and other shifts in the narrative flow or content of a document. The shift represented by a transition does not infer structural meaning on the elements that precede or follow it (see the
section element). A typical example of a transition in print documents is a spaced gap between paragraphs, which may include centered asterisks or other glyphs (often referred to as a space break). The Content Rendition feature's
symbol attribute can be used to represent a character marker associated with the transition, and the
src attribute can be used to reference an image. If both attributes are omitted, the transition is treated as a whitespace gap.
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.
Specifies whether the items in the list are ordered or unordered.
unordered
The order of the items in this list is insignificant.
Specifies whether the items in the list are ordered or unordered.
ordered
The order of the items in this list is significant.
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).
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.
The item element must neither be empty nor contain only whitespace.
The table element represents a single instance of tabular data arranged in rows and columns. A table may consist of one or more tr elements or may be divided into
table.thead ,
table.tbody and
table.tfoot divisions. A table may contain one or more
table.colgroup elements, for expressing common column formatting and properties.
The colgroup element allows a set of properties to be defined for the cells in one or more table columns. The colgroup can define a common set of properties for one or more columns using the
table.span attribute, in which case it must be an empty element. To specify different properties for different columns, the colgroup must contain one or more
table.col elements with the properties for those columns. A colgroup must not contain both a span attribute and child col elements.
The span attribute specifies the number of columns the properties defined in a
table.colgroup or
table.col apply to. If a colgroup element contains child col elements, the span is determined automatically from the number of child col elements and any respective span values they define. If omitted, the implicit value 1 is assumed.
The col element allows a set of properties to be defined for the cells in one or more table columns. The optional
table.span attribute indicates the number of adjoining columns to which the properties apply.
The thead element represents the collection of
table header rows.
The tfoot element represents the collection of
table footer rows. Note that contrary to the
XHTML Modularization 1.1 tables module tfoot element , this element is placed following the tbody element.
The tbody element represents a collection of
table body rows. Multiple tbody elements are allowed to enable representation of sections of rows.
The th element represents a single table cell containing header information. The optional
table.scope attribute can be used to express the column(s) or row(s) to which the header applies.
The abbr attribute specifies an abbreviated header value.
The td element represents a single table cell. The optional
table.colspan and
table.rowspan attributes can be used to specify that a column extends across or down more than one cell, respectively. The optional
table.scope attribute can be used to express that the current cell represents a header for columns(s) or row(s) defined by the attribute's value.
The colspan attribute specifies the number of columns spanned by the current cell. The implicit value of this attribute is 1. The value 0 indicates that the cell spans all columns from the current column to the last column of the
table.colgroup in which the cell is defined.
The rowspan attribute specifies the number of rows spanned by the current cell. The implicit value of this attribute is 1. The value 0 indicates that the cell spans all rows from the current row to the last row of the current table section (rowgroup) in which the cell is defined (where the
table.thead ,
table.tbody , and
table.tfoot elements are considered rowgroups).
The scope attribute specifies the set of data cells for which the current header cell provides header information. This attribute may be used in place of the
table.headers attribute, especially for simple tables.
row
The current cell provides header information for the rest of the row that contains it.
col
The current cell provides header information for the rest of the column that contains it.
rowgroup
The header cell provides header information for the rest of the row group that contains it.
colgroup
The header cell provides header information for the rest of the column group that contains it.
The headers attribute specifies the list of header cells that provide header information for the current data cell. This attribute requires a space separated list of valid
ID references that resolves to
th elements.
The headers attribute must resolve to a th in the current table.
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.
The code element must neither be empty nor contain only whitespace.
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.
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.
The ln element must not contain descendant ln elements.
The ln element must neither be empty nor contain only whitespace.
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.
The code element must neither be empty nor contain only whitespace.
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.
specialize the block model to allow linegroups and lines
The quote element must neither be empty nor contain only whitespace.
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.
The quote element must neither be empty nor contain only whitespace.
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.
The citation element must neither be empty nor contain only whitespace.
The ref attribute on the ref element must refer to an entry in a bibliography when nested inside a citation element.
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.
The citation element must neither be empty nor contain only whitespace.
The ref attribute on the ref element must refer to an entry in a bibliography when nested inside a citation element.
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 .
The {object} element must not contain descendant elements from the MathML feature grammar.
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 .
The {object} element must not contain descendant elements from the MathML feature grammar.
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 .
The {object} element must not contain descendant elements from the MathML feature grammar.
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.
The address element must neither be empty nor contain only whitespace.
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.
The address element must neither be empty nor contain only whitespace.
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.
The note element must either be referenced by a noteref or reference another element in the document.
The note element must neither be empty nor contain only whitespace.
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.
The note element must either be referenced by a noteref or reference another element in the document.
The note element must neither be empty nor contain only whitespace.
The noteref element represents a textual reference to a
note . Note references typically appear as superscripted numbers or symbols within the narrative flow but may also appear as linked words, especially in electronic formats. 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
noteref.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.
The {value} attribute can only be used on empty {noteref} elements.
A {noteref} element cannot be empty and not include a {value} attribute.
The IDREF(s) in the ref attribute must resolve to note elements.
Superscripted referents should be included in a {value} attribute, not as text content.
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.
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 annotation element must be referenced by an annoref or reference another element in the document unless it has the role value temporary.
The annotation element must neither be empty nor contain only whitespace.
Annotations with a {role} value of {temporary} must be removed prior to document finalization.
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.
The annotation element must be referenced by an annoref or reference another element in the document unless it has the role value temporary.
The annotation element must neither be empty nor contain only whitespace.
Annotations with a {role} value of {temporary} must be removed prior to document finalization.
clarification
An annotation whose purpose is to provide a clarification.
correction
An annotation whose purpose is to provide a correction.
alteration
An annotation whose purpose is to indicate an alteration made to the source document, such as the re-arrangement or removal of content.
production
A temporary annotation not intended as part of the finished document, such as a production note
presentation
An annotation whose purpose is to describe some aspect of the document layout, such as the formatting of a page or conventions used in rendering the content.
commentary
An annotation whose purpose is to provide commentary.
attribution
An annotation whose purpose is to provide a source or attribution.
introductory-note
An annotation whose purpose is to provide an introductory note.
The annoref element represents a textual reference to an
annotation . Although not as common as with footnotes and endnotes, the content or location in the document being annotated may be noted by a text referent (e.g., a superscripted symbol). 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
annoref.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.
The {value} attribute cannot be used on a non-empty {annoref}.
An empty {annoref} element must include a {value} attribute.
The IDREF(s) in the ref attribute must resolve to annotations.
Superscripted referents should be included in a {value} attribute, not as text content.
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.
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.
The aside element must neither be empty nor contain only whitespace.
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.
The aside element must neither be empty nor contain only whitespace.
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.
The caption element must not contain child caption elements.
The caption element must neither be empty nor contain only whitespace.
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
verse.section elements.
The section element represents a major structural division of a
verse , such as a canto.
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.
The description element must either contain text data or point to an external resource using the xlink:href attribute.
The {description} element must not contain text data and also point to an external resource using the {xlink:href} attribute.
The {description} element must not contain descendant {description} elements.
The {description} element must not contain descendant {object} elements.
The {description} element must not contain descendant {table} elements.
The {description} element must not contain descendant elements from the MathML feature grammar.
Every description element must be referenced by at least one element in the document.
The {object} element may contain only one child {description}.
{description} elements cannot be nested inside the children of an {object} element.
A single {description} element must be the only child of an {object} element when used.
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.
The description element must either contain text data or point to an external resource using the xlink:href attribute.
The {description} element must not contain text data and also point to an external resource using the {xlink:href} attribute.
The {description} element must not contain descendant {description} elements.
The {description} element must not contain descendant {object} elements.
The {description} element must not contain descendant {table} elements.
The {description} element must not contain descendant elements from the MathML feature grammar.
Every description element must be referenced by at least one element in the document.
The {object} element may contain only one child {description}.
{description} elements cannot be nested inside the children of an {object} element.
A single {description} element must be the only child of an {object} element when used.
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.
The description element must either contain text data or point to an external resource using the xlink:href attribute.
The {description} element must not contain text data and also point to an external resource using the {xlink:href} attribute.
The {description} element must not contain descendant {description} elements.
The {description} element must not contain descendant {object} elements.
The {description} element must not contain descendant {table} elements.
The {description} element must not contain descendant elements from the MathML feature grammar.
Every description element must be referenced by at least one element in the document.
The {object} element may contain only one child {description}.
{description} elements cannot be nested inside the children of an {object} element.
A single {description} element must be the only child of an {object} element when used.
The desc attribute establishes the connection between the current element and its associated accessible
description (s). The desc attribute must contain one or more space separated references to the
IDs of the associated descriptions. Features may extend the use of this attribute, but not override the requirement that it resolve to a description. The
Z39.98-2012 Content Selection feature , for example, provides a mechanism for pointing to a description based on the format being rendered.
Every IDREF in the desc attribute must resolve to a description element.
The span element represents an arbitrary phrase of text. The span element is similar to the
block element in that only acts a container for its child content. It is a semantically neutral element by default, but may express some other commonality between the elements such as formatting or language. To convey a semantic connection between the child content, the optional
role attribute must be attached.
The span element must neither be empty nor contain only whitespace.
The span element represents an arbitrary phrase of text. The span element is similar to the
block element in that only acts a container for its child content. It is a semantically neutral element by default, but may express some other commonality between the elements such as formatting or language. To convey a semantic connection between the child content, the optional
role attribute must be attached.
The span element must neither be empty nor contain only whitespace.
The ln element represents a single line of text. The
lnum element can be added to the start of the ln to represent numbered lines.
The ln element must not contain descendant ln elements.
The ln element must neither be empty nor contain only whitespace.
The lnum element represents the line number of the parent
ln . Line numbers are a common convention in poetic works, legal texts and programming code.
The lnum element must neither be empty nor contain only whitespace.
The lngroup element represents a group of
lines .
The pagebreak element represents the location of a page break in a print source. The
pagebreak.value attribute optionally expresses a page number associated with the page.
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.
The s element represents a grammatical and/or lexical sentence.
The s element must not contain descendant s elements.
The s element must neither be empty nor contain only whitespace.
The w element represents a single, possibly compound, lexical word. The
role attribute optionally expresses the semantic nature of the word. No implicit value is associated with the w element.
The word element must neither be empty nor contain only whitespace.
v-form
A formal second-person pronoun.
compound
A word created by the combination of two or more stems.
t-form
An informal second-person pronoun.
homograph
An instance of a set of words with the same spelling but different etymologies and often pronunciations (e.g. bass the instrument and bass the fish).
portmanteau
A word created from the merging of two other words (e.g. brunch from breakfast and lunch).
The wpart element represents a segment of a word. The wpart element is typically used to distinguish the parts of a word (root, stem and affix), compound word, portmanteau or homograph. It can also be used in grammatical contexts to identify morphemes, graphemes and other divisions and boundaries within a word. The wpart element additionally can be used in place of soft hyphens to identify line ending break locations, if external formatting options are limited. The
role attribute optionally expresses the semantic nature of the word part. No implicit value is associated with the wpart element.
The wpart element must neither be empty nor contain only whitespace.
The abbr element represents the abbreviated form of a phrase, term or name. The
role attribute optionally expresses whether the type of abbreviation. The
expansion and
name elements provide a mechanism for associating an abbreviation with its uncontracted form. When including an expansion, the ref attribute on the abbr element links the abbreviation to an expansion or name. The ref attribute can also be used to reference a
definition element when an explanatory definition of the abbreviation is also needed.
The ref attribute on an abbr element must resolve to an expansion, name or definition element.
The abbr element must neither be empty nor contain only whitespace.
The expansion element represents the fully expanded form of an
abbreviation . The expansion element requires an xml:id attribute with a unique identifier for linking from the associated abbreviation. Expansions that are not part of the document content must be placed in the document
head .
The expansion element must not contain descendant expansion elements.
The expansion element must neither be empty nor contain only whitespace.
The emph element represents an author's emphasis. Emphasis is not restricted to italicized text, but may constitute any of a variety of typographical or styling means used to distinguish text, such as bolding, underlining, coloring, etc. Nested emph elements indicate extra emphasized segments within an emphasized segment.
The emph element must neither be empty nor contain only whitespace.
The emph element represents an author's emphasis. Emphasis is not restricted to italicized text, but may constitute any of a variety of typographical or styling means used to distinguish text, such as bolding, underlining, coloring, etc. Nested emph elements indicate extra emphasized segments within an emphasized segment.
The emph element must neither be empty nor contain only whitespace.
The time element represents a calendar or clock-based statement of time. If the value of the time element is not in a machine-readable format, the
time attribute optionally allows the inclusion of an alternate representation.
The time element must not contain descendant time elements.
The time element must neither be empty nor contain only whitespace.
The time attribute contains a calendar or clock-based statement of time expressed in machine-readable form. When this attribute appears on the
time element, it contains an alternate rendition of the element's content. The time attribute value must be valid to the
Time.datatype datatype.
The name element represents particular instances of names, places and things (proper nouns). The
role attribute optionally expresses the semantic nature of the proper noun. No implicit value is associated with the name element.
The name element must neither be empty nor contain only whitespace.
signature
The handwritten, digital or stamped representation of a person's name.
place
The name of a city, state, province, country or other geographic or political entity. .
taxonomy
The name of a species, genus or other taxonomic classification. .
given-name
The part of a personal name that distinguishes the person from a group of persons sharing the same surname. Also known as 'forename' or 'first name'. .
personal-name
A proper name identifying a person, often composed of a given name and a family name.
surname
The part of a personal name that associates the person with a group of persons sharing the same surname. Also known as 'last name'.
name-title
The part of a personal name that signifies veneration, an official position or a professional or academic qualification. .
family-name
The part of a personal name that indicates the family to which the person belongs. Often used in conjunction with a honorific.
nationality
The name of a nationality, national group, or other designator of association. .
event
The name of a religious, sporting, or other event, holiday or festival. .
award
The name of an award or prize. .
product
The brand name of a product, medication, etc. .
organization
The name of an organization, corporation, or other business entity. .
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 .
The definition element must neither be empty nor contain only whitespace.
The term element represents a word, or compound word, characterized by its particular use and context. The addition of a
ref attribute establishes a link to a definition. The value of the ref attribute must reference the xml:id of a
definition element
The term element must neither be empty nor contain only whitespace.
The ref attribute on a term element must resolve to a definition.
The d element represents an instance of dialogue in a book, play, article or other document. 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. The
ref attribute can optionally be used to link an instance of dialogue to a character listed in a dramatis personae.
The d element must not contain descendant d elements.
The d element must neither be empty nor contain only whitespace.
The sub element represents instances of subscripted text.
The sub element must neither be empty nor contain only whitespace.
The sup element represents instances of superscripted text.
The sup element must neither be empty nor contain only whitespace.
The num element represents a set of Arabic or Roman numerals that taken together indicate a single value or represent a single number in a standardized format. Examples of numbers include: cardinal and ordinal values, weights, measures, currency values, postal codes, telephone numbers, ISBN numbers, scores and results, etc. Where these values include units of measure or other symbols integral to their understanding, the units and symbols must be included as a part of the num element. The
role attribute optionally expresses the semantic nature of the number. If omitted, the implicit value cardinal is assumed. If the value of the num element is not in a machine-readable format, the
num.value attribute optionally allows the inclusion of an alternate representation. The MathML feature is intended for marking proper mathematical statements within documents and should be used in preference over the num element whenever equations, formulae or other formal mathematic constructs or operators are being marked. The num element must not be used to mark instances of dates and times. Refer to the
time element for more information.
The num element must neither be empty nor contain only whitespace.
The value attribute provides the value of the num element in a machine-readable form. A processing agent's interpretation of the value depends on the specific type of numeral, as specified by the role attribute.
mixed
A whole number followed by a fraction with a numerator and denominator.
decimal
A single value where the integral number is separated from the fractional value by a decimal point or comma.
currency
A currency value, including the denomination indicator.
measure
A single value of measure, including units.
fraction
A single fraction with a numerator and denominator, and without a preceding whole number.
ratio
An expression of the magnitude of two quantities relative to each other.
roman
A single value expressed using roman numerals.
ordinal
A value indicating rank or position.
phone
A phone number, including area code and international dialing code.
isbn
An International Standard Book Number.
coordinate
A value expressing the location of a point in n-dimensional space, including degree, minute and other indicators if specified.
postal-code
A postal or zip code.
result
A single value that includes two or more sets of numbers separated by spaces.
percentage
A value that defines proportionality to a whole, including percent sign if present.
cardinal
A value indicating quantity.
weight
A single weight value, including units.
The char element represents a single instance of a special character or a character with no Unicode equivalent. The char element can contain either a single character or a
object tag, for characters and symbols that require special typesetting or display (e.g. ornamented initials at the start of chapters).
The xml:id attribute specifies a unique identifier for the element. No two elements in an xml document can have the same xml:id, including inside components that are appended to the primary document by xinclude statements or other means. The semantics of this attribute are defined by
refXMLID .
The xml:space attribute indicates whether the whitespace within an element is significant. The semantics of this attribute are defined by
refXML . Refer to
White Space Handling for more information.
default
Signals that applications' default white-space processing modes are acceptable for this element.
preserve
Signals the intent that applications preserve white space for this element.
The xml:base attribute specifies a base URI to use for resolving relative URI references, for instances where the base URI of the document or external entity is not appropriate. The semantics and behaviors of this attribute are defined by
refXMLBase .
The class attribute provides the ability to express general classifying or commonality between elements. This attribute inherits all the fundamental properties of the (X)HTML class attribute and is usable in the context of
CSS styling . The class attribute is not used to inflect semantics or structure on elements or their contents. Refer to the
role attribute for more information on how to layer semantic meaning on elements.
The xml:lang attribute identifies the natural or formal language in which the content is written. The semantics of this attribute are defined by
refXML . Refer to
Language Identification for more information.
0
The its:dir attribute specifies the base writing direction of the content. If omitted, the implicit value ltr (left-to-right) is assumed. The semantics of this attribute are defined by
refITS . Refer to
Directionality for more information.
ltr
The writing direction is left-to-right. This is the implicit value of this attribute.
rtl
The writing direction is right-to-left.
lro
The writing direction is left-to-right override.
rlo
The writing direction is right-to-left override.
The its:translate attribute indicates whether the content of an element is translatable or not. If omitted, the implicit value yes is assumed. The semantics of this attribute are defined by
refITS . Refer to
Translate for more information.
yes
The content is translatable. This is the default value of this attribute.
no
The content is not translatable.
Identifies a link target with a Legacy extended IRI (
LeIRI )
Identifies the XLink link type In any Z39.98-AI profile and as defined by XLink
Simple Conformance , the xlink type simple is the implied xlink type, and does therefore not need to be expressed literally using the
xlink.type attribute.
simple
The XLink simple link type
Identifies the XLink title of the link.
Identifies the XLink show behavior of the link
new
An application traversing to the ending resource should load it in a new window, frame, pane, or other relevant presentation context.
replace
An application traversing to the ending resource should load the resource in the same window, frame, pane, or other relevant presentation context in which the starting resource was loaded.
embed
An application traversing to the ending resource should load its presentation in place of the presentation of the starting resource.
other
The behavior of an application traversing to the ending resource is unconstrained by XLink. The application should look for other markup present in the link to determine the appropriate behavior.
none
The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior.
Identifies the XLink actuate behavior of the link
onLoad
An application should traverse to the ending resource immediately on loading the starting resource.
onRequest
An application should traverse from the starting resource to the ending resource only on a post-loading event triggered for the purpose of traversal.
other
The behavior of an application traversing to the ending resource is unconstrained by this specification. The application should look for other markup present in the link to determine the appropriate behavior.
none
The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior.
The depth attribute specifies the nesting depth of the current element in relation to ancestors of the same type. An element's name alone does not infer an ancestral relationship; the usage context is equally important. For example, the depth of the first index
section is not influenced by the number of structural
sections that may enclose the index. The outermost ancestor has the implied depth value 0.
The prefix attribute associates RDFa vocabulary namespace prefixes and URIs, as defined in
RDFa Core 1.1 . The prefix attribute may optionally be attached to the root
document element. Z39.98-AI profiles must not allow the attribute to be attached to any other element. The prefix attribute must not be used to redefine prefixes or URIs declared in the default context document for the profile.
\s*([\i-[:]][\c-[:]]*: +[^ ]+)(\s+[\i-[:]][\c-[:]]*: +[^ ]+)*\s*
The about attribute specifies the subject of a relationship. If not given, then the subject is the current document.
The fragment URI in the about attribute must resolve to an ID in the document.
The content attribute specifies a string to use as an object for the
rdfa.property attribute.
The datatype attribute specifies a datatype of the object of the
rdfa.property attribute (either in the content attribute, or the content of the element that the datatype attribute is on.) By default, data in the content attribute is of type string, and data in the content of an element has type xml:Literal. If datatype="" is used, then for the RDF the element content is stripped of markup, and is of type string.
The datatype attribute contains an undeclared CURIE prefix.
The typeof attribute creates a blank node, which becomes the subject, and asserts that the current element contains relationships that match the given RDF type.
The typeof attribute contains an undeclared CURIE prefix.
The property attribute defines a relationship between the subject and either a string (if the
rdfa.content attribute is present) or the content of the element that the property attribute is on.
The property attribute contains an undeclared CURIE prefix.
The rel attribute defines a relation between the subject and a URL given by the
rdfa.resource attribute. The
rdfa.rev attribute expresses the inverse relation.
The rel attribute contains an undeclared CURIE prefix.
The resource attribute specifies an object URI for the
rdfa.rev and
rdfa.rel attributes, if the attribute href is not present.
The rev attribute defines a relation between the subject and a URL given by the
rdfa.resource attribute. The
rdfa.rel attribute expresses the inverse relation.
The rev attribute contains an undeclared CURIE prefix.
The role attribute expresses a semantic inflection on the nature or purpose of its parent element. The attribute takes as its value one or more whitespace separated CURIEs
refRDFa11 , that must be bound to one or more RDF vocabularies either defined in the RDFa initial context document or by the
rdfa.prefix attribute. The role attribute is intended to be functionally compatible with the WAI-PF role attribute (
refROLE ) in its expression of document metadata to improve the accessibility of documents marked up to Z39.98-AI profiles.
The role attribute contains an undeclared CURIE prefix.
The by attribute expresses the contributor of an element to the document source, such as the author, editor, a republisher, etc. The by attribute allows a single CURIE as its value, which must be bound to an RDF property using the mechanism defined in
CURIE . All descendants of an element that declares a by attribute value implicitly inherit that value. In the absence of an expressed relationship, the implicit value author is assumed.
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. Frontmatter pages are typically identified by the use of Roman numerals for their numbering, but numbering alone is not a reliable indicator (it is not uncommon for front matter to begin with Arabic number 1, for example). The table of contents may help identify frontmatter sections either through emphasized typeface and/or the use of line breaks between the front, body and back matter sections.
The bodymatter element groups the primary narrative of a document, as contrasted with preliminary material in frontmatter and supplementary information in backmatter.
The backmatter element groups supplementary sections at the end of a document. Backmatter typically consists of such sections as appendices, glossaries, bibliographies and indices.
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.
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.
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..
The entry element must neither be empty nor contain only whitespace.
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.
The block element must neither be empty nor contain only whitespace.
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.
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.
The aside element must neither be empty nor contain only whitespace.
The cover element represents the complete cover or jacket of a print publication.
The cover element must contain at least one of its allowed children.
The {cover} element must contain descendant {pagebreak}s.
The spine element represents the section of the cover that overlays the bound inner side of a publication. The spine typically contains the author/editor name(s), title and the publisher/imprint logo. Information on the spine is often truncated because of space constraints.
The spine element must neither be empty nor contain only whitespace.
The frontcover element represents all content and images contained on the inside and outside of the front cover. The front outside cover typically contains the title and/or author information overlaid on an illustration. The front inside cover may contain maps, additional books by the author, pricing, ISBN numbers, etc.
The backcover element represents all content and images contained on the inside and outside of the back cover. The back covers typically contain biographical information about contributors, quotes, and a summary or description of the publication.
The flaps element represents all content and images contained on the front and back jacket flaps. If the content on the flaps is continued from the front to back flap, it should be merged and treated as unbroken.
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.
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.
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.
The entry element must neither be empty nor contain only whitespace.
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.
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.
The bibliography entry element represents a single unique entry in a
bibliography .
The entry element must neither be empty nor contain only whitespace.
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 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 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.
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.
Each entry element must contain at least one term element.
Each entry element must contain at least one definition or ref element.
Each {term} element must explicitly reference its {definition}(s) when more than one {term} or {definition} are included in the {entry}.
Each entry element must contain at least one definition or reference to a definition.
The entry element must neither be empty nor contain only whitespace.
Controls the pausing or other prosodic boundaries between tokens. Refer to
SSML 1.1 for further information.
Indicates the prosodic strength of the break in the speech output. Refer to
SSML 1.1 for further information.
none
Indicates that no prosodic break boundary should be output.
x-weak
weak
medium
strong
x-strong
Indicates the duration of a pause to be inserted in the output in seconds or milliseconds. Refer to
SSML 1.1 for further information.
Describes the desired behavior of a synthesis processor upon language speaking failure. The value of this attribute is inherited by descendants. Refer to
SSML 1.1 for further information.
changevoice
if a voice exists that can speak the language, the synthesis processor will switch to that voice and speak the content. Otherwise, the processor chooses another behavior (either ignoretext or ignorelang)
ignoretext
the synthesis processor will not attempt to render the text that is in the failed language.
ignorelang
the synthesis processor will ignore the change in language and speak as if the content were in the previous language.
processorchoice
processorchoice - the synthesis processor chooses the behavior (either changevoice, ignoretext, or ignorelang).
Provides a phonemic/phonetic pronunciation for the contained text. The phoneme element may be empty. However, it is recommended that the element contain human-readable text that can be used for non-spoken rendering of the document. Refer to
SSML 1.1 for further information.
The ssml:phoneme element must not have ssml namespace element or attribute descendants.
The ssml:phoneme element must neither be empty nor contain only whitespace.
Provides a phonemic/phonetic pronunciation for the contained text. The phoneme element may be empty. However, it is recommended that the element contain human-readable text that can be used for non-spoken rendering of the document. Refer to
SSML 1.1 for further information.
The ssml:phoneme element must not have ssml namespace element or attribute descendants.
The ssml:phoneme element must neither be empty nor contain only whitespace.
Specifies a phonemic/phonetic pronunciation for the text contained in the current element. Refer to
SSML 1.1 for further information.
Specifies which phonemic/phonetic pronunciation alphabet is used in the
ssml.ph attribute. If omitted, the implicit value x-SAMPA is assumed. Refer to
SSML 1.1 for further information.
ipa
The pronunciation alphabet is
IPA .
x-SAMPA
The pronunciation alphabet is
X-SAMPA .
Permits control of the pitch, speaking rate and volume of speech output. Refer to
SSML 1.1 for further information.
The ssml:prosody element must not have ssml:prosody descendants.
The ssml:prosody element must neither be empty nor contain only whitespace.
Permits control of the pitch, speaking rate and volume of speech output. Refer to
SSML 1.1 for further information.
The ssml:prosody element must not have ssml:prosody descendants.
The ssml:prosody element must neither be empty nor contain only whitespace.
Specifies the baseline pitch for the contained text. The labels x-low through x-high represent a sequence of monotonically non-decreasing pitch levels. Refer to
SSML 1.1 for further information.
x-low
low
medium
high
x-high
default
Sets the pitch contour for the contained text. Refer to
SSML 1.1 for further information.
Specifies the pitch range (variability) for the contained text. Refer to
SSML 1.1 for further information.
x-low
low
medium
high
x-high
default
Specifies a change in the speaking rate for the contained text. The values x-slow through x-fast represent a sequence of monotonically non-decreasing speaking rates. Refer to
SSML 1.1 for further information.
x-slow
slow
medium
fast
x-fast
default
Specifies a value in seconds or milliseconds for the desired time to take to read the contained text. Refer to
SSML 1.1 for further information.
Specifies the volume for the contained text. If omitted, the implicit value +0.0dB is assumed. Refer to
SSML 1.1 for further information.
silent
x-soft
soft
medium
loud
x-loud
default
Provides information on the type of text construct contained within the element to help specify the level of detail for rendering the contained text. Refer to
SSML 1.1 for further information.
The ssml:say-as element must neither be empty nor contain only whitespace.
Provides information on the type of text construct contained within the element to help specify the level of detail for rendering the contained text. Refer to
SSML 1.1 for further information.
The ssml:say-as element must neither be empty nor contain only whitespace.
Indicates the content type of the contained text construct. Refer to
SSML 1.1 for further information.
date
Indicates that the contained text is a Gregorian calendar date.
time
Indicates that the contained text is a time.
telephone
Indicates that the contained text is a telephone number.
characters
Indicates that the enclosed text should be spoken as a series of alpha-numeric characters.
cardinal
Indicates that the enclosed text is an integral or decimal number and should be spoken as a cardinal number (as opposed to an ordinal number or digit string).
ordinal
Indicates that the enclosed text is an integral number and should be spoken as an ordinal number (as opposed to a cardinal number or digit string).
In addition to
ssml.interpret-as , provides further hints on the precise formatting of the contained text for content types that may have ambiguous formats. Refer to
SSML 1.1 for further information.
Indicates the level of detail to be read aloud or rendered. Refer to
SSML 1.1 for further information.
Indicates that the text in the alias attribute value replaces the contained text for pronunciation. Refer to
SSML 1.1 for further information.
The ssml:sub element must neither be empty nor contain only whitespace.
Specifies the string to be spoken instead of the string in the sub element. Refer to
SSML 1.1 for further information.
Indicates that the text in the alias attribute value replaces the contained text for pronunciation. Refer to
SSML 1.1 for further information.
The ssml:sub element must neither be empty nor contain only whitespace.
Indicates that the content is a token in order to to eliminate token (word) segmentation ambiguities of a synthesis processor. Refer to
SSML 1.1 for further information.
The ssml:token element must neither be empty nor contain only whitespace.
Indicates that the content is a token in order to to eliminate token (word) segmentation ambiguities of a synthesis processor. Refer to
SSML 1.1 for further information.
The ssml:token element must neither be empty nor contain only whitespace.
Specifies a reference to a lexicon document. Refer to
SSML 1.1 for further information.
Identifies the location of the lexicon document. Refer to
SSML 1.1 for further information.
Specifies the media type of the lexicon document. The implicit value of this attribute is application/pls+xml, the media type associated with the
Pronunciation Lexicon Specification . Refer to
SSML 1.1 for further information.
application/pls+xml
Specifies a phonemic/phonetic pronunciation for the text contained in the current element. This attribute inherits the semantics of the
ssml.ph attribute on the SSML
ssml.phoneme element. Note that this attribute is namespace qualified and intended for use on non-SSML namespace elements, as opposed to the default (non-qualified)
ssml.ph attribute, which is only allowed on the
ssml.phoneme element. Consult
Speech Synthesis Markup Language (SSML) Version 1.1 for further information.
Elements with the ssml:ph attribute element must not have ssml:phoneme descendants, nor descendants with the ssml:ph attribute.
The ssml:ph attribute element must neither be empty nor contain only whitespace.
Specifies which phonemic/phonetic pronunciation alphabet is used in the value of the
ssml.ph.ns attribute. Note that this attribute is namespace qualified and intended for use on non-SSML namespace elements in conjunction with the
ssml.ph.ns attribute. If omitted, the implicit value x-SAMPA is assumed. Consult
Speech Synthesis Markup Language (SSML) Version 1.1 for further information.
ipa
The pronunciation alphabet is
IPA .
x-SAMPA
The pronunciation alphabet is
X-SAMPA .
A relative change expression, as defined in
relative change .
[\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)(%|st|Hz)
A
number followed by the string 'Hz'.
[\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)Hz
A pitch contour expression, as defined in
pitch contour .
\(([\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)%), ?([\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)Hz)\)(,\s*\(([\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)%), ?([\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)Hz)\))*
An unsigned
number immediately followed by "%", as defined in
Non-negative percentage .
([0-9]+(\.[0-9]*)?|\.[0-9]+)%
A
number preceded by "+" or "-" and immediately followed by "dB", as defined in
prosody Element .
[\-+]?([0-9]+(\.[0-9]*)?|\.[0-9]+)dB|silent|((x-)?(loud|soft))|medium|default
The container for ruby markup declarations. The its:ruby element contains either
simple or
complex ruby markup. Refer to
ITS Ruby for further information.
Ruby markup.
Contains the base text. Refer to
ITS Ruby for further information.
The its:rb element must not contain its:ruby descendants.
Contains the ruby text. Refer to
ITS Ruby for further information.
The its:rt element must not contain its:ruby descendants.
Allows an its:rt element to span multiple its:rb elements in
complex ruby markup . If omitted, the implicit value 1 is assumed.. Refer to
ITS Ruby for further information.
The rbspan attribute must not be used on the its:rt element in simple ruby markup.
Container for its:rb elements in
complex ruby markup . Refer to
ITS Ruby for further information.
Container for its:rt elements in
complex ruby markup . Refer to
ITS Ruby for further information.
Ruby text beginning and end marker This element is used in the case of
simple ruby markup to specify characters that denote the beginning and end of ruby text when user agents do not have other ways to present ruby text distinctively from the base text. Refer to
ITS Ruby for further information.
numeric
lexicographic
\s*([\+\-]?[0-9]*(\.[0-9]*)?\s*((%?\s*(height|depth|width)?)|e[mx]|in|cm|mm|p[xtc]|((negative)?((very){0,2}thi(n|ck)|medium)mathspace)))\s*
\s*\S\s*
\s*((#[0-9a-fA-F]{3}([0-9a-fA-F]{3})?)|[aA][qQ][uU][aA]|[bB][lL][aA][cC][kK]|[bB][lL][uU][eE]|[fF][uU][cC][hH][sS][iI][aA]|[gG][rR][aA][yY]|[gG][rR][eE][eE][nN]|[lL][iI][mM][eE]|[mM][aA][rR][oO][oO][nN]|[nN][aA][vV][yY]|[oO][lL][iI][vV][eE]|[pP][uU][rR][pP][lL][eE]|[rR][eE][dD]|[sS][iI][lL][vV][eE][rR]|[tT][eE][aA][lL]|[wW][hH][iI][tT][eE]|[yY][eE][lL][lL][oO][wW])\s*
(\s*\{\s*(left|center|right|decimalpoint)(\s+(left|center|right|decimalpoint))*\})*\s*
prefix
infix
postfix
true
false
true
false
true
false
true
false
infinity
true
false
true
false
true
false
auto
newline
nobreak
goodbreak
badbreak
before
after
duplicate
infixlinebreakstyle
left
center
right
auto
id
left
center
right
auto
id
indentalign
indentshift
left
center
right
auto
id
indentalign
indentshift
auto
newline
nobreak
goodbreak
badbreak
indentingnewline
top
middle
bottom
thin
medium
thick
transparent
normal
bold
italic
bold-italic
double-struck
bold-fraktur
script
bold-script
fraktur
sans-serif
bold-sans-serif
sans-serif-italic
sans-serif-bold-italic
monospace
initial
tailed
looped
stretched
small
normal
big
ltr
rtl
left
right
left
center
right
decimalpoint
ltr
rtl
thin
medium
thick
left
center
right
left
center
right
true
false
true
false
before
after
duplicate
true
false
true
false
left
right
center
true
false
true
false
left
center
right
loose
medium
tight
left
center
right
none
solid
dashed
none
updiagonalstrike
downdiagonalstrike
verticalstrike
horizontalstrike
left
center
right
ltr
rtl
left
right
true
false
true
false
true
false
prefix
infix
postfix
none
solid
dashed
left
center
right
auto
id
left
center
right
auto
id
indentalign
left
center
right
auto
id
indentalign
indentshift
indentshift
true
false
auto
newline
nobreak
goodbreak
badbreak
before
after
duplicate
infixlinebreakstyle
thin
medium
thick
w
nw
n
ne
e
se
s
sw
lefttop
stackedrightright
mediumstackedrightright
shortstackedrightright
righttop
left/\right
left)(right
:right=right
stackedleftleft
stackedleftlinetop
small
normal
big
normal
bold
italic
bold-italic
double-struck
bold-fraktur
script
bold-script
fraktur
sans-serif
bold-sans-serif
sans-serif-italic
sans-serif-bold-italic
monospace
initial
tailed
looped
stretched
infinity
true
false
thin
medium
thick
left
center
right
top
bottom
center
baseline
axis
none
solid
dashed
true
false
left
right
leftoverlap
rightoverlap
left
center
right
decimalpoint
true
false
true
false
top
middle
bottom
true
false
left
right
center
true
false
left
right
center
true
false
true
false
left
right
center
\s*(top|bottom|center|baseline|axis)\s*[0-9]*
top
bottom
center
baseline
axis
left
center
right
true
false
auto
none
solid
dashed
none
solid
dashed
none
solid
dashed
true
false
true
false
true
false
left
right
leftoverlap
rightoverlap
top
bottom
center
baseline
axis
left
center
right
top
bottom
center
baseline
axis
left
center
right
left
center
right
decimalpoint
\s*(top|bottom|center|baseline|axis)\s*[0-9]*
left
center
right
decimalpoint
left
center
right
loose
medium
tight
lefttop
stackedrightright
mediumstackedrightright
shortstackedrightright
righttop
left/\right
left)(right
:right=right
stackedleftleft
stackedleftlinetop
w
nw
n
ne
e
se
s
sw
none
updiagonalstrike
downdiagonalstrike
verticalstrike
horizontalstrike
w
nw
n
ne
e
se
s
sw
none
updiagonalstrike
downdiagonalstrike
verticalstrike
horizontalstrike
The annotation-xml element, when used with Z39.98-AI markup, must not contain any descendants in the MathML namespace.
\s*((-?[0-9]*(\.[0-9]*)?(e[mx]|in|cm|mm|p[xtc]|%)?)|(negative)?((very){0,2}thi(n|ck)|medium)mathspace)\s*
application/mathml-content+xml
MathML-Content
application/mathml-presentation+xml
MathML-Presentation
Z39.98-AI
Container for content selection declarations in a Phrase context.
Container for content selection declarations in a Block context.
Container for a content fragment, associated with a selection condition.
Container for a content fragment, associated with a selection condition.
Container for a content fragment to be selected if none of the preceding
when.phrase conditions evaluated to true.
The sel:otherwise element must not have sel:select descendants.
Container for a content fragment to be selected if none of the preceding
when.block conditions evaluated to true.
The sel:otherwise element must not have sel:select descendants.
The expr attribute contains a conditional expression. Refer to the
Content Selection Feature for information on syntax and function set association.
A conditional expression, as defined in
Conditional Expression
The selid attribute provides a mechanism for including ID values on elements that are repeated in more than one select condition. The selid allows a single NCNAME as its value. When processing a select, all selid attributes in the resulting output condition must be converted to xml:id attributes.
[1-9]\d*\.\d+
post
put
get
delete
post
form-data-post
urlencoded-post
#default
asynchronous
synchronous
all
instance
none
;
&
application/xml
application/x-www-form-urlencoded
multipart/related
multipart/form-data
none
[^:]+:[^:]+
minimal
compact
full
open
closed
open
closed
[^:]+:[^:]+
The rend:symbol attribute specifies the textual symbol used to represent a context break in the source document. As an alternative to rend:symbol, the
src attribute may be used to include an image symbol. Note that allowed media types in the src attribute are limited to the same set as the media types allowed on the object element. The rend:symbol and src attributes must not occur simultaneously on the same element.
The rend:prefix attribute specifies the symbol used as prefixes to the item children of an ordered list in the source document. The semantics of the allowed values of this attribute are defined by the
CSS list-style-type property . The value specified in rend:prefix is inherited by any descendant lists, unless such descendant lists specify a rend:prefix attribute themselves. In terms of the
CSS cascade , values provided here must be considered as of author origin. For more specialized symbols than the ones supported by the rend:prefix attribute on list, the
rend:prefix attribute on item can be used.
none
decimal
decimal-leading-zero
lower-alpha
lower-greek
lower-latin
lower-roman
upper-alpha
upper-greek
upper-latin
upper-roman
The rend:prefix attribute specifies the symbol used as prefixes to the item children of an unordered list in the source document. The semantics of the allowed values of this attribute are defined by the
CSS list-style-type property . The value specified in rend:prefix is inherited by any descendant lists, unless such descendant lists specify a rend:prefix attribute themselves. In terms of the
CSS cascade , values provided here must be considered as of author origin. For more specialized symbols than the ones supported by the rend:prefix attribute on list, the
rend:prefix attribute on item can be used.
none
box
check
circle
diamond
disc
hyphen
square
The rend:prefix attribute specifies the symbol used as a prefix to the content of the list item element. The occurrence of this attribute results in the prefix inheritance, as set by the prefix attribute on a list ancestor, ceases to be active, for this item, any following item siblings, and any child lists. To specify prefix symbols common to multiple list items, see
rend.list.unordered.prefix and
rend.list.ordered.prefix .
The rend:prefix attribute specifies the characters or symbols that prefix an element. This variant is intended for use where the attribute and its value carry no special semantics or processing requirements, such as for values that prefix notes and annotations.
The linebreak element represents a forced line ending. The
ln element should be used whenever the text content represents discrete lines.
The description element is the root container element for a description. It consists of an optional container element for metadata information (the
head ) and a required container for the different description types and alternate image renditions (the
body ). The language of the description can be specified by attaching an
xml.lang attribute to the description element. If the description will be made available in a standalone context (i.e., in which its language cannot be inherited from a host content document), the language should always be specified. The
DIAGRAM Description profile provides the ability to compile one or more description elements into a single document for distribution (e.g., to accompany an EPUB). When storing a description in a standalone context, the Description feature namespace http://www.daisy.org/ns/z3998/authoring/features/description/ should be declared on the description element using the xmlns namespace association mechanism defined in
refXMLNamespaces . Although not required, the prefix d is recommended.
The description head element contains meta information about the enclosing
description element. The meta information in the description head element should not be treated as document content, but may be used for display and other purposes when rendering descriptions. Although all metadata is optional, descriptions should, at a minimum, include an identifier, the intended reader age and/or school grade level. See the
DIAGRAM Descriptions Vocabulary for a set of predefined RDF properties. Properties from other RDF vocabularies can also be included, provided their prefix is declared. If age and grade-level metadata is omitted, the containing description should be assumed to be applicable to all readers.
The description body element contains the accessible description forms that readers can select from depending on their needs. The description body must minimally contain the primary description of the associated content in a child
longdesc element. The description body may also optionally compliment the primary description with a briefer
summary and a
simplified language representation . The body of the description can also be used to carry alternative images for readers unable to adequately interact with the source image. The
tactile element can be used to include a tactile image and accompanying
tour , and the
simplifiedImage element can be used to include images more accessible to various reader needs.
The summary element contains a shorter, more succinct version of the primary description in the
longdesc element.
The summary element must neither be empty nor contain only whitespace.
The longdesc element contains the primary description of the associated image, graphic or visually-oriented structure. The longdesc should contain a comprehensive explanation of the referenced item. See the
summary element for information on how to include a compact description.
The longdesc element must neither be empty nor contain only whitespace.
The simplifiedLanguageDescription element contains a simplified language version of the primary description in the
longdesc element.
The simplifiedLanguageDescription element must neither be empty nor contain only whitespace.
The tactile element contains an alternative tactile image. The element may contain one or more identical images for different production methods (e.g., one for swell paper production and another for stereolithograph printing). The tactile image may also include an explanatory
tour . This specification does not place any restrictions on the format used to represent the tactile image, but images should be final-form representations for output rendering by end users. The
role attribute should be used to differentiate the production use for each image.
The tour element is associated with a tactile graphic or a simplified alternative image, and provides orientation. In addition, the tour can explain how to explore the tactile or simplified image.
The simplifiedImage element contains a simplified version of the source image. The element may contain one or more identical images in different formats. The simplified image may also include an explanatory
tour .
An ID TokenizedType, as defined in section 3.3.1 of
refXML .
An IDREF TokenizedType, as defined in section 3.3.1 of
refXML .
A space-separated list of
IDREF TokenizedTypes.
A space-separated list of
NMTOKEN.datatype TokenizedTypes.
An XML non-colonized Name, as defined in section 3.3.7 of
refXML .
A single character, as per section 2.2 of
refXML .
1
Specifies a value that must contain at least one non-whitespace character after whitespace normalization rules have been applied to the attribute value, as expressed through the
XSD normalizedString datatype.
1
A derivation of the
XSD time datatype that only includes hour and minute specifications. The lexical expression is hh:mm.
\d\d:\d\d
A non-negative integer.
[0-9]+
A positive integer.
[0-9]+
An integer.
A Uniform Resource Identifier Reference, as defined by the anyURI type in
refXMLSchemaPart2 .
Media type, as per
refRFC2046 .
[a-zA-Z0-9!#$&+\-\^_]+/[a-zA-Z0-9!#$&+\-\^_]+.*
A time value as defined in CSS 2.1
Times , e.g. 250ms, 3s.
([0-9]+\.)?[0-9]+m?s
A single CURIE, as defined in
refRDFa11 .
(([\i-[:]][\c-[:]]*)?:)?[\i-[:]][\c-[:]]*
block
inline
linebreak
scroll
elide
truncate
scale
top
middle
bottom
The tr element represents a single
table row of data.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy