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{2004-11-25.16}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 3, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file. If not, see
24 % <http://www.gnu.org/licenses/>.
26 % As a special exception, when this file is read by TeX when processing
27 % a Texinfo source document, you may use the result without
28 % restriction. (This has been our intent since Texinfo was invented.)
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
33 % ftp://tug.org/tex/texinfo.tex
34 % (and all CTAN mirrors, see http://www.ctan.org).
35 % The texinfo.tex in any given distribution could well be out
36 % of date, so if that's what you're using, please check.
38 % Send bug reports to bug-texinfo@gnu.org. Please include including a
39 % complete document in each bug report with which we can reproduce the
40 % problem. Patches are, of course, greatly appreciated.
42 % To process a Texinfo manual with TeX, it's most reliable to use the
43 % texi2dvi shell script that comes with the distribution. For a simple
44 % manual foo.texi, however, you can get away with this:
49 % dvips foo.dvi -o # or whatever; this makes foo.ps.
50 % The extra TeX runs get the cross-reference information correct.
51 % Sometimes one run after texindex suffices, and sometimes you need more
52 % than two; texi2dvi does it as many times as necessary.
54 % It is possible to adapt texinfo.tex for other languages, to some
55 % extent. You can get the existing language-specific files from the
56 % full Texinfo distribution.
58 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
61 \message{Loading texinfo [version \texinfoversion]:}
63 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active}
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
76 % Save some plain tex macros whose names we will redefine.
78 \let\ptexbullet=\bullet
86 \let\ptexfootnote=\footnote
90 \let\ptexindent=\indent
91 \let\ptexinsert=\insert
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=\noindent
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % In some macros, we cannot use the `\? notation---the left quote is
156 % in some cases the escape char.
157 \chardef\colonChar = `\:
158 \chardef\commaChar = `\,
159 \chardef\dotChar = `\.
160 \chardef\exclamChar= `\!
161 \chardef\questChar = `\?
162 \chardef\semiChar = `\;
163 \chardef\underChar = `\_
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
179 ap-pen-dix bit-map bit-maps
180 data-base data-bases eshell fall-ing half-way long-est man-u-script
181 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
182 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
184 stand-alone strong-est time-stamp time-stamps which-ever white-space
185 wide-spread wrap-around
188 % Margin to add to right of even pages, to left of odd pages.
189 \newdimen\bindingoffset
190 \newdimen\normaloffset
191 \newdimen\pagewidth \newdimen\pageheight
193 % For a final copy, take out the rectangles
194 % that mark overfull boxes (in case you have decided
195 % that the text looks ok even though it passes the margin).
197 \def\finalout{\overfullrule=0pt}
199 % @| inserts a changebar to the left of the current line. It should
200 % surround any changed text. This approach does *not* work if the
201 % change spans more than two lines of output. To handle that, we would
202 % have adopt a much more difficult approach (putting marks into the main
203 % vertical list for the beginning and end of each change).
206 % \vadjust can only be used in horizontal mode.
209 % Append this vertical mode material after the current line in the output.
211 % We want to insert a rule with the height and depth of the current
212 % leading; that is exactly what \strutbox is supposed to record.
215 % \vadjust-items are inserted at the left edge of the type. So
216 % the \llap here moves out into the left-hand margin.
219 % For a thicker or thinner bar, change the `1pt'.
220 \vrule height\baselineskip width1pt
222 % This is the space between the bar and the text.
228 % Sometimes it is convenient to have everything in the transcript file
229 % and nothing on the terminal. We don't just call \tracingall here,
230 % since that produces some useless output on the terminal. We also make
231 % some effort to order the tracing commands to reduce output in the log
232 % file; cf. trace.sty in LaTeX.
234 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
238 \tracinglostchars2 % 2 gives us more in etex
243 \showboxbreadth\maxdimen \showboxdepth\maxdimen
244 \ifx\eTeXversion\undefined\else % etex gives us more logging
251 \tracingcommands3 % 3 gives us more in etex
255 % add check for \lastpenalty to plain's definitions. If the last thing
256 % we did was a \nobreak, we don't want to insert more space.
258 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
259 \removelastskip\penalty-50\smallskip\fi\fi}
260 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
261 \removelastskip\penalty-100\medskip\fi\fi}
262 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
263 \removelastskip\penalty-200\bigskip\fi\fi}
265 % For @cropmarks command.
266 % Do @cropmarks to get crop marks.
269 \let\cropmarks = \cropmarkstrue
271 % Dimensions to add cropmarks at corners.
272 % Added by P. A. MacKay, 12 Nov. 1986
274 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
275 \newdimen\cornerlong \cornerlong=1pc
276 \newdimen\cornerthick \cornerthick=.3pt
277 \newdimen\topandbottommargin \topandbottommargin=.75in
279 % Main output routine.
281 \output = {\onepageout{\pagecontents\PAGE}}
286 % \onepageout takes a vbox as an argument. Note that \pagecontents
287 % does insertions, but you have to call it yourself.
289 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
291 \ifodd\pageno \advance\hoffset by \bindingoffset
292 \else \advance\hoffset by -\bindingoffset\fi
294 % Do this outside of the \shipout so @code etc. will be expanded in
295 % the headline as they should be, not taken literally (outputting ''code).
296 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
297 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
300 % Have to do this stuff outside the \shipout because we want it to
301 % take effect in \write's, yet the group defined by the \vbox ends
302 % before the \shipout runs.
304 \escapechar = `\\ % use backslash in output files.
305 \indexdummies % don't expand commands in the output.
306 \normalturnoffactive % \ in index entries must not stay \, e.g., if
307 % the page break happens to be in the middle of an example.
309 % Do this early so pdf references go to the beginning of the page.
310 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
312 \ifcropmarks \vbox to \outervsize\bgroup
314 \vskip-\topandbottommargin
316 \line{\ewtop\hfil\ewtop}%
319 \vbox{\moveleft\cornerthick\nstop}%
321 \vbox{\moveright\cornerthick\nstop}%
324 \vskip\topandbottommargin
326 \hfil % center the page within the outer (page) hsize.
327 \ifodd\pageno\hskip\bindingoffset\fi
333 \ifdim\ht\footlinebox > 0pt
334 % Only leave this space if the footline is nonempty.
335 % (We lessened \vsize for it in \oddfootingxxx.)
336 % The \baselineskip=24pt in plain's \makefootline has no effect.
337 \vskip 2\baselineskip
342 \egroup % end of \vbox\bgroup
343 \hfil\egroup % end of (centering) \line\bgroup
344 \vskip\topandbottommargin plus1fill minus1fill
345 \boxmaxdepth = \cornerthick
348 \vbox{\moveleft\cornerthick\nsbot}%
350 \vbox{\moveright\cornerthick\nsbot}%
353 \line{\ewbot\hfil\ewbot}%
355 \egroup % \vbox from first cropmarks clause
357 }% end of \shipout\vbox
358 }% end of group with \normalturnoffactive
360 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
363 \newinsert\margin \dimen\margin=\maxdimen
365 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
367 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
368 % marginal hacks, juha@viisa.uucp (Juha Takala)
369 \ifvoid\margin\else % marginal info is present
370 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
371 \dimen@=\dp#1 \unvbox#1
372 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
373 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
376 % Here are the rules for the cropmarks. Note that they are
377 % offset so that the space between them is truly \outerhsize or \outervsize
378 % (P. A. MacKay, 12 November, 1986)
380 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
382 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
383 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
385 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
387 % Parse an argument, then pass it to #1. The argument is the rest of
388 % the input line (except we remove a trailing comment). #1 should be a
389 % macro which expects an ordinary undelimited TeX argument.
391 \def\parsearg{\parseargusing{}}
392 \def\parseargusing#1#2{%
398 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
402 \gdef\parseargline#1^^M{%
403 \endgroup % End of the group started in \parsearg.
404 \argremovecomment #1\comment\ArgTerm%
408 % First remove any @comment, then any @c comment.
409 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
410 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
412 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
414 % \argremovec might leave us with trailing space, e.g.,
415 % @end itemize @c foo
416 % This space token undergoes the same procedure and is eventually removed
417 % by \finishparsearg.
419 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
420 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
421 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
424 % We cannot use \next here, as it holds the macro to run;
425 % thus we reuse \temp.
426 \let\temp\finishparsearg
428 \let\temp\argcheckspaces
430 % Put the space token in:
434 % If a _delimited_ argument is enclosed in braces, they get stripped; so
435 % to get _exactly_ the rest of the line, we had to prevent such situation.
436 % We prepended an \empty token at the very beginning and we expand it now,
437 % just before passing the control to \next.
438 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
439 % either the null string, or it ends with \^^M---thus there is no danger
440 % that a pair of braces would be stripped.
442 % But first, we have to remove the trailing space token.
444 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
446 % \parseargdef\foo{...}
447 % is roughly equivalent to
448 % \def\foo{\parsearg\Xfoo}
451 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
452 % favourite TeX trick. --kasal, 16nov03
455 \expandafter \doparseargdef \csname\string#1\endcsname #1%
457 \def\doparseargdef#1#2{%
462 % Several utility definitions with active space:
467 % Make each space character in the input produce a normal interword
468 % space in the output. Don't allow a line break at this space, as this
469 % is used only in environments like @example, where each line of input
470 % should produce a line of output anyway.
472 \gdef\sepspaces{\obeyspaces\let =\tie}
474 % If an index command is used in an @example environment, any spaces
475 % therein should become regular spaces in the raw index file, not the
476 % expansion of \tie (\leavevmode \penalty \@M \ ).
477 \gdef\unsepspaces{\let =\space}
481 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
483 % Define the framework for environments in texinfo.tex. It's used like this:
488 % It's the responsibility of \envdef to insert \begingroup before the
489 % actual body; @end closes the group after calling \Efoo. \envdef also
490 % defines \thisenv, so the current environment is known; @end checks
491 % whether the environment name matches. The \checkenv macro can also be
492 % used to check whether the current environment is the one expected.
494 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
495 % are not treated as enviroments; they don't open a group. (The
496 % implementation of @end takes care not to call \endgroup in this
500 % At runtime, environments start with this:
501 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
505 % ... but they get defined via ``\envdef\foo{...}'':
506 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
507 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
509 % Check whether we're in the right environment:
518 % Evironment mismatch, #1 expected:
521 \errmessage{This command can appear only \inenvironment\temp,
522 not \inenvironment\thisenv}%
524 \def\inenvironment#1{%
526 out of any environment%
528 in environment \expandafter\string#1%
532 % @end foo executes the definition of \Efoo.
533 % But first, it executes a specialized version of \checkenv
536 \if 1\csname iscond.#1\endcsname
538 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
539 \expandafter\checkenv\csname#1\endcsname
540 \csname E#1\endcsname
545 \newhelp\EMsimple{Press RETURN to continue.}
548 %% Simple single-character @ commands
551 % Kludge this until the fonts are right (grr).
554 % This is turned off because it was never documented
555 % and you can use @w{...} around a quote to suppress ligatures.
556 %% Define @` and @' to be the same as ` and '
557 %% but suppressing ligatures.
561 % Used to generate quoted braces.
562 \def\mylbrace {{\tt\char123}}
563 \def\myrbrace {{\tt\char125}}
567 % Definitions to produce \{ and \} commands for indices,
568 % and @{ and @} for the aux file.
569 \catcode`\{ = \other \catcode`\} = \other
570 \catcode`\[ = 1 \catcode`\] = 2
571 \catcode`\! = 0 \catcode`\\ = \other
574 !gdef!lbraceatcmd[@{]%
575 !gdef!rbraceatcmd[@}]%
578 % @comma{} to avoid , parsing problems.
581 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
582 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
585 \def\ringaccent#1{{\accent23 #1}}
590 % Other special characters: @questiondown @exclamdown @ordf @ordm
591 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
592 \def\questiondown{?`}
594 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
595 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
597 % Dotless i and dotless j, used for accents.
602 \ifx\temp\imacro \ptexi
603 \else\ifx\temp\jmacro \j
604 \else \errmessage{@dotless can be used only with i or j}%
608 % The \TeX{} logo, as in plain, but resetting the spacing so that a
609 % period following counts as ending a sentence. (Idea found in latex.)
611 \edef\TeX{\TeX \spacefactor=1000 }
613 % @LaTeX{} logo. Not quite the same results as the definition in
614 % latex.ltx, since we use a different font for the raised A; it's most
615 % convenient for us to use an explicitly smaller font, rather than using
616 % the \scriptstyle font (since we don't reset \scriptstyle and
617 % \scriptscriptstyle).
622 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
627 % Be sure we're in horizontal mode when doing a tie, since we make space
628 % equivalent to this in @example-like environments. Otherwise, a space
629 % at the beginning of a line will start with \penalty -- and
630 % since \penalty is valid in vertical mode, we'd end up putting the
631 % penalty on the vertical list instead of in the new paragraph.
633 % Avoid using \@M directly, because that causes trouble
634 % if the definition is written into an index file.
635 \global\let\tiepenalty = \@M
636 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
639 % @: forces normal size whitespace following.
640 \def\:{\spacefactor=1000 }
642 % @* forces a line break.
643 \def\*{\hfil\break\hbox{}\ignorespaces}
645 % @/ allows a line break.
648 % @. is an end-of-sentence period.
649 \def\.{.\spacefactor=3000 }
651 % @! is an end-of-sentence bang.
652 \def\!{!\spacefactor=3000 }
654 % @? is an end-of-sentence query.
655 \def\?{?\spacefactor=3000 }
657 % @w prevents a word break. Without the \leavevmode, @w at the
658 % beginning of a paragraph, when TeX is still in vertical mode, would
659 % produce a whole line of output instead of starting the paragraph.
660 \def\w#1{\leavevmode\hbox{#1}}
662 % @group ... @end group forces ... to be all on one page, by enclosing
663 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
664 % to keep its height that of a normal line. According to the rules for
665 % \topskip (p.114 of the TeXbook), the glue inserted is
666 % max (\topskip - \ht (first item), 0). If that height is large,
667 % therefore, no glue is inserted, and the space between the headline and
668 % the text is small, which looks bad.
670 % Another complication is that the group might be very large. This can
671 % cause the glue on the previous page to be unduly stretched, because it
672 % does not have much material. In this case, it's better to add an
673 % explicit \vfill so that the extra space is at the bottom. The
674 % threshold for doing this is if the group is more than \vfilllimit
675 % percent of a page (\vfilllimit can be changed inside of @tex).
681 \ifnum\catcode`\^^M=\active \else
682 \errhelp = \groupinvalidhelp
683 \errmessage{@group invalid in context where filling is enabled}%
687 \setbox\groupbox = \vtop\bgroup
688 % Do @comment since we are called inside an environment such as
689 % @example, where each end-of-line in the input causes an
690 % end-of-line in the output. We don't want the end-of-line after
691 % the `@group' to put extra space in the output. Since @group
692 % should appear on a line by itself (according to the Texinfo
693 % manual), we don't worry about eating any user text.
697 % The \vtop produces a box with normal height and large depth; thus, TeX puts
698 % \baselineskip glue before it, and (when the next line of text is done)
699 % \lineskip glue after it. Thus, space below is not quite equal to space
700 % above. But it's pretty close.
702 % To get correct interline space between the last line of the group
703 % and the first line afterwards, we have to propagate \prevdepth.
704 \endgraf % Not \par, as it may have been set to \lisppar.
705 \global\dimen1 = \prevdepth
706 \egroup % End the \vtop.
707 % \dimen0 is the vertical size of the group's box.
708 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
709 % \dimen2 is how much space is left on the page (more or less).
710 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
711 % if the group doesn't fit on the current page, and it's a big big
712 % group, force a page break.
713 \ifdim \dimen0 > \dimen2
714 \ifdim \pagetotal < \vfilllimit\pageheight
723 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
724 % message, so this ends up printing `@group can only ...'.
726 \newhelp\groupinvalidhelp{%
727 group can only be used in environments such as @example,^^J%
728 where each line of input produces a line of output.}
730 % @need space-in-mils
731 % forces a page break if there is not space-in-mils remaining.
733 \newdimen\mil \mil=0.001in
735 % Old definition--didn't work.
736 %\parseargdef\need{\par %
737 %% This method tries to make TeX break the page naturally
738 %% if the depth of the box does not fit.
740 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
745 % Ensure vertical mode, so we don't make a big box in the middle of a
749 % If the @need value is less than one line space, it's useless.
751 \dimen2 = \ht\strutbox
752 \advance\dimen2 by \dp\strutbox
753 \ifdim\dimen0 > \dimen2
755 % Do a \strut just to make the height of this box be normal, so the
756 % normal leading is inserted relative to the preceding line.
757 % And a page break here is fine.
758 \vtop to #1\mil{\strut\vfil}%
760 % TeX does not even consider page breaks if a penalty added to the
761 % main vertical list is 10000 or more. But in order to see if the
762 % empty box we just added fits on the page, we must make it consider
763 % page breaks. On the other hand, we don't want to actually break the
764 % page after the empty box. So we use a penalty of 9999.
766 % There is an extremely small chance that TeX will actually break the
767 % page at this \penalty, if there are no other feasible breakpoints in
768 % sight. (If the user is using lots of big @group commands, which
769 % almost-but-not-quite fill up a page, TeX will have a hard time doing
770 % good page breaking, for example.) However, I could not construct an
771 % example where a page broke at this \penalty; if it happens in a real
772 % document, then we can reconsider our strategy.
775 % Back up by the size of the box, whether we did a page break or not.
778 % Do not allow a page break right after this kern.
783 % @br forces paragraph break (and is undocumented).
787 % @page forces the start of a new page.
789 \def\page{\par\vfill\supereject}
792 % outputs text on separate line in roman font, starting at standard page margin
794 % This records the amount of indent in the innermost environment.
795 % That's how much \exdent should take out.
796 \newskip\exdentamount
798 % This defn is used inside fill environments such as @defun.
799 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
801 % This defn is used inside nofill environments such as @example.
802 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
803 \leftline{\hskip\leftskip{\rm#1}}}}
805 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
806 % paragraph. For more general purposes, use the \margin insertion
807 % class. WHICH is `l' or `r'.
809 \newskip\inmarginspacing \inmarginspacing=1cm
810 \def\strutdepth{\dp\strutbox}
812 \def\doinmargin#1#2{\strut\vadjust{%
815 \vtop to \strutdepth{%
816 \baselineskip=\strutdepth
818 % if you have multiple lines of stuff to put here, you'll need to
819 % make the vbox yourself of the appropriate size.
821 \llap{\ignorespaces #2\hskip\inmarginspacing}%
823 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
828 \def\inleftmargin{\doinmargin l}
829 \def\inrightmargin{\doinmargin r}
831 % @inmargin{TEXT [, RIGHT-TEXT]}
832 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
833 % else use TEXT for both).
835 \def\inmargin#1{\parseinmargin #1,,\finish}
836 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
837 \setbox0 = \hbox{\ignorespaces #2}%
839 \def\lefttext{#1}% have both texts
842 \def\lefttext{#1}% have only one text
847 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
849 \def\temp{\inleftmargin\lefttext}%
854 % @include file insert text of that file as input.
856 \def\include{\parseargusing\filenamecatcodes\includezzz}
862 \def\temp{\input #1 }%
867 \def\filenamecatcodes{%
879 \def\pushthisfilestack{%
880 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
882 \def\pushthisfilestackX{%
883 \expandafter\pushthisfilestackY\thisfile\StackTerm
885 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
886 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
889 \def\popthisfilestack{\errthisfilestackempty}
890 \def\errthisfilestackempty{\errmessage{Internal error:
891 the stack of filenames is empty.}}
896 % outputs that line, centered.
898 \parseargdef\center{%
904 \next{\hfil \ignorespaces#1\unskip \hfil}%
909 \advance\hsize by -\leftskip
910 \advance\hsize by -\rightskip
915 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
917 % @sp n outputs n lines of vertical space
919 \parseargdef\sp{\vskip #1\baselineskip}
921 % @comment ...line which is ignored...
922 % @c is the same as @comment
923 % @ignore ... @end ignore is another way to write a comment
925 \def\comment{\begingroup \catcode`\^^M=\other%
926 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
928 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
932 % @paragraphindent NCHARS
933 % We'll use ems for NCHARS, close enough.
934 % NCHARS can also be the word `asis' or `none'.
935 % We cannot feasibly implement @paragraphindent asis, though.
937 \def\asisword{asis} % no translation, these are keywords
940 \parseargdef\paragraphindent{%
945 \defaultparindent = 0pt
947 \defaultparindent = #1em
950 \parindent = \defaultparindent
953 % @exampleindent NCHARS
954 % We'll use ems for NCHARS like @paragraphindent.
955 % It seems @exampleindent asis isn't necessary, but
956 % I preserve it to make it similar to @paragraphindent.
957 \parseargdef\exampleindent{%
964 \lispnarrowing = #1em
969 % @firstparagraphindent WORD
970 % If WORD is `none', then suppress indentation of the first paragraph
971 % after a section heading. If WORD is `insert', then do indent at such
974 % The paragraph indentation is suppressed or not by calling
975 % \suppressfirstparagraphindent, which the sectioning commands do.
976 % We switch the definition of this back and forth according to WORD.
977 % By default, we suppress indentation.
979 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
980 \def\insertword{insert}
982 \parseargdef\firstparagraphindent{%
985 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
986 \else\ifx\temp\insertword
987 \let\suppressfirstparagraphindent = \relax
990 \errmessage{Unknown @firstparagraphindent option `\temp'}%
994 % Here is how we actually suppress indentation. Redefine \everypar to
995 % \kern backwards by \parindent, and then reset itself to empty.
997 % We also make \indent itself not actually do anything until the next
1000 \gdef\dosuppressfirstparagraphindent{%
1002 \restorefirstparagraphindent
1006 \restorefirstparagraphindent
1009 \global\everypar = {%
1011 \restorefirstparagraphindent
1015 \gdef\restorefirstparagraphindent{%
1016 \global \let \indent = \ptexindent
1017 \global \let \noindent = \ptexnoindent
1018 \global \everypar = {}%
1022 % @asis just yields its argument. Used with @table, for example.
1026 % @math outputs its argument in math mode.
1028 % One complication: _ usually means subscripts, but it could also mean
1029 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1030 % _ active, and distinguish by seeing if the current family is \slfam,
1031 % which is what @var uses.
1033 \catcode\underChar = \active
1034 \gdef\mathunderscore{%
1035 \catcode\underChar=\active
1036 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1039 % Another complication: we want \\ (and @\) to output a \ character.
1040 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1041 % this is not advertised and we don't care. Texinfo does not
1042 % otherwise define @\.
1044 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1045 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1050 \let\\ = \mathbackslash
1054 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1056 % Some active characters (such as <) are spaced differently in math.
1057 % We have to reset their definitions in case the @math was an argument
1058 % to a command which sets the catcodes (such as @item or @section).
1061 \catcode`^ = \active
1062 \catcode`< = \active
1063 \catcode`> = \active
1064 \catcode`+ = \active
1073 % @bullet and @minus need the same treatment as @math, just above.
1074 \def\bullet{$\ptexbullet$}
1077 % @dots{} outputs an ellipsis using the current font.
1078 % We do .5em per period so that it has the same spacing in a typewriter
1079 % font as three actual period characters.
1084 \hskip 0pt plus 0.25fil
1086 \hskip 0pt plus 0.5fil
1090 % @enddots{} is an end-of-sentence ellipsis.
1097 % @comma{} is so commas can be inserted into text without messing up
1098 % Texinfo's parsing.
1102 % @refill is a no-op.
1105 % If working on a large document in chapters, it is convenient to
1106 % be able to disable indexing, cross-referencing, and contents, for test runs.
1107 % This is done with @novalidate (before @setfilename).
1109 \newif\iflinks \linkstrue % by default we want the aux files.
1110 \let\novalidate = \linksfalse
1112 % @setfilename is done at the beginning of every texinfo file.
1113 % So open here the files we need to have open while reading the input.
1114 % This makes it possible to make a .fmt file for texinfo.
1116 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1119 % Open the new aux file. TeX will close it automatically at exit.
1120 \immediate\openout\auxfile=\jobname.aux
1121 \fi % \openindices needs to do some work in any case.
1123 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1125 % If texinfo.cnf is present on the system, read it.
1126 % Useful for site-wide @afourpaper, etc.
1127 \openin 1 texinfo.cnf
1128 \ifeof 1 \else \input texinfo.cnf \fi
1131 \comment % Ignore the actual filename.
1134 % Called from \setfilename.
1146 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1150 % adobe `portable' document format
1154 \newcount\filenamelength
1163 \newif\ifpdfmakepagedest
1165 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1166 % can be set). So we test for \relax and 0 as well as \undefined,
1167 % borrowed from ifpdf.sty.
1168 \ifx\pdfoutput\undefined
1170 \ifx\pdfoutput\relax
1181 \pdfcatalog{/PageMode /UseOutlines}%
1182 \def\dopdfimage#1#2#3{%
1183 \def\imagewidth{#2}%
1184 \def\imageheight{#3}%
1185 % without \immediate, pdftex seg faults when the same image is
1186 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1187 \ifnum\pdftexversion < 14
1190 \immediate\pdfximage
1192 \ifx\empty\imagewidth\else width \imagewidth \fi
1193 \ifx\empty\imageheight\else height \imageheight \fi
1194 \ifnum\pdftexversion<13
1199 \ifnum\pdftexversion < 14 \else
1200 \pdfrefximage \pdflastximage
1203 % We have to set dummies so commands such as @code in a section title
1206 \normalturnoffactive
1207 \pdfdest name{#1} xyz%
1210 \let\linkcolor = \Blue % was Cyan, but that seems light?
1211 \def\endlink{\Black\pdfendlink}
1212 % Adding outlines to PDF; macros for calculating structure of outlines
1213 % come from Petr Olsak
1214 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1215 \else \csname#1\endcsname \fi}
1216 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1217 \advance\tempnum by 1
1218 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1220 % #1 is the section text. #2 is the pdf expression for the number
1221 % of subentries (or empty, for subsubsections). #3 is the node
1222 % text, which might be empty if this toc entry had no
1223 % corresponding node. #4 is the page number.
1225 \def\dopdfoutline#1#2#3#4{%
1226 % Generate a link to the node text if that exists; else, use the
1227 % page number. We could generate a destination for the section
1228 % text in the case where a section has no node, but it doesn't
1229 % seem worthwhile, since most documents are normally structured.
1230 \def\pdfoutlinedest{#3}%
1231 \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1233 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1236 \def\pdfmakeoutlines{%
1238 % Thanh's hack / proper braces in bookmarks
1239 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1240 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1242 % Read toc silently, to get counts of subentries for \pdfoutline.
1243 \def\numchapentry##1##2##3##4{%
1244 \def\thischapnum{##2}%
1246 \def\thissubsecnum{0}%
1248 \def\numsecentry##1##2##3##4{%
1249 \advancenumber{chap\thischapnum}%
1250 \def\thissecnum{##2}%
1251 \def\thissubsecnum{0}%
1253 \def\numsubsecentry##1##2##3##4{%
1254 \advancenumber{sec\thissecnum}%
1255 \def\thissubsecnum{##2}%
1257 \def\numsubsubsecentry##1##2##3##4{%
1258 \advancenumber{subsec\thissubsecnum}%
1260 \def\thischapnum{0}%
1262 \def\thissubsecnum{0}%
1264 % use \def rather than \let here because we redefine \chapentry et
1265 % al. a second time, below.
1266 \def\appentry{\numchapentry}%
1267 \def\appsecentry{\numsecentry}%
1268 \def\appsubsecentry{\numsubsecentry}%
1269 \def\appsubsubsecentry{\numsubsubsecentry}%
1270 \def\unnchapentry{\numchapentry}%
1271 \def\unnsecentry{\numsecentry}%
1272 \def\unnsubsecentry{\numsubsecentry}%
1273 \def\unnsubsubsecentry{\numsubsubsecentry}%
1276 % Read toc second time, this time actually producing the outlines.
1277 % The `-' means take the \expnumber as the absolute number of
1278 % subentries, which we calculated on our first read of the .toc above.
1280 % We use the node names as the destinations.
1281 \def\numchapentry##1##2##3##4{%
1282 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1283 \def\numsecentry##1##2##3##4{%
1284 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1285 \def\numsubsecentry##1##2##3##4{%
1286 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1287 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1288 \dopdfoutline{##1}{}{##3}{##4}}%
1290 % PDF outlines are displayed using system fonts, instead of
1291 % document fonts. Therefore we cannot use special characters,
1292 % since the encoding is unknown. For example, the eogonek from
1293 % Latin 2 (0xea) gets translated to a | character. Info from
1294 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1296 % xx to do this right, we have to translate 8-bit characters to
1297 % their "best" equivalent, based on the @documentencoding. Right
1298 % now, I guess we'll just let the pdf reader have its way.
1305 \def\makelinks #1,{%
1306 \def\params{#1}\def\E{END}%
1308 \let\nextmakelinks=\relax
1310 \let\nextmakelinks=\makelinks
1311 \ifnum\lnkcount>0,\fi
1313 \startlink attr{/Border [0 0 0]}
1314 goto name{\pdfmkpgn{\the\pgn}}%
1316 \advance\lnkcount by 1%
1321 \def\picknum#1{\expandafter\pn#1}
1332 \def\ppn#1{\pgn=#1\gobble}
1333 \def\ppnn{\pgn=\first}
1334 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1335 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1336 \ifx\PP\D\let\nextsp\relax
1337 \else\let\nextsp\skipspaces
1338 \ifx\p\space\else\addtokens{\filename}{\PP}%
1339 \advance\filenamelength by 1
1343 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1344 \ifnum\pdftexversion < 14
1345 \let \startlink \pdfannotlink
1347 \let \startlink \pdfstartlink
1351 \normalturnoffactive\def\@{@}%
1352 \makevalueexpandable
1354 \startlink attr{/Border [0 0 0]}%
1355 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1357 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1358 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1359 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1360 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1362 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1364 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1365 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1366 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1368 \ifnum0=\countA\else\makelink\fi
1369 \ifx\first.\let\next=\done\else
1371 \addtokens{\toksB}{\the\toksD}
1372 \ifx\first,\addtokens{\toksB}{\space}\fi
1374 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1376 \def\makelink{\addtokens{\toksB}%
1377 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1379 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1380 \linkcolor #1\endlink}
1381 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1383 \let\pdfmkdest = \gobble
1384 \let\pdfurl = \gobble
1385 \let\endlink = \relax
1386 \let\linkcolor = \relax
1387 \let\pdfmakeoutlines = \relax
1388 \fi % \ifx\pdfoutput
1393 % Change the current font style to #1, remembering it in \curfontstyle.
1394 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1395 % italics, not bold italics.
1397 \def\setfontstyle#1{%
1398 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1399 \csname ten#1\endcsname % change the current font
1402 % Select #1 fonts with the current style.
1404 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1406 \def\rm{\fam=0 \setfontstyle{rm}}
1407 \def\it{\fam=\itfam \setfontstyle{it}}
1408 \def\sl{\fam=\slfam \setfontstyle{sl}}
1409 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1410 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1412 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1413 % So we set up a \sf.
1415 \def\sf{\fam=\sffam \setfontstyle{sf}}
1416 \let\li = \sf % Sometimes we call it \li, not \sf.
1418 % We don't need math for this font style.
1419 \def\ttsl{\setfontstyle{ttsl}}
1422 \newdimen\textleading \textleading = 13.2pt
1424 % Set the baselineskip to #1, and the lineskip and strut size
1425 % correspondingly. There is no deep meaning behind these magic numbers
1426 % used as factors; they just match (closely enough) what Knuth defined.
1428 \def\lineskipfactor{.08333}
1429 \def\strutheightpercent{.70833}
1430 \def\strutdepthpercent {.29167}
1433 \normalbaselineskip = #1\relax
1434 \normallineskip = \lineskipfactor\normalbaselineskip
1436 \setbox\strutbox =\hbox{%
1437 \vrule width0pt height\strutheightpercent\baselineskip
1438 depth \strutdepthpercent \baselineskip
1442 % Set the font macro #1 to the font named #2, adding on the
1443 % specified font prefix (normally `cm').
1444 % #3 is the font's design size, #4 is a scale factor
1445 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1447 % Use cm as the default font prefix.
1448 % To specify the font prefix, you must define \fontprefix
1449 % before you read in texinfo.tex.
1450 \ifx\fontprefix\undefined
1453 % Support font families that don't use the same naming scheme as CM.
1455 \def\rmbshape{bx} %where the normal face is bold
1460 \def\ttslshape{sltt}
1470 % Text fonts (11.2pt, magstep1).
1471 \def\textnominalsize{11pt}
1472 \edef\mainmagstep{\magstephalf}
1473 \setfont\textrm\rmshape{10}{\mainmagstep}
1474 \setfont\texttt\ttshape{10}{\mainmagstep}
1475 \setfont\textbf\bfshape{10}{\mainmagstep}
1476 \setfont\textit\itshape{10}{\mainmagstep}
1477 \setfont\textsl\slshape{10}{\mainmagstep}
1478 \setfont\textsf\sfshape{10}{\mainmagstep}
1479 \setfont\textsc\scshape{10}{\mainmagstep}
1480 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1481 \font\texti=cmmi10 scaled \mainmagstep
1482 \font\textsy=cmsy10 scaled \mainmagstep
1484 % A few fonts for @defun names and args.
1485 \setfont\defbf\bfshape{10}{\magstep1}
1486 \setfont\deftt\ttshape{10}{\magstep1}
1487 \setfont\defttsl\ttslshape{10}{\magstep1}
1488 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1490 % Fonts for indices, footnotes, small examples (9pt).
1491 \def\smallnominalsize{9pt}
1492 \setfont\smallrm\rmshape{9}{1000}
1493 \setfont\smalltt\ttshape{9}{1000}
1494 \setfont\smallbf\bfshape{10}{900}
1495 \setfont\smallit\itshape{9}{1000}
1496 \setfont\smallsl\slshape{9}{1000}
1497 \setfont\smallsf\sfshape{9}{1000}
1498 \setfont\smallsc\scshape{10}{900}
1499 \setfont\smallttsl\ttslshape{10}{900}
1503 % Fonts for small examples (8pt).
1504 \def\smallernominalsize{8pt}
1505 \setfont\smallerrm\rmshape{8}{1000}
1506 \setfont\smallertt\ttshape{8}{1000}
1507 \setfont\smallerbf\bfshape{10}{800}
1508 \setfont\smallerit\itshape{8}{1000}
1509 \setfont\smallersl\slshape{8}{1000}
1510 \setfont\smallersf\sfshape{8}{1000}
1511 \setfont\smallersc\scshape{10}{800}
1512 \setfont\smallerttsl\ttslshape{10}{800}
1513 \font\smalleri=cmmi8
1514 \font\smallersy=cmsy8
1516 % Fonts for title page (20.4pt):
1517 \def\titlenominalsize{20pt}
1518 \setfont\titlerm\rmbshape{12}{\magstep3}
1519 \setfont\titleit\itbshape{10}{\magstep4}
1520 \setfont\titlesl\slbshape{10}{\magstep4}
1521 \setfont\titlett\ttbshape{12}{\magstep3}
1522 \setfont\titlettsl\ttslshape{10}{\magstep4}
1523 \setfont\titlesf\sfbshape{17}{\magstep1}
1524 \let\titlebf=\titlerm
1525 \setfont\titlesc\scbshape{10}{\magstep4}
1526 \font\titlei=cmmi12 scaled \magstep3
1527 \font\titlesy=cmsy10 scaled \magstep4
1528 \def\authorrm{\secrm}
1529 \def\authortt{\sectt}
1531 % Chapter (and unnumbered) fonts (17.28pt).
1532 \def\chapnominalsize{17pt}
1533 \setfont\chaprm\rmbshape{12}{\magstep2}
1534 \setfont\chapit\itbshape{10}{\magstep3}
1535 \setfont\chapsl\slbshape{10}{\magstep3}
1536 \setfont\chaptt\ttbshape{12}{\magstep2}
1537 \setfont\chapttsl\ttslshape{10}{\magstep3}
1538 \setfont\chapsf\sfbshape{17}{1000}
1540 \setfont\chapsc\scbshape{10}{\magstep3}
1541 \font\chapi=cmmi12 scaled \magstep2
1542 \font\chapsy=cmsy10 scaled \magstep3
1544 % Section fonts (14.4pt).
1545 \def\secnominalsize{14pt}
1546 \setfont\secrm\rmbshape{12}{\magstep1}
1547 \setfont\secit\itbshape{10}{\magstep2}
1548 \setfont\secsl\slbshape{10}{\magstep2}
1549 \setfont\sectt\ttbshape{12}{\magstep1}
1550 \setfont\secttsl\ttslshape{10}{\magstep2}
1551 \setfont\secsf\sfbshape{12}{\magstep1}
1553 \setfont\secsc\scbshape{10}{\magstep2}
1554 \font\seci=cmmi12 scaled \magstep1
1555 \font\secsy=cmsy10 scaled \magstep2
1557 % Subsection fonts (13.15pt).
1558 \def\ssecnominalsize{13pt}
1559 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1560 \setfont\ssecit\itbshape{10}{1315}
1561 \setfont\ssecsl\slbshape{10}{1315}
1562 \setfont\ssectt\ttbshape{12}{\magstephalf}
1563 \setfont\ssecttsl\ttslshape{10}{1315}
1564 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1566 \setfont\ssecsc\scbshape{10}{1315}
1567 \font\sseci=cmmi12 scaled \magstephalf
1568 \font\ssecsy=cmsy10 scaled 1315
1570 % Reduced fonts for @acro in text (10pt).
1571 \def\reducednominalsize{10pt}
1572 \setfont\reducedrm\rmshape{10}{1000}
1573 \setfont\reducedtt\ttshape{10}{1000}
1574 \setfont\reducedbf\bfshape{10}{1000}
1575 \setfont\reducedit\itshape{10}{1000}
1576 \setfont\reducedsl\slshape{10}{1000}
1577 \setfont\reducedsf\sfshape{10}{1000}
1578 \setfont\reducedsc\scshape{10}{1000}
1579 \setfont\reducedttsl\ttslshape{10}{1000}
1580 \font\reducedi=cmmi10
1581 \font\reducedsy=cmsy10
1583 % In order for the font changes to affect most math symbols and letters,
1584 % we have to define the \textfont of the standard families. Since
1585 % texinfo doesn't allow for producing subscripts and superscripts except
1586 % in the main text, we don't bother to reset \scriptfont and
1587 % \scriptscriptfont (which would also require loading a lot more fonts).
1589 \def\resetmathfonts{%
1590 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1591 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1592 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1595 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1596 % of just \STYLE. We do this because \STYLE needs to also set the
1597 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1598 % \tenSTYLE to set the current font.
1600 % Each font-changing command also sets the names \lsize (one size lower)
1601 % and \lllsize (three sizes lower). These relative commands are used in
1602 % the LaTeX logo and acronyms.
1604 % This all needs generalizing, badly.
1607 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1608 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1609 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1610 \let\tenttsl=\textttsl
1611 \def\curfontsize{text}%
1612 \def\lsize{reduced}\def\lllsize{smaller}%
1613 \resetmathfonts \setleading{\textleading}}
1615 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1616 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1617 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1618 \let\tenttsl=\titlettsl
1619 \def\curfontsize{title}%
1620 \def\lsize{chap}\def\lllsize{subsec}%
1621 \resetmathfonts \setleading{25pt}}
1622 \def\titlefont#1{{\titlefonts\rm #1}}
1624 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1625 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1626 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1627 \let\tenttsl=\chapttsl
1628 \def\curfontsize{chap}%
1629 \def\lsize{sec}\def\lllsize{text}%
1630 \resetmathfonts \setleading{19pt}}
1632 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1633 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1634 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1635 \let\tenttsl=\secttsl
1636 \def\curfontsize{sec}%
1637 \def\lsize{subsec}\def\lllsize{reduced}%
1638 \resetmathfonts \setleading{16pt}}
1640 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1641 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1642 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1643 \let\tenttsl=\ssecttsl
1644 \def\curfontsize{ssec}%
1645 \def\lsize{text}\def\lllsize{small}%
1646 \resetmathfonts \setleading{15pt}}
1647 \let\subsubsecfonts = \subsecfonts
1649 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1650 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1651 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1652 \let\tenttsl=\reducedttsl
1653 \def\curfontsize{reduced}%
1654 \def\lsize{small}\def\lllsize{smaller}%
1655 \resetmathfonts \setleading{10.5pt}}
1657 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1658 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1659 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1660 \let\tenttsl=\smallttsl
1661 \def\curfontsize{small}%
1662 \def\lsize{smaller}\def\lllsize{smaller}%
1663 \resetmathfonts \setleading{10.5pt}}
1665 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1666 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1667 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1668 \let\tenttsl=\smallerttsl
1669 \def\curfontsize{smaller}%
1670 \def\lsize{smaller}\def\lllsize{smaller}%
1671 \resetmathfonts \setleading{9.5pt}}
1673 % Set the fonts to use with the @small... environments.
1674 \let\smallexamplefonts = \smallfonts
1676 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1677 % can fit this many characters:
1678 % 8.5x11=86 smallbook=72 a4=90 a5=69
1679 % If we use \scriptfonts (8pt), then we can fit this many characters:
1680 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1681 % For me, subjectively, the few extra characters that fit aren't worth
1682 % the additional smallness of 8pt. So I'm making the default 9pt.
1684 % By the way, for comparison, here's what fits with @example (10pt):
1685 % 8.5x11=71 smallbook=60 a4=75 a5=58
1687 % I wish the USA used A4 paper.
1691 % Set up the default fonts, so we can use them for creating boxes.
1695 % Define these so they can be easily changed for other fonts.
1696 \def\angleleft{$\langle$}
1697 \def\angleright{$\rangle$}
1699 % Count depth in font-changes, for error checks
1700 \newcount\fontdepth \fontdepth=0
1702 % Fonts for short table of contents.
1703 \setfont\shortcontrm\rmshape{12}{1000}
1704 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1705 \setfont\shortcontsl\slshape{12}{1000}
1706 \setfont\shortconttt\ttshape{12}{1000}
1708 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1709 %% serif) and @ii for TeX italic
1711 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1712 % unless the following character is such as not to need one.
1713 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1714 \ptexslash\fi\fi\fi}
1715 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1716 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1718 % like \smartslanted except unconditionally uses \ttsl.
1719 % @var is set to this for defun arguments.
1720 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1722 % like \smartslanted except unconditionally use \sl. We never want
1723 % ttsl for book titles, do we?
1724 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1727 \let\slanted=\smartslanted
1728 \let\var=\smartslanted
1729 \let\dfn=\smartslanted
1730 \let\emph=\smartitalic
1732 % @b, explicit bold.
1736 % @sansserif, explicit sans.
1737 \def\sansserif#1{{\sf #1}}
1739 % We can't just use \exhyphenpenalty, because that only has effect at
1740 % the end of a paragraph. Restore normal hyphenation at the end of the
1741 % group within which \nohyphenation is presumably called.
1743 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1744 \def\restorehyphenation{\hyphenchar\font = `- }
1746 % Set sfcode to normal for the chars that usually have another value.
1747 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1748 % sometimes \x has an active definition that messes things up.
1751 \def\frenchspacing{%
1752 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1753 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1758 {\tt \rawbackslash \frenchspacing #1}%
1761 \def\samp#1{`\tclose{#1}'\null}
1762 \setfont\keyrm\rmshape{8}{1000}
1764 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1765 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1766 \vbox{\hrule\kern-0.4pt
1767 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1769 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1770 % The old definition, with no lozenge:
1771 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1772 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1774 % @file, @option are the same as @samp.
1778 % @code is a modification of @t,
1779 % which makes spaces the same size as normal in the surrounding text.
1782 % Change normal interword space to be same as for the current font.
1783 \spaceskip = \fontdimen2\font
1785 % Switch to typewriter.
1788 % But `\ ' produces the large typewriter interword space.
1789 \def\ {{\spaceskip = 0pt{} }}%
1791 % Turn off hyphenation.
1801 % We *must* turn on hyphenation at `-' and `_' in @code.
1802 % Otherwise, it is too hard to avoid overfull hboxes
1803 % in the Emacs manual, the Library manual, etc.
1805 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1806 % both hyphenation at - and hyphenation within words.
1807 % We must therefore turn them both off (\tclose does that)
1808 % and arrange explicitly to hyphenate at a dash.
1814 \global\def\code{\begingroup
1815 \catcode`\-=\active \let-\codedash
1816 \catcode`\_=\active \let_\codeunder
1822 \def\codedash{-\discretionary{}{}{}}
1824 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1825 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1826 % will therefore expand the active definition of _, which is us
1827 % (inside @code that is), therefore an endless loop.
1829 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1830 \else\normalunderscore \fi
1831 \discretionary{}{}{}}%
1834 \def\codex #1{\tclose{#1}\endgroup}
1836 % @kbd is like @code, except that if the argument is just one @key command,
1837 % then @kbd has no effect.
1839 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1840 % `example' (@kbd uses ttsl only inside of @example and friends),
1841 % or `code' (@kbd uses normal tty font always).
1842 \parseargdef\kbdinputstyle{%
1844 \ifx\arg\worddistinct
1845 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1846 \else\ifx\arg\wordexample
1847 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1848 \else\ifx\arg\wordcode
1849 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1851 \errhelp = \EMsimple
1852 \errmessage{Unknown @kbdinputstyle option `\arg'}%
1855 \def\worddistinct{distinct}
1856 \def\wordexample{example}
1859 % Default is `distinct.'
1860 \kbdinputstyle distinct
1863 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1864 \ifx\one\xkey\ifx\threex\three \key{#2}%
1865 \else{\tclose{\kbdfont\look}}\fi
1866 \else{\tclose{\kbdfont\look}}\fi}
1868 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1869 \let\indicateurl=\code
1873 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1874 % second argument specifying the text to display and an optional third
1875 % arg as text to display instead of (rather than in addition to) the url
1876 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1877 % a hypertex \special here.
1879 \def\uref#1{\douref #1,,,\finish}
1880 \def\douref#1,#2,#3,#4\finish{\begingroup
1883 \setbox0 = \hbox{\ignorespaces #3}%
1885 \unhbox0 % third arg given, show only that
1887 \setbox0 = \hbox{\ignorespaces #2}%
1890 \unhbox0 % PDF: 2nd arg given, show only it
1892 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1895 \code{#1}% only url given, so show it
1901 % @url synonym for @uref, since that's how everyone uses it.
1905 % rms does not like angle brackets --karl, 17may97.
1906 % So now @email is just like @uref, unless we are pdf.
1908 %\def\email#1{\angleleft{\tt #1}\angleright}
1910 \def\email#1{\doemail#1,,\finish}
1911 \def\doemail#1,#2,#3\finish{\begingroup
1914 \setbox0 = \hbox{\ignorespaces #2}%
1915 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1922 % Check if we are currently using a typewriter font. Since all the
1923 % Computer Modern typewriter fonts have zero interword stretch (and
1924 % shrink), and it is reasonable to expect all typewriter fonts to have
1925 % this property, we can check that font parameter.
1927 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1929 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1930 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1932 \def\dmn#1{\thinspace #1}
1934 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1936 % @l was never documented to mean ``switch to the Lisp font'',
1937 % and it is not used as such in any manual I can find. We need it for
1938 % Polish suppressed-l. --karl, 22sep96.
1939 %\def\l#1{{\li #1}\null}
1941 % Explicit font changes: @r, @sc, undocumented @ii.
1942 \def\r#1{{\rm #1}} % roman font
1943 \def\sc#1{{\smallcaps#1}} % smallcaps font
1944 \def\ii#1{{\it #1}} % italic font
1946 % @acronym for "FBI", "NATO", and the like.
1947 % We print this one point size smaller, since it's intended for
1950 \def\acronym#1{\doacronym #1,,\finish}
1951 \def\doacronym#1,#2,#3\finish{%
1952 {\selectfonts\lsize #1}%
1954 \ifx\temp\empty \else
1955 \space ({\unsepspaces \ignorespaces \temp \unskip})%
1959 % @abbr for "Comput. J." and the like.
1960 % No font change, but don't do end-of-sentence spacing.
1962 \def\abbr#1{\doabbr #1,,\finish}
1963 \def\doabbr#1,#2,#3\finish{%
1964 {\frenchspacing #1}%
1966 \ifx\temp\empty \else
1967 \space ({\unsepspaces \ignorespaces \temp \unskip})%
1971 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
1973 \def\pounds{{\it\$}}
1975 % @euro{} comes from a separate font, depending on the current style.
1976 % We use the free feym* fonts from the eurosym package by Henrik
1977 % Theiling, which support regular, slanted, bold and bold slanted (and
1978 % "outlined" (blackboard board, sort of) versions, which we don't need).
1979 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
1981 % Although only regular is the truly official Euro symbol, we ignore
1982 % that. The Euro is designed to be slightly taller than the regular
1988 % feybo - bold slanted
1990 % There is no good (free) typewriter version, to my knowledge.
1991 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
1994 % Also doesn't work in math. Do we need to do math with euro symbols?
1998 \def\euro{{\eurofont e}}
2000 % We set the font at each command, rather than predefining it in
2001 % \textfonts and the other font-switching commands, so that
2002 % installations which never need the symbold don't have to have the
2005 % There is only one designed size (nominal 10pt), so we always scale
2006 % that to the current nominal size.
2008 % By the way, simply using "at 1em" works for cmr10 and the like, but
2009 % does not work for cmbx10 and other extended/shrunken fonts.
2011 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2013 \ifx\curfontstyle\bfstylename
2015 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2018 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2023 % @registeredsymbol - R in a circle. The font for the R should really
2024 % be smaller yet, but lllsize is the best we can do for now.
2025 % Adapted from the plain.tex definition of \copyright.
2027 \def\registeredsymbol{%
2028 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2033 % Laurent Siebenmann reports \Orb undefined with:
2034 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2035 % so we'll define it if necessary.
2038 \def\Orb{\mathhexbox20D}
2042 \message{page headings,}
2044 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2045 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2047 % First the title page. Must do @settitle before @titlepage.
2049 \newif\iffinishedtitlepage
2051 % Do an implicit @contents or @shortcontents after @end titlepage if the
2052 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2054 \newif\ifsetcontentsaftertitlepage
2055 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2056 \newif\ifsetshortcontentsaftertitlepage
2057 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2059 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2060 \endgroup\page\hbox{}\page}
2063 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2065 \parindent=0pt \textfonts
2066 % Leave some space at the very top of the page.
2067 \vglue\titlepagetopglue
2068 % No rule at page bottom unless we print one at the top with @title.
2069 \finishedtitlepagetrue
2071 % Most title ``pages'' are actually two pages long, with space
2072 % at the top of the second. We don't want the ragged left on the second.
2073 \let\oldpage = \page
2075 \iffinishedtitlepage\else
2078 \let\page = \oldpage
2085 \iffinishedtitlepage\else
2088 % It is important to do the page break before ending the group,
2089 % because the headline and footline are only empty inside the group.
2090 % If we use the new definition of \page, we always get a blank page
2091 % after the title page, which we certainly don't want.
2095 % Need this before the \...aftertitlepage checks so that if they are
2096 % in effect the toc pages will come out with page numbers.
2099 % If they want short, they certainly want long too.
2100 \ifsetshortcontentsaftertitlepage
2103 \global\let\shortcontents = \relax
2104 \global\let\contents = \relax
2107 \ifsetcontentsaftertitlepage
2109 \global\let\contents = \relax
2110 \global\let\shortcontents = \relax
2114 \def\finishtitlepage{%
2115 \vskip4pt \hrule height 2pt width \hsize
2116 \vskip\titlepagebottomglue
2117 \finishedtitlepagetrue
2120 %%% Macros to be used within @titlepage:
2122 \let\subtitlerm=\tenrm
2123 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2125 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2128 \parseargdef\title{%
2130 \leftline{\titlefonts\rm #1}
2131 % print a rule at the page bottom also.
2132 \finishedtitlepagefalse
2133 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2136 \parseargdef\subtitle{%
2138 {\subtitlefont \rightline{#1}}%
2141 % @author should come last, but may come many times.
2142 % It can also be used inside @quotation.
2144 \parseargdef\author{%
2145 \def\temp{\quotation}%
2147 \def\quotationauthor{#1}% printed in \Equotation.
2150 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2151 {\authorfont \leftline{#1}}%
2156 %%% Set up page headings and footings.
2158 \let\thispage=\folio
2160 \newtoks\evenheadline % headline on even pages
2161 \newtoks\oddheadline % headline on odd pages
2162 \newtoks\evenfootline % footline on even pages
2163 \newtoks\oddfootline % footline on odd pages
2165 % Now make TeX use those variables
2166 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2167 \else \the\evenheadline \fi}}
2168 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2169 \else \the\evenfootline \fi}\HEADINGShook}
2170 \let\HEADINGShook=\relax
2172 % Commands to set those variables.
2173 % For example, this is what @headings on does
2174 % @evenheading @thistitle|@thispage|@thischapter
2175 % @oddheading @thischapter|@thispage|@thistitle
2176 % @evenfooting @thisfile||
2177 % @oddfooting ||@thisfile
2180 \def\evenheading{\parsearg\evenheadingxxx}
2181 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2182 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2183 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2185 \def\oddheading{\parsearg\oddheadingxxx}
2186 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2187 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2188 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2190 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2192 \def\evenfooting{\parsearg\evenfootingxxx}
2193 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2194 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2195 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2197 \def\oddfooting{\parsearg\oddfootingxxx}
2198 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2199 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2200 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2202 % Leave some space for the footline. Hopefully ok to assume
2203 % @evenfooting will not be used by itself.
2204 \global\advance\pageheight by -\baselineskip
2205 \global\advance\vsize by -\baselineskip
2208 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2211 % @headings double turns headings on for double-sided printing.
2212 % @headings single turns headings on for single-sided printing.
2213 % @headings off turns them off.
2214 % @headings on same as @headings double, retained for compatibility.
2215 % @headings after turns on double-sided headings after this page.
2216 % @headings doubleafter turns on double-sided headings after this page.
2217 % @headings singleafter turns on single-sided headings after this page.
2218 % By default, they are off at the start of a document,
2219 % and turned `on' after @end titlepage.
2221 \def\headings #1 {\csname HEADINGS#1\endcsname}
2224 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2225 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2227 % When we turn headings on, set the page number to 1.
2228 % For double-sided printing, put current file name in lower left corner,
2229 % chapter name on inside top of right hand pages, document
2230 % title on inside top of left hand pages, and page numbers on outside top
2231 % edge of all pages.
2232 \def\HEADINGSdouble{%
2234 \global\evenfootline={\hfil}
2235 \global\oddfootline={\hfil}
2236 \global\evenheadline={\line{\folio\hfil\thistitle}}
2237 \global\oddheadline={\line{\thischapter\hfil\folio}}
2238 \global\let\contentsalignmacro = \chapoddpage
2240 \let\contentsalignmacro = \chappager
2242 % For single-sided printing, chapter title goes across top left of page,
2243 % page number on top right.
2244 \def\HEADINGSsingle{%
2246 \global\evenfootline={\hfil}
2247 \global\oddfootline={\hfil}
2248 \global\evenheadline={\line{\thischapter\hfil\folio}}
2249 \global\oddheadline={\line{\thischapter\hfil\folio}}
2250 \global\let\contentsalignmacro = \chappager
2252 \def\HEADINGSon{\HEADINGSdouble}
2254 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2255 \let\HEADINGSdoubleafter=\HEADINGSafter
2256 \def\HEADINGSdoublex{%
2257 \global\evenfootline={\hfil}
2258 \global\oddfootline={\hfil}
2259 \global\evenheadline={\line{\folio\hfil\thistitle}}
2260 \global\oddheadline={\line{\thischapter\hfil\folio}}
2261 \global\let\contentsalignmacro = \chapoddpage
2264 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2265 \def\HEADINGSsinglex{%
2266 \global\evenfootline={\hfil}
2267 \global\oddfootline={\hfil}
2268 \global\evenheadline={\line{\thischapter\hfil\folio}}
2269 \global\oddheadline={\line{\thischapter\hfil\folio}}
2270 \global\let\contentsalignmacro = \chappager
2273 % Subroutines used in generating headings
2274 % This produces Day Month Year style of output.
2275 % Only define if not already defined, in case a txi-??.tex file has set
2276 % up a different format (e.g., txi-cs.tex does this).
2277 \ifx\today\undefined
2281 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2282 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2283 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2288 % @settitle line... specifies the title of the document, for headings.
2289 % It generates no output of its own.
2290 \def\thistitle{\putwordNoTitle}
2291 \def\settitle{\parsearg{\gdef\thistitle}}
2295 % Tables -- @table, @ftable, @vtable, @item(x).
2297 % default indentation of table text
2298 \newdimen\tableindent \tableindent=.8in
2299 % default indentation of @itemize and @enumerate text
2300 \newdimen\itemindent \itemindent=.3in
2301 % margin between end of table item and start of table text.
2302 \newdimen\itemmargin \itemmargin=.1in
2304 % used internally for \itemindent minus \itemmargin
2307 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2309 % They also define \itemindex
2310 % to index the item name in whatever manner is desired (perhaps none).
2312 \newif\ifitemxneedsnegativevskip
2314 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2316 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2317 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2319 \def\itemzzz #1{\begingroup %
2320 \advance\hsize by -\rightskip
2321 \advance\hsize by -\tableindent
2322 \setbox0=\hbox{\itemindicate{#1}}%
2324 \nobreak % This prevents a break before @itemx.
2326 % If the item text does not fit in the space we have, put it on a line
2327 % by itself, and do not allow a page break either before or after that
2328 % line. We do not start a paragraph here because then if the next
2329 % command is, e.g., @kindex, the whatsit would get put into the
2330 % horizontal list on a line by itself, resulting in extra blank space.
2331 \ifdim \wd0>\itemmax
2333 % Make this a paragraph so we get the \parskip glue and wrapping,
2334 % but leave it ragged-right.
2336 \advance\leftskip by-\tableindent
2337 \advance\hsize by\tableindent
2338 \advance\rightskip by0pt plus1fil
2339 \leavevmode\unhbox0\par
2342 % We're going to be starting a paragraph, but we don't want the
2343 % \parskip glue -- logically it's part of the @item we just started.
2344 \nobreak \vskip-\parskip
2346 % Stop a page break at the \parskip glue coming up. However, if
2347 % what follows is an environment such as @example, there will be no
2348 % \parskip glue; then the negative vskip we just inserted would
2349 % cause the example and the item to crash together. So we use this
2350 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2351 % \parskip glue after all. Section titles are handled this way also.
2355 \itemxneedsnegativevskipfalse
2357 % The item text fits into the space. Start a paragraph, so that the
2358 % following text (if any) will end up on the same line.
2360 % Do this with kerns and \unhbox so that if there is a footnote in
2361 % the item text, it can migrate to the main vertical list and
2362 % eventually be printed.
2363 \nobreak\kern-\tableindent
2364 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2366 \nobreak\kern\dimen0
2368 \itemxneedsnegativevskiptrue
2372 \def\item{\errmessage{@item while not in a list environment}}
2373 \def\itemx{\errmessage{@itemx while not in a list environment}}
2375 % @table, @ftable, @vtable.
2377 \let\itemindex\gobble
2381 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2382 \tablecheck{ftable}%
2385 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2386 \tablecheck{vtable}%
2389 \ifnum \the\catcode`\^^M=\active
2391 \errmessage{This command won't work in this context; perhaps the problem is
2392 that we are \inenvironment\thisenv}%
2393 \def\next{\doignore{#1}}%
2400 \def\itemindicate{#1}%
2405 \makevalueexpandable
2406 \edef\temp{\noexpand\tablez #1\space\space\space}%
2410 \def\tablez #1 #2 #3 #4\endtablez{%
2412 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2413 \ifnum 0#2>0 \tableindent=#2\mil \fi
2414 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2415 \itemmax=\tableindent
2416 \advance \itemmax by -\itemmargin
2417 \advance \leftskip by \tableindent
2418 \exdentamount=\tableindent
2420 \parskip = \smallskipamount
2421 \ifdim \parskip=0pt \parskip=2pt \fi
2422 \let\item = \internalBitem
2423 \let\itemx = \internalBitemx
2425 \def\Etable{\endgraf\afterenvbreak}
2428 \let\Eitemize\Etable
2429 \let\Eenumerate\Etable
2431 % This is the counter used by @enumerate, which is really @itemize
2435 \envdef\itemize{\parsearg\doitemize}
2439 \itemmax=\itemindent
2440 \advance\itemmax by -\itemmargin
2441 \advance\leftskip by \itemindent
2442 \exdentamount=\itemindent
2444 \parskip=\smallskipamount
2445 \ifdim\parskip=0pt \parskip=2pt \fi
2446 \def\itemcontents{#1}%
2447 % @itemize with no arg is equivalent to @itemize @bullet.
2448 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2449 \let\item=\itemizeitem
2452 % Definition of @item while inside @itemize and @enumerate.
2455 \advance\itemno by 1 % for enumerations
2456 {\let\par=\endgraf \smallbreak}% reasonable place to break
2458 % If the document has an @itemize directly after a section title, a
2459 % \nobreak will be last on the list, and \sectionheading will have
2460 % done a \vskip-\parskip. In that case, we don't want to zero
2461 % parskip, or the item text will crash with the heading. On the
2462 % other hand, when there is normal text preceding the item (as there
2463 % usually is), we do want to zero parskip, or there would be too much
2464 % space. In that case, we won't have a \nobreak before. At least
2465 % that's the theory.
2466 \ifnum\lastpenalty<10000 \parskip=0in \fi
2468 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2469 \vadjust{\penalty 1200}}% not good to break after first line of item.
2473 % \splitoff TOKENS\endmark defines \first to be the first token in
2474 % TOKENS, and \rest to be the remainder.
2476 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2478 % Allow an optional argument of an uppercase letter, lowercase letter,
2479 % or number, to specify the first label in the enumerated list. No
2480 % argument is the same as `1'.
2482 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2483 \def\enumeratey #1 #2\endenumeratey{%
2484 % If we were given no argument, pretend we were given `1'.
2486 \ifx\thearg\empty \def\thearg{1}\fi
2488 % Detect if the argument is a single token. If so, it might be a
2489 % letter. Otherwise, the only valid thing it can be is a number.
2490 % (We will always have one token, because of the test we just made.
2491 % This is a good thing, since \splitoff doesn't work given nothing at
2492 % all -- the first parameter is undelimited.)
2493 \expandafter\splitoff\thearg\endmark
2495 % Only one token in the argument. It could still be anything.
2496 % A ``lowercase letter'' is one whose \lccode is nonzero.
2497 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2498 % not equal to itself.
2499 % Otherwise, we assume it's a number.
2501 % We need the \relax at the end of the \ifnum lines to stop TeX from
2502 % continuing to look for a <number>.
2504 \ifnum\lccode\expandafter`\thearg=0\relax
2505 \numericenumerate % a number (we hope)
2508 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2509 \lowercaseenumerate % lowercase letter
2511 \uppercaseenumerate % uppercase letter
2515 % Multiple tokens in the argument. We hope it's a number.
2520 % An @enumerate whose labels are integers. The starting integer is
2523 \def\numericenumerate{%
2525 \startenumeration{\the\itemno}%
2528 % The starting (lowercase) letter is in \thearg.
2529 \def\lowercaseenumerate{%
2530 \itemno = \expandafter`\thearg
2532 % Be sure we're not beyond the end of the alphabet.
2534 \errmessage{No more lowercase letters in @enumerate; get a bigger
2541 % The starting (uppercase) letter is in \thearg.
2542 \def\uppercaseenumerate{%
2543 \itemno = \expandafter`\thearg
2545 % Be sure we're not beyond the end of the alphabet.
2547 \errmessage{No more uppercase letters in @enumerate; get a bigger
2554 % Call \doitemize, adding a period to the first argument and supplying the
2555 % common last two arguments. Also subtract one from the initial value in
2556 % \itemno, since @item increments \itemno.
2558 \def\startenumeration#1{%
2559 \advance\itemno by -1
2560 \doitemize{#1.}\flushcr
2563 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2566 \def\alphaenumerate{\enumerate{a}}
2567 \def\capsenumerate{\enumerate{A}}
2568 \def\Ealphaenumerate{\Eenumerate}
2569 \def\Ecapsenumerate{\Eenumerate}
2572 % @multitable macros
2573 % Amy Hendrickson, 8/18/94, 3/6/96
2575 % @multitable ... @end multitable will make as many columns as desired.
2576 % Contents of each column will wrap at width given in preamble. Width
2577 % can be specified either with sample text given in a template line,
2578 % or in percent of \hsize, the current width of text on page.
2580 % Table can continue over pages but will only break between lines.
2584 % Either define widths of columns in terms of percent of \hsize:
2585 % @multitable @columnfractions .25 .3 .45
2588 % Numbers following @columnfractions are the percent of the total
2589 % current hsize to be used for each column. You may use as many
2590 % columns as desired.
2593 % Or use a template:
2594 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2596 % using the widest term desired in each column.
2598 % Each new table line starts with @item, each subsequent new column
2599 % starts with @tab. Empty columns may be produced by supplying @tab's
2600 % with nothing between them for as many times as empty columns are needed,
2601 % ie, @tab@tab@tab will produce two empty columns.
2603 % @item, @tab do not need to be on their own lines, but it will not hurt
2606 % Sample multitable:
2608 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2609 % @item first col stuff @tab second col stuff @tab third col
2616 % @item first col stuff @tab second col stuff
2617 % @tab Many paragraphs of text may be used in any column.
2619 % They will wrap at the width determined by the template.
2620 % @item@tab@tab This will be in third column.
2623 % Default dimensions may be reset by user.
2624 % @multitableparskip is vertical space between paragraphs in table.
2625 % @multitableparindent is paragraph indent in table.
2626 % @multitablecolmargin is horizontal space to be left between columns.
2627 % @multitablelinespace is space to leave between table items, baseline
2629 % 0pt means it depends on current normal line spacing.
2631 \newskip\multitableparskip
2632 \newskip\multitableparindent
2633 \newdimen\multitablecolspace
2634 \newskip\multitablelinespace
2635 \multitableparskip=0pt
2636 \multitableparindent=6pt
2637 \multitablecolspace=12pt
2638 \multitablelinespace=0pt
2640 % Macros used to set up halign preamble:
2642 \let\endsetuptable\relax
2643 \def\xendsetuptable{\endsetuptable}
2644 \let\columnfractions\relax
2645 \def\xcolumnfractions{\columnfractions}
2648 % #1 is the @columnfraction, usually a decimal number like .5, but might
2649 % be just 1. We just use it, whatever it is.
2651 \def\pickupwholefraction#1 {%
2652 \global\advance\colcount by 1
2653 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2660 \ifx\firstarg\xendsetuptable
2663 \ifx\firstarg\xcolumnfractions
2664 \global\setpercenttrue
2667 \let\go\pickupwholefraction
2669 \global\advance\colcount by 1
2670 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2671 % separator; typically that is always in the input, anyway.
2672 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2675 \ifx\go\pickupwholefraction
2676 % Put the argument back for the \pickupwholefraction call, so
2677 % we'll always have a period there to be parsed.
2678 \def\go{\pickupwholefraction#1}%
2680 \let\go = \setuptable
2686 % multitable-only commands.
2688 % @headitem starts a heading row, which we typeset in bold.
2689 % Assignments have to be global since we are inside the implicit group
2690 % of an alignment entry. Note that \everycr resets \everytab.
2691 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2693 % A \tab used to include \hskip1sp. But then the space in a template
2694 % line is not enough. That is bad. So let's go back to just `&' until
2695 % we encounter the problem it was intended to solve again.
2696 % --karl, nathan@acm.org, 20apr99.
2697 \def\tab{\checkenv\multitable &\the\everytab}%
2699 % @multitable ... @end multitable definitions:
2701 \newtoks\everytab % insert after every tab.
2703 \envdef\multitable{%
2707 % @item within a multitable starts a normal row.
2708 % We use \def instead of \let so that if one of the multitable entries
2709 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2710 % \endtemplate) expanding \doitemize.
2715 \setmultitablespacing
2716 \parskip=\multitableparskip
2717 \parindent=\multitableparindent
2723 \global\everytab={}%
2724 \global\colcount=0 % Reset the column counter.
2725 % Check for saved footnotes, etc.
2727 % Keeps underfull box messages off when table breaks over pages.
2729 % Maybe so, but it also creates really weird page breaks when the
2730 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2731 % problem manifests itself, so it can be fixed for real --karl.
2735 \parsearg\domultitable
2737 \def\domultitable#1{%
2738 % To parse everything between @multitable and @item:
2739 \setuptable#1 \endsetuptable
2741 % This preamble sets up a generic column definition, which will
2742 % be used as many times as user calls for columns.
2743 % \vtop will set a single line and will also let text wrap and
2744 % continue for many paragraphs if desired.
2746 \global\advance\colcount by 1
2749 % Use the current \colcount to find the correct column width:
2750 \hsize=\expandafter\csname col\the\colcount\endcsname
2752 % In order to keep entries from bumping into each other
2753 % we will add a \leftskip of \multitablecolspace to all columns after
2756 % If a template has been used, we will add \multitablecolspace
2757 % to the width of each template entry.
2759 % If the user has set preamble in terms of percent of \hsize we will
2760 % use that dimension as the width of the column, and the \leftskip
2761 % will keep entries from bumping into each other. Table will start at
2762 % left margin and final column will justify at right margin.
2764 % Make sure we don't inherit \rightskip from the outer environment.
2767 % The first column will be indented with the surrounding text.
2768 \advance\hsize by\leftskip
2771 % If user has not set preamble in terms of percent of \hsize
2772 % we will advance \hsize by \multitablecolspace.
2773 \advance\hsize by \multitablecolspace
2775 % In either case we will make \leftskip=\multitablecolspace:
2776 \leftskip=\multitablecolspace
2778 % Ignoring space at the beginning and end avoids an occasional spurious
2779 % blank line, when TeX decides to break the line at the space before the
2780 % box from the multistrut, so the strut ends up on a line by itself.
2782 % @multitable @columnfractions .11 .89
2784 % @tab Legal holiday which is valid in major parts of the whole country.
2785 % Is automatically provided with highlighting sequences respectively
2786 % marking characters.
2787 \noindent\ignorespaces##\unskip\multistrut
2792 \egroup % end the \halign
2793 \global\setpercentfalse
2796 \def\setmultitablespacing{%
2797 \def\multistrut{\strut}% just use the standard line spacing
2799 % Compute \multitablelinespace (if not defined by user) for use in
2800 % \multitableparskip calculation. We used define \multistrut based on
2801 % this, but (ironically) that caused the spacing to be off.
2802 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2803 \ifdim\multitablelinespace=0pt
2804 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2805 \global\advance\multitablelinespace by-\ht0
2807 %% Test to see if parskip is larger than space between lines of
2808 %% table. If not, do nothing.
2809 %% If so, set to same dimension as multitablelinespace.
2810 \ifdim\multitableparskip>\multitablelinespace
2811 \global\multitableparskip=\multitablelinespace
2812 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2813 %% than skip between lines in the table.
2815 \ifdim\multitableparskip=0pt
2816 \global\multitableparskip=\multitablelinespace
2817 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2818 %% than skip between lines in the table.
2822 \message{conditionals,}
2824 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2825 % @ifnotxml always succeed. They currently do nothing; we don't
2826 % attempt to check whether the conditionals are properly nested. But we
2827 % have to remember that they are conditionals, so that @end doesn't
2828 % attempt to close an environment group.
2831 \expandafter\let\csname #1\endcsname = \relax
2832 \expandafter\let\csname iscond.#1\endcsname = 1
2835 \makecond{ifnotdocbook}
2836 \makecond{ifnothtml}
2837 \makecond{ifnotinfo}
2838 \makecond{ifnotplaintext}
2841 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2843 \def\direntry{\doignore{direntry}}
2844 \def\documentdescription{\doignore{documentdescription}}
2845 \def\docbook{\doignore{docbook}}
2846 \def\html{\doignore{html}}
2847 \def\ifdocbook{\doignore{ifdocbook}}
2848 \def\ifhtml{\doignore{ifhtml}}
2849 \def\ifinfo{\doignore{ifinfo}}
2850 \def\ifnottex{\doignore{ifnottex}}
2851 \def\ifplaintext{\doignore{ifplaintext}}
2852 \def\ifxml{\doignore{ifxml}}
2853 \def\ignore{\doignore{ignore}}
2854 \def\menu{\doignore{menu}}
2855 \def\xml{\doignore{xml}}
2857 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2859 % A count to remember the depth of nesting.
2860 \newcount\doignorecount
2862 \def\doignore#1{\begingroup
2863 % Scan in ``verbatim'' mode:
2864 \catcode`\@ = \other
2865 \catcode`\{ = \other
2866 \catcode`\} = \other
2868 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2871 % Count number of #1's that we've seen.
2874 % Swallow text until we reach the matching `@end #1'.
2878 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2881 \gdef\dodoignore#1{%
2882 % #1 contains the command name as a string, e.g., `ifinfo'.
2884 % Define a command to find the next `@end #1', which must be on a line
2886 \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2887 % And this command to find another #1 command, at the beginning of a
2888 % line. (Otherwise, we would consider a line `@c @ifset', for
2889 % example, to count as an @ifset for nesting.)
2890 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2892 % And now expand that command.
2898 \def\doignoreyyy#1{%
2900 \ifx\temp\empty % Nothing found.
2901 \let\next\doignoretextzzz
2902 \else % Found a nested condition, ...
2903 \advance\doignorecount by 1
2904 \let\next\doignoretextyyy % ..., look for another.
2905 % If we're here, #1 ends with ^^M\ifinfo (for example).
2907 \next #1% the token \_STOP_ is present just after this macro.
2910 % We have to swallow the remaining "\_STOP_".
2912 \def\doignoretextzzz#1{%
2913 \ifnum\doignorecount = 0 % We have just found the outermost @end.
2914 \let\next\enddoignore
2915 \else % Still inside a nested condition.
2916 \advance\doignorecount by -1
2917 \let\next\doignoretext % Look for the next @end.
2922 % Finish off ignored text.
2923 \def\enddoignore{\endgroup\ignorespaces}
2926 % @set VAR sets the variable VAR to an empty value.
2927 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2929 % Since we want to separate VAR from REST-OF-LINE (which might be
2930 % empty), we can't just use \parsearg; we have to insert a space of our
2931 % own to delimit the rest of the line, and then take it out again if we
2933 % We rely on the fact that \parsearg sets \catcode`\ =10.
2935 \parseargdef\set{\setyyy#1 \endsetyyy}
2936 \def\setyyy#1 #2\endsetyyy{%
2938 \makevalueexpandable
2940 \edef\next{\gdef\makecsname{SET#1}}%
2948 % Remove the trailing space \setxxx inserted.
2949 \def\setzzz#1 \endsetzzz{\next{#1}}
2951 % @clear VAR clears (i.e., unsets) the variable VAR.
2953 \parseargdef\clear{%
2955 \makevalueexpandable
2956 \global\expandafter\let\csname SET#1\endcsname=\relax
2960 % @value{foo} gets the text saved in variable foo.
2961 \def\value{\begingroup\makevalueexpandable\valuexxx}
2962 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2964 \catcode`\- = \active \catcode`\_ = \active
2966 \gdef\makevalueexpandable{%
2967 \let\value = \expandablevalue
2968 % We don't want these characters active, ...
2969 \catcode`\-=\other \catcode`\_=\other
2970 % ..., but we might end up with active ones in the argument if
2971 % we're called from @code, as @code{@value{foo-bar_}}, though.
2972 % So \let them to their normal equivalents.
2973 \let-\realdash \let_\normalunderscore
2977 % We have this subroutine so that we can handle at least some @value's
2978 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2979 % The command has to be fully expandable (if the variable is set), since
2980 % the result winds up in the index file. This means that if the
2981 % variable's value contains other Texinfo commands, it's almost certain
2982 % it will fail (although perhaps we could fix that with sufficient work
2983 % to do a one-level expansion on the result, instead of complete).
2985 \def\expandablevalue#1{%
2986 \expandafter\ifx\csname SET#1\endcsname\relax
2987 {[No value for ``#1'']}%
2988 \message{Variable `#1', used in @value, is not set.}%
2990 \csname SET#1\endcsname
2994 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2997 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3000 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3003 \makevalueexpandable
3005 \expandafter\ifx\csname SET#2\endcsname\relax
3006 #1% If not set, redefine \next.
3011 \def\ifsetfail{\doignore{ifset}}
3013 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3014 % defined with @set, or has been undefined with @clear.
3016 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3017 % above code: if the variable is not set, do nothing, if it is set,
3018 % then redefine \next to \ifclearfail.
3021 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3022 \def\ifclearfail{\doignore{ifclear}}
3024 % @dircategory CATEGORY -- specify a category of the dir file
3025 % which this file should belong to. Ignore this in TeX.
3026 \let\dircategory=\comment
3028 % @defininfoenclose.
3029 \let\definfoenclose=\comment
3033 % Index generation facilities
3035 % Define \newwrite to be identical to plain tex's \newwrite
3036 % except not \outer, so it can be used within macros and \if's.
3037 \edef\newwrite{\makecsname{ptexnewwrite}}
3039 % \newindex {foo} defines an index named foo.
3040 % It automatically defines \fooindex such that
3041 % \fooindex ...rest of line... puts an entry in the index foo.
3042 % It also defines \fooindfile to be the number of the output channel for
3043 % the file that accumulates this index. The file's extension is foo.
3044 % The name of an index should be no more than 2 characters long
3045 % for the sake of vms.
3049 \expandafter\newwrite \csname#1indfile\endcsname
3050 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3052 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3053 \noexpand\doindex{#1}}
3056 % @defindex foo == \newindex{foo}
3058 \def\defindex{\parsearg\newindex}
3060 % Define @defcodeindex, like @defindex except put all entries in @code.
3062 \def\defcodeindex{\parsearg\newcodeindex}
3064 \def\newcodeindex#1{%
3066 \expandafter\newwrite \csname#1indfile\endcsname
3067 \openout \csname#1indfile\endcsname \jobname.#1
3069 \expandafter\xdef\csname#1index\endcsname{%
3070 \noexpand\docodeindex{#1}}%
3074 % @synindex foo bar makes index foo feed into index bar.
3075 % Do this instead of @defindex foo if you don't want it as a separate index.
3077 % @syncodeindex foo bar similar, but put all entries made for index foo
3080 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3081 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3083 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3084 % #3 the target index (bar).
3085 \def\dosynindex#1#2#3{%
3086 % Only do \closeout if we haven't already done it, else we'll end up
3087 % closing the target index.
3088 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3089 % The \closeout helps reduce unnecessary open files; the limit on the
3090 % Acorn RISC OS is a mere 16 files.
3091 \expandafter\closeout\csname#2indfile\endcsname
3092 \expandafter\let\csname\donesynindex#2\endcsname = 1
3094 % redefine \fooindfile:
3095 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3096 \expandafter\let\csname#2indfile\endcsname=\temp
3097 % redefine \fooindex:
3098 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3101 % Define \doindex, the driver for all \fooindex macros.
3102 % Argument #1 is generated by the calling \fooindex macro,
3103 % and it is "foo", the name of the index.
3105 % \doindex just uses \parsearg; it calls \doind for the actual work.
3106 % This is because \doind is more useful to call from other macros.
3108 % There is also \dosubind {index}{topic}{subtopic}
3109 % which makes an entry in a two-level index such as the operation index.
3111 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3112 \def\singleindexer #1{\doind{\indexname}{#1}}
3114 % like the previous two, but they put @code around the argument.
3115 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3116 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3118 % Take care of Texinfo commands that can appear in an index entry.
3119 % Since there are some commands we want to expand, and others we don't,
3120 % we have to laboriously prevent expansion for those that we don't.
3123 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3124 \def\ {\realbackslash\space }%
3125 % Need these in case \tex is in effect and \{ is a \delimiter again.
3126 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3127 % braces and backslashes are used only as delimiters.
3131 % \definedummyword defines \#1 as \realbackslash #1\space, thus
3132 % effectively preventing its expansion. This is used only for control
3133 % words, not control letters, because the \space would be incorrect
3134 % for control characters, but is needed to separate the control word
3135 % from whatever follows.
3137 % For control letters, we have \definedummyletter, which omits the
3140 % These can be used both for control words that take an argument and
3141 % those that do not. If it is followed by {arg} in the input, then
3142 % that will dutifully get written to the index (or wherever).
3144 \def\definedummyword##1{%
3145 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3147 \def\definedummyletter##1{%
3148 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3150 \let\definedummyaccent\definedummyletter
3152 % Do the redefinitions.
3156 % For the aux file, @ is the escape character. So we want to redefine
3157 % everything using @ instead of \realbackslash. When everything uses
3158 % @, this will be simpler.
3163 \let\{ = \lbraceatcmd
3164 \let\} = \rbraceatcmd
3166 % (See comments in \indexdummies.)
3167 \def\definedummyword##1{%
3168 \expandafter\def\csname ##1\endcsname{@##1\space}%
3170 \def\definedummyletter##1{%
3171 \expandafter\def\csname ##1\endcsname{@##1}%
3173 \let\definedummyaccent\definedummyletter
3175 % Do the redefinitions.
3179 % Called from \indexdummies and \atdummies. \definedummyword and
3180 % \definedummyletter must be defined first.
3182 \def\commondummies{%
3184 \normalturnoffactive
3186 \commondummiesnofonts
3188 \definedummyletter{_}%
3190 % Non-English letters.
3191 \definedummyword{AA}%
3192 \definedummyword{AE}%
3193 \definedummyword{L}%
3194 \definedummyword{OE}%
3195 \definedummyword{O}%
3196 \definedummyword{aa}%
3197 \definedummyword{ae}%
3198 \definedummyword{l}%
3199 \definedummyword{oe}%
3200 \definedummyword{o}%
3201 \definedummyword{ss}%
3202 \definedummyword{exclamdown}%
3203 \definedummyword{questiondown}%
3204 \definedummyword{ordf}%
3205 \definedummyword{ordm}%
3207 % Although these internal commands shouldn't show up, sometimes they do.
3208 \definedummyword{bf}%
3209 \definedummyword{gtr}%
3210 \definedummyword{hat}%
3211 \definedummyword{less}%
3212 \definedummyword{sf}%
3213 \definedummyword{sl}%
3214 \definedummyword{tclose}%
3215 \definedummyword{tt}%
3217 \definedummyword{LaTeX}%
3218 \definedummyword{TeX}%
3220 % Assorted special characters.
3221 \definedummyword{bullet}%
3222 \definedummyword{comma}%
3223 \definedummyword{copyright}%
3224 \definedummyword{registeredsymbol}%
3225 \definedummyword{dots}%
3226 \definedummyword{enddots}%
3227 \definedummyword{equiv}%
3228 \definedummyword{error}%
3229 \definedummyword{euro}%
3230 \definedummyword{expansion}%
3231 \definedummyword{minus}%
3232 \definedummyword{pounds}%
3233 \definedummyword{point}%
3234 \definedummyword{print}%
3235 \definedummyword{result}%
3237 % Handle some cases of @value -- where it does not contain any
3238 % (non-fully-expandable) commands.
3239 \makevalueexpandable
3241 % Normal spaces, not active ones.
3244 % No macro expansion.
3248 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3250 % Better have this without active chars.
3253 \gdef\commondummiesnofonts{%
3254 % Control letters and accents.
3255 \definedummyletter{!}%
3256 \definedummyaccent{"}%
3257 \definedummyaccent{'}%
3258 \definedummyletter{*}%
3259 \definedummyaccent{,}%
3260 \definedummyletter{.}%
3261 \definedummyletter{/}%
3262 \definedummyletter{:}%
3263 \definedummyaccent{=}%
3264 \definedummyletter{?}%
3265 \definedummyaccent{^}%
3266 \definedummyaccent{`}%
3267 \definedummyaccent{~}%
3268 \definedummyword{u}%
3269 \definedummyword{v}%
3270 \definedummyword{H}%
3271 \definedummyword{dotaccent}%
3272 \definedummyword{ringaccent}%
3273 \definedummyword{tieaccent}%
3274 \definedummyword{ubaraccent}%
3275 \definedummyword{udotaccent}%
3276 \definedummyword{dotless}%
3278 % Texinfo font commands.
3279 \definedummyword{b}%
3280 \definedummyword{i}%
3281 \definedummyword{r}%
3282 \definedummyword{sc}%
3283 \definedummyword{t}%
3285 % Commands that take arguments.
3286 \definedummyword{acronym}%
3287 \definedummyword{cite}%
3288 \definedummyword{code}%
3289 \definedummyword{command}%
3290 \definedummyword{dfn}%
3291 \definedummyword{emph}%
3292 \definedummyword{env}%
3293 \definedummyword{file}%
3294 \definedummyword{kbd}%
3295 \definedummyword{key}%
3296 \definedummyword{math}%
3297 \definedummyword{option}%
3298 \definedummyword{samp}%
3299 \definedummyword{strong}%
3300 \definedummyword{tie}%
3301 \definedummyword{uref}%
3302 \definedummyword{url}%
3303 \definedummyword{var}%
3304 \definedummyword{verb}%
3305 \definedummyword{w}%
3309 % \indexnofonts is used when outputting the strings to sort the index
3310 % by, and when constructing control sequence names. It eliminates all
3311 % control sequences and just writes whatever the best ASCII sort string
3312 % would be for a given command (usually its argument).
3315 % Accent commands should become @asis.
3316 \def\definedummyaccent##1{%
3317 \expandafter\let\csname ##1\endcsname\asis
3319 % We can just ignore other control letters.
3320 \def\definedummyletter##1{%
3321 \expandafter\def\csname ##1\endcsname{}%
3323 % Hopefully, all control words can become @asis.
3324 \let\definedummyword\definedummyaccent
3326 \commondummiesnofonts
3328 % Don't no-op \tt, since it isn't a user-level command
3329 % and is used in the definitions of the active chars like <, >, |, etc.
3330 % Likewise with the other plain tex font commands.
3335 % how to handle braces?
3336 \def\_{\normalunderscore}%
3338 % Non-English letters.
3351 \def\questiondown{?}%
3358 % Assorted special characters.
3359 % (The following {} will end up in the sort string, but that's ok.)
3360 \def\bullet{bullet}%
3362 \def\copyright{copyright}%
3363 \def\registeredsymbol{R}%
3369 \def\expansion{==>}%
3371 \def\pounds{pounds}%
3376 % Don't write macro names.
3380 \let\indexbackslash=0 %overridden during \printindex.
3381 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3383 % Most index entries go through here, but \dosubind is the general case.
3384 % #1 is the index name, #2 is the entry text.
3385 \def\doind#1#2{\dosubind{#1}{#2}{}}
3387 % Workhorse for all \fooindexes.
3388 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3389 % empty if called from \doind, as we usually are (the main exception
3390 % is with most defuns, which call us directly).
3392 \def\dosubind#1#2#3{%
3395 % Store the main index entry text (including the third arg).
3397 % If third arg is present, precede it with a space.
3399 \ifx\thirdarg\empty \else
3400 \toks0 = \expandafter{\the\toks0 \space #3}%
3403 \edef\writeto{\csname#1indfile\endcsname}%
3414 % Write the entry in \toks0 to the index file:
3416 \def\dosubindwrite{%
3417 % Put the index entry in the margin if desired.
3418 \ifx\SETmarginindex\relax\else
3419 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3422 % Remember, we are within a group.
3423 \indexdummies % Must do this here, since \bf, etc expand at this stage
3425 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3426 % so it will be output as is; and it will print as backslash.
3428 % Process the index entry with all font commands turned off, to
3429 % get the string to sort by.
3431 \edef\temp{\the\toks0}% need full expansion
3432 \xdef\indexsorttmp{\temp}%
3435 % Set up the complete index entry, with both the sort key and
3436 % the original text, including any font commands. We write
3437 % three arguments to \entry to the .?? file (four in the
3438 % subentry case), texindex reduces to two when writing the .??s
3442 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3447 % Take care of unwanted page breaks:
3449 % If a skip is the last thing on the list now, preserve it
3450 % by backing up by \lastskip, doing the \write, then inserting
3451 % the skip again. Otherwise, the whatsit generated by the
3452 % \write will make \lastskip zero. The result is that sequences
3457 % will have extra space inserted, because the \medbreak in the
3458 % start of the @defun won't see the skip inserted by the @end of
3459 % the previous defun.
3461 % But don't do any of this if we're not in vertical mode. We
3462 % don't want to do a \vskip and prematurely end a paragraph.
3464 % Avoid page breaks due to these extra skips, too.
3466 % But wait, there is a catch there:
3467 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3468 % sufficient for this purpose, as it ignores stretch and shrink parts
3469 % of the skip. The only way seems to be to check the textual
3470 % representation of the skip.
3472 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3473 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3475 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3479 \def\dosubindsanitize{%
3480 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3482 \edef\lastskipmacro{\the\lastskip}%
3483 \count255 = \lastpenalty
3485 % If \lastskip is nonzero, that means the last item was a
3486 % skip. And since a skip is discardable, that means this
3487 % -\skip0 glue we're inserting is preceded by a
3488 % non-discardable item, therefore it is not a potential
3489 % breakpoint, therefore no \nobreak needed.
3490 \ifx\lastskipmacro\zeroskipmacro
3497 \ifx\lastskipmacro\zeroskipmacro
3498 % If \lastskip was zero, perhaps the last item was a penalty, and
3499 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3500 % to re-insert the same penalty (values >10000 are used for various
3501 % signals); since we just inserted a non-discardable item, any
3502 % following glue (such as a \parskip) would be a breakpoint. For example:
3504 % @deffn deffn-whatever
3505 % @vindex index-whatever
3507 % would allow a break between the index-whatever whatsit
3508 % and the "Description." paragraph.
3509 \ifnum\count255>9999 \penalty\count255 \fi
3511 % On the other hand, if we had a nonzero \lastskip,
3512 % this make-up glue would be preceded by a non-discardable item
3513 % (the whatsit from the \write), so we must insert a \nobreak.
3514 \nobreak\vskip\skip0
3518 % The index entry written in the file actually looks like
3519 % \entry {sortstring}{page}{topic}
3521 % \entry {sortstring}{page}{topic}{subtopic}
3522 % The texindex program reads in these files and writes files
3523 % containing these kinds of lines:
3525 % before the first topic whose initial is c
3526 % \entry {topic}{pagelist}
3527 % for a topic that is used without subtopics
3529 % for the beginning of a topic that is used with subtopics
3530 % \secondary {subtopic}{pagelist}
3531 % for each subtopic.
3533 % Define the user-accessible indexing commands
3534 % @findex, @vindex, @kindex, @cindex.
3536 \def\findex {\fnindex}
3537 \def\kindex {\kyindex}
3538 \def\cindex {\cpindex}
3539 \def\vindex {\vrindex}
3540 \def\tindex {\tpindex}
3541 \def\pindex {\pgindex}
3543 \def\cindexsub {\begingroup\obeylines\cindexsub}
3545 \gdef\cindexsub "#1" #2^^M{\endgroup %
3546 \dosubind{cp}{#2}{#1}}}
3548 % Define the macros used in formatting output of the sorted index material.
3550 % @printindex causes a particular index (the ??s file) to get printed.
3551 % It does not print any chapter heading (usually an @unnumbered).
3553 \parseargdef\printindex{\begingroup
3554 \dobreak \chapheadingskip{10000}%
3558 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3560 % See if the index file exists and is nonempty.
3561 % Change catcode of @ here so that if the index file contains
3563 % as its first line, TeX doesn't complain about mismatched braces
3564 % (because it thinks @} is a control sequence).
3566 \openin 1 \jobname.#1s
3568 % \enddoublecolumns gets confused if there is no text in the index,
3569 % and it loses the chapter title and the aux file entries for the
3570 % index. The easiest way to prevent this problem is to make sure
3571 % there is some text.
3572 \putwordIndexNonexistent
3575 % If the index file exists but is empty, then \openin leaves \ifeof
3576 % false. We have to make TeX try to read something from the file, so
3577 % it can discover if there is anything in it.
3580 \putwordIndexIsEmpty
3582 % Index files are almost Texinfo source, but we use \ as the escape
3583 % character. It would be better to use @, but that's too big a change
3584 % to make right now.
3585 \def\indexbackslash{\backslashcurfont}%
3596 % These macros are used by the sorted index file itself.
3597 % Change them to control the appearance of the index.
3600 % Some minor font changes for the special characters.
3601 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3603 % Remove any glue we may have, we'll be inserting our own.
3606 % We like breaks before the index initials, so insert a bonus.
3608 \vskip 0pt plus 3\baselineskip
3610 \vskip 0pt plus -3\baselineskip
3612 % Typeset the initial. Making this add up to a whole number of
3613 % baselineskips increases the chance of the dots lining up from column
3614 % to column. It still won't often be perfect, because of the stretch
3615 % we need before each entry, but it's better.
3617 % No shrink because it confuses \balancecolumns.
3618 \vskip 1.67\baselineskip plus .5\baselineskip
3619 \leftline{\secbf #1}%
3620 % Do our best not to break after the initial.
3622 \vskip .33\baselineskip plus .1\baselineskip
3625 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3626 % then page number (#2) flushed to the right margin. It is used for index
3627 % and table of contents entries. The paragraph is indented by \leftskip.
3629 % A straightforward implementation would start like this:
3630 % \def\entry#1#2{...
3631 % But this frozes the catcodes in the argument, and can cause problems to
3632 % @code, which sets - active. This problem was fixed by a kludge---
3633 % ``-'' was active throughout whole index, but this isn't really right.
3635 % The right solution is to prevent \entry from swallowing the whole text.
3640 % Start a new paragraph if necessary, so our assignments below can't
3641 % affect previous text.
3644 % Do not fill out the last line with white space.
3647 % No extra space above this paragraph.
3650 % Do not prefer a separate line ending with a hyphen to fewer lines.
3651 \finalhyphendemerits = 0
3653 % \hangindent is only relevant when the entry text and page number
3654 % don't both fit on one line. In that case, bob suggests starting the
3655 % dots pretty far over on the line. Unfortunately, a large
3656 % indentation looks wrong when the entry text itself is broken across
3657 % lines. So we use a small indentation and put up with long leaders.
3659 % \hangafter is reset to 1 (which is the value we want) at the start
3660 % of each paragraph, so we need not do anything with that.
3663 % When the entry text needs to be broken, just fill out the first line
3665 \rightskip = 0pt plus1fil
3667 % A bit of stretch before each entry for the benefit of balancing
3671 % Swallow the left brace of the text (first parameter):
3672 \afterassignment\doentry
3676 \bgroup % Instead of the swallowed brace.
3678 \aftergroup\finishentry
3679 % And now comes the text of the entry.
3681 \def\finishentry#1{%
3682 % #1 is the page number.
3684 % The following is kludged to not output a line of dots in the index if
3685 % there are no page numbers. The next person who breaks this will be
3686 % cursed by a Unix daemon.
3689 \edef\tempc{\tempa}%
3690 \edef\tempd{\tempb}%
3695 % If we must, put the page number on a line of its own, and fill out
3696 % this line with blank space. (The \hfil is overwhelmed with the
3697 % fill leaders glue in \indexdotfill if the page number does fit.)
3699 \null\nobreak\indexdotfill % Have leaders before the page number.
3701 % The `\ ' here is removed by the implicit \unskip that TeX does as
3702 % part of (the primitive) \par. Without it, a spurious underfull
3715 % Like \dotfill except takes at least 1 em.
3716 \def\indexdotfill{\cleaders
3717 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3719 \def\primary #1{\line{#1\hfil}}
3721 \newskip\secondaryindent \secondaryindent=0.5cm
3722 \def\secondary#1#2{{%
3727 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3729 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3736 % Define two-column mode, which we use to typeset indexes.
3737 % Adapted from the TeXbook, page 416, which is to say,
3738 % the manmac.tex format used to print the TeXbook itself.
3742 \newdimen\doublecolumnhsize
3744 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3745 % Grab any single-column material above us.
3748 % Here is a possibility not foreseen in manmac: if we accumulate a
3749 % whole lot of material, we might end up calling this \output
3750 % routine twice in a row (see the doublecol-lose test, which is
3751 % essentially a couple of indexes with @setchapternewpage off). In
3752 % that case we just ship out what is in \partialpage with the normal
3753 % output routine. Generally, \partialpage will be empty when this
3754 % runs and this will be a no-op. See the indexspread.tex test case.
3755 \ifvoid\partialpage \else
3756 \onepageout{\pagecontents\partialpage}%
3759 \global\setbox\partialpage = \vbox{%
3760 % Unvbox the main output page.
3762 \kern-\topskip \kern\baselineskip
3765 \eject % run that output routine to set \partialpage
3767 % Use the double-column output routine for subsequent pages.
3768 \output = {\doublecolumnout}%
3770 % Change the page size parameters. We could do this once outside this
3771 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3772 % format, but then we repeat the same computation. Repeating a couple
3773 % of assignments once per index is clearly meaningless for the
3774 % execution time, so we may as well do it in one place.
3776 % First we halve the line length, less a little for the gutter between
3777 % the columns. We compute the gutter based on the line length, so it
3778 % changes automatically with the paper format. The magic constant
3779 % below is chosen so that the gutter has the same value (well, +-<1pt)
3780 % as it did when we hard-coded it.
3782 % We put the result in a separate register, \doublecolumhsize, so we
3783 % can restore it in \pagesofar, after \hsize itself has (potentially)
3786 \doublecolumnhsize = \hsize
3787 \advance\doublecolumnhsize by -.04154\hsize
3788 \divide\doublecolumnhsize by 2
3789 \hsize = \doublecolumnhsize
3791 % Double the \vsize as well. (We don't need a separate register here,
3792 % since nobody clobbers \vsize.)
3796 % The double-column output routine for all double-column pages except
3799 \def\doublecolumnout{%
3800 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3801 % Get the available space for the double columns -- the normal
3802 % (undoubled) page height minus any material left over from the
3806 \advance\dimen@ by -\ht\partialpage
3808 % box0 will be the left-hand column, box2 the right.
3809 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3810 \onepageout\pagesofar
3812 \penalty\outputpenalty
3815 % Re-output the contents of the output page -- any previous material,
3816 % followed by the two boxes we just split, in box0 and box2.
3820 \hsize = \doublecolumnhsize
3821 \wd0=\hsize \wd2=\hsize
3822 \hbox to\pagewidth{\box0\hfil\box2}%
3825 % All done with double columns.
3826 \def\enddoublecolumns{%
3828 % Split the last of the double-column material. Leave it on the
3829 % current page, no automatic page break.
3832 % If we end up splitting too much material for the current page,
3833 % though, there will be another page break right after this \output
3834 % invocation ends. Having called \balancecolumns once, we do not
3835 % want to call it again. Therefore, reset \output to its normal
3836 % definition right away. (We hope \balancecolumns will never be
3837 % called on to balance too much material, but if it is, this makes
3838 % the output somewhat more palatable.)
3839 \global\output = {\onepageout{\pagecontents\PAGE}}%
3842 \endgroup % started in \begindoublecolumns
3844 % \pagegoal was set to the doubled \vsize above, since we restarted
3845 % the current page. We're now back to normal single-column
3846 % typesetting, so reset \pagegoal to the normal \vsize (after the
3847 % \endgroup where \vsize got restored).
3851 % Called at the end of the double column material.
3852 \def\balancecolumns{%
3853 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3855 \advance\dimen@ by \topskip
3856 \advance\dimen@ by-\baselineskip
3857 \divide\dimen@ by 2 % target to split to
3858 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3859 \splittopskip = \topskip
3860 % Loop until we get a decent breakpoint.
3864 \global\setbox3 = \copy0
3865 \global\setbox1 = \vsplit3 to \dimen@
3867 \global\advance\dimen@ by 1pt
3870 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3871 \setbox0=\vbox to\dimen@{\unvbox1}%
3872 \setbox2=\vbox to\dimen@{\unvbox3}%
3876 \catcode`\@ = \other
3879 \message{sectioning,}
3880 % Chapters, sections, etc.
3882 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3883 % sections so that we can refer to them unambiguously in the pdf
3884 % outlines by their "section number". We avoid collisions with chapter
3885 % numbers by starting them at 10000. (If a document ever has 10000
3886 % chapters, we're in trouble anyway, I'm sure.)
3887 \newcount\unnumberedno \unnumberedno = 10000
3889 \newcount\secno \secno=0
3890 \newcount\subsecno \subsecno=0
3891 \newcount\subsubsecno \subsubsecno=0
3893 % This counter is funny since it counts through charcodes of letters A, B, ...
3894 \newcount\appendixno \appendixno = `\@
3896 % \def\appendixletter{\char\the\appendixno}
3897 % We do the following ugly conditional instead of the above simple
3898 % construct for the sake of pdftex, which needs the actual
3899 % letter in the expansion, not just typeset.
3901 \def\appendixletter{%
3902 \ifnum\appendixno=`A A%
3903 \else\ifnum\appendixno=`B B%
3904 \else\ifnum\appendixno=`C C%
3905 \else\ifnum\appendixno=`D D%
3906 \else\ifnum\appendixno=`E E%
3907 \else\ifnum\appendixno=`F F%
3908 \else\ifnum\appendixno=`G G%
3909 \else\ifnum\appendixno=`H H%
3910 \else\ifnum\appendixno=`I I%
3911 \else\ifnum\appendixno=`J J%
3912 \else\ifnum\appendixno=`K K%
3913 \else\ifnum\appendixno=`L L%
3914 \else\ifnum\appendixno=`M M%
3915 \else\ifnum\appendixno=`N N%
3916 \else\ifnum\appendixno=`O O%
3917 \else\ifnum\appendixno=`P P%
3918 \else\ifnum\appendixno=`Q Q%
3919 \else\ifnum\appendixno=`R R%
3920 \else\ifnum\appendixno=`S S%
3921 \else\ifnum\appendixno=`T T%
3922 \else\ifnum\appendixno=`U U%
3923 \else\ifnum\appendixno=`V V%
3924 \else\ifnum\appendixno=`W W%
3925 \else\ifnum\appendixno=`X X%
3926 \else\ifnum\appendixno=`Y Y%
3927 \else\ifnum\appendixno=`Z Z%
3928 % The \the is necessary, despite appearances, because \appendixletter is
3929 % expanded while writing the .toc file. \char\appendixno is not
3930 % expandable, thus it is written literally, thus all appendixes come out
3931 % with the same letter (or @) in the toc without it.
3932 \else\char\the\appendixno
3933 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3934 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3936 % Each @chapter defines this as the name of the chapter.
3937 % page headings and footings can use it. @section does likewise.
3938 % However, they are not reliable, because we don't use marks.
3942 \newcount\absseclevel % used to calculate proper heading level
3943 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3945 % @raisesections: treat @section as chapter, @subsection as section, etc.
3946 \def\raisesections{\global\advance\secbase by -1}
3947 \let\up=\raisesections % original BFox name
3949 % @lowersections: treat @chapter as section, @section as subsection, etc.
3950 \def\lowersections{\global\advance\secbase by 1}
3951 \let\down=\lowersections % original BFox name
3953 % we only have subsub.
3954 \chardef\maxseclevel = 3
3956 % A numbered section within an unnumbered changes to unnumbered too.
3957 % To achive this, remember the "biggest" unnum. sec. we are currently in:
3958 \chardef\unmlevel = \maxseclevel
3960 % Trace whether the current chapter is an appendix or not:
3961 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
3962 \def\chapheadtype{N}
3964 % Choose a heading macro
3965 % #1 is heading type
3966 % #2 is heading level
3967 % #3 is text for heading
3968 \def\genhead#1#2#3{%
3969 % Compute the abs. sec. level:
3971 \advance\absseclevel by \secbase
3972 % Make sure \absseclevel doesn't fall outside the range:
3973 \ifnum \absseclevel < 0
3976 \ifnum \absseclevel > 3
3983 \ifnum \absseclevel < \unmlevel
3984 \chardef\unmlevel = \absseclevel
3987 % Check for appendix sections:
3988 \ifnum \absseclevel = 0
3989 \edef\chapheadtype{\headtype}%
3991 \if \headtype A\if \chapheadtype N%
3992 \errmessage{@appendix... within a non-appendix chapter}%
3995 % Check for numbered within unnumbered:
3996 \ifnum \absseclevel > \unmlevel
3999 \chardef\unmlevel = 3
4002 % Now print the heading:
4006 \or \unnumberedseczzz{#3}%
4007 \or \unnumberedsubseczzz{#3}%
4008 \or \unnumberedsubsubseczzz{#3}%
4014 \or \appendixsectionzzz{#3}%
4015 \or \appendixsubseczzz{#3}%
4016 \or \appendixsubsubseczzz{#3}%
4022 \or \numberedsubseczzz{#3}%
4023 \or \numberedsubsubseczzz{#3}%
4027 \suppressfirstparagraphindent
4031 \def\numhead{\genhead N}
4032 \def\apphead{\genhead A}
4033 \def\unnmhead{\genhead U}
4035 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4036 % all lower-level sectioning counters to zero.
4038 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4039 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4040 \let\chaplevelprefix = \empty
4042 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4044 % section resetting is \global in case the chapter is in a group, such
4045 % as an @include file.
4046 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4047 \global\advance\chapno by 1
4050 \gdef\chaplevelprefix{\the\chapno.}%
4053 \message{\putwordChapter\space \the\chapno}%
4055 % Write the actual heading.
4056 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4058 % So @section and the like are numbered underneath this chapter.
4059 \global\let\section = \numberedsec
4060 \global\let\subsection = \numberedsubsec
4061 \global\let\subsubsection = \numberedsubsubsec
4064 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4065 \def\appendixzzz#1{%
4066 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4067 \global\advance\appendixno by 1
4068 \gdef\chaplevelprefix{\appendixletter.}%
4071 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4072 \message{\appendixnum}%
4074 \chapmacro{#1}{Yappendix}{\appendixletter}%
4076 \global\let\section = \appendixsec
4077 \global\let\subsection = \appendixsubsec
4078 \global\let\subsubsection = \appendixsubsubsec
4081 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4082 \def\unnumberedzzz#1{%
4083 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4084 \global\advance\unnumberedno by 1
4086 % Since an unnumbered has no number, no prefix for figures.
4087 \global\let\chaplevelprefix = \empty
4090 % This used to be simply \message{#1}, but TeX fully expands the
4091 % argument to \message. Therefore, if #1 contained @-commands, TeX
4092 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4093 % expanded @cite (which turns out to cause errors because \cite is meant
4094 % to be executed, not expanded).
4096 % Anyway, we don't want the fully-expanded definition of @cite to appear
4097 % as a result of the \message, we just want `@cite' itself. We use
4098 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4099 % simply yielding the contents of <toks register>. (We also do this for
4102 \message{(\the\toks0)}%
4104 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4106 \global\let\section = \unnumberedsec
4107 \global\let\subsection = \unnumberedsubsec
4108 \global\let\subsubsection = \unnumberedsubsubsec
4111 % @centerchap is like @unnumbered, but the heading is centered.
4112 \outer\parseargdef\centerchap{%
4113 % Well, we could do the following in a group, but that would break
4114 % an assumption that \chapmacro is called at the outermost level.
4115 % Thus we are safer this way: --kasal, 24feb04
4116 \let\centerparametersmaybe = \centerparameters
4118 \let\centerparametersmaybe = \relax
4121 % @top is like @unnumbered.
4125 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4127 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4128 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4131 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4132 \def\appendixsectionzzz#1{%
4133 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4134 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4136 \let\appendixsec\appendixsection
4138 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4139 \def\unnumberedseczzz#1{%
4140 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4141 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4145 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4146 \def\numberedsubseczzz#1{%
4147 \global\subsubsecno=0 \global\advance\subsecno by 1
4148 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4151 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4152 \def\appendixsubseczzz#1{%
4153 \global\subsubsecno=0 \global\advance\subsecno by 1
4154 \sectionheading{#1}{subsec}{Yappendix}%
4155 {\appendixletter.\the\secno.\the\subsecno}%
4158 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4159 \def\unnumberedsubseczzz#1{%
4160 \global\subsubsecno=0 \global\advance\subsecno by 1
4161 \sectionheading{#1}{subsec}{Ynothing}%
4162 {\the\unnumberedno.\the\secno.\the\subsecno}%
4166 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4167 \def\numberedsubsubseczzz#1{%
4168 \global\advance\subsubsecno by 1
4169 \sectionheading{#1}{subsubsec}{Ynumbered}%
4170 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4173 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4174 \def\appendixsubsubseczzz#1{%
4175 \global\advance\subsubsecno by 1
4176 \sectionheading{#1}{subsubsec}{Yappendix}%
4177 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4180 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4181 \def\unnumberedsubsubseczzz#1{%
4182 \global\advance\subsubsecno by 1
4183 \sectionheading{#1}{subsubsec}{Ynothing}%
4184 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4187 % These macros control what the section commands do, according
4188 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4189 % Define them by default for a numbered chapter.
4190 \let\section = \numberedsec
4191 \let\subsection = \numberedsubsec
4192 \let\subsubsection = \numberedsubsubsec
4194 % Define @majorheading, @heading and @subheading
4196 % NOTE on use of \vbox for chapter headings, section headings, and such:
4197 % 1) We use \vbox rather than the earlier \line to permit
4198 % overlong headings to fold.
4199 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4200 % heading is obnoxious; this forbids it.
4201 % 3) Likewise, headings look best if no \parindent is used, and
4202 % if justification is not attempted. Hence \raggedright.
4206 {\advance\chapheadingskip by 10pt \chapbreak }%
4207 \parsearg\chapheadingzzz
4210 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4211 \def\chapheadingzzz#1{%
4212 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4213 \parindent=0pt\raggedright
4215 \bigskip \par\penalty 200\relax
4216 \suppressfirstparagraphindent
4219 % @heading, @subheading, @subsubheading.
4220 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4221 \suppressfirstparagraphindent}
4222 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4223 \suppressfirstparagraphindent}
4224 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4225 \suppressfirstparagraphindent}
4227 % These macros generate a chapter, section, etc. heading only
4228 % (including whitespace, linebreaking, etc. around it),
4229 % given all the information in convenient, parsed form.
4231 %%% Args are the skip and penalty (usually negative)
4232 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4234 %%% Define plain chapter starts, and page on/off switching for it
4235 % Parameter controlling skip before chapter headings (if needed)
4237 \newskip\chapheadingskip
4239 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4240 \def\chappager{\par\vfill\supereject}
4241 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4243 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4246 \global\let\contentsalignmacro = \chappager
4247 \global\let\pchapsepmacro=\chapbreak
4248 \global\let\pagealignmacro=\chappager}
4251 \global\let\contentsalignmacro = \chappager
4252 \global\let\pchapsepmacro=\chappager
4253 \global\let\pagealignmacro=\chappager
4254 \global\def\HEADINGSon{\HEADINGSsingle}}
4257 \global\let\contentsalignmacro = \chapoddpage
4258 \global\let\pchapsepmacro=\chapoddpage
4259 \global\let\pagealignmacro=\chapoddpage
4260 \global\def\HEADINGSon{\HEADINGSdouble}}
4266 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4267 % Yappendix, Yomitfromtoc), #3 the chapter number.
4269 % To test against our argument.
4270 \def\Ynothingkeyword{Ynothing}
4271 \def\Yomitfromtockeyword{Yomitfromtoc}
4272 \def\Yappendixkeyword{Yappendix}
4274 \def\chapmacro#1#2#3{%
4279 % Have to define \thissection before calling \donoderef, because the
4280 % xref code eventually uses it. On the other hand, it has to be called
4281 % after \pchapsepmacro, or the headline will change too soon.
4282 \gdef\thissection{#1}%
4283 \gdef\thischaptername{#1}%
4285 % Only insert the separating space if we have a chapter/appendix
4286 % number, and don't print the unnumbered ``number''.
4288 \ifx\temptype\Ynothingkeyword
4290 \def\toctype{unnchap}%
4291 \def\thischapter{#1}%
4292 \else\ifx\temptype\Yomitfromtockeyword
4293 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4295 \xdef\thischapter{}%
4296 \else\ifx\temptype\Yappendixkeyword
4297 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4299 % We don't substitute the actual chapter name into \thischapter
4300 % because we don't want its macros evaluated now. And we don't
4301 % use \thissection because that changes with each section.
4303 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4304 \noexpand\thischaptername}%
4306 \setbox0 = \hbox{#3\enspace}%
4307 \def\toctype{numchap}%
4308 \xdef\thischapter{\putwordChapter{} \the\chapno:
4309 \noexpand\thischaptername}%
4312 % Write the toc entry for this chapter. Must come before the
4313 % \donoderef, because we include the current node name in the toc
4314 % entry, and \donoderef resets it to empty.
4315 \writetocentry{\toctype}{#1}{#3}%
4317 % For pdftex, we have to write out the node definition (aka, make
4318 % the pdfdest) after any page break, but before the actual text has
4319 % been typeset. If the destination for the pdf outline is after the
4320 % text, then jumping from the outline may wind up with the text not
4321 % being visible, for instance under high magnification.
4324 % Typeset the actual heading.
4325 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4326 \hangindent=\wd0 \centerparametersmaybe
4329 \nobreak\bigskip % no page break after a chapter title
4333 % @centerchap -- centered and unnumbered.
4334 \let\centerparametersmaybe = \relax
4335 \def\centerparameters{%
4336 \advance\rightskip by 3\rightskip
4337 \leftskip = \rightskip
4342 % I don't think this chapter style is supported any more, so I'm not
4343 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4345 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4347 \def\unnchfopen #1{%
4348 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4349 \parindent=0pt\raggedright
4350 \rm #1\hfill}}\bigskip \par\nobreak
4352 \def\chfopen #1#2{\chapoddpage {\chapfonts
4353 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4356 \def\centerchfopen #1{%
4357 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4359 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4362 \global\let\chapmacro=\chfopen
4363 \global\let\centerchapmacro=\centerchfopen}
4366 % Section titles. These macros combine the section number parts and
4367 % call the generic \sectionheading to do the printing.
4369 \newskip\secheadingskip
4370 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4372 % Subsection titles.
4373 \newskip\subsecheadingskip
4374 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4376 % Subsubsection titles.
4377 \def\subsubsecheadingskip{\subsecheadingskip}
4378 \def\subsubsecheadingbreak{\subsecheadingbreak}
4381 % Print any size, any type, section title.
4383 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4384 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4387 \def\sectionheading#1#2#3#4{%
4389 % Switch to the right set of fonts.
4390 \csname #2fonts\endcsname \rm
4392 % Insert space above the heading.
4393 \csname #2headingbreak\endcsname
4395 % Only insert the space after the number if we have a section number.
4396 \def\sectionlevel{#2}%
4399 \ifx\temptype\Ynothingkeyword
4402 \gdef\thissection{#1}%
4403 \else\ifx\temptype\Yomitfromtockeyword
4404 % for @headings -- no section number, don't include in toc,
4405 % and don't redefine \thissection.
4408 \let\sectionlevel=\empty
4409 \else\ifx\temptype\Yappendixkeyword
4410 \setbox0 = \hbox{#4\enspace}%
4412 \gdef\thissection{#1}%
4414 \setbox0 = \hbox{#4\enspace}%
4416 \gdef\thissection{#1}%
4419 % Write the toc entry (before \donoderef). See comments in \chfplain.
4420 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4422 % Write the node reference (= pdf destination for pdftex).
4423 % Again, see comments in \chfplain.
4426 % Output the actual section heading.
4427 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4428 \hangindent=\wd0 % zero if no section number
4431 % Add extra space after the heading -- half of whatever came above it.
4432 % Don't allow stretch, though.
4433 \kern .5 \csname #2headingskip\endcsname
4435 % Do not let the kern be a potential breakpoint, as it would be if it
4436 % was followed by glue.
4439 % We'll almost certainly start a paragraph next, so don't let that
4440 % glue accumulate. (Not a breakpoint because it's preceded by a
4441 % discardable item.)
4444 % This is purely so the last item on the list is a known \penalty >
4445 % 10000. This is so \startdefun can avoid allowing breakpoints after
4446 % section headings. Otherwise, it would insert a valid breakpoint between:
4448 % @section sec-whatever
4449 % @deffn def-whatever
4455 % Table of contents.
4458 % Write an entry to the toc file, opening it if necessary.
4459 % Called from @chapter, etc.
4461 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4462 % We append the current node name (if any) and page number as additional
4463 % arguments for the \{chap,sec,...}entry macros which will eventually
4464 % read this. The node name is used in the pdf outlines as the
4465 % destination to jump to.
4467 % We open the .toc file for writing here instead of at @setfilename (or
4468 % any other fixed time) so that @contents can be anywhere in the document.
4469 % But if #1 is `omit', then we don't do anything. This is used for the
4470 % table of contents chapter openings themselves.
4472 \newif\iftocfileopened
4473 \def\omitkeyword{omit}%
4475 \def\writetocentry#1#2#3{%
4476 \edef\writetoctype{#1}%
4477 \ifx\writetoctype\omitkeyword \else
4478 \iftocfileopened\else
4479 \immediate\openout\tocfile = \jobname.toc
4480 \global\tocfileopenedtrue
4485 \toks2 = \expandafter{\lastnode}%
4486 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4487 {\the\toks2}{\noexpand\folio}}}%
4492 % Tell \shipout to create a pdf destination on each page, if we're
4493 % writing pdf. These are used in the table of contents. We can't
4494 % just write one on every page because the title pages are numbered
4495 % 1 and 2 (the page numbers aren't printed), and so are the first
4496 % two pages of the document. Thus, we'd have two destinations named
4497 % `1', and two named `2'.
4498 \ifpdf \global\pdfmakepagedesttrue \fi
4501 \newskip\contentsrightmargin \contentsrightmargin=1in
4502 \newcount\savepageno
4503 \newcount\lastnegativepageno \lastnegativepageno = -1
4505 % Prepare to read what we've written to \tocfile.
4507 \def\startcontents#1{%
4508 % If @setchapternewpage on, and @headings double, the contents should
4509 % start on an odd page, unlike chapters. Thus, we maintain
4510 % \contentsalignmacro in parallel with \pagealignmacro.
4511 % From: Torbjorn Granlund <tege@matematik.su.se>
4513 \immediate\closeout\tocfile
4515 % Don't need to put `Contents' or `Short Contents' in the headline.
4516 % It is abundantly clear what they are.
4518 \chapmacro{#1}{Yomitfromtoc}{}%
4520 \savepageno = \pageno
4521 \begingroup % Set up to handle contents files properly.
4522 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4523 % We can't do this, because then an actual ^ in a section
4524 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4525 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4526 \raggedbottom % Worry more about breakpoints than the bottom.
4527 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4529 % Roman numerals for page numbers.
4530 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4534 % Normal (long) toc.
4536 \startcontents{\putwordTOC}%
4537 \openin 1 \jobname.toc
4542 \contentsalignmacro % in case @setchapternewpage odd is in effect
4548 \lastnegativepageno = \pageno
4549 \global\pageno = \savepageno
4552 % And just the chapters.
4553 \def\summarycontents{%
4554 \startcontents{\putwordShortTOC}%
4556 \let\numchapentry = \shortchapentry
4557 \let\appentry = \shortchapentry
4558 \let\unnchapentry = \shortunnchapentry
4559 % We want a true roman here for the page numbers.
4561 \let\rm=\shortcontrm \let\bf=\shortcontbf
4562 \let\sl=\shortcontsl \let\tt=\shortconttt
4564 \hyphenpenalty = 10000
4565 \advance\baselineskip by 1pt % Open it up a little.
4566 \def\numsecentry##1##2##3##4{}
4567 \let\appsecentry = \numsecentry
4568 \let\unnsecentry = \numsecentry
4569 \let\numsubsecentry = \numsecentry
4570 \let\appsubsecentry = \numsecentry
4571 \let\unnsubsecentry = \numsecentry
4572 \let\numsubsubsecentry = \numsecentry
4573 \let\appsubsubsecentry = \numsecentry
4574 \let\unnsubsubsecentry = \numsecentry
4575 \openin 1 \jobname.toc
4581 \contentsalignmacro % in case @setchapternewpage odd is in effect
4583 \lastnegativepageno = \pageno
4584 \global\pageno = \savepageno
4586 \let\shortcontents = \summarycontents
4588 % Typeset the label for a chapter or appendix for the short contents.
4589 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4591 \def\shortchaplabel#1{%
4592 % This space should be enough, since a single number is .5em, and the
4593 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4594 % But use \hss just in case.
4595 % (This space doesn't include the extra space that gets added after
4596 % the label; that gets put in by \shortchapentry above.)
4598 % We'd like to right-justify chapter numbers, but that looks strange
4599 % with appendix letters. And right-justifying numbers and
4600 % left-justifying letters looks strange when there is less than 10
4601 % chapters. Have to read the whole toc once to know how many chapters
4602 % there are before deciding ...
4603 \hbox to 1em{#1\hss}%
4606 % These macros generate individual entries in the table of contents.
4607 % The first argument is the chapter or section name.
4608 % The last argument is the page number.
4609 % The arguments in between are the chapter number, section number, ...
4611 % Chapters, in the main contents.
4612 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4614 % Chapters, in the short toc.
4615 % See comments in \dochapentry re vbox and related settings.
4616 \def\shortchapentry#1#2#3#4{%
4617 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4620 % Appendices, in the main contents.
4621 % Need the word Appendix, and a fixed-size box.
4623 \def\appendixbox#1{%
4624 % We use M since it's probably the widest letter.
4625 \setbox0 = \hbox{\putwordAppendix{} M}%
4626 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4628 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4630 % Unnumbered chapters.
4631 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4632 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4635 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4636 \let\appsecentry=\numsecentry
4637 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4640 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4641 \let\appsubsecentry=\numsubsecentry
4642 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4644 % And subsubsections.
4645 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4646 \let\appsubsubsecentry=\numsubsubsecentry
4647 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4649 % This parameter controls the indentation of the various levels.
4650 % Same as \defaultparindent.
4651 \newdimen\tocindent \tocindent = 15pt
4653 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4656 % If the toc has to be broken over pages, we want it to be at chapters
4657 % if at all possible; hence the \penalty.
4658 \def\dochapentry#1#2{%
4659 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4662 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4664 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4667 \def\dosecentry#1#2{\begingroup
4668 \secentryfonts \leftskip=\tocindent
4669 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4672 \def\dosubsecentry#1#2{\begingroup
4673 \subsecentryfonts \leftskip=2\tocindent
4674 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4677 \def\dosubsubsecentry#1#2{\begingroup
4678 \subsubsecentryfonts \leftskip=3\tocindent
4679 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4682 % We use the same \entry macro as for the index entries.
4683 \let\tocentry = \entry
4685 % Space between chapter (or whatever) number and the title.
4686 \def\labelspace{\hskip1em \relax}
4688 \def\dopageno#1{{\rm #1}}
4689 \def\doshortpageno#1{{\rm #1}}
4691 \def\chapentryfonts{\secfonts \rm}
4692 \def\secentryfonts{\textfonts}
4693 \def\subsecentryfonts{\textfonts}
4694 \def\subsubsecentryfonts{\textfonts}
4697 \message{environments,}
4698 % @foo ... @end foo.
4700 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4702 % Since these characters are used in examples, it should be an even number of
4703 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4706 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4707 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4708 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4709 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4711 % The @error{} command.
4712 % Adapted from the TeXbook's \boxit.
4716 {\tentt \global\dimen0 = 3em}% Width of the box.
4717 \dimen2 = .55pt % Thickness of rules
4718 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4719 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4721 \setbox\errorbox=\hbox to \dimen0{\hfil
4722 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4723 \advance\hsize by -2\dimen2 % Rules.
4725 \hrule height\dimen2
4726 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4727 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4728 \kern3pt\vrule width\dimen2}% Space to right.
4729 \hrule height\dimen2}
4732 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4734 % @tex ... @end tex escapes into raw Tex temporarily.
4735 % One exception: @ is still an escape character, so that @end tex works.
4736 % But \@ or @@ will get a plain tex @ character.
4739 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4740 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4741 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4751 \let\bullet=\ptexbullet
4756 \let\equiv=\ptexequiv
4759 \let\indent=\ptexindent
4760 \let\noindent=\ptexnoindent
4768 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4769 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4772 % There is no need to define \Etex.
4774 % Define @lisp ... @end lisp.
4775 % @lisp environment forms a group so it can rebind things,
4776 % including the definition of @end lisp (which normally is erroneous).
4778 % Amount to narrow the margins by for @lisp.
4779 \newskip\lispnarrowing \lispnarrowing=0.4in
4781 % This is the definition that ^^M gets inside @lisp, @example, and other
4782 % such environments. \null is better than a space, since it doesn't
4784 \def\lisppar{\null\endgraf}
4786 % This space is always present above and below environments.
4787 \newskip\envskipamount \envskipamount = 0pt
4789 % Make spacing and below environment symmetrical. We use \parskip here
4790 % to help in doing that, since in @example-like environments \parskip
4791 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4792 % start of the next paragraph will insert \parskip.
4794 \def\aboveenvbreak{{%
4795 % =10000 instead of <10000 because of a special case in \itemzzz and
4796 % \sectionheading, q.v.
4797 \ifnum \lastpenalty=10000 \else
4798 \advance\envskipamount by \parskip
4800 \ifdim\lastskip<\envskipamount
4802 % it's not a good place to break if the last penalty was \nobreak
4804 \ifnum\lastpenalty<10000 \penalty-50 \fi
4805 \vskip\envskipamount
4810 \let\afterenvbreak = \aboveenvbreak
4812 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4813 \let\nonarrowing=\relax
4815 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4816 % environment contents.
4817 \font\circle=lcircle10
4819 \newdimen\cartouter\newdimen\cartinner
4820 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4821 \circthick=\fontdimen8\circle
4823 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4824 \def\ctr{{\hskip 6pt\circle\char'010}}
4825 \def\cbl{{\circle\char'012\hskip -6pt}}
4826 \def\cbr{{\hskip 6pt\circle\char'011}}
4827 \def\carttop{\hbox to \cartouter{\hskip\lskip
4828 \ctl\leaders\hrule height\circthick\hfil\ctr
4830 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4831 \cbl\leaders\hrule height\circthick\hfil\cbr
4834 \newskip\lskip\newskip\rskip
4837 \ifhmode\par\fi % can't be in the midst of a paragraph.
4839 \lskip=\leftskip \rskip=\rightskip
4840 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4841 \cartinner=\hsize \advance\cartinner by-\lskip
4842 \advance\cartinner by-\rskip
4844 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4845 % side, and for 6pt waste from
4846 % each corner char, and rule thickness
4847 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4848 % Flag to tell @lisp, etc., not to narrow margin.
4849 \let\nonarrowing=\comment
4851 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4859 \baselineskip=\normbskip
4860 \lineskip=\normlskip
4863 \comment % For explanation, see the end of \def\group.
4878 % This macro is called at the beginning of all the @example variants,
4882 \hfuzz = 12pt % Don't be fussy
4883 \sepspaces % Make spaces be word-separators rather than space tokens.
4884 \let\par = \lisppar % don't ignore blank lines
4885 \obeylines % each line of input is a line of output
4888 \emergencystretch = 0pt % don't try to avoid overfull boxes
4889 % @cartouche defines \nonarrowing to inhibit narrowing
4890 % at next level down.
4891 \ifx\nonarrowing\relax
4892 \advance \leftskip by \lispnarrowing
4893 \exdentamount=\lispnarrowing
4895 \let\exdent=\nofillexdent
4898 % If you want all examples etc. small: @set dispenvsize small.
4899 % If you want even small examples the full size: @set dispenvsize nosmall.
4900 % This affects the following displayed environments:
4901 % @example, @display, @format, @lisp
4903 \def\smallword{small}
4904 \def\nosmallword{nosmall}
4905 \let\SETdispenvsize\relax
4906 \def\setnormaldispenv{%
4907 \ifx\SETdispenvsize\smallword
4908 \smallexamplefonts \rm
4911 \def\setsmalldispenv{%
4912 \ifx\SETdispenvsize\nosmallword
4914 \smallexamplefonts \rm
4918 % We often define two environments, @foo and @smallfoo.
4919 % Let's do it by one command:
4920 \def\makedispenv #1#2{
4921 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4922 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4923 \expandafter\let\csname E#1\endcsname \afterenvbreak
4924 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4927 % Define two synonyms:
4928 \def\maketwodispenvs #1#2#3{
4929 \makedispenv{#1}{#3}
4930 \makedispenv{#2}{#3}
4933 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4935 % @smallexample and @smalllisp: use smaller fonts.
4936 % Originally contributed by Pavel@xerox.
4938 \maketwodispenvs {lisp}{example}{%
4941 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4942 \gobble % eat return
4945 % @display/@smalldisplay: same as @lisp except keep current font.
4947 \makedispenv {display}{%
4952 % @format/@smallformat: same as @display except don't narrow margins.
4954 \makedispenv{format}{%
4955 \let\nonarrowing = t%
4960 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4962 \let\nonarrowing = t%
4966 \let\Eflushleft = \afterenvbreak
4970 \envdef\flushright{%
4971 \let\nonarrowing = t%
4973 \advance\leftskip by 0pt plus 1fill
4976 \let\Eflushright = \afterenvbreak
4979 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4980 % and narrows the margins. We keep \parskip nonzero in general, since
4981 % we're doing normal filling. So, when using \aboveenvbreak and
4982 % \afterenvbreak, temporarily make \parskip 0.
4985 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4988 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4989 \ifx\nonarrowing\relax
4990 \advance\leftskip by \lispnarrowing
4991 \advance\rightskip by \lispnarrowing
4992 \exdentamount = \lispnarrowing
4993 \let\nonarrowing = \relax
4995 \parsearg\quotationlabel
4998 % We have retained a nonzero parskip for the environment, since we're
4999 % doing normal filling.
5003 \ifx\quotationauthor\undefined\else
5005 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5007 {\parskip=0pt \afterenvbreak}%
5010 % If we're given an argument, typeset it in bold with a colon after.
5011 \def\quotationlabel#1{%
5013 \ifx\temp\empty \else
5019 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5020 % If we want to allow any <char> as delimiter,
5021 % we need the curly braces so that makeinfo sees the @verb command, eg:
5022 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5024 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5026 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5027 % active too. Otherwise, they get lost as the first character on a
5030 \do\ \do\\\do\{\do\}\do\$\do\&%
5031 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5032 \do\<\do\>\do\|\do\@\do+\do\"%
5036 \def\uncatcodespecials{%
5037 \def\do##1{\catcode`##1=\other}\dospecials}
5039 % [Knuth] pp. 380,381,391
5040 % Disable Spanish ligatures ?` and !` of \tt font
5042 \catcode`\`=\active\gdef`{\relax\lq}
5045 % Setup for the @verb command.
5047 % Eight spaces for a tab
5049 \catcode`\^^I=\active
5050 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5054 \tt % easiest (and conventionally used) font for verbatim
5055 \def\par{\leavevmode\endgraf}%
5058 % Respect line breaks,
5059 % print special symbols as themselves, and
5060 % make each space count
5061 % must do in this order:
5062 \obeylines \uncatcodespecials \sepspaces
5065 % Setup for the @verbatim environment
5067 % Real tab expansion
5068 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5070 \def\starttabbox{\setbox0=\hbox\bgroup}
5072 \catcode`\^^I=\active
5074 \catcode`\^^I=\active
5075 \def^^I{\leavevmode\egroup
5076 \dimen0=\wd0 % the width so far, or since the previous tab
5077 \divide\dimen0 by\tabw
5078 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5079 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5080 \wd0=\dimen0 \box0 \starttabbox
5084 \def\setupverbatim{%
5086 \advance\leftskip by -\defbodyindent
5087 % Easiest (and conventionally used) font for verbatim
5089 \def\par{\leavevmode\egroup\box0\endgraf}%
5092 % Respect line breaks,
5093 % print special symbols as themselves, and
5094 % make each space count
5095 % must do in this order:
5096 \obeylines \uncatcodespecials \sepspaces
5097 \everypar{\starttabbox}%
5100 % Do the @verb magic: verbatim text is quoted by unique
5101 % delimiter characters. Before first delimiter expect a
5102 % right brace, after last delimiter expect closing brace:
5104 % \def\doverb'{'<char>#1<char>'}'{#1}
5106 % [Knuth] p. 382; only eat outer {}
5108 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5109 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5112 \def\verb{\begingroup\setupverb\doverb}
5115 % Do the @verbatim magic: define the macro \doverbatim so that
5116 % the (first) argument ends when '@end verbatim' is reached, ie:
5118 % \def\doverbatim#1@end verbatim{#1}
5120 % For Texinfo it's a lot easier than for LaTeX,
5121 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5122 % we need not redefine '\', '{' and '}'.
5124 % Inspired by LaTeX's verbatim command set [latex.ltx]
5129 % ignore everything up to the first ^^M, that's the newline at the end
5130 % of the @verbatim input line itself. Otherwise we get an extra blank
5131 % line in the output.
5132 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5133 % We really want {...\end verbatim} in the body of the macro, but
5134 % without the active space; thus we have to use \xdef and \gobble.
5138 \setupverbatim\doverbatim
5140 \let\Everbatim = \afterenvbreak
5143 % @verbatiminclude FILE - insert text of file in verbatim environment.
5145 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5147 \def\doverbatiminclude#1{%
5149 \makevalueexpandable
5156 % @copying ... @end copying.
5157 % Save the text away for @insertcopying later.
5159 % We save the uninterpreted tokens, rather than creating a box.
5160 % Saving the text in a box would be much easier, but then all the
5161 % typesetting commands (@smallbook, font changes, etc.) have to be done
5162 % beforehand -- and a) we want @copying to be done first in the source
5163 % file; b) letting users define the frontmatter in as flexible order as
5164 % possible is very desirable.
5166 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5167 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5169 \def\insertcopying{%
5171 \parindent = 0pt % paragraph indentation looks wrong on title page
5172 \scanexp\copyingtext
5179 \newskip\defbodyindent \defbodyindent=.4in
5180 \newskip\defargsindent \defargsindent=50pt
5181 \newskip\deflastargmargin \deflastargmargin=18pt
5183 % Start the processing of @deffn:
5185 \ifnum\lastpenalty<10000
5188 % If there are two @def commands in a row, we'll have a \nobreak,
5189 % which is there to keep the function description together with its
5190 % header. But if there's nothing but headers, we need to allow a
5191 % break somewhere. Check specifically for penalty 10002, inserted
5192 % by \defargscommonending, instead of 10000, since the sectioning
5193 % commands also insert a nobreak penalty, and we don't want to allow
5194 % a break between a section heading and a defun.
5196 \ifnum\lastpenalty=10002 \penalty2000 \fi
5198 % Similarly, after a section heading, do not allow a break.
5199 % But do insert the glue.
5200 \medskip % preceded by discardable penalty, so not a breakpoint
5204 \advance\leftskip by \defbodyindent
5205 \exdentamount=\defbodyindent
5209 % First, check whether we are in the right environment:
5212 % As above, allow line break if we have multiple x headers in a row.
5213 % It's not a great place, though.
5214 \ifnum\lastpenalty=10002 \penalty3000 \fi
5216 % And now, it's time to reuse the body of the original defun:
5217 \expandafter\gobbledefun#1%
5219 \def\gobbledefun#1\startdefun{}
5221 % \printdefunline \deffnheader{text}
5223 \def\printdefunline#1#2{%
5225 % call \deffnheader:
5228 \interlinepenalty = 10000
5229 \advance\rightskip by 0pt plus 1fil
5231 \nobreak\vskip -\parskip
5232 \penalty 10002 % signal to \startdefun and \dodefunx
5233 % Some of the @defun-type tags do not enable magic parentheses,
5234 % rendering the following check redundant. But we don't optimize.
5239 \def\Edefun{\endgraf\medbreak}
5241 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5242 % the only thing remainnig is to define \deffnheader.
5245 \expandafter\let\csname E#1\endcsname = \Edefun
5246 \edef\temp{\noexpand\domakedefun
5247 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5251 % \domakedefun \deffn \deffnx \deffnheader
5253 % Define \deffn and \deffnx, without parameters.
5254 % \deffnheader has to be defined explicitly.
5256 \def\domakedefun#1#2#3{%
5259 \parseargusing\activeparens{\printdefunline#3}%
5261 \def#2{\dodefunx#1}%
5265 %%% Untyped functions:
5267 % @deffn category name args
5268 \makedefun{deffn}{\deffngeneral{}}
5270 % @deffn category class name args
5271 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5273 % \defopon {category on}class name args
5274 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5276 % \deffngeneral {subind}category name args
5278 \def\deffngeneral#1#2 #3 #4\endheader{%
5279 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5280 \dosubind{fn}{\code{#3}}{#1}%
5281 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5284 %%% Typed functions:
5286 % @deftypefn category type name args
5287 \makedefun{deftypefn}{\deftypefngeneral{}}
5289 % @deftypeop category class type name args
5290 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5292 % \deftypeopon {category on}class type name args
5293 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5295 % \deftypefngeneral {subind}category type name args
5297 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5298 \dosubind{fn}{\code{#4}}{#1}%
5299 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5302 %%% Typed variables:
5304 % @deftypevr category type var args
5305 \makedefun{deftypevr}{\deftypecvgeneral{}}
5307 % @deftypecv category class type var args
5308 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5310 % \deftypecvof {category of}class type var args
5311 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5313 % \deftypecvgeneral {subind}category type var args
5315 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5316 \dosubind{vr}{\code{#4}}{#1}%
5317 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5320 %%% Untyped variables:
5322 % @defvr category var args
5323 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5325 % @defcv category class var args
5326 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5328 % \defcvof {category of}class var args
5329 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5332 % @deftp category name args
5333 \makedefun{deftp}#1 #2 #3\endheader{%
5334 \doind{tp}{\code{#2}}%
5335 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5338 % Remaining @defun-like shortcuts:
5339 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5340 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5341 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5342 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5343 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5344 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5345 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5346 \makedefun{defmethod}{\defopon\putwordMethodon}
5347 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5348 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5349 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5351 % \defname, which formats the name of the @def (not the args).
5352 % #1 is the category, such as "Function".
5353 % #2 is the return type, if any.
5354 % #3 is the function name.
5356 % We are followed by (but not passed) the arguments, if any.
5358 \def\defname#1#2#3{%
5359 % Get the values of \leftskip and \rightskip as they were outside the @def...
5360 \advance\leftskip by -\defbodyindent
5362 % How we'll format the type name. Putting it in brackets helps
5363 % distinguish it from the body text that may end up on the next line
5366 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5368 % Figure out line sizes for the paragraph shape.
5369 % The first line needs space for \box0; but if \rightskip is nonzero,
5370 % we need only space for the part of \box0 which exceeds it:
5371 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5372 % The continuations:
5373 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5374 % (plain.tex says that \dimen1 should be used only as global.)
5375 \parshape 2 0in \dimen0 \defargsindent \dimen2
5377 % Put the type name to the right margin.
5380 \hfil\box0 \kern-\hsize
5381 % \hsize has to be shortened this way:
5383 % Intentionally do not respect \rightskip, since we need the space.
5386 % Allow all lines to be underfull without complaint:
5387 \tolerance=10000 \hbadness=10000
5388 \exdentamount=\defbodyindent
5390 % defun fonts. We use typewriter by default (used to be bold) because:
5391 % . we're printing identifiers, they should be in tt in principle.
5392 % . in languages with many accents, such as Czech or French, it's
5393 % common to leave accents off identifiers. The result looks ok in
5394 % tt, but exceedingly strange in rm.
5395 % . we don't want -- and --- to be treated as ligatures.
5396 % . this still does not fix the ?` and !` ligatures, but so far no
5397 % one has made identifiers using them :).
5399 \def\temp{#2}% return value type
5400 \ifx\temp\empty\else \tclose{\temp} \fi
5401 #3% output function name
5403 {\rm\enskip}% hskip 0.5 em of \tenrm
5406 % arguments will be output next, if any.
5409 % Print arguments in slanted roman (not ttsl), inconsistently with using
5410 % tt for the name. This is because literal text is sometimes needed in
5411 % the argument list (groff manual), and ttsl and tt are not very
5412 % distinguishable. Prevent hyphenation at `-' chars.
5415 % use sl by default (not ttsl),
5417 \df \sl \hyphenchar\font=0
5419 % On the other hand, if an argument has two dashes (for instance), we
5420 % want a way to get ttsl. Let's try @var for that.
5423 \sl\hyphenchar\font=45
5426 % We want ()&[] to print specially on the defun line.
5429 \catcode`\(=\active \catcode`\)=\active
5430 \catcode`\[=\active \catcode`\]=\active
5434 % Make control sequences which act like normal parenthesis chars.
5435 \let\lparen = ( \let\rparen = )
5437 % Be sure that we always have a definition for `(', etc. For example,
5438 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5439 % so TeX would otherwise complain about undefined control sequence.
5442 \global\let(=\lparen \global\let)=\rparen
5443 \global\let[=\lbrack \global\let]=\rbrack
5446 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5447 \gdef\magicamp{\let&=\amprm}
5450 \newcount\parencount
5452 % If we encounter &foo, then turn on ()-hacking afterwards
5454 \def\amprm#1 {\ampseentrue{\bf\ }}
5458 % At the first level, print parens in roman,
5459 % otherwise use the default font.
5460 \ifnum \parencount=1 \rm \fi
5462 % The \sf parens (in \boldbrax) actually are a little bolder than
5463 % the contained text. This is especially needed for [ and ] .
5467 \def\infirstlevel#1{%
5474 \def\bfafterword#1 {#1 \bf}
5477 \global\advance\parencount by 1
5479 \infirstlevel \bfafterword
5484 \global\advance\parencount by -1
5487 \newcount\brackcount
5489 \global\advance\brackcount by 1
5494 \global\advance\brackcount by -1
5497 \def\checkparencounts{%
5498 \ifnum\parencount=0 \else \badparencount \fi
5499 \ifnum\brackcount=0 \else \badbrackcount \fi
5501 \def\badparencount{%
5502 \errmessage{Unbalanced parentheses in @def}%
5503 \global\parencount=0
5505 \def\badbrackcount{%
5506 \errmessage{Unbalanced square braces in @def}%
5507 \global\brackcount=0
5514 % To do this right we need a feature of e-TeX, \scantokens,
5515 % which we arrange to emulate with a temporary file in ordinary TeX.
5516 \ifx\eTeXversion\undefined
5517 \newwrite\macscribble
5520 \immediate\openout\macscribble=\jobname.tmp
5521 \immediate\write\macscribble{\the\toks0}%
5522 \immediate\closeout\macscribble
5530 \let\xeatspaces\eatspaces
5531 % Undo catcode changes of \startcontents and \doprintindex
5532 % When called from @insertcopying or (short)caption, we need active
5533 % backslash to get it printed correctly. Previously, we had
5534 % \catcode`\\=\other instead. We'll see whether a problem appears
5535 % with macro expansion. --kasal, 19aug04
5536 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5540 % Append \endinput to make sure that TeX does not see the ending newline.
5542 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5544 \scantokens{#1\endinput}%
5549 \edef\temp{\noexpand\scanmacro{#1}}%
5553 \newcount\paramno % Count of parameters
5554 \newtoks\macname % Macro name
5555 \newif\ifrecursive % Is it recursive?
5556 \def\macrolist{} % List of all defined macros in the form
5557 % \do\macro1\do\macro2...
5560 % This does \let #1 = #2, with \csnames; that is,
5561 % \let \csname#1\endcsname = \csname#2\endcsname
5562 % (except of course we have to play expansion games).
5566 \csname#1\expandafter\endcsname
5570 % Trim leading and trailing spaces off a string.
5571 % Concepts from aro-bend problem 15 (see CTAN).
5573 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5574 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5575 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5577 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5580 % Trim a single trailing ^^M off a string.
5581 {\catcode`\^^M=\other \catcode`\Q=3%
5582 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5583 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5584 \gdef\eatcrb#1Q#2Q{#1}%
5587 % Macro bodies are absorbed as an argument in a context where
5588 % all characters are catcode 10, 11 or 12, except \ which is active
5589 % (as in normal texinfo). It is necessary to change the definition of \.
5591 % It's necessary to have hard CRs when the macro is executed. This is
5592 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5593 % body, and then making it the \newlinechar in \scanmacro.
5610 \catcode`\^^M=\other
5613 \def\macrobodyctxt{%
5617 \catcode`\^^M=\other
5626 % \mbodybackslash is the definition of \ in @macro bodies.
5627 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5628 % where N is the macro parameter number.
5629 % We define \csname macarg.\endcsname to be \realbackslash, so
5630 % \\ in macro replacement text gets you a backslash.
5632 {\catcode`@=0 @catcode`@\=@active
5633 @gdef@usembodybackslash{@let\=@mbodybackslash}
5634 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5636 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5638 \def\macro{\recursivefalse\parsearg\macroxxx}
5639 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5642 \getargs{#1}% now \macname is the macname and \argl the arglist
5643 \ifx\argl\empty % no arguments
5646 \expandafter\parsemargdef \argl;%
5648 \if1\csname ismacro.\the\macname\endcsname
5649 \message{Warning: redefining \the\macname}%
5651 \expandafter\ifx\csname \the\macname\endcsname \relax
5652 \else \errmessage{Macro name \the\macname\space already defined}\fi
5653 \global\cslet{macsave.\the\macname}{\the\macname}%
5654 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5655 % Add the macroname to \macrolist
5656 \toks0 = \expandafter{\macrolist\do}%
5657 \xdef\macrolist{\the\toks0
5658 \expandafter\noexpand\csname\the\macname\endcsname}%
5660 \begingroup \macrobodyctxt
5661 \ifrecursive \expandafter\parsermacbody
5662 \else \expandafter\parsemacbody
5665 \parseargdef\unmacro{%
5666 \if1\csname ismacro.#1\endcsname
5667 \global\cslet{#1}{macsave.#1}%
5668 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5669 % Remove the macro name from \macrolist:
5671 \expandafter\let\csname#1\endcsname \relax
5673 \xdef\macrolist{\macrolist}%
5676 \errmessage{Macro #1 not defined}%
5680 % Called by \do from \dounmacro on each macro. The idea is to omit any
5681 % macro definitions that have been changed to \relax.
5687 \noexpand\do \noexpand #1%
5691 % This makes use of the obscure feature that if the last token of a
5692 % <parameter list> is #, then the preceding argument is delimited by
5693 % an opening brace, and that opening brace is not consumed.
5694 \def\getargs#1{\getargsxxx#1{}}
5695 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5696 \def\getmacname #1 #2\relax{\macname={#1}}
5697 \def\getmacargs#1{\def\argl{#1}}
5699 % Parse the optional {params} list. Set up \paramno and \paramlist
5700 % so \defmacro knows what to do. Define \macarg.blah for each blah
5701 % in the params list, to be ##N where N is the position in that list.
5702 % That gets used by \mbodybackslash (above).
5704 % We need to get `macro parameter char #' into several definitions.
5705 % The technique used is stolen from LaTeX: let \hash be something
5706 % unexpandable, insert that wherever you need a #, and then redefine
5707 % it to # just before using the token list produced.
5709 % The same technique is used to protect \eatspaces till just before
5710 % the macro is used.
5712 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5713 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5714 \def\parsemargdefxxx#1,{%
5715 \if#1;\let\next=\relax
5716 \else \let\next=\parsemargdefxxx
5717 \advance\paramno by 1%
5718 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5719 {\xeatspaces{\hash\the\paramno}}%
5720 \edef\paramlist{\paramlist\hash\the\paramno,}%
5723 % These two commands read recursive and nonrecursive macro bodies.
5724 % (They're different since rec and nonrec macros end differently.)
5726 \long\def\parsemacbody#1@end macro%
5727 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5728 \long\def\parsermacbody#1@end rmacro%
5729 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5731 % This defines the macro itself. There are six cases: recursive and
5732 % nonrecursive macros of zero, one, and many arguments.
5733 % Much magic with \expandafter here.
5734 % \xdef is used so that macro definitions will survive the file
5735 % they're defined in; @include reads the file inside a group.
5737 \let\hash=##% convert placeholders to macro parameter chars
5741 \expandafter\xdef\csname\the\macname\endcsname{%
5742 \noexpand\scanmacro{\temp}}%
5744 \expandafter\xdef\csname\the\macname\endcsname{%
5745 \bgroup\noexpand\macroargctxt
5746 \noexpand\braceorline
5747 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5748 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5749 \egroup\noexpand\scanmacro{\temp}}%
5751 \expandafter\xdef\csname\the\macname\endcsname{%
5752 \bgroup\noexpand\macroargctxt
5753 \noexpand\csname\the\macname xx\endcsname}%
5754 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5755 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5756 \expandafter\expandafter
5758 \expandafter\expandafter
5759 \csname\the\macname xxx\endcsname
5760 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5765 \expandafter\xdef\csname\the\macname\endcsname{%
5766 \noexpand\norecurse{\the\macname}%
5767 \noexpand\scanmacro{\temp}\egroup}%
5769 \expandafter\xdef\csname\the\macname\endcsname{%
5770 \bgroup\noexpand\macroargctxt
5771 \noexpand\braceorline
5772 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5773 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5775 \noexpand\norecurse{\the\macname}%
5776 \noexpand\scanmacro{\temp}\egroup}%
5778 \expandafter\xdef\csname\the\macname\endcsname{%
5779 \bgroup\noexpand\macroargctxt
5780 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5781 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5782 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5783 \expandafter\expandafter
5785 \expandafter\expandafter
5786 \csname\the\macname xxx\endcsname
5789 \noexpand\norecurse{\the\macname}%
5790 \noexpand\scanmacro{\temp}\egroup}%
5794 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5796 % \braceorline decides whether the next nonwhitespace character is a
5797 % {. If so it reads up to the closing }, if not, it reads the whole
5798 % line. Whatever was read is then fed to the next control sequence
5799 % as an argument (by \parsebrace or \parsearg)
5800 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5801 \def\braceorlinexxx{%
5802 \ifx\nchar\bgroup\else
5803 \expandafter\parsearg
5806 % We want to disable all macros during \shipout so that they are not
5807 % expanded by \write.
5808 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5809 \edef\next{\macrolist}\expandafter\endgroup\next}
5811 % For \indexnofonts, we need to get rid of all macros, leaving only the
5812 % arguments (if present). Of course this is not nearly correct, but it
5813 % is the best we can do for now. makeinfo does not expand macros in the
5814 % argument to @deffn, which ends up writing an index entry, and texindex
5815 % isn't prepared for an index sort entry that starts with \.
5817 % Since macro invocations are followed by braces, we can just redefine them
5818 % to take a single TeX argument. The case of a macro invocation that
5819 % goes to end-of-line is not handled.
5821 \def\emptyusermacros{\begingroup
5822 \def\do##1{\let\noexpand##1=\noexpand\asis}%
5823 \edef\next{\macrolist}\expandafter\endgroup\next}
5827 % We need some trickery to remove the optional spaces around the equal
5828 % sign. Just make them active and then expand them all to nothing.
5829 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5830 \def\aliasxxx #1{\aliasyyy#1\relax}
5831 \def\aliasyyy #1=#2\relax{%
5833 \expandafter\let\obeyedspace=\empty
5834 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5840 \message{cross references,}
5844 \newif\ifhavexrefs % True if xref values are known.
5845 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5847 % @inforef is relatively simple.
5848 \def\inforef #1{\inforefzzz #1,,,,**}
5849 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5850 node \samp{\ignorespaces#1{}}}
5852 % @node's only job in TeX is to define \lastnode, which is used in
5853 % cross-references. The @node line might or might not have commas, and
5854 % might or might not have spaces before the first comma, like:
5855 % @node foo , bar , ...
5856 % We don't want such trailing spaces in the node name.
5858 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
5860 % also remove a trailing comma, in case of something like this:
5861 % @node Help-Cross, , , Cross-refs
5862 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
5863 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5866 \let\lastnode=\empty
5868 % Write a cross-reference definition for the current node. #1 is the
5869 % type (Ynumbered, Yappendix, Ynothing).
5872 \ifx\lastnode\empty\else
5873 \setref{\lastnode}{#1}%
5874 \global\let\lastnode=\empty
5878 % @anchor{NAME} -- define xref target at arbitrary point.
5880 \newcount\savesfregister
5882 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5883 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5884 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5886 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5887 % anchor), which consists of three parts:
5888 % 1) NAME-title - the current sectioning name taken from \thissection,
5889 % or the anchor name.
5890 % 2) NAME-snt - section number and type, passed as the SNT arg, or
5891 % empty for anchors.
5892 % 3) NAME-pg - the page number.
5894 % This is called from \donoderef, \anchor, and \dofloat. In the case of
5895 % floats, there is an additional part, which is not written here:
5896 % 4) NAME-lof - the text as it should appear in a @listoffloats.
5902 \atdummies % preserve commands, but don't expand them
5905 \edef\writexrdef##1##2{%
5906 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5907 ##1}{##2}}% these are parameters of \writexrdef
5909 \toks0 = \expandafter{\thissection}%
5910 \immediate \writexrdef{title}{\the\toks0 }%
5911 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5912 \writexrdef{pg}{\folio}% will be written later, during \shipout
5917 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5918 % the node name, #2 the name of the Info cross-reference, #3 the printed
5919 % node name, #4 the name of the Info file, #5 the name of the printed
5920 % manual. All but the node name can be omitted.
5922 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5923 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5924 \def\ref#1{\xrefX[#1,,,,,,,]}
5925 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5927 \def\printedmanual{\ignorespaces #5}%
5928 \def\printedrefname{\ignorespaces #3}%
5929 \setbox1=\hbox{\printedmanual\unskip}%
5930 \setbox0=\hbox{\printedrefname\unskip}%
5932 % No printed node name was explicitly given.
5933 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5934 % Use the node name inside the square brackets.
5935 \def\printedrefname{\ignorespaces #1}%
5937 % Use the actual chapter/section title appear inside
5938 % the square brackets. Use the real section title if we have it.
5940 % It is in another manual, so we don't have it.
5941 \def\printedrefname{\ignorespaces #1}%
5944 % We know the real title if we have the xref values.
5945 \def\printedrefname{\refx{#1-title}{}}%
5947 % Otherwise just copy the Info node name.
5948 \def\printedrefname{\ignorespaces #1}%
5954 % Make link in pdf output.
5958 {\turnoffactive \otherbackslash
5959 \ifnum\filenamelength>0
5960 \startlink attr{/Border [0 0 0]}%
5961 goto file{\the\filename.pdf} name{#1}%
5963 \startlink attr{/Border [0 0 0]}%
5964 goto name{\pdfmkpgn{#1}}%
5970 % Float references are printed completely differently: "Figure 1.2"
5971 % instead of "[somenode], p.3". We distinguish them by the
5972 % LABEL-title being set to a magic string.
5974 % Have to otherify everything special to allow the \csname to
5975 % include an _ in the xref name, etc.
5979 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5980 \csname XR#1-title\endcsname
5982 \iffloat\Xthisreftitle
5983 % If the user specified the print name (third arg) to the ref,
5984 % print it instead of our usual "Figure 1.2".
5991 % if the user also gave the printed manual name (fifth arg), append
5994 \space \putwordin{} \cite{\printedmanual}%
5997 % node/anchor (non-float) references.
5999 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6000 % insert empty discretionaries after hyphens, which means that it will
6001 % not find a line break at a hyphen in a node names. Since some manuals
6002 % are best written with fairly long node names, containing hyphens, this
6003 % is a loss. Therefore, we give the text of the node name again, so it
6004 % is as if TeX is seeing it for the first time.
6006 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6008 % _ (for example) has to be the character _ for the purposes of the
6009 % control sequence corresponding to the node, but it has to expand
6010 % into the usual \leavevmode...\vrule stuff for purposes of
6011 % printing. So we \turnoffactive for the \refx-snt, back on for the
6012 % printing, back off for the \refx-pg.
6013 {\turnoffactive \otherbackslash
6014 % Only output a following space if the -snt ref is nonempty; for
6015 % @unnumbered and @anchor, it won't be.
6016 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6017 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6019 % output the `[mynode]' via a macro so it can be overridden.
6020 \xrefprintnodename\printedrefname
6022 % But we always want a comma and a space:
6025 % output the `page 3'.
6026 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
6032 % This macro is called from \xrefX for the `[nodename]' part of xref
6033 % output. It's a separate macro only so it can be changed more easily,
6034 % since square brackets don't work well in some documents. Particularly
6035 % one that Bob is working on :).
6037 \def\xrefprintnodename#1{[#1]}
6039 % Things referred to by \setref.
6045 \putwordChapter@tie \the\chapno
6046 \else \ifnum\subsecno=0
6047 \putwordSection@tie \the\chapno.\the\secno
6048 \else \ifnum\subsubsecno=0
6049 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6051 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6056 \putwordAppendix@tie @char\the\appendixno{}%
6057 \else \ifnum\subsecno=0
6058 \putwordSection@tie @char\the\appendixno.\the\secno
6059 \else \ifnum\subsubsecno=0
6060 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6063 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6067 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6068 % If its value is nonempty, SUFFIX is output afterward.
6074 \expandafter\global\expandafter\let\expandafter\thisrefX
6075 \csname XR#1\endcsname
6078 % If not defined, say something at least.
6079 \angleleft un\-de\-fined\angleright
6082 \message{\linenumber Undefined cross reference `#1'.}%
6085 \global\warnedxrefstrue
6086 \message{Cross reference values unknown; you must run TeX again.}%
6091 % It's defined, so just use it.
6094 #2% Output the suffix in any case.
6097 % This is the macro invoked by entries in the aux file. Usually it's
6098 % just a \def (we prepend XR to the control sequence name to avoid
6099 % collisions). But if this is a float type, we have more work to do.
6102 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6104 % Was that xref control sequence that we just defined for a float?
6105 \expandafter\iffloat\csname XR#1\endcsname
6106 % it was a float, and we have the (safe) float type in \iffloattype.
6107 \expandafter\let\expandafter\floatlist
6108 \csname floatlist\iffloattype\endcsname
6110 % Is this the first time we've seen this float type?
6111 \expandafter\ifx\floatlist\relax
6112 \toks0 = {\do}% yes, so just \do
6114 % had it before, so preserve previous elements in list.
6115 \toks0 = \expandafter{\floatlist\do}%
6118 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6119 % for later use in \listoffloats.
6120 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6124 % Read the last existing aux file, if any. No error if none exists.
6127 \openin 1 \jobname.aux
6130 \global\havexrefstrue
6135 \def\readauxfile{\begingroup
6136 \catcode`\^^@=\other
6137 \catcode`\^^A=\other
6138 \catcode`\^^B=\other
6139 \catcode`\^^C=\other
6140 \catcode`\^^D=\other
6141 \catcode`\^^E=\other
6142 \catcode`\^^F=\other
6143 \catcode`\^^G=\other
6144 \catcode`\^^H=\other
6145 \catcode`\^^K=\other
6146 \catcode`\^^L=\other
6147 \catcode`\^^N=\other
6148 \catcode`\^^P=\other
6149 \catcode`\^^Q=\other
6150 \catcode`\^^R=\other
6151 \catcode`\^^S=\other
6152 \catcode`\^^T=\other
6153 \catcode`\^^U=\other
6154 \catcode`\^^V=\other
6155 \catcode`\^^W=\other
6156 \catcode`\^^X=\other
6157 \catcode`\^^Z=\other
6158 \catcode`\^^[=\other
6159 \catcode`\^^\=\other
6160 \catcode`\^^]=\other
6161 \catcode`\^^^=\other
6162 \catcode`\^^_=\other
6163 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6164 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6165 % supported in the main text, it doesn't seem desirable. Furthermore,
6166 % that is not enough: for node names that actually contain a ^
6167 % character, we would end up writing a line like this: 'xrdef {'hat
6168 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6169 % argument, and \hat is not an expandable control sequence. It could
6170 % all be worked out, but why? Either we support ^^ or we don't.
6172 % The other change necessary for this was to define \auxhat:
6173 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6174 % and then to call \auxhat in \setq.
6178 % Special characters. Should be turned off anyway, but...
6191 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6193 % This is to support \ in node names and titles, since the \
6194 % characters end up in a \csname. It's easier than
6195 % leaving it active and making its active definition an actual \
6196 % character. What I don't understand is why it works in the *value*
6197 % of the xrdef. Seems like it should be a catcode12 \, and that
6198 % should not typeset properly. But it works, so I'm moving on for
6199 % now. --karl, 15jan04.
6202 % Make the characters 128-255 be printing characters.
6206 \catcode\count 1=\other
6207 \advance\count 1 by 1
6208 \ifnum \count 1<256 \loop \fi
6212 % @ is our escape character in .aux files, and we need braces.
6221 \message{insertions,}
6222 % including footnotes.
6224 \newcount \footnoteno
6226 % The trailing space in the following definition for supereject is
6227 % vital for proper filling; pages come out unaligned when you do a
6228 % pagealignmacro call if that space before the closing brace is
6229 % removed. (Generally, numeric constants should always be followed by a
6230 % space to prevent strange expansion errors.)
6231 \def\supereject{\par\penalty -20000\footnoteno =0 }
6233 % @footnotestyle is meaningful for info output only.
6234 \let\footnotestyle=\comment
6238 % Auto-number footnotes. Otherwise like plain.
6240 \let\indent=\ptexindent
6241 \let\noindent=\ptexnoindent
6242 \global\advance\footnoteno by \@ne
6243 \edef\thisfootno{$^{\the\footnoteno}$}%
6245 % In case the footnote comes at the end of a sentence, preserve the
6246 % extra spacing after we do the footnote number.
6248 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6250 % Remove inadvertent blank space before typesetting the footnote number.
6256 % Don't bother with the trickery in plain.tex to not require the
6257 % footnote text as a parameter. Our footnotes don't need to be so general.
6259 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6260 % \parseargline) fails inside footnotes because the tokens are fixed when
6261 % the footnote is read. --karl, 16nov96.
6264 \insert\footins\bgroup
6265 % We want to typeset this text as a normal paragraph, even if the
6266 % footnote reference occurs in (for example) a display environment.
6267 % So reset some parameters.
6269 \interlinepenalty\interfootnotelinepenalty
6270 \splittopskip\ht\strutbox % top baseline for broken footnotes
6271 \splitmaxdepth\dp\strutbox
6272 \floatingpenalty\@MM
6277 \parindent\defaultparindent
6281 % Because we use hanging indentation in footnotes, a @noindent appears
6282 % to exdent this text, so make it be a no-op. makeinfo does not use
6283 % hanging indentation so @noindent can still be needed within footnote
6284 % text after an @example or the like (not that this is good style).
6285 \let\noindent = \relax
6287 % Hang the footnote text off the number. Use \everypar in case the
6288 % footnote extends for more than one paragraph.
6289 \everypar = {\hang}%
6290 \textindent{\thisfootno}%
6292 % Don't crash into the line above the footnote text. Since this
6293 % expands into a box, it must come within the paragraph, lest it
6294 % provide a place where TeX can split the footnote.
6296 \futurelet\next\fo@t
6298 }%end \catcode `\@=11
6300 % In case a @footnote appears in a vbox, save the footnote text and create
6301 % the real \insert just after the vbox finished. Otherwise, the insertion
6303 % Similarily, if a @footnote appears inside an alignment, save the footnote
6304 % text to a box and make the \insert when a row of the table is finished.
6305 % And the same can be done for other insert classes. --kasal, 16nov03.
6307 % Replace the \insert primitive by a cheating macro.
6308 % Deeper inside, just make sure that the saved insertions are not spilled
6311 \def\startsavinginserts{%
6312 \ifx \insert\ptexinsert
6313 \let\insert\saveinsert
6315 \let\checkinserts\relax
6319 % This \insert replacement works for both \insert\footins{foo} and
6320 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6323 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6324 \afterassignment\next
6325 % swallow the left brace
6328 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6329 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6331 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6333 \def\placesaveins#1{%
6334 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6338 % eat @SAVE -- beware, all of them have catcode \other:
6340 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6341 \gdef\gobblesave @SAVE{}
6345 \def\newsaveins #1{%
6346 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6349 \def\newsaveinsX #1{%
6350 \csname newbox\endcsname #1%
6351 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6356 \let\checkinserts\empty
6361 % @image. We use the macros from epsf.tex to support this.
6362 % If epsf.tex is not installed and @image is used, we complain.
6364 % Check for and read epsf.tex up front. If we read it only at @image
6365 % time, we might be inside a group, and then its definitions would get
6366 % undone and the next image would fail.
6367 \openin 1 = epsf.tex
6369 % Do not bother showing banner with epsf.tex v2.7k (available in
6370 % doc/epsf.tex and on ctan).
6371 \def\epsfannounce{\toks0 = }%
6376 % We will only complain once about lack of epsf.tex.
6377 \newif\ifwarnednoepsf
6378 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6379 work. It is also included in the Texinfo distribution, or you can get
6380 it from ftp://tug.org/tex/epsf.tex.}
6383 \ifx\epsfbox\undefined
6384 \ifwarnednoepsf \else
6385 \errhelp = \noepsfhelp
6386 \errmessage{epsf.tex not found, images will be ignored}%
6387 \global\warnednoepsftrue
6390 \imagexxx #1,,,,,\finish
6394 % Arguments to @image:
6395 % #1 is (mandatory) image filename; we tack on .eps extension.
6396 % #2 is (optional) width, #3 is (optional) height.
6397 % #4 is (ignored optional) html alt text.
6398 % #5 is (ignored optional) extension.
6399 % #6 is just the usual extra ignored arg for parsing this stuff.
6401 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6402 \catcode`\^^M = 5 % in case we're inside an example
6403 \normalturnoffactive % allow _ et al. in names
6404 % If the image is by itself, center it.
6408 % Usually we'll have text after the image which will insert
6409 % \parskip glue, so insert it here too to equalize the space
6411 \nobreak\vskip\parskip
6418 \dopdfimage{#1}{#2}{#3}%
6420 % \epsfbox itself resets \epsf?size at each figure.
6421 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6422 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6426 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6430 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6431 % etc. We don't actually implement floating yet, we always include the
6432 % float "here". But it seemed the best name for the future.
6434 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6436 % There may be a space before second and/or third parameter; delete it.
6437 \def\eatcommaspace#1, {#1,}
6439 % #1 is the optional FLOATTYPE, the text label for this float, typically
6440 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6441 % this float will not be numbered and cannot be referred to.
6443 % #2 is the optional xref label. Also must be present for the float to
6446 % #3 is the optional positioning argument; for now, it is ignored. It
6447 % will somehow specify the positions allowed to float to (here, top, bottom).
6449 % We keep a separate counter for each FLOATTYPE, which we reset at each
6450 % chapter-level command.
6451 \let\resetallfloatnos=\empty
6453 \def\dofloat#1,#2,#3,#4\finish{%
6454 \let\thiscaption=\empty
6455 \let\thisshortcaption=\empty
6457 % don't lose footnotes inside @float.
6459 % BEWARE: when the floats start float, we have to issue warning whenever an
6460 % insert appears inside a float which could possibly float. --kasal, 26may04
6464 % We can't be used inside a paragraph.
6469 \def\floatlabel{#2}%
6470 \def\floatloc{#3}% we do nothing with this yet.
6472 \ifx\floattype\empty
6473 \let\safefloattype=\empty
6476 % the floattype might have accents or other special characters,
6477 % but we need to use it in a control sequence name.
6480 \xdef\safefloattype{\floattype}%
6484 % If label is given but no type, we handle that as the empty type.
6485 \ifx\floatlabel\empty \else
6486 % We want each FLOATTYPE to be numbered separately (Figure 1,
6487 % Table 1, Figure 2, ...). (And if no label, no number.)
6489 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6490 \global\advance\floatno by 1
6493 % This magic value for \thissection is output by \setref as the
6494 % XREFLABEL-title value. \xrefX uses it to distinguish float
6495 % labels (which have a completely different output format) from
6496 % node and anchor labels. And \xrdef uses it to construct the
6499 \edef\thissection{\floatmagic=\safefloattype}%
6500 \setref{\floatlabel}{Yfloat}%
6504 % start with \parskip glue, I guess.
6507 % Don't suppress indentation if a float happens to start a section.
6508 \restorefirstparagraphindent
6511 % we have these possibilities:
6512 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6513 % @float Foo,lbl & no caption: Foo 1.1
6514 % @float Foo & @caption{Cap}: Foo: Cap
6515 % @float Foo & no caption: Foo
6516 % @float ,lbl & Caption{Cap}: 1.1: Cap
6517 % @float ,lbl & no caption: 1.1
6518 % @float & @caption{Cap}: Cap
6519 % @float & no caption:
6522 \let\floatident = \empty
6524 % In all cases, if we have a float type, it comes first.
6525 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6527 % If we have an xref label, the number comes next.
6528 \ifx\floatlabel\empty \else
6529 \ifx\floattype\empty \else % if also had float type, need tie first.
6530 \appendtomacro\floatident{\tie}%
6533 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6536 % Start the printed caption with what we've constructed in
6537 % \floatident, but keep it separate; we need \floatident again.
6538 \let\captionline = \floatident
6540 \ifx\thiscaption\empty \else
6541 \ifx\floatident\empty \else
6542 \appendtomacro\captionline{: }% had ident, so need a colon between
6546 \appendtomacro\captionline{\scanexp\thiscaption}%
6549 % If we have anything to print, print it, with space before.
6550 % Eventually this needs to become an \insert.
6551 \ifx\captionline\empty \else
6555 % Space below caption.
6559 % If have an xref label, write the list of floats info. Do this
6560 % after the caption, to avoid chance of it being a breakpoint.
6561 \ifx\floatlabel\empty \else
6562 % Write the text that goes in the lof to the aux file as
6563 % \floatlabel-lof. Besides \floatident, we include the short
6564 % caption if specified, else the full caption if specified, else nothing.
6566 \atdummies \turnoffactive \otherbackslash
6567 % since we read the caption text in the macro world, where ^^M
6568 % is turned into a normal character, we have to scan it back, so
6569 % we don't write the literal three characters "^^M" into the aux file.
6571 \xdef\noexpand\gtemp{%
6572 \ifx\thisshortcaption\empty
6579 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6580 \ifx\gtemp\empty \else : \gtemp \fi}}%
6583 \egroup % end of \vtop
6585 % place the captured inserts
6587 % BEWARE: when the floats start float, we have to issue warning whenever an
6588 % insert appears inside a float which could possibly float. --kasal, 26may04
6593 % Append the tokens #2 to the definition of macro #1, not expanding either.
6595 \def\appendtomacro#1#2{%
6596 \expandafter\def\expandafter#1\expandafter{#1#2}%
6599 % @caption, @shortcaption
6601 \def\caption{\docaption\thiscaption}
6602 \def\shortcaption{\docaption\thisshortcaption}
6603 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6604 \def\defcaption#1#2{\egroup \def#1{#2}}
6606 % The parameter is the control sequence identifying the counter we are
6607 % going to use. Create it if it doesn't exist and assign it to \floatno.
6610 % Haven't seen this figure type before.
6611 \csname newcount\endcsname #1%
6613 % Remember to reset this floatno at the next chap.
6614 \expandafter\gdef\expandafter\resetallfloatnos
6615 \expandafter{\resetallfloatnos #1=0 }%
6620 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6621 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6622 % first read the @float command.
6624 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6626 % Magic string used for the XREFLABEL-title value, so \xrefX can
6627 % distinguish floats from other xref types.
6628 \def\floatmagic{!!float!!}
6630 % #1 is the control sequence we are passed; we expand into a conditional
6631 % which is true if #1 represents a float ref. That is, the magic
6632 % \thissection value which we \setref above.
6634 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6636 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6637 % (safe) float type for this float. We set \iffloattype to #2.
6639 \def\doiffloat#1=#2=#3\finish{%
6641 \def\iffloattype{#2}%
6642 \ifx\temp\floatmagic
6645 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6647 \parseargdef\listoffloats{%
6648 \def\floattype{#1}% floattype
6650 % the floattype might have accents or other special characters,
6651 % but we need to use it in a control sequence name.
6654 \xdef\safefloattype{\floattype}%
6657 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6658 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6660 % if the user said @listoffloats foo but never @float foo.
6661 \message{\linenumber No `\safefloattype' floats to list.}%
6665 \leftskip=\tocindent % indent these entries like a toc
6666 \let\do=\listoffloatsdo
6667 \csname floatlist\safefloattype\endcsname
6672 % This is called on each entry in a list of floats. We're passed the
6673 % xref label, in the form LABEL-title, which is how we save it in the
6674 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6675 % has the text we're supposed to typeset here.
6677 % Figures without xref labels will not be included in the list (since
6678 % they won't appear in the aux file).
6680 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6681 \def\listoffloatsdoentry#1-title\finish{{%
6682 % Can't fully expand XR#1-lof because it can contain anything. Just
6683 % pass the control sequence. On the other hand, XR#1-pg is just the
6684 % page number, and we want to fully expand that so we can get a link
6686 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6688 % use the same \entry macro we use to generate the TOC and index.
6689 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6693 \message{localization,}
6696 % @documentlanguage is usually given very early, just after
6697 % @setfilename. If done too late, it may not override everything
6698 % properly. Single argument is the language abbreviation.
6699 % It would be nice if we could set up a hyphenation file here.
6701 \parseargdef\documentlanguage{%
6702 \tex % read txi-??.tex file in plain TeX.
6703 % Read the file if it exists.
6704 \openin 1 txi-#1.tex
6706 \errhelp = \nolanghelp
6707 \errmessage{Cannot read language file txi-#1.tex}%
6714 \newhelp\nolanghelp{The given language definition file cannot be found or
6715 is empty. Maybe you need to install it? In the current directory
6716 should work if nowhere else does.}
6719 % @documentencoding should change something in TeX eventually, most
6720 % likely, but for now just recognize it.
6721 \let\documentencoding = \comment
6724 % Page size parameters.
6726 \newdimen\defaultparindent \defaultparindent = 15pt
6728 \chapheadingskip = 15pt plus 4pt minus 2pt
6729 \secheadingskip = 12pt plus 3pt minus 2pt
6730 \subsecheadingskip = 9pt plus 2pt minus 2pt
6732 % Prevent underfull vbox error messages.
6735 % Don't be so finicky about underfull hboxes, either.
6738 % Following George Bush, just get rid of widows and orphans.
6742 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6743 % using an old version of TeX, don't do anything. We want the amount of
6744 % stretch added to depend on the line length, hence the dependence on
6745 % \hsize. We call this whenever the paper size is set.
6747 \def\setemergencystretch{%
6748 \ifx\emergencystretch\thisisundefined
6749 % Allow us to assign to \emergencystretch anyway.
6750 \def\emergencystretch{\dimen0}%
6752 \emergencystretch = .15\hsize
6756 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6757 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6758 % physical page width.
6760 % We also call \setleading{\textleading}, so the caller should define
6761 % \textleading. The caller should also set \parskip.
6763 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6766 \splittopskip = \topskip
6769 \advance\vsize by \topskip
6770 \outervsize = \vsize
6771 \advance\outervsize by 2\topandbottommargin
6772 \pageheight = \vsize
6775 \outerhsize = \hsize
6776 \advance\outerhsize by 0.5in
6779 \normaloffset = #4\relax
6780 \bindingoffset = #5\relax
6783 \pdfpageheight #7\relax
6784 \pdfpagewidth #8\relax
6787 \setleading{\textleading}
6789 \parindent = \defaultparindent
6790 \setemergencystretch
6793 % @letterpaper (the default).
6794 \def\letterpaper{{\globaldefs = 1
6795 \parskip = 3pt plus 2pt minus 1pt
6796 \textleading = 13.2pt
6798 % If page is nothing but text, make it come out even.
6799 \internalpagesizes{46\baselineskip}{6in}%
6801 {\bindingoffset}{36pt}%
6805 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6806 \def\smallbook{{\globaldefs = 1
6807 \parskip = 2pt plus 1pt
6810 \internalpagesizes{7.5in}{5in}%
6812 {\bindingoffset}{16pt}%
6815 \lispnarrowing = 0.3in
6818 \contentsrightmargin = 0pt
6819 \defbodyindent = .5cm
6822 % Use @afourpaper to print on European A4 paper.
6823 \def\afourpaper{{\globaldefs = 1
6824 \parskip = 3pt plus 2pt minus 1pt
6825 \textleading = 13.2pt
6827 % Double-side printing via postscript on Laserjet 4050
6828 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6829 % To change the settings for a different printer or situation, adjust
6830 % \normaloffset until the front-side and back-side texts align. Then
6831 % do the same for \bindingoffset. You can set these for testing in
6832 % your texinfo source file like this:
6834 % \global\normaloffset = -6mm
6835 % \global\bindingoffset = 10mm
6837 \internalpagesizes{51\baselineskip}{160mm}
6838 {\voffset}{\hoffset}%
6839 {\bindingoffset}{44pt}%
6844 \contentsrightmargin = 0pt
6845 \defbodyindent = 5mm
6848 % Use @afivepaper to print on European A5 paper.
6849 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6850 % He also recommends making @example and @lisp be small.
6851 \def\afivepaper{{\globaldefs = 1
6852 \parskip = 2pt plus 1pt minus 0.1pt
6853 \textleading = 12.5pt
6855 \internalpagesizes{160mm}{120mm}%
6856 {\voffset}{\hoffset}%
6857 {\bindingoffset}{8pt}%
6860 \lispnarrowing = 0.2in
6863 \contentsrightmargin = 0pt
6864 \defbodyindent = 2mm
6868 % A specific text layout, 24x15cm overall, intended for A4 paper.
6869 \def\afourlatex{{\globaldefs = 1
6871 \internalpagesizes{237mm}{150mm}%
6873 {\bindingoffset}{7mm}%
6876 % Must explicitly reset to 0 because we call \afourpaper.
6880 % Use @afourwide to print on A4 paper in landscape format.
6881 \def\afourwide{{\globaldefs = 1
6883 \internalpagesizes{241mm}{165mm}%
6884 {\voffset}{-2.95mm}%
6885 {\bindingoffset}{7mm}%
6890 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6891 % Perhaps we should allow setting the margins, \topskip, \parskip,
6892 % and/or leading, also. Or perhaps we should compute them somehow.
6894 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6895 \def\pagesizesyyy#1,#2,#3\finish{{%
6896 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6899 \parskip = 3pt plus 2pt minus 1pt
6900 \setleading{\textleading}%
6903 \advance\dimen0 by \voffset
6906 \advance\dimen2 by \normaloffset
6908 \internalpagesizes{#1}{\hsize}%
6909 {\voffset}{\normaloffset}%
6910 {\bindingoffset}{44pt}%
6914 % Set default to letter.
6919 \message{and turning on texinfo input format.}
6921 % Define macros to output various characters with catcode for normal text.
6931 \def\normaldoublequote{"}
6934 \def\normalunderscore{_}
6935 \def\normalverticalbar{|}
6937 \def\normalgreater{>}
6939 \def\normaldollar{$}%$ font-lock fix
6941 % This macro is used to make a character print one way in \tt
6942 % (where it can probably be output as-is), and another way in other fonts,
6943 % where something hairier probably needs to be done.
6945 % #1 is what to print if we are indeed using \tt; #2 is what to print
6946 % otherwise. Since all the Computer Modern typewriter fonts have zero
6947 % interword stretch (and shrink), and it is reasonable to expect all
6948 % typewriter fonts to have this, we can check that font parameter.
6950 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6952 % Same as above, but check for italic font. Actually this also catches
6953 % non-italic slanted fonts since it is impossible to distinguish them from
6954 % italic fonts. But since this is only used by $ and it uses \sl anyway
6955 % this is not a problem.
6956 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6958 % Turn off all special characters except @
6959 % (and those which the user can use as if they were ordinary).
6960 % Most of these we simply print from the \tt font, but for some, we can
6961 % use math or other variants that look better in normal text.
6964 \def\activedoublequote{{\tt\char34}}
6965 \let"=\activedoublequote
6967 \def~{{\tt\char126}}
6973 \def_{\ifusingtt\normalunderscore\_}
6974 % Subroutine for the previous macro.
6975 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6978 \def|{{\tt\char124}}
6986 \def+{{\tt \char 43}}
6988 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6990 % If a .fmt file is being used, characters that might appear in a file
6991 % name cannot be active until we have parsed the command line.
6992 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6993 % \otherifyactive is called near the end of this file.
6994 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6998 % \backslashcurfont outputs one backslash character in current font,
7000 \global\chardef\backslashcurfont=`\\
7001 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7003 % \rawbackslash defines an active \ to do \backslashcurfont.
7004 % \otherbackslash defines an active \ to be a literal `\' character with
7006 {\catcode`\\=\active
7007 @gdef@rawbackslash{@let\=@backslashcurfont}
7008 @gdef@otherbackslash{@let\=@realbackslash}
7011 % \realbackslash is an actual character `\' with catcode other.
7012 {\catcode`\\=\other @gdef@realbackslash{\}}
7014 % \normalbackslash outputs one backslash in fixed width font.
7015 \def\normalbackslash{{\tt\backslashcurfont}}
7019 % Used sometimes to turn off (effectively) the active characters
7020 % even after parsing them.
7021 @def@turnoffactive{%
7022 @let"=@normaldoublequote
7023 @let\=@realbackslash
7026 @let_=@normalunderscore
7027 @let|=@normalverticalbar
7029 @let>=@normalgreater
7031 @let$=@normaldollar %$ font-lock fix
7035 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7036 % the literal character `\'. (Thus, \ is not expandable when this is in
7039 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
7041 % Make _ and + \other characters, temporarily.
7042 % This is canceled by @fixbackslash.
7045 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7046 % That is what \eatinput is for; after that, the `\' should revert to printing
7049 @gdef@eatinput input texinfo{@fixbackslash}
7050 @global@let\ = @eatinput
7052 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7053 % the first `\{ in the file would cause an error. This macro tries to fix
7054 % that, assuming it is called before the first `\' could plausibly occur.
7055 % Also back turn on active characters that might appear in the input
7056 % file name, in case not using a pre-dumped format.
7058 @gdef@fixbackslash{%
7059 @ifx\@eatinput @let\ = @normalbackslash @fi
7064 % Say @foo, not \foo, in error messages.
7067 % These look ok in all fonts, so just make them not special.
7068 @catcode`@& = @other
7069 @catcode`@# = @other
7070 @catcode`@% = @other
7074 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7075 @c page-delimiter: "^\\\\message"
7076 @c time-stamp-start: "def\\\\texinfoversion{"
7077 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7078 @c time-stamp-end: "}"
7084 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115