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{2005-08-07.06}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 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 % In some macros, we cannot use the `\? notation---the left quote is
157 % in some cases the escape char.
158 \chardef\backChar = `\\
159 \chardef\colonChar = `\:
160 \chardef\commaChar = `\,
161 \chardef\dotChar = `\.
162 \chardef\exclamChar= `\!
163 \chardef\plusChar = `\+
164 \chardef\questChar = `\?
165 \chardef\semiChar = `\;
166 \chardef\underChar = `\_
168 \chardef\spaceChar = `\ %
169 \chardef\spacecat = 10
170 \def\spaceisspace{\catcode\spaceChar=\spacecat}
172 {% for help with debugging.
173 % example usage: \expandafter\show\activebackslash
174 \catcode`\! = 0 \catcode`\\ = \active
175 !global!def!activebackslash{\}
182 % The following is used inside several \edef's.
183 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
187 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
188 ap-pen-dix bit-map bit-maps
189 data-base data-bases eshell fall-ing half-way long-est man-u-script
190 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
191 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
193 stand-alone strong-est time-stamp time-stamps which-ever white-space
194 wide-spread wrap-around
197 % Margin to add to right of even pages, to left of odd pages.
198 \newdimen\bindingoffset
199 \newdimen\normaloffset
200 \newdimen\pagewidth \newdimen\pageheight
202 % For a final copy, take out the rectangles
203 % that mark overfull boxes (in case you have decided
204 % that the text looks ok even though it passes the margin).
206 \def\finalout{\overfullrule=0pt}
208 % @| inserts a changebar to the left of the current line. It should
209 % surround any changed text. This approach does *not* work if the
210 % change spans more than two lines of output. To handle that, we would
211 % have adopt a much more difficult approach (putting marks into the main
212 % vertical list for the beginning and end of each change).
215 % \vadjust can only be used in horizontal mode.
218 % Append this vertical mode material after the current line in the output.
220 % We want to insert a rule with the height and depth of the current
221 % leading; that is exactly what \strutbox is supposed to record.
224 % \vadjust-items are inserted at the left edge of the type. So
225 % the \llap here moves out into the left-hand margin.
228 % For a thicker or thinner bar, change the `1pt'.
229 \vrule height\baselineskip width1pt
231 % This is the space between the bar and the text.
237 % Sometimes it is convenient to have everything in the transcript file
238 % and nothing on the terminal. We don't just call \tracingall here,
239 % since that produces some useless output on the terminal. We also make
240 % some effort to order the tracing commands to reduce output in the log
241 % file; cf. trace.sty in LaTeX.
243 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
247 \tracinglostchars2 % 2 gives us more in etex
252 \showboxbreadth\maxdimen \showboxdepth\maxdimen
253 \ifx\eTeXversion\undefined\else % etex gives us more logging
260 \tracingcommands3 % 3 gives us more in etex
264 % add check for \lastpenalty to plain's definitions. If the last thing
265 % we did was a \nobreak, we don't want to insert more space.
267 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
268 \removelastskip\penalty-50\smallskip\fi\fi}
269 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
270 \removelastskip\penalty-100\medskip\fi\fi}
271 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
272 \removelastskip\penalty-200\bigskip\fi\fi}
274 % For @cropmarks command.
275 % Do @cropmarks to get crop marks.
278 \let\cropmarks = \cropmarkstrue
280 % Dimensions to add cropmarks at corners.
281 % Added by P. A. MacKay, 12 Nov. 1986
283 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
284 \newdimen\cornerlong \cornerlong=1pc
285 \newdimen\cornerthick \cornerthick=.3pt
286 \newdimen\topandbottommargin \topandbottommargin=.75in
288 % Main output routine.
290 \output = {\onepageout{\pagecontents\PAGE}}
295 % \onepageout takes a vbox as an argument. Note that \pagecontents
296 % does insertions, but you have to call it yourself.
298 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
300 \ifodd\pageno \advance\hoffset by \bindingoffset
301 \else \advance\hoffset by -\bindingoffset\fi
303 % Do this outside of the \shipout so @code etc. will be expanded in
304 % the headline as they should be, not taken literally (outputting ''code).
305 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
306 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
309 % Have to do this stuff outside the \shipout because we want it to
310 % take effect in \write's, yet the group defined by the \vbox ends
311 % before the \shipout runs.
313 \indexdummies % don't expand commands in the output.
315 % Do this early so pdf references go to the beginning of the page.
316 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
318 \ifcropmarks \vbox to \outervsize\bgroup
320 \vskip-\topandbottommargin
322 \line{\ewtop\hfil\ewtop}%
325 \vbox{\moveleft\cornerthick\nstop}%
327 \vbox{\moveright\cornerthick\nstop}%
330 \vskip\topandbottommargin
332 \hfil % center the page within the outer (page) hsize.
333 \ifodd\pageno\hskip\bindingoffset\fi
339 \ifdim\ht\footlinebox > 0pt
340 % Only leave this space if the footline is nonempty.
341 % (We lessened \vsize for it in \oddfootingxxx.)
342 % The \baselineskip=24pt in plain's \makefootline has no effect.
343 \vskip 2\baselineskip
348 \egroup % end of \vbox\bgroup
349 \hfil\egroup % end of (centering) \line\bgroup
350 \vskip\topandbottommargin plus1fill minus1fill
351 \boxmaxdepth = \cornerthick
354 \vbox{\moveleft\cornerthick\nsbot}%
356 \vbox{\moveright\cornerthick\nsbot}%
359 \line{\ewbot\hfil\ewbot}%
361 \egroup % \vbox from first cropmarks clause
363 }% end of \shipout\vbox
364 }% end of group with \indexdummies
366 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
369 \newinsert\margin \dimen\margin=\maxdimen
371 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
373 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
374 % marginal hacks, juha@viisa.uucp (Juha Takala)
375 \ifvoid\margin\else % marginal info is present
376 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
377 \dimen@=\dp#1 \unvbox#1
378 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
379 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
382 % Here are the rules for the cropmarks. Note that they are
383 % offset so that the space between them is truly \outerhsize or \outervsize
384 % (P. A. MacKay, 12 November, 1986)
386 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
388 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
389 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
391 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
393 % Parse an argument, then pass it to #1. The argument is the rest of
394 % the input line (except we remove a trailing comment). #1 should be a
395 % macro which expects an ordinary undelimited TeX argument.
397 \def\parsearg{\parseargusing{}}
398 \def\parseargusing#1#2{%
404 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
408 \gdef\parseargline#1^^M{%
409 \endgroup % End of the group started in \parsearg.
410 \argremovecomment #1\comment\ArgTerm%
414 % First remove any @comment, then any @c comment.
415 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
416 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
418 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
420 % \argremovec might leave us with trailing space, e.g.,
421 % @end itemize @c foo
422 % This space token undergoes the same procedure and is eventually removed
423 % by \finishparsearg.
425 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
426 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
427 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
430 % We cannot use \next here, as it holds the macro to run;
431 % thus we reuse \temp.
432 \let\temp\finishparsearg
434 \let\temp\argcheckspaces
436 % Put the space token in:
440 % If a _delimited_ argument is enclosed in braces, they get stripped; so
441 % to get _exactly_ the rest of the line, we had to prevent such situation.
442 % We prepended an \empty token at the very beginning and we expand it now,
443 % just before passing the control to \next.
444 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
445 % either the null string, or it ends with \^^M---thus there is no danger
446 % that a pair of braces would be stripped.
448 % But first, we have to remove the trailing space token.
450 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
452 % \parseargdef\foo{...}
453 % is roughly equivalent to
454 % \def\foo{\parsearg\Xfoo}
457 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
458 % favourite TeX trick. --kasal, 16nov03
461 \expandafter \doparseargdef \csname\string#1\endcsname #1%
463 \def\doparseargdef#1#2{%
468 % Several utility definitions with active space:
473 % Make each space character in the input produce a normal interword
474 % space in the output. Don't allow a line break at this space, as this
475 % is used only in environments like @example, where each line of input
476 % should produce a line of output anyway.
478 \gdef\sepspaces{\obeyspaces\let =\tie}
480 % If an index command is used in an @example environment, any spaces
481 % therein should become regular spaces in the raw index file, not the
482 % expansion of \tie (\leavevmode \penalty \@M \ ).
483 \gdef\unsepspaces{\let =\space}
487 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
489 % Define the framework for environments in texinfo.tex. It's used like this:
494 % It's the responsibility of \envdef to insert \begingroup before the
495 % actual body; @end closes the group after calling \Efoo. \envdef also
496 % defines \thisenv, so the current environment is known; @end checks
497 % whether the environment name matches. The \checkenv macro can also be
498 % used to check whether the current environment is the one expected.
500 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
501 % are not treated as enviroments; they don't open a group. (The
502 % implementation of @end takes care not to call \endgroup in this
506 % At runtime, environments start with this:
507 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
511 % ... but they get defined via ``\envdef\foo{...}'':
512 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
513 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
515 % Check whether we're in the right environment:
524 % Evironment mismatch, #1 expected:
527 \errmessage{This command can appear only \inenvironment\temp,
528 not \inenvironment\thisenv}%
530 \def\inenvironment#1{%
532 out of any environment%
534 in environment \expandafter\string#1%
538 % @end foo executes the definition of \Efoo.
539 % But first, it executes a specialized version of \checkenv
542 \if 1\csname iscond.#1\endcsname
544 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
545 \expandafter\checkenv\csname#1\endcsname
546 \csname E#1\endcsname
551 \newhelp\EMsimple{Press RETURN to continue.}
554 %% Simple single-character @ commands
557 % Kludge this until the fonts are right (grr).
560 % This is turned off because it was never documented
561 % and you can use @w{...} around a quote to suppress ligatures.
562 %% Define @` and @' to be the same as ` and '
563 %% but suppressing ligatures.
567 % Used to generate quoted braces.
568 \def\mylbrace {{\tt\char123}}
569 \def\myrbrace {{\tt\char125}}
573 % Definitions to produce \{ and \} commands for indices,
574 % and @{ and @} for the aux/toc files.
575 \catcode`\{ = \other \catcode`\} = \other
576 \catcode`\[ = 1 \catcode`\] = 2
577 \catcode`\! = 0 \catcode`\\ = \other
580 !gdef!lbraceatcmd[@{]%
581 !gdef!rbraceatcmd[@}]%
584 % @comma{} to avoid , parsing problems.
587 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
588 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
591 \def\ringaccent#1{{\accent23 #1}}
596 % Other special characters: @questiondown @exclamdown @ordf @ordm
597 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
598 \def\questiondown{?`}
600 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
601 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
603 % Dotless i and dotless j, used for accents.
608 \ifx\temp\imacro \ptexi
609 \else\ifx\temp\jmacro \j
610 \else \errmessage{@dotless can be used only with i or j}%
614 % The \TeX{} logo, as in plain, but resetting the spacing so that a
615 % period following counts as ending a sentence. (Idea found in latex.)
617 \edef\TeX{\TeX \spacefactor=1000 }
619 % @LaTeX{} logo. Not quite the same results as the definition in
620 % latex.ltx, since we use a different font for the raised A; it's most
621 % convenient for us to use an explicitly smaller font, rather than using
622 % the \scriptstyle font (since we don't reset \scriptstyle and
623 % \scriptscriptstyle).
628 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
633 % Be sure we're in horizontal mode when doing a tie, since we make space
634 % equivalent to this in @example-like environments. Otherwise, a space
635 % at the beginning of a line will start with \penalty -- and
636 % since \penalty is valid in vertical mode, we'd end up putting the
637 % penalty on the vertical list instead of in the new paragraph.
639 % Avoid using \@M directly, because that causes trouble
640 % if the definition is written into an index file.
641 \global\let\tiepenalty = \@M
642 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
645 % @: forces normal size whitespace following.
646 \def\:{\spacefactor=1000 }
648 % @* forces a line break.
649 \def\*{\hfil\break\hbox{}\ignorespaces}
651 % @/ allows a line break.
654 % @. is an end-of-sentence period.
655 \def\.{.\spacefactor=\endofsentencespacefactor\space}
657 % @! is an end-of-sentence bang.
658 \def\!{!\spacefactor=\endofsentencespacefactor\space}
660 % @? is an end-of-sentence query.
661 \def\?{?\spacefactor=\endofsentencespacefactor\space}
663 % @frenchspacing on|off says whether to put extra space after punctuation.
668 \parseargdef\frenchspacing{%
670 \ifx\temp\onword \plainfrenchspacing
671 \else\ifx\temp\offword \plainnonfrenchspacing
674 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
678 % @w prevents a word break. Without the \leavevmode, @w at the
679 % beginning of a paragraph, when TeX is still in vertical mode, would
680 % produce a whole line of output instead of starting the paragraph.
681 \def\w#1{\leavevmode\hbox{#1}}
683 % @group ... @end group forces ... to be all on one page, by enclosing
684 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
685 % to keep its height that of a normal line. According to the rules for
686 % \topskip (p.114 of the TeXbook), the glue inserted is
687 % max (\topskip - \ht (first item), 0). If that height is large,
688 % therefore, no glue is inserted, and the space between the headline and
689 % the text is small, which looks bad.
691 % Another complication is that the group might be very large. This can
692 % cause the glue on the previous page to be unduly stretched, because it
693 % does not have much material. In this case, it's better to add an
694 % explicit \vfill so that the extra space is at the bottom. The
695 % threshold for doing this is if the group is more than \vfilllimit
696 % percent of a page (\vfilllimit can be changed inside of @tex).
702 \ifnum\catcode`\^^M=\active \else
703 \errhelp = \groupinvalidhelp
704 \errmessage{@group invalid in context where filling is enabled}%
708 \setbox\groupbox = \vtop\bgroup
709 % Do @comment since we are called inside an environment such as
710 % @example, where each end-of-line in the input causes an
711 % end-of-line in the output. We don't want the end-of-line after
712 % the `@group' to put extra space in the output. Since @group
713 % should appear on a line by itself (according to the Texinfo
714 % manual), we don't worry about eating any user text.
718 % The \vtop produces a box with normal height and large depth; thus, TeX puts
719 % \baselineskip glue before it, and (when the next line of text is done)
720 % \lineskip glue after it. Thus, space below is not quite equal to space
721 % above. But it's pretty close.
723 % To get correct interline space between the last line of the group
724 % and the first line afterwards, we have to propagate \prevdepth.
725 \endgraf % Not \par, as it may have been set to \lisppar.
726 \global\dimen1 = \prevdepth
727 \egroup % End the \vtop.
728 % \dimen0 is the vertical size of the group's box.
729 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
730 % \dimen2 is how much space is left on the page (more or less).
731 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
732 % if the group doesn't fit on the current page, and it's a big big
733 % group, force a page break.
734 \ifdim \dimen0 > \dimen2
735 \ifdim \pagetotal < \vfilllimit\pageheight
744 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
745 % message, so this ends up printing `@group can only ...'.
747 \newhelp\groupinvalidhelp{%
748 group can only be used in environments such as @example,^^J%
749 where each line of input produces a line of output.}
751 % @need space-in-mils
752 % forces a page break if there is not space-in-mils remaining.
754 \newdimen\mil \mil=0.001in
756 % Old definition--didn't work.
757 %\parseargdef\need{\par %
758 %% This method tries to make TeX break the page naturally
759 %% if the depth of the box does not fit.
761 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
766 % Ensure vertical mode, so we don't make a big box in the middle of a
770 % If the @need value is less than one line space, it's useless.
772 \dimen2 = \ht\strutbox
773 \advance\dimen2 by \dp\strutbox
774 \ifdim\dimen0 > \dimen2
776 % Do a \strut just to make the height of this box be normal, so the
777 % normal leading is inserted relative to the preceding line.
778 % And a page break here is fine.
779 \vtop to #1\mil{\strut\vfil}%
781 % TeX does not even consider page breaks if a penalty added to the
782 % main vertical list is 10000 or more. But in order to see if the
783 % empty box we just added fits on the page, we must make it consider
784 % page breaks. On the other hand, we don't want to actually break the
785 % page after the empty box. So we use a penalty of 9999.
787 % There is an extremely small chance that TeX will actually break the
788 % page at this \penalty, if there are no other feasible breakpoints in
789 % sight. (If the user is using lots of big @group commands, which
790 % almost-but-not-quite fill up a page, TeX will have a hard time doing
791 % good page breaking, for example.) However, I could not construct an
792 % example where a page broke at this \penalty; if it happens in a real
793 % document, then we can reconsider our strategy.
796 % Back up by the size of the box, whether we did a page break or not.
799 % Do not allow a page break right after this kern.
804 % @br forces paragraph break (and is undocumented).
808 % @page forces the start of a new page.
810 \def\page{\par\vfill\supereject}
813 % outputs text on separate line in roman font, starting at standard page margin
815 % This records the amount of indent in the innermost environment.
816 % That's how much \exdent should take out.
817 \newskip\exdentamount
819 % This defn is used inside fill environments such as @defun.
820 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
822 % This defn is used inside nofill environments such as @example.
823 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
824 \leftline{\hskip\leftskip{\rm#1}}}}
826 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
827 % paragraph. For more general purposes, use the \margin insertion
828 % class. WHICH is `l' or `r'.
830 \newskip\inmarginspacing \inmarginspacing=1cm
831 \def\strutdepth{\dp\strutbox}
833 \def\doinmargin#1#2{\strut\vadjust{%
836 \vtop to \strutdepth{%
837 \baselineskip=\strutdepth
839 % if you have multiple lines of stuff to put here, you'll need to
840 % make the vbox yourself of the appropriate size.
842 \llap{\ignorespaces #2\hskip\inmarginspacing}%
844 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
849 \def\inleftmargin{\doinmargin l}
850 \def\inrightmargin{\doinmargin r}
852 % @inmargin{TEXT [, RIGHT-TEXT]}
853 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
854 % else use TEXT for both).
856 \def\inmargin#1{\parseinmargin #1,,\finish}
857 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
858 \setbox0 = \hbox{\ignorespaces #2}%
860 \def\lefttext{#1}% have both texts
863 \def\lefttext{#1}% have only one text
868 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
870 \def\temp{\inleftmargin\lefttext}%
875 % @include file insert text of that file as input.
877 \def\include{\parseargusing\filenamecatcodes\includezzz}
883 \def\temp{\input #1 }%
888 \def\filenamecatcodes{%
900 \def\pushthisfilestack{%
901 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
903 \def\pushthisfilestackX{%
904 \expandafter\pushthisfilestackY\thisfile\StackTerm
906 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
907 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
910 \def\popthisfilestack{\errthisfilestackempty}
911 \def\errthisfilestackempty{\errmessage{Internal error:
912 the stack of filenames is empty.}}
917 % outputs that line, centered.
919 \parseargdef\center{%
925 \next{\hfil \ignorespaces#1\unskip \hfil}%
930 \advance\hsize by -\leftskip
931 \advance\hsize by -\rightskip
936 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
938 % @sp n outputs n lines of vertical space
940 \parseargdef\sp{\vskip #1\baselineskip}
942 % @comment ...line which is ignored...
943 % @c is the same as @comment
944 % @ignore ... @end ignore is another way to write a comment
946 \def\comment{\begingroup \catcode`\^^M=\other%
947 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
949 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
953 % @paragraphindent NCHARS
954 % We'll use ems for NCHARS, close enough.
955 % NCHARS can also be the word `asis' or `none'.
956 % We cannot feasibly implement @paragraphindent asis, though.
958 \def\asisword{asis} % no translation, these are keywords
961 \parseargdef\paragraphindent{%
966 \defaultparindent = 0pt
968 \defaultparindent = #1em
971 \parindent = \defaultparindent
974 % @exampleindent NCHARS
975 % We'll use ems for NCHARS like @paragraphindent.
976 % It seems @exampleindent asis isn't necessary, but
977 % I preserve it to make it similar to @paragraphindent.
978 \parseargdef\exampleindent{%
985 \lispnarrowing = #1em
990 % @firstparagraphindent WORD
991 % If WORD is `none', then suppress indentation of the first paragraph
992 % after a section heading. If WORD is `insert', then do indent at such
995 % The paragraph indentation is suppressed or not by calling
996 % \suppressfirstparagraphindent, which the sectioning commands do.
997 % We switch the definition of this back and forth according to WORD.
998 % By default, we suppress indentation.
1000 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1001 \def\insertword{insert}
1003 \parseargdef\firstparagraphindent{%
1006 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1007 \else\ifx\temp\insertword
1008 \let\suppressfirstparagraphindent = \relax
1010 \errhelp = \EMsimple
1011 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1015 % Here is how we actually suppress indentation. Redefine \everypar to
1016 % \kern backwards by \parindent, and then reset itself to empty.
1018 % We also make \indent itself not actually do anything until the next
1021 \gdef\dosuppressfirstparagraphindent{%
1023 \restorefirstparagraphindent
1027 \restorefirstparagraphindent
1030 \global\everypar = {%
1032 \restorefirstparagraphindent
1036 \gdef\restorefirstparagraphindent{%
1037 \global \let \indent = \ptexindent
1038 \global \let \noindent = \ptexnoindent
1039 \global \everypar = {}%
1043 % @asis just yields its argument. Used with @table, for example.
1047 % @math outputs its argument in math mode.
1049 % One complication: _ usually means subscripts, but it could also mean
1050 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1051 % _ active, and distinguish by seeing if the current family is \slfam,
1052 % which is what @var uses.
1054 \catcode\underChar = \active
1055 \gdef\mathunderscore{%
1056 \catcode\underChar=\active
1057 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1060 % Another complication: we want \\ (and @\) to output a \ character.
1061 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1062 % this is not advertised and we don't care. Texinfo does not
1063 % otherwise define @\.
1065 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1066 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1071 \let\\ = \mathbackslash
1075 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1077 % Some active characters (such as <) are spaced differently in math.
1078 % We have to reset their definitions in case the @math was an argument
1079 % to a command which sets the catcodes (such as @item or @section).
1082 \catcode`^ = \active
1083 \catcode`< = \active
1084 \catcode`> = \active
1085 \catcode`+ = \active
1094 % @bullet and @minus need the same treatment as @math, just above.
1095 \def\bullet{$\ptexbullet$}
1098 % @dots{} outputs an ellipsis using the current font.
1099 % We do .5em per period so that it has the same spacing in a typewriter
1100 % font as three actual period characters.
1105 \hskip 0pt plus 0.25fil
1107 \hskip 0pt plus 0.5fil
1111 % @enddots{} is an end-of-sentence ellipsis.
1115 \spacefactor=\endofsentencespacefactor
1118 % @comma{} is so commas can be inserted into text without messing up
1119 % Texinfo's parsing.
1123 % @refill is a no-op.
1126 % If working on a large document in chapters, it is convenient to
1127 % be able to disable indexing, cross-referencing, and contents, for test runs.
1128 % This is done with @novalidate (before @setfilename).
1130 \newif\iflinks \linkstrue % by default we want the aux files.
1131 \let\novalidate = \linksfalse
1133 % @setfilename is done at the beginning of every texinfo file.
1134 % So open here the files we need to have open while reading the input.
1135 % This makes it possible to make a .fmt file for texinfo.
1137 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1140 % Open the new aux file. TeX will close it automatically at exit.
1141 \immediate\openout\auxfile=\jobname.aux
1142 \fi % \openindices needs to do some work in any case.
1144 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1146 % If texinfo.cnf is present on the system, read it.
1147 % Useful for site-wide @afourpaper, etc.
1148 \openin 1 texinfo.cnf
1149 \ifeof 1 \else \input texinfo.cnf \fi
1152 \comment % Ignore the actual filename.
1155 % Called from \setfilename.
1167 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1171 % adobe `portable' document format
1175 \newcount\filenamelength
1184 \newif\ifpdfmakepagedest
1186 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1187 % can be set). So we test for \relax and 0 as well as \undefined,
1188 % borrowed from ifpdf.sty.
1189 \ifx\pdfoutput\undefined
1191 \ifx\pdfoutput\relax
1200 % PDF uses PostScript string constants for the names of xref targets, to
1201 % for display in the outlines, and in other places. Thus, we have to
1202 % double any backslashes. Otherwise, a name like "\node" will be
1203 % interpreted as a newline (\n), followed by o, d, e. Not good.
1204 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1205 % (and related messages, the final outcome is that it is up to the TeX
1206 % user to double the backslashes and otherwise make the string valid, so
1209 % double active backslashes.
1211 {\catcode`\@=0 \catcode`\\=\active
1212 @gdef@activebackslash{@catcode`@\=@active @otherbackslash}
1213 @gdef@activebackslashdouble{%
1214 @catcode@backChar=@active
1215 @let\=@doublebackslash}
1218 % To handle parens, we must adopt a different approach, since parens are
1219 % not active characters. hyperref.dtx (which has the same problem as
1220 % us) handles it with this amazing macro to replace tokens. I've
1221 % tinkered with it a little for texinfo, but it's definitely from there.
1223 % #1 is the tokens to replace.
1224 % #2 is the replacement.
1225 % #3 is the control sequence with the string.
1227 \def\HyPsdSubst#1#2#3{%
1228 \def\HyPsdReplace##1#1##2\END{%
1234 \HyPsdReplace##2\END
1238 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1240 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1242 % #1 is a control sequence in which to do the replacements.
1243 \def\backslashparens#1{%
1244 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1245 % \lastnode when called from \setref -> \pdfmkdest.
1246 \HyPsdSubst{(}{\backslashlparen}{#1}%
1247 \HyPsdSubst{)}{\backslashrparen}{#1}%
1250 {\catcode\exclamChar = 0 \catcode\backChar = \other
1251 !gdef!backslashlparen{\(}%
1252 !gdef!backslashrparen{\)}%
1257 \pdfcatalog{/PageMode /UseOutlines}%
1258 \def\dopdfimage#1#2#3{%
1259 \def\imagewidth{#2}%
1260 \def\imageheight{#3}%
1261 % without \immediate, pdftex seg faults when the same image is
1262 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1263 \ifnum\pdftexversion < 14
1266 \immediate\pdfximage
1268 \ifx\empty\imagewidth\else width \imagewidth \fi
1269 \ifx\empty\imageheight\else height \imageheight \fi
1270 \ifnum\pdftexversion<13
1275 \ifnum\pdftexversion < 14 \else
1276 \pdfrefximage \pdflastximage
1279 % We have to set dummies so commands such as @code, and characters
1280 % such as \, aren't expanded when present in a section title.
1282 \activebackslashdouble
1283 \def\pdfdestname{#1}%
1284 \backslashparens\pdfdestname
1285 \pdfdest name{\pdfdestname} xyz%
1288 % used to mark target names; must be expandable.
1289 \def\pdfmkpgn#1{#1}%
1291 \let\linkcolor = \Blue % was Cyan, but that seems light?
1292 \def\endlink{\Black\pdfendlink}
1293 % Adding outlines to PDF; macros for calculating structure of outlines
1294 % come from Petr Olsak
1295 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1296 \else \csname#1\endcsname \fi}
1297 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1298 \advance\tempnum by 1
1299 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1301 % #1 is the section text, which is what will be displayed in the
1302 % outline by the pdf viewer. #2 is the pdf expression for the number
1303 % of subentries (or empty, for subsubsections). #3 is the node text,
1304 % which might be empty if this toc entry had no corresponding node.
1305 % #4 is the page number
1307 \def\dopdfoutline#1#2#3#4{%
1308 % Generate a link to the node text if that exists; else, use the
1309 % page number. We could generate a destination for the section
1310 % text in the case where a section has no node, but it doesn't
1311 % seem worth the trouble, since most documents are normally structured.
1312 \def\pdfoutlinedest{#3}%
1313 \ifx\pdfoutlinedest\empty
1314 \def\pdfoutlinedest{#4}%
1316 % Doubled backslashes in the name.
1317 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1318 \backslashparens\pdfoutlinedest}%
1321 % Also double the backslashes in the display string.
1322 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1323 \backslashparens\pdfoutlinetext}%
1325 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1328 \def\pdfmakeoutlines{%
1330 % Thanh's hack / proper braces in bookmarks
1331 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1332 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1334 % Read toc silently, to get counts of subentries for \pdfoutline.
1335 \def\numchapentry##1##2##3##4{%
1336 \def\thischapnum{##2}%
1338 \def\thissubsecnum{0}%
1340 \def\numsecentry##1##2##3##4{%
1341 \advancenumber{chap\thischapnum}%
1342 \def\thissecnum{##2}%
1343 \def\thissubsecnum{0}%
1345 \def\numsubsecentry##1##2##3##4{%
1346 \advancenumber{sec\thissecnum}%
1347 \def\thissubsecnum{##2}%
1349 \def\numsubsubsecentry##1##2##3##4{%
1350 \advancenumber{subsec\thissubsecnum}%
1352 \def\thischapnum{0}%
1354 \def\thissubsecnum{0}%
1356 % use \def rather than \let here because we redefine \chapentry et
1357 % al. a second time, below.
1358 \def\appentry{\numchapentry}%
1359 \def\appsecentry{\numsecentry}%
1360 \def\appsubsecentry{\numsubsecentry}%
1361 \def\appsubsubsecentry{\numsubsubsecentry}%
1362 \def\unnchapentry{\numchapentry}%
1363 \def\unnsecentry{\numsecentry}%
1364 \def\unnsubsecentry{\numsubsecentry}%
1365 \def\unnsubsubsecentry{\numsubsubsecentry}%
1368 % Read toc second time, this time actually producing the outlines.
1369 % The `-' means take the \expnumber as the absolute number of
1370 % subentries, which we calculated on our first read of the .toc above.
1372 % We use the node names as the destinations.
1373 \def\numchapentry##1##2##3##4{%
1374 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1375 \def\numsecentry##1##2##3##4{%
1376 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1377 \def\numsubsecentry##1##2##3##4{%
1378 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1379 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1380 \dopdfoutline{##1}{}{##3}{##4}}%
1382 % PDF outlines are displayed using system fonts, instead of
1383 % document fonts. Therefore we cannot use special characters,
1384 % since the encoding is unknown. For example, the eogonek from
1385 % Latin 2 (0xea) gets translated to a | character. Info from
1386 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1388 % xx to do this right, we have to translate 8-bit characters to
1389 % their "best" equivalent, based on the @documentencoding. Right
1390 % now, I guess we'll just let the pdf reader have its way.
1398 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1399 \ifx\PP\D\let\nextsp\relax
1400 \else\let\nextsp\skipspaces
1401 \ifx\p\space\else\addtokens{\filename}{\PP}%
1402 \advance\filenamelength by 1
1406 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1407 \ifnum\pdftexversion < 14
1408 \let \startlink \pdfannotlink
1410 \let \startlink \pdfstartlink
1414 \normalturnoffactive\def\@{@}%
1415 \makevalueexpandable
1417 \startlink attr{/Border [0 0 0]}%
1418 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1420 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1421 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1422 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1423 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1425 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1427 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1428 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1429 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1431 \ifnum0=\countA\else\makelink\fi
1432 \ifx\first.\let\next=\done\else
1434 \addtokens{\toksB}{\the\toksD}
1435 \ifx\first,\addtokens{\toksB}{\space}\fi
1437 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1439 \def\makelink{\addtokens{\toksB}%
1440 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1442 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1443 \linkcolor #1\endlink}
1444 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1446 \let\pdfmkdest = \gobble
1447 \let\pdfurl = \gobble
1448 \let\endlink = \relax
1449 \let\linkcolor = \relax
1450 \let\pdfmakeoutlines = \relax
1451 \fi % \ifx\pdfoutput
1456 % Change the current font style to #1, remembering it in \curfontstyle.
1457 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1458 % italics, not bold italics.
1460 \def\setfontstyle#1{%
1461 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1462 \csname ten#1\endcsname % change the current font
1465 % Select #1 fonts with the current style.
1467 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1469 \def\rm{\fam=0 \setfontstyle{rm}}
1470 \def\it{\fam=\itfam \setfontstyle{it}}
1471 \def\sl{\fam=\slfam \setfontstyle{sl}}
1472 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1473 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1475 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1476 % So we set up a \sf.
1478 \def\sf{\fam=\sffam \setfontstyle{sf}}
1479 \let\li = \sf % Sometimes we call it \li, not \sf.
1481 % We don't need math for this font style.
1482 \def\ttsl{\setfontstyle{ttsl}}
1485 \newdimen\textleading \textleading = 13.2pt
1487 % Set the baselineskip to #1, and the lineskip and strut size
1488 % correspondingly. There is no deep meaning behind these magic numbers
1489 % used as factors; they just match (closely enough) what Knuth defined.
1491 \def\lineskipfactor{.08333}
1492 \def\strutheightpercent{.70833}
1493 \def\strutdepthpercent {.29167}
1496 \normalbaselineskip = #1\relax
1497 \normallineskip = \lineskipfactor\normalbaselineskip
1499 \setbox\strutbox =\hbox{%
1500 \vrule width0pt height\strutheightpercent\baselineskip
1501 depth \strutdepthpercent \baselineskip
1505 % Set the font macro #1 to the font named #2, adding on the
1506 % specified font prefix (normally `cm').
1507 % #3 is the font's design size, #4 is a scale factor
1508 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1510 % Use cm as the default font prefix.
1511 % To specify the font prefix, you must define \fontprefix
1512 % before you read in texinfo.tex.
1513 \ifx\fontprefix\undefined
1516 % Support font families that don't use the same naming scheme as CM.
1518 \def\rmbshape{bx} %where the normal face is bold
1523 \def\ttslshape{sltt}
1533 % Text fonts (11.2pt, magstep1).
1534 \def\textnominalsize{11pt}
1535 \edef\mainmagstep{\magstephalf}
1536 \setfont\textrm\rmshape{10}{\mainmagstep}
1537 \setfont\texttt\ttshape{10}{\mainmagstep}
1538 \setfont\textbf\bfshape{10}{\mainmagstep}
1539 \setfont\textit\itshape{10}{\mainmagstep}
1540 \setfont\textsl\slshape{10}{\mainmagstep}
1541 \setfont\textsf\sfshape{10}{\mainmagstep}
1542 \setfont\textsc\scshape{10}{\mainmagstep}
1543 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1544 \font\texti=cmmi10 scaled \mainmagstep
1545 \font\textsy=cmsy10 scaled \mainmagstep
1547 % A few fonts for @defun names and args.
1548 \setfont\defbf\bfshape{10}{\magstep1}
1549 \setfont\deftt\ttshape{10}{\magstep1}
1550 \setfont\defttsl\ttslshape{10}{\magstep1}
1551 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1553 % Fonts for indices, footnotes, small examples (9pt).
1554 \def\smallnominalsize{9pt}
1555 \setfont\smallrm\rmshape{9}{1000}
1556 \setfont\smalltt\ttshape{9}{1000}
1557 \setfont\smallbf\bfshape{10}{900}
1558 \setfont\smallit\itshape{9}{1000}
1559 \setfont\smallsl\slshape{9}{1000}
1560 \setfont\smallsf\sfshape{9}{1000}
1561 \setfont\smallsc\scshape{10}{900}
1562 \setfont\smallttsl\ttslshape{10}{900}
1566 % Fonts for small examples (8pt).
1567 \def\smallernominalsize{8pt}
1568 \setfont\smallerrm\rmshape{8}{1000}
1569 \setfont\smallertt\ttshape{8}{1000}
1570 \setfont\smallerbf\bfshape{10}{800}
1571 \setfont\smallerit\itshape{8}{1000}
1572 \setfont\smallersl\slshape{8}{1000}
1573 \setfont\smallersf\sfshape{8}{1000}
1574 \setfont\smallersc\scshape{10}{800}
1575 \setfont\smallerttsl\ttslshape{10}{800}
1576 \font\smalleri=cmmi8
1577 \font\smallersy=cmsy8
1579 % Fonts for title page (20.4pt):
1580 \def\titlenominalsize{20pt}
1581 \setfont\titlerm\rmbshape{12}{\magstep3}
1582 \setfont\titleit\itbshape{10}{\magstep4}
1583 \setfont\titlesl\slbshape{10}{\magstep4}
1584 \setfont\titlett\ttbshape{12}{\magstep3}
1585 \setfont\titlettsl\ttslshape{10}{\magstep4}
1586 \setfont\titlesf\sfbshape{17}{\magstep1}
1587 \let\titlebf=\titlerm
1588 \setfont\titlesc\scbshape{10}{\magstep4}
1589 \font\titlei=cmmi12 scaled \magstep3
1590 \font\titlesy=cmsy10 scaled \magstep4
1591 \def\authorrm{\secrm}
1592 \def\authortt{\sectt}
1594 % Chapter (and unnumbered) fonts (17.28pt).
1595 \def\chapnominalsize{17pt}
1596 \setfont\chaprm\rmbshape{12}{\magstep2}
1597 \setfont\chapit\itbshape{10}{\magstep3}
1598 \setfont\chapsl\slbshape{10}{\magstep3}
1599 \setfont\chaptt\ttbshape{12}{\magstep2}
1600 \setfont\chapttsl\ttslshape{10}{\magstep3}
1601 \setfont\chapsf\sfbshape{17}{1000}
1603 \setfont\chapsc\scbshape{10}{\magstep3}
1604 \font\chapi=cmmi12 scaled \magstep2
1605 \font\chapsy=cmsy10 scaled \magstep3
1607 % Section fonts (14.4pt).
1608 \def\secnominalsize{14pt}
1609 \setfont\secrm\rmbshape{12}{\magstep1}
1610 \setfont\secit\itbshape{10}{\magstep2}
1611 \setfont\secsl\slbshape{10}{\magstep2}
1612 \setfont\sectt\ttbshape{12}{\magstep1}
1613 \setfont\secttsl\ttslshape{10}{\magstep2}
1614 \setfont\secsf\sfbshape{12}{\magstep1}
1616 \setfont\secsc\scbshape{10}{\magstep2}
1617 \font\seci=cmmi12 scaled \magstep1
1618 \font\secsy=cmsy10 scaled \magstep2
1620 % Subsection fonts (13.15pt).
1621 \def\ssecnominalsize{13pt}
1622 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1623 \setfont\ssecit\itbshape{10}{1315}
1624 \setfont\ssecsl\slbshape{10}{1315}
1625 \setfont\ssectt\ttbshape{12}{\magstephalf}
1626 \setfont\ssecttsl\ttslshape{10}{1315}
1627 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1629 \setfont\ssecsc\scbshape{10}{1315}
1630 \font\sseci=cmmi12 scaled \magstephalf
1631 \font\ssecsy=cmsy10 scaled 1315
1633 % Reduced fonts for @acro in text (10pt).
1634 \def\reducednominalsize{10pt}
1635 \setfont\reducedrm\rmshape{10}{1000}
1636 \setfont\reducedtt\ttshape{10}{1000}
1637 \setfont\reducedbf\bfshape{10}{1000}
1638 \setfont\reducedit\itshape{10}{1000}
1639 \setfont\reducedsl\slshape{10}{1000}
1640 \setfont\reducedsf\sfshape{10}{1000}
1641 \setfont\reducedsc\scshape{10}{1000}
1642 \setfont\reducedttsl\ttslshape{10}{1000}
1643 \font\reducedi=cmmi10
1644 \font\reducedsy=cmsy10
1646 % In order for the font changes to affect most math symbols and letters,
1647 % we have to define the \textfont of the standard families. Since
1648 % texinfo doesn't allow for producing subscripts and superscripts except
1649 % in the main text, we don't bother to reset \scriptfont and
1650 % \scriptscriptfont (which would also require loading a lot more fonts).
1652 \def\resetmathfonts{%
1653 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1654 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1655 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1658 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1659 % of just \STYLE. We do this because \STYLE needs to also set the
1660 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1661 % \tenSTYLE to set the current font.
1663 % Each font-changing command also sets the names \lsize (one size lower)
1664 % and \lllsize (three sizes lower). These relative commands are used in
1665 % the LaTeX logo and acronyms.
1667 % This all needs generalizing, badly.
1670 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1671 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1672 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1673 \let\tenttsl=\textttsl
1674 \def\curfontsize{text}%
1675 \def\lsize{reduced}\def\lllsize{smaller}%
1676 \resetmathfonts \setleading{\textleading}}
1678 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1679 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1680 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1681 \let\tenttsl=\titlettsl
1682 \def\curfontsize{title}%
1683 \def\lsize{chap}\def\lllsize{subsec}%
1684 \resetmathfonts \setleading{25pt}}
1685 \def\titlefont#1{{\titlefonts\rm #1}}
1687 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1688 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1689 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1690 \let\tenttsl=\chapttsl
1691 \def\curfontsize{chap}%
1692 \def\lsize{sec}\def\lllsize{text}%
1693 \resetmathfonts \setleading{19pt}}
1695 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1696 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1697 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1698 \let\tenttsl=\secttsl
1699 \def\curfontsize{sec}%
1700 \def\lsize{subsec}\def\lllsize{reduced}%
1701 \resetmathfonts \setleading{16pt}}
1703 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1704 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1705 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1706 \let\tenttsl=\ssecttsl
1707 \def\curfontsize{ssec}%
1708 \def\lsize{text}\def\lllsize{small}%
1709 \resetmathfonts \setleading{15pt}}
1710 \let\subsubsecfonts = \subsecfonts
1712 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1713 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1714 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1715 \let\tenttsl=\reducedttsl
1716 \def\curfontsize{reduced}%
1717 \def\lsize{small}\def\lllsize{smaller}%
1718 \resetmathfonts \setleading{10.5pt}}
1720 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1721 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1722 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1723 \let\tenttsl=\smallttsl
1724 \def\curfontsize{small}%
1725 \def\lsize{smaller}\def\lllsize{smaller}%
1726 \resetmathfonts \setleading{10.5pt}}
1728 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1729 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1730 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1731 \let\tenttsl=\smallerttsl
1732 \def\curfontsize{smaller}%
1733 \def\lsize{smaller}\def\lllsize{smaller}%
1734 \resetmathfonts \setleading{9.5pt}}
1736 % Set the fonts to use with the @small... environments.
1737 \let\smallexamplefonts = \smallfonts
1739 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1740 % can fit this many characters:
1741 % 8.5x11=86 smallbook=72 a4=90 a5=69
1742 % If we use \scriptfonts (8pt), then we can fit this many characters:
1743 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1744 % For me, subjectively, the few extra characters that fit aren't worth
1745 % the additional smallness of 8pt. So I'm making the default 9pt.
1747 % By the way, for comparison, here's what fits with @example (10pt):
1748 % 8.5x11=71 smallbook=60 a4=75 a5=58
1750 % I wish the USA used A4 paper.
1754 % Set up the default fonts, so we can use them for creating boxes.
1758 % Define these so they can be easily changed for other fonts.
1759 \def\angleleft{$\langle$}
1760 \def\angleright{$\rangle$}
1762 % Count depth in font-changes, for error checks
1763 \newcount\fontdepth \fontdepth=0
1765 % Fonts for short table of contents.
1766 \setfont\shortcontrm\rmshape{12}{1000}
1767 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1768 \setfont\shortcontsl\slshape{12}{1000}
1769 \setfont\shortconttt\ttshape{12}{1000}
1771 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1772 %% serif) and @ii for TeX italic
1774 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1775 % unless the following character is such as not to need one.
1776 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1777 \ptexslash\fi\fi\fi}
1778 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1779 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1781 % like \smartslanted except unconditionally uses \ttsl.
1782 % @var is set to this for defun arguments.
1783 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1785 % like \smartslanted except unconditionally use \sl. We never want
1786 % ttsl for book titles, do we?
1787 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1790 \let\slanted=\smartslanted
1791 \let\var=\smartslanted
1792 \let\dfn=\smartslanted
1793 \let\emph=\smartitalic
1795 % @b, explicit bold.
1799 % @sansserif, explicit sans.
1800 \def\sansserif#1{{\sf #1}}
1802 % We can't just use \exhyphenpenalty, because that only has effect at
1803 % the end of a paragraph. Restore normal hyphenation at the end of the
1804 % group within which \nohyphenation is presumably called.
1806 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1807 \def\restorehyphenation{\hyphenchar\font = `- }
1809 % Set sfcode to normal for the chars that usually have another value.
1810 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1811 % sometimes \x has an active definition that messes things up.
1814 \def\plainfrenchspacing{%
1815 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1816 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1817 \def\endofsentencespacefactor{1000}% for @. and friends
1819 \def\plainnonfrenchspacing{%
1820 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1821 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1822 \def\endofsentencespacefactor{3000}% for @. and friends
1825 \def\endofsentencespacefactor{3000}% default
1828 {\tt \rawbackslash \plainfrenchspacing #1}%
1831 \def\samp#1{`\tclose{#1}'\null}
1832 \setfont\keyrm\rmshape{8}{1000}
1834 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1835 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1836 \vbox{\hrule\kern-0.4pt
1837 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1839 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1840 % The old definition, with no lozenge:
1841 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1842 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1844 % @file, @option are the same as @samp.
1848 % @code is a modification of @t,
1849 % which makes spaces the same size as normal in the surrounding text.
1852 % Change normal interword space to be same as for the current font.
1853 \spaceskip = \fontdimen2\font
1855 % Switch to typewriter.
1858 % But `\ ' produces the large typewriter interword space.
1859 \def\ {{\spaceskip = 0pt{} }}%
1861 % Turn off hyphenation.
1871 % We *must* turn on hyphenation at `-' and `_' in @code.
1872 % Otherwise, it is too hard to avoid overfull hboxes
1873 % in the Emacs manual, the Library manual, etc.
1875 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1876 % both hyphenation at - and hyphenation within words.
1877 % We must therefore turn them both off (\tclose does that)
1878 % and arrange explicitly to hyphenate at a dash.
1884 \global\def\code{\begingroup
1885 \catcode`\-=\active \catcode`\_=\active
1898 \def\codedash{-\discretionary{}{}{}}
1900 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1901 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1902 % will therefore expand the active definition of _, which is us
1903 % (inside @code that is), therefore an endless loop.
1905 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1906 \else\normalunderscore \fi
1907 \discretionary{}{}{}}%
1910 \def\codex #1{\tclose{#1}\endgroup}
1912 % An additional complication: the above will allow breaks after, e.g.,
1913 % each of the four underscores in __typeof__. This is undesirable in
1914 % some manuals, especially if they don't have long identifiers in
1915 % general. @allowcodebreaks provides a way to control this.
1917 \newif\ifallowcodebreaks \allowcodebreakstrue
1919 \def\keywordtrue{true}
1920 \def\keywordfalse{false}
1922 \parseargdef\allowcodebreaks{%
1924 \ifx\txiarg\keywordtrue
1925 \allowcodebreakstrue
1926 \else\ifx\txiarg\keywordfalse
1927 \allowcodebreaksfalse
1929 \errhelp = \EMsimple
1930 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
1934 % @kbd is like @code, except that if the argument is just one @key command,
1935 % then @kbd has no effect.
1937 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1938 % `example' (@kbd uses ttsl only inside of @example and friends),
1939 % or `code' (@kbd uses normal tty font always).
1940 \parseargdef\kbdinputstyle{%
1942 \ifx\txiarg\worddistinct
1943 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1944 \else\ifx\txiarg\wordexample
1945 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1946 \else\ifx\txiarg\wordcode
1947 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1949 \errhelp = \EMsimple
1950 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
1953 \def\worddistinct{distinct}
1954 \def\wordexample{example}
1957 % Default is `distinct.'
1958 \kbdinputstyle distinct
1961 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1962 \ifx\one\xkey\ifx\threex\three \key{#2}%
1963 \else{\tclose{\kbdfont\look}}\fi
1964 \else{\tclose{\kbdfont\look}}\fi}
1966 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1967 \let\indicateurl=\code
1971 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1972 % second argument specifying the text to display and an optional third
1973 % arg as text to display instead of (rather than in addition to) the url
1974 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1975 % a hypertex \special here.
1977 \def\uref#1{\douref #1,,,\finish}
1978 \def\douref#1,#2,#3,#4\finish{\begingroup
1981 \setbox0 = \hbox{\ignorespaces #3}%
1983 \unhbox0 % third arg given, show only that
1985 \setbox0 = \hbox{\ignorespaces #2}%
1988 \unhbox0 % PDF: 2nd arg given, show only it
1990 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1993 \code{#1}% only url given, so show it
1999 % @url synonym for @uref, since that's how everyone uses it.
2003 % rms does not like angle brackets --karl, 17may97.
2004 % So now @email is just like @uref, unless we are pdf.
2006 %\def\email#1{\angleleft{\tt #1}\angleright}
2008 \def\email#1{\doemail#1,,\finish}
2009 \def\doemail#1,#2,#3\finish{\begingroup
2012 \setbox0 = \hbox{\ignorespaces #2}%
2013 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2020 % Check if we are currently using a typewriter font. Since all the
2021 % Computer Modern typewriter fonts have zero interword stretch (and
2022 % shrink), and it is reasonable to expect all typewriter fonts to have
2023 % this property, we can check that font parameter.
2025 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2027 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2028 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2030 \def\dmn#1{\thinspace #1}
2032 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2034 % @l was never documented to mean ``switch to the Lisp font'',
2035 % and it is not used as such in any manual I can find. We need it for
2036 % Polish suppressed-l. --karl, 22sep96.
2037 %\def\l#1{{\li #1}\null}
2039 % Explicit font changes: @r, @sc, undocumented @ii.
2040 \def\r#1{{\rm #1}} % roman font
2041 \def\sc#1{{\smallcaps#1}} % smallcaps font
2042 \def\ii#1{{\it #1}} % italic font
2044 % @acronym for "FBI", "NATO", and the like.
2045 % We print this one point size smaller, since it's intended for
2048 \def\acronym#1{\doacronym #1,,\finish}
2049 \def\doacronym#1,#2,#3\finish{%
2050 {\selectfonts\lsize #1}%
2052 \ifx\temp\empty \else
2053 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2057 % @abbr for "Comput. J." and the like.
2058 % No font change, but don't do end-of-sentence spacing.
2060 \def\abbr#1{\doabbr #1,,\finish}
2061 \def\doabbr#1,#2,#3\finish{%
2062 {\plainfrenchspacing #1}%
2064 \ifx\temp\empty \else
2065 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2069 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2071 \def\pounds{{\it\$}}
2073 % @euro{} comes from a separate font, depending on the current style.
2074 % We use the free feym* fonts from the eurosym package by Henrik
2075 % Theiling, which support regular, slanted, bold and bold slanted (and
2076 % "outlined" (blackboard board, sort of) versions, which we don't need).
2077 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2079 % Although only regular is the truly official Euro symbol, we ignore
2080 % that. The Euro is designed to be slightly taller than the regular
2086 % feybo - bold slanted
2088 % There is no good (free) typewriter version, to my knowledge.
2089 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2092 % Also doesn't work in math. Do we need to do math with euro symbols?
2096 \def\euro{{\eurofont e}}
2098 % We set the font at each command, rather than predefining it in
2099 % \textfonts and the other font-switching commands, so that
2100 % installations which never need the symbol don't have to have the
2103 % There is only one designed size (nominal 10pt), so we always scale
2104 % that to the current nominal size.
2106 % By the way, simply using "at 1em" works for cmr10 and the like, but
2107 % does not work for cmbx10 and other extended/shrunken fonts.
2109 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2111 \ifx\curfontstyle\bfstylename
2113 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2116 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2121 % @registeredsymbol - R in a circle. The font for the R should really
2122 % be smaller yet, but lllsize is the best we can do for now.
2123 % Adapted from the plain.tex definition of \copyright.
2125 \def\registeredsymbol{%
2126 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2131 % Laurent Siebenmann reports \Orb undefined with:
2132 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2133 % so we'll define it if necessary.
2136 \def\Orb{\mathhexbox20D}
2140 \message{page headings,}
2142 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2143 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2145 % First the title page. Must do @settitle before @titlepage.
2147 \newif\iffinishedtitlepage
2149 % Do an implicit @contents or @shortcontents after @end titlepage if the
2150 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2152 \newif\ifsetcontentsaftertitlepage
2153 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2154 \newif\ifsetshortcontentsaftertitlepage
2155 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2157 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2158 \endgroup\page\hbox{}\page}
2161 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2163 \parindent=0pt \textfonts
2164 % Leave some space at the very top of the page.
2165 \vglue\titlepagetopglue
2166 % No rule at page bottom unless we print one at the top with @title.
2167 \finishedtitlepagetrue
2169 % Most title ``pages'' are actually two pages long, with space
2170 % at the top of the second. We don't want the ragged left on the second.
2171 \let\oldpage = \page
2173 \iffinishedtitlepage\else
2176 \let\page = \oldpage
2183 \iffinishedtitlepage\else
2186 % It is important to do the page break before ending the group,
2187 % because the headline and footline are only empty inside the group.
2188 % If we use the new definition of \page, we always get a blank page
2189 % after the title page, which we certainly don't want.
2193 % Need this before the \...aftertitlepage checks so that if they are
2194 % in effect the toc pages will come out with page numbers.
2197 % If they want short, they certainly want long too.
2198 \ifsetshortcontentsaftertitlepage
2201 \global\let\shortcontents = \relax
2202 \global\let\contents = \relax
2205 \ifsetcontentsaftertitlepage
2207 \global\let\contents = \relax
2208 \global\let\shortcontents = \relax
2212 \def\finishtitlepage{%
2213 \vskip4pt \hrule height 2pt width \hsize
2214 \vskip\titlepagebottomglue
2215 \finishedtitlepagetrue
2218 %%% Macros to be used within @titlepage:
2220 \let\subtitlerm=\tenrm
2221 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2223 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2226 \parseargdef\title{%
2228 \leftline{\titlefonts\rm #1}
2229 % print a rule at the page bottom also.
2230 \finishedtitlepagefalse
2231 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2234 \parseargdef\subtitle{%
2236 {\subtitlefont \rightline{#1}}%
2239 % @author should come last, but may come many times.
2240 % It can also be used inside @quotation.
2242 \parseargdef\author{%
2243 \def\temp{\quotation}%
2245 \def\quotationauthor{#1}% printed in \Equotation.
2248 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2249 {\authorfont \leftline{#1}}%
2254 %%% Set up page headings and footings.
2256 \let\thispage=\folio
2258 \newtoks\evenheadline % headline on even pages
2259 \newtoks\oddheadline % headline on odd pages
2260 \newtoks\evenfootline % footline on even pages
2261 \newtoks\oddfootline % footline on odd pages
2263 % Now make TeX use those variables
2264 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2265 \else \the\evenheadline \fi}}
2266 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2267 \else \the\evenfootline \fi}\HEADINGShook}
2268 \let\HEADINGShook=\relax
2270 % Commands to set those variables.
2271 % For example, this is what @headings on does
2272 % @evenheading @thistitle|@thispage|@thischapter
2273 % @oddheading @thischapter|@thispage|@thistitle
2274 % @evenfooting @thisfile||
2275 % @oddfooting ||@thisfile
2278 \def\evenheading{\parsearg\evenheadingxxx}
2279 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2280 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2281 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2283 \def\oddheading{\parsearg\oddheadingxxx}
2284 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2285 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2286 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2288 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2290 \def\evenfooting{\parsearg\evenfootingxxx}
2291 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2292 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2293 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2295 \def\oddfooting{\parsearg\oddfootingxxx}
2296 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2297 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2298 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2300 % Leave some space for the footline. Hopefully ok to assume
2301 % @evenfooting will not be used by itself.
2302 \global\advance\pageheight by -\baselineskip
2303 \global\advance\vsize by -\baselineskip
2306 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2309 % @headings double turns headings on for double-sided printing.
2310 % @headings single turns headings on for single-sided printing.
2311 % @headings off turns them off.
2312 % @headings on same as @headings double, retained for compatibility.
2313 % @headings after turns on double-sided headings after this page.
2314 % @headings doubleafter turns on double-sided headings after this page.
2315 % @headings singleafter turns on single-sided headings after this page.
2316 % By default, they are off at the start of a document,
2317 % and turned `on' after @end titlepage.
2319 \def\headings #1 {\csname HEADINGS#1\endcsname}
2322 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2323 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2325 % When we turn headings on, set the page number to 1.
2326 % For double-sided printing, put current file name in lower left corner,
2327 % chapter name on inside top of right hand pages, document
2328 % title on inside top of left hand pages, and page numbers on outside top
2329 % edge of all pages.
2330 \def\HEADINGSdouble{%
2332 \global\evenfootline={\hfil}
2333 \global\oddfootline={\hfil}
2334 \global\evenheadline={\line{\folio\hfil\thistitle}}
2335 \global\oddheadline={\line{\thischapter\hfil\folio}}
2336 \global\let\contentsalignmacro = \chapoddpage
2338 \let\contentsalignmacro = \chappager
2340 % For single-sided printing, chapter title goes across top left of page,
2341 % page number on top right.
2342 \def\HEADINGSsingle{%
2344 \global\evenfootline={\hfil}
2345 \global\oddfootline={\hfil}
2346 \global\evenheadline={\line{\thischapter\hfil\folio}}
2347 \global\oddheadline={\line{\thischapter\hfil\folio}}
2348 \global\let\contentsalignmacro = \chappager
2350 \def\HEADINGSon{\HEADINGSdouble}
2352 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2353 \let\HEADINGSdoubleafter=\HEADINGSafter
2354 \def\HEADINGSdoublex{%
2355 \global\evenfootline={\hfil}
2356 \global\oddfootline={\hfil}
2357 \global\evenheadline={\line{\folio\hfil\thistitle}}
2358 \global\oddheadline={\line{\thischapter\hfil\folio}}
2359 \global\let\contentsalignmacro = \chapoddpage
2362 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2363 \def\HEADINGSsinglex{%
2364 \global\evenfootline={\hfil}
2365 \global\oddfootline={\hfil}
2366 \global\evenheadline={\line{\thischapter\hfil\folio}}
2367 \global\oddheadline={\line{\thischapter\hfil\folio}}
2368 \global\let\contentsalignmacro = \chappager
2371 % Subroutines used in generating headings
2372 % This produces Day Month Year style of output.
2373 % Only define if not already defined, in case a txi-??.tex file has set
2374 % up a different format (e.g., txi-cs.tex does this).
2375 \ifx\today\undefined
2379 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2380 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2381 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2386 % @settitle line... specifies the title of the document, for headings.
2387 % It generates no output of its own.
2388 \def\thistitle{\putwordNoTitle}
2389 \def\settitle{\parsearg{\gdef\thistitle}}
2393 % Tables -- @table, @ftable, @vtable, @item(x).
2395 % default indentation of table text
2396 \newdimen\tableindent \tableindent=.8in
2397 % default indentation of @itemize and @enumerate text
2398 \newdimen\itemindent \itemindent=.3in
2399 % margin between end of table item and start of table text.
2400 \newdimen\itemmargin \itemmargin=.1in
2402 % used internally for \itemindent minus \itemmargin
2405 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2407 % They also define \itemindex
2408 % to index the item name in whatever manner is desired (perhaps none).
2410 \newif\ifitemxneedsnegativevskip
2412 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2414 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2415 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2417 \def\itemzzz #1{\begingroup %
2418 \advance\hsize by -\rightskip
2419 \advance\hsize by -\tableindent
2420 \setbox0=\hbox{\itemindicate{#1}}%
2422 \nobreak % This prevents a break before @itemx.
2424 % If the item text does not fit in the space we have, put it on a line
2425 % by itself, and do not allow a page break either before or after that
2426 % line. We do not start a paragraph here because then if the next
2427 % command is, e.g., @kindex, the whatsit would get put into the
2428 % horizontal list on a line by itself, resulting in extra blank space.
2429 \ifdim \wd0>\itemmax
2431 % Make this a paragraph so we get the \parskip glue and wrapping,
2432 % but leave it ragged-right.
2434 \advance\leftskip by-\tableindent
2435 \advance\hsize by\tableindent
2436 \advance\rightskip by0pt plus1fil
2437 \leavevmode\unhbox0\par
2440 % We're going to be starting a paragraph, but we don't want the
2441 % \parskip glue -- logically it's part of the @item we just started.
2442 \nobreak \vskip-\parskip
2444 % Stop a page break at the \parskip glue coming up. However, if
2445 % what follows is an environment such as @example, there will be no
2446 % \parskip glue; then the negative vskip we just inserted would
2447 % cause the example and the item to crash together. So we use this
2448 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2449 % \parskip glue after all. Section titles are handled this way also.
2453 \itemxneedsnegativevskipfalse
2455 % The item text fits into the space. Start a paragraph, so that the
2456 % following text (if any) will end up on the same line.
2458 % Do this with kerns and \unhbox so that if there is a footnote in
2459 % the item text, it can migrate to the main vertical list and
2460 % eventually be printed.
2461 \nobreak\kern-\tableindent
2462 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2464 \nobreak\kern\dimen0
2466 \itemxneedsnegativevskiptrue
2470 \def\item{\errmessage{@item while not in a list environment}}
2471 \def\itemx{\errmessage{@itemx while not in a list environment}}
2473 % @table, @ftable, @vtable.
2475 \let\itemindex\gobble
2479 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2480 \tablecheck{ftable}%
2483 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2484 \tablecheck{vtable}%
2487 \ifnum \the\catcode`\^^M=\active
2489 \errmessage{This command won't work in this context; perhaps the problem is
2490 that we are \inenvironment\thisenv}%
2491 \def\next{\doignore{#1}}%
2498 \def\itemindicate{#1}%
2503 \makevalueexpandable
2504 \edef\temp{\noexpand\tablez #1\space\space\space}%
2508 \def\tablez #1 #2 #3 #4\endtablez{%
2510 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2511 \ifnum 0#2>0 \tableindent=#2\mil \fi
2512 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2513 \itemmax=\tableindent
2514 \advance \itemmax by -\itemmargin
2515 \advance \leftskip by \tableindent
2516 \exdentamount=\tableindent
2518 \parskip = \smallskipamount
2519 \ifdim \parskip=0pt \parskip=2pt \fi
2520 \let\item = \internalBitem
2521 \let\itemx = \internalBitemx
2523 \def\Etable{\endgraf\afterenvbreak}
2526 \let\Eitemize\Etable
2527 \let\Eenumerate\Etable
2529 % This is the counter used by @enumerate, which is really @itemize
2533 \envdef\itemize{\parsearg\doitemize}
2537 \itemmax=\itemindent
2538 \advance\itemmax by -\itemmargin
2539 \advance\leftskip by \itemindent
2540 \exdentamount=\itemindent
2542 \parskip=\smallskipamount
2543 \ifdim\parskip=0pt \parskip=2pt \fi
2544 \def\itemcontents{#1}%
2545 % @itemize with no arg is equivalent to @itemize @bullet.
2546 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2547 \let\item=\itemizeitem
2550 % Definition of @item while inside @itemize and @enumerate.
2553 \advance\itemno by 1 % for enumerations
2554 {\let\par=\endgraf \smallbreak}% reasonable place to break
2556 % If the document has an @itemize directly after a section title, a
2557 % \nobreak will be last on the list, and \sectionheading will have
2558 % done a \vskip-\parskip. In that case, we don't want to zero
2559 % parskip, or the item text will crash with the heading. On the
2560 % other hand, when there is normal text preceding the item (as there
2561 % usually is), we do want to zero parskip, or there would be too much
2562 % space. In that case, we won't have a \nobreak before. At least
2563 % that's the theory.
2564 \ifnum\lastpenalty<10000 \parskip=0in \fi
2566 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2567 \vadjust{\penalty 1200}}% not good to break after first line of item.
2571 % \splitoff TOKENS\endmark defines \first to be the first token in
2572 % TOKENS, and \rest to be the remainder.
2574 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2576 % Allow an optional argument of an uppercase letter, lowercase letter,
2577 % or number, to specify the first label in the enumerated list. No
2578 % argument is the same as `1'.
2580 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2581 \def\enumeratey #1 #2\endenumeratey{%
2582 % If we were given no argument, pretend we were given `1'.
2584 \ifx\thearg\empty \def\thearg{1}\fi
2586 % Detect if the argument is a single token. If so, it might be a
2587 % letter. Otherwise, the only valid thing it can be is a number.
2588 % (We will always have one token, because of the test we just made.
2589 % This is a good thing, since \splitoff doesn't work given nothing at
2590 % all -- the first parameter is undelimited.)
2591 \expandafter\splitoff\thearg\endmark
2593 % Only one token in the argument. It could still be anything.
2594 % A ``lowercase letter'' is one whose \lccode is nonzero.
2595 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2596 % not equal to itself.
2597 % Otherwise, we assume it's a number.
2599 % We need the \relax at the end of the \ifnum lines to stop TeX from
2600 % continuing to look for a <number>.
2602 \ifnum\lccode\expandafter`\thearg=0\relax
2603 \numericenumerate % a number (we hope)
2606 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2607 \lowercaseenumerate % lowercase letter
2609 \uppercaseenumerate % uppercase letter
2613 % Multiple tokens in the argument. We hope it's a number.
2618 % An @enumerate whose labels are integers. The starting integer is
2621 \def\numericenumerate{%
2623 \startenumeration{\the\itemno}%
2626 % The starting (lowercase) letter is in \thearg.
2627 \def\lowercaseenumerate{%
2628 \itemno = \expandafter`\thearg
2630 % Be sure we're not beyond the end of the alphabet.
2632 \errmessage{No more lowercase letters in @enumerate; get a bigger
2639 % The starting (uppercase) letter is in \thearg.
2640 \def\uppercaseenumerate{%
2641 \itemno = \expandafter`\thearg
2643 % Be sure we're not beyond the end of the alphabet.
2645 \errmessage{No more uppercase letters in @enumerate; get a bigger
2652 % Call \doitemize, adding a period to the first argument and supplying the
2653 % common last two arguments. Also subtract one from the initial value in
2654 % \itemno, since @item increments \itemno.
2656 \def\startenumeration#1{%
2657 \advance\itemno by -1
2658 \doitemize{#1.}\flushcr
2661 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2664 \def\alphaenumerate{\enumerate{a}}
2665 \def\capsenumerate{\enumerate{A}}
2666 \def\Ealphaenumerate{\Eenumerate}
2667 \def\Ecapsenumerate{\Eenumerate}
2670 % @multitable macros
2671 % Amy Hendrickson, 8/18/94, 3/6/96
2673 % @multitable ... @end multitable will make as many columns as desired.
2674 % Contents of each column will wrap at width given in preamble. Width
2675 % can be specified either with sample text given in a template line,
2676 % or in percent of \hsize, the current width of text on page.
2678 % Table can continue over pages but will only break between lines.
2682 % Either define widths of columns in terms of percent of \hsize:
2683 % @multitable @columnfractions .25 .3 .45
2686 % Numbers following @columnfractions are the percent of the total
2687 % current hsize to be used for each column. You may use as many
2688 % columns as desired.
2691 % Or use a template:
2692 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2694 % using the widest term desired in each column.
2696 % Each new table line starts with @item, each subsequent new column
2697 % starts with @tab. Empty columns may be produced by supplying @tab's
2698 % with nothing between them for as many times as empty columns are needed,
2699 % ie, @tab@tab@tab will produce two empty columns.
2701 % @item, @tab do not need to be on their own lines, but it will not hurt
2704 % Sample multitable:
2706 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2707 % @item first col stuff @tab second col stuff @tab third col
2714 % @item first col stuff @tab second col stuff
2715 % @tab Many paragraphs of text may be used in any column.
2717 % They will wrap at the width determined by the template.
2718 % @item@tab@tab This will be in third column.
2721 % Default dimensions may be reset by user.
2722 % @multitableparskip is vertical space between paragraphs in table.
2723 % @multitableparindent is paragraph indent in table.
2724 % @multitablecolmargin is horizontal space to be left between columns.
2725 % @multitablelinespace is space to leave between table items, baseline
2727 % 0pt means it depends on current normal line spacing.
2729 \newskip\multitableparskip
2730 \newskip\multitableparindent
2731 \newdimen\multitablecolspace
2732 \newskip\multitablelinespace
2733 \multitableparskip=0pt
2734 \multitableparindent=6pt
2735 \multitablecolspace=12pt
2736 \multitablelinespace=0pt
2738 % Macros used to set up halign preamble:
2740 \let\endsetuptable\relax
2741 \def\xendsetuptable{\endsetuptable}
2742 \let\columnfractions\relax
2743 \def\xcolumnfractions{\columnfractions}
2746 % #1 is the @columnfraction, usually a decimal number like .5, but might
2747 % be just 1. We just use it, whatever it is.
2749 \def\pickupwholefraction#1 {%
2750 \global\advance\colcount by 1
2751 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2758 \ifx\firstarg\xendsetuptable
2761 \ifx\firstarg\xcolumnfractions
2762 \global\setpercenttrue
2765 \let\go\pickupwholefraction
2767 \global\advance\colcount by 1
2768 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2769 % separator; typically that is always in the input, anyway.
2770 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2773 \ifx\go\pickupwholefraction
2774 % Put the argument back for the \pickupwholefraction call, so
2775 % we'll always have a period there to be parsed.
2776 \def\go{\pickupwholefraction#1}%
2778 \let\go = \setuptable
2784 % multitable-only commands.
2786 % @headitem starts a heading row, which we typeset in bold.
2787 % Assignments have to be global since we are inside the implicit group
2788 % of an alignment entry. Note that \everycr resets \everytab.
2789 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2791 % A \tab used to include \hskip1sp. But then the space in a template
2792 % line is not enough. That is bad. So let's go back to just `&' until
2793 % we encounter the problem it was intended to solve again.
2794 % --karl, nathan@acm.org, 20apr99.
2795 \def\tab{\checkenv\multitable &\the\everytab}%
2797 % @multitable ... @end multitable definitions:
2799 \newtoks\everytab % insert after every tab.
2801 \envdef\multitable{%
2805 % @item within a multitable starts a normal row.
2806 % We use \def instead of \let so that if one of the multitable entries
2807 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2808 % \endtemplate) expanding \doitemize.
2813 \setmultitablespacing
2814 \parskip=\multitableparskip
2815 \parindent=\multitableparindent
2821 \global\everytab={}%
2822 \global\colcount=0 % Reset the column counter.
2823 % Check for saved footnotes, etc.
2825 % Keeps underfull box messages off when table breaks over pages.
2827 % Maybe so, but it also creates really weird page breaks when the
2828 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2829 % problem manifests itself, so it can be fixed for real --karl.
2833 \parsearg\domultitable
2835 \def\domultitable#1{%
2836 % To parse everything between @multitable and @item:
2837 \setuptable#1 \endsetuptable
2839 % This preamble sets up a generic column definition, which will
2840 % be used as many times as user calls for columns.
2841 % \vtop will set a single line and will also let text wrap and
2842 % continue for many paragraphs if desired.
2844 \global\advance\colcount by 1
2847 % Use the current \colcount to find the correct column width:
2848 \hsize=\expandafter\csname col\the\colcount\endcsname
2850 % In order to keep entries from bumping into each other
2851 % we will add a \leftskip of \multitablecolspace to all columns after
2854 % If a template has been used, we will add \multitablecolspace
2855 % to the width of each template entry.
2857 % If the user has set preamble in terms of percent of \hsize we will
2858 % use that dimension as the width of the column, and the \leftskip
2859 % will keep entries from bumping into each other. Table will start at
2860 % left margin and final column will justify at right margin.
2862 % Make sure we don't inherit \rightskip from the outer environment.
2865 % The first column will be indented with the surrounding text.
2866 \advance\hsize by\leftskip
2869 % If user has not set preamble in terms of percent of \hsize
2870 % we will advance \hsize by \multitablecolspace.
2871 \advance\hsize by \multitablecolspace
2873 % In either case we will make \leftskip=\multitablecolspace:
2874 \leftskip=\multitablecolspace
2876 % Ignoring space at the beginning and end avoids an occasional spurious
2877 % blank line, when TeX decides to break the line at the space before the
2878 % box from the multistrut, so the strut ends up on a line by itself.
2880 % @multitable @columnfractions .11 .89
2882 % @tab Legal holiday which is valid in major parts of the whole country.
2883 % Is automatically provided with highlighting sequences respectively
2884 % marking characters.
2885 \noindent\ignorespaces##\unskip\multistrut
2890 \egroup % end the \halign
2891 \global\setpercentfalse
2894 \def\setmultitablespacing{%
2895 \def\multistrut{\strut}% just use the standard line spacing
2897 % Compute \multitablelinespace (if not defined by user) for use in
2898 % \multitableparskip calculation. We used define \multistrut based on
2899 % this, but (ironically) that caused the spacing to be off.
2900 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2901 \ifdim\multitablelinespace=0pt
2902 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2903 \global\advance\multitablelinespace by-\ht0
2905 %% Test to see if parskip is larger than space between lines of
2906 %% table. If not, do nothing.
2907 %% If so, set to same dimension as multitablelinespace.
2908 \ifdim\multitableparskip>\multitablelinespace
2909 \global\multitableparskip=\multitablelinespace
2910 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2911 %% than skip between lines in the table.
2913 \ifdim\multitableparskip=0pt
2914 \global\multitableparskip=\multitablelinespace
2915 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2916 %% than skip between lines in the table.
2920 \message{conditionals,}
2922 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2923 % @ifnotxml always succeed. They currently do nothing; we don't
2924 % attempt to check whether the conditionals are properly nested. But we
2925 % have to remember that they are conditionals, so that @end doesn't
2926 % attempt to close an environment group.
2929 \expandafter\let\csname #1\endcsname = \relax
2930 \expandafter\let\csname iscond.#1\endcsname = 1
2933 \makecond{ifnotdocbook}
2934 \makecond{ifnothtml}
2935 \makecond{ifnotinfo}
2936 \makecond{ifnotplaintext}
2939 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2941 \def\direntry{\doignore{direntry}}
2942 \def\documentdescription{\doignore{documentdescription}}
2943 \def\docbook{\doignore{docbook}}
2944 \def\html{\doignore{html}}
2945 \def\ifdocbook{\doignore{ifdocbook}}
2946 \def\ifhtml{\doignore{ifhtml}}
2947 \def\ifinfo{\doignore{ifinfo}}
2948 \def\ifnottex{\doignore{ifnottex}}
2949 \def\ifplaintext{\doignore{ifplaintext}}
2950 \def\ifxml{\doignore{ifxml}}
2951 \def\ignore{\doignore{ignore}}
2952 \def\menu{\doignore{menu}}
2953 \def\xml{\doignore{xml}}
2955 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2957 % A count to remember the depth of nesting.
2958 \newcount\doignorecount
2960 \def\doignore#1{\begingroup
2961 % Scan in ``verbatim'' mode:
2962 \catcode`\@ = \other
2963 \catcode`\{ = \other
2964 \catcode`\} = \other
2966 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2969 % Count number of #1's that we've seen.
2972 % Swallow text until we reach the matching `@end #1'.
2976 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2979 \gdef\dodoignore#1{%
2980 % #1 contains the command name as a string, e.g., `ifinfo'.
2982 % Define a command to find the next `@end #1', which must be on a line
2984 \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2985 % And this command to find another #1 command, at the beginning of a
2986 % line. (Otherwise, we would consider a line `@c @ifset', for
2987 % example, to count as an @ifset for nesting.)
2988 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2990 % And now expand that command.
2996 \def\doignoreyyy#1{%
2998 \ifx\temp\empty % Nothing found.
2999 \let\next\doignoretextzzz
3000 \else % Found a nested condition, ...
3001 \advance\doignorecount by 1
3002 \let\next\doignoretextyyy % ..., look for another.
3003 % If we're here, #1 ends with ^^M\ifinfo (for example).
3005 \next #1% the token \_STOP_ is present just after this macro.
3008 % We have to swallow the remaining "\_STOP_".
3010 \def\doignoretextzzz#1{%
3011 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3012 \let\next\enddoignore
3013 \else % Still inside a nested condition.
3014 \advance\doignorecount by -1
3015 \let\next\doignoretext % Look for the next @end.
3020 % Finish off ignored text.
3021 \def\enddoignore{\endgroup\ignorespaces}
3024 % @set VAR sets the variable VAR to an empty value.
3025 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3027 % Since we want to separate VAR from REST-OF-LINE (which might be
3028 % empty), we can't just use \parsearg; we have to insert a space of our
3029 % own to delimit the rest of the line, and then take it out again if we
3031 % We rely on the fact that \parsearg sets \catcode`\ =10.
3033 \parseargdef\set{\setyyy#1 \endsetyyy}
3034 \def\setyyy#1 #2\endsetyyy{%
3036 \makevalueexpandable
3038 \edef\next{\gdef\makecsname{SET#1}}%
3046 % Remove the trailing space \setxxx inserted.
3047 \def\setzzz#1 \endsetzzz{\next{#1}}
3049 % @clear VAR clears (i.e., unsets) the variable VAR.
3051 \parseargdef\clear{%
3053 \makevalueexpandable
3054 \global\expandafter\let\csname SET#1\endcsname=\relax
3058 % @value{foo} gets the text saved in variable foo.
3059 \def\value{\begingroup\makevalueexpandable\valuexxx}
3060 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3062 \catcode`\- = \active \catcode`\_ = \active
3064 \gdef\makevalueexpandable{%
3065 \let\value = \expandablevalue
3066 % We don't want these characters active, ...
3067 \catcode`\-=\other \catcode`\_=\other
3068 % ..., but we might end up with active ones in the argument if
3069 % we're called from @code, as @code{@value{foo-bar_}}, though.
3070 % So \let them to their normal equivalents.
3071 \let-\realdash \let_\normalunderscore
3075 % We have this subroutine so that we can handle at least some @value's
3076 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3077 % The command has to be fully expandable (if the variable is set), since
3078 % the result winds up in the index file. This means that if the
3079 % variable's value contains other Texinfo commands, it's almost certain
3080 % it will fail (although perhaps we could fix that with sufficient work
3081 % to do a one-level expansion on the result, instead of complete).
3083 \def\expandablevalue#1{%
3084 \expandafter\ifx\csname SET#1\endcsname\relax
3085 {[No value for ``#1'']}%
3086 \message{Variable `#1', used in @value, is not set.}%
3088 \csname SET#1\endcsname
3092 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3095 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3098 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3101 \makevalueexpandable
3103 \expandafter\ifx\csname SET#2\endcsname\relax
3104 #1% If not set, redefine \next.
3109 \def\ifsetfail{\doignore{ifset}}
3111 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3112 % defined with @set, or has been undefined with @clear.
3114 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3115 % above code: if the variable is not set, do nothing, if it is set,
3116 % then redefine \next to \ifclearfail.
3119 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3120 \def\ifclearfail{\doignore{ifclear}}
3122 % @dircategory CATEGORY -- specify a category of the dir file
3123 % which this file should belong to. Ignore this in TeX.
3124 \let\dircategory=\comment
3126 % @defininfoenclose.
3127 \let\definfoenclose=\comment
3131 % Index generation facilities
3133 % Define \newwrite to be identical to plain tex's \newwrite
3134 % except not \outer, so it can be used within macros and \if's.
3135 \edef\newwrite{\makecsname{ptexnewwrite}}
3137 % \newindex {foo} defines an index named foo.
3138 % It automatically defines \fooindex such that
3139 % \fooindex ...rest of line... puts an entry in the index foo.
3140 % It also defines \fooindfile to be the number of the output channel for
3141 % the file that accumulates this index. The file's extension is foo.
3142 % The name of an index should be no more than 2 characters long
3143 % for the sake of vms.
3147 \expandafter\newwrite \csname#1indfile\endcsname
3148 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3150 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3151 \noexpand\doindex{#1}}
3154 % @defindex foo == \newindex{foo}
3156 \def\defindex{\parsearg\newindex}
3158 % Define @defcodeindex, like @defindex except put all entries in @code.
3160 \def\defcodeindex{\parsearg\newcodeindex}
3162 \def\newcodeindex#1{%
3164 \expandafter\newwrite \csname#1indfile\endcsname
3165 \openout \csname#1indfile\endcsname \jobname.#1
3167 \expandafter\xdef\csname#1index\endcsname{%
3168 \noexpand\docodeindex{#1}}%
3172 % @synindex foo bar makes index foo feed into index bar.
3173 % Do this instead of @defindex foo if you don't want it as a separate index.
3175 % @syncodeindex foo bar similar, but put all entries made for index foo
3178 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3179 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3181 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3182 % #3 the target index (bar).
3183 \def\dosynindex#1#2#3{%
3184 % Only do \closeout if we haven't already done it, else we'll end up
3185 % closing the target index.
3186 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3187 % The \closeout helps reduce unnecessary open files; the limit on the
3188 % Acorn RISC OS is a mere 16 files.
3189 \expandafter\closeout\csname#2indfile\endcsname
3190 \expandafter\let\csname\donesynindex#2\endcsname = 1
3192 % redefine \fooindfile:
3193 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3194 \expandafter\let\csname#2indfile\endcsname=\temp
3195 % redefine \fooindex:
3196 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3199 % Define \doindex, the driver for all \fooindex macros.
3200 % Argument #1 is generated by the calling \fooindex macro,
3201 % and it is "foo", the name of the index.
3203 % \doindex just uses \parsearg; it calls \doind for the actual work.
3204 % This is because \doind is more useful to call from other macros.
3206 % There is also \dosubind {index}{topic}{subtopic}
3207 % which makes an entry in a two-level index such as the operation index.
3209 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3210 \def\singleindexer #1{\doind{\indexname}{#1}}
3212 % like the previous two, but they put @code around the argument.
3213 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3214 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3216 % Take care of Texinfo commands that can appear in an index entry.
3217 % Since there are some commands we want to expand, and others we don't,
3218 % we have to laboriously prevent expansion for those that we don't.
3221 \escapechar = `\\ % use backslash in output files.
3222 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3223 \def\ {\realbackslash\space }%
3224 % Need these in case \tex is in effect and \{ is a \delimiter again.
3225 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3226 % braces and backslashes are used only as delimiters.
3230 % Do the redefinitions.
3234 % For the aux and toc files, @ is the escape character. So we want to
3235 % redefine everything using @ as the escape character (instead of
3236 % \realbackslash, still used for index files). When everything uses @,
3237 % this will be simpler.
3242 \let\{ = \lbraceatcmd
3243 \let\} = \rbraceatcmd
3245 % Do the redefinitions.
3249 % Called from \indexdummies and \atdummies.
3251 \def\commondummies{%
3253 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3254 % preventing its expansion. This is used only for control% words,
3255 % not control letters, because the \space would be incorrect for
3256 % control characters, but is needed to separate the control word
3257 % from whatever follows.
3259 % For control letters, we have \definedummyletter, which omits the
3262 % These can be used both for control words that take an argument and
3263 % those that do not. If it is followed by {arg} in the input, then
3264 % that will dutifully get written to the index (or wherever).
3266 \def\definedummyword ##1{\def##1{\string##1\space}}%
3267 \def\definedummyletter##1{\def##1{\string##1}}%
3268 \let\definedummyaccent\definedummyletter
3270 \commondummiesnofonts
3272 \definedummyletter\_%
3274 % Non-English letters.
3286 \definedummyword\exclamdown
3287 \definedummyword\questiondown
3288 \definedummyword\ordf
3289 \definedummyword\ordm
3291 % Although these internal commands shouldn't show up, sometimes they do.
3293 \definedummyword\gtr
3294 \definedummyword\hat
3295 \definedummyword\less
3298 \definedummyword\tclose
3301 \definedummyword\LaTeX
3302 \definedummyword\TeX
3304 % Assorted special characters.
3305 \definedummyword\bullet
3306 \definedummyword\comma
3307 \definedummyword\copyright
3308 \definedummyword\registeredsymbol
3309 \definedummyword\dots
3310 \definedummyword\enddots
3311 \definedummyword\equiv
3312 \definedummyword\error
3313 \definedummyword\euro
3314 \definedummyword\expansion
3315 \definedummyword\minus
3316 \definedummyword\pounds
3317 \definedummyword\point
3318 \definedummyword\print
3319 \definedummyword\result
3321 % We want to disable all macros so that they are not expanded by \write.
3324 \normalturnoffactive
3326 % Handle some cases of @value -- where it does not contain any
3327 % (non-fully-expandable) commands.
3328 \makevalueexpandable
3331 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3333 % Better have this without active chars.
3336 \gdef\commondummiesnofonts{%
3337 % Control letters and accents.
3338 \definedummyletter\!%
3339 \definedummyaccent\"%
3340 \definedummyaccent\'%
3341 \definedummyletter\*%
3342 \definedummyaccent\,%
3343 \definedummyletter\.%
3344 \definedummyletter\/%
3345 \definedummyletter\:%
3346 \definedummyaccent\=%
3347 \definedummyletter\?%
3348 \definedummyaccent\^%
3349 \definedummyaccent\`%
3350 \definedummyaccent\~%
3354 \definedummyword\dotaccent
3355 \definedummyword\ringaccent
3356 \definedummyword\tieaccent
3357 \definedummyword\ubaraccent
3358 \definedummyword\udotaccent
3359 \definedummyword\dotless
3361 % Texinfo font commands.
3368 % Commands that take arguments.
3369 \definedummyword\acronym
3370 \definedummyword\cite
3371 \definedummyword\code
3372 \definedummyword\command
3373 \definedummyword\dfn
3374 \definedummyword\emph
3375 \definedummyword\env
3376 \definedummyword\file
3377 \definedummyword\kbd
3378 \definedummyword\key
3379 \definedummyword\math
3380 \definedummyword\option
3381 \definedummyword\pxref
3382 \definedummyword\ref
3383 \definedummyword\samp
3384 \definedummyword\strong
3385 \definedummyword\tie
3386 \definedummyword\uref
3387 \definedummyword\url
3388 \definedummyword\var
3389 \definedummyword\verb
3391 \definedummyword\xref
3395 % \indexnofonts is used when outputting the strings to sort the index
3396 % by, and when constructing control sequence names. It eliminates all
3397 % control sequences and just writes whatever the best ASCII sort string
3398 % would be for a given command (usually its argument).
3401 % Accent commands should become @asis.
3402 \def\definedummyaccent##1{\let##1\asis}%
3403 % We can just ignore other control letters.
3404 \def\definedummyletter##1{\let##1\empty}%
3405 % Hopefully, all control words can become @asis.
3406 \let\definedummyword\definedummyaccent
3408 \commondummiesnofonts
3410 % Don't no-op \tt, since it isn't a user-level command
3411 % and is used in the definitions of the active chars like <, >, |, etc.
3412 % Likewise with the other plain tex font commands.
3417 % how to handle braces?
3418 \def\_{\normalunderscore}%
3420 % Non-English letters.
3433 \def\questiondown{?}%
3440 % Assorted special characters.
3441 % (The following {} will end up in the sort string, but that's ok.)
3442 \def\bullet{bullet}%
3444 \def\copyright{copyright}%
3445 \def\registeredsymbol{R}%
3451 \def\expansion{==>}%
3453 \def\pounds{pounds}%
3458 % We need to get rid of all macros, leaving only the arguments (if present).
3459 % Of course this is not nearly correct, but it is the best we can do for now.
3460 % makeinfo does not expand macros in the argument to @deffn, which ends up
3461 % writing an index entry, and texindex isn't prepared for an index sort entry
3462 % that starts with \.
3464 % Since macro invocations are followed by braces, we can just redefine them
3465 % to take a single TeX argument. The case of a macro invocation that
3466 % goes to end-of-line is not handled.
3471 \let\indexbackslash=0 %overridden during \printindex.
3472 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3474 % Most index entries go through here, but \dosubind is the general case.
3475 % #1 is the index name, #2 is the entry text.
3476 \def\doind#1#2{\dosubind{#1}{#2}{}}
3478 % Workhorse for all \fooindexes.
3479 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3480 % empty if called from \doind, as we usually are (the main exception
3481 % is with most defuns, which call us directly).
3483 \def\dosubind#1#2#3{%
3486 % Store the main index entry text (including the third arg).
3488 % If third arg is present, precede it with a space.
3490 \ifx\thirdarg\empty \else
3491 \toks0 = \expandafter{\the\toks0 \space #3}%
3494 \edef\writeto{\csname#1indfile\endcsname}%
3505 % Write the entry in \toks0 to the index file:
3507 \def\dosubindwrite{%
3508 % Put the index entry in the margin if desired.
3509 \ifx\SETmarginindex\relax\else
3510 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3513 % Remember, we are within a group.
3514 \indexdummies % Must do this here, since \bf, etc expand at this stage
3515 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3516 % so it will be output as is; and it will print as backslash.
3518 % Process the index entry with all font commands turned off, to
3519 % get the string to sort by.
3521 \edef\temp{\the\toks0}% need full expansion
3522 \xdef\indexsorttmp{\temp}%
3525 % Set up the complete index entry, with both the sort key and
3526 % the original text, including any font commands. We write
3527 % three arguments to \entry to the .?? file (four in the
3528 % subentry case), texindex reduces to two when writing the .??s
3532 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3537 % Take care of unwanted page breaks:
3539 % If a skip is the last thing on the list now, preserve it
3540 % by backing up by \lastskip, doing the \write, then inserting
3541 % the skip again. Otherwise, the whatsit generated by the
3542 % \write will make \lastskip zero. The result is that sequences
3547 % will have extra space inserted, because the \medbreak in the
3548 % start of the @defun won't see the skip inserted by the @end of
3549 % the previous defun.
3551 % But don't do any of this if we're not in vertical mode. We
3552 % don't want to do a \vskip and prematurely end a paragraph.
3554 % Avoid page breaks due to these extra skips, too.
3556 % But wait, there is a catch there:
3557 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3558 % sufficient for this purpose, as it ignores stretch and shrink parts
3559 % of the skip. The only way seems to be to check the textual
3560 % representation of the skip.
3562 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3563 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3565 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3569 \def\dosubindsanitize{%
3570 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3572 \edef\lastskipmacro{\the\lastskip}%
3573 \count255 = \lastpenalty
3575 % If \lastskip is nonzero, that means the last item was a
3576 % skip. And since a skip is discardable, that means this
3577 % -\skip0 glue we're inserting is preceded by a
3578 % non-discardable item, therefore it is not a potential
3579 % breakpoint, therefore no \nobreak needed.
3580 \ifx\lastskipmacro\zeroskipmacro
3587 \ifx\lastskipmacro\zeroskipmacro
3588 % If \lastskip was zero, perhaps the last item was a penalty, and
3589 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3590 % to re-insert the same penalty (values >10000 are used for various
3591 % signals); since we just inserted a non-discardable item, any
3592 % following glue (such as a \parskip) would be a breakpoint. For example:
3594 % @deffn deffn-whatever
3595 % @vindex index-whatever
3597 % would allow a break between the index-whatever whatsit
3598 % and the "Description." paragraph.
3599 \ifnum\count255>9999 \penalty\count255 \fi
3601 % On the other hand, if we had a nonzero \lastskip,
3602 % this make-up glue would be preceded by a non-discardable item
3603 % (the whatsit from the \write), so we must insert a \nobreak.
3604 \nobreak\vskip\skip0
3608 % The index entry written in the file actually looks like
3609 % \entry {sortstring}{page}{topic}
3611 % \entry {sortstring}{page}{topic}{subtopic}
3612 % The texindex program reads in these files and writes files
3613 % containing these kinds of lines:
3615 % before the first topic whose initial is c
3616 % \entry {topic}{pagelist}
3617 % for a topic that is used without subtopics
3619 % for the beginning of a topic that is used with subtopics
3620 % \secondary {subtopic}{pagelist}
3621 % for each subtopic.
3623 % Define the user-accessible indexing commands
3624 % @findex, @vindex, @kindex, @cindex.
3626 \def\findex {\fnindex}
3627 \def\kindex {\kyindex}
3628 \def\cindex {\cpindex}
3629 \def\vindex {\vrindex}
3630 \def\tindex {\tpindex}
3631 \def\pindex {\pgindex}
3633 \def\cindexsub {\begingroup\obeylines\cindexsub}
3635 \gdef\cindexsub "#1" #2^^M{\endgroup %
3636 \dosubind{cp}{#2}{#1}}}
3638 % Define the macros used in formatting output of the sorted index material.
3640 % @printindex causes a particular index (the ??s file) to get printed.
3641 % It does not print any chapter heading (usually an @unnumbered).
3643 \parseargdef\printindex{\begingroup
3644 \dobreak \chapheadingskip{10000}%
3648 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3650 % See if the index file exists and is nonempty.
3651 % Change catcode of @ here so that if the index file contains
3653 % as its first line, TeX doesn't complain about mismatched braces
3654 % (because it thinks @} is a control sequence).
3656 \openin 1 \jobname.#1s
3658 % \enddoublecolumns gets confused if there is no text in the index,
3659 % and it loses the chapter title and the aux file entries for the
3660 % index. The easiest way to prevent this problem is to make sure
3661 % there is some text.
3662 \putwordIndexNonexistent
3665 % If the index file exists but is empty, then \openin leaves \ifeof
3666 % false. We have to make TeX try to read something from the file, so
3667 % it can discover if there is anything in it.
3670 \putwordIndexIsEmpty
3672 % Index files are almost Texinfo source, but we use \ as the escape
3673 % character. It would be better to use @, but that's too big a change
3674 % to make right now.
3675 \def\indexbackslash{\backslashcurfont}%
3686 % These macros are used by the sorted index file itself.
3687 % Change them to control the appearance of the index.
3690 % Some minor font changes for the special characters.
3691 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3693 % Remove any glue we may have, we'll be inserting our own.
3696 % We like breaks before the index initials, so insert a bonus.
3698 \vskip 0pt plus 3\baselineskip
3700 \vskip 0pt plus -3\baselineskip
3702 % Typeset the initial. Making this add up to a whole number of
3703 % baselineskips increases the chance of the dots lining up from column
3704 % to column. It still won't often be perfect, because of the stretch
3705 % we need before each entry, but it's better.
3707 % No shrink because it confuses \balancecolumns.
3708 \vskip 1.67\baselineskip plus .5\baselineskip
3709 \leftline{\secbf #1}%
3710 % Do our best not to break after the initial.
3712 \vskip .33\baselineskip plus .1\baselineskip
3715 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3716 % then page number (#2) flushed to the right margin. It is used for index
3717 % and table of contents entries. The paragraph is indented by \leftskip.
3719 % A straightforward implementation would start like this:
3720 % \def\entry#1#2{...
3721 % But this frozes the catcodes in the argument, and can cause problems to
3722 % @code, which sets - active. This problem was fixed by a kludge---
3723 % ``-'' was active throughout whole index, but this isn't really right.
3725 % The right solution is to prevent \entry from swallowing the whole text.
3730 % Start a new paragraph if necessary, so our assignments below can't
3731 % affect previous text.
3734 % Do not fill out the last line with white space.
3737 % No extra space above this paragraph.
3740 % Do not prefer a separate line ending with a hyphen to fewer lines.
3741 \finalhyphendemerits = 0
3743 % \hangindent is only relevant when the entry text and page number
3744 % don't both fit on one line. In that case, bob suggests starting the
3745 % dots pretty far over on the line. Unfortunately, a large
3746 % indentation looks wrong when the entry text itself is broken across
3747 % lines. So we use a small indentation and put up with long leaders.
3749 % \hangafter is reset to 1 (which is the value we want) at the start
3750 % of each paragraph, so we need not do anything with that.
3753 % When the entry text needs to be broken, just fill out the first line
3755 \rightskip = 0pt plus1fil
3757 % A bit of stretch before each entry for the benefit of balancing
3761 % Swallow the left brace of the text (first parameter):
3762 \afterassignment\doentry
3766 \bgroup % Instead of the swallowed brace.
3768 \aftergroup\finishentry
3769 % And now comes the text of the entry.
3771 \def\finishentry#1{%
3772 % #1 is the page number.
3774 % The following is kludged to not output a line of dots in the index if
3775 % there are no page numbers. The next person who breaks this will be
3776 % cursed by a Unix daemon.
3779 \edef\tempc{\tempa}%
3780 \edef\tempd{\tempb}%
3785 % If we must, put the page number on a line of its own, and fill out
3786 % this line with blank space. (The \hfil is overwhelmed with the
3787 % fill leaders glue in \indexdotfill if the page number does fit.)
3789 \null\nobreak\indexdotfill % Have leaders before the page number.
3791 % The `\ ' here is removed by the implicit \unskip that TeX does as
3792 % part of (the primitive) \par. Without it, a spurious underfull
3805 % Like \dotfill except takes at least 1 em.
3806 \def\indexdotfill{\cleaders
3807 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3809 \def\primary #1{\line{#1\hfil}}
3811 \newskip\secondaryindent \secondaryindent=0.5cm
3812 \def\secondary#1#2{{%
3817 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3819 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3826 % Define two-column mode, which we use to typeset indexes.
3827 % Adapted from the TeXbook, page 416, which is to say,
3828 % the manmac.tex format used to print the TeXbook itself.
3832 \newdimen\doublecolumnhsize
3834 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3835 % Grab any single-column material above us.
3838 % Here is a possibility not foreseen in manmac: if we accumulate a
3839 % whole lot of material, we might end up calling this \output
3840 % routine twice in a row (see the doublecol-lose test, which is
3841 % essentially a couple of indexes with @setchapternewpage off). In
3842 % that case we just ship out what is in \partialpage with the normal
3843 % output routine. Generally, \partialpage will be empty when this
3844 % runs and this will be a no-op. See the indexspread.tex test case.
3845 \ifvoid\partialpage \else
3846 \onepageout{\pagecontents\partialpage}%
3849 \global\setbox\partialpage = \vbox{%
3850 % Unvbox the main output page.
3852 \kern-\topskip \kern\baselineskip
3855 \eject % run that output routine to set \partialpage
3857 % Use the double-column output routine for subsequent pages.
3858 \output = {\doublecolumnout}%
3860 % Change the page size parameters. We could do this once outside this
3861 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3862 % format, but then we repeat the same computation. Repeating a couple
3863 % of assignments once per index is clearly meaningless for the
3864 % execution time, so we may as well do it in one place.
3866 % First we halve the line length, less a little for the gutter between
3867 % the columns. We compute the gutter based on the line length, so it
3868 % changes automatically with the paper format. The magic constant
3869 % below is chosen so that the gutter has the same value (well, +-<1pt)
3870 % as it did when we hard-coded it.
3872 % We put the result in a separate register, \doublecolumhsize, so we
3873 % can restore it in \pagesofar, after \hsize itself has (potentially)
3876 \doublecolumnhsize = \hsize
3877 \advance\doublecolumnhsize by -.04154\hsize
3878 \divide\doublecolumnhsize by 2
3879 \hsize = \doublecolumnhsize
3881 % Double the \vsize as well. (We don't need a separate register here,
3882 % since nobody clobbers \vsize.)
3886 % The double-column output routine for all double-column pages except
3889 \def\doublecolumnout{%
3890 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3891 % Get the available space for the double columns -- the normal
3892 % (undoubled) page height minus any material left over from the
3896 \advance\dimen@ by -\ht\partialpage
3898 % box0 will be the left-hand column, box2 the right.
3899 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3900 \onepageout\pagesofar
3902 \penalty\outputpenalty
3905 % Re-output the contents of the output page -- any previous material,
3906 % followed by the two boxes we just split, in box0 and box2.
3910 \hsize = \doublecolumnhsize
3911 \wd0=\hsize \wd2=\hsize
3912 \hbox to\pagewidth{\box0\hfil\box2}%
3915 % All done with double columns.
3916 \def\enddoublecolumns{%
3918 % Split the last of the double-column material. Leave it on the
3919 % current page, no automatic page break.
3922 % If we end up splitting too much material for the current page,
3923 % though, there will be another page break right after this \output
3924 % invocation ends. Having called \balancecolumns once, we do not
3925 % want to call it again. Therefore, reset \output to its normal
3926 % definition right away. (We hope \balancecolumns will never be
3927 % called on to balance too much material, but if it is, this makes
3928 % the output somewhat more palatable.)
3929 \global\output = {\onepageout{\pagecontents\PAGE}}%
3932 \endgroup % started in \begindoublecolumns
3934 % \pagegoal was set to the doubled \vsize above, since we restarted
3935 % the current page. We're now back to normal single-column
3936 % typesetting, so reset \pagegoal to the normal \vsize (after the
3937 % \endgroup where \vsize got restored).
3941 % Called at the end of the double column material.
3942 \def\balancecolumns{%
3943 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3945 \advance\dimen@ by \topskip
3946 \advance\dimen@ by-\baselineskip
3947 \divide\dimen@ by 2 % target to split to
3948 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3949 \splittopskip = \topskip
3950 % Loop until we get a decent breakpoint.
3954 \global\setbox3 = \copy0
3955 \global\setbox1 = \vsplit3 to \dimen@
3957 \global\advance\dimen@ by 1pt
3960 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3961 \setbox0=\vbox to\dimen@{\unvbox1}%
3962 \setbox2=\vbox to\dimen@{\unvbox3}%
3966 \catcode`\@ = \other
3969 \message{sectioning,}
3970 % Chapters, sections, etc.
3972 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3973 % sections so that we can refer to them unambiguously in the pdf
3974 % outlines by their "section number". We avoid collisions with chapter
3975 % numbers by starting them at 10000. (If a document ever has 10000
3976 % chapters, we're in trouble anyway, I'm sure.)
3977 \newcount\unnumberedno \unnumberedno = 10000
3979 \newcount\secno \secno=0
3980 \newcount\subsecno \subsecno=0
3981 \newcount\subsubsecno \subsubsecno=0
3983 % This counter is funny since it counts through charcodes of letters A, B, ...
3984 \newcount\appendixno \appendixno = `\@
3986 % \def\appendixletter{\char\the\appendixno}
3987 % We do the following ugly conditional instead of the above simple
3988 % construct for the sake of pdftex, which needs the actual
3989 % letter in the expansion, not just typeset.
3991 \def\appendixletter{%
3992 \ifnum\appendixno=`A A%
3993 \else\ifnum\appendixno=`B B%
3994 \else\ifnum\appendixno=`C C%
3995 \else\ifnum\appendixno=`D D%
3996 \else\ifnum\appendixno=`E E%
3997 \else\ifnum\appendixno=`F F%
3998 \else\ifnum\appendixno=`G G%
3999 \else\ifnum\appendixno=`H H%
4000 \else\ifnum\appendixno=`I I%
4001 \else\ifnum\appendixno=`J J%
4002 \else\ifnum\appendixno=`K K%
4003 \else\ifnum\appendixno=`L L%
4004 \else\ifnum\appendixno=`M M%
4005 \else\ifnum\appendixno=`N N%
4006 \else\ifnum\appendixno=`O O%
4007 \else\ifnum\appendixno=`P P%
4008 \else\ifnum\appendixno=`Q Q%
4009 \else\ifnum\appendixno=`R R%
4010 \else\ifnum\appendixno=`S S%
4011 \else\ifnum\appendixno=`T T%
4012 \else\ifnum\appendixno=`U U%
4013 \else\ifnum\appendixno=`V V%
4014 \else\ifnum\appendixno=`W W%
4015 \else\ifnum\appendixno=`X X%
4016 \else\ifnum\appendixno=`Y Y%
4017 \else\ifnum\appendixno=`Z Z%
4018 % The \the is necessary, despite appearances, because \appendixletter is
4019 % expanded while writing the .toc file. \char\appendixno is not
4020 % expandable, thus it is written literally, thus all appendixes come out
4021 % with the same letter (or @) in the toc without it.
4022 \else\char\the\appendixno
4023 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4024 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4026 % Each @chapter defines this as the name of the chapter.
4027 % page headings and footings can use it. @section does likewise.
4028 % However, they are not reliable, because we don't use marks.
4032 \newcount\absseclevel % used to calculate proper heading level
4033 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4035 % @raisesections: treat @section as chapter, @subsection as section, etc.
4036 \def\raisesections{\global\advance\secbase by -1}
4037 \let\up=\raisesections % original BFox name
4039 % @lowersections: treat @chapter as section, @section as subsection, etc.
4040 \def\lowersections{\global\advance\secbase by 1}
4041 \let\down=\lowersections % original BFox name
4043 % we only have subsub.
4044 \chardef\maxseclevel = 3
4046 % A numbered section within an unnumbered changes to unnumbered too.
4047 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4048 \chardef\unmlevel = \maxseclevel
4050 % Trace whether the current chapter is an appendix or not:
4051 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4052 \def\chapheadtype{N}
4054 % Choose a heading macro
4055 % #1 is heading type
4056 % #2 is heading level
4057 % #3 is text for heading
4058 \def\genhead#1#2#3{%
4059 % Compute the abs. sec. level:
4061 \advance\absseclevel by \secbase
4062 % Make sure \absseclevel doesn't fall outside the range:
4063 \ifnum \absseclevel < 0
4066 \ifnum \absseclevel > 3
4073 \ifnum \absseclevel < \unmlevel
4074 \chardef\unmlevel = \absseclevel
4077 % Check for appendix sections:
4078 \ifnum \absseclevel = 0
4079 \edef\chapheadtype{\headtype}%
4081 \if \headtype A\if \chapheadtype N%
4082 \errmessage{@appendix... within a non-appendix chapter}%
4085 % Check for numbered within unnumbered:
4086 \ifnum \absseclevel > \unmlevel
4089 \chardef\unmlevel = 3
4092 % Now print the heading:
4096 \or \unnumberedseczzz{#3}%
4097 \or \unnumberedsubseczzz{#3}%
4098 \or \unnumberedsubsubseczzz{#3}%
4104 \or \appendixsectionzzz{#3}%
4105 \or \appendixsubseczzz{#3}%
4106 \or \appendixsubsubseczzz{#3}%
4112 \or \numberedsubseczzz{#3}%
4113 \or \numberedsubsubseczzz{#3}%
4117 \suppressfirstparagraphindent
4121 \def\numhead{\genhead N}
4122 \def\apphead{\genhead A}
4123 \def\unnmhead{\genhead U}
4125 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4126 % all lower-level sectioning counters to zero.
4128 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4129 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4130 \let\chaplevelprefix = \empty
4132 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4134 % section resetting is \global in case the chapter is in a group, such
4135 % as an @include file.
4136 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4137 \global\advance\chapno by 1
4140 \gdef\chaplevelprefix{\the\chapno.}%
4143 \message{\putwordChapter\space \the\chapno}%
4145 % Write the actual heading.
4146 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4148 % So @section and the like are numbered underneath this chapter.
4149 \global\let\section = \numberedsec
4150 \global\let\subsection = \numberedsubsec
4151 \global\let\subsubsection = \numberedsubsubsec
4154 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4155 \def\appendixzzz#1{%
4156 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4157 \global\advance\appendixno by 1
4158 \gdef\chaplevelprefix{\appendixletter.}%
4161 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4162 \message{\appendixnum}%
4164 \chapmacro{#1}{Yappendix}{\appendixletter}%
4166 \global\let\section = \appendixsec
4167 \global\let\subsection = \appendixsubsec
4168 \global\let\subsubsection = \appendixsubsubsec
4171 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4172 \def\unnumberedzzz#1{%
4173 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4174 \global\advance\unnumberedno by 1
4176 % Since an unnumbered has no number, no prefix for figures.
4177 \global\let\chaplevelprefix = \empty
4180 % This used to be simply \message{#1}, but TeX fully expands the
4181 % argument to \message. Therefore, if #1 contained @-commands, TeX
4182 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4183 % expanded @cite (which turns out to cause errors because \cite is meant
4184 % to be executed, not expanded).
4186 % Anyway, we don't want the fully-expanded definition of @cite to appear
4187 % as a result of the \message, we just want `@cite' itself. We use
4188 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4189 % simply yielding the contents of <toks register>. (We also do this for
4192 \message{(\the\toks0)}%
4194 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4196 \global\let\section = \unnumberedsec
4197 \global\let\subsection = \unnumberedsubsec
4198 \global\let\subsubsection = \unnumberedsubsubsec
4201 % @centerchap is like @unnumbered, but the heading is centered.
4202 \outer\parseargdef\centerchap{%
4203 % Well, we could do the following in a group, but that would break
4204 % an assumption that \chapmacro is called at the outermost level.
4205 % Thus we are safer this way: --kasal, 24feb04
4206 \let\centerparametersmaybe = \centerparameters
4208 \let\centerparametersmaybe = \relax
4211 % @top is like @unnumbered.
4215 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4217 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4218 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4221 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4222 \def\appendixsectionzzz#1{%
4223 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4224 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4226 \let\appendixsec\appendixsection
4228 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4229 \def\unnumberedseczzz#1{%
4230 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4231 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4235 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4236 \def\numberedsubseczzz#1{%
4237 \global\subsubsecno=0 \global\advance\subsecno by 1
4238 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4241 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4242 \def\appendixsubseczzz#1{%
4243 \global\subsubsecno=0 \global\advance\subsecno by 1
4244 \sectionheading{#1}{subsec}{Yappendix}%
4245 {\appendixletter.\the\secno.\the\subsecno}%
4248 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4249 \def\unnumberedsubseczzz#1{%
4250 \global\subsubsecno=0 \global\advance\subsecno by 1
4251 \sectionheading{#1}{subsec}{Ynothing}%
4252 {\the\unnumberedno.\the\secno.\the\subsecno}%
4256 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4257 \def\numberedsubsubseczzz#1{%
4258 \global\advance\subsubsecno by 1
4259 \sectionheading{#1}{subsubsec}{Ynumbered}%
4260 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4263 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4264 \def\appendixsubsubseczzz#1{%
4265 \global\advance\subsubsecno by 1
4266 \sectionheading{#1}{subsubsec}{Yappendix}%
4267 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4270 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4271 \def\unnumberedsubsubseczzz#1{%
4272 \global\advance\subsubsecno by 1
4273 \sectionheading{#1}{subsubsec}{Ynothing}%
4274 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4277 % These macros control what the section commands do, according
4278 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4279 % Define them by default for a numbered chapter.
4280 \let\section = \numberedsec
4281 \let\subsection = \numberedsubsec
4282 \let\subsubsection = \numberedsubsubsec
4284 % Define @majorheading, @heading and @subheading
4286 % NOTE on use of \vbox for chapter headings, section headings, and such:
4287 % 1) We use \vbox rather than the earlier \line to permit
4288 % overlong headings to fold.
4289 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4290 % heading is obnoxious; this forbids it.
4291 % 3) Likewise, headings look best if no \parindent is used, and
4292 % if justification is not attempted. Hence \raggedright.
4296 {\advance\chapheadingskip by 10pt \chapbreak }%
4297 \parsearg\chapheadingzzz
4300 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4301 \def\chapheadingzzz#1{%
4302 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4303 \parindent=0pt\raggedright
4305 \bigskip \par\penalty 200\relax
4306 \suppressfirstparagraphindent
4309 % @heading, @subheading, @subsubheading.
4310 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4311 \suppressfirstparagraphindent}
4312 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4313 \suppressfirstparagraphindent}
4314 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4315 \suppressfirstparagraphindent}
4317 % These macros generate a chapter, section, etc. heading only
4318 % (including whitespace, linebreaking, etc. around it),
4319 % given all the information in convenient, parsed form.
4321 %%% Args are the skip and penalty (usually negative)
4322 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4324 %%% Define plain chapter starts, and page on/off switching for it
4325 % Parameter controlling skip before chapter headings (if needed)
4327 \newskip\chapheadingskip
4329 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4330 \def\chappager{\par\vfill\supereject}
4331 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4333 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4336 \global\let\contentsalignmacro = \chappager
4337 \global\let\pchapsepmacro=\chapbreak
4338 \global\let\pagealignmacro=\chappager}
4341 \global\let\contentsalignmacro = \chappager
4342 \global\let\pchapsepmacro=\chappager
4343 \global\let\pagealignmacro=\chappager
4344 \global\def\HEADINGSon{\HEADINGSsingle}}
4347 \global\let\contentsalignmacro = \chapoddpage
4348 \global\let\pchapsepmacro=\chapoddpage
4349 \global\let\pagealignmacro=\chapoddpage
4350 \global\def\HEADINGSon{\HEADINGSdouble}}
4356 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4357 % Yappendix, Yomitfromtoc), #3 the chapter number.
4359 % To test against our argument.
4360 \def\Ynothingkeyword{Ynothing}
4361 \def\Yomitfromtockeyword{Yomitfromtoc}
4362 \def\Yappendixkeyword{Yappendix}
4364 \def\chapmacro#1#2#3{%
4369 % Have to define \thissection before calling \donoderef, because the
4370 % xref code eventually uses it. On the other hand, it has to be called
4371 % after \pchapsepmacro, or the headline will change too soon.
4372 \gdef\thissection{#1}%
4373 \gdef\thischaptername{#1}%
4375 % Only insert the separating space if we have a chapter/appendix
4376 % number, and don't print the unnumbered ``number''.
4378 \ifx\temptype\Ynothingkeyword
4380 \def\toctype{unnchap}%
4381 \gdef\thischapter{#1}%
4382 \else\ifx\temptype\Yomitfromtockeyword
4383 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4385 \gdef\thischapter{}%
4386 \else\ifx\temptype\Yappendixkeyword
4387 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4389 % We don't substitute the actual chapter name into \thischapter
4390 % because we don't want its macros evaluated now. And we don't
4391 % use \thissection because that changes with each section.
4393 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4394 \noexpand\thischaptername}%
4396 \setbox0 = \hbox{#3\enspace}%
4397 \def\toctype{numchap}%
4398 \xdef\thischapter{\putwordChapter{} \the\chapno:
4399 \noexpand\thischaptername}%
4402 % Write the toc entry for this chapter. Must come before the
4403 % \donoderef, because we include the current node name in the toc
4404 % entry, and \donoderef resets it to empty.
4405 \writetocentry{\toctype}{#1}{#3}%
4407 % For pdftex, we have to write out the node definition (aka, make
4408 % the pdfdest) after any page break, but before the actual text has
4409 % been typeset. If the destination for the pdf outline is after the
4410 % text, then jumping from the outline may wind up with the text not
4411 % being visible, for instance under high magnification.
4414 % Typeset the actual heading.
4415 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4416 \hangindent=\wd0 \centerparametersmaybe
4419 \nobreak\bigskip % no page break after a chapter title
4423 % @centerchap -- centered and unnumbered.
4424 \let\centerparametersmaybe = \relax
4425 \def\centerparameters{%
4426 \advance\rightskip by 3\rightskip
4427 \leftskip = \rightskip
4432 % I don't think this chapter style is supported any more, so I'm not
4433 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4435 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4437 \def\unnchfopen #1{%
4438 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4439 \parindent=0pt\raggedright
4440 \rm #1\hfill}}\bigskip \par\nobreak
4442 \def\chfopen #1#2{\chapoddpage {\chapfonts
4443 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4446 \def\centerchfopen #1{%
4447 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4449 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4452 \global\let\chapmacro=\chfopen
4453 \global\let\centerchapmacro=\centerchfopen}
4456 % Section titles. These macros combine the section number parts and
4457 % call the generic \sectionheading to do the printing.
4459 \newskip\secheadingskip
4460 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4462 % Subsection titles.
4463 \newskip\subsecheadingskip
4464 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4466 % Subsubsection titles.
4467 \def\subsubsecheadingskip{\subsecheadingskip}
4468 \def\subsubsecheadingbreak{\subsecheadingbreak}
4471 % Print any size, any type, section title.
4473 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4474 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4477 \def\sectionheading#1#2#3#4{%
4479 % Switch to the right set of fonts.
4480 \csname #2fonts\endcsname \rm
4482 % Insert space above the heading.
4483 \csname #2headingbreak\endcsname
4485 % Only insert the space after the number if we have a section number.
4486 \def\sectionlevel{#2}%
4489 \ifx\temptype\Ynothingkeyword
4492 \gdef\thissection{#1}%
4493 \else\ifx\temptype\Yomitfromtockeyword
4494 % for @headings -- no section number, don't include in toc,
4495 % and don't redefine \thissection.
4498 \let\sectionlevel=\empty
4499 \else\ifx\temptype\Yappendixkeyword
4500 \setbox0 = \hbox{#4\enspace}%
4502 \gdef\thissection{#1}%
4504 \setbox0 = \hbox{#4\enspace}%
4506 \gdef\thissection{#1}%
4509 % Write the toc entry (before \donoderef). See comments in \chfplain.
4510 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4512 % Write the node reference (= pdf destination for pdftex).
4513 % Again, see comments in \chfplain.
4516 % Output the actual section heading.
4517 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4518 \hangindent=\wd0 % zero if no section number
4521 % Add extra space after the heading -- half of whatever came above it.
4522 % Don't allow stretch, though.
4523 \kern .5 \csname #2headingskip\endcsname
4525 % Do not let the kern be a potential breakpoint, as it would be if it
4526 % was followed by glue.
4529 % We'll almost certainly start a paragraph next, so don't let that
4530 % glue accumulate. (Not a breakpoint because it's preceded by a
4531 % discardable item.)
4534 % This is purely so the last item on the list is a known \penalty >
4535 % 10000. This is so \startdefun can avoid allowing breakpoints after
4536 % section headings. Otherwise, it would insert a valid breakpoint between:
4538 % @section sec-whatever
4539 % @deffn def-whatever
4545 % Table of contents.
4548 % Write an entry to the toc file, opening it if necessary.
4549 % Called from @chapter, etc.
4551 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4552 % We append the current node name (if any) and page number as additional
4553 % arguments for the \{chap,sec,...}entry macros which will eventually
4554 % read this. The node name is used in the pdf outlines as the
4555 % destination to jump to.
4557 % We open the .toc file for writing here instead of at @setfilename (or
4558 % any other fixed time) so that @contents can be anywhere in the document.
4559 % But if #1 is `omit', then we don't do anything. This is used for the
4560 % table of contents chapter openings themselves.
4562 \newif\iftocfileopened
4563 \def\omitkeyword{omit}%
4565 \def\writetocentry#1#2#3{%
4566 \edef\writetoctype{#1}%
4567 \ifx\writetoctype\omitkeyword \else
4568 \iftocfileopened\else
4569 \immediate\openout\tocfile = \jobname.toc
4570 \global\tocfileopenedtrue
4576 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4582 % Tell \shipout to create a pdf destination on each page, if we're
4583 % writing pdf. These are used in the table of contents. We can't
4584 % just write one on every page because the title pages are numbered
4585 % 1 and 2 (the page numbers aren't printed), and so are the first
4586 % two pages of the document. Thus, we'd have two destinations named
4587 % `1', and two named `2'.
4588 \ifpdf \global\pdfmakepagedesttrue \fi
4592 % These characters do not print properly in the Computer Modern roman
4593 % fonts, so we must take special care. This is more or less redundant
4594 % with the Texinfo input format setup at the end of this file.
4596 \def\activecatcodes{%
4609 % Read the toc file, which is essentially Texinfo input.
4616 \newskip\contentsrightmargin \contentsrightmargin=1in
4617 \newcount\savepageno
4618 \newcount\lastnegativepageno \lastnegativepageno = -1
4620 % Prepare to read what we've written to \tocfile.
4622 \def\startcontents#1{%
4623 % If @setchapternewpage on, and @headings double, the contents should
4624 % start on an odd page, unlike chapters. Thus, we maintain
4625 % \contentsalignmacro in parallel with \pagealignmacro.
4626 % From: Torbjorn Granlund <tege@matematik.su.se>
4628 \immediate\closeout\tocfile
4630 % Don't need to put `Contents' or `Short Contents' in the headline.
4631 % It is abundantly clear what they are.
4633 \chapmacro{#1}{Yomitfromtoc}{}%
4635 \savepageno = \pageno
4636 \begingroup % Set up to handle contents files properly.
4637 \raggedbottom % Worry more about breakpoints than the bottom.
4638 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4640 % Roman numerals for page numbers.
4641 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4645 % Normal (long) toc.
4647 \startcontents{\putwordTOC}%
4648 \openin 1 \jobname.toc
4653 \contentsalignmacro % in case @setchapternewpage odd is in effect
4659 \lastnegativepageno = \pageno
4660 \global\pageno = \savepageno
4663 % And just the chapters.
4664 \def\summarycontents{%
4665 \startcontents{\putwordShortTOC}%
4667 \let\numchapentry = \shortchapentry
4668 \let\appentry = \shortchapentry
4669 \let\unnchapentry = \shortunnchapentry
4670 % We want a true roman here for the page numbers.
4672 \let\rm=\shortcontrm \let\bf=\shortcontbf
4673 \let\sl=\shortcontsl \let\tt=\shortconttt
4675 \hyphenpenalty = 10000
4676 \advance\baselineskip by 1pt % Open it up a little.
4677 \def\numsecentry##1##2##3##4{}
4678 \let\appsecentry = \numsecentry
4679 \let\unnsecentry = \numsecentry
4680 \let\numsubsecentry = \numsecentry
4681 \let\appsubsecentry = \numsecentry
4682 \let\unnsubsecentry = \numsecentry
4683 \let\numsubsubsecentry = \numsecentry
4684 \let\appsubsubsecentry = \numsecentry
4685 \let\unnsubsubsecentry = \numsecentry
4686 \openin 1 \jobname.toc
4692 \contentsalignmacro % in case @setchapternewpage odd is in effect
4694 \lastnegativepageno = \pageno
4695 \global\pageno = \savepageno
4697 \let\shortcontents = \summarycontents
4699 % Typeset the label for a chapter or appendix for the short contents.
4700 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4702 \def\shortchaplabel#1{%
4703 % This space should be enough, since a single number is .5em, and the
4704 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4705 % But use \hss just in case.
4706 % (This space doesn't include the extra space that gets added after
4707 % the label; that gets put in by \shortchapentry above.)
4709 % We'd like to right-justify chapter numbers, but that looks strange
4710 % with appendix letters. And right-justifying numbers and
4711 % left-justifying letters looks strange when there is less than 10
4712 % chapters. Have to read the whole toc once to know how many chapters
4713 % there are before deciding ...
4714 \hbox to 1em{#1\hss}%
4717 % These macros generate individual entries in the table of contents.
4718 % The first argument is the chapter or section name.
4719 % The last argument is the page number.
4720 % The arguments in between are the chapter number, section number, ...
4722 % Chapters, in the main contents.
4723 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4725 % Chapters, in the short toc.
4726 % See comments in \dochapentry re vbox and related settings.
4727 \def\shortchapentry#1#2#3#4{%
4728 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4731 % Appendices, in the main contents.
4732 % Need the word Appendix, and a fixed-size box.
4734 \def\appendixbox#1{%
4735 % We use M since it's probably the widest letter.
4736 \setbox0 = \hbox{\putwordAppendix{} M}%
4737 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4739 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4741 % Unnumbered chapters.
4742 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4743 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4746 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4747 \let\appsecentry=\numsecentry
4748 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4751 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4752 \let\appsubsecentry=\numsubsecentry
4753 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4755 % And subsubsections.
4756 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4757 \let\appsubsubsecentry=\numsubsubsecentry
4758 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4760 % This parameter controls the indentation of the various levels.
4761 % Same as \defaultparindent.
4762 \newdimen\tocindent \tocindent = 15pt
4764 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4767 % If the toc has to be broken over pages, we want it to be at chapters
4768 % if at all possible; hence the \penalty.
4769 \def\dochapentry#1#2{%
4770 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4773 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4775 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4778 \def\dosecentry#1#2{\begingroup
4779 \secentryfonts \leftskip=\tocindent
4780 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4783 \def\dosubsecentry#1#2{\begingroup
4784 \subsecentryfonts \leftskip=2\tocindent
4785 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4788 \def\dosubsubsecentry#1#2{\begingroup
4789 \subsubsecentryfonts \leftskip=3\tocindent
4790 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4793 % We use the same \entry macro as for the index entries.
4794 \let\tocentry = \entry
4796 % Space between chapter (or whatever) number and the title.
4797 \def\labelspace{\hskip1em \relax}
4799 \def\dopageno#1{{\rm #1}}
4800 \def\doshortpageno#1{{\rm #1}}
4802 \def\chapentryfonts{\secfonts \rm}
4803 \def\secentryfonts{\textfonts}
4804 \def\subsecentryfonts{\textfonts}
4805 \def\subsubsecentryfonts{\textfonts}
4808 \message{environments,}
4809 % @foo ... @end foo.
4811 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4813 % Since these characters are used in examples, it should be an even number of
4814 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4817 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4818 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4819 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4820 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4822 % The @error{} command.
4823 % Adapted from the TeXbook's \boxit.
4827 {\tentt \global\dimen0 = 3em}% Width of the box.
4828 \dimen2 = .55pt % Thickness of rules
4829 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4830 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4832 \setbox\errorbox=\hbox to \dimen0{\hfil
4833 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4834 \advance\hsize by -2\dimen2 % Rules.
4836 \hrule height\dimen2
4837 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4838 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4839 \kern3pt\vrule width\dimen2}% Space to right.
4840 \hrule height\dimen2}
4843 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4845 % @tex ... @end tex escapes into raw Tex temporarily.
4846 % One exception: @ is still an escape character, so that @end tex works.
4847 % But \@ or @@ will get a plain tex @ character.
4850 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4851 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4852 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4862 \let\bullet=\ptexbullet
4867 \let\equiv=\ptexequiv
4870 \let\indent=\ptexindent
4871 \let\noindent=\ptexnoindent
4878 \let\frenchspacing=\plainfrenchspacing
4880 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4881 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4884 % There is no need to define \Etex.
4886 % Define @lisp ... @end lisp.
4887 % @lisp environment forms a group so it can rebind things,
4888 % including the definition of @end lisp (which normally is erroneous).
4890 % Amount to narrow the margins by for @lisp.
4891 \newskip\lispnarrowing \lispnarrowing=0.4in
4893 % This is the definition that ^^M gets inside @lisp, @example, and other
4894 % such environments. \null is better than a space, since it doesn't
4896 \def\lisppar{\null\endgraf}
4898 % This space is always present above and below environments.
4899 \newskip\envskipamount \envskipamount = 0pt
4901 % Make spacing and below environment symmetrical. We use \parskip here
4902 % to help in doing that, since in @example-like environments \parskip
4903 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4904 % start of the next paragraph will insert \parskip.
4906 \def\aboveenvbreak{{%
4907 % =10000 instead of <10000 because of a special case in \itemzzz and
4908 % \sectionheading, q.v.
4909 \ifnum \lastpenalty=10000 \else
4910 \advance\envskipamount by \parskip
4912 \ifdim\lastskip<\envskipamount
4914 % it's not a good place to break if the last penalty was \nobreak
4916 \ifnum\lastpenalty<10000 \penalty-50 \fi
4917 \vskip\envskipamount
4922 \let\afterenvbreak = \aboveenvbreak
4924 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
4925 % also clear it, so that its embedded environments do the narrowing again.
4926 \let\nonarrowing=\relax
4928 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4929 % environment contents.
4930 \font\circle=lcircle10
4932 \newdimen\cartouter\newdimen\cartinner
4933 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4934 \circthick=\fontdimen8\circle
4936 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4937 \def\ctr{{\hskip 6pt\circle\char'010}}
4938 \def\cbl{{\circle\char'012\hskip -6pt}}
4939 \def\cbr{{\hskip 6pt\circle\char'011}}
4940 \def\carttop{\hbox to \cartouter{\hskip\lskip
4941 \ctl\leaders\hrule height\circthick\hfil\ctr
4943 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4944 \cbl\leaders\hrule height\circthick\hfil\cbr
4947 \newskip\lskip\newskip\rskip
4950 \ifhmode\par\fi % can't be in the midst of a paragraph.
4952 \lskip=\leftskip \rskip=\rightskip
4953 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4954 \cartinner=\hsize \advance\cartinner by-\lskip
4955 \advance\cartinner by-\rskip
4957 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4958 % side, and for 6pt waste from
4959 % each corner char, and rule thickness
4960 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4961 % Flag to tell @lisp, etc., not to narrow margin.
4962 \let\nonarrowing = t%
4964 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4972 \baselineskip=\normbskip
4973 \lineskip=\normlskip
4976 \comment % For explanation, see the end of \def\group.
4991 % This macro is called at the beginning of all the @example variants,
4995 \hfuzz = 12pt % Don't be fussy
4996 \sepspaces % Make spaces be word-separators rather than space tokens.
4997 \let\par = \lisppar % don't ignore blank lines
4998 \obeylines % each line of input is a line of output
5001 \emergencystretch = 0pt % don't try to avoid overfull boxes
5002 \ifx\nonarrowing\relax
5003 \advance \leftskip by \lispnarrowing
5004 \exdentamount=\lispnarrowing
5006 \let\nonarrowing = \relax
5008 \let\exdent=\nofillexdent
5011 % If you want all examples etc. small: @set dispenvsize small.
5012 % If you want even small examples the full size: @set dispenvsize nosmall.
5013 % This affects the following displayed environments:
5014 % @example, @display, @format, @lisp
5016 \def\smallword{small}
5017 \def\nosmallword{nosmall}
5018 \let\SETdispenvsize\relax
5019 \def\setnormaldispenv{%
5020 \ifx\SETdispenvsize\smallword
5021 \smallexamplefonts \rm
5024 \def\setsmalldispenv{%
5025 \ifx\SETdispenvsize\nosmallword
5027 \smallexamplefonts \rm
5031 % We often define two environments, @foo and @smallfoo.
5032 % Let's do it by one command:
5033 \def\makedispenv #1#2{
5034 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5035 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5036 \expandafter\let\csname E#1\endcsname \afterenvbreak
5037 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5040 % Define two synonyms:
5041 \def\maketwodispenvs #1#2#3{
5042 \makedispenv{#1}{#3}
5043 \makedispenv{#2}{#3}
5046 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5048 % @smallexample and @smalllisp: use smaller fonts.
5049 % Originally contributed by Pavel@xerox.
5051 \maketwodispenvs {lisp}{example}{%
5054 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5055 \gobble % eat return
5058 % @display/@smalldisplay: same as @lisp except keep current font.
5060 \makedispenv {display}{%
5065 % @format/@smallformat: same as @display except don't narrow margins.
5067 \makedispenv{format}{%
5068 \let\nonarrowing = t%
5073 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5075 \let\nonarrowing = t%
5079 \let\Eflushleft = \afterenvbreak
5083 \envdef\flushright{%
5084 \let\nonarrowing = t%
5086 \advance\leftskip by 0pt plus 1fill
5089 \let\Eflushright = \afterenvbreak
5092 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5093 % and narrows the margins. We keep \parskip nonzero in general, since
5094 % we're doing normal filling. So, when using \aboveenvbreak and
5095 % \afterenvbreak, temporarily make \parskip 0.
5098 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5101 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5102 \ifx\nonarrowing\relax
5103 \advance\leftskip by \lispnarrowing
5104 \advance\rightskip by \lispnarrowing
5105 \exdentamount = \lispnarrowing
5107 \let\nonarrowing = \relax
5109 \parsearg\quotationlabel
5112 % We have retained a nonzero parskip for the environment, since we're
5113 % doing normal filling.
5117 \ifx\quotationauthor\undefined\else
5119 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5121 {\parskip=0pt \afterenvbreak}%
5124 % If we're given an argument, typeset it in bold with a colon after.
5125 \def\quotationlabel#1{%
5127 \ifx\temp\empty \else
5133 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5134 % If we want to allow any <char> as delimiter,
5135 % we need the curly braces so that makeinfo sees the @verb command, eg:
5136 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5138 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5140 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5141 % active too. Otherwise, they get lost as the first character on a
5144 \do\ \do\\\do\{\do\}\do\$\do\&%
5145 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5146 \do\<\do\>\do\|\do\@\do+\do\"%
5150 \def\uncatcodespecials{%
5151 \def\do##1{\catcode`##1=\other}\dospecials}
5153 % [Knuth] pp. 380,381,391
5154 % Disable Spanish ligatures ?` and !` of \tt font
5156 \catcode`\`=\active\gdef`{\relax\lq}
5159 % Setup for the @verb command.
5161 % Eight spaces for a tab
5163 \catcode`\^^I=\active
5164 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5168 \tt % easiest (and conventionally used) font for verbatim
5169 \def\par{\leavevmode\endgraf}%
5172 % Respect line breaks,
5173 % print special symbols as themselves, and
5174 % make each space count
5175 % must do in this order:
5176 \obeylines \uncatcodespecials \sepspaces
5179 % Setup for the @verbatim environment
5181 % Real tab expansion
5182 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5184 \def\starttabbox{\setbox0=\hbox\bgroup}
5186 \catcode`\^^I=\active
5188 \catcode`\^^I=\active
5189 \def^^I{\leavevmode\egroup
5190 \dimen0=\wd0 % the width so far, or since the previous tab
5191 \divide\dimen0 by\tabw
5192 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5193 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5194 \wd0=\dimen0 \box0 \starttabbox
5198 \def\setupverbatim{%
5199 \let\nonarrowing = t%
5201 % Easiest (and conventionally used) font for verbatim
5203 \def\par{\leavevmode\egroup\box0\endgraf}%
5206 % Respect line breaks,
5207 % print special symbols as themselves, and
5208 % make each space count
5209 % must do in this order:
5210 \obeylines \uncatcodespecials \sepspaces
5211 \everypar{\starttabbox}%
5214 % Do the @verb magic: verbatim text is quoted by unique
5215 % delimiter characters. Before first delimiter expect a
5216 % right brace, after last delimiter expect closing brace:
5218 % \def\doverb'{'<char>#1<char>'}'{#1}
5220 % [Knuth] p. 382; only eat outer {}
5222 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5223 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5226 \def\verb{\begingroup\setupverb\doverb}
5229 % Do the @verbatim magic: define the macro \doverbatim so that
5230 % the (first) argument ends when '@end verbatim' is reached, ie:
5232 % \def\doverbatim#1@end verbatim{#1}
5234 % For Texinfo it's a lot easier than for LaTeX,
5235 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5236 % we need not redefine '\', '{' and '}'.
5238 % Inspired by LaTeX's verbatim command set [latex.ltx]
5243 % ignore everything up to the first ^^M, that's the newline at the end
5244 % of the @verbatim input line itself. Otherwise we get an extra blank
5245 % line in the output.
5246 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5247 % We really want {...\end verbatim} in the body of the macro, but
5248 % without the active space; thus we have to use \xdef and \gobble.
5252 \setupverbatim\doverbatim
5254 \let\Everbatim = \afterenvbreak
5257 % @verbatiminclude FILE - insert text of file in verbatim environment.
5259 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5261 \def\doverbatiminclude#1{%
5263 \makevalueexpandable
5270 % @copying ... @end copying.
5271 % Save the text away for @insertcopying later.
5273 % We save the uninterpreted tokens, rather than creating a box.
5274 % Saving the text in a box would be much easier, but then all the
5275 % typesetting commands (@smallbook, font changes, etc.) have to be done
5276 % beforehand -- and a) we want @copying to be done first in the source
5277 % file; b) letting users define the frontmatter in as flexible order as
5278 % possible is very desirable.
5280 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5281 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5283 \def\insertcopying{%
5285 \parindent = 0pt % paragraph indentation looks wrong on title page
5286 \scanexp\copyingtext
5293 \newskip\defbodyindent \defbodyindent=.4in
5294 \newskip\defargsindent \defargsindent=50pt
5295 \newskip\deflastargmargin \deflastargmargin=18pt
5297 % Start the processing of @deffn:
5299 \ifnum\lastpenalty<10000
5302 % If there are two @def commands in a row, we'll have a \nobreak,
5303 % which is there to keep the function description together with its
5304 % header. But if there's nothing but headers, we need to allow a
5305 % break somewhere. Check specifically for penalty 10002, inserted
5306 % by \defargscommonending, instead of 10000, since the sectioning
5307 % commands also insert a nobreak penalty, and we don't want to allow
5308 % a break between a section heading and a defun.
5310 \ifnum\lastpenalty=10002 \penalty2000 \fi
5312 % Similarly, after a section heading, do not allow a break.
5313 % But do insert the glue.
5314 \medskip % preceded by discardable penalty, so not a breakpoint
5318 \advance\leftskip by \defbodyindent
5319 \exdentamount=\defbodyindent
5323 % First, check whether we are in the right environment:
5326 % As above, allow line break if we have multiple x headers in a row.
5327 % It's not a great place, though.
5328 \ifnum\lastpenalty=10002 \penalty3000 \fi
5330 % And now, it's time to reuse the body of the original defun:
5331 \expandafter\gobbledefun#1%
5333 \def\gobbledefun#1\startdefun{}
5335 % \printdefunline \deffnheader{text}
5337 \def\printdefunline#1#2{%
5339 % call \deffnheader:
5342 \interlinepenalty = 10000
5343 \advance\rightskip by 0pt plus 1fil
5345 \nobreak\vskip -\parskip
5346 \penalty 10002 % signal to \startdefun and \dodefunx
5347 % Some of the @defun-type tags do not enable magic parentheses,
5348 % rendering the following check redundant. But we don't optimize.
5353 \def\Edefun{\endgraf\medbreak}
5355 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5356 % the only thing remainnig is to define \deffnheader.
5359 \expandafter\let\csname E#1\endcsname = \Edefun
5360 \edef\temp{\noexpand\domakedefun
5361 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5365 % \domakedefun \deffn \deffnx \deffnheader
5367 % Define \deffn and \deffnx, without parameters.
5368 % \deffnheader has to be defined explicitly.
5370 \def\domakedefun#1#2#3{%
5373 \parseargusing\activeparens{\printdefunline#3}%
5375 \def#2{\dodefunx#1}%
5379 %%% Untyped functions:
5381 % @deffn category name args
5382 \makedefun{deffn}{\deffngeneral{}}
5384 % @deffn category class name args
5385 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5387 % \defopon {category on}class name args
5388 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5390 % \deffngeneral {subind}category name args
5392 \def\deffngeneral#1#2 #3 #4\endheader{%
5393 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5394 \dosubind{fn}{\code{#3}}{#1}%
5395 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5398 %%% Typed functions:
5400 % @deftypefn category type name args
5401 \makedefun{deftypefn}{\deftypefngeneral{}}
5403 % @deftypeop category class type name args
5404 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5406 % \deftypeopon {category on}class type name args
5407 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5409 % \deftypefngeneral {subind}category type name args
5411 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5412 \dosubind{fn}{\code{#4}}{#1}%
5413 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5416 %%% Typed variables:
5418 % @deftypevr category type var args
5419 \makedefun{deftypevr}{\deftypecvgeneral{}}
5421 % @deftypecv category class type var args
5422 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5424 % \deftypecvof {category of}class type var args
5425 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5427 % \deftypecvgeneral {subind}category type var args
5429 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5430 \dosubind{vr}{\code{#4}}{#1}%
5431 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5434 %%% Untyped variables:
5436 % @defvr category var args
5437 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5439 % @defcv category class var args
5440 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5442 % \defcvof {category of}class var args
5443 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5446 % @deftp category name args
5447 \makedefun{deftp}#1 #2 #3\endheader{%
5448 \doind{tp}{\code{#2}}%
5449 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5452 % Remaining @defun-like shortcuts:
5453 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5454 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5455 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5456 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5457 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5458 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5459 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5460 \makedefun{defmethod}{\defopon\putwordMethodon}
5461 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5462 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5463 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5465 % \defname, which formats the name of the @def (not the args).
5466 % #1 is the category, such as "Function".
5467 % #2 is the return type, if any.
5468 % #3 is the function name.
5470 % We are followed by (but not passed) the arguments, if any.
5472 \def\defname#1#2#3{%
5473 % Get the values of \leftskip and \rightskip as they were outside the @def...
5474 \advance\leftskip by -\defbodyindent
5476 % How we'll format the type name. Putting it in brackets helps
5477 % distinguish it from the body text that may end up on the next line
5480 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5482 % Figure out line sizes for the paragraph shape.
5483 % The first line needs space for \box0; but if \rightskip is nonzero,
5484 % we need only space for the part of \box0 which exceeds it:
5485 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5486 % The continuations:
5487 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5488 % (plain.tex says that \dimen1 should be used only as global.)
5489 \parshape 2 0in \dimen0 \defargsindent \dimen2
5491 % Put the type name to the right margin.
5494 \hfil\box0 \kern-\hsize
5495 % \hsize has to be shortened this way:
5497 % Intentionally do not respect \rightskip, since we need the space.
5500 % Allow all lines to be underfull without complaint:
5501 \tolerance=10000 \hbadness=10000
5502 \exdentamount=\defbodyindent
5504 % defun fonts. We use typewriter by default (used to be bold) because:
5505 % . we're printing identifiers, they should be in tt in principle.
5506 % . in languages with many accents, such as Czech or French, it's
5507 % common to leave accents off identifiers. The result looks ok in
5508 % tt, but exceedingly strange in rm.
5509 % . we don't want -- and --- to be treated as ligatures.
5510 % . this still does not fix the ?` and !` ligatures, but so far no
5511 % one has made identifiers using them :).
5513 \def\temp{#2}% return value type
5514 \ifx\temp\empty\else \tclose{\temp} \fi
5515 #3% output function name
5517 {\rm\enskip}% hskip 0.5 em of \tenrm
5520 % arguments will be output next, if any.
5523 % Print arguments in slanted roman (not ttsl), inconsistently with using
5524 % tt for the name. This is because literal text is sometimes needed in
5525 % the argument list (groff manual), and ttsl and tt are not very
5526 % distinguishable. Prevent hyphenation at `-' chars.
5529 % use sl by default (not ttsl),
5531 \df \sl \hyphenchar\font=0
5533 % On the other hand, if an argument has two dashes (for instance), we
5534 % want a way to get ttsl. Let's try @var for that.
5537 \sl\hyphenchar\font=45
5540 % We want ()&[] to print specially on the defun line.
5543 \catcode`\(=\active \catcode`\)=\active
5544 \catcode`\[=\active \catcode`\]=\active
5548 % Make control sequences which act like normal parenthesis chars.
5549 \let\lparen = ( \let\rparen = )
5551 % Be sure that we always have a definition for `(', etc. For example,
5552 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5553 % so TeX would otherwise complain about undefined control sequence.
5556 \global\let(=\lparen \global\let)=\rparen
5557 \global\let[=\lbrack \global\let]=\rbrack
5560 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5561 \gdef\magicamp{\let&=\amprm}
5564 \newcount\parencount
5566 % If we encounter &foo, then turn on ()-hacking afterwards
5568 \def\amprm#1 {\ampseentrue{\bf\ }}
5572 % At the first level, print parens in roman,
5573 % otherwise use the default font.
5574 \ifnum \parencount=1 \rm \fi
5576 % The \sf parens (in \boldbrax) actually are a little bolder than
5577 % the contained text. This is especially needed for [ and ] .
5581 \def\infirstlevel#1{%
5588 \def\bfafterword#1 {#1 \bf}
5591 \global\advance\parencount by 1
5593 \infirstlevel \bfafterword
5598 \global\advance\parencount by -1
5601 \newcount\brackcount
5603 \global\advance\brackcount by 1
5608 \global\advance\brackcount by -1
5611 \def\checkparencounts{%
5612 \ifnum\parencount=0 \else \badparencount \fi
5613 \ifnum\brackcount=0 \else \badbrackcount \fi
5615 \def\badparencount{%
5616 \errmessage{Unbalanced parentheses in @def}%
5617 \global\parencount=0
5619 \def\badbrackcount{%
5620 \errmessage{Unbalanced square braces in @def}%
5621 \global\brackcount=0
5628 % To do this right we need a feature of e-TeX, \scantokens,
5629 % which we arrange to emulate with a temporary file in ordinary TeX.
5630 \ifx\eTeXversion\undefined
5631 \newwrite\macscribble
5634 \immediate\openout\macscribble=\jobname.tmp
5635 \immediate\write\macscribble{\the\toks0}%
5636 \immediate\closeout\macscribble
5644 \let\xeatspaces\eatspaces
5645 % Undo catcode changes of \startcontents and \doprintindex
5646 % When called from @insertcopying or (short)caption, we need active
5647 % backslash to get it printed correctly. Previously, we had
5648 % \catcode`\\=\other instead. We'll see whether a problem appears
5649 % with macro expansion. --kasal, 19aug04
5650 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5654 % Append \endinput to make sure that TeX does not see the ending newline.
5656 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5658 \scantokens{#1\endinput}%
5663 \edef\temp{\noexpand\scanmacro{#1}}%
5667 \newcount\paramno % Count of parameters
5668 \newtoks\macname % Macro name
5669 \newif\ifrecursive % Is it recursive?
5671 % List of all defined macros in the form
5672 % \definedummyword\macro1\definedummyword\macro2...
5673 % Currently is also contains all @aliases; the list can be split
5674 % if there is a need.
5677 % Add the macro to \macrolist
5678 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5679 \def\addtomacrolistxxx#1{%
5680 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5681 \xdef\macrolist{\the\toks0}%
5685 % This does \let #1 = #2, with \csnames; that is,
5686 % \let \csname#1\endcsname = \csname#2\endcsname
5687 % (except of course we have to play expansion games).
5691 \csname#1\expandafter\endcsname
5695 % Trim leading and trailing spaces off a string.
5696 % Concepts from aro-bend problem 15 (see CTAN).
5698 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5699 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5700 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5702 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5705 % Trim a single trailing ^^M off a string.
5706 {\catcode`\^^M=\other \catcode`\Q=3%
5707 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5708 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5709 \gdef\eatcrb#1Q#2Q{#1}%
5712 % Macro bodies are absorbed as an argument in a context where
5713 % all characters are catcode 10, 11 or 12, except \ which is active
5714 % (as in normal texinfo). It is necessary to change the definition of \.
5716 % It's necessary to have hard CRs when the macro is executed. This is
5717 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5718 % body, and then making it the \newlinechar in \scanmacro.
5735 \catcode`\^^M=\other
5738 \def\macrobodyctxt{%
5742 \catcode`\^^M=\other
5751 % \mbodybackslash is the definition of \ in @macro bodies.
5752 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5753 % where N is the macro parameter number.
5754 % We define \csname macarg.\endcsname to be \realbackslash, so
5755 % \\ in macro replacement text gets you a backslash.
5757 {\catcode`@=0 @catcode`@\=@active
5758 @gdef@usembodybackslash{@let\=@mbodybackslash}
5759 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5761 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5763 \def\macro{\recursivefalse\parsearg\macroxxx}
5764 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5767 \getargs{#1}% now \macname is the macname and \argl the arglist
5768 \ifx\argl\empty % no arguments
5771 \expandafter\parsemargdef \argl;%
5773 \if1\csname ismacro.\the\macname\endcsname
5774 \message{Warning: redefining \the\macname}%
5776 \expandafter\ifx\csname \the\macname\endcsname \relax
5777 \else \errmessage{Macro name \the\macname\space already defined}\fi
5778 \global\cslet{macsave.\the\macname}{\the\macname}%
5779 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5780 \addtomacrolist{\the\macname}%
5782 \begingroup \macrobodyctxt
5783 \ifrecursive \expandafter\parsermacbody
5784 \else \expandafter\parsemacbody
5787 \parseargdef\unmacro{%
5788 \if1\csname ismacro.#1\endcsname
5789 \global\cslet{#1}{macsave.#1}%
5790 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5791 % Remove the macro name from \macrolist:
5793 \expandafter\let\csname#1\endcsname \relax
5794 \let\definedummyword\unmacrodo
5795 \xdef\macrolist{\macrolist}%
5798 \errmessage{Macro #1 not defined}%
5802 % Called by \do from \dounmacro on each macro. The idea is to omit any
5803 % macro definitions that have been changed to \relax.
5809 \noexpand\definedummyword \noexpand#1%
5813 % This makes use of the obscure feature that if the last token of a
5814 % <parameter list> is #, then the preceding argument is delimited by
5815 % an opening brace, and that opening brace is not consumed.
5816 \def\getargs#1{\getargsxxx#1{}}
5817 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5818 \def\getmacname #1 #2\relax{\macname={#1}}
5819 \def\getmacargs#1{\def\argl{#1}}
5821 % Parse the optional {params} list. Set up \paramno and \paramlist
5822 % so \defmacro knows what to do. Define \macarg.blah for each blah
5823 % in the params list, to be ##N where N is the position in that list.
5824 % That gets used by \mbodybackslash (above).
5826 % We need to get `macro parameter char #' into several definitions.
5827 % The technique used is stolen from LaTeX: let \hash be something
5828 % unexpandable, insert that wherever you need a #, and then redefine
5829 % it to # just before using the token list produced.
5831 % The same technique is used to protect \eatspaces till just before
5832 % the macro is used.
5834 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5835 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5836 \def\parsemargdefxxx#1,{%
5837 \if#1;\let\next=\relax
5838 \else \let\next=\parsemargdefxxx
5839 \advance\paramno by 1%
5840 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5841 {\xeatspaces{\hash\the\paramno}}%
5842 \edef\paramlist{\paramlist\hash\the\paramno,}%
5845 % These two commands read recursive and nonrecursive macro bodies.
5846 % (They're different since rec and nonrec macros end differently.)
5848 \long\def\parsemacbody#1@end macro%
5849 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5850 \long\def\parsermacbody#1@end rmacro%
5851 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5853 % This defines the macro itself. There are six cases: recursive and
5854 % nonrecursive macros of zero, one, and many arguments.
5855 % Much magic with \expandafter here.
5856 % \xdef is used so that macro definitions will survive the file
5857 % they're defined in; @include reads the file inside a group.
5859 \let\hash=##% convert placeholders to macro parameter chars
5863 \expandafter\xdef\csname\the\macname\endcsname{%
5864 \noexpand\scanmacro{\temp}}%
5866 \expandafter\xdef\csname\the\macname\endcsname{%
5867 \bgroup\noexpand\macroargctxt
5868 \noexpand\braceorline
5869 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5870 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5871 \egroup\noexpand\scanmacro{\temp}}%
5873 \expandafter\xdef\csname\the\macname\endcsname{%
5874 \bgroup\noexpand\macroargctxt
5875 \noexpand\csname\the\macname xx\endcsname}%
5876 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5877 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5878 \expandafter\expandafter
5880 \expandafter\expandafter
5881 \csname\the\macname xxx\endcsname
5882 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5887 \expandafter\xdef\csname\the\macname\endcsname{%
5888 \noexpand\norecurse{\the\macname}%
5889 \noexpand\scanmacro{\temp}\egroup}%
5891 \expandafter\xdef\csname\the\macname\endcsname{%
5892 \bgroup\noexpand\macroargctxt
5893 \noexpand\braceorline
5894 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5895 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5897 \noexpand\norecurse{\the\macname}%
5898 \noexpand\scanmacro{\temp}\egroup}%
5900 \expandafter\xdef\csname\the\macname\endcsname{%
5901 \bgroup\noexpand\macroargctxt
5902 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5903 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5904 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5905 \expandafter\expandafter
5907 \expandafter\expandafter
5908 \csname\the\macname xxx\endcsname
5911 \noexpand\norecurse{\the\macname}%
5912 \noexpand\scanmacro{\temp}\egroup}%
5916 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5918 % \braceorline decides whether the next nonwhitespace character is a
5919 % {. If so it reads up to the closing }, if not, it reads the whole
5920 % line. Whatever was read is then fed to the next control sequence
5921 % as an argument (by \parsebrace or \parsearg)
5922 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5923 \def\braceorlinexxx{%
5924 \ifx\nchar\bgroup\else
5925 \expandafter\parsearg
5930 % We need some trickery to remove the optional spaces around the equal
5931 % sign. Just make them active and then expand them all to nothing.
5932 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5933 \def\aliasxxx #1{\aliasyyy#1\relax}
5934 \def\aliasyyy #1=#2\relax{%
5936 \expandafter\let\obeyedspace=\empty
5937 \addtomacrolist{#1}%
5938 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5944 \message{cross references,}
5948 \newif\ifhavexrefs % True if xref values are known.
5949 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5951 % @inforef is relatively simple.
5952 \def\inforef #1{\inforefzzz #1,,,,**}
5953 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5954 node \samp{\ignorespaces#1{}}}
5956 % @node's only job in TeX is to define \lastnode, which is used in
5957 % cross-references. The @node line might or might not have commas, and
5958 % might or might not have spaces before the first comma, like:
5959 % @node foo , bar , ...
5960 % We don't want such trailing spaces in the node name.
5962 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
5964 % also remove a trailing comma, in case of something like this:
5965 % @node Help-Cross, , , Cross-refs
5966 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
5967 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5970 \let\lastnode=\empty
5972 % Write a cross-reference definition for the current node. #1 is the
5973 % type (Ynumbered, Yappendix, Ynothing).
5976 \ifx\lastnode\empty\else
5977 \setref{\lastnode}{#1}%
5978 \global\let\lastnode=\empty
5982 % @anchor{NAME} -- define xref target at arbitrary point.
5984 \newcount\savesfregister
5986 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5987 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5988 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5990 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5991 % anchor), which consists of three parts:
5992 % 1) NAME-title - the current sectioning name taken from \thissection,
5993 % or the anchor name.
5994 % 2) NAME-snt - section number and type, passed as the SNT arg, or
5995 % empty for anchors.
5996 % 3) NAME-pg - the page number.
5998 % This is called from \donoderef, \anchor, and \dofloat. In the case of
5999 % floats, there is an additional part, which is not written here:
6000 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6006 \atdummies % preserve commands, but don't expand them
6007 \edef\writexrdef##1##2{%
6008 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6009 ##1}{##2}}% these are parameters of \writexrdef
6011 \toks0 = \expandafter{\thissection}%
6012 \immediate \writexrdef{title}{\the\toks0 }%
6013 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6014 \writexrdef{pg}{\folio}% will be written later, during \shipout
6019 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6020 % the node name, #2 the name of the Info cross-reference, #3 the printed
6021 % node name, #4 the name of the Info file, #5 the name of the printed
6022 % manual. All but the node name can be omitted.
6024 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6025 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6026 \def\ref#1{\xrefX[#1,,,,,,,]}
6027 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6029 \def\printedmanual{\ignorespaces #5}%
6030 \def\printedrefname{\ignorespaces #3}%
6031 \setbox1=\hbox{\printedmanual\unskip}%
6032 \setbox0=\hbox{\printedrefname\unskip}%
6034 % No printed node name was explicitly given.
6035 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6036 % Use the node name inside the square brackets.
6037 \def\printedrefname{\ignorespaces #1}%
6039 % Use the actual chapter/section title appear inside
6040 % the square brackets. Use the real section title if we have it.
6042 % It is in another manual, so we don't have it.
6043 \def\printedrefname{\ignorespaces #1}%
6046 % We know the real title if we have the xref values.
6047 \def\printedrefname{\refx{#1-title}{}}%
6049 % Otherwise just copy the Info node name.
6050 \def\printedrefname{\ignorespaces #1}%
6056 % Make link in pdf output.
6061 % See comments at \activebackslashdouble.
6062 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6063 \backslashparens\pdfxrefdest}%
6065 \ifnum\filenamelength>0
6066 \startlink attr{/Border [0 0 0]}%
6067 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6069 \startlink attr{/Border [0 0 0]}%
6070 goto name{\pdfmkpgn{\pdfxrefdest}}%
6076 % Float references are printed completely differently: "Figure 1.2"
6077 % instead of "[somenode], p.3". We distinguish them by the
6078 % LABEL-title being set to a magic string.
6080 % Have to otherify everything special to allow the \csname to
6081 % include an _ in the xref name, etc.
6084 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6085 \csname XR#1-title\endcsname
6087 \iffloat\Xthisreftitle
6088 % If the user specified the print name (third arg) to the ref,
6089 % print it instead of our usual "Figure 1.2".
6096 % if the user also gave the printed manual name (fifth arg), append
6099 \space \putwordin{} \cite{\printedmanual}%
6102 % node/anchor (non-float) references.
6104 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6105 % insert empty discretionaries after hyphens, which means that it will
6106 % not find a line break at a hyphen in a node names. Since some manuals
6107 % are best written with fairly long node names, containing hyphens, this
6108 % is a loss. Therefore, we give the text of the node name again, so it
6109 % is as if TeX is seeing it for the first time.
6111 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6113 % _ (for example) has to be the character _ for the purposes of the
6114 % control sequence corresponding to the node, but it has to expand
6115 % into the usual \leavevmode...\vrule stuff for purposes of
6116 % printing. So we \turnoffactive for the \refx-snt, back on for the
6117 % printing, back off for the \refx-pg.
6119 % Only output a following space if the -snt ref is nonempty; for
6120 % @unnumbered and @anchor, it won't be.
6121 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6122 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6124 % output the `[mynode]' via a macro so it can be overridden.
6125 \xrefprintnodename\printedrefname
6127 % But we always want a comma and a space:
6130 % output the `page 3'.
6131 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6137 % This macro is called from \xrefX for the `[nodename]' part of xref
6138 % output. It's a separate macro only so it can be changed more easily,
6139 % since square brackets don't work well in some documents. Particularly
6140 % one that Bob is working on :).
6142 \def\xrefprintnodename#1{[#1]}
6144 % Things referred to by \setref.
6150 \putwordChapter@tie \the\chapno
6151 \else \ifnum\subsecno=0
6152 \putwordSection@tie \the\chapno.\the\secno
6153 \else \ifnum\subsubsecno=0
6154 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6156 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6161 \putwordAppendix@tie @char\the\appendixno{}%
6162 \else \ifnum\subsecno=0
6163 \putwordSection@tie @char\the\appendixno.\the\secno
6164 \else \ifnum\subsubsecno=0
6165 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6168 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6172 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6173 % If its value is nonempty, SUFFIX is output afterward.
6179 \expandafter\global\expandafter\let\expandafter\thisrefX
6180 \csname XR#1\endcsname
6183 % If not defined, say something at least.
6184 \angleleft un\-de\-fined\angleright
6187 \message{\linenumber Undefined cross reference `#1'.}%
6190 \global\warnedxrefstrue
6191 \message{Cross reference values unknown; you must run TeX again.}%
6196 % It's defined, so just use it.
6199 #2% Output the suffix in any case.
6202 % This is the macro invoked by entries in the aux file. Usually it's
6203 % just a \def (we prepend XR to the control sequence name to avoid
6204 % collisions). But if this is a float type, we have more work to do.
6207 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6209 % Was that xref control sequence that we just defined for a float?
6210 \expandafter\iffloat\csname XR#1\endcsname
6211 % it was a float, and we have the (safe) float type in \iffloattype.
6212 \expandafter\let\expandafter\floatlist
6213 \csname floatlist\iffloattype\endcsname
6215 % Is this the first time we've seen this float type?
6216 \expandafter\ifx\floatlist\relax
6217 \toks0 = {\do}% yes, so just \do
6219 % had it before, so preserve previous elements in list.
6220 \toks0 = \expandafter{\floatlist\do}%
6223 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6224 % for later use in \listoffloats.
6225 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6229 % Read the last existing aux file, if any. No error if none exists.
6232 \openin 1 \jobname.aux
6235 \global\havexrefstrue
6240 \def\setupdatafile{%
6241 \catcode`\^^@=\other
6242 \catcode`\^^A=\other
6243 \catcode`\^^B=\other
6244 \catcode`\^^C=\other
6245 \catcode`\^^D=\other
6246 \catcode`\^^E=\other
6247 \catcode`\^^F=\other
6248 \catcode`\^^G=\other
6249 \catcode`\^^H=\other
6250 \catcode`\^^K=\other
6251 \catcode`\^^L=\other
6252 \catcode`\^^N=\other
6253 \catcode`\^^P=\other
6254 \catcode`\^^Q=\other
6255 \catcode`\^^R=\other
6256 \catcode`\^^S=\other
6257 \catcode`\^^T=\other
6258 \catcode`\^^U=\other
6259 \catcode`\^^V=\other
6260 \catcode`\^^W=\other
6261 \catcode`\^^X=\other
6262 \catcode`\^^Z=\other
6263 \catcode`\^^[=\other
6264 \catcode`\^^\=\other
6265 \catcode`\^^]=\other
6266 \catcode`\^^^=\other
6267 \catcode`\^^_=\other
6268 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6269 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6270 % supported in the main text, it doesn't seem desirable. Furthermore,
6271 % that is not enough: for node names that actually contain a ^
6272 % character, we would end up writing a line like this: 'xrdef {'hat
6273 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6274 % argument, and \hat is not an expandable control sequence. It could
6275 % all be worked out, but why? Either we support ^^ or we don't.
6277 % The other change necessary for this was to define \auxhat:
6278 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6279 % and then to call \auxhat in \setq.
6283 % Special characters. Should be turned off anyway, but...
6296 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6298 % This is to support \ in node names and titles, since the \
6299 % characters end up in a \csname. It's easier than
6300 % leaving it active and making its active definition an actual \
6301 % character. What I don't understand is why it works in the *value*
6302 % of the xrdef. Seems like it should be a catcode12 \, and that
6303 % should not typeset properly. But it works, so I'm moving on for
6304 % now. --karl, 15jan04.
6307 % Make the characters 128-255 be printing characters.
6311 \catcode\count1=\other
6312 \advance\count1 by 1
6313 \ifnum \count1<256 \loop \fi
6317 % @ is our escape character in .aux files, and we need braces.
6323 \def\readdatafile#1{%
6329 \message{insertions,}
6330 % including footnotes.
6332 \newcount \footnoteno
6334 % The trailing space in the following definition for supereject is
6335 % vital for proper filling; pages come out unaligned when you do a
6336 % pagealignmacro call if that space before the closing brace is
6337 % removed. (Generally, numeric constants should always be followed by a
6338 % space to prevent strange expansion errors.)
6339 \def\supereject{\par\penalty -20000\footnoteno =0 }
6341 % @footnotestyle is meaningful for info output only.
6342 \let\footnotestyle=\comment
6346 % Auto-number footnotes. Otherwise like plain.
6348 \let\indent=\ptexindent
6349 \let\noindent=\ptexnoindent
6350 \global\advance\footnoteno by \@ne
6351 \edef\thisfootno{$^{\the\footnoteno}$}%
6353 % In case the footnote comes at the end of a sentence, preserve the
6354 % extra spacing after we do the footnote number.
6356 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6358 % Remove inadvertent blank space before typesetting the footnote number.
6364 % Don't bother with the trickery in plain.tex to not require the
6365 % footnote text as a parameter. Our footnotes don't need to be so general.
6367 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6368 % \parseargline) fails inside footnotes because the tokens are fixed when
6369 % the footnote is read. --karl, 16nov96.
6372 \insert\footins\bgroup
6373 % We want to typeset this text as a normal paragraph, even if the
6374 % footnote reference occurs in (for example) a display environment.
6375 % So reset some parameters.
6377 \interlinepenalty\interfootnotelinepenalty
6378 \splittopskip\ht\strutbox % top baseline for broken footnotes
6379 \splitmaxdepth\dp\strutbox
6380 \floatingpenalty\@MM
6385 \parindent\defaultparindent
6389 % Because we use hanging indentation in footnotes, a @noindent appears
6390 % to exdent this text, so make it be a no-op. makeinfo does not use
6391 % hanging indentation so @noindent can still be needed within footnote
6392 % text after an @example or the like (not that this is good style).
6393 \let\noindent = \relax
6395 % Hang the footnote text off the number. Use \everypar in case the
6396 % footnote extends for more than one paragraph.
6397 \everypar = {\hang}%
6398 \textindent{\thisfootno}%
6400 % Don't crash into the line above the footnote text. Since this
6401 % expands into a box, it must come within the paragraph, lest it
6402 % provide a place where TeX can split the footnote.
6404 \futurelet\next\fo@t
6406 }%end \catcode `\@=11
6408 % In case a @footnote appears in a vbox, save the footnote text and create
6409 % the real \insert just after the vbox finished. Otherwise, the insertion
6411 % Similarily, if a @footnote appears inside an alignment, save the footnote
6412 % text to a box and make the \insert when a row of the table is finished.
6413 % And the same can be done for other insert classes. --kasal, 16nov03.
6415 % Replace the \insert primitive by a cheating macro.
6416 % Deeper inside, just make sure that the saved insertions are not spilled
6419 \def\startsavinginserts{%
6420 \ifx \insert\ptexinsert
6421 \let\insert\saveinsert
6423 \let\checkinserts\relax
6427 % This \insert replacement works for both \insert\footins{foo} and
6428 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6431 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6432 \afterassignment\next
6433 % swallow the left brace
6436 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6437 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6439 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6441 \def\placesaveins#1{%
6442 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6446 % eat @SAVE -- beware, all of them have catcode \other:
6448 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6449 \gdef\gobblesave @SAVE{}
6453 \def\newsaveins #1{%
6454 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6457 \def\newsaveinsX #1{%
6458 \csname newbox\endcsname #1%
6459 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6464 \let\checkinserts\empty
6469 % @image. We use the macros from epsf.tex to support this.
6470 % If epsf.tex is not installed and @image is used, we complain.
6472 % Check for and read epsf.tex up front. If we read it only at @image
6473 % time, we might be inside a group, and then its definitions would get
6474 % undone and the next image would fail.
6475 \openin 1 = epsf.tex
6477 % Do not bother showing banner with epsf.tex v2.7k (available in
6478 % doc/epsf.tex and on ctan).
6479 \def\epsfannounce{\toks0 = }%
6484 % We will only complain once about lack of epsf.tex.
6485 \newif\ifwarnednoepsf
6486 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6487 work. It is also included in the Texinfo distribution, or you can get
6488 it from ftp://tug.org/tex/epsf.tex.}
6491 \ifx\epsfbox\undefined
6492 \ifwarnednoepsf \else
6493 \errhelp = \noepsfhelp
6494 \errmessage{epsf.tex not found, images will be ignored}%
6495 \global\warnednoepsftrue
6498 \imagexxx #1,,,,,\finish
6502 % Arguments to @image:
6503 % #1 is (mandatory) image filename; we tack on .eps extension.
6504 % #2 is (optional) width, #3 is (optional) height.
6505 % #4 is (ignored optional) html alt text.
6506 % #5 is (ignored optional) extension.
6507 % #6 is just the usual extra ignored arg for parsing this stuff.
6509 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6510 \catcode`\^^M = 5 % in case we're inside an example
6511 \normalturnoffactive % allow _ et al. in names
6512 % If the image is by itself, center it.
6516 % Usually we'll have text after the image which will insert
6517 % \parskip glue, so insert it here too to equalize the space
6519 \nobreak\vskip\parskip
6526 \dopdfimage{#1}{#2}{#3}%
6528 % \epsfbox itself resets \epsf?size at each figure.
6529 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6530 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6534 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6538 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6539 % etc. We don't actually implement floating yet, we always include the
6540 % float "here". But it seemed the best name for the future.
6542 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6544 % There may be a space before second and/or third parameter; delete it.
6545 \def\eatcommaspace#1, {#1,}
6547 % #1 is the optional FLOATTYPE, the text label for this float, typically
6548 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6549 % this float will not be numbered and cannot be referred to.
6551 % #2 is the optional xref label. Also must be present for the float to
6554 % #3 is the optional positioning argument; for now, it is ignored. It
6555 % will somehow specify the positions allowed to float to (here, top, bottom).
6557 % We keep a separate counter for each FLOATTYPE, which we reset at each
6558 % chapter-level command.
6559 \let\resetallfloatnos=\empty
6561 \def\dofloat#1,#2,#3,#4\finish{%
6562 \let\thiscaption=\empty
6563 \let\thisshortcaption=\empty
6565 % don't lose footnotes inside @float.
6567 % BEWARE: when the floats start float, we have to issue warning whenever an
6568 % insert appears inside a float which could possibly float. --kasal, 26may04
6572 % We can't be used inside a paragraph.
6577 \def\floatlabel{#2}%
6578 \def\floatloc{#3}% we do nothing with this yet.
6580 \ifx\floattype\empty
6581 \let\safefloattype=\empty
6584 % the floattype might have accents or other special characters,
6585 % but we need to use it in a control sequence name.
6588 \xdef\safefloattype{\floattype}%
6592 % If label is given but no type, we handle that as the empty type.
6593 \ifx\floatlabel\empty \else
6594 % We want each FLOATTYPE to be numbered separately (Figure 1,
6595 % Table 1, Figure 2, ...). (And if no label, no number.)
6597 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6598 \global\advance\floatno by 1
6601 % This magic value for \thissection is output by \setref as the
6602 % XREFLABEL-title value. \xrefX uses it to distinguish float
6603 % labels (which have a completely different output format) from
6604 % node and anchor labels. And \xrdef uses it to construct the
6607 \edef\thissection{\floatmagic=\safefloattype}%
6608 \setref{\floatlabel}{Yfloat}%
6612 % start with \parskip glue, I guess.
6615 % Don't suppress indentation if a float happens to start a section.
6616 \restorefirstparagraphindent
6619 % we have these possibilities:
6620 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6621 % @float Foo,lbl & no caption: Foo 1.1
6622 % @float Foo & @caption{Cap}: Foo: Cap
6623 % @float Foo & no caption: Foo
6624 % @float ,lbl & Caption{Cap}: 1.1: Cap
6625 % @float ,lbl & no caption: 1.1
6626 % @float & @caption{Cap}: Cap
6627 % @float & no caption:
6630 \let\floatident = \empty
6632 % In all cases, if we have a float type, it comes first.
6633 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6635 % If we have an xref label, the number comes next.
6636 \ifx\floatlabel\empty \else
6637 \ifx\floattype\empty \else % if also had float type, need tie first.
6638 \appendtomacro\floatident{\tie}%
6641 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6644 % Start the printed caption with what we've constructed in
6645 % \floatident, but keep it separate; we need \floatident again.
6646 \let\captionline = \floatident
6648 \ifx\thiscaption\empty \else
6649 \ifx\floatident\empty \else
6650 \appendtomacro\captionline{: }% had ident, so need a colon between
6654 \appendtomacro\captionline{\scanexp\thiscaption}%
6657 % If we have anything to print, print it, with space before.
6658 % Eventually this needs to become an \insert.
6659 \ifx\captionline\empty \else
6663 % Space below caption.
6667 % If have an xref label, write the list of floats info. Do this
6668 % after the caption, to avoid chance of it being a breakpoint.
6669 \ifx\floatlabel\empty \else
6670 % Write the text that goes in the lof to the aux file as
6671 % \floatlabel-lof. Besides \floatident, we include the short
6672 % caption if specified, else the full caption if specified, else nothing.
6676 % since we read the caption text in the macro world, where ^^M
6677 % is turned into a normal character, we have to scan it back, so
6678 % we don't write the literal three characters "^^M" into the aux file.
6680 \xdef\noexpand\gtemp{%
6681 \ifx\thisshortcaption\empty
6688 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6689 \ifx\gtemp\empty \else : \gtemp \fi}}%
6692 \egroup % end of \vtop
6694 % place the captured inserts
6696 % BEWARE: when the floats start floating, we have to issue warning
6697 % whenever an insert appears inside a float which could possibly
6698 % float. --kasal, 26may04
6703 % Append the tokens #2 to the definition of macro #1, not expanding either.
6705 \def\appendtomacro#1#2{%
6706 \expandafter\def\expandafter#1\expandafter{#1#2}%
6709 % @caption, @shortcaption
6711 \def\caption{\docaption\thiscaption}
6712 \def\shortcaption{\docaption\thisshortcaption}
6713 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6714 \def\defcaption#1#2{\egroup \def#1{#2}}
6716 % The parameter is the control sequence identifying the counter we are
6717 % going to use. Create it if it doesn't exist and assign it to \floatno.
6720 % Haven't seen this figure type before.
6721 \csname newcount\endcsname #1%
6723 % Remember to reset this floatno at the next chap.
6724 \expandafter\gdef\expandafter\resetallfloatnos
6725 \expandafter{\resetallfloatnos #1=0 }%
6730 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6731 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6732 % first read the @float command.
6734 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6736 % Magic string used for the XREFLABEL-title value, so \xrefX can
6737 % distinguish floats from other xref types.
6738 \def\floatmagic{!!float!!}
6740 % #1 is the control sequence we are passed; we expand into a conditional
6741 % which is true if #1 represents a float ref. That is, the magic
6742 % \thissection value which we \setref above.
6744 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6746 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6747 % (safe) float type for this float. We set \iffloattype to #2.
6749 \def\doiffloat#1=#2=#3\finish{%
6751 \def\iffloattype{#2}%
6752 \ifx\temp\floatmagic
6755 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6757 \parseargdef\listoffloats{%
6758 \def\floattype{#1}% floattype
6760 % the floattype might have accents or other special characters,
6761 % but we need to use it in a control sequence name.
6764 \xdef\safefloattype{\floattype}%
6767 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6768 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6770 % if the user said @listoffloats foo but never @float foo.
6771 \message{\linenumber No `\safefloattype' floats to list.}%
6775 \leftskip=\tocindent % indent these entries like a toc
6776 \let\do=\listoffloatsdo
6777 \csname floatlist\safefloattype\endcsname
6782 % This is called on each entry in a list of floats. We're passed the
6783 % xref label, in the form LABEL-title, which is how we save it in the
6784 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6785 % has the text we're supposed to typeset here.
6787 % Figures without xref labels will not be included in the list (since
6788 % they won't appear in the aux file).
6790 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6791 \def\listoffloatsdoentry#1-title\finish{{%
6792 % Can't fully expand XR#1-lof because it can contain anything. Just
6793 % pass the control sequence. On the other hand, XR#1-pg is just the
6794 % page number, and we want to fully expand that so we can get a link
6796 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6798 % use the same \entry macro we use to generate the TOC and index.
6799 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6803 \message{localization,}
6806 % @documentlanguage is usually given very early, just after
6807 % @setfilename. If done too late, it may not override everything
6808 % properly. Single argument is the language abbreviation.
6809 % It would be nice if we could set up a hyphenation file here.
6811 \parseargdef\documentlanguage{%
6812 \tex % read txi-??.tex file in plain TeX.
6813 % Read the file if it exists.
6814 \openin 1 txi-#1.tex
6816 \errhelp = \nolanghelp
6817 \errmessage{Cannot read language file txi-#1.tex}%
6824 \newhelp\nolanghelp{The given language definition file cannot be found or
6825 is empty. Maybe you need to install it? In the current directory
6826 should work if nowhere else does.}
6829 % @documentencoding should change something in TeX eventually, most
6830 % likely, but for now just recognize it.
6831 \let\documentencoding = \comment
6834 % Page size parameters.
6836 \newdimen\defaultparindent \defaultparindent = 15pt
6838 \chapheadingskip = 15pt plus 4pt minus 2pt
6839 \secheadingskip = 12pt plus 3pt minus 2pt
6840 \subsecheadingskip = 9pt plus 2pt minus 2pt
6842 % Prevent underfull vbox error messages.
6845 % Don't be so finicky about underfull hboxes, either.
6848 % Following George Bush, just get rid of widows and orphans.
6852 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6853 % using an old version of TeX, don't do anything. We want the amount of
6854 % stretch added to depend on the line length, hence the dependence on
6855 % \hsize. We call this whenever the paper size is set.
6857 \def\setemergencystretch{%
6858 \ifx\emergencystretch\thisisundefined
6859 % Allow us to assign to \emergencystretch anyway.
6860 \def\emergencystretch{\dimen0}%
6862 \emergencystretch = .15\hsize
6866 % Parameters in order: 1) textheight; 2) textwidth;
6867 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
6868 % 7) physical page height; 8) physical page width.
6870 % We also call \setleading{\textleading}, so the caller should define
6871 % \textleading. The caller should also set \parskip.
6873 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6876 \splittopskip = \topskip
6879 \advance\vsize by \topskip
6880 \outervsize = \vsize
6881 \advance\outervsize by 2\topandbottommargin
6882 \pageheight = \vsize
6885 \outerhsize = \hsize
6886 \advance\outerhsize by 0.5in
6889 \normaloffset = #4\relax
6890 \bindingoffset = #5\relax
6893 \pdfpageheight #7\relax
6894 \pdfpagewidth #8\relax
6897 \setleading{\textleading}
6899 \parindent = \defaultparindent
6900 \setemergencystretch
6903 % @letterpaper (the default).
6904 \def\letterpaper{{\globaldefs = 1
6905 \parskip = 3pt plus 2pt minus 1pt
6906 \textleading = 13.2pt
6908 % If page is nothing but text, make it come out even.
6909 \internalpagesizes{46\baselineskip}{6in}%
6911 {\bindingoffset}{36pt}%
6915 % Use @smallbook to reset parameters for 7x9.25 trim size.
6916 \def\smallbook{{\globaldefs = 1
6917 \parskip = 2pt plus 1pt
6920 \internalpagesizes{7.5in}{5in}%
6922 {\bindingoffset}{16pt}%
6925 \lispnarrowing = 0.3in
6928 \contentsrightmargin = 0pt
6929 \defbodyindent = .5cm
6932 % Use @smallerbook to reset parameters for 6x9 trim size.
6933 % (Just testing, parameters still in flux.)
6934 \def\smallerbook{{\globaldefs = 1
6935 \parskip = 1.5pt plus 1pt
6938 \internalpagesizes{7.4in}{4.8in}%
6943 \lispnarrowing = 0.25in
6946 \contentsrightmargin = 0pt
6947 \defbodyindent = .4cm
6950 % Use @afourpaper to print on European A4 paper.
6951 \def\afourpaper{{\globaldefs = 1
6952 \parskip = 3pt plus 2pt minus 1pt
6953 \textleading = 13.2pt
6955 % Double-side printing via postscript on Laserjet 4050
6956 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6957 % To change the settings for a different printer or situation, adjust
6958 % \normaloffset until the front-side and back-side texts align. Then
6959 % do the same for \bindingoffset. You can set these for testing in
6960 % your texinfo source file like this:
6962 % \global\normaloffset = -6mm
6963 % \global\bindingoffset = 10mm
6965 \internalpagesizes{51\baselineskip}{160mm}
6966 {\voffset}{\hoffset}%
6967 {\bindingoffset}{44pt}%
6972 \contentsrightmargin = 0pt
6973 \defbodyindent = 5mm
6976 % Use @afivepaper to print on European A5 paper.
6977 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6978 % He also recommends making @example and @lisp be small.
6979 \def\afivepaper{{\globaldefs = 1
6980 \parskip = 2pt plus 1pt minus 0.1pt
6981 \textleading = 12.5pt
6983 \internalpagesizes{160mm}{120mm}%
6984 {\voffset}{\hoffset}%
6985 {\bindingoffset}{8pt}%
6988 \lispnarrowing = 0.2in
6991 \contentsrightmargin = 0pt
6992 \defbodyindent = 2mm
6996 % A specific text layout, 24x15cm overall, intended for A4 paper.
6997 \def\afourlatex{{\globaldefs = 1
6999 \internalpagesizes{237mm}{150mm}%
7001 {\bindingoffset}{7mm}%
7004 % Must explicitly reset to 0 because we call \afourpaper.
7008 % Use @afourwide to print on A4 paper in landscape format.
7009 \def\afourwide{{\globaldefs = 1
7011 \internalpagesizes{241mm}{165mm}%
7012 {\voffset}{-2.95mm}%
7013 {\bindingoffset}{7mm}%
7018 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7019 % Perhaps we should allow setting the margins, \topskip, \parskip,
7020 % and/or leading, also. Or perhaps we should compute them somehow.
7022 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7023 \def\pagesizesyyy#1,#2,#3\finish{{%
7024 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7027 \parskip = 3pt plus 2pt minus 1pt
7028 \setleading{\textleading}%
7031 \advance\dimen0 by \voffset
7034 \advance\dimen2 by \normaloffset
7036 \internalpagesizes{#1}{\hsize}%
7037 {\voffset}{\normaloffset}%
7038 {\bindingoffset}{44pt}%
7042 % Set default to letter.
7047 \message{and turning on texinfo input format.}
7049 % Define macros to output various characters with catcode for normal text.
7059 \def\normaldoublequote{"}
7062 \def\normalunderscore{_}
7063 \def\normalverticalbar{|}
7065 \def\normalgreater{>}
7067 \def\normaldollar{$}%$ font-lock fix
7069 % This macro is used to make a character print one way in \tt
7070 % (where it can probably be output as-is), and another way in other fonts,
7071 % where something hairier probably needs to be done.
7073 % #1 is what to print if we are indeed using \tt; #2 is what to print
7074 % otherwise. Since all the Computer Modern typewriter fonts have zero
7075 % interword stretch (and shrink), and it is reasonable to expect all
7076 % typewriter fonts to have this, we can check that font parameter.
7078 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7080 % Same as above, but check for italic font. Actually this also catches
7081 % non-italic slanted fonts since it is impossible to distinguish them from
7082 % italic fonts. But since this is only used by $ and it uses \sl anyway
7083 % this is not a problem.
7084 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7086 % Turn off all special characters except @
7087 % (and those which the user can use as if they were ordinary).
7088 % Most of these we simply print from the \tt font, but for some, we can
7089 % use math or other variants that look better in normal text.
7092 \def\activedoublequote{{\tt\char34}}
7093 \let"=\activedoublequote
7095 \def~{{\tt\char126}}
7101 \def_{\ifusingtt\normalunderscore\_}
7103 % Subroutine for the previous macro.
7104 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7107 \def|{{\tt\char124}}
7115 \def+{{\tt \char 43}}
7117 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7119 % If a .fmt file is being used, characters that might appear in a file
7120 % name cannot be active until we have parsed the command line.
7121 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7122 % \otherifyactive is called near the end of this file.
7123 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7127 % \backslashcurfont outputs one backslash character in current font,
7129 \global\chardef\backslashcurfont=`\\
7130 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7132 % \rawbackslash defines an active \ to do \backslashcurfont.
7133 % \otherbackslash defines an active \ to be a literal `\' character with
7135 {\catcode`\\=\active
7136 @gdef@rawbackslash{@let\=@backslashcurfont}
7137 @gdef@otherbackslash{@let\=@realbackslash}
7140 % \realbackslash is an actual character `\' with catcode other, and
7141 % \doublebackslash is two of them (for the pdf outlines).
7142 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7144 % \normalbackslash outputs one backslash in fixed width font.
7145 \def\normalbackslash{{\tt\backslashcurfont}}
7149 % Used sometimes to turn off (effectively) the active characters
7150 % even after parsing them.
7151 @def@turnoffactive{%
7152 @let"=@normaldoublequote
7153 @let\=@realbackslash
7156 @let_=@normalunderscore
7157 @let|=@normalverticalbar
7159 @let>=@normalgreater
7161 @let$=@normaldollar %$ font-lock fix
7165 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7166 % the literal character `\'. (Thus, \ is not expandable when this is in
7169 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
7171 % Make _ and + \other characters, temporarily.
7172 % This is canceled by @fixbackslash.
7175 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7176 % That is what \eatinput is for; after that, the `\' should revert to printing
7179 @gdef@eatinput input texinfo{@fixbackslash}
7180 @global@let\ = @eatinput
7182 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7183 % the first `\{ in the file would cause an error. This macro tries to fix
7184 % that, assuming it is called before the first `\' could plausibly occur.
7185 % Also turn back on active characters that might appear in the input
7186 % file name, in case not using a pre-dumped format.
7188 @gdef@fixbackslash{%
7189 @ifx\@eatinput @let\ = @normalbackslash @fi
7194 % Say @foo, not \foo, in error messages.
7197 % These look ok in all fonts, so just make them not special.
7198 @catcode`@& = @other
7199 @catcode`@# = @other
7200 @catcode`@% = @other
7204 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7205 @c page-delimiter: "^\\\\message"
7206 @c time-stamp-start: "def\\\\texinfoversion{"
7207 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7208 @c time-stamp-end: "}"
7214 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115