DocBook 5: The Definitive Guide

Name

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

Synopsis

segmentedlist ::= ((((title? & titleabbrev?), info? ^{db.titleforbidden.info}) | info ^{db.titleonly.info}), segtitle+, seglistitem+)

Attribute synopsis

Common attributes and common linking attributes.

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.

See Also

calloutlist, itemizedlist, listitem, orderedlist, simplelist, variablelist

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"?> ...