equation
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# equation

## Name

equation — A displayed mathematical equation

##

# Synopsis

### Content Model

    equation ::=
    ((title,titleabbrev?)?,
     (informalequation|
      (alt?,
       (graphic+|mediaobject+))))

### Attributes

Common attributes

Name | Type | Default
label | CDATA | None

### Parameter Entities

The following parameter entities contain equation:

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

An `Equation` is a formal mathematical equation (with an optional rather than 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.

### Future Changes

In some future version of DocBook, probably V5.0, even though the change has not yet been announced, the `Title` on `Equation` will be required. For equations without titles, use `InformalEquation`.

### Parents

These elements contain equation: `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 equation: `alt`, `graphic`, `informalequation`, `mediaobject`, `title`, `titleabbrev`.

## Attributes

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.

## See Also

`example`, `figure`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `inlineequation`, `subscript`, `superscript`, `table`.

## Examples

    <!DOCTYPE equation PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <equation><title>Fermat's Last Theorum</title>
      <alt>x^n + y^n &ne; z^n &forall; n &ne; 2</alt>
      <graphic fileref="figures/fermat"></graphic>
    </equation>

Equation 1. Fermat's Last Theorum

For additional examples, see also `inlinemediaobject` .

Prev | Home | Next
epigraph | Up | errorcode

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