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:
annotationbridgeheadformalgroupremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
phrase(db.phrase)textdata
- One or more of:
Attributes
Common attributes and common linking attributes.
No additional attributes.
Additional Constraints
- If this element is the root element, it must have a version attribute.
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.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain textobject: classsynopsisinfo, funcsynopsisinfo, informaltable (db.cals.informaltable), inlinemediaobject, literallayout, mediaobject, programlisting, screen, synopsis, synopsisinfo, table (db.cals.table).
Children
The following elements occur in textobject: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, para, phrase (db.phrase), procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, textdata, tip, typedefsynopsis, unionsynopsis, variablelist, warning.
See Also
Related elements: audioobject, caption, imageobject, inlinemediaobject, mediaobject, videoobject.