glossary

glossary — A glossary.

Synopsis

glossary ::=

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.

any attribute

Any attribute in any other explicit namespace

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, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, 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, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, 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, typedefsynopsis, unionsynopsis, variablelist, warning.

Examples

 1 |<glossary xmlns='http://docbook.org/ns/docbook'>
   |<title>Example Glossary</title>
   | 
   |<para>This is not a real glossary, it's just an example.
 5 |</para>
   | 
   |<!-- ... -->
   | 
   |<glossdiv><title>E</title>
10 | 
   |<glossentry xml:id="xml"><glossterm>Extensible Markup Language</glossterm>
   |  <acronym>XML</acronym>
   |<glossdef>
   |  <para>Some reasonable definition here.</para>
15 |  <glossseealso otherterm="sgml">SGML</glossseealso>
   |</glossdef>
   |</glossentry>
   | 
   |</glossdiv>
20 | 
   |<!-- ... -->
   | 
   |<glossdiv><title>S</title>
   | 
25 |<glossentry><glossterm>SGML</glossterm>
   |<glosssee otherterm="sgml"/>
   |</glossentry>
   | 
   |<glossentry xml:id="sgml"><glossterm>Standard Generalized
30 |  Markup Language</glossterm><acronym>SGML</acronym>
   |  <abbrev>ISO 8879:1986</abbrev>
   |<glossdef>
   |  <para>Some reasonable definition here.</para>
   |  <glossseealso otherterm="xml">XML</glossseealso>
35 |</glossdef>
   |</glossentry>
   | 
   |</glossdiv>
   |</glossary>

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