| blob | 88ed6cba08e27625467be482729b399a6ba81986 |
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 % \iffalse
30 %%% From File: ltfloat.dtx
31 %
32 %<*driver>
33 % \fi
34 \ProvidesFile{ltfloat.dtx}[2015/02/21 v1.2c LaTeX Kernel (Floats)]
35 % \iffalse
36 \documentclass{ltxdoc}
37 \GetFileInfo{ltfloat.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 Rainer Sch\"opf}
49 \begin{document}
50 \MaintainedByLaTeXTeam{latex}
51 \maketitle
52 \DocInput{\filename}
53 \end{document}
54 %</driver>
55 % \fi
56 %
57 % \CheckSum{869}
58 %
59 % \section{Floats}
60 %
61 % The different types of floats are identified by a \meta{type} name,
62 % which is the name of the counter for that kind of float. For
63 % example, figures are of type `figure' and tables are of type `table'.
64 % Each \meta{type} has associated a positive \meta{type number}, which
65 % is a power of two. E.g.,\\
66 % figures might be have type number~1, tables type number~2, programs
67 % type number~4, etc.
68 %
69 % The locations where a float can go are specified by a
70 % \meta{placement specifier}, which is a list of the possible
71 % locations, each denoted by a letter as follows:
72 % \begin{center}
73 % \begin{tabular}{l@{ : }l@{ --- }l}
74 % h & here & at the current location in the text.\\
75 % t & top & at the top of a text page.\\
76 % b & bottom & at the bottom of a text page.\\
77 % p & page & on a separate float page
78 % \end{tabular}
79 % \end{center}
80 % In addition, in conjunction with these, you can use `!' which means
81 % that the current values of the float positioning parameters are
82 % ignored for this float. (Has no effect on `p', float page
83 % positioning.)
84 % For example, `pht' specifies that the float can appear in any of
85 % three locations: page, here or top.
86 %
87 % \StopEventually{}
88 %
89 %
90 % \changes{v1.0a}{1994/03/04}{Initial version, split from latex.dtx}
91 % \changes{v1.0b}{1994/03/28}{Split further from ltherest.dtx}
92 % \changes{v1.0e}{1994/04/25}{Changed warning messages}
93 % \changes{v1.0e}{1994/04/25}{Removed obsolete tracing code}
94 % \changes{v1.0f}{1994/05/03}
95 % {(CAR) Added \cs{@largefloatcheck}}
96 % \changes{v1.0f}{1994/05/03}{Removed unnecessary braces from
97 % arguments of \cs{@ifnextchar}}
98 % \changes{v1.0i}{1994/05/22}{Use new warning commands}
99 % \changes{v1.1e}{1994/11/17}
100 % {\cs{@tempa} to \cs{reserved@a}}
101 % \changes{v1.1g}{1994/12/10}{Some temps reinserted temporarily}
102 % \changes{v1.1n}{1995/11/28}{documentation fixes}
103 % \changes{v1.1s}{1997/06/16}{documentation fixes}
104 %
105 % \subsection{Floating Environments}
106 % \begin{macrocode}
107 %<*2ekernel>
108 \message{floats,}
109 % \end{macrocode}
110 % \begin{oldcomments}
111 %
112 % Where floats may appear on a page, and how many may appear there
113 % are specified by the following float placement parameters. The
114 % numbers are named like counters so the user can set them with
115 % the ordinary counter-setting commands.
116 %
117 % \c@topnumber : Number of floats allowed at the top of a column.
118 % \topfraction : Fraction of column that can be devoted to floats.
119 % \c@dbltopnumber, \dbltopfraction
120 % : Same as above, but for double-column floats.
121 % \c@bottomnumber, \bottomfraction
122 % : Same as above for bottom of page.
123 % \c@totalnumber : Number of floats allowed in a single column,
124 % including in-text floats.
125 % \textfraction :Minimum fraction of column that must contain text.
126 % \floatpagefraction: Minimum fraction of page that must be taken
127 % up by float page.
128 % \dblfloatpagefraction
129 % : Same as above, for double-column floats.
130 %
131 % The document style must define the following.
132 %
133 % \fps@TYPE : The default placement specifier for floats of type
134 % TYPE.
135 %
136 % \ftype@TYPE : The type number for floats of type TYPE.
137 %
138 % \ext@TYPE : The file extension indicating the file on which the
139 % contents list for float type TYPE is stored.
140 % For example, \ext@figure = 'lof'.
141 %
142 % \fnum@TYPE : A macro to generate the figure number for a caption.
143 % For example, \fnum@TYPE == Figure \thefigure.
144 %
145 % \@makecaption{NUM}{TEXT} :
146 % A macro to make a caption, with NUM the value
147 % produced by \fnum@... and TEXT the text of the caption.
148 % It can assume it's in a \parbox of the appropriate width.
149 %
150 % \@float{TYPE}[PLACEMENT] : This macro begins a float environment for a
151 % single-column float of type TYPE with PLACEMENT as the placement
152 % specifier. The default value of PLACEMENT is defined by
153 % \fps@TYPE. The environment is ended by \end@float.
154 % E.g., \figure == \@float{figure}, \endfigure == \end@float.
155 %
156 % \@float{TYPE}[PLACEMENT] ==
157 % BEGIN
158 % if hmode then \@bsphack
159 % \@floatpenalty := -10002
160 % else \@floatpenalty := -10003
161 % fi
162 % \@captype ==L TYPE
163 % \@dblflset
164 % \@fps ==L PLACEMENT
165 % \@onelevel@sanitize \@fps
166 % add default PLACEMENT if at most ! in PLACEMENT == \@fpsadddefault
167 % if inner
168 % then LaTeX Error: 'Not in outer paragraph mode.'
169 % \@floatpenalty := 0
170 % else if \@freelist nonempty
171 % then \@currbox :=L head of \@freelist
172 % \@freelist :=G tail of \@freelist
173 % \count\@currbox :=G 32*\ftype@TYPE +
174 % bits determined by PLACEMENT
175 % else \@floatpenalty := 0
176 % LaTeX Error: 'Too many unprocessed floats'
177 % fi
178 % fi
179 % \@currbox :=G \color@vbox
180 % \normalcolor
181 % \vbox{
182 % %% 15 Dec 87 --
183 % %% removed \boxmaxdepth :=L 0pt
184 % %% that made box 0 depth because it screwed
185 % %% things up. Instead, added \vskip0pt at end
186 % \hsize = \columnwidth
187 % \@parboxrestore
188 % \@floatboxreset
189 % END
190 %
191 % \caption ==
192 % BEGIN
193 % \refstepcounter{\@captype}
194 % \@dblarg{\@caption{\@captype}}
195 % END
196 %
197 % In following definition, \par moved from after \addcontentsline to
198 % before \addcontentsline because the \write could cause
199 % an extra blank line to be added to the paragraph above the
200 % caption. (Change made 12 Jun 87)
201 %
202 % \@caption{TYPE}[STEXT]{TEXT} ==
203 % BEGIN
204 % \par
205 % \addcontentsline{\ext@TYPE}{TYPE}{\numberline{\theTYPE}{STEXT}}
206 % \begingroup
207 % \@parboxrestore
208 % \@normalsize
209 % \@makecaption{\fnum@TYPE}{TEXT}
210 % \par
211 % \endgroup
212 % END
213 %
214 %
215 % \@dblfloat{TYPE}[PLACEMENT] : Macro to begin a float environment for
216 % a double-column float of type TYPE with PLACEMENT as the placement
217 % specifier. The default value of PLACEMENT is 'tp'
218 % The environment is ended by \end@dblfloat.
219 % E.g., \figure* == \@dblfloat{figure},
220 % \endfigure* == \end@dblfloat.
221 %
222 % \@dblfloat{TYPE}[PLACEMENT] ==
223 % Identical to \@float{TYPE}[PLACEMENT] except \hsize and \linewidth
224 % are set to \textwidth.
225 % \end{oldcomments}
226 %
227 % \begin{macro}{\@floatpenalty}
228 % \begin{macrocode}
229 \newcount\@floatpenalty
230 % \end{macrocode}
231 % \end{macro}
232 %
233 % \begin{macro}{\caption}
234 %
235 % This is set to be an error message outside a float since no
236 % captype is defined there; this may need to be changed by some
237 % classes.
238 % \changes{v1.1u}{1999/04/19}
239 % {Made caption an error outside a float: latex/2815}
240 % \begin{macrocode}
241 \def\caption{%
242 \ifx\@captype\@undefined
243 \@latex@error{\noexpand\caption outside float}\@ehd
244 \expandafter\@gobble
245 \else
246 \refstepcounter\@captype
247 \expandafter\@firstofone
248 \fi
249 {\@dblarg{\@caption\@captype}}%
250 }
251 % \end{macrocode}
252 % \end{macro}
253 %
254 % \begin{macro}{\@caption}
255 % \changes{v1.0b}{1994/03/28}
256 % {Use \cs{normalsize} not \cs{@normalsize}}
257 % \changes{v1.1r}{1996/12/06}
258 % {Call \cs{@setminpage} if needed. latex/2318}
259 % \begin{macrocode}
260 \long\def\@caption#1[#2]#3{%
261 \par
262 \addcontentsline{\csname ext@#1\endcsname}{#1}%
263 {\protect\numberline{\csname the#1\endcsname}{\ignorespaces #2}}%
264 \begingroup
265 % \end{macrocode}
266 %
267 % The paragraph setting parameters are normalised at this point, however
268 % |\@parboxrestore| resets |\everypar| which is not correct in this
269 % context so |\@setminipage| is called if needed.
270 %
271 % The float mechanism, like minipage, sets the flag |@minipage| true
272 % before executing the user-supplied text. Many \LaTeX\ constructs
273 % test for this flag and do not add vertical space when it is true.
274 % The intention is that this emulates \TeX's `top of page' behaviour.
275 % The flag must be set false at the start of the first paragraph. This
276 % is achieved by a redefinition of |\everypar|, but the call to
277 % |\@parboxrestore| removes that redefinition, so it is re-inserted
278 % if needed. If the flag is already false then the |\caption| was not
279 % the first entry in the float, and so some other paragraph has already
280 % activated the special |\everypar|. In this case no further action is
281 % needed.
282 % \begin{macrocode}
283 \@parboxrestore
284 \if@minipage
285 \@setminipage
286 \fi
287 % \end{macrocode}
288 %
289 % \begin{macrocode}
290 \normalsize
291 \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par
292 \endgroup}
293 % \end{macrocode}
294 % \end{macro}
295 %
296 % \begin{macro}{\@float}
297 % \begin{macro}{\@dblflset}
298 % \changes{v1.1a}{1994/10/31}{Macro added}
299 % \changes{v1.1g}{1994/12/10}{Macro removed temporarily}
300 % \changes{v1.1a}{1994/10/31}
301 % {Major changes to parameter parsing, setting of local variables,
302 % etc; two-column and one-column cases merged; space hacks moved}
303 % \changes{v1.1c}{1994/11/05}
304 % {Add compatibility with old version of \cs{@xfloat}.}
305 % \changes{v1.1g}{1994/12/10}{Old version reinstated temporarily}
306 %
307 % \begin{macrocode}
308 \def\@float#1{%
309 \@ifnextchar[%
310 {\@xfloat{#1}}%
311 {\edef\reserved@a{\noexpand\@xfloat{#1}[\csname fps@#1\endcsname]}%
312 \reserved@a}}
313 % \end{macrocode}
314 %
315 % \end{macro}
316 % \end{macro}
317 %
318 % \begin{macro}{\@dblfloat}
319 % \changes{v1.1a}{1994/10/31}
320 % {Major changes since two-column and one-column cases merged}
321 % \changes{v1.1g}{1994/12/10}{Old version reinstated temporarily}
322 %
323 % \begin{macrocode}
324 \def\@dblfloat{%
325 \if@twocolumn\let\reserved@a\@dbflt\else\let\reserved@a\@float\fi
326 \reserved@a}
327 % \end{macrocode}
328 % \end{macro}
329 %
330 %
331 % \begin{macro}{\fps@dbl}
332 % \changes{v1.1a}{1994/10/31}{Macro added}
333 % \changes{v1.1g}{1994/12/10}{Macro removed temporarily}
334 % Note that all double floats have default fps `tp'.
335 % \end{macro}
336 %
337 % \begin{macro}{\@setfps}
338 % \changes{v1.1a}{1994/10/31}{Macro added}
339 % \changes{v1.1c}{1994/11/05}
340 % {Add compatibility with old version of \cs{@xfloat}.}
341 % \changes{v1.1g}{1994/12/10}{Macro removed temporarily}
342 % This sets the fps, dealing with error conditions by adding
343 % the default.
344 %
345 % \end{macro}
346 %
347 % \begin{macro}{\@xfloat}
348 % \changes{LaTeX2e}{1993/12/05}{Command changed}
349 % \changes{LaTeX2e}{1994/01/21}{Added missing percent characters.}
350 % \changes{v1.1a}{1994/10/31}
351 % {Major changes, removing setting of local variables, space hacks
352 % etc; two-column and one-column cases merged}
353 % \changes{v1.1c}{1994/11/05}
354 % {Add compatibility with old version of \cs{@xfloat}: but the
355 % arguments, provided at exorbitant cost, are now completely
356 % ignored}
357 % \changes{v1.1f}{1994/11/21}
358 % {Missing percents reinserted after 4, 8: these are not numbers.}
359 % \changes{v1.1g}{1994/12/10}{Old version reinstated temporarily}
360 % \changes{v1.1g}{1994/12/10}{Sanitisation added temporarily}
361 % The first part of this sets the count register that stores all
362 % the information about the type and fps of the float.
363 %
364 % We assume here that the default specifiers already contain no
365 % active characters.
366 %
367 % It may be better to store the defaults as numbers, rather than
368 % symbol strings.
369 %
370 % \changes{v1.1p}{1996/10/24}{Added \cs{@nodocument} to trap
371 % floats in the preamble}
372 % \begin{macrocode}
373 %</2ekernel>
374 %<latexrelease>\IncludeInRelease{2015/01/01}%
375 %<latexrelease> {\@xfloat}{Check float options}%
376 %<*2ekernel|latexrelease>
377 \def\@xfloat #1[#2]{%
378 \@nodocument
379 \def \@captype {#1}%
380 \def \@fps {#2}%
381 \@onelevel@sanitize \@fps
382 \def \reserved@b {!}%
383 \ifx \reserved@b \@fps
384 \@fpsadddefault
385 \else
386 \ifx \@fps \@empty
387 \@fpsadddefault
388 \fi
389 \fi
390 \ifhmode
391 \@bsphack
392 \@floatpenalty -\@Mii
393 \else
394 \@floatpenalty-\@Miii
395 \fi
396 \ifinner
397 \@parmoderr\@floatpenalty\z@
398 \else
399 \@next\@currbox\@freelist
400 {%
401 \@tempcnta \sixt@@n
402 \expandafter \@tfor \expandafter \reserved@a
403 \expandafter :\expandafter =\@fps
404 \do
405 % \end{macrocode}
406 % \changes{v1.2b}{2015/01/11}{Check for valid option (latexrelease)}
407 % Start of changes, use a nested if structure, ending in an error.
408 % \begin{macrocode}
409 {%
410 \if \reserved@a h%
411 \ifodd \@tempcnta
412 \else
413 \advance \@tempcnta \@ne
414 \fi
415 \else\if \reserved@a t%
416 \@setfpsbit \tw@
417 \else\if \reserved@a b%
418 \@setfpsbit 4%
419 \else\if \reserved@a p%
420 \@setfpsbit 8%
421 \else\if \reserved@a !%
422 \ifnum \@tempcnta>15
423 \advance\@tempcnta -\sixt@@n\relax
424 \fi
425 \else
426 \@latex@error{Unknown float option `\reserved@a'}%
427 {Option `\reserved@a' ignored and `p' used.}%
428 \@setfpsbit 8%
429 \fi\fi\fi\fi\fi
430 }%
431 % \end{macrocode}
432 % End of changes
433 % \begin{macrocode}
434 \@tempcntb \csname ftype@\@captype \endcsname
435 \multiply \@tempcntb \@xxxii
436 \advance \@tempcnta \@tempcntb
437 \global \count\@currbox \@tempcnta
438 }%
439 \@fltovf
440 \fi
441 % \end{macrocode}
442 % The remainder sets up the box in which the float is typeset, and
443 % the typesetting environment to be used. It is essential to have
444 % the extra box to avoid the unwanted space that would otherwise
445 % often be put at the top of the float.
446 %
447 % It ends with a hook; not sure how useful this is but it is needed
448 % at present to deal with double-column floats.
449 % \task{CAR?}{Sort out hooks}
450 % \changes{v1.0a}{1994/03/07}
451 % {(DPC) Extra group for colour}
452 % \changes{v1.0c}{1994/03/14}
453 % {(DPC) Use \cs{color@begingroup}}
454 % \changes{v1.0g}{1994/05/13}
455 % {(DPC) Use \cs{normalcolor}}
456 % \changes{v1.1a}{1994/10/31}
457 % {(DPC/CAR) Extra box added to remove colour resetting from vmode}
458 % \changes{v1.1a}{1994/10/31}{Reset hook added}
459 % \changes{v1.1c}{1994/11/05}
460 % {Use new \cs{color@hbox} concept.}
461 % \changes{v1.1f}{1994/11/21}
462 % {Changed to \cs{color@vbox} so that large floats overflow
463 % at the bottom}
464 % \changes{v1.1f}{1994/11/21}{Use \cs{@setnobreak}}
465 % \changes{v1.1f}{1994/11/21}{Added \cs{@setminipage}}
466 % \changes{v1.1f}{1994/11/21}{Added resetting of size and font}
467 % \changes{v1.1m}{1995/05/25}{(CAR) Resettings moved to hook}
468 % \begin{macrocode}
469 \global \setbox\@currbox
470 \color@vbox
471 \normalcolor
472 \vbox \bgroup
473 \hsize\columnwidth
474 \@parboxrestore
475 \@floatboxreset
476 }%
477 %</2ekernel|latexrelease>
478 %<latexrelease>\EndIncludeInRelease
479 %<latexrelease>\IncludeInRelease{0000/00/00}%
480 %<latexrelease> {\@xfloat}{Check float options}%
481 %<latexrelease>\def\@xfloat #1[#2]{%
482 %<latexrelease> \@nodocument
483 %<latexrelease> \def \@captype {#1}%
484 %<latexrelease> \def \@fps {#2}%
485 %<latexrelease> \@onelevel@sanitize \@fps
486 %<latexrelease> \def \reserved@b {!}%
487 %<latexrelease> \ifx \reserved@b \@fps
488 %<latexrelease> \@fpsadddefault
489 %<latexrelease> \else
490 %<latexrelease> \ifx \@fps \@empty
491 %<latexrelease> \@fpsadddefault
492 %<latexrelease> \fi
493 %<latexrelease> \fi
494 %<latexrelease> \ifhmode
495 %<latexrelease> \@bsphack
496 %<latexrelease> \@floatpenalty -\@Mii
497 %<latexrelease> \else
498 %<latexrelease> \@floatpenalty-\@Miii
499 %<latexrelease> \fi
500 %<latexrelease> \ifinner
501 %<latexrelease> \@parmoderr\@floatpenalty\z@
502 %<latexrelease> \else
503 %<latexrelease> \@next\@currbox\@freelist
504 %<latexrelease> {%
505 %<latexrelease> \@tempcnta \sixt@@n
506 %<latexrelease> \expandafter \@tfor \expandafter \reserved@a
507 %<latexrelease> \expandafter :\expandafter =\@fps
508 %<latexrelease> \do
509 %<latexrelease> {%
510 %<latexrelease> \if \reserved@a h%
511 %<latexrelease> \ifodd \@tempcnta
512 %<latexrelease> \else
513 %<latexrelease> \advance \@tempcnta \@ne
514 %<latexrelease> \fi
515 %<latexrelease> \fi
516 %<latexrelease> \if \reserved@a t%
517 %<latexrelease> \@setfpsbit \tw@
518 %<latexrelease> \fi
519 %<latexrelease> \if \reserved@a b%
520 %<latexrelease> \@setfpsbit 4%
521 %<latexrelease> \fi
522 %<latexrelease> \if \reserved@a p%
523 %<latexrelease> \@setfpsbit 8%
524 %<latexrelease> \fi
525 %<latexrelease> \if \reserved@a !%
526 %<latexrelease> \ifnum \@tempcnta>15
527 %<latexrelease> \advance\@tempcnta -\sixt@@n\relax
528 %<latexrelease> \fi
529 %<latexrelease> \fi
530 %<latexrelease> }%
531 %<latexrelease> \@tempcntb \csname ftype@\@captype \endcsname
532 %<latexrelease> \multiply \@tempcntb \@xxxii
533 %<latexrelease> \advance \@tempcnta \@tempcntb
534 %<latexrelease> \global \count\@currbox \@tempcnta
535 %<latexrelease> }%
536 %<latexrelease> \@fltovf
537 %<latexrelease> \fi
538 %<latexrelease> \global \setbox\@currbox
539 %<latexrelease> \color@vbox
540 %<latexrelease> \normalcolor
541 %<latexrelease> \vbox \bgroup
542 %<latexrelease> \hsize\columnwidth
543 %<latexrelease> \@parboxrestore
544 %<latexrelease> \@floatboxreset
545 %<latexrelease>}%
546 %<latexrelease>\EndIncludeInRelease
547 %<*2ekernel>
548 % \end{macrocode}
549 % \end{macro}
550 %
551 % \begin{macro}{\@floatboxreset}
552 % \changes{v1.1a}{1994/10/31}{Macro added}
553 %
554 % The rational for allowing these normally global flags to be set
555 % locally here, via |\@parboxrestore|, was stated originally by
556 % Donald Arseneau and extended by Chris Rowley.
557 % It is because these flags are only set globally to
558 % true by section commands, and these should never appear within
559 % marginals or floats or, indeed, in any group; and they are only ever
560 % set globally to false when they are definitely true.
561 %
562 % If anyone is unhappy with this argument then both flags should be
563 % treated as in |\set@nobreak|; otherwise this command will be
564 % redundant.
565 % \changes{v1.1p}{1996/10/24}
566 % {Added local settings of flags: dangerous!!}
567 % \begin{macrocode}
568 \def \@floatboxreset {%
569 \reset@font
570 \normalsize
571 \@setminipage
572 }
573 % \end{macrocode}
574 % \end{macro}
575 %
576 % \begin{macro}{\@setnobreak}
577 % \changes{v1.1f}{1994/11/21}{Macro added}
578 % \changes{v1.1n}{1996/07/26}{remove unecessary \cs{global} before
579 % \cs{@nobreak...}}
580 % \begin{macrocode}
581 \def \@setnobreak{%
582 \if@nobreak
583 \let\outer@nobreak\@nobreaktrue
584 \@nobreakfalse
585 \fi
586 }
587 % \end{macrocode}
588 % \end{macro}
589 %
590 % \begin{macro}{\@setminipage}
591 % \changes{v1.1f}{1994/11/21}{Macro added}
592 % \changes{v1.1n}{1996/07/26}{remove unecessary \cs{global} before
593 % \cs{@minipage...}}
594 % \begin{macrocode}
595 \def \@setminipage{%
596 \@minipagetrue
597 \everypar{\@minipagefalse\everypar{}}%
598 }
599 % \end{macrocode}
600 % \end{macro}
601 %
602 % \begin{macro}{\end@float}
603 % \changes{v1.0f}{1994/05/03}
604 % {(CAR) Added \cs{@largefloatcheck}}
605 % \changes{v1.1n}{1995/10/25}{(CAR) unify code for double and
606 % single versions}
607 % \begin{macrocode}
608 \def\end@float{%
609 \@endfloatbox
610 \ifnum\@floatpenalty <\z@
611 % \end{macrocode}
612 % We make sure that we never exceed |\textheight|, otherwise float
613 % will never get typeset (91/03/15 FMi).
614 % \begin{macrocode}
615 \@largefloatcheck
616 \@cons\@currlist\@currbox
617 \ifnum\@floatpenalty <-\@Mii
618 \penalty -\@Miv
619 % \end{macrocode}
620 % Saving and restoring |\prevdepth| added 26 May 87 to prevent extra
621 % vertical space when used in vertical mode.
622 % \begin{macrocode}
623 \@tempdima\prevdepth
624 \vbox{}%
625 \prevdepth\@tempdima
626 % \end{macrocode}
627 %
628 % \begin{macrocode}
629 \penalty\@floatpenalty
630 % \end{macrocode}
631 % \changes{LaTeX2.09}{1992/03/18}
632 % {(RmS) changed \cs{@esphack} to \cs{@Esphack}}
633 % \begin{macrocode}
634 \else
635 \vadjust{\penalty -\@Miv \vbox{}\penalty\@floatpenalty}\@Esphack
636 \fi
637 \fi
638 }
639 % \end{macrocode}
640 % \end{macro}
641 %
642 % \begin{macro}{\end@dblfloat}
643 % \changes{v1.0f}{1994/05/03}{\cs{@largefloatcheck} added}
644 % \changes{v1.1n}{1995/10/25}{(CAR) unify code for double and
645 % single versions}
646 % \changes{v1.2b}{2015/01/11}{float order in 2-column (latexrelease)}
647 % \begin{macrocode}
648 %</2ekernel>
649 %<latexrelease>\IncludeInRelease{2015/01/01}%
650 %<latexrelease> {\end@dblfloat}{float order in 2-column}%
651 %<*2ekernel|latexrelease>
652 \def\end@dblfloat{%
653 \if@twocolumn
654 \@endfloatbox
655 \ifnum\@floatpenalty <\z@
656 \@largefloatcheck
657 % \end{macrocode}
658 %
659 % Force the depth of two column float boxes.
660 % \begin{macrocode}
661 \global\dp\@currbox1sp %
662 % \end{macrocode}
663 % What follows is essentially |\end@float| without a starting
664 % |\@endfloatbox|.
665 % \changes{v1.2b}{2000/09/24}{FMi: use output routine to
666 % defer float}
667 % \changes{v1.2b}{2014/04/27}{Inline the code to allow some
668 % coexistence with packages that hook into \cs{end@float} and do not
669 % know about the algorithm change}
670 % \begin{macrocode}
671 \@cons\@currlist\@currbox
672 \ifnum\@floatpenalty <-\@Mii
673 \penalty -\@Miv
674 \@tempdima\prevdepth
675 \vbox{}%
676 \prevdepth\@tempdima
677 \penalty\@floatpenalty
678 \else
679 \vadjust{\penalty -\@Miv \vbox{}\penalty\@floatpenalty}\@Esphack
680 \fi
681 % \end{macrocode}
682 % \changes{v1.2b}{2014/06/10}{missing \cs{fi} added}
683 % \begin{macrocode}
684 \fi
685 \else
686 \end@float
687 \fi
688 }%
689 %</2ekernel|latexrelease>
690 %<latexrelease>\EndIncludeInRelease
691 %<latexrelease>\IncludeInRelease{0000/00/00}%
692 %<latexrelease> {\end@dblfloat}{float order in 2-column}%
693 %<latexrelease>\def\end@dblfloat{%
694 %<latexrelease>\if@twocolumn
695 %<latexrelease> \@endfloatbox
696 %<latexrelease> \ifnum\@floatpenalty <\z@
697 % \end{macrocode}
698 % We make sure that we never exceed |\textheight|, otherwise float
699 % will never get typeset (91/03/15 FMi).
700 % \begin{macrocode}
701 %<latexrelease> \@largefloatcheck
702 %<latexrelease> \@cons\@dbldeferlist\@currbox
703 %<latexrelease> \fi
704 % \end{macrocode}
705 % RmS 92/03/18 changed |\@esphack| to |\@Esphack|.
706 % \begin{macrocode}
707 %<latexrelease> \ifnum \@floatpenalty =-\@Mii \@Esphack\fi
708 %<latexrelease>\else
709 %<latexrelease> \end@float
710 %<latexrelease>\fi
711 %<latexrelease>}%
712 %<latexrelease>\EndIncludeInRelease
713 %<*2ekernel>
714 % \end{macrocode}
715 % \end{macro}
716 %
717 % \begin{macro}{\@endfloatbox}
718 % \changes{v1.1n}{1995/10/25}{(CAR) macro added: to unify code for
719 % double and single versions}
720 % This macro is not intended to be a hook; it is designed to help
721 % maintain the integrity of this code, which is used twice and, as
722 % can be seen, is subject to frequent changes.
723 % \begin{macrocode}
724 \def \@endfloatbox{%
725 \par\vskip\z@skip %% \par\vskip\z@ added 15 Dec 87
726 % \end{macrocode}
727 % \changes{v1.0a}
728 % {1994/03/07}{(DPC) Extra group for colour}
729 % \changes{v1.0c}{1994/03/14}
730 % {(DPC) Use \cs{color@endgroup}}
731 % \changes{v1.0h}{1994/05/20}{Restore outer value of @nobreak switch.}
732 % \changes{v1.1a}{1994/10/31}
733 % {(DPC/CAR) Extra box added to remove colour resetting from vmode}
734 % \changes{v1.1c}{1994/11/05}
735 % {Use new \cs{color@hbox} concept.}
736 % \changes{v1.1f}{1994/11/21}{Corrected position of \cs{outer@nobreak}}
737 % \changes{v1.1f}{1994/11/21}{Added reset of minipage flag}
738 % \changes{v1.1n}{1996/07/26}{remove unecessary \cs{global} before
739 % \cs{@minipage...}}
740 % \begin{macrocode}
741 \@minipagefalse
742 \outer@nobreak
743 \egroup %% end of vbox
744 \color@endbox
745 }
746 %
747 % \begin{macro}{\outer@nobreak}
748 % \changes{v1.0h}{1994/05/20}{Macro added: default is to do nothing.}
749 % \begin{macrocode}
750 \let\outer@nobreak\@empty
751 % \end{macrocode}
752 % \end{macro}
753 %
754 %
755 % \begin{macro}{\@largefloatcheck}
756 % \changes{v1.0e}{1994/04/25}{Command added}
757 %
758 % This calculates by how much a float is oversize for the page and
759 % prints this in a warning message.
760 %
761 % \begin{macrocode}
762 \def \@largefloatcheck{%
763 \ifdim \ht\@currbox>\textheight
764 \@tempdima -\textheight
765 \advance \@tempdima \ht\@currbox
766 % \end{macrocode}
767 % \changes{v1.0e}{1994/04/25}{Changed warning message to give more
768 % info}
769 % \begin{macrocode}
770 \@latex@warning {Float too large for page by \the\@tempdima}%
771 \ht\@currbox \textheight
772 \fi
773 }
774 % \end{macrocode}
775 % \end{macro}
776 %
777 % \begin{macro}{\@dbflt}
778 % \begin{macro}{\@xdblfloat}
779 % \changes{v1.1a}{1994/10/31}
780 % {Macros removed: \cs{@dbflt}, \cs{@xdblfloat}}
781 % \changes{v1.1g}{1994/12/10}{Macros reinserted temporarily}
782 %
783 %
784 % \begin{macrocode}
785 \def\@dbflt#1{\@ifnextchar[{\@xdblfloat{#1}}{\@xdblfloat{#1}[tp]}}
786 \def\@xdblfloat#1[#2]{%
787 \@xfloat{#1}[#2]\hsize\textwidth\linewidth\textwidth}
788 % \end{macrocode}
789 % \end{macro}
790 % \end{macro}
791 %
792 %
793 % Moved to ltoutput 93/12/16
794 % \begin{macrocode}
795 %\newcount\c@topnumber
796 %\newcount\c@dbltopnumber
797 %\newcount\c@bottomnumber
798 %\newcount\c@totalnumber
799 % \end{macrocode}
800 %
801 % \begin{macro}{\@dblfloatplacement}
802 % An analysis of |\@floatplacement|:
803 %
804 % This should be called whenever |\@colht| has been set.
805 % \begin{macrocode}
806 \def\@floatplacement{\global\@topnum\c@topnumber
807 % Textpage bit, global:
808 \global\@toproom \topfraction\@colht
809 \global\@botnum \c@bottomnumber
810 \global\@botroom \bottomfraction\@colht
811 \global\@colnum \c@totalnumber
812 % Floatpage bit, local:
813 \@fpmin \floatpagefraction\@colht}
814 %</2ekernel>
815 % \end{macrocode}
816 % \end{macro}
817 %
818 % \begin{macro}{\@dblfloatplacement}
819 % \changes{LaTeX2e}{1993/12/05}{Command changed}
820 %
821 % This should be called only within a group. Now changed to
822 % provide extra checks in |\@addtodblcol|, needed when processing a
823 % BANG float.
824 %
825 % \changes{v1.2b}{2015/01/11}{float order in 2-column (latexrelease)}
826 % \begin{macrocode}
827 %<latexrelease>\IncludeInRelease{2015/01/01}%
828 %<latexrelease> {\@dblfloatplacement}{float order in 2-column}%
829 %<*2ekernel|latexrelease>
830 % \end{macrocode}
831 % When making two column float area, look for floats with 1sp
832 % depth.
833 % \begin{macrocode}
834 \def\@dblfloatplacement{\global\@dbltopnum\c@dbltopnumber
835 \global\@dbltoproom \dbltopfraction\@colht
836 \@textmin \@colht
837 \advance \@textmin -\@dbltoproom
838 \@fpmin \dblfloatpagefraction\textheight
839 \@fptop \@dblfptop
840 \@fpsep \@dblfpsep
841 \@fpbot \@dblfpbot
842 % \end{macrocode}
843 % |\f@depth| is used in |\@testwrongwidth| to look for either
844 % column or dbl-column floats. A value of |1sp| signals the
845 % latter. Because of this setting here, |\@dblfloatplacment| needs to
846 % be called inside a group which is a questionable design.
847 % \begin{macrocode}
848 \def\f@depth{1sp}}%
849 % \end{macrocode}
850 %
851 % \begin{macrocode}
852 %</2ekernel|latexrelease>
853 %<latexrelease>\EndIncludeInRelease
854 %<latexrelease>\IncludeInRelease{0000/00/00}%
855 %<latexrelease> {\@dblfloatplacement}{float order in 2-column}%
856 %<latexrelease>\def \@dblfloatplacement {%
857 % \end{macrocode}
858 % Textpage bit: global, but need not be.
859 % \begin{macrocode}
860 %<latexrelease> \global \@dbltopnum \c@dbltopnumber
861 %<latexrelease> \global \@dbltoproom \dbltopfraction\@colht
862 % \end{macrocode}
863 % This new bit uses |\@textmin| to locally store the amount of extra
864 % room in the column.
865 % \begin{macrocode}
866 %<latexrelease> \@textmin \@colht
867 %<latexrelease> \advance \@textmin -\@dbltoproom
868 % \end{macrocode}
869 % Floatpage bit: must be local.
870 % \begin{macrocode}
871 %<latexrelease> \@fpmin \dblfloatpagefraction\textheight
872 %<latexrelease> \@fptop \@dblfptop
873 %<latexrelease> \@fpsep \@dblfpsep
874 %<latexrelease> \@fpbot \@dblfpbot
875 %<latexrelease>}%
876 %<latexrelease>\EndIncludeInRelease
877 %<*2ekernel>
878 % \end{macrocode}
879 % \end{macro}
880 %
881 %
882 % \begin{oldcomments}
883 % MARGINAL NOTES:
884 %
885 % Marginal notes use the same mechanism as floats to communicate
886 % with the \output routine. Marginal notes are distinguished from
887 % floats by having a negative placement specification. The command
888 % \marginpar [LTEXT]{RTEXT} generates a marginal note in a parbox,
889 % using LTEXT if it's on the left and RTEXT if it's on the right.
890 % (Default is RTEXT = LTEXT.) It uses the following parameters.
891 %
892 % \marginparwidth : Width of marginal notes.
893 % \marginparsep : Distance between marginal note and text.
894 % the page layout to determine how to move the marginal
895 % note into the margin. E.g., \@leftmarginskip ==
896 % \hskip -\marginparwidth \hskip -\marginparsep .
897 % \marginparpush : Minimum vertical separation between \marginpar's
898 %
899 % Marginal notes are normally put on the outside of the page
900 % if @mparswitch = true, and on the right if @mparswitch = false.
901 % The command \reversemarginpar reverses the side where they
902 % are put. \normalmarginpar undoes \reversemarginpar.
903 % These commands have no effect for two-column output.
904 %
905 % SURPRISE: if two marginal notes appear on the same line of
906 % text, then the second one could appear on the next page, in
907 % a funny position.
908 %
909 %
910 % \marginpar [LTEXT]{RTEXT} ==
911 % BEGIN
912 % if hmode then \@bsphack
913 % \@floatpenalty := -10002
914 % else \@floatpenalty := -10003
915 % fi
916 % if inner
917 % then LaTeX Error: 'Not in outer paragraph mode.'
918 % \@floatpenalty := 0
919 % else if \@freelist has two elements:
920 % then get \@marbox, \@currbox from \@freelist
921 % \count\@marbox :=G -1
922 % else \@floatpenalty := 0
923 % LaTeX Error: 'Too many unprocessed floats'
924 % \@currbox, \@marbox := \@tempboxa %%use \def
925 % fi
926 % fi
927 % if optional argument
928 % then %% \@xmpar ==
929 % \@savemarbox\@marbox{LTEXT}
930 % \@savemarbox\@currbox{RTEXT}
931 % else %% \@ympar ==
932 % \@savemarbox\@marbox{RTEXT}
933 % \box\@currbox :=G \box\@marbox
934 % fi
935 % \@xympar
936 % END
937 %
938 % \reversemarginpar == BEGIN \@mparbottom :=G 0
939 % @reversemargin :=G true
940 % END
941 %
942 % \normalmarginpar == BEGIN \@mparbottom :=G 0
943 % @reversemargin :=G false
944 % END
945 %
946 % \end{oldcomments}
947 %
948 % \begin{macro}{\marginpar}
949 % \begin{macrocode}
950 \def\marginpar{%
951 \ifhmode
952 \@bsphack
953 \@floatpenalty -\@Mii
954 \else
955 \@floatpenalty-\@Miii
956 \fi
957 \ifinner
958 \@parmoderr
959 \@floatpenalty\z@
960 \else
961 \@next\@currbox\@freelist{}{}%
962 \@next\@marbox\@freelist{\global\count\@marbox\m@ne}%
963 {\@floatpenalty\z@
964 \@fltovf\def\@currbox{\@tempboxa}\def\@marbox{\@tempboxa}}%
965 \fi
966 \@ifnextchar [\@xmpar\@ympar}
967 % \end{macrocode}
968 % \end{macro}
969 %
970 % \begin{macro}{\@xmpar}
971 % \begin{macrocode}
972 \long\def\@xmpar[#1]#2{%
973 \@savemarbox\@marbox{#1}%
974 \@savemarbox\@currbox{#2}%
975 \@xympar}
976 % \end{macrocode}
977 % \end{macro}
978 %
979 % \begin{macro}{\@ympar}
980 % \begin{macrocode}
981 \long\def\@ympar#1{%
982 \@savemarbox\@marbox{#1}%
983 \global\setbox\@currbox\copy\@marbox
984 \@xympar}
985 % \end{macrocode}
986 % \end{macro}
987 %
988 % \begin{macro}{\@savemarbox}
989 % \changes{v1.0b}{1994/03/12}
990 % {(DPC) Extra group for colour}
991 % \changes{v1.0c}{1994/03/14}
992 % {(DPC) Use \cs{color@begingroup}}
993 % \changes{v1.0d}{1994/04/18}
994 % {(DPC) Remove Colour support}
995 % \changes{v1.1a}{1994/10/31}
996 % {(DPC/CAR) Extra box added for colour}
997 % \changes{v1.1c}{1994/11/05}
998 % {Use new \cs{color@hbox} concept.}
999 % \changes{v1.1f}{1994/11/21}{Changed to \cs{color@vbox} }
1000 % \changes{v1.1f}{1994/11/21}{Use \cs{@setnobreak} etc}
1001 % \changes{v1.1f}{1994/11/21}{Added \cs{@setminipage} etc}
1002 % \changes{v1.1f}{1994/11/21}{Added resetting of size and font}
1003 % \changes{v1.1m}{1995/05/25}{(CAR) Resettings moved to hook}
1004 % \changes{v1.1n}{1996/07/26}{remove unecessary \cs{global} before
1005 % \cs{@minipage...}}
1006 % \begin{macrocode}
1007 \long\def \@savemarbox #1#2{%
1008 \global\setbox #1%
1009 \color@vbox
1010 \vtop{%
1011 \hsize\marginparwidth
1012 \@parboxrestore
1013 \@marginparreset
1014 #2%
1015 \@minipagefalse
1016 \outer@nobreak
1017 }%
1018 \color@endbox
1019 }
1020 % \end{macrocode}
1021 % \end{macro}
1022 %
1023 % \begin{macro}{\@marginparreset}
1024 % \changes{v1.1f}{1994/11/21}{Macro added}
1025 %
1026 % The rational for allowing these normally global flags to be set
1027 % locally here, via |\@parboxrestore| was stated originally by
1028 % Donald Arsenau and extended by Chris Rowley.
1029 % It is because these flags are only set globally to
1030 % true by section commands, and these should never appear within
1031 % marginals or floats or, indeed, in any group; and they are only ever
1032 % set globally to false when they are definitely true.
1033 %
1034 % If anyone is unhappy with this argument then both flags should be
1035 % treated as in |\set@nobreak|; otherwise this command will be
1036 % redundant.
1037 % \changes{v1.1p}{1996/10/24}
1038 % {Added local settings of flags: dangerous!!}
1039 % \begin{macrocode}
1040 \def \@marginparreset {%
1041 \reset@font
1042 \normalsize
1043 % \let\if@nobreak\iffalse
1044 % \let\if@noskipsec\iffalse
1045 % \@setnobreak
1046 \@setminipage
1047 }
1048 % \end{macrocode}
1049 % \end{macro}
1050 %
1051 % \begin{macro}{\@xympar}
1052 % \begin{macrocode}
1053 % \end{macrocode}
1054 % \changes{LaTeX2.09}{1992/03/18}
1055 % {(RmS) added \cs{global}\cs{@ignorefalse}}
1056 % \changes{v1.0b}{1994/03/12}
1057 % {(DPC) Extra bgroup for colour}
1058 % \changes{1.0c}{1994/03/14}
1059 % {(DPC) Use \cs{color@begingroup}}
1060 % \changes{v1.1a}{1994/10/31}
1061 % {(DPC/CAR) Extra box added since needed for floats}
1062 % \changes{v1.1c}{1994/11/05}
1063 % {Use new \cs{color@hbox} concept.}
1064 % \changes{v1.1f}{1994/11/21}{Changed to \cs{color@vbox} }
1065 % Setting the box here is done only because the code
1066 % uses \cs{end@float}; it will be empty and gets discarded.
1067 % \changes{v1.1o}{1996/08/02}{Remove \cs{global} before \cs{@ignore...}}
1068 % \begin{macrocode}
1069 \def \@xympar{%
1070 \ifnum\@floatpenalty <\z@\@cons\@currlist\@marbox\fi
1071 \setbox\@tempboxa
1072 \color@vbox
1073 \vbox \bgroup
1074 \end@float
1075 \@ignorefalse
1076 \@esphack
1077 }
1078 % \end{macrocode}
1079 % \end{macro}
1080 %
1081 % \begin{macro}{\reversemarginpar}
1082 % \begin{macro}{\normalmarginpar}
1083 % \begin{macrocode}
1084 \def\reversemarginpar{\global\@mparbottom\z@ \@reversemargintrue}
1085 \def\normalmarginpar{\global\@mparbottom\z@ \@reversemarginfalse}
1086 % \end{macrocode}
1087 % \end{macro}
1088 % \end{macro}
1089 %
1090 % \begin{macrocode}
1091 \message{footnotes,}
1092 % \end{macrocode}
1093 %
1094 % \subsection{Footnotes}
1095 %
1096 % \begin{oldcomments}
1097 %
1098 % \footnote{NOTE} : User command to insert a footnote.
1099 %
1100 % \footnote[NUM]{NOTE}: User command to insert a footnote numbered
1101 % NUM, where NUM is a number -- 1, 2,
1102 % etc. For example, if footnotes are numbered
1103 % *, **, etc. within pages, then \footnote[2]{...}
1104 % produces footnote '**'. This command does not
1105 % step the footnote counter.
1106 %
1107 % \footnotemark[NUM] : Command to produce just the footnote mark in
1108 % the text, but no footnote. With no argument,
1109 % it steps the footnote counter before generating
1110 % the mark.
1111 %
1112 % \footnotetext[NUM]{TEXT} : Command to produce the footnote but
1113 % no mark. \footnote is equivalent to
1114 % \footnotemark \footnotetext .
1115 %
1116 % As in PLAIN, footnotes use \insert\footins, and the following
1117 % parameters:
1118 %
1119 % \footnotesize : Size-changing command for footnotes.
1120 %
1121 % \footnotesep : The height of a strut placed at the beginning of
1122 % every footnote.
1123 % \skip\footins : Space between main text and footnotes. The rule
1124 % separating footnotes from text occurs in this
1125 % space. This space lies above the strut of height
1126 % \footnotesep which is at the beginning of the
1127 % first footnote.
1128 % \footnoterule : Macro to draw the rule separating footnotes from
1129 % text. It is executed right after a \vspace of
1130 % \skip\footins. It should take zero vertical
1131 % space--i.e., it should to a negative skip to
1132 % compensate for any positive space it occupies.
1133 % (See PLAIN.TEX.)
1134 %
1135 % \interfootnotelinepenalty : Interline penalty for footnotes.
1136 %
1137 % \thefootnote : In usual LaTeX style, produces the footnote number.
1138 % If footnotes are to be numbered within pages, then
1139 % the document style file must include an \@addtoreset
1140 % command to cause the footnote counter to be reset
1141 % when the page counter is stepped. This is not a good
1142 % idea, though, because the counter will not always be
1143 % reset in time to ensure that the first footnote on a
1144 % page is footnote number one.
1145 %
1146 % \@thefnmark : Holds the current footnote's mark--e.g., \dag or '1'
1147 % or 'a'.
1148 %
1149 % \@mpfnnumber : A macro that generates the numbers for \footnote
1150 % and \footnotemark commands. It == \thefootnote
1151 % outside a minipage environment, but can be
1152 % changed inside to generate numbers for
1153 % \footnote's.
1154 %
1155 % \@makefnmark : A macro to generate the footnote marker from
1156 % \@thefnmark The default definition was
1157 % \hbox{$^\@thefnmark$}.
1158 %
1159 % This is now replaced by
1160 % \textsuperscript{\@thefnmark}
1161 %
1162 % \@makefntext{NOTE} :
1163 % Must produce the actual footnote, using \@thefnmark as the mark
1164 % of the footnote and NOTE as the text. It is called when
1165 % effectively inside a \parbox, with \hsize = \columnwidth.
1166 % For example, it might be as simple as
1167 % $^{\@thefnmark}$ NOTE
1168 %
1169 % In a minipage environment, \footnote and \footnotetext are redefined
1170 % so that
1171 % (a) they use the counter mpfootnote
1172 % (b) the footnotes they produce go at the bottom of the minipage.
1173 % The switch is accomplished by letting \@mpfn == footnote or mpfootnote
1174 % and \thempfn == \thefootnote or \thempfootnote, and by redefining
1175 % \@footnotetext to be \@mpfootnotetext in the minipage.
1176 %
1177 % \footnote{NOTE} ==
1178 % BEGIN
1179 % \stepcounter{\@mpfn}
1180 % begingroup
1181 % \protect == \noexpand
1182 % \@thefnmark :=G eval (\thempfn)
1183 % endgroup
1184 % \@footnotemark
1185 % \@footnotetext{NOTE}
1186 % END
1187 %
1188 % \footnote[NUM]{NOTE} ==
1189 % BEGIN
1190 % begingroup
1191 % \protect == \noexpand
1192 % counter \@mpfn :=L NUM
1193 % \@thefnmark :=G eval (\thempfn)
1194 % endgroup
1195 % \@footnotemark
1196 % \@footnotetext{NOTE}
1197 % END
1198 %
1199 % \footnotemark ==
1200 % BEGIN \stepcounter{footnote}
1201 % begingroup
1202 % \protect == \noexpand
1203 % \@thefnmark :=G eval(\thefootnote)
1204 % endgroup
1205 % \@footnotemark
1206 % END
1207 %
1208 % \footnotemark[NUM] ==
1209 % BEGIN
1210 % begingroup
1211 % footnote counter :=L NUM
1212 % \protect == \noexpand
1213 % \@thefnmark :=G eval(\thefootnote)
1214 % endgroup
1215 % \@footnotemark
1216 % END
1217 %
1218 % \@footnotemark ==
1219 % BEGIN
1220 % \leavevmode
1221 % IF hmode THEN \@x@sf := \the\spacefactor FI
1222 % \@makefnmark % put number in main text
1223 % IF hmode THEN \spacefactor := \@x@sf FI
1224 % END
1225 %
1226 % \footnotetext ==
1227 % BEGIN begingroup \protect == \noexpand
1228 % \@thefnmark :=G eval (\thempfn)
1229 % endgroup
1230 % \@footnotetext
1231 % END
1232 %
1233 % \footnotetext[NUM] ==
1234 % BEGIN begingroup counter \@mpfn :=L NUM
1235 % \protect == \noexpand
1236 % \@thefnmark :=G eval (\thempfn)
1237 % endgroup
1238 % \@footnotetext
1239 % END
1240 %
1241 % \end{oldcomments}
1242 %
1243 %
1244 % \changes{v1.1l}{1995/05/24}{Moved definition of \cs{footins}
1245 % and \cs{footnoterule} from ltplain.}
1246 %
1247 % \begin{macro}{\footins}
1248 % \LaTeX\ does use the same insert for footnotes as PLAIN.
1249 % \begin{macrocode}
1250 \newinsert\footins
1251 % \end{macrocode}
1252 %
1253 % \LaTeX\ leaves these initializations for the |\footins| insert.
1254 %
1255 % \begin{macrocode}
1256 \skip\footins=\bigskipamount % space added when footnote is present
1257 \count\footins=1000 % footnote magnification factor (1 to 1)
1258 \dimen\footins=8in % maximum footnotes per page
1259 % \end{macrocode}
1260 % \end{macro}
1261 %
1262 %
1263 % \begin{macro}{\footnoterule}
1264 % \LaTeX\ keeps PLAIN \TeX's |\footnoterule| as the default.
1265 %
1266 % \begin{macrocode}
1267 \def\footnoterule{\kern-3\p@
1268 \hrule \@width 2in \kern 2.6\p@} % the \hrule is .4pt high
1269 % \end{macrocode}
1270 % \end{macro}
1271 %
1272 % \begin{macro}{\thefootnote}
1273 % \changes{v1.1i}{1995/05/16}{Streamlined parts of code.}
1274 % \begin{macrocode}
1275 \@definecounter{footnote}
1276 \def\thefootnote{\@arabic\c@footnote}
1277 % \end{macrocode}
1278 % \end{macro}
1279 %
1280 % \begin{macro}{\thempfootnote}
1281 % \changes{v1.1j}{1995/05/18}{Added \cs{itshape}.}
1282 % \changes{v1.1v}{2002/10/01}{Use braces around \cs{itshape}
1283 % to keep font change local (pr/3460).}
1284 % The default display for the footnote counter in minipages is to
1285 % use italic letters. We use |\itshape| not |\textit| as the latter
1286 % would add an italic correction.
1287 % \begin{macrocode}
1288 \@definecounter{mpfootnote}
1289 \def\thempfootnote{{\itshape\@alph\c@mpfootnote}}
1290 % \end{macrocode}
1291 % \end{macro}
1292 %
1293 % \begin{macro}{\@makefnmark}
1294 % \changes{v1.1i}{1995/05/16}{Now use \cs{textsuperscript}.}
1295 % \changes{v1.1j}{1995/05/18}{Added \cs{normalfont}.}
1296 % \changes{v1.1k}{1995/05/20}{Moved \cs{normalfont} to
1297 % \cs{textsuperscript}}
1298 % \changes{v1.1k}{1995/05/20}{Moved \cs{normalfont} back
1299 % and use \cs{@textsuperscript}}
1300 % Default definition.
1301 % \begin{macrocode}
1302 %\def\@makefnmark{\hbox{$^{\@thefnmark}\m@th$}}
1303 \def\@makefnmark{\hbox{\@textsuperscript{\normalfont\@thefnmark}}}
1304 % \end{macrocode}
1305 % \end{macro}
1306 %
1307 % \begin{macro}{\textsuperscript}
1308 % \changes{v1.1i}{1995/05/16}{Command added./pr1503}
1309 % \changes{v1.1k}{1995/05/20}{Use \cs{normalfont}.}
1310 % \changes{v1.1l}{1995/05/24}{Use \cs{@textsuperscript}}
1311 % This command provides superscript characters in the current text
1312 % font. It's implementation might change!!!
1313 % \begin{macrocode}
1314 \DeclareRobustCommand*\textsuperscript[1]{%
1315 \@textsuperscript{\selectfont#1}}
1316 % \end{macrocode}
1317 % \end{macro}
1318 %
1319 % \begin{macro}{\@textsuperscript}
1320 % \changes{v1.1l}{1995/05/24}{Command added.}
1321 % \changes{v1.1n}{1995/12/05}{Use \cs{ensuremath} for latex/1984.}
1322 % \changes{v1.1m}{1995/12/07}
1323 % {Move \cs{m@th} out of the \cs{ensuremath} for latex/1984.}
1324 % This command should not be used directly, but may be used to define
1325 % other commands |\textsuperscript|, |\@makefnmark|. |#1| should
1326 % always start with a font selection command, to activate the font
1327 % size switch.
1328 % \begin{macrocode}
1329 \def\@textsuperscript#1{%
1330 {\m@th\ensuremath{^{\mbox{\fontsize\sf@size\z@#1}}}}}
1331 % \end{macrocode}
1332 % \end{macro}
1333 %
1334 % \begin{macro}{\textsubscript}
1335 % \changes{v1.2a}{2014/12/30}{Command added (latexrelease)}
1336 % \begin{macrocode}
1337 %</2ekernel>
1338 %<latexrelease>\IncludeInRelease{2015/01/01}%
1339 %<latexrelease> {\textsubscript}{\textsubscript}%
1340 %<*2ekernel|latexrelease>
1341 % \end{macrocode}
1342 %
1343 % \begin{macrocode}
1344 \DeclareRobustCommand*\textsubscript[1]{%
1345 \@textsubscript{\selectfont#1}}%
1346 % \end{macrocode}
1347 % \end{macro}
1348 %
1349 % \begin{macro}{\@textsubscript}
1350 % \changes{v1.2a}{2014/12/30}{Command added (latexrelease)}
1351 %
1352 % \begin{macrocode}
1353 \def\@textsubscript#1{%
1354 {\m@th\ensuremath{_{\mbox{\fontsize\sf@size\z@#1}}}}}%
1355 % \end{macrocode}
1356 % \end{macro}
1357 %
1358 % \begin{macrocode}
1359 %</2ekernel|latexrelease>
1360 %<latexrelease>\EndIncludeInRelease
1361 %<latexrelease>\IncludeInRelease{0000/00/00}%
1362 %<latexrelease> {\textsubscript}{\textsubscript}%
1363 %<latexrelease>\let\textsubscript\@undefined
1364 %<latexrelease>\let\@textsubscript\@undefined
1365 %<latexrelease>\EndIncludeInRelease
1366 %<*2ekernel>
1367 % \end{macrocode}
1368 %
1369 % \begin{macrocode}
1370 \def\@textsubscript#1{%
1371 {\m@th\ensuremath{_{\mbox{\fontsize\sf@size\z@#1}}}}}
1372 % \end{macrocode}
1373 %
1374 % \begin{macro}{\footnotesep}
1375 % \begin{macrocode}
1376 \newdimen\footnotesep
1377 % \end{macrocode}
1378 %
1379 % \end{macro}
1380 %
1381 % \begin{macro}{\footnote}
1382 % \changes{LaTeX2.09}{1991/11/01}
1383 % {(RmS) Added \cs{let}\cs{protect}\cs{noexpand} in
1384 % \cs{footnote}, \cs{footnotemark},
1385 % and \cs{footnotetext}, since \cs{xdef} is used}
1386 % \changes{LaTeX2.09}{1991/11/22}
1387 % {(RmS) Added \cs{let}\cs{protect}\cs{noexpand} in
1388 % \cs{@xfootnote}, \cs{@xfootnotemark},
1389 % and \cs{@xfootnotetext}}
1390 % \changes{LaTeX2.09}{1992/11/26}
1391 % {(RmS) Changed all to
1392 % `def`protect\string{`noexpand`protect`noexpand\string}}
1393 % \changes{v1.1b}{1994/11/26}
1394 % {(ASAJ) Added \cs{protected@xdef}.}
1395 %
1396 % \begin{macrocode}
1397 \def\footnote{\@ifnextchar[\@xfootnote{\stepcounter\@mpfn
1398 \protected@xdef\@thefnmark{\thempfn}%
1399 \@footnotemark\@footnotetext}}
1400 % \end{macrocode}
1401 % \end{macro}
1402 %
1403 % \begin{macro}{\@xfootnote}
1404 % \begin{macrocode}
1405 \def\@xfootnote[#1]{%
1406 \begingroup
1407 \csname c@\@mpfn\endcsname #1\relax
1408 \unrestored@protected@xdef\@thefnmark{\thempfn}%
1409 \endgroup
1410 \@footnotemark\@footnotetext}
1411 % \end{macrocode}
1412 % \end{macro}
1413 %
1414 % \begin{macro}{\@footnotetext}
1415 % \changes{LaTeX2.09}{1991/09/29}
1416 % {(RmS) added \cs{reset@font}}
1417 % \changes{LaTeX2.09}{1992/11/26}
1418 % {(RmS) added protection for \cs{edef}}
1419 % \changes{v1.0a}{1994/03/07}
1420 % {(DPC) Extra group for colour}
1421 % \changes{v1.0c}{1994/03/14}
1422 % {(DPC) Use \cs{color@begingroup}, add \cs{endgraf}}
1423 % \changes{v1.0d}{1994/04/18}
1424 % {(DPC) Remove Colour support}
1425 % \changes{v1.0g}{1994/05/13}
1426 % {(DPC) Add new style colour support: \cs{normalcolor}}
1427 % \changes{v1.0g}{1994/05/13}
1428 % {(DPC) Use \cs{@finalstrut}}
1429 % \changes{v1.1a}{1994/10/31}
1430 % {(DPC/CAR) Move colour setting to output routine}
1431 % \changes{v1.1b}{1994/11/04}
1432 % {(ASAJ) Added \cs{protected@edef}.}
1433 % \changes{v1.1c}{1994/11/05}
1434 % {Removed \cs{normalcolor} (again)}
1435 % \changes{v1.1t}{1997/11/19}
1436 % {Missing percent, again}
1437 % \begin{macrocode}
1438 \long\def\@footnotetext#1{\insert\footins{%
1439 \reset@font\footnotesize
1440 \interlinepenalty\interfootnotelinepenalty
1441 \splittopskip\footnotesep
1442 \splitmaxdepth \dp\strutbox \floatingpenalty \@MM
1443 \hsize\columnwidth \@parboxrestore
1444 \protected@edef\@currentlabel{%
1445 \csname p@footnote\endcsname\@thefnmark
1446 }%
1447 \color@begingroup
1448 \@makefntext{%
1449 \rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}%
1450 \color@endgroup}}%
1451 % \end{macrocode}
1452 % \end{macro}
1453 %
1454 % \begin{macro}{\footnotemark}
1455 % \changes{v1.1b}{1994/11/04}{Added \cs{protected@xdef} to
1456 % \cs{footnotemark}.}
1457 % \begin{macrocode}
1458 \def\footnotemark{%
1459 \@ifnextchar[\@xfootnotemark
1460 {\stepcounter{footnote}%
1461 \protected@xdef\@thefnmark{\thefootnote}%
1462 \@footnotemark}}
1463 % \end{macrocode}
1464 % \end{macro}
1465 %
1466 % \begin{macro}{\@xfootnotemark}
1467 % \begin{macrocode}
1468 \def\@xfootnotemark[#1]{%
1469 \begingroup
1470 \c@footnote #1\relax
1471 \unrestored@protected@xdef\@thefnmark{\thefootnote}%
1472 \endgroup
1473 \@footnotemark}
1474 % \end{macrocode}
1475 % \end{macro}
1476 %
1477 % \begin{macro}{\@footnotemark}
1478 % \changes{v1.1h}{1995/05/12}
1479 % {Add \cs{nobreak} to allow hyphenation. latex/1605}
1480 % \begin{macrocode}
1481 \def\@footnotemark{%
1482 \leavevmode
1483 \ifhmode\edef\@x@sf{\the\spacefactor}\nobreak\fi
1484 \@makefnmark
1485 \ifhmode\spacefactor\@x@sf\fi
1486 \relax}
1487 % \end{macrocode}
1488 % \end{macro}
1489 %
1490 % \begin{macro}{\footnotetext}
1491 % \begin{macrocode}
1492 \def\footnotetext{%
1493 \@ifnextchar [\@xfootnotenext
1494 {\protected@xdef\@thefnmark{\thempfn}%
1495 \@footnotetext}}
1496 % \end{macrocode}
1497 % \end{macro}
1498 %
1499 % \begin{macro}{\@xfootnotenext}
1500 % \begin{macrocode}
1501 \def\@xfootnotenext[#1]{%
1502 \begingroup
1503 \csname c@\@mpfn\endcsname #1\relax
1504 \unrestored@protected@xdef\@thefnmark{\thempfn}%
1505 \endgroup
1506 \@footnotetext}
1507 % \end{macrocode}
1508 % \end{macro}
1509 %
1510 % \begin{macro}{\thempfn}
1511 % \begin{macro}{\@mpfn}
1512 % \begin{macrocode}
1513 \def\@mpfn{footnote}
1514 \def\thempfn{\thefootnote}
1515 %</2ekernel>
1516 % \end{macrocode}
1517 % \end{macro}
1518 % \end{macro}
1519 %
1520 % \Finale
1521 %