/usr/share/doc/texinfo/html/Node-Menu-Illustration.html is in texinfo-doc-nonfree 5.2.0-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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | <!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: Node Menu Illustration</title>
<meta name="description" content="GNU Texinfo 5.2: Node Menu Illustration">
<meta name="keywords" content="GNU Texinfo 5.2: Node Menu Illustration">
<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="Nodes.html#Nodes" rel="up" title="Nodes">
<link href="Menus.html#Menus" rel="next" title="Menus">
<link href="_0040anchor.html#g_t_0040anchor" rel="previous" title="@anchor">
<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="Node-Menu-Illustration"></a>
<div class="header">
<p>
Previous: <a href="_0040anchor.html#g_t_0040anchor" accesskey="p" rel="previous"><tt>@anchor</tt></a>, Up: <a href="Nodes.html#Nodes" accesskey="u" rel="up">Nodes</a> [<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="Node-and-Menu-Illustration"></a>
<h3 class="section">6.4 Node and Menu Illustration</h3>
<p>Here is a copy of the diagram shown earlier that illustrates a Texinfo
file with three chapters, each of which contains two sections.
</p>
<p>The “root” is at the top of the diagram and the “leaves” are at
the bottom. This is how such a diagram is drawn conventionally; it
illustrates an upside-down tree. For this reason, the root node is
called the ‘Top’ node, and ‘Up’ node pointers carry you closer to the
root.
</p>
<div class="example">
<pre class="example"> Top
|
-------------------------------------
| | |
Chapter 1 Chapter 2 Chapter 3
| | |
-------- -------- --------
| | | | | |
Section Section Section Section Section Section
1.1 1.2 2.1 2.2 3.1 3.2
</pre></div>
<p>Using explicit pointers (not recommended, but for shown for purposes
of the example), the fully-written command to start Chapter 2
would be this:
</p>
<div class="example">
<pre class="example">@node Chapter 2, Chapter 3, Chapter 1, Top
@comment node-name, next, previous, up
</pre></div>
<p>This <code>@node</code> line says that the name of this node is
“Chapter 2”, the name of the ‘Next’ node is “Chapter 3”, the
name of the ‘Previous’ node is “Chapter 1”, and the name of the
‘Up’ node is “Top”. You can (and should) omit writing out these
node names if your document is hierarchically organized
(see <a href="makeinfo-Pointer-Creation.html#makeinfo-Pointer-Creation"><tt>makeinfo</tt> Pointer Creation</a>), but the pointer
relationships still obtain.
</p>
<blockquote>
<p><b>Note:</b> ‘Next’ and ‘Previous’ refer to nodes at the <em>same hierarchical
level</em> in the manual, not necessarily to the next node within the
Texinfo file. In the Texinfo file, the subsequent node may be at a
lower level—a section-level node most often follows a chapter-level
node, for example. (The ‘Top’ node contains the exception to this
rule. Since the ‘Top’ node is the only node at that level, ‘Next’
refers to the first following node, which is almost always a chapter
or chapter-level node.)
</p></blockquote>
<p>To go to Sections 2.1 and 2.2 using Info, you need a menu inside
Chapter 2. (See <a href="Menus.html#Menus">Menus</a>.) You would write the menu just before the
beginning of Section 2.1, like this:
</p>
<div class="example">
<pre class="example"> @menu
* Sect. 2.1:: Description of this section.
* Sect. 2.2:: Description.
@end menu
</pre></div>
<p>Using explicit pointers, the node for Sect. 2.1 is written like this:
</p>
<div class="example">
<pre class="example">@node Sect. 2.1, Sect. 2.2, Chapter 2, Chapter 2
@comment node-name, next, previous, up
</pre></div>
<p>In Info format, the ‘Next’ and ‘Previous’ pointers of a node usually
lead to other nodes at the same level—from chapter to chapter or
from section to section (sometimes, as shown, the ‘Previous’ pointer
points up); an ‘Up’ pointer usually leads to a node at the level above
(closer to the ‘Top’ node); and a ‘Menu’ leads to nodes at a level
below (closer to ‘leaves’). (A cross reference can point to a node at
any level; see <a href="Cross-References.html#Cross-References">Cross References</a>.)
</p>
<p>Usually, an <code>@node</code> command and a chapter structuring command
are conventionally used together, in that order, often followed by
indexing commands. (As shown in the example above, you may follow the
<code>@node</code> line with a comment line, e.g., to show which pointer is
which if explicit pointers are used.) The Texinfo processors use this
construct to determine the relationships between nodes and sectioning
commands.
</p>
<p>Here is the beginning of the chapter in this manual called “Ending a
Texinfo File”. This shows an <code>@node</code> line followed by an
<code>@chapter</code> line, and then by indexing lines. The manual uses
implictly determined node pointers; therefore, nothing else is needed
on the <code>@node</code> line.
</p>
<div class="example">
<pre class="example">@node Ending a File
@chapter Ending a Texinfo File
@cindex Ending a Texinfo file
@cindex Texinfo file ending
@cindex File ending
</pre></div>
<p>An earlier version of the manual used explicit node pointers. Here is
the beginning of the same chapter for that case. This shows an
<code>@node</code> line followed by a comment line, an <code>@chapter</code>
line, and then by indexing lines.
</p>
<div class="example">
<pre class="example">@node Ending a File, Structuring, Beginning a File, Top
@comment node-name, next, previous, up
@chapter Ending a Texinfo File
@cindex Ending a Texinfo file
…
</pre></div>
<hr>
<div class="header">
<p>
Previous: <a href="_0040anchor.html#g_t_0040anchor" accesskey="p" rel="previous"><tt>@anchor</tt></a>, Up: <a href="Nodes.html#Nodes" accesskey="u" rel="up">Nodes</a> [<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>
|