PublishersMinimalElements

Norman Walsh edited this page Oct 3, 2015 · 2 revisions

This is a "working page" for the DocBook SubCommittee for Publishers.

This table reflects the minimal set of elements that we recommend for Core DocBook and the modules they are contained within. Table 2 contains any elements that have been recommended for separate domain-specific modules. ||'''Element Name''' ||'''Definition''' ||'''Group''' ||'''Module''' ||'''Description''' || ||abbrev ||db.abbrev ||db.publishing.inlines ||pool.rnc ||An abbreviation, especially one followed by a period || ||abstract ||db.abstract ||db.info.elements ||pool.rnc ||A summary || ||acknowledgements ||db.acknowledgements ||db.components ||hier.rnc ||Acknowledgements of a book or other component || ||acronym ||db.acronym ||db.publishing.inlines ||pool.rnc ||An often pronounceable word made from the initial (or selected) letters of a name or phrase || ||address ||db.address ||db.publishing.blocks ||pool.rnc ||A real-world address, generally a postal address || ||affiliation ||db.affiliation ||db.person.author.contentmodel ||pool.rnc ||The institutional affiliation of an individual || ||alt ||db.alt ||db.ubiq.inlines ||pool.rnc ||A text-only annotation, often used for accessibility || ||anchor ||db.anchor ||db.link.inlines ||pool.rnc ||A spot in the document || ||answer ||db.answer ||db.qandaentry ||qandaset.rnc ||An answer to a question posed in a QandASet || ||appendix ||db.appendix ||db.components ||hier.rnc ||An appendix in a Book or Article || ||area ||db.area ||db.areaspec ||callouts.rnc ||A region defined for a Callout in a graphic or code example || ||area ||db.area.inareaset ||db.areaset ||callouts.rnc ||A region defined for a Callout in a graphic or code example || ||areaset ||db.areaset ||db.areaspec ||callouts.rnc ||A set of related areas in a graphic or code example || ||areaspec ||db.areaspec ||db.programlistingco ||callouts.rnc ||A collection of regions in a graphic or code example || ||article ||db.article ||db.components ||hier.rnc ||An article || ||artpagenums ||db.artpagenums ||db.info.elements ||pool.rnc ||The page numbers of an article as published || ||attribution ||db.attribution ||db.blockquote ||pool.rnc ||The source of a block quote or epigraph || ||audiodata ||db.audiodata ||db.audioobject ||pool.rnc ||Pointer to external audio data || ||audioobject ||db.audioobject ||db.mediaobject.content ||pool.rnc ||A wrapper for audio data and its associated meta-information || ||author ||db.author ||db.bibliography.inlines ||pool.rnc ||The name of an individual author || ||authorgroup ||db.authorgroup ||db.info.elements ||pool.rnc ||Wrapper for author information when a document has multiple authors or collabarators || ||authorinitials ||db.authorinitials ||db.info.elements ||pool.rnc ||The initials or other short identifier for an author || ||bibliocoverage ||db.bibliocoverage ||db.info.elements ||pool.rnc ||The spatial or temporal coverage of a document || ||bibliodiv ||db.bibliodiv ||db.bibliography ||bibliography.rnc ||A section of a Bibliography || ||biblioentry ||db.biblioentry ||db.bibliography ||bibliography.rnc ||An entry in a Bibliography || ||bibliography ||db.bibliography ||db.navigation.components ||bibliography.rnc ||A bibliography || ||biblioid ||db.biblioid ||db.info.elements ||pool.rnc ||An identifier for a document || ||bibliolist ||db.bibliolist ||db.list.blocks ||bibliography.rnc ||A wrapper for a list of bibliography entries || ||bibliomisc ||db.bibliomisc ||db.info.elements ||bibliography.rnc ||Untyped bibliographic information || ||bibliomixed ||db.bibliomixed ||db.bibliography ||bibliography.rnc ||An entry in a Bibliography || ||bibliomset ||db.bibliomset ||db.info.elements ||bibliography.rnc ||A cooked container for related bibliographic information || ||biblioref ||db.biblioref ||db.link.inlines ||bibliography.rnc ||A cross-reference to a bibliographic entry || ||bibliorelation ||db.bibliorelation ||db.info.elements ||pool.rnc ||The relationship of a document to another || ||biblioset ||db.biblioset ||db.info.elements ||bibliography.rnc ||A raw container for related bibliographic information || ||bibliosource ||db.bibliosource ||db.info.elements ||pool.rnc ||The source of a document || ||blockquote ||db.blockquote ||db.publishing.blocks ||pool.rnc ||A quotation set off from the main text || ||book ||db.book ||db.set.components ||hier.rnc ||A book || ||bridgehead ||db.bridgehead ||db.nopara.blocks ||pool.rnc ||A free-floating heading || ||callout ||db.callout ||db.calloutlist ||callouts.rnc ||A called out description of a marked Area || ||calloutlist ||db.calloutlist ||db.list.blocks ||callouts.rnc ||A list of callouts || ||caption ||db.caption ||db.example ||pool.rnc ||A caption || ||caption ||db.html.caption ||db.html.table.model ||htmltbl.rnc ||An HTML table caption || ||chapter ||db.chapter ||db.components ||hier.rnc ||A chapter, as of a book || ||citation ||db.citation ||db.bibliography.inlines ||pool.rnc ||An inline bibliographic reference to another published work || ||citebiblioid ||db.citebiblioid ||db.bibliography.inlines ||pool.rnc ||A citation of a bibliographic identifier || ||citetitle ||db.citetitle ||db.bibliography.inlines ||pool.rnc ||The title of a cited work || ||city ||db.city ||db.address ||pool.rnc ||The name of a city in an address || ||co ||db.co ||db.verbatim.inlines ||callouts.rnc ||The location of a callout embedded in text || ||collab ||db.collab ||db.info.elements ||pool.rnc ||Identifies a collaborator || ||colophon ||db.colophon ||db.components ||hier.rnc ||Text at the back of a book describing facts about its production || ||colspec ||db.colspec ||db.tgroup ||calstbl.rnc ||Specifications for a column in a table || ||confdates ||db.confdates ||db.confgroup ||pool.rnc ||The dates of a conference for which a document was written || ||confgroup ||db.confgroup ||db.info.elements ||pool.rnc ||A wrapper for document meta-information about a conference || ||confnum ||db.confnum ||db.confgroup ||pool.rnc ||An identifier, frequently numerical, associated with a conference for which a document was written || ||confsponsor ||db.confsponsor ||db.confgroup ||pool.rnc ||The sponsor of a conference for which a document was written || ||conftitle ||db.conftitle ||db.confgroup ||pool.rnc ||The title of a conference for which a document was written || ||contractnum ||db.contractnum ||db.info.elements ||pool.rnc ||The contract number of a document || ||contractsponsor ||db.contractsponsor ||db.info.elements ||pool.rnc ||The sponsor of a contract || ||contrib ||db.contrib ||db.person.author.contentmodel ||pool.rnc ||A summary of the contributions made to a document by a credited source || ||copyright ||db.copyright ||db.info.elements ||pool.rnc ||Copyright information about a document || ||coref ||db.coref ||db.publishing.inlines ||callouts.rnc ||A cross reference to a co || ||country ||db.country ||db.address ||pool.rnc ||The name of a country || ||cover ||db.cover ||db.info.elements ||pool.rnc ||Additional content for the cover of a publication || ||date ||db.date ||db.publishing.inlines ||pool.rnc ||The date of publication or revision of a document || ||dedication ||db.dedication ||db.components ||hier.rnc ||The dedication of a book or other component || ||edition ||db.edition ||db.info.elements ||pool.rnc ||The name or number of an edition of a document || ||editor ||db.editor ||db.bibliography.inlines ||pool.rnc ||The name of the editor of a document || ||email ||db.email ||db.markup.inlines ||pool.rnc ||An email address || ||emphasis ||db._emphasis ||db._emphasis ||pool.rnc ||A limited span of emphasized text || ||emphasis ||db.emphasis ||db.publishing.inlines ||pool.rnc ||Emphasized text || ||entry ||db.entry ||db.row ||calstbl.rnc ||A cell in a table || ||entrytbl ||db.entrytbl ||db.row ||calstbl.rnc ||A subtable appearing in place of an Entry in a table || ||epigraph ||db.epigraph ||db.publishing.blocks ||pool.rnc ||A short inscription at the beginning of a document or component || ||equation ||db.equation ||db.formal.blocks ||math.rnc ||A displayed mathematical equation || ||example ||db.example ||db.formal.blocks ||pool.rnc ||A formal example, with a title || ||fax ||db.fax ||db.address ||pool.rnc ||A fax number || ||figure ||db.figure ||db.formal.blocks ||pool.rnc ||A formal figure, generally an illustration, with a title || ||firstname ||db.firstname ||db.personname ||pool.rnc ||The first name of a person || ||firstterm ||db.firstterm ||db.glossary.inlines ||glossary.rnc ||The first occurrence of a term || ||footnote ||db.footnote ||db.publishing.inlines ||pool.rnc ||A footnote || ||footnoteref ||db.footnoteref ||db.publishing.inlines ||pool.rnc ||A cross reference to a footnote (a footnote mark) || ||foreignphrase ||db.foreignphrase ||db.publishing.inlines ||pool.rnc ||A word or phrase in a language other than the primary language of the document || ||formalpara ||db.formalpara ||db.para.blocks ||pool.rnc ||A paragraph with a title || ||glossary ||db.glossary ||db.navigation.components ||glossary.rnc ||A glossary || ||glossdef ||db.glossdef ||db.glossentry ||glossary.rnc ||A definition in a GlossEntry || ||glossdiv ||db.glossdiv ||db.glossary ||glossary.rnc ||A division in a Glossary || ||glossentry ||db.glossentry ||db.glosslist ||glossary.rnc ||An entry in a Glossary or GlossList || ||glosslist ||db.glosslist ||db.list.blocks ||glossary.rnc ||A wrapper for a list of glossary entries || ||glosssee ||db.glosssee ||db.glossentry ||glossary.rnc ||A cross-reference from one glossentry to another || ||glossseealso ||db.glossseealso ||db.glossdef ||glossary.rnc ||A cross-reference from one GlossEntry to another || ||glossterm ||db.glossterm ||db.glossary.inlines ||glossary.rnc ||A glossary term || ||holder ||db.holder ||db.copyright ||pool.rnc ||The name of the individual or organization that holds a copyright || ||honorific ||db.honorific ||db.personname ||pool.rnc ||The title of a person || ||imagedata ||db.imagedata ||db.imageobject.content ||pool.rnc ||Pointer to external image data || ||imagedata ||db.imagedata.svg ||db.imageobject.content ||svg.rnc ||An SVG drawing in a media object || ||imagedata ||db.imagedata.mathml ||db.imageobject.content ||mathml.rnc ||A MathML expression in a media object || ||imageobject ||db.imageobject ||db.mediaobject.content ||pool.rnc ||A wrapper for image data and its associated meta-information || ||imageobjectco ||db.imageobjectco ||db.mediaobject.content ||callouts.rnc ||A wrapper for an image object with callouts || ||index ||db.index ||db.navigation.components ||index.rnc ||An index to a book or part of a book || ||indexterm ||db.indexterm.endofrange ||db.indexterm ||index.rnc ||Identifies the end of a range associated with an indexed term || ||indexterm ||db.indexterm.startofrange ||db.indexterm ||index.rnc ||A wrapper for an indexed term that covers a range || ||indexterm ||db.indexterm.singular ||db.itermset ||index.rnc ||A wrapper for an indexed term || ||info ||db.titleonly.info ||db._info.title.only ||pool.rnc ||A wrapper for information about a component or other block with only a title || ||info ||db.info ||db._info ||pool.rnc ||A wrapper for information about a component or other block || ||info ||db.titlereq.info ||db._info.title.req ||pool.rnc ||A wrapper for information about a component or other block with a required title || ||info ||db.titleforbidden.info ||db._info ||pool.rnc ||A wrapper for information about a component or other block without a title || ||info ||db.titleonlyreq.info ||db._info.title.onlyreq ||pool.rnc ||A wrapper for information about a component or other block with only a required title || ||informalequation ||db.informalequation ||db.informal.blocks ||math.rnc ||A displayed mathematical equation without a title || ||informalexample ||db.informalexample ||db.informal.blocks ||pool.rnc ||A displayed example without a title || ||informalfigure ||db.informalfigure ||db.informal.blocks ||pool.rnc ||A untitled figure || ||informaltable ||db.cals.informaltable ||db.informaltable.choice ||calstbl.rnc ||A table without a title || ||inlineequation ||db.inlineequation ||db.math.inlines ||math.rnc ||A mathematical equation or expression occurring inline || ||inlinemediaobject ||db.inlinemediaobject ||db.ubiq.inlines ||pool.rnc ||An inline media object (video, audio, image, and so on) || ||issuenum ||db.issuenum ||db.info.elements ||pool.rnc ||The number of an issue of a journal || ||itemizedlist ||db.itemizedlist ||db.list.blocks ||pool.rnc ||A list in which each entry is marked with a bullet or other dingbat || ||itermset ||db.itermset ||db.info.elements ||index.rnc ||A set of index terms in the meta-information of a document || ||jobtitle ||db.jobtitle ||db.bibliography.inlines ||pool.rnc ||The title of an individual in an organization || ||keyword ||db.keyword ||db.keywordset ||pool.rnc ||One of a set of keywords describing the content of a document || ||keywordset ||db.keywordset ||db.info.elements ||pool.rnc ||A set of keywords describing the content of a document || ||label ||db.label ||db.question ||qandaset.rnc ||A label on a Question or Answer || ||legalnotice ||db.legalnotice ||db.info.elements ||pool.rnc ||A statement of legal obligations or requirements || ||lineage ||db.lineage ||db.personname ||pool.rnc ||The portion of a person's name indicating a relationship to ancestors || ||link ||db.link ||db.link.inlines ||pool.rnc ||A hypertext link || ||listitem ||db.listitem ||db.itemizedlist ||pool.rnc ||A wrapper for the elements of a list item || ||literal ||db.literal ||db.markup.inlines ||markup.rnc ||Inline text that is some literal value || ||literallayout ||db.literallayout ||db.verbatim.blocks ||pool.rnc ||A block of text in which line breaks and white space are to be reproduced faithfully || ||mathphrase ||db.mathphrase ||db.equation.content ||math.rnc ||A mathematical phrase, an expression that can be represented with ordinary text and a small amount of markup || ||mediaobject ||db.mediaobject ||db.graphic.blocks ||pool.rnc ||A displayed media object (video, audio, image, etc.) || ||member ||db.member ||db.simplelist ||pool.rnc ||An element of a simple list || ||note ||db.note ||db.admonition.blocks ||pool.rnc ||A message set off from the text || ||olink ||db.olink ||db.link.inlines ||pool.rnc ||A link that addresses its target indirectly || ||optional ||db.optional ||db.technical.inlines ||technical.rnc ||Optional information || ||orderedlist ||db.orderedlist ||db.list.blocks ||pool.rnc ||A list in which each entry is marked with a sequentially incremented label || ||org ||db.org ||db.bibliography.inlines ||pool.rnc ||An organization and associated metadata || ||orgdiv ||db.orgdiv ||db.affiliation ||pool.rnc ||A division of an organization || ||orgname ||db.orgname ||db.bibliography.inlines ||pool.rnc ||The name of an organization other than a corporation || ||otheraddr ||db.otheraddr ||db.address ||pool.rnc ||Uncategorized information in address || ||othercredit ||db.othercredit ||db.info.elements ||pool.rnc ||A person or entity, other than an author or editor, credited in a document || ||othername ||db.othername ||db.personname ||pool.rnc ||A component of a persons name that is not a first name, surname, or lineage || ||pagenums ||db.pagenums ||db.info.elements ||pool.rnc ||The numbers of the pages in a book, for use in a bibliographic entry || ||para ||db.para ||db.para.blocks ||pool.rnc ||A paragraph || ||part ||db.part ||db.divisions ||hier.rnc ||A division in a book || ||partintro ||db.partintro ||db.part ||hier.rnc ||An introduction to the contents of a part || ||person ||db.person ||db.bibliography.inlines ||pool.rnc ||A person and associated metadata || ||personblurb ||db.personblurb ||db.person.author.contentmodel ||pool.rnc ||A short description or note about a person || ||personname ||db.personname ||db.bibliography.inlines ||pool.rnc ||The personal name of an individual || ||phone ||db.phone ||db.address ||pool.rnc ||A telephone number || ||phrase ||db.phrase ||db.publishing.inlines ||pool.rnc ||A span of text || ||phrase ||db._phrase ||db._text ||pool.rnc ||A limited span of text || ||pob ||db.pob ||db.address ||pool.rnc ||A post office box in an address || ||postcode ||db.postcode ||db.address ||pool.rnc ||A postal code in an address || ||preface ||db.preface ||db.components ||hier.rnc ||Introductory matter preceding the first chapter of a book || ||primary ||db.primary ||db.indexterm.contentmodel ||index.rnc ||The primary word or phrase under which an index term should be sorted || ||printhistory ||db.printhistory ||db.info.elements ||pool.rnc ||The printing history of a document || ||procedure ||db.procedure ||db.technical.blocks ||pool.rnc ||A list of operations to be performed in a well-defined sequence || ||productname ||db.productname ||db.product.inlines ||pool.rnc ||The formal name of a product || ||productnumber ||db.productnumber ||db.product.inlines ||pool.rnc ||A number assigned to a product || ||pubdate ||db.pubdate ||db.info.elements ||pool.rnc ||The date of publication of a document || ||publisher ||db.publisher ||db.info.elements ||pool.rnc ||The publisher of a document || ||publishername ||db.publishername ||db.info.elements ||pool.rnc ||The name of the publisher of a document || ||qandadiv ||db.qandadiv ||db.qandaset ||qandaset.rnc ||A titled division in a QandASet || ||qandaentry ||db.qandaentry ||db.qandaset ||qandaset.rnc ||A question/answer set within a QandASet || ||qandaset ||db.qandaset ||db.list.blocks ||qandaset.rnc ||A question-and-answer set || ||question ||db.question ||db.qandaentry ||qandaset.rnc ||A question in a QandASet || ||quote ||db.quote ||db.publishing.inlines ||pool.rnc ||An inline quotation || ||releaseinfo ||db.releaseinfo || ||pool.rnc || Information about a particular release of a document || ||remark ||remark || ||pool.rnc ||A remark (or comment) intended for presentation in a draft manuscript || ||revdescription ||revdescription || ||pool.rnc || An extended description of a revision to a document || ||revhistory ||revhistory || ||pool.rnc ||A history of the revisions to a document || ||revision ||revision || ||pool.rnc || An entry describing a single revision in the history of the revisions to a document || ||revnumber ||revnumber || ||pool.rnc || A document revision number || ||revremark ||revremark || ||pool.rnc || A description of a revision to a document || ||row ||row || ||calstbl.rnc || A row in a table || ||secondary ||secondary || ||index.rnc || A secondary word or phrase in an index term || ||secondaryie ||secondaryie || ||index.rnc || A secondary term in an index entry, rather than in the text || ||section ||db.section || ||hier.rnc || A recursive section || ||see ||see || ||index.rnc || Part of an index term directing the reader instead to another entry in the index || ||seealso ||seealso || ||index.rnc || Part of an index term directing the reader also to another entry in the index || ||seriesvolnums ||seriesvolnums || ||pool.rnc || Numbers of the volumes in a series of books || ||set ||set || ||hier.rnc || A collection of books || ||setindex ||setindex || ||index.rnc || An index to a set of books || ||shortaffil ||shortaffil || ||pool.rnc || A brief description of an affiliation || ||sidebar ||sidebar || ||pool.rnc ||A portion of a document that is isolated from the main narrative flow || ||simpara ||simpara || ||pool.rnc ||A paragraph that contains only text and inline markup, no block elements || ||simplelist ||simplelist || ||pool.rnc ||An undecorated list of single words or short phrases || ||simplesect ||simplesect || ||hier.rnc ||A section of a document with no subdivisions || ||spanspec ||spanspec || ||calstbl.rnc || Formatting information for a spanned column in a table || ||state ||state || || || A state or province in an address || ||step ||step || ||pool.rnc ||A unit of action in a procedure || ||stepalternatives ||stepalternatives || ||pool.rnc ||Alternative steps in a procedure || ||street ||street || ||pool.rnc || A street address in an address || ||subject ||subject || ||pool.rnc ||One of a group of terms describing the subject matter of a document || ||subjectset ||subjectset || ||pool.rnc ||A set of terms describing the subject matter of a document || ||subjectterm ||subjectterm || ||pool.rnc ||A term in a group of terms describing the subject matter of a document || ||subscript ||subscript || ||pool.rnc || A subscript (as in H2 O, the molecular formula for water) || ||substeps ||substeps || ||pool.rnc ||A wrapper for steps that occur within steps in a procedure || ||subtitle ||subtitle || ||pool.rnc ||The subtitle of a document || ||superscript ||superscript || ||pool.rnc || A superscript (as in x^2, the mathematical notation for x multiplied by itself) || ||surname ||surname || ||pool.rnc || A family name; in western cultures the last name || ||table ||table || ||calstbl.rnc || A formal table in a document || ||task ||task || ||tasks.rnc ||A task to be completed || ||taskprerequisites ||taskprerequisites || ||tasks.rnc ||The prerequisites for a task || ||taskrelated ||taskrelated || ||tasks.rnc ||Information related to a task || ||tasksummary ||tasksummary || ||tasks.rnc ||A summary of a task || ||tbody ||tbody || ||calstbl.rnc || A wrapper for the rows of a table or informal table || ||term ||term || ||pool.rnc ||The word or phrase being defined or described in a variable list || ||termdef ||db.termdef || ||glossary.rnc ||An inline definition of a term || ||tertiary ||tertiary || ||index.rnc || A tertiary word or phrase in an index term || ||textdata ||textdata || ||pool.rnc ||Pointer to external text data || ||textobject ||textobject || ||pool.rnc ||A wrapper for a text description of an object and its associated meta-information || ||tfoot ||tfoot || ||calstbl.rnc || A table footer consisting of one or more rows || ||tgroup ||tgroup || ||calstbl.rnc ||A wrapper for the main content of a table, or part of a table || ||thead ||thead || ||calstbl.rnc || A table header consisting of one or more rows || ||title ||title || ||pool.rnc ||The text of the title of a section of a document or of a formal block-level element || ||titleabbrev ||titleabbrev || ||pool.rnc ||The abbreviation of a title || ||toc ||toc || ||toc.rnc ||A table of contents || ||trademark ||trademark || ||pool.rnc || A trademark || ||uri ||uri || ||pool.rnc || A Uniform Resource Identifier || ||variablelist ||variablelist || ||pool.rnc ||A list in which each entry is composed of a set of one or more terms and an associated description || ||varlistentry ||varlistentry || ||pool.rnc ||A wrapper for a set of terms and the associated description in a variable list || ||videodata ||videodata || ||pool.rnc ||Pointer to external video data || ||videoobject ||videoobject || ||pool.rnc ||A wrapper for video data and its associated meta-information || ||volumenum ||volumenum || ||pool.rnc || The volume number of a document in a set (as of books in a set or articles in a journal) || ||wordasword ||db.wordasword || ||pool.rnc || A word meant specifically as a word and not representing anything else || ||xref ||xref || ||pool.rnc || A cross reference to another part of the document || ||year ||year || ||pool.rnc || The year of publication of a document || ||. ||db._any ||db._any ||pool.rnc ||Any element from almost any namespace ||

