/usr/share/doc/texinfo/html/Menu-Location.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 Location</title>

<meta name="description" content="GNU Texinfo 5.2: Menu Location">
<meta name="keywords" content="GNU Texinfo 5.2: Menu Location">
<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="Writing-a-Menu.html#Writing-a-Menu" rel="next" title="Writing a Menu">
<link href="Menus.html#Menus" rel="previous" title="Menus">
<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-Location"></a>
<div class="header">
<p>
Next: <a href="Writing-a-Menu.html#Writing-a-Menu" accesskey="n" rel="next">Writing a Menu</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="Menu-Location-1"></a>
<h3 class="section">7.1 Menu Location</h3>
<a name="index-Menu-location"></a>
<a name="index-Location-of-menus"></a>

<p>There may be at most one menu in a node.  A menu is conventionally
located at the end of a node, without any regular text or additional
commands between the <code>@end menu</code> and the beginning of the next
node.
</p>
<a name="index-Info-format_002c-and-menus"></a>
<p>This convention is useful, since a reader who uses the menu could
easily miss any such text.  Also, any such post-menu text will be
considered part of the menu in Info output (which has no marker for
the end of a menu).  Thus, a line beginning with &lsquo;<samp>* </samp>&rsquo; will likely
be incorrectly handled.
</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"><tt>makeinfo</tt> 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>
<p>Years ago, we recommended using an &lsquo;<samp>@heading</samp>&rsquo; command within an
<code>@ifinfo</code> conditional instead of the normal sectioning commands
after a very short node with a menu.  This had the advantage of making
the printed output look better, because there was no very short text
between two headings on the page.  But it does not work with
<code>makeinfo</code>&rsquo;s implicit pointer creation, and it also makes the
XML output incorrect, since it does not reflect the true document
structure.  So, we no longer recommend this.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Writing-a-Menu.html#Writing-a-Menu" accesskey="n" rel="next">Writing a Menu</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>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Menu-Location.html
