/usr/share/doc/texinfo/html/Two-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: Two Arguments</title>

<meta name="description" content="GNU Texinfo 5.2: Two Arguments">
<meta name="keywords" content="GNU Texinfo 5.2: Two 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="Three-Arguments.html#Three-Arguments" rel="next" title="Three Arguments">
<link href="One-Argument.html#One-Argument" rel="previous" title="One Argument">
<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="Two-Arguments"></a>
<div class="header">
<p>
Next: <a href="Three-Arguments.html#Three-Arguments" accesskey="n" rel="next">Three Arguments</a>, Previous: <a href="One-Argument.html#One-Argument" accesskey="p" rel="previous">One Argument</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-Two-Arguments"></a>
<h4 class="subsection">8.4.3 <code>@xref</code> with Two Arguments</h4>
<a name="index-Two_002dargument-form-of-cross-references"></a>

<p>With two arguments, the second is used as the name of the cross
reference, while the first is still the name of the node to which the
cross reference points.
</p>
<p>The template is like this:
</p>
<div class="example">
<pre class="example">@xref{<var>node-name</var>, <var>cross-reference-name</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.
(Note that in the preceding example the closing brace is followed by a
period; and that the node name is printed, not the cross reference name.)
</p>
<p>You can write a clause after the cross reference, like this:
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects, Lightning}, for more info.
</pre></div>

<p>which produces
</p>
<div class="example">
<pre class="example">*Note Lightning: Electrical Effects, for more info.
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>See Section 5.2 [Electrical Effects], page 57, for more info.
</p></blockquote>

<p>in a printed manual.  (Note that in the preceding example the closing
brace is followed by a comma, and then by the clause, which is
followed by a period.)
</p>
<p>The second argument to cross references must observe some of the
restrictions for node names (see <a href="Node-Line-Requirements.html#Node-Line-Requirements">Node Line Requirements</a>).  The
most common issue is that colons cannot be used, since that interferes
with the parsing of the Info file.
</p>




</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Two-Arguments.html
