DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

CiteRefEntry

Name

CiteRefEntry -- A citation to a reference page

Synopsis

Content Model

CiteRefEntry ::=
(RefEntryTitle,ManVolNum?)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%gen.char.class;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%screen.content;
%tbl.entry.mdl;%title.char.mix;

Description

This element is a citation to a RefEntry. It must include a RefEntryTitle that should exactly match the title of a RefEntry.

Processing expectations

This element implicitly links to the RefEntry with the same RefEntryTitle (in the same volume, as defined by ManVolNum).

Formatted inline. Usually the ManVolNum is put in parentheses.

Parents

These elements contain CiteRefEntry: Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Comment, Emphasis, entry, ForeignPhrase, GlossSee, GlossSeeAlso, GlossTerm, LineAnnotation, Link, LiteralLayout, LoTentry, Member, MsgAud, OLink, Para, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Quote, RefEntryTitle, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, ULink.

Children

The following elements occur in CiteRefEntry: ManVolNum, RefEntryTitle.

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

See Also

Citation, CiteTitle

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
For a further description of print formats, consult the
<citerefentry><refentrytitle>printf</refentrytitle>
<manvolnum>3S</manvolnum></citerefentry> manual page.
</para>

For a further description of print formats, consult the printf(3S) manual page.

For additional examples, see also ManVolNum.

PrevHomeNext
CitationUpCiteTitle

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.