changed variables v and d to complete words version and debian
[findutils.git] / doc / texinfo.tex
blob731cc1f49d536e4124c9eb4a86d74b5ab334827e
1 %% TeX macros to handle texinfo files
3 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 1994 Free Software Foundation, Inc.
5 %This texinfo.tex file is free software; you can redistribute it and/or
6 %modify it under the terms of the GNU General Public License as
7 %published by the Free Software Foundation; either version 2, or (at
8 %your option) any later version.
10 %This texinfo.tex file is distributed in the hope that it will be
11 %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
12 %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 %General Public License for more details.
15 %You should have received a copy of the GNU General Public License
16 %along with this texinfo.tex file; see the file COPYING. If not, write
17 %to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
18 %USA.
21 %In other words, you are welcome to use, share and improve this program.
22 %You are forbidden to forbid anyone else to use, share and improve
23 %what you give them. Help stamp out software-hoarding!
25 % This automatically updates the version number based on RCS.
26 \def\deftexinfoversion$#1: #2 ${\def\texinfoversion{#2}}
27 \deftexinfoversion$Revision: 1.1 $
28 \message{Loading texinfo package [Version \texinfoversion]:}
30 % Print the version number if in a .fmt file.
31 \everyjob{\message{[Texinfo version \texinfoversion]}\message{}}
33 % Save some parts of plain tex whose names we will redefine.
35 \let\ptextilde=\~
36 \let\ptexlbrace=\{
37 \let\ptexrbrace=\}
38 \let\ptexdots=\dots
39 \let\ptexdot=\.
40 \let\ptexstar=\*
41 \let\ptexend=\end
42 \let\ptexbullet=\bullet
43 \let\ptexb=\b
44 \let\ptexc=\c
45 \let\ptexi=\i
46 \let\ptext=\t
47 \let\ptexl=\l
48 \let\ptexL=\L
50 % Be sure we're in horizontal mode when doing a tie, since we make space
51 % equivalent to this in @example-like environments. Otherwise, a space
52 % at the beginning of a line will start with \penalty -- and
53 % since \penalty is valid in vertical mode, we'd end up putting the
54 % penalty on the vertical list instead of in the new paragraph.
55 {\catcode`@ = 11
56 \gdef\tie{\leavevmode\penalty\@M\ }
58 \let\~ = \tie % And make it available as @~.
60 \message{Basics,}
61 \chardef\other=12
63 % If this character appears in an error message or help string, it
64 % starts a new line in the output.
65 \newlinechar = `^^J
67 % Set up fixed words for English.
68 \ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter}}\fi%
69 \def\putwordInfo{Info}%
70 \ifx\putwordSee\undefined{\gdef\putwordSee{See}}\fi%
71 \ifx\putwordsee\undefined{\gdef\putwordsee{see}}\fi%
72 \ifx\putwordfile\undefined{\gdef\putwordfile{file}}\fi%
73 \ifx\putwordpage\undefined{\gdef\putwordpage{page}}\fi%
74 \ifx\putwordsection\undefined{\gdef\putwordsection{section}}\fi%
75 \ifx\putwordSection\undefined{\gdef\putwordSection{Section}}\fi%
76 \ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents}}\fi%
77 \ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents}}\fi%
78 \ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix}}\fi%
80 % Ignore a token.
82 \def\gobble#1{}
84 \hyphenation{ap-pen-dix}
85 \hyphenation{mini-buf-fer mini-buf-fers}
86 \hyphenation{eshell}
88 % Margin to add to right of even pages, to left of odd pages.
89 \newdimen \bindingoffset \bindingoffset=0pt
90 \newdimen \normaloffset \normaloffset=\hoffset
91 \newdimen\pagewidth \newdimen\pageheight
92 \pagewidth=\hsize \pageheight=\vsize
94 % Sometimes it is convenient to have everything in the transcript file
95 % and nothing on the terminal. We don't just call \tracingall here,
96 % since that produces some useless output on the terminal.
98 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
99 \def\loggingall{\tracingcommands2 \tracingstats2
100 \tracingpages1 \tracingoutput1 \tracinglostchars1
101 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
102 \showboxbreadth\maxdimen\showboxdepth\maxdimen
105 %---------------------Begin change-----------------------
107 %%%% For @cropmarks command.
108 % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
110 \newdimen\cornerlong \newdimen\cornerthick
111 \newdimen \topandbottommargin
112 \newdimen \outerhsize \newdimen \outervsize
113 \cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
114 \outerhsize=7in
115 %\outervsize=9.5in
116 % Alternative @smallbook page size is 9.25in
117 \outervsize=9.25in
118 \topandbottommargin=.75in
120 %---------------------End change-----------------------
122 % \onepageout takes a vbox as an argument. Note that \pagecontents
123 % does insertions itself, but you have to call it yourself.
124 \chardef\PAGE=255 \output={\onepageout{\pagecontents\PAGE}}
125 \def\onepageout#1{\hoffset=\normaloffset
126 \ifodd\pageno \advance\hoffset by \bindingoffset
127 \else \advance\hoffset by -\bindingoffset\fi
128 {\escapechar=`\\\relax % makes sure backslash is used in output files.
129 \shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
130 {\let\hsize=\pagewidth \makefootline}}}%
131 \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
133 %%%% For @cropmarks command %%%%
135 % Here is a modification of the main output routine for Near East Publications
136 % This provides right-angle cropmarks at all four corners.
137 % The contents of the page are centerlined into the cropmarks,
138 % and any desired binding offset is added as an \hskip on either
139 % site of the centerlined box. (P. A. MacKay, 12 November, 1986)
141 \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
142 {\escapechar=`\\\relax % makes sure backslash is used in output files.
143 \shipout
144 \vbox to \outervsize{\hsize=\outerhsize
145 \vbox{\line{\ewtop\hfill\ewtop}}
146 \nointerlineskip
147 \line{\vbox{\moveleft\cornerthick\nstop}
148 \hfill
149 \vbox{\moveright\cornerthick\nstop}}
150 \vskip \topandbottommargin
151 \centerline{\ifodd\pageno\hskip\bindingoffset\fi
152 \vbox{
153 {\let\hsize=\pagewidth \makeheadline}
154 \pagebody{#1}
155 {\let\hsize=\pagewidth \makefootline}}
156 \ifodd\pageno\else\hskip\bindingoffset\fi}
157 \vskip \topandbottommargin plus1fill minus1fill
158 \boxmaxdepth\cornerthick
159 \line{\vbox{\moveleft\cornerthick\nsbot}
160 \hfill
161 \vbox{\moveright\cornerthick\nsbot}}
162 \nointerlineskip
163 \vbox{\line{\ewbot\hfill\ewbot}}
165 \advancepageno
166 \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
168 % Do @cropmarks to get crop marks
169 \def\cropmarks{\let\onepageout=\croppageout }
171 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
172 {\catcode`\@ =11
173 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
174 \dimen@=\dp#1 \unvbox#1
175 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
176 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
180 % Here are the rules for the cropmarks. Note that they are
181 % offset so that the space between them is truly \outerhsize or \outervsize
182 % (P. A. MacKay, 12 November, 1986)
184 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
185 \def\nstop{\vbox
186 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
187 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
188 \def\nsbot{\vbox
189 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
191 % Parse an argument, then pass it to #1. The argument is the rest of
192 % the input line (except we remove a trailing comment). #1 should be a
193 % macro which expects an ordinary undelimited TeX argument.
195 \def\parsearg#1{%
196 \let\next = #1%
197 \begingroup
198 \obeylines
199 \futurelet\temp\parseargx
202 % If the next token is an obeyed space (from an @example environment or
203 % the like), remove it and recurse. Otherwise, we're done.
204 \def\parseargx{%
205 % \obeyedspace is defined far below, after the definition of \sepspaces.
206 \ifx\obeyedspace\temp
207 \expandafter\parseargdiscardspace
208 \else
209 \expandafter\parseargline
213 % Remove a single space (as the delimiter token to the macro call).
214 {\obeyspaces %
215 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
217 {\obeylines %
218 \gdef\parseargline#1^^M{%
219 \endgroup % End of the group started in \parsearg.
221 % First remove any @c comment, then any @comment.
222 % Result of each macro is put in \toks0.
223 \argremovec #1\c\relax %
224 \expandafter\argremovecomment \the\toks0 \comment\relax %
226 % Call the caller's macro, saved as \next in \parsearg.
227 \expandafter\next\expandafter{\the\toks0}%
231 % Since all \c{,omment} does is throw away the argument, we can let TeX
232 % do that for us. The \relax here is matched by the \relax in the call
233 % in \parseargline; it could be more or less anything, its purpose is
234 % just to delimit the argument to the \c.
235 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
236 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
238 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
239 % @end itemize @c foo
240 % will have two active spaces as part of the argument with the
241 % `itemize'. Here we remove all active spaces from #1, and assign the
242 % result to \toks0.
244 % This loses if there are any *other* active characters besides spaces
245 % in the argument -- _ ^ +, for example -- since they get expanded.
246 % Fortunately, Texinfo does not define any such commands. (If it ever
247 % does, the catcode of the characters in questionwill have to be changed
248 % here.) But this means we cannot call \removeactivespaces as part of
249 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
250 % that \parsearg gets might well have any character at all in it.
252 \def\removeactivespaces#1{%
253 \begingroup
254 \ignoreactivespaces
255 \edef\temp{#1}%
256 \global\toks0 = \expandafter{\temp}%
257 \endgroup
260 % Change the active space to expand to nothing.
262 \begingroup
263 \obeyspaces
264 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
265 \endgroup
268 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
270 %% These are used to keep @begin/@end levels from running away
271 %% Call \inENV within environments (after a \begingroup)
272 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
273 \def\ENVcheck{%
274 \ifENV\errmessage{Still within an environment. Type Return to continue.}
275 \endgroup\fi} % This is not perfect, but it should reduce lossage
277 % @begin foo is the same as @foo, for now.
278 \newhelp\EMsimple{Type <Return> to continue.}
280 \outer\def\begin{\parsearg\beginxxx}
282 \def\beginxxx #1{%
283 \expandafter\ifx\csname #1\endcsname\relax
284 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
285 \csname #1\endcsname\fi}
287 % @end foo executes the definition of \Efoo.
289 \def\end{\parsearg\endxxx}
290 \def\endxxx #1{%
291 \removeactivespaces{#1}%
292 \edef\endthing{\the\toks0}%
294 \expandafter\ifx\csname E\endthing\endcsname\relax
295 \expandafter\ifx\csname \endthing\endcsname\relax
296 % There's no \foo, i.e., no ``environment'' foo.
297 \errhelp = \EMsimple
298 \errmessage{Undefined command `@end \endthing'}%
299 \else
300 \unmatchedenderror\endthing
302 \else
303 % Everything's ok; the right environment has been started.
304 \csname E\endthing\endcsname
308 % There is an environment #1, but it hasn't been started. Give an error.
310 \def\unmatchedenderror#1{%
311 \errhelp = \EMsimple
312 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
315 % Define the control sequence \E#1 to give an unmatched @end error.
317 \def\defineunmatchedend#1{%
318 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
322 % Single-spacing is done by various environments (specifically, in
323 % \nonfillstart and \quotations).
324 \newskip\singlespaceskip \singlespaceskip = 12.5pt
325 \def\singlespace{%
326 % Why was this kern here? It messes up equalizing space above and below
327 % environments. --karl, 6may93
328 %{\advance \baselineskip by -\singlespaceskip
329 %\kern \baselineskip}%
330 \setleading \singlespaceskip
333 %% Simple single-character @ commands
335 % @@ prints an @
336 % Kludge this until the fonts are right (grr).
337 \def\@{{\tt \char '100}}
339 % This is turned off because it was never documented
340 % and you can use @w{...} around a quote to suppress ligatures.
341 %% Define @` and @' to be the same as ` and '
342 %% but suppressing ligatures.
343 %\def\`{{`}}
344 %\def\'{{'}}
346 % Used to generate quoted braces.
348 \def\mylbrace {{\tt \char '173}}
349 \def\myrbrace {{\tt \char '175}}
350 \let\{=\mylbrace
351 \let\}=\myrbrace
353 % @: forces normal size whitespace following.
354 \def\:{\spacefactor=1000 }
356 % @* forces a line break.
357 \def\*{\hfil\break\hbox{}\ignorespaces}
359 % @. is an end-of-sentence period.
360 \def\.{.\spacefactor=3000 }
362 % @enddots{} is an end-of-sentence ellipsis.
363 \gdef\enddots{$\mathinner{\ldotp\ldotp\ldotp\ldotp}$\spacefactor=3000}
365 % @! is an end-of-sentence bang.
366 \gdef\!{!\spacefactor=3000 }
368 % @? is an end-of-sentence query.
369 \gdef\?{?\spacefactor=3000 }
371 % @w prevents a word break. Without the \leavevmode, @w at the
372 % beginning of a paragraph, when TeX is still in vertical mode, would
373 % produce a whole line of output instead of starting the paragraph.
374 \def\w#1{\leavevmode\hbox{#1}}
376 % @group ... @end group forces ... to be all on one page, by enclosing
377 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
378 % to keep its height that of a normal line. According to the rules for
379 % \topskip (p.114 of the TeXbook), the glue inserted is
380 % max (\topskip - \ht (first item), 0). If that height is large,
381 % therefore, no glue is inserted, and the space between the headline and
382 % the text is small, which looks bad.
384 \def\group{\begingroup
385 \ifnum\catcode13=\active \else
386 \errhelp = \groupinvalidhelp
387 \errmessage{@group invalid in context where filling is enabled}%
390 % The \vtop we start below produces a box with normal height and large
391 % depth; thus, TeX puts \baselineskip glue before it, and (when the
392 % next line of text is done) \lineskip glue after it. (See p.82 of
393 % the TeXbook.) Thus, space below is not quite equal to space
394 % above. But it's pretty close.
395 \def\Egroup{%
396 \egroup % End the \vtop.
397 \endgroup % End the \group.
400 \vtop\bgroup
401 % We have to put a strut on the last line in case the @group is in
402 % the midst of an example, rather than completely enclosing it.
403 % Otherwise, the interline space between the last line of the group
404 % and the first line afterwards is too small. But we can't put the
405 % strut in \Egroup, since there it would be on a line by itself.
406 % Hence this just inserts a strut at the beginning of each line.
407 \everypar = {\strut}%
409 % Since we have a strut on every line, we don't need any of TeX's
410 % normal interline spacing.
411 \offinterlineskip
413 % OK, but now we have to do something about blank
414 % lines in the input in @example-like environments, which normally
415 % just turn into \lisppar, which will insert no space now that we've
416 % turned off the interline space. Simplest is to make them be an
417 % empty paragraph.
418 \ifx\par\lisppar
419 \edef\par{\leavevmode \par}%
421 % Reset ^^M's definition to new definition of \par.
422 \obeylines
425 % Do @comment since we are called inside an environment such as
426 % @example, where each end-of-line in the input causes an
427 % end-of-line in the output. We don't want the end-of-line after
428 % the `@group' to put extra space in the output. Since @group
429 % should appear on a line by itself (according to the Texinfo
430 % manual), we don't worry about eating any user text.
431 \comment
434 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
435 % message, so this ends up printing `@group can only ...'.
437 \newhelp\groupinvalidhelp{%
438 group can only be used in environments such as @example,^^J%
439 where each line of input produces a line of output.}
441 % @need space-in-mils
442 % forces a page break if there is not space-in-mils remaining.
444 \newdimen\mil \mil=0.001in
446 \def\need{\parsearg\needx}
448 % Old definition--didn't work.
449 %\def\needx #1{\par %
450 %% This method tries to make TeX break the page naturally
451 %% if the depth of the box does not fit.
452 %{\baselineskip=0pt%
453 %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
454 %\prevdepth=-1000pt
457 \def\needx#1{%
458 % Go into vertical mode, so we don't make a big box in the middle of a
459 % paragraph.
460 \par
462 % Don't add any leading before our big empty box, but allow a page
463 % break, since the best break might be right here.
464 \allowbreak
465 \nointerlineskip
466 \vtop to #1\mil{\vfil}%
468 % TeX does not even consider page breaks if a penalty added to the
469 % main vertical list is 10000 or more. But in order to see if the
470 % empty box we just added fits on the page, we must make it consider
471 % page breaks. On the other hand, we don't want to actually break the
472 % page after the empty box. So we use a penalty of 9999.
474 % There is an extremely small chance that TeX will actually break the
475 % page at this \penalty, if there are no other feasible breakpoints in
476 % sight. (If the user is using lots of big @group commands, which
477 % almost-but-not-quite fill up a page, TeX will have a hard time doing
478 % good page breaking, for example.) However, I could not construct an
479 % example where a page broke at this \penalty; if it happens in a real
480 % document, then we can reconsider our strategy.
481 \penalty9999
483 % Back up by the size of the box, whether we did a page break or not.
484 \kern -#1\mil
486 % Do not allow a page break right after this kern.
487 \nobreak
490 % @br forces paragraph break
492 \let\br = \par
494 % @dots{} output some dots
496 \def\dots{$\ldots$}
498 % @page forces the start of a new page
500 \def\page{\par\vfill\supereject}
502 % @exdent text....
503 % outputs text on separate line in roman font, starting at standard page margin
505 % This records the amount of indent in the innermost environment.
506 % That's how much \exdent should take out.
507 \newskip\exdentamount
509 % This defn is used inside fill environments such as @defun.
510 \def\exdent{\parsearg\exdentyyy}
511 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
513 % This defn is used inside nofill environments such as @example.
514 \def\nofillexdent{\parsearg\nofillexdentyyy}
515 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
516 \leftline{\hskip\leftskip{\rm#1}}}}
518 %\hbox{{\rm#1}}\hfil\break}}
520 % @include file insert text of that file as input.
522 \def\include{\parsearg\includezzz}
523 %Use \input\thisfile to avoid blank after \input, which may be an active
524 %char (in which case the blank would become the \input argument).
525 %The grouping keeps the value of \thisfile correct even when @include
526 %is nested.
527 \def\includezzz #1{\begingroup
528 \def\thisfile{#1}\input\thisfile
529 \endgroup}
531 \def\thisfile{}
533 % @center line outputs that line, centered
535 \def\center{\parsearg\centerzzz}
536 \def\centerzzz #1{{\advance\hsize by -\leftskip
537 \advance\hsize by -\rightskip
538 \centerline{#1}}}
540 % @sp n outputs n lines of vertical space
542 \def\sp{\parsearg\spxxx}
543 \def\spxxx #1{\par \vskip #1\baselineskip}
545 % @comment ...line which is ignored...
546 % @c is the same as @comment
547 % @ignore ... @end ignore is another way to write a comment
549 \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
550 \parsearg \commentxxx}
552 \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
554 \let\c=\comment
556 % Prevent errors for section commands.
557 % Used in @ignore and in failing conditionals.
558 \def\ignoresections{%
559 \let\chapter=\relax
560 \let\unnumbered=\relax
561 \let\top=\relax
562 \let\unnumberedsec=\relax
563 \let\unnumberedsection=\relax
564 \let\unnumberedsubsec=\relax
565 \let\unnumberedsubsection=\relax
566 \let\unnumberedsubsubsec=\relax
567 \let\unnumberedsubsubsection=\relax
568 \let\section=\relax
569 \let\subsec=\relax
570 \let\subsubsec=\relax
571 \let\subsection=\relax
572 \let\subsubsection=\relax
573 \let\appendix=\relax
574 \let\appendixsec=\relax
575 \let\appendixsection=\relax
576 \let\appendixsubsec=\relax
577 \let\appendixsubsection=\relax
578 \let\appendixsubsubsec=\relax
579 \let\appendixsubsubsection=\relax
580 \let\contents=\relax
581 \let\smallbook=\relax
582 \let\titlepage=\relax
585 % Used in nested conditionals, where we have to parse the Texinfo source
586 % and so want to turn off most commands, in case they are used
587 % incorrectly.
589 \def\ignoremorecommands{%
590 \let\defcv = \relax
591 \let\deffn = \relax
592 \let\deffnx = \relax
593 \let\defindex = \relax
594 \let\defivar = \relax
595 \let\defmac = \relax
596 \let\defmethod = \relax
597 \let\defop = \relax
598 \let\defopt = \relax
599 \let\defspec = \relax
600 \let\deftp = \relax
601 \let\deftypefn = \relax
602 \let\deftypefun = \relax
603 \let\deftypevar = \relax
604 \let\deftypevr = \relax
605 \let\defun = \relax
606 \let\defvar = \relax
607 \let\defvr = \relax
608 \let\ref = \relax
609 \let\xref = \relax
610 \let\printindex = \relax
611 \let\pxref = \relax
612 \let\settitle = \relax
613 \let\include = \relax
614 \let\lowersections = \relax
615 \let\down = \relax
616 \let\raisesections = \relax
617 \let\up = \relax
618 \let\set = \relax
619 \let\clear = \relax
620 \let\item = \relax
621 \let\message = \relax
624 % Ignore @ignore ... @end ignore.
626 \def\ignore{\doignore{ignore}}
628 % Also ignore @ifinfo, @ifhtml, @html, @menu, and @direntry text.
630 \def\ifinfo{\doignore{ifinfo}}
631 \def\ifhtml{\doignore{ifhtml}}
632 \def\html{\doignore{html}}
633 \def\menu{\doignore{menu}}
634 \def\direntry{\doignore{direntry}}
636 % Ignore text until a line `@end #1'.
638 \def\doignore#1{\begingroup
639 % Don't complain about control sequences we have declared \outer.
640 \ignoresections
642 % Define a command to swallow text until we reach `@end #1'.
643 \long\def\doignoretext##1\end #1{\enddoignore}%
645 % Make sure that spaces turn into tokens that match what \doignoretext wants.
646 \catcode32 = 10
648 % And now expand that command.
649 \doignoretext
652 % What we do to finish off ignored text.
654 \def\enddoignore{\endgroup\ignorespaces}%
656 \newif\ifwarnedobs\warnedobsfalse
657 \def\obstexwarn{%
658 \ifwarnedobs\relax\else
659 % We need to warn folks that they may have trouble with TeX 3.0.
660 % This uses \immediate\write16 rather than \message to get newlines.
661 \immediate\write16{}
662 \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
663 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
664 \immediate\write16{If you are running another version of TeX, relax.}
665 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
666 \immediate\write16{ Then upgrade your TeX installation if you can.}
667 \immediate\write16{If you are stuck with version 3.0, run the}
668 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
669 \immediate\write16{ to use a workaround.}
670 \immediate\write16{}
671 \warnedobstrue
675 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
676 % workaround (which requires the file ``dummy.tfm'' to be installed),
677 % uncomment the following line:
678 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
680 % Ignore text, except that we keep track of conditional commands for
681 % purposes of nesting, up to an `@end #1' command.
683 \def\nestedignore#1{%
684 \obstexwarn
685 % We must actually expand the ignored text to look for the @end
686 % command, so that nested ignore constructs work. Thus, we put the
687 % text into a \vbox and then do nothing with the result. To minimize
688 % the change of memory overflow, we follow the approach outlined on
689 % page 401 of the TeXbook: make the current font be a dummy font.
691 \setbox0 = \vbox\bgroup
692 % Don't complain about control sequences we have declared \outer.
693 \ignoresections
695 % Define `@end #1' to end the box, which will in turn undefine the
696 % @end command again.
697 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
699 % We are going to be parsing Texinfo commands. Most cause no
700 % trouble when they are used incorrectly, but some commands do
701 % complicated argument parsing or otherwise get confused, so we
702 % undefine them.
704 % We can't do anything about stray @-signs, unfortunately;
705 % they'll produce `undefined control sequence' errors.
706 \ignoremorecommands
708 % Set the current font to be \nullfont, a TeX primitive, and define
709 % all the font commands to also use \nullfont. We don't use
710 % dummy.tfm, as suggested in the TeXbook, because not all sites
711 % might have that installed. Therefore, math mode will still
712 % produce output, but that should be an extremely small amount of
713 % stuff compared to the main input.
715 \nullfont
716 \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
717 \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
718 \let\tensf = \nullfont
719 % Similarly for index fonts (mostly for their use in
720 % smallexample)
721 \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
722 \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
723 \let\indsf = \nullfont
725 % Don't complain when characters are missing from the fonts.
726 \tracinglostchars = 0
728 % Don't bother to do space factor calculations.
729 \frenchspacing
731 % Don't report underfull hboxes.
732 \hbadness = 10000
734 % Do minimal line-breaking.
735 \pretolerance = 10000
737 % Do not execute instructions in @tex
738 \def\tex{\doignore{tex}}
741 % @set VAR sets the variable VAR to an empty value.
742 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
744 % Since we want to separate VAR from REST-OF-LINE (which might be
745 % empty), we can't just use \parsearg; we have to insert a space of our
746 % own to delimit the rest of the line, and then take it out again if we
747 % didn't need it.
749 \def\set{\parsearg\setxxx}
750 \def\setxxx#1{\setyyy#1 \endsetyyy}
751 \def\setyyy#1 #2\endsetyyy{%
752 \def\temp{#2}%
753 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
754 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
757 \def\setzzz#1#2 \endsetzzz{\expandafter\xdef\csname SET#1\endcsname{#2}}
759 % @clear VAR clears (i.e., unsets) the variable VAR.
761 \def\clear{\parsearg\clearxxx}
762 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
764 % @value{foo} gets the text saved in variable foo.
766 \def\value#1{\expandafter
767 \ifx\csname SET#1\endcsname\relax
768 {\{No value for ``#1''\}}
769 \else \csname SET#1\endcsname \fi}
771 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
772 % with @set.
774 \def\ifset{\parsearg\ifsetxxx}
775 \def\ifsetxxx #1{%
776 \expandafter\ifx\csname SET#1\endcsname\relax
777 \expandafter\ifsetfail
778 \else
779 \expandafter\ifsetsucceed
782 \def\ifsetsucceed{\conditionalsucceed{ifset}}
783 \def\ifsetfail{\nestedignore{ifset}}
784 \defineunmatchedend{ifset}
786 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
787 % defined with @set, or has been undefined with @clear.
789 \def\ifclear{\parsearg\ifclearxxx}
790 \def\ifclearxxx #1{%
791 \expandafter\ifx\csname SET#1\endcsname\relax
792 \expandafter\ifclearsucceed
793 \else
794 \expandafter\ifclearfail
797 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
798 \def\ifclearfail{\nestedignore{ifclear}}
799 \defineunmatchedend{ifclear}
801 % @iftex always succeeds; we read the text following, through @end
802 % iftex). But `@end iftex' should be valid only after an @iftex.
804 \def\iftex{\conditionalsucceed{iftex}}
805 \defineunmatchedend{iftex}
807 % We can't just want to start a group at @iftex (for example) and end it
808 % at @end iftex, since then @set commands inside the conditional have no
809 % effect (they'd get reverted at the end of the group). So we must
810 % define \Eiftex to redefine itself to be its previous value. (We can't
811 % just define it to fail again with an ``unmatched end'' error, since
812 % the @ifset might be nested.)
814 \def\conditionalsucceed#1{%
815 \edef\temp{%
816 % Remember the current value of \E#1.
817 \let\nece{prevE#1} = \nece{E#1}%
819 % At the `@end #1', redefine \E#1 to be its previous value.
820 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
822 \temp
825 % We need to expand lots of \csname's, but we don't want to expand the
826 % control sequences after we've constructed them.
828 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
830 % @asis just yields its argument. Used with @table, for example.
832 \def\asis#1{#1}
834 % @math means output in math mode.
835 % We don't use $'s directly in the definition of \math because control
836 % sequences like \math are expanded when the toc file is written. Then,
837 % we read the toc file back, the $'s will be normal characters (as they
838 % should be, according to the definition of Texinfo). So we must use a
839 % control sequence to switch into and out of math mode.
841 % This isn't quite enough for @math to work properly in indices, but it
842 % seems unlikely it will ever be needed there.
844 \let\implicitmath = $
845 \def\math#1{\implicitmath #1\implicitmath}
847 % @bullet and @minus need the same treatment as @math, just above.
848 \def\bullet{\implicitmath\ptexbullet\implicitmath}
849 \def\minus{\implicitmath-\implicitmath}
851 \def\node{\ENVcheck\parsearg\nodezzz}
852 \def\nodezzz#1{\nodexxx [#1,]}
853 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
854 \let\nwnode=\node
855 \let\lastnode=\relax
857 \def\donoderef{\ifx\lastnode\relax\else
858 \expandafter\expandafter\expandafter\setref{\lastnode}\fi
859 \global\let\lastnode=\relax}
861 \def\unnumbnoderef{\ifx\lastnode\relax\else
862 \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
863 \global\let\lastnode=\relax}
865 \def\appendixnoderef{\ifx\lastnode\relax\else
866 \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
867 \global\let\lastnode=\relax}
869 \let\refill=\relax
871 % @setfilename is done at the beginning of every texinfo file.
872 % So open here the files we need to have open while reading the input.
873 % This makes it possible to make a .fmt file for texinfo.
874 \def\setfilename{%
875 \readauxfile
876 \opencontents
877 \openindices
878 \fixbackslash % Turn off hack to swallow `\input texinfo'.
879 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
880 \comment % Ignore the actual filename.
883 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
885 \def\inforef #1{\inforefzzz #1,,,,**}
886 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
887 node \samp{\ignorespaces#1{}}}
889 \message{fonts,}
891 % Font-change commands.
893 % Texinfo supports the sans serif font style, which plain TeX does not.
894 % So we set up a \sf analogous to plain's \rm, etc.
895 \newfam\sffam
896 \def\sf{\fam=\sffam \tensf}
897 \let\li = \sf % Sometimes we call it \li, not \sf.
899 %% Try out Computer Modern fonts at \magstephalf
900 \let\mainmagstep=\magstephalf
902 % Set the font macro #1 to the font named #2, adding on the
903 % specified font prefix (normally `cm').
904 \def\fontprefix{cm}
905 \def\setfont#1#2{\font#1=\fontprefix#2}
907 % Enter `@setfontprefix dc' to use the dc fonts instead of the cm fonts.
908 \def\setfontprefix{\parsearg\\setfontprefixzzz}
909 \def\setfontprefixzzz#1{\gdef\fontprefix{#1}}
911 \ifx\bigger\relax
912 \let\mainmagstep=\magstep1
913 \setfont\textrm{r12}
914 \setfont\texttt{tt12}
915 \else
916 \setfont\textrm{r10 scaled \mainmagstep}
917 \setfont\texttt{tt10 scaled \mainmagstep}
919 % Instead of cmb10, you many want to use cmbx10.
920 % cmbx10 is a prettier font on its own, but cmb10
921 % looks better when embedded in a line with cmr10.
922 \setfont\textbf{b10 scaled \mainmagstep}
923 \setfont\textit{ti10 scaled \mainmagstep}
924 \setfont\textsl{sl10 scaled \mainmagstep}
925 \setfont\textsf{ss10 scaled \mainmagstep}
926 \setfont\textsc{csc10 scaled \mainmagstep}
927 \setfont\texti{mi10 scaled \mainmagstep}
928 \setfont\textsy{sy10 scaled \mainmagstep}
930 % A few fonts for @defun, etc.
931 \setfont\defbf{bx10 scaled \magstep1} %was 1314
932 \setfont\deftt{tt10 scaled \magstep1}
933 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
935 % Fonts for indices and small examples.
936 % We actually use the slanted font rather than the italic,
937 % because texinfo normally uses the slanted fonts for that.
938 % Do not make many font distinctions in general in the index, since they
939 % aren't very useful.
940 \setfont\ninett{tt9}
941 \setfont\indrm{r9}
942 \setfont\indit{sl9}
943 \let\indsl=\indit
944 \let\indtt=\ninett
945 \let\indsf=\indrm
946 \let\indbf=\indrm
947 \let\indsc=\indrm
948 \setfont\indi{mi9}
949 \setfont\indsy{sy9}
951 % Fonts for headings
952 \setfont\chaprm{bx12 scaled \magstep2}
953 \setfont\chapit{ti12 scaled \magstep2}
954 \setfont\chapsl{sl12 scaled \magstep2}
955 \setfont\chaptt{tt12 scaled \magstep2}
956 \setfont\chapsf{ss12 scaled \magstep2}
957 \let\chapbf=\chaprm
958 \setfont\chapsc{csc10 scaled\magstep3}
959 \setfont\chapi{mi12 scaled \magstep2}
960 \setfont\chapsy{sy10 scaled \magstep3}
962 \setfont\secrm{bx12 scaled \magstep1}
963 \setfont\secit{ti12 scaled \magstep1}
964 \setfont\secsl{sl12 scaled \magstep1}
965 \setfont\sectt{tt12 scaled \magstep1}
966 \setfont\secsf{ss12 scaled \magstep1}
967 \setfont\secbf{bx12 scaled \magstep1}
968 \setfont\secsc{csc10 scaled\magstep2}
969 \setfont\seci{mi12 scaled \magstep1}
970 \setfont\secsy{sy10 scaled \magstep2}
972 % \setfont\ssecrm{bx10 scaled \magstep1} % This size an font looked bad.
973 % \setfont\ssecit{cmti10 scaled \magstep1} % The letters were too crowded.
974 % \setfont\ssecsl{sl10 scaled \magstep1}
975 % \setfont\ssectt{tt10 scaled \magstep1}
976 % \setfont\ssecsf{ss10 scaled \magstep1}
978 %\setfont\ssecrm{b10 scaled 1315} % Note the use of cmb rather than cmbx.
979 %\setfont\ssecit{ti10 scaled 1315} % Also, the size is a little larger than
980 %\setfont\ssecsl{sl10 scaled 1315} % being scaled magstep1.
981 %\setfont\ssectt{tt10 scaled 1315}
982 %\setfont\ssecsf{ss10 scaled 1315}
984 %\let\ssecbf=\ssecrm
986 \setfont\ssecrm{bx12 scaled \magstephalf}
987 \setfont\ssecit{ti12 scaled \magstephalf}
988 \setfont\ssecsl{sl12 scaled \magstephalf}
989 \setfont\ssectt{tt12 scaled \magstephalf}
990 \setfont\ssecsf{ss12 scaled \magstephalf}
991 \setfont\ssecbf{bx12 scaled \magstephalf}
992 \setfont\ssecsc{csc10 scaled \magstep1}
993 \setfont\sseci{mi12 scaled \magstephalf}
994 \setfont\ssecsy{sy10 scaled \magstep1}
995 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
996 % but that is not a standard magnification.
998 % Fonts for title page:
999 \setfont\titlerm{bx12 scaled \magstep3}
1000 \let\authorrm = \secrm
1002 % In order for the font changes to affect most math symbols and letters,
1003 % we have to define the \textfont of the standard families. Since
1004 % texinfo doesn't allow for producing subscripts and superscripts, we
1005 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1006 % also require loading a lot more fonts).
1008 \def\resetmathfonts{%
1009 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
1010 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
1011 \textfont\ttfam = \tentt \textfont\sffam = \tensf
1015 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1016 % of just \STYLE. We do this so that font changes will continue to work
1017 % in math mode, where it is the current \fam that is relevant in most
1018 % cases, not the current. Plain TeX does, for example,
1019 % \def\bf{\fam=\bffam \tenbf} By redefining \tenbf, we obviate the need
1020 % to redefine \bf itself.
1021 \def\textfonts{%
1022 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1023 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1024 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1025 \resetmathfonts}
1026 \def\chapfonts{%
1027 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1028 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1029 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1030 \resetmathfonts}
1031 \def\secfonts{%
1032 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1033 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1034 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1035 \resetmathfonts}
1036 \def\subsecfonts{%
1037 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1038 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1039 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1040 \resetmathfonts}
1041 \def\indexfonts{%
1042 \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
1043 \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
1044 \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy
1045 \resetmathfonts}
1047 % Set up the default fonts, so we can use them for creating boxes.
1049 \textfonts
1051 % Count depth in font-changes, for error checks
1052 \newcount\fontdepth \fontdepth=0
1054 % Fonts for short table of contents.
1055 \setfont\shortcontrm{r12}
1056 \setfont\shortcontbf{bx12}
1057 \setfont\shortcontsl{sl12}
1059 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1060 %% serif) and @ii for TeX italic
1062 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1063 % unless the following character is such as not to need one.
1064 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1065 \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1067 \let\i=\smartitalic
1068 \let\var=\smartitalic
1069 \let\dfn=\smartitalic
1070 \let\emph=\smartitalic
1071 \let\cite=\smartitalic
1073 \def\b#1{{\bf #1}}
1074 \let\strong=\b
1076 % We can't just use \exhyphenpenalty, because that only has effect at
1077 % the end of a paragraph. Restore normal hyphenation at the end of the
1078 % group within which \nohyphenation is presumably called.
1080 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1081 \def\restorehyphenation{\hyphenchar\font = `- }
1083 \def\t#1{%
1084 {\tt \nohyphenation \rawbackslash \frenchspacing #1}%
1085 \null
1087 \let\ttfont = \t
1088 %\def\samp #1{`{\tt \rawbackslash \frenchspacing #1}'\null}
1089 \def\samp #1{`\tclose{#1}'\null}
1090 \def\key #1{{\tt \nohyphenation \uppercase{#1}}\null}
1091 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1093 \let\file=\samp
1095 % @code is a modification of @t,
1096 % which makes spaces the same size as normal in the surrounding text.
1097 \def\tclose#1{%
1099 % Change normal interword space to be same as for the current font.
1100 \spaceskip = \fontdimen2\font
1102 % Switch to typewriter.
1105 % But `\ ' produces the large typewriter interword space.
1106 \def\ {{\spaceskip = 0pt{} }}%
1108 % Turn off hyphenation.
1109 \nohyphenation
1111 \rawbackslash
1112 \frenchspacing
1115 \null
1118 % We *must* turn on hyphenation at `-' and `_' in \code.
1119 % Otherwise, it is too hard to avoid overful hboxes
1120 % in the Emacs manual, the Library manual, etc.
1122 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1123 % both hyphenation at - and hyphenation within words.
1124 % We must therefore turn them both off (\tclose does that)
1125 % and arrange explicitly to hyphenate an a dash.
1126 % -- rms.
1128 \catcode`\-=\active
1129 \catcode`\_=\active
1130 \global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1131 % The following is used by \doprintindex to insure that long function names
1132 % wrap around. It is necessary for - and _ to be active before the index is
1133 % read from the file, as \entry parses the arguments long before \code is
1134 % ever called. -- mycroft
1135 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash \catcode`\_=\active \let_\realunder}
1137 \def\realdash{-}
1138 \def\realunder{_}
1139 \def\codedash{-\discretionary{}{}{}}
1140 \def\codeunder{\normalunderscore\discretionary{}{}{}}
1141 \def\codex #1{\tclose{#1}\endgroup}
1143 %\let\exp=\tclose %Was temporary
1145 % @kbd is like @code, except that if the argument is just one @key command,
1146 % then @kbd has no effect.
1148 \def\xkey{\key}
1149 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1150 \ifx\one\xkey\ifx\threex\three \key{#2}%
1151 \else\tclose{\look}\fi
1152 \else\tclose{\look}\fi}
1154 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1155 % argument is to make the input look right: @dmn{pt} instead of
1156 % @dmn{}pt.
1158 \def\dmn#1{\thinspace #1}
1160 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1162 \def\l#1{{\li #1}\null} %
1164 \def\r#1{{\rm #1}} % roman font
1165 % Use of \lowercase was suggested.
1166 \def\sc#1{{\smallcaps#1}} % smallcaps font
1167 \def\ii#1{{\it #1}} % italic font
1169 \message{page headings,}
1171 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1172 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1174 % First the title page. Must do @settitle before @titlepage.
1175 \def\titlefont#1{{\titlerm #1}}
1177 \newif\ifseenauthor
1178 \newif\iffinishedtitlepage
1180 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1181 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1182 \endgroup\page\hbox{}\page}
1184 \def\titlepage{\begingroup \parindent=0pt \textfonts
1185 \let\subtitlerm=\tenrm
1186 % I deinstalled the following change because \cmr12 is undefined.
1187 % This change was not in the ChangeLog anyway. --rms.
1188 % \let\subtitlerm=\cmr12
1189 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1191 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1193 % Leave some space at the very top of the page.
1194 \vglue\titlepagetopglue
1196 % Now you can print the title using @title.
1197 \def\title{\parsearg\titlezzz}%
1198 \def\titlezzz##1{\leftline{\titlefont{##1}}
1199 % print a rule at the page bottom also.
1200 \finishedtitlepagefalse
1201 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1202 % No rule at page bottom unless we print one at the top with @title.
1203 \finishedtitlepagetrue
1205 % Now you can put text using @subtitle.
1206 \def\subtitle{\parsearg\subtitlezzz}%
1207 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1209 % @author should come last, but may come many times.
1210 \def\author{\parsearg\authorzzz}%
1211 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1212 {\authorfont \leftline{##1}}}%
1214 % Most title ``pages'' are actually two pages long, with space
1215 % at the top of the second. We don't want the ragged left on the second.
1216 \let\oldpage = \page
1217 \def\page{%
1218 \iffinishedtitlepage\else
1219 \finishtitlepage
1221 \oldpage
1222 \let\page = \oldpage
1223 \hbox{}}%
1224 % \def\page{\oldpage \hbox{}}
1227 \def\Etitlepage{%
1228 \iffinishedtitlepage\else
1229 \finishtitlepage
1231 % It is important to do the page break before ending the group,
1232 % because the headline and footline are only empty inside the group.
1233 % If we use the new definition of \page, we always get a blank page
1234 % after the title page, which we certainly don't want.
1235 \oldpage
1236 \endgroup
1237 \HEADINGSon
1240 \def\finishtitlepage{%
1241 \vskip4pt \hrule height 2pt width \hsize
1242 \vskip\titlepagebottomglue
1243 \finishedtitlepagetrue
1246 %%% Set up page headings and footings.
1248 \let\thispage=\folio
1250 \newtoks \evenheadline % Token sequence for heading line of even pages
1251 \newtoks \oddheadline % Token sequence for heading line of odd pages
1252 \newtoks \evenfootline % Token sequence for footing line of even pages
1253 \newtoks \oddfootline % Token sequence for footing line of odd pages
1255 % Now make Tex use those variables
1256 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1257 \else \the\evenheadline \fi}}
1258 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1259 \else \the\evenfootline \fi}\HEADINGShook}
1260 \let\HEADINGShook=\relax
1262 % Commands to set those variables.
1263 % For example, this is what @headings on does
1264 % @evenheading @thistitle|@thispage|@thischapter
1265 % @oddheading @thischapter|@thispage|@thistitle
1266 % @evenfooting @thisfile||
1267 % @oddfooting ||@thisfile
1269 \def\evenheading{\parsearg\evenheadingxxx}
1270 \def\oddheading{\parsearg\oddheadingxxx}
1271 \def\everyheading{\parsearg\everyheadingxxx}
1273 \def\evenfooting{\parsearg\evenfootingxxx}
1274 \def\oddfooting{\parsearg\oddfootingxxx}
1275 \def\everyfooting{\parsearg\everyfootingxxx}
1277 {\catcode`\@=0 %
1279 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1280 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1281 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1283 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1284 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1285 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1287 \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
1288 \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
1289 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1290 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1292 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1293 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1294 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1296 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1297 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1298 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1300 \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
1301 \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
1302 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1303 \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1305 }% unbind the catcode of @.
1307 % @headings double turns headings on for double-sided printing.
1308 % @headings single turns headings on for single-sided printing.
1309 % @headings off turns them off.
1310 % @headings on same as @headings double, retained for compatibility.
1311 % @headings after turns on double-sided headings after this page.
1312 % @headings doubleafter turns on double-sided headings after this page.
1313 % @headings singleafter turns on single-sided headings after this page.
1314 % By default, they are off.
1316 \def\headings #1 {\csname HEADINGS#1\endcsname}
1318 \def\HEADINGSoff{
1319 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1320 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1321 \HEADINGSoff
1322 % When we turn headings on, set the page number to 1.
1323 % For double-sided printing, put current file name in lower left corner,
1324 % chapter name on inside top of right hand pages, document
1325 % title on inside top of left hand pages, and page numbers on outside top
1326 % edge of all pages.
1327 \def\HEADINGSdouble{
1328 %\pagealignmacro
1329 \global\pageno=1
1330 \global\evenfootline={\hfil}
1331 \global\oddfootline={\hfil}
1332 \global\evenheadline={\line{\folio\hfil\thistitle}}
1333 \global\oddheadline={\line{\thischapter\hfil\folio}}
1335 % For single-sided printing, chapter title goes across top left of page,
1336 % page number on top right.
1337 \def\HEADINGSsingle{
1338 %\pagealignmacro
1339 \global\pageno=1
1340 \global\evenfootline={\hfil}
1341 \global\oddfootline={\hfil}
1342 \global\evenheadline={\line{\thischapter\hfil\folio}}
1343 \global\oddheadline={\line{\thischapter\hfil\folio}}
1345 \def\HEADINGSon{\HEADINGSdouble}
1347 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1348 \let\HEADINGSdoubleafter=\HEADINGSafter
1349 \def\HEADINGSdoublex{%
1350 \global\evenfootline={\hfil}
1351 \global\oddfootline={\hfil}
1352 \global\evenheadline={\line{\folio\hfil\thistitle}}
1353 \global\oddheadline={\line{\thischapter\hfil\folio}}
1356 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1357 \def\HEADINGSsinglex{%
1358 \global\evenfootline={\hfil}
1359 \global\oddfootline={\hfil}
1360 \global\evenheadline={\line{\thischapter\hfil\folio}}
1361 \global\oddheadline={\line{\thischapter\hfil\folio}}
1364 % Subroutines used in generating headings
1365 % Produces Day Month Year style of output.
1366 \def\today{\number\day\space
1367 \ifcase\month\or
1368 January\or February\or March\or April\or May\or June\or
1369 July\or August\or September\or October\or November\or December\fi
1370 \space\number\year}
1372 % Use this if you want the Month Day, Year style of output.
1373 %\def\today{\ifcase\month\or
1374 %January\or February\or March\or April\or May\or June\or
1375 %July\or August\or September\or October\or November\or December\fi
1376 %\space\number\day, \number\year}
1378 % @settitle line... specifies the title of the document, for headings
1379 % It generates no output of its own
1381 \def\thistitle{No Title}
1382 \def\settitle{\parsearg\settitlezzz}
1383 \def\settitlezzz #1{\gdef\thistitle{#1}}
1385 \message{tables,}
1387 % @tabs -- simple alignment
1389 % These don't work. For one thing, \+ is defined as outer.
1390 % So these macros cannot even be defined.
1392 %\def\tabs{\parsearg\tabszzz}
1393 %\def\tabszzz #1{\settabs\+#1\cr}
1394 %\def\tabline{\parsearg\tablinezzz}
1395 %\def\tablinezzz #1{\+#1\cr}
1396 %\def\&{&}
1398 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1400 % default indentation of table text
1401 \newdimen\tableindent \tableindent=.8in
1402 % default indentation of @itemize and @enumerate text
1403 \newdimen\itemindent \itemindent=.3in
1404 % margin between end of table item and start of table text.
1405 \newdimen\itemmargin \itemmargin=.1in
1407 % used internally for \itemindent minus \itemmargin
1408 \newdimen\itemmax
1410 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1411 % these defs.
1412 % They also define \itemindex
1413 % to index the item name in whatever manner is desired (perhaps none).
1415 \newif\ifitemxneedsnegativevskip
1417 \def\itemxpar{\par\ifitemxneedsnegativevskip\vskip-\parskip\nobreak\fi}
1419 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1420 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1422 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1423 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1425 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1426 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1428 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1429 \itemzzz {#1}}
1431 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1432 \itemzzz {#1}}
1434 \def\itemzzz #1{\begingroup %
1435 \advance\hsize by -\rightskip
1436 \advance\hsize by -\tableindent
1437 \setbox0=\hbox{\itemfont{#1}}%
1438 \itemindex{#1}%
1439 \nobreak % This prevents a break before @itemx.
1441 % Be sure we are not still in the middle of a paragraph.
1442 %{\parskip = 0in
1443 %\par
1446 % If the item text does not fit in the space we have, put it on a line
1447 % by itself, and do not allow a page break either before or after that
1448 % line. We do not start a paragraph here because then if the next
1449 % command is, e.g., @kindex, the whatsit would get put into the
1450 % horizontal list on a line by itself, resulting in extra blank space.
1451 \ifdim \wd0>\itemmax
1453 % Make this a paragraph so we get the \parskip glue and wrapping,
1454 % but leave it ragged-right.
1455 \begingroup
1456 \advance\leftskip by-\tableindent
1457 \advance\hsize by\tableindent
1458 \advance\rightskip by0pt plus1fil
1459 \leavevmode\unhbox0\par
1460 \endgroup
1462 % We're going to be starting a paragraph, but we don't want the
1463 % \parskip glue -- logically it's part of the @item we just started.
1464 \nobreak \vskip-\parskip
1466 % Stop a page break at the \parskip glue coming up. Unfortunately
1467 % we can't prevent a possible page break at the following
1468 % \baselineskip glue.
1469 \nobreak
1470 \endgroup
1471 \itemxneedsnegativevskipfalse
1472 \else
1473 % The item text fits into the space. Start a paragraph, so that the
1474 % following text (if any) will end up on the same line. Since that
1475 % text will be indented by \tableindent, we make the item text be in
1476 % a zero-width box.
1477 \noindent
1478 \rlap{\hskip -\tableindent\box0}\ignorespaces%
1479 \endgroup%
1480 \itemxneedsnegativevskiptrue%
1484 \def\item{\errmessage{@item while not in a table}}
1485 \def\itemx{\errmessage{@itemx while not in a table}}
1486 \def\kitem{\errmessage{@kitem while not in a table}}
1487 \def\kitemx{\errmessage{@kitemx while not in a table}}
1488 \def\xitem{\errmessage{@xitem while not in a table}}
1489 \def\xitemx{\errmessage{@xitemx while not in a table}}
1491 %% Contains a kludge to get @end[description] to work
1492 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1494 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1495 {\obeylines\obeyspaces%
1496 \gdef\tablex #1^^M{%
1497 \tabley\dontindex#1 \endtabley}}
1499 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1500 {\obeylines\obeyspaces%
1501 \gdef\ftablex #1^^M{%
1502 \tabley\fnitemindex#1 \endtabley
1503 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1504 \let\Etable=\relax}}
1506 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1507 {\obeylines\obeyspaces%
1508 \gdef\vtablex #1^^M{%
1509 \tabley\vritemindex#1 \endtabley
1510 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1511 \let\Etable=\relax}}
1513 \def\dontindex #1{}
1514 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1515 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1517 {\obeyspaces %
1518 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1519 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1521 \def\tablez #1#2#3#4#5#6{%
1522 \aboveenvbreak %
1523 \begingroup %
1524 \def\Edescription{\Etable}% Neccessary kludge.
1525 \let\itemindex=#1%
1526 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1527 \ifnum 0#4>0 \tableindent=#4\mil \fi %
1528 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1529 \def\itemfont{#2}%
1530 \itemmax=\tableindent %
1531 \advance \itemmax by -\itemmargin %
1532 \advance \leftskip by \tableindent %
1533 \exdentamount=\tableindent
1534 \parindent = 0pt
1535 \parskip = \smallskipamount
1536 \ifdim \parskip=0pt \parskip=2pt \fi%
1537 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1538 \let\item = \internalBitem %
1539 \let\itemx = \internalBitemx %
1540 \let\kitem = \internalBkitem %
1541 \let\kitemx = \internalBkitemx %
1542 \let\xitem = \internalBxitem %
1543 \let\xitemx = \internalBxitemx %
1546 % This is the counter used by @enumerate, which is really @itemize
1548 \newcount \itemno
1550 \def\itemize{\parsearg\itemizezzz}
1552 \def\itemizezzz #1{%
1553 \begingroup % ended by the @end itemsize
1554 \itemizey {#1}{\Eitemize}
1557 \def\itemizey #1#2{%
1558 \aboveenvbreak %
1559 \itemmax=\itemindent %
1560 \advance \itemmax by -\itemmargin %
1561 \advance \leftskip by \itemindent %
1562 \exdentamount=\itemindent
1563 \parindent = 0pt %
1564 \parskip = \smallskipamount %
1565 \ifdim \parskip=0pt \parskip=2pt \fi%
1566 \def#2{\endgraf\afterenvbreak\endgroup}%
1567 \def\itemcontents{#1}%
1568 \let\item=\itemizeitem}
1570 % Set sfcode to normal for the chars that usually have another value.
1571 % These are `.?!:;,'
1572 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1573 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1575 % \splitoff TOKENS\endmark defines \first to be the first token in
1576 % TOKENS, and \rest to be the remainder.
1578 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1580 % Allow an optional argument of an uppercase letter, lowercase letter,
1581 % or number, to specify the first label in the enumerated list. No
1582 % argument is the same as `1'.
1584 \def\enumerate{\parsearg\enumeratezzz}
1585 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1586 \def\enumeratey #1 #2\endenumeratey{%
1587 \begingroup % ended by the @end enumerate
1589 % If we were given no argument, pretend we were given `1'.
1590 \def\thearg{#1}%
1591 \ifx\thearg\empty \def\thearg{1}\fi
1593 % Detect if the argument is a single token. If so, it might be a
1594 % letter. Otherwise, the only valid thing it can be is a number.
1595 % (We will always have one token, because of the test we just made.
1596 % This is a good thing, since \splitoff doesn't work given nothing at
1597 % all -- the first parameter is undelimited.)
1598 \expandafter\splitoff\thearg\endmark
1599 \ifx\rest\empty
1600 % Only one token in the argument. It could still be anything.
1601 % A ``lowercase letter'' is one whose \lccode is nonzero.
1602 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1603 % not equal to itself.
1604 % Otherwise, we assume it's a number.
1606 % We need the \relax at the end of the \ifnum lines to stop TeX from
1607 % continuing to look for a <number>.
1609 \ifnum\lccode\expandafter`\thearg=0\relax
1610 \numericenumerate % a number (we hope)
1611 \else
1612 % It's a letter.
1613 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1614 \lowercaseenumerate % lowercase letter
1615 \else
1616 \uppercaseenumerate % uppercase letter
1619 \else
1620 % Multiple tokens in the argument. We hope it's a number.
1621 \numericenumerate
1625 % An @enumerate whose labels are integers. The starting integer is
1626 % given in \thearg.
1628 \def\numericenumerate{%
1629 \itemno = \thearg
1630 \startenumeration{\the\itemno}%
1633 % The starting (lowercase) letter is in \thearg.
1634 \def\lowercaseenumerate{%
1635 \itemno = \expandafter`\thearg
1636 \startenumeration{%
1637 % Be sure we're not beyond the end of the alphabet.
1638 \ifnum\itemno=0
1639 \errmessage{No more lowercase letters in @enumerate; get a bigger
1640 alphabet}%
1642 \char\lccode\itemno
1646 % The starting (uppercase) letter is in \thearg.
1647 \def\uppercaseenumerate{%
1648 \itemno = \expandafter`\thearg
1649 \startenumeration{%
1650 % Be sure we're not beyond the end of the alphabet.
1651 \ifnum\itemno=0
1652 \errmessage{No more uppercase letters in @enumerate; get a bigger
1653 alphabet}
1655 \char\uccode\itemno
1659 % Call itemizey, adding a period to the first argument and supplying the
1660 % common last two arguments. Also subtract one from the initial value in
1661 % \itemno, since @item increments \itemno.
1663 \def\startenumeration#1{%
1664 \advance\itemno by -1
1665 \itemizey{#1.}\Eenumerate\flushcr
1668 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1669 % to @enumerate.
1671 \def\alphaenumerate{\enumerate{a}}
1672 \def\capsenumerate{\enumerate{A}}
1673 \def\Ealphaenumerate{\Eenumerate}
1674 \def\Ecapsenumerate{\Eenumerate}
1676 % Definition of @item while inside @itemize.
1678 \def\itemizeitem{%
1679 \advance\itemno by 1
1680 {\let\par=\endgraf \smallbreak}%
1681 \ifhmode \errmessage{\in hmode at itemizeitem}\fi
1682 {\parskip=0in \hskip 0pt
1683 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1684 \vadjust{\penalty 1200}}%
1685 \flushcr}
1687 % @multitable macros
1688 % Amy Hendrickson, 8/18/94
1690 % @multitable ... @endmultitable will make as many columns as desired.
1691 % Contents of each column will wrap at width given in preamble. Width
1692 % can be specified either with sample text given in a template line,
1693 % or in percent of \hsize, the current width of text on page.
1695 % Table can continue over pages but will only break between lines.
1697 % To make preamble:
1699 % Either define widths of columns in terms of percent of \hsize:
1700 % @multitable @percentofhsize .2 .3 .5
1701 % @item ...
1703 % Numbers following @percentofhsize are the percent of the total
1704 % current hsize to be used for each column. You may use as many
1705 % columns as desired.
1707 % Or use a template:
1708 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1709 % @item ...
1710 % using the widest term desired in each column.
1713 % Each new table line starts with @item, each subsequent new column
1714 % starts with @tab. Empty columns may be produced by supplying @tab's
1715 % with nothing between them for as many times as empty columns are needed,
1716 % ie, @tab@tab@tab will produce two empty columns.
1718 % @item, @tab, @multicolumn or @endmulticolumn do not need to be on their
1719 % own lines, but it will not hurt if they are.
1721 % Sample multitable:
1723 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
1724 % @item first col stuff @tab second col stuff @tab third col
1725 % @item
1726 % first col stuff
1727 % @tab
1728 % second col stuff
1729 % @tab
1730 % third col
1731 % @item first col stuff @tab second col stuff
1732 % @tab Many paragraphs of text may be used in any column.
1734 % They will wrap at the width determined by the template.
1735 % @item@tab@tab This will be in third column.
1736 % @endmultitable
1738 % Default dimensions may be reset by user.
1739 % @intableparskip will set vertical space between paragraphs in table.
1740 % @intableparindent will set paragraph indent in table.
1741 % @spacebetweencols will set horizontal space to be left between columns.
1742 % @spacebetweenlines will set vertical space to be left between lines.
1744 %%%%
1745 % Dimensions
1747 \newdimen\intableparskip
1748 \newdimen\intableparindent
1749 \newdimen\spacebetweencols
1750 \newdimen\spacebetweenlines
1751 \intableparskip=0pt
1752 \intableparindent=6pt
1753 \spacebetweencols=12pt
1754 \spacebetweenlines=12pt
1756 %%%%
1757 % Macros used to set up halign preamble:
1758 \let\endsetuptable\relax
1759 \def\xendsetuptable{\endsetuptable}
1760 \let\percentofhsize\relax
1761 \def\xpercentofhsize{\percentofhsize}
1762 \newif\ifsetpercent
1764 \newcount\colcount
1765 \def\setuptable#1{\def\firstarg{#1}%
1766 \ifx\firstarg\xendsetuptable\let\go\relax%
1767 \else
1768 \ifx\firstarg\xpercentofhsize\global\setpercenttrue%
1769 \else
1770 \ifsetpercent
1771 \if#1.\else%
1772 \global\advance\colcount by1 %
1773 \expandafter\xdef\csname col\the\colcount\endcsname{.#1\hsize}%
1775 \else
1776 \global\advance\colcount by1
1777 \setbox0=\hbox{#1}%
1778 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
1779 \fi%
1780 \fi%
1781 \let\go\setuptable%
1782 \fi\go}
1783 %%%%
1784 % multitable syntax
1785 \def\tab{&}
1787 %%%%
1788 % @multitable ... @endmultitable definitions:
1790 \def\multitable#1\item{\bgroup
1791 \let\item\cr
1792 \tolerance=9500
1793 \hbadness=9500
1794 \parskip=\intableparskip
1795 \parindent=\intableparindent
1796 \overfullrule=0pt
1797 \global\colcount=0\relax%
1798 \def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
1799 % To parse everything between @multitable and @item :
1800 \def\one{#1}\expandafter\setuptable\one\endsetuptable
1801 % Need to reset this to 0 after \setuptable.
1802 \global\colcount=0\relax%
1804 % This preamble sets up a generic column definition, which will
1805 % be used as many times as user calls for columns.
1806 % \vtop will set a single line and will also let text wrap and
1807 % continue for many paragraphs if desired.
1808 \halign\bgroup&\global\advance\colcount by 1\relax%
1809 \vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
1810 % In order to keep entries from bumping into each other
1811 % we will add a \leftskip of \spacebetweencols to all columns after
1812 % the first one.
1813 % If a template has been used, we will add \spacebetweencols
1814 % to the width of each template entry.
1815 % If user has set preamble in terms of percent of \hsize
1816 % we will use that dimension as the width of the column, and
1817 % the \leftskip will keep entries from bumping into each other.
1818 % Table will start at left margin and final column will justify at
1819 % right margin.
1820 \ifnum\colcount=1
1821 \else
1822 \ifsetpercent
1823 \else
1824 % If user has <not> set preamble in terms of percent of \hsize
1825 % we will advance \hsize by \spacebetweencols
1826 \advance\hsize by \spacebetweencols
1828 % In either case we will make \leftskip=\spacebetweencols:
1829 \leftskip=\spacebetweencols
1831 \noindent##}\cr%
1832 % \everycr will reset column counter, \colcount, at the end of
1833 % each line. Every column entry will cause \colcount to advance by one.
1834 % The table preamble
1835 % looks at the current \colcount to find the correct column width.
1836 \global\everycr{\noalign{\nointerlineskip\vskip\spacebetweenlines
1837 \filbreak%% keeps underfull box messages off when table breaks over pages.
1838 \global\colcount=0\relax}}}
1840 \message{indexing,}
1841 % Index generation facilities
1843 % Define \newwrite to be identical to plain tex's \newwrite
1844 % except not \outer, so it can be used within \newindex.
1845 {\catcode`\@=11
1846 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
1848 % \newindex {foo} defines an index named foo.
1849 % It automatically defines \fooindex such that
1850 % \fooindex ...rest of line... puts an entry in the index foo.
1851 % It also defines \fooindfile to be the number of the output channel for
1852 % the file that accumulates this index. The file's extension is foo.
1853 % The name of an index should be no more than 2 characters long
1854 % for the sake of vms.
1856 \def\newindex #1{
1857 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1858 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1859 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1860 \noexpand\doindex {#1}}
1863 % @defindex foo == \newindex{foo}
1865 \def\defindex{\parsearg\newindex}
1867 % Define @defcodeindex, like @defindex except put all entries in @code.
1869 \def\newcodeindex #1{
1870 \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1871 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1872 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1873 \noexpand\docodeindex {#1}}
1876 \def\defcodeindex{\parsearg\newcodeindex}
1878 % @synindex foo bar makes index foo feed into index bar.
1879 % Do this instead of @defindex foo if you don't want it as a separate index.
1880 \def\synindex #1 #2 {%
1881 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1882 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
1883 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1884 \noexpand\doindex {#2}}%
1887 % @syncodeindex foo bar similar, but put all entries made for index foo
1888 % inside @code.
1889 \def\syncodeindex #1 #2 {%
1890 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1891 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
1892 \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1893 \noexpand\docodeindex {#2}}%
1896 % Define \doindex, the driver for all \fooindex macros.
1897 % Argument #1 is generated by the calling \fooindex macro,
1898 % and it is "foo", the name of the index.
1900 % \doindex just uses \parsearg; it calls \doind for the actual work.
1901 % This is because \doind is more useful to call from other macros.
1903 % There is also \dosubind {index}{topic}{subtopic}
1904 % which makes an entry in a two-level index such as the operation index.
1906 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
1907 \def\singleindexer #1{\doind{\indexname}{#1}}
1909 % like the previous two, but they put @code around the argument.
1910 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
1911 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
1913 \def\indexdummies{%
1914 % Take care of the plain tex accent commands.
1915 \def\"{\realbackslash "}%
1916 \def\`{\realbackslash `}%
1917 \def\'{\realbackslash '}%
1918 \def\^{\realbackslash ^}%
1919 \def\~{\realbackslash ~}%
1920 \def\={\realbackslash =}%
1921 \def\b{\realbackslash b}%
1922 \def\c{\realbackslash c}%
1923 \def\d{\realbackslash d}%
1924 \def\u{\realbackslash u}%
1925 \def\v{\realbackslash v}%
1926 \def\H{\realbackslash H}%
1927 % Take care of the plain tex special European modified letters.
1928 \def\oe{\realbackslash oe}%
1929 \def\ae{\realbackslash ae}%
1930 \def\aa{\realbackslash aa}%
1931 \def\OE{\realbackslash OE}%
1932 \def\AE{\realbackslash AE}%
1933 \def\AA{\realbackslash AA}%
1934 \def\o{\realbackslash o}%
1935 \def\O{\realbackslash O}%
1936 \def\l{\realbackslash l}%
1937 \def\L{\realbackslash L}%
1938 \def\ss{\realbackslash ss}%
1939 % Take care of texinfo commands likely to appear in an index entry.
1940 \def\_{{\realbackslash _}}%
1941 \def\w{\realbackslash w }%
1942 \def\bf{\realbackslash bf }%
1943 \def\rm{\realbackslash rm }%
1944 \def\sl{\realbackslash sl }%
1945 \def\sf{\realbackslash sf}%
1946 \def\tt{\realbackslash tt}%
1947 \def\gtr{\realbackslash gtr}%
1948 \def\less{\realbackslash less}%
1949 \def\hat{\realbackslash hat}%
1950 \def\char{\realbackslash char}%
1951 \def\TeX{\realbackslash TeX}%
1952 \def\dots{\realbackslash dots }%
1953 \def\copyright{\realbackslash copyright }%
1954 \def\tclose##1{\realbackslash tclose {##1}}%
1955 \def\code##1{\realbackslash code {##1}}%
1956 \def\samp##1{\realbackslash samp {##1}}%
1957 \def\t##1{\realbackslash r {##1}}%
1958 \def\r##1{\realbackslash r {##1}}%
1959 \def\i##1{\realbackslash i {##1}}%
1960 \def\b##1{\realbackslash b {##1}}%
1961 \def\cite##1{\realbackslash cite {##1}}%
1962 \def\key##1{\realbackslash key {##1}}%
1963 \def\file##1{\realbackslash file {##1}}%
1964 \def\var##1{\realbackslash var {##1}}%
1965 \def\kbd##1{\realbackslash kbd {##1}}%
1966 \def\dfn##1{\realbackslash dfn {##1}}%
1967 \def\emph##1{\realbackslash emph {##1}}%
1970 % \indexnofonts no-ops all font-change commands.
1971 % This is used when outputting the strings to sort the index by.
1972 \def\indexdummyfont#1{#1}
1973 \def\indexdummytex{TeX}
1974 \def\indexdummydots{...}
1976 \def\indexnofonts{%
1977 % Just ignore accents.
1978 \let\"=\indexdummyfont
1979 \let\`=\indexdummyfont
1980 \let\'=\indexdummyfont
1981 \let\^=\indexdummyfont
1982 \let\~=\indexdummyfont
1983 \let\==\indexdummyfont
1984 \let\b=\indexdummyfont
1985 \let\c=\indexdummyfont
1986 \let\d=\indexdummyfont
1987 \let\u=\indexdummyfont
1988 \let\v=\indexdummyfont
1989 \let\H=\indexdummyfont
1990 % Take care of the plain tex special European modified letters.
1991 \def\oe{oe}%
1992 \def\ae{ae}%
1993 \def\aa{aa}%
1994 \def\OE{OE}%
1995 \def\AE{AE}%
1996 \def\AA{AA}%
1997 \def\o{o}%
1998 \def\O{O}%
1999 \def\l{l}%
2000 \def\L{L}%
2001 \def\ss{ss}%
2002 \let\w=\indexdummyfont
2003 \let\t=\indexdummyfont
2004 \let\r=\indexdummyfont
2005 \let\i=\indexdummyfont
2006 \let\b=\indexdummyfont
2007 \let\emph=\indexdummyfont
2008 \let\strong=\indexdummyfont
2009 \let\cite=\indexdummyfont
2010 \let\sc=\indexdummyfont
2011 %Don't no-op \tt, since it isn't a user-level command
2012 % and is used in the definitions of the active chars like <, >, |...
2013 %\let\tt=\indexdummyfont
2014 \let\tclose=\indexdummyfont
2015 \let\code=\indexdummyfont
2016 \let\file=\indexdummyfont
2017 \let\samp=\indexdummyfont
2018 \let\kbd=\indexdummyfont
2019 \let\key=\indexdummyfont
2020 \let\var=\indexdummyfont
2021 \let\TeX=\indexdummytex
2022 \let\dots=\indexdummydots
2025 % To define \realbackslash, we must make \ not be an escape.
2026 % We must first make another character (@) an escape
2027 % so we do not become unable to do a definition.
2029 {\catcode`\@=0 \catcode`\\=\other
2030 @gdef@realbackslash{\}}
2032 \let\indexbackslash=0 %overridden during \printindex.
2034 \def\doind #1#2{%
2035 {\count10=\lastpenalty %
2036 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2037 \escapechar=`\\%
2038 {\let\folio=0% Expand all macros now EXCEPT \folio
2039 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2040 % so it will be output as is; and it will print as backslash in the indx.
2042 % Now process the index-string once, with all font commands turned off,
2043 % to get the string to sort the index by.
2044 {\indexnofonts
2045 \xdef\temp1{#2}%
2047 % Now produce the complete index entry. We process the index-string again,
2048 % this time with font commands expanded, to get what to print in the index.
2049 \edef\temp{%
2050 \write \csname#1indfile\endcsname{%
2051 \realbackslash entry {\temp1}{\folio}{#2}}}%
2052 \temp }%
2053 }\penalty\count10}}
2055 \def\dosubind #1#2#3{%
2056 {\count10=\lastpenalty %
2057 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2058 \escapechar=`\\%
2059 {\let\folio=0%
2060 \def\rawbackslashxx{\indexbackslash}%
2062 % Now process the index-string once, with all font commands turned off,
2063 % to get the string to sort the index by.
2064 {\indexnofonts
2065 \xdef\temp1{#2 #3}%
2067 % Now produce the complete index entry. We process the index-string again,
2068 % this time with font commands expanded, to get what to print in the index.
2069 \edef\temp{%
2070 \write \csname#1indfile\endcsname{%
2071 \realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
2072 \temp }%
2073 }\penalty\count10}}
2075 % The index entry written in the file actually looks like
2076 % \entry {sortstring}{page}{topic}
2077 % or
2078 % \entry {sortstring}{page}{topic}{subtopic}
2079 % The texindex program reads in these files and writes files
2080 % containing these kinds of lines:
2081 % \initial {c}
2082 % before the first topic whose initial is c
2083 % \entry {topic}{pagelist}
2084 % for a topic that is used without subtopics
2085 % \primary {topic}
2086 % for the beginning of a topic that is used with subtopics
2087 % \secondary {subtopic}{pagelist}
2088 % for each subtopic.
2090 % Define the user-accessible indexing commands
2091 % @findex, @vindex, @kindex, @cindex.
2093 \def\findex {\fnindex}
2094 \def\kindex {\kyindex}
2095 \def\cindex {\cpindex}
2096 \def\vindex {\vrindex}
2097 \def\tindex {\tpindex}
2098 \def\pindex {\pgindex}
2100 \def\cindexsub {\begingroup\obeylines\cindexsub}
2101 {\obeylines %
2102 \gdef\cindexsub "#1" #2^^M{\endgroup %
2103 \dosubind{cp}{#2}{#1}}}
2105 % Define the macros used in formatting output of the sorted index material.
2107 % This is what you call to cause a particular index to get printed.
2108 % Write
2109 % @unnumbered Function Index
2110 % @printindex fn
2112 \def\printindex{\parsearg\doprintindex}
2114 \def\doprintindex#1{%
2115 \tex
2116 \dobreak \chapheadingskip {10000}
2117 \catcode`\%=\other\catcode`\&=\other\catcode`\#=\other
2118 \catcode`\$=\other
2119 \catcode`\~=\other
2120 \indexbreaks
2122 % The following don't help, since the chars were translated
2123 % when the raw index was written, and their fonts were discarded
2124 % due to \indexnofonts.
2125 %\catcode`\"=\active
2126 %\catcode`\^=\active
2127 %\catcode`\_=\active
2128 %\catcode`\|=\active
2129 %\catcode`\<=\active
2130 %\catcode`\>=\active
2132 \def\indexbackslash{\rawbackslashxx}
2133 \indexfonts\rm \tolerance=9500 \advance\baselineskip -1pt
2134 \begindoublecolumns
2136 % See if the index file exists and is nonempty.
2137 \openin 1 \jobname.#1s
2138 \ifeof 1
2139 % \enddoublecolumns gets confused if there is no text in the index,
2140 % and it loses the chapter title and the aux file entries for the
2141 % index. The easiest way to prevent this problem is to make sure
2142 % there is some text.
2143 (Index is nonexistent)
2144 \else
2146 % If the index file exists but is empty, then \openin leaves \ifeof
2147 % false. We have to make TeX try to read something from the file, so
2148 % it can discover if there is anything in it.
2149 \read 1 to \temp
2150 \ifeof 1
2151 (Index is empty)
2152 \else
2153 \input \jobname.#1s
2156 \closein 1
2157 \enddoublecolumns
2158 \Etex
2161 % These macros are used by the sorted index file itself.
2162 % Change them to control the appearance of the index.
2164 % Same as \bigskipamount except no shrink.
2165 % \balancecolumns gets confused if there is any shrink.
2166 \newskip\initialskipamount \initialskipamount 12pt plus4pt
2168 \def\initial #1{%
2169 {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
2170 \ifdim\lastskip<\initialskipamount
2171 \removelastskip \penalty-200 \vskip \initialskipamount\fi
2172 \line{\secbf#1\hfill}\kern 2pt\penalty10000}}
2174 % This typesets a paragraph consisting of #1, dot leaders, and then #2
2175 % flush to the right margin. It is used for index and table of contents
2176 % entries. The paragraph is indented by \leftskip.
2178 \def\entry #1#2{\begingroup
2180 % Start a new paragraph if necessary, so our assignments below can't
2181 % affect previous text.
2182 \par
2184 % Do not fill out the last line with white space.
2185 \parfillskip = 0in
2187 % No extra space above this paragraph.
2188 \parskip = 0in
2190 % Do not prefer a separate line ending with a hyphen to fewer lines.
2191 \finalhyphendemerits = 0
2193 % \hangindent is only relevant when the entry text and page number
2194 % don't both fit on one line. In that case, bob suggests starting the
2195 % dots pretty far over on the line. Unfortunately, a large
2196 % indentation looks wrong when the entry text itself is broken across
2197 % lines. So we use a small indentation and put up with long leaders.
2199 % \hangafter is reset to 1 (which is the value we want) at the start
2200 % of each paragraph, so we need not do anything with that.
2201 \hangindent=2em
2203 % When the entry text needs to be broken, just fill out the first line
2204 % with blank space.
2205 \rightskip = 0pt plus1fil
2207 % Start a ``paragraph'' for the index entry so the line breaking
2208 % parameters we've set above will have an effect.
2209 \noindent
2211 % Insert the text of the index entry. TeX will do line-breaking on it.
2213 % The following is kluged to not output a line of dots in the index if
2214 % there are no page numbers. The next person who breaks this will be
2215 % cursed by a Unix daemon.
2216 \def\tempa{{\rm }}%
2217 \def\tempb{#2}%
2218 \edef\tempc{\tempa}%
2219 \edef\tempd{\tempb}%
2220 \ifx\tempc\tempd\ \else%
2222 % If we must, put the page number on a line of its own, and fill out
2223 % this line with blank space. (The \hfil is overwhelmed with the
2224 % fill leaders glue in \indexdotfill if the page number does fit.)
2225 \hfil\penalty50
2226 \null\nobreak\indexdotfill % Have leaders before the page number.
2228 % The `\ ' here is removed by the implicit \unskip that TeX does as
2229 % part of (the primitive) \par. Without it, a spurious underfull
2230 % \hbox ensues.
2231 \ #2% The page number ends the paragraph.
2232 \fi%
2233 \par
2234 \endgroup}
2236 % Like \dotfill except takes at least 1 em.
2237 \def\indexdotfill{\cleaders
2238 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
2240 \def\primary #1{\line{#1\hfil}}
2242 \newskip\secondaryindent \secondaryindent=0.5cm
2244 \def\secondary #1#2{
2245 {\parfillskip=0in \parskip=0in
2246 \hangindent =1in \hangafter=1
2247 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2250 %% Define two-column mode, which is used in indexes.
2251 %% Adapted from the TeXbook, page 416.
2252 \catcode `\@=11
2254 \newbox\partialpage
2256 \newdimen\doublecolumnhsize
2258 \def\begindoublecolumns{\begingroup
2259 % Grab any single-column material above us.
2260 \output = {\global\setbox\partialpage
2261 =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
2262 \eject
2264 % Now switch to the double-column output routine.
2265 \output={\doublecolumnout}%
2267 % Change the page size parameters. We could do this once outside this
2268 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2269 % format, but then we repeat the same computation. Repeating a couple
2270 % of assignments once per index is clearly meaningless for the
2271 % execution time, so we may as well do it once.
2273 % First we halve the line length, less a little for the gutter between
2274 % the columns. We compute the gutter based on the line length, so it
2275 % changes automatically with the paper format. The magic constant
2276 % below is chosen so that the gutter has the same value (well, +- <
2277 % 1pt) as it did when we hard-coded it.
2279 % We put the result in a separate register, \doublecolumhsize, so we
2280 % can restore it in \pagesofar, after \hsize itself has (potentially)
2281 % been clobbered.
2283 \doublecolumnhsize = \hsize
2284 \advance\doublecolumnhsize by -.04154\hsize
2285 \divide\doublecolumnhsize by 2
2286 \hsize = \doublecolumnhsize
2288 % Double the \vsize as well. (We don't need a separate register here,
2289 % since nobody clobbers \vsize.)
2290 \vsize = 2\vsize
2291 \doublecolumnpagegoal
2294 \def\enddoublecolumns{\eject \endgroup \pagegoal=\vsize \unvbox\partialpage}
2296 \def\doublecolumnsplit{\splittopskip=\topskip \splitmaxdepth=\maxdepth
2297 \global\dimen@=\pageheight \global\advance\dimen@ by-\ht\partialpage
2298 \global\setbox1=\vsplit255 to\dimen@ \global\setbox0=\vbox{\unvbox1}
2299 \global\setbox3=\vsplit255 to\dimen@ \global\setbox2=\vbox{\unvbox3}
2300 \ifdim\ht0>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2301 \ifdim\ht2>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2303 \def\doublecolumnpagegoal{%
2304 \dimen@=\vsize \advance\dimen@ by-2\ht\partialpage \global\pagegoal=\dimen@
2306 \def\pagesofar{\unvbox\partialpage %
2307 \hsize=\doublecolumnhsize % have to restore this since output routine
2308 \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
2309 \def\doublecolumnout{%
2310 \setbox5=\copy255
2311 {\vbadness=10000 \doublecolumnsplit}
2312 \ifvbox255
2313 \setbox0=\vtop to\dimen@{\unvbox0}
2314 \setbox2=\vtop to\dimen@{\unvbox2}
2315 \onepageout\pagesofar \unvbox255 \penalty\outputpenalty
2316 \else
2317 \setbox0=\vbox{\unvbox5}
2318 \ifvbox0
2319 \dimen@=\ht0 \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
2320 \divide\dimen@ by2 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2321 {\vbadness=10000
2322 \loop \global\setbox5=\copy0
2323 \setbox1=\vsplit5 to\dimen@
2324 \setbox3=\vsplit5 to\dimen@
2325 \ifvbox5 \global\advance\dimen@ by1pt \repeat
2326 \setbox0=\vbox to\dimen@{\unvbox1}
2327 \setbox2=\vbox to\dimen@{\unvbox3}
2328 \global\setbox\partialpage=\vbox{\pagesofar}
2329 \doublecolumnpagegoal
2335 \catcode `\@=\other
2336 \message{sectioning,}
2337 % Define chapters, sections, etc.
2339 \newcount \chapno
2340 \newcount \secno \secno=0
2341 \newcount \subsecno \subsecno=0
2342 \newcount \subsubsecno \subsubsecno=0
2344 % This counter is funny since it counts through charcodes of letters A, B, ...
2345 \newcount \appendixno \appendixno = `\@
2346 \def\appendixletter{\char\the\appendixno}
2348 \newwrite \contentsfile
2349 % This is called from \setfilename.
2350 \def\opencontents{\openout \contentsfile = \jobname.toc}
2352 % Each @chapter defines this as the name of the chapter.
2353 % page headings and footings can use it. @section does likewise
2355 \def\thischapter{} \def\thissection{}
2356 \def\seccheck#1{\if \pageno<0 %
2357 \errmessage{@#1 not allowed after generating table of contents}\fi
2361 \def\chapternofonts{%
2362 \let\rawbackslash=\relax%
2363 \let\frenchspacing=\relax%
2364 \def\result{\realbackslash result}
2365 \def\equiv{\realbackslash equiv}
2366 \def\expansion{\realbackslash expansion}
2367 \def\print{\realbackslash print}
2368 \def\TeX{\realbackslash TeX}
2369 \def\dots{\realbackslash dots}
2370 \def\copyright{\realbackslash copyright}
2371 \def\tt{\realbackslash tt}
2372 \def\bf{\realbackslash bf }
2373 \def\w{\realbackslash w}
2374 \def\less{\realbackslash less}
2375 \def\gtr{\realbackslash gtr}
2376 \def\hat{\realbackslash hat}
2377 \def\char{\realbackslash char}
2378 \def\tclose##1{\realbackslash tclose {##1}}
2379 \def\code##1{\realbackslash code {##1}}
2380 \def\samp##1{\realbackslash samp {##1}}
2381 \def\r##1{\realbackslash r {##1}}
2382 \def\b##1{\realbackslash b {##1}}
2383 \def\key##1{\realbackslash key {##1}}
2384 \def\file##1{\realbackslash file {##1}}
2385 \def\kbd##1{\realbackslash kbd {##1}}
2386 % These are redefined because @smartitalic wouldn't work inside xdef.
2387 \def\i##1{\realbackslash i {##1}}
2388 \def\cite##1{\realbackslash cite {##1}}
2389 \def\var##1{\realbackslash var {##1}}
2390 \def\emph##1{\realbackslash emph {##1}}
2391 \def\dfn##1{\realbackslash dfn {##1}}
2394 \newcount\absseclevel % used to calculate proper heading level
2395 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
2397 % @raisesections: treat @section as chapter, @subsection as section, etc.
2398 \def\raisesections{\global\advance\secbase by -1}
2399 \let\up=\raisesections % original BFox name
2401 % @lowersections: treat @chapter as section, @section as subsection, etc.
2402 \def\lowersections{\global\advance\secbase by 1}
2403 \let\down=\lowersections % original BFox name
2405 % Choose a numbered-heading macro
2406 % #1 is heading level if unmodified by @raisesections or @lowersections
2407 % #2 is text for heading
2408 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2409 \ifcase\absseclevel
2410 \chapterzzz{#2}
2412 \seczzz{#2}
2414 \numberedsubseczzz{#2}
2416 \numberedsubsubseczzz{#2}
2417 \else
2418 \ifnum \absseclevel<0
2419 \chapterzzz{#2}
2420 \else
2421 \numberedsubsubseczzz{#2}
2426 % like \numhead, but chooses appendix heading levels
2427 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2428 \ifcase\absseclevel
2429 \appendixzzz{#2}
2431 \appendixsectionzzz{#2}
2433 \appendixsubseczzz{#2}
2435 \appendixsubsubseczzz{#2}
2436 \else
2437 \ifnum \absseclevel<0
2438 \appendixzzz{#2}
2439 \else
2440 \appendixsubsubseczzz{#2}
2445 % like \numhead, but chooses numberless heading levels
2446 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2447 \ifcase\absseclevel
2448 \unnumberedzzz{#2}
2450 \unnumberedseczzz{#2}
2452 \unnumberedsubseczzz{#2}
2454 \unnumberedsubsubseczzz{#2}
2455 \else
2456 \ifnum \absseclevel<0
2457 \unnumberedzzz{#2}
2458 \else
2459 \unnumberedsubsubseczzz{#2}
2465 \def\thischaptername{No Chapter Title}
2466 \outer\def\chapter{\parsearg\chapteryyy}
2467 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2468 \def\chapterzzz #1{\seccheck{chapter}%
2469 \secno=0 \subsecno=0 \subsubsecno=0
2470 \global\advance \chapno by 1 \message{Chapter \the\chapno}%
2471 \chapmacro {#1}{\the\chapno}%
2472 \gdef\thissection{#1}%
2473 \gdef\thischaptername{#1}%
2474 % We don't substitute the actual chapter name into \thischapter
2475 % because we don't want its macros evaluated now.
2476 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
2477 {\chapternofonts%
2478 \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
2479 \escapechar=`\\%
2480 \write \contentsfile \temp %
2481 \donoderef %
2482 \global\let\section = \numberedsec
2483 \global\let\subsection = \numberedsubsec
2484 \global\let\subsubsection = \numberedsubsubsec
2487 \outer\def\appendix{\parsearg\appendixyyy}
2488 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2489 \def\appendixzzz #1{\seccheck{appendix}%
2490 \secno=0 \subsecno=0 \subsubsecno=0
2491 \global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2492 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2493 \gdef\thissection{#1}%
2494 \gdef\thischaptername{#1}%
2495 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
2496 {\chapternofonts%
2497 \edef\temp{{\realbackslash chapentry
2498 {#1}{\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
2499 \escapechar=`\\%
2500 \write \contentsfile \temp %
2501 \appendixnoderef %
2502 \global\let\section = \appendixsec
2503 \global\let\subsection = \appendixsubsec
2504 \global\let\subsubsection = \appendixsubsubsec
2507 \outer\def\top{\parsearg\unnumberedyyy}
2508 \outer\def\unnumbered{\parsearg\unnumberedyyy}
2509 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2510 \def\unnumberedzzz #1{\seccheck{unnumbered}%
2511 \secno=0 \subsecno=0 \subsubsecno=0
2513 % This used to be simply \message{#1}, but TeX fully expands the
2514 % argument to \message. Therefore, if #1 contained @-commands, TeX
2515 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2516 % expanded @cite (which turns out to cause errors because \cite is meant
2517 % to be executed, not expanded).
2519 % Anyway, we don't want the fully-expanded definition of @cite to appear
2520 % as a result of the \message, we just want `@cite' itself. We use
2521 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
2522 % simply yielding the contents of the <toks register>.
2523 \toks0 = {#1}\message{(\the\toks0)}%
2525 \unnumbchapmacro {#1}%
2526 \gdef\thischapter{#1}\gdef\thissection{#1}%
2527 {\chapternofonts%
2528 \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
2529 \escapechar=`\\%
2530 \write \contentsfile \temp %
2531 \unnumbnoderef %
2532 \global\let\section = \unnumberedsec
2533 \global\let\subsection = \unnumberedsubsec
2534 \global\let\subsubsection = \unnumberedsubsubsec
2537 \outer\def\numberedsec{\parsearg\secyyy}
2538 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2539 \def\seczzz #1{\seccheck{section}%
2540 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2541 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2542 {\chapternofonts%
2543 \edef\temp{{\realbackslash secentry %
2544 {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2545 \escapechar=`\\%
2546 \write \contentsfile \temp %
2547 \donoderef %
2548 \penalty 10000 %
2551 \outer\def\appenixsection{\parsearg\appendixsecyyy}
2552 \outer\def\appendixsec{\parsearg\appendixsecyyy}
2553 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2554 \def\appendixsectionzzz #1{\seccheck{appendixsection}%
2555 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2556 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2557 {\chapternofonts%
2558 \edef\temp{{\realbackslash secentry %
2559 {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2560 \escapechar=`\\%
2561 \write \contentsfile \temp %
2562 \appendixnoderef %
2563 \penalty 10000 %
2566 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2567 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2568 \def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2569 \plainsecheading {#1}\gdef\thissection{#1}%
2570 {\chapternofonts%
2571 \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
2572 \escapechar=`\\%
2573 \write \contentsfile \temp %
2574 \unnumbnoderef %
2575 \penalty 10000 %
2578 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2579 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2580 \def\numberedsubseczzz #1{\seccheck{subsection}%
2581 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2582 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
2583 {\chapternofonts%
2584 \edef\temp{{\realbackslash subsecentry %
2585 {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2586 \escapechar=`\\%
2587 \write \contentsfile \temp %
2588 \donoderef %
2589 \penalty 10000 %
2592 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
2593 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
2594 \def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
2595 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2596 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
2597 {\chapternofonts%
2598 \edef\temp{{\realbackslash subsecentry %
2599 {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2600 \escapechar=`\\%
2601 \write \contentsfile \temp %
2602 \appendixnoderef %
2603 \penalty 10000 %
2606 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
2607 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
2608 \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
2609 \plainsecheading {#1}\gdef\thissection{#1}%
2610 {\chapternofonts%
2611 \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
2612 \escapechar=`\\%
2613 \write \contentsfile \temp %
2614 \unnumbnoderef %
2615 \penalty 10000 %
2618 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
2619 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
2620 \def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
2621 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2622 \subsubsecheading {#1}
2623 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2624 {\chapternofonts%
2625 \edef\temp{{\realbackslash subsubsecentry %
2626 {#1}
2627 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
2628 {\noexpand\folio}}}%
2629 \escapechar=`\\%
2630 \write \contentsfile \temp %
2631 \donoderef %
2632 \penalty 10000 %
2635 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
2636 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
2637 \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
2638 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2639 \subsubsecheading {#1}
2640 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2641 {\chapternofonts%
2642 \edef\temp{{\realbackslash subsubsecentry{#1}%
2643 {\appendixletter}
2644 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
2645 \escapechar=`\\%
2646 \write \contentsfile \temp %
2647 \appendixnoderef %
2648 \penalty 10000 %
2651 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
2652 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
2653 \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
2654 \plainsecheading {#1}\gdef\thissection{#1}%
2655 {\chapternofonts%
2656 \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
2657 \escapechar=`\\%
2658 \write \contentsfile \temp %
2659 \unnumbnoderef %
2660 \penalty 10000 %
2663 % These are variants which are not "outer", so they can appear in @ifinfo.
2664 % Actually, they should now be obsolete; ordinary section commands should work.
2665 \def\infotop{\parsearg\unnumberedzzz}
2666 \def\infounnumbered{\parsearg\unnumberedzzz}
2667 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
2668 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
2669 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
2671 \def\infoappendix{\parsearg\appendixzzz}
2672 \def\infoappendixsec{\parsearg\appendixseczzz}
2673 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
2674 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
2676 \def\infochapter{\parsearg\chapterzzz}
2677 \def\infosection{\parsearg\sectionzzz}
2678 \def\infosubsection{\parsearg\subsectionzzz}
2679 \def\infosubsubsection{\parsearg\subsubsectionzzz}
2681 % These macros control what the section commands do, according
2682 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
2683 % Define them by default for a numbered chapter.
2684 \global\let\section = \numberedsec
2685 \global\let\subsection = \numberedsubsec
2686 \global\let\subsubsection = \numberedsubsubsec
2688 % Define @majorheading, @heading and @subheading
2690 % NOTE on use of \vbox for chapter headings, section headings, and
2691 % such:
2692 % 1) We use \vbox rather than the earlier \line to permit
2693 % overlong headings to fold.
2694 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
2695 % heading is obnoxious; this forbids it.
2696 % 3) Likewise, headings look best if no \parindent is used, and
2697 % if justification is not attempted. Hence \raggedright.
2700 \def\majorheading{\parsearg\majorheadingzzz}
2701 \def\majorheadingzzz #1{%
2702 {\advance\chapheadingskip by 10pt \chapbreak }%
2703 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2704 \parindent=0pt\raggedright
2705 \rm #1\hfill}}\bigskip \par\penalty 200}
2707 \def\chapheading{\parsearg\chapheadingzzz}
2708 \def\chapheadingzzz #1{\chapbreak %
2709 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2710 \parindent=0pt\raggedright
2711 \rm #1\hfill}}\bigskip \par\penalty 200}
2713 \def\heading{\parsearg\secheadingi}
2715 \def\subheading{\parsearg\subsecheadingi}
2717 \def\subsubheading{\parsearg\subsubsecheadingi}
2719 % These macros generate a chapter, section, etc. heading only
2720 % (including whitespace, linebreaking, etc. around it),
2721 % given all the information in convenient, parsed form.
2723 %%% Args are the skip and penalty (usually negative)
2724 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
2726 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
2728 %%% Define plain chapter starts, and page on/off switching for it
2729 % Parameter controlling skip before chapter headings (if needed)
2731 \newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
2733 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
2734 \def\chappager{\par\vfill\supereject}
2735 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
2737 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
2739 \def\CHAPPAGoff{
2740 \global\let\pchapsepmacro=\chapbreak
2741 \global\let\pagealignmacro=\chappager}
2743 \def\CHAPPAGon{
2744 \global\let\pchapsepmacro=\chappager
2745 \global\let\pagealignmacro=\chappager
2746 \global\def\HEADINGSon{\HEADINGSsingle}}
2748 \def\CHAPPAGodd{
2749 \global\let\pchapsepmacro=\chapoddpage
2750 \global\let\pagealignmacro=\chapoddpage
2751 \global\def\HEADINGSon{\HEADINGSdouble}}
2753 \CHAPPAGon
2755 \def\CHAPFplain{
2756 \global\let\chapmacro=\chfplain
2757 \global\let\unnumbchapmacro=\unnchfplain}
2759 \def\chfplain #1#2{%
2760 \pchapsepmacro
2762 \chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2763 \parindent=0pt\raggedright
2764 \rm #2\enspace #1}%
2766 \bigskip
2767 \penalty5000
2770 \def\unnchfplain #1{%
2771 \pchapsepmacro %
2772 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2773 \parindent=0pt\raggedright
2774 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2776 \CHAPFplain % The default
2778 \def\unnchfopen #1{%
2779 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2780 \parindent=0pt\raggedright
2781 \rm #1\hfill}}\bigskip \par\penalty 10000 %
2784 \def\chfopen #1#2{\chapoddpage {\chapfonts
2785 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
2786 \par\penalty 5000 %
2789 \def\CHAPFopen{
2790 \global\let\chapmacro=\chfopen
2791 \global\let\unnumbchapmacro=\unnchfopen}
2793 % Parameter controlling skip before section headings.
2795 \newskip \subsecheadingskip \subsecheadingskip = 17pt plus 8pt minus 4pt
2796 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
2798 \newskip \secheadingskip \secheadingskip = 21pt plus 8pt minus 4pt
2799 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
2801 % @paragraphindent is defined for the Info formatting commands only.
2802 \let\paragraphindent=\comment
2804 % Section fonts are the base font at magstep2, which produces
2805 % a size a bit more than 14 points in the default situation.
2807 \def\secheading #1#2#3{\secheadingi {#2.#3\enspace #1}}
2808 \def\plainsecheading #1{\secheadingi {#1}}
2809 \def\secheadingi #1{{\advance \secheadingskip by \parskip %
2810 \secheadingbreak}%
2811 {\secfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2812 \parindent=0pt\raggedright
2813 \rm #1\hfill}}%
2814 \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2817 % Subsection fonts are the base font at magstep1,
2818 % which produces a size of 12 points.
2820 \def\subsecheading #1#2#3#4{\subsecheadingi {#2.#3.#4\enspace #1}}
2821 \def\subsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2822 \subsecheadingbreak}%
2823 {\subsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2824 \parindent=0pt\raggedright
2825 \rm #1\hfill}}%
2826 \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2828 \def\subsubsecfonts{\subsecfonts} % Maybe this should change:
2829 % Perhaps make sssec fonts scaled
2830 % magstep half
2831 \def\subsubsecheading #1#2#3#4#5{\subsubsecheadingi {#2.#3.#4.#5\enspace #1}}
2832 \def\subsubsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2833 \subsecheadingbreak}%
2834 {\subsubsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2835 \parindent=0pt\raggedright
2836 \rm #1\hfill}}%
2837 \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000}
2840 \message{toc printing,}
2842 % Finish up the main text and prepare to read what we've written
2843 % to \contentsfile.
2845 \newskip\contentsrightmargin \contentsrightmargin=1in
2846 \def\startcontents#1{%
2847 \pagealignmacro
2848 \immediate\closeout \contentsfile
2849 \ifnum \pageno>0
2850 \pageno = -1 % Request roman numbered pages.
2852 % Don't need to put `Contents' or `Short Contents' in the headline.
2853 % It is abundantly clear what they are.
2854 \unnumbchapmacro{#1}\def\thischapter{}%
2855 \begingroup % Set up to handle contents files properly.
2856 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
2857 \catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
2858 \raggedbottom % Worry more about breakpoints than the bottom.
2859 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
2863 % Normal (long) toc.
2864 \outer\def\contents{%
2865 \startcontents{\putwordTableofContents}%
2866 \input \jobname.toc
2867 \endgroup
2868 \vfill \eject
2871 % And just the chapters.
2872 \outer\def\summarycontents{%
2873 \startcontents{\putwordShortContents}%
2875 \let\chapentry = \shortchapentry
2876 \let\unnumbchapentry = \shortunnumberedentry
2877 % We want a true roman here for the page numbers.
2878 \secfonts
2879 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
2881 \advance\baselineskip by 1pt % Open it up a little.
2882 \def\secentry ##1##2##3##4{}
2883 \def\unnumbsecentry ##1##2{}
2884 \def\subsecentry ##1##2##3##4##5{}
2885 \def\unnumbsubsecentry ##1##2{}
2886 \def\subsubsecentry ##1##2##3##4##5##6{}
2887 \def\unnumbsubsubsecentry ##1##2{}
2888 \input \jobname.toc
2889 \endgroup
2890 \vfill \eject
2892 \let\shortcontents = \summarycontents
2894 % These macros generate individual entries in the table of contents.
2895 % The first argument is the chapter or section name.
2896 % The last argument is the page number.
2897 % The arguments in between are the chapter number, section number, ...
2899 % Chapter-level things, for both the long and short contents.
2900 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
2902 % See comments in \dochapentry re vbox and related settings
2903 \def\shortchapentry#1#2#3{%
2904 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
2907 % Typeset the label for a chapter or appendix for the short contents.
2908 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
2909 % We could simplify the code here by writing out an \appendixentry
2910 % command in the toc file for appendices, instead of using \chapentry
2911 % for both, but it doesn't seem worth it.
2912 \setbox0 = \hbox{\shortcontrm \putwordAppendix }
2913 \newdimen\shortappendixwidth \shortappendixwidth = \wd0
2915 \def\shortchaplabel#1{%
2916 % We typeset #1 in a box of constant width, regardless of the text of
2917 % #1, so the chapter titles will come out aligned.
2918 \setbox0 = \hbox{#1}%
2919 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
2921 % This space should be plenty, since a single number is .5em, and the
2922 % widest letter (M) is 1em, at least in the Computer Modern fonts.
2923 % (This space doesn't include the extra space that gets added after
2924 % the label; that gets put in in \shortchapentry above.)
2925 \advance\dimen0 by 1.1em
2926 \hbox to \dimen0{#1\hfil}%
2929 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
2930 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
2932 % Sections.
2933 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
2934 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
2936 % Subsections.
2937 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
2938 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
2940 % And subsubsections.
2941 \def\subsubsecentry#1#2#3#4#5#6{%
2942 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
2943 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
2946 % This parameter controls the indentation of the various levels.
2947 \newdimen\tocindent \tocindent = 3pc
2949 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
2950 % page number.
2952 % If the toc has to be broken over pages, we would want to be at chapters
2953 % if at all possible; hence the \penalty.
2954 \def\dochapentry#1#2{%
2955 \penalty-300 \vskip\baselineskip
2956 \begingroup
2957 \chapentryfonts
2958 \tocentry{#1}{\dopageno{#2}}%
2959 \endgroup
2960 \nobreak\vskip .25\baselineskip
2963 \def\dosecentry#1#2{\begingroup
2964 \secentryfonts \leftskip=\tocindent
2965 \tocentry{#1}{\dopageno{#2}}%
2966 \endgroup}
2968 \def\dosubsecentry#1#2{\begingroup
2969 \subsecentryfonts \leftskip=2\tocindent
2970 \tocentry{#1}{\dopageno{#2}}%
2971 \endgroup}
2973 \def\dosubsubsecentry#1#2{\begingroup
2974 \subsubsecentryfonts \leftskip=3\tocindent
2975 \tocentry{#1}{\dopageno{#2}}%
2976 \endgroup}
2978 % Final typesetting of a toc entry; we use the same \entry macro as for
2979 % the index entries, but we want to suppress hyphenation here. (We
2980 % can't do that in the \entry macro, since index entries might consist
2981 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
2983 \def\tocentry#1#2{\begingroup
2984 \hyphenpenalty = 10000
2985 \entry{#1}{#2}%
2986 \endgroup}
2988 % Space between chapter (or whatever) number and the title.
2989 \def\labelspace{\hskip1em \relax}
2991 \def\dopageno#1{{\rm #1}}
2992 \def\doshortpageno#1{{\rm #1}}
2994 \def\chapentryfonts{\secfonts \rm}
2995 \def\secentryfonts{\textfonts}
2996 \let\subsecentryfonts = \textfonts
2997 \let\subsubsecentryfonts = \textfonts
3000 \message{environments,}
3002 % Since these characters are used in examples, it should be an even number of
3003 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3004 % Furthermore, these definitions must come after we define our fonts.
3005 \newbox\dblarrowbox \newbox\longdblarrowbox
3006 \newbox\pushcharbox \newbox\bullbox
3007 \newbox\equivbox \newbox\errorbox
3009 \let\ptexequiv = \equiv
3011 %{\tentt
3012 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3013 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3014 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3015 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3016 % Adapted from the manmac format (p.420 of TeXbook)
3017 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3018 % depth .1ex\hfil}
3021 \def\point{$\star$}
3023 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3024 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
3025 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3027 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3029 % Adapted from the TeXbook's \boxit.
3030 {\tentt \global\dimen0 = 3em}% Width of the box.
3031 \dimen2 = .55pt % Thickness of rules
3032 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3033 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
3035 \global\setbox\errorbox=\hbox to \dimen0{\hfil
3036 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3037 \advance\hsize by -2\dimen2 % Rules.
3038 \vbox{
3039 \hrule height\dimen2
3040 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3041 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3042 \kern3pt\vrule width\dimen2}% Space to right.
3043 \hrule height\dimen2}
3044 \hfil}
3046 % The @error{} command.
3047 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3049 % @tex ... @end tex escapes into raw Tex temporarily.
3050 % One exception: @ is still an escape character, so that @end tex works.
3051 % But \@ or @@ will get a plain tex @ character.
3053 \def\tex{\begingroup
3054 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
3055 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
3056 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
3057 \catcode `\%=14
3058 \catcode 43=12
3059 \catcode`\"=12
3060 \catcode`\==12
3061 \catcode`\|=12
3062 \catcode`\<=12
3063 \catcode`\>=12
3064 \escapechar=`\\
3066 \let\~=\ptextilde
3067 \let\{=\ptexlbrace
3068 \let\}=\ptexrbrace
3069 \let\.=\ptexdot
3070 \let\*=\ptexstar
3071 \let\dots=\ptexdots
3072 \def\@{@}%
3073 \let\bullet=\ptexbullet
3074 \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
3075 \let\L=\ptexL
3077 \let\Etex=\endgroup}
3079 % Define @lisp ... @endlisp.
3080 % @lisp does a \begingroup so it can rebind things,
3081 % including the definition of @endlisp (which normally is erroneous).
3083 % Amount to narrow the margins by for @lisp.
3084 \newskip\lispnarrowing \lispnarrowing=0.4in
3086 % This is the definition that ^^M gets inside @lisp, @example, and other
3087 % such environments. \null is better than a space, since it doesn't
3088 % have any width.
3089 \def\lisppar{\null\endgraf}
3091 % Make each space character in the input produce a normal interword
3092 % space in the output. Don't allow a line break at this space, as this
3093 % is used only in environments like @example, where each line of input
3094 % should produce a line of output anyway.
3096 {\obeyspaces %
3097 \gdef\sepspaces{\obeyspaces\let =\tie}}
3099 % Define \obeyedspace to be our active space, whatever it is. This is
3100 % for use in \parsearg.
3101 {\sepspaces%
3102 \global\let\obeyedspace= }
3104 % This space is always present above and below environments.
3105 \newskip\envskipamount \envskipamount = 0pt
3107 % Make spacing and below environment symmetrical. We use \parskip here
3108 % to help in doing that, since in @example-like environments \parskip
3109 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
3110 % start of the next paragraph will insert \parskip
3112 \def\aboveenvbreak{{\advance\envskipamount by \parskip
3113 \endgraf \ifdim\lastskip<\envskipamount
3114 \removelastskip \penalty-50 \vskip\envskipamount \fi}}
3116 \let\afterenvbreak = \aboveenvbreak
3118 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3119 \let\nonarrowing=\relax
3121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3122 % \cartouche: draw rectangle w/rounded corners around argument
3123 \font\circle=lcircle10
3124 \newdimen\circthick
3125 \newdimen\cartouter\newdimen\cartinner
3126 \newskip\normbskip\newskip\normpskip\newskip\normlskip
3127 \circthick=\fontdimen8\circle
3129 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
3130 \def\ctr{{\hskip 6pt\circle\char'010}}
3131 \def\cbl{{\circle\char'012\hskip -6pt}}
3132 \def\cbr{{\hskip 6pt\circle\char'011}}
3133 \def\carttop{\hbox to \cartouter{\hskip\lskip
3134 \ctl\leaders\hrule height\circthick\hfil\ctr
3135 \hskip\rskip}}
3136 \def\cartbot{\hbox to \cartouter{\hskip\lskip
3137 \cbl\leaders\hrule height\circthick\hfil\cbr
3138 \hskip\rskip}}
3140 \newskip\lskip\newskip\rskip
3142 \long\def\cartouche{%
3143 \begingroup
3144 \lskip=\leftskip \rskip=\rightskip
3145 \leftskip=0pt\rightskip=0pt %we want these *outside*.
3146 \cartinner=\hsize \advance\cartinner by-\lskip
3147 \advance\cartinner by-\rskip
3148 \cartouter=\hsize
3149 \advance\cartouter by 18pt % allow for 3pt kerns on either
3150 % side, and for 6pt waste from
3151 % each corner char
3152 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
3153 % Flag to tell @lisp, etc., not to narrow margin.
3154 \let\nonarrowing=\comment
3155 \vbox\bgroup
3156 \baselineskip=0pt\parskip=0pt\lineskip=0pt
3157 \carttop
3158 \hbox\bgroup
3159 \hskip\lskip
3160 \vrule\kern3pt
3161 \vbox\bgroup
3162 \hsize=\cartinner
3163 \kern3pt
3164 \begingroup
3165 \baselineskip=\normbskip
3166 \lineskip=\normlskip
3167 \parskip=\normpskip
3168 \vskip -\parskip
3169 \def\Ecartouche{%
3170 \endgroup
3171 \kern3pt
3172 \egroup
3173 \kern3pt\vrule
3174 \hskip\rskip
3175 \egroup
3176 \cartbot
3177 \egroup
3178 \endgroup
3182 % This macro is called at the beginning of all the @example variants,
3183 % inside a group.
3184 \def\nonfillstart{%
3185 \aboveenvbreak
3186 \inENV % This group ends at the end of the body
3187 \hfuzz = 12pt % Don't be fussy
3188 \sepspaces % Make spaces be word-separators rather than space tokens.
3189 \singlespace
3190 \let\par = \lisppar % don't ignore blank lines
3191 \obeylines % each line of input is a line of output
3192 \parskip = 0pt
3193 \parindent = 0pt
3194 \emergencystretch = 0pt % don't try to avoid overfull boxes
3195 % @cartouche defines \nonarrowing to inhibit narrowing
3196 % at next level down.
3197 \ifx\nonarrowing\relax
3198 \advance \leftskip by \lispnarrowing
3199 \exdentamount=\lispnarrowing
3200 \let\exdent=\nofillexdent
3201 \let\nonarrowing=\relax
3205 % To ending an @example-like environment, we first end the paragraph
3206 % (via \afterenvbreak's vertical glue), and then the group. That way we
3207 % keep the zero \parskip that the environments set -- \parskip glue
3208 % will be inserted at the beginning of the next paragraph in the
3209 % document, after the environment.
3211 \def\nonfillfinish{\afterenvbreak\endgroup}%
3213 % This macro is
3214 \def\lisp{\begingroup
3215 \nonfillstart
3216 \let\Elisp = \nonfillfinish
3218 \rawbackslash % have \ input char produce \ char from current font
3219 \gobble
3222 % Define the \E... control sequence only if we are inside the
3223 % environment, so the error checking in \end will work.
3225 % We must call \lisp last in the definition, since it reads the
3226 % return following the @example (or whatever) command.
3228 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3229 \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3230 \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3232 % @smallexample and @smalllisp. This is not used unless the @smallbook
3233 % command is given. Originally contributed by Pavel@xerox.
3235 \def\smalllispx{\begingroup
3236 \nonfillstart
3237 \let\Esmalllisp = \nonfillfinish
3238 \let\Esmallexample = \nonfillfinish
3240 % Smaller interline space and fonts for small examples.
3241 \setleading{10pt}%
3242 \indexfonts \tt
3243 \rawbackslash % make \ output the \ character from the current font (tt)
3244 \gobble
3247 % This is @display; same as @lisp except use roman font.
3249 \def\display{\begingroup
3250 \nonfillstart
3251 \let\Edisplay = \nonfillfinish
3252 \gobble
3255 % This is @format; same as @display except don't narrow margins.
3257 \def\format{\begingroup
3258 \let\nonarrowing = t
3259 \nonfillstart
3260 \let\Eformat = \nonfillfinish
3261 \gobble
3264 % @flushleft (same as @format) and @flushright.
3266 \def\flushleft{\begingroup
3267 \let\nonarrowing = t
3268 \nonfillstart
3269 \let\Eflushleft = \nonfillfinish
3270 \gobble
3272 \def\flushright{\begingroup
3273 \let\nonarrowing = t
3274 \nonfillstart
3275 \let\Eflushright = \nonfillfinish
3276 \advance\leftskip by 0pt plus 1fill
3277 \gobble}
3279 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
3280 % and narrows the margins.
3282 \def\quotation{%
3283 \begingroup\inENV %This group ends at the end of the @quotation body
3284 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
3285 \singlespace
3286 \parindent=0pt
3287 % We have retained a nonzero parskip for the environment, since we're
3288 % doing normal filling. So to avoid extra space below the environment...
3289 \def\Equotation{\parskip = 0pt \nonfillfinish}%
3291 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3292 \ifx\nonarrowing\relax
3293 \advance\leftskip by \lispnarrowing
3294 \advance\rightskip by \lispnarrowing
3295 \exdentamount = \lispnarrowing
3296 \let\nonarrowing = \relax
3300 \message{defuns,}
3301 % Define formatter for defuns
3302 % First, allow user to change definition object font (\df) internally
3303 \def\setdeffont #1 {\csname DEF#1\endcsname}
3305 \newskip\defbodyindent \defbodyindent=.4in
3306 \newskip\defargsindent \defargsindent=50pt
3307 \newskip\deftypemargin \deftypemargin=12pt
3308 \newskip\deflastargmargin \deflastargmargin=18pt
3310 \newcount\parencount
3311 % define \functionparens, which makes ( and ) and & do special things.
3312 % \functionparens affects the group it is contained in.
3313 \def\activeparens{%
3314 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3315 \catcode`\[=\active \catcode`\]=\active}
3317 % Make control sequences which act like normal parenthesis chars.
3318 \let\lparen = ( \let\rparen = )
3320 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3322 % Be sure that we always have a definition for `(', etc. For example,
3323 % if the fn name has parens in it, \boldbrax will not be in effect yet,
3324 % so TeX would otherwise complain about undefined control sequence.
3325 \global\let(=\lparen \global\let)=\rparen
3326 \global\let[=\lbrack \global\let]=\rbrack
3328 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3329 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3331 % Definitions of (, ) and & used in args for functions.
3332 % This is the definition of ( outside of all parentheses.
3333 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
3334 \global\advance\parencount by 1 }
3336 % This is the definition of ( when already inside a level of parens.
3337 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
3339 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3340 % also in that case restore the outer-level definition of (.
3341 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3342 \global\advance \parencount by -1 }
3343 % If we encounter &foo, then turn on ()-hacking afterwards
3344 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
3346 \gdef\normalparens{\boldbrax\let&=\ampnr}
3347 } % End of definition inside \activeparens
3348 %% These parens (in \boldbrax) actually are a little bolder than the
3349 %% contained text. This is especially needed for [ and ]
3350 \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
3351 \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
3353 % First, defname, which formats the header line itself.
3354 % #1 should be the function name.
3355 % #2 should be the type of definition, such as "Function".
3357 \def\defname #1#2{%
3358 % Get the values of \leftskip and \rightskip as they were
3359 % outside the @def...
3360 \dimen2=\leftskip
3361 \advance\dimen2 by -\defbodyindent
3362 \dimen3=\rightskip
3363 \advance\dimen3 by -\defbodyindent
3364 \noindent %
3365 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3366 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3367 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3368 \parshape 2 0in \dimen0 \defargsindent \dimen1 %
3369 % Now output arg 2 ("Function" or some such)
3370 % ending at \deftypemargin from the right margin,
3371 % but stuck inside a box of width 0 so it does not interfere with linebreaking
3372 {% Adjust \hsize to exclude the ambient margins,
3373 % so that \rightline will obey them.
3374 \advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3375 \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3376 % Make all lines underfull and no complaints:
3377 \tolerance=10000 \hbadness=10000
3378 \advance\leftskip by -\defbodyindent
3379 \exdentamount=\defbodyindent
3380 {\df #1}\enskip % Generate function name
3383 % Actually process the body of a definition
3384 % #1 should be the terminating control sequence, such as \Edefun.
3385 % #2 should be the "another name" control sequence, such as \defunx.
3386 % #3 should be the control sequence that actually processes the header,
3387 % such as \defunheader.
3389 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3390 \medbreak %
3391 % Define the end token that this defining construct specifies
3392 % so that it will exit this group.
3393 \def#1{\endgraf\endgroup\medbreak}%
3394 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3395 \parindent=0in
3396 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3397 \exdentamount=\defbodyindent
3398 \begingroup %
3399 \catcode 61=\active % 61 is `='
3400 \obeylines\activeparens\spacesplit#3}
3402 \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3403 \medbreak %
3404 % Define the end token that this defining construct specifies
3405 % so that it will exit this group.
3406 \def#1{\endgraf\endgroup\medbreak}%
3407 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3408 \parindent=0in
3409 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3410 \exdentamount=\defbodyindent
3411 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3413 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3414 \medbreak %
3415 % Define the end token that this defining construct specifies
3416 % so that it will exit this group.
3417 \def#1{\endgraf\endgroup\medbreak}%
3418 \def#2##1 ##2 {\def#4{##1}%
3419 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3420 \parindent=0in
3421 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3422 \exdentamount=\defbodyindent
3423 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3425 % These parsing functions are similar to the preceding ones
3426 % except that they do not make parens into active characters.
3427 % These are used for "variables" since they have no arguments.
3429 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3430 \medbreak %
3431 % Define the end token that this defining construct specifies
3432 % so that it will exit this group.
3433 \def#1{\endgraf\endgroup\medbreak}%
3434 \def#2{\begingroup\obeylines\spacesplit#3}%
3435 \parindent=0in
3436 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3437 \exdentamount=\defbodyindent
3438 \begingroup %
3439 \catcode 61=\active %
3440 \obeylines\spacesplit#3}
3442 % This is used for \def{tp,vr}parsebody. It could probably be used for
3443 % some of the others, too, with some judicious conditionals.
3445 \def\parsebodycommon#1#2#3{%
3446 \begingroup\inENV %
3447 \medbreak %
3448 % Define the end token that this defining construct specifies
3449 % so that it will exit this group.
3450 \def#1{\endgraf\endgroup\medbreak}%
3451 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3452 \parindent=0in
3453 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3454 \exdentamount=\defbodyindent
3455 \begingroup\obeylines
3458 \def\defvrparsebody#1#2#3#4 {%
3459 \parsebodycommon{#1}{#2}{#3}%
3460 \spacesplit{#3{#4}}%
3463 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3464 % type is just `struct', because we lose the braces in `{struct
3465 % termios}' when \spacesplit reads its undelimited argument. Sigh.
3466 % \let\deftpparsebody=\defvrparsebody
3468 % So, to get around this, we put \empty in with the type name. That
3469 % way, TeX won't find exactly `{...}' as an undelimited argument, and
3470 % won't strip off the braces.
3472 \def\deftpparsebody #1#2#3#4 {%
3473 \parsebodycommon{#1}{#2}{#3}%
3474 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3477 % Fine, but then we have to eventually remove the \empty *and* the
3478 % braces (if any). That's what this does, putting the result in \tptemp.
3480 \def\removeemptybraces\empty#1\relax{\def\tptemp{#1}}%
3482 % After \spacesplit has done its work, this is called -- #1 is the final
3483 % thing to call, #2 the type name (which starts with \empty), and #3
3484 % (which might be empty) the arguments.
3486 \def\parsetpheaderline#1#2#3{%
3487 \removeemptybraces#2\relax
3488 #1{\tptemp}{#3}%
3491 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3492 \medbreak %
3493 % Define the end token that this defining construct specifies
3494 % so that it will exit this group.
3495 \def#1{\endgraf\endgroup\medbreak}%
3496 \def#2##1 ##2 {\def#4{##1}%
3497 \begingroup\obeylines\spacesplit{#3{##2}}}%
3498 \parindent=0in
3499 \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3500 \exdentamount=\defbodyindent
3501 \begingroup\obeylines\spacesplit{#3{#5}}}
3503 % Split up #2 at the first space token.
3504 % call #1 with two arguments:
3505 % the first is all of #2 before the space token,
3506 % the second is all of #2 after that space token.
3507 % If #2 contains no space token, all of it is passed as the first arg
3508 % and the second is passed as empty.
3510 {\obeylines
3511 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3512 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3513 \ifx\relax #3%
3514 #1{#2}{}\else #1{#2}{#3#4}\fi}}
3516 % So much for the things common to all kinds of definitions.
3518 % Define @defun.
3520 % First, define the processing that is wanted for arguments of \defun
3521 % Use this to expand the args and terminate the paragraph they make up
3523 \def\defunargs #1{\functionparens \sl
3524 % Expand, preventing hyphenation at `-' chars.
3525 % Note that groups don't affect changes in \hyphenchar.
3526 \hyphenchar\tensl=0
3528 \hyphenchar\tensl=45
3529 \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
3530 \interlinepenalty=10000
3531 \advance\rightskip by 0pt plus 1fil
3532 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3535 \def\deftypefunargs #1{%
3536 % Expand, preventing hyphenation at `-' chars.
3537 % Note that groups don't affect changes in \hyphenchar.
3538 \functionparens
3539 \tclose{#1}% avoid \code because of side effects on active chars
3540 \interlinepenalty=10000
3541 \advance\rightskip by 0pt plus 1fil
3542 \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3545 % Do complete processing of one @defun or @defunx line already parsed.
3547 % @deffn Command forward-char nchars
3549 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
3551 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
3552 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
3553 \catcode 61=\other % Turn off change made in \defparsebody
3556 % @defun == @deffn Function
3558 \def\defun{\defparsebody\Edefun\defunx\defunheader}
3560 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3561 \begingroup\defname {#1}{Function}%
3562 \defunargs {#2}\endgroup %
3563 \catcode 61=\other % Turn off change made in \defparsebody
3566 % @deftypefun int foobar (int @var{foo}, float @var{bar})
3568 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
3570 % #1 is the data type. #2 is the name and args.
3571 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
3572 % #1 is the data type, #2 the name, #3 the args.
3573 \def\deftypefunheaderx #1#2 #3\relax{%
3574 \doind {fn}{\code{#2}}% Make entry in function index
3575 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Function}%
3576 \deftypefunargs {#3}\endgroup %
3577 \catcode 61=\other % Turn off change made in \defparsebody
3580 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
3582 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
3584 % \defheaderxcond#1\relax$$$
3585 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
3586 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
3588 % #1 is the classification. #2 is the data type. #3 is the name and args.
3589 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
3590 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
3591 \def\deftypefnheaderx #1#2#3 #4\relax{%
3592 \doind {fn}{\code{#3}}% Make entry in function index
3593 \begingroup
3594 \normalparens % notably, turn off `&' magic, which prevents
3595 % at least some C++ text from working
3596 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
3597 \deftypefunargs {#4}\endgroup %
3598 \catcode 61=\other % Turn off change made in \defparsebody
3601 % @defmac == @deffn Macro
3603 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
3605 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3606 \begingroup\defname {#1}{Macro}%
3607 \defunargs {#2}\endgroup %
3608 \catcode 61=\other % Turn off change made in \defparsebody
3611 % @defspec == @deffn Special Form
3613 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
3615 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3616 \begingroup\defname {#1}{Special Form}%
3617 \defunargs {#2}\endgroup %
3618 \catcode 61=\other % Turn off change made in \defparsebody
3621 % This definition is run if you use @defunx
3622 % anywhere other than immediately after a @defun or @defunx.
3624 \def\deffnx #1 {\errmessage{@deffnx in invalid context}}
3625 \def\defunx #1 {\errmessage{@defunx in invalid context}}
3626 \def\defmacx #1 {\errmessage{@defmacx in invalid context}}
3627 \def\defspecx #1 {\errmessage{@defspecx in invalid context}}
3628 \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
3629 \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
3631 % @defmethod, and so on
3633 % @defop {Funny Method} foo-class frobnicate argument
3635 \def\defop #1 {\def\defoptype{#1}%
3636 \defopparsebody\Edefop\defopx\defopheader\defoptype}
3638 \def\defopheader #1#2#3{%
3639 \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
3640 \begingroup\defname {#2}{\defoptype{} on #1}%
3641 \defunargs {#3}\endgroup %
3644 % @defmethod == @defop Method
3646 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
3648 \def\defmethodheader #1#2#3{%
3649 \dosubind {fn}{\code{#2}}{on #1}% entry in function index
3650 \begingroup\defname {#2}{Method on #1}%
3651 \defunargs {#3}\endgroup %
3654 % @defcv {Class Option} foo-class foo-flag
3656 \def\defcv #1 {\def\defcvtype{#1}%
3657 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
3659 \def\defcvarheader #1#2#3{%
3660 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3661 \begingroup\defname {#2}{\defcvtype{} of #1}%
3662 \defvarargs {#3}\endgroup %
3665 % @defivar == @defcv {Instance Variable}
3667 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
3669 \def\defivarheader #1#2#3{%
3670 \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3671 \begingroup\defname {#2}{Instance Variable of #1}%
3672 \defvarargs {#3}\endgroup %
3675 % These definitions are run if you use @defmethodx, etc.,
3676 % anywhere other than immediately after a @defmethod, etc.
3678 \def\defopx #1 {\errmessage{@defopx in invalid context}}
3679 \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
3680 \def\defcvx #1 {\errmessage{@defcvx in invalid context}}
3681 \def\defivarx #1 {\errmessage{@defivarx in invalid context}}
3683 % Now @defvar
3685 % First, define the processing that is wanted for arguments of @defvar.
3686 % This is actually simple: just print them in roman.
3687 % This must expand the args and terminate the paragraph they make up
3688 \def\defvarargs #1{\normalparens #1%
3689 \interlinepenalty=10000
3690 \endgraf\penalty 10000\vskip -\parskip\penalty 10000}
3692 % @defvr Counter foo-count
3694 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
3696 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
3697 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
3699 % @defvar == @defvr Variable
3701 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
3703 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3704 \begingroup\defname {#1}{Variable}%
3705 \defvarargs {#2}\endgroup %
3708 % @defopt == @defvr {User Option}
3710 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
3712 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3713 \begingroup\defname {#1}{User Option}%
3714 \defvarargs {#2}\endgroup %
3717 % @deftypevar int foobar
3719 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
3721 % #1 is the data type. #2 is the name.
3722 \def\deftypevarheader #1#2{%
3723 \doind {vr}{\code{#2}}% Make entry in variables index
3724 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{Variable}%
3725 \interlinepenalty=10000
3726 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3727 \endgroup}
3729 % @deftypevr {Global Flag} int enable
3731 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
3733 \def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
3734 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
3735 \interlinepenalty=10000
3736 \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3737 \endgroup}
3739 % This definition is run if you use @defvarx
3740 % anywhere other than immediately after a @defvar or @defvarx.
3742 \def\defvrx #1 {\errmessage{@defvrx in invalid context}}
3743 \def\defvarx #1 {\errmessage{@defvarx in invalid context}}
3744 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
3745 \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
3746 \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
3748 % Now define @deftp
3749 % Args are printed in bold, a slight difference from @defvar.
3751 \def\deftpargs #1{\bf \defvarargs{#1}}
3753 % @deftp Class window height width ...
3755 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
3757 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
3758 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
3760 % This definition is run if you use @deftpx, etc
3761 % anywhere other than immediately after a @deftp, etc.
3763 \def\deftpx #1 {\errmessage{@deftpx in invalid context}}
3765 \message{cross reference,}
3766 % Define cross-reference macros
3767 \newwrite \auxfile
3769 \newif\ifhavexrefs % True if xref values are known.
3770 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
3772 % \setref{foo} defines a cross-reference point named foo.
3774 \def\setref#1{%
3775 \dosetq{#1-title}{Ytitle}%
3776 \dosetq{#1-pg}{Ypagenumber}%
3777 \dosetq{#1-snt}{Ysectionnumberandtype}}
3779 \def\unnumbsetref#1{%
3780 \dosetq{#1-title}{Ytitle}%
3781 \dosetq{#1-pg}{Ypagenumber}%
3782 \dosetq{#1-snt}{Ynothing}}
3784 \def\appendixsetref#1{%
3785 \dosetq{#1-title}{Ytitle}%
3786 \dosetq{#1-pg}{Ypagenumber}%
3787 \dosetq{#1-snt}{Yappendixletterandtype}}
3789 % \xref, \pxref, and \ref generate cross-references to specified points.
3790 % For \xrefX, #1 is the node name, #2 the name of the Info
3791 % cross-reference, #3 the printed node name, #4 the name of the Info
3792 % file, #5 the name of the printed manual. All but the node name can be
3793 % omitted.
3795 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
3796 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
3797 \def\ref#1{\xrefX[#1,,,,,,,]}
3798 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
3799 \def\printedmanual{\ignorespaces #5}%
3800 \def\printednodename{\ignorespaces #3}%
3801 \setbox1=\hbox{\printedmanual}%
3802 \setbox0=\hbox{\printednodename}%
3803 \ifdim \wd0 = 0pt
3804 % No printed node name was explicitly given.
3805 \ifx\SETxref-automatic-section-title\relax %
3806 % Use the actual chapter/section title appear inside
3807 % the square brackets. Use the real section title if we have it.
3808 \ifdim \wd1>0pt%
3809 % It is in another manual, so we don't have it.
3810 \def\printednodename{\ignorespaces #1}%
3811 \else
3812 \ifhavexrefs
3813 % We know the real title if we have the xref values.
3814 \def\printednodename{\refx{#1-title}}%
3815 \else
3816 % Otherwise just copy the Info node name.
3817 \def\printednodename{\ignorespaces #1}%
3818 \fi%
3820 \def\printednodename{#1-title}%
3821 \else
3822 % Use the node name inside the square brackets.
3823 \def\printednodename{\ignorespaces #1}%
3827 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
3828 % insert empty discretionaries after hyphens, which means that it will
3829 % not find a line break at a hyphen in a node names. Since some manuals
3830 % are best written with fairly long node names, containing hyphens, this
3831 % is a loss. Therefore, we give the text of the node name again, so it
3832 % is as if TeX is seeing it for the first time.
3833 \ifdim \wd1 > 0pt
3834 \putwordsection{} ``\printednodename'' in \cite{\printedmanual}%
3835 \else
3836 % _ (for example) has to be the character _ for the purposes of the
3837 % control sequence corresponding to the node, but it has to expand
3838 % into the usual \leavevmode...\vrule stuff for purposes of
3839 % printing. So we \turnoffactive for the \refx-snt, back on for the
3840 % printing, back off for the \refx-pg.
3841 {\turnoffactive \refx{#1-snt}{}}%
3842 \space [\printednodename],\space
3843 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
3845 \endgroup}
3847 % \dosetq is the interface for calls from other macros
3849 % Use \turnoffactive so that punctuation chars such as underscore
3850 % work in node names.
3851 \def\dosetq #1#2{{\let\folio=0 \turnoffactive%
3852 \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
3853 \next}}
3855 % \internalsetq {foo}{page} expands into
3856 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
3857 % When the aux file is read, ' is the escape character
3859 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
3861 % Things to be expanded by \internalsetq
3863 \def\Ypagenumber{\folio}
3865 \def\Ytitle{\thissection}
3867 \def\Ynothing{}
3869 \def\Ysectionnumberandtype{%
3870 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno %
3871 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno %
3872 \else \ifnum \subsubsecno=0 %
3873 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno %
3874 \else %
3875 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
3876 \fi \fi \fi }
3878 \def\Yappendixletterandtype{%
3879 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}%
3880 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno %
3881 \else \ifnum \subsubsecno=0 %
3882 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
3883 \else %
3884 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
3885 \fi \fi \fi }
3887 \gdef\xreftie{'tie}
3889 % Use TeX 3.0's \inputlineno to get the line number, for better error
3890 % messages, but if we're using an old version of TeX, don't do anything.
3892 \ifx\inputlineno\thisisundefined
3893 \let\linenumber = \empty % Non-3.0.
3894 \else
3895 \def\linenumber{\the\inputlineno:\space}
3898 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
3899 % If its value is nonempty, SUFFIX is output afterward.
3901 \def\refx#1#2{%
3902 \expandafter\ifx\csname X#1\endcsname\relax
3903 % If not defined, say something at least.
3904 $\langle$un\-de\-fined$\rangle$%
3905 \ifhavexrefs
3906 \message{\linenumber Undefined cross reference `#1'.}%
3907 \else
3908 \ifwarnedxrefs\else
3909 \global\warnedxrefstrue
3910 \message{Cross reference values unknown; you must run TeX again.}%
3913 \else
3914 % It's defined, so just use it.
3915 \csname X#1\endcsname
3917 #2% Output the suffix in any case.
3920 % Read the last existing aux file, if any. No error if none exists.
3922 % This is the macro invoked by entries in the aux file.
3923 \def\xrdef #1#2{
3924 {\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
3926 \def\readauxfile{%
3927 \begingroup
3928 \catcode `\^^@=\other
3929 \catcode `\\x01=\other
3930 \catcode `\\x02=\other
3931 \catcode `\^^C=\other
3932 \catcode `\^^D=\other
3933 \catcode `\^^E=\other
3934 \catcode `\^^F=\other
3935 \catcode `\^^G=\other
3936 \catcode `\^^H=\other
3937 \catcode `\\v=\other
3938 \catcode `\^^L=\other
3939 \catcode `\\x0e=\other
3940 \catcode `\\x0f=\other
3941 \catcode `\\x10=\other
3942 \catcode `\\x11=\other
3943 \catcode `\\x12=\other
3944 \catcode `\\x13=\other
3945 \catcode `\\x14=\other
3946 \catcode `\\x15=\other
3947 \catcode `\\x16=\other
3948 \catcode `\\x17=\other
3949 \catcode `\\x18=\other
3950 \catcode `\\x19=\other
3951 \catcode 26=\other
3952 \catcode `\^^[=\other
3953 \catcode `\^^\=\other
3954 \catcode `\^^]=\other
3955 \catcode `\^^^=\other
3956 \catcode `\^^_=\other
3957 \catcode `\@=\other
3958 \catcode `\^=\other
3959 \catcode `\~=\other
3960 \catcode `\[=\other
3961 \catcode `\]=\other
3962 \catcode`\"=\other
3963 \catcode`\_=\other
3964 \catcode`\|=\other
3965 \catcode`\<=\other
3966 \catcode`\>=\other
3967 \catcode `\$=\other
3968 \catcode `\#=\other
3969 \catcode `\&=\other
3970 % `\+ does not work, so use 43.
3971 \catcode 43=\other
3972 % Make the characters 128-255 be printing characters
3974 \count 1=128
3975 \def\loop{%
3976 \catcode\count 1=\other
3977 \advance\count 1 by 1
3978 \ifnum \count 1<256 \loop \fi
3981 % the aux file uses ' as the escape.
3982 % Turn off \ as an escape so we do not lose on
3983 % entries which were dumped with control sequences in their names.
3984 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
3985 % Reference to such entries still does not work the way one would wish,
3986 % but at least they do not bomb out when the aux file is read in.
3987 \catcode `\{=1 \catcode `\}=2
3988 \catcode `\%=\other
3989 \catcode `\'=0
3990 \catcode `\\=\other
3991 \openin 1 \jobname.aux
3992 \ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
3993 \global\warnedobstrue
3995 % Open the new aux file. Tex will close it automatically at exit.
3996 \openout \auxfile=\jobname.aux
3997 \endgroup}
4000 % Footnotes.
4002 \newcount \footnoteno
4004 % The trailing space in the following definition for supereject is
4005 % vital for proper filling; pages come out unaligned when you do a
4006 % pagealignmacro call if that space before the closing brace is
4007 % removed.
4008 \def\supereject{\par\penalty -20000\footnoteno =0 }
4010 % @footnotestyle is meaningful for info output only..
4011 \let\footnotestyle=\comment
4013 \let\ptexfootnote=\footnote
4015 {\catcode `\@=11
4017 % Auto-number footnotes. Otherwise like plain.
4018 \gdef\footnote{%
4019 \global\advance\footnoteno by \@ne
4020 \edef\thisfootno{$^{\the\footnoteno}$}%
4022 % In case the footnote comes at the end of a sentence, preserve the
4023 % extra spacing after we do the footnote number.
4024 \let\@sf\empty
4025 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
4027 % Remove inadvertent blank space before typesetting the footnote number.
4028 \unskip
4029 \thisfootno\@sf
4030 \footnotezzz
4033 % Don't bother with the trickery in plain.tex to not require the
4034 % footnote text as a parameter. Our footnotes don't need to be so general.
4036 \long\gdef\footnotezzz#1{\insert\footins{%
4037 % We want to typeset this text as a normal paragraph, even if the
4038 % footnote reference occurs in (for example) a display environment.
4039 % So reset some parameters.
4040 \interlinepenalty\interfootnotelinepenalty
4041 \splittopskip\ht\strutbox % top baseline for broken footnotes
4042 \splitmaxdepth\dp\strutbox
4043 \floatingpenalty\@MM
4044 \leftskip\z@skip
4045 \rightskip\z@skip
4046 \spaceskip\z@skip
4047 \xspaceskip\z@skip
4048 \parindent\defaultparindent
4050 % Hang the footnote text off the number.
4051 \hang
4052 \textindent{\thisfootno}%
4054 % Don't crash into the line above the footnote text. Since this
4055 % expands into a box, it must come within the paragraph, lest it
4056 % provide a place where TeX can split the footnote.
4057 \footstrut
4058 #1\strut}%
4061 }%end \catcode `\@=11
4063 % Set the baselineskip to #1, and the lineskip and strut size
4064 % correspondingly. There is no deep meaning behind these magic numbers
4065 % used as factors; they just match (closely enough) what Knuth defined.
4067 \def\lineskipfactor{.08333}
4068 \def\strutheightpercent{.70833}
4069 \def\strutdepthpercent {.29167}
4071 \def\setleading#1{%
4072 \normalbaselineskip = #1\relax
4073 \normallineskip = \lineskipfactor\normalbaselineskip
4074 \normalbaselines
4075 \setbox\strutbox =\hbox{%
4076 \vrule width0pt height\strutheightpercent\baselineskip
4077 depth \strutdepthpercent \baselineskip
4081 % @| inserts a changebar to the left of the current line. It should
4082 % surround any changed text. This approach does *not* work if the
4083 % change spans more than two lines of output. To handle that, we would
4084 % have adopt a much more difficult approach (putting marks into the main
4085 % vertical list for the beginning and end of each change).
4087 \def\|{%
4088 % \vadjust can only be used in horizontal mode.
4089 \leavevmode
4091 % Append this vertical mode material after the current line in the output.
4092 \vadjust{%
4093 % We want to insert a rule with the height and depth of the current
4094 % leading; that is exactly what \strutbox is supposed to record.
4095 \vskip-\baselineskip
4097 % \vadjust-items are inserted at the left edge of the type. So
4098 % the \llap here moves out into the left-hand margin.
4099 \llap{%
4101 % For a thicker or thinner bar, change the `1pt'.
4102 \vrule height\baselineskip width1pt
4104 % This is the space between the bar and the text.
4105 \hskip 12pt
4110 % For a final copy, take out the rectangles
4111 % that mark overfull boxes (in case you have decided
4112 % that the text looks ok even though it passes the margin).
4114 \def\finalout{\overfullrule=0pt}
4117 % End of control word definitions.
4119 \message{and turning on texinfo input format.}
4121 \def\openindices{%
4122 \newindex{cp}%
4123 \newcodeindex{fn}%
4124 \newcodeindex{vr}%
4125 \newcodeindex{tp}%
4126 \newcodeindex{ky}%
4127 \newcodeindex{pg}%
4130 % Set some numeric style parameters, for 8.5 x 11 format.
4132 %\hsize = 6.5in
4133 \newdimen\defaultparindent \defaultparindent = 15pt
4134 \parindent = \defaultparindent
4135 \parskip 18pt plus 1pt
4136 \setleading{15pt}
4137 \advance\topskip by 1.2cm
4139 % Prevent underfull vbox error messages.
4140 \vbadness=10000
4142 % Following George Bush, just get rid of widows and orphans.
4143 \widowpenalty=10000
4144 \clubpenalty=10000
4146 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4147 % using an old version of TeX, don't do anything. We want the amount of
4148 % stretch added to depend on the line length, hence the dependence on
4149 % \hsize. This makes it come to about 9pt for the 8.5x11 format.
4151 \ifx\emergencystretch\thisisundefined
4152 % Allow us to assign to \emergencystretch anyway.
4153 \def\emergencystretch{\dimen0}%
4154 \else
4155 \emergencystretch = \hsize
4156 \divide\emergencystretch by 45
4159 % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4160 \def\smallbook{
4162 % These values for secheadingskip and subsecheadingskip are
4163 % experiments. RJC 7 Aug 1992
4164 \global\secheadingskip = 17pt plus 6pt minus 3pt
4165 \global\subsecheadingskip = 14pt plus 6pt minus 3pt
4167 \global\lispnarrowing = 0.3in
4168 \setleading{12pt}
4169 \advance\topskip by -1cm
4170 \global\parskip 3pt plus 1pt
4171 \global\hsize = 5in
4172 \global\vsize=7.5in
4173 \global\tolerance=700
4174 \global\hfuzz=1pt
4175 \global\contentsrightmargin=0pt
4176 \global\deftypemargin=0pt
4177 \global\defbodyindent=.5cm
4179 \global\pagewidth=\hsize
4180 \global\pageheight=\vsize
4182 \global\let\smalllisp=\smalllispx
4183 \global\let\smallexample=\smalllispx
4184 \global\def\Esmallexample{\Esmalllisp}
4187 % Use @afourpaper to print on European A4 paper.
4188 \def\afourpaper{
4189 \global\tolerance=700
4190 \global\hfuzz=1pt
4191 \setleading{12pt}
4192 \global\parskip 15pt plus 1pt
4194 \global\vsize= 53\baselineskip
4195 \advance\vsize by \topskip
4196 %\global\hsize= 5.85in % A4 wide 10pt
4197 \global\hsize= 6.5in
4198 \global\outerhsize=\hsize
4199 \global\advance\outerhsize by 0.5in
4200 \global\outervsize=\vsize
4201 \global\advance\outervsize by 0.6in
4203 \global\pagewidth=\hsize
4204 \global\pageheight=\vsize
4207 % Allow control of the text dimensions. Parameters in order: textheight;
4208 % textwidth; \voffset; \hoffset (!); binding offset. All require a dimension;
4209 % header is additional; added length extends the bottom of the page.
4211 \def\changepagesizes#1#2#3#4#5
4212 {\global\vsize= #1
4213 \advance\vsize by \topskip
4214 \global\voffset= #3
4215 \global\hsize= #2
4216 \global\outerhsize=\hsize
4217 \global\advance\outerhsize by 0.5in
4218 \global\outervsize=\vsize
4219 \global\advance\outervsize by 0.6in
4220 \global\pagewidth=\hsize
4221 \global\pageheight=\vsize
4222 \global\normaloffset= #4
4223 \global\bindingoffset= #5}
4225 % This layout is compatible with Latex on A4 paper.
4227 \def\afourlatex{\changepagesizes{22cm}{15cm}{7mm}{4.6mm}{5mm}}
4229 % Define macros to output various characters with catcode for normal text.
4230 \catcode`\"=\other
4231 \catcode`\~=\other
4232 \catcode`\^=\other
4233 \catcode`\_=\other
4234 \catcode`\|=\other
4235 \catcode`\<=\other
4236 \catcode`\>=\other
4237 \catcode`\+=\other
4238 \def\normaldoublequote{"}
4239 \def\normaltilde{~}
4240 \def\normalcaret{^}
4241 \def\normalunderscore{_}
4242 \def\normalverticalbar{|}
4243 \def\normalless{<}
4244 \def\normalgreater{>}
4245 \def\normalplus{+}
4247 % This macro is used to make a character print one way in ttfont
4248 % where it can probably just be output, and another way in other fonts,
4249 % where something hairier probably needs to be done.
4251 % #1 is what to print if we are indeed using \tt; #2 is what to print
4252 % otherwise. Since all the Computer Modern typewriter fonts have zero
4253 % interword stretch (and shrink), and it is reasonable to expect all
4254 % typewriter fonts to have this, we can check that font parameter.
4256 \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
4258 % Turn off all special characters except @
4259 % (and those which the user can use as if they were ordinary).
4260 % Most of these we simply print from the \tt font, but for some, we can
4261 % use math or other variants that look better in normal text.
4263 \catcode`\"=\active
4264 \def\activedoublequote{{\tt \char '042}}
4265 \let"=\activedoublequote
4266 \catcode`\~=\active
4267 \def~{{\tt \char '176}}
4268 \chardef\hat=`\^
4269 \catcode`\^=\active
4270 \def^{{\tt \hat}}
4272 \catcode`\_=\active
4273 \def_{\ifusingtt\normalunderscore\_}
4274 % Subroutine for the previous macro.
4275 \def\_{\lvvmode \kern.06em \vbox{\hrule width.3em height.1ex}}
4277 % \lvvmode is equivalent in function to \leavevmode.
4278 % Using \leavevmode runs into trouble when written out to
4279 % an index file due to the expansion of \leavevmode into ``\unhbox
4280 % \voidb@x'' ---which looks to TeX like ``\unhbox \voidb\x'' due to our
4281 % magic tricks with @.
4282 \def\lvvmode{\vbox to 0pt{}}
4284 \catcode`\|=\active
4285 \def|{{\tt \char '174}}
4286 \chardef \less=`\<
4287 \catcode`\<=\active
4288 \def<{{\tt \less}}
4289 \chardef \gtr=`\>
4290 \catcode`\>=\active
4291 \def>{{\tt \gtr}}
4292 \catcode`\+=\active
4293 \def+{{\tt \char 43}}
4294 %\catcode 27=\active
4295 %\def^^[{$\diamondsuit$}
4297 % Set up an active definition for =, but don't enable it most of the time.
4298 {\catcode`\==\active
4299 \global\def={{\tt \char 61}}}
4301 \catcode`\@=0
4303 % \rawbackslashxx output one backslash character in current font
4304 \global\chardef\rawbackslashxx=`\\
4305 %{\catcode`\\=\other
4306 %@gdef@rawbackslashxx{\}}
4308 % \rawbackslash redefines \ as input to do \rawbackslashxx.
4309 {\catcode`\\=\active
4310 @gdef@rawbackslash{@let\=@rawbackslashxx }}
4312 % \normalbackslash outputs one backslash in fixed width font.
4313 \def\normalbackslash{{\tt\rawbackslashxx}}
4315 % Say @foo, not \foo, in error messages.
4316 \escapechar=`\@
4318 % \catcode 17=0 % Define control-q
4319 \catcode`\\=\active
4321 % Used sometimes to turn off (effectively) the active characters
4322 % even after parsing them.
4323 @def@turnoffactive{@let"=@normaldoublequote
4324 @let\=@realbackslash
4325 @let~=@normaltilde
4326 @let^=@normalcaret
4327 @let_=@normalunderscore
4328 @let|=@normalverticalbar
4329 @let<=@normalless
4330 @let>=@normalgreater
4331 @let+=@normalplus}
4333 @def@normalturnoffactive{@let"=@normaldoublequote
4334 @let\=@normalbackslash
4335 @let~=@normaltilde
4336 @let^=@normalcaret
4337 @let_=@normalunderscore
4338 @let|=@normalverticalbar
4339 @let<=@normalless
4340 @let>=@normalgreater
4341 @let+=@normalplus}
4343 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4344 % That is what \eatinput is for; after that, the `\' should revert to printing
4345 % a backslash.
4347 @gdef@eatinput input texinfo{@fixbackslash}
4348 @global@let\ = @eatinput
4350 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
4351 % the first `\{ in the file would cause an error. This macro tries to fix
4352 % that, assuming it is called before the first `\' could plausibly occur.
4354 @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi}
4356 %% These look ok in all fonts, so just make them not special. The @rm below
4357 %% makes sure that the current font starts out as the newly loaded cmr10
4358 @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4360 @textfonts
4363 @c Local variables:
4364 @c page-delimiter: "^\\\\message"
4365 @c End: