DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

SegmentedList

Name

SegmentedList -- A segmented list, a list of sets of elements

Synopsis

Content Model

SegmentedList ::=
((Title,TitleAbbrev?)?,
 SegTitle*,SegListItem+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

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

(4.0) 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, 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, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, TextObject, Tip, Warning.

Children

The following elements occur in SegmentedList: SegListItem, SegTitle, Title, TitleAbbrev.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

See Also

CalloutList, ItemizedList, ListItem, OrderedList, SimpleList, VariableList

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<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 1. State Capitals

StateCapital
Alabama???
AlaskaAnchorage
ArkansasLittle Rock

…

PrevHomeNext
SegListItemUpSegTitle

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.