Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

Reference
Guide to the DocBook DTD
PrevNext

Reference

Name

Reference -- Collection of RefEntries, forming a book component

Content Model

  ((DocInfo?, Title, TitleAbbrev?), PartIntro?
  , (RefEntry)+)+
  (IndexTerm | BeginPage)

Inclusions

Reference includes these elements at every level:

  IndexTerm | BeginPage

Attributes

This element has common and Role attributes.

NameValue(s)TypeDefault Value
LabelCDATA#IMPLIED 
StatusCDATA#IMPLIED 

Tag Minimization

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

Description

Collection of RefEntries, forming a book component. Reference has an optional DocInfo, a required Title, an optional TitleAbbrev, an optional PartIntro, and one or more RefEntries. It has Status, Label, and common attributes.

Parents

These elements contain Reference: Book, Part.

Children

Reference contains these elements: BeginPage, DocInfo, IndexTerm, PartIntro, RefEntry, Title, TitleAbbrev.

In some contexts, additional elements may be allowed by inclusions in parent elements.

Attributes

Label

Label holds an identifying number or string to be output in some manner when the element it is applied to is rendered.

Status

Editorial or publication status ofthe element it applies to, such as "in review" or "approved for distribution." There is no default.

Examples

<REFERENCE>
<TITLE>Reference Pages</TITLE>
<PARTINTRO>
<PARA>These reference pages document all the functions of the
Realtime Reality Realizer.
</PARA>
</PARTINTRO>
<REFENTRY>
<REFNAMEDIV>
<REFNAME>Start</REFNAME>
<REFPURPOSE>Starts the program</REFPURPOSE>
</REFNAMEDIV>
<REFSECT1>
<TITLE>Description</TITLE>
<PARA>Starts the program, and then the program runs.</PARA>
</REFSECT1>
</REFENTRY>
<REFENTRY>
<REFNAMEDIV>
<REFNAME>Stop</REFNAME>
<REFPURPOSE>Ends the program</REFPURPOSE>
</REFNAMEDIV>
<REFSECT1>
<TITLE>Description</TITLE>
<PARA>Brings the program to an end, deleting all data</PARA>
</REFSECT1>
</REFENTRY>
</REFERENCE>
PrevHomeNext
RefEntryUpRefMeta