1#@!#!123s

: / usr / share / doc / info / html /
Filename : Parts-of-an-Xref.html
back
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for Stand-alone GNU Info (version 6.7,
23 September 2019), a program for viewing documents in Info format
(usually created from Texinfo source files).

Copyright (C) 1992, 1993, 1996, 1997, 1998, 1999, 2001,
2002, 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" in the Texinfo manual.

This document is part of a collection distributed under the GNU Free
Documentation License.  If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Parts of an Xref (Stand-alone GNU Info 6.7)</title>

<meta name="description" content="Parts of an Xref (Stand-alone GNU Info 6.7)">
<meta name="keywords" content="Parts of an Xref (Stand-alone GNU Info 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Xref-Commands.html" rel="up" title="Xref Commands">
<link href="Selecting-Xrefs.html" rel="next" title="Selecting Xrefs">
<link href="Xref-Commands.html" rel="prev" title="Xref Commands">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Parts-of-an-Xref"></span><div class="header">
<p>
Next: <a href="Selecting-Xrefs.html" accesskey="n" rel="next">Selecting Xrefs</a>, Up: <a href="Xref-Commands.html" accesskey="u" rel="up">Xref Commands</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Parts-of-an-Xref-1"></span><h3 class="section">8.1 Parts of an Xref</h3>

<p>Cross-references have two major parts: the first part is called the
<em>label</em>; it is the name that you can use to refer to the cross
reference, and the second is the <em>target</em>; it is the full name of
the node that the cross-reference points to.
</p>
<p>The target is separated from the label by a colon &lsquo;<samp>:</samp>&rsquo;; first the
label appears, and then the target.  For example, in the sample menu
cross-reference below, the single colon separates the label from the
target.
</p>
<div class="example">
<pre class="example">* Foo Label: Foo Target.        More information about Foo.
</pre></div>

<p>Note the &lsquo;<samp>.</samp>&rsquo; which ends the name of the target.  The &lsquo;<samp>.</samp>&rsquo; is
not part of the target; it serves only to let Info know where the target
name ends.
</p>
<p>A shorthand way of specifying references allows two adjacent colons to
stand for a target name which is the same as the label name:
</p>
<div class="example">
<pre class="example">* Foo Commands::                Commands pertaining to Foo.
</pre></div>

<p>In the above example, the name of the target is the same as the name of
the label, in this case <code>Foo Commands</code>.
</p>
<p>You will normally see two types of cross-reference while viewing nodes:
<em>menu</em> references, and <em>note</em> references.  Menu references
appear within a node&rsquo;s menu; they begin with a &lsquo;<samp>*</samp>&rsquo; at the beginning
of a line, and continue with a label, a target, and a comment which
describes what the contents of the node pointed to contains.
</p>
<p>Note references appear within the body of the node text; they begin with
<code>*Note</code>, and continue with a label and a target.
</p>
<p>Like &lsquo;<samp>Next</samp>&rsquo;, &lsquo;<samp>Prev</samp>&rsquo;, and &lsquo;<samp>Up</samp>&rsquo; pointers, cross-references
can point to any valid node.  They are used to refer you to a place
where more detailed information can be found on a particular subject.
Here is a cross-reference which points to a node within the Texinfo
documentation:  See <a href="../texinfo/xref.html#xref">Writing an Xref</a> in <cite>the Texinfo
Manual</cite>, for more information on creating your own texinfo cross
references.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Selecting-Xrefs.html" accesskey="n" rel="next">Selecting Xrefs</a>, Up: <a href="Xref-Commands.html" accesskey="u" rel="up">Xref Commands</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>