JezK
Edit File: First-Node.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>First Node (GNU Texinfo 6.8)</title> <meta name="description" content="First Node (GNU Texinfo 6.8)"> <meta name="keywords" content="First Node (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="Nodes.html" rel="up" title="Nodes"> <link href="_0040top-Command.html" rel="next" title="@top Command"> <link href="Node-Line-Requirements.html" rel="prev" title="Node Line Requirements"> <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="section" id="First-Node"> <div class="header"> <p> Next: <a href="_0040top-Command.html" accesskey="n" rel="next">The <code>@top</code> Sectioning Command</a>, Previous: <a href="Node-Line-Requirements.html" accesskey="p" rel="prev"><code>@node</code> Line Requirements</a>, Up: <a href="Nodes.html" 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" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="The-First-Node"></span><h3 class="section">3.4 The First Node</h3> <span id="index-Top-node-is-first"></span> <span id="index-First-node"></span> <p>The first node of a Texinfo file is the <em>Top</em> node, except in an included file (see <a href="Include-Files.html">Include Files</a>). The Top node should contain a short summary and a master menu. See <a href="The-Top-Node.html">The ‘Top’ Node and Master Menu</a> for more information on the Top node contents and examples. Straight text before the Top node outside of any node should be avoided. </p> <p>Here is a description of the node pointers to be used in the Top node: </p> <ul> <li> <span id="index-Up-node-of-Top-node"></span> <span id="index-_0028dir_0029-as-Up-node-of-Top-node"></span> The Top node (which must be named ‘<samp>top</samp>’ or ‘<samp>Top</samp>’) should have as its ‘Up’ node the name of a node in another file, where there is a menu that leads to this file. Specify the file name in parentheses. <p>Usually, all Info files are available through a single virtual Info tree, constructed from multiple directories. In this case, use ‘<samp>(dir)</samp>’ as the parent of the Top node; this specifies the top-level node in the <samp>dir</samp> file, which contains the main menu for the Info system as a whole. (Each directory with Info files is intended to contain a file named <samp>dir</samp>.) </p> <p>That’s fine for Info, but for HTML output, one might well want the Up link from the Top node to go to some specific place. For example, for GNU the natural place would be <a href="http://www.gnu.org/manual/">http://www.gnu.org/manual/</a> (a web page collecting links to most GNU manuals), better specified as just <code>/manual/</code> if the manual will be installed on <code>www.gnu.org</code>. This can be specified with the <code>TOP_NODE_UP_URL</code> customization variable (see <a href="HTML-Customization-Variables.html">HTML Customization Variables</a>), as in </p> <div class="example"> <pre class="example">$ <kbd>makeinfo --html -c TOP_NODE_UP_URL=/manual/</kbd> ... </pre></div> </li><li> <span id="index-Prev-node-of-Top-node"></span> The ‘Prev’ node of the Top node is usually either omitted or also set to <samp>(dir)</samp>. Either is fine. </li><li> <span id="index-Next-node-of-Top-node"></span> The ‘Next’ node of the Top node should be the first chapter in your document. </li></ul> <p>See <a href="Installing-an-Info-File.html">Installing an Info File</a>, for more information about installing an Info file in the <samp>info</samp> directory. </p> <p>It is usually best to leave the pointers off entirely and let the tools implicitly define them, with this simple result: </p> <div class="example"> <pre class="example">@node Top </pre></div> </div> <hr> <div class="header"> <p> Next: <a href="_0040top-Command.html">The <code>@top</code> Sectioning Command</a>, Previous: <a href="Node-Line-Requirements.html"><code>@node</code> Line Requirements</a>, Up: <a href="Nodes.html">Nodes</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>