DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

GlossList

Name

GlossList -- A wrapper for a set of GlossEntrys

Synopsis

Content Model

GlossList ::=
(GlossEntry+)

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

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

Description

While Glossarys are usually limited to component or section boundaries, appearing at the end of a Book or Chapter, for instance, GlossLists can appear anywhere that the other list types are allowed.

Using a GlossList in running text, instead of a VariableList, for example, maintains the semantic distinction of a Glossary. This distinction may be necessary if you want to automatically point to the members of the list with GlossTerms in the body of the text.

Processing expectations

Formatted as a displayed block.

Parents

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

Children

The following elements occur in GlossList: GlossEntry.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Examples

<!DOCTYPE glosslist PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<glosslist>
<glossentry><glossterm>C</glossterm>
<glossdef>
<para>
A procedural programming language invented by K&amp;R.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Pascal</glossterm>
<glossdef>
<para>
A procedural programming language invented by Niklaus Wirth.
</para>
</glossdef>
</glossentry>
</glosslist>
C

A procedural programming language invented by K&R.

Pascal

A procedural programming language invented by Niklaus Wirth.

PrevHomeNext
GlossEntryUpGlossSee

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.