/usr/share/doc/texinfo/html/Four-and-Five-Arguments.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 5.2, 26 September 2013),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Four and Five Arguments</title>

<meta name="description" content="GNU Texinfo 5.2: Four and Five Arguments">
<meta name="keywords" content="GNU Texinfo 5.2: Four and Five Arguments">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="_0040xref.html#g_t_0040xref" rel="up" title="@xref">
<link href="Top-Node-Naming.html#Top-Node-Naming" rel="next" title="Top Node Naming">
<link href="Three-Arguments.html#Three-Arguments" rel="previous" title="Three Arguments">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Four-and-Five-Arguments"></a>
<div class="header">
<p>
Previous: <a href="Three-Arguments.html#Three-Arguments" accesskey="p" rel="previous">Three Arguments</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><tt>@xref</tt></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="g_t_0040xref-with-Four-and-Five-Arguments"></a>
<h4 class="subsection">8.4.5 <code>@xref</code> with Four and Five Arguments</h4>
<a name="index-Four_002d-and-five-argument-forms-of-cross-references"></a>

<p>In a cross reference, a fourth argument specifies the name of another
Info file, different from the file in which the reference appears, and
a fifth argument specifies its title as a printed manual.
</p>
<p>Remember that a comma or period must follow the closing brace of an
<code>@xref</code> command to terminate the cross reference.
</p>
<p>The full template is:
</p>
<div class="example">
<pre class="example">@xref{<var>node-name</var>, <var>cross-reference-name</var>, <var>title-or-topic</var>,
<var>info-file-name</var>, <var>printed-manual-title</var>}.
</pre></div>

<p>For example,
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects, Lightning, Thunder and Lightning,
weather, An Introduction to Meteorology}.
</pre></div>

<p>produces this output in Info:
</p>
<div class="example">
<pre class="example">*Note Lightning: (weather)Electrical Effects.
</pre></div>

<p>As you can see, the name of the Info file is enclosed in parentheses
and precedes the name of the node.
</p>
<p>In a printed manual, the reference looks like this:
</p>
<blockquote>
<p>See section &ldquo;Thunder and Lightning&rdquo; in <cite>An Introduction to
Meteorology</cite>.
</p></blockquote>

<p>The title of the printed manual is typeset like <code>@cite</code>; and the
reference lacks a page number since TeX cannot know to which page a
reference refers when that reference is to another manual.
</p>
<p>Next case: often, you will leave out the second argument when you use
the long version of <code>@xref</code>.  In this case, the third argument,
the topic description, will be used as the cross reference name in
Info.  For example,
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects, , Thunder and Lightning,
weather, An Introduction to Meteorology}.
</pre></div>

<p>produces
</p>
<div class="example">
<pre class="example">*Note Thunder and Lightning: (weather)Electrical Effects.
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>See section &ldquo;Thunder and Lightning&rdquo; in <cite>An Introduction to
Meteorology</cite>.
</p></blockquote>

<p>in a printed manual.
</p>
<p>Next case: If the node name and the section title are the same in the
other manual, you may also leave out the section title.  In this case,
the node name is used in both instances.  For example,
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects,,,
weather, An Introduction to Meteorology}.
</pre></div>

<p>produces
</p>
<div class="example">
<pre class="example">*Note (weather)Electrical Effects::.
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>See section &ldquo;Electrical Effects&rdquo; in <cite>An Introduction to
Meteorology</cite>.
</p></blockquote>

<p>in a printed manual.
</p>
<p>A very unusual case: you may want to refer to another manual file that
is within a single printed manual&mdash;when multiple Texinfo files are
incorporated into the same TeX run but can create separate Info or
HTML output files.  In this case, you need to specify only the fourth
argument, and not the fifth.
</p>
<p>Finally, it&rsquo;s also allowed to leave out all the arguments
<em>except</em> the fourth and fifth, to refer to another manual as a
whole.  See the next section.
</p>

<hr>
<div class="header">
<p>
Previous: <a href="Three-Arguments.html#Three-Arguments" accesskey="p" rel="previous">Three Arguments</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><tt>@xref</tt></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Four-and-Five-Arguments.html
