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

<meta name="description" content="makeinfo Pointer Creation (GNU Texinfo 6.7)">
<meta name="keywords" content="makeinfo Pointer Creation (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="Nodes.html" rel="up" title="Nodes">
<link href="Menus.html" rel="next" title="Menus">
<link href="Node-Menu-Illustration.html" rel="prev" title="Node Menu Illustration">
<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="makeinfo-Pointer-Creation"></span><div class="header">
<p>
Next: <a href="Menus.html" accesskey="n" rel="next">Menus</a>, Previous: <a href="Node-Menu-Illustration.html" accesskey="p" rel="prev">Node Menu Illustration</a>, Up: <a href="Nodes.html" accesskey="u" rel="up">Nodes</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="makeinfo-Pointer-Creation-1"></span><h3 class="section">4.8 <code>makeinfo</code> Pointer Creation</h3>

<span id="index-Creating-pointers-with-makeinfo"></span>
<span id="index-Pointer-creation-with-makeinfo"></span>
<span id="index-Automatic-pointer-creation-with-makeinfo"></span>
<span id="index-Implicit-pointer-creation-with-makeinfo"></span>

<p>The <code>makeinfo</code> program can automatically determine node pointers
for a hierarchically organized document.  This implicit node pointer
creation feature in <code>makeinfo</code> relieves you from the need to
update menus and pointers manually or with Texinfo mode commands.
(See <a href="Updating-Nodes-and-Menus.html">Updating Nodes and Menus</a>.)  We highly recommend taking
advantage of this.
</p>
<p>To do so, write your <code>@node</code> lines with just the name of the
node:
</p>
<div class="example">
<pre class="example">@node My Node
</pre></div>

<p>You do not need to write out the &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, and &lsquo;Up&rsquo;
pointers.
</p>
<p>Then, you must write a sectioning command, such as <code>@chapter</code>
or <code>@section</code>, on the line immediately following each truncated
<code>@node</code> line (except that comment lines may intervene).  This is
where it normally goes.
</p>
<p>Also, you must write the name of each node (except for the &lsquo;Top&rsquo; node)
in a menu that is one or more hierarchical levels above the node&rsquo;s
level.
</p>
<p>Finally, you must follow the &lsquo;Top&rsquo; <code>@node</code> line with a line
beginning with <code>@top</code> to mark the top-level node in the file.
See <a href="_0040top-Command.html"><code>@top</code> Command</a>.
</p>
<span id="index-Detail-menu"></span>
<span id="index-detailmenu-1"></span>
<p>If you use a detailed menu in your master menu (see <a href="Master-Menu-Parts.html">Master Menu Parts</a>), mark it with the <code>@detailmenu &hellip; @end
detailmenu</code> environment, or <code>makeinfo</code> will get confused,
typically about the last and/or first node in the document.
</p>
<p>In most cases, you will want to take advantage of this feature and not
redundantly specify node pointers that the programs can determine.
However, Texinfo documents are not required to be organized
hierarchically or in fact to contain sectioning commands at all (for
example, if you never intend the document to be printed), so node
pointers may still be specified explicitly, in full generality.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Menus.html" accesskey="n" rel="next">Menus</a>, Previous: <a href="Node-Menu-Illustration.html" accesskey="p" rel="prev">Node Menu Illustration</a>, Up: <a href="Nodes.html" accesskey="u" rel="up">Nodes</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>



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