DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
PrevNext

Name

Glossary -- A glossary

Synopsis

Content Model

Glossary ::= ((DocInfo?,Title,Subtitle?,TitleAbbrev?)?,  (CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|   SimpleList|VariableList|Caution|Important|Note|Tip|Warning|   LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|   ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|   SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|   MediaObjectCO|InformalEquation|InformalExample|InformalFigure|   InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|   Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract|   AuthorBlurb|Epigraph|IndexTerm)*,  (GlossDiv+|GlossEntry+),  Bibliography?)

Attributes

Common attributes

Name

Type

Default

StatusCDATANone

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

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: Article, Book, Chapter, Part, Sect1, Sect2, Sect3, Sect4, Sect5, Section.

Children

The following elements occur in Glossary: Abstract, Address, Anchor, AuthorBlurb, Bibliography, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossDiv, GlossEntry, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

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 V3.1//EN"> <glossary><title>Example Glossary</title> <para> This is not a real glossary, it's just an example. </para> <!-- ... --> <glossdiv><title>E</title> <glossentry ><glossterm>Extensible Markup Language</glossterm>   <acronym>XML</acronym> <glossdef>   <para>Some reasonable definition here.</para>   <glossseealso otherterm="sgml"> </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"> </glossdef> </glossentry> </glossdiv> </glossary>


PrevHomeNext
FunctionUpGlossDef

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net