figure — A formal figure, generally an illustration, with a title
figure ::=
((((title
&
titleabbrev
?),
info
? db.titleforbidden.info) |
info
db.titleonlyreq.info),
(annotation
| bridgehead
|
remark
| revhistory
| Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+,
caption
? db.caption)
Common attributes and common linking attributes.
Additional attributes:
floatstyle
label
pgwide
(enumeration) = “0” | “1”
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
.
caution
must not occur among the children
or descendants of figure
.
important
must not occur among the
children or descendants of figure
.
note
must not occur among the children or
descendants of figure
.
tip
must not occur among the children or
descendants of figure
.
warning
must not occur among the children
or descendants of figure
.
A figure
is a formal example with a title.
Figures often contain mediaobject
s, or other large
display elements. Frequently, they are given IDs and
referenced from the text with xref
or
link
.
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.
Common attributes and common linking attributes.
Specifies style information to be used when rendering the float
Specifies an identifying string for presentation purposes
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. |
<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>