DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

reference

reference — A collection of reference entries.

Synopsis

reference ::=

Attributes

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

Parents

These elements contain reference: book, part.

Children

The following elements occur in reference: info (db.titleforbidden.info), info (db.titlereq.info), partintro, refentry, subtitle, title, titleabbrev.

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>
    <refnamediv>
      <refname>awk</refname>
      <refpurpose>pattern scanning and text processing language</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>SYNOPSIS</title>
    <synopsis>...</synopsis>
    </refsynopsisdiv>
    <refsect1><title>DESCRIPTION</title>
    <para>...</para>
    </refsect1>
  </refentry>

  <!-- ... -->

</reference>