variablelist
variablelist — A list in which each entry is composed of a set of one or more terms and an associated description.
Synopsis
- Sequence of:
- One of:
- Zero or more of:
- Sequence of:
- empty
- empty
- Sequence of:
revhistoryspeakernotes- Formal elements
![[+]](figs/web/nav/right.gif)
- Graphic elements
![[+]](figs/web/nav/right.gif)
- Informal elements
![[+]](figs/web/nav/right.gif)
- List elements
![[+]](figs/web/nav/right.gif)
- Paragraph elements
![[+]](figs/web/nav/right.gif)
- Publishing elements
![[+]](figs/web/nav/right.gif)
- Verbatim elements
![[+]](figs/web/nav/right.gif)
- One or more of:
- One of:
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 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
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
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
These elements contain variablelist: bibliodiv, bibliography, blockquote, caption (db.caption), entry, example, figure, foil, foilgroup, footnote, itemizedlist, legalnotice, listitem, note, orderedlist, para, revdescription, section, sidebar, slides, speakernotes, td, textobject, th, variablelist.
Children
The following elements occur in variablelist: blockquote, epigraph, example, figure, info (db.titleforbidden.info), info (db.titleonly.info), informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, note, orderedlist, para, programlisting, revhistory, sidebar, speakernotes, table (db.cals.table), table (db.html.table), title, titleabbrev, variablelist, varlistentry.
See Also
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.
![[x]](figs/web/nav/delete.gif)
![[-]](figs/web/nav/down.gif)