DocBook: The Definitive Guide
PrevNext

%*.mix; Parameter Entities

Name

%*.mix; Parameter Entities -- Parameter entities which define the DocBook mixtures

Synopsis

Mixtures are collections of classes that appear in content models. For example, the content model of Example element includes the %example.mix;. Not every element's content model is a single mixture, but elements in the same class tend to have the same mixture in their content model.

If you want to change the content model of some class of elements (lists or admonitions, perhaps), you generally want to change the definition of the appropriate mixture.

Description

DocBook defines the following mixtures:

%admon.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 
		|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 		|Procedure|Sidebar
		|Anchor|BridgeHead|Comment
		|IndexTerm

%admon.mix; appears in:

CautionImportantNote
TipWarning

%bibliocomponent.mix;

Parameter entity content:

Abbrev|Abstract|Address|ArtPageNums|Author
		|AuthorGroup|AuthorInitials|BiblioMisc|BiblioSet
		|Collab|ConfGroup|ContractNum|ContractSponsor
		|Copyright|CorpAuthor|CorpName|Date|Edition
		|Editor|InvPartNumber|ISBN|ISSN|IssueNum|OrgName
		|OtherCredit|PageNums|PrintHistory|ProductName
		|ProductNumber|PubDate|Publisher|PublisherName
		|PubsNumber|ReleaseInfo|RevHistory|SeriesVolNums
		|Subtitle|Title|TitleAbbrev|VolumeNum|CiteTitle
		|Honorific|FirstName|Surname|Lineage|OtherName|Affiliation
		|AuthorBlurb|Contrib 
		|IndexTerm

%bibliocomponent.mix; appears in:

ArtHeaderBiblioEntryBiblioMixed
BiblioMSetBiblioSetBookBiblio
BookInfoDocInfoObjectInfo
RefSect1InfoRefSect2InfoRefSect3Info
RefSynopsisDivInfoSect1InfoSect2Info
Sect3InfoSect4InfoSect5Info
SectionInfoSeriesInfoSetInfo

%component.mix;

Parameter entity content:

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

%component.mix; appears in:

BiblioDivBibliographyBlockQuote
CalloutGlossaryGlossDiv
IndexListItemMsgExplan
MsgTextProcedureSetIndex
Step

%cptr.char.mix;

Parameter entity content:

#PCDATA
		|Link|OLink|ULink 	|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
		
		|Anchor 
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject
		|IndexTerm

%cptr.char.mix; appears in:

ActionCommandComputerOutput
DatabaseFilenameFuncParams
FuncSynopsisInfoFunctionHardware
InterfaceInterfaceDefinitionKeyCap
LiteralOptionOptional
ParameterPropertySystemItem
UserInput

%divcomponent.mix;

Parameter entity content:

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

%divcomponent.mix; appears in:

Sect1Sect2Sect3
Sect4Sect5Section
SimpleSect

%docinfo.char.mix;

Parameter entity content:

#PCDATA
		|Link|OLink|ULink 
					|Emphasis|Trademark
					|Replaceable
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject
		|IndexTerm

%docinfo.char.mix; appears in:

AcknoArtPageNumsAuthorInitials
CityCollabNameConfDates
ConfNumConfSponsorConfTitle
ContractNumContractSponsorContrib
CorpAuthorCorpNameCountry
DateEditionEmail
FaxFirstNameHolder
HonorificInvPartNumberISBN
ISSNIssueNumJobTitle
LineageModeSpecOrgDiv
OrgNameOtherAddrOtherName
PageNumsPhonePOB
PostcodeProductNumberPubDate
PublisherNamePubsNumberRefMiscInfo
ReleaseInfoRevNumberRevRemark
SeriesVolNumsShortAffilState
StreetSurnameVolumeNum
Year

%example.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 	|Synopsis|CmdSynopsis|FuncSynopsis 
		|FormalPara|Para|SimPara 		|Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable 
		|IndexTerm

%example.mix; appears in:

