DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

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

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%cptr.char.mix;	%docinfo.char.mix;	%inlineequation.content;
%inlineobj.char.class;	%ndxterm.char.mix;	%para.char.mix;
%programlisting.content;	%screen.content;	%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: VideoObjects, AudioObjects, and ImageObjects. Additional textual descriptions may be provided with TextObjects.

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, CollabName, Command, Comment, ComputerOutput, ConfDates, ConfNum, ConfSponsor, ConfTitle, Constant, ContractNum, ContractSponsor, Contrib, CorpAuthor, CorpName, Country, Database, Date, Edition, Email, Emphasis, entry, EnVar, ErrorCode, ErrorName, ErrorType, Fax, Filename, FirstName, FirstTerm, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, Holder, Honorific, InlineEquation, Interface, InterfaceDefinition, InvPartNumber, ISBN, ISSN, IssueNum, JobTitle, KeyCap, KeyCode, KeySym, Label, Lineage, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, ManVolNum, Markup, MediaLabel, Member, ModeSpec, 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, 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.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

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 V3.1//EN">
<para>
Einstien'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>

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

---

Prev	Home	Next
InlineGraphic	Up	Interface

Back to: DocBook: The Definitive Guide