Viewing File: /usr/share/doc/texinfo/html/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>Menu Parts (GNU Texinfo 6.7)</title>

<meta name="description" content="Menu Parts (GNU Texinfo 6.7)">
<meta name="keywords" content="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="Menus.html" rel="up" title="Menus">
<link href="Less-Cluttered-Menu-Entry.html" rel="next" title="Less Cluttered Menu Entry">
<link href="Menu-Location.html" rel="prev" title="Menu Location">
<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="Menu-Parts"></span><div class="header">
<p>
Next: <a href="Less-Cluttered-Menu-Entry.html" accesskey="n" rel="next">Less Cluttered Menu Entry</a>, Previous: <a href="Menu-Location.html" accesskey="p" rel="prev">Menu Location</a>, Up: <a href="Menus.html" accesskey="u" rel="up">Menus</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="The-Parts-of-a-Menu"></span><h4 class="subsection">4.9.4 The Parts of a Menu</h4>
<span id="index-Parts-of-a-menu"></span>
<span id="index-Menu-parts"></span>
<span id="index-_0040menu-parts"></span>

<p>A menu entry has three parts, only the second of which is required:
</p>
<ol>
<li> The menu entry name (optional).

</li><li> The name of the node (required).

</li><li> A description of the item (optional).
</li></ol>

<p>The template for a generic menu entry looks like this (but see the
next section for one more possibility):
</p>
<div class="example">
<pre class="example">* <var>menu-entry-name</var>: <var>node-name</var>.   <var>description</var>
</pre></div>

<p>Follow the menu entry name with a single colon, and follow the node
name with tab, comma, newline, or the two characters period and space
(&lsquo;<samp>. </samp>&rsquo;).
</p>
<p>The third part of a menu entry is a descriptive phrase or sentence.
Menu entry names and node names are often short; the description
explains to the reader what the node is about.  A useful description
complements the node name rather than repeats it.  The description,
which is optional, can spread over multiple lines; if it does, some
authors prefer to indent the second line while others prefer to align
it with the first (and all others).  It&rsquo;s up to you.  An empty line,
or the next menu entry, ends a description.
</p>
<p>Space characters in a menu are preserved as-is in the Info output; this
allows you to format the menu as you wish.  Unfortunately you must type
node names without any extra spaces or some versions of some Info
readers will not find the node (see <a href="Node-Line-Requirements.html">Node Line Requirements</a>).
</p>

<p><code>makeinfo</code> warns when the text of a menu item (and node names
and cross-references) contains a problematic construct that will
interfere with its parsing in Info.  If you don&rsquo;t want to see the
warnings, you can set the customization variable
<code>INFO_SPECIAL_CHARS_WARNING</code> to &lsquo;<samp>0</samp>&rsquo; (see <a href="Other-Customization-Variables.html">Other Customization Variables</a>).
</p>


<hr>
<div class="header">
<p>
Next: <a href="Less-Cluttered-Menu-Entry.html" accesskey="n" rel="next">Less Cluttered Menu Entry</a>, Previous: <a href="Menu-Location.html" accesskey="p" rel="prev">Menu Location</a>, Up: <a href="Menus.html" accesskey="u" rel="up">Menus</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