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