<itemizedlist> (
Itemized List)
Description
Description
This element contains a list of items that each have a prefix of some kind to separate them clearly. Itemized lists should be used in preference to simple lists when at least one of the items contains multiple paragraphs, in order to make it clear that subsequent paragraphs are not separate list items:
<itemizedlist listitemlabel="-">
<listitem><para>item one</para></listitem>
<listitem>
<para>item two</para>
<para>more in item two</para>
</listitem>
<listitem><para>item three</para></listitem>
</itemizedlist>
- item one
- item two
more in item two
- item three
Note that there must be at least two list items, whereas the
<simplelist> element allows for a single unlabelled list item. However, this element can have an optional leading title, whereas the simpler list type cannot.
Parent Elements
The elements listed below may directly contain this element.
They are "parent" elements. Elements in referenced groups are included, up to two levels of group nesting.
Model Diagram
The DTD model for this element:
--+(sequence)
|
listtitle (optional) -- (TEXT and elements)
|
listitem (repeatable) -- (elements)
DTD Definition
The DTD contains the following element and attribute definitions
(note that embedded links are to definitions within the DTD page of this guide):
<!ELEMENT itemizedlist (listtitle?, listitem+)>
<!ATTLIST itemizedlist
listitemlabel CDATA #IMPLIED
spacing (normal | compact) #IMPLIED
%a-group-CommonIDAttrs;>
.
Defined in DTD section
Block-level Content : Lists
General Attributes (shared with other elements)
Local Attributes (defined for this element alone)
Description
This attribute specifies which symbol to show at the start of each list item. In most cases, the character itself is used as the value, such as "-" or "*":
<itemizedlist listitemlabel="*">
<listitem><para>item one</para></listitem>
<listitem>
<para>item two</para>
<para>more in item two</para>
</listitem>
<listitem><para>item three</para></listitem>
</itemizedlist>
* item one
* item two
more in item two
* item three
But there is one exception: the value "bull" represents a bullet symbol.
Specification
This attribute is not required. It has text content.
DTD Definition
listitemlabel CDATA #IMPLIED
.
Description
This attribute can be used to specify that the list items should be "compact" (instead of the implied default value of "normal"):
<itemizedlist spacing="normal">
<listitem><para>Item One</para></listitem>
<listitem><para>Item Two</para></listitem>
<listitem><para>Item Three</para></listitem>
</itemizedlist>
- Item One
- Item Two
- Item Three
<itemizedlist spacing="compact">
<listitem><para>Item One</para></listitem>
<listitem><para>Item Two</para></listitem>
<listitem><para>Item Three</para></listitem>
</itemizedlist>
- Item One
- Item Two
- Item Three
Specification
This attribute is not required. The allowed values are "normal" and "compact".
DTD Definition
spacing (normal | compact) #IMPLIED
.