VirtualBox

source: kBuild/trunk/src/sed/config/texinfo.tex@ 2421

Last change on this file since 2421 was 599, checked in by bird, 18 years ago

GNU sed 4.1.5.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette