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{2006-02-13.16}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10 % Software Foundation, Inc.
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 2, 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; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
164 % The following is used inside several \edef's.
165 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
169 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
170 ap-pen-dix bit-map bit-maps
171 data-base data-bases eshell fall-ing half-way long-est man-u-script
172 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
173 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
175 stand-alone strong-est time-stamp time-stamps which-ever white-space
176 wide-spread wrap-around
179 % Margin to add to right of even pages, to left of odd pages.
180 \newdimen\bindingoffset
181 \newdimen\normaloffset
182 \newdimen\pagewidth \newdimen\pageheight
184 % For a final copy, take out the rectangles
185 % that mark overfull boxes (in case you have decided
186 % that the text looks ok even though it passes the margin).
188 \def\finalout{\overfullrule=0pt}
190 % @| inserts a changebar to the left of the current line. It should
191 % surround any changed text. This approach does *not* work if the
192 % change spans more than two lines of output. To handle that, we would
193 % have adopt a much more difficult approach (putting marks into the main
194 % vertical list for the beginning and end of each change).
197 % \vadjust can only be used in horizontal mode.
200 % Append this vertical mode material after the current line in the output.
202 % We want to insert a rule with the height and depth of the current
203 % leading; that is exactly what \strutbox is supposed to record.
206 % \vadjust-items are inserted at the left edge of the type. So
207 % the \llap here moves out into the left-hand margin.
210 % For a thicker or thinner bar, change the `1pt'.
211 \vrule height\baselineskip width1pt
213 % This is the space between the bar and the text.
219 % Sometimes it is convenient to have everything in the transcript file
220 % and nothing on the terminal. We don't just call \tracingall here,
221 % since that produces some useless output on the terminal. We also make
222 % some effort to order the tracing commands to reduce output in the log
223 % file; cf. trace.sty in LaTeX.
225 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
229 \tracinglostchars2 % 2 gives us more in etex
234 \showboxbreadth\maxdimen \showboxdepth\maxdimen
235 \ifx\eTeXversion\undefined\else % etex gives us more logging
242 \tracingcommands3 % 3 gives us more in etex
246 % add check for \lastpenalty to plain's definitions. If the last thing
247 % we did was a \nobreak, we don't want to insert more space.
249 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
250 \removelastskip\penalty-50\smallskip\fi\fi}
251 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
252 \removelastskip\penalty-100\medskip\fi\fi}
253 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
254 \removelastskip\penalty-200\bigskip\fi\fi}
256 % For @cropmarks command.
257 % Do @cropmarks to get crop marks.
260 \let\cropmarks = \cropmarkstrue
262 % Dimensions to add cropmarks at corners.
263 % Added by P. A. MacKay, 12 Nov. 1986
265 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
266 \newdimen\cornerlong \cornerlong=1pc
267 \newdimen\cornerthick \cornerthick=.3pt
268 \newdimen\topandbottommargin \topandbottommargin=.75in
270 % Main output routine.
272 \output = {\onepageout{\pagecontents\PAGE}}
277 % \onepageout takes a vbox as an argument. Note that \pagecontents
278 % does insertions, but you have to call it yourself.
280 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
282 \ifodd\pageno \advance\hoffset by \bindingoffset
283 \else \advance\hoffset by -\bindingoffset\fi
285 % Do this outside of the \shipout so @code etc. will be expanded in
286 % the headline as they should be, not taken literally (outputting ''code).
287 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
288 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
291 % Have to do this stuff outside the \shipout because we want it to
292 % take effect in \write's, yet the group defined by the \vbox ends
293 % before the \shipout runs.
295 \indexdummies % don't expand commands in the output.
296 \normalturnoffactive % \ in index entries must not stay \, e.g., if
297 % the page break happens to be in the middle of an example.
298 % We don't want .vr (or whatever) entries like this:
299 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
300 % "\acronym" won't work when it's read back in;
302 % {\code {{\tt \backslashcurfont }acronym}
304 % Do this early so pdf references go to the beginning of the page.
305 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
307 \ifcropmarks \vbox to \outervsize\bgroup
309 \vskip-\topandbottommargin
311 \line{\ewtop\hfil\ewtop}%
314 \vbox{\moveleft\cornerthick\nstop}%
316 \vbox{\moveright\cornerthick\nstop}%
319 \vskip\topandbottommargin
321 \hfil % center the page within the outer (page) hsize.
322 \ifodd\pageno\hskip\bindingoffset\fi
328 \ifdim\ht\footlinebox > 0pt
329 % Only leave this space if the footline is nonempty.
330 % (We lessened \vsize for it in \oddfootingxxx.)
331 % The \baselineskip=24pt in plain's \makefootline has no effect.
332 \vskip 2\baselineskip
337 \egroup % end of \vbox\bgroup
338 \hfil\egroup % end of (centering) \line\bgroup
339 \vskip\topandbottommargin plus1fill minus1fill
340 \boxmaxdepth = \cornerthick
343 \vbox{\moveleft\cornerthick\nsbot}%
345 \vbox{\moveright\cornerthick\nsbot}%
348 \line{\ewbot\hfil\ewbot}%
350 \egroup % \vbox from first cropmarks clause
352 }% end of \shipout\vbox
353 }% end of group with \indexdummies
355 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 \newinsert\margin \dimen\margin=\maxdimen
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
362 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363 % marginal hacks, juha@viisa.uucp (Juha Takala)
364 \ifvoid\margin\else % marginal info is present
365 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366 \dimen@=\dp#1 \unvbox#1
367 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 % Here are the rules for the cropmarks. Note that they are
372 % offset so that the space between them is truly \outerhsize or \outervsize
373 % (P. A. MacKay, 12 November, 1986)
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
377 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
380 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
382 % Parse an argument, then pass it to #1. The argument is the rest of
383 % the input line (except we remove a trailing comment). #1 should be a
384 % macro which expects an ordinary undelimited TeX argument.
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
393 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
397 \gdef\parseargline#1^^M{%
398 \endgroup % End of the group started in \parsearg.
399 \argremovecomment #1\comment\ArgTerm%
403 % First remove any @comment, then any @c comment.
404 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
407 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
409 % \argremovec might leave us with trailing space, e.g.,
410 % @end itemize @c foo
411 % This space token undergoes the same procedure and is eventually removed
412 % by \finishparsearg.
414 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
419 % We cannot use \next here, as it holds the macro to run;
420 % thus we reuse \temp.
421 \let\temp\finishparsearg
423 \let\temp\argcheckspaces
425 % Put the space token in:
429 % If a _delimited_ argument is enclosed in braces, they get stripped; so
430 % to get _exactly_ the rest of the line, we had to prevent such situation.
431 % We prepended an \empty token at the very beginning and we expand it now,
432 % just before passing the control to \next.
433 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
434 % either the null string, or it ends with \^^M---thus there is no danger
435 % that a pair of braces would be stripped.
437 % But first, we have to remove the trailing space token.
439 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
441 % \parseargdef\foo{...}
442 % is roughly equivalent to
443 % \def\foo{\parsearg\Xfoo}
446 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
447 % favourite TeX trick. --kasal, 16nov03
450 \expandafter \doparseargdef \csname\string#1\endcsname #1%
452 \def\doparseargdef#1#2{%
457 % Several utility definitions with active space:
462 % Make each space character in the input produce a normal interword
463 % space in the output. Don't allow a line break at this space, as this
464 % is used only in environments like @example, where each line of input
465 % should produce a line of output anyway.
467 \gdef\sepspaces{\obeyspaces\let =\tie}
469 % If an index command is used in an @example environment, any spaces
470 % therein should become regular spaces in the raw index file, not the
471 % expansion of \tie (\leavevmode \penalty \@M \ ).
472 \gdef\unsepspaces{\let =\space}
476 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
478 % Define the framework for environments in texinfo.tex. It's used like this:
483 % It's the responsibility of \envdef to insert \begingroup before the
484 % actual body; @end closes the group after calling \Efoo. \envdef also
485 % defines \thisenv, so the current environment is known; @end checks
486 % whether the environment name matches. The \checkenv macro can also be
487 % used to check whether the current environment is the one expected.
489 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
490 % are not treated as enviroments; they don't open a group. (The
491 % implementation of @end takes care not to call \endgroup in this
495 % At runtime, environments start with this:
496 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
500 % ... but they get defined via ``\envdef\foo{...}'':
501 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
502 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
504 % Check whether we're in the right environment:
513 % Evironment mismatch, #1 expected:
516 \errmessage{This command can appear only \inenvironment\temp,
517 not \inenvironment\thisenv}%
519 \def\inenvironment#1{%
521 out of any environment%
523 in environment \expandafter\string#1%
527 % @end foo executes the definition of \Efoo.
528 % But first, it executes a specialized version of \checkenv
531 \if 1\csname iscond.#1\endcsname
533 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
534 \expandafter\checkenv\csname#1\endcsname
535 \csname E#1\endcsname
540 \newhelp\EMsimple{Press RETURN to continue.}
543 %% Simple single-character @ commands
546 % Kludge this until the fonts are right (grr).
549 % This is turned off because it was never documented
550 % and you can use @w{...} around a quote to suppress ligatures.
551 %% Define @` and @' to be the same as ` and '
552 %% but suppressing ligatures.
556 % Used to generate quoted braces.
557 \def\mylbrace {{\tt\char123}}
558 \def\myrbrace {{\tt\char125}}
562 % Definitions to produce \{ and \} commands for indices,
563 % and @{ and @} for the aux/toc files.
564 \catcode`\{ = \other \catcode`\} = \other
565 \catcode`\[ = 1 \catcode`\] = 2
566 \catcode`\! = 0 \catcode`\\ = \other
569 !gdef!lbraceatcmd[@{]%
570 !gdef!rbraceatcmd[@}]%
573 % @comma{} to avoid , parsing problems.
576 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
577 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
580 \def\ringaccent#1{{\accent23 #1}}
585 % Other special characters: @questiondown @exclamdown @ordf @ordm
586 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
587 \def\questiondown{?`}
589 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
590 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
592 % Dotless i and dotless j, used for accents.
597 \ifx\temp\imacro \ptexi
598 \else\ifx\temp\jmacro \j
599 \else \errmessage{@dotless can be used only with i or j}%
603 % The \TeX{} logo, as in plain, but resetting the spacing so that a
604 % period following counts as ending a sentence. (Idea found in latex.)
606 \edef\TeX{\TeX \spacefactor=1000 }
608 % @LaTeX{} logo. Not quite the same results as the definition in
609 % latex.ltx, since we use a different font for the raised A; it's most
610 % convenient for us to use an explicitly smaller font, rather than using
611 % the \scriptstyle font (since we don't reset \scriptstyle and
612 % \scriptscriptstyle).
617 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
622 % Be sure we're in horizontal mode when doing a tie, since we make space
623 % equivalent to this in @example-like environments. Otherwise, a space
624 % at the beginning of a line will start with \penalty -- and
625 % since \penalty is valid in vertical mode, we'd end up putting the
626 % penalty on the vertical list instead of in the new paragraph.
628 % Avoid using \@M directly, because that causes trouble
629 % if the definition is written into an index file.
630 \global\let\tiepenalty = \@M
631 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
634 % @: forces normal size whitespace following.
635 \def\:{\spacefactor=1000 }
637 % @* forces a line break.
638 \def\*{\hfil\break\hbox{}\ignorespaces}
640 % @/ allows a line break.
643 % @. is an end-of-sentence period.
644 \def\.{.\spacefactor=\endofsentencespacefactor\space}
646 % @! is an end-of-sentence bang.
647 \def\!{!\spacefactor=\endofsentencespacefactor\space}
649 % @? is an end-of-sentence query.
650 \def\?{?\spacefactor=\endofsentencespacefactor\space}
652 % @frenchspacing on|off says whether to put extra space after punctuation.
657 \parseargdef\frenchspacing{%
659 \ifx\temp\onword \plainfrenchspacing
660 \else\ifx\temp\offword \plainnonfrenchspacing
663 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
667 % @w prevents a word break. Without the \leavevmode, @w at the
668 % beginning of a paragraph, when TeX is still in vertical mode, would
669 % produce a whole line of output instead of starting the paragraph.
670 \def\w#1{\leavevmode\hbox{#1}}
672 % @group ... @end group forces ... to be all on one page, by enclosing
673 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
674 % to keep its height that of a normal line. According to the rules for
675 % \topskip (p.114 of the TeXbook), the glue inserted is
676 % max (\topskip - \ht (first item), 0). If that height is large,
677 % therefore, no glue is inserted, and the space between the headline and
678 % the text is small, which looks bad.
680 % Another complication is that the group might be very large. This can
681 % cause the glue on the previous page to be unduly stretched, because it
682 % does not have much material. In this case, it's better to add an
683 % explicit \vfill so that the extra space is at the bottom. The
684 % threshold for doing this is if the group is more than \vfilllimit
685 % percent of a page (\vfilllimit can be changed inside of @tex).
691 \ifnum\catcode`\^^M=\active \else
692 \errhelp = \groupinvalidhelp
693 \errmessage{@group invalid in context where filling is enabled}%
697 \setbox\groupbox = \vtop\bgroup
698 % Do @comment since we are called inside an environment such as
699 % @example, where each end-of-line in the input causes an
700 % end-of-line in the output. We don't want the end-of-line after
701 % the `@group' to put extra space in the output. Since @group
702 % should appear on a line by itself (according to the Texinfo
703 % manual), we don't worry about eating any user text.
707 % The \vtop produces a box with normal height and large depth; thus, TeX puts
708 % \baselineskip glue before it, and (when the next line of text is done)
709 % \lineskip glue after it. Thus, space below is not quite equal to space
710 % above. But it's pretty close.
712 % To get correct interline space between the last line of the group
713 % and the first line afterwards, we have to propagate \prevdepth.
714 \endgraf % Not \par, as it may have been set to \lisppar.
715 \global\dimen1 = \prevdepth
716 \egroup % End the \vtop.
717 % \dimen0 is the vertical size of the group's box.
718 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
719 % \dimen2 is how much space is left on the page (more or less).
720 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
721 % if the group doesn't fit on the current page, and it's a big big
722 % group, force a page break.
723 \ifdim \dimen0 > \dimen2
724 \ifdim \pagetotal < \vfilllimit\pageheight
733 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
734 % message, so this ends up printing `@group can only ...'.
736 \newhelp\groupinvalidhelp{%
737 group can only be used in environments such as @example,^^J%
738 where each line of input produces a line of output.}
740 % @need space-in-mils
741 % forces a page break if there is not space-in-mils remaining.
743 \newdimen\mil \mil=0.001in
745 % Old definition--didn't work.
746 %\parseargdef\need{\par %
747 %% This method tries to make TeX break the page naturally
748 %% if the depth of the box does not fit.
750 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
755 % Ensure vertical mode, so we don't make a big box in the middle of a
759 % If the @need value is less than one line space, it's useless.
761 \dimen2 = \ht\strutbox
762 \advance\dimen2 by \dp\strutbox
763 \ifdim\dimen0 > \dimen2
765 % Do a \strut just to make the height of this box be normal, so the
766 % normal leading is inserted relative to the preceding line.
767 % And a page break here is fine.
768 \vtop to #1\mil{\strut\vfil}%
770 % TeX does not even consider page breaks if a penalty added to the
771 % main vertical list is 10000 or more. But in order to see if the
772 % empty box we just added fits on the page, we must make it consider
773 % page breaks. On the other hand, we don't want to actually break the
774 % page after the empty box. So we use a penalty of 9999.
776 % There is an extremely small chance that TeX will actually break the
777 % page at this \penalty, if there are no other feasible breakpoints in
778 % sight. (If the user is using lots of big @group commands, which
779 % almost-but-not-quite fill up a page, TeX will have a hard time doing
780 % good page breaking, for example.) However, I could not construct an
781 % example where a page broke at this \penalty; if it happens in a real
782 % document, then we can reconsider our strategy.
785 % Back up by the size of the box, whether we did a page break or not.
788 % Do not allow a page break right after this kern.
793 % @br forces paragraph break (and is undocumented).
797 % @page forces the start of a new page.
799 \def\page{\par\vfill\supereject}
802 % outputs text on separate line in roman font, starting at standard page margin
804 % This records the amount of indent in the innermost environment.
805 % That's how much \exdent should take out.
806 \newskip\exdentamount
808 % This defn is used inside fill environments such as @defun.
809 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
811 % This defn is used inside nofill environments such as @example.
812 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
813 \leftline{\hskip\leftskip{\rm#1}}}}
815 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
816 % paragraph. For more general purposes, use the \margin insertion
817 % class. WHICH is `l' or `r'.
819 \newskip\inmarginspacing \inmarginspacing=1cm
820 \def\strutdepth{\dp\strutbox}
822 \def\doinmargin#1#2{\strut\vadjust{%
825 \vtop to \strutdepth{%
826 \baselineskip=\strutdepth
828 % if you have multiple lines of stuff to put here, you'll need to
829 % make the vbox yourself of the appropriate size.
831 \llap{\ignorespaces #2\hskip\inmarginspacing}%
833 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
838 \def\inleftmargin{\doinmargin l}
839 \def\inrightmargin{\doinmargin r}
841 % @inmargin{TEXT [, RIGHT-TEXT]}
842 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
843 % else use TEXT for both).
845 \def\inmargin#1{\parseinmargin #1,,\finish}
846 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
847 \setbox0 = \hbox{\ignorespaces #2}%
849 \def\lefttext{#1}% have both texts
852 \def\lefttext{#1}% have only one text
857 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
859 \def\temp{\inleftmargin\lefttext}%
864 % @include file insert text of that file as input.
866 \def\include{\parseargusing\filenamecatcodes\includezzz}
872 \def\temp{\input #1 }%
877 \def\filenamecatcodes{%
889 \def\pushthisfilestack{%
890 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
892 \def\pushthisfilestackX{%
893 \expandafter\pushthisfilestackY\thisfile\StackTerm
895 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
896 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
899 \def\popthisfilestack{\errthisfilestackempty}
900 \def\errthisfilestackempty{\errmessage{Internal error:
901 the stack of filenames is empty.}}
906 % outputs that line, centered.
908 \parseargdef\center{%
914 \next{\hfil \ignorespaces#1\unskip \hfil}%
919 \advance\hsize by -\leftskip
920 \advance\hsize by -\rightskip
925 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
927 % @sp n outputs n lines of vertical space
929 \parseargdef\sp{\vskip #1\baselineskip}
931 % @comment ...line which is ignored...
932 % @c is the same as @comment
933 % @ignore ... @end ignore is another way to write a comment
935 \def\comment{\begingroup \catcode`\^^M=\other%
936 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
938 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
942 % @paragraphindent NCHARS
943 % We'll use ems for NCHARS, close enough.
944 % NCHARS can also be the word `asis' or `none'.
945 % We cannot feasibly implement @paragraphindent asis, though.
947 \def\asisword{asis} % no translation, these are keywords
950 \parseargdef\paragraphindent{%
955 \defaultparindent = 0pt
957 \defaultparindent = #1em
960 \parindent = \defaultparindent
963 % @exampleindent NCHARS
964 % We'll use ems for NCHARS like @paragraphindent.
965 % It seems @exampleindent asis isn't necessary, but
966 % I preserve it to make it similar to @paragraphindent.
967 \parseargdef\exampleindent{%
974 \lispnarrowing = #1em
979 % @firstparagraphindent WORD
980 % If WORD is `none', then suppress indentation of the first paragraph
981 % after a section heading. If WORD is `insert', then do indent at such
984 % The paragraph indentation is suppressed or not by calling
985 % \suppressfirstparagraphindent, which the sectioning commands do.
986 % We switch the definition of this back and forth according to WORD.
987 % By default, we suppress indentation.
989 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
990 \def\insertword{insert}
992 \parseargdef\firstparagraphindent{%
995 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
996 \else\ifx\temp\insertword
997 \let\suppressfirstparagraphindent = \relax
1000 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1004 % Here is how we actually suppress indentation. Redefine \everypar to
1005 % \kern backwards by \parindent, and then reset itself to empty.
1007 % We also make \indent itself not actually do anything until the next
1010 \gdef\dosuppressfirstparagraphindent{%
1012 \restorefirstparagraphindent
1016 \restorefirstparagraphindent
1019 \global\everypar = {%
1021 \restorefirstparagraphindent
1025 \gdef\restorefirstparagraphindent{%
1026 \global \let \indent = \ptexindent
1027 \global \let \noindent = \ptexnoindent
1028 \global \everypar = {}%
1032 % @asis just yields its argument. Used with @table, for example.
1036 % @math outputs its argument in math mode.
1038 % One complication: _ usually means subscripts, but it could also mean
1039 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1040 % _ active, and distinguish by seeing if the current family is \slfam,
1041 % which is what @var uses.
1043 \catcode`\_ = \active
1044 \gdef\mathunderscore{%
1046 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1049 % Another complication: we want \\ (and @\) to output a \ character.
1050 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1051 % this is not advertised and we don't care. Texinfo does not
1052 % otherwise define @\.
1054 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1055 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1060 \let\\ = \mathbackslash
1064 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1066 % Some active characters (such as <) are spaced differently in math.
1067 % We have to reset their definitions in case the @math was an argument
1068 % to a command which sets the catcodes (such as @item or @section).
1071 \catcode`^ = \active
1072 \catcode`< = \active
1073 \catcode`> = \active
1074 \catcode`+ = \active
1083 % @bullet and @minus need the same treatment as @math, just above.
1084 \def\bullet{$\ptexbullet$}
1087 % @dots{} outputs an ellipsis using the current font.
1088 % We do .5em per period so that it has the same spacing in a typewriter
1089 % font as three actual period characters.
1094 \hskip 0pt plus 0.25fil
1096 \hskip 0pt plus 0.5fil
1100 % @enddots{} is an end-of-sentence ellipsis.
1104 \spacefactor=\endofsentencespacefactor
1107 % @comma{} is so commas can be inserted into text without messing up
1108 % Texinfo's parsing.
1112 % @refill is a no-op.
1115 % If working on a large document in chapters, it is convenient to
1116 % be able to disable indexing, cross-referencing, and contents, for test runs.
1117 % This is done with @novalidate (before @setfilename).
1119 \newif\iflinks \linkstrue % by default we want the aux files.
1120 \let\novalidate = \linksfalse
1122 % @setfilename is done at the beginning of every texinfo file.
1123 % So open here the files we need to have open while reading the input.
1124 % This makes it possible to make a .fmt file for texinfo.
1126 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1129 % Open the new aux file. TeX will close it automatically at exit.
1130 \immediate\openout\auxfile=\jobname.aux
1131 \fi % \openindices needs to do some work in any case.
1133 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1135 % If texinfo.cnf is present on the system, read it.
1136 % Useful for site-wide @afourpaper, etc.
1137 \openin 1 texinfo.cnf
1138 \ifeof 1 \else \input texinfo.cnf \fi
1141 \comment % Ignore the actual filename.
1144 % Called from \setfilename.
1156 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1160 % adobe `portable' document format
1164 \newcount\filenamelength
1173 \newif\ifpdfmakepagedest
1175 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1176 % can be set). So we test for \relax and 0 as well as \undefined,
1177 % borrowed from ifpdf.sty.
1178 \ifx\pdfoutput\undefined
1180 \ifx\pdfoutput\relax
1189 % PDF uses PostScript string constants for the names of xref targets,
1190 % for display in the outlines, and in other places. Thus, we have to
1191 % double any backslashes. Otherwise, a name like "\node" will be
1192 % interpreted as a newline (\n), followed by o, d, e. Not good.
1193 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1194 % (and related messages, the final outcome is that it is up to the TeX
1195 % user to double the backslashes and otherwise make the string valid, so
1196 % that's what we do).
1198 % double active backslashes.
1200 {\catcode`\@=0 \catcode`\\=\active
1201 @gdef@activebackslashdouble{%
1203 @let\=@doublebackslash}
1206 % To handle parens, we must adopt a different approach, since parens are
1207 % not active characters. hyperref.dtx (which has the same problem as
1208 % us) handles it with this amazing macro to replace tokens. I've
1209 % tinkered with it a little for texinfo, but it's definitely from there.
1211 % #1 is the tokens to replace.
1212 % #2 is the replacement.
1213 % #3 is the control sequence with the string.
1215 \def\HyPsdSubst#1#2#3{%
1216 \def\HyPsdReplace##1#1##2\END{%
1222 \HyPsdReplace##2\END
1226 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1228 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1230 % #1 is a control sequence in which to do the replacements.
1231 \def\backslashparens#1{%
1232 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1233 % \lastnode when called from \setref -> \pdfmkdest.
1234 \HyPsdSubst{(}{\realbackslash(}{#1}%
1235 \HyPsdSubst{)}{\realbackslash)}{#1}%
1240 \pdfcatalog{/PageMode /UseOutlines}%
1241 \def\dopdfimage#1#2#3{%
1242 \def\imagewidth{#2}%
1243 \def\imageheight{#3}%
1244 % without \immediate, pdftex seg faults when the same image is
1245 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1246 \ifnum\pdftexversion < 14
1249 \immediate\pdfximage
1251 \ifx\empty\imagewidth\else width \imagewidth \fi
1252 \ifx\empty\imageheight\else height \imageheight \fi
1253 \ifnum\pdftexversion<13
1258 \ifnum\pdftexversion < 14 \else
1259 \pdfrefximage \pdflastximage
1262 % We have to set dummies so commands such as @code, and characters
1263 % such as \, aren't expanded when present in a section title.
1265 \activebackslashdouble
1266 \def\pdfdestname{#1}%
1267 \backslashparens\pdfdestname
1268 \pdfdest name{\pdfdestname} xyz%
1271 % used to mark target names; must be expandable.
1272 \def\pdfmkpgn#1{#1}%
1274 \let\linkcolor = \Blue % was Cyan, but that seems light?
1275 \def\endlink{\Black\pdfendlink}
1276 % Adding outlines to PDF; macros for calculating structure of outlines
1277 % come from Petr Olsak
1278 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1279 \else \csname#1\endcsname \fi}
1280 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1281 \advance\tempnum by 1
1282 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1284 % #1 is the section text, which is what will be displayed in the
1285 % outline by the pdf viewer. #2 is the pdf expression for the number
1286 % of subentries (or empty, for subsubsections). #3 is the node text,
1287 % which might be empty if this toc entry had no corresponding node.
1288 % #4 is the page number
1290 \def\dopdfoutline#1#2#3#4{%
1291 % Generate a link to the node text if that exists; else, use the
1292 % page number. We could generate a destination for the section
1293 % text in the case where a section has no node, but it doesn't
1294 % seem worth the trouble, since most documents are normally structured.
1295 \def\pdfoutlinedest{#3}%
1296 \ifx\pdfoutlinedest\empty
1297 \def\pdfoutlinedest{#4}%
1299 % Doubled backslashes in the name.
1300 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1301 \backslashparens\pdfoutlinedest}%
1304 % Also double the backslashes in the display string.
1305 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1306 \backslashparens\pdfoutlinetext}%
1308 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1311 \def\pdfmakeoutlines{%
1313 % Thanh's hack / proper braces in bookmarks
1314 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1315 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1317 % Read toc silently, to get counts of subentries for \pdfoutline.
1318 \def\numchapentry##1##2##3##4{%
1319 \def\thischapnum{##2}%
1321 \def\thissubsecnum{0}%
1323 \def\numsecentry##1##2##3##4{%
1324 \advancenumber{chap\thischapnum}%
1325 \def\thissecnum{##2}%
1326 \def\thissubsecnum{0}%
1328 \def\numsubsecentry##1##2##3##4{%
1329 \advancenumber{sec\thissecnum}%
1330 \def\thissubsecnum{##2}%
1332 \def\numsubsubsecentry##1##2##3##4{%
1333 \advancenumber{subsec\thissubsecnum}%
1335 \def\thischapnum{0}%
1337 \def\thissubsecnum{0}%
1339 % use \def rather than \let here because we redefine \chapentry et
1340 % al. a second time, below.
1341 \def\appentry{\numchapentry}%
1342 \def\appsecentry{\numsecentry}%
1343 \def\appsubsecentry{\numsubsecentry}%
1344 \def\appsubsubsecentry{\numsubsubsecentry}%
1345 \def\unnchapentry{\numchapentry}%
1346 \def\unnsecentry{\numsecentry}%
1347 \def\unnsubsecentry{\numsubsecentry}%
1348 \def\unnsubsubsecentry{\numsubsubsecentry}%
1351 % Read toc second time, this time actually producing the outlines.
1352 % The `-' means take the \expnumber as the absolute number of
1353 % subentries, which we calculated on our first read of the .toc above.
1355 % We use the node names as the destinations.
1356 \def\numchapentry##1##2##3##4{%
1357 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1358 \def\numsecentry##1##2##3##4{%
1359 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1360 \def\numsubsecentry##1##2##3##4{%
1361 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1362 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1363 \dopdfoutline{##1}{}{##3}{##4}}%
1365 % PDF outlines are displayed using system fonts, instead of
1366 % document fonts. Therefore we cannot use special characters,
1367 % since the encoding is unknown. For example, the eogonek from
1368 % Latin 2 (0xea) gets translated to a | character. Info from
1369 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1371 % xx to do this right, we have to translate 8-bit characters to
1372 % their "best" equivalent, based on the @documentencoding. Right
1373 % now, I guess we'll just let the pdf reader have its way.
1376 \catcode`\\=\active \otherbackslash
1381 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1382 \ifx\PP\D\let\nextsp\relax
1383 \else\let\nextsp\skipspaces
1384 \ifx\p\space\else\addtokens{\filename}{\PP}%
1385 \advance\filenamelength by 1
1389 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1390 \ifnum\pdftexversion < 14
1391 \let \startlink \pdfannotlink
1393 \let \startlink \pdfstartlink
1395 % make a live url in pdf output.
1398 % it seems we really need yet another set of dummies; have not
1399 % tried to figure out what each command should do in the context
1400 % of @url. for now, just make @/ a no-op, that's the only one
1401 % people have actually reported a problem with.
1403 \normalturnoffactive
1406 \makevalueexpandable
1408 \startlink attr{/Border [0 0 0]}%
1409 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1411 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1412 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1413 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1414 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1416 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1418 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1419 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1420 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1422 \ifnum0=\countA\else\makelink\fi
1423 \ifx\first.\let\next=\done\else
1425 \addtokens{\toksB}{\the\toksD}
1426 \ifx\first,\addtokens{\toksB}{\space}\fi
1428 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1430 \def\makelink{\addtokens{\toksB}%
1431 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1433 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1434 \linkcolor #1\endlink}
1435 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1437 \let\pdfmkdest = \gobble
1438 \let\pdfurl = \gobble
1439 \let\endlink = \relax
1440 \let\linkcolor = \relax
1441 \let\pdfmakeoutlines = \relax
1442 \fi % \ifx\pdfoutput
1447 % Change the current font style to #1, remembering it in \curfontstyle.
1448 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1449 % italics, not bold italics.
1451 \def\setfontstyle#1{%
1452 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1453 \csname ten#1\endcsname % change the current font
1456 % Select #1 fonts with the current style.
1458 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1460 \def\rm{\fam=0 \setfontstyle{rm}}
1461 \def\it{\fam=\itfam \setfontstyle{it}}
1462 \def\sl{\fam=\slfam \setfontstyle{sl}}
1463 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1464 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1466 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1467 % So we set up a \sf.
1469 \def\sf{\fam=\sffam \setfontstyle{sf}}
1470 \let\li = \sf % Sometimes we call it \li, not \sf.
1472 % We don't need math for this font style.
1473 \def\ttsl{\setfontstyle{ttsl}}
1476 \newdimen\textleading \textleading = 13.2pt
1478 % Set the baselineskip to #1, and the lineskip and strut size
1479 % correspondingly. There is no deep meaning behind these magic numbers
1480 % used as factors; they just match (closely enough) what Knuth defined.
1482 \def\lineskipfactor{.08333}
1483 \def\strutheightpercent{.70833}
1484 \def\strutdepthpercent {.29167}
1487 \normalbaselineskip = #1\relax
1488 \normallineskip = \lineskipfactor\normalbaselineskip
1490 \setbox\strutbox =\hbox{%
1491 \vrule width0pt height\strutheightpercent\baselineskip
1492 depth \strutdepthpercent \baselineskip
1496 % Set the font macro #1 to the font named #2, adding on the
1497 % specified font prefix (normally `cm').
1498 % #3 is the font's design size, #4 is a scale factor
1499 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1501 % Use cm as the default font prefix.
1502 % To specify the font prefix, you must define \fontprefix
1503 % before you read in texinfo.tex.
1504 \ifx\fontprefix\undefined
1507 % Support font families that don't use the same naming scheme as CM.
1509 \def\rmbshape{bx} %where the normal face is bold
1514 \def\ttslshape{sltt}
1524 % Text fonts (11.2pt, magstep1).
1525 \def\textnominalsize{11pt}
1526 \edef\mainmagstep{\magstephalf}
1527 \setfont\textrm\rmshape{10}{\mainmagstep}
1528 \setfont\texttt\ttshape{10}{\mainmagstep}
1529 \setfont\textbf\bfshape{10}{\mainmagstep}
1530 \setfont\textit\itshape{10}{\mainmagstep}
1531 \setfont\textsl\slshape{10}{\mainmagstep}
1532 \setfont\textsf\sfshape{10}{\mainmagstep}
1533 \setfont\textsc\scshape{10}{\mainmagstep}
1534 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1535 \font\texti=cmmi10 scaled \mainmagstep
1536 \font\textsy=cmsy10 scaled \mainmagstep
1538 % A few fonts for @defun names and args.
1539 \setfont\defbf\bfshape{10}{\magstep1}
1540 \setfont\deftt\ttshape{10}{\magstep1}
1541 \setfont\defttsl\ttslshape{10}{\magstep1}
1542 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1544 % Fonts for indices, footnotes, small examples (9pt).
1545 \def\smallnominalsize{9pt}
1546 \setfont\smallrm\rmshape{9}{1000}
1547 \setfont\smalltt\ttshape{9}{1000}
1548 \setfont\smallbf\bfshape{10}{900}
1549 \setfont\smallit\itshape{9}{1000}
1550 \setfont\smallsl\slshape{9}{1000}
1551 \setfont\smallsf\sfshape{9}{1000}
1552 \setfont\smallsc\scshape{10}{900}
1553 \setfont\smallttsl\ttslshape{10}{900}
1557 % Fonts for small examples (8pt).
1558 \def\smallernominalsize{8pt}
1559 \setfont\smallerrm\rmshape{8}{1000}
1560 \setfont\smallertt\ttshape{8}{1000}
1561 \setfont\smallerbf\bfshape{10}{800}
1562 \setfont\smallerit\itshape{8}{1000}
1563 \setfont\smallersl\slshape{8}{1000}
1564 \setfont\smallersf\sfshape{8}{1000}
1565 \setfont\smallersc\scshape{10}{800}
1566 \setfont\smallerttsl\ttslshape{10}{800}
1567 \font\smalleri=cmmi8
1568 \font\smallersy=cmsy8
1570 % Fonts for title page (20.4pt):
1571 \def\titlenominalsize{20pt}
1572 \setfont\titlerm\rmbshape{12}{\magstep3}
1573 \setfont\titleit\itbshape{10}{\magstep4}
1574 \setfont\titlesl\slbshape{10}{\magstep4}
1575 \setfont\titlett\ttbshape{12}{\magstep3}
1576 \setfont\titlettsl\ttslshape{10}{\magstep4}
1577 \setfont\titlesf\sfbshape{17}{\magstep1}
1578 \let\titlebf=\titlerm
1579 \setfont\titlesc\scbshape{10}{\magstep4}
1580 \font\titlei=cmmi12 scaled \magstep3
1581 \font\titlesy=cmsy10 scaled \magstep4
1582 \def\authorrm{\secrm}
1583 \def\authortt{\sectt}
1585 % Chapter (and unnumbered) fonts (17.28pt).
1586 \def\chapnominalsize{17pt}
1587 \setfont\chaprm\rmbshape{12}{\magstep2}
1588 \setfont\chapit\itbshape{10}{\magstep3}
1589 \setfont\chapsl\slbshape{10}{\magstep3}
1590 \setfont\chaptt\ttbshape{12}{\magstep2}
1591 \setfont\chapttsl\ttslshape{10}{\magstep3}
1592 \setfont\chapsf\sfbshape{17}{1000}
1594 \setfont\chapsc\scbshape{10}{\magstep3}
1595 \font\chapi=cmmi12 scaled \magstep2
1596 \font\chapsy=cmsy10 scaled \magstep3
1598 % Section fonts (14.4pt).
1599 \def\secnominalsize{14pt}
1600 \setfont\secrm\rmbshape{12}{\magstep1}
1601 \setfont\secit\itbshape{10}{\magstep2}
1602 \setfont\secsl\slbshape{10}{\magstep2}
1603 \setfont\sectt\ttbshape{12}{\magstep1}
1604 \setfont\secttsl\ttslshape{10}{\magstep2}
1605 \setfont\secsf\sfbshape{12}{\magstep1}
1607 \setfont\secsc\scbshape{10}{\magstep2}
1608 \font\seci=cmmi12 scaled \magstep1
1609 \font\secsy=cmsy10 scaled \magstep2
1611 % Subsection fonts (13.15pt).
1612 \def\ssecnominalsize{13pt}
1613 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1614 \setfont\ssecit\itbshape{10}{1315}
1615 \setfont\ssecsl\slbshape{10}{1315}
1616 \setfont\ssectt\ttbshape{12}{\magstephalf}
1617 \setfont\ssecttsl\ttslshape{10}{1315}
1618 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1620 \setfont\ssecsc\scbshape{10}{1315}
1621 \font\sseci=cmmi12 scaled \magstephalf
1622 \font\ssecsy=cmsy10 scaled 1315
1624 % Reduced fonts for @acro in text (10pt).
1625 \def\reducednominalsize{10pt}
1626 \setfont\reducedrm\rmshape{10}{1000}
1627 \setfont\reducedtt\ttshape{10}{1000}
1628 \setfont\reducedbf\bfshape{10}{1000}
1629 \setfont\reducedit\itshape{10}{1000}
1630 \setfont\reducedsl\slshape{10}{1000}
1631 \setfont\reducedsf\sfshape{10}{1000}
1632 \setfont\reducedsc\scshape{10}{1000}
1633 \setfont\reducedttsl\ttslshape{10}{1000}
1634 \font\reducedi=cmmi10
1635 \font\reducedsy=cmsy10
1637 % In order for the font changes to affect most math symbols and letters,
1638 % we have to define the \textfont of the standard families. Since
1639 % texinfo doesn't allow for producing subscripts and superscripts except
1640 % in the main text, we don't bother to reset \scriptfont and
1641 % \scriptscriptfont (which would also require loading a lot more fonts).
1643 \def\resetmathfonts{%
1644 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1645 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1646 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1649 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1650 % of just \STYLE. We do this because \STYLE needs to also set the
1651 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1652 % \tenSTYLE to set the current font.
1654 % Each font-changing command also sets the names \lsize (one size lower)
1655 % and \lllsize (three sizes lower). These relative commands are used in
1656 % the LaTeX logo and acronyms.
1658 % This all needs generalizing, badly.
1661 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1662 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1663 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1664 \let\tenttsl=\textttsl
1665 \def\curfontsize{text}%
1666 \def\lsize{reduced}\def\lllsize{smaller}%
1667 \resetmathfonts \setleading{\textleading}}
1669 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1670 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1671 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1672 \let\tenttsl=\titlettsl
1673 \def\curfontsize{title}%
1674 \def\lsize{chap}\def\lllsize{subsec}%
1675 \resetmathfonts \setleading{25pt}}
1676 \def\titlefont#1{{\titlefonts\rm #1}}
1678 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1679 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1680 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1681 \let\tenttsl=\chapttsl
1682 \def\curfontsize{chap}%
1683 \def\lsize{sec}\def\lllsize{text}%
1684 \resetmathfonts \setleading{19pt}}
1686 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1687 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1688 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1689 \let\tenttsl=\secttsl
1690 \def\curfontsize{sec}%
1691 \def\lsize{subsec}\def\lllsize{reduced}%
1692 \resetmathfonts \setleading{16pt}}
1694 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1695 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1696 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1697 \let\tenttsl=\ssecttsl
1698 \def\curfontsize{ssec}%
1699 \def\lsize{text}\def\lllsize{small}%
1700 \resetmathfonts \setleading{15pt}}
1701 \let\subsubsecfonts = \subsecfonts
1703 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1704 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1705 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1706 \let\tenttsl=\reducedttsl
1707 \def\curfontsize{reduced}%
1708 \def\lsize{small}\def\lllsize{smaller}%
1709 \resetmathfonts \setleading{10.5pt}}
1711 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1712 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1713 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1714 \let\tenttsl=\smallttsl
1715 \def\curfontsize{small}%
1716 \def\lsize{smaller}\def\lllsize{smaller}%
1717 \resetmathfonts \setleading{10.5pt}}
1719 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1720 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1721 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1722 \let\tenttsl=\smallerttsl
1723 \def\curfontsize{smaller}%
1724 \def\lsize{smaller}\def\lllsize{smaller}%
1725 \resetmathfonts \setleading{9.5pt}}
1727 % Set the fonts to use with the @small... environments.
1728 \let\smallexamplefonts = \smallfonts
1730 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1731 % can fit this many characters:
1732 % 8.5x11=86 smallbook=72 a4=90 a5=69
1733 % If we use \scriptfonts (8pt), then we can fit this many characters:
1734 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1735 % For me, subjectively, the few extra characters that fit aren't worth
1736 % the additional smallness of 8pt. So I'm making the default 9pt.
1738 % By the way, for comparison, here's what fits with @example (10pt):
1739 % 8.5x11=71 smallbook=60 a4=75 a5=58
1741 % I wish the USA used A4 paper.
1745 % Set up the default fonts, so we can use them for creating boxes.
1749 % Define these so they can be easily changed for other fonts.
1750 \def\angleleft{$\langle$}
1751 \def\angleright{$\rangle$}
1753 % Count depth in font-changes, for error checks
1754 \newcount\fontdepth \fontdepth=0
1756 % Fonts for short table of contents.
1757 \setfont\shortcontrm\rmshape{12}{1000}
1758 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1759 \setfont\shortcontsl\slshape{12}{1000}
1760 \setfont\shortconttt\ttshape{12}{1000}
1762 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1763 %% serif) and @ii for TeX italic
1765 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1766 % unless the following character is such as not to need one.
1767 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1768 \ptexslash\fi\fi\fi}
1769 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1770 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1772 % like \smartslanted except unconditionally uses \ttsl.
1773 % @var is set to this for defun arguments.
1774 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1776 % like \smartslanted except unconditionally use \sl. We never want
1777 % ttsl for book titles, do we?
1778 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1781 \let\slanted=\smartslanted
1782 \let\var=\smartslanted
1783 \let\dfn=\smartslanted
1784 \let\emph=\smartitalic
1786 % @b, explicit bold.
1790 % @sansserif, explicit sans.
1791 \def\sansserif#1{{\sf #1}}
1793 % We can't just use \exhyphenpenalty, because that only has effect at
1794 % the end of a paragraph. Restore normal hyphenation at the end of the
1795 % group within which \nohyphenation is presumably called.
1797 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1798 \def\restorehyphenation{\hyphenchar\font = `- }
1800 % Set sfcode to normal for the chars that usually have another value.
1801 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1802 % sometimes \x has an active definition that messes things up.
1804 \chardef\colonChar = `\:
1805 \chardef\commaChar = `\,
1806 \chardef\dotChar = `\.
1807 \chardef\exclamChar= `\!
1808 \chardef\questChar = `\?
1809 \chardef\semiChar = `\;
1812 \def\plainfrenchspacing{%
1813 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1814 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1815 \def\endofsentencespacefactor{1000}% for @. and friends
1817 \def\plainnonfrenchspacing{%
1818 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1819 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1820 \def\endofsentencespacefactor{3000}% for @. and friends
1823 \def\endofsentencespacefactor{3000}% default
1826 {\tt \rawbackslash \plainfrenchspacing #1}%
1829 \def\samp#1{`\tclose{#1}'\null}
1830 \setfont\keyrm\rmshape{8}{1000}
1832 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1833 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1834 \vbox{\hrule\kern-0.4pt
1835 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1837 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1838 % The old definition, with no lozenge:
1839 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1840 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1842 % @file, @option are the same as @samp.
1846 % @code is a modification of @t,
1847 % which makes spaces the same size as normal in the surrounding text.
1850 % Change normal interword space to be same as for the current font.
1851 \spaceskip = \fontdimen2\font
1853 % Switch to typewriter.
1856 % But `\ ' produces the large typewriter interword space.
1857 \def\ {{\spaceskip = 0pt{} }}%
1859 % Turn off hyphenation.
1869 % We *must* turn on hyphenation at `-' and `_' in @code.
1870 % Otherwise, it is too hard to avoid overfull hboxes
1871 % in the Emacs manual, the Library manual, etc.
1873 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1874 % both hyphenation at - and hyphenation within words.
1875 % We must therefore turn them both off (\tclose does that)
1876 % and arrange explicitly to hyphenate at a dash.
1883 \global\def\code{\begingroup
1884 \catcode`\-=\active \catcode`\_=\active
1886 \let'\singlequotechar
1899 \def\codedash{-\discretionary{}{}{}}
1901 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1902 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1903 % will therefore expand the active definition of _, which is us
1904 % (inside @code that is), therefore an endless loop.
1906 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1907 \else\normalunderscore \fi
1908 \discretionary{}{}{}}%
1911 \def\codex #1{\tclose{#1}\endgroup}
1913 % An additional complication: the above will allow breaks after, e.g.,
1914 % each of the four underscores in __typeof__. This is undesirable in
1915 % some manuals, especially if they don't have long identifiers in
1916 % general. @allowcodebreaks provides a way to control this.
1918 \newif\ifallowcodebreaks \allowcodebreakstrue
1920 \def\keywordtrue{true}
1921 \def\keywordfalse{false}
1923 \parseargdef\allowcodebreaks{%
1925 \ifx\txiarg\keywordtrue
1926 \allowcodebreakstrue
1927 \else\ifx\txiarg\keywordfalse
1928 \allowcodebreaksfalse
1930 \errhelp = \EMsimple
1931 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
1935 % @kbd is like @code, except that if the argument is just one @key command,
1936 % then @kbd has no effect.
1938 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1939 % `example' (@kbd uses ttsl only inside of @example and friends),
1940 % or `code' (@kbd uses normal tty font always).
1941 \parseargdef\kbdinputstyle{%
1943 \ifx\txiarg\worddistinct
1944 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1945 \else\ifx\txiarg\wordexample
1946 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1947 \else\ifx\txiarg\wordcode
1948 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1950 \errhelp = \EMsimple
1951 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
1954 \def\worddistinct{distinct}
1955 \def\wordexample{example}
1958 % Default is `distinct.'
1959 \kbdinputstyle distinct
1962 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1963 \ifx\one\xkey\ifx\threex\three \key{#2}%
1964 \else{\tclose{\kbdfont\look}}\fi
1965 \else{\tclose{\kbdfont\look}}\fi}
1967 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1968 \let\indicateurl=\code
1972 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1973 % second argument specifying the text to display and an optional third
1974 % arg as text to display instead of (rather than in addition to) the url
1975 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1976 % a hypertex \special here.
1978 \def\uref#1{\douref #1,,,\finish}
1979 \def\douref#1,#2,#3,#4\finish{\begingroup
1982 \setbox0 = \hbox{\ignorespaces #3}%
1984 \unhbox0 % third arg given, show only that
1986 \setbox0 = \hbox{\ignorespaces #2}%
1989 \unhbox0 % PDF: 2nd arg given, show only it
1991 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1994 \code{#1}% only url given, so show it
2000 % @url synonym for @uref, since that's how everyone uses it.
2004 % rms does not like angle brackets --karl, 17may97.
2005 % So now @email is just like @uref, unless we are pdf.
2007 %\def\email#1{\angleleft{\tt #1}\angleright}
2009 \def\email#1{\doemail#1,,\finish}
2010 \def\doemail#1,#2,#3\finish{\begingroup
2013 \setbox0 = \hbox{\ignorespaces #2}%
2014 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2021 % Check if we are currently using a typewriter font. Since all the
2022 % Computer Modern typewriter fonts have zero interword stretch (and
2023 % shrink), and it is reasonable to expect all typewriter fonts to have
2024 % this property, we can check that font parameter.
2026 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2028 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2029 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2031 \def\dmn#1{\thinspace #1}
2033 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2035 % @l was never documented to mean ``switch to the Lisp font'',
2036 % and it is not used as such in any manual I can find. We need it for
2037 % Polish suppressed-l. --karl, 22sep96.
2038 %\def\l#1{{\li #1}\null}
2040 % Explicit font changes: @r, @sc, undocumented @ii.
2041 \def\r#1{{\rm #1}} % roman font
2042 \def\sc#1{{\smallcaps#1}} % smallcaps font
2043 \def\ii#1{{\it #1}} % italic font
2045 % @acronym for "FBI", "NATO", and the like.
2046 % We print this one point size smaller, since it's intended for
2049 \def\acronym#1{\doacronym #1,,\finish}
2050 \def\doacronym#1,#2,#3\finish{%
2051 {\selectfonts\lsize #1}%
2053 \ifx\temp\empty \else
2054 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2058 % @abbr for "Comput. J." and the like.
2059 % No font change, but don't do end-of-sentence spacing.
2061 \def\abbr#1{\doabbr #1,,\finish}
2062 \def\doabbr#1,#2,#3\finish{%
2063 {\plainfrenchspacing #1}%
2065 \ifx\temp\empty \else
2066 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2070 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2072 \def\pounds{{\it\$}}
2074 % @euro{} comes from a separate font, depending on the current style.
2075 % We use the free feym* fonts from the eurosym package by Henrik
2076 % Theiling, which support regular, slanted, bold and bold slanted (and
2077 % "outlined" (blackboard board, sort of) versions, which we don't need).
2078 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2080 % Although only regular is the truly official Euro symbol, we ignore
2081 % that. The Euro is designed to be slightly taller than the regular
2087 % feybo - bold slanted
2089 % There is no good (free) typewriter version, to my knowledge.
2090 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2093 % Also doesn't work in math. Do we need to do math with euro symbols?
2097 \def\euro{{\eurofont e}}
2099 % We set the font at each command, rather than predefining it in
2100 % \textfonts and the other font-switching commands, so that
2101 % installations which never need the symbol don't have to have the
2104 % There is only one designed size (nominal 10pt), so we always scale
2105 % that to the current nominal size.
2107 % By the way, simply using "at 1em" works for cmr10 and the like, but
2108 % does not work for cmbx10 and other extended/shrunken fonts.
2110 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2112 \ifx\curfontstyle\bfstylename
2114 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2117 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2122 % @registeredsymbol - R in a circle. The font for the R should really
2123 % be smaller yet, but lllsize is the best we can do for now.
2124 % Adapted from the plain.tex definition of \copyright.
2126 \def\registeredsymbol{%
2127 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2132 % Laurent Siebenmann reports \Orb undefined with:
2133 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2134 % so we'll define it if necessary.
2137 \def\Orb{\mathhexbox20D}
2141 \message{page headings,}
2143 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2144 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2146 % First the title page. Must do @settitle before @titlepage.
2148 \newif\iffinishedtitlepage
2150 % Do an implicit @contents or @shortcontents after @end titlepage if the
2151 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2153 \newif\ifsetcontentsaftertitlepage
2154 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2155 \newif\ifsetshortcontentsaftertitlepage
2156 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2158 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2159 \endgroup\page\hbox{}\page}
2162 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2164 \parindent=0pt \textfonts
2165 % Leave some space at the very top of the page.
2166 \vglue\titlepagetopglue
2167 % No rule at page bottom unless we print one at the top with @title.
2168 \finishedtitlepagetrue
2170 % Most title ``pages'' are actually two pages long, with space
2171 % at the top of the second. We don't want the ragged left on the second.
2172 \let\oldpage = \page
2174 \iffinishedtitlepage\else
2177 \let\page = \oldpage
2184 \iffinishedtitlepage\else
2187 % It is important to do the page break before ending the group,
2188 % because the headline and footline are only empty inside the group.
2189 % If we use the new definition of \page, we always get a blank page
2190 % after the title page, which we certainly don't want.
2194 % Need this before the \...aftertitlepage checks so that if they are
2195 % in effect the toc pages will come out with page numbers.
2198 % If they want short, they certainly want long too.
2199 \ifsetshortcontentsaftertitlepage
2202 \global\let\shortcontents = \relax
2203 \global\let\contents = \relax
2206 \ifsetcontentsaftertitlepage
2208 \global\let\contents = \relax
2209 \global\let\shortcontents = \relax
2213 \def\finishtitlepage{%
2214 \vskip4pt \hrule height 2pt width \hsize
2215 \vskip\titlepagebottomglue
2216 \finishedtitlepagetrue
2219 %%% Macros to be used within @titlepage:
2221 \let\subtitlerm=\tenrm
2222 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2224 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2227 \parseargdef\title{%
2229 \leftline{\titlefonts\rm #1}
2230 % print a rule at the page bottom also.
2231 \finishedtitlepagefalse
2232 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2235 \parseargdef\subtitle{%
2237 {\subtitlefont \rightline{#1}}%
2240 % @author should come last, but may come many times.
2241 % It can also be used inside @quotation.
2243 \parseargdef\author{%
2244 \def\temp{\quotation}%
2246 \def\quotationauthor{#1}% printed in \Equotation.
2249 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2250 {\authorfont \leftline{#1}}%
2255 %%% Set up page headings and footings.
2257 \let\thispage=\folio
2259 \newtoks\evenheadline % headline on even pages
2260 \newtoks\oddheadline % headline on odd pages
2261 \newtoks\evenfootline % footline on even pages
2262 \newtoks\oddfootline % footline on odd pages
2264 % Now make TeX use those variables
2265 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2266 \else \the\evenheadline \fi}}
2267 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2268 \else \the\evenfootline \fi}\HEADINGShook}
2269 \let\HEADINGShook=\relax
2271 % Commands to set those variables.
2272 % For example, this is what @headings on does
2273 % @evenheading @thistitle|@thispage|@thischapter
2274 % @oddheading @thischapter|@thispage|@thistitle
2275 % @evenfooting @thisfile||
2276 % @oddfooting ||@thisfile
2279 \def\evenheading{\parsearg\evenheadingxxx}
2280 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2281 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2282 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2284 \def\oddheading{\parsearg\oddheadingxxx}
2285 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2286 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2287 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2289 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2291 \def\evenfooting{\parsearg\evenfootingxxx}
2292 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2293 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2294 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2296 \def\oddfooting{\parsearg\oddfootingxxx}
2297 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2298 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2299 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2301 % Leave some space for the footline. Hopefully ok to assume
2302 % @evenfooting will not be used by itself.
2303 \global\advance\pageheight by -\baselineskip
2304 \global\advance\vsize by -\baselineskip
2307 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2310 % @headings double turns headings on for double-sided printing.
2311 % @headings single turns headings on for single-sided printing.
2312 % @headings off turns them off.
2313 % @headings on same as @headings double, retained for compatibility.
2314 % @headings after turns on double-sided headings after this page.
2315 % @headings doubleafter turns on double-sided headings after this page.
2316 % @headings singleafter turns on single-sided headings after this page.
2317 % By default, they are off at the start of a document,
2318 % and turned `on' after @end titlepage.
2320 \def\headings #1 {\csname HEADINGS#1\endcsname}
2323 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2324 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2326 % When we turn headings on, set the page number to 1.
2327 % For double-sided printing, put current file name in lower left corner,
2328 % chapter name on inside top of right hand pages, document
2329 % title on inside top of left hand pages, and page numbers on outside top
2330 % edge of all pages.
2331 \def\HEADINGSdouble{%
2333 \global\evenfootline={\hfil}
2334 \global\oddfootline={\hfil}
2335 \global\evenheadline={\line{\folio\hfil\thistitle}}
2336 \global\oddheadline={\line{\thischapter\hfil\folio}}
2337 \global\let\contentsalignmacro = \chapoddpage
2339 \let\contentsalignmacro = \chappager
2341 % For single-sided printing, chapter title goes across top left of page,
2342 % page number on top right.
2343 \def\HEADINGSsingle{%
2345 \global\evenfootline={\hfil}
2346 \global\oddfootline={\hfil}
2347 \global\evenheadline={\line{\thischapter\hfil\folio}}
2348 \global\oddheadline={\line{\thischapter\hfil\folio}}
2349 \global\let\contentsalignmacro = \chappager
2351 \def\HEADINGSon{\HEADINGSdouble}
2353 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2354 \let\HEADINGSdoubleafter=\HEADINGSafter
2355 \def\HEADINGSdoublex{%
2356 \global\evenfootline={\hfil}
2357 \global\oddfootline={\hfil}
2358 \global\evenheadline={\line{\folio\hfil\thistitle}}
2359 \global\oddheadline={\line{\thischapter\hfil\folio}}
2360 \global\let\contentsalignmacro = \chapoddpage
2363 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2364 \def\HEADINGSsinglex{%
2365 \global\evenfootline={\hfil}
2366 \global\oddfootline={\hfil}
2367 \global\evenheadline={\line{\thischapter\hfil\folio}}
2368 \global\oddheadline={\line{\thischapter\hfil\folio}}
2369 \global\let\contentsalignmacro = \chappager
2372 % Subroutines used in generating headings
2373 % This produces Day Month Year style of output.
2374 % Only define if not already defined, in case a txi-??.tex file has set
2375 % up a different format (e.g., txi-cs.tex does this).
2376 \ifx\today\undefined
2380 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2381 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2382 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2387 % @settitle line... specifies the title of the document, for headings.
2388 % It generates no output of its own.
2389 \def\thistitle{\putwordNoTitle}
2390 \def\settitle{\parsearg{\gdef\thistitle}}
2394 % Tables -- @table, @ftable, @vtable, @item(x).
2396 % default indentation of table text
2397 \newdimen\tableindent \tableindent=.8in
2398 % default indentation of @itemize and @enumerate text
2399 \newdimen\itemindent \itemindent=.3in
2400 % margin between end of table item and start of table text.
2401 \newdimen\itemmargin \itemmargin=.1in
2403 % used internally for \itemindent minus \itemmargin
2406 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2408 % They also define \itemindex
2409 % to index the item name in whatever manner is desired (perhaps none).
2411 \newif\ifitemxneedsnegativevskip
2413 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2415 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2416 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2418 \def\itemzzz #1{\begingroup %
2419 \advance\hsize by -\rightskip
2420 \advance\hsize by -\tableindent
2421 \setbox0=\hbox{\itemindicate{#1}}%
2423 \nobreak % This prevents a break before @itemx.
2425 % If the item text does not fit in the space we have, put it on a line
2426 % by itself, and do not allow a page break either before or after that
2427 % line. We do not start a paragraph here because then if the next
2428 % command is, e.g., @kindex, the whatsit would get put into the
2429 % horizontal list on a line by itself, resulting in extra blank space.
2430 \ifdim \wd0>\itemmax
2432 % Make this a paragraph so we get the \parskip glue and wrapping,
2433 % but leave it ragged-right.
2435 \advance\leftskip by-\tableindent
2436 \advance\hsize by\tableindent
2437 \advance\rightskip by0pt plus1fil
2438 \leavevmode\unhbox0\par
2441 % We're going to be starting a paragraph, but we don't want the
2442 % \parskip glue -- logically it's part of the @item we just started.
2443 \nobreak \vskip-\parskip
2445 % Stop a page break at the \parskip glue coming up. However, if
2446 % what follows is an environment such as @example, there will be no
2447 % \parskip glue; then the negative vskip we just inserted would
2448 % cause the example and the item to crash together. So we use this
2449 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2450 % \parskip glue after all. Section titles are handled this way also.
2454 \itemxneedsnegativevskipfalse
2456 % The item text fits into the space. Start a paragraph, so that the
2457 % following text (if any) will end up on the same line.
2459 % Do this with kerns and \unhbox so that if there is a footnote in
2460 % the item text, it can migrate to the main vertical list and
2461 % eventually be printed.
2462 \nobreak\kern-\tableindent
2463 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2465 \nobreak\kern\dimen0
2467 \itemxneedsnegativevskiptrue
2471 \def\item{\errmessage{@item while not in a list environment}}
2472 \def\itemx{\errmessage{@itemx while not in a list environment}}
2474 % @table, @ftable, @vtable.
2476 \let\itemindex\gobble
2480 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2481 \tablecheck{ftable}%
2484 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2485 \tablecheck{vtable}%
2488 \ifnum \the\catcode`\^^M=\active
2490 \errmessage{This command won't work in this context; perhaps the problem is
2491 that we are \inenvironment\thisenv}%
2492 \def\next{\doignore{#1}}%
2499 \def\itemindicate{#1}%
2504 \makevalueexpandable
2505 \edef\temp{\noexpand\tablez #1\space\space\space}%
2509 \def\tablez #1 #2 #3 #4\endtablez{%
2511 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2512 \ifnum 0#2>0 \tableindent=#2\mil \fi
2513 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2514 \itemmax=\tableindent
2515 \advance \itemmax by -\itemmargin
2516 \advance \leftskip by \tableindent
2517 \exdentamount=\tableindent
2519 \parskip = \smallskipamount
2520 \ifdim \parskip=0pt \parskip=2pt \fi
2521 \let\item = \internalBitem
2522 \let\itemx = \internalBitemx
2524 \def\Etable{\endgraf\afterenvbreak}
2527 \let\Eitemize\Etable
2528 \let\Eenumerate\Etable
2530 % This is the counter used by @enumerate, which is really @itemize
2534 \envdef\itemize{\parsearg\doitemize}
2538 \itemmax=\itemindent
2539 \advance\itemmax by -\itemmargin
2540 \advance\leftskip by \itemindent
2541 \exdentamount=\itemindent
2543 \parskip=\smallskipamount
2544 \ifdim\parskip=0pt \parskip=2pt \fi
2545 \def\itemcontents{#1}%
2546 % @itemize with no arg is equivalent to @itemize @bullet.
2547 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2548 \let\item=\itemizeitem
2551 % Definition of @item while inside @itemize and @enumerate.
2554 \advance\itemno by 1 % for enumerations
2555 {\let\par=\endgraf \smallbreak}% reasonable place to break
2557 % If the document has an @itemize directly after a section title, a
2558 % \nobreak will be last on the list, and \sectionheading will have
2559 % done a \vskip-\parskip. In that case, we don't want to zero
2560 % parskip, or the item text will crash with the heading. On the
2561 % other hand, when there is normal text preceding the item (as there
2562 % usually is), we do want to zero parskip, or there would be too much
2563 % space. In that case, we won't have a \nobreak before. At least
2564 % that's the theory.
2565 \ifnum\lastpenalty<10000 \parskip=0in \fi
2567 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2568 \vadjust{\penalty 1200}}% not good to break after first line of item.
2572 % \splitoff TOKENS\endmark defines \first to be the first token in
2573 % TOKENS, and \rest to be the remainder.
2575 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2577 % Allow an optional argument of an uppercase letter, lowercase letter,
2578 % or number, to specify the first label in the enumerated list. No
2579 % argument is the same as `1'.
2581 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2582 \def\enumeratey #1 #2\endenumeratey{%
2583 % If we were given no argument, pretend we were given `1'.
2585 \ifx\thearg\empty \def\thearg{1}\fi
2587 % Detect if the argument is a single token. If so, it might be a
2588 % letter. Otherwise, the only valid thing it can be is a number.
2589 % (We will always have one token, because of the test we just made.
2590 % This is a good thing, since \splitoff doesn't work given nothing at
2591 % all -- the first parameter is undelimited.)
2592 \expandafter\splitoff\thearg\endmark
2594 % Only one token in the argument. It could still be anything.
2595 % A ``lowercase letter'' is one whose \lccode is nonzero.
2596 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2597 % not equal to itself.
2598 % Otherwise, we assume it's a number.
2600 % We need the \relax at the end of the \ifnum lines to stop TeX from
2601 % continuing to look for a <number>.
2603 \ifnum\lccode\expandafter`\thearg=0\relax
2604 \numericenumerate % a number (we hope)
2607 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2608 \lowercaseenumerate % lowercase letter
2610 \uppercaseenumerate % uppercase letter
2614 % Multiple tokens in the argument. We hope it's a number.
2619 % An @enumerate whose labels are integers. The starting integer is
2622 \def\numericenumerate{%
2624 \startenumeration{\the\itemno}%
2627 % The starting (lowercase) letter is in \thearg.
2628 \def\lowercaseenumerate{%
2629 \itemno = \expandafter`\thearg
2631 % Be sure we're not beyond the end of the alphabet.
2633 \errmessage{No more lowercase letters in @enumerate; get a bigger
2640 % The starting (uppercase) letter is in \thearg.
2641 \def\uppercaseenumerate{%
2642 \itemno = \expandafter`\thearg
2644 % Be sure we're not beyond the end of the alphabet.
2646 \errmessage{No more uppercase letters in @enumerate; get a bigger
2653 % Call \doitemize, adding a period to the first argument and supplying the
2654 % common last two arguments. Also subtract one from the initial value in
2655 % \itemno, since @item increments \itemno.
2657 \def\startenumeration#1{%
2658 \advance\itemno by -1
2659 \doitemize{#1.}\flushcr
2662 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2665 \def\alphaenumerate{\enumerate{a}}
2666 \def\capsenumerate{\enumerate{A}}
2667 \def\Ealphaenumerate{\Eenumerate}
2668 \def\Ecapsenumerate{\Eenumerate}
2671 % @multitable macros
2672 % Amy Hendrickson, 8/18/94, 3/6/96
2674 % @multitable ... @end multitable will make as many columns as desired.
2675 % Contents of each column will wrap at width given in preamble. Width
2676 % can be specified either with sample text given in a template line,
2677 % or in percent of \hsize, the current width of text on page.
2679 % Table can continue over pages but will only break between lines.
2683 % Either define widths of columns in terms of percent of \hsize:
2684 % @multitable @columnfractions .25 .3 .45
2687 % Numbers following @columnfractions are the percent of the total
2688 % current hsize to be used for each column. You may use as many
2689 % columns as desired.
2692 % Or use a template:
2693 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2695 % using the widest term desired in each column.
2697 % Each new table line starts with @item, each subsequent new column
2698 % starts with @tab. Empty columns may be produced by supplying @tab's
2699 % with nothing between them for as many times as empty columns are needed,
2700 % ie, @tab@tab@tab will produce two empty columns.
2702 % @item, @tab do not need to be on their own lines, but it will not hurt
2705 % Sample multitable:
2707 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2708 % @item first col stuff @tab second col stuff @tab third col
2715 % @item first col stuff @tab second col stuff
2716 % @tab Many paragraphs of text may be used in any column.
2718 % They will wrap at the width determined by the template.
2719 % @item@tab@tab This will be in third column.
2722 % Default dimensions may be reset by user.
2723 % @multitableparskip is vertical space between paragraphs in table.
2724 % @multitableparindent is paragraph indent in table.
2725 % @multitablecolmargin is horizontal space to be left between columns.
2726 % @multitablelinespace is space to leave between table items, baseline
2728 % 0pt means it depends on current normal line spacing.
2730 \newskip\multitableparskip
2731 \newskip\multitableparindent
2732 \newdimen\multitablecolspace
2733 \newskip\multitablelinespace
2734 \multitableparskip=0pt
2735 \multitableparindent=6pt
2736 \multitablecolspace=12pt
2737 \multitablelinespace=0pt
2739 % Macros used to set up halign preamble:
2741 \let\endsetuptable\relax
2742 \def\xendsetuptable{\endsetuptable}
2743 \let\columnfractions\relax
2744 \def\xcolumnfractions{\columnfractions}
2747 % #1 is the @columnfraction, usually a decimal number like .5, but might
2748 % be just 1. We just use it, whatever it is.
2750 \def\pickupwholefraction#1 {%
2751 \global\advance\colcount by 1
2752 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2759 \ifx\firstarg\xendsetuptable
2762 \ifx\firstarg\xcolumnfractions
2763 \global\setpercenttrue
2766 \let\go\pickupwholefraction
2768 \global\advance\colcount by 1
2769 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2770 % separator; typically that is always in the input, anyway.
2771 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2774 \ifx\go\pickupwholefraction
2775 % Put the argument back for the \pickupwholefraction call, so
2776 % we'll always have a period there to be parsed.
2777 \def\go{\pickupwholefraction#1}%
2779 \let\go = \setuptable
2785 % multitable-only commands.
2787 % @headitem starts a heading row, which we typeset in bold.
2788 % Assignments have to be global since we are inside the implicit group
2789 % of an alignment entry. Note that \everycr resets \everytab.
2790 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2792 % A \tab used to include \hskip1sp. But then the space in a template
2793 % line is not enough. That is bad. So let's go back to just `&' until
2794 % we encounter the problem it was intended to solve again.
2795 % --karl, nathan@acm.org, 20apr99.
2796 \def\tab{\checkenv\multitable &\the\everytab}%
2798 % @multitable ... @end multitable definitions:
2800 \newtoks\everytab % insert after every tab.
2802 \envdef\multitable{%
2806 % @item within a multitable starts a normal row.
2807 % We use \def instead of \let so that if one of the multitable entries
2808 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2809 % \endtemplate) expanding \doitemize.
2814 \setmultitablespacing
2815 \parskip=\multitableparskip
2816 \parindent=\multitableparindent
2822 \global\everytab={}%
2823 \global\colcount=0 % Reset the column counter.
2824 % Check for saved footnotes, etc.
2826 % Keeps underfull box messages off when table breaks over pages.
2828 % Maybe so, but it also creates really weird page breaks when the
2829 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2830 % problem manifests itself, so it can be fixed for real --karl.
2834 \parsearg\domultitable
2836 \def\domultitable#1{%
2837 % To parse everything between @multitable and @item:
2838 \setuptable#1 \endsetuptable
2840 % This preamble sets up a generic column definition, which will
2841 % be used as many times as user calls for columns.
2842 % \vtop will set a single line and will also let text wrap and
2843 % continue for many paragraphs if desired.
2845 \global\advance\colcount by 1
2848 % Use the current \colcount to find the correct column width:
2849 \hsize=\expandafter\csname col\the\colcount\endcsname
2851 % In order to keep entries from bumping into each other
2852 % we will add a \leftskip of \multitablecolspace to all columns after
2855 % If a template has been used, we will add \multitablecolspace
2856 % to the width of each template entry.
2858 % If the user has set preamble in terms of percent of \hsize we will
2859 % use that dimension as the width of the column, and the \leftskip
2860 % will keep entries from bumping into each other. Table will start at
2861 % left margin and final column will justify at right margin.
2863 % Make sure we don't inherit \rightskip from the outer environment.
2866 % The first column will be indented with the surrounding text.
2867 \advance\hsize by\leftskip
2870 % If user has not set preamble in terms of percent of \hsize
2871 % we will advance \hsize by \multitablecolspace.
2872 \advance\hsize by \multitablecolspace
2874 % In either case we will make \leftskip=\multitablecolspace:
2875 \leftskip=\multitablecolspace
2877 % Ignoring space at the beginning and end avoids an occasional spurious
2878 % blank line, when TeX decides to break the line at the space before the
2879 % box from the multistrut, so the strut ends up on a line by itself.
2881 % @multitable @columnfractions .11 .89
2883 % @tab Legal holiday which is valid in major parts of the whole country.
2884 % Is automatically provided with highlighting sequences respectively
2885 % marking characters.
2886 \noindent\ignorespaces##\unskip\multistrut
2891 \egroup % end the \halign
2892 \global\setpercentfalse
2895 \def\setmultitablespacing{%
2896 \def\multistrut{\strut}% just use the standard line spacing
2898 % Compute \multitablelinespace (if not defined by user) for use in
2899 % \multitableparskip calculation. We used define \multistrut based on
2900 % this, but (ironically) that caused the spacing to be off.
2901 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2902 \ifdim\multitablelinespace=0pt
2903 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2904 \global\advance\multitablelinespace by-\ht0
2906 %% Test to see if parskip is larger than space between lines of
2907 %% table. If not, do nothing.
2908 %% If so, set to same dimension as multitablelinespace.
2909 \ifdim\multitableparskip>\multitablelinespace
2910 \global\multitableparskip=\multitablelinespace
2911 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2912 %% than skip between lines in the table.
2914 \ifdim\multitableparskip=0pt
2915 \global\multitableparskip=\multitablelinespace
2916 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2917 %% than skip between lines in the table.
2921 \message{conditionals,}
2923 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2924 % @ifnotxml always succeed. They currently do nothing; we don't
2925 % attempt to check whether the conditionals are properly nested. But we
2926 % have to remember that they are conditionals, so that @end doesn't
2927 % attempt to close an environment group.
2930 \expandafter\let\csname #1\endcsname = \relax
2931 \expandafter\let\csname iscond.#1\endcsname = 1
2934 \makecond{ifnotdocbook}
2935 \makecond{ifnothtml}
2936 \makecond{ifnotinfo}
2937 \makecond{ifnotplaintext}
2940 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2942 \def\direntry{\doignore{direntry}}
2943 \def\documentdescription{\doignore{documentdescription}}
2944 \def\docbook{\doignore{docbook}}
2945 \def\html{\doignore{html}}
2946 \def\ifdocbook{\doignore{ifdocbook}}
2947 \def\ifhtml{\doignore{ifhtml}}
2948 \def\ifinfo{\doignore{ifinfo}}
2949 \def\ifnottex{\doignore{ifnottex}}
2950 \def\ifplaintext{\doignore{ifplaintext}}
2951 \def\ifxml{\doignore{ifxml}}
2952 \def\ignore{\doignore{ignore}}
2953 \def\menu{\doignore{menu}}
2954 \def\xml{\doignore{xml}}
2956 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2958 % A count to remember the depth of nesting.
2959 \newcount\doignorecount
2961 \def\doignore#1{\begingroup
2962 % Scan in ``verbatim'' mode:
2964 \catcode`\@ = \other
2965 \catcode`\{ = \other
2966 \catcode`\} = \other
2968 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2971 % Count number of #1's that we've seen.
2974 % Swallow text until we reach the matching `@end #1'.
2978 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2981 \gdef\dodoignore#1{%
2982 % #1 contains the command name as a string, e.g., `ifinfo'.
2984 % Define a command to find the next `@end #1'.
2985 \long\def\doignoretext##1^^M@end #1{%
2986 \doignoretextyyy##1^^M@#1\_STOP_}%
2988 % And this command to find another #1 command, at the beginning of a
2989 % line. (Otherwise, we would consider a line `@c @ifset', for
2990 % example, to count as an @ifset for nesting.)
2991 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2993 % And now expand that command.
2998 \def\doignoreyyy#1{%
3000 \ifx\temp\empty % Nothing found.
3001 \let\next\doignoretextzzz
3002 \else % Found a nested condition, ...
3003 \advance\doignorecount by 1
3004 \let\next\doignoretextyyy % ..., look for another.
3005 % If we're here, #1 ends with ^^M\ifinfo (for example).
3007 \next #1% the token \_STOP_ is present just after this macro.
3010 % We have to swallow the remaining "\_STOP_".
3012 \def\doignoretextzzz#1{%
3013 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3014 \let\next\enddoignore
3015 \else % Still inside a nested condition.
3016 \advance\doignorecount by -1
3017 \let\next\doignoretext % Look for the next @end.
3022 % Finish off ignored text.
3024 % Ignore anything after the last `@end #1'; this matters in verbatim
3025 % environments, where otherwise the newline after an ignored conditional
3026 % would result in a blank line in the output.
3027 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3031 % @set VAR sets the variable VAR to an empty value.
3032 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3034 % Since we want to separate VAR from REST-OF-LINE (which might be
3035 % empty), we can't just use \parsearg; we have to insert a space of our
3036 % own to delimit the rest of the line, and then take it out again if we
3038 % We rely on the fact that \parsearg sets \catcode`\ =10.
3040 \parseargdef\set{\setyyy#1 \endsetyyy}
3041 \def\setyyy#1 #2\endsetyyy{%
3043 \makevalueexpandable
3045 \edef\next{\gdef\makecsname{SET#1}}%
3053 % Remove the trailing space \setxxx inserted.
3054 \def\setzzz#1 \endsetzzz{\next{#1}}
3056 % @clear VAR clears (i.e., unsets) the variable VAR.
3058 \parseargdef\clear{%
3060 \makevalueexpandable
3061 \global\expandafter\let\csname SET#1\endcsname=\relax
3065 % @value{foo} gets the text saved in variable foo.
3066 \def\value{\begingroup\makevalueexpandable\valuexxx}
3067 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3069 \catcode`\- = \active \catcode`\_ = \active
3071 \gdef\makevalueexpandable{%
3072 \let\value = \expandablevalue
3073 % We don't want these characters active, ...
3074 \catcode`\-=\other \catcode`\_=\other
3075 % ..., but we might end up with active ones in the argument if
3076 % we're called from @code, as @code{@value{foo-bar_}}, though.
3077 % So \let them to their normal equivalents.
3078 \let-\realdash \let_\normalunderscore
3082 % We have this subroutine so that we can handle at least some @value's
3083 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3084 % The command has to be fully expandable (if the variable is set), since
3085 % the result winds up in the index file. This means that if the
3086 % variable's value contains other Texinfo commands, it's almost certain
3087 % it will fail (although perhaps we could fix that with sufficient work
3088 % to do a one-level expansion on the result, instead of complete).
3090 \def\expandablevalue#1{%
3091 \expandafter\ifx\csname SET#1\endcsname\relax
3092 {[No value for ``#1'']}%
3093 \message{Variable `#1', used in @value, is not set.}%
3095 \csname SET#1\endcsname
3099 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3102 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3105 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3108 \makevalueexpandable
3110 \expandafter\ifx\csname SET#2\endcsname\relax
3111 #1% If not set, redefine \next.
3116 \def\ifsetfail{\doignore{ifset}}
3118 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3119 % defined with @set, or has been undefined with @clear.
3121 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3122 % above code: if the variable is not set, do nothing, if it is set,
3123 % then redefine \next to \ifclearfail.
3126 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3127 \def\ifclearfail{\doignore{ifclear}}
3129 % @dircategory CATEGORY -- specify a category of the dir file
3130 % which this file should belong to. Ignore this in TeX.
3131 \let\dircategory=\comment
3133 % @defininfoenclose.
3134 \let\definfoenclose=\comment
3138 % Index generation facilities
3140 % Define \newwrite to be identical to plain tex's \newwrite
3141 % except not \outer, so it can be used within macros and \if's.
3142 \edef\newwrite{\makecsname{ptexnewwrite}}
3144 % \newindex {foo} defines an index named foo.
3145 % It automatically defines \fooindex such that
3146 % \fooindex ...rest of line... puts an entry in the index foo.
3147 % It also defines \fooindfile to be the number of the output channel for
3148 % the file that accumulates this index. The file's extension is foo.
3149 % The name of an index should be no more than 2 characters long
3150 % for the sake of vms.
3154 \expandafter\newwrite \csname#1indfile\endcsname
3155 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3157 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3158 \noexpand\doindex{#1}}
3161 % @defindex foo == \newindex{foo}
3163 \def\defindex{\parsearg\newindex}
3165 % Define @defcodeindex, like @defindex except put all entries in @code.
3167 \def\defcodeindex{\parsearg\newcodeindex}
3169 \def\newcodeindex#1{%
3171 \expandafter\newwrite \csname#1indfile\endcsname
3172 \openout \csname#1indfile\endcsname \jobname.#1
3174 \expandafter\xdef\csname#1index\endcsname{%
3175 \noexpand\docodeindex{#1}}%
3179 % @synindex foo bar makes index foo feed into index bar.
3180 % Do this instead of @defindex foo if you don't want it as a separate index.
3182 % @syncodeindex foo bar similar, but put all entries made for index foo
3185 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3186 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3188 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3189 % #3 the target index (bar).
3190 \def\dosynindex#1#2#3{%
3191 % Only do \closeout if we haven't already done it, else we'll end up
3192 % closing the target index.
3193 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3194 % The \closeout helps reduce unnecessary open files; the limit on the
3195 % Acorn RISC OS is a mere 16 files.
3196 \expandafter\closeout\csname#2indfile\endcsname
3197 \expandafter\let\csname\donesynindex#2\endcsname = 1
3199 % redefine \fooindfile:
3200 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3201 \expandafter\let\csname#2indfile\endcsname=\temp
3202 % redefine \fooindex:
3203 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3206 % Define \doindex, the driver for all \fooindex macros.
3207 % Argument #1 is generated by the calling \fooindex macro,
3208 % and it is "foo", the name of the index.
3210 % \doindex just uses \parsearg; it calls \doind for the actual work.
3211 % This is because \doind is more useful to call from other macros.
3213 % There is also \dosubind {index}{topic}{subtopic}
3214 % which makes an entry in a two-level index such as the operation index.
3216 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3217 \def\singleindexer #1{\doind{\indexname}{#1}}
3219 % like the previous two, but they put @code around the argument.
3220 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3221 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3223 % Take care of Texinfo commands that can appear in an index entry.
3224 % Since there are some commands we want to expand, and others we don't,
3225 % we have to laboriously prevent expansion for those that we don't.
3228 \escapechar = `\\ % use backslash in output files.
3229 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3230 \def\ {\realbackslash\space }%
3231 % Need these in case \tex is in effect and \{ is a \delimiter again.
3232 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3233 % braces and backslashes are used only as delimiters.
3237 % I don't entirely understand this, but when an index entry is
3238 % generated from a macro call, the \endinput which \scanmacro inserts
3239 % causes processing to be prematurely terminated. This is,
3240 % apparently, because \indexsorttmp is fully expanded, and \endinput
3241 % is an expandable command. The redefinition below makes \endinput
3242 % disappear altogether for that purpose -- although logging shows that
3243 % processing continues to some further point. On the other hand, it
3244 % seems \endinput does not hurt in the printed index arg, since that
3245 % is still getting written without apparent harm.
3247 % Sample source (mac-idx3.tex, reported by Graham Percival to
3248 % help-texinfo, 22may06):
3249 % @macro funindex {WORD}
3253 % @funindex commtest
3255 % The above is not enough to reproduce the bug, but it gives the flavor.
3257 % Sample whatsit resulting:
3258 % address@hidden@folio address@hidden address@hidden }}}
3261 \let\endinput = \empty
3263 % Do the redefinitions.
3267 % For the aux and toc files, @ is the escape character. So we want to
3268 % redefine everything using @ as the escape character (instead of
3269 % \realbackslash, still used for index files). When everything uses @,
3270 % this will be simpler.
3275 \let\{ = \lbraceatcmd
3276 \let\} = \rbraceatcmd
3278 % Do the redefinitions.
3283 % Called from \indexdummies and \atdummies.
3285 \def\commondummies{%
3287 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3288 % preventing its expansion. This is used only for control% words,
3289 % not control letters, because the \space would be incorrect for
3290 % control characters, but is needed to separate the control word
3291 % from whatever follows.
3293 % For control letters, we have \definedummyletter, which omits the
3296 % These can be used both for control words that take an argument and
3297 % those that do not. If it is followed by {arg} in the input, then
3298 % that will dutifully get written to the index (or wherever).
3300 \def\definedummyword ##1{\def##1{\string##1\space}}%
3301 \def\definedummyletter##1{\def##1{\string##1}}%
3302 \let\definedummyaccent\definedummyletter
3304 \commondummiesnofonts
3306 \definedummyletter\_%
3308 % Non-English letters.
3320 \definedummyword\exclamdown
3321 \definedummyword\questiondown
3322 \definedummyword\ordf
3323 \definedummyword\ordm
3325 % Although these internal commands shouldn't show up, sometimes they do.
3327 \definedummyword\gtr
3328 \definedummyword\hat
3329 \definedummyword\less
3332 \definedummyword\tclose
3335 \definedummyword\LaTeX
3336 \definedummyword\TeX
3338 % Assorted special characters.
3339 \definedummyword\bullet
3340 \definedummyword\comma
3341 \definedummyword\copyright
3342 \definedummyword\registeredsymbol
3343 \definedummyword\dots
3344 \definedummyword\enddots
3345 \definedummyword\equiv
3346 \definedummyword\error
3347 \definedummyword\euro
3348 \definedummyword\expansion
3349 \definedummyword\minus
3350 \definedummyword\pounds
3351 \definedummyword\point
3352 \definedummyword\print
3353 \definedummyword\result
3355 % We want to disable all macros so that they are not expanded by \write.
3358 \normalturnoffactive
3360 % Handle some cases of @value -- where it does not contain any
3361 % (non-fully-expandable) commands.
3362 \makevalueexpandable
3365 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3367 \def\commondummiesnofonts{%
3368 % Control letters and accents.
3369 \definedummyletter\!%
3370 \definedummyaccent\"%
3371 \definedummyaccent\'%
3372 \definedummyletter\*%
3373 \definedummyaccent\,%
3374 \definedummyletter\.%
3375 \definedummyletter\/%
3376 \definedummyletter\:%
3377 \definedummyaccent\=%
3378 \definedummyletter\?%
3379 \definedummyaccent\^%
3380 \definedummyaccent\`%
3381 \definedummyaccent\~%
3385 \definedummyword\dotaccent
3386 \definedummyword\ringaccent
3387 \definedummyword\tieaccent
3388 \definedummyword\ubaraccent
3389 \definedummyword\udotaccent
3390 \definedummyword\dotless
3392 % Texinfo font commands.
3399 % Commands that take arguments.
3400 \definedummyword\acronym
3401 \definedummyword\cite
3402 \definedummyword\code
3403 \definedummyword\command
3404 \definedummyword\dfn
3405 \definedummyword\emph
3406 \definedummyword\env
3407 \definedummyword\file
3408 \definedummyword\kbd
3409 \definedummyword\key
3410 \definedummyword\math
3411 \definedummyword\option
3412 \definedummyword\pxref
3413 \definedummyword\ref
3414 \definedummyword\samp
3415 \definedummyword\strong
3416 \definedummyword\tie
3417 \definedummyword\uref
3418 \definedummyword\url
3419 \definedummyword\var
3420 \definedummyword\verb
3422 \definedummyword\xref
3425 % \indexnofonts is used when outputting the strings to sort the index
3426 % by, and when constructing control sequence names. It eliminates all
3427 % control sequences and just writes whatever the best ASCII sort string
3428 % would be for a given command (usually its argument).
3431 % Accent commands should become @asis.
3432 \def\definedummyaccent##1{\let##1\asis}%
3433 % We can just ignore other control letters.
3434 \def\definedummyletter##1{\let##1\empty}%
3435 % Hopefully, all control words can become @asis.
3436 \let\definedummyword\definedummyaccent
3438 \commondummiesnofonts
3440 % Don't no-op \tt, since it isn't a user-level command
3441 % and is used in the definitions of the active chars like <, >, |, etc.
3442 % Likewise with the other plain tex font commands.
3447 % how to handle braces?
3448 \def\_{\normalunderscore}%
3450 % Non-English letters.
3463 \def\questiondown{?}%
3470 % Assorted special characters.
3471 % (The following {} will end up in the sort string, but that's ok.)
3472 \def\bullet{bullet}%
3474 \def\copyright{copyright}%
3475 \def\registeredsymbol{R}%
3481 \def\expansion{==>}%
3483 \def\pounds{pounds}%
3488 % We need to get rid of all macros, leaving only the arguments (if present).
3489 % Of course this is not nearly correct, but it is the best we can do for now.
3490 % makeinfo does not expand macros in the argument to @deffn, which ends up
3491 % writing an index entry, and texindex isn't prepared for an index sort entry
3492 % that starts with \.
3494 % Since macro invocations are followed by braces, we can just redefine them
3495 % to take a single TeX argument. The case of a macro invocation that
3496 % goes to end-of-line is not handled.
3501 \let\indexbackslash=0 %overridden during \printindex.
3502 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3504 % Most index entries go through here, but \dosubind is the general case.
3505 % #1 is the index name, #2 is the entry text.
3506 \def\doind#1#2{\dosubind{#1}{#2}{}}
3508 % Workhorse for all \fooindexes.
3509 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3510 % empty if called from \doind, as we usually are (the main exception
3511 % is with most defuns, which call us directly).
3513 \def\dosubind#1#2#3{%
3516 % Store the main index entry text (including the third arg).
3518 % If third arg is present, precede it with a space.
3520 \ifx\thirdarg\empty \else
3521 \toks0 = \expandafter{\the\toks0 \space #3}%
3524 \edef\writeto{\csname#1indfile\endcsname}%
3535 % Write the entry in \toks0 to the index file:
3537 \def\dosubindwrite{%
3538 % Put the index entry in the margin if desired.
3539 \ifx\SETmarginindex\relax\else
3540 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3543 % Remember, we are within a group.
3544 \indexdummies % Must do this here, since \bf, etc expand at this stage
3545 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3546 % so it will be output as is; and it will print as backslash.
3548 % Process the index entry with all font commands turned off, to
3549 % get the string to sort by.
3551 \edef\temp{\the\toks0}% need full expansion
3552 \xdef\indexsorttmp{\temp}%
3555 % Set up the complete index entry, with both the sort key and
3556 % the original text, including any font commands. We write
3557 % three arguments to \entry to the .?? file (four in the
3558 % subentry case), texindex reduces to two when writing the .??s
3562 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3567 % Take care of unwanted page breaks:
3569 % If a skip is the last thing on the list now, preserve it
3570 % by backing up by \lastskip, doing the \write, then inserting
3571 % the skip again. Otherwise, the whatsit generated by the
3572 % \write will make \lastskip zero. The result is that sequences
3577 % will have extra space inserted, because the \medbreak in the
3578 % start of the @defun won't see the skip inserted by the @end of
3579 % the previous defun.
3581 % But don't do any of this if we're not in vertical mode. We
3582 % don't want to do a \vskip and prematurely end a paragraph.
3584 % Avoid page breaks due to these extra skips, too.
3586 % But wait, there is a catch there:
3587 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3588 % sufficient for this purpose, as it ignores stretch and shrink parts
3589 % of the skip. The only way seems to be to check the textual
3590 % representation of the skip.
3592 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3593 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3595 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3599 \def\dosubindsanitize{%
3600 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3602 \edef\lastskipmacro{\the\lastskip}%
3603 \count255 = \lastpenalty
3605 % If \lastskip is nonzero, that means the last item was a
3606 % skip. And since a skip is discardable, that means this
3607 % -\skip0 glue we're inserting is preceded by a
3608 % non-discardable item, therefore it is not a potential
3609 % breakpoint, therefore no \nobreak needed.
3610 \ifx\lastskipmacro\zeroskipmacro
3617 \ifx\lastskipmacro\zeroskipmacro
3618 % If \lastskip was zero, perhaps the last item was a penalty, and
3619 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3620 % to re-insert the same penalty (values >10000 are used for various
3621 % signals); since we just inserted a non-discardable item, any
3622 % following glue (such as a \parskip) would be a breakpoint. For example:
3624 % @deffn deffn-whatever
3625 % @vindex index-whatever
3627 % would allow a break between the index-whatever whatsit
3628 % and the "Description." paragraph.
3629 \ifnum\count255>9999 \penalty\count255 \fi
3631 % On the other hand, if we had a nonzero \lastskip,
3632 % this make-up glue would be preceded by a non-discardable item
3633 % (the whatsit from the \write), so we must insert a \nobreak.
3634 \nobreak\vskip\skip0
3638 % The index entry written in the file actually looks like
3639 % \entry {sortstring}{page}{topic}
3641 % \entry {sortstring}{page}{topic}{subtopic}
3642 % The texindex program reads in these files and writes files
3643 % containing these kinds of lines:
3645 % before the first topic whose initial is c
3646 % \entry {topic}{pagelist}
3647 % for a topic that is used without subtopics
3649 % for the beginning of a topic that is used with subtopics
3650 % \secondary {subtopic}{pagelist}
3651 % for each subtopic.
3653 % Define the user-accessible indexing commands
3654 % @findex, @vindex, @kindex, @cindex.
3656 \def\findex {\fnindex}
3657 \def\kindex {\kyindex}
3658 \def\cindex {\cpindex}
3659 \def\vindex {\vrindex}
3660 \def\tindex {\tpindex}
3661 \def\pindex {\pgindex}
3663 \def\cindexsub {\begingroup\obeylines\cindexsub}
3665 \gdef\cindexsub "#1" #2^^M{\endgroup %
3666 \dosubind{cp}{#2}{#1}}}
3668 % Define the macros used in formatting output of the sorted index material.
3670 % @printindex causes a particular index (the ??s file) to get printed.
3671 % It does not print any chapter heading (usually an @unnumbered).
3673 \parseargdef\printindex{\begingroup
3674 \dobreak \chapheadingskip{10000}%
3678 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3680 % See if the index file exists and is nonempty.
3681 % Change catcode of @ here so that if the index file contains
3683 % as its first line, TeX doesn't complain about mismatched braces
3684 % (because it thinks @} is a control sequence).
3686 \openin 1 \jobname.#1s
3688 % \enddoublecolumns gets confused if there is no text in the index,
3689 % and it loses the chapter title and the aux file entries for the
3690 % index. The easiest way to prevent this problem is to make sure
3691 % there is some text.
3692 \putwordIndexNonexistent
3695 % If the index file exists but is empty, then \openin leaves \ifeof
3696 % false. We have to make TeX try to read something from the file, so
3697 % it can discover if there is anything in it.
3700 \putwordIndexIsEmpty
3702 % Index files are almost Texinfo source, but we use \ as the escape
3703 % character. It would be better to use @, but that's too big a change
3704 % to make right now.
3705 \def\indexbackslash{\backslashcurfont}%
3716 % These macros are used by the sorted index file itself.
3717 % Change them to control the appearance of the index.
3720 % Some minor font changes for the special characters.
3721 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3723 % Remove any glue we may have, we'll be inserting our own.
3726 % We like breaks before the index initials, so insert a bonus.
3728 \vskip 0pt plus 3\baselineskip
3730 \vskip 0pt plus -3\baselineskip
3732 % Typeset the initial. Making this add up to a whole number of
3733 % baselineskips increases the chance of the dots lining up from column
3734 % to column. It still won't often be perfect, because of the stretch
3735 % we need before each entry, but it's better.
3737 % No shrink because it confuses \balancecolumns.
3738 \vskip 1.67\baselineskip plus .5\baselineskip
3739 \leftline{\secbf #1}%
3740 % Do our best not to break after the initial.
3742 \vskip .33\baselineskip plus .1\baselineskip
3745 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3746 % then page number (#2) flushed to the right margin. It is used for index
3747 % and table of contents entries. The paragraph is indented by \leftskip.
3749 % A straightforward implementation would start like this:
3750 % \def\entry#1#2{...
3751 % But this frozes the catcodes in the argument, and can cause problems to
3752 % @code, which sets - active. This problem was fixed by a kludge---
3753 % ``-'' was active throughout whole index, but this isn't really right.
3755 % The right solution is to prevent \entry from swallowing the whole text.
3760 % Start a new paragraph if necessary, so our assignments below can't
3761 % affect previous text.
3764 % Do not fill out the last line with white space.
3767 % No extra space above this paragraph.
3770 % Do not prefer a separate line ending with a hyphen to fewer lines.
3771 \finalhyphendemerits = 0
3773 % \hangindent is only relevant when the entry text and page number
3774 % don't both fit on one line. In that case, bob suggests starting the
3775 % dots pretty far over on the line. Unfortunately, a large
3776 % indentation looks wrong when the entry text itself is broken across
3777 % lines. So we use a small indentation and put up with long leaders.
3779 % \hangafter is reset to 1 (which is the value we want) at the start
3780 % of each paragraph, so we need not do anything with that.
3783 % When the entry text needs to be broken, just fill out the first line
3785 \rightskip = 0pt plus1fil
3787 % A bit of stretch before each entry for the benefit of balancing
3791 % Swallow the left brace of the text (first parameter):
3792 \afterassignment\doentry
3796 \bgroup % Instead of the swallowed brace.
3798 \aftergroup\finishentry
3799 % And now comes the text of the entry.
3801 \def\finishentry#1{%
3802 % #1 is the page number.
3804 % The following is kludged to not output a line of dots in the index if
3805 % there are no page numbers. The next person who breaks this will be
3806 % cursed by a Unix daemon.
3809 \edef\tempc{\tempa}%
3810 \edef\tempd{\tempb}%
3815 % If we must, put the page number on a line of its own, and fill out
3816 % this line with blank space. (The \hfil is overwhelmed with the
3817 % fill leaders glue in \indexdotfill if the page number does fit.)
3819 \null\nobreak\indexdotfill % Have leaders before the page number.
3821 % The `\ ' here is removed by the implicit \unskip that TeX does as
3822 % part of (the primitive) \par. Without it, a spurious underfull
3835 % Like \dotfill except takes at least 1 em.
3836 \def\indexdotfill{\cleaders
3837 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3839 \def\primary #1{\line{#1\hfil}}
3841 \newskip\secondaryindent \secondaryindent=0.5cm
3842 \def\secondary#1#2{{%
3847 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3849 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3856 % Define two-column mode, which we use to typeset indexes.
3857 % Adapted from the TeXbook, page 416, which is to say,
3858 % the manmac.tex format used to print the TeXbook itself.
3862 \newdimen\doublecolumnhsize
3864 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3865 % Grab any single-column material above us.
3868 % Here is a possibility not foreseen in manmac: if we accumulate a
3869 % whole lot of material, we might end up calling this \output
3870 % routine twice in a row (see the doublecol-lose test, which is
3871 % essentially a couple of indexes with @setchapternewpage off). In
3872 % that case we just ship out what is in \partialpage with the normal
3873 % output routine. Generally, \partialpage will be empty when this
3874 % runs and this will be a no-op. See the indexspread.tex test case.
3875 \ifvoid\partialpage \else
3876 \onepageout{\pagecontents\partialpage}%
3879 \global\setbox\partialpage = \vbox{%
3880 % Unvbox the main output page.
3882 \kern-\topskip \kern\baselineskip
3885 \eject % run that output routine to set \partialpage
3887 % Use the double-column output routine for subsequent pages.
3888 \output = {\doublecolumnout}%
3890 % Change the page size parameters. We could do this once outside this
3891 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3892 % format, but then we repeat the same computation. Repeating a couple
3893 % of assignments once per index is clearly meaningless for the
3894 % execution time, so we may as well do it in one place.
3896 % First we halve the line length, less a little for the gutter between
3897 % the columns. We compute the gutter based on the line length, so it
3898 % changes automatically with the paper format. The magic constant
3899 % below is chosen so that the gutter has the same value (well, +-<1pt)
3900 % as it did when we hard-coded it.
3902 % We put the result in a separate register, \doublecolumhsize, so we
3903 % can restore it in \pagesofar, after \hsize itself has (potentially)
3906 \doublecolumnhsize = \hsize
3907 \advance\doublecolumnhsize by -.04154\hsize
3908 \divide\doublecolumnhsize by 2
3909 \hsize = \doublecolumnhsize
3911 % Double the \vsize as well. (We don't need a separate register here,
3912 % since nobody clobbers \vsize.)
3916 % The double-column output routine for all double-column pages except
3919 \def\doublecolumnout{%
3920 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3921 % Get the available space for the double columns -- the normal
3922 % (undoubled) page height minus any material left over from the
3926 \advance\dimen@ by -\ht\partialpage
3928 % box0 will be the left-hand column, box2 the right.
3929 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3930 \onepageout\pagesofar
3932 \penalty\outputpenalty
3935 % Re-output the contents of the output page -- any previous material,
3936 % followed by the two boxes we just split, in box0 and box2.
3940 \hsize = \doublecolumnhsize
3941 \wd0=\hsize \wd2=\hsize
3942 \hbox to\pagewidth{\box0\hfil\box2}%
3945 % All done with double columns.
3946 \def\enddoublecolumns{%
3948 % Split the last of the double-column material. Leave it on the
3949 % current page, no automatic page break.
3952 % If we end up splitting too much material for the current page,
3953 % though, there will be another page break right after this \output
3954 % invocation ends. Having called \balancecolumns once, we do not
3955 % want to call it again. Therefore, reset \output to its normal
3956 % definition right away. (We hope \balancecolumns will never be
3957 % called on to balance too much material, but if it is, this makes
3958 % the output somewhat more palatable.)
3959 \global\output = {\onepageout{\pagecontents\PAGE}}%
3962 \endgroup % started in \begindoublecolumns
3964 % \pagegoal was set to the doubled \vsize above, since we restarted
3965 % the current page. We're now back to normal single-column
3966 % typesetting, so reset \pagegoal to the normal \vsize (after the
3967 % \endgroup where \vsize got restored).
3971 % Called at the end of the double column material.
3972 \def\balancecolumns{%
3973 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3975 \advance\dimen@ by \topskip
3976 \advance\dimen@ by-\baselineskip
3977 \divide\dimen@ by 2 % target to split to
3978 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3979 \splittopskip = \topskip
3980 % Loop until we get a decent breakpoint.
3984 \global\setbox3 = \copy0
3985 \global\setbox1 = \vsplit3 to \dimen@
3987 \global\advance\dimen@ by 1pt
3990 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3991 \setbox0=\vbox to\dimen@{\unvbox1}%
3992 \setbox2=\vbox to\dimen@{\unvbox3}%
3996 \catcode`\@ = \other
3999 \message{sectioning,}
4000 % Chapters, sections, etc.
4002 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4003 % sections so that we can refer to them unambiguously in the pdf
4004 % outlines by their "section number". We avoid collisions with chapter
4005 % numbers by starting them at 10000. (If a document ever has 10000
4006 % chapters, we're in trouble anyway, I'm sure.)
4007 \newcount\unnumberedno \unnumberedno = 10000
4009 \newcount\secno \secno=0
4010 \newcount\subsecno \subsecno=0
4011 \newcount\subsubsecno \subsubsecno=0
4013 % This counter is funny since it counts through charcodes of letters A, B, ...
4014 \newcount\appendixno \appendixno = `\@
4016 % \def\appendixletter{\char\the\appendixno}
4017 % We do the following ugly conditional instead of the above simple
4018 % construct for the sake of pdftex, which needs the actual
4019 % letter in the expansion, not just typeset.
4021 \def\appendixletter{%
4022 \ifnum\appendixno=`A A%
4023 \else\ifnum\appendixno=`B B%
4024 \else\ifnum\appendixno=`C C%
4025 \else\ifnum\appendixno=`D D%
4026 \else\ifnum\appendixno=`E E%
4027 \else\ifnum\appendixno=`F F%
4028 \else\ifnum\appendixno=`G G%
4029 \else\ifnum\appendixno=`H H%
4030 \else\ifnum\appendixno=`I I%
4031 \else\ifnum\appendixno=`J J%
4032 \else\ifnum\appendixno=`K K%
4033 \else\ifnum\appendixno=`L L%
4034 \else\ifnum\appendixno=`M M%
4035 \else\ifnum\appendixno=`N N%
4036 \else\ifnum\appendixno=`O O%
4037 \else\ifnum\appendixno=`P P%
4038 \else\ifnum\appendixno=`Q Q%
4039 \else\ifnum\appendixno=`R R%
4040 \else\ifnum\appendixno=`S S%
4041 \else\ifnum\appendixno=`T T%
4042 \else\ifnum\appendixno=`U U%
4043 \else\ifnum\appendixno=`V V%
4044 \else\ifnum\appendixno=`W W%
4045 \else\ifnum\appendixno=`X X%
4046 \else\ifnum\appendixno=`Y Y%
4047 \else\ifnum\appendixno=`Z Z%
4048 % The \the is necessary, despite appearances, because \appendixletter is
4049 % expanded while writing the .toc file. \char\appendixno is not
4050 % expandable, thus it is written literally, thus all appendixes come out
4051 % with the same letter (or @) in the toc without it.
4052 \else\char\the\appendixno
4053 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4054 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4056 % Each @chapter defines this as the name of the chapter.
4057 % page headings and footings can use it. @section does likewise.
4058 % However, they are not reliable, because we don't use marks.
4062 \newcount\absseclevel % used to calculate proper heading level
4063 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4065 % @raisesections: treat @section as chapter, @subsection as section, etc.
4066 \def\raisesections{\global\advance\secbase by -1}
4067 \let\up=\raisesections % original BFox name
4069 % @lowersections: treat @chapter as section, @section as subsection, etc.
4070 \def\lowersections{\global\advance\secbase by 1}
4071 \let\down=\lowersections % original BFox name
4073 % we only have subsub.
4074 \chardef\maxseclevel = 3
4076 % A numbered section within an unnumbered changes to unnumbered too.
4077 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4078 \chardef\unmlevel = \maxseclevel
4080 % Trace whether the current chapter is an appendix or not:
4081 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4082 \def\chapheadtype{N}
4084 % Choose a heading macro
4085 % #1 is heading type
4086 % #2 is heading level
4087 % #3 is text for heading
4088 \def\genhead#1#2#3{%
4089 % Compute the abs. sec. level:
4091 \advance\absseclevel by \secbase
4092 % Make sure \absseclevel doesn't fall outside the range:
4093 \ifnum \absseclevel < 0
4096 \ifnum \absseclevel > 3
4103 \ifnum \absseclevel < \unmlevel
4104 \chardef\unmlevel = \absseclevel
4107 % Check for appendix sections:
4108 \ifnum \absseclevel = 0
4109 \edef\chapheadtype{\headtype}%
4111 \if \headtype A\if \chapheadtype N%
4112 \errmessage{@appendix... within a non-appendix chapter}%
4115 % Check for numbered within unnumbered:
4116 \ifnum \absseclevel > \unmlevel
4119 \chardef\unmlevel = 3
4122 % Now print the heading:
4126 \or \unnumberedseczzz{#3}%
4127 \or \unnumberedsubseczzz{#3}%
4128 \or \unnumberedsubsubseczzz{#3}%
4134 \or \appendixsectionzzz{#3}%
4135 \or \appendixsubseczzz{#3}%
4136 \or \appendixsubsubseczzz{#3}%
4142 \or \numberedsubseczzz{#3}%
4143 \or \numberedsubsubseczzz{#3}%
4147 \suppressfirstparagraphindent
4151 \def\numhead{\genhead N}
4152 \def\apphead{\genhead A}
4153 \def\unnmhead{\genhead U}
4155 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4156 % all lower-level sectioning counters to zero.
4158 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4159 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4160 \let\chaplevelprefix = \empty
4162 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4164 % section resetting is \global in case the chapter is in a group, such
4165 % as an @include file.
4166 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4167 \global\advance\chapno by 1
4170 \gdef\chaplevelprefix{\the\chapno.}%
4173 \message{\putwordChapter\space \the\chapno}%
4175 % Write the actual heading.
4176 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4178 % So @section and the like are numbered underneath this chapter.
4179 \global\let\section = \numberedsec
4180 \global\let\subsection = \numberedsubsec
4181 \global\let\subsubsection = \numberedsubsubsec
4184 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4185 \def\appendixzzz#1{%
4186 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4187 \global\advance\appendixno by 1
4188 \gdef\chaplevelprefix{\appendixletter.}%
4191 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4192 \message{\appendixnum}%
4194 \chapmacro{#1}{Yappendix}{\appendixletter}%
4196 \global\let\section = \appendixsec
4197 \global\let\subsection = \appendixsubsec
4198 \global\let\subsubsection = \appendixsubsubsec
4201 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4202 \def\unnumberedzzz#1{%
4203 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4204 \global\advance\unnumberedno by 1
4206 % Since an unnumbered has no number, no prefix for figures.
4207 \global\let\chaplevelprefix = \empty
4210 % This used to be simply \message{#1}, but TeX fully expands the
4211 % argument to \message. Therefore, if #1 contained @-commands, TeX
4212 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4213 % expanded @cite (which turns out to cause errors because \cite is meant
4214 % to be executed, not expanded).
4216 % Anyway, we don't want the fully-expanded definition of @cite to appear
4217 % as a result of the \message, we just want `@cite' itself. We use
4218 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4219 % simply yielding the contents of <toks register>. (We also do this for
4222 \message{(\the\toks0)}%
4224 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4226 \global\let\section = \unnumberedsec
4227 \global\let\subsection = \unnumberedsubsec
4228 \global\let\subsubsection = \unnumberedsubsubsec
4231 % @centerchap is like @unnumbered, but the heading is centered.
4232 \outer\parseargdef\centerchap{%
4233 % Well, we could do the following in a group, but that would break
4234 % an assumption that \chapmacro is called at the outermost level.
4235 % Thus we are safer this way: --kasal, 24feb04
4236 \let\centerparametersmaybe = \centerparameters
4238 \let\centerparametersmaybe = \relax
4241 % @top is like @unnumbered.
4245 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4247 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4248 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4251 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4252 \def\appendixsectionzzz#1{%
4253 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4254 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4256 \let\appendixsec\appendixsection
4258 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4259 \def\unnumberedseczzz#1{%
4260 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4261 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4265 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4266 \def\numberedsubseczzz#1{%
4267 \global\subsubsecno=0 \global\advance\subsecno by 1
4268 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4271 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4272 \def\appendixsubseczzz#1{%
4273 \global\subsubsecno=0 \global\advance\subsecno by 1
4274 \sectionheading{#1}{subsec}{Yappendix}%
4275 {\appendixletter.\the\secno.\the\subsecno}%
4278 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4279 \def\unnumberedsubseczzz#1{%
4280 \global\subsubsecno=0 \global\advance\subsecno by 1
4281 \sectionheading{#1}{subsec}{Ynothing}%
4282 {\the\unnumberedno.\the\secno.\the\subsecno}%
4286 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4287 \def\numberedsubsubseczzz#1{%
4288 \global\advance\subsubsecno by 1
4289 \sectionheading{#1}{subsubsec}{Ynumbered}%
4290 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4293 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4294 \def\appendixsubsubseczzz#1{%
4295 \global\advance\subsubsecno by 1
4296 \sectionheading{#1}{subsubsec}{Yappendix}%
4297 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4300 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4301 \def\unnumberedsubsubseczzz#1{%
4302 \global\advance\subsubsecno by 1
4303 \sectionheading{#1}{subsubsec}{Ynothing}%
4304 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4307 % These macros control what the section commands do, according
4308 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4309 % Define them by default for a numbered chapter.
4310 \let\section = \numberedsec
4311 \let\subsection = \numberedsubsec
4312 \let\subsubsection = \numberedsubsubsec
4314 % Define @majorheading, @heading and @subheading
4316 % NOTE on use of \vbox for chapter headings, section headings, and such:
4317 % 1) We use \vbox rather than the earlier \line to permit
4318 % overlong headings to fold.
4319 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4320 % heading is obnoxious; this forbids it.
4321 % 3) Likewise, headings look best if no \parindent is used, and
4322 % if justification is not attempted. Hence \raggedright.
4326 {\advance\chapheadingskip by 10pt \chapbreak }%
4327 \parsearg\chapheadingzzz
4330 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4331 \def\chapheadingzzz#1{%
4332 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4333 \parindent=0pt\raggedright
4335 \bigskip \par\penalty 200\relax
4336 \suppressfirstparagraphindent
4339 % @heading, @subheading, @subsubheading.
4340 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4341 \suppressfirstparagraphindent}
4342 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4343 \suppressfirstparagraphindent}
4344 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4345 \suppressfirstparagraphindent}
4347 % These macros generate a chapter, section, etc. heading only
4348 % (including whitespace, linebreaking, etc. around it),
4349 % given all the information in convenient, parsed form.
4351 %%% Args are the skip and penalty (usually negative)
4352 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4354 %%% Define plain chapter starts, and page on/off switching for it
4355 % Parameter controlling skip before chapter headings (if needed)
4357 \newskip\chapheadingskip
4359 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4360 \def\chappager{\par\vfill\supereject}
4361 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4363 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4366 \global\let\contentsalignmacro = \chappager
4367 \global\let\pchapsepmacro=\chapbreak
4368 \global\let\pagealignmacro=\chappager}
4371 \global\let\contentsalignmacro = \chappager
4372 \global\let\pchapsepmacro=\chappager
4373 \global\let\pagealignmacro=\chappager
4374 \global\def\HEADINGSon{\HEADINGSsingle}}
4377 \global\let\contentsalignmacro = \chapoddpage
4378 \global\let\pchapsepmacro=\chapoddpage
4379 \global\let\pagealignmacro=\chapoddpage
4380 \global\def\HEADINGSon{\HEADINGSdouble}}
4386 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4387 % Yappendix, Yomitfromtoc), #3 the chapter number.
4389 % To test against our argument.
4390 \def\Ynothingkeyword{Ynothing}
4391 \def\Yomitfromtockeyword{Yomitfromtoc}
4392 \def\Yappendixkeyword{Yappendix}
4394 \def\chapmacro#1#2#3{%
4399 % Have to define \thissection before calling \donoderef, because the
4400 % xref code eventually uses it. On the other hand, it has to be called
4401 % after \pchapsepmacro, or the headline will change too soon.
4402 \gdef\thissection{#1}%
4403 \gdef\thischaptername{#1}%
4405 % Only insert the separating space if we have a chapter/appendix
4406 % number, and don't print the unnumbered ``number''.
4408 \ifx\temptype\Ynothingkeyword
4410 \def\toctype{unnchap}%
4411 \gdef\thischapter{#1}%
4412 \else\ifx\temptype\Yomitfromtockeyword
4413 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4415 \gdef\thischapter{}%
4416 \else\ifx\temptype\Yappendixkeyword
4417 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4419 % We don't substitute the actual chapter name into \thischapter
4420 % because we don't want its macros evaluated now. And we don't
4421 % use \thissection because that changes with each section.
4423 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4424 \noexpand\thischaptername}%
4426 \setbox0 = \hbox{#3\enspace}%
4427 \def\toctype{numchap}%
4428 \xdef\thischapter{\putwordChapter{} \the\chapno:
4429 \noexpand\thischaptername}%
4432 % Write the toc entry for this chapter. Must come before the
4433 % \donoderef, because we include the current node name in the toc
4434 % entry, and \donoderef resets it to empty.
4435 \writetocentry{\toctype}{#1}{#3}%
4437 % For pdftex, we have to write out the node definition (aka, make
4438 % the pdfdest) after any page break, but before the actual text has
4439 % been typeset. If the destination for the pdf outline is after the
4440 % text, then jumping from the outline may wind up with the text not
4441 % being visible, for instance under high magnification.
4444 % Typeset the actual heading.
4445 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4446 \hangindent=\wd0 \centerparametersmaybe
4449 \nobreak\bigskip % no page break after a chapter title
4453 % @centerchap -- centered and unnumbered.
4454 \let\centerparametersmaybe = \relax
4455 \def\centerparameters{%
4456 \advance\rightskip by 3\rightskip
4457 \leftskip = \rightskip
4462 % I don't think this chapter style is supported any more, so I'm not
4463 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4465 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4467 \def\unnchfopen #1{%
4468 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4469 \parindent=0pt\raggedright
4470 \rm #1\hfill}}\bigskip \par\nobreak
4472 \def\chfopen #1#2{\chapoddpage {\chapfonts
4473 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4476 \def\centerchfopen #1{%
4477 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4479 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4482 \global\let\chapmacro=\chfopen
4483 \global\let\centerchapmacro=\centerchfopen}
4486 % Section titles. These macros combine the section number parts and
4487 % call the generic \sectionheading to do the printing.
4489 \newskip\secheadingskip
4490 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4492 % Subsection titles.
4493 \newskip\subsecheadingskip
4494 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4496 % Subsubsection titles.
4497 \def\subsubsecheadingskip{\subsecheadingskip}
4498 \def\subsubsecheadingbreak{\subsecheadingbreak}
4501 % Print any size, any type, section title.
4503 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4504 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4507 \def\sectionheading#1#2#3#4{%
4509 % Switch to the right set of fonts.
4510 \csname #2fonts\endcsname \rm
4512 % Insert space above the heading.
4513 \csname #2headingbreak\endcsname
4515 % Only insert the space after the number if we have a section number.
4516 \def\sectionlevel{#2}%
4519 \ifx\temptype\Ynothingkeyword
4522 \gdef\thissection{#1}%
4523 \else\ifx\temptype\Yomitfromtockeyword
4524 % for @headings -- no section number, don't include in toc,
4525 % and don't redefine \thissection.
4528 \let\sectionlevel=\empty
4529 \else\ifx\temptype\Yappendixkeyword
4530 \setbox0 = \hbox{#4\enspace}%
4532 \gdef\thissection{#1}%
4534 \setbox0 = \hbox{#4\enspace}%
4536 \gdef\thissection{#1}%
4539 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4540 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4542 % Write the node reference (= pdf destination for pdftex).
4543 % Again, see comments in \chapmacro.
4546 % Interline glue will be inserted when the vbox is completed.
4547 % That glue will be a valid breakpoint for the page, since it'll be
4548 % preceded by a whatsit (usually from the \donoderef, or from the
4549 % \writetocentry if there was no node). We don't want to allow that
4550 % break, since then the whatsits could end up on page n while the
4551 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4554 % Output the actual section heading.
4555 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4556 \hangindent=\wd0 % zero if no section number
4559 % Add extra space after the heading -- half of whatever came above it.
4560 % Don't allow stretch, though.
4561 \kern .5 \csname #2headingskip\endcsname
4563 % Do not let the kern be a potential breakpoint, as it would be if it
4564 % was followed by glue.
4567 % We'll almost certainly start a paragraph next, so don't let that
4568 % glue accumulate. (Not a breakpoint because it's preceded by a
4569 % discardable item.)
4572 % This is purely so the last item on the list is a known \penalty >
4573 % 10000. This is so \startdefun can avoid allowing breakpoints after
4574 % section headings. Otherwise, it would insert a valid breakpoint between:
4576 % @section sec-whatever
4577 % @deffn def-whatever
4583 % Table of contents.
4586 % Write an entry to the toc file, opening it if necessary.
4587 % Called from @chapter, etc.
4589 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4590 % We append the current node name (if any) and page number as additional
4591 % arguments for the \{chap,sec,...}entry macros which will eventually
4592 % read this. The node name is used in the pdf outlines as the
4593 % destination to jump to.
4595 % We open the .toc file for writing here instead of at @setfilename (or
4596 % any other fixed time) so that @contents can be anywhere in the document.
4597 % But if #1 is `omit', then we don't do anything. This is used for the
4598 % table of contents chapter openings themselves.
4600 \newif\iftocfileopened
4601 \def\omitkeyword{omit}%
4603 \def\writetocentry#1#2#3{%
4604 \edef\writetoctype{#1}%
4605 \ifx\writetoctype\omitkeyword \else
4606 \iftocfileopened\else
4607 \immediate\openout\tocfile = \jobname.toc
4608 \global\tocfileopenedtrue
4614 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4620 % Tell \shipout to create a pdf destination on each page, if we're
4621 % writing pdf. These are used in the table of contents. We can't
4622 % just write one on every page because the title pages are numbered
4623 % 1 and 2 (the page numbers aren't printed), and so are the first
4624 % two pages of the document. Thus, we'd have two destinations named
4625 % `1', and two named `2'.
4626 \ifpdf \global\pdfmakepagedesttrue \fi
4630 % These characters do not print properly in the Computer Modern roman
4631 % fonts, so we must take special care. This is more or less redundant
4632 % with the Texinfo input format setup at the end of this file.
4634 \def\activecatcodes{%
4647 % Read the toc file, which is essentially Texinfo input.
4654 \newskip\contentsrightmargin \contentsrightmargin=1in
4655 \newcount\savepageno
4656 \newcount\lastnegativepageno \lastnegativepageno = -1
4658 % Prepare to read what we've written to \tocfile.
4660 \def\startcontents#1{%
4661 % If @setchapternewpage on, and @headings double, the contents should
4662 % start on an odd page, unlike chapters. Thus, we maintain
4663 % \contentsalignmacro in parallel with \pagealignmacro.
4664 % From: Torbjorn Granlund <tege@matematik.su.se>
4666 \immediate\closeout\tocfile
4668 % Don't need to put `Contents' or `Short Contents' in the headline.
4669 % It is abundantly clear what they are.
4671 \chapmacro{#1}{Yomitfromtoc}{}%
4673 \savepageno = \pageno
4674 \begingroup % Set up to handle contents files properly.
4675 \raggedbottom % Worry more about breakpoints than the bottom.
4676 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4678 % Roman numerals for page numbers.
4679 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4683 % Normal (long) toc.
4685 \startcontents{\putwordTOC}%
4686 \openin 1 \jobname.toc
4691 \contentsalignmacro % in case @setchapternewpage odd is in effect
4697 \lastnegativepageno = \pageno
4698 \global\pageno = \savepageno
4701 % And just the chapters.
4702 \def\summarycontents{%
4703 \startcontents{\putwordShortTOC}%
4705 \let\numchapentry = \shortchapentry
4706 \let\appentry = \shortchapentry
4707 \let\unnchapentry = \shortunnchapentry
4708 % We want a true roman here for the page numbers.
4710 \let\rm=\shortcontrm \let\bf=\shortcontbf
4711 \let\sl=\shortcontsl \let\tt=\shortconttt
4713 \hyphenpenalty = 10000
4714 \advance\baselineskip by 1pt % Open it up a little.
4715 \def\numsecentry##1##2##3##4{}
4716 \let\appsecentry = \numsecentry
4717 \let\unnsecentry = \numsecentry
4718 \let\numsubsecentry = \numsecentry
4719 \let\appsubsecentry = \numsecentry
4720 \let\unnsubsecentry = \numsecentry
4721 \let\numsubsubsecentry = \numsecentry
4722 \let\appsubsubsecentry = \numsecentry
4723 \let\unnsubsubsecentry = \numsecentry
4724 \openin 1 \jobname.toc
4730 \contentsalignmacro % in case @setchapternewpage odd is in effect
4732 \lastnegativepageno = \pageno
4733 \global\pageno = \savepageno
4735 \let\shortcontents = \summarycontents
4737 % Typeset the label for a chapter or appendix for the short contents.
4738 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4740 \def\shortchaplabel#1{%
4741 % This space should be enough, since a single number is .5em, and the
4742 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4743 % But use \hss just in case.
4744 % (This space doesn't include the extra space that gets added after
4745 % the label; that gets put in by \shortchapentry above.)
4747 % We'd like to right-justify chapter numbers, but that looks strange
4748 % with appendix letters. And right-justifying numbers and
4749 % left-justifying letters looks strange when there is less than 10
4750 % chapters. Have to read the whole toc once to know how many chapters
4751 % there are before deciding ...
4752 \hbox to 1em{#1\hss}%
4755 % These macros generate individual entries in the table of contents.
4756 % The first argument is the chapter or section name.
4757 % The last argument is the page number.
4758 % The arguments in between are the chapter number, section number, ...
4760 % Chapters, in the main contents.
4761 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4763 % Chapters, in the short toc.
4764 % See comments in \dochapentry re vbox and related settings.
4765 \def\shortchapentry#1#2#3#4{%
4766 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4769 % Appendices, in the main contents.
4770 % Need the word Appendix, and a fixed-size box.
4772 \def\appendixbox#1{%
4773 % We use M since it's probably the widest letter.
4774 \setbox0 = \hbox{\putwordAppendix{} M}%
4775 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4777 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4779 % Unnumbered chapters.
4780 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4781 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4784 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4785 \let\appsecentry=\numsecentry
4786 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4789 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4790 \let\appsubsecentry=\numsubsecentry
4791 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4793 % And subsubsections.
4794 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4795 \let\appsubsubsecentry=\numsubsubsecentry
4796 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4798 % This parameter controls the indentation of the various levels.
4799 % Same as \defaultparindent.
4800 \newdimen\tocindent \tocindent = 15pt
4802 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4805 % If the toc has to be broken over pages, we want it to be at chapters
4806 % if at all possible; hence the \penalty.
4807 \def\dochapentry#1#2{%
4808 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4811 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4813 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4816 \def\dosecentry#1#2{\begingroup
4817 \secentryfonts \leftskip=\tocindent
4818 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4821 \def\dosubsecentry#1#2{\begingroup
4822 \subsecentryfonts \leftskip=2\tocindent
4823 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4826 \def\dosubsubsecentry#1#2{\begingroup
4827 \subsubsecentryfonts \leftskip=3\tocindent
4828 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4831 % We use the same \entry macro as for the index entries.
4832 \let\tocentry = \entry
4834 % Space between chapter (or whatever) number and the title.
4835 \def\labelspace{\hskip1em \relax}
4837 \def\dopageno#1{{\rm #1}}
4838 \def\doshortpageno#1{{\rm #1}}
4840 \def\chapentryfonts{\secfonts \rm}
4841 \def\secentryfonts{\textfonts}
4842 \def\subsecentryfonts{\textfonts}
4843 \def\subsubsecentryfonts{\textfonts}
4846 \message{environments,}
4847 % @foo ... @end foo.
4849 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4851 % Since these characters are used in examples, it should be an even number of
4852 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4855 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4856 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4857 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4858 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4860 % The @error{} command.
4861 % Adapted from the TeXbook's \boxit.
4865 {\tentt \global\dimen0 = 3em}% Width of the box.
4866 \dimen2 = .55pt % Thickness of rules
4867 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4868 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4870 \setbox\errorbox=\hbox to \dimen0{\hfil
4871 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4872 \advance\hsize by -2\dimen2 % Rules.
4874 \hrule height\dimen2
4875 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4876 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4877 \kern3pt\vrule width\dimen2}% Space to right.
4878 \hrule height\dimen2}
4881 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4883 % @tex ... @end tex escapes into raw Tex temporarily.
4884 % One exception: @ is still an escape character, so that @end tex works.
4885 % But \@ or @@ will get a plain tex @ character.
4888 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4889 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4890 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4900 \let\bullet=\ptexbullet
4905 \let\equiv=\ptexequiv
4908 \let\indent=\ptexindent
4909 \let\noindent=\ptexnoindent
4916 \let\frenchspacing=\plainfrenchspacing
4918 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4919 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4922 % There is no need to define \Etex.
4924 % Define @lisp ... @end lisp.
4925 % @lisp environment forms a group so it can rebind things,
4926 % including the definition of @end lisp (which normally is erroneous).
4928 % Amount to narrow the margins by for @lisp.
4929 \newskip\lispnarrowing \lispnarrowing=0.4in
4931 % This is the definition that ^^M gets inside @lisp, @example, and other
4932 % such environments. \null is better than a space, since it doesn't
4934 \def\lisppar{\null\endgraf}
4936 % This space is always present above and below environments.
4937 \newskip\envskipamount \envskipamount = 0pt
4939 % Make spacing and below environment symmetrical. We use \parskip here
4940 % to help in doing that, since in @example-like environments \parskip
4941 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4942 % start of the next paragraph will insert \parskip.
4944 \def\aboveenvbreak{{%
4945 % =10000 instead of <10000 because of a special case in \itemzzz and
4946 % \sectionheading, q.v.
4947 \ifnum \lastpenalty=10000 \else
4948 \advance\envskipamount by \parskip
4950 \ifdim\lastskip<\envskipamount
4952 % it's not a good place to break if the last penalty was \nobreak
4954 \ifnum\lastpenalty<10000 \penalty-50 \fi
4955 \vskip\envskipamount
4960 \let\afterenvbreak = \aboveenvbreak
4962 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
4963 % also clear it, so that its embedded environments do the narrowing again.
4964 \let\nonarrowing=\relax
4966 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4967 % environment contents.
4968 \font\circle=lcircle10
4970 \newdimen\cartouter\newdimen\cartinner
4971 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4972 \circthick=\fontdimen8\circle
4974 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4975 \def\ctr{{\hskip 6pt\circle\char'010}}
4976 \def\cbl{{\circle\char'012\hskip -6pt}}
4977 \def\cbr{{\hskip 6pt\circle\char'011}}
4978 \def\carttop{\hbox to \cartouter{\hskip\lskip
4979 \ctl\leaders\hrule height\circthick\hfil\ctr
4981 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4982 \cbl\leaders\hrule height\circthick\hfil\cbr
4985 \newskip\lskip\newskip\rskip
4988 \ifhmode\par\fi % can't be in the midst of a paragraph.
4990 \lskip=\leftskip \rskip=\rightskip
4991 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4992 \cartinner=\hsize \advance\cartinner by-\lskip
4993 \advance\cartinner by-\rskip
4995 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4996 % side, and for 6pt waste from
4997 % each corner char, and rule thickness
4998 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4999 % Flag to tell @lisp, etc., not to narrow margin.
5000 \let\nonarrowing = t%
5002 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5010 \baselineskip=\normbskip
5011 \lineskip=\normlskip
5014 \comment % For explanation, see the end of \def\group.
5029 % This macro is called at the beginning of all the @example variants,
5033 \hfuzz = 12pt % Don't be fussy
5034 \sepspaces % Make spaces be word-separators rather than space tokens.
5035 \let\par = \lisppar % don't ignore blank lines
5036 \obeylines % each line of input is a line of output
5039 \emergencystretch = 0pt % don't try to avoid overfull boxes
5040 \ifx\nonarrowing\relax
5041 \advance \leftskip by \lispnarrowing
5042 \exdentamount=\lispnarrowing
5044 \let\nonarrowing = \relax
5046 \let\exdent=\nofillexdent
5049 % If you want all examples etc. small: @set dispenvsize small.
5050 % If you want even small examples the full size: @set dispenvsize nosmall.
5051 % This affects the following displayed environments:
5052 % @example, @display, @format, @lisp
5054 \def\smallword{small}
5055 \def\nosmallword{nosmall}
5056 \let\SETdispenvsize\relax
5057 \def\setnormaldispenv{%
5058 \ifx\SETdispenvsize\smallword
5059 \smallexamplefonts \rm
5062 \def\setsmalldispenv{%
5063 \ifx\SETdispenvsize\nosmallword
5065 \smallexamplefonts \rm
5069 % We often define two environments, @foo and @smallfoo.
5070 % Let's do it by one command:
5071 \def\makedispenv #1#2{
5072 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5073 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5074 \expandafter\let\csname E#1\endcsname \afterenvbreak
5075 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5078 % Define two synonyms:
5079 \def\maketwodispenvs #1#2#3{
5080 \makedispenv{#1}{#3}
5081 \makedispenv{#2}{#3}
5084 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5086 % @smallexample and @smalllisp: use smaller fonts.
5087 % Originally contributed by Pavel@xerox.
5089 \maketwodispenvs {lisp}{example}{%
5092 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5093 \gobble % eat return
5095 % @display/@smalldisplay: same as @lisp except keep current font.
5097 \makedispenv {display}{%
5102 % @format/@smallformat: same as @display except don't narrow margins.
5104 \makedispenv{format}{%
5105 \let\nonarrowing = t%
5110 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5112 \let\nonarrowing = t%
5116 \let\Eflushleft = \afterenvbreak
5120 \envdef\flushright{%
5121 \let\nonarrowing = t%
5123 \advance\leftskip by 0pt plus 1fill
5126 \let\Eflushright = \afterenvbreak
5129 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5130 % and narrows the margins. We keep \parskip nonzero in general, since
5131 % we're doing normal filling. So, when using \aboveenvbreak and
5132 % \afterenvbreak, temporarily make \parskip 0.
5135 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5138 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5139 \ifx\nonarrowing\relax
5140 \advance\leftskip by \lispnarrowing
5141 \advance\rightskip by \lispnarrowing
5142 \exdentamount = \lispnarrowing
5144 \let\nonarrowing = \relax
5146 \parsearg\quotationlabel
5149 % We have retained a nonzero parskip for the environment, since we're
5150 % doing normal filling.
5154 \ifx\quotationauthor\undefined\else
5156 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5158 {\parskip=0pt \afterenvbreak}%
5161 % If we're given an argument, typeset it in bold with a colon after.
5162 \def\quotationlabel#1{%
5164 \ifx\temp\empty \else
5170 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5171 % If we want to allow any <char> as delimiter,
5172 % we need the curly braces so that makeinfo sees the @verb command, eg:
5173 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5175 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5177 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5178 % active too. Otherwise, they get lost as the first character on a
5181 \do\ \do\\\do\{\do\}\do\$\do\&%
5182 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5183 \do\<\do\>\do\|\do\@\do+\do\"%
5187 \def\uncatcodespecials{%
5188 \def\do##1{\catcode`##1=\other}\dospecials}
5190 % [Knuth] pp. 380,381,391
5191 % Disable Spanish ligatures ?` and !` of \tt font
5193 \catcode`\`=\active\gdef`{\relax\lq}
5196 % Setup for the @verb command.
5198 % Eight spaces for a tab
5200 \catcode`\^^I=\active
5201 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5205 \tt % easiest (and conventionally used) font for verbatim
5206 \def\par{\leavevmode\endgraf}%
5209 % Respect line breaks,
5210 % print special symbols as themselves, and
5211 % make each space count
5212 % must do in this order:
5213 \obeylines \uncatcodespecials \sepspaces
5216 % Setup for the @verbatim environment
5218 % Real tab expansion
5219 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5221 \def\starttabbox{\setbox0=\hbox\bgroup}
5224 % Don't replace quotes with curly quotes. This makes cut & pasting
5225 % from a PDF file problematic.
5227 \def\singlequotechar{\char'15\relax}
5229 \catcode`\^^I=\active
5231 \catcode`\^^I=\active
5232 \def^^I{\leavevmode\egroup
5233 \dimen0=\wd0 % the width so far, or since the previous tab
5234 \divide\dimen0 by\tabw
5235 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5236 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5237 \wd0=\dimen0 \box0 \starttabbox
5243 \def'{\singlequotechar}
5246 \def\setupverbatim{%
5247 \let\nonarrowing = t%
5249 % Easiest (and conventionally used) font for verbatim
5251 \def\par{\leavevmode\egroup\box0\endgraf}%
5255 % Respect line breaks,
5256 % print special symbols as themselves, and
5257 % make each space count
5258 % must do in this order:
5259 \obeylines \uncatcodespecials \sepspaces
5260 \everypar{\starttabbox}%
5263 % Do the @verb magic: verbatim text is quoted by unique
5264 % delimiter characters. Before first delimiter expect a
5265 % right brace, after last delimiter expect closing brace:
5267 % \def\doverb'{'<char>#1<char>'}'{#1}
5269 % [Knuth] p. 382; only eat outer {}
5271 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5272 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5275 \def\verb{\begingroup\setupverb\doverb}
5278 % Do the @verbatim magic: define the macro \doverbatim so that
5279 % the (first) argument ends when '@end verbatim' is reached, ie:
5281 % \def\doverbatim#1@end verbatim{#1}
5283 % For Texinfo it's a lot easier than for LaTeX,
5284 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5285 % we need not redefine '\', '{' and '}'.
5287 % Inspired by LaTeX's verbatim command set [latex.ltx]
5292 % ignore everything up to the first ^^M, that's the newline at the end
5293 % of the @verbatim input line itself. Otherwise we get an extra blank
5294 % line in the output.
5295 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5296 % We really want {...\end verbatim} in the body of the macro, but
5297 % without the active space; thus we have to use \xdef and \gobble.
5301 \setupverbatim\doverbatim
5303 \let\Everbatim = \afterenvbreak
5306 % @verbatiminclude FILE - insert text of file in verbatim environment.
5308 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5310 \def\doverbatiminclude#1{%
5312 \makevalueexpandable
5319 % @copying ... @end copying.
5320 % Save the text away for @insertcopying later.
5322 % We save the uninterpreted tokens, rather than creating a box.
5323 % Saving the text in a box would be much easier, but then all the
5324 % typesetting commands (@smallbook, font changes, etc.) have to be done
5325 % beforehand -- and a) we want @copying to be done first in the source
5326 % file; b) letting users define the frontmatter in as flexible order as
5327 % possible is very desirable.
5329 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5330 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5332 \def\insertcopying{%
5334 \parindent = 0pt % paragraph indentation looks wrong on title page
5335 \scanexp\copyingtext
5342 \newskip\defbodyindent \defbodyindent=.4in
5343 \newskip\defargsindent \defargsindent=50pt
5344 \newskip\deflastargmargin \deflastargmargin=18pt
5346 % Start the processing of @deffn:
5348 \ifnum\lastpenalty<10000
5351 % If there are two @def commands in a row, we'll have a \nobreak,
5352 % which is there to keep the function description together with its
5353 % header. But if there's nothing but headers, we need to allow a
5354 % break somewhere. Check specifically for penalty 10002, inserted
5355 % by \defargscommonending, instead of 10000, since the sectioning
5356 % commands also insert a nobreak penalty, and we don't want to allow
5357 % a break between a section heading and a defun.
5359 \ifnum\lastpenalty=10002 \penalty2000 \fi
5361 % Similarly, after a section heading, do not allow a break.
5362 % But do insert the glue.
5363 \medskip % preceded by discardable penalty, so not a breakpoint
5367 \advance\leftskip by \defbodyindent
5368 \exdentamount=\defbodyindent
5372 % First, check whether we are in the right environment:
5375 % As above, allow line break if we have multiple x headers in a row.
5376 % It's not a great place, though.
5377 \ifnum\lastpenalty=10002 \penalty3000 \fi
5379 % And now, it's time to reuse the body of the original defun:
5380 \expandafter\gobbledefun#1%
5382 \def\gobbledefun#1\startdefun{}
5384 % \printdefunline \deffnheader{text}
5386 \def\printdefunline#1#2{%
5388 % call \deffnheader:
5391 \interlinepenalty = 10000
5392 \advance\rightskip by 0pt plus 1fil
5394 \nobreak\vskip -\parskip
5395 \penalty 10002 % signal to \startdefun and \dodefunx
5396 % Some of the @defun-type tags do not enable magic parentheses,
5397 % rendering the following check redundant. But we don't optimize.
5402 \def\Edefun{\endgraf\medbreak}
5404 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5405 % the only thing remainnig is to define \deffnheader.
5408 \expandafter\let\csname E#1\endcsname = \Edefun
5409 \edef\temp{\noexpand\domakedefun
5410 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5414 % \domakedefun \deffn \deffnx \deffnheader
5416 % Define \deffn and \deffnx, without parameters.
5417 % \deffnheader has to be defined explicitly.
5419 \def\domakedefun#1#2#3{%
5422 \parseargusing\activeparens{\printdefunline#3}%
5424 \def#2{\dodefunx#1}%
5428 %%% Untyped functions:
5430 % @deffn category name args
5431 \makedefun{deffn}{\deffngeneral{}}
5433 % @deffn category class name args
5434 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5436 % \defopon {category on}class name args
5437 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5439 % \deffngeneral {subind}category name args
5441 \def\deffngeneral#1#2 #3 #4\endheader{%
5442 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5443 \dosubind{fn}{\code{#3}}{#1}%
5444 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5447 %%% Typed functions:
5449 % @deftypefn category type name args
5450 \makedefun{deftypefn}{\deftypefngeneral{}}
5452 % @deftypeop category class type name args
5453 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5455 % \deftypeopon {category on}class type name args
5456 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5458 % \deftypefngeneral {subind}category type name args
5460 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5461 \dosubind{fn}{\code{#4}}{#1}%
5462 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5465 %%% Typed variables:
5467 % @deftypevr category type var args
5468 \makedefun{deftypevr}{\deftypecvgeneral{}}
5470 % @deftypecv category class type var args
5471 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5473 % \deftypecvof {category of}class type var args
5474 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5476 % \deftypecvgeneral {subind}category type var args
5478 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5479 \dosubind{vr}{\code{#4}}{#1}%
5480 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5483 %%% Untyped variables:
5485 % @defvr category var args
5486 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5488 % @defcv category class var args
5489 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5491 % \defcvof {category of}class var args
5492 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5495 % @deftp category name args
5496 \makedefun{deftp}#1 #2 #3\endheader{%
5497 \doind{tp}{\code{#2}}%
5498 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5501 % Remaining @defun-like shortcuts:
5502 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5503 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5504 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5505 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5506 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5507 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5508 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5509 \makedefun{defmethod}{\defopon\putwordMethodon}
5510 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5511 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5512 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5514 % \defname, which formats the name of the @def (not the args).
5515 % #1 is the category, such as "Function".
5516 % #2 is the return type, if any.
5517 % #3 is the function name.
5519 % We are followed by (but not passed) the arguments, if any.
5521 \def\defname#1#2#3{%
5522 % Get the values of \leftskip and \rightskip as they were outside the @def...
5523 \advance\leftskip by -\defbodyindent
5525 % How we'll format the type name. Putting it in brackets helps
5526 % distinguish it from the body text that may end up on the next line
5529 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5531 % Figure out line sizes for the paragraph shape.
5532 % The first line needs space for \box0; but if \rightskip is nonzero,
5533 % we need only space for the part of \box0 which exceeds it:
5534 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5535 % The continuations:
5536 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5537 % (plain.tex says that \dimen1 should be used only as global.)
5538 \parshape 2 0in \dimen0 \defargsindent \dimen2
5540 % Put the type name to the right margin.
5543 \hfil\box0 \kern-\hsize
5544 % \hsize has to be shortened this way:
5546 % Intentionally do not respect \rightskip, since we need the space.
5549 % Allow all lines to be underfull without complaint:
5550 \tolerance=10000 \hbadness=10000
5551 \exdentamount=\defbodyindent
5553 % defun fonts. We use typewriter by default (used to be bold) because:
5554 % . we're printing identifiers, they should be in tt in principle.
5555 % . in languages with many accents, such as Czech or French, it's
5556 % common to leave accents off identifiers. The result looks ok in
5557 % tt, but exceedingly strange in rm.
5558 % . we don't want -- and --- to be treated as ligatures.
5559 % . this still does not fix the ?` and !` ligatures, but so far no
5560 % one has made identifiers using them :).
5562 \def\temp{#2}% return value type
5563 \ifx\temp\empty\else \tclose{\temp} \fi
5564 #3% output function name
5566 {\rm\enskip}% hskip 0.5 em of \tenrm
5569 % arguments will be output next, if any.
5572 % Print arguments in slanted roman (not ttsl), inconsistently with using
5573 % tt for the name. This is because literal text is sometimes needed in
5574 % the argument list (groff manual), and ttsl and tt are not very
5575 % distinguishable. Prevent hyphenation at `-' chars.
5578 % use sl by default (not ttsl),
5580 \df \sl \hyphenchar\font=0
5582 % On the other hand, if an argument has two dashes (for instance), we
5583 % want a way to get ttsl. Let's try @var for that.
5586 \sl\hyphenchar\font=45
5589 % We want ()&[] to print specially on the defun line.
5592 \catcode`\(=\active \catcode`\)=\active
5593 \catcode`\[=\active \catcode`\]=\active
5597 % Make control sequences which act like normal parenthesis chars.
5598 \let\lparen = ( \let\rparen = )
5600 % Be sure that we always have a definition for `(', etc. For example,
5601 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5602 % so TeX would otherwise complain about undefined control sequence.
5605 \global\let(=\lparen \global\let)=\rparen
5606 \global\let[=\lbrack \global\let]=\rbrack
5609 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5610 \gdef\magicamp{\let&=\amprm}
5613 \newcount\parencount
5615 % If we encounter &foo, then turn on ()-hacking afterwards
5617 \def\amprm#1 {\ampseentrue{\bf\ }}
5621 % At the first level, print parens in roman,
5622 % otherwise use the default font.
5623 \ifnum \parencount=1 \rm \fi
5625 % The \sf parens (in \boldbrax) actually are a little bolder than
5626 % the contained text. This is especially needed for [ and ] .
5630 \def\infirstlevel#1{%
5637 \def\bfafterword#1 {#1 \bf}
5640 \global\advance\parencount by 1
5642 \infirstlevel \bfafterword
5647 \global\advance\parencount by -1
5650 \newcount\brackcount
5652 \global\advance\brackcount by 1
5657 \global\advance\brackcount by -1
5660 \def\checkparencounts{%
5661 \ifnum\parencount=0 \else \badparencount \fi
5662 \ifnum\brackcount=0 \else \badbrackcount \fi
5664 \def\badparencount{%
5665 \errmessage{Unbalanced parentheses in @def}%
5666 \global\parencount=0
5668 \def\badbrackcount{%
5669 \errmessage{Unbalanced square braces in @def}%
5670 \global\brackcount=0
5677 % To do this right we need a feature of e-TeX, \scantokens,
5678 % which we arrange to emulate with a temporary file in ordinary TeX.
5679 \ifx\eTeXversion\undefined
5680 \newwrite\macscribble
5683 \immediate\openout\macscribble=\jobname.tmp
5684 \immediate\write\macscribble{\the\toks0}%
5685 \immediate\closeout\macscribble
5693 \let\xeatspaces\eatspaces
5694 % Undo catcode changes of \startcontents and \doprintindex
5695 % When called from @insertcopying or (short)caption, we need active
5696 % backslash to get it printed correctly. Previously, we had
5697 % \catcode`\\=\other instead. We'll see whether a problem appears
5698 % with macro expansion. --kasal, 19aug04
5699 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5703 % Append \endinput to make sure that TeX does not see the ending newline.
5705 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5707 \scantokens{#1\endinput}%
5712 \edef\temp{\noexpand\scanmacro{#1}}%
5716 \newcount\paramno % Count of parameters
5717 \newtoks\macname % Macro name
5718 \newif\ifrecursive % Is it recursive?
5720 % List of all defined macros in the form
5721 % \definedummyword\macro1\definedummyword\macro2...
5722 % Currently is also contains all @aliases; the list can be split
5723 % if there is a need.
5726 % Add the macro to \macrolist
5727 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5728 \def\addtomacrolistxxx#1{%
5729 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5730 \xdef\macrolist{\the\toks0}%
5734 % This does \let #1 = #2, with \csnames; that is,
5735 % \let \csname#1\endcsname = \csname#2\endcsname
5736 % (except of course we have to play expansion games).
5740 \csname#1\expandafter\endcsname
5744 % Trim leading and trailing spaces off a string.
5745 % Concepts from aro-bend problem 15 (see CTAN).
5747 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5748 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5749 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5751 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5754 % Trim a single trailing ^^M off a string.
5755 {\catcode`\^^M=\other \catcode`\Q=3%
5756 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5757 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5758 \gdef\eatcrb#1Q#2Q{#1}%
5761 % Macro bodies are absorbed as an argument in a context where
5762 % all characters are catcode 10, 11 or 12, except \ which is active
5763 % (as in normal texinfo). It is necessary to change the definition of \.
5765 % It's necessary to have hard CRs when the macro is executed. This is
5766 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5767 % body, and then making it the \newlinechar in \scanmacro.
5784 \catcode`\^^M=\other
5787 \def\macrobodyctxt{%
5791 \catcode`\^^M=\other
5800 % \mbodybackslash is the definition of \ in @macro bodies.
5801 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5802 % where N is the macro parameter number.
5803 % We define \csname macarg.\endcsname to be \realbackslash, so
5804 % \\ in macro replacement text gets you a backslash.
5806 {\catcode`@=0 @catcode`@\=@active
5807 @gdef@usembodybackslash{@let\=@mbodybackslash}
5808 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5810 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5812 \def\macro{\recursivefalse\parsearg\macroxxx}
5813 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5816 \getargs{#1}% now \macname is the macname and \argl the arglist
5817 \ifx\argl\empty % no arguments
5820 \expandafter\parsemargdef \argl;%
5822 \if1\csname ismacro.\the\macname\endcsname
5823 \message{Warning: redefining \the\macname}%
5825 \expandafter\ifx\csname \the\macname\endcsname \relax
5826 \else \errmessage{Macro name \the\macname\space already defined}\fi
5827 \global\cslet{macsave.\the\macname}{\the\macname}%
5828 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5829 \addtomacrolist{\the\macname}%
5831 \begingroup \macrobodyctxt
5832 \ifrecursive \expandafter\parsermacbody
5833 \else \expandafter\parsemacbody
5836 \parseargdef\unmacro{%
5837 \if1\csname ismacro.#1\endcsname
5838 \global\cslet{#1}{macsave.#1}%
5839 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5840 % Remove the macro name from \macrolist:
5842 \expandafter\let\csname#1\endcsname \relax
5843 \let\definedummyword\unmacrodo
5844 \xdef\macrolist{\macrolist}%
5847 \errmessage{Macro #1 not defined}%
5851 % Called by \do from \dounmacro on each macro. The idea is to omit any
5852 % macro definitions that have been changed to \relax.
5858 \noexpand\definedummyword \noexpand#1%
5862 % This makes use of the obscure feature that if the last token of a
5863 % <parameter list> is #, then the preceding argument is delimited by
5864 % an opening brace, and that opening brace is not consumed.
5865 \def\getargs#1{\getargsxxx#1{}}
5866 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5867 \def\getmacname #1 #2\relax{\macname={#1}}
5868 \def\getmacargs#1{\def\argl{#1}}
5870 % Parse the optional {params} list. Set up \paramno and \paramlist
5871 % so \defmacro knows what to do. Define \macarg.blah for each blah
5872 % in the params list, to be ##N where N is the position in that list.
5873 % That gets used by \mbodybackslash (above).
5875 % We need to get `macro parameter char #' into several definitions.
5876 % The technique used is stolen from LaTeX: let \hash be something
5877 % unexpandable, insert that wherever you need a #, and then redefine
5878 % it to # just before using the token list produced.
5880 % The same technique is used to protect \eatspaces till just before
5881 % the macro is used.
5883 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5884 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5885 \def\parsemargdefxxx#1,{%
5886 \if#1;\let\next=\relax
5887 \else \let\next=\parsemargdefxxx
5888 \advance\paramno by 1%
5889 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5890 {\xeatspaces{\hash\the\paramno}}%
5891 \edef\paramlist{\paramlist\hash\the\paramno,}%
5894 % These two commands read recursive and nonrecursive macro bodies.
5895 % (They're different since rec and nonrec macros end differently.)
5897 \long\def\parsemacbody#1@end macro%
5898 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5899 \long\def\parsermacbody#1@end rmacro%
5900 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5902 % This defines the macro itself. There are six cases: recursive and
5903 % nonrecursive macros of zero, one, and many arguments.
5904 % Much magic with \expandafter here.
5905 % \xdef is used so that macro definitions will survive the file
5906 % they're defined in; @include reads the file inside a group.
5908 \let\hash=##% convert placeholders to macro parameter chars
5912 \expandafter\xdef\csname\the\macname\endcsname{%
5913 \noexpand\scanmacro{\temp}}%
5915 \expandafter\xdef\csname\the\macname\endcsname{%
5916 \bgroup\noexpand\macroargctxt
5917 \noexpand\braceorline
5918 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5919 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5920 \egroup\noexpand\scanmacro{\temp}}%
5922 \expandafter\xdef\csname\the\macname\endcsname{%
5923 \bgroup\noexpand\macroargctxt
5924 \noexpand\csname\the\macname xx\endcsname}%
5925 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5926 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5927 \expandafter\expandafter
5929 \expandafter\expandafter
5930 \csname\the\macname xxx\endcsname
5931 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5936 \expandafter\xdef\csname\the\macname\endcsname{%
5937 \noexpand\norecurse{\the\macname}%
5938 \noexpand\scanmacro{\temp}\egroup}%
5940 \expandafter\xdef\csname\the\macname\endcsname{%
5941 \bgroup\noexpand\macroargctxt
5942 \noexpand\braceorline
5943 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5944 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5946 \noexpand\norecurse{\the\macname}%
5947 \noexpand\scanmacro{\temp}\egroup}%
5949 \expandafter\xdef\csname\the\macname\endcsname{%
5950 \bgroup\noexpand\macroargctxt
5951 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5952 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5953 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5954 \expandafter\expandafter
5956 \expandafter\expandafter
5957 \csname\the\macname xxx\endcsname
5960 \noexpand\norecurse{\the\macname}%
5961 \noexpand\scanmacro{\temp}\egroup}%
5965 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5967 % \braceorline decides whether the next nonwhitespace character is a
5968 % {. If so it reads up to the closing }, if not, it reads the whole
5969 % line. Whatever was read is then fed to the next control sequence
5970 % as an argument (by \parsebrace or \parsearg)
5971 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5972 \def\braceorlinexxx{%
5973 \ifx\nchar\bgroup\else
5974 \expandafter\parsearg
5979 % We need some trickery to remove the optional spaces around the equal
5980 % sign. Just make them active and then expand them all to nothing.
5981 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5982 \def\aliasxxx #1{\aliasyyy#1\relax}
5983 \def\aliasyyy #1=#2\relax{%
5985 \expandafter\let\obeyedspace=\empty
5986 \addtomacrolist{#1}%
5987 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5993 \message{cross references,}
5997 \newif\ifhavexrefs % True if xref values are known.
5998 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6000 % @inforef is relatively simple.
6001 \def\inforef #1{\inforefzzz #1,,,,**}
6002 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6003 node \samp{\ignorespaces#1{}}}
6005 % @node's only job in TeX is to define \lastnode, which is used in
6006 % cross-references. The @node line might or might not have commas, and
6007 % might or might not have spaces before the first comma, like:
6008 % @node foo , bar , ...
6009 % We don't want such trailing spaces in the node name.
6011 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6013 % also remove a trailing comma, in case of something like this:
6014 % @node Help-Cross, , , Cross-refs
6015 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6016 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6019 \let\lastnode=\empty
6021 % Write a cross-reference definition for the current node. #1 is the
6022 % type (Ynumbered, Yappendix, Ynothing).
6025 \ifx\lastnode\empty\else
6026 \setref{\lastnode}{#1}%
6027 \global\let\lastnode=\empty
6031 % @anchor{NAME} -- define xref target at arbitrary point.
6033 \newcount\savesfregister
6035 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6036 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6037 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6039 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6040 % anchor), which consists of three parts:
6041 % 1) NAME-title - the current sectioning name taken from \thissection,
6042 % or the anchor name.
6043 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6044 % empty for anchors.
6045 % 3) NAME-pg - the page number.
6047 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6048 % floats, there is an additional part, which is not written here:
6049 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6055 \atdummies % preserve commands, but don't expand them
6056 \edef\writexrdef##1##2{%
6057 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6058 ##1}{##2}}% these are parameters of \writexrdef
6060 \toks0 = \expandafter{\thissection}%
6061 \immediate \writexrdef{title}{\the\toks0 }%
6062 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6063 \writexrdef{pg}{\folio}% will be written later, during \shipout
6068 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6069 % the node name, #2 the name of the Info cross-reference, #3 the printed
6070 % node name, #4 the name of the Info file, #5 the name of the printed
6071 % manual. All but the node name can be omitted.
6073 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6074 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6075 \def\ref#1{\xrefX[#1,,,,,,,]}
6076 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6078 \def\printedmanual{\ignorespaces #5}%
6079 \def\printedrefname{\ignorespaces #3}%
6080 \setbox1=\hbox{\printedmanual\unskip}%
6081 \setbox0=\hbox{\printedrefname\unskip}%
6083 % No printed node name was explicitly given.
6084 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6085 % Use the node name inside the square brackets.
6086 \def\printedrefname{\ignorespaces #1}%
6088 % Use the actual chapter/section title appear inside
6089 % the square brackets. Use the real section title if we have it.
6091 % It is in another manual, so we don't have it.
6092 \def\printedrefname{\ignorespaces #1}%
6095 % We know the real title if we have the xref values.
6096 \def\printedrefname{\refx{#1-title}{}}%
6098 % Otherwise just copy the Info node name.
6099 \def\printedrefname{\ignorespaces #1}%
6105 % Make link in pdf output.
6110 % See comments at \activebackslashdouble.
6111 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6112 \backslashparens\pdfxrefdest}%
6114 \ifnum\filenamelength>0
6115 \startlink attr{/Border [0 0 0]}%
6116 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6118 \startlink attr{/Border [0 0 0]}%
6119 goto name{\pdfmkpgn{\pdfxrefdest}}%
6125 % Float references are printed completely differently: "Figure 1.2"
6126 % instead of "[somenode], p.3". We distinguish them by the
6127 % LABEL-title being set to a magic string.
6129 % Have to otherify everything special to allow the \csname to
6130 % include an _ in the xref name, etc.
6133 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6134 \csname XR#1-title\endcsname
6136 \iffloat\Xthisreftitle
6137 % If the user specified the print name (third arg) to the ref,
6138 % print it instead of our usual "Figure 1.2".
6145 % if the user also gave the printed manual name (fifth arg), append
6148 \space \putwordin{} \cite{\printedmanual}%
6151 % node/anchor (non-float) references.
6153 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6154 % insert empty discretionaries after hyphens, which means that it will
6155 % not find a line break at a hyphen in a node names. Since some manuals
6156 % are best written with fairly long node names, containing hyphens, this
6157 % is a loss. Therefore, we give the text of the node name again, so it
6158 % is as if TeX is seeing it for the first time.
6160 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6162 % _ (for example) has to be the character _ for the purposes of the
6163 % control sequence corresponding to the node, but it has to expand
6164 % into the usual \leavevmode...\vrule stuff for purposes of
6165 % printing. So we \turnoffactive for the \refx-snt, back on for the
6166 % printing, back off for the \refx-pg.
6168 % Only output a following space if the -snt ref is nonempty; for
6169 % @unnumbered and @anchor, it won't be.
6170 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6171 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6173 % output the `[mynode]' via a macro so it can be overridden.
6174 \xrefprintnodename\printedrefname
6176 % But we always want a comma and a space:
6179 % output the `page 3'.
6180 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6186 % This macro is called from \xrefX for the `[nodename]' part of xref
6187 % output. It's a separate macro only so it can be changed more easily,
6188 % since square brackets don't work well in some documents. Particularly
6189 % one that Bob is working on :).
6191 \def\xrefprintnodename#1{[#1]}
6193 % Things referred to by \setref.
6199 \putwordChapter@tie \the\chapno
6200 \else \ifnum\subsecno=0
6201 \putwordSection@tie \the\chapno.\the\secno
6202 \else \ifnum\subsubsecno=0
6203 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6205 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6210 \putwordAppendix@tie @char\the\appendixno{}%
6211 \else \ifnum\subsecno=0
6212 \putwordSection@tie @char\the\appendixno.\the\secno
6213 \else \ifnum\subsubsecno=0
6214 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6217 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6221 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6222 % If its value is nonempty, SUFFIX is output afterward.
6228 \expandafter\global\expandafter\let\expandafter\thisrefX
6229 \csname XR#1\endcsname
6232 % If not defined, say something at least.
6233 \angleleft un\-de\-fined\angleright
6236 \message{\linenumber Undefined cross reference `#1'.}%
6239 \global\warnedxrefstrue
6240 \message{Cross reference values unknown; you must run TeX again.}%
6245 % It's defined, so just use it.
6248 #2% Output the suffix in any case.
6251 % This is the macro invoked by entries in the aux file. Usually it's
6252 % just a \def (we prepend XR to the control sequence name to avoid
6253 % collisions). But if this is a float type, we have more work to do.
6256 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6258 % Was that xref control sequence that we just defined for a float?
6259 \expandafter\iffloat\csname XR#1\endcsname
6260 % it was a float, and we have the (safe) float type in \iffloattype.
6261 \expandafter\let\expandafter\floatlist
6262 \csname floatlist\iffloattype\endcsname
6264 % Is this the first time we've seen this float type?
6265 \expandafter\ifx\floatlist\relax
6266 \toks0 = {\do}% yes, so just \do
6268 % had it before, so preserve previous elements in list.
6269 \toks0 = \expandafter{\floatlist\do}%
6272 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6273 % for later use in \listoffloats.
6274 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6278 % Read the last existing aux file, if any. No error if none exists.
6281 \openin 1 \jobname.aux
6284 \global\havexrefstrue
6289 \def\setupdatafile{%
6290 \catcode`\^^@=\other
6291 \catcode`\^^A=\other
6292 \catcode`\^^B=\other
6293 \catcode`\^^C=\other
6294 \catcode`\^^D=\other
6295 \catcode`\^^E=\other
6296 \catcode`\^^F=\other
6297 \catcode`\^^G=\other
6298 \catcode`\^^H=\other
6299 \catcode`\^^K=\other
6300 \catcode`\^^L=\other
6301 \catcode`\^^N=\other
6302 \catcode`\^^P=\other
6303 \catcode`\^^Q=\other
6304 \catcode`\^^R=\other
6305 \catcode`\^^S=\other
6306 \catcode`\^^T=\other
6307 \catcode`\^^U=\other
6308 \catcode`\^^V=\other
6309 \catcode`\^^W=\other
6310 \catcode`\^^X=\other
6311 \catcode`\^^Z=\other
6312 \catcode`\^^[=\other
6313 \catcode`\^^\=\other
6314 \catcode`\^^]=\other
6315 \catcode`\^^^=\other
6316 \catcode`\^^_=\other
6317 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6318 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6319 % supported in the main text, it doesn't seem desirable. Furthermore,
6320 % that is not enough: for node names that actually contain a ^
6321 % character, we would end up writing a line like this: 'xrdef {'hat
6322 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6323 % argument, and \hat is not an expandable control sequence. It could
6324 % all be worked out, but why? Either we support ^^ or we don't.
6326 % The other change necessary for this was to define \auxhat:
6327 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6328 % and then to call \auxhat in \setq.
6332 % Special characters. Should be turned off anyway, but...
6345 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6347 % This is to support \ in node names and titles, since the \
6348 % characters end up in a \csname. It's easier than
6349 % leaving it active and making its active definition an actual \
6350 % character. What I don't understand is why it works in the *value*
6351 % of the xrdef. Seems like it should be a catcode12 \, and that
6352 % should not typeset properly. But it works, so I'm moving on for
6353 % now. --karl, 15jan04.
6356 % Make the characters 128-255 be printing characters.
6360 \catcode\count1=\other
6361 \advance\count1 by 1
6362 \ifnum \count1<256 \loop \fi
6366 % @ is our escape character in .aux files, and we need braces.
6372 \def\readdatafile#1{%
6378 \message{insertions,}
6379 % including footnotes.
6381 \newcount \footnoteno
6383 % The trailing space in the following definition for supereject is
6384 % vital for proper filling; pages come out unaligned when you do a
6385 % pagealignmacro call if that space before the closing brace is
6386 % removed. (Generally, numeric constants should always be followed by a
6387 % space to prevent strange expansion errors.)
6388 \def\supereject{\par\penalty -20000\footnoteno =0 }
6390 % @footnotestyle is meaningful for info output only.
6391 \let\footnotestyle=\comment
6395 % Auto-number footnotes. Otherwise like plain.
6397 \let\indent=\ptexindent
6398 \let\noindent=\ptexnoindent
6399 \global\advance\footnoteno by \@ne
6400 \edef\thisfootno{$^{\the\footnoteno}$}%
6402 % In case the footnote comes at the end of a sentence, preserve the
6403 % extra spacing after we do the footnote number.
6405 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6407 % Remove inadvertent blank space before typesetting the footnote number.
6413 % Don't bother with the trickery in plain.tex to not require the
6414 % footnote text as a parameter. Our footnotes don't need to be so general.
6416 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6417 % \parseargline) fails inside footnotes because the tokens are fixed when
6418 % the footnote is read. --karl, 16nov96.
6421 \insert\footins\bgroup
6422 % We want to typeset this text as a normal paragraph, even if the
6423 % footnote reference occurs in (for example) a display environment.
6424 % So reset some parameters.
6426 \interlinepenalty\interfootnotelinepenalty
6427 \splittopskip\ht\strutbox % top baseline for broken footnotes
6428 \splitmaxdepth\dp\strutbox
6429 \floatingpenalty\@MM
6434 \parindent\defaultparindent
6438 % Because we use hanging indentation in footnotes, a @noindent appears
6439 % to exdent this text, so make it be a no-op. makeinfo does not use
6440 % hanging indentation so @noindent can still be needed within footnote
6441 % text after an @example or the like (not that this is good style).
6442 \let\noindent = \relax
6444 % Hang the footnote text off the number. Use \everypar in case the
6445 % footnote extends for more than one paragraph.
6446 \everypar = {\hang}%
6447 \textindent{\thisfootno}%
6449 % Don't crash into the line above the footnote text. Since this
6450 % expands into a box, it must come within the paragraph, lest it
6451 % provide a place where TeX can split the footnote.
6453 \futurelet\next\fo@t
6455 }%end \catcode `\@=11
6457 % In case a @footnote appears in a vbox, save the footnote text and create
6458 % the real \insert just after the vbox finished. Otherwise, the insertion
6460 % Similarily, if a @footnote appears inside an alignment, save the footnote
6461 % text to a box and make the \insert when a row of the table is finished.
6462 % And the same can be done for other insert classes. --kasal, 16nov03.
6464 % Replace the \insert primitive by a cheating macro.
6465 % Deeper inside, just make sure that the saved insertions are not spilled
6468 \def\startsavinginserts{%
6469 \ifx \insert\ptexinsert
6470 \let\insert\saveinsert
6472 \let\checkinserts\relax
6476 % This \insert replacement works for both \insert\footins{foo} and
6477 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6480 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6481 \afterassignment\next
6482 % swallow the left brace
6485 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6486 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6488 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6490 \def\placesaveins#1{%
6491 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6495 % eat @SAVE -- beware, all of them have catcode \other:
6497 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6498 \gdef\gobblesave @SAVE{}
6502 \def\newsaveins #1{%
6503 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6506 \def\newsaveinsX #1{%
6507 \csname newbox\endcsname #1%
6508 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6513 \let\checkinserts\empty
6518 % @image. We use the macros from epsf.tex to support this.
6519 % If epsf.tex is not installed and @image is used, we complain.
6521 % Check for and read epsf.tex up front. If we read it only at @image
6522 % time, we might be inside a group, and then its definitions would get
6523 % undone and the next image would fail.
6524 \openin 1 = epsf.tex
6526 % Do not bother showing banner with epsf.tex v2.7k (available in
6527 % doc/epsf.tex and on ctan).
6528 \def\epsfannounce{\toks0 = }%
6533 % We will only complain once about lack of epsf.tex.
6534 \newif\ifwarnednoepsf
6535 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6536 work. It is also included in the Texinfo distribution, or you can get
6537 it from ftp://tug.org/tex/epsf.tex.}
6540 \ifx\epsfbox\undefined
6541 \ifwarnednoepsf \else
6542 \errhelp = \noepsfhelp
6543 \errmessage{epsf.tex not found, images will be ignored}%
6544 \global\warnednoepsftrue
6547 \imagexxx #1,,,,,\finish
6551 % Arguments to @image:
6552 % #1 is (mandatory) image filename; we tack on .eps extension.
6553 % #2 is (optional) width, #3 is (optional) height.
6554 % #4 is (ignored optional) html alt text.
6555 % #5 is (ignored optional) extension.
6556 % #6 is just the usual extra ignored arg for parsing this stuff.
6558 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6559 \catcode`\^^M = 5 % in case we're inside an example
6560 \normalturnoffactive % allow _ et al. in names
6561 % If the image is by itself, center it.
6565 % Usually we'll have text after the image which will insert
6566 % \parskip glue, so insert it here too to equalize the space
6568 \nobreak\vskip\parskip
6575 \dopdfimage{#1}{#2}{#3}%
6577 % \epsfbox itself resets \epsf?size at each figure.
6578 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6579 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6583 \ifimagevmode \egroup \bigbreak \fi % space after the image
6587 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6588 % etc. We don't actually implement floating yet, we always include the
6589 % float "here". But it seemed the best name for the future.
6591 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6593 % There may be a space before second and/or third parameter; delete it.
6594 \def\eatcommaspace#1, {#1,}
6596 % #1 is the optional FLOATTYPE, the text label for this float, typically
6597 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6598 % this float will not be numbered and cannot be referred to.
6600 % #2 is the optional xref label. Also must be present for the float to
6603 % #3 is the optional positioning argument; for now, it is ignored. It
6604 % will somehow specify the positions allowed to float to (here, top, bottom).
6606 % We keep a separate counter for each FLOATTYPE, which we reset at each
6607 % chapter-level command.
6608 \let\resetallfloatnos=\empty
6610 \def\dofloat#1,#2,#3,#4\finish{%
6611 \let\thiscaption=\empty
6612 \let\thisshortcaption=\empty
6614 % don't lose footnotes inside @float.
6616 % BEWARE: when the floats start float, we have to issue warning whenever an
6617 % insert appears inside a float which could possibly float. --kasal, 26may04
6621 % We can't be used inside a paragraph.
6626 \def\floatlabel{#2}%
6627 \def\floatloc{#3}% we do nothing with this yet.
6629 \ifx\floattype\empty
6630 \let\safefloattype=\empty
6633 % the floattype might have accents or other special characters,
6634 % but we need to use it in a control sequence name.
6637 \xdef\safefloattype{\floattype}%
6641 % If label is given but no type, we handle that as the empty type.
6642 \ifx\floatlabel\empty \else
6643 % We want each FLOATTYPE to be numbered separately (Figure 1,
6644 % Table 1, Figure 2, ...). (And if no label, no number.)
6646 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6647 \global\advance\floatno by 1
6650 % This magic value for \thissection is output by \setref as the
6651 % XREFLABEL-title value. \xrefX uses it to distinguish float
6652 % labels (which have a completely different output format) from
6653 % node and anchor labels. And \xrdef uses it to construct the
6656 \edef\thissection{\floatmagic=\safefloattype}%
6657 \setref{\floatlabel}{Yfloat}%
6661 % start with \parskip glue, I guess.
6664 % Don't suppress indentation if a float happens to start a section.
6665 \restorefirstparagraphindent
6668 % we have these possibilities:
6669 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6670 % @float Foo,lbl & no caption: Foo 1.1
6671 % @float Foo & @caption{Cap}: Foo: Cap
6672 % @float Foo & no caption: Foo
6673 % @float ,lbl & Caption{Cap}: 1.1: Cap
6674 % @float ,lbl & no caption: 1.1
6675 % @float & @caption{Cap}: Cap
6676 % @float & no caption:
6679 \let\floatident = \empty
6681 % In all cases, if we have a float type, it comes first.
6682 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6684 % If we have an xref label, the number comes next.
6685 \ifx\floatlabel\empty \else
6686 \ifx\floattype\empty \else % if also had float type, need tie first.
6687 \appendtomacro\floatident{\tie}%
6690 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6693 % Start the printed caption with what we've constructed in
6694 % \floatident, but keep it separate; we need \floatident again.
6695 \let\captionline = \floatident
6697 \ifx\thiscaption\empty \else
6698 \ifx\floatident\empty \else
6699 \appendtomacro\captionline{: }% had ident, so need a colon between
6703 \appendtomacro\captionline{\scanexp\thiscaption}%
6706 % If we have anything to print, print it, with space before.
6707 % Eventually this needs to become an \insert.
6708 \ifx\captionline\empty \else
6712 % Space below caption.
6716 % If have an xref label, write the list of floats info. Do this
6717 % after the caption, to avoid chance of it being a breakpoint.
6718 \ifx\floatlabel\empty \else
6719 % Write the text that goes in the lof to the aux file as
6720 % \floatlabel-lof. Besides \floatident, we include the short
6721 % caption if specified, else the full caption if specified, else nothing.
6725 % since we read the caption text in the macro world, where ^^M
6726 % is turned into a normal character, we have to scan it back, so
6727 % we don't write the literal three characters "^^M" into the aux file.
6729 \xdef\noexpand\gtemp{%
6730 \ifx\thisshortcaption\empty
6737 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6738 \ifx\gtemp\empty \else : \gtemp \fi}}%
6741 \egroup % end of \vtop
6743 % place the captured inserts
6745 % BEWARE: when the floats start floating, we have to issue warning
6746 % whenever an insert appears inside a float which could possibly
6747 % float. --kasal, 26may04
6752 % Append the tokens #2 to the definition of macro #1, not expanding either.
6754 \def\appendtomacro#1#2{%
6755 \expandafter\def\expandafter#1\expandafter{#1#2}%
6758 % @caption, @shortcaption
6760 \def\caption{\docaption\thiscaption}
6761 \def\shortcaption{\docaption\thisshortcaption}
6762 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6763 \def\defcaption#1#2{\egroup \def#1{#2}}
6765 % The parameter is the control sequence identifying the counter we are
6766 % going to use. Create it if it doesn't exist and assign it to \floatno.
6769 % Haven't seen this figure type before.
6770 \csname newcount\endcsname #1%
6772 % Remember to reset this floatno at the next chap.
6773 \expandafter\gdef\expandafter\resetallfloatnos
6774 \expandafter{\resetallfloatnos #1=0 }%
6779 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6780 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6781 % first read the @float command.
6783 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6785 % Magic string used for the XREFLABEL-title value, so \xrefX can
6786 % distinguish floats from other xref types.
6787 \def\floatmagic{!!float!!}
6789 % #1 is the control sequence we are passed; we expand into a conditional
6790 % which is true if #1 represents a float ref. That is, the magic
6791 % \thissection value which we \setref above.
6793 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6795 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6796 % (safe) float type for this float. We set \iffloattype to #2.
6798 \def\doiffloat#1=#2=#3\finish{%
6800 \def\iffloattype{#2}%
6801 \ifx\temp\floatmagic
6804 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6806 \parseargdef\listoffloats{%
6807 \def\floattype{#1}% floattype
6809 % the floattype might have accents or other special characters,
6810 % but we need to use it in a control sequence name.
6813 \xdef\safefloattype{\floattype}%
6816 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6817 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6819 % if the user said @listoffloats foo but never @float foo.
6820 \message{\linenumber No `\safefloattype' floats to list.}%
6824 \leftskip=\tocindent % indent these entries like a toc
6825 \let\do=\listoffloatsdo
6826 \csname floatlist\safefloattype\endcsname
6831 % This is called on each entry in a list of floats. We're passed the
6832 % xref label, in the form LABEL-title, which is how we save it in the
6833 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6834 % has the text we're supposed to typeset here.
6836 % Figures without xref labels will not be included in the list (since
6837 % they won't appear in the aux file).
6839 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6840 \def\listoffloatsdoentry#1-title\finish{{%
6841 % Can't fully expand XR#1-lof because it can contain anything. Just
6842 % pass the control sequence. On the other hand, XR#1-pg is just the
6843 % page number, and we want to fully expand that so we can get a link
6845 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6847 % use the same \entry macro we use to generate the TOC and index.
6848 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6852 \message{localization,}
6855 % @documentlanguage is usually given very early, just after
6856 % @setfilename. If done too late, it may not override everything
6857 % properly. Single argument is the language abbreviation.
6858 % It would be nice if we could set up a hyphenation file here.
6860 \parseargdef\documentlanguage{%
6861 \tex % read txi-??.tex file in plain TeX.
6862 % Read the file if it exists.
6863 \openin 1 txi-#1.tex
6865 \errhelp = \nolanghelp
6866 \errmessage{Cannot read language file txi-#1.tex}%
6873 \newhelp\nolanghelp{The given language definition file cannot be found or
6874 is empty. Maybe you need to install it? In the current directory
6875 should work if nowhere else does.}
6878 % @documentencoding should change something in TeX eventually, most
6879 % likely, but for now just recognize it.
6880 \let\documentencoding = \comment
6883 % Page size parameters.
6885 \newdimen\defaultparindent \defaultparindent = 15pt
6887 \chapheadingskip = 15pt plus 4pt minus 2pt
6888 \secheadingskip = 12pt plus 3pt minus 2pt
6889 \subsecheadingskip = 9pt plus 2pt minus 2pt
6891 % Prevent underfull vbox error messages.
6894 % Don't be so finicky about underfull hboxes, either.
6897 % Following George Bush, just get rid of widows and orphans.
6901 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6902 % using an old version of TeX, don't do anything. We want the amount of
6903 % stretch added to depend on the line length, hence the dependence on
6904 % \hsize. We call this whenever the paper size is set.
6906 \def\setemergencystretch{%
6907 \ifx\emergencystretch\thisisundefined
6908 % Allow us to assign to \emergencystretch anyway.
6909 \def\emergencystretch{\dimen0}%
6911 \emergencystretch = .15\hsize
6915 % Parameters in order: 1) textheight; 2) textwidth;
6916 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
6917 % 7) physical page height; 8) physical page width.
6919 % We also call \setleading{\textleading}, so the caller should define
6920 % \textleading. The caller should also set \parskip.
6922 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6925 \splittopskip = \topskip
6928 \advance\vsize by \topskip
6929 \outervsize = \vsize
6930 \advance\outervsize by 2\topandbottommargin
6931 \pageheight = \vsize
6934 \outerhsize = \hsize
6935 \advance\outerhsize by 0.5in
6938 \normaloffset = #4\relax
6939 \bindingoffset = #5\relax
6942 \pdfpageheight #7\relax
6943 \pdfpagewidth #8\relax
6946 \setleading{\textleading}
6948 \parindent = \defaultparindent
6949 \setemergencystretch
6952 % @letterpaper (the default).
6953 \def\letterpaper{{\globaldefs = 1
6954 \parskip = 3pt plus 2pt minus 1pt
6955 \textleading = 13.2pt
6957 % If page is nothing but text, make it come out even.
6958 \internalpagesizes{46\baselineskip}{6in}%
6960 {\bindingoffset}{36pt}%
6964 % Use @smallbook to reset parameters for 7x9.25 trim size.
6965 \def\smallbook{{\globaldefs = 1
6966 \parskip = 2pt plus 1pt
6969 \internalpagesizes{7.5in}{5in}%
6971 {\bindingoffset}{16pt}%
6974 \lispnarrowing = 0.3in
6977 \contentsrightmargin = 0pt
6978 \defbodyindent = .5cm
6981 % Use @smallerbook to reset parameters for 6x9 trim size.
6982 % (Just testing, parameters still in flux.)
6983 \def\smallerbook{{\globaldefs = 1
6984 \parskip = 1.5pt plus 1pt
6987 \internalpagesizes{7.4in}{4.8in}%
6992 \lispnarrowing = 0.25in
6995 \contentsrightmargin = 0pt
6996 \defbodyindent = .4cm
6999 % Use @afourpaper to print on European A4 paper.
7000 \def\afourpaper{{\globaldefs = 1
7001 \parskip = 3pt plus 2pt minus 1pt
7002 \textleading = 13.2pt
7004 % Double-side printing via postscript on Laserjet 4050
7005 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7006 % To change the settings for a different printer or situation, adjust
7007 % \normaloffset until the front-side and back-side texts align. Then
7008 % do the same for \bindingoffset. You can set these for testing in
7009 % your texinfo source file like this:
7011 % \global\normaloffset = -6mm
7012 % \global\bindingoffset = 10mm
7014 \internalpagesizes{51\baselineskip}{160mm}
7015 {\voffset}{\hoffset}%
7016 {\bindingoffset}{44pt}%
7021 \contentsrightmargin = 0pt
7022 \defbodyindent = 5mm
7025 % Use @afivepaper to print on European A5 paper.
7026 % From romildo@urano.iceb.ufop.br, 2 July 2000.
7027 % He also recommends making @example and @lisp be small.
7028 \def\afivepaper{{\globaldefs = 1
7029 \parskip = 2pt plus 1pt minus 0.1pt
7030 \textleading = 12.5pt
7032 \internalpagesizes{160mm}{120mm}%
7033 {\voffset}{\hoffset}%
7034 {\bindingoffset}{8pt}%
7037 \lispnarrowing = 0.2in
7040 \contentsrightmargin = 0pt
7041 \defbodyindent = 2mm
7045 % A specific text layout, 24x15cm overall, intended for A4 paper.
7046 \def\afourlatex{{\globaldefs = 1
7048 \internalpagesizes{237mm}{150mm}%
7050 {\bindingoffset}{7mm}%
7053 % Must explicitly reset to 0 because we call \afourpaper.
7057 % Use @afourwide to print on A4 paper in landscape format.
7058 \def\afourwide{{\globaldefs = 1
7060 \internalpagesizes{241mm}{165mm}%
7061 {\voffset}{-2.95mm}%
7062 {\bindingoffset}{7mm}%
7067 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7068 % Perhaps we should allow setting the margins, \topskip, \parskip,
7069 % and/or leading, also. Or perhaps we should compute them somehow.
7071 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7072 \def\pagesizesyyy#1,#2,#3\finish{{%
7073 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7076 \parskip = 3pt plus 2pt minus 1pt
7077 \setleading{\textleading}%
7080 \advance\dimen0 by \voffset
7083 \advance\dimen2 by \normaloffset
7085 \internalpagesizes{#1}{\hsize}%
7086 {\voffset}{\normaloffset}%
7087 {\bindingoffset}{44pt}%
7091 % Set default to letter.
7096 \message{and turning on texinfo input format.}
7098 % Define macros to output various characters with catcode for normal text.
7108 \def\normaldoublequote{"}
7111 \def\normalunderscore{_}
7112 \def\normalverticalbar{|}
7114 \def\normalgreater{>}
7116 \def\normaldollar{$}%$ font-lock fix
7118 % This macro is used to make a character print one way in \tt
7119 % (where it can probably be output as-is), and another way in other fonts,
7120 % where something hairier probably needs to be done.
7122 % #1 is what to print if we are indeed using \tt; #2 is what to print
7123 % otherwise. Since all the Computer Modern typewriter fonts have zero
7124 % interword stretch (and shrink), and it is reasonable to expect all
7125 % typewriter fonts to have this, we can check that font parameter.
7127 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7129 % Same as above, but check for italic font. Actually this also catches
7130 % non-italic slanted fonts since it is impossible to distinguish them from
7131 % italic fonts. But since this is only used by $ and it uses \sl anyway
7132 % this is not a problem.
7133 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7135 % Turn off all special characters except @
7136 % (and those which the user can use as if they were ordinary).
7137 % Most of these we simply print from the \tt font, but for some, we can
7138 % use math or other variants that look better in normal text.
7141 \def\activedoublequote{{\tt\char34}}
7142 \let"=\activedoublequote
7144 \def~{{\tt\char126}}
7150 \def_{\ifusingtt\normalunderscore\_}
7152 % Subroutine for the previous macro.
7153 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7156 \def|{{\tt\char124}}
7164 \def+{{\tt \char 43}}
7166 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7168 % If a .fmt file is being used, characters that might appear in a file
7169 % name cannot be active until we have parsed the command line.
7170 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7171 % \otherifyactive is called near the end of this file.
7172 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7174 % Used sometimes to turn off (effectively) the active characters even after
7176 \def\turnoffactive{%
7177 \normalturnoffactive
7183 % \backslashcurfont outputs one backslash character in current font,
7185 \global\chardef\backslashcurfont=`\\
7186 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7188 % \realbackslash is an actual character `\' with catcode other, and
7189 % \doublebackslash is two of them (for the pdf outlines).
7190 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7192 % In texinfo, backslash is an active character; it prints the backslash
7193 % in fixed width font.
7195 @def@normalbackslash{{@tt@backslashcurfont}}
7196 % On startup, @fixbackslash assigns:
7197 % @let \ = @normalbackslash
7199 % \rawbackslash defines an active \ to do \backslashcurfont.
7200 % \otherbackslash defines an active \ to be a literal `\' character with
7202 @gdef@rawbackslash{@let\=@backslashcurfont}
7203 @gdef@otherbackslash{@let\=@realbackslash}
7205 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7206 % the literal character `\'.
7208 @def@normalturnoffactive{%
7209 @let\=@normalbackslash
7210 @let"=@normaldoublequote
7213 @let_=@normalunderscore
7214 @let|=@normalverticalbar
7216 @let>=@normalgreater
7218 @let$=@normaldollar %$ font-lock fix
7222 % Make _ and + \other characters, temporarily.
7223 % This is canceled by @fixbackslash.
7226 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7227 % That is what \eatinput is for; after that, the `\' should revert to printing
7230 @gdef@eatinput input texinfo{@fixbackslash}
7231 @global@let\ = @eatinput
7233 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7234 % the first `\' in the file would cause an error. This macro tries to fix
7235 % that, assuming it is called before the first `\' could plausibly occur.
7236 % Also turn back on active characters that might appear in the input
7237 % file name, in case not using a pre-dumped format.
7239 @gdef@fixbackslash{%
7240 @ifx\@eatinput @let\ = @normalbackslash @fi
7245 % Say @foo, not \foo, in error messages.
7248 % These look ok in all fonts, so just make them not special.
7249 @catcode`@& = @other
7250 @catcode`@# = @other
7251 @catcode`@% = @other
7255 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7256 @c page-delimiter: "^\\\\message"
7257 @c time-stamp-start: "def\\\\texinfoversion{"
7258 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7259 @c time-stamp-end: "}"
7265 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115