JezK
Edit File: _0040inforef.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>@inforef (GNU Texinfo 6.8)</title> <meta name="description" content="@inforef (GNU Texinfo 6.8)"> <meta name="keywords" content="@inforef (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="Cross-References.html" rel="up" title="Cross References"> <link href="_0040url.html" rel="next" title="@url"> <link href="_0040anchor.html" rel="prev" title="@anchor"> <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="section" id="g_t_0040inforef"> <div class="header"> <p> Next: <a href="_0040url.html" accesskey="n" rel="next"><code>@url</code>, <code>@uref{<var>url</var>[, <var>text</var>][, <var>replacement</var>]}</code></a>, Previous: <a href="_0040anchor.html" accesskey="p" rel="prev"><code>@anchor</code>: Defining Arbitrary Cross-reference Targets</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> <span id="g_t_0040inforef_003a-Cross_002dreferences-to-Info_002donly-Material"></span><h3 class="section">5.9 <code>@inforef</code>: Cross-references to Info-only Material</h3> <span id="inforef"></span><span id="index-inforef"></span> <span id="index-Cross_002dreferences-using-_0040inforef"></span> <span id="index-References-using-_0040inforef"></span> <p><code>@inforef</code> is used for making cross-references to Info documents—even from a printed manual. This was originally used for Info files that were not generated from any Texinfo source. The command is now obsolete and should not be used. </p> <p>The command takes either two or three arguments, in the following order: </p> <ol> <li> The node name. </li><li> The cross-reference name (optional). </li><li> The Info file name. </li></ol> <p>The template is: </p> <div class="example"> <pre class="example">@inforef{<var>node-name</var>, <var>cross-reference-name</var>, <var>info-file-name</var>} </pre></div> <p>For example, </p> <div class="example"> <pre class="example">@inforef{Advanced, Advanced Info commands, info}, for more information. </pre></div> <p>produces (in Info): </p> <div class="example"> <pre class="example">*Note Advanced Info commands: (info)Advanced, for more information. </pre></div> <p>and (in the printed output): </p> <blockquote> <p>See Info file <samp>info</samp>, node ‘<samp>Advanced</samp>’, for more information. </p></blockquote> <p>(This particular example is not realistic, since the Info manual is written in Texinfo, so all formats are available. In fact, we don’t know of any extant Info-only manuals.) </p> <p>The converse of <code>@inforef</code> is <code>@cite</code>, which is used to refer to printed works for which no Info form exists. See <a href="_0040cite.html"><code>@cite</code>{<var>reference</var>}</a>. </p> </div> </body> </html>