ExampleInformalExample

%figure.mix;

Parameter entity content:

LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 	|Synopsis|CmdSynopsis|FuncSynopsis 
					|Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable 
		|IndexTerm

%figure.mix; appears in:

FigureInformalFigure

%footnote.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 	|Synopsis|CmdSynopsis|FuncSynopsis 
		|FormalPara|Para|SimPara 		|Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable

%footnote.mix; appears in:

Footnote

%glossdef.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 
		|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 
		|Comment
		|IndexTerm

%glossdef.mix; appears in:

GlossDef

%highlights.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 		|Caution|Important|Note|Tip|Warning 
		|FormalPara|Para|SimPara 
		|IndexTerm

%highlights.mix; appears in:

Highlights

%indexdivcomponent.mix;

Parameter entity content:

ItemizedList|OrderedList|VariableList|SimpleList
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 	|Synopsis|CmdSynopsis|FuncSynopsis 
		|FormalPara|Para|SimPara 		|Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable 
		|Anchor|Comment
		|Link|OLink|ULink

%indexdivcomponent.mix; appears in:

IndexDiv

%legalnotice.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 		|Caution|Important|Note|Tip|Warning 
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 
		|FormalPara|Para|SimPara 		|BlockQuote
		|IndexTerm

%legalnotice.mix; appears in:

DedicationLegalNotice

%mediaobject.mix;

Parameter entity content:

VideoObject|AudioObject|ImageObject

%mediaobject.mix; appears in:

InlineMediaObjectMediaObject

%ndxterm.char.mix;

Parameter entity content:

#PCDATA
		|FootnoteRef|XRef 	|Abbrev|Acronym|Citation|CiteRefEntry|CiteTitle|Emphasis
		|FirstTerm|ForeignPhrase|GlossTerm|Footnote|Phrase
		|Quote|Trademark|WordAsWord 
		|Link|OLink|ULink 	|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
		
		|Anchor 	|Author|AuthorInitials|CorpAuthor|ModeSpec|OtherCredit
		|ProductName|ProductNumber|RevHistory
		
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject

%ndxterm.char.mix; appears in:

PrimaryPrimaryIESecondary
SecondaryIESeeSeeAlso
SeeAlsoIESeeIETertiary
TertiaryIE

%para.char.mix;

Parameter entity content:

#PCDATA
		|FootnoteRef|XRef 	|Abbrev|Acronym|Citation|CiteRefEntry|CiteTitle|Emphasis
		|FirstTerm|ForeignPhrase|GlossTerm|Footnote|Phrase
		|Quote|Trademark|WordAsWord 
		|Link|OLink|ULink 	|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
		
		|Anchor 	|Author|AuthorInitials|CorpAuthor|ModeSpec|OtherCredit
		|ProductName|ProductNumber|RevHistory
		
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject|InlineEquation 
		|Synopsis|CmdSynopsis|FuncSynopsis 
		|IndexTerm

%para.char.mix; appears in:

ApplicationAttributionBiblioMisc
CitationCiteTitleComment
EmphasisForeignPhraseGlossSee
GlossSeeAlsoGlossTermLineAnnotation
LinkLiteralLayoutLoTentry
MemberMsgAudOLink
ParaPhraseProductName
QuoteRefEntryTitleScreenInfo
SegSimParaSynopsis
TermToCbackToCentry
ToCfrontULink

%para.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList            |Caution|Important|Note|Tip|Warning 
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 
					|Address|BlockQuote
		|Graphic|GraphicCO|MediaObject|MediaObjectCO
		|InformalEquation
		|InformalExample
		|InformalFigure
		|InformalTable 
		|Equation|Example|Figure|Table

%para.mix; appears in:

Para

%partcontent.mix;

Parameter entity content:

Appendix |Chapter |ToC|LoT|Index|Glossary|Bibliography 
				|Article 
		|Preface|RefEntry |Reference

%partcontent.mix; appears in:

Part

%person.ident.mix;

