DocBook: The Definitive Guide

Table of content


	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

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:

`Caution`	`Important`	`Note`
`Tip`	`Warning`

%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:

`ArtHeader`	`BiblioEntry`	`BiblioMixed`
`BiblioMSet`	`BiblioSet`	`BookBiblio`
`BookInfo`	`DocInfo`	`ObjectInfo`
`RefSect1Info`	`RefSect2Info`	`RefSect3Info`
`RefSynopsisDivInfo`	`Sect1Info`	`Sect2Info`
`Sect3Info`	`Sect4Info`	`Sect5Info`
`SectionInfo`	`SeriesInfo`	`SetInfo`

%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:

`BiblioDiv`	`Bibliography`	`BlockQuote`
`Callout`	`Glossary`	`GlossDiv`
`Index`	`ListItem`	`MsgExplan`
`MsgText`	`Procedure`	`SetIndex`
`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:

`Action`	`Command`	`ComputerOutput`
`Database`	`Filename`	`FuncParams`
`FuncSynopsisInfo`	`Function`	`Hardware`
`Interface`	`InterfaceDefinition`	`KeyCap`
`Literal`	`Option`	`Optional`
`Parameter`	`Property`	`SystemItem`
`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:

`Sect1`	`Sect2`	`Sect3`
`Sect4`	`Sect5`	`Section`
`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:

`Ackno`	`ArtPageNums`	`AuthorInitials`
`City`	`CollabName`	`ConfDates`
`ConfNum`	`ConfSponsor`	`ConfTitle`
`ContractNum`	`ContractSponsor`	`Contrib`
`CorpAuthor`	`CorpName`	`Country`
`Date`	`Edition`	`Email`
`Fax`	`FirstName`	`Holder`
`Honorific`	`InvPartNumber`	`ISBN`
`ISSN`	`IssueNum`	`JobTitle`
`Lineage`	`ModeSpec`	`OrgDiv`
`OrgName`	`OtherAddr`	`OtherName`
`PageNums`	`Phone`	`POB`
`Postcode`	`ProductNumber`	`PubDate`
`PublisherName`	`PubsNumber`	`RefMiscInfo`
`ReleaseInfo`	`RevNumber`	`RevRemark`
`SeriesVolNums`	`ShortAffil`	`State`
`Street`	`Surname`	`VolumeNum`
`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:

Example InformalExample

%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:

Figure InformalFigure

%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:

Dedication LegalNotice

%mediaobject.mix;

Parameter entity content:

VideoObject|AudioObject|ImageObject

%mediaobject.mix; appears in:

InlineMediaObject MediaObject

%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:

`Primary`	`PrimaryIE`	`Secondary`
`SecondaryIE`	`See`	`SeeAlso`
`SeeAlsoIE`	`SeeIE`	`Tertiary`
`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:

`Application`	`Attribution`	`BiblioMisc`
`Citation`	`CiteTitle`	`Comment`
`Emphasis`	`ForeignPhrase`	`GlossSee`
`GlossSeeAlso`	`GlossTerm`	`LineAnnotation`
`Link`	`LiteralLayout`	`LoTentry`
`Member`	`MsgAud`	`OLink`
`Para`	`Phrase`	`ProductName`
`Quote`	`RefEntryTitle`	`ScreenInfo`
`Seg`	`SimPara`	`Synopsis`
`Term`	`ToCback`	`ToCentry`
`ToCfront`	`ULink`

%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:

`Address`	`Author`	`Editor`
`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:

`Answer`	`QandADiv`	`QandASet`
`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:

`RefSect1`	`RefSect2`	`RefSect3`
`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:

RefDescriptor RefName

%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:

`Accel`	`ClassName`	`Constant`
`EnVar`	`ErrorCode`	`ErrorName`
`ErrorType`	`GUIButton`	`GUIIcon`
`GUILabel`	`GUIMenu`	`GUIMenuItem`
`GUISubmenu`	`KeyCode`	`KeySym`
`Markup`	`MediaLabel`	`MouseButton`
`MsgLevel`	`MsgOrig`	`Prompt`
`ReturnValue`	`SGMLTag`	`StructField`
`StructName`	`Symbol`	`Token`
`Type`	`VarName`

%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:

Caption Colophon TextObject

%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:

`BridgeHead`	`SegTitle`	`Subtitle`
`Title`	`TitleAbbrev`

%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:

`Abbrev`	`Acronym`	`FirstTerm`
`Label`	`ManVolNum`	`WordAsWord`

Prev	Home	Next
`%local.*.mix;` Parameter Entities	Up	`%*.module;` Parameter Entities

Back to: DocBook: The Definitive Guide

Table of content

DocBook 5: The Definitive Guide

ISBN: 0596805020
EAN: 2147483647

Year: 1999
Pages: 412

Authors: Walsh Norman, Richard L. Hamilton

BUY ON AMAZON

Interprocess Communications in Linux: The Nooks and Crannies

Pocket Guide to the National Electrical Code(R), 2005 Edition (8th Edition)

Telecommunications Essentials, Second Edition: The Complete Global Source (2nd Edition)

Special Edition Using FileMaker 8

Cultural Imperative: Global Trends in the 21st Century

Python Programming for the Absolute Beginner, 3rd Edition