Version: DocBook V4.5

%*.class; Parameter Entities

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

Description

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

%admon.class;

Parameter entity content:

caution|important|note|tip|warning

%appendix.class;

Parameter entity content:

appendix

%appendix.class; appears in:

%appendix.class; appears in:
`article`	`book`

%article.class;

Parameter entity content:

article

%article.class; appears in:

%article.class; appears in:
`book`

%base.char.class;

Parameter entity content:

anchor

%base.char.class; appears in:

%base.char.class; appears in:
`replaceable`	`subscript`	`superscript`
`trademark`

%biblio.class.attrib;

Parameter entity content:

Name

Type

Default

class

Enumerated:

uri

doi

isbn

isrn

issn

libraryofcongress

pubnumber

other

None

otherclass

CDATA

None

%biblio.class.attrib; appears in:

%biblio.class.attrib; appears in:
`biblioid`	`bibliorelation`	`bibliosource`
`citebiblioid`

%book.class;

Parameter entity content:

book

%book.class; appears in:

%book.class; appears in:
`set`

%chapter.class;

Parameter entity content:

chapter

%chapter.class; appears in:

%chapter.class; appears in:
`book`

%compound.class;

Parameter entity content:

msgset|procedure|sidebar|qandaset|task
                 |productionset|constraintdef

%descobj.class;

Parameter entity content:

abstract|authorblurb|epigraph

%docinfo.char.class;

Parameter entity content:

author|authorinitials|corpauthor|corpcredit|modespec|othercredit
		|productname|productnumber|revhistory

%formal.class;

Parameter entity content:

equation|example|figure|table

%gen.char.class;

Parameter entity content:

abbrev|acronym|citation|citerefentry|citetitle|citebiblioid|emphasis
		|firstterm|foreignphrase|glossterm|termdef|footnote|phrase
		|orgname|quote|trademark|wordasword
		|personname

%genobj.class;

Parameter entity content:

anchor|bridgehead|remark|highlights

%index.class;

Parameter entity content:

index|setindex

%index.class; appears in:

%index.class; appears in:
`book`

%info.class;

Parameter entity content:

graphic | mediaobject | legalnotice | modespec
		 | subjectset | keywordset | itermset | abbrev|abstract|address|artpagenums|author
		|authorgroup|authorinitials|bibliomisc|biblioset
		|collab|confgroup|contractnum|contractsponsor
		|copyright|corpauthor|corpname|corpcredit|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

%info.class; appears in:

%informal.class;

Parameter entity content:

address|blockquote
                |graphic|graphicco|mediaobject|mediaobjectco
                |informalequation
		|informalexample
                |informalfigure
                |informaltable

%inlineobj.char.class;

Parameter entity content:

inlinegraphic|inlinemediaobject|inlineequation

%linespecific.class;

Parameter entity content:

literallayout|programlisting|programlistingco|screen
		|screenco|screenshot

%link.char.class;

Parameter entity content:

link|olink|ulink

%link.char.class; appears in:

%link.char.class; appears in:
`figure`	`informalfigure`	`refentry`
`refnamediv`	`replaceable`	`subscript`
`superscript`	`trademark`

%list.class;

Parameter entity content:

calloutlist|glosslist|bibliolist|itemizedlist|orderedlist|segmentedlist
		|simplelist|variablelist

%method.synop.class;

Parameter entity content:

constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis

%method.synop.class; appears in:

%method.synop.class; appears in:
`classsynopsis`

%nav.class;

Parameter entity content:

toc|lot|index|glossary|bibliography

%nav.class; appears in:

%nav.class; appears in:
`appendix`	`article`	`chapter`
`preface`	`sect1`	`sect2`
`sect3`	`sect4`	`sect5`
`section`

%ndxterm.class;

Parameter entity content:

indexterm

%ndxterm.class; appears in:

%ndxterm.class; appears in:
`formalpara`	`glossentry`	`refentry`
`refmeta`	`task`

%notation.class;

Parameter entity content:

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

%notation.class; appears in:

%notation.class; appears in:
`modespec`

%other.char.class;

Parameter entity content:

remark|subscript|superscript

%other.char.class; appears in:

%other.char.class; appears in:
`replaceable`	`subscript`	`superscript`
`trademark`

%para.class;

Parameter entity content:

formalpara|para|simpara

%para.class; appears in:

%para.class; appears in:
`abstract`	`authorblurb`	`epigraph`
`personblurb`	`printhistory`

%refentry.class;

Parameter entity content:

refentry

%refentry.class; appears in:

%refentry.class; appears in:
`reference`	`sect1`	`sect2`
`sect3`	`sect4`	`sect5`
`section`

%section.class;

Parameter entity content:

section

%section.class; appears in:

%section.class; appears in:
`section`

%synop.class;

Parameter entity content:

synopsis|cmdsynopsis|funcsynopsis
                 |classsynopsis|fieldsynopsis
                 |constructorsynopsis
                 |destructorsynopsis
                 |methodsynopsis

%tech.char.class;

Parameter entity content:

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

%tech.char.class; appears in:

%tech.char.class; appears in:
`trademark`

%xref.char.class;

Parameter entity content:

footnoteref|xref|biblioref

%info.class; appears in:
`appendixinfo`	`articleinfo`	`bibliographyinfo`
`blockinfo`	`bookinfo`	`chapterinfo`
`glossaryinfo`	`indexinfo`	`objectinfo`
`partinfo`	`prefaceinfo`	`refentryinfo`
`referenceinfo`	`refsect1info`	`refsect2info`
`refsect3info`	`refsectioninfo`	`refsynopsisdivinfo`
`sect1info`	`sect2info`	`sect3info`
`sect4info`	`sect5info`	`sectioninfo`
`setindexinfo`	`setinfo`	`sidebarinfo`

Synopsis​

Description​

%admon.class;​

%appendix.class;​

%article.class;​

%base.char.class;​

%biblio.class.attrib;​

%book.class;​

%chapter.class;​

%compound.class;​

%descobj.class;​

%docinfo.char.class;​

%formal.class;​

%gen.char.class;​

%genobj.class;​

%index.class;​

%info.class;​

%informal.class;​

%inlineobj.char.class;​

%linespecific.class;​

%link.char.class;​

%list.class;​

%method.synop.class;​

%nav.class;​

%ndxterm.class;​

%notation.class;​

%other.char.class;​

%para.class;​

%refentry.class;​

%section.class;​

%synop.class;​

%tech.char.class;​

%xref.char.class;​

Synopsis

Description

%admon.class;

%appendix.class;

%article.class;

%base.char.class;

%biblio.class.attrib;

%book.class;

%chapter.class;

%compound.class;

%descobj.class;

%docinfo.char.class;

%formal.class;

%gen.char.class;

%genobj.class;

%index.class;

%info.class;

%informal.class;

%inlineobj.char.class;

%linespecific.class;

%link.char.class;

%list.class;

%method.synop.class;

%nav.class;

%ndxterm.class;

%notation.class;

%other.char.class;

%para.class;

%refentry.class;

%section.class;

%synop.class;

%tech.char.class;

%xref.char.class;