update from texinfo
[pspp] / config / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2004-01-17.16}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
10 % Foundation, Inc.
11 %
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.
16 %
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.
21 %
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.
26 %
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.)
30
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.
38 %
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.
42 %
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:
46 %   tex foo.texi
47 %   texindex foo.??
48 %   tex foo.texi
49 %   tex foo.texi
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.
54 %
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.
58
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62 \message{Loading texinfo [version \texinfoversion]:}
63
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}
69
70 \message{Basics,}
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexnoindent=\noindent
93 \let\ptexinsert=\insert
94 \let\ptexlbrace=\{
95 \let\ptexless=<
96 \let\ptexplus=+
97 \let\ptexrbrace=\}
98 \let\ptexslash=\/
99 \let\ptexstar=\*
100 \let\ptext=\t
101
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
105
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.
108 %
109 \ifx\inputlineno\thisisundefined
110   \let\linenumber = \empty % Pre-3.0.
111 \else
112   \def\linenumber{l.\the\inputlineno:\space}
113 \fi
114
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
135 %
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
148 %
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
154
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 = `\_
164
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
168
169 % Ignore a token.
170 %
171 \def\gobble#1{}
172
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
175
176 % Hyphenation fixes.
177 \hyphenation{ap-pen-dix}
178 \hyphenation{eshell}
179 \hyphenation{mini-buf-fer mini-buf-fers}
180 \hyphenation{time-stamp}
181 \hyphenation{white-space}
182
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
187
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).
191 %
192 \def\finalout{\overfullrule=0pt}
193
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).
199 %
200 \def\|{%
201   % \vadjust can only be used in horizontal mode.
202   \leavevmode
203   %
204   % Append this vertical mode material after the current line in the output.
205   \vadjust{%
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.
208     \vskip-\baselineskip
209     %
210     % \vadjust-items are inserted at the left edge of the type.  So
211     % the \llap here moves out into the left-hand margin.
212     \llap{%
213       %
214       % For a thicker or thinner bar, change the `1pt'.
215       \vrule height\baselineskip width1pt
216       %
217       % This is the space between the bar and the text.
218       \hskip 12pt
219     }%
220   }%
221 }
222
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.
228 %
229 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
230 \def\loggingall{%
231   \tracingstats2
232   \tracingpages1
233   \tracinglostchars2  % 2 gives us more in etex
234   \tracingparagraphs1
235   \tracingoutput1
236   \tracingmacros2
237   \tracingrestores1
238   \showboxbreadth\maxdimen \showboxdepth\maxdimen
239   \ifx\eTeXversion\undefined\else % etex gives us more logging
240     \tracingscantokens1
241     \tracingifs1
242     \tracinggroups1
243     \tracingnesting2
244     \tracingassigns1
245   \fi
246   \tracingcommands3  % 3 gives us more in etex
247   \errorcontextlines16
248 }%
249
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.
252 %
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}
259
260 % For @cropmarks command.
261 % Do @cropmarks to get crop marks.
262 %
263 \newif\ifcropmarks
264 \let\cropmarks = \cropmarkstrue
265 %
266 % Dimensions to add cropmarks at corners.
267 % Added by P. A. MacKay, 12 Nov. 1986
268 %
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
273
274 % Main output routine.
275 \chardef\PAGE = 255
276 \output = {\onepageout{\pagecontents\PAGE}}
277
278 \newbox\headlinebox
279 \newbox\footlinebox
280
281 % \onepageout takes a vbox as an argument.  Note that \pagecontents
282 % does insertions, but you have to call it yourself.
283 \def\onepageout#1{%
284   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
285   %
286   \ifodd\pageno  \advance\hoffset by \bindingoffset
287   \else \advance\hoffset by -\bindingoffset\fi
288   %
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}%
293   %
294   {%
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.
298     %
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.
303     \shipout\vbox{%
304       % Do this early so pdf references go to the beginning of the page.
305       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
306       %
307       \ifcropmarks \vbox to \outervsize\bgroup
308         \hsize = \outerhsize
309         \vskip-\topandbottommargin
310         \vtop to0pt{%
311           \line{\ewtop\hfil\ewtop}%
312           \nointerlineskip
313           \line{%
314             \vbox{\moveleft\cornerthick\nstop}%
315             \hfill
316             \vbox{\moveright\cornerthick\nstop}%
317           }%
318           \vss}%
319         \vskip\topandbottommargin
320         \line\bgroup
321           \hfil % center the page within the outer (page) hsize.
322           \ifodd\pageno\hskip\bindingoffset\fi
323           \vbox\bgroup
324       \fi
325       %
326       \unvbox\headlinebox
327       \pagebody{#1}%
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
333         \unvbox\footlinebox
334       \fi
335       %
336       \ifcropmarks
337           \egroup % end of \vbox\bgroup
338         \hfil\egroup % end of (centering) \line\bgroup
339         \vskip\topandbottommargin plus1fill minus1fill
340         \boxmaxdepth = \cornerthick
341         \vbox to0pt{\vss
342           \line{%
343             \vbox{\moveleft\cornerthick\nsbot}%
344             \hfill
345             \vbox{\moveright\cornerthick\nsbot}%
346           }%
347           \nointerlineskip
348           \line{\ewbot\hfil\ewbot}%
349         }%
350       \egroup % \vbox from first cropmarks clause
351       \fi
352     }% end of \shipout\vbox
353   }% end of group with \normalturnoffactive
354   \advancepageno
355   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
356 }
357
358 \newinsert\margin \dimen\margin=\maxdimen
359
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
361 {\catcode`\@ =11
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}
369 }
370
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)
374 %
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
376 \def\nstop{\vbox
377   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
379 \def\nsbot{\vbox
380   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
381
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.
385 %
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
388   \def\next{#2}%
389   \begingroup
390     \obeylines
391     \spaceisspace
392     #1%
393     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
394 }
395
396 {\obeylines %
397   \gdef\parseargline#1^^M{%
398     \endgroup % End of the group started in \parsearg.
399     \argremovecomment #1\comment\ArgTerm%
400   }%
401 }
402
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}
406
407 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
408 %
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.
413 %
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{%
417   \def\temp{#3}%
418   \ifx\temp\empty
419     % We cannot use \next here, as it holds the macro to run;
420     % thus we reuse \temp.
421     \let\temp\finishparsearg
422   \else
423     \let\temp\argcheckspaces
424   \fi
425   % Put the space token in:
426   \temp#1 #3\ArgTerm
427 }
428
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.
436 %
437 % But first, we have to remove the trailing space token.
438 %
439 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
440
441 % \parseargdef\foo{...}
442 %       is roughly equivalent to
443 % \def\foo{\parsearg\Xfoo}
444 % \def\Xfoo#1{...}
445 %
446 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
447 % favourite TeX trick.  --kasal, 16nov03
448
449 \def\parseargdef#1{%
450   \expandafter \doparseargdef \csname\string#1\endcsname #1%
451 }
452 \def\doparseargdef#1#2{%
453   \def#2{\parsearg#1}%
454   \def#1##1%
455 }
456
457 % Several utility definitions with active space:
458 {
459   \obeyspaces
460   \gdef\obeyedspace{ }
461
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.
466   %
467   \gdef\sepspaces{\obeyspaces\let =\tie}
468
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}
473 }
474
475
476 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
477
478 % Define the framework for environments in texinfo.tex.  It's used like this:
479
480 %   \envdef\foo{...}
481 %   \def\Efoo{...}
482 %   
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.
488
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
492 % special case.)
493
494
495 % At runtime, environments start with this:
496 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
497 % initialize
498 \let\thisenv\empty
499
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}}
503
504 % Check whether we're in the right environment:
505 \def\checkenv#1{%
506   \def\temp{#1}%
507   \ifx\thisenv\temp
508   \else
509     \badenverr
510   \fi
511 }
512
513 % Evironment mismatch, #1 expected:
514 \def\badenverr{%
515   \errhelp = \EMsimple
516   \errmessage{This command can appear only \inenvironment\temp,
517     not \inenvironment\thisenv}%
518 }
519 \def\inenvironment#1{%
520   \ifx#1\empty
521     out of any environment%
522   \else
523     in environment \expandafter\string#1%
524   \fi
525 }
526
527 % @end foo executes the definition of \Efoo.
528 % But first, it executes a specialized version of \checkenv
529 %
530 \parseargdef\end{%
531   \if 1\csname iscond.#1\endcsname
532   \else
533     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
534     \expandafter\checkenv\csname#1\endcsname
535     \csname E#1\endcsname
536     \endgroup
537   \fi
538 }
539
540 \newhelp\EMsimple{Press RETURN to continue.}
541
542
543 %% Simple single-character @ commands
544
545 % @@ prints an @
546 % Kludge this until the fonts are right (grr).
547 \def\@{{\tt\char64}}
548
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.
553 %\def\`{{`}}
554 %\def\'{{'}}
555
556 % Used to generate quoted braces.
557 \def\mylbrace {{\tt\char123}}
558 \def\myrbrace {{\tt\char125}}
559 \let\{=\mylbrace
560 \let\}=\myrbrace
561 \begingroup
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
567   !gdef!lbracecmd[\{]%
568   !gdef!rbracecmd[\}]%
569   !gdef!lbraceatcmd[@{]%
570   !gdef!rbraceatcmd[@}]%
571 !endgroup
572
573 % @comma{} to avoid , parsing problems.
574 \let\comma = ,
575
576 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
577 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
578 \let\, = \c
579 \let\dotaccent = \.
580 \def\ringaccent#1{{\accent23 #1}}
581 \let\tieaccent = \t
582 \let\ubaraccent = \b
583 \let\udotaccent = \d
584
585 % Other special characters: @questiondown @exclamdown @ordf @ordm
586 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
587 \def\questiondown{?`}
588 \def\exclamdown{!`}
589 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
590 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
591
592 % Dotless i and dotless j, used for accents.
593 \def\imacro{i}
594 \def\jmacro{j}
595 \def\dotless#1{%
596   \def\temp{#1}%
597   \ifx\temp\imacro \ptexi
598   \else\ifx\temp\jmacro \j
599   \else \errmessage{@dotless can be used only with i or j}%
600   \fi\fi
601 }
602
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.)
605
606 \def\TeX{T\kern-.1667em\lower.5ex\hbox{E}\kern-.125emX\spacefactor=3000 }
607
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).
613
614 \def\LaTeX{%
615   L\kern-.36em
616   {\setbox0=\hbox{T}%
617    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
618   \kern-.15em
619   \TeX
620 }
621
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.
627 {\catcode`@ = 11
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\ }
632 }
633
634 % @: forces normal size whitespace following.
635 \def\:{\spacefactor=1000 }
636
637 % @* forces a line break.
638 \def\*{\hfil\break\hbox{}\ignorespaces}
639
640 % @/ allows a line break.
641 \let\/=\allowbreak
642
643 % @. is an end-of-sentence period.
644 \def\.{.\spacefactor=3000 }
645
646 % @! is an end-of-sentence bang.
647 \def\!{!\spacefactor=3000 }
648
649 % @? is an end-of-sentence query.
650 \def\?{?\spacefactor=3000 }
651
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}}
656
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.
664 %
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).
671 %
672 \newbox\groupbox
673 \def\vfilllimit{0.7}
674 %
675 \envdef\group{%
676   \ifnum\catcode`\^^M=\active \else
677     \errhelp = \groupinvalidhelp
678     \errmessage{@group invalid in context where filling is enabled}%
679   \fi
680   \startsavinginserts
681   %
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.
689     \comment
690 }
691 %
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.
696 \def\Egroup{%
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
710       \page
711     \fi
712   \fi
713   \box\groupbox
714   \prevdepth = \dimen1
715   \checkinserts
716 }
717 %
718 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
719 % message, so this ends up printing `@group can only ...'.
720 %
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.}
724
725 % @need space-in-mils
726 % forces a page break if there is not space-in-mils remaining.
727
728 \newdimen\mil  \mil=0.001in
729
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.
734 %{\baselineskip=0pt%
735 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
736 %\prevdepth=-1000pt
737 %}}
738
739 \parseargdef\need{%
740   % Ensure vertical mode, so we don't make a big box in the middle of a
741   % paragraph.
742   \par
743   %
744   % If the @need value is less than one line space, it's useless.
745   \dimen0 = #1\mil
746   \dimen2 = \ht\strutbox
747   \advance\dimen2 by \dp\strutbox
748   \ifdim\dimen0 > \dimen2
749     %
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}%
754     %
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.
760     %
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.
768     \penalty9999
769     %
770     % Back up by the size of the box, whether we did a page break or not.
771     \kern -#1\mil
772     %
773     % Do not allow a page break right after this kern.
774     \nobreak
775   \fi
776 }
777
778 % @br   forces paragraph break (and is undocumented).
779
780 \let\br = \par
781
782 % @page forces the start of a new page.
783 %
784 \def\page{\par\vfill\supereject}
785
786 % @exdent text....
787 % outputs text on separate line in roman font, starting at standard page margin
788
789 % This records the amount of indent in the innermost environment.
790 % That's how much \exdent should take out.
791 \newskip\exdentamount
792
793 % This defn is used inside fill environments such as @defun.
794 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
795
796 % This defn is used inside nofill environments such as @example.
797 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
798   \leftline{\hskip\leftskip{\rm#1}}}}
799
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'.
803 %
804 \newskip\inmarginspacing \inmarginspacing=1cm
805 \def\strutdepth{\dp\strutbox}
806 %
807 \def\doinmargin#1#2{\strut\vadjust{%
808   \nobreak
809   \kern-\strutdepth
810   \vtop to \strutdepth{%
811     \baselineskip=\strutdepth
812     \vss
813     % if you have multiple lines of stuff to put here, you'll need to
814     % make the vbox yourself of the appropriate size.
815     \ifx#1l%
816       \llap{\ignorespaces #2\hskip\inmarginspacing}%
817     \else
818       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
819     \fi
820     \null
821   }%
822 }}
823 \def\inleftmargin{\doinmargin l}
824 \def\inrightmargin{\doinmargin r}
825 %
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).
829 %
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}%
833   \ifdim\wd0 > 0pt
834     \def\lefttext{#1}%  have both texts
835     \def\righttext{#2}%
836   \else
837     \def\lefttext{#1}%  have only one text
838     \def\righttext{#1}%
839   \fi
840   %
841   \ifodd\pageno
842     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
843   \else
844     \def\temp{\inleftmargin\lefttext}%
845   \fi
846   \temp
847 }
848
849 % @include file    insert text of that file as input.
850 %
851 \def\include{\parseargusing\filenamecatcodes\includezzz}
852 \def\includezzz#1{%
853   \pushthisfilestack
854   \def\thisfile{#1}%
855   {%
856     \makevalueexpandable
857     \def\temp{\input #1 }%
858     \expandafter
859   }\temp
860   \popthisfilestack
861 }
862 \def\filenamecatcodes{%
863   \catcode`\\=\other
864   \catcode`~=\other
865   \catcode`^=\other
866   \catcode`_=\other
867   \catcode`|=\other
868   \catcode`<=\other
869   \catcode`>=\other
870   \catcode`+=\other
871   \catcode`-=\other
872 }
873
874 \def\pushthisfilestack{%
875   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
876 }
877 \def\pushthisfilestackX{%
878   \expandafter\pushthisfilestackY\thisfile\StackTerm
879 }
880 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
881   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
882 }
883
884 \def\popthisfilestack{\errthisfilestackempty}
885 \def\errthisfilestackempty{\errmessage{Internal error:
886   the stack of filenames is empty.}}
887
888 \def\thisfile{}
889
890 % @center line
891 % outputs that line, centered.
892 %
893 \parseargdef\center{%
894   \ifhmode
895     \let\next\centerH
896   \else
897     \let\next\centerV
898   \fi
899   \next{\hfil \ignorespaces#1\unskip \hfil}%
900 }
901 \def\centerH#1{%
902   {%
903     \hfil\break
904     \advance\hsize by -\leftskip
905     \advance\hsize by -\rightskip
906     \line{#1}%
907     \break
908   }%
909 }
910 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
911
912 % @sp n   outputs n lines of vertical space
913
914 \parseargdef\sp{\vskip #1\baselineskip}
915
916 % @comment ...line which is ignored...
917 % @c is the same as @comment
918 % @ignore ... @end ignore  is another way to write a comment
919
920 \def\comment{\begingroup \catcode`\^^M=\other%
921 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
922 \commentxxx}
923 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
924
925 \let\c=\comment
926
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.
931 %
932 \def\asisword{asis} % no translation, these are keywords
933 \def\noneword{none}
934 %
935 \parseargdef\paragraphindent{%
936   \def\temp{#1}%
937   \ifx\temp\asisword
938   \else
939     \ifx\temp\noneword
940       \defaultparindent = 0pt
941     \else
942       \defaultparindent = #1em
943     \fi
944   \fi
945   \parindent = \defaultparindent
946 }
947
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{%
953   \def\temp{#1}%
954   \ifx\temp\asisword
955   \else
956     \ifx\temp\noneword
957       \lispnarrowing = 0pt
958     \else
959       \lispnarrowing = #1em
960     \fi
961   \fi
962 }
963
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
967 % paragraphs.
968 %
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.
973 %
974 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
975 \newdimen\currentparindent
976 %
977 \def\insertword{insert}
978 %
979 \parseargdef\firstparagraphindent{%
980   \def\temp{#1}%
981   \ifx\temp\noneword
982     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
983   \else\ifx\temp\insertword
984     \let\suppressfirstparagraphindent = \relax
985   \else
986     \errhelp = \EMsimple
987     \errmessage{Unknown @firstparagraphindent option `\temp'}%
988   \fi\fi
989 }
990
991 % Here is how we actually suppress indentation.  Redefine \everypar to
992 % \kern backwards by \parindent, and then reset itself to empty.
993 %
994 % We also make \indent itself not actually do anything until the next
995 % paragraph.
996 %
997 \gdef\dosuppressfirstparagraphindent{%
998   \gdef\indent{%
999     \restorefirstparagraphindent
1000     \indent
1001   }%
1002   \gdef\noindent{%
1003     \restorefirstparagraphindent
1004     \noindent
1005   }%
1006   \global\everypar = {%
1007     \kern -\parindent
1008     \restorefirstparagraphindent
1009   }%
1010 }
1011
1012 \gdef\restorefirstparagraphindent{%
1013   \global \let \indent = \ptexindent
1014   \global \let \noindent = \ptexnoindent
1015   \global \everypar = {}%
1016 }
1017
1018
1019 % @asis just yields its argument.  Used with @table, for example.
1020 %
1021 \def\asis#1{#1}
1022
1023 % @math outputs its argument in math mode.
1024 %
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.
1029 {
1030   \catcode\underChar = \active
1031   \gdef\mathunderscore{%
1032     \catcode\underChar=\active
1033     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1034   }
1035 }
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 @\.
1040 %
1041 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1042 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1043 %
1044 \def\math{%
1045   \tex
1046   \mathunderscore
1047   \let\\ = \mathbackslash
1048   \mathactive
1049   $\finishmath
1050 }
1051 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1052
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).
1056 %
1057 {
1058   \catcode`^ = \active
1059   \catcode`< = \active
1060   \catcode`> = \active
1061   \catcode`+ = \active
1062   \gdef\mathactive{%
1063     \let^ = \ptexhat
1064     \let< = \ptexless
1065     \let> = \ptexgtr
1066     \let+ = \ptexplus
1067   }
1068 }
1069
1070 % @bullet and @minus need the same treatment as @math, just above.
1071 \def\bullet{$\ptexbullet$}
1072 \def\minus{$-$}
1073
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.
1077 %
1078 \def\dots{%
1079   \leavevmode
1080   \hbox to 1.5em{%
1081     \hskip 0pt plus 0.25fil
1082     .\hfil.\hfil.%
1083     \hskip 0pt plus 0.5fil
1084   }%
1085 }
1086
1087 % @enddots{} is an end-of-sentence ellipsis.
1088 %
1089 \def\enddots{%
1090   \dots
1091   \spacefactor=3000
1092 }
1093
1094 % @comma{} is so commas can be inserted into text without messing up
1095 % Texinfo's parsing.
1096
1097 \let\comma = ,
1098
1099 % @refill is a no-op.
1100 \let\refill=\relax
1101
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).
1105 %
1106 \newif\iflinks \linkstrue % by default we want the aux files.
1107 \let\novalidate = \linksfalse
1108
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.
1112 \def\setfilename{%
1113    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1114    \iflinks
1115      \tryauxfile
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.
1119    \openindices
1120    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1121    %
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
1126    \closein 1
1127    %
1128    \comment % Ignore the actual filename.
1129 }
1130
1131 % Called from \setfilename.
1132 %
1133 \def\openindices{%
1134   \newindex{cp}%
1135   \newcodeindex{fn}%
1136   \newcodeindex{vr}%
1137   \newcodeindex{tp}%
1138   \newcodeindex{ky}%
1139   \newcodeindex{pg}%
1140 }
1141
1142 % @bye.
1143 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1144
1145
1146 \message{pdf,}
1147 % adobe `portable' document format
1148 \newcount\tempnum
1149 \newcount\lnkcount
1150 \newtoks\filename
1151 \newcount\filenamelength
1152 \newcount\pgn
1153 \newtoks\toksA
1154 \newtoks\toksB
1155 \newtoks\toksC
1156 \newtoks\toksD
1157 \newbox\boxA
1158 \newcount\countA
1159 \newif\ifpdf
1160 \newif\ifpdfmakepagedest
1161
1162 \ifx\pdfoutput\undefined
1163   \pdffalse
1164   \let\pdfmkdest = \gobble
1165   \let\pdfurl = \gobble
1166   \let\endlink = \relax
1167   \let\linkcolor = \relax
1168   \let\pdfmakeoutlines = \relax
1169 \else
1170   \pdftrue
1171   \pdfoutput = 1
1172   \input pdfcolor
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
1180       \immediate\pdfimage
1181     \else
1182       \immediate\pdfximage
1183     \fi
1184       \ifx\empty\imagewidth\else width \imagewidth \fi
1185       \ifx\empty\imageheight\else height \imageheight \fi
1186       \ifnum\pdftexversion<13
1187          #1.pdf%
1188        \else
1189          {#1.pdf}%
1190        \fi
1191     \ifnum\pdftexversion < 14 \else
1192       \pdfrefximage \pdflastximage
1193     \fi}
1194   \def\pdfmkdest#1{{%
1195     % We have to set dummies so commands such as @code in a section title
1196     % aren't expanded.
1197     \atdummies
1198     \normalturnoffactive
1199     \pdfdest name{#1} xyz%
1200   }}
1201   \def\pdfmkpgn#1{#1}
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}}
1211   %
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.
1216   % 
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
1224     %
1225     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1226   }
1227   %
1228   \def\pdfmakeoutlines{%
1229     \begingroup
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
1233       %
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
1239       }%
1240       \def\numsecentry##1##2##3##4{%
1241         \advancenumber{chap\thischapnum}%
1242         \def\thissecnum{##2}%
1243         \let\thissubsecnum\empty
1244       }%
1245       \def\numsubsecentry##1##2##3##4{%
1246         \advancenumber{sec\thissecnum}%
1247         \def\thissubsecnum{##2}%
1248       }%
1249       \def\numsubsubsecentry##1##2##3##4{%
1250         \advancenumber{subsec\thissubsecnum}%
1251       }%
1252       \let\thischapnum\empty
1253       \let\thissecnum\empty
1254       \let\thissubsecnum\empty
1255       %
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}%
1266       \input \jobname.toc
1267       %
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.
1271       % 
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}}%
1281       %
1282       % Make special characters normal for writing to the pdf file.
1283       \indexnofonts
1284       \turnoffactive
1285       \input \jobname.toc
1286     \endgroup
1287   }
1288   %
1289   \def\makelinks #1,{%
1290     \def\params{#1}\def\E{END}%
1291     \ifx\params\E
1292       \let\nextmakelinks=\relax
1293     \else
1294       \let\nextmakelinks=\makelinks
1295       \ifnum\lnkcount>0,\fi
1296       \picknum{#1}%
1297       \startlink attr{/Border [0 0 0]}
1298         goto name{\pdfmkpgn{\the\pgn}}%
1299       \linkcolor #1%
1300       \advance\lnkcount by 1%
1301       \endlink
1302     \fi
1303     \nextmakelinks
1304   }
1305   \def\picknum#1{\expandafter\pn#1}
1306   \def\pn#1{%
1307     \def\p{#1}%
1308     \ifx\p\lbrace
1309       \let\nextpn=\ppn
1310     \else
1311       \let\nextpn=\ppnn
1312       \def\first{#1}
1313     \fi
1314     \nextpn
1315   }
1316   \def\ppn#1{\pgn=#1\gobble}
1317   \def\ppnn{\pgn=\first}
1318   \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1319   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1320   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1321     \ifx\PP\D\let\nextsp\relax
1322     \else\let\nextsp\skipspaces
1323       \ifx\p\space\else\addtokens{\filename}{\PP}%
1324         \advance\filenamelength by 1
1325       \fi
1326     \fi
1327     \nextsp}
1328   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1329   \ifnum\pdftexversion < 14
1330     \let \startlink \pdfannotlink
1331   \else
1332     \let \startlink \pdfstartlink
1333   \fi
1334   \def\pdfurl#1{%
1335     \begingroup
1336       \normalturnoffactive\def\@{@}%
1337       \makevalueexpandable
1338       \leavevmode\Red
1339       \startlink attr{/Border [0 0 0]}%
1340         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1341         % #1
1342     \endgroup}
1343   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1344   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1345   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1346   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1347   \def\maketoks{%
1348     \expandafter\poptoks\the\toksA|ENDTOKS|
1349     \ifx\first0\adn0
1350     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1351     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1352     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1353     \else
1354       \ifnum0=\countA\else\makelink\fi
1355       \ifx\first.\let\next=\done\else
1356         \let\next=\maketoks
1357         \addtokens{\toksB}{\the\toksD}
1358         \ifx\first,\addtokens{\toksB}{\space}\fi
1359       \fi
1360     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1361     \next}
1362   \def\makelink{\addtokens{\toksB}%
1363     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1364   \def\pdflink#1{%
1365     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1366     \linkcolor #1\endlink}
1367   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1368 \fi % \ifx\pdfoutput
1369
1370
1371 \message{fonts,}
1372
1373 % Change the current font style to #1, remembering it in \curfontstyle.
1374 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1375 % italics, not bold italics.
1376
1377 \def\setfontstyle#1{%
1378   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1379   \csname ten#1\endcsname  % change the current font
1380 }
1381
1382 % Select #1 fonts with the current style.
1383
1384 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1385
1386 \def\rm{\fam=0 \setfontstyle{rm}}
1387 \def\it{\fam=\itfam \setfontstyle{it}}
1388 \def\sl{\fam=\slfam \setfontstyle{sl}}
1389 \def\bf{\fam=\bffam \setfontstyle{bf}}
1390 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1391
1392 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1393 % So we set up a \sf.
1394 \newfam\sffam
1395 \def\sf{\fam=\sffam \setfontstyle{sf}}
1396 \let\li = \sf % Sometimes we call it \li, not \sf.
1397
1398 % We don't need math for this font style.
1399 \def\ttsl{\setfontstyle{ttsl}}
1400
1401 % Default leading.
1402 \newdimen\textleading  \textleading = 13.2pt
1403
1404 % Set the baselineskip to #1, and the lineskip and strut size
1405 % correspondingly.  There is no deep meaning behind these magic numbers
1406 % used as factors; they just match (closely enough) what Knuth defined.
1407 %
1408 \def\lineskipfactor{.08333}
1409 \def\strutheightpercent{.70833}
1410 \def\strutdepthpercent {.29167}
1411 %
1412 \def\setleading#1{%
1413   \normalbaselineskip = #1\relax
1414   \normallineskip = \lineskipfactor\normalbaselineskip
1415   \normalbaselines
1416   \setbox\strutbox =\hbox{%
1417     \vrule width0pt height\strutheightpercent\baselineskip
1418                     depth \strutdepthpercent \baselineskip
1419   }%
1420 }
1421
1422 % Set the font macro #1 to the font named #2, adding on the
1423 % specified font prefix (normally `cm').
1424 % #3 is the font's design size, #4 is a scale factor
1425 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1426
1427 % Use cm as the default font prefix.
1428 % To specify the font prefix, you must define \fontprefix
1429 % before you read in texinfo.tex.
1430 \ifx\fontprefix\undefined
1431 \def\fontprefix{cm}
1432 \fi
1433 % Support font families that don't use the same naming scheme as CM.
1434 \def\rmshape{r}
1435 \def\rmbshape{bx}               %where the normal face is bold
1436 \def\bfshape{b}
1437 \def\bxshape{bx}
1438 \def\ttshape{tt}
1439 \def\ttbshape{tt}
1440 \def\ttslshape{sltt}
1441 \def\itshape{ti}
1442 \def\itbshape{bxti}
1443 \def\slshape{sl}
1444 \def\slbshape{bxsl}
1445 \def\sfshape{ss}
1446 \def\sfbshape{ss}
1447 \def\scshape{csc}
1448 \def\scbshape{csc}
1449
1450 % Text fonts (11.2pt, magstep1).
1451 \newcount\mainmagstep
1452 \ifx\bigger\relax
1453   % not really supported.
1454   \mainmagstep=\magstep1
1455   \setfont\textrm\rmshape{12}{1000}
1456   \setfont\texttt\ttshape{12}{1000}
1457 \else
1458   \mainmagstep=\magstephalf
1459   \setfont\textrm\rmshape{10}{\mainmagstep}
1460   \setfont\texttt\ttshape{10}{\mainmagstep}
1461 \fi
1462 \setfont\textbf\bfshape{10}{\mainmagstep}
1463 \setfont\textit\itshape{10}{\mainmagstep}
1464 \setfont\textsl\slshape{10}{\mainmagstep}
1465 \setfont\textsf\sfshape{10}{\mainmagstep}
1466 \setfont\textsc\scshape{10}{\mainmagstep}
1467 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1468 \font\texti=cmmi10 scaled \mainmagstep
1469 \font\textsy=cmsy10 scaled \mainmagstep
1470
1471 % A few fonts for @defun names and args.
1472 \setfont\defbf\bfshape{10}{\magstep1}
1473 \setfont\deftt\ttshape{10}{\magstep1}
1474 \setfont\defttsl\ttslshape{10}{\magstep1}
1475 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1476
1477 % Fonts for indices, footnotes, small examples (9pt).
1478 \setfont\smallrm\rmshape{9}{1000}
1479 \setfont\smalltt\ttshape{9}{1000}
1480 \setfont\smallbf\bfshape{10}{900}
1481 \setfont\smallit\itshape{9}{1000}
1482 \setfont\smallsl\slshape{9}{1000}
1483 \setfont\smallsf\sfshape{9}{1000}
1484 \setfont\smallsc\scshape{10}{900}
1485 \setfont\smallttsl\ttslshape{10}{900}
1486 \font\smalli=cmmi9
1487 \font\smallsy=cmsy9
1488
1489 % Fonts for small examples (8pt).
1490 \setfont\smallerrm\rmshape{8}{1000}
1491 \setfont\smallertt\ttshape{8}{1000}
1492 \setfont\smallerbf\bfshape{10}{800}
1493 \setfont\smallerit\itshape{8}{1000}
1494 \setfont\smallersl\slshape{8}{1000}
1495 \setfont\smallersf\sfshape{8}{1000}
1496 \setfont\smallersc\scshape{10}{800}
1497 \setfont\smallerttsl\ttslshape{10}{800}
1498 \font\smalleri=cmmi8
1499 \font\smallersy=cmsy8
1500
1501 % Fonts for title page (20.4pt):
1502 \setfont\titlerm\rmbshape{12}{\magstep3}
1503 \setfont\titleit\itbshape{10}{\magstep4}
1504 \setfont\titlesl\slbshape{10}{\magstep4}
1505 \setfont\titlett\ttbshape{12}{\magstep3}
1506 \setfont\titlettsl\ttslshape{10}{\magstep4}
1507 \setfont\titlesf\sfbshape{17}{\magstep1}
1508 \let\titlebf=\titlerm
1509 \setfont\titlesc\scbshape{10}{\magstep4}
1510 \font\titlei=cmmi12 scaled \magstep3
1511 \font\titlesy=cmsy10 scaled \magstep4
1512 \def\authorrm{\secrm}
1513 \def\authortt{\sectt}
1514
1515 % Chapter (and unnumbered) fonts (17.28pt).
1516 \setfont\chaprm\rmbshape{12}{\magstep2}
1517 \setfont\chapit\itbshape{10}{\magstep3}
1518 \setfont\chapsl\slbshape{10}{\magstep3}
1519 \setfont\chaptt\ttbshape{12}{\magstep2}
1520 \setfont\chapttsl\ttslshape{10}{\magstep3}
1521 \setfont\chapsf\sfbshape{17}{1000}
1522 \let\chapbf=\chaprm
1523 \setfont\chapsc\scbshape{10}{\magstep3}
1524 \font\chapi=cmmi12 scaled \magstep2
1525 \font\chapsy=cmsy10 scaled \magstep3
1526
1527 % Section fonts (14.4pt).
1528 \setfont\secrm\rmbshape{12}{\magstep1}
1529 \setfont\secit\itbshape{10}{\magstep2}
1530 \setfont\secsl\slbshape{10}{\magstep2}
1531 \setfont\sectt\ttbshape{12}{\magstep1}
1532 \setfont\secttsl\ttslshape{10}{\magstep2}
1533 \setfont\secsf\sfbshape{12}{\magstep1}
1534 \let\secbf\secrm
1535 \setfont\secsc\scbshape{10}{\magstep2}
1536 \font\seci=cmmi12 scaled \magstep1
1537 \font\secsy=cmsy10 scaled \magstep2
1538
1539 % Subsection fonts (13.15pt).
1540 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1541 \setfont\ssecit\itbshape{10}{1315}
1542 \setfont\ssecsl\slbshape{10}{1315}
1543 \setfont\ssectt\ttbshape{12}{\magstephalf}
1544 \setfont\ssecttsl\ttslshape{10}{1315}
1545 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1546 \let\ssecbf\ssecrm
1547 \setfont\ssecsc\scbshape{10}{1315}
1548 \font\sseci=cmmi12 scaled \magstephalf
1549 \font\ssecsy=cmsy10 scaled 1315
1550
1551 % Reduced fonts for @acro in text (10pt).
1552 \setfont\reducedrm\rmshape{10}{1000}
1553 \setfont\reducedtt\ttshape{10}{1000}
1554 \setfont\reducedbf\bfshape{10}{1000}
1555 \setfont\reducedit\itshape{10}{1000}
1556 \setfont\reducedsl\slshape{10}{1000}
1557 \setfont\reducedsf\sfshape{10}{1000}
1558 \setfont\reducedsc\scshape{10}{1000}
1559 \setfont\reducedttsl\ttslshape{10}{1000}
1560 \font\reducedi=cmmi10
1561 \font\reducedsy=cmsy10
1562
1563 % In order for the font changes to affect most math symbols and letters,
1564 % we have to define the \textfont of the standard families.  Since
1565 % texinfo doesn't allow for producing subscripts and superscripts except
1566 % in the main text, we don't bother to reset \scriptfont and
1567 % \scriptscriptfont (which would also require loading a lot more fonts).
1568 %
1569 \def\resetmathfonts{%
1570   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1571   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1572   \textfont\ttfam=\tentt \textfont\sffam=\tensf
1573 }
1574
1575 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1576 % of just \STYLE.  We do this because \STYLE needs to also set the
1577 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1578 % \tenSTYLE to set the current font.
1579
1580 % Each font-changing command also sets the names \lsize (one size lower)
1581 % and \lllsize (three sizes lower).  These relative commands are used in
1582 % the LaTeX logo and acronyms.
1583
1584 % This all needs generalizing, badly.
1585
1586 \def\textfonts{%
1587   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1588   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1589   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1590   \let\tenttsl=\textttsl
1591   \def\lsize{reduced}\def\lllsize{smaller}%
1592   \resetmathfonts \setleading{\textleading}}
1593 \def\titlefonts{%
1594   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1595   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1596   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1597   \let\tenttsl=\titlettsl
1598   \def\lsize{chap}\def\lllsize{subsec}%
1599   \resetmathfonts \setleading{25pt}}
1600 \def\titlefont#1{{\titlefonts\rm #1}}
1601 \def\chapfonts{%
1602   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1603   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1604   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1605   \def\lsize{sec}\def\lllsize{text}%
1606   \resetmathfonts \setleading{19pt}}
1607 \def\secfonts{%
1608   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1609   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1610   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1611   \let\tenttsl=\secttsl
1612   \def\lsize{subsec}\def\lllsize{reduced}%
1613   \resetmathfonts \setleading{16pt}}
1614 \def\subsecfonts{%
1615   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1616   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1617   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1618   \let\tenttsl=\ssecttsl
1619   \def\lsize{text}\def\lllsize{small}%
1620   \resetmathfonts \setleading{15pt}}
1621 \let\subsubsecfonts = \subsecfonts
1622 \def\reducedfonts{%
1623   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1624   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1625   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1626   \let\tenttsl=\reducedttsl
1627   \def\lsize{small}\def\lllsize{smaller}%
1628   \resetmathfonts \setleading{10.5pt}}
1629 \def\smallfonts{%
1630   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1631   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1632   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1633   \let\tenttsl=\smallttsl
1634   \def\lsize{smaller}\def\lllsize{smaller}%
1635   \resetmathfonts \setleading{10.5pt}}
1636 \def\smallerfonts{%
1637   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1638   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1639   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1640   \let\tenttsl=\smallerttsl
1641   \def\lsize{smaller}\def\lllsize{smaller}%
1642   \resetmathfonts \setleading{9.5pt}}
1643
1644 % Set the fonts to use with the @small... environments.
1645 \let\smallexamplefonts = \smallfonts
1646
1647 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1648 % can fit this many characters:
1649 %   8.5x11=86   smallbook=72  a4=90  a5=69
1650 % If we use \scriptfonts (8pt), then we can fit this many characters:
1651 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
1652 % For me, subjectively, the few extra characters that fit aren't worth
1653 % the additional smallness of 8pt.  So I'm making the default 9pt.
1654 %
1655 % By the way, for comparison, here's what fits with @example (10pt):
1656 %   8.5x11=71  smallbook=60  a4=75  a5=58
1657 %
1658 % I wish the USA used A4 paper.
1659 % --karl, 24jan03.
1660
1661
1662 % Set up the default fonts, so we can use them for creating boxes.
1663 %
1664 \textfonts \rm
1665
1666 % Define these so they can be easily changed for other fonts.
1667 \def\angleleft{$\langle$}
1668 \def\angleright{$\rangle$}
1669
1670 % Count depth in font-changes, for error checks
1671 \newcount\fontdepth \fontdepth=0
1672
1673 % Fonts for short table of contents.
1674 \setfont\shortcontrm\rmshape{12}{1000}
1675 \setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1676 \setfont\shortcontsl\slshape{12}{1000}
1677 \setfont\shortconttt\ttshape{12}{1000}
1678
1679 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1680 %% serif) and @ii for TeX italic
1681
1682 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1683 % unless the following character is such as not to need one.
1684 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1685                     \ptexslash\fi\fi\fi}
1686 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1687 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1688
1689 % like \smartslanted except unconditionally uses \ttsl.
1690 % @var is set to this for defun arguments.
1691 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1692
1693 % like \smartslanted except unconditionally use \sl.  We never want
1694 % ttsl for book titles, do we?
1695 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1696
1697 \let\i=\smartitalic
1698 \let\var=\smartslanted
1699 \let\dfn=\smartslanted
1700 \let\emph=\smartitalic
1701
1702 \def\b#1{{\bf #1}}
1703 \let\strong=\b
1704
1705 % We can't just use \exhyphenpenalty, because that only has effect at
1706 % the end of a paragraph.  Restore normal hyphenation at the end of the
1707 % group within which \nohyphenation is presumably called.
1708 %
1709 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1710 \def\restorehyphenation{\hyphenchar\font = `- }
1711
1712 % Set sfcode to normal for the chars that usually have another value.
1713 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1714 % sometimes \x has an active definition that messes things up.
1715 %
1716 \catcode`@=11
1717   \def\frenchspacing{%
1718     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1719     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1720   }
1721 \catcode`@=\other
1722
1723 \def\t#1{%
1724   {\tt \rawbackslash \frenchspacing #1}%
1725   \null
1726 }
1727 \def\samp#1{`\tclose{#1}'\null}
1728 \setfont\keyrm\rmshape{8}{1000}
1729 \font\keysy=cmsy9
1730 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1731   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1732     \vbox{\hrule\kern-0.4pt
1733      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1734     \kern-0.4pt\hrule}%
1735   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1736 % The old definition, with no lozenge:
1737 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1738 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1739
1740 % @file, @option are the same as @samp.
1741 \let\file=\samp
1742 \let\option=\samp
1743
1744 % @code is a modification of @t,
1745 % which makes spaces the same size as normal in the surrounding text.
1746 \def\tclose#1{%
1747   {%
1748     % Change normal interword space to be same as for the current font.
1749     \spaceskip = \fontdimen2\font
1750     %
1751     % Switch to typewriter.
1752     \tt
1753     %
1754     % But `\ ' produces the large typewriter interword space.
1755     \def\ {{\spaceskip = 0pt{} }}%
1756     %
1757     % Turn off hyphenation.
1758     \nohyphenation
1759     %
1760     \rawbackslash
1761     \frenchspacing
1762     #1%
1763   }%
1764   \null
1765 }
1766
1767 % We *must* turn on hyphenation at `-' and `_' in @code.
1768 % Otherwise, it is too hard to avoid overfull hboxes
1769 % in the Emacs manual, the Library manual, etc.
1770
1771 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1772 % both hyphenation at - and hyphenation within words.
1773 % We must therefore turn them both off (\tclose does that)
1774 % and arrange explicitly to hyphenate at a dash.
1775 %  -- rms.
1776 {
1777   \catcode`\-=\active
1778   \catcode`\_=\active
1779   %
1780   \global\def\code{\begingroup
1781     \catcode`\-=\active \let-\codedash
1782     \catcode`\_=\active \let_\codeunder
1783     \codex
1784   }
1785 }
1786
1787 \def\realdash{-}
1788 \def\codedash{-\discretionary{}{}{}}
1789 \def\codeunder{%
1790   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
1791   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1792   % will therefore expand the active definition of _, which is us
1793   % (inside @code that is), therefore an endless loop.
1794   \ifusingtt{\ifmmode
1795                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1796              \else\normalunderscore \fi
1797              \discretionary{}{}{}}%
1798             {\_}%
1799 }
1800 \def\codex #1{\tclose{#1}\endgroup}
1801
1802 % @kbd is like @code, except that if the argument is just one @key command,
1803 % then @kbd has no effect.
1804
1805 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1806 %   `example' (@kbd uses ttsl only inside of @example and friends),
1807 %   or `code' (@kbd uses normal tty font always).
1808 \parseargdef\kbdinputstyle{%
1809   \def\arg{#1}%
1810   \ifx\arg\worddistinct
1811     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1812   \else\ifx\arg\wordexample
1813     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1814   \else\ifx\arg\wordcode
1815     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1816   \else
1817     \errhelp = \EMsimple
1818     \errmessage{Unknown @kbdinputstyle option `\arg'}%
1819   \fi\fi\fi
1820 }
1821 \def\worddistinct{distinct}
1822 \def\wordexample{example}
1823 \def\wordcode{code}
1824
1825 % Default is `distinct.'
1826 \kbdinputstyle distinct
1827
1828 \def\xkey{\key}
1829 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1830 \ifx\one\xkey\ifx\threex\three \key{#2}%
1831 \else{\tclose{\kbdfont\look}}\fi
1832 \else{\tclose{\kbdfont\look}}\fi}
1833
1834 % For @url, @env, @command quotes seem unnecessary, so use \code.
1835 \let\url=\code
1836 \let\env=\code
1837 \let\command=\code
1838
1839 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1840 % second argument specifying the text to display and an optional third
1841 % arg as text to display instead of (rather than in addition to) the url
1842 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
1843 % a hypertex \special here.
1844 %
1845 \def\uref#1{\douref #1,,,\finish}
1846 \def\douref#1,#2,#3,#4\finish{\begingroup
1847   \unsepspaces
1848   \pdfurl{#1}%
1849   \setbox0 = \hbox{\ignorespaces #3}%
1850   \ifdim\wd0 > 0pt
1851     \unhbox0 % third arg given, show only that
1852   \else
1853     \setbox0 = \hbox{\ignorespaces #2}%
1854     \ifdim\wd0 > 0pt
1855       \ifpdf
1856         \unhbox0             % PDF: 2nd arg given, show only it
1857       \else
1858         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1859       \fi
1860     \else
1861       \code{#1}% only url given, so show it
1862     \fi
1863   \fi
1864   \endlink
1865 \endgroup}
1866
1867 % rms does not like angle brackets --karl, 17may97.
1868 % So now @email is just like @uref, unless we are pdf.
1869 %
1870 %\def\email#1{\angleleft{\tt #1}\angleright}
1871 \ifpdf
1872   \def\email#1{\doemail#1,,\finish}
1873   \def\doemail#1,#2,#3\finish{\begingroup
1874     \unsepspaces
1875     \pdfurl{mailto:#1}%
1876     \setbox0 = \hbox{\ignorespaces #2}%
1877     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1878     \endlink
1879   \endgroup}
1880 \else
1881   \let\email=\uref
1882 \fi
1883
1884 % Check if we are currently using a typewriter font.  Since all the
1885 % Computer Modern typewriter fonts have zero interword stretch (and
1886 % shrink), and it is reasonable to expect all typewriter fonts to have
1887 % this property, we can check that font parameter.
1888 %
1889 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1890
1891 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
1892 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1893 %
1894 \def\dmn#1{\thinspace #1}
1895
1896 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1897
1898 % @l was never documented to mean ``switch to the Lisp font'',
1899 % and it is not used as such in any manual I can find.  We need it for
1900 % Polish suppressed-l.  --karl, 22sep96.
1901 %\def\l#1{{\li #1}\null}
1902
1903 % Explicit font changes: @r, @sc, undocumented @ii.
1904 \def\r#1{{\rm #1}}              % roman font
1905 \def\sc#1{{\smallcaps#1}}       % smallcaps font
1906 \def\ii#1{{\it #1}}             % italic font
1907
1908 \def\acronym#1{\doacronym #1,,\finish}
1909 \def\doacronym#1,#2,#3\finish{%
1910   {\selectfonts\lsize #1}%
1911   \def\temp{#2}%
1912   \ifx\temp\empty \else
1913     \space ({\unsepspaces \ignorespaces \temp \unskip})%
1914   \fi
1915 }
1916
1917 % @pounds{} is a sterling sign, which is in the CM italic font.
1918
1919 \def\pounds{{\it\$}}
1920
1921 % @registeredsymbol - R in a circle.  The font for the R should really
1922 % be smaller yet, but lllsize is the best we can do for now.
1923 % Adapted from the plain.tex definition of \copyright.
1924 %
1925 \def\registeredsymbol{%
1926   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
1927                \hfil\crcr\Orb}}%
1928     }$%
1929 }
1930
1931
1932 \message{page headings,}
1933
1934 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1935 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1936
1937 % First the title page.  Must do @settitle before @titlepage.
1938 \newif\ifseenauthor
1939 \newif\iffinishedtitlepage
1940
1941 % Do an implicit @contents or @shortcontents after @end titlepage if the
1942 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1943 %
1944 \newif\ifsetcontentsaftertitlepage
1945  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1946 \newif\ifsetshortcontentsaftertitlepage
1947  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1948
1949 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1950         \endgroup\page\hbox{}\page}
1951
1952 \envdef\titlepage{%
1953   % Open one extra group, as we want to close it in the middle of \Etitlepage.
1954   \begingroup
1955     \parindent=0pt \textfonts
1956     % Leave some space at the very top of the page.
1957     \vglue\titlepagetopglue
1958     % No rule at page bottom unless we print one at the top with @title.
1959     \finishedtitlepagetrue
1960     %
1961     % Most title ``pages'' are actually two pages long, with space
1962     % at the top of the second.  We don't want the ragged left on the second.
1963     \let\oldpage = \page
1964     \def\page{%
1965       \iffinishedtitlepage\else
1966          \finishtitlepage
1967       \fi
1968       \let\page = \oldpage
1969       \page
1970       \null
1971     }%
1972 }
1973
1974 \def\Etitlepage{%
1975     \iffinishedtitlepage\else
1976         \finishtitlepage
1977     \fi
1978     % It is important to do the page break before ending the group,
1979     % because the headline and footline are only empty inside the group.
1980     % If we use the new definition of \page, we always get a blank page
1981     % after the title page, which we certainly don't want.
1982     \oldpage
1983   \endgroup
1984   %
1985   % Need this before the \...aftertitlepage checks so that if they are
1986   % in effect the toc pages will come out with page numbers.
1987   \HEADINGSon
1988   %
1989   % If they want short, they certainly want long too.
1990   \ifsetshortcontentsaftertitlepage
1991     \shortcontents
1992     \contents
1993     \global\let\shortcontents = \relax
1994     \global\let\contents = \relax
1995   \fi
1996   %
1997   \ifsetcontentsaftertitlepage
1998     \contents
1999     \global\let\contents = \relax
2000     \global\let\shortcontents = \relax
2001   \fi
2002 }
2003
2004 \def\finishtitlepage{%
2005   \vskip4pt \hrule height 2pt width \hsize
2006   \vskip\titlepagebottomglue
2007   \finishedtitlepagetrue
2008 }
2009
2010 %%% Macros to be used within @titlepage:
2011
2012 \let\subtitlerm=\tenrm
2013 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2014
2015 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2016                 \let\tt=\authortt}
2017
2018 \parseargdef\title{%
2019   \checkenv\titlepage
2020   \leftline{\titlefonts\rm #1}
2021   % print a rule at the page bottom also.
2022   \finishedtitlepagefalse
2023   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2024 }
2025
2026 \parseargdef\subtitle{%
2027   \checkenv\titlepage
2028   {\subtitlefont \rightline{#1}}%
2029 }
2030
2031 % @author should come last, but may come many times.
2032 \parseargdef\author{%
2033   \def\temp{\quotation}%
2034   \ifx\thisenv\temp
2035     This edition of the manual is dedicated to Karl Berry who should
2036     really make affiliations work.
2037   \else
2038     \checkenv\titlepage
2039     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2040     {\authorfont \leftline{#1}}%
2041   \fi
2042 }
2043
2044
2045 %%% Set up page headings and footings.
2046
2047 \let\thispage=\folio
2048
2049 \newtoks\evenheadline    % headline on even pages
2050 \newtoks\oddheadline     % headline on odd pages
2051 \newtoks\evenfootline    % footline on even pages
2052 \newtoks\oddfootline     % footline on odd pages
2053
2054 % Now make TeX use those variables
2055 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2056                             \else \the\evenheadline \fi}}
2057 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2058                             \else \the\evenfootline \fi}\HEADINGShook}
2059 \let\HEADINGShook=\relax
2060
2061 % Commands to set those variables.
2062 % For example, this is what  @headings on  does
2063 % @evenheading @thistitle|@thispage|@thischapter
2064 % @oddheading @thischapter|@thispage|@thistitle
2065 % @evenfooting @thisfile||
2066 % @oddfooting ||@thisfile
2067
2068
2069 \def\evenheading{\parsearg\evenheadingxxx}
2070 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2071 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2072 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2073
2074 \def\oddheading{\parsearg\oddheadingxxx}
2075 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2076 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2077 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2078
2079 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2080
2081 \def\evenfooting{\parsearg\evenfootingxxx}
2082 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2083 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2084 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2085
2086 \def\oddfooting{\parsearg\oddfootingxxx}
2087 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2088 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2089   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2090   %
2091   % Leave some space for the footline.  Hopefully ok to assume
2092   % @evenfooting will not be used by itself.
2093   \global\advance\pageheight by -\baselineskip
2094   \global\advance\vsize by -\baselineskip
2095 }
2096
2097 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2098
2099
2100 % @headings double      turns headings on for double-sided printing.
2101 % @headings single      turns headings on for single-sided printing.
2102 % @headings off         turns them off.
2103 % @headings on          same as @headings double, retained for compatibility.
2104 % @headings after       turns on double-sided headings after this page.
2105 % @headings doubleafter turns on double-sided headings after this page.
2106 % @headings singleafter turns on single-sided headings after this page.
2107 % By default, they are off at the start of a document,
2108 % and turned `on' after @end titlepage.
2109
2110 \def\headings #1 {\csname HEADINGS#1\endcsname}
2111
2112 \def\HEADINGSoff{%
2113 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2114 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2115 \HEADINGSoff
2116 % When we turn headings on, set the page number to 1.
2117 % For double-sided printing, put current file name in lower left corner,
2118 % chapter name on inside top of right hand pages, document
2119 % title on inside top of left hand pages, and page numbers on outside top
2120 % edge of all pages.
2121 \def\HEADINGSdouble{%
2122 \global\pageno=1
2123 \global\evenfootline={\hfil}
2124 \global\oddfootline={\hfil}
2125 \global\evenheadline={\line{\folio\hfil\thistitle}}
2126 \global\oddheadline={\line{\thischapter\hfil\folio}}
2127 \global\let\contentsalignmacro = \chapoddpage
2128 }
2129 \let\contentsalignmacro = \chappager
2130
2131 % For single-sided printing, chapter title goes across top left of page,
2132 % page number on top right.
2133 \def\HEADINGSsingle{%
2134 \global\pageno=1
2135 \global\evenfootline={\hfil}
2136 \global\oddfootline={\hfil}
2137 \global\evenheadline={\line{\thischapter\hfil\folio}}
2138 \global\oddheadline={\line{\thischapter\hfil\folio}}
2139 \global\let\contentsalignmacro = \chappager
2140 }
2141 \def\HEADINGSon{\HEADINGSdouble}
2142
2143 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2144 \let\HEADINGSdoubleafter=\HEADINGSafter
2145 \def\HEADINGSdoublex{%
2146 \global\evenfootline={\hfil}
2147 \global\oddfootline={\hfil}
2148 \global\evenheadline={\line{\folio\hfil\thistitle}}
2149 \global\oddheadline={\line{\thischapter\hfil\folio}}
2150 \global\let\contentsalignmacro = \chapoddpage
2151 }
2152
2153 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2154 \def\HEADINGSsinglex{%
2155 \global\evenfootline={\hfil}
2156 \global\oddfootline={\hfil}
2157 \global\evenheadline={\line{\thischapter\hfil\folio}}
2158 \global\oddheadline={\line{\thischapter\hfil\folio}}
2159 \global\let\contentsalignmacro = \chappager
2160 }
2161
2162 % Subroutines used in generating headings
2163 % This produces Day Month Year style of output.
2164 % Only define if not already defined, in case a txi-??.tex file has set
2165 % up a different format (e.g., txi-cs.tex does this).
2166 \ifx\today\undefined
2167 \def\today{%
2168   \number\day\space
2169   \ifcase\month
2170   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2171   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2172   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2173   \fi
2174   \space\number\year}
2175 \fi
2176
2177 % @settitle line...  specifies the title of the document, for headings.
2178 % It generates no output of its own.
2179 \def\thistitle{\putwordNoTitle}
2180 \def\settitle{\parsearg{\gdef\thistitle}}
2181
2182
2183 \message{tables,}
2184 % Tables -- @table, @ftable, @vtable, @item(x).
2185
2186 % default indentation of table text
2187 \newdimen\tableindent \tableindent=.8in
2188 % default indentation of @itemize and @enumerate text
2189 \newdimen\itemindent  \itemindent=.3in
2190 % margin between end of table item and start of table text.
2191 \newdimen\itemmargin  \itemmargin=.1in
2192
2193 % used internally for \itemindent minus \itemmargin
2194 \newdimen\itemmax
2195
2196 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2197 % these defs.
2198 % They also define \itemindex
2199 % to index the item name in whatever manner is desired (perhaps none).
2200
2201 \newif\ifitemxneedsnegativevskip
2202
2203 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2204
2205 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2206 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2207
2208 \def\itemzzz #1{\begingroup %
2209   \advance\hsize by -\rightskip
2210   \advance\hsize by -\tableindent
2211   \setbox0=\hbox{\itemindicate{#1}}%
2212   \itemindex{#1}%
2213   \nobreak % This prevents a break before @itemx.
2214   %
2215   % If the item text does not fit in the space we have, put it on a line
2216   % by itself, and do not allow a page break either before or after that
2217   % line.  We do not start a paragraph here because then if the next
2218   % command is, e.g., @kindex, the whatsit would get put into the
2219   % horizontal list on a line by itself, resulting in extra blank space.
2220   \ifdim \wd0>\itemmax
2221     %
2222     % Make this a paragraph so we get the \parskip glue and wrapping,
2223     % but leave it ragged-right.
2224     \begingroup
2225       \advance\leftskip by-\tableindent
2226       \advance\hsize by\tableindent
2227       \advance\rightskip by0pt plus1fil
2228       \leavevmode\unhbox0\par
2229     \endgroup
2230     %
2231     % We're going to be starting a paragraph, but we don't want the
2232     % \parskip glue -- logically it's part of the @item we just started.
2233     \nobreak \vskip-\parskip
2234     %
2235     % Stop a page break at the \parskip glue coming up.  (Unfortunately
2236     % we can't prevent a possible page break at the following
2237     % \baselineskip glue.)  However, if what follows is an environment
2238     % such as @example, there will be no \parskip glue; then
2239     % the negative vskip we just would cause the example and the item to
2240     % crash together.  So we use this bizarre value of 10001 as a signal
2241     % to \aboveenvbreak to insert \parskip glue after all.
2242     % (Possibly there are other commands that could be followed by
2243     % @example which need the same treatment, but not section titles; or
2244     % maybe section titles are the only special case and they should be
2245     % penalty 10001...)
2246     \penalty 10001
2247     \endgroup
2248     \itemxneedsnegativevskipfalse
2249   \else
2250     % The item text fits into the space.  Start a paragraph, so that the
2251     % following text (if any) will end up on the same line.
2252     \noindent
2253     % Do this with kerns and \unhbox so that if there is a footnote in
2254     % the item text, it can migrate to the main vertical list and
2255     % eventually be printed.
2256     \nobreak\kern-\tableindent
2257     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2258     \unhbox0
2259     \nobreak\kern\dimen0
2260     \endgroup
2261     \itemxneedsnegativevskiptrue
2262   \fi
2263 }
2264
2265 \def\item{\errmessage{@item while not in a list environment}}
2266 \def\itemx{\errmessage{@itemx while not in a list environment}}
2267
2268 % @table, @ftable, @vtable.
2269 \envdef\table{%
2270   \let\itemindex\gobble
2271   \tablex
2272 }
2273 \envdef\ftable{%
2274   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2275   \tablex
2276 }
2277 \envdef\vtable{%
2278   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2279   \tablex
2280 }
2281 \def\tablex#1{%
2282   \def\itemindicate{#1}%
2283   \parsearg\tabley
2284 }
2285 \def\tabley#1{%
2286   {%
2287     \makevalueexpandable
2288     \edef\temp{\noexpand\tablez #1\space\space\space}%
2289     \expandafter
2290   }\temp \endtablez
2291 }
2292 \def\tablez #1 #2 #3 #4\endtablez{%
2293   \aboveenvbreak
2294   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2295   \ifnum 0#2>0 \tableindent=#2\mil \fi
2296   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2297   \itemmax=\tableindent
2298   \advance \itemmax by -\itemmargin
2299   \advance \leftskip by \tableindent
2300   \exdentamount=\tableindent
2301   \parindent = 0pt
2302   \parskip = \smallskipamount
2303   \ifdim \parskip=0pt \parskip=2pt \fi
2304   \let\item = \internalBitem
2305   \let\itemx = \internalBitemx
2306 }
2307 \def\Etable{\endgraf\afterenvbreak}
2308 \let\Eftable\Etable
2309 \let\Evtable\Etable
2310 \let\Eitemize\Etable
2311 \let\Eenumerate\Etable
2312
2313 % This is the counter used by @enumerate, which is really @itemize
2314
2315 \newcount \itemno
2316
2317 \envdef\itemize{\parsearg\doitemize}
2318
2319 \def\doitemize#1{%
2320   \aboveenvbreak
2321   \itemmax=\itemindent
2322   \advance\itemmax by -\itemmargin
2323   \advance\leftskip by \itemindent
2324   \exdentamount=\itemindent
2325   \parindent=0pt
2326   \parskip=\smallskipamount
2327   \ifdim\parskip=0pt \parskip=2pt \fi
2328   \def\itemcontents{#1}%
2329   % @itemize with no arg is equivalent to @itemize @bullet.
2330   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2331   \let\item=\itemizeitem
2332 }
2333
2334 % Definition of @item while inside @itemize and @enumerate.
2335 %
2336 \def\itemizeitem{%
2337   \advance\itemno by 1  % for enumerations
2338   {\let\par=\endgraf \smallbreak}% reasonable place to break
2339   {%
2340    % If the document has an @itemize directly after a section title, a
2341    % \nobreak will be the last contribution, and \sectionheading will have
2342    % done a \vskip-\parskip.  In that case, we don't want to zero
2343    % parskip, or the item text will crash with the heading.  On the
2344    % other hand, when there is normal text preceding the item (as there
2345    % usually is), we do want to zero parskip, or there would be too much
2346    % space.  In that case, we won't have a \nobreak before.  At least
2347    % that's the theory.
2348    \ifnum\lastpenalty<10000 \parskip=0in \fi
2349    \noindent
2350    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2351    \vadjust{\penalty 1200}}% not good to break after first line of item.
2352   \flushcr
2353 }
2354
2355 % \splitoff TOKENS\endmark defines \first to be the first token in
2356 % TOKENS, and \rest to be the remainder.
2357 %
2358 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2359
2360 % Allow an optional argument of an uppercase letter, lowercase letter,
2361 % or number, to specify the first label in the enumerated list.  No
2362 % argument is the same as `1'.
2363 %
2364 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2365 \def\enumeratey #1 #2\endenumeratey{%
2366   % If we were given no argument, pretend we were given `1'.
2367   \def\thearg{#1}%
2368   \ifx\thearg\empty \def\thearg{1}\fi
2369   %
2370   % Detect if the argument is a single token.  If so, it might be a
2371   % letter.  Otherwise, the only valid thing it can be is a number.
2372   % (We will always have one token, because of the test we just made.
2373   % This is a good thing, since \splitoff doesn't work given nothing at
2374   % all -- the first parameter is undelimited.)
2375   \expandafter\splitoff\thearg\endmark
2376   \ifx\rest\empty
2377     % Only one token in the argument.  It could still be anything.
2378     % A ``lowercase letter'' is one whose \lccode is nonzero.
2379     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2380     %   not equal to itself.
2381     % Otherwise, we assume it's a number.
2382     %
2383     % We need the \relax at the end of the \ifnum lines to stop TeX from
2384     % continuing to look for a <number>.
2385     %
2386     \ifnum\lccode\expandafter`\thearg=0\relax
2387       \numericenumerate % a number (we hope)
2388     \else
2389       % It's a letter.
2390       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2391         \lowercaseenumerate % lowercase letter
2392       \else
2393         \uppercaseenumerate % uppercase letter
2394       \fi
2395     \fi
2396   \else
2397     % Multiple tokens in the argument.  We hope it's a number.
2398     \numericenumerate
2399   \fi
2400 }
2401
2402 % An @enumerate whose labels are integers.  The starting integer is
2403 % given in \thearg.
2404 %
2405 \def\numericenumerate{%
2406   \itemno = \thearg
2407   \startenumeration{\the\itemno}%
2408 }
2409
2410 % The starting (lowercase) letter is in \thearg.
2411 \def\lowercaseenumerate{%
2412   \itemno = \expandafter`\thearg
2413   \startenumeration{%
2414     % Be sure we're not beyond the end of the alphabet.
2415     \ifnum\itemno=0
2416       \errmessage{No more lowercase letters in @enumerate; get a bigger
2417                   alphabet}%
2418     \fi
2419     \char\lccode\itemno
2420   }%
2421 }
2422
2423 % The starting (uppercase) letter is in \thearg.
2424 \def\uppercaseenumerate{%
2425   \itemno = \expandafter`\thearg
2426   \startenumeration{%
2427     % Be sure we're not beyond the end of the alphabet.
2428     \ifnum\itemno=0
2429       \errmessage{No more uppercase letters in @enumerate; get a bigger
2430                   alphabet}
2431     \fi
2432     \char\uccode\itemno
2433   }%
2434 }
2435
2436 % Call \doitemize, adding a period to the first argument and supplying the
2437 % common last two arguments.  Also subtract one from the initial value in
2438 % \itemno, since @item increments \itemno.
2439 %
2440 \def\startenumeration#1{%
2441   \advance\itemno by -1
2442   \doitemize{#1.}\flushcr
2443 }
2444
2445 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2446 % to @enumerate.
2447 %
2448 \def\alphaenumerate{\enumerate{a}}
2449 \def\capsenumerate{\enumerate{A}}
2450 \def\Ealphaenumerate{\Eenumerate}
2451 \def\Ecapsenumerate{\Eenumerate}
2452
2453
2454 % @multitable macros
2455 % Amy Hendrickson, 8/18/94, 3/6/96
2456 %
2457 % @multitable ... @end multitable will make as many columns as desired.
2458 % Contents of each column will wrap at width given in preamble.  Width
2459 % can be specified either with sample text given in a template line,
2460 % or in percent of \hsize, the current width of text on page.
2461
2462 % Table can continue over pages but will only break between lines.
2463
2464 % To make preamble:
2465 %
2466 % Either define widths of columns in terms of percent of \hsize:
2467 %   @multitable @columnfractions .25 .3 .45
2468 %   @item ...
2469 %
2470 %   Numbers following @columnfractions are the percent of the total
2471 %   current hsize to be used for each column. You may use as many
2472 %   columns as desired.
2473
2474
2475 % Or use a template:
2476 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2477 %   @item ...
2478 %   using the widest term desired in each column.
2479
2480 % Each new table line starts with @item, each subsequent new column
2481 % starts with @tab. Empty columns may be produced by supplying @tab's
2482 % with nothing between them for as many times as empty columns are needed,
2483 % ie, @tab@tab@tab will produce two empty columns.
2484
2485 % @item, @tab do not need to be on their own lines, but it will not hurt
2486 % if they are.
2487
2488 % Sample multitable:
2489
2490 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2491 %   @item first col stuff @tab second col stuff @tab third col
2492 %   @item
2493 %   first col stuff
2494 %   @tab
2495 %   second col stuff
2496 %   @tab
2497 %   third col
2498 %   @item first col stuff @tab second col stuff
2499 %   @tab Many paragraphs of text may be used in any column.
2500 %
2501 %         They will wrap at the width determined by the template.
2502 %   @item@tab@tab This will be in third column.
2503 %   @end multitable
2504
2505 % Default dimensions may be reset by user.
2506 % @multitableparskip is vertical space between paragraphs in table.
2507 % @multitableparindent is paragraph indent in table.
2508 % @multitablecolmargin is horizontal space to be left between columns.
2509 % @multitablelinespace is space to leave between table items, baseline
2510 %                                                            to baseline.
2511 %   0pt means it depends on current normal line spacing.
2512 %
2513 \newskip\multitableparskip
2514 \newskip\multitableparindent
2515 \newdimen\multitablecolspace
2516 \newskip\multitablelinespace
2517 \multitableparskip=0pt
2518 \multitableparindent=6pt
2519 \multitablecolspace=12pt
2520 \multitablelinespace=0pt
2521
2522 % Macros used to set up halign preamble:
2523 %
2524 \let\endsetuptable\relax
2525 \def\xendsetuptable{\endsetuptable}
2526 \let\columnfractions\relax
2527 \def\xcolumnfractions{\columnfractions}
2528 \newif\ifsetpercent
2529
2530 % #1 is the part of the @columnfraction before the decimal point, which
2531 % is presumably either 0 or the empty string (but we don't check, we
2532 % just throw it away).  #2 is the decimal part, which we use as the
2533 % percent of \hsize for this column.
2534 \def\pickupwholefraction#1.#2 {%
2535   \global\advance\colcount by 1
2536   \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2537   \setuptable
2538 }
2539
2540 \newcount\colcount
2541 \def\setuptable#1{%
2542   \def\firstarg{#1}%
2543   \ifx\firstarg\xendsetuptable
2544     \let\go = \relax
2545   \else
2546     \ifx\firstarg\xcolumnfractions
2547       \global\setpercenttrue
2548     \else
2549       \ifsetpercent
2550          \let\go\pickupwholefraction
2551       \else
2552          \global\advance\colcount by 1
2553          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2554                    % separator; typically that is always in the input, anyway.
2555          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2556       \fi
2557     \fi
2558     \ifx\go\pickupwholefraction
2559       % Put the argument back for the \pickupwholefraction call, so
2560       % we'll always have a period there to be parsed.
2561       \def\go{\pickupwholefraction#1}%
2562     \else
2563       \let\go = \setuptable
2564     \fi%
2565   \fi
2566   \go
2567 }
2568
2569 % multitable-only commands.
2570 %
2571 % @headitem starts a heading row, which we typeset in bold.
2572 % Assignments have to be global since we are inside the implicit group
2573 % of an alignment entry.  Note that \everycr resets \everytab.
2574 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2575 %
2576 % A \tab used to include \hskip1sp.  But then the space in a template
2577 % line is not enough.  That is bad.  So let's go back to just `&' until
2578 % we encounter the problem it was intended to solve again.
2579 %                                       --karl, nathan@acm.org, 20apr99.
2580 \def\tab{\checkenv\multitable &\the\everytab}%
2581
2582 % @multitable ... @end multitable definitions:
2583 %
2584 \newtoks\everytab  % insert after every tab.
2585 %
2586 \envdef\multitable{%
2587   \vskip\parskip
2588   \startsavinginserts
2589   %
2590   % @item within a multitable starts a normal row.
2591   \let\item\crcr
2592   %
2593   \tolerance=9500
2594   \hbadness=9500
2595   \setmultitablespacing
2596   \parskip=\multitableparskip
2597   \parindent=\multitableparindent
2598   \overfullrule=0pt
2599   \global\colcount=0
2600   %
2601   \everycr = {%
2602     \noalign{%
2603       \global\everytab={}%
2604       \global\colcount=0 % Reset the column counter.
2605       % Check for saved footnotes, etc.
2606       \checkinserts
2607       % Keeps underfull box messages off when table breaks over pages.
2608       %\filbreak
2609         % Maybe so, but it also creates really weird page breaks when the
2610         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
2611         % problem manifests itself, so it can be fixed for real --karl.
2612     }%
2613   }%
2614   %
2615   \parsearg\domultitable
2616 }
2617 \def\domultitable#1{%
2618   % To parse everything between @multitable and @item:
2619   \setuptable#1 \endsetuptable
2620   %
2621   % This preamble sets up a generic column definition, which will
2622   % be used as many times as user calls for columns.
2623   % \vtop will set a single line and will also let text wrap and
2624   % continue for many paragraphs if desired.
2625   \halign\bgroup &%
2626     \global\advance\colcount by 1
2627     \multistrut
2628     \vtop{%
2629       % Use the current \colcount to find the correct column width:
2630       \hsize=\expandafter\csname col\the\colcount\endcsname
2631       %
2632       % In order to keep entries from bumping into each other
2633       % we will add a \leftskip of \multitablecolspace to all columns after
2634       % the first one.
2635       %
2636       % If a template has been used, we will add \multitablecolspace
2637       % to the width of each template entry.
2638       %
2639       % If the user has set preamble in terms of percent of \hsize we will
2640       % use that dimension as the width of the column, and the \leftskip
2641       % will keep entries from bumping into each other.  Table will start at
2642       % left margin and final column will justify at right margin.
2643       %
2644       % Make sure we don't inherit \rightskip from the outer environment.
2645       \rightskip=0pt
2646       \ifnum\colcount=1
2647         % The first column will be indented with the surrounding text.
2648         \advance\hsize by\leftskip
2649       \else
2650         \ifsetpercent \else
2651           % If user has not set preamble in terms of percent of \hsize
2652           % we will advance \hsize by \multitablecolspace.
2653           \advance\hsize by \multitablecolspace
2654         \fi
2655        % In either case we will make \leftskip=\multitablecolspace:
2656       \leftskip=\multitablecolspace
2657       \fi
2658       % Ignoring space at the beginning and end avoids an occasional spurious
2659       % blank line, when TeX decides to break the line at the space before the
2660       % box from the multistrut, so the strut ends up on a line by itself.
2661       % For example:
2662       % @multitable @columnfractions .11 .89
2663       % @item @code{#}
2664       % @tab Legal holiday which is valid in major parts of the whole country.
2665       % Is automatically provided with highlighting sequences respectively
2666       % marking characters.
2667       \noindent\ignorespaces##\unskip\multistrut
2668     }\cr
2669 }
2670 \def\Emultitable{%
2671   \crcr
2672   \egroup % end the \halign
2673   \global\setpercentfalse
2674 }
2675
2676 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2677 % If so, do nothing. If not, give it an appropriate dimension based on
2678 % current baselineskip.
2679 \ifdim\multitablelinespace=0pt
2680 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2681 \global\advance\multitablelinespace by-\ht0
2682 %% strut to put in table in case some entry doesn't have descenders,
2683 %% to keep lines equally spaced
2684 \let\multistrut = \strut
2685 \else
2686 %% FIXME: what is \box0 supposed to be?
2687 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2688 width0pt\relax} \fi
2689 %% Test to see if parskip is larger than space between lines of
2690 %% table. If not, do nothing.
2691 %%        If so, set to same dimension as multitablelinespace.
2692 \ifdim\multitableparskip>\multitablelinespace
2693 \global\multitableparskip=\multitablelinespace
2694 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2695                                       %% than skip between lines in the table.
2696 \fi%
2697 \ifdim\multitableparskip=0pt
2698 \global\multitableparskip=\multitablelinespace
2699 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2700                                       %% than skip between lines in the table.
2701 \fi}
2702
2703
2704 \message{conditionals,}
2705
2706 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2707 % @ifnotxml always succeed.  They currently do nothing; we don't
2708 % attempt to check whether the conditionals are properly nested.  But we
2709 % have to remember that they are conditionals, so that @end doesn't
2710 % attempt to close an environment group.
2711 %
2712 \def\makecond#1{%
2713   \expandafter\let\csname #1\endcsname = \relax
2714   \expandafter\let\csname iscond.#1\endcsname = 1
2715 }
2716 \makecond{iftex}
2717 \makecond{ifnotdocbook}
2718 \makecond{ifnothtml}
2719 \makecond{ifnotinfo}
2720 \makecond{ifnotplaintext}
2721 \makecond{ifnotxml}
2722
2723 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2724 %
2725 \def\direntry{\doignore{direntry}}
2726 \def\documentdescription{\doignore{documentdescription}}
2727 \def\docbook{\doignore{docbook}}
2728 \def\html{\doignore{html}}
2729 \def\ifdocbook{\doignore{ifdocbook}}
2730 \def\ifhtml{\doignore{ifhtml}}
2731 \def\ifinfo{\doignore{ifinfo}}
2732 \def\ifnottex{\doignore{ifnottex}}
2733 \def\ifplaintext{\doignore{ifplaintext}}
2734 \def\ifxml{\doignore{ifxml}}
2735 \def\ignore{\doignore{ignore}}
2736 \def\menu{\doignore{menu}}
2737 \def\xml{\doignore{xml}}
2738
2739 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2740 %
2741 % A count to remember the depth of nesting.
2742 \newcount\doignorecount
2743
2744 \def\doignore#1{\begingroup
2745   % Scan in ``verbatim'' mode:
2746   \catcode`\@ = \other
2747   \catcode`\{ = \other
2748   \catcode`\} = \other
2749   %
2750   % Make sure that spaces turn into tokens that match what \doignoretext wants.
2751   \spaceisspace
2752   %
2753   % Count number of #1's that we've seen.
2754   \doignorecount = 0
2755   %
2756   % Swallow text until we reach the matching `@end #1'.
2757   \dodoignore {#1}%
2758 }
2759
2760 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2761   \obeylines %
2762   %
2763   \gdef\dodoignore#1{%
2764     % #1 contains the string `ifinfo'.
2765     %
2766     % Define a command to find the next `@end #1', which must be on a line
2767     % by itself.
2768     \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2769     % And this command to find another #1 command, at the beginning of a
2770     % line.  (Otherwise, we would consider a line `@c @ifset', for
2771     % example, to count as an @ifset for nesting.)
2772     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2773     %
2774     % And now expand that command.
2775     \obeylines %
2776     \doignoretext ^^M%
2777   }%
2778 }
2779
2780 \def\doignoreyyy#1{%
2781   \def\temp{#1}%
2782   \ifx\temp\empty                       % Nothing found.
2783     \let\next\doignoretextzzz
2784   \else                                 % Found a nested condition, ...
2785     \advance\doignorecount by 1
2786     \let\next\doignoretextyyy           % ..., look for another.
2787     % If we're here, #1 ends with ^^M\ifinfo (for example).
2788   \fi
2789   \next #1% the token \_STOP_ is present just after this macro.
2790 }
2791
2792 % We have to swallow the remaining "\_STOP_".
2793
2794 \def\doignoretextzzz#1{%
2795   \ifnum\doignorecount = 0      % We have just found the outermost @end.
2796     \let\next\enddoignore
2797   \else                         % Still inside a nested condition.
2798     \advance\doignorecount by -1
2799     \let\next\doignoretext      % Look for the next @end.
2800   \fi
2801   \next
2802 }
2803
2804 % Finish off ignored text.
2805 \def\enddoignore{\endgroup\ignorespaces}
2806
2807
2808 % @set VAR sets the variable VAR to an empty value.
2809 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2810 %
2811 % Since we want to separate VAR from REST-OF-LINE (which might be
2812 % empty), we can't just use \parsearg; we have to insert a space of our
2813 % own to delimit the rest of the line, and then take it out again if we
2814 % didn't need it.
2815 % We rely on the fact that \parsearg sets \catcode`\ =10.
2816 %
2817 \parseargdef\set{\setyyy#1 \endsetyyy}
2818 \def\setyyy#1 #2\endsetyyy{%
2819   {%
2820     \makevalueexpandable
2821     \def\temp{#2}%
2822     \edef\next{\gdef\makecsname{SET#1}}%
2823     \ifx\temp\empty
2824       \next{}%
2825     \else
2826       \setzzz#2\endsetzzz
2827     \fi
2828   }%
2829 }
2830 % Remove the trailing space \setxxx inserted.
2831 \def\setzzz#1 \endsetzzz{\next{#1}}
2832
2833 % @clear VAR clears (i.e., unsets) the variable VAR.
2834 %
2835 \parseargdef\clear{%
2836   {%
2837     \makevalueexpandable
2838     \global\expandafter\let\csname SET#1\endcsname=\relax
2839   }%
2840 }
2841
2842 % @value{foo} gets the text saved in variable foo.
2843 \def\value{\begingroup\makevalueexpandable\valuexxx}
2844 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2845 {
2846   \catcode`\- = \active \catcode`\_ = \active
2847   %
2848   \gdef\makevalueexpandable{%
2849     \let\value = \expandablevalue
2850     % We don't want these characters active, ...
2851     \catcode`\-=\other \catcode`\_=\other
2852     % ..., but we might end up with active ones in the argument if
2853     % we're called from @code, as @code{@value{foo-bar_}}, though.
2854     % So \let them to their normal equivalents.
2855     \let-\realdash \let_\normalunderscore
2856   }
2857 }
2858
2859 % We have this subroutine so that we can handle at least some @value's
2860 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2861 % The command has to be fully expandable (if the variable is set), since
2862 % the result winds up in the index file.  This means that if the
2863 % variable's value contains other Texinfo commands, it's almost certain
2864 % it will fail (although perhaps we could fix that with sufficient work
2865 % to do a one-level expansion on the result, instead of complete).
2866 %
2867 \def\expandablevalue#1{%
2868   \expandafter\ifx\csname SET#1\endcsname\relax
2869     {[No value for ``#1'']}%
2870     \message{Variable `#1', used in @value, is not set.}%
2871   \else
2872     \csname SET#1\endcsname
2873   \fi
2874 }
2875
2876 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2877 % with @set.
2878 %
2879 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2880 %
2881 \makecond{ifset}
2882 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2883 \def\doifset#1#2{%
2884   {%
2885     \makevalueexpandable
2886     \let\next=\empty
2887     \expandafter\ifx\csname SET#2\endcsname\relax
2888       #1% If not set, redefine \next.
2889     \fi
2890     \expandafter
2891   }\next
2892 }
2893 \def\ifsetfail{\doignore{ifset}}
2894
2895 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2896 % defined with @set, or has been undefined with @clear.
2897 %
2898 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2899 % above code: if the variable is not set, do nothing, if it is set,
2900 % then redefine \next to \ifclearfail.
2901 %
2902 \makecond{ifclear}
2903 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2904 \def\ifclearfail{\doignore{ifclear}}
2905
2906 % @dircategory CATEGORY  -- specify a category of the dir file
2907 % which this file should belong to.  Ignore this in TeX.
2908 \let\dircategory=\comment
2909
2910 % @defininfoenclose.
2911 \let\definfoenclose=\comment
2912
2913
2914 \message{indexing,}
2915 % Index generation facilities
2916
2917 % Define \newwrite to be identical to plain tex's \newwrite
2918 % except not \outer, so it can be used within \newindex.
2919 {\catcode`\@=11
2920 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2921
2922 % \newindex {foo} defines an index named foo.
2923 % It automatically defines \fooindex such that
2924 % \fooindex ...rest of line... puts an entry in the index foo.
2925 % It also defines \fooindfile to be the number of the output channel for
2926 % the file that accumulates this index.  The file's extension is foo.
2927 % The name of an index should be no more than 2 characters long
2928 % for the sake of vms.
2929 %
2930 \def\newindex#1{%
2931   \iflinks
2932     \expandafter\newwrite \csname#1indfile\endcsname
2933     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2934   \fi
2935   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
2936     \noexpand\doindex{#1}}
2937 }
2938
2939 % @defindex foo  ==  \newindex{foo}
2940 %
2941 \def\defindex{\parsearg\newindex}
2942
2943 % Define @defcodeindex, like @defindex except put all entries in @code.
2944 %
2945 \def\defcodeindex{\parsearg\newcodeindex}
2946 %
2947 \def\newcodeindex#1{%
2948   \iflinks
2949     \expandafter\newwrite \csname#1indfile\endcsname
2950     \openout \csname#1indfile\endcsname \jobname.#1
2951   \fi
2952   \expandafter\xdef\csname#1index\endcsname{%
2953     \noexpand\docodeindex{#1}}%
2954 }
2955
2956
2957 % @synindex foo bar    makes index foo feed into index bar.
2958 % Do this instead of @defindex foo if you don't want it as a separate index.
2959 %
2960 % @syncodeindex foo bar   similar, but put all entries made for index foo
2961 % inside @code.
2962 %
2963 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2964 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2965
2966 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2967 % #3 the target index (bar).
2968 \def\dosynindex#1#2#3{%
2969   % Only do \closeout if we haven't already done it, else we'll end up
2970   % closing the target index.
2971   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2972     % The \closeout helps reduce unnecessary open files; the limit on the
2973     % Acorn RISC OS is a mere 16 files.
2974     \expandafter\closeout\csname#2indfile\endcsname
2975     \expandafter\let\csname\donesynindex#2\endcsname = 1
2976   \fi
2977   % redefine \fooindfile:
2978   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2979   \expandafter\let\csname#2indfile\endcsname=\temp
2980   % redefine \fooindex:
2981   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2982 }
2983
2984 % Define \doindex, the driver for all \fooindex macros.
2985 % Argument #1 is generated by the calling \fooindex macro,
2986 %  and it is "foo", the name of the index.
2987
2988 % \doindex just uses \parsearg; it calls \doind for the actual work.
2989 % This is because \doind is more useful to call from other macros.
2990
2991 % There is also \dosubind {index}{topic}{subtopic}
2992 % which makes an entry in a two-level index such as the operation index.
2993
2994 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2995 \def\singleindexer #1{\doind{\indexname}{#1}}
2996
2997 % like the previous two, but they put @code around the argument.
2998 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2999 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3000
3001 % Take care of Texinfo commands that can appear in an index entry.
3002 % Since there are some commands we want to expand, and others we don't,
3003 % we have to laboriously prevent expansion for those that we don't.
3004 %
3005 \def\indexdummies{%
3006   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3007   \def\ {\realbackslash\space }%
3008   % Need these in case \tex is in effect and \{ is a \delimiter again.
3009   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3010   % braces and backslashes are used only as delimiters.
3011   \let\{ = \mylbrace
3012   \let\} = \myrbrace
3013   %
3014   % \definedummyword defines \#1 as \realbackslash #1\space, thus
3015   % effectively preventing its expansion.  This is used only for control
3016   % words, not control letters, because the \space would be incorrect
3017   % for control characters, but is needed to separate the control word
3018   % from whatever follows.
3019   %
3020   % For control letters, we have \definedummyletter, which omits the
3021   % space.
3022   %
3023   % These can be used both for control words that take an argument and
3024   % those that do not.  If it is followed by {arg} in the input, then
3025   % that will dutifully get written to the index (or wherever).
3026   %
3027   \def\definedummyword##1{%
3028     \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3029   }%
3030   \def\definedummyletter##1{%
3031     \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3032   }%
3033   %
3034   % Do the redefinitions.
3035   \commondummies
3036 }
3037
3038 % For the aux file, @ is the escape character.  So we want to redefine
3039 % everything using @ instead of \realbackslash.  When everything uses
3040 % @, this will be simpler.
3041 %
3042 \def\atdummies{%
3043   \def\@{@@}%
3044   \def\ {@ }%
3045   \let\{ = \lbraceatcmd
3046   \let\} = \rbraceatcmd
3047   %
3048   % (See comments in \indexdummies.)
3049   \def\definedummyword##1{%
3050     \expandafter\def\csname ##1\endcsname{@##1\space}%
3051   }%
3052   \def\definedummyletter##1{%
3053     \expandafter\def\csname ##1\endcsname{@##1}%
3054   }%
3055   %
3056   % Do the redefinitions.
3057   \commondummies
3058 }
3059
3060 % Called from \indexdummies and \atdummies.  \definedummyword and
3061 % \definedummyletter must be defined first.
3062 %
3063 \def\commondummies{%
3064   %
3065   \normalturnoffactive
3066   %
3067   \commondummiesnofonts
3068   %
3069   \definedummyletter{_}%
3070   %
3071   % Non-English letters.
3072   \definedummyword{AA}%
3073   \definedummyword{AE}%
3074   \definedummyword{L}%
3075   \definedummyword{OE}%
3076   \definedummyword{O}%
3077   \definedummyword{aa}%
3078   \definedummyword{ae}%
3079   \definedummyword{l}%
3080   \definedummyword{oe}%
3081   \definedummyword{o}%
3082   \definedummyword{ss}%
3083   \definedummyword{exclamdown}%
3084   \definedummyword{questiondown}%
3085   \definedummyword{ordm}%
3086   \definedummyword{ordf}%
3087   %
3088   % Although these internal commands shouldn't show up, sometimes they do.
3089   \definedummyword{bf}%
3090   \definedummyword{gtr}%
3091   \definedummyword{hat}%
3092   \definedummyword{less}%
3093   \definedummyword{sf}%
3094   \definedummyword{sl}%
3095   \definedummyword{tclose}%
3096   \definedummyword{tt}%
3097   %
3098   \definedummyword{LaTeX}%
3099   \definedummyword{TeX}%
3100   \definedummyword{dots}%
3101   %
3102   % Assorted special characters.
3103   \definedummyword{bullet}%
3104   \definedummyword{copyright}%
3105   \definedummyword{registeredsymbol}%
3106   \definedummyword{dots}%
3107   \definedummyword{enddots}%
3108   \definedummyword{equiv}%
3109   \definedummyword{error}%
3110   \definedummyword{expansion}%
3111   \definedummyword{minus}%
3112   \definedummyword{pounds}%
3113   \definedummyword{point}%
3114   \definedummyword{print}%
3115   \definedummyword{result}%
3116   %
3117   % Handle some cases of @value -- where it does not contain any
3118   % (non-fully-expandable) commands.
3119   \makevalueexpandable
3120   %
3121   % Normal spaces, not active ones.
3122   \unsepspaces
3123   %
3124   % No macro expansion.
3125   \turnoffmacros
3126 }
3127
3128 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3129 %
3130 % Better have this without active chars.
3131 {
3132   \catcode`\~=\other
3133   \gdef\commondummiesnofonts{%
3134     % Control letters and accents.
3135     \definedummyletter{,}%
3136     \definedummyletter{"}%
3137     \definedummyletter{`}%
3138     \definedummyletter{'}%
3139     \definedummyletter{^}%
3140     \definedummyletter{~}%
3141     \definedummyletter{=}%
3142     \definedummyword{u}%
3143     \definedummyword{v}%
3144     \definedummyword{H}%
3145     \definedummyword{dotaccent}%
3146     \definedummyword{ringaccent}%
3147     \definedummyword{tieaccent}%
3148     \definedummyword{ubaraccent}%
3149     \definedummyword{udotaccent}%
3150     \definedummyword{dotless}%
3151     %
3152     % Texinfo font commands.
3153     \definedummyword{b}%
3154     \definedummyword{i}%
3155     \definedummyword{r}%
3156     \definedummyword{sc}%
3157     \definedummyword{t}%
3158     %
3159     \definedummyword{acronym}%
3160     \definedummyword{cite}%
3161     \definedummyword{code}%
3162     \definedummyword{command}%
3163     \definedummyword{dfn}%
3164     \definedummyword{emph}%
3165     \definedummyword{env}%
3166     \definedummyword{file}%
3167     \definedummyword{kbd}%
3168     \definedummyword{key}%
3169     \definedummyword{math}%
3170     \definedummyword{option}%
3171     \definedummyword{samp}%
3172     \definedummyword{strong}%
3173     \definedummyword{uref}%
3174     \definedummyword{url}%
3175     \definedummyword{var}%
3176     \definedummyword{verb}%
3177     \definedummyword{w}%
3178   }
3179 }
3180
3181 % \indexnofonts is used when outputting the strings to sort the index
3182 % by, and when constructing control sequence names.  It eliminates all
3183 % control sequences and just writes whatever the best ASCII sort string
3184 % would be for a given command (usually its argument).
3185 %
3186 \def\indexnofonts{%
3187   \def\definedummyword##1{%
3188     \expandafter\let\csname ##1\endcsname\asis
3189   }%
3190   \let\definedummyletter=\definedummyword
3191   %
3192   \commondummiesnofonts
3193   %
3194   % Don't no-op \tt, since it isn't a user-level command
3195   % and is used in the definitions of the active chars like <, >, |, etc.
3196   % Likewise with the other plain tex font commands.
3197   %\let\tt=\asis
3198   %
3199   \def\ { }%
3200   \def\@{@}%
3201   % how to handle braces?
3202   \def\_{\normalunderscore}%
3203   %
3204   % Non-English letters.
3205   \def\AA{AA}%
3206   \def\AE{AE}%
3207   \def\L{L}%
3208   \def\OE{OE}%
3209   \def\O{O}%
3210   \def\aa{aa}%
3211   \def\ae{ae}%
3212   \def\l{l}%
3213   \def\oe{oe}%
3214   \def\o{o}%
3215   \def\ss{ss}%
3216   \def\exclamdown{!}%
3217   \def\questiondown{?}%
3218   \def\ordf{a}%
3219   \def\ordm{o}%
3220   %
3221   \def\LaTeX{LaTeX}%
3222   \def\TeX{TeX}%
3223   \def\dots{...}%
3224 }
3225
3226 \let\indexbackslash=0  %overridden during \printindex.
3227 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3228
3229 % Most index entries go through here, but \dosubind is the general case.
3230 % #1 is the index name, #2 is the entry text.
3231 \def\doind#1#2{\dosubind{#1}{#2}{}}
3232
3233 % Workhorse for all \fooindexes.
3234 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3235 % empty if called from \doind, as we usually are (the main exception
3236 % is with most defuns, which call us directly).
3237 %
3238 \def\dosubind#1#2#3{%
3239   \iflinks
3240   {%
3241     % Store the main index entry text (including the third arg).
3242     \toks0 = {#2}%
3243     % If third arg is present, precede it with a space.
3244     \def\thirdarg{#3}%
3245     \ifx\thirdarg\empty \else
3246       \toks0 = \expandafter{\the\toks0 \space #3}%
3247     \fi
3248     %
3249     \edef\writeto{\csname#1indfile\endcsname}%
3250     %
3251     \ifvmode
3252       \dosubindsanitize
3253     \else
3254       \dosubindwrite
3255     \fi
3256   }%
3257   \fi
3258 }
3259
3260 % Write the entry in \toks0 to the index file:
3261 %
3262 \def\dosubindwrite{%
3263   % Put the index entry in the margin if desired.
3264   \ifx\SETmarginindex\relax\else
3265     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3266   \fi
3267   %
3268   % Remember, we are within a group.
3269   \indexdummies % Must do this here, since \bf, etc expand at this stage
3270   \escapechar=`\\
3271   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3272       % so it will be output as is; and it will print as backslash.
3273   %
3274   % Process the index entry with all font commands turned off, to
3275   % get the string to sort by.
3276   {\indexnofonts
3277    \edef\temp{\the\toks0}% need full expansion
3278    \xdef\indexsorttmp{\temp}%
3279   }%
3280   %
3281   % Set up the complete index entry, with both the sort key and
3282   % the original text, including any font commands.  We write
3283   % three arguments to \entry to the .?? file (four in the
3284   % subentry case), texindex reduces to two when writing the .??s
3285   % sorted result.
3286   \edef\temp{%
3287     \write\writeto{%
3288       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3289   }%
3290   \temp
3291 }
3292
3293 % Take care of unwanted page breaks:
3294 %
3295 % If a skip is the last thing on the list now, preserve it
3296 % by backing up by \lastskip, doing the \write, then inserting
3297 % the skip again.  Otherwise, the whatsit generated by the
3298 % \write will make \lastskip zero.  The result is that sequences
3299 % like this:
3300 % @end defun
3301 % @tindex whatever
3302 % @defun ...
3303 % will have extra space inserted, because the \medbreak in the
3304 % start of the @defun won't see the skip inserted by the @end of
3305 % the previous defun.
3306 %
3307 % But don't do any of this if we're not in vertical mode.  We
3308 % don't want to do a \vskip and prematurely end a paragraph.
3309 %
3310 % Avoid page breaks due to these extra skips, too.
3311 %
3312 % But wait, there is a catch there:
3313 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
3314 % sufficient for this purpose, as it ignores stretch and shrink parts
3315 % of the skip.  The only way seems to be to check the textual
3316 % representation of the skip.
3317 %
3318 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3319 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3320 %
3321 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3322 %
3323 % ..., ready, GO:
3324 %
3325 \def\dosubindsanitize{%
3326   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3327   \skip0 = \lastskip
3328   \edef\lastskipmacro{\the\lastskip}%
3329   \count255 = \lastpenalty
3330   %
3331   % If \lastskip is nonzero, that means the last item was a
3332   % skip.  And since a skip is discardable, that means this
3333   % -\skip0 glue we're inserting is preceded by a
3334   % non-discardable item, therefore it is not a potential
3335   % breakpoint, therefore no \nobreak needed.
3336   \ifx\lastskipmacro\zeroskipmacro
3337   \else
3338     \vskip-\skip0
3339   \fi
3340   %
3341   \dosubindwrite
3342   %
3343   \ifx\lastskipmacro\zeroskipmacro
3344     % if \lastskip was zero, perhaps the last item was a
3345     % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3346     % In that case, we want to re-insert the penalty; since we
3347     % just inserted a non-discardable item, any following glue
3348     % (such as a \parskip) would be a breakpoint.  For example:
3349     %   @deffn deffn-whatever
3350     %   @vindex index-whatever
3351     %   Description.
3352     % would allow a break between the index-whatever whatsit
3353     % and the "Description." paragraph.
3354     \ifnum\count255>9999 \nobreak \fi
3355   \else
3356     % On the other hand, if we had a nonzero \lastskip,
3357     % this make-up glue would be preceded by a non-discardable item
3358     % (the whatsit from the \write), so we must insert a \nobreak.
3359     \nobreak\vskip\skip0
3360   \fi
3361 }
3362
3363 % The index entry written in the file actually looks like
3364 %  \entry {sortstring}{page}{topic}
3365 % or
3366 %  \entry {sortstring}{page}{topic}{subtopic}
3367 % The texindex program reads in these files and writes files
3368 % containing these kinds of lines:
3369 %  \initial {c}
3370 %     before the first topic whose initial is c
3371 %  \entry {topic}{pagelist}
3372 %     for a topic that is used without subtopics
3373 %  \primary {topic}
3374 %     for the beginning of a topic that is used with subtopics
3375 %  \secondary {subtopic}{pagelist}
3376 %     for each subtopic.
3377
3378 % Define the user-accessible indexing commands
3379 % @findex, @vindex, @kindex, @cindex.
3380
3381 \def\findex {\fnindex}
3382 \def\kindex {\kyindex}
3383 \def\cindex {\cpindex}
3384 \def\vindex {\vrindex}
3385 \def\tindex {\tpindex}
3386 \def\pindex {\pgindex}
3387
3388 \def\cindexsub {\begingroup\obeylines\cindexsub}
3389 {\obeylines %
3390 \gdef\cindexsub "#1" #2^^M{\endgroup %
3391 \dosubind{cp}{#2}{#1}}}
3392
3393 % Define the macros used in formatting output of the sorted index material.
3394
3395 % @printindex causes a particular index (the ??s file) to get printed.
3396 % It does not print any chapter heading (usually an @unnumbered).
3397 %
3398 \parseargdef\printindex{\begingroup
3399   \dobreak \chapheadingskip{10000}%
3400   %
3401   \smallfonts \rm
3402   \tolerance = 9500
3403   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3404   %
3405   % See if the index file exists and is nonempty.
3406   % Change catcode of @ here so that if the index file contains
3407   % \initial {@}
3408   % as its first line, TeX doesn't complain about mismatched braces
3409   % (because it thinks @} is a control sequence).
3410   \catcode`\@ = 11
3411   \openin 1 \jobname.#1s
3412   \ifeof 1
3413     % \enddoublecolumns gets confused if there is no text in the index,
3414     % and it loses the chapter title and the aux file entries for the
3415     % index.  The easiest way to prevent this problem is to make sure
3416     % there is some text.
3417     \putwordIndexNonexistent
3418   \else
3419     %
3420     % If the index file exists but is empty, then \openin leaves \ifeof
3421     % false.  We have to make TeX try to read something from the file, so
3422     % it can discover if there is anything in it.
3423     \read 1 to \temp
3424     \ifeof 1
3425       \putwordIndexIsEmpty
3426     \else
3427       % Index files are almost Texinfo source, but we use \ as the escape
3428       % character.  It would be better to use @, but that's too big a change
3429       % to make right now.
3430       \def\indexbackslash{\backslashcurfont}%
3431       \catcode`\\ = 0
3432       \escapechar = `\\
3433       \begindoublecolumns
3434       \input \jobname.#1s
3435       \enddoublecolumns
3436     \fi
3437   \fi
3438   \closein 1
3439 \endgroup}
3440
3441 % These macros are used by the sorted index file itself.
3442 % Change them to control the appearance of the index.
3443
3444 \def\initial#1{{%
3445   % Some minor font changes for the special characters.
3446   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3447   %
3448   % Remove any glue we may have, we'll be inserting our own.
3449   \removelastskip
3450   %
3451   % We like breaks before the index initials, so insert a bonus.
3452   \penalty -300
3453   %
3454   % Typeset the initial.  Making this add up to a whole number of
3455   % baselineskips increases the chance of the dots lining up from column
3456   % to column.  It still won't often be perfect, because of the stretch
3457   % we need before each entry, but it's better.
3458   %
3459   % No shrink because it confuses \balancecolumns.
3460   \vskip 1.67\baselineskip plus .5\baselineskip
3461   \leftline{\secbf #1}%
3462   \vskip .33\baselineskip plus .1\baselineskip
3463   %
3464   % Do our best not to break after the initial.
3465   \nobreak
3466 }}
3467
3468 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3469 % then page number (#2) flushed to the right margin.  It is used for index
3470 % and table of contents entries.  The paragraph is indented by \leftskip.
3471 %
3472 % A straigtforward implementation would start like this:
3473 %       \def\entry#1#2{...
3474 % But this frozes the catcodes in the argument, and can cause problems to
3475 % @code, which set's active ``-''.  This problem was fixed by a kludge---
3476 % ``-'' was active throughout whole index, but this isn't what we really
3477 % want.
3478 % The right solution is to prevent \entry from swallowing the whole text.
3479 %                                 --kasal, 21nov03
3480 \def\entry{%
3481   \begingroup
3482     %
3483     % Start a new paragraph if necessary, so our assignments below can't
3484     % affect previous text.
3485     \par
3486     %
3487     % Do not fill out the last line with white space.
3488     \parfillskip = 0in
3489     %
3490     % No extra space above this paragraph.
3491     \parskip = 0in
3492     %
3493     % Do not prefer a separate line ending with a hyphen to fewer lines.
3494     \finalhyphendemerits = 0
3495     %
3496     % \hangindent is only relevant when the entry text and page number
3497     % don't both fit on one line.  In that case, bob suggests starting the
3498     % dots pretty far over on the line.  Unfortunately, a large
3499     % indentation looks wrong when the entry text itself is broken across
3500     % lines.  So we use a small indentation and put up with long leaders.
3501     %
3502     % \hangafter is reset to 1 (which is the value we want) at the start
3503     % of each paragraph, so we need not do anything with that.
3504     \hangindent = 2em
3505     %
3506     % When the entry text needs to be broken, just fill out the first line
3507     % with blank space.
3508     \rightskip = 0pt plus1fil
3509     %
3510     % A bit of stretch before each entry for the benefit of balancing
3511     % columns.
3512     \vskip 0pt plus1pt
3513     %
3514     % Swallow the left brace of the text (first parameter):
3515     \afterassignment\doentry
3516     \let\temp =
3517 }
3518 \def\doentry{%
3519     \bgroup % Instead of the swallowed brace.
3520       \noindent
3521       \aftergroup\finishentry
3522       % And now comes the text of the entry.
3523 }
3524 \def\finishentry#1{%
3525     % #1 is the page number.
3526     %
3527     % The following is kludged to not output a line of dots in the index if
3528     % there are no page numbers.  The next person who breaks this will be
3529     % cursed by a Unix daemon.
3530     \def\tempa{{\rm }}%
3531     \def\tempb{#1}%
3532     \edef\tempc{\tempa}%
3533     \edef\tempd{\tempb}%
3534     \ifx\tempc\tempd
3535       \ %
3536     \else
3537       %
3538       % If we must, put the page number on a line of its own, and fill out
3539       % this line with blank space.  (The \hfil is overwhelmed with the
3540       % fill leaders glue in \indexdotfill if the page number does fit.)
3541       \hfil\penalty50
3542       \null\nobreak\indexdotfill % Have leaders before the page number.
3543       %
3544       % The `\ ' here is removed by the implicit \unskip that TeX does as
3545       % part of (the primitive) \par.  Without it, a spurious underfull
3546       % \hbox ensues.
3547       \ifpdf
3548         \pdfgettoks#1.\ \the\toksA
3549       \else
3550         \ #1%
3551       \fi
3552     \fi
3553     \par
3554   \endgroup
3555 }
3556
3557 % Like \dotfill except takes at least 1 em.
3558 \def\indexdotfill{\cleaders
3559   \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3560
3561 \def\primary #1{\line{#1\hfil}}
3562
3563 \newskip\secondaryindent \secondaryindent=0.5cm
3564 \def\secondary#1#2{{%
3565   \parfillskip=0in
3566   \parskip=0in
3567   \hangindent=1in
3568   \hangafter=1
3569   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3570   \ifpdf
3571     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3572   \else
3573     #2
3574   \fi
3575   \par
3576 }}
3577
3578 % Define two-column mode, which we use to typeset indexes.
3579 % Adapted from the TeXbook, page 416, which is to say,
3580 % the manmac.tex format used to print the TeXbook itself.
3581 \catcode`\@=11
3582
3583 \newbox\partialpage
3584 \newdimen\doublecolumnhsize
3585
3586 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3587   % Grab any single-column material above us.
3588   \output = {%
3589     %
3590     % Here is a possibility not foreseen in manmac: if we accumulate a
3591     % whole lot of material, we might end up calling this \output
3592     % routine twice in a row (see the doublecol-lose test, which is
3593     % essentially a couple of indexes with @setchapternewpage off).  In
3594     % that case we just ship out what is in \partialpage with the normal
3595     % output routine.  Generally, \partialpage will be empty when this
3596     % runs and this will be a no-op.  See the indexspread.tex test case.
3597     \ifvoid\partialpage \else
3598       \onepageout{\pagecontents\partialpage}%
3599     \fi
3600     %
3601     \global\setbox\partialpage = \vbox{%
3602       % Unvbox the main output page.
3603       \unvbox\PAGE
3604       \kern-\topskip \kern\baselineskip
3605     }%
3606   }%
3607   \eject % run that output routine to set \partialpage
3608   %
3609   % Use the double-column output routine for subsequent pages.
3610   \output = {\doublecolumnout}%
3611   %
3612   % Change the page size parameters.  We could do this once outside this
3613   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3614   % format, but then we repeat the same computation.  Repeating a couple
3615   % of assignments once per index is clearly meaningless for the
3616   % execution time, so we may as well do it in one place.
3617   %
3618   % First we halve the line length, less a little for the gutter between
3619   % the columns.  We compute the gutter based on the line length, so it
3620   % changes automatically with the paper format.  The magic constant
3621   % below is chosen so that the gutter has the same value (well, +-<1pt)
3622   % as it did when we hard-coded it.
3623   %
3624   % We put the result in a separate register, \doublecolumhsize, so we
3625   % can restore it in \pagesofar, after \hsize itself has (potentially)
3626   % been clobbered.
3627   %
3628   \doublecolumnhsize = \hsize
3629     \advance\doublecolumnhsize by -.04154\hsize
3630     \divide\doublecolumnhsize by 2
3631   \hsize = \doublecolumnhsize
3632   %
3633   % Double the \vsize as well.  (We don't need a separate register here,
3634   % since nobody clobbers \vsize.)
3635   \vsize = 2\vsize
3636 }
3637
3638 % The double-column output routine for all double-column pages except
3639 % the last.
3640 %
3641 \def\doublecolumnout{%
3642   \splittopskip=\topskip \splitmaxdepth=\maxdepth
3643   % Get the available space for the double columns -- the normal
3644   % (undoubled) page height minus any material left over from the
3645   % previous page.
3646   \dimen@ = \vsize
3647   \divide\dimen@ by 2
3648   \advance\dimen@ by -\ht\partialpage
3649   %
3650   % box0 will be the left-hand column, box2 the right.
3651   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3652   \onepageout\pagesofar
3653   \unvbox255
3654   \penalty\outputpenalty
3655 }
3656 %
3657 % Re-output the contents of the output page -- any previous material,
3658 % followed by the two boxes we just split, in box0 and box2.
3659 \def\pagesofar{%
3660   \unvbox\partialpage
3661   %
3662   \hsize = \doublecolumnhsize
3663   \wd0=\hsize \wd2=\hsize
3664   \hbox to\pagewidth{\box0\hfil\box2}%
3665 }
3666 %
3667 % All done with double columns.
3668 \def\enddoublecolumns{%
3669   \output = {%
3670     % Split the last of the double-column material.  Leave it on the
3671     % current page, no automatic page break.
3672     \balancecolumns
3673     %
3674     % If we end up splitting too much material for the current page,
3675     % though, there will be another page break right after this \output
3676     % invocation ends.  Having called \balancecolumns once, we do not
3677     % want to call it again.  Therefore, reset \output to its normal
3678     % definition right away.  (We hope \balancecolumns will never be
3679     % called on to balance too much material, but if it is, this makes
3680     % the output somewhat more palatable.)
3681     \global\output = {\onepageout{\pagecontents\PAGE}}%
3682   }%
3683   \eject
3684   \endgroup % started in \begindoublecolumns
3685   %
3686   % \pagegoal was set to the doubled \vsize above, since we restarted
3687   % the current page.  We're now back to normal single-column
3688   % typesetting, so reset \pagegoal to the normal \vsize (after the
3689   % \endgroup where \vsize got restored).
3690   \pagegoal = \vsize
3691 }
3692 %
3693 % Called at the end of the double column material.
3694 \def\balancecolumns{%
3695   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3696   \dimen@ = \ht0
3697   \advance\dimen@ by \topskip
3698   \advance\dimen@ by-\baselineskip
3699   \divide\dimen@ by 2 % target to split to
3700   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3701   \splittopskip = \topskip
3702   % Loop until we get a decent breakpoint.
3703   {%
3704     \vbadness = 10000
3705     \loop
3706       \global\setbox3 = \copy0
3707       \global\setbox1 = \vsplit3 to \dimen@
3708     \ifdim\ht3>\dimen@
3709       \global\advance\dimen@ by 1pt
3710     \repeat
3711   }%
3712   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3713   \setbox0=\vbox to\dimen@{\unvbox1}%
3714   \setbox2=\vbox to\dimen@{\unvbox3}%
3715   %
3716   \pagesofar
3717 }
3718 \catcode`\@ = \other
3719
3720
3721 \message{sectioning,}
3722 % Chapters, sections, etc.
3723
3724 % \unnumberedno is an oxymoron, of course.  But we count the unnumbered
3725 % sections so that we can refer to them unambiguously in the pdf
3726 % outlines by their "section number".  We avoid collisions with chapter
3727 % numbers by starting them at 10000.  (If a document ever has 10000
3728 % chapters, we're in trouble anyway, I'm sure.)
3729 \newcount\unnumberedno \unnumberedno = 10000
3730 \newcount\chapno
3731 \newcount\secno        \secno=0
3732 \newcount\subsecno     \subsecno=0
3733 \newcount\subsubsecno  \subsubsecno=0
3734
3735 % This counter is funny since it counts through charcodes of letters A, B, ...
3736 \newcount\appendixno  \appendixno = `\@
3737 %
3738 % \def\appendixletter{\char\the\appendixno}
3739 % We do the following ugly conditional instead of the above simple
3740 % construct for the sake of pdftex, which needs the actual
3741 % letter in the expansion, not just typeset.
3742
3743 \def\appendixletter{%
3744   \ifnum\appendixno=`A A%
3745   \else\ifnum\appendixno=`B B%
3746   \else\ifnum\appendixno=`C C%
3747   \else\ifnum\appendixno=`D D%
3748   \else\ifnum\appendixno=`E E%
3749   \else\ifnum\appendixno=`F F%
3750   \else\ifnum\appendixno=`G G%
3751   \else\ifnum\appendixno=`H H%
3752   \else\ifnum\appendixno=`I I%
3753   \else\ifnum\appendixno=`J J%
3754   \else\ifnum\appendixno=`K K%
3755   \else\ifnum\appendixno=`L L%
3756   \else\ifnum\appendixno=`M M%
3757   \else\ifnum\appendixno=`N N%
3758   \else\ifnum\appendixno=`O O%
3759   \else\ifnum\appendixno=`P P%
3760   \else\ifnum\appendixno=`Q Q%
3761   \else\ifnum\appendixno=`R R%
3762   \else\ifnum\appendixno=`S S%
3763   \else\ifnum\appendixno=`T T%
3764   \else\ifnum\appendixno=`U U%
3765   \else\ifnum\appendixno=`V V%
3766   \else\ifnum\appendixno=`W W%
3767   \else\ifnum\appendixno=`X X%
3768   \else\ifnum\appendixno=`Y Y%
3769   \else\ifnum\appendixno=`Z Z%
3770   % The \the is necessary, despite appearances, because \appendixletter is
3771   % expanded while writing the .toc file.  \char\appendixno is not
3772   % expandable, thus it is written literally, thus all appendixes come out
3773   % with the same letter (or @) in the toc without it.
3774   \else\char\the\appendixno
3775   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3776   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3777
3778 % Each @chapter defines this as the name of the chapter.
3779 % page headings and footings can use it.  @section does likewise.
3780 % However, they are not reliable, because we don't use marks.
3781 \def\thischapter{}
3782 \def\thissection{}
3783
3784 \newcount\absseclevel % used to calculate proper heading level
3785 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3786
3787 % @raisesections: treat @section as chapter, @subsection as section, etc.
3788 \def\raisesections{\global\advance\secbase by -1}
3789 \let\up=\raisesections % original BFox name
3790
3791 % @lowersections: treat @chapter as section, @section as subsection, etc.
3792 \def\lowersections{\global\advance\secbase by 1}
3793 \let\down=\lowersections % original BFox name
3794
3795 % Choose a numbered-heading macro
3796 % #1 is heading level if unmodified by @raisesections or @lowersections
3797 % #2 is text for heading
3798 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3799 \ifcase\absseclevel
3800       \chapterzzz{#2}%
3801   \or \seczzz{#2}%
3802   \or \numberedsubseczzz{#2}%
3803   \or \numberedsubsubseczzz{#2}%
3804   \else
3805     \ifnum \absseclevel<0 \chapterzzz{#2}%
3806     \else \numberedsubsubseczzz{#2}%
3807     \fi
3808   \fi
3809   \suppressfirstparagraphindent
3810 }
3811
3812 % like \numhead, but chooses appendix heading levels
3813 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3814 \ifcase\absseclevel
3815       \appendixzzz{#2}%
3816   \or \appendixsectionzzz{#2}%
3817   \or \appendixsubseczzz{#2}%
3818   \or \appendixsubsubseczzz{#2}%
3819   \else
3820     \ifnum \absseclevel<0 \appendixzzz{#2}%
3821     \else \appendixsubsubseczzz{#2}%
3822     \fi
3823   \fi
3824   \suppressfirstparagraphindent
3825 }
3826
3827 % like \numhead, but chooses numberless heading levels
3828 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3829   \ifcase\absseclevel
3830       \unnumberedzzz{#2}%
3831   \or \unnumberedseczzz{#2}%
3832   \or \unnumberedsubseczzz{#2}%
3833   \or \unnumberedsubsubseczzz{#2}%
3834   \else
3835     \ifnum \absseclevel<0 \unnumberedzzz{#2}%
3836     \else \unnumberedsubsubseczzz{#2}%
3837     \fi
3838   \fi
3839   \suppressfirstparagraphindent
3840 }
3841
3842 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
3843 % all lower-level sectioning counters to zero.
3844
3845 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3846 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
3847 \let\chaplevelprefix = \empty
3848
3849 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3850 \def\chapterzzz#1{%
3851   % section resetting is \global in case the chapter is in a group, such
3852   % as an @include file.
3853   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3854     \global\advance\chapno by 1
3855   %
3856   % Used for \float.
3857   \gdef\chaplevelprefix{\the\chapno.}%
3858   \resetallfloatnos
3859   %
3860   \message{\putwordChapter\space \the\chapno}%
3861   %
3862   % Write the actual heading.
3863   \chapmacro{#1}{Ynumbered}{\the\chapno}%
3864   %
3865   % So @section and the like are numbered underneath this chapter.
3866   \global\let\section = \numberedsec
3867   \global\let\subsection = \numberedsubsec
3868   \global\let\subsubsection = \numberedsubsubsec
3869 }
3870
3871 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3872 \def\appendixzzz#1{%
3873   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3874     \global\advance\appendixno by 1
3875   \gdef\chaplevelprefix{\appendixletter.}%
3876   \resetallfloatnos
3877   %
3878   \def\appendixnum{\putwordAppendix\space \appendixletter}%
3879   \message{\appendixnum}%
3880   %
3881   \chapmacro{#1}{Yappendix}{\appendixletter}%
3882   %
3883   \global\let\section = \appendixsec
3884   \global\let\subsection = \appendixsubsec
3885   \global\let\subsubsection = \appendixsubsubsec
3886 }
3887
3888 % @centerchap is like @unnumbered, but the heading is centered.
3889 \outer\parseargdef\centerchap{{\unnumberedyyy{#1}}}
3890
3891 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3892 \def\unnumberedzzz#1{%
3893   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3894     \global\advance\unnumberedno by 1
3895   %
3896   % Since an unnumbered has no number, no prefix for figures.
3897   \global\let\chaplevelprefix = \empty
3898   \resetallfloatnos
3899   %
3900   % This used to be simply \message{#1}, but TeX fully expands the
3901   % argument to \message.  Therefore, if #1 contained @-commands, TeX
3902   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
3903   % expanded @cite (which turns out to cause errors because \cite is meant
3904   % to be executed, not expanded).
3905   %
3906   % Anyway, we don't want the fully-expanded definition of @cite to appear
3907   % as a result of the \message, we just want `@cite' itself.  We use
3908   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3909   % simply yielding the contents of <toks register>.  (We also do this for
3910   % the toc entries.)
3911   \toks0 = {#1}%
3912   \message{(\the\toks0)}%
3913   %
3914   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
3915   %
3916   \global\let\section = \unnumberedsec
3917   \global\let\subsection = \unnumberedsubsec
3918   \global\let\subsubsection = \unnumberedsubsubsec
3919 }
3920
3921 % @top is like @unnumbered.
3922 \let\top\unnumbered
3923
3924 % Sections.
3925 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
3926 \def\seczzz#1{%
3927   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3928   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3929 }
3930
3931 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
3932 \def\appendixsectionzzz#1{%
3933   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3934   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3935 }
3936 \let\appendixsec\appendixsection
3937
3938 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
3939 \def\unnumberedseczzz#1{%
3940   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
3941   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3942 }
3943
3944 % Subsections.
3945 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
3946 \def\numberedsubseczzz#1{%
3947   \global\subsubsecno=0  \global\advance\subsecno by 1
3948   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3949 }
3950
3951 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
3952 \def\appendixsubseczzz#1{%
3953   \global\subsubsecno=0  \global\advance\subsecno by 1
3954   \sectionheading{#1}{subsec}{Yappendix}%
3955                  {\appendixletter.\the\secno.\the\subsecno}%
3956 }
3957
3958 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3959 \def\unnumberedsubseczzz#1{%
3960   \global\subsubsecno=0  \global\advance\subsecno by 1
3961   \sectionheading{#1}{subsec}{Ynothing}%
3962                  {\the\unnumberedno.\the\secno.\the\subsecno}%
3963 }
3964
3965 % Subsubsections.
3966 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
3967 \def\numberedsubsubseczzz#1{%
3968   \global\advance\subsubsecno by 1
3969   \sectionheading{#1}{subsubsec}{Ynumbered}%
3970                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
3971 }
3972
3973 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
3974 \def\appendixsubsubseczzz#1{%
3975   \global\advance\subsubsecno by 1
3976   \sectionheading{#1}{subsubsec}{Yappendix}%
3977                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
3978 }
3979
3980 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3981 \def\unnumberedsubsubseczzz#1{%
3982   \global\advance\subsubsecno by 1
3983   \sectionheading{#1}{subsubsec}{Ynothing}%
3984                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
3985 }
3986
3987 % These are variants which are not "outer", so they can appear in @ifinfo.
3988 % Actually, they are now be obsolete; ordinary section commands should work.
3989 \def\infotop{\parsearg\unnumberedzzz}
3990 \def\infounnumbered{\parsearg\unnumberedzzz}
3991 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3992 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3993 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3994
3995 \def\infoappendix{\parsearg\appendixzzz}
3996 \def\infoappendixsec{\parsearg\appendixseczzz}
3997 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3998 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3999
4000 \def\infochapter{\parsearg\chapterzzz}
4001 \def\infosection{\parsearg\sectionzzz}
4002 \def\infosubsection{\parsearg\subsectionzzz}
4003 \def\infosubsubsection{\parsearg\subsubsectionzzz}
4004
4005 % These macros control what the section commands do, according
4006 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4007 % Define them by default for a numbered chapter.
4008 \let\section = \numberedsec
4009 \let\subsection = \numberedsubsec
4010 \let\subsubsection = \numberedsubsubsec
4011
4012 % Define @majorheading, @heading and @subheading
4013
4014 % NOTE on use of \vbox for chapter headings, section headings, and such:
4015 %       1) We use \vbox rather than the earlier \line to permit
4016 %          overlong headings to fold.
4017 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
4018 %          heading is obnoxious; this forbids it.
4019 %       3) Likewise, headings look best if no \parindent is used, and
4020 %          if justification is not attempted.  Hence \raggedright.
4021
4022
4023 \def\majorheading{%
4024   {\advance\chapheadingskip by 10pt \chapbreak }%
4025   \parsearg\chapheadingzzz
4026 }
4027
4028 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4029 \def\chapheadingzzz#1{%
4030   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4031                     \parindent=0pt\raggedright
4032                     \rm #1\hfill}}%
4033   \bigskip \par\penalty 200\relax
4034   \suppressfirstparagraphindent
4035 }
4036
4037 % @heading, @subheading, @subsubheading.
4038 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4039   \suppressfirstparagraphindent}
4040 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4041   \suppressfirstparagraphindent}
4042 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4043   \suppressfirstparagraphindent}
4044
4045 % These macros generate a chapter, section, etc. heading only
4046 % (including whitespace, linebreaking, etc. around it),
4047 % given all the information in convenient, parsed form.
4048
4049 %%% Args are the skip and penalty (usually negative)
4050 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4051
4052 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4053
4054 %%% Define plain chapter starts, and page on/off switching for it
4055 % Parameter controlling skip before chapter headings (if needed)
4056
4057 \newskip\chapheadingskip
4058
4059 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4060 \def\chappager{\par\vfill\supereject}
4061 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4062
4063 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4064
4065 \def\CHAPPAGoff{%
4066 \global\let\contentsalignmacro = \chappager
4067 \global\let\pchapsepmacro=\chapbreak
4068 \global\let\pagealignmacro=\chappager}
4069
4070 \def\CHAPPAGon{%
4071 \global\let\contentsalignmacro = \chappager
4072 \global\let\pchapsepmacro=\chappager
4073 \global\let\pagealignmacro=\chappager
4074 \global\def\HEADINGSon{\HEADINGSsingle}}
4075
4076 \def\CHAPPAGodd{%
4077 \global\let\contentsalignmacro = \chapoddpage
4078 \global\let\pchapsepmacro=\chapoddpage
4079 \global\let\pagealignmacro=\chapoddpage
4080 \global\def\HEADINGSon{\HEADINGSdouble}}
4081
4082 \CHAPPAGon
4083
4084 \def\CHAPFplain{%
4085 \global\let\chapmacro=\chfplain
4086 \global\let\centerchapmacro=\centerchfplain}
4087
4088 % Normal chapter opening.
4089
4090 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4091 % Yappendix, Yomitfromtoc), #3 the chapter number.
4092
4093 % To test against our argument.
4094 \def\Ynothingkeyword{Ynothing}
4095 \def\Yomitfromtockeyword{Yomitfromtoc}
4096 \def\Yappendixkeyword{Yappendix}
4097 %
4098 \def\chfplain#1#2#3{%
4099   \pchapsepmacro
4100   {%
4101     \chapfonts \rm
4102     %
4103     % Have to define \thissection before calling \donoderef, because the
4104     % xref code eventually uses it.  On the other hand, it has to be called
4105     % after \pchapsepmacro, or the headline will change too soon.
4106     \gdef\thissection{#1}%
4107     \gdef\thischaptername{#1}%
4108     %
4109     % Only insert the separating space if we have a chapter/appendix
4110     % number, and don't print the unnumbered ``number''.
4111     \def\temptype{#2}%
4112     \ifx\temptype\Ynothingkeyword
4113       \setbox0 = \hbox{}%
4114       \def\toctype{unnchap}%
4115       \def\thischapter{#1}%
4116     \else\ifx\temptype\Yomitfromtockeyword
4117       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4118       \def\toctype{omit}%
4119       \xdef\thischapter{}%
4120     \else\ifx\temptype\Yappendixkeyword
4121       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4122       \def\toctype{app}%
4123       % We don't substitute the actual chapter name into \thischapter
4124       % because we don't want its macros evaluated now.  And we don't
4125       % use \thissection because that changes with each section.
4126       %
4127       \xdef\thischapter{\putwordAppendix{} \appendixletter:
4128                         \noexpand\thischaptername}%
4129     \else
4130       \setbox0 = \hbox{#3\enspace}%
4131       \def\toctype{numchap}%
4132       \xdef\thischapter{\putwordChapter{} \the\chapno:
4133                         \noexpand\thischaptername}%
4134     \fi\fi\fi
4135     %
4136     % Write the toc entry for this chapter.  Must come before the
4137     % \donoderef, because we include the current node name in the toc
4138     % entry, and \donoderef resets it to empty.
4139     \writetocentry{\toctype}{#1}{#3}%
4140     %
4141     % For pdftex, we have to write out the node definition (aka, make
4142     % the pdfdest) after any page break, but before the actual text has
4143     % been typeset.  If the destination for the pdf outline is after the
4144     % text, then jumping from the outline may wind up with the text not
4145     % being visible, for instance under high magnification.
4146     \donoderef{#2}%
4147     %
4148     % Typeset the actual heading.
4149     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4150           \hangindent=\wd0 \centerparametersmaybe
4151           \unhbox0 #1\par}%
4152   }%
4153   \nobreak\bigskip % no page break after a chapter title
4154   \nobreak
4155 }
4156
4157 % @centerchap -- centered and unnumbered.
4158 \let\centerparametersmaybe = \relax
4159 \def\centerchfplain#1{{%
4160   \def\centerparametersmaybe{%
4161     \advance\rightskip by 3\rightskip
4162     \leftskip = \rightskip
4163     \parfillskip = 0pt
4164   }%
4165   \chfplain{#1}{Ynothing}{}%
4166 }}
4167
4168 \CHAPFplain % The default
4169
4170 % I don't think this chapter style is supported any more, so I'm not
4171 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
4172
4173 \def\unnchfopen #1{%
4174 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4175                        \parindent=0pt\raggedright
4176                        \rm #1\hfill}}\bigskip \par\nobreak
4177 }
4178
4179 \def\chfopen #1#2{\chapoddpage {\chapfonts
4180 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4181 \par\penalty 5000 %
4182 }
4183
4184 \def\centerchfopen #1{%
4185 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4186                        \parindent=0pt
4187                        \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4188 }
4189
4190 \def\CHAPFopen{%
4191 \global\let\chapmacro=\chfopen
4192 \global\let\centerchapmacro=\centerchfopen}
4193
4194
4195 % Section titles.  These macros combine the section number parts and
4196 % call the generic \sectionheading to do the printing.
4197
4198 \newskip\secheadingskip
4199 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4200
4201 % Subsection titles.
4202 \newskip\subsecheadingskip
4203 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4204
4205 % Subsubsection titles.
4206 \def\subsubsecheadingskip{\subsecheadingskip}
4207 \def\subsubsecheadingbreak{\subsecheadingbreak}
4208
4209
4210 % Print any size, any type, section title.
4211
4212 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4213 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4214 % section number.
4215
4216 \def\sectionheading#1#2#3#4{%
4217   {%
4218     % Switch to the right set of fonts.
4219     \csname #2fonts\endcsname \rm
4220     %
4221     % Insert space above the heading.
4222     \csname #2headingbreak\endcsname
4223     %
4224     % Only insert the space after the number if we have a section number.
4225     \def\sectionlevel{#2}%
4226     \def\temptype{#3}%
4227     %
4228     \ifx\temptype\Ynothingkeyword
4229       \setbox0 = \hbox{}%
4230       \def\toctype{unn}%
4231       \gdef\thissection{#1}%
4232     \else\ifx\temptype\Yomitfromtockeyword
4233       % for @headings -- no section number, don't include in toc,
4234       % and don't redefine \thissection.
4235       \setbox0 = \hbox{}%
4236       \def\toctype{omit}%
4237       \let\sectionlevel=\empty
4238     \else\ifx\temptype\Yappendixkeyword
4239       \setbox0 = \hbox{#4\enspace}%
4240       \def\toctype{app}%
4241       \gdef\thissection{#1}%
4242     \else
4243       \setbox0 = \hbox{#4\enspace}%
4244       \def\toctype{num}%
4245       \gdef\thissection{#1}%
4246     \fi\fi\fi
4247     %
4248     % Write the toc entry (before \donoderef).  See comments in \chfplain.
4249     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4250     %
4251     % Write the node reference (= pdf destination for pdftex).
4252     % Again, see comments in \chfplain.
4253     \donoderef{#3}%
4254     %
4255     % Output the actual section heading.
4256     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4257           \hangindent=\wd0  % zero if no section number
4258           \unhbox0 #1}%
4259   }%
4260   % Add extra space after the heading -- half of whatever came above it.
4261   % Don't allow stretch, though.
4262   \kern .5 \csname #2headingskip\endcsname
4263   %
4264   % Do not let the kern be a potential breakpoint, as it would be if it
4265   % was followed by glue.
4266   \nobreak
4267   %
4268   % We'll almost certainly start a paragraph next, so don't let that
4269   % glue accumulate.  (Not a breakpoint because it's preceded by a
4270   % discardable item.)
4271   \vskip-\parskip
4272   %
4273   % This \nobreak is purely so the last item on the list is a \penalty
4274   % of 10000.  This is so other code, for instance \parsebodycommon, can
4275   % check for and avoid allowing breakpoints.  Otherwise, it would
4276   % insert a valid breakpoint between:
4277   %   @section sec-whatever
4278   %   @deffn def-whatever
4279   \nobreak
4280 }
4281
4282
4283 \message{toc,}
4284 % Table of contents.
4285 \newwrite\tocfile
4286
4287 % Write an entry to the toc file, opening it if necessary.
4288 % Called from @chapter, etc.  
4289
4290 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4291 % We append the current node name (if any) and page number as additional
4292 % arguments for the \{chap,sec,...}entry macros which will eventually
4293 % read this.  The node name is used in the pdf outlines as the
4294 % destination to jump to.
4295
4296 % We open the .toc file for writing here instead of at @setfilename (or
4297 % any other fixed time) so that @contents can be anywhere in the document.
4298 % But if #1 is `omit', then we don't do anything.  This is used for the
4299 % table of contents chapter openings themselves.
4300 %
4301 \newif\iftocfileopened
4302 \def\omitkeyword{omit}%
4303 %
4304 \def\writetocentry#1#2#3{%
4305   \edef\writetoctype{#1}%
4306   \ifx\writetoctype\omitkeyword \else
4307     \iftocfileopened\else
4308       \immediate\openout\tocfile = \jobname.toc
4309       \global\tocfileopenedtrue
4310     \fi
4311     %
4312     \iflinks
4313       \toks0 = {#2}%
4314       \toks2 = \expandafter{\lastnode}%
4315       \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4316                                {\the\toks2}{\noexpand\folio}}}%
4317       \temp
4318     \fi
4319   \fi
4320   %
4321   % Tell \shipout to create a pdf destination on each page, if we're
4322   % writing pdf.  These are used in the table of contents.  We can't
4323   % just write one on every page because the title pages are numbered
4324   % 1 and 2 (the page numbers aren't printed), and so are the first
4325   % two pages of the document.  Thus, we'd have two destinations named
4326   % `1', and two named `2'.
4327   \ifpdf \global\pdfmakepagedesttrue \fi
4328 }
4329
4330 \newskip\contentsrightmargin \contentsrightmargin=1in
4331 \newcount\savepageno
4332 \newcount\lastnegativepageno \lastnegativepageno = -1
4333
4334 % Prepare to read what we've written to \tocfile.
4335 %
4336 \def\startcontents#1{%
4337   % If @setchapternewpage on, and @headings double, the contents should
4338   % start on an odd page, unlike chapters.  Thus, we maintain
4339   % \contentsalignmacro in parallel with \pagealignmacro.
4340   % From: Torbjorn Granlund <tege@matematik.su.se>
4341   \contentsalignmacro
4342   \immediate\closeout\tocfile
4343   %
4344   % Don't need to put `Contents' or `Short Contents' in the headline.
4345   % It is abundantly clear what they are.
4346   \def\thischapter{}%
4347   \chapmacro{#1}{Yomitfromtoc}{}%
4348   %
4349   \savepageno = \pageno
4350   \begingroup                  % Set up to handle contents files properly.
4351     \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
4352     % We can't do this, because then an actual ^ in a section
4353     % title fails, e.g., @chapter ^ -- exponentiation.  --karl, 9jul97.
4354     %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4355     \raggedbottom             % Worry more about breakpoints than the bottom.
4356     \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4357     %
4358     % Roman numerals for page numbers.
4359     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4360 }
4361
4362
4363 % Normal (long) toc.
4364 \def\contents{%
4365   \startcontents{\putwordTOC}%
4366     \openin 1 \jobname.toc
4367     \ifeof 1 \else
4368       \input \jobname.toc
4369     \fi
4370     \vfill \eject
4371     \contentsalignmacro % in case @setchapternewpage odd is in effect
4372     \ifeof 1 \else
4373       \pdfmakeoutlines
4374     \fi
4375     \closein 1
4376   \endgroup
4377   \lastnegativepageno = \pageno
4378   \global\pageno = \savepageno
4379 }
4380
4381 % And just the chapters.
4382 \def\summarycontents{%
4383   \startcontents{\putwordShortTOC}%
4384     %
4385     \let\numchapentry = \shortchapentry
4386     \let\appentry = \shortchapentry
4387     \let\unnchapentry = \shortunnchapentry
4388     % We want a true roman here for the page numbers.
4389     \secfonts
4390     \let\rm=\shortcontrm \let\bf=\shortcontbf
4391     \let\sl=\shortcontsl \let\tt=\shortconttt
4392     \rm
4393     \hyphenpenalty = 10000
4394     \advance\baselineskip by 1pt % Open it up a little.
4395     \def\numsecentry##1##2##3##4{}
4396     \let\appsecentry = \numsecentry
4397     \let\unnsecentry = \numsecentry
4398     \let\numsubsecentry = \numsecentry
4399     \let\appsubsecentry = \numsecentry
4400     \let\unnsubsecentry = \numsecentry
4401     \let\numsubsubsecentry = \numsecentry
4402     \let\appsubsubsecentry = \numsecentry
4403     \let\unnsubsubsecentry = \numsecentry
4404     \openin 1 \jobname.toc
4405     \ifeof 1 \else
4406       \input \jobname.toc
4407     \fi
4408     \closein 1
4409     \vfill \eject
4410     \contentsalignmacro % in case @setchapternewpage odd is in effect
4411   \endgroup
4412   \lastnegativepageno = \pageno
4413   \global\pageno = \savepageno
4414 }
4415 \let\shortcontents = \summarycontents
4416
4417 % Typeset the label for a chapter or appendix for the short contents.
4418 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4419 %
4420 \def\shortchaplabel#1{%
4421   % This space should be enough, since a single number is .5em, and the
4422   % widest letter (M) is 1em, at least in the Computer Modern fonts.
4423   % But use \hss just in case.
4424   % (This space doesn't include the extra space that gets added after
4425   % the label; that gets put in by \shortchapentry above.)
4426   % 
4427   % We'd like to right-justify chapter numbers, but that looks strange
4428   % with appendix letters.  And right-justifying numbers and
4429   % left-justifying letters looks strange when there is less than 10
4430   % chapters.  Have to read the whole toc once to know how many chapters
4431   % there are before deciding ...
4432   \hbox to 1em{#1\hss}%
4433 }
4434
4435 % These macros generate individual entries in the table of contents.
4436 % The first argument is the chapter or section name.
4437 % The last argument is the page number.
4438 % The arguments in between are the chapter number, section number, ...
4439
4440 % Chapters, in the main contents.
4441 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4442 %
4443 % Chapters, in the short toc.
4444 % See comments in \dochapentry re vbox and related settings.
4445 \def\shortchapentry#1#2#3#4{%
4446   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4447 }
4448
4449 % Appendices, in the main contents.
4450 % Need the word Appendix, and a fixed-size box.
4451
4452 \def\appendixbox#1{%
4453   % We use M since it's probably the widest letter.
4454   \setbox0 = \hbox{\putwordAppendix{} M}%
4455   \hbox to \wd0{\putwordAppendix{} #1\hss}}
4456 %
4457 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4458
4459 % Unnumbered chapters.
4460 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4461 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4462
4463 % Sections.
4464 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4465 \let\appsecentry=\numsecentry
4466 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4467
4468 % Subsections.
4469 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4470 \let\appsubsecentry=\numsubsecentry
4471 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4472
4473 % And subsubsections.
4474 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4475 \let\appsubsubsecentry=\numsubsubsecentry
4476 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4477
4478 % This parameter controls the indentation of the various levels.
4479 \newdimen\tocindent \tocindent = 2pc
4480
4481 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4482 % page number.
4483 %
4484 % If the toc has to be broken over pages, we want it to be at chapters
4485 % if at all possible; hence the \penalty.
4486 \def\dochapentry#1#2{%
4487    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4488    \begingroup
4489      \chapentryfonts
4490      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4491    \endgroup
4492    \nobreak\vskip .25\baselineskip plus.1\baselineskip
4493 }
4494
4495 \def\dosecentry#1#2{\begingroup
4496   \secentryfonts \leftskip=\tocindent
4497   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4498 \endgroup}
4499
4500 \def\dosubsecentry#1#2{\begingroup
4501   \subsecentryfonts \leftskip=2\tocindent
4502   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4503 \endgroup}
4504
4505 \def\dosubsubsecentry#1#2{\begingroup
4506   \subsubsecentryfonts \leftskip=3\tocindent
4507   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4508 \endgroup}
4509
4510 % We use the same \entry macro as for the index entries.
4511 \let\tocentry = \entry
4512
4513 % Space between chapter (or whatever) number and the title.
4514 \def\labelspace{\hskip1em \relax}
4515
4516 \def\dopageno#1{{\rm #1}}
4517 \def\doshortpageno#1{{\rm #1}}
4518
4519 \def\chapentryfonts{\secfonts \rm}
4520 \def\secentryfonts{\textfonts}
4521 \def\subsecentryfonts{\textfonts}
4522 \def\subsubsecentryfonts{\textfonts}
4523
4524
4525 \message{environments,}
4526 % @foo ... @end foo.
4527
4528 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4529 %
4530 % Since these characters are used in examples, it should be an even number of
4531 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4532 %
4533 \def\point{$\star$}
4534 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4535 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4536 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4537 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4538
4539 % The @error{} command.
4540 % Adapted from the TeXbook's \boxit.
4541 %
4542 \newbox\errorbox
4543 %
4544 {\tentt \global\dimen0 = 3em}% Width of the box.
4545 \dimen2 = .55pt % Thickness of rules
4546 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4547 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4548 %
4549 \setbox\errorbox=\hbox to \dimen0{\hfil
4550    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4551    \advance\hsize by -2\dimen2 % Rules.
4552    \vbox{%
4553       \hrule height\dimen2
4554       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
4555          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4556          \kern3pt\vrule width\dimen2}% Space to right.
4557       \hrule height\dimen2}
4558     \hfil}
4559 %
4560 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4561
4562 % @tex ... @end tex    escapes into raw Tex temporarily.
4563 % One exception: @ is still an escape character, so that @end tex works.
4564 % But \@ or @@ will get a plain tex @ character.
4565
4566 \envdef\tex{%
4567   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4568   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4569   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4570   \catcode `\%=14
4571   \catcode `\+=\other
4572   \catcode `\"=\other
4573   \catcode `\|=\other
4574   \catcode `\<=\other
4575   \catcode `\>=\other
4576   \escapechar=`\\
4577   %
4578   \let\b=\ptexb
4579   \let\bullet=\ptexbullet
4580   \let\c=\ptexc
4581   \let\,=\ptexcomma
4582   \let\.=\ptexdot
4583   \let\dots=\ptexdots
4584   \let\equiv=\ptexequiv
4585   \let\!=\ptexexclam
4586   \let\i=\ptexi
4587   \let\indent=\ptexindent
4588   \let\noindent=\ptexnoindent
4589   \let\{=\ptexlbrace
4590   \let\+=\tabalign
4591   \let\}=\ptexrbrace
4592   \let\/=\ptexslash
4593   \let\*=\ptexstar
4594   \let\t=\ptext
4595   %
4596   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4597   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4598   \def\@{@}%
4599 }
4600 % There is no need to define \Etex.
4601
4602 % Define @lisp ... @end lisp.
4603 % @lisp environment forms a group so it can rebind things,
4604 % including the definition of @end lisp (which normally is erroneous).
4605
4606 % Amount to narrow the margins by for @lisp.
4607 \newskip\lispnarrowing \lispnarrowing=0.4in
4608
4609 % This is the definition that ^^M gets inside @lisp, @example, and other
4610 % such environments.  \null is better than a space, since it doesn't
4611 % have any width.
4612 \def\lisppar{\null\endgraf}
4613
4614 % This space is always present above and below environments.
4615 \newskip\envskipamount \envskipamount = 0pt
4616
4617 % Make spacing and below environment symmetrical.  We use \parskip here
4618 % to help in doing that, since in @example-like environments \parskip
4619 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4620 % start of the next paragraph will insert \parskip.
4621 %
4622 \def\aboveenvbreak{{%
4623   % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4624   \ifnum \lastpenalty=10000 \else
4625     \advance\envskipamount by \parskip
4626     \endgraf
4627     \ifdim\lastskip<\envskipamount
4628       \removelastskip
4629       % it's not a good place to break if the last penalty was \nobreak
4630       % or better ...
4631       \ifnum\lastpenalty<10000 \penalty-50 \fi
4632       \vskip\envskipamount
4633     \fi
4634   \fi
4635 }}
4636
4637 \let\afterenvbreak = \aboveenvbreak
4638
4639 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
4640 \let\nonarrowing=\relax
4641
4642 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4643 % environment contents.
4644 \font\circle=lcircle10
4645 \newdimen\circthick
4646 \newdimen\cartouter\newdimen\cartinner
4647 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4648 \circthick=\fontdimen8\circle
4649 %
4650 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4651 \def\ctr{{\hskip 6pt\circle\char'010}}
4652 \def\cbl{{\circle\char'012\hskip -6pt}}
4653 \def\cbr{{\hskip 6pt\circle\char'011}}
4654 \def\carttop{\hbox to \cartouter{\hskip\lskip
4655         \ctl\leaders\hrule height\circthick\hfil\ctr
4656         \hskip\rskip}}
4657 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4658         \cbl\leaders\hrule height\circthick\hfil\cbr
4659         \hskip\rskip}}
4660 %
4661 \newskip\lskip\newskip\rskip
4662
4663 \envdef\cartouche{%
4664   \ifhmode\par\fi  % can't be in the midst of a paragraph.
4665   \startsavinginserts
4666   \lskip=\leftskip \rskip=\rightskip
4667   \leftskip=0pt\rightskip=0pt % we want these *outside*.
4668   \cartinner=\hsize \advance\cartinner by-\lskip
4669   \advance\cartinner by-\rskip
4670   \cartouter=\hsize
4671   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
4672                                 % side, and for 6pt waste from
4673                                 % each corner char, and rule thickness
4674   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4675   % Flag to tell @lisp, etc., not to narrow margin.
4676   \let\nonarrowing=\comment
4677   \vbox\bgroup
4678       \baselineskip=0pt\parskip=0pt\lineskip=0pt
4679       \carttop
4680       \hbox\bgroup
4681           \hskip\lskip
4682           \vrule\kern3pt
4683           \vbox\bgroup
4684               \kern3pt
4685               \hsize=\cartinner
4686               \baselineskip=\normbskip
4687               \lineskip=\normlskip
4688               \parskip=\normpskip
4689               \vskip -\parskip
4690               \comment % For explanation, see the end of \def\group.
4691 }
4692 \def\Ecartouche{%
4693               \ifhmode\par\fi
4694               \kern3pt
4695           \egroup
4696           \kern3pt\vrule
4697           \hskip\rskip
4698       \egroup
4699       \cartbot
4700   \egroup
4701   \checkinserts
4702 }
4703
4704
4705 % This macro is called at the beginning of all the @example variants,
4706 % inside a group.
4707 \def\nonfillstart{%
4708   \aboveenvbreak
4709   \hfuzz = 12pt % Don't be fussy
4710   \sepspaces % Make spaces be word-separators rather than space tokens.
4711   \let\par = \lisppar % don't ignore blank lines
4712   \obeylines % each line of input is a line of output
4713   \parskip = 0pt
4714   \parindent = 0pt
4715   \emergencystretch = 0pt % don't try to avoid overfull boxes
4716   % @cartouche defines \nonarrowing to inhibit narrowing
4717   % at next level down.
4718   \ifx\nonarrowing\relax
4719     \advance \leftskip by \lispnarrowing
4720     \exdentamount=\lispnarrowing
4721   \fi
4722   \let\exdent=\nofillexdent
4723 }
4724
4725 % If you want all examples etc. small: @set dispenvsize small.
4726 % If you want even small examples the full size: @set dispenvsize nosmall.
4727 % This affects the following displayed environments:
4728 %    @example, @display, @format, @lisp
4729 %
4730 \def\smallword{small}
4731 \def\nosmallword{nosmall}
4732 \let\SETdispenvsize\relax
4733 \def\setnormaldispenv{%
4734   \ifx\SETdispenvsize\smallword
4735     \smallexamplefonts \rm
4736   \fi
4737 }
4738 \def\setsmalldispenv{%
4739   \ifx\SETdispenvsize\nosmallword
4740   \else
4741     \smallexamplefonts \rm
4742   \fi
4743 }
4744
4745 % We often define two environments, @foo and @smallfoo.
4746 % Let's do it by one command:
4747 \def\makedispenv #1#2{
4748   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4749   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4750   \expandafter\let\csname E#1\endcsname \afterenvbreak
4751   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4752 }
4753
4754 % Define two synonyms:
4755 \def\maketwodispenvs #1#2#3{
4756   \makedispenv{#1}{#3}
4757   \makedispenv{#2}{#3}
4758 }
4759
4760 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4761 %
4762 % @smallexample and @smalllisp: use smaller fonts.
4763 % Originally contributed by Pavel@xerox.
4764 %
4765 \maketwodispenvs {lisp}{example}{%
4766   \nonfillstart
4767   \tt
4768   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4769   \gobble       % eat return
4770 }
4771
4772 % @display/@smalldisplay: same as @lisp except keep current font.
4773 %
4774 \makedispenv {display}{%
4775   \nonfillstart
4776   \gobble
4777 }
4778
4779 % @format/@smallformat: same as @display except don't narrow margins.
4780 %
4781 \makedispenv{format}{%
4782   \let\nonarrowing = t%
4783   \nonfillstart
4784   \gobble
4785 }
4786
4787 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4788 \envdef\flushleft{%
4789   \let\nonarrowing = t%
4790   \nonfillstart
4791   \gobble
4792 }
4793 \let\Eflushleft = \afterenvbreak
4794
4795 % @flushright.
4796 %
4797 \envdef\flushright{%
4798   \let\nonarrowing = t%
4799   \nonfillstart
4800   \advance\leftskip by 0pt plus 1fill
4801   \gobble
4802 }
4803 \let\Eflushright = \afterenvbreak
4804
4805
4806 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4807 % and narrows the margins.
4808 %
4809 \envdef\quotation{%
4810   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4811   \parindent=0pt
4812   %
4813   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4814   \ifx\nonarrowing\relax
4815     \advance\leftskip by \lispnarrowing
4816     \advance\rightskip by \lispnarrowing
4817     \exdentamount = \lispnarrowing
4818     \let\nonarrowing = \relax
4819   \fi
4820   \parsearg\quotationlabel
4821 }
4822
4823 % We have retained a nonzero parskip for the environment, since we're
4824 % doing normal filling. So to avoid extra space below the environment...
4825 \def\Equotation{\parskip = 0pt \afterenvbreak}
4826
4827 % If we're given an argument, typeset it in bold with a colon after.
4828 \def\quotationlabel#1{%
4829   \def\temp{#1}%
4830   \ifx\temp\empty \else
4831     {\bf #1: }%
4832   \fi
4833 }
4834
4835
4836 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4837 % If we want to allow any <char> as delimiter,
4838 % we need the curly braces so that makeinfo sees the @verb command, eg:
4839 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
4840 %
4841 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
4842 %
4843 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4844 % active too.  Otherwise, they get lost as the first character on a
4845 % verbatim line.
4846 \def\dospecials{%
4847   \do\ \do\\\do\{\do\}\do\$\do\&%
4848   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4849   \do\<\do\>\do\|\do\@\do+\do\"%
4850 }
4851 %
4852 % [Knuth] p. 380
4853 \def\uncatcodespecials{%
4854   \def\do##1{\catcode`##1=\other}\dospecials}
4855 %
4856 % [Knuth] pp. 380,381,391
4857 % Disable Spanish ligatures ?` and !` of \tt font
4858 \begingroup
4859   \catcode`\`=\active\gdef`{\relax\lq}
4860 \endgroup
4861 %
4862 % Setup for the @verb command.
4863 %
4864 % Eight spaces for a tab
4865 \begingroup
4866   \catcode`\^^I=\active
4867   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4868 \endgroup
4869 %
4870 \def\setupverb{%
4871   \tt  % easiest (and conventionally used) font for verbatim
4872   \def\par{\leavevmode\endgraf}%
4873   \catcode`\`=\active
4874   \tabeightspaces
4875   % Respect line breaks,
4876   % print special symbols as themselves, and
4877   % make each space count
4878   % must do in this order:
4879   \obeylines \uncatcodespecials \sepspaces
4880 }
4881
4882 % Setup for the @verbatim environment
4883 %
4884 % Real tab expansion
4885 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4886 %
4887 \def\starttabbox{\setbox0=\hbox\bgroup}
4888 \begingroup
4889   \catcode`\^^I=\active
4890   \gdef\tabexpand{%
4891     \catcode`\^^I=\active
4892     \def^^I{\leavevmode\egroup
4893       \dimen0=\wd0 % the width so far, or since the previous tab
4894       \divide\dimen0 by\tabw
4895       \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4896       \advance\dimen0 by\tabw  % advance to next multiple of \tabw
4897       \wd0=\dimen0 \box0 \starttabbox
4898     }%
4899   }
4900 \endgroup
4901 \def\setupverbatim{%
4902   \nonfillstart
4903   \advance\leftskip by -\defbodyindent
4904   % Easiest (and conventionally used) font for verbatim
4905   \tt
4906   \def\par{\leavevmode\egroup\box0\endgraf}%
4907   \catcode`\`=\active
4908   \tabexpand
4909   % Respect line breaks,
4910   % print special symbols as themselves, and
4911   % make each space count
4912   % must do in this order:
4913   \obeylines \uncatcodespecials \sepspaces
4914   \everypar{\starttabbox}%
4915 }
4916
4917 % Do the @verb magic: verbatim text is quoted by unique
4918 % delimiter characters.  Before first delimiter expect a
4919 % right brace, after last delimiter expect closing brace:
4920 %
4921 %    \def\doverb'{'<char>#1<char>'}'{#1}
4922 %
4923 % [Knuth] p. 382; only eat outer {}
4924 \begingroup
4925   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
4926   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4927 \endgroup
4928 %
4929 \def\verb{\begingroup\setupverb\doverb}
4930 %
4931 %
4932 % Do the @verbatim magic: define the macro \doverbatim so that
4933 % the (first) argument ends when '@end verbatim' is reached, ie:
4934 %
4935 %     \def\doverbatim#1@end verbatim{#1}
4936 %
4937 % For Texinfo it's a lot easier than for LaTeX,
4938 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4939 % we need not redefine '\', '{' and '}'.
4940 %
4941 % Inspired by LaTeX's verbatim command set [latex.ltx]
4942 %
4943 \begingroup
4944   \catcode`\ =\active
4945   \obeylines %
4946   % ignore everything up to the first ^^M, that's the newline at the end
4947   % of the @verbatim input line itself.  Otherwise we get an extra blank
4948   % line in the output.
4949   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
4950   % We really want {...\end verbatim} in the body of the macro, but
4951   % without the active space; thus we have to use \xdef and \gobble.
4952 \endgroup
4953 %
4954 \envdef\verbatim{%
4955     \setupverbatim\doverbatim
4956 }
4957 \let\Everbatim = \afterenvbreak
4958
4959
4960 % @verbatiminclude FILE - insert text of file in verbatim environment.
4961 %
4962 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
4963 %
4964 \def\doverbatiminclude#1{%
4965   {%
4966     \makevalueexpandable
4967     \setupverbatim
4968     \input #1
4969     \afterenvbreak
4970   }%
4971 }
4972
4973 % @copying ... @end copying.
4974 % Save the text away for @insertcopying later.  Many commands won't be
4975 % allowed in this context, but that's ok.
4976 %
4977 % We save the uninterpreted tokens, rather than creating a box.
4978 % Saving the text in a box would be much easier, but then all the
4979 % typesetting commands (@smallbook, font changes, etc.) have to be done
4980 % beforehand -- and a) we want @copying to be done first in the source
4981 % file; b) letting users define the frontmatter in as flexible order as
4982 % possible is very desirable.
4983 %
4984 \def\copying{\begingroup
4985   % Define a command to swallow text until we reach `@end copying'.
4986   % \ is the escape char in this texinfo.tex file, so it is the
4987   % delimiter for the command; @ will be the escape char when we read
4988   % it, but that doesn't matter.
4989   \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4990   %
4991   % We must preserve ^^M's in the input file; see \insertcopying below.
4992   \catcode`\^^M = \active
4993   \docopying
4994 }
4995
4996 % What we do to finish off the copying text.
4997 %
4998 \def\enddocopying{\endgroup\ignorespaces}
4999
5000 % @insertcopying.  Here we must play games with ^^M's.  On the one hand,
5001 % we need them to delimit commands such as `@end quotation', so they
5002 % must be active.  On the other hand, we certainly don't want every
5003 % end-of-line to be a \par, as would happen with the normal active
5004 % definition of ^^M.  On the third hand, two ^^M's in a row should still
5005 % generate a \par.
5006 %
5007 % Our approach is to make ^^M insert a space and a penalty1 normally;
5008 % then it can also check if \lastpenalty=1.  If it does, then manually
5009 % do \par.
5010 %
5011 % This messes up the normal definitions of @c[omment], so we redefine
5012 % it.  Similarly for @ignore.  (These commands are used in the gcc
5013 % manual for man page generation.)
5014 %
5015 % Seems pretty fragile, most line-oriented commands will presumably
5016 % fail, but for the limited use of getting the copying text (which
5017 % should be quite simple) inserted, we can hope it's ok.
5018 %
5019 {\catcode`\^^M=\active %
5020 \gdef\insertcopying{\begingroup %
5021   \parindent = 0pt  % looks wrong on title page
5022   \def^^M{%
5023     \ifnum \lastpenalty=1 %
5024       \par %
5025     \else %
5026       \space \penalty 1 %
5027     \fi %
5028   }%
5029   %
5030   % Fix @c[omment] for catcode 13 ^^M's.
5031   \def\c##1^^M{\ignorespaces}%
5032   \let\comment = \c %
5033   %
5034   % Don't bother jumping through all the hoops that \doignore does, it
5035   % would be very hard since the catcodes are already set.
5036   \long\def\ignore##1\end ignore{\ignorespaces}%
5037   %
5038   \copyingtext %
5039 \endgroup}%
5040 }
5041
5042 \message{defuns,}
5043 % @defun etc.
5044
5045 \newskip\defbodyindent \defbodyindent=.4in
5046 \newskip\defargsindent \defargsindent=50pt
5047 \newskip\deflastargmargin \deflastargmargin=18pt
5048
5049 % Start the processing of @deffn:
5050 \def\startdefun{%
5051   \ifnum\lastpenalty<10000
5052     \medbreak
5053   \else
5054     % If there are two @def commands in a row, we'll have a \nobreak,
5055     % which is there to keep the function description together with its
5056     % header.  But if there's nothing but headers, we need to allow a
5057     % break somewhere.  Check for penalty 10002 (inserted by
5058     % \defargscommonending) instead of 10000, since the sectioning
5059     % commands insert a \penalty10000, and we don't want to allow a break
5060     % between a section heading and a defun.
5061     \ifnum\lastpenalty=10002 \penalty2000 \fi
5062     %
5063     % Similarly, after a section heading, do not allow a break.
5064     % But do insert the glue.
5065     \medskip  % preceded by discardable penalty, so not a breakpoint
5066   \fi
5067   %
5068   \parindent=0in
5069   \advance\leftskip by \defbodyindent
5070   \exdentamount=\defbodyindent
5071 }
5072
5073 \def\dodefunx#1{%
5074   % First, check whether we are in the right environment:
5075   \checkenv#1%
5076   %
5077   % As above, allow line break if we have multiple x headers in a row.
5078   % It's not a great place, though.
5079   \ifnum\lastpenalty=10002 \penalty3000 \fi
5080   %
5081   % And now, it's time to reuse the body of the original defun:
5082   \expandafter\gobbledefun#1%
5083 }
5084 \def\gobbledefun#1\startdefun{}
5085
5086 % \printdefunline \deffnheader{text}
5087 %
5088 \def\printdefunline#1#2{%
5089   \begingroup
5090     % call \deffnheader:
5091     #1#2 \endheader
5092     % common ending:
5093     \interlinepenalty = 10000
5094     \advance\rightskip by 0pt plus 1fil
5095     \endgraf
5096     \nobreak\vskip -\parskip
5097     \penalty 10002  % signal to \startdefun and \dodefunx
5098     % Some of the @defun-type tags do not enable magic parentheses,
5099     % rendering the following check redundant.  But we don't optimize.
5100     \checkparencounts
5101   \endgroup
5102 }
5103
5104 \def\Edefun{\endgraf\medbreak}
5105
5106 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5107 % the only thing remainnig is to define \deffnheader.
5108 %
5109 \def\makedefun#1{%
5110   \expandafter\let\csname E#1\endcsname = \Edefun
5111   \edef\temp{\noexpand\domakedefun
5112     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5113   \temp
5114 }
5115
5116 % \domakedefun \deffn \deffnx \deffnheader
5117 %
5118 % Define \deffn and \deffnx, without parameters.
5119 % \deffnheader has to be defined explicitly.
5120 %
5121 \def\domakedefun#1#2#3{%
5122   \envdef#1{%
5123     \startdefun
5124     \parseargusing\activeparens{\printdefunline#3}%
5125   }%
5126   \def#2{\dodefunx#1}%
5127   \def#3%
5128 }
5129
5130 %%% Untyped functions:
5131
5132 % @deffn category name args
5133 \makedefun{deffn}{\deffngeneral{}}
5134
5135 % @deffn category class name args
5136 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5137
5138 % \defopon {category on}class name args
5139 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5140
5141 % \deffngeneral {subind}category name args
5142 %
5143 \def\deffngeneral#1#2 #3 #4\endheader{%
5144   % Remember that \dosubin{fn}{xxx}{} is equivalent to \doind{fn}{xxx}.
5145   \dosubind{fn}{\code{#3}}{#1}%
5146   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5147 }
5148
5149 %%% Typed functions:
5150
5151 % @deftypefn category type name args
5152 \makedefun{deftypefn}{\deftypefngeneral{}}
5153
5154 % @deftypeop category class type name args
5155 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5156
5157 % \deftypeopon {category on}class type name args
5158 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5159
5160 % \deftypefngeneral {subind}category type name args
5161 %
5162 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5163   \dosubind{fn}{\code{#4}}{#1}%
5164   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5165 }
5166
5167 %%% Typed variables:
5168
5169 % @deftypevr category type var args
5170 \makedefun{deftypevr}{\deftypecvgeneral{}}
5171
5172 % @deftypecv category class type var args
5173 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5174
5175 % \deftypecvof {category of}class type var args
5176 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5177
5178 % \deftypecvgeneral {subind}category type var args
5179 %
5180 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5181   \dosubind{vr}{\code{#4}}{#1}%
5182   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5183 }
5184
5185 %%% Untyped variables:
5186
5187 % @defvr category var args
5188 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5189
5190 % @defcv category class var args
5191 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5192
5193 % \defcvof {category of}class var args
5194 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5195
5196 %%% Type:
5197 % @deftp category name args
5198 \makedefun{deftp}#1 #2 #3\endheader{%
5199   \doind{tp}{\code{#2}}%
5200   \defname{#1}{}{#2}\defunargs{#3\unskip}%
5201 }
5202
5203 % Remaining @defun-like shortcuts:
5204 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5205 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5206 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5207 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5208 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5209 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5210 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5211 \makedefun{defmethod}{\defopon\putwordMethodon}
5212 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5213 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5214 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5215
5216 % \defname, which formats the name of the @def (not the args).
5217 % #1 is the category, such as "Function".
5218 % #2 is the return type, if any.
5219 % #3 is the function name.
5220
5221 % We are followed by (but not passed) the arguments, if any.
5222 %
5223 \def\defname#1#2#3{%
5224   % Get the values of \leftskip and \rightskip as they were outside the @def...
5225   \advance\leftskip by -\defbodyindent
5226   %
5227   % How we'll format the type name.  Putting it in brackets helps
5228   % distinguish it from the body text that may end up on the next line
5229   % just below it.
5230   \def\temp{#1}%
5231   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5232   %
5233   % Figure out line sizes for the paragraph shape.
5234   % The first line needs space for \box0; but if \rightskip is nonzero,
5235   % we need only space for the part of \box0 which exceeds it:
5236   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
5237   % The continuations:
5238   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
5239   % (plain.tex says that \dimen1 should be used only as global.)
5240   \parshape 2 0in \dimen0 \defargsindent \dimen2
5241   %
5242   % Put the type name to the right margin.
5243   \noindent
5244   \hbox to 0pt{%
5245     \hfil\box0 \kern-\hsize
5246     % \hsize has to be shortened this way:
5247     \kern\leftskip
5248     % Intentionally do not respect \rightskip, since we need the space.
5249   }%
5250   %
5251   % Allow all lines to be underfull without complaint:
5252   \tolerance=10000 \hbadness=10000
5253   \exdentamount=\defbodyindent
5254   {%
5255     % defun fonts. We use typewriter by default (used to be bold) because:
5256     % . we're printing identifiers, they should be in tt in principle.
5257     % . in languages with many accents, such as Czech or French, it's
5258     %   common to leave accents off identifiers.  The result looks ok in
5259     %   tt, but exceedingly strange in rm.
5260     % . we don't want -- and --- to be treated as ligatures.
5261     % . this still does not fix the ?` and !` ligatures, but so far no
5262     %   one has made identifiers using them :).
5263     \df \tt
5264     \def\temp{#2}% return value type
5265     \ifx\temp\empty\else \tclose{\temp} \fi
5266     #3% output function name
5267   }%
5268   {\rm\enskip}% hskip 0.5 em of \tenrm
5269   %
5270   \boldbrax
5271   % arguments will be output next, if any.
5272 }
5273
5274 % Print arguments in slanted typewriter, prevent hyphenation at `-' chars.
5275
5276 \def\defunargs#1{%
5277   % use sl by default (not ttsl), inconsistently with using tt for the
5278   % name.  This is because literal text is sometimes needed in the
5279   % argument list (groff manual), and ttsl and tt are not very
5280   % distinguishable.
5281   % tt for the names.
5282   \df \sl \hyphenchar\font=0
5283   % On the other hand, if an argument has two dashes (for instance), we
5284   % want a way to get ttsl.  Let's try @var for that.
5285   \let\var=\ttslanted
5286   #1%
5287   \sl\hyphenchar\font=45
5288 }
5289
5290 % We want ()&[] to print specially on the defun line.
5291 %
5292 \def\activeparens{%
5293   \catcode`\(=\active \catcode`\)=\active
5294   \catcode`\[=\active \catcode`\]=\active
5295   \catcode`\&=\active
5296 }
5297
5298 % Make control sequences which act like normal parenthesis chars.
5299 \let\lparen = ( \let\rparen = )
5300
5301 % Be sure that we always have a definition for `(', etc.  For example,
5302 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5303 % so TeX would otherwise complain about undefined control sequence.
5304 {
5305   \activeparens
5306   \global\let(=\lparen \global\let)=\rparen
5307   \global\let[=\lbrack \global\let]=\rbrack
5308   \global\let& = \&
5309
5310   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5311   \gdef\magicamp{\let&=\amprm}
5312 }
5313
5314 \newcount\parencount
5315
5316 % If we encounter &foo, then turn on ()-hacking afterwards
5317 \newif\ifampseen
5318 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5319
5320 \def\parenfont{%
5321   \ifampseen
5322     % At the first level, print parens in roman,
5323     % otherwise use the default font.
5324     \ifnum \parencount=1 \rm \fi
5325   \else
5326     % The \sf parens (in \boldbrax) actually are a little bolder than
5327     % the contained text.  This is especially needed for [ and ] .
5328     \sf
5329   \fi
5330 }
5331 \def\infirstlevel#1{%
5332   \ifampseen
5333     \ifnum\parencount=1
5334       #1%
5335     \fi
5336   \fi
5337 }
5338 \def\bfafterword#1 {#1 \bf}
5339
5340 \def\opnr{%
5341   \global\advance\parencount by 1
5342   {\parenfont(}%
5343   \infirstlevel \bfafterword
5344 }
5345 \def\clnr{%
5346   {\parenfont)}%
5347   \infirstlevel \sl
5348   \global\advance\parencount by -1
5349 }
5350
5351 \newcount\brackcount
5352 \def\lbrb{%
5353   \global\advance\brackcount by 1
5354   {\bf[}%
5355 }
5356 \def\rbrb{%
5357   {\bf]}%
5358   \global\advance\brackcount by -1
5359 }
5360
5361 \def\checkparencounts{%
5362   \ifnum\parencount=0 \else \badparencount \fi
5363   \ifnum\brackcount=0 \else \badbrackcount \fi
5364 }
5365 \def\badparencount{%
5366   \errmessage{Unbalanced parentheses in @def}%
5367   \global\parencount=0
5368 }
5369 \def\badbrackcount{%
5370   \errmessage{Unbalanced square braces in @def}%
5371   \global\brackcount=0
5372 }
5373
5374
5375 \message{macros,}
5376 % @macro.
5377
5378 % To do this right we need a feature of e-TeX, \scantokens,
5379 % which we arrange to emulate with a temporary file in ordinary TeX.
5380 \ifx\eTeXversion\undefined
5381   \newwrite\macscribble
5382   \def\scantokens#1{%
5383     \toks0={#1\endinput}%
5384     \immediate\openout\macscribble=\jobname.tmp
5385     \immediate\write\macscribble{\the\toks0}%
5386     \immediate\closeout\macscribble
5387     \input \jobname.tmp
5388   }
5389 \fi
5390
5391 \def\scanmacro#1{%
5392   \begingroup
5393     \newlinechar`\^^M
5394     \let\xeatspaces\eatspaces
5395     % Undo catcode changes of \startcontents and \doprintindex
5396     \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5397     % ... and \example
5398     \spaceisspace
5399     %
5400     % Append \endinput to make sure that TeX does not see the ending newline.
5401     %
5402     % I've verified that it is necessary both for e-TeX and for ordinary TeX
5403     %                                                   --kasal, 29nov03
5404     \scantokens{#1\endinput}%
5405   \endgroup
5406 }
5407
5408 \newcount\paramno   % Count of parameters
5409 \newtoks\macname    % Macro name
5410 \newif\ifrecursive  % Is it recursive?
5411 \def\macrolist{}    % List of all defined macros in the form
5412                     % \do\macro1\do\macro2...
5413
5414 % Utility routines.
5415 % This does \let #1 = #2, except with \csnames.
5416 \def\cslet#1#2{%
5417 \expandafter\expandafter
5418 \expandafter\let
5419 \expandafter\expandafter
5420 \csname#1\endcsname
5421 \csname#2\endcsname}
5422
5423 % Trim leading and trailing spaces off a string.
5424 % Concepts from aro-bend problem 15 (see CTAN).
5425 {\catcode`\@=11
5426 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5427 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5428 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5429 \def\unbrace#1{#1}
5430 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5431 }
5432
5433 % Trim a single trailing ^^M off a string.
5434 {\catcode`\^^M=\other \catcode`\Q=3%
5435 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5436 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5437 \gdef\eatcrb#1Q#2Q{#1}%
5438 }
5439
5440 % Macro bodies are absorbed as an argument in a context where
5441 % all characters are catcode 10, 11 or 12, except \ which is active
5442 % (as in normal texinfo). It is necessary to change the definition of \.
5443
5444 % It's necessary to have hard CRs when the macro is executed. This is
5445 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
5446 % body, and then making it the \newlinechar in \scanmacro.
5447
5448 \def\macrobodyctxt{%
5449   \catcode`\~=\other
5450   \catcode`\^=\other
5451   \catcode`\_=\other
5452   \catcode`\|=\other
5453   \catcode`\<=\other
5454   \catcode`\>=\other
5455   \catcode`\+=\other
5456   \catcode`\{=\other
5457   \catcode`\}=\other
5458   \catcode`\@=\other
5459   \catcode`\^^M=\other
5460   \usembodybackslash}
5461
5462 \def\macroargctxt{%
5463   \catcode`\~=\other
5464   \catcode`\^=\other
5465   \catcode`\_=\other
5466   \catcode`\|=\other
5467   \catcode`\<=\other
5468   \catcode`\>=\other
5469   \catcode`\+=\other
5470   \catcode`\@=\other
5471   \catcode`\\=\other}
5472
5473 % \mbodybackslash is the definition of \ in @macro bodies.
5474 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5475 % where N is the macro parameter number.
5476 % We define \csname macarg.\endcsname to be \realbackslash, so
5477 % \\ in macro replacement text gets you a backslash.
5478
5479 {\catcode`@=0 @catcode`@\=@active
5480  @gdef@usembodybackslash{@let\=@mbodybackslash}
5481  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5482 }
5483 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5484
5485 \def\macro{\recursivefalse\parsearg\macroxxx}
5486 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5487
5488 \def\macroxxx#1{%
5489   \getargs{#1}%           now \macname is the macname and \argl the arglist
5490   \ifx\argl\empty       % no arguments
5491      \paramno=0%
5492   \else
5493      \expandafter\parsemargdef \argl;%
5494   \fi
5495   \if1\csname ismacro.\the\macname\endcsname
5496      \message{Warning: redefining \the\macname}%
5497   \else
5498      \expandafter\ifx\csname \the\macname\endcsname \relax
5499      \else \errmessage{Macro name \the\macname\space already defined}\fi
5500      \global\cslet{macsave.\the\macname}{\the\macname}%
5501      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5502      % Add the macroname to \macrolist
5503      \toks0 = \expandafter{\macrolist\do}%
5504      \xdef\macrolist{\the\toks0
5505        \expandafter\noexpand\csname\the\macname\endcsname}%
5506   \fi
5507   \begingroup \macrobodyctxt
5508   \ifrecursive \expandafter\parsermacbody
5509   \else \expandafter\parsemacbody
5510   \fi}
5511
5512 \parseargdef\unmacro{%
5513   \if1\csname ismacro.#1\endcsname
5514     \global\cslet{#1}{macsave.#1}%
5515     \global\expandafter\let \csname ismacro.#1\endcsname=0%
5516     % Remove the macro name from \macrolist:
5517     \begingroup
5518       \expandafter\let\csname#1\endcsname \relax
5519       \let\do\unmacrodo
5520       \xdef\macrolist{\macrolist}%
5521     \endgroup
5522   \else
5523     \errmessage{Macro #1 not defined}%
5524   \fi
5525 }
5526
5527 % Called by \do from \dounmacro on each macro.  The idea is to omit any
5528 % macro definitions that have been changed to \relax.
5529 %
5530 \def\unmacrodo#1{%
5531   \ifx#1\relax
5532     % remove this
5533   \else
5534     \noexpand\do \noexpand #1%
5535   \fi
5536 }
5537
5538 % This makes use of the obscure feature that if the last token of a
5539 % <parameter list> is #, then the preceding argument is delimited by
5540 % an opening brace, and that opening brace is not consumed.
5541 \def\getargs#1{\getargsxxx#1{}}
5542 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5543 \def\getmacname #1 #2\relax{\macname={#1}}
5544 \def\getmacargs#1{\def\argl{#1}}
5545
5546 % Parse the optional {params} list.  Set up \paramno and \paramlist
5547 % so \defmacro knows what to do.  Define \macarg.blah for each blah
5548 % in the params list, to be ##N where N is the position in that list.
5549 % That gets used by \mbodybackslash (above).
5550
5551 % We need to get `macro parameter char #' into several definitions.
5552 % The technique used is stolen from LaTeX:  let \hash be something
5553 % unexpandable, insert that wherever you need a #, and then redefine
5554 % it to # just before using the token list produced.
5555 %
5556 % The same technique is used to protect \eatspaces till just before
5557 % the macro is used.
5558
5559 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5560         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5561 \def\parsemargdefxxx#1,{%
5562   \if#1;\let\next=\relax
5563   \else \let\next=\parsemargdefxxx
5564     \advance\paramno by 1%
5565     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5566         {\xeatspaces{\hash\the\paramno}}%
5567     \edef\paramlist{\paramlist\hash\the\paramno,}%
5568   \fi\next}
5569
5570 % These two commands read recursive and nonrecursive macro bodies.
5571 % (They're different since rec and nonrec macros end differently.)
5572
5573 \long\def\parsemacbody#1@end macro%
5574 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5575 \long\def\parsermacbody#1@end rmacro%
5576 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5577
5578 % This defines the macro itself. There are six cases: recursive and
5579 % nonrecursive macros of zero, one, and many arguments.
5580 % Much magic with \expandafter here.
5581 % \xdef is used so that macro definitions will survive the file
5582 % they're defined in; @include reads the file inside a group.
5583 \def\defmacro{%
5584   \let\hash=##% convert placeholders to macro parameter chars
5585   \ifrecursive
5586     \ifcase\paramno
5587     % 0
5588       \expandafter\xdef\csname\the\macname\endcsname{%
5589         \noexpand\scanmacro{\temp}}%
5590     \or % 1
5591       \expandafter\xdef\csname\the\macname\endcsname{%
5592          \bgroup\noexpand\macroargctxt
5593          \noexpand\braceorline
5594          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5595       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5596          \egroup\noexpand\scanmacro{\temp}}%
5597     \else % many
5598       \expandafter\xdef\csname\the\macname\endcsname{%
5599          \bgroup\noexpand\macroargctxt
5600          \noexpand\csname\the\macname xx\endcsname}%
5601       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5602           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5603       \expandafter\expandafter
5604       \expandafter\xdef
5605       \expandafter\expandafter
5606         \csname\the\macname xxx\endcsname
5607           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5608     \fi
5609   \else
5610     \ifcase\paramno
5611     % 0
5612       \expandafter\xdef\csname\the\macname\endcsname{%
5613         \noexpand\norecurse{\the\macname}%
5614         \noexpand\scanmacro{\temp}\egroup}%
5615     \or % 1
5616       \expandafter\xdef\csname\the\macname\endcsname{%
5617          \bgroup\noexpand\macroargctxt
5618          \noexpand\braceorline
5619          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5620       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5621         \egroup
5622         \noexpand\norecurse{\the\macname}%
5623         \noexpand\scanmacro{\temp}\egroup}%
5624     \else % many
5625       \expandafter\xdef\csname\the\macname\endcsname{%
5626          \bgroup\noexpand\macroargctxt
5627          \expandafter\noexpand\csname\the\macname xx\endcsname}%
5628       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5629           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5630       \expandafter\expandafter
5631       \expandafter\xdef
5632       \expandafter\expandafter
5633       \csname\the\macname xxx\endcsname
5634       \paramlist{%
5635           \egroup
5636           \noexpand\norecurse{\the\macname}%
5637           \noexpand\scanmacro{\temp}\egroup}%
5638     \fi
5639   \fi}
5640
5641 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5642
5643 % \braceorline decides whether the next nonwhitespace character is a
5644 % {.  If so it reads up to the closing }, if not, it reads the whole
5645 % line.  Whatever was read is then fed to the next control sequence
5646 % as an argument (by \parsebrace or \parsearg)
5647 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5648 \def\braceorlinexxx{%
5649   \ifx\nchar\bgroup\else
5650     \expandafter\parsearg
5651   \fi \next}
5652
5653 % We mant to disable all macros during \shipout so that they are not
5654 % expanded by \write.
5655 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5656   \edef\next{\macrolist}\expandafter\endgroup\next}
5657
5658
5659 % @alias.
5660 % We need some trickery to remove the optional spaces around the equal
5661 % sign.  Just make them active and then expand them all to nothing.
5662 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5663 \def\aliasxxx #1{\aliasyyy#1\relax}
5664 \def\aliasyyy #1=#2\relax{%
5665   {%
5666     \expandafter\let\obeyedspace=\empty
5667     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5668   }%
5669   \next
5670 }
5671
5672
5673 \message{cross references,}
5674
5675 \newwrite\auxfile
5676
5677 \newif\ifhavexrefs    % True if xref values are known.
5678 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
5679
5680 % @inforef is relatively simple.
5681 \def\inforef #1{\inforefzzz #1,,,,**}
5682 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5683   node \samp{\ignorespaces#1{}}}
5684
5685 % @node's only job in TeX is to define \lastnode, which is used in
5686 % cross-references.
5687 \parseargdef\node{\checkenv{}\nodexxx #1,\finishnodeparse}
5688 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5689 \let\nwnode=\node
5690 \let\lastnode=\empty
5691
5692 % Write a cross-reference definition for the current node.  #1 is the
5693 % type (Ynumbered, Yappendix, Ynothing).
5694
5695 \def\donoderef#1{%
5696   \ifx\lastnode\empty\else
5697     \setref{\lastnode}{#1}%
5698     \global\let\lastnode=\empty
5699   \fi
5700 }
5701
5702 % @anchor{NAME} -- define xref target at arbitrary point.
5703 %
5704 \newcount\savesfregister
5705 %
5706 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5707 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5708 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5709
5710 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5711 % anchor), which consists of three parts:
5712 % 1) NAME-title - the current sectioning name, taken from \thissection;
5713 % 2) NAME-snt   - section number and type, defined as the SNT arg;
5714 % 3) NAME-pg    - the page number.
5715 % This is called from \donoderef, \anchor, and \dofloat.
5716
5717 % We take care not to fully expand the title, since it may contain
5718 % arbitrary macros.
5719 %
5720 % Use \turnoffactive so that punctuation chars such as underscore
5721 % and backslash work in node names.
5722 %
5723 \def\setref#1#2{%
5724   \pdfmkdest{#1}%
5725   \iflinks
5726     {%
5727       \atdummies  % preserve commands, but don't expand them
5728       \turnoffactive
5729       \otherbackslash
5730       \edef\writexrdef##1##2{%
5731         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5732           ##1}{##2}}% these are parameters of \writexrdef
5733       }%
5734       \toks0 = \expandafter{\thissection}%
5735       \immediate \writexrdef{title}{\the\toks0 }%
5736       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5737       \writexrdef{pg}{\folio}% will be written later, during \shipout
5738     }%
5739   \fi
5740 }
5741
5742 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
5743 % the node name, #2 the name of the Info cross-reference, #3 the printed
5744 % node name, #4 the name of the Info file, #5 the name of the printed
5745 % manual.  All but the node name can be omitted.
5746 %
5747 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5748 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5749 \def\ref#1{\xrefX[#1,,,,,,,]}
5750 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5751   \unsepspaces
5752   \def\printedmanual{\ignorespaces #5}%
5753   \def\printedrefname{\ignorespaces #3}%
5754   \setbox1=\hbox{\printedmanual\unskip}%
5755   \setbox0=\hbox{\printedrefname\unskip}%
5756   \ifdim \wd0 = 0pt
5757     % No printed node name was explicitly given.
5758     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5759       % Use the node name inside the square brackets.
5760       \def\printedrefname{\ignorespaces #1}%
5761     \else
5762       % Use the actual chapter/section title appear inside
5763       % the square brackets.  Use the real section title if we have it.
5764       \ifdim \wd1 > 0pt
5765         % It is in another manual, so we don't have it.
5766         \def\printedrefname{\ignorespaces #1}%
5767       \else
5768         \ifhavexrefs
5769           % We know the real title if we have the xref values.
5770           \def\printedrefname{\refx{#1-title}{}}%
5771         \else
5772           % Otherwise just copy the Info node name.
5773           \def\printedrefname{\ignorespaces #1}%
5774         \fi%
5775       \fi
5776     \fi
5777   \fi
5778   %
5779   % Make link in pdf output.
5780   \ifpdf
5781     \leavevmode
5782     \getfilename{#4}%
5783     {\turnoffactive \otherbackslash
5784      \ifnum\filenamelength>0
5785        \startlink attr{/Border [0 0 0]}%
5786          goto file{\the\filename.pdf} name{#1}%
5787      \else
5788        \startlink attr{/Border [0 0 0]}%
5789          goto name{\pdfmkpgn{#1}}%
5790      \fi
5791     }%
5792     \linkcolor
5793   \fi
5794   %
5795   % Float references are printed completely differently: "Figure 1.2"
5796   % instead of "[somenode], p.3".  We distinguish them by the
5797   % LABEL-title being set to a magic string.
5798   {%
5799     % Have to otherify everything special to allow the \csname to
5800     % include an _ in the xref name, etc.
5801     \indexnofonts
5802     \turnoffactive
5803     \otherbackslash
5804     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5805       \csname X#1-title\endcsname
5806   }%
5807   \ifx \Xthisreftitle \floatmagic
5808     % If the user specified the print name (third arg) to the ref,
5809     % print it instead of our usual "Figure 1.2".
5810     \ifdim\wd0 = 0pt
5811       \refx{#1-snt}%
5812     \else
5813       \printedrefname
5814     \fi
5815     %
5816     % if the user also gave the printed manual name (fifth arg), append
5817     % "in MANUALNAME". 
5818     \ifdim \wd1 > 0pt
5819       \space \putwordin{} \cite{\printedmanual}%
5820     \fi
5821   \else
5822     % node/anchor (non-float) references.
5823     % 
5824     % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5825     % insert empty discretionaries after hyphens, which means that it will
5826     % not find a line break at a hyphen in a node names.  Since some manuals
5827     % are best written with fairly long node names, containing hyphens, this
5828     % is a loss.  Therefore, we give the text of the node name again, so it
5829     % is as if TeX is seeing it for the first time.
5830     \ifdim \wd1 > 0pt
5831       \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
5832     \else
5833       % _ (for example) has to be the character _ for the purposes of the
5834       % control sequence corresponding to the node, but it has to expand
5835       % into the usual \leavevmode...\vrule stuff for purposes of
5836       % printing. So we \turnoffactive for the \refx-snt, back on for the
5837       % printing, back off for the \refx-pg.
5838       {\turnoffactive \otherbackslash
5839        % Only output a following space if the -snt ref is nonempty; for
5840        % @unnumbered and @anchor, it won't be.
5841        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5842        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5843       }%
5844       % output the `[mynode]' via a macro so it can be overridden.
5845       \xrefprintnodename\printedrefname
5846       %
5847       % But we always want a comma and a space:
5848       ,\space
5849       %
5850       % output the `page 3'.
5851       \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5852     \fi
5853   \fi
5854   \endlink
5855 \endgroup}
5856
5857 % This macro is called from \xrefX for the `[nodename]' part of xref
5858 % output.  It's a separate macro only so it can be changed more easily,
5859 % since square brackets don't work well in some documents.  Particularly
5860 % one that Bob is working on :).
5861 %
5862 \def\xrefprintnodename#1{[#1]}
5863
5864 % Things referred to by \setref.
5865 %
5866 \def\Ynothing{}
5867 \def\Yomitfromtoc{}
5868 \def\Ynumbered{%
5869   \ifnum\secno=0
5870     \putwordChapter@tie \the\chapno
5871   \else \ifnum\subsecno=0
5872     \putwordSection@tie \the\chapno.\the\secno
5873   \else \ifnum\subsubsecno=0
5874     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5875   \else
5876     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5877   \fi\fi\fi
5878 }
5879 \def\Yappendix{%
5880   \ifnum\secno=0
5881      \putwordAppendix@tie @char\the\appendixno{}%
5882   \else \ifnum\subsecno=0
5883      \putwordSection@tie @char\the\appendixno.\the\secno
5884   \else \ifnum\subsubsecno=0
5885     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5886   \else
5887     \putwordSection@tie
5888       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5889   \fi\fi\fi
5890 }
5891
5892 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5893 % If its value is nonempty, SUFFIX is output afterward.
5894 %
5895 \def\refx#1#2{%
5896   {%
5897     \indexnofonts
5898     \otherbackslash
5899     \expandafter\global\expandafter\let\expandafter\thisrefX
5900       \csname X#1\endcsname
5901   }%
5902   \ifx\thisrefX\relax
5903     % If not defined, say something at least.
5904     \angleleft un\-de\-fined\angleright
5905     \iflinks
5906       \ifhavexrefs
5907         \message{\linenumber Undefined cross reference `#1'.}%
5908       \else
5909         \ifwarnedxrefs\else
5910           \global\warnedxrefstrue
5911           \message{Cross reference values unknown; you must run TeX again.}%
5912         \fi
5913       \fi
5914     \fi
5915   \else
5916     % It's defined, so just use it.
5917     \thisrefX
5918   \fi
5919   #2% Output the suffix in any case.
5920 }
5921
5922 % This is the macro invoked by entries in the aux file.
5923 %
5924 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
5925
5926 % Read the last existing aux file, if any.  No error if none exists.
5927
5928 \def\tryauxfile{%
5929   \openin 1 \jobname.aux
5930   \ifeof 1 \else
5931     \readauxfile
5932     \global\havexrefstrue
5933   \fi
5934   \closein 1
5935 }
5936
5937 \def\readauxfile{\begingroup
5938   \catcode`\^^@=\other
5939   \catcode`\^^A=\other
5940   \catcode`\^^B=\other
5941   \catcode`\^^C=\other
5942   \catcode`\^^D=\other
5943   \catcode`\^^E=\other
5944   \catcode`\^^F=\other
5945   \catcode`\^^G=\other
5946   \catcode`\^^H=\other
5947   \catcode`\^^K=\other
5948   \catcode`\^^L=\other
5949   \catcode`\^^N=\other
5950   \catcode`\^^P=\other
5951   \catcode`\^^Q=\other
5952   \catcode`\^^R=\other
5953   \catcode`\^^S=\other
5954   \catcode`\^^T=\other
5955   \catcode`\^^U=\other
5956   \catcode`\^^V=\other
5957   \catcode`\^^W=\other
5958   \catcode`\^^X=\other
5959   \catcode`\^^Z=\other
5960   \catcode`\^^[=\other
5961   \catcode`\^^\=\other
5962   \catcode`\^^]=\other
5963   \catcode`\^^^=\other
5964   \catcode`\^^_=\other
5965   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
5966   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
5967   % supported in the main text, it doesn't seem desirable.  Furthermore,
5968   % that is not enough: for node names that actually contain a ^
5969   % character, we would end up writing a line like this: 'xrdef {'hat
5970   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5971   % argument, and \hat is not an expandable control sequence.  It could
5972   % all be worked out, but why?  Either we support ^^ or we don't.
5973   %
5974   % The other change necessary for this was to define \auxhat:
5975   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5976   % and then to call \auxhat in \setq.
5977   %
5978   \catcode`\^=\other
5979   %
5980   % Special characters.  Should be turned off anyway, but...
5981   \catcode`\~=\other
5982   \catcode`\[=\other
5983   \catcode`\]=\other
5984   \catcode`\"=\other
5985   \catcode`\_=\other
5986   \catcode`\|=\other
5987   \catcode`\<=\other
5988   \catcode`\>=\other
5989   \catcode`\$=\other
5990   \catcode`\#=\other
5991   \catcode`\&=\other
5992   \catcode`\%=\other
5993   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5994   %
5995   % This is to support \ in node names and titles, since the \
5996   % characters end up in a \csname.  It's easier than
5997   % leaving it active and making its active definition an actual \
5998   % character.  What I don't understand is why it works in the *value*
5999   % of the xrdef.  Seems like it should be a catcode12 \, and that
6000   % should not typeset properly.  But it works, so I'm moving on for
6001   % now.  --karl, 15jan04.
6002   \catcode`\\=\other
6003   %
6004   % Make the characters 128-255 be printing characters.
6005   {%
6006     \count 1=128
6007     \def\loop{%
6008       \catcode\count 1=\other
6009       \advance\count 1 by 1
6010       \ifnum \count 1<256 \loop \fi
6011     }%
6012   }%
6013   %
6014   % @ is our escape character in .aux files, and we need braces.
6015   \catcode`\{=1
6016   \catcode`\}=2
6017   \catcode`\@=0
6018   %
6019   \input \jobname.aux
6020 \endgroup}
6021
6022
6023 \message{insertions,}
6024 % including footnotes.
6025
6026 \newcount \footnoteno
6027
6028 % The trailing space in the following definition for supereject is
6029 % vital for proper filling; pages come out unaligned when you do a
6030 % pagealignmacro call if that space before the closing brace is
6031 % removed. (Generally, numeric constants should always be followed by a
6032 % space to prevent strange expansion errors.)
6033 \def\supereject{\par\penalty -20000\footnoteno =0 }
6034
6035 % @footnotestyle is meaningful for info output only.
6036 \let\footnotestyle=\comment
6037
6038 {\catcode `\@=11
6039 %
6040 % Auto-number footnotes.  Otherwise like plain.
6041 \gdef\footnote{%
6042   \let\indent=\ptexindent
6043   \let\noindent=\ptexnoindent
6044   \global\advance\footnoteno by \@ne
6045   \edef\thisfootno{$^{\the\footnoteno}$}%
6046   %
6047   % In case the footnote comes at the end of a sentence, preserve the
6048   % extra spacing after we do the footnote number.
6049   \let\@sf\empty
6050   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6051   %
6052   % Remove inadvertent blank space before typesetting the footnote number.
6053   \unskip
6054   \thisfootno\@sf
6055   \dofootnote
6056 }%
6057
6058 % Don't bother with the trickery in plain.tex to not require the
6059 % footnote text as a parameter.  Our footnotes don't need to be so general.
6060 %
6061 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6062 % \parseargline) fails inside footnotes because the tokens are fixed when
6063 % the footnote is read.  --karl, 16nov96.
6064 %
6065 \gdef\dofootnote{%
6066   \insert\footins\bgroup
6067   % We want to typeset this text as a normal paragraph, even if the
6068   % footnote reference occurs in (for example) a display environment.
6069   % So reset some parameters.
6070   \hsize=\pagewidth
6071   \interlinepenalty\interfootnotelinepenalty
6072   \splittopskip\ht\strutbox % top baseline for broken footnotes
6073   \splitmaxdepth\dp\strutbox
6074   \floatingpenalty\@MM
6075   \leftskip\z@skip
6076   \rightskip\z@skip
6077   \spaceskip\z@skip
6078   \xspaceskip\z@skip
6079   \parindent\defaultparindent
6080   %
6081   \smallfonts \rm
6082   %
6083   % Because we use hanging indentation in footnotes, a @noindent appears
6084   % to exdent this text, so make it be a no-op.  makeinfo does not use
6085   % hanging indentation so @noindent can still be needed within footnote
6086   % text after an @example or the like (not that this is good style).
6087   \let\noindent = \relax
6088   %
6089   % Hang the footnote text off the number.  Use \everypar in case the
6090   % footnote extends for more than one paragraph.
6091   \everypar = {\hang}%
6092   \textindent{\thisfootno}%
6093   %
6094   % Don't crash into the line above the footnote text.  Since this
6095   % expands into a box, it must come within the paragraph, lest it
6096   % provide a place where TeX can split the footnote.
6097   \footstrut
6098   \futurelet\next\fo@t
6099 }
6100 }%end \catcode `\@=11
6101
6102 % In case a @footnote appears in a vbox, save the footnote text and create
6103 % the real \insert just after the vbox finished.  Otherwise, the insertion
6104 % would be lost.
6105 % Similarily, if a @footnote appears inside an alignment, save the footnote
6106 % text to a box and make the \insert when a row of the table is finished.
6107 % And the same can be done for other insert classes.  --kasal, 16nov03.
6108
6109 % Replace the \insert primitive by a cheating macro.
6110 % Deeper inside, just make sure that the saved insertions are not spilled
6111 % out prematurely.
6112 %
6113 \def\startsavinginserts{%
6114   \ifx \insert\ptexinsert
6115     \let\insert\saveinsert
6116   \else
6117     \let\checkinserts\relax
6118   \fi
6119 }
6120
6121 % This \insert replacements works for both \insert\footins{foo} and
6122 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6123 %
6124 \def\saveinsert#1{%
6125   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6126   \afterassignment\next
6127   % swallow the left brace
6128   \let\temp =
6129 }
6130 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6131 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6132
6133 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6134
6135 \def\placesaveins#1{%
6136   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6137     {\box#1}%
6138 }
6139
6140 % eat @SAVE -- beware, all of them have catcode \other:
6141 {
6142   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
6143   \gdef\gobblesave @SAVE{}
6144 }
6145
6146 % initialization:
6147 \def\newsaveins #1{%
6148   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6149   \next
6150 }
6151 \def\newsaveinsX #1{%
6152   \csname newbox\endcsname #1%
6153   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6154     \checksaveins #1}%
6155 }
6156
6157 % initialize:
6158 \let\checkinserts\empty
6159 \newsaveins\footins
6160 \newsaveins\margin
6161
6162
6163 % @image.  We use the macros from epsf.tex to support this.
6164 % If epsf.tex is not installed and @image is used, we complain.
6165 %
6166 % Check for and read epsf.tex up front.  If we read it only at @image
6167 % time, we might be inside a group, and then its definitions would get
6168 % undone and the next image would fail.
6169 \openin 1 = epsf.tex
6170 \ifeof 1 \else
6171   % Do not bother showing banner with epsf.tex v2.7k (available in
6172   % doc/epsf.tex and on ctan).
6173   \def\epsfannounce{\toks0 = }%
6174   \input epsf.tex
6175 \fi
6176 \closein 1
6177 %
6178 % We will only complain once about lack of epsf.tex.
6179 \newif\ifwarnednoepsf
6180 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6181   work.  It is also included in the Texinfo distribution, or you can get
6182   it from ftp://tug.org/tex/epsf.tex.}
6183 %
6184 \def\image#1{%
6185   \ifx\epsfbox\undefined
6186     \ifwarnednoepsf \else
6187       \errhelp = \noepsfhelp
6188       \errmessage{epsf.tex not found, images will be ignored}%
6189       \global\warnednoepsftrue
6190     \fi
6191   \else
6192     \imagexxx #1,,,,,\finish
6193   \fi
6194 }
6195 %
6196 % Arguments to @image:
6197 % #1 is (mandatory) image filename; we tack on .eps extension.
6198 % #2 is (optional) width, #3 is (optional) height.
6199 % #4 is (ignored optional) html alt text.
6200 % #5 is (ignored optional) extension.
6201 % #6 is just the usual extra ignored arg for parsing this stuff.
6202 \newif\ifimagevmode
6203 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6204   \catcode`\^^M = 5     % in case we're inside an example
6205   \normalturnoffactive  % allow _ et al. in names
6206   % If the image is by itself, center it.
6207   \ifvmode
6208     \imagevmodetrue
6209     \nobreak\bigskip
6210     % Usually we'll have text after the image which will insert
6211     % \parskip glue, so insert it here too to equalize the space
6212     % above and below.
6213     \nobreak\vskip\parskip
6214     \nobreak
6215     \line\bgroup\hss
6216   \fi
6217   %
6218   % Output the image.
6219   \ifpdf
6220     \dopdfimage{#1}{#2}{#3}%
6221   \else
6222     % \epsfbox itself resets \epsf?size at each figure.
6223     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6224     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6225     \epsfbox{#1.eps}%
6226   \fi
6227   %
6228   \ifimagevmode \hss \egroup \bigbreak \fi  % space after the image
6229 \endgroup}
6230
6231
6232 % @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc.
6233 % We don't actually implement floating yet, we just plop the float "here".
6234 % But it seemed the best name for the future.
6235
6236 \envparseargdef\float{\dofloat #1,,,\finish}
6237
6238 % #1 is the optional FLOATTYPE, the text label for this float, typically
6239 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
6240 % this float will not be numbered and cannot be referred to.
6241
6242 % #2 is the optional xref label.  Also must be present for the float to
6243 % be referable.
6244
6245 % #3 is the optional positioning argument; for now, it is ignored.  It
6246 % will somehow specify the positions allowed to float to (here, top, bottom).
6247
6248 % We keep a separate counter for each FLOATTYPE, which we reset at each
6249 % chapter-level command.
6250 \let\resetallfloatnos=\empty
6251 %
6252 \def\dofloat#1,#2,#3,#4\finish{%
6253   % don't lose footnotes inside @float.
6254   \startsavinginserts
6255   %
6256   \vtop\bgroup
6257     \def\floattype{#1}%
6258     \def\floatlabel{#2}%
6259     \def\floatloc{#3}% we do nothing with this yet.
6260     %
6261     \ifx\floattype\empty \else
6262       {%
6263         % the floattype might have accents or other special characters,
6264         % but we need to use it in a control sequence name.
6265         \indexnofonts
6266         \turnoffactive
6267         \xdef\safefloattype{\floattype}%
6268       }%
6269       % We want each FLOATTYPE to be numbered separately (Figure 1,
6270       % Table 1, Figure 2, ...).
6271       % 
6272       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6273       \global\advance\floatno by 1
6274       %
6275       \ifx\floatlabel\empty \else
6276         {%
6277           % This magic value for \thissection is output by \setref as the
6278           % XREFLABEL-title value.  \xrefX uses it to distinguish float
6279           % labels (which have a completely different output format) from
6280           % node and anchor labels.
6281           % 
6282           \let\thissection=\floatmagic
6283           \setref{\floatlabel}{Yfloat}%
6284         }%
6285       \fi
6286     \fi
6287 }
6288
6289 % we have four possibilities:
6290 % @float Foo & @caption{Cap}: Foo 1.1: Cap
6291 % @float Foo & no caption:    Foo 1.1
6292 % @float & @caption{Cap}:     Cap
6293 % @float & no caption:
6294 %
6295 \def\Efloat{%
6296     \let\printedsomething = \empty
6297     %
6298     \ifx\floattype\empty \else
6299       \vskip.5\parskip  % space above caption
6300       %
6301       % Print the float number preceded by the chapter-level number
6302       % (empty in the case of unnumbered).  Although there are other
6303       % styles of float numbering, we hardwire this one.
6304       \floattype\space\chaplevelprefix\the\floatno
6305       \let\printedsomething = t%
6306     \fi
6307     %
6308     \ifx\thiscaption\empty \else
6309       \ifx\printedsomething\empty
6310         \vskip.5\parskip  % space above caption
6311       \else
6312         :\space  % had a number, so print a colon before the caption.
6313       \fi
6314       %
6315       % Print caption text.
6316       \thiscaption
6317       \let\printedsomething = t%
6318     \fi
6319     %
6320     % Space below caption, if we printed anything.
6321     \ifx\printedsomething\empty \else \vskip\parskip \fi
6322     %
6323   \egroup  % end of \vtop
6324   \checkinserts
6325 }
6326
6327 \def\caption#1{\checkenv\float \def\thiscaption{#1}}
6328 \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
6329 \let\thiscaption=\empty
6330 \let\thisshortcaption=\empty
6331
6332 % The parameter is the control sequence identifying the counter we are
6333 % going to use.  Create it if it doesn't exist and assign it to \floatno.
6334 \def\getfloatno#1{%
6335   \ifx#1\relax
6336       % Haven't seen this figure type before.
6337       \csname newcount\endcsname #1%
6338       %
6339       % Remember to reset this floatno at the next chap.
6340       \expandafter\gdef\expandafter\resetallfloatnos
6341         \expandafter{\resetallfloatnos #1=0 }%
6342   \fi
6343   \let\floatno#1%
6344 }
6345
6346 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
6347 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
6348 % first read the @float command.
6349
6350 \def\Yfloat{\floattype @tie{}\chaplevelprefix\the\floatno}%
6351
6352 % Magic string used for the XREFLABEL-title value, so \xrefX can
6353 % distinguish floats from other xref types.
6354 \def\floatmagic{!!float!!}
6355
6356 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6357 \parseargdef\listoffloats{%xx
6358 }
6359
6360
6361 \message{localization,}
6362 % and i18n.
6363
6364 % @documentlanguage is usually given very early, just after
6365 % @setfilename.  If done too late, it may not override everything
6366 % properly.  Single argument is the language abbreviation.
6367 % It would be nice if we could set up a hyphenation file here.
6368 %
6369 \parseargdef\documentlanguage{%
6370   \tex % read txi-??.tex file in plain TeX.
6371     % Read the file if it exists.
6372     \openin 1 txi-#1.tex
6373     \ifeof 1
6374       \errhelp = \nolanghelp
6375       \errmessage{Cannot read language file txi-#1.tex}%
6376     \else
6377       \input txi-#1.tex
6378     \fi
6379     \closein 1
6380   \endgroup
6381 }
6382 \newhelp\nolanghelp{The given language definition file cannot be found or
6383 is empty.  Maybe you need to install it?  In the current directory
6384 should work if nowhere else does.}
6385
6386
6387 % @documentencoding should change something in TeX eventually, most
6388 % likely, but for now just recognize it.
6389 \let\documentencoding = \comment
6390
6391
6392 % Page size parameters.
6393 %
6394 \newdimen\defaultparindent \defaultparindent = 15pt
6395
6396 \chapheadingskip = 15pt plus 4pt minus 2pt
6397 \secheadingskip = 12pt plus 3pt minus 2pt
6398 \subsecheadingskip = 9pt plus 2pt minus 2pt
6399
6400 % Prevent underfull vbox error messages.
6401 \vbadness = 10000
6402
6403 % Don't be so finicky about underfull hboxes, either.
6404 \hbadness = 2000
6405
6406 % Following George Bush, just get rid of widows and orphans.
6407 \widowpenalty=10000
6408 \clubpenalty=10000
6409
6410 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6411 % using an old version of TeX, don't do anything.  We want the amount of
6412 % stretch added to depend on the line length, hence the dependence on
6413 % \hsize.  We call this whenever the paper size is set.
6414 %
6415 \def\setemergencystretch{%
6416   \ifx\emergencystretch\thisisundefined
6417     % Allow us to assign to \emergencystretch anyway.
6418     \def\emergencystretch{\dimen0}%
6419   \else
6420     \emergencystretch = .15\hsize
6421   \fi
6422 }
6423
6424 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6425 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6426 % physical page width.
6427 %
6428 % We also call \setleading{\textleading}, so the caller should define
6429 % \textleading.  The caller should also set \parskip.
6430 %
6431 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6432   \voffset = #3\relax
6433   \topskip = #6\relax
6434   \splittopskip = \topskip
6435   %
6436   \vsize = #1\relax
6437   \advance\vsize by \topskip
6438   \outervsize = \vsize
6439   \advance\outervsize by 2\topandbottommargin
6440   \pageheight = \vsize
6441   %
6442   \hsize = #2\relax
6443   \outerhsize = \hsize
6444   \advance\outerhsize by 0.5in
6445   \pagewidth = \hsize
6446   %
6447   \normaloffset = #4\relax
6448   \bindingoffset = #5\relax
6449   %
6450   \ifpdf
6451     \pdfpageheight #7\relax
6452     \pdfpagewidth #8\relax
6453   \fi
6454   %
6455   \setleading{\textleading}
6456   %
6457   \parindent = \defaultparindent
6458   \setemergencystretch
6459 }
6460
6461 % @letterpaper (the default).
6462 \def\letterpaper{{\globaldefs = 1
6463   \parskip = 3pt plus 2pt minus 1pt
6464   \textleading = 13.2pt
6465   %
6466   % If page is nothing but text, make it come out even.
6467   \internalpagesizes{46\baselineskip}{6in}%
6468                     {\voffset}{.25in}%
6469                     {\bindingoffset}{36pt}%
6470                     {11in}{8.5in}%
6471 }}
6472
6473 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6474 \def\smallbook{{\globaldefs = 1
6475   \parskip = 2pt plus 1pt
6476   \textleading = 12pt
6477   %
6478   \internalpagesizes{7.5in}{5in}%
6479                     {\voffset}{.25in}%
6480                     {\bindingoffset}{16pt}%
6481                     {9.25in}{7in}%
6482   %
6483   \lispnarrowing = 0.3in
6484   \tolerance = 700
6485   \hfuzz = 1pt
6486   \contentsrightmargin = 0pt
6487   \defbodyindent = .5cm
6488 }}
6489
6490 % Use @afourpaper to print on European A4 paper.
6491 \def\afourpaper{{\globaldefs = 1
6492   \parskip = 3pt plus 2pt minus 1pt
6493   \textleading = 13.2pt
6494   %
6495   % Double-side printing via postscript on Laserjet 4050
6496   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6497   % To change the settings for a different printer or situation, adjust
6498   % \normaloffset until the front-side and back-side texts align.  Then
6499   % do the same for \bindingoffset.  You can set these for testing in
6500   % your texinfo source file like this:
6501   % @tex
6502   % \global\normaloffset = -6mm
6503   % \global\bindingoffset = 10mm
6504   % @end tex
6505   \internalpagesizes{51\baselineskip}{160mm}
6506                     {\voffset}{\hoffset}%
6507                     {\bindingoffset}{44pt}%
6508                     {297mm}{210mm}%
6509   %
6510   \tolerance = 700
6511   \hfuzz = 1pt
6512   \contentsrightmargin = 0pt
6513   \defbodyindent = 5mm
6514 }}
6515
6516 % Use @afivepaper to print on European A5 paper.
6517 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6518 % He also recommends making @example and @lisp be small.
6519 \def\afivepaper{{\globaldefs = 1
6520   \parskip = 2pt plus 1pt minus 0.1pt
6521   \textleading = 12.5pt
6522   %
6523   \internalpagesizes{160mm}{120mm}%
6524                     {\voffset}{\hoffset}%
6525                     {\bindingoffset}{8pt}%
6526                     {210mm}{148mm}%
6527   %
6528   \lispnarrowing = 0.2in
6529   \tolerance = 800
6530   \hfuzz = 1.2pt
6531   \contentsrightmargin = 0pt
6532   \defbodyindent = 2mm
6533   \tableindent = 12mm
6534 }}
6535
6536 % A specific text layout, 24x15cm overall, intended for A4 paper.
6537 \def\afourlatex{{\globaldefs = 1
6538   \afourpaper
6539   \internalpagesizes{237mm}{150mm}%
6540                     {\voffset}{4.6mm}%
6541                     {\bindingoffset}{7mm}%
6542                     {297mm}{210mm}%
6543   %
6544   % Must explicitly reset to 0 because we call \afourpaper.
6545   \globaldefs = 0
6546 }}
6547
6548 % Use @afourwide to print on A4 paper in landscape format.
6549 \def\afourwide{{\globaldefs = 1
6550   \afourpaper
6551   \internalpagesizes{241mm}{165mm}%
6552                     {\voffset}{-2.95mm}%
6553                     {\bindingoffset}{7mm}%
6554                     {297mm}{210mm}%
6555   \globaldefs = 0
6556 }}
6557
6558 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6559 % Perhaps we should allow setting the margins, \topskip, \parskip,
6560 % and/or leading, also. Or perhaps we should compute them somehow.
6561 %
6562 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6563 \def\pagesizesyyy#1,#2,#3\finish{{%
6564   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6565   \globaldefs = 1
6566   %
6567   \parskip = 3pt plus 2pt minus 1pt
6568   \setleading{\textleading}%
6569   %
6570   \dimen0 = #1
6571   \advance\dimen0 by \voffset
6572   %
6573   \dimen2 = \hsize
6574   \advance\dimen2 by \normaloffset
6575   %
6576   \internalpagesizes{#1}{\hsize}%
6577                     {\voffset}{\normaloffset}%
6578                     {\bindingoffset}{44pt}%
6579                     {\dimen0}{\dimen2}%
6580 }}
6581
6582 % Set default to letter.
6583 %
6584 \letterpaper
6585
6586
6587 \message{and turning on texinfo input format.}
6588
6589 % Define macros to output various characters with catcode for normal text.
6590 \catcode`\"=\other
6591 \catcode`\~=\other
6592 \catcode`\^=\other
6593 \catcode`\_=\other
6594 \catcode`\|=\other
6595 \catcode`\<=\other
6596 \catcode`\>=\other
6597 \catcode`\+=\other
6598 \catcode`\$=\other
6599 \def\normaldoublequote{"}
6600 \def\normaltilde{~}
6601 \def\normalcaret{^}
6602 \def\normalunderscore{_}
6603 \def\normalverticalbar{|}
6604 \def\normalless{<}
6605 \def\normalgreater{>}
6606 \def\normalplus{+}
6607 \def\normaldollar{$}%$ font-lock fix
6608
6609 % This macro is used to make a character print one way in \tt
6610 % (where it can probably be output as-is), and another way in other fonts,
6611 % where something hairier probably needs to be done.
6612 %
6613 % #1 is what to print if we are indeed using \tt; #2 is what to print
6614 % otherwise.  Since all the Computer Modern typewriter fonts have zero
6615 % interword stretch (and shrink), and it is reasonable to expect all
6616 % typewriter fonts to have this, we can check that font parameter.
6617 %
6618 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6619
6620 % Same as above, but check for italic font.  Actually this also catches
6621 % non-italic slanted fonts since it is impossible to distinguish them from
6622 % italic fonts.  But since this is only used by $ and it uses \sl anyway
6623 % this is not a problem.
6624 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6625
6626 % Turn off all special characters except @
6627 % (and those which the user can use as if they were ordinary).
6628 % Most of these we simply print from the \tt font, but for some, we can
6629 % use math or other variants that look better in normal text.
6630
6631 \catcode`\"=\active
6632 \def\activedoublequote{{\tt\char34}}
6633 \let"=\activedoublequote
6634 \catcode`\~=\active
6635 \def~{{\tt\char126}}
6636 \chardef\hat=`\^
6637 \catcode`\^=\active
6638 \def^{{\tt \hat}}
6639
6640 \catcode`\_=\active
6641 \def_{\ifusingtt\normalunderscore\_}
6642 % Subroutine for the previous macro.
6643 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6644
6645 \catcode`\|=\active
6646 \def|{{\tt\char124}}
6647 \chardef \less=`\<
6648 \catcode`\<=\active
6649 \def<{{\tt \less}}
6650 \chardef \gtr=`\>
6651 \catcode`\>=\active
6652 \def>{{\tt \gtr}}
6653 \catcode`\+=\active
6654 \def+{{\tt \char 43}}
6655 \catcode`\$=\active
6656 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6657
6658 % If a .fmt file is being used, characters that might appear in a file
6659 % name cannot be active until we have parsed the command line.
6660 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6661 % \otherifyactive is called near the end of this file.
6662 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6663
6664 \catcode`\@=0
6665
6666 % \backslashcurfont outputs one backslash character in current font,
6667 % as in \char`\\.
6668 \global\chardef\backslashcurfont=`\\
6669
6670 % \rawbackslash defines an active \ to do \backslashcurfont.
6671 % \otherbackslash defines an active \ to be a literal `\' character with
6672 % catcode other.
6673 {\catcode`\\=\active
6674  @gdef@rawbackslash{@let\=@backslashcurfont}
6675  @gdef@otherbackslash{@let\=@realbackslash}
6676 }
6677
6678 % \realbackslash is an actual character `\' with catcode other.
6679 {\catcode`\\=\other @gdef@realbackslash{\}}
6680
6681 % \normalbackslash outputs one backslash in fixed width font.
6682 \def\normalbackslash{{\tt\backslashcurfont}}
6683
6684 \catcode`\\=\active
6685
6686 % Used sometimes to turn off (effectively) the active characters
6687 % even after parsing them.
6688 @def@turnoffactive{%
6689   @let"=@normaldoublequote
6690   @let\=@realbackslash
6691   @let~=@normaltilde
6692   @let^=@normalcaret
6693   @let_=@normalunderscore
6694   @let|=@normalverticalbar
6695   @let<=@normalless
6696   @let>=@normalgreater
6697   @let+=@normalplus
6698   @let$=@normaldollar %$ font-lock fix
6699   @unsepspaces
6700 }
6701
6702 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6703 % the literal character `\'.  (Thus, \ is not expandable when this is in
6704 % effect.)
6705 %
6706 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6707
6708 % Make _ and + \other characters, temporarily.
6709 % This is canceled by @fixbackslash.
6710 @otherifyactive
6711
6712 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6713 % That is what \eatinput is for; after that, the `\' should revert to printing
6714 % a backslash.
6715 %
6716 @gdef@eatinput input texinfo{@fixbackslash}
6717 @global@let\ = @eatinput
6718
6719 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6720 % the first `\{ in the file would cause an error. This macro tries to fix
6721 % that, assuming it is called before the first `\' could plausibly occur.
6722 % Also back turn on active characters that might appear in the input
6723 % file name, in case not using a pre-dumped format.
6724 %
6725 @gdef@fixbackslash{%
6726   @ifx\@eatinput @let\ = @normalbackslash @fi
6727   @catcode`+=@active
6728   @catcode`@_=@active
6729 }
6730
6731 % Say @foo, not \foo, in error messages.
6732 @escapechar = `@@
6733
6734 % These look ok in all fonts, so just make them not special.
6735 @catcode`@& = @other
6736 @catcode`@# = @other
6737 @catcode`@% = @other
6738
6739
6740 @c Local variables:
6741 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6742 @c page-delimiter: "^\\\\message"
6743 @c time-stamp-start: "def\\\\texinfoversion{"
6744 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6745 @c time-stamp-end: "}"
6746 @c End:
6747
6748 @c vim:sw=2:
6749
6750 @ignore
6751    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
6752 @end ignore