[Prev] [Next]

VariableList

Name

Synopsis

  ((Title, TitleAbbrev?)?, VarListEntry+)

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
TermLength	CDATA	#IMPLIED

Tag Minimization

Both the start- and end-tags are required for this element.

Description

List in which each entry is composed of VarListEntries, which are sets of one or more Terms with associated ListItems. ListItems contain paragraphs and other block-oriented elements in any order. Inclusions are as for OrderedList (see OrderedList). VariableList has TermLength and common attributes.

Parents

These elements contain VariableList: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Dedication, Example, Footnote, GlossDef, GlossDiv, Glossary, Highlights, Important, Index, IndexDiv, InformalExample, LegalNotice, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning, and entry.

Children

VariableList contains these elements: Title, TitleAbbrev, and VarListEntry.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Attributes

TermLength

TermLength sets the length of the tem beyond which the presentation engine may consider the Term too long and select an alternate presentation of the Term and, or, its associated ListItem.

Examples

<VARIABLELIST>
<VARLISTENTRY>
<TERM>Window
</TERM>
<LISTITEM>
<PARA>A unique integer identifier (ID) that is
returned by XCreateWindow or XCreateSimpleWindow and is
thereafter used by the program to refer to the created
window resource.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>Display
</TERM>
<TERM>XOpenDisplay
</TERM>
<LISTITEM>
<PARA>A large structure that contains information
about the server and its screens.  It is filled only after
this program connects to a server by calling XOpenDisplay.
</PARA>
<PARA>A small structure containing information about
the server and its screens would be more economical, but we
mention it only to generate another paragraph.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</VARIABLELIST>

[Prev] VarArgs
[Next] VarListEntry
[Reference Home] [Davenport Group Home]