glossary

glossary — A glossary.

Synopsis

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

The root element 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

This element occurs in 13 elements.

Children

This element contains 67 elements.

Examples

  1 <glossary xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example Glossary</title>
    
  4 <para>This is not a real glossary, it's just an example.
    </para>
  6 
    <!-- ... -->
  8 
    <glossdiv><title>E</title>
 10 
    <glossentry xml:id="xml"><glossterm>Extensible Markup Language</glossterm>
 12   <acronym>XML</acronym>
    <glossdef>
 14   <para>Some reasonable definition here.</para>
      <glossseealso otherterm="sgml">SGML</glossseealso>
 16 </glossdef>
    </glossentry>
 18 
    </glossdiv>
 20 
    <!-- ... -->
 22 
    <glossdiv><title>S</title>
 24 
    <glossentry><glossterm>SGML</glossterm>
 26 <glosssee otherterm="sgml"/>
    </glossentry>
 28 
    <glossentry xml:id="sgml"><glossterm>Standard Generalized
 30   Markup Language</glossterm><acronym>SGML</acronym>
      <abbrev>ISO 8879:1986</abbrev>
 32 <glossdef>
      <para>Some reasonable definition here.</para>
 34   <glossseealso otherterm="xml">XML</glossseealso>
    </glossdef>
 36 </glossentry>
    
 38 </glossdiv>
    </glossary>

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


function		glossdef