Common Attribute Parameter Entities
Prev | DocBook Parameter Entity Reference | Next

This is an alpha version of this book.

# Common Attribute Parameter Entities

## Name

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
arch | CDATA | None

### %common.attrib;

Parameter entity content:

Name | Type | Default
id | ID | None
lang | CDATA | None
remap | CDATA | None
xreflabel | CDATA | None
revisionflag | Enumerated:
changed
added
deleted
off
| None
arch | CDATA | None
condition | CDATA | None
conformance | NMTOKENS | None
os | CDATA | None
revision | CDATA | None
security | CDATA | None
userlevel | CDATA | None
vendor | CDATA | None

%common.attrib; appears in:

`abbrev` | `abstract` | `accel`
`ackno` | `acronym` | `action`
`address` | `affiliation` | `alt`
`answer` | `appendix` | `appendixinfo`
`application` | `areaspec` | `arg`
`article` | `articleinfo` | `artpagenums`
`attribution` | `audiodata` | `audioobject`
`author` | `authorblurb` | `authorgroup`
`authorinitials` | `beginpage` | `bibliodiv`
`biblioentry` | `bibliography` | `bibliographyinfo`
`bibliomisc` | `bibliomixed` | `bibliomset`
`biblioset` | `blockquote` | `book`
`bookinfo` | `bridgehead` | `callout`
`calloutlist` | `caption` | `caution`
`chapter` | `chapterinfo` | `citation`
`citerefentry` | `citetitle` | `city`
`classname` | `classsynopsis` | `classsynopsisinfo`
`cmdsynopsis` | `collab` | `collabname`
`colophon` | `command` | `computeroutput`
`confdates` | `confgroup` | `confnum`
`confsponsor` | `conftitle` | `constant`
`constraint` | `constructorsynopsis` | `contractnum`
`contractsponsor` | `contrib` | `copyright`
`corpauthor` | `corpname` | `country`
`database` | `date` | `dedication`
`destructorsynopsis` | `edition` | `editor`
`email` | `emphasis` | `envar`
`epigraph` | `equation` | `errorcode`
`errorname` | `errortype` | `example`
`exceptionname` | `fax` | `fieldsynopsis`
`figure` | `filename` | `firstname`
`firstterm` | `footnote` | `footnoteref`
`foreignphrase` | `formalpara` | `funcdef`
`funcparams` | `funcprototype` | `funcsynopsis`
`funcsynopsisinfo` | `function` | `glossary`
`glossaryinfo` | `glossdef` | `glossdiv`
`glossentry` | `glosslist` | `glosssee`
`glossseealso` | `glossterm` | `graphic`
`graphicco` | `group` | `guibutton`
`guiicon` | `guilabel` | `guimenu`
`guimenuitem` | `guisubmenu` | `hardware`
`highlights` | `holder` | `honorific`
`imagedata` | `imageobject` | `imageobjectco`
`important` | `index` | `indexdiv`
`indexentry` | `indexinfo` | `indexterm`
`informalequation` | `informalexample` | `informalfigure`
`initializer` | `inlineequation` | `inlinegraphic`
`inlinemediaobject` | `interface` | `interfacename`
`invpartnumber` | `isbn` | `issn`
`issuenum` | `itemizedlist` | `itermset`
`jobtitle` | `keycap` | `keycode`
`keycombo` | `keysym` | `keyword`
`keywordset` | `label` | `legalnotice`
`lhs` | `lineage` | `lineannotation`
`link` | `listitem` | `literal`
`literallayout` | `lot` | `lotentry`
`manvolnum` | `markup` | `medialabel`
`mediaobject` | `mediaobjectco` | `member`
`menuchoice` | `methodname` | `methodparam`
`methodsynopsis` | `modespec` | `modifier`
`mousebutton` | `msg` | `msgaud`
`msgentry` | `msgexplan` | `msginfo`
`msglevel` | `msgmain` | `msgorig`
`msgrel` | `msgset` | `msgsub`
`msgtext` | `nonterminal` | `note`
`objectinfo` | `olink` | `ooclass`
`ooexception` | `oointerface` | `option`
`optional` | `orderedlist` | `orgdiv`
`orgname` | `otheraddr` | `othercredit`
`othername` | `pagenums` | `para`
`paramdef` | `parameter` | `part`
`partinfo` | `partintro` | `phone`
`phrase` | `pob` | `postcode`
`preface` | `prefaceinfo` | `primary`
`primaryie` | `printhistory` | `procedure`
`productionrecap` | `productionset` | `productname`
`productnumber` | `programlisting` | `programlistingco`
`prompt` | `property` | `pubdate`
`publisher` | `publishername` | `pubsnumber`
`qandadiv` | `qandaentry` | `qandaset`
`question` | `quote` | `refclass`
`refdescriptor` | `refentry` | `refentryinfo`
`refentrytitle` | `reference` | `referenceinfo`
`refmeta` | `refmiscinfo` | `refname`
`refnamediv` | `refpurpose` | `refsect1`
`refsect1info` | `refsect2` | `refsect2info`
`refsect3` | `refsect3info` | `refsynopsisdiv`
`refsynopsisdivinfo` | `releaseinfo` | `remark`
`replaceable` | `returnvalue` | `revdescription`
`revhistory` | `revision` | `revnumber`
`revremark` | `rhs` | `sbr`
`screen` | `screenco` | `screeninfo`
`screenshot` | `secondary` | `secondaryie`
`sect1` | `sect1info` | `sect2`
`sect2info` | `sect3` | `sect3info`
`sect4` | `sect4info` | `sect5`
`sect5info` | `section` | `sectioninfo`
`see` | `seealso` | `seealsoie`
`seeie` | `seg` | `seglistitem`
`segmentedlist` | `segtitle` | `seriesvolnums`
`set` | `setindex` | `setindexinfo`
`setinfo` | `sgmltag` | `shortaffil`
`shortcut` | `sidebar` | `sidebarinfo`
`simpara` | `simplelist` | `simplemsgentry`
`simplesect` | `state` | `step`
`street` | `structfield` | `structname`
`subject` | `subjectset` | `subjectterm`
`subscript` | `substeps` | `subtitle`
`superscript` | `surname` | `symbol`
`synopfragmentref` | `synopsis` | `systemitem`
`term` | `tertiary` | `tertiaryie`
`textobject` | `tip` | `title`
`titleabbrev` | `toc` | `tocback`
`tocchap` | `tocentry` | `tocfront`
`toclevel1` | `toclevel2` | `toclevel3`
`toclevel4` | `toclevel5` | `tocpart`
`token` | `trademark` | `type`
`ulink` | `userinput` | `varargs`
`variablelist` | `varlistentry` | `varname`
`videodata` | `videoobject` | `void`
`volumenum` | `warning` | `wordasword`
`xref` | `year` |

