/usr/share/doc/texinfo/html/Three-Arguments.html

<html lang="en">
<head>
<title>Three Arguments - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="xref.html#xref" title="xref">
<link rel="prev" href="Two-Arguments.html#Two-Arguments" title="Two Arguments">
<link rel="next" href="Four-and-Five-Arguments.html#Four-and-Five-Arguments" title="Four and Five Arguments">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 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 are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="Three-Arguments"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Four-and-Five-Arguments.html#Four-and-Five-Arguments">Four and Five Arguments</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Two-Arguments.html#Two-Arguments">Two Arguments</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="xref.html#xref">xref</a>
<hr>
</div>

<h4 class="subsection">8.4.4 <code>@xref</code> with Three Arguments</h4>

<p>A third argument replaces the node name in the TeX output.  The third
argument should be the name of the section in the printed output, or
else state the topic discussed by that section.  Often, you will want to
use initial upper case letters so it will be easier to read when the
reference is printed.  Use a third argument when the node name is
unsuitable because of syntax or meaning.

  <p>Remember to avoid placing a comma within the title or topic section of
a cross reference, or within any other section.  The formatters divide
cross references into arguments according to the commas; a comma
within a title or other section will divide it into two arguments.  In
a reference, you need to write a title such as &ldquo;Clouds, Mist, and
Fog&rdquo; without the commas.

  <p>Also, remember to write a comma or period after the closing brace of an
<code>@xref</code> to terminate the cross reference.  In the following
examples, a clause follows a terminating comma.

<p class="noindent">The template is like this:

<pre class="example">     @xref{<var>node-name</var>, <var>cross-reference-name</var>, <var>title-or-topic</var>}.
</pre>
  <p class="noindent">For example,

<pre class="example">     @xref{Electrical Effects, Lightning, Thunder and Lightning},
     for details.
</pre>
  <p class="noindent">produces

<pre class="example">     *Note Lightning: Electrical Effects, for details.
</pre>
  <p class="noindent">and

  <blockquote>
See Section 5.2 [Thunder and Lightning], page 57, for details. 
</blockquote>

  <p>If a third argument is given and the second one is empty, then the
third argument serves both.  (Note how two commas, side by side, mark
the empty second argument.)

<pre class="example">     @xref{Electrical Effects, , Thunder and Lightning},
     for details.
</pre>
  <p class="noindent">produces

<pre class="example">     *Note Thunder and Lightning: Electrical Effects, for details.
</pre>
  <p class="noindent">and

  <blockquote>
See Section 5.2 [Thunder and Lightning], page 57, for details. 
</blockquote>

  <p>As a practical matter, it is often best to write cross references with
just the first argument if the node name and the section title are the
same, and with the first and third arguments if the node name and title
are different.

  <p>Here are several examples from <cite>The GNU Awk User's Guide</cite>:

<pre class="smallexample">     @xref{Sample Program}.
     @xref{Glossary}.
     @xref{Case-sensitivity, ,Case-sensitivity in Matching}.
     @xref{Close Output, , Closing Output Files and Pipes},
       for more information.
     @xref{Regexp, , Regular Expressions as Patterns}.
</pre>
  </body></html>
texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / Three-Arguments.html
