Appendix G. DocBook Quick Reference
Element | Brief Description |
---|---|
An abbreviation, especially one followed by a period | |
A summary | |
A graphical user interface (GUI) keyboard shortcut | |
Acknowledgements in an | |
An often pronounceable word made from the initial (or selected) letters of a name or phrase | |
A response to a user event | |
A real-world address, generally a postal address | |
The institutional affiliation of an individual | |
Text representation for a graphical element | |
A spot in the document | |
An answer to a question posed in a | |
The name of a software program | |
A region defined for a | |
A set of related areas in a graphic or code example | |
A collection of regions in a graphic or code example | |
An argument in a | |
| Meta-information for an |
The page numbers of an article as published | |
An article | |
The source of a block quote or epigraph | |
Pointer to external audio data | |
A wrapper for audio data and its associated meta-information | |
The name of an individual author | |
A short description or note about an author | |
Wrapper for author information when a document has multiple authors or collabarators | |
The initials or other short identifier for an author | |
The location of a page break in a print version of the document | |
A section of a | |
An entry in a | |
A “cooked” container for related bibliographic information | |
Untyped bibliographic information | |
An entry in a | |
A “raw” container for related bibliographic information | |
A bibliography | |
A quotation set off from the main text | |
A book | |
| Meta-information about a book used in a bibliographical citation |
Meta-information for a Book | |
A free-floating heading | |
The location of a callout embedded in text | |
A “called out” description of a marked | |
A list of | |
A caption | |
A note of caution | |
A chapter, as of a book | |
An inline bibliographic reference to another published work | |
A citation to a reference page | |
The title of a cited work | |
The name of a city in an address | |
The name of a class, in the object-oriented programming sense | |
A syntax summary for a software command | |
Specifications for a column in a table | |
Identifies a collaborator | |
The name of a collaborator | |
Text at the back of a book describing facts about its production | |
The name of an executable program or other software command | |
| A comment intended for presentation in a draft manuscript |
Data, generally text, displayed or presented by a computer | |
The dates of a conference for which a document was written | |
A wrapper for document meta-information about a conference | |
An identifier, frequently numerical, associated with a conference for which a document was written | |
The sponsor of a conference for which a document was written | |
The title of a conference for which a document was written | |
A programming or system constant | |
The contract number of a document | |
The sponsor of a contract | |
A summary of the contributions made to a document by a credited source | |
Copyright information about a document | |
A corporate author, as opposed to an individual | |
The name of a corporation | |
The name of a country | |
The name of a database, or part of a database | |
The date of publication or revision of a document | |
A wrapper for the dedication section of a book | |
| Meta-data for a book component |
The name or number of an edition of a document | |
The name of the editor of a document | |
An email address | |
Emphasized text | |
A software environment variable | |
A cell in a table | |
A subtable appearing in place of an | |
A short inscription at the beginning of a document or component | |
A displayed mathematical equation | |
An error code | |
An error name | |
The classification of an error message | |
A formal example, with a title | |
A fax number | |
A formal figure, generally an illustration, with a title | |
The name of a file | |
The first name of a person | |
The first occurrence of a term | |
A footnote | |
A cross reference to a footnote (a footnote mark) | |
A word or phrase in a language other than the primary language of the document | |
A paragraph with a title | |
A function (subroutine) name and its return type | |
Parameters for a function referenced through a function pointer in a synopsis | |
The prototype of a function | |
The syntax summary for a function definition | |
Information supplementing the | |
The name of a function or subroutine, as in a programming language | |
The text on a button in a GUI | |
Graphic and/or text appearing as a icon in a GUI | |
The text of a label in a GUI | |
The name of a menu in a GUI | |
The name of a terminal menu item in a GUI | |
The name of a submenu in a GUI | |
A definition in a | |
A division in a | |
A wrapper for a set of | |
A cross-reference from one | |
A cross-reference from one | |
A glossary term | |
A glossary | |
A displayed graphical object (not an inline) | |
A graphic that contains callout areas | |
A group of elements in a | |
A physical part of a computer system | |
A summary of the main points of the discussed component | |
The name of the individual or organization that holds a copyright | |
The title of a person | |
The International Standard Book Number of a document | |
The International Standard Serial Number of a periodical | |
A set of index terms in the meta-information of a document | |
Pointer to external image data | |
A wrapper for image data and its associated meta-information | |
A wrapper for an image object with callouts | |
An admonition set off from the text | |
An index | |
A division in an index | |
An entry in an index | |
A wrapper for terms to be indexed | |
A displayed mathematical equation without a title | |
A displayed example without a title | |
A untitled figure | |
A table without a title | |
A mathematical equation or expression occurring inline | |
An object containing or pointing to graphical data that will be rendered inline | |
An inline media object (video, audio, image, and so on) | |
An element of a GUI | |
| The name of a formal specification of a GUI |
An inventory part number | |
The number of an issue of a journal | |
A list in which each entry is marked with a bullet or other dingbat | |
The title of an individual in an organization | |
The text printed on a key on a keyboard | |
The internal, frequently numeric, identifier for a key on a keyboard | |
A combination of input actions | |
The symbolic name of a key on a keyboard | |
One of a set of keywords describing the content of a document | |
A set of keywords describing the content of a document | |
A statement of legal obligations or requirements | |
A comment on a line in a verbatim listing | |
The portion of a person's name indicating a relationship to ancestors | |
A hypertext link | |
A wrapper for the elements of a list item | |
Inline text that is some literal value | |
A block of text in which line breaks and white space are to be reproduced faithfully | |
A list of the titles of formal objects (as tables or figures) in a document | |
An entry in a list of titles | |
A reference volume number | |
A string of formatting markup in text that is to be represented literally | |
A name that identifies the physical medium on which some information resides | |
A displayed media object (video, audio, image, etc.) | |
A media object that contains callouts | |
An element of a simple list | |
A selection or series of selections from a menu | |
Application-specific information necessary for the completion of an OLink | |
The conventional name of a mouse button | |
A message in a message set | |
The audience to which a message in a message set is relevant | |
A wrapper for an entry in a message set | |
Explanatory material relating to a message in a message set | |
Information about a message in a message set | |
The level of importance or severity of a message in a message set | |
The primary component of a message in a message set | |
The origin of a message in a message set | |
A related component of a message in a message set | |
A detailed set of messages, usually error messages | |
A subcomponent of a message in a message set | |
The actual text of a message component in a message set | |
A message set off from the text | |
A link that addresses its target indirectly, through an entity | |
Meta-information for an object | |
An option for a software command | |
Optional information | |
A list in which each entry is marked with a sequentially incremented label | |
A division of an organization | |
The name of an organization other than a corporation | |
Uncategorized information in address | |
A person or entity, other than an author or editor, credited in a document | |
A component of a persons name that is not a first name, surname, or lineage | |
A post office box in an address | |
The numbers of the pages in a book, for use in a bibliographic entry | |
A paragraph | |
Information about a function parameter in a programming language | |
A value or a symbolic reference to a value | |
A division in a book | |
An introduction to the contents of a part | |
A telephone number | |
A span of text | |
A postal code in an address | |
Introductory matter preceding the first chapter of a book | |
The primary word or phrase under which an index term should be sorted | |
A primary term in an index entry, not in the text | |
The printing history of a document | |
A list of operations to be performed in a well-defined sequence | |
The formal name of a product | |
A number assigned to a product | |
A literal listing of all or part of a program | |
A program listing with associated areas used in callouts | |
A character or string indicating the start of an input field in a computer display | |
A unit of data associated with some part of a computer system | |
The date of publication of a document | |
The publisher of a document | |
The name of the publisher of a document | |
A number assigned to a publication other than an ISBN or ISSN or inventory part number | |
A titled division in a | |
A question/answer set within a | |
A question-and-answer set | |
A question in a | |
An inline quotation | |
The scope or other indication of applicability of a reference entry | |
A description of the topic of a reference page | |
A reference page (originally a UNIX man-style reference page) | |
The title of a reference page | |
Meta-information for a reference entry | |
Meta-information for a reference entry other than the title and volume number | |
The name of (one of) the subject(s) of a reference page | |
The name, purpose, and classification of a reference page | |
A short (one sentence) synopsis of the topic of a reference page | |
A major subsection of a reference entry | |
Meta-information for a | |
A subsection of a | |
Meta-information for a | |
A subsection of a | |
Meta-information for a | |
A syntactic synopsis of the subject of the reference page | |
Meta-information for a RefSynopsisDiv | |
A collection of reference entries | |
Information about a particular release of a document | |
Content that may or must be replaced by the user | |
The value returned by a function | |
A history of the revisions to a document | |
A document revision number | |
A description of a revision to a document | |
An entry describing a single revision in the history of the revisions to a document | |
A row in a table | |
An explicit line break in a command synopsis | |
A component of SGML markup | |
Text that a user sees or might see on a computer screen | |
A screen with associated areas used in callouts | |
Information about how a screen shot was produced | |
A representation of what the user sees or might see on a computer screen | |
A secondary word or phrase in an index term | |
A secondary term in an index entry, rather than in the text | |
A top-level section of document | |
Meta-information for a | |
A subsection within a | |
Meta-information for a | |
A subsection within a | |
Meta-information for a | |
A subsection within a | |
Meta-information for a | |
A subsection within a | |
Meta-information for a | |
A recursive section | |
Meta-information for a recursive section | |
Part of an index term directing the reader instead to another entry in the index | |
Part of an index term directing the reader also to another entry in the index | |
A “See also” entry in an index, rather than in the text | |
A “See” entry in an index, rather than in the text | |
An element of a list item in a segmented list | |
A list item in a segmented list | |
The title of an element of a list item in a segmented list | |
A segmented list, a list of sets of elements | |
| Information about the publication series of which a book is a part |
Numbers of the volumes in a series of books | |
A collection of books | |
An index to a set of books | |
Meta-information for a | |
A brief description of an affiliation | |
A key combination for an action that is also accessible through a menu | |
A portion of a document that is isolated from the main narrative flow | |
A paragraph that contains only text and inline markup, no block elements | |
An undecorated list of single words or short phrases | |
A section of a document with no subdivisions | |
Formatting information for a spanned column in a table | |
A state or province in an address | |
A unit of action in a procedure | |
A street address in an address | |
A field in a structure (in the programming language sense) | |
The name of a structure (in the programming language sense) | |
A wrapper for steps that occur within steps in a procedure | |
One of a group of terms describing the subject matter of a document | |
A set of terms describing the subject matter of a document | |
A term in a group of terms describing the subject matter of a document | |
A subscript (as in H2O, the molecular formula for water) | |
The subtitle of a document | |
A superscript (as in x2, the mathematical notation for x multiplied by itself) | |
A family name; in western cultures the “last name” | |
A name that is replaced by a value before processing | |
A portion of a | |
A reference to a fragment of a command synopsis | |
A general-purpose element for representing the syntax of commands or functions | |
A system-related item or term | |
A wrapper for the rows of a table or informal table | |
A table footer consisting of one or more rows | |
A wrapper for the main content of a table, or part of a table | |
A table header consisting of one or more rows | |
A formal table in a document | |
The word or phrase being defined or described in a variable list | |
A tertiary word or phrase in an index term | |
A tertiary term in an index entry, rather than in the text | |
A wrapper for a text description of an object and its associated meta-information | |
A suggestion to the user, set off from the text | |
The text of the title of a section of a document or of a formal block-level element | |
The abbreviation of a | |
A table of contents | |
An entry in a table of contents for a back matter component | |
An entry in a table of contents for a component in the body of a document | |
A component title in a table of contents | |
An entry in a table of contents for a front matter component | |
A top-level entry within a table of contents entry for a chapter-like component | |
A second-level entry within a table of contents entry for a chapter-like component | |
A third-level entry within a table of contents entry for a chapter-like component | |
A fourth-level entry within a table of contents entry for a chapter-like component | |
A fifth-level entry within a table of contents entry for a chapter-like component | |
An entry in a table of contents for a part of a book | |
A unit of information | |
A trademark | |
The classification of a value | |
A link that addresses its target by means of a URL (Uniform Resource Locator) | |
Data entered by the user | |
An empty element in a function synopsis indicating a variable number of arguments | |
A wrapper for a set of terms and the associated description in a variable list | |
The name of a variable | |
A list in which each entry is composed of a set of one or more terms and an associated description | |
Pointer to external video data | |
A wrapper for video data and its associated meta-information | |
An empty element in a function synopsis indicating that the function in question takes no arguments | |
The volume number of a document in a set (as of books in a set or articles in a journal) | |
An admonition set off from the text | |
A word meant specifically as a word and not representing anything else | |
A cross reference to another part of the document | |
The year of publication of a document |
All of the elements in DocBook V3.1 except ArtHeader
, BookBiblio
, Comment
, DocInfo
, InterfaceDefinition
, SeriesInfo
plus the following additional elements:
Element | Brief Description |
---|---|
Meta-information for an | |
Meta-information for an | |
Meta-information for a | |
Meta-information for a | |
The syntax summary for a class definition | |
Information supplementing the contents of a | |
A syntax summary for a constructor | |
A syntax summary for a destructor | |
The name of an exception | |
The name of a field in a class definition | |
Meta-information for a | |
Meta-information for an | |
The initializer for a | |
The name of an interface | |
The name of a method | |
Parameters to a method | |
A syntax summary for a method | |
Modifiers in a synopsis | |
A class in an object-oriented programming language | |
An exception in an object-oriented programming language | |
An interface in an object-oriented programming language | |
Meta-information for a | |
Meta-information for a | |
Meta-information for a | |
Meta-information for a | |
A remark (or comment) intended for presentation in a draft manuscript | |
A extended description of a revision to a document | |
Meta-information for a | |
Meta-information for a | |
A wrapper for a simpler entry in a message set |
The following elements in addition to the elements in the version of DocBook to which this module is added:
Element | Brief Description |
---|---|
A constraint in an EBNF production | |
The definition of a constraint in an EBNF production | |
The left-hand side of an EBNF production | |
A non-terminal in an EBNF production | |
A production in a set of EBNF productions | |
A cross-reference to an EBNF production | |
A set of EBNF productions | |
The right-hand side of an EBNF production |
The HTML Forms Module adds the HTML Form
element and related elements.
The MathML Module adds the elements from the MathML namespace.
The SVG Module adds the elements from the SVG namespace.