variablelist

variablelist — A list in which each entry is composed of a set of one or more terms and an associated description

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • spacing (enumeration)
    • “compact”
    • “normal”
  • termlength

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 deal with the problems presented in formatting a variable list with long Terms. DocBook does not mandate any particular presentation. The TermLength attribute may influence the presentation of Terms.

Attributes

Common attributes and common linking 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

FIXME:

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>

Font Filename Extensions

TTF

TrueType fonts.

PFA,
PFB

PostScript fonts. PFA files are common on UNIX systems, PFB files are more common on Windows systems.

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:58 $.