JezK
Edit File: Three-Arguments.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://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.8, 8 June 2021), 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-2021 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.8)</title> <meta name="description" content="Three Arguments (GNU Texinfo 6.8)"> <meta name="keywords" content="Three Arguments (GNU Texinfo 6.8)"> <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"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="Three-Arguments"> <div class="header"> <p> Next: <a href="Four-and-Five-Arguments.html" accesskey="n" rel="next"><code>@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html" accesskey="p" rel="prev"><code>@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html" accesskey="u" rel="up"><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> <span id="g_t_0040xref-with-Three-Arguments"></span><h4 class="subsection">5.4.3 <code>@xref</code> with Three Arguments</h4> <span id="index-Three_002dargument-form-of-cross_002dreferences"></span> <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"> <pre class="example">@xref{<var>node-name</var>, <var>online-label</var>, <var>printed-label</var>}. </pre></div> <p>For example, </p> <div class="example"> <pre class="example">@xref{Electrical Effects, Lightning, Thunder and Lightning}, for details. </pre></div> <p>produces </p> <div class="example"> <pre class="example">*Note Lightning: Electrical Effects, for details. </pre></div> <p>in Info and </p> <blockquote> <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"> <pre class="example">@xref{Electrical Effects, , Thunder and Lightning}, for details. </pre></div> <p>produces </p> <div class="example"> <pre class="example">*Note Thunder and Lightning: Electrical Effects, for details. </pre></div> <p>in Info and </p> <blockquote> <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 href="Node-Line-Requirements.html"><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> <span id="index-xrefautomaticsectiontitle"></span> <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">@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>@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>@xrefautomaticsectiontitle</code> is on, the sections names are used in node headers instead of the node names when possible. </p> </div> <hr> <div class="header"> <p> Next: <a href="Four-and-Five-Arguments.html"><code>@xref</code> with Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html"><code>@xref</code> with Two Arguments</a>, Up: <a href="_0040xref.html"><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>