refdescriptor — A description of the topic of a reference page
refdescriptor ::=
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
Reference pages (RefEntry
s) are usually identified
by a short, succinct topic name, such as the name of a function
or command. The RefName
(or one of the
RefName
s, in the case of a reference page that has
several) is generally used as the topic name. When none of the
RefName
s is appropriate, RefDescriptor
is used to specify the topic name.
RefDescriptor
is unnecessary when an appropriate
RefName
can be selected automatically. At least one
RefName
is required, so RefDescriptor
cannot
be used in place of a name, only in addition to it.
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 heads, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.
If a RefDescriptor
is present, it should be used
for the short topic name. This name usually appears in the running
header along with the ManVolNum
in print media.
It may also appear in tables of contents and the index.
The following elements occur in refdescriptor: 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
.