| blob | b267daaf8b2e25686a3103666bf8dfed1b26c4e9 |
1 % \iffalse meta-comment
2 %
3 % Copyright 1993-2015
4 % The LaTeX3 Project and any individual authors listed elsewhere
5 % in this file.
6 %
7 % This file is part of the LaTeX base system.
8 % -------------------------------------------
9 %
10 % It may be distributed and/or modified under the
11 % conditions of the LaTeX Project Public License, either version 1.3c
12 % of this license or (at your option) any later version.
13 % The latest version of this license is in
14 % http://www.latex-project.org/lppl.txt
15 % and version 1.3c or later is part of all distributions of LaTeX
16 % version 2005/12/01 or later.
17 %
18 % This file has the LPPL maintenance status "maintained".
19 %
20 % The list of all files belonging to the LaTeX base distribution is
21 % given in the file `manifest.txt'. See also `legal.txt' for additional
22 % information.
23 %
24 % The list of derived (unpacked) files belonging to the distribution
25 % and covered by LPPL is defined by the unpacking scripts (with
26 % extension .ins) which are part of the distribution.
27 %
28 % \fi
29 %
30 % \iffalse
31 %%% From File: ltsect.dtx
32 %<*driver>
33 % \fi
34 \ProvidesFile{ltsect.dtx}[2014/09/29 v1.0z LaTeX Kernel (Sectioning)]
35 % \iffalse
36 \documentclass{ltxdoc}
37 \GetFileInfo{ltsect.dtx}
38 \title{\filename}
39 \date{\filedate}
40 \author{%
41 Johannes Braams\and
42 David Carlisle\and
43 Alan Jeffrey\and
44 Leslie Lamport\and
45 Frank Mittelbach\and
46 Chris Rowley\and
47 Tobias Oetiker\thanks{Tobi updated
48 the comments to `doc' conventions}\and
49 Rainer Sch\"opf}
51 \begin{document}
52 \MaintainedByLaTeXTeam{latex}
53 \maketitle
54 \DocInput{\filename}
55 \end{document}
56 %</driver>
57 % \fi
58 %
59 % \CheckSum{363}
60 %
61 % \changes{v1.0o}{1995/05/07}{Use \cs{hb@xt@}}
62 % \changes{v1.0y}{1996/10/31}{Corrected and tidied documentation;
63 % removed long lines}
64 %
65 %
66 % \section{Sectioning Commands}
67 %
68 % This file defines the declarations such as |\author| which are used
69 % by |\maketitle|. |\maketitle| itself is defined by each class, not
70 % in the \LaTeX{} kernel.
71 %
72 % The second part of the file defines the generic commands used for
73 % defining sectioning commands such as |\chapter|. Again the actual
74 % document level commands are defined in the class files, in terms of
75 % these commands.
76 %
77 % \StopEventually{}
78 %
79 %
80 % \changes{v1.0a}{1994/03/04}{Initial version, split from latex.dtx}
81 % \changes{v1.0b}{1994/03/28}{Split further from ltherest.dtx}
82 % \changes{v1.0d}{1994/05/21}{Use new error commands}
83 % \changes{v1.0f}{1994/10/12}{Doc. typos}
84 % \changes{v1.0g}{1994/10/18}{Added \cs{normalcolor}}
85 % \changes{v1.0i}{1994/11/17}
86 % {\cs{@tempa} to \cs{reserved@a}}
87 % \changes{v1.0m}{1995/05/03}{TO: Promoted documentation to doc.sty
88 % standard}
89 %
90 % \begin{macrocode}
91 %<*2ekernel>
92 \message{title,}
93 % \end{macrocode}
94 %
95 % \subsection{The Title}
96 %
97 % \DescribeMacro{\title}
98 % The user defines the title and author by the declarations
99 % |\title|\marg{name},
100 % \DescribeMacro{\author}
101 % |\author|\marg{name}
102 %
103 % \DescribeMacro{\date}
104 % Similarly the date is declared with
105 % |\date|\marg{date}.
106 %
107 % \DescribeMacro{\thanks}
108 % Inside these, the |\thanks|\marg{footnote text} command may be used
109 % to make acknowledgements, notice of address, etc.\ in a footnote.
110 % \DescribeMacro{\and}
111 % If there are multiple authors, they have to be separated with the
112 % |\and| command.
113 %
114 % \DescribeMacro{\maketitle}
115 % And finally, the |\maketitle| command produces the actual title,
116 % using the information previously saved with the other commands.
117 %
118 % \begin{macro}{\title}
119 % \begin{macro}{\@title}
120 % \changes{LaTeX2e}{1993/12/11}{Added default}
121 % |\title| for use in |\maketitle|. If not given |\maketitle| will
122 % produce an error message.
123 % \begin{macrocode}
124 \def\title#1{\gdef\@title{#1}}
125 \def\@title{\@latex@error{No \noexpand\title given}\@ehc}
126 % \end{macrocode}
127 % \end{macro}
128 % \end{macro}
129 %
130 % \begin{macro}{\author}
131 % \begin{macro}{\@author}
132 % \changes{LaTeX2e}{1993/12/11}{Added default}
133 %
134 % |\author| for use in |\maketitle|. If not given |\maketitle| will
135 % produce a warning message.
136 %
137 % \begin{macrocode}
138 \def\author#1{\gdef\@author{#1}}
139 \def\@author{\@latex@warning@no@line{No \noexpand\author given}}
140 % \end{macrocode}
141 % \end{macro}
142 % \end{macro}
143 %
144 % \begin{macro}{\date}
145 % \begin{macro}{\@date}
146 % |\date| for use in |\maketitle|. If not given |\maketitle| will
147 % produce |\today| as the default.
148 % \begin{macrocode}
149 \def\date#1{\gdef\@date{#1}}
150 \gdef\@date{\today}
151 % \end{macrocode}
152 % \end{macro}
153 % \end{macro}
154 %
155 % \changes{1.0h}{1994/11/04}{(ASAJ) Added \cs{protected@xdef} to
156 % \cs{thanks}.}
157 % \begin{macro}{\thanks}
158 % \begin{macrocode}
159 \def\thanks#1{\footnotemark
160 \protected@xdef\@thanks{\@thanks
161 \protect\footnotetext[\the\c@footnote]{#1}}%
162 }
163 % \end{macrocode}
164 % \end{macro}
165 %
166 % \begin{macro}{\@thanks}
167 % \begin{macrocode}
168 \let\@thanks\@empty
169 % \end{macrocode}
170 % \end{macro}
171 % \begin{macro}{\and}
172 % \begin{macrocode}
173 \def\and{% % \begin{tabular}
174 \end{tabular}%
175 \hskip 1em \@plus.17fil%
176 \begin{tabular}[t]{c}}% % \end{tabular}
177 % \end{macrocode}
178 % \end{macro}
179 %
180 % \begin{macrocode}
181 \message{sectioning,}
182 % \end{macrocode}
183 % \subsection{Sectioning}
184 %
185 %
186 % \begin{macro}{\@secpenalty}
187 % \begin{macrocode}
188 \newcount\@secpenalty
189 \@secpenalty = -300
190 % \end{macrocode}
191 % \end{macro}
192 %
193 % \begin{macro}{\if@noskipsec}
194 % \begin{macro}{\@noskipsectrue}
195 % \changes{1.0w}{1996/09/29}{Added documentation}
196 % Way back in 1991 (08/26) FMi \& RmS set the |\@noskipsec| switch
197 % to true for the preamble and to false in |\document|.
198 % This was done to trap lists and related text in the preamble but it
199 % does not catch everything.
200 % \begin{macrocode}
201 \newif\if@noskipsec \@noskipsectrue
202 % \end{macrocode}
203 % \end{macro}
204 % \end{macro}
205 %
206 % \begin{macro}{\@startsection}
207 %
208 % The |\@startsection{|\meta{name}|}{|\meta{level}|}{|%
209 % \meta{indent}|}{|\meta{beforeskip}|}|\\
210 % |{|\meta{afterskip}|}{|\meta{style}|}*[|\meta{altheading}%
211 % |]{|\meta{heading}|}|
212 % command is the mother of all the user level sectioning commands.
213 % The part after the |*|, including the |*| is optional.
214 %
215 % \begin{description}
216 % \item[name:] e.g., 'subsection'
217 % \item[level:] a number, denoting depth of section -- e.g., chapter=1,
218 % section = 2, etc.
219 % \item[indent:] Indentation of heading from left margin
220 % \item[beforeskip:] Absolute value = skip to leave above the heading.
221 % If negative, then paragraph indent of text following
222 % heading is suppressed.
223 % \item[afterskip:] if positive, then skip to leave below heading, else
224 % negative of skip to leave to right of run-in heading.
225 % \item[style:] Commands to set style. Since June 1996 release the
226 % \emph{last} command in this argument may be a command
227 % such as |\MakeUppercase| or |\fbox| that takes an
228 % argument. The section heading will be supplied as the
229 % argument to this command. So setting |#6| to, say,
230 % |\bfseries\MakeUppercase| would produce bold,
231 % uppercase headings.
232 % \end{description}
233 %
234 % If `|*|' is missing, then increment the counter. If it is
235 % present, then there should be no |[|\meta{altheading}|]| argument.
236 % The command uses the counter 'secnumdepth'. It contains a pointer
237 % to the highest section level that is to be numbered.
238 %
239 % \textbf{Warning:}
240 % The |\@startsection| command should be at the same or higher
241 % grouping level as the text that follows it. For example, you should
242 % \emph{not} do something like
243 % \begin{verbatim}
244 % \def\foo{ \begingroup ...
245 % \paragraph{...}
246 % \endgroup}
247 % \end{verbatim}
248 %
249 % Pseudocode for the |\@startsection| command
250 % \begin{oldcomments}
251 % \@startsection {NAME}{LEVEL}{INDENT}{BEFORESKIP}{AFTERSKIP}{STYLE} ==
252 % BEGIN
253 % IF @noskipsec = T THEN \leavevmode FI
254 % % true if previous section had no body.
255 %
256 % \par
257 % \@tempskipa := BEFORESKIP
258 % @afterindent := T
259 % IF \@tempskipa < 0 THEN \@tempskipa := -\@tempskipa
260 % @afterindent := F
261 % FI
262 % IF @nobreak = true
263 % THEN \everypar == null
264 % ELSE \addpenalty{\@secpenalty}
265 % \addvspace{\@tempskipa}
266 % FI
267 % IF * next
268 % THEN \@ssect{INDENT}{BEFORESKIP}{AFTERSKIP}{STYLE}
269 % ELSE \@dblarg{\@sect
270 % {NAME}{LEVEL}{INDENT}
271 % {BEFORESKIP}{AFTERSKIP}{STYLE}}
272 % FI
273 % END
274 % \end{oldcomments}
275 %
276 % \begin{macrocode}
277 \def\@startsection#1#2#3#4#5#6{%
278 \if@noskipsec \leavevmode \fi
279 \par
280 \@tempskipa #4\relax
281 \@afterindenttrue
282 \ifdim \@tempskipa <\z@
283 \@tempskipa -\@tempskipa \@afterindentfalse
284 \fi
285 \if@nobreak
286 \everypar{}%
287 \else
288 \addpenalty\@secpenalty\addvspace\@tempskipa
289 \fi
290 \@ifstar
291 {\@ssect{#3}{#4}{#5}{#6}}%
292 {\@dblarg{\@sect{#1}{#2}{#3}{#4}{#5}{#6}}}}
293 % \end{macrocode}
294 % \end{macro}
295 %
296 % \begin{macro}{\@sect}
297 % Pseudocode for the |\@sect| command
298 % \begin{oldcomments}
299 % \@sect{NAME}{LEVEL}{INDENT}{BEFORESKIP}{AFTERSKIP}{STYLE}[ARG1]{ARG2}
300 % ==
301 % BEGIN
302 % IF LEVEL > \c@secnumdepth
303 % THEN \@svsec :=L null
304 % ELSE \refstepcounter{NAME}
305 % \@svsec :=L BEGIN \@seccntformat{#1}\relax END
306 % FI
307 % IF AFTERSKIP > 0
308 % THEN \begingroup
309 % STYLE
310 % \@hangfrom{\hskip INDENT\@svsec}
311 % {\interlinepenalty 10000 ARG2\par}
312 % \endgroup
313 % \NAMEmark{ARG1}
314 % \addcontentsline{toc}{NAME}
315 % { IF LEVEL > \c@secnumdepth
316 % ELSE \protect\numberline{\theNAME} FI
317 % ARG1 }
318 % ELSE \@svsechd == BEGIN STYLE
319 % \hskip INDENT\@svsec
320 % ARG2
321 % \NAMEmark{ARG1}
322 % \addcontentsline{toc}{NAME}
323 % { IF LEVEL > \c@secnumdepth
324 % ELSE
325 % \protect\numberline{\theNAME}
326 % FI
327 % ARG1 }
328 % END
329 % FI
330 % \@xsect{AFTERSKIP}
331 % END
332 % \end{oldcomments}
333 %
334 % \changes{LaTeX2.09}{1992/08/25}
335 % {(FMi) replaced explicit setting of \cs{@svsec}
336 % by call to \cs{@seccntformat}}
337 % \changes{LaTeX2.09}{1993/08/05}
338 % {(RmS) Made sure that \cs{protect} works correctly in
339 % expansion of \cs{the} counter}
340 % \changes{1.0h}{1994/11/04}
341 % {(ASAJ) Added \cs{protected@edef}.}
342 % \begin{macrocode}
343 \def\@sect#1#2#3#4#5#6[#7]#8{%
344 \ifnum #2>\c@secnumdepth
345 \let\@svsec\@empty
346 \else
347 \refstepcounter{#1}%
348 % \end{macrocode}
349 % Since |\@seccntformat| might end with an improper |\hskip| which
350 % is scanning forward for |plus| or |minus| we end the definition
351 % of |\@svsec| with |\relax| as a precaution.
352 % \changes{1.0n}{1995/05/06}{Added \cs{relax} after
353 % \cs{@seccntformat} just in case}
354 % \begin{macrocode}
355 \protected@edef\@svsec{\@seccntformat{#1}\relax}%
356 \fi
357 \@tempskipa #5\relax
358 \ifdim \@tempskipa>\z@
359 \begingroup
360 % \end{macrocode}
361 % \changes{v1.0s}{1996/05/21}
362 % {(DPC) Moved brace to allow commands like
363 % \cs{MakeUppercase} in 6th argument.
364 % Changed \cs{par} to \cs{endgraf} to allow non-long
365 % commands. internal/2148}
366 % \changes{v1.0t}{1996/06/10}
367 % {(DPC) Changed \cs{endgraf} to \cs{@@par}}
368 % This |{| used to be after the argument to |\@hangfrom| but was moved
369 % here to allow commands such as |\MakeUppercase| to be used at the end
370 % of |#6|.
371 % \begin{macrocode}
372 #6{%
373 \@hangfrom{\hskip #3\relax\@svsec}%
374 \interlinepenalty \@M #8\@@par}%
375 \endgroup
376 \csname #1mark\endcsname{#7}%
377 \addcontentsline{toc}{#1}{%
378 \ifnum #2>\c@secnumdepth \else
379 \protect\numberline{\csname the#1\endcsname}%
380 \fi
381 #7}%
382 \else
383 % \end{macrocode}
384 % |\relax| added 2 May 90
385 % \changes{v1.0s}{1996/05/21}
386 % {(DPC) Added extra braces for internal/2148}
387 % \begin{macrocode}
388 \def\@svsechd{%
389 #6{\hskip #3\relax
390 \@svsec #8}%
391 \csname #1mark\endcsname{#7}%
392 \addcontentsline{toc}{#1}{%
393 \ifnum #2>\c@secnumdepth \else
394 \protect\numberline{\csname the#1\endcsname}%
395 \fi
396 #7}}%
397 \fi
398 \@xsect{#5}}
399 % \end{macrocode}
400 % \end{macro}
401 %
402 % \begin{macro}{\@xsect}%
403 % Pseudocode for the |\@xsect| command
404 % \begin{oldcomments}
405 % \@xsect{AFTERSKIP} ==
406 % BEGIN
407 % IF AFTERSKIP > 0
408 % THEN \par \nobreak
409 % \vskip AFTERSKIP
410 % \@afterheading
411 % ELSE @nobreak :=G F
412 % @noskipsec :=G T
413 % \everypar{ IF @noskipsec = T
414 % THEN @noskipsec :=G F
415 % \clubpenalty :=G 10000
416 % \hskip -\parindent
417 % \begingroup
418 % \@svsechd
419 % \endgroup
420 % \unskip
421 % \hskip -AFTERSKIP \relax
422 % %% relax added 14 Jan 91
423 % ELSE \clubpenalty :=G \@clubpenalty
424 % \everypar := NULL
425 % FI
426 % }
427 % FI
428 %
429 % END
430 % \end{oldcomments}
431 %
432 % \changes{0.0}{1992/08/19}
433 % {(RmS) corrected bug: stretch and shrink in argument to
434 % \cs{hskip} previously not negated}
435 % \begin{macrocode}
436 \def\@xsect#1{%
437 \@tempskipa #1\relax
438 \ifdim \@tempskipa>\z@
439 % \end{macrocode}
440 % Why not combine |\@sect| and |\@xsect| and save doing the
441 % same test twice? It is not possible to change this now as these
442 % have become hooks!
443 %
444 % This |\par| seems unnecessary.
445 % \begin{macrocode}
446 \par \nobreak
447 \vskip \@tempskipa
448 \@afterheading
449 \else
450 % \end{macrocode}
451 % \changes{v1.0u}{1996/07/26}{Removed \cs{global} before
452 % \cs{@nobreak...}}
453 % \changes{v1.0x}{1996/10/23}{Replaced \cs{hskip...} with \cs{setbox...}
454 % as used in \cs{@afterheading}}
455 % \begin{macrocode}
456 \@nobreakfalse
457 \global\@noskipsectrue
458 \everypar{%
459 \if@noskipsec
460 \global\@noskipsecfalse
461 {\setbox\z@\lastbox}%
462 \clubpenalty\@M
463 \begingroup \@svsechd \endgroup
464 \unskip
465 \@tempskipa #1\relax
466 \hskip -\@tempskipa
467 \else
468 \clubpenalty \@clubpenalty
469 \everypar{}%
470 \fi}%
471 \fi
472 \ignorespaces}
473 % \end{macrocode}
474 % \end{macro}
475 %
476 % \begin{macro}{\@seccntformat}
477 % This command formats the section number including the space
478 % following it.
479 % \changes{1.0n}{1995/05/06}{Use \cs{quad} instead of \cs{hskip}}
480 % \begin{macrocode}
481 \def\@seccntformat#1{\csname the#1\endcsname\quad}
482 % \end{macrocode}
483 % \end{macro}
484 %
485 % Pseudocode for the |\@ssect| command
486 % \begin{oldcomments}
487 % \@ssect{INDENT}{BEFORESKIP}{AFTERSKIP}{STYLE}{ARG} ==
488 % BEGIN
489 % IF AFTERSKIP > 0
490 % THEN \begingroup
491 % STYLE
492 % \@hangfrom{\hskip INDENT}{\interlinepenalty 10000 ARG\par}
493 % \endgroup
494 % ELSE \@svsechd == BEGIN STYLE
495 % \hskip INDENT
496 % ARG
497 % END
498 % FI
499 % \@xsect{AFTERSKIP}
500 % END
501 % \end{oldcomments}
502 %
503 % Pseudocode for the |\@afterheading| command
504 % \begin{oldcomments}
505 % \@afterheading ==
506 % BEGIN
507 % @nobreak :=G true
508 % \everypar := BEGIN IF @nobreak = T
509 % THEN @nobreak :=G false
510 % \clubpenalty :=G 10000
511 % IF @afterindent = F
512 % THEN remove \lastbox
513 % FI
514 % ELSE \clubpenalty :=G \@clubpenalty
515 % \everypar := NULL
516 % FI
517 % END
518 % END
519 % \end{oldcomments}
520 %
521 %
522 % \begin{macro}{\@ssect}
523 % \begin{macrocode}
524 \def\@ssect#1#2#3#4#5{%
525 \@tempskipa #3\relax
526 \ifdim \@tempskipa>\z@
527 \begingroup
528 % \end{macrocode}
529 % \changes{v1.0s}{1996/05/21}
530 % {(DPC) Moved brace to allow commands like
531 % \cs{MakeUppercase} in 4th argument.
532 % Changed \cs{par} to \cs{endgraf} to allow non-long
533 % commands. internal/2148}
534 % \changes{v1.0t}{1996/06/10}
535 % {(DPC) Changed \cs{endgraf} to \cs{@@par}}
536 % This |{| used to be after the argument to |\@hangfrom| but was moved
537 % here to allow commands such as |\MakeUppercase| to be used at the end
538 % of |#4|.
539 % \begin{macrocode}
540 #4{%
541 \@hangfrom{\hskip #1}%
542 \interlinepenalty \@M #5\@@par}%
543 \endgroup
544 \else
545 % \end{macrocode}
546 % \changes{v1.0s}{1996/05/21}
547 % {(DPC) Added extra braces for internal/2148}
548 % \begin{macrocode}
549 \def\@svsechd{#4{\hskip #1\relax #5}}%
550 \fi
551 \@xsect{#3}}
552 % \end{macrocode}
553 % \end{macro}
554 %
555 % \begin{macro}{\if@afterindent}
556 % \begin{macro}{\@afterindenttrue}
557 % \begin{macrocode}
558 \newif\if@afterindent \@afterindenttrue
559 % \end{macrocode}
560 % \end{macro}\end{macro}
561 %
562 % \begin{macro}{\@afterheading}
563 % \changes{v1.0v}{1996/08/02}{Removed \cs{global}
564 % before \cs{@nobreak...}}
565 %
566 % This hook is used in setting up custom-built headings in classes.dtx.
567 %
568 % \begin{macrocode}
569 \def\@afterheading{%
570 \@nobreaktrue
571 \everypar{%
572 \if@nobreak
573 \@nobreakfalse
574 \clubpenalty \@M
575 \if@afterindent \else
576 {\setbox\z@\lastbox}%
577 \fi
578 \else
579 \clubpenalty \@clubpenalty
580 \everypar{}%
581 \fi}}
582 % \end{macrocode}
583 % \end{macro}
584 %
585 %
586 % \begin{macro}{\@hangfrom}
587 %
588 % |\@hangfrom{|\meta{text}|}| : Puts \meta{text} in a box, and makes a
589 % hanging indentation of the following material up to the first
590 % |\par|. Should be used in vertical mode.
591 %
592 % \changes{v1.0a}{1994/03/07}{(DPC)Extra groups for colour}
593 % \begin{macrocode}
594 \def\@hangfrom#1{\setbox\@tempboxa\hbox{{#1}}%
595 \hangindent \wd\@tempboxa\noindent\box\@tempboxa}
596 % \end{macrocode}
597 % \end{macro}
598 %
599 % \begin{macro}{\c@secnumdepth}
600 % \begin{macro}{\c@tocdepth}
601 % \begin{macrocode}
602 \newcount\c@secnumdepth
603 \newcount\c@tocdepth
604 % \end{macrocode}
605 % \end{macro}\end{macro}
606 %
607 % \begin{macro}{\secdef}
608 %
609 % |\secdef{|\meta{unstarcmds}|}{|\meta{unstarcmds}|}{|%
610 % \meta{starcmds}|}|\\
611 % When defining a |\chapter| or |\section| command without using
612 % |\@startsection|, you can use |\secdef| as follows:
613 % \begin{enumerate}
614 % \item |\def\chapter{| \ldots |\secdef|
615 % |\|\meta{starcmd} |\|\meta{unstarcmd} |}|
616 % \item |\def\|\meta{starcmd}|[#1]#2{| \ldots |}|
617 % |%| Command to define |\chapter[|\ldots|]{|\ldots|}|
618 % \item |\def\|\meta{unstarcmd}|#1{| \ldots |}|
619 % |%| Command to define |\chapter*{|\ldots|}|
620 % \end{enumerate}
621 %
622 % \begin{macrocode}
623 \def\secdef#1#2{\@ifstar{#2}{\@dblarg{#1}}}
624 % \end{macrocode}
625 % \end{macro}
626 %
627 % \subsubsection{Initializations}
628 % \begin{macro}{\sectionmark}
629 % \begin{macro}{\subsectionmark}
630 % \begin{macro}{\subsubsectionmark}
631 % \begin{macro}{\paragraphmark}
632 % \begin{macro}{\subparagraphmark}
633 % \changes{v1.0q}{1995/10/25}{Use \cs{let} not \cs{def} to save space.}
634 % \begin{macrocode}
635 \let\sectionmark\@gobble
636 \let\subsectionmark\@gobble
637 \let\subsubsectionmark\@gobble
638 \let\paragraphmark\@gobble
639 \let\subparagraphmark\@gobble
640 % \end{macrocode}
641 % \end{macro}
642 % \end{macro}
643 % \end{macro}
644 % \end{macro}
645 % \end{macro}
646 %
647 % \begin{macrocode}
648 \message{contents,}
649 % \end{macrocode}
650 %
651 % \subsection{Table of Contents etc.}
652 %
653 % \subsubsection{Convention}
654 % |\tf@|\meta{foo} = file number for output for table foo.
655 % The file is opened only if |@filesw| = |true|.
656 %
657 % \subsubsection{Commands}
658 %
659 %
660 % A |\l@|\meta{type}|{|\meta{entry}|}{|\meta{page}|}| Macro needs to
661 % defined by document style for making an entry of type \meta{type}
662 % in a table of contents, etc. E.g., the document style
663 % should define |\l@chapter|, |\l@section|, etc.
664 %
665 % \textbf{Note:} When the |\protect| command is
666 % used in the \meta{entry} or \meta{text} of one of the commands
667 % below, it causes the following control sequence to be written on
668 % the file without being expanded. The sequence will be expanded
669 % when the table of contents entry is processed.
670 %
671 % \textbf{Surprise:} Inside an |\addcontentsline| or |\addtocontents|
672 % command argument, the commands: |\index|, |\glossary|, and |\label|
673 % are no-ops . This could cause a problem if the user puts an
674 % |\index| or |\label| into one of the commands he writes, or into the
675 % optional `short version' argument of a |\section| or |\caption|
676 % command.
677 %
678 % \begin{macro}{\@starttoc}
679 % The |\@starttoc|\marg{ext} command is used to define the commands:\\
680 % |\tableofcontents|, |\listoffigures|, etc.
681 %
682 % For example:
683 % |\@starttoc{lof}| is used in |\listoffigures|. This command
684 % reads the |.|\meta{ext} file and sets up to write the new
685 % |.|\meta{ext} file.
686 %
687 % \begin{oldcomments}
688 % \@starttoc{EXT} ==
689 % BEGIN
690 % \begingroup
691 % \makeatletter
692 % read file \jobname.EXT
693 % IF @filesw = true
694 % THEN open \jobname.EXT as file \tf@EXT
695 % FI
696 % @nobreak :=G FALSE %% added 24 May 89
697 % \endgroup
698 % END
699 % \end{oldcomments}
700 %
701 % \changes{0.0}{1992/01/14}{(RmS) added \cs{immediate} to \cs{openout}
702 % as all \cs{write} commands
703 % are also executed \cs{immediate}}
704 % \changes{v1.0u}{1996/07/26}{removed \cs{global}
705 % before \cs{@nobreak...}}
706 % \begin{macrocode}
707 \def\@starttoc#1{%
708 \begingroup
709 \makeatletter
710 \@input{\jobname.#1}%
711 \if@filesw
712 \expandafter\newwrite\csname tf@#1\endcsname
713 \immediate\openout \csname tf@#1\endcsname \jobname.#1\relax
714 \fi
715 \@nobreakfalse
716 \endgroup}
717 % \end{macrocode}
718 % \end{macro}
719 %
720 % \begin{macro}{\addcontentsline}
721 % The |\addcontentsline{|\meta{table}|}{|\meta{type}|}{|%
722 % \meta{entry}|}| command allows the user to add
723 % his/her own entry to a table of contents, etc. The command adds the
724 % entry |\contentsline{|\meta{type}|}{|\meta{entry}|}{|\meta{page}|}|
725 % to the |.|\meta{table} file.
726 %
727 % This macro is implemented as an application of |\addtocontents|.
728 % Note that |\thepage| is not expandable during |\protected@write|
729 % therefore one gets the page number at the time of the |\shipout|.
730 %
731 % \changes{v1.0c}{1994/05/20}{Correct setting of \cs{protect}.}
732 % \changes{v1.0j}{1995/04/23}{Use \cs{contentsline} internally.}
733 % \changes{v1.0h}{1994/11/04}{Added \cs{protected@write} to
734 % \cs{addcontentsline}. ASAJ.}
735 % \begin{macrocode}
736 \def\addcontentsline#1#2#3{%
737 \addtocontents{#1}{\protect\contentsline{#2}{#3}{\thepage}}}
738 % \end{macrocode}
739 % \end{macro}
740 %
741 % \changes{v1.0c}{1994/05/20}{Correct setting of \cs{protect}.}
742 % \changes{v1.0h}{1994/11/04}{Added \cs{protected@write} to
743 % \cs{addtocontents}. ASAJ.}
744 % \begin{macro}{\addtocontents}
745 %
746 % The |\addtocontents{|\meta{table}|}{|\meta{text}|}| command
747 % adds \meta{text} to the |.|\meta{table} file, with no
748 % page number.
749 %
750 % \begin{macrocode}
751 \long\def\addtocontents#1#2{%
752 \protected@write\@auxout
753 {\let\label\@gobble \let\index\@gobble \let\glossary\@gobble}%
754 {\string\@writefile{#1}{#2}}}
755 % \end{macrocode}
756 % \end{macro}
757 %
758 % \begin{macro}{\contentsline}
759 % The |\contentsline{|\meta{type}|}{|\meta{entry}|}{|\meta{page}|}|
760 % macro produces a \meta{type} entry in a table of contents, etc.
761 % It will appear in the |.toc| or other file. For example,
762 % The entry for subsection 1.4.3 in the table of contents for
763 % example, might be produced by:
764 %
765 % \begin{verbatim}
766 % \contentsline{subsection}
767 % {\makebox{30pt}[r]{1.4.3} Gnats and Gnus}{22}
768 % \end{verbatim}
769 %
770 % The |\protect| command causes command sequences to be written
771 % without expanding them.
772 %
773 % \begin{macrocode}
774 \def\contentsline#1{\csname l@#1\endcsname}
775 % \end{macrocode}
776 % \end{macro}
777 %
778 % |\@dottedtocline{|\meta{level}|}{|\meta{indent}|}{|\meta{numwidth}%
779 % |}{|\meta{title}|}{|\meta{page}|}|:
780 % Macro to produce a table of contents line with the following
781 % parameters:
782 % \begin{description}
783 % \item[level] If \meta{level} $>$ |\c@tocdepth|, then no line
784 % produced.
785 % \item[indent] Total indentation from the left margin.
786 % \item[numwidth] Width of box for number if the \meta{title} has a
787 % |\numberline| command.
788 % As of 25 Jan 1988, this is also the amount of extra
789 % indentation added to second and later lines of a
790 % multiple line entry.
791 % \item[title] Contents of entry.
792 % \item[page] Page number.
793 % \end{description}
794 %
795 % Uses the following parameters, which must be set by the document
796 % style. They should be defined with |\def|'s.
797 % \begin{description}
798 % \item[|\@pnumwidth|] Width of box in which page number is set.
799 % \item[|\@tocrmarg|] Right margin indentation for all but last line
800 % of multiple-line entries.
801 % \item[|\@dotsep|] Separation between dots, in mu units.
802 % Should be |\def|'d to a number like 2 or 1.7
803 % \end{description}
804 %
805 % \begin{macro}{\@dottedtocline}
806 % \changes{LaTeX2.09}{1991/09/29}
807 % {(RmS) added \cs{reset@font} for page number}
808 % \changes{v1.0e}{1994/05/25}{Put braces around argument 4
809 % (the actual toc entry) to avoid font (and possibly other)
810 % changes leaking out to the leaders.}
811 % \changes{v1.0g}{1994/10/18}{Added \cs{normalcolor} for page number}
812 % \changes{v1.0z}{1996/12/20}{Added \cs{nobreak} for latex/2343}
813 % \begin{macrocode}
814 \def\@dottedtocline#1#2#3#4#5{%
815 \ifnum #1>\c@tocdepth \else
816 \vskip \z@ \@plus.2\p@
817 {\leftskip #2\relax \rightskip \@tocrmarg \parfillskip -\rightskip
818 \parindent #2\relax\@afterindenttrue
819 \interlinepenalty\@M
820 \leavevmode
821 \@tempdima #3\relax
822 % \end{macrocode}
823 % \changes{v1.0z}{1996/12/20}{Added \cs{nobreak} for latex/2343}
824 % \begin{macrocode}
825 \advance\leftskip \@tempdima \null\nobreak\hskip -\leftskip
826 {#4}\nobreak
827 \leaders\hbox{$\m@th
828 % \end{macrocode}
829 % If a document uses fonts other than computer modern, the use of a
830 % dot from math can be very disturbing despite the fact that this
831 % might be the only place in a document that then uses computer
832 % modern.
833 % Therefore we surround the dot with an |\hbox| to escape to the
834 % surrounding text font.
835 % \changes{v1.0k}{1995/04/25}{Added \cs{hbox} around dots.}
836 % \changes{v1.0l}{1995/05/02}{Don't reset to \cs{rmfamily}}
837 % \begin{macrocode}
838 \mkern \@dotsep mu\hbox{.}\mkern \@dotsep
839 mu$}\hfill
840 \nobreak
841 \hb@xt@\@pnumwidth{\hfil\normalfont \normalcolor #5}%
842 \par}%
843 \fi}
844 % \end{macrocode}
845 % \end{macro}
846 %
847 % \textbf{Note:} |\nobreak|'s added 7 Jan 86 to prevent bad line break
848 % that left the page number dangling by itself at left edge of a new
849 % line.
850 %
851 % Changed 25 Jan 88 to use |\leftskip| instead of |\hangindent| so
852 % leaders of multiple-line contents entries would line up properly.
853 % \begin{macro}{\numberline}
854 % |\numberline{|\meta{number}|}|: For use in a |\contentsline| command.
855 % It puts \meta{number} flushleft in a box of width |\@tempdima|
856 % (Before 25
857 % Jan 88 change, it also added |\@tempdima| to the hanging
858 % indentation.)
859 %
860 % \begin{macrocode}
861 \def\numberline#1{\hb@xt@\@tempdima{#1\hfil}}
862 %</2ekernel>
863 % \end{macrocode}
864 % \end{macro}
865 %
866 % \Finale
867 %