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>\addcontentsline (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="\addcontentsline (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="\addcontentsline (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="_005caddtocontents.html#g_t_005caddtocontents" rel="next" title="\addtocontents"> 0054 <link href="Table-of-contents-etc_002e.html#Table-of-contents-etc_002e" rel="prev" title="Table of contents etc."> 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_005caddcontentsline"></a> 0114 <div class="header"> 0115 <p> 0116 Next: <a href="_005caddtocontents.html#g_t_005caddtocontents" accesskey="n" rel="next">\addtocontents</a>, Up: <a href="Table-of-contents-etc_002e.html#Table-of-contents-etc_002e" accesskey="u" rel="up">Table of contents etc.</a> [<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_005caddcontentsline-1"></a> 0120 <h4 class="subsection">25.1.1 <code>\addcontentsline</code></h4> 0121 0122 <a name="index-_005caddcontentsline"></a> 0123 <a name="index-table-of-contents-entry_002c-manually-adding"></a> 0124 0125 <p>Synopsis: 0126 </p> 0127 <div class="example"> 0128 <pre class="example">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>} 0129 </pre></div> 0130 0131 <a name="index-_005ccontentsline"></a> 0132 <p>Add an entry to the file specified by <var>ext</var>. Usually <var>ext</var> is 0133 one of <code>toc</code> for the table of contents, <code>lof</code> for the list of 0134 figures, or <code>lot</code> for the list of tables. 0135 </p> 0136 <p>The following will result in an ‘<samp>Appendices</samp>’ line in the table of 0137 contents. 0138 </p> 0139 <div class="example"> 0140 <pre class="example">\addcontentsline{toc}{section}{\protect\textbf{Appendices}} 0141 </pre></div> 0142 0143 <p>It will appear at the same indentation level as the sections, will be in 0144 boldface, and will be assigned the page number associated with the point 0145 where it appears in the input file. 0146 </p> 0147 <p>The <code>\addcontentsline</code> command writes information to the file 0148 <samp><var>root-name</var>.<var>ext</var></samp>. It writes that information as the 0149 text of the command 0150 <code>\contentsline{<var>unit</var>}{<var>text</var>}{<var>num</var>}</code>, where 0151 <code><var>num</var></code> is the current value of counter <code><var>unit</var></code>. The 0152 most common case is the table of contents and there <var>num</var> is the 0153 page number of the first page of <var>unit</var>. 0154 </p> 0155 <p>This command is invoked by the sectioning commands <code>\chapter</code>, 0156 etc., and also by <code>\caption</code> inside a float environment. But it is 0157 also used by authors. For example, in a book to have the preface 0158 unnumbered, you may use the starred <code>\chapter*</code>. But that does not 0159 put in table of contents information, so you can enter it manually, as 0160 here. 0161 </p> 0162 <div class="example"> 0163 <pre class="example">\chapter*{Preface} 0164 \addcontentsline{toc}{chapter}{\protect\numberline{}Preface} 0165 </pre></div> 0166 0167 <p>In the <samp>.toc</samp> file LaTeX will put the line <code>\contentsline 0168 {chapter}{\numberline {}Preface}{3}</code>; note the page number 0169 ‘<samp>3</samp>’. 0170 </p> 0171 0172 <p>All of the arguments for <code>\addcontentsline</code> are required. 0173 </p> 0174 <dl compact="compact"> 0175 <dt><var>ext</var></dt> 0176 <dd><p>Typically one of the strings <code>toc</code> for the table of contents, 0177 <code>lof</code> for the list of figures, or <code>lot</code> for the list of 0178 tables. The filename extension of the information file. 0179 </p> 0180 </dd> 0181 <dt><var>unit</var></dt> 0182 <dd><p>A string that depends on the value of the <var>ext</var> argument: 0183 </p> 0184 <dl compact="compact"> 0185 <dt><code>toc</code></dt> 0186 <dd><p>For the table of contents, this is the name of a sectional unit: 0187 <code>part</code>, <code>chapter</code>, <code>section</code>, <code>subsection</code>, etc. 0188 </p> 0189 </dd> 0190 <dt><code>lof</code></dt> 0191 <dd><p>For the list of figures: <code>figure</code>. 0192 </p> 0193 </dd> 0194 <dt><code>lot</code></dt> 0195 <dd><p>For the list of tables: <code>table</code>. 0196 </p></dd> 0197 </dl> 0198 0199 </dd> 0200 <dt><var>text</var></dt> 0201 <dd><p>The text of the entry. You must <code>\protect</code> any commands that are 0202 fragile (see <a href="_005cprotect.html#g_t_005cprotect">\protect</a>). 0203 </p></dd> 0204 </dl> 0205 0206 <p>The <code>\addcontentsline</code> command has an interaction with 0207 <code>\include</code> (see <a href="_005cinclude-_0026-_005cincludeonly.html#g_t_005cinclude-_0026-_005cincludeonly">\include & \includeonly</a>). If you use them at 0208 the same level, as with 0209 <code>\addcontentsline{...}{...}{...}\include{...}</code> then lines 0210 in the table of contents can come out in the wrong order. The solution 0211 is to move <code>\addcontentsline</code> into the file being included. 0212 </p> 0213 <p>If you use a <var>unit</var> that LaTeX does not recognize, as here 0214 </p> 0215 <div class="example"> 0216 <pre class="example">\addcontentsline{toc}{setcion}{\protect\textbf{Appendices}} 0217 </pre></div> 0218 0219 <p>then you don’t get an error but the formatting in the table of contents 0220 will not make sense. 0221 </p> 0222 0223 0224 0225 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0226 </body> 0227 </html>