DocBook: The Definitive Guide

Table of content


	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

Name

InformalFigure -- A untitled figure

Synopsis

Content Model

InformalFigure ::= ((LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|   ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|Address|BlockQuote|   Graphic|GraphicCO|MediaObject|MediaObjectCO|InformalEquation|   InformalExample|InformalFigure|InformalTable|IndexTerm|Link|   OLink|ULink)+)

Attributes

Common attributes

Name	Type	Default
Label	CDATA	None
PgWide	NUMBER	None
Float	NUMBER	"0"

Tag Minimization

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

Parameter Entities

`%admon.mix;`	`%bookcomponent.content;`	`%component.mix;`
`%divcomponent.mix;`	`%example.mix;`	`%figure.mix;`
`%footnote.mix;`	`%glossdef.mix;`	`%indexdivcomponent.mix;`
`%informal.class;`	`%para.mix;`	`%qandaset.mix;`
`%refcomponent.mix;`	`%sidebar.mix;`

Description

An InformalFigure is a figure without a title. Figures often contain Graphics, or other large display elements.

Processing expectations

Formatted as a displayed block.

Parents

These elements contain InformalFigure: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Example, Figure, Footnote, Glossary, GlossDef, GlossDiv, Important, Index, IndexDiv, InformalExample, InformalFigure, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, QandADiv, QandASet, Question, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning.

Children

The following elements occur in InformalFigure: Address, BlockQuote, CmdSynopsis, FuncSynopsis, Graphic, GraphicCO, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, Link, LiteralLayout, MediaObject, MediaObjectCO, OLink, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, Synopsis, ULink.

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

In some contexts, the following elements are excluded: IndexTerm, InformalTable.

Attributes

Float

If Float has the value 1 (true), then the processing system is free to move the figure to a convenient location. (Where convenient location may be described in the style sheet or may be application dependent.) A value of 0 (false) indicates that the figure should be placed precisely where it occurs in the flow.

Label

Label specifies an identifying string for presentation purposes.

Generally, an explicit Label attribute is used only if the processing system is incapable of generating the label automatically. If present, the Label is normative; it will used even if the processing system is capable of automatic labelling.

PgWide

If Pgwide has the value 0 (false), then the InformalFigure is rendered in the current text flow (with flow column width). A value of 1 (true) specifies that the figure should be rendered across the full text page.

Examples

<!DOCTYPE informalfigure PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <informalfigure> <mediaobject> <imageobject> <imagedata fileref="watarun.eps" srccredit="Norman Walsh, 1998"> </imageobject> <textobject><phrase>Wat Arun</phrase></textobject> <caption><para>Wat Arun, Temple of the Dawn, on the Chao Phraya River in Bangkok, Thailand. In April, 1998, Wat Arun was in the midst of renovation.</para> </caption> </mediaobject> </informalfigure>

Wat Arun

Wat Arun, Temple of the Dawn, on the Chao Phraya River in Bangkok, Thailand. In April, 1998, Wat Arun was in the midst of renovation.