DocBook 5: The Definitive Guide

Name

citerefentry — A citation to a reference page

Synopsis

citerefentry ::= (refentrytitle, manvolnum?)

Attribute synopsis

Common attributes and common linking attributes.

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.

See Also

citation, citebiblioid, citetitle

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example citerefentry</title>

<para>For a further description of print formats, consult the
<citerefentry><refentrytitle>printf</refentrytitle>
<manvolnum>3S</manvolnum></citerefentry> manual page.
</para>

</article>

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