glosslist

glosslist — A wrapper for a list of glossary entries

Synopsis

glosslist ::=

Sequence of:
- Optionally one of:
  - Sequence of:
    
    Interleave of:
    
    title?
    
    titleabbrev?
    
    info? (db.titleforbidden.info)
  - info (db.titleonly.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
  - HTML Form elements
    
    html:form
  - 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 or more of:
  - glossentry

Attributes

Common attributes and common linking attributes.

Description

While glossarys are usually limited to component or section boundaries, appearing at the end of a book or chapter, for instance, glosslists can appear anywhere that the other list types are allowed.

Using a glosslist in running text, instead of a variablelist, for example, maintains the semantic distinction of a Glossary. This distinction may be necessary if you want to automatically point to the members of the list with glossterms in the body of the text.

Processing expectations

Formatted as a displayed block.

Parents

These elements contain glosslist: acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.

Children

The following elements occur in glosslist: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glossentry, glosslist, html:form, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.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, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, variablelist, warning.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example glosslist</title>

<glosslist>
<glossentry><glossterm>C</glossterm>
<glossdef>
<para>A procedural programming language invented by K&amp;R.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>Pascal</glossterm>
<glossdef>
<para>A procedural programming language invented by Niklaus Wirth.
</para>
</glossdef>
</glossentry>
</glosslist>

</article>

C: A procedural programming language invented by K&R.
Pascal: A procedural programming language invented by Niklaus Wirth.

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


glossentry		glosssee