1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2005-12-25.16}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % 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.
297 % Do this early so pdf references go to the beginning of the page.
298 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
300 \ifcropmarks \vbox to \outervsize\bgroup
302 \vskip-\topandbottommargin
304 \line{\ewtop\hfil\ewtop}%
307 \vbox{\moveleft\cornerthick\nstop}%
309 \vbox{\moveright\cornerthick\nstop}%
312 \vskip\topandbottommargin
314 \hfil % center the page within the outer (page) hsize.
315 \ifodd\pageno\hskip\bindingoffset\fi
321 \ifdim\ht\footlinebox > 0pt
322 % Only leave this space if the footline is nonempty.
323 % (We lessened \vsize for it in \oddfootingxxx.)
324 % The \baselineskip=24pt in plain's \makefootline has no effect.
325 \vskip 2\baselineskip
330 \egroup % end of \vbox\bgroup
331 \hfil\egroup % end of (centering) \line\bgroup
332 \vskip\topandbottommargin plus1fill minus1fill
333 \boxmaxdepth = \cornerthick
336 \vbox{\moveleft\cornerthick\nsbot}%
338 \vbox{\moveright\cornerthick\nsbot}%
341 \line{\ewbot\hfil\ewbot}%
343 \egroup % \vbox from first cropmarks clause
345 }% end of \shipout\vbox
346 }% end of group with \indexdummies
348 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
351 \newinsert\margin \dimen\margin=\maxdimen
353 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
355 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
356 % marginal hacks, juha@viisa.uucp (Juha Takala)
357 \ifvoid\margin\else % marginal info is present
358 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
359 \dimen@=\dp#1 \unvbox#1
360 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
361 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
364 % Here are the rules for the cropmarks. Note that they are
365 % offset so that the space between them is truly \outerhsize or \outervsize
366 % (P. A. MacKay, 12 November, 1986)
368 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
370 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
371 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
373 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
375 % Parse an argument, then pass it to #1. The argument is the rest of
376 % the input line (except we remove a trailing comment). #1 should be a
377 % macro which expects an ordinary undelimited TeX argument.
379 \def\parsearg{\parseargusing{}}
380 \def\parseargusing#1#2{%
386 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
390 \gdef\parseargline#1^^M{%
391 \endgroup % End of the group started in \parsearg.
392 \argremovecomment #1\comment\ArgTerm%
396 % First remove any @comment, then any @c comment.
397 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
398 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
400 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
402 % \argremovec might leave us with trailing space, e.g.,
403 % @end itemize @c foo
404 % This space token undergoes the same procedure and is eventually removed
405 % by \finishparsearg.
407 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
408 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
409 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
412 % We cannot use \next here, as it holds the macro to run;
413 % thus we reuse \temp.
414 \let\temp\finishparsearg
416 \let\temp\argcheckspaces
418 % Put the space token in:
422 % If a _delimited_ argument is enclosed in braces, they get stripped; so
423 % to get _exactly_ the rest of the line, we had to prevent such situation.
424 % We prepended an \empty token at the very beginning and we expand it now,
425 % just before passing the control to \next.
426 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
427 % either the null string, or it ends with \^^M---thus there is no danger
428 % that a pair of braces would be stripped.
430 % But first, we have to remove the trailing space token.
432 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
434 % \parseargdef\foo{...}
435 % is roughly equivalent to
436 % \def\foo{\parsearg\Xfoo}
439 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
440 % favourite TeX trick. --kasal, 16nov03
443 \expandafter \doparseargdef \csname\string#1\endcsname #1%
445 \def\doparseargdef#1#2{%
450 % Several utility definitions with active space:
455 % Make each space character in the input produce a normal interword
456 % space in the output. Don't allow a line break at this space, as this
457 % is used only in environments like @example, where each line of input
458 % should produce a line of output anyway.
460 \gdef\sepspaces{\obeyspaces\let =\tie}
462 % If an index command is used in an @example environment, any spaces
463 % therein should become regular spaces in the raw index file, not the
464 % expansion of \tie (\leavevmode \penalty \@M \ ).
465 \gdef\unsepspaces{\let =\space}
469 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
471 % Define the framework for environments in texinfo.tex. It's used like this:
476 % It's the responsibility of \envdef to insert \begingroup before the
477 % actual body; @end closes the group after calling \Efoo. \envdef also
478 % defines \thisenv, so the current environment is known; @end checks
479 % whether the environment name matches. The \checkenv macro can also be
480 % used to check whether the current environment is the one expected.
482 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
483 % are not treated as enviroments; they don't open a group. (The
484 % implementation of @end takes care not to call \endgroup in this
488 % At runtime, environments start with this:
489 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
493 % ... but they get defined via ``\envdef\foo{...}'':
494 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
495 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
497 % Check whether we're in the right environment:
506 % Evironment mismatch, #1 expected:
509 \errmessage{This command can appear only \inenvironment\temp,
510 not \inenvironment\thisenv}%
512 \def\inenvironment#1{%
514 out of any environment%
516 in environment \expandafter\string#1%
520 % @end foo executes the definition of \Efoo.
521 % But first, it executes a specialized version of \checkenv
524 \if 1\csname iscond.#1\endcsname
526 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
527 \expandafter\checkenv\csname#1\endcsname
528 \csname E#1\endcsname
533 \newhelp\EMsimple{Press RETURN to continue.}
536 %% Simple single-character @ commands
539 % Kludge this until the fonts are right (grr).
542 % This is turned off because it was never documented
543 % and you can use @w{...} around a quote to suppress ligatures.
544 %% Define @` and @' to be the same as ` and '
545 %% but suppressing ligatures.
549 % Used to generate quoted braces.
550 \def\mylbrace {{\tt\char123}}
551 \def\myrbrace {{\tt\char125}}
555 % Definitions to produce \{ and \} commands for indices,
556 % and @{ and @} for the aux/toc files.
557 \catcode`\{ = \other \catcode`\} = \other
558 \catcode`\[ = 1 \catcode`\] = 2
559 \catcode`\! = 0 \catcode`\\ = \other
562 !gdef!lbraceatcmd[@{]%
563 !gdef!rbraceatcmd[@}]%
566 % @comma{} to avoid , parsing problems.
569 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
570 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
573 \def\ringaccent#1{{\accent23 #1}}
578 % Other special characters: @questiondown @exclamdown @ordf @ordm
579 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
580 \def\questiondown{?`}
582 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
583 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
585 % Dotless i and dotless j, used for accents.
590 \ifx\temp\imacro \ptexi
591 \else\ifx\temp\jmacro \j
592 \else \errmessage{@dotless can be used only with i or j}%
596 % The \TeX{} logo, as in plain, but resetting the spacing so that a
597 % period following counts as ending a sentence. (Idea found in latex.)
599 \edef\TeX{\TeX \spacefactor=1000 }
601 % @LaTeX{} logo. Not quite the same results as the definition in
602 % latex.ltx, since we use a different font for the raised A; it's most
603 % convenient for us to use an explicitly smaller font, rather than using
604 % the \scriptstyle font (since we don't reset \scriptstyle and
605 % \scriptscriptstyle).
610 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
615 % Be sure we're in horizontal mode when doing a tie, since we make space
616 % equivalent to this in @example-like environments. Otherwise, a space
617 % at the beginning of a line will start with \penalty -- and
618 % since \penalty is valid in vertical mode, we'd end up putting the
619 % penalty on the vertical list instead of in the new paragraph.
621 % Avoid using \@M directly, because that causes trouble
622 % if the definition is written into an index file.
623 \global\let\tiepenalty = \@M
624 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
627 % @: forces normal size whitespace following.
628 \def\:{\spacefactor=1000 }
630 % @* forces a line break.
631 \def\*{\hfil\break\hbox{}\ignorespaces}
633 % @/ allows a line break.
636 % @. is an end-of-sentence period.
637 \def\.{.\spacefactor=\endofsentencespacefactor\space}
639 % @! is an end-of-sentence bang.
640 \def\!{!\spacefactor=\endofsentencespacefactor\space}
642 % @? is an end-of-sentence query.
643 \def\?{?\spacefactor=\endofsentencespacefactor\space}
645 % @frenchspacing on|off says whether to put extra space after punctuation.
650 \parseargdef\frenchspacing{%
652 \ifx\temp\onword \plainfrenchspacing
653 \else\ifx\temp\offword \plainnonfrenchspacing
656 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
660 % @w prevents a word break. Without the \leavevmode, @w at the
661 % beginning of a paragraph, when TeX is still in vertical mode, would
662 % produce a whole line of output instead of starting the paragraph.
663 \def\w#1{\leavevmode\hbox{#1}}
665 % @group ... @end group forces ... to be all on one page, by enclosing
666 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
667 % to keep its height that of a normal line. According to the rules for
668 % \topskip (p.114 of the TeXbook), the glue inserted is
669 % max (\topskip - \ht (first item), 0). If that height is large,
670 % therefore, no glue is inserted, and the space between the headline and
671 % the text is small, which looks bad.
673 % Another complication is that the group might be very large. This can
674 % cause the glue on the previous page to be unduly stretched, because it
675 % does not have much material. In this case, it's better to add an
676 % explicit \vfill so that the extra space is at the bottom. The
677 % threshold for doing this is if the group is more than \vfilllimit
678 % percent of a page (\vfilllimit can be changed inside of @tex).
684 \ifnum\catcode`\^^M=\active \else
685 \errhelp = \groupinvalidhelp
686 \errmessage{@group invalid in context where filling is enabled}%
690 \setbox\groupbox = \vtop\bgroup
691 % Do @comment since we are called inside an environment such as
692 % @example, where each end-of-line in the input causes an
693 % end-of-line in the output. We don't want the end-of-line after
694 % the `@group' to put extra space in the output. Since @group
695 % should appear on a line by itself (according to the Texinfo
696 % manual), we don't worry about eating any user text.
700 % The \vtop produces a box with normal height and large depth; thus, TeX puts
701 % \baselineskip glue before it, and (when the next line of text is done)
702 % \lineskip glue after it. Thus, space below is not quite equal to space
703 % above. But it's pretty close.
705 % To get correct interline space between the last line of the group
706 % and the first line afterwards, we have to propagate \prevdepth.
707 \endgraf % Not \par, as it may have been set to \lisppar.
708 \global\dimen1 = \prevdepth
709 \egroup % End the \vtop.
710 % \dimen0 is the vertical size of the group's box.
711 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
712 % \dimen2 is how much space is left on the page (more or less).
713 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
714 % if the group doesn't fit on the current page, and it's a big big
715 % group, force a page break.
716 \ifdim \dimen0 > \dimen2
717 \ifdim \pagetotal < \vfilllimit\pageheight
726 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
727 % message, so this ends up printing `@group can only ...'.
729 \newhelp\groupinvalidhelp{%
730 group can only be used in environments such as @example,^^J%
731 where each line of input produces a line of output.}
733 % @need space-in-mils
734 % forces a page break if there is not space-in-mils remaining.
736 \newdimen\mil \mil=0.001in
738 % Old definition--didn't work.
739 %\parseargdef\need{\par %
740 %% This method tries to make TeX break the page naturally
741 %% if the depth of the box does not fit.
743 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
748 % Ensure vertical mode, so we don't make a big box in the middle of a
752 % If the @need value is less than one line space, it's useless.
754 \dimen2 = \ht\strutbox
755 \advance\dimen2 by \dp\strutbox
756 \ifdim\dimen0 > \dimen2
758 % Do a \strut just to make the height of this box be normal, so the
759 % normal leading is inserted relative to the preceding line.
760 % And a page break here is fine.
761 \vtop to #1\mil{\strut\vfil}%
763 % TeX does not even consider page breaks if a penalty added to the
764 % main vertical list is 10000 or more. But in order to see if the
765 % empty box we just added fits on the page, we must make it consider
766 % page breaks. On the other hand, we don't want to actually break the
767 % page after the empty box. So we use a penalty of 9999.
769 % There is an extremely small chance that TeX will actually break the
770 % page at this \penalty, if there are no other feasible breakpoints in
771 % sight. (If the user is using lots of big @group commands, which
772 % almost-but-not-quite fill up a page, TeX will have a hard time doing
773 % good page breaking, for example.) However, I could not construct an
774 % example where a page broke at this \penalty; if it happens in a real
775 % document, then we can reconsider our strategy.
778 % Back up by the size of the box, whether we did a page break or not.
781 % Do not allow a page break right after this kern.
786 % @br forces paragraph break (and is undocumented).
790 % @page forces the start of a new page.
792 \def\page{\par\vfill\supereject}
795 % outputs text on separate line in roman font, starting at standard page margin
797 % This records the amount of indent in the innermost environment.
798 % That's how much \exdent should take out.
799 \newskip\exdentamount
801 % This defn is used inside fill environments such as @defun.
802 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
804 % This defn is used inside nofill environments such as @example.
805 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
806 \leftline{\hskip\leftskip{\rm#1}}}}
808 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
809 % paragraph. For more general purposes, use the \margin insertion
810 % class. WHICH is `l' or `r'.
812 \newskip\inmarginspacing \inmarginspacing=1cm
813 \def\strutdepth{\dp\strutbox}
815 \def\doinmargin#1#2{\strut\vadjust{%
818 \vtop to \strutdepth{%
819 \baselineskip=\strutdepth
821 % if you have multiple lines of stuff to put here, you'll need to
822 % make the vbox yourself of the appropriate size.
824 \llap{\ignorespaces #2\hskip\inmarginspacing}%
826 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
831 \def\inleftmargin{\doinmargin l}
832 \def\inrightmargin{\doinmargin r}
834 % @inmargin{TEXT [, RIGHT-TEXT]}
835 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
836 % else use TEXT for both).
838 \def\inmargin#1{\parseinmargin #1,,\finish}
839 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
840 \setbox0 = \hbox{\ignorespaces #2}%
842 \def\lefttext{#1}% have both texts
845 \def\lefttext{#1}% have only one text
850 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
852 \def\temp{\inleftmargin\lefttext}%
857 % @include file insert text of that file as input.
859 \def\include{\parseargusing\filenamecatcodes\includezzz}
865 \def\temp{\input #1 }%
870 \def\filenamecatcodes{%
882 \def\pushthisfilestack{%
883 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
885 \def\pushthisfilestackX{%
886 \expandafter\pushthisfilestackY\thisfile\StackTerm
888 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
889 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
892 \def\popthisfilestack{\errthisfilestackempty}
893 \def\errthisfilestackempty{\errmessage{Internal error:
894 the stack of filenames is empty.}}
899 % outputs that line, centered.
901 \parseargdef\center{%
907 \next{\hfil \ignorespaces#1\unskip \hfil}%
912 \advance\hsize by -\leftskip
913 \advance\hsize by -\rightskip
918 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
920 % @sp n outputs n lines of vertical space
922 \parseargdef\sp{\vskip #1\baselineskip}
924 % @comment ...line which is ignored...
925 % @c is the same as @comment
926 % @ignore ... @end ignore is another way to write a comment
928 \def\comment{\begingroup \catcode`\^^M=\other%
929 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
931 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
935 % @paragraphindent NCHARS
936 % We'll use ems for NCHARS, close enough.
937 % NCHARS can also be the word `asis' or `none'.
938 % We cannot feasibly implement @paragraphindent asis, though.
940 \def\asisword{asis} % no translation, these are keywords
943 \parseargdef\paragraphindent{%
948 \defaultparindent = 0pt
950 \defaultparindent = #1em
953 \parindent = \defaultparindent
956 % @exampleindent NCHARS
957 % We'll use ems for NCHARS like @paragraphindent.
958 % It seems @exampleindent asis isn't necessary, but
959 % I preserve it to make it similar to @paragraphindent.
960 \parseargdef\exampleindent{%
967 \lispnarrowing = #1em
972 % @firstparagraphindent WORD
973 % If WORD is `none', then suppress indentation of the first paragraph
974 % after a section heading. If WORD is `insert', then do indent at such
977 % The paragraph indentation is suppressed or not by calling
978 % \suppressfirstparagraphindent, which the sectioning commands do.
979 % We switch the definition of this back and forth according to WORD.
980 % By default, we suppress indentation.
982 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
983 \def\insertword{insert}
985 \parseargdef\firstparagraphindent{%
988 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
989 \else\ifx\temp\insertword
990 \let\suppressfirstparagraphindent = \relax
993 \errmessage{Unknown @firstparagraphindent option `\temp'}%
997 % Here is how we actually suppress indentation. Redefine \everypar to
998 % \kern backwards by \parindent, and then reset itself to empty.
1000 % We also make \indent itself not actually do anything until the next
1003 \gdef\dosuppressfirstparagraphindent{%
1005 \restorefirstparagraphindent
1009 \restorefirstparagraphindent
1012 \global\everypar = {%
1014 \restorefirstparagraphindent
1018 \gdef\restorefirstparagraphindent{%
1019 \global \let \indent = \ptexindent
1020 \global \let \noindent = \ptexnoindent
1021 \global \everypar = {}%
1025 % @asis just yields its argument. Used with @table, for example.
1029 % @math outputs its argument in math mode.
1031 % One complication: _ usually means subscripts, but it could also mean
1032 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1033 % _ active, and distinguish by seeing if the current family is \slfam,
1034 % which is what @var uses.
1036 \catcode`\_ = \active
1037 \gdef\mathunderscore{%
1039 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1042 % Another complication: we want \\ (and @\) to output a \ character.
1043 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1044 % this is not advertised and we don't care. Texinfo does not
1045 % otherwise define @\.
1047 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1048 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1053 \let\\ = \mathbackslash
1057 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1059 % Some active characters (such as <) are spaced differently in math.
1060 % We have to reset their definitions in case the @math was an argument
1061 % to a command which sets the catcodes (such as @item or @section).
1064 \catcode`^ = \active
1065 \catcode`< = \active
1066 \catcode`> = \active
1067 \catcode`+ = \active
1076 % @bullet and @minus need the same treatment as @math, just above.
1077 \def\bullet{$\ptexbullet$}
1080 % @dots{} outputs an ellipsis using the current font.
1081 % We do .5em per period so that it has the same spacing in a typewriter
1082 % font as three actual period characters.
1087 \hskip 0pt plus 0.25fil
1089 \hskip 0pt plus 0.5fil
1093 % @enddots{} is an end-of-sentence ellipsis.
1097 \spacefactor=\endofsentencespacefactor
1100 % @comma{} is so commas can be inserted into text without messing up
1101 % Texinfo's parsing.
1105 % @refill is a no-op.
1108 % If working on a large document in chapters, it is convenient to
1109 % be able to disable indexing, cross-referencing, and contents, for test runs.
1110 % This is done with @novalidate (before @setfilename).
1112 \newif\iflinks \linkstrue % by default we want the aux files.
1113 \let\novalidate = \linksfalse
1115 % @setfilename is done at the beginning of every texinfo file.
1116 % So open here the files we need to have open while reading the input.
1117 % This makes it possible to make a .fmt file for texinfo.
1119 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1122 % Open the new aux file. TeX will close it automatically at exit.
1123 \immediate\openout\auxfile=\jobname.aux
1124 \fi % \openindices needs to do some work in any case.
1126 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1128 % If texinfo.cnf is present on the system, read it.
1129 % Useful for site-wide @afourpaper, etc.
1130 \openin 1 texinfo.cnf
1131 \ifeof 1 \else \input texinfo.cnf \fi
1134 \comment % Ignore the actual filename.
1137 % Called from \setfilename.
1149 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1153 % adobe `portable' document format
1157 \newcount\filenamelength
1166 \newif\ifpdfmakepagedest
1168 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1169 % can be set). So we test for \relax and 0 as well as \undefined,
1170 % borrowed from ifpdf.sty.
1171 \ifx\pdfoutput\undefined
1173 \ifx\pdfoutput\relax
1182 % PDF uses PostScript string constants for the names of xref targets,
1183 % for display in the outlines, and in other places. Thus, we have to
1184 % double any backslashes. Otherwise, a name like "\node" will be
1185 % interpreted as a newline (\n), followed by o, d, e. Not good.
1186 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1187 % (and related messages, the final outcome is that it is up to the TeX
1188 % user to double the backslashes and otherwise make the string valid, so
1189 % that's what we do).
1191 % double active backslashes.
1193 {\catcode`\@=0 \catcode`\\=\active
1194 @gdef@activebackslashdouble{%
1196 @let\=@doublebackslash}
1199 % To handle parens, we must adopt a different approach, since parens are
1200 % not active characters. hyperref.dtx (which has the same problem as
1201 % us) handles it with this amazing macro to replace tokens. I've
1202 % tinkered with it a little for texinfo, but it's definitely from there.
1204 % #1 is the tokens to replace.
1205 % #2 is the replacement.
1206 % #3 is the control sequence with the string.
1208 \def\HyPsdSubst#1#2#3{%
1209 \def\HyPsdReplace##1#1##2\END{%
1215 \HyPsdReplace##2\END
1219 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1221 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1223 % #1 is a control sequence in which to do the replacements.
1224 \def\backslashparens#1{%
1225 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1226 % \lastnode when called from \setref -> \pdfmkdest.
1227 \HyPsdSubst{(}{\realbackslash(}{#1}%
1228 \HyPsdSubst{)}{\realbackslash)}{#1}%
1233 \pdfcatalog{/PageMode /UseOutlines}%
1234 \def\dopdfimage#1#2#3{%
1235 \def\imagewidth{#2}%
1236 \def\imageheight{#3}%
1237 % without \immediate, pdftex seg faults when the same image is
1238 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1239 \ifnum\pdftexversion < 14
1242 \immediate\pdfximage
1244 \ifx\empty\imagewidth\else width \imagewidth \fi
1245 \ifx\empty\imageheight\else height \imageheight \fi
1246 \ifnum\pdftexversion<13
1251 \ifnum\pdftexversion < 14 \else
1252 \pdfrefximage \pdflastximage
1255 % We have to set dummies so commands such as @code, and characters
1256 % such as \, aren't expanded when present in a section title.
1258 \activebackslashdouble
1259 \def\pdfdestname{#1}%
1260 \backslashparens\pdfdestname
1261 \pdfdest name{\pdfdestname} xyz%
1264 % used to mark target names; must be expandable.
1265 \def\pdfmkpgn#1{#1}%
1267 \let\linkcolor = \Blue % was Cyan, but that seems light?
1268 \def\endlink{\Black\pdfendlink}
1269 % Adding outlines to PDF; macros for calculating structure of outlines
1270 % come from Petr Olsak
1271 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1272 \else \csname#1\endcsname \fi}
1273 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1274 \advance\tempnum by 1
1275 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1277 % #1 is the section text, which is what will be displayed in the
1278 % outline by the pdf viewer. #2 is the pdf expression for the number
1279 % of subentries (or empty, for subsubsections). #3 is the node text,
1280 % which might be empty if this toc entry had no corresponding node.
1281 % #4 is the page number
1283 \def\dopdfoutline#1#2#3#4{%
1284 % Generate a link to the node text if that exists; else, use the
1285 % page number. We could generate a destination for the section
1286 % text in the case where a section has no node, but it doesn't
1287 % seem worth the trouble, since most documents are normally structured.
1288 \def\pdfoutlinedest{#3}%
1289 \ifx\pdfoutlinedest\empty
1290 \def\pdfoutlinedest{#4}%
1292 % Doubled backslashes in the name.
1293 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1294 \backslashparens\pdfoutlinedest}%
1297 % Also double the backslashes in the display string.
1298 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1299 \backslashparens\pdfoutlinetext}%
1301 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1304 \def\pdfmakeoutlines{%
1306 % Thanh's hack / proper braces in bookmarks
1307 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1308 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1310 % Read toc silently, to get counts of subentries for \pdfoutline.
1311 \def\numchapentry##1##2##3##4{%
1312 \def\thischapnum{##2}%
1314 \def\thissubsecnum{0}%
1316 \def\numsecentry##1##2##3##4{%
1317 \advancenumber{chap\thischapnum}%
1318 \def\thissecnum{##2}%
1319 \def\thissubsecnum{0}%
1321 \def\numsubsecentry##1##2##3##4{%
1322 \advancenumber{sec\thissecnum}%
1323 \def\thissubsecnum{##2}%
1325 \def\numsubsubsecentry##1##2##3##4{%
1326 \advancenumber{subsec\thissubsecnum}%
1328 \def\thischapnum{0}%
1330 \def\thissubsecnum{0}%
1332 % use \def rather than \let here because we redefine \chapentry et
1333 % al. a second time, below.
1334 \def\appentry{\numchapentry}%
1335 \def\appsecentry{\numsecentry}%
1336 \def\appsubsecentry{\numsubsecentry}%
1337 \def\appsubsubsecentry{\numsubsubsecentry}%
1338 \def\unnchapentry{\numchapentry}%
1339 \def\unnsecentry{\numsecentry}%
1340 \def\unnsubsecentry{\numsubsecentry}%
1341 \def\unnsubsubsecentry{\numsubsubsecentry}%
1344 % Read toc second time, this time actually producing the outlines.
1345 % The `-' means take the \expnumber as the absolute number of
1346 % subentries, which we calculated on our first read of the .toc above.
1348 % We use the node names as the destinations.
1349 \def\numchapentry##1##2##3##4{%
1350 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1351 \def\numsecentry##1##2##3##4{%
1352 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1353 \def\numsubsecentry##1##2##3##4{%
1354 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1355 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1356 \dopdfoutline{##1}{}{##3}{##4}}%
1358 % PDF outlines are displayed using system fonts, instead of
1359 % document fonts. Therefore we cannot use special characters,
1360 % since the encoding is unknown. For example, the eogonek from
1361 % Latin 2 (0xea) gets translated to a | character. Info from
1362 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1364 % xx to do this right, we have to translate 8-bit characters to
1365 % their "best" equivalent, based on the @documentencoding. Right
1366 % now, I guess we'll just let the pdf reader have its way.
1369 \catcode`\\=\active \otherbackslash
1374 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1375 \ifx\PP\D\let\nextsp\relax
1376 \else\let\nextsp\skipspaces
1377 \ifx\p\space\else\addtokens{\filename}{\PP}%
1378 \advance\filenamelength by 1
1382 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1383 \ifnum\pdftexversion < 14
1384 \let \startlink \pdfannotlink
1386 \let \startlink \pdfstartlink
1388 % make a live url in pdf output.
1391 % it seems we really need yet another set of dummies; have not
1392 % tried to figure out what each command should do in the context
1393 % of @url. for now, just make @/ a no-op, that's the only one
1394 % people have actually reported a problem with.
1396 \normalturnoffactive
1399 \makevalueexpandable
1401 \startlink attr{/Border [0 0 0]}%
1402 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1404 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1405 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1406 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1407 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1409 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1411 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1412 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1413 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1415 \ifnum0=\countA\else\makelink\fi
1416 \ifx\first.\let\next=\done\else
1418 \addtokens{\toksB}{\the\toksD}
1419 \ifx\first,\addtokens{\toksB}{\space}\fi
1421 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1423 \def\makelink{\addtokens{\toksB}%
1424 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1426 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1427 \linkcolor #1\endlink}
1428 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1430 \let\pdfmkdest = \gobble
1431 \let\pdfurl = \gobble
1432 \let\endlink = \relax
1433 \let\linkcolor = \relax
1434 \let\pdfmakeoutlines = \relax
1435 \fi % \ifx\pdfoutput
1440 % Change the current font style to #1, remembering it in \curfontstyle.
1441 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1442 % italics, not bold italics.
1444 \def\setfontstyle#1{%
1445 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1446 \csname ten#1\endcsname % change the current font
1449 % Select #1 fonts with the current style.
1451 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1453 \def\rm{\fam=0 \setfontstyle{rm}}
1454 \def\it{\fam=\itfam \setfontstyle{it}}
1455 \def\sl{\fam=\slfam \setfontstyle{sl}}
1456 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1457 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1459 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1460 % So we set up a \sf.
1462 \def\sf{\fam=\sffam \setfontstyle{sf}}
1463 \let\li = \sf % Sometimes we call it \li, not \sf.
1465 % We don't need math for this font style.
1466 \def\ttsl{\setfontstyle{ttsl}}
1469 \newdimen\textleading \textleading = 13.2pt
1471 % Set the baselineskip to #1, and the lineskip and strut size
1472 % correspondingly. There is no deep meaning behind these magic numbers
1473 % used as factors; they just match (closely enough) what Knuth defined.
1475 \def\lineskipfactor{.08333}
1476 \def\strutheightpercent{.70833}
1477 \def\strutdepthpercent {.29167}
1480 \normalbaselineskip = #1\relax
1481 \normallineskip = \lineskipfactor\normalbaselineskip
1483 \setbox\strutbox =\hbox{%
1484 \vrule width0pt height\strutheightpercent\baselineskip
1485 depth \strutdepthpercent \baselineskip
1489 % Set the font macro #1 to the font named #2, adding on the
1490 % specified font prefix (normally `cm').
1491 % #3 is the font's design size, #4 is a scale factor
1492 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1494 % Use cm as the default font prefix.
1495 % To specify the font prefix, you must define \fontprefix
1496 % before you read in texinfo.tex.
1497 \ifx\fontprefix\undefined
1500 % Support font families that don't use the same naming scheme as CM.
1502 \def\rmbshape{bx} %where the normal face is bold
1507 \def\ttslshape{sltt}
1517 % Text fonts (11.2pt, magstep1).
1518 \def\textnominalsize{11pt}
1519 \edef\mainmagstep{\magstephalf}
1520 \setfont\textrm\rmshape{10}{\mainmagstep}
1521 \setfont\texttt\ttshape{10}{\mainmagstep}
1522 \setfont\textbf\bfshape{10}{\mainmagstep}
1523 \setfont\textit\itshape{10}{\mainmagstep}
1524 \setfont\textsl\slshape{10}{\mainmagstep}
1525 \setfont\textsf\sfshape{10}{\mainmagstep}
1526 \setfont\textsc\scshape{10}{\mainmagstep}
1527 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1528 \font\texti=cmmi10 scaled \mainmagstep
1529 \font\textsy=cmsy10 scaled \mainmagstep
1531 % A few fonts for @defun names and args.
1532 \setfont\defbf\bfshape{10}{\magstep1}
1533 \setfont\deftt\ttshape{10}{\magstep1}
1534 \setfont\defttsl\ttslshape{10}{\magstep1}
1535 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1537 % Fonts for indices, footnotes, small examples (9pt).
1538 \def\smallnominalsize{9pt}
1539 \setfont\smallrm\rmshape{9}{1000}
1540 \setfont\smalltt\ttshape{9}{1000}
1541 \setfont\smallbf\bfshape{10}{900}
1542 \setfont\smallit\itshape{9}{1000}
1543 \setfont\smallsl\slshape{9}{1000}
1544 \setfont\smallsf\sfshape{9}{1000}
1545 \setfont\smallsc\scshape{10}{900}
1546 \setfont\smallttsl\ttslshape{10}{900}
1550 % Fonts for small examples (8pt).
1551 \def\smallernominalsize{8pt}
1552 \setfont\smallerrm\rmshape{8}{1000}
1553 \setfont\smallertt\ttshape{8}{1000}
1554 \setfont\smallerbf\bfshape{10}{800}
1555 \setfont\smallerit\itshape{8}{1000}
1556 \setfont\smallersl\slshape{8}{1000}
1557 \setfont\smallersf\sfshape{8}{1000}
1558 \setfont\smallersc\scshape{10}{800}
1559 \setfont\smallerttsl\ttslshape{10}{800}
1560 \font\smalleri=cmmi8
1561 \font\smallersy=cmsy8
1563 % Fonts for title page (20.4pt):
1564 \def\titlenominalsize{20pt}
1565 \setfont\titlerm\rmbshape{12}{\magstep3}
1566 \setfont\titleit\itbshape{10}{\magstep4}
1567 \setfont\titlesl\slbshape{10}{\magstep4}
1568 \setfont\titlett\ttbshape{12}{\magstep3}
1569 \setfont\titlettsl\ttslshape{10}{\magstep4}
1570 \setfont\titlesf\sfbshape{17}{\magstep1}
1571 \let\titlebf=\titlerm
1572 \setfont\titlesc\scbshape{10}{\magstep4}
1573 \font\titlei=cmmi12 scaled \magstep3
1574 \font\titlesy=cmsy10 scaled \magstep4
1575 \def\authorrm{\secrm}
1576 \def\authortt{\sectt}
1578 % Chapter (and unnumbered) fonts (17.28pt).
1579 \def\chapnominalsize{17pt}
1580 \setfont\chaprm\rmbshape{12}{\magstep2}
1581 \setfont\chapit\itbshape{10}{\magstep3}
1582 \setfont\chapsl\slbshape{10}{\magstep3}
1583 \setfont\chaptt\ttbshape{12}{\magstep2}
1584 \setfont\chapttsl\ttslshape{10}{\magstep3}
1585 \setfont\chapsf\sfbshape{17}{1000}
1587 \setfont\chapsc\scbshape{10}{\magstep3}
1588 \font\chapi=cmmi12 scaled \magstep2
1589 \font\chapsy=cmsy10 scaled \magstep3
1591 % Section fonts (14.4pt).
1592 \def\secnominalsize{14pt}
1593 \setfont\secrm\rmbshape{12}{\magstep1}
1594 \setfont\secit\itbshape{10}{\magstep2}
1595 \setfont\secsl\slbshape{10}{\magstep2}
1596 \setfont\sectt\ttbshape{12}{\magstep1}
1597 \setfont\secttsl\ttslshape{10}{\magstep2}
1598 \setfont\secsf\sfbshape{12}{\magstep1}
1600 \setfont\secsc\scbshape{10}{\magstep2}
1601 \font\seci=cmmi12 scaled \magstep1
1602 \font\secsy=cmsy10 scaled \magstep2
1604 % Subsection fonts (13.15pt).
1605 \def\ssecnominalsize{13pt}
1606 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1607 \setfont\ssecit\itbshape{10}{1315}
1608 \setfont\ssecsl\slbshape{10}{1315}
1609 \setfont\ssectt\ttbshape{12}{\magstephalf}
1610 \setfont\ssecttsl\ttslshape{10}{1315}
1611 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1613 \setfont\ssecsc\scbshape{10}{1315}
1614 \font\sseci=cmmi12 scaled \magstephalf
1615 \font\ssecsy=cmsy10 scaled 1315
1617 % Reduced fonts for @acro in text (10pt).
1618 \def\reducednominalsize{10pt}
1619 \setfont\reducedrm\rmshape{10}{1000}
1620 \setfont\reducedtt\ttshape{10}{1000}
1621 \setfont\reducedbf\bfshape{10}{1000}
1622 \setfont\reducedit\itshape{10}{1000}
1623 \setfont\reducedsl\slshape{10}{1000}
1624 \setfont\reducedsf\sfshape{10}{1000}
1625 \setfont\reducedsc\scshape{10}{1000}
1626 \setfont\reducedttsl\ttslshape{10}{1000}
1627 \font\reducedi=cmmi10
1628 \font\reducedsy=cmsy10
1630 % In order for the font changes to affect most math symbols and letters,
1631 % we have to define the \textfont of the standard families. Since
1632 % texinfo doesn't allow for producing subscripts and superscripts except
1633 % in the main text, we don't bother to reset \scriptfont and
1634 % \scriptscriptfont (which would also require loading a lot more fonts).
1636 \def\resetmathfonts{%
1637 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1638 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1639 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1642 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1643 % of just \STYLE. We do this because \STYLE needs to also set the
1644 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1645 % \tenSTYLE to set the current font.
1647 % Each font-changing command also sets the names \lsize (one size lower)
1648 % and \lllsize (three sizes lower). These relative commands are used in
1649 % the LaTeX logo and acronyms.
1651 % This all needs generalizing, badly.
1654 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1655 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1656 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1657 \let\tenttsl=\textttsl
1658 \def\curfontsize{text}%
1659 \def\lsize{reduced}\def\lllsize{smaller}%
1660 \resetmathfonts \setleading{\textleading}}
1662 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1663 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1664 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1665 \let\tenttsl=\titlettsl
1666 \def\curfontsize{title}%
1667 \def\lsize{chap}\def\lllsize{subsec}%
1668 \resetmathfonts \setleading{25pt}}
1669 \def\titlefont#1{{\titlefonts\rm #1}}
1671 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1672 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1673 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1674 \let\tenttsl=\chapttsl
1675 \def\curfontsize{chap}%
1676 \def\lsize{sec}\def\lllsize{text}%
1677 \resetmathfonts \setleading{19pt}}
1679 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1680 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1681 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1682 \let\tenttsl=\secttsl
1683 \def\curfontsize{sec}%
1684 \def\lsize{subsec}\def\lllsize{reduced}%
1685 \resetmathfonts \setleading{16pt}}
1687 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1688 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1689 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1690 \let\tenttsl=\ssecttsl
1691 \def\curfontsize{ssec}%
1692 \def\lsize{text}\def\lllsize{small}%
1693 \resetmathfonts \setleading{15pt}}
1694 \let\subsubsecfonts = \subsecfonts
1696 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1697 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1698 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1699 \let\tenttsl=\reducedttsl
1700 \def\curfontsize{reduced}%
1701 \def\lsize{small}\def\lllsize{smaller}%
1702 \resetmathfonts \setleading{10.5pt}}
1704 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1705 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1706 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1707 \let\tenttsl=\smallttsl
1708 \def\curfontsize{small}%
1709 \def\lsize{smaller}\def\lllsize{smaller}%
1710 \resetmathfonts \setleading{10.5pt}}
1712 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1713 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1714 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1715 \let\tenttsl=\smallerttsl
1716 \def\curfontsize{smaller}%
1717 \def\lsize{smaller}\def\lllsize{smaller}%
1718 \resetmathfonts \setleading{9.5pt}}
1720 % Set the fonts to use with the @small... environments.
1721 \let\smallexamplefonts = \smallfonts
1723 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1724 % can fit this many characters:
1725 % 8.5x11=86 smallbook=72 a4=90 a5=69
1726 % If we use \scriptfonts (8pt), then we can fit this many characters:
1727 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1728 % For me, subjectively, the few extra characters that fit aren't worth
1729 % the additional smallness of 8pt. So I'm making the default 9pt.
1731 % By the way, for comparison, here's what fits with @example (10pt):
1732 % 8.5x11=71 smallbook=60 a4=75 a5=58
1734 % I wish the USA used A4 paper.
1738 % Set up the default fonts, so we can use them for creating boxes.
1742 % Define these so they can be easily changed for other fonts.
1743 \def\angleleft{$\langle$}
1744 \def\angleright{$\rangle$}
1746 % Count depth in font-changes, for error checks
1747 \newcount\fontdepth \fontdepth=0
1749 % Fonts for short table of contents.
1750 \setfont\shortcontrm\rmshape{12}{1000}
1751 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1752 \setfont\shortcontsl\slshape{12}{1000}
1753 \setfont\shortconttt\ttshape{12}{1000}
1755 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1756 %% serif) and @ii for TeX italic
1758 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1759 % unless the following character is such as not to need one.
1760 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1761 \ptexslash\fi\fi\fi}
1762 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1763 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1765 % like \smartslanted except unconditionally uses \ttsl.
1766 % @var is set to this for defun arguments.
1767 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1769 % like \smartslanted except unconditionally use \sl. We never want
1770 % ttsl for book titles, do we?
1771 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1774 \let\slanted=\smartslanted
1775 \let\var=\smartslanted
1776 \let\dfn=\smartslanted
1777 \let\emph=\smartitalic
1779 % @b, explicit bold.
1783 % @sansserif, explicit sans.
1784 \def\sansserif#1{{\sf #1}}
1786 % We can't just use \exhyphenpenalty, because that only has effect at
1787 % the end of a paragraph. Restore normal hyphenation at the end of the
1788 % group within which \nohyphenation is presumably called.
1790 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1791 \def\restorehyphenation{\hyphenchar\font = `- }
1793 % Set sfcode to normal for the chars that usually have another value.
1794 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1795 % sometimes \x has an active definition that messes things up.
1797 \chardef\colonChar = `\:
1798 \chardef\commaChar = `\,
1799 \chardef\dotChar = `\.
1800 \chardef\exclamChar= `\!
1801 \chardef\questChar = `\?
1802 \chardef\semiChar = `\;
1805 \def\plainfrenchspacing{%
1806 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1807 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1808 \def\endofsentencespacefactor{1000}% for @. and friends
1810 \def\plainnonfrenchspacing{%
1811 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1812 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1813 \def\endofsentencespacefactor{3000}% for @. and friends
1816 \def\endofsentencespacefactor{3000}% default
1819 {\tt \rawbackslash \plainfrenchspacing #1}%
1822 \def\samp#1{`\tclose{#1}'\null}
1823 \setfont\keyrm\rmshape{8}{1000}
1825 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1826 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1827 \vbox{\hrule\kern-0.4pt
1828 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1830 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1831 % The old definition, with no lozenge:
1832 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1833 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1835 % @file, @option are the same as @samp.
1839 % @code is a modification of @t,
1840 % which makes spaces the same size as normal in the surrounding text.
1843 % Change normal interword space to be same as for the current font.
1844 \spaceskip = \fontdimen2\font
1846 % Switch to typewriter.
1849 % But `\ ' produces the large typewriter interword space.
1850 \def\ {{\spaceskip = 0pt{} }}%
1852 % Turn off hyphenation.
1862 % We *must* turn on hyphenation at `-' and `_' in @code.
1863 % Otherwise, it is too hard to avoid overfull hboxes
1864 % in the Emacs manual, the Library manual, etc.
1866 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1867 % both hyphenation at - and hyphenation within words.
1868 % We must therefore turn them both off (\tclose does that)
1869 % and arrange explicitly to hyphenate at a dash.
1875 \global\def\code{\begingroup
1876 \catcode`\-=\active \catcode`\_=\active
1889 \def\codedash{-\discretionary{}{}{}}
1891 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1892 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1893 % will therefore expand the active definition of _, which is us
1894 % (inside @code that is), therefore an endless loop.
1896 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1897 \else\normalunderscore \fi
1898 \discretionary{}{}{}}%
1901 \def\codex #1{\tclose{#1}\endgroup}
1903 % An additional complication: the above will allow breaks after, e.g.,
1904 % each of the four underscores in __typeof__. This is undesirable in
1905 % some manuals, especially if they don't have long identifiers in
1906 % general. @allowcodebreaks provides a way to control this.
1908 \newif\ifallowcodebreaks \allowcodebreakstrue
1910 \def\keywordtrue{true}
1911 \def\keywordfalse{false}
1913 \parseargdef\allowcodebreaks{%
1915 \ifx\txiarg\keywordtrue
1916 \allowcodebreakstrue
1917 \else\ifx\txiarg\keywordfalse
1918 \allowcodebreaksfalse
1920 \errhelp = \EMsimple
1921 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
1925 % @kbd is like @code, except that if the argument is just one @key command,
1926 % then @kbd has no effect.
1928 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1929 % `example' (@kbd uses ttsl only inside of @example and friends),
1930 % or `code' (@kbd uses normal tty font always).
1931 \parseargdef\kbdinputstyle{%
1933 \ifx\txiarg\worddistinct
1934 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1935 \else\ifx\txiarg\wordexample
1936 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1937 \else\ifx\txiarg\wordcode
1938 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1940 \errhelp = \EMsimple
1941 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
1944 \def\worddistinct{distinct}
1945 \def\wordexample{example}
1948 % Default is `distinct.'
1949 \kbdinputstyle distinct
1952 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1953 \ifx\one\xkey\ifx\threex\three \key{#2}%
1954 \else{\tclose{\kbdfont\look}}\fi
1955 \else{\tclose{\kbdfont\look}}\fi}
1957 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1958 \let\indicateurl=\code
1962 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1963 % second argument specifying the text to display and an optional third
1964 % arg as text to display instead of (rather than in addition to) the url
1965 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1966 % a hypertex \special here.
1968 \def\uref#1{\douref #1,,,\finish}
1969 \def\douref#1,#2,#3,#4\finish{\begingroup
1972 \setbox0 = \hbox{\ignorespaces #3}%
1974 \unhbox0 % third arg given, show only that
1976 \setbox0 = \hbox{\ignorespaces #2}%
1979 \unhbox0 % PDF: 2nd arg given, show only it
1981 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1984 \code{#1}% only url given, so show it
1990 % @url synonym for @uref, since that's how everyone uses it.
1994 % rms does not like angle brackets --karl, 17may97.
1995 % So now @email is just like @uref, unless we are pdf.
1997 %\def\email#1{\angleleft{\tt #1}\angleright}
1999 \def\email#1{\doemail#1,,\finish}
2000 \def\doemail#1,#2,#3\finish{\begingroup
2003 \setbox0 = \hbox{\ignorespaces #2}%
2004 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2011 % Check if we are currently using a typewriter font. Since all the
2012 % Computer Modern typewriter fonts have zero interword stretch (and
2013 % shrink), and it is reasonable to expect all typewriter fonts to have
2014 % this property, we can check that font parameter.
2016 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2018 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2019 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2021 \def\dmn#1{\thinspace #1}
2023 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2025 % @l was never documented to mean ``switch to the Lisp font'',
2026 % and it is not used as such in any manual I can find. We need it for
2027 % Polish suppressed-l. --karl, 22sep96.
2028 %\def\l#1{{\li #1}\null}
2030 % Explicit font changes: @r, @sc, undocumented @ii.
2031 \def\r#1{{\rm #1}} % roman font
2032 \def\sc#1{{\smallcaps#1}} % smallcaps font
2033 \def\ii#1{{\it #1}} % italic font
2035 % @acronym for "FBI", "NATO", and the like.
2036 % We print this one point size smaller, since it's intended for
2039 \def\acronym#1{\doacronym #1,,\finish}
2040 \def\doacronym#1,#2,#3\finish{%
2041 {\selectfonts\lsize #1}%
2043 \ifx\temp\empty \else
2044 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2048 % @abbr for "Comput. J." and the like.
2049 % No font change, but don't do end-of-sentence spacing.
2051 \def\abbr#1{\doabbr #1,,\finish}
2052 \def\doabbr#1,#2,#3\finish{%
2053 {\plainfrenchspacing #1}%
2055 \ifx\temp\empty \else
2056 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2060 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2062 \def\pounds{{\it\$}}
2064 % @euro{} comes from a separate font, depending on the current style.
2065 % We use the free feym* fonts from the eurosym package by Henrik
2066 % Theiling, which support regular, slanted, bold and bold slanted (and
2067 % "outlined" (blackboard board, sort of) versions, which we don't need).
2068 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2070 % Although only regular is the truly official Euro symbol, we ignore
2071 % that. The Euro is designed to be slightly taller than the regular
2077 % feybo - bold slanted
2079 % There is no good (free) typewriter version, to my knowledge.
2080 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2083 % Also doesn't work in math. Do we need to do math with euro symbols?
2087 \def\euro{{\eurofont e}}
2089 % We set the font at each command, rather than predefining it in
2090 % \textfonts and the other font-switching commands, so that
2091 % installations which never need the symbol don't have to have the
2094 % There is only one designed size (nominal 10pt), so we always scale
2095 % that to the current nominal size.
2097 % By the way, simply using "at 1em" works for cmr10 and the like, but
2098 % does not work for cmbx10 and other extended/shrunken fonts.
2100 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2102 \ifx\curfontstyle\bfstylename
2104 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2107 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2112 % @registeredsymbol - R in a circle. The font for the R should really
2113 % be smaller yet, but lllsize is the best we can do for now.
2114 % Adapted from the plain.tex definition of \copyright.
2116 \def\registeredsymbol{%
2117 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2122 % Laurent Siebenmann reports \Orb undefined with:
2123 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2124 % so we'll define it if necessary.
2127 \def\Orb{\mathhexbox20D}
2131 \message{page headings,}
2133 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2134 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2136 % First the title page. Must do @settitle before @titlepage.
2138 \newif\iffinishedtitlepage
2140 % Do an implicit @contents or @shortcontents after @end titlepage if the
2141 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2143 \newif\ifsetcontentsaftertitlepage
2144 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2145 \newif\ifsetshortcontentsaftertitlepage
2146 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2148 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2149 \endgroup\page\hbox{}\page}
2152 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2154 \parindent=0pt \textfonts
2155 % Leave some space at the very top of the page.
2156 \vglue\titlepagetopglue
2157 % No rule at page bottom unless we print one at the top with @title.
2158 \finishedtitlepagetrue
2160 % Most title ``pages'' are actually two pages long, with space
2161 % at the top of the second. We don't want the ragged left on the second.
2162 \let\oldpage = \page
2164 \iffinishedtitlepage\else
2167 \let\page = \oldpage
2174 \iffinishedtitlepage\else
2177 % It is important to do the page break before ending the group,
2178 % because the headline and footline are only empty inside the group.
2179 % If we use the new definition of \page, we always get a blank page
2180 % after the title page, which we certainly don't want.
2184 % Need this before the \...aftertitlepage checks so that if they are
2185 % in effect the toc pages will come out with page numbers.
2188 % If they want short, they certainly want long too.
2189 \ifsetshortcontentsaftertitlepage
2192 \global\let\shortcontents = \relax
2193 \global\let\contents = \relax
2196 \ifsetcontentsaftertitlepage
2198 \global\let\contents = \relax
2199 \global\let\shortcontents = \relax
2203 \def\finishtitlepage{%
2204 \vskip4pt \hrule height 2pt width \hsize
2205 \vskip\titlepagebottomglue
2206 \finishedtitlepagetrue
2209 %%% Macros to be used within @titlepage:
2211 \let\subtitlerm=\tenrm
2212 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2214 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2217 \parseargdef\title{%
2219 \leftline{\titlefonts\rm #1}
2220 % print a rule at the page bottom also.
2221 \finishedtitlepagefalse
2222 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2225 \parseargdef\subtitle{%
2227 {\subtitlefont \rightline{#1}}%
2230 % @author should come last, but may come many times.
2231 % It can also be used inside @quotation.
2233 \parseargdef\author{%
2234 \def\temp{\quotation}%
2236 \def\quotationauthor{#1}% printed in \Equotation.
2239 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2240 {\authorfont \leftline{#1}}%
2245 %%% Set up page headings and footings.
2247 \let\thispage=\folio
2249 \newtoks\evenheadline % headline on even pages
2250 \newtoks\oddheadline % headline on odd pages
2251 \newtoks\evenfootline % footline on even pages
2252 \newtoks\oddfootline % footline on odd pages
2254 % Now make TeX use those variables
2255 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2256 \else \the\evenheadline \fi}}
2257 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2258 \else \the\evenfootline \fi}\HEADINGShook}
2259 \let\HEADINGShook=\relax
2261 % Commands to set those variables.
2262 % For example, this is what @headings on does
2263 % @evenheading @thistitle|@thispage|@thischapter
2264 % @oddheading @thischapter|@thispage|@thistitle
2265 % @evenfooting @thisfile||
2266 % @oddfooting ||@thisfile
2269 \def\evenheading{\parsearg\evenheadingxxx}
2270 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2271 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2272 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2274 \def\oddheading{\parsearg\oddheadingxxx}
2275 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2276 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2277 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2279 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2281 \def\evenfooting{\parsearg\evenfootingxxx}
2282 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2283 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2284 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2286 \def\oddfooting{\parsearg\oddfootingxxx}
2287 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2288 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2289 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2291 % Leave some space for the footline. Hopefully ok to assume
2292 % @evenfooting will not be used by itself.
2293 \global\advance\pageheight by -\baselineskip
2294 \global\advance\vsize by -\baselineskip
2297 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2300 % @headings double turns headings on for double-sided printing.
2301 % @headings single turns headings on for single-sided printing.
2302 % @headings off turns them off.
2303 % @headings on same as @headings double, retained for compatibility.
2304 % @headings after turns on double-sided headings after this page.
2305 % @headings doubleafter turns on double-sided headings after this page.
2306 % @headings singleafter turns on single-sided headings after this page.
2307 % By default, they are off at the start of a document,
2308 % and turned `on' after @end titlepage.
2310 \def\headings #1 {\csname HEADINGS#1\endcsname}
2313 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2314 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2316 % When we turn headings on, set the page number to 1.
2317 % For double-sided printing, put current file name in lower left corner,
2318 % chapter name on inside top of right hand pages, document
2319 % title on inside top of left hand pages, and page numbers on outside top
2320 % edge of all pages.
2321 \def\HEADINGSdouble{%
2323 \global\evenfootline={\hfil}
2324 \global\oddfootline={\hfil}
2325 \global\evenheadline={\line{\folio\hfil\thistitle}}
2326 \global\oddheadline={\line{\thischapter\hfil\folio}}
2327 \global\let\contentsalignmacro = \chapoddpage
2329 \let\contentsalignmacro = \chappager
2331 % For single-sided printing, chapter title goes across top left of page,
2332 % page number on top right.
2333 \def\HEADINGSsingle{%
2335 \global\evenfootline={\hfil}
2336 \global\oddfootline={\hfil}
2337 \global\evenheadline={\line{\thischapter\hfil\folio}}
2338 \global\oddheadline={\line{\thischapter\hfil\folio}}
2339 \global\let\contentsalignmacro = \chappager
2341 \def\HEADINGSon{\HEADINGSdouble}
2343 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2344 \let\HEADINGSdoubleafter=\HEADINGSafter
2345 \def\HEADINGSdoublex{%
2346 \global\evenfootline={\hfil}
2347 \global\oddfootline={\hfil}
2348 \global\evenheadline={\line{\folio\hfil\thistitle}}
2349 \global\oddheadline={\line{\thischapter\hfil\folio}}
2350 \global\let\contentsalignmacro = \chapoddpage
2353 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2354 \def\HEADINGSsinglex{%
2355 \global\evenfootline={\hfil}
2356 \global\oddfootline={\hfil}
2357 \global\evenheadline={\line{\thischapter\hfil\folio}}
2358 \global\oddheadline={\line{\thischapter\hfil\folio}}
2359 \global\let\contentsalignmacro = \chappager
2362 % Subroutines used in generating headings
2363 % This produces Day Month Year style of output.
2364 % Only define if not already defined, in case a txi-??.tex file has set
2365 % up a different format (e.g., txi-cs.tex does this).
2366 \ifx\today\undefined
2370 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2371 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2372 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2377 % @settitle line... specifies the title of the document, for headings.
2378 % It generates no output of its own.
2379 \def\thistitle{\putwordNoTitle}
2380 \def\settitle{\parsearg{\gdef\thistitle}}
2384 % Tables -- @table, @ftable, @vtable, @item(x).
2386 % default indentation of table text
2387 \newdimen\tableindent \tableindent=.8in
2388 % default indentation of @itemize and @enumerate text
2389 \newdimen\itemindent \itemindent=.3in
2390 % margin between end of table item and start of table text.
2391 \newdimen\itemmargin \itemmargin=.1in
2393 % used internally for \itemindent minus \itemmargin
2396 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2398 % They also define \itemindex
2399 % to index the item name in whatever manner is desired (perhaps none).
2401 \newif\ifitemxneedsnegativevskip
2403 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2405 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2406 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2408 \def\itemzzz #1{\begingroup %
2409 \advance\hsize by -\rightskip
2410 \advance\hsize by -\tableindent
2411 \setbox0=\hbox{\itemindicate{#1}}%
2413 \nobreak % This prevents a break before @itemx.
2415 % If the item text does not fit in the space we have, put it on a line
2416 % by itself, and do not allow a page break either before or after that
2417 % line. We do not start a paragraph here because then if the next
2418 % command is, e.g., @kindex, the whatsit would get put into the
2419 % horizontal list on a line by itself, resulting in extra blank space.
2420 \ifdim \wd0>\itemmax
2422 % Make this a paragraph so we get the \parskip glue and wrapping,
2423 % but leave it ragged-right.
2425 \advance\leftskip by-\tableindent
2426 \advance\hsize by\tableindent
2427 \advance\rightskip by0pt plus1fil
2428 \leavevmode\unhbox0\par
2431 % We're going to be starting a paragraph, but we don't want the
2432 % \parskip glue -- logically it's part of the @item we just started.
2433 \nobreak \vskip-\parskip
2435 % Stop a page break at the \parskip glue coming up. However, if
2436 % what follows is an environment such as @example, there will be no
2437 % \parskip glue; then the negative vskip we just inserted would
2438 % cause the example and the item to crash together. So we use this
2439 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2440 % \parskip glue after all. Section titles are handled this way also.
2444 \itemxneedsnegativevskipfalse
2446 % The item text fits into the space. Start a paragraph, so that the
2447 % following text (if any) will end up on the same line.
2449 % Do this with kerns and \unhbox so that if there is a footnote in
2450 % the item text, it can migrate to the main vertical list and
2451 % eventually be printed.
2452 \nobreak\kern-\tableindent
2453 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2455 \nobreak\kern\dimen0
2457 \itemxneedsnegativevskiptrue
2461 \def\item{\errmessage{@item while not in a list environment}}
2462 \def\itemx{\errmessage{@itemx while not in a list environment}}
2464 % @table, @ftable, @vtable.
2466 \let\itemindex\gobble
2470 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2471 \tablecheck{ftable}%
2474 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2475 \tablecheck{vtable}%
2478 \ifnum \the\catcode`\^^M=\active
2480 \errmessage{This command won't work in this context; perhaps the problem is
2481 that we are \inenvironment\thisenv}%
2482 \def\next{\doignore{#1}}%
2489 \def\itemindicate{#1}%
2494 \makevalueexpandable
2495 \edef\temp{\noexpand\tablez #1\space\space\space}%
2499 \def\tablez #1 #2 #3 #4\endtablez{%
2501 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2502 \ifnum 0#2>0 \tableindent=#2\mil \fi
2503 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2504 \itemmax=\tableindent
2505 \advance \itemmax by -\itemmargin
2506 \advance \leftskip by \tableindent
2507 \exdentamount=\tableindent
2509 \parskip = \smallskipamount
2510 \ifdim \parskip=0pt \parskip=2pt \fi
2511 \let\item = \internalBitem
2512 \let\itemx = \internalBitemx
2514 \def\Etable{\endgraf\afterenvbreak}
2517 \let\Eitemize\Etable
2518 \let\Eenumerate\Etable
2520 % This is the counter used by @enumerate, which is really @itemize
2524 \envdef\itemize{\parsearg\doitemize}
2528 \itemmax=\itemindent
2529 \advance\itemmax by -\itemmargin
2530 \advance\leftskip by \itemindent
2531 \exdentamount=\itemindent
2533 \parskip=\smallskipamount
2534 \ifdim\parskip=0pt \parskip=2pt \fi
2535 \def\itemcontents{#1}%
2536 % @itemize with no arg is equivalent to @itemize @bullet.
2537 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2538 \let\item=\itemizeitem
2541 % Definition of @item while inside @itemize and @enumerate.
2544 \advance\itemno by 1 % for enumerations
2545 {\let\par=\endgraf \smallbreak}% reasonable place to break
2547 % If the document has an @itemize directly after a section title, a
2548 % \nobreak will be last on the list, and \sectionheading will have
2549 % done a \vskip-\parskip. In that case, we don't want to zero
2550 % parskip, or the item text will crash with the heading. On the
2551 % other hand, when there is normal text preceding the item (as there
2552 % usually is), we do want to zero parskip, or there would be too much
2553 % space. In that case, we won't have a \nobreak before. At least
2554 % that's the theory.
2555 \ifnum\lastpenalty<10000 \parskip=0in \fi
2557 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2558 \vadjust{\penalty 1200}}% not good to break after first line of item.
2562 % \splitoff TOKENS\endmark defines \first to be the first token in
2563 % TOKENS, and \rest to be the remainder.
2565 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2567 % Allow an optional argument of an uppercase letter, lowercase letter,
2568 % or number, to specify the first label in the enumerated list. No
2569 % argument is the same as `1'.
2571 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2572 \def\enumeratey #1 #2\endenumeratey{%
2573 % If we were given no argument, pretend we were given `1'.
2575 \ifx\thearg\empty \def\thearg{1}\fi
2577 % Detect if the argument is a single token. If so, it might be a
2578 % letter. Otherwise, the only valid thing it can be is a number.
2579 % (We will always have one token, because of the test we just made.
2580 % This is a good thing, since \splitoff doesn't work given nothing at
2581 % all -- the first parameter is undelimited.)
2582 \expandafter\splitoff\thearg\endmark
2584 % Only one token in the argument. It could still be anything.
2585 % A ``lowercase letter'' is one whose \lccode is nonzero.
2586 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2587 % not equal to itself.
2588 % Otherwise, we assume it's a number.
2590 % We need the \relax at the end of the \ifnum lines to stop TeX from
2591 % continuing to look for a <number>.
2593 \ifnum\lccode\expandafter`\thearg=0\relax
2594 \numericenumerate % a number (we hope)
2597 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2598 \lowercaseenumerate % lowercase letter
2600 \uppercaseenumerate % uppercase letter
2604 % Multiple tokens in the argument. We hope it's a number.
2609 % An @enumerate whose labels are integers. The starting integer is
2612 \def\numericenumerate{%
2614 \startenumeration{\the\itemno}%
2617 % The starting (lowercase) letter is in \thearg.
2618 \def\lowercaseenumerate{%
2619 \itemno = \expandafter`\thearg
2621 % Be sure we're not beyond the end of the alphabet.
2623 \errmessage{No more lowercase letters in @enumerate; get a bigger
2630 % The starting (uppercase) letter is in \thearg.
2631 \def\uppercaseenumerate{%
2632 \itemno = \expandafter`\thearg
2634 % Be sure we're not beyond the end of the alphabet.
2636 \errmessage{No more uppercase letters in @enumerate; get a bigger
2643 % Call \doitemize, adding a period to the first argument and supplying the
2644 % common last two arguments. Also subtract one from the initial value in
2645 % \itemno, since @item increments \itemno.
2647 \def\startenumeration#1{%
2648 \advance\itemno by -1
2649 \doitemize{#1.}\flushcr
2652 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2655 \def\alphaenumerate{\enumerate{a}}
2656 \def\capsenumerate{\enumerate{A}}
2657 \def\Ealphaenumerate{\Eenumerate}
2658 \def\Ecapsenumerate{\Eenumerate}
2661 % @multitable macros
2662 % Amy Hendrickson, 8/18/94, 3/6/96
2664 % @multitable ... @end multitable will make as many columns as desired.
2665 % Contents of each column will wrap at width given in preamble. Width
2666 % can be specified either with sample text given in a template line,
2667 % or in percent of \hsize, the current width of text on page.
2669 % Table can continue over pages but will only break between lines.
2673 % Either define widths of columns in terms of percent of \hsize:
2674 % @multitable @columnfractions .25 .3 .45
2677 % Numbers following @columnfractions are the percent of the total
2678 % current hsize to be used for each column. You may use as many
2679 % columns as desired.
2682 % Or use a template:
2683 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2685 % using the widest term desired in each column.
2687 % Each new table line starts with @item, each subsequent new column
2688 % starts with @tab. Empty columns may be produced by supplying @tab's
2689 % with nothing between them for as many times as empty columns are needed,
2690 % ie, @tab@tab@tab will produce two empty columns.
2692 % @item, @tab do not need to be on their own lines, but it will not hurt
2695 % Sample multitable:
2697 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2698 % @item first col stuff @tab second col stuff @tab third col
2705 % @item first col stuff @tab second col stuff
2706 % @tab Many paragraphs of text may be used in any column.
2708 % They will wrap at the width determined by the template.
2709 % @item@tab@tab This will be in third column.
2712 % Default dimensions may be reset by user.
2713 % @multitableparskip is vertical space between paragraphs in table.
2714 % @multitableparindent is paragraph indent in table.
2715 % @multitablecolmargin is horizontal space to be left between columns.
2716 % @multitablelinespace is space to leave between table items, baseline
2718 % 0pt means it depends on current normal line spacing.
2720 \newskip\multitableparskip
2721 \newskip\multitableparindent
2722 \newdimen\multitablecolspace
2723 \newskip\multitablelinespace
2724 \multitableparskip=0pt
2725 \multitableparindent=6pt
2726 \multitablecolspace=12pt
2727 \multitablelinespace=0pt
2729 % Macros used to set up halign preamble:
2731 \let\endsetuptable\relax
2732 \def\xendsetuptable{\endsetuptable}
2733 \let\columnfractions\relax
2734 \def\xcolumnfractions{\columnfractions}
2737 % #1 is the @columnfraction, usually a decimal number like .5, but might
2738 % be just 1. We just use it, whatever it is.
2740 \def\pickupwholefraction#1 {%
2741 \global\advance\colcount by 1
2742 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2749 \ifx\firstarg\xendsetuptable
2752 \ifx\firstarg\xcolumnfractions
2753 \global\setpercenttrue
2756 \let\go\pickupwholefraction
2758 \global\advance\colcount by 1
2759 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2760 % separator; typically that is always in the input, anyway.
2761 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2764 \ifx\go\pickupwholefraction
2765 % Put the argument back for the \pickupwholefraction call, so
2766 % we'll always have a period there to be parsed.
2767 \def\go{\pickupwholefraction#1}%
2769 \let\go = \setuptable
2775 % multitable-only commands.
2777 % @headitem starts a heading row, which we typeset in bold.
2778 % Assignments have to be global since we are inside the implicit group
2779 % of an alignment entry. Note that \everycr resets \everytab.
2780 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2782 % A \tab used to include \hskip1sp. But then the space in a template
2783 % line is not enough. That is bad. So let's go back to just `&' until
2784 % we encounter the problem it was intended to solve again.
2785 % --karl, nathan@acm.org, 20apr99.
2786 \def\tab{\checkenv\multitable &\the\everytab}%
2788 % @multitable ... @end multitable definitions:
2790 \newtoks\everytab % insert after every tab.
2792 \envdef\multitable{%
2796 % @item within a multitable starts a normal row.
2797 % We use \def instead of \let so that if one of the multitable entries
2798 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2799 % \endtemplate) expanding \doitemize.
2804 \setmultitablespacing
2805 \parskip=\multitableparskip
2806 \parindent=\multitableparindent
2812 \global\everytab={}%
2813 \global\colcount=0 % Reset the column counter.
2814 % Check for saved footnotes, etc.
2816 % Keeps underfull box messages off when table breaks over pages.
2818 % Maybe so, but it also creates really weird page breaks when the
2819 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2820 % problem manifests itself, so it can be fixed for real --karl.
2824 \parsearg\domultitable
2826 \def\domultitable#1{%
2827 % To parse everything between @multitable and @item:
2828 \setuptable#1 \endsetuptable
2830 % This preamble sets up a generic column definition, which will
2831 % be used as many times as user calls for columns.
2832 % \vtop will set a single line and will also let text wrap and
2833 % continue for many paragraphs if desired.
2835 \global\advance\colcount by 1
2838 % Use the current \colcount to find the correct column width:
2839 \hsize=\expandafter\csname col\the\colcount\endcsname
2841 % In order to keep entries from bumping into each other
2842 % we will add a \leftskip of \multitablecolspace to all columns after
2845 % If a template has been used, we will add \multitablecolspace
2846 % to the width of each template entry.
2848 % If the user has set preamble in terms of percent of \hsize we will
2849 % use that dimension as the width of the column, and the \leftskip
2850 % will keep entries from bumping into each other. Table will start at
2851 % left margin and final column will justify at right margin.
2853 % Make sure we don't inherit \rightskip from the outer environment.
2856 % The first column will be indented with the surrounding text.
2857 \advance\hsize by\leftskip
2860 % If user has not set preamble in terms of percent of \hsize
2861 % we will advance \hsize by \multitablecolspace.
2862 \advance\hsize by \multitablecolspace
2864 % In either case we will make \leftskip=\multitablecolspace:
2865 \leftskip=\multitablecolspace
2867 % Ignoring space at the beginning and end avoids an occasional spurious
2868 % blank line, when TeX decides to break the line at the space before the
2869 % box from the multistrut, so the strut ends up on a line by itself.
2871 % @multitable @columnfractions .11 .89
2873 % @tab Legal holiday which is valid in major parts of the whole country.
2874 % Is automatically provided with highlighting sequences respectively
2875 % marking characters.
2876 \noindent\ignorespaces##\unskip\multistrut
2881 \egroup % end the \halign
2882 \global\setpercentfalse
2885 \def\setmultitablespacing{%
2886 \def\multistrut{\strut}% just use the standard line spacing
2888 % Compute \multitablelinespace (if not defined by user) for use in
2889 % \multitableparskip calculation. We used define \multistrut based on
2890 % this, but (ironically) that caused the spacing to be off.
2891 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2892 \ifdim\multitablelinespace=0pt
2893 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2894 \global\advance\multitablelinespace by-\ht0
2896 %% Test to see if parskip is larger than space between lines of
2897 %% table. If not, do nothing.
2898 %% If so, set to same dimension as multitablelinespace.
2899 \ifdim\multitableparskip>\multitablelinespace
2900 \global\multitableparskip=\multitablelinespace
2901 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2902 %% than skip between lines in the table.
2904 \ifdim\multitableparskip=0pt
2905 \global\multitableparskip=\multitablelinespace
2906 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2907 %% than skip between lines in the table.
2911 \message{conditionals,}
2913 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2914 % @ifnotxml always succeed. They currently do nothing; we don't
2915 % attempt to check whether the conditionals are properly nested. But we
2916 % have to remember that they are conditionals, so that @end doesn't
2917 % attempt to close an environment group.
2920 \expandafter\let\csname #1\endcsname = \relax
2921 \expandafter\let\csname iscond.#1\endcsname = 1
2924 \makecond{ifnotdocbook}
2925 \makecond{ifnothtml}
2926 \makecond{ifnotinfo}
2927 \makecond{ifnotplaintext}
2930 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2932 \def\direntry{\doignore{direntry}}
2933 \def\documentdescription{\doignore{documentdescription}}
2934 \def\docbook{\doignore{docbook}}
2935 \def\html{\doignore{html}}
2936 \def\ifdocbook{\doignore{ifdocbook}}
2937 \def\ifhtml{\doignore{ifhtml}}
2938 \def\ifinfo{\doignore{ifinfo}}
2939 \def\ifnottex{\doignore{ifnottex}}
2940 \def\ifplaintext{\doignore{ifplaintext}}
2941 \def\ifxml{\doignore{ifxml}}
2942 \def\ignore{\doignore{ignore}}
2943 \def\menu{\doignore{menu}}
2944 \def\xml{\doignore{xml}}
2946 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2948 % A count to remember the depth of nesting.
2949 \newcount\doignorecount
2951 \def\doignore#1{\begingroup
2952 % Scan in ``verbatim'' mode:
2953 \catcode`\@ = \other
2954 \catcode`\{ = \other
2955 \catcode`\} = \other
2957 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2960 % Count number of #1's that we've seen.
2963 % Swallow text until we reach the matching `@end #1'.
2967 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2970 \gdef\dodoignore#1{%
2971 % #1 contains the command name as a string, e.g., `ifinfo'.
2973 % Define a command to find the next `@end #1', which must be on a line
2974 % by itself. Ignore anything after the `#1'; this matters in
2975 % verbatim environments, where otherwise the newline after an
2976 % ignored conditional would result in a blank line in the output.
2977 \long\def\doignoretext##1^^M@end #1##2^^M{%
2978 \doignoretextyyy##1^^M@#1\_STOP_}%
2979 % And this command to find another #1 command, at the beginning of a
2980 % line. (Otherwise, we would consider a line `@c @ifset', for
2981 % example, to count as an @ifset for nesting.)
2982 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2984 % And now expand that command.
2990 \def\doignoreyyy#1{%
2992 \ifx\temp\empty % Nothing found.
2993 \let\next\doignoretextzzz
2994 \else % Found a nested condition, ...
2995 \advance\doignorecount by 1
2996 \let\next\doignoretextyyy % ..., look for another.
2997 % If we're here, #1 ends with ^^M\ifinfo (for example).
2999 \next #1% the token \_STOP_ is present just after this macro.
3002 % We have to swallow the remaining "\_STOP_".
3004 \def\doignoretextzzz#1{%
3005 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3006 \let\next\enddoignore
3007 \else % Still inside a nested condition.
3008 \advance\doignorecount by -1
3009 \let\next\doignoretext % Look for the next @end.
3014 % Finish off ignored text.
3015 \def\enddoignore{\endgroup\ignorespaces}
3018 % @set VAR sets the variable VAR to an empty value.
3019 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3021 % Since we want to separate VAR from REST-OF-LINE (which might be
3022 % empty), we can't just use \parsearg; we have to insert a space of our
3023 % own to delimit the rest of the line, and then take it out again if we
3025 % We rely on the fact that \parsearg sets \catcode`\ =10.
3027 \parseargdef\set{\setyyy#1 \endsetyyy}
3028 \def\setyyy#1 #2\endsetyyy{%
3030 \makevalueexpandable
3032 \edef\next{\gdef\makecsname{SET#1}}%
3040 % Remove the trailing space \setxxx inserted.
3041 \def\setzzz#1 \endsetzzz{\next{#1}}
3043 % @clear VAR clears (i.e., unsets) the variable VAR.
3045 \parseargdef\clear{%
3047 \makevalueexpandable
3048 \global\expandafter\let\csname SET#1\endcsname=\relax
3052 % @value{foo} gets the text saved in variable foo.
3053 \def\value{\begingroup\makevalueexpandable\valuexxx}
3054 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3056 \catcode`\- = \active \catcode`\_ = \active
3058 \gdef\makevalueexpandable{%
3059 \let\value = \expandablevalue
3060 % We don't want these characters active, ...
3061 \catcode`\-=\other \catcode`\_=\other
3062 % ..., but we might end up with active ones in the argument if
3063 % we're called from @code, as @code{@value{foo-bar_}}, though.
3064 % So \let them to their normal equivalents.
3065 \let-\realdash \let_\normalunderscore
3069 % We have this subroutine so that we can handle at least some @value's
3070 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3071 % The command has to be fully expandable (if the variable is set), since
3072 % the result winds up in the index file. This means that if the
3073 % variable's value contains other Texinfo commands, it's almost certain
3074 % it will fail (although perhaps we could fix that with sufficient work
3075 % to do a one-level expansion on the result, instead of complete).
3077 \def\expandablevalue#1{%
3078 \expandafter\ifx\csname SET#1\endcsname\relax
3079 {[No value for ``#1'']}%
3080 \message{Variable `#1', used in @value, is not set.}%
3082 \csname SET#1\endcsname
3086 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3089 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3092 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3095 \makevalueexpandable
3097 \expandafter\ifx\csname SET#2\endcsname\relax
3098 #1% If not set, redefine \next.
3103 \def\ifsetfail{\doignore{ifset}}
3105 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3106 % defined with @set, or has been undefined with @clear.
3108 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3109 % above code: if the variable is not set, do nothing, if it is set,
3110 % then redefine \next to \ifclearfail.
3113 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3114 \def\ifclearfail{\doignore{ifclear}}
3116 % @dircategory CATEGORY -- specify a category of the dir file
3117 % which this file should belong to. Ignore this in TeX.
3118 \let\dircategory=\comment
3120 % @defininfoenclose.
3121 \let\definfoenclose=\comment
3125 % Index generation facilities
3127 % Define \newwrite to be identical to plain tex's \newwrite
3128 % except not \outer, so it can be used within macros and \if's.
3129 \edef\newwrite{\makecsname{ptexnewwrite}}
3131 % \newindex {foo} defines an index named foo.
3132 % It automatically defines \fooindex such that
3133 % \fooindex ...rest of line... puts an entry in the index foo.
3134 % It also defines \fooindfile to be the number of the output channel for
3135 % the file that accumulates this index. The file's extension is foo.
3136 % The name of an index should be no more than 2 characters long
3137 % for the sake of vms.
3141 \expandafter\newwrite \csname#1indfile\endcsname
3142 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3144 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3145 \noexpand\doindex{#1}}
3148 % @defindex foo == \newindex{foo}
3150 \def\defindex{\parsearg\newindex}
3152 % Define @defcodeindex, like @defindex except put all entries in @code.
3154 \def\defcodeindex{\parsearg\newcodeindex}
3156 \def\newcodeindex#1{%
3158 \expandafter\newwrite \csname#1indfile\endcsname
3159 \openout \csname#1indfile\endcsname \jobname.#1
3161 \expandafter\xdef\csname#1index\endcsname{%
3162 \noexpand\docodeindex{#1}}%
3166 % @synindex foo bar makes index foo feed into index bar.
3167 % Do this instead of @defindex foo if you don't want it as a separate index.
3169 % @syncodeindex foo bar similar, but put all entries made for index foo
3172 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3173 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3175 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3176 % #3 the target index (bar).
3177 \def\dosynindex#1#2#3{%
3178 % Only do \closeout if we haven't already done it, else we'll end up
3179 % closing the target index.
3180 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3181 % The \closeout helps reduce unnecessary open files; the limit on the
3182 % Acorn RISC OS is a mere 16 files.
3183 \expandafter\closeout\csname#2indfile\endcsname
3184 \expandafter\let\csname\donesynindex#2\endcsname = 1
3186 % redefine \fooindfile:
3187 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3188 \expandafter\let\csname#2indfile\endcsname=\temp
3189 % redefine \fooindex:
3190 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3193 % Define \doindex, the driver for all \fooindex macros.
3194 % Argument #1 is generated by the calling \fooindex macro,
3195 % and it is "foo", the name of the index.
3197 % \doindex just uses \parsearg; it calls \doind for the actual work.
3198 % This is because \doind is more useful to call from other macros.
3200 % There is also \dosubind {index}{topic}{subtopic}
3201 % which makes an entry in a two-level index such as the operation index.
3203 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3204 \def\singleindexer #1{\doind{\indexname}{#1}}
3206 % like the previous two, but they put @code around the argument.
3207 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3208 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3210 % Take care of Texinfo commands that can appear in an index entry.
3211 % Since there are some commands we want to expand, and others we don't,
3212 % we have to laboriously prevent expansion for those that we don't.
3215 \escapechar = `\\ % use backslash in output files.
3216 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3217 \def\ {\realbackslash\space }%
3218 % Need these in case \tex is in effect and \{ is a \delimiter again.
3219 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3220 % braces and backslashes are used only as delimiters.
3224 % Do the redefinitions.
3228 % For the aux and toc files, @ is the escape character. So we want to
3229 % redefine everything using @ as the escape character (instead of
3230 % \realbackslash, still used for index files). When everything uses @,
3231 % this will be simpler.
3236 \let\{ = \lbraceatcmd
3237 \let\} = \rbraceatcmd
3239 % Do the redefinitions.
3244 % Called from \indexdummies and \atdummies.
3246 \def\commondummies{%
3248 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3249 % preventing its expansion. This is used only for control% words,
3250 % not control letters, because the \space would be incorrect for
3251 % control characters, but is needed to separate the control word
3252 % from whatever follows.
3254 % For control letters, we have \definedummyletter, which omits the
3257 % These can be used both for control words that take an argument and
3258 % those that do not. If it is followed by {arg} in the input, then
3259 % that will dutifully get written to the index (or wherever).
3261 \def\definedummyword ##1{\def##1{\string##1\space}}%
3262 \def\definedummyletter##1{\def##1{\string##1}}%
3263 \let\definedummyaccent\definedummyletter
3265 \commondummiesnofonts
3267 \definedummyletter\_%
3269 % Non-English letters.
3281 \definedummyword\exclamdown
3282 \definedummyword\questiondown
3283 \definedummyword\ordf
3284 \definedummyword\ordm
3286 % Although these internal commands shouldn't show up, sometimes they do.
3288 \definedummyword\gtr
3289 \definedummyword\hat
3290 \definedummyword\less
3293 \definedummyword\tclose
3296 \definedummyword\LaTeX
3297 \definedummyword\TeX
3299 % Assorted special characters.
3300 \definedummyword\bullet
3301 \definedummyword\comma
3302 \definedummyword\copyright
3303 \definedummyword\registeredsymbol
3304 \definedummyword\dots
3305 \definedummyword\enddots
3306 \definedummyword\equiv
3307 \definedummyword\error
3308 \definedummyword\euro
3309 \definedummyword\expansion
3310 \definedummyword\minus
3311 \definedummyword\pounds
3312 \definedummyword\point
3313 \definedummyword\print
3314 \definedummyword\result
3316 % We want to disable all macros so that they are not expanded by \write.
3319 \normalturnoffactive
3321 % Handle some cases of @value -- where it does not contain any
3322 % (non-fully-expandable) commands.
3323 \makevalueexpandable
3326 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3328 \def\commondummiesnofonts{%
3329 % Control letters and accents.
3330 \definedummyletter\!%
3331 \definedummyaccent\"%
3332 \definedummyaccent\'%
3333 \definedummyletter\*%
3334 \definedummyaccent\,%
3335 \definedummyletter\.%
3336 \definedummyletter\/%
3337 \definedummyletter\:%
3338 \definedummyaccent\=%
3339 \definedummyletter\?%
3340 \definedummyaccent\^%
3341 \definedummyaccent\`%
3342 \definedummyaccent\~%
3346 \definedummyword\dotaccent
3347 \definedummyword\ringaccent
3348 \definedummyword\tieaccent
3349 \definedummyword\ubaraccent
3350 \definedummyword\udotaccent
3351 \definedummyword\dotless
3353 % Texinfo font commands.
3360 % Commands that take arguments.
3361 \definedummyword\acronym
3362 \definedummyword\cite
3363 \definedummyword\code
3364 \definedummyword\command
3365 \definedummyword\dfn
3366 \definedummyword\emph
3367 \definedummyword\env
3368 \definedummyword\file
3369 \definedummyword\kbd
3370 \definedummyword\key
3371 \definedummyword\math
3372 \definedummyword\option
3373 \definedummyword\pxref
3374 \definedummyword\ref
3375 \definedummyword\samp
3376 \definedummyword\strong
3377 \definedummyword\tie
3378 \definedummyword\uref
3379 \definedummyword\url
3380 \definedummyword\var
3381 \definedummyword\verb
3383 \definedummyword\xref
3386 % \indexnofonts is used when outputting the strings to sort the index
3387 % by, and when constructing control sequence names. It eliminates all
3388 % control sequences and just writes whatever the best ASCII sort string
3389 % would be for a given command (usually its argument).
3392 % Accent commands should become @asis.
3393 \def\definedummyaccent##1{\let##1\asis}%
3394 % We can just ignore other control letters.
3395 \def\definedummyletter##1{\let##1\empty}%
3396 % Hopefully, all control words can become @asis.
3397 \let\definedummyword\definedummyaccent
3399 \commondummiesnofonts
3401 % Don't no-op \tt, since it isn't a user-level command
3402 % and is used in the definitions of the active chars like <, >, |, etc.
3403 % Likewise with the other plain tex font commands.
3408 % how to handle braces?
3409 \def\_{\normalunderscore}%
3411 % Non-English letters.
3424 \def\questiondown{?}%
3431 % Assorted special characters.
3432 % (The following {} will end up in the sort string, but that's ok.)
3433 \def\bullet{bullet}%
3435 \def\copyright{copyright}%
3436 \def\registeredsymbol{R}%
3442 \def\expansion{==>}%
3444 \def\pounds{pounds}%
3449 % We need to get rid of all macros, leaving only the arguments (if present).
3450 % Of course this is not nearly correct, but it is the best we can do for now.
3451 % makeinfo does not expand macros in the argument to @deffn, which ends up
3452 % writing an index entry, and texindex isn't prepared for an index sort entry
3453 % that starts with \.
3455 % Since macro invocations are followed by braces, we can just redefine them
3456 % to take a single TeX argument. The case of a macro invocation that
3457 % goes to end-of-line is not handled.
3462 \let\indexbackslash=0 %overridden during \printindex.
3463 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3465 % Most index entries go through here, but \dosubind is the general case.
3466 % #1 is the index name, #2 is the entry text.
3467 \def\doind#1#2{\dosubind{#1}{#2}{}}
3469 % Workhorse for all \fooindexes.
3470 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3471 % empty if called from \doind, as we usually are (the main exception
3472 % is with most defuns, which call us directly).
3474 \def\dosubind#1#2#3{%
3477 % Store the main index entry text (including the third arg).
3479 % If third arg is present, precede it with a space.
3481 \ifx\thirdarg\empty \else
3482 \toks0 = \expandafter{\the\toks0 \space #3}%
3485 \edef\writeto{\csname#1indfile\endcsname}%
3496 % Write the entry in \toks0 to the index file:
3498 \def\dosubindwrite{%
3499 % Put the index entry in the margin if desired.
3500 \ifx\SETmarginindex\relax\else
3501 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3504 % Remember, we are within a group.
3505 \indexdummies % Must do this here, since \bf, etc expand at this stage
3506 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3507 % so it will be output as is; and it will print as backslash.
3509 % Process the index entry with all font commands turned off, to
3510 % get the string to sort by.
3512 \edef\temp{\the\toks0}% need full expansion
3513 \xdef\indexsorttmp{\temp}%
3516 % Set up the complete index entry, with both the sort key and
3517 % the original text, including any font commands. We write
3518 % three arguments to \entry to the .?? file (four in the
3519 % subentry case), texindex reduces to two when writing the .??s
3523 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3528 % Take care of unwanted page breaks:
3530 % If a skip is the last thing on the list now, preserve it
3531 % by backing up by \lastskip, doing the \write, then inserting
3532 % the skip again. Otherwise, the whatsit generated by the
3533 % \write will make \lastskip zero. The result is that sequences
3538 % will have extra space inserted, because the \medbreak in the
3539 % start of the @defun won't see the skip inserted by the @end of
3540 % the previous defun.
3542 % But don't do any of this if we're not in vertical mode. We
3543 % don't want to do a \vskip and prematurely end a paragraph.
3545 % Avoid page breaks due to these extra skips, too.
3547 % But wait, there is a catch there:
3548 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3549 % sufficient for this purpose, as it ignores stretch and shrink parts
3550 % of the skip. The only way seems to be to check the textual
3551 % representation of the skip.
3553 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3554 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3556 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3560 \def\dosubindsanitize{%
3561 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3563 \edef\lastskipmacro{\the\lastskip}%
3564 \count255 = \lastpenalty
3566 % If \lastskip is nonzero, that means the last item was a
3567 % skip. And since a skip is discardable, that means this
3568 % -\skip0 glue we're inserting is preceded by a
3569 % non-discardable item, therefore it is not a potential
3570 % breakpoint, therefore no \nobreak needed.
3571 \ifx\lastskipmacro\zeroskipmacro
3578 \ifx\lastskipmacro\zeroskipmacro
3579 % If \lastskip was zero, perhaps the last item was a penalty, and
3580 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3581 % to re-insert the same penalty (values >10000 are used for various
3582 % signals); since we just inserted a non-discardable item, any
3583 % following glue (such as a \parskip) would be a breakpoint. For example:
3585 % @deffn deffn-whatever
3586 % @vindex index-whatever
3588 % would allow a break between the index-whatever whatsit
3589 % and the "Description." paragraph.
3590 \ifnum\count255>9999 \penalty\count255 \fi
3592 % On the other hand, if we had a nonzero \lastskip,
3593 % this make-up glue would be preceded by a non-discardable item
3594 % (the whatsit from the \write), so we must insert a \nobreak.
3595 \nobreak\vskip\skip0
3599 % The index entry written in the file actually looks like
3600 % \entry {sortstring}{page}{topic}
3602 % \entry {sortstring}{page}{topic}{subtopic}
3603 % The texindex program reads in these files and writes files
3604 % containing these kinds of lines:
3606 % before the first topic whose initial is c
3607 % \entry {topic}{pagelist}
3608 % for a topic that is used without subtopics
3610 % for the beginning of a topic that is used with subtopics
3611 % \secondary {subtopic}{pagelist}
3612 % for each subtopic.
3614 % Define the user-accessible indexing commands
3615 % @findex, @vindex, @kindex, @cindex.
3617 \def\findex {\fnindex}
3618 \def\kindex {\kyindex}
3619 \def\cindex {\cpindex}
3620 \def\vindex {\vrindex}
3621 \def\tindex {\tpindex}
3622 \def\pindex {\pgindex}
3624 \def\cindexsub {\begingroup\obeylines\cindexsub}
3626 \gdef\cindexsub "#1" #2^^M{\endgroup %
3627 \dosubind{cp}{#2}{#1}}}
3629 % Define the macros used in formatting output of the sorted index material.
3631 % @printindex causes a particular index (the ??s file) to get printed.
3632 % It does not print any chapter heading (usually an @unnumbered).
3634 \parseargdef\printindex{\begingroup
3635 \dobreak \chapheadingskip{10000}%
3639 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3641 % See if the index file exists and is nonempty.
3642 % Change catcode of @ here so that if the index file contains
3644 % as its first line, TeX doesn't complain about mismatched braces
3645 % (because it thinks @} is a control sequence).
3647 \openin 1 \jobname.#1s
3649 % \enddoublecolumns gets confused if there is no text in the index,
3650 % and it loses the chapter title and the aux file entries for the
3651 % index. The easiest way to prevent this problem is to make sure
3652 % there is some text.
3653 \putwordIndexNonexistent
3656 % If the index file exists but is empty, then \openin leaves \ifeof
3657 % false. We have to make TeX try to read something from the file, so
3658 % it can discover if there is anything in it.
3661 \putwordIndexIsEmpty
3663 % Index files are almost Texinfo source, but we use \ as the escape
3664 % character. It would be better to use @, but that's too big a change
3665 % to make right now.
3666 \def\indexbackslash{\backslashcurfont}%
3677 % These macros are used by the sorted index file itself.
3678 % Change them to control the appearance of the index.
3681 % Some minor font changes for the special characters.
3682 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3684 % Remove any glue we may have, we'll be inserting our own.
3687 % We like breaks before the index initials, so insert a bonus.
3689 \vskip 0pt plus 3\baselineskip
3691 \vskip 0pt plus -3\baselineskip
3693 % Typeset the initial. Making this add up to a whole number of
3694 % baselineskips increases the chance of the dots lining up from column
3695 % to column. It still won't often be perfect, because of the stretch
3696 % we need before each entry, but it's better.
3698 % No shrink because it confuses \balancecolumns.
3699 \vskip 1.67\baselineskip plus .5\baselineskip
3700 \leftline{\secbf #1}%
3701 % Do our best not to break after the initial.
3703 \vskip .33\baselineskip plus .1\baselineskip
3706 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3707 % then page number (#2) flushed to the right margin. It is used for index
3708 % and table of contents entries. The paragraph is indented by \leftskip.
3710 % A straightforward implementation would start like this:
3711 % \def\entry#1#2{...
3712 % But this frozes the catcodes in the argument, and can cause problems to
3713 % @code, which sets - active. This problem was fixed by a kludge---
3714 % ``-'' was active throughout whole index, but this isn't really right.
3716 % The right solution is to prevent \entry from swallowing the whole text.
3721 % Start a new paragraph if necessary, so our assignments below can't
3722 % affect previous text.
3725 % Do not fill out the last line with white space.
3728 % No extra space above this paragraph.
3731 % Do not prefer a separate line ending with a hyphen to fewer lines.
3732 \finalhyphendemerits = 0
3734 % \hangindent is only relevant when the entry text and page number
3735 % don't both fit on one line. In that case, bob suggests starting the
3736 % dots pretty far over on the line. Unfortunately, a large
3737 % indentation looks wrong when the entry text itself is broken across
3738 % lines. So we use a small indentation and put up with long leaders.
3740 % \hangafter is reset to 1 (which is the value we want) at the start
3741 % of each paragraph, so we need not do anything with that.
3744 % When the entry text needs to be broken, just fill out the first line
3746 \rightskip = 0pt plus1fil
3748 % A bit of stretch before each entry for the benefit of balancing
3752 % Swallow the left brace of the text (first parameter):
3753 \afterassignment\doentry
3757 \bgroup % Instead of the swallowed brace.
3759 \aftergroup\finishentry
3760 % And now comes the text of the entry.
3762 \def\finishentry#1{%
3763 % #1 is the page number.
3765 % The following is kludged to not output a line of dots in the index if
3766 % there are no page numbers. The next person who breaks this will be
3767 % cursed by a Unix daemon.
3770 \edef\tempc{\tempa}%
3771 \edef\tempd{\tempb}%
3776 % If we must, put the page number on a line of its own, and fill out
3777 % this line with blank space. (The \hfil is overwhelmed with the
3778 % fill leaders glue in \indexdotfill if the page number does fit.)
3780 \null\nobreak\indexdotfill % Have leaders before the page number.
3782 % The `\ ' here is removed by the implicit \unskip that TeX does as
3783 % part of (the primitive) \par. Without it, a spurious underfull
3796 % Like \dotfill except takes at least 1 em.
3797 \def\indexdotfill{\cleaders
3798 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3800 \def\primary #1{\line{#1\hfil}}
3802 \newskip\secondaryindent \secondaryindent=0.5cm
3803 \def\secondary#1#2{{%
3808 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3810 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3817 % Define two-column mode, which we use to typeset indexes.
3818 % Adapted from the TeXbook, page 416, which is to say,
3819 % the manmac.tex format used to print the TeXbook itself.
3823 \newdimen\doublecolumnhsize
3825 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3826 % Grab any single-column material above us.
3829 % Here is a possibility not foreseen in manmac: if we accumulate a
3830 % whole lot of material, we might end up calling this \output
3831 % routine twice in a row (see the doublecol-lose test, which is
3832 % essentially a couple of indexes with @setchapternewpage off). In
3833 % that case we just ship out what is in \partialpage with the normal
3834 % output routine. Generally, \partialpage will be empty when this
3835 % runs and this will be a no-op. See the indexspread.tex test case.
3836 \ifvoid\partialpage \else
3837 \onepageout{\pagecontents\partialpage}%
3840 \global\setbox\partialpage = \vbox{%
3841 % Unvbox the main output page.
3843 \kern-\topskip \kern\baselineskip
3846 \eject % run that output routine to set \partialpage
3848 % Use the double-column output routine for subsequent pages.
3849 \output = {\doublecolumnout}%
3851 % Change the page size parameters. We could do this once outside this
3852 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3853 % format, but then we repeat the same computation. Repeating a couple
3854 % of assignments once per index is clearly meaningless for the
3855 % execution time, so we may as well do it in one place.
3857 % First we halve the line length, less a little for the gutter between
3858 % the columns. We compute the gutter based on the line length, so it
3859 % changes automatically with the paper format. The magic constant
3860 % below is chosen so that the gutter has the same value (well, +-<1pt)
3861 % as it did when we hard-coded it.
3863 % We put the result in a separate register, \doublecolumhsize, so we
3864 % can restore it in \pagesofar, after \hsize itself has (potentially)
3867 \doublecolumnhsize = \hsize
3868 \advance\doublecolumnhsize by -.04154\hsize
3869 \divide\doublecolumnhsize by 2
3870 \hsize = \doublecolumnhsize
3872 % Double the \vsize as well. (We don't need a separate register here,
3873 % since nobody clobbers \vsize.)
3877 % The double-column output routine for all double-column pages except
3880 \def\doublecolumnout{%
3881 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3882 % Get the available space for the double columns -- the normal
3883 % (undoubled) page height minus any material left over from the
3887 \advance\dimen@ by -\ht\partialpage
3889 % box0 will be the left-hand column, box2 the right.
3890 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3891 \onepageout\pagesofar
3893 \penalty\outputpenalty
3896 % Re-output the contents of the output page -- any previous material,
3897 % followed by the two boxes we just split, in box0 and box2.
3901 \hsize = \doublecolumnhsize
3902 \wd0=\hsize \wd2=\hsize
3903 \hbox to\pagewidth{\box0\hfil\box2}%
3906 % All done with double columns.
3907 \def\enddoublecolumns{%
3909 % Split the last of the double-column material. Leave it on the
3910 % current page, no automatic page break.
3913 % If we end up splitting too much material for the current page,
3914 % though, there will be another page break right after this \output
3915 % invocation ends. Having called \balancecolumns once, we do not
3916 % want to call it again. Therefore, reset \output to its normal
3917 % definition right away. (We hope \balancecolumns will never be
3918 % called on to balance too much material, but if it is, this makes
3919 % the output somewhat more palatable.)
3920 \global\output = {\onepageout{\pagecontents\PAGE}}%
3923 \endgroup % started in \begindoublecolumns
3925 % \pagegoal was set to the doubled \vsize above, since we restarted
3926 % the current page. We're now back to normal single-column
3927 % typesetting, so reset \pagegoal to the normal \vsize (after the
3928 % \endgroup where \vsize got restored).
3932 % Called at the end of the double column material.
3933 \def\balancecolumns{%
3934 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3936 \advance\dimen@ by \topskip
3937 \advance\dimen@ by-\baselineskip
3938 \divide\dimen@ by 2 % target to split to
3939 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3940 \splittopskip = \topskip
3941 % Loop until we get a decent breakpoint.
3945 \global\setbox3 = \copy0
3946 \global\setbox1 = \vsplit3 to \dimen@
3948 \global\advance\dimen@ by 1pt
3951 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3952 \setbox0=\vbox to\dimen@{\unvbox1}%
3953 \setbox2=\vbox to\dimen@{\unvbox3}%
3957 \catcode`\@ = \other
3960 \message{sectioning,}
3961 % Chapters, sections, etc.
3963 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3964 % sections so that we can refer to them unambiguously in the pdf
3965 % outlines by their "section number". We avoid collisions with chapter
3966 % numbers by starting them at 10000. (If a document ever has 10000
3967 % chapters, we're in trouble anyway, I'm sure.)
3968 \newcount\unnumberedno \unnumberedno = 10000
3970 \newcount\secno \secno=0
3971 \newcount\subsecno \subsecno=0
3972 \newcount\subsubsecno \subsubsecno=0
3974 % This counter is funny since it counts through charcodes of letters A, B, ...
3975 \newcount\appendixno \appendixno = `\@
3977 % \def\appendixletter{\char\the\appendixno}
3978 % We do the following ugly conditional instead of the above simple
3979 % construct for the sake of pdftex, which needs the actual
3980 % letter in the expansion, not just typeset.
3982 \def\appendixletter{%
3983 \ifnum\appendixno=`A A%
3984 \else\ifnum\appendixno=`B B%
3985 \else\ifnum\appendixno=`C C%
3986 \else\ifnum\appendixno=`D D%
3987 \else\ifnum\appendixno=`E E%
3988 \else\ifnum\appendixno=`F F%
3989 \else\ifnum\appendixno=`G G%
3990 \else\ifnum\appendixno=`H H%
3991 \else\ifnum\appendixno=`I I%
3992 \else\ifnum\appendixno=`J J%
3993 \else\ifnum\appendixno=`K K%
3994 \else\ifnum\appendixno=`L L%
3995 \else\ifnum\appendixno=`M M%
3996 \else\ifnum\appendixno=`N N%
3997 \else\ifnum\appendixno=`O O%
3998 \else\ifnum\appendixno=`P P%
3999 \else\ifnum\appendixno=`Q Q%
4000 \else\ifnum\appendixno=`R R%
4001 \else\ifnum\appendixno=`S S%
4002 \else\ifnum\appendixno=`T T%
4003 \else\ifnum\appendixno=`U U%
4004 \else\ifnum\appendixno=`V V%
4005 \else\ifnum\appendixno=`W W%
4006 \else\ifnum\appendixno=`X X%
4007 \else\ifnum\appendixno=`Y Y%
4008 \else\ifnum\appendixno=`Z Z%
4009 % The \the is necessary, despite appearances, because \appendixletter is
4010 % expanded while writing the .toc file. \char\appendixno is not
4011 % expandable, thus it is written literally, thus all appendixes come out
4012 % with the same letter (or @) in the toc without it.
4013 \else\char\the\appendixno
4014 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4015 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4017 % Each @chapter defines this as the name of the chapter.
4018 % page headings and footings can use it. @section does likewise.
4019 % However, they are not reliable, because we don't use marks.
4023 \newcount\absseclevel % used to calculate proper heading level
4024 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4026 % @raisesections: treat @section as chapter, @subsection as section, etc.
4027 \def\raisesections{\global\advance\secbase by -1}
4028 \let\up=\raisesections % original BFox name
4030 % @lowersections: treat @chapter as section, @section as subsection, etc.
4031 \def\lowersections{\global\advance\secbase by 1}
4032 \let\down=\lowersections % original BFox name
4034 % we only have subsub.
4035 \chardef\maxseclevel = 3
4037 % A numbered section within an unnumbered changes to unnumbered too.
4038 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4039 \chardef\unmlevel = \maxseclevel
4041 % Trace whether the current chapter is an appendix or not:
4042 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4043 \def\chapheadtype{N}
4045 % Choose a heading macro
4046 % #1 is heading type
4047 % #2 is heading level
4048 % #3 is text for heading
4049 \def\genhead#1#2#3{%
4050 % Compute the abs. sec. level:
4052 \advance\absseclevel by \secbase
4053 % Make sure \absseclevel doesn't fall outside the range:
4054 \ifnum \absseclevel < 0
4057 \ifnum \absseclevel > 3
4064 \ifnum \absseclevel < \unmlevel
4065 \chardef\unmlevel = \absseclevel
4068 % Check for appendix sections:
4069 \ifnum \absseclevel = 0
4070 \edef\chapheadtype{\headtype}%
4072 \if \headtype A\if \chapheadtype N%
4073 \errmessage{@appendix... within a non-appendix chapter}%
4076 % Check for numbered within unnumbered:
4077 \ifnum \absseclevel > \unmlevel
4080 \chardef\unmlevel = 3
4083 % Now print the heading:
4087 \or \unnumberedseczzz{#3}%
4088 \or \unnumberedsubseczzz{#3}%
4089 \or \unnumberedsubsubseczzz{#3}%
4095 \or \appendixsectionzzz{#3}%
4096 \or \appendixsubseczzz{#3}%
4097 \or \appendixsubsubseczzz{#3}%
4103 \or \numberedsubseczzz{#3}%
4104 \or \numberedsubsubseczzz{#3}%
4108 \suppressfirstparagraphindent
4112 \def\numhead{\genhead N}
4113 \def\apphead{\genhead A}
4114 \def\unnmhead{\genhead U}
4116 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4117 % all lower-level sectioning counters to zero.
4119 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4120 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4121 \let\chaplevelprefix = \empty
4123 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4125 % section resetting is \global in case the chapter is in a group, such
4126 % as an @include file.
4127 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4128 \global\advance\chapno by 1
4131 \gdef\chaplevelprefix{\the\chapno.}%
4134 \message{\putwordChapter\space \the\chapno}%
4136 % Write the actual heading.
4137 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4139 % So @section and the like are numbered underneath this chapter.
4140 \global\let\section = \numberedsec
4141 \global\let\subsection = \numberedsubsec
4142 \global\let\subsubsection = \numberedsubsubsec
4145 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4146 \def\appendixzzz#1{%
4147 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4148 \global\advance\appendixno by 1
4149 \gdef\chaplevelprefix{\appendixletter.}%
4152 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4153 \message{\appendixnum}%
4155 \chapmacro{#1}{Yappendix}{\appendixletter}%
4157 \global\let\section = \appendixsec
4158 \global\let\subsection = \appendixsubsec
4159 \global\let\subsubsection = \appendixsubsubsec
4162 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4163 \def\unnumberedzzz#1{%
4164 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4165 \global\advance\unnumberedno by 1
4167 % Since an unnumbered has no number, no prefix for figures.
4168 \global\let\chaplevelprefix = \empty
4171 % This used to be simply \message{#1}, but TeX fully expands the
4172 % argument to \message. Therefore, if #1 contained @-commands, TeX
4173 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4174 % expanded @cite (which turns out to cause errors because \cite is meant
4175 % to be executed, not expanded).
4177 % Anyway, we don't want the fully-expanded definition of @cite to appear
4178 % as a result of the \message, we just want `@cite' itself. We use
4179 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4180 % simply yielding the contents of <toks register>. (We also do this for
4183 \message{(\the\toks0)}%
4185 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4187 \global\let\section = \unnumberedsec
4188 \global\let\subsection = \unnumberedsubsec
4189 \global\let\subsubsection = \unnumberedsubsubsec
4192 % @centerchap is like @unnumbered, but the heading is centered.
4193 \outer\parseargdef\centerchap{%
4194 % Well, we could do the following in a group, but that would break
4195 % an assumption that \chapmacro is called at the outermost level.
4196 % Thus we are safer this way: --kasal, 24feb04
4197 \let\centerparametersmaybe = \centerparameters
4199 \let\centerparametersmaybe = \relax
4202 % @top is like @unnumbered.
4206 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4208 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4209 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4212 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4213 \def\appendixsectionzzz#1{%
4214 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4215 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4217 \let\appendixsec\appendixsection
4219 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4220 \def\unnumberedseczzz#1{%
4221 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4222 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4226 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4227 \def\numberedsubseczzz#1{%
4228 \global\subsubsecno=0 \global\advance\subsecno by 1
4229 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4232 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4233 \def\appendixsubseczzz#1{%
4234 \global\subsubsecno=0 \global\advance\subsecno by 1
4235 \sectionheading{#1}{subsec}{Yappendix}%
4236 {\appendixletter.\the\secno.\the\subsecno}%
4239 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4240 \def\unnumberedsubseczzz#1{%
4241 \global\subsubsecno=0 \global\advance\subsecno by 1
4242 \sectionheading{#1}{subsec}{Ynothing}%
4243 {\the\unnumberedno.\the\secno.\the\subsecno}%
4247 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4248 \def\numberedsubsubseczzz#1{%
4249 \global\advance\subsubsecno by 1
4250 \sectionheading{#1}{subsubsec}{Ynumbered}%
4251 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4254 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4255 \def\appendixsubsubseczzz#1{%
4256 \global\advance\subsubsecno by 1
4257 \sectionheading{#1}{subsubsec}{Yappendix}%
4258 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4261 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4262 \def\unnumberedsubsubseczzz#1{%
4263 \global\advance\subsubsecno by 1
4264 \sectionheading{#1}{subsubsec}{Ynothing}%
4265 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4268 % These macros control what the section commands do, according
4269 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4270 % Define them by default for a numbered chapter.
4271 \let\section = \numberedsec
4272 \let\subsection = \numberedsubsec
4273 \let\subsubsection = \numberedsubsubsec
4275 % Define @majorheading, @heading and @subheading
4277 % NOTE on use of \vbox for chapter headings, section headings, and such:
4278 % 1) We use \vbox rather than the earlier \line to permit
4279 % overlong headings to fold.
4280 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4281 % heading is obnoxious; this forbids it.
4282 % 3) Likewise, headings look best if no \parindent is used, and
4283 % if justification is not attempted. Hence \raggedright.
4287 {\advance\chapheadingskip by 10pt \chapbreak }%
4288 \parsearg\chapheadingzzz
4291 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4292 \def\chapheadingzzz#1{%
4293 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4294 \parindent=0pt\raggedright
4296 \bigskip \par\penalty 200\relax
4297 \suppressfirstparagraphindent
4300 % @heading, @subheading, @subsubheading.
4301 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4302 \suppressfirstparagraphindent}
4303 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4304 \suppressfirstparagraphindent}
4305 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4306 \suppressfirstparagraphindent}
4308 % These macros generate a chapter, section, etc. heading only
4309 % (including whitespace, linebreaking, etc. around it),
4310 % given all the information in convenient, parsed form.
4312 %%% Args are the skip and penalty (usually negative)
4313 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4315 %%% Define plain chapter starts, and page on/off switching for it
4316 % Parameter controlling skip before chapter headings (if needed)
4318 \newskip\chapheadingskip
4320 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4321 \def\chappager{\par\vfill\supereject}
4322 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4324 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4327 \global\let\contentsalignmacro = \chappager
4328 \global\let\pchapsepmacro=\chapbreak
4329 \global\let\pagealignmacro=\chappager}
4332 \global\let\contentsalignmacro = \chappager
4333 \global\let\pchapsepmacro=\chappager
4334 \global\let\pagealignmacro=\chappager
4335 \global\def\HEADINGSon{\HEADINGSsingle}}
4338 \global\let\contentsalignmacro = \chapoddpage
4339 \global\let\pchapsepmacro=\chapoddpage
4340 \global\let\pagealignmacro=\chapoddpage
4341 \global\def\HEADINGSon{\HEADINGSdouble}}
4347 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4348 % Yappendix, Yomitfromtoc), #3 the chapter number.
4350 % To test against our argument.
4351 \def\Ynothingkeyword{Ynothing}
4352 \def\Yomitfromtockeyword{Yomitfromtoc}
4353 \def\Yappendixkeyword{Yappendix}
4355 \def\chapmacro#1#2#3{%
4360 % Have to define \thissection before calling \donoderef, because the
4361 % xref code eventually uses it. On the other hand, it has to be called
4362 % after \pchapsepmacro, or the headline will change too soon.
4363 \gdef\thissection{#1}%
4364 \gdef\thischaptername{#1}%
4366 % Only insert the separating space if we have a chapter/appendix
4367 % number, and don't print the unnumbered ``number''.
4369 \ifx\temptype\Ynothingkeyword
4371 \def\toctype{unnchap}%
4372 \gdef\thischapter{#1}%
4373 \else\ifx\temptype\Yomitfromtockeyword
4374 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4376 \gdef\thischapter{}%
4377 \else\ifx\temptype\Yappendixkeyword
4378 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4380 % We don't substitute the actual chapter name into \thischapter
4381 % because we don't want its macros evaluated now. And we don't
4382 % use \thissection because that changes with each section.
4384 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4385 \noexpand\thischaptername}%
4387 \setbox0 = \hbox{#3\enspace}%
4388 \def\toctype{numchap}%
4389 \xdef\thischapter{\putwordChapter{} \the\chapno:
4390 \noexpand\thischaptername}%
4393 % Write the toc entry for this chapter. Must come before the
4394 % \donoderef, because we include the current node name in the toc
4395 % entry, and \donoderef resets it to empty.
4396 \writetocentry{\toctype}{#1}{#3}%
4398 % For pdftex, we have to write out the node definition (aka, make
4399 % the pdfdest) after any page break, but before the actual text has
4400 % been typeset. If the destination for the pdf outline is after the
4401 % text, then jumping from the outline may wind up with the text not
4402 % being visible, for instance under high magnification.
4405 % Typeset the actual heading.
4406 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4407 \hangindent=\wd0 \centerparametersmaybe
4410 \nobreak\bigskip % no page break after a chapter title
4414 % @centerchap -- centered and unnumbered.
4415 \let\centerparametersmaybe = \relax
4416 \def\centerparameters{%
4417 \advance\rightskip by 3\rightskip
4418 \leftskip = \rightskip
4423 % I don't think this chapter style is supported any more, so I'm not
4424 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4426 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4428 \def\unnchfopen #1{%
4429 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4430 \parindent=0pt\raggedright
4431 \rm #1\hfill}}\bigskip \par\nobreak
4433 \def\chfopen #1#2{\chapoddpage {\chapfonts
4434 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4437 \def\centerchfopen #1{%
4438 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4440 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4443 \global\let\chapmacro=\chfopen
4444 \global\let\centerchapmacro=\centerchfopen}
4447 % Section titles. These macros combine the section number parts and
4448 % call the generic \sectionheading to do the printing.
4450 \newskip\secheadingskip
4451 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4453 % Subsection titles.
4454 \newskip\subsecheadingskip
4455 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4457 % Subsubsection titles.
4458 \def\subsubsecheadingskip{\subsecheadingskip}
4459 \def\subsubsecheadingbreak{\subsecheadingbreak}
4462 % Print any size, any type, section title.
4464 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4465 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4468 \def\sectionheading#1#2#3#4{%
4470 % Switch to the right set of fonts.
4471 \csname #2fonts\endcsname \rm
4473 % Insert space above the heading.
4474 \csname #2headingbreak\endcsname
4476 % Only insert the space after the number if we have a section number.
4477 \def\sectionlevel{#2}%
4480 \ifx\temptype\Ynothingkeyword
4483 \gdef\thissection{#1}%
4484 \else\ifx\temptype\Yomitfromtockeyword
4485 % for @headings -- no section number, don't include in toc,
4486 % and don't redefine \thissection.
4489 \let\sectionlevel=\empty
4490 \else\ifx\temptype\Yappendixkeyword
4491 \setbox0 = \hbox{#4\enspace}%
4493 \gdef\thissection{#1}%
4495 \setbox0 = \hbox{#4\enspace}%
4497 \gdef\thissection{#1}%
4500 % Write the toc entry (before \donoderef). See comments in \chfplain.
4501 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4503 % Write the node reference (= pdf destination for pdftex).
4504 % Again, see comments in \chfplain.
4507 % Output the actual section heading.
4508 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4509 \hangindent=\wd0 % zero if no section number
4512 % Add extra space after the heading -- half of whatever came above it.
4513 % Don't allow stretch, though.
4514 \kern .5 \csname #2headingskip\endcsname
4516 % Do not let the kern be a potential breakpoint, as it would be if it
4517 % was followed by glue.
4520 % We'll almost certainly start a paragraph next, so don't let that
4521 % glue accumulate. (Not a breakpoint because it's preceded by a
4522 % discardable item.)
4525 % This is purely so the last item on the list is a known \penalty >
4526 % 10000. This is so \startdefun can avoid allowing breakpoints after
4527 % section headings. Otherwise, it would insert a valid breakpoint between:
4529 % @section sec-whatever
4530 % @deffn def-whatever
4536 % Table of contents.
4539 % Write an entry to the toc file, opening it if necessary.
4540 % Called from @chapter, etc.
4542 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4543 % We append the current node name (if any) and page number as additional
4544 % arguments for the \{chap,sec,...}entry macros which will eventually
4545 % read this. The node name is used in the pdf outlines as the
4546 % destination to jump to.
4548 % We open the .toc file for writing here instead of at @setfilename (or
4549 % any other fixed time) so that @contents can be anywhere in the document.
4550 % But if #1 is `omit', then we don't do anything. This is used for the
4551 % table of contents chapter openings themselves.
4553 \newif\iftocfileopened
4554 \def\omitkeyword{omit}%
4556 \def\writetocentry#1#2#3{%
4557 \edef\writetoctype{#1}%
4558 \ifx\writetoctype\omitkeyword \else
4559 \iftocfileopened\else
4560 \immediate\openout\tocfile = \jobname.toc
4561 \global\tocfileopenedtrue
4567 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4573 % Tell \shipout to create a pdf destination on each page, if we're
4574 % writing pdf. These are used in the table of contents. We can't
4575 % just write one on every page because the title pages are numbered
4576 % 1 and 2 (the page numbers aren't printed), and so are the first
4577 % two pages of the document. Thus, we'd have two destinations named
4578 % `1', and two named `2'.
4579 \ifpdf \global\pdfmakepagedesttrue \fi
4583 % These characters do not print properly in the Computer Modern roman
4584 % fonts, so we must take special care. This is more or less redundant
4585 % with the Texinfo input format setup at the end of this file.
4587 \def\activecatcodes{%
4600 % Read the toc file, which is essentially Texinfo input.
4607 \newskip\contentsrightmargin \contentsrightmargin=1in
4608 \newcount\savepageno
4609 \newcount\lastnegativepageno \lastnegativepageno = -1
4611 % Prepare to read what we've written to \tocfile.
4613 \def\startcontents#1{%
4614 % If @setchapternewpage on, and @headings double, the contents should
4615 % start on an odd page, unlike chapters. Thus, we maintain
4616 % \contentsalignmacro in parallel with \pagealignmacro.
4617 % From: Torbjorn Granlund <tege@matematik.su.se>
4619 \immediate\closeout\tocfile
4621 % Don't need to put `Contents' or `Short Contents' in the headline.
4622 % It is abundantly clear what they are.
4624 \chapmacro{#1}{Yomitfromtoc}{}%
4626 \savepageno = \pageno
4627 \begingroup % Set up to handle contents files properly.
4628 \raggedbottom % Worry more about breakpoints than the bottom.
4629 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4631 % Roman numerals for page numbers.
4632 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4636 % Normal (long) toc.
4638 \startcontents{\putwordTOC}%
4639 \openin 1 \jobname.toc
4644 \contentsalignmacro % in case @setchapternewpage odd is in effect
4650 \lastnegativepageno = \pageno
4651 \global\pageno = \savepageno
4654 % And just the chapters.
4655 \def\summarycontents{%
4656 \startcontents{\putwordShortTOC}%
4658 \let\numchapentry = \shortchapentry
4659 \let\appentry = \shortchapentry
4660 \let\unnchapentry = \shortunnchapentry
4661 % We want a true roman here for the page numbers.
4663 \let\rm=\shortcontrm \let\bf=\shortcontbf
4664 \let\sl=\shortcontsl \let\tt=\shortconttt
4666 \hyphenpenalty = 10000
4667 \advance\baselineskip by 1pt % Open it up a little.
4668 \def\numsecentry##1##2##3##4{}
4669 \let\appsecentry = \numsecentry
4670 \let\unnsecentry = \numsecentry
4671 \let\numsubsecentry = \numsecentry
4672 \let\appsubsecentry = \numsecentry
4673 \let\unnsubsecentry = \numsecentry
4674 \let\numsubsubsecentry = \numsecentry
4675 \let\appsubsubsecentry = \numsecentry
4676 \let\unnsubsubsecentry = \numsecentry
4677 \openin 1 \jobname.toc
4683 \contentsalignmacro % in case @setchapternewpage odd is in effect
4685 \lastnegativepageno = \pageno
4686 \global\pageno = \savepageno
4688 \let\shortcontents = \summarycontents
4690 % Typeset the label for a chapter or appendix for the short contents.
4691 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4693 \def\shortchaplabel#1{%
4694 % This space should be enough, since a single number is .5em, and the
4695 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4696 % But use \hss just in case.
4697 % (This space doesn't include the extra space that gets added after
4698 % the label; that gets put in by \shortchapentry above.)
4700 % We'd like to right-justify chapter numbers, but that looks strange
4701 % with appendix letters. And right-justifying numbers and
4702 % left-justifying letters looks strange when there is less than 10
4703 % chapters. Have to read the whole toc once to know how many chapters
4704 % there are before deciding ...
4705 \hbox to 1em{#1\hss}%
4708 % These macros generate individual entries in the table of contents.
4709 % The first argument is the chapter or section name.
4710 % The last argument is the page number.
4711 % The arguments in between are the chapter number, section number, ...
4713 % Chapters, in the main contents.
4714 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4716 % Chapters, in the short toc.
4717 % See comments in \dochapentry re vbox and related settings.
4718 \def\shortchapentry#1#2#3#4{%
4719 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4722 % Appendices, in the main contents.
4723 % Need the word Appendix, and a fixed-size box.
4725 \def\appendixbox#1{%
4726 % We use M since it's probably the widest letter.
4727 \setbox0 = \hbox{\putwordAppendix{} M}%
4728 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4730 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4732 % Unnumbered chapters.
4733 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4734 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4737 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4738 \let\appsecentry=\numsecentry
4739 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4742 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4743 \let\appsubsecentry=\numsubsecentry
4744 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4746 % And subsubsections.
4747 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4748 \let\appsubsubsecentry=\numsubsubsecentry
4749 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4751 % This parameter controls the indentation of the various levels.
4752 % Same as \defaultparindent.
4753 \newdimen\tocindent \tocindent = 15pt
4755 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4758 % If the toc has to be broken over pages, we want it to be at chapters
4759 % if at all possible; hence the \penalty.
4760 \def\dochapentry#1#2{%
4761 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4764 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4766 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4769 \def\dosecentry#1#2{\begingroup
4770 \secentryfonts \leftskip=\tocindent
4771 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4774 \def\dosubsecentry#1#2{\begingroup
4775 \subsecentryfonts \leftskip=2\tocindent
4776 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4779 \def\dosubsubsecentry#1#2{\begingroup
4780 \subsubsecentryfonts \leftskip=3\tocindent
4781 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4784 % We use the same \entry macro as for the index entries.
4785 \let\tocentry = \entry
4787 % Space between chapter (or whatever) number and the title.
4788 \def\labelspace{\hskip1em \relax}
4790 \def\dopageno#1{{\rm #1}}
4791 \def\doshortpageno#1{{\rm #1}}
4793 \def\chapentryfonts{\secfonts \rm}
4794 \def\secentryfonts{\textfonts}
4795 \def\subsecentryfonts{\textfonts}
4796 \def\subsubsecentryfonts{\textfonts}
4799 \message{environments,}
4800 % @foo ... @end foo.
4802 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4804 % Since these characters are used in examples, it should be an even number of
4805 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4808 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4809 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4810 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4811 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4813 % The @error{} command.
4814 % Adapted from the TeXbook's \boxit.
4818 {\tentt \global\dimen0 = 3em}% Width of the box.
4819 \dimen2 = .55pt % Thickness of rules
4820 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4821 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4823 \setbox\errorbox=\hbox to \dimen0{\hfil
4824 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4825 \advance\hsize by -2\dimen2 % Rules.
4827 \hrule height\dimen2
4828 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4829 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4830 \kern3pt\vrule width\dimen2}% Space to right.
4831 \hrule height\dimen2}
4834 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4836 % @tex ... @end tex escapes into raw Tex temporarily.
4837 % One exception: @ is still an escape character, so that @end tex works.
4838 % But \@ or @@ will get a plain tex @ character.
4841 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4842 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4843 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4853 \let\bullet=\ptexbullet
4858 \let\equiv=\ptexequiv
4861 \let\indent=\ptexindent
4862 \let\noindent=\ptexnoindent
4869 \let\frenchspacing=\plainfrenchspacing
4871 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4872 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4875 % There is no need to define \Etex.
4877 % Define @lisp ... @end lisp.
4878 % @lisp environment forms a group so it can rebind things,
4879 % including the definition of @end lisp (which normally is erroneous).
4881 % Amount to narrow the margins by for @lisp.
4882 \newskip\lispnarrowing \lispnarrowing=0.4in
4884 % This is the definition that ^^M gets inside @lisp, @example, and other
4885 % such environments. \null is better than a space, since it doesn't
4887 \def\lisppar{\null\endgraf}
4889 % This space is always present above and below environments.
4890 \newskip\envskipamount \envskipamount = 0pt
4892 % Make spacing and below environment symmetrical. We use \parskip here
4893 % to help in doing that, since in @example-like environments \parskip
4894 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4895 % start of the next paragraph will insert \parskip.
4897 \def\aboveenvbreak{{%
4898 % =10000 instead of <10000 because of a special case in \itemzzz and
4899 % \sectionheading, q.v.
4900 \ifnum \lastpenalty=10000 \else
4901 \advance\envskipamount by \parskip
4903 \ifdim\lastskip<\envskipamount
4905 % it's not a good place to break if the last penalty was \nobreak
4907 \ifnum\lastpenalty<10000 \penalty-50 \fi
4908 \vskip\envskipamount
4913 \let\afterenvbreak = \aboveenvbreak
4915 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
4916 % also clear it, so that its embedded environments do the narrowing again.
4917 \let\nonarrowing=\relax
4919 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4920 % environment contents.
4921 \font\circle=lcircle10
4923 \newdimen\cartouter\newdimen\cartinner
4924 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4925 \circthick=\fontdimen8\circle
4927 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4928 \def\ctr{{\hskip 6pt\circle\char'010}}
4929 \def\cbl{{\circle\char'012\hskip -6pt}}
4930 \def\cbr{{\hskip 6pt\circle\char'011}}
4931 \def\carttop{\hbox to \cartouter{\hskip\lskip
4932 \ctl\leaders\hrule height\circthick\hfil\ctr
4934 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4935 \cbl\leaders\hrule height\circthick\hfil\cbr
4938 \newskip\lskip\newskip\rskip
4941 \ifhmode\par\fi % can't be in the midst of a paragraph.
4943 \lskip=\leftskip \rskip=\rightskip
4944 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4945 \cartinner=\hsize \advance\cartinner by-\lskip
4946 \advance\cartinner by-\rskip
4948 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4949 % side, and for 6pt waste from
4950 % each corner char, and rule thickness
4951 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4952 % Flag to tell @lisp, etc., not to narrow margin.
4953 \let\nonarrowing = t%
4955 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4963 \baselineskip=\normbskip
4964 \lineskip=\normlskip
4967 \comment % For explanation, see the end of \def\group.
4982 % This macro is called at the beginning of all the @example variants,
4986 \hfuzz = 12pt % Don't be fussy
4987 \sepspaces % Make spaces be word-separators rather than space tokens.
4988 \let\par = \lisppar % don't ignore blank lines
4989 \obeylines % each line of input is a line of output
4992 \emergencystretch = 0pt % don't try to avoid overfull boxes
4993 \ifx\nonarrowing\relax
4994 \advance \leftskip by \lispnarrowing
4995 \exdentamount=\lispnarrowing
4997 \let\nonarrowing = \relax
4999 \let\exdent=\nofillexdent
5002 % If you want all examples etc. small: @set dispenvsize small.
5003 % If you want even small examples the full size: @set dispenvsize nosmall.
5004 % This affects the following displayed environments:
5005 % @example, @display, @format, @lisp
5007 \def\smallword{small}
5008 \def\nosmallword{nosmall}
5009 \let\SETdispenvsize\relax
5010 \def\setnormaldispenv{%
5011 \ifx\SETdispenvsize\smallword
5012 \smallexamplefonts \rm
5015 \def\setsmalldispenv{%
5016 \ifx\SETdispenvsize\nosmallword
5018 \smallexamplefonts \rm
5022 % We often define two environments, @foo and @smallfoo.
5023 % Let's do it by one command:
5024 \def\makedispenv #1#2{
5025 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5026 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5027 \expandafter\let\csname E#1\endcsname \afterenvbreak
5028 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5031 % Define two synonyms:
5032 \def\maketwodispenvs #1#2#3{
5033 \makedispenv{#1}{#3}
5034 \makedispenv{#2}{#3}
5037 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5039 % @smallexample and @smalllisp: use smaller fonts.
5040 % Originally contributed by Pavel@xerox.
5042 \maketwodispenvs {lisp}{example}{%
5045 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5046 \gobble % eat return
5049 % @display/@smalldisplay: same as @lisp except keep current font.
5051 \makedispenv {display}{%
5056 % @format/@smallformat: same as @display except don't narrow margins.
5058 \makedispenv{format}{%
5059 \let\nonarrowing = t%
5064 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5066 \let\nonarrowing = t%
5070 \let\Eflushleft = \afterenvbreak
5074 \envdef\flushright{%
5075 \let\nonarrowing = t%
5077 \advance\leftskip by 0pt plus 1fill
5080 \let\Eflushright = \afterenvbreak
5083 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5084 % and narrows the margins. We keep \parskip nonzero in general, since
5085 % we're doing normal filling. So, when using \aboveenvbreak and
5086 % \afterenvbreak, temporarily make \parskip 0.
5089 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5092 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5093 \ifx\nonarrowing\relax
5094 \advance\leftskip by \lispnarrowing
5095 \advance\rightskip by \lispnarrowing
5096 \exdentamount = \lispnarrowing
5098 \let\nonarrowing = \relax
5100 \parsearg\quotationlabel
5103 % We have retained a nonzero parskip for the environment, since we're
5104 % doing normal filling.
5108 \ifx\quotationauthor\undefined\else
5110 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5112 {\parskip=0pt \afterenvbreak}%
5115 % If we're given an argument, typeset it in bold with a colon after.
5116 \def\quotationlabel#1{%
5118 \ifx\temp\empty \else
5124 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5125 % If we want to allow any <char> as delimiter,
5126 % we need the curly braces so that makeinfo sees the @verb command, eg:
5127 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5129 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5131 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5132 % active too. Otherwise, they get lost as the first character on a
5135 \do\ \do\\\do\{\do\}\do\$\do\&%
5136 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5137 \do\<\do\>\do\|\do\@\do+\do\"%
5141 \def\uncatcodespecials{%
5142 \def\do##1{\catcode`##1=\other}\dospecials}
5144 % [Knuth] pp. 380,381,391
5145 % Disable Spanish ligatures ?` and !` of \tt font
5147 \catcode`\`=\active\gdef`{\relax\lq}
5150 % Setup for the @verb command.
5152 % Eight spaces for a tab
5154 \catcode`\^^I=\active
5155 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5159 \tt % easiest (and conventionally used) font for verbatim
5160 \def\par{\leavevmode\endgraf}%
5163 % Respect line breaks,
5164 % print special symbols as themselves, and
5165 % make each space count
5166 % must do in this order:
5167 \obeylines \uncatcodespecials \sepspaces
5170 % Setup for the @verbatim environment
5172 % Real tab expansion
5173 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5175 \def\starttabbox{\setbox0=\hbox\bgroup}
5177 \catcode`\^^I=\active
5179 \catcode`\^^I=\active
5180 \def^^I{\leavevmode\egroup
5181 \dimen0=\wd0 % the width so far, or since the previous tab
5182 \divide\dimen0 by\tabw
5183 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5184 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5185 \wd0=\dimen0 \box0 \starttabbox
5189 \def\setupverbatim{%
5190 \let\nonarrowing = t%
5192 % Easiest (and conventionally used) font for verbatim
5194 \def\par{\leavevmode\egroup\box0\endgraf}%
5197 % Respect line breaks,
5198 % print special symbols as themselves, and
5199 % make each space count
5200 % must do in this order:
5201 \obeylines \uncatcodespecials \sepspaces
5202 \everypar{\starttabbox}%
5205 % Do the @verb magic: verbatim text is quoted by unique
5206 % delimiter characters. Before first delimiter expect a
5207 % right brace, after last delimiter expect closing brace:
5209 % \def\doverb'{'<char>#1<char>'}'{#1}
5211 % [Knuth] p. 382; only eat outer {}
5213 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5214 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5217 \def\verb{\begingroup\setupverb\doverb}
5220 % Do the @verbatim magic: define the macro \doverbatim so that
5221 % the (first) argument ends when '@end verbatim' is reached, ie:
5223 % \def\doverbatim#1@end verbatim{#1}
5225 % For Texinfo it's a lot easier than for LaTeX,
5226 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5227 % we need not redefine '\', '{' and '}'.
5229 % Inspired by LaTeX's verbatim command set [latex.ltx]
5234 % ignore everything up to the first ^^M, that's the newline at the end
5235 % of the @verbatim input line itself. Otherwise we get an extra blank
5236 % line in the output.
5237 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5238 % We really want {...\end verbatim} in the body of the macro, but
5239 % without the active space; thus we have to use \xdef and \gobble.
5243 \setupverbatim\doverbatim
5245 \let\Everbatim = \afterenvbreak
5248 % @verbatiminclude FILE - insert text of file in verbatim environment.
5250 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5252 \def\doverbatiminclude#1{%
5254 \makevalueexpandable
5261 % @copying ... @end copying.
5262 % Save the text away for @insertcopying later.
5264 % We save the uninterpreted tokens, rather than creating a box.
5265 % Saving the text in a box would be much easier, but then all the
5266 % typesetting commands (@smallbook, font changes, etc.) have to be done
5267 % beforehand -- and a) we want @copying to be done first in the source
5268 % file; b) letting users define the frontmatter in as flexible order as
5269 % possible is very desirable.
5271 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5272 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5274 \def\insertcopying{%
5276 \parindent = 0pt % paragraph indentation looks wrong on title page
5277 \scanexp\copyingtext
5284 \newskip\defbodyindent \defbodyindent=.4in
5285 \newskip\defargsindent \defargsindent=50pt
5286 \newskip\deflastargmargin \deflastargmargin=18pt
5288 % Start the processing of @deffn:
5290 \ifnum\lastpenalty<10000
5293 % If there are two @def commands in a row, we'll have a \nobreak,
5294 % which is there to keep the function description together with its
5295 % header. But if there's nothing but headers, we need to allow a
5296 % break somewhere. Check specifically for penalty 10002, inserted
5297 % by \defargscommonending, instead of 10000, since the sectioning
5298 % commands also insert a nobreak penalty, and we don't want to allow
5299 % a break between a section heading and a defun.
5301 \ifnum\lastpenalty=10002 \penalty2000 \fi
5303 % Similarly, after a section heading, do not allow a break.
5304 % But do insert the glue.
5305 \medskip % preceded by discardable penalty, so not a breakpoint
5309 \advance\leftskip by \defbodyindent
5310 \exdentamount=\defbodyindent
5314 % First, check whether we are in the right environment:
5317 % As above, allow line break if we have multiple x headers in a row.
5318 % It's not a great place, though.
5319 \ifnum\lastpenalty=10002 \penalty3000 \fi
5321 % And now, it's time to reuse the body of the original defun:
5322 \expandafter\gobbledefun#1%
5324 \def\gobbledefun#1\startdefun{}
5326 % \printdefunline \deffnheader{text}
5328 \def\printdefunline#1#2{%
5330 % call \deffnheader:
5333 \interlinepenalty = 10000
5334 \advance\rightskip by 0pt plus 1fil
5336 \nobreak\vskip -\parskip
5337 \penalty 10002 % signal to \startdefun and \dodefunx
5338 % Some of the @defun-type tags do not enable magic parentheses,
5339 % rendering the following check redundant. But we don't optimize.
5344 \def\Edefun{\endgraf\medbreak}
5346 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5347 % the only thing remainnig is to define \deffnheader.
5350 \expandafter\let\csname E#1\endcsname = \Edefun
5351 \edef\temp{\noexpand\domakedefun
5352 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5356 % \domakedefun \deffn \deffnx \deffnheader
5358 % Define \deffn and \deffnx, without parameters.
5359 % \deffnheader has to be defined explicitly.
5361 \def\domakedefun#1#2#3{%
5364 \parseargusing\activeparens{\printdefunline#3}%
5366 \def#2{\dodefunx#1}%
5370 %%% Untyped functions:
5372 % @deffn category name args
5373 \makedefun{deffn}{\deffngeneral{}}
5375 % @deffn category class name args
5376 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5378 % \defopon {category on}class name args
5379 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5381 % \deffngeneral {subind}category name args
5383 \def\deffngeneral#1#2 #3 #4\endheader{%
5384 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5385 \dosubind{fn}{\code{#3}}{#1}%
5386 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5389 %%% Typed functions:
5391 % @deftypefn category type name args
5392 \makedefun{deftypefn}{\deftypefngeneral{}}
5394 % @deftypeop category class type name args
5395 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5397 % \deftypeopon {category on}class type name args
5398 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5400 % \deftypefngeneral {subind}category type name args
5402 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5403 \dosubind{fn}{\code{#4}}{#1}%
5404 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5407 %%% Typed variables:
5409 % @deftypevr category type var args
5410 \makedefun{deftypevr}{\deftypecvgeneral{}}
5412 % @deftypecv category class type var args
5413 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5415 % \deftypecvof {category of}class type var args
5416 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5418 % \deftypecvgeneral {subind}category type var args
5420 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5421 \dosubind{vr}{\code{#4}}{#1}%
5422 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5425 %%% Untyped variables:
5427 % @defvr category var args
5428 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5430 % @defcv category class var args
5431 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5433 % \defcvof {category of}class var args
5434 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5437 % @deftp category name args
5438 \makedefun{deftp}#1 #2 #3\endheader{%
5439 \doind{tp}{\code{#2}}%
5440 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5443 % Remaining @defun-like shortcuts:
5444 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5445 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5446 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5447 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5448 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5449 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5450 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5451 \makedefun{defmethod}{\defopon\putwordMethodon}
5452 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5453 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5454 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5456 % \defname, which formats the name of the @def (not the args).
5457 % #1 is the category, such as "Function".
5458 % #2 is the return type, if any.
5459 % #3 is the function name.
5461 % We are followed by (but not passed) the arguments, if any.
5463 \def\defname#1#2#3{%
5464 % Get the values of \leftskip and \rightskip as they were outside the @def...
5465 \advance\leftskip by -\defbodyindent
5467 % How we'll format the type name. Putting it in brackets helps
5468 % distinguish it from the body text that may end up on the next line
5471 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5473 % Figure out line sizes for the paragraph shape.
5474 % The first line needs space for \box0; but if \rightskip is nonzero,
5475 % we need only space for the part of \box0 which exceeds it:
5476 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5477 % The continuations:
5478 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5479 % (plain.tex says that \dimen1 should be used only as global.)
5480 \parshape 2 0in \dimen0 \defargsindent \dimen2
5482 % Put the type name to the right margin.
5485 \hfil\box0 \kern-\hsize
5486 % \hsize has to be shortened this way:
5488 % Intentionally do not respect \rightskip, since we need the space.
5491 % Allow all lines to be underfull without complaint:
5492 \tolerance=10000 \hbadness=10000
5493 \exdentamount=\defbodyindent
5495 % defun fonts. We use typewriter by default (used to be bold) because:
5496 % . we're printing identifiers, they should be in tt in principle.
5497 % . in languages with many accents, such as Czech or French, it's
5498 % common to leave accents off identifiers. The result looks ok in
5499 % tt, but exceedingly strange in rm.
5500 % . we don't want -- and --- to be treated as ligatures.
5501 % . this still does not fix the ?` and !` ligatures, but so far no
5502 % one has made identifiers using them :).
5504 \def\temp{#2}% return value type
5505 \ifx\temp\empty\else \tclose{\temp} \fi
5506 #3% output function name
5508 {\rm\enskip}% hskip 0.5 em of \tenrm
5511 % arguments will be output next, if any.
5514 % Print arguments in slanted roman (not ttsl), inconsistently with using
5515 % tt for the name. This is because literal text is sometimes needed in
5516 % the argument list (groff manual), and ttsl and tt are not very
5517 % distinguishable. Prevent hyphenation at `-' chars.
5520 % use sl by default (not ttsl),
5522 \df \sl \hyphenchar\font=0
5524 % On the other hand, if an argument has two dashes (for instance), we
5525 % want a way to get ttsl. Let's try @var for that.
5528 \sl\hyphenchar\font=45
5531 % We want ()&[] to print specially on the defun line.
5534 \catcode`\(=\active \catcode`\)=\active
5535 \catcode`\[=\active \catcode`\]=\active
5539 % Make control sequences which act like normal parenthesis chars.
5540 \let\lparen = ( \let\rparen = )
5542 % Be sure that we always have a definition for `(', etc. For example,
5543 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5544 % so TeX would otherwise complain about undefined control sequence.
5547 \global\let(=\lparen \global\let)=\rparen
5548 \global\let[=\lbrack \global\let]=\rbrack
5551 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5552 \gdef\magicamp{\let&=\amprm}
5555 \newcount\parencount
5557 % If we encounter &foo, then turn on ()-hacking afterwards
5559 \def\amprm#1 {\ampseentrue{\bf\ }}
5563 % At the first level, print parens in roman,
5564 % otherwise use the default font.
5565 \ifnum \parencount=1 \rm \fi
5567 % The \sf parens (in \boldbrax) actually are a little bolder than
5568 % the contained text. This is especially needed for [ and ] .
5572 \def\infirstlevel#1{%
5579 \def\bfafterword#1 {#1 \bf}
5582 \global\advance\parencount by 1
5584 \infirstlevel \bfafterword
5589 \global\advance\parencount by -1
5592 \newcount\brackcount
5594 \global\advance\brackcount by 1
5599 \global\advance\brackcount by -1
5602 \def\checkparencounts{%
5603 \ifnum\parencount=0 \else \badparencount \fi
5604 \ifnum\brackcount=0 \else \badbrackcount \fi
5606 \def\badparencount{%
5607 \errmessage{Unbalanced parentheses in @def}%
5608 \global\parencount=0
5610 \def\badbrackcount{%
5611 \errmessage{Unbalanced square braces in @def}%
5612 \global\brackcount=0
5619 % To do this right we need a feature of e-TeX, \scantokens,
5620 % which we arrange to emulate with a temporary file in ordinary TeX.
5621 \ifx\eTeXversion\undefined
5622 \newwrite\macscribble
5625 \immediate\openout\macscribble=\jobname.tmp
5626 \immediate\write\macscribble{\the\toks0}%
5627 \immediate\closeout\macscribble
5635 \let\xeatspaces\eatspaces
5636 % Undo catcode changes of \startcontents and \doprintindex
5637 % When called from @insertcopying or (short)caption, we need active
5638 % backslash to get it printed correctly. Previously, we had
5639 % \catcode`\\=\other instead. We'll see whether a problem appears
5640 % with macro expansion. --kasal, 19aug04
5641 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5645 % Append \endinput to make sure that TeX does not see the ending newline.
5647 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5649 \scantokens{#1\endinput}%
5654 \edef\temp{\noexpand\scanmacro{#1}}%
5658 \newcount\paramno % Count of parameters
5659 \newtoks\macname % Macro name
5660 \newif\ifrecursive % Is it recursive?
5662 % List of all defined macros in the form
5663 % \definedummyword\macro1\definedummyword\macro2...
5664 % Currently is also contains all @aliases; the list can be split
5665 % if there is a need.
5668 % Add the macro to \macrolist
5669 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5670 \def\addtomacrolistxxx#1{%
5671 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5672 \xdef\macrolist{\the\toks0}%
5676 % This does \let #1 = #2, with \csnames; that is,
5677 % \let \csname#1\endcsname = \csname#2\endcsname
5678 % (except of course we have to play expansion games).
5682 \csname#1\expandafter\endcsname
5686 % Trim leading and trailing spaces off a string.
5687 % Concepts from aro-bend problem 15 (see CTAN).
5689 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5690 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5691 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5693 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5696 % Trim a single trailing ^^M off a string.
5697 {\catcode`\^^M=\other \catcode`\Q=3%
5698 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5699 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5700 \gdef\eatcrb#1Q#2Q{#1}%
5703 % Macro bodies are absorbed as an argument in a context where
5704 % all characters are catcode 10, 11 or 12, except \ which is active
5705 % (as in normal texinfo). It is necessary to change the definition of \.
5707 % It's necessary to have hard CRs when the macro is executed. This is
5708 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5709 % body, and then making it the \newlinechar in \scanmacro.
5726 \catcode`\^^M=\other
5729 \def\macrobodyctxt{%
5733 \catcode`\^^M=\other
5742 % \mbodybackslash is the definition of \ in @macro bodies.
5743 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5744 % where N is the macro parameter number.
5745 % We define \csname macarg.\endcsname to be \realbackslash, so
5746 % \\ in macro replacement text gets you a backslash.
5748 {\catcode`@=0 @catcode`@\=@active
5749 @gdef@usembodybackslash{@let\=@mbodybackslash}
5750 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5752 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5754 \def\macro{\recursivefalse\parsearg\macroxxx}
5755 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5758 \getargs{#1}% now \macname is the macname and \argl the arglist
5759 \ifx\argl\empty % no arguments
5762 \expandafter\parsemargdef \argl;%
5764 \if1\csname ismacro.\the\macname\endcsname
5765 \message{Warning: redefining \the\macname}%
5767 \expandafter\ifx\csname \the\macname\endcsname \relax
5768 \else \errmessage{Macro name \the\macname\space already defined}\fi
5769 \global\cslet{macsave.\the\macname}{\the\macname}%
5770 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5771 \addtomacrolist{\the\macname}%
5773 \begingroup \macrobodyctxt
5774 \ifrecursive \expandafter\parsermacbody
5775 \else \expandafter\parsemacbody
5778 \parseargdef\unmacro{%
5779 \if1\csname ismacro.#1\endcsname
5780 \global\cslet{#1}{macsave.#1}%
5781 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5782 % Remove the macro name from \macrolist:
5784 \expandafter\let\csname#1\endcsname \relax
5785 \let\definedummyword\unmacrodo
5786 \xdef\macrolist{\macrolist}%
5789 \errmessage{Macro #1 not defined}%
5793 % Called by \do from \dounmacro on each macro. The idea is to omit any
5794 % macro definitions that have been changed to \relax.
5800 \noexpand\definedummyword \noexpand#1%
5804 % This makes use of the obscure feature that if the last token of a
5805 % <parameter list> is #, then the preceding argument is delimited by
5806 % an opening brace, and that opening brace is not consumed.
5807 \def\getargs#1{\getargsxxx#1{}}
5808 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5809 \def\getmacname #1 #2\relax{\macname={#1}}
5810 \def\getmacargs#1{\def\argl{#1}}
5812 % Parse the optional {params} list. Set up \paramno and \paramlist
5813 % so \defmacro knows what to do. Define \macarg.blah for each blah
5814 % in the params list, to be ##N where N is the position in that list.
5815 % That gets used by \mbodybackslash (above).
5817 % We need to get `macro parameter char #' into several definitions.
5818 % The technique used is stolen from LaTeX: let \hash be something
5819 % unexpandable, insert that wherever you need a #, and then redefine
5820 % it to # just before using the token list produced.
5822 % The same technique is used to protect \eatspaces till just before
5823 % the macro is used.
5825 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5826 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5827 \def\parsemargdefxxx#1,{%
5828 \if#1;\let\next=\relax
5829 \else \let\next=\parsemargdefxxx
5830 \advance\paramno by 1%
5831 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5832 {\xeatspaces{\hash\the\paramno}}%
5833 \edef\paramlist{\paramlist\hash\the\paramno,}%
5836 % These two commands read recursive and nonrecursive macro bodies.
5837 % (They're different since rec and nonrec macros end differently.)
5839 \long\def\parsemacbody#1@end macro%
5840 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5841 \long\def\parsermacbody#1@end rmacro%
5842 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5844 % This defines the macro itself. There are six cases: recursive and
5845 % nonrecursive macros of zero, one, and many arguments.
5846 % Much magic with \expandafter here.
5847 % \xdef is used so that macro definitions will survive the file
5848 % they're defined in; @include reads the file inside a group.
5850 \let\hash=##% convert placeholders to macro parameter chars
5854 \expandafter\xdef\csname\the\macname\endcsname{%
5855 \noexpand\scanmacro{\temp}}%
5857 \expandafter\xdef\csname\the\macname\endcsname{%
5858 \bgroup\noexpand\macroargctxt
5859 \noexpand\braceorline
5860 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5861 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5862 \egroup\noexpand\scanmacro{\temp}}%
5864 \expandafter\xdef\csname\the\macname\endcsname{%
5865 \bgroup\noexpand\macroargctxt
5866 \noexpand\csname\the\macname xx\endcsname}%
5867 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5868 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5869 \expandafter\expandafter
5871 \expandafter\expandafter
5872 \csname\the\macname xxx\endcsname
5873 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5878 \expandafter\xdef\csname\the\macname\endcsname{%
5879 \noexpand\norecurse{\the\macname}%
5880 \noexpand\scanmacro{\temp}\egroup}%
5882 \expandafter\xdef\csname\the\macname\endcsname{%
5883 \bgroup\noexpand\macroargctxt
5884 \noexpand\braceorline
5885 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5886 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5888 \noexpand\norecurse{\the\macname}%
5889 \noexpand\scanmacro{\temp}\egroup}%
5891 \expandafter\xdef\csname\the\macname\endcsname{%
5892 \bgroup\noexpand\macroargctxt
5893 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5894 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5895 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5896 \expandafter\expandafter
5898 \expandafter\expandafter
5899 \csname\the\macname xxx\endcsname
5902 \noexpand\norecurse{\the\macname}%
5903 \noexpand\scanmacro{\temp}\egroup}%
5907 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5909 % \braceorline decides whether the next nonwhitespace character is a
5910 % {. If so it reads up to the closing }, if not, it reads the whole
5911 % line. Whatever was read is then fed to the next control sequence
5912 % as an argument (by \parsebrace or \parsearg)
5913 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5914 \def\braceorlinexxx{%
5915 \ifx\nchar\bgroup\else
5916 \expandafter\parsearg
5921 % We need some trickery to remove the optional spaces around the equal
5922 % sign. Just make them active and then expand them all to nothing.
5923 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5924 \def\aliasxxx #1{\aliasyyy#1\relax}
5925 \def\aliasyyy #1=#2\relax{%
5927 \expandafter\let\obeyedspace=\empty
5928 \addtomacrolist{#1}%
5929 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5935 \message{cross references,}
5939 \newif\ifhavexrefs % True if xref values are known.
5940 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5942 % @inforef is relatively simple.
5943 \def\inforef #1{\inforefzzz #1,,,,**}
5944 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5945 node \samp{\ignorespaces#1{}}}
5947 % @node's only job in TeX is to define \lastnode, which is used in
5948 % cross-references. The @node line might or might not have commas, and
5949 % might or might not have spaces before the first comma, like:
5950 % @node foo , bar , ...
5951 % We don't want such trailing spaces in the node name.
5953 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
5955 % also remove a trailing comma, in case of something like this:
5956 % @node Help-Cross, , , Cross-refs
5957 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
5958 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5961 \let\lastnode=\empty
5963 % Write a cross-reference definition for the current node. #1 is the
5964 % type (Ynumbered, Yappendix, Ynothing).
5967 \ifx\lastnode\empty\else
5968 \setref{\lastnode}{#1}%
5969 \global\let\lastnode=\empty
5973 % @anchor{NAME} -- define xref target at arbitrary point.
5975 \newcount\savesfregister
5977 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5978 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5979 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5981 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5982 % anchor), which consists of three parts:
5983 % 1) NAME-title - the current sectioning name taken from \thissection,
5984 % or the anchor name.
5985 % 2) NAME-snt - section number and type, passed as the SNT arg, or
5986 % empty for anchors.
5987 % 3) NAME-pg - the page number.
5989 % This is called from \donoderef, \anchor, and \dofloat. In the case of
5990 % floats, there is an additional part, which is not written here:
5991 % 4) NAME-lof - the text as it should appear in a @listoffloats.
5997 \atdummies % preserve commands, but don't expand them
5998 \edef\writexrdef##1##2{%
5999 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6000 ##1}{##2}}% these are parameters of \writexrdef
6002 \toks0 = \expandafter{\thissection}%
6003 \immediate \writexrdef{title}{\the\toks0 }%
6004 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6005 \writexrdef{pg}{\folio}% will be written later, during \shipout
6010 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6011 % the node name, #2 the name of the Info cross-reference, #3 the printed
6012 % node name, #4 the name of the Info file, #5 the name of the printed
6013 % manual. All but the node name can be omitted.
6015 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6016 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6017 \def\ref#1{\xrefX[#1,,,,,,,]}
6018 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6020 \def\printedmanual{\ignorespaces #5}%
6021 \def\printedrefname{\ignorespaces #3}%
6022 \setbox1=\hbox{\printedmanual\unskip}%
6023 \setbox0=\hbox{\printedrefname\unskip}%
6025 % No printed node name was explicitly given.
6026 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6027 % Use the node name inside the square brackets.
6028 \def\printedrefname{\ignorespaces #1}%
6030 % Use the actual chapter/section title appear inside
6031 % the square brackets. Use the real section title if we have it.
6033 % It is in another manual, so we don't have it.
6034 \def\printedrefname{\ignorespaces #1}%
6037 % We know the real title if we have the xref values.
6038 \def\printedrefname{\refx{#1-title}{}}%
6040 % Otherwise just copy the Info node name.
6041 \def\printedrefname{\ignorespaces #1}%
6047 % Make link in pdf output.
6052 % See comments at \activebackslashdouble.
6053 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6054 \backslashparens\pdfxrefdest}%
6056 \ifnum\filenamelength>0
6057 \startlink attr{/Border [0 0 0]}%
6058 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6060 \startlink attr{/Border [0 0 0]}%
6061 goto name{\pdfmkpgn{\pdfxrefdest}}%
6067 % Float references are printed completely differently: "Figure 1.2"
6068 % instead of "[somenode], p.3". We distinguish them by the
6069 % LABEL-title being set to a magic string.
6071 % Have to otherify everything special to allow the \csname to
6072 % include an _ in the xref name, etc.
6075 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6076 \csname XR#1-title\endcsname
6078 \iffloat\Xthisreftitle
6079 % If the user specified the print name (third arg) to the ref,
6080 % print it instead of our usual "Figure 1.2".
6087 % if the user also gave the printed manual name (fifth arg), append
6090 \space \putwordin{} \cite{\printedmanual}%
6093 % node/anchor (non-float) references.
6095 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6096 % insert empty discretionaries after hyphens, which means that it will
6097 % not find a line break at a hyphen in a node names. Since some manuals
6098 % are best written with fairly long node names, containing hyphens, this
6099 % is a loss. Therefore, we give the text of the node name again, so it
6100 % is as if TeX is seeing it for the first time.
6102 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6104 % _ (for example) has to be the character _ for the purposes of the
6105 % control sequence corresponding to the node, but it has to expand
6106 % into the usual \leavevmode...\vrule stuff for purposes of
6107 % printing. So we \turnoffactive for the \refx-snt, back on for the
6108 % printing, back off for the \refx-pg.
6110 % Only output a following space if the -snt ref is nonempty; for
6111 % @unnumbered and @anchor, it won't be.
6112 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6113 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6115 % output the `[mynode]' via a macro so it can be overridden.
6116 \xrefprintnodename\printedrefname
6118 % But we always want a comma and a space:
6121 % output the `page 3'.
6122 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6128 % This macro is called from \xrefX for the `[nodename]' part of xref
6129 % output. It's a separate macro only so it can be changed more easily,
6130 % since square brackets don't work well in some documents. Particularly
6131 % one that Bob is working on :).
6133 \def\xrefprintnodename#1{[#1]}
6135 % Things referred to by \setref.
6141 \putwordChapter@tie \the\chapno
6142 \else \ifnum\subsecno=0
6143 \putwordSection@tie \the\chapno.\the\secno
6144 \else \ifnum\subsubsecno=0
6145 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6147 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6152 \putwordAppendix@tie @char\the\appendixno{}%
6153 \else \ifnum\subsecno=0
6154 \putwordSection@tie @char\the\appendixno.\the\secno
6155 \else \ifnum\subsubsecno=0
6156 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6159 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6163 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6164 % If its value is nonempty, SUFFIX is output afterward.
6170 \expandafter\global\expandafter\let\expandafter\thisrefX
6171 \csname XR#1\endcsname
6174 % If not defined, say something at least.
6175 \angleleft un\-de\-fined\angleright
6178 \message{\linenumber Undefined cross reference `#1'.}%
6181 \global\warnedxrefstrue
6182 \message{Cross reference values unknown; you must run TeX again.}%
6187 % It's defined, so just use it.
6190 #2% Output the suffix in any case.
6193 % This is the macro invoked by entries in the aux file. Usually it's
6194 % just a \def (we prepend XR to the control sequence name to avoid
6195 % collisions). But if this is a float type, we have more work to do.
6198 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6200 % Was that xref control sequence that we just defined for a float?
6201 \expandafter\iffloat\csname XR#1\endcsname
6202 % it was a float, and we have the (safe) float type in \iffloattype.
6203 \expandafter\let\expandafter\floatlist
6204 \csname floatlist\iffloattype\endcsname
6206 % Is this the first time we've seen this float type?
6207 \expandafter\ifx\floatlist\relax
6208 \toks0 = {\do}% yes, so just \do
6210 % had it before, so preserve previous elements in list.
6211 \toks0 = \expandafter{\floatlist\do}%
6214 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6215 % for later use in \listoffloats.
6216 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6220 % Read the last existing aux file, if any. No error if none exists.
6223 \openin 1 \jobname.aux
6226 \global\havexrefstrue
6231 \def\setupdatafile{%
6232 \catcode`\^^@=\other
6233 \catcode`\^^A=\other
6234 \catcode`\^^B=\other
6235 \catcode`\^^C=\other
6236 \catcode`\^^D=\other
6237 \catcode`\^^E=\other
6238 \catcode`\^^F=\other
6239 \catcode`\^^G=\other
6240 \catcode`\^^H=\other
6241 \catcode`\^^K=\other
6242 \catcode`\^^L=\other
6243 \catcode`\^^N=\other
6244 \catcode`\^^P=\other
6245 \catcode`\^^Q=\other
6246 \catcode`\^^R=\other
6247 \catcode`\^^S=\other
6248 \catcode`\^^T=\other
6249 \catcode`\^^U=\other
6250 \catcode`\^^V=\other
6251 \catcode`\^^W=\other
6252 \catcode`\^^X=\other
6253 \catcode`\^^Z=\other
6254 \catcode`\^^[=\other
6255 \catcode`\^^\=\other
6256 \catcode`\^^]=\other
6257 \catcode`\^^^=\other
6258 \catcode`\^^_=\other
6259 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6260 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6261 % supported in the main text, it doesn't seem desirable. Furthermore,
6262 % that is not enough: for node names that actually contain a ^
6263 % character, we would end up writing a line like this: 'xrdef {'hat
6264 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6265 % argument, and \hat is not an expandable control sequence. It could
6266 % all be worked out, but why? Either we support ^^ or we don't.
6268 % The other change necessary for this was to define \auxhat:
6269 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6270 % and then to call \auxhat in \setq.
6274 % Special characters. Should be turned off anyway, but...
6287 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6289 % This is to support \ in node names and titles, since the \
6290 % characters end up in a \csname. It's easier than
6291 % leaving it active and making its active definition an actual \
6292 % character. What I don't understand is why it works in the *value*
6293 % of the xrdef. Seems like it should be a catcode12 \, and that
6294 % should not typeset properly. But it works, so I'm moving on for
6295 % now. --karl, 15jan04.
6298 % Make the characters 128-255 be printing characters.
6302 \catcode\count1=\other
6303 \advance\count1 by 1
6304 \ifnum \count1<256 \loop \fi
6308 % @ is our escape character in .aux files, and we need braces.
6314 \def\readdatafile#1{%
6320 \message{insertions,}
6321 % including footnotes.
6323 \newcount \footnoteno
6325 % The trailing space in the following definition for supereject is
6326 % vital for proper filling; pages come out unaligned when you do a
6327 % pagealignmacro call if that space before the closing brace is
6328 % removed. (Generally, numeric constants should always be followed by a
6329 % space to prevent strange expansion errors.)
6330 \def\supereject{\par\penalty -20000\footnoteno =0 }
6332 % @footnotestyle is meaningful for info output only.
6333 \let\footnotestyle=\comment
6337 % Auto-number footnotes. Otherwise like plain.
6339 \let\indent=\ptexindent
6340 \let\noindent=\ptexnoindent
6341 \global\advance\footnoteno by \@ne
6342 \edef\thisfootno{$^{\the\footnoteno}$}%
6344 % In case the footnote comes at the end of a sentence, preserve the
6345 % extra spacing after we do the footnote number.
6347 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6349 % Remove inadvertent blank space before typesetting the footnote number.
6355 % Don't bother with the trickery in plain.tex to not require the
6356 % footnote text as a parameter. Our footnotes don't need to be so general.
6358 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6359 % \parseargline) fails inside footnotes because the tokens are fixed when
6360 % the footnote is read. --karl, 16nov96.
6363 \insert\footins\bgroup
6364 % We want to typeset this text as a normal paragraph, even if the
6365 % footnote reference occurs in (for example) a display environment.
6366 % So reset some parameters.
6368 \interlinepenalty\interfootnotelinepenalty
6369 \splittopskip\ht\strutbox % top baseline for broken footnotes
6370 \splitmaxdepth\dp\strutbox
6371 \floatingpenalty\@MM
6376 \parindent\defaultparindent
6380 % Because we use hanging indentation in footnotes, a @noindent appears
6381 % to exdent this text, so make it be a no-op. makeinfo does not use
6382 % hanging indentation so @noindent can still be needed within footnote
6383 % text after an @example or the like (not that this is good style).
6384 \let\noindent = \relax
6386 % Hang the footnote text off the number. Use \everypar in case the
6387 % footnote extends for more than one paragraph.
6388 \everypar = {\hang}%
6389 \textindent{\thisfootno}%
6391 % Don't crash into the line above the footnote text. Since this
6392 % expands into a box, it must come within the paragraph, lest it
6393 % provide a place where TeX can split the footnote.
6395 \futurelet\next\fo@t
6397 }%end \catcode `\@=11
6399 % In case a @footnote appears in a vbox, save the footnote text and create
6400 % the real \insert just after the vbox finished. Otherwise, the insertion
6402 % Similarily, if a @footnote appears inside an alignment, save the footnote
6403 % text to a box and make the \insert when a row of the table is finished.
6404 % And the same can be done for other insert classes. --kasal, 16nov03.
6406 % Replace the \insert primitive by a cheating macro.
6407 % Deeper inside, just make sure that the saved insertions are not spilled
6410 \def\startsavinginserts{%
6411 \ifx \insert\ptexinsert
6412 \let\insert\saveinsert
6414 \let\checkinserts\relax
6418 % This \insert replacement works for both \insert\footins{foo} and
6419 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6422 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6423 \afterassignment\next
6424 % swallow the left brace
6427 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6428 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6430 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6432 \def\placesaveins#1{%
6433 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6437 % eat @SAVE -- beware, all of them have catcode \other:
6439 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6440 \gdef\gobblesave @SAVE{}
6444 \def\newsaveins #1{%
6445 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6448 \def\newsaveinsX #1{%
6449 \csname newbox\endcsname #1%
6450 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6455 \let\checkinserts\empty
6460 % @image. We use the macros from epsf.tex to support this.
6461 % If epsf.tex is not installed and @image is used, we complain.
6463 % Check for and read epsf.tex up front. If we read it only at @image
6464 % time, we might be inside a group, and then its definitions would get
6465 % undone and the next image would fail.
6466 \openin 1 = epsf.tex
6468 % Do not bother showing banner with epsf.tex v2.7k (available in
6469 % doc/epsf.tex and on ctan).
6470 \def\epsfannounce{\toks0 = }%
6475 % We will only complain once about lack of epsf.tex.
6476 \newif\ifwarnednoepsf
6477 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6478 work. It is also included in the Texinfo distribution, or you can get
6479 it from ftp://tug.org/tex/epsf.tex.}
6482 \ifx\epsfbox\undefined
6483 \ifwarnednoepsf \else
6484 \errhelp = \noepsfhelp
6485 \errmessage{epsf.tex not found, images will be ignored}%
6486 \global\warnednoepsftrue
6489 \imagexxx #1,,,,,\finish
6493 % Arguments to @image:
6494 % #1 is (mandatory) image filename; we tack on .eps extension.
6495 % #2 is (optional) width, #3 is (optional) height.
6496 % #4 is (ignored optional) html alt text.
6497 % #5 is (ignored optional) extension.
6498 % #6 is just the usual extra ignored arg for parsing this stuff.
6500 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6501 \catcode`\^^M = 5 % in case we're inside an example
6502 \normalturnoffactive % allow _ et al. in names
6503 % If the image is by itself, center it.
6507 % Usually we'll have text after the image which will insert
6508 % \parskip glue, so insert it here too to equalize the space
6510 \nobreak\vskip\parskip
6517 \dopdfimage{#1}{#2}{#3}%
6519 % \epsfbox itself resets \epsf?size at each figure.
6520 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6521 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6525 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6529 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6530 % etc. We don't actually implement floating yet, we always include the
6531 % float "here". But it seemed the best name for the future.
6533 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6535 % There may be a space before second and/or third parameter; delete it.
6536 \def\eatcommaspace#1, {#1,}
6538 % #1 is the optional FLOATTYPE, the text label for this float, typically
6539 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6540 % this float will not be numbered and cannot be referred to.
6542 % #2 is the optional xref label. Also must be present for the float to
6545 % #3 is the optional positioning argument; for now, it is ignored. It
6546 % will somehow specify the positions allowed to float to (here, top, bottom).
6548 % We keep a separate counter for each FLOATTYPE, which we reset at each
6549 % chapter-level command.
6550 \let\resetallfloatnos=\empty
6552 \def\dofloat#1,#2,#3,#4\finish{%
6553 \let\thiscaption=\empty
6554 \let\thisshortcaption=\empty
6556 % don't lose footnotes inside @float.
6558 % BEWARE: when the floats start float, we have to issue warning whenever an
6559 % insert appears inside a float which could possibly float. --kasal, 26may04
6563 % We can't be used inside a paragraph.
6568 \def\floatlabel{#2}%
6569 \def\floatloc{#3}% we do nothing with this yet.
6571 \ifx\floattype\empty
6572 \let\safefloattype=\empty
6575 % the floattype might have accents or other special characters,
6576 % but we need to use it in a control sequence name.
6579 \xdef\safefloattype{\floattype}%
6583 % If label is given but no type, we handle that as the empty type.
6584 \ifx\floatlabel\empty \else
6585 % We want each FLOATTYPE to be numbered separately (Figure 1,
6586 % Table 1, Figure 2, ...). (And if no label, no number.)
6588 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6589 \global\advance\floatno by 1
6592 % This magic value for \thissection is output by \setref as the
6593 % XREFLABEL-title value. \xrefX uses it to distinguish float
6594 % labels (which have a completely different output format) from
6595 % node and anchor labels. And \xrdef uses it to construct the
6598 \edef\thissection{\floatmagic=\safefloattype}%
6599 \setref{\floatlabel}{Yfloat}%
6603 % start with \parskip glue, I guess.
6606 % Don't suppress indentation if a float happens to start a section.
6607 \restorefirstparagraphindent
6610 % we have these possibilities:
6611 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6612 % @float Foo,lbl & no caption: Foo 1.1
6613 % @float Foo & @caption{Cap}: Foo: Cap
6614 % @float Foo & no caption: Foo
6615 % @float ,lbl & Caption{Cap}: 1.1: Cap
6616 % @float ,lbl & no caption: 1.1
6617 % @float & @caption{Cap}: Cap
6618 % @float & no caption:
6621 \let\floatident = \empty
6623 % In all cases, if we have a float type, it comes first.
6624 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6626 % If we have an xref label, the number comes next.
6627 \ifx\floatlabel\empty \else
6628 \ifx\floattype\empty \else % if also had float type, need tie first.
6629 \appendtomacro\floatident{\tie}%
6632 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6635 % Start the printed caption with what we've constructed in
6636 % \floatident, but keep it separate; we need \floatident again.
6637 \let\captionline = \floatident
6639 \ifx\thiscaption\empty \else
6640 \ifx\floatident\empty \else
6641 \appendtomacro\captionline{: }% had ident, so need a colon between
6645 \appendtomacro\captionline{\scanexp\thiscaption}%
6648 % If we have anything to print, print it, with space before.
6649 % Eventually this needs to become an \insert.
6650 \ifx\captionline\empty \else
6654 % Space below caption.
6658 % If have an xref label, write the list of floats info. Do this
6659 % after the caption, to avoid chance of it being a breakpoint.
6660 \ifx\floatlabel\empty \else
6661 % Write the text that goes in the lof to the aux file as
6662 % \floatlabel-lof. Besides \floatident, we include the short
6663 % caption if specified, else the full caption if specified, else nothing.
6667 % since we read the caption text in the macro world, where ^^M
6668 % is turned into a normal character, we have to scan it back, so
6669 % we don't write the literal three characters "^^M" into the aux file.
6671 \xdef\noexpand\gtemp{%
6672 \ifx\thisshortcaption\empty
6679 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6680 \ifx\gtemp\empty \else : \gtemp \fi}}%
6683 \egroup % end of \vtop
6685 % place the captured inserts
6687 % BEWARE: when the floats start floating, we have to issue warning
6688 % whenever an insert appears inside a float which could possibly
6689 % float. --kasal, 26may04
6694 % Append the tokens #2 to the definition of macro #1, not expanding either.
6696 \def\appendtomacro#1#2{%
6697 \expandafter\def\expandafter#1\expandafter{#1#2}%
6700 % @caption, @shortcaption
6702 \def\caption{\docaption\thiscaption}
6703 \def\shortcaption{\docaption\thisshortcaption}
6704 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6705 \def\defcaption#1#2{\egroup \def#1{#2}}
6707 % The parameter is the control sequence identifying the counter we are
6708 % going to use. Create it if it doesn't exist and assign it to \floatno.
6711 % Haven't seen this figure type before.
6712 \csname newcount\endcsname #1%
6714 % Remember to reset this floatno at the next chap.
6715 \expandafter\gdef\expandafter\resetallfloatnos
6716 \expandafter{\resetallfloatnos #1=0 }%
6721 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6722 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6723 % first read the @float command.
6725 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6727 % Magic string used for the XREFLABEL-title value, so \xrefX can
6728 % distinguish floats from other xref types.
6729 \def\floatmagic{!!float!!}
6731 % #1 is the control sequence we are passed; we expand into a conditional
6732 % which is true if #1 represents a float ref. That is, the magic
6733 % \thissection value which we \setref above.
6735 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6737 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6738 % (safe) float type for this float. We set \iffloattype to #2.
6740 \def\doiffloat#1=#2=#3\finish{%
6742 \def\iffloattype{#2}%
6743 \ifx\temp\floatmagic
6746 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6748 \parseargdef\listoffloats{%
6749 \def\floattype{#1}% floattype
6751 % the floattype might have accents or other special characters,
6752 % but we need to use it in a control sequence name.
6755 \xdef\safefloattype{\floattype}%
6758 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6759 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6761 % if the user said @listoffloats foo but never @float foo.
6762 \message{\linenumber No `\safefloattype' floats to list.}%
6766 \leftskip=\tocindent % indent these entries like a toc
6767 \let\do=\listoffloatsdo
6768 \csname floatlist\safefloattype\endcsname
6773 % This is called on each entry in a list of floats. We're passed the
6774 % xref label, in the form LABEL-title, which is how we save it in the
6775 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6776 % has the text we're supposed to typeset here.
6778 % Figures without xref labels will not be included in the list (since
6779 % they won't appear in the aux file).
6781 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6782 \def\listoffloatsdoentry#1-title\finish{{%
6783 % Can't fully expand XR#1-lof because it can contain anything. Just
6784 % pass the control sequence. On the other hand, XR#1-pg is just the
6785 % page number, and we want to fully expand that so we can get a link
6787 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6789 % use the same \entry macro we use to generate the TOC and index.
6790 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6794 \message{localization,}
6797 % @documentlanguage is usually given very early, just after
6798 % @setfilename. If done too late, it may not override everything
6799 % properly. Single argument is the language abbreviation.
6800 % It would be nice if we could set up a hyphenation file here.
6802 \parseargdef\documentlanguage{%
6803 \tex % read txi-??.tex file in plain TeX.
6804 % Read the file if it exists.
6805 \openin 1 txi-#1.tex
6807 \errhelp = \nolanghelp
6808 \errmessage{Cannot read language file txi-#1.tex}%
6815 \newhelp\nolanghelp{The given language definition file cannot be found or
6816 is empty. Maybe you need to install it? In the current directory
6817 should work if nowhere else does.}
6820 % @documentencoding should change something in TeX eventually, most
6821 % likely, but for now just recognize it.
6822 \let\documentencoding = \comment
6825 % Page size parameters.
6827 \newdimen\defaultparindent \defaultparindent = 15pt
6829 \chapheadingskip = 15pt plus 4pt minus 2pt
6830 \secheadingskip = 12pt plus 3pt minus 2pt
6831 \subsecheadingskip = 9pt plus 2pt minus 2pt
6833 % Prevent underfull vbox error messages.
6836 % Don't be so finicky about underfull hboxes, either.
6839 % Following George Bush, just get rid of widows and orphans.
6843 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6844 % using an old version of TeX, don't do anything. We want the amount of
6845 % stretch added to depend on the line length, hence the dependence on
6846 % \hsize. We call this whenever the paper size is set.
6848 \def\setemergencystretch{%
6849 \ifx\emergencystretch\thisisundefined
6850 % Allow us to assign to \emergencystretch anyway.
6851 \def\emergencystretch{\dimen0}%
6853 \emergencystretch = .15\hsize
6857 % Parameters in order: 1) textheight; 2) textwidth;
6858 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
6859 % 7) physical page height; 8) physical page width.
6861 % We also call \setleading{\textleading}, so the caller should define
6862 % \textleading. The caller should also set \parskip.
6864 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6867 \splittopskip = \topskip
6870 \advance\vsize by \topskip
6871 \outervsize = \vsize
6872 \advance\outervsize by 2\topandbottommargin
6873 \pageheight = \vsize
6876 \outerhsize = \hsize
6877 \advance\outerhsize by 0.5in
6880 \normaloffset = #4\relax
6881 \bindingoffset = #5\relax
6884 \pdfpageheight #7\relax
6885 \pdfpagewidth #8\relax
6888 \setleading{\textleading}
6890 \parindent = \defaultparindent
6891 \setemergencystretch
6894 % @letterpaper (the default).
6895 \def\letterpaper{{\globaldefs = 1
6896 \parskip = 3pt plus 2pt minus 1pt
6897 \textleading = 13.2pt
6899 % If page is nothing but text, make it come out even.
6900 \internalpagesizes{46\baselineskip}{6in}%
6902 {\bindingoffset}{36pt}%
6906 % Use @smallbook to reset parameters for 7x9.25 trim size.
6907 \def\smallbook{{\globaldefs = 1
6908 \parskip = 2pt plus 1pt
6911 \internalpagesizes{7.5in}{5in}%
6913 {\bindingoffset}{16pt}%
6916 \lispnarrowing = 0.3in
6919 \contentsrightmargin = 0pt
6920 \defbodyindent = .5cm
6923 % Use @smallerbook to reset parameters for 6x9 trim size.
6924 % (Just testing, parameters still in flux.)
6925 \def\smallerbook{{\globaldefs = 1
6926 \parskip = 1.5pt plus 1pt
6929 \internalpagesizes{7.4in}{4.8in}%
6934 \lispnarrowing = 0.25in
6937 \contentsrightmargin = 0pt
6938 \defbodyindent = .4cm
6941 % Use @afourpaper to print on European A4 paper.
6942 \def\afourpaper{{\globaldefs = 1
6943 \parskip = 3pt plus 2pt minus 1pt
6944 \textleading = 13.2pt
6946 % Double-side printing via postscript on Laserjet 4050
6947 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6948 % To change the settings for a different printer or situation, adjust
6949 % \normaloffset until the front-side and back-side texts align. Then
6950 % do the same for \bindingoffset. You can set these for testing in
6951 % your texinfo source file like this:
6953 % \global\normaloffset = -6mm
6954 % \global\bindingoffset = 10mm
6956 \internalpagesizes{51\baselineskip}{160mm}
6957 {\voffset}{\hoffset}%
6958 {\bindingoffset}{44pt}%
6963 \contentsrightmargin = 0pt
6964 \defbodyindent = 5mm
6967 % Use @afivepaper to print on European A5 paper.
6968 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6969 % He also recommends making @example and @lisp be small.
6970 \def\afivepaper{{\globaldefs = 1
6971 \parskip = 2pt plus 1pt minus 0.1pt
6972 \textleading = 12.5pt
6974 \internalpagesizes{160mm}{120mm}%
6975 {\voffset}{\hoffset}%
6976 {\bindingoffset}{8pt}%
6979 \lispnarrowing = 0.2in
6982 \contentsrightmargin = 0pt
6983 \defbodyindent = 2mm
6987 % A specific text layout, 24x15cm overall, intended for A4 paper.
6988 \def\afourlatex{{\globaldefs = 1
6990 \internalpagesizes{237mm}{150mm}%
6992 {\bindingoffset}{7mm}%
6995 % Must explicitly reset to 0 because we call \afourpaper.
6999 % Use @afourwide to print on A4 paper in landscape format.
7000 \def\afourwide{{\globaldefs = 1
7002 \internalpagesizes{241mm}{165mm}%
7003 {\voffset}{-2.95mm}%
7004 {\bindingoffset}{7mm}%
7009 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7010 % Perhaps we should allow setting the margins, \topskip, \parskip,
7011 % and/or leading, also. Or perhaps we should compute them somehow.
7013 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7014 \def\pagesizesyyy#1,#2,#3\finish{{%
7015 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7018 \parskip = 3pt plus 2pt minus 1pt
7019 \setleading{\textleading}%
7022 \advance\dimen0 by \voffset
7025 \advance\dimen2 by \normaloffset
7027 \internalpagesizes{#1}{\hsize}%
7028 {\voffset}{\normaloffset}%
7029 {\bindingoffset}{44pt}%
7033 % Set default to letter.
7038 \message{and turning on texinfo input format.}
7040 % Define macros to output various characters with catcode for normal text.
7050 \def\normaldoublequote{"}
7053 \def\normalunderscore{_}
7054 \def\normalverticalbar{|}
7056 \def\normalgreater{>}
7058 \def\normaldollar{$}%$ font-lock fix
7060 % This macro is used to make a character print one way in \tt
7061 % (where it can probably be output as-is), and another way in other fonts,
7062 % where something hairier probably needs to be done.
7064 % #1 is what to print if we are indeed using \tt; #2 is what to print
7065 % otherwise. Since all the Computer Modern typewriter fonts have zero
7066 % interword stretch (and shrink), and it is reasonable to expect all
7067 % typewriter fonts to have this, we can check that font parameter.
7069 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7071 % Same as above, but check for italic font. Actually this also catches
7072 % non-italic slanted fonts since it is impossible to distinguish them from
7073 % italic fonts. But since this is only used by $ and it uses \sl anyway
7074 % this is not a problem.
7075 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7077 % Turn off all special characters except @
7078 % (and those which the user can use as if they were ordinary).
7079 % Most of these we simply print from the \tt font, but for some, we can
7080 % use math or other variants that look better in normal text.
7083 \def\activedoublequote{{\tt\char34}}
7084 \let"=\activedoublequote
7086 \def~{{\tt\char126}}
7092 \def_{\ifusingtt\normalunderscore\_}
7094 % Subroutine for the previous macro.
7095 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7098 \def|{{\tt\char124}}
7106 \def+{{\tt \char 43}}
7108 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7110 % If a .fmt file is being used, characters that might appear in a file
7111 % name cannot be active until we have parsed the command line.
7112 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7113 % \otherifyactive is called near the end of this file.
7114 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7116 % Same as @turnoffactive below, but backslash retains its normal definition.
7117 % (Before 2005-08-15, this macro explicitly assigned @let\=@normalbackslash,
7118 % but it doesn't seem to be necessary. --kasal)
7119 \def\normalturnoffactive{%
7120 \let"=\normaldoublequote
7123 \let_=\normalunderscore
7124 \let|=\normalverticalbar
7126 \let>=\normalgreater
7128 \let$=\normaldollar %$ font-lock fix
7132 % Used sometimes to turn off (effectively) the active characters even after
7134 \def\turnoffactive{%
7135 \normalturnoffactive
7141 % \backslashcurfont outputs one backslash character in current font,
7143 \global\chardef\backslashcurfont=`\\
7144 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7146 % \realbackslash is an actual character `\' with catcode other, and
7147 % \doublebackslash is two of them (for the pdf outlines).
7148 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7150 % In texinfo, backslash is an active character; it prints the backslash
7151 % in fixed width font.
7153 @def@normalbackslash{{@tt@backslashcurfont}}
7154 % On startup, @fixbackslash assigns:
7155 % @let \ = @normalbackslash
7157 % \rawbackslash defines an active \ to do \backslashcurfont.
7158 % \otherbackslash defines an active \ to be a literal `\' character with
7160 @gdef@rawbackslash{@let\=@backslashcurfont}
7161 @gdef@otherbackslash{@let\=@realbackslash}
7163 % Make _ and + \other characters, temporarily.
7164 % This is canceled by @fixbackslash.
7167 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7168 % That is what \eatinput is for; after that, the `\' should revert to printing
7171 @gdef@eatinput input texinfo{@fixbackslash}
7172 @global@let\ = @eatinput
7174 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7175 % the first `\' in the file would cause an error. This macro tries to fix
7176 % that, assuming it is called before the first `\' could plausibly occur.
7177 % Also turn back on active characters that might appear in the input
7178 % file name, in case not using a pre-dumped format.
7180 @gdef@fixbackslash{%
7181 @ifx\@eatinput @let\ = @normalbackslash @fi
7186 % Say @foo, not \foo, in error messages.
7189 % These look ok in all fonts, so just make them not special.
7190 @catcode`@& = @other
7191 @catcode`@# = @other
7192 @catcode`@% = @other
7196 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7197 @c page-delimiter: "^\\\\message"
7198 @c time-stamp-start: "def\\\\texinfoversion{"
7199 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7200 @c time-stamp-end: "}"
7206 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115