DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
PrevNext

ElementBrief Description
AbbrevAn abbreviation, especially one followed by a period
AbstractA summary
AccelA graphical user interface (GUI) keyboard shortcut
AcknoAcknowledgements in an Article
AcronymAn often pronounceable word made from the initial (or selected) letters of a name or phrase
ActionA response to a user event
AddressA real-world address, generally a postal address
AffiliationThe institutional affiliation of an individual
AltText representation for a graphical element
AnchorA spot in the document
AnswerAn answer to a question posed in a QandASet
AppendixAn appendix in a Book or Article
ApplicationThe name of a software program
AreaA region defined for a Callout in a graphic or code example
AreaSetA set of related areas in a graphic or code example
AreaSpecA collection of regions in a graphic or code example
ArgAn argument in a CmdSynopsis
ArtHeaderMeta-information for an Article
ArtPageNumsThe page numbers of an article as published
ArticleAn article
AttributionThe source of a block quote or epigraph
AudioDataPointer to external audio data
AudioObjectA wrapper for audio data and its associated meta-information
AuthorThe name of an individual author
AuthorBlurbA short description or note about an author
AuthorGroupWrapper for author information when a document has multiple authors or collabarators
AuthorInitialsThe initials or other short identifier for an author
BeginPageThe location of a page break in a print version of the document
BiblioDivA section of a Bibliography
BiblioEntryAn entry in a Bibliography
BiblioMSetA "cooked" container for related bibliographic information
BiblioMiscUntyped bibliographic information
BiblioMixedAn entry in a Bibliography
BiblioSetA "raw" container for related bibliographic information
BibliographyA bibliography
BlockQuoteA quotation set off from the main text
BookA book
BookBiblioMeta-information about a book used in a bibliographical citation
BookInfoMeta-information for a Book
BridgeHeadA free-floating heading
COThe location of a callout embedded in text
CalloutA "called out" description of a marked Area
CalloutListA list of Callouts
CaptionA caption
CautionA note of caution
ChapterA chapter, as of a book
CitationAn inline bibliographic reference to another published work
CiteRefEntryA citation to a reference page
CiteTitleThe title of a cited work
CityThe name of a city in an address
ClassNameThe name of a class, in the object-oriented programming sense
CmdSynopsisA syntax summary for a software command
ColSpecSpecifications for a column in a table
CollabIdentifies a collaborator
CollabNameThe name of a collaborator
ColophonText at the back of a book describing facts about its production
CommandThe name of an executable program or other software command
CommentA comment intended for presentation in a draft manuscript
ComputerOutputData, generally text, displayed or presented by a computer
ConfDatesThe dates of a conference for which a document was written
ConfGroupA wrapper for document meta-information about a conference
ConfNumAn identifier, frequently numerical, associated with a conference for which a document was written
ConfSponsorThe sponsor of a conference for which a document was written
ConfTitleThe title of a conference for which a document was written
ConstantA programming or system constant
ContractNumThe contract number of a document
ContractSponsorThe sponsor of a contract
ContribA summary of the contributions made to a document by a credited source
CopyrightCopyright information about a document
CorpAuthorA corporate author, as opposed to an individual
CorpNameThe name of a corporation
CountryThe name of a country
DatabaseThe name of a database, or part of a database
DateThe date of publication or revision of a document
DedicationA wrapper for the dedication section of a book
DocInfoMeta-data for a book component
EditionThe name or number of an edition of a document
EditorThe name of the editor of a document
EmailAn email address
EmphasisEmphasized text
EnVarA software environment variable
EntryA cell in a table
EntryTblA subtable appearing in place of an Entry in a table
EpigraphA short inscription at the beginning of a document or component
EquationA displayed mathematical equation
ErrorCodeAn error code
ErrorNameAn error message
ErrorTypeThe classification of an error message
ExampleA formal example, with a title
FaxA fax number
FigureA formal figure, generally an illustration, with a title
FilenameThe name of a file
FirstNameThe first name of a person
FirstTermThe first occurrence of a term
FootnoteA footnote
FootnoteRefA cross reference to a footnote (a footnote mark)
ForeignPhraseA word or phrase in a language other than the primary language of the document
FormalParaA paragraph with a title
FuncDefA function (subroutine) name and its return type
FuncParamsParameters for a function referenced through a function pointer in a synopsis
FuncPrototypeThe prototype of a function
FuncSynopsisThe syntax summary for a function definition
FuncSynopsisInfoInformation supplementing the FuncDefs of a FuncSynopsis
FunctionThe name of a function or subroutine, as in a programming language
GUIButtonThe text on a button in a GUI
GUIIconGraphic and/or text appearing as a icon in a GUI
GUILabelThe text of a label in a GUI
GUIMenuThe name of a menu in a GUI
GUIMenuItemThe name of a terminal menu item in a GUI
GUISubmenuThe name of a submenu in a GUI
GlossDefA definition in a GlossEntry
GlossDivA division in a Glossary
GlossEntryAn entry in a Glossary or GlossList
GlossListA wrapper for a set of GlossEntrys
GlossSeeA cross-reference from one GlossEntry to another
GlossSeeAlsoA cross-reference from one GlossEntry to another
GlossTermA glossary term
GlossaryA glossary
GraphicA displayed graphical object (not an inline)
GraphicCOA graphic that contains callout areas
GroupA group of elements in a CmdSynopsis
HardwareA physical part of a computer system
HighlightsA summary of the main points of the discussed component
HolderThe name of the individual or organization that holds a copyright
HonorificThe title of a person
ISBNThe International Standard Book Number of a document
ISSNThe International Standard Serial Number of a periodical
ITermSetA set of index terms in the meta-information of a document
ImageDataPointer to external image data
ImageObjectA wrapper for image data and its associated meta-information
ImageObjectCOA wrapper for an image object with callouts
ImportantAn admonition set off from the text
IndexAn index
IndexDivA division in an index
IndexEntryAn entry in an index
IndexTermA wrapper for terms to be indexed
InformalEquationA displayed mathematical equation without a title
InformalExampleA displayed example without a title
InformalFigureA untitled figure
InformalTableA table without a title
InlineEquationA mathematical equation or expression occurring inline
InlineGraphicAn object containing or pointing to graphical data that will be rendered inline
InlineMediaObjectAn inline media object (video, audio, image, and so on)
InterfaceAn element of a GUI
InterfaceDefinitionThe name of a formal specification of a GUI
InvPartNumberAn inventory part number
IssueNumThe number of an issue of a journal
ItemizedListA list in which each entry is marked with a bullet or other dingbat
JobTitleThe title of an individual in an organization
KeyCapThe text printed on a key on a keyboard
KeyCodeThe internal, frequently numeric, identifier for a key on a keyboard
KeyComboA combination of input actions
KeySymThe symbolic name of a key on a keyboard
KeywordOne of a set of keywords describing the content of a document
KeywordSetA set of keywords describing the content of a document
LegalNoticeA statement of legal obligations or requirements
LineAnnotationA comment on a line in a verbatim listing
LineageThe portion of a person's name indicating a relationship to ancestors
LinkA hypertext link
ListItemA wrapper for the elements of a list item
LiteralInline text that is some literal value
LiteralLayoutA block of text in which line breaks and white space are to be reproduced faithfully
LoTA list of the titles of formal objects (as tables or figures) in a document
LoTentryAn entry in a list of titles
ManVolNumA reference volume number
MarkupA string of formatting markup in text that is to be represented literally
MediaLabelA name that identifies the physical medium on which some information resides
MediaObjectA displayed media object (video, audio, image, etc.)
MediaObjectCOA media object that contains callouts
MemberAn element of a simple list
MenuChoiceA selection or series of selections from a menu
ModeSpecApplication-specific information necessary for the completion of an OLink
MouseButtonThe conventional name of a mouse button
MsgA message in a message set
MsgAudThe audience to which a message in a message set is relevant
MsgEntryA wrapper for an entry in a message set
MsgExplanExplanatory material relating to a message in a message set
MsgInfoInformation about a message in a message set
MsgLevelThe level of importance or severity of a message in a message set
MsgMainThe primary component of a message in a message set
MsgOrigThe origin of a message in a message set
MsgRelA related component of a message in a message set
MsgSetA detailed set of messages, usually error messages
MsgSubA subcomponent of a message in a message set
MsgTextThe actual text of a message component in a message set
NoteA message set off from the text
OLinkA link that addresses its target indirectly, through an entity
ObjectInfoMeta-information for an object
OptionAn option for a software command
OptionalOptional information
OrderedListA list in which each entry is marked with a sequentially incremented label
OrgDivA division of an organization
OrgNameThe name of an organization other than a corporation
OtherAddrUncategorized information in address
OtherCreditA person or entity, other than an author or editor, credited in a document
OtherNameA component of a persons name that is not a first name, surname, or lineage
POBA post office box in an address
PageNumsThe numbers of the pages in a book, for use in a bibliographic entry
ParaA paragraph
ParamDefInformation about a function parameter in a programming language
ParameterA value or a symbolic reference to a value
PartA division in a book
PartIntroAn introduction to the contents of a part
PhoneA telephone number
PhraseA span of text
PostcodeA postal code in an address
PrefaceIntroductory matter preceding the first chapter of a book
PrimaryThe primary word or phrase under which an index term should be sorted
PrimaryIEA primary term in an index entry, not in the text
PrintHistoryThe printing history of a document
ProcedureA list of operations to be performed in a well-defined sequence
ProductNameThe formal name of a product
ProductNumberA number assigned to a product
ProgramListingA literal listing of all or part of a program
ProgramListingCOA program listing with associated areas used in callouts
PromptA character or string indicating the start of an input field in a computer display
PropertyA unit of data associated with some part of a computer system
PubDateThe date of publication of a document
PublisherThe publisher of a document
PublisherNameThe name of the publisher of a document
PubsNumberA number assigned to a publication other than an ISBN or ISSN or inventory part number
QandADivA titled division in a QandASet
QandAEntryA question/answer set within a QandASet
QandASetA question-and-answer set
QuestionA question in a QandASet
QuoteAn inline quotation
RefClassThe scope or other indication of applicability of a reference entry
RefDescriptorA description of the topic of a reference page
RefEntryA reference page (originally a UNIX man-style reference page)
RefEntryTitleThe title of a reference page
RefMetaMeta-information for a reference entry
RefMiscInfoMeta-information for a reference entry other than the title and volume number
RefNameThe name of (one of) the subject(s) of a reference page
RefNameDivThe name, purpose, and classification of a reference page
RefPurposeA short (one sentence) synopsis of the topic of a reference page
RefSect1A major subsection of a reference entry
RefSect1InfoMeta-information for a RefSect1
RefSect2A subsection of a RefSect1
RefSect2InfoMeta-information for a RefSect2
RefSect3A subsection of a RefSect2
RefSect3InfoMeta-information for a RefSect3
RefSynopsisDivA syntactic synopsis of the subject of the reference page
RefSynopsisDivInfoMeta-information for a RefSynopsisDiv
ReferenceA collection of reference entries
ReleaseInfoInformation about a particular release of a document
ReplaceableContent that may or must be replaced by the user
ReturnValueThe value returned by a function
RevHistoryA history of the revisions to a document
RevNumberA document revision number
RevRemarkA description of a revision to a document
RevisionAn entry describing a single revision in the history of the revisions to a document
RowA row in a table
SBRAn explicit line break in a command synopsis
SGMLTagA component of SGML markup
ScreenText that a user sees or might see on a computer screen
ScreenCOA screen with associated areas used in callouts
ScreenInfoInformation about how a screen shot was produced
ScreenShotA representation of what the user sees or might see on a computer screen
SecondaryA secondary word or phrase in an index term
SecondaryIEA secondary term in an index entry, rather than in the text
Sect1A top-level section of document
Sect1InfoMeta-information for a Sect1
Sect2A subsection within a Sect1
Sect2InfoMeta-information for a Sect2
Sect3A subsection within a Sect2
Sect3InfoMeta-information for a Sect3
Sect4A subsection within a Sect3
Sect4InfoMeta-information for a Sect4
Sect5A subsection within a Sect4
Sect5InfoMeta-information for a Sect5
SectionA recursive section
SectionInfoMeta-information for a recursive section
SeePart of an index term directing the reader instead to another entry in the index
SeeAlsoPart of an index term directing the reader also to another entry in the index
SeeAlsoIEA "See also" entry in an index, rather than in the text
SeeIEA "See" entry in an index, rather than in the text
SegAn element of a list item in a segmented list
SegListItemA list item in a segmented list
SegTitleThe title of an element of a list item in a segmented list
SegmentedListA segmented list, a list of sets of elements
SeriesInfoInformation about the publication series of which a book is a part
SeriesVolNumsNumbers of the volumes in a series of books
SetA collection of books
SetIndexAn index to a set of books
SetInfoMeta-information for a Set
ShortAffilA brief description of an affiliation
ShortcutA key combination for an action that is also accessible through a menu
SidebarA portion of a document that is isolated from the main narrative flow
SimParaA paragraph that contains only text and inline markup, no block elements
SimpleListAn undecorated list of single words or short phrases
SimpleSectA section of a document with no subdivisions
SpanSpecFormatting information for a spanned column in a table
StateA state or province in an address
StepA unit of action in a procedure
StreetA street address in an address
StructFieldA field in a structure (in the programming language sense)
StructNameThe name of a structure (in the programming language sense)
SubStepsA wrapper for steps that occur within steps in a procedure
SubjectOne of a group of terms describing the subject matter of a document
SubjectSetA set of terms describing the subject matter of a document
SubjectTermA term in a group of terms describing the subject matter of a document
SubscriptA subscript (as in H2O, the molecular formula for water)
SubtitleThe subtitle of a document
SuperscriptA superscript (as in x2, the mathematical notation for x multiplied by itself)
SurnameA family name; in western cultures the "last name"
SymbolA name that is replaced by a value before processing
SynopFragmentA portion of a CmdSynopsis broken out from the main body of the synopsis
SynopFragmentRefA reference to a fragment of a command synopsis
SynopsisA general-purpose element for representing the syntax of commands or functions
SystemItemA system-related item or term
TBodyA wrapper for the rows of a table or informal table
TFootA table footer consisting of one or more rows
TGroupA wrapper for the main content of a table, or part of a table
THeadA table header consisting of one or more rows
TableA formal table in a document
TermThe word or phrase being defined or described in a variable list
TertiaryA tertiary word or phrase in an index term
TertiaryIEA tertiary term in an index entry, rather than in the text
TextObjectA wrapper for a text description of an object and its associated meta-information
TipA suggestion to the user, set off from the text
TitleThe text of the title of a section of a document or of a formal block-level element
TitleAbbrevThe abbreviation of a Title
ToCA table of contents
ToCbackAn entry in a table of contents for a back matter component
ToCchapAn entry in a table of contents for a component in the body of a document
ToCentryA component title in a table of contents
ToCfrontAn entry in a table of contents for a front matter component
ToClevel1A top-level entry within a table of contents entry for a chapter-like component
ToClevel2A second-level entry within a table of contents entry for a chapter-like component
ToClevel3A third-level entry within a table of contents entry for a chapter-like component
ToClevel4A fourth-level entry within a table of contents entry for a chapter-like component
ToClevel5A fifth-level entry within a table of contents entry for a chapter-like component
ToCpartAn entry in a table of contents for a part of a book
TokenA unit of information
TrademarkA trademark
TypeThe classification of a value
ULinkA link that addresses its target by means of a URL (Uniform Resource Locator)
UserInputData entered by the user
VarArgsAn empty element in a function synopsis indicating a variable number of arguments
VarListEntryA wrapper for a set of terms and the associated description in a variable list
VarNameThe name of a variable
VariableListA list in which each entry is composed of a set of one or more terms and an associated description
VideoDataPointer to external video data
VideoObjectA wrapper for video data and its associated meta-information
VoidAn empty element in a function synopsis indicating that the function in question takes no arguments
VolumeNumThe volume number of a document in a set (as of books in a set or articles in a journal)
WarningAn admonition set off from the text
WordAsWordA word meant specifically as a word and not representing anything else
XRefA cross reference to another part of the document
YearThe year of publication of a document


PrevHomeNext
Interchanging DocBook DocumentsUpGlossary

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition)

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net