caption (db.caption)
caption — A caption.
Synopsis
caption (db.caption) ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
info? (db.titleforbidden.info)- One or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
- 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
Attributes
Additional Constraints
- example must not occur among the children or descendants of caption
- figure must not occur among the children or descendants of caption
- table must not occur among the children or descendants of caption
- equation must not occur among the children or descendants of caption
- sidebar must not occur among the children or descendants of caption
- task must not occur among the children or descendants of caption
- caution must not occur among the children or descendants of caption
- important must not occur among the children or descendants of caption
- note must not occur among the children or descendants of caption
- tip must not occur among the children or descendants of caption
- warning must not occur among the children or descendants of caption
- If this element is the root element, it must have a version attribute.
Description
A caption is an extended description of a
mediaobject or figure or other
formal or informal element. Unlike a textobject,
which is an alternative to the other elements in the
mediaobject, the caption augments
the object.
Processing expectations
Formatted as a displayed block.
Parents
These elements contain caption: equation, example, figure, informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), mediaobject, table (db.cals.table).
Children
The following elements occur in caption: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, variablelist, warning.
See Also
audioobject, caption (db.html.caption), imageobject, inlinemediaobject, mediaobject, textobject, videoobject
Examples
See informalfigure for and example that uses caption.