DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

OrderedList

Name

OrderedList -- A list in which each entry is marked with a sequentially incremented label

Synopsis

Content Model

OrderedList ::=
(ListItem+)

Attributes

Common attributes

Name	Type	Default
Numeration	Enumeration: Arabic Loweralpha Lowerroman Upperalpha Upperroman	None
InheritNum	Enumeration: Ignore Inherit	"Ignore"
Spacing	Enumeration: Compact Normal	None
Continuation	Enumeration: Continues Restarts	"Restarts"

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%admon.mix;	%bookcomponent.content;	%component.mix;
%divcomponent.mix;	%example.mix;	%footnote.mix;
%glossdef.mix;	%highlights.mix;	%indexdivcomponent.mix;
%legalnotice.mix;	%list.class;	%para.mix;
%qandaset.mix;	%refcomponent.mix;	%sidebar.mix;
%tabentry.mix;	%tbl.entry.mdl;	%textobject.mix;

Description

In an OrderedList, each member of the list is marked with a numeral, letter, or other sequential symbol (such as roman numerals).

Processing expectations

Formatted as a displayed block.

If no value is specified for Numeration, Arabic numerals (1, 2, 3, …) are to be used.

In nested lists, DocBook does not specify the sequence of numerations.

Note that the attributes of OrderedList have a significant influence on the processing expectations.

Parents

These elements contain OrderedList: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caption, Caution, Chapter, Colophon, Dedication, entry, Example, Footnote, Glossary, GlossDef, GlossDiv, Highlights, Important, Index, IndexDiv, InformalExample, LegalNotice, 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, TextObject, Tip, Warning.

Children

The following elements occur in OrderedList: ListItem.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Continuation

If Continuation is specified, it indicates how list numbering should begin relative to the immediately preceding list. Restarts, the default, indicates that numbering should begin again at 1. Continues indicates that numbering should begin where the preceding list left off.

InheritNum

In a nested list, InheritNum indicates whether or not the enumeration of interior lists should include the numbers of containing list items. If InheritNum is Inherit then the third item of a list inside the second item of a list inside the fourth item of a list might be enumerated as "4.2.3". If it is Ignore, the default, then it would be simply "3". (The Numeration attribute controls the actual format of the item numbers, of course.)

Numeration

Numeration specifies the style of numbering to be used for items in the current OrderedList.

Spacing

Spacing indicates whether or not the vertical space in the list should be minimized.

See Also

CalloutList, ItemizedList, ListItem, SegmentedList, SimpleList, VariableList

Examples

<!DOCTYPE orderedlist PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<orderedlist numeration="lowerroman">
<listitem>
<para>One</para>
</listitem>
<listitem>
<para>Two</para>
</listitem>
<listitem>
<para>Three</para>
</listitem>
<listitem>
<para>Four</para>
</listitem>
</orderedlist>

1. One

2. Two

3. Three

4. Four

---

Prev	Home	Next
Optional	Up	OrgDiv

Back to: DocBook: The Definitive Guide