glossary

DocBook Publishers: The Definitive Guide (Version 1.2.1 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:
  - bridgehead
  - dialogue
  - drama
  - poetry
  - remark
  - revhistory
  - Indexing inlines
    indexterm (db.indexterm.endofrange)
    indexterm (db.indexterm.singular)
    indexterm (db.indexterm.startofrange)
  - Admonition elements
    note
  - Formal elements
    equation
    example
    figure
    table
  - Graphic elements
    mediaobject
  - Informal elements
    informalequation
    informalexample
    informalfigure
    informaltable
  - List elements
    bibliolist
    calloutlist
    glosslist
    itemizedlist
    orderedlist
    procedure
    qandaset
    simplelist
    variablelist
  - Paragraph elements
    anchor
    formalpara
    para
    simpara
  - Publishing elements
    address
    blockquote
    epigraph
    sidebar
  - Technical elements
    procedure
    task
  - Verbatim elements
    literallayout
- 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, section.

Children

The following elements occur in glossary: address, anchor, bibliography, bibliolist, blockquote, bridgehead, calloutlist, dialogue, drama, epigraph, equation, example, figure, formalpara, glossdiv, glossentry, glosslist, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.info), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, subtitle, table, task, title, titleabbrev, variablelist.

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.