citerefentry

citerefentry — A citation to a reference page.

Synopsis

citerefentry ::=

Attributes

Common attributes (ID required).

Additional 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.

    Attributes

    Common attributes (ID required).

    Children

    The following elements occur in citerefentry: manvolnum, refentrytitle.

    Examples

      1 <article xmlns='http://docbook.org/ns/docbook'>
      2 <title>Example citerefentry</title>
        
      4 <para>For a further description of print formats, consult the
        <citerefentry><refentrytitle>printf</refentrytitle>
      6 <manvolnum>3S</manvolnum></citerefentry> manual page.
        </para>
      8 
        </article>

    For a further description of print formats, consult the printf

    <manvolnum>3S</manvolnum>
    manual page.

    Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)