Writing documentation with DocBook-XML 4.3 |  |
Writing documentation with DocBook-XML 4.3 | |
You can include mathematical formulae written in TeX and LaTeX in your document. Here is an example:
There are some limitations:
The technique works best for equations displayed as a block element, interrupting any text paragraph.
Each displayed equation must be placed in a separate file. For hints on writing these files, see Section 12.1, “Preparing a formula with LaTeX” or Section 12.2, “Preparing a formula with TeX”.
Displayed equations are set flush to the left margin. The best workaround for this is to number your equations on the left; this will center the math part of the line.
You can include bits of math as inline elements within a paragraph; see Section 12.5, “Simple inline math” and Section 12.6, “Inline math using LaTeX or TeX”.
The procedure is somewhat involved; see Section 12.3, “Processing your math files for inclusion”. However, adding a few
rules to your Makefile automates
the entire procedure: see Section 12.4, “Automating math display production with your Makefile”.
To use a LaTeX displayed formula, the formula must reside in a separate file, and you must follow a specific structure. Here is the LaTeX source file for the example in Section 12, “Including TeX and LaTeX math”.
% lamath.tex: Sample of LaTeX math for inclusion in DocBook
%
\documentclass[leqno]{article}
\pagestyle{empty}
\setlength{\textwidth}{6in}
\begin{document}
\setcounter{equation}{13}
\begin{equation}
\int \tanh^{-1}{x\over a}dx =
x \tanh^{-1}{x\over a}+{a\over 2}\log(a^2-x^2),\qquad
\left(\left| x\over a \right| < 1\right)
\end{equation}
\end{document}
The option [leqno] instructs LaTeX
to place equation numbers on the left side.
The conversion process selects everything on the page
and puts it into a rectangular box. Hence, a page
number would force the box to be page-sized. The
\pagestyle{empty} command suppresses
page numbering.
The line \setlength{\textwidth}{6in
sets the width of the text column to six inches,
which matches the text column width in the PDF
output from DocBook.
Use a line \setcounter{equation}{ to set the equation number
to one less than the desired equation number. A
value of 13 here will number the equation as (14).
N}
Place the equation in a \begin{equation}…\end{equation}
environment so that the equation will be numbered.
The math itself is expressed using the usual LaTeX conventions.