/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 5.2, 26 September 2013),
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 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 the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Menu Example</title>

<meta name="description" content="GNU Texinfo 5.2: Menu Example">
<meta name="keywords" content="GNU Texinfo 5.2: Menu Example">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Menus.html#Menus" rel="up" title="Menus">
<link href="Other-Info-Files.html#Other-Info-Files" rel="next" title="Other Info Files">
<link href="Less-Cluttered-Menu-Entry.html#Less-Cluttered-Menu-Entry" rel="previous" title="Less Cluttered Menu Entry">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Menu-Example"></a>
<div class="header">
<p>
Next: <a href="Other-Info-Files.html#Other-Info-Files" accesskey="n" rel="next">Other Info Files</a>, Previous: <a href="Less-Cluttered-Menu-Entry.html#Less-Cluttered-Menu-Entry" accesskey="p" rel="previous">Less Cluttered Menu Entry</a>, Up: <a href="Menus.html#Menus" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="A-Menu-Example"></a>
<h3 class="section">7.5 A Menu Example</h3>
<a name="index-Menu-example"></a>
<a name="index-Example-menu"></a>

<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#Other-Info-Files">Referring to Other Info Files</a>).
</p>



</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Menu-Example.html
