<refentry id="orderedlist.element">
<?dbhtml filename="orderedlist.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>orderedlist</secondary></indexterm>
<refentrytitle>orderedlist</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>orderedlist</refname>
<refpurpose>&orderedlist.purpose;</refpurpose>
</refnamediv>

&orderedlist.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

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

<refsect2><title>Processing expectations</title>
<para>
&format.block;
</para>
<para>
If no value is specified for <sgmltag class='attribute'>Numeration</sgmltag>,
Arabic numerals (1, 2, 3, &hellip;) are to be used.
</para>
<para>
In nested lists, DocBook does not specify the sequence of numerations.
</para>
<para>
Note that the attributes of <sgmltag>OrderedList</sgmltag> have a significant
influence on the processing expectations.
</para>
</refsect2>

<refsect2 role='fu' revision="5.0"><title>&FutureChanges;</title>
<para>Introductory material may appear before the first list item.
</para>
</refsect2>


&orderedlist.parents.gen;
&orderedlist.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>continuation</term>
<listitem>
<para>If <sgmltag class="attribute">continuation</sgmltag> is specified, it indicates 
how list numbering should begin relative to the immediately preceding 
list. <literal>Restarts</literal>, the default, indicates that numbering should
begin again at 1. <literal>Continues</literal> indicates that numbering should
begin where the preceding list left off.
</para>
</listitem>
</varlistentry>
<varlistentry><term>inheritnum</term>
<listitem>
<para>
In a nested list, <sgmltag class='attribute'>InheritNum</sgmltag> indicates whether
or not the enumeration of interior lists should include the numbers of 
containing list items. If <sgmltag class='attribute'>InheritNum</sgmltag> is 
<literal>Inherit</literal> 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 <quote>4.2.3</quote>. If it is <literal>Ignore</literal>, the default, then it would
be simply <quote>3</quote>. (The <sgmltag class='attribute'>Numeration</sgmltag> attribute
controls the actual format of the item numbers, of course.)
</para>
</listitem>
</varlistentry>
<varlistentry><term>numeration</term>
<listitem>
<para>
<sgmltag class="attribute">Numeration</sgmltag> specifies the style of numbering
to be used for items in the current <sgmltag>OrderedList</sgmltag>.
</para>
</listitem>
</varlistentry>
<varlistentry><term>spacing</term>
<listitem>
<para>
<sgmltag class="attribute">Spacing</sgmltag> indicates whether or not the
vertical space in the list should be minimized.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&orderedlist.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

<informalexample role="example-source">
<programlisting>&orderedlist.example.1.txt;</programlisting>
</informalexample>

<anchor id="ex.os.orderedlist.1" role="HACK-ex.out.start"/>
&orderedlist.example.1.gen;
<anchor id="ex.oe.orderedlist.1" role="HACK-ex.out.end"/>

&orderedlist.example.seealso.gen;
</refsect1>
</refentry>

