texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / Cross-Reference-Parts.html

This file is indexed.

/usr/share/doc/texinfo/html/Cross-Reference-Parts.html is in texinfo-doc-nonfree 4.13a-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
<html lang="en">
<head>
<title>Cross Reference Parts - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Cross-References.html#Cross-References" title="Cross References">
<link rel="prev" href="Cross-Reference-Commands.html#Cross-Reference-Commands" title="Cross Reference Commands">
<link rel="next" href="xref.html#xref" title="xref">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 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 are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="Cross-Reference-Parts"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="xref.html#xref">xref</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Cross-Reference-Commands.html#Cross-Reference-Commands">Cross Reference Commands</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Cross-References.html#Cross-References">Cross References</a>
<hr>
</div>

<!-- node-name,  next,  previous,  up -->
<h3 class="section">8.3 Parts of a Cross Reference</h3>

<p><a name="index-Cross-reference-parts-368"></a><a name="index-Parts-of-a-cross-reference-369"></a>
A cross reference command 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 for Info, a topic
description or section title for the printed output, the name of a
different Info file, and the name of a different printed
manual.

  <p>Here is a simple cross reference example:

<pre class="example">     @xref{Node name}.
</pre>
  <p class="noindent">which produces

<pre class="example">     *Note Node name::.
</pre>
  <p class="noindent">and

  <blockquote>
See Section <var>nnn</var> [Node name], page <var>ppp</var>. 
</blockquote>

  <p>Here is an example of a full five-part cross reference:

<pre class="example">     @xref{Node name, Cross Reference Name, Particular Topic,
     info-file-name, A Printed Manual}, for details.
</pre>
  <p class="noindent">which produces

<pre class="example">     *Note Cross Reference Name: (info-file-name)Node name,
     for details.
</pre>
  <p class="noindent">in Info and

  <blockquote>
See section &ldquo;Particular Topic&rdquo; in <i>A Printed Manual</i>, for details. 
</blockquote>

<p class="noindent">in a printed book.

  <p>The five possible arguments for a cross reference are:

     <ol type=1 start=1>
<li>The node or anchor name (required).  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>The cross reference name for the Info reference, if it is to be
different from the node name or the topic description.  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>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>The name of the Info file in which the reference is located, if it is
different from the current file.  You need not include any &lsquo;<samp><span class="samp">.info</span></samp>&rsquo;
suffix on the file name, since Info readers try appending it
automatically.

     <li>The name of a printed manual from a different Texinfo file.
       </ol>

  <p>The template for a full five argument cross reference looks like
this:

<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>
  <p>Cross references with one, two, three, four, and five arguments are
described separately following the description of <code>@xref</code>.

  <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>You can write cross reference commands within a paragraph, but note
how Info and TeX format the output of each of the various commands:
write <code>@xref</code> at the beginning of a sentence; write
<code>@pxref</code> only within parentheses, and so on.

  </body></html>

APT Browse - Built by Thomas Orozco.