DocBook Publishers: The Definitive Guide (Version 1.2.1 for DocBook 5.1) |
equation
equation — A displayed mathematical equation.
Synopsis
Attributes
Common attributes and common linking attributes.
Additional attributes:
- floatstyle
- label
- pgwide (enumeration)
- “0”
- “1”
Description
An equation
is a formal mathematical equation
(with an optional rather than a required title).
If the MathML Module is used, equation
can also
contain the mml:math
element.
Processing expectations
Formatted as a displayed block. For an inline equation, use
inlineequation
.
Processing systems that number equations or build a table of
equations at the beginning of a document may have difficulty correctly
formatting documents that contain both equation
s
with title
s and equation
s
without title
s. You are advised to use informalequation
for equations without
titles.
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.
Parents
These elements contain equation
: acknowledgements
, answer
, appendix
, article
, bibliodiv
, bibliography
, bibliolist
, blockquote
, callout
, calloutlist
, caption
, chapter
, colophon
, dedication
, dialogue
, drama
, entry
, example
, figure
, footnote
, glossary
, glossdef
, glossdiv
, glosslist
, index
, informalexample
, informalfigure
, itemizedlist
, legalnotice
, linegroup
, listitem
, note
, orderedlist
, para
, partintro
, poetry
, preface
, procedure
, qandadiv
, qandaset
, question
, result
, revdescription
, section
, setindex
, sidebar
, simplesect
, step
, taskprerequisites
, taskrelated
, tasksummary
, textobject
, toc
, variablelist
.
Children
The following elements occur in equation: alt
, caption
, info
(db.titleforbidden.info), info
(db.titleonly.info), mathphrase
, mediaobject
, mml:*
, title
, titleabbrev
.
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example equation</title>
<equation xml:id="eq.fermat">
<title>Fermat's Last Theorem</title>
<alt>x^n + y^n ≠ z^n ∀ n ≠ 2</alt>
<mediaobject>
<imageobject condition="print">
<imagedata fileref="figs/print/db5d_refeqn01.pdf"/>
</imageobject>
<imageobject condition="web">
<imagedata fileref="figs/web/db5d_refeqn01.png"/>
</imageobject>
</mediaobject>
</equation>
</article>

Alternatively, for relatively simple equations such as Fermat's Last
Theorem, mathphrase
is often sufficient:
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example equation</title>
<equation xml:id="eq.fermat.mathphrase">
<title>Fermat's Last Theorem</title>
<alt>x^n + y^n ≠ z^n ∀ n ≠ 2</alt>
<mathphrase>x<superscript>n</superscript>
+ y<superscript>n</superscript>
≠ z<superscript>n</superscript>
∀ n ≠ 2</mathphrase>
</equation>
</article>