    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
refname — The name of (one of) the subject(s) of a reference page
RefEntrys 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 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.
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 InterfaceDefinition
element will be discarded in DocBook V4.0. It will no longer be available
in the content model of this element.
The following elements occur in refname:
action, application, classname, code, command, computeroutput, constant, database, email, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, function, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, interface, interfacename, keycap, keycode, keycombo, keysym, literal, markup, medialabel, menuchoice, methodname, mousebutton, nonterminal, ooclass, ooexception, oointerface, option, optional, package, parameter, prompt, property, replaceable, returnvalue, sgmltag, structfield, structname, symbol, systemitem, token, type, uri, userinput, varname.
| | | |
| refmiscinfo | | refnamediv |