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
Prev		Next

GlossDef

Name

GlossDef -- A definition in a GlossEntry

Synopsis

Content Model

GlossDef ::= ((CalloutListGlossListItemizedListOrderedListSegmentedList SimpleListVariableListLiteralLayoutProgramListing ProgramListingCOScreenScreenCOScreenShotSynopsis CmdSynopsisFuncSynopsisFormalParaParaSimParaAddress BlockQuoteGraphicGraphicCOMediaObjectMediaObjectCO InformalEquationInformalExampleInformalFigureInformalTable EquationExampleFigureTableCommentIndexTerm)+, GlossSeeAlso*)

Attributes

Common attributes

Name	Type	Default
Subject	CDATA	None

Tag Minimization

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

Description

A GlossDef contains the description or definition of a GlossTerm .

Processing expectations

Formatted as a displayed block.

Future Changes

The Subject attribute will be renamed Keywords in DocBook V4.0 .

Parents

These elements contain GlossDef: GlossEntry .

Children

The following elements occur in GlossDef: Address , BlockQuote , CalloutList , CmdSynopsis , Comment , Equation , Example , Figure , FormalPara , FuncSynopsis , GlossList , GlossSeeAlso , Graphic , GraphicCO , IndexTerm , InformalEquation , InformalExample , InformalFigure , InformalTable , ItemizedList , LiteralLayout , MediaObject , MediaObjectCO , OrderedList , Para , ProgramListing , ProgramListingCO , Screen , ScreenCO , ScreenShot , SegmentedList , SimPara , SimpleList , Synopsis , Table , VariableList .

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

In some contexts, the following elements are excluded: Equation , Example , Figure , IndexTerm , InformalTable , Table .

Attributes

Subject: Subject holds a list of keywords for the GlossDef 's definition.

Examples

For examples, see Glossary , GlossList .

Prev	Home	Next
Glossary	Up	GlossDiv

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.

<one> GlossSee </one>


	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
Prev		Next

GlossSee

Name

GlossSee -- A cross-reference from one GlossEntry to another

Synopsis

Mixed Content Model

GlossSee ::= ((#PCDATAFootnoteRefXRefAbbrevAcronymCitationCiteRefEntry CiteTitleEmphasisFirstTermForeignPhraseGlossTermFootnote PhraseQuoteTrademarkWordAsWordLinkOLinkULinkAction ApplicationClassNameCommandComputerOutputDatabaseEmail EnVarErrorCodeErrorNameErrorTypeFilenameFunctionGUIButton GUIIconGUILabelGUIMenuGUIMenuItemGUISubmenuHardware InterfaceInterfaceDefinitionKeyCapKeyCodeKeyComboKeySym LiteralConstantMarkupMediaLabelMenuChoiceMouseButton MsgTextOptionOptionalParameterPromptPropertyReplaceable ReturnValueSGMLTagStructFieldStructNameSymbolSystemItem TokenTypeUserInputVarNameAnchorAuthorAuthorInitials CorpAuthorModeSpecOtherCreditProductNameProductNumber RevHistoryCommentSubscriptSuperscriptInlineGraphic InlineMediaObjectInlineEquationSynopsisCmdSynopsis FuncSynopsisIndexTerm)+)

Attributes

Common attributes

Name	Type	Default
OtherTerm	IDREF	Content reference

Tag Minimization

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

Description

GlossSee directs the reader to another GlossEntry instead of this one. A "See" cross-reference occurs in place of the definition.

Processing Expectations

Formatted as a displayed block, in the same style as a GlossDef .

GlossSee elements are expected to generate the necessary cross-reference text, usually "See" in English, as well as any necessary punctuation.

Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Parents

These elements contain GlossSee: GlossEntry .

Children

The following elements occur in GlossSee: Abbrev , Acronym , Action , Anchor , Application , Author , AuthorInitials , Citation , CiteRefEntry , CiteTitle , ClassName , CmdSynopsis , Command , Comment , ComputerOutput , Constant , CorpAuthor , Database , Email , Emphasis , EnVar , ErrorCode , ErrorName , ErrorType , Filename , FirstTerm , Footnote , FootnoteRef , ForeignPhrase , FuncSynopsis , Function , GlossTerm , GUIButton , GUIIcon , GUILabel , GUIMenu , GUIMenuItem , GUISubmenu , Hardware , IndexTerm , InlineEquation , InlineGraphic , InlineMediaObject , Interface , InterfaceDefinition , KeyCap , KeyCode , KeyCombo , KeySym , Link , Literal , Markup , MediaLabel , MenuChoice , ModeSpec , MouseButton , MsgText , OLink , Option , Optional , OtherCredit , Parameter , Phrase , ProductName , ProductNumber , Prompt , Property , Quote , Replaceable , ReturnValue , RevHistory , SGMLTag , StructField , StructName , Subscript , Superscript , Symbol , Synopsis , SystemItem , Token , Trademark , Type , ULink , UserInput , VarName , WordAsWord , XRef .