IDocBook Element Reference

Table of Contents
  • *:* — Any element from almost any namespace
  • abbrev — An abbreviation, especially one followed by a period
  • abstract — A summary
  • accel — A graphical user interface (GUI) keyboard shortcut
  • acknowledgements — Acknowledgements of a book or other componentV5.0
  • acronym — An often pronounceable word made from the initial (or selected) letters of a name or phrase
  • address — A real-world address, generally a postal address
  • affiliation — The institutional affiliation of an individual
  • alt — A text-only annotation, often used for accessibility
  • anchor — A spot in the document
  • annotation — An annotation
  • answer — An answer to a question posed in a qandaset
  • appendix — An appendix in a book or article
  • application — The name of a software program
  • arc — An XLink arc in an extendedlinkV5.0
  • area (db.area) — A region defined for a callout in a graphic or code example
  • area (db.area.inareaset) — A region defined for a callout in a graphic or code example
  • areaset — A set of related areas in a graphic or code example
  • areaspec — A collection of regions in a graphic or code example
  • arg — An argument in a cmdsynopsis
  • article — An article
  • artpagenums — The page numbers of an article as published
  • attribution — The source of a block quote or epigraph
  • audiodata — Pointer to external audio data
  • audioobject — A wrapper for audio data and its associated meta-information
  • author — The name of an individual author
  • authorgroup — Wrapper for author information when a document has multiple authors or collaborators
  • authorinitials — The initials or other short identifier for an author
  • bibliocoverage — The spatial or temporal coverage of a document
  • bibliodiv — A section of a bibliography
  • biblioentry — A raw entry in a bibliography
  • bibliography — A bibliography
  • biblioid — An identifier for a documentV5.0
  • bibliolist — A wrapper for a list of bibliography entries
  • bibliomisc — Untyped bibliographic information
  • bibliomixed — A cooked entry in a bibliography
  • bibliomset — A cooked container for related bibliographic information
  • biblioref — A cross-reference to a bibliographic entry
  • bibliorelation — The relationship of a document to another
  • biblioset — A raw container for related bibliographic information
  • bibliosource — The source of a document
  • blockquote — A quotation set off from the main text
  • book — A book
  • bridgehead — A free-floating heading
  • buildtarget — Target of a buildV5.2
  • callout — A called out description of a marked area
  • calloutlist — A list of callout s
  • caption (db.caption) — A caption
  • caption (db.html.caption) — An HTML table caption
  • caution — A note of caution
  • chapter — A chapter, as of a book
  • citation — An inline bibliographic reference to another published work
  • citebiblioid — A citation of a bibliographic identifier
  • citerefentry — A citation to a reference page
  • citetitle — The title of a cited work
  • city — The name of a city in an address
  • classname — The name of a class, in the object-oriented programming sense
  • classsynopsis — The syntax summary for a class definition
  • classsynopsisinfo — Information supplementing the contents of a classsynopsis
  • cmdsynopsis — A syntax summary for a software command
  • co — The location of a callout embedded in text
  • code — An inline code fragment
  • col — Specifications for a column in an HTML table
  • colgroup — A group of columns in an HTML table
  • collab — Identifies a collaborator
  • colophon — Text at the back of a book describing facts about its production
  • colspec — Specifications for a column in a table
  • command — The name of an executable program or other software command
  • computeroutput — Data, generally text, displayed or presented by a computer
  • confdates — The dates of a conference for which a document was written
  • confgroup — A wrapper for document meta-information about a conference
  • confnum — An identifier, frequently numerical, associated with a conference for which a document was written
  • confsponsor — The sponsor of a conference for which a document was written
  • conftitle — The title of a conference for which a document was written
  • constant — A programming or system constant
  • constraint — A constraint in an EBNF production
  • constraintdef — The definition of a constraint in an EBNF production
  • constructorsynopsis — A syntax summary for a constructor
  • contractnum — The contract number of a document
  • contractsponsor — The sponsor of a contract
  • contrib — A summary of the contributions made to a document by a credited source
  • copyright — Copyright information about a document
  • coref — A cross reference to a co
  • country — The name of a country
  • cover — Additional content for the cover of a publicationV5.0
  • danger — An admonition set off from the text indicating hazardous situationV5.2
  • database — The name of a database, or part of a database
  • date — The date of publication or revision of a document
  • dedication — The dedication of a book or other component
  • destructorsynopsis — A syntax summary for a destructor
  • edition — The name or number of an edition of a document
  • editor — The name of the editor of a document
  • email — An email address
  • emphasis (db._emphasis) — A limited span of emphasized text
  • emphasis (db.emphasis) — Emphasized text
  • entry — A cell in a table
  • entrytbl — A subtable appearing in place of an entry in a table
  • enumidentifier — The identifier of a value an enumerated type can takeV5.2
  • enumitem — A value an enumerated type can take and its descriptionV5.2
  • enumitemdescription — The description of a value an enumerated type can takeV5.2
  • enumname — The name of an enumerationV5.2
  • enumsynopsis — The syntax summary for an enumerated-type definitionV5.2
  • enumvalue — The value an enumerated type can takeV5.2
  • envar — A software environment variable
  • epigraph — A short inscription at the beginning of a document or component
  • equation — A displayed mathematical equation
  • errorcode — An error code
  • errorname — An error name
  • errortext — An error message.
  • errortype — The classification of an error message
  • example — A formal example, with a title
  • exceptionname — The name of an exception
  • extendedlink — An XLink extended linkV5.0
  • fax — A fax number
  • fieldsynopsis — The name of a field in a class definition
  • figure — A formal figure, generally an illustration, with a title
  • filename — The name of a file
  • firstname — A given name of a person
  • firstterm (db._firstterm) — The first occurrence of a term, with limited contentV5.1
  • firstterm (db.firstterm) — The first occurrence of a term
  • footnote — A footnote
  • footnoteref — A cross reference to a footnote (a footnote mark)
  • foreignphrase (db._foreignphrase) — A limited word or phrase in a language other than the primary language of the documentV5.1
  • foreignphrase (db.foreignphrase) — A word or phrase in a language other than the primary language of the document
  • formalgroup — A group of formal objects, for example subfiguresV5.2
  • formalpara — A paragraph with a title
  • funcdef — A function (subroutine) name and its return type
  • funcparams — Parameters for a function referenced through a function pointer in a synopsis
  • funcprototype — The prototype of a function
  • funcsynopsis — The syntax summary for a function definition
  • funcsynopsisinfo — Information supplementing the funcdefs of a funcsynopsis
  • function — The name of a function or subroutine, as in a programming language
  • givenname — The given name of a personV5.1
  • glossary — A glossary
  • glossdef — A definition in a glossentry
  • glossdiv — A division in a glossary
  • glossentry — An entry in a glossary or glosslist
  • glosslist — A wrapper for a list of glossary entries
  • glosssee — A cross-reference from one glossentry to another
  • glossseealso — A cross-reference from one glossentry to another
  • glossterm (db._glossterm) — A glossary termV5.1
  • glossterm (db.glossterm) — A glossary term
  • group (db.group) — A group of elements in a cmdsynopsis
  • group (db.group.methodparam) — A group of method parametersV5.1
  • group (db.group.paramdef) — A group of parametersV5.1
  • guibutton — The text on a button in a GUI
  • guiicon — Graphic and/or text appearing as a icon in a GUI
  • guilabel — The text of a label in a GUI
  • guimenu — The name of a menu in a GUI
  • guimenuitem — The name of a terminal menu item in a GUI
  • guisubmenu — The name of a submenu in a GUI
  • hardware — A physical part of a computer system
  • holder — The name of the individual or organization that holds a copyright
  • honorific — The title of a person
  • imagedata (db.imagedata) — Pointer to external image data
  • imagedata (db.imagedata.mathml) — A MathML expression in a media object
  • imagedata (db.imagedata.svg) — An SVG drawing in a media object
  • imageobject — A wrapper for image data and its associated meta-information
  • imageobjectco — A wrapper for an image object with callouts
  • important — An admonition set off from the text
  • index — An index to a book or part of a book
  • indexdiv — A division in an index
  • indexentry — An entry in an index
  • indexterm (db.indexterm.endofrange) — Identifies the end of a range associated with an indexed term
  • indexterm (db.indexterm.singular) — A wrapper for an indexed term
  • indexterm (db.indexterm.startofrange) — A wrapper for an indexed term that covers a range
  • info (db.info) — A wrapper for information about a component or other blockV5.0
  • info (db.titleforbidden.info) — A wrapper for information about a component or other block without a titleV5.0
  • info (db.titleonly.info) — A wrapper for information about a component or other block with only a titleV5.0
  • info (db.titleonlyreq.info) — A wrapper for information about a component or other block with only a required titleV5.0
  • info (db.titlereq.info) — A wrapper for information about a component or other block with a required titleV5.0
  • informalequation — A displayed mathematical equation without a title
  • informalexample — A displayed example without a title
  • informalfigure — A untitled figure
  • informaltable (db.html.informaltable) — An HTML table without a title
  • informaltable (db.cals.informaltable) — A table without a title
  • initializer — The initializer for a fieldsynopsis
  • inlineequation — A mathematical equation or expression occurring inline
  • inlinemediaobject — An inline media object (video, audio, image, and so on)
  • interfacename — The name of an interface
  • issuenum — The number of an issue of a journal
  • itemizedlist — A list in which each entry is marked with a bullet or other dingbat
  • itermset — A set of index terms in the meta-information of a document
  • jobtitle — The title of an individual in an organization
  • keycap — The text printed on a key on a keyboard
  • keycode — The internal, frequently numeric, identifier for a key on a keyboard
  • keycombo — A combination of input actions
  • keysym — The symbolic name of a key on a keyboard
  • keyword — One of a set of keywords describing the content of a document
  • keywordset — A set of keywords describing the content of a document
  • label — A label on a question or answer
  • legalnotice — A statement of legal obligations or requirements
  • lhs — The left-hand side of an EBNF production
  • lineage — The portion of a person's name indicating a relationship to ancestors
  • lineannotation — A comment on a line in a verbatim listing
  • link — A hypertext link
  • listitem — A wrapper for the elements of a list item
  • literal — Inline text that is some literal value
  • literallayout — A block of text in which line breaks and white space are to be reproduced faithfully
  • locator — An XLink locator in an extendedlinkV5.0
  • macrodef — A macro name and its return typeV5.2
  • macroname — The name of a macro (a code-generating function)V5.2
  • macroprototype — The prototype of a macro (code-generating function)V5.2
  • macrosynopsis — The syntax summary for a macro definition (code-generating function)V5.2
  • manvolnum — A reference volume number
  • markup — A string of formatting markup in text that is to be represented literally
  • mathphrase — A mathematical phrase that can be represented with ordinary text and a small amount of markup
  • mediaobject — A displayed media object (video, audio, image, etc.)
  • member — An element of a simple list
  • menuchoice — A selection or series of selections from a menu
  • meta (db.meta.content) — A generic metadata elementV5.2
  • meta (db.meta.empty) — A generic metadata elementV5.2
  • methodname — The name of a method
  • methodparam — Parameters to a method
  • methodsynopsis — A syntax summary for a method
  • mml:* — Any element from the MathML namespace
  • modifier — Modifiers in a synopsis
  • mousebutton — The conventional name of a mouse button
  • msg — A message in a message set
  • msgaud — The audience to which a message in a message set is relevant
  • msgentry — A wrapper for an entry in a message set
  • msgexplan — Explanatory material relating to a message in a message set
  • msginfo — Information about a message in a message set
  • msglevel — The level of importance or severity of a message in a message set
  • msgmain — The primary component of a message in a message set
  • msgorig — The origin of a message in a message set
  • msgrel — A related component of a message in a message set
  • msgset — A detailed set of messages, usually error messages
  • msgsub — A subcomponent of a message in a message set
  • msgtext — The actual text of a message component in a message set
  • multimediaparam — Application specific parameters for a media playerV5.1
  • nonterminal — A non-terminal in an EBNF production
  • note — A message set off from the text
  • olink — A link that addresses its target indirectly
  • ooclass — A class in an object-oriented programming language
  • ooexception — An exception in an object-oriented programming language
  • oointerface — An interface in an object-oriented programming language
  • option — An option for a software command
  • optional — Optional information
  • orderedlist — A list in which each entry is marked with a sequentially incremented label
  • org — An organization and associated metadataV5.0
  • orgdiv — A division of an organization
  • orgname — The name of an organization
  • otheraddr — Uncategorized information in address
  • othercredit — A person or entity, other than an author or editor, credited in a document
  • othername — A component of a person's name that is not a first name, surname, or lineage
  • package — A software or application package
  • packagesynopsis — The syntax summary for a package definitionV5.2
  • pagenums — The numbers of the pages in a book, for use in a bibliographic entry
  • para — A paragraph
  • paramdef — Information about a function parameter in a programming language
  • parameter — A value or a symbolic reference to a value
  • part — A division in a book
  • partintro — An introduction to the contents of a part
  • person — A person and associated metadataV5.0
  • personblurb — A short description or note about a person
  • personname — The personal name of an individual
  • phone — A telephone number
  • phrase (db._phrase) — A limited span of text
  • phrase (db.phrase) — A span of text
  • pob — A post office box in an address
  • postcode — A postal code in an address
  • preface — Introductory matter preceding the first chapter of a book
  • primary — The primary word or phrase under which an index term should be sorted
  • primaryie — A primary term in an index entry, not in the text
  • printhistory — The printing history of a document
  • procedure — A list of operations to be performed in a well-defined sequence
  • production — A production in a set of EBNF productions
  • productionrecap — A cross-reference to an EBNF production
  • productionset — A set of EBNF productions
  • productname — The formal name of a product
  • productnumber — A number assigned to a product
  • programlisting — A literal listing of all or part of a program
  • programlistingco — A program listing with associated areas used in callouts
  • prompt — A character or string indicating the start of an input field in a computer display
  • property — A unit of data associated with some part of a computer system
  • pubdate — The date of publication of a document
  • publisher — The publisher of a document
  • publishername — The name of the publisher of a document
  • qandadiv — A titled division in a qandaset
  • qandaentry — A question/answer set within a qandaset
  • qandaset — A question-and-answer set
  • question — A question in a qandaset
  • quote (db._quote) — A limited inline quotationV5.1
  • quote (db.quote) — An inline quotation
  • refclass — The scope or other indication of applicability of a reference entry
  • refdescriptor — A description of the topic of a reference page
  • refentry — A reference page (originally a UNIX man-style reference page)
  • refentrytitle — The title of a reference page
  • reference — A collection of reference entries
  • refmeta — Meta-information for a reference entry
  • refmiscinfo — Meta-information for a reference entry other than the title and volume number
  • refname — The name of (one of) the subject(s) of a reference page
  • refnamediv — The name, purpose, and classification of a reference page
  • refpurpose — A short (one sentence) synopsis of the topic of a reference page
  • refsect1 — A major subsection of a reference entry
  • refsect2 — A subsection of a refsect1
  • refsect3 — A subsection of a refsect2
  • refsection — A recursive section in a refentry
  • refsynopsisdiv — A syntactic synopsis of the subject of the reference page
  • releaseinfo — Information about a particular release of a document
  • remark — A remark (or comment) intended for presentation in a draft manuscript
  • replaceable — Content that may or must be replaced by the user
  • result — A wrapper for identifying the results of a procedure or stepV5.1
  • returnvalue — The value returned by a function
  • revdescription — A extended description of a revision to a document
  • revhistory — A history of the revisions to a document
  • revision — An entry describing a single revision in the history of the revisions to a document
  • revnumber — A document revision number
  • revremark — A description of a revision to a document
  • rhs — The right-hand side of an EBNF production
  • row (db.entrytbl.row) — A row in a table
  • row (db.row) — A row in a table
  • sbr — An explicit line break in a command synopsis
  • screen — Text that a user sees or might see on a computer screen
  • screenco — A screen with associated areas used in callouts
  • screenshot — A representation of what the user sees or might see on a computer screen
  • secondary — A secondary word or phrase in an index term
  • secondaryie — A secondary term in an index entry, rather than in the text
  • sect1 — A top-level section of document
  • sect2 — A subsection within a sect1
  • sect3 — A subsection within a sect2
  • sect4 — A subsection within a sect3
  • sect5 — A subsection within a sect4
  • section — A recursive section
  • see — Part of an index term directing the reader instead to another entry in the index
  • seealso — Part of an index term directing the reader also to another entry in the index
  • seealsoie — A See also entry in an index, rather than in the text
  • seeie — A See entry in an index, rather than in the text
  • seg — An element of a list item in a segmented list
  • seglistitem — A list item in a segmented list
  • segmentedlist — A segmented list, a list of sets of elements
  • segtitle — The title of an element of a list item in a segmented list
  • seriesvolnums — Numbers of the volumes in a series of books
  • set — A collection of books
  • setindex — An index to a set of books
  • shortaffil — A brief description of an affiliation
  • shortcut — A key combination for an action that is also accessible through a menu
  • sidebar — A portion of a document that is isolated from the main narrative flow
  • simpara — A paragraph that contains only text and inline markup, no block elements
  • simplelist — An undecorated list of single words or short phrases
  • simplemsgentry — A wrapper for a simpler entry in a message set
  • simplesect — A section of a document with no subdivisions
  • spanspec — Formatting information for a spanned column in a table
  • specializedtemplate — The specialization of a template identifier, in the generic programming senseV5.2
  • state — A state or province in an address
  • step — A unit of action in a procedure
  • stepalternatives — Alternative steps in a procedure
  • street — A street address in an address
  • subject — One of a group of terms describing the subject matter of a document
  • subjectset — A set of terms describing the subject matter of a document
  • subjectterm — A term in a group of terms describing the subject matter of a document
  • subscript — A subscript (as in H₂O, the molecular formula for water)
  • substeps — A wrapper for steps that occur within steps in a procedure
  • subtitle — The subtitle of a document
  • superscript — A superscript (as in x², the mathematical notation for x multiplied by itself)
  • surname — An inherited or family name; in western cultures the last name
  • svg:* — Any element from the SVG namespace
  • symbol — A name that is replaced by a value before processing
  • synopfragment — A portion of a cmdsynopsis broken out from the main body of the synopsis
  • synopfragmentref — A reference to a fragment of a command synopsis
  • synopsis — A general-purpose element for representing the syntax of commands or functions
  • synopsisinfo — Information supplementing synopsisV5.2
  • systemitem — A system-related item or term
  • table (db.html.table) — A formal (captioned) HTML table in a document
  • table (db.cals.table) — A formal table in a document
  • tag — A component of XML (or SGML) markupV5.0
  • task — A task to be completed
  • taskprerequisites — The prerequisites for a task
  • taskrelated — Information related to a task
  • tasksummary — A summary of a task
  • tbody (db.cals.entrytbl.tbody) — A wrapper for the rows of a table or informal table
  • tbody (db.html.tbody) — A wrapper for the rows of an HTML table or informal HTML table
  • tbody (db.cals.tbody) — A wrapper for the rows of a table or informal table
  • td — A table entry in an HTML table
  • template — The definition of a template, in the generic programming senseV5.2
  • templatename — The identifier for a template, in the generic programming senseV5.2
  • term — The word or phrase being defined or described in a variable list
  • termdef — An inline definition of a term
  • tertiary — A tertiary word or phrase in an index term
  • tertiaryie — A tertiary term in an index entry, rather than in the text
  • textdata — Pointer to external text data
  • textobject — A wrapper for a text description of an object and its associated meta-information
  • tfoot (db.html.tfoot) — A table footer consisting of one or more rows in an HTML table
  • tfoot (db.cals.tfoot) — A table footer consisting of one or more rows
  • tgroup — A wrapper for the main content of a table, or part of a table
  • th — A table header entry in an HTML table
  • thead (db.cals.entrytbl.thead) — A table header consisting of one or more rows
  • thead (db.html.thead) — A table header consisting of one or more rows in an HTML table
  • thead (db.cals.thead) — A table header consisting of one or more rows
  • tip — A suggestion to the user, set off from the text
  • title — The text of the title of a section of a document or of a formal block-level element
  • titleabbrev — The abbreviation of a title
  • toc — A table of contents
  • tocdiv — A division in a table of contentsV5.0
  • tocentry — A component title in a table of contents
  • token — A unit of information
  • topic — A modular unit of documentation not part of any particular narrative flowV5.1
  • tr — A row in an HTML table
  • trademark — A trademark
  • type — The classification of a value
  • typedefname — The name of a type aliasV5.2
  • typedefsynopsis — The syntax summary for a type-alias definitionV5.2
  • union — The definition of a union of types, which may be more than a nameV5.2
  • unionname — The name of a union of typesV5.2
  • unionsynopsis — The syntax summary for a union-of-types definitionV5.2
  • uri — A Uniform Resource Identifier
  • userinput — Data entered by the user
  • varargs — An empty element in a function synopsis indicating a variable number of arguments
  • variablelist — A list in which each entry is composed of a set of one or more terms and an associated description
  • varlistentry — A wrapper for a set of terms and the associated description in a variable list
  • varname — The name of a variable
  • videodata — Pointer to external video data
  • videoobject — A wrapper for video data and its associated meta-information
  • void — An empty element in a function synopsis indicating that the function in question takes no arguments
  • volumenum — The volume number of a document in a set (as of books in a set or articles in a journal)
  • warning — An admonition set off from the text
  • wordasword — A word meant specifically as a word and not representing anything else
  • xref — A cross reference to another part of the document
  • year — The year of publication of a document

