glossary
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# glossary

## Name

glossary — A glossary

##

# Synopsis

### Content Model

    glossary ::=
    (glossaryinfo?,
     (title,subtitle?,titleabbrev?)?,
     (calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
      simplelist|variablelist|caution|important|note|tip|warning|
      literallayout|programlisting|programlistingco|screen|screenco|
      screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|
      fieldsynopsis|constructorsynopsis|destructorsynopsis|
      methodsynopsis|formalpara|para|simpara|address|blockquote|
      graphic|graphicco|mediaobject|mediaobjectco|informalequation|
      informalexample|informalfigure|informaltable|equation|example|
      figure|table|msgset|procedure|sidebar|qandaset|productionset|
      constraintdef|anchor|bridgehead|remark|highlights|abstract|
      authorblurb|epigraph|indexterm|beginpage)*,
     (glossdiv+|glossentry+),
     bibliography?)

### Attributes

Common attributes

Name | Type | Default
status | CDATA | None

### Parameter Entities

The following parameter entities contain glossary:

Parameter Entities
`%nav.class;` | `%partcontent.mix;` |

## 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.

### Parents

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

### Children

The following elements occur in glossary: `abstract`, `address`, `anchor`, `authorblurb`, `beginpage`, `bibliography`, `blockquote`, `bridgehead`, `calloutlist`, `caution`, `classsynopsis`, `cmdsynopsis`, `constraintdef`, `constructorsynopsis`, `destructorsynopsis`, `epigraph`, `equation`, `example`, `fieldsynopsis`, `figure`, `formalpara`, `funcsynopsis`, `glossaryinfo`, `glossdiv`, `glossentry`, `glosslist`, `graphic`, `graphicco`, `highlights`, `important`, `indexterm`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `itemizedlist`, `literallayout`, `mediaobject`, `mediaobjectco`, `methodsynopsis`, `msgset`, `note`, `orderedlist`, `para`, `procedure`, `productionset`, `programlisting`, `programlistingco`, `qandaset`, `remark`, `screen`, `screenco`, `screenshot`, `segmentedlist`, `sidebar`, `simpara`, `simplelist`, `subtitle`, `synopsis`, `table`, `tip`, `title`, `titleabbrev`, `variablelist`, `warning`.

## Attributes

status

  `Status` identifies the editorial or publication status of the `Glossary`.

  Publication status might be used to control formatting (for example, printing a ‘draft’ watermark on drafts) or processing (perhaps a document with a status of ‘final’ should not include any components that are not final).

## Examples

    <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <glossary><title>Example Glossary</title>
    <para>
    This is not a real glossary, it's just an example.
    </para>

    <!-- ... -->

    <glossdiv><title>E</title>

    <glossentry 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 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>

Prev | Home | Next
function | Up | glossaryinfo

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.