1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2006-06-01.17}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10 % Software Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
164 % The following is used inside several \edef's.
165 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
169 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
170 ap-pen-dix bit-map bit-maps
171 data-base data-bases eshell fall-ing half-way long-est man-u-script
172 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
173 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
175 stand-alone strong-est time-stamp time-stamps which-ever white-space
176 wide-spread wrap-around
179 % Margin to add to right of even pages, to left of odd pages.
180 \newdimen\bindingoffset
181 \newdimen\normaloffset
182 \newdimen\pagewidth \newdimen\pageheight
184 % For a final copy, take out the rectangles
185 % that mark overfull boxes (in case you have decided
186 % that the text looks ok even though it passes the margin).
188 \def\finalout{\overfullrule=0pt}
190 % @| inserts a changebar to the left of the current line. It should
191 % surround any changed text. This approach does *not* work if the
192 % change spans more than two lines of output. To handle that, we would
193 % have adopt a much more difficult approach (putting marks into the main
194 % vertical list for the beginning and end of each change).
197 % \vadjust can only be used in horizontal mode.
200 % Append this vertical mode material after the current line in the output.
202 % We want to insert a rule with the height and depth of the current
203 % leading; that is exactly what \strutbox is supposed to record.
206 % \vadjust-items are inserted at the left edge of the type. So
207 % the \llap here moves out into the left-hand margin.
210 % For a thicker or thinner bar, change the `1pt'.
211 \vrule height\baselineskip width1pt
213 % This is the space between the bar and the text.
219 % Sometimes it is convenient to have everything in the transcript file
220 % and nothing on the terminal. We don't just call \tracingall here,
221 % since that produces some useless output on the terminal. We also make
222 % some effort to order the tracing commands to reduce output in the log
223 % file; cf. trace.sty in LaTeX.
225 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
229 \tracinglostchars2 % 2 gives us more in etex
234 \showboxbreadth\maxdimen \showboxdepth\maxdimen
235 \ifx\eTeXversion\undefined\else % etex gives us more logging
242 \tracingcommands3 % 3 gives us more in etex
246 % add check for \lastpenalty to plain's definitions. If the last thing
247 % we did was a \nobreak, we don't want to insert more space.
249 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
250 \removelastskip\penalty-50\smallskip\fi\fi}
251 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
252 \removelastskip\penalty-100\medskip\fi\fi}
253 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
254 \removelastskip\penalty-200\bigskip\fi\fi}
256 % For @cropmarks command.
257 % Do @cropmarks to get crop marks.
260 \let\cropmarks = \cropmarkstrue
262 % Dimensions to add cropmarks at corners.
263 % Added by P. A. MacKay, 12 Nov. 1986
265 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
266 \newdimen\cornerlong \cornerlong=1pc
267 \newdimen\cornerthick \cornerthick=.3pt
268 \newdimen\topandbottommargin \topandbottommargin=.75in
270 % Main output routine.
272 \output = {\onepageout{\pagecontents\PAGE}}
277 % \onepageout takes a vbox as an argument. Note that \pagecontents
278 % does insertions, but you have to call it yourself.
280 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
282 \ifodd\pageno \advance\hoffset by \bindingoffset
283 \else \advance\hoffset by -\bindingoffset\fi
285 % Do this outside of the \shipout so @code etc. will be expanded in
286 % the headline as they should be, not taken literally (outputting ''code).
287 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
288 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
291 % Have to do this stuff outside the \shipout because we want it to
292 % take effect in \write's, yet the group defined by the \vbox ends
293 % before the \shipout runs.
295 \indexdummies % don't expand commands in the output.
296 \normalturnoffactive % \ in index entries must not stay \, e.g., if
297 % the page break happens to be in the middle of an example.
298 % We don't want .vr (or whatever) entries like this:
299 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
300 % "\acronym" won't work when it's read back in;
302 % {\code {{\tt \backslashcurfont }acronym}
304 % Do this early so pdf references go to the beginning of the page.
305 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
307 \ifcropmarks \vbox to \outervsize\bgroup
309 \vskip-\topandbottommargin
311 \line{\ewtop\hfil\ewtop}%
314 \vbox{\moveleft\cornerthick\nstop}%
316 \vbox{\moveright\cornerthick\nstop}%
319 \vskip\topandbottommargin
321 \hfil % center the page within the outer (page) hsize.
322 \ifodd\pageno\hskip\bindingoffset\fi
328 \ifdim\ht\footlinebox > 0pt
329 % Only leave this space if the footline is nonempty.
330 % (We lessened \vsize for it in \oddfootingxxx.)
331 % The \baselineskip=24pt in plain's \makefootline has no effect.
332 \vskip 2\baselineskip
337 \egroup % end of \vbox\bgroup
338 \hfil\egroup % end of (centering) \line\bgroup
339 \vskip\topandbottommargin plus1fill minus1fill
340 \boxmaxdepth = \cornerthick
343 \vbox{\moveleft\cornerthick\nsbot}%
345 \vbox{\moveright\cornerthick\nsbot}%
348 \line{\ewbot\hfil\ewbot}%
350 \egroup % \vbox from first cropmarks clause
352 }% end of \shipout\vbox
353 }% end of group with \indexdummies
355 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 \newinsert\margin \dimen\margin=\maxdimen
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
362 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363 % marginal hacks, juha@viisa.uucp (Juha Takala)
364 \ifvoid\margin\else % marginal info is present
365 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366 \dimen@=\dp#1 \unvbox#1
367 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 % Here are the rules for the cropmarks. Note that they are
372 % offset so that the space between them is truly \outerhsize or \outervsize
373 % (P. A. MacKay, 12 November, 1986)
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
377 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
380 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
382 % Parse an argument, then pass it to #1. The argument is the rest of
383 % the input line (except we remove a trailing comment). #1 should be a
384 % macro which expects an ordinary undelimited TeX argument.
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
393 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
397 \gdef\parseargline#1^^M{%
398 \endgroup % End of the group started in \parsearg.
399 \argremovecomment #1\comment\ArgTerm%
403 % First remove any @comment, then any @c comment.
404 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
407 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
409 % \argremovec might leave us with trailing space, e.g.,
410 % @end itemize @c foo
411 % This space token undergoes the same procedure and is eventually removed
412 % by \finishparsearg.
414 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
419 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
420 \let\temp\finishparsearg
422 \let\temp\argcheckspaces
424 % Put the space token in:
428 % If a _delimited_ argument is enclosed in braces, they get stripped; so
429 % to get _exactly_ the rest of the line, we had to prevent such situation.
430 % We prepended an \empty token at the very beginning and we expand it now,
431 % just before passing the control to \argtorun.
432 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
433 % either the null string, or it ends with \^^M---thus there is no danger
434 % that a pair of braces would be stripped.
436 % But first, we have to remove the trailing space token.
438 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
440 % \parseargdef\foo{...}
441 % is roughly equivalent to
442 % \def\foo{\parsearg\Xfoo}
445 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
446 % favourite TeX trick. --kasal, 16nov03
449 \expandafter \doparseargdef \csname\string#1\endcsname #1%
451 \def\doparseargdef#1#2{%
456 % Several utility definitions with active space:
461 % Make each space character in the input produce a normal interword
462 % space in the output. Don't allow a line break at this space, as this
463 % is used only in environments like @example, where each line of input
464 % should produce a line of output anyway.
466 \gdef\sepspaces{\obeyspaces\let =\tie}
468 % If an index command is used in an @example environment, any spaces
469 % therein should become regular spaces in the raw index file, not the
470 % expansion of \tie (\leavevmode \penalty \@M \ ).
471 \gdef\unsepspaces{\let =\space}
475 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
477 % Define the framework for environments in texinfo.tex. It's used like this:
482 % It's the responsibility of \envdef to insert \begingroup before the
483 % actual body; @end closes the group after calling \Efoo. \envdef also
484 % defines \thisenv, so the current environment is known; @end checks
485 % whether the environment name matches. The \checkenv macro can also be
486 % used to check whether the current environment is the one expected.
488 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
489 % are not treated as enviroments; they don't open a group. (The
490 % implementation of @end takes care not to call \endgroup in this
494 % At runtime, environments start with this:
495 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
499 % ... but they get defined via ``\envdef\foo{...}'':
500 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
501 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
503 % Check whether we're in the right environment:
512 % Evironment mismatch, #1 expected:
515 \errmessage{This command can appear only \inenvironment\temp,
516 not \inenvironment\thisenv}%
518 \def\inenvironment#1{%
520 out of any environment%
522 in environment \expandafter\string#1%
526 % @end foo executes the definition of \Efoo.
527 % But first, it executes a specialized version of \checkenv
530 \if 1\csname iscond.#1\endcsname
532 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
533 \expandafter\checkenv\csname#1\endcsname
534 \csname E#1\endcsname
539 \newhelp\EMsimple{Press RETURN to continue.}
542 %% Simple single-character @ commands
545 % Kludge this until the fonts are right (grr).
548 % This is turned off because it was never documented
549 % and you can use @w{...} around a quote to suppress ligatures.
550 %% Define @` and @' to be the same as ` and '
551 %% but suppressing ligatures.
555 % Used to generate quoted braces.
556 \def\mylbrace {{\tt\char123}}
557 \def\myrbrace {{\tt\char125}}
561 % Definitions to produce \{ and \} commands for indices,
562 % and @{ and @} for the aux/toc files.
563 \catcode`\{ = \other \catcode`\} = \other
564 \catcode`\[ = 1 \catcode`\] = 2
565 \catcode`\! = 0 \catcode`\\ = \other
568 !gdef!lbraceatcmd[@{]%
569 !gdef!rbraceatcmd[@}]%
572 % @comma{} to avoid , parsing problems.
575 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
576 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
579 \def\ringaccent#1{{\accent23 #1}}
584 % Other special characters: @questiondown @exclamdown @ordf @ordm
585 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
586 \def\questiondown{?`}
588 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
589 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
591 % Dotless i and dotless j, used for accents.
596 \ifx\temp\imacro \ptexi
597 \else\ifx\temp\jmacro \j
598 \else \errmessage{@dotless can be used only with i or j}%
602 % The \TeX{} logo, as in plain, but resetting the spacing so that a
603 % period following counts as ending a sentence. (Idea found in latex.)
605 \edef\TeX{\TeX \spacefactor=1000 }
607 % @LaTeX{} logo. Not quite the same results as the definition in
608 % latex.ltx, since we use a different font for the raised A; it's most
609 % convenient for us to use an explicitly smaller font, rather than using
610 % the \scriptstyle font (since we don't reset \scriptstyle and
611 % \scriptscriptstyle).
616 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
621 % Be sure we're in horizontal mode when doing a tie, since we make space
622 % equivalent to this in @example-like environments. Otherwise, a space
623 % at the beginning of a line will start with \penalty -- and
624 % since \penalty is valid in vertical mode, we'd end up putting the
625 % penalty on the vertical list instead of in the new paragraph.
627 % Avoid using \@M directly, because that causes trouble
628 % if the definition is written into an index file.
629 \global\let\tiepenalty = \@M
630 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
633 % @: forces normal size whitespace following.
634 \def\:{\spacefactor=1000 }
636 % @* forces a line break.
637 \def\*{\hfil\break\hbox{}\ignorespaces}
639 % @/ allows a line break.
642 % @. is an end-of-sentence period.
643 \def\.{.\spacefactor=\endofsentencespacefactor\space}
645 % @! is an end-of-sentence bang.
646 \def\!{!\spacefactor=\endofsentencespacefactor\space}
648 % @? is an end-of-sentence query.
649 \def\?{?\spacefactor=\endofsentencespacefactor\space}
651 % @frenchspacing on|off says whether to put extra space after punctuation.
656 \parseargdef\frenchspacing{%
658 \ifx\temp\onword \plainfrenchspacing
659 \else\ifx\temp\offword \plainnonfrenchspacing
662 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
666 % @w prevents a word break. Without the \leavevmode, @w at the
667 % beginning of a paragraph, when TeX is still in vertical mode, would
668 % produce a whole line of output instead of starting the paragraph.
669 \def\w#1{\leavevmode\hbox{#1}}
671 % @group ... @end group forces ... to be all on one page, by enclosing
672 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
673 % to keep its height that of a normal line. According to the rules for
674 % \topskip (p.114 of the TeXbook), the glue inserted is
675 % max (\topskip - \ht (first item), 0). If that height is large,
676 % therefore, no glue is inserted, and the space between the headline and
677 % the text is small, which looks bad.
679 % Another complication is that the group might be very large. This can
680 % cause the glue on the previous page to be unduly stretched, because it
681 % does not have much material. In this case, it's better to add an
682 % explicit \vfill so that the extra space is at the bottom. The
683 % threshold for doing this is if the group is more than \vfilllimit
684 % percent of a page (\vfilllimit can be changed inside of @tex).
690 \ifnum\catcode`\^^M=\active \else
691 \errhelp = \groupinvalidhelp
692 \errmessage{@group invalid in context where filling is enabled}%
696 \setbox\groupbox = \vtop\bgroup
697 % Do @comment since we are called inside an environment such as
698 % @example, where each end-of-line in the input causes an
699 % end-of-line in the output. We don't want the end-of-line after
700 % the `@group' to put extra space in the output. Since @group
701 % should appear on a line by itself (according to the Texinfo
702 % manual), we don't worry about eating any user text.
706 % The \vtop produces a box with normal height and large depth; thus, TeX puts
707 % \baselineskip glue before it, and (when the next line of text is done)
708 % \lineskip glue after it. Thus, space below is not quite equal to space
709 % above. But it's pretty close.
711 % To get correct interline space between the last line of the group
712 % and the first line afterwards, we have to propagate \prevdepth.
713 \endgraf % Not \par, as it may have been set to \lisppar.
714 \global\dimen1 = \prevdepth
715 \egroup % End the \vtop.
716 % \dimen0 is the vertical size of the group's box.
717 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
718 % \dimen2 is how much space is left on the page (more or less).
719 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
720 % if the group doesn't fit on the current page, and it's a big big
721 % group, force a page break.
722 \ifdim \dimen0 > \dimen2
723 \ifdim \pagetotal < \vfilllimit\pageheight
732 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
733 % message, so this ends up printing `@group can only ...'.
735 \newhelp\groupinvalidhelp{%
736 group can only be used in environments such as @example,^^J%
737 where each line of input produces a line of output.}
739 % @need space-in-mils
740 % forces a page break if there is not space-in-mils remaining.
742 \newdimen\mil \mil=0.001in
744 % Old definition--didn't work.
745 %\parseargdef\need{\par %
746 %% This method tries to make TeX break the page naturally
747 %% if the depth of the box does not fit.
749 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
754 % Ensure vertical mode, so we don't make a big box in the middle of a
758 % If the @need value is less than one line space, it's useless.
760 \dimen2 = \ht\strutbox
761 \advance\dimen2 by \dp\strutbox
762 \ifdim\dimen0 > \dimen2
764 % Do a \strut just to make the height of this box be normal, so the
765 % normal leading is inserted relative to the preceding line.
766 % And a page break here is fine.
767 \vtop to #1\mil{\strut\vfil}%
769 % TeX does not even consider page breaks if a penalty added to the
770 % main vertical list is 10000 or more. But in order to see if the
771 % empty box we just added fits on the page, we must make it consider
772 % page breaks. On the other hand, we don't want to actually break the
773 % page after the empty box. So we use a penalty of 9999.
775 % There is an extremely small chance that TeX will actually break the
776 % page at this \penalty, if there are no other feasible breakpoints in
777 % sight. (If the user is using lots of big @group commands, which
778 % almost-but-not-quite fill up a page, TeX will have a hard time doing
779 % good page breaking, for example.) However, I could not construct an
780 % example where a page broke at this \penalty; if it happens in a real
781 % document, then we can reconsider our strategy.
784 % Back up by the size of the box, whether we did a page break or not.
787 % Do not allow a page break right after this kern.
792 % @br forces paragraph break (and is undocumented).
796 % @page forces the start of a new page.
798 \def\page{\par\vfill\supereject}
801 % outputs text on separate line in roman font, starting at standard page margin
803 % This records the amount of indent in the innermost environment.
804 % That's how much \exdent should take out.
805 \newskip\exdentamount
807 % This defn is used inside fill environments such as @defun.
808 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
810 % This defn is used inside nofill environments such as @example.
811 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
812 \leftline{\hskip\leftskip{\rm#1}}}}
814 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
815 % paragraph. For more general purposes, use the \margin insertion
816 % class. WHICH is `l' or `r'.
818 \newskip\inmarginspacing \inmarginspacing=1cm
819 \def\strutdepth{\dp\strutbox}
821 \def\doinmargin#1#2{\strut\vadjust{%
824 \vtop to \strutdepth{%
825 \baselineskip=\strutdepth
827 % if you have multiple lines of stuff to put here, you'll need to
828 % make the vbox yourself of the appropriate size.
830 \llap{\ignorespaces #2\hskip\inmarginspacing}%
832 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
837 \def\inleftmargin{\doinmargin l}
838 \def\inrightmargin{\doinmargin r}
840 % @inmargin{TEXT [, RIGHT-TEXT]}
841 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
842 % else use TEXT for both).
844 \def\inmargin#1{\parseinmargin #1,,\finish}
845 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
846 \setbox0 = \hbox{\ignorespaces #2}%
848 \def\lefttext{#1}% have both texts
851 \def\lefttext{#1}% have only one text
856 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
858 \def\temp{\inleftmargin\lefttext}%
863 % @include file insert text of that file as input.
865 \def\include{\parseargusing\filenamecatcodes\includezzz}
871 \def\temp{\input #1 }%
876 \def\filenamecatcodes{%
888 \def\pushthisfilestack{%
889 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
891 \def\pushthisfilestackX{%
892 \expandafter\pushthisfilestackY\thisfile\StackTerm
894 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
895 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
898 \def\popthisfilestack{\errthisfilestackempty}
899 \def\errthisfilestackempty{\errmessage{Internal error:
900 the stack of filenames is empty.}}
905 % outputs that line, centered.
907 \parseargdef\center{%
913 \next{\hfil \ignorespaces#1\unskip \hfil}%
918 \advance\hsize by -\leftskip
919 \advance\hsize by -\rightskip
924 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
926 % @sp n outputs n lines of vertical space
928 \parseargdef\sp{\vskip #1\baselineskip}
930 % @comment ...line which is ignored...
931 % @c is the same as @comment
932 % @ignore ... @end ignore is another way to write a comment
934 \def\comment{\begingroup \catcode`\^^M=\other%
935 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
937 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
941 % @paragraphindent NCHARS
942 % We'll use ems for NCHARS, close enough.
943 % NCHARS can also be the word `asis' or `none'.
944 % We cannot feasibly implement @paragraphindent asis, though.
946 \def\asisword{asis} % no translation, these are keywords
949 \parseargdef\paragraphindent{%
954 \defaultparindent = 0pt
956 \defaultparindent = #1em
959 \parindent = \defaultparindent
962 % @exampleindent NCHARS
963 % We'll use ems for NCHARS like @paragraphindent.
964 % It seems @exampleindent asis isn't necessary, but
965 % I preserve it to make it similar to @paragraphindent.
966 \parseargdef\exampleindent{%
973 \lispnarrowing = #1em
978 % @firstparagraphindent WORD
979 % If WORD is `none', then suppress indentation of the first paragraph
980 % after a section heading. If WORD is `insert', then do indent at such
983 % The paragraph indentation is suppressed or not by calling
984 % \suppressfirstparagraphindent, which the sectioning commands do.
985 % We switch the definition of this back and forth according to WORD.
986 % By default, we suppress indentation.
988 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
989 \def\insertword{insert}
991 \parseargdef\firstparagraphindent{%
994 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
995 \else\ifx\temp\insertword
996 \let\suppressfirstparagraphindent = \relax
999 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1003 % Here is how we actually suppress indentation. Redefine \everypar to
1004 % \kern backwards by \parindent, and then reset itself to empty.
1006 % We also make \indent itself not actually do anything until the next
1009 \gdef\dosuppressfirstparagraphindent{%
1011 \restorefirstparagraphindent
1015 \restorefirstparagraphindent
1018 \global\everypar = {%
1020 \restorefirstparagraphindent
1024 \gdef\restorefirstparagraphindent{%
1025 \global \let \indent = \ptexindent
1026 \global \let \noindent = \ptexnoindent
1027 \global \everypar = {}%
1031 % @asis just yields its argument. Used with @table, for example.
1035 % @math outputs its argument in math mode.
1037 % One complication: _ usually means subscripts, but it could also mean
1038 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1039 % _ active, and distinguish by seeing if the current family is \slfam,
1040 % which is what @var uses.
1042 \catcode`\_ = \active
1043 \gdef\mathunderscore{%
1045 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1048 % Another complication: we want \\ (and @\) to output a \ character.
1049 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1050 % this is not advertised and we don't care. Texinfo does not
1051 % otherwise define @\.
1053 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1054 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1059 \let\\ = \mathbackslash
1063 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1065 % Some active characters (such as <) are spaced differently in math.
1066 % We have to reset their definitions in case the @math was an argument
1067 % to a command which sets the catcodes (such as @item or @section).
1070 \catcode`^ = \active
1071 \catcode`< = \active
1072 \catcode`> = \active
1073 \catcode`+ = \active
1082 % @bullet and @minus need the same treatment as @math, just above.
1083 \def\bullet{$\ptexbullet$}
1086 % @dots{} outputs an ellipsis using the current font.
1087 % We do .5em per period so that it has the same spacing in the cm
1088 % typewriter fonts as three actual period characters; on the other hand,
1089 % in other typewriter fonts three periods are wider than 1.5em. So do
1090 % whichever is larger.
1094 \setbox0=\hbox{...}% get width of three periods
1101 \hskip 0pt plus.25fil
1102 .\hskip 0pt plus1fil
1103 .\hskip 0pt plus1fil
1104 .\hskip 0pt plus.5fil
1108 % @enddots{} is an end-of-sentence ellipsis.
1112 \spacefactor=\endofsentencespacefactor
1115 % @comma{} is so commas can be inserted into text without messing up
1116 % Texinfo's parsing.
1120 % @refill is a no-op.
1123 % If working on a large document in chapters, it is convenient to
1124 % be able to disable indexing, cross-referencing, and contents, for test runs.
1125 % This is done with @novalidate (before @setfilename).
1127 \newif\iflinks \linkstrue % by default we want the aux files.
1128 \let\novalidate = \linksfalse
1130 % @setfilename is done at the beginning of every texinfo file.
1131 % So open here the files we need to have open while reading the input.
1132 % This makes it possible to make a .fmt file for texinfo.
1134 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1137 % Open the new aux file. TeX will close it automatically at exit.
1138 \immediate\openout\auxfile=\jobname.aux
1139 \fi % \openindices needs to do some work in any case.
1141 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1143 % If texinfo.cnf is present on the system, read it.
1144 % Useful for site-wide @afourpaper, etc.
1145 \openin 1 texinfo.cnf
1146 \ifeof 1 \else \input texinfo.cnf \fi
1149 \comment % Ignore the actual filename.
1152 % Called from \setfilename.
1164 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1168 % adobe `portable' document format
1172 \newcount\filenamelength
1181 \newif\ifpdfmakepagedest
1183 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1184 % can be set). So we test for \relax and 0 as well as \undefined,
1185 % borrowed from ifpdf.sty.
1186 \ifx\pdfoutput\undefined
1188 \ifx\pdfoutput\relax
1197 % PDF uses PostScript string constants for the names of xref targets,
1198 % for display in the outlines, and in other places. Thus, we have to
1199 % double any backslashes. Otherwise, a name like "\node" will be
1200 % interpreted as a newline (\n), followed by o, d, e. Not good.
1201 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1202 % (and related messages, the final outcome is that it is up to the TeX
1203 % user to double the backslashes and otherwise make the string valid, so
1204 % that's what we do).
1206 % double active backslashes.
1208 {\catcode`\@=0 \catcode`\\=\active
1209 @gdef@activebackslashdouble{%
1211 @let\=@doublebackslash}
1214 % To handle parens, we must adopt a different approach, since parens are
1215 % not active characters. hyperref.dtx (which has the same problem as
1216 % us) handles it with this amazing macro to replace tokens. I've
1217 % tinkered with it a little for texinfo, but it's definitely from there.
1219 % #1 is the tokens to replace.
1220 % #2 is the replacement.
1221 % #3 is the control sequence with the string.
1223 \def\HyPsdSubst#1#2#3{%
1224 \def\HyPsdReplace##1#1##2\END{%
1230 \HyPsdReplace##2\END
1234 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1236 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1238 % #1 is a control sequence in which to do the replacements.
1239 \def\backslashparens#1{%
1240 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1241 % \lastnode when called from \setref -> \pdfmkdest.
1242 \HyPsdSubst{(}{\realbackslash(}{#1}%
1243 \HyPsdSubst{)}{\realbackslash)}{#1}%
1248 \pdfcatalog{/PageMode /UseOutlines}%
1249 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1250 \def\dopdfimage#1#2#3{%
1251 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1252 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1253 % without \immediate, pdftex seg faults when the same image is
1254 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1255 \ifnum\pdftexversion < 14
1258 \immediate\pdfximage
1260 \ifdim \wd0 >0pt width \imagewidth \fi
1261 \ifdim \wd2 >0pt height \imageheight \fi
1262 \ifnum\pdftexversion<13
1267 \ifnum\pdftexversion < 14 \else
1268 \pdfrefximage \pdflastximage
1271 % We have to set dummies so commands such as @code, and characters
1272 % such as \, aren't expanded when present in a section title.
1274 \activebackslashdouble
1275 \def\pdfdestname{#1}%
1276 \backslashparens\pdfdestname
1277 \pdfdest name{\pdfdestname} xyz%
1280 % used to mark target names; must be expandable.
1281 \def\pdfmkpgn#1{#1}%
1283 \let\linkcolor = \Blue % was Cyan, but that seems light?
1284 \def\endlink{\Black\pdfendlink}
1285 % Adding outlines to PDF; macros for calculating structure of outlines
1286 % come from Petr Olsak
1287 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1288 \else \csname#1\endcsname \fi}
1289 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1290 \advance\tempnum by 1
1291 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1293 % #1 is the section text, which is what will be displayed in the
1294 % outline by the pdf viewer. #2 is the pdf expression for the number
1295 % of subentries (or empty, for subsubsections). #3 is the node text,
1296 % which might be empty if this toc entry had no corresponding node.
1297 % #4 is the page number
1299 \def\dopdfoutline#1#2#3#4{%
1300 % Generate a link to the node text if that exists; else, use the
1301 % page number. We could generate a destination for the section
1302 % text in the case where a section has no node, but it doesn't
1303 % seem worth the trouble, since most documents are normally structured.
1304 \def\pdfoutlinedest{#3}%
1305 \ifx\pdfoutlinedest\empty
1306 \def\pdfoutlinedest{#4}%
1308 % Doubled backslashes in the name.
1309 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1310 \backslashparens\pdfoutlinedest}%
1313 % Also double the backslashes in the display string.
1314 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1315 \backslashparens\pdfoutlinetext}%
1317 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1320 \def\pdfmakeoutlines{%
1322 % Thanh's hack / proper braces in bookmarks
1323 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1324 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1326 % Read toc silently, to get counts of subentries for \pdfoutline.
1327 \def\numchapentry##1##2##3##4{%
1328 \def\thischapnum{##2}%
1330 \def\thissubsecnum{0}%
1332 \def\numsecentry##1##2##3##4{%
1333 \advancenumber{chap\thischapnum}%
1334 \def\thissecnum{##2}%
1335 \def\thissubsecnum{0}%
1337 \def\numsubsecentry##1##2##3##4{%
1338 \advancenumber{sec\thissecnum}%
1339 \def\thissubsecnum{##2}%
1341 \def\numsubsubsecentry##1##2##3##4{%
1342 \advancenumber{subsec\thissubsecnum}%
1344 \def\thischapnum{0}%
1346 \def\thissubsecnum{0}%
1348 % use \def rather than \let here because we redefine \chapentry et
1349 % al. a second time, below.
1350 \def\appentry{\numchapentry}%
1351 \def\appsecentry{\numsecentry}%
1352 \def\appsubsecentry{\numsubsecentry}%
1353 \def\appsubsubsecentry{\numsubsubsecentry}%
1354 \def\unnchapentry{\numchapentry}%
1355 \def\unnsecentry{\numsecentry}%
1356 \def\unnsubsecentry{\numsubsecentry}%
1357 \def\unnsubsubsecentry{\numsubsubsecentry}%
1360 % Read toc second time, this time actually producing the outlines.
1361 % The `-' means take the \expnumber as the absolute number of
1362 % subentries, which we calculated on our first read of the .toc above.
1364 % We use the node names as the destinations.
1365 \def\numchapentry##1##2##3##4{%
1366 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1367 \def\numsecentry##1##2##3##4{%
1368 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1369 \def\numsubsecentry##1##2##3##4{%
1370 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1371 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1372 \dopdfoutline{##1}{}{##3}{##4}}%
1374 % PDF outlines are displayed using system fonts, instead of
1375 % document fonts. Therefore we cannot use special characters,
1376 % since the encoding is unknown. For example, the eogonek from
1377 % Latin 2 (0xea) gets translated to a | character. Info from
1378 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1380 % xx to do this right, we have to translate 8-bit characters to
1381 % their "best" equivalent, based on the @documentencoding. Right
1382 % now, I guess we'll just let the pdf reader have its way.
1385 \catcode`\\=\active \otherbackslash
1390 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1391 \ifx\PP\D\let\nextsp\relax
1392 \else\let\nextsp\skipspaces
1393 \ifx\p\space\else\addtokens{\filename}{\PP}%
1394 \advance\filenamelength by 1
1398 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1399 \ifnum\pdftexversion < 14
1400 \let \startlink \pdfannotlink
1402 \let \startlink \pdfstartlink
1404 % make a live url in pdf output.
1407 % it seems we really need yet another set of dummies; have not
1408 % tried to figure out what each command should do in the context
1409 % of @url. for now, just make @/ a no-op, that's the only one
1410 % people have actually reported a problem with.
1412 \normalturnoffactive
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}}
1486 \newdimen\textleading \textleading = 13.2pt
1488 % Set the baselineskip to #1, and the lineskip and strut size
1489 % correspondingly. There is no deep meaning behind these magic numbers
1490 % used as factors; they just match (closely enough) what Knuth defined.
1492 \def\lineskipfactor{.08333}
1493 \def\strutheightpercent{.70833}
1494 \def\strutdepthpercent {.29167}
1497 \normalbaselineskip = #1\relax
1498 \normallineskip = \lineskipfactor\normalbaselineskip
1500 \setbox\strutbox =\hbox{%
1501 \vrule width0pt height\strutheightpercent\baselineskip
1502 depth \strutdepthpercent \baselineskip
1507 % Set the font macro #1 to the font named #2, adding on the
1508 % specified font prefix (normally `cm').
1509 % #3 is the font's design size, #4 is a scale factor
1510 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1513 % Use cm as the default font prefix.
1514 % To specify the font prefix, you must define \fontprefix
1515 % before you read in texinfo.tex.
1516 \ifx\fontprefix\undefined
1519 % Support font families that don't use the same naming scheme as CM.
1521 \def\rmbshape{bx} %where the normal face is bold
1526 \def\ttslshape{sltt}
1536 % Definitions for a main text size of 11pt. This is the default in
1539 \def\definetextfontsizexi{
1540 % Text fonts (11.2pt, magstep1).
1541 \def\textnominalsize{11pt}
1542 \edef\mainmagstep{\magstephalf}
1543 \setfont\textrm\rmshape{10}{\mainmagstep}
1544 \setfont\texttt\ttshape{10}{\mainmagstep}
1545 \setfont\textbf\bfshape{10}{\mainmagstep}
1546 \setfont\textit\itshape{10}{\mainmagstep}
1547 \setfont\textsl\slshape{10}{\mainmagstep}
1548 \setfont\textsf\sfshape{10}{\mainmagstep}
1549 \setfont\textsc\scshape{10}{\mainmagstep}
1550 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1551 \font\texti=cmmi10 scaled \mainmagstep
1552 \font\textsy=cmsy10 scaled \mainmagstep
1554 % A few fonts for @defun names and args.
1555 \setfont\defbf\bfshape{10}{\magstep1}
1556 \setfont\deftt\ttshape{10}{\magstep1}
1557 \setfont\defttsl\ttslshape{10}{\magstep1}
1558 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1560 % Fonts for indices, footnotes, small examples (9pt).
1561 \def\smallnominalsize{9pt}
1562 \setfont\smallrm\rmshape{9}{1000}
1563 \setfont\smalltt\ttshape{9}{1000}
1564 \setfont\smallbf\bfshape{10}{900}
1565 \setfont\smallit\itshape{9}{1000}
1566 \setfont\smallsl\slshape{9}{1000}
1567 \setfont\smallsf\sfshape{9}{1000}
1568 \setfont\smallsc\scshape{10}{900}
1569 \setfont\smallttsl\ttslshape{10}{900}
1573 % Fonts for small examples (8pt).
1574 \def\smallernominalsize{8pt}
1575 \setfont\smallerrm\rmshape{8}{1000}
1576 \setfont\smallertt\ttshape{8}{1000}
1577 \setfont\smallerbf\bfshape{10}{800}
1578 \setfont\smallerit\itshape{8}{1000}
1579 \setfont\smallersl\slshape{8}{1000}
1580 \setfont\smallersf\sfshape{8}{1000}
1581 \setfont\smallersc\scshape{10}{800}
1582 \setfont\smallerttsl\ttslshape{10}{800}
1583 \font\smalleri=cmmi8
1584 \font\smallersy=cmsy8
1586 % Fonts for title page (20.4pt):
1587 \def\titlenominalsize{20pt}
1588 \setfont\titlerm\rmbshape{12}{\magstep3}
1589 \setfont\titleit\itbshape{10}{\magstep4}
1590 \setfont\titlesl\slbshape{10}{\magstep4}
1591 \setfont\titlett\ttbshape{12}{\magstep3}
1592 \setfont\titlettsl\ttslshape{10}{\magstep4}
1593 \setfont\titlesf\sfbshape{17}{\magstep1}
1594 \let\titlebf=\titlerm
1595 \setfont\titlesc\scbshape{10}{\magstep4}
1596 \font\titlei=cmmi12 scaled \magstep3
1597 \font\titlesy=cmsy10 scaled \magstep4
1598 \def\authorrm{\secrm}
1599 \def\authortt{\sectt}
1601 % Chapter (and unnumbered) fonts (17.28pt).
1602 \def\chapnominalsize{17pt}
1603 \setfont\chaprm\rmbshape{12}{\magstep2}
1604 \setfont\chapit\itbshape{10}{\magstep3}
1605 \setfont\chapsl\slbshape{10}{\magstep3}
1606 \setfont\chaptt\ttbshape{12}{\magstep2}
1607 \setfont\chapttsl\ttslshape{10}{\magstep3}
1608 \setfont\chapsf\sfbshape{17}{1000}
1610 \setfont\chapsc\scbshape{10}{\magstep3}
1611 \font\chapi=cmmi12 scaled \magstep2
1612 \font\chapsy=cmsy10 scaled \magstep3
1614 % Section fonts (14.4pt).
1615 \def\secnominalsize{14pt}
1616 \setfont\secrm\rmbshape{12}{\magstep1}
1617 \setfont\secit\itbshape{10}{\magstep2}
1618 \setfont\secsl\slbshape{10}{\magstep2}
1619 \setfont\sectt\ttbshape{12}{\magstep1}
1620 \setfont\secttsl\ttslshape{10}{\magstep2}
1621 \setfont\secsf\sfbshape{12}{\magstep1}
1623 \setfont\secsc\scbshape{10}{\magstep2}
1624 \font\seci=cmmi12 scaled \magstep1
1625 \font\secsy=cmsy10 scaled \magstep2
1627 % Subsection fonts (13.15pt).
1628 \def\ssecnominalsize{13pt}
1629 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1630 \setfont\ssecit\itbshape{10}{1315}
1631 \setfont\ssecsl\slbshape{10}{1315}
1632 \setfont\ssectt\ttbshape{12}{\magstephalf}
1633 \setfont\ssecttsl\ttslshape{10}{1315}
1634 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1636 \setfont\ssecsc\scbshape{10}{1315}
1637 \font\sseci=cmmi12 scaled \magstephalf
1638 \font\ssecsy=cmsy10 scaled 1315
1640 % Reduced fonts for @acro in text (10pt).
1641 \def\reducednominalsize{10pt}
1642 \setfont\reducedrm\rmshape{10}{1000}
1643 \setfont\reducedtt\ttshape{10}{1000}
1644 \setfont\reducedbf\bfshape{10}{1000}
1645 \setfont\reducedit\itshape{10}{1000}
1646 \setfont\reducedsl\slshape{10}{1000}
1647 \setfont\reducedsf\sfshape{10}{1000}
1648 \setfont\reducedsc\scshape{10}{1000}
1649 \setfont\reducedttsl\ttslshape{10}{1000}
1650 \font\reducedi=cmmi10
1651 \font\reducedsy=cmsy10
1653 % reset the current fonts
1656 } % end of 11pt text font size definitions
1659 % Definitions to make the main text be 10pt Computer Modern, with
1660 % section, chapter, etc., sizes following suit. This is for the GNU
1661 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1662 % future. Used with @smallbook, which sets the leading to 12pt.
1664 \def\definetextfontsizex{%
1665 % Text fonts (10pt).
1666 \def\textnominalsize{10pt}
1667 \edef\mainmagstep{1000}
1668 \setfont\textrm\rmshape{10}{\mainmagstep}
1669 \setfont\texttt\ttshape{10}{\mainmagstep}
1670 \setfont\textbf\bfshape{10}{\mainmagstep}
1671 \setfont\textit\itshape{10}{\mainmagstep}
1672 \setfont\textsl\slshape{10}{\mainmagstep}
1673 \setfont\textsf\sfshape{10}{\mainmagstep}
1674 \setfont\textsc\scshape{10}{\mainmagstep}
1675 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1676 \font\texti=cmmi10 scaled \mainmagstep
1677 \font\textsy=cmsy10 scaled \mainmagstep
1679 % A few fonts for @defun names and args.
1680 \setfont\defbf\bfshape{10}{\magstephalf}
1681 \setfont\deftt\ttshape{10}{\magstephalf}
1682 \setfont\defttsl\ttslshape{10}{\magstephalf}
1683 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1685 % Fonts for indices, footnotes, small examples (9pt).
1686 \def\smallnominalsize{9pt}
1687 \setfont\smallrm\rmshape{9}{1000}
1688 \setfont\smalltt\ttshape{9}{1000}
1689 \setfont\smallbf\bfshape{10}{900}
1690 \setfont\smallit\itshape{9}{1000}
1691 \setfont\smallsl\slshape{9}{1000}
1692 \setfont\smallsf\sfshape{9}{1000}
1693 \setfont\smallsc\scshape{10}{900}
1694 \setfont\smallttsl\ttslshape{10}{900}
1698 % Fonts for small examples (8pt).
1699 \def\smallernominalsize{8pt}
1700 \setfont\smallerrm\rmshape{8}{1000}
1701 \setfont\smallertt\ttshape{8}{1000}
1702 \setfont\smallerbf\bfshape{10}{800}
1703 \setfont\smallerit\itshape{8}{1000}
1704 \setfont\smallersl\slshape{8}{1000}
1705 \setfont\smallersf\sfshape{8}{1000}
1706 \setfont\smallersc\scshape{10}{800}
1707 \setfont\smallerttsl\ttslshape{10}{800}
1708 \font\smalleri=cmmi8
1709 \font\smallersy=cmsy8
1711 % Fonts for title page (20.4pt):
1712 \def\titlenominalsize{20pt}
1713 \setfont\titlerm\rmbshape{12}{\magstep3}
1714 \setfont\titleit\itbshape{10}{\magstep4}
1715 \setfont\titlesl\slbshape{10}{\magstep4}
1716 \setfont\titlett\ttbshape{12}{\magstep3}
1717 \setfont\titlettsl\ttslshape{10}{\magstep4}
1718 \setfont\titlesf\sfbshape{17}{\magstep1}
1719 \let\titlebf=\titlerm
1720 \setfont\titlesc\scbshape{10}{\magstep4}
1721 \font\titlei=cmmi12 scaled \magstep3
1722 \font\titlesy=cmsy10 scaled \magstep4
1723 \def\authorrm{\secrm}
1724 \def\authortt{\sectt}
1726 % Chapter fonts (14.4pt).
1727 \def\chapnominalsize{14pt}
1728 \setfont\chaprm\rmbshape{12}{\magstep1}
1729 \setfont\chapit\itbshape{10}{\magstep2}
1730 \setfont\chapsl\slbshape{10}{\magstep2}
1731 \setfont\chaptt\ttbshape{12}{\magstep1}
1732 \setfont\chapttsl\ttslshape{10}{\magstep2}
1733 \setfont\chapsf\sfbshape{12}{\magstep1}
1735 \setfont\chapsc\scbshape{10}{\magstep2}
1736 \font\chapi=cmmi12 scaled \magstep1
1737 \font\chapsy=cmsy10 scaled \magstep2
1739 % Section fonts (12pt).
1740 \def\secnominalsize{12pt}
1741 \setfont\secrm\rmbshape{12}{1000}
1742 \setfont\secit\itbshape{10}{\magstep1}
1743 \setfont\secsl\slbshape{10}{\magstep1}
1744 \setfont\sectt\ttbshape{12}{1000}
1745 \setfont\secttsl\ttslshape{10}{\magstep1}
1746 \setfont\secsf\sfbshape{12}{1000}
1748 \setfont\secsc\scbshape{10}{\magstep1}
1750 \font\secsy=cmsy10 scaled \magstep1
1752 % Subsection fonts (10pt).
1753 \def\ssecnominalsize{10pt}
1754 \setfont\ssecrm\rmbshape{10}{1000}
1755 \setfont\ssecit\itbshape{10}{1000}
1756 \setfont\ssecsl\slbshape{10}{1000}
1757 \setfont\ssectt\ttbshape{10}{1000}
1758 \setfont\ssecttsl\ttslshape{10}{1000}
1759 \setfont\ssecsf\sfbshape{10}{1000}
1761 \setfont\ssecsc\scbshape{10}{1000}
1765 % Reduced fonts for @acro in text (9pt).
1766 \def\reducednominalsize{9pt}
1767 \setfont\reducedrm\rmshape{9}{1000}
1768 \setfont\reducedtt\ttshape{9}{1000}
1769 \setfont\reducedbf\bfshape{10}{900}
1770 \setfont\reducedit\itshape{9}{1000}
1771 \setfont\reducedsl\slshape{9}{1000}
1772 \setfont\reducedsf\sfshape{9}{1000}
1773 \setfont\reducedsc\scshape{10}{900}
1774 \setfont\reducedttsl\ttslshape{10}{900}
1775 \font\reducedi=cmmi9
1776 \font\reducedsy=cmsy9
1778 % reduce space between paragraphs
1779 \divide\parskip by 2
1781 % reset the current fonts
1784 } % end of 10pt text font size definitions
1787 % We provide the user-level command
1789 % (or 11) to redefine the text font size. pt is assumed.
1794 \parseargdef\fonttextsize{%
1795 \def\textsizearg{#1}%
1796 \wlog{doing @fonttextsize \textsizearg}%
1798 % Set \globaldefs so that documents can use this inside @tex, since
1799 % makeinfo 4.8 does not support it, but we need it nonetheless.
1801 \begingroup \globaldefs=1
1802 \ifx\textsizearg\xword \definetextfontsizex
1803 \else \ifx\textsizearg\xiword \definetextfontsizexi
1806 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1812 % In order for the font changes to affect most math symbols and letters,
1813 % we have to define the \textfont of the standard families. Since
1814 % texinfo doesn't allow for producing subscripts and superscripts except
1815 % in the main text, we don't bother to reset \scriptfont and
1816 % \scriptscriptfont (which would also require loading a lot more fonts).
1818 \def\resetmathfonts{%
1819 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1820 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1821 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1824 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1825 % of just \STYLE. We do this because \STYLE needs to also set the
1826 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1827 % \tenSTYLE to set the current font.
1829 % Each font-changing command also sets the names \lsize (one size lower)
1830 % and \lllsize (three sizes lower). These relative commands are used in
1831 % the LaTeX logo and acronyms.
1833 % This all needs generalizing, badly.
1836 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1837 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1838 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1839 \let\tenttsl=\textttsl
1840 \def\curfontsize{text}%
1841 \def\lsize{reduced}\def\lllsize{smaller}%
1842 \resetmathfonts \setleading{\textleading}}
1844 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1845 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1846 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1847 \let\tenttsl=\titlettsl
1848 \def\curfontsize{title}%
1849 \def\lsize{chap}\def\lllsize{subsec}%
1850 \resetmathfonts \setleading{25pt}}
1851 \def\titlefont#1{{\titlefonts\rm #1}}
1853 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1854 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1855 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1856 \let\tenttsl=\chapttsl
1857 \def\curfontsize{chap}%
1858 \def\lsize{sec}\def\lllsize{text}%
1859 \resetmathfonts \setleading{19pt}}
1861 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1862 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1863 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1864 \let\tenttsl=\secttsl
1865 \def\curfontsize{sec}%
1866 \def\lsize{subsec}\def\lllsize{reduced}%
1867 \resetmathfonts \setleading{16pt}}
1869 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1870 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1871 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1872 \let\tenttsl=\ssecttsl
1873 \def\curfontsize{ssec}%
1874 \def\lsize{text}\def\lllsize{small}%
1875 \resetmathfonts \setleading{15pt}}
1876 \let\subsubsecfonts = \subsecfonts
1878 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1879 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1880 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1881 \let\tenttsl=\reducedttsl
1882 \def\curfontsize{reduced}%
1883 \def\lsize{small}\def\lllsize{smaller}%
1884 \resetmathfonts \setleading{10.5pt}}
1886 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1887 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1888 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1889 \let\tenttsl=\smallttsl
1890 \def\curfontsize{small}%
1891 \def\lsize{smaller}\def\lllsize{smaller}%
1892 \resetmathfonts \setleading{10.5pt}}
1894 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1895 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1896 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1897 \let\tenttsl=\smallerttsl
1898 \def\curfontsize{smaller}%
1899 \def\lsize{smaller}\def\lllsize{smaller}%
1900 \resetmathfonts \setleading{9.5pt}}
1902 % Set the fonts to use with the @small... environments.
1903 \let\smallexamplefonts = \smallfonts
1905 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1906 % can fit this many characters:
1907 % 8.5x11=86 smallbook=72 a4=90 a5=69
1908 % If we use \scriptfonts (8pt), then we can fit this many characters:
1909 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1910 % For me, subjectively, the few extra characters that fit aren't worth
1911 % the additional smallness of 8pt. So I'm making the default 9pt.
1913 % By the way, for comparison, here's what fits with @example (10pt):
1914 % 8.5x11=71 smallbook=60 a4=75 a5=58
1916 % I wish the USA used A4 paper.
1920 % Set up the default fonts, so we can use them for creating boxes.
1922 \definetextfontsizexi
1924 % Define these so they can be easily changed for other fonts.
1925 \def\angleleft{$\langle$}
1926 \def\angleright{$\rangle$}
1928 % Count depth in font-changes, for error checks
1929 \newcount\fontdepth \fontdepth=0
1931 % Fonts for short table of contents.
1932 \setfont\shortcontrm\rmshape{12}{1000}
1933 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1934 \setfont\shortcontsl\slshape{12}{1000}
1935 \setfont\shortconttt\ttshape{12}{1000}
1937 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1938 %% serif) and @ii for TeX italic
1940 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1941 % unless the following character is such as not to need one.
1942 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1943 \ptexslash\fi\fi\fi}
1944 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1945 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1947 % like \smartslanted except unconditionally uses \ttsl.
1948 % @var is set to this for defun arguments.
1949 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1951 % like \smartslanted except unconditionally use \sl. We never want
1952 % ttsl for book titles, do we?
1953 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1956 \let\slanted=\smartslanted
1957 \let\var=\smartslanted
1958 \let\dfn=\smartslanted
1959 \let\emph=\smartitalic
1961 % @b, explicit bold.
1965 % @sansserif, explicit sans.
1966 \def\sansserif#1{{\sf #1}}
1968 % We can't just use \exhyphenpenalty, because that only has effect at
1969 % the end of a paragraph. Restore normal hyphenation at the end of the
1970 % group within which \nohyphenation is presumably called.
1972 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1973 \def\restorehyphenation{\hyphenchar\font = `- }
1975 % Set sfcode to normal for the chars that usually have another value.
1976 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1977 % sometimes \x has an active definition that messes things up.
1979 \chardef\colonChar = `\:
1980 \chardef\commaChar = `\,
1981 \chardef\dotChar = `\.
1982 \chardef\exclamChar= `\!
1983 \chardef\questChar = `\?
1984 \chardef\semiChar = `\;
1987 \def\plainfrenchspacing{%
1988 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1989 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1990 \def\endofsentencespacefactor{1000}% for @. and friends
1992 \def\plainnonfrenchspacing{%
1993 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1994 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1995 \def\endofsentencespacefactor{3000}% for @. and friends
1998 \def\endofsentencespacefactor{3000}% default
2001 {\tt \rawbackslash \plainfrenchspacing #1}%
2004 \def\samp#1{`\tclose{#1}'\null}
2005 \setfont\keyrm\rmshape{8}{1000}
2007 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2008 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2009 \vbox{\hrule\kern-0.4pt
2010 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2012 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2013 % The old definition, with no lozenge:
2014 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2015 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2017 % @file, @option are the same as @samp.
2021 % @code is a modification of @t,
2022 % which makes spaces the same size as normal in the surrounding text.
2025 % Change normal interword space to be same as for the current font.
2026 \spaceskip = \fontdimen2\font
2028 % Switch to typewriter.
2031 % But `\ ' produces the large typewriter interword space.
2032 \def\ {{\spaceskip = 0pt{} }}%
2034 % Turn off hyphenation.
2044 % We *must* turn on hyphenation at `-' and `_' in @code.
2045 % Otherwise, it is too hard to avoid overfull hboxes
2046 % in the Emacs manual, the Library manual, etc.
2048 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2049 % both hyphenation at - and hyphenation within words.
2050 % We must therefore turn them both off (\tclose does that)
2051 % and arrange explicitly to hyphenate at a dash.
2058 \global\def\code{\begingroup
2059 \catcode`\-=\active \catcode`\_=\active
2061 \let'\singlequotechar
2074 \def\codedash{-\discretionary{}{}{}}
2076 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2077 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2078 % will therefore expand the active definition of _, which is us
2079 % (inside @code that is), therefore an endless loop.
2081 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2082 \else\normalunderscore \fi
2083 \discretionary{}{}{}}%
2086 \def\codex #1{\tclose{#1}\endgroup}
2088 % An additional complication: the above will allow breaks after, e.g.,
2089 % each of the four underscores in __typeof__. This is undesirable in
2090 % some manuals, especially if they don't have long identifiers in
2091 % general. @allowcodebreaks provides a way to control this.
2093 \newif\ifallowcodebreaks \allowcodebreakstrue
2095 \def\keywordtrue{true}
2096 \def\keywordfalse{false}
2098 \parseargdef\allowcodebreaks{%
2100 \ifx\txiarg\keywordtrue
2101 \allowcodebreakstrue
2102 \else\ifx\txiarg\keywordfalse
2103 \allowcodebreaksfalse
2105 \errhelp = \EMsimple
2106 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2110 % @kbd is like @code, except that if the argument is just one @key command,
2111 % then @kbd has no effect.
2113 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2114 % `example' (@kbd uses ttsl only inside of @example and friends),
2115 % or `code' (@kbd uses normal tty font always).
2116 \parseargdef\kbdinputstyle{%
2118 \ifx\txiarg\worddistinct
2119 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2120 \else\ifx\txiarg\wordexample
2121 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2122 \else\ifx\txiarg\wordcode
2123 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2125 \errhelp = \EMsimple
2126 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2129 \def\worddistinct{distinct}
2130 \def\wordexample{example}
2133 % Default is `distinct.'
2134 \kbdinputstyle distinct
2137 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2138 \ifx\one\xkey\ifx\threex\three \key{#2}%
2139 \else{\tclose{\kbdfont\look}}\fi
2140 \else{\tclose{\kbdfont\look}}\fi}
2142 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2143 \let\indicateurl=\code
2147 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2148 % second argument specifying the text to display and an optional third
2149 % arg as text to display instead of (rather than in addition to) the url
2150 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2151 % a hypertex \special here.
2153 \def\uref#1{\douref #1,,,\finish}
2154 \def\douref#1,#2,#3,#4\finish{\begingroup
2157 \setbox0 = \hbox{\ignorespaces #3}%
2159 \unhbox0 % third arg given, show only that
2161 \setbox0 = \hbox{\ignorespaces #2}%
2164 \unhbox0 % PDF: 2nd arg given, show only it
2166 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2169 \code{#1}% only url given, so show it
2175 % @url synonym for @uref, since that's how everyone uses it.
2179 % rms does not like angle brackets --karl, 17may97.
2180 % So now @email is just like @uref, unless we are pdf.
2182 %\def\email#1{\angleleft{\tt #1}\angleright}
2184 \def\email#1{\doemail#1,,\finish}
2185 \def\doemail#1,#2,#3\finish{\begingroup
2188 \setbox0 = \hbox{\ignorespaces #2}%
2189 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2196 % Check if we are currently using a typewriter font. Since all the
2197 % Computer Modern typewriter fonts have zero interword stretch (and
2198 % shrink), and it is reasonable to expect all typewriter fonts to have
2199 % this property, we can check that font parameter.
2201 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2203 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2204 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2206 \def\dmn#1{\thinspace #1}
2208 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2210 % @l was never documented to mean ``switch to the Lisp font'',
2211 % and it is not used as such in any manual I can find. We need it for
2212 % Polish suppressed-l. --karl, 22sep96.
2213 %\def\l#1{{\li #1}\null}
2215 % Explicit font changes: @r, @sc, undocumented @ii.
2216 \def\r#1{{\rm #1}} % roman font
2217 \def\sc#1{{\smallcaps#1}} % smallcaps font
2218 \def\ii#1{{\it #1}} % italic font
2220 % @acronym for "FBI", "NATO", and the like.
2221 % We print this one point size smaller, since it's intended for
2224 \def\acronym#1{\doacronym #1,,\finish}
2225 \def\doacronym#1,#2,#3\finish{%
2226 {\selectfonts\lsize #1}%
2228 \ifx\temp\empty \else
2229 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2233 % @abbr for "Comput. J." and the like.
2234 % No font change, but don't do end-of-sentence spacing.
2236 \def\abbr#1{\doabbr #1,,\finish}
2237 \def\doabbr#1,#2,#3\finish{%
2238 {\plainfrenchspacing #1}%
2240 \ifx\temp\empty \else
2241 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2245 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2247 \def\pounds{{\it\$}}
2249 % @euro{} comes from a separate font, depending on the current style.
2250 % We use the free feym* fonts from the eurosym package by Henrik
2251 % Theiling, which support regular, slanted, bold and bold slanted (and
2252 % "outlined" (blackboard board, sort of) versions, which we don't need).
2253 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2255 % Although only regular is the truly official Euro symbol, we ignore
2256 % that. The Euro is designed to be slightly taller than the regular
2262 % feybo - bold slanted
2264 % There is no good (free) typewriter version, to my knowledge.
2265 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2268 % Also doesn't work in math. Do we need to do math with euro symbols?
2272 \def\euro{{\eurofont e}}
2274 % We set the font at each command, rather than predefining it in
2275 % \textfonts and the other font-switching commands, so that
2276 % installations which never need the symbol don't have to have the
2279 % There is only one designed size (nominal 10pt), so we always scale
2280 % that to the current nominal size.
2282 % By the way, simply using "at 1em" works for cmr10 and the like, but
2283 % does not work for cmbx10 and other extended/shrunken fonts.
2285 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2287 \ifx\curfontstyle\bfstylename
2289 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2292 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2297 % @registeredsymbol - R in a circle. The font for the R should really
2298 % be smaller yet, but lllsize is the best we can do for now.
2299 % Adapted from the plain.tex definition of \copyright.
2301 \def\registeredsymbol{%
2302 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2307 % Laurent Siebenmann reports \Orb undefined with:
2308 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2309 % so we'll define it if necessary.
2312 \def\Orb{\mathhexbox20D}
2316 \message{page headings,}
2318 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2319 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2321 % First the title page. Must do @settitle before @titlepage.
2323 \newif\iffinishedtitlepage
2325 % Do an implicit @contents or @shortcontents after @end titlepage if the
2326 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2328 \newif\ifsetcontentsaftertitlepage
2329 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2330 \newif\ifsetshortcontentsaftertitlepage
2331 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2333 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2334 \endgroup\page\hbox{}\page}
2337 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2339 \parindent=0pt \textfonts
2340 % Leave some space at the very top of the page.
2341 \vglue\titlepagetopglue
2342 % No rule at page bottom unless we print one at the top with @title.
2343 \finishedtitlepagetrue
2345 % Most title ``pages'' are actually two pages long, with space
2346 % at the top of the second. We don't want the ragged left on the second.
2347 \let\oldpage = \page
2349 \iffinishedtitlepage\else
2352 \let\page = \oldpage
2359 \iffinishedtitlepage\else
2362 % It is important to do the page break before ending the group,
2363 % because the headline and footline are only empty inside the group.
2364 % If we use the new definition of \page, we always get a blank page
2365 % after the title page, which we certainly don't want.
2369 % Need this before the \...aftertitlepage checks so that if they are
2370 % in effect the toc pages will come out with page numbers.
2373 % If they want short, they certainly want long too.
2374 \ifsetshortcontentsaftertitlepage
2377 \global\let\shortcontents = \relax
2378 \global\let\contents = \relax
2381 \ifsetcontentsaftertitlepage
2383 \global\let\contents = \relax
2384 \global\let\shortcontents = \relax
2388 \def\finishtitlepage{%
2389 \vskip4pt \hrule height 2pt width \hsize
2390 \vskip\titlepagebottomglue
2391 \finishedtitlepagetrue
2394 %%% Macros to be used within @titlepage:
2396 \let\subtitlerm=\tenrm
2397 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2399 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2402 \parseargdef\title{%
2404 \leftline{\titlefonts\rm #1}
2405 % print a rule at the page bottom also.
2406 \finishedtitlepagefalse
2407 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2410 \parseargdef\subtitle{%
2412 {\subtitlefont \rightline{#1}}%
2415 % @author should come last, but may come many times.
2416 % It can also be used inside @quotation.
2418 \parseargdef\author{%
2419 \def\temp{\quotation}%
2421 \def\quotationauthor{#1}% printed in \Equotation.
2424 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2425 {\authorfont \leftline{#1}}%
2430 %%% Set up page headings and footings.
2432 \let\thispage=\folio
2434 \newtoks\evenheadline % headline on even pages
2435 \newtoks\oddheadline % headline on odd pages
2436 \newtoks\evenfootline % footline on even pages
2437 \newtoks\oddfootline % footline on odd pages
2439 % Now make TeX use those variables
2440 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2441 \else \the\evenheadline \fi}}
2442 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2443 \else \the\evenfootline \fi}\HEADINGShook}
2444 \let\HEADINGShook=\relax
2446 % Commands to set those variables.
2447 % For example, this is what @headings on does
2448 % @evenheading @thistitle|@thispage|@thischapter
2449 % @oddheading @thischapter|@thispage|@thistitle
2450 % @evenfooting @thisfile||
2451 % @oddfooting ||@thisfile
2454 \def\evenheading{\parsearg\evenheadingxxx}
2455 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2456 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2457 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2459 \def\oddheading{\parsearg\oddheadingxxx}
2460 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2461 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2462 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2464 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2466 \def\evenfooting{\parsearg\evenfootingxxx}
2467 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2468 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2469 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2471 \def\oddfooting{\parsearg\oddfootingxxx}
2472 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2473 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2474 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2476 % Leave some space for the footline. Hopefully ok to assume
2477 % @evenfooting will not be used by itself.
2478 \global\advance\pageheight by -\baselineskip
2479 \global\advance\vsize by -\baselineskip
2482 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2485 % @headings double turns headings on for double-sided printing.
2486 % @headings single turns headings on for single-sided printing.
2487 % @headings off turns them off.
2488 % @headings on same as @headings double, retained for compatibility.
2489 % @headings after turns on double-sided headings after this page.
2490 % @headings doubleafter turns on double-sided headings after this page.
2491 % @headings singleafter turns on single-sided headings after this page.
2492 % By default, they are off at the start of a document,
2493 % and turned `on' after @end titlepage.
2495 \def\headings #1 {\csname HEADINGS#1\endcsname}
2498 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2499 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2501 % When we turn headings on, set the page number to 1.
2502 % For double-sided printing, put current file name in lower left corner,
2503 % chapter name on inside top of right hand pages, document
2504 % title on inside top of left hand pages, and page numbers on outside top
2505 % edge of all pages.
2506 \def\HEADINGSdouble{%
2508 \global\evenfootline={\hfil}
2509 \global\oddfootline={\hfil}
2510 \global\evenheadline={\line{\folio\hfil\thistitle}}
2511 \global\oddheadline={\line{\thischapter\hfil\folio}}
2512 \global\let\contentsalignmacro = \chapoddpage
2514 \let\contentsalignmacro = \chappager
2516 % For single-sided printing, chapter title goes across top left of page,
2517 % page number on top right.
2518 \def\HEADINGSsingle{%
2520 \global\evenfootline={\hfil}
2521 \global\oddfootline={\hfil}
2522 \global\evenheadline={\line{\thischapter\hfil\folio}}
2523 \global\oddheadline={\line{\thischapter\hfil\folio}}
2524 \global\let\contentsalignmacro = \chappager
2526 \def\HEADINGSon{\HEADINGSdouble}
2528 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2529 \let\HEADINGSdoubleafter=\HEADINGSafter
2530 \def\HEADINGSdoublex{%
2531 \global\evenfootline={\hfil}
2532 \global\oddfootline={\hfil}
2533 \global\evenheadline={\line{\folio\hfil\thistitle}}
2534 \global\oddheadline={\line{\thischapter\hfil\folio}}
2535 \global\let\contentsalignmacro = \chapoddpage
2538 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2539 \def\HEADINGSsinglex{%
2540 \global\evenfootline={\hfil}
2541 \global\oddfootline={\hfil}
2542 \global\evenheadline={\line{\thischapter\hfil\folio}}
2543 \global\oddheadline={\line{\thischapter\hfil\folio}}
2544 \global\let\contentsalignmacro = \chappager
2547 % Subroutines used in generating headings
2548 % This produces Day Month Year style of output.
2549 % Only define if not already defined, in case a txi-??.tex file has set
2550 % up a different format (e.g., txi-cs.tex does this).
2551 \ifx\today\undefined
2555 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2556 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2557 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2562 % @settitle line... specifies the title of the document, for headings.
2563 % It generates no output of its own.
2564 \def\thistitle{\putwordNoTitle}
2565 \def\settitle{\parsearg{\gdef\thistitle}}
2569 % Tables -- @table, @ftable, @vtable, @item(x).
2571 % default indentation of table text
2572 \newdimen\tableindent \tableindent=.8in
2573 % default indentation of @itemize and @enumerate text
2574 \newdimen\itemindent \itemindent=.3in
2575 % margin between end of table item and start of table text.
2576 \newdimen\itemmargin \itemmargin=.1in
2578 % used internally for \itemindent minus \itemmargin
2581 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2583 % They also define \itemindex
2584 % to index the item name in whatever manner is desired (perhaps none).
2586 \newif\ifitemxneedsnegativevskip
2588 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2590 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2591 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2593 \def\itemzzz #1{\begingroup %
2594 \advance\hsize by -\rightskip
2595 \advance\hsize by -\tableindent
2596 \setbox0=\hbox{\itemindicate{#1}}%
2598 \nobreak % This prevents a break before @itemx.
2600 % If the item text does not fit in the space we have, put it on a line
2601 % by itself, and do not allow a page break either before or after that
2602 % line. We do not start a paragraph here because then if the next
2603 % command is, e.g., @kindex, the whatsit would get put into the
2604 % horizontal list on a line by itself, resulting in extra blank space.
2605 \ifdim \wd0>\itemmax
2607 % Make this a paragraph so we get the \parskip glue and wrapping,
2608 % but leave it ragged-right.
2610 \advance\leftskip by-\tableindent
2611 \advance\hsize by\tableindent
2612 \advance\rightskip by0pt plus1fil
2613 \leavevmode\unhbox0\par
2616 % We're going to be starting a paragraph, but we don't want the
2617 % \parskip glue -- logically it's part of the @item we just started.
2618 \nobreak \vskip-\parskip
2620 % Stop a page break at the \parskip glue coming up. However, if
2621 % what follows is an environment such as @example, there will be no
2622 % \parskip glue; then the negative vskip we just inserted would
2623 % cause the example and the item to crash together. So we use this
2624 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2625 % \parskip glue after all. Section titles are handled this way also.
2629 \itemxneedsnegativevskipfalse
2631 % The item text fits into the space. Start a paragraph, so that the
2632 % following text (if any) will end up on the same line.
2634 % Do this with kerns and \unhbox so that if there is a footnote in
2635 % the item text, it can migrate to the main vertical list and
2636 % eventually be printed.
2637 \nobreak\kern-\tableindent
2638 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2640 \nobreak\kern\dimen0
2642 \itemxneedsnegativevskiptrue
2646 \def\item{\errmessage{@item while not in a list environment}}
2647 \def\itemx{\errmessage{@itemx while not in a list environment}}
2649 % @table, @ftable, @vtable.
2651 \let\itemindex\gobble
2655 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2656 \tablecheck{ftable}%
2659 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2660 \tablecheck{vtable}%
2663 \ifnum \the\catcode`\^^M=\active
2665 \errmessage{This command won't work in this context; perhaps the problem is
2666 that we are \inenvironment\thisenv}%
2667 \def\next{\doignore{#1}}%
2674 \def\itemindicate{#1}%
2679 \makevalueexpandable
2680 \edef\temp{\noexpand\tablez #1\space\space\space}%
2684 \def\tablez #1 #2 #3 #4\endtablez{%
2686 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2687 \ifnum 0#2>0 \tableindent=#2\mil \fi
2688 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2689 \itemmax=\tableindent
2690 \advance \itemmax by -\itemmargin
2691 \advance \leftskip by \tableindent
2692 \exdentamount=\tableindent
2694 \parskip = \smallskipamount
2695 \ifdim \parskip=0pt \parskip=2pt \fi
2696 \let\item = \internalBitem
2697 \let\itemx = \internalBitemx
2699 \def\Etable{\endgraf\afterenvbreak}
2702 \let\Eitemize\Etable
2703 \let\Eenumerate\Etable
2705 % This is the counter used by @enumerate, which is really @itemize
2709 \envdef\itemize{\parsearg\doitemize}
2713 \itemmax=\itemindent
2714 \advance\itemmax by -\itemmargin
2715 \advance\leftskip by \itemindent
2716 \exdentamount=\itemindent
2718 \parskip=\smallskipamount
2719 \ifdim\parskip=0pt \parskip=2pt \fi
2720 \def\itemcontents{#1}%
2721 % @itemize with no arg is equivalent to @itemize @bullet.
2722 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2723 \let\item=\itemizeitem
2726 % Definition of @item while inside @itemize and @enumerate.
2729 \advance\itemno by 1 % for enumerations
2730 {\let\par=\endgraf \smallbreak}% reasonable place to break
2732 % If the document has an @itemize directly after a section title, a
2733 % \nobreak will be last on the list, and \sectionheading will have
2734 % done a \vskip-\parskip. In that case, we don't want to zero
2735 % parskip, or the item text will crash with the heading. On the
2736 % other hand, when there is normal text preceding the item (as there
2737 % usually is), we do want to zero parskip, or there would be too much
2738 % space. In that case, we won't have a \nobreak before. At least
2739 % that's the theory.
2740 \ifnum\lastpenalty<10000 \parskip=0in \fi
2742 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2743 \vadjust{\penalty 1200}}% not good to break after first line of item.
2747 % \splitoff TOKENS\endmark defines \first to be the first token in
2748 % TOKENS, and \rest to be the remainder.
2750 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2752 % Allow an optional argument of an uppercase letter, lowercase letter,
2753 % or number, to specify the first label in the enumerated list. No
2754 % argument is the same as `1'.
2756 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2757 \def\enumeratey #1 #2\endenumeratey{%
2758 % If we were given no argument, pretend we were given `1'.
2760 \ifx\thearg\empty \def\thearg{1}\fi
2762 % Detect if the argument is a single token. If so, it might be a
2763 % letter. Otherwise, the only valid thing it can be is a number.
2764 % (We will always have one token, because of the test we just made.
2765 % This is a good thing, since \splitoff doesn't work given nothing at
2766 % all -- the first parameter is undelimited.)
2767 \expandafter\splitoff\thearg\endmark
2769 % Only one token in the argument. It could still be anything.
2770 % A ``lowercase letter'' is one whose \lccode is nonzero.
2771 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2772 % not equal to itself.
2773 % Otherwise, we assume it's a number.
2775 % We need the \relax at the end of the \ifnum lines to stop TeX from
2776 % continuing to look for a <number>.
2778 \ifnum\lccode\expandafter`\thearg=0\relax
2779 \numericenumerate % a number (we hope)
2782 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2783 \lowercaseenumerate % lowercase letter
2785 \uppercaseenumerate % uppercase letter
2789 % Multiple tokens in the argument. We hope it's a number.
2794 % An @enumerate whose labels are integers. The starting integer is
2797 \def\numericenumerate{%
2799 \startenumeration{\the\itemno}%
2802 % The starting (lowercase) letter is in \thearg.
2803 \def\lowercaseenumerate{%
2804 \itemno = \expandafter`\thearg
2806 % Be sure we're not beyond the end of the alphabet.
2808 \errmessage{No more lowercase letters in @enumerate; get a bigger
2815 % The starting (uppercase) letter is in \thearg.
2816 \def\uppercaseenumerate{%
2817 \itemno = \expandafter`\thearg
2819 % Be sure we're not beyond the end of the alphabet.
2821 \errmessage{No more uppercase letters in @enumerate; get a bigger
2828 % Call \doitemize, adding a period to the first argument and supplying the
2829 % common last two arguments. Also subtract one from the initial value in
2830 % \itemno, since @item increments \itemno.
2832 \def\startenumeration#1{%
2833 \advance\itemno by -1
2834 \doitemize{#1.}\flushcr
2837 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2840 \def\alphaenumerate{\enumerate{a}}
2841 \def\capsenumerate{\enumerate{A}}
2842 \def\Ealphaenumerate{\Eenumerate}
2843 \def\Ecapsenumerate{\Eenumerate}
2846 % @multitable macros
2847 % Amy Hendrickson, 8/18/94, 3/6/96
2849 % @multitable ... @end multitable will make as many columns as desired.
2850 % Contents of each column will wrap at width given in preamble. Width
2851 % can be specified either with sample text given in a template line,
2852 % or in percent of \hsize, the current width of text on page.
2854 % Table can continue over pages but will only break between lines.
2858 % Either define widths of columns in terms of percent of \hsize:
2859 % @multitable @columnfractions .25 .3 .45
2862 % Numbers following @columnfractions are the percent of the total
2863 % current hsize to be used for each column. You may use as many
2864 % columns as desired.
2867 % Or use a template:
2868 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2870 % using the widest term desired in each column.
2872 % Each new table line starts with @item, each subsequent new column
2873 % starts with @tab. Empty columns may be produced by supplying @tab's
2874 % with nothing between them for as many times as empty columns are needed,
2875 % ie, @tab@tab@tab will produce two empty columns.
2877 % @item, @tab do not need to be on their own lines, but it will not hurt
2880 % Sample multitable:
2882 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2883 % @item first col stuff @tab second col stuff @tab third col
2890 % @item first col stuff @tab second col stuff
2891 % @tab Many paragraphs of text may be used in any column.
2893 % They will wrap at the width determined by the template.
2894 % @item@tab@tab This will be in third column.
2897 % Default dimensions may be reset by user.
2898 % @multitableparskip is vertical space between paragraphs in table.
2899 % @multitableparindent is paragraph indent in table.
2900 % @multitablecolmargin is horizontal space to be left between columns.
2901 % @multitablelinespace is space to leave between table items, baseline
2903 % 0pt means it depends on current normal line spacing.
2905 \newskip\multitableparskip
2906 \newskip\multitableparindent
2907 \newdimen\multitablecolspace
2908 \newskip\multitablelinespace
2909 \multitableparskip=0pt
2910 \multitableparindent=6pt
2911 \multitablecolspace=12pt
2912 \multitablelinespace=0pt
2914 % Macros used to set up halign preamble:
2916 \let\endsetuptable\relax
2917 \def\xendsetuptable{\endsetuptable}
2918 \let\columnfractions\relax
2919 \def\xcolumnfractions{\columnfractions}
2922 % #1 is the @columnfraction, usually a decimal number like .5, but might
2923 % be just 1. We just use it, whatever it is.
2925 \def\pickupwholefraction#1 {%
2926 \global\advance\colcount by 1
2927 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2934 \ifx\firstarg\xendsetuptable
2937 \ifx\firstarg\xcolumnfractions
2938 \global\setpercenttrue
2941 \let\go\pickupwholefraction
2943 \global\advance\colcount by 1
2944 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2945 % separator; typically that is always in the input, anyway.
2946 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2949 \ifx\go\pickupwholefraction
2950 % Put the argument back for the \pickupwholefraction call, so
2951 % we'll always have a period there to be parsed.
2952 \def\go{\pickupwholefraction#1}%
2954 \let\go = \setuptable
2960 % multitable-only commands.
2962 % @headitem starts a heading row, which we typeset in bold.
2963 % Assignments have to be global since we are inside the implicit group
2964 % of an alignment entry. Note that \everycr resets \everytab.
2965 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2967 % A \tab used to include \hskip1sp. But then the space in a template
2968 % line is not enough. That is bad. So let's go back to just `&' until
2969 % we encounter the problem it was intended to solve again.
2970 % --karl, nathan@acm.org, 20apr99.
2971 \def\tab{\checkenv\multitable &\the\everytab}%
2973 % @multitable ... @end multitable definitions:
2975 \newtoks\everytab % insert after every tab.
2977 \envdef\multitable{%
2981 % @item within a multitable starts a normal row.
2982 % We use \def instead of \let so that if one of the multitable entries
2983 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2984 % \endtemplate) expanding \doitemize.
2989 \setmultitablespacing
2990 \parskip=\multitableparskip
2991 \parindent=\multitableparindent
2997 \global\everytab={}%
2998 \global\colcount=0 % Reset the column counter.
2999 % Check for saved footnotes, etc.
3001 % Keeps underfull box messages off when table breaks over pages.
3003 % Maybe so, but it also creates really weird page breaks when the
3004 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3005 % problem manifests itself, so it can be fixed for real --karl.
3009 \parsearg\domultitable
3011 \def\domultitable#1{%
3012 % To parse everything between @multitable and @item:
3013 \setuptable#1 \endsetuptable
3015 % This preamble sets up a generic column definition, which will
3016 % be used as many times as user calls for columns.
3017 % \vtop will set a single line and will also let text wrap and
3018 % continue for many paragraphs if desired.
3020 \global\advance\colcount by 1
3023 % Use the current \colcount to find the correct column width:
3024 \hsize=\expandafter\csname col\the\colcount\endcsname
3026 % In order to keep entries from bumping into each other
3027 % we will add a \leftskip of \multitablecolspace to all columns after
3030 % If a template has been used, we will add \multitablecolspace
3031 % to the width of each template entry.
3033 % If the user has set preamble in terms of percent of \hsize we will
3034 % use that dimension as the width of the column, and the \leftskip
3035 % will keep entries from bumping into each other. Table will start at
3036 % left margin and final column will justify at right margin.
3038 % Make sure we don't inherit \rightskip from the outer environment.
3041 % The first column will be indented with the surrounding text.
3042 \advance\hsize by\leftskip
3045 % If user has not set preamble in terms of percent of \hsize
3046 % we will advance \hsize by \multitablecolspace.
3047 \advance\hsize by \multitablecolspace
3049 % In either case we will make \leftskip=\multitablecolspace:
3050 \leftskip=\multitablecolspace
3052 % Ignoring space at the beginning and end avoids an occasional spurious
3053 % blank line, when TeX decides to break the line at the space before the
3054 % box from the multistrut, so the strut ends up on a line by itself.
3056 % @multitable @columnfractions .11 .89
3058 % @tab Legal holiday which is valid in major parts of the whole country.
3059 % Is automatically provided with highlighting sequences respectively
3060 % marking characters.
3061 \noindent\ignorespaces##\unskip\multistrut
3066 \egroup % end the \halign
3067 \global\setpercentfalse
3070 \def\setmultitablespacing{%
3071 \def\multistrut{\strut}% just use the standard line spacing
3073 % Compute \multitablelinespace (if not defined by user) for use in
3074 % \multitableparskip calculation. We used define \multistrut based on
3075 % this, but (ironically) that caused the spacing to be off.
3076 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3077 \ifdim\multitablelinespace=0pt
3078 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3079 \global\advance\multitablelinespace by-\ht0
3081 %% Test to see if parskip is larger than space between lines of
3082 %% table. If not, do nothing.
3083 %% If so, set to same dimension as multitablelinespace.
3084 \ifdim\multitableparskip>\multitablelinespace
3085 \global\multitableparskip=\multitablelinespace
3086 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3087 %% than skip between lines in the table.
3089 \ifdim\multitableparskip=0pt
3090 \global\multitableparskip=\multitablelinespace
3091 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3092 %% than skip between lines in the table.
3096 \message{conditionals,}
3098 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3099 % @ifnotxml always succeed. They currently do nothing; we don't
3100 % attempt to check whether the conditionals are properly nested. But we
3101 % have to remember that they are conditionals, so that @end doesn't
3102 % attempt to close an environment group.
3105 \expandafter\let\csname #1\endcsname = \relax
3106 \expandafter\let\csname iscond.#1\endcsname = 1
3109 \makecond{ifnotdocbook}
3110 \makecond{ifnothtml}
3111 \makecond{ifnotinfo}
3112 \makecond{ifnotplaintext}
3115 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3117 \def\direntry{\doignore{direntry}}
3118 \def\documentdescription{\doignore{documentdescription}}
3119 \def\docbook{\doignore{docbook}}
3120 \def\html{\doignore{html}}
3121 \def\ifdocbook{\doignore{ifdocbook}}
3122 \def\ifhtml{\doignore{ifhtml}}
3123 \def\ifinfo{\doignore{ifinfo}}
3124 \def\ifnottex{\doignore{ifnottex}}
3125 \def\ifplaintext{\doignore{ifplaintext}}
3126 \def\ifxml{\doignore{ifxml}}
3127 \def\ignore{\doignore{ignore}}
3128 \def\menu{\doignore{menu}}
3129 \def\xml{\doignore{xml}}
3131 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3133 % A count to remember the depth of nesting.
3134 \newcount\doignorecount
3136 \def\doignore#1{\begingroup
3137 % Scan in ``verbatim'' mode:
3139 \catcode`\@ = \other
3140 \catcode`\{ = \other
3141 \catcode`\} = \other
3143 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3146 % Count number of #1's that we've seen.
3149 % Swallow text until we reach the matching `@end #1'.
3153 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3156 \gdef\dodoignore#1{%
3157 % #1 contains the command name as a string, e.g., `ifinfo'.
3159 % Define a command to find the next `@end #1'.
3160 \long\def\doignoretext##1^^M@end #1{%
3161 \doignoretextyyy##1^^M@#1\_STOP_}%
3163 % And this command to find another #1 command, at the beginning of a
3164 % line. (Otherwise, we would consider a line `@c @ifset', for
3165 % example, to count as an @ifset for nesting.)
3166 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3168 % And now expand that command.
3173 \def\doignoreyyy#1{%
3175 \ifx\temp\empty % Nothing found.
3176 \let\next\doignoretextzzz
3177 \else % Found a nested condition, ...
3178 \advance\doignorecount by 1
3179 \let\next\doignoretextyyy % ..., look for another.
3180 % If we're here, #1 ends with ^^M\ifinfo (for example).
3182 \next #1% the token \_STOP_ is present just after this macro.
3185 % We have to swallow the remaining "\_STOP_".
3187 \def\doignoretextzzz#1{%
3188 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3189 \let\next\enddoignore
3190 \else % Still inside a nested condition.
3191 \advance\doignorecount by -1
3192 \let\next\doignoretext % Look for the next @end.
3197 % Finish off ignored text.
3199 % Ignore anything after the last `@end #1'; this matters in verbatim
3200 % environments, where otherwise the newline after an ignored conditional
3201 % would result in a blank line in the output.
3202 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3206 % @set VAR sets the variable VAR to an empty value.
3207 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3209 % Since we want to separate VAR from REST-OF-LINE (which might be
3210 % empty), we can't just use \parsearg; we have to insert a space of our
3211 % own to delimit the rest of the line, and then take it out again if we
3213 % We rely on the fact that \parsearg sets \catcode`\ =10.
3215 \parseargdef\set{\setyyy#1 \endsetyyy}
3216 \def\setyyy#1 #2\endsetyyy{%
3218 \makevalueexpandable
3220 \edef\next{\gdef\makecsname{SET#1}}%
3228 % Remove the trailing space \setxxx inserted.
3229 \def\setzzz#1 \endsetzzz{\next{#1}}
3231 % @clear VAR clears (i.e., unsets) the variable VAR.
3233 \parseargdef\clear{%
3235 \makevalueexpandable
3236 \global\expandafter\let\csname SET#1\endcsname=\relax
3240 % @value{foo} gets the text saved in variable foo.
3241 \def\value{\begingroup\makevalueexpandable\valuexxx}
3242 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3244 \catcode`\- = \active \catcode`\_ = \active
3246 \gdef\makevalueexpandable{%
3247 \let\value = \expandablevalue
3248 % We don't want these characters active, ...
3249 \catcode`\-=\other \catcode`\_=\other
3250 % ..., but we might end up with active ones in the argument if
3251 % we're called from @code, as @code{@value{foo-bar_}}, though.
3252 % So \let them to their normal equivalents.
3253 \let-\realdash \let_\normalunderscore
3257 % We have this subroutine so that we can handle at least some @value's
3258 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3259 % The command has to be fully expandable (if the variable is set), since
3260 % the result winds up in the index file. This means that if the
3261 % variable's value contains other Texinfo commands, it's almost certain
3262 % it will fail (although perhaps we could fix that with sufficient work
3263 % to do a one-level expansion on the result, instead of complete).
3265 \def\expandablevalue#1{%
3266 \expandafter\ifx\csname SET#1\endcsname\relax
3267 {[No value for ``#1'']}%
3268 \message{Variable `#1', used in @value, is not set.}%
3270 \csname SET#1\endcsname
3274 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3277 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3280 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3283 \makevalueexpandable
3285 \expandafter\ifx\csname SET#2\endcsname\relax
3286 #1% If not set, redefine \next.
3291 \def\ifsetfail{\doignore{ifset}}
3293 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3294 % defined with @set, or has been undefined with @clear.
3296 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3297 % above code: if the variable is not set, do nothing, if it is set,
3298 % then redefine \next to \ifclearfail.
3301 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3302 \def\ifclearfail{\doignore{ifclear}}
3304 % @dircategory CATEGORY -- specify a category of the dir file
3305 % which this file should belong to. Ignore this in TeX.
3306 \let\dircategory=\comment
3308 % @defininfoenclose.
3309 \let\definfoenclose=\comment
3313 % Index generation facilities
3315 % Define \newwrite to be identical to plain tex's \newwrite
3316 % except not \outer, so it can be used within macros and \if's.
3317 \edef\newwrite{\makecsname{ptexnewwrite}}
3319 % \newindex {foo} defines an index named foo.
3320 % It automatically defines \fooindex such that
3321 % \fooindex ...rest of line... puts an entry in the index foo.
3322 % It also defines \fooindfile to be the number of the output channel for
3323 % the file that accumulates this index. The file's extension is foo.
3324 % The name of an index should be no more than 2 characters long
3325 % for the sake of vms.
3329 \expandafter\newwrite \csname#1indfile\endcsname
3330 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3332 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3333 \noexpand\doindex{#1}}
3336 % @defindex foo == \newindex{foo}
3338 \def\defindex{\parsearg\newindex}
3340 % Define @defcodeindex, like @defindex except put all entries in @code.
3342 \def\defcodeindex{\parsearg\newcodeindex}
3344 \def\newcodeindex#1{%
3346 \expandafter\newwrite \csname#1indfile\endcsname
3347 \openout \csname#1indfile\endcsname \jobname.#1
3349 \expandafter\xdef\csname#1index\endcsname{%
3350 \noexpand\docodeindex{#1}}%
3354 % @synindex foo bar makes index foo feed into index bar.
3355 % Do this instead of @defindex foo if you don't want it as a separate index.
3357 % @syncodeindex foo bar similar, but put all entries made for index foo
3360 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3361 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3363 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3364 % #3 the target index (bar).
3365 \def\dosynindex#1#2#3{%
3366 % Only do \closeout if we haven't already done it, else we'll end up
3367 % closing the target index.
3368 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3369 % The \closeout helps reduce unnecessary open files; the limit on the
3370 % Acorn RISC OS is a mere 16 files.
3371 \expandafter\closeout\csname#2indfile\endcsname
3372 \expandafter\let\csname\donesynindex#2\endcsname = 1
3374 % redefine \fooindfile:
3375 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3376 \expandafter\let\csname#2indfile\endcsname=\temp
3377 % redefine \fooindex:
3378 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3381 % Define \doindex, the driver for all \fooindex macros.
3382 % Argument #1 is generated by the calling \fooindex macro,
3383 % and it is "foo", the name of the index.
3385 % \doindex just uses \parsearg; it calls \doind for the actual work.
3386 % This is because \doind is more useful to call from other macros.
3388 % There is also \dosubind {index}{topic}{subtopic}
3389 % which makes an entry in a two-level index such as the operation index.
3391 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3392 \def\singleindexer #1{\doind{\indexname}{#1}}
3394 % like the previous two, but they put @code around the argument.
3395 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3396 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3398 % Take care of Texinfo commands that can appear in an index entry.
3399 % Since there are some commands we want to expand, and others we don't,
3400 % we have to laboriously prevent expansion for those that we don't.
3403 \escapechar = `\\ % use backslash in output files.
3404 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3405 \def\ {\realbackslash\space }%
3407 % Need these in case \tex is in effect and \{ is a \delimiter again.
3408 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3409 % braces and backslashes are used only as delimiters.
3413 % I don't entirely understand this, but when an index entry is
3414 % generated from a macro call, the \endinput which \scanmacro inserts
3415 % causes processing to be prematurely terminated. This is,
3416 % apparently, because \indexsorttmp is fully expanded, and \endinput
3417 % is an expandable command. The redefinition below makes \endinput
3418 % disappear altogether for that purpose -- although logging shows that
3419 % processing continues to some further point. On the other hand, it
3420 % seems \endinput does not hurt in the printed index arg, since that
3421 % is still getting written without apparent harm.
3423 % Sample source (mac-idx3.tex, reported by Graham Percival to
3424 % help-texinfo, 22may06):
3425 % @macro funindex {WORD}
3429 % @funindex commtest
3431 % The above is not enough to reproduce the bug, but it gives the flavor.
3433 % Sample whatsit resulting:
3434 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3437 \let\endinput = \empty
3439 % Do the redefinitions.
3443 % For the aux and toc files, @ is the escape character. So we want to
3444 % redefine everything using @ as the escape character (instead of
3445 % \realbackslash, still used for index files). When everything uses @,
3446 % this will be simpler.
3451 \let\{ = \lbraceatcmd
3452 \let\} = \rbraceatcmd
3454 % Do the redefinitions.
3459 % Called from \indexdummies and \atdummies.
3461 \def\commondummies{%
3463 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3464 % preventing its expansion. This is used only for control% words,
3465 % not control letters, because the \space would be incorrect for
3466 % control characters, but is needed to separate the control word
3467 % from whatever follows.
3469 % For control letters, we have \definedummyletter, which omits the
3472 % These can be used both for control words that take an argument and
3473 % those that do not. If it is followed by {arg} in the input, then
3474 % that will dutifully get written to the index (or wherever).
3476 \def\definedummyword ##1{\def##1{\string##1\space}}%
3477 \def\definedummyletter##1{\def##1{\string##1}}%
3478 \let\definedummyaccent\definedummyletter
3480 \commondummiesnofonts
3482 \definedummyletter\_%
3484 % Non-English letters.
3496 \definedummyword\exclamdown
3497 \definedummyword\questiondown
3498 \definedummyword\ordf
3499 \definedummyword\ordm
3501 % Although these internal commands shouldn't show up, sometimes they do.
3503 \definedummyword\gtr
3504 \definedummyword\hat
3505 \definedummyword\less
3508 \definedummyword\tclose
3511 \definedummyword\LaTeX
3512 \definedummyword\TeX
3514 % Assorted special characters.
3515 \definedummyword\bullet
3516 \definedummyword\comma
3517 \definedummyword\copyright
3518 \definedummyword\registeredsymbol
3519 \definedummyword\dots
3520 \definedummyword\enddots
3521 \definedummyword\equiv
3522 \definedummyword\error
3523 \definedummyword\euro
3524 \definedummyword\expansion
3525 \definedummyword\minus
3526 \definedummyword\pounds
3527 \definedummyword\point
3528 \definedummyword\print
3529 \definedummyword\result
3531 % We want to disable all macros so that they are not expanded by \write.
3534 \normalturnoffactive
3536 % Handle some cases of @value -- where it does not contain any
3537 % (non-fully-expandable) commands.
3538 \makevalueexpandable
3541 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3543 \def\commondummiesnofonts{%
3544 % Control letters and accents.
3545 \definedummyletter\!%
3546 \definedummyaccent\"%
3547 \definedummyaccent\'%
3548 \definedummyletter\*%
3549 \definedummyaccent\,%
3550 \definedummyletter\.%
3551 \definedummyletter\/%
3552 \definedummyletter\:%
3553 \definedummyaccent\=%
3554 \definedummyletter\?%
3555 \definedummyaccent\^%
3556 \definedummyaccent\`%
3557 \definedummyaccent\~%
3561 \definedummyword\dotaccent
3562 \definedummyword\ringaccent
3563 \definedummyword\tieaccent
3564 \definedummyword\ubaraccent
3565 \definedummyword\udotaccent
3566 \definedummyword\dotless
3568 % Texinfo font commands.
3575 % Commands that take arguments.
3576 \definedummyword\acronym
3577 \definedummyword\cite
3578 \definedummyword\code
3579 \definedummyword\command
3580 \definedummyword\dfn
3581 \definedummyword\emph
3582 \definedummyword\env
3583 \definedummyword\file
3584 \definedummyword\kbd
3585 \definedummyword\key
3586 \definedummyword\math
3587 \definedummyword\option
3588 \definedummyword\pxref
3589 \definedummyword\ref
3590 \definedummyword\samp
3591 \definedummyword\strong
3592 \definedummyword\tie
3593 \definedummyword\uref
3594 \definedummyword\url
3595 \definedummyword\var
3596 \definedummyword\verb
3598 \definedummyword\xref
3601 % \indexnofonts is used when outputting the strings to sort the index
3602 % by, and when constructing control sequence names. It eliminates all
3603 % control sequences and just writes whatever the best ASCII sort string
3604 % would be for a given command (usually its argument).
3607 % Accent commands should become @asis.
3608 \def\definedummyaccent##1{\let##1\asis}%
3609 % We can just ignore other control letters.
3610 \def\definedummyletter##1{\let##1\empty}%
3611 % Hopefully, all control words can become @asis.
3612 \let\definedummyword\definedummyaccent
3614 \commondummiesnofonts
3616 % Don't no-op \tt, since it isn't a user-level command
3617 % and is used in the definitions of the active chars like <, >, |, etc.
3618 % Likewise with the other plain tex font commands.
3623 % how to handle braces?
3624 \def\_{\normalunderscore}%
3626 % Non-English letters.
3639 \def\questiondown{?}%
3646 % Assorted special characters.
3647 % (The following {} will end up in the sort string, but that's ok.)
3648 \def\bullet{bullet}%
3650 \def\copyright{copyright}%
3651 \def\registeredsymbol{R}%
3657 \def\expansion{==>}%
3659 \def\pounds{pounds}%
3664 % We need to get rid of all macros, leaving only the arguments (if present).
3665 % Of course this is not nearly correct, but it is the best we can do for now.
3666 % makeinfo does not expand macros in the argument to @deffn, which ends up
3667 % writing an index entry, and texindex isn't prepared for an index sort entry
3668 % that starts with \.
3670 % Since macro invocations are followed by braces, we can just redefine them
3671 % to take a single TeX argument. The case of a macro invocation that
3672 % goes to end-of-line is not handled.
3677 \let\indexbackslash=0 %overridden during \printindex.
3678 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3680 % Most index entries go through here, but \dosubind is the general case.
3681 % #1 is the index name, #2 is the entry text.
3682 \def\doind#1#2{\dosubind{#1}{#2}{}}
3684 % Workhorse for all \fooindexes.
3685 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3686 % empty if called from \doind, as we usually are (the main exception
3687 % is with most defuns, which call us directly).
3689 \def\dosubind#1#2#3{%
3692 % Store the main index entry text (including the third arg).
3694 % If third arg is present, precede it with a space.
3696 \ifx\thirdarg\empty \else
3697 \toks0 = \expandafter{\the\toks0 \space #3}%
3700 \edef\writeto{\csname#1indfile\endcsname}%
3711 % Write the entry in \toks0 to the index file:
3713 \def\dosubindwrite{%
3714 % Put the index entry in the margin if desired.
3715 \ifx\SETmarginindex\relax\else
3716 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3719 % Remember, we are within a group.
3720 \indexdummies % Must do this here, since \bf, etc expand at this stage
3721 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3722 % so it will be output as is; and it will print as backslash.
3724 % Process the index entry with all font commands turned off, to
3725 % get the string to sort by.
3727 \edef\temp{\the\toks0}% need full expansion
3728 \xdef\indexsorttmp{\temp}%
3731 % Set up the complete index entry, with both the sort key and
3732 % the original text, including any font commands. We write
3733 % three arguments to \entry to the .?? file (four in the
3734 % subentry case), texindex reduces to two when writing the .??s
3738 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3743 % Take care of unwanted page breaks:
3745 % If a skip is the last thing on the list now, preserve it
3746 % by backing up by \lastskip, doing the \write, then inserting
3747 % the skip again. Otherwise, the whatsit generated by the
3748 % \write will make \lastskip zero. The result is that sequences
3753 % will have extra space inserted, because the \medbreak in the
3754 % start of the @defun won't see the skip inserted by the @end of
3755 % the previous defun.
3757 % But don't do any of this if we're not in vertical mode. We
3758 % don't want to do a \vskip and prematurely end a paragraph.
3760 % Avoid page breaks due to these extra skips, too.
3762 % But wait, there is a catch there:
3763 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3764 % sufficient for this purpose, as it ignores stretch and shrink parts
3765 % of the skip. The only way seems to be to check the textual
3766 % representation of the skip.
3768 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3769 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3771 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3775 \def\dosubindsanitize{%
3776 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3778 \edef\lastskipmacro{\the\lastskip}%
3779 \count255 = \lastpenalty
3781 % If \lastskip is nonzero, that means the last item was a
3782 % skip. And since a skip is discardable, that means this
3783 % -\skip0 glue we're inserting is preceded by a
3784 % non-discardable item, therefore it is not a potential
3785 % breakpoint, therefore no \nobreak needed.
3786 \ifx\lastskipmacro\zeroskipmacro
3793 \ifx\lastskipmacro\zeroskipmacro
3794 % If \lastskip was zero, perhaps the last item was a penalty, and
3795 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3796 % to re-insert the same penalty (values >10000 are used for various
3797 % signals); since we just inserted a non-discardable item, any
3798 % following glue (such as a \parskip) would be a breakpoint. For example:
3800 % @deffn deffn-whatever
3801 % @vindex index-whatever
3803 % would allow a break between the index-whatever whatsit
3804 % and the "Description." paragraph.
3805 \ifnum\count255>9999 \penalty\count255 \fi
3807 % On the other hand, if we had a nonzero \lastskip,
3808 % this make-up glue would be preceded by a non-discardable item
3809 % (the whatsit from the \write), so we must insert a \nobreak.
3810 \nobreak\vskip\skip0
3814 % The index entry written in the file actually looks like
3815 % \entry {sortstring}{page}{topic}
3817 % \entry {sortstring}{page}{topic}{subtopic}
3818 % The texindex program reads in these files and writes files
3819 % containing these kinds of lines:
3821 % before the first topic whose initial is c
3822 % \entry {topic}{pagelist}
3823 % for a topic that is used without subtopics
3825 % for the beginning of a topic that is used with subtopics
3826 % \secondary {subtopic}{pagelist}
3827 % for each subtopic.
3829 % Define the user-accessible indexing commands
3830 % @findex, @vindex, @kindex, @cindex.
3832 \def\findex {\fnindex}
3833 \def\kindex {\kyindex}
3834 \def\cindex {\cpindex}
3835 \def\vindex {\vrindex}
3836 \def\tindex {\tpindex}
3837 \def\pindex {\pgindex}
3839 \def\cindexsub {\begingroup\obeylines\cindexsub}
3841 \gdef\cindexsub "#1" #2^^M{\endgroup %
3842 \dosubind{cp}{#2}{#1}}}
3844 % Define the macros used in formatting output of the sorted index material.
3846 % @printindex causes a particular index (the ??s file) to get printed.
3847 % It does not print any chapter heading (usually an @unnumbered).
3849 \parseargdef\printindex{\begingroup
3850 \dobreak \chapheadingskip{10000}%
3854 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3856 % See if the index file exists and is nonempty.
3857 % Change catcode of @ here so that if the index file contains
3859 % as its first line, TeX doesn't complain about mismatched braces
3860 % (because it thinks @} is a control sequence).
3862 \openin 1 \jobname.#1s
3864 % \enddoublecolumns gets confused if there is no text in the index,
3865 % and it loses the chapter title and the aux file entries for the
3866 % index. The easiest way to prevent this problem is to make sure
3867 % there is some text.
3868 \putwordIndexNonexistent
3871 % If the index file exists but is empty, then \openin leaves \ifeof
3872 % false. We have to make TeX try to read something from the file, so
3873 % it can discover if there is anything in it.
3876 \putwordIndexIsEmpty
3878 % Index files are almost Texinfo source, but we use \ as the escape
3879 % character. It would be better to use @, but that's too big a change
3880 % to make right now.
3881 \def\indexbackslash{\backslashcurfont}%
3892 % These macros are used by the sorted index file itself.
3893 % Change them to control the appearance of the index.
3896 % Some minor font changes for the special characters.
3897 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3899 % Remove any glue we may have, we'll be inserting our own.
3902 % We like breaks before the index initials, so insert a bonus.
3904 \vskip 0pt plus 3\baselineskip
3906 \vskip 0pt plus -3\baselineskip
3908 % Typeset the initial. Making this add up to a whole number of
3909 % baselineskips increases the chance of the dots lining up from column
3910 % to column. It still won't often be perfect, because of the stretch
3911 % we need before each entry, but it's better.
3913 % No shrink because it confuses \balancecolumns.
3914 \vskip 1.67\baselineskip plus .5\baselineskip
3915 \leftline{\secbf #1}%
3916 % Do our best not to break after the initial.
3918 \vskip .33\baselineskip plus .1\baselineskip
3921 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3922 % then page number (#2) flushed to the right margin. It is used for index
3923 % and table of contents entries. The paragraph is indented by \leftskip.
3925 % A straightforward implementation would start like this:
3926 % \def\entry#1#2{...
3927 % But this frozes the catcodes in the argument, and can cause problems to
3928 % @code, which sets - active. This problem was fixed by a kludge---
3929 % ``-'' was active throughout whole index, but this isn't really right.
3931 % The right solution is to prevent \entry from swallowing the whole text.
3936 % Start a new paragraph if necessary, so our assignments below can't
3937 % affect previous text.
3940 % Do not fill out the last line with white space.
3943 % No extra space above this paragraph.
3946 % Do not prefer a separate line ending with a hyphen to fewer lines.
3947 \finalhyphendemerits = 0
3949 % \hangindent is only relevant when the entry text and page number
3950 % don't both fit on one line. In that case, bob suggests starting the
3951 % dots pretty far over on the line. Unfortunately, a large
3952 % indentation looks wrong when the entry text itself is broken across
3953 % lines. So we use a small indentation and put up with long leaders.
3955 % \hangafter is reset to 1 (which is the value we want) at the start
3956 % of each paragraph, so we need not do anything with that.
3959 % When the entry text needs to be broken, just fill out the first line
3961 \rightskip = 0pt plus1fil
3963 % A bit of stretch before each entry for the benefit of balancing
3967 % Swallow the left brace of the text (first parameter):
3968 \afterassignment\doentry
3972 \bgroup % Instead of the swallowed brace.
3974 \aftergroup\finishentry
3975 % And now comes the text of the entry.
3977 \def\finishentry#1{%
3978 % #1 is the page number.
3980 % The following is kludged to not output a line of dots in the index if
3981 % there are no page numbers. The next person who breaks this will be
3982 % cursed by a Unix daemon.
3985 \edef\tempc{\tempa}%
3986 \edef\tempd{\tempb}%
3991 % If we must, put the page number on a line of its own, and fill out
3992 % this line with blank space. (The \hfil is overwhelmed with the
3993 % fill leaders glue in \indexdotfill if the page number does fit.)
3995 \null\nobreak\indexdotfill % Have leaders before the page number.
3997 % The `\ ' here is removed by the implicit \unskip that TeX does as
3998 % part of (the primitive) \par. Without it, a spurious underfull
4011 % Like \dotfill except takes at least 1 em.
4012 \def\indexdotfill{\cleaders
4013 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
4015 \def\primary #1{\line{#1\hfil}}
4017 \newskip\secondaryindent \secondaryindent=0.5cm
4018 \def\secondary#1#2{{%
4023 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4025 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4032 % Define two-column mode, which we use to typeset indexes.
4033 % Adapted from the TeXbook, page 416, which is to say,
4034 % the manmac.tex format used to print the TeXbook itself.
4038 \newdimen\doublecolumnhsize
4040 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4041 % Grab any single-column material above us.
4044 % Here is a possibility not foreseen in manmac: if we accumulate a
4045 % whole lot of material, we might end up calling this \output
4046 % routine twice in a row (see the doublecol-lose test, which is
4047 % essentially a couple of indexes with @setchapternewpage off). In
4048 % that case we just ship out what is in \partialpage with the normal
4049 % output routine. Generally, \partialpage will be empty when this
4050 % runs and this will be a no-op. See the indexspread.tex test case.
4051 \ifvoid\partialpage \else
4052 \onepageout{\pagecontents\partialpage}%
4055 \global\setbox\partialpage = \vbox{%
4056 % Unvbox the main output page.
4058 \kern-\topskip \kern\baselineskip
4061 \eject % run that output routine to set \partialpage
4063 % Use the double-column output routine for subsequent pages.
4064 \output = {\doublecolumnout}%
4066 % Change the page size parameters. We could do this once outside this
4067 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4068 % format, but then we repeat the same computation. Repeating a couple
4069 % of assignments once per index is clearly meaningless for the
4070 % execution time, so we may as well do it in one place.
4072 % First we halve the line length, less a little for the gutter between
4073 % the columns. We compute the gutter based on the line length, so it
4074 % changes automatically with the paper format. The magic constant
4075 % below is chosen so that the gutter has the same value (well, +-<1pt)
4076 % as it did when we hard-coded it.
4078 % We put the result in a separate register, \doublecolumhsize, so we
4079 % can restore it in \pagesofar, after \hsize itself has (potentially)
4082 \doublecolumnhsize = \hsize
4083 \advance\doublecolumnhsize by -.04154\hsize
4084 \divide\doublecolumnhsize by 2
4085 \hsize = \doublecolumnhsize
4087 % Double the \vsize as well. (We don't need a separate register here,
4088 % since nobody clobbers \vsize.)
4092 % The double-column output routine for all double-column pages except
4095 \def\doublecolumnout{%
4096 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4097 % Get the available space for the double columns -- the normal
4098 % (undoubled) page height minus any material left over from the
4102 \advance\dimen@ by -\ht\partialpage
4104 % box0 will be the left-hand column, box2 the right.
4105 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4106 \onepageout\pagesofar
4108 \penalty\outputpenalty
4111 % Re-output the contents of the output page -- any previous material,
4112 % followed by the two boxes we just split, in box0 and box2.
4116 \hsize = \doublecolumnhsize
4117 \wd0=\hsize \wd2=\hsize
4118 \hbox to\pagewidth{\box0\hfil\box2}%
4121 % All done with double columns.
4122 \def\enddoublecolumns{%
4124 % Split the last of the double-column material. Leave it on the
4125 % current page, no automatic page break.
4128 % If we end up splitting too much material for the current page,
4129 % though, there will be another page break right after this \output
4130 % invocation ends. Having called \balancecolumns once, we do not
4131 % want to call it again. Therefore, reset \output to its normal
4132 % definition right away. (We hope \balancecolumns will never be
4133 % called on to balance too much material, but if it is, this makes
4134 % the output somewhat more palatable.)
4135 \global\output = {\onepageout{\pagecontents\PAGE}}%
4138 \endgroup % started in \begindoublecolumns
4140 % \pagegoal was set to the doubled \vsize above, since we restarted
4141 % the current page. We're now back to normal single-column
4142 % typesetting, so reset \pagegoal to the normal \vsize (after the
4143 % \endgroup where \vsize got restored).
4147 % Called at the end of the double column material.
4148 \def\balancecolumns{%
4149 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4151 \advance\dimen@ by \topskip
4152 \advance\dimen@ by-\baselineskip
4153 \divide\dimen@ by 2 % target to split to
4154 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4155 \splittopskip = \topskip
4156 % Loop until we get a decent breakpoint.
4160 \global\setbox3 = \copy0
4161 \global\setbox1 = \vsplit3 to \dimen@
4163 \global\advance\dimen@ by 1pt
4166 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4167 \setbox0=\vbox to\dimen@{\unvbox1}%
4168 \setbox2=\vbox to\dimen@{\unvbox3}%
4172 \catcode`\@ = \other
4175 \message{sectioning,}
4176 % Chapters, sections, etc.
4178 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4179 % sections so that we can refer to them unambiguously in the pdf
4180 % outlines by their "section number". We avoid collisions with chapter
4181 % numbers by starting them at 10000. (If a document ever has 10000
4182 % chapters, we're in trouble anyway, I'm sure.)
4183 \newcount\unnumberedno \unnumberedno = 10000
4185 \newcount\secno \secno=0
4186 \newcount\subsecno \subsecno=0
4187 \newcount\subsubsecno \subsubsecno=0
4189 % This counter is funny since it counts through charcodes of letters A, B, ...
4190 \newcount\appendixno \appendixno = `\@
4192 % \def\appendixletter{\char\the\appendixno}
4193 % We do the following ugly conditional instead of the above simple
4194 % construct for the sake of pdftex, which needs the actual
4195 % letter in the expansion, not just typeset.
4197 \def\appendixletter{%
4198 \ifnum\appendixno=`A A%
4199 \else\ifnum\appendixno=`B B%
4200 \else\ifnum\appendixno=`C C%
4201 \else\ifnum\appendixno=`D D%
4202 \else\ifnum\appendixno=`E E%
4203 \else\ifnum\appendixno=`F F%
4204 \else\ifnum\appendixno=`G G%
4205 \else\ifnum\appendixno=`H H%
4206 \else\ifnum\appendixno=`I I%
4207 \else\ifnum\appendixno=`J J%
4208 \else\ifnum\appendixno=`K K%
4209 \else\ifnum\appendixno=`L L%
4210 \else\ifnum\appendixno=`M M%
4211 \else\ifnum\appendixno=`N N%
4212 \else\ifnum\appendixno=`O O%
4213 \else\ifnum\appendixno=`P P%
4214 \else\ifnum\appendixno=`Q Q%
4215 \else\ifnum\appendixno=`R R%
4216 \else\ifnum\appendixno=`S S%
4217 \else\ifnum\appendixno=`T T%
4218 \else\ifnum\appendixno=`U U%
4219 \else\ifnum\appendixno=`V V%
4220 \else\ifnum\appendixno=`W W%
4221 \else\ifnum\appendixno=`X X%
4222 \else\ifnum\appendixno=`Y Y%
4223 \else\ifnum\appendixno=`Z Z%
4224 % The \the is necessary, despite appearances, because \appendixletter is
4225 % expanded while writing the .toc file. \char\appendixno is not
4226 % expandable, thus it is written literally, thus all appendixes come out
4227 % with the same letter (or @) in the toc without it.
4228 \else\char\the\appendixno
4229 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4230 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4232 % Each @chapter defines this as the name of the chapter.
4233 % page headings and footings can use it. @section does likewise.
4234 % However, they are not reliable, because we don't use marks.
4238 \newcount\absseclevel % used to calculate proper heading level
4239 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4241 % @raisesections: treat @section as chapter, @subsection as section, etc.
4242 \def\raisesections{\global\advance\secbase by -1}
4243 \let\up=\raisesections % original BFox name
4245 % @lowersections: treat @chapter as section, @section as subsection, etc.
4246 \def\lowersections{\global\advance\secbase by 1}
4247 \let\down=\lowersections % original BFox name
4249 % we only have subsub.
4250 \chardef\maxseclevel = 3
4252 % A numbered section within an unnumbered changes to unnumbered too.
4253 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4254 \chardef\unmlevel = \maxseclevel
4256 % Trace whether the current chapter is an appendix or not:
4257 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4258 \def\chapheadtype{N}
4260 % Choose a heading macro
4261 % #1 is heading type
4262 % #2 is heading level
4263 % #3 is text for heading
4264 \def\genhead#1#2#3{%
4265 % Compute the abs. sec. level:
4267 \advance\absseclevel by \secbase
4268 % Make sure \absseclevel doesn't fall outside the range:
4269 \ifnum \absseclevel < 0
4272 \ifnum \absseclevel > 3
4279 \ifnum \absseclevel < \unmlevel
4280 \chardef\unmlevel = \absseclevel
4283 % Check for appendix sections:
4284 \ifnum \absseclevel = 0
4285 \edef\chapheadtype{\headtype}%
4287 \if \headtype A\if \chapheadtype N%
4288 \errmessage{@appendix... within a non-appendix chapter}%
4291 % Check for numbered within unnumbered:
4292 \ifnum \absseclevel > \unmlevel
4295 \chardef\unmlevel = 3
4298 % Now print the heading:
4302 \or \unnumberedseczzz{#3}%
4303 \or \unnumberedsubseczzz{#3}%
4304 \or \unnumberedsubsubseczzz{#3}%
4310 \or \appendixsectionzzz{#3}%
4311 \or \appendixsubseczzz{#3}%
4312 \or \appendixsubsubseczzz{#3}%
4318 \or \numberedsubseczzz{#3}%
4319 \or \numberedsubsubseczzz{#3}%
4323 \suppressfirstparagraphindent
4327 \def\numhead{\genhead N}
4328 \def\apphead{\genhead A}
4329 \def\unnmhead{\genhead U}
4331 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4332 % all lower-level sectioning counters to zero.
4334 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4335 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4336 \let\chaplevelprefix = \empty
4338 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4340 % section resetting is \global in case the chapter is in a group, such
4341 % as an @include file.
4342 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4343 \global\advance\chapno by 1
4346 \gdef\chaplevelprefix{\the\chapno.}%
4349 \message{\putwordChapter\space \the\chapno}%
4351 % Write the actual heading.
4352 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4354 % So @section and the like are numbered underneath this chapter.
4355 \global\let\section = \numberedsec
4356 \global\let\subsection = \numberedsubsec
4357 \global\let\subsubsection = \numberedsubsubsec
4360 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4361 \def\appendixzzz#1{%
4362 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4363 \global\advance\appendixno by 1
4364 \gdef\chaplevelprefix{\appendixletter.}%
4367 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4368 \message{\appendixnum}%
4370 \chapmacro{#1}{Yappendix}{\appendixletter}%
4372 \global\let\section = \appendixsec
4373 \global\let\subsection = \appendixsubsec
4374 \global\let\subsubsection = \appendixsubsubsec
4377 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4378 \def\unnumberedzzz#1{%
4379 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4380 \global\advance\unnumberedno by 1
4382 % Since an unnumbered has no number, no prefix for figures.
4383 \global\let\chaplevelprefix = \empty
4386 % This used to be simply \message{#1}, but TeX fully expands the
4387 % argument to \message. Therefore, if #1 contained @-commands, TeX
4388 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4389 % expanded @cite (which turns out to cause errors because \cite is meant
4390 % to be executed, not expanded).
4392 % Anyway, we don't want the fully-expanded definition of @cite to appear
4393 % as a result of the \message, we just want `@cite' itself. We use
4394 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4395 % simply yielding the contents of <toks register>. (We also do this for
4398 \message{(\the\toks0)}%
4400 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4402 \global\let\section = \unnumberedsec
4403 \global\let\subsection = \unnumberedsubsec
4404 \global\let\subsubsection = \unnumberedsubsubsec
4407 % @centerchap is like @unnumbered, but the heading is centered.
4408 \outer\parseargdef\centerchap{%
4409 % Well, we could do the following in a group, but that would break
4410 % an assumption that \chapmacro is called at the outermost level.
4411 % Thus we are safer this way: --kasal, 24feb04
4412 \let\centerparametersmaybe = \centerparameters
4414 \let\centerparametersmaybe = \relax
4417 % @top is like @unnumbered.
4421 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4423 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4424 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4427 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4428 \def\appendixsectionzzz#1{%
4429 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4430 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4432 \let\appendixsec\appendixsection
4434 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4435 \def\unnumberedseczzz#1{%
4436 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4437 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4441 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4442 \def\numberedsubseczzz#1{%
4443 \global\subsubsecno=0 \global\advance\subsecno by 1
4444 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4447 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4448 \def\appendixsubseczzz#1{%
4449 \global\subsubsecno=0 \global\advance\subsecno by 1
4450 \sectionheading{#1}{subsec}{Yappendix}%
4451 {\appendixletter.\the\secno.\the\subsecno}%
4454 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4455 \def\unnumberedsubseczzz#1{%
4456 \global\subsubsecno=0 \global\advance\subsecno by 1
4457 \sectionheading{#1}{subsec}{Ynothing}%
4458 {\the\unnumberedno.\the\secno.\the\subsecno}%
4462 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4463 \def\numberedsubsubseczzz#1{%
4464 \global\advance\subsubsecno by 1
4465 \sectionheading{#1}{subsubsec}{Ynumbered}%
4466 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4469 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4470 \def\appendixsubsubseczzz#1{%
4471 \global\advance\subsubsecno by 1
4472 \sectionheading{#1}{subsubsec}{Yappendix}%
4473 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4476 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4477 \def\unnumberedsubsubseczzz#1{%
4478 \global\advance\subsubsecno by 1
4479 \sectionheading{#1}{subsubsec}{Ynothing}%
4480 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4483 % These macros control what the section commands do, according
4484 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4485 % Define them by default for a numbered chapter.
4486 \let\section = \numberedsec
4487 \let\subsection = \numberedsubsec
4488 \let\subsubsection = \numberedsubsubsec
4490 % Define @majorheading, @heading and @subheading
4492 % NOTE on use of \vbox for chapter headings, section headings, and such:
4493 % 1) We use \vbox rather than the earlier \line to permit
4494 % overlong headings to fold.
4495 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4496 % heading is obnoxious; this forbids it.
4497 % 3) Likewise, headings look best if no \parindent is used, and
4498 % if justification is not attempted. Hence \raggedright.
4502 {\advance\chapheadingskip by 10pt \chapbreak }%
4503 \parsearg\chapheadingzzz
4506 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4507 \def\chapheadingzzz#1{%
4508 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4509 \parindent=0pt\raggedright
4511 \bigskip \par\penalty 200\relax
4512 \suppressfirstparagraphindent
4515 % @heading, @subheading, @subsubheading.
4516 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4517 \suppressfirstparagraphindent}
4518 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4519 \suppressfirstparagraphindent}
4520 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4521 \suppressfirstparagraphindent}
4523 % These macros generate a chapter, section, etc. heading only
4524 % (including whitespace, linebreaking, etc. around it),
4525 % given all the information in convenient, parsed form.
4527 %%% Args are the skip and penalty (usually negative)
4528 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4530 %%% Define plain chapter starts, and page on/off switching for it
4531 % Parameter controlling skip before chapter headings (if needed)
4533 \newskip\chapheadingskip
4535 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4536 \def\chappager{\par\vfill\supereject}
4537 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4539 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4542 \global\let\contentsalignmacro = \chappager
4543 \global\let\pchapsepmacro=\chapbreak
4544 \global\let\pagealignmacro=\chappager}
4547 \global\let\contentsalignmacro = \chappager
4548 \global\let\pchapsepmacro=\chappager
4549 \global\let\pagealignmacro=\chappager
4550 \global\def\HEADINGSon{\HEADINGSsingle}}
4553 \global\let\contentsalignmacro = \chapoddpage
4554 \global\let\pchapsepmacro=\chapoddpage
4555 \global\let\pagealignmacro=\chapoddpage
4556 \global\def\HEADINGSon{\HEADINGSdouble}}
4562 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4563 % Yappendix, Yomitfromtoc), #3 the chapter number.
4565 % To test against our argument.
4566 \def\Ynothingkeyword{Ynothing}
4567 \def\Yomitfromtockeyword{Yomitfromtoc}
4568 \def\Yappendixkeyword{Yappendix}
4570 \def\chapmacro#1#2#3{%
4575 % Have to define \thissection before calling \donoderef, because the
4576 % xref code eventually uses it. On the other hand, it has to be called
4577 % after \pchapsepmacro, or the headline will change too soon.
4578 \gdef\thissection{#1}%
4579 \gdef\thischaptername{#1}%
4581 % Only insert the separating space if we have a chapter/appendix
4582 % number, and don't print the unnumbered ``number''.
4584 \ifx\temptype\Ynothingkeyword
4586 \def\toctype{unnchap}%
4587 \gdef\thischapternum{}%
4588 \gdef\thischapter{#1}%
4589 \else\ifx\temptype\Yomitfromtockeyword
4590 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4592 \gdef\thischapternum{}%
4593 \gdef\thischapter{}%
4594 \else\ifx\temptype\Yappendixkeyword
4595 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4597 \xdef\thischapternum{\appendixletter}%
4598 % We don't substitute the actual chapter name into \thischapter
4599 % because we don't want its macros evaluated now. And we don't
4600 % use \thissection because that changes with each section.
4602 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4603 \noexpand\thischaptername}%
4605 \setbox0 = \hbox{#3\enspace}%
4606 \def\toctype{numchap}%
4607 \xdef\thischapternum{\the\chapno}%
4608 \xdef\thischapter{\putwordChapter{} \the\chapno:
4609 \noexpand\thischaptername}%
4612 % Write the toc entry for this chapter. Must come before the
4613 % \donoderef, because we include the current node name in the toc
4614 % entry, and \donoderef resets it to empty.
4615 \writetocentry{\toctype}{#1}{#3}%
4617 % For pdftex, we have to write out the node definition (aka, make
4618 % the pdfdest) after any page break, but before the actual text has
4619 % been typeset. If the destination for the pdf outline is after the
4620 % text, then jumping from the outline may wind up with the text not
4621 % being visible, for instance under high magnification.
4624 % Typeset the actual heading.
4625 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4626 \hangindent=\wd0 \centerparametersmaybe
4629 \nobreak\bigskip % no page break after a chapter title
4633 % @centerchap -- centered and unnumbered.
4634 \let\centerparametersmaybe = \relax
4635 \def\centerparameters{%
4636 \advance\rightskip by 3\rightskip
4637 \leftskip = \rightskip
4642 % I don't think this chapter style is supported any more, so I'm not
4643 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4645 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4647 \def\unnchfopen #1{%
4648 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4649 \parindent=0pt\raggedright
4650 \rm #1\hfill}}\bigskip \par\nobreak
4652 \def\chfopen #1#2{\chapoddpage {\chapfonts
4653 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4656 \def\centerchfopen #1{%
4657 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4659 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4662 \global\let\chapmacro=\chfopen
4663 \global\let\centerchapmacro=\centerchfopen}
4666 % Section titles. These macros combine the section number parts and
4667 % call the generic \sectionheading to do the printing.
4669 \newskip\secheadingskip
4670 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4672 % Subsection titles.
4673 \newskip\subsecheadingskip
4674 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4676 % Subsubsection titles.
4677 \def\subsubsecheadingskip{\subsecheadingskip}
4678 \def\subsubsecheadingbreak{\subsecheadingbreak}
4681 % Print any size, any type, section title.
4683 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4684 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4687 \def\sectionheading#1#2#3#4{%
4689 % Switch to the right set of fonts.
4690 \csname #2fonts\endcsname \rm
4692 % Insert space above the heading.
4693 \csname #2headingbreak\endcsname
4695 % Only insert the space after the number if we have a section number.
4696 \def\sectionlevel{#2}%
4699 \ifx\temptype\Ynothingkeyword
4702 \gdef\thissection{#1}%
4703 \else\ifx\temptype\Yomitfromtockeyword
4704 % for @headings -- no section number, don't include in toc,
4705 % and don't redefine \thissection.
4708 \let\sectionlevel=\empty
4709 \else\ifx\temptype\Yappendixkeyword
4710 \setbox0 = \hbox{#4\enspace}%
4712 \gdef\thissection{#1}%
4714 \setbox0 = \hbox{#4\enspace}%
4716 \gdef\thissection{#1}%
4719 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4720 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4722 % Write the node reference (= pdf destination for pdftex).
4723 % Again, see comments in \chapmacro.
4726 % Interline glue will be inserted when the vbox is completed.
4727 % That glue will be a valid breakpoint for the page, since it'll be
4728 % preceded by a whatsit (usually from the \donoderef, or from the
4729 % \writetocentry if there was no node). We don't want to allow that
4730 % break, since then the whatsits could end up on page n while the
4731 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4734 % Output the actual section heading.
4735 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4736 \hangindent=\wd0 % zero if no section number
4739 % Add extra space after the heading -- half of whatever came above it.
4740 % Don't allow stretch, though.
4741 \kern .5 \csname #2headingskip\endcsname
4743 % Do not let the kern be a potential breakpoint, as it would be if it
4744 % was followed by glue.
4747 % We'll almost certainly start a paragraph next, so don't let that
4748 % glue accumulate. (Not a breakpoint because it's preceded by a
4749 % discardable item.)
4752 % This is purely so the last item on the list is a known \penalty >
4753 % 10000. This is so \startdefun can avoid allowing breakpoints after
4754 % section headings. Otherwise, it would insert a valid breakpoint between:
4756 % @section sec-whatever
4757 % @deffn def-whatever
4763 % Table of contents.
4766 % Write an entry to the toc file, opening it if necessary.
4767 % Called from @chapter, etc.
4769 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4770 % We append the current node name (if any) and page number as additional
4771 % arguments for the \{chap,sec,...}entry macros which will eventually
4772 % read this. The node name is used in the pdf outlines as the
4773 % destination to jump to.
4775 % We open the .toc file for writing here instead of at @setfilename (or
4776 % any other fixed time) so that @contents can be anywhere in the document.
4777 % But if #1 is `omit', then we don't do anything. This is used for the
4778 % table of contents chapter openings themselves.
4780 \newif\iftocfileopened
4781 \def\omitkeyword{omit}%
4783 \def\writetocentry#1#2#3{%
4784 \edef\writetoctype{#1}%
4785 \ifx\writetoctype\omitkeyword \else
4786 \iftocfileopened\else
4787 \immediate\openout\tocfile = \jobname.toc
4788 \global\tocfileopenedtrue
4794 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4800 % Tell \shipout to create a pdf destination on each page, if we're
4801 % writing pdf. These are used in the table of contents. We can't
4802 % just write one on every page because the title pages are numbered
4803 % 1 and 2 (the page numbers aren't printed), and so are the first
4804 % two pages of the document. Thus, we'd have two destinations named
4805 % `1', and two named `2'.
4806 \ifpdf \global\pdfmakepagedesttrue \fi
4810 % These characters do not print properly in the Computer Modern roman
4811 % fonts, so we must take special care. This is more or less redundant
4812 % with the Texinfo input format setup at the end of this file.
4814 \def\activecatcodes{%
4827 % Read the toc file, which is essentially Texinfo input.
4834 \newskip\contentsrightmargin \contentsrightmargin=1in
4835 \newcount\savepageno
4836 \newcount\lastnegativepageno \lastnegativepageno = -1
4838 % Prepare to read what we've written to \tocfile.
4840 \def\startcontents#1{%
4841 % If @setchapternewpage on, and @headings double, the contents should
4842 % start on an odd page, unlike chapters. Thus, we maintain
4843 % \contentsalignmacro in parallel with \pagealignmacro.
4844 % From: Torbjorn Granlund <tege@matematik.su.se>
4846 \immediate\closeout\tocfile
4848 % Don't need to put `Contents' or `Short Contents' in the headline.
4849 % It is abundantly clear what they are.
4851 \chapmacro{#1}{Yomitfromtoc}{}%
4853 \savepageno = \pageno
4854 \begingroup % Set up to handle contents files properly.
4855 \raggedbottom % Worry more about breakpoints than the bottom.
4856 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4858 % Roman numerals for page numbers.
4859 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4863 % Normal (long) toc.
4865 \startcontents{\putwordTOC}%
4866 \openin 1 \jobname.toc
4871 \contentsalignmacro % in case @setchapternewpage odd is in effect
4877 \lastnegativepageno = \pageno
4878 \global\pageno = \savepageno
4881 % And just the chapters.
4882 \def\summarycontents{%
4883 \startcontents{\putwordShortTOC}%
4885 \let\numchapentry = \shortchapentry
4886 \let\appentry = \shortchapentry
4887 \let\unnchapentry = \shortunnchapentry
4888 % We want a true roman here for the page numbers.
4890 \let\rm=\shortcontrm \let\bf=\shortcontbf
4891 \let\sl=\shortcontsl \let\tt=\shortconttt
4893 \hyphenpenalty = 10000
4894 \advance\baselineskip by 1pt % Open it up a little.
4895 \def\numsecentry##1##2##3##4{}
4896 \let\appsecentry = \numsecentry
4897 \let\unnsecentry = \numsecentry
4898 \let\numsubsecentry = \numsecentry
4899 \let\appsubsecentry = \numsecentry
4900 \let\unnsubsecentry = \numsecentry
4901 \let\numsubsubsecentry = \numsecentry
4902 \let\appsubsubsecentry = \numsecentry
4903 \let\unnsubsubsecentry = \numsecentry
4904 \openin 1 \jobname.toc
4910 \contentsalignmacro % in case @setchapternewpage odd is in effect
4912 \lastnegativepageno = \pageno
4913 \global\pageno = \savepageno
4915 \let\shortcontents = \summarycontents
4917 % Typeset the label for a chapter or appendix for the short contents.
4918 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4920 \def\shortchaplabel#1{%
4921 % This space should be enough, since a single number is .5em, and the
4922 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4923 % But use \hss just in case.
4924 % (This space doesn't include the extra space that gets added after
4925 % the label; that gets put in by \shortchapentry above.)
4927 % We'd like to right-justify chapter numbers, but that looks strange
4928 % with appendix letters. And right-justifying numbers and
4929 % left-justifying letters looks strange when there is less than 10
4930 % chapters. Have to read the whole toc once to know how many chapters
4931 % there are before deciding ...
4932 \hbox to 1em{#1\hss}%
4935 % These macros generate individual entries in the table of contents.
4936 % The first argument is the chapter or section name.
4937 % The last argument is the page number.
4938 % The arguments in between are the chapter number, section number, ...
4940 % Chapters, in the main contents.
4941 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4943 % Chapters, in the short toc.
4944 % See comments in \dochapentry re vbox and related settings.
4945 \def\shortchapentry#1#2#3#4{%
4946 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4949 % Appendices, in the main contents.
4950 % Need the word Appendix, and a fixed-size box.
4952 \def\appendixbox#1{%
4953 % We use M since it's probably the widest letter.
4954 \setbox0 = \hbox{\putwordAppendix{} M}%
4955 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4957 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4959 % Unnumbered chapters.
4960 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4961 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4964 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4965 \let\appsecentry=\numsecentry
4966 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4969 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4970 \let\appsubsecentry=\numsubsecentry
4971 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4973 % And subsubsections.
4974 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4975 \let\appsubsubsecentry=\numsubsubsecentry
4976 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4978 % This parameter controls the indentation of the various levels.
4979 % Same as \defaultparindent.
4980 \newdimen\tocindent \tocindent = 15pt
4982 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4985 % If the toc has to be broken over pages, we want it to be at chapters
4986 % if at all possible; hence the \penalty.
4987 \def\dochapentry#1#2{%
4988 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4991 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4993 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4996 \def\dosecentry#1#2{\begingroup
4997 \secentryfonts \leftskip=\tocindent
4998 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5001 \def\dosubsecentry#1#2{\begingroup
5002 \subsecentryfonts \leftskip=2\tocindent
5003 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5006 \def\dosubsubsecentry#1#2{\begingroup
5007 \subsubsecentryfonts \leftskip=3\tocindent
5008 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5011 % We use the same \entry macro as for the index entries.
5012 \let\tocentry = \entry
5014 % Space between chapter (or whatever) number and the title.
5015 \def\labelspace{\hskip1em \relax}
5017 \def\dopageno#1{{\rm #1}}
5018 \def\doshortpageno#1{{\rm #1}}
5020 \def\chapentryfonts{\secfonts \rm}
5021 \def\secentryfonts{\textfonts}
5022 \def\subsecentryfonts{\textfonts}
5023 \def\subsubsecentryfonts{\textfonts}
5026 \message{environments,}
5027 % @foo ... @end foo.
5029 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5031 % Since these characters are used in examples, it should be an even number of
5032 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5035 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5036 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5037 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5038 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5040 % The @error{} command.
5041 % Adapted from the TeXbook's \boxit.
5045 {\tentt \global\dimen0 = 3em}% Width of the box.
5046 \dimen2 = .55pt % Thickness of rules
5047 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5048 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
5050 \setbox\errorbox=\hbox to \dimen0{\hfil
5051 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5052 \advance\hsize by -2\dimen2 % Rules.
5054 \hrule height\dimen2
5055 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5056 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5057 \kern3pt\vrule width\dimen2}% Space to right.
5058 \hrule height\dimen2}
5061 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5063 % @tex ... @end tex escapes into raw Tex temporarily.
5064 % One exception: @ is still an escape character, so that @end tex works.
5065 % But \@ or @@ will get a plain tex @ character.
5068 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5069 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5070 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5080 \let\bullet=\ptexbullet
5085 \let\equiv=\ptexequiv
5088 \let\indent=\ptexindent
5089 \let\noindent=\ptexnoindent
5096 \let\frenchspacing=\plainfrenchspacing
5098 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5099 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5102 % There is no need to define \Etex.
5104 % Define @lisp ... @end lisp.
5105 % @lisp environment forms a group so it can rebind things,
5106 % including the definition of @end lisp (which normally is erroneous).
5108 % Amount to narrow the margins by for @lisp.
5109 \newskip\lispnarrowing \lispnarrowing=0.4in
5111 % This is the definition that ^^M gets inside @lisp, @example, and other
5112 % such environments. \null is better than a space, since it doesn't
5114 \def\lisppar{\null\endgraf}
5116 % This space is always present above and below environments.
5117 \newskip\envskipamount \envskipamount = 0pt
5119 % Make spacing and below environment symmetrical. We use \parskip here
5120 % to help in doing that, since in @example-like environments \parskip
5121 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5122 % start of the next paragraph will insert \parskip.
5124 \def\aboveenvbreak{{%
5125 % =10000 instead of <10000 because of a special case in \itemzzz and
5126 % \sectionheading, q.v.
5127 \ifnum \lastpenalty=10000 \else
5128 \advance\envskipamount by \parskip
5130 \ifdim\lastskip<\envskipamount
5132 % it's not a good place to break if the last penalty was \nobreak
5134 \ifnum\lastpenalty<10000 \penalty-50 \fi
5135 \vskip\envskipamount
5140 \let\afterenvbreak = \aboveenvbreak
5142 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5143 % also clear it, so that its embedded environments do the narrowing again.
5144 \let\nonarrowing=\relax
5146 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5147 % environment contents.
5148 \font\circle=lcircle10
5150 \newdimen\cartouter\newdimen\cartinner
5151 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5152 \circthick=\fontdimen8\circle
5154 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5155 \def\ctr{{\hskip 6pt\circle\char'010}}
5156 \def\cbl{{\circle\char'012\hskip -6pt}}
5157 \def\cbr{{\hskip 6pt\circle\char'011}}
5158 \def\carttop{\hbox to \cartouter{\hskip\lskip
5159 \ctl\leaders\hrule height\circthick\hfil\ctr
5161 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5162 \cbl\leaders\hrule height\circthick\hfil\cbr
5165 \newskip\lskip\newskip\rskip
5168 \ifhmode\par\fi % can't be in the midst of a paragraph.
5170 \lskip=\leftskip \rskip=\rightskip
5171 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5172 \cartinner=\hsize \advance\cartinner by-\lskip
5173 \advance\cartinner by-\rskip
5175 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5176 % side, and for 6pt waste from
5177 % each corner char, and rule thickness
5178 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5179 % Flag to tell @lisp, etc., not to narrow margin.
5180 \let\nonarrowing = t%
5182 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5190 \baselineskip=\normbskip
5191 \lineskip=\normlskip
5194 \comment % For explanation, see the end of \def\group.
5209 % This macro is called at the beginning of all the @example variants,
5213 \hfuzz = 12pt % Don't be fussy
5214 \sepspaces % Make spaces be word-separators rather than space tokens.
5215 \let\par = \lisppar % don't ignore blank lines
5216 \obeylines % each line of input is a line of output
5219 \emergencystretch = 0pt % don't try to avoid overfull boxes
5220 \ifx\nonarrowing\relax
5221 \advance \leftskip by \lispnarrowing
5222 \exdentamount=\lispnarrowing
5224 \let\nonarrowing = \relax
5226 \let\exdent=\nofillexdent
5229 % If you want all examples etc. small: @set dispenvsize small.
5230 % If you want even small examples the full size: @set dispenvsize nosmall.
5231 % This affects the following displayed environments:
5232 % @example, @display, @format, @lisp
5234 \def\smallword{small}
5235 \def\nosmallword{nosmall}
5236 \let\SETdispenvsize\relax
5237 \def\setnormaldispenv{%
5238 \ifx\SETdispenvsize\smallword
5239 \smallexamplefonts \rm
5242 \def\setsmalldispenv{%
5243 \ifx\SETdispenvsize\nosmallword
5245 \smallexamplefonts \rm
5249 % We often define two environments, @foo and @smallfoo.
5250 % Let's do it by one command:
5251 \def\makedispenv #1#2{
5252 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5253 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5254 \expandafter\let\csname E#1\endcsname \afterenvbreak
5255 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5258 % Define two synonyms:
5259 \def\maketwodispenvs #1#2#3{
5260 \makedispenv{#1}{#3}
5261 \makedispenv{#2}{#3}
5264 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5266 % @smallexample and @smalllisp: use smaller fonts.
5267 % Originally contributed by Pavel@xerox.
5269 \maketwodispenvs {lisp}{example}{%
5272 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5273 \gobble % eat return
5276 % @display/@smalldisplay: same as @lisp except keep current font.
5278 \makedispenv {display}{%
5283 % @format/@smallformat: same as @display except don't narrow margins.
5285 \makedispenv{format}{%
5286 \let\nonarrowing = t%
5291 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5293 \let\nonarrowing = t%
5297 \let\Eflushleft = \afterenvbreak
5301 \envdef\flushright{%
5302 \let\nonarrowing = t%
5304 \advance\leftskip by 0pt plus 1fill
5307 \let\Eflushright = \afterenvbreak
5310 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5311 % and narrows the margins. We keep \parskip nonzero in general, since
5312 % we're doing normal filling. So, when using \aboveenvbreak and
5313 % \afterenvbreak, temporarily make \parskip 0.
5316 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5319 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5320 \ifx\nonarrowing\relax
5321 \advance\leftskip by \lispnarrowing
5322 \advance\rightskip by \lispnarrowing
5323 \exdentamount = \lispnarrowing
5325 \let\nonarrowing = \relax
5327 \parsearg\quotationlabel
5330 % We have retained a nonzero parskip for the environment, since we're
5331 % doing normal filling.
5335 \ifx\quotationauthor\undefined\else
5337 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5339 {\parskip=0pt \afterenvbreak}%
5342 % If we're given an argument, typeset it in bold with a colon after.
5343 \def\quotationlabel#1{%
5345 \ifx\temp\empty \else
5351 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5352 % If we want to allow any <char> as delimiter,
5353 % we need the curly braces so that makeinfo sees the @verb command, eg:
5354 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5356 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5358 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5359 % active too. Otherwise, they get lost as the first character on a
5362 \do\ \do\\\do\{\do\}\do\$\do\&%
5363 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5364 \do\<\do\>\do\|\do\@\do+\do\"%
5368 \def\uncatcodespecials{%
5369 \def\do##1{\catcode`##1=\other}\dospecials}
5371 % [Knuth] pp. 380,381,391
5372 % Disable Spanish ligatures ?` and !` of \tt font
5374 \catcode`\`=\active\gdef`{\relax\lq}
5377 % Setup for the @verb command.
5379 % Eight spaces for a tab
5381 \catcode`\^^I=\active
5382 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5386 \tt % easiest (and conventionally used) font for verbatim
5387 \def\par{\leavevmode\endgraf}%
5390 % Respect line breaks,
5391 % print special symbols as themselves, and
5392 % make each space count
5393 % must do in this order:
5394 \obeylines \uncatcodespecials \sepspaces
5397 % Setup for the @verbatim environment
5399 % Real tab expansion
5400 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5402 \def\starttabbox{\setbox0=\hbox\bgroup}
5405 % Don't replace quotes with curly quotes. This makes cut & pasting
5406 % from a PDF file problematic.
5408 \def\singlequotechar{\char'15\relax}
5410 \catcode`\^^I=\active
5412 \catcode`\^^I=\active
5413 \def^^I{\leavevmode\egroup
5414 \dimen0=\wd0 % the width so far, or since the previous tab
5415 \divide\dimen0 by\tabw
5416 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5417 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5418 \wd0=\dimen0 \box0 \starttabbox
5424 \def'{\singlequotechar}
5427 \def\setupverbatim{%
5428 \let\nonarrowing = t%
5430 % Easiest (and conventionally used) font for verbatim
5432 \def\par{\leavevmode\egroup\box0\endgraf}%
5436 % Respect line breaks,
5437 % print special symbols as themselves, and
5438 % make each space count
5439 % must do in this order:
5440 \obeylines \uncatcodespecials \sepspaces
5441 \everypar{\starttabbox}%
5444 % Do the @verb magic: verbatim text is quoted by unique
5445 % delimiter characters. Before first delimiter expect a
5446 % right brace, after last delimiter expect closing brace:
5448 % \def\doverb'{'<char>#1<char>'}'{#1}
5450 % [Knuth] p. 382; only eat outer {}
5452 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5453 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5456 \def\verb{\begingroup\setupverb\doverb}
5459 % Do the @verbatim magic: define the macro \doverbatim so that
5460 % the (first) argument ends when '@end verbatim' is reached, ie:
5462 % \def\doverbatim#1@end verbatim{#1}
5464 % For Texinfo it's a lot easier than for LaTeX,
5465 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5466 % we need not redefine '\', '{' and '}'.
5468 % Inspired by LaTeX's verbatim command set [latex.ltx]
5473 % ignore everything up to the first ^^M, that's the newline at the end
5474 % of the @verbatim input line itself. Otherwise we get an extra blank
5475 % line in the output.
5476 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5477 % We really want {...\end verbatim} in the body of the macro, but
5478 % without the active space; thus we have to use \xdef and \gobble.
5482 \setupverbatim\doverbatim
5484 \let\Everbatim = \afterenvbreak
5487 % @verbatiminclude FILE - insert text of file in verbatim environment.
5489 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5491 \def\doverbatiminclude#1{%
5493 \makevalueexpandable
5500 % @copying ... @end copying.
5501 % Save the text away for @insertcopying later.
5503 % We save the uninterpreted tokens, rather than creating a box.
5504 % Saving the text in a box would be much easier, but then all the
5505 % typesetting commands (@smallbook, font changes, etc.) have to be done
5506 % beforehand -- and a) we want @copying to be done first in the source
5507 % file; b) letting users define the frontmatter in as flexible order as
5508 % possible is very desirable.
5510 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5511 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5513 \def\insertcopying{%
5515 \parindent = 0pt % paragraph indentation looks wrong on title page
5516 \scanexp\copyingtext
5523 \newskip\defbodyindent \defbodyindent=.4in
5524 \newskip\defargsindent \defargsindent=50pt
5525 \newskip\deflastargmargin \deflastargmargin=18pt
5527 % Start the processing of @deffn:
5529 \ifnum\lastpenalty<10000
5532 % If there are two @def commands in a row, we'll have a \nobreak,
5533 % which is there to keep the function description together with its
5534 % header. But if there's nothing but headers, we need to allow a
5535 % break somewhere. Check specifically for penalty 10002, inserted
5536 % by \defargscommonending, instead of 10000, since the sectioning
5537 % commands also insert a nobreak penalty, and we don't want to allow
5538 % a break between a section heading and a defun.
5540 \ifnum\lastpenalty=10002 \penalty2000 \fi
5542 % Similarly, after a section heading, do not allow a break.
5543 % But do insert the glue.
5544 \medskip % preceded by discardable penalty, so not a breakpoint
5548 \advance\leftskip by \defbodyindent
5549 \exdentamount=\defbodyindent
5553 % First, check whether we are in the right environment:
5556 % As above, allow line break if we have multiple x headers in a row.
5557 % It's not a great place, though.
5558 \ifnum\lastpenalty=10002 \penalty3000 \fi
5560 % And now, it's time to reuse the body of the original defun:
5561 \expandafter\gobbledefun#1%
5563 \def\gobbledefun#1\startdefun{}
5565 % \printdefunline \deffnheader{text}
5567 \def\printdefunline#1#2{%
5569 % call \deffnheader:
5572 \interlinepenalty = 10000
5573 \advance\rightskip by 0pt plus 1fil
5575 \nobreak\vskip -\parskip
5576 \penalty 10002 % signal to \startdefun and \dodefunx
5577 % Some of the @defun-type tags do not enable magic parentheses,
5578 % rendering the following check redundant. But we don't optimize.
5583 \def\Edefun{\endgraf\medbreak}
5585 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5586 % the only thing remainnig is to define \deffnheader.
5589 \expandafter\let\csname E#1\endcsname = \Edefun
5590 \edef\temp{\noexpand\domakedefun
5591 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5595 % \domakedefun \deffn \deffnx \deffnheader
5597 % Define \deffn and \deffnx, without parameters.
5598 % \deffnheader has to be defined explicitly.
5600 \def\domakedefun#1#2#3{%
5603 \parseargusing\activeparens{\printdefunline#3}%
5605 \def#2{\dodefunx#1}%
5609 %%% Untyped functions:
5611 % @deffn category name args
5612 \makedefun{deffn}{\deffngeneral{}}
5614 % @deffn category class name args
5615 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5617 % \defopon {category on}class name args
5618 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5620 % \deffngeneral {subind}category name args
5622 \def\deffngeneral#1#2 #3 #4\endheader{%
5623 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5624 \dosubind{fn}{\code{#3}}{#1}%
5625 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5628 %%% Typed functions:
5630 % @deftypefn category type name args
5631 \makedefun{deftypefn}{\deftypefngeneral{}}
5633 % @deftypeop category class type name args
5634 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5636 % \deftypeopon {category on}class type name args
5637 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5639 % \deftypefngeneral {subind}category type name args
5641 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5642 \dosubind{fn}{\code{#4}}{#1}%
5643 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5646 %%% Typed variables:
5648 % @deftypevr category type var args
5649 \makedefun{deftypevr}{\deftypecvgeneral{}}
5651 % @deftypecv category class type var args
5652 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5654 % \deftypecvof {category of}class type var args
5655 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5657 % \deftypecvgeneral {subind}category type var args
5659 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5660 \dosubind{vr}{\code{#4}}{#1}%
5661 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5664 %%% Untyped variables:
5666 % @defvr category var args
5667 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5669 % @defcv category class var args
5670 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5672 % \defcvof {category of}class var args
5673 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5676 % @deftp category name args
5677 \makedefun{deftp}#1 #2 #3\endheader{%
5678 \doind{tp}{\code{#2}}%
5679 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5682 % Remaining @defun-like shortcuts:
5683 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5684 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5685 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5686 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5687 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5688 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5689 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5690 \makedefun{defmethod}{\defopon\putwordMethodon}
5691 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5692 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5693 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5695 % \defname, which formats the name of the @def (not the args).
5696 % #1 is the category, such as "Function".
5697 % #2 is the return type, if any.
5698 % #3 is the function name.
5700 % We are followed by (but not passed) the arguments, if any.
5702 \def\defname#1#2#3{%
5703 % Get the values of \leftskip and \rightskip as they were outside the @def...
5704 \advance\leftskip by -\defbodyindent
5706 % How we'll format the type name. Putting it in brackets helps
5707 % distinguish it from the body text that may end up on the next line
5710 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5712 % Figure out line sizes for the paragraph shape.
5713 % The first line needs space for \box0; but if \rightskip is nonzero,
5714 % we need only space for the part of \box0 which exceeds it:
5715 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5716 % The continuations:
5717 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5718 % (plain.tex says that \dimen1 should be used only as global.)
5719 \parshape 2 0in \dimen0 \defargsindent \dimen2
5721 % Put the type name to the right margin.
5724 \hfil\box0 \kern-\hsize
5725 % \hsize has to be shortened this way:
5727 % Intentionally do not respect \rightskip, since we need the space.
5730 % Allow all lines to be underfull without complaint:
5731 \tolerance=10000 \hbadness=10000
5732 \exdentamount=\defbodyindent
5734 % defun fonts. We use typewriter by default (used to be bold) because:
5735 % . we're printing identifiers, they should be in tt in principle.
5736 % . in languages with many accents, such as Czech or French, it's
5737 % common to leave accents off identifiers. The result looks ok in
5738 % tt, but exceedingly strange in rm.
5739 % . we don't want -- and --- to be treated as ligatures.
5740 % . this still does not fix the ?` and !` ligatures, but so far no
5741 % one has made identifiers using them :).
5743 \def\temp{#2}% return value type
5744 \ifx\temp\empty\else \tclose{\temp} \fi
5745 #3% output function name
5747 {\rm\enskip}% hskip 0.5 em of \tenrm
5750 % arguments will be output next, if any.
5753 % Print arguments in slanted roman (not ttsl), inconsistently with using
5754 % tt for the name. This is because literal text is sometimes needed in
5755 % the argument list (groff manual), and ttsl and tt are not very
5756 % distinguishable. Prevent hyphenation at `-' chars.
5759 % use sl by default (not ttsl),
5761 \df \sl \hyphenchar\font=0
5763 % On the other hand, if an argument has two dashes (for instance), we
5764 % want a way to get ttsl. Let's try @var for that.
5767 \sl\hyphenchar\font=45
5770 % We want ()&[] to print specially on the defun line.
5773 \catcode`\(=\active \catcode`\)=\active
5774 \catcode`\[=\active \catcode`\]=\active
5778 % Make control sequences which act like normal parenthesis chars.
5779 \let\lparen = ( \let\rparen = )
5781 % Be sure that we always have a definition for `(', etc. For example,
5782 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5783 % so TeX would otherwise complain about undefined control sequence.
5786 \global\let(=\lparen \global\let)=\rparen
5787 \global\let[=\lbrack \global\let]=\rbrack
5790 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5791 \gdef\magicamp{\let&=\amprm}
5794 \newcount\parencount
5796 % If we encounter &foo, then turn on ()-hacking afterwards
5798 \def\amprm#1 {\ampseentrue{\bf\ }}
5802 % At the first level, print parens in roman,
5803 % otherwise use the default font.
5804 \ifnum \parencount=1 \rm \fi
5806 % The \sf parens (in \boldbrax) actually are a little bolder than
5807 % the contained text. This is especially needed for [ and ] .
5811 \def\infirstlevel#1{%
5818 \def\bfafterword#1 {#1 \bf}
5821 \global\advance\parencount by 1
5823 \infirstlevel \bfafterword
5828 \global\advance\parencount by -1
5831 \newcount\brackcount
5833 \global\advance\brackcount by 1
5838 \global\advance\brackcount by -1
5841 \def\checkparencounts{%
5842 \ifnum\parencount=0 \else \badparencount \fi
5843 \ifnum\brackcount=0 \else \badbrackcount \fi
5845 \def\badparencount{%
5846 \errmessage{Unbalanced parentheses in @def}%
5847 \global\parencount=0
5849 \def\badbrackcount{%
5850 \errmessage{Unbalanced square braces in @def}%
5851 \global\brackcount=0
5858 % To do this right we need a feature of e-TeX, \scantokens,
5859 % which we arrange to emulate with a temporary file in ordinary TeX.
5860 \ifx\eTeXversion\undefined
5861 \newwrite\macscribble
5864 \immediate\openout\macscribble=\jobname.tmp
5865 \immediate\write\macscribble{\the\toks0}%
5866 \immediate\closeout\macscribble
5874 \let\xeatspaces\eatspaces
5875 % Undo catcode changes of \startcontents and \doprintindex
5876 % When called from @insertcopying or (short)caption, we need active
5877 % backslash to get it printed correctly. Previously, we had
5878 % \catcode`\\=\other instead. We'll see whether a problem appears
5879 % with macro expansion. --kasal, 19aug04
5880 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5884 % Append \endinput to make sure that TeX does not see the ending newline.
5885 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5887 \scantokens{#1\endinput}%
5892 \edef\temp{\noexpand\scanmacro{#1}}%
5896 \newcount\paramno % Count of parameters
5897 \newtoks\macname % Macro name
5898 \newif\ifrecursive % Is it recursive?
5900 % List of all defined macros in the form
5901 % \definedummyword\macro1\definedummyword\macro2...
5902 % Currently is also contains all @aliases; the list can be split
5903 % if there is a need.
5906 % Add the macro to \macrolist
5907 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5908 \def\addtomacrolistxxx#1{%
5909 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5910 \xdef\macrolist{\the\toks0}%
5914 % This does \let #1 = #2, with \csnames; that is,
5915 % \let \csname#1\endcsname = \csname#2\endcsname
5916 % (except of course we have to play expansion games).
5920 \csname#1\expandafter\endcsname
5924 % Trim leading and trailing spaces off a string.
5925 % Concepts from aro-bend problem 15 (see CTAN).
5927 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5928 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5929 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5931 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5934 % Trim a single trailing ^^M off a string.
5935 {\catcode`\^^M=\other \catcode`\Q=3%
5936 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5937 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5938 \gdef\eatcrb#1Q#2Q{#1}%
5941 % Macro bodies are absorbed as an argument in a context where
5942 % all characters are catcode 10, 11 or 12, except \ which is active
5943 % (as in normal texinfo). It is necessary to change the definition of \.
5945 % It's necessary to have hard CRs when the macro is executed. This is
5946 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5947 % body, and then making it the \newlinechar in \scanmacro.
5964 \catcode`\^^M=\other
5967 \def\macrobodyctxt{%
5971 \catcode`\^^M=\other
5980 % \mbodybackslash is the definition of \ in @macro bodies.
5981 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5982 % where N is the macro parameter number.
5983 % We define \csname macarg.\endcsname to be \realbackslash, so
5984 % \\ in macro replacement text gets you a backslash.
5986 {\catcode`@=0 @catcode`@\=@active
5987 @gdef@usembodybackslash{@let\=@mbodybackslash}
5988 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5990 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5992 \def\macro{\recursivefalse\parsearg\macroxxx}
5993 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5996 \getargs{#1}% now \macname is the macname and \argl the arglist
5997 \ifx\argl\empty % no arguments
6000 \expandafter\parsemargdef \argl;%
6002 \if1\csname ismacro.\the\macname\endcsname
6003 \message{Warning: redefining \the\macname}%
6005 \expandafter\ifx\csname \the\macname\endcsname \relax
6006 \else \errmessage{Macro name \the\macname\space already defined}\fi
6007 \global\cslet{macsave.\the\macname}{\the\macname}%
6008 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6009 \addtomacrolist{\the\macname}%
6011 \begingroup \macrobodyctxt
6012 \ifrecursive \expandafter\parsermacbody
6013 \else \expandafter\parsemacbody
6016 \parseargdef\unmacro{%
6017 \if1\csname ismacro.#1\endcsname
6018 \global\cslet{#1}{macsave.#1}%
6019 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6020 % Remove the macro name from \macrolist:
6022 \expandafter\let\csname#1\endcsname \relax
6023 \let\definedummyword\unmacrodo
6024 \xdef\macrolist{\macrolist}%
6027 \errmessage{Macro #1 not defined}%
6031 % Called by \do from \dounmacro on each macro. The idea is to omit any
6032 % macro definitions that have been changed to \relax.
6038 \noexpand\definedummyword \noexpand#1%
6042 % This makes use of the obscure feature that if the last token of a
6043 % <parameter list> is #, then the preceding argument is delimited by
6044 % an opening brace, and that opening brace is not consumed.
6045 \def\getargs#1{\getargsxxx#1{}}
6046 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6047 \def\getmacname #1 #2\relax{\macname={#1}}
6048 \def\getmacargs#1{\def\argl{#1}}
6050 % Parse the optional {params} list. Set up \paramno and \paramlist
6051 % so \defmacro knows what to do. Define \macarg.blah for each blah
6052 % in the params list, to be ##N where N is the position in that list.
6053 % That gets used by \mbodybackslash (above).
6055 % We need to get `macro parameter char #' into several definitions.
6056 % The technique used is stolen from LaTeX: let \hash be something
6057 % unexpandable, insert that wherever you need a #, and then redefine
6058 % it to # just before using the token list produced.
6060 % The same technique is used to protect \eatspaces till just before
6061 % the macro is used.
6063 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6064 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6065 \def\parsemargdefxxx#1,{%
6066 \if#1;\let\next=\relax
6067 \else \let\next=\parsemargdefxxx
6068 \advance\paramno by 1%
6069 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6070 {\xeatspaces{\hash\the\paramno}}%
6071 \edef\paramlist{\paramlist\hash\the\paramno,}%
6074 % These two commands read recursive and nonrecursive macro bodies.
6075 % (They're different since rec and nonrec macros end differently.)
6077 \long\def\parsemacbody#1@end macro%
6078 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6079 \long\def\parsermacbody#1@end rmacro%
6080 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6082 % This defines the macro itself. There are six cases: recursive and
6083 % nonrecursive macros of zero, one, and many arguments.
6084 % Much magic with \expandafter here.
6085 % \xdef is used so that macro definitions will survive the file
6086 % they're defined in; @include reads the file inside a group.
6088 \let\hash=##% convert placeholders to macro parameter chars
6092 \expandafter\xdef\csname\the\macname\endcsname{%
6093 \noexpand\scanmacro{\temp}}%
6095 \expandafter\xdef\csname\the\macname\endcsname{%
6096 \bgroup\noexpand\macroargctxt
6097 \noexpand\braceorline
6098 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6099 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6100 \egroup\noexpand\scanmacro{\temp}}%
6102 \expandafter\xdef\csname\the\macname\endcsname{%
6103 \bgroup\noexpand\macroargctxt
6104 \noexpand\csname\the\macname xx\endcsname}%
6105 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6106 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6107 \expandafter\expandafter
6109 \expandafter\expandafter
6110 \csname\the\macname xxx\endcsname
6111 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6116 \expandafter\xdef\csname\the\macname\endcsname{%
6117 \noexpand\norecurse{\the\macname}%
6118 \noexpand\scanmacro{\temp}\egroup}%
6120 \expandafter\xdef\csname\the\macname\endcsname{%
6121 \bgroup\noexpand\macroargctxt
6122 \noexpand\braceorline
6123 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6124 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6126 \noexpand\norecurse{\the\macname}%
6127 \noexpand\scanmacro{\temp}\egroup}%
6129 \expandafter\xdef\csname\the\macname\endcsname{%
6130 \bgroup\noexpand\macroargctxt
6131 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6132 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6133 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6134 \expandafter\expandafter
6136 \expandafter\expandafter
6137 \csname\the\macname xxx\endcsname
6140 \noexpand\norecurse{\the\macname}%
6141 \noexpand\scanmacro{\temp}\egroup}%
6145 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6147 % \braceorline decides whether the next nonwhitespace character is a
6148 % {. If so it reads up to the closing }, if not, it reads the whole
6149 % line. Whatever was read is then fed to the next control sequence
6150 % as an argument (by \parsebrace or \parsearg)
6151 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6152 \def\braceorlinexxx{%
6153 \ifx\nchar\bgroup\else
6154 \expandafter\parsearg
6159 % We need some trickery to remove the optional spaces around the equal
6160 % sign. Just make them active and then expand them all to nothing.
6161 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6162 \def\aliasxxx #1{\aliasyyy#1\relax}
6163 \def\aliasyyy #1=#2\relax{%
6165 \expandafter\let\obeyedspace=\empty
6166 \addtomacrolist{#1}%
6167 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6173 \message{cross references,}
6177 \newif\ifhavexrefs % True if xref values are known.
6178 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6180 % @inforef is relatively simple.
6181 \def\inforef #1{\inforefzzz #1,,,,**}
6182 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6183 node \samp{\ignorespaces#1{}}}
6185 % @node's only job in TeX is to define \lastnode, which is used in
6186 % cross-references. The @node line might or might not have commas, and
6187 % might or might not have spaces before the first comma, like:
6188 % @node foo , bar , ...
6189 % We don't want such trailing spaces in the node name.
6191 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6193 % also remove a trailing comma, in case of something like this:
6194 % @node Help-Cross, , , Cross-refs
6195 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6196 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6199 \let\lastnode=\empty
6201 % Write a cross-reference definition for the current node. #1 is the
6202 % type (Ynumbered, Yappendix, Ynothing).
6205 \ifx\lastnode\empty\else
6206 \setref{\lastnode}{#1}%
6207 \global\let\lastnode=\empty
6211 % @anchor{NAME} -- define xref target at arbitrary point.
6213 \newcount\savesfregister
6215 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6216 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6217 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6219 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6220 % anchor), which consists of three parts:
6221 % 1) NAME-title - the current sectioning name taken from \thissection,
6222 % or the anchor name.
6223 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6224 % empty for anchors.
6225 % 3) NAME-pg - the page number.
6227 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6228 % floats, there is an additional part, which is not written here:
6229 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6235 \atdummies % preserve commands, but don't expand them
6236 \edef\writexrdef##1##2{%
6237 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6238 ##1}{##2}}% these are parameters of \writexrdef
6240 \toks0 = \expandafter{\thissection}%
6241 \immediate \writexrdef{title}{\the\toks0 }%
6242 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6243 \writexrdef{pg}{\folio}% will be written later, during \shipout
6248 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6249 % the node name, #2 the name of the Info cross-reference, #3 the printed
6250 % node name, #4 the name of the Info file, #5 the name of the printed
6251 % manual. All but the node name can be omitted.
6253 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6254 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6255 \def\ref#1{\xrefX[#1,,,,,,,]}
6256 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6258 \def\printedmanual{\ignorespaces #5}%
6259 \def\printedrefname{\ignorespaces #3}%
6260 \setbox1=\hbox{\printedmanual\unskip}%
6261 \setbox0=\hbox{\printedrefname\unskip}%
6263 % No printed node name was explicitly given.
6264 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6265 % Use the node name inside the square brackets.
6266 \def\printedrefname{\ignorespaces #1}%
6268 % Use the actual chapter/section title appear inside
6269 % the square brackets. Use the real section title if we have it.
6271 % It is in another manual, so we don't have it.
6272 \def\printedrefname{\ignorespaces #1}%
6275 % We know the real title if we have the xref values.
6276 \def\printedrefname{\refx{#1-title}{}}%
6278 % Otherwise just copy the Info node name.
6279 \def\printedrefname{\ignorespaces #1}%
6285 % Make link in pdf output.
6290 % See comments at \activebackslashdouble.
6291 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6292 \backslashparens\pdfxrefdest}%
6294 \ifnum\filenamelength>0
6295 \startlink attr{/Border [0 0 0]}%
6296 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6298 \startlink attr{/Border [0 0 0]}%
6299 goto name{\pdfmkpgn{\pdfxrefdest}}%
6305 % Float references are printed completely differently: "Figure 1.2"
6306 % instead of "[somenode], p.3". We distinguish them by the
6307 % LABEL-title being set to a magic string.
6309 % Have to otherify everything special to allow the \csname to
6310 % include an _ in the xref name, etc.
6313 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6314 \csname XR#1-title\endcsname
6316 \iffloat\Xthisreftitle
6317 % If the user specified the print name (third arg) to the ref,
6318 % print it instead of our usual "Figure 1.2".
6325 % if the user also gave the printed manual name (fifth arg), append
6328 \space \putwordin{} \cite{\printedmanual}%
6331 % node/anchor (non-float) references.
6333 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6334 % insert empty discretionaries after hyphens, which means that it will
6335 % not find a line break at a hyphen in a node names. Since some manuals
6336 % are best written with fairly long node names, containing hyphens, this
6337 % is a loss. Therefore, we give the text of the node name again, so it
6338 % is as if TeX is seeing it for the first time.
6340 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6342 % _ (for example) has to be the character _ for the purposes of the
6343 % control sequence corresponding to the node, but it has to expand
6344 % into the usual \leavevmode...\vrule stuff for purposes of
6345 % printing. So we \turnoffactive for the \refx-snt, back on for the
6346 % printing, back off for the \refx-pg.
6348 % Only output a following space if the -snt ref is nonempty; for
6349 % @unnumbered and @anchor, it won't be.
6350 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6351 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6353 % output the `[mynode]' via a macro so it can be overridden.
6354 \xrefprintnodename\printedrefname
6356 % But we always want a comma and a space:
6359 % output the `page 3'.
6360 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6366 % This macro is called from \xrefX for the `[nodename]' part of xref
6367 % output. It's a separate macro only so it can be changed more easily,
6368 % since square brackets don't work well in some documents. Particularly
6369 % one that Bob is working on :).
6371 \def\xrefprintnodename#1{[#1]}
6373 % Things referred to by \setref.
6379 \putwordChapter@tie \the\chapno
6380 \else \ifnum\subsecno=0
6381 \putwordSection@tie \the\chapno.\the\secno
6382 \else \ifnum\subsubsecno=0
6383 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6385 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6390 \putwordAppendix@tie @char\the\appendixno{}%
6391 \else \ifnum\subsecno=0
6392 \putwordSection@tie @char\the\appendixno.\the\secno
6393 \else \ifnum\subsubsecno=0
6394 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6397 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6401 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6402 % If its value is nonempty, SUFFIX is output afterward.
6408 \expandafter\global\expandafter\let\expandafter\thisrefX
6409 \csname XR#1\endcsname
6412 % If not defined, say something at least.
6413 \angleleft un\-de\-fined\angleright
6416 \message{\linenumber Undefined cross reference `#1'.}%
6419 \global\warnedxrefstrue
6420 \message{Cross reference values unknown; you must run TeX again.}%
6425 % It's defined, so just use it.
6428 #2% Output the suffix in any case.
6431 % This is the macro invoked by entries in the aux file. Usually it's
6432 % just a \def (we prepend XR to the control sequence name to avoid
6433 % collisions). But if this is a float type, we have more work to do.
6436 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6438 % Was that xref control sequence that we just defined for a float?
6439 \expandafter\iffloat\csname XR#1\endcsname
6440 % it was a float, and we have the (safe) float type in \iffloattype.
6441 \expandafter\let\expandafter\floatlist
6442 \csname floatlist\iffloattype\endcsname
6444 % Is this the first time we've seen this float type?
6445 \expandafter\ifx\floatlist\relax
6446 \toks0 = {\do}% yes, so just \do
6448 % had it before, so preserve previous elements in list.
6449 \toks0 = \expandafter{\floatlist\do}%
6452 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6453 % for later use in \listoffloats.
6454 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6458 % Read the last existing aux file, if any. No error if none exists.
6461 \openin 1 \jobname.aux
6464 \global\havexrefstrue
6469 \def\setupdatafile{%
6470 \catcode`\^^@=\other
6471 \catcode`\^^A=\other
6472 \catcode`\^^B=\other
6473 \catcode`\^^C=\other
6474 \catcode`\^^D=\other
6475 \catcode`\^^E=\other
6476 \catcode`\^^F=\other
6477 \catcode`\^^G=\other
6478 \catcode`\^^H=\other
6479 \catcode`\^^K=\other
6480 \catcode`\^^L=\other
6481 \catcode`\^^N=\other
6482 \catcode`\^^P=\other
6483 \catcode`\^^Q=\other
6484 \catcode`\^^R=\other
6485 \catcode`\^^S=\other
6486 \catcode`\^^T=\other
6487 \catcode`\^^U=\other
6488 \catcode`\^^V=\other
6489 \catcode`\^^W=\other
6490 \catcode`\^^X=\other
6491 \catcode`\^^Z=\other
6492 \catcode`\^^[=\other
6493 \catcode`\^^\=\other
6494 \catcode`\^^]=\other
6495 \catcode`\^^^=\other
6496 \catcode`\^^_=\other
6497 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6498 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6499 % supported in the main text, it doesn't seem desirable. Furthermore,
6500 % that is not enough: for node names that actually contain a ^
6501 % character, we would end up writing a line like this: 'xrdef {'hat
6502 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6503 % argument, and \hat is not an expandable control sequence. It could
6504 % all be worked out, but why? Either we support ^^ or we don't.
6506 % The other change necessary for this was to define \auxhat:
6507 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6508 % and then to call \auxhat in \setq.
6512 % Special characters. Should be turned off anyway, but...
6525 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6527 % This is to support \ in node names and titles, since the \
6528 % characters end up in a \csname. It's easier than
6529 % leaving it active and making its active definition an actual \
6530 % character. What I don't understand is why it works in the *value*
6531 % of the xrdef. Seems like it should be a catcode12 \, and that
6532 % should not typeset properly. But it works, so I'm moving on for
6533 % now. --karl, 15jan04.
6536 % Make the characters 128-255 be printing characters.
6540 \catcode\count1=\other
6541 \advance\count1 by 1
6542 \ifnum \count1<256 \loop \fi
6546 % @ is our escape character in .aux files, and we need braces.
6552 \def\readdatafile#1{%
6558 \message{insertions,}
6559 % including footnotes.
6561 \newcount \footnoteno
6563 % The trailing space in the following definition for supereject is
6564 % vital for proper filling; pages come out unaligned when you do a
6565 % pagealignmacro call if that space before the closing brace is
6566 % removed. (Generally, numeric constants should always be followed by a
6567 % space to prevent strange expansion errors.)
6568 \def\supereject{\par\penalty -20000\footnoteno =0 }
6570 % @footnotestyle is meaningful for info output only.
6571 \let\footnotestyle=\comment
6575 % Auto-number footnotes. Otherwise like plain.
6577 \let\indent=\ptexindent
6578 \let\noindent=\ptexnoindent
6579 \global\advance\footnoteno by \@ne
6580 \edef\thisfootno{$^{\the\footnoteno}$}%
6582 % In case the footnote comes at the end of a sentence, preserve the
6583 % extra spacing after we do the footnote number.
6585 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6587 % Remove inadvertent blank space before typesetting the footnote number.
6593 % Don't bother with the trickery in plain.tex to not require the
6594 % footnote text as a parameter. Our footnotes don't need to be so general.
6596 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6597 % \parseargline) fails inside footnotes because the tokens are fixed when
6598 % the footnote is read. --karl, 16nov96.
6601 \insert\footins\bgroup
6602 % We want to typeset this text as a normal paragraph, even if the
6603 % footnote reference occurs in (for example) a display environment.
6604 % So reset some parameters.
6606 \interlinepenalty\interfootnotelinepenalty
6607 \splittopskip\ht\strutbox % top baseline for broken footnotes
6608 \splitmaxdepth\dp\strutbox
6609 \floatingpenalty\@MM
6614 \parindent\defaultparindent
6618 % Because we use hanging indentation in footnotes, a @noindent appears
6619 % to exdent this text, so make it be a no-op. makeinfo does not use
6620 % hanging indentation so @noindent can still be needed within footnote
6621 % text after an @example or the like (not that this is good style).
6622 \let\noindent = \relax
6624 % Hang the footnote text off the number. Use \everypar in case the
6625 % footnote extends for more than one paragraph.
6626 \everypar = {\hang}%
6627 \textindent{\thisfootno}%
6629 % Don't crash into the line above the footnote text. Since this
6630 % expands into a box, it must come within the paragraph, lest it
6631 % provide a place where TeX can split the footnote.
6633 \futurelet\next\fo@t
6635 }%end \catcode `\@=11
6637 % In case a @footnote appears in a vbox, save the footnote text and create
6638 % the real \insert just after the vbox finished. Otherwise, the insertion
6640 % Similarily, if a @footnote appears inside an alignment, save the footnote
6641 % text to a box and make the \insert when a row of the table is finished.
6642 % And the same can be done for other insert classes. --kasal, 16nov03.
6644 % Replace the \insert primitive by a cheating macro.
6645 % Deeper inside, just make sure that the saved insertions are not spilled
6648 \def\startsavinginserts{%
6649 \ifx \insert\ptexinsert
6650 \let\insert\saveinsert
6652 \let\checkinserts\relax
6656 % This \insert replacement works for both \insert\footins{foo} and
6657 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6660 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6661 \afterassignment\next
6662 % swallow the left brace
6665 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6666 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6668 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6670 \def\placesaveins#1{%
6671 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6675 % eat @SAVE -- beware, all of them have catcode \other:
6677 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6678 \gdef\gobblesave @SAVE{}
6682 \def\newsaveins #1{%
6683 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6686 \def\newsaveinsX #1{%
6687 \csname newbox\endcsname #1%
6688 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6693 \let\checkinserts\empty
6698 % @image. We use the macros from epsf.tex to support this.
6699 % If epsf.tex is not installed and @image is used, we complain.
6701 % Check for and read epsf.tex up front. If we read it only at @image
6702 % time, we might be inside a group, and then its definitions would get
6703 % undone and the next image would fail.
6704 \openin 1 = epsf.tex
6706 % Do not bother showing banner with epsf.tex v2.7k (available in
6707 % doc/epsf.tex and on ctan).
6708 \def\epsfannounce{\toks0 = }%
6713 % We will only complain once about lack of epsf.tex.
6714 \newif\ifwarnednoepsf
6715 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6716 work. It is also included in the Texinfo distribution, or you can get
6717 it from ftp://tug.org/tex/epsf.tex.}
6720 \ifx\epsfbox\undefined
6721 \ifwarnednoepsf \else
6722 \errhelp = \noepsfhelp
6723 \errmessage{epsf.tex not found, images will be ignored}%
6724 \global\warnednoepsftrue
6727 \imagexxx #1,,,,,\finish
6731 % Arguments to @image:
6732 % #1 is (mandatory) image filename; we tack on .eps extension.
6733 % #2 is (optional) width, #3 is (optional) height.
6734 % #4 is (ignored optional) html alt text.
6735 % #5 is (ignored optional) extension.
6736 % #6 is just the usual extra ignored arg for parsing this stuff.
6738 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6739 \catcode`\^^M = 5 % in case we're inside an example
6740 \normalturnoffactive % allow _ et al. in names
6741 % If the image is by itself, center it.
6745 % Usually we'll have text after the image which will insert
6746 % \parskip glue, so insert it here too to equalize the space
6748 \nobreak\vskip\parskip
6755 \dopdfimage{#1}{#2}{#3}%
6757 % \epsfbox itself resets \epsf?size at each figure.
6758 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6759 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6763 \ifimagevmode \egroup \bigbreak \fi % space after the image
6767 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6768 % etc. We don't actually implement floating yet, we always include the
6769 % float "here". But it seemed the best name for the future.
6771 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6773 % There may be a space before second and/or third parameter; delete it.
6774 \def\eatcommaspace#1, {#1,}
6776 % #1 is the optional FLOATTYPE, the text label for this float, typically
6777 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6778 % this float will not be numbered and cannot be referred to.
6780 % #2 is the optional xref label. Also must be present for the float to
6783 % #3 is the optional positioning argument; for now, it is ignored. It
6784 % will somehow specify the positions allowed to float to (here, top, bottom).
6786 % We keep a separate counter for each FLOATTYPE, which we reset at each
6787 % chapter-level command.
6788 \let\resetallfloatnos=\empty
6790 \def\dofloat#1,#2,#3,#4\finish{%
6791 \let\thiscaption=\empty
6792 \let\thisshortcaption=\empty
6794 % don't lose footnotes inside @float.
6796 % BEWARE: when the floats start float, we have to issue warning whenever an
6797 % insert appears inside a float which could possibly float. --kasal, 26may04
6801 % We can't be used inside a paragraph.
6806 \def\floatlabel{#2}%
6807 \def\floatloc{#3}% we do nothing with this yet.
6809 \ifx\floattype\empty
6810 \let\safefloattype=\empty
6813 % the floattype might have accents or other special characters,
6814 % but we need to use it in a control sequence name.
6817 \xdef\safefloattype{\floattype}%
6821 % If label is given but no type, we handle that as the empty type.
6822 \ifx\floatlabel\empty \else
6823 % We want each FLOATTYPE to be numbered separately (Figure 1,
6824 % Table 1, Figure 2, ...). (And if no label, no number.)
6826 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6827 \global\advance\floatno by 1
6830 % This magic value for \thissection is output by \setref as the
6831 % XREFLABEL-title value. \xrefX uses it to distinguish float
6832 % labels (which have a completely different output format) from
6833 % node and anchor labels. And \xrdef uses it to construct the
6836 \edef\thissection{\floatmagic=\safefloattype}%
6837 \setref{\floatlabel}{Yfloat}%
6841 % start with \parskip glue, I guess.
6844 % Don't suppress indentation if a float happens to start a section.
6845 \restorefirstparagraphindent
6848 % we have these possibilities:
6849 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6850 % @float Foo,lbl & no caption: Foo 1.1
6851 % @float Foo & @caption{Cap}: Foo: Cap
6852 % @float Foo & no caption: Foo
6853 % @float ,lbl & Caption{Cap}: 1.1: Cap
6854 % @float ,lbl & no caption: 1.1
6855 % @float & @caption{Cap}: Cap
6856 % @float & no caption:
6859 \let\floatident = \empty
6861 % In all cases, if we have a float type, it comes first.
6862 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6864 % If we have an xref label, the number comes next.
6865 \ifx\floatlabel\empty \else
6866 \ifx\floattype\empty \else % if also had float type, need tie first.
6867 \appendtomacro\floatident{\tie}%
6870 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6873 % Start the printed caption with what we've constructed in
6874 % \floatident, but keep it separate; we need \floatident again.
6875 \let\captionline = \floatident
6877 \ifx\thiscaption\empty \else
6878 \ifx\floatident\empty \else
6879 \appendtomacro\captionline{: }% had ident, so need a colon between
6883 \appendtomacro\captionline{\scanexp\thiscaption}%
6886 % If we have anything to print, print it, with space before.
6887 % Eventually this needs to become an \insert.
6888 \ifx\captionline\empty \else
6892 % Space below caption.
6896 % If have an xref label, write the list of floats info. Do this
6897 % after the caption, to avoid chance of it being a breakpoint.
6898 \ifx\floatlabel\empty \else
6899 % Write the text that goes in the lof to the aux file as
6900 % \floatlabel-lof. Besides \floatident, we include the short
6901 % caption if specified, else the full caption if specified, else nothing.
6905 % since we read the caption text in the macro world, where ^^M
6906 % is turned into a normal character, we have to scan it back, so
6907 % we don't write the literal three characters "^^M" into the aux file.
6909 \xdef\noexpand\gtemp{%
6910 \ifx\thisshortcaption\empty
6917 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6918 \ifx\gtemp\empty \else : \gtemp \fi}}%
6921 \egroup % end of \vtop
6923 % place the captured inserts
6925 % BEWARE: when the floats start floating, we have to issue warning
6926 % whenever an insert appears inside a float which could possibly
6927 % float. --kasal, 26may04
6932 % Append the tokens #2 to the definition of macro #1, not expanding either.
6934 \def\appendtomacro#1#2{%
6935 \expandafter\def\expandafter#1\expandafter{#1#2}%
6938 % @caption, @shortcaption
6940 \def\caption{\docaption\thiscaption}
6941 \def\shortcaption{\docaption\thisshortcaption}
6942 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6943 \def\defcaption#1#2{\egroup \def#1{#2}}
6945 % The parameter is the control sequence identifying the counter we are
6946 % going to use. Create it if it doesn't exist and assign it to \floatno.
6949 % Haven't seen this figure type before.
6950 \csname newcount\endcsname #1%
6952 % Remember to reset this floatno at the next chap.
6953 \expandafter\gdef\expandafter\resetallfloatnos
6954 \expandafter{\resetallfloatnos #1=0 }%
6959 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6960 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6961 % first read the @float command.
6963 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6965 % Magic string used for the XREFLABEL-title value, so \xrefX can
6966 % distinguish floats from other xref types.
6967 \def\floatmagic{!!float!!}
6969 % #1 is the control sequence we are passed; we expand into a conditional
6970 % which is true if #1 represents a float ref. That is, the magic
6971 % \thissection value which we \setref above.
6973 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6975 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6976 % (safe) float type for this float. We set \iffloattype to #2.
6978 \def\doiffloat#1=#2=#3\finish{%
6980 \def\iffloattype{#2}%
6981 \ifx\temp\floatmagic
6984 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6986 \parseargdef\listoffloats{%
6987 \def\floattype{#1}% floattype
6989 % the floattype might have accents or other special characters,
6990 % but we need to use it in a control sequence name.
6993 \xdef\safefloattype{\floattype}%
6996 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6997 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6999 % if the user said @listoffloats foo but never @float foo.
7000 \message{\linenumber No `\safefloattype' floats to list.}%
7004 \leftskip=\tocindent % indent these entries like a toc
7005 \let\do=\listoffloatsdo
7006 \csname floatlist\safefloattype\endcsname
7011 % This is called on each entry in a list of floats. We're passed the
7012 % xref label, in the form LABEL-title, which is how we save it in the
7013 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7014 % has the text we're supposed to typeset here.
7016 % Figures without xref labels will not be included in the list (since
7017 % they won't appear in the aux file).
7019 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7020 \def\listoffloatsdoentry#1-title\finish{{%
7021 % Can't fully expand XR#1-lof because it can contain anything. Just
7022 % pass the control sequence. On the other hand, XR#1-pg is just the
7023 % page number, and we want to fully expand that so we can get a link
7025 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7027 % use the same \entry macro we use to generate the TOC and index.
7028 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7032 \message{localization,}
7035 % @documentlanguage is usually given very early, just after
7036 % @setfilename. If done too late, it may not override everything
7037 % properly. Single argument is the language abbreviation.
7038 % It would be nice if we could set up a hyphenation file here.
7040 \parseargdef\documentlanguage{%
7041 \tex % read txi-??.tex file in plain TeX.
7042 % Read the file if it exists.
7043 \openin 1 txi-#1.tex
7045 \errhelp = \nolanghelp
7046 \errmessage{Cannot read language file txi-#1.tex}%
7053 \newhelp\nolanghelp{The given language definition file cannot be found or
7054 is empty. Maybe you need to install it? In the current directory
7055 should work if nowhere else does.}
7058 % @documentencoding should change something in TeX eventually, most
7059 % likely, but for now just recognize it.
7060 \let\documentencoding = \comment
7063 % Page size parameters.
7065 \newdimen\defaultparindent \defaultparindent = 15pt
7067 \chapheadingskip = 15pt plus 4pt minus 2pt
7068 \secheadingskip = 12pt plus 3pt minus 2pt
7069 \subsecheadingskip = 9pt plus 2pt minus 2pt
7071 % Prevent underfull vbox error messages.
7074 % Don't be so finicky about underfull hboxes, either.
7077 % Following George Bush, just get rid of widows and orphans.
7081 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7082 % using an old version of TeX, don't do anything. We want the amount of
7083 % stretch added to depend on the line length, hence the dependence on
7084 % \hsize. We call this whenever the paper size is set.
7086 \def\setemergencystretch{%
7087 \ifx\emergencystretch\thisisundefined
7088 % Allow us to assign to \emergencystretch anyway.
7089 \def\emergencystretch{\dimen0}%
7091 \emergencystretch = .15\hsize
7095 % Parameters in order: 1) textheight; 2) textwidth;
7096 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
7097 % 7) physical page height; 8) physical page width.
7099 % We also call \setleading{\textleading}, so the caller should define
7100 % \textleading. The caller should also set \parskip.
7102 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
7105 \splittopskip = \topskip
7108 \advance\vsize by \topskip
7109 \outervsize = \vsize
7110 \advance\outervsize by 2\topandbottommargin
7111 \pageheight = \vsize
7114 \outerhsize = \hsize
7115 \advance\outerhsize by 0.5in
7118 \normaloffset = #4\relax
7119 \bindingoffset = #5\relax
7122 \pdfpageheight #7\relax
7123 \pdfpagewidth #8\relax
7126 \setleading{\textleading}
7128 \parindent = \defaultparindent
7129 \setemergencystretch
7132 % @letterpaper (the default).
7133 \def\letterpaper{{\globaldefs = 1
7134 \parskip = 3pt plus 2pt minus 1pt
7135 \textleading = 13.2pt
7137 % If page is nothing but text, make it come out even.
7138 \internalpagesizes{46\baselineskip}{6in}%
7140 {\bindingoffset}{36pt}%
7144 % Use @smallbook to reset parameters for 7x9.25 trim size.
7145 \def\smallbook{{\globaldefs = 1
7146 \parskip = 2pt plus 1pt
7149 \internalpagesizes{7.5in}{5in}%
7151 {\bindingoffset}{16pt}%
7154 \lispnarrowing = 0.3in
7157 \contentsrightmargin = 0pt
7158 \defbodyindent = .5cm
7161 % Use @smallerbook to reset parameters for 6x9 trim size.
7162 % (Just testing, parameters still in flux.)
7163 \def\smallerbook{{\globaldefs = 1
7164 \parskip = 1.5pt plus 1pt
7167 \internalpagesizes{7.4in}{4.8in}%
7172 \lispnarrowing = 0.25in
7175 \contentsrightmargin = 0pt
7176 \defbodyindent = .4cm
7179 % Use @afourpaper to print on European A4 paper.
7180 \def\afourpaper{{\globaldefs = 1
7181 \parskip = 3pt plus 2pt minus 1pt
7182 \textleading = 13.2pt
7184 % Double-side printing via postscript on Laserjet 4050
7185 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7186 % To change the settings for a different printer or situation, adjust
7187 % \normaloffset until the front-side and back-side texts align. Then
7188 % do the same for \bindingoffset. You can set these for testing in
7189 % your texinfo source file like this:
7191 % \global\normaloffset = -6mm
7192 % \global\bindingoffset = 10mm
7194 \internalpagesizes{51\baselineskip}{160mm}
7195 {\voffset}{\hoffset}%
7196 {\bindingoffset}{44pt}%
7201 \contentsrightmargin = 0pt
7202 \defbodyindent = 5mm
7205 % Use @afivepaper to print on European A5 paper.
7206 % From romildo@urano.iceb.ufop.br, 2 July 2000.
7207 % He also recommends making @example and @lisp be small.
7208 \def\afivepaper{{\globaldefs = 1
7209 \parskip = 2pt plus 1pt minus 0.1pt
7210 \textleading = 12.5pt
7212 \internalpagesizes{160mm}{120mm}%
7213 {\voffset}{\hoffset}%
7214 {\bindingoffset}{8pt}%
7217 \lispnarrowing = 0.2in
7220 \contentsrightmargin = 0pt
7221 \defbodyindent = 2mm
7225 % A specific text layout, 24x15cm overall, intended for A4 paper.
7226 \def\afourlatex{{\globaldefs = 1
7228 \internalpagesizes{237mm}{150mm}%
7230 {\bindingoffset}{7mm}%
7233 % Must explicitly reset to 0 because we call \afourpaper.
7237 % Use @afourwide to print on A4 paper in landscape format.
7238 \def\afourwide{{\globaldefs = 1
7240 \internalpagesizes{241mm}{165mm}%
7241 {\voffset}{-2.95mm}%
7242 {\bindingoffset}{7mm}%
7247 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7248 % Perhaps we should allow setting the margins, \topskip, \parskip,
7249 % and/or leading, also. Or perhaps we should compute them somehow.
7251 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7252 \def\pagesizesyyy#1,#2,#3\finish{{%
7253 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7256 \parskip = 3pt plus 2pt minus 1pt
7257 \setleading{\textleading}%
7260 \advance\dimen0 by \voffset
7263 \advance\dimen2 by \normaloffset
7265 \internalpagesizes{#1}{\hsize}%
7266 {\voffset}{\normaloffset}%
7267 {\bindingoffset}{44pt}%
7271 % Set default to letter.
7276 \message{and turning on texinfo input format.}
7278 % Define macros to output various characters with catcode for normal text.
7288 \def\normaldoublequote{"}
7291 \def\normalunderscore{_}
7292 \def\normalverticalbar{|}
7294 \def\normalgreater{>}
7296 \def\normaldollar{$}%$ font-lock fix
7298 % This macro is used to make a character print one way in \tt
7299 % (where it can probably be output as-is), and another way in other fonts,
7300 % where something hairier probably needs to be done.
7302 % #1 is what to print if we are indeed using \tt; #2 is what to print
7303 % otherwise. Since all the Computer Modern typewriter fonts have zero
7304 % interword stretch (and shrink), and it is reasonable to expect all
7305 % typewriter fonts to have this, we can check that font parameter.
7307 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7309 % Same as above, but check for italic font. Actually this also catches
7310 % non-italic slanted fonts since it is impossible to distinguish them from
7311 % italic fonts. But since this is only used by $ and it uses \sl anyway
7312 % this is not a problem.
7313 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7315 % Turn off all special characters except @
7316 % (and those which the user can use as if they were ordinary).
7317 % Most of these we simply print from the \tt font, but for some, we can
7318 % use math or other variants that look better in normal text.
7321 \def\activedoublequote{{\tt\char34}}
7322 \let"=\activedoublequote
7324 \def~{{\tt\char126}}
7330 \def_{\ifusingtt\normalunderscore\_}
7332 % Subroutine for the previous macro.
7333 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7336 \def|{{\tt\char124}}
7344 \def+{{\tt \char 43}}
7346 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7348 % If a .fmt file is being used, characters that might appear in a file
7349 % name cannot be active until we have parsed the command line.
7350 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7351 % \otherifyactive is called near the end of this file.
7352 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7354 % Used sometimes to turn off (effectively) the active characters even after
7356 \def\turnoffactive{%
7357 \normalturnoffactive
7363 % \backslashcurfont outputs one backslash character in current font,
7365 \global\chardef\backslashcurfont=`\\
7366 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7368 % \realbackslash is an actual character `\' with catcode other, and
7369 % \doublebackslash is two of them (for the pdf outlines).
7370 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7372 % In texinfo, backslash is an active character; it prints the backslash
7373 % in fixed width font.
7375 @def@normalbackslash{{@tt@backslashcurfont}}
7376 % On startup, @fixbackslash assigns:
7377 % @let \ = @normalbackslash
7379 % \rawbackslash defines an active \ to do \backslashcurfont.
7380 % \otherbackslash defines an active \ to be a literal `\' character with
7382 @gdef@rawbackslash{@let\=@backslashcurfont}
7383 @gdef@otherbackslash{@let\=@realbackslash}
7385 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7386 % the literal character `\'.
7388 @def@normalturnoffactive{%
7389 @let\=@normalbackslash
7390 @let"=@normaldoublequote
7393 @let_=@normalunderscore
7394 @let|=@normalverticalbar
7396 @let>=@normalgreater
7398 @let$=@normaldollar %$ font-lock fix
7402 % Make _ and + \other characters, temporarily.
7403 % This is canceled by @fixbackslash.
7406 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7407 % That is what \eatinput is for; after that, the `\' should revert to printing
7410 @gdef@eatinput input texinfo{@fixbackslash}
7411 @global@let\ = @eatinput
7413 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7414 % the first `\' in the file would cause an error. This macro tries to fix
7415 % that, assuming it is called before the first `\' could plausibly occur.
7416 % Also turn back on active characters that might appear in the input
7417 % file name, in case not using a pre-dumped format.
7419 @gdef@fixbackslash{%
7420 @ifx\@eatinput @let\ = @normalbackslash @fi
7425 % Say @foo, not \foo, in error messages.
7428 % These look ok in all fonts, so just make them not special.
7429 @catcode`@& = @other
7430 @catcode`@# = @other
7431 @catcode`@% = @other
7435 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7436 @c page-delimiter: "^\\\\message"
7437 @c time-stamp-start: "def\\\\texinfoversion{"
7438 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7439 @c time-stamp-end: "}"
7445 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115