DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
Equation
Synopsis
Content Model
Equation ::= ((Title,TitleAbbrev?)?, (InformalEquation| (Alt?, (Graphic+|MediaObject+))))Attributes
Name
Type
Default
Label CDATA None Tag Minimization
Both the start- and end-tags are required for this element.
Parameter Entities
%admon.mix; %bookcomponent.content; %component.mix; %divcomponent.mix; %footnote.exclusion; %formal.class; %formal.exclusion; %glossdef.mix; %highlights.exclusion; %para.mix; %qandaset.mix; %refcomponent.mix; %sidebar.mix; %tbl.table.excep; Description
An Equation is a formal mathematical equation (with an optional rather than required title).
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 Equations with Titles and Equations without Titles. 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, Glossary, GlossDef, GlossDiv, Important, Index, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, QandADiv, QandASet, Question, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, 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.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
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 V3.1//EN"> <equation><title>Fermat's Last Theorum</title> <alt>x^n + y^n ≠ z^n ∀ n ≠ 2</alt> <graphic fileref="figures/fermat"></graphic> </equation>Equation 1. Fermat's Last Theorum
For additional examples, see also InlineMediaObject.
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.