ManVolNum

DocBook: The Definitive Guide
Prev		Next

Synopsis

Mixed Content Model

ManVolNum ::=
((#PCDATA|Acronym|Emphasis|Trademark|Link|OLink|ULink|Anchor|
  Comment|Subscript|Superscript|InlineGraphic|InlineMediaObject|
  IndexTerm)+)

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

In a DocBook reference page, the ManVolNum holds the number of the volume in which the RefEntry belongs.

The notion of a volume number is historical. UNIX manual pages ("man pages"), for which RefEntry was devised, were typically stored in three ring binders. Each bound manual was a volume in a set and contained information about a particular class of things. For example, volume 1 was for user commands, and volume 8 was for administrator commands.

Volume numbers need not be strictly numerical; volume "l" frequently held manual pages for local additions to the system, and the X Window System manual pages had an "x" in the volume number: for example, 1x.

Processing expectations

The content of ManVolNum is usually printed in parentheses after the element title or citation.

Parents

These elements contain ManVolNum: CiteRefEntry, RefMeta.

Children

The following elements occur in ManVolNum: Acronym, Anchor, Comment, Emphasis, IndexTerm, InlineGraphic, InlineMediaObject, Link, OLink, Subscript, Superscript, Trademark, ULink.

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

In some contexts, the following elements are excluded: Acronym, IndexTerm.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
For a further description of print formats, consult the
<citerefentry><refentrytitle>printf</refentrytitle>
<manvolnum>3S</manvolnum></citerefentry> manual page.
</para>

For a further description of print formats, consult the printf(3S) manual page.

For additional examples, see also CiteRefEntry.

Prev	Home	Next
LoTentry	Up	Markup


	DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide