DocBook Quick Reference $Revision: 1.13 $

htp://www.holoweb.net/~liam/xml/docbook/

This quick reference as compiled is copyright © Liam Quin, 2001; you can copy or reuse this quick reference for any purpose as long as you retain this and the following copyright notice from the original material:

Copyright 1992, 1993 HaL Computer Systems International, Ltd., and O'Reilly & Associates, Inc.
Permission to use, copy, modify and distribute the DocBook DTD and its accompanying documentation for any purpose and without fee is hereby granted, provided that this copyright notice appears in all copies. If you modify the DocBook DTD, rename your modified version. HaL Computer Systems International, Ltd., and O'Reilly & Associates, Inc., make no representation about the suitability of the DTD for any purpose. It is provided "as is" without expressed or implied warranty.


abbrevAn abbreviation, especially one followed by a period
abstractA document summary
accelA GUI keyboard shortcut
acknoAcknowledgements in an Article
acronymA (usually pronounceable) contraction of initials, usually printed in all caps or small caps
actionA function invoked in response to a user event
addressA real-world (e.g. postal) address
affiliationSomeone's institutional affiliation
altText used instead of, or to describe, an image
anchorMarks a target for a Link
answerAn answer to a question in a qandaset
appendixFound at the end of a book or article
appendixinfo[4.0] Meta-data for an Appendix
application The name of a software program
areaA region identified for a callout in a graphic or code example
areaseta set of related areas
areaspeca collection of regions in a graphic or code example
argArgument in a CmdSynopsis
artheader Metainformation for an Article; 4.0: replaced by articleinfo
article An article (e.g. in a journal)
articleinfo[4.0] Meta-data for an Article
articleinfo[4.0] replaces articleheader
artpagenums Page numbers of an Article as published
attributionIdentifies where a block quote or epigraph came from
audiodataLink to external audio data
audioobjectWrapper for audiodata
authorAuthor of a document
authorblurbShort description of author
authorgroupWrapper for author information
authorinitialsIndicates the author of a Revision or Comment
beginpageA page break in a print version of a work
bibliodivA section of a Bibliography
biblioentryAn entry in a Bibliography
bibliographyA bibliography
bibliographyinfo[4.0] Meta-data for a Bibliography
bibliomiscUntyped information in a bibliography
bibliomixedA bibliography entry
bibliomsetA group of related bibliographic information
bibliosetA container for related bibliographic information
blockquoteA quotation set off from the main text
bookA book
bookbiblioInformation about a book for a bibliographical citation
bookbiblio[4.0] Meta-information about a book used in a bibliographical citation
bookinfoMeta-information for a Book
bridgeheadA free-floating heading not tied to the Sect hierarchy
callouta separate (called out) description of a marked area
calloutlista list of callouts
captionA caption
cautionAn admonition set off from the text
chapterA part of a Book
chapterinfo[4.0] Meta-data for a Chapter
citationAny in-line bibliographic reference to another published work
citerefentry A citation of a reference entry
citetitleA citation for some published work
cityPart of Address
classnameThe name of an object-oriented programming class
classsynopsis[4.0] The syntax summary for a class definition
classsynopsisinfo[4.0] Information supplementing the content of a ClassSynopsis
cmdsynopsisSynopsis for a Command
coThe location of a callout embedded in text
collabA collaborative group of authors
collabnameName of a collaborative group of authors
colophonDescription of how a book was produced, usually at the end
colspecFormatting specification for a column in a table
commandAn executable program, or the entry a user makes to execute a command
commentNotes for printing in drafts of a manuscript; 4.0: replaced by remark
computeroutputData presented to the user by a computer
confdatesDates of a conference for which a document was written
confgroupA wrapper for information about a conference
confnumThe number of a conference
confsponsorSponsor of a conference for which a document was written
conftitleTitle of a conference for which a document was written
constantA programming or system constant
constructorsynopsis[4.0] The syntax summary for a constructor definition
contractnumContract number for a document
contractsponsorSponsor of a contract
copyrightCopyright information about a document
corpauthorCorporate author of a book, as opposed to an individual
corpnameName of a corporation
countryPart of Address
databaseThe name of a database, or part of a database
dateDate of publication or revision
dedicationWrapper for the dedication section in a book
destructorsynopsis[4.0] The syntax summary for a destructor definition
docinfoMeta-information for a book component; obsolete in 4.0, replaced by *info
editionThe name or number of an edition of a document
editorThe editor of a document
emailan electronic mail address
emphasisEmphasized text
entryA single cell in a table
entrytblA table that can appear instead of an entry in a table
envarAn environment variable, e.g. $PATH
epigraphA brief section of poetry or prose at the start of a chapter
equationA titled mathematical equation displayed on a line by itself, rather than in-line
errorcodeAn error code, e.g. given with some error messages
errornameThe text of an error message
errortypeA classification of an error message
exampleA formal example with title, often contains a program listing
exceptionname[4.0] The name of an exception
faxA fax number
fieldsynopsis[4.0] The syntax summary for a field definition
figureAn illustration, generally with a title
filename The name of a file
firstnameSomeone's first (given, not family) name; see also surname.
firsttermFirst occurrence of a rod or term in a given context
footnoteThe contents of a footnote
footnoterefLocation for a footnote mark, which is generated
foreignphraseA word or phrase from a language other than that of the document
formalparaA paragraph with a Title
funcdef A function or subroutine's name and return type
funcparamsParameters to a function; subroutine arguments.
funcprototypeThe prototype (type signature) of a function or subroutine
funcsynopsisHow a function is to be used or called
funcsynopsisinfoInformation supplementing the FuncDefs of a FuncSynopsis
functionThe name of a function of subroutine
glossaryA glossary of terms and definitions.
glossaryinfo[4.0] Meta-data for a Glossary
glossdefThe definition attached to a glossterm in a glossentry
glossdivA division of a glossary
glossentryAn entry in a glossary or glosslist
glosslistA wrapper for a group of glossentry elements
glossseeA cross-reference from one glossentry to another
glossseealsoA cross-reference from one glossdef to another glossentry
glosstermA term defined in a glossary, either where it's used in running text, or at its definition insde a glossary or glosslist
graphicAn imaeg, that can be helpd in an external file, and is displayed by itself, not in running text. See also mediaobject.
graphiccoA graphic with callout areas
groupA group of constituent parts of a CmdSynopsis
guiblabelText of a label in a graphical user interface
guibuttonThe text on a button in a graphical user interface
guiiconGraphic/text used as an icon in a graphical user interface
guimenuThe name of a menu in a user interface
guimenuitemText of a menu item that doesn't have a sub-menu
guisubmenuName of a submenu in a graphical user interface
hardwareA physical part of a computer system
highlightsA list of main points discussed
holderA holder of copyright
honorificA person's title, such as Dr. or Mrs.
imagedataPoints to external image data
imageobjectContains imagedata and associated meta-information
imageobjectcoan imageobject with a callout.
importantAn admonition set off from the text like a warning
index An index, e.g. to a chapter or book
indexdivA division of an Index
indexentryA single entry in an index
indexinfo[4.0] Meta-data for an Index
indextermMarks text that's to be placed in the index.
informalequationAn untitled mathematical equation displayed on a line by itself, rather than in-line
informalexampleA displayed (block) example without a title
informalfigureAn untitled figure displayed as a block
informaltableA table that has no title
initializer[4.0] The text of an expression that initializes part of a ClassSynopsis
inlineequationAn untitled mathematical equation that's part of running text
inlinegraphicAn image to be rendered as part of running text. EMPTY in DocBook 4, and gone in DocBook 5 (use mediaobject or inlinemediaobject)
inlinemediaobjectAn inline image, video, audio clip etc.
interfaceAny part of a graphical user interface
interfacedefinitionThe name of a GUI specification; discarded in DocBook 4
interfacedefinition[4.0] The name of a formal specification of a GUI
interfacename[4.0] The name of an interface
invpartnumberAn inventory part number
isbnInternational Standard Book Number of a document
issnInternational Standard Serial Number of a journal or periodical
issuenumThe number of an issue of a journal
itemizedlistAn unnumbered (bullet) list, like HTML's UL
itermsetA set of index terms inside document meta-information.
jobtitleThe title of a person within an organization
keycapThe text printed on a physical key on a computer keyboard
keycodeTheinternal code sent by a key when pressed, often numeric
keycomboA sequence of keycap, keycombo, keysym and mousebutton elements.
keysymThe symbolic name of a key, such as META_LEFT
keywordFreely chosen words and phrases used for searching; see also subjectterm
keywordsetcontainer for keyword elements
legalnoticeA warranty, license, legal obligation, etc., displayed as a block
lineagePart of an author's name, such as “Jr”
lineannotationA comment on a line of program code
linkA hypertext link
listitemA wrapper for the elements of items in a list; like HTML's LI
literalA literal computer text string, used in-line
literallayoutBlock in which line breaks and leading white space are to be regarded as significant, similar to HTML's PRE
lotList of Tables, figures, etc.
lotentryAn element of LoT
manvolnumA volumne number in documentation, e.g. a Unix man page
markupformatting markup in text to be represented literally, e.g. XML element names
medialabelThe physical medium on which some information is contained
mediaobjectA displayed (block) image, video, audio clip, etc.
mediaobjectcoA media object with a callout
memberPart of a SimpleList
menuchoiceA complete menu selection, e.g. containing multiple guimenuitems and keysyms.
methodname[4.0] The name of a method
methodparam[4.0] A parameter to a method
methodsynopsis[4.0] The syntax summary for a method definition
modespecContains application-specific information necessary for the completion of an OLink
modifier[4.0] A modifier
mousebuttonThe name of a mousebutton (e.g. left)
msgThe part of a MsgEntry containing the actual message and its subparts, along with explanatory text
msgaudThe audience to which a msg is relevant
msgentryA wrapper for an entry in a MsgSet
msgexplanExplanatory material for a msg in a msgset element
msginfoInformation about the Msg containing it
msglevelThe level of importance or severity of a Msg
msgmainThe main error or other message of a Msg
msgorigThe origin of a Msg
msgrelA message related to the main message (MsgMain) but which appears in a different place
msgsetA list of error or other messages, with related information
msgsubAn optional subpart of a Msg
msgtextText of a message, to be used only within a msgset element.
noteA message set off from the text
objectinfometa-information for an object
olinkAn indirect link using an entity
optionAn option for a computer program command
optionalTo show that a parameter is optional in a synopsis
orderedlistA numbered or lettered list of listitems (like HTML's OL)
orgdivPart of an organization
orgnameA non-corporate organization
otheraddrExtra information in an address
othercreditSupplements Author and Editor; you could use it to credit a contributor, a contributing editor, or some deserving production person
othernameAn alternative to Firstname and Surname, for use in Author, Editor, or Other Credit
pagenumsPage numbers cited in a bibliography
paraA paragraph (like HTML P)
paramdefDefines a parameter to a function
parameterA value or a reference to a value that's passed as an argument
partA section of a Book containing book components
partinfo[4.0] Meta-data for a Part
partintroIntroduction to the contents of a part; may also appear in Reference
phonetelephone number
phrasea span of text
pobPost Office Box in an Address
postcodeA postal code in an Address
prefaceAny introductory matter in a Book
prefaceinfo[4.0] Meta-data for a Preface
primaryA word or phrase in the text that an index term should be sorted under
primaryieA primary entry in an Index, not in the text
printhistoryThe printing history of a document
procedureA list of operations to be performed
productnameFormal name for any product
productnumberA number assigned to a product
programlistingA literal listing of a program
programlistingcoa programlisting with callouts
promptA string indicating the computer is ready and longing for input
propertyA defined set of data associated with a window or other resource
pubdateThe date of publication of a document
publisherThe publisher of a document
publishernameThe name of a publisher of a document
pubsnumberA number assigned to a publication, other than an ISBN or ISSN or InvPartNumber
qandadivA titled division in a qandaset
qandaentrya question and answer in a qandaset
qandaseta set of questions with answers
questiona question in a qandaset
quoteAn in-line quotation
refclassAn element of RefNameDiv, showing the applicability or scope of the topic of a RefEntry
refdescriptorThe topic of a reference page
refentryA reference page, like a Unix man page
refentryinfo[4.0] Meta-data for a RefEntry
refentrytitlePrimary name given to a reference page for sorting and indexing
referenceA collection of RefEntries
referenceinfo[4.0] Meta-data for a Reference
refmetaMeta-information for a reference entry
refmiscinfoExtra information in RefMeta, such as copyright, revision date, etc.
refnameThe subject or subjects of a reference page
refnamedivThe second major division of a reference page (name, purpose, classification)
refpurposeA short phrase describing the subject of the reference page
refsect1Equivalent to a Sect1 in the DocBook DTD
refsect1infoMetadata for refsect1
refsect2Equivalent to a Sect2 in the DocBook DTD, and may occur within RefSect1 or RefSynopsisDiv
refsect2infoMetadata for refsect2
refsect3Subdivision of RefSect2
refsect3infoMetadata for refsect2
refsynopsisdivThe third major division of a reference page, giving the syntax of the pages' subject
refsynopsisdivinfometadata for refsynopsis
releaseinfoInformation about a particular version of a document
remark[4.0] A remark intended for presentation in a draft manuscript
remark[4.0] replaces comment
replaceablePart of a synopsis or command line whose contents are to be replaced by the user
returnvalueA value returned by a function
revdescription[4.0] A long description in a Revision
revhistoryRevision history
revisiona single revision in a revision history
revnumberDocument revision number
revremarkAn element of Revision, describing the Revision
rowA row in a TBody, THead, or TFoot in a table
sbrA line break in a command synopsis
scereninfoMetadata about how a screenshot was made
screenText showing what the user sees or might see on a computer screen
screencoA screen with callout areas
screeninfoPart of ScreenShot
screenshota graphical screenshot
secondaryA second-level index entry
secondaryiePart of IndexEntry, see PrimaryIE
sect1A top-level section of a document
sect1infoMetadata for sect1
sect2A section beginning with a second-level heading
sect2infoMetadata for sect2
sect3within a sect2
sect3infoMetadata for sect3
sect4within a sect3
sect4infoMetadata for sect4
sect5within a sect4
sect5infoMetadata for sect5
sectionLike a sect2 but can contain a section, so recursive
sectioninfoMetadata for a section
seeBlind entry in an index term (see XXX instead)
seealsocross reference in an index entry
seealsoieA see also entry in an index, not in the text
seeieA see entry in an index, not in the text
segA component of a SegmentedList
seglistitemA list item in a SegmentedList
segmentedlistA list of sets of units
segtitleA title that pertains to one Seg in each SegListItem
seriesinfoFor a book that's part of a series
seriesinfo[4.0] Information about the publication series of which a book is a part
seriesvolnumsThe numbers of volumes in a Series, in SeriesInfo
setTwo or more Books
setindexIndex to a Set
setindexinfo[4.0] Meta-data for a SetIndex
setinfoMetainformation for a Set
sgmltagAn element tag in SGML or XML
shortaffilBrief version of an Affiliation
shortcutA keyboard shortcut for a menu item
sidebarPortion of a document that is separated from the flow of the main text, usually boxed and floating
sidebarinfo[4.0] Meta-data for a Sidebar
simparaA paragraph that is only a text block, without included block-oriented elements
simplelistAn undecorated list of short words or phrases (like HTML's LI COMPACT)
simplemsgentry[4.0] A simpler MsgSet entry
simplesectA section of a document with no subdivisions
spanspecFormatting information for a spanned column in a TGroup in a table
stateState or Province in an Address
stepPart of a Procedure
streetPart of Address
structfieldA field in a structure (like a Pascal record or C struct)
structnameThe name of a Structure
subjectContains one ore more subjectterm elements (q.v.)
subjectsetA set of subjects describing the document
subjecttermA word or phrase from a controlled vocabulary (see Chapter 23)
subscriptA subscript (like HTML 's SUB)
substepsA wrapper for Steps within Steps
subtitleSubtitle of a document
superscriptA superscript, like HTML's SUP
surnameA family or last name
symbolA name that is replaced by a value before processing
synopfragmentPart of CmdSynopsis
synopfragmentrefPart of a CmdSynopsis
synopsisThe syntax of a command or function
systemitemAny system-related item
tableA table, with title and one or more tgroups
tbodyWrapper for the Rows of a Table or InformalTable
termThe phrase being defined in a variable list
tertiaryA third-level index item
tertiaryieLike tertiary but in an index entry rather than in running text
textobjectcontains a textual description of a media object and any associated metadata
tfootoptional part of TGroup for footers at the bottom of each page of a table
tgroupThe main part of a table
theadRunning headers at the top of a table on every page
tipA suggestion to the user, set off from the text
titleThe text of a heading or the title of a block-oriented element
titleabbrevAn optional, abbreviated version of any Title
tocA Table of Contents
tocbackEntry for back matter in a ToC
tocchapTable of contents entry for a chapter or other component
tocentryThe title of a component as shown in a table of contents
tocfrontTable of contents entry for front matter components
toclevel1Top-level entry in a toc for a chapter, etc.
toclevel2Level 2 toc entry
toclevel3Level 3 toc entry
toclevel4Level 4 toc entry
toclevel5Level 5 toc entry
tocpartA table of contents entry in a toc for a part
tokenA unit of information in the context of lexical analysis
trademarkA trademark
typeIndicates the classification of a value
ulinkA link containing a URL (like HTML's A)
userinputData entered by the user
varargsAn empty element in a FuncSynopsis, for functions with a variable number of arguments
variablelistAn optionally titled list of VarListEntries (a bit like HTML's DL)
varlistentryA component of VariableList
varnameThe name of a variable
videodataPoints to external video data
videoobjectContains videodata and associated metadata
voidAn empty element in a function synopsis, showing that a function takes no arguments
volumenumThe number of a Book in relation to Set, or of a journal, when Book is used to represent a journal by containing Articles
warningAn admonition set off from the text
wordaswordA word (or letter or number) used not to represent the thing or idea it usually represents, but merely as the word itself
xrefCross reference link to another part of the document
yearYear of publication, for use in Copyright