%*.class; Parameter Entities

Name

%*.class; Parameter Entities -- Parameter entities which define the DocBook classes

Synopsis

Classes group elements of a similar type, for example all the lists are in the %list.class;

If you want to add a new kind of something (a new kind of list or a new kind of verbatim environment, for example), you generally want to add the name of the new element to the appropriate class.

%admon.class;

Elements which are admonitions.

Parameter Entity

Caution|Important|Note|Tip|Warning 

%admon.class; contributes to the declaration of the following elements:

AppendixArticleBiblioDiv
BibliographyBlockQuoteCallout
CaptionChapterColophon
DedicationentryGlossary
GlossDivHighlightsIndex
LegalNoticeListItemMsgExplan
MsgTextParaPartIntro
PrefaceProcedureRefSect1
RefSect2RefSect3RefSynopsisDiv
Sect1Sect2Sect3
Sect4Sect5Section
SetIndexSidebarSimpleSect
StepTextObject

%appendix.class;

Elements which are appendixes.

Parameter Entity

Appendix 

%appendix.class; contributes to the declaration of the following elements:

ArticleBookPart

%article.class;

Elements which are articles.

Parameter Entity

Article 

%article.class; contributes to the declaration of the following elements:

BookPart

%base.char.class;

Elements which are in the base character class. These elements are part of every character class.

Parameter Entity

Anchor 

%base.char.class; contributes to the declaration of the following elements:

AbbrevAcronymAction
ApplicationAttributionBiblioMisc
BridgeHeadCitationCiteTitle
CommandCommentComputerOutput
DatabaseEmphasisentry
FilenameFirstTermForeignPhrase
FuncParamsFuncSynopsisInfoFunction
GlossSeeGlossSeeAlsoGlossTerm
HardwareInterfaceInterfaceDefinition
KeyCapLabelLineAnnotation
LinkLiteralLiteralLayout
LoTentryManVolNumMember
MsgAudOLinkOption
OptionalParaParameter
PhrasePrimaryPrimaryIE
ProductNameProgramListingProperty
QuoteRefEntryTitleRefPurpose
ReplaceableScreenScreenInfo
SecondarySecondaryIESee
SeeAlsoSeeAlsoIESeeIE
SegSegTitleSimPara
SubscriptSubtitleSuperscript
SynopsisSystemItemTerm
TertiaryTertiaryIETitle
TitleAbbrevToCbackToCentry
ToCfrontTrademarkULink
UserInputWordAsWord

%book.class;

Elements which are books.

Parameter Entity

Book 

%book.class; contributes to the declaration of the following element:

Set

%chapter.class;

Elements which are chapters.

Parameter Entity

Chapter 

%chapter.class; contributes to the declaration of the following elements:

BookPart

%compound.class;

Elements which are compound objects (objects with internal structure).

Parameter Entity

MsgSet|Procedure|Sidebar|QandASet 

%compound.class; contributes to the declaration of the following elements:

AppendixArticleBiblioDiv
BibliographyBlockQuoteCallout
ChapterGlossaryGlossDiv
IndexListItemMsgExplan
MsgTextPartIntroPreface
ProcedureRefSect1RefSect2
RefSect3RefSynopsisDivSect1
Sect2Sect3Sect4
Sect5SectionSetIndex
SimpleSectStep

%descobj.class;

Elements which are descriptive in nature.

Parameter Entity

Abstract|AuthorBlurb|Epigraph
		

%descobj.class; contributes to the declaration of the following elements:

AppendixArticleBiblioDiv
BibliographyBlockQuoteCallout
ChapterGlossaryGlossDiv
IndexListItemMsgExplan
MsgTextPartIntroPreface
ProcedureRefSect1RefSect2
RefSect3RefSynopsisDivSect1
Sect2Sect3Sect4
Sect5SectionSetIndex
SimpleSectStep

%docinfo.char.class;

Elements which provide information about a document. (Not to be confused with elements which are part of the DocInfo element.) While %docinfo.char.class; is part of the content model of DocInfo, it has nothing directly to do with the similarity of their names.)

Parameter Entity

Author|AuthorInitials|CorpAuthor|ModeSpec|OtherCredit
		|ProductName|ProductNumber|RevHistory
		

%docinfo.char.class; contributes to the declaration of the following elements:

