Common Attribute Parameter Entities

Common Attribute Parameter Entities — Parameter entities which define the common attributes

Synopsis

These parameter entities define the attributes that are considered “common”. Common attributes occur on every element. They are provided by either the %common.attrib; parameter entity or the %idreq.common.attrib; parameter entity. Those parameter entities are defined in terms of the others, listed here.

Description

The following parameter entities define the common attributes in DocBook:

%arch.attrib;

Parameter entity content:

Name

Type

Default

archCDATANone

%common.attrib;

Parameter entity content:

Name

Type

Default

idIDNone
langCDATANone
remapCDATANone
xreflabelCDATANone
revisionflag

Enumerated:

changed
added
deleted
off
None
archCDATANone
conditionCDATANone
conformanceNMTOKENSNone
osCDATANone
revisionCDATANone
securityCDATANone
userlevelCDATANone
vendorCDATANone
wordsizeCDATANone
dir

Enumerated:

ltr
rtl
lro
rlo
None
xml:baseCDATANone

%common.attrib; appears in:

%common.attrib; appears in:
abbrevabstractaccel
acknoacronymaction
addressaffiliationalt
answerappendixappendixinfo
applicationareaspecarg
articlearticleinfoartpagenums
attributionaudiodataaudioobject
authorauthorblurbauthorgroup
authorinitialsbeginpagebibliocoverage
bibliodivbiblioentrybibliography
bibliographyinfobiblioidbibliolist
bibliomiscbibliomixedbibliomset
bibliorefbibliorelationbiblioset
bibliosourceblockinfoblockquote
bookbookinfobridgehead
calloutcalloutlistcaution
chapterchapterinfocitation
citebiblioidciterefentrycitetitle
cityclassnameclasssynopsis
classsynopsisinfocmdsynopsiscode
collabcollabnamecolophon
commandcomputeroutputconfdates
confgroupconfnumconfsponsor
conftitleconstantconstraint
constructorsynopsiscontractnumcontractsponsor
contribcopyrightcoref
corpauthorcorpcreditcorpname
countrydatabasedate
dedicationdestructorsynopsisedition
editoremailemphasis
envarepigraphequation
errorcodeerrornameerrortext
errortypeexampleexceptionname
faxfieldsynopsisfigure
filenamefirstnamefirstterm
footnotefootnoterefforeignphrase
formalparafuncdeffuncparams
funcprototypefuncsynopsisfuncsynopsisinfo
functionglossaryglossaryinfo
glossdefglossdivglossentry
glosslistglossseeglossseealso
glosstermgraphicgraphicco
groupguibuttonguiicon
guilabelguimenuguimenuitem
guisubmenuhardwarehighlights
holderhonorificimagedata
imageobjectimageobjectcoimportant
indexindexdivindexentry
indexinfoindexterminformalequation
informalexampleinformalfigureinitializer
inlineequationinlinegraphicinlinemediaobject
interfaceinterfacenameinvpartnumber
isbnissnissuenum
itemizedlistitermsetjobtitle
keycapkeycodekeycombo
keysymkeywordkeywordset
labellegalnoticelhs
lineagelineannotationlink
listitemliteralliterallayout
lotlotentrymanvolnum
markupmedialabelmediaobject
mediaobjectcomembermenuchoice
methodnamemethodparammethodsynopsis
modespecmodifiermousebutton
msgmsgaudmsgentry
msgexplanmsginfomsglevel
msgmainmsgorigmsgrel
msgsetmsgsubmsgtext
nonterminalnoteobjectinfo
olinkooclassooexception
oointerfaceoptionoptional
orderedlistorgdivorgname
otheraddrothercreditothername
packagepagenumspara
paramdefparameterpart
partinfopartintropersonblurb
personnamephonephrase
pobpostcodepreface
prefaceinfoprimaryprimaryie
printhistoryprocedureproductionrecap
productionsetproductnameproductnumber
programlistingprogramlistingcoprompt
propertypubdatepublisher
publishernamepubsnumberqandadiv
qandaentryqandasetquestion
quoterefclassrefdescriptor
refentryrefentryinforefentrytitle
referencereferenceinforefmeta
refmiscinforefnamerefnamediv
refpurposerefsect1refsect1info
refsect2refsect2inforefsect3
refsect3inforefsectionrefsectioninfo
refsynopsisdivrefsynopsisdivinforeleaseinfo
remarkreplaceablereturnvalue
revdescriptionrevhistoryrevision
revnumberrevremarkrhs
sbrscreenscreenco
screeninfoscreenshotsecondary
secondaryiesect1sect1info
sect2sect2infosect3
sect3infosect4sect4info
sect5sect5infosection
sectioninfoseeseealso
seealsoieseeieseg
seglistitemsegmentedlistsegtitle
seriesvolnumssetsetindex
setindexinfosetinfosgmltag
shortaffilshortcutsidebar
sidebarinfosimparasimplelist
simplemsgentrysimplesectstate
stepstepalternativesstreet
structfieldstructnamesubject
subjectsetsubjecttermsubscript
substepssubtitlesuperscript
surnamesymbolsynopfragmentref
synopsissystemitemtask
taskprerequisitestaskrelatedtasksummary
termtertiarytertiaryie
textdatatextobjecttip
titletitleabbrevtoc
tocbacktocchaptocentry
tocfronttoclevel1toclevel2
toclevel3toclevel4toclevel5
tocparttokentrademark
typeulinkuri
userinputvarargsvariablelist
varlistentryvarnamevideodata
videoobjectvoidvolumenum
warningwordaswordxref
year  

