annotation
annotation — An annotation.
Synopsis
- Sequence of:
- One of:
- One or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
![[-]](figs/web/nav/down.gif)
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
Additional Constraints
- annotation must not occur in the descendants of annotation
Description
The annotation element is a “block” annotation.
Block annotations can be used for pop ups and other “out of line”
effects.
An annotation element is associated with
another element by using a reference to an xml:id value. The association can go in
either direction. An annotation element can use an
annotates attribute on itself to
point to an xml:id on another
element. Or the other element can use an annotations attribute (one of the common
attributes) on itself to point to an xml:id on an annotation
element. There is no assumption that an annotation
element is associated with its parent or any other ancestor
element.
The attribute type of annotations and annotates is plain text, not IDREF or
IDREFS. That enables modular content files to form associations with
elements in other files without generating validation errors.
Processing expectations
Application specific.
Attributes
- annotates
Identifies one ore more elements to which this annotation applies
Parents ![[+]](figs/web/nav/right.gif)
Children
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example of an annotation</title> 4 <annotation xml:id="note-parts-list"> <para>This list is not comprehensive.</para> 6 </annotation> 8 <para annotations="note-parts-list"> An automobile contains an engine, 10 wheels, doors, and windows. </para> 12 </article>