Writing documentation with DocBook-XML 4.3 |  |
Writing documentation with DocBook-XML 4.3 | |
To produce a numbered list of items, use the orderedlist element. Here's an example:
DocBook renders documents in both print and Web form.
It frees the author from most concerns of presentation.
Here's how the above list looks in source form:
<orderedlist>
<listitem>
<para>
DocBook renders documents in both print and Web form.
</para>
</listitem>
<listitem>
<para>
It frees the author from most concerns of presentation.
</para>
</listitem>
</orderedlist>
There are a number of attributes you can add to the orderedlist element to change the way the
entries are numbered.
numeration
The default value is
numeration="arabic", with entries
numbered 1., 2., 3., …. Other possible
values include:
numeration="loweralpha" for a.,
b., …
numeration="lowerroman" for i., ii., iii., …
numeration="upperalpha" for A., B., C., …
numeration="upperroman" for I., II., III., …
inheritnum="inherit"
Normally, when you use an ordered list inside
another ordered list, the inner list has its own
numbering. However, if you specify
inheritnum="inherit", each item number
in the inner list will have the item number from
the next outer list prepended to it.
For example, if an inner list is under an
outer-list item numbered 17, and the inner list had
the inheritnum="inherit"
attribute, its items would be numbered 17.1, 17.2,
17.3, ….
spacing="compact"
Normally the items of an ordered list are separated
by generous amounts of space. Use the
spacing="compact" attribute to squeeze
out most of the space between the items.
continuation="continues"
Sometimes you have to break an ordered list into multiple pieces, with text paragraphs or other material between the pieces. This attribute allows you to start the numbering of a new list where the old one left off.
For example, suppose the first chunk of an ordered list ended with item XIV, and another ordered list followed it, starting with:
<orderedlist numeration="upperroman" continuation="continues">
That second list would start with item XV.