infog/test-infodir/texinfo_html/Three-Arguments.html - texinfo - Git at Google

 <!DOCTYPE html>
 <html>
 <!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
 a documentation system that can produce both online information and a
 printed manual from a single source using semantic markup.

 Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 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 no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled
 "GNU Free Documentation License". -->
 <title>Three Arguments (GNU Texinfo 6.8dev)</title>

 <meta name="description" content="Three Arguments (GNU Texinfo 6.8dev)">
 <meta name="keywords" content="Three Arguments (GNU Texinfo 6.8dev)">
 <meta name="resource-type" content="document">
 <meta name="distribution" content="global">
 <meta name="Generator" content="texi2any">
 <meta name="viewport" content="width=device-width,initial-scale=1">

 <link href="index.html" rel="start" title="Top">
 <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
 <link href="_0040xref.html" rel="up" title="@xref">
 <link href="Four-and-Five-Arguments.html" rel="next" title="Four and Five Arguments">
 <link href="Two-Arguments.html" rel="prev" title="Two Arguments">
 <style type="text/css">
 <!--
 div.example {margin-left: 3.2em}
 -->
 </style>


 </head>

 <body lang="en">
 <div class="subsection-level-extent" id="Three-Arguments">
 <div class="nav-panel">
 <p>
 Next: <a href="Four-and-Five-Arguments.html" accesskey="n" rel="next"><code class="code">@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html" accesskey="p" rel="prev"><code class="code">@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html" accesskey="u" rel="up"><code class="code">@xref</code></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
 </div>
 <hr>
 <h4 class="subsection" id="g_t_0040xref-with-Three-Arguments">5.4.3 <code class="code">@xref</code> with Three Arguments</h4>
 <a class="index-entry-id" id="index-Three_002dargument-form-of-cross_002dreferences"></a>

 <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.
 </p>
 <p>The template is like this:
 </p>
 <div class="example">
 <div class="group"><pre class="example-preformatted">@xref{<var class="var">node-name</var>, <var class="var">online-label</var>, <var class="var">printed-label</var>}.
 </pre></div></div>

 <p>For example,
 </p>
 <div class="example">
 <div class="group"><pre class="example-preformatted">@xref{Electrical Effects, Lightning, Thunder and Lightning},
 for details.
 </pre></div></div>

 <p>produces
 </p>
 <div class="example">
 <pre class="example-preformatted">*Note Lightning: Electrical Effects, for details.
 </pre></div>

 <p>in Info and
 </p>
 <blockquote class="quotation">
 <p>See Section 5.2 [Thunder and Lightning], page 57, for details.
 </p></blockquote>

 <p>in a printed manual.
 </p>
 <p>If a third argument is given and the second one is empty, then the
 third argument serves for both.  (Note how two commas, side by side, mark
 the empty second argument.)
 </p>
 <div class="example">
 <div class="group"><pre class="example-preformatted">@xref{Electrical Effects, , Thunder and Lightning},
 for details.
 </pre></div></div>

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

 <p>in Info and
 </p>
 <blockquote class="quotation">
 <p>See Section 5.2 [Thunder and Lightning], page 57, for details.
 </p></blockquote>

 <p>in a printed manual.
 </p>
 <p>The third argument to cross-references must observe some of the
 restrictions for node names (see <a class="pxref" href="Node-Line-Requirements.html"><code class="code">@node</code> Line Requirements</a>).  The
 most common issue is that colons cannot be used, since that interferes
 with the parsing of the Info file.
 </p>
 <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 (or nearly so), and with the first and third arguments only if the
 node name and title are different.
 </p>
 <a class="index-entry-id" id="index-xrefautomaticsectiontitle"></a>
 <p>Texinfo offers a setting to use the section title instead of node
 names by default in cross-references (an explicitly specified third
 argument still takes precedence):
 </p>
 <div class="example">
 <pre class="example-preformatted">@xrefautomaticsectiontitle on
 </pre></div>

 <p>Typically this line would be given near the beginning of the document
 and used for the whole manual.  But you can turn it off if you want
 (<code class="code">@xrefautomaticsectiontitle off</code>), for example, if you&rsquo;re
 including some other sub-document that doesn&rsquo;t have suitable section
 names.  This setting also applies to node headers in HTML, if
 <code class="code">@xrefautomaticsectiontitle</code> is on, the sections names are used
 in node headers instead of the node names when possible.
 </p>

 </div>
 <hr>
 <div class="nav-panel">
 <p>
 Next: <a href="Four-and-Five-Arguments.html"><code class="code">@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html"><code class="code">@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html"><code class="code">@xref</code></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
 </div>


 </body>
 </html>
	<!DOCTYPE html>
	<html>
	<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
	a documentation system that can produce both online information and a
	printed manual from a single source using semantic markup.

	Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 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 no Front-Cover Texts, and with no Back-Cover
	Texts. A copy of the license is included in the section entitled
	"GNU Free Documentation License". -->
	<title>Three Arguments (GNU Texinfo 6.8dev)</title>

	<meta name="description" content="Three Arguments (GNU Texinfo 6.8dev)">
	<meta name="keywords" content="Three Arguments (GNU Texinfo 6.8dev)">
	<meta name="resource-type" content="document">
	<meta name="distribution" content="global">
	<meta name="Generator" content="texi2any">
	<meta name="viewport" content="width=device-width,initial-scale=1">

	<link href="index.html" rel="start" title="Top">
	<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
	<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
	<link href="_0040xref.html" rel="up" title="@xref">
	<link href="Four-and-Five-Arguments.html" rel="next" title="Four and Five Arguments">
	<link href="Two-Arguments.html" rel="prev" title="Two Arguments">
	<style type="text/css">
	<!--
	div.example {margin-left: 3.2em}
	-->
	</style>


	</head>

	<body lang="en">
	<div class="subsection-level-extent" id="Three-Arguments">
	<div class="nav-panel">
	<p>
	Next: <a href="Four-and-Five-Arguments.html" accesskey="n" rel="next"><code class="code">@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html" accesskey="p" rel="prev"><code class="code">@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html" accesskey="u" rel="up"><code class="code">@xref</code></a>   [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
	</div>
	<hr>
	<h4 class="subsection" id="g_t_0040xref-with-Three-Arguments">5.4.3 <code class="code">@xref</code> with Three Arguments</h4>
	<a class="index-entry-id" id="index-Three_002dargument-form-of-cross_002dreferences"></a>

	<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.
	</p>
	<p>The template is like this:
	</p>
	<div class="example">
	<div class="group"><pre class="example-preformatted">@xref{<var class="var">node-name</var>, <var class="var">online-label</var>, <var class="var">printed-label</var>}.
	</pre></div></div>

	<p>For example,
	</p>
	<div class="example">
	<div class="group"><pre class="example-preformatted">@xref{Electrical Effects, Lightning, Thunder and Lightning},
	for details.
	</pre></div></div>

	<p>produces
	</p>
	<div class="example">
	<pre class="example-preformatted">*Note Lightning: Electrical Effects, for details.
	</pre></div>

	<p>in Info and
	</p>
	<blockquote class="quotation">
	<p>See Section 5.2 [Thunder and Lightning], page 57, for details.
	</p></blockquote>

	<p>in a printed manual.
	</p>
	<p>If a third argument is given and the second one is empty, then the
	third argument serves for both. (Note how two commas, side by side, mark
	the empty second argument.)
	</p>
	<div class="example">
	<div class="group"><pre class="example-preformatted">@xref{Electrical Effects, , Thunder and Lightning},
	for details.
	</pre></div></div>

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

	<p>in Info and
	</p>
	<blockquote class="quotation">
	<p>See Section 5.2 [Thunder and Lightning], page 57, for details.
	</p></blockquote>

	<p>in a printed manual.
	</p>
	<p>The third argument to cross-references must observe some of the
	restrictions for node names (see <a class="pxref" href="Node-Line-Requirements.html"><code class="code">@node</code> Line Requirements</a>). The
	most common issue is that colons cannot be used, since that interferes
	with the parsing of the Info file.
	</p>
	<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 (or nearly so), and with the first and third arguments only if the
	node name and title are different.
	</p>
	<a class="index-entry-id" id="index-xrefautomaticsectiontitle"></a>
	<p>Texinfo offers a setting to use the section title instead of node
	names by default in cross-references (an explicitly specified third
	argument still takes precedence):
	</p>
	<div class="example">
	<pre class="example-preformatted">@xrefautomaticsectiontitle on
	</pre></div>

	<p>Typically this line would be given near the beginning of the document
	and used for the whole manual. But you can turn it off if you want
	(<code class="code">@xrefautomaticsectiontitle off</code>), for example, if you’re
	including some other sub-document that doesn’t have suitable section
	names. This setting also applies to node headers in HTML, if
	<code class="code">@xrefautomaticsectiontitle</code> is on, the sections names are used
	in node headers instead of the node names when possible.
	</p>

	</div>
	<hr>
	<div class="nav-panel">
	<p>
	Next: <a href="Four-and-Five-Arguments.html"><code class="code">@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html"><code class="code">@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html"><code class="code">@xref</code></a>   [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
	</div>



	</body>
	</html>