inlinemediaobject

inlinemediaobject — An inline media object (video, audio, image, and so on).

Synopsis

inlinemediaobject ::=

Additional Constraints

  • If this element is the root element, it must have a version attribute.

Description

The inlinemediaobject element contains a set of alternative “graphical objects”: videoobject, audioobject, and imageobject. Additional textual descriptions may be provided with textobjects.

An inlinemediaobject provides a wrapper for a set of alternative presentations for some, usually graphical, information. It is the “inline” equivalent of mediaobject.

In almost all contexts where text is allowed, inlinemediaobject is also allowed. This allows an author to provide a graphic for a character or glyph—for example, one that is not available in the publisher’s fonts or perhaps is not available in Unicode. Authors should exercise care when using inlinemediaobject for this purpose as graphics may be difficult or impossible to display in some contexts on some presentation systems.

Processing expectations

Formatted inline.

If possible, the processing system should use the content of the first object within the inlinemediaobject. 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 may more than one object in an inlinemediaobject be used or presented at the same time.

For example, an inlinemediaobject might contain a high-resolution image, a low-resolution image, and a text description. For print publishing, the high-resolution image is used; for online systems, either the high- or low-resolution image is used, possibly including the text description as an online alternative. In a text-only environment, the text description is used.

Parents

These elements contain inlinemediaobject: abbrev, accel, acronym, address, alt, application, arg, artpagenums, attribution, authorinitials, bibliocoverage, biblioid, bibliomisc, bibliomixed, bibliomset, bibliorelation, bibliosource, bridgehead, caption (db.html.caption), citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, command, computeroutput, confdates, confnum, confsponsor, conftitle, constant, contractnum, contractsponsor, contrib, country, database, description, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, envar, errorcode, errorname, errortext, errortype, exceptionname, fax, filename, firstname, firstterm (db._firstterm), firstterm (db.firstterm), foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), funcdef, funcparams, funcsynopsisinfo, function, givenname, glosssee, glossseealso, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, initializer, inlineequation, interfacename, issuenum, jobtitle, keycap, keycode, keysym, label, lineage, lineannotation, link, literal, literallayout, manvolnum, markup, mathphrase, member, methodname, modifier, mousebutton, msgaud, msglevel, msgorig, olink, option, optional, orgdiv, orgname, otheraddr, othername, package, pagenums, para, paramdef, parameter, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, postcode, primary, primaryie, productname, productnumber, programlisting, prompt, property, publishername, quote (db._quote), quote (db.quote), refdescriptor, refentrytitle, refmiscinfo, refname, refpurpose, releaseinfo, remark, replaceable, returnvalue, revnumber, revremark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, seriesvolnums, shortaffil, simpara, state, street, subscript, subtitle, superscript, surname, symbol, synopsis, systemitem, tag, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, token, trademark, type, uri, userinput, varname, volumenum, wordasword, year.

Children

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

Examples

<?xml version="1.0" encoding="UTF-8"?>
<article xmlns="http://docbook.org/ns/docbook">
<title>Example inlinemediaobject</title>

<para>Einstein's most famous equation,
<inlineequation>
  <inlinemediaobject>
    <imageobject condition="print">
      <imagedata fileref="figs/print/db5d_refeqn03.pdf"/>
    </imageobject>
    <imageobject condition="web">
      <imagedata fileref="figs/web/db5d_refeqn03.png"/>
    </imageobject>
    <textobject>
      <phrase>E=mc<superscript>2</superscript></phrase>
    </textobject>
  </inlinemediaobject>
  </inlineequation>, expresses the relationship between matter and energy.
</para>

</article>

Einstein's most famous equation, E=mc2, expresses the relationship between matter and energy.

Last revised by Norman Walsh on (git hash: 32232d73aaed8bf7134470f3f72f9e1dc6874d38 68abf83671c42c0ef5e0aed2f171edf1c3b1bdcd)