Table 2. Following is a list of elements to be available in separate modules: ||'''Element Name''' ||'''Definition''' ||'''Group''' ||'''Module''' ||'''Description''' || ||accel ||db.accel ||db.keyboard.inlines ||keyboard.rnc ||A graphical user interface (GUI) keyboard shortcut || ||annotation ||db.annotation ||db.ubiq.inlines ||annotations.rnc ||An annotation || ||application ||db.application ||db.product.inlines ||product.rnc ||The name of a software program || ||arc ||db.arc ||db.extendedlink ||xlink.rnc ||An XLink arc in an extendedlink || ||arg ||db.arg ||db.cmdsynopsis ||programming.rnc ||An argument in a CmdSynopsis || ||caution ||db.caution ||db.admonition.blocks ||admonitions.rnc ||A note of caution || ||citerefentry ||db.citerefentry ||db.bibliography.inlines ||refentry.rnc ||A citation to a reference page || ||classname ||db.classname ||db.programming.inlines ||programming.rnc ||The name of a class, in the object-oriented programming sense || ||classsynopsis ||db.classsynopsis ||db.synopsis.blocks ||programming.rnc ||The syntax summary for a class definition || ||classsynopsisinfo ||db.classsynopsisinfo ||db.classsynopsis ||programming.rnc ||Information supplementing the contents of a ClassSynopsis || ||cmdsynopsis ||db.cmdsynopsis ||db.synopsis.blocks ||programming.rnc ||A syntax summary for a software command || ||code ||db.code ||db.markup.inlines ||markup.rnc ||An inline code fragment || ||col ||db.html.col ||db.html.table.model ||htmltbl.rnc ||Specifications for a column in an HTML table || ||colgroup ||db.html.colgroup ||db.html.table.model ||htmltbl.rnc ||A group of columns in an HTML table || ||command ||db.command ||db.os.inlines ||os.rnc ||The name of an executable program or other software command || ||computeroutput ||db.computeroutput ||db.os.inlines ||os.rnc ||Data, generally text, displayed or presented by a computer || ||constant ||db.constant ||db.markup.inlines ||markup.rnc ||A programming or system constant || ||constraint ||db.constraint ||db.production ||ebnf.rnc ||A constraint in an EBNF production || ||constraintdef ||db.constraintdef ||db.technical.blocks ||ebnf.rnc ||The definition of a constraint in an EBNF production || ||constructorsynopsis ||db.constructorsynopsis ||db.synopsis.blocks ||programming.rnc ||A syntax summary for a constructor || ||database ||db.database ||db.product.inlines ||product.rnc ||The name of a database, or part of a database || ||destructorsynopsis ||db.destructorsynopsis ||db.synopsis.blocks ||programming.rnc ||A syntax summary for a destructor || ||envar ||db.envar ||db.os.inlines ||os.rnc ||A software environment variable || ||errorcode ||db.errorcode ||db.error.inlines ||error.rnc ||An error code || ||errorname ||db.errorname ||db.error.inlines ||error.rnc ||An error name || ||errortext ||db.errortext ||db.error.inlines ||error.rnc ||An error message. || ||errortype ||db.errortype ||db.error.inlines ||error.rnc ||The classification of an error message || ||exceptionname ||db.exceptionname ||db.programming.inlines ||programming.rnc ||The name of an exception || ||extendedlink ||db.extendedlink ||db.info.elements ||xlink.rnc ||An XLink extended link || ||fieldsynopsis ||db.fieldsynopsis ||db.synopsis.blocks ||programming.rnc ||The name of a field in a class definition || ||filename ||db.filename ||db.os.inlines ||os.rnc ||The name of a file || ||funcdef ||db.funcdef ||db.funcprototype ||programming.rnc ||A function (subroutine) name and its return type || ||funcparams ||db.funcparams ||db.paramdef ||programming.rnc ||Parameters for a function referenced through a function pointer in a synopsis || ||funcprototype ||db.funcprototype ||db.funcsynopsis ||programming.rnc ||The prototype of a function || ||funcsynopsis ||db.funcsynopsis ||db.synopsis.blocks ||programming.rnc ||The syntax summary for a function definition || ||funcsynopsisinfo ||db.funcsynopsisinfo ||db.funcsynopsis ||programming.rnc ||Information supplementing the FuncDefs of a FuncSynopsis || ||function ||db.function ||db.programming.inlines ||programming.rnc ||The name of a function or subroutine, as in a programming language || ||group ||db.group ||db.cmdsynopsis ||programming.rnc ||A group of elements in a CmdSynopsis || ||guibutton ||db.guibutton ||db.gui.inlines ||gui.rnc ||The text on a button in a GUI || ||guiicon ||db.guiicon ||db.gui.inlines ||gui.rnc ||Graphic and/or text appearing as a icon in a GUI || ||guilabel ||db.guilabel ||db.gui.inlines ||gui.rnc ||The text of a label in a GUI || ||guimenu ||db.guimenu ||db.gui.inlines ||gui.rnc ||The name of a menu in a GUI || ||guimenuitem ||db.guimenuitem ||db.gui.inlines ||gui.rnc ||The name of a terminal menu item in a GUI || ||guisubmenu ||db.guisubmenu ||db.gui.inlines ||gui.rnc ||The name of a submenu in a GUI || ||hardware ||db.hardware ||db.product.inlines ||product.rnc ||A physical part of a computer system || ||important ||db.important ||db.admonition.blocks ||admonitions.rnc ||An admonition set off from the text || ||indexdiv ||db.indexdiv ||db.index ||index.rnc ||A division in an index || ||indexentry ||db.indexentry ||db.index ||index.rnc ||An entry in an index || ||informaltable ||db.html.informaltable ||db.informaltable.choice ||htmltbl.rnc ||An HTML table without a title || ||initializer ||db.initializer ||db.programming.inlines ||programming.rnc ||The initializer for a FieldSynopsis || ||interfacename ||db.interfacename ||db.programming.inlines ||programming.rnc ||The name of an interface || ||keycap ||db.keycap ||db.keyboard.inlines ||keyboard.rnc ||The text printed on a key on a keyboard || ||keycode ||db.keycode ||db.keyboard.inlines ||keyboard.rnc ||The internal, frequently numeric, identifier for a key on a keyboard || ||keycombo ||db.keycombo ||db.keyboard.inlines ||keyboard.rnc ||A combination of input actions || ||keysym ||db.keysym ||db.keyboard.inlines ||keyboard.rnc ||The symbolic name of a key on a keyboard || ||lhs ||db.lhs ||db.production ||ebnf.rnc ||The left-hand side of an EBNF production || ||locator ||db.locator ||db.extendedlink ||xlink.rnc ||An XLink locator in an extendedlink || ||manvolnum ||db.manvolnum ||db.citerefentry ||refentry.rnc ||A reference volume number || ||markup ||db.markup ||db.markup.inlines ||markup.rnc ||A string of formatting markup in text that is to be represented literally || ||lineannotation ||db.lineannotation ||db.verbatim.inlines ||programming.rnc ||A comment on a line in a verbatim listing || ||menuchoice ||db.menuchoice ||db.gui.inlines ||gui.rnc ||A selection or series of selections from a menu || ||methodname ||db.methodname ||db.programming.inlines ||programming.rnc ||The name of a method || ||methodparam ||db.methodparam ||db.constructorsynopsis ||programming.rnc ||Parameters to a method || ||methodsynopsis ||db.methodsynopsis ||db.synopsis.blocks ||programming.rnc ||A syntax summary for a method || ||modifier ||db.modifier ||db.programming.inlines ||programming.rnc ||Modifiers in a synopsis || ||mousebutton ||db.mousebutton ||db.gui.inlines ||gui.rnc ||The conventional name of a mouse button || ||msg ||db.msg ||db.msgentry ||msgset.rnc ||A message in a message set || ||msgaud ||db.msgaud ||db.msginfo ||msgset.rnc ||The audience to which a message in a message set is relevant || ||msgentry ||db.msgentry ||db.msgset ||msgset.rnc ||A wrapper for an entry in a message set || ||msgexplan ||db.msgexplan ||db.msgentry ||msgset.rnc ||Explanatory material relating to a message in a message set || ||msginfo ||db.msginfo ||db.msgentry ||msgset.rnc ||Information about a message in a message set || ||msglevel ||db.msglevel ||db.msginfo ||msgset.rnc ||The level of importance or severity of a message in a message set || ||msgmain ||db.msgmain ||db.msg ||msgset.rnc ||The primary component of a message in a message set || ||msgorig ||db.msgorig ||db.msginfo ||msgset.rnc ||The origin of a message in a message set || ||msgrel ||db.msgrel ||db.msg ||msgset.rnc ||A related component of a message in a message set || ||msgset ||db.msgset ||db.technical.blocks ||msgset.rnc ||A detailed set of messages, usually error messages || ||msgsub ||db.msgsub ||db.msg ||msgset.rnc ||A subcomponent of a message in a message set || ||msgtext ||db.msgtext ||db.simplemsgentry ||msgset.rnc ||The actual text of a message component in a message set || ||nonterminal ||db.nonterminal ||db.technical.inlines ||ebnf.rnc ||A non-terminal in an EBNF production || ||ooclass ||db.ooclass ||db.oo.inlines ||programming.rnc ||A class in an object-oriented programming language || ||ooexception ||db.ooexception ||db.oo.inlines ||programming.rnc ||An exception in an object-oriented programming language || ||oointerface ||db.oointerface ||db.oo.inlines ||programming.rnc ||An interface in an object-oriented programming language || ||option ||db.option ||db.technical.inlines ||technical.rnc ||An option for a software command || ||package ||db.package ||db.technical.inlines ||technical.rnc ||A software or application package || ||paramdef ||db.paramdef ||db.funcprototype ||programming.rnc ||Information about a function parameter in a programming language || ||parameter ||db.parameter ||db.technical.inlines ||programming.rnc ||A value or a symbolic reference to a value || ||primaryie ||db.primaryie ||db.indexentry ||index.rnc ||A primary term in an index entry, not in the text || ||production ||db.production ||db.productionset ||ebnf.rnc ||A production in a set of EBNF productions || ||productionrecap ||db.productionrecap ||db.productionset ||ebnf.rnc ||A cross-reference to an EBNF production || ||productionset ||db.productionset ||db.technical.blocks ||ebnf.rnc ||A set of EBNF productions || ||programlisting ||db.programlisting ||db.verbatim.blocks ||programming.rnc ||A literal listing of all or part of a program || ||programlistingco ||db.programlistingco ||db.verbatim.blocks ||callouts.rnc ||A program listing with associated areas used in callouts || ||prompt ||db.prompt ||db.os.inlines ||os.rnc ||A character or string indicating the start of an input field in a computer display || ||property ||db.property ||db.technical.inlines ||technical.rnc ||A unit of data associated with some part of a computer system || ||refclass ||db.refclass ||db.refnamediv ||refentry.rnc ||The scope or other indication of applicability of a reference entry || ||refdescriptor ||db.refdescriptor ||db.refnamediv ||refentry.rnc ||A description of the topic of a reference page || ||refentry ||db.refentry ||db.toplevel.sections ||refentry.rnc ||A reference page (originally a UNIX man-style reference page) || ||refentrytitle ||db.refentrytitle ||db.citerefentry ||refentry.rnc ||The title of a reference page || ||reference ||db.reference ||db.divisions ||refentry.rnc ||A collection of reference entries || ||refmeta ||db.refmeta ||db.refentry ||refentry.rnc ||Meta-information for a reference entry || ||refmiscinfo ||db.refmiscinfo ||db.refmeta ||refentry.rnc ||Meta-information for a reference entry other than the title and volume number || ||refname ||db.refname ||db.refnamediv ||refentry.rnc ||The name of (one of) the subject(s) of a reference page || ||refnamediv ||db.refnamediv ||db.refentry ||refentry.rnc ||The name, purpose, and classification of a reference page || ||refpurpose ||db.refpurpose ||db.refnamediv ||refentry.rnc ||A short (one sentence) synopsis of the topic of a reference page || ||refsect1 ||db.refsect1 ||db.toplevel.sections ||refsect1.rnc ||A major subsection of a reference entry || ||refsect2 ||db.refsect2 ||db.secondlevel.refsection ||refsect1.rnc ||A subsection of a refsect1 || ||refsect3 ||db.refsect3 ||db.refsect2.sections ||refsect1.rnc ||A subsection of a refsect2 || ||refsection ||db.refsection ||db.toplevel.refsection ||refentry.rnc ||A recursive section in a refentry || ||refsynopsisdiv ||db.refsynopsisdiv ||db.refentry ||refentry.rnc ||A syntactic synopsis of the subject of the reference page || ||replaceable ||replaceable ||db.technical.inlines ||technical.rnc || || ||returnvalue ||db.returnvalue ||db.programming.inlines ||programming.rnc || || ||rhs ||db.rhs ||db.production ||ebnf.rnc || || ||sbr || db.sbr || ||programming.rnc || || ||screen || db.screen || ||technical.rnc ||Text that a user sees or might see on a computer screen || ||screenco || db.screenco ||db.verbatim.blocks ||callouts.rnc ||A screen with associated areas used in callouts || ||screenshot || db.screenshot || ||technical.rnc ||A representation of what the user sees or might see on a computer screen || ||sect1 ||db.sect1 ||db.toplevel.sections ||sect1.rnc ||A top-level section of the document || ||sect2 ||db.sect2 ||db.sect1.sections ||sect1.rnc ||A subsection within a Sect1 || ||sect3 ||db.sect3 ||db.sect2.sections ||sect1.rnc ||A subsection within a Sect2 || ||sect4 ||db.sect4 ||db.sect3.sections ||sect1.rnc ||A subsection within a Sect3 || ||sect5 ||db.sect5 ||db.sect4.sections ||sect1.rnc ||A subsection within a Sect4 || ||seealsoie ||seealsoie || ||index.rnc ||A "See also" ] " entry in an index, rather than in the text || ||seeie ||seeie || ||index.rnc ||A "See" entry in an index, rather than in the text || ||seg ||db.seg || ||markup.rnc ||An element of a list item in a segmented list || ||seglistitem ||db.seglistitem || ||markup.rnc ||A list item in a segmented list || ||segmentedlist ||db.segmentedlist || ||markup.rnc ||A segmented list, a list of sets of elements || ||segtitle ||db.segtitle || ||markup.rnc ||The title of an element of a list item in a segmented list || ||shortcut ||db.shortcut || ||keyboard.rnc || || ||simplemsgentry ||db.simplemsgentry ||db.msgset ||msgset.rnc || || ||symbol ||symbol ||db.markup.inlines ||markup.rnc ||A name that is replaced by a value before processing || ||synopfragment || db.synopfragment || ||programming.rnc || || ||synopfragmentref || db.synopfragmentref || ||programming.rnc || || ||synopsis || db.synopsis || ||programming.rnc ||A general-purpose element for representing the syntax of commands or functions || ||systemitem || db.systemitem ||db.technical.inlines ||technical.rnc || || ||tag ||db.tag ||db.markup.inlines ||markup.rnc ||A component of XML (or SGML) markup || ||td ||db.html.informaltable || ||htmltbl.rnc || || ||tertiaryie ||tertiaryie || ||index.rnc || || ||th ||db.html.informaltable || ||htmltbl.rnc || || ||tip ||tip || ||admonitions.rnc || || ||tocdiv || || ||toc.rnc ||A division in a table of contents || ||tocentry || || ||toc.rnc ||A component title in a table of contents || ||token ||db.token ||db.markup.inlines ||markup.rnc ||A unit of information || ||tr ||db.html.informaltable || ||htmltbl.rnc || || ||type ||db.type ||db.programming.inlines ||programming.rnc || || ||userinput || db.userinput ||db.os.inlines ||os.rnc || || ||varargs ||varargs || ||programming.rnc || || ||varname ||varname ||db.programming.inlines ||programming.rnc || || ||void || db.void || ||programming.rnc || || ||warning || db.warning || ||admonitions.rnc || ||

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.