The Crash Course to DocBook

Chapter 6. Lists

DocBook lists are very similar to their counterparts in HTML except that DocBook contains several more types of lists for specialized purposes.

The tags covered in this chapter are listed below.

simplelist - List of single words or short phrases
member - Member of a simplelist
itemizedlist - List in which each entry is marked with a bullet, dash, or other dingbat
listitem - Wrapper for the elements of items in an itemizedlist or orderedlist
orderedlist - List in which each entry is marked with a sequentially incremented label
variablelist - List in which each entry is composed of sets of one or more terms with associated listitems
varlistentry - Wrapper for term and its associated listitem in a variablelist
term - Hanging term attached to a listitem within a varlistentry in a variablelist
segmentedlist - List of sets of information
segtitle - Title that pertains to one seg in each seglistitem
seglistitem - List item in a segmentedlist
seg - Component of a segmentedlist
qandaset - A question-and-answer set
qandaentry - A question/answer set within a qandaset
question - A question in a qandaset
answer - An answer to a question posed in a qandaset
procedure - List of operations to be performed
step - Part of a procedure
substeps - Wrapper for steps within steps

6.1. The simplelist

The easiest of all the lists to use is the simplelist. It is designed for lists of short phrases (like a grocery list) and only requires two tags for building the list as you can see in the example below. The <member> tag can only contain inline content, so a simplelist cannot contain other lists.

Example 6-1. A simplelist


<simplelist>
<member>Apples</member>
<member>Oranges</member>
<member>Bananas</member>
<member>Grapefruit</member>
<member>Black Beans</member>
</simplelist>

When converted, a simplelist will look something like this:

Apples
Oranges
Bananas
Grapefruit
Black Beans