callout — A “called out” description of a marked Area.
- arearefs (IDREFS)
Required attributes are shown in bold.
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 analogous 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.
Somewhere else in the document, usually close by, a
calloutlist provides a description for each of the
The old filename. The mv command renames
the file currently called
The new filename. The mv command changes
the name of the old file to
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
or by an explicit
Formatted as a displayed block.
callout usually generates 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
likely to deserve special consideration for interchange. See Appendix D, Interchanging DocBook Documents. 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
Identifies the areas described by this callout.
The following elements occur in callout: