]> sourceware.org Git - glibc.git/blame - manual/texinfo.tex
Update.
[glibc.git] / manual / texinfo.tex
CommitLineData
23a01afe 1%% TeX macros to handle Texinfo files.
3996f34b 2%% $Id: texinfo.tex,v 2.211 1997/07/28 21:55:24 drepper Exp $
9e9f9cc2
KB
3
4% Copyright (C) 1985, 86, 88, 90, 91, 92, 93,
3e99cd6f 5% 94, 95, 96, 97 Free Software Foundation, Inc.
9e9f9cc2
KB
6
7%This texinfo.tex file is free software; you can redistribute it and/or
8%modify it under the terms of the GNU General Public License as
9%published by the Free Software Foundation; either version 2, or (at
10%your option) any later version.
11
12%This texinfo.tex file is distributed in the hope that it will be
13%useful, but WITHOUT ANY WARRANTY; without even the implied warranty
14%of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15%General Public License for more details.
16
17%You should have received a copy of the GNU General Public License
18%along with this texinfo.tex file; see the file COPYING. If not, write
19%to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20%Boston, MA 02111-1307, USA.
21
22
23%In other words, you are welcome to use, share and improve this program.
24%You are forbidden to forbid anyone else to use, share and improve
25%what you give them. Help stamp out software-hoarding!
26
27
28% Send bug reports to bug-texinfo@prep.ai.mit.edu.
29% Please include a *precise* test case in each bug report.
30
31
32% Make it possible to create a .fmt file just by loading this file:
33% if the underlying format is not loaded, start by loading it now.
34% Added by gildea November 1993.
35\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
36
37% This automatically updates the version number based on RCS.
38\def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}}
3996f34b 39\deftexinfoversion$Revision: 2.211 $
9e9f9cc2
KB
40\message{Loading texinfo package [Version \texinfoversion]:}
41
42% If in a .fmt file, print the version number
43% and turn on active characters that we couldn't do earlier because
44% they might have appeared in the input file name.
45\everyjob{\message{[Texinfo version \texinfoversion]}\message{}
46 \catcode`+=\active \catcode`\_=\active}
47
48% Save some parts of plain tex whose names we will redefine.
49
9e9f9cc2 50\let\ptexb=\b
359a1d0b 51\let\ptexbullet=\bullet
9e9f9cc2 52\let\ptexc=\c
359a1d0b
KB
53\let\ptexcomma=\,
54\let\ptexdot=\.
55\let\ptexdots=\dots
56\let\ptexend=\end
57\let\ptexequiv = \equiv
9e9f9cc2 58\let\ptexi=\i
359a1d0b
KB
59\let\ptexlbrace=\{
60\let\ptexrbrace=\}
61\let\ptexstar=\*
9e9f9cc2 62\let\ptext=\t
9e9f9cc2
KB
63
64% Be sure we're in horizontal mode when doing a tie, since we make space
65% equivalent to this in @example-like environments. Otherwise, a space
66% at the beginning of a line will start with \penalty -- and
67% since \penalty is valid in vertical mode, we'd end up putting the
68% penalty on the vertical list instead of in the new paragraph.
69{\catcode`@ = 11
70 % Avoid using \@M directly, because that causes trouble
71 % if the definition is written into an index file.
72 \global\let\tiepenalty = \@M
73 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
74}
9e9f9cc2 75
d66b7b41 76
9e9f9cc2
KB
77\message{Basics,}
78\chardef\other=12
79
80% If this character appears in an error message or help string, it
81% starts a new line in the output.
82\newlinechar = `^^J
83
84% Set up fixed words for English.
85\ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi%
86\def\putwordInfo{Info}%
87\ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi%
88\ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi%
89\ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi%
90\ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi%
91\ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi%
92\ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi%
93\ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi%
94\ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi%
95\ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi%
96
97% Ignore a token.
98%
99\def\gobble#1{}
100
101\hyphenation{ap-pen-dix}
102\hyphenation{mini-buf-fer mini-buf-fers}
103\hyphenation{eshell}
2d7da676 104\hyphenation{white-space}
9e9f9cc2
KB
105
106% Margin to add to right of even pages, to left of odd pages.
10dc2a90
UD
107\newdimen \bindingoffset
108\newdimen \normaloffset
9e9f9cc2 109\newdimen\pagewidth \newdimen\pageheight
9e9f9cc2
KB
110
111% Sometimes it is convenient to have everything in the transcript file
112% and nothing on the terminal. We don't just call \tracingall here,
113% since that produces some useless output on the terminal.
114%
115\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
116\def\loggingall{\tracingcommands2 \tracingstats2
117 \tracingpages1 \tracingoutput1 \tracinglostchars1
118 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
119 \showboxbreadth\maxdimen\showboxdepth\maxdimen
120}%
121
779ae82e
UD
122% For @cropmarks command.
123% Do @cropmarks to get crop marks.
ce37fa88 124%
779ae82e
UD
125\newif\ifcropmarks
126\let\cropmarks = \cropmarkstrue
9e9f9cc2 127%
779ae82e
UD
128% Dimensions to add cropmarks at corners.
129% Added by P. A. MacKay, 12 Nov. 1986
9e9f9cc2
KB
130%
131\newdimen\cornerlong \newdimen\cornerthick
779ae82e
UD
132\newdimen\topandbottommargin
133\newdimen\outerhsize \newdimen\outervsize
2d07133b 134\cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
9e9f9cc2
KB
135\outerhsize=7in
136%\outervsize=9.5in
137% Alternative @smallbook page size is 9.25in
138\outervsize=9.25in
139\topandbottommargin=.75in
9e9f9cc2 140
f5311448
KB
141% Main output routine.
142\chardef\PAGE = 255
143\output = {\onepageout{\pagecontents\PAGE}}
144
779ae82e
UD
145\newbox\headlinebox
146\newbox\footlinebox
f5311448 147
9e9f9cc2 148% \onepageout takes a vbox as an argument. Note that \pagecontents
359a1d0b 149% does insertions, but you have to call it yourself.
359a1d0b 150\def\onepageout#1{%
51702635 151 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
779ae82e 152 %
359a1d0b
KB
153 \ifodd\pageno \advance\hoffset by \bindingoffset
154 \else \advance\hoffset by -\bindingoffset\fi
f5311448
KB
155 %
156 % Do this outside of the \shipout so @code etc. will be expanded in
157 % the headline as they should be, not taken literally (outputting ''code).
158 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
159 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
160 %
359a1d0b 161 {%
f5311448
KB
162 % Have to do this stuff outside the \shipout because we want it to
163 % take effect in \write's, yet the group defined by the \vbox ends
164 % before the \shipout runs.
165 %
23a01afe
KB
166 \escapechar = `\\ % use backslash in output files.
167 \indexdummies % don't expand commands in the output.
168 \normalturnoffactive % \ in index entries must not stay \, e.g., if
169 % the page break happens to be in the middle of an example.
359a1d0b 170 \shipout\vbox{%
51702635
UD
171 \ifcropmarks \vbox to \outervsize\bgroup
172 \hsize = \outerhsize
173 \line{\ewtop\hfil\ewtop}%
174 \nointerlineskip
175 \line{%
176 \vbox{\moveleft\cornerthick\nstop}%
177 \hfill
178 \vbox{\moveright\cornerthick\nstop}%
179 }%
180 \vskip\topandbottommargin
181 \line\bgroup
182 \hfil % center the page within the outer (page) hsize.
183 \ifodd\pageno\hskip\bindingoffset\fi
184 \vbox\bgroup
779ae82e
UD
185 \fi
186 %
f5311448 187 \unvbox\headlinebox
359a1d0b 188 \pagebody{#1}%
d705269e
UD
189 \ifdim\ht\footlinebox > 0pt
190 % Only leave this space if the footline is nonempty.
191 % (We lessened \vsize for it in \oddfootingxxx.)
192 % The \baselineskip=24pt in plain's \makefootline has no effect.
9c2322bc 193 \vskip 2\baselineskip
d705269e
UD
194 \unvbox\footlinebox
195 \fi
779ae82e
UD
196 %
197 \ifcropmarks
51702635
UD
198 \egroup % end of \vbox\bgroup
199 \hfil\egroup % end of (centering) \line\bgroup
200 \vskip\topandbottommargin plus1fill minus1fill
201 \boxmaxdepth = \cornerthick
202 \line{%
203 \vbox{\moveleft\cornerthick\nsbot}%
204 \hfill
205 \vbox{\moveright\cornerthick\nsbot}%
206 }%
207 \nointerlineskip
208 \line{\ewbot\hfil\ewbot}%
209 \egroup % \vbox from first cropmarks clause
779ae82e 210 \fi
51702635
UD
211 }% end of \shipout\vbox
212 }% end of group with \turnoffactive
359a1d0b
KB
213 \advancepageno
214 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
215}
9e9f9cc2 216
9e9f9cc2
KB
217\newinsert\margin \dimen\margin=\maxdimen
218
219\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
220{\catcode`\@ =11
221\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
222% marginal hacks, juha@viisa.uucp (Juha Takala)
223\ifvoid\margin\else % marginal info is present
224 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
225\dimen@=\dp#1 \unvbox#1
226\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
227\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
228}
229
9e9f9cc2
KB
230% Here are the rules for the cropmarks. Note that they are
231% offset so that the space between them is truly \outerhsize or \outervsize
232% (P. A. MacKay, 12 November, 1986)
233%
234\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
235\def\nstop{\vbox
236 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
237\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
238\def\nsbot{\vbox
239 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
240
241% Parse an argument, then pass it to #1. The argument is the rest of
242% the input line (except we remove a trailing comment). #1 should be a
243% macro which expects an ordinary undelimited TeX argument.
244%
245\def\parsearg#1{%
246 \let\next = #1%
247 \begingroup
248 \obeylines
249 \futurelet\temp\parseargx
250}
251
252% If the next token is an obeyed space (from an @example environment or
253% the like), remove it and recurse. Otherwise, we're done.
254\def\parseargx{%
255 % \obeyedspace is defined far below, after the definition of \sepspaces.
256 \ifx\obeyedspace\temp
257 \expandafter\parseargdiscardspace
258 \else
259 \expandafter\parseargline
260 \fi
261}
262
263% Remove a single space (as the delimiter token to the macro call).
264{\obeyspaces %
265 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
266
267{\obeylines %
268 \gdef\parseargline#1^^M{%
269 \endgroup % End of the group started in \parsearg.
270 %
271 % First remove any @c comment, then any @comment.
272 % Result of each macro is put in \toks0.
273 \argremovec #1\c\relax %
274 \expandafter\argremovecomment \the\toks0 \comment\relax %
275 %
276 % Call the caller's macro, saved as \next in \parsearg.
277 \expandafter\next\expandafter{\the\toks0}%
278 }%
279}
280
281% Since all \c{,omment} does is throw away the argument, we can let TeX
282% do that for us. The \relax here is matched by the \relax in the call
283% in \parseargline; it could be more or less anything, its purpose is
284% just to delimit the argument to the \c.
285\def\argremovec#1\c#2\relax{\toks0 = {#1}}
286\def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
287
288% \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
289% @end itemize @c foo
290% will have two active spaces as part of the argument with the
291% `itemize'. Here we remove all active spaces from #1, and assign the
292% result to \toks0.
293%
294% This loses if there are any *other* active characters besides spaces
295% in the argument -- _ ^ +, for example -- since they get expanded.
296% Fortunately, Texinfo does not define any such commands. (If it ever
297% does, the catcode of the characters in questionwill have to be changed
298% here.) But this means we cannot call \removeactivespaces as part of
299% \argremovec{,omment}, since @c uses \parsearg, and thus the argument
300% that \parsearg gets might well have any character at all in it.
301%
302\def\removeactivespaces#1{%
303 \begingroup
304 \ignoreactivespaces
305 \edef\temp{#1}%
306 \global\toks0 = \expandafter{\temp}%
307 \endgroup
308}
309
310% Change the active space to expand to nothing.
311%
312\begingroup
313 \obeyspaces
314 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
315\endgroup
316
317
318\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
319
320%% These are used to keep @begin/@end levels from running away
321%% Call \inENV within environments (after a \begingroup)
322\newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
323\def\ENVcheck{%
324\ifENV\errmessage{Still within an environment. Type Return to continue.}
325\endgroup\fi} % This is not perfect, but it should reduce lossage
326
327% @begin foo is the same as @foo, for now.
328\newhelp\EMsimple{Type <Return> to continue.}
329
330\outer\def\begin{\parsearg\beginxxx}
331
332\def\beginxxx #1{%
333\expandafter\ifx\csname #1\endcsname\relax
334{\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
335\csname #1\endcsname\fi}
336
337% @end foo executes the definition of \Efoo.
338%
339\def\end{\parsearg\endxxx}
340\def\endxxx #1{%
341 \removeactivespaces{#1}%
342 \edef\endthing{\the\toks0}%
343 %
344 \expandafter\ifx\csname E\endthing\endcsname\relax
345 \expandafter\ifx\csname \endthing\endcsname\relax
346 % There's no \foo, i.e., no ``environment'' foo.
347 \errhelp = \EMsimple
348 \errmessage{Undefined command `@end \endthing'}%
349 \else
350 \unmatchedenderror\endthing
351 \fi
352 \else
353 % Everything's ok; the right environment has been started.
354 \csname E\endthing\endcsname
355 \fi
356}
357
358% There is an environment #1, but it hasn't been started. Give an error.
359%
360\def\unmatchedenderror#1{%
361 \errhelp = \EMsimple
362 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
363}
364
365% Define the control sequence \E#1 to give an unmatched @end error.
366%
367\def\defineunmatchedend#1{%
368 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
369}
370
371
372% Single-spacing is done by various environments (specifically, in
373% \nonfillstart and \quotations).
374\newskip\singlespaceskip \singlespaceskip = 12.5pt
375\def\singlespace{%
376 % Why was this kern here? It messes up equalizing space above and below
377 % environments. --karl, 6may93
378 %{\advance \baselineskip by -\singlespaceskip
379 %\kern \baselineskip}%
380 \setleading \singlespaceskip
381}
382
383%% Simple single-character @ commands
384
385% @@ prints an @
386% Kludge this until the fonts are right (grr).
387\def\@{{\tt \char '100}}
388
389% This is turned off because it was never documented
390% and you can use @w{...} around a quote to suppress ligatures.
391%% Define @` and @' to be the same as ` and '
392%% but suppressing ligatures.
393%\def\`{{`}}
394%\def\'{{'}}
395
396% Used to generate quoted braces.
9e9f9cc2
KB
397\def\mylbrace {{\tt \char '173}}
398\def\myrbrace {{\tt \char '175}}
399\let\{=\mylbrace
400\let\}=\myrbrace
359a1d0b
KB
401\begingroup
402 % Definitions to produce actual \{ & \} command in an index.
403 \catcode`\{ = 12 \catcode`\} = 12
404 \catcode`\[ = 1 \catcode`\] = 2
405 \catcode`\@ = 0 \catcode`\\ = 12
406 @gdef@lbracecmd[\{]%
407 @gdef@rbracecmd[\}]%
408@endgroup
409
410% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
411% Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
412\let\, = \c
413\let\dotaccent = \.
414\def\ringaccent#1{{\accent23 #1}}
415\let\tieaccent = \t
416\let\ubaraccent = \b
417\let\udotaccent = \d
418
419% Other special characters: @questiondown @exclamdown
420% Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
421\def\questiondown{?`}
422\def\exclamdown{!`}
423
424% Dotless i and dotless j, used for accents.
425\def\imacro{i}
426\def\jmacro{j}
427\def\dotless#1{%
428 \def\temp{#1}%
429 \ifx\temp\imacro \ptexi
430 \else\ifx\temp\jmacro \j
431 \else \errmessage{@dotless can be used only with i or j}%
432 \fi\fi
433}
9e9f9cc2
KB
434
435% @: forces normal size whitespace following.
436\def\:{\spacefactor=1000 }
437
438% @* forces a line break.
439\def\*{\hfil\break\hbox{}\ignorespaces}
440
441% @. is an end-of-sentence period.
442\def\.{.\spacefactor=3000 }
443
444% @enddots{} is an end-of-sentence ellipsis.
445\gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000}
446
447% @! is an end-of-sentence bang.
448\gdef\!{!\spacefactor=3000 }
449
450% @? is an end-of-sentence query.
451\gdef\?{?\spacefactor=3000 }
452
453% @w prevents a word break. Without the \leavevmode, @w at the
454% beginning of a paragraph, when TeX is still in vertical mode, would
455% produce a whole line of output instead of starting the paragraph.
456\def\w#1{\leavevmode\hbox{#1}}
457
458% @group ... @end group forces ... to be all on one page, by enclosing
459% it in a TeX vbox. We use \vtop instead of \vbox to construct the box
460% to keep its height that of a normal line. According to the rules for
461% \topskip (p.114 of the TeXbook), the glue inserted is
462% max (\topskip - \ht (first item), 0). If that height is large,
463% therefore, no glue is inserted, and the space between the headline and
464% the text is small, which looks bad.
465%
466\def\group{\begingroup
467 \ifnum\catcode13=\active \else
468 \errhelp = \groupinvalidhelp
469 \errmessage{@group invalid in context where filling is enabled}%
470 \fi
471 %
472 % The \vtop we start below produces a box with normal height and large
473 % depth; thus, TeX puts \baselineskip glue before it, and (when the
474 % next line of text is done) \lineskip glue after it. (See p.82 of
475 % the TeXbook.) Thus, space below is not quite equal to space
476 % above. But it's pretty close.
477 \def\Egroup{%
478 \egroup % End the \vtop.
479 \endgroup % End the \group.
480 }%
481 %
482 \vtop\bgroup
483 % We have to put a strut on the last line in case the @group is in
484 % the midst of an example, rather than completely enclosing it.
485 % Otherwise, the interline space between the last line of the group
486 % and the first line afterwards is too small. But we can't put the
487 % strut in \Egroup, since there it would be on a line by itself.
488 % Hence this just inserts a strut at the beginning of each line.
489 \everypar = {\strut}%
490 %
491 % Since we have a strut on every line, we don't need any of TeX's
492 % normal interline spacing.
493 \offinterlineskip
494 %
495 % OK, but now we have to do something about blank
496 % lines in the input in @example-like environments, which normally
497 % just turn into \lisppar, which will insert no space now that we've
498 % turned off the interline space. Simplest is to make them be an
499 % empty paragraph.
500 \ifx\par\lisppar
501 \edef\par{\leavevmode \par}%
502 %
503 % Reset ^^M's definition to new definition of \par.
504 \obeylines
505 \fi
506 %
507 % Do @comment since we are called inside an environment such as
508 % @example, where each end-of-line in the input causes an
509 % end-of-line in the output. We don't want the end-of-line after
510 % the `@group' to put extra space in the output. Since @group
511 % should appear on a line by itself (according to the Texinfo
512 % manual), we don't worry about eating any user text.
513 \comment
514}
515%
516% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
517% message, so this ends up printing `@group can only ...'.
518%
519\newhelp\groupinvalidhelp{%
520group can only be used in environments such as @example,^^J%
521where each line of input produces a line of output.}
522
523% @need space-in-mils
524% forces a page break if there is not space-in-mils remaining.
525
526\newdimen\mil \mil=0.001in
527
528\def\need{\parsearg\needx}
529
530% Old definition--didn't work.
531%\def\needx #1{\par %
532%% This method tries to make TeX break the page naturally
533%% if the depth of the box does not fit.
534%{\baselineskip=0pt%
535%\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
536%\prevdepth=-1000pt
537%}}
538
539\def\needx#1{%
540 % Go into vertical mode, so we don't make a big box in the middle of a
541 % paragraph.
542 \par
543 %
544 % Don't add any leading before our big empty box, but allow a page
545 % break, since the best break might be right here.
546 \allowbreak
547 \nointerlineskip
548 \vtop to #1\mil{\vfil}%
549 %
550 % TeX does not even consider page breaks if a penalty added to the
551 % main vertical list is 10000 or more. But in order to see if the
552 % empty box we just added fits on the page, we must make it consider
553 % page breaks. On the other hand, we don't want to actually break the
554 % page after the empty box. So we use a penalty of 9999.
555 %
556 % There is an extremely small chance that TeX will actually break the
557 % page at this \penalty, if there are no other feasible breakpoints in
558 % sight. (If the user is using lots of big @group commands, which
559 % almost-but-not-quite fill up a page, TeX will have a hard time doing
560 % good page breaking, for example.) However, I could not construct an
561 % example where a page broke at this \penalty; if it happens in a real
562 % document, then we can reconsider our strategy.
563 \penalty9999
564 %
565 % Back up by the size of the box, whether we did a page break or not.
566 \kern -#1\mil
567 %
568 % Do not allow a page break right after this kern.
569 \nobreak
570}
571
572% @br forces paragraph break
573
574\let\br = \par
575
576% @dots{} output some dots
577
578\def\dots{$\ldots$}
579
580% @page forces the start of a new page
581
582\def\page{\par\vfill\supereject}
583
584% @exdent text....
585% outputs text on separate line in roman font, starting at standard page margin
586
587% This records the amount of indent in the innermost environment.
588% That's how much \exdent should take out.
589\newskip\exdentamount
590
591% This defn is used inside fill environments such as @defun.
592\def\exdent{\parsearg\exdentyyy}
593\def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
594
595% This defn is used inside nofill environments such as @example.
596\def\nofillexdent{\parsearg\nofillexdentyyy}
597\def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
598\leftline{\hskip\leftskip{\rm#1}}}}
599
600% @inmargin{TEXT} puts TEXT in the margin next to the current paragraph.
601
602\def\inmargin#1{%
603\strut\vadjust{\nobreak\kern-\strutdepth
604 \vtop to \strutdepth{\baselineskip\strutdepth\vss
605 \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}}
606\newskip\inmarginspacing \inmarginspacing=1cm
607\def\strutdepth{\dp\strutbox}
608
609%\hbox{{\rm#1}}\hfil\break}}
610
611% @include file insert text of that file as input.
612% Allow normal characters that we make active in the argument (a file name).
613\def\include{\begingroup
614 \catcode`\\=12
615 \catcode`~=12
616 \catcode`^=12
617 \catcode`_=12
618 \catcode`|=12
619 \catcode`<=12
620 \catcode`>=12
621 \catcode`+=12
622 \parsearg\includezzz}
623% Restore active chars for included file.
624\def\includezzz#1{\endgroup\begingroup
625 % Read the included file in a group so nested @include's work.
626 \def\thisfile{#1}%
627 \input\thisfile
628\endgroup}
629
630\def\thisfile{}
631
632% @center line outputs that line, centered
633
634\def\center{\parsearg\centerzzz}
635\def\centerzzz #1{{\advance\hsize by -\leftskip
636\advance\hsize by -\rightskip
637\centerline{#1}}}
638
639% @sp n outputs n lines of vertical space
640
641\def\sp{\parsearg\spxxx}
d66b7b41 642\def\spxxx #1{\vskip #1\baselineskip}
9e9f9cc2
KB
643
644% @comment ...line which is ignored...
645% @c is the same as @comment
646% @ignore ... @end ignore is another way to write a comment
647
648\def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
649\parsearg \commentxxx}
650
651\def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
652
653\let\c=\comment
654
cd4e176c
KB
655% @paragraphindent is defined for the Info formatting commands only.
656\let\paragraphindent=\comment
657
9e9f9cc2
KB
658% Prevent errors for section commands.
659% Used in @ignore and in failing conditionals.
660\def\ignoresections{%
661\let\chapter=\relax
662\let\unnumbered=\relax
663\let\top=\relax
664\let\unnumberedsec=\relax
665\let\unnumberedsection=\relax
666\let\unnumberedsubsec=\relax
667\let\unnumberedsubsection=\relax
668\let\unnumberedsubsubsec=\relax
669\let\unnumberedsubsubsection=\relax
670\let\section=\relax
671\let\subsec=\relax
672\let\subsubsec=\relax
673\let\subsection=\relax
674\let\subsubsection=\relax
675\let\appendix=\relax
676\let\appendixsec=\relax
677\let\appendixsection=\relax
678\let\appendixsubsec=\relax
679\let\appendixsubsection=\relax
680\let\appendixsubsubsec=\relax
681\let\appendixsubsubsection=\relax
682\let\contents=\relax
683\let\smallbook=\relax
684\let\titlepage=\relax
685}
686
687% Used in nested conditionals, where we have to parse the Texinfo source
688% and so want to turn off most commands, in case they are used
689% incorrectly.
690%
691\def\ignoremorecommands{%
692 \let\defcodeindex = \relax
693 \let\defcv = \relax
694 \let\deffn = \relax
695 \let\deffnx = \relax
696 \let\defindex = \relax
697 \let\defivar = \relax
698 \let\defmac = \relax
699 \let\defmethod = \relax
700 \let\defop = \relax
701 \let\defopt = \relax
702 \let\defspec = \relax
703 \let\deftp = \relax
704 \let\deftypefn = \relax
705 \let\deftypefun = \relax
706 \let\deftypevar = \relax
707 \let\deftypevr = \relax
708 \let\defun = \relax
709 \let\defvar = \relax
710 \let\defvr = \relax
711 \let\ref = \relax
712 \let\xref = \relax
713 \let\printindex = \relax
714 \let\pxref = \relax
715 \let\settitle = \relax
716 \let\setchapternewpage = \relax
717 \let\setchapterstyle = \relax
718 \let\everyheading = \relax
719 \let\evenheading = \relax
720 \let\oddheading = \relax
721 \let\everyfooting = \relax
722 \let\evenfooting = \relax
723 \let\oddfooting = \relax
724 \let\headings = \relax
725 \let\include = \relax
726 \let\lowersections = \relax
727 \let\down = \relax
728 \let\raisesections = \relax
729 \let\up = \relax
730 \let\set = \relax
731 \let\clear = \relax
732 \let\item = \relax
733}
734
735% Ignore @ignore ... @end ignore.
736%
737\def\ignore{\doignore{ignore}}
738
762a2918 739% Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
9e9f9cc2
KB
740%
741\def\ifinfo{\doignore{ifinfo}}
742\def\ifhtml{\doignore{ifhtml}}
762a2918 743\def\ifnottex{\doignore{ifnottex}}
9e9f9cc2
KB
744\def\html{\doignore{html}}
745\def\menu{\doignore{menu}}
746\def\direntry{\doignore{direntry}}
747
d66b7b41
KB
748% Also ignore @macro ... @end macro. The user must run texi2dvi,
749% which runs makeinfo to do macro expansion. Ignore @unmacro, too.
750\def\macro{\doignore{macro}}
751\let\unmacro = \comment
752
753
9e9f9cc2
KB
754% @dircategory CATEGORY -- specify a category of the dir file
755% which this file should belong to. Ignore this in TeX.
d66b7b41 756\let\dircategory = \comment
9e9f9cc2
KB
757
758% Ignore text until a line `@end #1'.
759%
760\def\doignore#1{\begingroup
761 % Don't complain about control sequences we have declared \outer.
762 \ignoresections
763 %
764 % Define a command to swallow text until we reach `@end #1'.
765 \long\def\doignoretext##1\end #1{\enddoignore}%
766 %
767 % Make sure that spaces turn into tokens that match what \doignoretext wants.
768 \catcode32 = 10
769 %
762a2918
UD
770 % Ignore braces, too, so mismatched braces don't cause trouble.
771 \catcode`\{ = 9
772 \catcode`\} = 9
773 %
9e9f9cc2
KB
774 % And now expand that command.
775 \doignoretext
776}
777
778% What we do to finish off ignored text.
779%
780\def\enddoignore{\endgroup\ignorespaces}%
781
782\newif\ifwarnedobs\warnedobsfalse
783\def\obstexwarn{%
784 \ifwarnedobs\relax\else
785 % We need to warn folks that they may have trouble with TeX 3.0.
786 % This uses \immediate\write16 rather than \message to get newlines.
787 \immediate\write16{}
788 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
789 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
790 \immediate\write16{If you are running another version of TeX, relax.}
791 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
792 \immediate\write16{ Then upgrade your TeX installation if you can.}
359a1d0b 793 \immediate\write16{ (See ftp://ftp.gnu.ai.mit.edu/pub/gnu/TeX.README.)}
9e9f9cc2
KB
794 \immediate\write16{If you are stuck with version 3.0, run the}
795 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
796 \immediate\write16{ to use a workaround.}
797 \immediate\write16{}
798 \global\warnedobstrue
799 \fi
800}
801
802% **In TeX 3.0, setting text in \nullfont hangs tex. For a
803% workaround (which requires the file ``dummy.tfm'' to be installed),
804% uncomment the following line:
805%%%%%\font\nullfont=dummy\let\obstexwarn=\relax
806
807% Ignore text, except that we keep track of conditional commands for
808% purposes of nesting, up to an `@end #1' command.
809%
810\def\nestedignore#1{%
811 \obstexwarn
812 % We must actually expand the ignored text to look for the @end
813 % command, so that nested ignore constructs work. Thus, we put the
814 % text into a \vbox and then do nothing with the result. To minimize
815 % the change of memory overflow, we follow the approach outlined on
816 % page 401 of the TeXbook: make the current font be a dummy font.
817 %
818 \setbox0 = \vbox\bgroup
819 % Don't complain about control sequences we have declared \outer.
820 \ignoresections
821 %
822 % Define `@end #1' to end the box, which will in turn undefine the
823 % @end command again.
824 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
825 %
826 % We are going to be parsing Texinfo commands. Most cause no
827 % trouble when they are used incorrectly, but some commands do
828 % complicated argument parsing or otherwise get confused, so we
829 % undefine them.
830 %
831 % We can't do anything about stray @-signs, unfortunately;
832 % they'll produce `undefined control sequence' errors.
833 \ignoremorecommands
834 %
835 % Set the current font to be \nullfont, a TeX primitive, and define
836 % all the font commands to also use \nullfont. We don't use
837 % dummy.tfm, as suggested in the TeXbook, because not all sites
838 % might have that installed. Therefore, math mode will still
839 % produce output, but that should be an extremely small amount of
840 % stuff compared to the main input.
841 %
842 \nullfont
843 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
844 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
845 \let\tensf = \nullfont
846 % Similarly for index fonts (mostly for their use in
847 % smallexample)
848 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
849 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
850 \let\indsf = \nullfont
851 %
852 % Don't complain when characters are missing from the fonts.
853 \tracinglostchars = 0
854 %
855 % Don't bother to do space factor calculations.
856 \frenchspacing
857 %
858 % Don't report underfull hboxes.
859 \hbadness = 10000
860 %
861 % Do minimal line-breaking.
862 \pretolerance = 10000
863 %
864 % Do not execute instructions in @tex
762a2918 865 \def\tex{\doignore{tex}}%
9e9f9cc2
KB
866}
867
868% @set VAR sets the variable VAR to an empty value.
869% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
870%
871% Since we want to separate VAR from REST-OF-LINE (which might be
872% empty), we can't just use \parsearg; we have to insert a space of our
873% own to delimit the rest of the line, and then take it out again if we
874% didn't need it. Make sure the catcode of space is correct to avoid
875% losing inside @example, for instance.
876%
fe92af18
KB
877\def\set{\begingroup\catcode` =10
878 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
879 \parsearg\setxxx}
9e9f9cc2
KB
880\def\setxxx#1{\setyyy#1 \endsetyyy}
881\def\setyyy#1 #2\endsetyyy{%
882 \def\temp{#2}%
883 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
884 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
885 \fi
886 \endgroup
887}
888% Can't use \xdef to pre-expand #2 and save some time, since \temp or
889% \next or other control sequences that we've defined might get us into
890% an infinite loop. Consider `@set foo @cite{bar}'.
891\def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
892
893% @clear VAR clears (i.e., unsets) the variable VAR.
894%
895\def\clear{\parsearg\clearxxx}
896\def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
897
898% @value{foo} gets the text saved in variable foo.
899%
fe92af18
KB
900\def\value{\begingroup
901 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
3a3df4c7 902 \valuexxx}
fe92af18
KB
903\def\valuexxx#1{%
904 \expandafter\ifx\csname SET#1\endcsname\relax
905 {\{No value for ``#1''\}}%
906 \else
907 \csname SET#1\endcsname
908 \fi
909\endgroup}
9e9f9cc2
KB
910
911% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
912% with @set.
913%
914\def\ifset{\parsearg\ifsetxxx}
915\def\ifsetxxx #1{%
916 \expandafter\ifx\csname SET#1\endcsname\relax
917 \expandafter\ifsetfail
918 \else
919 \expandafter\ifsetsucceed
920 \fi
921}
922\def\ifsetsucceed{\conditionalsucceed{ifset}}
923\def\ifsetfail{\nestedignore{ifset}}
924\defineunmatchedend{ifset}
925
926% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
927% defined with @set, or has been undefined with @clear.
928%
929\def\ifclear{\parsearg\ifclearxxx}
930\def\ifclearxxx #1{%
931 \expandafter\ifx\csname SET#1\endcsname\relax
932 \expandafter\ifclearsucceed
933 \else
934 \expandafter\ifclearfail
935 \fi
936}
937\def\ifclearsucceed{\conditionalsucceed{ifclear}}
938\def\ifclearfail{\nestedignore{ifclear}}
939\defineunmatchedend{ifclear}
940
762a2918
UD
941% @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
942% following, through the first @end iftex (etc.). Make `@end iftex'
943% (etc.) valid only after an @iftex.
9e9f9cc2
KB
944%
945\def\iftex{\conditionalsucceed{iftex}}
762a2918
UD
946\def\ifnothtml{\conditionalsucceed{ifnothtml}}
947\def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
9e9f9cc2 948\defineunmatchedend{iftex}
762a2918
UD
949\defineunmatchedend{ifnothtml}
950\defineunmatchedend{ifnotinfo}
9e9f9cc2
KB
951
952% We can't just want to start a group at @iftex (for example) and end it
953% at @end iftex, since then @set commands inside the conditional have no
954% effect (they'd get reverted at the end of the group). So we must
955% define \Eiftex to redefine itself to be its previous value. (We can't
956% just define it to fail again with an ``unmatched end'' error, since
957% the @ifset might be nested.)
958%
959\def\conditionalsucceed#1{%
960 \edef\temp{%
961 % Remember the current value of \E#1.
962 \let\nece{prevE#1} = \nece{E#1}%
963 %
964 % At the `@end #1', redefine \E#1 to be its previous value.
965 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
966 }%
967 \temp
968}
969
970% We need to expand lots of \csname's, but we don't want to expand the
971% control sequences after we've constructed them.
972%
973\def\nece#1{\expandafter\noexpand\csname#1\endcsname}
974
975% @asis just yields its argument. Used with @table, for example.
976%
977\def\asis#1{#1}
978
979% @math means output in math mode.
980% We don't use $'s directly in the definition of \math because control
981% sequences like \math are expanded when the toc file is written. Then,
982% we read the toc file back, the $'s will be normal characters (as they
983% should be, according to the definition of Texinfo). So we must use a
984% control sequence to switch into and out of math mode.
985%
986% This isn't quite enough for @math to work properly in indices, but it
987% seems unlikely it will ever be needed there.
988%
989\let\implicitmath = $
990\def\math#1{\implicitmath #1\implicitmath}
991
992% @bullet and @minus need the same treatment as @math, just above.
993\def\bullet{\implicitmath\ptexbullet\implicitmath}
994\def\minus{\implicitmath-\implicitmath}
995
996\def\node{\ENVcheck\parsearg\nodezzz}
997\def\nodezzz#1{\nodexxx [#1,]}
998\def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
999\let\nwnode=\node
1000\let\lastnode=\relax
1001
1002\def\donoderef{\ifx\lastnode\relax\else
1003\expandafter\expandafter\expandafter\setref{\lastnode}\fi
1004\global\let\lastnode=\relax}
1005
1006\def\unnumbnoderef{\ifx\lastnode\relax\else
1007\expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
1008\global\let\lastnode=\relax}
1009
1010\def\appendixnoderef{\ifx\lastnode\relax\else
1011\expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
1012\global\let\lastnode=\relax}
1013
359a1d0b 1014% @refill is a no-op.
9e9f9cc2
KB
1015\let\refill=\relax
1016
1017% @setfilename is done at the beginning of every texinfo file.
1018% So open here the files we need to have open while reading the input.
1019% This makes it possible to make a .fmt file for texinfo.
1020\def\setfilename{%
1021 \readauxfile
1022 \opencontents
1023 \openindices
1024 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1025 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
d705269e
UD
1026 %
1027 % If texinfo.cnf is present on the system, read it.
1028 % Useful for site-wide @afourpaper, etc.
1029 % Just to be on the safe side, close the input stream before the \input.
1030 \openin 1 texinfo.cnf
1031 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
1032 \closein1
1033 \temp
1034 %
9e9f9cc2
KB
1035 \comment % Ignore the actual filename.
1036}
1037
d66b7b41 1038% @bye.
9e9f9cc2
KB
1039\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1040
d66b7b41
KB
1041% \def\macro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\macroxxx}
1042% \def\macroxxx#1#2 \end macro{%
1043% \expandafter\gdef\macrotemp#1{#2}%
1044% \endgroup}
9e9f9cc2
KB
1045
1046%\def\linemacro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\linemacroxxx}
1047%\def\linemacroxxx#1#2 \end linemacro{%
1048%\let\parsearg=\relax
1049%\edef\macrotempx{\csname M\butfirst\expandafter\string\macrotemp\endcsname}%
1050%\expandafter\xdef\macrotemp{\parsearg\macrotempx}%
1051%\expandafter\gdef\macrotempx#1{#2}%
1052%\endgroup}
1053
1054%\def\butfirst#1{}
1055
d66b7b41 1056
9e9f9cc2
KB
1057\message{fonts,}
1058
1059% Font-change commands.
1060
1061% Texinfo supports the sans serif font style, which plain TeX does not.
1062% So we set up a \sf analogous to plain's \rm, etc.
1063\newfam\sffam
1064\def\sf{\fam=\sffam \tensf}
1065\let\li = \sf % Sometimes we call it \li, not \sf.
1066
1067% We don't need math for this one.
1068\def\ttsl{\tenttsl}
1069
b0de3e9e
UD
1070% Use Computer Modern fonts at \magstephalf (11pt).
1071\newcount\mainmagstep
1072\mainmagstep=\magstephalf
9e9f9cc2
KB
1073
1074% Set the font macro #1 to the font named #2, adding on the
1075% specified font prefix (normally `cm').
1076% #3 is the font's design size, #4 is a scale factor
1077\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1078
1079% Use cm as the default font prefix.
1080% To specify the font prefix, you must define \fontprefix
1081% before you read in texinfo.tex.
1082\ifx\fontprefix\undefined
1083\def\fontprefix{cm}
1084\fi
1085% Support font families that don't use the same naming scheme as CM.
1086\def\rmshape{r}
2d07133b 1087\def\rmbshape{bx} %where the normal face is bold
9e9f9cc2
KB
1088\def\bfshape{b}
1089\def\bxshape{bx}
1090\def\ttshape{tt}
1091\def\ttbshape{tt}
1092\def\ttslshape{sltt}
1093\def\itshape{ti}
1094\def\itbshape{bxti}
1095\def\slshape{sl}
1096\def\slbshape{bxsl}
1097\def\sfshape{ss}
1098\def\sfbshape{ss}
1099\def\scshape{csc}
1100\def\scbshape{csc}
1101
1102\ifx\bigger\relax
1103\let\mainmagstep=\magstep1
1104\setfont\textrm\rmshape{12}{1000}
1105\setfont\texttt\ttshape{12}{1000}
1106\else
1107\setfont\textrm\rmshape{10}{\mainmagstep}
1108\setfont\texttt\ttshape{10}{\mainmagstep}
1109\fi
1110% Instead of cmb10, you many want to use cmbx10.
1111% cmbx10 is a prettier font on its own, but cmb10
1112% looks better when embedded in a line with cmr10.
1113\setfont\textbf\bfshape{10}{\mainmagstep}
1114\setfont\textit\itshape{10}{\mainmagstep}
1115\setfont\textsl\slshape{10}{\mainmagstep}
1116\setfont\textsf\sfshape{10}{\mainmagstep}
1117\setfont\textsc\scshape{10}{\mainmagstep}
1118\setfont\textttsl\ttslshape{10}{\mainmagstep}
1119\font\texti=cmmi10 scaled \mainmagstep
1120\font\textsy=cmsy10 scaled \mainmagstep
1121
1122% A few fonts for @defun, etc.
1123\setfont\defbf\bxshape{10}{\magstep1} %was 1314
1124\setfont\deftt\ttshape{10}{\magstep1}
1125\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1126
cd4e176c 1127% Fonts for indices and small examples (9pt).
9e9f9cc2
KB
1128% We actually use the slanted font rather than the italic,
1129% because texinfo normally uses the slanted fonts for that.
1130% Do not make many font distinctions in general in the index, since they
1131% aren't very useful.
1132\setfont\ninett\ttshape{9}{1000}
1133\setfont\indrm\rmshape{9}{1000}
1134\setfont\indit\slshape{9}{1000}
1135\let\indsl=\indit
1136\let\indtt=\ninett
1137\let\indttsl=\ninett
1138\let\indsf=\indrm
1139\let\indbf=\indrm
1140\setfont\indsc\scshape{10}{900}
1141\font\indi=cmmi9
1142\font\indsy=cmsy9
1143
9c2322bc
UD
1144% Fonts for title page:
1145\setfont\titlerm\rmbshape{12}{\magstep3}
1146\setfont\titleit\itbshape{10}{\magstep4}
1147\setfont\titlesl\slbshape{10}{\magstep4}
1148\setfont\titlett\ttbshape{12}{\magstep3}
1149\setfont\titlettsl\ttslshape{10}{\magstep4}
1150\setfont\titlesf\sfbshape{17}{\magstep1}
1151\let\titlebf=\titlerm
1152\setfont\titlesc\scbshape{10}{\magstep4}
1153\font\titlei=cmmi12 scaled \magstep3
1154\font\titlesy=cmsy10 scaled \magstep4
cd6ede75 1155\def\authorrm{\secrm}
9c2322bc 1156
cd4e176c 1157% Chapter (and unnumbered) fonts (17.28pt).
9e9f9cc2
KB
1158\setfont\chaprm\rmbshape{12}{\magstep2}
1159\setfont\chapit\itbshape{10}{\magstep3}
1160\setfont\chapsl\slbshape{10}{\magstep3}
1161\setfont\chaptt\ttbshape{12}{\magstep2}
1162\setfont\chapttsl\ttslshape{10}{\magstep3}
9c2322bc 1163\setfont\chapsf\sfbshape{17}{1000}
9e9f9cc2
KB
1164\let\chapbf=\chaprm
1165\setfont\chapsc\scbshape{10}{\magstep3}
1166\font\chapi=cmmi12 scaled \magstep2
1167\font\chapsy=cmsy10 scaled \magstep3
1168
cd4e176c 1169% Section fonts (14.4pt).
9e9f9cc2
KB
1170\setfont\secrm\rmbshape{12}{\magstep1}
1171\setfont\secit\itbshape{10}{\magstep2}
1172\setfont\secsl\slbshape{10}{\magstep2}
1173\setfont\sectt\ttbshape{12}{\magstep1}
1174\setfont\secttsl\ttslshape{10}{\magstep2}
1175\setfont\secsf\sfbshape{12}{\magstep1}
1176\let\secbf\secrm
1177\setfont\secsc\scbshape{10}{\magstep2}
1178\font\seci=cmmi12 scaled \magstep1
1179\font\secsy=cmsy10 scaled \magstep2
1180
1181% \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1182% \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1183% \setfont\ssecsl\slshape{10}{\magstep1}
1184% \setfont\ssectt\ttshape{10}{\magstep1}
1185% \setfont\ssecsf\sfshape{10}{\magstep1}
1186
2d07133b
KB
1187%\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1188%\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1189%\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
9e9f9cc2
KB
1190%\setfont\ssectt\ttshape{10}{1315}
1191%\setfont\ssecsf\sfshape{10}{1315}
1192
1193%\let\ssecbf=\ssecrm
1194
cd4e176c 1195% Subsection fonts (13.15pt).
9e9f9cc2
KB
1196\setfont\ssecrm\rmbshape{12}{\magstephalf}
1197\setfont\ssecit\itbshape{10}{1315}
1198\setfont\ssecsl\slbshape{10}{1315}
1199\setfont\ssectt\ttbshape{12}{\magstephalf}
9c2322bc 1200\setfont\ssecttsl\ttslshape{10}{1315}
9e9f9cc2
KB
1201\setfont\ssecsf\sfbshape{12}{\magstephalf}
1202\let\ssecbf\ssecrm
1203\setfont\ssecsc\scbshape{10}{\magstep1}
1204\font\sseci=cmmi12 scaled \magstephalf
9c2322bc 1205\font\ssecsy=cmsy10 scaled 1315
9e9f9cc2
KB
1206% The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1207% but that is not a standard magnification.
1208
9e9f9cc2
KB
1209% In order for the font changes to affect most math symbols and letters,
1210% we have to define the \textfont of the standard families. Since
1211% texinfo doesn't allow for producing subscripts and superscripts, we
1212% don't bother to reset \scriptfont and \scriptscriptfont (which would
1213% also require loading a lot more fonts).
1214%
1215\def\resetmathfonts{%
1216 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1217 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1218 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1219}
1220
1221
1222% The font-changing commands redefine the meanings of \tenSTYLE, instead
1223% of just \STYLE. We do this so that font changes will continue to work
1224% in math mode, where it is the current \fam that is relevant in most
1225% cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1226% \tenbf}, for example. By redefining \tenbf, we obviate the need to
1227% redefine \bf itself.
1228\def\textfonts{%
1229 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1230 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1231 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1232 \resetmathfonts}
9c2322bc
UD
1233\def\titlefonts{%
1234 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1235 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1236 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1237 \let\tenttsl=\titlettsl
1238 \resetmathfonts \setleading{25pt}}
2d7da676 1239\def\titlefont#1{{\titlefonts #1}}
9e9f9cc2
KB
1240\def\chapfonts{%
1241 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1242 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1243 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
cd4e176c 1244 \resetmathfonts \setleading{19pt}}
9e9f9cc2
KB
1245\def\secfonts{%
1246 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1247 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1248 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
cd4e176c 1249 \resetmathfonts \setleading{16pt}}
9e9f9cc2
KB
1250\def\subsecfonts{%
1251 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1252 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1253 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
cd4e176c
KB
1254 \resetmathfonts \setleading{15pt}}
1255\let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
9e9f9cc2
KB
1256\def\indexfonts{%
1257 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
1258 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
1259 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy \let\tenttsl=\indttsl
ea6631a2 1260 \resetmathfonts \setleading{12pt}}
9e9f9cc2
KB
1261
1262% Set up the default fonts, so we can use them for creating boxes.
1263%
1264\textfonts
1265
1266% Count depth in font-changes, for error checks
1267\newcount\fontdepth \fontdepth=0
1268
1269% Fonts for short table of contents.
1270\setfont\shortcontrm\rmshape{12}{1000}
1271\setfont\shortcontbf\bxshape{12}{1000}
1272\setfont\shortcontsl\slshape{12}{1000}
1273
1274%% Add scribe-like font environments, plus @l for inline lisp (usually sans
1275%% serif) and @ii for TeX italic
1276
1277% \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1278% unless the following character is such as not to need one.
1279\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1280\def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1281
1282\let\i=\smartitalic
1283\let\var=\smartitalic
1284\let\dfn=\smartitalic
1285\let\emph=\smartitalic
1286\let\cite=\smartitalic
1287
1288\def\b#1{{\bf #1}}
1289\let\strong=\b
1290
1291% We can't just use \exhyphenpenalty, because that only has effect at
1292% the end of a paragraph. Restore normal hyphenation at the end of the
1293% group within which \nohyphenation is presumably called.
1294%
1295\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1296\def\restorehyphenation{\hyphenchar\font = `- }
1297
1298\def\t#1{%
1299 {\tt \rawbackslash \frenchspacing #1}%
1300 \null
1301}
1302\let\ttfont=\t
1303\def\samp #1{`\tclose{#1}'\null}
f77a6b9e
KB
1304\setfont\smallrm\rmshape{8}{1000}
1305\font\smallsy=cmsy9
1306\def\key#1{{\smallrm\textfont2=\smallsy \leavevmode\hbox{%
1307 \raise0.4pt\hbox{$\langle$}\kern-.08em\vtop{%
1308 \vbox{\hrule\kern-0.4pt
b2cd2155 1309 \hbox{\raise0.4pt\hbox{\vphantom{$\langle$}}#1}}%
f77a6b9e
KB
1310 \kern-0.4pt\hrule}%
1311 \kern-.06em\raise0.4pt\hbox{$\rangle$}}}}
474be527 1312% The old definition, with no lozenge:
f77a6b9e 1313%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
9e9f9cc2
KB
1314\def\ctrl #1{{\tt \rawbackslash \hat}#1}
1315
1316\let\file=\samp
9e9f9cc2
KB
1317
1318% @code is a modification of @t,
1319% which makes spaces the same size as normal in the surrounding text.
1320\def\tclose#1{%
1321 {%
1322 % Change normal interword space to be same as for the current font.
1323 \spaceskip = \fontdimen2\font
1324 %
1325 % Switch to typewriter.
1326 \tt
1327 %
1328 % But `\ ' produces the large typewriter interword space.
1329 \def\ {{\spaceskip = 0pt{} }}%
1330 %
1331 % Turn off hyphenation.
1332 \nohyphenation
1333 %
1334 \rawbackslash
1335 \frenchspacing
1336 #1%
1337 }%
1338 \null
1339}
1340
1341% We *must* turn on hyphenation at `-' and `_' in \code.
1342% Otherwise, it is too hard to avoid overfull hboxes
1343% in the Emacs manual, the Library manual, etc.
1344
1345% Unfortunately, TeX uses one parameter (\hyphenchar) to control
1346% both hyphenation at - and hyphenation within words.
1347% We must therefore turn them both off (\tclose does that)
d66b7b41 1348% and arrange explicitly to hyphenate at a dash.
9e9f9cc2
KB
1349% -- rms.
1350{
1351\catcode`\-=\active
1352\catcode`\_=\active
3a3df4c7 1353\catcode`\|=\active
9e9f9cc2
KB
1354\global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1355% The following is used by \doprintindex to insure that long function names
1356% wrap around. It is necessary for - and _ to be active before the index is
1357% read from the file, as \entry parses the arguments long before \code is
1358% ever called. -- mycroft
3a3df4c7
KB
1359% _ is always active; and it shouldn't be \let = to an _ that is a
1360% subscript character anyway. Then, @cindex @samp{_} (for example)
1361% fails. --karl
1362\global\def\indexbreaks{%
1363 \catcode`\-=\active \let-\realdash
1364}
9e9f9cc2
KB
1365}
1366
1367\def\realdash{-}
9e9f9cc2 1368\def\codedash{-\discretionary{}{}{}}
1f205a47 1369\def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}}
9e9f9cc2
KB
1370\def\codex #1{\tclose{#1}\endgroup}
1371
1372%\let\exp=\tclose %Was temporary
1373
1374% @kbd is like @code, except that if the argument is just one @key command,
1375% then @kbd has no effect.
762a2918 1376
9c2322bc
UD
1377% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1378% `example' (@kbd uses ttsl only inside of @example and friends),
1379% or `code' (@kbd uses normal tty font always).
1380\def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1381\def\kbdinputstylexxx#1{%
1382 \def\arg{#1}%
1383 \ifx\arg\worddistinct
1384 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1385 \else\ifx\arg\wordexample
1386 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1387 \else\ifx\arg\wordcode
1388 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1389 \fi\fi\fi
1390}
1391\def\worddistinct{distinct}
1392\def\wordexample{example}
1393\def\wordcode{code}
762a2918 1394
9c2322bc
UD
1395% Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1396% the catcodes are wrong for parsearg to work.)
1397\gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
762a2918
UD
1398
1399% If you use @setkbdinputexample, then @kbd produces slanted tty font
1400% only inside of @example and friends.
1401\def\setkbdinputexample{\gdef\kbdexamplefont\ttsl}
1402
9e9f9cc2
KB
1403\def\xkey{\key}
1404\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1405\ifx\one\xkey\ifx\threex\three \key{#2}%
762a2918
UD
1406\else{\tclose{\kbdfont\look}}\fi
1407\else{\tclose{\kbdfont\look}}\fi}
9e9f9cc2 1408
3996f34b
UD
1409% @url. Quotes do not seem necessary, so use \code.
1410\let\url=\code
1f205a47 1411
714a562f
UD
1412% @uref (abbreviation for `urlref') takes an optional second argument
1413% specifying the text to display. First (mandatory) arg is the url.
3996f34b 1414% Perhaps eventually put in a hypertex \special here.
ce37fa88 1415%
714a562f
UD
1416\def\uref#1{\urefxxx #1,,\finish}
1417\def\urefxxx#1,#2,#3\finish{%
1418 \setbox0 = \hbox{\ignorespaces #2}%
1419 \ifdim\wd0 > 0pt
1420 \unhbox0\ (\code{#1})%
1421 \else
1422 \code{#1}%
1423 \fi
1424}
1425
3996f34b
UD
1426% rms does not like the angle brackets --karl, 17may97.
1427% So now @email is just like @uref.
1428%\def\email#1{$\langle${\tt #1}$\rangle$}
1429\let\email=\uref
1430
9e9f9cc2
KB
1431% Check if we are currently using a typewriter font. Since all the
1432% Computer Modern typewriter fonts have zero interword stretch (and
1433% shrink), and it is reasonable to expect all typewriter fonts to have
1434% this property, we can check that font parameter.
10dc2a90 1435%
9e9f9cc2
KB
1436\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1437
1438% Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1439% argument is to make the input look right: @dmn{pt} instead of
1440% @dmn{}pt.
1441%
1442\def\dmn#1{\thinspace #1}
1443
1444\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1445
359a1d0b
KB
1446% @l was never documented to mean ``switch to the Lisp font'',
1447% and it is not used as such in any manual I can find. We need it for
1448% Polish suppressed-l. --karl, 22sep96.
1449%\def\l#1{{\li #1}\null}
9e9f9cc2 1450
2d07133b 1451\def\r#1{{\rm #1}} % roman font
9e9f9cc2 1452% Use of \lowercase was suggested.
2d07133b
KB
1453\def\sc#1{{\smallcaps#1}} % smallcaps font
1454\def\ii#1{{\it #1}} % italic font
9e9f9cc2 1455
474be527 1456% @pounds{} is a sterling sign.
d66b7b41
KB
1457\def\pounds{{\it\$}}
1458
474be527 1459
9e9f9cc2
KB
1460\message{page headings,}
1461
1462\newskip\titlepagetopglue \titlepagetopglue = 1.5in
1463\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1464
1465% First the title page. Must do @settitle before @titlepage.
9e9f9cc2
KB
1466\newif\ifseenauthor
1467\newif\iffinishedtitlepage
1468
1469\def\shorttitlepage{\parsearg\shorttitlepagezzz}
1470\def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2d07133b 1471 \endgroup\page\hbox{}\page}
9e9f9cc2
KB
1472
1473\def\titlepage{\begingroup \parindent=0pt \textfonts
1474 \let\subtitlerm=\tenrm
1475% I deinstalled the following change because \cmr12 is undefined.
1476% This change was not in the ChangeLog anyway. --rms.
1477% \let\subtitlerm=\cmr12
1478 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1479 %
1480 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1481 %
1482 % Leave some space at the very top of the page.
1483 \vglue\titlepagetopglue
1484 %
1485 % Now you can print the title using @title.
1486 \def\title{\parsearg\titlezzz}%
9c2322bc 1487 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
2d07133b
KB
1488 % print a rule at the page bottom also.
1489 \finishedtitlepagefalse
1490 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
9e9f9cc2
KB
1491 % No rule at page bottom unless we print one at the top with @title.
1492 \finishedtitlepagetrue
1493 %
1494 % Now you can put text using @subtitle.
1495 \def\subtitle{\parsearg\subtitlezzz}%
1496 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1497 %
1498 % @author should come last, but may come many times.
1499 \def\author{\parsearg\authorzzz}%
1500 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1501 {\authorfont \leftline{##1}}}%
1502 %
1503 % Most title ``pages'' are actually two pages long, with space
1504 % at the top of the second. We don't want the ragged left on the second.
1505 \let\oldpage = \page
1506 \def\page{%
1507 \iffinishedtitlepage\else
2d07133b 1508 \finishtitlepage
9e9f9cc2
KB
1509 \fi
1510 \oldpage
1511 \let\page = \oldpage
1512 \hbox{}}%
1513% \def\page{\oldpage \hbox{}}
1514}
1515
1516\def\Etitlepage{%
1517 \iffinishedtitlepage\else
1518 \finishtitlepage
1519 \fi
1520 % It is important to do the page break before ending the group,
1521 % because the headline and footline are only empty inside the group.
1522 % If we use the new definition of \page, we always get a blank page
1523 % after the title page, which we certainly don't want.
1524 \oldpage
1525 \endgroup
1526 \HEADINGSon
1527}
1528
1529\def\finishtitlepage{%
1530 \vskip4pt \hrule height 2pt width \hsize
1531 \vskip\titlepagebottomglue
1532 \finishedtitlepagetrue
1533}
1534
1535%%% Set up page headings and footings.
1536
1537\let\thispage=\folio
1538
1539\newtoks \evenheadline % Token sequence for heading line of even pages
1540\newtoks \oddheadline % Token sequence for heading line of odd pages
1541\newtoks \evenfootline % Token sequence for footing line of even pages
1542\newtoks \oddfootline % Token sequence for footing line of odd pages
1543
1544% Now make Tex use those variables
1545\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1546 \else \the\evenheadline \fi}}
1547\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1548 \else \the\evenfootline \fi}\HEADINGShook}
1549\let\HEADINGShook=\relax
1550
1551% Commands to set those variables.
1552% For example, this is what @headings on does
1553% @evenheading @thistitle|@thispage|@thischapter
1554% @oddheading @thischapter|@thispage|@thistitle
1555% @evenfooting @thisfile||
1556% @oddfooting ||@thisfile
1557
1558\def\evenheading{\parsearg\evenheadingxxx}
1559\def\oddheading{\parsearg\oddheadingxxx}
1560\def\everyheading{\parsearg\everyheadingxxx}
1561
1562\def\evenfooting{\parsearg\evenfootingxxx}
1563\def\oddfooting{\parsearg\oddfootingxxx}
1564\def\everyfooting{\parsearg\everyfootingxxx}
1565
1566{\catcode`\@=0 %
1567
1568\gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1569\gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1570\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1571
1572\gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1573\gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1574\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1575
d705269e 1576\gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
9e9f9cc2
KB
1577
1578\gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1579\gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1580\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1581
1582\gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1583\gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
d705269e
UD
1584 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1585 %
1586 % Leave some space for the footline. Hopefully ok to assume
1587 % @evenfooting will not be used by itself.
762a2918
UD
1588 \global\advance\pageheight by -\baselineskip
1589 \global\advance\vsize by -\baselineskip
d705269e 1590}
9e9f9cc2 1591
d705269e 1592\gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
9e9f9cc2
KB
1593%
1594}% unbind the catcode of @.
1595
2d07133b
KB
1596% @headings double turns headings on for double-sided printing.
1597% @headings single turns headings on for single-sided printing.
1598% @headings off turns them off.
1599% @headings on same as @headings double, retained for compatibility.
1600% @headings after turns on double-sided headings after this page.
1601% @headings doubleafter turns on double-sided headings after this page.
9e9f9cc2 1602% @headings singleafter turns on single-sided headings after this page.
793fde8a
KB
1603% By default, they are off at the start of a document,
1604% and turned `on' after @end titlepage.
9e9f9cc2
KB
1605
1606\def\headings #1 {\csname HEADINGS#1\endcsname}
1607
1608\def\HEADINGSoff{
1609\global\evenheadline={\hfil} \global\evenfootline={\hfil}
1610\global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1611\HEADINGSoff
1612% When we turn headings on, set the page number to 1.
1613% For double-sided printing, put current file name in lower left corner,
1614% chapter name on inside top of right hand pages, document
1615% title on inside top of left hand pages, and page numbers on outside top
1616% edge of all pages.
1617\def\HEADINGSdouble{
9e9f9cc2
KB
1618\global\pageno=1
1619\global\evenfootline={\hfil}
1620\global\oddfootline={\hfil}
1621\global\evenheadline={\line{\folio\hfil\thistitle}}
1622\global\oddheadline={\line{\thischapter\hfil\folio}}
793fde8a 1623\global\let\contentsalignmacro = \chapoddpage
9e9f9cc2 1624}
793fde8a
KB
1625\let\contentsalignmacro = \chappager
1626
9e9f9cc2
KB
1627% For single-sided printing, chapter title goes across top left of page,
1628% page number on top right.
1629\def\HEADINGSsingle{
9e9f9cc2
KB
1630\global\pageno=1
1631\global\evenfootline={\hfil}
1632\global\oddfootline={\hfil}
1633\global\evenheadline={\line{\thischapter\hfil\folio}}
1634\global\oddheadline={\line{\thischapter\hfil\folio}}
793fde8a 1635\global\let\contentsalignmacro = \chappager
9e9f9cc2
KB
1636}
1637\def\HEADINGSon{\HEADINGSdouble}
1638
1639\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1640\let\HEADINGSdoubleafter=\HEADINGSafter
1641\def\HEADINGSdoublex{%
1642\global\evenfootline={\hfil}
1643\global\oddfootline={\hfil}
1644\global\evenheadline={\line{\folio\hfil\thistitle}}
1645\global\oddheadline={\line{\thischapter\hfil\folio}}
793fde8a 1646\global\let\contentsalignmacro = \chapoddpage
9e9f9cc2
KB
1647}
1648
1649\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1650\def\HEADINGSsinglex{%
1651\global\evenfootline={\hfil}
1652\global\oddfootline={\hfil}
1653\global\evenheadline={\line{\thischapter\hfil\folio}}
1654\global\oddheadline={\line{\thischapter\hfil\folio}}
793fde8a 1655\global\let\contentsalignmacro = \chappager
9e9f9cc2
KB
1656}
1657
1658% Subroutines used in generating headings
1659% Produces Day Month Year style of output.
1660\def\today{\number\day\space
1661\ifcase\month\or
1662January\or February\or March\or April\or May\or June\or
1663July\or August\or September\or October\or November\or December\fi
1664\space\number\year}
1665
1666% Use this if you want the Month Day, Year style of output.
1667%\def\today{\ifcase\month\or
1668%January\or February\or March\or April\or May\or June\or
1669%July\or August\or September\or October\or November\or December\fi
1670%\space\number\day, \number\year}
1671
1672% @settitle line... specifies the title of the document, for headings
1673% It generates no output of its own
1674
1675\def\thistitle{No Title}
1676\def\settitle{\parsearg\settitlezzz}
1677\def\settitlezzz #1{\gdef\thistitle{#1}}
1678
d66b7b41 1679
9e9f9cc2
KB
1680\message{tables,}
1681
1682% @tabs -- simple alignment
1683
1684% These don't work. For one thing, \+ is defined as outer.
1685% So these macros cannot even be defined.
1686
1687%\def\tabs{\parsearg\tabszzz}
1688%\def\tabszzz #1{\settabs\+#1\cr}
1689%\def\tabline{\parsearg\tablinezzz}
1690%\def\tablinezzz #1{\+#1\cr}
1691%\def\&{&}
1692
1693% Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1694
1695% default indentation of table text
1696\newdimen\tableindent \tableindent=.8in
1697% default indentation of @itemize and @enumerate text
1698\newdimen\itemindent \itemindent=.3in
1699% margin between end of table item and start of table text.
1700\newdimen\itemmargin \itemmargin=.1in
1701
1702% used internally for \itemindent minus \itemmargin
1703\newdimen\itemmax
1704
1705% Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1706% these defs.
1707% They also define \itemindex
1708% to index the item name in whatever manner is desired (perhaps none).
1709
1710\newif\ifitemxneedsnegativevskip
1711
1712\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1713
1714\def\internalBitem{\smallbreak \parsearg\itemzzz}
1715\def\internalBitemx{\itemxpar \parsearg\itemzzz}
1716
1717\def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1718\def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1719
1720\def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1721\def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1722
1723\def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1724 \itemzzz {#1}}
1725
1726\def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1727 \itemzzz {#1}}
1728
1729\def\itemzzz #1{\begingroup %
1730 \advance\hsize by -\rightskip
1731 \advance\hsize by -\tableindent
1732 \setbox0=\hbox{\itemfont{#1}}%
1733 \itemindex{#1}%
1734 \nobreak % This prevents a break before @itemx.
1735 %
1736 % Be sure we are not still in the middle of a paragraph.
1737 %{\parskip = 0in
1738 %\par
1739 %}%
1740 %
1741 % If the item text does not fit in the space we have, put it on a line
1742 % by itself, and do not allow a page break either before or after that
1743 % line. We do not start a paragraph here because then if the next
1744 % command is, e.g., @kindex, the whatsit would get put into the
1745 % horizontal list on a line by itself, resulting in extra blank space.
1746 \ifdim \wd0>\itemmax
1747 %
1748 % Make this a paragraph so we get the \parskip glue and wrapping,
1749 % but leave it ragged-right.
1750 \begingroup
1751 \advance\leftskip by-\tableindent
1752 \advance\hsize by\tableindent
1753 \advance\rightskip by0pt plus1fil
1754 \leavevmode\unhbox0\par
1755 \endgroup
1756 %
1757 % We're going to be starting a paragraph, but we don't want the
1758 % \parskip glue -- logically it's part of the @item we just started.
1759 \nobreak \vskip-\parskip
1760 %
1761 % Stop a page break at the \parskip glue coming up. Unfortunately
1762 % we can't prevent a possible page break at the following
1763 % \baselineskip glue.
1764 \nobreak
1765 \endgroup
1766 \itemxneedsnegativevskipfalse
1767 \else
1768 % The item text fits into the space. Start a paragraph, so that the
1769 % following text (if any) will end up on the same line. Since that
1770 % text will be indented by \tableindent, we make the item text be in
1771 % a zero-width box.
1772 \noindent
1773 \rlap{\hskip -\tableindent\box0}\ignorespaces%
1774 \endgroup%
1775 \itemxneedsnegativevskiptrue%
1776 \fi
1777}
1778
1779\def\item{\errmessage{@item while not in a table}}
1780\def\itemx{\errmessage{@itemx while not in a table}}
1781\def\kitem{\errmessage{@kitem while not in a table}}
1782\def\kitemx{\errmessage{@kitemx while not in a table}}
1783\def\xitem{\errmessage{@xitem while not in a table}}
1784\def\xitemx{\errmessage{@xitemx while not in a table}}
1785
1786%% Contains a kludge to get @end[description] to work
1787\def\description{\tablez{\dontindex}{1}{}{}{}{}}
1788
1789\def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1790{\obeylines\obeyspaces%
1791\gdef\tablex #1^^M{%
1792\tabley\dontindex#1 \endtabley}}
1793
1794\def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1795{\obeylines\obeyspaces%
1796\gdef\ftablex #1^^M{%
1797\tabley\fnitemindex#1 \endtabley
1798\def\Eftable{\endgraf\afterenvbreak\endgroup}%
1799\let\Etable=\relax}}
1800
1801\def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1802{\obeylines\obeyspaces%
1803\gdef\vtablex #1^^M{%
1804\tabley\vritemindex#1 \endtabley
1805\def\Evtable{\endgraf\afterenvbreak\endgroup}%
1806\let\Etable=\relax}}
1807
1808\def\dontindex #1{}
1809\def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1810\def\vritemindex #1{\doind {vr}{\code{#1}}}%
1811
1812{\obeyspaces %
1813\gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1814\tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1815
1816\def\tablez #1#2#3#4#5#6{%
1817\aboveenvbreak %
1818\begingroup %
1819\def\Edescription{\Etable}% Necessary kludge.
1820\let\itemindex=#1%
1821\ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1822\ifnum 0#4>0 \tableindent=#4\mil \fi %
1823\ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1824\def\itemfont{#2}%
1825\itemmax=\tableindent %
1826\advance \itemmax by -\itemmargin %
1827\advance \leftskip by \tableindent %
1828\exdentamount=\tableindent
1829\parindent = 0pt
1830\parskip = \smallskipamount
1831\ifdim \parskip=0pt \parskip=2pt \fi%
1832\def\Etable{\endgraf\afterenvbreak\endgroup}%
1833\let\item = \internalBitem %
1834\let\itemx = \internalBitemx %
1835\let\kitem = \internalBkitem %
1836\let\kitemx = \internalBkitemx %
1837\let\xitem = \internalBxitem %
1838\let\xitemx = \internalBxitemx %
1839}
1840
1841% This is the counter used by @enumerate, which is really @itemize
1842
1843\newcount \itemno
1844
1845\def\itemize{\parsearg\itemizezzz}
1846
1847\def\itemizezzz #1{%
1848 \begingroup % ended by the @end itemsize
1849 \itemizey {#1}{\Eitemize}
1850}
1851
1852\def\itemizey #1#2{%
1853\aboveenvbreak %
1854\itemmax=\itemindent %
1855\advance \itemmax by -\itemmargin %
1856\advance \leftskip by \itemindent %
1857\exdentamount=\itemindent
1858\parindent = 0pt %
1859\parskip = \smallskipamount %
1860\ifdim \parskip=0pt \parskip=2pt \fi%
1861\def#2{\endgraf\afterenvbreak\endgroup}%
1862\def\itemcontents{#1}%
1863\let\item=\itemizeitem}
1864
1865% Set sfcode to normal for the chars that usually have another value.
1866% These are `.?!:;,'
1867\def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1868 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1869
1870% \splitoff TOKENS\endmark defines \first to be the first token in
1871% TOKENS, and \rest to be the remainder.
1872%
1873\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1874
1875% Allow an optional argument of an uppercase letter, lowercase letter,
1876% or number, to specify the first label in the enumerated list. No
1877% argument is the same as `1'.
1878%
1879\def\enumerate{\parsearg\enumeratezzz}
1880\def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1881\def\enumeratey #1 #2\endenumeratey{%
1882 \begingroup % ended by the @end enumerate
1883 %
1884 % If we were given no argument, pretend we were given `1'.
1885 \def\thearg{#1}%
1886 \ifx\thearg\empty \def\thearg{1}\fi
1887 %
1888 % Detect if the argument is a single token. If so, it might be a
1889 % letter. Otherwise, the only valid thing it can be is a number.
1890 % (We will always have one token, because of the test we just made.
1891 % This is a good thing, since \splitoff doesn't work given nothing at
1892 % all -- the first parameter is undelimited.)
1893 \expandafter\splitoff\thearg\endmark
1894 \ifx\rest\empty
1895 % Only one token in the argument. It could still be anything.
1896 % A ``lowercase letter'' is one whose \lccode is nonzero.
1897 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1898 % not equal to itself.
1899 % Otherwise, we assume it's a number.
1900 %
1901 % We need the \relax at the end of the \ifnum lines to stop TeX from
1902 % continuing to look for a <number>.
1903 %
1904 \ifnum\lccode\expandafter`\thearg=0\relax
1905 \numericenumerate % a number (we hope)
1906 \else
1907 % It's a letter.
1908 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1909 \lowercaseenumerate % lowercase letter
1910 \else
1911 \uppercaseenumerate % uppercase letter
1912 \fi
1913 \fi
1914 \else
1915 % Multiple tokens in the argument. We hope it's a number.
1916 \numericenumerate
1917 \fi
1918}
1919
1920% An @enumerate whose labels are integers. The starting integer is
1921% given in \thearg.
1922%
1923\def\numericenumerate{%
1924 \itemno = \thearg
1925 \startenumeration{\the\itemno}%
1926}
1927
1928% The starting (lowercase) letter is in \thearg.
1929\def\lowercaseenumerate{%
1930 \itemno = \expandafter`\thearg
1931 \startenumeration{%
1932 % Be sure we're not beyond the end of the alphabet.
1933 \ifnum\itemno=0
1934 \errmessage{No more lowercase letters in @enumerate; get a bigger
1935 alphabet}%
1936 \fi
1937 \char\lccode\itemno
1938 }%
1939}
1940
1941% The starting (uppercase) letter is in \thearg.
1942\def\uppercaseenumerate{%
1943 \itemno = \expandafter`\thearg
1944 \startenumeration{%
1945 % Be sure we're not beyond the end of the alphabet.
1946 \ifnum\itemno=0
1947 \errmessage{No more uppercase letters in @enumerate; get a bigger
1948 alphabet}
1949 \fi
1950 \char\uccode\itemno
1951 }%
1952}
1953
1954% Call itemizey, adding a period to the first argument and supplying the
1955% common last two arguments. Also subtract one from the initial value in
1956% \itemno, since @item increments \itemno.
1957%
1958\def\startenumeration#1{%
1959 \advance\itemno by -1
1960 \itemizey{#1.}\Eenumerate\flushcr
1961}
1962
1963% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1964% to @enumerate.
1965%
1966\def\alphaenumerate{\enumerate{a}}
1967\def\capsenumerate{\enumerate{A}}
1968\def\Ealphaenumerate{\Eenumerate}
1969\def\Ecapsenumerate{\Eenumerate}
1970
1971% Definition of @item while inside @itemize.
1972
1973\def\itemizeitem{%
1974\advance\itemno by 1
1975{\let\par=\endgraf \smallbreak}%
ebbad4cc 1976\ifhmode \errmessage{In hmode at itemizeitem}\fi
9e9f9cc2
KB
1977{\parskip=0in \hskip 0pt
1978\hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1979\vadjust{\penalty 1200}}%
1980\flushcr}
1981
1982% @multitable macros
1983% Amy Hendrickson, 8/18/94, 3/6/96
1984%
1985% @multitable ... @end multitable will make as many columns as desired.
1986% Contents of each column will wrap at width given in preamble. Width
1987% can be specified either with sample text given in a template line,
1988% or in percent of \hsize, the current width of text on page.
1989
1990% Table can continue over pages but will only break between lines.
1991
1992% To make preamble:
1993%
10dc2a90 1994% Either define widths of columns in terms of percent of \hsize:
9e9f9cc2
KB
1995% @multitable @columnfractions .25 .3 .45
1996% @item ...
1997%
1998% Numbers following @columnfractions are the percent of the total
1999% current hsize to be used for each column. You may use as many
2000% columns as desired.
2001
d66b7b41 2002
9e9f9cc2
KB
2003% Or use a template:
2004% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2005% @item ...
2006% using the widest term desired in each column.
2007%
2008% For those who want to use more than one line's worth of words in
2009% the preamble, break the line within one argument and it
2010% will parse correctly, i.e.,
2011%
10dc2a90 2012% @multitable {Column 1 template} {Column 2 template} {Column 3
9e9f9cc2
KB
2013% template}
2014% Not:
10dc2a90 2015% @multitable {Column 1 template} {Column 2 template}
9e9f9cc2
KB
2016% {Column 3 template}
2017
10dc2a90 2018% Each new table line starts with @item, each subsequent new column
9e9f9cc2
KB
2019% starts with @tab. Empty columns may be produced by supplying @tab's
2020% with nothing between them for as many times as empty columns are needed,
2021% ie, @tab@tab@tab will produce two empty columns.
2022
d66b7b41 2023% @item, @tab, @multitable or @end multitable do not need to be on their
9e9f9cc2
KB
2024% own lines, but it will not hurt if they are.
2025
2026% Sample multitable:
2027
2028% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2029% @item first col stuff @tab second col stuff @tab third col
10dc2a90
UD
2030% @item
2031% first col stuff
2032% @tab
2033% second col stuff
2034% @tab
2035% third col
2036% @item first col stuff @tab second col stuff
9e9f9cc2 2037% @tab Many paragraphs of text may be used in any column.
10dc2a90 2038%
9e9f9cc2
KB
2039% They will wrap at the width determined by the template.
2040% @item@tab@tab This will be in third column.
2041% @end multitable
2042
2043% Default dimensions may be reset by user.
2044% @multitableparskip is vertical space between paragraphs in table.
2045% @multitableparindent is paragraph indent in table.
2046% @multitablecolmargin is horizontal space to be left between columns.
2047% @multitablelinespace is space to leave between table items, baseline
2048% to baseline.
2049% 0pt means it depends on current normal line spacing.
2050
2051%%%%
10dc2a90 2052% Dimensions
9e9f9cc2
KB
2053
2054\newskip\multitableparskip
2055\newskip\multitableparindent
2056\newdimen\multitablecolspace
2057\newskip\multitablelinespace
2058\multitableparskip=0pt
2059\multitableparindent=6pt
2060\multitablecolspace=12pt
2061\multitablelinespace=0pt
2062
2063%%%%
2064% Macros used to set up halign preamble:
2065\let\endsetuptable\relax
2066\def\xendsetuptable{\endsetuptable}
2067\let\columnfractions\relax
2068\def\xcolumnfractions{\columnfractions}
2069\newif\ifsetpercent
2070
2071%% 2/1/96, to allow fractions to be given with more than one digit.
2072\def\pickupwholefraction#1 {\global\advance\colcount by1 %
2073\expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}%
2074\setuptable}
2075
2076\newcount\colcount
2077\def\setuptable#1{\def\firstarg{#1}%
2078\ifx\firstarg\xendsetuptable\let\go\relax%
2079\else
2080 \ifx\firstarg\xcolumnfractions\global\setpercenttrue%
2081 \else
2082 \ifsetpercent
2083 \let\go\pickupwholefraction % In this case arg of setuptable
2084 % is the decimal point before the
2085 % number given in percent of hsize.
2086 % We don't need this so we don't use it.
2087 \else
2088 \global\advance\colcount by1
359a1d0b
KB
2089 \setbox0=\hbox{#1 }% Add a normal word space as a separator;
2090 % typically that is always in the input, anyway.
9e9f9cc2
KB
2091 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2092 \fi%
2093 \fi%
2094\ifx\go\pickupwholefraction\else\let\go\setuptable\fi%
2095\fi\go}
2096
2097%%%%
2098% multitable syntax
2099\def\tab{&\hskip1sp\relax} % 2/2/96
2100 % tiny skip here makes sure this column space is
2101 % maintained, even if it is never used.
2102
2103
2104%%%%
2105% @multitable ... @end multitable definitions:
2106
2107\def\multitable{\parsearg\dotable}
2108
2109\def\dotable#1{\bgroup
2110\let\item\cr
2111\tolerance=9500
2112\hbadness=9500
2113\setmultitablespacing
2114\parskip=\multitableparskip
2115\parindent=\multitableparindent
2116\overfullrule=0pt
2117\global\colcount=0\relax%
2118\def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
2119 % To parse everything between @multitable and @item :
2120\setuptable#1 \endsetuptable
2121 % Need to reset this to 0 after \setuptable.
10dc2a90 2122\global\colcount=0\relax%
9e9f9cc2
KB
2123 %
2124 % This preamble sets up a generic column definition, which will
2125 % be used as many times as user calls for columns.
10dc2a90 2126 % \vtop will set a single line and will also let text wrap and
9e9f9cc2
KB
2127 % continue for many paragraphs if desired.
2128\halign\bgroup&\global\advance\colcount by 1\relax%
2129\multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2130 % In order to keep entries from bumping into each other
2131 % we will add a \leftskip of \multitablecolspace to all columns after
2132 % the first one.
10dc2a90 2133 % If a template has been used, we will add \multitablecolspace
9e9f9cc2
KB
2134 % to the width of each template entry.
2135 % If user has set preamble in terms of percent of \hsize
2136 % we will use that dimension as the width of the column, and
2137 % the \leftskip will keep entries from bumping into each other.
2138 % Table will start at left margin and final column will justify at
2139 % right margin.
2140\ifnum\colcount=1
2141\else
2142 \ifsetpercent
2143 \else
2144 % If user has <not> set preamble in terms of percent of \hsize
10dc2a90 2145 % we will advance \hsize by \multitablecolspace
9e9f9cc2
KB
2146 \advance\hsize by \multitablecolspace
2147 \fi
2148 % In either case we will make \leftskip=\multitablecolspace:
2149\leftskip=\multitablecolspace
2150\fi
3a3df4c7
KB
2151 % Ignoring space at the beginning and end avoids an occasional spurious
2152 % blank line, when TeX decides to break the line at the space before the
2153 % box from the multistrut, so the strut ends up on a line by itself.
2154 % For example:
2155 % @multitable @columnfractions .11 .89
2156 % @item @code{#}
2157 % @tab Legal holiday which is valid in major parts of the whole country.
cc2af7ea 2158 % Is automatically provided with highlighting sequences respectively marking
3a3df4c7
KB
2159 % characters.
2160 \noindent\ignorespaces##\unskip\multistrut}\cr
9e9f9cc2 2161 % \everycr will reset column counter, \colcount, at the end of
3e99cd6f 2162 % each line. Every column entry will cause \colcount to advance by one.
9e9f9cc2
KB
2163 % The table preamble
2164 % looks at the current \colcount to find the correct column width.
2165\global\everycr{\noalign{%
f5311448
KB
2166% \filbreak%% keeps underfull box messages off when table breaks over pages.
2167% Maybe so, but it also creates really weird page breaks when the table
2168% breaks over pages Wouldn't \vfil be better? Wait until the problem
2169% manifests itself, so it can be fixed for real --karl.
9e9f9cc2
KB
2170\global\colcount=0\relax}}
2171}
2172
ce37fa88 2173\def\setmultitablespacing{% test to see if user has set \multitablelinespace.
9e9f9cc2
KB
2174% If so, do nothing. If not, give it an appropriate dimension based on
2175% current baselineskip.
9e9f9cc2
KB
2176\ifdim\multitablelinespace=0pt
2177%% strut to put in table in case some entry doesn't have descenders,
2178%% to keep lines equally spaced
359a1d0b 2179\let\multistrut = \strut
9e9f9cc2 2180%% Test to see if parskip is larger than space between lines of
10dc2a90 2181%% table. If not, do nothing.
9e9f9cc2
KB
2182%% If so, set to same dimension as multitablelinespace.
2183\else
2184\gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2185width0pt\relax} \fi
2186\ifdim\multitableparskip>\multitablelinespace
2187\global\multitableparskip=\multitablelinespace
2188\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2189 %% than skip between lines in the table.
2190\fi%
2191\ifdim\multitableparskip=0pt
2192\global\multitableparskip=\multitablelinespace
2193\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2194 %% than skip between lines in the table.
2195\fi}
d66b7b41
KB
2196
2197
9e9f9cc2
KB
2198\message{indexing,}
2199% Index generation facilities
2200
2201% Define \newwrite to be identical to plain tex's \newwrite
2202% except not \outer, so it can be used within \newindex.
2203{\catcode`\@=11
2204\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2205
2206% \newindex {foo} defines an index named foo.
2207% It automatically defines \fooindex such that
2208% \fooindex ...rest of line... puts an entry in the index foo.
2209% It also defines \fooindfile to be the number of the output channel for
2d07133b 2210% the file that accumulates this index. The file's extension is foo.
9e9f9cc2
KB
2211% The name of an index should be no more than 2 characters long
2212% for the sake of vms.
2213
2214\def\newindex #1{
2215\expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2d07133b
KB
2216\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2217\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
9e9f9cc2
KB
2218\noexpand\doindex {#1}}
2219}
2220
2221% @defindex foo == \newindex{foo}
2222
2223\def\defindex{\parsearg\newindex}
2224
2225% Define @defcodeindex, like @defindex except put all entries in @code.
2226
2227\def\newcodeindex #1{
2228\expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
2d07133b
KB
2229\openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2230\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
9e9f9cc2
KB
2231\noexpand\docodeindex {#1}}
2232}
2233
2234\def\defcodeindex{\parsearg\newcodeindex}
2235
2236% @synindex foo bar makes index foo feed into index bar.
2237% Do this instead of @defindex foo if you don't want it as a separate index.
2238\def\synindex #1 #2 {%
2239\expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2240\expandafter\let\csname#1indfile\endcsname=\synindexfoo
2d07133b 2241\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
9e9f9cc2
KB
2242\noexpand\doindex {#2}}%
2243}
2244
2245% @syncodeindex foo bar similar, but put all entries made for index foo
2246% inside @code.
2247\def\syncodeindex #1 #2 {%
2248\expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2249\expandafter\let\csname#1indfile\endcsname=\synindexfoo
2d07133b 2250\expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
9e9f9cc2
KB
2251\noexpand\docodeindex {#2}}%
2252}
2253
2254% Define \doindex, the driver for all \fooindex macros.
2255% Argument #1 is generated by the calling \fooindex macro,
2256% and it is "foo", the name of the index.
2257
2258% \doindex just uses \parsearg; it calls \doind for the actual work.
2259% This is because \doind is more useful to call from other macros.
2260
2261% There is also \dosubind {index}{topic}{subtopic}
2262% which makes an entry in a two-level index such as the operation index.
2263
2264\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2265\def\singleindexer #1{\doind{\indexname}{#1}}
2266
2267% like the previous two, but they put @code around the argument.
2268\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2269\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2270
2271\def\indexdummies{%
2272% Take care of the plain tex accent commands.
2273\def\"{\realbackslash "}%
2274\def\`{\realbackslash `}%
2275\def\'{\realbackslash '}%
2276\def\^{\realbackslash ^}%
2277\def\~{\realbackslash ~}%
2278\def\={\realbackslash =}%
2279\def\b{\realbackslash b}%
2280\def\c{\realbackslash c}%
2281\def\d{\realbackslash d}%
2282\def\u{\realbackslash u}%
2283\def\v{\realbackslash v}%
2284\def\H{\realbackslash H}%
2285% Take care of the plain tex special European modified letters.
2286\def\oe{\realbackslash oe}%
2287\def\ae{\realbackslash ae}%
2288\def\aa{\realbackslash aa}%
2289\def\OE{\realbackslash OE}%
2290\def\AE{\realbackslash AE}%
2291\def\AA{\realbackslash AA}%
2292\def\o{\realbackslash o}%
2293\def\O{\realbackslash O}%
2294\def\l{\realbackslash l}%
2295\def\L{\realbackslash L}%
2296\def\ss{\realbackslash ss}%
2297% Take care of texinfo commands likely to appear in an index entry.
359a1d0b
KB
2298% (Must be a way to avoid doing expansion at all, and thus not have to
2299% laboriously list every single command here.)
2300\def\@{@}% will be @@ when we switch to @ as escape char.
2301%\let\{ = \lbracecmd
2302%\let\} = \rbracecmd
9e9f9cc2
KB
2303\def\_{{\realbackslash _}}%
2304\def\w{\realbackslash w }%
2305\def\bf{\realbackslash bf }%
359a1d0b 2306%\def\rm{\realbackslash rm }%
9e9f9cc2
KB
2307\def\sl{\realbackslash sl }%
2308\def\sf{\realbackslash sf}%
2309\def\tt{\realbackslash tt}%
2310\def\gtr{\realbackslash gtr}%
2311\def\less{\realbackslash less}%
2312\def\hat{\realbackslash hat}%
359a1d0b 2313%\def\char{\realbackslash char}%
9e9f9cc2
KB
2314\def\TeX{\realbackslash TeX}%
2315\def\dots{\realbackslash dots }%
d705269e
UD
2316\def\result{\realbackslash result}%
2317\def\equiv{\realbackslash equiv}%
2318\def\expansion{\realbackslash expansion}%
2319\def\print{\realbackslash print}%
2320\def\error{\realbackslash error}%
2321\def\point{\realbackslash point}%
2322\def\copyright{\realbackslash copyright}%
9e9f9cc2
KB
2323\def\tclose##1{\realbackslash tclose {##1}}%
2324\def\code##1{\realbackslash code {##1}}%
359a1d0b 2325\def\dotless##1{\realbackslash dotless {##1}}%
9e9f9cc2 2326\def\samp##1{\realbackslash samp {##1}}%
359a1d0b
KB
2327\def\,##1{\realbackslash ,{##1}}%
2328\def\t##1{\realbackslash t {##1}}%
9e9f9cc2
KB
2329\def\r##1{\realbackslash r {##1}}%
2330\def\i##1{\realbackslash i {##1}}%
2331\def\b##1{\realbackslash b {##1}}%
779ae82e 2332\def\sc##1{\realbackslash sc {##1}}%
9e9f9cc2
KB
2333\def\cite##1{\realbackslash cite {##1}}%
2334\def\key##1{\realbackslash key {##1}}%
2335\def\file##1{\realbackslash file {##1}}%
2336\def\var##1{\realbackslash var {##1}}%
2337\def\kbd##1{\realbackslash kbd {##1}}%
2338\def\dfn##1{\realbackslash dfn {##1}}%
2339\def\emph##1{\realbackslash emph {##1}}%
907a1bac 2340\def\value##1{\realbackslash value {##1}}%
9e9f9cc2
KB
2341\unsepspaces
2342}
2343
2344% If an index command is used in an @example environment, any spaces
2345% therein should become regular spaces in the raw index file, not the
2346% expansion of \tie (\\leavevmode \penalty \@M \ ).
2347{\obeyspaces
2348 \gdef\unsepspaces{\obeyspaces\let =\space}}
2349
2350% \indexnofonts no-ops all font-change commands.
2351% This is used when outputting the strings to sort the index by.
2352\def\indexdummyfont#1{#1}
2353\def\indexdummytex{TeX}
2354\def\indexdummydots{...}
2355
2356\def\indexnofonts{%
2357% Just ignore accents.
359a1d0b 2358\let\,=\indexdummyfont
9e9f9cc2
KB
2359\let\"=\indexdummyfont
2360\let\`=\indexdummyfont
2361\let\'=\indexdummyfont
2362\let\^=\indexdummyfont
2363\let\~=\indexdummyfont
2364\let\==\indexdummyfont
2365\let\b=\indexdummyfont
2366\let\c=\indexdummyfont
2367\let\d=\indexdummyfont
2368\let\u=\indexdummyfont
2369\let\v=\indexdummyfont
2370\let\H=\indexdummyfont
359a1d0b 2371\let\dotless=\indexdummyfont
9e9f9cc2
KB
2372% Take care of the plain tex special European modified letters.
2373\def\oe{oe}%
2374\def\ae{ae}%
2375\def\aa{aa}%
2376\def\OE{OE}%
2377\def\AE{AE}%
2378\def\AA{AA}%
2379\def\o{o}%
2380\def\O{O}%
2381\def\l{l}%
2382\def\L{L}%
2383\def\ss{ss}%
2384\let\w=\indexdummyfont
2385\let\t=\indexdummyfont
2386\let\r=\indexdummyfont
2387\let\i=\indexdummyfont
2388\let\b=\indexdummyfont
2389\let\emph=\indexdummyfont
2390\let\strong=\indexdummyfont
2391\let\cite=\indexdummyfont
2392\let\sc=\indexdummyfont
2393%Don't no-op \tt, since it isn't a user-level command
2394% and is used in the definitions of the active chars like <, >, |...
2395%\let\tt=\indexdummyfont
2396\let\tclose=\indexdummyfont
2397\let\code=\indexdummyfont
2398\let\file=\indexdummyfont
2399\let\samp=\indexdummyfont
2400\let\kbd=\indexdummyfont
2401\let\key=\indexdummyfont
2402\let\var=\indexdummyfont
2403\let\TeX=\indexdummytex
2404\let\dots=\indexdummydots
359a1d0b 2405\def\@{@}%
9e9f9cc2
KB
2406}
2407
2408% To define \realbackslash, we must make \ not be an escape.
2409% We must first make another character (@) an escape
2410% so we do not become unable to do a definition.
2411
2412{\catcode`\@=0 \catcode`\\=\other
2413@gdef@realbackslash{\}}
2414
2415\let\indexbackslash=0 %overridden during \printindex.
2416
2417\let\SETmarginindex=\relax %initialize!
2418% workhorse for all \fooindexes
2419% #1 is name of index, #2 is stuff to put there
2420\def\doind #1#2{%
359a1d0b
KB
2421 % Put the index entry in the margin if desired.
2422 \ifx\SETmarginindex\relax\else
2423 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
2424 \fi
2425 {%
2426 \count255=\lastpenalty
2427 {%
2428 \indexdummies % Must do this here, since \bf, etc expand at this stage
2429 \escapechar=`\\
2430 {%
f5311448 2431 \let\folio=0% We will expand all macros now EXCEPT \folio.
359a1d0b
KB
2432 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2433 % so it will be output as is; and it will print as backslash.
2434 %
2435 % First process the index-string with all font commands turned off
2436 % to get the string to sort by.
2437 {\indexnofonts \xdef\indexsorttmp{#2}}%
2438 %
2439 % Now produce the complete index entry, with both the sort key and the
2440 % original text, including any font commands.
2441 \toks0 = {#2}%
2442 \edef\temp{%
2443 \write\csname#1indfile\endcsname{%
2444 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2445 }%
2446 \temp
2447 }%
2448 }%
2449 \penalty\count255
2450 }%
2451}
9e9f9cc2
KB
2452
2453\def\dosubind #1#2#3{%
2454{\count10=\lastpenalty %
2455{\indexdummies % Must do this here, since \bf, etc expand at this stage
2456\escapechar=`\\%
2457{\let\folio=0%
2458\def\rawbackslashxx{\indexbackslash}%
2459%
2460% Now process the index-string once, with all font commands turned off,
2461% to get the string to sort the index by.
2462{\indexnofonts
2463\xdef\temp1{#2 #3}%
2464}%
2465% Now produce the complete index entry. We process the index-string again,
2466% this time with font commands expanded, to get what to print in the index.
2467\edef\temp{%
2468\write \csname#1indfile\endcsname{%
2469\realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
2470\temp }%
2471}\penalty\count10}}
2472
2473% The index entry written in the file actually looks like
2474% \entry {sortstring}{page}{topic}
2475% or
2476% \entry {sortstring}{page}{topic}{subtopic}
2477% The texindex program reads in these files and writes files
2478% containing these kinds of lines:
2479% \initial {c}
2480% before the first topic whose initial is c
2481% \entry {topic}{pagelist}
2482% for a topic that is used without subtopics
2483% \primary {topic}
2484% for the beginning of a topic that is used with subtopics
2485% \secondary {subtopic}{pagelist}
2486% for each subtopic.
2487
2488% Define the user-accessible indexing commands
2489% @findex, @vindex, @kindex, @cindex.
2490
2491\def\findex {\fnindex}
2492\def\kindex {\kyindex}
2493\def\cindex {\cpindex}
2494\def\vindex {\vrindex}
2495\def\tindex {\tpindex}
2496\def\pindex {\pgindex}
2497
2498\def\cindexsub {\begingroup\obeylines\cindexsub}
2499{\obeylines %
2500\gdef\cindexsub "#1" #2^^M{\endgroup %
2501\dosubind{cp}{#2}{#1}}}
2502
2503% Define the macros used in formatting output of the sorted index material.
2504
51702635
UD
2505% @printindex causes a particular index (the ??s file) to get printed.
2506% It does not print any chapter heading (usually an @unnumbered).
2507%
9e9f9cc2 2508\def\printindex{\parsearg\doprintindex}
ea6631a2
KB
2509\def\doprintindex#1{\begingroup
2510 \dobreak \chapheadingskip{10000}%
9e9f9cc2 2511 %
ea6631a2
KB
2512 \indexfonts \rm
2513 \tolerance = 9500
2514 \indexbreaks
9e9f9cc2
KB
2515 %
2516 % See if the index file exists and is nonempty.
2517 \openin 1 \jobname.#1s
2518 \ifeof 1
2519 % \enddoublecolumns gets confused if there is no text in the index,
2520 % and it loses the chapter title and the aux file entries for the
2521 % index. The easiest way to prevent this problem is to make sure
2522 % there is some text.
2523 (Index is nonexistent)
ea6631a2 2524 \else
9e9f9cc2
KB
2525 %
2526 % If the index file exists but is empty, then \openin leaves \ifeof
2527 % false. We have to make TeX try to read something from the file, so
2528 % it can discover if there is anything in it.
2529 \read 1 to \temp
2530 \ifeof 1
2531 (Index is empty)
2532 \else
51702635
UD
2533 % Index files are almost Texinfo source, but we use \ as the escape
2534 % character. It would be better to use @, but that's too big a change
2535 % to make right now.
2536 \def\indexbackslash{\rawbackslashxx}%
2537 \catcode`\\ = 0
2538 \catcode`\@ = 11
2539 \escapechar = `\\
2540 \begindoublecolumns
9e9f9cc2 2541 \input \jobname.#1s
51702635 2542 \enddoublecolumns
9e9f9cc2
KB
2543 \fi
2544 \fi
2545 \closein 1
ea6631a2 2546\endgroup}
9e9f9cc2
KB
2547
2548% These macros are used by the sorted index file itself.
2549% Change them to control the appearance of the index.
2550
2551% Same as \bigskipamount except no shrink.
2552% \balancecolumns gets confused if there is any shrink.
2553\newskip\initialskipamount \initialskipamount 12pt plus4pt
2554
2555\def\initial #1{%
2556{\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
2557\ifdim\lastskip<\initialskipamount
2558\removelastskip \penalty-200 \vskip \initialskipamount\fi
2559\line{\secbf#1\hfill}\kern 2pt\penalty10000}}
2560
2561% This typesets a paragraph consisting of #1, dot leaders, and then #2
2562% flush to the right margin. It is used for index and table of contents
2563% entries. The paragraph is indented by \leftskip.
2564%
2565\def\entry #1#2{\begingroup
2566 %
2567 % Start a new paragraph if necessary, so our assignments below can't
2568 % affect previous text.
2569 \par
2570 %
2571 % Do not fill out the last line with white space.
2572 \parfillskip = 0in
2573 %
2574 % No extra space above this paragraph.
2575 \parskip = 0in
2576 %
2577 % Do not prefer a separate line ending with a hyphen to fewer lines.
2578 \finalhyphendemerits = 0
2579 %
2580 % \hangindent is only relevant when the entry text and page number
2581 % don't both fit on one line. In that case, bob suggests starting the
2582 % dots pretty far over on the line. Unfortunately, a large
2583 % indentation looks wrong when the entry text itself is broken across
2584 % lines. So we use a small indentation and put up with long leaders.
2585 %
2586 % \hangafter is reset to 1 (which is the value we want) at the start
2587 % of each paragraph, so we need not do anything with that.
2588 \hangindent=2em
2589 %
2590 % When the entry text needs to be broken, just fill out the first line
2591 % with blank space.
2592 \rightskip = 0pt plus1fil
2593 %
2594 % Start a ``paragraph'' for the index entry so the line breaking
2595 % parameters we've set above will have an effect.
2596 \noindent
2597 %
2598 % Insert the text of the index entry. TeX will do line-breaking on it.
2599 #1%
2600 % The following is kludged to not output a line of dots in the index if
2601 % there are no page numbers. The next person who breaks this will be
2602 % cursed by a Unix daemon.
2603 \def\tempa{{\rm }}%
2604 \def\tempb{#2}%
2605 \edef\tempc{\tempa}%
2606 \edef\tempd{\tempb}%
2607 \ifx\tempc\tempd\ \else%
2608 %
2609 % If we must, put the page number on a line of its own, and fill out
2610 % this line with blank space. (The \hfil is overwhelmed with the
2611 % fill leaders glue in \indexdotfill if the page number does fit.)
2612 \hfil\penalty50
2613 \null\nobreak\indexdotfill % Have leaders before the page number.
2614 %
2615 % The `\ ' here is removed by the implicit \unskip that TeX does as
2616 % part of (the primitive) \par. Without it, a spurious underfull
2617 % \hbox ensues.
2618 \ #2% The page number ends the paragraph.
2619 \fi%
2620 \par
2621\endgroup}
2622
2623% Like \dotfill except takes at least 1 em.
2624\def\indexdotfill{\cleaders
2625 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
2626
2627\def\primary #1{\line{#1\hfil}}
2628
2629\newskip\secondaryindent \secondaryindent=0.5cm
2630
2631\def\secondary #1#2{
2632{\parfillskip=0in \parskip=0in
2633\hangindent =1in \hangafter=1
2634\noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2635}}
2636
359a1d0b
KB
2637% Define two-column mode, which we use to typeset indexes.
2638% Adapted from the TeXbook, page 416, which is to say,
2639% the manmac.tex format used to print the TeXbook itself.
2640\catcode`\@=11
9e9f9cc2
KB
2641
2642\newbox\partialpage
9e9f9cc2
KB
2643\newdimen\doublecolumnhsize
2644
359a1d0b 2645\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
9e9f9cc2 2646 % Grab any single-column material above us.
51702635 2647 \output = {\global\setbox\partialpage = \vbox{%
ce37fa88 2648 %
51702635
UD
2649 % Here is a possibility not foreseen in manmac: if we accumulate a
2650 % whole lot of material, we might end up calling this \output
2651 % routine twice in a row (see the doublecol-lose test, which is
2652 % essentially a couple of indexes with @setchapternewpage off). In
2653 % that case, we must prevent the second \partialpage from
2654 % simply overwriting the first, causing us to lose the page.
2655 % This will preserve it until a real output routine can ship it
2656 % out. Generally, \partialpage will be empty when this runs and
2657 % this will be a no-op.
2658 \unvbox\partialpage
2659 %
2660 % Unvbox the main output page.
2661 \unvbox255
2662 \kern-\topskip \kern\baselineskip
2663 }}%
9e9f9cc2
KB
2664 \eject
2665 %
51702635
UD
2666 % Use the double-column output routine for subsequent pages.
2667 \output = {\doublecolumnout}%
9e9f9cc2
KB
2668 %
2669 % Change the page size parameters. We could do this once outside this
2670 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2671 % format, but then we repeat the same computation. Repeating a couple
2672 % of assignments once per index is clearly meaningless for the
51702635 2673 % execution time, so we may as well do it in one place.
9e9f9cc2
KB
2674 %
2675 % First we halve the line length, less a little for the gutter between
2676 % the columns. We compute the gutter based on the line length, so it
2677 % changes automatically with the paper format. The magic constant
51702635
UD
2678 % below is chosen so that the gutter has the same value (well, +-<1pt)
2679 % as it did when we hard-coded it.
9e9f9cc2
KB
2680 %
2681 % We put the result in a separate register, \doublecolumhsize, so we
2682 % can restore it in \pagesofar, after \hsize itself has (potentially)
2683 % been clobbered.
2684 %
2685 \doublecolumnhsize = \hsize
2686 \advance\doublecolumnhsize by -.04154\hsize
2687 \divide\doublecolumnhsize by 2
2688 \hsize = \doublecolumnhsize
2689 %
2690 % Double the \vsize as well. (We don't need a separate register here,
2691 % since nobody clobbers \vsize.)
2692 \vsize = 2\vsize
9e9f9cc2 2693}
9e9f9cc2 2694\def\doublecolumnout{%
359a1d0b
KB
2695 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2696 % Get the available space for the double columns -- the normal
2697 % (undoubled) page height minus any material left over from the
2698 % previous page.
2699 \dimen@=\pageheight \advance\dimen@ by-\ht\partialpage
51702635 2700 % box0 will be the left-hand column, box2 the right.
359a1d0b
KB
2701 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
2702 \onepageout\pagesofar
51702635
UD
2703 \unvbox255
2704 \penalty\outputpenalty
359a1d0b
KB
2705}
2706\def\pagesofar{%
51702635 2707 % Re-output the contents of the output page -- any previous material,
359a1d0b
KB
2708 % followed by the two boxes we just split.
2709 \unvbox\partialpage
2710 \hsize = \doublecolumnhsize
2711 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}%
2712}
2713\def\enddoublecolumns{%
51702635
UD
2714 \output = {\balancecolumns}\eject % split what we have
2715 \endgroup % started in \begindoublecolumns
2716 %
359a1d0b
KB
2717 % Back to normal single-column typesetting, but take account of the
2718 % fact that we just accumulated some stuff on the output page.
51702635 2719 \pagegoal = \vsize
359a1d0b
KB
2720}
2721\def\balancecolumns{%
51702635
UD
2722 % Called at the end of the double column material.
2723 \setbox0 = \vbox{\unvbox255}%
359a1d0b
KB
2724 \dimen@ = \ht0
2725 \advance\dimen@ by \topskip
2726 \advance\dimen@ by-\baselineskip
2727 \divide\dimen@ by 2
2728 \splittopskip = \topskip
2729 % Loop until we get a decent breakpoint.
51702635
UD
2730 {\vbadness=10000 \loop
2731 \global\setbox3=\copy0
359a1d0b 2732 \global\setbox1=\vsplit3 to\dimen@
51702635
UD
2733 \ifdim\ht3>\dimen@ \global\advance\dimen@ by1pt
2734 \repeat}%
359a1d0b
KB
2735 \setbox0=\vbox to\dimen@{\unvbox1}%
2736 \setbox2=\vbox to\dimen@{\unvbox3}%
2737 \pagesofar
9e9f9cc2 2738}
51702635 2739\catcode`\@ = \other
d66b7b41
KB
2740
2741
9e9f9cc2
KB
2742\message{sectioning,}
2743% Define chapters, sections, etc.
2744
51702635
UD
2745\newcount\chapno
2746\newcount\secno \secno=0
2747\newcount\subsecno \subsecno=0
2748\newcount\subsubsecno \subsubsecno=0
9e9f9cc2
KB
2749
2750% This counter is funny since it counts through charcodes of letters A, B, ...
51702635 2751\newcount\appendixno \appendixno = `\@
9e9f9cc2
KB
2752\def\appendixletter{\char\the\appendixno}
2753
51702635 2754\newwrite\contentsfile
9e9f9cc2 2755% This is called from \setfilename.
51702635 2756\def\opencontents{\openout\contentsfile = \jobname.toc }
9e9f9cc2
KB
2757
2758% Each @chapter defines this as the name of the chapter.
2759% page headings and footings can use it. @section does likewise
2760
2761\def\thischapter{} \def\thissection{}
51702635
UD
2762\def\seccheck#1{\ifnum \pageno<0
2763 \errmessage{@#1 not allowed after generating table of contents}%
2764\fi}
9e9f9cc2
KB
2765
2766\def\chapternofonts{%
51702635
UD
2767 \let\rawbackslash=\relax
2768 \let\frenchspacing=\relax
2769 \def\result{\realbackslash result}%
2770 \def\equiv{\realbackslash equiv}%
2771 \def\expansion{\realbackslash expansion}%
2772 \def\print{\realbackslash print}%
2773 \def\TeX{\realbackslash TeX}%
2774 \def\dots{\realbackslash dots}%
d705269e
UD
2775 \def\result{\realbackslash result}%
2776 \def\equiv{\realbackslash equiv}%
2777 \def\expansion{\realbackslash expansion}%
2778 \def\print{\realbackslash print}%
2779 \def\error{\realbackslash error}%
2780 \def\point{\realbackslash point}%
51702635
UD
2781 \def\copyright{\realbackslash copyright}%
2782 \def\tt{\realbackslash tt}%
2783 \def\bf{\realbackslash bf}%
2784 \def\w{\realbackslash w}%
2785 \def\less{\realbackslash less}%
2786 \def\gtr{\realbackslash gtr}%
2787 \def\hat{\realbackslash hat}%
2788 \def\char{\realbackslash char}%
2789 \def\tclose##1{\realbackslash tclose{##1}}%
2790 \def\code##1{\realbackslash code{##1}}%
2791 \def\samp##1{\realbackslash samp{##1}}%
2792 \def\r##1{\realbackslash r{##1}}%
2793 \def\b##1{\realbackslash b{##1}}%
2794 \def\key##1{\realbackslash key{##1}}%
2795 \def\file##1{\realbackslash file{##1}}%
2796 \def\kbd##1{\realbackslash kbd{##1}}%
2797 % These are redefined because @smartitalic wouldn't work inside xdef.
2798 \def\i##1{\realbackslash i{##1}}%
2799 \def\cite##1{\realbackslash cite{##1}}%
2800 \def\var##1{\realbackslash var{##1}}%
2801 \def\emph##1{\realbackslash emph{##1}}%
2802 \def\dfn##1{\realbackslash dfn{##1}}%
9e9f9cc2
KB
2803}
2804
2805\newcount\absseclevel % used to calculate proper heading level
2806\newcount\secbase\secbase=0 % @raise/lowersections modify this count
2807
2808% @raisesections: treat @section as chapter, @subsection as section, etc.
2809\def\raisesections{\global\advance\secbase by -1}
2810\let\up=\raisesections % original BFox name
2811
2812% @lowersections: treat @chapter as section, @section as subsection, etc.
2813\def\lowersections{\global\advance\secbase by 1}
2814\let\down=\lowersections % original BFox name
2815
2816% Choose a numbered-heading macro
2817% #1 is heading level if unmodified by @raisesections or @lowersections
2818% #2 is text for heading
2819\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2820\ifcase\absseclevel
2821 \chapterzzz{#2}
2822\or
2823 \seczzz{#2}
2824\or
2825 \numberedsubseczzz{#2}
2826\or
2827 \numberedsubsubseczzz{#2}
2828\else
2829 \ifnum \absseclevel<0
2830 \chapterzzz{#2}
2831 \else
2832 \numberedsubsubseczzz{#2}
2833 \fi
2834\fi
2835}
2836
2837% like \numhead, but chooses appendix heading levels
2838\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2839\ifcase\absseclevel
2840 \appendixzzz{#2}
2841\or
2842 \appendixsectionzzz{#2}
2843\or
2844 \appendixsubseczzz{#2}
2845\or
2846 \appendixsubsubseczzz{#2}
2847\else
2848 \ifnum \absseclevel<0
2849 \appendixzzz{#2}
2850 \else
2851 \appendixsubsubseczzz{#2}
2852 \fi
2853\fi
2854}
2855
2856% like \numhead, but chooses numberless heading levels
2857\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2858\ifcase\absseclevel
2859 \unnumberedzzz{#2}
2860\or
2861 \unnumberedseczzz{#2}
2862\or
2863 \unnumberedsubseczzz{#2}
2864\or
2865 \unnumberedsubsubseczzz{#2}
2866\else
2867 \ifnum \absseclevel<0
2868 \unnumberedzzz{#2}
2869 \else
2870 \unnumberedsubsubseczzz{#2}
2871 \fi
2872\fi
2873}
2874
2875
2876\def\thischaptername{No Chapter Title}
2877\outer\def\chapter{\parsearg\chapteryyy}
2878\def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2879\def\chapterzzz #1{\seccheck{chapter}%
2880\secno=0 \subsecno=0 \subsubsecno=0
2881\global\advance \chapno by 1 \message{\putwordChapter \the\chapno}%
2882\chapmacro {#1}{\the\chapno}%
2883\gdef\thissection{#1}%
2884\gdef\thischaptername{#1}%
2885% We don't substitute the actual chapter name into \thischapter
2886% because we don't want its macros evaluated now.
2887\xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
2888{\chapternofonts%
779ae82e
UD
2889\toks0 = {#1}%
2890\edef\temp{{\realbackslash chapentry{\the\toks0}{\the\chapno}{\noexpand\folio}}}%
9e9f9cc2
KB
2891\escapechar=`\\%
2892\write \contentsfile \temp %
2893\donoderef %
2894\global\let\section = \numberedsec
2895\global\let\subsection = \numberedsubsec
2896\global\let\subsubsection = \numberedsubsubsec
2897}}
2898
2899\outer\def\appendix{\parsearg\appendixyyy}
2900\def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2901\def\appendixzzz #1{\seccheck{appendix}%
2902\secno=0 \subsecno=0 \subsubsecno=0
2903\global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2904\chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2905\gdef\thissection{#1}%
2906\gdef\thischaptername{#1}%
2907\xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
2908{\chapternofonts%
779ae82e
UD
2909\toks0 = {#1}%
2910\edef\temp{{\realbackslash chapentry{\the\toks0}%
2911 {\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
9e9f9cc2
KB
2912\escapechar=`\\%
2913\write \contentsfile \temp %
2914\appendixnoderef %
2915\global\let\section = \appendixsec
2916\global\let\subsection = \appendixsubsec
2917\global\let\subsubsection = \appendixsubsubsec
2918}}
2919
2920% @centerchap is like @unnumbered, but the heading is centered.
2921\outer\def\centerchap{\parsearg\centerchapyyy}
2922\def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
2923
2924\outer\def\top{\parsearg\unnumberedyyy}
2925\outer\def\unnumbered{\parsearg\unnumberedyyy}
2926\def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2927\def\unnumberedzzz #1{\seccheck{unnumbered}%
2928\secno=0 \subsecno=0 \subsubsecno=0
2929%
2930% This used to be simply \message{#1}, but TeX fully expands the
2931% argument to \message. Therefore, if #1 contained @-commands, TeX
2932% expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2933% expanded @cite (which turns out to cause errors because \cite is meant
2934% to be executed, not expanded).
2935%
2936% Anyway, we don't want the fully-expanded definition of @cite to appear
2937% as a result of the \message, we just want `@cite' itself. We use
2938% \the<toks register> to achieve this: TeX expands \the<toks> only once,
2939% simply yielding the contents of the <toks register>.
2940\toks0 = {#1}\message{(\the\toks0)}%
2941%
2942\unnumbchapmacro {#1}%
2943\gdef\thischapter{#1}\gdef\thissection{#1}%
2944{\chapternofonts%
779ae82e
UD
2945\toks0 = {#1}%
2946\edef\temp{{\realbackslash unnumbchapentry{\the\toks0}{\noexpand\folio}}}%
9e9f9cc2
KB
2947\escapechar=`\\%
2948\write \contentsfile \temp %
2949\unnumbnoderef %
2950\global\let\section = \unnumberedsec
2951\global\let\subsection = \unnumberedsubsec
2952\global\let\subsubsection = \unnumberedsubsubsec
2953}}
2954
2955\outer\def\numberedsec{\parsearg\secyyy}
2956\def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2957\def\seczzz #1{\seccheck{section}%
2958\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2959\gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2960{\chapternofonts%
779ae82e 2961\toks0 = {#1}%
9e9f9cc2 2962\edef\temp{{\realbackslash secentry %
779ae82e 2963{\the\toks0}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
9e9f9cc2
KB
2964\escapechar=`\\%
2965\write \contentsfile \temp %
2966\donoderef %
2967\penalty 10000 %
2968}}
2969
2970\outer\def\appendixsection{\parsearg\appendixsecyyy}
2971\outer\def\appendixsec{\parsearg\appendixsecyyy}
2972\def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2973\def\appendixsectionzzz #1{\seccheck{appendixsection}%
2974\subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2975\gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2976{\chapternofonts%
779ae82e 2977\toks0 = {#1}%
9e9f9cc2 2978\edef\temp{{\realbackslash secentry %
779ae82e 2979{\the\toks0}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
9e9f9cc2
KB
2980\escapechar=`\\%
2981\write \contentsfile \temp %
2982\appendixnoderef %
2983\penalty 10000 %
2984}}
2985
2986\outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2987\def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2988\def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2989\plainsecheading {#1}\gdef\thissection{#1}%
2990{\chapternofonts%
779ae82e
UD
2991\toks0 = {#1}%
2992\edef\temp{{\realbackslash unnumbsecentry{\the\toks0}{\noexpand\folio}}}%
9e9f9cc2
KB
2993\escapechar=`\\%
2994\write \contentsfile \temp %
2995\unnumbnoderef %
2996\penalty 10000 %
2997}}
2998
2999\outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3000\def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3001\def\numberedsubseczzz #1{\seccheck{subsection}%
3002\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3003\subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3004{\chapternofonts%
779ae82e 3005\toks0 = {#1}%
9e9f9cc2 3006\edef\temp{{\realbackslash subsecentry %
779ae82e 3007{\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
9e9f9cc2
KB
3008\escapechar=`\\%
3009\write \contentsfile \temp %
3010\donoderef %
3011\penalty 10000 %
3012}}
3013
3014\outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3015\def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3016\def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
3017\gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3018\subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3019{\chapternofonts%
779ae82e 3020\toks0 = {#1}%
9e9f9cc2 3021\edef\temp{{\realbackslash subsecentry %
779ae82e 3022{\the\toks0}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
9e9f9cc2
KB
3023\escapechar=`\\%
3024\write \contentsfile \temp %
3025\appendixnoderef %
3026\penalty 10000 %
3027}}
3028
3029\outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3030\def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3031\def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
f2fec269 3032\plainsubsecheading {#1}\gdef\thissection{#1}%
9e9f9cc2 3033{\chapternofonts%
779ae82e
UD
3034\toks0 = {#1}%
3035\edef\temp{{\realbackslash unnumbsubsecentry{\the\toks0}{\noexpand\folio}}}%
9e9f9cc2
KB
3036\escapechar=`\\%
3037\write \contentsfile \temp %
3038\unnumbnoderef %
3039\penalty 10000 %
3040}}
3041
3042\outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3043\def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3044\def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
3045\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3046\subsubsecheading {#1}
3047 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3048{\chapternofonts%
779ae82e
UD
3049\toks0 = {#1}%
3050\edef\temp{{\realbackslash subsubsecentry{\the\toks0}
9e9f9cc2
KB
3051 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
3052 {\noexpand\folio}}}%
3053\escapechar=`\\%
3054\write \contentsfile \temp %
3055\donoderef %
3056\penalty 10000 %
3057}}
3058
3059\outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3060\def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3061\def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
3062\gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3063\subsubsecheading {#1}
3064 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3065{\chapternofonts%
779ae82e
UD
3066\toks0 = {#1}%
3067\edef\temp{{\realbackslash subsubsecentry{\the\toks0}%
9e9f9cc2
KB
3068 {\appendixletter}
3069 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
3070\escapechar=`\\%
3071\write \contentsfile \temp %
3072\appendixnoderef %
3073\penalty 10000 %
3074}}
3075
3076\outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3077\def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3078\def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
f2fec269 3079\plainsubsubsecheading {#1}\gdef\thissection{#1}%
9e9f9cc2 3080{\chapternofonts%
779ae82e
UD
3081\toks0 = {#1}%
3082\edef\temp{{\realbackslash unnumbsubsubsecentry{\the\toks0}{\noexpand\folio}}}%
9e9f9cc2
KB
3083\escapechar=`\\%
3084\write \contentsfile \temp %
3085\unnumbnoderef %
3086\penalty 10000 %
3087}}
3088
3089% These are variants which are not "outer", so they can appear in @ifinfo.
3090% Actually, they should now be obsolete; ordinary section commands should work.
3091\def\infotop{\parsearg\unnumberedzzz}
3092\def\infounnumbered{\parsearg\unnumberedzzz}
3093\def\infounnumberedsec{\parsearg\unnumberedseczzz}
3094\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3095\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3096
3097\def\infoappendix{\parsearg\appendixzzz}
3098\def\infoappendixsec{\parsearg\appendixseczzz}
3099\def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3100\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3101
3102\def\infochapter{\parsearg\chapterzzz}
3103\def\infosection{\parsearg\sectionzzz}
3104\def\infosubsection{\parsearg\subsectionzzz}
3105\def\infosubsubsection{\parsearg\subsubsectionzzz}
3106
3107% These macros control what the section commands do, according
3108% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3109% Define them by default for a numbered chapter.
3110\global\let\section = \numberedsec
3111\global\let\subsection = \numberedsubsec
3112\global\let\subsubsection = \numberedsubsubsec
3113
3114% Define @majorheading, @heading and @subheading
3115
3116% NOTE on use of \vbox for chapter headings, section headings, and
3117% such:
2d07133b
KB
3118% 1) We use \vbox rather than the earlier \line to permit
3119% overlong headings to fold.
3120% 2) \hyphenpenalty is set to 10000 because hyphenation in a
3121% heading is obnoxious; this forbids it.
9e9f9cc2
KB
3122% 3) Likewise, headings look best if no \parindent is used, and
3123% if justification is not attempted. Hence \raggedright.
3124
3125
3126\def\majorheading{\parsearg\majorheadingzzz}
3127\def\majorheadingzzz #1{%
3128{\advance\chapheadingskip by 10pt \chapbreak }%
3129{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3130 \parindent=0pt\raggedright
3131 \rm #1\hfill}}\bigskip \par\penalty 200}
3132
3133\def\chapheading{\parsearg\chapheadingzzz}
3134\def\chapheadingzzz #1{\chapbreak %
3135{\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3136 \parindent=0pt\raggedright
3137 \rm #1\hfill}}\bigskip \par\penalty 200}
3138
f2fec269
KB
3139% @heading, @subheading, @subsubheading.
3140\def\heading{\parsearg\plainsecheading}
3141\def\subheading{\parsearg\plainsubsecheading}
3142\def\subsubheading{\parsearg\plainsubsubsecheading}
9e9f9cc2
KB
3143
3144% These macros generate a chapter, section, etc. heading only
3145% (including whitespace, linebreaking, etc. around it),
3146% given all the information in convenient, parsed form.
3147
3148%%% Args are the skip and penalty (usually negative)
3149\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3150
3151\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3152
3153%%% Define plain chapter starts, and page on/off switching for it
3154% Parameter controlling skip before chapter headings (if needed)
3155
474be527 3156\newskip\chapheadingskip
9e9f9cc2
KB
3157
3158\def\chapbreak{\dobreak \chapheadingskip {-4000}}
3159\def\chappager{\par\vfill\supereject}
3160\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3161
3162\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3163
3164\def\CHAPPAGoff{
793fde8a 3165\global\let\contentsalignmacro = \chappager
9e9f9cc2
KB
3166\global\let\pchapsepmacro=\chapbreak
3167\global\let\pagealignmacro=\chappager}
3168
3169\def\CHAPPAGon{
793fde8a 3170\global\let\contentsalignmacro = \chappager
9e9f9cc2
KB
3171\global\let\pchapsepmacro=\chappager
3172\global\let\pagealignmacro=\chappager
3173\global\def\HEADINGSon{\HEADINGSsingle}}
3174
3175\def\CHAPPAGodd{
793fde8a 3176\global\let\contentsalignmacro = \chapoddpage
9e9f9cc2
KB
3177\global\let\pchapsepmacro=\chapoddpage
3178\global\let\pagealignmacro=\chapoddpage
3179\global\def\HEADINGSon{\HEADINGSdouble}}
3180
3181\CHAPPAGon
3182
3183\def\CHAPFplain{
3184\global\let\chapmacro=\chfplain
3185\global\let\unnumbchapmacro=\unnchfplain
3186\global\let\centerchapmacro=\centerchfplain}
3187
843be0d3
KB
3188% Plain chapter opening.
3189% #1 is the text, #2 the chapter number or empty if unnumbered.
3190\def\chfplain#1#2{%
9e9f9cc2
KB
3191 \pchapsepmacro
3192 {%
cd4e176c 3193 \chapfonts \rm
843be0d3
KB
3194 \def\chapnum{#2}%
3195 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
cd4e176c 3196 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
843be0d3
KB
3197 \hangindent = \wd0 \centerparametersmaybe
3198 \unhbox0 #1\par}%
9e9f9cc2 3199 }%
cd4e176c
KB
3200 \nobreak\bigskip % no page break after a chapter title
3201 \nobreak
9e9f9cc2
KB
3202}
3203
843be0d3
KB
3204% Plain opening for unnumbered.
3205\def\unnchfplain#1{\chfplain{#1}{}}
9e9f9cc2 3206
843be0d3
KB
3207% @centerchap -- centered and unnumbered.
3208\let\centerparametersmaybe = \relax
3209\def\centerchfplain#1{{%
3210 \def\centerparametersmaybe{%
3211 \advance\rightskip by 3\rightskip
3212 \leftskip = \rightskip
3213 \parfillskip = 0pt
3214 }%
3215 \chfplain{#1}{}%
3216}}
9e9f9cc2
KB
3217
3218\CHAPFplain % The default
3219
3220\def\unnchfopen #1{%
3221\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3222 \parindent=0pt\raggedright
3223 \rm #1\hfill}}\bigskip \par\penalty 10000 %
3224}
3225
3226\def\chfopen #1#2{\chapoddpage {\chapfonts
3227\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3228\par\penalty 5000 %
3229}
3230
3231\def\centerchfopen #1{%
3232\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3233 \parindent=0pt
3234 \hfill {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
3235}
3236
3237\def\CHAPFopen{
3238\global\let\chapmacro=\chfopen
3239\global\let\unnumbchapmacro=\unnchfopen
3240\global\let\centerchapmacro=\centerchfopen}
3241
9e9f9cc2 3242
cd4e176c 3243% Section titles.
474be527 3244\newskip\secheadingskip
cd4e176c
KB
3245\def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3246\def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3247\def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3248
3249% Subsection titles.
474be527 3250\newskip \subsecheadingskip
9e9f9cc2 3251\def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
cd4e176c 3252\def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
f2fec269 3253\def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
9e9f9cc2 3254
cd4e176c
KB
3255% Subsubsection titles.
3256\let\subsubsecheadingskip = \subsecheadingskip
3257\let\subsubsecheadingbreak = \subsecheadingbreak
3258\def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
f2fec269 3259\def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
9e9f9cc2 3260
9e9f9cc2 3261
cd4e176c 3262% Print any size section title.
10dc2a90 3263%
cd4e176c
KB
3264% #1 is the section type (sec/subsec/subsubsec), #2 is the section
3265% number (maybe empty), #3 the text.
3266\def\sectionheading#1#2#3{%
3267 {%
3268 \expandafter\advance\csname #1headingskip\endcsname by \parskip
3269 \csname #1headingbreak\endcsname
3270 }%
3271 {%
843be0d3 3272 % Switch to the right set of fonts.
cd4e176c 3273 \csname #1fonts\endcsname \rm
843be0d3 3274 %
cd4e176c 3275 % Only insert the separating space if we have a section number.
843be0d3
KB
3276 \def\secnum{#2}%
3277 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3278 %
cd4e176c
KB
3279 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3280 \hangindent = \wd0 % zero if no section number
3281 \unhbox0 #3}%
3282 }%
3283 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak
3284}
9e9f9cc2
KB
3285
3286
3287\message{toc printing,}
9e9f9cc2
KB
3288% Finish up the main text and prepare to read what we've written
3289% to \contentsfile.
3290
3291\newskip\contentsrightmargin \contentsrightmargin=1in
3292\def\startcontents#1{%
793fde8a
KB
3293 % If @setchapternewpage on, and @headings double, the contents should
3294 % start on an odd page, unlike chapters. Thus, we maintain
3295 % \contentsalignmacro in parallel with \pagealignmacro.
3296 % From: Torbjorn Granlund <tege@matematik.su.se>
3297 \contentsalignmacro
9e9f9cc2
KB
3298 \immediate\closeout \contentsfile
3299 \ifnum \pageno>0
2d07133b 3300 \pageno = -1 % Request roman numbered pages.
9e9f9cc2
KB
3301 \fi
3302 % Don't need to put `Contents' or `Short Contents' in the headline.
3303 % It is abundantly clear what they are.
3304 \unnumbchapmacro{#1}\def\thischapter{}%
2d07133b 3305 \begingroup % Set up to handle contents files properly.
9e9f9cc2 3306 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
2d7da676
UD
3307 % We can't do this, because then an actual ^ in a section
3308 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3309 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
9e9f9cc2
KB
3310 \raggedbottom % Worry more about breakpoints than the bottom.
3311 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3312}
3313
3314
3315% Normal (long) toc.
3316\outer\def\contents{%
3317 \startcontents{\putwordTableofContents}%
3318 \input \jobname.toc
3319 \endgroup
3320 \vfill \eject
3321}
3322
3323% And just the chapters.
3324\outer\def\summarycontents{%
3325 \startcontents{\putwordShortContents}%
3326 %
3327 \let\chapentry = \shortchapentry
3328 \let\unnumbchapentry = \shortunnumberedentry
3329 % We want a true roman here for the page numbers.
3330 \secfonts
3331 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
3332 \rm
359a1d0b 3333 \hyphenpenalty = 10000
9e9f9cc2
KB
3334 \advance\baselineskip by 1pt % Open it up a little.
3335 \def\secentry ##1##2##3##4{}
3336 \def\unnumbsecentry ##1##2{}
3337 \def\subsecentry ##1##2##3##4##5{}
3338 \def\unnumbsubsecentry ##1##2{}
3339 \def\subsubsecentry ##1##2##3##4##5##6{}
3340 \def\unnumbsubsubsecentry ##1##2{}
3341 \input \jobname.toc
3342 \endgroup
3343 \vfill \eject
3344}
3345\let\shortcontents = \summarycontents
3346
3347% These macros generate individual entries in the table of contents.
3348% The first argument is the chapter or section name.
3349% The last argument is the page number.
3350% The arguments in between are the chapter number, section number, ...
3351
3352% Chapter-level things, for both the long and short contents.
3353\def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3354
3355% See comments in \dochapentry re vbox and related settings
3356\def\shortchapentry#1#2#3{%
3357 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
3358}
3359
3360% Typeset the label for a chapter or appendix for the short contents.
3361% The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3362% We could simplify the code here by writing out an \appendixentry
3363% command in the toc file for appendices, instead of using \chapentry
3364% for both, but it doesn't seem worth it.
3365\setbox0 = \hbox{\shortcontrm \putwordAppendix }
3366\newdimen\shortappendixwidth \shortappendixwidth = \wd0
3367
3368\def\shortchaplabel#1{%
3369 % We typeset #1 in a box of constant width, regardless of the text of
3370 % #1, so the chapter titles will come out aligned.
3371 \setbox0 = \hbox{#1}%
3372 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3373 %
3374 % This space should be plenty, since a single number is .5em, and the
3375 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3376 % (This space doesn't include the extra space that gets added after
359a1d0b 3377 % the label; that gets put in by \shortchapentry above.)
9e9f9cc2
KB
3378 \advance\dimen0 by 1.1em
3379 \hbox to \dimen0{#1\hfil}%
3380}
3381
3382\def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3383\def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
3384
3385% Sections.
3386\def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
3387\def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3388
3389% Subsections.
3390\def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
3391\def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3392
3393% And subsubsections.
3394\def\subsubsecentry#1#2#3#4#5#6{%
3395 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
3396\def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3397
9e9f9cc2
KB
3398% This parameter controls the indentation of the various levels.
3399\newdimen\tocindent \tocindent = 3pc
3400
3401% Now for the actual typesetting. In all these, #1 is the text and #2 is the
3402% page number.
3403%
359a1d0b 3404% If the toc has to be broken over pages, we want it to be at chapters
9e9f9cc2
KB
3405% if at all possible; hence the \penalty.
3406\def\dochapentry#1#2{%
359a1d0b 3407 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
9e9f9cc2
KB
3408 \begingroup
3409 \chapentryfonts
3410 \tocentry{#1}{\dopageno{#2}}%
3411 \endgroup
359a1d0b 3412 \nobreak\vskip .25\baselineskip plus.1\baselineskip
9e9f9cc2
KB
3413}
3414
3415\def\dosecentry#1#2{\begingroup
3416 \secentryfonts \leftskip=\tocindent
3417 \tocentry{#1}{\dopageno{#2}}%
3418\endgroup}
3419
3420\def\dosubsecentry#1#2{\begingroup
3421 \subsecentryfonts \leftskip=2\tocindent
3422 \tocentry{#1}{\dopageno{#2}}%
3423\endgroup}
3424
3425\def\dosubsubsecentry#1#2{\begingroup
3426 \subsubsecentryfonts \leftskip=3\tocindent
3427 \tocentry{#1}{\dopageno{#2}}%
3428\endgroup}
3429
3430% Final typesetting of a toc entry; we use the same \entry macro as for
3431% the index entries, but we want to suppress hyphenation here. (We
3432% can't do that in the \entry macro, since index entries might consist
3433% of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3434%
3435% \turnoffactive is for the sake of @" used for umlauts.
3436\def\tocentry#1#2{\begingroup
359a1d0b 3437 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
9e9f9cc2
KB
3438 \entry{\turnoffactive #1}{\turnoffactive #2}%
3439\endgroup}
3440
3441% Space between chapter (or whatever) number and the title.
3442\def\labelspace{\hskip1em \relax}
3443
3444\def\dopageno#1{{\rm #1}}
3445\def\doshortpageno#1{{\rm #1}}
3446
3447\def\chapentryfonts{\secfonts \rm}
3448\def\secentryfonts{\textfonts}
3449\let\subsecentryfonts = \textfonts
3450\let\subsubsecentryfonts = \textfonts
3451
3452
3453\message{environments,}
3454
3455% Since these characters are used in examples, it should be an even number of
3456% \tt widths. Each \tt character is 1en, so two makes it 1em.
3457% Furthermore, these definitions must come after we define our fonts.
3458\newbox\dblarrowbox \newbox\longdblarrowbox
3459\newbox\pushcharbox \newbox\bullbox
3460\newbox\equivbox \newbox\errorbox
3461
9e9f9cc2
KB
3462%{\tentt
3463%\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3464%\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3465%\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3466%\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3467% Adapted from the manmac format (p.420 of TeXbook)
3468%\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3469% depth .1ex\hfil}
3470%}
3471
474be527 3472% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
9e9f9cc2 3473\def\point{$\star$}
9e9f9cc2
KB
3474\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3475\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
3476\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
9e9f9cc2
KB
3477\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3478
3479% Adapted from the TeXbook's \boxit.
3480{\tentt \global\dimen0 = 3em}% Width of the box.
3481\dimen2 = .55pt % Thickness of rules
3482% The text. (`r' is open on the right, `e' somewhat less so on the left.)
3483\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
3484
3485\global\setbox\errorbox=\hbox to \dimen0{\hfil
3486 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3487 \advance\hsize by -2\dimen2 % Rules.
3488 \vbox{
3489 \hrule height\dimen2
3490 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3491 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3492 \kern3pt\vrule width\dimen2}% Space to right.
3493 \hrule height\dimen2}
3494 \hfil}
3495
3496% The @error{} command.
3497\def\error{\leavevmode\lower.7ex\copy\errorbox}
3498
3499% @tex ... @end tex escapes into raw Tex temporarily.
3500% One exception: @ is still an escape character, so that @end tex works.
3501% But \@ or @@ will get a plain tex @ character.
3502
3503\def\tex{\begingroup
3504\catcode `\\=0 \catcode `\{=1 \catcode `\}=2
3505\catcode `\$=3 \catcode `\&=4 \catcode `\#=6
3506\catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
3507\catcode `\%=14
359a1d0b 3508\catcode 43=12 % plus
9e9f9cc2
KB
3509\catcode`\"=12
3510\catcode`\==12
3511\catcode`\|=12
3512\catcode`\<=12
3513\catcode`\>=12
3514\escapechar=`\\
3515%
359a1d0b 3516\let\,=\ptexcomma
9e9f9cc2
KB
3517\let\{=\ptexlbrace
3518\let\}=\ptexrbrace
3519\let\.=\ptexdot
3520\let\*=\ptexstar
3521\let\dots=\ptexdots
1f205a47
UD
3522\def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
3523\def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
9e9f9cc2
KB
3524\def\@{@}%
3525\let\bullet=\ptexbullet
359a1d0b 3526\let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext
9e9f9cc2
KB
3527%
3528\let\Etex=\endgroup}
3529
3530% Define @lisp ... @endlisp.
3531% @lisp does a \begingroup so it can rebind things,
3532% including the definition of @endlisp (which normally is erroneous).
3533
3534% Amount to narrow the margins by for @lisp.
3535\newskip\lispnarrowing \lispnarrowing=0.4in
3536
3537% This is the definition that ^^M gets inside @lisp, @example, and other
3538% such environments. \null is better than a space, since it doesn't
3539% have any width.
3540\def\lisppar{\null\endgraf}
3541
3542% Make each space character in the input produce a normal interword
3543% space in the output. Don't allow a line break at this space, as this
3544% is used only in environments like @example, where each line of input
3545% should produce a line of output anyway.
3546%
3547{\obeyspaces %
3548\gdef\sepspaces{\obeyspaces\let =\tie}}
3549
3550% Define \obeyedspace to be our active space, whatever it is. This is
3551% for use in \parsearg.
3552{\sepspaces%
3553\global\let\obeyedspace= }
3554
3555% This space is always present above and below environments.
3556\newskip\envskipamount \envskipamount = 0pt
3557
3558% Make spacing and below environment symmetrical. We use \parskip here
3559% to help in doing that, since in @example-like environments \parskip
3560% is reset to zero; thus the \afterenvbreak inserts no space -- but the
3561% start of the next paragraph will insert \parskip
3562%
3563\def\aboveenvbreak{{\advance\envskipamount by \parskip
3564\endgraf \ifdim\lastskip<\envskipamount
3565\removelastskip \penalty-50 \vskip\envskipamount \fi}}
3566
3567\let\afterenvbreak = \aboveenvbreak
3568
3569% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3570\let\nonarrowing=\relax
3571
3572%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3573% \cartouche: draw rectangle w/rounded corners around argument
3574\font\circle=lcircle10
3575\newdimen\circthick
3576\newdimen\cartouter\newdimen\cartinner
3577\newskip\normbskip\newskip\normpskip\newskip\normlskip
3578\circthick=\fontdimen8\circle
3579%
3580\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
3581\def\ctr{{\hskip 6pt\circle\char'010}}
3582\def\cbl{{\circle\char'012\hskip -6pt}}
3583\def\cbr{{\hskip 6pt\circle\char'011}}
3584\def\carttop{\hbox to \cartouter{\hskip\lskip
2d07133b
KB
3585 \ctl\leaders\hrule height\circthick\hfil\ctr
3586 \hskip\rskip}}
9e9f9cc2 3587\def\cartbot{\hbox to \cartouter{\hskip\lskip
2d07133b
KB
3588 \cbl\leaders\hrule height\circthick\hfil\cbr
3589 \hskip\rskip}}
9e9f9cc2
KB
3590%
3591\newskip\lskip\newskip\rskip
3592
3593\long\def\cartouche{%
3594\begingroup
2d07133b
KB
3595 \lskip=\leftskip \rskip=\rightskip
3596 \leftskip=0pt\rightskip=0pt %we want these *outside*.
3597 \cartinner=\hsize \advance\cartinner by-\lskip
3598 \advance\cartinner by-\rskip
3599 \cartouter=\hsize
3600 \advance\cartouter by 18pt % allow for 3pt kerns on either
3601% side, and for 6pt waste from
3602% each corner char
3603 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
3604 % Flag to tell @lisp, etc., not to narrow margin.
3605 \let\nonarrowing=\comment
3606 \vbox\bgroup
3607 \baselineskip=0pt\parskip=0pt\lineskip=0pt
3608 \carttop
3609 \hbox\bgroup
3610 \hskip\lskip
3611 \vrule\kern3pt
3612 \vbox\bgroup
3613 \hsize=\cartinner
3614 \kern3pt
3615 \begingroup
3616 \baselineskip=\normbskip
3617 \lineskip=\normlskip
3618 \parskip=\normpskip
3619 \vskip -\parskip
9e9f9cc2 3620\def\Ecartouche{%
2d07133b
KB
3621 \endgroup
3622 \kern3pt
3623 \egroup
3624 \kern3pt\vrule
3625 \hskip\rskip
3626 \egroup
3627 \cartbot
3628 \egroup
9e9f9cc2
KB
3629\endgroup
3630}}
3631
3632
3633% This macro is called at the beginning of all the @example variants,
3634% inside a group.
3635\def\nonfillstart{%
3636 \aboveenvbreak
3637 \inENV % This group ends at the end of the body
3638 \hfuzz = 12pt % Don't be fussy
3639 \sepspaces % Make spaces be word-separators rather than space tokens.
3640 \singlespace
3641 \let\par = \lisppar % don't ignore blank lines
3642 \obeylines % each line of input is a line of output
3643 \parskip = 0pt
3644 \parindent = 0pt
3645 \emergencystretch = 0pt % don't try to avoid overfull boxes
3646 % @cartouche defines \nonarrowing to inhibit narrowing
3647 % at next level down.
3648 \ifx\nonarrowing\relax
3649 \advance \leftskip by \lispnarrowing
3650 \exdentamount=\lispnarrowing
3651 \let\exdent=\nofillexdent
3652 \let\nonarrowing=\relax
3653 \fi
3654}
3655
3656% To ending an @example-like environment, we first end the paragraph
3657% (via \afterenvbreak's vertical glue), and then the group. That way we
3658% keep the zero \parskip that the environments set -- \parskip glue
3659% will be inserted at the beginning of the next paragraph in the
3660% document, after the environment.
3661%
3662\def\nonfillfinish{\afterenvbreak\endgroup}%
3663
9e9f9cc2
KB
3664\def\lisp{\begingroup
3665 \nonfillstart
3666 \let\Elisp = \nonfillfinish
3667 \tt
762a2918
UD
3668 % Make @kbd do something special, if requested.
3669 \let\kbdfont\kbdexamplefont
9e9f9cc2
KB
3670 \rawbackslash % have \ input char produce \ char from current font
3671 \gobble
3672}
3673
3674% Define the \E... control sequence only if we are inside the
3675% environment, so the error checking in \end will work.
3676%
3677% We must call \lisp last in the definition, since it reads the
3678% return following the @example (or whatever) command.
3679%
3680\def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3681\def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3682\def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3683
3684% @smallexample and @smalllisp. This is not used unless the @smallbook
3685% command is given. Originally contributed by Pavel@xerox.
3686%
3687\def\smalllispx{\begingroup
3688 \nonfillstart
3689 \let\Esmalllisp = \nonfillfinish
3690 \let\Esmallexample = \nonfillfinish
3691 %
ea6631a2 3692 % Smaller fonts for small examples.
9e9f9cc2
KB
3693 \indexfonts \tt
3694 \rawbackslash % make \ output the \ character from the current font (tt)
3695 \gobble
3696}
3697
3698% This is @display; same as @lisp except use roman font.
3699%
3700\def\display{\begingroup
3701 \nonfillstart
3702 \let\Edisplay = \nonfillfinish
3703 \gobble
3704}
3705
3706% This is @format; same as @display except don't narrow margins.
3707%
3708\def\format{\begingroup
3709 \let\nonarrowing = t
3710 \nonfillstart
3711 \let\Eformat = \nonfillfinish
3712 \gobble
3713}
3714
3715% @flushleft (same as @format) and @flushright.
3716%
3717\def\flushleft{\begingroup
3718 \let\nonarrowing = t
3719 \nonfillstart
3720 \let\Eflushleft = \nonfillfinish
3721 \gobble
3722}
3723\def\flushright{\begingroup
3724 \let\nonarrowing = t
3725 \nonfillstart
3726 \let\Eflushright = \nonfillfinish
3727 \advance\leftskip by 0pt plus 1fill
3728 \gobble}
3729
3730% @quotation does normal linebreaking (hence we can't use \nonfillstart)
3731% and narrows the margins.
3732%
3733\def\quotation{%
3734 \begingroup\inENV %This group ends at the end of the @quotation body
3735 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
3736 \singlespace
3737 \parindent=0pt
3738 % We have retained a nonzero parskip for the environment, since we're
3739 % doing normal filling. So to avoid extra space below the environment...
3740 \def\Equotation{\parskip = 0pt \nonfillfinish}%
3741 %
3742 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3743 \ifx\nonarrowing\relax
3744 \advance\leftskip by \lispnarrowing
3745 \advance\rightskip by \lispnarrowing
3746 \exdentamount = \lispnarrowing
3747 \let\nonarrowing = \relax
3748 \fi
3749}
3750
3751\message{defuns,}
3752% Define formatter for defuns
3753% First, allow user to change definition object font (\df) internally
3754\def\setdeffont #1 {\csname DEF#1\endcsname}
3755
3756\newskip\defbodyindent \defbodyindent=.4in
3757\newskip\defargsindent \defargsindent=50pt
3758\newskip\deftypemargin \deftypemargin=12pt
3759\newskip\deflastargmargin \deflastargmargin=18pt
3760
3761\newcount\parencount
3762% define \functionparens, which makes ( and ) and & do special things.
3763% \functionparens affects the group it is contained in.
3764\def\activeparens{%
3765\catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3766\catcode`\[=\active \catcode`\]=\active}
3767
3768% Make control sequences which act like normal parenthesis chars.
3769\let\lparen = ( \let\rparen = )
3770
3771{\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3772
3773% Be sure that we always have a definition for `(', etc. For example,
3774% if the fn name has parens in it, \boldbrax will not be in effect yet,
3775% so TeX would otherwise complain about undefined control sequence.
3776\global\let(=\lparen \global\let)=\rparen
3777\global\let[=\lbrack \global\let]=\rbrack
3778
3779\gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3780\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3781% This is used to turn on special parens
3782% but make & act ordinary (given that it's active).
3783\gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
3784
3785% Definitions of (, ) and & used in args for functions.
3786% This is the definition of ( outside of all parentheses.
ebbad4cc
UD
3787\gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
3788 \global\advance\parencount by 1
3789}
9e9f9cc2
KB
3790%
3791% This is the definition of ( when already inside a level of parens.
3792\gdef\opnested{\char`\(\global\advance\parencount by 1 }
3793%
3794\gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
ebbad4cc
UD
3795 % also in that case restore the outer-level definition of (.
3796 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3797 \global\advance \parencount by -1 }
9e9f9cc2
KB
3798% If we encounter &foo, then turn on ()-hacking afterwards
3799\gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
3800%
3801\gdef\normalparens{\boldbrax\let&=\ampnr}
3802} % End of definition inside \activeparens
3803%% These parens (in \boldbrax) actually are a little bolder than the
3804%% contained text. This is especially needed for [ and ]
ebbad4cc
UD
3805\def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
3806\def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
3807\def\ampnr{\&}
3808\def\lbrb{{\bf\char`\[}}
3809\def\rbrb{{\bf\char`\]}}
9e9f9cc2
KB
3810
3811% First, defname, which formats the header line itself.
3812% #1 should be the function name.
3813% #2 should be the type of definition, such as "Function".
3814
3815\def\defname #1#2{%
3816% Get the values of \leftskip and \rightskip as they were
3817% outside the @def...
3818\dimen2=\leftskip
3819\advance\dimen2 by -\defbodyindent
3820\dimen3=\rightskip
3821\advance\dimen3 by -\defbodyindent
3822\noindent %
3823\setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3824\dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3825\dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3826\parshape 2 0in \dimen0 \defargsindent \dimen1 %
3827% Now output arg 2 ("Function" or some such)
3828% ending at \deftypemargin from the right margin,
3829% but stuck inside a box of width 0 so it does not interfere with linebreaking
3830{% Adjust \hsize to exclude the ambient margins,
3831% so that \rightline will obey them.
3832\advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3833\rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3834% Make all lines underfull and no complaints:
3835\tolerance=10000 \hbadness=10000
3836\advance\leftskip by -\defbodyindent
3837\exdentamount=\defbodyindent
3838{\df #1}\enskip % Generate function name
3839}
3840
3841% Actually process the body of a definition
3842% #1 should be the terminating control sequence, such as \Edefun.
3843% #2 should be the "another name" control sequence, such as \defunx.
3844% #3 should be the control sequence that actually processes the header,
3845% such as \defunheader.
3846
3847\def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3848\medbreak %
3849% Define the end token that this defining construct specifies
3850% so that it will exit this group.
3851\def#1{\endgraf\endgroup\medbreak}%
3852\def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3853\parindent=0in
3854\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3855\exdentamount=\defbodyindent
3856\begingroup %
3857\catcode 61=\active % 61 is `='
3858\obeylines\activeparens\spacesplit#3}
3859
3860\def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3861\medbreak %
3862% Define the end token that this defining construct specifies
3863% so that it will exit this group.
3864\def#1{\endgraf\endgroup\medbreak}%
3865\def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3866\parindent=0in
3867\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3868\exdentamount=\defbodyindent
3869\begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3870
3871\def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3872\medbreak %
3873% Define the end token that this defining construct specifies
3874% so that it will exit this group.
3875\def#1{\endgraf\endgroup\medbreak}%
3876\def#2##1 ##2 {\def#4{##1}%
3877\begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3878\parindent=0in
3879\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3880\exdentamount=\defbodyindent
3881\begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3882
3883% These parsing functions are similar to the preceding ones
3884% except that they do not make parens into active characters.
3885% These are used for "variables" since they have no arguments.
3886
3887\def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3888\medbreak %
3889% Define the end token that this defining construct specifies
3890% so that it will exit this group.
3891\def#1{\endgraf\endgroup\medbreak}%
3892\def#2{\begingroup\obeylines\spacesplit#3}%
3893\parindent=0in
3894\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3895\exdentamount=\defbodyindent
3896\begingroup %
3897\catcode 61=\active %
3898\obeylines\spacesplit#3}
3899
3900% This is used for \def{tp,vr}parsebody. It could probably be used for
3901% some of the others, too, with some judicious conditionals.
10dc2a90 3902%
9e9f9cc2
KB
3903\def\parsebodycommon#1#2#3{%
3904 \begingroup\inENV %
3905 \medbreak %
3906 % Define the end token that this defining construct specifies
3907 % so that it will exit this group.
3908 \def#1{\endgraf\endgroup\medbreak}%
3909 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3910 \parindent=0in
3911 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3912 \exdentamount=\defbodyindent
3913 \begingroup\obeylines
3914}
3915
3916\def\defvrparsebody#1#2#3#4 {%
3917 \parsebodycommon{#1}{#2}{#3}%
3918 \spacesplit{#3{#4}}%
3919}
3920
3921% This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3922% type is just `struct', because we lose the braces in `{struct
3923% termios}' when \spacesplit reads its undelimited argument. Sigh.
3924% \let\deftpparsebody=\defvrparsebody
3925%
3926% So, to get around this, we put \empty in with the type name. That
3927% way, TeX won't find exactly `{...}' as an undelimited argument, and
3928% won't strip off the braces.
3929%
3930\def\deftpparsebody #1#2#3#4 {%
3931 \parsebodycommon{#1}{#2}{#3}%
3932 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3933}
3934
3935% Fine, but then we have to eventually remove the \empty *and* the
df9ceed9 3936% braces (if any). That's what this does.
10dc2a90 3937%
df9ceed9 3938\def\removeemptybraces\empty#1\relax{#1}
9e9f9cc2
KB
3939
3940% After \spacesplit has done its work, this is called -- #1 is the final
3941% thing to call, #2 the type name (which starts with \empty), and #3
3942% (which might be empty) the arguments.
10dc2a90 3943%
9e9f9cc2 3944\def\parsetpheaderline#1#2#3{%
df9ceed9 3945 #1{\removeemptybraces#2\relax}{#3}%
9e9f9cc2
KB
3946}%
3947
3948\def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3949\medbreak %
3950% Define the end token that this defining construct specifies
3951% so that it will exit this group.
3952\def#1{\endgraf\endgroup\medbreak}%
3953\def#2##1 ##2 {\def#4{##1}%
3954\begingroup\obeylines\spacesplit{#3{##2}}}%
3955\parindent=0in
3956\advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3957\exdentamount=\defbodyindent
3958\begingroup\obeylines\spacesplit{#3{#5}}}
3959
3960% Split up #2 at the first space token.
3961% call #1 with two arguments:
3962% the first is all of #2 before the space token,
3963% the second is all of #2 after that space token.
3964% If #2 contains no space token, all of it is passed as the first arg
3965% and the second is passed as empty.
3966
3967{\obeylines
3968\gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3969\long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3970\ifx\relax #3%
3971#1{#2}{}\else #1{#2}{#3#4}\fi}}
3972
3973% So much for the things common to all kinds of definitions.
3974
3975% Define @defun.
3976
3977% First, define the processing that is wanted for arguments of \defun
3978% Use this to expand the args and terminate the paragraph they make up
3979
3980\def\defunargs #1{\functionparens \sl
3981% Expand, preventing hyphenation at `-' chars.
3982% Note that groups don't affect changes in \hyphenchar.
3983\hyphenchar\tensl=0
3984#1%
3985\hyphenchar\tensl=45
ebbad4cc 3986\ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
9e9f9cc2
KB
3987\interlinepenalty=10000
3988\advance\rightskip by 0pt plus 1fil
3989\endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3990}
3991
3992\def\deftypefunargs #1{%
3993% Expand, preventing hyphenation at `-' chars.
3994% Note that groups don't affect changes in \hyphenchar.
3995% Use \boldbraxnoamp, not \functionparens, so that & is not special.
3996\boldbraxnoamp
3997\tclose{#1}% avoid \code because of side effects on active chars
3998\interlinepenalty=10000
3999\advance\rightskip by 0pt plus 1fil
4000\endgraf\penalty 10000\vskip -\parskip\penalty 10000%
4001}
4002
4003% Do complete processing of one @defun or @defunx line already parsed.
4004
4005% @deffn Command forward-char nchars
4006
4007\def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4008
4009\def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4010\begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4011\catcode 61=\other % Turn off change made in \defparsebody
4012}
4013
4014% @defun == @deffn Function
4015
4016\def\defun{\defparsebody\Edefun\defunx\defunheader}
4017
4018\def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4019\begingroup\defname {#1}{Function}%
4020\defunargs {#2}\endgroup %
4021\catcode 61=\other % Turn off change made in \defparsebody
4022}
4023
4024% @deftypefun int foobar (int @var{foo}, float @var{bar})
4025
4026\def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4027
4028% #1 is the data type. #2 is the name and args.
4029\def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4030% #1 is the data type, #2 the name, #3 the args.
4031\def\deftypefunheaderx #1#2 #3\relax{%
4032\doind {fn}{\code{#2}}% Make entry in function index
4033\begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}%
4034\deftypefunargs {#3}\endgroup %
4035\catcode 61=\other % Turn off change made in \defparsebody
4036}
4037
4038% @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4039
4040\def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4041
4042% \defheaderxcond#1\relax$$$
4043% puts #1 in @code, followed by a space, but does nothing if #1 is null.
4044\def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4045
4046% #1 is the classification. #2 is the data type. #3 is the name and args.
4047\def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4048% #1 is the classification, #2 the data type, #3 the name, #4 the args.
4049\def\deftypefnheaderx #1#2#3 #4\relax{%
4050\doind {fn}{\code{#3}}% Make entry in function index
4051\begingroup
4052\normalparens % notably, turn off `&' magic, which prevents
4053% at least some C++ text from working
4054\defname {\defheaderxcond#2\relax$$$#3}{#1}%
4055\deftypefunargs {#4}\endgroup %
4056\catcode 61=\other % Turn off change made in \defparsebody
4057}
4058
4059% @defmac == @deffn Macro
4060
4061\def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4062
4063\def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4064\begingroup\defname {#1}{Macro}%
4065\defunargs {#2}\endgroup %
4066\catcode 61=\other % Turn off change made in \defparsebody
4067}
4068
4069% @defspec == @deffn Special Form
4070
4071\def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4072
4073\def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4074\begingroup\defname {#1}{Special Form}%
4075\defunargs {#2}\endgroup %
4076\catcode 61=\other % Turn off change made in \defparsebody
4077}
4078
4079% This definition is run if you use @defunx
4080% anywhere other than immediately after a @defun or @defunx.
4081
4082\def\deffnx #1 {\errmessage{@deffnx in invalid context}}
4083\def\defunx #1 {\errmessage{@defunx in invalid context}}
4084\def\defmacx #1 {\errmessage{@defmacx in invalid context}}
4085\def\defspecx #1 {\errmessage{@defspecx in invalid context}}
4086\def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
ebbad4cc 4087\def\deftypemethodx #1 {\errmessage{@deftypemethodx in invalid context}}
9e9f9cc2
KB
4088\def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
4089
4090% @defmethod, and so on
4091
4092% @defop {Funny Method} foo-class frobnicate argument
4093
4094\def\defop #1 {\def\defoptype{#1}%
4095\defopparsebody\Edefop\defopx\defopheader\defoptype}
4096
4097\def\defopheader #1#2#3{%
4098\dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
4099\begingroup\defname {#2}{\defoptype{} on #1}%
4100\defunargs {#3}\endgroup %
4101}
4102
ebbad4cc
UD
4103% @deftypemethod foo-class return-type foo-method args
4104%
4105\def\deftypemethod{%
4106 \defmethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4107%
4108% #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4109\def\deftypemethodheader#1#2#3#4{%
4110 \deftypefnheaderx{Method on #1}{#2}#3 #4\relax
4111}
4112
9e9f9cc2
KB
4113% @defmethod == @defop Method
4114
4115\def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4116
4117\def\defmethodheader #1#2#3{%
4118\dosubind {fn}{\code{#2}}{on #1}% entry in function index
4119\begingroup\defname {#2}{Method on #1}%
4120\defunargs {#3}\endgroup %
4121}
4122
4123% @defcv {Class Option} foo-class foo-flag
4124
4125\def\defcv #1 {\def\defcvtype{#1}%
4126\defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4127
4128\def\defcvarheader #1#2#3{%
4129\dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
4130\begingroup\defname {#2}{\defcvtype{} of #1}%
4131\defvarargs {#3}\endgroup %
4132}
4133
4134% @defivar == @defcv {Instance Variable}
4135
4136\def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
4137
4138\def\defivarheader #1#2#3{%
4139\dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
4140\begingroup\defname {#2}{Instance Variable of #1}%
4141\defvarargs {#3}\endgroup %
4142}
4143
4144% These definitions are run if you use @defmethodx, etc.,
4145% anywhere other than immediately after a @defmethod, etc.
4146
4147\def\defopx #1 {\errmessage{@defopx in invalid context}}
4148\def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
4149\def\defcvx #1 {\errmessage{@defcvx in invalid context}}
4150\def\defivarx #1 {\errmessage{@defivarx in invalid context}}
4151
4152% Now @defvar
4153
4154% First, define the processing that is wanted for arguments of @defvar.
4155% This is actually simple: just print them in roman.
4156% This must expand the args and terminate the paragraph they make up
4157\def\defvarargs #1{\normalparens #1%
4158\interlinepenalty=10000
4159\endgraf\penalty 10000\vskip -\parskip\penalty 10000}
4160
4161% @defvr Counter foo-count
4162
4163\def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
4164
4165\def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
4166\begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
4167
4168% @defvar == @defvr Variable
4169
4170\def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
4171
4172\def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4173\begingroup\defname {#1}{Variable}%
4174\defvarargs {#2}\endgroup %
4175}
4176
4177% @defopt == @defvr {User Option}
4178
4179\def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
4180
4181\def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4182\begingroup\defname {#1}{User Option}%
4183\defvarargs {#2}\endgroup %
4184}
4185
4186% @deftypevar int foobar
4187
4188\def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
4189
c44db1b1
KB
4190% #1 is the data type. #2 is the name, perhaps followed by text that
4191% is actually part of the data type, which should not be put into the index.
9e9f9cc2 4192\def\deftypevarheader #1#2{%
c44db1b1 4193\dovarind#2 \relax% Make entry in variables index
9e9f9cc2
KB
4194\begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}%
4195\interlinepenalty=10000
4196\endgraf\penalty 10000\vskip -\parskip\penalty 10000
4197\endgroup}
c44db1b1 4198\def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
9e9f9cc2
KB
4199
4200% @deftypevr {Global Flag} int enable
4201
4202\def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
4203
c44db1b1 4204\def\deftypevrheader #1#2#3{\dovarind#3 \relax%
9e9f9cc2
KB
4205\begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
4206\interlinepenalty=10000
4207\endgraf\penalty 10000\vskip -\parskip\penalty 10000
4208\endgroup}
4209
4210% This definition is run if you use @defvarx
4211% anywhere other than immediately after a @defvar or @defvarx.
4212
4213\def\defvrx #1 {\errmessage{@defvrx in invalid context}}
4214\def\defvarx #1 {\errmessage{@defvarx in invalid context}}
4215\def\defoptx #1 {\errmessage{@defoptx in invalid context}}
4216\def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
4217\def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
4218
4219% Now define @deftp
4220% Args are printed in bold, a slight difference from @defvar.
4221
4222\def\deftpargs #1{\bf \defvarargs{#1}}
4223
4224% @deftp Class window height width ...
4225
4226\def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
4227
4228\def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
4229\begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
4230
4231% This definition is run if you use @deftpx, etc
4232% anywhere other than immediately after a @deftp, etc.
4233
4234\def\deftpx #1 {\errmessage{@deftpx in invalid context}}
4235
d66b7b41 4236
9e9f9cc2
KB
4237\message{cross reference,}
4238% Define cross-reference macros
4239\newwrite \auxfile
4240
4241\newif\ifhavexrefs % True if xref values are known.
4242\newif\ifwarnedxrefs % True if we warned once that they aren't known.
4243
d66b7b41
KB
4244% @inforef is simple.
4245\def\inforef #1{\inforefzzz #1,,,,**}
4246\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
4247 node \samp{\ignorespaces#1{}}}
4248
9e9f9cc2
KB
4249% \setref{foo} defines a cross-reference point named foo.
4250
4251\def\setref#1{%
4252\dosetq{#1-title}{Ytitle}%
4253\dosetq{#1-pg}{Ypagenumber}%
4254\dosetq{#1-snt}{Ysectionnumberandtype}}
4255
4256\def\unnumbsetref#1{%
4257\dosetq{#1-title}{Ytitle}%
4258\dosetq{#1-pg}{Ypagenumber}%
4259\dosetq{#1-snt}{Ynothing}}
4260
4261\def\appendixsetref#1{%
4262\dosetq{#1-title}{Ytitle}%
4263\dosetq{#1-pg}{Ypagenumber}%
4264\dosetq{#1-snt}{Yappendixletterandtype}}
4265
4266% \xref, \pxref, and \ref generate cross-references to specified points.
4267% For \xrefX, #1 is the node name, #2 the name of the Info
4268% cross-reference, #3 the printed node name, #4 the name of the Info
4269% file, #5 the name of the printed manual. All but the node name can be
4270% omitted.
4271%
4272\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
4273\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
4274\def\ref#1{\xrefX[#1,,,,,,,]}
4275\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
4276 \def\printedmanual{\ignorespaces #5}%
4277 \def\printednodename{\ignorespaces #3}%
4278 \setbox1=\hbox{\printedmanual}%
4279 \setbox0=\hbox{\printednodename}%
4280 \ifdim \wd0 = 0pt
4281 % No printed node name was explicitly given.
4282 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
4283 % Use the node name inside the square brackets.
4284 \def\printednodename{\ignorespaces #1}%
4285 \else
4286 % Use the actual chapter/section title appear inside
4287 % the square brackets. Use the real section title if we have it.
4288 \ifdim \wd1>0pt%
4289 % It is in another manual, so we don't have it.
4290 \def\printednodename{\ignorespaces #1}%
4291 \else
4292 \ifhavexrefs
4293 % We know the real title if we have the xref values.
4294 \def\printednodename{\refx{#1-title}{}}%
4295 \else
4296 % Otherwise just copy the Info node name.
4297 \def\printednodename{\ignorespaces #1}%
4298 \fi%
4299 \fi
4300 \fi
4301 \fi
4302 %
4303 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
4304 % insert empty discretionaries after hyphens, which means that it will
4305 % not find a line break at a hyphen in a node names. Since some manuals
4306 % are best written with fairly long node names, containing hyphens, this
4307 % is a loss. Therefore, we give the text of the node name again, so it
4308 % is as if TeX is seeing it for the first time.
4309 \ifdim \wd1 > 0pt
4310 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}%
4311 \else
4312 % _ (for example) has to be the character _ for the purposes of the
4313 % control sequence corresponding to the node, but it has to expand
4314 % into the usual \leavevmode...\vrule stuff for purposes of
4315 % printing. So we \turnoffactive for the \refx-snt, back on for the
4316 % printing, back off for the \refx-pg.
4317 {\turnoffactive \refx{#1-snt}{}}%
4318 \space [\printednodename],\space
4319 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
4320 \fi
4321\endgroup}
4322
4323% \dosetq is the interface for calls from other macros
4324
4325% Use \turnoffactive so that punctuation chars such as underscore
4326% work in node names.
10dc2a90 4327\def\dosetq #1#2{{\let\folio=0 \turnoffactive
9e9f9cc2
KB
4328\edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
4329\next}}
4330
4331% \internalsetq {foo}{page} expands into
4332% CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
4333% When the aux file is read, ' is the escape character
4334
4335\def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
4336
4337% Things to be expanded by \internalsetq
4338
4339\def\Ypagenumber{\folio}
4340
4341\def\Ytitle{\thissection}
4342
4343\def\Ynothing{}
4344
4345\def\Ysectionnumberandtype{%
4346\ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
4347\else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
4348\else \ifnum \subsubsecno=0 %
4349\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
4350\else %
4351\putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
4352\fi \fi \fi }
4353
4354\def\Yappendixletterandtype{%
4355\ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
4356\else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
4357\else \ifnum \subsubsecno=0 %
4358\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
4359\else %
4360\putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
4361\fi \fi \fi }
4362
4363\gdef\xreftie{'tie}
4364
4365% Use TeX 3.0's \inputlineno to get the line number, for better error
4366% messages, but if we're using an old version of TeX, don't do anything.
4367%
4368\ifx\inputlineno\thisisundefined
4369 \let\linenumber = \empty % Non-3.0.
4370\else
4371 \def\linenumber{\the\inputlineno:\space}
4372\fi
4373
4374% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
4375% If its value is nonempty, SUFFIX is output afterward.
4376
4377\def\refx#1#2{%
4378 \expandafter\ifx\csname X#1\endcsname\relax
4379 % If not defined, say something at least.
4380 $\langle$un\-de\-fined$\rangle$%
4381 \ifhavexrefs
4382 \message{\linenumber Undefined cross reference `#1'.}%
4383 \else
4384 \ifwarnedxrefs\else
4385 \global\warnedxrefstrue
4386 \message{Cross reference values unknown; you must run TeX again.}%
4387 \fi
4388 \fi
4389 \else
4390 % It's defined, so just use it.
4391 \csname X#1\endcsname
4392 \fi
4393 #2% Output the suffix in any case.
4394}
4395
9e9f9cc2 4396% This is the macro invoked by entries in the aux file.
4dbca03b
KB
4397\def\xrdef #1#2{{%
4398 \catcode`\'=\other
4399 \expandafter\gdef\csname X#1\endcsname{#2}%
4400}}
9e9f9cc2 4401
4dbca03b
KB
4402% Read the last existing aux file, if any. No error if none exists.
4403\def\readauxfile{\begingroup
4404 \catcode`\^^@=\other
9c2322bc
UD
4405 \catcode`\^\ 1=\other
4406 \catcode`\^\ 2=\other
4dbca03b
KB
4407 \catcode`\^^C=\other
4408 \catcode`\^^D=\other
4409 \catcode`\^^E=\other
4410 \catcode`\^^F=\other
4411 \catcode`\^^G=\other
4412 \catcode`\^^H=\other
9c2322bc 4413 \catcode`\^\v=\other
4dbca03b 4414 \catcode`\^^L=\other
9c2322bc
UD
4415 \catcode`\^^N=\other
4416 \catcode`\^^P=\other
4417 \catcode`\^^Q=\other
4418 \catcode`\^^R=\other
4419 \catcode`\^^S=\other
4420 \catcode`\^^T=\other
4421 \catcode`\^^U=\other
4422 \catcode`\^^V=\other
4423 \catcode`\^^W=\other
4424 \catcode`\^^X=\other
4425 \catcode`\^^Z=\other
4dbca03b
KB
4426 \catcode`\^^[=\other
4427 \catcode`\^^\=\other
4428 \catcode`\^^]=\other
4429 \catcode`\^^^=\other
4430 \catcode`\^^_=\other
4431 \catcode`\@=\other
4432 \catcode`\^=\other
4433 % It was suggested to define this as 7, which would allow ^^e4 etc.
4434 % in xref tags, i.e., node names. But since ^^e4 notation isn't
4435 % supported in the main text, it doesn't seem desirable. Furthermore,
4436 % that is not enough: for node names that actually contain a ^
4437 % character, we would end up writing a line like this: 'xrdef {'hat
4438 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
4439 % argument, and \hat is not an expandable control sequence. It could
4440 % all be worked out, but why? Either we support ^^ or we don't.
10dc2a90 4441 %
4dbca03b
KB
4442 % The other change necessary for this was to define \auxhat:
4443 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
4444 % and then to call \auxhat in \setq.
10dc2a90 4445 %
4dbca03b
KB
4446 \catcode`\~=\other
4447 \catcode`\[=\other
4448 \catcode`\]=\other
4449 \catcode`\"=\other
4450 \catcode`\_=\other
4451 \catcode`\|=\other
4452 \catcode`\<=\other
4453 \catcode`\>=\other
4454 \catcode`\$=\other
4455 \catcode`\#=\other
4456 \catcode`\&=\other
4457 % `\+ does not work, so use 43.
4458 \catcode43=\other
4459 % Make the characters 128-255 be printing characters
4460 {%
4461 \count 1=128
4462 \def\loop{%
4463 \catcode\count 1=\other
4464 \advance\count 1 by 1
4465 \ifnum \count 1<256 \loop \fi
4466 }%
9e9f9cc2 4467 }%
4dbca03b
KB
4468 % The aux file uses ' as the escape (for now).
4469 % Turn off \ as an escape so we do not lose on
4470 % entries which were dumped with control sequences in their names.
4471 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
4472 % Reference to such entries still does not work the way one would wish,
4473 % but at least they do not bomb out when the aux file is read in.
4474 \catcode`\{=1
4475 \catcode`\}=2
4476 \catcode`\%=\other
4477 \catcode`\'=0
4478 \catcode`\\=\other
4479 %
4480 \openin 1 \jobname.aux
4481 \ifeof 1 \else
4482 \closein 1
4483 \input \jobname.aux
4484 \global\havexrefstrue
4485 \global\warnedobstrue
4486 \fi
4487 % Open the new aux file. TeX will close it automatically at exit.
4488 \openout\auxfile=\jobname.aux
9e9f9cc2
KB
4489\endgroup}
4490
4491
4492% Footnotes.
4493
4494\newcount \footnoteno
4495
4496% The trailing space in the following definition for supereject is
4497% vital for proper filling; pages come out unaligned when you do a
4498% pagealignmacro call if that space before the closing brace is
793fde8a
KB
4499% removed. (Generally, numeric constants should always be followed by a
4500% space to prevent strange expansion errors.)
9e9f9cc2
KB
4501\def\supereject{\par\penalty -20000\footnoteno =0 }
4502
9c2322bc 4503% @footnotestyle is meaningful for info output only.
9e9f9cc2
KB
4504\let\footnotestyle=\comment
4505
4506\let\ptexfootnote=\footnote
4507
4508{\catcode `\@=11
4509%
4510% Auto-number footnotes. Otherwise like plain.
4511\gdef\footnote{%
4512 \global\advance\footnoteno by \@ne
4513 \edef\thisfootno{$^{\the\footnoteno}$}%
4514 %
4515 % In case the footnote comes at the end of a sentence, preserve the
4516 % extra spacing after we do the footnote number.
4517 \let\@sf\empty
4518 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
4519 %
4520 % Remove inadvertent blank space before typesetting the footnote number.
4521 \unskip
4522 \thisfootno\@sf
4523 \footnotezzz
4524}%
4525
4526% Don't bother with the trickery in plain.tex to not require the
4527% footnote text as a parameter. Our footnotes don't need to be so general.
10dc2a90 4528%
3a3df4c7
KB
4529% Oh yes, they do; otherwise, @ifset and anything else that uses
4530% \parseargline fail inside footnotes because the tokens are fixed when
4531% the footnote is read. --karl, 16nov96.
9e9f9cc2 4532%
3a3df4c7 4533\long\gdef\footnotezzz{\insert\footins\bgroup
9e9f9cc2
KB
4534 % We want to typeset this text as a normal paragraph, even if the
4535 % footnote reference occurs in (for example) a display environment.
4536 % So reset some parameters.
4537 \interlinepenalty\interfootnotelinepenalty
4538 \splittopskip\ht\strutbox % top baseline for broken footnotes
4539 \splitmaxdepth\dp\strutbox
4540 \floatingpenalty\@MM
4541 \leftskip\z@skip
4542 \rightskip\z@skip
4543 \spaceskip\z@skip
4544 \xspaceskip\z@skip
4545 \parindent\defaultparindent
4546 %
4547 % Hang the footnote text off the number.
4548 \hang
4549 \textindent{\thisfootno}%
4550 %
4551 % Don't crash into the line above the footnote text. Since this
4552 % expands into a box, it must come within the paragraph, lest it
4553 % provide a place where TeX can split the footnote.
4554 \footstrut
3a3df4c7 4555 \futurelet\next\fo@t
9e9f9cc2 4556}
3a3df4c7
KB
4557\def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
4558 \else\let\next\f@t\fi \next}
4559\def\f@@t{\bgroup\aftergroup\@foot\let\next}
4560\def\f@t#1{#1\@foot}
4561\def\@foot{\strut\egroup}
9e9f9cc2
KB
4562
4563}%end \catcode `\@=11
4564
4565% Set the baselineskip to #1, and the lineskip and strut size
4566% correspondingly. There is no deep meaning behind these magic numbers
4567% used as factors; they just match (closely enough) what Knuth defined.
4568%
4569\def\lineskipfactor{.08333}
4570\def\strutheightpercent{.70833}
4571\def\strutdepthpercent {.29167}
4572%
4573\def\setleading#1{%
4574 \normalbaselineskip = #1\relax
4575 \normallineskip = \lineskipfactor\normalbaselineskip
4576 \normalbaselines
4577 \setbox\strutbox =\hbox{%
4578 \vrule width0pt height\strutheightpercent\baselineskip
4579 depth \strutdepthpercent \baselineskip
4580 }%
4581}
4582
4583% @| inserts a changebar to the left of the current line. It should
4584% surround any changed text. This approach does *not* work if the
4585% change spans more than two lines of output. To handle that, we would
4586% have adopt a much more difficult approach (putting marks into the main
4587% vertical list for the beginning and end of each change).
4588%
4589\def\|{%
4590 % \vadjust can only be used in horizontal mode.
4591 \leavevmode
4592 %
4593 % Append this vertical mode material after the current line in the output.
4594 \vadjust{%
4595 % We want to insert a rule with the height and depth of the current
4596 % leading; that is exactly what \strutbox is supposed to record.
4597 \vskip-\baselineskip
4598 %
4599 % \vadjust-items are inserted at the left edge of the type. So
4600 % the \llap here moves out into the left-hand margin.
4601 \llap{%
4602 %
4603 % For a thicker or thinner bar, change the `1pt'.
4604 \vrule height\baselineskip width1pt
4605 %
4606 % This is the space between the bar and the text.
4607 \hskip 12pt
4608 }%
4609 }%
4610}
4611
4612% For a final copy, take out the rectangles
4613% that mark overfull boxes (in case you have decided
4614% that the text looks ok even though it passes the margin).
4615%
4616\def\finalout{\overfullrule=0pt}
4617
5ae3e846
UD
4618% @image. We use the macros from epsf.tex to support this.
4619% If epsf.tex is not installed and @image is used, we complain.
4620%
4621% Check for and read epsf.tex up front. If we read it only at @image
4622% time, we might be inside a group, and then its definitions would get
4623% undone and the next image would fail.
4624\openin 1 = xepsf.tex
4625\ifeof 1 \else
4626 \closein 1
4627 \def\epsfannounce{\toks0 = }% do not bother showing banner
4628 \input epsf.tex
4629\fi
4630%
4631\newif\ifwarnednoepsf
4632\newhelp\noepsfhelp{epsf.tex must be installed for images to
4633 work. It is also included in the Texinfo distribution, or you can get
4634 it from ftp://ftp.tug.org/tex/epsf.tex.}
4635%
4636% Only complain once about lack of epsf.tex.
4637\def\image#1{%
4638 \ifx\epsfbox\undefined
4639 \ifwarnednoepsf \else
4640 \errhelp = \noepsfhelp
4641 \errmessage{epsf.tex not found, images will be ignored}%
4642 \global\warnednoepsftrue
4643 \fi
4644 \else
4645 \imagexxx #1,,,\finish
4646 \fi
4647}
4648%
4649% Arguments to @image:
4650% #1 is (mandatory) image filename; we tack on .eps extension.
4651% #2 is (optional) width, #3 is (optional) height.
4652% #4 is just the usual extra ignored arg for parsing this stuff.
4653\def\imagexxx#1,#2,#3,#4\finish{%
4654 % \epsfbox itself resets \epsf?size at each figure.
4655 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
4656 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
4657 \epsfbox{#1.eps}%
4658}
9e9f9cc2
KB
4659
4660% End of control word definitions.
4661
5ae3e846 4662
9e9f9cc2
KB
4663\message{and turning on texinfo input format.}
4664
4665\def\openindices{%
4666 \newindex{cp}%
4667 \newcodeindex{fn}%
4668 \newcodeindex{vr}%
4669 \newcodeindex{tp}%
4670 \newcodeindex{ky}%
4671 \newcodeindex{pg}%
4672}
4673
4674% Set some numeric style parameters, for 8.5 x 11 format.
4675
474be527
KB
4676\hsize = 6in
4677\hoffset = .25in
9e9f9cc2
KB
4678\newdimen\defaultparindent \defaultparindent = 15pt
4679\parindent = \defaultparindent
474be527
KB
4680\parskip 3pt plus 2pt minus 1pt
4681\setleading{13.2pt}
9e9f9cc2
KB
4682\advance\topskip by 1.2cm
4683
474be527
KB
4684\chapheadingskip = 15pt plus 4pt minus 2pt
4685\secheadingskip = 12pt plus 3pt minus 2pt
4686\subsecheadingskip = 9pt plus 2pt minus 2pt
4687
9e9f9cc2
KB
4688% Prevent underfull vbox error messages.
4689\vbadness=10000
4690
4691% Following George Bush, just get rid of widows and orphans.
4692\widowpenalty=10000
4693\clubpenalty=10000
4694
4695% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4696% using an old version of TeX, don't do anything. We want the amount of
4697% stretch added to depend on the line length, hence the dependence on
4698% \hsize. This makes it come to about 9pt for the 8.5x11 format.
4699%
4700\ifx\emergencystretch\thisisundefined
4701 % Allow us to assign to \emergencystretch anyway.
4702 \def\emergencystretch{\dimen0}%
4703\else
4704 \emergencystretch = \hsize
4705 \divide\emergencystretch by 45
4706\fi
4707
4708% Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4709\def\smallbook{
474be527
KB
4710 \global\chapheadingskip = 15pt plus 4pt minus 2pt
4711 \global\secheadingskip = 12pt plus 3pt minus 2pt
4712 \global\subsecheadingskip = 9pt plus 2pt minus 2pt
4713 %
4714 \global\lispnarrowing = 0.3in
4715 \setleading{12pt}
4716 \advance\topskip by -1cm
4717 \global\parskip 2pt plus 1pt
4718 \global\hsize = 5in
4719 \global\vsize=7.5in
4720 \global\tolerance=700
4721 \global\hfuzz=1pt
4722 \global\contentsrightmargin=0pt
4723 \global\deftypemargin=0pt
4724 \global\defbodyindent=.5cm
4725 %
4726 \global\pagewidth=\hsize
4727 \global\pageheight=\vsize
4728 %
4729 \global\let\smalllisp=\smalllispx
4730 \global\let\smallexample=\smalllispx
4731 \global\def\Esmallexample{\Esmalllisp}
9e9f9cc2
KB
4732}
4733
4734% Use @afourpaper to print on European A4 paper.
4735\def\afourpaper{
4736\global\tolerance=700
4737\global\hfuzz=1pt
4738\setleading{12pt}
4739\global\parskip 15pt plus 1pt
4740
4741\global\vsize= 53\baselineskip
4742\advance\vsize by \topskip
4743%\global\hsize= 5.85in % A4 wide 10pt
4744\global\hsize= 6.5in
4745\global\outerhsize=\hsize
4746\global\advance\outerhsize by 0.5in
4747\global\outervsize=\vsize
4748\global\advance\outervsize by 0.6in
4749
4750\global\pagewidth=\hsize
4751\global\pageheight=\vsize
4752}
4753
2d07133b
KB
4754\bindingoffset=0pt
4755\normaloffset=\hoffset
4756\pagewidth=\hsize
4757\pageheight=\vsize
4758
9e9f9cc2
KB
4759% Allow control of the text dimensions. Parameters in order: textheight;
4760% textwidth; voffset; hoffset; binding offset; topskip.
4761% All require a dimension;
4762% header is additional; added length extends the bottom of the page.
4763
4764\def\changepagesizes#1#2#3#4#5#6{
4765 \global\vsize= #1
4766 \global\topskip= #6
4767 \advance\vsize by \topskip
4768 \global\voffset= #3
4769 \global\hsize= #2
4770 \global\outerhsize=\hsize
4771 \global\advance\outerhsize by 0.5in
4772 \global\outervsize=\vsize
4773 \global\advance\outervsize by 0.6in
4774 \global\pagewidth=\hsize
4775 \global\pageheight=\vsize
4776 \global\normaloffset= #4
4777 \global\bindingoffset= #5}
4778
4779% A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
4780% 29mm, hence bottom margin 28mm, nominal side margin 3cm.
4781\def\afourlatex
4782 {\global\tolerance=700
4783 \global\hfuzz=1pt
4784 \setleading{12pt}
4785 \global\parskip 15pt plus 1pt
4786 \advance\baselineskip by 1.6pt
4787 \changepagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}
4788 }
4789
4790% Use @afourwide to print on European A4 paper in wide format.
4791\def\afourwide{\afourpaper
4792\changepagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}}
4793
4794% Define macros to output various characters with catcode for normal text.
4795\catcode`\"=\other
4796\catcode`\~=\other
4797\catcode`\^=\other
4798\catcode`\_=\other
4799\catcode`\|=\other
4800\catcode`\<=\other
4801\catcode`\>=\other
4802\catcode`\+=\other
4803\def\normaldoublequote{"}
4804\def\normaltilde{~}
4805\def\normalcaret{^}
4806\def\normalunderscore{_}
4807\def\normalverticalbar{|}
4808\def\normalless{<}
4809\def\normalgreater{>}
4810\def\normalplus{+}
4811
4812% This macro is used to make a character print one way in ttfont
4813% where it can probably just be output, and another way in other fonts,
4814% where something hairier probably needs to be done.
4815%
4816% #1 is what to print if we are indeed using \tt; #2 is what to print
4817% otherwise. Since all the Computer Modern typewriter fonts have zero
4818% interword stretch (and shrink), and it is reasonable to expect all
4819% typewriter fonts to have this, we can check that font parameter.
4820%
4821\def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
4822
4823% Turn off all special characters except @
4824% (and those which the user can use as if they were ordinary).
4825% Most of these we simply print from the \tt font, but for some, we can
4826% use math or other variants that look better in normal text.
4827
4828\catcode`\"=\active
4829\def\activedoublequote{{\tt \char '042}}
4830\let"=\activedoublequote
4831\catcode`\~=\active
4832\def~{{\tt \char '176}}
4833\chardef\hat=`\^
4834\catcode`\^=\active
9e9f9cc2
KB
4835\def^{{\tt \hat}}
4836
4837\catcode`\_=\active
4838\def_{\ifusingtt\normalunderscore\_}
4839% Subroutine for the previous macro.
4840\def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}}
4841
4842\catcode`\|=\active
4843\def|{{\tt \char '174}}
4844\chardef \less=`\<
4845\catcode`\<=\active
4846\def<{{\tt \less}}
4847\chardef \gtr=`\>
4848\catcode`\>=\active
4849\def>{{\tt \gtr}}
4850\catcode`\+=\active
4851\def+{{\tt \char 43}}
4852%\catcode 27=\active
4853%\def^^[{$\diamondsuit$}
4854
4855% Set up an active definition for =, but don't enable it most of the time.
4856{\catcode`\==\active
4857\global\def={{\tt \char 61}}}
4858
4859\catcode`+=\active
4860\catcode`\_=\active
4861
4862% If a .fmt file is being used, characters that might appear in a file
4863% name cannot be active until we have parsed the command line.
4864% So turn them off again, and have \everyjob (or @setfilename) turn them on.
4865% \otherifyactive is called near the end of this file.
4866\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
4867
4868\catcode`\@=0
4869
4870% \rawbackslashxx output one backslash character in current font
4871\global\chardef\rawbackslashxx=`\\
4872%{\catcode`\\=\other
4873%@gdef@rawbackslashxx{\}}
4874
4875% \rawbackslash redefines \ as input to do \rawbackslashxx.
4876{\catcode`\\=\active
4877@gdef@rawbackslash{@let\=@rawbackslashxx }}
4878
4879% \normalbackslash outputs one backslash in fixed width font.
4880\def\normalbackslash{{\tt\rawbackslashxx}}
4881
4882% Say @foo, not \foo, in error messages.
4883\escapechar=`\@
4884
4885% \catcode 17=0 % Define control-q
4886\catcode`\\=\active
4887
4888% Used sometimes to turn off (effectively) the active characters
4889% even after parsing them.
4890@def@turnoffactive{@let"=@normaldoublequote
4891@let\=@realbackslash
4892@let~=@normaltilde
4893@let^=@normalcaret
4894@let_=@normalunderscore
4895@let|=@normalverticalbar
4896@let<=@normalless
4897@let>=@normalgreater
4898@let+=@normalplus}
4899
4900@def@normalturnoffactive{@let"=@normaldoublequote
4901@let\=@normalbackslash
4902@let~=@normaltilde
4903@let^=@normalcaret
4904@let_=@normalunderscore
4905@let|=@normalverticalbar
4906@let<=@normalless
4907@let>=@normalgreater
4908@let+=@normalplus}
4909
4910% Make _ and + \other characters, temporarily.
4911% This is canceled by @fixbackslash.
4912@otherifyactive
4913
4914% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4915% That is what \eatinput is for; after that, the `\' should revert to printing
4916% a backslash.
4917%
4918@gdef@eatinput input texinfo{@fixbackslash}
4919@global@let\ = @eatinput
4920
4921% On the other hand, perhaps the file did not have a `\input texinfo'. Then
4922% the first `\{ in the file would cause an error. This macro tries to fix
4923% that, assuming it is called before the first `\' could plausibly occur.
4924% Also back turn on active characters that might appear in the input
4925% file name, in case not using a pre-dumped format.
4926%
4927@gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi
4928 @catcode`+=@active @catcode`@_=@active}
4929
4930%% These look ok in all fonts, so just make them not special. The @rm below
4931%% makes sure that the current font starts out as the newly loaded cmr10
4932@catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4933
4934@textfonts
4935@rm
4936
4937@c Local variables:
4938@c page-delimiter: "^\\\\message"
4939@c End:
This page took 0.545398 seconds and 5 git commands to generate.