Home Prev Up Next DocBook 5: The Definitive Guide (Version 1.1 for DocBook V5.0+)

caption (db.caption)

caption — A caption

Synopsis

Attributes

Common attributes and common linking 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, html:form, 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.

Prev  Home  Next
calloutlist  Up  caption (db.html.caption)
$Revision: 8627 $ / $Date: 2010-05-19 09:57:55 -0400 (Wed, 19 May 2010) $

Copyright © 2010 Norman Walsh.