Fix typo in last commit.
[pspp] / build-aux / 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{2008-11-09.14}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008 Free Software 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 3 of the
15 % License, or (at 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 program.  If not, see <http://www.gnu.org/licenses/>.
24 %
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction.  (This has been our intent since Texinfo was invented.)
28 %
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 %   ftp://tug.org/tex/texinfo.tex
33 %     (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
36 %
37 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem.  Patches are, of course, greatly appreciated.
40 %
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution.  For a simple
43 % manual foo.texi, however, you can get away with this:
44 %   tex foo.texi
45 %   texindex foo.??
46 %   tex foo.texi
47 %   tex foo.texi
48 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
52 %
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent.  You can get the existing language-specific files from the
55 % full Texinfo distribution.
56 %
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
58
59
60 \message{Loading texinfo [version \texinfoversion]:}
61
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66   \catcode`+=\active \catcode`\_=\active}
67
68
69 \chardef\other=12
70
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
73 \let\+ = \relax
74
75 % Save some plain tex macros whose names we will redefine.
76 \let\ptexb=\b
77 \let\ptexbullet=\bullet
78 \let\ptexc=\c
79 \let\ptexcomma=\,
80 \let\ptexdot=\.
81 \let\ptexdots=\dots
82 \let\ptexend=\end
83 \let\ptexequiv=\equiv
84 \let\ptexexclam=\!
85 \let\ptexfootnote=\footnote
86 \let\ptexgtr=>
87 \let\ptexhat=^
88 \let\ptexi=\i
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
95 \let\ptexplus=+
96 \let\ptexrbrace=\}
97 \let\ptexslash=\/
98 \let\ptexstar=\*
99 \let\ptext=\t
100 \let\ptextop=\top
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 % Since the category of space is not known, we have to be careful.
156 \chardef\spacecat = 10
157 \def\spaceisspace{\catcode`\ =\spacecat}
158
159 % sometimes characters are active, so we need control sequences.
160 \chardef\colonChar = `\:
161 \chardef\commaChar = `\,
162 \chardef\dashChar  = `\-
163 \chardef\dotChar   = `\.
164 \chardef\exclamChar= `\!
165 \chardef\lquoteChar= `\`
166 \chardef\questChar = `\?
167 \chardef\rquoteChar= `\'
168 \chardef\semiChar  = `\;
169 \chardef\underChar = `\_
170
171 % Ignore a token.
172 %
173 \def\gobble#1{}
174
175 % The following is used inside several \edef's.
176 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
177
178 % Hyphenation fixes.
179 \hyphenation{
180   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
181   ap-pen-dix bit-map bit-maps
182   data-base data-bases eshell fall-ing half-way long-est man-u-script
183   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
184   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
185   spell-ing spell-ings
186   stand-alone strong-est time-stamp time-stamps which-ever white-space
187   wide-spread wrap-around
188 }
189
190 % Margin to add to right of even pages, to left of odd pages.
191 \newdimen\bindingoffset
192 \newdimen\normaloffset
193 \newdimen\pagewidth \newdimen\pageheight
194
195 % For a final copy, take out the rectangles
196 % that mark overfull boxes (in case you have decided
197 % that the text looks ok even though it passes the margin).
198 %
199 \def\finalout{\overfullrule=0pt}
200
201 % @| inserts a changebar to the left of the current line.  It should
202 % surround any changed text.  This approach does *not* work if the
203 % change spans more than two lines of output.  To handle that, we would
204 % have adopt a much more difficult approach (putting marks into the main
205 % vertical list for the beginning and end of each change).
206 %
207 \def\|{%
208   % \vadjust can only be used in horizontal mode.
209   \leavevmode
210   %
211   % Append this vertical mode material after the current line in the output.
212   \vadjust{%
213     % We want to insert a rule with the height and depth of the current
214     % leading; that is exactly what \strutbox is supposed to record.
215     \vskip-\baselineskip
216     %
217     % \vadjust-items are inserted at the left edge of the type.  So
218     % the \llap here moves out into the left-hand margin.
219     \llap{%
220       %
221       % For a thicker or thinner bar, change the `1pt'.
222       \vrule height\baselineskip width1pt
223       %
224       % This is the space between the bar and the text.
225       \hskip 12pt
226     }%
227   }%
228 }
229
230 % Sometimes it is convenient to have everything in the transcript file
231 % and nothing on the terminal.  We don't just call \tracingall here,
232 % since that produces some useless output on the terminal.  We also make
233 % some effort to order the tracing commands to reduce output in the log
234 % file; cf. trace.sty in LaTeX.
235 %
236 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
237 \def\loggingall{%
238   \tracingstats2
239   \tracingpages1
240   \tracinglostchars2  % 2 gives us more in etex
241   \tracingparagraphs1
242   \tracingoutput1
243   \tracingmacros2
244   \tracingrestores1
245   \showboxbreadth\maxdimen \showboxdepth\maxdimen
246   \ifx\eTeXversion\undefined\else % etex gives us more logging
247     \tracingscantokens1
248     \tracingifs1
249     \tracinggroups1
250     \tracingnesting2
251     \tracingassigns1
252   \fi
253   \tracingcommands3  % 3 gives us more in etex
254   \errorcontextlines16
255 }%
256
257 % add check for \lastpenalty to plain's definitions.  If the last thing
258 % we did was a \nobreak, we don't want to insert more space.
259 %
260 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
261   \removelastskip\penalty-50\smallskip\fi\fi}
262 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
263   \removelastskip\penalty-100\medskip\fi\fi}
264 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
265   \removelastskip\penalty-200\bigskip\fi\fi}
266
267 % For @cropmarks command.
268 % Do @cropmarks to get crop marks.
269 %
270 \newif\ifcropmarks
271 \let\cropmarks = \cropmarkstrue
272 %
273 % Dimensions to add cropmarks at corners.
274 % Added by P. A. MacKay, 12 Nov. 1986
275 %
276 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
277 \newdimen\cornerlong  \cornerlong=1pc
278 \newdimen\cornerthick \cornerthick=.3pt
279 \newdimen\topandbottommargin \topandbottommargin=.75in
280
281 % Output a mark which sets \thischapter, \thissection and \thiscolor.
282 % We dump everything together because we only have one kind of mark.
283 % This works because we only use \botmark / \topmark, not \firstmark.
284 %
285 % A mark contains a subexpression of the \ifcase ... \fi construct.
286 % \get*marks macros below extract the needed part using \ifcase.
287 %
288 % Another complication is to let the user choose whether \thischapter
289 % (\thissection) refers to the chapter (section) in effect at the top
290 % of a page, or that at the bottom of a page.  The solution is
291 % described on page 260 of The TeXbook.  It involves outputting two
292 % marks for the sectioning macros, one before the section break, and
293 % one after.  I won't pretend I can describe this better than DEK...
294 \def\domark{%
295   \toks0=\expandafter{\lastchapterdefs}%
296   \toks2=\expandafter{\lastsectiondefs}%
297   \toks4=\expandafter{\prevchapterdefs}%
298   \toks6=\expandafter{\prevsectiondefs}%
299   \toks8=\expandafter{\lastcolordefs}%
300   \mark{%
301                    \the\toks0 \the\toks2
302       \noexpand\or \the\toks4 \the\toks6
303     \noexpand\else \the\toks8
304   }%
305 }
306 % \topmark doesn't work for the very first chapter (after the title
307 % page or the contents), so we use \firstmark there -- this gets us
308 % the mark with the chapter defs, unless the user sneaks in, e.g.,
309 % @setcolor (or @url, or @link, etc.) between @contents and the very
310 % first @chapter.
311 \def\gettopheadingmarks{%
312   \ifcase0\topmark\fi
313   \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
314 }
315 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
316 \def\getcolormarks{\ifcase2\topmark\fi}
317
318 % Avoid "undefined control sequence" errors.
319 \def\lastchapterdefs{}
320 \def\lastsectiondefs{}
321 \def\prevchapterdefs{}
322 \def\prevsectiondefs{}
323 \def\lastcolordefs{}
324
325 % Main output routine.
326 \chardef\PAGE = 255
327 \output = {\onepageout{\pagecontents\PAGE}}
328
329 \newbox\headlinebox
330 \newbox\footlinebox
331
332 % \onepageout takes a vbox as an argument.  Note that \pagecontents
333 % does insertions, but you have to call it yourself.
334 \def\onepageout#1{%
335   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
336   %
337   \ifodd\pageno  \advance\hoffset by \bindingoffset
338   \else \advance\hoffset by -\bindingoffset\fi
339   %
340   % Do this outside of the \shipout so @code etc. will be expanded in
341   % the headline as they should be, not taken literally (outputting ''code).
342   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
343   \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
344   \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
345   \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
346   %
347   {%
348     % Have to do this stuff outside the \shipout because we want it to
349     % take effect in \write's, yet the group defined by the \vbox ends
350     % before the \shipout runs.
351     %
352     \indexdummies         % don't expand commands in the output.
353     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
354                % the page break happens to be in the middle of an example.
355                % We don't want .vr (or whatever) entries like this:
356                % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
357                % "\acronym" won't work when it's read back in;
358                % it needs to be 
359                % {\code {{\tt \backslashcurfont }acronym}
360     \shipout\vbox{%
361       % Do this early so pdf references go to the beginning of the page.
362       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
363       %
364       \ifcropmarks \vbox to \outervsize\bgroup
365         \hsize = \outerhsize
366         \vskip-\topandbottommargin
367         \vtop to0pt{%
368           \line{\ewtop\hfil\ewtop}%
369           \nointerlineskip
370           \line{%
371             \vbox{\moveleft\cornerthick\nstop}%
372             \hfill
373             \vbox{\moveright\cornerthick\nstop}%
374           }%
375           \vss}%
376         \vskip\topandbottommargin
377         \line\bgroup
378           \hfil % center the page within the outer (page) hsize.
379           \ifodd\pageno\hskip\bindingoffset\fi
380           \vbox\bgroup
381       \fi
382       %
383       \unvbox\headlinebox
384       \pagebody{#1}%
385       \ifdim\ht\footlinebox > 0pt
386         % Only leave this space if the footline is nonempty.
387         % (We lessened \vsize for it in \oddfootingyyy.)
388         % The \baselineskip=24pt in plain's \makefootline has no effect.
389         \vskip 24pt
390         \unvbox\footlinebox
391       \fi
392       %
393       \ifcropmarks
394           \egroup % end of \vbox\bgroup
395         \hfil\egroup % end of (centering) \line\bgroup
396         \vskip\topandbottommargin plus1fill minus1fill
397         \boxmaxdepth = \cornerthick
398         \vbox to0pt{\vss
399           \line{%
400             \vbox{\moveleft\cornerthick\nsbot}%
401             \hfill
402             \vbox{\moveright\cornerthick\nsbot}%
403           }%
404           \nointerlineskip
405           \line{\ewbot\hfil\ewbot}%
406         }%
407       \egroup % \vbox from first cropmarks clause
408       \fi
409     }% end of \shipout\vbox
410   }% end of group with \indexdummies
411   \advancepageno
412   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
413 }
414
415 \newinsert\margin \dimen\margin=\maxdimen
416
417 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
418 {\catcode`\@ =11
419 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
420 % marginal hacks, juha@viisa.uucp (Juha Takala)
421 \ifvoid\margin\else % marginal info is present
422   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
423 \dimen@=\dp#1\relax \unvbox#1\relax
424 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
425 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
426 }
427
428 % Here are the rules for the cropmarks.  Note that they are
429 % offset so that the space between them is truly \outerhsize or \outervsize
430 % (P. A. MacKay, 12 November, 1986)
431 %
432 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
433 \def\nstop{\vbox
434   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
435 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
436 \def\nsbot{\vbox
437   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
438
439 % Parse an argument, then pass it to #1.  The argument is the rest of
440 % the input line (except we remove a trailing comment).  #1 should be a
441 % macro which expects an ordinary undelimited TeX argument.
442 %
443 \def\parsearg{\parseargusing{}}
444 \def\parseargusing#1#2{%
445   \def\argtorun{#2}%
446   \begingroup
447     \obeylines
448     \spaceisspace
449     #1%
450     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
451 }
452
453 {\obeylines %
454   \gdef\parseargline#1^^M{%
455     \endgroup % End of the group started in \parsearg.
456     \argremovecomment #1\comment\ArgTerm%
457   }%
458 }
459
460 % First remove any @comment, then any @c comment.
461 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
462 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
463
464 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
465 %
466 % \argremovec might leave us with trailing space, e.g.,
467 %    @end itemize  @c foo
468 % This space token undergoes the same procedure and is eventually removed
469 % by \finishparsearg.
470 %
471 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
472 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
473 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
474   \def\temp{#3}%
475   \ifx\temp\empty
476     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
477     \let\temp\finishparsearg
478   \else
479     \let\temp\argcheckspaces
480   \fi
481   % Put the space token in:
482   \temp#1 #3\ArgTerm
483 }
484
485 % If a _delimited_ argument is enclosed in braces, they get stripped; so
486 % to get _exactly_ the rest of the line, we had to prevent such situation.
487 % We prepended an \empty token at the very beginning and we expand it now,
488 % just before passing the control to \argtorun.
489 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
490 % either the null string, or it ends with \^^M---thus there is no danger
491 % that a pair of braces would be stripped.
492 %
493 % But first, we have to remove the trailing space token.
494 %
495 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
496
497 % \parseargdef\foo{...}
498 %       is roughly equivalent to
499 % \def\foo{\parsearg\Xfoo}
500 % \def\Xfoo#1{...}
501 %
502 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
503 % favourite TeX trick.  --kasal, 16nov03
504
505 \def\parseargdef#1{%
506   \expandafter \doparseargdef \csname\string#1\endcsname #1%
507 }
508 \def\doparseargdef#1#2{%
509   \def#2{\parsearg#1}%
510   \def#1##1%
511 }
512
513 % Several utility definitions with active space:
514 {
515   \obeyspaces
516   \gdef\obeyedspace{ }
517
518   % Make each space character in the input produce a normal interword
519   % space in the output.  Don't allow a line break at this space, as this
520   % is used only in environments like @example, where each line of input
521   % should produce a line of output anyway.
522   %
523   \gdef\sepspaces{\obeyspaces\let =\tie}
524
525   % If an index command is used in an @example environment, any spaces
526   % therein should become regular spaces in the raw index file, not the
527   % expansion of \tie (\leavevmode \penalty \@M \ ).
528   \gdef\unsepspaces{\let =\space}
529 }
530
531
532 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
533
534 % Define the framework for environments in texinfo.tex.  It's used like this:
535 %
536 %   \envdef\foo{...}
537 %   \def\Efoo{...}
538 %
539 % It's the responsibility of \envdef to insert \begingroup before the
540 % actual body; @end closes the group after calling \Efoo.  \envdef also
541 % defines \thisenv, so the current environment is known; @end checks
542 % whether the environment name matches.  The \checkenv macro can also be
543 % used to check whether the current environment is the one expected.
544 %
545 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
546 % are not treated as environments; they don't open a group.  (The
547 % implementation of @end takes care not to call \endgroup in this
548 % special case.)
549
550
551 % At run-time, environments start with this:
552 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
553 % initialize
554 \let\thisenv\empty
555
556 % ... but they get defined via ``\envdef\foo{...}'':
557 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
558 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
559
560 % Check whether we're in the right environment:
561 \def\checkenv#1{%
562   \def\temp{#1}%
563   \ifx\thisenv\temp
564   \else
565     \badenverr
566   \fi
567 }
568
569 % Environment mismatch, #1 expected:
570 \def\badenverr{%
571   \errhelp = \EMsimple
572   \errmessage{This command can appear only \inenvironment\temp,
573     not \inenvironment\thisenv}%
574 }
575 \def\inenvironment#1{%
576   \ifx#1\empty
577     out of any environment%
578   \else
579     in environment \expandafter\string#1%
580   \fi
581 }
582
583 % @end foo executes the definition of \Efoo.
584 % But first, it executes a specialized version of \checkenv
585 %
586 \parseargdef\end{%
587   \if 1\csname iscond.#1\endcsname
588   \else
589     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
590     \expandafter\checkenv\csname#1\endcsname
591     \csname E#1\endcsname
592     \endgroup
593   \fi
594 }
595
596 \newhelp\EMsimple{Press RETURN to continue.}
597
598
599 %% Simple single-character @ commands
600
601 % @@ prints an @
602 % Kludge this until the fonts are right (grr).
603 \def\@{{\tt\char64}}
604
605 % This is turned off because it was never documented
606 % and you can use @w{...} around a quote to suppress ligatures.
607 %% Define @` and @' to be the same as ` and '
608 %% but suppressing ligatures.
609 %\def\`{{`}}
610 %\def\'{{'}}
611
612 % Used to generate quoted braces.
613 \def\mylbrace {{\tt\char123}}
614 \def\myrbrace {{\tt\char125}}
615 \let\{=\mylbrace
616 \let\}=\myrbrace
617 \begingroup
618   % Definitions to produce \{ and \} commands for indices,
619   % and @{ and @} for the aux/toc files.
620   \catcode`\{ = \other \catcode`\} = \other
621   \catcode`\[ = 1 \catcode`\] = 2
622   \catcode`\! = 0 \catcode`\\ = \other
623   !gdef!lbracecmd[\{]%
624   !gdef!rbracecmd[\}]%
625   !gdef!lbraceatcmd[@{]%
626   !gdef!rbraceatcmd[@}]%
627 !endgroup
628
629 % @comma{} to avoid , parsing problems.
630 \let\comma = ,
631
632 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
633 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
634 \let\, = \c
635 \let\dotaccent = \.
636 \def\ringaccent#1{{\accent23 #1}}
637 \let\tieaccent = \t
638 \let\ubaraccent = \b
639 \let\udotaccent = \d
640
641 % Other special characters: @questiondown @exclamdown @ordf @ordm
642 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
643 \def\questiondown{?`}
644 \def\exclamdown{!`}
645 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
646 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
647
648 % Dotless i and dotless j, used for accents.
649 \def\imacro{i}
650 \def\jmacro{j}
651 \def\dotless#1{%
652   \def\temp{#1}%
653   \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
654   \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
655   \else \errmessage{@dotless can be used only with i or j}%
656   \fi\fi
657 }
658
659 % The \TeX{} logo, as in plain, but resetting the spacing so that a
660 % period following counts as ending a sentence.  (Idea found in latex.)
661 %
662 \edef\TeX{\TeX \spacefactor=1000 }
663
664 % @LaTeX{} logo.  Not quite the same results as the definition in
665 % latex.ltx, since we use a different font for the raised A; it's most
666 % convenient for us to use an explicitly smaller font, rather than using
667 % the \scriptstyle font (since we don't reset \scriptstyle and
668 % \scriptscriptstyle).
669 %
670 \def\LaTeX{%
671   L\kern-.36em
672   {\setbox0=\hbox{T}%
673    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
674   \kern-.15em
675   \TeX
676 }
677
678 % Be sure we're in horizontal mode when doing a tie, since we make space
679 % equivalent to this in @example-like environments. Otherwise, a space
680 % at the beginning of a line will start with \penalty -- and
681 % since \penalty is valid in vertical mode, we'd end up putting the
682 % penalty on the vertical list instead of in the new paragraph.
683 {\catcode`@ = 11
684  % Avoid using \@M directly, because that causes trouble
685  % if the definition is written into an index file.
686  \global\let\tiepenalty = \@M
687  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
688 }
689
690 % @: forces normal size whitespace following.
691 \def\:{\spacefactor=1000 }
692
693 % @* forces a line break.
694 \def\*{\hfil\break\hbox{}\ignorespaces}
695
696 % @/ allows a line break.
697 \let\/=\allowbreak
698
699 % @. is an end-of-sentence period.
700 \def\.{.\spacefactor=\endofsentencespacefactor\space}
701
702 % @! is an end-of-sentence bang.
703 \def\!{!\spacefactor=\endofsentencespacefactor\space}
704
705 % @? is an end-of-sentence query.
706 \def\?{?\spacefactor=\endofsentencespacefactor\space}
707
708 % @frenchspacing on|off  says whether to put extra space after punctuation.
709
710 \def\onword{on}
711 \def\offword{off}
712 %
713 \parseargdef\frenchspacing{%
714   \def\temp{#1}%
715   \ifx\temp\onword \plainfrenchspacing
716   \else\ifx\temp\offword \plainnonfrenchspacing
717   \else
718     \errhelp = \EMsimple
719     \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
720   \fi\fi
721 }
722
723 % @w prevents a word break.  Without the \leavevmode, @w at the
724 % beginning of a paragraph, when TeX is still in vertical mode, would
725 % produce a whole line of output instead of starting the paragraph.
726 \def\w#1{\leavevmode\hbox{#1}}
727
728 % @group ... @end group forces ... to be all on one page, by enclosing
729 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
730 % to keep its height that of a normal line.  According to the rules for
731 % \topskip (p.114 of the TeXbook), the glue inserted is
732 % max (\topskip - \ht (first item), 0).  If that height is large,
733 % therefore, no glue is inserted, and the space between the headline and
734 % the text is small, which looks bad.
735 %
736 % Another complication is that the group might be very large.  This can
737 % cause the glue on the previous page to be unduly stretched, because it
738 % does not have much material.  In this case, it's better to add an
739 % explicit \vfill so that the extra space is at the bottom.  The
740 % threshold for doing this is if the group is more than \vfilllimit
741 % percent of a page (\vfilllimit can be changed inside of @tex).
742 %
743 \newbox\groupbox
744 \def\vfilllimit{0.7}
745 %
746 \envdef\group{%
747   \ifnum\catcode`\^^M=\active \else
748     \errhelp = \groupinvalidhelp
749     \errmessage{@group invalid in context where filling is enabled}%
750   \fi
751   \startsavinginserts
752   %
753   \setbox\groupbox = \vtop\bgroup
754     % Do @comment since we are called inside an environment such as
755     % @example, where each end-of-line in the input causes an
756     % end-of-line in the output.  We don't want the end-of-line after
757     % the `@group' to put extra space in the output.  Since @group
758     % should appear on a line by itself (according to the Texinfo
759     % manual), we don't worry about eating any user text.
760     \comment
761 }
762 %
763 % The \vtop produces a box with normal height and large depth; thus, TeX puts
764 % \baselineskip glue before it, and (when the next line of text is done)
765 % \lineskip glue after it.  Thus, space below is not quite equal to space
766 % above.  But it's pretty close.
767 \def\Egroup{%
768     % To get correct interline space between the last line of the group
769     % and the first line afterwards, we have to propagate \prevdepth.
770     \endgraf % Not \par, as it may have been set to \lisppar.
771     \global\dimen1 = \prevdepth
772   \egroup           % End the \vtop.
773   % \dimen0 is the vertical size of the group's box.
774   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
775   % \dimen2 is how much space is left on the page (more or less).
776   \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
777   % if the group doesn't fit on the current page, and it's a big big
778   % group, force a page break.
779   \ifdim \dimen0 > \dimen2
780     \ifdim \pagetotal < \vfilllimit\pageheight
781       \page
782     \fi
783   \fi
784   \box\groupbox
785   \prevdepth = \dimen1
786   \checkinserts
787 }
788 %
789 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
790 % message, so this ends up printing `@group can only ...'.
791 %
792 \newhelp\groupinvalidhelp{%
793 group can only be used in environments such as @example,^^J%
794 where each line of input produces a line of output.}
795
796 % @need space-in-mils
797 % forces a page break if there is not space-in-mils remaining.
798
799 \newdimen\mil  \mil=0.001in
800
801 % Old definition--didn't work.
802 %\parseargdef\need{\par %
803 %% This method tries to make TeX break the page naturally
804 %% if the depth of the box does not fit.
805 %{\baselineskip=0pt%
806 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
807 %\prevdepth=-1000pt
808 %}}
809
810 \parseargdef\need{%
811   % Ensure vertical mode, so we don't make a big box in the middle of a
812   % paragraph.
813   \par
814   %
815   % If the @need value is less than one line space, it's useless.
816   \dimen0 = #1\mil
817   \dimen2 = \ht\strutbox
818   \advance\dimen2 by \dp\strutbox
819   \ifdim\dimen0 > \dimen2
820     %
821     % Do a \strut just to make the height of this box be normal, so the
822     % normal leading is inserted relative to the preceding line.
823     % And a page break here is fine.
824     \vtop to #1\mil{\strut\vfil}%
825     %
826     % TeX does not even consider page breaks if a penalty added to the
827     % main vertical list is 10000 or more.  But in order to see if the
828     % empty box we just added fits on the page, we must make it consider
829     % page breaks.  On the other hand, we don't want to actually break the
830     % page after the empty box.  So we use a penalty of 9999.
831     %
832     % There is an extremely small chance that TeX will actually break the
833     % page at this \penalty, if there are no other feasible breakpoints in
834     % sight.  (If the user is using lots of big @group commands, which
835     % almost-but-not-quite fill up a page, TeX will have a hard time doing
836     % good page breaking, for example.)  However, I could not construct an
837     % example where a page broke at this \penalty; if it happens in a real
838     % document, then we can reconsider our strategy.
839     \penalty9999
840     %
841     % Back up by the size of the box, whether we did a page break or not.
842     \kern -#1\mil
843     %
844     % Do not allow a page break right after this kern.
845     \nobreak
846   \fi
847 }
848
849 % @br   forces paragraph break (and is undocumented).
850
851 \let\br = \par
852
853 % @page forces the start of a new page.
854 %
855 \def\page{\par\vfill\supereject}
856
857 % @exdent text....
858 % outputs text on separate line in roman font, starting at standard page margin
859
860 % This records the amount of indent in the innermost environment.
861 % That's how much \exdent should take out.
862 \newskip\exdentamount
863
864 % This defn is used inside fill environments such as @defun.
865 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
866
867 % This defn is used inside nofill environments such as @example.
868 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
869   \leftline{\hskip\leftskip{\rm#1}}}}
870
871 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
872 % paragraph.  For more general purposes, use the \margin insertion
873 % class.  WHICH is `l' or `r'.
874 %
875 \newskip\inmarginspacing \inmarginspacing=1cm
876 \def\strutdepth{\dp\strutbox}
877 %
878 \def\doinmargin#1#2{\strut\vadjust{%
879   \nobreak
880   \kern-\strutdepth
881   \vtop to \strutdepth{%
882     \baselineskip=\strutdepth
883     \vss
884     % if you have multiple lines of stuff to put here, you'll need to
885     % make the vbox yourself of the appropriate size.
886     \ifx#1l%
887       \llap{\ignorespaces #2\hskip\inmarginspacing}%
888     \else
889       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
890     \fi
891     \null
892   }%
893 }}
894 \def\inleftmargin{\doinmargin l}
895 \def\inrightmargin{\doinmargin r}
896 %
897 % @inmargin{TEXT [, RIGHT-TEXT]}
898 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
899 % else use TEXT for both).
900 %
901 \def\inmargin#1{\parseinmargin #1,,\finish}
902 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
903   \setbox0 = \hbox{\ignorespaces #2}%
904   \ifdim\wd0 > 0pt
905     \def\lefttext{#1}%  have both texts
906     \def\righttext{#2}%
907   \else
908     \def\lefttext{#1}%  have only one text
909     \def\righttext{#1}%
910   \fi
911   %
912   \ifodd\pageno
913     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
914   \else
915     \def\temp{\inleftmargin\lefttext}%
916   \fi
917   \temp
918 }
919
920 % @include FILE -- \input text of FILE.
921 %
922 \def\include{\parseargusing\filenamecatcodes\includezzz}
923 \def\includezzz#1{%
924   \pushthisfilestack
925   \def\thisfile{#1}%
926   {%
927     \makevalueexpandable  % we want to expand any @value in FILE.
928     \turnoffactive        % and allow special characters in the expansion
929     \indexnofonts         % Allow `@@' and other weird things in file names.
930     \edef\temp{\noexpand\input #1 }%
931     %
932     % This trickery is to read FILE outside of a group, in case it makes
933     % definitions, etc.
934     \expandafter
935   }\temp
936   \popthisfilestack
937 }
938 \def\filenamecatcodes{%
939   \catcode`\\=\other
940   \catcode`~=\other
941   \catcode`^=\other
942   \catcode`_=\other
943   \catcode`|=\other
944   \catcode`<=\other
945   \catcode`>=\other
946   \catcode`+=\other
947   \catcode`-=\other
948 }
949
950 \def\pushthisfilestack{%
951   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
952 }
953 \def\pushthisfilestackX{%
954   \expandafter\pushthisfilestackY\thisfile\StackTerm
955 }
956 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
957   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
958 }
959
960 \def\popthisfilestack{\errthisfilestackempty}
961 \def\errthisfilestackempty{\errmessage{Internal error:
962   the stack of filenames is empty.}}
963
964 \def\thisfile{}
965
966 % @center line
967 % outputs that line, centered.
968 %
969 \parseargdef\center{%
970   \ifhmode
971     \let\next\centerH
972   \else
973     \let\next\centerV
974   \fi
975   \next{\hfil \ignorespaces#1\unskip \hfil}%
976 }
977 \def\centerH#1{%
978   {%
979     \hfil\break
980     \advance\hsize by -\leftskip
981     \advance\hsize by -\rightskip
982     \line{#1}%
983     \break
984   }%
985 }
986 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
987
988 % @sp n   outputs n lines of vertical space
989
990 \parseargdef\sp{\vskip #1\baselineskip}
991
992 % @comment ...line which is ignored...
993 % @c is the same as @comment
994 % @ignore ... @end ignore  is another way to write a comment
995
996 \def\comment{\begingroup \catcode`\^^M=\other%
997 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
998 \commentxxx}
999 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1000
1001 \let\c=\comment
1002
1003 % @paragraphindent NCHARS
1004 % We'll use ems for NCHARS, close enough.
1005 % NCHARS can also be the word `asis' or `none'.
1006 % We cannot feasibly implement @paragraphindent asis, though.
1007 %
1008 \def\asisword{asis} % no translation, these are keywords
1009 \def\noneword{none}
1010 %
1011 \parseargdef\paragraphindent{%
1012   \def\temp{#1}%
1013   \ifx\temp\asisword
1014   \else
1015     \ifx\temp\noneword
1016       \defaultparindent = 0pt
1017     \else
1018       \defaultparindent = #1em
1019     \fi
1020   \fi
1021   \parindent = \defaultparindent
1022 }
1023
1024 % @exampleindent NCHARS
1025 % We'll use ems for NCHARS like @paragraphindent.
1026 % It seems @exampleindent asis isn't necessary, but
1027 % I preserve it to make it similar to @paragraphindent.
1028 \parseargdef\exampleindent{%
1029   \def\temp{#1}%
1030   \ifx\temp\asisword
1031   \else
1032     \ifx\temp\noneword
1033       \lispnarrowing = 0pt
1034     \else
1035       \lispnarrowing = #1em
1036     \fi
1037   \fi
1038 }
1039
1040 % @firstparagraphindent WORD
1041 % If WORD is `none', then suppress indentation of the first paragraph
1042 % after a section heading.  If WORD is `insert', then do indent at such
1043 % paragraphs.
1044 %
1045 % The paragraph indentation is suppressed or not by calling
1046 % \suppressfirstparagraphindent, which the sectioning commands do.
1047 % We switch the definition of this back and forth according to WORD.
1048 % By default, we suppress indentation.
1049 %
1050 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1051 \def\insertword{insert}
1052 %
1053 \parseargdef\firstparagraphindent{%
1054   \def\temp{#1}%
1055   \ifx\temp\noneword
1056     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1057   \else\ifx\temp\insertword
1058     \let\suppressfirstparagraphindent = \relax
1059   \else
1060     \errhelp = \EMsimple
1061     \errmessage{Unknown @firstparagraphindent option `\temp'}%
1062   \fi\fi
1063 }
1064
1065 % Here is how we actually suppress indentation.  Redefine \everypar to
1066 % \kern backwards by \parindent, and then reset itself to empty.
1067 %
1068 % We also make \indent itself not actually do anything until the next
1069 % paragraph.
1070 %
1071 \gdef\dosuppressfirstparagraphindent{%
1072   \gdef\indent{%
1073     \restorefirstparagraphindent
1074     \indent
1075   }%
1076   \gdef\noindent{%
1077     \restorefirstparagraphindent
1078     \noindent
1079   }%
1080   \global\everypar = {%
1081     \kern -\parindent
1082     \restorefirstparagraphindent
1083   }%
1084 }
1085
1086 \gdef\restorefirstparagraphindent{%
1087   \global \let \indent = \ptexindent
1088   \global \let \noindent = \ptexnoindent
1089   \global \everypar = {}%
1090 }
1091
1092
1093 % @asis just yields its argument.  Used with @table, for example.
1094 %
1095 \def\asis#1{#1}
1096
1097 % @math outputs its argument in math mode.
1098 %
1099 % One complication: _ usually means subscripts, but it could also mean
1100 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1101 % _ active, and distinguish by seeing if the current family is \slfam,
1102 % which is what @var uses.
1103 {
1104   \catcode`\_ = \active
1105   \gdef\mathunderscore{%
1106     \catcode`\_=\active
1107     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1108   }
1109 }
1110 % Another complication: we want \\ (and @\) to output a \ character.
1111 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1112 % this is not advertised and we don't care.  Texinfo does not
1113 % otherwise define @\.
1114 %
1115 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1116 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1117 %
1118 \def\math{%
1119   \tex
1120   \mathunderscore
1121   \let\\ = \mathbackslash
1122   \mathactive
1123   % make the texinfo accent commands work in math mode
1124   \let\"=\ddot
1125   \let\'=\acute
1126   \let\==\bar
1127   \let\^=\hat
1128   \let\`=\grave
1129   \let\u=\breve
1130   \let\v=\check
1131   \let\~=\tilde
1132   \let\dotaccent=\dot
1133   $\finishmath
1134 }
1135 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1136
1137 % Some active characters (such as <) are spaced differently in math.
1138 % We have to reset their definitions in case the @math was an argument
1139 % to a command which sets the catcodes (such as @item or @section).
1140 %
1141 {
1142   \catcode`^ = \active
1143   \catcode`< = \active
1144   \catcode`> = \active
1145   \catcode`+ = \active
1146   \gdef\mathactive{%
1147     \let^ = \ptexhat
1148     \let< = \ptexless
1149     \let> = \ptexgtr
1150     \let+ = \ptexplus
1151   }
1152 }
1153
1154 % Some math mode symbols.
1155 \def\bullet{$\ptexbullet$}
1156 \def\geq{\ifmmode \ge\else $\ge$\fi}
1157 \def\leq{\ifmmode \le\else $\le$\fi}
1158 \def\minus{\ifmmode -\else $-$\fi}
1159
1160 % @dots{} outputs an ellipsis using the current font.
1161 % We do .5em per period so that it has the same spacing in the cm
1162 % typewriter fonts as three actual period characters; on the other hand,
1163 % in other typewriter fonts three periods are wider than 1.5em.  So do
1164 % whichever is larger.
1165 %
1166 \def\dots{%
1167   \leavevmode
1168   \setbox0=\hbox{...}% get width of three periods
1169   \ifdim\wd0 > 1.5em
1170     \dimen0 = \wd0
1171   \else
1172     \dimen0 = 1.5em
1173   \fi
1174   \hbox to \dimen0{%
1175     \hskip 0pt plus.25fil
1176     .\hskip 0pt plus1fil
1177     .\hskip 0pt plus1fil
1178     .\hskip 0pt plus.5fil
1179   }%
1180 }
1181
1182 % @enddots{} is an end-of-sentence ellipsis.
1183 %
1184 \def\enddots{%
1185   \dots
1186   \spacefactor=\endofsentencespacefactor
1187 }
1188
1189 % @comma{} is so commas can be inserted into text without messing up
1190 % Texinfo's parsing.
1191 %
1192 \let\comma = ,
1193
1194 % @refill is a no-op.
1195 \let\refill=\relax
1196
1197 % If working on a large document in chapters, it is convenient to
1198 % be able to disable indexing, cross-referencing, and contents, for test runs.
1199 % This is done with @novalidate (before @setfilename).
1200 %
1201 \newif\iflinks \linkstrue % by default we want the aux files.
1202 \let\novalidate = \linksfalse
1203
1204 % @setfilename is done at the beginning of every texinfo file.
1205 % So open here the files we need to have open while reading the input.
1206 % This makes it possible to make a .fmt file for texinfo.
1207 \def\setfilename{%
1208    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1209    \iflinks
1210      \tryauxfile
1211      % Open the new aux file.  TeX will close it automatically at exit.
1212      \immediate\openout\auxfile=\jobname.aux
1213    \fi % \openindices needs to do some work in any case.
1214    \openindices
1215    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1216    %
1217    % If texinfo.cnf is present on the system, read it.
1218    % Useful for site-wide @afourpaper, etc.
1219    \openin 1 texinfo.cnf
1220    \ifeof 1 \else \input texinfo.cnf \fi
1221    \closein 1
1222    %
1223    \comment % Ignore the actual filename.
1224 }
1225
1226 % Called from \setfilename.
1227 %
1228 \def\openindices{%
1229   \newindex{cp}%
1230   \newcodeindex{fn}%
1231   \newcodeindex{vr}%
1232   \newcodeindex{tp}%
1233   \newcodeindex{ky}%
1234   \newcodeindex{pg}%
1235 }
1236
1237 % @bye.
1238 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1239
1240
1241 \message{pdf,}
1242 % adobe `portable' document format
1243 \newcount\tempnum
1244 \newcount\lnkcount
1245 \newtoks\filename
1246 \newcount\filenamelength
1247 \newcount\pgn
1248 \newtoks\toksA
1249 \newtoks\toksB
1250 \newtoks\toksC
1251 \newtoks\toksD
1252 \newbox\boxA
1253 \newcount\countA
1254 \newif\ifpdf
1255 \newif\ifpdfmakepagedest
1256
1257 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1258 % can be set).  So we test for \relax and 0 as well as \undefined,
1259 % borrowed from ifpdf.sty.
1260 \ifx\pdfoutput\undefined
1261 \else
1262   \ifx\pdfoutput\relax
1263   \else
1264     \ifcase\pdfoutput
1265     \else
1266       \pdftrue
1267     \fi
1268   \fi
1269 \fi
1270
1271 % PDF uses PostScript string constants for the names of xref targets,
1272 % for display in the outlines, and in other places.  Thus, we have to
1273 % double any backslashes.  Otherwise, a name like "\node" will be
1274 % interpreted as a newline (\n), followed by o, d, e.  Not good.
1275 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1276 % (and related messages, the final outcome is that it is up to the TeX
1277 % user to double the backslashes and otherwise make the string valid, so
1278 % that's what we do).
1279
1280 % double active backslashes.
1281
1282 {\catcode`\@=0 \catcode`\\=\active
1283  @gdef@activebackslashdouble{%
1284    @catcode`@\=@active
1285    @let\=@doublebackslash}
1286 }
1287
1288 % To handle parens, we must adopt a different approach, since parens are
1289 % not active characters.  hyperref.dtx (which has the same problem as
1290 % us) handles it with this amazing macro to replace tokens, with minor
1291 % changes for Texinfo.  It is included here under the GPL by permission
1292 % from the author, Heiko Oberdiek.
1293
1294 % #1 is the tokens to replace.
1295 % #2 is the replacement.
1296 % #3 is the control sequence with the string.
1297
1298 \def\HyPsdSubst#1#2#3{%
1299   \def\HyPsdReplace##1#1##2\END{%
1300     ##1%
1301     \ifx\\##2\\%
1302     \else
1303       #2%
1304       \HyReturnAfterFi{%
1305         \HyPsdReplace##2\END
1306       }%
1307     \fi
1308   }%
1309   \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1310 }
1311 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1312
1313 % #1 is a control sequence in which to do the replacements.
1314 \def\backslashparens#1{%
1315   \xdef#1{#1}% redefine it as its expansion; the definition is simply
1316              % \lastnode when called from \setref -> \pdfmkdest.
1317   \HyPsdSubst{(}{\realbackslash(}{#1}%
1318   \HyPsdSubst{)}{\realbackslash)}{#1}%
1319 }
1320
1321 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1322 with PDF output, and none of those formats could be found.  (.eps cannot
1323 be supported due to the design of the PDF format; use regular TeX (DVI
1324 output) for that.)}
1325
1326 \ifpdf
1327   %
1328   % Color manipulation macros based on pdfcolor.tex.
1329   \def\cmykDarkRed{0.28 1 1 0.35}
1330   \def\cmykBlack{0 0 0 1}
1331   %
1332   \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1333   % Set color, and create a mark which defines \thiscolor accordingly,
1334   % so that \makeheadline knows which color to restore.
1335   \def\setcolor#1{%
1336     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1337     \domark
1338     \pdfsetcolor{#1}%
1339   }
1340   %
1341   \def\maincolor{\cmykBlack}
1342   \pdfsetcolor{\maincolor}
1343   \edef\thiscolor{\maincolor}
1344   \def\lastcolordefs{}
1345   %
1346   \def\makefootline{%
1347     \baselineskip24pt
1348     \line{\pdfsetcolor{\maincolor}\the\footline}%
1349   }
1350   %
1351   \def\makeheadline{%
1352     \vbox to 0pt{%
1353       \vskip-22.5pt
1354       \line{%
1355         \vbox to8.5pt{}%
1356         % Extract \thiscolor definition from the marks.
1357         \getcolormarks
1358         % Typeset the headline with \maincolor, then restore the color.
1359         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1360       }%
1361       \vss
1362     }%
1363     \nointerlineskip
1364   }
1365   %
1366   %
1367   \pdfcatalog{/PageMode /UseOutlines}
1368   %
1369   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1370   \def\dopdfimage#1#2#3{%
1371     \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1372     \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1373     %
1374     % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1375     % others).  Let's try in that order.
1376     \let\pdfimgext=\empty
1377     \begingroup
1378       \openin 1 #1.png \ifeof 1
1379         \openin 1 #1.jpg \ifeof 1
1380           \openin 1 #1.jpeg \ifeof 1
1381             \openin 1 #1.JPG \ifeof 1
1382               \openin 1 #1.pdf \ifeof 1
1383                 \openin 1 #1.PDF \ifeof 1
1384                   \errhelp = \nopdfimagehelp
1385                   \errmessage{Could not find image file #1 for pdf}%
1386                 \else \gdef\pdfimgext{PDF}%
1387                 \fi
1388               \else \gdef\pdfimgext{pdf}%
1389               \fi
1390             \else \gdef\pdfimgext{JPG}%
1391             \fi
1392           \else \gdef\pdfimgext{jpeg}%
1393           \fi
1394         \else \gdef\pdfimgext{jpg}%
1395         \fi
1396       \else \gdef\pdfimgext{png}%
1397       \fi
1398       \closein 1
1399     \endgroup
1400     %
1401     % without \immediate, ancient pdftex seg faults when the same image is
1402     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1403     \ifnum\pdftexversion < 14
1404       \immediate\pdfimage
1405     \else
1406       \immediate\pdfximage
1407     \fi
1408       \ifdim \wd0 >0pt width \imagewidth \fi
1409       \ifdim \wd2 >0pt height \imageheight \fi
1410       \ifnum\pdftexversion<13
1411          #1.\pdfimgext
1412        \else
1413          {#1.\pdfimgext}%
1414        \fi
1415     \ifnum\pdftexversion < 14 \else
1416       \pdfrefximage \pdflastximage
1417     \fi}
1418   %
1419   \def\pdfmkdest#1{{%
1420     % We have to set dummies so commands such as @code, and characters
1421     % such as \, aren't expanded when present in a section title.
1422     \indexnofonts
1423     \turnoffactive
1424     \activebackslashdouble
1425     \makevalueexpandable
1426     \def\pdfdestname{#1}%
1427     \backslashparens\pdfdestname
1428     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1429   }}
1430   %
1431   % used to mark target names; must be expandable.
1432   \def\pdfmkpgn#1{#1}
1433   %
1434   % by default, use a color that is dark enough to print on paper as
1435   % nearly black, but still distinguishable for online viewing.
1436   \def\urlcolor{\cmykDarkRed}
1437   \def\linkcolor{\cmykDarkRed}
1438   \def\endlink{\setcolor{\maincolor}\pdfendlink}
1439   %
1440   % Adding outlines to PDF; macros for calculating structure of outlines
1441   % come from Petr Olsak
1442   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1443     \else \csname#1\endcsname \fi}
1444   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1445     \advance\tempnum by 1
1446     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1447   %
1448   % #1 is the section text, which is what will be displayed in the
1449   % outline by the pdf viewer.  #2 is the pdf expression for the number
1450   % of subentries (or empty, for subsubsections).  #3 is the node text,
1451   % which might be empty if this toc entry had no corresponding node.
1452   % #4 is the page number
1453   %
1454   \def\dopdfoutline#1#2#3#4{%
1455     % Generate a link to the node text if that exists; else, use the
1456     % page number.  We could generate a destination for the section
1457     % text in the case where a section has no node, but it doesn't
1458     % seem worth the trouble, since most documents are normally structured.
1459     \def\pdfoutlinedest{#3}%
1460     \ifx\pdfoutlinedest\empty
1461       \def\pdfoutlinedest{#4}%
1462     \else
1463       % Doubled backslashes in the name.
1464       {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1465        \backslashparens\pdfoutlinedest}%
1466     \fi
1467     %
1468     % Also double the backslashes in the display string.
1469     {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1470      \backslashparens\pdfoutlinetext}%
1471     %
1472     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1473   }
1474   %
1475   \def\pdfmakeoutlines{%
1476     \begingroup
1477       % Thanh's hack / proper braces in bookmarks
1478       \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1479       \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1480       %
1481       % Read toc silently, to get counts of subentries for \pdfoutline.
1482       \def\numchapentry##1##2##3##4{%
1483         \def\thischapnum{##2}%
1484         \def\thissecnum{0}%
1485         \def\thissubsecnum{0}%
1486       }%
1487       \def\numsecentry##1##2##3##4{%
1488         \advancenumber{chap\thischapnum}%
1489         \def\thissecnum{##2}%
1490         \def\thissubsecnum{0}%
1491       }%
1492       \def\numsubsecentry##1##2##3##4{%
1493         \advancenumber{sec\thissecnum}%
1494         \def\thissubsecnum{##2}%
1495       }%
1496       \def\numsubsubsecentry##1##2##3##4{%
1497         \advancenumber{subsec\thissubsecnum}%
1498       }%
1499       \def\thischapnum{0}%
1500       \def\thissecnum{0}%
1501       \def\thissubsecnum{0}%
1502       %
1503       % use \def rather than \let here because we redefine \chapentry et
1504       % al. a second time, below.
1505       \def\appentry{\numchapentry}%
1506       \def\appsecentry{\numsecentry}%
1507       \def\appsubsecentry{\numsubsecentry}%
1508       \def\appsubsubsecentry{\numsubsubsecentry}%
1509       \def\unnchapentry{\numchapentry}%
1510       \def\unnsecentry{\numsecentry}%
1511       \def\unnsubsecentry{\numsubsecentry}%
1512       \def\unnsubsubsecentry{\numsubsubsecentry}%
1513       \readdatafile{toc}%
1514       %
1515       % Read toc second time, this time actually producing the outlines.
1516       % The `-' means take the \expnumber as the absolute number of
1517       % subentries, which we calculated on our first read of the .toc above.
1518       %
1519       % We use the node names as the destinations.
1520       \def\numchapentry##1##2##3##4{%
1521         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1522       \def\numsecentry##1##2##3##4{%
1523         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1524       \def\numsubsecentry##1##2##3##4{%
1525         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1526       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1527         \dopdfoutline{##1}{}{##3}{##4}}%
1528       %
1529       % PDF outlines are displayed using system fonts, instead of
1530       % document fonts.  Therefore we cannot use special characters,
1531       % since the encoding is unknown.  For example, the eogonek from
1532       % Latin 2 (0xea) gets translated to a | character.  Info from
1533       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1534       %
1535       % xx to do this right, we have to translate 8-bit characters to
1536       % their "best" equivalent, based on the @documentencoding.  Right
1537       % now, I guess we'll just let the pdf reader have its way.
1538       \indexnofonts
1539       \setupdatafile
1540       \catcode`\\=\active \otherbackslash
1541       \input \tocreadfilename
1542     \endgroup
1543   }
1544   %
1545   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1546     \ifx\PP\D\let\nextsp\relax
1547     \else\let\nextsp\skipspaces
1548       \ifx\p\space\else\addtokens{\filename}{\PP}%
1549         \advance\filenamelength by 1
1550       \fi
1551     \fi
1552     \nextsp}
1553   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1554   \ifnum\pdftexversion < 14
1555     \let \startlink \pdfannotlink
1556   \else
1557     \let \startlink \pdfstartlink
1558   \fi
1559   % make a live url in pdf output.
1560   \def\pdfurl#1{%
1561     \begingroup
1562       % it seems we really need yet another set of dummies; have not
1563       % tried to figure out what each command should do in the context
1564       % of @url.  for now, just make @/ a no-op, that's the only one
1565       % people have actually reported a problem with.
1566       % 
1567       \normalturnoffactive
1568       \def\@{@}%
1569       \let\/=\empty
1570       \makevalueexpandable
1571       \leavevmode\setcolor{\urlcolor}%
1572       \startlink attr{/Border [0 0 0]}%
1573         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1574     \endgroup}
1575   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1576   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1577   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1578   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1579   \def\maketoks{%
1580     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1581     \ifx\first0\adn0
1582     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1583     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1584     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1585     \else
1586       \ifnum0=\countA\else\makelink\fi
1587       \ifx\first.\let\next=\done\else
1588         \let\next=\maketoks
1589         \addtokens{\toksB}{\the\toksD}
1590         \ifx\first,\addtokens{\toksB}{\space}\fi
1591       \fi
1592     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1593     \next}
1594   \def\makelink{\addtokens{\toksB}%
1595     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1596   \def\pdflink#1{%
1597     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1598     \setcolor{\linkcolor}#1\endlink}
1599   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1600 \else
1601   \let\pdfmkdest = \gobble
1602   \let\pdfurl = \gobble
1603   \let\endlink = \relax
1604   \let\setcolor = \gobble
1605   \let\pdfsetcolor = \gobble
1606   \let\pdfmakeoutlines = \relax
1607 \fi  % \ifx\pdfoutput
1608
1609
1610 \message{fonts,}
1611
1612 % Change the current font style to #1, remembering it in \curfontstyle.
1613 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1614 % italics, not bold italics.
1615 %
1616 \def\setfontstyle#1{%
1617   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1618   \csname ten#1\endcsname  % change the current font
1619 }
1620
1621 % Select #1 fonts with the current style.
1622 %
1623 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1624
1625 \def\rm{\fam=0 \setfontstyle{rm}}
1626 \def\it{\fam=\itfam \setfontstyle{it}}
1627 \def\sl{\fam=\slfam \setfontstyle{sl}}
1628 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1629 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1630
1631 % Unfortunately, we have to override this for titles and the like, since
1632 % in those cases "rm" is bold.  Sigh.
1633 \def\rmisbold{\rm\def\curfontstyle{bf}}
1634
1635 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1636 % So we set up a \sf.
1637 \newfam\sffam
1638 \def\sf{\fam=\sffam \setfontstyle{sf}}
1639 \let\li = \sf % Sometimes we call it \li, not \sf.
1640
1641 % We don't need math for this font style.
1642 \def\ttsl{\setfontstyle{ttsl}}
1643
1644
1645 % Default leading.
1646 \newdimen\textleading  \textleading = 13.2pt
1647
1648 % Set the baselineskip to #1, and the lineskip and strut size
1649 % correspondingly.  There is no deep meaning behind these magic numbers
1650 % used as factors; they just match (closely enough) what Knuth defined.
1651 %
1652 \def\lineskipfactor{.08333}
1653 \def\strutheightpercent{.70833}
1654 \def\strutdepthpercent {.29167}
1655 %
1656 % can get a sort of poor man's double spacing by redefining this.
1657 \def\baselinefactor{1}
1658 %
1659 \def\setleading#1{%
1660   \dimen0 = #1\relax
1661   \normalbaselineskip = \baselinefactor\dimen0
1662   \normallineskip = \lineskipfactor\normalbaselineskip
1663   \normalbaselines
1664   \setbox\strutbox =\hbox{%
1665     \vrule width0pt height\strutheightpercent\baselineskip
1666                     depth \strutdepthpercent \baselineskip
1667   }%
1668 }
1669
1670 % PDF CMaps.  See also LaTeX's t1.cmap.
1671 %
1672 % do nothing with this by default.
1673 \expandafter\let\csname cmapOT1\endcsname\gobble
1674 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1675 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1676
1677 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1678 % (\pdffontattr was introduced many years ago, but people still run
1679 % older pdftex's; it's easy to conditionalize, so we do.)
1680 \ifpdf \ifx\pdffontattr\undefined \else
1681   \begingroup
1682     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1683     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1684 %%DocumentNeededResources: ProcSet (CIDInit)
1685 %%IncludeResource: ProcSet (CIDInit)
1686 %%BeginResource: CMap (TeX-OT1-0)
1687 %%Title: (TeX-OT1-0 TeX OT1 0)
1688 %%Version: 1.000
1689 %%EndComments
1690 /CIDInit /ProcSet findresource begin
1691 12 dict begin
1692 begincmap
1693 /CIDSystemInfo
1694 << /Registry (TeX)
1695 /Ordering (OT1)
1696 /Supplement 0
1697 >> def
1698 /CMapName /TeX-OT1-0 def
1699 /CMapType 2 def
1700 1 begincodespacerange
1701 <00> <7F>
1702 endcodespacerange
1703 8 beginbfrange
1704 <00> <01> <0393>
1705 <09> <0A> <03A8>
1706 <23> <26> <0023>
1707 <28> <3B> <0028>
1708 <3F> <5B> <003F>
1709 <5D> <5E> <005D>
1710 <61> <7A> <0061>
1711 <7B> <7C> <2013>
1712 endbfrange
1713 40 beginbfchar
1714 <02> <0398>
1715 <03> <039B>
1716 <04> <039E>
1717 <05> <03A0>
1718 <06> <03A3>
1719 <07> <03D2>
1720 <08> <03A6>
1721 <0B> <00660066>
1722 <0C> <00660069>
1723 <0D> <0066006C>
1724 <0E> <006600660069>
1725 <0F> <00660066006C>
1726 <10> <0131>
1727 <11> <0237>
1728 <12> <0060>
1729 <13> <00B4>
1730 <14> <02C7>
1731 <15> <02D8>
1732 <16> <00AF>
1733 <17> <02DA>
1734 <18> <00B8>
1735 <19> <00DF>
1736 <1A> <00E6>
1737 <1B> <0153>
1738 <1C> <00F8>
1739 <1D> <00C6>
1740 <1E> <0152>
1741 <1F> <00D8>
1742 <21> <0021>
1743 <22> <201D>
1744 <27> <2019>
1745 <3C> <00A1>
1746 <3D> <003D>
1747 <3E> <00BF>
1748 <5C> <201C>
1749 <5F> <02D9>
1750 <60> <2018>
1751 <7D> <02DD>
1752 <7E> <007E>
1753 <7F> <00A8>
1754 endbfchar
1755 endcmap
1756 CMapName currentdict /CMap defineresource pop
1757 end
1758 end
1759 %%EndResource
1760 %%EOF
1761     }\endgroup
1762   \expandafter\edef\csname cmapOT1\endcsname#1{%
1763     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1764   }%
1765 %
1766 % \cmapOT1IT
1767   \begingroup
1768     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1769     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1770 %%DocumentNeededResources: ProcSet (CIDInit)
1771 %%IncludeResource: ProcSet (CIDInit)
1772 %%BeginResource: CMap (TeX-OT1IT-0)
1773 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1774 %%Version: 1.000
1775 %%EndComments
1776 /CIDInit /ProcSet findresource begin
1777 12 dict begin
1778 begincmap
1779 /CIDSystemInfo
1780 << /Registry (TeX)
1781 /Ordering (OT1IT)
1782 /Supplement 0
1783 >> def
1784 /CMapName /TeX-OT1IT-0 def
1785 /CMapType 2 def
1786 1 begincodespacerange
1787 <00> <7F>
1788 endcodespacerange
1789 8 beginbfrange
1790 <00> <01> <0393>
1791 <09> <0A> <03A8>
1792 <25> <26> <0025>
1793 <28> <3B> <0028>
1794 <3F> <5B> <003F>
1795 <5D> <5E> <005D>
1796 <61> <7A> <0061>
1797 <7B> <7C> <2013>
1798 endbfrange
1799 42 beginbfchar
1800 <02> <0398>
1801 <03> <039B>
1802 <04> <039E>
1803 <05> <03A0>
1804 <06> <03A3>
1805 <07> <03D2>
1806 <08> <03A6>
1807 <0B> <00660066>
1808 <0C> <00660069>
1809 <0D> <0066006C>
1810 <0E> <006600660069>
1811 <0F> <00660066006C>
1812 <10> <0131>
1813 <11> <0237>
1814 <12> <0060>
1815 <13> <00B4>
1816 <14> <02C7>
1817 <15> <02D8>
1818 <16> <00AF>
1819 <17> <02DA>
1820 <18> <00B8>
1821 <19> <00DF>
1822 <1A> <00E6>
1823 <1B> <0153>
1824 <1C> <00F8>
1825 <1D> <00C6>
1826 <1E> <0152>
1827 <1F> <00D8>
1828 <21> <0021>
1829 <22> <201D>
1830 <23> <0023>
1831 <24> <00A3>
1832 <27> <2019>
1833 <3C> <00A1>
1834 <3D> <003D>
1835 <3E> <00BF>
1836 <5C> <201C>
1837 <5F> <02D9>
1838 <60> <2018>
1839 <7D> <02DD>
1840 <7E> <007E>
1841 <7F> <00A8>
1842 endbfchar
1843 endcmap
1844 CMapName currentdict /CMap defineresource pop
1845 end
1846 end
1847 %%EndResource
1848 %%EOF
1849     }\endgroup
1850   \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1851     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1852   }%
1853 %
1854 % \cmapOT1TT
1855   \begingroup
1856     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1857     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1858 %%DocumentNeededResources: ProcSet (CIDInit)
1859 %%IncludeResource: ProcSet (CIDInit)
1860 %%BeginResource: CMap (TeX-OT1TT-0)
1861 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1862 %%Version: 1.000
1863 %%EndComments
1864 /CIDInit /ProcSet findresource begin
1865 12 dict begin
1866 begincmap
1867 /CIDSystemInfo
1868 << /Registry (TeX)
1869 /Ordering (OT1TT)
1870 /Supplement 0
1871 >> def
1872 /CMapName /TeX-OT1TT-0 def
1873 /CMapType 2 def
1874 1 begincodespacerange
1875 <00> <7F>
1876 endcodespacerange
1877 5 beginbfrange
1878 <00> <01> <0393>
1879 <09> <0A> <03A8>
1880 <21> <26> <0021>
1881 <28> <5F> <0028>
1882 <61> <7E> <0061>
1883 endbfrange
1884 32 beginbfchar
1885 <02> <0398>
1886 <03> <039B>
1887 <04> <039E>
1888 <05> <03A0>
1889 <06> <03A3>
1890 <07> <03D2>
1891 <08> <03A6>
1892 <0B> <2191>
1893 <0C> <2193>
1894 <0D> <0027>
1895 <0E> <00A1>
1896 <0F> <00BF>
1897 <10> <0131>
1898 <11> <0237>
1899 <12> <0060>
1900 <13> <00B4>
1901 <14> <02C7>
1902 <15> <02D8>
1903 <16> <00AF>
1904 <17> <02DA>
1905 <18> <00B8>
1906 <19> <00DF>
1907 <1A> <00E6>
1908 <1B> <0153>
1909 <1C> <00F8>
1910 <1D> <00C6>
1911 <1E> <0152>
1912 <1F> <00D8>
1913 <20> <2423>
1914 <27> <2019>
1915 <60> <2018>
1916 <7F> <00A8>
1917 endbfchar
1918 endcmap
1919 CMapName currentdict /CMap defineresource pop
1920 end
1921 end
1922 %%EndResource
1923 %%EOF
1924     }\endgroup
1925   \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1926     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1927   }%
1928 \fi\fi
1929
1930
1931 % Set the font macro #1 to the font named #2, adding on the
1932 % specified font prefix (normally `cm').
1933 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1934 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1935 % empty to omit).
1936 \def\setfont#1#2#3#4#5{%
1937   \font#1=\fontprefix#2#3 scaled #4
1938   \csname cmap#5\endcsname#1%
1939 }
1940 % This is what gets called when #5 of \setfont is empty.
1941 \let\cmap\gobble
1942 % emacs-page end of cmaps
1943
1944 % Use cm as the default font prefix.
1945 % To specify the font prefix, you must define \fontprefix
1946 % before you read in texinfo.tex.
1947 \ifx\fontprefix\undefined
1948 \def\fontprefix{cm}
1949 \fi
1950 % Support font families that don't use the same naming scheme as CM.
1951 \def\rmshape{r}
1952 \def\rmbshape{bx}               %where the normal face is bold
1953 \def\bfshape{b}
1954 \def\bxshape{bx}
1955 \def\ttshape{tt}
1956 \def\ttbshape{tt}
1957 \def\ttslshape{sltt}
1958 \def\itshape{ti}
1959 \def\itbshape{bxti}
1960 \def\slshape{sl}
1961 \def\slbshape{bxsl}
1962 \def\sfshape{ss}
1963 \def\sfbshape{ss}
1964 \def\scshape{csc}
1965 \def\scbshape{csc}
1966
1967 % Definitions for a main text size of 11pt.  This is the default in
1968 % Texinfo.
1969
1970 \def\definetextfontsizexi{%
1971 % Text fonts (11.2pt, magstep1).
1972 \def\textnominalsize{11pt}
1973 \edef\mainmagstep{\magstephalf}
1974 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1975 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1976 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1977 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1978 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1979 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1980 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1981 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1982 \font\texti=cmmi10 scaled \mainmagstep
1983 \font\textsy=cmsy10 scaled \mainmagstep
1984 \def\textecsize{1095}
1985
1986 % A few fonts for @defun names and args.
1987 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1988 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1989 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1990 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1991
1992 % Fonts for indices, footnotes, small examples (9pt).
1993 \def\smallnominalsize{9pt}
1994 \setfont\smallrm\rmshape{9}{1000}{OT1}
1995 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1996 \setfont\smallbf\bfshape{10}{900}{OT1}
1997 \setfont\smallit\itshape{9}{1000}{OT1IT}
1998 \setfont\smallsl\slshape{9}{1000}{OT1}
1999 \setfont\smallsf\sfshape{9}{1000}{OT1}
2000 \setfont\smallsc\scshape{10}{900}{OT1}
2001 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2002 \font\smalli=cmmi9
2003 \font\smallsy=cmsy9
2004 \def\smallecsize{0900}
2005
2006 % Fonts for small examples (8pt).
2007 \def\smallernominalsize{8pt}
2008 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2009 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2010 \setfont\smallerbf\bfshape{10}{800}{OT1}
2011 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2012 \setfont\smallersl\slshape{8}{1000}{OT1}
2013 \setfont\smallersf\sfshape{8}{1000}{OT1}
2014 \setfont\smallersc\scshape{10}{800}{OT1}
2015 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2016 \font\smalleri=cmmi8
2017 \font\smallersy=cmsy8
2018 \def\smallerecsize{0800}
2019
2020 % Fonts for title page (20.4pt):
2021 \def\titlenominalsize{20pt}
2022 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2023 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2024 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2025 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2026 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2027 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2028 \let\titlebf=\titlerm
2029 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2030 \font\titlei=cmmi12 scaled \magstep3
2031 \font\titlesy=cmsy10 scaled \magstep4
2032 \def\titleecsize{2074}
2033
2034 % Chapter (and unnumbered) fonts (17.28pt).
2035 \def\chapnominalsize{17pt}
2036 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2037 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2038 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2039 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2040 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2041 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2042 \let\chapbf=\chaprm
2043 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2044 \font\chapi=cmmi12 scaled \magstep2
2045 \font\chapsy=cmsy10 scaled \magstep3
2046 \def\chapecsize{1728}
2047
2048 % Section fonts (14.4pt).
2049 \def\secnominalsize{14pt}
2050 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2051 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2052 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2053 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2054 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2055 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2056 \let\secbf\secrm
2057 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2058 \font\seci=cmmi12 scaled \magstep1
2059 \font\secsy=cmsy10 scaled \magstep2
2060 \def\sececsize{1440}
2061
2062 % Subsection fonts (13.15pt).
2063 \def\ssecnominalsize{13pt}
2064 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2065 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2066 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2067 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2068 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2069 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2070 \let\ssecbf\ssecrm
2071 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2072 \font\sseci=cmmi12 scaled \magstephalf
2073 \font\ssecsy=cmsy10 scaled 1315
2074 \def\ssececsize{1200}
2075
2076 % Reduced fonts for @acro in text (10pt).
2077 \def\reducednominalsize{10pt}
2078 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2079 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2080 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2081 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2082 \setfont\reducedsl\slshape{10}{1000}{OT1}
2083 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2084 \setfont\reducedsc\scshape{10}{1000}{OT1}
2085 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2086 \font\reducedi=cmmi10
2087 \font\reducedsy=cmsy10
2088 \def\reducedecsize{1000}
2089
2090 % reset the current fonts
2091 \textfonts
2092 \rm
2093 } % end of 11pt text font size definitions
2094
2095
2096 % Definitions to make the main text be 10pt Computer Modern, with
2097 % section, chapter, etc., sizes following suit.  This is for the GNU
2098 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
2099 % future.  Used with @smallbook, which sets the leading to 12pt.
2100
2101 \def\definetextfontsizex{%
2102 % Text fonts (10pt).
2103 \def\textnominalsize{10pt}
2104 \edef\mainmagstep{1000}
2105 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2106 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2107 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2108 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2109 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2110 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2111 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2112 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2113 \font\texti=cmmi10 scaled \mainmagstep
2114 \font\textsy=cmsy10 scaled \mainmagstep
2115 \def\textecsize{1000}
2116
2117 % A few fonts for @defun names and args.
2118 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2119 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2120 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2121 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2122
2123 % Fonts for indices, footnotes, small examples (9pt).
2124 \def\smallnominalsize{9pt}
2125 \setfont\smallrm\rmshape{9}{1000}{OT1}
2126 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2127 \setfont\smallbf\bfshape{10}{900}{OT1}
2128 \setfont\smallit\itshape{9}{1000}{OT1IT}
2129 \setfont\smallsl\slshape{9}{1000}{OT1}
2130 \setfont\smallsf\sfshape{9}{1000}{OT1}
2131 \setfont\smallsc\scshape{10}{900}{OT1}
2132 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2133 \font\smalli=cmmi9
2134 \font\smallsy=cmsy9
2135 \def\smallecsize{0900}
2136
2137 % Fonts for small examples (8pt).
2138 \def\smallernominalsize{8pt}
2139 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2140 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2141 \setfont\smallerbf\bfshape{10}{800}{OT1}
2142 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2143 \setfont\smallersl\slshape{8}{1000}{OT1}
2144 \setfont\smallersf\sfshape{8}{1000}{OT1}
2145 \setfont\smallersc\scshape{10}{800}{OT1}
2146 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2147 \font\smalleri=cmmi8
2148 \font\smallersy=cmsy8
2149 \def\smallerecsize{0800}
2150
2151 % Fonts for title page (20.4pt):
2152 \def\titlenominalsize{20pt}
2153 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2154 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2155 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2156 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2157 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2158 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2159 \let\titlebf=\titlerm
2160 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2161 \font\titlei=cmmi12 scaled \magstep3
2162 \font\titlesy=cmsy10 scaled \magstep4
2163 \def\titleecsize{2074}
2164
2165 % Chapter fonts (14.4pt).
2166 \def\chapnominalsize{14pt}
2167 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2168 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2169 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2170 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2171 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2172 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2173 \let\chapbf\chaprm
2174 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2175 \font\chapi=cmmi12 scaled \magstep1
2176 \font\chapsy=cmsy10 scaled \magstep2
2177 \def\chapecsize{1440}
2178
2179 % Section fonts (12pt).
2180 \def\secnominalsize{12pt}
2181 \setfont\secrm\rmbshape{12}{1000}{OT1}
2182 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2183 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2184 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2185 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2186 \setfont\secsf\sfbshape{12}{1000}{OT1}
2187 \let\secbf\secrm
2188 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2189 \font\seci=cmmi12 
2190 \font\secsy=cmsy10 scaled \magstep1
2191 \def\sececsize{1200}
2192
2193 % Subsection fonts (10pt).
2194 \def\ssecnominalsize{10pt}
2195 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2196 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2197 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2198 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2199 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2200 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2201 \let\ssecbf\ssecrm
2202 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2203 \font\sseci=cmmi10
2204 \font\ssecsy=cmsy10
2205 \def\ssececsize{1000}
2206
2207 % Reduced fonts for @acro in text (9pt).
2208 \def\reducednominalsize{9pt}
2209 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2210 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2211 \setfont\reducedbf\bfshape{10}{900}{OT1}
2212 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2213 \setfont\reducedsl\slshape{9}{1000}{OT1}
2214 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2215 \setfont\reducedsc\scshape{10}{900}{OT1}
2216 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2217 \font\reducedi=cmmi9
2218 \font\reducedsy=cmsy9
2219 \def\reducedecsize{0900}
2220
2221 % reduce space between paragraphs
2222 \divide\parskip by 2
2223
2224 % reset the current fonts
2225 \textfonts
2226 \rm
2227 } % end of 10pt text font size definitions
2228
2229
2230 % We provide the user-level command
2231 %   @fonttextsize 10
2232 % (or 11) to redefine the text font size.  pt is assumed.
2233
2234 \def\xword{10}
2235 \def\xiword{11}
2236 %
2237 \parseargdef\fonttextsize{%
2238   \def\textsizearg{#1}%
2239   \wlog{doing @fonttextsize \textsizearg}%
2240   %
2241   % Set \globaldefs so that documents can use this inside @tex, since
2242   % makeinfo 4.8 does not support it, but we need it nonetheless.
2243   % 
2244  \begingroup \globaldefs=1
2245   \ifx\textsizearg\xword \definetextfontsizex
2246   \else \ifx\textsizearg\xiword \definetextfontsizexi
2247   \else
2248     \errhelp=\EMsimple
2249     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2250   \fi\fi
2251  \endgroup
2252 }
2253
2254
2255 % In order for the font changes to affect most math symbols and letters,
2256 % we have to define the \textfont of the standard families.  Since
2257 % texinfo doesn't allow for producing subscripts and superscripts except
2258 % in the main text, we don't bother to reset \scriptfont and
2259 % \scriptscriptfont (which would also require loading a lot more fonts).
2260 %
2261 \def\resetmathfonts{%
2262   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2263   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2264   \textfont\ttfam=\tentt \textfont\sffam=\tensf
2265 }
2266
2267 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2268 % of just \STYLE.  We do this because \STYLE needs to also set the
2269 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
2270 % \tenSTYLE to set the current font.
2271 %
2272 % Each font-changing command also sets the names \lsize (one size lower)
2273 % and \lllsize (three sizes lower).  These relative commands are used in
2274 % the LaTeX logo and acronyms.
2275 %
2276 % This all needs generalizing, badly.
2277 %
2278 \def\textfonts{%
2279   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2280   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2281   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2282   \let\tenttsl=\textttsl
2283   \def\curfontsize{text}%
2284   \def\lsize{reduced}\def\lllsize{smaller}%
2285   \resetmathfonts \setleading{\textleading}}
2286 \def\titlefonts{%
2287   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2288   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2289   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2290   \let\tenttsl=\titlettsl
2291   \def\curfontsize{title}%
2292   \def\lsize{chap}\def\lllsize{subsec}%
2293   \resetmathfonts \setleading{25pt}}
2294 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2295 \def\chapfonts{%
2296   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2297   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2298   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2299   \let\tenttsl=\chapttsl
2300   \def\curfontsize{chap}%
2301   \def\lsize{sec}\def\lllsize{text}%
2302   \resetmathfonts \setleading{19pt}}
2303 \def\secfonts{%
2304   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2305   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2306   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2307   \let\tenttsl=\secttsl
2308   \def\curfontsize{sec}%
2309   \def\lsize{subsec}\def\lllsize{reduced}%
2310   \resetmathfonts \setleading{16pt}}
2311 \def\subsecfonts{%
2312   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2313   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2314   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2315   \let\tenttsl=\ssecttsl
2316   \def\curfontsize{ssec}%
2317   \def\lsize{text}\def\lllsize{small}%
2318   \resetmathfonts \setleading{15pt}}
2319 \let\subsubsecfonts = \subsecfonts
2320 \def\reducedfonts{%
2321   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2322   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2323   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2324   \let\tenttsl=\reducedttsl
2325   \def\curfontsize{reduced}%
2326   \def\lsize{small}\def\lllsize{smaller}%
2327   \resetmathfonts \setleading{10.5pt}}
2328 \def\smallfonts{%
2329   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2330   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2331   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2332   \let\tenttsl=\smallttsl
2333   \def\curfontsize{small}%
2334   \def\lsize{smaller}\def\lllsize{smaller}%
2335   \resetmathfonts \setleading{10.5pt}}
2336 \def\smallerfonts{%
2337   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2338   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2339   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2340   \let\tenttsl=\smallerttsl
2341   \def\curfontsize{smaller}%
2342   \def\lsize{smaller}\def\lllsize{smaller}%
2343   \resetmathfonts \setleading{9.5pt}}
2344
2345 % Set the fonts to use with the @small... environments.
2346 \let\smallexamplefonts = \smallfonts
2347
2348 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
2349 % can fit this many characters:
2350 %   8.5x11=86   smallbook=72  a4=90  a5=69
2351 % If we use \scriptfonts (8pt), then we can fit this many characters:
2352 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
2353 % For me, subjectively, the few extra characters that fit aren't worth
2354 % the additional smallness of 8pt.  So I'm making the default 9pt.
2355 %
2356 % By the way, for comparison, here's what fits with @example (10pt):
2357 %   8.5x11=71  smallbook=60  a4=75  a5=58
2358 %
2359 % I wish the USA used A4 paper.
2360 % --karl, 24jan03.
2361
2362
2363 % Set up the default fonts, so we can use them for creating boxes.
2364 %
2365 \definetextfontsizexi
2366
2367 % Define these so they can be easily changed for other fonts.
2368 \def\angleleft{$\langle$}
2369 \def\angleright{$\rangle$}
2370
2371 % Count depth in font-changes, for error checks
2372 \newcount\fontdepth \fontdepth=0
2373
2374 % Fonts for short table of contents.
2375 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2376 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1}  % no cmb12
2377 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2378 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2379
2380 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2381 %% serif) and @ii for TeX italic
2382
2383 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2384 % unless the following character is such as not to need one.
2385 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2386                     \ptexslash\fi\fi\fi}
2387 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2388 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2389
2390 % like \smartslanted except unconditionally uses \ttsl.
2391 % @var is set to this for defun arguments.
2392 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2393
2394 % like \smartslanted except unconditionally use \sl.  We never want
2395 % ttsl for book titles, do we?
2396 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2397
2398 \let\i=\smartitalic
2399 \let\slanted=\smartslanted
2400 \let\var=\smartslanted
2401 \let\dfn=\smartslanted
2402 \let\emph=\smartitalic
2403
2404 % @b, explicit bold.
2405 \def\b#1{{\bf #1}}
2406 \let\strong=\b
2407
2408 % @sansserif, explicit sans.
2409 \def\sansserif#1{{\sf #1}}
2410
2411 % We can't just use \exhyphenpenalty, because that only has effect at
2412 % the end of a paragraph.  Restore normal hyphenation at the end of the
2413 % group within which \nohyphenation is presumably called.
2414 %
2415 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
2416 \def\restorehyphenation{\hyphenchar\font = `- }
2417
2418 % Set sfcode to normal for the chars that usually have another value.
2419 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2420 % sometimes \x has an active definition that messes things up.
2421 %
2422 \catcode`@=11
2423   \def\plainfrenchspacing{%
2424     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2425     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2426     \def\endofsentencespacefactor{1000}% for @. and friends
2427   }
2428   \def\plainnonfrenchspacing{%
2429     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2430     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2431     \def\endofsentencespacefactor{3000}% for @. and friends
2432   }
2433 \catcode`@=\other
2434 \def\endofsentencespacefactor{3000}% default
2435
2436 \def\t#1{%
2437   {\tt \rawbackslash \plainfrenchspacing #1}%
2438   \null
2439 }
2440 \def\samp#1{`\tclose{#1}'\null}
2441 \setfont\keyrm\rmshape{8}{1000}{OT1}
2442 \font\keysy=cmsy9
2443 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2444   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2445     \vbox{\hrule\kern-0.4pt
2446      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2447     \kern-0.4pt\hrule}%
2448   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2449 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2450 % The old definition, with no lozenge:
2451 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2452 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2453
2454 % @file, @option are the same as @samp.
2455 \let\file=\samp
2456 \let\option=\samp
2457
2458 % @code is a modification of @t,
2459 % which makes spaces the same size as normal in the surrounding text.
2460 \def\tclose#1{%
2461   {%
2462     % Change normal interword space to be same as for the current font.
2463     \spaceskip = \fontdimen2\font
2464     %
2465     % Switch to typewriter.
2466     \tt
2467     %
2468     % But `\ ' produces the large typewriter interword space.
2469     \def\ {{\spaceskip = 0pt{} }}%
2470     %
2471     % Turn off hyphenation.
2472     \nohyphenation
2473     %
2474     \rawbackslash
2475     \plainfrenchspacing
2476     #1%
2477   }%
2478   \null
2479 }
2480
2481 % We *must* turn on hyphenation at `-' and `_' in @code.
2482 % Otherwise, it is too hard to avoid overfull hboxes
2483 % in the Emacs manual, the Library manual, etc.
2484
2485 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2486 % both hyphenation at - and hyphenation within words.
2487 % We must therefore turn them both off (\tclose does that)
2488 % and arrange explicitly to hyphenate at a dash.
2489 %  -- rms.
2490 {
2491   \catcode`\-=\active \catcode`\_=\active
2492   \catcode`\'=\active \catcode`\`=\active
2493   \global\let'=\rq \global\let`=\lq  % default definitions
2494   %
2495   \global\def\code{\begingroup
2496     \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2497     \let'\codequoteright \let`\codequoteleft
2498     %
2499     \catcode\dashChar=\active  \catcode\underChar=\active
2500     \ifallowcodebreaks
2501      \let-\codedash
2502      \let_\codeunder
2503     \else
2504      \let-\realdash
2505      \let_\realunder
2506     \fi
2507     \codex
2508   }
2509 }
2510
2511 \def\realdash{-}
2512 \def\codedash{-\discretionary{}{}{}}
2513 \def\codeunder{%
2514   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2515   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2516   % will therefore expand the active definition of _, which is us
2517   % (inside @code that is), therefore an endless loop.
2518   \ifusingtt{\ifmmode
2519                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2520              \else\normalunderscore \fi
2521              \discretionary{}{}{}}%
2522             {\_}%
2523 }
2524 \def\codex #1{\tclose{#1}\endgroup}
2525
2526 % An additional complication: the above will allow breaks after, e.g.,
2527 % each of the four underscores in __typeof__.  This is undesirable in
2528 % some manuals, especially if they don't have long identifiers in
2529 % general.  @allowcodebreaks provides a way to control this.
2530
2531 \newif\ifallowcodebreaks  \allowcodebreakstrue
2532
2533 \def\keywordtrue{true}
2534 \def\keywordfalse{false}
2535
2536 \parseargdef\allowcodebreaks{%
2537   \def\txiarg{#1}%
2538   \ifx\txiarg\keywordtrue
2539     \allowcodebreakstrue
2540   \else\ifx\txiarg\keywordfalse
2541     \allowcodebreaksfalse
2542   \else
2543     \errhelp = \EMsimple
2544     \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2545   \fi\fi
2546 }
2547
2548 % @kbd is like @code, except that if the argument is just one @key command,
2549 % then @kbd has no effect.
2550
2551 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2552 %   `example' (@kbd uses ttsl only inside of @example and friends),
2553 %   or `code' (@kbd uses normal tty font always).
2554 \parseargdef\kbdinputstyle{%
2555   \def\txiarg{#1}%
2556   \ifx\txiarg\worddistinct
2557     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2558   \else\ifx\txiarg\wordexample
2559     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2560   \else\ifx\txiarg\wordcode
2561     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2562   \else
2563     \errhelp = \EMsimple
2564     \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2565   \fi\fi\fi
2566 }
2567 \def\worddistinct{distinct}
2568 \def\wordexample{example}
2569 \def\wordcode{code}
2570
2571 % Default is `distinct.'
2572 \kbdinputstyle distinct
2573
2574 \def\xkey{\key}
2575 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2576 \ifx\one\xkey\ifx\threex\three \key{#2}%
2577 \else{\tclose{\kbdfont\look}}\fi
2578 \else{\tclose{\kbdfont\look}}\fi}
2579
2580 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2581 \let\indicateurl=\code
2582 \let\env=\code
2583 \let\command=\code
2584
2585 % @clicksequence{File @click{} Open ...}
2586 \def\clicksequence#1{\begingroup #1\endgroup}
2587
2588 % @clickstyle @arrow   (by default)
2589 \parseargdef\clickstyle{\def\click{#1}}
2590 \def\click{\arrow}
2591
2592 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2593 % second argument specifying the text to display and an optional third
2594 % arg as text to display instead of (rather than in addition to) the url
2595 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
2596 % a hypertex \special here.
2597 %
2598 \def\uref#1{\douref #1,,,\finish}
2599 \def\douref#1,#2,#3,#4\finish{\begingroup
2600   \unsepspaces
2601   \pdfurl{#1}%
2602   \setbox0 = \hbox{\ignorespaces #3}%
2603   \ifdim\wd0 > 0pt
2604     \unhbox0 % third arg given, show only that
2605   \else
2606     \setbox0 = \hbox{\ignorespaces #2}%
2607     \ifdim\wd0 > 0pt
2608       \ifpdf
2609         \unhbox0             % PDF: 2nd arg given, show only it
2610       \else
2611         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2612       \fi
2613     \else
2614       \code{#1}% only url given, so show it
2615     \fi
2616   \fi
2617   \endlink
2618 \endgroup}
2619
2620 % @url synonym for @uref, since that's how everyone uses it.
2621 %
2622 \let\url=\uref
2623
2624 % rms does not like angle brackets --karl, 17may97.
2625 % So now @email is just like @uref, unless we are pdf.
2626 %
2627 %\def\email#1{\angleleft{\tt #1}\angleright}
2628 \ifpdf
2629   \def\email#1{\doemail#1,,\finish}
2630   \def\doemail#1,#2,#3\finish{\begingroup
2631     \unsepspaces
2632     \pdfurl{mailto:#1}%
2633     \setbox0 = \hbox{\ignorespaces #2}%
2634     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2635     \endlink
2636   \endgroup}
2637 \else
2638   \let\email=\uref
2639 \fi
2640
2641 % Check if we are currently using a typewriter font.  Since all the
2642 % Computer Modern typewriter fonts have zero interword stretch (and
2643 % shrink), and it is reasonable to expect all typewriter fonts to have
2644 % this property, we can check that font parameter.
2645 %
2646 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2647
2648 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
2649 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2650 %
2651 \def\dmn#1{\thinspace #1}
2652
2653 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2654
2655 % @l was never documented to mean ``switch to the Lisp font'',
2656 % and it is not used as such in any manual I can find.  We need it for
2657 % Polish suppressed-l.  --karl, 22sep96.
2658 %\def\l#1{{\li #1}\null}
2659
2660 % Explicit font changes: @r, @sc, undocumented @ii.
2661 \def\r#1{{\rm #1}}              % roman font
2662 \def\sc#1{{\smallcaps#1}}       % smallcaps font
2663 \def\ii#1{{\it #1}}             % italic font
2664
2665 % @acronym for "FBI", "NATO", and the like.
2666 % We print this one point size smaller, since it's intended for
2667 % all-uppercase.
2668
2669 \def\acronym#1{\doacronym #1,,\finish}
2670 \def\doacronym#1,#2,#3\finish{%
2671   {\selectfonts\lsize #1}%
2672   \def\temp{#2}%
2673   \ifx\temp\empty \else
2674     \space ({\unsepspaces \ignorespaces \temp \unskip})%
2675   \fi
2676 }
2677
2678 % @abbr for "Comput. J." and the like.
2679 % No font change, but don't do end-of-sentence spacing.
2680
2681 \def\abbr#1{\doabbr #1,,\finish}
2682 \def\doabbr#1,#2,#3\finish{%
2683   {\plainfrenchspacing #1}%
2684   \def\temp{#2}%
2685   \ifx\temp\empty \else
2686     \space ({\unsepspaces \ignorespaces \temp \unskip})%
2687   \fi
2688 }
2689
2690 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2691 %
2692 \def\pounds{{\it\$}}
2693
2694 % @euro{} comes from a separate font, depending on the current style.
2695 % We use the free feym* fonts from the eurosym package by Henrik
2696 % Theiling, which support regular, slanted, bold and bold slanted (and
2697 % "outlined" (blackboard board, sort of) versions, which we don't need).
2698 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2699
2700 % Although only regular is the truly official Euro symbol, we ignore
2701 % that.  The Euro is designed to be slightly taller than the regular
2702 % font height.
2703
2704 % feymr - regular
2705 % feymo - slanted
2706 % feybr - bold
2707 % feybo - bold slanted
2708
2709 % There is no good (free) typewriter version, to my knowledge.
2710 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2711 % Hmm.
2712
2713 % Also doesn't work in math.  Do we need to do math with euro symbols?
2714 % Hope not.
2715
2716
2717 \def\euro{{\eurofont e}}
2718 \def\eurofont{%
2719   % We set the font at each command, rather than predefining it in
2720   % \textfonts and the other font-switching commands, so that
2721   % installations which never need the symbol don't have to have the
2722   % font installed.
2723   % 
2724   % There is only one designed size (nominal 10pt), so we always scale
2725   % that to the current nominal size.
2726   % 
2727   % By the way, simply using "at 1em" works for cmr10 and the like, but
2728   % does not work for cmbx10 and other extended/shrunken fonts.
2729   % 
2730   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2731   %
2732   \ifx\curfontstyle\bfstylename 
2733     % bold:
2734     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2735   \else 
2736     % regular:
2737     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2738   \fi
2739   \thiseurofont
2740 }
2741
2742 % Hacks for glyphs from the EC fonts similar to \euro.  We don't
2743 % use \let for the aliases, because sometimes we redefine the original
2744 % macro, and the alias should reflect the redefinition.
2745 \def\guillemetleft{{\ecfont \char"13}}
2746 \def\guillemotleft{\guillemetleft}
2747 \def\guillemetright{{\ecfont \char"14}}
2748 \def\guillemotright{\guillemetright}
2749 \def\guilsinglleft{{\ecfont \char"0E}}
2750 \def\guilsinglright{{\ecfont \char"0F}}
2751 \def\quotedblbase{{\ecfont \char"12}}
2752 \def\quotesinglbase{{\ecfont \char"0D}}
2753 %
2754 % This positioning is not perfect (see the ogonek LaTeX package), but
2755 % we have the precomposed glyphs for the most common cases.  We put the
2756 % tests to use those glyphs in the single \ogonek macro so we have fewer
2757 % dummy definitions to worry about for index entries, etc.
2758
2759 % ogonek is also used with other letters in Lithuanian (IOU), but using
2760 % the precomposed glyphs for those is not so easy since they aren't in
2761 % the same EC font.
2762 \def\ogonek#1{{%
2763   \def\temp{#1}%
2764   \ifx\temp\macrocharA\Aogonek
2765   \else\ifx\temp\macrochara\aogonek
2766   \else\ifx\temp\macrocharE\Eogonek
2767   \else\ifx\temp\macrochare\eogonek
2768   \else
2769     \ecfont \setbox0=\hbox{#1}%
2770     \ifdim\ht0=1ex\accent"0C #1%
2771     \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2772     \fi
2773   \fi\fi\fi\fi
2774   }%
2775 }
2776 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2777 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2778 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2779 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2780 %
2781 \def\ecfont{%
2782   % We can't distinguish serif/sans and italic/slanted, but this
2783   % is used for crude hacks anyway (like adding French and German
2784   % quotes to documents typeset with CM, where we lose kerning), so
2785   % hopefully nobody will notice/care.
2786   \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2787   \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2788   \ifx\curfontstyle\bfstylename
2789     % bold:
2790     \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2791   \else
2792     % regular:
2793     \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2794   \fi
2795   \thisecfont
2796 }
2797
2798 % @registeredsymbol - R in a circle.  The font for the R should really
2799 % be smaller yet, but lllsize is the best we can do for now.
2800 % Adapted from the plain.tex definition of \copyright.
2801 %
2802 \def\registeredsymbol{%
2803   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2804                \hfil\crcr\Orb}}%
2805     }$%
2806 }
2807
2808 % @textdegree - the normal degrees sign.
2809 %
2810 \def\textdegree{$^\circ$}
2811
2812 % Laurent Siebenmann reports \Orb undefined with:
2813 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
2814 % so we'll define it if necessary.
2815
2816 \ifx\Orb\undefined
2817 \def\Orb{\mathhexbox20D}
2818 \fi
2819
2820 % Quotes.
2821 \chardef\quotedblleft="5C
2822 \chardef\quotedblright=`\"
2823 \chardef\quoteleft=`\`
2824 \chardef\quoteright=`\'
2825
2826
2827 \message{page headings,}
2828
2829 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2830 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2831
2832 % First the title page.  Must do @settitle before @titlepage.
2833 \newif\ifseenauthor
2834 \newif\iffinishedtitlepage
2835
2836 % Do an implicit @contents or @shortcontents after @end titlepage if the
2837 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2838 %
2839 \newif\ifsetcontentsaftertitlepage
2840  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2841 \newif\ifsetshortcontentsaftertitlepage
2842  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2843
2844 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2845         \endgroup\page\hbox{}\page}
2846
2847 \envdef\titlepage{%
2848   % Open one extra group, as we want to close it in the middle of \Etitlepage.
2849   \begingroup
2850     \parindent=0pt \textfonts
2851     % Leave some space at the very top of the page.
2852     \vglue\titlepagetopglue
2853     % No rule at page bottom unless we print one at the top with @title.
2854     \finishedtitlepagetrue
2855     %
2856     % Most title ``pages'' are actually two pages long, with space
2857     % at the top of the second.  We don't want the ragged left on the second.
2858     \let\oldpage = \page
2859     \def\page{%
2860       \iffinishedtitlepage\else
2861          \finishtitlepage
2862       \fi
2863       \let\page = \oldpage
2864       \page
2865       \null
2866     }%
2867 }
2868
2869 \def\Etitlepage{%
2870     \iffinishedtitlepage\else
2871         \finishtitlepage
2872     \fi
2873     % It is important to do the page break before ending the group,
2874     % because the headline and footline are only empty inside the group.
2875     % If we use the new definition of \page, we always get a blank page
2876     % after the title page, which we certainly don't want.
2877     \oldpage
2878   \endgroup
2879   %
2880   % Need this before the \...aftertitlepage checks so that if they are
2881   % in effect the toc pages will come out with page numbers.
2882   \HEADINGSon
2883   %
2884   % If they want short, they certainly want long too.
2885   \ifsetshortcontentsaftertitlepage
2886     \shortcontents
2887     \contents
2888     \global\let\shortcontents = \relax
2889     \global\let\contents = \relax
2890   \fi
2891   %
2892   \ifsetcontentsaftertitlepage
2893     \contents
2894     \global\let\contents = \relax
2895     \global\let\shortcontents = \relax
2896   \fi
2897 }
2898
2899 \def\finishtitlepage{%
2900   \vskip4pt \hrule height 2pt width \hsize
2901   \vskip\titlepagebottomglue
2902   \finishedtitlepagetrue
2903 }
2904
2905 %%% Macros to be used within @titlepage:
2906
2907 \let\subtitlerm=\tenrm
2908 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2909
2910 \parseargdef\title{%
2911   \checkenv\titlepage
2912   \leftline{\titlefonts\rmisbold #1}
2913   % print a rule at the page bottom also.
2914   \finishedtitlepagefalse
2915   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2916 }
2917
2918 \parseargdef\subtitle{%
2919   \checkenv\titlepage
2920   {\subtitlefont \rightline{#1}}%
2921 }
2922
2923 % @author should come last, but may come many times.
2924 % It can also be used inside @quotation.
2925 %
2926 \parseargdef\author{%
2927   \def\temp{\quotation}%
2928   \ifx\thisenv\temp
2929     \def\quotationauthor{#1}% printed in \Equotation.
2930   \else
2931     \checkenv\titlepage
2932     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2933     {\secfonts\rmisbold \leftline{#1}}%
2934   \fi
2935 }
2936
2937
2938 %%% Set up page headings and footings.
2939
2940 \let\thispage=\folio
2941
2942 \newtoks\evenheadline    % headline on even pages
2943 \newtoks\oddheadline     % headline on odd pages
2944 \newtoks\evenfootline    % footline on even pages
2945 \newtoks\oddfootline     % footline on odd pages
2946
2947 % Now make TeX use those variables
2948 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2949                             \else \the\evenheadline \fi}}
2950 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2951                             \else \the\evenfootline \fi}\HEADINGShook}
2952 \let\HEADINGShook=\relax
2953
2954 % Commands to set those variables.
2955 % For example, this is what  @headings on  does
2956 % @evenheading @thistitle|@thispage|@thischapter
2957 % @oddheading @thischapter|@thispage|@thistitle
2958 % @evenfooting @thisfile||
2959 % @oddfooting ||@thisfile
2960
2961
2962 \def\evenheading{\parsearg\evenheadingxxx}
2963 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2964 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2965 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2966
2967 \def\oddheading{\parsearg\oddheadingxxx}
2968 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2969 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2970 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2971
2972 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2973
2974 \def\evenfooting{\parsearg\evenfootingxxx}
2975 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2976 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2977 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2978
2979 \def\oddfooting{\parsearg\oddfootingxxx}
2980 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2981 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2982   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2983   %
2984   % Leave some space for the footline.  Hopefully ok to assume
2985   % @evenfooting will not be used by itself.
2986   \global\advance\pageheight by -12pt
2987   \global\advance\vsize by -12pt
2988 }
2989
2990 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2991
2992 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
2993 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
2994 %
2995 % The same set of arguments for:
2996 %
2997 % @oddheadingmarks
2998 % @evenfootingmarks
2999 % @oddfootingmarks
3000 % @everyheadingmarks
3001 % @everyfootingmarks
3002
3003 \def\evenheadingmarks{\headingmarks{even}{heading}}
3004 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3005 \def\evenfootingmarks{\headingmarks{even}{footing}}
3006 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3007 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3008                           \headingmarks{odd}{heading}{#1} }
3009 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3010                           \headingmarks{odd}{footing}{#1} }
3011 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3012 \def\headingmarks#1#2#3 {%
3013   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3014   \global\expandafter\let\csname get#1#2marks\endcsname \temp
3015 }
3016
3017 \everyheadingmarks bottom
3018 \everyfootingmarks bottom
3019
3020 % @headings double      turns headings on for double-sided printing.
3021 % @headings single      turns headings on for single-sided printing.
3022 % @headings off         turns them off.
3023 % @headings on          same as @headings double, retained for compatibility.
3024 % @headings after       turns on double-sided headings after this page.
3025 % @headings doubleafter turns on double-sided headings after this page.
3026 % @headings singleafter turns on single-sided headings after this page.
3027 % By default, they are off at the start of a document,
3028 % and turned `on' after @end titlepage.
3029
3030 \def\headings #1 {\csname HEADINGS#1\endcsname}
3031
3032 \def\HEADINGSoff{%
3033 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3034 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3035 \HEADINGSoff
3036 % When we turn headings on, set the page number to 1.
3037 % For double-sided printing, put current file name in lower left corner,
3038 % chapter name on inside top of right hand pages, document
3039 % title on inside top of left hand pages, and page numbers on outside top
3040 % edge of all pages.
3041 \def\HEADINGSdouble{%
3042 \global\pageno=1
3043 \global\evenfootline={\hfil}
3044 \global\oddfootline={\hfil}
3045 \global\evenheadline={\line{\folio\hfil\thistitle}}
3046 \global\oddheadline={\line{\thischapter\hfil\folio}}
3047 \global\let\contentsalignmacro = \chapoddpage
3048 }
3049 \let\contentsalignmacro = \chappager
3050
3051 % For single-sided printing, chapter title goes across top left of page,
3052 % page number on top right.
3053 \def\HEADINGSsingle{%
3054 \global\pageno=1
3055 \global\evenfootline={\hfil}
3056 \global\oddfootline={\hfil}
3057 \global\evenheadline={\line{\thischapter\hfil\folio}}
3058 \global\oddheadline={\line{\thischapter\hfil\folio}}
3059 \global\let\contentsalignmacro = \chappager
3060 }
3061 \def\HEADINGSon{\HEADINGSdouble}
3062
3063 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3064 \let\HEADINGSdoubleafter=\HEADINGSafter
3065 \def\HEADINGSdoublex{%
3066 \global\evenfootline={\hfil}
3067 \global\oddfootline={\hfil}
3068 \global\evenheadline={\line{\folio\hfil\thistitle}}
3069 \global\oddheadline={\line{\thischapter\hfil\folio}}
3070 \global\let\contentsalignmacro = \chapoddpage
3071 }
3072
3073 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3074 \def\HEADINGSsinglex{%
3075 \global\evenfootline={\hfil}
3076 \global\oddfootline={\hfil}
3077 \global\evenheadline={\line{\thischapter\hfil\folio}}
3078 \global\oddheadline={\line{\thischapter\hfil\folio}}
3079 \global\let\contentsalignmacro = \chappager
3080 }
3081
3082 % Subroutines used in generating headings
3083 % This produces Day Month Year style of output.
3084 % Only define if not already defined, in case a txi-??.tex file has set
3085 % up a different format (e.g., txi-cs.tex does this).
3086 \ifx\today\undefined
3087 \def\today{%
3088   \number\day\space
3089   \ifcase\month
3090   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3091   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3092   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3093   \fi
3094   \space\number\year}
3095 \fi
3096
3097 % @settitle line...  specifies the title of the document, for headings.
3098 % It generates no output of its own.
3099 \def\thistitle{\putwordNoTitle}
3100 \def\settitle{\parsearg{\gdef\thistitle}}
3101
3102
3103 \message{tables,}
3104 % Tables -- @table, @ftable, @vtable, @item(x).
3105
3106 % default indentation of table text
3107 \newdimen\tableindent \tableindent=.8in
3108 % default indentation of @itemize and @enumerate text
3109 \newdimen\itemindent  \itemindent=.3in
3110 % margin between end of table item and start of table text.
3111 \newdimen\itemmargin  \itemmargin=.1in
3112
3113 % used internally for \itemindent minus \itemmargin
3114 \newdimen\itemmax
3115
3116 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3117 % these defs.
3118 % They also define \itemindex
3119 % to index the item name in whatever manner is desired (perhaps none).
3120
3121 \newif\ifitemxneedsnegativevskip
3122
3123 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3124
3125 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3126 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3127
3128 \def\itemzzz #1{\begingroup %
3129   \advance\hsize by -\rightskip
3130   \advance\hsize by -\tableindent
3131   \setbox0=\hbox{\itemindicate{#1}}%
3132   \itemindex{#1}%
3133   \nobreak % This prevents a break before @itemx.
3134   %
3135   % If the item text does not fit in the space we have, put it on a line
3136   % by itself, and do not allow a page break either before or after that
3137   % line.  We do not start a paragraph here because then if the next
3138   % command is, e.g., @kindex, the whatsit would get put into the
3139   % horizontal list on a line by itself, resulting in extra blank space.
3140   \ifdim \wd0>\itemmax
3141     %
3142     % Make this a paragraph so we get the \parskip glue and wrapping,
3143     % but leave it ragged-right.
3144     \begingroup
3145       \advance\leftskip by-\tableindent
3146       \advance\hsize by\tableindent
3147       \advance\rightskip by0pt plus1fil
3148       \leavevmode\unhbox0\par
3149     \endgroup
3150     %
3151     % We're going to be starting a paragraph, but we don't want the
3152     % \parskip glue -- logically it's part of the @item we just started.
3153     \nobreak \vskip-\parskip
3154     %
3155     % Stop a page break at the \parskip glue coming up.  However, if
3156     % what follows is an environment such as @example, there will be no
3157     % \parskip glue; then the negative vskip we just inserted would
3158     % cause the example and the item to crash together.  So we use this
3159     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3160     % \parskip glue after all.  Section titles are handled this way also.
3161     % 
3162     \penalty 10001
3163     \endgroup
3164     \itemxneedsnegativevskipfalse
3165   \else
3166     % The item text fits into the space.  Start a paragraph, so that the
3167     % following text (if any) will end up on the same line.
3168     \noindent
3169     % Do this with kerns and \unhbox so that if there is a footnote in
3170     % the item text, it can migrate to the main vertical list and
3171     % eventually be printed.
3172     \nobreak\kern-\tableindent
3173     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3174     \unhbox0
3175     \nobreak\kern\dimen0
3176     \endgroup
3177     \itemxneedsnegativevskiptrue
3178   \fi
3179 }
3180
3181 \def\item{\errmessage{@item while not in a list environment}}
3182 \def\itemx{\errmessage{@itemx while not in a list environment}}
3183
3184 % @table, @ftable, @vtable.
3185 \envdef\table{%
3186   \let\itemindex\gobble
3187   \tablecheck{table}%
3188 }
3189 \envdef\ftable{%
3190   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3191   \tablecheck{ftable}%
3192 }
3193 \envdef\vtable{%
3194   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3195   \tablecheck{vtable}%
3196 }
3197 \def\tablecheck#1{%
3198   \ifnum \the\catcode`\^^M=\active
3199     \endgroup
3200     \errmessage{This command won't work in this context; perhaps the problem is
3201       that we are \inenvironment\thisenv}%
3202     \def\next{\doignore{#1}}%
3203   \else
3204     \let\next\tablex
3205   \fi
3206   \next
3207 }
3208 \def\tablex#1{%
3209   \def\itemindicate{#1}%
3210   \parsearg\tabley
3211 }
3212 \def\tabley#1{%
3213   {%
3214     \makevalueexpandable
3215     \edef\temp{\noexpand\tablez #1\space\space\space}%
3216     \expandafter
3217   }\temp \endtablez
3218 }
3219 \def\tablez #1 #2 #3 #4\endtablez{%
3220   \aboveenvbreak
3221   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3222   \ifnum 0#2>0 \tableindent=#2\mil \fi
3223   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3224   \itemmax=\tableindent
3225   \advance \itemmax by -\itemmargin
3226   \advance \leftskip by \tableindent
3227   \exdentamount=\tableindent
3228   \parindent = 0pt
3229   \parskip = \smallskipamount
3230   \ifdim \parskip=0pt \parskip=2pt \fi
3231   \let\item = \internalBitem
3232   \let\itemx = \internalBitemx
3233 }
3234 \def\Etable{\endgraf\afterenvbreak}
3235 \let\Eftable\Etable
3236 \let\Evtable\Etable
3237 \let\Eitemize\Etable
3238 \let\Eenumerate\Etable
3239
3240 % This is the counter used by @enumerate, which is really @itemize
3241
3242 \newcount \itemno
3243
3244 \envdef\itemize{\parsearg\doitemize}
3245
3246 \def\doitemize#1{%
3247   \aboveenvbreak
3248   \itemmax=\itemindent
3249   \advance\itemmax by -\itemmargin
3250   \advance\leftskip by \itemindent
3251   \exdentamount=\itemindent
3252   \parindent=0pt
3253   \parskip=\smallskipamount
3254   \ifdim\parskip=0pt \parskip=2pt \fi
3255   \def\itemcontents{#1}%
3256   % @itemize with no arg is equivalent to @itemize @bullet.
3257   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3258   \let\item=\itemizeitem
3259 }
3260
3261 % Definition of @item while inside @itemize and @enumerate.
3262 %
3263 \def\itemizeitem{%
3264   \advance\itemno by 1  % for enumerations
3265   {\let\par=\endgraf \smallbreak}% reasonable place to break
3266   {%
3267    % If the document has an @itemize directly after a section title, a
3268    % \nobreak will be last on the list, and \sectionheading will have
3269    % done a \vskip-\parskip.  In that case, we don't want to zero
3270    % parskip, or the item text will crash with the heading.  On the
3271    % other hand, when there is normal text preceding the item (as there
3272    % usually is), we do want to zero parskip, or there would be too much
3273    % space.  In that case, we won't have a \nobreak before.  At least
3274    % that's the theory.
3275    \ifnum\lastpenalty<10000 \parskip=0in \fi
3276    \noindent
3277    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3278    \vadjust{\penalty 1200}}% not good to break after first line of item.
3279   \flushcr
3280 }
3281
3282 % \splitoff TOKENS\endmark defines \first to be the first token in
3283 % TOKENS, and \rest to be the remainder.
3284 %
3285 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3286
3287 % Allow an optional argument of an uppercase letter, lowercase letter,
3288 % or number, to specify the first label in the enumerated list.  No
3289 % argument is the same as `1'.
3290 %
3291 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
3292 \def\enumeratey #1 #2\endenumeratey{%
3293   % If we were given no argument, pretend we were given `1'.
3294   \def\thearg{#1}%
3295   \ifx\thearg\empty \def\thearg{1}\fi
3296   %
3297   % Detect if the argument is a single token.  If so, it might be a
3298   % letter.  Otherwise, the only valid thing it can be is a number.
3299   % (We will always have one token, because of the test we just made.
3300   % This is a good thing, since \splitoff doesn't work given nothing at
3301   % all -- the first parameter is undelimited.)
3302   \expandafter\splitoff\thearg\endmark
3303   \ifx\rest\empty
3304     % Only one token in the argument.  It could still be anything.
3305     % A ``lowercase letter'' is one whose \lccode is nonzero.
3306     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3307     %   not equal to itself.
3308     % Otherwise, we assume it's a number.
3309     %
3310     % We need the \relax at the end of the \ifnum lines to stop TeX from
3311     % continuing to look for a <number>.
3312     %
3313     \ifnum\lccode\expandafter`\thearg=0\relax
3314       \numericenumerate % a number (we hope)
3315     \else
3316       % It's a letter.
3317       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3318         \lowercaseenumerate % lowercase letter
3319       \else
3320         \uppercaseenumerate % uppercase letter
3321       \fi
3322     \fi
3323   \else
3324     % Multiple tokens in the argument.  We hope it's a number.
3325     \numericenumerate
3326   \fi
3327 }
3328
3329 % An @enumerate whose labels are integers.  The starting integer is
3330 % given in \thearg.
3331 %
3332 \def\numericenumerate{%
3333   \itemno = \thearg
3334   \startenumeration{\the\itemno}%
3335 }
3336
3337 % The starting (lowercase) letter is in \thearg.
3338 \def\lowercaseenumerate{%
3339   \itemno = \expandafter`\thearg
3340   \startenumeration{%
3341     % Be sure we're not beyond the end of the alphabet.
3342     \ifnum\itemno=0
3343       \errmessage{No more lowercase letters in @enumerate; get a bigger
3344                   alphabet}%
3345     \fi
3346     \char\lccode\itemno
3347   }%
3348 }
3349
3350 % The starting (uppercase) letter is in \thearg.
3351 \def\uppercaseenumerate{%
3352   \itemno = \expandafter`\thearg
3353   \startenumeration{%
3354     % Be sure we're not beyond the end of the alphabet.
3355     \ifnum\itemno=0
3356       \errmessage{No more uppercase letters in @enumerate; get a bigger
3357                   alphabet}
3358     \fi
3359     \char\uccode\itemno
3360   }%
3361 }
3362
3363 % Call \doitemize, adding a period to the first argument and supplying the
3364 % common last two arguments.  Also subtract one from the initial value in
3365 % \itemno, since @item increments \itemno.
3366 %
3367 \def\startenumeration#1{%
3368   \advance\itemno by -1
3369   \doitemize{#1.}\flushcr
3370 }
3371
3372 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3373 % to @enumerate.
3374 %
3375 \def\alphaenumerate{\enumerate{a}}
3376 \def\capsenumerate{\enumerate{A}}
3377 \def\Ealphaenumerate{\Eenumerate}
3378 \def\Ecapsenumerate{\Eenumerate}
3379
3380
3381 % @multitable macros
3382 % Amy Hendrickson, 8/18/94, 3/6/96
3383 %
3384 % @multitable ... @end multitable will make as many columns as desired.
3385 % Contents of each column will wrap at width given in preamble.  Width
3386 % can be specified either with sample text given in a template line,
3387 % or in percent of \hsize, the current width of text on page.
3388
3389 % Table can continue over pages but will only break between lines.
3390
3391 % To make preamble:
3392 %
3393 % Either define widths of columns in terms of percent of \hsize:
3394 %   @multitable @columnfractions .25 .3 .45
3395 %   @item ...
3396 %
3397 %   Numbers following @columnfractions are the percent of the total
3398 %   current hsize to be used for each column. You may use as many
3399 %   columns as desired.
3400
3401
3402 % Or use a template:
3403 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3404 %   @item ...
3405 %   using the widest term desired in each column.
3406
3407 % Each new table line starts with @item, each subsequent new column
3408 % starts with @tab. Empty columns may be produced by supplying @tab's
3409 % with nothing between them for as many times as empty columns are needed,
3410 % ie, @tab@tab@tab will produce two empty columns.
3411
3412 % @item, @tab do not need to be on their own lines, but it will not hurt
3413 % if they are.
3414
3415 % Sample multitable:
3416
3417 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3418 %   @item first col stuff @tab second col stuff @tab third col
3419 %   @item
3420 %   first col stuff
3421 %   @tab
3422 %   second col stuff
3423 %   @tab
3424 %   third col
3425 %   @item first col stuff @tab second col stuff
3426 %   @tab Many paragraphs of text may be used in any column.
3427 %
3428 %         They will wrap at the width determined by the template.
3429 %   @item@tab@tab This will be in third column.
3430 %   @end multitable
3431
3432 % Default dimensions may be reset by user.
3433 % @multitableparskip is vertical space between paragraphs in table.
3434 % @multitableparindent is paragraph indent in table.
3435 % @multitablecolmargin is horizontal space to be left between columns.
3436 % @multitablelinespace is space to leave between table items, baseline
3437 %                                                            to baseline.
3438 %   0pt means it depends on current normal line spacing.
3439 %
3440 \newskip\multitableparskip
3441 \newskip\multitableparindent
3442 \newdimen\multitablecolspace
3443 \newskip\multitablelinespace
3444 \multitableparskip=0pt
3445 \multitableparindent=6pt
3446 \multitablecolspace=12pt
3447 \multitablelinespace=0pt
3448
3449 % Macros used to set up halign preamble:
3450 %
3451 \let\endsetuptable\relax
3452 \def\xendsetuptable{\endsetuptable}
3453 \let\columnfractions\relax
3454 \def\xcolumnfractions{\columnfractions}
3455 \newif\ifsetpercent
3456
3457 % #1 is the @columnfraction, usually a decimal number like .5, but might
3458 % be just 1.  We just use it, whatever it is.
3459 %
3460 \def\pickupwholefraction#1 {%
3461   \global\advance\colcount by 1
3462   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3463   \setuptable
3464 }
3465
3466 \newcount\colcount
3467 \def\setuptable#1{%
3468   \def\firstarg{#1}%
3469   \ifx\firstarg\xendsetuptable
3470     \let\go = \relax
3471   \else
3472     \ifx\firstarg\xcolumnfractions
3473       \global\setpercenttrue
3474     \else
3475       \ifsetpercent
3476          \let\go\pickupwholefraction
3477       \else
3478          \global\advance\colcount by 1
3479          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3480                    % separator; typically that is always in the input, anyway.
3481          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3482       \fi
3483     \fi
3484     \ifx\go\pickupwholefraction
3485       % Put the argument back for the \pickupwholefraction call, so
3486       % we'll always have a period there to be parsed.
3487       \def\go{\pickupwholefraction#1}%
3488     \else
3489       \let\go = \setuptable
3490     \fi%
3491   \fi
3492   \go
3493 }
3494
3495 % multitable-only commands.
3496 %
3497 % @headitem starts a heading row, which we typeset in bold.
3498 % Assignments have to be global since we are inside the implicit group
3499 % of an alignment entry.  Note that \everycr resets \everytab.
3500 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3501 %
3502 % A \tab used to include \hskip1sp.  But then the space in a template
3503 % line is not enough.  That is bad.  So let's go back to just `&' until
3504 % we encounter the problem it was intended to solve again.
3505 %                                       --karl, nathan@acm.org, 20apr99.
3506 \def\tab{\checkenv\multitable &\the\everytab}%
3507
3508 % @multitable ... @end multitable definitions:
3509 %
3510 \newtoks\everytab  % insert after every tab.
3511 %
3512 \envdef\multitable{%
3513   \vskip\parskip
3514   \startsavinginserts
3515   %
3516   % @item within a multitable starts a normal row.
3517   % We use \def instead of \let so that if one of the multitable entries
3518   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3519   % \endtemplate) expanding \doitemize.
3520   \def\item{\crcr}%
3521   %
3522   \tolerance=9500
3523   \hbadness=9500
3524   \setmultitablespacing
3525   \parskip=\multitableparskip
3526   \parindent=\multitableparindent
3527   \overfullrule=0pt
3528   \global\colcount=0
3529   %
3530   \everycr = {%
3531     \noalign{%
3532       \global\everytab={}%
3533       \global\colcount=0 % Reset the column counter.
3534       % Check for saved footnotes, etc.
3535       \checkinserts
3536       % Keeps underfull box messages off when table breaks over pages.
3537       %\filbreak
3538         % Maybe so, but it also creates really weird page breaks when the
3539         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
3540         % problem manifests itself, so it can be fixed for real --karl.
3541     }%
3542   }%
3543   %
3544   \parsearg\domultitable
3545 }
3546 \def\domultitable#1{%
3547   % To parse everything between @multitable and @item:
3548   \setuptable#1 \endsetuptable
3549   %
3550   % This preamble sets up a generic column definition, which will
3551   % be used as many times as user calls for columns.
3552   % \vtop will set a single line and will also let text wrap and
3553   % continue for many paragraphs if desired.
3554   \halign\bgroup &%
3555     \global\advance\colcount by 1
3556     \multistrut
3557     \vtop{%
3558       % Use the current \colcount to find the correct column width:
3559       \hsize=\expandafter\csname col\the\colcount\endcsname
3560       %
3561       % In order to keep entries from bumping into each other
3562       % we will add a \leftskip of \multitablecolspace to all columns after
3563       % the first one.
3564       %
3565       % If a template has been used, we will add \multitablecolspace
3566       % to the width of each template entry.
3567       %
3568       % If the user has set preamble in terms of percent of \hsize we will
3569       % use that dimension as the width of the column, and the \leftskip
3570       % will keep entries from bumping into each other.  Table will start at
3571       % left margin and final column will justify at right margin.
3572       %
3573       % Make sure we don't inherit \rightskip from the outer environment.
3574       \rightskip=0pt
3575       \ifnum\colcount=1
3576         % The first column will be indented with the surrounding text.
3577         \advance\hsize by\leftskip
3578       \else
3579         \ifsetpercent \else
3580           % If user has not set preamble in terms of percent of \hsize
3581           % we will advance \hsize by \multitablecolspace.
3582           \advance\hsize by \multitablecolspace
3583         \fi
3584        % In either case we will make \leftskip=\multitablecolspace:
3585       \leftskip=\multitablecolspace
3586       \fi
3587       % Ignoring space at the beginning and end avoids an occasional spurious
3588       % blank line, when TeX decides to break the line at the space before the
3589       % box from the multistrut, so the strut ends up on a line by itself.
3590       % For example:
3591       % @multitable @columnfractions .11 .89
3592       % @item @code{#}
3593       % @tab Legal holiday which is valid in major parts of the whole country.
3594       % Is automatically provided with highlighting sequences respectively
3595       % marking characters.
3596       \noindent\ignorespaces##\unskip\multistrut
3597     }\cr
3598 }
3599 \def\Emultitable{%
3600   \crcr
3601   \egroup % end the \halign
3602   \global\setpercentfalse
3603 }
3604
3605 \def\setmultitablespacing{%
3606   \def\multistrut{\strut}% just use the standard line spacing
3607   %
3608   % Compute \multitablelinespace (if not defined by user) for use in
3609   % \multitableparskip calculation.  We used define \multistrut based on
3610   % this, but (ironically) that caused the spacing to be off.
3611   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3612 \ifdim\multitablelinespace=0pt
3613 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3614 \global\advance\multitablelinespace by-\ht0
3615 \fi
3616 %% Test to see if parskip is larger than space between lines of
3617 %% table. If not, do nothing.
3618 %%        If so, set to same dimension as multitablelinespace.
3619 \ifdim\multitableparskip>\multitablelinespace
3620 \global\multitableparskip=\multitablelinespace
3621 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3622                                       %% than skip between lines in the table.
3623 \fi%
3624 \ifdim\multitableparskip=0pt
3625 \global\multitableparskip=\multitablelinespace
3626 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3627                                       %% than skip between lines in the table.
3628 \fi}
3629
3630
3631 \message{conditionals,}
3632
3633 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3634 % @ifnotxml always succeed.  They currently do nothing; we don't
3635 % attempt to check whether the conditionals are properly nested.  But we
3636 % have to remember that they are conditionals, so that @end doesn't
3637 % attempt to close an environment group.
3638 %
3639 \def\makecond#1{%
3640   \expandafter\let\csname #1\endcsname = \relax
3641   \expandafter\let\csname iscond.#1\endcsname = 1
3642 }
3643 \makecond{iftex}
3644 \makecond{ifnotdocbook}
3645 \makecond{ifnothtml}
3646 \makecond{ifnotinfo}
3647 \makecond{ifnotplaintext}
3648 \makecond{ifnotxml}
3649
3650 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3651 %
3652 \def\direntry{\doignore{direntry}}
3653 \def\documentdescription{\doignore{documentdescription}}
3654 \def\docbook{\doignore{docbook}}
3655 \def\html{\doignore{html}}
3656 \def\ifdocbook{\doignore{ifdocbook}}
3657 \def\ifhtml{\doignore{ifhtml}}
3658 \def\ifinfo{\doignore{ifinfo}}
3659 \def\ifnottex{\doignore{ifnottex}}
3660 \def\ifplaintext{\doignore{ifplaintext}}
3661 \def\ifxml{\doignore{ifxml}}
3662 \def\ignore{\doignore{ignore}}
3663 \def\menu{\doignore{menu}}
3664 \def\xml{\doignore{xml}}
3665
3666 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3667 %
3668 % A count to remember the depth of nesting.
3669 \newcount\doignorecount
3670
3671 \def\doignore#1{\begingroup
3672   % Scan in ``verbatim'' mode:
3673   \obeylines
3674   \catcode`\@ = \other
3675   \catcode`\{ = \other
3676   \catcode`\} = \other
3677   %
3678   % Make sure that spaces turn into tokens that match what \doignoretext wants.
3679   \spaceisspace
3680   %
3681   % Count number of #1's that we've seen.
3682   \doignorecount = 0
3683   %
3684   % Swallow text until we reach the matching `@end #1'.
3685   \dodoignore{#1}%
3686 }
3687
3688 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3689   \obeylines %
3690   %
3691   \gdef\dodoignore#1{%
3692     % #1 contains the command name as a string, e.g., `ifinfo'.
3693     %
3694     % Define a command to find the next `@end #1'.
3695     \long\def\doignoretext##1^^M@end #1{%
3696       \doignoretextyyy##1^^M@#1\_STOP_}%
3697     %
3698     % And this command to find another #1 command, at the beginning of a
3699     % line.  (Otherwise, we would consider a line `@c @ifset', for
3700     % example, to count as an @ifset for nesting.)
3701     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3702     %
3703     % And now expand that command.
3704     \doignoretext ^^M%
3705   }%
3706 }
3707
3708 \def\doignoreyyy#1{%
3709   \def\temp{#1}%
3710   \ifx\temp\empty                       % Nothing found.
3711     \let\next\doignoretextzzz
3712   \else                                 % Found a nested condition, ...
3713     \advance\doignorecount by 1
3714     \let\next\doignoretextyyy           % ..., look for another.
3715     % If we're here, #1 ends with ^^M\ifinfo (for example).
3716   \fi
3717   \next #1% the token \_STOP_ is present just after this macro.
3718 }
3719
3720 % We have to swallow the remaining "\_STOP_".
3721 %
3722 \def\doignoretextzzz#1{%
3723   \ifnum\doignorecount = 0      % We have just found the outermost @end.
3724     \let\next\enddoignore
3725   \else                         % Still inside a nested condition.
3726     \advance\doignorecount by -1
3727     \let\next\doignoretext      % Look for the next @end.
3728   \fi
3729   \next
3730 }
3731
3732 % Finish off ignored text.
3733 { \obeylines%
3734   % Ignore anything after the last `@end #1'; this matters in verbatim
3735   % environments, where otherwise the newline after an ignored conditional
3736   % would result in a blank line in the output.
3737   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3738 }
3739
3740
3741 % @set VAR sets the variable VAR to an empty value.
3742 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3743 %
3744 % Since we want to separate VAR from REST-OF-LINE (which might be
3745 % empty), we can't just use \parsearg; we have to insert a space of our
3746 % own to delimit the rest of the line, and then take it out again if we
3747 % didn't need it.
3748 % We rely on the fact that \parsearg sets \catcode`\ =10.
3749 %
3750 \parseargdef\set{\setyyy#1 \endsetyyy}
3751 \def\setyyy#1 #2\endsetyyy{%
3752   {%
3753     \makevalueexpandable
3754     \def\temp{#2}%
3755     \edef\next{\gdef\makecsname{SET#1}}%
3756     \ifx\temp\empty
3757       \next{}%
3758     \else
3759       \setzzz#2\endsetzzz
3760     \fi
3761   }%
3762 }
3763 % Remove the trailing space \setxxx inserted.
3764 \def\setzzz#1 \endsetzzz{\next{#1}}
3765
3766 % @clear VAR clears (i.e., unsets) the variable VAR.
3767 %
3768 \parseargdef\clear{%
3769   {%
3770     \makevalueexpandable
3771     \global\expandafter\let\csname SET#1\endcsname=\relax
3772   }%
3773 }
3774
3775 % @value{foo} gets the text saved in variable foo.
3776 \def\value{\begingroup\makevalueexpandable\valuexxx}
3777 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3778 {
3779   \catcode`\- = \active \catcode`\_ = \active
3780   %
3781   \gdef\makevalueexpandable{%
3782     \let\value = \expandablevalue
3783     % We don't want these characters active, ...
3784     \catcode`\-=\other \catcode`\_=\other
3785     % ..., but we might end up with active ones in the argument if
3786     % we're called from @code, as @code{@value{foo-bar_}}, though.
3787     % So \let them to their normal equivalents.
3788     \let-\realdash \let_\normalunderscore
3789   }
3790 }
3791
3792 % We have this subroutine so that we can handle at least some @value's
3793 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3794 % The command has to be fully expandable (if the variable is set), since
3795 % the result winds up in the index file.  This means that if the
3796 % variable's value contains other Texinfo commands, it's almost certain
3797 % it will fail (although perhaps we could fix that with sufficient work
3798 % to do a one-level expansion on the result, instead of complete).
3799 %
3800 \def\expandablevalue#1{%
3801   \expandafter\ifx\csname SET#1\endcsname\relax
3802     {[No value for ``#1'']}%
3803     \message{Variable `#1', used in @value, is not set.}%
3804   \else
3805     \csname SET#1\endcsname
3806   \fi
3807 }
3808
3809 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3810 % with @set.
3811 %
3812 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3813 %
3814 \makecond{ifset}
3815 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3816 \def\doifset#1#2{%
3817   {%
3818     \makevalueexpandable
3819     \let\next=\empty
3820     \expandafter\ifx\csname SET#2\endcsname\relax
3821       #1% If not set, redefine \next.
3822     \fi
3823     \expandafter
3824   }\next
3825 }
3826 \def\ifsetfail{\doignore{ifset}}
3827
3828 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3829 % defined with @set, or has been undefined with @clear.
3830 %
3831 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3832 % above code: if the variable is not set, do nothing, if it is set,
3833 % then redefine \next to \ifclearfail.
3834 %
3835 \makecond{ifclear}
3836 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3837 \def\ifclearfail{\doignore{ifclear}}
3838
3839 % @dircategory CATEGORY  -- specify a category of the dir file
3840 % which this file should belong to.  Ignore this in TeX.
3841 \let\dircategory=\comment
3842
3843 % @defininfoenclose.
3844 \let\definfoenclose=\comment
3845
3846
3847 \message{indexing,}
3848 % Index generation facilities
3849
3850 % Define \newwrite to be identical to plain tex's \newwrite
3851 % except not \outer, so it can be used within macros and \if's.
3852 \edef\newwrite{\makecsname{ptexnewwrite}}
3853
3854 % \newindex {foo} defines an index named foo.
3855 % It automatically defines \fooindex such that
3856 % \fooindex ...rest of line... puts an entry in the index foo.
3857 % It also defines \fooindfile to be the number of the output channel for
3858 % the file that accumulates this index.  The file's extension is foo.
3859 % The name of an index should be no more than 2 characters long
3860 % for the sake of vms.
3861 %
3862 \def\newindex#1{%
3863   \iflinks
3864     \expandafter\newwrite \csname#1indfile\endcsname
3865     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3866   \fi
3867   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
3868     \noexpand\doindex{#1}}
3869 }
3870
3871 % @defindex foo  ==  \newindex{foo}
3872 %
3873 \def\defindex{\parsearg\newindex}
3874
3875 % Define @defcodeindex, like @defindex except put all entries in @code.
3876 %
3877 \def\defcodeindex{\parsearg\newcodeindex}
3878 %
3879 \def\newcodeindex#1{%
3880   \iflinks
3881     \expandafter\newwrite \csname#1indfile\endcsname
3882     \openout \csname#1indfile\endcsname \jobname.#1
3883   \fi
3884   \expandafter\xdef\csname#1index\endcsname{%
3885     \noexpand\docodeindex{#1}}%
3886 }
3887
3888
3889 % @synindex foo bar    makes index foo feed into index bar.
3890 % Do this instead of @defindex foo if you don't want it as a separate index.
3891 %
3892 % @syncodeindex foo bar   similar, but put all entries made for index foo
3893 % inside @code.
3894 %
3895 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3896 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3897
3898 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3899 % #3 the target index (bar).
3900 \def\dosynindex#1#2#3{%
3901   % Only do \closeout if we haven't already done it, else we'll end up
3902   % closing the target index.
3903   \expandafter \ifx\csname donesynindex#2\endcsname \relax
3904     % The \closeout helps reduce unnecessary open files; the limit on the
3905     % Acorn RISC OS is a mere 16 files.
3906     \expandafter\closeout\csname#2indfile\endcsname
3907     \expandafter\let\csname donesynindex#2\endcsname = 1
3908   \fi
3909   % redefine \fooindfile:
3910   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3911   \expandafter\let\csname#2indfile\endcsname=\temp
3912   % redefine \fooindex:
3913   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3914 }
3915
3916 % Define \doindex, the driver for all \fooindex macros.
3917 % Argument #1 is generated by the calling \fooindex macro,
3918 %  and it is "foo", the name of the index.
3919
3920 % \doindex just uses \parsearg; it calls \doind for the actual work.
3921 % This is because \doind is more useful to call from other macros.
3922
3923 % There is also \dosubind {index}{topic}{subtopic}
3924 % which makes an entry in a two-level index such as the operation index.
3925
3926 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3927 \def\singleindexer #1{\doind{\indexname}{#1}}
3928
3929 % like the previous two, but they put @code around the argument.
3930 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3931 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3932
3933 % Take care of Texinfo commands that can appear in an index entry.
3934 % Since there are some commands we want to expand, and others we don't,
3935 % we have to laboriously prevent expansion for those that we don't.
3936 %
3937 \def\indexdummies{%
3938   \escapechar = `\\     % use backslash in output files.
3939   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3940   \def\ {\realbackslash\space }%
3941   %
3942   % Need these in case \tex is in effect and \{ is a \delimiter again.
3943   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3944   % braces and backslashes are used only as delimiters.
3945   \let\{ = \mylbrace
3946   \let\} = \myrbrace
3947   %
3948   % I don't entirely understand this, but when an index entry is
3949   % generated from a macro call, the \endinput which \scanmacro inserts
3950   % causes processing to be prematurely terminated.  This is,
3951   % apparently, because \indexsorttmp is fully expanded, and \endinput
3952   % is an expandable command.  The redefinition below makes \endinput
3953   % disappear altogether for that purpose -- although logging shows that
3954   % processing continues to some further point.  On the other hand, it
3955   % seems \endinput does not hurt in the printed index arg, since that
3956   % is still getting written without apparent harm.
3957   % 
3958   % Sample source (mac-idx3.tex, reported by Graham Percival to
3959   % help-texinfo, 22may06):
3960   % @macro funindex {WORD}
3961   % @findex xyz
3962   % @end macro
3963   % ...
3964   % @funindex commtest
3965   % 
3966   % The above is not enough to reproduce the bug, but it gives the flavor.
3967   % 
3968   % Sample whatsit resulting:
3969   % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3970   % 
3971   % So:
3972   \let\endinput = \empty
3973   %
3974   % Do the redefinitions.
3975   \commondummies
3976 }
3977
3978 % For the aux and toc files, @ is the escape character.  So we want to
3979 % redefine everything using @ as the escape character (instead of
3980 % \realbackslash, still used for index files).  When everything uses @,
3981 % this will be simpler.
3982 %
3983 \def\atdummies{%
3984   \def\@{@@}%
3985   \def\ {@ }%
3986   \let\{ = \lbraceatcmd
3987   \let\} = \rbraceatcmd
3988   %
3989   % Do the redefinitions.
3990   \commondummies
3991   \otherbackslash
3992 }
3993
3994 % Called from \indexdummies and \atdummies.
3995 %
3996 \def\commondummies{%
3997   %
3998   % \definedummyword defines \#1 as \string\#1\space, thus effectively
3999   % preventing its expansion.  This is used only for control% words,
4000   % not control letters, because the \space would be incorrect for
4001   % control characters, but is needed to separate the control word
4002   % from whatever follows.
4003   %
4004   % For control letters, we have \definedummyletter, which omits the
4005   % space.
4006   %
4007   % These can be used both for control words that take an argument and
4008   % those that do not.  If it is followed by {arg} in the input, then
4009   % that will dutifully get written to the index (or wherever).
4010   %
4011   \def\definedummyword  ##1{\def##1{\string##1\space}}%
4012   \def\definedummyletter##1{\def##1{\string##1}}%
4013   \let\definedummyaccent\definedummyletter
4014   %
4015   \commondummiesnofonts
4016   %
4017   \definedummyletter\_%
4018   %
4019   % Non-English letters.
4020   \definedummyword\AA
4021   \definedummyword\AE
4022   \definedummyword\L
4023   \definedummyword\OE
4024   \definedummyword\O
4025   \definedummyword\aa
4026   \definedummyword\ae
4027   \definedummyword\l
4028   \definedummyword\oe
4029   \definedummyword\o
4030   \definedummyword\ss
4031   \definedummyword\exclamdown
4032   \definedummyword\questiondown
4033   \definedummyword\ordf
4034   \definedummyword\ordm
4035   %
4036   % Although these internal commands shouldn't show up, sometimes they do.
4037   \definedummyword\bf
4038   \definedummyword\gtr
4039   \definedummyword\hat
4040   \definedummyword\less
4041   \definedummyword\sf
4042   \definedummyword\sl
4043   \definedummyword\tclose
4044   \definedummyword\tt
4045   %
4046   \definedummyword\LaTeX
4047   \definedummyword\TeX
4048   %
4049   % Assorted special characters.
4050   \definedummyword\bullet
4051   \definedummyword\comma
4052   \definedummyword\copyright
4053   \definedummyword\registeredsymbol
4054   \definedummyword\dots
4055   \definedummyword\enddots
4056   \definedummyword\equiv
4057   \definedummyword\error
4058   \definedummyword\euro
4059   \definedummyword\guillemetleft
4060   \definedummyword\guillemetright
4061   \definedummyword\guilsinglleft
4062   \definedummyword\guilsinglright
4063   \definedummyword\expansion
4064   \definedummyword\minus
4065   \definedummyword\ogonek
4066   \definedummyword\pounds
4067   \definedummyword\point
4068   \definedummyword\print
4069   \definedummyword\quotedblbase
4070   \definedummyword\quotedblleft
4071   \definedummyword\quotedblright
4072   \definedummyword\quoteleft
4073   \definedummyword\quoteright
4074   \definedummyword\quotesinglbase
4075   \definedummyword\result
4076   \definedummyword\textdegree
4077   %
4078   % We want to disable all macros so that they are not expanded by \write.
4079   \macrolist
4080   %
4081   \normalturnoffactive
4082   %
4083   % Handle some cases of @value -- where it does not contain any
4084   % (non-fully-expandable) commands.
4085   \makevalueexpandable
4086 }
4087
4088 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4089 %
4090 \def\commondummiesnofonts{%
4091   % Control letters and accents.
4092   \definedummyletter\!%
4093   \definedummyaccent\"%
4094   \definedummyaccent\'%
4095   \definedummyletter\*%
4096   \definedummyaccent\,%
4097   \definedummyletter\.%
4098   \definedummyletter\/%
4099   \definedummyletter\:%
4100   \definedummyaccent\=%
4101   \definedummyletter\?%
4102   \definedummyaccent\^%
4103   \definedummyaccent\`%
4104   \definedummyaccent\~%
4105   \definedummyword\u
4106   \definedummyword\v
4107   \definedummyword\H
4108   \definedummyword\dotaccent
4109   \definedummyword\ogonek
4110   \definedummyword\ringaccent
4111   \definedummyword\tieaccent
4112   \definedummyword\ubaraccent
4113   \definedummyword\udotaccent
4114   \definedummyword\dotless
4115   %
4116   % Texinfo font commands.
4117   \definedummyword\b
4118   \definedummyword\i
4119   \definedummyword\r
4120   \definedummyword\sc
4121   \definedummyword\t
4122   %
4123   % Commands that take arguments.
4124   \definedummyword\acronym
4125   \definedummyword\cite
4126   \definedummyword\code
4127   \definedummyword\command
4128   \definedummyword\dfn
4129   \definedummyword\emph
4130   \definedummyword\env
4131   \definedummyword\file
4132   \definedummyword\kbd
4133   \definedummyword\key
4134   \definedummyword\math
4135   \definedummyword\option
4136   \definedummyword\pxref
4137   \definedummyword\ref
4138   \definedummyword\samp
4139   \definedummyword\strong
4140   \definedummyword\tie
4141   \definedummyword\uref
4142   \definedummyword\url
4143   \definedummyword\var
4144   \definedummyword\verb
4145   \definedummyword\w
4146   \definedummyword\xref
4147 }
4148
4149 % \indexnofonts is used when outputting the strings to sort the index
4150 % by, and when constructing control sequence names.  It eliminates all
4151 % control sequences and just writes whatever the best ASCII sort string
4152 % would be for a given command (usually its argument).
4153 %
4154 \def\indexnofonts{%
4155   % Accent commands should become @asis.
4156   \def\definedummyaccent##1{\let##1\asis}%
4157   % We can just ignore other control letters.
4158   \def\definedummyletter##1{\let##1\empty}%
4159   % Hopefully, all control words can become @asis.
4160   \let\definedummyword\definedummyaccent
4161   %
4162   \commondummiesnofonts
4163   %
4164   % Don't no-op \tt, since it isn't a user-level command
4165   % and is used in the definitions of the active chars like <, >, |, etc.
4166   % Likewise with the other plain tex font commands.
4167   %\let\tt=\asis
4168   %
4169   \def\ { }%
4170   \def\@{@}%
4171   % how to handle braces?
4172   \def\_{\normalunderscore}%
4173   %
4174   % Non-English letters.
4175   \def\AA{AA}%
4176   \def\AE{AE}%
4177   \def\L{L}%
4178   \def\OE{OE}%
4179   \def\O{O}%
4180   \def\aa{aa}%
4181   \def\ae{ae}%
4182   \def\l{l}%
4183   \def\oe{oe}%
4184   \def\o{o}%
4185   \def\ss{ss}%
4186   \def\exclamdown{!}%
4187   \def\questiondown{?}%
4188   \def\ordf{a}%
4189   \def\ordm{o}%
4190   %
4191   \def\LaTeX{LaTeX}%
4192   \def\TeX{TeX}%
4193   %
4194   % Assorted special characters.
4195   % (The following {} will end up in the sort string, but that's ok.)
4196   \def\bullet{bullet}%
4197   \def\comma{,}%
4198   \def\copyright{copyright}%
4199   \def\registeredsymbol{R}%
4200   \def\dots{...}%
4201   \def\enddots{...}%
4202   \def\equiv{==}%
4203   \def\error{error}%
4204   \def\euro{euro}%
4205   \def\guillemetleft{<<}%
4206   \def\guillemetright{>>}%
4207   \def\guilsinglleft{<}%
4208   \def\guilsinglright{>}%
4209   \def\expansion{==>}%
4210   \def\minus{-}%
4211   \def\pounds{pounds}%
4212   \def\point{.}%
4213   \def\print{-|}%
4214   \def\quotedblbase{"}%
4215   \def\quotedblleft{"}%
4216   \def\quotedblright{"}%
4217   \def\quoteleft{`}%
4218   \def\quoteright{'}%
4219   \def\quotesinglbase{,}%
4220   \def\result{=>}%
4221   \def\textdegree{degrees}%
4222   %
4223   % We need to get rid of all macros, leaving only the arguments (if present).
4224   % Of course this is not nearly correct, but it is the best we can do for now.
4225   % makeinfo does not expand macros in the argument to @deffn, which ends up
4226   % writing an index entry, and texindex isn't prepared for an index sort entry
4227   % that starts with \.
4228   % 
4229   % Since macro invocations are followed by braces, we can just redefine them
4230   % to take a single TeX argument.  The case of a macro invocation that
4231   % goes to end-of-line is not handled.
4232   % 
4233   \macrolist
4234 }
4235
4236 \let\indexbackslash=0  %overridden during \printindex.
4237 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4238
4239 % Most index entries go through here, but \dosubind is the general case.
4240 % #1 is the index name, #2 is the entry text.
4241 \def\doind#1#2{\dosubind{#1}{#2}{}}
4242
4243 % Workhorse for all \fooindexes.
4244 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4245 % empty if called from \doind, as we usually are (the main exception
4246 % is with most defuns, which call us directly).
4247 %
4248 \def\dosubind#1#2#3{%
4249   \iflinks
4250   {%
4251     % Store the main index entry text (including the third arg).
4252     \toks0 = {#2}%
4253     % If third arg is present, precede it with a space.
4254     \def\thirdarg{#3}%
4255     \ifx\thirdarg\empty \else
4256       \toks0 = \expandafter{\the\toks0 \space #3}%
4257     \fi
4258     %
4259     \edef\writeto{\csname#1indfile\endcsname}%
4260     %
4261     \safewhatsit\dosubindwrite
4262   }%
4263   \fi
4264 }
4265
4266 % Write the entry in \toks0 to the index file:
4267 %
4268 \def\dosubindwrite{%
4269   % Put the index entry in the margin if desired.
4270   \ifx\SETmarginindex\relax\else
4271     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4272   \fi
4273   %
4274   % Remember, we are within a group.
4275   \indexdummies % Must do this here, since \bf, etc expand at this stage
4276   \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4277       % so it will be output as is; and it will print as backslash.
4278   %
4279   % Process the index entry with all font commands turned off, to
4280   % get the string to sort by.
4281   {\indexnofonts
4282    \edef\temp{\the\toks0}% need full expansion
4283    \xdef\indexsorttmp{\temp}%
4284   }%
4285   %
4286   % Set up the complete index entry, with both the sort key and
4287   % the original text, including any font commands.  We write
4288   % three arguments to \entry to the .?? file (four in the
4289   % subentry case), texindex reduces to two when writing the .??s
4290   % sorted result.
4291   \edef\temp{%
4292     \write\writeto{%
4293       \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4294   }%
4295   \temp
4296 }
4297
4298 % Take care of unwanted page breaks/skips around a whatsit:
4299 %
4300 % If a skip is the last thing on the list now, preserve it
4301 % by backing up by \lastskip, doing the \write, then inserting
4302 % the skip again.  Otherwise, the whatsit generated by the
4303 % \write or \pdfdest will make \lastskip zero.  The result is that
4304 % sequences like this:
4305 % @end defun
4306 % @tindex whatever
4307 % @defun ...
4308 % will have extra space inserted, because the \medbreak in the
4309 % start of the @defun won't see the skip inserted by the @end of
4310 % the previous defun.
4311 %
4312 % But don't do any of this if we're not in vertical mode.  We
4313 % don't want to do a \vskip and prematurely end a paragraph.
4314 %
4315 % Avoid page breaks due to these extra skips, too.
4316 %
4317 % But wait, there is a catch there:
4318 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
4319 % sufficient for this purpose, as it ignores stretch and shrink parts
4320 % of the skip.  The only way seems to be to check the textual
4321 % representation of the skip.
4322 %
4323 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4324 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4325 %
4326 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4327 %
4328 \newskip\whatsitskip
4329 \newcount\whatsitpenalty
4330 %
4331 % ..., ready, GO:
4332 %
4333 \def\safewhatsit#1{%
4334 \ifhmode
4335   #1%
4336 \else
4337   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4338   \whatsitskip = \lastskip
4339   \edef\lastskipmacro{\the\lastskip}%
4340   \whatsitpenalty = \lastpenalty
4341   %
4342   % If \lastskip is nonzero, that means the last item was a
4343   % skip.  And since a skip is discardable, that means this
4344   % -\whatsitskip glue we're inserting is preceded by a
4345   % non-discardable item, therefore it is not a potential
4346   % breakpoint, therefore no \nobreak needed.
4347   \ifx\lastskipmacro\zeroskipmacro
4348   \else
4349     \vskip-\whatsitskip
4350   \fi
4351   %
4352   #1%
4353   %
4354   \ifx\lastskipmacro\zeroskipmacro
4355     % If \lastskip was zero, perhaps the last item was a penalty, and
4356     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
4357     % to re-insert the same penalty (values >10000 are used for various
4358     % signals); since we just inserted a non-discardable item, any
4359     % following glue (such as a \parskip) would be a breakpoint.  For example:
4360     % 
4361     %   @deffn deffn-whatever
4362     %   @vindex index-whatever
4363     %   Description.
4364     % would allow a break between the index-whatever whatsit
4365     % and the "Description." paragraph.
4366     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4367   \else
4368     % On the other hand, if we had a nonzero \lastskip,
4369     % this make-up glue would be preceded by a non-discardable item
4370     % (the whatsit from the \write), so we must insert a \nobreak.
4371     \nobreak\vskip\whatsitskip
4372   \fi
4373 \fi
4374 }
4375
4376 % The index entry written in the file actually looks like
4377 %  \entry {sortstring}{page}{topic}
4378 % or
4379 %  \entry {sortstring}{page}{topic}{subtopic}
4380 % The texindex program reads in these files and writes files
4381 % containing these kinds of lines:
4382 %  \initial {c}
4383 %     before the first topic whose initial is c
4384 %  \entry {topic}{pagelist}
4385 %     for a topic that is used without subtopics
4386 %  \primary {topic}
4387 %     for the beginning of a topic that is used with subtopics
4388 %  \secondary {subtopic}{pagelist}
4389 %     for each subtopic.
4390
4391 % Define the user-accessible indexing commands
4392 % @findex, @vindex, @kindex, @cindex.
4393
4394 \def\findex {\fnindex}
4395 \def\kindex {\kyindex}
4396 \def\cindex {\cpindex}
4397 \def\vindex {\vrindex}
4398 \def\tindex {\tpindex}
4399 \def\pindex {\pgindex}
4400
4401 \def\cindexsub {\begingroup\obeylines\cindexsub}
4402 {\obeylines %
4403 \gdef\cindexsub "#1" #2^^M{\endgroup %
4404 \dosubind{cp}{#2}{#1}}}
4405
4406 % Define the macros used in formatting output of the sorted index material.
4407
4408 % @printindex causes a particular index (the ??s file) to get printed.
4409 % It does not print any chapter heading (usually an @unnumbered).
4410 %
4411 \parseargdef\printindex{\begingroup
4412   \dobreak \chapheadingskip{10000}%
4413   %
4414   \smallfonts \rm
4415   \tolerance = 9500
4416   \plainfrenchspacing
4417   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4418   %
4419   % See if the index file exists and is nonempty.
4420   % Change catcode of @ here so that if the index file contains
4421   % \initial {@}
4422   % as its first line, TeX doesn't complain about mismatched braces
4423   % (because it thinks @} is a control sequence).
4424   \catcode`\@ = 11
4425   \openin 1 \jobname.#1s
4426   \ifeof 1
4427     % \enddoublecolumns gets confused if there is no text in the index,
4428     % and it loses the chapter title and the aux file entries for the
4429     % index.  The easiest way to prevent this problem is to make sure
4430     % there is some text.
4431     \putwordIndexNonexistent
4432   \else
4433     %
4434     % If the index file exists but is empty, then \openin leaves \ifeof
4435     % false.  We have to make TeX try to read something from the file, so
4436     % it can discover if there is anything in it.
4437     \read 1 to \temp
4438     \ifeof 1
4439       \putwordIndexIsEmpty
4440     \else
4441       % Index files are almost Texinfo source, but we use \ as the escape
4442       % character.  It would be better to use @, but that's too big a change
4443       % to make right now.
4444       \def\indexbackslash{\backslashcurfont}%
4445       \catcode`\\ = 0
4446       \escapechar = `\\
4447       \begindoublecolumns
4448       \input \jobname.#1s
4449       \enddoublecolumns
4450     \fi
4451   \fi
4452   \closein 1
4453 \endgroup}
4454
4455 % These macros are used by the sorted index file itself.
4456 % Change them to control the appearance of the index.
4457
4458 \def\initial#1{{%
4459   % Some minor font changes for the special characters.
4460   \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4461   %
4462   % Remove any glue we may have, we'll be inserting our own.
4463   \removelastskip
4464   %
4465   % We like breaks before the index initials, so insert a bonus.
4466   \nobreak
4467   \vskip 0pt plus 3\baselineskip
4468   \penalty 0
4469   \vskip 0pt plus -3\baselineskip
4470   %
4471   % Typeset the initial.  Making this add up to a whole number of
4472   % baselineskips increases the chance of the dots lining up from column
4473   % to column.  It still won't often be perfect, because of the stretch
4474   % we need before each entry, but it's better.
4475   %
4476   % No shrink because it confuses \balancecolumns.
4477   \vskip 1.67\baselineskip plus .5\baselineskip
4478   \leftline{\secbf #1}%
4479   % Do our best not to break after the initial.
4480   \nobreak
4481   \vskip .33\baselineskip plus .1\baselineskip
4482 }}
4483
4484 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4485 % then page number (#2) flushed to the right margin.  It is used for index
4486 % and table of contents entries.  The paragraph is indented by \leftskip.
4487 %
4488 % A straightforward implementation would start like this:
4489 %       \def\entry#1#2{...
4490 % But this freezes the catcodes in the argument, and can cause problems to
4491 % @code, which sets - active.  This problem was fixed by a kludge---
4492 % ``-'' was active throughout whole index, but this isn't really right.
4493 %
4494 % The right solution is to prevent \entry from swallowing the whole text.
4495 %                                 --kasal, 21nov03
4496 \def\entry{%
4497   \begingroup
4498     %
4499     % Start a new paragraph if necessary, so our assignments below can't
4500     % affect previous text.
4501     \par
4502     %
4503     % Do not fill out the last line with white space.
4504     \parfillskip = 0in
4505     %
4506     % No extra space above this paragraph.
4507     \parskip = 0in
4508     %
4509     % Do not prefer a separate line ending with a hyphen to fewer lines.
4510     \finalhyphendemerits = 0
4511     %
4512     % \hangindent is only relevant when the entry text and page number
4513     % don't both fit on one line.  In that case, bob suggests starting the
4514     % dots pretty far over on the line.  Unfortunately, a large
4515     % indentation looks wrong when the entry text itself is broken across
4516     % lines.  So we use a small indentation and put up with long leaders.
4517     %
4518     % \hangafter is reset to 1 (which is the value we want) at the start
4519     % of each paragraph, so we need not do anything with that.
4520     \hangindent = 2em
4521     %
4522     % When the entry text needs to be broken, just fill out the first line
4523     % with blank space.
4524     \rightskip = 0pt plus1fil
4525     %
4526     % A bit of stretch before each entry for the benefit of balancing
4527     % columns.
4528     \vskip 0pt plus1pt
4529     %
4530     % Swallow the left brace of the text (first parameter):
4531     \afterassignment\doentry
4532     \let\temp =
4533 }
4534 \def\doentry{%
4535     \bgroup % Instead of the swallowed brace.
4536       \noindent
4537       \aftergroup\finishentry
4538       % And now comes the text of the entry.
4539 }
4540 \def\finishentry#1{%
4541     % #1 is the page number.
4542     %
4543     % The following is kludged to not output a line of dots in the index if
4544     % there are no page numbers.  The next person who breaks this will be
4545     % cursed by a Unix daemon.
4546     \setbox\boxA = \hbox{#1}%
4547     \ifdim\wd\boxA = 0pt
4548       \ %
4549     \else
4550       %
4551       % If we must, put the page number on a line of its own, and fill out
4552       % this line with blank space.  (The \hfil is overwhelmed with the
4553       % fill leaders glue in \indexdotfill if the page number does fit.)
4554       \hfil\penalty50
4555       \null\nobreak\indexdotfill % Have leaders before the page number.
4556       %
4557       % The `\ ' here is removed by the implicit \unskip that TeX does as
4558       % part of (the primitive) \par.  Without it, a spurious underfull
4559       % \hbox ensues.
4560       \ifpdf
4561         \pdfgettoks#1.%
4562         \ \the\toksA
4563       \else
4564         \ #1%
4565       \fi
4566     \fi
4567     \par
4568   \endgroup
4569 }
4570
4571 % Like plain.tex's \dotfill, except uses up at least 1 em.
4572 \def\indexdotfill{\cleaders
4573   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4574
4575 \def\primary #1{\line{#1\hfil}}
4576
4577 \newskip\secondaryindent \secondaryindent=0.5cm
4578 \def\secondary#1#2{{%
4579   \parfillskip=0in
4580   \parskip=0in
4581   \hangindent=1in
4582   \hangafter=1
4583   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4584   \ifpdf
4585     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4586   \else
4587     #2
4588   \fi
4589   \par
4590 }}
4591
4592 % Define two-column mode, which we use to typeset indexes.
4593 % Adapted from the TeXbook, page 416, which is to say,
4594 % the manmac.tex format used to print the TeXbook itself.
4595 \catcode`\@=11
4596
4597 \newbox\partialpage
4598 \newdimen\doublecolumnhsize
4599
4600 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4601   % Grab any single-column material above us.
4602   \output = {%
4603     %
4604     % Here is a possibility not foreseen in manmac: if we accumulate a
4605     % whole lot of material, we might end up calling this \output
4606     % routine twice in a row (see the doublecol-lose test, which is
4607     % essentially a couple of indexes with @setchapternewpage off).  In
4608     % that case we just ship out what is in \partialpage with the normal
4609     % output routine.  Generally, \partialpage will be empty when this
4610     % runs and this will be a no-op.  See the indexspread.tex test case.
4611     \ifvoid\partialpage \else
4612       \onepageout{\pagecontents\partialpage}%
4613     \fi
4614     %
4615     \global\setbox\partialpage = \vbox{%
4616       % Unvbox the main output page.
4617       \unvbox\PAGE
4618       \kern-\topskip \kern\baselineskip
4619     }%
4620   }%
4621   \eject % run that output routine to set \partialpage
4622   %
4623   % Use the double-column output routine for subsequent pages.
4624   \output = {\doublecolumnout}%
4625   %
4626   % Change the page size parameters.  We could do this once outside this
4627   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4628   % format, but then we repeat the same computation.  Repeating a couple
4629   % of assignments once per index is clearly meaningless for the
4630   % execution time, so we may as well do it in one place.
4631   %
4632   % First we halve the line length, less a little for the gutter between
4633   % the columns.  We compute the gutter based on the line length, so it
4634   % changes automatically with the paper format.  The magic constant
4635   % below is chosen so that the gutter has the same value (well, +-<1pt)
4636   % as it did when we hard-coded it.
4637   %
4638   % We put the result in a separate register, \doublecolumhsize, so we
4639   % can restore it in \pagesofar, after \hsize itself has (potentially)
4640   % been clobbered.
4641   %
4642   \doublecolumnhsize = \hsize
4643     \advance\doublecolumnhsize by -.04154\hsize
4644     \divide\doublecolumnhsize by 2
4645   \hsize = \doublecolumnhsize
4646   %
4647   % Double the \vsize as well.  (We don't need a separate register here,
4648   % since nobody clobbers \vsize.)
4649   \vsize = 2\vsize
4650 }
4651
4652 % The double-column output routine for all double-column pages except
4653 % the last.
4654 %
4655 \def\doublecolumnout{%
4656   \splittopskip=\topskip \splitmaxdepth=\maxdepth
4657   % Get the available space for the double columns -- the normal
4658   % (undoubled) page height minus any material left over from the
4659   % previous page.
4660   \dimen@ = \vsize
4661   \divide\dimen@ by 2
4662   \advance\dimen@ by -\ht\partialpage
4663   %
4664   % box0 will be the left-hand column, box2 the right.
4665   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4666   \onepageout\pagesofar
4667   \unvbox255
4668   \penalty\outputpenalty
4669 }
4670 %
4671 % Re-output the contents of the output page -- any previous material,
4672 % followed by the two boxes we just split, in box0 and box2.
4673 \def\pagesofar{%
4674   \unvbox\partialpage
4675   %
4676   \hsize = \doublecolumnhsize
4677   \wd0=\hsize \wd2=\hsize
4678   \hbox to\pagewidth{\box0\hfil\box2}%
4679 }
4680 %
4681 % All done with double columns.
4682 \def\enddoublecolumns{%
4683   % The following penalty ensures that the page builder is exercised
4684   % _before_ we change the output routine.  This is necessary in the
4685   % following situation:
4686   %
4687   % The last section of the index consists only of a single entry.
4688   % Before this section, \pagetotal is less than \pagegoal, so no
4689   % break occurs before the last section starts.  However, the last
4690   % section, consisting of \initial and the single \entry, does not
4691   % fit on the page and has to be broken off.  Without the following
4692   % penalty the page builder will not be exercised until \eject
4693   % below, and by that time we'll already have changed the output
4694   % routine to the \balancecolumns version, so the next-to-last
4695   % double-column page will be processed with \balancecolumns, which
4696   % is wrong:  The two columns will go to the main vertical list, with
4697   % the broken-off section in the recent contributions.  As soon as
4698   % the output routine finishes, TeX starts reconsidering the page
4699   % break.  The two columns and the broken-off section both fit on the
4700   % page, because the two columns now take up only half of the page
4701   % goal.  When TeX sees \eject from below which follows the final
4702   % section, it invokes the new output routine that we've set after
4703   % \balancecolumns below; \onepageout will try to fit the two columns
4704   % and the final section into the vbox of \pageheight (see
4705   % \pagebody), causing an overfull box.
4706   %
4707   % Note that glue won't work here, because glue does not exercise the
4708   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4709   \penalty0
4710   %
4711   \output = {%
4712     % Split the last of the double-column material.  Leave it on the
4713     % current page, no automatic page break.
4714     \balancecolumns
4715     %
4716     % If we end up splitting too much material for the current page,
4717     % though, there will be another page break right after this \output
4718     % invocation ends.  Having called \balancecolumns once, we do not
4719     % want to call it again.  Therefore, reset \output to its normal
4720     % definition right away.  (We hope \balancecolumns will never be
4721     % called on to balance too much material, but if it is, this makes
4722     % the output somewhat more palatable.)
4723     \global\output = {\onepageout{\pagecontents\PAGE}}%
4724   }%
4725   \eject
4726   \endgroup % started in \begindoublecolumns
4727   %
4728   % \pagegoal was set to the doubled \vsize above, since we restarted
4729   % the current page.  We're now back to normal single-column
4730   % typesetting, so reset \pagegoal to the normal \vsize (after the
4731   % \endgroup where \vsize got restored).
4732   \pagegoal = \vsize
4733 }
4734 %
4735 % Called at the end of the double column material.
4736 \def\balancecolumns{%
4737   \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4738   \dimen@ = \ht0
4739   \advance\dimen@ by \topskip
4740   \advance\dimen@ by-\baselineskip
4741   \divide\dimen@ by 2 % target to split to
4742   %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4743   \splittopskip = \topskip
4744   % Loop until we get a decent breakpoint.
4745   {%
4746     \vbadness = 10000
4747     \loop
4748       \global\setbox3 = \copy0
4749       \global\setbox1 = \vsplit3 to \dimen@
4750     \ifdim\ht3>\dimen@
4751       \global\advance\dimen@ by 1pt
4752     \repeat
4753   }%
4754   %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4755   \setbox0=\vbox to\dimen@{\unvbox1}%
4756   \setbox2=\vbox to\dimen@{\unvbox3}%
4757   %
4758   \pagesofar
4759 }
4760 \catcode`\@ = \other
4761
4762
4763 \message{sectioning,}
4764 % Chapters, sections, etc.
4765
4766 % \unnumberedno is an oxymoron, of course.  But we count the unnumbered
4767 % sections so that we can refer to them unambiguously in the pdf
4768 % outlines by their "section number".  We avoid collisions with chapter
4769 % numbers by starting them at 10000.  (If a document ever has 10000
4770 % chapters, we're in trouble anyway, I'm sure.)
4771 \newcount\unnumberedno \unnumberedno = 10000
4772 \newcount\chapno
4773 \newcount\secno        \secno=0
4774 \newcount\subsecno     \subsecno=0
4775 \newcount\subsubsecno  \subsubsecno=0
4776
4777 % This counter is funny since it counts through charcodes of letters A, B, ...
4778 \newcount\appendixno  \appendixno = `\@
4779 %
4780 % \def\appendixletter{\char\the\appendixno}
4781 % We do the following ugly conditional instead of the above simple
4782 % construct for the sake of pdftex, which needs the actual
4783 % letter in the expansion, not just typeset.
4784 %
4785 \def\appendixletter{%
4786   \ifnum\appendixno=`A A%
4787   \else\ifnum\appendixno=`B B%
4788   \else\ifnum\appendixno=`C C%
4789   \else\ifnum\appendixno=`D D%
4790   \else\ifnum\appendixno=`E E%
4791   \else\ifnum\appendixno=`F F%
4792   \else\ifnum\appendixno=`G G%
4793   \else\ifnum\appendixno=`H H%
4794   \else\ifnum\appendixno=`I I%
4795   \else\ifnum\appendixno=`J J%
4796   \else\ifnum\appendixno=`K K%
4797   \else\ifnum\appendixno=`L L%
4798   \else\ifnum\appendixno=`M M%
4799   \else\ifnum\appendixno=`N N%
4800   \else\ifnum\appendixno=`O O%
4801   \else\ifnum\appendixno=`P P%
4802   \else\ifnum\appendixno=`Q Q%
4803   \else\ifnum\appendixno=`R R%
4804   \else\ifnum\appendixno=`S S%
4805   \else\ifnum\appendixno=`T T%
4806   \else\ifnum\appendixno=`U U%
4807   \else\ifnum\appendixno=`V V%
4808   \else\ifnum\appendixno=`W W%
4809   \else\ifnum\appendixno=`X X%
4810   \else\ifnum\appendixno=`Y Y%
4811   \else\ifnum\appendixno=`Z Z%
4812   % The \the is necessary, despite appearances, because \appendixletter is
4813   % expanded while writing the .toc file.  \char\appendixno is not
4814   % expandable, thus it is written literally, thus all appendixes come out
4815   % with the same letter (or @) in the toc without it.
4816   \else\char\the\appendixno
4817   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4818   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4819
4820 % Each @chapter defines these (using marks) as the number+name, number
4821 % and name of the chapter.  Page headings and footings can use
4822 % these.  @section does likewise.
4823 \def\thischapter{}
4824 \def\thischapternum{}
4825 \def\thischaptername{}
4826 \def\thissection{}
4827 \def\thissectionnum{}
4828 \def\thissectionname{}
4829
4830 \newcount\absseclevel % used to calculate proper heading level
4831 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4832
4833 % @raisesections: treat @section as chapter, @subsection as section, etc.
4834 \def\raisesections{\global\advance\secbase by -1}
4835 \let\up=\raisesections % original BFox name
4836
4837 % @lowersections: treat @chapter as section, @section as subsection, etc.
4838 \def\lowersections{\global\advance\secbase by 1}
4839 \let\down=\lowersections % original BFox name
4840
4841 % we only have subsub.
4842 \chardef\maxseclevel = 3
4843 %
4844 % A numbered section within an unnumbered changes to unnumbered too.
4845 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4846 \chardef\unmlevel = \maxseclevel
4847 %
4848 % Trace whether the current chapter is an appendix or not:
4849 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4850 \def\chapheadtype{N}
4851
4852 % Choose a heading macro
4853 % #1 is heading type
4854 % #2 is heading level
4855 % #3 is text for heading
4856 \def\genhead#1#2#3{%
4857   % Compute the abs. sec. level:
4858   \absseclevel=#2
4859   \advance\absseclevel by \secbase
4860   % Make sure \absseclevel doesn't fall outside the range:
4861   \ifnum \absseclevel < 0
4862     \absseclevel = 0
4863   \else
4864     \ifnum \absseclevel > 3
4865       \absseclevel = 3
4866     \fi
4867   \fi
4868   % The heading type:
4869   \def\headtype{#1}%
4870   \if \headtype U%
4871     \ifnum \absseclevel < \unmlevel
4872       \chardef\unmlevel = \absseclevel
4873     \fi
4874   \else
4875     % Check for appendix sections:
4876     \ifnum \absseclevel = 0
4877       \edef\chapheadtype{\headtype}%
4878     \else
4879       \if \headtype A\if \chapheadtype N%
4880         \errmessage{@appendix... within a non-appendix chapter}%
4881       \fi\fi
4882     \fi
4883     % Check for numbered within unnumbered:
4884     \ifnum \absseclevel > \unmlevel
4885       \def\headtype{U}%
4886     \else
4887       \chardef\unmlevel = 3
4888     \fi
4889   \fi
4890   % Now print the heading:
4891   \if \headtype U%
4892     \ifcase\absseclevel
4893         \unnumberedzzz{#3}%
4894     \or \unnumberedseczzz{#3}%
4895     \or \unnumberedsubseczzz{#3}%
4896     \or \unnumberedsubsubseczzz{#3}%
4897     \fi
4898   \else
4899     \if \headtype A%
4900       \ifcase\absseclevel
4901           \appendixzzz{#3}%
4902       \or \appendixsectionzzz{#3}%
4903       \or \appendixsubseczzz{#3}%
4904       \or \appendixsubsubseczzz{#3}%
4905       \fi
4906     \else
4907       \ifcase\absseclevel
4908           \chapterzzz{#3}%
4909       \or \seczzz{#3}%
4910       \or \numberedsubseczzz{#3}%
4911       \or \numberedsubsubseczzz{#3}%
4912       \fi
4913     \fi
4914   \fi
4915   \suppressfirstparagraphindent
4916 }
4917
4918 % an interface:
4919 \def\numhead{\genhead N}
4920 \def\apphead{\genhead A}
4921 \def\unnmhead{\genhead U}
4922
4923 % @chapter, @appendix, @unnumbered.  Increment top-level counter, reset
4924 % all lower-level sectioning counters to zero.
4925 %
4926 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4927 % (e.g., figures), q.v.  By default (before any chapter), that is empty.
4928 \let\chaplevelprefix = \empty
4929 %
4930 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4931 \def\chapterzzz#1{%
4932   % section resetting is \global in case the chapter is in a group, such
4933   % as an @include file.
4934   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4935     \global\advance\chapno by 1
4936   %
4937   % Used for \float.
4938   \gdef\chaplevelprefix{\the\chapno.}%
4939   \resetallfloatnos
4940   %
4941   \message{\putwordChapter\space \the\chapno}%
4942   %
4943   % Write the actual heading.
4944   \chapmacro{#1}{Ynumbered}{\the\chapno}%
4945   %
4946   % So @section and the like are numbered underneath this chapter.
4947   \global\let\section = \numberedsec
4948   \global\let\subsection = \numberedsubsec
4949   \global\let\subsubsection = \numberedsubsubsec
4950 }
4951
4952 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4953 \def\appendixzzz#1{%
4954   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4955     \global\advance\appendixno by 1
4956   \gdef\chaplevelprefix{\appendixletter.}%
4957   \resetallfloatnos
4958   %
4959   \def\appendixnum{\putwordAppendix\space \appendixletter}%
4960   \message{\appendixnum}%
4961   %
4962   \chapmacro{#1}{Yappendix}{\appendixletter}%
4963   %
4964   \global\let\section = \appendixsec
4965   \global\let\subsection = \appendixsubsec
4966   \global\let\subsubsection = \appendixsubsubsec
4967 }
4968
4969 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4970 \def\unnumberedzzz#1{%
4971   \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4972     \global\advance\unnumberedno by 1
4973   %
4974   % Since an unnumbered has no number, no prefix for figures.
4975   \global\let\chaplevelprefix = \empty
4976   \resetallfloatnos
4977   %
4978   % This used to be simply \message{#1}, but TeX fully expands the
4979   % argument to \message.  Therefore, if #1 contained @-commands, TeX
4980   % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
4981   % expanded @cite (which turns out to cause errors because \cite is meant
4982   % to be executed, not expanded).
4983   %
4984   % Anyway, we don't want the fully-expanded definition of @cite to appear
4985   % as a result of the \message, we just want `@cite' itself.  We use
4986   % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4987   % simply yielding the contents of <toks register>.  (We also do this for
4988   % the toc entries.)
4989   \toks0 = {#1}%
4990   \message{(\the\toks0)}%
4991   %
4992   \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4993   %
4994   \global\let\section = \unnumberedsec
4995   \global\let\subsection = \unnumberedsubsec
4996   \global\let\subsubsection = \unnumberedsubsubsec
4997 }
4998
4999 % @centerchap is like @unnumbered, but the heading is centered.
5000 \outer\parseargdef\centerchap{%
5001   % Well, we could do the following in a group, but that would break
5002   % an assumption that \chapmacro is called at the outermost level.
5003   % Thus we are safer this way:         --kasal, 24feb04
5004   \let\centerparametersmaybe = \centerparameters
5005   \unnmhead0{#1}%
5006   \let\centerparametersmaybe = \relax
5007 }
5008
5009 % @top is like @unnumbered.
5010 \let\top\unnumbered
5011
5012 % Sections.
5013 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5014 \def\seczzz#1{%
5015   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5016   \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5017 }
5018
5019 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5020 \def\appendixsectionzzz#1{%
5021   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5022   \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5023 }
5024 \let\appendixsec\appendixsection
5025
5026 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5027 \def\unnumberedseczzz#1{%
5028   \global\subsecno=0 \global\subsubsecno=0  \global\advance\secno by 1
5029   \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5030 }
5031
5032 % Subsections.
5033 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5034 \def\numberedsubseczzz#1{%
5035   \global\subsubsecno=0  \global\advance\subsecno by 1
5036   \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5037 }
5038
5039 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5040 \def\appendixsubseczzz#1{%
5041   \global\subsubsecno=0  \global\advance\subsecno by 1
5042   \sectionheading{#1}{subsec}{Yappendix}%
5043                  {\appendixletter.\the\secno.\the\subsecno}%
5044 }
5045
5046 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5047 \def\unnumberedsubseczzz#1{%
5048   \global\subsubsecno=0  \global\advance\subsecno by 1
5049   \sectionheading{#1}{subsec}{Ynothing}%
5050                  {\the\unnumberedno.\the\secno.\the\subsecno}%
5051 }
5052
5053 % Subsubsections.
5054 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5055 \def\numberedsubsubseczzz#1{%
5056   \global\advance\subsubsecno by 1
5057   \sectionheading{#1}{subsubsec}{Ynumbered}%
5058                  {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5059 }
5060
5061 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5062 \def\appendixsubsubseczzz#1{%
5063   \global\advance\subsubsecno by 1
5064   \sectionheading{#1}{subsubsec}{Yappendix}%
5065                  {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5066 }
5067
5068 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5069 \def\unnumberedsubsubseczzz#1{%
5070   \global\advance\subsubsecno by 1
5071   \sectionheading{#1}{subsubsec}{Ynothing}%
5072                  {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5073 }
5074
5075 % These macros control what the section commands do, according
5076 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5077 % Define them by default for a numbered chapter.
5078 \let\section = \numberedsec
5079 \let\subsection = \numberedsubsec
5080 \let\subsubsection = \numberedsubsubsec
5081
5082 % Define @majorheading, @heading and @subheading
5083
5084 % NOTE on use of \vbox for chapter headings, section headings, and such:
5085 %       1) We use \vbox rather than the earlier \line to permit
5086 %          overlong headings to fold.
5087 %       2) \hyphenpenalty is set to 10000 because hyphenation in a
5088 %          heading is obnoxious; this forbids it.
5089 %       3) Likewise, headings look best if no \parindent is used, and
5090 %          if justification is not attempted.  Hence \raggedright.
5091
5092 \def\majorheading{%
5093   {\advance\chapheadingskip by 10pt \chapbreak }%
5094   \parsearg\chapheadingzzz
5095 }
5096
5097 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5098 \def\chapheadingzzz#1{%
5099   {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5100                     \parindent=0pt\raggedright
5101                     \rmisbold #1\hfill}}%
5102   \bigskip \par\penalty 200\relax
5103   \suppressfirstparagraphindent
5104 }
5105
5106 % @heading, @subheading, @subsubheading.
5107 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5108   \suppressfirstparagraphindent}
5109 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5110   \suppressfirstparagraphindent}
5111 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5112   \suppressfirstparagraphindent}
5113
5114 % These macros generate a chapter, section, etc. heading only
5115 % (including whitespace, linebreaking, etc. around it),
5116 % given all the information in convenient, parsed form.
5117
5118 %%% Args are the skip and penalty (usually negative)
5119 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5120
5121 %%% Define plain chapter starts, and page on/off switching for it
5122 % Parameter controlling skip before chapter headings (if needed)
5123
5124 \newskip\chapheadingskip
5125
5126 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5127 \def\chappager{\par\vfill\supereject}
5128 % Because \domark is called before \chapoddpage, the filler page will
5129 % get the headings for the next chapter, which is wrong.  But we don't
5130 % care -- we just disable all headings on the filler page.
5131 \def\chapoddpage{%
5132   \chappager
5133   \ifodd\pageno \else
5134     \begingroup
5135       \evenheadline={\hfil}\evenfootline={\hfil}%
5136       \oddheadline={\hfil}\oddfootline={\hfil}%
5137       \hbox to 0pt{}%
5138       \chappager
5139     \endgroup
5140   \fi
5141 }
5142
5143 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5144
5145 \def\CHAPPAGoff{%
5146 \global\let\contentsalignmacro = \chappager
5147 \global\let\pchapsepmacro=\chapbreak
5148 \global\let\pagealignmacro=\chappager}
5149
5150 \def\CHAPPAGon{%
5151 \global\let\contentsalignmacro = \chappager
5152 \global\let\pchapsepmacro=\chappager
5153 \global\let\pagealignmacro=\chappager
5154 \global\def\HEADINGSon{\HEADINGSsingle}}
5155
5156 \def\CHAPPAGodd{%
5157 \global\let\contentsalignmacro = \chapoddpage
5158 \global\let\pchapsepmacro=\chapoddpage
5159 \global\let\pagealignmacro=\chapoddpage
5160 \global\def\HEADINGSon{\HEADINGSdouble}}
5161
5162 \CHAPPAGon
5163
5164 % Chapter opening.
5165 %
5166 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5167 % Yappendix, Yomitfromtoc), #3 the chapter number.
5168 %
5169 % To test against our argument.
5170 \def\Ynothingkeyword{Ynothing}
5171 \def\Yomitfromtockeyword{Yomitfromtoc}
5172 \def\Yappendixkeyword{Yappendix}
5173 %
5174 \def\chapmacro#1#2#3{%
5175   % Insert the first mark before the heading break (see notes for \domark).
5176   \let\prevchapterdefs=\lastchapterdefs
5177   \let\prevsectiondefs=\lastsectiondefs
5178   \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5179                         \gdef\thissection{}}%
5180   %
5181   \def\temptype{#2}%
5182   \ifx\temptype\Ynothingkeyword
5183     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5184                           \gdef\thischapter{\thischaptername}}%
5185   \else\ifx\temptype\Yomitfromtockeyword
5186     \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5187                           \gdef\thischapter{}}%
5188   \else\ifx\temptype\Yappendixkeyword
5189     \toks0={#1}%
5190     \xdef\lastchapterdefs{%
5191       \gdef\noexpand\thischaptername{\the\toks0}%
5192       \gdef\noexpand\thischapternum{\appendixletter}%
5193       \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5194                                  \noexpand\thischaptername}%
5195     }%
5196   \else
5197     \toks0={#1}%
5198     \xdef\lastchapterdefs{%
5199       \gdef\noexpand\thischaptername{\the\toks0}%
5200       \gdef\noexpand\thischapternum{\the\chapno}%
5201       \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5202                                  \noexpand\thischaptername}%
5203     }%
5204   \fi\fi\fi
5205   %
5206   % Output the mark.  Pass it through \safewhatsit, to take care of
5207   % the preceding space.
5208   \safewhatsit\domark
5209   %
5210   % Insert the chapter heading break.
5211   \pchapsepmacro
5212   %
5213   % Now the second mark, after the heading break.  No break points
5214   % between here and the heading.
5215   \let\prevchapterdefs=\lastchapterdefs
5216   \let\prevsectiondefs=\lastsectiondefs
5217   \domark
5218   %
5219   {%
5220     \chapfonts \rmisbold
5221     %
5222     % Have to define \lastsection before calling \donoderef, because the
5223     % xref code eventually uses it.  On the other hand, it has to be called
5224     % after \pchapsepmacro, or the headline will change too soon.
5225     \gdef\lastsection{#1}%
5226     %
5227     % Only insert the separating space if we have a chapter/appendix
5228     % number, and don't print the unnumbered ``number''.
5229     \ifx\temptype\Ynothingkeyword
5230       \setbox0 = \hbox{}%
5231       \def\toctype{unnchap}%
5232     \else\ifx\temptype\Yomitfromtockeyword
5233       \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5234       \def\toctype{omit}%
5235     \else\ifx\temptype\Yappendixkeyword
5236       \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5237       \def\toctype{app}%
5238     \else
5239       \setbox0 = \hbox{#3\enspace}%
5240       \def\toctype{numchap}%
5241     \fi\fi\fi
5242     %
5243     % Write the toc entry for this chapter.  Must come before the
5244     % \donoderef, because we include the current node name in the toc
5245     % entry, and \donoderef resets it to empty.
5246     \writetocentry{\toctype}{#1}{#3}%
5247     %
5248     % For pdftex, we have to write out the node definition (aka, make
5249     % the pdfdest) after any page break, but before the actual text has
5250     % been typeset.  If the destination for the pdf outline is after the
5251     % text, then jumping from the outline may wind up with the text not
5252     % being visible, for instance under high magnification.
5253     \donoderef{#2}%
5254     %
5255     % Typeset the actual heading.
5256     \nobreak % Avoid page breaks at the interline glue.
5257     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5258           \hangindent=\wd0 \centerparametersmaybe
5259           \unhbox0 #1\par}%
5260   }%
5261   \nobreak\bigskip % no page break after a chapter title
5262   \nobreak
5263 }
5264
5265 % @centerchap -- centered and unnumbered.
5266 \let\centerparametersmaybe = \relax
5267 \def\centerparameters{%
5268   \advance\rightskip by 3\rightskip
5269   \leftskip = \rightskip
5270   \parfillskip = 0pt
5271 }
5272
5273
5274 % I don't think this chapter style is supported any more, so I'm not
5275 % updating it with the new noderef stuff.  We'll see.  --karl, 11aug03.
5276 %
5277 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5278 %
5279 \def\unnchfopen #1{%
5280 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5281                        \parindent=0pt\raggedright
5282                        \rmisbold #1\hfill}}\bigskip \par\nobreak
5283 }
5284 \def\chfopen #1#2{\chapoddpage {\chapfonts
5285 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5286 \par\penalty 5000 %
5287 }
5288 \def\centerchfopen #1{%
5289 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5290                        \parindent=0pt
5291                        \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5292 }
5293 \def\CHAPFopen{%
5294   \global\let\chapmacro=\chfopen
5295   \global\let\centerchapmacro=\centerchfopen}
5296
5297
5298 % Section titles.  These macros combine the section number parts and
5299 % call the generic \sectionheading to do the printing.
5300 %
5301 \newskip\secheadingskip
5302 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5303
5304 % Subsection titles.
5305 \newskip\subsecheadingskip
5306 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5307
5308 % Subsubsection titles.
5309 \def\subsubsecheadingskip{\subsecheadingskip}
5310 \def\subsubsecheadingbreak{\subsecheadingbreak}
5311
5312
5313 % Print any size, any type, section title.
5314 %
5315 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5316 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5317 % section number.
5318 %
5319 \def\seckeyword{sec}
5320 %
5321 \def\sectionheading#1#2#3#4{%
5322   {%
5323     % Switch to the right set of fonts.
5324     \csname #2fonts\endcsname \rmisbold
5325     %
5326     \def\sectionlevel{#2}%
5327     \def\temptype{#3}%
5328     %
5329     % Insert first mark before the heading break (see notes for \domark).
5330     \let\prevsectiondefs=\lastsectiondefs
5331     \ifx\temptype\Ynothingkeyword
5332       \ifx\sectionlevel\seckeyword
5333         \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5334                               \gdef\thissection{\thissectionname}}%
5335       \fi
5336     \else\ifx\temptype\Yomitfromtockeyword
5337       % Don't redefine \thissection.
5338     \else\ifx\temptype\Yappendixkeyword
5339       \ifx\sectionlevel\seckeyword
5340         \toks0={#1}%
5341         \xdef\lastsectiondefs{%
5342           \gdef\noexpand\thissectionname{\the\toks0}%
5343           \gdef\noexpand\thissectionnum{#4}%
5344           \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5345                                      \noexpand\thissectionname}%
5346         }%
5347       \fi
5348     \else
5349       \ifx\sectionlevel\seckeyword
5350         \toks0={#1}%
5351         \xdef\lastsectiondefs{%
5352           \gdef\noexpand\thissectionname{\the\toks0}%
5353           \gdef\noexpand\thissectionnum{#4}%
5354           \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5355                                      \noexpand\thissectionname}%
5356         }%
5357       \fi
5358     \fi\fi\fi
5359     %
5360     % Output the mark.  Pass it through \safewhatsit, to take care of
5361     % the preceding space.
5362     \safewhatsit\domark
5363     %
5364     % Insert space above the heading.
5365     \csname #2headingbreak\endcsname
5366     %
5367     % Now the second mark, after the heading break.  No break points
5368     % between here and the heading.
5369     \let\prevsectiondefs=\lastsectiondefs
5370     \domark
5371     %
5372     % Only insert the space after the number if we have a section number.
5373     \ifx\temptype\Ynothingkeyword
5374       \setbox0 = \hbox{}%
5375       \def\toctype{unn}%
5376       \gdef\lastsection{#1}%
5377     \else\ifx\temptype\Yomitfromtockeyword
5378       % for @headings -- no section number, don't include in toc,
5379       % and don't redefine \lastsection.
5380       \setbox0 = \hbox{}%
5381       \def\toctype{omit}%
5382       \let\sectionlevel=\empty
5383     \else\ifx\temptype\Yappendixkeyword
5384       \setbox0 = \hbox{#4\enspace}%
5385       \def\toctype{app}%
5386       \gdef\lastsection{#1}%
5387     \else
5388       \setbox0 = \hbox{#4\enspace}%
5389       \def\toctype{num}%
5390       \gdef\lastsection{#1}%
5391     \fi\fi\fi
5392     %
5393     % Write the toc entry (before \donoderef).  See comments in \chapmacro.
5394     \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5395     %
5396     % Write the node reference (= pdf destination for pdftex).
5397     % Again, see comments in \chapmacro.
5398     \donoderef{#3}%
5399     %
5400     % Interline glue will be inserted when the vbox is completed.
5401     % That glue will be a valid breakpoint for the page, since it'll be
5402     % preceded by a whatsit (usually from the \donoderef, or from the
5403     % \writetocentry if there was no node).  We don't want to allow that
5404     % break, since then the whatsits could end up on page n while the
5405     % section is on page n+1, thus toc/etc. are wrong.  Debian bug 276000.
5406     \nobreak
5407     %
5408     % Output the actual section heading.
5409     \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5410           \hangindent=\wd0  % zero if no section number
5411           \unhbox0 #1}%
5412   }%
5413   % Add extra space after the heading -- half of whatever came above it.
5414   % Don't allow stretch, though.
5415   \kern .5 \csname #2headingskip\endcsname
5416   %
5417   % Do not let the kern be a potential breakpoint, as it would be if it
5418   % was followed by glue.
5419   \nobreak
5420   %
5421   % We'll almost certainly start a paragraph next, so don't let that
5422   % glue accumulate.  (Not a breakpoint because it's preceded by a
5423   % discardable item.)
5424   \vskip-\parskip
5425   % 
5426   % This is purely so the last item on the list is a known \penalty >
5427   % 10000.  This is so \startdefun can avoid allowing breakpoints after
5428   % section headings.  Otherwise, it would insert a valid breakpoint between:
5429   % 
5430   %   @section sec-whatever
5431   %   @deffn def-whatever
5432   \penalty 10001
5433 }
5434
5435
5436 \message{toc,}
5437 % Table of contents.
5438 \newwrite\tocfile
5439
5440 % Write an entry to the toc file, opening it if necessary.
5441 % Called from @chapter, etc.
5442 %
5443 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5444 % We append the current node name (if any) and page number as additional
5445 % arguments for the \{chap,sec,...}entry macros which will eventually
5446 % read this.  The node name is used in the pdf outlines as the
5447 % destination to jump to.
5448 %
5449 % We open the .toc file for writing here instead of at @setfilename (or
5450 % any other fixed time) so that @contents can be anywhere in the document.
5451 % But if #1 is `omit', then we don't do anything.  This is used for the
5452 % table of contents chapter openings themselves.
5453 %
5454 \newif\iftocfileopened
5455 \def\omitkeyword{omit}%
5456 %
5457 \def\writetocentry#1#2#3{%
5458   \edef\writetoctype{#1}%
5459   \ifx\writetoctype\omitkeyword \else
5460     \iftocfileopened\else
5461       \immediate\openout\tocfile = \jobname.toc
5462       \global\tocfileopenedtrue
5463     \fi
5464     %
5465     \iflinks
5466       {\atdummies
5467        \edef\temp{%
5468          \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5469        \temp
5470       }%
5471     \fi
5472   \fi
5473   %
5474   % Tell \shipout to create a pdf destination on each page, if we're
5475   % writing pdf.  These are used in the table of contents.  We can't
5476   % just write one on every page because the title pages are numbered
5477   % 1 and 2 (the page numbers aren't printed), and so are the first
5478   % two pages of the document.  Thus, we'd have two destinations named
5479   % `1', and two named `2'.
5480   \ifpdf \global\pdfmakepagedesttrue \fi
5481 }
5482
5483
5484 % These characters do not print properly in the Computer Modern roman
5485 % fonts, so we must take special care.  This is more or less redundant
5486 % with the Texinfo input format setup at the end of this file.
5487
5488 \def\activecatcodes{%
5489   \catcode`\"=\active
5490   \catcode`\$=\active
5491   \catcode`\<=\active
5492   \catcode`\>=\active
5493   \catcode`\\=\active
5494   \catcode`\^=\active
5495   \catcode`\_=\active
5496   \catcode`\|=\active
5497   \catcode`\~=\active
5498 }
5499
5500
5501 % Read the toc file, which is essentially Texinfo input.
5502 \def\readtocfile{%
5503   \setupdatafile
5504   \activecatcodes
5505   \input \tocreadfilename
5506 }
5507
5508 \newskip\contentsrightmargin \contentsrightmargin=1in
5509 \newcount\savepageno
5510 \newcount\lastnegativepageno \lastnegativepageno = -1
5511
5512 % Prepare to read what we've written to \tocfile.
5513 %
5514 \def\startcontents#1{%
5515   % If @setchapternewpage on, and @headings double, the contents should
5516   % start on an odd page, unlike chapters.  Thus, we maintain
5517   % \contentsalignmacro in parallel with \pagealignmacro.
5518   % From: Torbjorn Granlund <tege@matematik.su.se>
5519   \contentsalignmacro
5520   \immediate\closeout\tocfile
5521   %
5522   % Don't need to put `Contents' or `Short Contents' in the headline.
5523   % It is abundantly clear what they are.
5524   \chapmacro{#1}{Yomitfromtoc}{}%
5525   %
5526   \savepageno = \pageno
5527   \begingroup                  % Set up to handle contents files properly.
5528     \raggedbottom              % Worry more about breakpoints than the bottom.
5529     \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5530     %
5531     % Roman numerals for page numbers.
5532     \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5533 }
5534
5535 % redefined for the two-volume lispref.  We always output on
5536 % \jobname.toc even if this is redefined.
5537
5538 \def\tocreadfilename{\jobname.toc}
5539
5540 % Normal (long) toc.
5541 %
5542 \def\contents{%
5543   \startcontents{\putwordTOC}%
5544     \openin 1 \tocreadfilename\space
5545     \ifeof 1 \else
5546       \readtocfile
5547     \fi
5548     \vfill \eject
5549     \contentsalignmacro % in case @setchapternewpage odd is in effect
5550     \ifeof 1 \else
5551       \pdfmakeoutlines
5552     \fi
5553     \closein 1
5554   \endgroup
5555   \lastnegativepageno = \pageno
5556   \global\pageno = \savepageno
5557 }
5558
5559 % And just the chapters.
5560 \def\summarycontents{%
5561   \startcontents{\putwordShortTOC}%
5562     %
5563     \let\numchapentry = \shortchapentry
5564     \let\appentry = \shortchapentry
5565     \let\unnchapentry = \shortunnchapentry
5566     % We want a true roman here for the page numbers.
5567     \secfonts
5568     \let\rm=\shortcontrm \let\bf=\shortcontbf
5569     \let\sl=\shortcontsl \let\tt=\shortconttt
5570     \rm
5571     \hyphenpenalty = 10000
5572     \advance\baselineskip by 1pt % Open it up a little.
5573     \def\numsecentry##1##2##3##4{}
5574     \let\appsecentry = \numsecentry
5575     \let\unnsecentry = \numsecentry
5576     \let\numsubsecentry = \numsecentry
5577     \let\appsubsecentry = \numsecentry
5578     \let\unnsubsecentry = \numsecentry
5579     \let\numsubsubsecentry = \numsecentry
5580     \let\appsubsubsecentry = \numsecentry
5581     \let\unnsubsubsecentry = \numsecentry
5582     \openin 1 \tocreadfilename\space
5583     \ifeof 1 \else
5584       \readtocfile
5585     \fi
5586     \closein 1
5587     \vfill \eject
5588     \contentsalignmacro % in case @setchapternewpage odd is in effect
5589   \endgroup
5590   \lastnegativepageno = \pageno
5591   \global\pageno = \savepageno
5592 }
5593 \let\shortcontents = \summarycontents
5594
5595 % Typeset the label for a chapter or appendix for the short contents.
5596 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5597 %
5598 \def\shortchaplabel#1{%
5599   % This space should be enough, since a single number is .5em, and the
5600   % widest letter (M) is 1em, at least in the Computer Modern fonts.
5601   % But use \hss just in case.
5602   % (This space doesn't include the extra space that gets added after
5603   % the label; that gets put in by \shortchapentry above.)
5604   %
5605   % We'd like to right-justify chapter numbers, but that looks strange
5606   % with appendix letters.  And right-justifying numbers and
5607   % left-justifying letters looks strange when there is less than 10
5608   % chapters.  Have to read the whole toc once to know how many chapters
5609   % there are before deciding ...
5610   \hbox to 1em{#1\hss}%
5611 }
5612
5613 % These macros generate individual entries in the table of contents.
5614 % The first argument is the chapter or section name.
5615 % The last argument is the page number.
5616 % The arguments in between are the chapter number, section number, ...
5617
5618 % Chapters, in the main contents.
5619 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5620 %
5621 % Chapters, in the short toc.
5622 % See comments in \dochapentry re vbox and related settings.
5623 \def\shortchapentry#1#2#3#4{%
5624   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5625 }
5626
5627 % Appendices, in the main contents.
5628 % Need the word Appendix, and a fixed-size box.
5629 %
5630 \def\appendixbox#1{%
5631   % We use M since it's probably the widest letter.
5632   \setbox0 = \hbox{\putwordAppendix{} M}%
5633   \hbox to \wd0{\putwordAppendix{} #1\hss}}
5634 %
5635 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5636
5637 % Unnumbered chapters.
5638 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5639 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5640
5641 % Sections.
5642 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5643 \let\appsecentry=\numsecentry
5644 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5645
5646 % Subsections.
5647 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5648 \let\appsubsecentry=\numsubsecentry
5649 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5650
5651 % And subsubsections.
5652 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5653 \let\appsubsubsecentry=\numsubsubsecentry
5654 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5655
5656 % This parameter controls the indentation of the various levels.
5657 % Same as \defaultparindent.
5658 \newdimen\tocindent \tocindent = 15pt
5659
5660 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5661 % page number.
5662 %
5663 % If the toc has to be broken over pages, we want it to be at chapters
5664 % if at all possible; hence the \penalty.
5665 \def\dochapentry#1#2{%
5666    \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5667    \begingroup
5668      \chapentryfonts
5669      \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5670    \endgroup
5671    \nobreak\vskip .25\baselineskip plus.1\baselineskip
5672 }
5673
5674 \def\dosecentry#1#2{\begingroup
5675   \secentryfonts \leftskip=\tocindent
5676   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5677 \endgroup}
5678
5679 \def\dosubsecentry#1#2{\begingroup
5680   \subsecentryfonts \leftskip=2\tocindent
5681   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5682 \endgroup}
5683
5684 \def\dosubsubsecentry#1#2{\begingroup
5685   \subsubsecentryfonts \leftskip=3\tocindent
5686   \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5687 \endgroup}
5688
5689 % We use the same \entry macro as for the index entries.
5690 \let\tocentry = \entry
5691
5692 % Space between chapter (or whatever) number and the title.
5693 \def\labelspace{\hskip1em \relax}
5694
5695 \def\dopageno#1{{\rm #1}}
5696 \def\doshortpageno#1{{\rm #1}}
5697
5698 \def\chapentryfonts{\secfonts \rm}
5699 \def\secentryfonts{\textfonts}
5700 \def\subsecentryfonts{\textfonts}
5701 \def\subsubsecentryfonts{\textfonts}
5702
5703
5704 \message{environments,}
5705 % @foo ... @end foo.
5706
5707 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5708 %
5709 % Since these characters are used in examples, they should be an even number of
5710 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5711 %
5712 \def\point{$\star$}
5713 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5714 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5715 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5716 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5717 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5718
5719 % The @error{} command.
5720 % Adapted from the TeXbook's \boxit.
5721 %
5722 \newbox\errorbox
5723 %
5724 {\tentt \global\dimen0 = 3em}% Width of the box.
5725 \dimen2 = .55pt % Thickness of rules
5726 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5727 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5728 %
5729 \setbox\errorbox=\hbox to \dimen0{\hfil
5730    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5731    \advance\hsize by -2\dimen2 % Rules.
5732    \vbox{%
5733       \hrule height\dimen2
5734       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
5735          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5736          \kern3pt\vrule width\dimen2}% Space to right.
5737       \hrule height\dimen2}
5738     \hfil}
5739 %
5740 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5741
5742 % @tex ... @end tex    escapes into raw Tex temporarily.
5743 % One exception: @ is still an escape character, so that @end tex works.
5744 % But \@ or @@ will get a plain tex @ character.
5745
5746 \envdef\tex{%
5747   \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5748   \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5749   \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5750   \catcode `\%=14
5751   \catcode `\+=\other
5752   \catcode `\"=\other
5753   \catcode `\|=\other
5754   \catcode `\<=\other
5755   \catcode `\>=\other
5756   \escapechar=`\\
5757   %
5758   \let\b=\ptexb
5759   \let\bullet=\ptexbullet
5760   \let\c=\ptexc
5761   \let\,=\ptexcomma
5762   \let\.=\ptexdot
5763   \let\dots=\ptexdots
5764   \let\equiv=\ptexequiv
5765   \let\!=\ptexexclam
5766   \let\i=\ptexi
5767   \let\indent=\ptexindent
5768   \let\noindent=\ptexnoindent
5769   \let\{=\ptexlbrace
5770   \let\+=\tabalign
5771   \let\}=\ptexrbrace
5772   \let\/=\ptexslash
5773   \let\*=\ptexstar
5774   \let\t=\ptext
5775   \expandafter \let\csname top\endcsname=\ptextop  % outer
5776   \let\frenchspacing=\plainfrenchspacing
5777   %
5778   \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5779   \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5780   \def\@{@}%
5781 }
5782 % There is no need to define \Etex.
5783
5784 % Define @lisp ... @end lisp.
5785 % @lisp environment forms a group so it can rebind things,
5786 % including the definition of @end lisp (which normally is erroneous).
5787
5788 % Amount to narrow the margins by for @lisp.
5789 \newskip\lispnarrowing \lispnarrowing=0.4in
5790
5791 % This is the definition that ^^M gets inside @lisp, @example, and other
5792 % such environments.  \null is better than a space, since it doesn't
5793 % have any width.
5794 \def\lisppar{\null\endgraf}
5795
5796 % This space is always present above and below environments.
5797 \newskip\envskipamount \envskipamount = 0pt
5798
5799 % Make spacing and below environment symmetrical.  We use \parskip here
5800 % to help in doing that, since in @example-like environments \parskip
5801 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5802 % start of the next paragraph will insert \parskip.
5803 %
5804 \def\aboveenvbreak{{%
5805   % =10000 instead of <10000 because of a special case in \itemzzz and
5806   % \sectionheading, q.v.
5807   \ifnum \lastpenalty=10000 \else
5808     \advance\envskipamount by \parskip
5809     \endgraf
5810     \ifdim\lastskip<\envskipamount
5811       \removelastskip
5812       % it's not a good place to break if the last penalty was \nobreak
5813       % or better ...
5814       \ifnum\lastpenalty<10000 \penalty-50 \fi
5815       \vskip\envskipamount
5816     \fi
5817   \fi
5818 }}
5819
5820 \let\afterenvbreak = \aboveenvbreak
5821
5822 % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins; it will
5823 % also clear it, so that its embedded environments do the narrowing again.
5824 \let\nonarrowing=\relax
5825
5826 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5827 % environment contents.
5828 \font\circle=lcircle10
5829 \newdimen\circthick
5830 \newdimen\cartouter\newdimen\cartinner
5831 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5832 \circthick=\fontdimen8\circle
5833 %
5834 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5835 \def\ctr{{\hskip 6pt\circle\char'010}}
5836 \def\cbl{{\circle\char'012\hskip -6pt}}
5837 \def\cbr{{\hskip 6pt\circle\char'011}}
5838 \def\carttop{\hbox to \cartouter{\hskip\lskip
5839         \ctl\leaders\hrule height\circthick\hfil\ctr
5840         \hskip\rskip}}
5841 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5842         \cbl\leaders\hrule height\circthick\hfil\cbr
5843         \hskip\rskip}}
5844 %
5845 \newskip\lskip\newskip\rskip
5846
5847 \envdef\cartouche{%
5848   \ifhmode\par\fi  % can't be in the midst of a paragraph.
5849   \startsavinginserts
5850   \lskip=\leftskip \rskip=\rightskip
5851   \leftskip=0pt\rightskip=0pt % we want these *outside*.
5852   \cartinner=\hsize \advance\cartinner by-\lskip
5853   \advance\cartinner by-\rskip
5854   \cartouter=\hsize
5855   \advance\cartouter by 18.4pt  % allow for 3pt kerns on either
5856                                 % side, and for 6pt waste from
5857                                 % each corner char, and rule thickness
5858   \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5859   % Flag to tell @lisp, etc., not to narrow margin.
5860   \let\nonarrowing = t%
5861   \vbox\bgroup
5862       \baselineskip=0pt\parskip=0pt\lineskip=0pt
5863       \carttop
5864       \hbox\bgroup
5865           \hskip\lskip
5866           \vrule\kern3pt
5867           \vbox\bgroup
5868               \kern3pt
5869               \hsize=\cartinner
5870               \baselineskip=\normbskip
5871               \lineskip=\normlskip
5872               \parskip=\normpskip
5873               \vskip -\parskip
5874               \comment % For explanation, see the end of \def\group.
5875 }
5876 \def\Ecartouche{%
5877               \ifhmode\par\fi
5878               \kern3pt
5879           \egroup
5880           \kern3pt\vrule
5881           \hskip\rskip
5882       \egroup
5883       \cartbot
5884   \egroup
5885   \checkinserts
5886 }
5887
5888
5889 % This macro is called at the beginning of all the @example variants,
5890 % inside a group.
5891 \def\nonfillstart{%
5892   \aboveenvbreak
5893   \hfuzz = 12pt % Don't be fussy
5894   \sepspaces % Make spaces be word-separators rather than space tokens.
5895   \let\par = \lisppar % don't ignore blank lines
5896   \obeylines % each line of input is a line of output
5897   \parskip = 0pt
5898   \parindent = 0pt
5899   \emergencystretch = 0pt % don't try to avoid overfull boxes
5900   \ifx\nonarrowing\relax
5901     \advance \leftskip by \lispnarrowing
5902     \exdentamount=\lispnarrowing
5903   \else
5904     \let\nonarrowing = \relax
5905   \fi
5906   \let\exdent=\nofillexdent
5907 }
5908
5909 % If you want all examples etc. small: @set dispenvsize small.
5910 % If you want even small examples the full size: @set dispenvsize nosmall.
5911 % This affects the following displayed environments:
5912 %    @example, @display, @format, @lisp
5913 %
5914 \def\smallword{small}
5915 \def\nosmallword{nosmall}
5916 \let\SETdispenvsize\relax
5917 \def\setnormaldispenv{%
5918   \ifx\SETdispenvsize\smallword
5919     % end paragraph for sake of leading, in case document has no blank
5920     % line.  This is redundant with what happens in \aboveenvbreak, but
5921     % we need to do it before changing the fonts, and it's inconvenient
5922     % to change the fonts afterward.
5923     \ifnum \lastpenalty=10000 \else \endgraf \fi
5924     \smallexamplefonts \rm
5925   \fi
5926 }
5927 \def\setsmalldispenv{%
5928   \ifx\SETdispenvsize\nosmallword
5929   \else
5930     \ifnum \lastpenalty=10000 \else \endgraf \fi
5931     \smallexamplefonts \rm
5932   \fi
5933 }
5934
5935 % We often define two environments, @foo and @smallfoo.
5936 % Let's do it by one command:
5937 \def\makedispenv #1#2{
5938   \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5939   \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5940   \expandafter\let\csname E#1\endcsname \afterenvbreak
5941   \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5942 }
5943
5944 % Define two synonyms:
5945 \def\maketwodispenvs #1#2#3{
5946   \makedispenv{#1}{#3}
5947   \makedispenv{#2}{#3}
5948 }
5949
5950 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5951 %
5952 % @smallexample and @smalllisp: use smaller fonts.
5953 % Originally contributed by Pavel@xerox.
5954 %
5955 \maketwodispenvs {lisp}{example}{%
5956   \nonfillstart
5957   \tt\quoteexpand
5958   \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5959   \gobble       % eat return
5960 }
5961 % @display/@smalldisplay: same as @lisp except keep current font.
5962 %
5963 \makedispenv {display}{%
5964   \nonfillstart
5965   \gobble
5966 }
5967
5968 % @format/@smallformat: same as @display except don't narrow margins.
5969 %
5970 \makedispenv{format}{%
5971   \let\nonarrowing = t%
5972   \nonfillstart
5973   \gobble
5974 }
5975
5976 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5977 \envdef\flushleft{%
5978   \let\nonarrowing = t%
5979   \nonfillstart
5980   \gobble
5981 }
5982 \let\Eflushleft = \afterenvbreak
5983
5984 % @flushright.
5985 %
5986 \envdef\flushright{%
5987   \let\nonarrowing = t%
5988   \nonfillstart
5989   \advance\leftskip by 0pt plus 1fill
5990   \gobble
5991 }
5992 \let\Eflushright = \afterenvbreak
5993
5994
5995 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5996 % and narrows the margins.  We keep \parskip nonzero in general, since
5997 % we're doing normal filling.  So, when using \aboveenvbreak and
5998 % \afterenvbreak, temporarily make \parskip 0.
5999 %
6000 \def\quotationstart{%
6001   {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6002   \parindent=0pt
6003   %
6004   % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6005   \ifx\nonarrowing\relax
6006     \advance\leftskip by \lispnarrowing
6007     \advance\rightskip by \lispnarrowing
6008     \exdentamount = \lispnarrowing
6009   \else
6010     \let\nonarrowing = \relax
6011   \fi
6012   \parsearg\quotationlabel
6013 }
6014
6015 \envdef\quotation{%
6016   \setnormaldispenv
6017   \quotationstart
6018 }
6019
6020 \envdef\smallquotation{%
6021   \setsmalldispenv
6022   \quotationstart
6023 }
6024 \let\Esmallquotation = \Equotation
6025
6026 % We have retained a nonzero parskip for the environment, since we're
6027 % doing normal filling.
6028 %
6029 \def\Equotation{%
6030   \par
6031   \ifx\quotationauthor\undefined\else
6032     % indent a bit.
6033     \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6034   \fi
6035   {\parskip=0pt \afterenvbreak}%
6036 }
6037
6038 % If we're given an argument, typeset it in bold with a colon after.
6039 \def\quotationlabel#1{%
6040   \def\temp{#1}%
6041   \ifx\temp\empty \else
6042     {\bf #1: }%
6043   \fi
6044 }
6045
6046
6047 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6048 % If we want to allow any <char> as delimiter,
6049 % we need the curly braces so that makeinfo sees the @verb command, eg:
6050 % `@verbx...x' would look like the '@verbx' command.  --janneke@gnu.org
6051 %
6052 % [Knuth]: Donald Ervin Knuth, 1996.  The TeXbook.
6053 %
6054 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6055 % active too.  Otherwise, they get lost as the first character on a
6056 % verbatim line.
6057 \def\dospecials{%
6058   \do\ \do\\\do\{\do\}\do\$\do\&%
6059   \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6060   \do\<\do\>\do\|\do\@\do+\do\"%
6061 }
6062 %
6063 % [Knuth] p. 380
6064 \def\uncatcodespecials{%
6065   \def\do##1{\catcode`##1=\other}\dospecials}
6066 %
6067 % Setup for the @verb command.
6068 %
6069 % Eight spaces for a tab
6070 \begingroup
6071   \catcode`\^^I=\active
6072   \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6073 \endgroup
6074 %
6075 \def\setupverb{%
6076   \tt  % easiest (and conventionally used) font for verbatim
6077   \def\par{\leavevmode\endgraf}%
6078   \catcode`\`=\active
6079   \tabeightspaces
6080   % Respect line breaks,
6081   % print special symbols as themselves, and
6082   % make each space count
6083   % must do in this order:
6084   \obeylines \uncatcodespecials \sepspaces
6085 }
6086
6087 % Setup for the @verbatim environment
6088 %
6089 % Real tab expansion
6090 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6091 %
6092 \def\starttabbox{\setbox0=\hbox\bgroup}
6093
6094 % Allow an option to not replace quotes with a regular directed right
6095 % quote/apostrophe (char 0x27), but instead use the undirected quote
6096 % from cmtt (char 0x0d).  The undirected quote is ugly, so don't make it
6097 % the default, but it works for pasting with more pdf viewers (at least
6098 % evince), the lilypond developers report.  xpdf does work with the
6099 % regular 0x27.  
6100
6101 \def\codequoteright{%
6102   \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6103     \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6104       '%
6105     \else \char'15 \fi
6106   \else \char'15 \fi
6107 }
6108 %
6109 % and a similar option for the left quote char vs. a grave accent.
6110 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6111 % the code environments to do likewise.
6112
6113 \def\codequoteleft{%
6114   \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6115     \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6116       \relax`% the \relax disables the `! and `? ligatures
6117     \else \char'22 \fi
6118   \else \char'22 \fi
6119 }
6120 %
6121 \begingroup
6122   \catcode`\^^I=\active
6123   \gdef\tabexpand{%
6124     \catcode`\^^I=\active
6125     \def^^I{\leavevmode\egroup
6126       \dimen0=\wd0 % the width so far, or since the previous tab
6127       \divide\dimen0 by\tabw
6128       \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6129       \advance\dimen0 by\tabw  % advance to next multiple of \tabw
6130       \wd0=\dimen0 \box0 \starttabbox
6131     }%
6132   }
6133   \catcode`\'=\active
6134   \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6135   %
6136   \catcode`\`=\active
6137   \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6138   %
6139   \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6140 \endgroup
6141
6142 % start the verbatim environment.
6143 \def\setupverbatim{%
6144   \let\nonarrowing = t%
6145   \nonfillstart
6146   % Easiest (and conventionally used) font for verbatim
6147   \tt
6148   \def\par{\leavevmode\egroup\box0\endgraf}%
6149   \catcode`\`=\active
6150   \tabexpand
6151   \quoteexpand
6152   % Respect line breaks,
6153   % print special symbols as themselves, and
6154   % make each space count
6155   % must do in this order:
6156   \obeylines \uncatcodespecials \sepspaces
6157   \everypar{\starttabbox}%
6158 }
6159
6160 % Do the @verb magic: verbatim text is quoted by unique
6161 % delimiter characters.  Before first delimiter expect a
6162 % right brace, after last delimiter expect closing brace:
6163 %
6164 %    \def\doverb'{'<char>#1<char>'}'{#1}
6165 %
6166 % [Knuth] p. 382; only eat outer {}
6167 \begingroup
6168   \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6169   \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6170 \endgroup
6171 %
6172 \def\verb{\begingroup\setupverb\doverb}
6173 %
6174 %
6175 % Do the @verbatim magic: define the macro \doverbatim so that
6176 % the (first) argument ends when '@end verbatim' is reached, ie:
6177 %
6178 %     \def\doverbatim#1@end verbatim{#1}
6179 %
6180 % For Texinfo it's a lot easier than for LaTeX,
6181 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6182 % we need not redefine '\', '{' and '}'.
6183 %
6184 % Inspired by LaTeX's verbatim command set [latex.ltx]
6185 %
6186 \begingroup
6187   \catcode`\ =\active
6188   \obeylines %
6189   % ignore everything up to the first ^^M, that's the newline at the end
6190   % of the @verbatim input line itself.  Otherwise we get an extra blank
6191   % line in the output.
6192   \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6193   % We really want {...\end verbatim} in the body of the macro, but
6194   % without the active space; thus we have to use \xdef and \gobble.
6195 \endgroup
6196 %
6197 \envdef\verbatim{%
6198     \setupverbatim\doverbatim
6199 }
6200 \let\Everbatim = \afterenvbreak
6201
6202
6203 % @verbatiminclude FILE - insert text of file in verbatim environment.
6204 %
6205 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6206 %
6207 \def\doverbatiminclude#1{%
6208   {%
6209     \makevalueexpandable
6210     \setupverbatim
6211     \indexnofonts       % Allow `@@' and other weird things in file names.
6212     \input #1
6213     \afterenvbreak
6214   }%
6215 }
6216
6217 % @copying ... @end copying.
6218 % Save the text away for @insertcopying later.
6219 %
6220 % We save the uninterpreted tokens, rather than creating a box.
6221 % Saving the text in a box would be much easier, but then all the
6222 % typesetting commands (@smallbook, font changes, etc.) have to be done
6223 % beforehand -- and a) we want @copying to be done first in the source
6224 % file; b) letting users define the frontmatter in as flexible order as
6225 % possible is very desirable.
6226 %
6227 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6228 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6229 %
6230 \def\insertcopying{%
6231   \begingroup
6232     \parindent = 0pt  % paragraph indentation looks wrong on title page
6233     \scanexp\copyingtext
6234   \endgroup
6235 }
6236
6237
6238 \message{defuns,}
6239 % @defun etc.
6240
6241 \newskip\defbodyindent \defbodyindent=.4in
6242 \newskip\defargsindent \defargsindent=50pt
6243 \newskip\deflastargmargin \deflastargmargin=18pt
6244 \newcount\defunpenalty
6245
6246 % Start the processing of @deffn:
6247 \def\startdefun{%
6248   \ifnum\lastpenalty<10000
6249     \medbreak
6250     \defunpenalty=10003 % Will keep this @deffn together with the
6251                         % following @def command, see below.
6252   \else
6253     % If there are two @def commands in a row, we'll have a \nobreak,
6254     % which is there to keep the function description together with its
6255     % header.  But if there's nothing but headers, we need to allow a
6256     % break somewhere.  Check specifically for penalty 10002, inserted
6257     % by \printdefunline, instead of 10000, since the sectioning
6258     % commands also insert a nobreak penalty, and we don't want to allow
6259     % a break between a section heading and a defun.
6260     %
6261     % As a minor refinement, we avoid "club" headers by signalling
6262     % with penalty of 10003 after the very first @deffn in the
6263     % sequence (see above), and penalty of 10002 after any following
6264     % @def command.
6265     \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6266     %
6267     % Similarly, after a section heading, do not allow a break.
6268     % But do insert the glue.
6269     \medskip  % preceded by discardable penalty, so not a breakpoint
6270   \fi
6271   %
6272   \parindent=0in
6273   \advance\leftskip by \defbodyindent
6274   \exdentamount=\defbodyindent
6275 }
6276
6277 \def\dodefunx#1{%
6278   % First, check whether we are in the right environment:
6279   \checkenv#1%
6280   %
6281   % As above, allow line break if we have multiple x headers in a row.
6282   % It's not a great place, though.
6283   \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6284   %
6285   % And now, it's time to reuse the body of the original defun:
6286   \expandafter\gobbledefun#1%
6287 }
6288 \def\gobbledefun#1\startdefun{}
6289
6290 % \printdefunline \deffnheader{text}
6291 %
6292 \def\printdefunline#1#2{%
6293   \begingroup
6294     % call \deffnheader:
6295     #1#2 \endheader
6296     % common ending:
6297     \interlinepenalty = 10000
6298     \advance\rightskip by 0pt plus 1fil
6299     \endgraf
6300     \nobreak\vskip -\parskip
6301     \penalty\defunpenalty  % signal to \startdefun and \dodefunx
6302     % Some of the @defun-type tags do not enable magic parentheses,
6303     % rendering the following check redundant.  But we don't optimize.
6304     \checkparencounts
6305   \endgroup
6306 }
6307
6308 \def\Edefun{\endgraf\medbreak}
6309
6310 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6311 % the only thing remaining is to define \deffnheader.
6312 %
6313 \def\makedefun#1{%
6314   \expandafter\let\csname E#1\endcsname = \Edefun
6315   \edef\temp{\noexpand\domakedefun
6316     \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6317   \temp
6318 }
6319
6320 % \domakedefun \deffn \deffnx \deffnheader
6321 %
6322 % Define \deffn and \deffnx, without parameters.
6323 % \deffnheader has to be defined explicitly.
6324 %
6325 \def\domakedefun#1#2#3{%
6326   \envdef#1{%
6327     \startdefun
6328     \parseargusing\activeparens{\printdefunline#3}%
6329   }%
6330   \def#2{\dodefunx#1}%
6331   \def#3%
6332 }
6333
6334 %%% Untyped functions:
6335
6336 % @deffn category name args
6337 \makedefun{deffn}{\deffngeneral{}}
6338
6339 % @deffn category class name args
6340 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6341
6342 % \defopon {category on}class name args
6343 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6344
6345 % \deffngeneral {subind}category name args
6346 %
6347 \def\deffngeneral#1#2 #3 #4\endheader{%
6348   % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6349   \dosubind{fn}{\code{#3}}{#1}%
6350   \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6351 }
6352
6353 %%% Typed functions:
6354
6355 % @deftypefn category type name args
6356 \makedefun{deftypefn}{\deftypefngeneral{}}
6357
6358 % @deftypeop category class type name args
6359 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6360
6361 % \deftypeopon {category on}class type name args
6362 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6363
6364 % \deftypefngeneral {subind}category type name args
6365 %
6366 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6367   \dosubind{fn}{\code{#4}}{#1}%
6368   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6369 }
6370
6371 %%% Typed variables:
6372
6373 % @deftypevr category type var args
6374 \makedefun{deftypevr}{\deftypecvgeneral{}}
6375
6376 % @deftypecv category class type var args
6377 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6378
6379 % \deftypecvof {category of}class type var args
6380 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6381
6382 % \deftypecvgeneral {subind}category type var args
6383 %
6384 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6385   \dosubind{vr}{\code{#4}}{#1}%
6386   \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6387 }
6388
6389 %%% Untyped variables:
6390
6391 % @defvr category var args
6392 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6393
6394 % @defcv category class var args
6395 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6396
6397 % \defcvof {category of}class var args
6398 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6399
6400 %%% Type:
6401 % @deftp category name args
6402 \makedefun{deftp}#1 #2 #3\endheader{%
6403   \doind{tp}{\code{#2}}%
6404   \defname{#1}{}{#2}\defunargs{#3\unskip}%
6405 }
6406
6407 % Remaining @defun-like shortcuts:
6408 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6409 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6410 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6411 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6412 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6413 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6414 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6415 \makedefun{defmethod}{\defopon\putwordMethodon}
6416 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6417 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6418 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6419
6420 % \defname, which formats the name of the @def (not the args).
6421 % #1 is the category, such as "Function".
6422 % #2 is the return type, if any.
6423 % #3 is the function name.
6424 %
6425 % We are followed by (but not passed) the arguments, if any.
6426 %
6427 \def\defname#1#2#3{%
6428   % Get the values of \leftskip and \rightskip as they were outside the @def...
6429   \advance\leftskip by -\defbodyindent
6430   %
6431   % How we'll format the type name.  Putting it in brackets helps
6432   % distinguish it from the body text that may end up on the next line
6433   % just below it.
6434   \def\temp{#1}%
6435   \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6436   %
6437   % Figure out line sizes for the paragraph shape.
6438   % The first line needs space for \box0; but if \rightskip is nonzero,
6439   % we need only space for the part of \box0 which exceeds it:
6440   \dimen0=\hsize  \advance\dimen0 by -\wd0  \advance\dimen0 by \rightskip
6441   % The continuations:
6442   \dimen2=\hsize  \advance\dimen2 by -\defargsindent
6443   % (plain.tex says that \dimen1 should be used only as global.)
6444   \parshape 2 0in \dimen0 \defargsindent \dimen2
6445   %
6446   % Put the type name to the right margin.
6447   \noindent
6448   \hbox to 0pt{%
6449     \hfil\box0 \kern-\hsize
6450     % \hsize has to be shortened this way:
6451     \kern\leftskip
6452     % Intentionally do not respect \rightskip, since we need the space.
6453   }%
6454   %
6455   % Allow all lines to be underfull without complaint:
6456   \tolerance=10000 \hbadness=10000
6457   \exdentamount=\defbodyindent
6458   {%
6459     % defun fonts. We use typewriter by default (used to be bold) because:
6460     % . we're printing identifiers, they should be in tt in principle.
6461     % . in languages with many accents, such as Czech or French, it's
6462     %   common to leave accents off identifiers.  The result looks ok in
6463     %   tt, but exceedingly strange in rm.
6464     % . we don't want -- and --- to be treated as ligatures.
6465     % . this still does not fix the ?` and !` ligatures, but so far no
6466     %   one has made identifiers using them :).
6467     \df \tt
6468     \def\temp{#2}% return value type
6469     \ifx\temp\empty\else \tclose{\temp} \fi
6470     #3% output function name
6471   }%
6472   {\rm\enskip}% hskip 0.5 em of \tenrm
6473   %
6474   \boldbrax
6475   % arguments will be output next, if any.
6476 }
6477
6478 % Print arguments in slanted roman (not ttsl), inconsistently with using
6479 % tt for the name.  This is because literal text is sometimes needed in
6480 % the argument list (groff manual), and ttsl and tt are not very
6481 % distinguishable.  Prevent hyphenation at `-' chars.
6482 %
6483 \def\defunargs#1{%
6484   % use sl by default (not ttsl),
6485   % tt for the names.
6486   \df \sl \hyphenchar\font=0
6487   %
6488   % On the other hand, if an argument has two dashes (for instance), we
6489   % want a way to get ttsl.  Let's try @var for that.
6490   \let\var=\ttslanted
6491   #1%
6492   \sl\hyphenchar\font=45
6493 }
6494
6495 % We want ()&[] to print specially on the defun line.
6496 %
6497 \def\activeparens{%
6498   \catcode`\(=\active \catcode`\)=\active
6499   \catcode`\[=\active \catcode`\]=\active
6500   \catcode`\&=\active
6501 }
6502
6503 % Make control sequences which act like normal parenthesis chars.
6504 \let\lparen = ( \let\rparen = )
6505
6506 % Be sure that we always have a definition for `(', etc.  For example,
6507 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6508 % so TeX would otherwise complain about undefined control sequence.
6509 {
6510   \activeparens
6511   \global\let(=\lparen \global\let)=\rparen
6512   \global\let[=\lbrack \global\let]=\rbrack
6513   \global\let& = \&
6514
6515   \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6516   \gdef\magicamp{\let&=\amprm}
6517 }
6518
6519 \newcount\parencount
6520
6521 % If we encounter &foo, then turn on ()-hacking afterwards
6522 \newif\ifampseen
6523 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6524
6525 \def\parenfont{%
6526   \ifampseen
6527     % At the first level, print parens in roman,
6528     % otherwise use the default font.
6529     \ifnum \parencount=1 \rm \fi
6530   \else
6531     % The \sf parens (in \boldbrax) actually are a little bolder than
6532     % the contained text.  This is especially needed for [ and ] .
6533     \sf
6534   \fi
6535 }
6536 \def\infirstlevel#1{%
6537   \ifampseen
6538     \ifnum\parencount=1
6539       #1%
6540     \fi
6541   \fi
6542 }
6543 \def\bfafterword#1 {#1 \bf}
6544
6545 \def\opnr{%
6546   \global\advance\parencount by 1
6547   {\parenfont(}%
6548   \infirstlevel \bfafterword
6549 }
6550 \def\clnr{%
6551   {\parenfont)}%
6552   \infirstlevel \sl
6553   \global\advance\parencount by -1
6554 }
6555
6556 \newcount\brackcount
6557 \def\lbrb{%
6558   \global\advance\brackcount by 1
6559   {\bf[}%
6560 }
6561 \def\rbrb{%
6562   {\bf]}%
6563   \global\advance\brackcount by -1
6564 }
6565
6566 \def\checkparencounts{%
6567   \ifnum\parencount=0 \else \badparencount \fi
6568   \ifnum\brackcount=0 \else \badbrackcount \fi
6569 }
6570 % these should not use \errmessage; the glibc manual, at least, actually
6571 % has such constructs (when documenting function pointers).
6572 \def\badparencount{%
6573   \message{Warning: unbalanced parentheses in @def...}%
6574   \global\parencount=0
6575 }
6576 \def\badbrackcount{%
6577   \message{Warning: unbalanced square brackets in @def...}%
6578   \global\brackcount=0
6579 }
6580
6581
6582 \message{macros,}
6583 % @macro.
6584
6585 % To do this right we need a feature of e-TeX, \scantokens,
6586 % which we arrange to emulate with a temporary file in ordinary TeX.
6587 \ifx\eTeXversion\undefined
6588   \newwrite\macscribble
6589   \def\scantokens#1{%
6590     \toks0={#1}%
6591     \immediate\openout\macscribble=\jobname.tmp
6592     \immediate\write\macscribble{\the\toks0}%
6593     \immediate\closeout\macscribble
6594     \input \jobname.tmp
6595   }
6596 \fi
6597
6598 \def\scanmacro#1{%
6599   \begingroup
6600     \newlinechar`\^^M
6601     \let\xeatspaces\eatspaces
6602     % Undo catcode changes of \startcontents and \doprintindex
6603     % When called from @insertcopying or (short)caption, we need active
6604     % backslash to get it printed correctly.  Previously, we had
6605     % \catcode`\\=\other instead.  We'll see whether a problem appears
6606     % with macro expansion.                             --kasal, 19aug04
6607     \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6608     % ... and \example
6609     \spaceisspace
6610     %
6611     % Append \endinput to make sure that TeX does not see the ending newline.
6612     % I've verified that it is necessary both for e-TeX and for ordinary TeX
6613     %                                                   --kasal, 29nov03
6614     \scantokens{#1\endinput}%
6615   \endgroup
6616 }
6617
6618 \def\scanexp#1{%
6619   \edef\temp{\noexpand\scanmacro{#1}}%
6620   \temp
6621 }
6622
6623 \newcount\paramno   % Count of parameters
6624 \newtoks\macname    % Macro name
6625 \newif\ifrecursive  % Is it recursive?
6626
6627 % List of all defined macros in the form
6628 %    \definedummyword\macro1\definedummyword\macro2...
6629 % Currently is also contains all @aliases; the list can be split
6630 % if there is a need.
6631 \def\macrolist{}
6632
6633 % Add the macro to \macrolist
6634 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6635 \def\addtomacrolistxxx#1{%
6636      \toks0 = \expandafter{\macrolist\definedummyword#1}%
6637      \xdef\macrolist{\the\toks0}%
6638 }
6639
6640 % Utility routines.
6641 % This does \let #1 = #2, with \csnames; that is,
6642 %   \let \csname#1\endcsname = \csname#2\endcsname
6643 % (except of course we have to play expansion games).
6644
6645 \def\cslet#1#2{%
6646   \expandafter\let
6647   \csname#1\expandafter\endcsname
6648   \csname#2\endcsname
6649 }
6650
6651 % Trim leading and trailing spaces off a string.
6652 % Concepts from aro-bend problem 15 (see CTAN).
6653 {\catcode`\@=11
6654 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6655 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6656 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6657 \def\unbrace#1{#1}
6658 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6659 }
6660
6661 % Trim a single trailing ^^M off a string.
6662 {\catcode`\^^M=\other \catcode`\Q=3%
6663 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6664 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6665 \gdef\eatcrb#1Q#2Q{#1}%
6666 }
6667
6668 % Macro bodies are absorbed as an argument in a context where
6669 % all characters are catcode 10, 11 or 12, except \ which is active
6670 % (as in normal texinfo). It is necessary to change the definition of \.
6671
6672 % Non-ASCII encodings make 8-bit characters active, so un-activate
6673 % them to avoid their expansion.  Must do this non-globally, to
6674 % confine the change to the current group.
6675
6676 % It's necessary to have hard CRs when the macro is executed. This is
6677 % done by  making ^^M (\endlinechar) catcode 12 when reading the macro
6678 % body, and then making it the \newlinechar in \scanmacro.
6679
6680 \def\scanctxt{%
6681   \catcode`\"=\other
6682   \catcode`\+=\other
6683   \catcode`\<=\other
6684   \catcode`\>=\other
6685   \catcode`\@=\other
6686   \catcode`\^=\other
6687   \catcode`\_=\other
6688   \catcode`\|=\other
6689   \catcode`\~=\other
6690   \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6691 }
6692
6693 \def\scanargctxt{%
6694   \scanctxt
6695   \catcode`\\=\other
6696   \catcode`\^^M=\other
6697 }
6698
6699 \def\macrobodyctxt{%
6700   \scanctxt
6701   \catcode`\{=\other
6702   \catcode`\}=\other
6703   \catcode`\^^M=\other
6704   \usembodybackslash
6705 }
6706
6707 \def\macroargctxt{%
6708   \scanctxt
6709   \catcode`\\=\other
6710 }
6711
6712 % \mbodybackslash is the definition of \ in @macro bodies.
6713 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6714 % where N is the macro parameter number.
6715 % We define \csname macarg.\endcsname to be \realbackslash, so
6716 % \\ in macro replacement text gets you a backslash.
6717
6718 {\catcode`@=0 @catcode`@\=@active
6719  @gdef@usembodybackslash{@let\=@mbodybackslash}
6720  @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6721 }
6722 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6723
6724 \def\macro{\recursivefalse\parsearg\macroxxx}
6725 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6726
6727 \def\macroxxx#1{%
6728   \getargs{#1}%           now \macname is the macname and \argl the arglist
6729   \ifx\argl\empty       % no arguments
6730      \paramno=0%
6731   \else
6732      \expandafter\parsemargdef \argl;%
6733   \fi
6734   \if1\csname ismacro.\the\macname\endcsname
6735      \message{Warning: redefining \the\macname}%
6736   \else
6737      \expandafter\ifx\csname \the\macname\endcsname \relax
6738      \else \errmessage{Macro name \the\macname\space already defined}\fi
6739      \global\cslet{macsave.\the\macname}{\the\macname}%
6740      \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6741      \addtomacrolist{\the\macname}%
6742   \fi
6743   \begingroup \macrobodyctxt
6744   \ifrecursive \expandafter\parsermacbody
6745   \else \expandafter\parsemacbody
6746   \fi}
6747
6748 \parseargdef\unmacro{%
6749   \if1\csname ismacro.#1\endcsname
6750     \global\cslet{#1}{macsave.#1}%
6751     \global\expandafter\let \csname ismacro.#1\endcsname=0%
6752     % Remove the macro name from \macrolist:
6753     \begingroup
6754       \expandafter\let\csname#1\endcsname \relax
6755       \let\definedummyword\unmacrodo
6756       \xdef\macrolist{\macrolist}%
6757     \endgroup
6758   \else
6759     \errmessage{Macro #1 not defined}%
6760   \fi
6761 }
6762
6763 % Called by \do from \dounmacro on each macro.  The idea is to omit any
6764 % macro definitions that have been changed to \relax.
6765 %
6766 \def\unmacrodo#1{%
6767   \ifx #1\relax
6768     % remove this
6769   \else
6770     \noexpand\definedummyword \noexpand#1%
6771   \fi
6772 }
6773
6774 % This makes use of the obscure feature that if the last token of a
6775 % <parameter list> is #, then the preceding argument is delimited by
6776 % an opening brace, and that opening brace is not consumed.
6777 \def\getargs#1{\getargsxxx#1{}}
6778 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6779 \def\getmacname #1 #2\relax{\macname={#1}}
6780 \def\getmacargs#1{\def\argl{#1}}
6781
6782 % Parse the optional {params} list.  Set up \paramno and \paramlist
6783 % so \defmacro knows what to do.  Define \macarg.blah for each blah
6784 % in the params list, to be ##N where N is the position in that list.
6785 % That gets used by \mbodybackslash (above).
6786
6787 % We need to get `macro parameter char #' into several definitions.
6788 % The technique used is stolen from LaTeX:  let \hash be something
6789 % unexpandable, insert that wherever you need a #, and then redefine
6790 % it to # just before using the token list produced.
6791 %
6792 % The same technique is used to protect \eatspaces till just before
6793 % the macro is used.
6794
6795 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6796         \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6797 \def\parsemargdefxxx#1,{%
6798   \if#1;\let\next=\relax
6799   \else \let\next=\parsemargdefxxx
6800     \advance\paramno by 1%
6801     \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6802         {\xeatspaces{\hash\the\paramno}}%
6803     \edef\paramlist{\paramlist\hash\the\paramno,}%
6804   \fi\next}
6805
6806 % These two commands read recursive and nonrecursive macro bodies.
6807 % (They're different since rec and nonrec macros end differently.)
6808
6809 \long\def\parsemacbody#1@end macro%
6810 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6811 \long\def\parsermacbody#1@end rmacro%
6812 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6813
6814 % This defines the macro itself. There are six cases: recursive and
6815 % nonrecursive macros of zero, one, and many arguments.
6816 % Much magic with \expandafter here.
6817 % \xdef is used so that macro definitions will survive the file
6818 % they're defined in; @include reads the file inside a group.
6819 \def\defmacro{%
6820   \let\hash=##% convert placeholders to macro parameter chars
6821   \ifrecursive
6822     \ifcase\paramno
6823     % 0
6824       \expandafter\xdef\csname\the\macname\endcsname{%
6825         \noexpand\scanmacro{\temp}}%
6826     \or % 1
6827       \expandafter\xdef\csname\the\macname\endcsname{%
6828          \bgroup\noexpand\macroargctxt
6829          \noexpand\braceorline
6830          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6831       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6832          \egroup\noexpand\scanmacro{\temp}}%
6833     \else % many
6834       \expandafter\xdef\csname\the\macname\endcsname{%
6835          \bgroup\noexpand\macroargctxt
6836          \noexpand\csname\the\macname xx\endcsname}%
6837       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6838           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6839       \expandafter\expandafter
6840       \expandafter\xdef
6841       \expandafter\expandafter
6842         \csname\the\macname xxx\endcsname
6843           \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6844     \fi
6845   \else
6846     \ifcase\paramno
6847     % 0
6848       \expandafter\xdef\csname\the\macname\endcsname{%
6849         \noexpand\norecurse{\the\macname}%
6850         \noexpand\scanmacro{\temp}\egroup}%
6851     \or % 1
6852       \expandafter\xdef\csname\the\macname\endcsname{%
6853          \bgroup\noexpand\macroargctxt
6854          \noexpand\braceorline
6855          \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6856       \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6857         \egroup
6858         \noexpand\norecurse{\the\macname}%
6859         \noexpand\scanmacro{\temp}\egroup}%
6860     \else % many
6861       \expandafter\xdef\csname\the\macname\endcsname{%
6862          \bgroup\noexpand\macroargctxt
6863          \expandafter\noexpand\csname\the\macname xx\endcsname}%
6864       \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6865           \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6866       \expandafter\expandafter
6867       \expandafter\xdef
6868       \expandafter\expandafter
6869       \csname\the\macname xxx\endcsname
6870       \paramlist{%
6871           \egroup
6872           \noexpand\norecurse{\the\macname}%
6873           \noexpand\scanmacro{\temp}\egroup}%
6874     \fi
6875   \fi}
6876
6877 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6878
6879 % \braceorline decides whether the next nonwhitespace character is a
6880 % {.  If so it reads up to the closing }, if not, it reads the whole
6881 % line.  Whatever was read is then fed to the next control sequence
6882 % as an argument (by \parsebrace or \parsearg)
6883 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6884 \def\braceorlinexxx{%
6885   \ifx\nchar\bgroup\else
6886     \expandafter\parsearg
6887   \fi \macnamexxx}
6888
6889
6890 % @alias.
6891 % We need some trickery to remove the optional spaces around the equal
6892 % sign.  Just make them active and then expand them all to nothing.
6893 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6894 \def\aliasxxx #1{\aliasyyy#1\relax}
6895 \def\aliasyyy #1=#2\relax{%
6896   {%
6897     \expandafter\let\obeyedspace=\empty
6898     \addtomacrolist{#1}%
6899     \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6900   }%
6901   \next
6902 }
6903
6904
6905 \message{cross references,}
6906
6907 \newwrite\auxfile
6908 \newif\ifhavexrefs    % True if xref values are known.
6909 \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
6910
6911 % @inforef is relatively simple.
6912 \def\inforef #1{\inforefzzz #1,,,,**}
6913 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6914   node \samp{\ignorespaces#1{}}}
6915
6916 % @node's only job in TeX is to define \lastnode, which is used in
6917 % cross-references.  The @node line might or might not have commas, and
6918 % might or might not have spaces before the first comma, like:
6919 % @node foo , bar , ...
6920 % We don't want such trailing spaces in the node name.
6921 %
6922 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6923 %
6924 % also remove a trailing comma, in case of something like this:
6925 % @node Help-Cross,  ,  , Cross-refs
6926 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6927 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6928
6929 \let\nwnode=\node
6930 \let\lastnode=\empty
6931
6932 % Write a cross-reference definition for the current node.  #1 is the
6933 % type (Ynumbered, Yappendix, Ynothing).
6934 %
6935 \def\donoderef#1{%
6936   \ifx\lastnode\empty\else
6937     \setref{\lastnode}{#1}%
6938     \global\let\lastnode=\empty
6939   \fi
6940 }
6941
6942 % @anchor{NAME} -- define xref target at arbitrary point.
6943 %
6944 \newcount\savesfregister
6945 %
6946 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6947 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6948 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6949
6950 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6951 % anchor), which consists of three parts:
6952 % 1) NAME-title - the current sectioning name taken from \lastsection,
6953 %                 or the anchor name.
6954 % 2) NAME-snt   - section number and type, passed as the SNT arg, or
6955 %                 empty for anchors.
6956 % 3) NAME-pg    - the page number.
6957 %
6958 % This is called from \donoderef, \anchor, and \dofloat.  In the case of
6959 % floats, there is an additional part, which is not written here:
6960 % 4) NAME-lof   - the text as it should appear in a @listoffloats.
6961 %
6962 \def\setref#1#2{%
6963   \pdfmkdest{#1}%
6964   \iflinks
6965     {%
6966       \atdummies  % preserve commands, but don't expand them
6967       \edef\writexrdef##1##2{%
6968         \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6969           ##1}{##2}}% these are parameters of \writexrdef
6970       }%
6971       \toks0 = \expandafter{\lastsection}%
6972       \immediate \writexrdef{title}{\the\toks0 }%
6973       \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6974       \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6975     }%
6976   \fi
6977 }
6978
6979 % @xref, @pxref, and @ref generate cross-references.  For \xrefX, #1 is
6980 % the node name, #2 the name of the Info cross-reference, #3 the printed
6981 % node name, #4 the name of the Info file, #5 the name of the printed
6982 % manual.  All but the node name can be omitted.
6983 %
6984 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6985 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6986 \def\ref#1{\xrefX[#1,,,,,,,]}
6987 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6988   \unsepspaces
6989   \def\printedmanual{\ignorespaces #5}%
6990   \def\printedrefname{\ignorespaces #3}%
6991   \setbox1=\hbox{\printedmanual\unskip}%
6992   \setbox0=\hbox{\printedrefname\unskip}%
6993   \ifdim \wd0 = 0pt
6994     % No printed node name was explicitly given.
6995     \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6996       % Use the node name inside the square brackets.
6997       \def\printedrefname{\ignorespaces #1}%
6998     \else
6999       % Use the actual chapter/section title appear inside
7000       % the square brackets.  Use the real section title if we have it.
7001       \ifdim \wd1 > 0pt
7002         % It is in another manual, so we don't have it.
7003         \def\printedrefname{\ignorespaces #1}%
7004       \else
7005         \ifhavexrefs
7006           % We know the real title if we have the xref values.
7007           \def\printedrefname{\refx{#1-title}{}}%
7008         \else
7009           % Otherwise just copy the Info node name.
7010           \def\printedrefname{\ignorespaces #1}%
7011         \fi%
7012       \fi
7013     \fi
7014   \fi
7015   %
7016   % Make link in pdf output.
7017   \ifpdf
7018     {\indexnofonts
7019      \turnoffactive
7020      % This expands tokens, so do it after making catcode changes, so _
7021      % etc. don't get their TeX definitions.
7022      \getfilename{#4}%
7023      %
7024      % See comments at \activebackslashdouble.
7025      {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7026       \backslashparens\pdfxrefdest}%
7027      %
7028      \leavevmode
7029      \startlink attr{/Border [0 0 0]}%
7030      \ifnum\filenamelength>0
7031        goto file{\the\filename.pdf} name{\pdfxrefdest}%
7032      \else
7033        goto name{\pdfmkpgn{\pdfxrefdest}}%
7034      \fi
7035     }%
7036     \setcolor{\linkcolor}%
7037   \fi
7038   %
7039   % Float references are printed completely differently: "Figure 1.2"
7040   % instead of "[somenode], p.3".  We distinguish them by the
7041   % LABEL-title being set to a magic string.
7042   {%
7043     % Have to otherify everything special to allow the \csname to
7044     % include an _ in the xref name, etc.
7045     \indexnofonts
7046     \turnoffactive
7047     \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7048       \csname XR#1-title\endcsname
7049   }%
7050   \iffloat\Xthisreftitle
7051     % If the user specified the print name (third arg) to the ref,
7052     % print it instead of our usual "Figure 1.2".
7053     \ifdim\wd0 = 0pt
7054       \refx{#1-snt}{}%
7055     \else
7056       \printedrefname
7057     \fi
7058     %
7059     % if the user also gave the printed manual name (fifth arg), append
7060     % "in MANUALNAME".
7061     \ifdim \wd1 > 0pt
7062       \space \putwordin{} \cite{\printedmanual}%
7063     \fi
7064   \else
7065     % node/anchor (non-float) references.
7066     %
7067     % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7068     % insert empty discretionaries after hyphens, which means that it will
7069     % not find a line break at a hyphen in a node names.  Since some manuals
7070     % are best written with fairly long node names, containing hyphens, this
7071     % is a loss.  Therefore, we give the text of the node name again, so it
7072     % is as if TeX is seeing it for the first time.
7073     \ifdim \wd1 > 0pt
7074       \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7075     \else
7076       % _ (for example) has to be the character _ for the purposes of the
7077       % control sequence corresponding to the node, but it has to expand
7078       % into the usual \leavevmode...\vrule stuff for purposes of
7079       % printing. So we \turnoffactive for the \refx-snt, back on for the
7080       % printing, back off for the \refx-pg.
7081       {\turnoffactive
7082        % Only output a following space if the -snt ref is nonempty; for
7083        % @unnumbered and @anchor, it won't be.
7084        \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7085        \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7086       }%
7087       % output the `[mynode]' via a macro so it can be overridden.
7088       \xrefprintnodename\printedrefname
7089       %
7090       % But we always want a comma and a space:
7091       ,\space
7092       %
7093       % output the `page 3'.
7094       \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7095     \fi
7096   \fi
7097   \endlink
7098 \endgroup}
7099
7100 % This macro is called from \xrefX for the `[nodename]' part of xref
7101 % output.  It's a separate macro only so it can be changed more easily,
7102 % since square brackets don't work well in some documents.  Particularly
7103 % one that Bob is working on :).
7104 %
7105 \def\xrefprintnodename#1{[#1]}
7106
7107 % Things referred to by \setref.
7108 %
7109 \def\Ynothing{}
7110 \def\Yomitfromtoc{}
7111 \def\Ynumbered{%
7112   \ifnum\secno=0
7113     \putwordChapter@tie \the\chapno
7114   \else \ifnum\subsecno=0
7115     \putwordSection@tie \the\chapno.\the\secno
7116   \else \ifnum\subsubsecno=0
7117     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7118   \else
7119     \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7120   \fi\fi\fi
7121 }
7122 \def\Yappendix{%
7123   \ifnum\secno=0
7124      \putwordAppendix@tie @char\the\appendixno{}%
7125   \else \ifnum\subsecno=0
7126      \putwordSection@tie @char\the\appendixno.\the\secno
7127   \else \ifnum\subsubsecno=0
7128     \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7129   \else
7130     \putwordSection@tie
7131       @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7132   \fi\fi\fi
7133 }
7134
7135 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7136 % If its value is nonempty, SUFFIX is output afterward.
7137 %
7138 \def\refx#1#2{%
7139   {%
7140     \indexnofonts
7141     \otherbackslash
7142     \expandafter\global\expandafter\let\expandafter\thisrefX
7143       \csname XR#1\endcsname
7144   }%
7145   \ifx\thisrefX\relax
7146     % If not defined, say something at least.
7147     \angleleft un\-de\-fined\angleright
7148     \iflinks
7149       \ifhavexrefs
7150         \message{\linenumber Undefined cross reference `#1'.}%
7151       \else
7152         \ifwarnedxrefs\else
7153           \global\warnedxrefstrue
7154           \message{Cross reference values unknown; you must run TeX again.}%
7155         \fi
7156       \fi
7157     \fi
7158   \else
7159     % It's defined, so just use it.
7160     \thisrefX
7161   \fi
7162   #2% Output the suffix in any case.
7163 }
7164
7165 % This is the macro invoked by entries in the aux file.  Usually it's
7166 % just a \def (we prepend XR to the control sequence name to avoid
7167 % collisions).  But if this is a float type, we have more work to do.
7168 %
7169 \def\xrdef#1#2{%
7170   {% The node name might contain 8-bit characters, which in our current
7171    % implementation are changed to commands like @'e.  Don't let these
7172    % mess up the control sequence name.
7173     \indexnofonts
7174     \turnoffactive
7175     \xdef\safexrefname{#1}%
7176   }%
7177   %
7178   \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7179   %
7180   % Was that xref control sequence that we just defined for a float?
7181   \expandafter\iffloat\csname XR\safexrefname\endcsname
7182     % it was a float, and we have the (safe) float type in \iffloattype.
7183     \expandafter\let\expandafter\floatlist
7184       \csname floatlist\iffloattype\endcsname
7185     %
7186     % Is this the first time we've seen this float type?
7187     \expandafter\ifx\floatlist\relax
7188       \toks0 = {\do}% yes, so just \do
7189     \else
7190       % had it before, so preserve previous elements in list.
7191       \toks0 = \expandafter{\floatlist\do}%
7192     \fi
7193     %
7194     % Remember this xref in the control sequence \floatlistFLOATTYPE,
7195     % for later use in \listoffloats.
7196     \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7197       {\safexrefname}}%
7198   \fi
7199 }
7200
7201 % Read the last existing aux file, if any.  No error if none exists.
7202 %
7203 \def\tryauxfile{%
7204   \openin 1 \jobname.aux
7205   \ifeof 1 \else
7206     \readdatafile{aux}%
7207     \global\havexrefstrue
7208   \fi
7209   \closein 1
7210 }
7211
7212 \def\setupdatafile{%
7213   \catcode`\^^@=\other
7214   \catcode`\^^A=\other
7215   \catcode`\^^B=\other
7216   \catcode`\^^C=\other
7217   \catcode`\^^D=\other
7218   \catcode`\^^E=\other
7219   \catcode`\^^F=\other
7220   \catcode`\^^G=\other
7221   \catcode`\^^H=\other
7222   \catcode`\^^K=\other
7223   \catcode`\^^L=\other
7224   \catcode`\^^N=\other
7225   \catcode`\^^P=\other
7226   \catcode`\^^Q=\other
7227   \catcode`\^^R=\other
7228   \catcode`\^^S=\other
7229   \catcode`\^^T=\other
7230   \catcode`\^^U=\other
7231   \catcode`\^^V=\other
7232   \catcode`\^^W=\other
7233   \catcode`\^^X=\other
7234   \catcode`\^^Z=\other
7235   \catcode`\^^[=\other
7236   \catcode`\^^\=\other
7237   \catcode`\^^]=\other
7238   \catcode`\^^^=\other
7239   \catcode`\^^_=\other
7240   % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7241   % in xref tags, i.e., node names.  But since ^^e4 notation isn't
7242   % supported in the main text, it doesn't seem desirable.  Furthermore,
7243   % that is not enough: for node names that actually contain a ^
7244   % character, we would end up writing a line like this: 'xrdef {'hat
7245   % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7246   % argument, and \hat is not an expandable control sequence.  It could
7247   % all be worked out, but why?  Either we support ^^ or we don't.
7248   %
7249   % The other change necessary for this was to define \auxhat:
7250   % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7251   % and then to call \auxhat in \setq.
7252   %
7253   \catcode`\^=\other
7254   %
7255   % Special characters.  Should be turned off anyway, but...
7256   \catcode`\~=\other
7257   \catcode`\[=\other
7258   \catcode`\]=\other
7259   \catcode`\"=\other
7260   \catcode`\_=\other
7261   \catcode`\|=\other
7262   \catcode`\<=\other
7263   \catcode`\>=\other
7264   \catcode`\$=\other
7265   \catcode`\#=\other
7266   \catcode`\&=\other
7267   \catcode`\%=\other
7268   \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7269   %
7270   % This is to support \ in node names and titles, since the \
7271   % characters end up in a \csname.  It's easier than
7272   % leaving it active and making its active definition an actual \
7273   % character.  What I don't understand is why it works in the *value*
7274   % of the xrdef.  Seems like it should be a catcode12 \, and that
7275   % should not typeset properly.  But it works, so I'm moving on for
7276   % now.  --karl, 15jan04.
7277   \catcode`\\=\other
7278   %
7279   % Make the characters 128-255 be printing characters.
7280   {%
7281     \count1=128
7282     \def\loop{%
7283       \catcode\count1=\other
7284       \advance\count1 by 1
7285       \ifnum \count1<256 \loop \fi
7286     }%
7287   }%
7288   %
7289   % @ is our escape character in .aux files, and we need braces.
7290   \catcode`\{=1
7291   \catcode`\}=2
7292   \catcode`\@=0
7293 }
7294
7295 \def\readdatafile#1{%
7296 \begingroup
7297   \setupdatafile
7298   \input\jobname.#1
7299 \endgroup}
7300
7301
7302 \message{insertions,}
7303 % including footnotes.
7304
7305 \newcount \footnoteno
7306
7307 % The trailing space in the following definition for supereject is
7308 % vital for proper filling; pages come out unaligned when you do a
7309 % pagealignmacro call if that space before the closing brace is
7310 % removed. (Generally, numeric constants should always be followed by a
7311 % space to prevent strange expansion errors.)
7312 \def\supereject{\par\penalty -20000\footnoteno =0 }
7313
7314 % @footnotestyle is meaningful for info output only.
7315 \let\footnotestyle=\comment
7316
7317 {\catcode `\@=11
7318 %
7319 % Auto-number footnotes.  Otherwise like plain.
7320 \gdef\footnote{%
7321   \let\indent=\ptexindent
7322   \let\noindent=\ptexnoindent
7323   \global\advance\footnoteno by \@ne
7324   \edef\thisfootno{$^{\the\footnoteno}$}%
7325   %
7326   % In case the footnote comes at the end of a sentence, preserve the
7327   % extra spacing after we do the footnote number.
7328   \let\@sf\empty
7329   \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7330   %
7331   % Remove inadvertent blank space before typesetting the footnote number.
7332   \unskip
7333   \thisfootno\@sf
7334   \dofootnote
7335 }%
7336
7337 % Don't bother with the trickery in plain.tex to not require the
7338 % footnote text as a parameter.  Our footnotes don't need to be so general.
7339 %
7340 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7341 % \parseargline) fails inside footnotes because the tokens are fixed when
7342 % the footnote is read.  --karl, 16nov96.
7343 %
7344 \gdef\dofootnote{%
7345   \insert\footins\bgroup
7346   % We want to typeset this text as a normal paragraph, even if the
7347   % footnote reference occurs in (for example) a display environment.
7348   % So reset some parameters.
7349   \hsize=\pagewidth
7350   \interlinepenalty\interfootnotelinepenalty
7351   \splittopskip\ht\strutbox % top baseline for broken footnotes
7352   \splitmaxdepth\dp\strutbox
7353   \floatingpenalty\@MM
7354   \leftskip\z@skip
7355   \rightskip\z@skip
7356   \spaceskip\z@skip
7357   \xspaceskip\z@skip
7358   \parindent\defaultparindent
7359   %
7360   \smallfonts \rm
7361   %
7362   % Because we use hanging indentation in footnotes, a @noindent appears
7363   % to exdent this text, so make it be a no-op.  makeinfo does not use
7364   % hanging indentation so @noindent can still be needed within footnote
7365   % text after an @example or the like (not that this is good style).
7366   \let\noindent = \relax
7367   %
7368   % Hang the footnote text off the number.  Use \everypar in case the
7369   % footnote extends for more than one paragraph.
7370   \everypar = {\hang}%
7371   \textindent{\thisfootno}%
7372   %
7373   % Don't crash into the line above the footnote text.  Since this
7374   % expands into a box, it must come within the paragraph, lest it
7375   % provide a place where TeX can split the footnote.
7376   \footstrut
7377   \futurelet\next\fo@t
7378 }
7379 }%end \catcode `\@=11
7380
7381 % In case a @footnote appears in a vbox, save the footnote text and create
7382 % the real \insert just after the vbox finished.  Otherwise, the insertion
7383 % would be lost.
7384 % Similarly, if a @footnote appears inside an alignment, save the footnote
7385 % text to a box and make the \insert when a row of the table is finished.
7386 % And the same can be done for other insert classes.  --kasal, 16nov03.
7387
7388 % Replace the \insert primitive by a cheating macro.
7389 % Deeper inside, just make sure that the saved insertions are not spilled
7390 % out prematurely.
7391 %
7392 \def\startsavinginserts{%
7393   \ifx \insert\ptexinsert
7394     \let\insert\saveinsert
7395   \else
7396     \let\checkinserts\relax
7397   \fi
7398 }
7399
7400 % This \insert replacement works for both \insert\footins{foo} and
7401 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7402 %
7403 \def\saveinsert#1{%
7404   \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7405   \afterassignment\next
7406   % swallow the left brace
7407   \let\temp =
7408 }
7409 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7410 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7411
7412 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7413
7414 \def\placesaveins#1{%
7415   \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7416     {\box#1}%
7417 }
7418
7419 % eat @SAVE -- beware, all of them have catcode \other:
7420 {
7421   \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials  %  ;-)
7422   \gdef\gobblesave @SAVE{}
7423 }
7424
7425 % initialization:
7426 \def\newsaveins #1{%
7427   \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7428   \next
7429 }
7430 \def\newsaveinsX #1{%
7431   \csname newbox\endcsname #1%
7432   \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7433     \checksaveins #1}%
7434 }
7435
7436 % initialize:
7437 \let\checkinserts\empty
7438 \newsaveins\footins
7439 \newsaveins\margin
7440
7441
7442 % @image.  We use the macros from epsf.tex to support this.
7443 % If epsf.tex is not installed and @image is used, we complain.
7444 %
7445 % Check for and read epsf.tex up front.  If we read it only at @image
7446 % time, we might be inside a group, and then its definitions would get
7447 % undone and the next image would fail.
7448 \openin 1 = epsf.tex
7449 \ifeof 1 \else
7450   % Do not bother showing banner with epsf.tex v2.7k (available in
7451   % doc/epsf.tex and on ctan).
7452   \def\epsfannounce{\toks0 = }%
7453   \input epsf.tex
7454 \fi
7455 \closein 1
7456 %
7457 % We will only complain once about lack of epsf.tex.
7458 \newif\ifwarnednoepsf
7459 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7460   work.  It is also included in the Texinfo distribution, or you can get
7461   it from ftp://tug.org/tex/epsf.tex.}
7462 %
7463 \def\image#1{%
7464   \ifx\epsfbox\undefined
7465     \ifwarnednoepsf \else
7466       \errhelp = \noepsfhelp
7467       \errmessage{epsf.tex not found, images will be ignored}%
7468       \global\warnednoepsftrue
7469     \fi
7470   \else
7471     \imagexxx #1,,,,,\finish
7472   \fi
7473 }
7474 %
7475 % Arguments to @image:
7476 % #1 is (mandatory) image filename; we tack on .eps extension.
7477 % #2 is (optional) width, #3 is (optional) height.
7478 % #4 is (ignored optional) html alt text.
7479 % #5 is (ignored optional) extension.
7480 % #6 is just the usual extra ignored arg for parsing this stuff.
7481 \newif\ifimagevmode
7482 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7483   \catcode`\^^M = 5     % in case we're inside an example
7484   \normalturnoffactive  % allow _ et al. in names
7485   % If the image is by itself, center it.
7486   \ifvmode
7487     \imagevmodetrue
7488     \nobreak\medskip
7489     % Usually we'll have text after the image which will insert
7490     % \parskip glue, so insert it here too to equalize the space
7491     % above and below.
7492     \nobreak\vskip\parskip
7493     \nobreak
7494   \fi
7495   %
7496   % Leave vertical mode so that indentation from an enclosing
7497   % environment such as @quotation is respected.  On the other hand, if
7498   % it's at the top level, we don't want the normal paragraph indentation.
7499   \noindent
7500   %
7501   % Output the image.
7502   \ifpdf
7503     \dopdfimage{#1}{#2}{#3}%
7504   \else
7505     % \epsfbox itself resets \epsf?size at each figure.
7506     \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7507     \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7508     \epsfbox{#1.eps}%
7509   \fi
7510   %
7511   \ifimagevmode \medskip \fi  % space after the standalone image
7512 \endgroup}
7513
7514
7515 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7516 % etc.  We don't actually implement floating yet, we always include the
7517 % float "here".  But it seemed the best name for the future.
7518 %
7519 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7520
7521 % There may be a space before second and/or third parameter; delete it.
7522 \def\eatcommaspace#1, {#1,}
7523
7524 % #1 is the optional FLOATTYPE, the text label for this float, typically
7525 % "Figure", "Table", "Example", etc.  Can't contain commas.  If omitted,
7526 % this float will not be numbered and cannot be referred to.
7527 %
7528 % #2 is the optional xref label.  Also must be present for the float to
7529 % be referable.
7530 %
7531 % #3 is the optional positioning argument; for now, it is ignored.  It
7532 % will somehow specify the positions allowed to float to (here, top, bottom).
7533 %
7534 % We keep a separate counter for each FLOATTYPE, which we reset at each
7535 % chapter-level command.
7536 \let\resetallfloatnos=\empty
7537 %
7538 \def\dofloat#1,#2,#3,#4\finish{%
7539   \let\thiscaption=\empty
7540   \let\thisshortcaption=\empty
7541   %
7542   % don't lose footnotes inside @float.
7543   %
7544   % BEWARE: when the floats start float, we have to issue warning whenever an
7545   % insert appears inside a float which could possibly float. --kasal, 26may04
7546   %
7547   \startsavinginserts
7548   %
7549   % We can't be used inside a paragraph.
7550   \par
7551   %
7552   \vtop\bgroup
7553     \def\floattype{#1}%
7554     \def\floatlabel{#2}%
7555     \def\floatloc{#3}% we do nothing with this yet.
7556     %
7557     \ifx\floattype\empty
7558       \let\safefloattype=\empty
7559     \else
7560       {%
7561         % the floattype might have accents or other special characters,
7562         % but we need to use it in a control sequence name.
7563         \indexnofonts
7564         \turnoffactive
7565         \xdef\safefloattype{\floattype}%
7566       }%
7567     \fi
7568     %
7569     % If label is given but no type, we handle that as the empty type.
7570     \ifx\floatlabel\empty \else
7571       % We want each FLOATTYPE to be numbered separately (Figure 1,
7572       % Table 1, Figure 2, ...).  (And if no label, no number.)
7573       %
7574       \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7575       \global\advance\floatno by 1
7576       %
7577       {%
7578         % This magic value for \lastsection is output by \setref as the
7579         % XREFLABEL-title value.  \xrefX uses it to distinguish float
7580         % labels (which have a completely different output format) from
7581         % node and anchor labels.  And \xrdef uses it to construct the
7582         % lists of floats.
7583         %
7584         \edef\lastsection{\floatmagic=\safefloattype}%
7585         \setref{\floatlabel}{Yfloat}%
7586       }%
7587     \fi
7588     %
7589     % start with \parskip glue, I guess.
7590     \vskip\parskip
7591     %
7592     % Don't suppress indentation if a float happens to start a section.
7593     \restorefirstparagraphindent
7594 }
7595
7596 % we have these possibilities:
7597 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7598 % @float Foo,lbl & no caption:    Foo 1.1
7599 % @float Foo & @caption{Cap}:     Foo: Cap
7600 % @float Foo & no caption:        Foo
7601 % @float ,lbl & Caption{Cap}:     1.1: Cap
7602 % @float ,lbl & no caption:       1.1
7603 % @float & @caption{Cap}:         Cap
7604 % @float & no caption:
7605 %
7606 \def\Efloat{%
7607     \let\floatident = \empty
7608     %
7609     % In all cases, if we have a float type, it comes first.
7610     \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7611     %
7612     % If we have an xref label, the number comes next.
7613     \ifx\floatlabel\empty \else
7614       \ifx\floattype\empty \else % if also had float type, need tie first.
7615         \appendtomacro\floatident{\tie}%
7616       \fi
7617       % the number.
7618       \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7619     \fi
7620     %
7621     % Start the printed caption with what we've constructed in
7622     % \floatident, but keep it separate; we need \floatident again.
7623     \let\captionline = \floatident
7624     %
7625     \ifx\thiscaption\empty \else
7626       \ifx\floatident\empty \else
7627         \appendtomacro\captionline{: }% had ident, so need a colon between
7628       \fi
7629       %
7630       % caption text.
7631       \appendtomacro\captionline{\scanexp\thiscaption}%
7632     \fi
7633     %
7634     % If we have anything to print, print it, with space before.
7635     % Eventually this needs to become an \insert.
7636     \ifx\captionline\empty \else
7637       \vskip.5\parskip
7638       \captionline
7639       %
7640       % Space below caption.
7641       \vskip\parskip
7642     \fi
7643     %
7644     % If have an xref label, write the list of floats info.  Do this
7645     % after the caption, to avoid chance of it being a breakpoint.
7646     \ifx\floatlabel\empty \else
7647       % Write the text that goes in the lof to the aux file as
7648       % \floatlabel-lof.  Besides \floatident, we include the short
7649       % caption if specified, else the full caption if specified, else nothing.
7650       {%
7651         \atdummies
7652         %
7653         % since we read the caption text in the macro world, where ^^M
7654         % is turned into a normal character, we have to scan it back, so
7655         % we don't write the literal three characters "^^M" into the aux file.
7656         \scanexp{%
7657           \xdef\noexpand\gtemp{%
7658             \ifx\thisshortcaption\empty
7659               \thiscaption
7660             \else
7661               \thisshortcaption
7662             \fi
7663           }%
7664         }%
7665         \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7666           \ifx\gtemp\empty \else : \gtemp \fi}}%
7667       }%
7668     \fi
7669   \egroup  % end of \vtop
7670   %
7671   % place the captured inserts
7672   %
7673   % BEWARE: when the floats start floating, we have to issue warning
7674   % whenever an insert appears inside a float which could possibly
7675   % float. --kasal, 26may04
7676   %
7677   \checkinserts
7678 }
7679
7680 % Append the tokens #2 to the definition of macro #1, not expanding either.
7681 %
7682 \def\appendtomacro#1#2{%
7683   \expandafter\def\expandafter#1\expandafter{#1#2}%
7684 }
7685
7686 % @caption, @shortcaption
7687 %
7688 \def\caption{\docaption\thiscaption}
7689 \def\shortcaption{\docaption\thisshortcaption}
7690 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7691 \def\defcaption#1#2{\egroup \def#1{#2}}
7692
7693 % The parameter is the control sequence identifying the counter we are
7694 % going to use.  Create it if it doesn't exist and assign it to \floatno.
7695 \def\getfloatno#1{%
7696   \ifx#1\relax
7697       % Haven't seen this figure type before.
7698       \csname newcount\endcsname #1%
7699       %
7700       % Remember to reset this floatno at the next chap.
7701       \expandafter\gdef\expandafter\resetallfloatnos
7702         \expandafter{\resetallfloatnos #1=0 }%
7703   \fi
7704   \let\floatno#1%
7705 }
7706
7707 % \setref calls this to get the XREFLABEL-snt value.  We want an @xref
7708 % to the FLOATLABEL to expand to "Figure 3.1".  We call \setref when we
7709 % first read the @float command.
7710 %
7711 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7712
7713 % Magic string used for the XREFLABEL-title value, so \xrefX can
7714 % distinguish floats from other xref types.
7715 \def\floatmagic{!!float!!}
7716
7717 % #1 is the control sequence we are passed; we expand into a conditional
7718 % which is true if #1 represents a float ref.  That is, the magic
7719 % \lastsection value which we \setref above.
7720 %
7721 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7722 %
7723 % #1 is (maybe) the \floatmagic string.  If so, #2 will be the
7724 % (safe) float type for this float.  We set \iffloattype to #2.
7725 %
7726 \def\doiffloat#1=#2=#3\finish{%
7727   \def\temp{#1}%
7728   \def\iffloattype{#2}%
7729   \ifx\temp\floatmagic
7730 }
7731
7732 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7733 %
7734 \parseargdef\listoffloats{%
7735   \def\floattype{#1}% floattype
7736   {%
7737     % the floattype might have accents or other special characters,
7738     % but we need to use it in a control sequence name.
7739     \indexnofonts
7740     \turnoffactive
7741     \xdef\safefloattype{\floattype}%
7742   }%
7743   %
7744   % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7745   \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7746     \ifhavexrefs
7747       % if the user said @listoffloats foo but never @float foo.
7748       \message{\linenumber No `\safefloattype' floats to list.}%
7749     \fi
7750   \else
7751     \begingroup
7752       \leftskip=\tocindent  % indent these entries like a toc
7753       \let\do=\listoffloatsdo
7754       \csname floatlist\safefloattype\endcsname
7755     \endgroup
7756   \fi
7757 }
7758
7759 % This is called on each entry in a list of floats.  We're passed the
7760 % xref label, in the form LABEL-title, which is how we save it in the
7761 % aux file.  We strip off the -title and look up \XRLABEL-lof, which
7762 % has the text we're supposed to typeset here.
7763 %
7764 % Figures without xref labels will not be included in the list (since
7765 % they won't appear in the aux file).
7766 %
7767 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7768 \def\listoffloatsdoentry#1-title\finish{{%
7769   % Can't fully expand XR#1-lof because it can contain anything.  Just
7770   % pass the control sequence.  On the other hand, XR#1-pg is just the
7771   % page number, and we want to fully expand that so we can get a link
7772   % in pdf output.
7773   \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7774   %
7775   % use the same \entry macro we use to generate the TOC and index.
7776   \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7777   \writeentry
7778 }}
7779
7780
7781 \message{localization,}
7782
7783 % For single-language documents, @documentlanguage is usually given very
7784 % early, just after @documentencoding.  Single argument is the language
7785 % (de) or locale (de_DE) abbreviation.
7786 %
7787 {
7788   \catcode`\_ = \active
7789   \globaldefs=1
7790 \parseargdef\documentlanguage{\begingroup
7791   \let_=\normalunderscore  % normal _ character for filenames
7792   \tex % read txi-??.tex file in plain TeX.
7793     % Read the file by the name they passed if it exists.
7794     \openin 1 txi-#1.tex
7795     \ifeof 1
7796       \documentlanguagetrywithoutunderscore{#1_\finish}%
7797     \else
7798       \globaldefs = 1  % everything in the txi-LL files needs to persist
7799       \input txi-#1.tex
7800     \fi
7801     \closein 1
7802   \endgroup % end raw TeX
7803 \endgroup}
7804 }
7805 %
7806 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7807 % try txi-de.tex.
7808
7809 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7810   \openin 1 txi-#1.tex
7811   \ifeof 1
7812     \errhelp = \nolanghelp
7813     \errmessage{Cannot read language file txi-#1.tex}%
7814   \else
7815     \input txi-#1.tex
7816   \fi
7817   \closein 1
7818 }
7819 %
7820 \newhelp\nolanghelp{The given language definition file cannot be found or
7821 is empty.  Maybe you need to install it?  Putting it in the current
7822 directory should work if nowhere else does.}
7823
7824 % This macro is called from txi-??.tex files; the first argument is the
7825 % \language name to set (without the "\lang@" prefix), the second and
7826 % third args are \{left,right}hyphenmin.
7827
7828 % The language names to pass are determined when the format is built.
7829 % See the etex.log file created at that time, e.g.,
7830 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
7831
7832 % With TeX Live 2008, etex now includes hyphenation patterns for all
7833 % available languages.  This means we can support hyphenation in
7834 % Texinfo, at least to some extent.  (This still doesn't solve the
7835 % accented characters problem.)
7836
7837 \catcode`@=11
7838 \def\txisetlanguage#1#2#3{%
7839   % do not set the language if the name is undefined in the current TeX.
7840   \expandafter\ifx\csname lang@#1\endcsname \relax
7841     \message{no patterns for #1}%
7842   \else
7843     \global\language = \csname lang@#1\endcsname
7844   \fi
7845   % but there is no harm in adjusting the hyphenmin values regardless.
7846   \global\lefthyphenmin = #2\relax
7847   \global\righthyphenmin = #3\relax
7848 }
7849
7850 % Helpers for encodings.
7851 % Set the catcode of characters 128 through 255 to the specified number.
7852 %
7853 \def\setnonasciicharscatcode#1{%
7854    \count255=128
7855    \loop\ifnum\count255<256
7856       \global\catcode\count255=#1\relax
7857       \advance\count255 by 1
7858    \repeat
7859 }
7860
7861 \def\setnonasciicharscatcodenonglobal#1{%
7862    \count255=128
7863    \loop\ifnum\count255<256
7864       \catcode\count255=#1\relax
7865       \advance\count255 by 1
7866    \repeat
7867 }
7868
7869 % @documentencoding sets the definition of non-ASCII characters
7870 % according to the specified encoding.
7871 %
7872 \parseargdef\documentencoding{%
7873   % Encoding being declared for the document.
7874   \def\declaredencoding{\csname #1.enc\endcsname}%
7875   %
7876   % Supported encodings: names converted to tokens in order to be able
7877   % to compare them with \ifx.
7878   \def\ascii{\csname US-ASCII.enc\endcsname}%
7879   \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7880   \def\latone{\csname ISO-8859-1.enc\endcsname}%
7881   \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7882   \def\utfeight{\csname UTF-8.enc\endcsname}%
7883   %
7884   \ifx \declaredencoding \ascii
7885      \asciichardefs
7886   %
7887   \else \ifx \declaredencoding \lattwo
7888      \setnonasciicharscatcode\active
7889      \lattwochardefs
7890   %
7891   \else \ifx \declaredencoding \latone 
7892      \setnonasciicharscatcode\active
7893      \latonechardefs
7894   %
7895   \else \ifx \declaredencoding \latnine
7896      \setnonasciicharscatcode\active
7897      \latninechardefs
7898   %
7899   \else \ifx \declaredencoding \utfeight
7900      \setnonasciicharscatcode\active
7901      \utfeightchardefs
7902   %
7903   \else 
7904     \message{Unknown document encoding #1, ignoring.}%
7905   %
7906   \fi % utfeight
7907   \fi % latnine
7908   \fi % latone
7909   \fi % lattwo
7910   \fi % ascii
7911 }
7912
7913 % A message to be logged when using a character that isn't available
7914 % the default font encoding (OT1).
7915
7916 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7917
7918 % Take account of \c (plain) vs. \, (Texinfo) difference.
7919 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7920
7921 % First, make active non-ASCII characters in order for them to be
7922 % correctly categorized when TeX reads the replacement text of
7923 % macros containing the character definitions.
7924 \setnonasciicharscatcode\active
7925 %
7926 % Latin1 (ISO-8859-1) character definitions.
7927 \def\latonechardefs{%
7928   \gdef^^a0{~} 
7929   \gdef^^a1{\exclamdown}
7930   \gdef^^a2{\missingcharmsg{CENT SIGN}} 
7931   \gdef^^a3{{\pounds}}
7932   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7933   \gdef^^a5{\missingcharmsg{YEN SIGN}}
7934   \gdef^^a6{\missingcharmsg{BROKEN BAR}} 
7935   \gdef^^a7{\S}
7936   \gdef^^a8{\"{}} 
7937   \gdef^^a9{\copyright} 
7938   \gdef^^aa{\ordf}
7939   \gdef^^ab{\guillemetleft}
7940   \gdef^^ac{$\lnot$}
7941   \gdef^^ad{\-} 
7942   \gdef^^ae{\registeredsymbol} 
7943   \gdef^^af{\={}}
7944   %
7945   \gdef^^b0{\textdegree}
7946   \gdef^^b1{$\pm$}
7947   \gdef^^b2{$^2$}
7948   \gdef^^b3{$^3$}
7949   \gdef^^b4{\'{}}
7950   \gdef^^b5{$\mu$}
7951   \gdef^^b6{\P}
7952   %
7953   \gdef^^b7{$^.$}
7954   \gdef^^b8{\cedilla\ }
7955   \gdef^^b9{$^1$}
7956   \gdef^^ba{\ordm}
7957   %
7958   \gdef^^bb{\guilletright}
7959   \gdef^^bc{$1\over4$}
7960   \gdef^^bd{$1\over2$}
7961   \gdef^^be{$3\over4$}
7962   \gdef^^bf{\questiondown}
7963   %
7964   \gdef^^c0{\`A}
7965   \gdef^^c1{\'A}
7966   \gdef^^c2{\^A}
7967   \gdef^^c3{\~A}
7968   \gdef^^c4{\"A}
7969   \gdef^^c5{\ringaccent A} 
7970   \gdef^^c6{\AE}
7971   \gdef^^c7{\cedilla C}
7972   \gdef^^c8{\`E}
7973   \gdef^^c9{\'E}
7974   \gdef^^ca{\^E}
7975   \gdef^^cb{\"E}
7976   \gdef^^cc{\`I}
7977   \gdef^^cd{\'I}
7978   \gdef^^ce{\^I}
7979   \gdef^^cf{\"I}
7980   %
7981   \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7982   \gdef^^d1{\~N}
7983   \gdef^^d2{\`O}
7984   \gdef^^d3{\'O}
7985   \gdef^^d4{\^O}
7986   \gdef^^d5{\~O}
7987   \gdef^^d6{\"O}
7988   \gdef^^d7{$\times$}
7989   \gdef^^d8{\O}
7990   \gdef^^d9{\`U}
7991   \gdef^^da{\'U}
7992   \gdef^^db{\^U}
7993   \gdef^^dc{\"U}
7994   \gdef^^dd{\'Y}
7995   \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7996   \gdef^^df{\ss}
7997   %
7998   \gdef^^e0{\`a}
7999   \gdef^^e1{\'a}
8000   \gdef^^e2{\^a}
8001   \gdef^^e3{\~a}
8002   \gdef^^e4{\"a}
8003   \gdef^^e5{\ringaccent a}
8004   \gdef^^e6{\ae}
8005   \gdef^^e7{\cedilla c}
8006   \gdef^^e8{\`e}
8007   \gdef^^e9{\'e}
8008   \gdef^^ea{\^e}
8009   \gdef^^eb{\"e}
8010   \gdef^^ec{\`{\dotless i}}
8011   \gdef^^ed{\'{\dotless i}}
8012   \gdef^^ee{\^{\dotless i}}
8013   \gdef^^ef{\"{\dotless i}}
8014   %
8015   \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
8016   \gdef^^f1{\~n}
8017   \gdef^^f2{\`o}
8018   \gdef^^f3{\'o}
8019   \gdef^^f4{\^o}
8020   \gdef^^f5{\~o}
8021   \gdef^^f6{\"o}
8022   \gdef^^f7{$\div$}
8023   \gdef^^f8{\o}
8024   \gdef^^f9{\`u}
8025   \gdef^^fa{\'u}
8026   \gdef^^fb{\^u}
8027   \gdef^^fc{\"u}
8028   \gdef^^fd{\'y}
8029   \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
8030   \gdef^^ff{\"y}
8031 }
8032
8033 % Latin9 (ISO-8859-15) encoding character definitions.
8034 \def\latninechardefs{%
8035   % Encoding is almost identical to Latin1.
8036   \latonechardefs
8037   %
8038   \gdef^^a4{\euro}
8039   \gdef^^a6{\v S}
8040   \gdef^^a8{\v s}
8041   \gdef^^b4{\v Z}
8042   \gdef^^b8{\v z}
8043   \gdef^^bc{\OE}
8044   \gdef^^bd{\oe}
8045   \gdef^^be{\"Y}
8046 }
8047
8048 % Latin2 (ISO-8859-2) character definitions.
8049 \def\lattwochardefs{%
8050   \gdef^^a0{~}
8051   \gdef^^a1{\ogonek{A}}
8052   \gdef^^a2{\u{}}
8053   \gdef^^a3{\L}
8054   \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8055   \gdef^^a5{\v L}
8056   \gdef^^a6{\'S}
8057   \gdef^^a7{\S}
8058   \gdef^^a8{\"{}}
8059   \gdef^^a9{\v S}
8060   \gdef^^aa{\cedilla S}
8061   \gdef^^ab{\v T}
8062   \gdef^^ac{\'Z}
8063   \gdef^^ad{\-}
8064   \gdef^^ae{\v Z}
8065   \gdef^^af{\dotaccent Z}
8066   %
8067   \gdef^^b0{\textdegree}
8068   \gdef^^b1{\ogonek{a}}
8069   \gdef^^b2{\ogonek{ }}
8070   \gdef^^b3{\l}
8071   \gdef^^b4{\'{}}
8072   \gdef^^b5{\v l}
8073   \gdef^^b6{\'s}
8074   \gdef^^b7{\v{}}
8075   \gdef^^b8{\cedilla\ }
8076   \gdef^^b9{\v s}
8077   \gdef^^ba{\cedilla s}
8078   \gdef^^bb{\v t}
8079   \gdef^^bc{\'z}
8080   \gdef^^bd{\H{}}
8081   \gdef^^be{\v z}
8082   \gdef^^bf{\dotaccent z}
8083   %
8084   \gdef^^c0{\'R}
8085   \gdef^^c1{\'A}
8086   \gdef^^c2{\^A}
8087   \gdef^^c3{\u A}
8088   \gdef^^c4{\"A}
8089   \gdef^^c5{\'L}
8090   \gdef^^c6{\'C}
8091   \gdef^^c7{\cedilla C}
8092   \gdef^^c8{\v C}
8093   \gdef^^c9{\'E}
8094   \gdef^^ca{\ogonek{E}}
8095   \gdef^^cb{\"E}
8096   \gdef^^cc{\v E}
8097   \gdef^^cd{\'I}
8098   \gdef^^ce{\^I}
8099   \gdef^^cf{\v D}
8100   %
8101   \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8102   \gdef^^d1{\'N}
8103   \gdef^^d2{\v N}
8104   \gdef^^d3{\'O}
8105   \gdef^^d4{\^O}
8106   \gdef^^d5{\H O}
8107   \gdef^^d6{\"O}
8108   \gdef^^d7{$\times$}
8109   \gdef^^d8{\v R}
8110   \gdef^^d9{\ringaccent U} 
8111   \gdef^^da{\'U}
8112   \gdef^^db{\H U}
8113   \gdef^^dc{\"U}
8114   \gdef^^dd{\'Y}
8115   \gdef^^de{\cedilla T}
8116   \gdef^^df{\ss}
8117   %
8118   \gdef^^e0{\'r}
8119   \gdef^^e1{\'a}
8120   \gdef^^e2{\^a}
8121   \gdef^^e3{\u a}
8122   \gdef^^e4{\"a}
8123   \gdef^^e5{\'l}
8124   \gdef^^e6{\'c}
8125   \gdef^^e7{\cedilla c}
8126   \gdef^^e8{\v c}
8127   \gdef^^e9{\'e}
8128   \gdef^^ea{\ogonek{e}}
8129   \gdef^^eb{\"e}
8130   \gdef^^ec{\v e}
8131   \gdef^^ed{\'\i}
8132   \gdef^^ee{\^\i}
8133   \gdef^^ef{\v d}
8134   %
8135   \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8136   \gdef^^f1{\'n}
8137   \gdef^^f2{\v n}
8138   \gdef^^f3{\'o}
8139   \gdef^^f4{\^o}
8140   \gdef^^f5{\H o}
8141   \gdef^^f6{\"o}
8142   \gdef^^f7{$\div$}
8143   \gdef^^f8{\v r}
8144   \gdef^^f9{\ringaccent u}
8145   \gdef^^fa{\'u}
8146   \gdef^^fb{\H u}
8147   \gdef^^fc{\"u}
8148   \gdef^^fd{\'y}
8149   \gdef^^fe{\cedilla t}
8150   \gdef^^ff{\dotaccent{}}
8151 }
8152
8153 % UTF-8 character definitions.
8154
8155 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8156 % changes for Texinfo conventions.  It is included here under the GPL by
8157 % permission from Frank Mittelbach and the LaTeX team.
8158
8159 \newcount\countUTFx
8160 \newcount\countUTFy
8161 \newcount\countUTFz
8162
8163 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8164    \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8165 %
8166 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8167    \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8168 %
8169 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8170    \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8171
8172 \gdef\UTFviiiDefined#1{%
8173   \ifx #1\relax
8174     \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8175   \else
8176     \expandafter #1%
8177   \fi
8178 }
8179
8180 \begingroup
8181   \catcode`\~13
8182   \catcode`\"12
8183
8184   \def\UTFviiiLoop{%
8185     \global\catcode\countUTFx\active
8186     \uccode`\~\countUTFx
8187     \uppercase\expandafter{\UTFviiiTmp}%
8188     \advance\countUTFx by 1
8189     \ifnum\countUTFx < \countUTFy
8190       \expandafter\UTFviiiLoop
8191     \fi}
8192
8193   \countUTFx = "C2
8194   \countUTFy = "E0
8195   \def\UTFviiiTmp{%
8196     \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8197   \UTFviiiLoop
8198
8199   \countUTFx = "E0
8200   \countUTFy = "F0
8201   \def\UTFviiiTmp{%
8202     \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8203   \UTFviiiLoop
8204
8205   \countUTFx = "F0
8206   \countUTFy = "F4
8207   \def\UTFviiiTmp{%
8208     \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8209   \UTFviiiLoop
8210 \endgroup
8211
8212 \begingroup
8213   \catcode`\"=12
8214   \catcode`\<=12
8215   \catcode`\.=12
8216   \catcode`\,=12
8217   \catcode`\;=12
8218   \catcode`\!=12
8219   \catcode`\~=13
8220
8221   \gdef\DeclareUnicodeCharacter#1#2{%
8222     \countUTFz = "#1\relax
8223     \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8224     \begingroup
8225       \parseXMLCharref
8226       \def\UTFviiiTwoOctets##1##2{%
8227         \csname u8:##1\string ##2\endcsname}%
8228       \def\UTFviiiThreeOctets##1##2##3{%
8229         \csname u8:##1\string ##2\string ##3\endcsname}%
8230       \def\UTFviiiFourOctets##1##2##3##4{%
8231         \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8232       \expandafter\expandafter\expandafter\expandafter
8233        \expandafter\expandafter\expandafter
8234        \gdef\UTFviiiTmp{#2}%
8235     \endgroup}
8236
8237   \gdef\parseXMLCharref{%
8238     \ifnum\countUTFz < "A0\relax
8239       \errhelp = \EMsimple
8240       \errmessage{Cannot define Unicode char value < 00A0}%
8241     \else\ifnum\countUTFz < "800\relax
8242       \parseUTFviiiA,%
8243       \parseUTFviiiB C\UTFviiiTwoOctets.,%
8244     \else\ifnum\countUTFz < "10000\relax
8245       \parseUTFviiiA;%
8246       \parseUTFviiiA,%
8247       \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8248     \else
8249       \parseUTFviiiA;%
8250       \parseUTFviiiA,%
8251       \parseUTFviiiA!%
8252       \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8253     \fi\fi\fi
8254   }
8255
8256   \gdef\parseUTFviiiA#1{%
8257     \countUTFx = \countUTFz
8258     \divide\countUTFz by 64
8259     \countUTFy = \countUTFz
8260     \multiply\countUTFz by 64
8261     \advance\countUTFx by -\countUTFz
8262     \advance\countUTFx by 128
8263     \uccode `#1\countUTFx
8264     \countUTFz = \countUTFy}
8265
8266   \gdef\parseUTFviiiB#1#2#3#4{%
8267     \advance\countUTFz by "#10\relax
8268     \uccode `#3\countUTFz
8269     \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8270 \endgroup
8271
8272 \def\utfeightchardefs{%
8273   \DeclareUnicodeCharacter{00A0}{\tie}
8274   \DeclareUnicodeCharacter{00A1}{\exclamdown}
8275   \DeclareUnicodeCharacter{00A3}{\pounds}
8276   \DeclareUnicodeCharacter{00A8}{\"{ }}
8277   \DeclareUnicodeCharacter{00A9}{\copyright}
8278   \DeclareUnicodeCharacter{00AA}{\ordf}
8279   \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8280   \DeclareUnicodeCharacter{00AD}{\-}
8281   \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8282   \DeclareUnicodeCharacter{00AF}{\={ }}
8283
8284   \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8285   \DeclareUnicodeCharacter{00B4}{\'{ }}
8286   \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8287   \DeclareUnicodeCharacter{00BA}{\ordm}
8288   \DeclareUnicodeCharacter{00BB}{\guillemetright}
8289   \DeclareUnicodeCharacter{00BF}{\questiondown}
8290
8291   \DeclareUnicodeCharacter{00C0}{\`A}
8292   \DeclareUnicodeCharacter{00C1}{\'A}
8293   \DeclareUnicodeCharacter{00C2}{\^A}
8294   \DeclareUnicodeCharacter{00C3}{\~A}
8295   \DeclareUnicodeCharacter{00C4}{\"A}
8296   \DeclareUnicodeCharacter{00C5}{\AA}
8297   \DeclareUnicodeCharacter{00C6}{\AE}
8298   \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8299   \DeclareUnicodeCharacter{00C8}{\`E}
8300   \DeclareUnicodeCharacter{00C9}{\'E}
8301   \DeclareUnicodeCharacter{00CA}{\^E}
8302   \DeclareUnicodeCharacter{00CB}{\"E}
8303   \DeclareUnicodeCharacter{00CC}{\`I}
8304   \DeclareUnicodeCharacter{00CD}{\'I}
8305   \DeclareUnicodeCharacter{00CE}{\^I}
8306   \DeclareUnicodeCharacter{00CF}{\"I}
8307
8308   \DeclareUnicodeCharacter{00D1}{\~N}
8309   \DeclareUnicodeCharacter{00D2}{\`O}
8310   \DeclareUnicodeCharacter{00D3}{\'O}
8311   \DeclareUnicodeCharacter{00D4}{\^O}
8312   \DeclareUnicodeCharacter{00D5}{\~O}
8313   \DeclareUnicodeCharacter{00D6}{\"O}
8314   \DeclareUnicodeCharacter{00D8}{\O}
8315   \DeclareUnicodeCharacter{00D9}{\`U}
8316   \DeclareUnicodeCharacter{00DA}{\'U}
8317   \DeclareUnicodeCharacter{00DB}{\^U}
8318   \DeclareUnicodeCharacter{00DC}{\"U}
8319   \DeclareUnicodeCharacter{00DD}{\'Y}
8320   \DeclareUnicodeCharacter{00DF}{\ss}
8321
8322   \DeclareUnicodeCharacter{00E0}{\`a}
8323   \DeclareUnicodeCharacter{00E1}{\'a}
8324   \DeclareUnicodeCharacter{00E2}{\^a}
8325   \DeclareUnicodeCharacter{00E3}{\~a}
8326   \DeclareUnicodeCharacter{00E4}{\"a}
8327   \DeclareUnicodeCharacter{00E5}{\aa}
8328   \DeclareUnicodeCharacter{00E6}{\ae}
8329   \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8330   \DeclareUnicodeCharacter{00E8}{\`e}
8331   \DeclareUnicodeCharacter{00E9}{\'e}
8332   \DeclareUnicodeCharacter{00EA}{\^e}
8333   \DeclareUnicodeCharacter{00EB}{\"e}
8334   \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8335   \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8336   \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8337   \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8338
8339   \DeclareUnicodeCharacter{00F1}{\~n}
8340   \DeclareUnicodeCharacter{00F2}{\`o}
8341   \DeclareUnicodeCharacter{00F3}{\'o}
8342   \DeclareUnicodeCharacter{00F4}{\^o}
8343   \DeclareUnicodeCharacter{00F5}{\~o}
8344   \DeclareUnicodeCharacter{00F6}{\"o}
8345   \DeclareUnicodeCharacter{00F8}{\o}
8346   \DeclareUnicodeCharacter{00F9}{\`u}
8347   \DeclareUnicodeCharacter{00FA}{\'u}
8348   \DeclareUnicodeCharacter{00FB}{\^u}
8349   \DeclareUnicodeCharacter{00FC}{\"u}
8350   \DeclareUnicodeCharacter{00FD}{\'y}
8351   \DeclareUnicodeCharacter{00FF}{\"y}
8352
8353   \DeclareUnicodeCharacter{0100}{\=A}
8354   \DeclareUnicodeCharacter{0101}{\=a}
8355   \DeclareUnicodeCharacter{0102}{\u{A}}
8356   \DeclareUnicodeCharacter{0103}{\u{a}}
8357   \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8358   \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8359   \DeclareUnicodeCharacter{0106}{\'C}
8360   \DeclareUnicodeCharacter{0107}{\'c}
8361   \DeclareUnicodeCharacter{0108}{\^C}
8362   \DeclareUnicodeCharacter{0109}{\^c}
8363   \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8364   \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8365   \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8366   \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8367   \DeclareUnicodeCharacter{010C}{\v{C}}
8368   \DeclareUnicodeCharacter{010D}{\v{c}}
8369   \DeclareUnicodeCharacter{010E}{\v{D}}
8370
8371   \DeclareUnicodeCharacter{0112}{\=E}
8372   \DeclareUnicodeCharacter{0113}{\=e}
8373   \DeclareUnicodeCharacter{0114}{\u{E}}
8374   \DeclareUnicodeCharacter{0115}{\u{e}}
8375   \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8376   \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8377   \DeclareUnicodeCharacter{011A}{\v{E}}
8378   \DeclareUnicodeCharacter{011B}{\v{e}}
8379   \DeclareUnicodeCharacter{011C}{\^G}
8380   \DeclareUnicodeCharacter{011D}{\^g}
8381   \DeclareUnicodeCharacter{011E}{\u{G}}
8382   \DeclareUnicodeCharacter{011F}{\u{g}}
8383
8384   \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8385   \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8386   \DeclareUnicodeCharacter{0124}{\^H}
8387   \DeclareUnicodeCharacter{0125}{\^h}
8388   \DeclareUnicodeCharacter{0128}{\~I}
8389   \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8390   \DeclareUnicodeCharacter{012A}{\=I}
8391   \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8392   \DeclareUnicodeCharacter{012C}{\u{I}}
8393   \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8394
8395   \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8396   \DeclareUnicodeCharacter{0131}{\dotless{i}}
8397   \DeclareUnicodeCharacter{0132}{IJ}
8398   \DeclareUnicodeCharacter{0133}{ij}
8399   \DeclareUnicodeCharacter{0134}{\^J}
8400   \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8401   \DeclareUnicodeCharacter{0139}{\'L}
8402   \DeclareUnicodeCharacter{013A}{\'l}
8403
8404   \DeclareUnicodeCharacter{0141}{\L}
8405   \DeclareUnicodeCharacter{0142}{\l}
8406   \DeclareUnicodeCharacter{0143}{\'N}
8407   \DeclareUnicodeCharacter{0144}{\'n}
8408   \DeclareUnicodeCharacter{0147}{\v{N}}
8409   \DeclareUnicodeCharacter{0148}{\v{n}}
8410   \DeclareUnicodeCharacter{014C}{\=O}
8411   \DeclareUnicodeCharacter{014D}{\=o}
8412   \DeclareUnicodeCharacter{014E}{\u{O}}
8413   \DeclareUnicodeCharacter{014F}{\u{o}}
8414
8415   \DeclareUnicodeCharacter{0150}{\H{O}}
8416   \DeclareUnicodeCharacter{0151}{\H{o}}
8417   \DeclareUnicodeCharacter{0152}{\OE}
8418   \DeclareUnicodeCharacter{0153}{\oe}
8419   \DeclareUnicodeCharacter{0154}{\'R}
8420   \DeclareUnicodeCharacter{0155}{\'r}
8421   \DeclareUnicodeCharacter{0158}{\v{R}}
8422   \DeclareUnicodeCharacter{0159}{\v{r}}
8423   \DeclareUnicodeCharacter{015A}{\'S}
8424   \DeclareUnicodeCharacter{015B}{\'s}
8425   \DeclareUnicodeCharacter{015C}{\^S}
8426   \DeclareUnicodeCharacter{015D}{\^s}
8427   \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8428   \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8429
8430   \DeclareUnicodeCharacter{0160}{\v{S}}
8431   \DeclareUnicodeCharacter{0161}{\v{s}}
8432   \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8433   \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8434   \DeclareUnicodeCharacter{0164}{\v{T}}
8435
8436   \DeclareUnicodeCharacter{0168}{\~U}
8437   \DeclareUnicodeCharacter{0169}{\~u}
8438   \DeclareUnicodeCharacter{016A}{\=U}
8439   \DeclareUnicodeCharacter{016B}{\=u}
8440   \DeclareUnicodeCharacter{016C}{\u{U}}
8441   \DeclareUnicodeCharacter{016D}{\u{u}}
8442   \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8443   \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8444
8445   \DeclareUnicodeCharacter{0170}{\H{U}}
8446   \DeclareUnicodeCharacter{0171}{\H{u}}
8447   \DeclareUnicodeCharacter{0174}{\^W}
8448   \DeclareUnicodeCharacter{0175}{\^w}
8449   \DeclareUnicodeCharacter{0176}{\^Y}
8450   \DeclareUnicodeCharacter{0177}{\^y}
8451   \DeclareUnicodeCharacter{0178}{\"Y}
8452   \DeclareUnicodeCharacter{0179}{\'Z}
8453   \DeclareUnicodeCharacter{017A}{\'z}
8454   \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8455   \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8456   \DeclareUnicodeCharacter{017D}{\v{Z}}
8457   \DeclareUnicodeCharacter{017E}{\v{z}}
8458
8459   \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8460   \DeclareUnicodeCharacter{01C5}{D\v{z}}
8461   \DeclareUnicodeCharacter{01C6}{d\v{z}}
8462   \DeclareUnicodeCharacter{01C7}{LJ}
8463   \DeclareUnicodeCharacter{01C8}{Lj}
8464   \DeclareUnicodeCharacter{01C9}{lj}
8465   \DeclareUnicodeCharacter{01CA}{NJ}
8466   \DeclareUnicodeCharacter{01CB}{Nj}
8467   \DeclareUnicodeCharacter{01CC}{nj}
8468   \DeclareUnicodeCharacter{01CD}{\v{A}}
8469   \DeclareUnicodeCharacter{01CE}{\v{a}}
8470   \DeclareUnicodeCharacter{01CF}{\v{I}}
8471
8472   \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8473   \DeclareUnicodeCharacter{01D1}{\v{O}}
8474   \DeclareUnicodeCharacter{01D2}{\v{o}}
8475   \DeclareUnicodeCharacter{01D3}{\v{U}}
8476   \DeclareUnicodeCharacter{01D4}{\v{u}}
8477
8478   \DeclareUnicodeCharacter{01E2}{\={\AE}}
8479   \DeclareUnicodeCharacter{01E3}{\={\ae}}
8480   \DeclareUnicodeCharacter{01E6}{\v{G}}
8481   \DeclareUnicodeCharacter{01E7}{\v{g}}
8482   \DeclareUnicodeCharacter{01E8}{\v{K}}
8483   \DeclareUnicodeCharacter{01E9}{\v{k}}
8484
8485   \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8486   \DeclareUnicodeCharacter{01F1}{DZ}
8487   \DeclareUnicodeCharacter{01F2}{Dz}
8488   \DeclareUnicodeCharacter{01F3}{dz}
8489   \DeclareUnicodeCharacter{01F4}{\'G}
8490   \DeclareUnicodeCharacter{01F5}{\'g}
8491   \DeclareUnicodeCharacter{01F8}{\`N}
8492   \DeclareUnicodeCharacter{01F9}{\`n}
8493   \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8494   \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8495   \DeclareUnicodeCharacter{01FE}{\'{\O}}
8496   \DeclareUnicodeCharacter{01FF}{\'{\o}}
8497
8498   \DeclareUnicodeCharacter{021E}{\v{H}}
8499   \DeclareUnicodeCharacter{021F}{\v{h}}
8500
8501   \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8502   \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8503   \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8504   \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8505   \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8506   \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8507
8508   \DeclareUnicodeCharacter{0232}{\=Y}
8509   \DeclareUnicodeCharacter{0233}{\=y}
8510   \DeclareUnicodeCharacter{0237}{\dotless{j}}
8511
8512   \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8513
8514   \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8515   \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8516   \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8517   \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8518   \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8519   \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8520   \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8521   \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8522   \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8523   \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8524   \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8525   \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8526
8527   \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8528   \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8529
8530   \DeclareUnicodeCharacter{1E20}{\=G}
8531   \DeclareUnicodeCharacter{1E21}{\=g}
8532   \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8533   \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8534   \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8535   \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8536   \DeclareUnicodeCharacter{1E26}{\"H}
8537   \DeclareUnicodeCharacter{1E27}{\"h}
8538
8539   \DeclareUnicodeCharacter{1E30}{\'K}
8540   \DeclareUnicodeCharacter{1E31}{\'k}
8541   \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8542   \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8543   \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8544   \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8545   \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8546   \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8547   \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8548   \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8549   \DeclareUnicodeCharacter{1E3E}{\'M}
8550   \DeclareUnicodeCharacter{1E3F}{\'m}
8551
8552   \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8553   \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8554   \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8555   \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8556   \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8557   \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8558   \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8559   \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8560   \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8561   \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8562
8563   \DeclareUnicodeCharacter{1E54}{\'P}
8564   \DeclareUnicodeCharacter{1E55}{\'p}
8565   \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8566   \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8567   \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8568   \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8569   \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8570   \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8571   \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8572   \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8573
8574   \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8575   \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8576   \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8577   \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8578   \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8579   \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8580   \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8581   \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8582   \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8583   \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8584
8585   \DeclareUnicodeCharacter{1E7C}{\~V}
8586   \DeclareUnicodeCharacter{1E7D}{\~v}
8587   \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8588   \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8589
8590   \DeclareUnicodeCharacter{1E80}{\`W}
8591   \DeclareUnicodeCharacter{1E81}{\`w}
8592   \DeclareUnicodeCharacter{1E82}{\'W}
8593   \DeclareUnicodeCharacter{1E83}{\'w}
8594   \DeclareUnicodeCharacter{1E84}{\"W}
8595   \DeclareUnicodeCharacter{1E85}{\"w}
8596   \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8597   \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8598   \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8599   \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8600   \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8601   \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8602   \DeclareUnicodeCharacter{1E8C}{\"X}
8603   \DeclareUnicodeCharacter{1E8D}{\"x}
8604   \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8605   \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8606
8607   \DeclareUnicodeCharacter{1E90}{\^Z}
8608   \DeclareUnicodeCharacter{1E91}{\^z}
8609   \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8610   \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8611   \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8612   \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8613   \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8614   \DeclareUnicodeCharacter{1E97}{\"t}
8615   \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8616   \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8617
8618   \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8619   \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8620
8621   \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8622   \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8623   \DeclareUnicodeCharacter{1EBC}{\~E}
8624   \DeclareUnicodeCharacter{1EBD}{\~e}
8625
8626   \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8627   \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8628   \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8629   \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8630
8631   \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8632   \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8633
8634   \DeclareUnicodeCharacter{1EF2}{\`Y}
8635   \DeclareUnicodeCharacter{1EF3}{\`y}
8636   \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8637
8638   \DeclareUnicodeCharacter{1EF8}{\~Y}
8639   \DeclareUnicodeCharacter{1EF9}{\~y}
8640
8641   \DeclareUnicodeCharacter{2013}{--}
8642   \DeclareUnicodeCharacter{2014}{---}
8643   \DeclareUnicodeCharacter{2018}{\quoteleft}
8644   \DeclareUnicodeCharacter{2019}{\quoteright}
8645   \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8646   \DeclareUnicodeCharacter{201C}{\quotedblleft}
8647   \DeclareUnicodeCharacter{201D}{\quotedblright}
8648   \DeclareUnicodeCharacter{201E}{\quotedblbase}
8649   \DeclareUnicodeCharacter{2022}{\bullet}
8650   \DeclareUnicodeCharacter{2026}{\dots}
8651   \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8652   \DeclareUnicodeCharacter{203A}{\guilsinglright}
8653   \DeclareUnicodeCharacter{20AC}{\euro}
8654
8655   \DeclareUnicodeCharacter{2192}{\expansion}
8656   \DeclareUnicodeCharacter{21D2}{\result}
8657
8658   \DeclareUnicodeCharacter{2212}{\minus}
8659   \DeclareUnicodeCharacter{2217}{\point}
8660   \DeclareUnicodeCharacter{2261}{\equiv}
8661 }% end of \utfeightchardefs
8662
8663
8664 % US-ASCII character definitions.
8665 \def\asciichardefs{% nothing need be done
8666    \relax
8667 }
8668
8669 % Make non-ASCII characters printable again for compatibility with
8670 % existing Texinfo documents that may use them, even without declaring a
8671 % document encoding.
8672 %
8673 \setnonasciicharscatcode \other
8674
8675
8676 \message{formatting,}
8677
8678 \newdimen\defaultparindent \defaultparindent = 15pt
8679
8680 \chapheadingskip = 15pt plus 4pt minus 2pt
8681 \secheadingskip = 12pt plus 3pt minus 2pt
8682 \subsecheadingskip = 9pt plus 2pt minus 2pt
8683
8684 % Prevent underfull vbox error messages.
8685 \vbadness = 10000
8686
8687 % Don't be so finicky about underfull hboxes, either.
8688 \hbadness = 2000
8689
8690 % Following George Bush, get rid of widows and orphans.
8691 \widowpenalty=10000
8692 \clubpenalty=10000
8693
8694 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8695 % using an old version of TeX, don't do anything.  We want the amount of
8696 % stretch added to depend on the line length, hence the dependence on
8697 % \hsize.  We call this whenever the paper size is set.
8698 %
8699 \def\setemergencystretch{%
8700   \ifx\emergencystretch\thisisundefined
8701     % Allow us to assign to \emergencystretch anyway.
8702     \def\emergencystretch{\dimen0}%
8703   \else
8704     \emergencystretch = .15\hsize
8705   \fi
8706 }
8707
8708 % Parameters in order: 1) textheight; 2) textwidth;
8709 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8710 % 7) physical page height; 8) physical page width.
8711 %
8712 % We also call \setleading{\textleading}, so the caller should define
8713 % \textleading.  The caller should also set \parskip.
8714 %
8715 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8716   \voffset = #3\relax
8717   \topskip = #6\relax
8718   \splittopskip = \topskip
8719   %
8720   \vsize = #1\relax
8721   \advance\vsize by \topskip
8722   \outervsize = \vsize
8723   \advance\outervsize by 2\topandbottommargin
8724   \pageheight = \vsize
8725   %
8726   \hsize = #2\relax
8727   \outerhsize = \hsize
8728   \advance\outerhsize by 0.5in
8729   \pagewidth = \hsize
8730   %
8731   \normaloffset = #4\relax
8732   \bindingoffset = #5\relax
8733   %
8734   \ifpdf
8735     \pdfpageheight #7\relax
8736     \pdfpagewidth #8\relax
8737     % if we don't reset these, they will remain at "1 true in" of
8738     % whatever layout pdftex was dumped with.
8739     \pdfhorigin = 1 true in
8740     \pdfvorigin = 1 true in
8741   \fi
8742   %
8743   \setleading{\textleading}
8744   %
8745   \parindent = \defaultparindent
8746   \setemergencystretch
8747 }
8748
8749 % @letterpaper (the default).
8750 \def\letterpaper{{\globaldefs = 1
8751   \parskip = 3pt plus 2pt minus 1pt
8752   \textleading = 13.2pt
8753   %
8754   % If page is nothing but text, make it come out even.
8755   \internalpagesizes{607.2pt}{6in}% that's 46 lines
8756                     {\voffset}{.25in}%
8757                     {\bindingoffset}{36pt}%
8758                     {11in}{8.5in}%
8759 }}
8760
8761 % Use @smallbook to reset parameters for 7x9.25 trim size.
8762 \def\smallbook{{\globaldefs = 1
8763   \parskip = 2pt plus 1pt
8764   \textleading = 12pt
8765   %
8766   \internalpagesizes{7.5in}{5in}%
8767                     {-.2in}{0in}%
8768                     {\bindingoffset}{16pt}%
8769                     {9.25in}{7in}%
8770   %
8771   \lispnarrowing = 0.3in
8772   \tolerance = 700
8773   \hfuzz = 1pt
8774   \contentsrightmargin = 0pt
8775   \defbodyindent = .5cm
8776 }}
8777
8778 % Use @smallerbook to reset parameters for 6x9 trim size.
8779 % (Just testing, parameters still in flux.)
8780 \def\smallerbook{{\globaldefs = 1
8781   \parskip = 1.5pt plus 1pt
8782   \textleading = 12pt
8783   %
8784   \internalpagesizes{7.4in}{4.8in}%
8785                     {-.2in}{-.4in}%
8786                     {0pt}{14pt}%
8787                     {9in}{6in}%
8788   %
8789   \lispnarrowing = 0.25in
8790   \tolerance = 700
8791   \hfuzz = 1pt
8792   \contentsrightmargin = 0pt
8793   \defbodyindent = .4cm
8794 }}
8795
8796 % Use @afourpaper to print on European A4 paper.
8797 \def\afourpaper{{\globaldefs = 1
8798   \parskip = 3pt plus 2pt minus 1pt
8799   \textleading = 13.2pt
8800   %
8801   % Double-side printing via postscript on Laserjet 4050
8802   % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8803   % To change the settings for a different printer or situation, adjust
8804   % \normaloffset until the front-side and back-side texts align.  Then
8805   % do the same for \bindingoffset.  You can set these for testing in
8806   % your texinfo source file like this:
8807   % @tex
8808   % \global\normaloffset = -6mm
8809   % \global\bindingoffset = 10mm
8810   % @end tex
8811   \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8812                     {\voffset}{\hoffset}%
8813                     {\bindingoffset}{44pt}%
8814                     {297mm}{210mm}%
8815   %
8816   \tolerance = 700
8817   \hfuzz = 1pt
8818   \contentsrightmargin = 0pt
8819   \defbodyindent = 5mm
8820 }}
8821
8822 % Use @afivepaper to print on European A5 paper.
8823 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8824 % He also recommends making @example and @lisp be small.
8825 \def\afivepaper{{\globaldefs = 1
8826   \parskip = 2pt plus 1pt minus 0.1pt
8827   \textleading = 12.5pt
8828   %
8829   \internalpagesizes{160mm}{120mm}%
8830                     {\voffset}{\hoffset}%
8831                     {\bindingoffset}{8pt}%
8832                     {210mm}{148mm}%
8833   %
8834   \lispnarrowing = 0.2in
8835   \tolerance = 800
8836   \hfuzz = 1.2pt
8837   \contentsrightmargin = 0pt
8838   \defbodyindent = 2mm
8839   \tableindent = 12mm
8840 }}
8841
8842 % A specific text layout, 24x15cm overall, intended for A4 paper.
8843 \def\afourlatex{{\globaldefs = 1
8844   \afourpaper
8845   \internalpagesizes{237mm}{150mm}%
8846                     {\voffset}{4.6mm}%
8847                     {\bindingoffset}{7mm}%
8848                     {297mm}{210mm}%
8849   %
8850   % Must explicitly reset to 0 because we call \afourpaper.
8851   \globaldefs = 0
8852 }}
8853
8854 % Use @afourwide to print on A4 paper in landscape format.
8855 \def\afourwide{{\globaldefs = 1
8856   \afourpaper
8857   \internalpagesizes{241mm}{165mm}%
8858                     {\voffset}{-2.95mm}%
8859                     {\bindingoffset}{7mm}%
8860                     {297mm}{210mm}%
8861   \globaldefs = 0
8862 }}
8863
8864 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8865 % Perhaps we should allow setting the margins, \topskip, \parskip,
8866 % and/or leading, also. Or perhaps we should compute them somehow.
8867 %
8868 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8869 \def\pagesizesyyy#1,#2,#3\finish{{%
8870   \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8871   \globaldefs = 1
8872   %
8873   \parskip = 3pt plus 2pt minus 1pt
8874   \setleading{\textleading}%
8875   %
8876   \dimen0 = #1\relax
8877   \advance\dimen0 by \voffset
8878   %
8879   \dimen2 = \hsize
8880   \advance\dimen2 by \normaloffset
8881   %
8882   \internalpagesizes{#1}{\hsize}%
8883                     {\voffset}{\normaloffset}%
8884                     {\bindingoffset}{44pt}%
8885                     {\dimen0}{\dimen2}%
8886 }}
8887
8888 % Set default to letter.
8889 %
8890 \letterpaper
8891
8892
8893 \message{and turning on texinfo input format.}
8894
8895 % Define macros to output various characters with catcode for normal text.
8896 \catcode`\"=\other
8897 \catcode`\~=\other
8898 \catcode`\^=\other
8899 \catcode`\_=\other
8900 \catcode`\|=\other
8901 \catcode`\<=\other
8902 \catcode`\>=\other
8903 \catcode`\+=\other
8904 \catcode`\$=\other
8905 \def\normaldoublequote{"}
8906 \def\normaltilde{~}
8907 \def\normalcaret{^}
8908 \def\normalunderscore{_}
8909 \def\normalverticalbar{|}
8910 \def\normalless{<}
8911 \def\normalgreater{>}
8912 \def\normalplus{+}
8913 \def\normaldollar{$}%$ font-lock fix
8914
8915 % This macro is used to make a character print one way in \tt
8916 % (where it can probably be output as-is), and another way in other fonts,
8917 % where something hairier probably needs to be done.
8918 %
8919 % #1 is what to print if we are indeed using \tt; #2 is what to print
8920 % otherwise.  Since all the Computer Modern typewriter fonts have zero
8921 % interword stretch (and shrink), and it is reasonable to expect all
8922 % typewriter fonts to have this, we can check that font parameter.
8923 %
8924 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8925
8926 % Same as above, but check for italic font.  Actually this also catches
8927 % non-italic slanted fonts since it is impossible to distinguish them from
8928 % italic fonts.  But since this is only used by $ and it uses \sl anyway
8929 % this is not a problem.
8930 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8931
8932 % Turn off all special characters except @
8933 % (and those which the user can use as if they were ordinary).
8934 % Most of these we simply print from the \tt font, but for some, we can
8935 % use math or other variants that look better in normal text.
8936
8937 \catcode`\"=\active
8938 \def\activedoublequote{{\tt\char34}}
8939 \let"=\activedoublequote
8940 \catcode`\~=\active
8941 \def~{{\tt\char126}}
8942 \chardef\hat=`\^
8943 \catcode`\^=\active
8944 \def^{{\tt \hat}}
8945
8946 \catcode`\_=\active
8947 \def_{\ifusingtt\normalunderscore\_}
8948 \let\realunder=_
8949 % Subroutine for the previous macro.
8950 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8951
8952 \catcode`\|=\active
8953 \def|{{\tt\char124}}
8954 \chardef \less=`\<
8955 \catcode`\<=\active
8956 \def<{{\tt \less}}
8957 \chardef \gtr=`\>
8958 \catcode`\>=\active
8959 \def>{{\tt \gtr}}
8960 \catcode`\+=\active
8961 \def+{{\tt \char 43}}
8962 \catcode`\$=\active
8963 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8964
8965 % If a .fmt file is being used, characters that might appear in a file
8966 % name cannot be active until we have parsed the command line.
8967 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8968 % \otherifyactive is called near the end of this file.
8969 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8970
8971 % Used sometimes to turn off (effectively) the active characters even after
8972 % parsing them.
8973 \def\turnoffactive{%
8974   \normalturnoffactive
8975   \otherbackslash
8976 }
8977
8978 \catcode`\@=0
8979
8980 % \backslashcurfont outputs one backslash character in current font,
8981 % as in \char`\\.
8982 \global\chardef\backslashcurfont=`\\
8983 \global\let\rawbackslashxx=\backslashcurfont  % let existing .??s files work
8984
8985 % \realbackslash is an actual character `\' with catcode other, and
8986 % \doublebackslash is two of them (for the pdf outlines).
8987 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8988
8989 % In texinfo, backslash is an active character; it prints the backslash
8990 % in fixed width font.
8991 \catcode`\\=\active
8992 @def@normalbackslash{{@tt@backslashcurfont}}
8993 % On startup, @fixbackslash assigns:
8994 %  @let \ = @normalbackslash
8995
8996 % \rawbackslash defines an active \ to do \backslashcurfont.
8997 % \otherbackslash defines an active \ to be a literal `\' character with
8998 % catcode other.
8999 @gdef@rawbackslash{@let\=@backslashcurfont}
9000 @gdef@otherbackslash{@let\=@realbackslash}
9001
9002 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9003 % the literal character `\'.
9004
9005 @def@normalturnoffactive{%
9006   @let\=@normalbackslash
9007   @let"=@normaldoublequote
9008   @let~=@normaltilde
9009   @let^=@normalcaret
9010   @let_=@normalunderscore
9011   @let|=@normalverticalbar
9012   @let<=@normalless
9013   @let>=@normalgreater
9014   @let+=@normalplus
9015   @let$=@normaldollar %$ font-lock fix
9016   @unsepspaces
9017 }
9018
9019 % Make _ and + \other characters, temporarily.
9020 % This is canceled by @fixbackslash.
9021 @otherifyactive
9022
9023 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9024 % That is what \eatinput is for; after that, the `\' should revert to printing
9025 % a backslash.
9026 %
9027 @gdef@eatinput input texinfo{@fixbackslash}
9028 @global@let\ = @eatinput
9029
9030 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9031 % the first `\' in the file would cause an error. This macro tries to fix
9032 % that, assuming it is called before the first `\' could plausibly occur.
9033 % Also turn back on active characters that might appear in the input
9034 % file name, in case not using a pre-dumped format.
9035 %
9036 @gdef@fixbackslash{%
9037   @ifx\@eatinput @let\ = @normalbackslash @fi
9038   @catcode`+=@active
9039   @catcode`@_=@active
9040 }
9041
9042 % Say @foo, not \foo, in error messages.
9043 @escapechar = `@@
9044
9045 % These look ok in all fonts, so just make them not special.
9046 @catcode`@& = @other
9047 @catcode`@# = @other
9048 @catcode`@% = @other
9049
9050 @c Finally, make ` and ' active, so that txicodequoteundirected and
9051 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}.  If we
9052 @c don't make ` and ' active, @code will not get them as active chars.
9053 @c Do this last of all since we use ` in the previous @catcode assignments.
9054 @c (not ready yet, sigh)
9055 @c atcode`@'=@active @let'@rq
9056 @c atcode`@`=@active @let`@lq
9057  
9058 @c Local variables:
9059 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9060 @c page-delimiter: "^\\\\message"
9061 @c time-stamp-start: "def\\\\texinfoversion{"
9062 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9063 @c time-stamp-end: "}"
9064 @c End:
9065
9066 @c vim:sw=2:
9067
9068 @ignore
9069    arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
9070 @end ignore