refname
refname — The name of (one of) the subject(s) of a reference page.
Synopsis
refname ::= × ⏵
- 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 ⏵
- Technical inlines ⏵
- Ubiquitous inlines ⏵
Attributes
Common attributes and common linking attributes.
No additional 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
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.
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.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
1 element contains refname
. × ⏵
Children
115 elements occur in refname
. × ⏵
See Also
Related elements: refdescriptor
, refentrytitle
.
Examples
See reference
and refentry
for examples that use this element.