segmentedlist
Prev	DocBook Element Reference	Next

segmentedlist

Name

segmentedlist — A segmented list, a list of sets of elements

Synopsis

Content Model

segmentedlist ::=
((title,titleabbrev?)?,
 segtitle,segtitle+,seglistitem+)

Attributes

Common attributes

Parameter Entities

The following parameter entities contain segmentedlist:

Parameter Entities
`%admon.mix;`	`%bookcomponent.content;`	`%component.mix;`
`%divcomponent.mix;`	`%example.mix;`	`%footnote.mix;`
`%glossdef.mix;`	`%highlights.mix;`	`%legalnotice.mix;`
`%list.class;`	`%para.mix;`	`%qandaset.mix;`
`%refcomponent.mix;`	`%revdescription.mix;`	`%sidebar.mix;`
`%tabentry.mix;`	`%tbl.entry.mdl;`	`%textobject.mix;`

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.

Future Changes

In DocBook V4.0, at least two SegTitles will be required.

Parents

These elements contain segmentedlist: 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 segmentedlist: seglistitem, segtitle, title, titleabbrev.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The capitals of the states of the United States of America are:

<segmentedlist><title>State Capitals</title>
<segtitle>State</segtitle>
<segtitle>Capital</segtitle>
<seglistitem><seg>Alabama</seg><seg>Montgomery</seg></seglistitem>
<seglistitem><seg>Alaska</seg><seg>Anchorage</seg></seglistitem>
<seglistitem><seg>Arkansas</seg><seg>Little Rock</seg></seglistitem>
</segmentedlist>

&hellip;
</para>

The capitals of the states of the United States of America are:

State Capitals

State: Alabama

Capital: Montgomery

State: Alaska

Capital: Anchorage

State: Arkansas

Capital: Little Rock

…

Alternatively:

Table 2. State Capitals

State	Capital
Alabama	???
Alaska	Anchorage
Arkansas	Little Rock

…

Prev	Home	Next
seglistitem	Up	segtitle