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