Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

OrderedList
Guide to the DocBook DTD
PrevNext

OrderedList

Name

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

Content Model

  ListItem+

Attributes

This element has common and Role attributes.

NameValue(s)TypeDefault Value
Continuation(Continues |Restarts) Restarts
InheritNum(Inherit |Ignore) Ignore
Numeration(Arabic |Upperalpha |Loweralpha |Upperroman |Lowerroman)#IMPLIED 
Spacing(Normal |Compact)#IMPLIED 

Tag Minimization

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

Description

Numbered or lettered list, consisting of ListItems. A ListItem in an OrderedList contains paragraphs and other block-oriented elements, which may in turn contain other lists; an OrderedList may be nested within other lists, too. OrderedList has common, Numeration, InheritNum, Continuation, and Spacing attributes.

Processing Expectations

If no value is supplied for the Numeration attribute, Arabic numbering (1, 2, 3, . . .) is to be used.

Parents

These elements contain OrderedList: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Dedication, Example, Footnote, GlossDef, GlossDiv, Glossary, Highlights, Important, Index, IndexDiv, InformalExample, LegalNotice, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning, entry.

Children

OrderedList contains ListItem.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Attributes

Numeration

Numeration specifies the style of numbering to be used for ListItems. The default is Arabic.

InheritNum

InheritNum specified for a nested list whether the numbering of ListItems should include the number of the ListItem within which they are nested (e.g., 1, 1.a, rather than 1, a); that is the value Inherit. Ignore, the default, indicates that the parent ListItem's number is not to be inherited.

Continuation

Continuation indicates whether list numbering should begin afresh (Restarts, the default) or continues that of the immediately preceding list (Continues). The default is Restarts.

Spacing

Spacing indicates whether the vertical space in the list should be compressed.

Examples

<ORDEREDLIST NUMERATION="Upperalpha">
<LISTITEM>
<PARA>This ListItem will be preceded by a capital A.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>And this one by a capital B.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>Use the Continuation attribute to continue a sequence
of ListItem numbering across OrderLists that are separated
by other text.
</PARA>
<ORDEREDLIST NUMERATION="Arabic">
<LISTITEM>
<PARA>This nested OrderedList will be numbered 1, 2, etc.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>No list should contain only one member, as a matter of
good style.
</PARA>
</LISTITEM>
</ORDEREDLIST>
</LISTITEM>
<LISTITEM>
<PARA>Don't forget that OrderedList has common attributes.
</PARA>
<ORDEREDLIST NUMERATION="Arabic" INHERITNUM="Inherit">
<LISTITEM>
<PARA>This nested OrderedList will be numbered B.1, B.2, etc.
</PARA>
</LISTITEM>
<LISTITEM>
<PARA>No list should contain only one member, as a matter of
good style.
</PARA>
</LISTITEM>
</ORDEREDLIST>
</LISTITEM>
</ORDEREDLIST>
PrevHomeNext
OptionalUpOrgDiv