variablelist
variablelist — A list in which each entry is composed of a set of one or more terms and an associated description.
Synopsis
variablelist ::= × ⏵
- Sequence of:
- One of:
- Zero or more of:
bridgehead
dialogue
drama
formalgroup
poetry
remark
revhistory
stagedir
- Indexing inlines ⏵
- Admonition elements ⏵
- Formal elements ⏵
- Graphic elements ⏵
- Informal elements ⏵
- List elements ⏵
- Paragraph elements ⏵
- Publishing elements ⏵
- Technical elements ⏵
- Verbatim elements ⏵
- One or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- spacing (enumeration)
- “compact”
- “normal”
- termlength
Description
A variablelist
is a list consisting of
term
s 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 term
s. 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.
- any attribute
Any attribute in any other explicit namespace
- 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
62 elements contain variablelist
. × ⏵
Children
50 elements occur in variablelist
. × ⏵
See Also
Related elements: calloutlist
, itemizedlist
, listitem
, orderedlist
, simplelist
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example variablelist</title>
||
<variablelist><title>Font Filename Extensions</title>
5 |<varlistentry>
|<term><filename>TTF</filename></term>
|<listitem>
|<para>TrueType fonts.</para>
|</listitem>
10 |</varlistentry>
|<varlistentry>
|<term><filename>PFA</filename></term>
|<term><filename>PFB</filename></term>
|<listitem>
15 |<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>
20 |</listitem>
|</varlistentry>
|</variablelist>
||
</article>
TTF
TrueType fonts.
PFA
,PFB
PostScript fonts.
PFA
files are common on UNIX systems,PFB
files are more common on Windows systems.