1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2004-02-09.15}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 % Boston, MA 02111-1307, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexnoindent=\noindent
93 \let\ptexinsert=\insert
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % In some macros, we cannot use the `\? notation---the left quote is
156 % in some cases the escape char.
157 \chardef\colonChar = `\:
158 \chardef\commaChar = `\,
159 \chardef\dotChar = `\.
160 \chardef\exclamChar= `\!
161 \chardef\questChar = `\?
162 \chardef\semiChar = `\;
163 \chardef\underChar = `\_
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
177 \hyphenation{ap-pen-dix}
179 \hyphenation{mini-buf-fer mini-buf-fers}
180 \hyphenation{time-stamp}
181 \hyphenation{white-space}
183 % Margin to add to right of even pages, to left of odd pages.
184 \newdimen\bindingoffset
185 \newdimen\normaloffset
186 \newdimen\pagewidth \newdimen\pageheight
188 % For a final copy, take out the rectangles
189 % that mark overfull boxes (in case you have decided
190 % that the text looks ok even though it passes the margin).
192 \def\finalout{\overfullrule=0pt}
194 % @| inserts a changebar to the left of the current line. It should
195 % surround any changed text. This approach does *not* work if the
196 % change spans more than two lines of output. To handle that, we would
197 % have adopt a much more difficult approach (putting marks into the main
198 % vertical list for the beginning and end of each change).
201 % \vadjust can only be used in horizontal mode.
204 % Append this vertical mode material after the current line in the output.
206 % We want to insert a rule with the height and depth of the current
207 % leading; that is exactly what \strutbox is supposed to record.
210 % \vadjust-items are inserted at the left edge of the type. So
211 % the \llap here moves out into the left-hand margin.
214 % For a thicker or thinner bar, change the `1pt'.
215 \vrule height\baselineskip width1pt
217 % This is the space between the bar and the text.
223 % Sometimes it is convenient to have everything in the transcript file
224 % and nothing on the terminal. We don't just call \tracingall here,
225 % since that produces some useless output on the terminal. We also make
226 % some effort to order the tracing commands to reduce output in the log
227 % file; cf. trace.sty in LaTeX.
229 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
233 \tracinglostchars2 % 2 gives us more in etex
238 \showboxbreadth\maxdimen \showboxdepth\maxdimen
239 \ifx\eTeXversion\undefined\else % etex gives us more logging
246 \tracingcommands3 % 3 gives us more in etex
250 % add check for \lastpenalty to plain's definitions. If the last thing
251 % we did was a \nobreak, we don't want to insert more space.
253 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
254 \removelastskip\penalty-50\smallskip\fi\fi}
255 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
256 \removelastskip\penalty-100\medskip\fi\fi}
257 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
258 \removelastskip\penalty-200\bigskip\fi\fi}
260 % For @cropmarks command.
261 % Do @cropmarks to get crop marks.
264 \let\cropmarks = \cropmarkstrue
266 % Dimensions to add cropmarks at corners.
267 % Added by P. A. MacKay, 12 Nov. 1986
269 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
270 \newdimen\cornerlong \cornerlong=1pc
271 \newdimen\cornerthick \cornerthick=.3pt
272 \newdimen\topandbottommargin \topandbottommargin=.75in
274 % Main output routine.
276 \output = {\onepageout{\pagecontents\PAGE}}
281 % \onepageout takes a vbox as an argument. Note that \pagecontents
282 % does insertions, but you have to call it yourself.
284 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
286 \ifodd\pageno \advance\hoffset by \bindingoffset
287 \else \advance\hoffset by -\bindingoffset\fi
289 % Do this outside of the \shipout so @code etc. will be expanded in
290 % the headline as they should be, not taken literally (outputting ''code).
291 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
292 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
295 % Have to do this stuff outside the \shipout because we want it to
296 % take effect in \write's, yet the group defined by the \vbox ends
297 % before the \shipout runs.
299 \escapechar = `\\ % use backslash in output files.
300 \indexdummies % don't expand commands in the output.
301 \normalturnoffactive % \ in index entries must not stay \, e.g., if
302 % the page break happens to be in the middle of an example.
304 % Do this early so pdf references go to the beginning of the page.
305 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
307 \ifcropmarks \vbox to \outervsize\bgroup
309 \vskip-\topandbottommargin
311 \line{\ewtop\hfil\ewtop}%
314 \vbox{\moveleft\cornerthick\nstop}%
316 \vbox{\moveright\cornerthick\nstop}%
319 \vskip\topandbottommargin
321 \hfil % center the page within the outer (page) hsize.
322 \ifodd\pageno\hskip\bindingoffset\fi
328 \ifdim\ht\footlinebox > 0pt
329 % Only leave this space if the footline is nonempty.
330 % (We lessened \vsize for it in \oddfootingxxx.)
331 % The \baselineskip=24pt in plain's \makefootline has no effect.
332 \vskip 2\baselineskip
337 \egroup % end of \vbox\bgroup
338 \hfil\egroup % end of (centering) \line\bgroup
339 \vskip\topandbottommargin plus1fill minus1fill
340 \boxmaxdepth = \cornerthick
343 \vbox{\moveleft\cornerthick\nsbot}%
345 \vbox{\moveright\cornerthick\nsbot}%
348 \line{\ewbot\hfil\ewbot}%
350 \egroup % \vbox from first cropmarks clause
352 }% end of \shipout\vbox
353 }% end of group with \normalturnoffactive
355 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 \newinsert\margin \dimen\margin=\maxdimen
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
362 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363 % marginal hacks, juha@viisa.uucp (Juha Takala)
364 \ifvoid\margin\else % marginal info is present
365 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366 \dimen@=\dp#1 \unvbox#1
367 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 % Here are the rules for the cropmarks. Note that they are
372 % offset so that the space between them is truly \outerhsize or \outervsize
373 % (P. A. MacKay, 12 November, 1986)
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
377 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
380 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
382 % Parse an argument, then pass it to #1. The argument is the rest of
383 % the input line (except we remove a trailing comment). #1 should be a
384 % macro which expects an ordinary undelimited TeX argument.
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
393 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
397 \gdef\parseargline#1^^M{%
398 \endgroup % End of the group started in \parsearg.
399 \argremovecomment #1\comment\ArgTerm%
403 % First remove any @comment, then any @c comment.
404 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
407 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
409 % \argremovec might leave us with trailing space, e.g.,
410 % @end itemize @c foo
411 % This space token undergoes the same procedure and is eventually removed
412 % by \finishparsearg.
414 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
419 % We cannot use \next here, as it holds the macro to run;
420 % thus we reuse \temp.
421 \let\temp\finishparsearg
423 \let\temp\argcheckspaces
425 % Put the space token in:
429 % If a _delimited_ argument is enclosed in braces, they get stripped; so
430 % to get _exactly_ the rest of the line, we had to prevent such situation.
431 % We prepended an \empty token at the very beginning and we expand it now,
432 % just before passing the control to \next.
433 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
434 % either the null string, or it ends with \^^M---thus there is no danger
435 % that a pair of braces would be stripped.
437 % But first, we have to remove the trailing space token.
439 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
441 % \parseargdef\foo{...}
442 % is roughly equivalent to
443 % \def\foo{\parsearg\Xfoo}
446 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
447 % favourite TeX trick. --kasal, 16nov03
450 \expandafter \doparseargdef \csname\string#1\endcsname #1%
452 \def\doparseargdef#1#2{%
457 % Several utility definitions with active space:
462 % Make each space character in the input produce a normal interword
463 % space in the output. Don't allow a line break at this space, as this
464 % is used only in environments like @example, where each line of input
465 % should produce a line of output anyway.
467 \gdef\sepspaces{\obeyspaces\let =\tie}
469 % If an index command is used in an @example environment, any spaces
470 % therein should become regular spaces in the raw index file, not the
471 % expansion of \tie (\leavevmode \penalty \@M \ ).
472 \gdef\unsepspaces{\let =\space}
476 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
478 % Define the framework for environments in texinfo.tex. It's used like this:
483 % It's the responsibility of \envdef to insert \begingroup before the
484 % actual body; @end closes the group after calling \Efoo. \envdef also
485 % defines \thisenv, so the current environment is known; @end checks
486 % whether the environment name matches. The \checkenv macro can also be
487 % used to check whether the current environment is the one expected.
489 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
490 % are not treated as enviroments; they don't open a group. (The
491 % implementation of @end takes care not to call \endgroup in this
495 % At runtime, environments start with this:
496 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
500 % ... but they get defined via ``\envdef\foo{...}'':
501 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
502 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
504 % Check whether we're in the right environment:
513 % Evironment mismatch, #1 expected:
516 \errmessage{This command can appear only \inenvironment\temp,
517 not \inenvironment\thisenv}%
519 \def\inenvironment#1{%
521 out of any environment%
523 in environment \expandafter\string#1%
527 % @end foo executes the definition of \Efoo.
528 % But first, it executes a specialized version of \checkenv
531 \if 1\csname iscond.#1\endcsname
533 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
534 \expandafter\checkenv\csname#1\endcsname
535 \csname E#1\endcsname
540 \newhelp\EMsimple{Press RETURN to continue.}
543 %% Simple single-character @ commands
546 % Kludge this until the fonts are right (grr).
549 % This is turned off because it was never documented
550 % and you can use @w{...} around a quote to suppress ligatures.
551 %% Define @` and @' to be the same as ` and '
552 %% but suppressing ligatures.
556 % Used to generate quoted braces.
557 \def\mylbrace {{\tt\char123}}
558 \def\myrbrace {{\tt\char125}}
562 % Definitions to produce \{ and \} commands for indices,
563 % and @{ and @} for the aux file.
564 \catcode`\{ = \other \catcode`\} = \other
565 \catcode`\[ = 1 \catcode`\] = 2
566 \catcode`\! = 0 \catcode`\\ = \other
569 !gdef!lbraceatcmd[@{]%
570 !gdef!rbraceatcmd[@}]%
573 % @comma{} to avoid , parsing problems.
576 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
577 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
580 \def\ringaccent#1{{\accent23 #1}}
585 % Other special characters: @questiondown @exclamdown @ordf @ordm
586 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
587 \def\questiondown{?`}
589 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
590 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
592 % Dotless i and dotless j, used for accents.
597 \ifx\temp\imacro \ptexi
598 \else\ifx\temp\jmacro \j
599 \else \errmessage{@dotless can be used only with i or j}%
603 % The \TeX{} logo, as in plain, but resetting the spacing so that a
604 % period following counts as ending a sentence. (Idea found in latex.)
606 \edef\TeX{\TeX \spacefactor=3000 }
608 % @LaTeX{} logo. Not quite the same results as the definition in
609 % latex.ltx, since we use a different font for the raised A; it's most
610 % convenient for us to use an explicitly smaller font, rather than using
611 % the \scriptstyle font (since we don't reset \scriptstyle and
612 % \scriptscriptstyle).
617 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
622 % Be sure we're in horizontal mode when doing a tie, since we make space
623 % equivalent to this in @example-like environments. Otherwise, a space
624 % at the beginning of a line will start with \penalty -- and
625 % since \penalty is valid in vertical mode, we'd end up putting the
626 % penalty on the vertical list instead of in the new paragraph.
628 % Avoid using \@M directly, because that causes trouble
629 % if the definition is written into an index file.
630 \global\let\tiepenalty = \@M
631 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
634 % @: forces normal size whitespace following.
635 \def\:{\spacefactor=1000 }
637 % @* forces a line break.
638 \def\*{\hfil\break\hbox{}\ignorespaces}
640 % @/ allows a line break.
643 % @. is an end-of-sentence period.
644 \def\.{.\spacefactor=3000 }
646 % @! is an end-of-sentence bang.
647 \def\!{!\spacefactor=3000 }
649 % @? is an end-of-sentence query.
650 \def\?{?\spacefactor=3000 }
652 % @w prevents a word break. Without the \leavevmode, @w at the
653 % beginning of a paragraph, when TeX is still in vertical mode, would
654 % produce a whole line of output instead of starting the paragraph.
655 \def\w#1{\leavevmode\hbox{#1}}
657 % @group ... @end group forces ... to be all on one page, by enclosing
658 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
659 % to keep its height that of a normal line. According to the rules for
660 % \topskip (p.114 of the TeXbook), the glue inserted is
661 % max (\topskip - \ht (first item), 0). If that height is large,
662 % therefore, no glue is inserted, and the space between the headline and
663 % the text is small, which looks bad.
665 % Another complication is that the group might be very large. This can
666 % cause the glue on the previous page to be unduly stretched, because it
667 % does not have much material. In this case, it's better to add an
668 % explicit \vfill so that the extra space is at the bottom. The
669 % threshold for doing this is if the group is more than \vfilllimit
670 % percent of a page (\vfilllimit can be changed inside of @tex).
676 \ifnum\catcode`\^^M=\active \else
677 \errhelp = \groupinvalidhelp
678 \errmessage{@group invalid in context where filling is enabled}%
682 \setbox\groupbox = \vtop\bgroup
683 % Do @comment since we are called inside an environment such as
684 % @example, where each end-of-line in the input causes an
685 % end-of-line in the output. We don't want the end-of-line after
686 % the `@group' to put extra space in the output. Since @group
687 % should appear on a line by itself (according to the Texinfo
688 % manual), we don't worry about eating any user text.
692 % The \vtop produces a box with normal height and large depth; thus, TeX puts
693 % \baselineskip glue before it, and (when the next line of text is done)
694 % \lineskip glue after it. Thus, space below is not quite equal to space
695 % above. But it's pretty close.
697 % To get correct interline space between the last line of the group
698 % and the first line afterwards, we have to propagate \prevdepth.
699 \endgraf % Not \par, as it may have been set to \lisppar.
700 \global\dimen1 = \prevdepth
701 \egroup % End the \vtop.
702 % \dimen0 is the vertical size of the group's box.
703 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
704 % \dimen2 is how much space is left on the page (more or less).
705 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
706 % if the group doesn't fit on the current page, and it's a big big
707 % group, force a page break.
708 \ifdim \dimen0 > \dimen2
709 \ifdim \pagetotal < \vfilllimit\pageheight
718 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
719 % message, so this ends up printing `@group can only ...'.
721 \newhelp\groupinvalidhelp{%
722 group can only be used in environments such as @example,^^J%
723 where each line of input produces a line of output.}
725 % @need space-in-mils
726 % forces a page break if there is not space-in-mils remaining.
728 \newdimen\mil \mil=0.001in
730 % Old definition--didn't work.
731 %\parseargdef\need{\par %
732 %% This method tries to make TeX break the page naturally
733 %% if the depth of the box does not fit.
735 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
740 % Ensure vertical mode, so we don't make a big box in the middle of a
744 % If the @need value is less than one line space, it's useless.
746 \dimen2 = \ht\strutbox
747 \advance\dimen2 by \dp\strutbox
748 \ifdim\dimen0 > \dimen2
750 % Do a \strut just to make the height of this box be normal, so the
751 % normal leading is inserted relative to the preceding line.
752 % And a page break here is fine.
753 \vtop to #1\mil{\strut\vfil}%
755 % TeX does not even consider page breaks if a penalty added to the
756 % main vertical list is 10000 or more. But in order to see if the
757 % empty box we just added fits on the page, we must make it consider
758 % page breaks. On the other hand, we don't want to actually break the
759 % page after the empty box. So we use a penalty of 9999.
761 % There is an extremely small chance that TeX will actually break the
762 % page at this \penalty, if there are no other feasible breakpoints in
763 % sight. (If the user is using lots of big @group commands, which
764 % almost-but-not-quite fill up a page, TeX will have a hard time doing
765 % good page breaking, for example.) However, I could not construct an
766 % example where a page broke at this \penalty; if it happens in a real
767 % document, then we can reconsider our strategy.
770 % Back up by the size of the box, whether we did a page break or not.
773 % Do not allow a page break right after this kern.
778 % @br forces paragraph break (and is undocumented).
782 % @page forces the start of a new page.
784 \def\page{\par\vfill\supereject}
787 % outputs text on separate line in roman font, starting at standard page margin
789 % This records the amount of indent in the innermost environment.
790 % That's how much \exdent should take out.
791 \newskip\exdentamount
793 % This defn is used inside fill environments such as @defun.
794 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
796 % This defn is used inside nofill environments such as @example.
797 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
798 \leftline{\hskip\leftskip{\rm#1}}}}
800 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
801 % paragraph. For more general purposes, use the \margin insertion
802 % class. WHICH is `l' or `r'.
804 \newskip\inmarginspacing \inmarginspacing=1cm
805 \def\strutdepth{\dp\strutbox}
807 \def\doinmargin#1#2{\strut\vadjust{%
810 \vtop to \strutdepth{%
811 \baselineskip=\strutdepth
813 % if you have multiple lines of stuff to put here, you'll need to
814 % make the vbox yourself of the appropriate size.
816 \llap{\ignorespaces #2\hskip\inmarginspacing}%
818 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
823 \def\inleftmargin{\doinmargin l}
824 \def\inrightmargin{\doinmargin r}
826 % @inmargin{TEXT [, RIGHT-TEXT]}
827 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
828 % else use TEXT for both).
830 \def\inmargin#1{\parseinmargin #1,,\finish}
831 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
832 \setbox0 = \hbox{\ignorespaces #2}%
834 \def\lefttext{#1}% have both texts
837 \def\lefttext{#1}% have only one text
842 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
844 \def\temp{\inleftmargin\lefttext}%
849 % @include file insert text of that file as input.
851 \def\include{\parseargusing\filenamecatcodes\includezzz}
857 \def\temp{\input #1 }%
862 \def\filenamecatcodes{%
874 \def\pushthisfilestack{%
875 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
877 \def\pushthisfilestackX{%
878 \expandafter\pushthisfilestackY\thisfile\StackTerm
880 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
881 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
884 \def\popthisfilestack{\errthisfilestackempty}
885 \def\errthisfilestackempty{\errmessage{Internal error:
886 the stack of filenames is empty.}}
891 % outputs that line, centered.
893 \parseargdef\center{%
899 \next{\hfil \ignorespaces#1\unskip \hfil}%
904 \advance\hsize by -\leftskip
905 \advance\hsize by -\rightskip
910 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
912 % @sp n outputs n lines of vertical space
914 \parseargdef\sp{\vskip #1\baselineskip}
916 % @comment ...line which is ignored...
917 % @c is the same as @comment
918 % @ignore ... @end ignore is another way to write a comment
920 \def\comment{\begingroup \catcode`\^^M=\other%
921 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
923 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
927 % @paragraphindent NCHARS
928 % We'll use ems for NCHARS, close enough.
929 % NCHARS can also be the word `asis' or `none'.
930 % We cannot feasibly implement @paragraphindent asis, though.
932 \def\asisword{asis} % no translation, these are keywords
935 \parseargdef\paragraphindent{%
940 \defaultparindent = 0pt
942 \defaultparindent = #1em
945 \parindent = \defaultparindent
948 % @exampleindent NCHARS
949 % We'll use ems for NCHARS like @paragraphindent.
950 % It seems @exampleindent asis isn't necessary, but
951 % I preserve it to make it similar to @paragraphindent.
952 \parseargdef\exampleindent{%
959 \lispnarrowing = #1em
964 % @firstparagraphindent WORD
965 % If WORD is `none', then suppress indentation of the first paragraph
966 % after a section heading. If WORD is `insert', then do indent at such
969 % The paragraph indentation is suppressed or not by calling
970 % \suppressfirstparagraphindent, which the sectioning commands do.
971 % We switch the definition of this back and forth according to WORD.
972 % By default, we suppress indentation.
974 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
975 \newdimen\currentparindent
977 \def\insertword{insert}
979 \parseargdef\firstparagraphindent{%
982 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
983 \else\ifx\temp\insertword
984 \let\suppressfirstparagraphindent = \relax
987 \errmessage{Unknown @firstparagraphindent option `\temp'}%
991 % Here is how we actually suppress indentation. Redefine \everypar to
992 % \kern backwards by \parindent, and then reset itself to empty.
994 % We also make \indent itself not actually do anything until the next
997 \gdef\dosuppressfirstparagraphindent{%
999 \restorefirstparagraphindent
1003 \restorefirstparagraphindent
1006 \global\everypar = {%
1008 \restorefirstparagraphindent
1012 \gdef\restorefirstparagraphindent{%
1013 \global \let \indent = \ptexindent
1014 \global \let \noindent = \ptexnoindent
1015 \global \everypar = {}%
1019 % @asis just yields its argument. Used with @table, for example.
1023 % @math outputs its argument in math mode.
1025 % One complication: _ usually means subscripts, but it could also mean
1026 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1027 % _ active, and distinguish by seeing if the current family is \slfam,
1028 % which is what @var uses.
1030 \catcode\underChar = \active
1031 \gdef\mathunderscore{%
1032 \catcode\underChar=\active
1033 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1036 % Another complication: we want \\ (and @\) to output a \ character.
1037 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1038 % this is not advertised and we don't care. Texinfo does not
1039 % otherwise define @\.
1041 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1042 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1047 \let\\ = \mathbackslash
1051 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1053 % Some active characters (such as <) are spaced differently in math.
1054 % We have to reset their definitions in case the @math was an argument
1055 % to a command which sets the catcodes (such as @item or @section).
1058 \catcode`^ = \active
1059 \catcode`< = \active
1060 \catcode`> = \active
1061 \catcode`+ = \active
1070 % @bullet and @minus need the same treatment as @math, just above.
1071 \def\bullet{$\ptexbullet$}
1074 % @dots{} outputs an ellipsis using the current font.
1075 % We do .5em per period so that it has the same spacing in a typewriter
1076 % font as three actual period characters.
1081 \hskip 0pt plus 0.25fil
1083 \hskip 0pt plus 0.5fil
1087 % @enddots{} is an end-of-sentence ellipsis.
1094 % @comma{} is so commas can be inserted into text without messing up
1095 % Texinfo's parsing.
1099 % @refill is a no-op.
1102 % If working on a large document in chapters, it is convenient to
1103 % be able to disable indexing, cross-referencing, and contents, for test runs.
1104 % This is done with @novalidate (before @setfilename).
1106 \newif\iflinks \linkstrue % by default we want the aux files.
1107 \let\novalidate = \linksfalse
1109 % @setfilename is done at the beginning of every texinfo file.
1110 % So open here the files we need to have open while reading the input.
1111 % This makes it possible to make a .fmt file for texinfo.
1113 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1116 % Open the new aux file. TeX will close it automatically at exit.
1117 \immediate\openout\auxfile=\jobname.aux
1118 \fi % \openindices needs to do some work in any case.
1120 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1122 % If texinfo.cnf is present on the system, read it.
1123 % Useful for site-wide @afourpaper, etc.
1124 \openin 1 texinfo.cnf
1125 \ifeof 1 \else \input texinfo.cnf \fi
1128 \comment % Ignore the actual filename.
1131 % Called from \setfilename.
1143 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1147 % adobe `portable' document format
1151 \newcount\filenamelength
1160 \newif\ifpdfmakepagedest
1162 \ifx\pdfoutput\undefined
1164 \let\pdfmkdest = \gobble
1165 \let\pdfurl = \gobble
1166 \let\endlink = \relax
1167 \let\linkcolor = \relax
1168 \let\pdfmakeoutlines = \relax
1173 \pdfcatalog{/PageMode /UseOutlines}%
1174 \def\dopdfimage#1#2#3{%
1175 \def\imagewidth{#2}%
1176 \def\imageheight{#3}%
1177 % without \immediate, pdftex seg faults when the same image is
1178 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1179 \ifnum\pdftexversion < 14
1182 \immediate\pdfximage
1184 \ifx\empty\imagewidth\else width \imagewidth \fi
1185 \ifx\empty\imageheight\else height \imageheight \fi
1186 \ifnum\pdftexversion<13
1191 \ifnum\pdftexversion < 14 \else
1192 \pdfrefximage \pdflastximage
1195 % We have to set dummies so commands such as @code in a section title
1198 \normalturnoffactive
1199 \pdfdest name{#1} xyz%
1202 \let\linkcolor = \Blue % was Cyan, but that seems light?
1203 \def\endlink{\Black\pdfendlink}
1204 % Adding outlines to PDF; macros for calculating structure of outlines
1205 % come from Petr Olsak
1206 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1207 \else \csname#1\endcsname \fi}
1208 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1209 \advance\tempnum by 1
1210 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1212 % #1 is the section text. #2 is the pdf expression for the number
1213 % of subentries (or empty, for subsubsections). #3 is the node
1214 % text, which might be empty if this toc entry had no
1215 % corresponding node. #4 is the page number.
1217 \def\dopdfoutline#1#2#3#4{%
1218 % Generate a link to the node text if that exists; else, use the
1219 % page number. We could generate a destination for the section
1220 % text in the case where a section has no node, but it doesn't
1221 % seem worthwhile, since most documents are normally structured.
1222 \def\pdfoutlinedest{#3}%
1223 \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1225 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1228 \def\pdfmakeoutlines{%
1230 % Thanh's hack / proper braces in bookmarks
1231 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1232 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1234 % Read toc silently, to get counts of subentries for \pdfoutline.
1235 \def\numchapentry##1##2##3##4{%
1236 \def\thischapnum{##2}%
1237 \let\thissecnum\empty
1238 \let\thissubsecnum\empty
1240 \def\numsecentry##1##2##3##4{%
1241 \advancenumber{chap\thischapnum}%
1242 \def\thissecnum{##2}%
1243 \let\thissubsecnum\empty
1245 \def\numsubsecentry##1##2##3##4{%
1246 \advancenumber{sec\thissecnum}%
1247 \def\thissubsecnum{##2}%
1249 \def\numsubsubsecentry##1##2##3##4{%
1250 \advancenumber{subsec\thissubsecnum}%
1252 \let\thischapnum\empty
1253 \let\thissecnum\empty
1254 \let\thissubsecnum\empty
1256 % use \def rather than \let here because we redefine \chapentry et
1257 % al. a second time, below.
1258 \def\appentry{\numchapentry}%
1259 \def\appsecentry{\numsecentry}%
1260 \def\appsubsecentry{\numsubsecentry}%
1261 \def\appsubsubsecentry{\numsubsubsecentry}%
1262 \def\unnchapentry{\numchapentry}%
1263 \def\unnsecentry{\numsecentry}%
1264 \def\unnsubsecentry{\numsubsecentry}%
1265 \def\unnsubsubsecentry{\numsubsubsecentry}%
1268 % Read toc second time, this time actually producing the outlines.
1269 % The `-' means take the \expnumber as the absolute number of
1270 % subentries, which we calculated on our first read of the .toc above.
1272 % We use the node names as the destinations.
1273 \def\numchapentry##1##2##3##4{%
1274 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1275 \def\numsecentry##1##2##3##4{%
1276 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1277 \def\numsubsecentry##1##2##3##4{%
1278 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1279 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1280 \dopdfoutline{##1}{}{##3}{##4}}%
1282 % PDF outlines are displayed using system fonts, instead of
1283 % document fonts. Therefore we cannot use special characters,
1284 % since the encoding is unknown. For example, the eogonek from
1285 % Latin 2 (0xea) gets translated to a | character. Info from
1286 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1288 % xx to do this right, we have to translate 8-bit characters to
1289 % their "best" equivalent, based on the @documentencoding. Right
1290 % now, I guess we'll just let the pdf reader have its way.
1297 \def\makelinks #1,{%
1298 \def\params{#1}\def\E{END}%
1300 \let\nextmakelinks=\relax
1302 \let\nextmakelinks=\makelinks
1303 \ifnum\lnkcount>0,\fi
1305 \startlink attr{/Border [0 0 0]}
1306 goto name{\pdfmkpgn{\the\pgn}}%
1308 \advance\lnkcount by 1%
1313 \def\picknum#1{\expandafter\pn#1}
1324 \def\ppn#1{\pgn=#1\gobble}
1325 \def\ppnn{\pgn=\first}
1326 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1327 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1328 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1329 \ifx\PP\D\let\nextsp\relax
1330 \else\let\nextsp\skipspaces
1331 \ifx\p\space\else\addtokens{\filename}{\PP}%
1332 \advance\filenamelength by 1
1336 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1337 \ifnum\pdftexversion < 14
1338 \let \startlink \pdfannotlink
1340 \let \startlink \pdfstartlink
1344 \normalturnoffactive\def\@{@}%
1345 \makevalueexpandable
1347 \startlink attr{/Border [0 0 0]}%
1348 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1351 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1352 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1353 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1354 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1356 \expandafter\poptoks\the\toksA|ENDTOKS|
1358 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1359 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1360 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1362 \ifnum0=\countA\else\makelink\fi
1363 \ifx\first.\let\next=\done\else
1365 \addtokens{\toksB}{\the\toksD}
1366 \ifx\first,\addtokens{\toksB}{\space}\fi
1368 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1370 \def\makelink{\addtokens{\toksB}%
1371 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1373 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1374 \linkcolor #1\endlink}
1375 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1376 \fi % \ifx\pdfoutput
1381 % Change the current font style to #1, remembering it in \curfontstyle.
1382 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1383 % italics, not bold italics.
1385 \def\setfontstyle#1{%
1386 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1387 \csname ten#1\endcsname % change the current font
1390 % Select #1 fonts with the current style.
1392 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1394 \def\rm{\fam=0 \setfontstyle{rm}}
1395 \def\it{\fam=\itfam \setfontstyle{it}}
1396 \def\sl{\fam=\slfam \setfontstyle{sl}}
1397 \def\bf{\fam=\bffam \setfontstyle{bf}}
1398 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1400 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1401 % So we set up a \sf.
1403 \def\sf{\fam=\sffam \setfontstyle{sf}}
1404 \let\li = \sf % Sometimes we call it \li, not \sf.
1406 % We don't need math for this font style.
1407 \def\ttsl{\setfontstyle{ttsl}}
1410 \newdimen\textleading \textleading = 13.2pt
1412 % Set the baselineskip to #1, and the lineskip and strut size
1413 % correspondingly. There is no deep meaning behind these magic numbers
1414 % used as factors; they just match (closely enough) what Knuth defined.
1416 \def\lineskipfactor{.08333}
1417 \def\strutheightpercent{.70833}
1418 \def\strutdepthpercent {.29167}
1421 \normalbaselineskip = #1\relax
1422 \normallineskip = \lineskipfactor\normalbaselineskip
1424 \setbox\strutbox =\hbox{%
1425 \vrule width0pt height\strutheightpercent\baselineskip
1426 depth \strutdepthpercent \baselineskip
1430 % Set the font macro #1 to the font named #2, adding on the
1431 % specified font prefix (normally `cm').
1432 % #3 is the font's design size, #4 is a scale factor
1433 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1435 % Use cm as the default font prefix.
1436 % To specify the font prefix, you must define \fontprefix
1437 % before you read in texinfo.tex.
1438 \ifx\fontprefix\undefined
1441 % Support font families that don't use the same naming scheme as CM.
1443 \def\rmbshape{bx} %where the normal face is bold
1448 \def\ttslshape{sltt}
1458 % Text fonts (11.2pt, magstep1).
1459 \newcount\mainmagstep
1461 % not really supported.
1462 \mainmagstep=\magstep1
1463 \setfont\textrm\rmshape{12}{1000}
1464 \setfont\texttt\ttshape{12}{1000}
1466 \mainmagstep=\magstephalf
1467 \setfont\textrm\rmshape{10}{\mainmagstep}
1468 \setfont\texttt\ttshape{10}{\mainmagstep}
1470 \setfont\textbf\bfshape{10}{\mainmagstep}
1471 \setfont\textit\itshape{10}{\mainmagstep}
1472 \setfont\textsl\slshape{10}{\mainmagstep}
1473 \setfont\textsf\sfshape{10}{\mainmagstep}
1474 \setfont\textsc\scshape{10}{\mainmagstep}
1475 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1476 \font\texti=cmmi10 scaled \mainmagstep
1477 \font\textsy=cmsy10 scaled \mainmagstep
1479 % A few fonts for @defun names and args.
1480 \setfont\defbf\bfshape{10}{\magstep1}
1481 \setfont\deftt\ttshape{10}{\magstep1}
1482 \setfont\defttsl\ttslshape{10}{\magstep1}
1483 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1485 % Fonts for indices, footnotes, small examples (9pt).
1486 \setfont\smallrm\rmshape{9}{1000}
1487 \setfont\smalltt\ttshape{9}{1000}
1488 \setfont\smallbf\bfshape{10}{900}
1489 \setfont\smallit\itshape{9}{1000}
1490 \setfont\smallsl\slshape{9}{1000}
1491 \setfont\smallsf\sfshape{9}{1000}
1492 \setfont\smallsc\scshape{10}{900}
1493 \setfont\smallttsl\ttslshape{10}{900}
1497 % Fonts for small examples (8pt).
1498 \setfont\smallerrm\rmshape{8}{1000}
1499 \setfont\smallertt\ttshape{8}{1000}
1500 \setfont\smallerbf\bfshape{10}{800}
1501 \setfont\smallerit\itshape{8}{1000}
1502 \setfont\smallersl\slshape{8}{1000}
1503 \setfont\smallersf\sfshape{8}{1000}
1504 \setfont\smallersc\scshape{10}{800}
1505 \setfont\smallerttsl\ttslshape{10}{800}
1506 \font\smalleri=cmmi8
1507 \font\smallersy=cmsy8
1509 % Fonts for title page (20.4pt):
1510 \setfont\titlerm\rmbshape{12}{\magstep3}
1511 \setfont\titleit\itbshape{10}{\magstep4}
1512 \setfont\titlesl\slbshape{10}{\magstep4}
1513 \setfont\titlett\ttbshape{12}{\magstep3}
1514 \setfont\titlettsl\ttslshape{10}{\magstep4}
1515 \setfont\titlesf\sfbshape{17}{\magstep1}
1516 \let\titlebf=\titlerm
1517 \setfont\titlesc\scbshape{10}{\magstep4}
1518 \font\titlei=cmmi12 scaled \magstep3
1519 \font\titlesy=cmsy10 scaled \magstep4
1520 \def\authorrm{\secrm}
1521 \def\authortt{\sectt}
1523 % Chapter (and unnumbered) fonts (17.28pt).
1524 \setfont\chaprm\rmbshape{12}{\magstep2}
1525 \setfont\chapit\itbshape{10}{\magstep3}
1526 \setfont\chapsl\slbshape{10}{\magstep3}
1527 \setfont\chaptt\ttbshape{12}{\magstep2}
1528 \setfont\chapttsl\ttslshape{10}{\magstep3}
1529 \setfont\chapsf\sfbshape{17}{1000}
1531 \setfont\chapsc\scbshape{10}{\magstep3}
1532 \font\chapi=cmmi12 scaled \magstep2
1533 \font\chapsy=cmsy10 scaled \magstep3
1535 % Section fonts (14.4pt).
1536 \setfont\secrm\rmbshape{12}{\magstep1}
1537 \setfont\secit\itbshape{10}{\magstep2}
1538 \setfont\secsl\slbshape{10}{\magstep2}
1539 \setfont\sectt\ttbshape{12}{\magstep1}
1540 \setfont\secttsl\ttslshape{10}{\magstep2}
1541 \setfont\secsf\sfbshape{12}{\magstep1}
1543 \setfont\secsc\scbshape{10}{\magstep2}
1544 \font\seci=cmmi12 scaled \magstep1
1545 \font\secsy=cmsy10 scaled \magstep2
1547 % Subsection fonts (13.15pt).
1548 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1549 \setfont\ssecit\itbshape{10}{1315}
1550 \setfont\ssecsl\slbshape{10}{1315}
1551 \setfont\ssectt\ttbshape{12}{\magstephalf}
1552 \setfont\ssecttsl\ttslshape{10}{1315}
1553 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1555 \setfont\ssecsc\scbshape{10}{1315}
1556 \font\sseci=cmmi12 scaled \magstephalf
1557 \font\ssecsy=cmsy10 scaled 1315
1559 % Reduced fonts for @acro in text (10pt).
1560 \setfont\reducedrm\rmshape{10}{1000}
1561 \setfont\reducedtt\ttshape{10}{1000}
1562 \setfont\reducedbf\bfshape{10}{1000}
1563 \setfont\reducedit\itshape{10}{1000}
1564 \setfont\reducedsl\slshape{10}{1000}
1565 \setfont\reducedsf\sfshape{10}{1000}
1566 \setfont\reducedsc\scshape{10}{1000}
1567 \setfont\reducedttsl\ttslshape{10}{1000}
1568 \font\reducedi=cmmi10
1569 \font\reducedsy=cmsy10
1571 % In order for the font changes to affect most math symbols and letters,
1572 % we have to define the \textfont of the standard families. Since
1573 % texinfo doesn't allow for producing subscripts and superscripts except
1574 % in the main text, we don't bother to reset \scriptfont and
1575 % \scriptscriptfont (which would also require loading a lot more fonts).
1577 \def\resetmathfonts{%
1578 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1579 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1580 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1583 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1584 % of just \STYLE. We do this because \STYLE needs to also set the
1585 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1586 % \tenSTYLE to set the current font.
1588 % Each font-changing command also sets the names \lsize (one size lower)
1589 % and \lllsize (three sizes lower). These relative commands are used in
1590 % the LaTeX logo and acronyms.
1592 % This all needs generalizing, badly.
1595 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1596 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1597 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1598 \let\tenttsl=\textttsl
1599 \def\lsize{reduced}\def\lllsize{smaller}%
1600 \resetmathfonts \setleading{\textleading}}
1602 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1603 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1604 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1605 \let\tenttsl=\titlettsl
1606 \def\lsize{chap}\def\lllsize{subsec}%
1607 \resetmathfonts \setleading{25pt}}
1608 \def\titlefont#1{{\titlefonts\rm #1}}
1610 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1611 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1612 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1613 \def\lsize{sec}\def\lllsize{text}%
1614 \resetmathfonts \setleading{19pt}}
1616 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1617 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1618 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1619 \let\tenttsl=\secttsl
1620 \def\lsize{subsec}\def\lllsize{reduced}%
1621 \resetmathfonts \setleading{16pt}}
1623 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1624 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1625 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1626 \let\tenttsl=\ssecttsl
1627 \def\lsize{text}\def\lllsize{small}%
1628 \resetmathfonts \setleading{15pt}}
1629 \let\subsubsecfonts = \subsecfonts
1631 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1632 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1633 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1634 \let\tenttsl=\reducedttsl
1635 \def\lsize{small}\def\lllsize{smaller}%
1636 \resetmathfonts \setleading{10.5pt}}
1638 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1639 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1640 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1641 \let\tenttsl=\smallttsl
1642 \def\lsize{smaller}\def\lllsize{smaller}%
1643 \resetmathfonts \setleading{10.5pt}}
1645 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1646 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1647 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1648 \let\tenttsl=\smallerttsl
1649 \def\lsize{smaller}\def\lllsize{smaller}%
1650 \resetmathfonts \setleading{9.5pt}}
1652 % Set the fonts to use with the @small... environments.
1653 \let\smallexamplefonts = \smallfonts
1655 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1656 % can fit this many characters:
1657 % 8.5x11=86 smallbook=72 a4=90 a5=69
1658 % If we use \scriptfonts (8pt), then we can fit this many characters:
1659 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1660 % For me, subjectively, the few extra characters that fit aren't worth
1661 % the additional smallness of 8pt. So I'm making the default 9pt.
1663 % By the way, for comparison, here's what fits with @example (10pt):
1664 % 8.5x11=71 smallbook=60 a4=75 a5=58
1666 % I wish the USA used A4 paper.
1670 % Set up the default fonts, so we can use them for creating boxes.
1674 % Define these so they can be easily changed for other fonts.
1675 \def\angleleft{$\langle$}
1676 \def\angleright{$\rangle$}
1678 % Count depth in font-changes, for error checks
1679 \newcount\fontdepth \fontdepth=0
1681 % Fonts for short table of contents.
1682 \setfont\shortcontrm\rmshape{12}{1000}
1683 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1684 \setfont\shortcontsl\slshape{12}{1000}
1685 \setfont\shortconttt\ttshape{12}{1000}
1687 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1688 %% serif) and @ii for TeX italic
1690 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1691 % unless the following character is such as not to need one.
1692 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1693 \ptexslash\fi\fi\fi}
1694 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1695 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1697 % like \smartslanted except unconditionally uses \ttsl.
1698 % @var is set to this for defun arguments.
1699 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1701 % like \smartslanted except unconditionally use \sl. We never want
1702 % ttsl for book titles, do we?
1703 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1706 \let\var=\smartslanted
1707 \let\dfn=\smartslanted
1708 \let\emph=\smartitalic
1713 % We can't just use \exhyphenpenalty, because that only has effect at
1714 % the end of a paragraph. Restore normal hyphenation at the end of the
1715 % group within which \nohyphenation is presumably called.
1717 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1718 \def\restorehyphenation{\hyphenchar\font = `- }
1720 % Set sfcode to normal for the chars that usually have another value.
1721 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1722 % sometimes \x has an active definition that messes things up.
1725 \def\frenchspacing{%
1726 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1727 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1732 {\tt \rawbackslash \frenchspacing #1}%
1735 \def\samp#1{`\tclose{#1}'\null}
1736 \setfont\keyrm\rmshape{8}{1000}
1738 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1739 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1740 \vbox{\hrule\kern-0.4pt
1741 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1743 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1744 % The old definition, with no lozenge:
1745 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1746 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1748 % @file, @option are the same as @samp.
1752 % @code is a modification of @t,
1753 % which makes spaces the same size as normal in the surrounding text.
1756 % Change normal interword space to be same as for the current font.
1757 \spaceskip = \fontdimen2\font
1759 % Switch to typewriter.
1762 % But `\ ' produces the large typewriter interword space.
1763 \def\ {{\spaceskip = 0pt{} }}%
1765 % Turn off hyphenation.
1775 % We *must* turn on hyphenation at `-' and `_' in @code.
1776 % Otherwise, it is too hard to avoid overfull hboxes
1777 % in the Emacs manual, the Library manual, etc.
1779 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1780 % both hyphenation at - and hyphenation within words.
1781 % We must therefore turn them both off (\tclose does that)
1782 % and arrange explicitly to hyphenate at a dash.
1788 \global\def\code{\begingroup
1789 \catcode`\-=\active \let-\codedash
1790 \catcode`\_=\active \let_\codeunder
1796 \def\codedash{-\discretionary{}{}{}}
1798 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1799 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1800 % will therefore expand the active definition of _, which is us
1801 % (inside @code that is), therefore an endless loop.
1803 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1804 \else\normalunderscore \fi
1805 \discretionary{}{}{}}%
1808 \def\codex #1{\tclose{#1}\endgroup}
1810 % @kbd is like @code, except that if the argument is just one @key command,
1811 % then @kbd has no effect.
1813 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1814 % `example' (@kbd uses ttsl only inside of @example and friends),
1815 % or `code' (@kbd uses normal tty font always).
1816 \parseargdef\kbdinputstyle{%
1818 \ifx\arg\worddistinct
1819 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1820 \else\ifx\arg\wordexample
1821 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1822 \else\ifx\arg\wordcode
1823 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1825 \errhelp = \EMsimple
1826 \errmessage{Unknown @kbdinputstyle option `\arg'}%
1829 \def\worddistinct{distinct}
1830 \def\wordexample{example}
1833 % Default is `distinct.'
1834 \kbdinputstyle distinct
1837 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1838 \ifx\one\xkey\ifx\threex\three \key{#2}%
1839 \else{\tclose{\kbdfont\look}}\fi
1840 \else{\tclose{\kbdfont\look}}\fi}
1842 % For @url, @env, @command quotes seem unnecessary, so use \code.
1847 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1848 % second argument specifying the text to display and an optional third
1849 % arg as text to display instead of (rather than in addition to) the url
1850 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1851 % a hypertex \special here.
1853 \def\uref#1{\douref #1,,,\finish}
1854 \def\douref#1,#2,#3,#4\finish{\begingroup
1857 \setbox0 = \hbox{\ignorespaces #3}%
1859 \unhbox0 % third arg given, show only that
1861 \setbox0 = \hbox{\ignorespaces #2}%
1864 \unhbox0 % PDF: 2nd arg given, show only it
1866 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1869 \code{#1}% only url given, so show it
1875 % rms does not like angle brackets --karl, 17may97.
1876 % So now @email is just like @uref, unless we are pdf.
1878 %\def\email#1{\angleleft{\tt #1}\angleright}
1880 \def\email#1{\doemail#1,,\finish}
1881 \def\doemail#1,#2,#3\finish{\begingroup
1884 \setbox0 = \hbox{\ignorespaces #2}%
1885 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1892 % Check if we are currently using a typewriter font. Since all the
1893 % Computer Modern typewriter fonts have zero interword stretch (and
1894 % shrink), and it is reasonable to expect all typewriter fonts to have
1895 % this property, we can check that font parameter.
1897 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1899 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1900 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1902 \def\dmn#1{\thinspace #1}
1904 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1906 % @l was never documented to mean ``switch to the Lisp font'',
1907 % and it is not used as such in any manual I can find. We need it for
1908 % Polish suppressed-l. --karl, 22sep96.
1909 %\def\l#1{{\li #1}\null}
1911 % Explicit font changes: @r, @sc, undocumented @ii.
1912 \def\r#1{{\rm #1}} % roman font
1913 \def\sc#1{{\smallcaps#1}} % smallcaps font
1914 \def\ii#1{{\it #1}} % italic font
1916 \def\acronym#1{\doacronym #1,,\finish}
1917 \def\doacronym#1,#2,#3\finish{%
1918 {\selectfonts\lsize #1}%
1920 \ifx\temp\empty \else
1921 \space ({\unsepspaces \ignorespaces \temp \unskip})%
1925 % @pounds{} is a sterling sign, which is in the CM italic font.
1927 \def\pounds{{\it\$}}
1929 % @registeredsymbol - R in a circle. The font for the R should really
1930 % be smaller yet, but lllsize is the best we can do for now.
1931 % Adapted from the plain.tex definition of \copyright.
1933 \def\registeredsymbol{%
1934 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
1940 \message{page headings,}
1942 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1943 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1945 % First the title page. Must do @settitle before @titlepage.
1947 \newif\iffinishedtitlepage
1949 % Do an implicit @contents or @shortcontents after @end titlepage if the
1950 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1952 \newif\ifsetcontentsaftertitlepage
1953 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1954 \newif\ifsetshortcontentsaftertitlepage
1955 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1957 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1958 \endgroup\page\hbox{}\page}
1961 % Open one extra group, as we want to close it in the middle of \Etitlepage.
1963 \parindent=0pt \textfonts
1964 % Leave some space at the very top of the page.
1965 \vglue\titlepagetopglue
1966 % No rule at page bottom unless we print one at the top with @title.
1967 \finishedtitlepagetrue
1969 % Most title ``pages'' are actually two pages long, with space
1970 % at the top of the second. We don't want the ragged left on the second.
1971 \let\oldpage = \page
1973 \iffinishedtitlepage\else
1976 \let\page = \oldpage
1983 \iffinishedtitlepage\else
1986 % It is important to do the page break before ending the group,
1987 % because the headline and footline are only empty inside the group.
1988 % If we use the new definition of \page, we always get a blank page
1989 % after the title page, which we certainly don't want.
1993 % Need this before the \...aftertitlepage checks so that if they are
1994 % in effect the toc pages will come out with page numbers.
1997 % If they want short, they certainly want long too.
1998 \ifsetshortcontentsaftertitlepage
2001 \global\let\shortcontents = \relax
2002 \global\let\contents = \relax
2005 \ifsetcontentsaftertitlepage
2007 \global\let\contents = \relax
2008 \global\let\shortcontents = \relax
2012 \def\finishtitlepage{%
2013 \vskip4pt \hrule height 2pt width \hsize
2014 \vskip\titlepagebottomglue
2015 \finishedtitlepagetrue
2018 %%% Macros to be used within @titlepage:
2020 \let\subtitlerm=\tenrm
2021 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2023 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2026 \parseargdef\title{%
2028 \leftline{\titlefonts\rm #1}
2029 % print a rule at the page bottom also.
2030 \finishedtitlepagefalse
2031 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2034 \parseargdef\subtitle{%
2036 {\subtitlefont \rightline{#1}}%
2039 % @author should come last, but may come many times.
2040 \parseargdef\author{%
2041 \def\temp{\quotation}%
2043 This edition of the manual is dedicated to Karl Berry who should
2044 really make affiliations work.
2047 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2048 {\authorfont \leftline{#1}}%
2053 %%% Set up page headings and footings.
2055 \let\thispage=\folio
2057 \newtoks\evenheadline % headline on even pages
2058 \newtoks\oddheadline % headline on odd pages
2059 \newtoks\evenfootline % footline on even pages
2060 \newtoks\oddfootline % footline on odd pages
2062 % Now make TeX use those variables
2063 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2064 \else \the\evenheadline \fi}}
2065 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2066 \else \the\evenfootline \fi}\HEADINGShook}
2067 \let\HEADINGShook=\relax
2069 % Commands to set those variables.
2070 % For example, this is what @headings on does
2071 % @evenheading @thistitle|@thispage|@thischapter
2072 % @oddheading @thischapter|@thispage|@thistitle
2073 % @evenfooting @thisfile||
2074 % @oddfooting ||@thisfile
2077 \def\evenheading{\parsearg\evenheadingxxx}
2078 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2079 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2080 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2082 \def\oddheading{\parsearg\oddheadingxxx}
2083 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2084 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2085 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2087 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2089 \def\evenfooting{\parsearg\evenfootingxxx}
2090 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2091 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2092 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2094 \def\oddfooting{\parsearg\oddfootingxxx}
2095 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2096 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2097 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2099 % Leave some space for the footline. Hopefully ok to assume
2100 % @evenfooting will not be used by itself.
2101 \global\advance\pageheight by -\baselineskip
2102 \global\advance\vsize by -\baselineskip
2105 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2108 % @headings double turns headings on for double-sided printing.
2109 % @headings single turns headings on for single-sided printing.
2110 % @headings off turns them off.
2111 % @headings on same as @headings double, retained for compatibility.
2112 % @headings after turns on double-sided headings after this page.
2113 % @headings doubleafter turns on double-sided headings after this page.
2114 % @headings singleafter turns on single-sided headings after this page.
2115 % By default, they are off at the start of a document,
2116 % and turned `on' after @end titlepage.
2118 \def\headings #1 {\csname HEADINGS#1\endcsname}
2121 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2122 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2124 % When we turn headings on, set the page number to 1.
2125 % For double-sided printing, put current file name in lower left corner,
2126 % chapter name on inside top of right hand pages, document
2127 % title on inside top of left hand pages, and page numbers on outside top
2128 % edge of all pages.
2129 \def\HEADINGSdouble{%
2131 \global\evenfootline={\hfil}
2132 \global\oddfootline={\hfil}
2133 \global\evenheadline={\line{\folio\hfil\thistitle}}
2134 \global\oddheadline={\line{\thischapter\hfil\folio}}
2135 \global\let\contentsalignmacro = \chapoddpage
2137 \let\contentsalignmacro = \chappager
2139 % For single-sided printing, chapter title goes across top left of page,
2140 % page number on top right.
2141 \def\HEADINGSsingle{%
2143 \global\evenfootline={\hfil}
2144 \global\oddfootline={\hfil}
2145 \global\evenheadline={\line{\thischapter\hfil\folio}}
2146 \global\oddheadline={\line{\thischapter\hfil\folio}}
2147 \global\let\contentsalignmacro = \chappager
2149 \def\HEADINGSon{\HEADINGSdouble}
2151 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2152 \let\HEADINGSdoubleafter=\HEADINGSafter
2153 \def\HEADINGSdoublex{%
2154 \global\evenfootline={\hfil}
2155 \global\oddfootline={\hfil}
2156 \global\evenheadline={\line{\folio\hfil\thistitle}}
2157 \global\oddheadline={\line{\thischapter\hfil\folio}}
2158 \global\let\contentsalignmacro = \chapoddpage
2161 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2162 \def\HEADINGSsinglex{%
2163 \global\evenfootline={\hfil}
2164 \global\oddfootline={\hfil}
2165 \global\evenheadline={\line{\thischapter\hfil\folio}}
2166 \global\oddheadline={\line{\thischapter\hfil\folio}}
2167 \global\let\contentsalignmacro = \chappager
2170 % Subroutines used in generating headings
2171 % This produces Day Month Year style of output.
2172 % Only define if not already defined, in case a txi-??.tex file has set
2173 % up a different format (e.g., txi-cs.tex does this).
2174 \ifx\today\undefined
2178 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2179 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2180 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2185 % @settitle line... specifies the title of the document, for headings.
2186 % It generates no output of its own.
2187 \def\thistitle{\putwordNoTitle}
2188 \def\settitle{\parsearg{\gdef\thistitle}}
2192 % Tables -- @table, @ftable, @vtable, @item(x).
2194 % default indentation of table text
2195 \newdimen\tableindent \tableindent=.8in
2196 % default indentation of @itemize and @enumerate text
2197 \newdimen\itemindent \itemindent=.3in
2198 % margin between end of table item and start of table text.
2199 \newdimen\itemmargin \itemmargin=.1in
2201 % used internally for \itemindent minus \itemmargin
2204 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2206 % They also define \itemindex
2207 % to index the item name in whatever manner is desired (perhaps none).
2209 \newif\ifitemxneedsnegativevskip
2211 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2213 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2214 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2216 \def\itemzzz #1{\begingroup %
2217 \advance\hsize by -\rightskip
2218 \advance\hsize by -\tableindent
2219 \setbox0=\hbox{\itemindicate{#1}}%
2221 \nobreak % This prevents a break before @itemx.
2223 % If the item text does not fit in the space we have, put it on a line
2224 % by itself, and do not allow a page break either before or after that
2225 % line. We do not start a paragraph here because then if the next
2226 % command is, e.g., @kindex, the whatsit would get put into the
2227 % horizontal list on a line by itself, resulting in extra blank space.
2228 \ifdim \wd0>\itemmax
2230 % Make this a paragraph so we get the \parskip glue and wrapping,
2231 % but leave it ragged-right.
2233 \advance\leftskip by-\tableindent
2234 \advance\hsize by\tableindent
2235 \advance\rightskip by0pt plus1fil
2236 \leavevmode\unhbox0\par
2239 % We're going to be starting a paragraph, but we don't want the
2240 % \parskip glue -- logically it's part of the @item we just started.
2241 \nobreak \vskip-\parskip
2243 % Stop a page break at the \parskip glue coming up. (Unfortunately
2244 % we can't prevent a possible page break at the following
2245 % \baselineskip glue.) However, if what follows is an environment
2246 % such as @example, there will be no \parskip glue; then
2247 % the negative vskip we just would cause the example and the item to
2248 % crash together. So we use this bizarre value of 10001 as a signal
2249 % to \aboveenvbreak to insert \parskip glue after all.
2250 % (Possibly there are other commands that could be followed by
2251 % @example which need the same treatment, but not section titles; or
2252 % maybe section titles are the only special case and they should be
2256 \itemxneedsnegativevskipfalse
2258 % The item text fits into the space. Start a paragraph, so that the
2259 % following text (if any) will end up on the same line.
2261 % Do this with kerns and \unhbox so that if there is a footnote in
2262 % the item text, it can migrate to the main vertical list and
2263 % eventually be printed.
2264 \nobreak\kern-\tableindent
2265 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2267 \nobreak\kern\dimen0
2269 \itemxneedsnegativevskiptrue
2273 \def\item{\errmessage{@item while not in a list environment}}
2274 \def\itemx{\errmessage{@itemx while not in a list environment}}
2276 % @table, @ftable, @vtable.
2278 \let\itemindex\gobble
2282 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2286 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2290 \def\itemindicate{#1}%
2295 \makevalueexpandable
2296 \edef\temp{\noexpand\tablez #1\space\space\space}%
2300 \def\tablez #1 #2 #3 #4\endtablez{%
2302 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2303 \ifnum 0#2>0 \tableindent=#2\mil \fi
2304 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2305 \itemmax=\tableindent
2306 \advance \itemmax by -\itemmargin
2307 \advance \leftskip by \tableindent
2308 \exdentamount=\tableindent
2310 \parskip = \smallskipamount
2311 \ifdim \parskip=0pt \parskip=2pt \fi
2312 \let\item = \internalBitem
2313 \let\itemx = \internalBitemx
2315 \def\Etable{\endgraf\afterenvbreak}
2318 \let\Eitemize\Etable
2319 \let\Eenumerate\Etable
2321 % This is the counter used by @enumerate, which is really @itemize
2325 \envdef\itemize{\parsearg\doitemize}
2329 \itemmax=\itemindent
2330 \advance\itemmax by -\itemmargin
2331 \advance\leftskip by \itemindent
2332 \exdentamount=\itemindent
2334 \parskip=\smallskipamount
2335 \ifdim\parskip=0pt \parskip=2pt \fi
2336 \def\itemcontents{#1}%
2337 % @itemize with no arg is equivalent to @itemize @bullet.
2338 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2339 \let\item=\itemizeitem
2342 % Definition of @item while inside @itemize and @enumerate.
2345 \advance\itemno by 1 % for enumerations
2346 {\let\par=\endgraf \smallbreak}% reasonable place to break
2348 % If the document has an @itemize directly after a section title, a
2349 % \nobreak will be last on the list, and \sectionheading will have
2350 % done a \vskip-\parskip. In that case, we don't want to zero
2351 % parskip, or the item text will crash with the heading. On the
2352 % other hand, when there is normal text preceding the item (as there
2353 % usually is), we do want to zero parskip, or there would be too much
2354 % space. In that case, we won't have a \nobreak before. At least
2355 % that's the theory.
2356 \ifnum\lastpenalty<10000 \parskip=0in \fi
2358 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2359 \vadjust{\penalty 1200}}% not good to break after first line of item.
2363 % \splitoff TOKENS\endmark defines \first to be the first token in
2364 % TOKENS, and \rest to be the remainder.
2366 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2368 % Allow an optional argument of an uppercase letter, lowercase letter,
2369 % or number, to specify the first label in the enumerated list. No
2370 % argument is the same as `1'.
2372 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2373 \def\enumeratey #1 #2\endenumeratey{%
2374 % If we were given no argument, pretend we were given `1'.
2376 \ifx\thearg\empty \def\thearg{1}\fi
2378 % Detect if the argument is a single token. If so, it might be a
2379 % letter. Otherwise, the only valid thing it can be is a number.
2380 % (We will always have one token, because of the test we just made.
2381 % This is a good thing, since \splitoff doesn't work given nothing at
2382 % all -- the first parameter is undelimited.)
2383 \expandafter\splitoff\thearg\endmark
2385 % Only one token in the argument. It could still be anything.
2386 % A ``lowercase letter'' is one whose \lccode is nonzero.
2387 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2388 % not equal to itself.
2389 % Otherwise, we assume it's a number.
2391 % We need the \relax at the end of the \ifnum lines to stop TeX from
2392 % continuing to look for a <number>.
2394 \ifnum\lccode\expandafter`\thearg=0\relax
2395 \numericenumerate % a number (we hope)
2398 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2399 \lowercaseenumerate % lowercase letter
2401 \uppercaseenumerate % uppercase letter
2405 % Multiple tokens in the argument. We hope it's a number.
2410 % An @enumerate whose labels are integers. The starting integer is
2413 \def\numericenumerate{%
2415 \startenumeration{\the\itemno}%
2418 % The starting (lowercase) letter is in \thearg.
2419 \def\lowercaseenumerate{%
2420 \itemno = \expandafter`\thearg
2422 % Be sure we're not beyond the end of the alphabet.
2424 \errmessage{No more lowercase letters in @enumerate; get a bigger
2431 % The starting (uppercase) letter is in \thearg.
2432 \def\uppercaseenumerate{%
2433 \itemno = \expandafter`\thearg
2435 % Be sure we're not beyond the end of the alphabet.
2437 \errmessage{No more uppercase letters in @enumerate; get a bigger
2444 % Call \doitemize, adding a period to the first argument and supplying the
2445 % common last two arguments. Also subtract one from the initial value in
2446 % \itemno, since @item increments \itemno.
2448 \def\startenumeration#1{%
2449 \advance\itemno by -1
2450 \doitemize{#1.}\flushcr
2453 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2456 \def\alphaenumerate{\enumerate{a}}
2457 \def\capsenumerate{\enumerate{A}}
2458 \def\Ealphaenumerate{\Eenumerate}
2459 \def\Ecapsenumerate{\Eenumerate}
2462 % @multitable macros
2463 % Amy Hendrickson, 8/18/94, 3/6/96
2465 % @multitable ... @end multitable will make as many columns as desired.
2466 % Contents of each column will wrap at width given in preamble. Width
2467 % can be specified either with sample text given in a template line,
2468 % or in percent of \hsize, the current width of text on page.
2470 % Table can continue over pages but will only break between lines.
2474 % Either define widths of columns in terms of percent of \hsize:
2475 % @multitable @columnfractions .25 .3 .45
2478 % Numbers following @columnfractions are the percent of the total
2479 % current hsize to be used for each column. You may use as many
2480 % columns as desired.
2483 % Or use a template:
2484 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2486 % using the widest term desired in each column.
2488 % Each new table line starts with @item, each subsequent new column
2489 % starts with @tab. Empty columns may be produced by supplying @tab's
2490 % with nothing between them for as many times as empty columns are needed,
2491 % ie, @tab@tab@tab will produce two empty columns.
2493 % @item, @tab do not need to be on their own lines, but it will not hurt
2496 % Sample multitable:
2498 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2499 % @item first col stuff @tab second col stuff @tab third col
2506 % @item first col stuff @tab second col stuff
2507 % @tab Many paragraphs of text may be used in any column.
2509 % They will wrap at the width determined by the template.
2510 % @item@tab@tab This will be in third column.
2513 % Default dimensions may be reset by user.
2514 % @multitableparskip is vertical space between paragraphs in table.
2515 % @multitableparindent is paragraph indent in table.
2516 % @multitablecolmargin is horizontal space to be left between columns.
2517 % @multitablelinespace is space to leave between table items, baseline
2519 % 0pt means it depends on current normal line spacing.
2521 \newskip\multitableparskip
2522 \newskip\multitableparindent
2523 \newdimen\multitablecolspace
2524 \newskip\multitablelinespace
2525 \multitableparskip=0pt
2526 \multitableparindent=6pt
2527 \multitablecolspace=12pt
2528 \multitablelinespace=0pt
2530 % Macros used to set up halign preamble:
2532 \let\endsetuptable\relax
2533 \def\xendsetuptable{\endsetuptable}
2534 \let\columnfractions\relax
2535 \def\xcolumnfractions{\columnfractions}
2538 % #1 is the @columnfraction, usually a decimal number like .5, but might
2539 % be just 1. We just use it, whatever it is.
2541 \def\pickupwholefraction#1 {%
2542 \global\advance\colcount by 1
2543 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2550 \ifx\firstarg\xendsetuptable
2553 \ifx\firstarg\xcolumnfractions
2554 \global\setpercenttrue
2557 \let\go\pickupwholefraction
2559 \global\advance\colcount by 1
2560 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2561 % separator; typically that is always in the input, anyway.
2562 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2565 \ifx\go\pickupwholefraction
2566 % Put the argument back for the \pickupwholefraction call, so
2567 % we'll always have a period there to be parsed.
2568 \def\go{\pickupwholefraction#1}%
2570 \let\go = \setuptable
2576 % multitable-only commands.
2578 % @headitem starts a heading row, which we typeset in bold.
2579 % Assignments have to be global since we are inside the implicit group
2580 % of an alignment entry. Note that \everycr resets \everytab.
2581 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2583 % A \tab used to include \hskip1sp. But then the space in a template
2584 % line is not enough. That is bad. So let's go back to just `&' until
2585 % we encounter the problem it was intended to solve again.
2586 % --karl, nathan@acm.org, 20apr99.
2587 \def\tab{\checkenv\multitable &\the\everytab}%
2589 % @multitable ... @end multitable definitions:
2591 \newtoks\everytab % insert after every tab.
2593 \envdef\multitable{%
2597 % @item within a multitable starts a normal row.
2602 \setmultitablespacing
2603 \parskip=\multitableparskip
2604 \parindent=\multitableparindent
2610 \global\everytab={}%
2611 \global\colcount=0 % Reset the column counter.
2612 % Check for saved footnotes, etc.
2614 % Keeps underfull box messages off when table breaks over pages.
2616 % Maybe so, but it also creates really weird page breaks when the
2617 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2618 % problem manifests itself, so it can be fixed for real --karl.
2622 \parsearg\domultitable
2624 \def\domultitable#1{%
2625 % To parse everything between @multitable and @item:
2626 \setuptable#1 \endsetuptable
2628 % This preamble sets up a generic column definition, which will
2629 % be used as many times as user calls for columns.
2630 % \vtop will set a single line and will also let text wrap and
2631 % continue for many paragraphs if desired.
2633 \global\advance\colcount by 1
2636 % Use the current \colcount to find the correct column width:
2637 \hsize=\expandafter\csname col\the\colcount\endcsname
2639 % In order to keep entries from bumping into each other
2640 % we will add a \leftskip of \multitablecolspace to all columns after
2643 % If a template has been used, we will add \multitablecolspace
2644 % to the width of each template entry.
2646 % If the user has set preamble in terms of percent of \hsize we will
2647 % use that dimension as the width of the column, and the \leftskip
2648 % will keep entries from bumping into each other. Table will start at
2649 % left margin and final column will justify at right margin.
2651 % Make sure we don't inherit \rightskip from the outer environment.
2654 % The first column will be indented with the surrounding text.
2655 \advance\hsize by\leftskip
2658 % If user has not set preamble in terms of percent of \hsize
2659 % we will advance \hsize by \multitablecolspace.
2660 \advance\hsize by \multitablecolspace
2662 % In either case we will make \leftskip=\multitablecolspace:
2663 \leftskip=\multitablecolspace
2665 % Ignoring space at the beginning and end avoids an occasional spurious
2666 % blank line, when TeX decides to break the line at the space before the
2667 % box from the multistrut, so the strut ends up on a line by itself.
2669 % @multitable @columnfractions .11 .89
2671 % @tab Legal holiday which is valid in major parts of the whole country.
2672 % Is automatically provided with highlighting sequences respectively
2673 % marking characters.
2674 \noindent\ignorespaces##\unskip\multistrut
2679 \egroup % end the \halign
2680 \global\setpercentfalse
2683 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2684 % If so, do nothing. If not, give it an appropriate dimension based on
2685 % current baselineskip.
2686 \ifdim\multitablelinespace=0pt
2687 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2688 \global\advance\multitablelinespace by-\ht0
2689 %% strut to put in table in case some entry doesn't have descenders,
2690 %% to keep lines equally spaced
2691 \let\multistrut = \strut
2693 %% FIXME: what is \box0 supposed to be?
2694 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2696 %% Test to see if parskip is larger than space between lines of
2697 %% table. If not, do nothing.
2698 %% If so, set to same dimension as multitablelinespace.
2699 \ifdim\multitableparskip>\multitablelinespace
2700 \global\multitableparskip=\multitablelinespace
2701 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2702 %% than skip between lines in the table.
2704 \ifdim\multitableparskip=0pt
2705 \global\multitableparskip=\multitablelinespace
2706 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2707 %% than skip between lines in the table.
2711 \message{conditionals,}
2713 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2714 % @ifnotxml always succeed. They currently do nothing; we don't
2715 % attempt to check whether the conditionals are properly nested. But we
2716 % have to remember that they are conditionals, so that @end doesn't
2717 % attempt to close an environment group.
2720 \expandafter\let\csname #1\endcsname = \relax
2721 \expandafter\let\csname iscond.#1\endcsname = 1
2724 \makecond{ifnotdocbook}
2725 \makecond{ifnothtml}
2726 \makecond{ifnotinfo}
2727 \makecond{ifnotplaintext}
2730 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2732 \def\direntry{\doignore{direntry}}
2733 \def\documentdescription{\doignore{documentdescription}}
2734 \def\docbook{\doignore{docbook}}
2735 \def\html{\doignore{html}}
2736 \def\ifdocbook{\doignore{ifdocbook}}
2737 \def\ifhtml{\doignore{ifhtml}}
2738 \def\ifinfo{\doignore{ifinfo}}
2739 \def\ifnottex{\doignore{ifnottex}}
2740 \def\ifplaintext{\doignore{ifplaintext}}
2741 \def\ifxml{\doignore{ifxml}}
2742 \def\ignore{\doignore{ignore}}
2743 \def\menu{\doignore{menu}}
2744 \def\xml{\doignore{xml}}
2746 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2748 % A count to remember the depth of nesting.
2749 \newcount\doignorecount
2751 \def\doignore#1{\begingroup
2752 % Scan in ``verbatim'' mode:
2753 \catcode`\@ = \other
2754 \catcode`\{ = \other
2755 \catcode`\} = \other
2757 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2760 % Count number of #1's that we've seen.
2763 % Swallow text until we reach the matching `@end #1'.
2767 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2770 \gdef\dodoignore#1{%
2771 % #1 contains the string `ifinfo'.
2773 % Define a command to find the next `@end #1', which must be on a line
2775 \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2776 % And this command to find another #1 command, at the beginning of a
2777 % line. (Otherwise, we would consider a line `@c @ifset', for
2778 % example, to count as an @ifset for nesting.)
2779 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2781 % And now expand that command.
2787 \def\doignoreyyy#1{%
2789 \ifx\temp\empty % Nothing found.
2790 \let\next\doignoretextzzz
2791 \else % Found a nested condition, ...
2792 \advance\doignorecount by 1
2793 \let\next\doignoretextyyy % ..., look for another.
2794 % If we're here, #1 ends with ^^M\ifinfo (for example).
2796 \next #1% the token \_STOP_ is present just after this macro.
2799 % We have to swallow the remaining "\_STOP_".
2801 \def\doignoretextzzz#1{%
2802 \ifnum\doignorecount = 0 % We have just found the outermost @end.
2803 \let\next\enddoignore
2804 \else % Still inside a nested condition.
2805 \advance\doignorecount by -1
2806 \let\next\doignoretext % Look for the next @end.
2811 % Finish off ignored text.
2812 \def\enddoignore{\endgroup\ignorespaces}
2815 % @set VAR sets the variable VAR to an empty value.
2816 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2818 % Since we want to separate VAR from REST-OF-LINE (which might be
2819 % empty), we can't just use \parsearg; we have to insert a space of our
2820 % own to delimit the rest of the line, and then take it out again if we
2822 % We rely on the fact that \parsearg sets \catcode`\ =10.
2824 \parseargdef\set{\setyyy#1 \endsetyyy}
2825 \def\setyyy#1 #2\endsetyyy{%
2827 \makevalueexpandable
2829 \edef\next{\gdef\makecsname{SET#1}}%
2837 % Remove the trailing space \setxxx inserted.
2838 \def\setzzz#1 \endsetzzz{\next{#1}}
2840 % @clear VAR clears (i.e., unsets) the variable VAR.
2842 \parseargdef\clear{%
2844 \makevalueexpandable
2845 \global\expandafter\let\csname SET#1\endcsname=\relax
2849 % @value{foo} gets the text saved in variable foo.
2850 \def\value{\begingroup\makevalueexpandable\valuexxx}
2851 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2853 \catcode`\- = \active \catcode`\_ = \active
2855 \gdef\makevalueexpandable{%
2856 \let\value = \expandablevalue
2857 % We don't want these characters active, ...
2858 \catcode`\-=\other \catcode`\_=\other
2859 % ..., but we might end up with active ones in the argument if
2860 % we're called from @code, as @code{@value{foo-bar_}}, though.
2861 % So \let them to their normal equivalents.
2862 \let-\realdash \let_\normalunderscore
2866 % We have this subroutine so that we can handle at least some @value's
2867 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2868 % The command has to be fully expandable (if the variable is set), since
2869 % the result winds up in the index file. This means that if the
2870 % variable's value contains other Texinfo commands, it's almost certain
2871 % it will fail (although perhaps we could fix that with sufficient work
2872 % to do a one-level expansion on the result, instead of complete).
2874 \def\expandablevalue#1{%
2875 \expandafter\ifx\csname SET#1\endcsname\relax
2876 {[No value for ``#1'']}%
2877 \message{Variable `#1', used in @value, is not set.}%
2879 \csname SET#1\endcsname
2883 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2886 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2889 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2892 \makevalueexpandable
2894 \expandafter\ifx\csname SET#2\endcsname\relax
2895 #1% If not set, redefine \next.
2900 \def\ifsetfail{\doignore{ifset}}
2902 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2903 % defined with @set, or has been undefined with @clear.
2905 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2906 % above code: if the variable is not set, do nothing, if it is set,
2907 % then redefine \next to \ifclearfail.
2910 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2911 \def\ifclearfail{\doignore{ifclear}}
2913 % @dircategory CATEGORY -- specify a category of the dir file
2914 % which this file should belong to. Ignore this in TeX.
2915 \let\dircategory=\comment
2917 % @defininfoenclose.
2918 \let\definfoenclose=\comment
2922 % Index generation facilities
2924 % Define \newwrite to be identical to plain tex's \newwrite
2925 % except not \outer, so it can be used within \newindex.
2927 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2929 % \newindex {foo} defines an index named foo.
2930 % It automatically defines \fooindex such that
2931 % \fooindex ...rest of line... puts an entry in the index foo.
2932 % It also defines \fooindfile to be the number of the output channel for
2933 % the file that accumulates this index. The file's extension is foo.
2934 % The name of an index should be no more than 2 characters long
2935 % for the sake of vms.
2939 \expandafter\newwrite \csname#1indfile\endcsname
2940 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2942 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2943 \noexpand\doindex{#1}}
2946 % @defindex foo == \newindex{foo}
2948 \def\defindex{\parsearg\newindex}
2950 % Define @defcodeindex, like @defindex except put all entries in @code.
2952 \def\defcodeindex{\parsearg\newcodeindex}
2954 \def\newcodeindex#1{%
2956 \expandafter\newwrite \csname#1indfile\endcsname
2957 \openout \csname#1indfile\endcsname \jobname.#1
2959 \expandafter\xdef\csname#1index\endcsname{%
2960 \noexpand\docodeindex{#1}}%
2964 % @synindex foo bar makes index foo feed into index bar.
2965 % Do this instead of @defindex foo if you don't want it as a separate index.
2967 % @syncodeindex foo bar similar, but put all entries made for index foo
2970 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2971 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2973 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2974 % #3 the target index (bar).
2975 \def\dosynindex#1#2#3{%
2976 % Only do \closeout if we haven't already done it, else we'll end up
2977 % closing the target index.
2978 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2979 % The \closeout helps reduce unnecessary open files; the limit on the
2980 % Acorn RISC OS is a mere 16 files.
2981 \expandafter\closeout\csname#2indfile\endcsname
2982 \expandafter\let\csname\donesynindex#2\endcsname = 1
2984 % redefine \fooindfile:
2985 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2986 \expandafter\let\csname#2indfile\endcsname=\temp
2987 % redefine \fooindex:
2988 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2991 % Define \doindex, the driver for all \fooindex macros.
2992 % Argument #1 is generated by the calling \fooindex macro,
2993 % and it is "foo", the name of the index.
2995 % \doindex just uses \parsearg; it calls \doind for the actual work.
2996 % This is because \doind is more useful to call from other macros.
2998 % There is also \dosubind {index}{topic}{subtopic}
2999 % which makes an entry in a two-level index such as the operation index.
3001 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3002 \def\singleindexer #1{\doind{\indexname}{#1}}
3004 % like the previous two, but they put @code around the argument.
3005 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3006 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3008 % Take care of Texinfo commands that can appear in an index entry.
3009 % Since there are some commands we want to expand, and others we don't,
3010 % we have to laboriously prevent expansion for those that we don't.
3013 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3014 \def\ {\realbackslash\space }%
3015 % Need these in case \tex is in effect and \{ is a \delimiter again.
3016 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3017 % braces and backslashes are used only as delimiters.
3021 % \definedummyword defines \#1 as \realbackslash #1\space, thus
3022 % effectively preventing its expansion. This is used only for control
3023 % words, not control letters, because the \space would be incorrect
3024 % for control characters, but is needed to separate the control word
3025 % from whatever follows.
3027 % For control letters, we have \definedummyletter, which omits the
3030 % These can be used both for control words that take an argument and
3031 % those that do not. If it is followed by {arg} in the input, then
3032 % that will dutifully get written to the index (or wherever).
3034 \def\definedummyword##1{%
3035 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3037 \def\definedummyletter##1{%
3038 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3041 % Do the redefinitions.
3045 % For the aux file, @ is the escape character. So we want to redefine
3046 % everything using @ instead of \realbackslash. When everything uses
3047 % @, this will be simpler.
3052 \let\{ = \lbraceatcmd
3053 \let\} = \rbraceatcmd
3055 % (See comments in \indexdummies.)
3056 \def\definedummyword##1{%
3057 \expandafter\def\csname ##1\endcsname{@##1\space}%
3059 \def\definedummyletter##1{%
3060 \expandafter\def\csname ##1\endcsname{@##1}%
3063 % Do the redefinitions.
3067 % Called from \indexdummies and \atdummies. \definedummyword and
3068 % \definedummyletter must be defined first.
3070 \def\commondummies{%
3072 \normalturnoffactive
3074 \commondummiesnofonts
3076 \definedummyletter{_}%
3078 % Non-English letters.
3079 \definedummyword{AA}%
3080 \definedummyword{AE}%
3081 \definedummyword{L}%
3082 \definedummyword{OE}%
3083 \definedummyword{O}%
3084 \definedummyword{aa}%
3085 \definedummyword{ae}%
3086 \definedummyword{l}%
3087 \definedummyword{oe}%
3088 \definedummyword{o}%
3089 \definedummyword{ss}%
3090 \definedummyword{exclamdown}%
3091 \definedummyword{questiondown}%
3092 \definedummyword{ordf}%
3093 \definedummyword{ordm}%
3095 % Although these internal commands shouldn't show up, sometimes they do.
3096 \definedummyword{bf}%
3097 \definedummyword{gtr}%
3098 \definedummyword{hat}%
3099 \definedummyword{less}%
3100 \definedummyword{sf}%
3101 \definedummyword{sl}%
3102 \definedummyword{tclose}%
3103 \definedummyword{tt}%
3105 \definedummyword{LaTeX}%
3106 \definedummyword{TeX}%
3108 % Assorted special characters.
3109 \definedummyword{bullet}%
3110 \definedummyword{copyright}%
3111 \definedummyword{registeredsymbol}%
3112 \definedummyword{dots}%
3113 \definedummyword{enddots}%
3114 \definedummyword{equiv}%
3115 \definedummyword{error}%
3116 \definedummyword{expansion}%
3117 \definedummyword{minus}%
3118 \definedummyword{pounds}%
3119 \definedummyword{point}%
3120 \definedummyword{print}%
3121 \definedummyword{result}%
3123 % Handle some cases of @value -- where it does not contain any
3124 % (non-fully-expandable) commands.
3125 \makevalueexpandable
3127 % Normal spaces, not active ones.
3130 % No macro expansion.
3134 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3136 % Better have this without active chars.
3139 \gdef\commondummiesnofonts{%
3140 % Control letters and accents.
3141 \definedummyletter{!}%
3142 \definedummyletter{"}%
3143 \definedummyletter{'}%
3144 \definedummyletter{*}%
3145 \definedummyletter{,}%
3146 \definedummyletter{.}%
3147 \definedummyletter{/}%
3148 \definedummyletter{:}%
3149 \definedummyletter{=}%
3150 \definedummyletter{?}%
3151 \definedummyletter{^}%
3152 \definedummyletter{`}%
3153 \definedummyletter{~}%
3154 \definedummyword{u}%
3155 \definedummyword{v}%
3156 \definedummyword{H}%
3157 \definedummyword{dotaccent}%
3158 \definedummyword{ringaccent}%
3159 \definedummyword{tieaccent}%
3160 \definedummyword{ubaraccent}%
3161 \definedummyword{udotaccent}%
3162 \definedummyword{dotless}%
3164 % Texinfo font commands.
3165 \definedummyword{b}%
3166 \definedummyword{i}%
3167 \definedummyword{r}%
3168 \definedummyword{sc}%
3169 \definedummyword{t}%
3171 % Commands that take arguments.
3172 \definedummyword{acronym}%
3173 \definedummyword{cite}%
3174 \definedummyword{code}%
3175 \definedummyword{command}%
3176 \definedummyword{dfn}%
3177 \definedummyword{emph}%
3178 \definedummyword{env}%
3179 \definedummyword{file}%
3180 \definedummyword{kbd}%
3181 \definedummyword{key}%
3182 \definedummyword{math}%
3183 \definedummyword{option}%
3184 \definedummyword{samp}%
3185 \definedummyword{strong}%
3186 \definedummyword{tie}%
3187 \definedummyword{uref}%
3188 \definedummyword{url}%
3189 \definedummyword{var}%
3190 \definedummyword{verb}%
3191 \definedummyword{w}%
3195 % \indexnofonts is used when outputting the strings to sort the index
3196 % by, and when constructing control sequence names. It eliminates all
3197 % control sequences and just writes whatever the best ASCII sort string
3198 % would be for a given command (usually its argument).
3201 \def\definedummyword##1{%
3202 \expandafter\let\csname ##1\endcsname\asis
3204 \let\definedummyletter=\definedummyword
3206 \commondummiesnofonts
3208 % Don't no-op \tt, since it isn't a user-level command
3209 % and is used in the definitions of the active chars like <, >, |, etc.
3210 % Likewise with the other plain tex font commands.
3215 % how to handle braces?
3216 \def\_{\normalunderscore}%
3218 % Non-English letters.
3231 \def\questiondown{?}%
3238 % Assorted special characters.
3239 % (The following {} will end up in the sort string, but that's ok.)
3240 \def\bullet{bullet}%
3241 \def\copyright{copyright}%
3242 \def\registeredsymbol{R}%
3247 \def\expansion{==>}%
3249 \def\pounds{pounds}%
3255 \let\indexbackslash=0 %overridden during \printindex.
3256 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3258 % Most index entries go through here, but \dosubind is the general case.
3259 % #1 is the index name, #2 is the entry text.
3260 \def\doind#1#2{\dosubind{#1}{#2}{}}
3262 % Workhorse for all \fooindexes.
3263 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3264 % empty if called from \doind, as we usually are (the main exception
3265 % is with most defuns, which call us directly).
3267 \def\dosubind#1#2#3{%
3270 % Store the main index entry text (including the third arg).
3272 % If third arg is present, precede it with a space.
3274 \ifx\thirdarg\empty \else
3275 \toks0 = \expandafter{\the\toks0 \space #3}%
3278 \edef\writeto{\csname#1indfile\endcsname}%
3289 % Write the entry in \toks0 to the index file:
3291 \def\dosubindwrite{%
3292 % Put the index entry in the margin if desired.
3293 \ifx\SETmarginindex\relax\else
3294 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3297 % Remember, we are within a group.
3298 \indexdummies % Must do this here, since \bf, etc expand at this stage
3300 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3301 % so it will be output as is; and it will print as backslash.
3303 % Process the index entry with all font commands turned off, to
3304 % get the string to sort by.
3306 \edef\temp{\the\toks0}% need full expansion
3307 \xdef\indexsorttmp{\temp}%
3310 % Set up the complete index entry, with both the sort key and
3311 % the original text, including any font commands. We write
3312 % three arguments to \entry to the .?? file (four in the
3313 % subentry case), texindex reduces to two when writing the .??s
3317 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3322 % Take care of unwanted page breaks:
3324 % If a skip is the last thing on the list now, preserve it
3325 % by backing up by \lastskip, doing the \write, then inserting
3326 % the skip again. Otherwise, the whatsit generated by the
3327 % \write will make \lastskip zero. The result is that sequences
3332 % will have extra space inserted, because the \medbreak in the
3333 % start of the @defun won't see the skip inserted by the @end of
3334 % the previous defun.
3336 % But don't do any of this if we're not in vertical mode. We
3337 % don't want to do a \vskip and prematurely end a paragraph.
3339 % Avoid page breaks due to these extra skips, too.
3341 % But wait, there is a catch there:
3342 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3343 % sufficient for this purpose, as it ignores stretch and shrink parts
3344 % of the skip. The only way seems to be to check the textual
3345 % representation of the skip.
3347 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3348 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3350 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3354 \def\dosubindsanitize{%
3355 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3357 \edef\lastskipmacro{\the\lastskip}%
3358 \count255 = \lastpenalty
3360 % If \lastskip is nonzero, that means the last item was a
3361 % skip. And since a skip is discardable, that means this
3362 % -\skip0 glue we're inserting is preceded by a
3363 % non-discardable item, therefore it is not a potential
3364 % breakpoint, therefore no \nobreak needed.
3365 \ifx\lastskipmacro\zeroskipmacro
3372 \ifx\lastskipmacro\zeroskipmacro
3373 % if \lastskip was zero, perhaps the last item was a
3374 % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3375 % In that case, we want to re-insert the penalty; since we
3376 % just inserted a non-discardable item, any following glue
3377 % (such as a \parskip) would be a breakpoint. For example:
3378 % @deffn deffn-whatever
3379 % @vindex index-whatever
3381 % would allow a break between the index-whatever whatsit
3382 % and the "Description." paragraph.
3383 \ifnum\count255>9999 \nobreak \fi
3385 % On the other hand, if we had a nonzero \lastskip,
3386 % this make-up glue would be preceded by a non-discardable item
3387 % (the whatsit from the \write), so we must insert a \nobreak.
3388 \nobreak\vskip\skip0
3392 % The index entry written in the file actually looks like
3393 % \entry {sortstring}{page}{topic}
3395 % \entry {sortstring}{page}{topic}{subtopic}
3396 % The texindex program reads in these files and writes files
3397 % containing these kinds of lines:
3399 % before the first topic whose initial is c
3400 % \entry {topic}{pagelist}
3401 % for a topic that is used without subtopics
3403 % for the beginning of a topic that is used with subtopics
3404 % \secondary {subtopic}{pagelist}
3405 % for each subtopic.
3407 % Define the user-accessible indexing commands
3408 % @findex, @vindex, @kindex, @cindex.
3410 \def\findex {\fnindex}
3411 \def\kindex {\kyindex}
3412 \def\cindex {\cpindex}
3413 \def\vindex {\vrindex}
3414 \def\tindex {\tpindex}
3415 \def\pindex {\pgindex}
3417 \def\cindexsub {\begingroup\obeylines\cindexsub}
3419 \gdef\cindexsub "#1" #2^^M{\endgroup %
3420 \dosubind{cp}{#2}{#1}}}
3422 % Define the macros used in formatting output of the sorted index material.
3424 % @printindex causes a particular index (the ??s file) to get printed.
3425 % It does not print any chapter heading (usually an @unnumbered).
3427 \parseargdef\printindex{\begingroup
3428 \dobreak \chapheadingskip{10000}%
3432 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3434 % See if the index file exists and is nonempty.
3435 % Change catcode of @ here so that if the index file contains
3437 % as its first line, TeX doesn't complain about mismatched braces
3438 % (because it thinks @} is a control sequence).
3440 \openin 1 \jobname.#1s
3442 % \enddoublecolumns gets confused if there is no text in the index,
3443 % and it loses the chapter title and the aux file entries for the
3444 % index. The easiest way to prevent this problem is to make sure
3445 % there is some text.
3446 \putwordIndexNonexistent
3449 % If the index file exists but is empty, then \openin leaves \ifeof
3450 % false. We have to make TeX try to read something from the file, so
3451 % it can discover if there is anything in it.
3454 \putwordIndexIsEmpty
3456 % Index files are almost Texinfo source, but we use \ as the escape
3457 % character. It would be better to use @, but that's too big a change
3458 % to make right now.
3459 \def\indexbackslash{\backslashcurfont}%
3470 % These macros are used by the sorted index file itself.
3471 % Change them to control the appearance of the index.
3474 % Some minor font changes for the special characters.
3475 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3477 % Remove any glue we may have, we'll be inserting our own.
3480 % We like breaks before the index initials, so insert a bonus.
3483 % Typeset the initial. Making this add up to a whole number of
3484 % baselineskips increases the chance of the dots lining up from column
3485 % to column. It still won't often be perfect, because of the stretch
3486 % we need before each entry, but it's better.
3488 % No shrink because it confuses \balancecolumns.
3489 \vskip 1.67\baselineskip plus .5\baselineskip
3490 \leftline{\secbf #1}%
3491 \vskip .33\baselineskip plus .1\baselineskip
3493 % Do our best not to break after the initial.
3497 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3498 % then page number (#2) flushed to the right margin. It is used for index
3499 % and table of contents entries. The paragraph is indented by \leftskip.
3501 % A straightforward implementation would start like this:
3502 % \def\entry#1#2{...
3503 % But this frozes the catcodes in the argument, and can cause problems to
3504 % @code, which sets - active. This problem was fixed by a kludge---
3505 % ``-'' was active throughout whole index, but this isn't really right.
3507 % The right solution is to prevent \entry from swallowing the whole text.
3512 % Start a new paragraph if necessary, so our assignments below can't
3513 % affect previous text.
3516 % Do not fill out the last line with white space.
3519 % No extra space above this paragraph.
3522 % Do not prefer a separate line ending with a hyphen to fewer lines.
3523 \finalhyphendemerits = 0
3525 % \hangindent is only relevant when the entry text and page number
3526 % don't both fit on one line. In that case, bob suggests starting the
3527 % dots pretty far over on the line. Unfortunately, a large
3528 % indentation looks wrong when the entry text itself is broken across
3529 % lines. So we use a small indentation and put up with long leaders.
3531 % \hangafter is reset to 1 (which is the value we want) at the start
3532 % of each paragraph, so we need not do anything with that.
3535 % When the entry text needs to be broken, just fill out the first line
3537 \rightskip = 0pt plus1fil
3539 % A bit of stretch before each entry for the benefit of balancing
3543 % Swallow the left brace of the text (first parameter):
3544 \afterassignment\doentry
3548 \bgroup % Instead of the swallowed brace.
3550 \aftergroup\finishentry
3551 % And now comes the text of the entry.
3553 \def\finishentry#1{%
3554 % #1 is the page number.
3556 % The following is kludged to not output a line of dots in the index if
3557 % there are no page numbers. The next person who breaks this will be
3558 % cursed by a Unix daemon.
3561 \edef\tempc{\tempa}%
3562 \edef\tempd{\tempb}%
3567 % If we must, put the page number on a line of its own, and fill out
3568 % this line with blank space. (The \hfil is overwhelmed with the
3569 % fill leaders glue in \indexdotfill if the page number does fit.)
3571 \null\nobreak\indexdotfill % Have leaders before the page number.
3573 % The `\ ' here is removed by the implicit \unskip that TeX does as
3574 % part of (the primitive) \par. Without it, a spurious underfull
3577 \pdfgettoks#1.\ \the\toksA
3586 % Like \dotfill except takes at least 1 em.
3587 \def\indexdotfill{\cleaders
3588 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3590 \def\primary #1{\line{#1\hfil}}
3592 \newskip\secondaryindent \secondaryindent=0.5cm
3593 \def\secondary#1#2{{%
3598 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3600 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3607 % Define two-column mode, which we use to typeset indexes.
3608 % Adapted from the TeXbook, page 416, which is to say,
3609 % the manmac.tex format used to print the TeXbook itself.
3613 \newdimen\doublecolumnhsize
3615 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3616 % Grab any single-column material above us.
3619 % Here is a possibility not foreseen in manmac: if we accumulate a
3620 % whole lot of material, we might end up calling this \output
3621 % routine twice in a row (see the doublecol-lose test, which is
3622 % essentially a couple of indexes with @setchapternewpage off). In
3623 % that case we just ship out what is in \partialpage with the normal
3624 % output routine. Generally, \partialpage will be empty when this
3625 % runs and this will be a no-op. See the indexspread.tex test case.
3626 \ifvoid\partialpage \else
3627 \onepageout{\pagecontents\partialpage}%
3630 \global\setbox\partialpage = \vbox{%
3631 % Unvbox the main output page.
3633 \kern-\topskip \kern\baselineskip
3636 \eject % run that output routine to set \partialpage
3638 % Use the double-column output routine for subsequent pages.
3639 \output = {\doublecolumnout}%
3641 % Change the page size parameters. We could do this once outside this
3642 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3643 % format, but then we repeat the same computation. Repeating a couple
3644 % of assignments once per index is clearly meaningless for the
3645 % execution time, so we may as well do it in one place.
3647 % First we halve the line length, less a little for the gutter between
3648 % the columns. We compute the gutter based on the line length, so it
3649 % changes automatically with the paper format. The magic constant
3650 % below is chosen so that the gutter has the same value (well, +-<1pt)
3651 % as it did when we hard-coded it.
3653 % We put the result in a separate register, \doublecolumhsize, so we
3654 % can restore it in \pagesofar, after \hsize itself has (potentially)
3657 \doublecolumnhsize = \hsize
3658 \advance\doublecolumnhsize by -.04154\hsize
3659 \divide\doublecolumnhsize by 2
3660 \hsize = \doublecolumnhsize
3662 % Double the \vsize as well. (We don't need a separate register here,
3663 % since nobody clobbers \vsize.)
3667 % The double-column output routine for all double-column pages except
3670 \def\doublecolumnout{%
3671 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3672 % Get the available space for the double columns -- the normal
3673 % (undoubled) page height minus any material left over from the
3677 \advance\dimen@ by -\ht\partialpage
3679 % box0 will be the left-hand column, box2 the right.
3680 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3681 \onepageout\pagesofar
3683 \penalty\outputpenalty
3686 % Re-output the contents of the output page -- any previous material,
3687 % followed by the two boxes we just split, in box0 and box2.
3691 \hsize = \doublecolumnhsize
3692 \wd0=\hsize \wd2=\hsize
3693 \hbox to\pagewidth{\box0\hfil\box2}%
3696 % All done with double columns.
3697 \def\enddoublecolumns{%
3699 % Split the last of the double-column material. Leave it on the
3700 % current page, no automatic page break.
3703 % If we end up splitting too much material for the current page,
3704 % though, there will be another page break right after this \output
3705 % invocation ends. Having called \balancecolumns once, we do not
3706 % want to call it again. Therefore, reset \output to its normal
3707 % definition right away. (We hope \balancecolumns will never be
3708 % called on to balance too much material, but if it is, this makes
3709 % the output somewhat more palatable.)
3710 \global\output = {\onepageout{\pagecontents\PAGE}}%
3713 \endgroup % started in \begindoublecolumns
3715 % \pagegoal was set to the doubled \vsize above, since we restarted
3716 % the current page. We're now back to normal single-column
3717 % typesetting, so reset \pagegoal to the normal \vsize (after the
3718 % \endgroup where \vsize got restored).
3722 % Called at the end of the double column material.
3723 \def\balancecolumns{%
3724 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3726 \advance\dimen@ by \topskip
3727 \advance\dimen@ by-\baselineskip
3728 \divide\dimen@ by 2 % target to split to
3729 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3730 \splittopskip = \topskip
3731 % Loop until we get a decent breakpoint.
3735 \global\setbox3 = \copy0
3736 \global\setbox1 = \vsplit3 to \dimen@
3738 \global\advance\dimen@ by 1pt
3741 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3742 \setbox0=\vbox to\dimen@{\unvbox1}%
3743 \setbox2=\vbox to\dimen@{\unvbox3}%
3747 \catcode`\@ = \other
3750 \message{sectioning,}
3751 % Chapters, sections, etc.
3753 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3754 % sections so that we can refer to them unambiguously in the pdf
3755 % outlines by their "section number". We avoid collisions with chapter
3756 % numbers by starting them at 10000. (If a document ever has 10000
3757 % chapters, we're in trouble anyway, I'm sure.)
3758 \newcount\unnumberedno \unnumberedno = 10000
3760 \newcount\secno \secno=0
3761 \newcount\subsecno \subsecno=0
3762 \newcount\subsubsecno \subsubsecno=0
3764 % This counter is funny since it counts through charcodes of letters A, B, ...
3765 \newcount\appendixno \appendixno = `\@
3767 % \def\appendixletter{\char\the\appendixno}
3768 % We do the following ugly conditional instead of the above simple
3769 % construct for the sake of pdftex, which needs the actual
3770 % letter in the expansion, not just typeset.
3772 \def\appendixletter{%
3773 \ifnum\appendixno=`A A%
3774 \else\ifnum\appendixno=`B B%
3775 \else\ifnum\appendixno=`C C%
3776 \else\ifnum\appendixno=`D D%
3777 \else\ifnum\appendixno=`E E%
3778 \else\ifnum\appendixno=`F F%
3779 \else\ifnum\appendixno=`G G%
3780 \else\ifnum\appendixno=`H H%
3781 \else\ifnum\appendixno=`I I%
3782 \else\ifnum\appendixno=`J J%
3783 \else\ifnum\appendixno=`K K%
3784 \else\ifnum\appendixno=`L L%
3785 \else\ifnum\appendixno=`M M%
3786 \else\ifnum\appendixno=`N N%
3787 \else\ifnum\appendixno=`O O%
3788 \else\ifnum\appendixno=`P P%
3789 \else\ifnum\appendixno=`Q Q%
3790 \else\ifnum\appendixno=`R R%
3791 \else\ifnum\appendixno=`S S%
3792 \else\ifnum\appendixno=`T T%
3793 \else\ifnum\appendixno=`U U%
3794 \else\ifnum\appendixno=`V V%
3795 \else\ifnum\appendixno=`W W%
3796 \else\ifnum\appendixno=`X X%
3797 \else\ifnum\appendixno=`Y Y%
3798 \else\ifnum\appendixno=`Z Z%
3799 % The \the is necessary, despite appearances, because \appendixletter is
3800 % expanded while writing the .toc file. \char\appendixno is not
3801 % expandable, thus it is written literally, thus all appendixes come out
3802 % with the same letter (or @) in the toc without it.
3803 \else\char\the\appendixno
3804 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3805 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3807 % Each @chapter defines this as the name of the chapter.
3808 % page headings and footings can use it. @section does likewise.
3809 % However, they are not reliable, because we don't use marks.
3813 \newcount\absseclevel % used to calculate proper heading level
3814 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3816 % @raisesections: treat @section as chapter, @subsection as section, etc.
3817 \def\raisesections{\global\advance\secbase by -1}
3818 \let\up=\raisesections % original BFox name
3820 % @lowersections: treat @chapter as section, @section as subsection, etc.
3821 \def\lowersections{\global\advance\secbase by 1}
3822 \let\down=\lowersections % original BFox name
3824 % Choose a numbered-heading macro
3825 % #1 is heading level if unmodified by @raisesections or @lowersections
3826 % #2 is text for heading
3827 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3831 \or \numberedsubseczzz{#2}%
3832 \or \numberedsubsubseczzz{#2}%
3834 \ifnum \absseclevel<0 \chapterzzz{#2}%
3835 \else \numberedsubsubseczzz{#2}%
3838 \suppressfirstparagraphindent
3841 % like \numhead, but chooses appendix heading levels
3842 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3845 \or \appendixsectionzzz{#2}%
3846 \or \appendixsubseczzz{#2}%
3847 \or \appendixsubsubseczzz{#2}%
3849 \ifnum \absseclevel<0 \appendixzzz{#2}%
3850 \else \appendixsubsubseczzz{#2}%
3853 \suppressfirstparagraphindent
3856 % like \numhead, but chooses numberless heading levels
3857 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3860 \or \unnumberedseczzz{#2}%
3861 \or \unnumberedsubseczzz{#2}%
3862 \or \unnumberedsubsubseczzz{#2}%
3864 \ifnum \absseclevel<0 \unnumberedzzz{#2}%
3865 \else \unnumberedsubsubseczzz{#2}%
3868 \suppressfirstparagraphindent
3871 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
3872 % all lower-level sectioning counters to zero.
3874 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3875 % (e.g., figures), q.v. By default (before any chapter), that is empty.
3876 \let\chaplevelprefix = \empty
3878 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3880 % section resetting is \global in case the chapter is in a group, such
3881 % as an @include file.
3882 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3883 \global\advance\chapno by 1
3886 \gdef\chaplevelprefix{\the\chapno.}%
3889 \message{\putwordChapter\space \the\chapno}%
3891 % Write the actual heading.
3892 \chapmacro{#1}{Ynumbered}{\the\chapno}%
3894 % So @section and the like are numbered underneath this chapter.
3895 \global\let\section = \numberedsec
3896 \global\let\subsection = \numberedsubsec
3897 \global\let\subsubsection = \numberedsubsubsec
3900 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3901 \def\appendixzzz#1{%
3902 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3903 \global\advance\appendixno by 1
3904 \gdef\chaplevelprefix{\appendixletter.}%
3907 \def\appendixnum{\putwordAppendix\space \appendixletter}%
3908 \message{\appendixnum}%
3910 \chapmacro{#1}{Yappendix}{\appendixletter}%
3912 \global\let\section = \appendixsec
3913 \global\let\subsection = \appendixsubsec
3914 \global\let\subsubsection = \appendixsubsubsec
3917 % @centerchap is like @unnumbered, but the heading is centered.
3918 \outer\parseargdef\centerchap{{\unnumberedyyy{#1}}}
3920 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3921 \def\unnumberedzzz#1{%
3922 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3923 \global\advance\unnumberedno by 1
3925 % Since an unnumbered has no number, no prefix for figures.
3926 \global\let\chaplevelprefix = \empty
3929 % This used to be simply \message{#1}, but TeX fully expands the
3930 % argument to \message. Therefore, if #1 contained @-commands, TeX
3931 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3932 % expanded @cite (which turns out to cause errors because \cite is meant
3933 % to be executed, not expanded).
3935 % Anyway, we don't want the fully-expanded definition of @cite to appear
3936 % as a result of the \message, we just want `@cite' itself. We use
3937 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3938 % simply yielding the contents of <toks register>. (We also do this for
3941 \message{(\the\toks0)}%
3943 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
3945 \global\let\section = \unnumberedsec
3946 \global\let\subsection = \unnumberedsubsec
3947 \global\let\subsubsection = \unnumberedsubsubsec
3950 % @top is like @unnumbered.
3954 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
3956 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3957 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3960 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
3961 \def\appendixsectionzzz#1{%
3962 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3963 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3965 \let\appendixsec\appendixsection
3967 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
3968 \def\unnumberedseczzz#1{%
3969 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3970 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3974 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
3975 \def\numberedsubseczzz#1{%
3976 \global\subsubsecno=0 \global\advance\subsecno by 1
3977 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3980 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
3981 \def\appendixsubseczzz#1{%
3982 \global\subsubsecno=0 \global\advance\subsecno by 1
3983 \sectionheading{#1}{subsec}{Yappendix}%
3984 {\appendixletter.\the\secno.\the\subsecno}%
3987 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3988 \def\unnumberedsubseczzz#1{%
3989 \global\subsubsecno=0 \global\advance\subsecno by 1
3990 \sectionheading{#1}{subsec}{Ynothing}%
3991 {\the\unnumberedno.\the\secno.\the\subsecno}%
3995 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
3996 \def\numberedsubsubseczzz#1{%
3997 \global\advance\subsubsecno by 1
3998 \sectionheading{#1}{subsubsec}{Ynumbered}%
3999 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4002 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4003 \def\appendixsubsubseczzz#1{%
4004 \global\advance\subsubsecno by 1
4005 \sectionheading{#1}{subsubsec}{Yappendix}%
4006 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4009 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4010 \def\unnumberedsubsubseczzz#1{%
4011 \global\advance\subsubsecno by 1
4012 \sectionheading{#1}{subsubsec}{Ynothing}%
4013 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4016 % These are variants which are not "outer", so they can appear in @ifinfo.
4017 % Actually, they are now be obsolete; ordinary section commands should work.
4018 \def\infotop{\parsearg\unnumberedzzz}
4019 \def\infounnumbered{\parsearg\unnumberedzzz}
4020 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
4021 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
4022 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
4024 \def\infoappendix{\parsearg\appendixzzz}
4025 \def\infoappendixsec{\parsearg\appendixseczzz}
4026 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
4027 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
4029 \def\infochapter{\parsearg\chapterzzz}
4030 \def\infosection{\parsearg\sectionzzz}
4031 \def\infosubsection{\parsearg\subsectionzzz}
4032 \def\infosubsubsection{\parsearg\subsubsectionzzz}
4034 % These macros control what the section commands do, according
4035 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4036 % Define them by default for a numbered chapter.
4037 \let\section = \numberedsec
4038 \let\subsection = \numberedsubsec
4039 \let\subsubsection = \numberedsubsubsec
4041 % Define @majorheading, @heading and @subheading
4043 % NOTE on use of \vbox for chapter headings, section headings, and such:
4044 % 1) We use \vbox rather than the earlier \line to permit
4045 % overlong headings to fold.
4046 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4047 % heading is obnoxious; this forbids it.
4048 % 3) Likewise, headings look best if no \parindent is used, and
4049 % if justification is not attempted. Hence \raggedright.
4053 {\advance\chapheadingskip by 10pt \chapbreak }%
4054 \parsearg\chapheadingzzz
4057 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4058 \def\chapheadingzzz#1{%
4059 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4060 \parindent=0pt\raggedright
4062 \bigskip \par\penalty 200\relax
4063 \suppressfirstparagraphindent
4066 % @heading, @subheading, @subsubheading.
4067 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4068 \suppressfirstparagraphindent}
4069 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4070 \suppressfirstparagraphindent}
4071 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4072 \suppressfirstparagraphindent}
4074 % These macros generate a chapter, section, etc. heading only
4075 % (including whitespace, linebreaking, etc. around it),
4076 % given all the information in convenient, parsed form.
4078 %%% Args are the skip and penalty (usually negative)
4079 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4081 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4083 %%% Define plain chapter starts, and page on/off switching for it
4084 % Parameter controlling skip before chapter headings (if needed)
4086 \newskip\chapheadingskip
4088 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4089 \def\chappager{\par\vfill\supereject}
4090 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4092 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4095 \global\let\contentsalignmacro = \chappager
4096 \global\let\pchapsepmacro=\chapbreak
4097 \global\let\pagealignmacro=\chappager}
4100 \global\let\contentsalignmacro = \chappager
4101 \global\let\pchapsepmacro=\chappager
4102 \global\let\pagealignmacro=\chappager
4103 \global\def\HEADINGSon{\HEADINGSsingle}}
4106 \global\let\contentsalignmacro = \chapoddpage
4107 \global\let\pchapsepmacro=\chapoddpage
4108 \global\let\pagealignmacro=\chapoddpage
4109 \global\def\HEADINGSon{\HEADINGSdouble}}
4114 \global\let\chapmacro=\chfplain
4115 \global\let\centerchapmacro=\centerchfplain}
4117 % Normal chapter opening.
4119 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4120 % Yappendix, Yomitfromtoc), #3 the chapter number.
4122 % To test against our argument.
4123 \def\Ynothingkeyword{Ynothing}
4124 \def\Yomitfromtockeyword{Yomitfromtoc}
4125 \def\Yappendixkeyword{Yappendix}
4127 \def\chfplain#1#2#3{%
4132 % Have to define \thissection before calling \donoderef, because the
4133 % xref code eventually uses it. On the other hand, it has to be called
4134 % after \pchapsepmacro, or the headline will change too soon.
4135 \gdef\thissection{#1}%
4136 \gdef\thischaptername{#1}%
4138 % Only insert the separating space if we have a chapter/appendix
4139 % number, and don't print the unnumbered ``number''.
4141 \ifx\temptype\Ynothingkeyword
4143 \def\toctype{unnchap}%
4144 \def\thischapter{#1}%
4145 \else\ifx\temptype\Yomitfromtockeyword
4146 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4148 \xdef\thischapter{}%
4149 \else\ifx\temptype\Yappendixkeyword
4150 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4152 % We don't substitute the actual chapter name into \thischapter
4153 % because we don't want its macros evaluated now. And we don't
4154 % use \thissection because that changes with each section.
4156 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4157 \noexpand\thischaptername}%
4159 \setbox0 = \hbox{#3\enspace}%
4160 \def\toctype{numchap}%
4161 \xdef\thischapter{\putwordChapter{} \the\chapno:
4162 \noexpand\thischaptername}%
4165 % Write the toc entry for this chapter. Must come before the
4166 % \donoderef, because we include the current node name in the toc
4167 % entry, and \donoderef resets it to empty.
4168 \writetocentry{\toctype}{#1}{#3}%
4170 % For pdftex, we have to write out the node definition (aka, make
4171 % the pdfdest) after any page break, but before the actual text has
4172 % been typeset. If the destination for the pdf outline is after the
4173 % text, then jumping from the outline may wind up with the text not
4174 % being visible, for instance under high magnification.
4177 % Typeset the actual heading.
4178 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4179 \hangindent=\wd0 \centerparametersmaybe
4182 \nobreak\bigskip % no page break after a chapter title
4186 % @centerchap -- centered and unnumbered.
4187 \let\centerparametersmaybe = \relax
4188 \def\centerchfplain#1{{%
4189 \def\centerparametersmaybe{%
4190 \advance\rightskip by 3\rightskip
4191 \leftskip = \rightskip
4194 \chfplain{#1}{Ynothing}{}%
4197 \CHAPFplain % The default
4199 % I don't think this chapter style is supported any more, so I'm not
4200 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4202 \def\unnchfopen #1{%
4203 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4204 \parindent=0pt\raggedright
4205 \rm #1\hfill}}\bigskip \par\nobreak
4208 \def\chfopen #1#2{\chapoddpage {\chapfonts
4209 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4213 \def\centerchfopen #1{%
4214 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4216 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4220 \global\let\chapmacro=\chfopen
4221 \global\let\centerchapmacro=\centerchfopen}
4224 % Section titles. These macros combine the section number parts and
4225 % call the generic \sectionheading to do the printing.
4227 \newskip\secheadingskip
4228 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4230 % Subsection titles.
4231 \newskip\subsecheadingskip
4232 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4234 % Subsubsection titles.
4235 \def\subsubsecheadingskip{\subsecheadingskip}
4236 \def\subsubsecheadingbreak{\subsecheadingbreak}
4239 % Print any size, any type, section title.
4241 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4242 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4245 \def\sectionheading#1#2#3#4{%
4247 % Switch to the right set of fonts.
4248 \csname #2fonts\endcsname \rm
4250 % Insert space above the heading.
4251 \csname #2headingbreak\endcsname
4253 % Only insert the space after the number if we have a section number.
4254 \def\sectionlevel{#2}%
4257 \ifx\temptype\Ynothingkeyword
4260 \gdef\thissection{#1}%
4261 \else\ifx\temptype\Yomitfromtockeyword
4262 % for @headings -- no section number, don't include in toc,
4263 % and don't redefine \thissection.
4266 \let\sectionlevel=\empty
4267 \else\ifx\temptype\Yappendixkeyword
4268 \setbox0 = \hbox{#4\enspace}%
4270 \gdef\thissection{#1}%
4272 \setbox0 = \hbox{#4\enspace}%
4274 \gdef\thissection{#1}%
4277 % Write the toc entry (before \donoderef). See comments in \chfplain.
4278 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4280 % Write the node reference (= pdf destination for pdftex).
4281 % Again, see comments in \chfplain.
4284 % Output the actual section heading.
4285 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4286 \hangindent=\wd0 % zero if no section number
4289 % Add extra space after the heading -- half of whatever came above it.
4290 % Don't allow stretch, though.
4291 \kern .5 \csname #2headingskip\endcsname
4293 % Do not let the kern be a potential breakpoint, as it would be if it
4294 % was followed by glue.
4297 % We'll almost certainly start a paragraph next, so don't let that
4298 % glue accumulate. (Not a breakpoint because it's preceded by a
4299 % discardable item.)
4302 % This \nobreak is purely so the last item on the list is a \penalty
4303 % of 10000. This is so other code, for instance \parsebodycommon, can
4304 % check for and avoid allowing breakpoints. Otherwise, it would
4305 % insert a valid breakpoint between:
4306 % @section sec-whatever
4307 % @deffn def-whatever
4313 % Table of contents.
4316 % Write an entry to the toc file, opening it if necessary.
4317 % Called from @chapter, etc.
4319 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4320 % We append the current node name (if any) and page number as additional
4321 % arguments for the \{chap,sec,...}entry macros which will eventually
4322 % read this. The node name is used in the pdf outlines as the
4323 % destination to jump to.
4325 % We open the .toc file for writing here instead of at @setfilename (or
4326 % any other fixed time) so that @contents can be anywhere in the document.
4327 % But if #1 is `omit', then we don't do anything. This is used for the
4328 % table of contents chapter openings themselves.
4330 \newif\iftocfileopened
4331 \def\omitkeyword{omit}%
4333 \def\writetocentry#1#2#3{%
4334 \edef\writetoctype{#1}%
4335 \ifx\writetoctype\omitkeyword \else
4336 \iftocfileopened\else
4337 \immediate\openout\tocfile = \jobname.toc
4338 \global\tocfileopenedtrue
4343 \toks2 = \expandafter{\lastnode}%
4344 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4345 {\the\toks2}{\noexpand\folio}}}%
4350 % Tell \shipout to create a pdf destination on each page, if we're
4351 % writing pdf. These are used in the table of contents. We can't
4352 % just write one on every page because the title pages are numbered
4353 % 1 and 2 (the page numbers aren't printed), and so are the first
4354 % two pages of the document. Thus, we'd have two destinations named
4355 % `1', and two named `2'.
4356 \ifpdf \global\pdfmakepagedesttrue \fi
4359 \newskip\contentsrightmargin \contentsrightmargin=1in
4360 \newcount\savepageno
4361 \newcount\lastnegativepageno \lastnegativepageno = -1
4363 % Prepare to read what we've written to \tocfile.
4365 \def\startcontents#1{%
4366 % If @setchapternewpage on, and @headings double, the contents should
4367 % start on an odd page, unlike chapters. Thus, we maintain
4368 % \contentsalignmacro in parallel with \pagealignmacro.
4369 % From: Torbjorn Granlund <tege@matematik.su.se>
4371 \immediate\closeout\tocfile
4373 % Don't need to put `Contents' or `Short Contents' in the headline.
4374 % It is abundantly clear what they are.
4376 \chapmacro{#1}{Yomitfromtoc}{}%
4378 \savepageno = \pageno
4379 \begingroup % Set up to handle contents files properly.
4380 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4381 % We can't do this, because then an actual ^ in a section
4382 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4383 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4384 \raggedbottom % Worry more about breakpoints than the bottom.
4385 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4387 % Roman numerals for page numbers.
4388 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4392 % Normal (long) toc.
4394 \startcontents{\putwordTOC}%
4395 \openin 1 \jobname.toc
4400 \contentsalignmacro % in case @setchapternewpage odd is in effect
4406 \lastnegativepageno = \pageno
4407 \global\pageno = \savepageno
4410 % And just the chapters.
4411 \def\summarycontents{%
4412 \startcontents{\putwordShortTOC}%
4414 \let\numchapentry = \shortchapentry
4415 \let\appentry = \shortchapentry
4416 \let\unnchapentry = \shortunnchapentry
4417 % We want a true roman here for the page numbers.
4419 \let\rm=\shortcontrm \let\bf=\shortcontbf
4420 \let\sl=\shortcontsl \let\tt=\shortconttt
4422 \hyphenpenalty = 10000
4423 \advance\baselineskip by 1pt % Open it up a little.
4424 \def\numsecentry##1##2##3##4{}
4425 \let\appsecentry = \numsecentry
4426 \let\unnsecentry = \numsecentry
4427 \let\numsubsecentry = \numsecentry
4428 \let\appsubsecentry = \numsecentry
4429 \let\unnsubsecentry = \numsecentry
4430 \let\numsubsubsecentry = \numsecentry
4431 \let\appsubsubsecentry = \numsecentry
4432 \let\unnsubsubsecentry = \numsecentry
4433 \openin 1 \jobname.toc
4439 \contentsalignmacro % in case @setchapternewpage odd is in effect
4441 \lastnegativepageno = \pageno
4442 \global\pageno = \savepageno
4444 \let\shortcontents = \summarycontents
4446 % Typeset the label for a chapter or appendix for the short contents.
4447 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4449 \def\shortchaplabel#1{%
4450 % This space should be enough, since a single number is .5em, and the
4451 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4452 % But use \hss just in case.
4453 % (This space doesn't include the extra space that gets added after
4454 % the label; that gets put in by \shortchapentry above.)
4456 % We'd like to right-justify chapter numbers, but that looks strange
4457 % with appendix letters. And right-justifying numbers and
4458 % left-justifying letters looks strange when there is less than 10
4459 % chapters. Have to read the whole toc once to know how many chapters
4460 % there are before deciding ...
4461 \hbox to 1em{#1\hss}%
4464 % These macros generate individual entries in the table of contents.
4465 % The first argument is the chapter or section name.
4466 % The last argument is the page number.
4467 % The arguments in between are the chapter number, section number, ...
4469 % Chapters, in the main contents.
4470 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4472 % Chapters, in the short toc.
4473 % See comments in \dochapentry re vbox and related settings.
4474 \def\shortchapentry#1#2#3#4{%
4475 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4478 % Appendices, in the main contents.
4479 % Need the word Appendix, and a fixed-size box.
4481 \def\appendixbox#1{%
4482 % We use M since it's probably the widest letter.
4483 \setbox0 = \hbox{\putwordAppendix{} M}%
4484 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4486 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4488 % Unnumbered chapters.
4489 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4490 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4493 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4494 \let\appsecentry=\numsecentry
4495 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4498 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4499 \let\appsubsecentry=\numsubsecentry
4500 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4502 % And subsubsections.
4503 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4504 \let\appsubsubsecentry=\numsubsubsecentry
4505 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4507 % This parameter controls the indentation of the various levels.
4508 % Same as \defaultparindent.
4509 \newdimen\tocindent \tocindent = 15pt
4511 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4514 % If the toc has to be broken over pages, we want it to be at chapters
4515 % if at all possible; hence the \penalty.
4516 \def\dochapentry#1#2{%
4517 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4520 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4522 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4525 \def\dosecentry#1#2{\begingroup
4526 \secentryfonts \leftskip=\tocindent
4527 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4530 \def\dosubsecentry#1#2{\begingroup
4531 \subsecentryfonts \leftskip=2\tocindent
4532 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4535 \def\dosubsubsecentry#1#2{\begingroup
4536 \subsubsecentryfonts \leftskip=3\tocindent
4537 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4540 % We use the same \entry macro as for the index entries.
4541 \let\tocentry = \entry
4543 % Space between chapter (or whatever) number and the title.
4544 \def\labelspace{\hskip1em \relax}
4546 \def\dopageno#1{{\rm #1}}
4547 \def\doshortpageno#1{{\rm #1}}
4549 \def\chapentryfonts{\secfonts \rm}
4550 \def\secentryfonts{\textfonts}
4551 \def\subsecentryfonts{\textfonts}
4552 \def\subsubsecentryfonts{\textfonts}
4555 \message{environments,}
4556 % @foo ... @end foo.
4558 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4560 % Since these characters are used in examples, it should be an even number of
4561 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4564 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4565 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4566 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4567 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4569 % The @error{} command.
4570 % Adapted from the TeXbook's \boxit.
4574 {\tentt \global\dimen0 = 3em}% Width of the box.
4575 \dimen2 = .55pt % Thickness of rules
4576 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4577 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4579 \setbox\errorbox=\hbox to \dimen0{\hfil
4580 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4581 \advance\hsize by -2\dimen2 % Rules.
4583 \hrule height\dimen2
4584 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4585 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4586 \kern3pt\vrule width\dimen2}% Space to right.
4587 \hrule height\dimen2}
4590 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4592 % @tex ... @end tex escapes into raw Tex temporarily.
4593 % One exception: @ is still an escape character, so that @end tex works.
4594 % But \@ or @@ will get a plain tex @ character.
4597 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4598 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4599 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4609 \let\bullet=\ptexbullet
4614 \let\equiv=\ptexequiv
4617 \let\indent=\ptexindent
4618 \let\noindent=\ptexnoindent
4626 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4627 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4630 % There is no need to define \Etex.
4632 % Define @lisp ... @end lisp.
4633 % @lisp environment forms a group so it can rebind things,
4634 % including the definition of @end lisp (which normally is erroneous).
4636 % Amount to narrow the margins by for @lisp.
4637 \newskip\lispnarrowing \lispnarrowing=0.4in
4639 % This is the definition that ^^M gets inside @lisp, @example, and other
4640 % such environments. \null is better than a space, since it doesn't
4642 \def\lisppar{\null\endgraf}
4644 % This space is always present above and below environments.
4645 \newskip\envskipamount \envskipamount = 0pt
4647 % Make spacing and below environment symmetrical. We use \parskip here
4648 % to help in doing that, since in @example-like environments \parskip
4649 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4650 % start of the next paragraph will insert \parskip.
4652 \def\aboveenvbreak{{%
4653 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4654 \ifnum \lastpenalty=10000 \else
4655 \advance\envskipamount by \parskip
4657 \ifdim\lastskip<\envskipamount
4659 % it's not a good place to break if the last penalty was \nobreak
4661 \ifnum\lastpenalty<10000 \penalty-50 \fi
4662 \vskip\envskipamount
4667 \let\afterenvbreak = \aboveenvbreak
4669 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4670 \let\nonarrowing=\relax
4672 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4673 % environment contents.
4674 \font\circle=lcircle10
4676 \newdimen\cartouter\newdimen\cartinner
4677 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4678 \circthick=\fontdimen8\circle
4680 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4681 \def\ctr{{\hskip 6pt\circle\char'010}}
4682 \def\cbl{{\circle\char'012\hskip -6pt}}
4683 \def\cbr{{\hskip 6pt\circle\char'011}}
4684 \def\carttop{\hbox to \cartouter{\hskip\lskip
4685 \ctl\leaders\hrule height\circthick\hfil\ctr
4687 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4688 \cbl\leaders\hrule height\circthick\hfil\cbr
4691 \newskip\lskip\newskip\rskip
4694 \ifhmode\par\fi % can't be in the midst of a paragraph.
4696 \lskip=\leftskip \rskip=\rightskip
4697 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4698 \cartinner=\hsize \advance\cartinner by-\lskip
4699 \advance\cartinner by-\rskip
4701 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4702 % side, and for 6pt waste from
4703 % each corner char, and rule thickness
4704 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4705 % Flag to tell @lisp, etc., not to narrow margin.
4706 \let\nonarrowing=\comment
4708 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4716 \baselineskip=\normbskip
4717 \lineskip=\normlskip
4720 \comment % For explanation, see the end of \def\group.
4735 % This macro is called at the beginning of all the @example variants,
4739 \hfuzz = 12pt % Don't be fussy
4740 \sepspaces % Make spaces be word-separators rather than space tokens.
4741 \let\par = \lisppar % don't ignore blank lines
4742 \obeylines % each line of input is a line of output
4745 \emergencystretch = 0pt % don't try to avoid overfull boxes
4746 % @cartouche defines \nonarrowing to inhibit narrowing
4747 % at next level down.
4748 \ifx\nonarrowing\relax
4749 \advance \leftskip by \lispnarrowing
4750 \exdentamount=\lispnarrowing
4752 \let\exdent=\nofillexdent
4755 % If you want all examples etc. small: @set dispenvsize small.
4756 % If you want even small examples the full size: @set dispenvsize nosmall.
4757 % This affects the following displayed environments:
4758 % @example, @display, @format, @lisp
4760 \def\smallword{small}
4761 \def\nosmallword{nosmall}
4762 \let\SETdispenvsize\relax
4763 \def\setnormaldispenv{%
4764 \ifx\SETdispenvsize\smallword
4765 \smallexamplefonts \rm
4768 \def\setsmalldispenv{%
4769 \ifx\SETdispenvsize\nosmallword
4771 \smallexamplefonts \rm
4775 % We often define two environments, @foo and @smallfoo.
4776 % Let's do it by one command:
4777 \def\makedispenv #1#2{
4778 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4779 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4780 \expandafter\let\csname E#1\endcsname \afterenvbreak
4781 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4784 % Define two synonyms:
4785 \def\maketwodispenvs #1#2#3{
4786 \makedispenv{#1}{#3}
4787 \makedispenv{#2}{#3}
4790 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4792 % @smallexample and @smalllisp: use smaller fonts.
4793 % Originally contributed by Pavel@xerox.
4795 \maketwodispenvs {lisp}{example}{%
4798 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4799 \gobble % eat return
4802 % @display/@smalldisplay: same as @lisp except keep current font.
4804 \makedispenv {display}{%
4809 % @format/@smallformat: same as @display except don't narrow margins.
4811 \makedispenv{format}{%
4812 \let\nonarrowing = t%
4817 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4819 \let\nonarrowing = t%
4823 \let\Eflushleft = \afterenvbreak
4827 \envdef\flushright{%
4828 \let\nonarrowing = t%
4830 \advance\leftskip by 0pt plus 1fill
4833 \let\Eflushright = \afterenvbreak
4836 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4837 % and narrows the margins.
4840 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4843 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4844 \ifx\nonarrowing\relax
4845 \advance\leftskip by \lispnarrowing
4846 \advance\rightskip by \lispnarrowing
4847 \exdentamount = \lispnarrowing
4848 \let\nonarrowing = \relax
4850 \parsearg\quotationlabel
4853 % We have retained a nonzero parskip for the environment, since we're
4854 % doing normal filling. So to avoid extra space below the environment...
4855 \def\Equotation{\parskip = 0pt \afterenvbreak}
4857 % If we're given an argument, typeset it in bold with a colon after.
4858 \def\quotationlabel#1{%
4860 \ifx\temp\empty \else
4866 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4867 % If we want to allow any <char> as delimiter,
4868 % we need the curly braces so that makeinfo sees the @verb command, eg:
4869 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4871 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4873 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4874 % active too. Otherwise, they get lost as the first character on a
4877 \do\ \do\\\do\{\do\}\do\$\do\&%
4878 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4879 \do\<\do\>\do\|\do\@\do+\do\"%
4883 \def\uncatcodespecials{%
4884 \def\do##1{\catcode`##1=\other}\dospecials}
4886 % [Knuth] pp. 380,381,391
4887 % Disable Spanish ligatures ?` and !` of \tt font
4889 \catcode`\`=\active\gdef`{\relax\lq}
4892 % Setup for the @verb command.
4894 % Eight spaces for a tab
4896 \catcode`\^^I=\active
4897 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4901 \tt % easiest (and conventionally used) font for verbatim
4902 \def\par{\leavevmode\endgraf}%
4905 % Respect line breaks,
4906 % print special symbols as themselves, and
4907 % make each space count
4908 % must do in this order:
4909 \obeylines \uncatcodespecials \sepspaces
4912 % Setup for the @verbatim environment
4914 % Real tab expansion
4915 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4917 \def\starttabbox{\setbox0=\hbox\bgroup}
4919 \catcode`\^^I=\active
4921 \catcode`\^^I=\active
4922 \def^^I{\leavevmode\egroup
4923 \dimen0=\wd0 % the width so far, or since the previous tab
4924 \divide\dimen0 by\tabw
4925 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4926 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4927 \wd0=\dimen0 \box0 \starttabbox
4931 \def\setupverbatim{%
4933 \advance\leftskip by -\defbodyindent
4934 % Easiest (and conventionally used) font for verbatim
4936 \def\par{\leavevmode\egroup\box0\endgraf}%
4939 % Respect line breaks,
4940 % print special symbols as themselves, and
4941 % make each space count
4942 % must do in this order:
4943 \obeylines \uncatcodespecials \sepspaces
4944 \everypar{\starttabbox}%
4947 % Do the @verb magic: verbatim text is quoted by unique
4948 % delimiter characters. Before first delimiter expect a
4949 % right brace, after last delimiter expect closing brace:
4951 % \def\doverb'{'<char>#1<char>'}'{#1}
4953 % [Knuth] p. 382; only eat outer {}
4955 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
4956 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4959 \def\verb{\begingroup\setupverb\doverb}
4962 % Do the @verbatim magic: define the macro \doverbatim so that
4963 % the (first) argument ends when '@end verbatim' is reached, ie:
4965 % \def\doverbatim#1@end verbatim{#1}
4967 % For Texinfo it's a lot easier than for LaTeX,
4968 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4969 % we need not redefine '\', '{' and '}'.
4971 % Inspired by LaTeX's verbatim command set [latex.ltx]
4976 % ignore everything up to the first ^^M, that's the newline at the end
4977 % of the @verbatim input line itself. Otherwise we get an extra blank
4978 % line in the output.
4979 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
4980 % We really want {...\end verbatim} in the body of the macro, but
4981 % without the active space; thus we have to use \xdef and \gobble.
4985 \setupverbatim\doverbatim
4987 \let\Everbatim = \afterenvbreak
4990 % @verbatiminclude FILE - insert text of file in verbatim environment.
4992 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
4994 \def\doverbatiminclude#1{%
4996 \makevalueexpandable
5003 % @copying ... @end copying.
5004 % Save the text away for @insertcopying later. Many commands won't be
5005 % allowed in this context, but that's ok.
5007 % We save the uninterpreted tokens, rather than creating a box.
5008 % Saving the text in a box would be much easier, but then all the
5009 % typesetting commands (@smallbook, font changes, etc.) have to be done
5010 % beforehand -- and a) we want @copying to be done first in the source
5011 % file; b) letting users define the frontmatter in as flexible order as
5012 % possible is very desirable.
5014 \def\copying{\begingroup
5015 % Define a command to swallow text until we reach `@end copying'.
5016 % \ is the escape char in this texinfo.tex file, so it is the
5017 % delimiter for the command; @ will be the escape char when we read
5018 % it, but that doesn't matter.
5019 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
5021 % We must preserve ^^M's in the input file; see \insertcopying below.
5022 \catcode`\^^M = \active
5026 % What we do to finish off the copying text.
5028 \def\enddocopying{\endgroup\ignorespaces}
5030 % @insertcopying. Here we must play games with ^^M's. On the one hand,
5031 % we need them to delimit commands such as `@end quotation', so they
5032 % must be active. On the other hand, we certainly don't want every
5033 % end-of-line to be a \par, as would happen with the normal active
5034 % definition of ^^M. On the third hand, two ^^M's in a row should still
5037 % Our approach is to make ^^M insert a space and a penalty1 normally;
5038 % then it can also check if \lastpenalty=1. If it does, then manually
5041 % This messes up the normal definitions of @c[omment], so we redefine
5042 % it. Similarly for @ignore. (These commands are used in the gcc
5043 % manual for man page generation.)
5045 % Seems pretty fragile, most line-oriented commands will presumably
5046 % fail, but for the limited use of getting the copying text (which
5047 % should be quite simple) inserted, we can hope it's ok.
5049 {\catcode`\^^M=\active %
5050 \gdef\insertcopying{\begingroup %
5051 \parindent = 0pt % looks wrong on title page
5053 \ifnum \lastpenalty=1 %
5060 % Fix @c[omment] for catcode 13 ^^M's.
5061 \def\c##1^^M{\ignorespaces}%
5064 % Don't bother jumping through all the hoops that \doignore does, it
5065 % would be very hard since the catcodes are already set.
5066 \long\def\ignore##1\end ignore{\ignorespaces}%
5075 \newskip\defbodyindent \defbodyindent=.4in
5076 \newskip\defargsindent \defargsindent=50pt
5077 \newskip\deflastargmargin \deflastargmargin=18pt
5079 % Start the processing of @deffn:
5081 \ifnum\lastpenalty<10000
5084 % If there are two @def commands in a row, we'll have a \nobreak,
5085 % which is there to keep the function description together with its
5086 % header. But if there's nothing but headers, we need to allow a
5087 % break somewhere. Check for penalty 10002 (inserted by
5088 % \defargscommonending) instead of 10000, since the sectioning
5089 % commands insert a \penalty10000, and we don't want to allow a break
5090 % between a section heading and a defun.
5091 \ifnum\lastpenalty=10002 \penalty2000 \fi
5093 % Similarly, after a section heading, do not allow a break.
5094 % But do insert the glue.
5095 \medskip % preceded by discardable penalty, so not a breakpoint
5099 \advance\leftskip by \defbodyindent
5100 \exdentamount=\defbodyindent
5104 % First, check whether we are in the right environment:
5107 % As above, allow line break if we have multiple x headers in a row.
5108 % It's not a great place, though.
5109 \ifnum\lastpenalty=10002 \penalty3000 \fi
5111 % And now, it's time to reuse the body of the original defun:
5112 \expandafter\gobbledefun#1%
5114 \def\gobbledefun#1\startdefun{}
5116 % \printdefunline \deffnheader{text}
5118 \def\printdefunline#1#2{%
5120 % call \deffnheader:
5123 \interlinepenalty = 10000
5124 \advance\rightskip by 0pt plus 1fil
5126 \nobreak\vskip -\parskip
5127 \penalty 10002 % signal to \startdefun and \dodefunx
5128 % Some of the @defun-type tags do not enable magic parentheses,
5129 % rendering the following check redundant. But we don't optimize.
5134 \def\Edefun{\endgraf\medbreak}
5136 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5137 % the only thing remainnig is to define \deffnheader.
5140 \expandafter\let\csname E#1\endcsname = \Edefun
5141 \edef\temp{\noexpand\domakedefun
5142 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5146 % \domakedefun \deffn \deffnx \deffnheader
5148 % Define \deffn and \deffnx, without parameters.
5149 % \deffnheader has to be defined explicitly.
5151 \def\domakedefun#1#2#3{%
5154 \parseargusing\activeparens{\printdefunline#3}%
5156 \def#2{\dodefunx#1}%
5160 %%% Untyped functions:
5162 % @deffn category name args
5163 \makedefun{deffn}{\deffngeneral{}}
5165 % @deffn category class name args
5166 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5168 % \defopon {category on}class name args
5169 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5171 % \deffngeneral {subind}category name args
5173 \def\deffngeneral#1#2 #3 #4\endheader{%
5174 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5175 \dosubind{fn}{\code{#3}}{#1}%
5176 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5179 %%% Typed functions:
5181 % @deftypefn category type name args
5182 \makedefun{deftypefn}{\deftypefngeneral{}}
5184 % @deftypeop category class type name args
5185 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5187 % \deftypeopon {category on}class type name args
5188 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5190 % \deftypefngeneral {subind}category type name args
5192 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5193 \dosubind{fn}{\code{#4}}{#1}%
5194 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5197 %%% Typed variables:
5199 % @deftypevr category type var args
5200 \makedefun{deftypevr}{\deftypecvgeneral{}}
5202 % @deftypecv category class type var args
5203 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5205 % \deftypecvof {category of}class type var args
5206 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5208 % \deftypecvgeneral {subind}category type var args
5210 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5211 \dosubind{vr}{\code{#4}}{#1}%
5212 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5215 %%% Untyped variables:
5217 % @defvr category var args
5218 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5220 % @defcv category class var args
5221 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5223 % \defcvof {category of}class var args
5224 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5227 % @deftp category name args
5228 \makedefun{deftp}#1 #2 #3\endheader{%
5229 \doind{tp}{\code{#2}}%
5230 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5233 % Remaining @defun-like shortcuts:
5234 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5235 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5236 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5237 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5238 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5239 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5240 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5241 \makedefun{defmethod}{\defopon\putwordMethodon}
5242 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5243 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5244 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5246 % \defname, which formats the name of the @def (not the args).
5247 % #1 is the category, such as "Function".
5248 % #2 is the return type, if any.
5249 % #3 is the function name.
5251 % We are followed by (but not passed) the arguments, if any.
5253 \def\defname#1#2#3{%
5254 % Get the values of \leftskip and \rightskip as they were outside the @def...
5255 \advance\leftskip by -\defbodyindent
5257 % How we'll format the type name. Putting it in brackets helps
5258 % distinguish it from the body text that may end up on the next line
5261 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5263 % Figure out line sizes for the paragraph shape.
5264 % The first line needs space for \box0; but if \rightskip is nonzero,
5265 % we need only space for the part of \box0 which exceeds it:
5266 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5267 % The continuations:
5268 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5269 % (plain.tex says that \dimen1 should be used only as global.)
5270 \parshape 2 0in \dimen0 \defargsindent \dimen2
5272 % Put the type name to the right margin.
5275 \hfil\box0 \kern-\hsize
5276 % \hsize has to be shortened this way:
5278 % Intentionally do not respect \rightskip, since we need the space.
5281 % Allow all lines to be underfull without complaint:
5282 \tolerance=10000 \hbadness=10000
5283 \exdentamount=\defbodyindent
5285 % defun fonts. We use typewriter by default (used to be bold) because:
5286 % . we're printing identifiers, they should be in tt in principle.
5287 % . in languages with many accents, such as Czech or French, it's
5288 % common to leave accents off identifiers. The result looks ok in
5289 % tt, but exceedingly strange in rm.
5290 % . we don't want -- and --- to be treated as ligatures.
5291 % . this still does not fix the ?` and !` ligatures, but so far no
5292 % one has made identifiers using them :).
5294 \def\temp{#2}% return value type
5295 \ifx\temp\empty\else \tclose{\temp} \fi
5296 #3% output function name
5298 {\rm\enskip}% hskip 0.5 em of \tenrm
5301 % arguments will be output next, if any.
5304 % Print arguments in slanted typewriter, prevent hyphenation at `-' chars.
5307 % use sl by default (not ttsl), inconsistently with using tt for the
5308 % name. This is because literal text is sometimes needed in the
5309 % argument list (groff manual), and ttsl and tt are not very
5312 \df \sl \hyphenchar\font=0
5313 % On the other hand, if an argument has two dashes (for instance), we
5314 % want a way to get ttsl. Let's try @var for that.
5317 \sl\hyphenchar\font=45
5320 % We want ()&[] to print specially on the defun line.
5323 \catcode`\(=\active \catcode`\)=\active
5324 \catcode`\[=\active \catcode`\]=\active
5328 % Make control sequences which act like normal parenthesis chars.
5329 \let\lparen = ( \let\rparen = )
5331 % Be sure that we always have a definition for `(', etc. For example,
5332 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5333 % so TeX would otherwise complain about undefined control sequence.
5336 \global\let(=\lparen \global\let)=\rparen
5337 \global\let[=\lbrack \global\let]=\rbrack
5340 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5341 \gdef\magicamp{\let&=\amprm}
5344 \newcount\parencount
5346 % If we encounter &foo, then turn on ()-hacking afterwards
5348 \def\amprm#1 {\ampseentrue{\bf\ }}
5352 % At the first level, print parens in roman,
5353 % otherwise use the default font.
5354 \ifnum \parencount=1 \rm \fi
5356 % The \sf parens (in \boldbrax) actually are a little bolder than
5357 % the contained text. This is especially needed for [ and ] .
5361 \def\infirstlevel#1{%
5368 \def\bfafterword#1 {#1 \bf}
5371 \global\advance\parencount by 1
5373 \infirstlevel \bfafterword
5378 \global\advance\parencount by -1
5381 \newcount\brackcount
5383 \global\advance\brackcount by 1
5388 \global\advance\brackcount by -1
5391 \def\checkparencounts{%
5392 \ifnum\parencount=0 \else \badparencount \fi
5393 \ifnum\brackcount=0 \else \badbrackcount \fi
5395 \def\badparencount{%
5396 \errmessage{Unbalanced parentheses in @def}%
5397 \global\parencount=0
5399 \def\badbrackcount{%
5400 \errmessage{Unbalanced square braces in @def}%
5401 \global\brackcount=0
5408 % To do this right we need a feature of e-TeX, \scantokens,
5409 % which we arrange to emulate with a temporary file in ordinary TeX.
5410 \ifx\eTeXversion\undefined
5411 \newwrite\macscribble
5413 \toks0={#1\endinput}%
5414 \immediate\openout\macscribble=\jobname.tmp
5415 \immediate\write\macscribble{\the\toks0}%
5416 \immediate\closeout\macscribble
5424 \let\xeatspaces\eatspaces
5425 % Undo catcode changes of \startcontents and \doprintindex
5426 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5430 % Append \endinput to make sure that TeX does not see the ending newline.
5432 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5434 \scantokens{#1\endinput}%
5438 \newcount\paramno % Count of parameters
5439 \newtoks\macname % Macro name
5440 \newif\ifrecursive % Is it recursive?
5441 \def\macrolist{} % List of all defined macros in the form
5442 % \do\macro1\do\macro2...
5445 % This does \let #1 = #2, except with \csnames.
5447 \expandafter\expandafter
5449 \expandafter\expandafter
5451 \csname#2\endcsname}
5453 % Trim leading and trailing spaces off a string.
5454 % Concepts from aro-bend problem 15 (see CTAN).
5456 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5457 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5458 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5460 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5463 % Trim a single trailing ^^M off a string.
5464 {\catcode`\^^M=\other \catcode`\Q=3%
5465 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5466 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5467 \gdef\eatcrb#1Q#2Q{#1}%
5470 % Macro bodies are absorbed as an argument in a context where
5471 % all characters are catcode 10, 11 or 12, except \ which is active
5472 % (as in normal texinfo). It is necessary to change the definition of \.
5474 % It's necessary to have hard CRs when the macro is executed. This is
5475 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5476 % body, and then making it the \newlinechar in \scanmacro.
5478 \def\macrobodyctxt{%
5489 \catcode`\^^M=\other
5503 % \mbodybackslash is the definition of \ in @macro bodies.
5504 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5505 % where N is the macro parameter number.
5506 % We define \csname macarg.\endcsname to be \realbackslash, so
5507 % \\ in macro replacement text gets you a backslash.
5509 {\catcode`@=0 @catcode`@\=@active
5510 @gdef@usembodybackslash{@let\=@mbodybackslash}
5511 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5513 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5515 \def\macro{\recursivefalse\parsearg\macroxxx}
5516 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5519 \getargs{#1}% now \macname is the macname and \argl the arglist
5520 \ifx\argl\empty % no arguments
5523 \expandafter\parsemargdef \argl;%
5525 \if1\csname ismacro.\the\macname\endcsname
5526 \message{Warning: redefining \the\macname}%
5528 \expandafter\ifx\csname \the\macname\endcsname \relax
5529 \else \errmessage{Macro name \the\macname\space already defined}\fi
5530 \global\cslet{macsave.\the\macname}{\the\macname}%
5531 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5532 % Add the macroname to \macrolist
5533 \toks0 = \expandafter{\macrolist\do}%
5534 \xdef\macrolist{\the\toks0
5535 \expandafter\noexpand\csname\the\macname\endcsname}%
5537 \begingroup \macrobodyctxt
5538 \ifrecursive \expandafter\parsermacbody
5539 \else \expandafter\parsemacbody
5542 \parseargdef\unmacro{%
5543 \if1\csname ismacro.#1\endcsname
5544 \global\cslet{#1}{macsave.#1}%
5545 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5546 % Remove the macro name from \macrolist:
5548 \expandafter\let\csname#1\endcsname \relax
5550 \xdef\macrolist{\macrolist}%
5553 \errmessage{Macro #1 not defined}%
5557 % Called by \do from \dounmacro on each macro. The idea is to omit any
5558 % macro definitions that have been changed to \relax.
5564 \noexpand\do \noexpand #1%
5568 % This makes use of the obscure feature that if the last token of a
5569 % <parameter list> is #, then the preceding argument is delimited by
5570 % an opening brace, and that opening brace is not consumed.
5571 \def\getargs#1{\getargsxxx#1{}}
5572 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5573 \def\getmacname #1 #2\relax{\macname={#1}}
5574 \def\getmacargs#1{\def\argl{#1}}
5576 % Parse the optional {params} list. Set up \paramno and \paramlist
5577 % so \defmacro knows what to do. Define \macarg.blah for each blah
5578 % in the params list, to be ##N where N is the position in that list.
5579 % That gets used by \mbodybackslash (above).
5581 % We need to get `macro parameter char #' into several definitions.
5582 % The technique used is stolen from LaTeX: let \hash be something
5583 % unexpandable, insert that wherever you need a #, and then redefine
5584 % it to # just before using the token list produced.
5586 % The same technique is used to protect \eatspaces till just before
5587 % the macro is used.
5589 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5590 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5591 \def\parsemargdefxxx#1,{%
5592 \if#1;\let\next=\relax
5593 \else \let\next=\parsemargdefxxx
5594 \advance\paramno by 1%
5595 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5596 {\xeatspaces{\hash\the\paramno}}%
5597 \edef\paramlist{\paramlist\hash\the\paramno,}%
5600 % These two commands read recursive and nonrecursive macro bodies.
5601 % (They're different since rec and nonrec macros end differently.)
5603 \long\def\parsemacbody#1@end macro%
5604 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5605 \long\def\parsermacbody#1@end rmacro%
5606 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5608 % This defines the macro itself. There are six cases: recursive and
5609 % nonrecursive macros of zero, one, and many arguments.
5610 % Much magic with \expandafter here.
5611 % \xdef is used so that macro definitions will survive the file
5612 % they're defined in; @include reads the file inside a group.
5614 \let\hash=##% convert placeholders to macro parameter chars
5618 \expandafter\xdef\csname\the\macname\endcsname{%
5619 \noexpand\scanmacro{\temp}}%
5621 \expandafter\xdef\csname\the\macname\endcsname{%
5622 \bgroup\noexpand\macroargctxt
5623 \noexpand\braceorline
5624 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5625 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5626 \egroup\noexpand\scanmacro{\temp}}%
5628 \expandafter\xdef\csname\the\macname\endcsname{%
5629 \bgroup\noexpand\macroargctxt
5630 \noexpand\csname\the\macname xx\endcsname}%
5631 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5632 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5633 \expandafter\expandafter
5635 \expandafter\expandafter
5636 \csname\the\macname xxx\endcsname
5637 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5642 \expandafter\xdef\csname\the\macname\endcsname{%
5643 \noexpand\norecurse{\the\macname}%
5644 \noexpand\scanmacro{\temp}\egroup}%
5646 \expandafter\xdef\csname\the\macname\endcsname{%
5647 \bgroup\noexpand\macroargctxt
5648 \noexpand\braceorline
5649 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5650 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5652 \noexpand\norecurse{\the\macname}%
5653 \noexpand\scanmacro{\temp}\egroup}%
5655 \expandafter\xdef\csname\the\macname\endcsname{%
5656 \bgroup\noexpand\macroargctxt
5657 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5658 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5659 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5660 \expandafter\expandafter
5662 \expandafter\expandafter
5663 \csname\the\macname xxx\endcsname
5666 \noexpand\norecurse{\the\macname}%
5667 \noexpand\scanmacro{\temp}\egroup}%
5671 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5673 % \braceorline decides whether the next nonwhitespace character is a
5674 % {. If so it reads up to the closing }, if not, it reads the whole
5675 % line. Whatever was read is then fed to the next control sequence
5676 % as an argument (by \parsebrace or \parsearg)
5677 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5678 \def\braceorlinexxx{%
5679 \ifx\nchar\bgroup\else
5680 \expandafter\parsearg
5683 % We mant to disable all macros during \shipout so that they are not
5684 % expanded by \write.
5685 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5686 \edef\next{\macrolist}\expandafter\endgroup\next}
5690 % We need some trickery to remove the optional spaces around the equal
5691 % sign. Just make them active and then expand them all to nothing.
5692 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5693 \def\aliasxxx #1{\aliasyyy#1\relax}
5694 \def\aliasyyy #1=#2\relax{%
5696 \expandafter\let\obeyedspace=\empty
5697 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5703 \message{cross references,}
5707 \newif\ifhavexrefs % True if xref values are known.
5708 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5710 % @inforef is relatively simple.
5711 \def\inforef #1{\inforefzzz #1,,,,**}
5712 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5713 node \samp{\ignorespaces#1{}}}
5715 % @node's only job in TeX is to define \lastnode, which is used in
5717 \parseargdef\node{\checkenv{}\nodexxx #1,\finishnodeparse}
5718 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5720 \let\lastnode=\empty
5722 % Write a cross-reference definition for the current node. #1 is the
5723 % type (Ynumbered, Yappendix, Ynothing).
5726 \ifx\lastnode\empty\else
5727 \setref{\lastnode}{#1}%
5728 \global\let\lastnode=\empty
5732 % @anchor{NAME} -- define xref target at arbitrary point.
5734 \newcount\savesfregister
5736 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5737 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5738 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5740 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5741 % anchor), which consists of three parts:
5742 % 1) NAME-title - the current sectioning name taken from \thissection,
5743 % or the anchor name.
5744 % 2) NAME-snt - section number and type, passed as the SNT arg, or
5745 % empty for anchors.
5746 % 3) NAME-pg - the page number.
5748 % This is called from \donoderef, \anchor, and \dofloat. In the case of
5749 % floats, there is an additional part, which is not written here:
5750 % 4) NAME-lof - the text as it should appear in a @listoffloats.
5756 \atdummies % preserve commands, but don't expand them
5759 \edef\writexrdef##1##2{%
5760 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5761 ##1}{##2}}% these are parameters of \writexrdef
5763 \toks0 = \expandafter{\thissection}%
5764 \immediate \writexrdef{title}{\the\toks0 }%
5765 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5766 \writexrdef{pg}{\folio}% will be written later, during \shipout
5771 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5772 % the node name, #2 the name of the Info cross-reference, #3 the printed
5773 % node name, #4 the name of the Info file, #5 the name of the printed
5774 % manual. All but the node name can be omitted.
5776 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5777 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5778 \def\ref#1{\xrefX[#1,,,,,,,]}
5779 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5781 \def\printedmanual{\ignorespaces #5}%
5782 \def\printedrefname{\ignorespaces #3}%
5783 \setbox1=\hbox{\printedmanual\unskip}%
5784 \setbox0=\hbox{\printedrefname\unskip}%
5786 % No printed node name was explicitly given.
5787 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5788 % Use the node name inside the square brackets.
5789 \def\printedrefname{\ignorespaces #1}%
5791 % Use the actual chapter/section title appear inside
5792 % the square brackets. Use the real section title if we have it.
5794 % It is in another manual, so we don't have it.
5795 \def\printedrefname{\ignorespaces #1}%
5798 % We know the real title if we have the xref values.
5799 \def\printedrefname{\refx{#1-title}{}}%
5801 % Otherwise just copy the Info node name.
5802 \def\printedrefname{\ignorespaces #1}%
5808 % Make link in pdf output.
5812 {\turnoffactive \otherbackslash
5813 \ifnum\filenamelength>0
5814 \startlink attr{/Border [0 0 0]}%
5815 goto file{\the\filename.pdf} name{#1}%
5817 \startlink attr{/Border [0 0 0]}%
5818 goto name{\pdfmkpgn{#1}}%
5824 % Float references are printed completely differently: "Figure 1.2"
5825 % instead of "[somenode], p.3". We distinguish them by the
5826 % LABEL-title being set to a magic string.
5828 % Have to otherify everything special to allow the \csname to
5829 % include an _ in the xref name, etc.
5833 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5834 \csname XR#1-title\endcsname
5836 \iffloat\Xthisreftitle
5837 % If the user specified the print name (third arg) to the ref,
5838 % print it instead of our usual "Figure 1.2".
5845 % if the user also gave the printed manual name (fifth arg), append
5848 \space \putwordin{} \cite{\printedmanual}%
5851 % node/anchor (non-float) references.
5853 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5854 % insert empty discretionaries after hyphens, which means that it will
5855 % not find a line break at a hyphen in a node names. Since some manuals
5856 % are best written with fairly long node names, containing hyphens, this
5857 % is a loss. Therefore, we give the text of the node name again, so it
5858 % is as if TeX is seeing it for the first time.
5860 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
5862 % _ (for example) has to be the character _ for the purposes of the
5863 % control sequence corresponding to the node, but it has to expand
5864 % into the usual \leavevmode...\vrule stuff for purposes of
5865 % printing. So we \turnoffactive for the \refx-snt, back on for the
5866 % printing, back off for the \refx-pg.
5867 {\turnoffactive \otherbackslash
5868 % Only output a following space if the -snt ref is nonempty; for
5869 % @unnumbered and @anchor, it won't be.
5870 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5871 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5873 % output the `[mynode]' via a macro so it can be overridden.
5874 \xrefprintnodename\printedrefname
5876 % But we always want a comma and a space:
5879 % output the `page 3'.
5880 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5886 % This macro is called from \xrefX for the `[nodename]' part of xref
5887 % output. It's a separate macro only so it can be changed more easily,
5888 % since square brackets don't work well in some documents. Particularly
5889 % one that Bob is working on :).
5891 \def\xrefprintnodename#1{[#1]}
5893 % Things referred to by \setref.
5899 \putwordChapter@tie \the\chapno
5900 \else \ifnum\subsecno=0
5901 \putwordSection@tie \the\chapno.\the\secno
5902 \else \ifnum\subsubsecno=0
5903 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5905 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5910 \putwordAppendix@tie @char\the\appendixno{}%
5911 \else \ifnum\subsecno=0
5912 \putwordSection@tie @char\the\appendixno.\the\secno
5913 \else \ifnum\subsubsecno=0
5914 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5917 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5921 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5922 % If its value is nonempty, SUFFIX is output afterward.
5928 \expandafter\global\expandafter\let\expandafter\thisrefX
5929 \csname XR#1\endcsname
5932 % If not defined, say something at least.
5933 \angleleft un\-de\-fined\angleright
5936 \message{\linenumber Undefined cross reference `#1'.}%
5939 \global\warnedxrefstrue
5940 \message{Cross reference values unknown; you must run TeX again.}%
5945 % It's defined, so just use it.
5948 #2% Output the suffix in any case.
5951 % This is the macro invoked by entries in the aux file. Usually it's
5952 % just a \def (we prepend XR to the control sequence name to avoid
5953 % collisions). But if this is a float type, we have more work to do.
5956 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
5958 % Was that xref control sequence that we just defined for a float?
5959 \expandafter\iffloat\csname XR#1\endcsname
5960 % it was a float, and we have the (safe) float type in \iffloattype.
5961 \expandafter\let\expandafter\floatlist
5962 \csname floatlist\iffloattype\endcsname
5964 % Is this the first time we've seen this float type?
5965 \expandafter\ifx\floatlist\relax
5966 \toks0 = {\do}% yes, so just \do
5968 % had it before, so preserve previous elements in list.
5969 \toks0 = \expandafter{\floatlist\do}%
5972 % Remember this xref in the control sequence \floatlistFLOATTYPE,
5973 % for later use in \listoffloats.
5974 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
5978 % Read the last existing aux file, if any. No error if none exists.
5981 \openin 1 \jobname.aux
5984 \global\havexrefstrue
5989 \def\readauxfile{\begingroup
5990 \catcode`\^^@=\other
5991 \catcode`\^^A=\other
5992 \catcode`\^^B=\other
5993 \catcode`\^^C=\other
5994 \catcode`\^^D=\other
5995 \catcode`\^^E=\other
5996 \catcode`\^^F=\other
5997 \catcode`\^^G=\other
5998 \catcode`\^^H=\other
5999 \catcode`\^^K=\other
6000 \catcode`\^^L=\other
6001 \catcode`\^^N=\other
6002 \catcode`\^^P=\other
6003 \catcode`\^^Q=\other
6004 \catcode`\^^R=\other
6005 \catcode`\^^S=\other
6006 \catcode`\^^T=\other
6007 \catcode`\^^U=\other
6008 \catcode`\^^V=\other
6009 \catcode`\^^W=\other
6010 \catcode`\^^X=\other
6011 \catcode`\^^Z=\other
6012 \catcode`\^^[=\other
6013 \catcode`\^^\=\other
6014 \catcode`\^^]=\other
6015 \catcode`\^^^=\other
6016 \catcode`\^^_=\other
6017 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6018 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6019 % supported in the main text, it doesn't seem desirable. Furthermore,
6020 % that is not enough: for node names that actually contain a ^
6021 % character, we would end up writing a line like this: 'xrdef {'hat
6022 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6023 % argument, and \hat is not an expandable control sequence. It could
6024 % all be worked out, but why? Either we support ^^ or we don't.
6026 % The other change necessary for this was to define \auxhat:
6027 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6028 % and then to call \auxhat in \setq.
6032 % Special characters. Should be turned off anyway, but...
6045 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6047 % This is to support \ in node names and titles, since the \
6048 % characters end up in a \csname. It's easier than
6049 % leaving it active and making its active definition an actual \
6050 % character. What I don't understand is why it works in the *value*
6051 % of the xrdef. Seems like it should be a catcode12 \, and that
6052 % should not typeset properly. But it works, so I'm moving on for
6053 % now. --karl, 15jan04.
6056 % Make the characters 128-255 be printing characters.
6060 \catcode\count 1=\other
6061 \advance\count 1 by 1
6062 \ifnum \count 1<256 \loop \fi
6066 % @ is our escape character in .aux files, and we need braces.
6075 \message{insertions,}
6076 % including footnotes.
6078 \newcount \footnoteno
6080 % The trailing space in the following definition for supereject is
6081 % vital for proper filling; pages come out unaligned when you do a
6082 % pagealignmacro call if that space before the closing brace is
6083 % removed. (Generally, numeric constants should always be followed by a
6084 % space to prevent strange expansion errors.)
6085 \def\supereject{\par\penalty -20000\footnoteno =0 }
6087 % @footnotestyle is meaningful for info output only.
6088 \let\footnotestyle=\comment
6092 % Auto-number footnotes. Otherwise like plain.
6094 \let\indent=\ptexindent
6095 \let\noindent=\ptexnoindent
6096 \global\advance\footnoteno by \@ne
6097 \edef\thisfootno{$^{\the\footnoteno}$}%
6099 % In case the footnote comes at the end of a sentence, preserve the
6100 % extra spacing after we do the footnote number.
6102 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6104 % Remove inadvertent blank space before typesetting the footnote number.
6110 % Don't bother with the trickery in plain.tex to not require the
6111 % footnote text as a parameter. Our footnotes don't need to be so general.
6113 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6114 % \parseargline) fails inside footnotes because the tokens are fixed when
6115 % the footnote is read. --karl, 16nov96.
6118 \insert\footins\bgroup
6119 % We want to typeset this text as a normal paragraph, even if the
6120 % footnote reference occurs in (for example) a display environment.
6121 % So reset some parameters.
6123 \interlinepenalty\interfootnotelinepenalty
6124 \splittopskip\ht\strutbox % top baseline for broken footnotes
6125 \splitmaxdepth\dp\strutbox
6126 \floatingpenalty\@MM
6131 \parindent\defaultparindent
6135 % Because we use hanging indentation in footnotes, a @noindent appears
6136 % to exdent this text, so make it be a no-op. makeinfo does not use
6137 % hanging indentation so @noindent can still be needed within footnote
6138 % text after an @example or the like (not that this is good style).
6139 \let\noindent = \relax
6141 % Hang the footnote text off the number. Use \everypar in case the
6142 % footnote extends for more than one paragraph.
6143 \everypar = {\hang}%
6144 \textindent{\thisfootno}%
6146 % Don't crash into the line above the footnote text. Since this
6147 % expands into a box, it must come within the paragraph, lest it
6148 % provide a place where TeX can split the footnote.
6150 \futurelet\next\fo@t
6152 }%end \catcode `\@=11
6154 % In case a @footnote appears in a vbox, save the footnote text and create
6155 % the real \insert just after the vbox finished. Otherwise, the insertion
6157 % Similarily, if a @footnote appears inside an alignment, save the footnote
6158 % text to a box and make the \insert when a row of the table is finished.
6159 % And the same can be done for other insert classes. --kasal, 16nov03.
6161 % Replace the \insert primitive by a cheating macro.
6162 % Deeper inside, just make sure that the saved insertions are not spilled
6165 \def\startsavinginserts{%
6166 \ifx \insert\ptexinsert
6167 \let\insert\saveinsert
6169 \let\checkinserts\relax
6173 % This \insert replacement works for both \insert\footins{foo} and
6174 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6177 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6178 \afterassignment\next
6179 % swallow the left brace
6182 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6183 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6185 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6187 \def\placesaveins#1{%
6188 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6192 % eat @SAVE -- beware, all of them have catcode \other:
6194 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6195 \gdef\gobblesave @SAVE{}
6199 \def\newsaveins #1{%
6200 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6203 \def\newsaveinsX #1{%
6204 \csname newbox\endcsname #1%
6205 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6210 \let\checkinserts\empty
6215 % @image. We use the macros from epsf.tex to support this.
6216 % If epsf.tex is not installed and @image is used, we complain.
6218 % Check for and read epsf.tex up front. If we read it only at @image
6219 % time, we might be inside a group, and then its definitions would get
6220 % undone and the next image would fail.
6221 \openin 1 = epsf.tex
6223 % Do not bother showing banner with epsf.tex v2.7k (available in
6224 % doc/epsf.tex and on ctan).
6225 \def\epsfannounce{\toks0 = }%
6230 % We will only complain once about lack of epsf.tex.
6231 \newif\ifwarnednoepsf
6232 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6233 work. It is also included in the Texinfo distribution, or you can get
6234 it from ftp://tug.org/tex/epsf.tex.}
6237 \ifx\epsfbox\undefined
6238 \ifwarnednoepsf \else
6239 \errhelp = \noepsfhelp
6240 \errmessage{epsf.tex not found, images will be ignored}%
6241 \global\warnednoepsftrue
6244 \imagexxx #1,,,,,\finish
6248 % Arguments to @image:
6249 % #1 is (mandatory) image filename; we tack on .eps extension.
6250 % #2 is (optional) width, #3 is (optional) height.
6251 % #4 is (ignored optional) html alt text.
6252 % #5 is (ignored optional) extension.
6253 % #6 is just the usual extra ignored arg for parsing this stuff.
6255 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6256 \catcode`\^^M = 5 % in case we're inside an example
6257 \normalturnoffactive % allow _ et al. in names
6258 % If the image is by itself, center it.
6262 % Usually we'll have text after the image which will insert
6263 % \parskip glue, so insert it here too to equalize the space
6265 \nobreak\vskip\parskip
6272 \dopdfimage{#1}{#2}{#3}%
6274 % \epsfbox itself resets \epsf?size at each figure.
6275 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6276 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6280 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6284 % @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc.
6285 % We don't actually implement floating yet, we just plop the float "here".
6286 % But it seemed the best name for the future.
6288 \envparseargdef\float{\dofloat #1,,,\finish}
6290 % #1 is the optional FLOATTYPE, the text label for this float, typically
6291 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6292 % this float will not be numbered and cannot be referred to.
6294 % #2 is the optional xref label. Also must be present for the float to
6297 % #3 is the optional positioning argument; for now, it is ignored. It
6298 % will somehow specify the positions allowed to float to (here, top, bottom).
6300 % We keep a separate counter for each FLOATTYPE, which we reset at each
6301 % chapter-level command.
6302 \let\resetallfloatnos=\empty
6304 \def\dofloat#1,#2,#3,#4\finish{%
6305 % don't lose footnotes inside @float.
6310 \def\floatlabel{#2}%
6311 \def\floatloc{#3}% we do nothing with this yet.
6313 \ifx\floattype\empty
6314 \let\safefloattype=\empty
6317 % the floattype might have accents or other special characters,
6318 % but we need to use it in a control sequence name.
6321 \xdef\safefloattype{\floattype}%
6325 % If label is given but no type, we handle that as the empty type.
6326 \ifx\floatlabel\empty \else
6327 % We want each FLOATTYPE to be numbered separately (Figure 1,
6328 % Table 1, Figure 2, ...). (And if no label, no number.)
6330 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6331 \global\advance\floatno by 1
6334 % This magic value for \thissection is output by \setref as the
6335 % XREFLABEL-title value. \xrefX uses it to distinguish float
6336 % labels (which have a completely different output format) from
6337 % node and anchor labels. And \xrdef uses it to construct the
6340 \edef\thissection{\floatmagic=\safefloattype}%
6341 \setref{\floatlabel}{Yfloat}%
6346 % we have these possibilities:
6347 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6348 % @float Foo,lbl & no caption: Foo 1.1
6349 % @float ,lbl & Caption{Cap}: 1.1: Cap
6350 % @float ,lbl & no caption: 1.1
6351 % @float & @caption{Cap}: Cap
6352 % @float & no caption:
6355 \let\printedsomething = \empty
6357 \ifx\floattype\empty \else
6358 \vskip.5\parskip % space above caption
6360 % Print the float number preceded by the chapter-level number
6361 % (empty in the case of unnumbered), as in "Figure 1.1". Although
6362 % there are other styles of float numbering, we hardwire this one.
6363 \def\floatident{\floattype\tie\chaplevelprefix\the\floatno}%
6365 \let\printedsomething = t%
6367 % Write the text that goes in the list of floats to the aux file
6368 % as \floatlabel-lof. Besides the float ident, we include the
6369 % short caption if specified, else the full caption if specified,
6372 \atdummies \turnoffactive \otherbackslash
6373 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{%
6375 \ifx\thisshortcaption\empty
6376 \ifx\thiscaption\empty \else
6384 \fi % end have xref label for this float
6386 \ifx\thiscaption\empty \else
6387 \ifx\printedsomething\empty
6388 \vskip.5\parskip % space above caption
6390 :\space % had a number, so print a colon before the caption.
6393 % Print caption text.
6395 \let\printedsomething = t%
6398 % Space below caption, if we printed anything.
6399 \ifx\printedsomething\empty \else \vskip\parskip \fi
6400 \egroup % end of \vtop
6404 \def\caption#1{\checkenv\float \def\thiscaption{#1}}
6405 \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
6406 \let\thiscaption=\empty
6407 \let\thisshortcaption=\empty
6409 % The parameter is the control sequence identifying the counter we are
6410 % going to use. Create it if it doesn't exist and assign it to \floatno.
6413 % Haven't seen this figure type before.
6414 \csname newcount\endcsname #1%
6416 % Remember to reset this floatno at the next chap.
6417 \expandafter\gdef\expandafter\resetallfloatnos
6418 \expandafter{\resetallfloatnos #1=0 }%
6423 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6424 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6425 % first read the @float command.
6427 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6429 % Magic string used for the XREFLABEL-title value, so \xrefX can
6430 % distinguish floats from other xref types.
6431 \def\floatmagic{!!float!!}
6433 % #1 is the control sequence we are passed; we expand into a conditional
6434 % which is true if #1 represents a float ref. That is, the magic
6435 % \thissection value which we \setref above.
6437 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6439 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6440 % (safe) float type for this float. We set \iffloattype to #2.
6442 \def\doiffloat#1=#2=#3\finish{%
6444 \def\iffloattype{#2}%
6445 \ifx\temp\floatmagic
6448 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6450 \parseargdef\listoffloats{%
6451 \def\floattype{#1}% floattype
6453 % the floattype might have accents or other special characters,
6454 % but we need to use it in a control sequence name.
6457 \xdef\safefloattype{\floattype}%
6460 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6461 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6463 % if the user said @listoffloats foo but never @float foo.
6464 \message{\linenumber No `\safefloattype' floats to list.}%
6468 \leftskip=\tocindent % indent these entries like a toc
6469 \let\do=\listoffloatsdo
6470 \csname floatlist\safefloattype\endcsname
6475 % This is called on each entry in a list of floats. We're passed the
6476 % xref label, in the form LABEL-title, which is how we save it in the
6477 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6478 % has the text we're supposed to typeset here.
6480 % Figures without xref labels will not be included in the list (since
6481 % they won't appear in the aux file).
6483 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6484 \def\listoffloatsdoentry#1-title\finish{%
6485 % use the same \entry we use for the TOC.
6486 \entry{\csname XR#1-lof\endcsname}{\csname XR#1-pg\endcsname}%
6489 \message{localization,}
6492 % @documentlanguage is usually given very early, just after
6493 % @setfilename. If done too late, it may not override everything
6494 % properly. Single argument is the language abbreviation.
6495 % It would be nice if we could set up a hyphenation file here.
6497 \parseargdef\documentlanguage{%
6498 \tex % read txi-??.tex file in plain TeX.
6499 % Read the file if it exists.
6500 \openin 1 txi-#1.tex
6502 \errhelp = \nolanghelp
6503 \errmessage{Cannot read language file txi-#1.tex}%
6510 \newhelp\nolanghelp{The given language definition file cannot be found or
6511 is empty. Maybe you need to install it? In the current directory
6512 should work if nowhere else does.}
6515 % @documentencoding should change something in TeX eventually, most
6516 % likely, but for now just recognize it.
6517 \let\documentencoding = \comment
6520 % Page size parameters.
6522 \newdimen\defaultparindent \defaultparindent = 15pt
6524 \chapheadingskip = 15pt plus 4pt minus 2pt
6525 \secheadingskip = 12pt plus 3pt minus 2pt
6526 \subsecheadingskip = 9pt plus 2pt minus 2pt
6528 % Prevent underfull vbox error messages.
6531 % Don't be so finicky about underfull hboxes, either.
6534 % Following George Bush, just get rid of widows and orphans.
6538 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6539 % using an old version of TeX, don't do anything. We want the amount of
6540 % stretch added to depend on the line length, hence the dependence on
6541 % \hsize. We call this whenever the paper size is set.
6543 \def\setemergencystretch{%
6544 \ifx\emergencystretch\thisisundefined
6545 % Allow us to assign to \emergencystretch anyway.
6546 \def\emergencystretch{\dimen0}%
6548 \emergencystretch = .15\hsize
6552 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6553 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6554 % physical page width.
6556 % We also call \setleading{\textleading}, so the caller should define
6557 % \textleading. The caller should also set \parskip.
6559 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6562 \splittopskip = \topskip
6565 \advance\vsize by \topskip
6566 \outervsize = \vsize
6567 \advance\outervsize by 2\topandbottommargin
6568 \pageheight = \vsize
6571 \outerhsize = \hsize
6572 \advance\outerhsize by 0.5in
6575 \normaloffset = #4\relax
6576 \bindingoffset = #5\relax
6579 \pdfpageheight #7\relax
6580 \pdfpagewidth #8\relax
6583 \setleading{\textleading}
6585 \parindent = \defaultparindent
6586 \setemergencystretch
6589 % @letterpaper (the default).
6590 \def\letterpaper{{\globaldefs = 1
6591 \parskip = 3pt plus 2pt minus 1pt
6592 \textleading = 13.2pt
6594 % If page is nothing but text, make it come out even.
6595 \internalpagesizes{46\baselineskip}{6in}%
6597 {\bindingoffset}{36pt}%
6601 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6602 \def\smallbook{{\globaldefs = 1
6603 \parskip = 2pt plus 1pt
6606 \internalpagesizes{7.5in}{5in}%
6608 {\bindingoffset}{16pt}%
6611 \lispnarrowing = 0.3in
6614 \contentsrightmargin = 0pt
6615 \defbodyindent = .5cm
6618 % Use @afourpaper to print on European A4 paper.
6619 \def\afourpaper{{\globaldefs = 1
6620 \parskip = 3pt plus 2pt minus 1pt
6621 \textleading = 13.2pt
6623 % Double-side printing via postscript on Laserjet 4050
6624 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6625 % To change the settings for a different printer or situation, adjust
6626 % \normaloffset until the front-side and back-side texts align. Then
6627 % do the same for \bindingoffset. You can set these for testing in
6628 % your texinfo source file like this:
6630 % \global\normaloffset = -6mm
6631 % \global\bindingoffset = 10mm
6633 \internalpagesizes{51\baselineskip}{160mm}
6634 {\voffset}{\hoffset}%
6635 {\bindingoffset}{44pt}%
6640 \contentsrightmargin = 0pt
6641 \defbodyindent = 5mm
6644 % Use @afivepaper to print on European A5 paper.
6645 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6646 % He also recommends making @example and @lisp be small.
6647 \def\afivepaper{{\globaldefs = 1
6648 \parskip = 2pt plus 1pt minus 0.1pt
6649 \textleading = 12.5pt
6651 \internalpagesizes{160mm}{120mm}%
6652 {\voffset}{\hoffset}%
6653 {\bindingoffset}{8pt}%
6656 \lispnarrowing = 0.2in
6659 \contentsrightmargin = 0pt
6660 \defbodyindent = 2mm
6664 % A specific text layout, 24x15cm overall, intended for A4 paper.
6665 \def\afourlatex{{\globaldefs = 1
6667 \internalpagesizes{237mm}{150mm}%
6669 {\bindingoffset}{7mm}%
6672 % Must explicitly reset to 0 because we call \afourpaper.
6676 % Use @afourwide to print on A4 paper in landscape format.
6677 \def\afourwide{{\globaldefs = 1
6679 \internalpagesizes{241mm}{165mm}%
6680 {\voffset}{-2.95mm}%
6681 {\bindingoffset}{7mm}%
6686 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6687 % Perhaps we should allow setting the margins, \topskip, \parskip,
6688 % and/or leading, also. Or perhaps we should compute them somehow.
6690 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6691 \def\pagesizesyyy#1,#2,#3\finish{{%
6692 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6695 \parskip = 3pt plus 2pt minus 1pt
6696 \setleading{\textleading}%
6699 \advance\dimen0 by \voffset
6702 \advance\dimen2 by \normaloffset
6704 \internalpagesizes{#1}{\hsize}%
6705 {\voffset}{\normaloffset}%
6706 {\bindingoffset}{44pt}%
6710 % Set default to letter.
6715 \message{and turning on texinfo input format.}
6717 % Define macros to output various characters with catcode for normal text.
6727 \def\normaldoublequote{"}
6730 \def\normalunderscore{_}
6731 \def\normalverticalbar{|}
6733 \def\normalgreater{>}
6735 \def\normaldollar{$}%$ font-lock fix
6737 % This macro is used to make a character print one way in \tt
6738 % (where it can probably be output as-is), and another way in other fonts,
6739 % where something hairier probably needs to be done.
6741 % #1 is what to print if we are indeed using \tt; #2 is what to print
6742 % otherwise. Since all the Computer Modern typewriter fonts have zero
6743 % interword stretch (and shrink), and it is reasonable to expect all
6744 % typewriter fonts to have this, we can check that font parameter.
6746 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6748 % Same as above, but check for italic font. Actually this also catches
6749 % non-italic slanted fonts since it is impossible to distinguish them from
6750 % italic fonts. But since this is only used by $ and it uses \sl anyway
6751 % this is not a problem.
6752 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6754 % Turn off all special characters except @
6755 % (and those which the user can use as if they were ordinary).
6756 % Most of these we simply print from the \tt font, but for some, we can
6757 % use math or other variants that look better in normal text.
6760 \def\activedoublequote{{\tt\char34}}
6761 \let"=\activedoublequote
6763 \def~{{\tt\char126}}
6769 \def_{\ifusingtt\normalunderscore\_}
6770 % Subroutine for the previous macro.
6771 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6774 \def|{{\tt\char124}}
6782 \def+{{\tt \char 43}}
6784 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6786 % If a .fmt file is being used, characters that might appear in a file
6787 % name cannot be active until we have parsed the command line.
6788 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6789 % \otherifyactive is called near the end of this file.
6790 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6794 % \backslashcurfont outputs one backslash character in current font,
6796 \global\chardef\backslashcurfont=`\\
6797 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
6799 % \rawbackslash defines an active \ to do \backslashcurfont.
6800 % \otherbackslash defines an active \ to be a literal `\' character with
6802 {\catcode`\\=\active
6803 @gdef@rawbackslash{@let\=@backslashcurfont}
6804 @gdef@otherbackslash{@let\=@realbackslash}
6807 % \realbackslash is an actual character `\' with catcode other.
6808 {\catcode`\\=\other @gdef@realbackslash{\}}
6810 % \normalbackslash outputs one backslash in fixed width font.
6811 \def\normalbackslash{{\tt\backslashcurfont}}
6815 % Used sometimes to turn off (effectively) the active characters
6816 % even after parsing them.
6817 @def@turnoffactive{%
6818 @let"=@normaldoublequote
6819 @let\=@realbackslash
6822 @let_=@normalunderscore
6823 @let|=@normalverticalbar
6825 @let>=@normalgreater
6827 @let$=@normaldollar %$ font-lock fix
6831 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6832 % the literal character `\'. (Thus, \ is not expandable when this is in
6835 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6837 % Make _ and + \other characters, temporarily.
6838 % This is canceled by @fixbackslash.
6841 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6842 % That is what \eatinput is for; after that, the `\' should revert to printing
6845 @gdef@eatinput input texinfo{@fixbackslash}
6846 @global@let\ = @eatinput
6848 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6849 % the first `\{ in the file would cause an error. This macro tries to fix
6850 % that, assuming it is called before the first `\' could plausibly occur.
6851 % Also back turn on active characters that might appear in the input
6852 % file name, in case not using a pre-dumped format.
6854 @gdef@fixbackslash{%
6855 @ifx\@eatinput @let\ = @normalbackslash @fi
6860 % Say @foo, not \foo, in error messages.
6863 % These look ok in all fonts, so just make them not special.
6864 @catcode`@& = @other
6865 @catcode`@# = @other
6866 @catcode`@% = @other
6870 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6871 @c page-delimiter: "^\\\\message"
6872 @c time-stamp-start: "def\\\\texinfoversion{"
6873 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6874 @c time-stamp-end: "}"
6880 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115