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
Prev		Next

---

Reference

Name

Reference -- A collection of reference entries

Synopsis

Content Model

Reference ::=
((DocInfo?,Title,Subtitle?,TitleAbbrev?),
 PartIntro?,
 (RefEntry)+)

Attributes

Common attributes

Name	Type	Default
Label	CDATA	None
Status	CDATA	None

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Parameter Entities

%partcontent.mix;

Description

A Reference is a collection of RefEntrys. In a Book, a Reference can occur at either the Part or 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. Referencess often introduce a forced page break and may start on the next recto page. Frequently, they also produce a separator page, on which may be printed the content of the PartIntro.

Parents

These elements contain Reference: Book, Part.

Children

The following elements occur in Reference: DocInfo, PartIntro, RefEntry, Subtitle, Title, TitleAbbrev.

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

Attributes

Label

Label specifies an identifying string for presentation purposes.

Generally, an explicit Label attribute is used only if the processing system is incapable of generating the label automatically. If present, the Label is normative; it will used even if the processing system is capable of automatic labelling.

Status

Status identifies the editorial or publication status of the Reference.

Publication status might be used to control formatting (for example, printing a "draft" watermark on drafts) or processing (perhaps a document with a status of "final" should not include any components that are not final).

Examples

<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V3.1//EN">

<reference><title>Reference Pages</title>
<refentry>...</refentry>
<refentry>...</refentry>
...
</reference>

---

Prev	Home	Next
RefEntryTitle	Up	RefMeta

Back to: DocBook: The Definitive Guide