/usr/share/doc/texinfo/html/Cross-Reference-Parts.html is in texinfo-doc-nonfree 5.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | <!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: Cross Reference Parts</title>
<meta name="description" content="GNU Texinfo 5.2: Cross Reference Parts">
<meta name="keywords" content="GNU Texinfo 5.2: Cross Reference Parts">
<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="Cross-References.html#Cross-References" rel="up" title="Cross References">
<link href="_0040xref.html#g_t_0040xref" rel="next" title="@xref">
<link href="Cross-Reference-Commands.html#Cross-Reference-Commands" rel="previous" title="Cross Reference Commands">
<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="Cross-Reference-Parts"></a>
<div class="header">
<p>
Next: <a href="_0040xref.html#g_t_0040xref" accesskey="n" rel="next"><tt>@xref</tt></a>, Previous: <a href="Cross-Reference-Commands.html#Cross-Reference-Commands" accesskey="p" rel="previous">Cross Reference Commands</a>, Up: <a href="Cross-References.html#Cross-References" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Parts-of-a-Cross-Reference"></a>
<h3 class="section">8.3 Parts of a Cross Reference</h3>
<a name="index-Cross-reference-parts"></a>
<a name="index-Parts-of-a-cross-reference"></a>
<p>A cross reference command to a node requires only one argument, which
is the name of the node to which it refers. But a cross reference
command may contain up to four additional arguments. By using these
arguments, you can provide a cross reference name, a topic description
or section title for the printed output, the name of a different
manual file, and the name of a different printed manual. To refer
to another manual as a whole, the manual file and/or the name of the
printed manual are the only required arguments (see <a href="Top-Node-Naming.html#Top-Node-Naming">Top Node Naming</a>).
</p>
<p>Here is a simple cross reference example:
</p>
<div class="example">
<pre class="example">@xref{Node name}.
</pre></div>
<p>which produces
</p>
<div class="example">
<pre class="example">*Note Node name::.
</pre></div>
<p>in Info and
</p>
<blockquote>
<p>See Section <var>nnn</var> [Node name], page <var>ppp</var>.
</p></blockquote>
<p>in a printed manual.
</p>
<p>Here is an example of a full five-part cross reference:
</p>
<div class="example">
<pre class="example">@xref{Node name, Cross Reference Name, Particular Topic,
info-file-name, A Printed Manual}, for details.
</pre></div>
<p>which produces
</p>
<div class="example">
<pre class="example">*Note Cross Reference Name: (info-file-name)Node name,
for details.
</pre></div>
<p>in Info and
</p>
<blockquote>
<p>See section “Particular Topic” in <i>A Printed Manual</i>, for details.
</p></blockquote>
<p>in a printed book.
</p>
<p>The five possible arguments for a cross reference are:
</p>
<ol>
<li> The node or anchor name (required, except for reference to whole
manuals). This is the location to which the cross reference takes
you. In a printed document, the location of the node provides the
page reference only for references within the same document.
</li><li> The cross reference name. If you include this argument, it becomes
the first part of the cross reference. It is usually omitted; then
the topic description (third argument) is used if it was specified;
if that was omitted as well, the node name is used.
</li><li> A topic description or section name. Often, this is the title of the
section. This is used as the name of the reference in the printed
manual. If omitted, the node name is used.
</li><li> The name of the manual file in which the reference is located, if it is
different from the current file. This name is used both for Info and
HTML.
</li><li> The name of a printed manual from a different Texinfo file.
</li></ol>
<p>The template for a full five argument cross reference looks like
this:
</p>
<div class="example">
<pre class="example">@xref{<var>node-name</var>, <var>cross-reference-name</var>, <var>title-or-topic</var>,
<var>info-file-name</var>, <var>printed-manual-title</var>}.
</pre></div>
<p>Cross references with one, two, three, four, and five arguments are
described separately following the description of <code>@xref</code>.
</p>
<p>Write a node name in a cross reference in exactly the same way as in
the <code>@node</code> line, including the same capitalization; otherwise, the
formatters may not find the reference.
</p>
<p><code>makeinfo</code> warns when the text of a cross reference (and node
names and menu items) contains a problematic construct that will
interfere with its parsing in Info. If you don’t want to see the
warnings, you can set the customization variable
<code>INFO_SPECIAL_CHARS_WARNING</code> to ‘<samp>0</samp>’ (see <a href="Other-Customization-Variables.html#Other-Customization-Variables">Other Customization Variables</a>).
</p>
<hr>
<div class="header">
<p>
Next: <a href="_0040xref.html#g_t_0040xref" accesskey="n" rel="next"><tt>@xref</tt></a>, Previous: <a href="Cross-Reference-Commands.html#Cross-Reference-Commands" accesskey="p" rel="previous">Cross Reference Commands</a>, Up: <a href="Cross-References.html#Cross-References" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|