citerefentry

citerefentry — A citation to a reference page.

Synopsis

citerefentry ::=

Sequence of:
- refentrytitle
- manvolnum?

Attributes

Common attributes and common linking attributes.

No 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 and common linking attributes.

any attribute: Any attribute in any other explicit namespace

Parents

These elements contain citerefentry: biblioentry, bibliomixed, bibliomset, biblioset, bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), foreignphrase (db.foreignphrase), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, meta (db.meta.content), olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.

Children

The following elements occur in citerefentry: manvolnum, refentrytitle.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example citerefentry</title>
  | 
  |<para>For a further description of print formats, consult the
5 |<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.