ManVolNum ::= ((#PCDATA|Acronym|Emphasis|Trademark|Link|OLink|ULink|Anchor| Comment|Subscript|Superscript|InlineGraphic|InlineMediaObject| IndexTerm)+)
The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.
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.
The content of ManVolNum is usually printed in parentheses after the element title or citation.
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.
<!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.
Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.
HIVE: All information for read only. Please respect copyright! |