ApplicationAttributionBiblioMisc
BridgeHeadCitationCiteTitle
CommentEmphasisentry
ForeignPhraseGlossSeeGlossSeeAlso
GlossTermLineAnnotationLink
LiteralLayoutLoTentryMember
MsgAudOLinkPara
PhrasePrimaryPrimaryIE
ProductNameProgramListingQuote
RefEntryTitleRefPurposeScreen
ScreenInfoSecondarySecondaryIE
SeeSeeAlsoSeeAlsoIE
SeeIESegSegTitle
SimParaSubtitleSynopsis
TermTertiaryTertiaryIE
TitleTitleAbbrevToCback
ToCentryToCfrontULink

%formal.class;

Formal objects (objects with titles).

Parameter Entity

Equation|Example|Figure|Table 

%formal.class; contributes to the declaration of the following elements:

AnswerAppendixArticle
BiblioDivBibliographyBlockQuote
CalloutCautionChapter
GlossaryGlossDefGlossDiv
ImportantIndexListItem
MsgExplanMsgTextNote
ParaPartIntroPreface
ProcedureQandADivQandASet
QuestionRefSect1RefSect2
RefSect3RefSynopsisDivSect1
Sect2Sect3Sect4
Sect5SectionSetIndex
SidebarSimpleSectStep
TipWarning

%gen.char.class;

The class of general inline elements.

Parameter Entity

Abbrev|Acronym|Citation|CiteRefEntry|CiteTitle|Emphasis
		|FirstTerm|ForeignPhrase|GlossTerm|Footnote|Phrase
		|Quote|Trademark|WordAsWord 

%gen.char.class; contributes to the declaration of the following elements:

ApplicationAttributionBiblioMisc
BridgeHeadCitationCiteTitle
CommentEmphasisentry
ForeignPhraseGlossSeeGlossSeeAlso
GlossTermLineAnnotationLink
LiteralLayoutLoTentryMember
MsgAudOLinkPara
PhrasePrimaryPrimaryIE
ProductNameProgramListingQuote
RefEntryTitleRefPurposeScreen
ScreenInfoSecondarySecondaryIE
SeeSeeAlsoSeeAlsoIE
SeeIESegSegTitle
SimParaSubtitleSynopsis
TermTertiaryTertiaryIE
TitleTitleAbbrevToCback
ToCentryToCfrontULink

%genobj.class;

The general class of objects.

Parameter Entity

Anchor|BridgeHead|Comment|Highlights
		

%genobj.class; contributes to the declaration of the following elements:

AnswerAppendixArticle
BiblioDivBibliographyBlockQuote
CalloutChapterGlossary
GlossDivIndexListItem
MsgExplanMsgTextPartIntro
PrefaceProcedureQandADiv
QandASetQuestionRefSect1
RefSect2RefSect3RefSynopsisDiv
Sect1Sect2Sect3
Sect4Sect5Section
SetIndexSidebarSimpleSect
Step

%index.class;

Elements which are indexes.

Parameter Entity

Index|SetIndex 

%index.class; contributes to the declaration of the following element:

Book

%informal.class;

Elements which are informal objects.

Parameter Entity

Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable 

%informal.class; contributes to the declaration of the following elements:

AnswerAppendixArticle
BiblioDivBibliographyBlockQuote
CalloutCautionChapter
ExampleFigureFootnote
GlossaryGlossDefGlossDiv
ImportantIndexIndexDiv
InformalExampleInformalFigureListItem
MsgExplanMsgTextNote
ParaPartIntroPreface
ProcedureQandADivQandASet
QuestionRefSect1RefSect2
RefSect3RefSynopsisDivSect1
Sect2Sect3Sect4
Sect5SectionSetIndex
SidebarSimpleSectStep
TipWarning

%inlineobj.char.class;

Elements which are inline objects.

Parameter Entity

InlineGraphic|InlineMediaObject|InlineEquation 

%inlineobj.char.class; contributes to the declaration of the following elements:

ApplicationAttributionBiblioMisc
BridgeHeadCitationCiteTitle
CommentEmphasisentry
ForeignPhraseGlossSeeGlossSeeAlso
GlossTermLineAnnotationLink
LiteralLayoutLoTentryMember
MsgAudOLinkPara
PhraseProductNameProgramListing
QuoteRefEntryTitleScreen
ScreenInfoSegSegTitle
SimParaSubtitleSynopsis
TermTitleTitleAbbrev
ToCbackToCentryToCfront
ULink

%linespecific.class;

Elements which are "line specific". Spaces and line breaks are significant in line specific elements.

Parameter Entity

LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 

%linespecific.class; contributes to the declaration of the following elements:

AnswerAppendixArticle
BiblioDivBibliographyBlockQuote
CalloutCaptionCaution
ChapterColophonDedication
entryExampleFigure
FootnoteGlossaryGlossDef
GlossDivImportantIndex
IndexDivInformalExampleInformalFigure
LegalNoticeListItemMsgExplan
MsgTextNotePara
PartIntroPrefaceProcedure
QandADivQandASetQuestion
RefSect1RefSect2RefSect3
RefSynopsisDivSect1Sect2
Sect3Sect4Sect5
SectionSetIndexSidebar
SimpleSectStepTextObject
TipWarning

%link.char.class;

Elements which are hyperlinks.

Parameter Entity

Link|OLink|ULink 

%link.char.class; contributes to the declaration of the following elements:

AbbrevAcknoAcronym
ActionApplicationArtPageNums
AttributionAuthorInitialsBiblioMisc
BridgeHeadCitationCiteTitle
CityCollabNameCommand
CommentComputerOutputConfDates
ConfNumConfSponsorConfTitle
ContractNumContractSponsorContrib
CorpAuthorCorpNameCountry
DatabaseDateEdition
EmailEmphasisentry
FaxFigureFilename
FirstNameFirstTermForeignPhrase
FuncParamsFuncSynopsisInfoFunction
GlossSeeGlossSeeAlsoGlossTerm
HardwareHolderHonorific
IndexDivInformalFigureInterface
InterfaceDefinitionInvPartNumberISBN
ISSNIssueNumJobTitle
KeyCapLabelLineage
LineAnnotationLinkLiteral
LiteralLayoutLoTentryManVolNum
MemberModeSpecMsgAud
OLinkOptionOptional
OrgDivOrgNameOtherAddr
OtherNamePageNumsPara
ParameterPhonePhrase
POBPostcodePrimary
PrimaryIEProductNameProductNumber
ProgramListingPropertyPubDate
PublisherNamePubsNumberQuote
RefEntryRefEntryTitleRefMiscInfo
RefNameDivRefPurposeReleaseInfo
ReplaceableRevNumberRevRemark
ScreenScreenInfoSecondary
SecondaryIESeeSeeAlso
SeeAlsoIESeeIESeg
SegTitleSeriesVolNumsShortAffil
SimParaStateStreet
SubscriptSubtitleSuperscript
SurnameSynopsisSystemItem
TermTertiaryTertiaryIE
TitleTitleAbbrevToCback
ToCentryToCfrontTrademark
ULinkUserInputVolumeNum
WordAsWordYear

%list.class;

Elements which are lists.

Parameter Entity

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 

%list.class; contributes to the declaration of the following elements:

AnswerAppendixArticle
BiblioDivBibliographyBlockQuote
CalloutCaptionCaution
ChapterColophonDedication
entryExampleFootnote
GlossaryGlossDefGlossDiv
HighlightsImportantIndex
InformalExampleLegalNoticeListItem
MsgExplanMsgTextNote
ParaPartIntroPreface
ProcedureQandADivQandASet
QuestionRefSect1RefSect2
RefSect3RefSynopsisDivSect1
Sect2Sect3Sect4
Sect5SectionSetIndex
SidebarSimpleSectStep
TextObjectTipWarning

%nav.class;

Elements which provide navigational information about a document (tables of contents, indexes, etc.).

Parameter Entity

ToC|LoT|Index|Glossary|Bibliography 
				

%nav.class; contributes to the declaration of the following elements:

ArticlePartSect1
Sect2Sect3Sect4
Sect5Section

%ndxterm.class;

Elements which are index terms.

Parameter Entity

IndexTerm 

%ndxterm.class; contributes to the declaration of the following elements:

AbbrevAccelAckno
AcronymActionAnswer
AppendixApplicationArtHeader
ArticleArtPageNumsAttribution
AuthorInitialsBiblioDivBiblioEntry
BibliographyBiblioMiscBiblioMixed
BiblioMSetBiblioSetBlockQuote
BookBiblioBookInfoBridgeHead
CalloutCautionChapter
CitationCiteTitleCity
ClassNameCollabNameCommand
CommentComputerOutputConfDates
ConfNumConfSponsorConfTitle
ConstantContractNumContractSponsor
ContribCorpAuthorCorpName
CountryDatabaseDate
DedicationDocInfoEdition
EmailEmphasisentry
EnVarErrorCodeErrorName
ErrorTypeExampleFax
FigureFilenameFirstName
FirstTermForeignPhraseFormalPara
FuncParamsFuncSynopsisInfoFunction
GlossaryGlossDefGlossDiv
GlossEntryGlossSeeGlossSeeAlso
GlossTermGUIButtonGUIIcon
GUILabelGUIMenuGUIMenuItem
GUISubmenuHardwareHighlights
HolderHonorificImportant
IndexInformalExampleInformalFigure
InterfaceInterfaceDefinitionInvPartNumber
ISBNISSNIssueNum
JobTitleKeyCapKeyCode
KeySymLabelLegalNotice
LineageLineAnnotationLink
ListItemLiteralLiteralLayout
LoTentryManVolNumMarkup
MediaLabelMemberModeSpec
MouseButtonMsgAudMsgExplan
MsgLevelMsgOrigMsgText
NoteObjectInfoOLink
OptionOptionalOrgDiv
OrgNameOtherAddrOtherName
PageNumsParaParameter
PartIntroPhonePhrase
POBPostcodePreface
ProcedureProductNameProductNumber
ProgramListingPromptProperty
PubDatePublisherNamePubsNumber
QandADivQandASetQuestion
QuoteRefEntryTitleRefMiscInfo
RefPurposeRefSect1RefSect1Info
RefSect2RefSect2InfoRefSect3
RefSect3InfoRefSynopsisDivRefSynopsisDivInfo
ReleaseInfoReturnValueRevNumber
RevRemarkScreenScreenInfo
Sect1Sect1InfoSect2
Sect2InfoSect3Sect3Info
Sect4Sect4InfoSect5
Sect5InfoSectionSectionInfo
SegSegTitleSeriesInfo
SeriesVolNumsSetIndexSetInfo
SGMLTagShortAffilSidebar
SimParaSimpleSectState
StepStreetStructField
StructNameSubtitleSurname
SymbolSynopsisSystemItem
TableTermTip
TitleTitleAbbrevToCback
ToCentryToCfrontToken
TypeULinkUserInput
VarNameVolumeNumWarning
WordAsWordYear

%notation.class;

The notations defined by DocBookk.

Parameter Entity

BMP| CGM-CHAR | CGM-BINARY | CGM-CLEAR | DITROFF | DVI
		| EPS | EQN | FAX | GIF | GIF87a | GIF89a 
		| JPG | JPEG | IGES | PCX
		| PIC | PS | SGML | TBL | TEX | TIFF | WMF | WPG
		| linespecific
		

%notation.class; contributes to the declaration of the following elements:

AudioDataGraphicImageData
InlineGraphicModeSpecVideoData

%other.char.class;

