simplelist
simplelist — An undecorated list of single words or short phrases
Synopsis
Content Model
simplelist ::=
(member+)
Attributes
Name | Type | Default | ||||
columns | CDATA | None | ||||
type |
| "vert" |
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:
InlineIndicates that the
Members of the list should be rendered as a comma separated, inline list.HorizIndicates that the
Members of the list should be rendered in a tabular fashion with members running across the rows.VertIndicates 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, constraintdef, 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, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, warning.
Attributes
columns
Columnsspecifies the number of columns to be used in the presentation of aSimpleListwith aTypeofVertorHoriz. IfColumnsis unspecified,1is assumed.type
Typespecifies how theMembers of theSimpleListare 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 XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Here is a <sgmltag>SimpleList</sgmltag>, rendered inline:
<simplelist type='inline'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>
Here is a SimpleList, rendered inline: A, B, C, D, E, F, G
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Here is the same <sgmltag>SimpleList</sgmltag> rendered horizontally with
three columns:
<simplelist type='horiz' columns='3'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>
Here is the same SimpleList rendered horizontally with three columns:
A | B | C |
D | E | F |
G |
|
|
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
Finally, here is the list rendered vertically:
<simplelist type='vert' columns='3'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>
Finally, here is the list rendered vertically:
A | D | G |
B | E |
|
C | F |
|