JezK
Edit File: Two-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>Two Arguments (GNU Texinfo 6.8)</title> <meta name="description" content="Two Arguments (GNU Texinfo 6.8)"> <meta name="keywords" content="Two 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="Three-Arguments.html" rel="next" title="Three Arguments"> <link href="One-Argument.html" rel="prev" title="One Argument"> <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="Two-Arguments"> <div class="header"> <p> Next: <a href="Three-Arguments.html" accesskey="n" rel="next"><code>@xref</code> with Three Arguments</a>, Previous: <a href="One-Argument.html" accesskey="p" rel="prev"><code>@xref</code> with One Argument</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-Two-Arguments"></span><h4 class="subsection">5.4.2 <code>@xref</code> with Two Arguments</h4> <span id="index-Two_002dargument-form-of-cross_002dreferences"></span> <p>With two arguments, the second is used as a label for the online output. </p> <p>The template is like this: </p> <div class="example"> <pre class="example">@xref{<var>node-name</var>, <var>online-label</var>}. </pre></div> <p>For example, </p> <div class="example"> <pre class="example">@xref{Electrical Effects, Lightning}. </pre></div> <p>produces: </p> <div class="example"> <pre class="example">*Note Lightning: Electrical Effects. </pre></div> <p>in Info and </p> <blockquote> <p>See Section 5.2 [Electrical Effects], page 57. </p></blockquote> <p>in a printed manual, where the node name is printed. </p> <p>The second 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> </div> </body> </html>