inlinemediaobject
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# inlinemediaobject

## Name

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

##

# Synopsis

### Content Model

    inlinemediaobject ::=
    (objectinfo?,
     (videoobject|audioobject|imageobject),
     (videoobject|audioobject|imageobject|textobject)*)

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain inlinemediaobject:

Parameter Entities
`%cptr.char.mix;` | `%docinfo.char.mix;` | `%inlineequation.content;`
`%inlineobj.char.class;` | `%ndxterm.char.mix;` | `%para.char.mix;`
`%smallcptr.char.mix;` | `%tbl.entry.mdl;` | `%title.char.mix;`
`%word.char.mix;` |  |

## Description

`InlineMediaObject` contains a set of alternative “graphical objects.” In DocBook V3.1, three types of external graphical objects are defined: `VideoObject`s, `AudioObject`s, and `ImageObject`s. Additional textual descriptions may be provided with `TextObject`s.

### Processing expectations

Formatted inline.

The primary purpose of the `InlineMediaObject` 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 `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 should 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.

### Future Changes

In DocBook V5.0, `InlineMediaObject` will replace `InlineGraphic`.

### Parents

These elements contain inlinemediaobject: `abbrev`, `accel`, `ackno`, `acronym`, `action`, `application`, `artpagenums`, `attribution`, `authorinitials`, `bibliomisc`, `bridgehead`, `citation`, `citetitle`, `city`, `classname`, `classsynopsisinfo`, `collabname`, `command`, `computeroutput`, `confdates`, `confnum`, `confsponsor`, `conftitle`, `constant`, `contractnum`, `contractsponsor`, `contrib`, `corpauthor`, `corpname`, `country`, `database`, `date`, `edition`, `email`, `emphasis`, `entry`, `envar`, `errorcode`, `errorname`, `errortype`, `exceptionname`, `fax`, `filename`, `firstname`, `firstterm`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glosssee`, `glossseealso`, `glossterm`, `guibutton`, `guiicon`, `guilabel`, `guimenu`, `guimenuitem`, `guisubmenu`, `hardware`, `holder`, `honorific`, `initializer`, `inlineequation`, `interface`, `interfacename`, `invpartnumber`, `isbn`, `issn`, `issuenum`, `jobtitle`, `keycap`, `keycode`, `keysym`, `label`, `lineage`, `lineannotation`, `link`, `literal`, `literallayout`, `lotentry`, `manvolnum`, `markup`, `medialabel`, `member`, `methodname`, `modespec`, `modifier`, `mousebutton`, `msgaud`, `msglevel`, `msgorig`, `olink`, `option`, `optional`, `orgdiv`, `orgname`, `otheraddr`, `othername`, `pagenums`, `para`, `parameter`, `phone`, `phrase`, `pob`, `postcode`, `primary`, `primaryie`, `productname`, `productnumber`, `programlisting`, `prompt`, `property`, `pubdate`, `publishername`, `pubsnumber`, `quote`, `refentrytitle`, `refmiscinfo`, `releaseinfo`, `remark`, `replaceable`, `returnvalue`, `revnumber`, `revremark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `seriesvolnums`, `sgmltag`, `shortaffil`, `simpara`, `state`, `street`, `structfield`, `structname`, `subscript`, `subtitle`, `superscript`, `surname`, `symbol`, `synopsis`, `systemitem`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `token`, `trademark`, `type`, `ulink`, `userinput`, `varname`, `volumenum`, `wordasword`, `year`.

### Children

The following elements occur in inlinemediaobject: `audioobject`, `imageobject`, `objectinfo`, `textobject`, `videoobject`.

## See Also

`alt`, `audioobject`, `caption`, `graphic`, `imageobject`, `inlinegraphic`, `mediaobject`, `textobject`, `videoobject`.

## Examples

In the following example, the `InlineEquation` uses `InlineMediaObject` to provide to alternate renderings for the equation. One is a graphic, the other is a text representation.

For display purposes, both in print and in the online presentation, the graphic is selected. If you were generating content for some other medium, a text only browser or a cell phone, for example, only the text representation might be selected.

    <!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <para>
    Einstein's most famous equation,
    <inlineequation>
    <inlinemediaobject>
    <imageobject>
    <imagedata fileref="figures/emc2.gif"/>
    </imageobject>
    <textobject>
    <phrase>E=mc<superscript>2</superscript></phrase>
    </textobject>
    </inlinemediaobject>
    </inlineequation>, expresses the relationship between matter
    and energy.
    </para>

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

Prev | Home | Next
inlinegraphic | Up | interface

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.