Name
variablelist — A list in which each entry is composed of a set of one or more terms and an associated description
Synopsis
variablelist ::=
((((title? &
titleabbrev?),
info? db.titleforbidden.info) |
info db.titleonly.info),
(annotation | bridgehead |
remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)*,
varlistentry+)
Attribute synopsis
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 selects an alternate presentation for that term, item, or list
See Also
calloutlist, itemizedlist ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
