JezK
Edit File: Info-Format-Cross-Reference.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 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". --> <title>Info Format Cross Reference (GNU Texinfo 6.8)</title> <meta name="description" content="Info Format Cross Reference (GNU Texinfo 6.8)"> <meta name="keywords" content="Info Format Cross Reference (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Info-Format-Text-Constructs.html" rel="up" title="Info Format Text Constructs"> <link href="Info-Format-Printindex.html" rel="prev" title="Info Format Printindex"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="Info-Format-Cross-Reference"> <div class="header"> <p> Previous: <a href="Info-Format-Printindex.html" accesskey="p" rel="prev">Info Format: Printindex</a>, Up: <a href="Info-Format-Text-Constructs.html" accesskey="u" rel="up">Info Format Text Constructs</a> [<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="Info-Format_003a-Cross_002dreference"></span><h4 class="subsection">F.2.4 Info Format: Cross-reference</h4> <span id="index-Cross_002dreferences_002c-in-Info-format"></span> <p>A general cross-reference in Info format has one of the following two forms: </p> <div class="example"> <pre class="example"> <cross-reference> = * (N|n)ote <id>:: | * (N|n)ote <label>:<id>(.|,) <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)? | <id> = (<lparen><infofile><rparen>)?(<nodename>)? <label> = <del>?<label text><del>? </pre></div> <p>No space should occur between the ‘<samp>*</samp>’ character and the following ‘<samp>N</samp>’ or ‘<samp>n</samp>’. ‘<samp>*Note</samp>’ should be used at the start of a sentence, otherwise ‘<samp>*note</samp>’ should be used. (Some Info readers, such as the one in Emacs, can display ‘<samp>*Note</samp>’ and ‘<samp>*note</samp>’ as ‘<samp>See</samp>’ and ‘<samp>see</samp>’ respectively.) In both cases, <tt><label text></tt> is descriptive text. </p> <p>In both forms the <tt><id></tt> refers to a node or anchor, in the same way as a reference in the node information line does (see <a href="Info-Format-Regular-Nodes.html">Info Format: Regular Nodes</a>). The optional parenthesized ‘<samp><infofile></samp>’ is the name of the manual being referenced, and the <tt><nodename></tt> is the node or anchor within that manual, </p> <p>The second form has a descriptive label. A cross-reference in this form should usually be terminated with a comma or period, to make it feasible to find the end of the <tt><id></tt>. </p> <p>If <tt><label></tt> contains a colon character (<tt>:</tt>), it should be surrounded with a pair of <tt><del></tt> characters. Likewise, if <tt><nodename></tt> contains problematic characters (such as commas or periods), it should be surrounded by a pair of <tt><del></tt> characters; then a terminating comma or period is not needed. </p> <p>As with node names, this quoting mechanism has as of the time of writing limited support in Info-reading programs; hence we do not recommend using it until this changes. </p> <p>The format does not prescribe how to find other manuals to resolve such references. </p> <p>Here are some examples: </p> <div class="example"> <pre class="example">*note GNU Free Documentation License:: *note Tag table: Info Format Tag Table, for details. *Note Overview: (make)Top. *Note ^?:^?: (bash)Bourne Shell Builtins. *Note alloca.h: (gnulib)^?alloca.h^?. </pre></div> <p>The first shows a reference to a node in the current manual using the short form. </p> <p>The second also refers to a node in the current manual, namely ‘Info Format Tag Table’; the ‘Tag table’ before the ‘<samp>:</samp>’ is only a label on this particular reference, and the ‘<samp>for details.</samp>’ is text belonging to the sentence, not part of the reference. </p> <p>The third example refers to the node ‘Top’ in another manual, namely ‘<samp>make</samp>’, with ‘Overview’ being the label for this cross-reference. </p> <p>The fourth example shows a colon character being quoted in a label, and the fifth example shows a period being quoted in a node name. </p> <p>See <a href="Cross-References.html">Cross-references</a>. </p> </div> <hr> <div class="header"> <p> Previous: <a href="Info-Format-Printindex.html">Info Format: Printindex</a>, Up: <a href="Info-Format-Text-Constructs.html">Info Format Text Constructs</a> [<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> </body> </html>