refname
refname — The name of (one of) the subject(s) of a reference page.
Synopsis
refname ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Zero or more of:
- text
- Bibliography inlines
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
abbrevacronymcorefdateemphasis(db.emphasis)firstterm(db._firstterm)firstterm(db.firstterm)footnotefootnoterefforeignphrase(db.foreignphrase)glossterm(db._glossterm)glossterm(db.glossterm)phrase(db.phrase)quote(db.quote)subscriptsuperscriptwordasword
- Technical inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
Attributes
Description
A refentry is a small unit 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
refnames, one for each command or function. When a
refentry has several refnames, it
is likely to have a refdescriptor that identifies the
whole family of functions.
Processing expectations
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.
Parents
These elements contain refname: refnamediv.
Children
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), emphasis (db.emphasis), envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), function, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, link, literal, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, org, orgname, package, parameter, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, prompt, property, quote (db._quote), quote (db.quote), remark, replaceable, returnvalue, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, token, trademark, type, uri, userinput, varname, wordasword, xref.