DocBook 5: The Definitive Guide

Name

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

Synopsis

textobject ::= (info? ^{db.titleforbidden.info}, ((annotation | bridgehead | remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+ | phrase ^db.phrase | textdata))

Attribute synopsis

Common attributes and common linking attributes.

Description

A textobject is a wrapper containing a textual description of a media object and its associated meta-information. A textobject is only allowed in mediaobject as a fallback. It 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 ...