<!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>Updating Requirements (GNU Texinfo 6.7)</title>
<meta name="description" content="Updating Requirements (GNU Texinfo 6.7)">
<meta name="keywords" content="Updating Requirements (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="Updating-Nodes-and-Menus.html" rel="up" title="Updating Nodes and Menus">
<link href="Other-Updating-Commands.html" rel="next" title="Other Updating Commands">
<link href="Updating-Commands.html" rel="prev" title="Updating Commands">
<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="Updating-Requirements"></span><div class="header">
<p>
Next: <a href="Other-Updating-Commands.html" accesskey="n" rel="next">Other Updating Commands</a>, Previous: <a href="Updating-Commands.html" accesskey="p" rel="prev">Updating Commands</a>, Up: <a href="Updating-Nodes-and-Menus.html" accesskey="u" rel="up">Updating Nodes and Menus</a> [<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="Updating-Requirements-1"></span><h4 class="subsection">D.5.2 Updating Requirements</h4>
<span id="index-Updating-requirements"></span>
<span id="index-Requirements-for-updating-commands"></span>
<p>To use the updating commands, you must organize the Texinfo file
hierarchically with chapters, sections, subsections, and the like.
When you construct the hierarchy of the manual, do not ‘jump down’
more than one level at a time: you can follow the ‘Top’ node with a
chapter, but not with a section; you can follow a chapter with a
section, but not with a subsection. However, you may ‘jump up’ any
number of levels at one time—for example, from a subsection to a
chapter.
</p>
<p>Each <code>@node</code> line, with the exception of the line for the ‘Top’
node, must be followed by a line with a structuring command such as
<code>@chapter</code>, <code>@section</code>, or
<code>@unnumberedsubsec</code>.
</p>
<p>Each <code>@node</code> line/structuring-command line combination
must look either like this:
</p>
<div class="example">
<pre class="example">@node Comments, Minimum, Conventions, Overview
@comment node-name, next, previous, up
@section Comments
</pre></div>
<p>or like this (without the <code>@comment</code> line):
</p>
<div class="example">
<pre class="example">@node Comments, Minimum, Conventions, Overview
@section Comments
</pre></div>
<p>or like this (without the explicit node pointers):
</p>
<div class="example">
<pre class="example">@node Comments
@section Comments
</pre></div>
<p>In this example, ‘Comments’ is the name of both the node and the
section. The next node is called ‘Minimum’ and the previous node is
called ‘Conventions’. The ‘Comments’ section is within the ‘Overview’
node, which is specified by the ‘Up’ pointer. (Instead of an
<code>@comment</code> line, you may also write an <code>@ifinfo</code> line.)
</p>
<p>If a file has a ‘Top’ node, it must be called ‘<samp>top</samp>’ or ‘<samp>Top</samp>’
and be the first node in the file.
</p>
<p>The menu updating commands create a menu of sections within a chapter,
a menu of subsections within a section, and so on. This means that
you must have a ‘Top’ node if you want a menu of chapters.
</p>
<p>Incidentally, the <code>makeinfo</code> command will create an Info file for a
hierarchically organized Texinfo file that lacks ‘Next’, ‘Previous’ and
‘Up’ pointers. Thus, if you can be sure that your Texinfo file will be
formatted with <code>makeinfo</code>, you have no need for the update node
commands. (See <a href="Creating-an-Info-File.html">Creating an Info File</a>, for more information about
<code>makeinfo</code>.)
</p>
<hr>
<div class="header">
<p>
Next: <a href="Other-Updating-Commands.html" accesskey="n" rel="next">Other Updating Commands</a>, Previous: <a href="Updating-Commands.html" accesskey="p" rel="prev">Updating Commands</a>, Up: <a href="Updating-Nodes-and-Menus.html" accesskey="u" rel="up">Updating Nodes and Menus</a> [<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>
</body>
</html>