DocBook 5: The Definitive Guide

Name

RefClass -- The scope or other indication of applicability of a reference entry

Synopsis

Mixed Content Model

RefClass ::= ((#PCDATA|Application)+)

Attributes

Common attributes

Tag Minimization

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

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.

Parents

These elements contain RefClass: RefNameDiv.

Children

The following elements occur in RefClass: Application.

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

Examples

For examples, see RefEntry.

Back to: DocBook: The Definitive Guide