xml.schema.z3998-book-1.0.mod.z3998-annotation.rng Maven / Gradle / Ivy
The annotation module
This module defines the annotation element for including annotations and comments about the document content.
Two variants of the annotation element are available: one for use in a Block context and a second for use in a Phrase context.
More information about this module is available at http://www.daisy.org/z3998/2012/auth/cm/#z3998.annotation.module
Markus Gylling
[email protected]
2009
2010
2011
2012
DAISY Consortium
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
2012-12-19
MGy
Initial version
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 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.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy