    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
orderedlist — A list in which each entry is marked with a sequentially incremented label
orderedlist ::= ![[-]](graphics/down.gif)
![[+]](graphics/right.gif)
annotationbridgeheadremarkrevhistory
informalequationinformalexampleinformalfigureinformaltable (db.cals.informaltable)informaltable (db.html.informaltable)
Common attributes and common linking attributes.
Additional attributes:
In an orderedlist, each member of the list is marked with a numeral, letter, or other sequential symbol (such as roman numerals).
Formatted as a displayed block.
The numeration attribute indicates the desired numeration. If it is not specified, Arabic numerals (1, 2, 3, …) are to be used.
The actually characters used in alphabetic numeration may be locale sensitive. Where the sequence “a”, “b”, “c” might be selected in an English locale, “ア”, “イ”, “ウ” might be selected if Katakana was implied by the current locale.
The continuation attribute indicates how numbering should begin relative to the immediately preceding list. If it is not specified, numbering is to be restarted at 1.
The preceding list is not required to be in the same parent. That is, a list in one chapter may be continued in the next, or indeed arbitrarily later in the document, provided no other list intervenes.
The inheritnum attribute indicates how items in nested lists should be numbered. If it is not specified, numbering is to ignore list nesting. Inherited numeration creates compound list item numbers.
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 inheritnum is “ignore”, then it would be simply “3”. (With the numeration attribute handling the actual format of the numbers.)
In nested lists, some publishers prefer to use Arabic numbers throughout (4.3.2) while others prefer to step through a sequence of numerations (4.b.iii). DocBook does not specify the sequence of numerations.
Common attributes and common linking attributes.
Indicates how list numbering should begin relative to the immediately preceding list
| Enumerated values: | |
|---|---|
| “continues” |
Specifies that numbering should begin where the preceding list left off |
| “restarts” |
Specifies that numbering should begin again at 1 |
Indicates whether or not item numbering should be influenced by list nesting
| Enumerated values: | |
|---|---|
| “ignore” |
Specifies that numbering should ignore list nesting |
| “inherit” |
Specifies that numbering should inherit from outer-level lists |
Indicates the desired numeration
| Enumerated values: | |
|---|---|
| “arabic” |
Specifies Arabic numeration (1, 2, 3, …) |
| “upperalpha” |
Specifies upper-case alphabetic numeration (A, B, C, …) |
| “loweralpha” |
Specifies lower-case alphabetic numeration (a, b, c, …) |
| “upperroman” |
Specifies upper-case Roman numeration (I, II, III, …) |
| “lowerroman” |
Specifies lower-case Roman numeration (i, ii, iii …) |
Specifies (a hint about) the spacing of the content
| Enumerated values: | |
|---|---|
| “compact” |
The spacing should be "compact". |
| “normal” |
The spacing should be "normal". |
Specifies the initial line number.
These elements contain orderedlist: acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist,
caption (db.caption), caution, chapter, colophon, constraintdef, cover, dedication, entry, example, figure, footnote, glossary, glossdef,
glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.
The following elements occur in orderedlist: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, html:form, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, listitem, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, variablelist, warning.
<article xmlns='http://docbook.org/ns/docbook'> <title>Example orderedlist</title> <orderedlist numeration="lowerroman"> <listitem> <para>One</para> </listitem> <listitem> <para>Two</para> </listitem> <listitem> <para>Three</para> </listitem> <listitem> <para>Four</para> </listitem> </orderedlist> </article>
One
Two
Three
Four
| |
|
|
| optional | |
org |