This reference describes every element in DocBook V5.0.

1Organization of Reference Pages

The description of each element in this reference is divided into the following sections:

Synopsis

Provides a quick synopsis of the element. The content of the synopsis varies according to the nature of the element described, but may include any or all of the following sections:

Content Model

Describes the content model of the element, the mixture of things that it can contain. See Section 1.1, “Understanding Content Models”.

Attributes

Provides a synopsis of the attributes on the element. For brevity, common attributes are described only once, in this introduction. Likewise, common linking attributes are described once.

Additional Constraints

Provides a synopsis of any additional constraints on the element. These constraints are expressed using Schematron in the RELAX NG grammar.

Description

Describes the semantics of the element.

Processing expectations

Summarizes specific formatting expectations of the element. Many processing expectations are influenced by attribute values. Be sure to consult the description of element attributes as well.

Future changes

Identifies changes that are scheduled for future versions of the schema. These changes are highlighted because they involve some backward incompatibility that may make currently valid DocBook documents no longer valid under the new version.

Attributes

Describes the semantics of each attribute.

See Also

Lists similar or related elements.

Examples

Provides examples of proper usage for the element. Generally, the smallest example required to reasonably demonstrate the element is used. In many cases, a formatted version of the example is also shown.

All of the examples in the book are valid according to the RELAX NG grammar.

