figure
figure — A formal figure, generally an illustration, with a title.
Synopsis
figure ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- One or more of:
bridgeheaddialoguedramapoetryremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
- List elements
- Paragraph elements
- Publishing elements
- Technical elements
- Verbatim elements
caption?
- One of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- floatstyle
- label
- pgwide (enumeration)
- “0”
- “1”
Additional Constraints
- example must not occur among the children or descendants of figure
- figure must not occur among the children or descendants of figure
- table must not occur among the children or descendants of figure
- equation must not occur among the children or descendants of figure
- note must not occur among the children or descendants of figure
Description
A figure is a formal example with a title.
Figures often contain mediaobjects, or other large
display elements. Frequently, they are given IDs and
referenced from the text with xref or
link.
Processing expectations
Formatted as a displayed block.
A figure may contain multiple display
elements. DocBook does not specify how these elements are to be
presented with respect to one another.
DocBook does not specify the location of the figure within the final displayed flow of text; it may float or remain where it is located.
A list of figures may be generated at the beginning of a document.
Attributes
Common attributes and common linking attributes.
- floatstyle
Specifies style information to be used when rendering the float
- label
Specifies an identifying string for presentation purposes
- pgwide
Indicates if the element is rendered across the column or the page
Enumerated values: “0” The element should be rendered in the current text flow (with the flow column width).
“1” The element should be rendered across the full text page.
Parents
These elements contain figure: acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, chapter, colophon, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, toc, variablelist.
Children
The following elements occur in figure: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caption, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonlyreq.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, table, task, title, titleabbrev, variablelist.
See Also
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example figure</title>
<figure xml:id="ex.pythagorean">
<title>The Pythagorean Theorem Illustrated</title>
<mediaobject>
<imageobject condition="print">
<imagedata fileref="figs/print/db5d_ref01.pdf"/>
</imageobject>
<imageobject condition="web">
<imagedata fileref="figs/web/db5d_ref01.png"/>
</imageobject>
<textobject><phrase>An illustration of the Pythagorean Theorem</phrase></textobject>
</mediaobject>
</figure>
</article>
