DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

SimpleList

Name

SimpleList -- An undecorated list of single words or short phrases

Synopsis

Content Model

SimpleList ::=
(Member+)

Attributes

Common attributes

Name

Type

Default

ColumnsNUMBERNone
Type

Enumeration:

Horiz
Inline
Vert

"Vert"

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

A SimpleList is a list of words or phrases. It offers a convenient alternative to the other list elements for inline content.

Processing expectations

Ironically, the processing expectations of a SimpleList are quite complex.

The presentation of a SimpleList is controlled by the Type attribute, which has three possible values:

Inline

Indicates that the Members of the list should be rendered as a comma separated, inline list.

Horiz

Indicates that the Members of the list should be rendered in a tabular fashion with members running across the rows.

Vert

Indicates that the Members of the list should be rendered in a tabular fashion with members running down the columns. This is the default.

In both of the tabular cases, the number of columns in the table is controlled by the Columns attribute.

Parents

These elements contain SimpleList: 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 SimpleList: Member.

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

Attributes

Columns

Columns specifies the number of columns to be used in the presentation of a SimpleList with a Type of Vert or Horiz. If Columns is unspecified, 1 is assumed.

Type

Type specifies how the Members of the SimpleList are to be formatted. (This attribute would better fit DocBook semantics if it were named "Class").

See Also

CalloutList, ItemizedList, ListItem, OrderedList, SegmentedList, VariableList

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
Here is a <sgmltag>SimpleList</>, rendered inline: 
<simplelist type=inline>
<member>A</>
<member>B</>
<member>C</>
<member>D</>
<member>E</>
<member>F</>
<member>G</>
</simplelist>
</para>

Here is a SimpleList, rendered inline: A, B, C, D, E, F, G

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
Here is the same <sgmltag>SimpleList</> rendered horizontally with 
three columns:
<simplelist type=horiz columns=3>
<member>A</>
<member>B</>
<member>C</>
<member>D</>
<member>E</>
<member>F</>
<member>G</>
</simplelist>
</para>

Here is the same SimpleList rendered horizontally with three columns:

ABC
DEF
G  

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
Finally, here is the list rendered vertically:
<simplelist type=vert columns=3>
<member>A</>
<member>B</>
<member>C</>
<member>D</>
<member>E</>
<member>F</>
<member>G</>
</simplelist>
</para>

Finally, here is the list rendered vertically:

ADG
BE 
CF 

PrevHomeNext
SimParaUpSimpleSect

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