| DocBook: The Definitive Guide 2.0.17 (Alpha)

# segmentedlist

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

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

## Synopsis

### Content Model

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

### Attributes

Common attributes

## Description

A `SegmentedList` consists of a set of headings (`SegTitle`s) 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 `SegTitle`s 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`, `refsection`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `taskprerequisites`, `taskrelated`, `tasksummary`, `td`, `textobject`, `th`, `tip`, `warning`.

### Children

The following elements occur in segmentedlist: `seglistitem`, `segtitle`, `title`, `titleabbrev`.

## See Also

`calloutlist`, `itemizedlist`, `listitem`, `orderedlist`, `simplelist`, `variablelist`.

## 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>
    <?dbhtml 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>

    &hellip;
    </para>

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

State Capitals
State: Alabama
Capital: Montgomery
State: Alaska
Capital: Juneau
State: Arkansas
Capital: Little Rock
…

Alternatively:

    <!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <para>
    <segmentedlist><title>State Capitals</title>
    <?dbhtml list-presentation="table"?>
    <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>

State Capitals

State | Capital
--- | ---
Alabama | Montgomery
Alaska | Anchorage
Arkansas | Little Rock

…

seglistitem |  | segtitle

Copyright © 1999, 2000, 2001, 2002, 2003 O'Reilly & Associates, Inc. All rights reserved.