JezK
Edit File: Contents.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>Contents (GNU Texinfo 6.8)</title> <meta name="description" content="Contents (GNU Texinfo 6.8)"> <meta name="keywords" content="Contents (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="Writing-a-Texinfo-File.html" rel="up" title="Writing a Texinfo File"> <link href="The-Top-Node.html" rel="next" title="The Top Node"> <link href="Titlepage-_0026-Copyright-Page.html" rel="prev" title="Titlepage & Copyright Page"> <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="Contents"> <div class="header"> <p> Next: <a href="The-Top-Node.html" accesskey="n" rel="next">The ‘Top’ Node and Master Menu</a>, Previous: <a href="Titlepage-_0026-Copyright-Page.html" accesskey="p" rel="prev">Title and Copyright Pages</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</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="Generating-a-Table-of-Contents"></span><h3 class="section">2.8 Generating a Table of Contents</h3> <span id="index-Table-of-contents"></span> <span id="index-Contents_002c-table-of"></span> <span id="index-Short-table-of-contents"></span> <span id="index-contents"></span> <span id="index-summarycontents"></span> <span id="index-shortcontents"></span> <p>The <code>@chapter</code>, <code>@section</code>, and other structuring commands (see <a href="Chapter-Structuring.html">Chapter Structuring</a>) supply the information to make up a table of contents, but they do not cause an actual table to appear in the manual. To do this, you must use the <code>@contents</code> and/or <code>@summarycontents</code> command(s). </p> <dl compact="compact"> <dt><span><code>@contents</code></span></dt> <dd><p>Generates a table of contents in a printed manual, including all chapters, sections, subsections, etc., as well as appendices and unnumbered chapters. Headings generated by <code>@majorheading</code>, <code>@chapheading</code>, and the other <code>@…heading</code> commands do not appear in the table of contents (see <a href="Structuring-Command-Types.html">Structuring Command Types</a>). </p> </dd> <dt><span><code>@shortcontents</code></span></dt> <dt><span><code>@summarycontents</code></span></dt> <dd><p>(<code>@summarycontents</code> is a synonym for <code>@shortcontents</code>.) </p> <p>Generates a short or summary table of contents that lists only the chapters, appendices, and unnumbered chapters. Sections, subsections and subsubsections are omitted. Only a long manual needs a short table of contents in addition to the full table of contents. </p></dd> </dl> <p>Both contents commands should be written on a line by themselves, and placed near the beginning of the file, after the <code>@end titlepage</code> (see <a href="_0040titlepage.html"><code>@titlepage</code></a>), before any sectioning command. The contents commands automatically generate a chapter-like heading at the top of the first table of contents page, so don’t include any sectioning command such as <code>@unnumbered</code> before them. </p> <p>Since an Info file uses menus instead of tables of contents, the Info formatting commands ignore the contents commands. But the contents are included in plain text output (generated by <code>makeinfo --plaintext</code>) and in other output formats, such as HTML. </p> <p>When <code>makeinfo</code> writes a short table of contents while producing HTML output, the links in the short table of contents point to corresponding entries in the full table of contents rather than the text of the document. The links in the full table of contents point to the main text of the document. </p> </div> <hr> <div class="header"> <p> Next: <a href="The-Top-Node.html">The ‘Top’ Node and Master Menu</a>, Previous: <a href="Titlepage-_0026-Copyright-Page.html">Title and Copyright Pages</a>, Up: <a href="Writing-a-Texinfo-File.html">Writing a Texinfo File</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>