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

reference — A collection of reference entries

Synopsis

reference ::= ((((title & titleabbrev? & subtitle?), infodb.titleforbidden.info) | info db.titlereq.info), partintro?, refentry+)

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • label

  • status

Additional constraints

  • If this element is the root element, it must have a version attribute.

Description

A reference is a collection of refentrys. 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> ...

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