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