docbook-apps

Currently equation elements are not handled consistently in the DocBook XSL
stylesheets. Part of the problem is that contrary to table and figure, an
equation's title is not required. Having the title be optional has created
the current inconsistencies. SourceForge bug report 2889817 describes the
current problems, and the comments in the report discuss the issues further.
If you are interested in how equation elements are displayed, you might want
to read the bug report:

http://sourceforge.net/tracker/?func=detail&aid=2889817&group_id=21935&atid=373747

One thing to note is that there is no standard style for equation numbers
and titles, although there are several common practices. The bug report
comments have somewhat settled on the following output features as the
default formatting for equations. I know it is impossible to satisfy
everyone, so we are looking for reasonable and consistent default behavior
here.


1. equation elements are numbered, and informalequation elements are not.

2. All equations use the same number sequence, regardless of whether they
include a title or not.

3. An equation with a title is formatted with "Equation 3.2. My equation
title", placed either above or below the equation, based on the existing
'formal.title.placement' parameter.

4. An equation without a title is formatted with the equation number in
parentheses, right-aligned next to the equation, something like this:

s = (a + b) x (c + d) (3.2)

5. The optional List of Equations in the front of a book includes only
equations with titles. Including equations without titles doesn't make much
sense, because the reader has no basis for selecting an equation based on
just the number. Since untitled equations are omitted, the number sequence
in the List of Equations may not be continuous.

6. An xref's generated text for a cross reference to an equation with title
looks like this by default:

Equation 3.2, "My equation title"

7. An xref's text for an equation without title looks like:

Equation 3.2

8. An xref to an informalequation generates nothing. Use equation without
title if you need to reference it.

Comments?

Bob Stayton
Sagehill Enterprises
bobs@sagehill.net

Bob

Could I suggest that there be some additional work here to enable some equation justification. I ran into some issues last year where it would have been good to be able to place the equation right/left/center justified and also have some control on how the equation number is rendered (Left just, right just, inside, outside) or is this in area of compromise that you were referring to?

Dean Nelson



In a message dated 11/27/09 20:51:45 Pacific Standard Time, bobs@sagehill.net writes:
4. An equation without a title is formatted with the equation number in
parentheses, right-aligned next to the equation, something like this:

s = (a + b) x (c + d) (3.2)

We need to be able to align specified equations on the equal sign
(sometimes with intervening text), but I expect that's way too much to
ask!

Dave Cramer

On Nov 29, 2009, at 12:48 AM, DeanNelson wrote:

> Bob
>
> Could I suggest that there be some additional work here to enable
> some equation justification. I ran into some issues last year where
> it would have been good to be able to place the equation right/left/
> center justified and also have some control on how the equation
> number is rendered (Left just, right just, inside, outside) or is
> this in area of compromise that you were referring to?
>
> Dean Nelson
>
>
>
> In a message dated 11/27/09 20:51:45 Pacific Standard Time, bobs@sagehill.net
> writes:
> 4. An equation without a title is formatted with the equation
> number in
> parentheses, right-aligned next to the equation, something like this:
>
> s = (a + b) x (c + d) (3.2)
>