mediaobject

mediaobject — A displayed media object (video, audio, image, etc.)

Synopsis

mediaobject ::=

Sequence of:
- info? (db.titleforbidden.info)
- alt?
- One or more of:
- caption? (db.caption)

Attributes

Common attributes and common linking attributes.

Description

This element contains a set of alternative “media objects.” Exactly one object will be selected and rendered.

Processing expectations

Formatted as a displayed block. The primary purpose of the mediaobject is to provide a wrapper around a set of alternative presentations of the same information.

If possible, the processing system should use the content of the first object within the mediaobject. If the first object cannot be used, the remaining objects should be considered in the order that they occur. A processor should use the first object that it can, although it is free to choose any of the remaining objects if the primary one cannot be used.

Under no circumstances should more than one object in a mediaobject be used or presented at the same time.

For example, a mediaobject might contain a video, a high resolution image, a low resolution image, a long text description, and a short text description. In a “high end” online system, the video is used. For print publishing, the high resolution image is used. For other online systems, either the high or low resolution image is used, possibly including the short text description as the online alternative. In a text-only environment, either the long or short text descriptions are used.

Parents

These elements contain mediaobject: acknowledgements, annotation, answer, appendix, article, bibliodiv, biblioentry, bibliography, bibliolist, bibliomixed, bibliomset, biblioset, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, dedication, entry, equation, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, info (db.info), info (db.titleforbidden.info), info (db.titleonly.info), info (db.titleonlyreq.info), info (db.titlereq.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, screenshot, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, table (db.cals.table), taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.

Children

The following elements occur in mediaobject: alt, audioobject, caption (db.caption), imageobject, imageobjectco, info (db.titleforbidden.info), textobject, videoobject.

Examples

<article xmlns='http://docbook.org/ns/docbook'
         xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Example mediaobject</title>

<mediaobject>
  <info>
    <othercredit>
      <orgname>O'Reilly &amp; Associates</orgname>
    </othercredit>
    <othercredit>
      <orgname>Dover Archives</orgname>
    </othercredit>
  </info>
  <alt>The DocBook: TDG Duck</alt>
  <imageobject>
    <imagedata align="right" width="6in" format="PNG"
               fileref="figures/duck-small.png"/>
  </imageobject>
  <imageobject>
    <imagedata align="right" width="6in" format="GIF"
               fileref="figures/duck-small.gif"/>
  </imageobject>
  <textobject>
    <para>The bird on the cover of <citetitle>DocBook: The Definitive
Guide</citetitle> is a wood duck.  Often considered one of the most
beautiful ducks in North America, the mail wood duck has a metallic
purple and green head with white streaks extending from its bill
around the eyes and down to its blue and green, gold-flecked
wings. It has a white neck, chestnut-colored chest, a white or red
bill, and yellow-orange legs and feet. Females have more brown, gray,
and subdueed hues.</para>

<para>Edie Freedman designed the cover of this book, using a
19th-century engraving from the Dover Pictorial Archive. The
cover layout was produced by Kathleen Wilson using QuarkXPress
3.32 and Adobe's ITC Garamond font. The inside layout was
designed by Alicia Cech, based on a series design by Nancy
Priest. The text was formatted from SGML into FrameMaker 5.5
with Jade, using a DSSSL conversion stylesheet written by
Chris Maden. The interior fonts are ITC Garamond Light,
Garamond Book, and ConstantWillison.</para>
  </textobject>
</mediaobject>

</article>

[D]

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


mathphrase		member