orderedlist
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# orderedlist

## Name

orderedlist — A list in which each entry is marked with a sequentially incremented label

##

# Synopsis

### Content Model

    orderedlist ::=
    ((title,titleabbrev?)?,
     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"

### Parameter Entities

The following parameter entities contain orderedlist:

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;` | `%revdescription.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.

### Future Changes

Introductory material may appear before the first list item.

### Parents

These elements contain orderedlist: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caption`, `caution`, `chapter`, `colophon`, `constraintdef`, `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`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `textobject`, `tip`, `warning`.

### Children

The following elements occur in orderedlist: `listitem`, `title`, `titleabbrev`.

## 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 XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <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

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.