Schema Documentation: the annotation element

On this page:

Back to
main menu
Usage Example
Allowed parents
Allowed children
Content model and additional requirements
Variants
Namespace

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 (block) elements for more information.

Usage Example

<verse>
    <ln xml:id="bw_1">Famed was this Beowulf:
        <annotation ref="bw_1">Not, of course, Beowulf the Great, hero of the epic.</annotation>
    </ln>            
    <ln>far flew the boast of him,</ln>
</verse>

Allowed parents

address, annotation (block variant), annotation (phrase variant), m:annotation-xml, aside (block variant), aside (toc variant), block, caption, citation (block variant), citation (phrase variant), d, definition, description (block variant), description (phrase variant), entry (bibliography variant), entry (glossary variant), entry (index variant), xforms:group, item, xforms:label, ln, lngroup, d:longdesc, meta, note (block variant), note (phrase variant), object (block variant), object (phrase variant), sel:otherwise, p, ssml:phoneme, ssml:prosody, quote (block variant), quote (phrase variant), its:rb, xforms:repeat, its:rt, s, ssml:say-as (phrase variant), ssml:say-as (text variant), section, d:simplifiedLanguageDescription, span, ssml:sub, d:summary, td, th, d:tour, verse and sel:when

Allowed children

This element may contain text.

This element may contain the following children: abbr, address, annoref, annotation, ssml:break, char, citation, code, d, definition, emph (text variant), emph (phrase variant), expansion, xforms:input, rend:linebreak, ln, m:math, name, note, noteref, num, object (text variant), object (phrase variant), pagebreak, ssml:phoneme (text variant), ssml:phoneme (phrase variant), ssml:prosody (text variant), ssml:prosody (phrase variant), quote, xforms:range, ref, its:ruby, s, ssml:say-as (text variant), ssml:say-as (phrase variant), xforms:secret, sel:select, xforms:select, xforms:select1, span (text variant), span (phrase variant), sub, ssml:sub (text variant), ssml:sub (phrase variant), sup, term, xforms:textarea, time, ssml:token (text variant), ssml:token (phrase variant) and w

Content model and additional requirements

optional attributes: @about, @by, @class, @content, @datatype, @desc, @its:dir, @its:translate, @property, @ref, @rel, @resource, @rev, @role, @sel:selid, @ssml:onlangfailure, @typeof, @xml:base, @xml:id, @xml:lang and @xml:space

optionally the following 2 co-ocurring attributes: @ssml:alphabet and @ssml:ph

one or more of

a choice of

either one of the 53 elements: abbr, address, annoref, annotation, char, citation, code, d, definition, emph, emph, expansion, its:ruby, ln, m:math, name, note, noteref, num, object, object, pagebreak, quote, ref, rend:linebreak, s, sel:select, span, span, ssml:break, ssml:break, ssml:phoneme, ssml:phoneme, ssml:prosody, ssml:prosody, ssml:say-as, ssml:say-as, ssml:sub, ssml:sub, ssml:token, ssml:token, sub, sup, term, time, w, w, xforms:input, xforms:range, xforms:secret, xforms:select, xforms:select1 or xforms:textarea

or text

end of choice

Note that in addition to restrictions presented in the content model above, use of this element must also respect the following requirements:

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.

Such requirements take precedence over any conflicting statements in the content model or in the lists above of allowed children and parents.

Variants

This element exists in 2 variants. The other variant is the block variant.

Namespace

http://www.daisy.org/ns/z3998/authoring/