variablelist
variablelist — A list in which each entry is composed of a set of one or more terms and an associated description.
Synopsis
variablelist ::= ![[-]](figs/web/nav/down.gif)
- Sequence of:
- One of:
- Zero or more of:
annotationbridgeheadremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One or more of:
- One of:
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A variablelist is a list consisting of
terms and their definitions or descriptions.
Processing expectations
Formatted as a displayed block.
There are many ways to present a variable list. DocBook does not
mandate any particular presentation. The termlength attribute may influence the
presentation of terms. The termlength attribute is often specified as
a number of characters, but other forms are possible. This is an interchange issue.
Attributes
- spacing
Specifies (a hint about) the spacing of the content
Enumerated values: “compact” The spacing should be "compact".
“normal” The spacing should be "normal".
- termlength
Indicates a length beyond which the presentation system may consider a term too long and select an alternate presentation for that term, item, or list
Parents ![[+]](figs/web/nav/right.gif)
Children
See Also
calloutlist, itemizedlist, listitem, orderedlist, segmentedlist, simplelist
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example variablelist</title>
<variablelist><title>Font Filename Extensions</title>
<varlistentry>
<term><filename>TTF</filename></term>
<listitem>
<para>TrueType fonts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>PFA</filename></term>
<term><filename>PFB</filename></term>
<listitem>
<para>
PostScript fonts. <filename>PFA</filename> files are common
on <acronym>UNIX</acronym> systems, <filename>PFB</filename>
files are more common on Windows systems.
</para>
</listitem>
</varlistentry>
</variablelist>
</article>
TTFTrueType fonts.
PFA,PFBPostScript fonts.
PFAfiles are common on UNIX systems,PFBfiles are more common on Windows systems.