segmentedlist
segmentedlist — A segmented list, a list of sets of elements.
Synopsis
segmentedlist ::=
Attributes
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A segmentedlist consists of a set of headings
(segtitles) and a list of parallel sets of elements.
Every seglistitem contains a set of elements that
have a one-to-one correspondence with the headings. Each of these
elements is contained in a seg.
Processing expectations
Segmented lists can be formatted in a number of ways. Two
popular formats are tabular and as a list of repeated headings and
elements. In a tabular presentation, the
segmentedlist is the table. In the list
presentation, the segmentedlist surrounds the
entire list of blocks of heading/element pairs.
Specifying the output format for lists is not part of the
normative definition of DocBook. However, the tabular and list formats
are supported in the open source DocBook stylesheets using the
list-presentation attribute on
the <?dbhtml> and <?dbfo> processing instructions. The examples on
this reference page show how to use these processing
instructions.
Parents
These elements contain segmentedlist: 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, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.
Children
The following elements occur in segmentedlist: info (db.titleforbidden.info), info (db.titleonly.info), seglistitem, segtitle, title, titleabbrev.
See Also
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example segmentedlist</title>
<para>The capitals of the states of the United States of America are:
<segmentedlist><title>State Capitals</title>
<?dbhtml list-presentation="list"?>
<?dbfo list-presentation="list"?>
<segtitle>State</segtitle>
<segtitle>Capital</segtitle>
<seglistitem><seg>Alabama</seg><seg>Montgomery</seg></seglistitem>
<seglistitem><seg>Alaska</seg><seg>Juneau</seg></seglistitem>
<seglistitem><seg>Arkansas</seg><seg>Little Rock</seg></seglistitem>
</segmentedlist>
…
</para>
</article>
The capitals of the states of the United States of America are:
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example segmentedlist</title>
<para><segmentedlist><title>State Capitals</title>
<?dbhtml list-presentation="table"?>
<?dbfo list-presentation="table"?>
<segtitle>State</segtitle>
<segtitle>Capital</segtitle>
<seglistitem><seg>Alabama</seg><seg>Montgomery</seg></seglistitem>
<seglistitem><seg>Alaska</seg><seg>Juneau</seg></seglistitem>
<seglistitem><seg>Arkansas</seg><seg>Little Rock</seg></seglistitem>
</segmentedlist>
…
</para>
</article>
| State | Capital |
|---|---|
| Alabama | Montgomery |
| Alaska | Juneau |
| Arkansas | Little Rock |