Formatted examples are indicated using a vertical bar.

1.1Understanding Content Models

Each element synopsis begins with a description of its content model. Content models are the way that grammars describe the name, number, and order of other elements that may be used inside an element.

1.1.1Content models and validity

A validator uses the content models to determine if a given document is valid. In order for a document to be valid, the content of every element in the document must match the content model for that element.

In practical terms, match means that it must be possible to expand the content model until it exactly matches the sequence of elements in the document.

For example, consider the content model of the epigraph:

epigraph ::= (info?db.titleforbidden.info, attribution?,(literallayout | Paragraph elements)+)

Does the following example match that content model?

  |<epigraph>
  |<para>Some text</para>
  |</epigraph>

Yes, it is valid because the following expansion of the content model exactly matches the actual content: choose zero occurrences of info, choose zero occurrences of attribution, choose the alternative para from the Paragraph elements choice, and choose to let the one or more match once.

By the same token, this example is not valid because there is no expansion of the content model that can match it:

  |<epigraph>
  |<para>Some text</para>
  |<attribution>John Doe</attribution>
  |</epigraph>

2Common Attributes

There are many common attributes that occur on every DocBook element. They are summarized here for brevity and to make the additional attributes that occur on many elements stand out.

NameType
*:*text
annotationstext
dir
Enumeration:
ltr
rtl
lro
rlo
remaptext
revisionflag
Enumeration:
changed
added
deleted
off
roletext
trans:idfixup
Enumeration:
none
suffix
auto
trans:linkscope
Enumeration:
user
local
near
global
trans:suffixtext
versiontext
xml:baseanyURI
xml:idID
xml:langtext
xreflabeltext
*:*

