Name
reference — A collection of reference entries
Synopsis
reference ::=
((((title
&
titleabbrev
? & subtitle
?),
info
? db.titleforbidden.info) |
info
db.titlereq.info),
partintro
?, refentry
+)
Additional constraints
If this element is the root element, it must have a
version
attribute.
Description
A reference
is a collection of
refentry
s. In a book
, a
reference
can occur at either the
part
or the chapter
level.
Reference pages are usually bound together by topic; in
traditional UNIX documentation they are most
frequently bound into volumes. See manvolnum
.
Processing expectations
Formatted as a displayed block. A reference
often introduces a forced page break and may start on the next recto
page. Frequently, it also produces a separator page, on which may be
printed the content of the partintro
.
Attributes
Common attributes and common linking attributes.
- label
Specifies an identifying string for presentation purposes
- status
Identifies the editorial or publication status of the element on which it occurs
Examples
<reference xmlns='http://docbook.org/ns/docbook'> <title>Reference Pages</title> <refentry> <refnamediv> <refdescriptor>GNU as</refdescriptor> <refname>as</refname> <refpurpose>the portable GNU assembler</refpurpose> </refnamediv> <refsynopsisdiv><title>SYNOPSIS</title> <synopsis>...</synopsis> </refsynopsisdiv> <refsect1><title>DESCRIPTION</title> <para>...</para> </refsect1> </refentry> <refentry> ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.