<refentry id="figure.element">
<?dbhtml filename="figure.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>figure</secondary></indexterm>
<refentrytitle>figure</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>figure</refname>
<refpurpose>&figure.purpose;</refpurpose>
</refnamediv>

&figure.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
<sgmltag>Figure</sgmltag> is a formal example with a title. Figures often
contain <sgmltag>Graphic</sgmltag>s, or other large, display elements.
Frequently they are given <acronym>ID</acronym>s and referenced from the text with
<sgmltag>XRef</sgmltag> or <sgmltag>Link</sgmltag>.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block; 
</para>
<para>
<sgmltag>Figure</sgmltag>s may contain multiple display elements.  DocBook
does not specify how these elements are to be presented with respect
to one another.
</para>
<para>
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.
</para>
<para>
A list of figures may be generated at the beginning of a
document.
</para>
</refsect2>


&figure.parents.gen;
&figure.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>float</term>
<listitem>
<para>
If <sgmltag class="attribute">Float</sgmltag> 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.
</para>
</listitem>
</varlistentry>
<varlistentry><term>label</term>
<listitem>
<para>
<sgmltag class='attribute'>Label</sgmltag> specifies an identifying string for presentation purposes.
</para>
<para>
Generally, an explicit <sgmltag class='attribute'>Label</sgmltag> attribute is
used only if the processing system is incapable of generating the label
automatically. If present, the <sgmltag class='attribute'>Label</sgmltag> 
is normative; it will used even
if the processing system is capable of automatic labelling.
</para>
</listitem>
</varlistentry>
<varlistentry><term>pgwide</term>
<listitem>
<para>
If <sgmltag class="attribute">Pgwide</sgmltag> has the value 0 (false), then the
<sgmltag>Figure</sgmltag> 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.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&figure.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

<informalexample role="example-source">
<programlisting>&figure.example.1.txt;</programlisting>
</informalexample>

<anchor id="ex.os.figure.1" role="HACK-ex.out.start"/>
&figure.example.1.gen;
<anchor id="ex.oe.figure.1" role="HACK-ex.out.end"/>

&figure.example.seealso.gen;
</refsect1>
</refentry>

