textobject

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

Synopsis

textobject ::=

Sequence of:
- info? (db.titleforbidden.info)
- One of:
  - One or more of:
    - empty
    - empty
    - revhistory
    - Admonition elements
      note
    - Formal elements
      example
      figure
      table (db.cals.table)
      table (db.html.table)
    - Graphic elements
      mediaobject
    - Informal elements
      informaltable (db.cals.informaltable)
      informaltable (db.html.informaltable)
    - List elements
      itemizedlist
      orderedlist
      variablelist
    - Paragraph elements
      para
    - Publishing elements
      blockquote
      epigraph
      sidebar
    - Verbatim elements
      literallayout
      programlisting
  - phrase (db.phrase)
  - textdata

Attributes

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 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: informaltable (db.cals.informaltable), inlinemediaobject, literallayout, mediaobject, programlisting, table (db.cals.table).

Children

The following elements occur in textobject: blockquote, epigraph, example, figure, info (db.titleforbidden.info), informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, note, orderedlist, para, phrase (db.phrase), programlisting, revhistory, sidebar, table (db.cals.table), table (db.html.table), textdata, variablelist.