File Manager

Editing File: /usr/share/doc/texinfo/html/References.html

<!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 6.7, 23 September 2019),
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, 2014, 2015, 2016, 2017, 2018, 2019 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". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>References (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<span id="References"></span><div class="header">
<p>
Next: <a href="Cross-Reference-Commands.html" accesskey="n" rel="next">Cross Reference Commands</a>, Up: <a href="Cross-References.html" accesskey="u" rel="up">Cross References</a> &nbsp; [<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="What-References-Are-For"></span><h3 class="section">6.1 What References Are For</h3>

<p>Often, but not always, a printed document should be designed so that
it can be read sequentially.  People tire of flipping back and forth
to find information that should be presented to them as they need
it.
</p>
<p>However, in any document, some information will be too detailed for
the current context, or incidental to it; use cross-references to
provide access to such information.  Also, an online help system or a
reference manual is not like a novel; few read such documents in
sequence from beginning to end.  Instead, people look up what they
need.  For this reason, such creations should contain many cross
references to help readers find other information that they may not
have read.
</p>
<p>In a printed manual, a cross-reference results in a page reference,
unless it is to another manual altogether, in which case the
cross-reference names that manual.  In Info, a cross-reference results
in an entry that you can follow using the Info &lsquo;<samp>f</samp>&rsquo; command.
(See <a href="../info/Help_002dXref.html#Help_002dXref">Following cross-references</a> in <cite>Info</cite>.)  In HTML, a
cross-reference results in an hyperlink.
</p>
<p>The various cross-reference commands use nodes (or anchors,
see <a href="_0040anchor.html"><code>@anchor</code></a>) to define cross-reference locations.
TeX needs nodes to define cross-reference locations.  When TeX
generates a DVI file, it records each node&rsquo;s page number and uses the 
page numbers in making references.  Thus, even if you are writing a 
manual that will only be printed, and not used online, you must 
nonetheless write <code>@node</code> lines in order to name the places to 
which you make cross-references.
</p>

</body>
</html>

Back to Directory File Manager