Caption

Name

Caption -- A caption

Synopsis

Content Model

Caption ::=
(CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
 SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
 LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
 ScreenShot|FormalPara|Para|SimPara|BlockQuote)*

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Description

A Caption is an extended description of a MediaObject. 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: MediaObject.

Children

The following elements occur in Caption: BlockQuote, CalloutList, Caution, FormalPara, GlossList, Important, ItemizedList, LiteralLayout, Note, OrderedList, Para, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, SimPara, SimpleList, Tip, VariableList, Warning.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: Caution, Important, Note, Tip, Warning.

See Also

Alt, AudioObject, Graphic, ImageObject, InlineGraphic, InlineMediaObject, MediaObject, TextObject, VideoObject

Examples

For examples, see ImageObject, InformalFigure.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.