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

<meta name="description" content="Menu Example (GNU Texinfo 6.7)">
<meta name="keywords" content="Menu Example (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="Menu-Location.html" rel="next" title="Menu Location">
<link href="Writing-a-Menu.html" rel="prev" title="Writing a Menu">
<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-Example"></span><div class="header">
<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>
<span id="A-Menu-Example"></span><h4 class="subsection">4.9.2 A Menu Example</h4>
<span id="index-Menu-example"></span>
<span id="index-Example-menu"></span>


<p>A menu looks like this in Texinfo:
</p>
<div class="example">
<pre class="example">@menu
* menu entry name: Node name.   A short description.
* Node name::                   This form is preferred.
@end menu
</pre></div>

<p>This produces:
</p>
<div class="example">
<pre class="example">* menu:

* menu entry name: Node name.   A short description.
* Node name::                   This form is preferred.
</pre></div>

<p>Here is an example as you might see it in a Texinfo file:
</p>
<div class="example">
<pre class="example">@menu
Larger Units of Text

* Files::                       All about handling files.
* Multiples: Buffers.           Multiple buffers; editing
                                 several files at once.
@end menu
</pre></div>

<p>This produces:
</p>
<div class="example">
<pre class="example">* menu:
Larger Units of Text

* Files::                       All about handling files.
* Multiples: Buffers.           Multiple buffers; editing
                                 several files at once.
</pre></div>

<p>In this example, the menu has two entries.  &lsquo;<samp>Files</samp>&rsquo; is both a menu
entry name and the name of the node referred to by that name.
&lsquo;<samp>Multiples</samp>&rsquo; is the menu entry name; it refers to the node named
&lsquo;<samp>Buffers</samp>&rsquo;. The line &lsquo;<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>Files</samp>&rsquo; or
&lsquo;<samp>Buffers</samp>&rsquo;, they must be the names of nodes in the same Info file
(see <a href="Other-Info-Files.html">Referring to Other Info Files</a>).
</p>




</body>
</html>
Back to Directory File Manager