Any attribute in an other explicit namespace. Any number of attributes that are in an explicit namespace other than the DocBook, XML, XLink, or transclusion namespaces are allowed.

annotations

Identifies one or more annotations that apply to this element.

dir

Identifies the direction of text in an element.

ltr

Left-to-right text

rtl

Right-to-left text

lro

Left-to-right override

rlo

Right-to-left override

remap

Provides the name or similar semantic identifier assigned to the content in some previous markup scheme.

revisionflag

Identifies the revision status of the element.

changed

The element has been changed.

added

The element is new (has been added to the document).

deleted

The element has been deleted.

off

Explicitly turns off revision markup for this element.

role

Provides additional, user-specified classification for an element.

While role is a common attribute in the sense that it occurs on all DocBook elements, customizers will find that it is not part of any of the “common attribute” patterns. It is parameterized differently because it is useful to be able to subclass role independently on different elements.

trans:idfixup

The transclusion ID fixup strategy.

none

No ID fixup strategy

suffix

ID fixup by concatenating suffixes

auto

ID fixup by creating unique values

trans:linkscope

The transclusion link scope adjustment.

user

No link scope adjustments are made

local

The link scopes are adjusted with the suffix property

near

The link scopes are adjusted based on proximity

global

The link scopes are adjusted based on document order

