Home Prev Up Next DocBook: The Definitive Guide Version 2.0.8 (Alpha)

%*.mix; Parameter Entities

%*.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

The following sections identify all of the mixture parameter entities in DocBook.

%admon.mix;

Parameter entity content:

calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist
        |simplelist|variablelist 
        |literallayout|programlisting|programlistingco|screen
        |screenco|screenshot    |synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |procedure|sidebar
        |anchor|bridgehead|remark
        |indexterm         |beginpage

%admon.mix; appears in:

%admon.mix; appears in:
caution constraintdef 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
        |biblioid|citebiblioid|bibliosource|bibliorelation|bibliocoverage
        |othercredit|pagenums|printhistory|productname
        |productnumber|pubdate|publisher|publishername
        |pubsnumber|releaseinfo|revhistory|seriesvolnums
        |subtitle|title|titleabbrev|volumenum|citetitle
        |personname|honorific|firstname|surname|lineage|othername|affiliation
        |authorblurb|contrib 
        |indexterm

%bibliocomponent.mix; appears in:

%bibliocomponent.mix; appears in:
biblioentry bibliomixed bibliomset
biblioset    

%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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |msgset|procedure|sidebar|qandaset
                 |productionset|constraintdef
                 
        |anchor|bridgehead|remark|highlights
                |abstract|authorblurb|epigraph
        
        |indexterm         |beginpage

%component.mix; appears in:

%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|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal
        
        |anchor 
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject
        |indexterm         |beginpage

%cptr.char.mix; appears in:

%cptr.char.mix; appears in:
action classsynopsisinfo command
computeroutput database filename
funcparams funcsynopsisinfo function
hardware interfacename 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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |msgset|procedure|sidebar|qandaset
                 |productionset|constraintdef
                 
        |anchor|bridgehead|remark|highlights
                |abstract|authorblurb|epigraph
        
        |indexterm         |beginpage

%divcomponent.mix; appears in:

%divcomponent.mix; appears in:
sect1 sect2 sect3
sect4 sect5 section
simplesect    

%docinfo.char.mix;

Parameter entity content:

#PCDATA
        |link|olink|ulink 
                    |emphasis|trademark
                    |replaceable
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject
        |indexterm

%docinfo.char.mix; appears in:

%docinfo.char.mix; appears in:
ackno artpagenums authorinitials
bibliocoverage biblioid bibliorelation
bibliosource citebiblioid 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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |indexterm         |beginpage

%example.mix; appears in:

%example.mix; appears in:
example informalexample  

%figure.mix;

Parameter entity content:

literallayout|programlisting|programlistingco|screen
        |screenco|screenshot    |synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
                    |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |indexterm         |beginpage

%figure.mix; appears in:

%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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable

%footnote.mix; appears in:

%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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table 
        |remark
        |indexterm         |beginpage

%glossdef.mix; appears in:

%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.mix; appears in:
highlights    

%indexdivcomponent.mix;

Parameter entity content:

itemizedlist|orderedlist|variablelist|simplelist
        |literallayout|programlisting|programlistingco|screen
        |screenco|screenshot    |synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |anchor|remark
        |link|olink|ulink 
                                |beginpage

%indexdivcomponent.mix; appears in:

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

%legalnotice.mix; appears in:

%legalnotice.mix; appears in:
dedication legalnotice  

%listpreamble.mix;

Parameter entity content:

                     caution|important|note|tip|warning 
        |literallayout|programlisting|programlistingco|screen
        |screenco|screenshot    |synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |anchor|bridgehead|remark|highlights
                |abstract|authorblurb|epigraph
        
        |indexterm         |beginpage

%listpreamble.mix; appears in:

%listpreamble.mix; appears in:
itemizedlist orderedlist variablelist

%mediaobject.mix;

Parameter entity content:

videoobject|audioobject|imageobject|textobject

%mediaobject.mix; appears in:

%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|personname 
        |link|olink|ulink   |action|application
                |classname|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal
        
        |anchor     |author|authorinitials|corpauthor|modespec|othercredit
        |productname|productnumber|revhistory
        
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject

%ndxterm.char.mix; appears in:

%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|personname 
        |link|olink|ulink   |action|application
                |classname|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal
        
        |anchor     |author|authorinitials|corpauthor|modespec|othercredit
        |productname|productnumber|revhistory
        
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject|inlineequation 
        |synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |indexterm         |beginpage

%para.char.mix; appears in:

%para.char.mix; appears in:
application attribution bibliomisc
citation citetitle emphasis
foreignphrase glosssee glossseealso
glossterm lineannotation link
literallayout lotentry member
msgaud olink para
phrase productname programlisting
quote refentrytitle remark
screen 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.mix; appears in:
para    

