RefName -- The name of (one of) the subject(s) of a reference page


Mixed Content Model

RefName ::=


Common attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.


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.

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.

(4.0) Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.


These elements contain RefName: RefNameDiv.


The following elements occur in RefName: Action, Application, ClassName, Command, ComputerOutput, Constant, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, Option, Optional, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Symbol, SystemItem, Token, Type, UserInput, VarName.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

See Also

RefDescriptor, RefEntryTitle


For examples, see RefEntry.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.