trans:suffix

The transclusion suffix to use when the suffix ID fixup strategy is employed.

version

Specifies the DocBook version of the element and its descendants.

xml:base

Specifies the base URI of the element and its descendants.

xml:id

Identifies the unique ID value of the element.

xml:lang

Specifies the natural language of the element and its descendants.

xreflabel

Provides the text that is to be generated for a cross reference to the element.

2.1Common Effectivity Attributes

The common attributes include a collection of effectivity attributes. These attributes are available for authors to identify to whom a particular element applies. Effectivity attributes are often used for profiling: building documents that contain information only relevant to a particular audience.

For example, a section might be identified as available only to readers with a top-secret security clearance or a paragraph might be identified as affecting only users running the implementation provided by a particular vendor.

NameType
archtext
audiencetext
conditiontext
conformancetext
ostext
outputformattext
revisiontext
securitytext
userleveltext
vendortext
wordsizetext
arch

Designates the computer or chip architecture to which the element applies.

audience

Designates the intended audience to which the element applies, for example, system administrators, programmers, or new users.

condition

provides a standard place for application-specific effectivity.

Many DocBook users observed that in order to add an effectivity condition that was unique to their environment required abusing the semantics of one of the existing attributes, or adding their own, making their customization an extension rather than a subset. Thecondition attribute is a general-purpose effectivity attribute with no specified semantics.

