figure

figure — A formal figure, generally an illustration, with a title.

Synopsis

figure ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • floatstyle
  • label
  • pgwide (enumeration)
    • “0”
    • “1”
  • type

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

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.

any attribute

Any attribute in any other explicit namespace

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.

type

Identifies the type of figure

Parents

These elements contain figure: abstract, acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, caution, chapter, colophon, danger, dedication, dialogue, drama, entry, example, figure, footnote, formalgroup, glossary, glossdef, glossdiv, glosslist, important, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, meta (db.meta.content), note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, result, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, tip, toc, variablelist, warning.

Children

The following elements occur in figure: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caption, caution, danger, dialogue, drama, epigraph, equation, example, figure, formalgroup, formalpara, glosslist, important, 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, stagedir, table, task, tip, title, titleabbrev, variablelist, warning.

See Also

Related elements: equation, example, informalequation, informalexample, informalfigure, informaltable, table.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example figure</title>
   | 
   |<figure xml:id="ex.pythagorean">
 5 |<title>The Pythagorean Theorem Illustrated</title>
   |<mediaobject>
   |  <imageobject condition="print">
   |    <imagedata fileref="figs/print/db5d_ref01.pdf"/>
   |  </imageobject>
10 |  <imageobject condition="web">
   |    <imagedata fileref="figs/web/db5d_ref01.png"/>
   |  </imageobject>
   |  <textobject><phrase>An illustration of the Pythagorean Theorem</phrase></textobject>
   |</mediaobject>
15 |</figure>
   | 
   |</article>
An illustration of the Pythagorean Theorem
Figure 1. The Pythagorean Theorem Illustrated