File indexing completed on 2024-11-24 04:34:43

0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
0002 <html>
0003 <!-- This document is an unofficial reference manual for LaTeX, a
0004 document preparation system, version of November 2018.
0005 
0006 This manual was originally translated from LATEX.HLP v1.0a in the
0007 VMS Help Library.  The pre-translation version was written by
0008 George D. Greenwade of Sam Houston State University.  The
0009 LaTeX 2.09 version was written by Stephen Gilmore.  The
0010 LaTeX2e version was adapted from this by Torsten Martinsen.  Karl
0011 Berry made further updates and additions, and gratefully acknowledges
0012 using Hypertext Help with LaTeX, by Sheldon Green, and
0013 LaTeX Command Summary (for LaTeX 2.09) by
0014 L. Botway and C. Biemesderfer (published by the TeX Users
0015 Group as TeXniques number 10), as reference material.  We also
0016 gratefully acknowledge additional material appearing in
0017 latex2e-reference by Martin Herbert Dietze.  (From these references no
0018 text was directly copied.)
0019 
0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013,
0021 2014, 2015, 2016, 2017, 2018 Karl Berry.
0022 
0023 Copyright 1988, 1994, 2007 Stephen Gilmore.
0024 
0025 Copyright 1994, 1995, 1996 Torsten Martinsen.
0026 
0027 Permission is granted to make and distribute verbatim copies of
0028 this manual provided the copyright notice and this permission notice
0029 are preserved on all copies.
0030 
0031 
0032 Permission is granted to copy and distribute modified versions of this
0033 manual under the conditions for verbatim copying, provided that the entire
0034 resulting derived work is distributed under the terms of a permission
0035 notice identical to this one.
0036 
0037 Permission is granted to copy and distribute translations of this manual
0038 into another language, under the above conditions for modified versions. -->
0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
0040 <head>
0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
0042 <title>\addtocontents (LaTeX2e unofficial reference manual (November 2018))</title>
0043 
0044 <meta name="description" content="\addtocontents (LaTeX2e unofficial reference manual (November 2018))">
0045 <meta name="keywords" content="\addtocontents (LaTeX2e unofficial reference manual (November 2018))">
0046 <meta name="resource-type" content="document">
0047 <meta name="distribution" content="global">
0048 <meta name="Generator" content="makeinfo">
0049 <link href="index.html#Top" rel="start" title="Top">
0050 <link href="IndexDocument.html#Index" rel="index" title="Index">
0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
0052 <link href="Table-of-contents-etc_002e.html#Table-of-contents-etc_002e" rel="up" title="Table of contents etc.">
0053 <link href="_005cnofiles.html#g_t_005cnofiles" rel="next" title="\nofiles">
0054 <link href="_005caddcontentsline.html#g_t_005caddcontentsline" rel="prev" title="\addcontentsline">
0055 <style type="text/css">
0056 <!--
0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $
0058    Minor css for latexrefman. Public domain.
0059    Originally written by Jim Hefferon and Karl Berry, 2018. */
0060 
0061 /* So you can style for yourself */
0062 @import url("/css/latexreflocal.css");
0063 
0064 
0065 
0066 a.summary-letter {text-decoration: none}
0067 blockquote.indentedblock {margin-right: 0em}
0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
0069 blockquote.smallquotation {font-size: smaller}
0070 div.display {margin-left: 3.2em}
0071 div.example {margin-left: 3.2em}
0072 div.lisp {margin-left: 3.2em}
0073 div.smalldisplay {margin-left: 3.2em}
0074 div.smallexample {margin-left: 3.2em}
0075 div.smalllisp {margin-left: 3.2em}
0076 kbd {font-style: oblique}
0077 pre.display {font-family: inherit}
0078 pre.format {font-family: inherit}
0079 pre.menu-comment {font-family: serif}
0080 pre.menu-preformatted {font-family: serif}
0081 pre.smalldisplay {font-family: inherit; font-size: smaller}
0082 pre.smallexample {font-size: smaller}
0083 pre.smallformat {font-family: inherit; font-size: smaller}
0084 pre.smalllisp {font-size: smaller}
0085 span.nolinebreak {white-space: nowrap}
0086 span.roman {font-family: initial; font-weight: normal}
0087 span.sansserif {font-family: sans-serif; font-weight: normal}
0088 ul.no-bullet {list-style: none}
0089 BODY {
0090   margin-top: 1em;
0091   margin-left: 1em; /* auto results in two-digit <ol> lost off left */
0092   margin-right: 1em;
0093   margin-bottom: 1em;
0094   /* the idea is to use the whole window, unless it is ridiculously
0095      wide, probably with too-small fonts, too.  */
0096   max-width: 64em;
0097 }
0098 
0099 /* Because we want @math{... @code ...} to be upright, not slanted,
0100    and Texinfo won't fix it. */
0101 code {font-style:normal; font-family:monospace; }
0102 
0103 /* We put a link to our own home page at the bottom. */
0104 div.referenceinfo {font-size:small;}
0105 
0106 -->
0107 </style>
0108 
0109 
0110 </head>
0111 
0112 <body lang="en">
0113 <a name="g_t_005caddtocontents"></a>
0114 <div class="header">
0115 <p>
0116 Next: <a href="_005cnofiles.html#g_t_005cnofiles" accesskey="n" rel="next">\nofiles</a>, Previous: <a href="_005caddcontentsline.html#g_t_005caddcontentsline" accesskey="p" rel="prev">\addcontentsline</a>, Up: <a href="Table-of-contents-etc_002e.html#Table-of-contents-etc_002e" accesskey="u" rel="up">Table of contents etc.</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p>
0117 </div>
0118 <hr>
0119 <a name="g_t_005caddtocontents-1"></a>
0120 <h4 class="subsection">25.1.2 <code>\addtocontents</code></h4>
0121 
0122 <a name="index-_005caddtocontents_007bext_007d_007btext_007d"></a>
0123 
0124 <p>Synopsis:
0125 </p>
0126 <div class="example">
0127 <pre class="example">\addtocontents{<var>ext</var>}{<var>text</var>}
0128 </pre></div>
0129 
0130 <p>Add <var>text</var>, which may be text or formatting commands, directly to
0131 the auxiliary file with extension <var>ext</var>.  This is most commonly used
0132 for the table of contents so that is the discussion here, but this also
0133 applies to the list of figures and list of tables.
0134 </p>
0135 <p>This will put some vertical space in the table of contents after the
0136 &lsquo;<samp>Contents</samp>&rsquo; header.
0137 </p>
0138 <div class="example">
0139 <pre class="example">\tableofcontents\newpage
0140 \addtocontents{toc}{\protect\vspace*{3ex}}
0141 </pre></div>
0142 
0143 <p>The <code>\addtocontents</code> command has two arguments.  Both are
0144 required.
0145 </p>
0146 <dl compact="compact">
0147 <dt><var>ext</var></dt>
0148 <dd><p>Typically one of: <samp>toc</samp> for the table of contents, <samp>lof</samp> for
0149 the list of figures, or <samp>lot</samp> for the list of tables.  The
0150 extension of the file holding the information.
0151 </p>
0152 </dd>
0153 <dt><var>text</var></dt>
0154 <dd><p>The text, and possibly commands, to be written.
0155 </p></dd>
0156 </dl>
0157 
0158 <p>The sectioning commands such as <code>\chapter</code> use the
0159 <code>\addcontentsline</code> command to store information.  This command
0160 creates lines in the <samp>.toc</samp> auxiliary file containing the
0161 <code>\contentsline</code> command (see <a href="_005caddcontentsline.html#g_t_005caddcontentsline">\addcontentsline</a>).  In contrast,
0162 the command <code>\addtocontents</code> puts material directly in that file.
0163 </p>
0164 <p>The <code>\addtocontents</code> command has an interaction with
0165 <code>\include</code> (see <a href="_005cinclude-_0026-_005cincludeonly.html#g_t_005cinclude-_0026-_005cincludeonly">\include &amp; \includeonly</a>). If you use them at
0166 the same level, as with
0167 <code>\addtocontents{...}{...}\include{...}</code> then lines in the
0168 table of contents can come out in the wrong order.  The solution is to
0169 move <code>\addtocontents</code> into the file being included.
0170 </p>
0171 
0172 
0173 
0174 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div>
0175 </body>
0176 </html>