DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

ItemizedList

Name

ItemizedList -- A list in which each entry is marked with a bullet or other dingbat

Synopsis

Content Model

ItemizedList ::=
(ListItem+)

Attributes

Common attributes

Name

Type

Default

Spacing

Enumeration:

Compact
Normal

None
MarkCDATANone

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%admon.mix;%bookcomponent.content;%component.mix;
%divcomponent.mix;%example.mix;%footnote.mix;
%glossdef.mix;%highlights.mix;%indexdivcomponent.mix;
%legalnotice.mix;%list.class;%para.mix;
%qandaset.mix;%refcomponent.mix;%sidebar.mix;
%tabentry.mix;%tbl.entry.mdl;%textobject.mix;

Description

In an ItemizedList, each member of the list is marked with a bullet, dash, or other symbol.

Processing expectations

Formatted as a displayed block.

DocBook specifies neither the initial mark nor the sequence of marks to be used in nested lists. If explicit control is desired, the Mark attribute should be used. The values of the Mark attribute are expected to be keywords, not representations (numerical character references, entities, and so on.) of the actual mark.

In order to enforce a standard set of marks at your organization, it may be useful to construct a customization layer that limits the values of the Mark attribute to an enumerated list. See Chapter 5, Customizing DocBook,.

Parents

These elements contain ItemizedList: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caption, Caution, Chapter, Colophon, 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, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, TextObject, Tip, Warning.

Children

The following elements occur in ItemizedList: ListItem.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Mark

Mark contains a keyword indicating the type of mark to be used on items in this ItemizedList. DocBook does not provide a fixed list of appropriate keywords.

Spacing

Spacing indicates whether or not the vertical space in the list should be minimized.

See Also

CalloutList, ListItem, OrderedList, SegmentedList, SimpleList, VariableList

Examples

<!DOCTYPE itemizedlist PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<itemizedlist mark=opencircle>
<listitem>
<para>
TeX and LaTeX
</para>
</listitem>
<listitem override=bullet>
<para>
Troff
</para>
</listitem>
<listitem>
<para>
Lout
</para>
</listitem>
</itemizedlist>

For additional examples, see also Highlights, Para, XRef.

PrevHomeNext
IssueNumUpITermSet

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.