JezK
Edit File: _0040top-Command.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 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". --> <title>@top Command (GNU Texinfo 6.8)</title> <meta name="description" content="@top Command (GNU Texinfo 6.8)"> <meta name="keywords" content="@top Command (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <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="Texinfo-Document-Structure.html" rel="next" title="Texinfo Document Structure"> <link href="First-Node.html" rel="prev" title="First Node"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="g_t_0040top-Command"> <div class="header"> <p> Next: <a href="Texinfo-Document-Structure.html" accesskey="n" rel="next">Texinfo Document Structure</a>, Previous: <a href="First-Node.html" accesskey="p" rel="prev">The First Node</a>, Up: <a href="Nodes.html" accesskey="u" rel="up">Nodes</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="The-_0040top-Sectioning-Command"></span><h3 class="section">3.5 The <code>@top</code> Sectioning Command</h3> <span id="top-command"></span><span id="makeinfo-top"></span><span id="makeinfo-top-command"></span><span id="index-top-1"></span> <p>The <code>@top</code> command is a special sectioning command that you should only use after a ‘<samp>@node Top</samp>’ line at the beginning of a Texinfo file. The <code>@top</code> command tells the <code>makeinfo</code> formatter which node is to be used as the root of the node tree. </p> <p>It produces the same sort of output as <code>@unnumbered</code> (see <a href="_0040unnumbered-_0040appendix.html"><code>@unnumbered</code>, <code>@appendix</code>: Chapters with Other Labeling</a>). </p> <p><code>@top</code> is ignored when raising or lowering sections. That is, it is never lowered and nothing can be raised to it (see <a href="Raise_002flower-sections.html">Raise/lower Sections: <code>@raisesections</code> and <code>@lowersections</code></a>). </p> <p>It used to be conventionial to wrap the ‘<samp>Top</samp>’ node in an <code>@ifnottex</code> conditional so that it would not appear in TeX output (see <a href="Conditionals.html">Conditionally Visible Text</a>). Thus, a Top node often looked like this: </p> <div class="example"> <pre class="example">@ifnottex @node Top @top <var>your-manual-title</var> <var>very-high-level-summary</var> @end ifnottex </pre></div> <p>This is no longer necessary, as the ‘<samp>Top</samp>’ node is now never output for TeX output. </p> </div> </body> </html>