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