blob: 7ce855db84242548692e3be15ffb4776ebda63ae [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://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.8dev, 23 February 2022),
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-2022 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>Menu Example (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Menu Example (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Menu Example (GNU Texinfo 6.8dev)">
<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="Menus.html" rel="up" title="Menus">
<link href="Menu-Location.html" rel="next" title="Menu Location">
<link href="Writing-a-Menu.html" rel="prev" title="Writing a Menu">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Menu-Example">
<div class="nav-panel">
<p>
Next: <a href="Menu-Location.html" accesskey="n" rel="next">Menu Location</a>, Previous: <a href="Writing-a-Menu.html" accesskey="p" rel="prev">Writing a Menu</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>
<h4 class="subsection" id="A-Menu-Example">3.8.2 A Menu Example</h4>
<a class="index-entry-id" id="index-Menu-example"></a>
<a class="index-entry-id" id="index-Example-menu"></a>
<p>A menu looks like this in Texinfo:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@menu
* menu entry name: Node name. A short description.
* Node name:: This form is preferred.
@end menu
</pre></div></div>
<p>This produces:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">* menu:
* menu entry name: Node name. A short description.
* Node name:: This form is preferred.
</pre></div></div>
<p>Here is an example as you might see it in a Texinfo file:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@menu
Larger Units of Text
* Files:: All about handling files.
* Multiples: Buffers. Multiple buffers; editing
several files at once.
@end menu
</pre></div></div>
<p>This produces:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">* menu:
Larger Units of Text
* Files:: All about handling files.
* Multiples: Buffers. Multiple buffers; editing
several files at once.
</pre></div></div>
<p>In this example, the menu has two entries. &lsquo;<samp class="samp">Files</samp>&rsquo; is both a menu
entry name and the name of the node referred to by that name.
&lsquo;<samp class="samp">Multiples</samp>&rsquo; is the menu entry name; it refers to the node named
&lsquo;<samp class="samp">Buffers</samp>&rsquo;. The line &lsquo;<samp class="samp">Larger Units of Text</samp>&rsquo; is a comment; it
appears in the menu, but is not an entry.
</p>
<p>Since no file name is specified with either &lsquo;<samp class="samp">Files</samp>&rsquo; or
&lsquo;<samp class="samp">Buffers</samp>&rsquo;, they must be the names of nodes in the same Info file
(see <a class="pxref" href="Other-Info-Files.html">Referring to Other Info Files</a>).
</p>
</div>
</body>
</html>