A.8. Lists

Preparing Cogent Documentation :
	Appendix A. Frequently Used DocBook Tags

List of elements

(grouped with their respective item types)

`<itemizedlist>`	A bulleted list.
`<orderedlist>`	A numbered (or lettered) list.
`<listitem>`	An item in an itemized or ordered list, or the definition in a variable list.
`<variablelist>`	A list of terms with corresponding descriptions or definitions.
`<varlistentry>`	An item in a variable list, consisting of a `<term>` and a `<listitem>` (the term's definition).
`<term>`	A term that is defined in a variable list.
`<simplelist>`	A basic list of single words or phrases (no paragraphs).
`<member>`	An item in a simple list.
`<procedure>`	A sequential list of procedural steps.
`<step>`	One step in a procedure.
`<substeps>`	A supplementary group of steps related to and performed within a procedural step.

Elements shown in context

<bridgehead renderas="sect3">An itemized list</bridgehead>
<itemizedlist>
  <listitem>
    <para>First item.</para>
  </listitem>
  <listitem>
    <para>Second item.</para>
  </listitem>
  <listitem>
    <para>Third item.</para>
  </listitem>
</itemizedlist>

<bridgehead renderas="sect3">An ordered list</bridgehead>
<orderedlist>
  <title>An ordered list</title>
  <listitem>
    <para>First item.</para>
  </listitem>
  <listitem>
    <para>Second item.</para>
  </listitem>
  <listitem>
    <para>Third item.</para>
  </listitem>
</orderedlist>

<variablelist>
  <title>A variable list</title>
  <varlistentry>
    <term>First term</term>
    <listitem>
      <para>Definition or explanation.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>Second term</term>
    <listitem>
      <para>Definition or explanation.</para>
    </listitem>
  </varlistentry>
</variablelist>

<bridgehead renderas="sect3">Here is a simple list:</bridgehead>
<simplelist>
  <member>First member</member>
  <member>Second member</member>
  <member>Third member</member>
</simplelist>

<procedure>
  <title>A procedure</title>
  <step>
    <para>Step 1.</para>
  </step>
  <step>
    <para>Step 2.</para>
    <substeps>
      <step>
        <para>Substep a.</para>
      </step>
      <step>
        <para>Substep b.</para>
      </step>
    </substeps>
  </step>
  <step>
    <para>Step 3.</para>
  </step>
</procedure>

Example output

An itemized list

First item.
Second item.
Third item.

An ordered list

First item.
Second item.
Third item.

A variable list

First term: Definition or explanation.
Second term: Definition or explanation.

Here is a simple list:

First member

Second member

Third member

Procedure A.1. A procedure

Step 1.
Step 2.
1. Substep a.
2. Substep b.
Step 3.


A.7. Admonitions		A.9. Tables