figure

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

Synopsis

figure ::=

Sequence of:
- One of:
  - Sequence of:
    - Interleave of:
      - title
      - titleabbrev?
    - info? (db.titleforbidden.info)
  - info (db.titleonlyreq.info)
- One or more of:
  - empty
  - empty
  - revhistory
  - speakernotes
  - Admonition elements
    note
  - Formal elements
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
  - Informal elements
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    itemizedlist
    orderedlist
    variablelist
  - Paragraph elements
    para
  - Publishing elements
    blockquote
    epigraph
    sidebar
  - Verbatim elements
    literallayout
    programlisting
- caption? (db.caption)

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

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.

type

Identifies the type of figure

Parents

These elements contain figure: abstract, bibliodiv, bibliography, blockquote, caption (db.caption), entry, example, figure, foil, foilgroup, footnote, itemizedlist, legalnotice, listitem, note, orderedlist, revdescription, section, sidebar, slides, speakernotes, td, textobject, th, variablelist.

Children

The following elements occur in figure: blockquote, caption (db.caption), epigraph, example, figure, info (db.titleforbidden.info), info (db.titleonlyreq.info), informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, note, orderedlist, para, programlisting, revhistory, sidebar, speakernotes, table (db.cals.table), table (db.html.table), title, titleabbrev, variablelist.

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