figure
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# figure

## Name

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

##

# Synopsis

### Content Model

    figure ::=
    ((title,titleabbrev?),
     (literallayout|programlisting|programlistingco|screen|screenco|
      screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|
      fieldsynopsis|constructorsynopsis|destructorsynopsis|
      methodsynopsis|address|blockquote|graphic|graphicco|mediaobject|
      mediaobjectco|informalequation|informalexample|informalfigure|
      informaltable|indexterm|beginpage|link|olink|ulink)+)

### Attributes

Common attributes

Name | Type | Default
label | CDATA | None
pgwide | CDATA | None
float | CDATA | "0"

### Parameter Entities

The following parameter entities contain figure:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%formal.class;` | `%glossdef.mix;`
`%para.mix;` | `%qandaset.mix;` | `%refcomponent.mix;`
`%revdescription.mix;` | `%sidebar.mix;` |

## Description

`Figure` is a formal example with a title. Figures often contain `Graphic`s, 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.

`Figure`s 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.

### Parents

These elements contain figure: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caution`, `chapter`, `constraintdef`, `glossary`, `glossdef`, `glossdiv`, `important`, `index`, `listitem`, `msgexplan`, `msgtext`, `note`, `para`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `tip`, `warning`.

### Children

The following elements occur in figure: `address`, `beginpage`, `blockquote`, `classsynopsis`, `cmdsynopsis`, `constructorsynopsis`, `destructorsynopsis`, `fieldsynopsis`, `funcsynopsis`, `graphic`, `graphicco`, `indexterm`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `link`, `literallayout`, `mediaobject`, `mediaobjectco`, `methodsynopsis`, `olink`, `programlisting`, `programlistingco`, `screen`, `screenco`, `screenshot`, `synopsis`, `title`, `titleabbrev`, `ulink`.

## 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 `Figure` 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.

## See Also

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

## Examples

    <!DOCTYPE figure PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <figure><title>The Pythagorean Theorum Illustrated</title>
    <graphic fileref="figures/pythag"></graphic>
    </figure>

Figure 3. The Pythagorean Theorum Illustrated

For additional examples, see also `graphic` .

Prev | Home | Next
fieldsynopsis | Up | filename

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.