| <!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>@pxref (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@pxref (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@pxref (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="Cross-References.html" rel="up" title="Cross References"> |
| <link href="_0040anchor.html" rel="next" title="@anchor"> |
| <link href="_0040ref.html" rel="prev" title="@ref"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="g_t_0040pxref"> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="_0040anchor.html" accesskey="n" rel="next"><code class="code">@anchor</code>: Defining Arbitrary Cross-reference Targets</a>, Previous: <a href="_0040ref.html" accesskey="p" rel="prev"><code class="code">@ref</code></a>, Up: <a href="Cross-References.html" accesskey="u" rel="up">Cross-references</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> |
| <h3 class="section" id="g_t_0040pxref-1">5.7 <code class="code">@pxref</code></h3> |
| |
| <a class="anchor" id="pxref"></a><a class="index-entry-id" id="index-pxref"></a> |
| <a class="index-entry-id" id="index-Cross_002dreferences-using-_0040pxref"></a> |
| <a class="index-entry-id" id="index-References-using-_0040pxref"></a> |
| |
| <p>The parenthetical reference command, <code class="code">@pxref</code>, is nearly the |
| same as <code class="code">@xref</code>, but it is best used within parentheses. |
| The command differs from <code class="code">@xref</code> in that TeX typesets the |
| reference for the printed manual with a lowercase ‘see’ rather than an |
| uppercase ‘See’. |
| </p> |
| <p>With one argument, a parenthetical cross-reference looks like this: |
| </p> |
| <a class="index-entry-id" id="index-Flooding"></a> |
| <div class="example"> |
| <pre class="example-preformatted">… storms cause flooding (@pxref{Hurricanes}) … |
| </pre></div> |
| |
| <p>which produces |
| </p> |
| <div class="example"> |
| <div class="group"><pre class="example-preformatted">… storms cause flooding (*note Hurricanes::) … |
| </pre></div></div> |
| |
| <p>in Info and |
| </p> |
| <blockquote class="quotation"> |
| <p>… storms cause flooding (see Section 6.7 [Hurricanes], page 72) … |
| </p></blockquote> |
| |
| <p>in a printed manual. |
| </p> |
| <p>With two arguments, a parenthetical cross-reference has this template: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">… (@pxref{<var class="var">node-name</var>, <var class="var">cross-reference-name</var>}) … |
| </pre></div> |
| |
| <p>which produces |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">… (*note <var class="var">cross-reference-name</var>: <var class="var">node-name</var>.) … |
| </pre></div> |
| |
| <p>in Info and |
| </p> |
| <blockquote class="quotation"> |
| <p>… (see Section <var class="var">nnn</var> [<var class="var">node-name</var>], page <var class="var">ppp</var>) … |
| </p></blockquote> |
| |
| <p>in a printed manual. |
| </p> |
| <p><code class="code">@pxref</code> can be used with up to five arguments, just like |
| <code class="code">@xref</code> (see <a class="pxref" href="_0040xref.html"><code class="code">@xref</code></a>). |
| </p> |
| <p>In past versions of Texinfo, it was not allowed to write punctuation |
| after a <code class="code">@pxref</code>, so it could be used <em class="emph">only</em> before a |
| right parenthesis. This is no longer the case. |
| The effect of ‘<samp class="samp">@pxref{<var class="var">node-name</var>}</samp>’ is similar to that of |
| ‘<samp class="samp">see @ref{<var class="var">node-name</var>}</samp>’. However, in many circumstances the |
| latter is preferable, as this makes it clear in the Info output that |
| the word “see” should be present. |
| </p> |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="_0040anchor.html"><code class="code">@anchor</code>: Defining Arbitrary Cross-reference Targets</a>, Previous: <a href="_0040ref.html"><code class="code">@ref</code></a>, Up: <a href="Cross-References.html">Cross-references</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> |
