JezK
Edit File: The-Top-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>The Top Node (GNU Texinfo 6.8)</title> <meta name="description" content="The Top Node (GNU Texinfo 6.8)"> <meta name="keywords" content="The Top 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="Writing-a-Texinfo-File.html" rel="up" title="Writing a Texinfo File"> <link href="The-Body-of-the-Document.html" rel="next" title="The Body of the Document"> <link href="Contents.html" rel="prev" title="Contents"> <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="The-Top-Node"> <div class="header"> <p> Next: <a href="The-Body-of-the-Document.html" accesskey="n" rel="next">The Body of the Document</a>, Previous: <a href="Contents.html" accesskey="p" rel="prev">Generating a Table of Contents</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</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-_0060Top_0027-Node-and-Master-Menu"></span><h3 class="section">2.9 The ‘Top’ Node and Master Menu</h3> <span id="index-Top-node"></span> <span id="index-Node_002c-_0060Top_0027"></span> <span id="Top-Node-Example"></span> <p>The ‘Top’ node is the node in which a reader enters an Info manual. As such, it should contain a very brief description of the manual (including the version number). The contents of the ‘Top’ node do not appear in printed output. </p> <span id="index-top"></span> <p>It is conventional to write a <code>@top</code> sectioning command line containing the title of the document immediately after the <code>@node Top</code> line (see <a href="_0040top-Command.html">The <code>@top</code> Sectioning Command</a>). This command helps <code>makeinfo</code> determine the relationships between nodes. </p> <p>We repeat the short description from the beginning of the ‘<samp>@copying</samp>’ text, but there’s no need to repeat the copyright information, so we don’t use ‘<samp>@insertcopying</samp>’ here. </p> <p>The ‘Top’ node contains a top-level <em>menu</em> listing the chapters, and possibly a <em>detailed menu</em> listing all the nodes in the entire document. </p> <span id="index-Top-node-example"></span> <div class="example"> <pre class="example">@node Top @top Short Sample This is a short sample Texinfo file. </pre><pre class="example">@menu * First Chapter:: The first chapter is the only chapter in this sample. * Index:: Complete index. @end menu </pre></div> <ul class="section-toc"> <li><a href="Master-Menu-Parts.html" accesskey="1">Parts of a Master Menu</a></li> </ul> </div> </body> </html>