1 %% TeX macros to handle Texinfo files.
2 %% $Id: texinfo.tex,v 1.1 1997/08/11 15:57:14 law Exp $
4 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93,
5 % 94, 95, 96, 97 Free Software Foundation, Inc.
7 %This texinfo.tex file is free software; you can redistribute it and/or
8 %modify it under the terms of the GNU General Public License as
9 %published by the Free Software Foundation; either version 2, or (at
10 %your option) any later version.
12 %This texinfo.tex file is distributed in the hope that it will be
13 %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
14 %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 %General Public License for more details.
17 %You should have received a copy of the GNU General Public License
18 %along with this texinfo.tex file; see the file COPYING. If not, write
19 %to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 %Boston, MA 02111-1307, USA.
23 %In other words, you are welcome to use, share and improve this program.
24 %You are forbidden to forbid anyone else to use, share and improve
25 %what you give them. Help stamp out software-hoarding!
28 % Send bug reports to bug-texinfo@prep.ai.mit.edu.
29 % Please include a *precise* test case in each bug report.
32 % Make it possible to create a .fmt file just by loading this file:
33 % if the underlying format is not loaded, start by loading it now.
34 % Added by gildea November 1993.
35 \expandafter\ifx\csname fmtname
\endcsname\relax\input plain
\fi
37 % This automatically updates the version number based on RCS.
38 \def\deftexinfoversion$
#1:
#2 $
{\def\texinfoversion{#2}}
39 \deftexinfoversion$Revision:
1.1 $
40 \message{Loading texinfo package
[Version
\texinfoversion]:
}
42 % If in a .fmt file, print the version number
43 % and turn on active characters that we couldn't do earlier because
44 % they might have appeared in the input file name.
45 \everyjob{\message{[Texinfo version
\texinfoversion]}\message{}
46 \catcode`+=
\active \catcode`
\_=
\active}
48 % Save some parts of plain tex whose names we will redefine.
51 \let\ptexbullet=
\bullet
57 \let\ptexequiv =
\equiv
64 % Be sure we're in horizontal mode when doing a tie, since we make space
65 % equivalent to this in @example-like environments. Otherwise, a space
66 % at the beginning of a line will start with \penalty -- and
67 % since \penalty is valid in vertical mode, we'd end up putting the
68 % penalty on the vertical list instead of in the new paragraph.
70 % Avoid using \@M directly, because that causes trouble
71 % if the definition is written into an index file.
72 \global\let\tiepenalty = \@M
73 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
80 % If this character appears in an error message or help string, it
81 % starts a new line in the output.
84 % Set up fixed words for English.
85 \ifx\putwordChapter\undefined{\gdef\putwordChapter{Chapter
}}\fi%
86 \def\putwordInfo{Info
}%
87 \ifx\putwordSee\undefined{\gdef\putwordSee{See
}}\fi%
88 \ifx\putwordsee\undefined{\gdef\putwordsee{see
}}\fi%
89 \ifx\putwordfile\undefined{\gdef\putwordfile{file
}}\fi%
90 \ifx\putwordpage\undefined{\gdef\putwordpage{page
}}\fi%
91 \ifx\putwordsection\undefined{\gdef\putwordsection{section
}}\fi%
92 \ifx\putwordSection\undefined{\gdef\putwordSection{Section
}}\fi%
93 \ifx\putwordTableofContents\undefined{\gdef\putwordTableofContents{Table of Contents
}}\fi%
94 \ifx\putwordShortContents\undefined{\gdef\putwordShortContents{Short Contents
}}\fi%
95 \ifx\putwordAppendix\undefined{\gdef\putwordAppendix{Appendix
}}\fi%
101 \hyphenation{ap-pen-dix
}
102 \hyphenation{mini-buf-fer mini-buf-fers
}
104 \hyphenation{white-space
}
106 % Margin to add to right of even pages, to left of odd pages.
107 \newdimen \bindingoffset
108 \newdimen \normaloffset
109 \newdimen\pagewidth \newdimen\pageheight
111 % Sometimes it is convenient to have everything in the transcript file
112 % and nothing on the terminal. We don't just call \tracingall here,
113 % since that produces some useless output on the terminal.
115 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
116 \def\loggingall{\tracingcommands2 \tracingstats2
117 \tracingpages1 \tracingoutput1 \tracinglostchars1
118 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
119 \showboxbreadth\maxdimen\showboxdepth\maxdimen
122 % For @cropmarks command.
123 % Do @cropmarks to get crop marks.
126 \let\cropmarks =
\cropmarkstrue
128 % Dimensions to add cropmarks at corners.
129 % Added by P. A. MacKay, 12 Nov. 1986
131 \newdimen\cornerlong \newdimen\cornerthick
132 \newdimen\topandbottommargin
133 \newdimen\outerhsize \newdimen\outervsize
134 \cornerlong=
1pc
\cornerthick=
.3pt
% These set size of cropmarks
137 % Alternative @smallbook page size is 9.25in
139 \topandbottommargin=
.75in
141 % Main output routine.
143 \output =
{\onepageout{\pagecontents\PAGE}}
148 % \onepageout takes a vbox as an argument. Note that \pagecontents
149 % does insertions, but you have to call it yourself.
151 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
153 \ifodd\pageno \advance\hoffset by
\bindingoffset
154 \else \advance\hoffset by -
\bindingoffset\fi
156 % Do this outside of the \shipout so @code etc. will be expanded in
157 % the headline as they should be, not taken literally (outputting ''code).
158 \setbox\headlinebox =
\vbox{\let\hsize=
\pagewidth \makeheadline}%
159 \setbox\footlinebox =
\vbox{\let\hsize=
\pagewidth \makefootline}%
162 % Have to do this stuff outside the \shipout because we want it to
163 % take effect in \write's, yet the group defined by the \vbox ends
164 % before the \shipout runs.
166 \escapechar = `\\
% use backslash in output files.
167 \indexdummies % don't expand commands in the output.
168 \normalturnoffactive % \ in index entries must not stay \, e.g., if
169 % the page break happens to be in the middle of an example.
171 \ifcropmarks \vbox to
\outervsize\bgroup
173 \line{\ewtop\hfil\ewtop}%
176 \vbox{\moveleft\cornerthick\nstop}%
178 \vbox{\moveright\cornerthick\nstop}%
180 \vskip\topandbottommargin
182 \hfil % center the page within the outer (page) hsize.
183 \ifodd\pageno\hskip\bindingoffset\fi
189 \ifdim\ht\footlinebox >
0pt
190 % Only leave this space if the footline is nonempty.
191 % (We lessened \vsize for it in \oddfootingxxx.)
192 % The \baselineskip=24pt in plain's \makefootline has no effect.
193 \vskip 2\baselineskip
198 \egroup % end of \vbox\bgroup
199 \hfil\egroup % end of (centering) \line\bgroup
200 \vskip\topandbottommargin plus1fill minus1fill
201 \boxmaxdepth =
\cornerthick
203 \vbox{\moveleft\cornerthick\nsbot}%
205 \vbox{\moveright\cornerthick\nsbot}%
208 \line{\ewbot\hfil\ewbot}%
209 \egroup % \vbox from first cropmarks clause
211 }% end of \shipout\vbox
212 }% end of group with \turnoffactive
214 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
217 \newinsert\margin \dimen\margin=
\maxdimen
219 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
221 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
222 % marginal hacks, juha@viisa.uucp (Juha Takala)
223 \ifvoid\margin\else % marginal info is present
224 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
225 \dimen@=
\dp#1 \unvbox#1
226 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
227 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
230 % Here are the rules for the cropmarks. Note that they are
231 % offset so that the space between them is truly \outerhsize or \outervsize
232 % (P. A. MacKay, 12 November, 1986)
234 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
236 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
237 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
239 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
241 % Parse an argument, then pass it to #1. The argument is the rest of
242 % the input line (except we remove a trailing comment). #1 should be a
243 % macro which expects an ordinary undelimited TeX argument.
249 \futurelet\temp\parseargx
252 % If the next token is an obeyed space (from an @example environment or
253 % the like), remove it and recurse. Otherwise, we're done.
255 % \obeyedspace is defined far below, after the definition of \sepspaces.
256 \ifx\obeyedspace\temp
257 \expandafter\parseargdiscardspace
259 \expandafter\parseargline
263 % Remove a single space (as the delimiter token to the macro call).
265 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
268 \gdef\parseargline#1^^M
{%
269 \endgroup % End of the group started in \parsearg.
271 % First remove any @c comment, then any @comment.
272 % Result of each macro is put in \toks0.
273 \argremovec #1\c\relax %
274 \expandafter\argremovecomment \the\toks0 \comment\relax %
276 % Call the caller's macro, saved as \next in \parsearg.
277 \expandafter\next\expandafter{\the\toks0}%
281 % Since all \c{,omment} does is throw away the argument, we can let TeX
282 % do that for us. The \relax here is matched by the \relax in the call
283 % in \parseargline; it could be more or less anything, its purpose is
284 % just to delimit the argument to the \c.
285 \def\argremovec#1\c#2\relax{\toks0 =
{#1}}
286 \def\argremovecomment#1\comment#2\relax{\toks0 =
{#1}}
288 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
289 % @end itemize @c foo
290 % will have two active spaces as part of the argument with the
291 % `itemize'. Here we remove all active spaces from #1, and assign the
294 % This loses if there are any *other* active characters besides spaces
295 % in the argument -- _ ^ +, for example -- since they get expanded.
296 % Fortunately, Texinfo does not define any such commands. (If it ever
297 % does, the catcode of the characters in questionwill have to be changed
298 % here.) But this means we cannot call \removeactivespaces as part of
299 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
300 % that \parsearg gets might well have any character at all in it.
302 \def\removeactivespaces#1{%
306 \global\toks0 =
\expandafter{\temp}%
310 % Change the active space to expand to nothing.
314 \gdef\ignoreactivespaces{\obeyspaces\let =
\empty}
318 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
320 %% These are used to keep @begin/@end levels from running away
321 %% Call \inENV within environments (after a \begingroup)
322 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
324 \ifENV\errmessage{Still within an environment. Type Return to continue.
}
325 \endgroup\fi} % This is not perfect, but it should reduce lossage
327 % @begin foo is the same as @foo, for now.
328 \newhelp\EMsimple{Type <Return> to continue.
}
330 \outer\def\begin{\parsearg\beginxxx}
333 \expandafter\ifx\csname #1\endcsname\relax
334 {\errhelp=
\EMsimple \errmessage{Undefined command @begin
#1}}\else
335 \csname #1\endcsname\fi}
337 % @end foo executes the definition of \Efoo.
339 \def\end{\parsearg\endxxx}
341 \removeactivespaces{#1}%
342 \edef\endthing{\the\toks0}%
344 \expandafter\ifx\csname E
\endthing\endcsname\relax
345 \expandafter\ifx\csname \endthing\endcsname\relax
346 % There's no \foo, i.e., no ``environment'' foo.
348 \errmessage{Undefined command `@end
\endthing'
}%
350 \unmatchedenderror\endthing
353 % Everything's ok; the right environment has been started.
354 \csname E
\endthing\endcsname
358 % There is an environment #1, but it hasn't been started. Give an error.
360 \def\unmatchedenderror#1{%
362 \errmessage{This `@end
#1' doesn't have a matching `@
#1'
}%
365 % Define the control sequence \E#1 to give an unmatched @end error.
367 \def\defineunmatchedend#1{%
368 \expandafter\def\csname E
#1\endcsname{\unmatchedenderror{#1}}%
372 % Single-spacing is done by various environments (specifically, in
373 % \nonfillstart and \quotations).
374 \newskip\singlespaceskip \singlespaceskip =
12.5pt
376 % Why was this kern here? It messes up equalizing space above and below
377 % environments. --karl, 6may93
378 %{\advance \baselineskip by -\singlespaceskip
379 %\kern \baselineskip}%
380 \setleading \singlespaceskip
383 %% Simple single-character @ commands
386 % Kludge this until the fonts are right (grr).
387 \def\@
{{\tt \char '
100}}
389 % This is turned off because it was never documented
390 % and you can use @w{...} around a quote to suppress ligatures.
391 %% Define @` and @' to be the same as ` and '
392 %% but suppressing ligatures.
396 % Used to generate quoted braces.
397 \def\mylbrace {{\tt \char '
173}}
398 \def\myrbrace {{\tt \char '
175}}
402 % Definitions to produce actual \{ & \} command in an index.
403 \catcode`\
{ =
12 \catcode`\
} =
12
404 \catcode`\
[ =
1 \catcode`\
] =
2
405 \catcode`\@ =
0 \catcode`\\ =
12
410 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
411 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
414 \def\ringaccent#1{{\accent23 #1}}
419 % Other special characters: @questiondown @exclamdown
420 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
421 \def\questiondown{?`
}
424 % Dotless i and dotless j, used for accents.
429 \ifx\temp\imacro \ptexi
430 \else\ifx\temp\jmacro \j
431 \else \errmessage{@dotless can be used only with i or j
}%
435 % @: forces normal size whitespace following.
436 \def\:
{\spacefactor=
1000 }
438 % @* forces a line break.
439 \def\*
{\hfil\break\hbox{}\ignorespaces}
441 % @. is an end-of-sentence period.
442 \def\.
{.
\spacefactor=
3000 }
444 % @enddots{} is an end-of-sentence ellipsis.
445 \gdef\enddots{$
\mathinner{\ldotp\ldotp\ldotp\ldotp}$
\spacefactor=
3000}
447 % @! is an end-of-sentence bang.
448 \gdef\!
{!
\spacefactor=
3000 }
450 % @? is an end-of-sentence query.
451 \gdef\?
{?
\spacefactor=
3000 }
453 % @w prevents a word break. Without the \leavevmode, @w at the
454 % beginning of a paragraph, when TeX is still in vertical mode, would
455 % produce a whole line of output instead of starting the paragraph.
456 \def\w#1{\leavevmode\hbox{#1}}
458 % @group ... @end group forces ... to be all on one page, by enclosing
459 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
460 % to keep its height that of a normal line. According to the rules for
461 % \topskip (p.114 of the TeXbook), the glue inserted is
462 % max (\topskip - \ht (first item), 0). If that height is large,
463 % therefore, no glue is inserted, and the space between the headline and
464 % the text is small, which looks bad.
466 \def\group{\begingroup
467 \ifnum\catcode13=
\active \else
468 \errhelp =
\groupinvalidhelp
469 \errmessage{@group invalid in context where filling is enabled
}%
472 % The \vtop we start below produces a box with normal height and large
473 % depth; thus, TeX puts \baselineskip glue before it, and (when the
474 % next line of text is done) \lineskip glue after it. (See p.82 of
475 % the TeXbook.) Thus, space below is not quite equal to space
476 % above. But it's pretty close.
478 \egroup % End the \vtop.
479 \endgroup % End the \group.
483 % We have to put a strut on the last line in case the @group is in
484 % the midst of an example, rather than completely enclosing it.
485 % Otherwise, the interline space between the last line of the group
486 % and the first line afterwards is too small. But we can't put the
487 % strut in \Egroup, since there it would be on a line by itself.
488 % Hence this just inserts a strut at the beginning of each line.
489 \everypar =
{\strut}%
491 % Since we have a strut on every line, we don't need any of TeX's
492 % normal interline spacing.
495 % OK, but now we have to do something about blank
496 % lines in the input in @example-like environments, which normally
497 % just turn into \lisppar, which will insert no space now that we've
498 % turned off the interline space. Simplest is to make them be an
501 \edef\par{\leavevmode \par}%
503 % Reset ^^M's definition to new definition of \par.
507 % Do @comment since we are called inside an environment such as
508 % @example, where each end-of-line in the input causes an
509 % end-of-line in the output. We don't want the end-of-line after
510 % the `@group' to put extra space in the output. Since @group
511 % should appear on a line by itself (according to the Texinfo
512 % manual), we don't worry about eating any user text.
516 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
517 % message, so this ends up printing `@group can only ...'.
519 \newhelp\groupinvalidhelp{%
520 group can only be used in environments such as @example,^^J
%
521 where each line of input produces a line of output.
}
523 % @need space-in-mils
524 % forces a page break if there is not space-in-mils remaining.
526 \newdimen\mil \mil=
0.001in
528 \def\need{\parsearg\needx}
530 % Old definition--didn't work.
531 %\def\needx #1{\par %
532 %% This method tries to make TeX break the page naturally
533 %% if the depth of the box does not fit.
535 %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
540 % Go into vertical mode, so we don't make a big box in the middle of a
544 % Don't add any leading before our big empty box, but allow a page
545 % break, since the best break might be right here.
548 \vtop to
#1\mil{\vfil}%
550 % TeX does not even consider page breaks if a penalty added to the
551 % main vertical list is 10000 or more. But in order to see if the
552 % empty box we just added fits on the page, we must make it consider
553 % page breaks. On the other hand, we don't want to actually break the
554 % page after the empty box. So we use a penalty of 9999.
556 % There is an extremely small chance that TeX will actually break the
557 % page at this \penalty, if there are no other feasible breakpoints in
558 % sight. (If the user is using lots of big @group commands, which
559 % almost-but-not-quite fill up a page, TeX will have a hard time doing
560 % good page breaking, for example.) However, I could not construct an
561 % example where a page broke at this \penalty; if it happens in a real
562 % document, then we can reconsider our strategy.
565 % Back up by the size of the box, whether we did a page break or not.
568 % Do not allow a page break right after this kern.
572 % @br forces paragraph break
576 % @dots{} output some dots
580 % @page forces the start of a new page
582 \def\page{\par\vfill\supereject}
585 % outputs text on separate line in roman font, starting at standard page margin
587 % This records the amount of indent in the innermost environment.
588 % That's how much \exdent should take out.
589 \newskip\exdentamount
591 % This defn is used inside fill environments such as @defun.
592 \def\exdent{\parsearg\exdentyyy}
593 \def\exdentyyy #1{{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}}
595 % This defn is used inside nofill environments such as @example.
596 \def\nofillexdent{\parsearg\nofillexdentyyy}
597 \def\nofillexdentyyy #1{{\advance \leftskip by -
\exdentamount
598 \leftline{\hskip\leftskip{\rm#1}}}}
600 % @inmargin{TEXT} puts TEXT in the margin next to the current paragraph.
603 \strut\vadjust{\nobreak\kern-
\strutdepth
604 \vtop to
\strutdepth{\baselineskip\strutdepth\vss
605 \llap{\rightskip=
\inmarginspacing \vbox{\noindent #1}}\null}}}
606 \newskip\inmarginspacing \inmarginspacing=
1cm
607 \def\strutdepth{\dp\strutbox}
609 %\hbox{{\rm#1}}\hfil\break}}
611 % @include file insert text of that file as input.
612 % Allow normal characters that we make active in the argument (a file name).
613 \def\include{\begingroup
622 \parsearg\includezzz}
623 % Restore active chars for included file.
624 \def\includezzz#1{\endgroup\begingroup
625 % Read the included file in a group so nested @include's work.
632 % @center line outputs that line, centered
634 \def\center{\parsearg\centerzzz}
635 \def\centerzzz #1{{\advance\hsize by -
\leftskip
636 \advance\hsize by -
\rightskip
639 % @sp n outputs n lines of vertical space
641 \def\sp{\parsearg\spxxx}
642 \def\spxxx #1{\vskip #1\baselineskip}
644 % @comment ...line which is ignored...
645 % @c is the same as @comment
646 % @ignore ... @end ignore is another way to write a comment
648 \def\comment{\catcode 64=
\other \catcode 123=
\other \catcode 125=
\other%
649 \parsearg \commentxxx}
651 \def\commentxxx #1{\catcode 64=
0 \catcode 123=
1 \catcode 125=
2 }
655 % @paragraphindent is defined for the Info formatting commands only.
656 \let\paragraphindent=
\comment
658 % Prevent errors for section commands.
659 % Used in @ignore and in failing conditionals.
660 \def\ignoresections{%
662 \let\unnumbered=
\relax
664 \let\unnumberedsec=
\relax
665 \let\unnumberedsection=
\relax
666 \let\unnumberedsubsec=
\relax
667 \let\unnumberedsubsection=
\relax
668 \let\unnumberedsubsubsec=
\relax
669 \let\unnumberedsubsubsection=
\relax
672 \let\subsubsec=
\relax
673 \let\subsection=
\relax
674 \let\subsubsection=
\relax
676 \let\appendixsec=
\relax
677 \let\appendixsection=
\relax
678 \let\appendixsubsec=
\relax
679 \let\appendixsubsection=
\relax
680 \let\appendixsubsubsec=
\relax
681 \let\appendixsubsubsection=
\relax
683 \let\smallbook=
\relax
684 \let\titlepage=
\relax
687 % Used in nested conditionals, where we have to parse the Texinfo source
688 % and so want to turn off most commands, in case they are used
691 \def\ignoremorecommands{%
692 \let\defcodeindex =
\relax
696 \let\defindex =
\relax
697 \let\defivar =
\relax
699 \let\defmethod =
\relax
702 \let\defspec =
\relax
704 \let\deftypefn =
\relax
705 \let\deftypefun =
\relax
706 \let\deftypevar =
\relax
707 \let\deftypevr =
\relax
713 \let\printindex =
\relax
715 \let\settitle =
\relax
716 \let\setchapternewpage =
\relax
717 \let\setchapterstyle =
\relax
718 \let\everyheading =
\relax
719 \let\evenheading =
\relax
720 \let\oddheading =
\relax
721 \let\everyfooting =
\relax
722 \let\evenfooting =
\relax
723 \let\oddfooting =
\relax
724 \let\headings =
\relax
725 \let\include =
\relax
726 \let\lowersections =
\relax
728 \let\raisesections =
\relax
735 % Ignore @ignore ... @end ignore.
737 \def\ignore{\doignore{ignore
}}
739 % Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
741 \def\ifinfo{\doignore{ifinfo
}}
742 \def\ifhtml{\doignore{ifhtml
}}
743 \def\ifnottex{\doignore{ifnottex
}}
744 \def\html{\doignore{html
}}
745 \def\menu{\doignore{menu
}}
746 \def\direntry{\doignore{direntry
}}
748 % Also ignore @macro ... @end macro. The user must run texi2dvi,
749 % which runs makeinfo to do macro expansion. Ignore @unmacro, too.
750 \def\macro{\doignore{macro
}}
751 \let\unmacro =
\comment
754 % @dircategory CATEGORY -- specify a category of the dir file
755 % which this file should belong to. Ignore this in TeX.
756 \let\dircategory =
\comment
758 % Ignore text until a line `@end #1'.
760 \def\doignore#1{\begingroup
761 % Don't complain about control sequences we have declared \outer.
764 % Define a command to swallow text until we reach `@end #1'.
765 \long\def\doignoretext#
#1\end #1{\enddoignore}%
767 % Make sure that spaces turn into tokens that match what \doignoretext wants.
770 % Ignore braces, too, so mismatched braces don't cause trouble.
774 % And now expand that command.
778 % What we do to finish off ignored text.
780 \def\enddoignore{\endgroup\ignorespaces}%
782 \newif\ifwarnedobs\warnedobsfalse
784 \ifwarnedobs\relax\else
785 % We need to warn folks that they may have trouble with TeX 3.0.
786 % This uses \immediate\write16 rather than \message to get newlines.
788 \immediate\write16{***WARNING*** for users of Unix TeX
3.0!
}
789 \immediate\write16{This manual trips a bug in TeX version
3.0 (tex hangs).
}
790 \immediate\write16{If you are running another version of TeX, relax.
}
791 \immediate\write16{If you are running Unix TeX
3.0, kill this TeX process.
}
792 \immediate\write16{ Then upgrade your TeX installation if you can.
}
793 \immediate\write16{ (See ftp://ftp.gnu.ai.mit.edu/pub/gnu/TeX.README.)
}
794 \immediate\write16{If you are stuck with version
3.0, run the
}
795 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution
}
796 \immediate\write16{ to use a workaround.
}
798 \global\warnedobstrue
802 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
803 % workaround (which requires the file ``dummy.tfm'' to be installed),
804 % uncomment the following line:
805 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
807 % Ignore text, except that we keep track of conditional commands for
808 % purposes of nesting, up to an `@end #1' command.
810 \def\nestedignore#1{%
812 % We must actually expand the ignored text to look for the @end
813 % command, so that nested ignore constructs work. Thus, we put the
814 % text into a \vbox and then do nothing with the result. To minimize
815 % the change of memory overflow, we follow the approach outlined on
816 % page 401 of the TeXbook: make the current font be a dummy font.
818 \setbox0 =
\vbox\bgroup
819 % Don't complain about control sequences we have declared \outer.
822 % Define `@end #1' to end the box, which will in turn undefine the
823 % @end command again.
824 \expandafter\def\csname E
#1\endcsname{\egroup\ignorespaces}%
826 % We are going to be parsing Texinfo commands. Most cause no
827 % trouble when they are used incorrectly, but some commands do
828 % complicated argument parsing or otherwise get confused, so we
831 % We can't do anything about stray @-signs, unfortunately;
832 % they'll produce `undefined control sequence' errors.
835 % Set the current font to be \nullfont, a TeX primitive, and define
836 % all the font commands to also use \nullfont. We don't use
837 % dummy.tfm, as suggested in the TeXbook, because not all sites
838 % might have that installed. Therefore, math mode will still
839 % produce output, but that should be an extremely small amount of
840 % stuff compared to the main input.
843 \let\tenrm =
\nullfont \let\tenit =
\nullfont \let\tensl =
\nullfont
844 \let\tenbf =
\nullfont \let\tentt =
\nullfont \let\smallcaps =
\nullfont
845 \let\tensf =
\nullfont
846 % Similarly for index fonts (mostly for their use in
848 \let\indrm =
\nullfont \let\indit =
\nullfont \let\indsl =
\nullfont
849 \let\indbf =
\nullfont \let\indtt =
\nullfont \let\indsc =
\nullfont
850 \let\indsf =
\nullfont
852 % Don't complain when characters are missing from the fonts.
853 \tracinglostchars =
0
855 % Don't bother to do space factor calculations.
858 % Don't report underfull hboxes.
861 % Do minimal line-breaking.
862 \pretolerance =
10000
864 % Do not execute instructions in @tex
865 \def\tex{\doignore{tex
}}%
868 % @set VAR sets the variable VAR to an empty value.
869 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
871 % Since we want to separate VAR from REST-OF-LINE (which might be
872 % empty), we can't just use \parsearg; we have to insert a space of our
873 % own to delimit the rest of the line, and then take it out again if we
874 % didn't need it. Make sure the catcode of space is correct to avoid
875 % losing inside @example, for instance.
877 \def\set{\begingroup\catcode` =
10
878 \catcode`\-=
12 \catcode`
\_=
12 % Allow - and _ in VAR.
880 \def\setxxx#1{\setyyy#1 \endsetyyy}
881 \def\setyyy#1 #2\endsetyyy{%
883 \ifx\temp\empty \global\expandafter\let\csname SET
#1\endcsname =
\empty
884 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
888 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
889 % \next or other control sequences that we've defined might get us into
890 % an infinite loop. Consider `@set foo @cite{bar}'.
891 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET
#1\endcsname{#2}}
893 % @clear VAR clears (i.e., unsets) the variable VAR.
895 \def\clear{\parsearg\clearxxx}
896 \def\clearxxx#1{\global\expandafter\let\csname SET
#1\endcsname=
\relax}
898 % @value{foo} gets the text saved in variable foo.
900 \def\value{\begingroup
901 \catcode`\-=
12 \catcode`
\_=
12 % Allow - and _ in VAR.
904 \expandafter\ifx\csname SET
#1\endcsname\relax
905 {\
{No value for ``
#1''\
}}%
907 \csname SET
#1\endcsname
911 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
914 \def\ifset{\parsearg\ifsetxxx}
916 \expandafter\ifx\csname SET
#1\endcsname\relax
917 \expandafter\ifsetfail
919 \expandafter\ifsetsucceed
922 \def\ifsetsucceed{\conditionalsucceed{ifset
}}
923 \def\ifsetfail{\nestedignore{ifset
}}
924 \defineunmatchedend{ifset
}
926 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
927 % defined with @set, or has been undefined with @clear.
929 \def\ifclear{\parsearg\ifclearxxx}
931 \expandafter\ifx\csname SET
#1\endcsname\relax
932 \expandafter\ifclearsucceed
934 \expandafter\ifclearfail
937 \def\ifclearsucceed{\conditionalsucceed{ifclear
}}
938 \def\ifclearfail{\nestedignore{ifclear
}}
939 \defineunmatchedend{ifclear
}
941 % @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
942 % following, through the first @end iftex (etc.). Make `@end iftex'
943 % (etc.) valid only after an @iftex.
945 \def\iftex{\conditionalsucceed{iftex
}}
946 \def\ifnothtml{\conditionalsucceed{ifnothtml
}}
947 \def\ifnotinfo{\conditionalsucceed{ifnotinfo
}}
948 \defineunmatchedend{iftex
}
949 \defineunmatchedend{ifnothtml
}
950 \defineunmatchedend{ifnotinfo
}
952 % We can't just want to start a group at @iftex (for example) and end it
953 % at @end iftex, since then @set commands inside the conditional have no
954 % effect (they'd get reverted at the end of the group). So we must
955 % define \Eiftex to redefine itself to be its previous value. (We can't
956 % just define it to fail again with an ``unmatched end'' error, since
957 % the @ifset might be nested.)
959 \def\conditionalsucceed#1{%
961 % Remember the current value of \E#1.
962 \let\nece{prevE
#1} =
\nece{E
#1}%
964 % At the `@end #1', redefine \E#1 to be its previous value.
965 \def\nece{E
#1}{\let\nece{E
#1} =
\nece{prevE
#1}}%
970 % We need to expand lots of \csname's, but we don't want to expand the
971 % control sequences after we've constructed them.
973 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
975 % @asis just yields its argument. Used with @table, for example.
979 % @math means output in math mode.
980 % We don't use $'s directly in the definition of \math because control
981 % sequences like \math are expanded when the toc file is written. Then,
982 % we read the toc file back, the $'s will be normal characters (as they
983 % should be, according to the definition of Texinfo). So we must use a
984 % control sequence to switch into and out of math mode.
986 % This isn't quite enough for @math to work properly in indices, but it
987 % seems unlikely it will ever be needed there.
989 \let\implicitmath = $
990 \def\math#1{\implicitmath #1\implicitmath}
992 % @bullet and @minus need the same treatment as @math, just above.
993 \def\bullet{\implicitmath\ptexbullet\implicitmath}
994 \def\minus{\implicitmath-
\implicitmath}
996 \def\node{\ENVcheck\parsearg\nodezzz}
997 \def\nodezzz#1{\nodexxx [#1,
]}
998 \def\nodexxx[#1,
#2]{\gdef\lastnode{#1}}
1000 \let\lastnode=
\relax
1002 \def\donoderef{\ifx\lastnode\relax\else
1003 \expandafter\expandafter\expandafter\setref{\lastnode}\fi
1004 \global\let\lastnode=
\relax}
1006 \def\unnumbnoderef{\ifx\lastnode\relax\else
1007 \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
1008 \global\let\lastnode=
\relax}
1010 \def\appendixnoderef{\ifx\lastnode\relax\else
1011 \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
1012 \global\let\lastnode=
\relax}
1014 % @refill is a no-op.
1017 % @setfilename is done at the beginning of every texinfo file.
1018 % So open here the files we need to have open while reading the input.
1019 % This makes it possible to make a .fmt file for texinfo.
1024 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1025 \global\let\setfilename=
\comment % Ignore extra @setfilename cmds.
1027 % If texinfo.cnf is present on the system, read it.
1028 % Useful for site-wide @afourpaper, etc.
1029 % Just to be on the safe side, close the input stream before the \input.
1030 \openin 1 texinfo.cnf
1031 \ifeof1 \let\temp=
\relax \else \def\temp{\input texinfo.cnf
}\fi
1035 \comment % Ignore the actual filename.
1039 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1041 % \def\macro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\macroxxx}
1042 % \def\macroxxx#1#2 \end macro{%
1043 % \expandafter\gdef\macrotemp#1{#2}%
1046 %\def\linemacro#1{\begingroup\ignoresections\catcode`\#=6\def\macrotemp{#1}\parsearg\linemacroxxx}
1047 %\def\linemacroxxx#1#2 \end linemacro{%
1048 %\let\parsearg=\relax
1049 %\edef\macrotempx{\csname M\butfirst\expandafter\string\macrotemp\endcsname}%
1050 %\expandafter\xdef\macrotemp{\parsearg\macrotempx}%
1051 %\expandafter\gdef\macrotempx#1{#2}%
1059 % Font-change commands.
1061 % Texinfo supports the sans serif font style, which plain TeX does not.
1062 % So we set up a \sf analogous to plain's \rm, etc.
1064 \def\sf{\fam=
\sffam \tensf}
1065 \let\li =
\sf % Sometimes we call it \li, not \sf.
1067 % We don't need math for this one.
1070 % Use Computer Modern fonts at \magstephalf (11pt).
1071 \newcount\mainmagstep
1072 \mainmagstep=
\magstephalf
1074 % Set the font macro #1 to the font named #2, adding on the
1075 % specified font prefix (normally `cm').
1076 % #3 is the font's design size, #4 is a scale factor
1077 \def\setfont#1#2#3#4{\font#1=
\fontprefix#2#3 scaled
#4}
1079 % Use cm as the default font prefix.
1080 % To specify the font prefix, you must define \fontprefix
1081 % before you read in texinfo.tex.
1082 \ifx\fontprefix\undefined
1085 % Support font families that don't use the same naming scheme as CM.
1087 \def\rmbshape{bx
} %where the normal face is bold
1092 \def\ttslshape{sltt
}
1103 \let\mainmagstep=
\magstep1
1104 \setfont\textrm\rmshape{12}{1000}
1105 \setfont\texttt\ttshape{12}{1000}
1107 \setfont\textrm\rmshape{10}{\mainmagstep}
1108 \setfont\texttt\ttshape{10}{\mainmagstep}
1110 % Instead of cmb10, you many want to use cmbx10.
1111 % cmbx10 is a prettier font on its own, but cmb10
1112 % looks better when embedded in a line with cmr10.
1113 \setfont\textbf\bfshape{10}{\mainmagstep}
1114 \setfont\textit\itshape{10}{\mainmagstep}
1115 \setfont\textsl\slshape{10}{\mainmagstep}
1116 \setfont\textsf\sfshape{10}{\mainmagstep}
1117 \setfont\textsc\scshape{10}{\mainmagstep}
1118 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1119 \font\texti=cmmi10 scaled
\mainmagstep
1120 \font\textsy=cmsy10 scaled
\mainmagstep
1122 % A few fonts for @defun, etc.
1123 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1124 \setfont\deftt\ttshape{10}{\magstep1}
1125 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \bf}
1127 % Fonts for indices and small examples (9pt).
1128 % We actually use the slanted font rather than the italic,
1129 % because texinfo normally uses the slanted fonts for that.
1130 % Do not make many font distinctions in general in the index, since they
1131 % aren't very useful.
1132 \setfont\ninett\ttshape{9}{1000}
1133 \setfont\indrm\rmshape{9}{1000}
1134 \setfont\indit\slshape{9}{1000}
1137 \let\indttsl=
\ninett
1140 \setfont\indsc\scshape{10}{900}
1144 % Fonts for title page:
1145 \setfont\titlerm\rmbshape{12}{\magstep3}
1146 \setfont\titleit\itbshape{10}{\magstep4}
1147 \setfont\titlesl\slbshape{10}{\magstep4}
1148 \setfont\titlett\ttbshape{12}{\magstep3}
1149 \setfont\titlettsl\ttslshape{10}{\magstep4}
1150 \setfont\titlesf\sfbshape{17}{\magstep1}
1151 \let\titlebf=
\titlerm
1152 \setfont\titlesc\scbshape{10}{\magstep4}
1153 \font\titlei=cmmi12 scaled
\magstep3
1154 \font\titlesy=cmsy10 scaled
\magstep4
1155 \def\authorrm{\secrm}
1157 % Chapter (and unnumbered) fonts (17.28pt).
1158 \setfont\chaprm\rmbshape{12}{\magstep2}
1159 \setfont\chapit\itbshape{10}{\magstep3}
1160 \setfont\chapsl\slbshape{10}{\magstep3}
1161 \setfont\chaptt\ttbshape{12}{\magstep2}
1162 \setfont\chapttsl\ttslshape{10}{\magstep3}
1163 \setfont\chapsf\sfbshape{17}{1000}
1165 \setfont\chapsc\scbshape{10}{\magstep3}
1166 \font\chapi=cmmi12 scaled
\magstep2
1167 \font\chapsy=cmsy10 scaled
\magstep3
1169 % Section fonts (14.4pt).
1170 \setfont\secrm\rmbshape{12}{\magstep1}
1171 \setfont\secit\itbshape{10}{\magstep2}
1172 \setfont\secsl\slbshape{10}{\magstep2}
1173 \setfont\sectt\ttbshape{12}{\magstep1}
1174 \setfont\secttsl\ttslshape{10}{\magstep2}
1175 \setfont\secsf\sfbshape{12}{\magstep1}
1177 \setfont\secsc\scbshape{10}{\magstep2}
1178 \font\seci=cmmi12 scaled
\magstep1
1179 \font\secsy=cmsy10 scaled
\magstep2
1181 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1182 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1183 % \setfont\ssecsl\slshape{10}{\magstep1}
1184 % \setfont\ssectt\ttshape{10}{\magstep1}
1185 % \setfont\ssecsf\sfshape{10}{\magstep1}
1187 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1188 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1189 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1190 %\setfont\ssectt\ttshape{10}{1315}
1191 %\setfont\ssecsf\sfshape{10}{1315}
1193 %\let\ssecbf=\ssecrm
1195 % Subsection fonts (13.15pt).
1196 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1197 \setfont\ssecit\itbshape{10}{1315}
1198 \setfont\ssecsl\slbshape{10}{1315}
1199 \setfont\ssectt\ttbshape{12}{\magstephalf}
1200 \setfont\ssecttsl\ttslshape{10}{1315}
1201 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1203 \setfont\ssecsc\scbshape{10}{\magstep1}
1204 \font\sseci=cmmi12 scaled
\magstephalf
1205 \font\ssecsy=cmsy10 scaled
1315
1206 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1207 % but that is not a standard magnification.
1209 % In order for the font changes to affect most math symbols and letters,
1210 % we have to define the \textfont of the standard families. Since
1211 % texinfo doesn't allow for producing subscripts and superscripts, we
1212 % don't bother to reset \scriptfont and \scriptscriptfont (which would
1213 % also require loading a lot more fonts).
1215 \def\resetmathfonts{%
1216 \textfont0 =
\tenrm \textfont1 =
\teni \textfont2 =
\tensy
1217 \textfont\itfam =
\tenit \textfont\slfam =
\tensl \textfont\bffam =
\tenbf
1218 \textfont\ttfam =
\tentt \textfont\sffam =
\tensf
1222 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1223 % of just \STYLE. We do this so that font changes will continue to work
1224 % in math mode, where it is the current \fam that is relevant in most
1225 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1226 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1227 % redefine \bf itself.
1229 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
1230 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
1231 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy \let\tenttsl=
\textttsl
1234 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
1235 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
1236 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
1237 \let\tenttsl=
\titlettsl
1238 \resetmathfonts \setleading{25pt
}}
1239 \def\titlefont#1{{\titlefonts #1}}
1241 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
1242 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
1243 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy \let\tenttsl=
\chapttsl
1244 \resetmathfonts \setleading{19pt
}}
1246 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
1247 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
1248 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy \let\tenttsl=
\secttsl
1249 \resetmathfonts \setleading{16pt
}}
1251 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
1252 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
1253 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy \let\tenttsl=
\ssecttsl
1254 \resetmathfonts \setleading{15pt
}}
1255 \let\subsubsecfonts =
\subsecfonts % Maybe make sssec fonts scaled magstephalf?
1257 \let\tenrm=
\indrm \let\tenit=
\indit \let\tensl=
\indsl
1258 \let\tenbf=
\indbf \let\tentt=
\indtt \let\smallcaps=
\indsc
1259 \let\tensf=
\indsf \let\teni=
\indi \let\tensy=
\indsy \let\tenttsl=
\indttsl
1260 \resetmathfonts \setleading{12pt
}}
1262 % Set up the default fonts, so we can use them for creating boxes.
1266 % Count depth in font-changes, for error checks
1267 \newcount\fontdepth \fontdepth=
0
1269 % Fonts for short table of contents.
1270 \setfont\shortcontrm\rmshape{12}{1000}
1271 \setfont\shortcontbf\bxshape{12}{1000}
1272 \setfont\shortcontsl\slshape{12}{1000}
1274 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1275 %% serif) and @ii for TeX italic
1277 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1278 % unless the following character is such as not to need one.
1279 \def\smartitalicx{\ifx\next,
\else\ifx\next-
\else\ifx\next.
\else\/
\fi\fi\fi}
1280 \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1283 \let\var=
\smartitalic
1284 \let\dfn=
\smartitalic
1285 \let\emph=
\smartitalic
1286 \let\cite=
\smartitalic
1291 % We can't just use \exhyphenpenalty, because that only has effect at
1292 % the end of a paragraph. Restore normal hyphenation at the end of the
1293 % group within which \nohyphenation is presumably called.
1295 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
1296 \def\restorehyphenation{\hyphenchar\font = `-
}
1299 {\tt \rawbackslash \frenchspacing #1}%
1303 \def\samp #1{`
\tclose{#1}'
\null}
1304 \setfont\smallrm\rmshape{8}{1000}
1306 \def\key#1{{\smallrm\textfont2=
\smallsy \leavevmode\hbox{%
1307 \raise0.4pt
\hbox{$
\langle$
}\kern-
.08em
\vtop{%
1308 \vbox{\hrule\kern-
0.4pt
1309 \hbox{\raise0.4pt
\hbox{\vphantom{$
\langle$
}}#1}}%
1311 \kern-
.06em
\raise0.4pt
\hbox{$
\rangle$
}}}}
1312 % The old definition, with no lozenge:
1313 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1314 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1318 % @code is a modification of @t,
1319 % which makes spaces the same size as normal in the surrounding text.
1322 % Change normal interword space to be same as for the current font.
1323 \spaceskip =
\fontdimen2\font
1325 % Switch to typewriter.
1328 % But `\ ' produces the large typewriter interword space.
1329 \def\
{{\spaceskip =
0pt
{} }}%
1331 % Turn off hyphenation.
1341 % We *must* turn on hyphenation at `-' and `_' in \code.
1342 % Otherwise, it is too hard to avoid overfull hboxes
1343 % in the Emacs manual, the Library manual, etc.
1345 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1346 % both hyphenation at - and hyphenation within words.
1347 % We must therefore turn them both off (\tclose does that)
1348 % and arrange explicitly to hyphenate at a dash.
1354 \global\def\code{\begingroup \catcode`\-=
\active \let-
\codedash \catcode`
\_=
\active \let_\codeunder \codex}
1355 % The following is used by \doprintindex to insure that long function names
1356 % wrap around. It is necessary for - and _ to be active before the index is
1357 % read from the file, as \entry parses the arguments long before \code is
1358 % ever called. -- mycroft
1359 % _ is always active; and it shouldn't be \let = to an _ that is a
1360 % subscript character anyway. Then, @cindex @samp{_} (for example)
1362 \global\def\indexbreaks{%
1363 \catcode`\-=
\active \let-
\realdash
1368 \def\codedash{-
\discretionary{}{}{}}
1369 \def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}}
1370 \def\codex #1{\tclose{#1}\endgroup}
1372 %\let\exp=\tclose %Was temporary
1374 % @kbd is like @code, except that if the argument is just one @key command,
1375 % then @kbd has no effect.
1377 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1378 % `example' (@kbd uses ttsl only inside of @example and friends),
1379 % or `code' (@kbd uses normal tty font always).
1380 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1381 \def\kbdinputstylexxx#1{%
1383 \ifx\arg\worddistinct
1384 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1385 \else\ifx\arg\wordexample
1386 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1387 \else\ifx\arg\wordcode
1388 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1391 \def\worddistinct{distinct
}
1392 \def\wordexample{example
}
1395 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1396 % the catcodes are wrong for parsearg to work.)
1397 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1400 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??
}%
1401 \ifx\one\xkey\ifx\threex\three \key{#2}%
1402 \else{\tclose{\kbdfont\look}}\fi
1403 \else{\tclose{\kbdfont\look}}\fi}
1405 % @url. Quotes do not seem necessary, so use \code.
1408 % @uref (abbreviation for `urlref') takes an optional second argument
1409 % specifying the text to display. First (mandatory) arg is the url.
1410 % Perhaps eventually put in a hypertex \special here.
1412 \def\uref#1{\urefxxx #1,,
\finish}
1413 \def\urefxxx#1,
#2,
#3\finish{%
1414 \setbox0 =
\hbox{\ignorespaces #2}%
1416 \unhbox0\ (
\code{#1})
%
1422 % rms does not like the angle brackets --karl, 17may97.
1423 % So now @email is just like @uref.
1424 %\def\email#1{$\langle${\tt #1}$\rangle$}
1427 % Check if we are currently using a typewriter font. Since all the
1428 % Computer Modern typewriter fonts have zero interword stretch (and
1429 % shrink), and it is reasonable to expect all typewriter fonts to have
1430 % this property, we can check that font parameter.
1432 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
1434 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1435 % argument is to make the input look right: @dmn{pt} instead of
1438 \def\dmn#1{\thinspace #1}
1440 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??
\par}
1442 % @l was never documented to mean ``switch to the Lisp font'',
1443 % and it is not used as such in any manual I can find. We need it for
1444 % Polish suppressed-l. --karl, 22sep96.
1445 %\def\l#1{{\li #1}\null}
1447 \def\r#1{{\rm #1}} % roman font
1448 % Use of \lowercase was suggested.
1449 \def\sc#1{{\smallcaps#1}} % smallcaps font
1450 \def\ii#1{{\it #1}} % italic font
1452 % @pounds{} is a sterling sign.
1453 \def\pounds{{\it\$
}}
1456 \message{page headings,
}
1458 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
1459 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
1461 % First the title page. Must do @settitle before @titlepage.
1463 \newif\iffinishedtitlepage
1465 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1466 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
1467 \endgroup\page\hbox{}\page}
1469 \def\titlepage{\begingroup \parindent=
0pt
\textfonts
1470 \let\subtitlerm=
\tenrm
1471 % I deinstalled the following change because \cmr12 is undefined.
1472 % This change was not in the ChangeLog anyway. --rms.
1473 % \let\subtitlerm=\cmr12
1474 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}%
1476 \def\authorfont{\authorrm \normalbaselineskip =
16pt
\normalbaselines}%
1478 % Leave some space at the very top of the page.
1479 \vglue\titlepagetopglue
1481 % Now you can print the title using @title.
1482 \def\title{\parsearg\titlezzz}%
1483 \def\titlezzz#
#1{\leftline{\titlefonts\rm #
#1}
1484 % print a rule at the page bottom also.
1485 \finishedtitlepagefalse
1486 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt}%
1487 % No rule at page bottom unless we print one at the top with @title.
1488 \finishedtitlepagetrue
1490 % Now you can put text using @subtitle.
1491 \def\subtitle{\parsearg\subtitlezzz}%
1492 \def\subtitlezzz#
#1{{\subtitlefont \rightline{#
#1}}}%
1494 % @author should come last, but may come many times.
1495 \def\author{\parsearg\authorzzz}%
1496 \def\authorzzz#
#1{\ifseenauthor\else\vskip 0pt plus
1filll
\seenauthortrue\fi
1497 {\authorfont \leftline{#
#1}}}%
1499 % Most title ``pages'' are actually two pages long, with space
1500 % at the top of the second. We don't want the ragged left on the second.
1501 \let\oldpage =
\page
1503 \iffinishedtitlepage\else
1507 \let\page =
\oldpage
1509 % \def\page{\oldpage \hbox{}}
1513 \iffinishedtitlepage\else
1516 % It is important to do the page break before ending the group,
1517 % because the headline and footline are only empty inside the group.
1518 % If we use the new definition of \page, we always get a blank page
1519 % after the title page, which we certainly don't want.
1525 \def\finishtitlepage{%
1526 \vskip4pt \hrule height
2pt width
\hsize
1527 \vskip\titlepagebottomglue
1528 \finishedtitlepagetrue
1531 %%% Set up page headings and footings.
1533 \let\thispage=
\folio
1535 \newtoks \evenheadline % Token sequence for heading line of even pages
1536 \newtoks \oddheadline % Token sequence for heading line of odd pages
1537 \newtoks \evenfootline % Token sequence for footing line of even pages
1538 \newtoks \oddfootline % Token sequence for footing line of odd pages
1540 % Now make Tex use those variables
1541 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
1542 \else \the\evenheadline \fi}}
1543 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
1544 \else \the\evenfootline \fi}\HEADINGShook}
1545 \let\HEADINGShook=
\relax
1547 % Commands to set those variables.
1548 % For example, this is what @headings on does
1549 % @evenheading @thistitle|@thispage|@thischapter
1550 % @oddheading @thischapter|@thispage|@thistitle
1551 % @evenfooting @thisfile||
1552 % @oddfooting ||@thisfile
1554 \def\evenheading{\parsearg\evenheadingxxx}
1555 \def\oddheading{\parsearg\oddheadingxxx}
1556 \def\everyheading{\parsearg\everyheadingxxx}
1558 \def\evenfooting{\parsearg\evenfootingxxx}
1559 \def\oddfooting{\parsearg\oddfootingxxx}
1560 \def\everyfooting{\parsearg\everyfootingxxx}
1564 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|
\finish}
1565 \gdef\evenheadingyyy #1@|
#2@|
#3@|
#4\finish{%
1566 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1568 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|
\finish}
1569 \gdef\oddheadingyyy #1@|
#2@|
#3@|
#4\finish{%
1570 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1572 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1574 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|
\finish}
1575 \gdef\evenfootingyyy #1@|
#2@|
#3@|
#4\finish{%
1576 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1578 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|
\finish}
1579 \gdef\oddfootingyyy #1@|
#2@|
#3@|
#4\finish{%
1580 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1582 % Leave some space for the footline. Hopefully ok to assume
1583 % @evenfooting will not be used by itself.
1584 \global\advance\pageheight by -
\baselineskip
1585 \global\advance\vsize by -
\baselineskip
1588 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1590 }% unbind the catcode of @.
1592 % @headings double turns headings on for double-sided printing.
1593 % @headings single turns headings on for single-sided printing.
1594 % @headings off turns them off.
1595 % @headings on same as @headings double, retained for compatibility.
1596 % @headings after turns on double-sided headings after this page.
1597 % @headings doubleafter turns on double-sided headings after this page.
1598 % @headings singleafter turns on single-sided headings after this page.
1599 % By default, they are off at the start of a document,
1600 % and turned `on' after @end titlepage.
1602 \def\headings #1 {\csname HEADINGS
#1\endcsname}
1605 \global\evenheadline=
{\hfil} \global\evenfootline=
{\hfil}
1606 \global\oddheadline=
{\hfil} \global\oddfootline=
{\hfil}}
1608 % When we turn headings on, set the page number to 1.
1609 % For double-sided printing, put current file name in lower left corner,
1610 % chapter name on inside top of right hand pages, document
1611 % title on inside top of left hand pages, and page numbers on outside top
1612 % edge of all pages.
1613 \def\HEADINGSdouble{
1615 \global\evenfootline=
{\hfil}
1616 \global\oddfootline=
{\hfil}
1617 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
1618 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1619 \global\let\contentsalignmacro =
\chapoddpage
1621 \let\contentsalignmacro =
\chappager
1623 % For single-sided printing, chapter title goes across top left of page,
1624 % page number on top right.
1625 \def\HEADINGSsingle{
1627 \global\evenfootline=
{\hfil}
1628 \global\oddfootline=
{\hfil}
1629 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
1630 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1631 \global\let\contentsalignmacro =
\chappager
1633 \def\HEADINGSon{\HEADINGSdouble}
1635 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
1636 \let\HEADINGSdoubleafter=
\HEADINGSafter
1637 \def\HEADINGSdoublex{%
1638 \global\evenfootline=
{\hfil}
1639 \global\oddfootline=
{\hfil}
1640 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
1641 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1642 \global\let\contentsalignmacro =
\chapoddpage
1645 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
1646 \def\HEADINGSsinglex{%
1647 \global\evenfootline=
{\hfil}
1648 \global\oddfootline=
{\hfil}
1649 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
1650 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1651 \global\let\contentsalignmacro =
\chappager
1654 % Subroutines used in generating headings
1655 % Produces Day Month Year style of output.
1656 \def\today{\number\day\space
1658 January
\or February
\or March
\or April
\or May
\or June
\or
1659 July
\or August
\or September
\or October
\or November
\or December
\fi
1662 % Use this if you want the Month Day, Year style of output.
1663 %\def\today{\ifcase\month\or
1664 %January\or February\or March\or April\or May\or June\or
1665 %July\or August\or September\or October\or November\or December\fi
1666 %\space\number\day, \number\year}
1668 % @settitle line... specifies the title of the document, for headings
1669 % It generates no output of its own
1671 \def\thistitle{No Title
}
1672 \def\settitle{\parsearg\settitlezzz}
1673 \def\settitlezzz #1{\gdef\thistitle{#1}}
1678 % @tabs -- simple alignment
1680 % These don't work. For one thing, \+ is defined as outer.
1681 % So these macros cannot even be defined.
1683 %\def\tabs{\parsearg\tabszzz}
1684 %\def\tabszzz #1{\settabs\+#1\cr}
1685 %\def\tabline{\parsearg\tablinezzz}
1686 %\def\tablinezzz #1{\+#1\cr}
1689 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1691 % default indentation of table text
1692 \newdimen\tableindent \tableindent=
.8in
1693 % default indentation of @itemize and @enumerate text
1694 \newdimen\itemindent \itemindent=
.3in
1695 % margin between end of table item and start of table text.
1696 \newdimen\itemmargin \itemmargin=
.1in
1698 % used internally for \itemindent minus \itemmargin
1701 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1703 % They also define \itemindex
1704 % to index the item name in whatever manner is desired (perhaps none).
1706 \newif\ifitemxneedsnegativevskip
1708 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
1710 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1711 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1713 \def\internalBxitem "
#1"
{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1714 \def\internalBxitemx "
#1"
{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1716 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1717 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1719 \def\kitemzzz #1{\dosubind {kw
}{\code{#1}}{for
{\bf \lastfunction}}%
1722 \def\xitemzzz #1{\dosubind {kw
}{\code{#1}}{for
{\bf \xitemsubtopic}}%
1725 \def\itemzzz #1{\begingroup %
1726 \advance\hsize by -
\rightskip
1727 \advance\hsize by -
\tableindent
1728 \setbox0=
\hbox{\itemfont{#1}}%
1730 \nobreak % This prevents a break before @itemx.
1732 % Be sure we are not still in the middle of a paragraph.
1737 % If the item text does not fit in the space we have, put it on a line
1738 % by itself, and do not allow a page break either before or after that
1739 % line. We do not start a paragraph here because then if the next
1740 % command is, e.g., @kindex, the whatsit would get put into the
1741 % horizontal list on a line by itself, resulting in extra blank space.
1742 \ifdim \wd0>
\itemmax
1744 % Make this a paragraph so we get the \parskip glue and wrapping,
1745 % but leave it ragged-right.
1747 \advance\leftskip by-
\tableindent
1748 \advance\hsize by
\tableindent
1749 \advance\rightskip by0pt plus1fil
1750 \leavevmode\unhbox0\par
1753 % We're going to be starting a paragraph, but we don't want the
1754 % \parskip glue -- logically it's part of the @item we just started.
1755 \nobreak \vskip-
\parskip
1757 % Stop a page break at the \parskip glue coming up. Unfortunately
1758 % we can't prevent a possible page break at the following
1759 % \baselineskip glue.
1762 \itemxneedsnegativevskipfalse
1764 % The item text fits into the space. Start a paragraph, so that the
1765 % following text (if any) will end up on the same line. Since that
1766 % text will be indented by \tableindent, we make the item text be in
1769 \rlap{\hskip -
\tableindent\box0}\ignorespaces%
1771 \itemxneedsnegativevskiptrue%
1775 \def\item{\errmessage{@item while not in a table
}}
1776 \def\itemx{\errmessage{@itemx while not in a table
}}
1777 \def\kitem{\errmessage{@kitem while not in a table
}}
1778 \def\kitemx{\errmessage{@kitemx while not in a table
}}
1779 \def\xitem{\errmessage{@xitem while not in a table
}}
1780 \def\xitemx{\errmessage{@xitemx while not in a table
}}
1782 %% Contains a kludge to get @end[description] to work
1783 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1785 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1786 {\obeylines\obeyspaces%
1787 \gdef\tablex #1^^M
{%
1788 \tabley\dontindex#1 \endtabley}}
1790 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1791 {\obeylines\obeyspaces%
1792 \gdef\ftablex #1^^M
{%
1793 \tabley\fnitemindex#1 \endtabley
1794 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1795 \let\Etable=
\relax}}
1797 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1798 {\obeylines\obeyspaces%
1799 \gdef\vtablex #1^^M
{%
1800 \tabley\vritemindex#1 \endtabley
1801 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1802 \let\Etable=
\relax}}
1805 \def\fnitemindex #1{\doind {fn
}{\code{#1}}}%
1806 \def\vritemindex #1{\doind {vr
}{\code{#1}}}%
1809 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1810 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1812 \def\tablez #1#2#3#4#5#6{%
1815 \def\Edescription{\Etable}% Necessary kludge.
1817 \ifnum 0#3>
0 \advance \leftskip by
#3\mil \fi %
1818 \ifnum 0#4>
0 \tableindent=
#4\mil \fi %
1819 \ifnum 0#5>
0 \advance \rightskip by
#5\mil \fi %
1821 \itemmax=
\tableindent %
1822 \advance \itemmax by -
\itemmargin %
1823 \advance \leftskip by
\tableindent %
1824 \exdentamount=
\tableindent
1826 \parskip =
\smallskipamount
1827 \ifdim \parskip=
0pt
\parskip=
2pt
\fi%
1828 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1829 \let\item =
\internalBitem %
1830 \let\itemx =
\internalBitemx %
1831 \let\kitem =
\internalBkitem %
1832 \let\kitemx =
\internalBkitemx %
1833 \let\xitem =
\internalBxitem %
1834 \let\xitemx =
\internalBxitemx %
1837 % This is the counter used by @enumerate, which is really @itemize
1841 \def\itemize{\parsearg\itemizezzz}
1843 \def\itemizezzz #1{%
1844 \begingroup % ended by the @end itemsize
1845 \itemizey {#1}{\Eitemize}
1848 \def\itemizey #1#2{%
1850 \itemmax=
\itemindent %
1851 \advance \itemmax by -
\itemmargin %
1852 \advance \leftskip by
\itemindent %
1853 \exdentamount=
\itemindent
1855 \parskip =
\smallskipamount %
1856 \ifdim \parskip=
0pt
\parskip=
2pt
\fi%
1857 \def#2{\endgraf\afterenvbreak\endgroup}%
1858 \def\itemcontents{#1}%
1859 \let\item=
\itemizeitem}
1861 % Set sfcode to normal for the chars that usually have another value.
1862 % These are `.?!:;,'
1863 \def\frenchspacing{\sfcode46=
1000 \sfcode63=
1000 \sfcode33=
1000
1864 \sfcode58=
1000 \sfcode59=
1000 \sfcode44=
1000 }
1866 % \splitoff TOKENS\endmark defines \first to be the first token in
1867 % TOKENS, and \rest to be the remainder.
1869 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1871 % Allow an optional argument of an uppercase letter, lowercase letter,
1872 % or number, to specify the first label in the enumerated list. No
1873 % argument is the same as `1'.
1875 \def\enumerate{\parsearg\enumeratezzz}
1876 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1877 \def\enumeratey #1 #2\endenumeratey{%
1878 \begingroup % ended by the @end enumerate
1880 % If we were given no argument, pretend we were given `1'.
1882 \ifx\thearg\empty \def\thearg{1}\fi
1884 % Detect if the argument is a single token. If so, it might be a
1885 % letter. Otherwise, the only valid thing it can be is a number.
1886 % (We will always have one token, because of the test we just made.
1887 % This is a good thing, since \splitoff doesn't work given nothing at
1888 % all -- the first parameter is undelimited.)
1889 \expandafter\splitoff\thearg\endmark
1891 % Only one token in the argument. It could still be anything.
1892 % A ``lowercase letter'' is one whose \lccode is nonzero.
1893 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1894 % not equal to itself.
1895 % Otherwise, we assume it's a number.
1897 % We need the \relax at the end of the \ifnum lines to stop TeX from
1898 % continuing to look for a <number>.
1900 \ifnum\lccode\expandafter`
\thearg=
0\relax
1901 \numericenumerate % a number (we hope)
1904 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
1905 \lowercaseenumerate % lowercase letter
1907 \uppercaseenumerate % uppercase letter
1911 % Multiple tokens in the argument. We hope it's a number.
1916 % An @enumerate whose labels are integers. The starting integer is
1919 \def\numericenumerate{%
1921 \startenumeration{\the\itemno}%
1924 % The starting (lowercase) letter is in \thearg.
1925 \def\lowercaseenumerate{%
1926 \itemno =
\expandafter`
\thearg
1928 % Be sure we're not beyond the end of the alphabet.
1930 \errmessage{No more lowercase letters in @enumerate; get a bigger
1937 % The starting (uppercase) letter is in \thearg.
1938 \def\uppercaseenumerate{%
1939 \itemno =
\expandafter`
\thearg
1941 % Be sure we're not beyond the end of the alphabet.
1943 \errmessage{No more uppercase letters in @enumerate; get a bigger
1950 % Call itemizey, adding a period to the first argument and supplying the
1951 % common last two arguments. Also subtract one from the initial value in
1952 % \itemno, since @item increments \itemno.
1954 \def\startenumeration#1{%
1955 \advance\itemno by -
1
1956 \itemizey{#1.
}\Eenumerate\flushcr
1959 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1962 \def\alphaenumerate{\enumerate{a
}}
1963 \def\capsenumerate{\enumerate{A
}}
1964 \def\Ealphaenumerate{\Eenumerate}
1965 \def\Ecapsenumerate{\Eenumerate}
1967 % Definition of @item while inside @itemize.
1970 \advance\itemno by
1
1971 {\let\par=
\endgraf \smallbreak}%
1972 \ifhmode \errmessage{In hmode at itemizeitem
}\fi
1973 {\parskip=
0in
\hskip 0pt
1974 \hbox to
0pt
{\hss \itemcontents\hskip \itemmargin}%
1975 \vadjust{\penalty 1200}}%
1978 % @multitable macros
1979 % Amy Hendrickson, 8/18/94, 3/6/96
1981 % @multitable ... @end multitable will make as many columns as desired.
1982 % Contents of each column will wrap at width given in preamble. Width
1983 % can be specified either with sample text given in a template line,
1984 % or in percent of \hsize, the current width of text on page.
1986 % Table can continue over pages but will only break between lines.
1990 % Either define widths of columns in terms of percent of \hsize:
1991 % @multitable @columnfractions .25 .3 .45
1994 % Numbers following @columnfractions are the percent of the total
1995 % current hsize to be used for each column. You may use as many
1996 % columns as desired.
1999 % Or use a template:
2000 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2002 % using the widest term desired in each column.
2004 % For those who want to use more than one line's worth of words in
2005 % the preamble, break the line within one argument and it
2006 % will parse correctly, i.e.,
2008 % @multitable {Column 1 template} {Column 2 template} {Column 3
2011 % @multitable {Column 1 template} {Column 2 template}
2012 % {Column 3 template}
2014 % Each new table line starts with @item, each subsequent new column
2015 % starts with @tab. Empty columns may be produced by supplying @tab's
2016 % with nothing between them for as many times as empty columns are needed,
2017 % ie, @tab@tab@tab will produce two empty columns.
2019 % @item, @tab, @multitable or @end multitable do not need to be on their
2020 % own lines, but it will not hurt if they are.
2022 % Sample multitable:
2024 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2025 % @item first col stuff @tab second col stuff @tab third col
2032 % @item first col stuff @tab second col stuff
2033 % @tab Many paragraphs of text may be used in any column.
2035 % They will wrap at the width determined by the template.
2036 % @item@tab@tab This will be in third column.
2039 % Default dimensions may be reset by user.
2040 % @multitableparskip is vertical space between paragraphs in table.
2041 % @multitableparindent is paragraph indent in table.
2042 % @multitablecolmargin is horizontal space to be left between columns.
2043 % @multitablelinespace is space to leave between table items, baseline
2045 % 0pt means it depends on current normal line spacing.
2050 \newskip\multitableparskip
2051 \newskip\multitableparindent
2052 \newdimen\multitablecolspace
2053 \newskip\multitablelinespace
2054 \multitableparskip=
0pt
2055 \multitableparindent=
6pt
2056 \multitablecolspace=
12pt
2057 \multitablelinespace=
0pt
2060 % Macros used to set up halign preamble:
2061 \let\endsetuptable\relax
2062 \def\xendsetuptable{\endsetuptable}
2063 \let\columnfractions\relax
2064 \def\xcolumnfractions{\columnfractions}
2067 %% 2/1/96, to allow fractions to be given with more than one digit.
2068 \def\pickupwholefraction#1 {\global\advance\colcount by1
%
2069 \expandafter\xdef\csname col
\the\colcount\endcsname{.
#1\hsize}%
2073 \def\setuptable#1{\def\firstarg{#1}%
2074 \ifx\firstarg\xendsetuptable\let\go\relax%
2076 \ifx\firstarg\xcolumnfractions\global\setpercenttrue%
2079 \let\go\pickupwholefraction % In this case arg of setuptable
2080 % is the decimal point before the
2081 % number given in percent of hsize.
2082 % We don't need this so we don't use it.
2084 \global\advance\colcount by1
2085 \setbox0=
\hbox{#1 }% Add a normal word space as a separator;
2086 % typically that is always in the input, anyway.
2087 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
2090 \ifx\go\pickupwholefraction\else\let\go\setuptable\fi%
2095 \def\tab{&
\hskip1sp\relax} % 2/2/96
2096 % tiny skip here makes sure this column space is
2097 % maintained, even if it is never used.
2101 % @multitable ... @end multitable definitions:
2103 \def\multitable{\parsearg\dotable}
2105 \def\dotable#1{\bgroup
2109 \setmultitablespacing
2110 \parskip=
\multitableparskip
2111 \parindent=
\multitableparindent
2113 \global\colcount=
0\relax%
2114 \def\Emultitable{\global\setpercentfalse\global\everycr{}\cr\egroup\egroup}%
2115 % To parse everything between @multitable and @item :
2116 \setuptable#1 \endsetuptable
2117 % Need to reset this to 0 after \setuptable.
2118 \global\colcount=
0\relax%
2120 % This preamble sets up a generic column definition, which will
2121 % be used as many times as user calls for columns.
2122 % \vtop will set a single line and will also let text wrap and
2123 % continue for many paragraphs if desired.
2124 \halign\bgroup&
\global\advance\colcount by
1\relax%
2125 \multistrut\vtop{\hsize=
\expandafter\csname col
\the\colcount\endcsname
2126 % In order to keep entries from bumping into each other
2127 % we will add a \leftskip of \multitablecolspace to all columns after
2129 % If a template has been used, we will add \multitablecolspace
2130 % to the width of each template entry.
2131 % If user has set preamble in terms of percent of \hsize
2132 % we will use that dimension as the width of the column, and
2133 % the \leftskip will keep entries from bumping into each other.
2134 % Table will start at left margin and final column will justify at
2140 % If user has <not> set preamble in terms of percent of \hsize
2141 % we will advance \hsize by \multitablecolspace
2142 \advance\hsize by
\multitablecolspace
2144 % In either case we will make \leftskip=\multitablecolspace:
2145 \leftskip=
\multitablecolspace
2147 % Ignoring space at the beginning and end avoids an occasional spurious
2148 % blank line, when TeX decides to break the line at the space before the
2149 % box from the multistrut, so the strut ends up on a line by itself.
2151 % @multitable @columnfractions .11 .89
2153 % @tab Legal holiday which is valid in major parts of the whole country.
2154 % Is automatically provided with highlighting sequences respectively marking
2156 \noindent\ignorespaces##
\unskip\multistrut}\cr
2157 % \everycr will reset column counter, \colcount, at the end of
2158 % each line. Every column entry will cause \colcount to advance by one.
2159 % The table preamble
2160 % looks at the current \colcount to find the correct column width.
2161 \global\everycr{\noalign{%
2162 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2163 % Maybe so, but it also creates really weird page breaks when the table
2164 % breaks over pages Wouldn't \vfil be better? Wait until the problem
2165 % manifests itself, so it can be fixed for real --karl.
2166 \global\colcount=
0\relax}}
2169 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2170 % If so, do nothing. If not, give it an appropriate dimension based on
2171 % current baselineskip.
2172 \ifdim\multitablelinespace=
0pt
2173 %% strut to put in table in case some entry doesn't have descenders,
2174 %% to keep lines equally spaced
2175 \let\multistrut =
\strut
2176 %% Test to see if parskip is larger than space between lines of
2177 %% table. If not, do nothing.
2178 %% If so, set to same dimension as multitablelinespace.
2180 \gdef\multistrut{\vrule height
\multitablelinespace depth
\dp0
2182 \ifdim\multitableparskip>
\multitablelinespace
2183 \global\multitableparskip=
\multitablelinespace
2184 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2185 %% than skip between lines in the table.
2187 \ifdim\multitableparskip=
0pt
2188 \global\multitableparskip=
\multitablelinespace
2189 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2190 %% than skip between lines in the table.
2195 % Index generation facilities
2197 % Define \newwrite to be identical to plain tex's \newwrite
2198 % except not \outer, so it can be used within \newindex.
2200 \gdef\newwrite{\alloc@
7\write\chardef\sixt@@n
}}
2202 % \newindex {foo} defines an index named foo.
2203 % It automatically defines \fooindex such that
2204 % \fooindex ...rest of line... puts an entry in the index foo.
2205 % It also defines \fooindfile to be the number of the output channel for
2206 % the file that accumulates this index. The file's extension is foo.
2207 % The name of an index should be no more than 2 characters long
2208 % for the sake of vms.
2211 \expandafter\newwrite \csname#1indfile
\endcsname% Define number for output file
2212 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
2213 \expandafter\xdef\csname#1index
\endcsname{% % Define \xxxindex
2214 \noexpand\doindex {#1}}
2217 % @defindex foo == \newindex{foo}
2219 \def\defindex{\parsearg\newindex}
2221 % Define @defcodeindex, like @defindex except put all entries in @code.
2223 \def\newcodeindex #1{
2224 \expandafter\newwrite \csname#1indfile
\endcsname% Define number for output file
2225 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
2226 \expandafter\xdef\csname#1index
\endcsname{% % Define \xxxindex
2227 \noexpand\docodeindex {#1}}
2230 \def\defcodeindex{\parsearg\newcodeindex}
2232 % @synindex foo bar makes index foo feed into index bar.
2233 % Do this instead of @defindex foo if you don't want it as a separate index.
2234 \def\synindex #1 #2 {%
2235 \expandafter\let\expandafter\synindexfoo\expandafter=
\csname#2indfile
\endcsname
2236 \expandafter\let\csname#1indfile
\endcsname=
\synindexfoo
2237 \expandafter\xdef\csname#1index
\endcsname{% % Define \xxxindex
2238 \noexpand\doindex {#2}}%
2241 % @syncodeindex foo bar similar, but put all entries made for index foo
2243 \def\syncodeindex #1 #2 {%
2244 \expandafter\let\expandafter\synindexfoo\expandafter=
\csname#2indfile
\endcsname
2245 \expandafter\let\csname#1indfile
\endcsname=
\synindexfoo
2246 \expandafter\xdef\csname#1index
\endcsname{% % Define \xxxindex
2247 \noexpand\docodeindex {#2}}%
2250 % Define \doindex, the driver for all \fooindex macros.
2251 % Argument #1 is generated by the calling \fooindex macro,
2252 % and it is "foo", the name of the index.
2254 % \doindex just uses \parsearg; it calls \doind for the actual work.
2255 % This is because \doind is more useful to call from other macros.
2257 % There is also \dosubind {index}{topic}{subtopic}
2258 % which makes an entry in a two-level index such as the operation index.
2260 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2261 \def\singleindexer #1{\doind{\indexname}{#1}}
2263 % like the previous two, but they put @code around the argument.
2264 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2265 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2268 % Take care of the plain tex accent commands.
2269 \def\"
{\realbackslash "
}%
2270 \def\`
{\realbackslash `
}%
2271 \def\'
{\realbackslash '
}%
2272 \def\^
{\realbackslash ^
}%
2273 \def\~
{\realbackslash ~
}%
2274 \def\=
{\realbackslash =
}%
2275 \def\b{\realbackslash b
}%
2276 \def\c{\realbackslash c
}%
2277 \def\d{\realbackslash d
}%
2278 \def\u{\realbackslash u
}%
2279 \def\v{\realbackslash v
}%
2280 \def\H{\realbackslash H
}%
2281 % Take care of the plain tex special European modified letters.
2282 \def\oe{\realbackslash oe
}%
2283 \def\ae{\realbackslash ae
}%
2284 \def\aa{\realbackslash aa
}%
2285 \def\OE{\realbackslash OE
}%
2286 \def\AE{\realbackslash AE
}%
2287 \def\AA{\realbackslash AA
}%
2288 \def\o{\realbackslash o
}%
2289 \def\O{\realbackslash O
}%
2290 \def\l{\realbackslash l
}%
2291 \def\L{\realbackslash L
}%
2292 \def\ss{\realbackslash ss
}%
2293 % Take care of texinfo commands likely to appear in an index entry.
2294 % (Must be a way to avoid doing expansion at all, and thus not have to
2295 % laboriously list every single command here.)
2296 \def\@
{@
}% will be @@ when we switch to @ as escape char.
2297 %\let\{ = \lbracecmd
2298 %\let\} = \rbracecmd
2299 \def\_{{\realbackslash _
}}%
2300 \def\w{\realbackslash w
}%
2301 \def\bf{\realbackslash bf
}%
2302 %\def\rm{\realbackslash rm }%
2303 \def\sl{\realbackslash sl
}%
2304 \def\sf{\realbackslash sf
}%
2305 \def\tt{\realbackslash tt
}%
2306 \def\gtr{\realbackslash gtr
}%
2307 \def\less{\realbackslash less
}%
2308 \def\hat{\realbackslash hat
}%
2309 %\def\char{\realbackslash char}%
2310 \def\TeX{\realbackslash TeX
}%
2311 \def\dots{\realbackslash dots
}%
2312 \def\result{\realbackslash result
}%
2313 \def\equiv{\realbackslash equiv
}%
2314 \def\expansion{\realbackslash expansion
}%
2315 \def\print{\realbackslash print
}%
2316 \def\error{\realbackslash error
}%
2317 \def\point{\realbackslash point
}%
2318 \def\copyright{\realbackslash copyright
}%
2319 \def\tclose#
#1{\realbackslash tclose
{#
#1}}%
2320 \def\code#
#1{\realbackslash code
{#
#1}}%
2321 \def\dotless#
#1{\realbackslash dotless
{#
#1}}%
2322 \def\samp#
#1{\realbackslash samp
{#
#1}}%
2323 \def\,#
#1{\realbackslash ,
{#
#1}}%
2324 \def\t#
#1{\realbackslash t
{#
#1}}%
2325 \def\r#
#1{\realbackslash r
{#
#1}}%
2326 \def\i#
#1{\realbackslash i
{#
#1}}%
2327 \def\b#
#1{\realbackslash b
{#
#1}}%
2328 \def\sc#
#1{\realbackslash sc
{#
#1}}%
2329 \def\cite#
#1{\realbackslash cite
{#
#1}}%
2330 \def\key#
#1{\realbackslash key
{#
#1}}%
2331 \def\file#
#1{\realbackslash file
{#
#1}}%
2332 \def\var#
#1{\realbackslash var
{#
#1}}%
2333 \def\kbd#
#1{\realbackslash kbd
{#
#1}}%
2334 \def\dfn#
#1{\realbackslash dfn
{#
#1}}%
2335 \def\emph#
#1{\realbackslash emph
{#
#1}}%
2336 \def\value#
#1{\realbackslash value
{#
#1}}%
2340 % If an index command is used in an @example environment, any spaces
2341 % therein should become regular spaces in the raw index file, not the
2342 % expansion of \tie (\\leavevmode \penalty \@M \ ).
2344 \gdef\unsepspaces{\obeyspaces\let =
\space}}
2346 % \indexnofonts no-ops all font-change commands.
2347 % This is used when outputting the strings to sort the index by.
2348 \def\indexdummyfont#1{#1}
2349 \def\indexdummytex{TeX
}
2350 \def\indexdummydots{...
}
2353 % Just ignore accents.
2354 \let\,=
\indexdummyfont
2355 \let\"=
\indexdummyfont
2356 \let\`=
\indexdummyfont
2357 \let\'=
\indexdummyfont
2358 \let\^=
\indexdummyfont
2359 \let\~=
\indexdummyfont
2360 \let\==
\indexdummyfont
2361 \let\b=
\indexdummyfont
2362 \let\c=
\indexdummyfont
2363 \let\d=
\indexdummyfont
2364 \let\u=
\indexdummyfont
2365 \let\v=
\indexdummyfont
2366 \let\H=
\indexdummyfont
2367 \let\dotless=
\indexdummyfont
2368 % Take care of the plain tex special European modified letters.
2380 \let\w=
\indexdummyfont
2381 \let\t=
\indexdummyfont
2382 \let\r=
\indexdummyfont
2383 \let\i=
\indexdummyfont
2384 \let\b=
\indexdummyfont
2385 \let\emph=
\indexdummyfont
2386 \let\strong=
\indexdummyfont
2387 \let\cite=
\indexdummyfont
2388 \let\sc=
\indexdummyfont
2389 %Don't no-op \tt, since it isn't a user-level command
2390 % and is used in the definitions of the active chars like <, >, |...
2391 %\let\tt=\indexdummyfont
2392 \let\tclose=
\indexdummyfont
2393 \let\code=
\indexdummyfont
2394 \let\file=
\indexdummyfont
2395 \let\samp=
\indexdummyfont
2396 \let\kbd=
\indexdummyfont
2397 \let\key=
\indexdummyfont
2398 \let\var=
\indexdummyfont
2399 \let\TeX=
\indexdummytex
2400 \let\dots=
\indexdummydots
2404 % To define \realbackslash, we must make \ not be an escape.
2405 % We must first make another character (@) an escape
2406 % so we do not become unable to do a definition.
2408 {\catcode`\@=
0 \catcode`\\=
\other
2409 @gdef@realbackslash
{\
}}
2411 \let\indexbackslash=
0 %overridden during \printindex.
2413 \let\SETmarginindex=
\relax %initialize!
2414 % workhorse for all \fooindexes
2415 % #1 is name of index, #2 is stuff to put there
2417 % Put the index entry in the margin if desired.
2418 \ifx\SETmarginindex\relax\else
2419 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
#2}}%
2422 \count255=
\lastpenalty
2424 \indexdummies % Must do this here, since \bf, etc expand at this stage
2427 \let\folio=
0% We will expand all macros now EXCEPT \folio.
2428 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
2429 % so it will be output as is; and it will print as backslash.
2431 % First process the index-string with all font commands turned off
2432 % to get the string to sort by.
2433 {\indexnofonts \xdef\indexsorttmp{#2}}%
2435 % Now produce the complete index entry, with both the sort key and the
2436 % original text, including any font commands.
2439 \write\csname#1indfile
\endcsname{%
2440 \realbackslash entry
{\indexsorttmp}{\folio}{\the\toks0}}%
2449 \def\dosubind #1#2#3{%
2450 {\count10=
\lastpenalty %
2451 {\indexdummies % Must do this here, since \bf, etc expand at this stage
2454 \def\rawbackslashxx{\indexbackslash}%
2456 % Now process the index-string once, with all font commands turned off,
2457 % to get the string to sort the index by.
2461 % Now produce the complete index entry. We process the index-string again,
2462 % this time with font commands expanded, to get what to print in the index.
2464 \write \csname#1indfile
\endcsname{%
2465 \realbackslash entry
{\temp1}{\folio}{#2}{#3}}}%
2469 % The index entry written in the file actually looks like
2470 % \entry {sortstring}{page}{topic}
2472 % \entry {sortstring}{page}{topic}{subtopic}
2473 % The texindex program reads in these files and writes files
2474 % containing these kinds of lines:
2476 % before the first topic whose initial is c
2477 % \entry {topic}{pagelist}
2478 % for a topic that is used without subtopics
2480 % for the beginning of a topic that is used with subtopics
2481 % \secondary {subtopic}{pagelist}
2482 % for each subtopic.
2484 % Define the user-accessible indexing commands
2485 % @findex, @vindex, @kindex, @cindex.
2487 \def\findex {\fnindex}
2488 \def\kindex {\kyindex}
2489 \def\cindex {\cpindex}
2490 \def\vindex {\vrindex}
2491 \def\tindex {\tpindex}
2492 \def\pindex {\pgindex}
2494 \def\cindexsub {\begingroup\obeylines\cindexsub}
2496 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
2497 \dosubind{cp
}{#2}{#1}}}
2499 % Define the macros used in formatting output of the sorted index material.
2501 % @printindex causes a particular index (the ??s file) to get printed.
2502 % It does not print any chapter heading (usually an @unnumbered).
2504 \def\printindex{\parsearg\doprintindex}
2505 \def\doprintindex#1{\begingroup
2506 \dobreak \chapheadingskip{10000}%
2512 % See if the index file exists and is nonempty.
2513 \openin 1 \jobname.
#1s
2515 % \enddoublecolumns gets confused if there is no text in the index,
2516 % and it loses the chapter title and the aux file entries for the
2517 % index. The easiest way to prevent this problem is to make sure
2518 % there is some text.
2519 (Index is nonexistent)
2522 % If the index file exists but is empty, then \openin leaves \ifeof
2523 % false. We have to make TeX try to read something from the file, so
2524 % it can discover if there is anything in it.
2529 % Index files are almost Texinfo source, but we use \ as the escape
2530 % character. It would be better to use @, but that's too big a change
2531 % to make right now.
2532 \def\indexbackslash{\rawbackslashxx}%
2544 % These macros are used by the sorted index file itself.
2545 % Change them to control the appearance of the index.
2547 % Same as \bigskipamount except no shrink.
2548 % \balancecolumns gets confused if there is any shrink.
2549 \newskip\initialskipamount \initialskipamount 12pt plus4pt
2552 {\let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
2553 \ifdim\lastskip<
\initialskipamount
2554 \removelastskip \penalty-
200 \vskip \initialskipamount\fi
2555 \line{\secbf#1\hfill}\kern 2pt
\penalty10000}}
2557 % This typesets a paragraph consisting of #1, dot leaders, and then #2
2558 % flush to the right margin. It is used for index and table of contents
2559 % entries. The paragraph is indented by \leftskip.
2561 \def\entry #1#2{\begingroup
2563 % Start a new paragraph if necessary, so our assignments below can't
2564 % affect previous text.
2567 % Do not fill out the last line with white space.
2570 % No extra space above this paragraph.
2573 % Do not prefer a separate line ending with a hyphen to fewer lines.
2574 \finalhyphendemerits =
0
2576 % \hangindent is only relevant when the entry text and page number
2577 % don't both fit on one line. In that case, bob suggests starting the
2578 % dots pretty far over on the line. Unfortunately, a large
2579 % indentation looks wrong when the entry text itself is broken across
2580 % lines. So we use a small indentation and put up with long leaders.
2582 % \hangafter is reset to 1 (which is the value we want) at the start
2583 % of each paragraph, so we need not do anything with that.
2586 % When the entry text needs to be broken, just fill out the first line
2588 \rightskip =
0pt plus1fil
2590 % Start a ``paragraph'' for the index entry so the line breaking
2591 % parameters we've set above will have an effect.
2594 % Insert the text of the index entry. TeX will do line-breaking on it.
2596 % The following is kludged to not output a line of dots in the index if
2597 % there are no page numbers. The next person who breaks this will be
2598 % cursed by a Unix daemon.
2601 \edef\tempc{\tempa}%
2602 \edef\tempd{\tempb}%
2603 \ifx\tempc\tempd\
\else%
2605 % If we must, put the page number on a line of its own, and fill out
2606 % this line with blank space. (The \hfil is overwhelmed with the
2607 % fill leaders glue in \indexdotfill if the page number does fit.)
2609 \null\nobreak\indexdotfill % Have leaders before the page number.
2611 % The `\ ' here is removed by the implicit \unskip that TeX does as
2612 % part of (the primitive) \par. Without it, a spurious underfull
2614 \
#2% The page number ends the paragraph.
2619 % Like \dotfill except takes at least 1 em.
2620 \def\indexdotfill{\cleaders
2621 \hbox{$
\mathsurround=
0pt
\mkern1.5mu $
{\it .
}$
\mkern1.5mu$
}\hskip 1em plus
1fill
}
2623 \def\primary #1{\line{#1\hfil}}
2625 \newskip\secondaryindent \secondaryindent=
0.5cm
2627 \def\secondary #1#2{
2628 {\parfillskip=
0in
\parskip=
0in
2629 \hangindent =
1in
\hangafter=
1
2630 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
2633 % Define two-column mode, which we use to typeset indexes.
2634 % Adapted from the TeXbook, page 416, which is to say,
2635 % the manmac.tex format used to print the TeXbook itself.
2639 \newdimen\doublecolumnhsize
2641 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
2642 % Grab any single-column material above us.
2643 \output =
{\global\setbox\partialpage =
\vbox{%
2645 % Here is a possibility not foreseen in manmac: if we accumulate a
2646 % whole lot of material, we might end up calling this \output
2647 % routine twice in a row (see the doublecol-lose test, which is
2648 % essentially a couple of indexes with @setchapternewpage off). In
2649 % that case, we must prevent the second \partialpage from
2650 % simply overwriting the first, causing us to lose the page.
2651 % This will preserve it until a real output routine can ship it
2652 % out. Generally, \partialpage will be empty when this runs and
2653 % this will be a no-op.
2656 % Unvbox the main output page.
2658 \kern-
\topskip \kern\baselineskip
2662 % Use the double-column output routine for subsequent pages.
2663 \output =
{\doublecolumnout}%
2665 % Change the page size parameters. We could do this once outside this
2666 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2667 % format, but then we repeat the same computation. Repeating a couple
2668 % of assignments once per index is clearly meaningless for the
2669 % execution time, so we may as well do it in one place.
2671 % First we halve the line length, less a little for the gutter between
2672 % the columns. We compute the gutter based on the line length, so it
2673 % changes automatically with the paper format. The magic constant
2674 % below is chosen so that the gutter has the same value (well, +-<1pt)
2675 % as it did when we hard-coded it.
2677 % We put the result in a separate register, \doublecolumhsize, so we
2678 % can restore it in \pagesofar, after \hsize itself has (potentially)
2681 \doublecolumnhsize =
\hsize
2682 \advance\doublecolumnhsize by -
.04154\hsize
2683 \divide\doublecolumnhsize by
2
2684 \hsize =
\doublecolumnhsize
2686 % Double the \vsize as well. (We don't need a separate register here,
2687 % since nobody clobbers \vsize.)
2690 \def\doublecolumnout{%
2691 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
2692 % Get the available space for the double columns -- the normal
2693 % (undoubled) page height minus any material left over from the
2695 \dimen@=
\pageheight \advance\dimen@ by-
\ht\partialpage
2696 % box0 will be the left-hand column, box2 the right.
2697 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
2698 \onepageout\pagesofar
2700 \penalty\outputpenalty
2703 % Re-output the contents of the output page -- any previous material,
2704 % followed by the two boxes we just split.
2706 \hsize =
\doublecolumnhsize
2707 \wd0=
\hsize \wd2=
\hsize \hbox to
\pagewidth{\box0\hfil\box2}%
2709 \def\enddoublecolumns{%
2710 \output =
{\balancecolumns}\eject % split what we have
2711 \endgroup % started in \begindoublecolumns
2713 % Back to normal single-column typesetting, but take account of the
2714 % fact that we just accumulated some stuff on the output page.
2717 \def\balancecolumns{%
2718 % Called at the end of the double column material.
2719 \setbox0 =
\vbox{\unvbox255}%
2721 \advance\dimen@ by
\topskip
2722 \advance\dimen@ by-
\baselineskip
2724 \splittopskip =
\topskip
2725 % Loop until we get a decent breakpoint.
2726 {\vbadness=
10000 \loop
2727 \global\setbox3=
\copy0
2728 \global\setbox1=
\vsplit3 to
\dimen@
2729 \ifdim\ht3>
\dimen@
\global\advance\dimen@ by1pt
2731 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
2732 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
2735 \catcode`\@ =
\other
2738 \message{sectioning,
}
2739 % Define chapters, sections, etc.
2742 \newcount\secno \secno=
0
2743 \newcount\subsecno \subsecno=
0
2744 \newcount\subsubsecno \subsubsecno=
0
2746 % This counter is funny since it counts through charcodes of letters A, B, ...
2747 \newcount\appendixno \appendixno = `\@
2748 \def\appendixletter{\char\the\appendixno}
2750 \newwrite\contentsfile
2751 % This is called from \setfilename.
2752 \def\opencontents{\openout\contentsfile =
\jobname.toc
}
2754 % Each @chapter defines this as the name of the chapter.
2755 % page headings and footings can use it. @section does likewise
2757 \def\thischapter{} \def\thissection{}
2758 \def\seccheck#1{\ifnum \pageno<
0
2759 \errmessage{@
#1 not allowed after generating table of contents
}%
2762 \def\chapternofonts{%
2763 \let\rawbackslash=
\relax
2764 \let\frenchspacing=
\relax
2765 \def\result{\realbackslash result
}%
2766 \def\equiv{\realbackslash equiv
}%
2767 \def\expansion{\realbackslash expansion
}%
2768 \def\print{\realbackslash print
}%
2769 \def\TeX{\realbackslash TeX
}%
2770 \def\dots{\realbackslash dots
}%
2771 \def\result{\realbackslash result
}%
2772 \def\equiv{\realbackslash equiv
}%
2773 \def\expansion{\realbackslash expansion
}%
2774 \def\print{\realbackslash print
}%
2775 \def\error{\realbackslash error
}%
2776 \def\point{\realbackslash point
}%
2777 \def\copyright{\realbackslash copyright
}%
2778 \def\tt{\realbackslash tt
}%
2779 \def\bf{\realbackslash bf
}%
2780 \def\w{\realbackslash w
}%
2781 \def\less{\realbackslash less
}%
2782 \def\gtr{\realbackslash gtr
}%
2783 \def\hat{\realbackslash hat
}%
2784 \def\char{\realbackslash char
}%
2785 \def\tclose#
#1{\realbackslash tclose
{#
#1}}%
2786 \def\code#
#1{\realbackslash code
{#
#1}}%
2787 \def\samp#
#1{\realbackslash samp
{#
#1}}%
2788 \def\r#
#1{\realbackslash r
{#
#1}}%
2789 \def\b#
#1{\realbackslash b
{#
#1}}%
2790 \def\key#
#1{\realbackslash key
{#
#1}}%
2791 \def\file#
#1{\realbackslash file
{#
#1}}%
2792 \def\kbd#
#1{\realbackslash kbd
{#
#1}}%
2793 % These are redefined because @smartitalic wouldn't work inside xdef.
2794 \def\i#
#1{\realbackslash i
{#
#1}}%
2795 \def\cite#
#1{\realbackslash cite
{#
#1}}%
2796 \def\var#
#1{\realbackslash var
{#
#1}}%
2797 \def\emph#
#1{\realbackslash emph
{#
#1}}%
2798 \def\dfn#
#1{\realbackslash dfn
{#
#1}}%
2801 \newcount\absseclevel % used to calculate proper heading level
2802 \newcount\secbase\secbase=
0 % @raise/lowersections modify this count
2804 % @raisesections: treat @section as chapter, @subsection as section, etc.
2805 \def\raisesections{\global\advance\secbase by -
1}
2806 \let\up=
\raisesections % original BFox name
2808 % @lowersections: treat @chapter as section, @section as subsection, etc.
2809 \def\lowersections{\global\advance\secbase by
1}
2810 \let\down=
\lowersections % original BFox name
2812 % Choose a numbered-heading macro
2813 % #1 is heading level if unmodified by @raisesections or @lowersections
2814 % #2 is text for heading
2815 \def\numhead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
2821 \numberedsubseczzz{#2}
2823 \numberedsubsubseczzz{#2}
2825 \ifnum \absseclevel<
0
2828 \numberedsubsubseczzz{#2}
2833 % like \numhead, but chooses appendix heading levels
2834 \def\apphead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
2838 \appendixsectionzzz{#2}
2840 \appendixsubseczzz{#2}
2842 \appendixsubsubseczzz{#2}
2844 \ifnum \absseclevel<
0
2847 \appendixsubsubseczzz{#2}
2852 % like \numhead, but chooses numberless heading levels
2853 \def\unnmhead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
2857 \unnumberedseczzz{#2}
2859 \unnumberedsubseczzz{#2}
2861 \unnumberedsubsubseczzz{#2}
2863 \ifnum \absseclevel<
0
2866 \unnumberedsubsubseczzz{#2}
2872 \def\thischaptername{No Chapter Title
}
2873 \outer\def\chapter{\parsearg\chapteryyy}
2874 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2875 \def\chapterzzz #1{\seccheck{chapter
}%
2876 \secno=
0 \subsecno=
0 \subsubsecno=
0
2877 \global\advance \chapno by
1 \message{\putwordChapter \the\chapno}%
2878 \chapmacro {#1}{\the\chapno}%
2879 \gdef\thissection{#1}%
2880 \gdef\thischaptername{#1}%
2881 % We don't substitute the actual chapter name into \thischapter
2882 % because we don't want its macros evaluated now.
2883 \xdef\thischapter{\putwordChapter{} \the\chapno:
\noexpand\thischaptername}%
2886 \edef\temp{{\realbackslash chapentry
{\the\toks0}{\the\chapno}{\noexpand\folio}}}%
2888 \write \contentsfile \temp %
2890 \global\let\section =
\numberedsec
2891 \global\let\subsection =
\numberedsubsec
2892 \global\let\subsubsection =
\numberedsubsubsec
2895 \outer\def\appendix{\parsearg\appendixyyy}
2896 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2897 \def\appendixzzz #1{\seccheck{appendix
}%
2898 \secno=
0 \subsecno=
0 \subsubsecno=
0
2899 \global\advance \appendixno by
1 \message{Appendix
\appendixletter}%
2900 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
2901 \gdef\thissection{#1}%
2902 \gdef\thischaptername{#1}%
2903 \xdef\thischapter{\putwordAppendix{} \appendixletter:
\noexpand\thischaptername}%
2906 \edef\temp{{\realbackslash chapentry
{\the\toks0}%
2907 {\putwordAppendix{} \appendixletter}{\noexpand\folio}}}%
2909 \write \contentsfile \temp %
2911 \global\let\section =
\appendixsec
2912 \global\let\subsection =
\appendixsubsec
2913 \global\let\subsubsection =
\appendixsubsubsec
2916 % @centerchap is like @unnumbered, but the heading is centered.
2917 \outer\def\centerchap{\parsearg\centerchapyyy}
2918 \def\centerchapyyy #1{{\let\unnumbchapmacro=
\centerchapmacro \unnumberedyyy{#1}}}
2920 \outer\def\top{\parsearg\unnumberedyyy}
2921 \outer\def\unnumbered{\parsearg\unnumberedyyy}
2922 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2923 \def\unnumberedzzz #1{\seccheck{unnumbered
}%
2924 \secno=
0 \subsecno=
0 \subsubsecno=
0
2926 % This used to be simply \message{#1}, but TeX fully expands the
2927 % argument to \message. Therefore, if #1 contained @-commands, TeX
2928 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2929 % expanded @cite (which turns out to cause errors because \cite is meant
2930 % to be executed, not expanded).
2932 % Anyway, we don't want the fully-expanded definition of @cite to appear
2933 % as a result of the \message, we just want `@cite' itself. We use
2934 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
2935 % simply yielding the contents of the <toks register>.
2936 \toks0 =
{#1}\message{(
\the\toks0)
}%
2938 \unnumbchapmacro {#1}%
2939 \gdef\thischapter{#1}\gdef\thissection{#1}%
2942 \edef\temp{{\realbackslash unnumbchapentry
{\the\toks0}{\noexpand\folio}}}%
2944 \write \contentsfile \temp %
2946 \global\let\section =
\unnumberedsec
2947 \global\let\subsection =
\unnumberedsubsec
2948 \global\let\subsubsection =
\unnumberedsubsubsec
2951 \outer\def\numberedsec{\parsearg\secyyy}
2952 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2953 \def\seczzz #1{\seccheck{section
}%
2954 \subsecno=
0 \subsubsecno=
0 \global\advance \secno by
1 %
2955 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2958 \edef\temp{{\realbackslash secentry
%
2959 {\the\toks0}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2961 \write \contentsfile \temp %
2966 \outer\def\appendixsection{\parsearg\appendixsecyyy}
2967 \outer\def\appendixsec{\parsearg\appendixsecyyy}
2968 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2969 \def\appendixsectionzzz #1{\seccheck{appendixsection
}%
2970 \subsecno=
0 \subsubsecno=
0 \global\advance \secno by
1 %
2971 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2974 \edef\temp{{\realbackslash secentry
%
2975 {\the\toks0}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2977 \write \contentsfile \temp %
2982 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2983 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2984 \def\unnumberedseczzz #1{\seccheck{unnumberedsec
}%
2985 \plainsecheading {#1}\gdef\thissection{#1}%
2988 \edef\temp{{\realbackslash unnumbsecentry
{\the\toks0}{\noexpand\folio}}}%
2990 \write \contentsfile \temp %
2995 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2996 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2997 \def\numberedsubseczzz #1{\seccheck{subsection
}%
2998 \gdef\thissection{#1}\subsubsecno=
0 \global\advance \subsecno by
1 %
2999 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3002 \edef\temp{{\realbackslash subsecentry
%
3003 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
3005 \write \contentsfile \temp %
3010 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3011 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3012 \def\appendixsubseczzz #1{\seccheck{appendixsubsec
}%
3013 \gdef\thissection{#1}\subsubsecno=
0 \global\advance \subsecno by
1 %
3014 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3017 \edef\temp{{\realbackslash subsecentry
%
3018 {\the\toks0}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
3020 \write \contentsfile \temp %
3025 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3026 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3027 \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec
}%
3028 \plainsubsecheading {#1}\gdef\thissection{#1}%
3031 \edef\temp{{\realbackslash unnumbsubsecentry
{\the\toks0}{\noexpand\folio}}}%
3033 \write \contentsfile \temp %
3038 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3039 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3040 \def\numberedsubsubseczzz #1{\seccheck{subsubsection
}%
3041 \gdef\thissection{#1}\global\advance \subsubsecno by
1 %
3042 \subsubsecheading {#1}
3043 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3046 \edef\temp{{\realbackslash subsubsecentry
{\the\toks0}
3047 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
3048 {\noexpand\folio}}}%
3050 \write \contentsfile \temp %
3055 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3056 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3057 \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec
}%
3058 \gdef\thissection{#1}\global\advance \subsubsecno by
1 %
3059 \subsubsecheading {#1}
3060 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3063 \edef\temp{{\realbackslash subsubsecentry
{\the\toks0}%
3065 {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
3067 \write \contentsfile \temp %
3072 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3073 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3074 \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec
}%
3075 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3078 \edef\temp{{\realbackslash unnumbsubsubsecentry
{\the\toks0}{\noexpand\folio}}}%
3080 \write \contentsfile \temp %
3085 % These are variants which are not "outer", so they can appear in @ifinfo.
3086 % Actually, they should now be obsolete; ordinary section commands should work.
3087 \def\infotop{\parsearg\unnumberedzzz}
3088 \def\infounnumbered{\parsearg\unnumberedzzz}
3089 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3090 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3091 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3093 \def\infoappendix{\parsearg\appendixzzz}
3094 \def\infoappendixsec{\parsearg\appendixseczzz}
3095 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3096 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3098 \def\infochapter{\parsearg\chapterzzz}
3099 \def\infosection{\parsearg\sectionzzz}
3100 \def\infosubsection{\parsearg\subsectionzzz}
3101 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3103 % These macros control what the section commands do, according
3104 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3105 % Define them by default for a numbered chapter.
3106 \global\let\section =
\numberedsec
3107 \global\let\subsection =
\numberedsubsec
3108 \global\let\subsubsection =
\numberedsubsubsec
3110 % Define @majorheading, @heading and @subheading
3112 % NOTE on use of \vbox for chapter headings, section headings, and
3114 % 1) We use \vbox rather than the earlier \line to permit
3115 % overlong headings to fold.
3116 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3117 % heading is obnoxious; this forbids it.
3118 % 3) Likewise, headings look best if no \parindent is used, and
3119 % if justification is not attempted. Hence \raggedright.
3122 \def\majorheading{\parsearg\majorheadingzzz}
3123 \def\majorheadingzzz #1{%
3124 {\advance\chapheadingskip by
10pt
\chapbreak }%
3125 {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3126 \parindent=
0pt
\raggedright
3127 \rm #1\hfill}}\bigskip \par\penalty 200}
3129 \def\chapheading{\parsearg\chapheadingzzz}
3130 \def\chapheadingzzz #1{\chapbreak %
3131 {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3132 \parindent=
0pt
\raggedright
3133 \rm #1\hfill}}\bigskip \par\penalty 200}
3135 % @heading, @subheading, @subsubheading.
3136 \def\heading{\parsearg\plainsecheading}
3137 \def\subheading{\parsearg\plainsubsecheading}
3138 \def\subsubheading{\parsearg\plainsubsubsecheading}
3140 % These macros generate a chapter, section, etc. heading only
3141 % (including whitespace, linebreaking, etc. around it),
3142 % given all the information in convenient, parsed form.
3144 %%% Args are the skip and penalty (usually negative)
3145 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
3147 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
3149 %%% Define plain chapter starts, and page on/off switching for it
3150 % Parameter controlling skip before chapter headings (if needed)
3152 \newskip\chapheadingskip
3154 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
3155 \def\chappager{\par\vfill\supereject}
3156 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to
0pt
{} \chappager\fi}
3158 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
3161 \global\let\contentsalignmacro =
\chappager
3162 \global\let\pchapsepmacro=
\chapbreak
3163 \global\let\pagealignmacro=
\chappager}
3166 \global\let\contentsalignmacro =
\chappager
3167 \global\let\pchapsepmacro=
\chappager
3168 \global\let\pagealignmacro=
\chappager
3169 \global\def\HEADINGSon{\HEADINGSsingle}}
3172 \global\let\contentsalignmacro =
\chapoddpage
3173 \global\let\pchapsepmacro=
\chapoddpage
3174 \global\let\pagealignmacro=
\chapoddpage
3175 \global\def\HEADINGSon{\HEADINGSdouble}}
3180 \global\let\chapmacro=
\chfplain
3181 \global\let\unnumbchapmacro=
\unnchfplain
3182 \global\let\centerchapmacro=
\centerchfplain}
3184 % Plain chapter opening.
3185 % #1 is the text, #2 the chapter number or empty if unnumbered.
3191 \setbox0 =
\hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3192 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
3193 \hangindent =
\wd0 \centerparametersmaybe
3196 \nobreak\bigskip % no page break after a chapter title
3200 % Plain opening for unnumbered.
3201 \def\unnchfplain#1{\chfplain{#1}{}}
3203 % @centerchap -- centered and unnumbered.
3204 \let\centerparametersmaybe =
\relax
3205 \def\centerchfplain#1{{%
3206 \def\centerparametersmaybe{%
3207 \advance\rightskip by
3\rightskip
3208 \leftskip =
\rightskip
3214 \CHAPFplain % The default
3216 \def\unnchfopen #1{%
3217 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3218 \parindent=
0pt
\raggedright
3219 \rm #1\hfill}}\bigskip \par\penalty 10000 %
3222 \def\chfopen #1#2{\chapoddpage {\chapfonts
3223 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
3227 \def\centerchfopen #1{%
3228 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3230 \hfill {\rm #1}\hfill}}\bigskip \par\penalty 10000 %
3234 \global\let\chapmacro=
\chfopen
3235 \global\let\unnumbchapmacro=
\unnchfopen
3236 \global\let\centerchapmacro=
\centerchfopen}
3240 \newskip\secheadingskip
3241 \def\secheadingbreak{\dobreak \secheadingskip {-
1000}}
3242 \def\secheading#1#2#3{\sectionheading{sec
}{#2.
#3}{#1}}
3243 \def\plainsecheading#1{\sectionheading{sec
}{}{#1}}
3245 % Subsection titles.
3246 \newskip \subsecheadingskip
3247 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-
500}}
3248 \def\subsecheading#1#2#3#4{\sectionheading{subsec
}{#2.
#3.
#4}{#1}}
3249 \def\plainsubsecheading#1{\sectionheading{subsec
}{}{#1}}
3251 % Subsubsection titles.
3252 \let\subsubsecheadingskip =
\subsecheadingskip
3253 \let\subsubsecheadingbreak =
\subsecheadingbreak
3254 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec
}{#2.
#3.
#4.
#5}{#1}}
3255 \def\plainsubsubsecheading#1{\sectionheading{subsubsec
}{}{#1}}
3258 % Print any size section title.
3260 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3261 % number (maybe empty), #3 the text.
3262 \def\sectionheading#1#2#3{%
3264 \expandafter\advance\csname #1headingskip
\endcsname by
\parskip
3265 \csname #1headingbreak
\endcsname
3268 % Switch to the right set of fonts.
3269 \csname #1fonts
\endcsname \rm
3271 % Only insert the separating space if we have a section number.
3273 \setbox0 =
\hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3275 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
3276 \hangindent =
\wd0 % zero if no section number
3279 \ifdim\parskip<
10pt
\nobreak\kern10pt\nobreak\kern-
\parskip\fi \nobreak
3283 \message{toc printing,
}
3284 % Finish up the main text and prepare to read what we've written
3287 \newskip\contentsrightmargin \contentsrightmargin=
1in
3288 \def\startcontents#1{%
3289 % If @setchapternewpage on, and @headings double, the contents should
3290 % start on an odd page, unlike chapters. Thus, we maintain
3291 % \contentsalignmacro in parallel with \pagealignmacro.
3292 % From: Torbjorn Granlund <tege@matematik.su.se>
3294 \immediate\closeout \contentsfile
3296 \pageno = -
1 % Request roman numbered pages.
3298 % Don't need to put `Contents' or `Short Contents' in the headline.
3299 % It is abundantly clear what they are.
3300 \unnumbchapmacro{#1}\def\thischapter{}%
3301 \begingroup % Set up to handle contents files properly.
3302 \catcode`\\=
0 \catcode`\
{=
1 \catcode`\
}=
2 \catcode`\@=
11
3303 % We can't do this, because then an actual ^ in a section
3304 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3305 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3306 \raggedbottom % Worry more about breakpoints than the bottom.
3307 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
3311 % Normal (long) toc.
3312 \outer\def\contents{%
3313 \startcontents{\putwordTableofContents}%
3319 % And just the chapters.
3320 \outer\def\summarycontents{%
3321 \startcontents{\putwordShortContents}%
3323 \let\chapentry =
\shortchapentry
3324 \let\unnumbchapentry =
\shortunnumberedentry
3325 % We want a true roman here for the page numbers.
3327 \let\rm=
\shortcontrm \let\bf=
\shortcontbf \let\sl=
\shortcontsl
3329 \hyphenpenalty =
10000
3330 \advance\baselineskip by
1pt
% Open it up a little.
3331 \def\secentry #
#1#
#2#
#3#
#4{}
3332 \def\unnumbsecentry #
#1#
#2{}
3333 \def\subsecentry #
#1#
#2#
#3#
#4#
#5{}
3334 \def\unnumbsubsecentry #
#1#
#2{}
3335 \def\subsubsecentry #
#1#
#2#
#3#
#4#
#5#
#6{}
3336 \def\unnumbsubsubsecentry #
#1#
#2{}
3341 \let\shortcontents =
\summarycontents
3343 % These macros generate individual entries in the table of contents.
3344 % The first argument is the chapter or section name.
3345 % The last argument is the page number.
3346 % The arguments in between are the chapter number, section number, ...
3348 % Chapter-level things, for both the long and short contents.
3349 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
3351 % See comments in \dochapentry re vbox and related settings
3352 \def\shortchapentry#1#2#3{%
3353 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
3356 % Typeset the label for a chapter or appendix for the short contents.
3357 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
3358 % We could simplify the code here by writing out an \appendixentry
3359 % command in the toc file for appendices, instead of using \chapentry
3360 % for both, but it doesn't seem worth it.
3361 \setbox0 =
\hbox{\shortcontrm \putwordAppendix }
3362 \newdimen\shortappendixwidth \shortappendixwidth =
\wd0
3364 \def\shortchaplabel#1{%
3365 % We typeset #1 in a box of constant width, regardless of the text of
3366 % #1, so the chapter titles will come out aligned.
3367 \setbox0 =
\hbox{#1}%
3368 \dimen0 =
\ifdim\wd0 >
\shortappendixwidth \shortappendixwidth \else 0pt
\fi
3370 % This space should be plenty, since a single number is .5em, and the
3371 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3372 % (This space doesn't include the extra space that gets added after
3373 % the label; that gets put in by \shortchapentry above.)
3374 \advance\dimen0 by
1.1em
3375 \hbox to
\dimen0{#1\hfil}%
3378 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3379 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
3382 \def\secentry#1#2#3#4{\dosecentry{#2.
#3\labelspace#1}{#4}}
3383 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
3386 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.
#3.
#4\labelspace#1}{#5}}
3387 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
3389 % And subsubsections.
3390 \def\subsubsecentry#1#2#3#4#5#6{%
3391 \dosubsubsecentry{#2.
#3.
#4.
#5\labelspace#1}{#6}}
3392 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
3394 % This parameter controls the indentation of the various levels.
3395 \newdimen\tocindent \tocindent =
3pc
3397 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3400 % If the toc has to be broken over pages, we want it to be at chapters
3401 % if at all possible; hence the \penalty.
3402 \def\dochapentry#1#2{%
3403 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
3406 \tocentry{#1}{\dopageno{#2}}%
3408 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
3411 \def\dosecentry#1#2{\begingroup
3412 \secentryfonts \leftskip=
\tocindent
3413 \tocentry{#1}{\dopageno{#2}}%
3416 \def\dosubsecentry#1#2{\begingroup
3417 \subsecentryfonts \leftskip=
2\tocindent
3418 \tocentry{#1}{\dopageno{#2}}%
3421 \def\dosubsubsecentry#1#2{\begingroup
3422 \subsubsecentryfonts \leftskip=
3\tocindent
3423 \tocentry{#1}{\dopageno{#2}}%
3426 % Final typesetting of a toc entry; we use the same \entry macro as for
3427 % the index entries, but we want to suppress hyphenation here. (We
3428 % can't do that in the \entry macro, since index entries might consist
3429 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3431 % \turnoffactive is for the sake of @" used for umlauts.
3432 \def\tocentry#1#2{\begingroup
3433 \vskip 0pt plus1pt
% allow a little stretch for the sake of nice page breaks
3434 \entry{\turnoffactive #1}{\turnoffactive #2}%
3437 % Space between chapter (or whatever) number and the title.
3438 \def\labelspace{\hskip1em \relax}
3440 \def\dopageno#1{{\rm #1}}
3441 \def\doshortpageno#1{{\rm #1}}
3443 \def\chapentryfonts{\secfonts \rm}
3444 \def\secentryfonts{\textfonts}
3445 \let\subsecentryfonts =
\textfonts
3446 \let\subsubsecentryfonts =
\textfonts
3449 \message{environments,
}
3451 % Since these characters are used in examples, it should be an even number of
3452 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3453 % Furthermore, these definitions must come after we define our fonts.
3454 \newbox\dblarrowbox \newbox\longdblarrowbox
3455 \newbox\pushcharbox \newbox\bullbox
3456 \newbox\equivbox \newbox\errorbox
3459 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3460 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3461 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3462 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3463 % Adapted from the manmac format (p.420 of TeXbook)
3464 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3468 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3470 \def\result{\leavevmode\raise.15ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
3471 \def\expansion{\leavevmode\raise.1ex
\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
3472 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
3473 \def\equiv{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
3475 % Adapted from the TeXbook's \boxit.
3476 {\tentt \global\dimen0 =
3em
}% Width of the box.
3477 \dimen2 =
.55pt
% Thickness of rules
3478 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3479 \setbox0 =
\hbox{\kern-
.75pt
\tensf error
\kern-
1.5pt
}
3481 \global\setbox\errorbox=
\hbox to
\dimen0{\hfil
3482 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
3483 \advance\hsize by -
2\dimen2 % Rules.
3485 \hrule height
\dimen2
3486 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
3487 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
3488 \kern3pt\vrule width
\dimen2}% Space to right.
3489 \hrule height
\dimen2}
3492 % The @error{} command.
3493 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
3495 % @tex ... @end tex escapes into raw Tex temporarily.
3496 % One exception: @ is still an escape character, so that @end tex works.
3497 % But \@ or @@ will get a plain tex @ character.
3499 \def\tex{\begingroup
3500 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
3501 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
3502 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
13 \let~=
\tie
3504 \catcode 43=
12 % plus
3518 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
3519 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
3521 \let\bullet=
\ptexbullet
3522 \let\b=
\ptexb \let\c=
\ptexc \let\i=
\ptexi \let\t=
\ptext
3524 \let\Etex=
\endgroup}
3526 % Define @lisp ... @endlisp.
3527 % @lisp does a \begingroup so it can rebind things,
3528 % including the definition of @endlisp (which normally is erroneous).
3530 % Amount to narrow the margins by for @lisp.
3531 \newskip\lispnarrowing \lispnarrowing=
0.4in
3533 % This is the definition that ^^M gets inside @lisp, @example, and other
3534 % such environments. \null is better than a space, since it doesn't
3536 \def\lisppar{\null\endgraf}
3538 % Make each space character in the input produce a normal interword
3539 % space in the output. Don't allow a line break at this space, as this
3540 % is used only in environments like @example, where each line of input
3541 % should produce a line of output anyway.
3544 \gdef\sepspaces{\obeyspaces\let =
\tie}}
3546 % Define \obeyedspace to be our active space, whatever it is. This is
3547 % for use in \parsearg.
3549 \global\let\obeyedspace=
}
3551 % This space is always present above and below environments.
3552 \newskip\envskipamount \envskipamount =
0pt
3554 % Make spacing and below environment symmetrical. We use \parskip here
3555 % to help in doing that, since in @example-like environments \parskip
3556 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
3557 % start of the next paragraph will insert \parskip
3559 \def\aboveenvbreak{{\advance\envskipamount by
\parskip
3560 \endgraf \ifdim\lastskip<
\envskipamount
3561 \removelastskip \penalty-
50 \vskip\envskipamount \fi}}
3563 \let\afterenvbreak =
\aboveenvbreak
3565 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
3566 \let\nonarrowing=
\relax
3568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3569 % \cartouche: draw rectangle w/rounded corners around argument
3570 \font\circle=lcircle10
3572 \newdimen\cartouter\newdimen\cartinner
3573 \newskip\normbskip\newskip\normpskip\newskip\normlskip
3574 \circthick=
\fontdimen8\circle
3576 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
3577 \def\ctr{{\hskip 6pt
\circle\char'
010}}
3578 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
3579 \def\cbr{{\hskip 6pt
\circle\char'
011}}
3580 \def\carttop{\hbox to
\cartouter{\hskip\lskip
3581 \ctl\leaders\hrule height
\circthick\hfil\ctr
3583 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
3584 \cbl\leaders\hrule height
\circthick\hfil\cbr
3587 \newskip\lskip\newskip\rskip
3589 \long\def\cartouche{%
3591 \lskip=
\leftskip \rskip=
\rightskip
3592 \leftskip=
0pt
\rightskip=
0pt
%we want these *outside*.
3593 \cartinner=
\hsize \advance\cartinner by-
\lskip
3594 \advance\cartinner by-
\rskip
3596 \advance\cartouter by
18pt
% allow for 3pt kerns on either
3597 % side, and for 6pt waste from
3599 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
3600 % Flag to tell @lisp, etc., not to narrow margin.
3601 \let\nonarrowing=
\comment
3603 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
3612 \baselineskip=
\normbskip
3613 \lineskip=
\normlskip
3629 % This macro is called at the beginning of all the @example variants,
3633 \inENV % This group ends at the end of the body
3634 \hfuzz =
12pt
% Don't be fussy
3635 \sepspaces % Make spaces be word-separators rather than space tokens.
3637 \let\par =
\lisppar % don't ignore blank lines
3638 \obeylines % each line of input is a line of output
3641 \emergencystretch =
0pt
% don't try to avoid overfull boxes
3642 % @cartouche defines \nonarrowing to inhibit narrowing
3643 % at next level down.
3644 \ifx\nonarrowing\relax
3645 \advance \leftskip by
\lispnarrowing
3646 \exdentamount=
\lispnarrowing
3647 \let\exdent=
\nofillexdent
3648 \let\nonarrowing=
\relax
3652 % To ending an @example-like environment, we first end the paragraph
3653 % (via \afterenvbreak's vertical glue), and then the group. That way we
3654 % keep the zero \parskip that the environments set -- \parskip glue
3655 % will be inserted at the beginning of the next paragraph in the
3656 % document, after the environment.
3658 \def\nonfillfinish{\afterenvbreak\endgroup}%
3660 \def\lisp{\begingroup
3662 \let\Elisp =
\nonfillfinish
3664 % Make @kbd do something special, if requested.
3665 \let\kbdfont\kbdexamplefont
3666 \rawbackslash % have \ input char produce \ char from current font
3670 % Define the \E... control sequence only if we are inside the
3671 % environment, so the error checking in \end will work.
3673 % We must call \lisp last in the definition, since it reads the
3674 % return following the @example (or whatever) command.
3676 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
3677 \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
3678 \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
3680 % @smallexample and @smalllisp. This is not used unless the @smallbook
3681 % command is given. Originally contributed by Pavel@xerox.
3683 \def\smalllispx{\begingroup
3685 \let\Esmalllisp =
\nonfillfinish
3686 \let\Esmallexample =
\nonfillfinish
3688 % Smaller fonts for small examples.
3690 \rawbackslash % make \ output the \ character from the current font (tt)
3694 % This is @display; same as @lisp except use roman font.
3696 \def\display{\begingroup
3698 \let\Edisplay =
\nonfillfinish
3702 % This is @format; same as @display except don't narrow margins.
3704 \def\format{\begingroup
3705 \let\nonarrowing = t
3707 \let\Eformat =
\nonfillfinish
3711 % @flushleft (same as @format) and @flushright.
3713 \def\flushleft{\begingroup
3714 \let\nonarrowing = t
3716 \let\Eflushleft =
\nonfillfinish
3719 \def\flushright{\begingroup
3720 \let\nonarrowing = t
3722 \let\Eflushright =
\nonfillfinish
3723 \advance\leftskip by
0pt plus
1fill
3726 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
3727 % and narrows the margins.
3730 \begingroup\inENV %This group ends at the end of the @quotation body
3731 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
3734 % We have retained a nonzero parskip for the environment, since we're
3735 % doing normal filling. So to avoid extra space below the environment...
3736 \def\Equotation{\parskip =
0pt
\nonfillfinish}%
3738 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
3739 \ifx\nonarrowing\relax
3740 \advance\leftskip by
\lispnarrowing
3741 \advance\rightskip by
\lispnarrowing
3742 \exdentamount =
\lispnarrowing
3743 \let\nonarrowing =
\relax
3748 % Define formatter for defuns
3749 % First, allow user to change definition object font (\df) internally
3750 \def\setdeffont #1 {\csname DEF
#1\endcsname}
3752 \newskip\defbodyindent \defbodyindent=
.4in
3753 \newskip\defargsindent \defargsindent=
50pt
3754 \newskip\deftypemargin \deftypemargin=
12pt
3755 \newskip\deflastargmargin \deflastargmargin=
18pt
3757 \newcount\parencount
3758 % define \functionparens, which makes ( and ) and & do special things.
3759 % \functionparens affects the group it is contained in.
3761 \catcode`\(=
\active \catcode`\)=
\active \catcode`\&=
\active
3762 \catcode`\
[=
\active \catcode`\
]=
\active}
3764 % Make control sequences which act like normal parenthesis chars.
3765 \let\lparen = (
\let\rparen = )
3767 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3769 % Be sure that we always have a definition for `(', etc. For example,
3770 % if the fn name has parens in it, \boldbrax will not be in effect yet,
3771 % so TeX would otherwise complain about undefined control sequence.
3772 \global\let(=
\lparen \global\let)=
\rparen
3773 \global\let[=
\lbrack \global\let]=
\rbrack
3775 \gdef\functionparens{\boldbrax\let&=
\amprm\parencount=
0 }
3776 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
3777 % This is used to turn on special parens
3778 % but make & act ordinary (given that it's active).
3779 \gdef\boldbraxnoamp{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb\let&=
\ampnr}
3781 % Definitions of (, ) and & used in args for functions.
3782 % This is the definition of ( outside of all parentheses.
3783 \gdef\oprm#1 {{\rm\char`\(
}#1 \bf \let(=
\opnested
3784 \global\advance\parencount by
1
3787 % This is the definition of ( when already inside a level of parens.
3788 \gdef\opnested{\char`\(
\global\advance\parencount by
1 }
3790 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3791 % also in that case restore the outer-level definition of (.
3792 \ifnum \parencount=
1 {\rm \char `\)
}\sl \let(=
\oprm \else \char `\)
\fi
3793 \global\advance \parencount by -
1 }
3794 % If we encounter &foo, then turn on ()-hacking afterwards
3795 \gdef\amprm#1 {{\rm\&
#1}\let(=
\oprm \let)=
\clrm\
}
3797 \gdef\normalparens{\boldbrax\let&=
\ampnr}
3798 } % End of definition inside \activeparens
3799 %% These parens (in \boldbrax) actually are a little bolder than the
3800 %% contained text. This is especially needed for [ and ]
3801 \def\opnr{{\sf\char`\(
}\global\advance\parencount by
1 }
3802 \def\clnr{{\sf\char`\)
}\global\advance\parencount by -
1 }
3804 \def\lbrb{{\bf\char`\
[}}
3805 \def\rbrb{{\bf\char`\
]}}
3807 % First, defname, which formats the header line itself.
3808 % #1 should be the function name.
3809 % #2 should be the type of definition, such as "Function".
3812 % Get the values of \leftskip and \rightskip as they were
3813 % outside the @def...
3815 \advance\dimen2 by -
\defbodyindent
3817 \advance\dimen3 by -
\defbodyindent
3819 \setbox0=
\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3820 \dimen0=
\hsize \advance \dimen0 by -
\wd0 % compute size for first line
3821 \dimen1=
\hsize \advance \dimen1 by -
\defargsindent %size for continuations
3822 \parshape 2 0in
\dimen0 \defargsindent \dimen1 %
3823 % Now output arg 2 ("Function" or some such)
3824 % ending at \deftypemargin from the right margin,
3825 % but stuck inside a box of width 0 so it does not interfere with linebreaking
3826 {% Adjust \hsize to exclude the ambient margins,
3827 % so that \rightline will obey them.
3828 \advance \hsize by -
\dimen2 \advance \hsize by -
\dimen3
3829 \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3830 % Make all lines underfull and no complaints:
3831 \tolerance=
10000 \hbadness=
10000
3832 \advance\leftskip by -
\defbodyindent
3833 \exdentamount=
\defbodyindent
3834 {\df #1}\enskip % Generate function name
3837 % Actually process the body of a definition
3838 % #1 should be the terminating control sequence, such as \Edefun.
3839 % #2 should be the "another name" control sequence, such as \defunx.
3840 % #3 should be the control sequence that actually processes the header,
3841 % such as \defunheader.
3843 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3845 % Define the end token that this defining construct specifies
3846 % so that it will exit this group.
3847 \def#1{\endgraf\endgroup\medbreak}%
3848 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3850 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3851 \exdentamount=
\defbodyindent
3853 \catcode 61=
\active % 61 is `='
3854 \obeylines\activeparens\spacesplit#3}
3856 \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3858 % Define the end token that this defining construct specifies
3859 % so that it will exit this group.
3860 \def#1{\endgraf\endgroup\medbreak}%
3861 \def#2#
#1 {\begingroup\obeylines\activeparens\spacesplit{#3{#
#1}}}%
3863 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3864 \exdentamount=
\defbodyindent
3865 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3867 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3869 % Define the end token that this defining construct specifies
3870 % so that it will exit this group.
3871 \def#1{\endgraf\endgroup\medbreak}%
3872 \def#2#
#1 #
#2 {\def#4{#
#1}%
3873 \begingroup\obeylines\activeparens\spacesplit{#3{#
#2}}}%
3875 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3876 \exdentamount=
\defbodyindent
3877 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3879 % These parsing functions are similar to the preceding ones
3880 % except that they do not make parens into active characters.
3881 % These are used for "variables" since they have no arguments.
3883 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3885 % Define the end token that this defining construct specifies
3886 % so that it will exit this group.
3887 \def#1{\endgraf\endgroup\medbreak}%
3888 \def#2{\begingroup\obeylines\spacesplit#3}%
3890 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3891 \exdentamount=
\defbodyindent
3893 \catcode 61=
\active %
3894 \obeylines\spacesplit#3}
3896 % This is used for \def{tp,vr}parsebody. It could probably be used for
3897 % some of the others, too, with some judicious conditionals.
3899 \def\parsebodycommon#1#2#3{%
3902 % Define the end token that this defining construct specifies
3903 % so that it will exit this group.
3904 \def#1{\endgraf\endgroup\medbreak}%
3905 \def#2#
#1 {\begingroup\obeylines\spacesplit{#3{#
#1}}}%
3907 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3908 \exdentamount=
\defbodyindent
3909 \begingroup\obeylines
3912 \def\defvrparsebody#1#2#3#4 {%
3913 \parsebodycommon{#1}{#2}{#3}%
3914 \spacesplit{#3{#4}}%
3917 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3918 % type is just `struct', because we lose the braces in `{struct
3919 % termios}' when \spacesplit reads its undelimited argument. Sigh.
3920 % \let\deftpparsebody=\defvrparsebody
3922 % So, to get around this, we put \empty in with the type name. That
3923 % way, TeX won't find exactly `{...}' as an undelimited argument, and
3924 % won't strip off the braces.
3926 \def\deftpparsebody #1#2#3#4 {%
3927 \parsebodycommon{#1}{#2}{#3}%
3928 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3931 % Fine, but then we have to eventually remove the \empty *and* the
3932 % braces (if any). That's what this does.
3934 \def\removeemptybraces\empty#1\relax{#1}
3936 % After \spacesplit has done its work, this is called -- #1 is the final
3937 % thing to call, #2 the type name (which starts with \empty), and #3
3938 % (which might be empty) the arguments.
3940 \def\parsetpheaderline#1#2#3{%
3941 #1{\removeemptybraces#2\relax}{#3}%
3944 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3946 % Define the end token that this defining construct specifies
3947 % so that it will exit this group.
3948 \def#1{\endgraf\endgroup\medbreak}%
3949 \def#2#
#1 #
#2 {\def#4{#
#1}%
3950 \begingroup\obeylines\spacesplit{#3{#
#2}}}%
3952 \advance\leftskip by
\defbodyindent \advance \rightskip by
\defbodyindent
3953 \exdentamount=
\defbodyindent
3954 \begingroup\obeylines\spacesplit{#3{#5}}}
3956 % Split up #2 at the first space token.
3957 % call #1 with two arguments:
3958 % the first is all of #2 before the space token,
3959 % the second is all of #2 after that space token.
3960 % If #2 contains no space token, all of it is passed as the first arg
3961 % and the second is passed as empty.
3964 \gdef\spacesplit#1#2^^M
{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3965 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3967 #1{#2}{}\else #1{#2}{#3#4}\fi}}
3969 % So much for the things common to all kinds of definitions.
3973 % First, define the processing that is wanted for arguments of \defun
3974 % Use this to expand the args and terminate the paragraph they make up
3976 \def\defunargs #1{\functionparens \sl
3977 % Expand, preventing hyphenation at `-' chars.
3978 % Note that groups don't affect changes in \hyphenchar.
3981 \hyphenchar\tensl=
45
3982 \ifnum\parencount=
0 \else \errmessage{Unbalanced parentheses in @def
}\fi%
3983 \interlinepenalty=
10000
3984 \advance\rightskip by
0pt plus
1fil
3985 \endgraf\penalty 10000\vskip -
\parskip\penalty 10000%
3988 \def\deftypefunargs #1{%
3989 % Expand, preventing hyphenation at `-' chars.
3990 % Note that groups don't affect changes in \hyphenchar.
3991 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
3993 \tclose{#1}% avoid \code because of side effects on active chars
3994 \interlinepenalty=
10000
3995 \advance\rightskip by
0pt plus
1fil
3996 \endgraf\penalty 10000\vskip -
\parskip\penalty 10000%
3999 % Do complete processing of one @defun or @defunx line already parsed.
4001 % @deffn Command forward-char nchars
4003 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4005 \def\deffnheader #1#2#3{\doind {fn
}{\code{#2}}%
4006 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4007 \catcode 61=
\other % Turn off change made in \defparsebody
4010 % @defun == @deffn Function
4012 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4014 \def\defunheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
4015 \begingroup\defname {#1}{Function
}%
4016 \defunargs {#2}\endgroup %
4017 \catcode 61=
\other % Turn off change made in \defparsebody
4020 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4022 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4024 % #1 is the data type. #2 is the name and args.
4025 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4026 % #1 is the data type, #2 the name, #3 the args.
4027 \def\deftypefunheaderx #1#2 #3\relax{%
4028 \doind {fn
}{\code{#2}}% Make entry in function index
4029 \begingroup\defname {\defheaderxcond#1\relax$$$
#2}{Function
}%
4030 \deftypefunargs {#3}\endgroup %
4031 \catcode 61=
\other % Turn off change made in \defparsebody
4034 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4036 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4038 % \defheaderxcond#1\relax$$$
4039 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4040 \def\defheaderxcond#1#2$$$
{\ifx#1\relax\else\code{#1#2} \fi}
4042 % #1 is the classification. #2 is the data type. #3 is the name and args.
4043 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4044 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4045 \def\deftypefnheaderx #1#2#3 #4\relax{%
4046 \doind {fn
}{\code{#3}}% Make entry in function index
4048 \normalparens % notably, turn off `&' magic, which prevents
4049 % at least some C++ text from working
4050 \defname {\defheaderxcond#2\relax$$$
#3}{#1}%
4051 \deftypefunargs {#4}\endgroup %
4052 \catcode 61=
\other % Turn off change made in \defparsebody
4055 % @defmac == @deffn Macro
4057 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4059 \def\defmacheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
4060 \begingroup\defname {#1}{Macro
}%
4061 \defunargs {#2}\endgroup %
4062 \catcode 61=
\other % Turn off change made in \defparsebody
4065 % @defspec == @deffn Special Form
4067 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4069 \def\defspecheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
4070 \begingroup\defname {#1}{Special Form
}%
4071 \defunargs {#2}\endgroup %
4072 \catcode 61=
\other % Turn off change made in \defparsebody
4075 % This definition is run if you use @defunx
4076 % anywhere other than immediately after a @defun or @defunx.
4078 \def\deffnx #1 {\errmessage{@deffnx in invalid context
}}
4079 \def\defunx #1 {\errmessage{@defunx in invalid context
}}
4080 \def\defmacx #1 {\errmessage{@defmacx in invalid context
}}
4081 \def\defspecx #1 {\errmessage{@defspecx in invalid context
}}
4082 \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context
}}
4083 \def\deftypemethodx #1 {\errmessage{@deftypemethodx in invalid context
}}
4084 \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context
}}
4086 % @defmethod, and so on
4088 % @defop {Funny Method} foo-class frobnicate argument
4090 \def\defop #1 {\def\defoptype{#1}%
4091 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4093 \def\defopheader #1#2#3{%
4094 \dosubind {fn
}{\code{#2}}{on
#1}% Make entry in function index
4095 \begingroup\defname {#2}{\defoptype{} on
#1}%
4096 \defunargs {#3}\endgroup %
4099 % @deftypemethod foo-class return-type foo-method args
4101 \def\deftypemethod{%
4102 \defmethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4104 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4105 \def\deftypemethodheader#1#2#3#4{%
4106 \deftypefnheaderx{Method on
#1}{#2}#3 #4\relax
4109 % @defmethod == @defop Method
4111 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4113 \def\defmethodheader #1#2#3{%
4114 \dosubind {fn
}{\code{#2}}{on
#1}% entry in function index
4115 \begingroup\defname {#2}{Method on
#1}%
4116 \defunargs {#3}\endgroup %
4119 % @defcv {Class Option} foo-class foo-flag
4121 \def\defcv #1 {\def\defcvtype{#1}%
4122 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4124 \def\defcvarheader #1#2#3{%
4125 \dosubind {vr
}{\code{#2}}{of
#1}% Make entry in var index
4126 \begingroup\defname {#2}{\defcvtype{} of
#1}%
4127 \defvarargs {#3}\endgroup %
4130 % @defivar == @defcv {Instance Variable}
4132 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
4134 \def\defivarheader #1#2#3{%
4135 \dosubind {vr
}{\code{#2}}{of
#1}% Make entry in var index
4136 \begingroup\defname {#2}{Instance Variable of
#1}%
4137 \defvarargs {#3}\endgroup %
4140 % These definitions are run if you use @defmethodx, etc.,
4141 % anywhere other than immediately after a @defmethod, etc.
4143 \def\defopx #1 {\errmessage{@defopx in invalid context
}}
4144 \def\defmethodx #1 {\errmessage{@defmethodx in invalid context
}}
4145 \def\defcvx #1 {\errmessage{@defcvx in invalid context
}}
4146 \def\defivarx #1 {\errmessage{@defivarx in invalid context
}}
4150 % First, define the processing that is wanted for arguments of @defvar.
4151 % This is actually simple: just print them in roman.
4152 % This must expand the args and terminate the paragraph they make up
4153 \def\defvarargs #1{\normalparens #1%
4154 \interlinepenalty=
10000
4155 \endgraf\penalty 10000\vskip -
\parskip\penalty 10000}
4157 % @defvr Counter foo-count
4159 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
4161 \def\defvrheader #1#2#3{\doind {vr
}{\code{#2}}%
4162 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
4164 % @defvar == @defvr Variable
4166 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
4168 \def\defvarheader #1#2{\doind {vr
}{\code{#1}}% Make entry in var index
4169 \begingroup\defname {#1}{Variable
}%
4170 \defvarargs {#2}\endgroup %
4173 % @defopt == @defvr {User Option}
4175 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
4177 \def\defoptheader #1#2{\doind {vr
}{\code{#1}}% Make entry in var index
4178 \begingroup\defname {#1}{User Option
}%
4179 \defvarargs {#2}\endgroup %
4182 % @deftypevar int foobar
4184 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
4186 % #1 is the data type. #2 is the name, perhaps followed by text that
4187 % is actually part of the data type, which should not be put into the index.
4188 \def\deftypevarheader #1#2{%
4189 \dovarind#2 \relax% Make entry in variables index
4190 \begingroup\defname {\defheaderxcond#1\relax$$$
#2}{Variable
}%
4191 \interlinepenalty=
10000
4192 \endgraf\penalty 10000\vskip -
\parskip\penalty 10000
4194 \def\dovarind#1 #2\relax{\doind{vr
}{\code{#1}}}
4196 % @deftypevr {Global Flag} int enable
4198 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
4200 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
4201 \begingroup\defname {\defheaderxcond#2\relax$$$
#3}{#1}
4202 \interlinepenalty=
10000
4203 \endgraf\penalty 10000\vskip -
\parskip\penalty 10000
4206 % This definition is run if you use @defvarx
4207 % anywhere other than immediately after a @defvar or @defvarx.
4209 \def\defvrx #1 {\errmessage{@defvrx in invalid context
}}
4210 \def\defvarx #1 {\errmessage{@defvarx in invalid context
}}
4211 \def\defoptx #1 {\errmessage{@defoptx in invalid context
}}
4212 \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context
}}
4213 \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context
}}
4216 % Args are printed in bold, a slight difference from @defvar.
4218 \def\deftpargs #1{\bf \defvarargs{#1}}
4220 % @deftp Class window height width ...
4222 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
4224 \def\deftpheader #1#2#3{\doind {tp
}{\code{#2}}%
4225 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
4227 % This definition is run if you use @deftpx, etc
4228 % anywhere other than immediately after a @deftp, etc.
4230 \def\deftpx #1 {\errmessage{@deftpx in invalid context
}}
4233 \message{cross reference,
}
4234 % Define cross-reference macros
4237 \newif\ifhavexrefs % True if xref values are known.
4238 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
4240 % @inforef is simple.
4241 \def\inforef #1{\inforefzzz #1,,,,**
}
4242 \def\inforefzzz #1,
#2,
#3,
#4**
{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
4243 node
\samp{\ignorespaces#1{}}}
4245 % \setref{foo} defines a cross-reference point named foo.
4248 \dosetq{#1-title
}{Ytitle
}%
4249 \dosetq{#1-pg
}{Ypagenumber
}%
4250 \dosetq{#1-snt
}{Ysectionnumberandtype
}}
4252 \def\unnumbsetref#1{%
4253 \dosetq{#1-title
}{Ytitle
}%
4254 \dosetq{#1-pg
}{Ypagenumber
}%
4255 \dosetq{#1-snt
}{Ynothing
}}
4257 \def\appendixsetref#1{%
4258 \dosetq{#1-title
}{Ytitle
}%
4259 \dosetq{#1-pg
}{Ypagenumber
}%
4260 \dosetq{#1-snt
}{Yappendixletterandtype
}}
4262 % \xref, \pxref, and \ref generate cross-references to specified points.
4263 % For \xrefX, #1 is the node name, #2 the name of the Info
4264 % cross-reference, #3 the printed node name, #4 the name of the Info
4265 % file, #5 the name of the printed manual. All but the node name can be
4268 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
4269 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
4270 \def\ref#1{\xrefX[#1,,,,,,,
]}
4271 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
4272 \def\printedmanual{\ignorespaces #5}%
4273 \def\printednodename{\ignorespaces #3}%
4274 \setbox1=
\hbox{\printedmanual}%
4275 \setbox0=
\hbox{\printednodename}%
4277 % No printed node name was explicitly given.
4278 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname\relax
4279 % Use the node name inside the square brackets.
4280 \def\printednodename{\ignorespaces #1}%
4282 % Use the actual chapter/section title appear inside
4283 % the square brackets. Use the real section title if we have it.
4285 % It is in another manual, so we don't have it.
4286 \def\printednodename{\ignorespaces #1}%
4289 % We know the real title if we have the xref values.
4290 \def\printednodename{\refx{#1-title
}{}}%
4292 % Otherwise just copy the Info node name.
4293 \def\printednodename{\ignorespaces #1}%
4299 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
4300 % insert empty discretionaries after hyphens, which means that it will
4301 % not find a line break at a hyphen in a node names. Since some manuals
4302 % are best written with fairly long node names, containing hyphens, this
4303 % is a loss. Therefore, we give the text of the node name again, so it
4304 % is as if TeX is seeing it for the first time.
4306 \putwordsection{} ``
\printednodename'' in
\cite{\printedmanual}%
4308 % _ (for example) has to be the character _ for the purposes of the
4309 % control sequence corresponding to the node, but it has to expand
4310 % into the usual \leavevmode...\vrule stuff for purposes of
4311 % printing. So we \turnoffactive for the \refx-snt, back on for the
4312 % printing, back off for the \refx-pg.
4313 {\turnoffactive \refx{#1-snt
}{}}%
4314 \space [\printednodename],
\space
4315 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
4319 % \dosetq is the interface for calls from other macros
4321 % Use \turnoffactive so that punctuation chars such as underscore
4322 % work in node names.
4323 \def\dosetq #1#2{{\let\folio=
0 \turnoffactive
4324 \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
4327 % \internalsetq {foo}{page} expands into
4328 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
4329 % When the aux file is read, ' is the escape character
4331 \def\internalsetq #1#2{'xrdef
{#1}{\csname #2\endcsname}}
4333 % Things to be expanded by \internalsetq
4335 \def\Ypagenumber{\folio}
4337 \def\Ytitle{\thissection}
4341 \def\Ysectionnumberandtype{%
4342 \ifnum\secno=
0 \putwordChapter\xreftie\the\chapno %
4343 \else \ifnum \subsecno=
0 \putwordSection\xreftie\the\chapno.
\the\secno %
4344 \else \ifnum \subsubsecno=
0 %
4345 \putwordSection\xreftie\the\chapno.
\the\secno.
\the\subsecno %
4347 \putwordSection\xreftie\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno %
4350 \def\Yappendixletterandtype{%
4351 \ifnum\secno=
0 \putwordAppendix\xreftie'char
\the\appendixno{}%
4352 \else \ifnum \subsecno=
0 \putwordSection\xreftie'char
\the\appendixno.
\the\secno %
4353 \else \ifnum \subsubsecno=
0 %
4354 \putwordSection\xreftie'char
\the\appendixno.
\the\secno.
\the\subsecno %
4356 \putwordSection\xreftie'char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno %
4361 % Use TeX 3.0's \inputlineno to get the line number, for better error
4362 % messages, but if we're using an old version of TeX, don't do anything.
4364 \ifx\inputlineno\thisisundefined
4365 \let\linenumber =
\empty % Non-3.0.
4367 \def\linenumber{\the\inputlineno:
\space}
4370 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
4371 % If its value is nonempty, SUFFIX is output afterward.
4374 \expandafter\ifx\csname X
#1\endcsname\relax
4375 % If not defined, say something at least.
4376 $
\langle$un\-de\-fined$
\rangle$
%
4378 \message{\linenumber Undefined cross reference `
#1'.
}%
4381 \global\warnedxrefstrue
4382 \message{Cross reference values unknown; you must run TeX again.
}%
4386 % It's defined, so just use it.
4387 \csname X
#1\endcsname
4389 #2% Output the suffix in any case.
4392 % This is the macro invoked by entries in the aux file.
4395 \expandafter\gdef\csname X
#1\endcsname{#2}%
4398 % Read the last existing aux file, if any. No error if none exists.
4399 \def\readauxfile{\begingroup
4400 \catcode`\^^@=
\other
4401 \catcode`\^^A=
\other
4402 \catcode`\^^B=
\other
4403 \catcode`\^^C=
\other
4404 \catcode`\^^D=
\other
4405 \catcode`\^^E=
\other
4406 \catcode`\^^F=
\other
4407 \catcode`\^^G=
\other
4408 \catcode`\^^H=
\other
4409 \catcode`\^^K=
\other
4410 \catcode`\^^L=
\other
4411 \catcode`\^^N=
\other
4412 \catcode`\^^P=
\other
4413 \catcode`\^^Q=
\other
4414 \catcode`\^^R=
\other
4415 \catcode`\^^S=
\other
4416 \catcode`\^^T=
\other
4417 \catcode`\^^U=
\other
4418 \catcode`\^^V=
\other
4419 \catcode`\^^W=
\other
4420 \catcode`\^^X=
\other
4421 \catcode`\^^Z=
\other
4422 \catcode`\^^
[=
\other
4423 \catcode`\^^\=
\other
4424 \catcode`\^^
]=
\other
4425 \catcode`\^^^=
\other
4426 \catcode`\^^_=
\other
4429 % It was suggested to define this as 7, which would allow ^^e4 etc.
4430 % in xref tags, i.e., node names. But since ^^e4 notation isn't
4431 % supported in the main text, it doesn't seem desirable. Furthermore,
4432 % that is not enough: for node names that actually contain a ^
4433 % character, we would end up writing a line like this: 'xrdef {'hat
4434 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
4435 % argument, and \hat is not an expandable control sequence. It could
4436 % all be worked out, but why? Either we support ^^ or we don't.
4438 % The other change necessary for this was to define \auxhat:
4439 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
4440 % and then to call \auxhat in \setq.
4453 % `\+ does not work, so use 43.
4455 % Make the characters 128-255 be printing characters
4459 \catcode\count 1=
\other
4460 \advance\count 1 by
1
4461 \ifnum \count 1<
256 \loop \fi
4464 % The aux file uses ' as the escape (for now).
4465 % Turn off \ as an escape so we do not lose on
4466 % entries which were dumped with control sequences in their names.
4467 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
4468 % Reference to such entries still does not work the way one would wish,
4469 % but at least they do not bomb out when the aux file is read in.
4476 \openin 1 \jobname.aux
4480 \global\havexrefstrue
4481 \global\warnedobstrue
4483 % Open the new aux file. TeX will close it automatically at exit.
4484 \openout\auxfile=
\jobname.aux
4490 \newcount \footnoteno
4492 % The trailing space in the following definition for supereject is
4493 % vital for proper filling; pages come out unaligned when you do a
4494 % pagealignmacro call if that space before the closing brace is
4495 % removed. (Generally, numeric constants should always be followed by a
4496 % space to prevent strange expansion errors.)
4497 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
4499 % @footnotestyle is meaningful for info output only.
4500 \let\footnotestyle=
\comment
4502 \let\ptexfootnote=
\footnote
4506 % Auto-number footnotes. Otherwise like plain.
4508 \global\advance\footnoteno by \@ne
4509 \edef\thisfootno{$^
{\the\footnoteno}$
}%
4511 % In case the footnote comes at the end of a sentence, preserve the
4512 % extra spacing after we do the footnote number.
4514 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\/
\fi
4516 % Remove inadvertent blank space before typesetting the footnote number.
4522 % Don't bother with the trickery in plain.tex to not require the
4523 % footnote text as a parameter. Our footnotes don't need to be so general.
4525 % Oh yes, they do; otherwise, @ifset and anything else that uses
4526 % \parseargline fail inside footnotes because the tokens are fixed when
4527 % the footnote is read. --karl, 16nov96.
4529 \long\gdef\footnotezzz{\insert\footins\bgroup
4530 % We want to typeset this text as a normal paragraph, even if the
4531 % footnote reference occurs in (for example) a display environment.
4532 % So reset some parameters.
4533 \interlinepenalty\interfootnotelinepenalty
4534 \splittopskip\ht\strutbox % top baseline for broken footnotes
4535 \splitmaxdepth\dp\strutbox
4536 \floatingpenalty\@MM
4541 \parindent\defaultparindent
4543 % Hang the footnote text off the number.
4545 \textindent{\thisfootno}%
4547 % Don't crash into the line above the footnote text. Since this
4548 % expands into a box, it must come within the paragraph, lest it
4549 % provide a place where TeX can split the footnote.
4551 \futurelet\next\fo@t
4553 \def\fo@t
{\ifcat\bgroup\noexpand\next \let\next\f@@t
4554 \else\let\next\f@t
\fi \next}
4555 \def\f@@t
{\bgroup\aftergroup\@foot
\let\next}
4556 \def\f@t
#1{#1\@foot
}
4557 \def\@foot
{\strut\egroup}
4559 }%end \catcode `\@=11
4561 % Set the baselineskip to #1, and the lineskip and strut size
4562 % correspondingly. There is no deep meaning behind these magic numbers
4563 % used as factors; they just match (closely enough) what Knuth defined.
4565 \def\lineskipfactor{.08333}
4566 \def\strutheightpercent{.70833}
4567 \def\strutdepthpercent {.29167}
4570 \normalbaselineskip =
#1\relax
4571 \normallineskip =
\lineskipfactor\normalbaselineskip
4573 \setbox\strutbox =
\hbox{%
4574 \vrule width0pt height
\strutheightpercent\baselineskip
4575 depth
\strutdepthpercent \baselineskip
4579 % @| inserts a changebar to the left of the current line. It should
4580 % surround any changed text. This approach does *not* work if the
4581 % change spans more than two lines of output. To handle that, we would
4582 % have adopt a much more difficult approach (putting marks into the main
4583 % vertical list for the beginning and end of each change).
4586 % \vadjust can only be used in horizontal mode.
4589 % Append this vertical mode material after the current line in the output.
4591 % We want to insert a rule with the height and depth of the current
4592 % leading; that is exactly what \strutbox is supposed to record.
4593 \vskip-
\baselineskip
4595 % \vadjust-items are inserted at the left edge of the type. So
4596 % the \llap here moves out into the left-hand margin.
4599 % For a thicker or thinner bar, change the `1pt'.
4600 \vrule height
\baselineskip width1pt
4602 % This is the space between the bar and the text.
4608 % For a final copy, take out the rectangles
4609 % that mark overfull boxes (in case you have decided
4610 % that the text looks ok even though it passes the margin).
4612 \def\finalout{\overfullrule=
0pt
}
4614 % @image. We use the macros from epsf.tex to support this.
4615 % If epsf.tex is not installed and @image is used, we complain.
4617 % Check for and read epsf.tex up front. If we read it only at @image
4618 % time, we might be inside a group, and then its definitions would get
4619 % undone and the next image would fail.
4620 \openin 1 = xepsf.tex
4623 \def\epsfannounce{\toks0 =
}% do not bother showing banner
4627 \newif\ifwarnednoepsf
4628 \newhelp\noepsfhelp{epsf.tex must be installed for images to
4629 work. It is also included in the Texinfo distribution, or you can get
4630 it from ftp://ftp.tug.org/tex/epsf.tex.
}
4632 % Only complain once about lack of epsf.tex.
4634 \ifx\epsfbox\undefined
4635 \ifwarnednoepsf \else
4636 \errhelp =
\noepsfhelp
4637 \errmessage{epsf.tex not found, images will be ignored
}%
4638 \global\warnednoepsftrue
4641 \imagexxx #1,,,
\finish
4645 % Arguments to @image:
4646 % #1 is (mandatory) image filename; we tack on .eps extension.
4647 % #2 is (optional) width, #3 is (optional) height.
4648 % #4 is just the usual extra ignored arg for parsing this stuff.
4649 \def\imagexxx#1,
#2,
#3,
#4\finish{%
4650 % \epsfbox itself resets \epsf?size at each figure.
4651 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
4652 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
4656 % End of control word definitions.
4659 \message{and turning on texinfo input format.
}
4670 % Set some numeric style parameters, for 8.5 x 11 format.
4674 \newdimen\defaultparindent \defaultparindent =
15pt
4675 \parindent =
\defaultparindent
4676 \parskip 3pt plus
2pt minus
1pt
4678 \advance\topskip by
1.2cm
4680 \chapheadingskip =
15pt plus
4pt minus
2pt
4681 \secheadingskip =
12pt plus
3pt minus
2pt
4682 \subsecheadingskip =
9pt plus
2pt minus
2pt
4684 % Prevent underfull vbox error messages.
4687 % Following George Bush, just get rid of widows and orphans.
4691 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
4692 % using an old version of TeX, don't do anything. We want the amount of
4693 % stretch added to depend on the line length, hence the dependence on
4694 % \hsize. This makes it come to about 9pt for the 8.5x11 format.
4696 \ifx\emergencystretch\thisisundefined
4697 % Allow us to assign to \emergencystretch anyway.
4698 \def\emergencystretch{\dimen0}%
4700 \emergencystretch =
\hsize
4701 \divide\emergencystretch by
45
4704 % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
4706 \global\chapheadingskip =
15pt plus
4pt minus
2pt
4707 \global\secheadingskip =
12pt plus
3pt minus
2pt
4708 \global\subsecheadingskip =
9pt plus
2pt minus
2pt
4710 \global\lispnarrowing =
0.3in
4712 \advance\topskip by -
1cm
4713 \global\parskip 2pt plus
1pt
4716 \global\tolerance=
700
4718 \global\contentsrightmargin=
0pt
4719 \global\deftypemargin=
0pt
4720 \global\defbodyindent=
.5cm
4722 \global\pagewidth=
\hsize
4723 \global\pageheight=
\vsize
4725 \global\let\smalllisp=
\smalllispx
4726 \global\let\smallexample=
\smalllispx
4727 \global\def\Esmallexample{\Esmalllisp}
4730 % Use @afourpaper to print on European A4 paper.
4732 \global\tolerance=
700
4735 \global\parskip 15pt plus
1pt
4737 \global\vsize=
53\baselineskip
4738 \advance\vsize by
\topskip
4739 %\global\hsize= 5.85in % A4 wide 10pt
4740 \global\hsize=
6.5in
4741 \global\outerhsize=
\hsize
4742 \global\advance\outerhsize by
0.5in
4743 \global\outervsize=
\vsize
4744 \global\advance\outervsize by
0.6in
4746 \global\pagewidth=
\hsize
4747 \global\pageheight=
\vsize
4751 \normaloffset=
\hoffset
4755 % Allow control of the text dimensions. Parameters in order: textheight;
4756 % textwidth; voffset; hoffset; binding offset; topskip.
4757 % All require a dimension;
4758 % header is additional; added length extends the bottom of the page.
4760 \def\changepagesizes#1#2#3#4#5#6{
4763 \advance\vsize by
\topskip
4766 \global\outerhsize=
\hsize
4767 \global\advance\outerhsize by
0.5in
4768 \global\outervsize=
\vsize
4769 \global\advance\outervsize by
0.6in
4770 \global\pagewidth=
\hsize
4771 \global\pageheight=
\vsize
4772 \global\normaloffset=
#4
4773 \global\bindingoffset=
#5}
4775 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
4776 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
4778 {\global\tolerance=
700
4781 \global\parskip 15pt plus
1pt
4782 \advance\baselineskip by
1.6pt
4783 \changepagesizes{237mm
}{150mm
}{3.6mm
}{3.6mm
}{3mm
}{7mm
}
4786 % Use @afourwide to print on European A4 paper in wide format.
4787 \def\afourwide{\afourpaper
4788 \changepagesizes{9.5in
}{6.5in
}{\hoffset}{\normaloffset}{\bindingoffset}{7mm
}}
4790 % Define macros to output various characters with catcode for normal text.
4799 \def\normaldoublequote{"
}
4802 \def\normalunderscore{_
}
4803 \def\normalverticalbar{|
}
4805 \def\normalgreater{>
}
4808 % This macro is used to make a character print one way in ttfont
4809 % where it can probably just be output, and another way in other fonts,
4810 % where something hairier probably needs to be done.
4812 % #1 is what to print if we are indeed using \tt; #2 is what to print
4813 % otherwise. Since all the Computer Modern typewriter fonts have zero
4814 % interword stretch (and shrink), and it is reasonable to expect all
4815 % typewriter fonts to have this, we can check that font parameter.
4817 \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=
0pt
#1\else #2\fi}
4819 % Turn off all special characters except @
4820 % (and those which the user can use as if they were ordinary).
4821 % Most of these we simply print from the \tt font, but for some, we can
4822 % use math or other variants that look better in normal text.
4825 \def\activedoublequote{{\tt \char '
042}}
4826 \let"=
\activedoublequote
4828 \def~
{{\tt \char '
176}}
4834 \def_{\ifusingtt\normalunderscore\_}
4835 % Subroutine for the previous macro.
4836 \def\_{\leavevmode \kern.06em
\vbox{\hrule width
.3em height
.1ex
}}
4839 \def|
{{\tt \char '
174}}
4847 \def+
{{\tt \char 43}}
4848 %\catcode 27=\active
4849 %\def^^[{$\diamondsuit$}
4851 % Set up an active definition for =, but don't enable it most of the time.
4852 {\catcode`\==
\active
4853 \global\def=
{{\tt \char 61}}}
4858 % If a .fmt file is being used, characters that might appear in a file
4859 % name cannot be active until we have parsed the command line.
4860 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
4861 % \otherifyactive is called near the end of this file.
4862 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
4866 % \rawbackslashxx output one backslash character in current font
4867 \global\chardef\rawbackslashxx=`\\
4868 %{\catcode`\\=\other
4869 %@gdef@rawbackslashxx{\}}
4871 % \rawbackslash redefines \ as input to do \rawbackslashxx.
4872 {\catcode`\\=
\active
4873 @gdef@rawbackslash
{@let\=@rawbackslashxx
}}
4875 % \normalbackslash outputs one backslash in fixed width font.
4876 \def\normalbackslash{{\tt\rawbackslashxx}}
4878 % Say @foo, not \foo, in error messages.
4881 % \catcode 17=0 % Define control-q
4884 % Used sometimes to turn off (effectively) the active characters
4885 % even after parsing them.
4886 @def@turnoffactive
{@let"=@normaldoublequote
4887 @let\=@realbackslash
4890 @let_=@normalunderscore
4891 @let|=@normalverticalbar
4893 @let>=@normalgreater
4896 @def@normalturnoffactive
{@let"=@normaldoublequote
4897 @let\=@normalbackslash
4900 @let_=@normalunderscore
4901 @let|=@normalverticalbar
4903 @let>=@normalgreater
4906 % Make _ and + \other characters, temporarily.
4907 % This is canceled by @fixbackslash.
4910 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4911 % That is what \eatinput is for; after that, the `\' should revert to printing
4914 @gdef@eatinput input texinfo
{@fixbackslash
}
4915 @global@let\ = @eatinput
4917 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
4918 % the first `\{ in the file would cause an error. This macro tries to fix
4919 % that, assuming it is called before the first `\' could plausibly occur.
4920 % Also back turn on active characters that might appear in the input
4921 % file name, in case not using a pre-dumped format.
4923 @gdef@fixbackslash
{@ifx\@eatinput @let\ = @normalbackslash @fi
4924 @catcode`+=@active @catcode`@_=@active
}
4926 %% These look ok in all fonts, so just make them not special. The @rm below
4927 %% makes sure that the current font starts out as the newly loaded cmr10
4928 @catcode`@$=@other @catcode`@
%=@other @catcode`@&=@other @catcode`@#=@other
4934 @c page-delimiter: "^\\\
\message"