DocBook 5: The Definitive Guide

Name

Callout -- A "called out" description of a marked Area

Synopsis

Content Model

Callout ::= ((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList| SimpleList|VariableList|Caution|Important|Note|Tip|Warning| LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO| ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para| SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject| MediaObjectCO|InformalEquation|InformalExample|InformalFigure| InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure| Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract| AuthorBlurb|Epigraph|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

A "callout" is a visual device for associating annotations with an image, program listing, or similar figure. Each location is identified with a mark, and the annotation is identified with the same mark. This is somewhat analagous to the notion of footnotes in print.

An example will help illustrate the concept. In the following example, the synopsis for the mv command is annotated with two marks. Note the location of the old and new filenames.

mv (1)oldfile (2)newfile

Somewhere else in the document, usually close by, a CalloutList provides a description for each of the callouts:

(1)

The old filename. The mv command renames the file currently called oldfile, which must exist when mv is executed.

(2)

The new filename. The mv command changes the name of the old file to newfile. If newfile exists when mv is executed, it will be replaced by the old file.

Each Callout contains an annotation for an individual callout or a group of callouts. The Callout points to the areas that it annotates with ID references. The areas are identified by coordinates in an an Area or AreaSet, or by an explicit CO element.

Processing expectations

Formatted as a displayed block.

CallOuts usually generate text that points the reader to the appropriate area on the object being augmented. Often, these are numbered bullets or other distinct visual icons. The same icons should be used in both places. In other words, whatever identifies the callouts on the object should generate the same icons on the respective callouts.

In online environments, it may also be possible to establish a linking relationship between the two elements.

The processing expectations of Callouts are likely to deserve special consideration for interchange. See Appendix F. This is especially true if your interchange partners are producing documentation in a medium that has restricted visual presentation features, such as aural media or Braille.

Parents

These elements contain Callout: CalloutList.

Children

The following elements occur in Callout: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, VariableList, Warning.

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

In some contexts, the following elements are excluded: Caution, Equation, Example, Figure, Important, IndexTerm, InformalTable, Note, Table, Tip, Warning.

Attributes

AreaRefs

AreaRefs must point to one or more Areas or AreaSets. These, in turn, identify the portions of the object described by this Callout.

Examples

For examples, see ProgramListingCO, ScreenCO.

Back to: DocBook: The Definitive Guide