Thecondition attribute provides a standard place for application-specific effectivity.

conformance

Indicates standards conformance characteristics of the element.

These characteristics are application-specific; DocBook provides no default semantics.

os

Indicates the operating system to which the element is applicable.

outputformat

Indicates the output format (for example, print or epub) to which the element applies.

revision

Indicates the editorial revision to which the element belongs.

security

Indicates something about the security level associated with the element to which it applies.

userlevel

Indicates the level of user experience for which the element applies.

vendor

Indicates the computer vendor to which the element applies.

wordsize

Indicates the word size (width in bits) of the computer architecture to which the element applies.

The names of the effectivity attributes are suggestive of several classes of common effectivity information. The semantically neutral condition attribute was added to give authors a place to put values that don’t fit neatly into one of the other alternatives.

In authoring environments where many different kinds of effectivity information are required, it’s not uncommon to see local extensions that add new attributes. It’s also not uncommon to see attributes used without regard to the class of information suggested by the name.

2.2Common RDFa Lite Attributes

The RDFa Lite attributes incorporate support for RDFa into DocBook.

NameType
prefixtext
propertytext
resourcetext
typeoftext
vocabanyURI
prefix

The RDFa Lite prefix.

property

The RDFa Lite property.

resource

The RDFa Lite resource.

