O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

refclass — The scope or other indication of applicability of a reference entry

Synopsis

refclass ::= (text | application)*

Description

The refclass element describes the applicability or scope of a refentry. A refclass might indicate that the entry was only applicable to a particular application, for example, or only to a particular vendor’s operating system.

Processing expectations

May be formatted inline or as a displayed block, depending on context. Sometimes suppressed.

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.

Examples

See refentry for an example using this element.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required