%partcontent.mix;

Parameter entity content:

appendix |chapter |toc|lot|index|glossary|bibliography
                |article 
        |preface|refentry |reference

%partcontent.mix; appears in:

%partcontent.mix; appears in:
part    

%person.ident.mix;

Parameter entity content:

honorific|firstname|surname|lineage|othername|affiliation
        |authorblurb|contrib

%person.ident.mix; appears in:

%person.ident.mix; appears in:
address author editor
othercredit    

%qandaset.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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |procedure
        |anchor|bridgehead|remark|highlights
        
        |indexterm

%qandaset.mix; appears in:

%qandaset.mix; appears in:
answer qandadiv qandaset
question    

%refclass.char.mix;

Parameter entity content:

#PCDATA
        |application

%refclass.char.mix; appears in:

%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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |msgset|procedure|sidebar|qandaset
                 |productionset|constraintdef
                 
        |anchor|bridgehead|remark|highlights
                |abstract|authorblurb|epigraph
        
        |indexterm         |beginpage

%refcomponent.mix; appears in:

%refcomponent.mix; appears in:
refsect1 refsect2 refsect3
refsection refsynopsisdiv  

%refinline.char.mix;

Parameter entity content:

#PCDATA
        |footnoteref|xref   |abbrev|acronym|citation|citerefentry|citetitle|emphasis
        |firstterm|foreignphrase|glossterm|footnote|phrase
        |quote|trademark|wordasword|personname 
        |link|olink|ulink   |action|application
                |classname|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal
        
        |anchor     |author|authorinitials|corpauthor|modespec|othercredit
        |productname|productnumber|revhistory
        
        |remark|subscript|superscript 
        |indexterm         |beginpage

%refinline.char.mix; appears in:

%refinline.char.mix; appears in:
refpurpose    

%refname.char.mix;

Parameter entity content:

#PCDATA
        |action|application
                |classname|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal

%refname.char.mix; appears in:

%refname.char.mix; appears in:
refdescriptor refname  

%revdescription.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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |procedure
        |anchor|bridgehead|remark|highlights
        
        |indexterm

%revdescription.mix; appears in:

%revdescription.mix; appears in:
revdescription    

%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
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis  
        |formalpara|para|simpara        |address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
        |informalexample
                |informalfigure
                |informaltable 
        |equation|example|figure|table      |procedure
        |anchor|bridgehead|remark|highlights
        
        |indexterm         |beginpage

%sidebar.mix; appears in:

%sidebar.mix; appears in:
sidebar    

%smallcptr.char.mix;

Parameter entity content:

#PCDATA
                    |replaceable
                    |inlinegraphic|inlinemediaobject
        |indexterm         |beginpage

%smallcptr.char.mix; appears in:

%smallcptr.char.mix; appears in:
accel classname constant
envar errorcode errorname
errortext errortype exceptionname
guibutton guiicon guilabel
guimenu guimenuitem guisubmenu
initializer interface keycode
keysym markup medialabel
methodname modifier 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:

%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|personname 
        |link|olink|ulink   |action|application
                |classname|methodname|interfacename|exceptionname
                |ooclass|oointerface|ooexception
                |command|computeroutput
        |database|email|envar|errorcode|errorname|errortype|errortext|filename
        |function|guibutton|guiicon|guilabel|guimenu|guimenuitem
        |guisubmenu|hardware|interface|keycap
        |keycode|keycombo|keysym|literal|constant|markup|medialabel
        |menuchoice|mousebutton|option|optional|parameter
        |prompt|property|replaceable|returnvalue|sgmltag|structfield
        |structname|symbol|systemitem|token|type|userinput|varname
                |nonterminal
        
        |anchor     |author|authorinitials|corpauthor|modespec|othercredit
        |productname|productnumber|revhistory
        
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject|inlineequation 
        |indexterm

%title.char.mix; appears in:

%title.char.mix; appears in:
bridgehead segtitle subtitle
title titleabbrev  

%ubiq.mix;

Parameter entity content:

The replacement text for this entity is empty.

%word.char.mix;

Parameter entity content:

#PCDATA
                    |acronym|emphasis|trademark
        |link|olink|ulink 
        |anchor 
        |remark|subscript|superscript   |inlinegraphic|inlinemediaobject
        |indexterm         |beginpage

%word.char.mix; appears in:

%word.char.mix; appears in:
abbrev acronym firstterm
label manvolnum wordasword
Prev  Home  Next
local.*.mix Parameter Entities  Up  *.module Parameter Entities

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