### %conformance.attrib;

Parameter entity content:

Name | Type | Default
conformance | NMTOKENS | None

### %effectivity.attrib;

Parameter entity content:

Name | Type | Default
arch | CDATA | None
condition | CDATA | None
conformance | NMTOKENS | None
os | CDATA | None
revision | CDATA | None
security | CDATA | None
userlevel | CDATA | None
vendor | CDATA | None

%effectivity.attrib; appears in:

`anchor` |  |

### %id.attrib;

Parameter entity content:

Name | Type | Default
id | ID | None

### %idreq.attrib;

Parameter entity content:

Name | Type | Default
id | ID | Required

%idreq.attrib; appears in:

`anchor` |  |

### %idreq.common.attrib;

Parameter entity content:

Name | Type | Default
id | ID | Required
lang | CDATA | None
remap | CDATA | None
xreflabel | CDATA | None
revisionflag | Enumerated:
changed
added
deleted
off
| None
arch | CDATA | None
condition | CDATA | None
conformance | NMTOKENS | None
os | CDATA | None
revision | CDATA | None
security | CDATA | None
userlevel | CDATA | None
vendor | CDATA | None

%idreq.common.attrib; appears in:

`area` | `areaset` | `co`
`constraintdef` | `production` | `synopfragment`

### %lang.attrib;

Parameter entity content:

Name | Type | Default
lang | CDATA | None

### %os.attrib;

Parameter entity content:

Name | Type | Default
os | CDATA | None

### %remap.attrib;

Parameter entity content:

Name | Type | Default
remap | CDATA | None

%remap.attrib; appears in:

`anchor` |  |

### %revision.attrib;

Parameter entity content:

Name | Type | Default
revision | CDATA | None

### %revisionflag.attrib;

Parameter entity content:

Name | Type | Default
revisionflag | Enumerated:
changed
added
deleted
off
| None

%revisionflag.attrib; appears in:

`anchor` |  |

### %userlevel.attrib;

Parameter entity content:

Name | Type | Default
userlevel | CDATA | None

### %vendor.attrib;

Parameter entity content:

Name | Type | Default
vendor | CDATA | None

### %xreflabel.attrib;

Parameter entity content:

Name | Type | Default
xreflabel | CDATA | None

%xreflabel.attrib; appears in:

`anchor` |  |

Prev | Home | Next
Content Module Parameter Entities | Up | DocBook Content Parameter Entities

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.