/usr/share/doc/texinfo/html/Reference-Syntax.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 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: Reference Syntax</title>

<meta name="description" content="GNU Texinfo 5.2: Reference Syntax">
<meta name="keywords" content="GNU Texinfo 5.2: Reference Syntax">
<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="_0040xref.html#g_t_0040xref" rel="up" title="@xref">
<link href="One-Argument.html#One-Argument" rel="next" title="One Argument">
<link href="_0040xref.html#g_t_0040xref" rel="previous" title="@xref">
<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="Reference-Syntax"></a>
<div class="header">
<p>
Next: <a href="One-Argument.html#One-Argument" accesskey="n" rel="next">One Argument</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><tt>@xref</tt></a> &nbsp; [<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="What-a-Reference-Looks-Like-and-Requires"></a>
<h4 class="subsection">8.4.1 What a Reference Looks Like and Requires</h4>

<p>Most often, an Info cross reference looks like this:
</p>
<div class="example">
<pre class="example">*Note <var>node-name</var>::.
</pre></div>

<p>or like this
</p>
<div class="example">
<pre class="example">*Note <var>cross-reference-name</var>: <var>node-name</var>.
</pre></div>

<p>In TeX, a cross reference looks like this:
</p>
<blockquote>
<p>See Section <var>section-number</var> [<var>node-name</var>], page <var>page</var>.
</p></blockquote>

<p>or like this
</p>
<blockquote>
<p>See Section <var>section-number</var> [<var>title-or-topic</var>], page <var>page</var>.
</p></blockquote>

<p>The <code>@xref</code> command does not generate a period or comma to end
the cross reference automatically.  You must write that period or
comma yourself; otherwise, Info will not recognize the end of the
reference.  (The <code>@pxref</code> command works differently;
see <a href="_0040pxref.html#g_t_0040pxref"><tt>@pxref</tt></a>.)
</p>
<blockquote>
<p><b>Caution:</b> A period or comma <em>must</em> follow the closing brace of an
<code>@xref</code>.  It is required to terminate the cross reference.  This
period or comma will appear in the output.
</p></blockquote>

<p><code>@xref</code> must refer to a node by name.  Use <code>@node</code> to
define the node (see <a href="Writing-a-Node.html#Writing-a-Node">Writing a Node</a>), or <code>@anchor</code>
(see <a href="_0040anchor.html#g_t_0040anchor"><tt>@anchor</tt></a>).
</p>
<p><code>@xref</code> is followed by several arguments inside braces,
separated by commas.  Whitespace before and after these commas is
ignored.
</p>
<p>A cross reference to a node within the current file requires only the
name of a node; but it may contain up to four additional arguments.
Each of these variations produces a cross reference that looks
somewhat different.  A cross reference to another manual as a whole
only requires the fourth or fifth argument.
</p>
<blockquote>
<p><b>Note:</b> Commas separate arguments in a cross reference, so you must not
include a comma in the title or any other part lest the formatters
mistake them for separators.  <code>@comma{}</code> may be used to
protect such commas (see <a href="Inserting-a-Comma.html#Inserting-a-Comma">Inserting a Comma</a>).
</p></blockquote>


<hr>
<div class="header">
<p>
Next: <a href="One-Argument.html#One-Argument" accesskey="n" rel="next">One Argument</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><tt>@xref</tt></a> &nbsp; [<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>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Reference-Syntax.html
