texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Writing-a-Menu.html

This file is indexed.

/usr/share/doc/texinfo/html/Writing-a-Menu.html is in texinfo-doc-nonfree 6.5.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!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.5, 25 August 2017),
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 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 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Writing a Menu (GNU Texinfo 6.5)</title>

<meta name="description" content="Writing a Menu (GNU Texinfo 6.5)">
<meta name="keywords" content="Writing a Menu (GNU Texinfo 6.5)">
<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="Menu-Example.html#Menu-Example" rel="next" title="Menu Example">
<link href="Menus.html#Menus" rel="prev" title="Menus">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
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.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">
<a name="Writing-a-Menu"></a>
<div class="header">
<p>
Next: <a href="Menu-Example.html#Menu-Example" accesskey="n" rel="next">Menu Example</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="Writing-a-Menu-1"></a>
<h4 class="subsection">4.9.1 Writing a Menu</h4>
<a name="index-Writing-a-menu"></a>
<a name="index-Menu-writing"></a>

<p>A menu consists of a <code>@menu</code> command on a line by itself,
followed by menu entry lines or menu comment lines, and then followed
by an <code>@end menu</code> command on a line by itself.
</p>
<p>A menu looks like this:
</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>

<a name="index-Spaces_002c-in-menus"></a>
<p>In a menu, every line that begins with an &lsquo;<samp>*&nbsp;</samp>&rsquo;<!-- /@w --> is a <em>menu
entry</em>.  (Note the space after the asterisk.)
</p>
<p>A line that does not start with an &lsquo;<samp>*&nbsp;</samp>&rsquo;<!-- /@w --> may also appear in a
menu.  Such a line is not a menu entry but rather a <em>menu comment</em>
line that appears in the Info file.  In the example above, the line
&lsquo;<samp>Larger Units of Text</samp>&rsquo; is such a menu comment line; the two lines
starting with &lsquo;<samp>*&nbsp;</samp>&rsquo;<!-- /@w --> are menu entries.
</p>
<a name="index-Hierarchical-documents_002c-and-menus"></a>
<p>Technically, menus can carry you to any node, regardless of the
structure of the document; even to nodes in a different Info file.
However, we do not recommend making use of this, because it is hard
for readers to follow.  Also, the <code>makeinfo</code> implicit pointer
creation feature (see <a href="makeinfo-Pointer-Creation.html#makeinfo-Pointer-Creation"><code>makeinfo</code> Pointer Creation</a>) and GNU
Emacs Texinfo mode updating commands work only to create menus of
subordinate nodes in a hierarchically structured document.  It is much
better to use cross-references to refer to arbitrary nodes.
</p>
<a name="index-Menus_002c-automatically-generating"></a>
<a name="index-validatemenus"></a>
<p><code>makeinfo</code> can automatically generate menus in nodes for Info 
and HTML output, based on the chapter structure of the document.  To 
specify that you want it to do this, place the line 
&lsquo;<samp>@validatemenus off</samp>&rsquo; near the beginning of the document.
</p>
<p>In Info, a user selects a node with the <kbd>m</kbd> (<code>Info-menu</code>)
command.  The menu entry name is what the user types after the <kbd>m</kbd>
command.
<a name="index-accesskey_002c-in-HTML-output-of-menus"></a>
In the HTML output from <code>makeinfo</code>, the <code>accesskey</code>
attribute is used with the values &lsquo;<samp>1</samp>&rsquo;&hellip;&lsquo;<samp>9</samp>&rsquo; for the
first nine entries.  This allows people using web browsers to follow
the first menu entries using (typically) <kbd>M-<var>digit</var></kbd>, e.g.,
<kbd>M-1</kbd> for the first entry.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Menu-Example.html#Menu-Example" accesskey="n" rel="next">Menu Example</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>



</body>
</html>

APT Browse - Built by Thomas Orozco.