Parameter entity content:

Honorific|FirstName|Surname|Lineage|OtherName|Affiliation
		|AuthorBlurb|Contrib

%person.ident.mix; appears in:

AddressAuthorEditor
OtherCredit

%qandaset.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 
		|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 		|Procedure
		|Anchor|BridgeHead|Comment|Highlights
		
		|IndexTerm

%qandaset.mix; appears in:

AnswerQandADivQandASet
Question

%refclass.char.mix;

Parameter entity content:

#PCDATA
		|Application

%refclass.char.mix; appears in:

RefClass

%refcomponent.mix;

Parameter entity content:

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

%refcomponent.mix; appears in:

RefSect1RefSect2RefSect3
RefSynopsisDiv

%refinline.char.mix;

Parameter entity content:

#PCDATA
		|FootnoteRef|XRef 	|Abbrev|Acronym|Citation|CiteRefEntry|CiteTitle|Emphasis
		|FirstTerm|ForeignPhrase|GlossTerm|Footnote|Phrase
		|Quote|Trademark|WordAsWord 
		|Link|OLink|ULink 	|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
		
		|Anchor 	|Author|AuthorInitials|CorpAuthor|ModeSpec|OtherCredit
		|ProductName|ProductNumber|RevHistory
		
		|Comment|Subscript|Superscript 
		|IndexTerm

%refinline.char.mix; appears in:

RefPurpose

%refname.char.mix;

Parameter entity content:

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

%refname.char.mix; appears in:

RefDescriptorRefName

%sidebar.mix;

Parameter entity content:

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 		|Procedure
		|Anchor|BridgeHead|Comment|Highlights
		
		|IndexTerm

%sidebar.mix; appears in:

Sidebar

%smallcptr.char.mix;

Parameter entity content:

#PCDATA
					|Replaceable
					|InlineGraphic|InlineMediaObject
		|IndexTerm

%smallcptr.char.mix; appears in:

AccelClassNameConstant
EnVarErrorCodeErrorName
ErrorTypeGUIButtonGUIIcon
GUILabelGUIMenuGUIMenuItem
GUISubmenuKeyCodeKeySym
MarkupMediaLabelMouseButton
MsgLevelMsgOrigPrompt
ReturnValueSGMLTagStructField
StructNameSymbolToken
TypeVarName

%textobject.mix;

Parameter entity content:

CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList
		|SimpleList|VariableList 		|Caution|Important|Note|Tip|Warning 
		|LiteralLayout|ProgramListing|ProgramListingCO|Screen
		|ScreenCO|ScreenShot 
		|FormalPara|Para|SimPara 		|BlockQuote

%textobject.mix; appears in:

CaptionColophonTextObject

%title.char.mix;

Parameter entity content:

#PCDATA
		|FootnoteRef|XRef 	|Abbrev|Acronym|Citation|CiteRefEntry|CiteTitle|Emphasis
		|FirstTerm|ForeignPhrase|GlossTerm|Footnote|Phrase
		|Quote|Trademark|WordAsWord 
		|Link|OLink|ULink 	|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
		
		|Anchor 	|Author|AuthorInitials|CorpAuthor|ModeSpec|OtherCredit
		|ProductName|ProductNumber|RevHistory
		
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject|InlineEquation 
		|IndexTerm

%title.char.mix; appears in:

BridgeHeadSegTitleSubtitle
TitleTitleAbbrev

%ubiq.mix;

Parameter entity content:

IndexTerm |BeginPage

%word.char.mix;

Parameter entity content:

#PCDATA
					|Acronym|Emphasis|Trademark
		|Link|OLink|ULink 
		|Anchor 
		|Comment|Subscript|Superscript 	|InlineGraphic|InlineMediaObject
		|IndexTerm

%word.char.mix; appears in:

AbbrevAcronymFirstTerm
LabelManVolNumWordAsWord
PrevHomeNext
%local.*.mix; Parameter EntitiesUp%*.module; Parameter Entities

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