/usr/share/doc/texinfo/html/Node-Line-Requirements.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 | <html lang="en">
<head>
<title>Node Line Requirements - 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="node.html#node" title="node">
<link rel="prev" href="Node-Line-Tips.html#Node-Line-Tips" title="Node Line Tips">
<link rel="next" href="First-Node.html#First-Node" title="First Node">
<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="Node-Line-Requirements"></a>
<p>
Next: <a rel="next" accesskey="n" href="First-Node.html#First-Node">First Node</a>,
Previous: <a rel="previous" accesskey="p" href="Node-Line-Tips.html#Node-Line-Tips">Node Line Tips</a>,
Up: <a rel="up" accesskey="u" href="node.html#node">node</a>
<hr>
</div>
<h4 class="subsection">6.3.4 <code>@node</code> Line Requirements</h4>
<p><a name="index-Node-line-requirements-307"></a><a name="index-Restrictions-on-node-names-308"></a>Here are several requirements for <code>@node</code> lines:
<a name="index-Unique-nodename-requirement-309"></a>
<a name="index-Node-name-must-be-unique-310"></a>
<ul><li>All the node names for a single Info file must be unique.
<p>Duplicates confuse the Info movement commands. This means, for
example, that if you end every chapter with a summary, you must name
each summary node differently. You cannot just call each one
“Summary”. You may, however, duplicate the titles of chapters, sections,
and the like. Thus you can end each chapter in a book with a section
called “Summary”, so long as the node names for those sections are all
different.
<li>A pointer name must be the name of a node.
<p>The node to which a pointer points may come before or after the
node containing the pointer.
<p><a name="index-g_t_0040_0040_002dcommands-in-nodename-311"></a><a name="index-Node-name_002c-should-not-contain-_0040_0040_002dcommands-312"></a><li>@-commands in node names are not allowed. This includes punctuation
characters that are escaped with a ‘<samp><span class="samp">@</span></samp>’, such as <code>@</code> and
<code>{</code>, and accent commands such as ‘<samp><span class="samp">@'</span></samp>’. (For a few cases
when this is useful, Texinfo has limited support for using
@-commands<!-- /@w --> in node names; see <a href="Pointer-Validation.html#Pointer-Validation">Pointer Validation</a>.) Perhaps
this limitation will be removed some day.
<li><a name="index-Colon-in-nodename-313"></a><a name="index-Comma-in-nodename-314"></a><a name="index-Parentheses-in-nodename-315"></a><a name="index-Period-in-nodename-316"></a><a name="index-Characters_002c-invalid-in-node-name-317"></a><a name="index-Invalid-characters-in-node-names-318"></a><a name="index-Node-names_002c-invalid-characters-in-319"></a>Unfortunately, you cannot use periods, commas, colons or parentheses
within a node name; these confuse the Texinfo processors. Perhaps
this limitation will be removed some day, too.
<p>For example, the following is a section title in this manual:
<pre class="smallexample"> @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}
</pre>
<p class="noindent">But the corresponding node name lacks the commas and the @'s:
<pre class="smallexample"> unnumberedsec appendixsec heading
</pre>
<p><a name="index-Case-in-node-name-320"></a><li>Case is significant in node names.
<p><a name="index-White-space-in-node-name-321"></a><a name="index-Spaces-in-node-name-322"></a>Spaces before and after names on the ‘<samp><span class="samp">@node</span></samp>’ line are ignored,
but spaces “inside” a name are significant. For example:
<pre class="example"> @node foo bar,
@node foo bar ,
@node foo bar ,
</pre>
<p class="noindent">all define the same node, ‘<samp><span class="samp">foo bar</span></samp>’. References to the
node should all use that name, without the leading or trailing spaces,
but with the internal spaces.
</ul>
</body></html>
|