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

<meta name="description" content="GNU Texinfo 5.2: Contents">
<meta name="keywords" content="GNU Texinfo 5.2: Contents">
<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="Beginning-a-File.html#Beginning-a-File" rel="up" title="Beginning a File">
<link href="The-Top-Node.html#The-Top-Node" rel="next" title="The Top Node">
<link href="Heading-Generation.html#Heading-Generation" rel="previous" title="Heading Generation">
<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="Contents"></a>
<div class="header">
<p>
Next: <a href="The-Top-Node.html#The-Top-Node" accesskey="n" rel="next">The Top Node</a>, Previous: <a href="Titlepage-_0026-Copyright-Page.html#Titlepage-_0026-Copyright-Page" accesskey="p" rel="previous">Titlepage &amp; Copyright Page</a>, Up: <a href="Beginning-a-File.html#Beginning-a-File" accesskey="u" rel="up">Beginning a File</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="Generating-a-Table-of-Contents"></a>
<h3 class="section">3.5 Generating a Table of Contents</h3>
<a name="index-Table-of-contents"></a>
<a name="index-Contents_002c-table-of"></a>
<a name="index-Short-table-of-contents"></a>
<a name="index-contents"></a>
<a name="index-summarycontents"></a>
<a name="index-shortcontents"></a>

<p>The <code>@chapter</code>, <code>@section</code>, and other structuring commands
(see <a href="Chapter-Structuring.html#Chapter-Structuring">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><code>@contents</code></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>@&hellip;heading</code> commands
do not appear in the table of contents (see <a href="Structuring-Command-Types.html#Structuring-Command-Types">Structuring Command Types</a>).
</p>
</dd>
<dt><code>@shortcontents</code></dt>
<dt><code>@summarycontents</code></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#g_t_0040titlepage"><tt>@titlepage</tt></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&rsquo;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>
<p>In the past, the contents commands were sometimes placed at the end of
the file, after any indices and just before the <code>@bye</code>, but we
no longer recommend this.
</p>
<a name="index-setcontentsaftertitlepage"></a>
<a name="index-setshortcontentsaftertitlepage"></a>
<a name="index-Contents_002c-after-title-page"></a>
<a name="index-Table-of-contents_002c-after-title-page"></a>
<p>However, since many existing Texinfo documents still do have the
<code>@contents</code> at the end of the manual, if you are a user printing
a manual, you may wish to force the contents to be printed after the
title page.  You can do this by specifying
<code>@setcontentsaftertitlepage</code> and/or
<code>@setshortcontentsaftertitlepage</code>.  The first prints only the
main contents after the <code>@end titlepage</code>; the second prints both
the short contents and the main contents.  In either case, any
subsequent <code>@contents</code> or <code>@shortcontents</code> is ignored.
</p>
<p>You need to include the <code>@set&hellip;contentsaftertitlepage</code>
commands early in the document (just after <code>@setfilename</code>, for
example).  We recommend using <code>texi2dvi</code> (see <a href="Format-with-texi2dvi.html#Format-with-texi2dvi">Format with <tt>texi2dvi</tt></a>) to specify this without altering the source file at
all.  For example:
</p>
<div class="example">
<pre class="example">texi2dvi --texinfo=@setcontentsaftertitlepage foo.texi
</pre></div>

<p>An alternative invocation, using <code>texi2any</code>:
</p>
<div class="example">
<pre class="example">texi2any --dvi --Xopt --texinfo=@setcontentsaftertitlepage foo.texi
</pre></div>



<hr>
<div class="header">
<p>
Next: <a href="The-Top-Node.html#The-Top-Node" accesskey="n" rel="next">The Top Node</a>, Previous: <a href="Titlepage-_0026-Copyright-Page.html#Titlepage-_0026-Copyright-Page" accesskey="p" rel="previous">Titlepage &amp; Copyright Page</a>, Up: <a href="Beginning-a-File.html#Beginning-a-File" accesskey="u" rel="up">Beginning a File</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 / Contents.html