%conformance.attrib;

Parameter entity content:

Name

Type

Default

conformanceNMTOKENSNone

%effectivity.attrib;

Parameter entity content:

Name

Type

Default

archCDATANone
conditionCDATANone
conformanceNMTOKENSNone
osCDATANone
revisionCDATANone
securityCDATANone
userlevelCDATANone
vendorCDATANone
wordsizeCDATANone

%effectivity.attrib; appears in:

%effectivity.attrib; appears in:
anchor  

%id.attrib;

Parameter entity content:

Name

Type

Default

idIDNone

%idreq.attrib;

Parameter entity content:

Name

Type

Default

idIDRequired

%idreq.attrib; appears in:

%idreq.attrib; appears in:
anchor  

%idreq.common.attrib;

Parameter entity content:

Name

Type

Default

idIDRequired
langCDATANone
remapCDATANone
xreflabelCDATANone
revisionflag

Enumerated:

changed
added
deleted
off
None
archCDATANone
conditionCDATANone
conformanceNMTOKENSNone
osCDATANone
revisionCDATANone
securityCDATANone
userlevelCDATANone
vendorCDATANone
wordsizeCDATANone
dir

Enumerated:

ltr
rtl
lro
rlo
None
xml:baseCDATANone

%idreq.common.attrib; appears in:

%idreq.common.attrib; appears in:
areaareasetco
constraintdefproductionsynopfragment

%lang.attrib;

Parameter entity content:

Name

Type

Default

langCDATANone

%os.attrib;

Parameter entity content:

Name

Type

Default

osCDATANone

%remap.attrib;

Parameter entity content:

Name

Type

Default

remapCDATANone

%remap.attrib; appears in:

%remap.attrib; appears in:
anchor  

%revision.attrib;

Parameter entity content:

Name

Type

Default

revisionCDATANone

%revisionflag.attrib;

Parameter entity content:

Name

Type

Default

revisionflag

Enumerated:

changed
added
deleted
off
None

%revisionflag.attrib; appears in:

%revisionflag.attrib; appears in:
anchor  

%userlevel.attrib;

Parameter entity content:

Name

Type

Default

userlevelCDATANone

%vendor.attrib;

Parameter entity content:

Name

Type

Default

vendorCDATANone

%xreflabel.attrib;

Parameter entity content:

Name

Type

Default

xreflabelCDATANone

%xreflabel.attrib; appears in:

%xreflabel.attrib; appears in:
anchor