variablelist
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# variablelist

## Name

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

##

# Synopsis

### Content Model

    variablelist ::=
    ((title,titleabbrev?)?,
     varlistentry+)

### Attributes

Common attributes

Name | Type | Default
termlength | CDATA | None

### Parameter Entities

The following parameter entities contain variablelist:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%example.mix;` | `%footnote.mix;`
`%glossdef.mix;` | `%highlights.mix;` | `%indexdivcomponent.mix;`
`%legalnotice.mix;` | `%list.class;` | `%para.mix;`
`%qandaset.mix;` | `%refcomponent.mix;` | `%revdescription.mix;`
`%sidebar.mix;` | `%tabentry.mix;` | `%tbl.entry.mdl;`
`%textobject.mix;` |  |

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

### Future Changes

Introductory material may appear before the first list item.

### Parents

These elements contain variablelist: `answer`, `appendix`, `article`, `bibliodiv`, `bibliography`, `blockquote`, `callout`, `caption`, `caution`, `chapter`, `colophon`, `constraintdef`, `dedication`, `entry`, `example`, `footnote`, `glossary`, `glossdef`, `glossdiv`, `highlights`, `important`, `index`, `indexdiv`, `informalexample`, `legalnotice`, `listitem`, `msgexplan`, `msgtext`, `note`, `para`, `partintro`, `preface`, `procedure`, `qandadiv`, `qandaset`, `question`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `revdescription`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `setindex`, `sidebar`, `simplesect`, `step`, `textobject`, `tip`, `warning`.

### Children

The following elements occur in variablelist: `title`, `titleabbrev`, `varlistentry`.

## Attributes

termlength

  `TermLength` indicates a length beyond which the presentation engine may consider the `Term`(s) too long and select an alternate presentation of the `Term`(s) and/or, the associated `ListItem`.

## See Also

`calloutlist`, `itemizedlist`, `listitem`, `orderedlist`, `segmentedlist`, `simplelist`.

## Examples

    <!DOCTYPE variablelist PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <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>

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.

For additional examples, see also `refentry` .

Prev | Home | Next
varargs | Up | varlistentry

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.