DocBook 5: The Definitive Guide

Name

TextObject -- A wrapper for a text description of an object and its associated meta-information

Synopsis

Content Model

TextObject ::= (ObjectInfo?, (Phrase| (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 TextObject is a wrapper containing a textual description of a media object, and its associated meta-information. TextObjects are only allowed in MediaObjects as a fall-back option, they cannot be the primary content.

There are two different forms of TextObject, and it is not unreasonable for a media object to contain both of them.

In the first form, the content of a TextObject is simply a Phrase. This form is a mechanism for providing a simple "alt text" for a media object. The phrase might be used, for example, as the value of the ALT attribute on an HTML IMG, with the primary content of the image coming from one of the other objects in the media object.

In the second form, the content of TextObject is a longer, prose description. This form could be used when rendering to devices that are incapable of displaying any of the other alternatives.

Processing expectations

May be formatted inline or as a displayed block, depending on context. It might not be rendered at all, depending on its placement within a MediaObject or InlineMediaObject and the constraints on the publishing system. For a more detailed description of the semantics involved, see MediaObject.

Parents

These elements contain TextObject: InlineMediaObject, MediaObject, MediaObjectCO.

Children

The following elements occur in TextObject: BlockQuote, CalloutList, Caution, FormalPara, GlossList, Important, ItemizedList, LiteralLayout, Note, ObjectInfo, OrderedList, Para, Phrase, 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, Caption, Graphic, ImageObject, InlineGraphic, InlineMediaObject, MediaObject, VideoObject

Examples

For examples, see AudioObject, ImageObject, InformalFigure, InlineMediaObject, VideoObject.

Back to: DocBook: The Definitive Guide