JezK
Edit File: Master-Menu-Parts.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>Master Menu Parts (GNU Texinfo 6.8)</title> <meta name="description" content="Master Menu Parts (GNU Texinfo 6.8)"> <meta name="keywords" content="Master Menu Parts (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="The-Top-Node.html" rel="up" title="The Top Node"> <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="Master-Menu-Parts"> <div class="header"> <p> Up: <a href="The-Top-Node.html" accesskey="u" rel="up">The ‘Top’ Node and Master Menu</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="Parts-of-a-Master-Menu"></span><h4 class="subsection">2.9.1 Parts of a Master Menu</h4> <span id="index-Master-menu"></span> <span id="index-Menu_002c-master"></span> <span id="index-Parts-of-a-master-menu"></span> <p>A <em>master menu</em> is the main menu. It is customary to include a detailed menu listing all the nodes in the document in this menu. Like any other menu, a master menu is enclosed in <code>@menu</code> and <code>@end menu</code> and does not appear in the printed output. </p> <p>The master menu contains entries for the major nodes in the Texinfo file: the nodes for the chapters, chapter-like sections, and the appendices, followed by nodes for the indices. </p> <span id="index-detailmenu"></span> <span id="index-Detailed-menu"></span> <p>You may choose to follow these entries with a <em>defailed menu</em>. This lists other, lower-level nodes, often ordered by chapter. These items may be a convenience for an inquirer who can go directly to a particular node when searching for specific information, rather than going through an intermediate menu. If you use a detailed menu in your master menu, mark it with the <code>@detailmenu … @end detailmenu</code> environment, or <code>makeinfo</code> will get confused. </p> <p>Each section in the menu can be introduced by a descriptive line. So long as the line does not begin with an asterisk, it will not be treated as a menu entry. (See <a href="Writing-a-Menu.html">Writing a Menu</a>, for more information.) </p> <p>For example, the master menu for this manual looks like the following (but has many more entries): </p> <div class="example"> <pre class="example">@menu * Copying Conditions:: Your rights. * Overview:: Texinfo in brief. … </pre><pre class="example">* Command and Variable Index:: * General Index:: </pre><pre class="example"> </pre><pre class="example">@detailmenu --- The Detailed Node Listing --- Overview of Texinfo * Reporting Bugs:: … … </pre><pre class="example"> </pre><pre class="example">Beginning a Texinfo File * Sample Beginning:: … … @end detailmenu @end menu </pre></div> </div> <hr> <div class="header"> <p> Up: <a href="The-Top-Node.html">The ‘Top’ Node and Master Menu</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>