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

---

InlineGraphic

Name

InlineGraphic -- An object containing or pointing to graphical data that will be rendered inline

Synopsis

Declared Content

InlineGraphic ::=
CDATA

Attributes

Common attributes

Name	Type	Default
Width	NUTOKEN	None
SrcCredit	CDATA	None
Scale	NUMBER	None
Format	Enumerated notation: BMP CGM-BINARY CGM-CHAR CGM-CLEAR DITROFF DVI EPS EQN FAX GIF GIF87a GIF89a IGES JPEG JPG linespecific PCX PIC PS SGML TBL TEX TIFF WMF WPG	None
Align	Enumeration: Center Left Right	None
Scalefit	NUMBER	None
Depth	NUTOKEN	None
EntityRef	ENTITY	None
FileRef	CDATA	None

Tag Minimization

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

Parameter Entities

%cptr.char.mix;	%docinfo.char.mix;	%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

This element contains graphical data, or a pointer to an external entity containing graphical data. One of the deficiencies of the DocBook Graphic element is that there is no way to specify an alternate text description of the graphic. This has been rectified by the introduction of InlineMediaObject.

Processing expectations

Formatted inline.

There are several ways to provide content for a Graphic. It is best to use only one of these methods. However, if multiple graphic sources are provided, the processing expectations are as follows: element content should be used in favor of either EntityRef or FileRef and EntityRef should be used in favor of FileRef.

 Future Changes

In DocBook V4.0, InlineGraphic will be declared EMPTY. This change will require that any embedded graphic content be stored outside the SGML source and pointed to with an EntityRef or FileRef attribute.

 Future Changes

In DocBook V5.0, InlineGraphic will be discarded. At that time, graphics will have to be incorporated using MediaObject or InlineMediaObject.

Parents

These elements contain InlineGraphic: 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, 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.

Attributes

Align

Align specifies the horizontal alignment of the graphic within the element that frames it.

Depth

Depth specifies the desired depth (vertical distance, at least in horizontal writing systems) of the image.

EntityRef

EntityRef identifies the general entity which contains (or points to) the content of the graphic.

FileRef

FileRef specifies the name of the file which contains the content of the graphic.

Format

Format identifies the format of the graphic content. The Format must be a defined notation.

Scale

Scale specifies integer representing a percentage scaling factor (retaining the relative dimensions of the original graphic). If unspecified, the value 100 (100%) is assumed.

Scalefit

If ScaleFit has the value 1 (true), then the graphic is to be scaled (uniformly) to the specified width or depth. The default value of 0 (false) indicates that the image will not be scaled to fit (although it may still be scaled by the Scale attribute).

SrcCredit

SrcCredit contains details about the source of the InlineGraphic.

Width

Width indicates the width of the graphic.

See Also

Alt, AudioObject, Caption, Graphic, ImageObject, InlineMediaObject, MediaObject, TextObject, VideoObject

Examples

For examples, see GUIButton, GUIIcon, GUILabel.

---

Prev	Home	Next
InlineEquation	Up	InlineMediaObject

Back to: DocBook: The Definitive Guide