| <!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>@ref (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@ref (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@ref (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="_0040pxref.html" rel="next" title="@pxref"> |
| <link href="Referring-to-a-Manual-as-a-Whole.html" rel="prev" title="Referring to a Manual as a Whole"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="g_t_0040ref"> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="_0040pxref.html" accesskey="n" rel="next"><code class="code">@pxref</code></a>, Previous: <a href="Referring-to-a-Manual-as-a-Whole.html" accesskey="p" rel="prev">Referring to a Manual as a Whole</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_0040ref-1">5.6 <code class="code">@ref</code></h3> |
| |
| <a class="anchor" id="ref"></a><a class="index-entry-id" id="index-ref"></a> |
| <a class="index-entry-id" id="index-Cross_002dreferences-using-_0040ref"></a> |
| <a class="index-entry-id" id="index-References-using-_0040ref"></a> |
| |
| <p><code class="code">@ref</code> is nearly the same as <code class="code">@xref</code> except that it does |
| not generate a ‘See’ in the printed output, just the reference itself. |
| This makes it useful as the last part of a sentence. |
| </p> |
| <p>For example, |
| </p> |
| <a class="index-entry-id" id="index-Hurricanes"></a> |
| <div class="example"> |
| <pre class="example-preformatted">For more information, @pxref{This}, and @ref{That}. |
| </pre></div> |
| |
| <p>produces in Info: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">For more information, *note This::, and *note That::. |
| </pre></div> |
| |
| <p>and in printed output: |
| </p> |
| <blockquote class="quotation"> |
| <p>For more information, see Section 1.1 [This], page 1, |
| and Section 1.2 [That], page 2. |
| </p></blockquote> |
| |
| <p>The <code class="code">@ref</code> command can tempt writers to express themselves in a |
| manner that is suitable for a printed manual but looks awkward in the |
| Info format. Bear in mind that your audience could be using both the |
| printed and the Info format. For example: |
| </p> |
| <a class="index-entry-id" id="index-Sea-surges"></a> |
| <div class="example"> |
| <pre class="example-preformatted">Sea surges are described in @ref{Hurricanes}. |
| </pre></div> |
| |
| <p>looks ok in the printed output: |
| </p> |
| <blockquote class="quotation"> |
| <p>Sea surges are described in Section 6.7 [Hurricanes], page 72. |
| </p></blockquote> |
| |
| <p>but is awkward to read in Info, “note” being a verb: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">Sea surges are described in *note Hurricanes::. |
| </pre></div> |
| |
| |
| </div> |
| |
| |
| |
| </body> |
| </html> |
