source: trunk/essentials/sys-devel/automake-1.8/lib/texinfo.tex

Last change on this file was 3118, checked in by bird, 18 years ago

automake 1.8.5

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