1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2003-01-30.15}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at
14 % your option) any later version.
16 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details.
21 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 % Boston, MA 02111-1307, USA.
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org),
36 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
40 % The texinfo.tex in any given Texinfo distribution could well be out
41 % of date, so if that's what you're using, please check.
43 % Send bug reports to bug-texinfo@gnu.org. Please include including a
44 % complete document in each bug report with which we can reproduce the
45 % problem. Patches are, of course, greatly appreciated.
47 % To process a Texinfo manual with TeX, it's most reliable to use the
48 % texi2dvi shell script that comes with the distribution. For a simple
49 % manual foo.texi, however, you can get away with this:
54 % dvips foo.dvi -o # or whatever; this makes foo.ps.
55 % The extra TeX runs get the cross-reference information correct.
56 % Sometimes one run after texindex suffices, and sometimes you need more
57 % than two; texi2dvi does it as many times as necessary.
59 % It is possible to adapt texinfo.tex for other languages, to some
60 % extent. You can get the existing language-specific files from the
61 % full Texinfo distribution.
63 \message{Loading texinfo [version \texinfoversion]:}
65 % If in a .fmt file, print the version number
66 % and turn on active characters that we couldn't do earlier because
67 % they might have appeared in the input file name.
68 \everyjob{\message{[Texinfo version \texinfoversion]}%
69 \catcode`+=\active \catcode`\_=\active}
74 % We never want plain's outer \+ definition in Texinfo.
75 % For @tex, we can use \tabalign.
78 % Save some parts of plain tex whose names we will redefine.
80 \let\ptexbullet=\bullet
98 % If this character appears in an error message or help string, it
99 % starts a new line in the output.
102 % Set up fixed words for English if not already set.
103 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
104 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
105 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
106 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
107 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
108 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
109 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
110 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
111 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
112 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
113 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
114 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
115 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
116 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
117 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
118 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
119 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
120 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
121 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
123 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
124 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
125 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
126 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
127 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
128 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
129 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
130 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
131 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
132 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
133 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
134 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
136 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
137 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
138 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
139 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
140 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
141 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
142 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
144 % In some macros, we cannot use the `\? notation---the left quote is
145 % in some cases the escape char.
146 \chardef\colonChar = `\:
147 \chardef\commaChar = `\,
148 \chardef\dotChar = `\.
149 \chardef\equalChar = `\=
150 \chardef\exclamChar= `\!
151 \chardef\questChar = `\?
152 \chardef\semiChar = `\;
153 \chardef\spaceChar = `\ %
154 \chardef\underChar = `\_
160 % True if #1 is the empty string, i.e., called like `\ifempty{}'.
162 \def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}%
163 \def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}%
166 \hyphenation{ap-pen-dix}
167 \hyphenation{mini-buf-fer mini-buf-fers}
169 \hyphenation{white-space}
171 % Margin to add to right of even pages, to left of odd pages.
172 \newdimen\bindingoffset
173 \newdimen\normaloffset
174 \newdimen\pagewidth \newdimen\pageheight
176 % Sometimes it is convenient to have everything in the transcript file
177 % and nothing on the terminal. We don't just call \tracingall here,
178 % since that produces some useless output on the terminal. We also make
179 % some effort to order the tracing commands to reduce output in the log
180 % file; cf. trace.sty in LaTeX.
182 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
186 \tracinglostchars2 % 2 gives us more in etex
191 \showboxbreadth\maxdimen \showboxdepth\maxdimen
192 \ifx\eTeXversion\undefined\else % etex gives us more logging
199 \tracingcommands3 % 3 gives us more in etex
200 \errorcontextlines\maxdimen
203 % add check for \lastpenalty to plain's definitions. If the last thing
204 % we did was a \nobreak, we don't want to insert more space.
206 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
207 \removelastskip\penalty-50\smallskip\fi\fi}
208 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
209 \removelastskip\penalty-100\medskip\fi\fi}
210 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
211 \removelastskip\penalty-200\bigskip\fi\fi}
213 % For @cropmarks command.
214 % Do @cropmarks to get crop marks.
217 \let\cropmarks = \cropmarkstrue
219 % Dimensions to add cropmarks at corners.
220 % Added by P. A. MacKay, 12 Nov. 1986
222 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
223 \newdimen\cornerlong \cornerlong=1pc
224 \newdimen\cornerthick \cornerthick=.3pt
225 \newdimen\topandbottommargin \topandbottommargin=.75in
227 % Main output routine.
229 \output = {\onepageout{\pagecontents\PAGE}}
234 % \onepageout takes a vbox as an argument. Note that \pagecontents
235 % does insertions, but you have to call it yourself.
237 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
239 \ifodd\pageno \advance\hoffset by \bindingoffset
240 \else \advance\hoffset by -\bindingoffset\fi
242 % Do this outside of the \shipout so @code etc. will be expanded in
243 % the headline as they should be, not taken literally (outputting ''code).
244 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
245 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
248 % Have to do this stuff outside the \shipout because we want it to
249 % take effect in \write's, yet the group defined by the \vbox ends
250 % before the \shipout runs.
252 \escapechar = `\\ % use backslash in output files.
253 \indexdummies % don't expand commands in the output.
254 \normalturnoffactive % \ in index entries must not stay \, e.g., if
255 % the page break happens to be in the middle of an example.
257 % Do this early so pdf references go to the beginning of the page.
258 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
260 \ifcropmarks \vbox to \outervsize\bgroup
262 \vskip-\topandbottommargin
264 \line{\ewtop\hfil\ewtop}%
267 \vbox{\moveleft\cornerthick\nstop}%
269 \vbox{\moveright\cornerthick\nstop}%
272 \vskip\topandbottommargin
274 \hfil % center the page within the outer (page) hsize.
275 \ifodd\pageno\hskip\bindingoffset\fi
281 \ifdim\ht\footlinebox > 0pt
282 % Only leave this space if the footline is nonempty.
283 % (We lessened \vsize for it in \oddfootingxxx.)
284 % The \baselineskip=24pt in plain's \makefootline has no effect.
285 \vskip 2\baselineskip
290 \egroup % end of \vbox\bgroup
291 \hfil\egroup % end of (centering) \line\bgroup
292 \vskip\topandbottommargin plus1fill minus1fill
293 \boxmaxdepth = \cornerthick
296 \vbox{\moveleft\cornerthick\nsbot}%
298 \vbox{\moveright\cornerthick\nsbot}%
301 \line{\ewbot\hfil\ewbot}%
303 \egroup % \vbox from first cropmarks clause
305 }% end of \shipout\vbox
306 }% end of group with \normalturnoffactive
308 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
311 \newinsert\margin \dimen\margin=\maxdimen
313 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
315 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
316 % marginal hacks, juha@viisa.uucp (Juha Takala)
317 \ifvoid\margin\else % marginal info is present
318 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
319 \dimen@=\dp#1 \unvbox#1
320 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
321 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
324 % Here are the rules for the cropmarks. Note that they are
325 % offset so that the space between them is truly \outerhsize or \outervsize
326 % (P. A. MacKay, 12 November, 1986)
328 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
330 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
331 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
333 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
335 % Parse an argument, then pass it to #1. The argument is the rest of
336 % the input line (except we remove a trailing comment). #1 should be a
337 % macro which expects an ordinary undelimited TeX argument.
343 \futurelet\temp\parseargx
346 % If the next token is an obeyed space (from an @example environment or
347 % the like), remove it and recurse. Otherwise, we're done.
349 % \obeyedspace is defined far below, after the definition of \sepspaces.
350 \ifx\obeyedspace\temp
351 \expandafter\parseargdiscardspace
353 \expandafter\parseargline
357 % Remove a single space (as the delimiter token to the macro call).
359 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
362 \gdef\parseargline#1^^M{%
363 \endgroup % End of the group started in \parsearg.
365 % First remove any @c comment, then any @comment.
366 % Result of each macro is put in \toks0.
367 \argremovec #1\c\relax %
368 \expandafter\argremovecomment \the\toks0 \comment\relax %
370 % Call the caller's macro, saved as \next in \parsearg.
371 \expandafter\next\expandafter{\the\toks0}%
375 % Since all \c{,omment} does is throw away the argument, we can let TeX
376 % do that for us. The \relax here is matched by the \relax in the call
377 % in \parseargline; it could be more or less anything, its purpose is
378 % just to delimit the argument to the \c.
379 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
380 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
382 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
383 % @end itemize @c foo
384 % will have two active spaces as part of the argument with the
385 % `itemize'. Here we remove all active spaces from #1, and assign the
388 % This loses if there are any *other* active characters besides spaces
389 % in the argument -- _ ^ +, for example -- since they get expanded.
390 % Fortunately, Texinfo does not define any such commands. (If it ever
391 % does, the catcode of the characters in questionwill have to be changed
392 % here.) But this means we cannot call \removeactivespaces as part of
393 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
394 % that \parsearg gets might well have any character at all in it.
396 \def\removeactivespaces#1{%
400 \global\toks0 = \expandafter{\temp}%
404 % Change the active space to expand to nothing.
408 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
412 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
414 %% These are used to keep @begin/@end levels from running away
415 %% Call \inENV within environments (after a \begingroup)
416 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
418 \ifENV\errmessage{Still within an environment; press RETURN to continue}
419 \endgroup\fi} % This is not perfect, but it should reduce lossage
421 % @begin foo is the same as @foo, for now.
422 \newhelp\EMsimple{Press RETURN to continue.}
424 \outer\def\begin{\parsearg\beginxxx}
427 \expandafter\ifx\csname #1\endcsname\relax
428 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
429 \csname #1\endcsname\fi}
431 % @end foo executes the definition of \Efoo.
433 \def\end{\parsearg\endxxx}
435 \removeactivespaces{#1}%
436 \edef\endthing{\the\toks0}%
438 \expandafter\ifx\csname E\endthing\endcsname\relax
439 \expandafter\ifx\csname \endthing\endcsname\relax
440 % There's no \foo, i.e., no ``environment'' foo.
442 \errmessage{Undefined command `@end \endthing'}%
444 \unmatchedenderror\endthing
447 % Everything's ok; the right environment has been started.
448 \csname E\endthing\endcsname
452 % There is an environment #1, but it hasn't been started. Give an error.
454 \def\unmatchedenderror#1{%
456 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
459 % Define the control sequence \E#1 to give an unmatched @end error.
461 \def\defineunmatchedend#1{%
462 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
466 %% Simple single-character @ commands
469 % Kludge this until the fonts are right (grr).
472 % This is turned off because it was never documented
473 % and you can use @w{...} around a quote to suppress ligatures.
474 %% Define @` and @' to be the same as ` and '
475 %% but suppressing ligatures.
479 % Used to generate quoted braces.
480 \def\mylbrace {{\tt\char123}}
481 \def\myrbrace {{\tt\char125}}
485 % Definitions to produce \{ and \} commands for indices,
486 % and @{ and @} for the aux file.
487 \catcode`\{ = \other \catcode`\} = \other
488 \catcode`\[ = 1 \catcode`\] = 2
489 \catcode`\! = 0 \catcode`\\ = \other
492 !gdef!lbraceatcmd[@{]%
493 !gdef!rbraceatcmd[@}]%
496 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
497 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
500 \def\ringaccent#1{{\accent23 #1}}
505 % Other special characters: @questiondown @exclamdown
506 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
507 \def\questiondown{?`}
510 % Dotless i and dotless j, used for accents.
515 \ifx\temp\imacro \ptexi
516 \else\ifx\temp\jmacro \j
517 \else \errmessage{@dotless can be used only with i or j}%
521 % Be sure we're in horizontal mode when doing a tie, since we make space
522 % equivalent to this in @example-like environments. Otherwise, a space
523 % at the beginning of a line will start with \penalty -- and
524 % since \penalty is valid in vertical mode, we'd end up putting the
525 % penalty on the vertical list instead of in the new paragraph.
527 % Avoid using \@M directly, because that causes trouble
528 % if the definition is written into an index file.
529 \global\let\tiepenalty = \@M
530 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
533 % @: forces normal size whitespace following.
534 \def\:{\spacefactor=1000 }
536 % @* forces a line break.
537 \def\*{\hfil\break\hbox{}\ignorespaces}
539 % @. is an end-of-sentence period.
540 \def\.{.\spacefactor=3000 }
542 % @! is an end-of-sentence bang.
543 \def\!{!\spacefactor=3000 }
545 % @? is an end-of-sentence query.
546 \def\?{?\spacefactor=3000 }
548 % @w prevents a word break. Without the \leavevmode, @w at the
549 % beginning of a paragraph, when TeX is still in vertical mode, would
550 % produce a whole line of output instead of starting the paragraph.
551 \def\w#1{\leavevmode\hbox{#1}}
553 % @group ... @end group forces ... to be all on one page, by enclosing
554 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
555 % to keep its height that of a normal line. According to the rules for
556 % \topskip (p.114 of the TeXbook), the glue inserted is
557 % max (\topskip - \ht (first item), 0). If that height is large,
558 % therefore, no glue is inserted, and the space between the headline and
559 % the text is small, which looks bad.
561 \def\group{\begingroup
562 \ifnum\catcode13=\active \else
563 \errhelp = \groupinvalidhelp
564 \errmessage{@group invalid in context where filling is enabled}%
567 % The \vtop we start below produces a box with normal height and large
568 % depth; thus, TeX puts \baselineskip glue before it, and (when the
569 % next line of text is done) \lineskip glue after it. (See p.82 of
570 % the TeXbook.) Thus, space below is not quite equal to space
571 % above. But it's pretty close.
573 \egroup % End the \vtop.
574 \endgroup % End the \group.
578 % We have to put a strut on the last line in case the @group is in
579 % the midst of an example, rather than completely enclosing it.
580 % Otherwise, the interline space between the last line of the group
581 % and the first line afterwards is too small. But we can't put the
582 % strut in \Egroup, since there it would be on a line by itself.
583 % Hence this just inserts a strut at the beginning of each line.
584 \everypar = {\strut}%
586 % Since we have a strut on every line, we don't need any of TeX's
587 % normal interline spacing.
590 % OK, but now we have to do something about blank
591 % lines in the input in @example-like environments, which normally
592 % just turn into \lisppar, which will insert no space now that we've
593 % turned off the interline space. Simplest is to make them be an
596 \edef\par{\leavevmode \par}%
598 % Reset ^^M's definition to new definition of \par.
602 % Do @comment since we are called inside an environment such as
603 % @example, where each end-of-line in the input causes an
604 % end-of-line in the output. We don't want the end-of-line after
605 % the `@group' to put extra space in the output. Since @group
606 % should appear on a line by itself (according to the Texinfo
607 % manual), we don't worry about eating any user text.
611 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
612 % message, so this ends up printing `@group can only ...'.
614 \newhelp\groupinvalidhelp{%
615 group can only be used in environments such as @example,^^J%
616 where each line of input produces a line of output.}
618 % @need space-in-mils
619 % forces a page break if there is not space-in-mils remaining.
621 \newdimen\mil \mil=0.001in
623 \def\need{\parsearg\needx}
625 % Old definition--didn't work.
626 %\def\needx #1{\par %
627 %% This method tries to make TeX break the page naturally
628 %% if the depth of the box does not fit.
630 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
635 % Ensure vertical mode, so we don't make a big box in the middle of a
639 % If the @need value is less than one line space, it's useless.
641 \dimen2 = \ht\strutbox
642 \advance\dimen2 by \dp\strutbox
643 \ifdim\dimen0 > \dimen2
645 % Do a \strut just to make the height of this box be normal, so the
646 % normal leading is inserted relative to the preceding line.
647 % And a page break here is fine.
648 \vtop to #1\mil{\strut\vfil}%
650 % TeX does not even consider page breaks if a penalty added to the
651 % main vertical list is 10000 or more. But in order to see if the
652 % empty box we just added fits on the page, we must make it consider
653 % page breaks. On the other hand, we don't want to actually break the
654 % page after the empty box. So we use a penalty of 9999.
656 % There is an extremely small chance that TeX will actually break the
657 % page at this \penalty, if there are no other feasible breakpoints in
658 % sight. (If the user is using lots of big @group commands, which
659 % almost-but-not-quite fill up a page, TeX will have a hard time doing
660 % good page breaking, for example.) However, I could not construct an
661 % example where a page broke at this \penalty; if it happens in a real
662 % document, then we can reconsider our strategy.
665 % Back up by the size of the box, whether we did a page break or not.
668 % Do not allow a page break right after this kern.
673 % @br forces paragraph break
677 % @dots{} output an ellipsis using the current font.
678 % We do .5em per period so that it has the same spacing in a typewriter
679 % font as three actual period characters.
684 \hskip 0pt plus 0.25fil minus 0.25fil
686 \hskip 0pt plus 0.5fil minus 0.5fil
690 % @enddots{} is an end-of-sentence ellipsis.
695 \hskip 0pt plus 0.25fil minus 0.25fil
697 \hskip 0pt plus 0.5fil minus 0.5fil
703 % @page forces the start of a new page
705 \def\page{\par\vfill\supereject}
708 % outputs text on separate line in roman font, starting at standard page margin
710 % This records the amount of indent in the innermost environment.
711 % That's how much \exdent should take out.
712 \newskip\exdentamount
714 % This defn is used inside fill environments such as @defun.
715 \def\exdent{\parsearg\exdentyyy}
716 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
718 % This defn is used inside nofill environments such as @example.
719 \def\nofillexdent{\parsearg\nofillexdentyyy}
720 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
721 \leftline{\hskip\leftskip{\rm#1}}}}
723 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
724 % paragraph. For more general purposes, use the \margin insertion
725 % class. WHICH is `l' or `r'.
727 \newskip\inmarginspacing \inmarginspacing=1cm
728 \def\strutdepth{\dp\strutbox}
730 \def\doinmargin#1#2{\strut\vadjust{%
733 \vtop to \strutdepth{%
734 \baselineskip=\strutdepth
736 % if you have multiple lines of stuff to put here, you'll need to
737 % make the vbox yourself of the appropriate size.
739 \llap{\ignorespaces #2\hskip\inmarginspacing}%
741 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
746 \def\inleftmargin{\doinmargin l}
747 \def\inrightmargin{\doinmargin r}
749 % @inmargin{TEXT [, RIGHT-TEXT]}
750 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
751 % else use TEXT for both).
753 \def\inmargin#1{\parseinmargin #1,,\finish}
754 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
755 \setbox0 = \hbox{\ignorespaces #2}%
757 \def\lefttext{#1}% have both texts
760 \def\lefttext{#1}% have only one text
765 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
767 \def\temp{\inleftmargin\lefttext}%
772 % @include file insert text of that file as input.
773 % Allow normal characters that we make active in the argument (a file name).
774 \def\include{\begingroup
783 \parsearg\includezzz}
784 % Restore active chars for included file.
785 \def\includezzz#1{\endgroup\begingroup
786 % Read the included file in a group so nested @include's work.
788 \let\value=\expandablevalue
795 % outputs that line, centered.
797 \def\center{\parsearg\docenter}
799 \ifhmode \hfil\break \fi
800 \advance\hsize by -\leftskip
801 \advance\hsize by -\rightskip
802 \line{\hfil \ignorespaces#1\unskip \hfil}%
806 % @sp n outputs n lines of vertical space
808 \def\sp{\parsearg\spxxx}
809 \def\spxxx #1{\vskip #1\baselineskip}
811 % @comment ...line which is ignored...
812 % @c is the same as @comment
813 % @ignore ... @end ignore is another way to write a comment
815 \def\comment{\begingroup \catcode`\^^M=\other%
816 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
818 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
822 % @paragraphindent NCHARS
823 % We'll use ems for NCHARS, close enough.
824 % We cannot implement @paragraphindent asis, though.
826 \def\asisword{asis} % no translation, these are keywords
829 \def\paragraphindent{\parsearg\doparagraphindent}
830 \def\doparagraphindent#1{%
835 \defaultparindent = 0pt
837 \defaultparindent = #1em
840 \parindent = \defaultparindent
843 % @exampleindent NCHARS
844 % We'll use ems for NCHARS like @paragraphindent.
845 % It seems @exampleindent asis isn't necessary, but
846 % I preserve it to make it similar to @paragraphindent.
847 \def\exampleindent{\parsearg\doexampleindent}
848 \def\doexampleindent#1{%
855 \lispnarrowing = #1em
860 % @asis just yields its argument. Used with @table, for example.
864 % @math outputs its argument in math mode.
865 % We don't use $'s directly in the definition of \math because we need
866 % to set catcodes according to plain TeX first, to allow for subscripts,
867 % superscripts, special math chars, etc.
869 \let\implicitmath = $%$ font-lock fix
871 % One complication: _ usually means subscripts, but it could also mean
872 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
873 % _ within @math be active (mathcode "8000), and distinguish by seeing
874 % if the current family is \slfam, which is what @var uses.
876 {\catcode\underChar = \active
877 \gdef\mathunderscore{%
878 \catcode\underChar=\active
879 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
882 % Another complication: we want \\ (and @\) to output a \ character.
883 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
884 % this is not advertised and we don't care. Texinfo does not
885 % otherwise define @\.
887 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
888 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
892 \mathcode`\_="8000 \mathunderscore
893 \let\\ = \mathbackslash
895 \implicitmath\finishmath}
896 \def\finishmath#1{#1\implicitmath\Etex}
898 % Some active characters (such as <) are spaced differently in math.
899 % We have to reset their definitions in case the @math was an
900 % argument to a command which set the catcodes (such as @item or @section).
915 % @bullet and @minus need the same treatment as @math, just above.
916 \def\bullet{\implicitmath\ptexbullet\implicitmath}
917 \def\minus{\implicitmath-\implicitmath}
919 % @refill is a no-op.
922 % If working on a large document in chapters, it is convenient to
923 % be able to disable indexing, cross-referencing, and contents, for test runs.
924 % This is done with @novalidate (before @setfilename).
926 \newif\iflinks \linkstrue % by default we want the aux files.
927 \let\novalidate = \linksfalse
929 % @setfilename is done at the beginning of every texinfo file.
930 % So open here the files we need to have open while reading the input.
931 % This makes it possible to make a .fmt file for texinfo.
935 \fi % \openindices needs to do some work in any case.
937 \fixbackslash % Turn off hack to swallow `\input texinfo'.
938 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
940 % If texinfo.cnf is present on the system, read it.
941 % Useful for site-wide @afourpaper, etc.
942 % Just to be on the safe side, close the input stream before the \input.
943 \openin 1 texinfo.cnf
944 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
948 \comment % Ignore the actual filename.
951 % Called from \setfilename.
963 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
967 % adobe `portable' document format
971 \newcount\filenamelength
980 \newif\ifpdfmakepagedest
982 \ifx\pdfoutput\undefined
984 \let\pdfmkdest = \gobble
985 \let\pdfurl = \gobble
986 \let\endlink = \relax
987 \let\linkcolor = \relax
988 \let\pdfmakeoutlines = \relax
993 \def\dopdfimage#1#2#3{%
995 \def\imageheight{#3}%
996 % without \immediate, pdftex seg faults when the same image is
997 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
998 \ifnum\pdftexversion < 14
1001 \immediate\pdfximage
1003 \ifx\empty\imagewidth\else width \imagewidth \fi
1004 \ifx\empty\imageheight\else height \imageheight \fi
1005 \ifnum\pdftexversion<13
1010 \ifnum\pdftexversion < 14 \else
1011 \pdfrefximage \pdflastximage
1013 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
1015 \let\linkcolor = \Blue % was Cyan, but that seems light?
1016 \def\endlink{\Black\pdfendlink}
1017 % Adding outlines to PDF; macros for calculating structure of outlines
1018 % come from Petr Olsak
1019 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1020 \else \csname#1\endcsname \fi}
1021 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1022 \advance\tempnum by1
1023 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1024 \def\pdfmakeoutlines{{%
1025 \openin 1 \jobname.toc
1026 \ifeof 1\else\begingroup
1028 % Thanh's hack / proper braces in bookmarks
1029 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1030 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1032 \def\chapentry ##1##2##3{}
1033 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1034 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1035 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1036 \let\appendixentry = \chapentry
1037 \let\unnumbchapentry = \chapentry
1038 \let\unnumbsecentry = \secentry
1039 \let\unnumbsubsecentry = \subsecentry
1040 \let\unnumbsubsubsecentry = \subsubsecentry
1042 \def\chapentry ##1##2##3{%
1043 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1044 \def\secentry ##1##2##3##4{%
1045 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1046 \def\subsecentry ##1##2##3##4##5{%
1047 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1048 \def\subsubsecentry ##1##2##3##4##5##6{%
1049 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1050 \let\appendixentry = \chapentry
1051 \let\unnumbchapentry = \chapentry
1052 \let\unnumbsecentry = \secentry
1053 \let\unnumbsubsecentry = \subsecentry
1054 \let\unnumbsubsubsecentry = \subsubsecentry
1056 % Make special characters normal for writing to the pdf file.
1064 \def\makelinks #1,{%
1065 \def\params{#1}\def\E{END}%
1067 \let\nextmakelinks=\relax
1069 \let\nextmakelinks=\makelinks
1070 \ifnum\lnkcount>0,\fi
1072 \startlink attr{/Border [0 0 0]}
1073 goto name{\pdfmkpgn{\the\pgn}}%
1075 \advance\lnkcount by 1%
1080 \def\picknum#1{\expandafter\pn#1}
1091 \def\ppn#1{\pgn=#1\gobble}
1092 \def\ppnn{\pgn=\first}
1093 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1094 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1095 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1096 \ifx\PP\D\let\nextsp\relax
1097 \else\let\nextsp\skipspaces
1098 \ifx\p\space\else\addtokens{\filename}{\PP}%
1099 \advance\filenamelength by 1
1103 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1104 \ifnum\pdftexversion < 14
1105 \let \startlink \pdfannotlink
1107 \let \startlink \pdfstartlink
1111 \normalturnoffactive\def\@{@}%
1112 \let\value=\expandablevalue
1114 \startlink attr{/Border [0 0 0]}%
1115 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1118 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1119 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1120 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1121 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1123 \expandafter\poptoks\the\toksA|ENDTOKS|
1125 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1126 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1127 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1129 \ifnum0=\countA\else\makelink\fi
1130 \ifx\first.\let\next=\done\else
1132 \addtokens{\toksB}{\the\toksD}
1133 \ifx\first,\addtokens{\toksB}{\space}\fi
1135 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1137 \def\makelink{\addtokens{\toksB}%
1138 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1140 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1141 \linkcolor #1\endlink}
1142 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1143 \fi % \ifx\pdfoutput
1147 % Font-change commands.
1149 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1150 % So we set up a \sf analogous to plain's \rm, etc.
1152 \def\sf{\fam=\sffam \tensf}
1153 \let\li = \sf % Sometimes we call it \li, not \sf.
1155 % We don't need math for this one.
1159 \newdimen\textleading \textleading = 13.2pt
1161 % Set the baselineskip to #1, and the lineskip and strut size
1162 % correspondingly. There is no deep meaning behind these magic numbers
1163 % used as factors; they just match (closely enough) what Knuth defined.
1165 \def\lineskipfactor{.08333}
1166 \def\strutheightpercent{.70833}
1167 \def\strutdepthpercent {.29167}
1170 \normalbaselineskip = #1\relax
1171 \normallineskip = \lineskipfactor\normalbaselineskip
1173 \setbox\strutbox =\hbox{%
1174 \vrule width0pt height\strutheightpercent\baselineskip
1175 depth \strutdepthpercent \baselineskip
1179 % Set the font macro #1 to the font named #2, adding on the
1180 % specified font prefix (normally `cm').
1181 % #3 is the font's design size, #4 is a scale factor
1182 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1184 % Use cm as the default font prefix.
1185 % To specify the font prefix, you must define \fontprefix
1186 % before you read in texinfo.tex.
1187 \ifx\fontprefix\undefined
1190 % Support font families that don't use the same naming scheme as CM.
1192 \def\rmbshape{bx} %where the normal face is bold
1197 \def\ttslshape{sltt}
1207 \newcount\mainmagstep
1209 % not really supported.
1210 \mainmagstep=\magstep1
1211 \setfont\textrm\rmshape{12}{1000}
1212 \setfont\texttt\ttshape{12}{1000}
1214 \mainmagstep=\magstephalf
1215 \setfont\textrm\rmshape{10}{\mainmagstep}
1216 \setfont\texttt\ttshape{10}{\mainmagstep}
1218 % Instead of cmb10, you may want to use cmbx10.
1219 % cmbx10 is a prettier font on its own, but cmb10
1220 % looks better when embedded in a line with cmr10
1221 % (in Bob's opinion).
1222 \setfont\textbf\bfshape{10}{\mainmagstep}
1223 \setfont\textit\itshape{10}{\mainmagstep}
1224 \setfont\textsl\slshape{10}{\mainmagstep}
1225 \setfont\textsf\sfshape{10}{\mainmagstep}
1226 \setfont\textsc\scshape{10}{\mainmagstep}
1227 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1228 \font\texti=cmmi10 scaled \mainmagstep
1229 \font\textsy=cmsy10 scaled \mainmagstep
1231 % A few fonts for @defun, etc.
1232 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1233 \setfont\deftt\ttshape{10}{\magstep1}
1234 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1236 % Fonts for indices, footnotes, small examples (9pt).
1237 \setfont\smallrm\rmshape{9}{1000}
1238 \setfont\smalltt\ttshape{9}{1000}
1239 \setfont\smallbf\bfshape{10}{900}
1240 \setfont\smallit\itshape{9}{1000}
1241 \setfont\smallsl\slshape{9}{1000}
1242 \setfont\smallsf\sfshape{9}{1000}
1243 \setfont\smallsc\scshape{10}{900}
1244 \setfont\smallttsl\ttslshape{10}{900}
1248 % Fonts for small examples (8pt).
1249 \setfont\smallerrm\rmshape{8}{1000}
1250 \setfont\smallertt\ttshape{8}{1000}
1251 \setfont\smallerbf\bfshape{10}{800}
1252 \setfont\smallerit\itshape{8}{1000}
1253 \setfont\smallersl\slshape{8}{1000}
1254 \setfont\smallersf\sfshape{8}{1000}
1255 \setfont\smallersc\scshape{10}{800}
1256 \setfont\smallerttsl\ttslshape{10}{800}
1257 \font\smalleri=cmmi8
1258 \font\smallersy=cmsy8
1260 % Fonts for title page:
1261 \setfont\titlerm\rmbshape{12}{\magstep3}
1262 \setfont\titleit\itbshape{10}{\magstep4}
1263 \setfont\titlesl\slbshape{10}{\magstep4}
1264 \setfont\titlett\ttbshape{12}{\magstep3}
1265 \setfont\titlettsl\ttslshape{10}{\magstep4}
1266 \setfont\titlesf\sfbshape{17}{\magstep1}
1267 \let\titlebf=\titlerm
1268 \setfont\titlesc\scbshape{10}{\magstep4}
1269 \font\titlei=cmmi12 scaled \magstep3
1270 \font\titlesy=cmsy10 scaled \magstep4
1271 \def\authorrm{\secrm}
1272 \def\authortt{\sectt}
1274 % Chapter (and unnumbered) fonts (17.28pt).
1275 \setfont\chaprm\rmbshape{12}{\magstep2}
1276 \setfont\chapit\itbshape{10}{\magstep3}
1277 \setfont\chapsl\slbshape{10}{\magstep3}
1278 \setfont\chaptt\ttbshape{12}{\magstep2}
1279 \setfont\chapttsl\ttslshape{10}{\magstep3}
1280 \setfont\chapsf\sfbshape{17}{1000}
1282 \setfont\chapsc\scbshape{10}{\magstep3}
1283 \font\chapi=cmmi12 scaled \magstep2
1284 \font\chapsy=cmsy10 scaled \magstep3
1286 % Section fonts (14.4pt).
1287 \setfont\secrm\rmbshape{12}{\magstep1}
1288 \setfont\secit\itbshape{10}{\magstep2}
1289 \setfont\secsl\slbshape{10}{\magstep2}
1290 \setfont\sectt\ttbshape{12}{\magstep1}
1291 \setfont\secttsl\ttslshape{10}{\magstep2}
1292 \setfont\secsf\sfbshape{12}{\magstep1}
1294 \setfont\secsc\scbshape{10}{\magstep2}
1295 \font\seci=cmmi12 scaled \magstep1
1296 \font\secsy=cmsy10 scaled \magstep2
1298 % Subsection fonts (13.15pt).
1299 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1300 \setfont\ssecit\itbshape{10}{1315}
1301 \setfont\ssecsl\slbshape{10}{1315}
1302 \setfont\ssectt\ttbshape{12}{\magstephalf}
1303 \setfont\ssecttsl\ttslshape{10}{1315}
1304 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1306 \setfont\ssecsc\scbshape{10}{\magstep1}
1307 \font\sseci=cmmi12 scaled \magstephalf
1308 \font\ssecsy=cmsy10 scaled 1315
1309 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1310 % but that is not a standard magnification.
1312 % In order for the font changes to affect most math symbols and letters,
1313 % we have to define the \textfont of the standard families. Since
1314 % texinfo doesn't allow for producing subscripts and superscripts except
1315 % in the main text, we don't bother to reset \scriptfont and
1316 % \scriptscriptfont (which would also require loading a lot more fonts).
1318 \def\resetmathfonts{%
1319 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1320 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1321 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1324 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1325 % of just \STYLE. We do this so that font changes will continue to work
1326 % in math mode, where it is the current \fam that is relevant in most
1327 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1328 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1329 % redefine \bf itself.
1331 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1332 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1333 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1334 \resetmathfonts \setleading{\textleading}}
1336 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1337 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1338 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1339 \let\tenttsl=\titlettsl
1340 \resetmathfonts \setleading{25pt}}
1341 \def\titlefont#1{{\titlefonts\rm #1}}
1343 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1344 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1345 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1346 \resetmathfonts \setleading{19pt}}
1348 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1349 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1350 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1351 \resetmathfonts \setleading{16pt}}
1353 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1354 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1355 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1356 \resetmathfonts \setleading{15pt}}
1357 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1359 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1360 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1361 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1362 \let\tenttsl=\smallttsl
1363 \resetmathfonts \setleading{10.5pt}}
1365 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1366 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1367 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1368 \let\tenttsl=\smallerttsl
1369 \resetmathfonts \setleading{9.5pt}}
1371 % Set the fonts to use with the @small... environments.
1372 \let\smallexamplefonts = \smallfonts
1374 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1375 % can fit this many characters:
1376 % 8.5x11=86 smallbook=72 a4=90 a5=69
1377 % If we use \smallerfonts (8pt), then we can fit this many characters:
1378 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1379 % For me, subjectively, the few extra characters that fit aren't worth
1380 % the additional smallness of 8pt. So I'm making the default 9pt.
1382 % By the way, for comparison, here's what fits with @example (10pt):
1383 % 8.5x11=71 smallbook=60 a4=75 a5=58
1385 % I wish we used A4 paper on this side of the Atlantic.
1390 % Set up the default fonts, so we can use them for creating boxes.
1394 % Define these so they can be easily changed for other fonts.
1395 \def\angleleft{$\langle$}
1396 \def\angleright{$\rangle$}
1398 % Count depth in font-changes, for error checks
1399 \newcount\fontdepth \fontdepth=0
1401 % Fonts for short table of contents.
1402 \setfont\shortcontrm\rmshape{12}{1000}
1403 \setfont\shortcontbf\bxshape{12}{1000}
1404 \setfont\shortcontsl\slshape{12}{1000}
1405 \setfont\shortconttt\ttshape{12}{1000}
1407 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1408 %% serif) and @ii for TeX italic
1410 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1411 % unless the following character is such as not to need one.
1412 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1413 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1414 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1417 \let\var=\smartslanted
1418 \let\dfn=\smartslanted
1419 \let\emph=\smartitalic
1420 \let\cite=\smartslanted
1425 % We can't just use \exhyphenpenalty, because that only has effect at
1426 % the end of a paragraph. Restore normal hyphenation at the end of the
1427 % group within which \nohyphenation is presumably called.
1429 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1430 \def\restorehyphenation{\hyphenchar\font = `- }
1432 % Set sfcode to normal for the chars that usually have another value.
1433 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1434 % sometimes \x has an active definition that messes things up.
1437 \def\frenchspacing{%
1438 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1439 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1444 {\tt \rawbackslash \frenchspacing #1}%
1448 \def\samp#1{`\tclose{#1}'\null}
1449 \setfont\keyrm\rmshape{8}{1000}
1451 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1452 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1453 \vbox{\hrule\kern-0.4pt
1454 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1456 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1457 % The old definition, with no lozenge:
1458 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1459 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1461 % @file, @option are the same as @samp.
1465 % @code is a modification of @t,
1466 % which makes spaces the same size as normal in the surrounding text.
1469 % Change normal interword space to be same as for the current font.
1470 \spaceskip = \fontdimen2\font
1472 % Switch to typewriter.
1475 % But `\ ' produces the large typewriter interword space.
1476 \def\ {{\spaceskip = 0pt{} }}%
1478 % Turn off hyphenation.
1488 % We *must* turn on hyphenation at `-' and `_' in \code.
1489 % Otherwise, it is too hard to avoid overfull hboxes
1490 % in the Emacs manual, the Library manual, etc.
1492 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1493 % both hyphenation at - and hyphenation within words.
1494 % We must therefore turn them both off (\tclose does that)
1495 % and arrange explicitly to hyphenate at a dash.
1501 \global\def\code{\begingroup
1502 \catcode`\-=\active \let-\codedash
1503 \catcode`\_=\active \let_\codeunder
1507 % If we end up with any active - characters when handling the index,
1508 % just treat them as a normal -.
1509 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1513 \def\codedash{-\discretionary{}{}{}}
1515 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1516 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1517 % will therefore expand the active definition of _, which is us
1518 % (inside @code that is), therefore an endless loop.
1520 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1521 \else\normalunderscore \fi
1522 \discretionary{}{}{}}%
1525 \def\codex #1{\tclose{#1}\endgroup}
1527 % @kbd is like @code, except that if the argument is just one @key command,
1528 % then @kbd has no effect.
1530 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1531 % `example' (@kbd uses ttsl only inside of @example and friends),
1532 % or `code' (@kbd uses normal tty font always).
1533 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1534 \def\kbdinputstylexxx#1{%
1536 \ifx\arg\worddistinct
1537 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1538 \else\ifx\arg\wordexample
1539 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1540 \else\ifx\arg\wordcode
1541 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1543 \errhelp = \EMsimple
1544 \errmessage{Unknown @kbdinputstyle `\arg'}%
1547 \def\worddistinct{distinct}
1548 \def\wordexample{example}
1551 % Default is `distinct.'
1552 \kbdinputstyle distinct
1555 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1556 \ifx\one\xkey\ifx\threex\three \key{#2}%
1557 \else{\tclose{\kbdfont\look}}\fi
1558 \else{\tclose{\kbdfont\look}}\fi}
1560 % For @url, @env, @command quotes seem unnecessary, so use \code.
1565 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1566 % second argument specifying the text to display and an optional third
1567 % arg as text to display instead of (rather than in addition to) the url
1568 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1569 % a hypertex \special here.
1571 \def\uref#1{\douref #1,,,\finish}
1572 \def\douref#1,#2,#3,#4\finish{\begingroup
1575 \setbox0 = \hbox{\ignorespaces #3}%
1577 \unhbox0 % third arg given, show only that
1579 \setbox0 = \hbox{\ignorespaces #2}%
1582 \unhbox0 % PDF: 2nd arg given, show only it
1584 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1587 \code{#1}% only url given, so show it
1593 % rms does not like angle brackets --karl, 17may97.
1594 % So now @email is just like @uref, unless we are pdf.
1596 %\def\email#1{\angleleft{\tt #1}\angleright}
1598 \def\email#1{\doemail#1,,\finish}
1599 \def\doemail#1,#2,#3\finish{\begingroup
1602 \setbox0 = \hbox{\ignorespaces #2}%
1603 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1610 % Check if we are currently using a typewriter font. Since all the
1611 % Computer Modern typewriter fonts have zero interword stretch (and
1612 % shrink), and it is reasonable to expect all typewriter fonts to have
1613 % this property, we can check that font parameter.
1615 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1617 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1618 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1620 \def\dmn#1{\thinspace #1}
1622 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1624 % @l was never documented to mean ``switch to the Lisp font'',
1625 % and it is not used as such in any manual I can find. We need it for
1626 % Polish suppressed-l. --karl, 22sep96.
1627 %\def\l#1{{\li #1}\null}
1629 % Explicit font changes: @r, @sc, undocumented @ii.
1630 \def\r#1{{\rm #1}} % roman font
1631 \def\sc#1{{\smallcaps#1}} % smallcaps font
1632 \def\ii#1{{\it #1}} % italic font
1634 % @acronym downcases the argument and prints in smallcaps.
1635 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1637 % @pounds{} is a sterling sign.
1638 \def\pounds{{\it\$}}
1641 \message{page headings,}
1643 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1644 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1646 % First the title page. Must do @settitle before @titlepage.
1648 \newif\iffinishedtitlepage
1650 % Do an implicit @contents or @shortcontents after @end titlepage if the
1651 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1653 \newif\ifsetcontentsaftertitlepage
1654 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1655 \newif\ifsetshortcontentsaftertitlepage
1656 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1658 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1659 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1660 \endgroup\page\hbox{}\page}
1662 \def\titlepage{\begingroup \parindent=0pt \textfonts
1663 \let\subtitlerm=\tenrm
1664 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1666 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1669 % Leave some space at the very top of the page.
1670 \vglue\titlepagetopglue
1672 % Now you can print the title using @title.
1673 \def\title{\parsearg\titlezzz}%
1674 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1675 % print a rule at the page bottom also.
1676 \finishedtitlepagefalse
1677 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1678 % No rule at page bottom unless we print one at the top with @title.
1679 \finishedtitlepagetrue
1681 % Now you can put text using @subtitle.
1682 \def\subtitle{\parsearg\subtitlezzz}%
1683 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1685 % @author should come last, but may come many times.
1686 \def\author{\parsearg\authorzzz}%
1687 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1688 {\authorfont \leftline{##1}}}%
1690 % Most title ``pages'' are actually two pages long, with space
1691 % at the top of the second. We don't want the ragged left on the second.
1692 \let\oldpage = \page
1694 \iffinishedtitlepage\else
1698 \let\page = \oldpage
1700 % \def\page{\oldpage \hbox{}}
1704 \iffinishedtitlepage\else
1707 % It is important to do the page break before ending the group,
1708 % because the headline and footline are only empty inside the group.
1709 % If we use the new definition of \page, we always get a blank page
1710 % after the title page, which we certainly don't want.
1714 % Need this before the \...aftertitlepage checks so that if they are
1715 % in effect the toc pages will come out with page numbers.
1718 % If they want short, they certainly want long too.
1719 \ifsetshortcontentsaftertitlepage
1722 \global\let\shortcontents = \relax
1723 \global\let\contents = \relax
1726 \ifsetcontentsaftertitlepage
1728 \global\let\contents = \relax
1729 \global\let\shortcontents = \relax
1733 \def\finishtitlepage{%
1734 \vskip4pt \hrule height 2pt width \hsize
1735 \vskip\titlepagebottomglue
1736 \finishedtitlepagetrue
1739 %%% Set up page headings and footings.
1741 \let\thispage=\folio
1743 \newtoks\evenheadline % headline on even pages
1744 \newtoks\oddheadline % headline on odd pages
1745 \newtoks\evenfootline % footline on even pages
1746 \newtoks\oddfootline % footline on odd pages
1748 % Now make Tex use those variables
1749 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1750 \else \the\evenheadline \fi}}
1751 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1752 \else \the\evenfootline \fi}\HEADINGShook}
1753 \let\HEADINGShook=\relax
1755 % Commands to set those variables.
1756 % For example, this is what @headings on does
1757 % @evenheading @thistitle|@thispage|@thischapter
1758 % @oddheading @thischapter|@thispage|@thistitle
1759 % @evenfooting @thisfile||
1760 % @oddfooting ||@thisfile
1762 \def\evenheading{\parsearg\evenheadingxxx}
1763 \def\oddheading{\parsearg\oddheadingxxx}
1764 \def\everyheading{\parsearg\everyheadingxxx}
1766 \def\evenfooting{\parsearg\evenfootingxxx}
1767 \def\oddfooting{\parsearg\oddfootingxxx}
1768 \def\everyfooting{\parsearg\everyfootingxxx}
1772 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1773 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1774 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1776 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1777 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1778 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1780 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1782 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1783 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1784 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1786 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1787 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1788 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1790 % Leave some space for the footline. Hopefully ok to assume
1791 % @evenfooting will not be used by itself.
1792 \global\advance\pageheight by -\baselineskip
1793 \global\advance\vsize by -\baselineskip
1796 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1798 }% unbind the catcode of @.
1800 % @headings double turns headings on for double-sided printing.
1801 % @headings single turns headings on for single-sided printing.
1802 % @headings off turns them off.
1803 % @headings on same as @headings double, retained for compatibility.
1804 % @headings after turns on double-sided headings after this page.
1805 % @headings doubleafter turns on double-sided headings after this page.
1806 % @headings singleafter turns on single-sided headings after this page.
1807 % By default, they are off at the start of a document,
1808 % and turned `on' after @end titlepage.
1810 \def\headings #1 {\csname HEADINGS#1\endcsname}
1813 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1814 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1816 % When we turn headings on, set the page number to 1.
1817 % For double-sided printing, put current file name in lower left corner,
1818 % chapter name on inside top of right hand pages, document
1819 % title on inside top of left hand pages, and page numbers on outside top
1820 % edge of all pages.
1821 \def\HEADINGSdouble{
1823 \global\evenfootline={\hfil}
1824 \global\oddfootline={\hfil}
1825 \global\evenheadline={\line{\folio\hfil\thistitle}}
1826 \global\oddheadline={\line{\thischapter\hfil\folio}}
1827 \global\let\contentsalignmacro = \chapoddpage
1829 \let\contentsalignmacro = \chappager
1831 % For single-sided printing, chapter title goes across top left of page,
1832 % page number on top right.
1833 \def\HEADINGSsingle{
1835 \global\evenfootline={\hfil}
1836 \global\oddfootline={\hfil}
1837 \global\evenheadline={\line{\thischapter\hfil\folio}}
1838 \global\oddheadline={\line{\thischapter\hfil\folio}}
1839 \global\let\contentsalignmacro = \chappager
1841 \def\HEADINGSon{\HEADINGSdouble}
1843 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1844 \let\HEADINGSdoubleafter=\HEADINGSafter
1845 \def\HEADINGSdoublex{%
1846 \global\evenfootline={\hfil}
1847 \global\oddfootline={\hfil}
1848 \global\evenheadline={\line{\folio\hfil\thistitle}}
1849 \global\oddheadline={\line{\thischapter\hfil\folio}}
1850 \global\let\contentsalignmacro = \chapoddpage
1853 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1854 \def\HEADINGSsinglex{%
1855 \global\evenfootline={\hfil}
1856 \global\oddfootline={\hfil}
1857 \global\evenheadline={\line{\thischapter\hfil\folio}}
1858 \global\oddheadline={\line{\thischapter\hfil\folio}}
1859 \global\let\contentsalignmacro = \chappager
1862 % Subroutines used in generating headings
1863 % This produces Day Month Year style of output.
1864 % Only define if not already defined, in case a txi-??.tex file has set
1865 % up a different format (e.g., txi-cs.tex does this).
1866 \ifx\today\undefined
1870 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1871 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1872 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1877 % @settitle line... specifies the title of the document, for headings.
1878 % It generates no output of its own.
1879 \def\thistitle{\putwordNoTitle}
1880 \def\settitle{\parsearg\settitlezzz}
1881 \def\settitlezzz #1{\gdef\thistitle{#1}}
1885 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1887 % default indentation of table text
1888 \newdimen\tableindent \tableindent=.8in
1889 % default indentation of @itemize and @enumerate text
1890 \newdimen\itemindent \itemindent=.3in
1891 % margin between end of table item and start of table text.
1892 \newdimen\itemmargin \itemmargin=.1in
1894 % used internally for \itemindent minus \itemmargin
1897 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1899 % They also define \itemindex
1900 % to index the item name in whatever manner is desired (perhaps none).
1902 \newif\ifitemxneedsnegativevskip
1904 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1906 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1907 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1909 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1910 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1912 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1913 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1915 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1918 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1921 \def\itemzzz #1{\begingroup %
1922 \advance\hsize by -\rightskip
1923 \advance\hsize by -\tableindent
1924 \setbox0=\hbox{\itemfont{#1}}%
1926 \nobreak % This prevents a break before @itemx.
1928 % If the item text does not fit in the space we have, put it on a line
1929 % by itself, and do not allow a page break either before or after that
1930 % line. We do not start a paragraph here because then if the next
1931 % command is, e.g., @kindex, the whatsit would get put into the
1932 % horizontal list on a line by itself, resulting in extra blank space.
1933 \ifdim \wd0>\itemmax
1935 % Make this a paragraph so we get the \parskip glue and wrapping,
1936 % but leave it ragged-right.
1938 \advance\leftskip by-\tableindent
1939 \advance\hsize by\tableindent
1940 \advance\rightskip by0pt plus1fil
1941 \leavevmode\unhbox0\par
1944 % We're going to be starting a paragraph, but we don't want the
1945 % \parskip glue -- logically it's part of the @item we just started.
1946 \nobreak \vskip-\parskip
1948 % Stop a page break at the \parskip glue coming up. (Unfortunately
1949 % we can't prevent a possible page break at the following
1950 % \baselineskip glue.) However, if what follows is an environment
1951 % such as @example, there will be no \parskip glue; then
1952 % the negative vskip we just would cause the example and the item to
1953 % crash together. So we use this bizarre value of 10001 as a signal
1954 % to \aboveenvbreak to insert \parskip glue after all.
1955 % (Possibly there are other commands that could be followed by
1956 % @example which need the same treatment, but not section titles; or
1957 % maybe section titles are the only special case and they should be
1961 \itemxneedsnegativevskipfalse
1963 % The item text fits into the space. Start a paragraph, so that the
1964 % following text (if any) will end up on the same line.
1966 % Do this with kerns and \unhbox so that if there is a footnote in
1967 % the item text, it can migrate to the main vertical list and
1968 % eventually be printed.
1969 \nobreak\kern-\tableindent
1970 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
1972 \nobreak\kern\dimen0
1974 \itemxneedsnegativevskiptrue
1978 \def\item{\errmessage{@item while not in a table}}
1979 \def\itemx{\errmessage{@itemx while not in a table}}
1980 \def\kitem{\errmessage{@kitem while not in a table}}
1981 \def\kitemx{\errmessage{@kitemx while not in a table}}
1982 \def\xitem{\errmessage{@xitem while not in a table}}
1983 \def\xitemx{\errmessage{@xitemx while not in a table}}
1985 % Contains a kludge to get @end[description] to work.
1986 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1988 % @table, @ftable, @vtable.
1989 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1990 {\obeylines\obeyspaces%
1991 \gdef\tablex #1^^M{%
1992 \tabley\dontindex#1 \endtabley}}
1994 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1995 {\obeylines\obeyspaces%
1996 \gdef\ftablex #1^^M{%
1997 \tabley\fnitemindex#1 \endtabley
1998 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1999 \let\Etable=\relax}}
2001 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
2002 {\obeylines\obeyspaces%
2003 \gdef\vtablex #1^^M{%
2004 \tabley\vritemindex#1 \endtabley
2005 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
2006 \let\Etable=\relax}}
2009 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
2010 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
2013 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
2014 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
2016 \def\tablez #1#2#3#4#5#6{%
2019 \def\Edescription{\Etable}% Necessary kludge.
2021 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
2022 \ifnum 0#4>0 \tableindent=#4\mil \fi %
2023 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
2025 \itemmax=\tableindent %
2026 \advance \itemmax by -\itemmargin %
2027 \advance \leftskip by \tableindent %
2028 \exdentamount=\tableindent
2030 \parskip = \smallskipamount
2031 \ifdim \parskip=0pt \parskip=2pt \fi%
2032 \def\Etable{\endgraf\afterenvbreak\endgroup}%
2033 \let\item = \internalBitem %
2034 \let\itemx = \internalBitemx %
2035 \let\kitem = \internalBkitem %
2036 \let\kitemx = \internalBkitemx %
2037 \let\xitem = \internalBxitem %
2038 \let\xitemx = \internalBxitemx %
2041 % This is the counter used by @enumerate, which is really @itemize
2045 \def\itemize{\parsearg\itemizezzz}
2047 \def\itemizezzz #1{%
2048 \begingroup % ended by the @end itemize
2049 \itemizey {#1}{\Eitemize}
2052 \def\itemizey #1#2{%
2054 \itemmax=\itemindent %
2055 \advance \itemmax by -\itemmargin %
2056 \advance \leftskip by \itemindent %
2057 \exdentamount=\itemindent
2059 \parskip = \smallskipamount %
2060 \ifdim \parskip=0pt \parskip=2pt \fi%
2061 \def#2{\endgraf\afterenvbreak\endgroup}%
2062 \def\itemcontents{#1}%
2063 \let\item=\itemizeitem}
2065 % \splitoff TOKENS\endmark defines \first to be the first token in
2066 % TOKENS, and \rest to be the remainder.
2068 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2070 % Allow an optional argument of an uppercase letter, lowercase letter,
2071 % or number, to specify the first label in the enumerated list. No
2072 % argument is the same as `1'.
2074 \def\enumerate{\parsearg\enumeratezzz}
2075 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2076 \def\enumeratey #1 #2\endenumeratey{%
2077 \begingroup % ended by the @end enumerate
2079 % If we were given no argument, pretend we were given `1'.
2081 \ifx\thearg\empty \def\thearg{1}\fi
2083 % Detect if the argument is a single token. If so, it might be a
2084 % letter. Otherwise, the only valid thing it can be is a number.
2085 % (We will always have one token, because of the test we just made.
2086 % This is a good thing, since \splitoff doesn't work given nothing at
2087 % all -- the first parameter is undelimited.)
2088 \expandafter\splitoff\thearg\endmark
2090 % Only one token in the argument. It could still be anything.
2091 % A ``lowercase letter'' is one whose \lccode is nonzero.
2092 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2093 % not equal to itself.
2094 % Otherwise, we assume it's a number.
2096 % We need the \relax at the end of the \ifnum lines to stop TeX from
2097 % continuing to look for a <number>.
2099 \ifnum\lccode\expandafter`\thearg=0\relax
2100 \numericenumerate % a number (we hope)
2103 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2104 \lowercaseenumerate % lowercase letter
2106 \uppercaseenumerate % uppercase letter
2110 % Multiple tokens in the argument. We hope it's a number.
2115 % An @enumerate whose labels are integers. The starting integer is
2118 \def\numericenumerate{%
2120 \startenumeration{\the\itemno}%
2123 % The starting (lowercase) letter is in \thearg.
2124 \def\lowercaseenumerate{%
2125 \itemno = \expandafter`\thearg
2127 % Be sure we're not beyond the end of the alphabet.
2129 \errmessage{No more lowercase letters in @enumerate; get a bigger
2136 % The starting (uppercase) letter is in \thearg.
2137 \def\uppercaseenumerate{%
2138 \itemno = \expandafter`\thearg
2140 % Be sure we're not beyond the end of the alphabet.
2142 \errmessage{No more uppercase letters in @enumerate; get a bigger
2149 % Call itemizey, adding a period to the first argument and supplying the
2150 % common last two arguments. Also subtract one from the initial value in
2151 % \itemno, since @item increments \itemno.
2153 \def\startenumeration#1{%
2154 \advance\itemno by -1
2155 \itemizey{#1.}\Eenumerate\flushcr
2158 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2161 \def\alphaenumerate{\enumerate{a}}
2162 \def\capsenumerate{\enumerate{A}}
2163 \def\Ealphaenumerate{\Eenumerate}
2164 \def\Ecapsenumerate{\Eenumerate}
2166 % Definition of @item while inside @itemize.
2169 \advance\itemno by 1
2170 {\let\par=\endgraf \smallbreak}%
2171 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2172 {\parskip=0in \hskip 0pt
2173 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2174 \vadjust{\penalty 1200}}%
2177 % @multitable macros
2178 % Amy Hendrickson, 8/18/94, 3/6/96
2180 % @multitable ... @end multitable will make as many columns as desired.
2181 % Contents of each column will wrap at width given in preamble. Width
2182 % can be specified either with sample text given in a template line,
2183 % or in percent of \hsize, the current width of text on page.
2185 % Table can continue over pages but will only break between lines.
2189 % Either define widths of columns in terms of percent of \hsize:
2190 % @multitable @columnfractions .25 .3 .45
2193 % Numbers following @columnfractions are the percent of the total
2194 % current hsize to be used for each column. You may use as many
2195 % columns as desired.
2198 % Or use a template:
2199 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2201 % using the widest term desired in each column.
2203 % For those who want to use more than one line's worth of words in
2204 % the preamble, break the line within one argument and it
2205 % will parse correctly, i.e.,
2207 % @multitable {Column 1 template} {Column 2 template} {Column 3
2210 % @multitable {Column 1 template} {Column 2 template}
2211 % {Column 3 template}
2213 % Each new table line starts with @item, each subsequent new column
2214 % starts with @tab. Empty columns may be produced by supplying @tab's
2215 % with nothing between them for as many times as empty columns are needed,
2216 % ie, @tab@tab@tab will produce two empty columns.
2218 % @item, @tab, @multitable or @end multitable do not need to be on their
2219 % own lines, but it will not hurt if they are.
2221 % Sample multitable:
2223 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2224 % @item first col stuff @tab second col stuff @tab third col
2231 % @item first col stuff @tab second col stuff
2232 % @tab Many paragraphs of text may be used in any column.
2234 % They will wrap at the width determined by the template.
2235 % @item@tab@tab This will be in third column.
2238 % Default dimensions may be reset by user.
2239 % @multitableparskip is vertical space between paragraphs in table.
2240 % @multitableparindent is paragraph indent in table.
2241 % @multitablecolmargin is horizontal space to be left between columns.
2242 % @multitablelinespace is space to leave between table items, baseline
2244 % 0pt means it depends on current normal line spacing.
2246 \newskip\multitableparskip
2247 \newskip\multitableparindent
2248 \newdimen\multitablecolspace
2249 \newskip\multitablelinespace
2250 \multitableparskip=0pt
2251 \multitableparindent=6pt
2252 \multitablecolspace=12pt
2253 \multitablelinespace=0pt
2255 % Macros used to set up halign preamble:
2257 \let\endsetuptable\relax
2258 \def\xendsetuptable{\endsetuptable}
2259 \let\columnfractions\relax
2260 \def\xcolumnfractions{\columnfractions}
2263 % #1 is the part of the @columnfraction before the decimal point, which
2264 % is presumably either 0 or the empty string (but we don't check, we
2265 % just throw it away). #2 is the decimal part, which we use as the
2266 % percent of \hsize for this column.
2267 \def\pickupwholefraction#1.#2 {%
2268 \global\advance\colcount by 1
2269 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2276 \ifx\firstarg\xendsetuptable
2279 \ifx\firstarg\xcolumnfractions
2280 \global\setpercenttrue
2283 \let\go\pickupwholefraction
2285 \global\advance\colcount by 1
2286 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2287 % separator; typically that is always in the input, anyway.
2288 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2291 \ifx\go\pickupwholefraction
2292 % Put the argument back for the \pickupwholefraction call, so
2293 % we'll always have a period there to be parsed.
2294 \def\go{\pickupwholefraction#1}%
2296 \let\go = \setuptable
2302 % @multitable ... @end multitable definitions:
2304 \def\multitable{\parsearg\dotable}
2305 \def\dotable#1{\bgroup
2307 \let\item=\crcrwithfootnotes
2308 % A \tab used to include \hskip1sp. But then the space in a template
2309 % line is not enough. That is bad. So let's go back to just & until
2310 % we encounter the problem it was intended to solve again. --karl,
2311 % nathan@acm.org, 20apr99.
2313 \let\startfootins=\startsavedfootnote
2316 \setmultitablespacing
2317 \parskip=\multitableparskip
2318 \parindent=\multitableparindent
2322 \global\setpercentfalse
2323 \crcrwithfootnotes\crcr
2327 % To parse everything between @multitable and @item:
2328 \setuptable#1 \endsetuptable
2330 % \everycr will reset column counter, \colcount, at the end of
2331 % each line. Every column entry will cause \colcount to advance by one.
2332 % The table preamble
2333 % looks at the current \colcount to find the correct column width.
2336 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2337 % Maybe so, but it also creates really weird page breaks when the table
2338 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2339 % manifests itself, so it can be fixed for real --karl.
2340 \global\colcount=0\relax}}%
2342 % This preamble sets up a generic column definition, which will
2343 % be used as many times as user calls for columns.
2344 % \vtop will set a single line and will also let text wrap and
2345 % continue for many paragraphs if desired.
2346 \halign\bgroup&\global\advance\colcount by 1\relax
2347 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2349 % In order to keep entries from bumping into each other
2350 % we will add a \leftskip of \multitablecolspace to all columns after
2353 % If a template has been used, we will add \multitablecolspace
2354 % to the width of each template entry.
2356 % If the user has set preamble in terms of percent of \hsize we will
2357 % use that dimension as the width of the column, and the \leftskip
2358 % will keep entries from bumping into each other. Table will start at
2359 % left margin and final column will justify at right margin.
2361 % Make sure we don't inherit \rightskip from the outer environment.
2364 % The first column will be indented with the surrounding text.
2365 \advance\hsize by\leftskip
2368 % If user has not set preamble in terms of percent of \hsize
2369 % we will advance \hsize by \multitablecolspace.
2370 \advance\hsize by \multitablecolspace
2372 % In either case we will make \leftskip=\multitablecolspace:
2373 \leftskip=\multitablecolspace
2375 % Ignoring space at the beginning and end avoids an occasional spurious
2376 % blank line, when TeX decides to break the line at the space before the
2377 % box from the multistrut, so the strut ends up on a line by itself.
2379 % @multitable @columnfractions .11 .89
2381 % @tab Legal holiday which is valid in major parts of the whole country.
2382 % Is automatically provided with highlighting sequences respectively marking
2384 \noindent\ignorespaces##\unskip\multistrut}\cr
2387 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2388 % If so, do nothing. If not, give it an appropriate dimension based on
2389 % current baselineskip.
2390 \ifdim\multitablelinespace=0pt
2391 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2392 \global\advance\multitablelinespace by-\ht0
2393 %% strut to put in table in case some entry doesn't have descenders,
2394 %% to keep lines equally spaced
2395 \let\multistrut = \strut
2397 %% FIXME: what is \box0 supposed to be?
2398 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2400 %% Test to see if parskip is larger than space between lines of
2401 %% table. If not, do nothing.
2402 %% If so, set to same dimension as multitablelinespace.
2403 \ifdim\multitableparskip>\multitablelinespace
2404 \global\multitableparskip=\multitablelinespace
2405 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2406 %% than skip between lines in the table.
2408 \ifdim\multitableparskip=0pt
2409 \global\multitableparskip=\multitablelinespace
2410 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2411 %% than skip between lines in the table.
2414 % In case a @footnote appears inside an alignment, save the footnote
2415 % text to a box and make the \insert when a row of the table is
2416 % finished. Otherwise, the insertion is lost, it never migrates to the
2417 % main vertical list. --kasal, 22jan03.
2419 \newbox\savedfootnotes
2421 % \dotable \let's \startfootins to this, so that \dofootnote will call
2422 % it instead of starting the insertion right away.
2423 \def\startsavedfootnote{%
2424 \global\setbox\savedfootnotes = \vbox\bgroup
2425 \unvbox\savedfootnotes
2427 \def\crcrwithfootnotes{%
2429 \ifvoid\savedfootnotes \else
2430 \noalign{\insert\footins{\box\savedfootnotes}}%
2434 \message{conditionals,}
2435 % Prevent errors for section commands.
2436 % Used in @ignore and in failing conditionals.
2437 \def\ignoresections{%
2439 \let\unnumbered=\relax
2441 \let\unnumberedsec=\relax
2442 \let\unnumberedsection=\relax
2443 \let\unnumberedsubsec=\relax
2444 \let\unnumberedsubsection=\relax
2445 \let\unnumberedsubsubsec=\relax
2446 \let\unnumberedsubsubsection=\relax
2449 \let\subsubsec=\relax
2450 \let\subsection=\relax
2451 \let\subsubsection=\relax
2452 \let\appendix=\relax
2453 \let\appendixsec=\relax
2454 \let\appendixsection=\relax
2455 \let\appendixsubsec=\relax
2456 \let\appendixsubsection=\relax
2457 \let\appendixsubsubsec=\relax
2458 \let\appendixsubsubsection=\relax
2459 \let\contents=\relax
2460 \let\smallbook=\relax
2461 \let\titlepage=\relax
2464 % Used in nested conditionals, where we have to parse the Texinfo source
2465 % and so want to turn off most commands, in case they are used
2468 % We use \empty instead of \relax for the @def... commands, so that \end
2469 % doesn't throw an error. For instance:
2475 % The @end deffn is going to get expanded, because we're trying to allow
2476 % nested conditionals. But we don't want to expand the actual @deffn,
2477 % since it might be syntactically correct and intended to be ignored.
2478 % Since \end checks for \relax, using \empty does not cause an error.
2480 \def\ignoremorecommands{%
2481 \let\defcodeindex = \relax
2483 \let\defcvx = \empty
2484 \let\Edefcv = \empty
2486 \let\deffnx = \empty
2487 \let\Edeffn = \empty
2488 \let\defindex = \relax
2489 \let\defivar = \empty
2490 \let\defivarx = \empty
2491 \let\Edefivar = \empty
2492 \let\defmac = \empty
2493 \let\defmacx = \empty
2494 \let\Edefmac = \empty
2495 \let\defmethod = \empty
2496 \let\defmethodx = \empty
2497 \let\Edefmethod = \empty
2499 \let\defopx = \empty
2500 \let\Edefop = \empty
2501 \let\defopt = \empty
2502 \let\defoptx = \empty
2503 \let\Edefopt = \empty
2504 \let\defspec = \empty
2505 \let\defspecx = \empty
2506 \let\Edefspec = \empty
2508 \let\deftpx = \empty
2509 \let\Edeftp = \empty
2510 \let\deftypefn = \empty
2511 \let\deftypefnx = \empty
2512 \let\Edeftypefn = \empty
2513 \let\deftypefun = \empty
2514 \let\deftypefunx = \empty
2515 \let\Edeftypefun = \empty
2516 \let\deftypeivar = \empty
2517 \let\deftypeivarx = \empty
2518 \let\Edeftypeivar = \empty
2519 \let\deftypemethod = \empty
2520 \let\deftypemethodx = \empty
2521 \let\Edeftypemethod = \empty
2522 \let\deftypeop = \empty
2523 \let\deftypeopx = \empty
2524 \let\Edeftypeop = \empty
2525 \let\deftypevar = \empty
2526 \let\deftypevarx = \empty
2527 \let\Edeftypevar = \empty
2528 \let\deftypevr = \empty
2529 \let\deftypevrx = \empty
2530 \let\Edeftypevr = \empty
2532 \let\defunx = \empty
2533 \let\Edefun = \empty
2534 \let\defvar = \empty
2535 \let\defvarx = \empty
2536 \let\Edefvar = \empty
2538 \let\defvrx = \empty
2539 \let\Edefvr = \empty
2542 \let\evenfooting = \relax
2543 \let\evenheading = \relax
2544 \let\everyfooting = \relax
2545 \let\everyheading = \relax
2546 \let\headings = \relax
2547 \let\include = \relax
2549 \let\lowersections = \relax
2550 \let\oddfooting = \relax
2551 \let\oddheading = \relax
2552 \let\printindex = \relax
2554 \let\raisesections = \relax
2557 \let\setchapternewpage = \relax
2558 \let\setchapterstyle = \relax
2559 \let\settitle = \relax
2561 \let\verbatiminclude = \relax
2565 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2567 \def\direntry{\doignore{direntry}}
2568 \def\documentdescriptionword{documentdescription}
2569 \def\documentdescription{\doignore{documentdescription}}
2570 \def\html{\doignore{html}}
2571 \def\ifhtml{\doignore{ifhtml}}
2572 \def\ifinfo{\doignore{ifinfo}}
2573 \def\ifnottex{\doignore{ifnottex}}
2574 \def\ifplaintext{\doignore{ifplaintext}}
2575 \def\ifxml{\doignore{ifxml}}
2576 \def\ignore{\doignore{ignore}}
2577 \def\menu{\doignore{menu}}
2578 \def\xml{\doignore{xml}}
2580 % @dircategory CATEGORY -- specify a category of the dir file
2581 % which this file should belong to. Ignore this in TeX.
2582 \let\dircategory = \comment
2584 % Ignore text until a line `@end #1'.
2586 \def\doignore#1{\begingroup
2587 % Don't complain about control sequences we have declared \outer.
2590 % Define a command to swallow text until we reach `@end #1'.
2591 % This @ is a catcode 12 token (that is the normal catcode of @ in
2592 % this texinfo.tex file). We change the catcode of @ below to match.
2593 \long\def\doignoretext##1@end #1{\enddoignore}%
2595 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2596 \catcode\spaceChar = 10
2598 % Ignore braces, too, so mismatched braces don't cause trouble.
2602 % We must not have @c interpreted as a control sequence.
2605 \def\ignoreword{#1}%
2606 \ifx\ignoreword\documentdescriptionword
2607 % The c kludge breaks documentdescription, since
2608 % `documentdescription' contains a `c'. Means not everything will
2609 % be ignored inside @documentdescription, but oh well...
2611 % Make the letter c a comment character so that the rest of the line
2612 % will be ignored. This way, the document can have (for example)
2614 % and the @end ifinfo will be properly ignored.
2615 % (We've just changed @ to catcode 12.)
2619 % And now expand the command defined above.
2623 % What we do to finish off ignored text.
2625 \def\enddoignore{\endgroup\ignorespaces}%
2627 \newif\ifwarnedobs\warnedobsfalse
2629 \ifwarnedobs\relax\else
2630 % We need to warn folks that they may have trouble with TeX 3.0.
2631 % This uses \immediate\write16 rather than \message to get newlines.
2632 \immediate\write16{}
2633 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2634 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2635 \immediate\write16{If you are running another version of TeX, relax.}
2636 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2637 \immediate\write16{ Then upgrade your TeX installation if you can.}
2638 \immediate\write16{ (See ftp://ftp.gnu.org/non-gnu/TeX.README.)}
2639 \immediate\write16{If you are stuck with version 3.0, run the}
2640 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2641 \immediate\write16{ to use a workaround.}
2642 \immediate\write16{}
2643 \global\warnedobstrue
2647 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2648 % workaround (which requires the file ``dummy.tfm'' to be installed),
2649 % uncomment the following line:
2650 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2652 % Ignore text, except that we keep track of conditional commands for
2653 % purposes of nesting, up to an `@end #1' command.
2655 \def\nestedignore#1{%
2657 % We must actually expand the ignored text to look for the @end
2658 % command, so that nested ignore constructs work. Thus, we put the
2659 % text into a \vbox and then do nothing with the result. To minimize
2660 % the chance of memory overflow, we follow the approach outlined on
2661 % page 401 of the TeXbook.
2663 \setbox0 = \vbox\bgroup
2664 % Don't complain about control sequences we have declared \outer.
2667 % Define `@end #1' to end the box, which will in turn undefine the
2668 % @end command again.
2669 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2671 % We are going to be parsing Texinfo commands. Most cause no
2672 % trouble when they are used incorrectly, but some commands do
2673 % complicated argument parsing or otherwise get confused, so we
2676 % We can't do anything about stray @-signs, unfortunately;
2677 % they'll produce `undefined control sequence' errors.
2680 % Set the current font to be \nullfont, a TeX primitive, and define
2681 % all the font commands to also use \nullfont. We don't use
2682 % dummy.tfm, as suggested in the TeXbook, because some sites
2683 % might not have that installed. Therefore, math mode will still
2684 % produce output, but that should be an extremely small amount of
2685 % stuff compared to the main input.
2688 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2689 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2690 \let\tensf=\nullfont
2691 % Similarly for index fonts.
2692 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2693 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2694 \let\smallsf=\nullfont
2695 % Similarly for smallexample fonts.
2696 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2697 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2698 \let\smallersf=\nullfont
2700 % Don't complain when characters are missing from the fonts.
2701 \tracinglostchars = 0
2703 % Don't bother to do space factor calculations.
2706 % Don't report underfull hboxes.
2709 % Do minimal line-breaking.
2710 \pretolerance = 10000
2712 % Do not execute instructions in @tex.
2713 \def\tex{\doignore{tex}}%
2714 % Do not execute macro definitions.
2715 % `c' is a comment character, so the word `macro' will get cut off.
2716 \def\macro{\doignore{ma}}%
2719 % @set VAR sets the variable VAR to an empty value.
2720 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2722 % Since we want to separate VAR from REST-OF-LINE (which might be
2723 % empty), we can't just use \parsearg; we have to insert a space of our
2724 % own to delimit the rest of the line, and then take it out again if we
2725 % didn't need it. Make sure the catcode of space is correct to avoid
2726 % losing inside @example, for instance.
2728 \def\set{\begingroup\catcode` =10
2729 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2731 \def\setxxx#1{\setyyy#1 \endsetyyy}
2732 \def\setyyy#1 #2\endsetyyy{%
2734 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2735 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2739 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2740 % \next or other control sequences that we've defined might get us into
2741 % an infinite loop. Consider `@set foo @cite{bar}'.
2742 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2744 % @clear VAR clears (i.e., unsets) the variable VAR.
2746 \def\clear{\parsearg\clearxxx}
2747 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2749 % @value{foo} gets the text saved in variable foo.
2751 \catcode`\_ = \active
2753 % We might end up with active _ or - characters in the argument if
2754 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2755 % such active characters to their normal equivalents.
2756 \gdef\value{\begingroup
2757 \catcode`\-=\other \catcode`\_=\other
2758 \indexbreaks \let_\normalunderscore
2761 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2763 % We have this subroutine so that we can handle at least some @value's
2764 % properly in indexes (we \let\value to this in \indexdummies). Ones
2765 % whose names contain - or _ still won't work, but we can't do anything
2766 % about that. The command has to be fully expandable (if the variable
2767 % is set), since the result winds up in the index file. This means that
2768 % if the variable's value contains other Texinfo commands, it's almost
2769 % certain it will fail (although perhaps we could fix that with
2770 % sufficient work to do a one-level expansion on the result, instead of
2773 \def\expandablevalue#1{%
2774 \expandafter\ifx\csname SET#1\endcsname\relax
2775 {[No value for ``#1'']}%
2776 \message{Variable `#1', used in @value, is not set.}%
2778 \csname SET#1\endcsname
2782 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2785 \def\ifset{\parsearg\doifset}
2787 \expandafter\ifx\csname SET#1\endcsname\relax
2788 \let\next=\ifsetfail
2790 \let\next=\ifsetsucceed
2794 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2795 \def\ifsetfail{\nestedignore{ifset}}
2796 \defineunmatchedend{ifset}
2798 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2799 % defined with @set, or has been undefined with @clear.
2801 \def\ifclear{\parsearg\doifclear}
2803 \expandafter\ifx\csname SET#1\endcsname\relax
2804 \let\next=\ifclearsucceed
2806 \let\next=\ifclearfail
2810 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2811 \def\ifclearfail{\nestedignore{ifclear}}
2812 \defineunmatchedend{ifclear}
2814 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2815 % read the text following, through the first @end iftex (etc.). Make
2816 % `@end iftex' (etc.) valid only after an @iftex.
2818 \def\iftex{\conditionalsucceed{iftex}}
2819 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2820 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2821 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2822 \defineunmatchedend{iftex}
2823 \defineunmatchedend{ifnothtml}
2824 \defineunmatchedend{ifnotinfo}
2825 \defineunmatchedend{ifnotplaintext}
2827 % True conditional. Since \set globally defines its variables, we can
2828 % just start and end a group (to keep the @end definition undefined at
2831 \def\conditionalsucceed#1{\begingroup
2832 \expandafter\def\csname E#1\endcsname{\endgroup}%
2835 % @defininfoenclose.
2836 \let\definfoenclose=\comment
2840 % Index generation facilities
2842 % Define \newwrite to be identical to plain tex's \newwrite
2843 % except not \outer, so it can be used within \newindex.
2845 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2847 % \newindex {foo} defines an index named foo.
2848 % It automatically defines \fooindex such that
2849 % \fooindex ...rest of line... puts an entry in the index foo.
2850 % It also defines \fooindfile to be the number of the output channel for
2851 % the file that accumulates this index. The file's extension is foo.
2852 % The name of an index should be no more than 2 characters long
2853 % for the sake of vms.
2857 \expandafter\newwrite \csname#1indfile\endcsname
2858 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2860 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2861 \noexpand\doindex{#1}}
2864 % @defindex foo == \newindex{foo}
2866 \def\defindex{\parsearg\newindex}
2868 % Define @defcodeindex, like @defindex except put all entries in @code.
2870 \def\defcodeindex{\parsearg\newcodeindex}
2872 \def\newcodeindex#1{%
2874 \expandafter\newwrite \csname#1indfile\endcsname
2875 \openout \csname#1indfile\endcsname \jobname.#1
2877 \expandafter\xdef\csname#1index\endcsname{%
2878 \noexpand\docodeindex{#1}}%
2882 % @synindex foo bar makes index foo feed into index bar.
2883 % Do this instead of @defindex foo if you don't want it as a separate index.
2885 % @syncodeindex foo bar similar, but put all entries made for index foo
2888 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2889 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2891 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2892 % #3 the target index (bar).
2893 \def\dosynindex#1#2#3{%
2894 % Only do \closeout if we haven't already done it, else we'll end up
2895 % closing the target index.
2896 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2897 % The \closeout helps reduce unnecessary open files; the limit on the
2898 % Acorn RISC OS is a mere 16 files.
2899 \expandafter\closeout\csname#2indfile\endcsname
2900 \expandafter\let\csname\donesynindex#2\endcsname = 1
2902 % redefine \fooindfile:
2903 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2904 \expandafter\let\csname#2indfile\endcsname=\temp
2905 % redefine \fooindex:
2906 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2909 % Define \doindex, the driver for all \fooindex macros.
2910 % Argument #1 is generated by the calling \fooindex macro,
2911 % and it is "foo", the name of the index.
2913 % \doindex just uses \parsearg; it calls \doind for the actual work.
2914 % This is because \doind is more useful to call from other macros.
2916 % There is also \dosubind {index}{topic}{subtopic}
2917 % which makes an entry in a two-level index such as the operation index.
2919 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2920 \def\singleindexer #1{\doind{\indexname}{#1}}
2922 % like the previous two, but they put @code around the argument.
2923 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2924 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2926 % Take care of Texinfo commands that can appear in an index entry.
2927 % Since there are some commands we want to expand, and others we don't,
2928 % we have to laboriously prevent expansion for those that we don't.
2931 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2932 \def\ {\realbackslash\space }%
2933 % Need these in case \tex is in effect and \{ is a \delimiter again.
2934 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2935 % braces and backslashes are used only as delimiters.
2939 % \definedummyword defines \#1 as \realbackslash #1\space, thus
2940 % effectively preventing its expansion. This is used only for control
2941 % words, not control letters, because the \space would be incorrect
2942 % for control characters, but is needed to separate the control word
2943 % from whatever follows.
2945 % For control letters, we have \definedummyletter, which omits the
2948 % These can be used both for control words that take an argument and
2949 % those that do not. If it is followed by {arg} in the input, then
2950 % that will dutifully get written to the index (or wherever).
2952 \def\definedummyword##1{%
2953 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
2955 \def\definedummyletter##1{%
2956 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
2959 % Do the redefinitions.
2963 % For the aux file, @ is the escape character. So we want to redefine
2964 % everything using @ instead of \realbackslash. When everything uses
2965 % @, this will be simpler.
2970 \let\{ = \lbraceatcmd
2971 \let\} = \rbraceatcmd
2973 % (See comments in \indexdummies.)
2974 \def\definedummyword##1{%
2975 \expandafter\def\csname ##1\endcsname{@##1\space}%
2977 \def\definedummyletter##1{%
2978 \expandafter\def\csname ##1\endcsname{@##1}%
2981 % Do the redefinitions.
2985 % Called from \indexdummies and \atdummies. \definedummyword and
2986 % \definedummyletter must be defined first.
2988 \def\commondummies{%
2990 \normalturnoffactive
2992 % Control letters and accents.
2993 \definedummyletter{_}%
2994 \definedummyletter{,}%
2995 \definedummyletter{"}%
2996 \definedummyletter{`}%
2997 \definedummyletter{'}%
2998 \definedummyletter{^}%
2999 \definedummyletter{~}%
3000 \definedummyletter{=}%
3001 \definedummyword{u}%
3002 \definedummyword{v}%
3003 \definedummyword{H}%
3004 \definedummyword{dotaccent}%
3005 \definedummyword{ringaccent}%
3006 \definedummyword{tieaccent}%
3007 \definedummyword{ubaraccent}%
3008 \definedummyword{udotaccent}%
3009 \definedummyword{dotless}%
3011 % Other non-English letters.
3012 \definedummyword{AA}%
3013 \definedummyword{AE}%
3014 \definedummyword{L}%
3015 \definedummyword{OE}%
3016 \definedummyword{O}%
3017 \definedummyword{aa}%
3018 \definedummyword{ae}%
3019 \definedummyword{l}%
3020 \definedummyword{oe}%
3021 \definedummyword{o}%
3022 \definedummyword{ss}%
3024 % Although these internal commands shouldn't show up, sometimes they do.
3025 \definedummyword{bf}%
3026 \definedummyword{gtr}%
3027 \definedummyword{hat}%
3028 \definedummyword{less}%
3029 \definedummyword{sf}%
3030 \definedummyword{sl}%
3031 \definedummyword{tclose}%
3032 \definedummyword{tt}%
3034 % Texinfo font commands.
3035 \definedummyword{b}%
3036 \definedummyword{i}%
3037 \definedummyword{r}%
3038 \definedummyword{sc}%
3039 \definedummyword{t}%
3041 \definedummyword{TeX}%
3042 \definedummyword{acronym}%
3043 \definedummyword{cite}%
3044 \definedummyword{code}%
3045 \definedummyword{command}%
3046 \definedummyword{dfn}%
3047 \definedummyword{dots}%
3048 \definedummyword{emph}%
3049 \definedummyword{env}%
3050 \definedummyword{file}%
3051 \definedummyword{kbd}%
3052 \definedummyword{key}%
3053 \definedummyword{math}%
3054 \definedummyword{option}%
3055 \definedummyword{samp}%
3056 \definedummyword{strong}%
3057 \definedummyword{uref}%
3058 \definedummyword{url}%
3059 \definedummyword{var}%
3060 \definedummyword{w}%
3062 % Assorted special characters.
3063 \definedummyword{bullet}%
3064 \definedummyword{copyright}%
3065 \definedummyword{dots}%
3066 \definedummyword{enddots}%
3067 \definedummyword{equiv}%
3068 \definedummyword{error}%
3069 \definedummyword{expansion}%
3070 \definedummyword{minus}%
3071 \definedummyword{pounds}%
3072 \definedummyword{point}%
3073 \definedummyword{print}%
3074 \definedummyword{result}%
3076 % Handle some cases of @value -- where the variable name does not
3077 % contain - or _, and the value does not contain any
3078 % (non-fully-expandable) commands.
3079 \let\value = \expandablevalue
3081 % Normal spaces, not active ones.
3084 % No macro expansion.
3088 % If an index command is used in an @example environment, any spaces
3089 % therein should become regular spaces in the raw index file, not the
3090 % expansion of \tie (\leavevmode \penalty \@M \ ).
3092 \gdef\unsepspaces{\obeyspaces\let =\space}}
3095 % \indexnofonts is used when outputting the strings to sort the index
3096 % by, and when constructing control sequence names. It eliminates all
3097 % control sequences and just writes whatever the best ASCII sort string
3098 % would be for a given command (usually its argument).
3100 \def\indexdummytex{TeX}
3101 \def\indexdummydots{...}
3106 % how to handle braces?
3107 \def\_{\normalunderscore}%
3119 \let\dotaccent=\asis
3120 \let\ringaccent=\asis
3121 \let\tieaccent=\asis
3122 \let\ubaraccent=\asis
3123 \let\udotaccent=\asis
3126 % Other non-English letters.
3139 \def\questiondown{?}%
3141 % Don't no-op \tt, since it isn't a user-level command
3142 % and is used in the definitions of the active chars like <, >, |, etc.
3143 % Likewise with the other plain tex font commands.
3146 % Texinfo font commands.
3153 \let\TeX=\indexdummytex
3159 \let\dots=\indexdummydots
3175 \let\indexbackslash=0 %overridden during \printindex.
3176 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3178 % For \ifx comparisons.
3179 \def\emptymacro{\empty}
3181 % Most index entries go through here, but \dosubind is the general case.
3183 \def\doind#1#2{\dosubind{#1}{#2}\empty}
3185 % Workhorse for all \fooindexes.
3186 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3187 % \empty if called from \doind, as we usually are. The main exception
3188 % is with defuns, which call us directly.
3190 \def\dosubind#1#2#3{%
3191 % Put the index entry in the margin if desired.
3192 \ifx\SETmarginindex\relax\else
3193 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
3196 \count255=\lastpenalty
3198 \indexdummies % Must do this here, since \bf, etc expand at this stage
3201 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3202 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3203 % so it will be output as is; and it will print as backslash.
3205 % The main index entry text.
3208 % If third arg is present, precede it with space in sort key.
3210 \ifx\thirdarg\emptymacro \else
3211 % If the third (subentry) arg is present, add it to the index
3213 \toks0 = \expandafter{\the\toks0 \space #3}%
3216 % Process the index entry with all font commands turned off, to
3217 % get the string to sort by.
3218 {\indexnofonts \xdef\indexsorttmp{\the\toks0}}%
3220 % Set up the complete index entry, with both the sort key and
3221 % the original text, including any font commands. We write
3222 % three arguments to \entry to the .?? file (four in the
3223 % subentry case), texindex reduces to two when writing the .??s
3226 \write\csname#1indfile\endcsname{%
3227 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3230 % If a skip is the last thing on the list now, preserve it
3231 % by backing up by \lastskip, doing the \write, then inserting
3232 % the skip again. Otherwise, the whatsit generated by the
3233 % \write will make \lastskip zero. The result is that sequences
3238 % will have extra space inserted, because the \medbreak in the
3239 % start of the @defun won't see the skip inserted by the @end of
3240 % the previous defun.
3242 % But don't do any of this if we're not in vertical mode. We
3243 % don't want to do a \vskip and prematurely end a paragraph.
3245 % Avoid page breaks due to these extra skips, too.
3250 \ifdim\lastskip = 0pt \else \nobreak\vskip-\skip0 \fi
3253 \temp % do the write
3255 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3263 % The index entry written in the file actually looks like
3264 % \entry {sortstring}{page}{topic}
3266 % \entry {sortstring}{page}{topic}{subtopic}
3267 % The texindex program reads in these files and writes files
3268 % containing these kinds of lines:
3270 % before the first topic whose initial is c
3271 % \entry {topic}{pagelist}
3272 % for a topic that is used without subtopics
3274 % for the beginning of a topic that is used with subtopics
3275 % \secondary {subtopic}{pagelist}
3276 % for each subtopic.
3278 % Define the user-accessible indexing commands
3279 % @findex, @vindex, @kindex, @cindex.
3281 \def\findex {\fnindex}
3282 \def\kindex {\kyindex}
3283 \def\cindex {\cpindex}
3284 \def\vindex {\vrindex}
3285 \def\tindex {\tpindex}
3286 \def\pindex {\pgindex}
3288 \def\cindexsub {\begingroup\obeylines\cindexsub}
3290 \gdef\cindexsub "#1" #2^^M{\endgroup %
3291 \dosubind{cp}{#2}{#1}}}
3293 % Define the macros used in formatting output of the sorted index material.
3295 % @printindex causes a particular index (the ??s file) to get printed.
3296 % It does not print any chapter heading (usually an @unnumbered).
3298 \def\printindex{\parsearg\doprintindex}
3299 \def\doprintindex#1{\begingroup
3300 \dobreak \chapheadingskip{10000}%
3306 % See if the index file exists and is nonempty.
3307 % Change catcode of @ here so that if the index file contains
3309 % as its first line, TeX doesn't complain about mismatched braces
3310 % (because it thinks @} is a control sequence).
3312 \openin 1 \jobname.#1s
3314 % \enddoublecolumns gets confused if there is no text in the index,
3315 % and it loses the chapter title and the aux file entries for the
3316 % index. The easiest way to prevent this problem is to make sure
3317 % there is some text.
3318 \putwordIndexNonexistent
3321 % If the index file exists but is empty, then \openin leaves \ifeof
3322 % false. We have to make TeX try to read something from the file, so
3323 % it can discover if there is anything in it.
3326 \putwordIndexIsEmpty
3328 % Index files are almost Texinfo source, but we use \ as the escape
3329 % character. It would be better to use @, but that's too big a change
3330 % to make right now.
3331 \def\indexbackslash{\rawbackslashxx}%
3342 % These macros are used by the sorted index file itself.
3343 % Change them to control the appearance of the index.
3346 % Some minor font changes for the special characters.
3347 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3349 % Remove any glue we may have, we'll be inserting our own.
3352 % We like breaks before the index initials, so insert a bonus.
3355 % Typeset the initial. Making this add up to a whole number of
3356 % baselineskips increases the chance of the dots lining up from column
3357 % to column. It still won't often be perfect, because of the stretch
3358 % we need before each entry, but it's better.
3360 % No shrink because it confuses \balancecolumns.
3361 \vskip 1.67\baselineskip plus .5\baselineskip
3362 \leftline{\secbf #1}%
3363 \vskip .33\baselineskip plus .1\baselineskip
3365 % Do our best not to break after the initial.
3369 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3370 % flush to the right margin. It is used for index and table of contents
3371 % entries. The paragraph is indented by \leftskip.
3373 \def\entry#1#2{\begingroup
3375 % Start a new paragraph if necessary, so our assignments below can't
3376 % affect previous text.
3379 % Do not fill out the last line with white space.
3382 % No extra space above this paragraph.
3385 % Do not prefer a separate line ending with a hyphen to fewer lines.
3386 \finalhyphendemerits = 0
3388 % \hangindent is only relevant when the entry text and page number
3389 % don't both fit on one line. In that case, bob suggests starting the
3390 % dots pretty far over on the line. Unfortunately, a large
3391 % indentation looks wrong when the entry text itself is broken across
3392 % lines. So we use a small indentation and put up with long leaders.
3394 % \hangafter is reset to 1 (which is the value we want) at the start
3395 % of each paragraph, so we need not do anything with that.
3398 % When the entry text needs to be broken, just fill out the first line
3400 \rightskip = 0pt plus1fil
3402 % A bit of stretch before each entry for the benefit of balancing columns.
3405 % Start a ``paragraph'' for the index entry so the line breaking
3406 % parameters we've set above will have an effect.
3409 % Insert the text of the index entry. TeX will do line-breaking on it.
3411 % The following is kludged to not output a line of dots in the index if
3412 % there are no page numbers. The next person who breaks this will be
3413 % cursed by a Unix daemon.
3416 \edef\tempc{\tempa}%
3417 \edef\tempd{\tempb}%
3418 \ifx\tempc\tempd\ \else%
3420 % If we must, put the page number on a line of its own, and fill out
3421 % this line with blank space. (The \hfil is overwhelmed with the
3422 % fill leaders glue in \indexdotfill if the page number does fit.)
3424 \null\nobreak\indexdotfill % Have leaders before the page number.
3426 % The `\ ' here is removed by the implicit \unskip that TeX does as
3427 % part of (the primitive) \par. Without it, a spurious underfull
3430 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3432 \ #2% The page number ends the paragraph.
3438 % Like \dotfill except takes at least 1 em.
3439 \def\indexdotfill{\cleaders
3440 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3442 \def\primary #1{\line{#1\hfil}}
3444 \newskip\secondaryindent \secondaryindent=0.5cm
3445 \def\secondary#1#2{{%
3450 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3452 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3459 % Define two-column mode, which we use to typeset indexes.
3460 % Adapted from the TeXbook, page 416, which is to say,
3461 % the manmac.tex format used to print the TeXbook itself.
3465 \newdimen\doublecolumnhsize
3467 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3468 % Grab any single-column material above us.
3471 % Here is a possibility not foreseen in manmac: if we accumulate a
3472 % whole lot of material, we might end up calling this \output
3473 % routine twice in a row (see the doublecol-lose test, which is
3474 % essentially a couple of indexes with @setchapternewpage off). In
3475 % that case we just ship out what is in \partialpage with the normal
3476 % output routine. Generally, \partialpage will be empty when this
3477 % runs and this will be a no-op. See the indexspread.tex test case.
3478 \ifvoid\partialpage \else
3479 \onepageout{\pagecontents\partialpage}%
3482 \global\setbox\partialpage = \vbox{%
3483 % Unvbox the main output page.
3485 \kern-\topskip \kern\baselineskip
3488 \eject % run that output routine to set \partialpage
3490 % Use the double-column output routine for subsequent pages.
3491 \output = {\doublecolumnout}%
3493 % Change the page size parameters. We could do this once outside this
3494 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3495 % format, but then we repeat the same computation. Repeating a couple
3496 % of assignments once per index is clearly meaningless for the
3497 % execution time, so we may as well do it in one place.
3499 % First we halve the line length, less a little for the gutter between
3500 % the columns. We compute the gutter based on the line length, so it
3501 % changes automatically with the paper format. The magic constant
3502 % below is chosen so that the gutter has the same value (well, +-<1pt)
3503 % as it did when we hard-coded it.
3505 % We put the result in a separate register, \doublecolumhsize, so we
3506 % can restore it in \pagesofar, after \hsize itself has (potentially)
3509 \doublecolumnhsize = \hsize
3510 \advance\doublecolumnhsize by -.04154\hsize
3511 \divide\doublecolumnhsize by 2
3512 \hsize = \doublecolumnhsize
3514 % Double the \vsize as well. (We don't need a separate register here,
3515 % since nobody clobbers \vsize.)
3519 % The double-column output routine for all double-column pages except
3522 \def\doublecolumnout{%
3523 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3524 % Get the available space for the double columns -- the normal
3525 % (undoubled) page height minus any material left over from the
3529 \advance\dimen@ by -\ht\partialpage
3531 % box0 will be the left-hand column, box2 the right.
3532 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3533 \onepageout\pagesofar
3535 \penalty\outputpenalty
3538 % Re-output the contents of the output page -- any previous material,
3539 % followed by the two boxes we just split, in box0 and box2.
3543 \hsize = \doublecolumnhsize
3544 \wd0=\hsize \wd2=\hsize
3545 \hbox to\pagewidth{\box0\hfil\box2}%
3548 % All done with double columns.
3549 \def\enddoublecolumns{%
3551 % Split the last of the double-column material. Leave it on the
3552 % current page, no automatic page break.
3555 % If we end up splitting too much material for the current page,
3556 % though, there will be another page break right after this \output
3557 % invocation ends. Having called \balancecolumns once, we do not
3558 % want to call it again. Therefore, reset \output to its normal
3559 % definition right away. (We hope \balancecolumns will never be
3560 % called on to balance too much material, but if it is, this makes
3561 % the output somewhat more palatable.)
3562 \global\output = {\onepageout{\pagecontents\PAGE}}%
3565 \endgroup % started in \begindoublecolumns
3567 % \pagegoal was set to the doubled \vsize above, since we restarted
3568 % the current page. We're now back to normal single-column
3569 % typesetting, so reset \pagegoal to the normal \vsize (after the
3570 % \endgroup where \vsize got restored).
3574 % Called at the end of the double column material.
3575 \def\balancecolumns{%
3576 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3578 \advance\dimen@ by \topskip
3579 \advance\dimen@ by-\baselineskip
3580 \divide\dimen@ by 2 % target to split to
3581 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3582 \splittopskip = \topskip
3583 % Loop until we get a decent breakpoint.
3587 \global\setbox3 = \copy0
3588 \global\setbox1 = \vsplit3 to \dimen@
3590 \global\advance\dimen@ by 1pt
3593 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3594 \setbox0=\vbox to\dimen@{\unvbox1}%
3595 \setbox2=\vbox to\dimen@{\unvbox3}%
3599 \catcode`\@ = \other
3602 \message{sectioning,}
3603 % Chapters, sections, etc.
3606 \newcount\secno \secno=0
3607 \newcount\subsecno \subsecno=0
3608 \newcount\subsubsecno \subsubsecno=0
3610 % This counter is funny since it counts through charcodes of letters A, B, ...
3611 \newcount\appendixno \appendixno = `\@
3612 % \def\appendixletter{\char\the\appendixno}
3613 % We do the following for the sake of pdftex, which needs the actual
3614 % letter in the expansion, not just typeset.
3615 \def\appendixletter{%
3616 \ifnum\appendixno=`A A%
3617 \else\ifnum\appendixno=`B B%
3618 \else\ifnum\appendixno=`C C%
3619 \else\ifnum\appendixno=`D D%
3620 \else\ifnum\appendixno=`E E%
3621 \else\ifnum\appendixno=`F F%
3622 \else\ifnum\appendixno=`G G%
3623 \else\ifnum\appendixno=`H H%
3624 \else\ifnum\appendixno=`I I%
3625 \else\ifnum\appendixno=`J J%
3626 \else\ifnum\appendixno=`K K%
3627 \else\ifnum\appendixno=`L L%
3628 \else\ifnum\appendixno=`M M%
3629 \else\ifnum\appendixno=`N N%
3630 \else\ifnum\appendixno=`O O%
3631 \else\ifnum\appendixno=`P P%
3632 \else\ifnum\appendixno=`Q Q%
3633 \else\ifnum\appendixno=`R R%
3634 \else\ifnum\appendixno=`S S%
3635 \else\ifnum\appendixno=`T T%
3636 \else\ifnum\appendixno=`U U%
3637 \else\ifnum\appendixno=`V V%
3638 \else\ifnum\appendixno=`W W%
3639 \else\ifnum\appendixno=`X X%
3640 \else\ifnum\appendixno=`Y Y%
3641 \else\ifnum\appendixno=`Z Z%
3642 % The \the is necessary, despite appearances, because \appendixletter is
3643 % expanded while writing the .toc file. \char\appendixno is not
3644 % expandable, thus it is written literally, thus all appendixes come out
3645 % with the same letter (or @) in the toc without it.
3646 \else\char\the\appendixno
3647 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3648 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3650 % Each @chapter defines this as the name of the chapter.
3651 % page headings and footings can use it. @section does likewise.
3655 \newcount\absseclevel % used to calculate proper heading level
3656 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3658 % @raisesections: treat @section as chapter, @subsection as section, etc.
3659 \def\raisesections{\global\advance\secbase by -1}
3660 \let\up=\raisesections % original BFox name
3662 % @lowersections: treat @chapter as section, @section as subsection, etc.
3663 \def\lowersections{\global\advance\secbase by 1}
3664 \let\down=\lowersections % original BFox name
3666 % Choose a numbered-heading macro
3667 % #1 is heading level if unmodified by @raisesections or @lowersections
3668 % #2 is text for heading
3669 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3675 \numberedsubseczzz{#2}
3677 \numberedsubsubseczzz{#2}
3679 \ifnum \absseclevel<0
3682 \numberedsubsubseczzz{#2}
3687 % like \numhead, but chooses appendix heading levels
3688 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3692 \appendixsectionzzz{#2}
3694 \appendixsubseczzz{#2}
3696 \appendixsubsubseczzz{#2}
3698 \ifnum \absseclevel<0
3701 \appendixsubsubseczzz{#2}
3706 % like \numhead, but chooses numberless heading levels
3707 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3711 \unnumberedseczzz{#2}
3713 \unnumberedsubseczzz{#2}
3715 \unnumberedsubsubseczzz{#2}
3717 \ifnum \absseclevel<0
3720 \unnumberedsubsubseczzz{#2}
3725 % @chapter, @appendix, @unnumbered.
3726 \def\thischaptername{No Chapter Title}
3727 \outer\def\chapter{\parsearg\chapteryyy}
3728 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3729 \def\chapterzzz #1{%
3730 \secno=0 \subsecno=0 \subsubsecno=0
3731 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3732 \chapmacro {#1}{\the\chapno}%
3733 \gdef\thissection{#1}%
3734 \gdef\thischaptername{#1}%
3735 % We don't substitute the actual chapter name into \thischapter
3736 % because we don't want its macros evaluated now.
3737 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3738 \writetocentry{chap}{#1}{{\the\chapno}}
3740 \global\let\section = \numberedsec
3741 \global\let\subsection = \numberedsubsec
3742 \global\let\subsubsection = \numberedsubsubsec
3745 % we use \chapno to avoid indenting back
3746 \def\appendixbox#1{%
3747 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3748 \hbox to \wd0{#1\hss}}
3750 \outer\def\appendix{\parsearg\appendixyyy}
3751 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3752 \def\appendixzzz #1{%
3753 \secno=0 \subsecno=0 \subsubsecno=0
3754 \global\advance \appendixno by 1
3755 \message{\putwordAppendix\space \appendixletter}%
3756 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3757 \gdef\thissection{#1}%
3758 \gdef\thischaptername{#1}%
3759 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3760 \writetocentry{appendix}{#1}{{\appendixletter}}
3762 \global\let\section = \appendixsec
3763 \global\let\subsection = \appendixsubsec
3764 \global\let\subsubsection = \appendixsubsubsec
3767 % @centerchap is like @unnumbered, but the heading is centered.
3768 \outer\def\centerchap{\parsearg\centerchapyyy}
3769 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3771 % @top is like @unnumbered.
3772 \outer\def\top{\parsearg\unnumberedyyy}
3774 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3775 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3776 \def\unnumberedzzz #1{%
3777 \secno=0 \subsecno=0 \subsubsecno=0
3779 % This used to be simply \message{#1}, but TeX fully expands the
3780 % argument to \message. Therefore, if #1 contained @-commands, TeX
3781 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3782 % expanded @cite (which turns out to cause errors because \cite is meant
3783 % to be executed, not expanded).
3785 % Anyway, we don't want the fully-expanded definition of @cite to appear
3786 % as a result of the \message, we just want `@cite' itself. We use
3787 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3788 % simply yielding the contents of <toks register>. (We also do this for
3790 \toks0 = {#1}\message{(\the\toks0)}%
3792 \unnumbchapmacro {#1}%
3793 \gdef\thischapter{#1}\gdef\thissection{#1}%
3794 \writetocentry{unnumbchap}{#1}{{\the\chapno}}
3796 \global\let\section = \unnumberedsec
3797 \global\let\subsection = \unnumberedsubsec
3798 \global\let\subsubsection = \unnumberedsubsubsec
3802 \outer\def\numberedsec{\parsearg\secyyy}
3803 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3805 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3806 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3807 \writetocentry{sec}{#1}{{\the\chapno}{\the\secno}}
3812 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3813 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3814 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3815 \def\appendixsectionzzz #1{%
3816 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3817 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3818 \writetocentry{sec}{#1}{{\appendixletter}{\the\secno}}
3823 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3824 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3825 \def\unnumberedseczzz #1{%
3826 \plainsecheading {#1}\gdef\thissection{#1}%
3827 \writetocentry{unnumbsec}{#1}{{\the\chapno}{\the\secno}}
3833 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3834 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3835 \def\numberedsubseczzz #1{%
3836 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3837 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3838 \writetocentry{subsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3843 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3844 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3845 \def\appendixsubseczzz #1{%
3846 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3847 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3848 \writetocentry{subsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}}
3853 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3854 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3855 \def\unnumberedsubseczzz #1{%
3856 \plainsubsecheading {#1}\gdef\thissection{#1}%
3857 \writetocentry{unnumbsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3863 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3864 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3865 \def\numberedsubsubseczzz #1{%
3866 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3867 \subsubsecheading {#1}
3868 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3869 \writetocentry{subsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3874 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3875 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3876 \def\appendixsubsubseczzz #1{%
3877 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3878 \subsubsecheading {#1}
3879 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3880 \writetocentry{subsubsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3885 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3886 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3887 \def\unnumberedsubsubseczzz #1{%
3888 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3889 \writetocentry{unnumbsubsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3894 % These are variants which are not "outer", so they can appear in @ifinfo.
3895 % Actually, they should now be obsolete; ordinary section commands should work.
3896 \def\infotop{\parsearg\unnumberedzzz}
3897 \def\infounnumbered{\parsearg\unnumberedzzz}
3898 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3899 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3900 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3902 \def\infoappendix{\parsearg\appendixzzz}
3903 \def\infoappendixsec{\parsearg\appendixseczzz}
3904 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3905 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3907 \def\infochapter{\parsearg\chapterzzz}
3908 \def\infosection{\parsearg\sectionzzz}
3909 \def\infosubsection{\parsearg\subsectionzzz}
3910 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3912 % These macros control what the section commands do, according
3913 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3914 % Define them by default for a numbered chapter.
3915 \global\let\section = \numberedsec
3916 \global\let\subsection = \numberedsubsec
3917 \global\let\subsubsection = \numberedsubsubsec
3919 % Define @majorheading, @heading and @subheading
3921 % NOTE on use of \vbox for chapter headings, section headings, and such:
3922 % 1) We use \vbox rather than the earlier \line to permit
3923 % overlong headings to fold.
3924 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3925 % heading is obnoxious; this forbids it.
3926 % 3) Likewise, headings look best if no \parindent is used, and
3927 % if justification is not attempted. Hence \raggedright.
3930 \def\majorheading{\parsearg\majorheadingzzz}
3931 \def\majorheadingzzz #1{%
3932 {\advance\chapheadingskip by 10pt \chapbreak }%
3933 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3934 \parindent=0pt\raggedright
3935 \rm #1\hfill}}\bigskip \par\penalty 200}
3937 \def\chapheading{\parsearg\chapheadingzzz}
3938 \def\chapheadingzzz #1{\chapbreak %
3939 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3940 \parindent=0pt\raggedright
3941 \rm #1\hfill}}\bigskip \par\penalty 200}
3943 % @heading, @subheading, @subsubheading.
3944 \def\heading{\parsearg\plainsecheading}
3945 \def\subheading{\parsearg\plainsubsecheading}
3946 \def\subsubheading{\parsearg\plainsubsubsecheading}
3948 % These macros generate a chapter, section, etc. heading only
3949 % (including whitespace, linebreaking, etc. around it),
3950 % given all the information in convenient, parsed form.
3952 %%% Args are the skip and penalty (usually negative)
3953 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3955 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3957 %%% Define plain chapter starts, and page on/off switching for it
3958 % Parameter controlling skip before chapter headings (if needed)
3960 \newskip\chapheadingskip
3962 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3963 \def\chappager{\par\vfill\supereject}
3964 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3966 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3969 \global\let\contentsalignmacro = \chappager
3970 \global\let\pchapsepmacro=\chapbreak
3971 \global\let\pagealignmacro=\chappager}
3974 \global\let\contentsalignmacro = \chappager
3975 \global\let\pchapsepmacro=\chappager
3976 \global\let\pagealignmacro=\chappager
3977 \global\def\HEADINGSon{\HEADINGSsingle}}
3980 \global\let\contentsalignmacro = \chapoddpage
3981 \global\let\pchapsepmacro=\chapoddpage
3982 \global\let\pagealignmacro=\chapoddpage
3983 \global\def\HEADINGSon{\HEADINGSdouble}}
3988 \global\let\chapmacro=\chfplain
3989 \global\let\unnumbchapmacro=\unnchfplain
3990 \global\let\centerchapmacro=\centerchfplain}
3992 % Plain chapter opening.
3993 % #1 is the text, #2 the chapter number or empty if unnumbered.
3999 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
4000 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4001 \hangindent = \wd0 \centerparametersmaybe
4004 \nobreak\bigskip % no page break after a chapter title
4008 % Plain opening for unnumbered.
4009 \def\unnchfplain#1{\chfplain{#1}{}}
4011 % @centerchap -- centered and unnumbered.
4012 \let\centerparametersmaybe = \relax
4013 \def\centerchfplain#1{{%
4014 \def\centerparametersmaybe{%
4015 \advance\rightskip by 3\rightskip
4016 \leftskip = \rightskip
4022 \CHAPFplain % The default
4024 \def\unnchfopen #1{%
4025 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4026 \parindent=0pt\raggedright
4027 \rm #1\hfill}}\bigskip \par\nobreak
4030 \def\chfopen #1#2{\chapoddpage {\chapfonts
4031 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4035 \def\centerchfopen #1{%
4036 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4038 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4042 \global\let\chapmacro=\chfopen
4043 \global\let\unnumbchapmacro=\unnchfopen
4044 \global\let\centerchapmacro=\centerchfopen}
4048 \newskip\secheadingskip
4049 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
4050 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
4051 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
4053 % Subsection titles.
4054 \newskip \subsecheadingskip
4055 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
4056 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
4057 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
4059 % Subsubsection titles.
4060 \let\subsubsecheadingskip = \subsecheadingskip
4061 \let\subsubsecheadingbreak = \subsecheadingbreak
4062 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
4063 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
4066 % Print any size section title.
4068 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
4069 % number (maybe empty), #3 the text.
4070 \def\sectionheading#1#2#3{%
4072 \expandafter\advance\csname #1headingskip\endcsname by \parskip
4073 \csname #1headingbreak\endcsname
4076 % Switch to the right set of fonts.
4077 \csname #1fonts\endcsname \rm
4079 % Only insert the separating space if we have a section number.
4081 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
4083 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4084 \hangindent = \wd0 % zero if no section number
4087 % Add extra space after the heading -- either a line space or a
4088 % paragraph space, whichever is more. (Some people like to set
4089 % \parskip to large values for some reason.)
4091 \ifdim\parskip>\normalbaselineskip
4094 \kern\normalbaselineskip
4101 % Table of contents.
4104 % Write an entry to the toc file, opening it if necessary.
4105 % Called from @chapter, etc. We supply {\folio} at the end of the
4106 % argument, which will end up as the last argument to the \...entry macro.
4108 % Usage: \writetocentry{chap}{The Name of The Game}{{\the\chapno}}
4109 % We open the .toc file for writing here instead of at @setfilename (or
4110 % any other fixed time) so that @contents can be anywhere in the document.
4112 \newif\iftocfileopened
4113 \def\writetocentry#1#2#3{%
4114 \iftocfileopened\else
4115 \immediate\openout\tocfile = \jobname.toc
4116 \global\tocfileopenedtrue
4121 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}#3{\folio}}}%
4125 % Tell \shipout to create a page destination if we're doing pdf, which
4126 % will be the target of the links in the table of contents. We can't
4127 % just do it on every page because the title pages are numbered 1 and
4128 % 2 (the page numbers aren't printed), and so are the first two pages
4129 % of the document. Thus, we'd have two destinations named `1', and
4131 \ifpdf \pdfmakepagedesttrue \fi
4134 \newskip\contentsrightmargin \contentsrightmargin=1in
4135 \newcount\savepageno
4136 \newcount\lastnegativepageno \lastnegativepageno = -1
4138 % Finish up the main text and prepare to read what we've written
4141 \def\startcontents#1{%
4142 % If @setchapternewpage on, and @headings double, the contents should
4143 % start on an odd page, unlike chapters. Thus, we maintain
4144 % \contentsalignmacro in parallel with \pagealignmacro.
4145 % From: Torbjorn Granlund <tege@matematik.su.se>
4147 \immediate\closeout\tocfile
4149 % Don't need to put `Contents' or `Short Contents' in the headline.
4150 % It is abundantly clear what they are.
4151 \unnumbchapmacro{#1}\def\thischapter{}%
4152 \savepageno = \pageno
4153 \begingroup % Set up to handle contents files properly.
4154 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4155 % We can't do this, because then an actual ^ in a section
4156 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4157 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4158 \raggedbottom % Worry more about breakpoints than the bottom.
4159 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4161 % Roman numerals for page numbers.
4162 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi
4166 % Normal (long) toc.
4168 \startcontents{\putwordTOC}%
4169 \openin 1 \jobname.toc
4175 \contentsalignmacro % in case @setchapternewpage odd is in effect
4178 \lastnegativepageno = \pageno
4179 \pageno = \savepageno
4182 % And just the chapters.
4183 \def\summarycontents{%
4184 \startcontents{\putwordShortTOC}%
4186 \let\chapentry = \shortchapentry
4187 \let\appendixentry = \shortappendixentry
4188 \let\unnumbchapentry = \shortunnumberedentry
4189 % We want a true roman here for the page numbers.
4191 \let\rm=\shortcontrm \let\bf=\shortcontbf
4192 \let\sl=\shortcontsl \let\tt=\shortconttt
4194 \hyphenpenalty = 10000
4195 \advance\baselineskip by 1pt % Open it up a little.
4196 \def\secentry ##1##2##3##4{}
4197 \def\subsecentry ##1##2##3##4##5{}
4198 \def\subsubsecentry ##1##2##3##4##5##6{}
4199 \let\unnumbsecentry = \secentry
4200 \let\unnumbsubsecentry = \subsecentry
4201 \let\unnumbsubsubsecentry = \subsubsecentry
4202 \openin 1 \jobname.toc
4208 \contentsalignmacro % in case @setchapternewpage odd is in effect
4210 \lastnegativepageno = \pageno
4211 \pageno = \savepageno
4213 \let\shortcontents = \summarycontents
4216 \pdfcatalog{/PageMode /UseOutlines}%
4219 % These macros generate individual entries in the table of contents.
4220 % The first argument is the chapter or section name.
4221 % The last argument is the page number.
4222 % The arguments in between are the chapter number, section number, ...
4224 % Chapters, in the main contents.
4225 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4227 % Chapters, in the short toc.
4228 % See comments in \dochapentry re vbox and related settings.
4229 \def\shortchapentry#1#2#3{%
4230 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4233 % Appendices, in the main contents.
4234 \def\appendixentry#1#2#3{%
4235 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4237 % Appendices, in the short toc.
4238 \let\shortappendixentry = \shortchapentry
4240 % Typeset the label for a chapter or appendix for the short contents.
4241 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4242 % We could simplify the code here by writing out an \appendixentry
4243 % command in the toc file for appendices, instead of using \chapentry
4244 % for both, but it doesn't seem worth it.
4246 \newdimen\shortappendixwidth
4248 \def\shortchaplabel#1{%
4249 % This space should be enough, since a single number is .5em, and the
4250 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4251 % But use \hss just in case.
4252 % (This space doesn't include the extra space that gets added after
4253 % the label; that gets put in by \shortchapentry above.)
4255 \hbox to \dimen0{#1\hss}%
4258 % Unnumbered chapters.
4259 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4260 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4263 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4264 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4267 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4268 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4270 % And subsubsections.
4271 \def\subsubsecentry#1#2#3#4#5#6{%
4272 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4273 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4275 % This parameter controls the indentation of the various levels.
4276 \newdimen\tocindent \tocindent = 3pc
4278 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4281 % If the toc has to be broken over pages, we want it to be at chapters
4282 % if at all possible; hence the \penalty.
4283 \def\dochapentry#1#2{%
4284 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4287 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4289 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4292 \def\dosecentry#1#2{\begingroup
4293 \secentryfonts \leftskip=\tocindent
4294 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4297 \def\dosubsecentry#1#2{\begingroup
4298 \subsecentryfonts \leftskip=2\tocindent
4299 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4302 \def\dosubsubsecentry#1#2{\begingroup
4303 \subsubsecentryfonts \leftskip=3\tocindent
4304 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4307 % Final typesetting of a toc entry; we use the same \entry macro as for
4308 % the index entries, but we want to suppress hyphenation here. (We
4309 % can't do that in the \entry macro, since index entries might consist
4310 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4311 \def\tocentry#1#2{\begingroup
4312 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4313 % Do not use \turnoffactive in these arguments. Since the toc is
4314 % typeset in cmr, characters such as _ would come out wrong; we
4315 % have to do the usual translation tricks.
4319 % Space between chapter (or whatever) number and the title.
4320 \def\labelspace{\hskip1em \relax}
4322 \def\dopageno#1{{\rm #1}}
4323 \def\doshortpageno#1{{\rm #1}}
4325 \def\chapentryfonts{\secfonts \rm}
4326 \def\secentryfonts{\textfonts}
4327 \let\subsecentryfonts = \textfonts
4328 \let\subsubsecentryfonts = \textfonts
4331 \message{environments,}
4332 % @foo ... @end foo.
4334 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4336 % Since these characters are used in examples, it should be an even number of
4337 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4340 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4341 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4342 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4343 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4345 % The @error{} command.
4346 % Adapted from the TeXbook's \boxit.
4350 {\tentt \global\dimen0 = 3em}% Width of the box.
4351 \dimen2 = .55pt % Thickness of rules
4352 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4353 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4355 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4356 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4357 \advance\hsize by -2\dimen2 % Rules.
4359 \hrule height\dimen2
4360 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4361 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4362 \kern3pt\vrule width\dimen2}% Space to right.
4363 \hrule height\dimen2}
4366 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4368 % @tex ... @end tex escapes into raw Tex temporarily.
4369 % One exception: @ is still an escape character, so that @end tex works.
4370 % But \@ or @@ will get a plain tex @ character.
4372 \def\tex{\begingroup
4373 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4374 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4375 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4386 \let\bullet=\ptexbullet
4391 \let\equiv=\ptexequiv
4400 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4401 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4403 \let\Etex=\endgroup}
4405 % Define @lisp ... @end lisp.
4406 % @lisp does a \begingroup so it can rebind things,
4407 % including the definition of @end lisp (which normally is erroneous).
4409 % Amount to narrow the margins by for @lisp.
4410 \newskip\lispnarrowing \lispnarrowing=0.4in
4412 % This is the definition that ^^M gets inside @lisp, @example, and other
4413 % such environments. \null is better than a space, since it doesn't
4415 \def\lisppar{\null\endgraf}
4417 % Make each space character in the input produce a normal interword
4418 % space in the output. Don't allow a line break at this space, as this
4419 % is used only in environments like @example, where each line of input
4420 % should produce a line of output anyway.
4423 \gdef\sepspaces{\obeyspaces\let =\tie}}
4425 % Define \obeyedspace to be our active space, whatever it is. This is
4426 % for use in \parsearg.
4428 \global\let\obeyedspace= }
4430 % This space is always present above and below environments.
4431 \newskip\envskipamount \envskipamount = 0pt
4433 % Make spacing and below environment symmetrical. We use \parskip here
4434 % to help in doing that, since in @example-like environments \parskip
4435 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4436 % start of the next paragraph will insert \parskip.
4438 \def\aboveenvbreak{{%
4439 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4440 \ifnum \lastpenalty=10000 \else
4441 \advance\envskipamount by \parskip
4443 \ifdim\lastskip<\envskipamount
4445 % it's not a good place to break if the last penalty was \nobreak
4447 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4448 \vskip\envskipamount
4453 \let\afterenvbreak = \aboveenvbreak
4455 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4456 \let\nonarrowing=\relax
4458 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4459 % environment contents.
4460 \font\circle=lcircle10
4462 \newdimen\cartouter\newdimen\cartinner
4463 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4464 \circthick=\fontdimen8\circle
4466 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4467 \def\ctr{{\hskip 6pt\circle\char'010}}
4468 \def\cbl{{\circle\char'012\hskip -6pt}}
4469 \def\cbr{{\hskip 6pt\circle\char'011}}
4470 \def\carttop{\hbox to \cartouter{\hskip\lskip
4471 \ctl\leaders\hrule height\circthick\hfil\ctr
4473 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4474 \cbl\leaders\hrule height\circthick\hfil\cbr
4477 \newskip\lskip\newskip\rskip
4481 \lskip=\leftskip \rskip=\rightskip
4482 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4483 \cartinner=\hsize \advance\cartinner by-\lskip
4484 \advance\cartinner by-\rskip
4486 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4487 % side, and for 6pt waste from
4488 % each corner char, and rule thickness
4489 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4490 % Flag to tell @lisp, etc., not to narrow margin.
4491 \let\nonarrowing=\comment
4493 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4502 \baselineskip=\normbskip
4503 \lineskip=\normlskip
4519 % This macro is called at the beginning of all the @example variants,
4523 \inENV % This group ends at the end of the body
4524 \hfuzz = 12pt % Don't be fussy
4525 \sepspaces % Make spaces be word-separators rather than space tokens.
4526 \let\par = \lisppar % don't ignore blank lines
4527 \obeylines % each line of input is a line of output
4530 \emergencystretch = 0pt % don't try to avoid overfull boxes
4531 % @cartouche defines \nonarrowing to inhibit narrowing
4532 % at next level down.
4533 \ifx\nonarrowing\relax
4534 \advance \leftskip by \lispnarrowing
4535 \exdentamount=\lispnarrowing
4536 \let\exdent=\nofillexdent
4537 \let\nonarrowing=\relax
4541 % Define the \E... control sequence only if we are inside the particular
4542 % environment, so the error checking in \end will work.
4544 % To end an @example-like environment, we first end the paragraph (via
4545 % \afterenvbreak's vertical glue), and then the group. That way we keep
4546 % the zero \parskip that the environments set -- \parskip glue will be
4547 % inserted at the beginning of the next paragraph in the document, after
4550 \def\nonfillfinish{\afterenvbreak\endgroup}
4552 % @lisp: indented, narrowed, typewriter font.
4553 \def\lisp{\begingroup
4555 \let\Elisp = \nonfillfinish
4557 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4558 \gobble % eat return
4561 % @example: Same as @lisp.
4562 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4564 % @smallexample and @smalllisp: use smaller fonts.
4565 % Originally contributed by Pavel@xerox.
4566 \def\smalllisp{\begingroup
4567 \def\Esmalllisp{\nonfillfinish\endgroup}%
4568 \def\Esmallexample{\nonfillfinish\endgroup}%
4572 \let\smallexample = \smalllisp
4575 % @display: same as @lisp except keep current font.
4577 \def\display{\begingroup
4579 \let\Edisplay = \nonfillfinish
4583 % @smalldisplay: @display plus smaller fonts.
4585 \def\smalldisplay{\begingroup
4586 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4587 \smallexamplefonts \rm
4591 % @format: same as @display except don't narrow margins.
4593 \def\format{\begingroup
4594 \let\nonarrowing = t
4596 \let\Eformat = \nonfillfinish
4600 % @smallformat: @format plus smaller fonts.
4602 \def\smallformat{\begingroup
4603 \def\Esmallformat{\nonfillfinish\endgroup}%
4604 \smallexamplefonts \rm
4608 % @flushleft (same as @format).
4610 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4614 \def\flushright{\begingroup
4615 \let\nonarrowing = t
4617 \let\Eflushright = \nonfillfinish
4618 \advance\leftskip by 0pt plus 1fill
4623 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4624 % and narrows the margins.
4627 \begingroup\inENV %This group ends at the end of the @quotation body
4628 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4630 % We have retained a nonzero parskip for the environment, since we're
4631 % doing normal filling. So to avoid extra space below the environment...
4632 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4634 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4635 \ifx\nonarrowing\relax
4636 \advance\leftskip by \lispnarrowing
4637 \advance\rightskip by \lispnarrowing
4638 \exdentamount = \lispnarrowing
4639 \let\nonarrowing = \relax
4644 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4645 % If we want to allow any <char> as delimiter,
4646 % we need the curly braces so that makeinfo sees the @verb command, eg:
4647 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4649 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4651 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4652 % active too. Otherwise, they get lost as the first character on a
4655 \do\ \do\\\do\{\do\}\do\$\do\&%
4656 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4657 \do\<\do\>\do\|\do\@\do+\do\"%
4661 \def\uncatcodespecials{%
4662 \def\do##1{\catcode`##1=12}\dospecials}
4664 % [Knuth] pp. 380,381,391
4665 % Disable Spanish ligatures ?` and !` of \tt font
4667 \catcode`\`=\active\gdef`{\relax\lq}
4670 % Setup for the @verb command.
4672 % Eight spaces for a tab
4674 \catcode`\^^I=\active
4675 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4679 \tt % easiest (and conventionally used) font for verbatim
4680 \def\par{\leavevmode\endgraf}%
4683 % Respect line breaks,
4684 % print special symbols as themselves, and
4685 % make each space count
4686 % must do in this order:
4687 \obeylines \uncatcodespecials \sepspaces
4690 % Setup for the @verbatim environment
4692 % Real tab expansion
4693 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4695 \def\starttabbox{\setbox0=\hbox\bgroup}
4697 \catcode`\^^I=\active
4699 \catcode`\^^I=\active
4700 \def^^I{\leavevmode\egroup
4701 \dimen0=\wd0 % the width so far, or since the previous tab
4702 \divide\dimen0 by\tabw
4703 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4704 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4705 \wd0=\dimen0 \box0 \starttabbox
4709 \def\setupverbatim{%
4710 % Easiest (and conventionally used) font for verbatim
4712 \def\par{\leavevmode\egroup\box0\endgraf}%
4715 % Respect line breaks,
4716 % print special symbols as themselves, and
4717 % make each space count
4718 % must do in this order:
4719 \obeylines \uncatcodespecials \sepspaces
4720 \everypar{\starttabbox}%
4723 % Do the @verb magic: verbatim text is quoted by unique
4724 % delimiter characters. Before first delimiter expect a
4725 % right brace, after last delimiter expect closing brace:
4727 % \def\doverb'{'<char>#1<char>'}'{#1}
4729 % [Knuth] p. 382; only eat outer {}
4731 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4732 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4735 \def\verb{\begingroup\setupverb\doverb}
4738 % Do the @verbatim magic: define the macro \doverbatim so that
4739 % the (first) argument ends when '@end verbatim' is reached, ie:
4741 % \def\doverbatim#1@end verbatim{#1}
4743 % For Texinfo it's a lot easier than for LaTeX,
4744 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4745 % we need not redefine '\', '{' and '}'.
4747 % Inspired by LaTeX's verbatim command set [latex.ltx]
4748 %% Include LaTeX hack for completeness -- never know
4750 %% \catcode`|=0 \catcode`[=1
4751 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4752 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4753 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4759 % ignore everything up to the first ^^M, that's the newline at the end
4760 % of the @verbatim input line itself. Otherwise we get an extra blank
4761 % line in the output.
4762 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}%
4766 \def\Everbatim{\nonfillfinish\endgroup}%
4769 \advance\leftskip by -\defbodyindent
4770 \begingroup\setupverbatim\doverbatim
4773 % @verbatiminclude FILE - insert text of file in verbatim environment.
4775 % Allow normal characters that we make active in the argument (a file name).
4776 \def\verbatiminclude{%
4786 \parsearg\doverbatiminclude
4788 \def\setupverbatiminclude{%
4791 \advance\leftskip by -\defbodyindent
4792 \begingroup\setupverbatim
4795 \def\doverbatiminclude#1{%
4796 % Restore active chars for included file.
4799 \let\value=\expandablevalue
4801 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4807 % @copying ... @end copying.
4808 % Save the text away for @insertcopying later. Many commands won't be
4809 % allowed in this context, but that's ok.
4811 % We save the uninterpreted tokens, rather than creating a box.
4812 % Saving the text in a box would be much easier, but then all the
4813 % typesetting commands (@smallbook, font changes, etc.) have to be done
4814 % beforehand -- and a) we want @copying to be done first in the source
4815 % file; b) letting users define the frontmatter in as flexible order as
4816 % possible is very desirable.
4818 \def\copying{\begingroup
4819 % Define a command to swallow text until we reach `@end copying'.
4820 % \ is the escape char in this texinfo.tex file, so it is the
4821 % delimiter for the command; @ will be the escape char when we read
4822 % it, but that doesn't matter.
4823 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4825 % We must preserve ^^M's in the input file; see \insertcopying below.
4826 \catcode`\^^M = \active
4830 % What we do to finish off the copying text.
4832 \def\enddocopying{\endgroup\ignorespaces}
4834 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4835 % we need them to delimit commands such as `@end quotation', so they
4836 % must be active. On the other hand, we certainly don't want every
4837 % end-of-line to be a \par, as would happen with the normal active
4838 % definition of ^^M. On the third hand, two ^^M's in a row should still
4841 % Our approach is to make ^^M insert a space and a penalty1 normally;
4842 % then it can also check if \lastpenalty=1. If it does, then manually
4845 % This messes up the normal definitions of @c[omment], so we redefine
4846 % it. Similarly for @ignore. (These commands are used in the gcc
4847 % manual for man page generation.)
4849 % Seems pretty fragile, most line-oriented commands will presumably
4850 % fail, but for the limited use of getting the copying text (which
4851 % should be quite simple) inserted, we can hope it's ok.
4853 {\catcode`\^^M=\active %
4854 \gdef\insertcopying{\begingroup %
4855 \parindent = 0pt % looks wrong on title page
4857 \ifnum \lastpenalty=1 %
4864 % Fix @c[omment] for catcode 13 ^^M's.
4865 \def\c##1^^M{\ignorespaces}%
4868 % Don't bother jumping through all the hoops that \doignore does, it
4869 % would be very hard since the catcodes are already set.
4870 \long\def\ignore##1\end ignore{\ignorespaces}%
4879 % Allow user to change definition object font (\df) internally
4880 \def\setdeffont#1 {\csname DEF#1\endcsname}
4882 \newskip\defbodyindent \defbodyindent=.4in
4883 \newskip\defargsindent \defargsindent=50pt
4884 \newskip\deflastargmargin \deflastargmargin=18pt
4886 \newcount\parencount
4888 % We want ()&[] to print specially on the defun line.
4891 \catcode`\(=\active \catcode`\)=\active
4893 \catcode`\[=\active \catcode`\]=\active
4896 % Make control sequences which act like normal parenthesis chars.
4897 \let\lparen = ( \let\rparen = )
4899 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4901 % Be sure that we always have a definition for `(', etc. For example,
4902 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4903 % so TeX would otherwise complain about undefined control sequence.
4904 \global\let(=\lparen \global\let)=\rparen
4905 \global\let[=\lbrack \global\let]=\rbrack
4907 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4908 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4909 % This is used to turn on special parens
4910 % but make & act ordinary (given that it's active).
4911 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4913 % Definitions of (, ) and & used in args for functions.
4914 % This is the definition of ( outside of all parentheses.
4915 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4916 \global\advance\parencount by 1
4919 % This is the definition of ( when already inside a level of parens.
4920 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4922 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4923 % also in that case restore the outer-level definition of (.
4924 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4925 \global\advance \parencount by -1 }
4926 % If we encounter &foo, then turn on ()-hacking afterwards
4927 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4929 \gdef\normalparens{\boldbrax\let&=\ampnr}
4930 } % End of definition inside \activeparens
4931 %% These parens (in \boldbrax) actually are a little bolder than the
4932 %% contained text. This is especially needed for [ and ]
4933 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4934 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4936 \def\lbrb{{\bf\char`\[}}
4937 \def\rbrb{{\bf\char`\]}}
4939 % Active &'s sneak into the index arguments, so make sure it's defined.
4941 \catcode`& = \active
4942 \global\let& = \ampnr
4945 % \defname, which formats the name of the @def (not the args).
4946 % #1 is the function name.
4947 % #2 is the type of definition, such as "Function".
4950 % How we'll output the type name. Putting it in brackets helps
4951 % distinguish it from the body text that may end up on the next line
4956 \def\defnametype{[\rm #2]}%
4959 % Get the values of \leftskip and \rightskip as they were outside the @def...
4961 \advance\dimen2 by -\defbodyindent
4963 % Figure out values for the paragraph shape.
4964 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}%
4965 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4966 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations
4967 \parshape 2 0in \dimen0 \defargsindent \dimen1
4969 % Output arg 2 ("Function" or some such) but stuck inside a box of
4970 % width 0 so it does not interfere with linebreaking.
4973 {% Adjust \hsize to exclude the ambient margins,
4974 % so that \rightline will obey them.
4975 \advance \hsize by -\dimen2
4976 \dimen3 = 0pt % was -1.25pc
4977 \rlap{\rightline{\defnametype\kern\dimen3}}%
4980 % Allow all lines to be underfull without complaint:
4981 \tolerance=10000 \hbadness=10000
4982 \advance\leftskip by -\defbodyindent
4983 \exdentamount=\defbodyindent
4984 {\df #1}\enskip % output function name
4985 % \defunargs will be called next to output the arguments, if any.
4988 % Common pieces to start any @def...
4989 % #1 is the \E... control sequence to end the definition (which we define).
4990 % #2 is the \...x control sequence (which our caller defines).
4991 % #3 is the control sequence to process the header, such as \defunheader.
4993 \def\parsebodycommon#1#2#3{%
4995 % If there are two @def commands in a row, we'll have a \nobreak,
4996 % which is there to keep the function description together with its
4997 % header. But if there's nothing but headers, we want to allow a
4999 \ifnum\lastpenalty=10000 \penalty0 \fi
5002 % Define the \E... end token that this defining construct specifies
5003 % so that it will exit this group.
5004 \def#1{\endgraf\endgroup\medbreak}%
5007 \advance\leftskip by \defbodyindent
5008 \exdentamount=\defbodyindent
5011 % Common part of the \...x definitions.
5013 \def\defxbodycommon{%
5014 % As with \parsebodycommon above, allow line break if we have multiple
5015 % x headers in a row. It's not a great place, though.
5016 \ifnum\lastpenalty=10000 \penalty1000 \fi
5018 \begingroup\obeylines
5021 % Process body of @defun, @deffn, @defmac, etc.
5023 \def\defparsebody#1#2#3{%
5024 \parsebodycommon{#1}{#2}{#3}%
5025 \def#2{\defxbodycommon \activeparens \spacesplit#3}%
5026 \catcode\equalChar=\active
5027 \begingroup\obeylines\activeparens
5031 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
5032 % #4, delimited by the space, is the class name.
5034 \def\defmethparsebody#1#2#3#4 {%
5035 \parsebodycommon{#1}{#2}{#3}%
5036 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
5037 \begingroup\obeylines\activeparens
5038 % The \empty here prevents misinterpretation of a construct such as
5039 % @deffn {whatever} {Enharmonic comma}
5040 % See comments at \deftpparsebody, although in our case we don't have
5041 % to remove the \empty afterwards, since it is empty.
5042 \spacesplit{#3{#4}}\empty
5045 % Used for @deftypemethod and @deftypeivar.
5046 % #1, #2, #3 are the common arguments (see \defparsebody).
5047 % #4, delimited by a space, is the class name.
5048 % #5 is the method's return type.
5050 \def\deftypemethparsebody#1#2#3#4 #5 {%
5051 \parsebodycommon{#1}{#2}{#3}%
5052 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
5053 \begingroup\obeylines\activeparens
5054 \spacesplit{#3{#4}{#5}}%
5057 % Used for @deftypeop. The change from \deftypemethparsebody is an
5058 % extra argument at the beginning which is the `category', instead of it
5059 % being the hardwired string `Method' or `Instance Variable'. We have
5060 % to account for this both in the \...x definition and in parsing the
5061 % input at hand. Thus also need a control sequence (passed as #5) for
5062 % the \E... definition to assign the category name to.
5064 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
5065 \parsebodycommon{#1}{#2}{#3}%
5066 \def#2##1 ##2 ##3 {\def#4{##1}%
5067 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
5068 \begingroup\obeylines\activeparens
5069 \spacesplit{#3{#5}{#6}}%
5073 \def\defopparsebody #1#2#3#4#5 {%
5074 \parsebodycommon{#1}{#2}{#3}%
5075 \def#2##1 ##2 {\def#4{##1}%
5076 \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
5077 \begingroup\obeylines\activeparens
5078 \spacesplit{#3{#5}}%
5081 % These parsing functions are similar to the preceding ones
5082 % except that they do not make parens into active characters.
5083 % These are used for "variables" since they have no arguments.
5085 \def\defvarparsebody #1#2#3{%
5086 \parsebodycommon{#1}{#2}{#3}%
5087 \def#2{\defxbodycommon \spacesplit#3}%
5088 \catcode\equalChar=\active
5089 \begingroup\obeylines
5094 \def\defopvarparsebody #1#2#3#4#5 {%
5095 \parsebodycommon{#1}{#2}{#3}%
5096 \def#2##1 ##2 {\def#4{##1}%
5097 \defxbodycommon \spacesplit{#3{##2}}}%
5098 \begingroup\obeylines
5099 \spacesplit{#3{#5}}%
5102 \def\defvrparsebody#1#2#3#4 {%
5103 \parsebodycommon{#1}{#2}{#3}%
5104 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5105 \begingroup\obeylines
5106 \spacesplit{#3{#4}}%
5109 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5110 % type is just `struct', because we lose the braces in `{struct
5111 % termios}' when \spacesplit reads its undelimited argument. Sigh.
5112 % \let\deftpparsebody=\defvrparsebody
5114 % So, to get around this, we put \empty in with the type name. That
5115 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5116 % won't strip off the braces.
5118 \def\deftpparsebody #1#2#3#4 {%
5119 \parsebodycommon{#1}{#2}{#3}%
5120 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5121 \begingroup\obeylines
5122 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5125 % Fine, but then we have to eventually remove the \empty *and* the
5126 % braces (if any). That's what this does.
5128 \def\removeemptybraces\empty#1\relax{#1}
5130 % After \spacesplit has done its work, this is called -- #1 is the final
5131 % thing to call, #2 the type name (which starts with \empty), and #3
5132 % (which might be empty) the arguments.
5134 \def\parsetpheaderline#1#2#3{%
5135 #1{\removeemptybraces#2\relax}{#3}%
5138 % Split up #2 (the rest of the input line) at the first space token.
5139 % call #1 with two arguments:
5140 % the first is all of #2 before the space token,
5141 % the second is all of #2 after that space token.
5142 % If #2 contains no space token, all of it is passed as the first arg
5143 % and the second is passed as empty.
5146 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5147 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5157 % First, define the processing that is wanted for arguments of \defun
5158 % Use this to expand the args and terminate the paragraph they make up
5160 \def\defunargs#1{\functionparens \sl
5161 % Expand, preventing hyphenation at `-' chars.
5162 % Note that groups don't affect changes in \hyphenchar.
5163 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5164 {\tensl\hyphenchar\font=0}%
5166 {\tensl\hyphenchar\font=45}%
5167 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
5168 \interlinepenalty=10000
5169 \advance\rightskip by 0pt plus 1fil
5170 \endgraf\nobreak\vskip -\parskip\nobreak
5173 \def\deftypefunargs #1{%
5174 % Expand, preventing hyphenation at `-' chars.
5175 % Note that groups don't affect changes in \hyphenchar.
5176 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
5178 \tclose{#1}% avoid \code because of side effects on active chars
5179 \interlinepenalty=10000
5180 \advance\rightskip by 0pt plus 1fil
5181 \endgraf\nobreak\vskip -\parskip\nobreak
5184 % Do complete processing of one @defun or @defunx line already parsed.
5186 % @deffn Command forward-char nchars
5188 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5190 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5191 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5192 \catcode\equalChar=\other % Turn off change made in \defparsebody
5195 % @defun == @deffn Function
5197 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5199 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5200 \begingroup\defname {#1}{\putwordDeffunc}%
5201 \defunargs {#2}\endgroup %
5202 \catcode\equalChar=\other % Turn off change made in \defparsebody
5205 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5207 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5209 % #1 is the data type. #2 is the name and args.
5210 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5211 % #1 is the data type, #2 the name, #3 the args.
5212 \def\deftypefunheaderx #1#2 #3\relax{%
5213 \doind {fn}{\code{#2}}% Make entry in function index
5214 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5215 \deftypefunargs {#3}\endgroup %
5216 \catcode\equalChar=\other % Turn off change made in \defparsebody
5219 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5221 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5223 % \defheaderxcond#1\relax$.$
5224 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5225 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5227 % #1 is the classification. #2 is the data type. #3 is the name and args.
5228 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5229 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5230 \def\deftypefnheaderx #1#2#3 #4\relax{%
5231 \doind {fn}{\code{#3}}% Make entry in function index
5233 \normalparens % notably, turn off `&' magic, which prevents
5234 % at least some C++ text from working
5235 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5236 \deftypefunargs {#4}\endgroup %
5237 \catcode\equalChar=\other % Turn off change made in \defparsebody
5240 % @defmac == @deffn Macro
5242 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5244 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5245 \begingroup\defname {#1}{\putwordDefmac}%
5246 \defunargs {#2}\endgroup %
5247 \catcode\equalChar=\other % Turn off change made in \defparsebody
5250 % @defspec == @deffn Special Form
5252 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5254 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5255 \begingroup\defname {#1}{\putwordDefspec}%
5256 \defunargs {#2}\endgroup %
5257 \catcode\equalChar=\other % Turn off change made in \defparsebody
5260 % @defop CATEGORY CLASS OPERATION ARG...
5262 \def\defop #1 {\def\defoptype{#1}%
5263 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5265 \def\defopheader#1#2#3{%
5266 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% function index entry
5268 \defname{#2}{\defoptype\ \putwordon\ #1}%
5273 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5275 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5276 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5279 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5280 \def\deftypeopheader#1#2#3#4{%
5281 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5283 \defname{\defheaderxcond#2\relax$.$#3}
5284 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5285 \deftypefunargs{#4}%
5289 % @deftypemethod CLASS TYPE METHOD ARG...
5291 \def\deftypemethod{%
5292 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5294 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5295 \def\deftypemethodheader#1#2#3#4{%
5296 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5298 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5299 \deftypefunargs{#4}%
5303 % @deftypeivar CLASS TYPE VARNAME
5306 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5308 % #1 is the class name, #2 the data type, #3 the variable name.
5309 \def\deftypeivarheader#1#2#3{%
5310 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5312 \defname{\defheaderxcond#2\relax$.$#3}
5313 {\putwordInstanceVariableof\ \code{#1}}%
5318 % @defmethod == @defop Method
5320 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5322 % #1 is the class name, #2 the method name, #3 the args.
5323 \def\defmethodheader#1#2#3{%
5324 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5326 \defname{#2}{\putwordMethodon\ \code{#1}}%
5331 % @defcv {Class Option} foo-class foo-flag
5333 \def\defcv #1 {\def\defcvtype{#1}%
5334 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5336 \def\defcvarheader #1#2#3{%
5337 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% variable index entry
5339 \defname{#2}{\defcvtype\ \putwordof\ #1}%
5344 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5346 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5348 \def\defivarheader#1#2#3{%
5349 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% entry in var index
5351 \defname{#2}{\putwordInstanceVariableof\ #1}%
5357 % First, define the processing that is wanted for arguments of @defvar.
5358 % This is actually simple: just print them in roman.
5359 % This must expand the args and terminate the paragraph they make up
5360 \def\defvarargs #1{\normalparens #1%
5361 \interlinepenalty=10000
5362 \endgraf\nobreak\vskip -\parskip\nobreak}
5364 % @defvr Counter foo-count
5366 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5368 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5369 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5371 % @defvar == @defvr Variable
5373 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5375 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5376 \begingroup\defname {#1}{\putwordDefvar}%
5377 \defvarargs {#2}\endgroup %
5380 % @defopt == @defvr {User Option}
5382 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5384 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5385 \begingroup\defname {#1}{\putwordDefopt}%
5386 \defvarargs {#2}\endgroup %
5389 % @deftypevar int foobar
5391 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5393 % #1 is the data type. #2 is the name, perhaps followed by text that
5394 % is actually part of the data type, which should not be put into the index.
5395 \def\deftypevarheader #1#2{%
5396 \dovarind#2 \relax% Make entry in variables index
5397 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5398 \interlinepenalty=10000
5399 \endgraf\nobreak\vskip -\parskip\nobreak
5401 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5403 % @deftypevr {Global Flag} int enable
5405 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5407 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5408 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5409 \interlinepenalty=10000
5410 \endgraf\nobreak\vskip -\parskip\nobreak
5414 % Args are printed in bold, a slight difference from @defvar.
5416 \def\deftpargs #1{\bf \defvarargs{#1}}
5418 % @deftp Class window height width ...
5420 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5422 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5423 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5425 % These definitions are used if you use @defunx (etc.)
5426 % anywhere other than immediately after a @defun or @defunx.
5428 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5429 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5430 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5431 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5432 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5433 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5434 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5435 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5436 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5437 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5438 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5439 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5440 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5441 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5442 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5443 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5444 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5445 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5446 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5452 % To do this right we need a feature of e-TeX, \scantokens,
5453 % which we arrange to emulate with a temporary file in ordinary TeX.
5454 \ifx\eTeXversion\undefined
5455 \newwrite\macscribble
5457 \begingroup \newlinechar`\^^M
5458 % Undo catcode changes of \startcontents and \doprintindex
5459 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5460 % Append \endinput to make sure that TeX does not see the ending newline.
5461 \toks0={#1\endinput}%
5462 \immediate\openout\macscribble=\jobname.tmp
5463 \immediate\write\macscribble{\the\toks0}%
5464 \immediate\closeout\macscribble
5465 \let\xeatspaces\eatspaces
5471 \begingroup \newlinechar`\^^M
5472 % Undo catcode changes of \startcontents and \doprintindex
5473 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5474 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5477 \newcount\paramno % Count of parameters
5478 \newtoks\macname % Macro name
5479 \newif\ifrecursive % Is it recursive?
5480 \def\macrolist{} % List of all defined macros in the form
5481 % \do\macro1\do\macro2...
5484 % Thisdoes \let #1 = #2, except with \csnames.
5486 \expandafter\expandafter
5488 \expandafter\expandafter
5490 \csname#2\endcsname}
5492 % Trim leading and trailing spaces off a string.
5493 % Concepts from aro-bend problem 15 (see CTAN).
5495 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5496 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5497 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5499 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5502 % Trim a single trailing ^^M off a string.
5503 {\catcode`\^^M=\other \catcode`\Q=3%
5504 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5505 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5506 \gdef\eatcrb#1Q#2Q{#1}%
5509 % Macro bodies are absorbed as an argument in a context where
5510 % all characters are catcode 10, 11 or 12, except \ which is active
5511 % (as in normal texinfo). It is necessary to change the definition of \.
5513 % It's necessary to have hard CRs when the macro is executed. This is
5514 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5515 % body, and then making it the \newlinechar in \scanmacro.
5517 \def\macrobodyctxt{%
5528 \catcode`\^^M=\other
5542 % \mbodybackslash is the definition of \ in @macro bodies.
5543 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5544 % where N is the macro parameter number.
5545 % We define \csname macarg.\endcsname to be \realbackslash, so
5546 % \\ in macro replacement text gets you a backslash.
5548 {\catcode`@=0 @catcode`@\=@active
5549 @gdef@usembodybackslash{@let\=@mbodybackslash}
5550 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5552 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5554 \def\macro{\recursivefalse\parsearg\macroxxx}
5555 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5558 \getargs{#1}% now \macname is the macname and \argl the arglist
5559 \ifx\argl\empty % no arguments
5562 \expandafter\parsemargdef \argl;%
5564 \if1\csname ismacro.\the\macname\endcsname
5565 \message{Warning: redefining \the\macname}%
5567 \expandafter\ifx\csname \the\macname\endcsname \relax
5568 \else \errmessage{Macro name \the\macname\space already defined}\fi
5569 \global\cslet{macsave.\the\macname}{\the\macname}%
5570 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5571 % Add the macroname to \macrolist
5572 \toks0 = \expandafter{\macrolist\do}%
5573 \xdef\macrolist{\the\toks0
5574 \expandafter\noexpand\csname\the\macname\endcsname}%
5576 \begingroup \macrobodyctxt
5577 \ifrecursive \expandafter\parsermacbody
5578 \else \expandafter\parsemacbody
5581 \def\unmacro{\parsearg\dounmacro}
5583 \if1\csname ismacro.#1\endcsname
5584 \global\cslet{#1}{macsave.#1}%
5585 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5586 % Remove the macro name from \macrolist:
5588 \expandafter\let\csname#1\endcsname \relax
5590 \xdef\macrolist{\macrolist}%
5593 \errmessage{Macro #1 not defined}%
5597 % Called by \do from \dounmacro on each macro. The idea is to omit any
5598 % macro definitions that have been changed to \relax.
5604 \noexpand\do \noexpand #1%
5608 % This makes use of the obscure feature that if the last token of a
5609 % <parameter list> is #, then the preceding argument is delimited by
5610 % an opening brace, and that opening brace is not consumed.
5611 \def\getargs#1{\getargsxxx#1{}}
5612 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5613 \def\getmacname #1 #2\relax{\macname={#1}}
5614 \def\getmacargs#1{\def\argl{#1}}
5616 % Parse the optional {params} list. Set up \paramno and \paramlist
5617 % so \defmacro knows what to do. Define \macarg.blah for each blah
5618 % in the params list, to be ##N where N is the position in that list.
5619 % That gets used by \mbodybackslash (above).
5621 % We need to get `macro parameter char #' into several definitions.
5622 % The technique used is stolen from LaTeX: let \hash be something
5623 % unexpandable, insert that wherever you need a #, and then redefine
5624 % it to # just before using the token list produced.
5626 % The same technique is used to protect \eatspaces till just before
5627 % the macro is used.
5629 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5630 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5631 \def\parsemargdefxxx#1,{%
5632 \if#1;\let\next=\relax
5633 \else \let\next=\parsemargdefxxx
5634 \advance\paramno by 1%
5635 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5636 {\xeatspaces{\hash\the\paramno}}%
5637 \edef\paramlist{\paramlist\hash\the\paramno,}%
5640 % These two commands read recursive and nonrecursive macro bodies.
5641 % (They're different since rec and nonrec macros end differently.)
5643 \long\def\parsemacbody#1@end macro%
5644 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5645 \long\def\parsermacbody#1@end rmacro%
5646 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5648 % This defines the macro itself. There are six cases: recursive and
5649 % nonrecursive macros of zero, one, and many arguments.
5650 % Much magic with \expandafter here.
5651 % \xdef is used so that macro definitions will survive the file
5652 % they're defined in; @include reads the file inside a group.
5654 \let\hash=##% convert placeholders to macro parameter chars
5658 \expandafter\xdef\csname\the\macname\endcsname{%
5659 \noexpand\scanmacro{\temp}}%
5661 \expandafter\xdef\csname\the\macname\endcsname{%
5662 \bgroup\noexpand\macroargctxt
5663 \noexpand\braceorline
5664 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5665 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5666 \egroup\noexpand\scanmacro{\temp}}%
5668 \expandafter\xdef\csname\the\macname\endcsname{%
5669 \bgroup\noexpand\macroargctxt
5670 \noexpand\csname\the\macname xx\endcsname}%
5671 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5672 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5673 \expandafter\expandafter
5675 \expandafter\expandafter
5676 \csname\the\macname xxx\endcsname
5677 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5682 \expandafter\xdef\csname\the\macname\endcsname{%
5683 \noexpand\norecurse{\the\macname}%
5684 \noexpand\scanmacro{\temp}\egroup}%
5686 \expandafter\xdef\csname\the\macname\endcsname{%
5687 \bgroup\noexpand\macroargctxt
5688 \noexpand\braceorline
5689 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5690 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5692 \noexpand\norecurse{\the\macname}%
5693 \noexpand\scanmacro{\temp}\egroup}%
5695 \expandafter\xdef\csname\the\macname\endcsname{%
5696 \bgroup\noexpand\macroargctxt
5697 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5698 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5699 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5700 \expandafter\expandafter
5702 \expandafter\expandafter
5703 \csname\the\macname xxx\endcsname
5706 \noexpand\norecurse{\the\macname}%
5707 \noexpand\scanmacro{\temp}\egroup}%
5711 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5713 % \braceorline decides whether the next nonwhitespace character is a
5714 % {. If so it reads up to the closing }, if not, it reads the whole
5715 % line. Whatever was read is then fed to the next control sequence
5716 % as an argument (by \parsebrace or \parsearg)
5717 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5718 \def\braceorlinexxx{%
5719 \ifx\nchar\bgroup\else
5720 \expandafter\parsearg
5723 % We mant to disable all macros during \shipout so that they are not
5724 % expanded by \write.
5725 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5726 \edef\next{\macrolist}\expandafter\endgroup\next}
5730 % We need some trickery to remove the optional spaces around the equal
5731 % sign. Just make them active and then expand them all to nothing.
5732 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5733 \def\aliasxxx #1{\aliasyyy#1\relax}
5734 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5735 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5736 \expandafter\noexpand\csname#2\endcsname}%
5737 \expandafter\endgroup\next}
5740 \message{cross references,}
5745 \newif\ifhavexrefs % True if xref values are known.
5746 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5748 % @inforef is relatively simple.
5749 \def\inforef #1{\inforefzzz #1,,,,**}
5750 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5751 node \samp{\ignorespaces#1{}}}
5753 % @node's job is to define \lastnode.
5754 \def\node{\ENVcheck\parsearg\nodezzz}
5755 \def\nodezzz#1{\nodexxx [#1,]}
5756 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5758 \let\lastnode=\relax
5760 % The sectioning commands (@chapter, etc.) call these.
5762 \ifx\lastnode\relax\else
5763 \expandafter\expandafter\expandafter\setref{\lastnode}%
5764 {Ysectionnumberandtype}%
5765 \global\let\lastnode=\relax
5768 \def\unnumbnoderef{%
5769 \ifx\lastnode\relax\else
5770 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5771 \global\let\lastnode=\relax
5774 \def\appendixnoderef{%
5775 \ifx\lastnode\relax\else
5776 \expandafter\expandafter\expandafter\setref{\lastnode}%
5777 {Yappendixletterandtype}%
5778 \global\let\lastnode=\relax
5783 % @anchor{NAME} -- define xref target at arbitrary point.
5785 \newcount\savesfregister
5786 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5787 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5788 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5790 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5791 % anchor), namely NAME-title (the corresponding @chapter/etc. name),
5792 % NAME-pg (the page number), and NAME-snt (section number and type).
5793 % Called from \foonoderef.
5795 % We have to set \indexdummies so commands such as @code in a section
5796 % title aren't expanded. It would be nicer not to expand the titles in
5797 % the first place, but there's so many layers that that is hard to do.
5799 % Likewise, use \turnoffactive so that punctuation chars such as underscore
5800 % and backslash work in node names.
5807 \dosetq{#1-title}{Ytitle}%
5808 \dosetq{#1-pg}{Ypagenumber}%
5809 \dosetq{#1-snt}{#2}%
5812 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5813 % the node name, #2 the name of the Info cross-reference, #3 the printed
5814 % node name, #4 the name of the Info file, #5 the name of the printed
5815 % manual. All but the node name can be omitted.
5817 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5818 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5819 \def\ref#1{\xrefX[#1,,,,,,,]}
5820 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5822 \def\printedmanual{\ignorespaces #5}%
5823 \def\printednodename{\ignorespaces #3}%
5824 \setbox1=\hbox{\printedmanual}%
5825 \setbox0=\hbox{\printednodename}%
5827 % No printed node name was explicitly given.
5828 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5829 % Use the node name inside the square brackets.
5830 \def\printednodename{\ignorespaces #1}%
5832 % Use the actual chapter/section title appear inside
5833 % the square brackets. Use the real section title if we have it.
5835 % It is in another manual, so we don't have it.
5836 \def\printednodename{\ignorespaces #1}%
5839 % We know the real title if we have the xref values.
5840 \def\printednodename{\refx{#1-title}{}}%
5842 % Otherwise just copy the Info node name.
5843 \def\printednodename{\ignorespaces #1}%
5849 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5850 % insert empty discretionaries after hyphens, which means that it will
5851 % not find a line break at a hyphen in a node names. Since some manuals
5852 % are best written with fairly long node names, containing hyphens, this
5853 % is a loss. Therefore, we give the text of the node name again, so it
5854 % is as if TeX is seeing it for the first time.
5858 {\turnoffactive \otherbackslash
5859 \ifnum\filenamelength>0
5860 \startlink attr{/Border [0 0 0]}%
5861 goto file{\the\filename.pdf} name{#1}%
5863 \startlink attr{/Border [0 0 0]}%
5871 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5873 % _ (for example) has to be the character _ for the purposes of the
5874 % control sequence corresponding to the node, but it has to expand
5875 % into the usual \leavevmode...\vrule stuff for purposes of
5876 % printing. So we \turnoffactive for the \refx-snt, back on for the
5877 % printing, back off for the \refx-pg.
5878 {\turnoffactive \otherbackslash
5879 % Only output a following space if the -snt ref is nonempty; for
5880 % @unnumbered and @anchor, it won't be.
5881 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5882 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5885 [\printednodename],\space
5887 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5892 % \dosetq is called from \setref to do the actual \write (\iflinks).
5896 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5901 % \internalsetq{foo}{page} expands into
5902 % CHARACTERS @xrdef{foo}{...expansion of \page...}
5903 \def\internalsetq#1#2{@xrdef{#1}{\csname #2\endcsname}}
5905 % Things to be expanded by \internalsetq.
5907 \def\Ypagenumber{\folio}
5908 \def\Ytitle{\thissection}
5910 \def\Ysectionnumberandtype{%
5912 \putwordChapter@tie \the\chapno
5913 \else \ifnum\subsecno=0
5914 \putwordSection@tie \the\chapno.\the\secno
5915 \else \ifnum\subsubsecno=0
5916 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5918 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5922 \def\Yappendixletterandtype{%
5924 \putwordAppendix@tie @char\the\appendixno{}%
5925 \else \ifnum\subsecno=0
5926 \putwordSection@tie @char\the\appendixno.\the\secno
5927 \else \ifnum\subsubsecno=0
5928 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5931 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5935 % Use TeX 3.0's \inputlineno to get the line number, for better error
5936 % messages, but if we're using an old version of TeX, don't do anything.
5938 \ifx\inputlineno\thisisundefined
5939 \let\linenumber = \empty % Pre-3.0.
5941 \def\linenumber{\the\inputlineno:\space}
5944 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5945 % If its value is nonempty, SUFFIX is output afterward.
5951 \expandafter\global\expandafter\let\expandafter\thisrefX
5952 \csname X#1\endcsname
5955 % If not defined, say something at least.
5956 \angleleft un\-de\-fined\angleright
5959 \message{\linenumber Undefined cross reference `#1'.}%
5962 \global\warnedxrefstrue
5963 \message{Cross reference values unknown; you must run TeX again.}%
5968 % It's defined, so just use it.
5971 #2% Output the suffix in any case.
5974 % This is the macro invoked by entries in the aux file.
5976 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
5978 % Read the last existing aux file, if any. No error if none exists.
5979 \def\readauxfile{\begingroup
5980 \catcode`\^^@=\other
5981 \catcode`\^^A=\other
5982 \catcode`\^^B=\other
5983 \catcode`\^^C=\other
5984 \catcode`\^^D=\other
5985 \catcode`\^^E=\other
5986 \catcode`\^^F=\other
5987 \catcode`\^^G=\other
5988 \catcode`\^^H=\other
5989 \catcode`\^^K=\other
5990 \catcode`\^^L=\other
5991 \catcode`\^^N=\other
5992 \catcode`\^^P=\other
5993 \catcode`\^^Q=\other
5994 \catcode`\^^R=\other
5995 \catcode`\^^S=\other
5996 \catcode`\^^T=\other
5997 \catcode`\^^U=\other
5998 \catcode`\^^V=\other
5999 \catcode`\^^W=\other
6000 \catcode`\^^X=\other
6001 \catcode`\^^Z=\other
6002 \catcode`\^^[=\other
6003 \catcode`\^^\=\other
6004 \catcode`\^^]=\other
6005 \catcode`\^^^=\other
6006 \catcode`\^^_=\other
6007 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6008 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6009 % supported in the main text, it doesn't seem desirable. Furthermore,
6010 % that is not enough: for node names that actually contain a ^
6011 % character, we would end up writing a line like this: 'xrdef {'hat
6012 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6013 % argument, and \hat is not an expandable control sequence. It could
6014 % all be worked out, but why? Either we support ^^ or we don't.
6016 % The other change necessary for this was to define \auxhat:
6017 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6018 % and then to call \auxhat in \setq.
6022 % Special characters. Should be turned off anyway, but...
6035 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6037 % Make the characters 128-255 be printing characters
6041 \catcode\count 1=\other
6042 \advance\count 1 by 1
6043 \ifnum \count 1<256 \loop \fi
6047 % Turn off \ as an escape so we do not lose on
6048 % entries which were dumped with control sequences in their names.
6049 % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^
6050 % Reference to such entries still does not work the way one would wish,
6051 % but at least they do not bomb out when the aux file is read in.
6054 % @ is our escape character in .aux files.
6059 \openin 1 \jobname.aux
6063 \global\havexrefstrue
6064 \global\warnedobstrue
6066 % Open the new aux file. TeX will close it automatically at exit.
6067 \openout\auxfile=\jobname.aux
6073 \newcount \footnoteno
6075 % The trailing space in the following definition for supereject is
6076 % vital for proper filling; pages come out unaligned when you do a
6077 % pagealignmacro call if that space before the closing brace is
6078 % removed. (Generally, numeric constants should always be followed by a
6079 % space to prevent strange expansion errors.)
6080 \def\supereject{\par\penalty -20000\footnoteno =0 }
6082 % @footnotestyle is meaningful for info output only.
6083 \let\footnotestyle=\comment
6085 \let\ptexfootnote=\footnote
6089 % Auto-number footnotes. Otherwise like plain.
6091 \global\advance\footnoteno by \@ne
6092 \edef\thisfootno{$^{\the\footnoteno}$}%
6094 % In case the footnote comes at the end of a sentence, preserve the
6095 % extra spacing after we do the footnote number.
6097 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
6099 % Remove inadvertent blank space before typesetting the footnote number.
6105 % Don't bother with the trickery in plain.tex to not require the
6106 % footnote text as a parameter. Our footnotes don't need to be so general.
6108 % Oh yes, they do; otherwise, @ifset and anything else that uses
6109 % \parseargline fail inside footnotes because the tokens are fixed when
6110 % the footnote is read. --karl, 16nov96.
6112 % The start of the footnote looks usually like this:
6113 \gdef\startfootins{\insert\footins\bgroup}
6115 % ... but this macro is redefined inside @multitable.
6119 % We want to typeset this text as a normal paragraph, even if the
6120 % footnote reference occurs in (for example) a display environment.
6121 % So reset some parameters.
6123 \interlinepenalty\interfootnotelinepenalty
6124 \splittopskip\ht\strutbox % top baseline for broken footnotes
6125 \splitmaxdepth\dp\strutbox
6126 \floatingpenalty\@MM
6131 \parindent\defaultparindent
6135 % Because we use hanging indentation in footnotes, a @noindent appears
6136 % to exdent this text, so make it be a no-op. makeinfo does not use
6137 % hanging indentation so @noindent can still be needed within footnote
6138 % text after an @example or the like (not that this is good style).
6139 \let\noindent = \relax
6141 % Hang the footnote text off the number. Use \everypar in case the
6142 % footnote extends for more than one paragraph.
6143 \everypar = {\hang}%
6144 \textindent{\thisfootno}%
6146 % Don't crash into the line above the footnote text. Since this
6147 % expands into a box, it must come within the paragraph, lest it
6148 % provide a place where TeX can split the footnote.
6150 \futurelet\next\fo@t
6152 }%end \catcode `\@=11
6154 % @| inserts a changebar to the left of the current line. It should
6155 % surround any changed text. This approach does *not* work if the
6156 % change spans more than two lines of output. To handle that, we would
6157 % have adopt a much more difficult approach (putting marks into the main
6158 % vertical list for the beginning and end of each change).
6161 % \vadjust can only be used in horizontal mode.
6164 % Append this vertical mode material after the current line in the output.
6166 % We want to insert a rule with the height and depth of the current
6167 % leading; that is exactly what \strutbox is supposed to record.
6168 \vskip-\baselineskip
6170 % \vadjust-items are inserted at the left edge of the type. So
6171 % the \llap here moves out into the left-hand margin.
6174 % For a thicker or thinner bar, change the `1pt'.
6175 \vrule height\baselineskip width1pt
6177 % This is the space between the bar and the text.
6183 % For a final copy, take out the rectangles
6184 % that mark overfull boxes (in case you have decided
6185 % that the text looks ok even though it passes the margin).
6187 \def\finalout{\overfullrule=0pt}
6189 % @image. We use the macros from epsf.tex to support this.
6190 % If epsf.tex is not installed and @image is used, we complain.
6192 % Check for and read epsf.tex up front. If we read it only at @image
6193 % time, we might be inside a group, and then its definitions would get
6194 % undone and the next image would fail.
6195 \openin 1 = epsf.tex
6198 % Do not bother showing banner with epsf.tex v2.7k (available in
6199 % doc/epsf.tex and on ctan).
6200 \def\epsfannounce{\toks0 = }%
6204 % We will only complain once about lack of epsf.tex.
6205 \newif\ifwarnednoepsf
6206 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6207 work. It is also included in the Texinfo distribution, or you can get
6208 it from ftp://tug.org/tex/epsf.tex.}
6211 \ifx\epsfbox\undefined
6212 \ifwarnednoepsf \else
6213 \errhelp = \noepsfhelp
6214 \errmessage{epsf.tex not found, images will be ignored}%
6215 \global\warnednoepsftrue
6218 \imagexxx #1,,,,,\finish
6222 % Arguments to @image:
6223 % #1 is (mandatory) image filename; we tack on .eps extension.
6224 % #2 is (optional) width, #3 is (optional) height.
6225 % #4 is (ignored optional) html alt text.
6226 % #5 is (ignored optional) extension.
6227 % #6 is just the usual extra ignored arg for parsing this stuff.
6229 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6230 \catcode`\^^M = 5 % in case we're inside an example
6231 \normalturnoffactive % allow _ et al. in names
6232 % If the image is by itself, center it.
6236 % Usually we'll have text after the image which will insert
6237 % \parskip glue, so insert it here too to equalize the space
6239 \nobreak\vskip\parskip
6246 \dopdfimage{#1}{#2}{#3}%
6248 % \epsfbox itself resets \epsf?size at each figure.
6249 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6250 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6254 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6258 \message{localization,}
6261 % @documentlanguage is usually given very early, just after
6262 % @setfilename. If done too late, it may not override everything
6263 % properly. Single argument is the language abbreviation.
6264 % It would be nice if we could set up a hyphenation file here.
6266 \def\documentlanguage{\parsearg\dodocumentlanguage}
6267 \def\dodocumentlanguage#1{%
6268 \tex % read txi-??.tex file in plain TeX.
6269 % Read the file if it exists.
6270 \openin 1 txi-#1.tex
6272 \errhelp = \nolanghelp
6273 \errmessage{Cannot read language file txi-#1.tex}%
6276 \def\temp{\input txi-#1.tex }%
6281 \newhelp\nolanghelp{The given language definition file cannot be found or
6282 is empty. Maybe you need to install it? In the current directory
6283 should work if nowhere else does.}
6286 % @documentencoding should change something in TeX eventually, most
6287 % likely, but for now just recognize it.
6288 \let\documentencoding = \comment
6291 % Page size parameters.
6293 \newdimen\defaultparindent \defaultparindent = 15pt
6295 \chapheadingskip = 15pt plus 4pt minus 2pt
6296 \secheadingskip = 12pt plus 3pt minus 2pt
6297 \subsecheadingskip = 9pt plus 2pt minus 2pt
6299 % Prevent underfull vbox error messages.
6302 % Don't be so finicky about underfull hboxes, either.
6305 % Following George Bush, just get rid of widows and orphans.
6309 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6310 % using an old version of TeX, don't do anything. We want the amount of
6311 % stretch added to depend on the line length, hence the dependence on
6312 % \hsize. We call this whenever the paper size is set.
6314 \def\setemergencystretch{%
6315 \ifx\emergencystretch\thisisundefined
6316 % Allow us to assign to \emergencystretch anyway.
6317 \def\emergencystretch{\dimen0}%
6319 \emergencystretch = .15\hsize
6323 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6324 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6325 % physical page width.
6327 % We also call \setleading{\textleading}, so the caller should define
6328 % \textleading. The caller should also set \parskip.
6330 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6333 \splittopskip = \topskip
6336 \advance\vsize by \topskip
6337 \outervsize = \vsize
6338 \advance\outervsize by 2\topandbottommargin
6339 \pageheight = \vsize
6342 \outerhsize = \hsize
6343 \advance\outerhsize by 0.5in
6346 \normaloffset = #4\relax
6347 \bindingoffset = #5\relax
6350 \pdfpageheight #7\relax
6351 \pdfpagewidth #8\relax
6354 \setleading{\textleading}
6356 \parindent = \defaultparindent
6357 \setemergencystretch
6360 % @letterpaper (the default).
6361 \def\letterpaper{{\globaldefs = 1
6362 \parskip = 3pt plus 2pt minus 1pt
6363 \textleading = 13.2pt
6365 % If page is nothing but text, make it come out even.
6366 \internalpagesizes{46\baselineskip}{6in}%
6368 {\bindingoffset}{36pt}%
6372 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6373 \def\smallbook{{\globaldefs = 1
6374 \parskip = 2pt plus 1pt
6377 \internalpagesizes{7.5in}{5in}%
6379 {\bindingoffset}{16pt}%
6382 \lispnarrowing = 0.3in
6385 \contentsrightmargin = 0pt
6386 \defbodyindent = .5cm
6389 % Use @afourpaper to print on European A4 paper.
6390 \def\afourpaper{{\globaldefs = 1
6391 \parskip = 3pt plus 2pt minus 1pt
6392 \textleading = 13.2pt
6394 % Double-side printing via postscript on Laserjet 4050
6395 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6396 % To change the settings for a different printer or situation, adjust
6397 % \normaloffset until the front-side and back-side texts align. Then
6398 % do the same for \bindingoffset. You can set these for testing in
6399 % your texinfo source file like this:
6401 % \global\normaloffset = -6mm
6402 % \global\bindingoffset = 10mm
6404 \internalpagesizes{51\baselineskip}{160mm}
6405 {\voffset}{\hoffset}%
6406 {\bindingoffset}{44pt}%
6411 \contentsrightmargin = 0pt
6412 \defbodyindent = 5mm
6415 % Use @afivepaper to print on European A5 paper.
6416 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6417 % He also recommends making @example and @lisp be small.
6418 \def\afivepaper{{\globaldefs = 1
6419 \parskip = 2pt plus 1pt minus 0.1pt
6420 \textleading = 12.5pt
6422 \internalpagesizes{160mm}{120mm}%
6423 {\voffset}{\hoffset}%
6424 {\bindingoffset}{8pt}%
6427 \lispnarrowing = 0.2in
6430 \contentsrightmargin = 0pt
6431 \defbodyindent = 2mm
6435 % A specific text layout, 24x15cm overall, intended for A4 paper.
6436 \def\afourlatex{{\globaldefs = 1
6438 \internalpagesizes{237mm}{150mm}%
6440 {\bindingoffset}{7mm}%
6443 % Must explicitly reset to 0 because we call \afourpaper.
6447 % Use @afourwide to print on A4 paper in landscape format.
6448 \def\afourwide{{\globaldefs = 1
6450 \internalpagesizes{241mm}{165mm}%
6451 {\voffset}{-2.95mm}%
6452 {\bindingoffset}{7mm}%
6457 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6458 % Perhaps we should allow setting the margins, \topskip, \parskip,
6459 % and/or leading, also. Or perhaps we should compute them somehow.
6461 \def\pagesizes{\parsearg\pagesizesxxx}
6462 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6463 \def\pagesizesyyy#1,#2,#3\finish{{%
6464 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6467 \parskip = 3pt plus 2pt minus 1pt
6468 \setleading{\textleading}%
6471 \advance\dimen0 by \voffset
6474 \advance\dimen2 by \normaloffset
6476 \internalpagesizes{#1}{\hsize}%
6477 {\voffset}{\normaloffset}%
6478 {\bindingoffset}{44pt}%
6482 % Set default to letter.
6487 \message{and turning on texinfo input format.}
6489 % Define macros to output various characters with catcode for normal text.
6499 \def\normaldoublequote{"}
6502 \def\normalunderscore{_}
6503 \def\normalverticalbar{|}
6505 \def\normalgreater{>}
6507 \def\normaldollar{$}%$ font-lock fix
6509 % This macro is used to make a character print one way in ttfont
6510 % where it can probably just be output, and another way in other fonts,
6511 % where something hairier probably needs to be done.
6513 % #1 is what to print if we are indeed using \tt; #2 is what to print
6514 % otherwise. Since all the Computer Modern typewriter fonts have zero
6515 % interword stretch (and shrink), and it is reasonable to expect all
6516 % typewriter fonts to have this, we can check that font parameter.
6518 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6520 % Same as above, but check for italic font. Actually this also catches
6521 % non-italic slanted fonts since it is impossible to distinguish them from
6522 % italic fonts. But since this is only used by $ and it uses \sl anyway
6523 % this is not a problem.
6524 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6526 % Turn off all special characters except @
6527 % (and those which the user can use as if they were ordinary).
6528 % Most of these we simply print from the \tt font, but for some, we can
6529 % use math or other variants that look better in normal text.
6532 \def\activedoublequote{{\tt\char34}}
6533 \let"=\activedoublequote
6535 \def~{{\tt\char126}}
6541 \def_{\ifusingtt\normalunderscore\_}
6542 % Subroutine for the previous macro.
6543 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6546 \def|{{\tt\char124}}
6554 \def+{{\tt \char 43}}
6556 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6558 % Set up an active definition for =, but don't enable it most of the time.
6559 {\catcode`\==\active
6560 \global\def={{\tt \char 61}}}
6565 % If a .fmt file is being used, characters that might appear in a file
6566 % name cannot be active until we have parsed the command line.
6567 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6568 % \otherifyactive is called near the end of this file.
6569 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6573 % \rawbackslashxx outputs one backslash character in current font,
6575 \global\chardef\rawbackslashxx=`\\
6577 % \rawbackslash defines an active \ to do \rawbackslashxx.
6578 % \otherbackslash defines an active \ to be a literal `\' character with
6580 {\catcode`\\=\active
6581 @gdef@rawbackslash{@let\=@rawbackslashxx}
6582 @gdef@otherbackslash{@let\=@realbackslash}
6585 % \realbackslash is an actual character `\' with catcode other.
6586 {\catcode`\\=\other @gdef@realbackslash{\}}
6588 % \normalbackslash outputs one backslash in fixed width font.
6589 \def\normalbackslash{{\tt\rawbackslashxx}}
6593 % Used sometimes to turn off (effectively) the active characters
6594 % even after parsing them.
6595 @def@turnoffactive{%
6596 @let"=@normaldoublequote
6597 @let\=@realbackslash
6600 @let_=@normalunderscore
6601 @let|=@normalverticalbar
6603 @let>=@normalgreater
6605 @let$=@normaldollar %$ font-lock fix
6608 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6609 % the literal character `\'. (Thus, \ is not expandable when this is in
6612 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6614 % Make _ and + \other characters, temporarily.
6615 % This is canceled by @fixbackslash.
6618 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6619 % That is what \eatinput is for; after that, the `\' should revert to printing
6622 @gdef@eatinput input texinfo{@fixbackslash}
6623 @global@let\ = @eatinput
6625 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6626 % the first `\{ in the file would cause an error. This macro tries to fix
6627 % that, assuming it is called before the first `\' could plausibly occur.
6628 % Also back turn on active characters that might appear in the input
6629 % file name, in case not using a pre-dumped format.
6631 @gdef@fixbackslash{%
6632 @ifx\@eatinput @let\ = @normalbackslash @fi
6637 % Say @foo, not \foo, in error messages.
6640 % These look ok in all fonts, so just make them not special.
6641 @catcode`@& = @other
6642 @catcode`@# = @other
6643 @catcode`@% = @other
6645 @c Set initial fonts.
6651 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6652 @c page-delimiter: "^\\\\message"
6653 @c time-stamp-start: "def\\\\texinfoversion{"
6654 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6655 @c time-stamp-end: "}"