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