Viewing File: /usr/share/doc/texinfo/html/Master-Menu-Parts.html

<!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 6.7, 23 September 2019),
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, 2014, 2015, 2016, 2017, 2018, 2019 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". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Master Menu Parts (GNU Texinfo 6.7)</title>

<meta name="description" content="Master Menu Parts (GNU Texinfo 6.7)">
<meta name="keywords" content="Master Menu Parts (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<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">
<link href="Global-Document-Commands.html" rel="next" title="Global Document Commands">
<link href="Top-Node-Example.html" rel="prev" title="Top Node Example">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Master-Menu-Parts"></span><div class="header">
<p>
Previous: <a href="Top-Node-Example.html" accesskey="p" rel="prev">Top Node Example</a>, Up: <a href="The-Top-Node.html" accesskey="u" rel="up">The Top Node</a> &nbsp; [<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">3.6.2 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.
</p>
<p>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>Generally, a master menu is divided into parts.
</p>
<ul>
<li> The first part contains the major nodes in the Texinfo file: the nodes
for the chapters, chapter-like sections, and the appendices.

</li><li> The second part contains nodes for the indices.

</li><li> <span id="index-detailmenu"></span>
<span id="index-Detailed-menu"></span>
The third and subsequent parts contain a listing of the other,
lower-level nodes, often ordered by chapter.  This way, rather than go
through an intermediary menu, an inquirer can go directly to a
particular node when searching for specific information.  These menu
items are not required; add them if you think they are a convenience.
If you do use them, put <code>@detailmenu</code> before the first one, and
<code>@end detailmenu</code> after the last; otherwise, <code>makeinfo</code>
will get confused.
</li></ul>

<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.
&hellip;
</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:: &hellip;
&hellip;
</pre><pre class="example">

</pre><pre class="example">Beginning a Texinfo File

* Sample Beginning:: &hellip;
&hellip;
@end detailmenu
@end menu
</pre></div>


<hr>
<div class="header">
<p>
Previous: <a href="Top-Node-Example.html" accesskey="p" rel="prev">Top Node Example</a>, Up: <a href="The-Top-Node.html" accesskey="u" rel="up">The Top Node</a> &nbsp; [<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>
Back to Directory File Manager