refname — The name of (one of) the subject(s) of a reference page
refname ::=
abbrev
accel
acronym
alt
anchor
annotation
application
author
biblioref
citation
citebiblioid
citerefentry
citetitle
classname
code
command
computeroutput
constant
coref
database
date
editor
email
emphasis
(db.emphasis)envar
errorcode
errorname
errortext
errortype
exceptionname
filename
firstterm
footnote
footnoteref
foreignphrase
function
glossterm
guibutton
guiicon
guilabel
guimenu
guimenuitem
guisubmenu
hardware
html:button
html:fieldset
html:input
html:label
html:select
html:textarea
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)initializer
inlineequation
inlinemediaobject
interfacename
keycap
keycode
keycombo
keysym
link
literal
markup
menuchoice
methodname
modifier
mousebutton
nonterminal
olink
ooclass
ooexception
oointerface
option
optional
orgname
package
parameter
personname
phrase
(db.phrase)productname
productnumber
prompt
property
quote
remark
replaceable
returnvalue
shortcut
subscript
superscript
symbol
systemitem
tag
termdef
token
trademark
type
uri
userinput
varname
wordasword
xref
RefEntry
s are small units of reference documentation
describing a single topic. The RefName
identifies
the topic. Often this is the name of the command or function
that the reference page describes.
Some reference pages describe a whole family of very closely related
commands or functions. In this case, a RefEntry
will
have multiple RefName
s, one for each command or function.
When a RefEntry
has several RefName
s, it is
likely to have a RefDescriptor
that identifies the
whole family of functions.
May be formatted inline or as a displayed block, depending on context.
Formatting reference pages may require a fairly sophisticated
processing system. Much of the meta-information about a
reference page (its name, type, purpose, title, and
classification) is stored in wrappers near the beginning of
the RefEntry
.
Common presentational features, such as titles and running headers, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.
The following elements occur in refname: text, abbrev
, accel
, acronym
, alt
, anchor
, annotation
, application
, author
, biblioref
, citation
, citebiblioid
, citerefentry
, citetitle
, classname
, code
, command
, computeroutput
, constant
, coref
, database
, date
, editor
, email
, emphasis
(db.emphasis), envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, filename
, firstterm
, footnote
, footnoteref
, foreignphrase
, function
, glossterm
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, html:button
, html:fieldset
, html:input
, html:label
, html:select
, html:textarea
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), initializer
, inlineequation
, inlinemediaobject
, interfacename
, keycap
, keycode
, keycombo
, keysym
, link
, literal
, markup
, menuchoice
, methodname
, modifier
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, orgname
, package
, parameter
, personname
, phrase
(db.phrase), productname
, productnumber
, prompt
, property
, quote
, remark
, replaceable
, returnvalue
, shortcut
, subscript
, superscript
, symbol
, systemitem
, tag
, termdef
, token
, trademark
, type
, uri
, userinput
, varname
, wordasword
, xref
.