glossary

DocBook 5.1: The Definitive Guide (Version 1.5.3 for DocBook 5.1)

glossary

glossary — A glossary.

Synopsis

glossary ::=

Sequence of:
- One of:
  - Sequence of:
    Interleave of:
    title?
    titleabbrev?
    subtitle?
    info? (db.titleforbidden.info)
  - info? (db.info)
- Zero or more of:
  - annotation
  - bridgehead
  - remark
  - revhistory
  - Indexing inlines
    indexterm (db.indexterm.endofrange)
    indexterm (db.indexterm.singular)
    indexterm (db.indexterm.startofrange)
  - Admonition elements
    caution
    important
    note
    tip
    warning
  - Formal elements
    equation
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
    screenshot
  - Informal elements
    informalequation
    informalexample
    informalfigure
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    bibliolist
    calloutlist
    glosslist
    itemizedlist
    orderedlist
    procedure
    qandaset
    segmentedlist
    simplelist
    variablelist
  - Paragraph elements
    anchor
    formalpara
    para
    simpara
  - Publishing elements
    address
    blockquote
    epigraph
    sidebar
  - Synopsis elements
    classsynopsis
    cmdsynopsis
    constructorsynopsis
    destructorsynopsis
    fieldsynopsis
    funcsynopsis
    methodsynopsis
  - Technical elements
    constraintdef
    msgset
    procedure
    productionset
    task
  - Verbatim elements
    literallayout
    programlisting
    programlistingco
    screen
    screenco
    synopsis
- One of:
  - Zero or more of:
    glossdiv
  - Zero or more of:
    glossentry
- bibliography?

Attributes

Common attributes and common linking attributes.

Additional attributes:

label
status

Additional Constraints

If this element is the root element, it must have a version attribute.

Description

A glossary contains a collection of terms and brief descriptions or definitions of those terms.

Processing expectations

Formatted as a displayed block. A glossary in a book frequently causes a forced page break in print media.

Attributes

Common attributes and common linking attributes.

label: Specifies an identifying string for presentation purposes
status: Identifies the editorial or publication status of the element on which it occurs

Parents

These elements contain glossary: appendix, article, book, chapter, part, preface, sect1, sect2, sect3, sect4, sect5, section, topic.

Children

The following elements occur in glossary: address, anchor, annotation, bibliography, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glossdiv, glossentry, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.info), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, subtitle, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, variablelist, warning.

Examples

<glossary xmlns='http://docbook.org/ns/docbook'>
<title>Example Glossary</title>

<para>This is not a real glossary, it's just an example.
</para>

<!-- ... -->

<glossdiv><title>E</title>

<glossentry xml:id="xml"><glossterm>Extensible Markup Language</glossterm>
  <acronym>XML</acronym>
<glossdef>
  <para>Some reasonable definition here.</para>
  <glossseealso otherterm="sgml">SGML</glossseealso>
</glossdef>
</glossentry>

</glossdiv>

<!-- ... -->

<glossdiv><title>S</title>

<glossentry><glossterm>SGML</glossterm>
<glosssee otherterm="sgml"/>
</glossentry>

<glossentry xml:id="sgml"><glossterm>Standard Generalized
  Markup Language</glossterm><acronym>SGML</acronym>
  <abbrev>ISO 8879:1986</abbrev>
<glossdef>
  <para>Some reasonable definition here.</para>
  <glossseealso otherterm="xml">XML</glossseealso>
</glossdef>
</glossentry>

</glossdiv>
</glossary>

This is not a real glossary, it's just an example.