The other character classes (inline elements which don't obviously fall into one of the other classes).

Parameter Entity

Comment|Subscript|Superscript 

%other.char.class; contributes to the declaration of the following elements:

AbbrevAcknoAcronym
ActionApplicationArtPageNums
AttributionAuthorInitialsBiblioMisc
BridgeHeadCitationCiteTitle
CityCollabNameCommand
CommentComputerOutputConfDates
ConfNumConfSponsorConfTitle
ContractNumContractSponsorContrib
CorpAuthorCorpNameCountry
DatabaseDateEdition
EmailEmphasisentry
FaxFilenameFirstName
FirstTermForeignPhraseFuncParams
FuncSynopsisInfoFunctionGlossSee
GlossSeeAlsoGlossTermHardware
HolderHonorificInterface
InterfaceDefinitionInvPartNumberISBN
ISSNIssueNumJobTitle
KeyCapLabelLineage
LineAnnotationLinkLiteral
LiteralLayoutLoTentryManVolNum
MemberModeSpecMsgAud
OLinkOptionOptional
OrgDivOrgNameOtherAddr
OtherNamePageNumsPara
ParameterPhonePhrase
POBPostcodePrimary
PrimaryIEProductNameProductNumber
ProgramListingPropertyPubDate
PublisherNamePubsNumberQuote
RefEntryTitleRefMiscInfoRefPurpose
ReleaseInfoReplaceableRevNumber
RevRemarkScreenScreenInfo
SecondarySecondaryIESee
SeeAlsoSeeAlsoIESeeIE
SegSegTitleSeriesVolNums
ShortAffilSimParaState
StreetSubscriptSubtitle
SuperscriptSurnameSynopsis
SystemItemTermTertiary
TertiaryIETitleTitleAbbrev
ToCbackToCentryToCfront
TrademarkULinkUserInput
VolumeNumWordAsWordYear

%otherinfo.class;

Parameter Entity

DocInfo|Sect1Info|Sect2Info|Sect3Info
				|Sect4Info|Sect5Info|RefSect1Info
				|RefSect2Info|RefSect3Info|RefSynopsisDivInfo
				

%para.class;

Parameter Entity

FormalPara|Para|SimPara 

%para.class; contributes to the declaration of the following elements:

AbstractAnswerAppendix
ArticleAuthorBlurbBiblioDiv
BibliographyBlockQuoteCallout
CaptionCautionChapter
ColophonDedicationentry
EpigraphExampleFootnote
GlossaryGlossDefGlossDiv
HighlightsImportantIndex
IndexDivInformalExampleLegalNotice
ListItemMsgExplanMsgText
NotePartIntroPreface
PrintHistoryProcedureQandADiv
QandASetQuestionRefSect1
RefSect2RefSect3RefSynopsisDiv
Sect1Sect2Sect3
Sect4Sect5Section
SetIndexSidebarSimpleSect
StepTextObjectTip
Warning

%refentry.class;

Parameter Entity

RefEntry 

%refentry.class; contributes to the declaration of the following elements:

AppendixArticleChapter
PartPartIntroPreface
ReferenceSect1Sect2
Sect3Sect4Sect5
Section

%synop.class;

Parameter Entity

Synopsis|CmdSynopsis|FuncSynopsis 

%synop.class; contributes to the declaration of the following elements:

AnswerAppendixApplication
ArticleAttributionBiblioDiv
BibliographyBiblioMiscBlockQuote
CalloutCautionChapter
CitationCiteTitleComment
EmphasisentryExample
FigureFootnoteForeignPhrase
GlossaryGlossDefGlossDiv
GlossSeeGlossSeeAlsoGlossTerm
ImportantIndexIndexDiv
InformalExampleInformalFigureLineAnnotation
LinkListItemLiteralLayout
LoTentryMemberMsgAud
MsgExplanMsgTextNote
OLinkParaPartIntro
PhrasePrefaceProcedure
ProductNameProgramListingQandADiv
QandASetQuestionQuote
RefEntryTitleRefSect1RefSect2
RefSect3RefSynopsisDivScreen
ScreenInfoSect1Sect2
Sect3Sect4Sect5
SectionSegSetIndex
SidebarSimParaSimpleSect
StepSynopsisTerm
TipToCbackToCentry
ToCfrontULinkWarning

%tech.char.class;

Parameter Entity

Action|Application|ClassName|Command|ComputerOutput
		|Database|Email|EnVar|ErrorCode|ErrorName|ErrorType|Filename
		|Function|GUIButton|GUIIcon|GUILabel|GUIMenu|GUIMenuItem
		|GUISubmenu|Hardware|Interface|InterfaceDefinition|KeyCap
		|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|MediaLabel
		|MenuChoice|MouseButton|MsgText|Option|Optional|Parameter
		|Prompt|Property|Replaceable|ReturnValue|SGMLTag|StructField
		|StructName|Symbol|SystemItem|Token|Type|UserInput|VarName
		

%tech.char.class; contributes to the declaration of the following elements:

ActionApplicationAttribution
BiblioMiscBridgeHeadCitation
CiteTitleCommandComment
ComputerOutputDatabaseEmphasis
entryFilenameForeignPhrase
FuncParamsFuncSynopsisInfoFunction
GlossSeeGlossSeeAlsoGlossTerm
HardwareInterfaceInterfaceDefinition
KeyCapLineAnnotationLink
LiteralLiteralLayoutLoTentry
MemberMsgAudOLink
OptionOptionalPara
ParameterPhrasePrimary
PrimaryIEProductNameProgramListing
PropertyQuoteRefDescriptor
RefEntryTitleRefNameRefPurpose
ScreenScreenInfoSecondary
SecondaryIESeeSeeAlso
SeeAlsoIESeeIESeg
SegTitleSimParaSubtitle
SynopsisSystemItemTerm
TertiaryTertiaryIETitle
TitleAbbrevToCbackToCentry
ToCfrontTrademarkULink
UserInput

%xref.char.class;

Parameter Entity

FootnoteRef|XRef 

%xref.char.class; contributes to the declaration of the following elements:

ApplicationAttributionBiblioMisc
BridgeHeadCitationCiteTitle
CommentEmphasisentry
ForeignPhraseGlossSeeGlossSeeAlso
GlossTermLineAnnotationLink
LiteralLayoutLoTentryMember
MsgAudOLinkPara
PhrasePrimaryPrimaryIE
ProductNameProgramListingQuote
RefEntryTitleRefPurposeScreen
ScreenInfoSecondarySecondaryIE
SeeSeeAlsoSeeAlsoIE
SeeIESegSegTitle
SimParaSubtitleSynopsis
TermTertiaryTertiaryIE
TitleTitleAbbrevToCback
ToCentryToCfrontULink

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.