figure

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

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

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

Additional Constraints

  • example must not occur in the descendants of figure
  • figure must not occur in the descendants of figure
  • table must not occur in the descendants of figure
  • table must not occur in the descendants of figure
  • caution must not occur in the descendants of figure
  • important must not occur in the descendants of figure
  • note must not occur in the descendants of figure
  • tip must not occur in the descendants of figure
  • warning must not occur in the descendants of figure

Description

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.

Figures 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

FIXME:

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.

See Also

equation, example, informalequation, informalexample, informalfigure, informaltable, table

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>
    <imagedata fileref="figures/pythag.png"/>
  </imageobject>
  <textobject><phrase>An illustration of the Pythagorean Theorem</phrase></textobject>
</mediaobject>
</figure>

</article>

Figure 1. The Pythagorean Theorem Illustrated

An illustration of the Pythagorean Theorem

ChangeLog

This alpha reference page is $Revision: 1.5 $ published $Date: 2005/10/31 18:42:45 $.