typeof

The RDFa Lite typeof.

vocab

The RDFa Lite vocab.

See RDFa Lite 1.1 for more details about the RDFa Lite attributes.

2.3Common Transclusion Attributes

The transclusion attributes incorporate support for DocBook transclusion.

NameType

See DocBook Transclusion for more details about the transclusion attributes.

3Common Linking Attributes

The following attributes occur on all elements that can be the start of a link. They are summarized here once for brevity and to make the additional attributes that occur on many elements stand out.

NameType
linkend/linkendsIDREF/IDREFS
xlink:actuate
Enumeration:
onLoad
onRequest
other
none
xlink:arcroleanyURI
xlink:fromNMTOKEN
xlink:hrefanyURI
xlink:labelNMTOKEN
xlink:roleanyURI
xlink:show
Enumeration:
new
replace
embed
other
none
xlink:titletext
xlink:toNMTOKEN
xlink:typetext
linkend/linkends

Points to an internal link target by identifying the value of its xml:id attribute.

xlink:actuate

Identifies the XLink actuate behavior of the link.

onLoad

An application should traverse to the ending resource immediately on loading the starting resource.

onRequest

An application should traverse from the starting resource to the ending resource only on a post-loading event triggered for the purpose of traversal.

other

The behavior of an application traversing to the ending resource is unconstrained by this specification. The application should look for other markup present in the link to determine the appropriate behavior.

none

The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior.

xlink:arcrole

Identifies the XLink arcrole of the link.

xlink:from

Specifies the XLink traversal-from.

xlink:href

Identifies a link target with a URI.

xlink:label

Specifies the XLink label.

xlink:role

Identifies the XLink role of the link.

DocBook uses the XLink role value http://docbook.org/xlink/role/olink to identify linking elements with OLink semantics. That means the part of xlink:href before the number sign (#) is to be interpreted as equivalent to the olink targetdoc attribute value, and the part after the number sign as the olink targetptr attribute value.

xlink:show

Identifies the XLink show behavior of the link.

new

An application traversing to the ending resource should load it in a new window, frame, pane, or other relevant presentation context.

replace

An application traversing to the ending resource should load the resource in the same window, frame, pane, or other relevant presentation context in which the starting resource was loaded.

embed

An application traversing to the ending resource should load its presentation in place of the presentation of the starting resource.

other

The behavior of an application traversing to the ending resource is unconstrained by XLink. The application should look for other markup present in the link to determine the appropriate behavior.

none

The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior.

xlink:title

Identifies the XLink title of the link.

xlink:to

Specifies the XLink traversal-to.

xlink:type

Identifies the XLink link type.