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{2007-07-01.15}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 2007,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 3 of the
15 % License, or (at 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 program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
75 % Save some plain tex macros whose names we will redefine.
77 \let\ptexbullet=\bullet
85 \let\ptexfootnote=\footnote
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
101 % If this character appears in an error message or help string, it
102 % starts a new line in the output.
105 % Use TeX 3.0's \inputlineno to get the line number, for better error
106 % messages, but if we're using an old version of TeX, don't do anything.
108 \ifx\inputlineno\thisisundefined
109 \let\linenumber = \empty % Pre-3.0.
111 \def\linenumber{l.\the\inputlineno:\space}
114 % Set up fixed words for English if not already set.
115 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
116 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
117 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
118 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
119 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
120 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
121 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
122 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
123 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
124 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
125 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
126 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
127 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
128 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
129 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
130 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
131 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
132 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
133 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
135 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
136 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
137 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
138 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
139 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
140 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
141 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
142 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
143 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
144 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
145 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
146 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
148 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
149 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
150 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
151 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
152 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
154 % Since the category of space is not known, we have to be careful.
155 \chardef\spacecat = 10
156 \def\spaceisspace{\catcode`\ =\spacecat}
158 % sometimes characters are active, so we need control sequences.
159 \chardef\colonChar = `\:
160 \chardef\commaChar = `\,
161 \chardef\dashChar = `\-
162 \chardef\dotChar = `\.
163 \chardef\exclamChar= `\!
164 \chardef\lquoteChar= `\`
165 \chardef\questChar = `\?
166 \chardef\rquoteChar= `\'
167 \chardef\semiChar = `\;
168 \chardef\underChar = `\_
174 % The following is used inside several \edef's.
175 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
179 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
180 ap-pen-dix bit-map bit-maps
181 data-base data-bases eshell fall-ing half-way long-est man-u-script
182 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
183 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
185 stand-alone strong-est time-stamp time-stamps which-ever white-space
186 wide-spread wrap-around
189 % Margin to add to right of even pages, to left of odd pages.
190 \newdimen\bindingoffset
191 \newdimen\normaloffset
192 \newdimen\pagewidth \newdimen\pageheight
194 % For a final copy, take out the rectangles
195 % that mark overfull boxes (in case you have decided
196 % that the text looks ok even though it passes the margin).
198 \def\finalout{\overfullrule=0pt}
200 % @| inserts a changebar to the left of the current line. It should
201 % surround any changed text. This approach does *not* work if the
202 % change spans more than two lines of output. To handle that, we would
203 % have adopt a much more difficult approach (putting marks into the main
204 % vertical list for the beginning and end of each change).
207 % \vadjust can only be used in horizontal mode.
210 % Append this vertical mode material after the current line in the output.
212 % We want to insert a rule with the height and depth of the current
213 % leading; that is exactly what \strutbox is supposed to record.
216 % \vadjust-items are inserted at the left edge of the type. So
217 % the \llap here moves out into the left-hand margin.
220 % For a thicker or thinner bar, change the `1pt'.
221 \vrule height\baselineskip width1pt
223 % This is the space between the bar and the text.
229 % Sometimes it is convenient to have everything in the transcript file
230 % and nothing on the terminal. We don't just call \tracingall here,
231 % since that produces some useless output on the terminal. We also make
232 % some effort to order the tracing commands to reduce output in the log
233 % file; cf. trace.sty in LaTeX.
235 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
239 \tracinglostchars2 % 2 gives us more in etex
244 \showboxbreadth\maxdimen \showboxdepth\maxdimen
245 \ifx\eTeXversion\undefined\else % etex gives us more logging
252 \tracingcommands3 % 3 gives us more in etex
256 % add check for \lastpenalty to plain's definitions. If the last thing
257 % we did was a \nobreak, we don't want to insert more space.
259 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
260 \removelastskip\penalty-50\smallskip\fi\fi}
261 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
262 \removelastskip\penalty-100\medskip\fi\fi}
263 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
264 \removelastskip\penalty-200\bigskip\fi\fi}
266 % For @cropmarks command.
267 % Do @cropmarks to get crop marks.
270 \let\cropmarks = \cropmarkstrue
272 % Dimensions to add cropmarks at corners.
273 % Added by P. A. MacKay, 12 Nov. 1986
275 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
276 \newdimen\cornerlong \cornerlong=1pc
277 \newdimen\cornerthick \cornerthick=.3pt
278 \newdimen\topandbottommargin \topandbottommargin=.75in
280 % Main output routine.
282 \output = {\onepageout{\pagecontents\PAGE}}
287 % \onepageout takes a vbox as an argument. Note that \pagecontents
288 % does insertions, but you have to call it yourself.
290 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
292 \ifodd\pageno \advance\hoffset by \bindingoffset
293 \else \advance\hoffset by -\bindingoffset\fi
295 % Do this outside of the \shipout so @code etc. will be expanded in
296 % the headline as they should be, not taken literally (outputting ''code).
297 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
298 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
301 % Have to do this stuff outside the \shipout because we want it to
302 % take effect in \write's, yet the group defined by the \vbox ends
303 % before the \shipout runs.
305 \indexdummies % don't expand commands in the output.
306 \normalturnoffactive % \ in index entries must not stay \, e.g., if
307 % the page break happens to be in the middle of an example.
308 % We don't want .vr (or whatever) entries like this:
309 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
310 % "\acronym" won't work when it's read back in;
312 % {\code {{\tt \backslashcurfont }acronym}
314 % Do this early so pdf references go to the beginning of the page.
315 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
317 \ifcropmarks \vbox to \outervsize\bgroup
319 \vskip-\topandbottommargin
321 \line{\ewtop\hfil\ewtop}%
324 \vbox{\moveleft\cornerthick\nstop}%
326 \vbox{\moveright\cornerthick\nstop}%
329 \vskip\topandbottommargin
331 \hfil % center the page within the outer (page) hsize.
332 \ifodd\pageno\hskip\bindingoffset\fi
338 \ifdim\ht\footlinebox > 0pt
339 % Only leave this space if the footline is nonempty.
340 % (We lessened \vsize for it in \oddfootingyyy.)
341 % The \baselineskip=24pt in plain's \makefootline has no effect.
347 \egroup % end of \vbox\bgroup
348 \hfil\egroup % end of (centering) \line\bgroup
349 \vskip\topandbottommargin plus1fill minus1fill
350 \boxmaxdepth = \cornerthick
353 \vbox{\moveleft\cornerthick\nsbot}%
355 \vbox{\moveright\cornerthick\nsbot}%
358 \line{\ewbot\hfil\ewbot}%
360 \egroup % \vbox from first cropmarks clause
362 }% end of \shipout\vbox
363 }% end of group with \indexdummies
365 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
368 \newinsert\margin \dimen\margin=\maxdimen
370 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
372 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
373 % marginal hacks, juha@viisa.uucp (Juha Takala)
374 \ifvoid\margin\else % marginal info is present
375 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
376 \dimen@=\dp#1 \unvbox#1
377 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
378 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
381 % Here are the rules for the cropmarks. Note that they are
382 % offset so that the space between them is truly \outerhsize or \outervsize
383 % (P. A. MacKay, 12 November, 1986)
385 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
387 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
388 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
390 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
392 % Parse an argument, then pass it to #1. The argument is the rest of
393 % the input line (except we remove a trailing comment). #1 should be a
394 % macro which expects an ordinary undelimited TeX argument.
396 \def\parsearg{\parseargusing{}}
397 \def\parseargusing#1#2{%
403 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
407 \gdef\parseargline#1^^M{%
408 \endgroup % End of the group started in \parsearg.
409 \argremovecomment #1\comment\ArgTerm%
413 % First remove any @comment, then any @c comment.
414 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
415 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
417 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
419 % \argremovec might leave us with trailing space, e.g.,
420 % @end itemize @c foo
421 % This space token undergoes the same procedure and is eventually removed
422 % by \finishparsearg.
424 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
425 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
426 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
429 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
430 \let\temp\finishparsearg
432 \let\temp\argcheckspaces
434 % Put the space token in:
438 % If a _delimited_ argument is enclosed in braces, they get stripped; so
439 % to get _exactly_ the rest of the line, we had to prevent such situation.
440 % We prepended an \empty token at the very beginning and we expand it now,
441 % just before passing the control to \argtorun.
442 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
443 % either the null string, or it ends with \^^M---thus there is no danger
444 % that a pair of braces would be stripped.
446 % But first, we have to remove the trailing space token.
448 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
450 % \parseargdef\foo{...}
451 % is roughly equivalent to
452 % \def\foo{\parsearg\Xfoo}
455 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
456 % favourite TeX trick. --kasal, 16nov03
459 \expandafter \doparseargdef \csname\string#1\endcsname #1%
461 \def\doparseargdef#1#2{%
466 % Several utility definitions with active space:
471 % Make each space character in the input produce a normal interword
472 % space in the output. Don't allow a line break at this space, as this
473 % is used only in environments like @example, where each line of input
474 % should produce a line of output anyway.
476 \gdef\sepspaces{\obeyspaces\let =\tie}
478 % If an index command is used in an @example environment, any spaces
479 % therein should become regular spaces in the raw index file, not the
480 % expansion of \tie (\leavevmode \penalty \@M \ ).
481 \gdef\unsepspaces{\let =\space}
485 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
487 % Define the framework for environments in texinfo.tex. It's used like this:
492 % It's the responsibility of \envdef to insert \begingroup before the
493 % actual body; @end closes the group after calling \Efoo. \envdef also
494 % defines \thisenv, so the current environment is known; @end checks
495 % whether the environment name matches. The \checkenv macro can also be
496 % used to check whether the current environment is the one expected.
498 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
499 % are not treated as enviroments; they don't open a group. (The
500 % implementation of @end takes care not to call \endgroup in this
504 % At runtime, environments start with this:
505 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
509 % ... but they get defined via ``\envdef\foo{...}'':
510 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
511 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
513 % Check whether we're in the right environment:
522 % Evironment mismatch, #1 expected:
525 \errmessage{This command can appear only \inenvironment\temp,
526 not \inenvironment\thisenv}%
528 \def\inenvironment#1{%
530 out of any environment%
532 in environment \expandafter\string#1%
536 % @end foo executes the definition of \Efoo.
537 % But first, it executes a specialized version of \checkenv
540 \if 1\csname iscond.#1\endcsname
542 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
543 \expandafter\checkenv\csname#1\endcsname
544 \csname E#1\endcsname
549 \newhelp\EMsimple{Press RETURN to continue.}
552 %% Simple single-character @ commands
555 % Kludge this until the fonts are right (grr).
558 % This is turned off because it was never documented
559 % and you can use @w{...} around a quote to suppress ligatures.
560 %% Define @` and @' to be the same as ` and '
561 %% but suppressing ligatures.
565 % Used to generate quoted braces.
566 \def\mylbrace {{\tt\char123}}
567 \def\myrbrace {{\tt\char125}}
571 % Definitions to produce \{ and \} commands for indices,
572 % and @{ and @} for the aux/toc files.
573 \catcode`\{ = \other \catcode`\} = \other
574 \catcode`\[ = 1 \catcode`\] = 2
575 \catcode`\! = 0 \catcode`\\ = \other
578 !gdef!lbraceatcmd[@{]%
579 !gdef!rbraceatcmd[@}]%
582 % @comma{} to avoid , parsing problems.
585 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
586 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
589 \def\ringaccent#1{{\accent23 #1}}
594 % Other special characters: @questiondown @exclamdown @ordf @ordm
595 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
596 \def\questiondown{?`}
598 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
599 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
601 % Dotless i and dotless j, used for accents.
606 \ifx\temp\imacro \ptexi
607 \else\ifx\temp\jmacro \j
608 \else \errmessage{@dotless can be used only with i or j}%
612 % The \TeX{} logo, as in plain, but resetting the spacing so that a
613 % period following counts as ending a sentence. (Idea found in latex.)
615 \edef\TeX{\TeX \spacefactor=1000 }
617 % @LaTeX{} logo. Not quite the same results as the definition in
618 % latex.ltx, since we use a different font for the raised A; it's most
619 % convenient for us to use an explicitly smaller font, rather than using
620 % the \scriptstyle font (since we don't reset \scriptstyle and
621 % \scriptscriptstyle).
626 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
631 % Be sure we're in horizontal mode when doing a tie, since we make space
632 % equivalent to this in @example-like environments. Otherwise, a space
633 % at the beginning of a line will start with \penalty -- and
634 % since \penalty is valid in vertical mode, we'd end up putting the
635 % penalty on the vertical list instead of in the new paragraph.
637 % Avoid using \@M directly, because that causes trouble
638 % if the definition is written into an index file.
639 \global\let\tiepenalty = \@M
640 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
643 % @: forces normal size whitespace following.
644 \def\:{\spacefactor=1000 }
646 % @* forces a line break.
647 \def\*{\hfil\break\hbox{}\ignorespaces}
649 % @/ allows a line break.
652 % @. is an end-of-sentence period.
653 \def\.{.\spacefactor=\endofsentencespacefactor\space}
655 % @! is an end-of-sentence bang.
656 \def\!{!\spacefactor=\endofsentencespacefactor\space}
658 % @? is an end-of-sentence query.
659 \def\?{?\spacefactor=\endofsentencespacefactor\space}
661 % @frenchspacing on|off says whether to put extra space after punctuation.
666 \parseargdef\frenchspacing{%
668 \ifx\temp\onword \plainfrenchspacing
669 \else\ifx\temp\offword \plainnonfrenchspacing
672 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
676 % @w prevents a word break. Without the \leavevmode, @w at the
677 % beginning of a paragraph, when TeX is still in vertical mode, would
678 % produce a whole line of output instead of starting the paragraph.
679 \def\w#1{\leavevmode\hbox{#1}}
681 % @group ... @end group forces ... to be all on one page, by enclosing
682 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
683 % to keep its height that of a normal line. According to the rules for
684 % \topskip (p.114 of the TeXbook), the glue inserted is
685 % max (\topskip - \ht (first item), 0). If that height is large,
686 % therefore, no glue is inserted, and the space between the headline and
687 % the text is small, which looks bad.
689 % Another complication is that the group might be very large. This can
690 % cause the glue on the previous page to be unduly stretched, because it
691 % does not have much material. In this case, it's better to add an
692 % explicit \vfill so that the extra space is at the bottom. The
693 % threshold for doing this is if the group is more than \vfilllimit
694 % percent of a page (\vfilllimit can be changed inside of @tex).
700 \ifnum\catcode`\^^M=\active \else
701 \errhelp = \groupinvalidhelp
702 \errmessage{@group invalid in context where filling is enabled}%
706 \setbox\groupbox = \vtop\bgroup
707 % Do @comment since we are called inside an environment such as
708 % @example, where each end-of-line in the input causes an
709 % end-of-line in the output. We don't want the end-of-line after
710 % the `@group' to put extra space in the output. Since @group
711 % should appear on a line by itself (according to the Texinfo
712 % manual), we don't worry about eating any user text.
716 % The \vtop produces a box with normal height and large depth; thus, TeX puts
717 % \baselineskip glue before it, and (when the next line of text is done)
718 % \lineskip glue after it. Thus, space below is not quite equal to space
719 % above. But it's pretty close.
721 % To get correct interline space between the last line of the group
722 % and the first line afterwards, we have to propagate \prevdepth.
723 \endgraf % Not \par, as it may have been set to \lisppar.
724 \global\dimen1 = \prevdepth
725 \egroup % End the \vtop.
726 % \dimen0 is the vertical size of the group's box.
727 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
728 % \dimen2 is how much space is left on the page (more or less).
729 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
730 % if the group doesn't fit on the current page, and it's a big big
731 % group, force a page break.
732 \ifdim \dimen0 > \dimen2
733 \ifdim \pagetotal < \vfilllimit\pageheight
742 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
743 % message, so this ends up printing `@group can only ...'.
745 \newhelp\groupinvalidhelp{%
746 group can only be used in environments such as @example,^^J%
747 where each line of input produces a line of output.}
749 % @need space-in-mils
750 % forces a page break if there is not space-in-mils remaining.
752 \newdimen\mil \mil=0.001in
754 % Old definition--didn't work.
755 %\parseargdef\need{\par %
756 %% This method tries to make TeX break the page naturally
757 %% if the depth of the box does not fit.
759 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
764 % Ensure vertical mode, so we don't make a big box in the middle of a
768 % If the @need value is less than one line space, it's useless.
770 \dimen2 = \ht\strutbox
771 \advance\dimen2 by \dp\strutbox
772 \ifdim\dimen0 > \dimen2
774 % Do a \strut just to make the height of this box be normal, so the
775 % normal leading is inserted relative to the preceding line.
776 % And a page break here is fine.
777 \vtop to #1\mil{\strut\vfil}%
779 % TeX does not even consider page breaks if a penalty added to the
780 % main vertical list is 10000 or more. But in order to see if the
781 % empty box we just added fits on the page, we must make it consider
782 % page breaks. On the other hand, we don't want to actually break the
783 % page after the empty box. So we use a penalty of 9999.
785 % There is an extremely small chance that TeX will actually break the
786 % page at this \penalty, if there are no other feasible breakpoints in
787 % sight. (If the user is using lots of big @group commands, which
788 % almost-but-not-quite fill up a page, TeX will have a hard time doing
789 % good page breaking, for example.) However, I could not construct an
790 % example where a page broke at this \penalty; if it happens in a real
791 % document, then we can reconsider our strategy.
794 % Back up by the size of the box, whether we did a page break or not.
797 % Do not allow a page break right after this kern.
802 % @br forces paragraph break (and is undocumented).
806 % @page forces the start of a new page.
808 \def\page{\par\vfill\supereject}
811 % outputs text on separate line in roman font, starting at standard page margin
813 % This records the amount of indent in the innermost environment.
814 % That's how much \exdent should take out.
815 \newskip\exdentamount
817 % This defn is used inside fill environments such as @defun.
818 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
820 % This defn is used inside nofill environments such as @example.
821 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
822 \leftline{\hskip\leftskip{\rm#1}}}}
824 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
825 % paragraph. For more general purposes, use the \margin insertion
826 % class. WHICH is `l' or `r'.
828 \newskip\inmarginspacing \inmarginspacing=1cm
829 \def\strutdepth{\dp\strutbox}
831 \def\doinmargin#1#2{\strut\vadjust{%
834 \vtop to \strutdepth{%
835 \baselineskip=\strutdepth
837 % if you have multiple lines of stuff to put here, you'll need to
838 % make the vbox yourself of the appropriate size.
840 \llap{\ignorespaces #2\hskip\inmarginspacing}%
842 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
847 \def\inleftmargin{\doinmargin l}
848 \def\inrightmargin{\doinmargin r}
850 % @inmargin{TEXT [, RIGHT-TEXT]}
851 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
852 % else use TEXT for both).
854 \def\inmargin#1{\parseinmargin #1,,\finish}
855 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
856 \setbox0 = \hbox{\ignorespaces #2}%
858 \def\lefttext{#1}% have both texts
861 \def\lefttext{#1}% have only one text
866 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
868 \def\temp{\inleftmargin\lefttext}%
873 % @include file insert text of that file as input.
875 \def\include{\parseargusing\filenamecatcodes\includezzz}
881 \def\temp{\input #1 }%
886 \def\filenamecatcodes{%
898 \def\pushthisfilestack{%
899 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
901 \def\pushthisfilestackX{%
902 \expandafter\pushthisfilestackY\thisfile\StackTerm
904 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
905 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
908 \def\popthisfilestack{\errthisfilestackempty}
909 \def\errthisfilestackempty{\errmessage{Internal error:
910 the stack of filenames is empty.}}
915 % outputs that line, centered.
917 \parseargdef\center{%
923 \next{\hfil \ignorespaces#1\unskip \hfil}%
928 \advance\hsize by -\leftskip
929 \advance\hsize by -\rightskip
934 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
936 % @sp n outputs n lines of vertical space
938 \parseargdef\sp{\vskip #1\baselineskip}
940 % @comment ...line which is ignored...
941 % @c is the same as @comment
942 % @ignore ... @end ignore is another way to write a comment
944 \def\comment{\begingroup \catcode`\^^M=\other%
945 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
947 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
951 % @paragraphindent NCHARS
952 % We'll use ems for NCHARS, close enough.
953 % NCHARS can also be the word `asis' or `none'.
954 % We cannot feasibly implement @paragraphindent asis, though.
956 \def\asisword{asis} % no translation, these are keywords
959 \parseargdef\paragraphindent{%
964 \defaultparindent = 0pt
966 \defaultparindent = #1em
969 \parindent = \defaultparindent
972 % @exampleindent NCHARS
973 % We'll use ems for NCHARS like @paragraphindent.
974 % It seems @exampleindent asis isn't necessary, but
975 % I preserve it to make it similar to @paragraphindent.
976 \parseargdef\exampleindent{%
983 \lispnarrowing = #1em
988 % @firstparagraphindent WORD
989 % If WORD is `none', then suppress indentation of the first paragraph
990 % after a section heading. If WORD is `insert', then do indent at such
993 % The paragraph indentation is suppressed or not by calling
994 % \suppressfirstparagraphindent, which the sectioning commands do.
995 % We switch the definition of this back and forth according to WORD.
996 % By default, we suppress indentation.
998 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
999 \def\insertword{insert}
1001 \parseargdef\firstparagraphindent{%
1004 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1005 \else\ifx\temp\insertword
1006 \let\suppressfirstparagraphindent = \relax
1008 \errhelp = \EMsimple
1009 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1013 % Here is how we actually suppress indentation. Redefine \everypar to
1014 % \kern backwards by \parindent, and then reset itself to empty.
1016 % We also make \indent itself not actually do anything until the next
1019 \gdef\dosuppressfirstparagraphindent{%
1021 \restorefirstparagraphindent
1025 \restorefirstparagraphindent
1028 \global\everypar = {%
1030 \restorefirstparagraphindent
1034 \gdef\restorefirstparagraphindent{%
1035 \global \let \indent = \ptexindent
1036 \global \let \noindent = \ptexnoindent
1037 \global \everypar = {}%
1041 % @asis just yields its argument. Used with @table, for example.
1045 % @math outputs its argument in math mode.
1047 % One complication: _ usually means subscripts, but it could also mean
1048 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1049 % _ active, and distinguish by seeing if the current family is \slfam,
1050 % which is what @var uses.
1052 \catcode`\_ = \active
1053 \gdef\mathunderscore{%
1055 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1058 % Another complication: we want \\ (and @\) to output a \ character.
1059 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1060 % this is not advertised and we don't care. Texinfo does not
1061 % otherwise define @\.
1063 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1064 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1069 \let\\ = \mathbackslash
1073 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1075 % Some active characters (such as <) are spaced differently in math.
1076 % We have to reset their definitions in case the @math was an argument
1077 % to a command which sets the catcodes (such as @item or @section).
1080 \catcode`^ = \active
1081 \catcode`< = \active
1082 \catcode`> = \active
1083 \catcode`+ = \active
1092 % @bullet and @minus need the same treatment as @math, just above.
1093 \def\bullet{$\ptexbullet$}
1096 % @dots{} outputs an ellipsis using the current font.
1097 % We do .5em per period so that it has the same spacing in the cm
1098 % typewriter fonts as three actual period characters; on the other hand,
1099 % in other typewriter fonts three periods are wider than 1.5em. So do
1100 % whichever is larger.
1104 \setbox0=\hbox{...}% get width of three periods
1111 \hskip 0pt plus.25fil
1112 .\hskip 0pt plus1fil
1113 .\hskip 0pt plus1fil
1114 .\hskip 0pt plus.5fil
1118 % @enddots{} is an end-of-sentence ellipsis.
1122 \spacefactor=\endofsentencespacefactor
1125 % @comma{} is so commas can be inserted into text without messing up
1126 % Texinfo's parsing.
1130 % @refill is a no-op.
1133 % If working on a large document in chapters, it is convenient to
1134 % be able to disable indexing, cross-referencing, and contents, for test runs.
1135 % This is done with @novalidate (before @setfilename).
1137 \newif\iflinks \linkstrue % by default we want the aux files.
1138 \let\novalidate = \linksfalse
1140 % @setfilename is done at the beginning of every texinfo file.
1141 % So open here the files we need to have open while reading the input.
1142 % This makes it possible to make a .fmt file for texinfo.
1144 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1147 % Open the new aux file. TeX will close it automatically at exit.
1148 \immediate\openout\auxfile=\jobname.aux
1149 \fi % \openindices needs to do some work in any case.
1151 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1153 % If texinfo.cnf is present on the system, read it.
1154 % Useful for site-wide @afourpaper, etc.
1155 \openin 1 texinfo.cnf
1156 \ifeof 1 \else \input texinfo.cnf \fi
1159 \comment % Ignore the actual filename.
1162 % Called from \setfilename.
1174 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1178 % adobe `portable' document format
1182 \newcount\filenamelength
1191 \newif\ifpdfmakepagedest
1193 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1194 % can be set). So we test for \relax and 0 as well as \undefined,
1195 % borrowed from ifpdf.sty.
1196 \ifx\pdfoutput\undefined
1198 \ifx\pdfoutput\relax
1207 % PDF uses PostScript string constants for the names of xref targets,
1208 % for display in the outlines, and in other places. Thus, we have to
1209 % double any backslashes. Otherwise, a name like "\node" will be
1210 % interpreted as a newline (\n), followed by o, d, e. Not good.
1211 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1212 % (and related messages, the final outcome is that it is up to the TeX
1213 % user to double the backslashes and otherwise make the string valid, so
1214 % that's what we do).
1216 % double active backslashes.
1218 {\catcode`\@=0 \catcode`\\=\active
1219 @gdef@activebackslashdouble{%
1221 @let\=@doublebackslash}
1224 % To handle parens, we must adopt a different approach, since parens are
1225 % not active characters. hyperref.dtx (which has the same problem as
1226 % us) handles it with this amazing macro to replace tokens, with minor
1227 % changes for Texinfo. It is included here under the GPL by permission
1228 % from the author, Heiko Oberdiek.
1230 % #1 is the tokens to replace.
1231 % #2 is the replacement.
1232 % #3 is the control sequence with the string.
1234 \def\HyPsdSubst#1#2#3{%
1235 \def\HyPsdReplace##1#1##2\END{%
1241 \HyPsdReplace##2\END
1245 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1247 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1249 % #1 is a control sequence in which to do the replacements.
1250 \def\backslashparens#1{%
1251 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1252 % \lastnode when called from \setref -> \pdfmkdest.
1253 \HyPsdSubst{(}{\realbackslash(}{#1}%
1254 \HyPsdSubst{)}{\realbackslash)}{#1}%
1257 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1258 with PDF output, and none of those formats could be found. (.eps cannot
1259 be supported due to the design of the PDF format; use regular TeX (DVI
1264 \pdfcatalog{/PageMode /UseOutlines}
1266 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1267 \def\dopdfimage#1#2#3{%
1268 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1269 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1271 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1272 % others). Let's try in that order.
1273 \let\pdfimgext=\empty
1275 \openin 1 #1.png \ifeof 1
1276 \openin 1 #1.jpg \ifeof 1
1277 \openin 1 #1.jpeg \ifeof 1
1278 \openin 1 #1.JPG \ifeof 1
1279 \openin 1 #1.pdf \ifeof 1
1280 \errhelp = \nopdfimagehelp
1281 \errmessage{Could not find image file #1 for pdf}%
1282 \else \gdef\pdfimgext{pdf}%
1284 \else \gdef\pdfimgext{JPG}%
1286 \else \gdef\pdfimgext{jpeg}%
1288 \else \gdef\pdfimgext{jpg}%
1290 \else \gdef\pdfimgext{png}%
1295 % without \immediate, pdftex seg faults when the same image is
1296 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1297 \ifnum\pdftexversion < 14
1300 \immediate\pdfximage
1302 \ifdim \wd0 >0pt width \imagewidth \fi
1303 \ifdim \wd2 >0pt height \imageheight \fi
1304 \ifnum\pdftexversion<13
1309 \ifnum\pdftexversion < 14 \else
1310 \pdfrefximage \pdflastximage
1314 % We have to set dummies so commands such as @code, and characters
1315 % such as \, aren't expanded when present in a section title.
1318 \activebackslashdouble
1319 \makevalueexpandable
1320 \def\pdfdestname{#1}%
1321 \backslashparens\pdfdestname
1322 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1325 % used to mark target names; must be expandable.
1328 % by default, use a color that is dark enough to print on paper as
1329 % nearly black, but still distinguishable for online viewing.
1330 % (Defined in pdfcolor.tex.)
1331 \let\urlcolor = \BrickRed
1332 \let\linkcolor = \BrickRed
1333 \def\endlink{\Black\pdfendlink}
1335 % Adding outlines to PDF; macros for calculating structure of outlines
1336 % come from Petr Olsak
1337 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1338 \else \csname#1\endcsname \fi}
1339 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1340 \advance\tempnum by 1
1341 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1343 % #1 is the section text, which is what will be displayed in the
1344 % outline by the pdf viewer. #2 is the pdf expression for the number
1345 % of subentries (or empty, for subsubsections). #3 is the node text,
1346 % which might be empty if this toc entry had no corresponding node.
1347 % #4 is the page number
1349 \def\dopdfoutline#1#2#3#4{%
1350 % Generate a link to the node text if that exists; else, use the
1351 % page number. We could generate a destination for the section
1352 % text in the case where a section has no node, but it doesn't
1353 % seem worth the trouble, since most documents are normally structured.
1354 \def\pdfoutlinedest{#3}%
1355 \ifx\pdfoutlinedest\empty
1356 \def\pdfoutlinedest{#4}%
1358 % Doubled backslashes in the name.
1359 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1360 \backslashparens\pdfoutlinedest}%
1363 % Also double the backslashes in the display string.
1364 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1365 \backslashparens\pdfoutlinetext}%
1367 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1370 \def\pdfmakeoutlines{%
1372 % Thanh's hack / proper braces in bookmarks
1373 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1374 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1376 % Read toc silently, to get counts of subentries for \pdfoutline.
1377 \def\numchapentry##1##2##3##4{%
1378 \def\thischapnum{##2}%
1380 \def\thissubsecnum{0}%
1382 \def\numsecentry##1##2##3##4{%
1383 \advancenumber{chap\thischapnum}%
1384 \def\thissecnum{##2}%
1385 \def\thissubsecnum{0}%
1387 \def\numsubsecentry##1##2##3##4{%
1388 \advancenumber{sec\thissecnum}%
1389 \def\thissubsecnum{##2}%
1391 \def\numsubsubsecentry##1##2##3##4{%
1392 \advancenumber{subsec\thissubsecnum}%
1394 \def\thischapnum{0}%
1396 \def\thissubsecnum{0}%
1398 % use \def rather than \let here because we redefine \chapentry et
1399 % al. a second time, below.
1400 \def\appentry{\numchapentry}%
1401 \def\appsecentry{\numsecentry}%
1402 \def\appsubsecentry{\numsubsecentry}%
1403 \def\appsubsubsecentry{\numsubsubsecentry}%
1404 \def\unnchapentry{\numchapentry}%
1405 \def\unnsecentry{\numsecentry}%
1406 \def\unnsubsecentry{\numsubsecentry}%
1407 \def\unnsubsubsecentry{\numsubsubsecentry}%
1410 % Read toc second time, this time actually producing the outlines.
1411 % The `-' means take the \expnumber as the absolute number of
1412 % subentries, which we calculated on our first read of the .toc above.
1414 % We use the node names as the destinations.
1415 \def\numchapentry##1##2##3##4{%
1416 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1417 \def\numsecentry##1##2##3##4{%
1418 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1419 \def\numsubsecentry##1##2##3##4{%
1420 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1421 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1422 \dopdfoutline{##1}{}{##3}{##4}}%
1424 % PDF outlines are displayed using system fonts, instead of
1425 % document fonts. Therefore we cannot use special characters,
1426 % since the encoding is unknown. For example, the eogonek from
1427 % Latin 2 (0xea) gets translated to a | character. Info from
1428 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1430 % xx to do this right, we have to translate 8-bit characters to
1431 % their "best" equivalent, based on the @documentencoding. Right
1432 % now, I guess we'll just let the pdf reader have its way.
1435 \catcode`\\=\active \otherbackslash
1436 \input \tocreadfilename
1440 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1441 \ifx\PP\D\let\nextsp\relax
1442 \else\let\nextsp\skipspaces
1443 \ifx\p\space\else\addtokens{\filename}{\PP}%
1444 \advance\filenamelength by 1
1448 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1449 \ifnum\pdftexversion < 14
1450 \let \startlink \pdfannotlink
1452 \let \startlink \pdfstartlink
1454 % make a live url in pdf output.
1457 % it seems we really need yet another set of dummies; have not
1458 % tried to figure out what each command should do in the context
1459 % of @url. for now, just make @/ a no-op, that's the only one
1460 % people have actually reported a problem with.
1462 \normalturnoffactive
1465 \makevalueexpandable
1466 \leavevmode\urlcolor
1467 \startlink attr{/Border [0 0 0]}%
1468 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1470 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1471 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1472 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1473 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1475 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1477 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1478 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1479 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1481 \ifnum0=\countA\else\makelink\fi
1482 \ifx\first.\let\next=\done\else
1484 \addtokens{\toksB}{\the\toksD}
1485 \ifx\first,\addtokens{\toksB}{\space}\fi
1487 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1489 \def\makelink{\addtokens{\toksB}%
1490 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1492 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1493 \linkcolor #1\endlink}
1494 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1496 \let\pdfmkdest = \gobble
1497 \let\pdfurl = \gobble
1498 \let\endlink = \relax
1499 \let\linkcolor = \relax
1500 \let\pdfmakeoutlines = \relax
1501 \fi % \ifx\pdfoutput
1506 % Change the current font style to #1, remembering it in \curfontstyle.
1507 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1508 % italics, not bold italics.
1510 \def\setfontstyle#1{%
1511 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1512 \csname ten#1\endcsname % change the current font
1515 % Select #1 fonts with the current style.
1517 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1519 \def\rm{\fam=0 \setfontstyle{rm}}
1520 \def\it{\fam=\itfam \setfontstyle{it}}
1521 \def\sl{\fam=\slfam \setfontstyle{sl}}
1522 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1523 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1525 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1526 % So we set up a \sf.
1528 \def\sf{\fam=\sffam \setfontstyle{sf}}
1529 \let\li = \sf % Sometimes we call it \li, not \sf.
1531 % We don't need math for this font style.
1532 \def\ttsl{\setfontstyle{ttsl}}
1536 \newdimen\textleading \textleading = 13.2pt
1538 % Set the baselineskip to #1, and the lineskip and strut size
1539 % correspondingly. There is no deep meaning behind these magic numbers
1540 % used as factors; they just match (closely enough) what Knuth defined.
1542 \def\lineskipfactor{.08333}
1543 \def\strutheightpercent{.70833}
1544 \def\strutdepthpercent {.29167}
1547 \normalbaselineskip = #1\relax
1548 \normallineskip = \lineskipfactor\normalbaselineskip
1550 \setbox\strutbox =\hbox{%
1551 \vrule width0pt height\strutheightpercent\baselineskip
1552 depth \strutdepthpercent \baselineskip
1557 % PDF CMaps. See also LaTeX's t1.cmap.
1562 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1563 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1564 %%DocumentNeededResources: ProcSet (CIDInit)
1565 %%IncludeResource: ProcSet (CIDInit)
1566 %%BeginResource: CMap (TeX-OT1-0)
1567 %%Title: (TeX-OT1-0 TeX OT1 0)
1570 /CIDInit /ProcSet findresource begin
1578 /CMapName /TeX-OT1-0 def
1580 1 begincodespacerange
1636 CMapName currentdict /CMap defineresource pop
1642 \expandafter\edef\csname cmapOT1\endcsname#1{%
1643 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1648 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1649 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1650 %%DocumentNeededResources: ProcSet (CIDInit)
1651 %%IncludeResource: ProcSet (CIDInit)
1652 %%BeginResource: CMap (TeX-OT1IT-0)
1653 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1656 /CIDInit /ProcSet findresource begin
1664 /CMapName /TeX-OT1IT-0 def
1666 1 begincodespacerange
1724 CMapName currentdict /CMap defineresource pop
1730 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1731 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1736 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1737 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1738 %%DocumentNeededResources: ProcSet (CIDInit)
1739 %%IncludeResource: ProcSet (CIDInit)
1740 %%BeginResource: CMap (TeX-OT1TT-0)
1741 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1744 /CIDInit /ProcSet findresource begin
1752 /CMapName /TeX-OT1TT-0 def
1754 1 begincodespacerange
1799 CMapName currentdict /CMap defineresource pop
1805 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1806 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1809 \expandafter\let\csname cmapOT1\endcsname\gobble
1810 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1811 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1815 % Set the font macro #1 to the font named #2, adding on the
1816 % specified font prefix (normally `cm').
1817 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1818 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1820 \def\setfont#1#2#3#4#5{%
1821 \font#1=\fontprefix#2#3 scaled #4
1822 \csname cmap#5\endcsname#1%
1824 % This is what gets called when #5 of \setfont is empty.
1828 % Use cm as the default font prefix.
1829 % To specify the font prefix, you must define \fontprefix
1830 % before you read in texinfo.tex.
1831 \ifx\fontprefix\undefined
1834 % Support font families that don't use the same naming scheme as CM.
1836 \def\rmbshape{bx} %where the normal face is bold
1841 \def\ttslshape{sltt}
1851 % Definitions for a main text size of 11pt. This is the default in
1854 \def\definetextfontsizexi{%
1855 % Text fonts (11.2pt, magstep1).
1856 \def\textnominalsize{11pt}
1857 \edef\mainmagstep{\magstephalf}
1858 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1859 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1860 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1861 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1862 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1863 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1864 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1865 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1866 \font\texti=cmmi10 scaled \mainmagstep
1867 \font\textsy=cmsy10 scaled \mainmagstep
1869 % A few fonts for @defun names and args.
1870 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1871 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1872 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1873 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1875 % Fonts for indices, footnotes, small examples (9pt).
1876 \def\smallnominalsize{9pt}
1877 \setfont\smallrm\rmshape{9}{1000}{OT1}
1878 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1879 \setfont\smallbf\bfshape{10}{900}{OT1}
1880 \setfont\smallit\itshape{9}{1000}{OT1IT}
1881 \setfont\smallsl\slshape{9}{1000}{OT1}
1882 \setfont\smallsf\sfshape{9}{1000}{OT1}
1883 \setfont\smallsc\scshape{10}{900}{OT1}
1884 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1888 % Fonts for small examples (8pt).
1889 \def\smallernominalsize{8pt}
1890 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1891 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1892 \setfont\smallerbf\bfshape{10}{800}{OT1}
1893 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1894 \setfont\smallersl\slshape{8}{1000}{OT1}
1895 \setfont\smallersf\sfshape{8}{1000}{OT1}
1896 \setfont\smallersc\scshape{10}{800}{OT1}
1897 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1898 \font\smalleri=cmmi8
1899 \font\smallersy=cmsy8
1901 % Fonts for title page (20.4pt):
1902 \def\titlenominalsize{20pt}
1903 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1904 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1905 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1906 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1907 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1908 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1909 \let\titlebf=\titlerm
1910 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1911 \font\titlei=cmmi12 scaled \magstep3
1912 \font\titlesy=cmsy10 scaled \magstep4
1913 \def\authorrm{\secrm}
1914 \def\authortt{\sectt}
1916 % Chapter (and unnumbered) fonts (17.28pt).
1917 \def\chapnominalsize{17pt}
1918 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1919 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1920 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1921 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1922 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1923 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1925 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1926 \font\chapi=cmmi12 scaled \magstep2
1927 \font\chapsy=cmsy10 scaled \magstep3
1929 % Section fonts (14.4pt).
1930 \def\secnominalsize{14pt}
1931 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1932 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1933 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1934 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1935 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1936 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1938 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1939 \font\seci=cmmi12 scaled \magstep1
1940 \font\secsy=cmsy10 scaled \magstep2
1942 % Subsection fonts (13.15pt).
1943 \def\ssecnominalsize{13pt}
1944 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1945 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1946 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1947 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1948 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1949 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1951 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1952 \font\sseci=cmmi12 scaled \magstephalf
1953 \font\ssecsy=cmsy10 scaled 1315
1955 % Reduced fonts for @acro in text (10pt).
1956 \def\reducednominalsize{10pt}
1957 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1958 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1959 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1960 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1961 \setfont\reducedsl\slshape{10}{1000}{OT1}
1962 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1963 \setfont\reducedsc\scshape{10}{1000}{OT1}
1964 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1965 \font\reducedi=cmmi10
1966 \font\reducedsy=cmsy10
1968 % reset the current fonts
1971 } % end of 11pt text font size definitions
1974 % Definitions to make the main text be 10pt Computer Modern, with
1975 % section, chapter, etc., sizes following suit. This is for the GNU
1976 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1977 % future. Used with @smallbook, which sets the leading to 12pt.
1979 \def\definetextfontsizex{%
1980 % Text fonts (10pt).
1981 \def\textnominalsize{10pt}
1982 \edef\mainmagstep{1000}
1983 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1984 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1985 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1986 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1987 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1988 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1989 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1990 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1991 \font\texti=cmmi10 scaled \mainmagstep
1992 \font\textsy=cmsy10 scaled \mainmagstep
1994 % A few fonts for @defun names and args.
1995 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1996 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1997 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1998 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2000 % Fonts for indices, footnotes, small examples (9pt).
2001 \def\smallnominalsize{9pt}
2002 \setfont\smallrm\rmshape{9}{1000}{OT1}
2003 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2004 \setfont\smallbf\bfshape{10}{900}{OT1}
2005 \setfont\smallit\itshape{9}{1000}{OT1IT}
2006 \setfont\smallsl\slshape{9}{1000}{OT1}
2007 \setfont\smallsf\sfshape{9}{1000}{OT1}
2008 \setfont\smallsc\scshape{10}{900}{OT1}
2009 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2013 % Fonts for small examples (8pt).
2014 \def\smallernominalsize{8pt}
2015 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2016 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2017 \setfont\smallerbf\bfshape{10}{800}{OT1}
2018 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2019 \setfont\smallersl\slshape{8}{1000}{OT1}
2020 \setfont\smallersf\sfshape{8}{1000}{OT1}
2021 \setfont\smallersc\scshape{10}{800}{OT1}
2022 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2023 \font\smalleri=cmmi8
2024 \font\smallersy=cmsy8
2026 % Fonts for title page (20.4pt):
2027 \def\titlenominalsize{20pt}
2028 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2029 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2030 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2031 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2032 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2033 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2034 \let\titlebf=\titlerm
2035 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2036 \font\titlei=cmmi12 scaled \magstep3
2037 \font\titlesy=cmsy10 scaled \magstep4
2038 \def\authorrm{\secrm}
2039 \def\authortt{\sectt}
2041 % Chapter fonts (14.4pt).
2042 \def\chapnominalsize{14pt}
2043 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2044 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2045 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2046 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2047 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2048 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2050 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2051 \font\chapi=cmmi12 scaled \magstep1
2052 \font\chapsy=cmsy10 scaled \magstep2
2054 % Section fonts (12pt).
2055 \def\secnominalsize{12pt}
2056 \setfont\secrm\rmbshape{12}{1000}{OT1}
2057 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2058 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2059 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2060 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2061 \setfont\secsf\sfbshape{12}{1000}{OT1}
2063 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2065 \font\secsy=cmsy10 scaled \magstep1
2067 % Subsection fonts (10pt).
2068 \def\ssecnominalsize{10pt}
2069 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2070 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2071 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2072 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2073 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2074 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2076 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2080 % Reduced fonts for @acro in text (9pt).
2081 \def\reducednominalsize{9pt}
2082 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2083 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2084 \setfont\reducedbf\bfshape{10}{900}{OT1}
2085 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2086 \setfont\reducedsl\slshape{9}{1000}{OT1}
2087 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2088 \setfont\reducedsc\scshape{10}{900}{OT1}
2089 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2090 \font\reducedi=cmmi9
2091 \font\reducedsy=cmsy9
2093 % reduce space between paragraphs
2094 \divide\parskip by 2
2096 % reset the current fonts
2099 } % end of 10pt text font size definitions
2102 % We provide the user-level command
2104 % (or 11) to redefine the text font size. pt is assumed.
2109 \parseargdef\fonttextsize{%
2110 \def\textsizearg{#1}%
2111 \wlog{doing @fonttextsize \textsizearg}%
2113 % Set \globaldefs so that documents can use this inside @tex, since
2114 % makeinfo 4.8 does not support it, but we need it nonetheless.
2116 \begingroup \globaldefs=1
2117 \ifx\textsizearg\xword \definetextfontsizex
2118 \else \ifx\textsizearg\xiword \definetextfontsizexi
2121 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2127 % In order for the font changes to affect most math symbols and letters,
2128 % we have to define the \textfont of the standard families. Since
2129 % texinfo doesn't allow for producing subscripts and superscripts except
2130 % in the main text, we don't bother to reset \scriptfont and
2131 % \scriptscriptfont (which would also require loading a lot more fonts).
2133 \def\resetmathfonts{%
2134 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2135 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2136 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2139 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2140 % of just \STYLE. We do this because \STYLE needs to also set the
2141 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2142 % \tenSTYLE to set the current font.
2144 % Each font-changing command also sets the names \lsize (one size lower)
2145 % and \lllsize (three sizes lower). These relative commands are used in
2146 % the LaTeX logo and acronyms.
2148 % This all needs generalizing, badly.
2151 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2152 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2153 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2154 \let\tenttsl=\textttsl
2155 \def\curfontsize{text}%
2156 \def\lsize{reduced}\def\lllsize{smaller}%
2157 \resetmathfonts \setleading{\textleading}}
2159 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2160 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2161 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2162 \let\tenttsl=\titlettsl
2163 \def\curfontsize{title}%
2164 \def\lsize{chap}\def\lllsize{subsec}%
2165 \resetmathfonts \setleading{25pt}}
2166 \def\titlefont#1{{\titlefonts\rm #1}}
2168 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2169 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2170 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2171 \let\tenttsl=\chapttsl
2172 \def\curfontsize{chap}%
2173 \def\lsize{sec}\def\lllsize{text}%
2174 \resetmathfonts \setleading{19pt}}
2176 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2177 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2178 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2179 \let\tenttsl=\secttsl
2180 \def\curfontsize{sec}%
2181 \def\lsize{subsec}\def\lllsize{reduced}%
2182 \resetmathfonts \setleading{16pt}}
2184 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2185 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2186 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2187 \let\tenttsl=\ssecttsl
2188 \def\curfontsize{ssec}%
2189 \def\lsize{text}\def\lllsize{small}%
2190 \resetmathfonts \setleading{15pt}}
2191 \let\subsubsecfonts = \subsecfonts
2193 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2194 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2195 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2196 \let\tenttsl=\reducedttsl
2197 \def\curfontsize{reduced}%
2198 \def\lsize{small}\def\lllsize{smaller}%
2199 \resetmathfonts \setleading{10.5pt}}
2201 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2202 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2203 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2204 \let\tenttsl=\smallttsl
2205 \def\curfontsize{small}%
2206 \def\lsize{smaller}\def\lllsize{smaller}%
2207 \resetmathfonts \setleading{10.5pt}}
2209 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2210 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2211 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2212 \let\tenttsl=\smallerttsl
2213 \def\curfontsize{smaller}%
2214 \def\lsize{smaller}\def\lllsize{smaller}%
2215 \resetmathfonts \setleading{9.5pt}}
2217 % Set the fonts to use with the @small... environments.
2218 \let\smallexamplefonts = \smallfonts
2220 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2221 % can fit this many characters:
2222 % 8.5x11=86 smallbook=72 a4=90 a5=69
2223 % If we use \scriptfonts (8pt), then we can fit this many characters:
2224 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2225 % For me, subjectively, the few extra characters that fit aren't worth
2226 % the additional smallness of 8pt. So I'm making the default 9pt.
2228 % By the way, for comparison, here's what fits with @example (10pt):
2229 % 8.5x11=71 smallbook=60 a4=75 a5=58
2231 % I wish the USA used A4 paper.
2235 % Set up the default fonts, so we can use them for creating boxes.
2237 \definetextfontsizexi
2239 % Define these so they can be easily changed for other fonts.
2240 \def\angleleft{$\langle$}
2241 \def\angleright{$\rangle$}
2243 % Count depth in font-changes, for error checks
2244 \newcount\fontdepth \fontdepth=0
2246 % Fonts for short table of contents.
2247 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2248 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2249 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2250 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2252 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2253 %% serif) and @ii for TeX italic
2255 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2256 % unless the following character is such as not to need one.
2257 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2258 \ptexslash\fi\fi\fi}
2259 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2260 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2262 % like \smartslanted except unconditionally uses \ttsl.
2263 % @var is set to this for defun arguments.
2264 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2266 % like \smartslanted except unconditionally use \sl. We never want
2267 % ttsl for book titles, do we?
2268 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2271 \let\slanted=\smartslanted
2272 \let\var=\smartslanted
2273 \let\dfn=\smartslanted
2274 \let\emph=\smartitalic
2276 % @b, explicit bold.
2280 % @sansserif, explicit sans.
2281 \def\sansserif#1{{\sf #1}}
2283 % We can't just use \exhyphenpenalty, because that only has effect at
2284 % the end of a paragraph. Restore normal hyphenation at the end of the
2285 % group within which \nohyphenation is presumably called.
2287 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2288 \def\restorehyphenation{\hyphenchar\font = `- }
2290 % Set sfcode to normal for the chars that usually have another value.
2291 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2292 % sometimes \x has an active definition that messes things up.
2295 \def\plainfrenchspacing{%
2296 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2297 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2298 \def\endofsentencespacefactor{1000}% for @. and friends
2300 \def\plainnonfrenchspacing{%
2301 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2302 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2303 \def\endofsentencespacefactor{3000}% for @. and friends
2306 \def\endofsentencespacefactor{3000}% default
2309 {\tt \rawbackslash \plainfrenchspacing #1}%
2312 \def\samp#1{`\tclose{#1}'\null}
2313 \setfont\keyrm\rmshape{8}{1000}{OT1}
2315 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2316 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2317 \vbox{\hrule\kern-0.4pt
2318 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2320 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2321 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2322 % The old definition, with no lozenge:
2323 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2324 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2326 % @file, @option are the same as @samp.
2330 % @code is a modification of @t,
2331 % which makes spaces the same size as normal in the surrounding text.
2334 % Change normal interword space to be same as for the current font.
2335 \spaceskip = \fontdimen2\font
2337 % Switch to typewriter.
2340 % But `\ ' produces the large typewriter interword space.
2341 \def\ {{\spaceskip = 0pt{} }}%
2343 % Turn off hyphenation.
2353 % We *must* turn on hyphenation at `-' and `_' in @code.
2354 % Otherwise, it is too hard to avoid overfull hboxes
2355 % in the Emacs manual, the Library manual, etc.
2357 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2358 % both hyphenation at - and hyphenation within words.
2359 % We must therefore turn them both off (\tclose does that)
2360 % and arrange explicitly to hyphenate at a dash.
2363 \catcode`\-=\active \catcode`\_=\active
2364 \catcode`\'=\active \catcode`\`=\active
2366 \global\def\code{\begingroup
2367 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2368 \let'\codequoteright \let`\codequoteleft
2370 \catcode\dashChar=\active \catcode\underChar=\active
2383 \def\codedash{-\discretionary{}{}{}}
2385 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2386 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2387 % will therefore expand the active definition of _, which is us
2388 % (inside @code that is), therefore an endless loop.
2390 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2391 \else\normalunderscore \fi
2392 \discretionary{}{}{}}%
2395 \def\codex #1{\tclose{#1}\endgroup}
2397 % An additional complication: the above will allow breaks after, e.g.,
2398 % each of the four underscores in __typeof__. This is undesirable in
2399 % some manuals, especially if they don't have long identifiers in
2400 % general. @allowcodebreaks provides a way to control this.
2402 \newif\ifallowcodebreaks \allowcodebreakstrue
2404 \def\keywordtrue{true}
2405 \def\keywordfalse{false}
2407 \parseargdef\allowcodebreaks{%
2409 \ifx\txiarg\keywordtrue
2410 \allowcodebreakstrue
2411 \else\ifx\txiarg\keywordfalse
2412 \allowcodebreaksfalse
2414 \errhelp = \EMsimple
2415 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2419 % @kbd is like @code, except that if the argument is just one @key command,
2420 % then @kbd has no effect.
2422 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2423 % `example' (@kbd uses ttsl only inside of @example and friends),
2424 % or `code' (@kbd uses normal tty font always).
2425 \parseargdef\kbdinputstyle{%
2427 \ifx\txiarg\worddistinct
2428 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2429 \else\ifx\txiarg\wordexample
2430 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2431 \else\ifx\txiarg\wordcode
2432 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2434 \errhelp = \EMsimple
2435 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2438 \def\worddistinct{distinct}
2439 \def\wordexample{example}
2442 % Default is `distinct.'
2443 \kbdinputstyle distinct
2446 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2447 \ifx\one\xkey\ifx\threex\three \key{#2}%
2448 \else{\tclose{\kbdfont\look}}\fi
2449 \else{\tclose{\kbdfont\look}}\fi}
2451 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2452 \let\indicateurl=\code
2456 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2457 % second argument specifying the text to display and an optional third
2458 % arg as text to display instead of (rather than in addition to) the url
2459 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2460 % a hypertex \special here.
2462 \def\uref#1{\douref #1,,,\finish}
2463 \def\douref#1,#2,#3,#4\finish{\begingroup
2466 \setbox0 = \hbox{\ignorespaces #3}%
2468 \unhbox0 % third arg given, show only that
2470 \setbox0 = \hbox{\ignorespaces #2}%
2473 \unhbox0 % PDF: 2nd arg given, show only it
2475 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2478 \code{#1}% only url given, so show it
2484 % @url synonym for @uref, since that's how everyone uses it.
2488 % rms does not like angle brackets --karl, 17may97.
2489 % So now @email is just like @uref, unless we are pdf.
2491 %\def\email#1{\angleleft{\tt #1}\angleright}
2493 \def\email#1{\doemail#1,,\finish}
2494 \def\doemail#1,#2,#3\finish{\begingroup
2497 \setbox0 = \hbox{\ignorespaces #2}%
2498 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2505 % Check if we are currently using a typewriter font. Since all the
2506 % Computer Modern typewriter fonts have zero interword stretch (and
2507 % shrink), and it is reasonable to expect all typewriter fonts to have
2508 % this property, we can check that font parameter.
2510 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2512 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2513 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2515 \def\dmn#1{\thinspace #1}
2517 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2519 % @l was never documented to mean ``switch to the Lisp font'',
2520 % and it is not used as such in any manual I can find. We need it for
2521 % Polish suppressed-l. --karl, 22sep96.
2522 %\def\l#1{{\li #1}\null}
2524 % Explicit font changes: @r, @sc, undocumented @ii.
2525 \def\r#1{{\rm #1}} % roman font
2526 \def\sc#1{{\smallcaps#1}} % smallcaps font
2527 \def\ii#1{{\it #1}} % italic font
2529 % @acronym for "FBI", "NATO", and the like.
2530 % We print this one point size smaller, since it's intended for
2533 \def\acronym#1{\doacronym #1,,\finish}
2534 \def\doacronym#1,#2,#3\finish{%
2535 {\selectfonts\lsize #1}%
2537 \ifx\temp\empty \else
2538 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2542 % @abbr for "Comput. J." and the like.
2543 % No font change, but don't do end-of-sentence spacing.
2545 \def\abbr#1{\doabbr #1,,\finish}
2546 \def\doabbr#1,#2,#3\finish{%
2547 {\plainfrenchspacing #1}%
2549 \ifx\temp\empty \else
2550 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2554 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2556 \def\pounds{{\it\$}}
2558 % @euro{} comes from a separate font, depending on the current style.
2559 % We use the free feym* fonts from the eurosym package by Henrik
2560 % Theiling, which support regular, slanted, bold and bold slanted (and
2561 % "outlined" (blackboard board, sort of) versions, which we don't need).
2562 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2564 % Although only regular is the truly official Euro symbol, we ignore
2565 % that. The Euro is designed to be slightly taller than the regular
2571 % feybo - bold slanted
2573 % There is no good (free) typewriter version, to my knowledge.
2574 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2577 % Also doesn't work in math. Do we need to do math with euro symbols?
2581 \def\euro{{\eurofont e}}
2583 % We set the font at each command, rather than predefining it in
2584 % \textfonts and the other font-switching commands, so that
2585 % installations which never need the symbol don't have to have the
2588 % There is only one designed size (nominal 10pt), so we always scale
2589 % that to the current nominal size.
2591 % By the way, simply using "at 1em" works for cmr10 and the like, but
2592 % does not work for cmbx10 and other extended/shrunken fonts.
2594 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2596 \ifx\curfontstyle\bfstylename
2598 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2601 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2606 % @registeredsymbol - R in a circle. The font for the R should really
2607 % be smaller yet, but lllsize is the best we can do for now.
2608 % Adapted from the plain.tex definition of \copyright.
2610 \def\registeredsymbol{%
2611 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2616 % @textdegree - the normal degrees sign.
2618 \def\textdegree{$^\circ$}
2620 % Laurent Siebenmann reports \Orb undefined with:
2621 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2622 % so we'll define it if necessary.
2625 \def\Orb{\mathhexbox20D}
2629 \message{page headings,}
2631 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2632 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2634 % First the title page. Must do @settitle before @titlepage.
2636 \newif\iffinishedtitlepage
2638 % Do an implicit @contents or @shortcontents after @end titlepage if the
2639 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2641 \newif\ifsetcontentsaftertitlepage
2642 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2643 \newif\ifsetshortcontentsaftertitlepage
2644 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2646 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2647 \endgroup\page\hbox{}\page}
2650 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2652 \parindent=0pt \textfonts
2653 % Leave some space at the very top of the page.
2654 \vglue\titlepagetopglue
2655 % No rule at page bottom unless we print one at the top with @title.
2656 \finishedtitlepagetrue
2658 % Most title ``pages'' are actually two pages long, with space
2659 % at the top of the second. We don't want the ragged left on the second.
2660 \let\oldpage = \page
2662 \iffinishedtitlepage\else
2665 \let\page = \oldpage
2672 \iffinishedtitlepage\else
2675 % It is important to do the page break before ending the group,
2676 % because the headline and footline are only empty inside the group.
2677 % If we use the new definition of \page, we always get a blank page
2678 % after the title page, which we certainly don't want.
2682 % Need this before the \...aftertitlepage checks so that if they are
2683 % in effect the toc pages will come out with page numbers.
2686 % If they want short, they certainly want long too.
2687 \ifsetshortcontentsaftertitlepage
2690 \global\let\shortcontents = \relax
2691 \global\let\contents = \relax
2694 \ifsetcontentsaftertitlepage
2696 \global\let\contents = \relax
2697 \global\let\shortcontents = \relax
2701 \def\finishtitlepage{%
2702 \vskip4pt \hrule height 2pt width \hsize
2703 \vskip\titlepagebottomglue
2704 \finishedtitlepagetrue
2707 %%% Macros to be used within @titlepage:
2709 \let\subtitlerm=\tenrm
2710 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2712 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2715 \parseargdef\title{%
2717 \leftline{\titlefonts\rm #1}
2718 % print a rule at the page bottom also.
2719 \finishedtitlepagefalse
2720 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2723 \parseargdef\subtitle{%
2725 {\subtitlefont \rightline{#1}}%
2728 % @author should come last, but may come many times.
2729 % It can also be used inside @quotation.
2731 \parseargdef\author{%
2732 \def\temp{\quotation}%
2734 \def\quotationauthor{#1}% printed in \Equotation.
2737 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2738 {\authorfont \leftline{#1}}%
2743 %%% Set up page headings and footings.
2745 \let\thispage=\folio
2747 \newtoks\evenheadline % headline on even pages
2748 \newtoks\oddheadline % headline on odd pages
2749 \newtoks\evenfootline % footline on even pages
2750 \newtoks\oddfootline % footline on odd pages
2752 % Now make TeX use those variables
2753 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2754 \else \the\evenheadline \fi}}
2755 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2756 \else \the\evenfootline \fi}\HEADINGShook}
2757 \let\HEADINGShook=\relax
2759 % Commands to set those variables.
2760 % For example, this is what @headings on does
2761 % @evenheading @thistitle|@thispage|@thischapter
2762 % @oddheading @thischapter|@thispage|@thistitle
2763 % @evenfooting @thisfile||
2764 % @oddfooting ||@thisfile
2767 \def\evenheading{\parsearg\evenheadingxxx}
2768 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2769 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2770 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2772 \def\oddheading{\parsearg\oddheadingxxx}
2773 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2774 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2775 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2777 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2779 \def\evenfooting{\parsearg\evenfootingxxx}
2780 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2781 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2782 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2784 \def\oddfooting{\parsearg\oddfootingxxx}
2785 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2786 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2787 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2789 % Leave some space for the footline. Hopefully ok to assume
2790 % @evenfooting will not be used by itself.
2791 \global\advance\pageheight by -12pt
2792 \global\advance\vsize by -12pt
2795 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2798 % @headings double turns headings on for double-sided printing.
2799 % @headings single turns headings on for single-sided printing.
2800 % @headings off turns them off.
2801 % @headings on same as @headings double, retained for compatibility.
2802 % @headings after turns on double-sided headings after this page.
2803 % @headings doubleafter turns on double-sided headings after this page.
2804 % @headings singleafter turns on single-sided headings after this page.
2805 % By default, they are off at the start of a document,
2806 % and turned `on' after @end titlepage.
2808 \def\headings #1 {\csname HEADINGS#1\endcsname}
2811 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2812 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2814 % When we turn headings on, set the page number to 1.
2815 % For double-sided printing, put current file name in lower left corner,
2816 % chapter name on inside top of right hand pages, document
2817 % title on inside top of left hand pages, and page numbers on outside top
2818 % edge of all pages.
2819 \def\HEADINGSdouble{%
2821 \global\evenfootline={\hfil}
2822 \global\oddfootline={\hfil}
2823 \global\evenheadline={\line{\folio\hfil\thistitle}}
2824 \global\oddheadline={\line{\thischapter\hfil\folio}}
2825 \global\let\contentsalignmacro = \chapoddpage
2827 \let\contentsalignmacro = \chappager
2829 % For single-sided printing, chapter title goes across top left of page,
2830 % page number on top right.
2831 \def\HEADINGSsingle{%
2833 \global\evenfootline={\hfil}
2834 \global\oddfootline={\hfil}
2835 \global\evenheadline={\line{\thischapter\hfil\folio}}
2836 \global\oddheadline={\line{\thischapter\hfil\folio}}
2837 \global\let\contentsalignmacro = \chappager
2839 \def\HEADINGSon{\HEADINGSdouble}
2841 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2842 \let\HEADINGSdoubleafter=\HEADINGSafter
2843 \def\HEADINGSdoublex{%
2844 \global\evenfootline={\hfil}
2845 \global\oddfootline={\hfil}
2846 \global\evenheadline={\line{\folio\hfil\thistitle}}
2847 \global\oddheadline={\line{\thischapter\hfil\folio}}
2848 \global\let\contentsalignmacro = \chapoddpage
2851 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2852 \def\HEADINGSsinglex{%
2853 \global\evenfootline={\hfil}
2854 \global\oddfootline={\hfil}
2855 \global\evenheadline={\line{\thischapter\hfil\folio}}
2856 \global\oddheadline={\line{\thischapter\hfil\folio}}
2857 \global\let\contentsalignmacro = \chappager
2860 % Subroutines used in generating headings
2861 % This produces Day Month Year style of output.
2862 % Only define if not already defined, in case a txi-??.tex file has set
2863 % up a different format (e.g., txi-cs.tex does this).
2864 \ifx\today\undefined
2868 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2869 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2870 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2875 % @settitle line... specifies the title of the document, for headings.
2876 % It generates no output of its own.
2877 \def\thistitle{\putwordNoTitle}
2878 \def\settitle{\parsearg{\gdef\thistitle}}
2882 % Tables -- @table, @ftable, @vtable, @item(x).
2884 % default indentation of table text
2885 \newdimen\tableindent \tableindent=.8in
2886 % default indentation of @itemize and @enumerate text
2887 \newdimen\itemindent \itemindent=.3in
2888 % margin between end of table item and start of table text.
2889 \newdimen\itemmargin \itemmargin=.1in
2891 % used internally for \itemindent minus \itemmargin
2894 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2896 % They also define \itemindex
2897 % to index the item name in whatever manner is desired (perhaps none).
2899 \newif\ifitemxneedsnegativevskip
2901 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2903 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2904 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2906 \def\itemzzz #1{\begingroup %
2907 \advance\hsize by -\rightskip
2908 \advance\hsize by -\tableindent
2909 \setbox0=\hbox{\itemindicate{#1}}%
2911 \nobreak % This prevents a break before @itemx.
2913 % If the item text does not fit in the space we have, put it on a line
2914 % by itself, and do not allow a page break either before or after that
2915 % line. We do not start a paragraph here because then if the next
2916 % command is, e.g., @kindex, the whatsit would get put into the
2917 % horizontal list on a line by itself, resulting in extra blank space.
2918 \ifdim \wd0>\itemmax
2920 % Make this a paragraph so we get the \parskip glue and wrapping,
2921 % but leave it ragged-right.
2923 \advance\leftskip by-\tableindent
2924 \advance\hsize by\tableindent
2925 \advance\rightskip by0pt plus1fil
2926 \leavevmode\unhbox0\par
2929 % We're going to be starting a paragraph, but we don't want the
2930 % \parskip glue -- logically it's part of the @item we just started.
2931 \nobreak \vskip-\parskip
2933 % Stop a page break at the \parskip glue coming up. However, if
2934 % what follows is an environment such as @example, there will be no
2935 % \parskip glue; then the negative vskip we just inserted would
2936 % cause the example and the item to crash together. So we use this
2937 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2938 % \parskip glue after all. Section titles are handled this way also.
2942 \itemxneedsnegativevskipfalse
2944 % The item text fits into the space. Start a paragraph, so that the
2945 % following text (if any) will end up on the same line.
2947 % Do this with kerns and \unhbox so that if there is a footnote in
2948 % the item text, it can migrate to the main vertical list and
2949 % eventually be printed.
2950 \nobreak\kern-\tableindent
2951 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2953 \nobreak\kern\dimen0
2955 \itemxneedsnegativevskiptrue
2959 \def\item{\errmessage{@item while not in a list environment}}
2960 \def\itemx{\errmessage{@itemx while not in a list environment}}
2962 % @table, @ftable, @vtable.
2964 \let\itemindex\gobble
2968 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2969 \tablecheck{ftable}%
2972 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2973 \tablecheck{vtable}%
2976 \ifnum \the\catcode`\^^M=\active
2978 \errmessage{This command won't work in this context; perhaps the problem is
2979 that we are \inenvironment\thisenv}%
2980 \def\next{\doignore{#1}}%
2987 \def\itemindicate{#1}%
2992 \makevalueexpandable
2993 \edef\temp{\noexpand\tablez #1\space\space\space}%
2997 \def\tablez #1 #2 #3 #4\endtablez{%
2999 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3000 \ifnum 0#2>0 \tableindent=#2\mil \fi
3001 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3002 \itemmax=\tableindent
3003 \advance \itemmax by -\itemmargin
3004 \advance \leftskip by \tableindent
3005 \exdentamount=\tableindent
3007 \parskip = \smallskipamount
3008 \ifdim \parskip=0pt \parskip=2pt \fi
3009 \let\item = \internalBitem
3010 \let\itemx = \internalBitemx
3012 \def\Etable{\endgraf\afterenvbreak}
3015 \let\Eitemize\Etable
3016 \let\Eenumerate\Etable
3018 % This is the counter used by @enumerate, which is really @itemize
3022 \envdef\itemize{\parsearg\doitemize}
3026 \itemmax=\itemindent
3027 \advance\itemmax by -\itemmargin
3028 \advance\leftskip by \itemindent
3029 \exdentamount=\itemindent
3031 \parskip=\smallskipamount
3032 \ifdim\parskip=0pt \parskip=2pt \fi
3033 \def\itemcontents{#1}%
3034 % @itemize with no arg is equivalent to @itemize @bullet.
3035 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3036 \let\item=\itemizeitem
3039 % Definition of @item while inside @itemize and @enumerate.
3042 \advance\itemno by 1 % for enumerations
3043 {\let\par=\endgraf \smallbreak}% reasonable place to break
3045 % If the document has an @itemize directly after a section title, a
3046 % \nobreak will be last on the list, and \sectionheading will have
3047 % done a \vskip-\parskip. In that case, we don't want to zero
3048 % parskip, or the item text will crash with the heading. On the
3049 % other hand, when there is normal text preceding the item (as there
3050 % usually is), we do want to zero parskip, or there would be too much
3051 % space. In that case, we won't have a \nobreak before. At least
3052 % that's the theory.
3053 \ifnum\lastpenalty<10000 \parskip=0in \fi
3055 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3056 \vadjust{\penalty 1200}}% not good to break after first line of item.
3060 % \splitoff TOKENS\endmark defines \first to be the first token in
3061 % TOKENS, and \rest to be the remainder.
3063 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3065 % Allow an optional argument of an uppercase letter, lowercase letter,
3066 % or number, to specify the first label in the enumerated list. No
3067 % argument is the same as `1'.
3069 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3070 \def\enumeratey #1 #2\endenumeratey{%
3071 % If we were given no argument, pretend we were given `1'.
3073 \ifx\thearg\empty \def\thearg{1}\fi
3075 % Detect if the argument is a single token. If so, it might be a
3076 % letter. Otherwise, the only valid thing it can be is a number.
3077 % (We will always have one token, because of the test we just made.
3078 % This is a good thing, since \splitoff doesn't work given nothing at
3079 % all -- the first parameter is undelimited.)
3080 \expandafter\splitoff\thearg\endmark
3082 % Only one token in the argument. It could still be anything.
3083 % A ``lowercase letter'' is one whose \lccode is nonzero.
3084 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3085 % not equal to itself.
3086 % Otherwise, we assume it's a number.
3088 % We need the \relax at the end of the \ifnum lines to stop TeX from
3089 % continuing to look for a <number>.
3091 \ifnum\lccode\expandafter`\thearg=0\relax
3092 \numericenumerate % a number (we hope)
3095 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3096 \lowercaseenumerate % lowercase letter
3098 \uppercaseenumerate % uppercase letter
3102 % Multiple tokens in the argument. We hope it's a number.
3107 % An @enumerate whose labels are integers. The starting integer is
3110 \def\numericenumerate{%
3112 \startenumeration{\the\itemno}%
3115 % The starting (lowercase) letter is in \thearg.
3116 \def\lowercaseenumerate{%
3117 \itemno = \expandafter`\thearg
3119 % Be sure we're not beyond the end of the alphabet.
3121 \errmessage{No more lowercase letters in @enumerate; get a bigger
3128 % The starting (uppercase) letter is in \thearg.
3129 \def\uppercaseenumerate{%
3130 \itemno = \expandafter`\thearg
3132 % Be sure we're not beyond the end of the alphabet.
3134 \errmessage{No more uppercase letters in @enumerate; get a bigger
3141 % Call \doitemize, adding a period to the first argument and supplying the
3142 % common last two arguments. Also subtract one from the initial value in
3143 % \itemno, since @item increments \itemno.
3145 \def\startenumeration#1{%
3146 \advance\itemno by -1
3147 \doitemize{#1.}\flushcr
3150 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3153 \def\alphaenumerate{\enumerate{a}}
3154 \def\capsenumerate{\enumerate{A}}
3155 \def\Ealphaenumerate{\Eenumerate}
3156 \def\Ecapsenumerate{\Eenumerate}
3159 % @multitable macros
3160 % Amy Hendrickson, 8/18/94, 3/6/96
3162 % @multitable ... @end multitable will make as many columns as desired.
3163 % Contents of each column will wrap at width given in preamble. Width
3164 % can be specified either with sample text given in a template line,
3165 % or in percent of \hsize, the current width of text on page.
3167 % Table can continue over pages but will only break between lines.
3171 % Either define widths of columns in terms of percent of \hsize:
3172 % @multitable @columnfractions .25 .3 .45
3175 % Numbers following @columnfractions are the percent of the total
3176 % current hsize to be used for each column. You may use as many
3177 % columns as desired.
3180 % Or use a template:
3181 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3183 % using the widest term desired in each column.
3185 % Each new table line starts with @item, each subsequent new column
3186 % starts with @tab. Empty columns may be produced by supplying @tab's
3187 % with nothing between them for as many times as empty columns are needed,
3188 % ie, @tab@tab@tab will produce two empty columns.
3190 % @item, @tab do not need to be on their own lines, but it will not hurt
3193 % Sample multitable:
3195 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3196 % @item first col stuff @tab second col stuff @tab third col
3203 % @item first col stuff @tab second col stuff
3204 % @tab Many paragraphs of text may be used in any column.
3206 % They will wrap at the width determined by the template.
3207 % @item@tab@tab This will be in third column.
3210 % Default dimensions may be reset by user.
3211 % @multitableparskip is vertical space between paragraphs in table.
3212 % @multitableparindent is paragraph indent in table.
3213 % @multitablecolmargin is horizontal space to be left between columns.
3214 % @multitablelinespace is space to leave between table items, baseline
3216 % 0pt means it depends on current normal line spacing.
3218 \newskip\multitableparskip
3219 \newskip\multitableparindent
3220 \newdimen\multitablecolspace
3221 \newskip\multitablelinespace
3222 \multitableparskip=0pt
3223 \multitableparindent=6pt
3224 \multitablecolspace=12pt
3225 \multitablelinespace=0pt
3227 % Macros used to set up halign preamble:
3229 \let\endsetuptable\relax
3230 \def\xendsetuptable{\endsetuptable}
3231 \let\columnfractions\relax
3232 \def\xcolumnfractions{\columnfractions}
3235 % #1 is the @columnfraction, usually a decimal number like .5, but might
3236 % be just 1. We just use it, whatever it is.
3238 \def\pickupwholefraction#1 {%
3239 \global\advance\colcount by 1
3240 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3247 \ifx\firstarg\xendsetuptable
3250 \ifx\firstarg\xcolumnfractions
3251 \global\setpercenttrue
3254 \let\go\pickupwholefraction
3256 \global\advance\colcount by 1
3257 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3258 % separator; typically that is always in the input, anyway.
3259 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3262 \ifx\go\pickupwholefraction
3263 % Put the argument back for the \pickupwholefraction call, so
3264 % we'll always have a period there to be parsed.
3265 \def\go{\pickupwholefraction#1}%
3267 \let\go = \setuptable
3273 % multitable-only commands.
3275 % @headitem starts a heading row, which we typeset in bold.
3276 % Assignments have to be global since we are inside the implicit group
3277 % of an alignment entry. Note that \everycr resets \everytab.
3278 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3280 % A \tab used to include \hskip1sp. But then the space in a template
3281 % line is not enough. That is bad. So let's go back to just `&' until
3282 % we encounter the problem it was intended to solve again.
3283 % --karl, nathan@acm.org, 20apr99.
3284 \def\tab{\checkenv\multitable &\the\everytab}%
3286 % @multitable ... @end multitable definitions:
3288 \newtoks\everytab % insert after every tab.
3290 \envdef\multitable{%
3294 % @item within a multitable starts a normal row.
3295 % We use \def instead of \let so that if one of the multitable entries
3296 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3297 % \endtemplate) expanding \doitemize.
3302 \setmultitablespacing
3303 \parskip=\multitableparskip
3304 \parindent=\multitableparindent
3310 \global\everytab={}%
3311 \global\colcount=0 % Reset the column counter.
3312 % Check for saved footnotes, etc.
3314 % Keeps underfull box messages off when table breaks over pages.
3316 % Maybe so, but it also creates really weird page breaks when the
3317 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3318 % problem manifests itself, so it can be fixed for real --karl.
3322 \parsearg\domultitable
3324 \def\domultitable#1{%
3325 % To parse everything between @multitable and @item:
3326 \setuptable#1 \endsetuptable
3328 % This preamble sets up a generic column definition, which will
3329 % be used as many times as user calls for columns.
3330 % \vtop will set a single line and will also let text wrap and
3331 % continue for many paragraphs if desired.
3333 \global\advance\colcount by 1
3336 % Use the current \colcount to find the correct column width:
3337 \hsize=\expandafter\csname col\the\colcount\endcsname
3339 % In order to keep entries from bumping into each other
3340 % we will add a \leftskip of \multitablecolspace to all columns after
3343 % If a template has been used, we will add \multitablecolspace
3344 % to the width of each template entry.
3346 % If the user has set preamble in terms of percent of \hsize we will
3347 % use that dimension as the width of the column, and the \leftskip
3348 % will keep entries from bumping into each other. Table will start at
3349 % left margin and final column will justify at right margin.
3351 % Make sure we don't inherit \rightskip from the outer environment.
3354 % The first column will be indented with the surrounding text.
3355 \advance\hsize by\leftskip
3358 % If user has not set preamble in terms of percent of \hsize
3359 % we will advance \hsize by \multitablecolspace.
3360 \advance\hsize by \multitablecolspace
3362 % In either case we will make \leftskip=\multitablecolspace:
3363 \leftskip=\multitablecolspace
3365 % Ignoring space at the beginning and end avoids an occasional spurious
3366 % blank line, when TeX decides to break the line at the space before the
3367 % box from the multistrut, so the strut ends up on a line by itself.
3369 % @multitable @columnfractions .11 .89
3371 % @tab Legal holiday which is valid in major parts of the whole country.
3372 % Is automatically provided with highlighting sequences respectively
3373 % marking characters.
3374 \noindent\ignorespaces##\unskip\multistrut
3379 \egroup % end the \halign
3380 \global\setpercentfalse
3383 \def\setmultitablespacing{%
3384 \def\multistrut{\strut}% just use the standard line spacing
3386 % Compute \multitablelinespace (if not defined by user) for use in
3387 % \multitableparskip calculation. We used define \multistrut based on
3388 % this, but (ironically) that caused the spacing to be off.
3389 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3390 \ifdim\multitablelinespace=0pt
3391 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3392 \global\advance\multitablelinespace by-\ht0
3394 %% Test to see if parskip is larger than space between lines of
3395 %% table. If not, do nothing.
3396 %% If so, set to same dimension as multitablelinespace.
3397 \ifdim\multitableparskip>\multitablelinespace
3398 \global\multitableparskip=\multitablelinespace
3399 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3400 %% than skip between lines in the table.
3402 \ifdim\multitableparskip=0pt
3403 \global\multitableparskip=\multitablelinespace
3404 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3405 %% than skip between lines in the table.
3409 \message{conditionals,}
3411 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3412 % @ifnotxml always succeed. They currently do nothing; we don't
3413 % attempt to check whether the conditionals are properly nested. But we
3414 % have to remember that they are conditionals, so that @end doesn't
3415 % attempt to close an environment group.
3418 \expandafter\let\csname #1\endcsname = \relax
3419 \expandafter\let\csname iscond.#1\endcsname = 1
3422 \makecond{ifnotdocbook}
3423 \makecond{ifnothtml}
3424 \makecond{ifnotinfo}
3425 \makecond{ifnotplaintext}
3428 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3430 \def\direntry{\doignore{direntry}}
3431 \def\documentdescription{\doignore{documentdescription}}
3432 \def\docbook{\doignore{docbook}}
3433 \def\html{\doignore{html}}
3434 \def\ifdocbook{\doignore{ifdocbook}}
3435 \def\ifhtml{\doignore{ifhtml}}
3436 \def\ifinfo{\doignore{ifinfo}}
3437 \def\ifnottex{\doignore{ifnottex}}
3438 \def\ifplaintext{\doignore{ifplaintext}}
3439 \def\ifxml{\doignore{ifxml}}
3440 \def\ignore{\doignore{ignore}}
3441 \def\menu{\doignore{menu}}
3442 \def\xml{\doignore{xml}}
3444 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3446 % A count to remember the depth of nesting.
3447 \newcount\doignorecount
3449 \def\doignore#1{\begingroup
3450 % Scan in ``verbatim'' mode:
3452 \catcode`\@ = \other
3453 \catcode`\{ = \other
3454 \catcode`\} = \other
3456 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3459 % Count number of #1's that we've seen.
3462 % Swallow text until we reach the matching `@end #1'.
3466 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3469 \gdef\dodoignore#1{%
3470 % #1 contains the command name as a string, e.g., `ifinfo'.
3472 % Define a command to find the next `@end #1'.
3473 \long\def\doignoretext##1^^M@end #1{%
3474 \doignoretextyyy##1^^M@#1\_STOP_}%
3476 % And this command to find another #1 command, at the beginning of a
3477 % line. (Otherwise, we would consider a line `@c @ifset', for
3478 % example, to count as an @ifset for nesting.)
3479 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3481 % And now expand that command.
3486 \def\doignoreyyy#1{%
3488 \ifx\temp\empty % Nothing found.
3489 \let\next\doignoretextzzz
3490 \else % Found a nested condition, ...
3491 \advance\doignorecount by 1
3492 \let\next\doignoretextyyy % ..., look for another.
3493 % If we're here, #1 ends with ^^M\ifinfo (for example).
3495 \next #1% the token \_STOP_ is present just after this macro.
3498 % We have to swallow the remaining "\_STOP_".
3500 \def\doignoretextzzz#1{%
3501 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3502 \let\next\enddoignore
3503 \else % Still inside a nested condition.
3504 \advance\doignorecount by -1
3505 \let\next\doignoretext % Look for the next @end.
3510 % Finish off ignored text.
3512 % Ignore anything after the last `@end #1'; this matters in verbatim
3513 % environments, where otherwise the newline after an ignored conditional
3514 % would result in a blank line in the output.
3515 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3519 % @set VAR sets the variable VAR to an empty value.
3520 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3522 % Since we want to separate VAR from REST-OF-LINE (which might be
3523 % empty), we can't just use \parsearg; we have to insert a space of our
3524 % own to delimit the rest of the line, and then take it out again if we
3526 % We rely on the fact that \parsearg sets \catcode`\ =10.
3528 \parseargdef\set{\setyyy#1 \endsetyyy}
3529 \def\setyyy#1 #2\endsetyyy{%
3531 \makevalueexpandable
3533 \edef\next{\gdef\makecsname{SET#1}}%
3541 % Remove the trailing space \setxxx inserted.
3542 \def\setzzz#1 \endsetzzz{\next{#1}}
3544 % @clear VAR clears (i.e., unsets) the variable VAR.
3546 \parseargdef\clear{%
3548 \makevalueexpandable
3549 \global\expandafter\let\csname SET#1\endcsname=\relax
3553 % @value{foo} gets the text saved in variable foo.
3554 \def\value{\begingroup\makevalueexpandable\valuexxx}
3555 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3557 \catcode`\- = \active \catcode`\_ = \active
3559 \gdef\makevalueexpandable{%
3560 \let\value = \expandablevalue
3561 % We don't want these characters active, ...
3562 \catcode`\-=\other \catcode`\_=\other
3563 % ..., but we might end up with active ones in the argument if
3564 % we're called from @code, as @code{@value{foo-bar_}}, though.
3565 % So \let them to their normal equivalents.
3566 \let-\realdash \let_\normalunderscore
3570 % We have this subroutine so that we can handle at least some @value's
3571 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3572 % The command has to be fully expandable (if the variable is set), since
3573 % the result winds up in the index file. This means that if the
3574 % variable's value contains other Texinfo commands, it's almost certain
3575 % it will fail (although perhaps we could fix that with sufficient work
3576 % to do a one-level expansion on the result, instead of complete).
3578 \def\expandablevalue#1{%
3579 \expandafter\ifx\csname SET#1\endcsname\relax
3580 {[No value for ``#1'']}%
3581 \message{Variable `#1', used in @value, is not set.}%
3583 \csname SET#1\endcsname
3587 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3590 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3593 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3596 \makevalueexpandable
3598 \expandafter\ifx\csname SET#2\endcsname\relax
3599 #1% If not set, redefine \next.
3604 \def\ifsetfail{\doignore{ifset}}
3606 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3607 % defined with @set, or has been undefined with @clear.
3609 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3610 % above code: if the variable is not set, do nothing, if it is set,
3611 % then redefine \next to \ifclearfail.
3614 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3615 \def\ifclearfail{\doignore{ifclear}}
3617 % @dircategory CATEGORY -- specify a category of the dir file
3618 % which this file should belong to. Ignore this in TeX.
3619 \let\dircategory=\comment
3621 % @defininfoenclose.
3622 \let\definfoenclose=\comment
3626 % Index generation facilities
3628 % Define \newwrite to be identical to plain tex's \newwrite
3629 % except not \outer, so it can be used within macros and \if's.
3630 \edef\newwrite{\makecsname{ptexnewwrite}}
3632 % \newindex {foo} defines an index named foo.
3633 % It automatically defines \fooindex such that
3634 % \fooindex ...rest of line... puts an entry in the index foo.
3635 % It also defines \fooindfile to be the number of the output channel for
3636 % the file that accumulates this index. The file's extension is foo.
3637 % The name of an index should be no more than 2 characters long
3638 % for the sake of vms.
3642 \expandafter\newwrite \csname#1indfile\endcsname
3643 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3645 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3646 \noexpand\doindex{#1}}
3649 % @defindex foo == \newindex{foo}
3651 \def\defindex{\parsearg\newindex}
3653 % Define @defcodeindex, like @defindex except put all entries in @code.
3655 \def\defcodeindex{\parsearg\newcodeindex}
3657 \def\newcodeindex#1{%
3659 \expandafter\newwrite \csname#1indfile\endcsname
3660 \openout \csname#1indfile\endcsname \jobname.#1
3662 \expandafter\xdef\csname#1index\endcsname{%
3663 \noexpand\docodeindex{#1}}%
3667 % @synindex foo bar makes index foo feed into index bar.
3668 % Do this instead of @defindex foo if you don't want it as a separate index.
3670 % @syncodeindex foo bar similar, but put all entries made for index foo
3673 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3674 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3676 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3677 % #3 the target index (bar).
3678 \def\dosynindex#1#2#3{%
3679 % Only do \closeout if we haven't already done it, else we'll end up
3680 % closing the target index.
3681 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3682 % The \closeout helps reduce unnecessary open files; the limit on the
3683 % Acorn RISC OS is a mere 16 files.
3684 \expandafter\closeout\csname#2indfile\endcsname
3685 \expandafter\let\csname\donesynindex#2\endcsname = 1
3687 % redefine \fooindfile:
3688 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3689 \expandafter\let\csname#2indfile\endcsname=\temp
3690 % redefine \fooindex:
3691 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3694 % Define \doindex, the driver for all \fooindex macros.
3695 % Argument #1 is generated by the calling \fooindex macro,
3696 % and it is "foo", the name of the index.
3698 % \doindex just uses \parsearg; it calls \doind for the actual work.
3699 % This is because \doind is more useful to call from other macros.
3701 % There is also \dosubind {index}{topic}{subtopic}
3702 % which makes an entry in a two-level index such as the operation index.
3704 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3705 \def\singleindexer #1{\doind{\indexname}{#1}}
3707 % like the previous two, but they put @code around the argument.
3708 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3709 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3711 % Take care of Texinfo commands that can appear in an index entry.
3712 % Since there are some commands we want to expand, and others we don't,
3713 % we have to laboriously prevent expansion for those that we don't.
3716 \escapechar = `\\ % use backslash in output files.
3717 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3718 \def\ {\realbackslash\space }%
3720 % Need these in case \tex is in effect and \{ is a \delimiter again.
3721 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3722 % braces and backslashes are used only as delimiters.
3726 % I don't entirely understand this, but when an index entry is
3727 % generated from a macro call, the \endinput which \scanmacro inserts
3728 % causes processing to be prematurely terminated. This is,
3729 % apparently, because \indexsorttmp is fully expanded, and \endinput
3730 % is an expandable command. The redefinition below makes \endinput
3731 % disappear altogether for that purpose -- although logging shows that
3732 % processing continues to some further point. On the other hand, it
3733 % seems \endinput does not hurt in the printed index arg, since that
3734 % is still getting written without apparent harm.
3736 % Sample source (mac-idx3.tex, reported by Graham Percival to
3737 % help-texinfo, 22may06):
3738 % @macro funindex {WORD}
3742 % @funindex commtest
3744 % The above is not enough to reproduce the bug, but it gives the flavor.
3746 % Sample whatsit resulting:
3747 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3750 \let\endinput = \empty
3752 % Do the redefinitions.
3756 % For the aux and toc files, @ is the escape character. So we want to
3757 % redefine everything using @ as the escape character (instead of
3758 % \realbackslash, still used for index files). When everything uses @,
3759 % this will be simpler.
3764 \let\{ = \lbraceatcmd
3765 \let\} = \rbraceatcmd
3767 % Do the redefinitions.
3772 % Called from \indexdummies and \atdummies.
3774 \def\commondummies{%
3776 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3777 % preventing its expansion. This is used only for control% words,
3778 % not control letters, because the \space would be incorrect for
3779 % control characters, but is needed to separate the control word
3780 % from whatever follows.
3782 % For control letters, we have \definedummyletter, which omits the
3785 % These can be used both for control words that take an argument and
3786 % those that do not. If it is followed by {arg} in the input, then
3787 % that will dutifully get written to the index (or wherever).
3789 \def\definedummyword ##1{\def##1{\string##1\space}}%
3790 \def\definedummyletter##1{\def##1{\string##1}}%
3791 \let\definedummyaccent\definedummyletter
3793 \commondummiesnofonts
3795 \definedummyletter\_%
3797 % Non-English letters.
3809 \definedummyword\exclamdown
3810 \definedummyword\questiondown
3811 \definedummyword\ordf
3812 \definedummyword\ordm
3814 % Although these internal commands shouldn't show up, sometimes they do.
3816 \definedummyword\gtr
3817 \definedummyword\hat
3818 \definedummyword\less
3821 \definedummyword\tclose
3824 \definedummyword\LaTeX
3825 \definedummyword\TeX
3827 % Assorted special characters.
3828 \definedummyword\bullet
3829 \definedummyword\comma
3830 \definedummyword\copyright
3831 \definedummyword\registeredsymbol
3832 \definedummyword\dots
3833 \definedummyword\enddots
3834 \definedummyword\equiv
3835 \definedummyword\error
3836 \definedummyword\euro
3837 \definedummyword\expansion
3838 \definedummyword\minus
3839 \definedummyword\pounds
3840 \definedummyword\point
3841 \definedummyword\print
3842 \definedummyword\result
3843 \definedummyword\textdegree
3845 % We want to disable all macros so that they are not expanded by \write.
3848 \normalturnoffactive
3850 % Handle some cases of @value -- where it does not contain any
3851 % (non-fully-expandable) commands.
3852 \makevalueexpandable
3855 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3857 \def\commondummiesnofonts{%
3858 % Control letters and accents.
3859 \definedummyletter\!%
3860 \definedummyaccent\"%
3861 \definedummyaccent\'%
3862 \definedummyletter\*%
3863 \definedummyaccent\,%
3864 \definedummyletter\.%
3865 \definedummyletter\/%
3866 \definedummyletter\:%
3867 \definedummyaccent\=%
3868 \definedummyletter\?%
3869 \definedummyaccent\^%
3870 \definedummyaccent\`%
3871 \definedummyaccent\~%
3875 \definedummyword\dotaccent
3876 \definedummyword\ringaccent
3877 \definedummyword\tieaccent
3878 \definedummyword\ubaraccent
3879 \definedummyword\udotaccent
3880 \definedummyword\dotless
3882 % Texinfo font commands.
3889 % Commands that take arguments.
3890 \definedummyword\acronym
3891 \definedummyword\cite
3892 \definedummyword\code
3893 \definedummyword\command
3894 \definedummyword\dfn
3895 \definedummyword\emph
3896 \definedummyword\env
3897 \definedummyword\file
3898 \definedummyword\kbd
3899 \definedummyword\key
3900 \definedummyword\math
3901 \definedummyword\option
3902 \definedummyword\pxref
3903 \definedummyword\ref
3904 \definedummyword\samp
3905 \definedummyword\strong
3906 \definedummyword\tie
3907 \definedummyword\uref
3908 \definedummyword\url
3909 \definedummyword\var
3910 \definedummyword\verb
3912 \definedummyword\xref
3915 % \indexnofonts is used when outputting the strings to sort the index
3916 % by, and when constructing control sequence names. It eliminates all
3917 % control sequences and just writes whatever the best ASCII sort string
3918 % would be for a given command (usually its argument).
3921 % Accent commands should become @asis.
3922 \def\definedummyaccent##1{\let##1\asis}%
3923 % We can just ignore other control letters.
3924 \def\definedummyletter##1{\let##1\empty}%
3925 % Hopefully, all control words can become @asis.
3926 \let\definedummyword\definedummyaccent
3928 \commondummiesnofonts
3930 % Don't no-op \tt, since it isn't a user-level command
3931 % and is used in the definitions of the active chars like <, >, |, etc.
3932 % Likewise with the other plain tex font commands.
3937 % how to handle braces?
3938 \def\_{\normalunderscore}%
3940 % Non-English letters.
3953 \def\questiondown{?}%
3960 % Assorted special characters.
3961 % (The following {} will end up in the sort string, but that's ok.)
3962 \def\bullet{bullet}%
3964 \def\copyright{copyright}%
3965 \def\registeredsymbol{R}%
3971 \def\expansion{==>}%
3973 \def\pounds{pounds}%
3977 \def\textdegree{degrees}%
3979 % We need to get rid of all macros, leaving only the arguments (if present).
3980 % Of course this is not nearly correct, but it is the best we can do for now.
3981 % makeinfo does not expand macros in the argument to @deffn, which ends up
3982 % writing an index entry, and texindex isn't prepared for an index sort entry
3983 % that starts with \.
3985 % Since macro invocations are followed by braces, we can just redefine them
3986 % to take a single TeX argument. The case of a macro invocation that
3987 % goes to end-of-line is not handled.
3992 \let\indexbackslash=0 %overridden during \printindex.
3993 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3995 % Most index entries go through here, but \dosubind is the general case.
3996 % #1 is the index name, #2 is the entry text.
3997 \def\doind#1#2{\dosubind{#1}{#2}{}}
3999 % Workhorse for all \fooindexes.
4000 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4001 % empty if called from \doind, as we usually are (the main exception
4002 % is with most defuns, which call us directly).
4004 \def\dosubind#1#2#3{%
4007 % Store the main index entry text (including the third arg).
4009 % If third arg is present, precede it with a space.
4011 \ifx\thirdarg\empty \else
4012 \toks0 = \expandafter{\the\toks0 \space #3}%
4015 \edef\writeto{\csname#1indfile\endcsname}%
4017 \safewhatsit\dosubindwrite
4022 % Write the entry in \toks0 to the index file:
4024 \def\dosubindwrite{%
4025 % Put the index entry in the margin if desired.
4026 \ifx\SETmarginindex\relax\else
4027 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4030 % Remember, we are within a group.
4031 \indexdummies % Must do this here, since \bf, etc expand at this stage
4032 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4033 % so it will be output as is; and it will print as backslash.
4035 % Process the index entry with all font commands turned off, to
4036 % get the string to sort by.
4038 \edef\temp{\the\toks0}% need full expansion
4039 \xdef\indexsorttmp{\temp}%
4042 % Set up the complete index entry, with both the sort key and
4043 % the original text, including any font commands. We write
4044 % three arguments to \entry to the .?? file (four in the
4045 % subentry case), texindex reduces to two when writing the .??s
4049 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4054 % Take care of unwanted page breaks/skips around a whatsit:
4056 % If a skip is the last thing on the list now, preserve it
4057 % by backing up by \lastskip, doing the \write, then inserting
4058 % the skip again. Otherwise, the whatsit generated by the
4059 % \write or \pdfdest will make \lastskip zero. The result is that
4060 % sequences like this:
4064 % will have extra space inserted, because the \medbreak in the
4065 % start of the @defun won't see the skip inserted by the @end of
4066 % the previous defun.
4068 % But don't do any of this if we're not in vertical mode. We
4069 % don't want to do a \vskip and prematurely end a paragraph.
4071 % Avoid page breaks due to these extra skips, too.
4073 % But wait, there is a catch there:
4074 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4075 % sufficient for this purpose, as it ignores stretch and shrink parts
4076 % of the skip. The only way seems to be to check the textual
4077 % representation of the skip.
4079 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4080 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4082 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4084 \newskip\whatsitskip
4085 \newcount\whatsitpenalty
4089 \def\safewhatsit#1{%
4093 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4094 \whatsitskip = \lastskip
4095 \edef\lastskipmacro{\the\lastskip}%
4096 \whatsitpenalty = \lastpenalty
4098 % If \lastskip is nonzero, that means the last item was a
4099 % skip. And since a skip is discardable, that means this
4100 % -\skip0 glue we're inserting is preceded by a
4101 % non-discardable item, therefore it is not a potential
4102 % breakpoint, therefore no \nobreak needed.
4103 \ifx\lastskipmacro\zeroskipmacro
4110 \ifx\lastskipmacro\zeroskipmacro
4111 % If \lastskip was zero, perhaps the last item was a penalty, and
4112 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4113 % to re-insert the same penalty (values >10000 are used for various
4114 % signals); since we just inserted a non-discardable item, any
4115 % following glue (such as a \parskip) would be a breakpoint. For example:
4117 % @deffn deffn-whatever
4118 % @vindex index-whatever
4120 % would allow a break between the index-whatever whatsit
4121 % and the "Description." paragraph.
4122 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4124 % On the other hand, if we had a nonzero \lastskip,
4125 % this make-up glue would be preceded by a non-discardable item
4126 % (the whatsit from the \write), so we must insert a \nobreak.
4127 \nobreak\vskip\whatsitskip
4132 % The index entry written in the file actually looks like
4133 % \entry {sortstring}{page}{topic}
4135 % \entry {sortstring}{page}{topic}{subtopic}
4136 % The texindex program reads in these files and writes files
4137 % containing these kinds of lines:
4139 % before the first topic whose initial is c
4140 % \entry {topic}{pagelist}
4141 % for a topic that is used without subtopics
4143 % for the beginning of a topic that is used with subtopics
4144 % \secondary {subtopic}{pagelist}
4145 % for each subtopic.
4147 % Define the user-accessible indexing commands
4148 % @findex, @vindex, @kindex, @cindex.
4150 \def\findex {\fnindex}
4151 \def\kindex {\kyindex}
4152 \def\cindex {\cpindex}
4153 \def\vindex {\vrindex}
4154 \def\tindex {\tpindex}
4155 \def\pindex {\pgindex}
4157 \def\cindexsub {\begingroup\obeylines\cindexsub}
4159 \gdef\cindexsub "#1" #2^^M{\endgroup %
4160 \dosubind{cp}{#2}{#1}}}
4162 % Define the macros used in formatting output of the sorted index material.
4164 % @printindex causes a particular index (the ??s file) to get printed.
4165 % It does not print any chapter heading (usually an @unnumbered).
4167 \parseargdef\printindex{\begingroup
4168 \dobreak \chapheadingskip{10000}%
4173 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4175 % See if the index file exists and is nonempty.
4176 % Change catcode of @ here so that if the index file contains
4178 % as its first line, TeX doesn't complain about mismatched braces
4179 % (because it thinks @} is a control sequence).
4181 \openin 1 \jobname.#1s
4183 % \enddoublecolumns gets confused if there is no text in the index,
4184 % and it loses the chapter title and the aux file entries for the
4185 % index. The easiest way to prevent this problem is to make sure
4186 % there is some text.
4187 \putwordIndexNonexistent
4190 % If the index file exists but is empty, then \openin leaves \ifeof
4191 % false. We have to make TeX try to read something from the file, so
4192 % it can discover if there is anything in it.
4195 \putwordIndexIsEmpty
4197 % Index files are almost Texinfo source, but we use \ as the escape
4198 % character. It would be better to use @, but that's too big a change
4199 % to make right now.
4200 \def\indexbackslash{\backslashcurfont}%
4211 % These macros are used by the sorted index file itself.
4212 % Change them to control the appearance of the index.
4215 % Some minor font changes for the special characters.
4216 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4218 % Remove any glue we may have, we'll be inserting our own.
4221 % We like breaks before the index initials, so insert a bonus.
4223 \vskip 0pt plus 3\baselineskip
4225 \vskip 0pt plus -3\baselineskip
4227 % Typeset the initial. Making this add up to a whole number of
4228 % baselineskips increases the chance of the dots lining up from column
4229 % to column. It still won't often be perfect, because of the stretch
4230 % we need before each entry, but it's better.
4232 % No shrink because it confuses \balancecolumns.
4233 \vskip 1.67\baselineskip plus .5\baselineskip
4234 \leftline{\secbf #1}%
4235 % Do our best not to break after the initial.
4237 \vskip .33\baselineskip plus .1\baselineskip
4240 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4241 % then page number (#2) flushed to the right margin. It is used for index
4242 % and table of contents entries. The paragraph is indented by \leftskip.
4244 % A straightforward implementation would start like this:
4245 % \def\entry#1#2{...
4246 % But this frozes the catcodes in the argument, and can cause problems to
4247 % @code, which sets - active. This problem was fixed by a kludge---
4248 % ``-'' was active throughout whole index, but this isn't really right.
4250 % The right solution is to prevent \entry from swallowing the whole text.
4255 % Start a new paragraph if necessary, so our assignments below can't
4256 % affect previous text.
4259 % Do not fill out the last line with white space.
4262 % No extra space above this paragraph.
4265 % Do not prefer a separate line ending with a hyphen to fewer lines.
4266 \finalhyphendemerits = 0
4268 % \hangindent is only relevant when the entry text and page number
4269 % don't both fit on one line. In that case, bob suggests starting the
4270 % dots pretty far over on the line. Unfortunately, a large
4271 % indentation looks wrong when the entry text itself is broken across
4272 % lines. So we use a small indentation and put up with long leaders.
4274 % \hangafter is reset to 1 (which is the value we want) at the start
4275 % of each paragraph, so we need not do anything with that.
4278 % When the entry text needs to be broken, just fill out the first line
4280 \rightskip = 0pt plus1fil
4282 % A bit of stretch before each entry for the benefit of balancing
4286 % Swallow the left brace of the text (first parameter):
4287 \afterassignment\doentry
4291 \bgroup % Instead of the swallowed brace.
4293 \aftergroup\finishentry
4294 % And now comes the text of the entry.
4296 \def\finishentry#1{%
4297 % #1 is the page number.
4299 % The following is kludged to not output a line of dots in the index if
4300 % there are no page numbers. The next person who breaks this will be
4301 % cursed by a Unix daemon.
4302 \setbox\boxA = \hbox{#1}%
4303 \ifdim\wd\boxA = 0pt
4307 % If we must, put the page number on a line of its own, and fill out
4308 % this line with blank space. (The \hfil is overwhelmed with the
4309 % fill leaders glue in \indexdotfill if the page number does fit.)
4311 \null\nobreak\indexdotfill % Have leaders before the page number.
4313 % The `\ ' here is removed by the implicit \unskip that TeX does as
4314 % part of (the primitive) \par. Without it, a spurious underfull
4327 % Like plain.tex's \dotfill, except uses up at least 1 em.
4328 \def\indexdotfill{\cleaders
4329 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4331 \def\primary #1{\line{#1\hfil}}
4333 \newskip\secondaryindent \secondaryindent=0.5cm
4334 \def\secondary#1#2{{%
4339 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4341 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4348 % Define two-column mode, which we use to typeset indexes.
4349 % Adapted from the TeXbook, page 416, which is to say,
4350 % the manmac.tex format used to print the TeXbook itself.
4354 \newdimen\doublecolumnhsize
4356 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4357 % Grab any single-column material above us.
4360 % Here is a possibility not foreseen in manmac: if we accumulate a
4361 % whole lot of material, we might end up calling this \output
4362 % routine twice in a row (see the doublecol-lose test, which is
4363 % essentially a couple of indexes with @setchapternewpage off). In
4364 % that case we just ship out what is in \partialpage with the normal
4365 % output routine. Generally, \partialpage will be empty when this
4366 % runs and this will be a no-op. See the indexspread.tex test case.
4367 \ifvoid\partialpage \else
4368 \onepageout{\pagecontents\partialpage}%
4371 \global\setbox\partialpage = \vbox{%
4372 % Unvbox the main output page.
4374 \kern-\topskip \kern\baselineskip
4377 \eject % run that output routine to set \partialpage
4379 % Use the double-column output routine for subsequent pages.
4380 \output = {\doublecolumnout}%
4382 % Change the page size parameters. We could do this once outside this
4383 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4384 % format, but then we repeat the same computation. Repeating a couple
4385 % of assignments once per index is clearly meaningless for the
4386 % execution time, so we may as well do it in one place.
4388 % First we halve the line length, less a little for the gutter between
4389 % the columns. We compute the gutter based on the line length, so it
4390 % changes automatically with the paper format. The magic constant
4391 % below is chosen so that the gutter has the same value (well, +-<1pt)
4392 % as it did when we hard-coded it.
4394 % We put the result in a separate register, \doublecolumhsize, so we
4395 % can restore it in \pagesofar, after \hsize itself has (potentially)
4398 \doublecolumnhsize = \hsize
4399 \advance\doublecolumnhsize by -.04154\hsize
4400 \divide\doublecolumnhsize by 2
4401 \hsize = \doublecolumnhsize
4403 % Double the \vsize as well. (We don't need a separate register here,
4404 % since nobody clobbers \vsize.)
4408 % The double-column output routine for all double-column pages except
4411 \def\doublecolumnout{%
4412 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4413 % Get the available space for the double columns -- the normal
4414 % (undoubled) page height minus any material left over from the
4418 \advance\dimen@ by -\ht\partialpage
4420 % box0 will be the left-hand column, box2 the right.
4421 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4422 \onepageout\pagesofar
4424 \penalty\outputpenalty
4427 % Re-output the contents of the output page -- any previous material,
4428 % followed by the two boxes we just split, in box0 and box2.
4432 \hsize = \doublecolumnhsize
4433 \wd0=\hsize \wd2=\hsize
4434 \hbox to\pagewidth{\box0\hfil\box2}%
4437 % All done with double columns.
4438 \def\enddoublecolumns{%
4439 % The following penalty ensures that the page builder is exercised
4440 % _before_ we change the output routine. This is necessary in the
4441 % following situation:
4443 % The last section of the index consists only of a single entry.
4444 % Before this section, \pagetotal is less than \pagegoal, so no
4445 % break occurs before the last section starts. However, the last
4446 % section, consisting of \initial and the single \entry, does not
4447 % fit on the page and has to be broken off. Without the following
4448 % penalty the page builder will not be exercised until \eject
4449 % below, and by that time we'll already have changed the output
4450 % routine to the \balancecolumns version, so the next-to-last
4451 % double-column page will be processed with \balancecolumns, which
4452 % is wrong: The two columns will go to the main vertical list, with
4453 % the broken-off section in the recent contributions. As soon as
4454 % the output routine finishes, TeX starts reconsidering the page
4455 % break. The two columns and the broken-off section both fit on the
4456 % page, because the two columns now take up only half of the page
4457 % goal. When TeX sees \eject from below which follows the final
4458 % section, it invokes the new output routine that we've set after
4459 % \balancecolumns below; \onepageout will try to fit the two columns
4460 % and the final section into the vbox of \pageheight (see
4461 % \pagebody), causing an overfull box.
4463 % Note that glue won't work here, because glue does not exercise the
4464 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4468 % Split the last of the double-column material. Leave it on the
4469 % current page, no automatic page break.
4472 % If we end up splitting too much material for the current page,
4473 % though, there will be another page break right after this \output
4474 % invocation ends. Having called \balancecolumns once, we do not
4475 % want to call it again. Therefore, reset \output to its normal
4476 % definition right away. (We hope \balancecolumns will never be
4477 % called on to balance too much material, but if it is, this makes
4478 % the output somewhat more palatable.)
4479 \global\output = {\onepageout{\pagecontents\PAGE}}%
4482 \endgroup % started in \begindoublecolumns
4484 % \pagegoal was set to the doubled \vsize above, since we restarted
4485 % the current page. We're now back to normal single-column
4486 % typesetting, so reset \pagegoal to the normal \vsize (after the
4487 % \endgroup where \vsize got restored).
4491 % Called at the end of the double column material.
4492 \def\balancecolumns{%
4493 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4495 \advance\dimen@ by \topskip
4496 \advance\dimen@ by-\baselineskip
4497 \divide\dimen@ by 2 % target to split to
4498 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4499 \splittopskip = \topskip
4500 % Loop until we get a decent breakpoint.
4504 \global\setbox3 = \copy0
4505 \global\setbox1 = \vsplit3 to \dimen@
4507 \global\advance\dimen@ by 1pt
4510 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4511 \setbox0=\vbox to\dimen@{\unvbox1}%
4512 \setbox2=\vbox to\dimen@{\unvbox3}%
4516 \catcode`\@ = \other
4519 \message{sectioning,}
4520 % Chapters, sections, etc.
4522 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4523 % sections so that we can refer to them unambiguously in the pdf
4524 % outlines by their "section number". We avoid collisions with chapter
4525 % numbers by starting them at 10000. (If a document ever has 10000
4526 % chapters, we're in trouble anyway, I'm sure.)
4527 \newcount\unnumberedno \unnumberedno = 10000
4529 \newcount\secno \secno=0
4530 \newcount\subsecno \subsecno=0
4531 \newcount\subsubsecno \subsubsecno=0
4533 % This counter is funny since it counts through charcodes of letters A, B, ...
4534 \newcount\appendixno \appendixno = `\@
4536 % \def\appendixletter{\char\the\appendixno}
4537 % We do the following ugly conditional instead of the above simple
4538 % construct for the sake of pdftex, which needs the actual
4539 % letter in the expansion, not just typeset.
4541 \def\appendixletter{%
4542 \ifnum\appendixno=`A A%
4543 \else\ifnum\appendixno=`B B%
4544 \else\ifnum\appendixno=`C C%
4545 \else\ifnum\appendixno=`D D%
4546 \else\ifnum\appendixno=`E E%
4547 \else\ifnum\appendixno=`F F%
4548 \else\ifnum\appendixno=`G G%
4549 \else\ifnum\appendixno=`H H%
4550 \else\ifnum\appendixno=`I I%
4551 \else\ifnum\appendixno=`J J%
4552 \else\ifnum\appendixno=`K K%
4553 \else\ifnum\appendixno=`L L%
4554 \else\ifnum\appendixno=`M M%
4555 \else\ifnum\appendixno=`N N%
4556 \else\ifnum\appendixno=`O O%
4557 \else\ifnum\appendixno=`P P%
4558 \else\ifnum\appendixno=`Q Q%
4559 \else\ifnum\appendixno=`R R%
4560 \else\ifnum\appendixno=`S S%
4561 \else\ifnum\appendixno=`T T%
4562 \else\ifnum\appendixno=`U U%
4563 \else\ifnum\appendixno=`V V%
4564 \else\ifnum\appendixno=`W W%
4565 \else\ifnum\appendixno=`X X%
4566 \else\ifnum\appendixno=`Y Y%
4567 \else\ifnum\appendixno=`Z Z%
4568 % The \the is necessary, despite appearances, because \appendixletter is
4569 % expanded while writing the .toc file. \char\appendixno is not
4570 % expandable, thus it is written literally, thus all appendixes come out
4571 % with the same letter (or @) in the toc without it.
4572 \else\char\the\appendixno
4573 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4574 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4576 % Each @chapter defines this as the name of the chapter.
4577 % page headings and footings can use it. @section does likewise.
4578 % However, they are not reliable, because we don't use marks.
4582 \newcount\absseclevel % used to calculate proper heading level
4583 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4585 % @raisesections: treat @section as chapter, @subsection as section, etc.
4586 \def\raisesections{\global\advance\secbase by -1}
4587 \let\up=\raisesections % original BFox name
4589 % @lowersections: treat @chapter as section, @section as subsection, etc.
4590 \def\lowersections{\global\advance\secbase by 1}
4591 \let\down=\lowersections % original BFox name
4593 % we only have subsub.
4594 \chardef\maxseclevel = 3
4596 % A numbered section within an unnumbered changes to unnumbered too.
4597 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4598 \chardef\unmlevel = \maxseclevel
4600 % Trace whether the current chapter is an appendix or not:
4601 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4602 \def\chapheadtype{N}
4604 % Choose a heading macro
4605 % #1 is heading type
4606 % #2 is heading level
4607 % #3 is text for heading
4608 \def\genhead#1#2#3{%
4609 % Compute the abs. sec. level:
4611 \advance\absseclevel by \secbase
4612 % Make sure \absseclevel doesn't fall outside the range:
4613 \ifnum \absseclevel < 0
4616 \ifnum \absseclevel > 3
4623 \ifnum \absseclevel < \unmlevel
4624 \chardef\unmlevel = \absseclevel
4627 % Check for appendix sections:
4628 \ifnum \absseclevel = 0
4629 \edef\chapheadtype{\headtype}%
4631 \if \headtype A\if \chapheadtype N%
4632 \errmessage{@appendix... within a non-appendix chapter}%
4635 % Check for numbered within unnumbered:
4636 \ifnum \absseclevel > \unmlevel
4639 \chardef\unmlevel = 3
4642 % Now print the heading:
4646 \or \unnumberedseczzz{#3}%
4647 \or \unnumberedsubseczzz{#3}%
4648 \or \unnumberedsubsubseczzz{#3}%
4654 \or \appendixsectionzzz{#3}%
4655 \or \appendixsubseczzz{#3}%
4656 \or \appendixsubsubseczzz{#3}%
4662 \or \numberedsubseczzz{#3}%
4663 \or \numberedsubsubseczzz{#3}%
4667 \suppressfirstparagraphindent
4671 \def\numhead{\genhead N}
4672 \def\apphead{\genhead A}
4673 \def\unnmhead{\genhead U}
4675 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4676 % all lower-level sectioning counters to zero.
4678 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4679 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4680 \let\chaplevelprefix = \empty
4682 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4684 % section resetting is \global in case the chapter is in a group, such
4685 % as an @include file.
4686 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4687 \global\advance\chapno by 1
4690 \gdef\chaplevelprefix{\the\chapno.}%
4693 \message{\putwordChapter\space \the\chapno}%
4695 % Write the actual heading.
4696 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4698 % So @section and the like are numbered underneath this chapter.
4699 \global\let\section = \numberedsec
4700 \global\let\subsection = \numberedsubsec
4701 \global\let\subsubsection = \numberedsubsubsec
4704 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4705 \def\appendixzzz#1{%
4706 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4707 \global\advance\appendixno by 1
4708 \gdef\chaplevelprefix{\appendixletter.}%
4711 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4712 \message{\appendixnum}%
4714 \chapmacro{#1}{Yappendix}{\appendixletter}%
4716 \global\let\section = \appendixsec
4717 \global\let\subsection = \appendixsubsec
4718 \global\let\subsubsection = \appendixsubsubsec
4721 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4722 \def\unnumberedzzz#1{%
4723 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4724 \global\advance\unnumberedno by 1
4726 % Since an unnumbered has no number, no prefix for figures.
4727 \global\let\chaplevelprefix = \empty
4730 % This used to be simply \message{#1}, but TeX fully expands the
4731 % argument to \message. Therefore, if #1 contained @-commands, TeX
4732 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4733 % expanded @cite (which turns out to cause errors because \cite is meant
4734 % to be executed, not expanded).
4736 % Anyway, we don't want the fully-expanded definition of @cite to appear
4737 % as a result of the \message, we just want `@cite' itself. We use
4738 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4739 % simply yielding the contents of <toks register>. (We also do this for
4742 \message{(\the\toks0)}%
4744 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4746 \global\let\section = \unnumberedsec
4747 \global\let\subsection = \unnumberedsubsec
4748 \global\let\subsubsection = \unnumberedsubsubsec
4751 % @centerchap is like @unnumbered, but the heading is centered.
4752 \outer\parseargdef\centerchap{%
4753 % Well, we could do the following in a group, but that would break
4754 % an assumption that \chapmacro is called at the outermost level.
4755 % Thus we are safer this way: --kasal, 24feb04
4756 \let\centerparametersmaybe = \centerparameters
4758 \let\centerparametersmaybe = \relax
4761 % @top is like @unnumbered.
4765 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4767 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4768 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4771 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4772 \def\appendixsectionzzz#1{%
4773 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4774 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4776 \let\appendixsec\appendixsection
4778 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4779 \def\unnumberedseczzz#1{%
4780 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4781 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4785 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4786 \def\numberedsubseczzz#1{%
4787 \global\subsubsecno=0 \global\advance\subsecno by 1
4788 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4791 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4792 \def\appendixsubseczzz#1{%
4793 \global\subsubsecno=0 \global\advance\subsecno by 1
4794 \sectionheading{#1}{subsec}{Yappendix}%
4795 {\appendixletter.\the\secno.\the\subsecno}%
4798 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4799 \def\unnumberedsubseczzz#1{%
4800 \global\subsubsecno=0 \global\advance\subsecno by 1
4801 \sectionheading{#1}{subsec}{Ynothing}%
4802 {\the\unnumberedno.\the\secno.\the\subsecno}%
4806 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4807 \def\numberedsubsubseczzz#1{%
4808 \global\advance\subsubsecno by 1
4809 \sectionheading{#1}{subsubsec}{Ynumbered}%
4810 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4813 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4814 \def\appendixsubsubseczzz#1{%
4815 \global\advance\subsubsecno by 1
4816 \sectionheading{#1}{subsubsec}{Yappendix}%
4817 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4820 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4821 \def\unnumberedsubsubseczzz#1{%
4822 \global\advance\subsubsecno by 1
4823 \sectionheading{#1}{subsubsec}{Ynothing}%
4824 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4827 % These macros control what the section commands do, according
4828 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4829 % Define them by default for a numbered chapter.
4830 \let\section = \numberedsec
4831 \let\subsection = \numberedsubsec
4832 \let\subsubsection = \numberedsubsubsec
4834 % Define @majorheading, @heading and @subheading
4836 % NOTE on use of \vbox for chapter headings, section headings, and such:
4837 % 1) We use \vbox rather than the earlier \line to permit
4838 % overlong headings to fold.
4839 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4840 % heading is obnoxious; this forbids it.
4841 % 3) Likewise, headings look best if no \parindent is used, and
4842 % if justification is not attempted. Hence \raggedright.
4846 {\advance\chapheadingskip by 10pt \chapbreak }%
4847 \parsearg\chapheadingzzz
4850 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4851 \def\chapheadingzzz#1{%
4852 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4853 \parindent=0pt\raggedright
4855 \bigskip \par\penalty 200\relax
4856 \suppressfirstparagraphindent
4859 % @heading, @subheading, @subsubheading.
4860 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4861 \suppressfirstparagraphindent}
4862 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4863 \suppressfirstparagraphindent}
4864 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4865 \suppressfirstparagraphindent}
4867 % These macros generate a chapter, section, etc. heading only
4868 % (including whitespace, linebreaking, etc. around it),
4869 % given all the information in convenient, parsed form.
4871 %%% Args are the skip and penalty (usually negative)
4872 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4874 %%% Define plain chapter starts, and page on/off switching for it
4875 % Parameter controlling skip before chapter headings (if needed)
4877 \newskip\chapheadingskip
4879 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4880 \def\chappager{\par\vfill\supereject}
4881 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4883 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4886 \global\let\contentsalignmacro = \chappager
4887 \global\let\pchapsepmacro=\chapbreak
4888 \global\let\pagealignmacro=\chappager}
4891 \global\let\contentsalignmacro = \chappager
4892 \global\let\pchapsepmacro=\chappager
4893 \global\let\pagealignmacro=\chappager
4894 \global\def\HEADINGSon{\HEADINGSsingle}}
4897 \global\let\contentsalignmacro = \chapoddpage
4898 \global\let\pchapsepmacro=\chapoddpage
4899 \global\let\pagealignmacro=\chapoddpage
4900 \global\def\HEADINGSon{\HEADINGSdouble}}
4906 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4907 % Yappendix, Yomitfromtoc), #3 the chapter number.
4909 % To test against our argument.
4910 \def\Ynothingkeyword{Ynothing}
4911 \def\Yomitfromtockeyword{Yomitfromtoc}
4912 \def\Yappendixkeyword{Yappendix}
4914 \def\chapmacro#1#2#3{%
4919 % Have to define \thissection before calling \donoderef, because the
4920 % xref code eventually uses it. On the other hand, it has to be called
4921 % after \pchapsepmacro, or the headline will change too soon.
4922 \gdef\thissection{#1}%
4923 \gdef\thischaptername{#1}%
4925 % Only insert the separating space if we have a chapter/appendix
4926 % number, and don't print the unnumbered ``number''.
4928 \ifx\temptype\Ynothingkeyword
4930 \def\toctype{unnchap}%
4931 \gdef\thischapternum{}%
4932 \gdef\thischapter{#1}%
4933 \else\ifx\temptype\Yomitfromtockeyword
4934 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4936 \gdef\thischapternum{}%
4937 \gdef\thischapter{}%
4938 \else\ifx\temptype\Yappendixkeyword
4939 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4941 \xdef\thischapternum{\appendixletter}%
4942 % We don't substitute the actual chapter name into \thischapter
4943 % because we don't want its macros evaluated now. And we don't
4944 % use \thissection because that changes with each section.
4946 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4947 \noexpand\thischaptername}%
4949 \setbox0 = \hbox{#3\enspace}%
4950 \def\toctype{numchap}%
4951 \xdef\thischapternum{\the\chapno}%
4952 \xdef\thischapter{\putwordChapter{} \the\chapno:
4953 \noexpand\thischaptername}%
4956 % Write the toc entry for this chapter. Must come before the
4957 % \donoderef, because we include the current node name in the toc
4958 % entry, and \donoderef resets it to empty.
4959 \writetocentry{\toctype}{#1}{#3}%
4961 % For pdftex, we have to write out the node definition (aka, make
4962 % the pdfdest) after any page break, but before the actual text has
4963 % been typeset. If the destination for the pdf outline is after the
4964 % text, then jumping from the outline may wind up with the text not
4965 % being visible, for instance under high magnification.
4968 % Typeset the actual heading.
4969 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4970 \hangindent=\wd0 \centerparametersmaybe
4973 \nobreak\bigskip % no page break after a chapter title
4977 % @centerchap -- centered and unnumbered.
4978 \let\centerparametersmaybe = \relax
4979 \def\centerparameters{%
4980 \advance\rightskip by 3\rightskip
4981 \leftskip = \rightskip
4986 % I don't think this chapter style is supported any more, so I'm not
4987 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4989 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4991 \def\unnchfopen #1{%
4992 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4993 \parindent=0pt\raggedright
4994 \rm #1\hfill}}\bigskip \par\nobreak
4996 \def\chfopen #1#2{\chapoddpage {\chapfonts
4997 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5000 \def\centerchfopen #1{%
5001 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5003 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5006 \global\let\chapmacro=\chfopen
5007 \global\let\centerchapmacro=\centerchfopen}
5010 % Section titles. These macros combine the section number parts and
5011 % call the generic \sectionheading to do the printing.
5013 \newskip\secheadingskip
5014 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5016 % Subsection titles.
5017 \newskip\subsecheadingskip
5018 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5020 % Subsubsection titles.
5021 \def\subsubsecheadingskip{\subsecheadingskip}
5022 \def\subsubsecheadingbreak{\subsecheadingbreak}
5025 % Print any size, any type, section title.
5027 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5028 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5031 \def\sectionheading#1#2#3#4{%
5033 % Switch to the right set of fonts.
5034 \csname #2fonts\endcsname \rm
5036 % Insert space above the heading.
5037 \csname #2headingbreak\endcsname
5039 % Only insert the space after the number if we have a section number.
5040 \def\sectionlevel{#2}%
5043 \ifx\temptype\Ynothingkeyword
5046 \gdef\thissection{#1}%
5047 \else\ifx\temptype\Yomitfromtockeyword
5048 % for @headings -- no section number, don't include in toc,
5049 % and don't redefine \thissection.
5052 \let\sectionlevel=\empty
5053 \else\ifx\temptype\Yappendixkeyword
5054 \setbox0 = \hbox{#4\enspace}%
5056 \gdef\thissection{#1}%
5058 \setbox0 = \hbox{#4\enspace}%
5060 \gdef\thissection{#1}%
5063 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5064 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5066 % Write the node reference (= pdf destination for pdftex).
5067 % Again, see comments in \chapmacro.
5070 % Interline glue will be inserted when the vbox is completed.
5071 % That glue will be a valid breakpoint for the page, since it'll be
5072 % preceded by a whatsit (usually from the \donoderef, or from the
5073 % \writetocentry if there was no node). We don't want to allow that
5074 % break, since then the whatsits could end up on page n while the
5075 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5078 % Output the actual section heading.
5079 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5080 \hangindent=\wd0 % zero if no section number
5083 % Add extra space after the heading -- half of whatever came above it.
5084 % Don't allow stretch, though.
5085 \kern .5 \csname #2headingskip\endcsname
5087 % Do not let the kern be a potential breakpoint, as it would be if it
5088 % was followed by glue.
5091 % We'll almost certainly start a paragraph next, so don't let that
5092 % glue accumulate. (Not a breakpoint because it's preceded by a
5093 % discardable item.)
5096 % This is purely so the last item on the list is a known \penalty >
5097 % 10000. This is so \startdefun can avoid allowing breakpoints after
5098 % section headings. Otherwise, it would insert a valid breakpoint between:
5100 % @section sec-whatever
5101 % @deffn def-whatever
5107 % Table of contents.
5110 % Write an entry to the toc file, opening it if necessary.
5111 % Called from @chapter, etc.
5113 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5114 % We append the current node name (if any) and page number as additional
5115 % arguments for the \{chap,sec,...}entry macros which will eventually
5116 % read this. The node name is used in the pdf outlines as the
5117 % destination to jump to.
5119 % We open the .toc file for writing here instead of at @setfilename (or
5120 % any other fixed time) so that @contents can be anywhere in the document.
5121 % But if #1 is `omit', then we don't do anything. This is used for the
5122 % table of contents chapter openings themselves.
5124 \newif\iftocfileopened
5125 \def\omitkeyword{omit}%
5127 \def\writetocentry#1#2#3{%
5128 \edef\writetoctype{#1}%
5129 \ifx\writetoctype\omitkeyword \else
5130 \iftocfileopened\else
5131 \immediate\openout\tocfile = \jobname.toc
5132 \global\tocfileopenedtrue
5138 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5144 % Tell \shipout to create a pdf destination on each page, if we're
5145 % writing pdf. These are used in the table of contents. We can't
5146 % just write one on every page because the title pages are numbered
5147 % 1 and 2 (the page numbers aren't printed), and so are the first
5148 % two pages of the document. Thus, we'd have two destinations named
5149 % `1', and two named `2'.
5150 \ifpdf \global\pdfmakepagedesttrue \fi
5154 % These characters do not print properly in the Computer Modern roman
5155 % fonts, so we must take special care. This is more or less redundant
5156 % with the Texinfo input format setup at the end of this file.
5158 \def\activecatcodes{%
5171 % Read the toc file, which is essentially Texinfo input.
5175 \input \tocreadfilename
5178 \newskip\contentsrightmargin \contentsrightmargin=1in
5179 \newcount\savepageno
5180 \newcount\lastnegativepageno \lastnegativepageno = -1
5182 % Prepare to read what we've written to \tocfile.
5184 \def\startcontents#1{%
5185 % If @setchapternewpage on, and @headings double, the contents should
5186 % start on an odd page, unlike chapters. Thus, we maintain
5187 % \contentsalignmacro in parallel with \pagealignmacro.
5188 % From: Torbjorn Granlund <tege@matematik.su.se>
5190 \immediate\closeout\tocfile
5192 % Don't need to put `Contents' or `Short Contents' in the headline.
5193 % It is abundantly clear what they are.
5195 \chapmacro{#1}{Yomitfromtoc}{}%
5197 \savepageno = \pageno
5198 \begingroup % Set up to handle contents files properly.
5199 \raggedbottom % Worry more about breakpoints than the bottom.
5200 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5202 % Roman numerals for page numbers.
5203 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5206 % redefined for the two-volume lispref. We always output on
5207 % \jobname.toc even if this is redefined.
5209 \def\tocreadfilename{\jobname.toc}
5211 % Normal (long) toc.
5214 \startcontents{\putwordTOC}%
5215 \openin 1 \tocreadfilename\space
5220 \contentsalignmacro % in case @setchapternewpage odd is in effect
5226 \lastnegativepageno = \pageno
5227 \global\pageno = \savepageno
5230 % And just the chapters.
5231 \def\summarycontents{%
5232 \startcontents{\putwordShortTOC}%
5234 \let\numchapentry = \shortchapentry
5235 \let\appentry = \shortchapentry
5236 \let\unnchapentry = \shortunnchapentry
5237 % We want a true roman here for the page numbers.
5239 \let\rm=\shortcontrm \let\bf=\shortcontbf
5240 \let\sl=\shortcontsl \let\tt=\shortconttt
5242 \hyphenpenalty = 10000
5243 \advance\baselineskip by 1pt % Open it up a little.
5244 \def\numsecentry##1##2##3##4{}
5245 \let\appsecentry = \numsecentry
5246 \let\unnsecentry = \numsecentry
5247 \let\numsubsecentry = \numsecentry
5248 \let\appsubsecentry = \numsecentry
5249 \let\unnsubsecentry = \numsecentry
5250 \let\numsubsubsecentry = \numsecentry
5251 \let\appsubsubsecentry = \numsecentry
5252 \let\unnsubsubsecentry = \numsecentry
5253 \openin 1 \tocreadfilename\space
5259 \contentsalignmacro % in case @setchapternewpage odd is in effect
5261 \lastnegativepageno = \pageno
5262 \global\pageno = \savepageno
5264 \let\shortcontents = \summarycontents
5266 % Typeset the label for a chapter or appendix for the short contents.
5267 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5269 \def\shortchaplabel#1{%
5270 % This space should be enough, since a single number is .5em, and the
5271 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5272 % But use \hss just in case.
5273 % (This space doesn't include the extra space that gets added after
5274 % the label; that gets put in by \shortchapentry above.)
5276 % We'd like to right-justify chapter numbers, but that looks strange
5277 % with appendix letters. And right-justifying numbers and
5278 % left-justifying letters looks strange when there is less than 10
5279 % chapters. Have to read the whole toc once to know how many chapters
5280 % there are before deciding ...
5281 \hbox to 1em{#1\hss}%
5284 % These macros generate individual entries in the table of contents.
5285 % The first argument is the chapter or section name.
5286 % The last argument is the page number.
5287 % The arguments in between are the chapter number, section number, ...
5289 % Chapters, in the main contents.
5290 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5292 % Chapters, in the short toc.
5293 % See comments in \dochapentry re vbox and related settings.
5294 \def\shortchapentry#1#2#3#4{%
5295 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5298 % Appendices, in the main contents.
5299 % Need the word Appendix, and a fixed-size box.
5301 \def\appendixbox#1{%
5302 % We use M since it's probably the widest letter.
5303 \setbox0 = \hbox{\putwordAppendix{} M}%
5304 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5306 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5308 % Unnumbered chapters.
5309 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5310 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5313 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5314 \let\appsecentry=\numsecentry
5315 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5318 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5319 \let\appsubsecentry=\numsubsecentry
5320 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5322 % And subsubsections.
5323 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5324 \let\appsubsubsecentry=\numsubsubsecentry
5325 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5327 % This parameter controls the indentation of the various levels.
5328 % Same as \defaultparindent.
5329 \newdimen\tocindent \tocindent = 15pt
5331 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5334 % If the toc has to be broken over pages, we want it to be at chapters
5335 % if at all possible; hence the \penalty.
5336 \def\dochapentry#1#2{%
5337 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5340 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5342 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5345 \def\dosecentry#1#2{\begingroup
5346 \secentryfonts \leftskip=\tocindent
5347 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5350 \def\dosubsecentry#1#2{\begingroup
5351 \subsecentryfonts \leftskip=2\tocindent
5352 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5355 \def\dosubsubsecentry#1#2{\begingroup
5356 \subsubsecentryfonts \leftskip=3\tocindent
5357 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5360 % We use the same \entry macro as for the index entries.
5361 \let\tocentry = \entry
5363 % Space between chapter (or whatever) number and the title.
5364 \def\labelspace{\hskip1em \relax}
5366 \def\dopageno#1{{\rm #1}}
5367 \def\doshortpageno#1{{\rm #1}}
5369 \def\chapentryfonts{\secfonts \rm}
5370 \def\secentryfonts{\textfonts}
5371 \def\subsecentryfonts{\textfonts}
5372 \def\subsubsecentryfonts{\textfonts}
5375 \message{environments,}
5376 % @foo ... @end foo.
5378 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5380 % Since these characters are used in examples, it should be an even number of
5381 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5384 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5385 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5386 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5387 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5389 % The @error{} command.
5390 % Adapted from the TeXbook's \boxit.
5394 {\tentt \global\dimen0 = 3em}% Width of the box.
5395 \dimen2 = .55pt % Thickness of rules
5396 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5397 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5399 \setbox\errorbox=\hbox to \dimen0{\hfil
5400 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5401 \advance\hsize by -2\dimen2 % Rules.
5403 \hrule height\dimen2
5404 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5405 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5406 \kern3pt\vrule width\dimen2}% Space to right.
5407 \hrule height\dimen2}
5410 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5412 % @tex ... @end tex escapes into raw Tex temporarily.
5413 % One exception: @ is still an escape character, so that @end tex works.
5414 % But \@ or @@ will get a plain tex @ character.
5417 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5418 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5419 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5429 \let\bullet=\ptexbullet
5434 \let\equiv=\ptexequiv
5437 \let\indent=\ptexindent
5438 \let\noindent=\ptexnoindent
5445 \let\frenchspacing=\plainfrenchspacing
5447 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5448 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5451 % There is no need to define \Etex.
5453 % Define @lisp ... @end lisp.
5454 % @lisp environment forms a group so it can rebind things,
5455 % including the definition of @end lisp (which normally is erroneous).
5457 % Amount to narrow the margins by for @lisp.
5458 \newskip\lispnarrowing \lispnarrowing=0.4in
5460 % This is the definition that ^^M gets inside @lisp, @example, and other
5461 % such environments. \null is better than a space, since it doesn't
5463 \def\lisppar{\null\endgraf}
5465 % This space is always present above and below environments.
5466 \newskip\envskipamount \envskipamount = 0pt
5468 % Make spacing and below environment symmetrical. We use \parskip here
5469 % to help in doing that, since in @example-like environments \parskip
5470 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5471 % start of the next paragraph will insert \parskip.
5473 \def\aboveenvbreak{{%
5474 % =10000 instead of <10000 because of a special case in \itemzzz and
5475 % \sectionheading, q.v.
5476 \ifnum \lastpenalty=10000 \else
5477 \advance\envskipamount by \parskip
5479 \ifdim\lastskip<\envskipamount
5481 % it's not a good place to break if the last penalty was \nobreak
5483 \ifnum\lastpenalty<10000 \penalty-50 \fi
5484 \vskip\envskipamount
5489 \let\afterenvbreak = \aboveenvbreak
5491 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5492 % also clear it, so that its embedded environments do the narrowing again.
5493 \let\nonarrowing=\relax
5495 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5496 % environment contents.
5497 \font\circle=lcircle10
5499 \newdimen\cartouter\newdimen\cartinner
5500 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5501 \circthick=\fontdimen8\circle
5503 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5504 \def\ctr{{\hskip 6pt\circle\char'010}}
5505 \def\cbl{{\circle\char'012\hskip -6pt}}
5506 \def\cbr{{\hskip 6pt\circle\char'011}}
5507 \def\carttop{\hbox to \cartouter{\hskip\lskip
5508 \ctl\leaders\hrule height\circthick\hfil\ctr
5510 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5511 \cbl\leaders\hrule height\circthick\hfil\cbr
5514 \newskip\lskip\newskip\rskip
5517 \ifhmode\par\fi % can't be in the midst of a paragraph.
5519 \lskip=\leftskip \rskip=\rightskip
5520 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5521 \cartinner=\hsize \advance\cartinner by-\lskip
5522 \advance\cartinner by-\rskip
5524 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5525 % side, and for 6pt waste from
5526 % each corner char, and rule thickness
5527 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5528 % Flag to tell @lisp, etc., not to narrow margin.
5529 \let\nonarrowing = t%
5531 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5539 \baselineskip=\normbskip
5540 \lineskip=\normlskip
5543 \comment % For explanation, see the end of \def\group.
5558 % This macro is called at the beginning of all the @example variants,
5562 \hfuzz = 12pt % Don't be fussy
5563 \sepspaces % Make spaces be word-separators rather than space tokens.
5564 \let\par = \lisppar % don't ignore blank lines
5565 \obeylines % each line of input is a line of output
5568 \emergencystretch = 0pt % don't try to avoid overfull boxes
5569 \ifx\nonarrowing\relax
5570 \advance \leftskip by \lispnarrowing
5571 \exdentamount=\lispnarrowing
5573 \let\nonarrowing = \relax
5575 \let\exdent=\nofillexdent
5578 % If you want all examples etc. small: @set dispenvsize small.
5579 % If you want even small examples the full size: @set dispenvsize nosmall.
5580 % This affects the following displayed environments:
5581 % @example, @display, @format, @lisp
5583 \def\smallword{small}
5584 \def\nosmallword{nosmall}
5585 \let\SETdispenvsize\relax
5586 \def\setnormaldispenv{%
5587 \ifx\SETdispenvsize\smallword
5588 % end paragraph for sake of leading, in case document has no blank
5589 % line. This is redundant with what happens in \aboveenvbreak, but
5590 % we need to do it before changing the fonts, and it's inconvenient
5591 % to change the fonts afterward.
5592 \ifnum \lastpenalty=10000 \else \endgraf \fi
5593 \smallexamplefonts \rm
5596 \def\setsmalldispenv{%
5597 \ifx\SETdispenvsize\nosmallword
5599 \ifnum \lastpenalty=10000 \else \endgraf \fi
5600 \smallexamplefonts \rm
5604 % We often define two environments, @foo and @smallfoo.
5605 % Let's do it by one command:
5606 \def\makedispenv #1#2{
5607 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5608 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5609 \expandafter\let\csname E#1\endcsname \afterenvbreak
5610 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5613 % Define two synonyms:
5614 \def\maketwodispenvs #1#2#3{
5615 \makedispenv{#1}{#3}
5616 \makedispenv{#2}{#3}
5619 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5621 % @smallexample and @smalllisp: use smaller fonts.
5622 % Originally contributed by Pavel@xerox.
5624 \maketwodispenvs {lisp}{example}{%
5627 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5628 \gobble % eat return
5630 % @display/@smalldisplay: same as @lisp except keep current font.
5632 \makedispenv {display}{%
5637 % @format/@smallformat: same as @display except don't narrow margins.
5639 \makedispenv{format}{%
5640 \let\nonarrowing = t%
5645 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5647 \let\nonarrowing = t%
5651 \let\Eflushleft = \afterenvbreak
5655 \envdef\flushright{%
5656 \let\nonarrowing = t%
5658 \advance\leftskip by 0pt plus 1fill
5661 \let\Eflushright = \afterenvbreak
5664 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5665 % and narrows the margins. We keep \parskip nonzero in general, since
5666 % we're doing normal filling. So, when using \aboveenvbreak and
5667 % \afterenvbreak, temporarily make \parskip 0.
5670 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5673 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5674 \ifx\nonarrowing\relax
5675 \advance\leftskip by \lispnarrowing
5676 \advance\rightskip by \lispnarrowing
5677 \exdentamount = \lispnarrowing
5679 \let\nonarrowing = \relax
5681 \parsearg\quotationlabel
5684 % We have retained a nonzero parskip for the environment, since we're
5685 % doing normal filling.
5689 \ifx\quotationauthor\undefined\else
5691 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5693 {\parskip=0pt \afterenvbreak}%
5696 % If we're given an argument, typeset it in bold with a colon after.
5697 \def\quotationlabel#1{%
5699 \ifx\temp\empty \else
5705 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5706 % If we want to allow any <char> as delimiter,
5707 % we need the curly braces so that makeinfo sees the @verb command, eg:
5708 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5710 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5712 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5713 % active too. Otherwise, they get lost as the first character on a
5716 \do\ \do\\\do\{\do\}\do\$\do\&%
5717 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5718 \do\<\do\>\do\|\do\@\do+\do\"%
5722 \def\uncatcodespecials{%
5723 \def\do##1{\catcode`##1=\other}\dospecials}
5725 % [Knuth] pp. 380,381,391
5726 % Disable Spanish ligatures ?` and !` of \tt font
5728 \catcode`\`=\active\gdef`{\relax\lq}
5731 % Setup for the @verb command.
5733 % Eight spaces for a tab
5735 \catcode`\^^I=\active
5736 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5740 \tt % easiest (and conventionally used) font for verbatim
5741 \def\par{\leavevmode\endgraf}%
5744 % Respect line breaks,
5745 % print special symbols as themselves, and
5746 % make each space count
5747 % must do in this order:
5748 \obeylines \uncatcodespecials \sepspaces
5751 % Setup for the @verbatim environment
5753 % Real tab expansion
5754 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5756 \def\starttabbox{\setbox0=\hbox\bgroup}
5758 % Allow an option to not replace quotes with a regular directed right
5759 % quote/apostrophe (char 0x27), but instead use the undirected quote
5760 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5761 % the default, but it works for pasting with more pdf viewers (at least
5762 % evince), the lilypond developers report. xpdf does work with the
5765 \def\codequoteright{%
5766 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
5767 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5773 % and a similar option for the left quote char vs. a grave accent.
5774 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5775 % the code environments to do likewise.
5777 \def\codequoteleft{%
5778 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
5779 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5786 \catcode`\^^I=\active
5788 \catcode`\^^I=\active
5789 \def^^I{\leavevmode\egroup
5790 \dimen0=\wd0 % the width so far, or since the previous tab
5791 \divide\dimen0 by\tabw
5792 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5793 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5794 \wd0=\dimen0 \box0 \starttabbox
5798 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
5801 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
5803 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
5806 % start the verbatim environment.
5807 \def\setupverbatim{%
5808 \let\nonarrowing = t%
5810 % Easiest (and conventionally used) font for verbatim
5812 \def\par{\leavevmode\egroup\box0\endgraf}%
5816 % Respect line breaks,
5817 % print special symbols as themselves, and
5818 % make each space count
5819 % must do in this order:
5820 \obeylines \uncatcodespecials \sepspaces
5821 \everypar{\starttabbox}%
5824 % Do the @verb magic: verbatim text is quoted by unique
5825 % delimiter characters. Before first delimiter expect a
5826 % right brace, after last delimiter expect closing brace:
5828 % \def\doverb'{'<char>#1<char>'}'{#1}
5830 % [Knuth] p. 382; only eat outer {}
5832 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5833 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5836 \def\verb{\begingroup\setupverb\doverb}
5839 % Do the @verbatim magic: define the macro \doverbatim so that
5840 % the (first) argument ends when '@end verbatim' is reached, ie:
5842 % \def\doverbatim#1@end verbatim{#1}
5844 % For Texinfo it's a lot easier than for LaTeX,
5845 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5846 % we need not redefine '\', '{' and '}'.
5848 % Inspired by LaTeX's verbatim command set [latex.ltx]
5853 % ignore everything up to the first ^^M, that's the newline at the end
5854 % of the @verbatim input line itself. Otherwise we get an extra blank
5855 % line in the output.
5856 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5857 % We really want {...\end verbatim} in the body of the macro, but
5858 % without the active space; thus we have to use \xdef and \gobble.
5862 \setupverbatim\doverbatim
5864 \let\Everbatim = \afterenvbreak
5867 % @verbatiminclude FILE - insert text of file in verbatim environment.
5869 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5871 \def\doverbatiminclude#1{%
5873 \makevalueexpandable
5880 % @copying ... @end copying.
5881 % Save the text away for @insertcopying later.
5883 % We save the uninterpreted tokens, rather than creating a box.
5884 % Saving the text in a box would be much easier, but then all the
5885 % typesetting commands (@smallbook, font changes, etc.) have to be done
5886 % beforehand -- and a) we want @copying to be done first in the source
5887 % file; b) letting users define the frontmatter in as flexible order as
5888 % possible is very desirable.
5890 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5891 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5893 \def\insertcopying{%
5895 \parindent = 0pt % paragraph indentation looks wrong on title page
5896 \scanexp\copyingtext
5904 \newskip\defbodyindent \defbodyindent=.4in
5905 \newskip\defargsindent \defargsindent=50pt
5906 \newskip\deflastargmargin \deflastargmargin=18pt
5907 \newcount\defunpenalty
5909 % Start the processing of @deffn:
5911 \ifnum\lastpenalty<10000
5913 \defunpenalty=10003 % Will keep this @deffn together with the
5914 % following @def command, see below.
5916 % If there are two @def commands in a row, we'll have a \nobreak,
5917 % which is there to keep the function description together with its
5918 % header. But if there's nothing but headers, we need to allow a
5919 % break somewhere. Check specifically for penalty 10002, inserted
5920 % by \printdefunline, instead of 10000, since the sectioning
5921 % commands also insert a nobreak penalty, and we don't want to allow
5922 % a break between a section heading and a defun.
5924 % As a minor refinement, we avoid "club" headers by signalling
5925 % with penalty of 10003 after the very first @deffn in the
5926 % sequence (see above), and penalty of 10002 after any following
5928 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
5930 % Similarly, after a section heading, do not allow a break.
5931 % But do insert the glue.
5932 \medskip % preceded by discardable penalty, so not a breakpoint
5936 \advance\leftskip by \defbodyindent
5937 \exdentamount=\defbodyindent
5941 % First, check whether we are in the right environment:
5944 % As above, allow line break if we have multiple x headers in a row.
5945 % It's not a great place, though.
5946 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
5948 % And now, it's time to reuse the body of the original defun:
5949 \expandafter\gobbledefun#1%
5951 \def\gobbledefun#1\startdefun{}
5953 % \printdefunline \deffnheader{text}
5955 \def\printdefunline#1#2{%
5957 % call \deffnheader:
5960 \interlinepenalty = 10000
5961 \advance\rightskip by 0pt plus 1fil
5963 \nobreak\vskip -\parskip
5964 \penalty\defunpenalty % signal to \startdefun and \dodefunx
5965 % Some of the @defun-type tags do not enable magic parentheses,
5966 % rendering the following check redundant. But we don't optimize.
5971 \def\Edefun{\endgraf\medbreak}
5973 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5974 % the only thing remainnig is to define \deffnheader.
5977 \expandafter\let\csname E#1\endcsname = \Edefun
5978 \edef\temp{\noexpand\domakedefun
5979 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5983 % \domakedefun \deffn \deffnx \deffnheader
5985 % Define \deffn and \deffnx, without parameters.
5986 % \deffnheader has to be defined explicitly.
5988 \def\domakedefun#1#2#3{%
5991 \parseargusing\activeparens{\printdefunline#3}%
5993 \def#2{\dodefunx#1}%
5997 %%% Untyped functions:
5999 % @deffn category name args
6000 \makedefun{deffn}{\deffngeneral{}}
6002 % @deffn category class name args
6003 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6005 % \defopon {category on}class name args
6006 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6008 % \deffngeneral {subind}category name args
6010 \def\deffngeneral#1#2 #3 #4\endheader{%
6011 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6012 \dosubind{fn}{\code{#3}}{#1}%
6013 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6016 %%% Typed functions:
6018 % @deftypefn category type name args
6019 \makedefun{deftypefn}{\deftypefngeneral{}}
6021 % @deftypeop category class type name args
6022 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6024 % \deftypeopon {category on}class type name args
6025 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6027 % \deftypefngeneral {subind}category type name args
6029 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6030 \dosubind{fn}{\code{#4}}{#1}%
6031 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6034 %%% Typed variables:
6036 % @deftypevr category type var args
6037 \makedefun{deftypevr}{\deftypecvgeneral{}}
6039 % @deftypecv category class type var args
6040 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6042 % \deftypecvof {category of}class type var args
6043 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6045 % \deftypecvgeneral {subind}category type var args
6047 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6048 \dosubind{vr}{\code{#4}}{#1}%
6049 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6052 %%% Untyped variables:
6054 % @defvr category var args
6055 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6057 % @defcv category class var args
6058 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6060 % \defcvof {category of}class var args
6061 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6064 % @deftp category name args
6065 \makedefun{deftp}#1 #2 #3\endheader{%
6066 \doind{tp}{\code{#2}}%
6067 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6070 % Remaining @defun-like shortcuts:
6071 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6072 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6073 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6074 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6075 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6076 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6077 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6078 \makedefun{defmethod}{\defopon\putwordMethodon}
6079 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6080 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6081 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6083 % \defname, which formats the name of the @def (not the args).
6084 % #1 is the category, such as "Function".
6085 % #2 is the return type, if any.
6086 % #3 is the function name.
6088 % We are followed by (but not passed) the arguments, if any.
6090 \def\defname#1#2#3{%
6091 % Get the values of \leftskip and \rightskip as they were outside the @def...
6092 \advance\leftskip by -\defbodyindent
6094 % How we'll format the type name. Putting it in brackets helps
6095 % distinguish it from the body text that may end up on the next line
6098 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6100 % Figure out line sizes for the paragraph shape.
6101 % The first line needs space for \box0; but if \rightskip is nonzero,
6102 % we need only space for the part of \box0 which exceeds it:
6103 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6104 % The continuations:
6105 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6106 % (plain.tex says that \dimen1 should be used only as global.)
6107 \parshape 2 0in \dimen0 \defargsindent \dimen2
6109 % Put the type name to the right margin.
6112 \hfil\box0 \kern-\hsize
6113 % \hsize has to be shortened this way:
6115 % Intentionally do not respect \rightskip, since we need the space.
6118 % Allow all lines to be underfull without complaint:
6119 \tolerance=10000 \hbadness=10000
6120 \exdentamount=\defbodyindent
6122 % defun fonts. We use typewriter by default (used to be bold) because:
6123 % . we're printing identifiers, they should be in tt in principle.
6124 % . in languages with many accents, such as Czech or French, it's
6125 % common to leave accents off identifiers. The result looks ok in
6126 % tt, but exceedingly strange in rm.
6127 % . we don't want -- and --- to be treated as ligatures.
6128 % . this still does not fix the ?` and !` ligatures, but so far no
6129 % one has made identifiers using them :).
6131 \def\temp{#2}% return value type
6132 \ifx\temp\empty\else \tclose{\temp} \fi
6133 #3% output function name
6135 {\rm\enskip}% hskip 0.5 em of \tenrm
6138 % arguments will be output next, if any.
6141 % Print arguments in slanted roman (not ttsl), inconsistently with using
6142 % tt for the name. This is because literal text is sometimes needed in
6143 % the argument list (groff manual), and ttsl and tt are not very
6144 % distinguishable. Prevent hyphenation at `-' chars.
6147 % use sl by default (not ttsl),
6149 \df \sl \hyphenchar\font=0
6151 % On the other hand, if an argument has two dashes (for instance), we
6152 % want a way to get ttsl. Let's try @var for that.
6155 \sl\hyphenchar\font=45
6158 % We want ()&[] to print specially on the defun line.
6161 \catcode`\(=\active \catcode`\)=\active
6162 \catcode`\[=\active \catcode`\]=\active
6166 % Make control sequences which act like normal parenthesis chars.
6167 \let\lparen = ( \let\rparen = )
6169 % Be sure that we always have a definition for `(', etc. For example,
6170 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6171 % so TeX would otherwise complain about undefined control sequence.
6174 \global\let(=\lparen \global\let)=\rparen
6175 \global\let[=\lbrack \global\let]=\rbrack
6178 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6179 \gdef\magicamp{\let&=\amprm}
6182 \newcount\parencount
6184 % If we encounter &foo, then turn on ()-hacking afterwards
6186 \def\amprm#1 {\ampseentrue{\bf\ }}
6190 % At the first level, print parens in roman,
6191 % otherwise use the default font.
6192 \ifnum \parencount=1 \rm \fi
6194 % The \sf parens (in \boldbrax) actually are a little bolder than
6195 % the contained text. This is especially needed for [ and ] .
6199 \def\infirstlevel#1{%
6206 \def\bfafterword#1 {#1 \bf}
6209 \global\advance\parencount by 1
6211 \infirstlevel \bfafterword
6216 \global\advance\parencount by -1
6219 \newcount\brackcount
6221 \global\advance\brackcount by 1
6226 \global\advance\brackcount by -1
6229 \def\checkparencounts{%
6230 \ifnum\parencount=0 \else \badparencount \fi
6231 \ifnum\brackcount=0 \else \badbrackcount \fi
6233 \def\badparencount{%
6234 \errmessage{Unbalanced parentheses in @def}%
6235 \global\parencount=0
6237 \def\badbrackcount{%
6238 \errmessage{Unbalanced square braces in @def}%
6239 \global\brackcount=0
6246 % To do this right we need a feature of e-TeX, \scantokens,
6247 % which we arrange to emulate with a temporary file in ordinary TeX.
6248 \ifx\eTeXversion\undefined
6249 \newwrite\macscribble
6252 \immediate\openout\macscribble=\jobname.tmp
6253 \immediate\write\macscribble{\the\toks0}%
6254 \immediate\closeout\macscribble
6262 \let\xeatspaces\eatspaces
6263 % Undo catcode changes of \startcontents and \doprintindex
6264 % When called from @insertcopying or (short)caption, we need active
6265 % backslash to get it printed correctly. Previously, we had
6266 % \catcode`\\=\other instead. We'll see whether a problem appears
6267 % with macro expansion. --kasal, 19aug04
6268 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6272 % Append \endinput to make sure that TeX does not see the ending newline.
6273 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6275 \scantokens{#1\endinput}%
6280 \edef\temp{\noexpand\scanmacro{#1}}%
6284 \newcount\paramno % Count of parameters
6285 \newtoks\macname % Macro name
6286 \newif\ifrecursive % Is it recursive?
6288 % List of all defined macros in the form
6289 % \definedummyword\macro1\definedummyword\macro2...
6290 % Currently is also contains all @aliases; the list can be split
6291 % if there is a need.
6294 % Add the macro to \macrolist
6295 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6296 \def\addtomacrolistxxx#1{%
6297 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6298 \xdef\macrolist{\the\toks0}%
6302 % This does \let #1 = #2, with \csnames; that is,
6303 % \let \csname#1\endcsname = \csname#2\endcsname
6304 % (except of course we have to play expansion games).
6308 \csname#1\expandafter\endcsname
6312 % Trim leading and trailing spaces off a string.
6313 % Concepts from aro-bend problem 15 (see CTAN).
6315 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6316 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6317 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6319 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6322 % Trim a single trailing ^^M off a string.
6323 {\catcode`\^^M=\other \catcode`\Q=3%
6324 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6325 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6326 \gdef\eatcrb#1Q#2Q{#1}%
6329 % Macro bodies are absorbed as an argument in a context where
6330 % all characters are catcode 10, 11 or 12, except \ which is active
6331 % (as in normal texinfo). It is necessary to change the definition of \.
6333 % Non-ASCII encodings make 8-bit characters active, so un-activate
6334 % them to avoid their expansion. Must do this non-globally, to
6335 % confine the change to the current group.
6337 % It's necessary to have hard CRs when the macro is executed. This is
6338 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6339 % body, and then making it the \newlinechar in \scanmacro.
6351 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6357 \catcode`\^^M=\other
6360 \def\macrobodyctxt{%
6364 \catcode`\^^M=\other
6373 % \mbodybackslash is the definition of \ in @macro bodies.
6374 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6375 % where N is the macro parameter number.
6376 % We define \csname macarg.\endcsname to be \realbackslash, so
6377 % \\ in macro replacement text gets you a backslash.
6379 {\catcode`@=0 @catcode`@\=@active
6380 @gdef@usembodybackslash{@let\=@mbodybackslash}
6381 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6383 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6385 \def\macro{\recursivefalse\parsearg\macroxxx}
6386 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6389 \getargs{#1}% now \macname is the macname and \argl the arglist
6390 \ifx\argl\empty % no arguments
6393 \expandafter\parsemargdef \argl;%
6395 \if1\csname ismacro.\the\macname\endcsname
6396 \message{Warning: redefining \the\macname}%
6398 \expandafter\ifx\csname \the\macname\endcsname \relax
6399 \else \errmessage{Macro name \the\macname\space already defined}\fi
6400 \global\cslet{macsave.\the\macname}{\the\macname}%
6401 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6402 \addtomacrolist{\the\macname}%
6404 \begingroup \macrobodyctxt
6405 \ifrecursive \expandafter\parsermacbody
6406 \else \expandafter\parsemacbody
6409 \parseargdef\unmacro{%
6410 \if1\csname ismacro.#1\endcsname
6411 \global\cslet{#1}{macsave.#1}%
6412 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6413 % Remove the macro name from \macrolist:
6415 \expandafter\let\csname#1\endcsname \relax
6416 \let\definedummyword\unmacrodo
6417 \xdef\macrolist{\macrolist}%
6420 \errmessage{Macro #1 not defined}%
6424 % Called by \do from \dounmacro on each macro. The idea is to omit any
6425 % macro definitions that have been changed to \relax.
6431 \noexpand\definedummyword \noexpand#1%
6435 % This makes use of the obscure feature that if the last token of a
6436 % <parameter list> is #, then the preceding argument is delimited by
6437 % an opening brace, and that opening brace is not consumed.
6438 \def\getargs#1{\getargsxxx#1{}}
6439 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6440 \def\getmacname #1 #2\relax{\macname={#1}}
6441 \def\getmacargs#1{\def\argl{#1}}
6443 % Parse the optional {params} list. Set up \paramno and \paramlist
6444 % so \defmacro knows what to do. Define \macarg.blah for each blah
6445 % in the params list, to be ##N where N is the position in that list.
6446 % That gets used by \mbodybackslash (above).
6448 % We need to get `macro parameter char #' into several definitions.
6449 % The technique used is stolen from LaTeX: let \hash be something
6450 % unexpandable, insert that wherever you need a #, and then redefine
6451 % it to # just before using the token list produced.
6453 % The same technique is used to protect \eatspaces till just before
6454 % the macro is used.
6456 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6457 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6458 \def\parsemargdefxxx#1,{%
6459 \if#1;\let\next=\relax
6460 \else \let\next=\parsemargdefxxx
6461 \advance\paramno by 1%
6462 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6463 {\xeatspaces{\hash\the\paramno}}%
6464 \edef\paramlist{\paramlist\hash\the\paramno,}%
6467 % These two commands read recursive and nonrecursive macro bodies.
6468 % (They're different since rec and nonrec macros end differently.)
6470 \long\def\parsemacbody#1@end macro%
6471 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6472 \long\def\parsermacbody#1@end rmacro%
6473 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6475 % This defines the macro itself. There are six cases: recursive and
6476 % nonrecursive macros of zero, one, and many arguments.
6477 % Much magic with \expandafter here.
6478 % \xdef is used so that macro definitions will survive the file
6479 % they're defined in; @include reads the file inside a group.
6481 \let\hash=##% convert placeholders to macro parameter chars
6485 \expandafter\xdef\csname\the\macname\endcsname{%
6486 \noexpand\scanmacro{\temp}}%
6488 \expandafter\xdef\csname\the\macname\endcsname{%
6489 \bgroup\noexpand\macroargctxt
6490 \noexpand\braceorline
6491 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6492 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6493 \egroup\noexpand\scanmacro{\temp}}%
6495 \expandafter\xdef\csname\the\macname\endcsname{%
6496 \bgroup\noexpand\macroargctxt
6497 \noexpand\csname\the\macname xx\endcsname}%
6498 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6499 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6500 \expandafter\expandafter
6502 \expandafter\expandafter
6503 \csname\the\macname xxx\endcsname
6504 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6509 \expandafter\xdef\csname\the\macname\endcsname{%
6510 \noexpand\norecurse{\the\macname}%
6511 \noexpand\scanmacro{\temp}\egroup}%
6513 \expandafter\xdef\csname\the\macname\endcsname{%
6514 \bgroup\noexpand\macroargctxt
6515 \noexpand\braceorline
6516 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6517 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6519 \noexpand\norecurse{\the\macname}%
6520 \noexpand\scanmacro{\temp}\egroup}%
6522 \expandafter\xdef\csname\the\macname\endcsname{%
6523 \bgroup\noexpand\macroargctxt
6524 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6525 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6526 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6527 \expandafter\expandafter
6529 \expandafter\expandafter
6530 \csname\the\macname xxx\endcsname
6533 \noexpand\norecurse{\the\macname}%
6534 \noexpand\scanmacro{\temp}\egroup}%
6538 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6540 % \braceorline decides whether the next nonwhitespace character is a
6541 % {. If so it reads up to the closing }, if not, it reads the whole
6542 % line. Whatever was read is then fed to the next control sequence
6543 % as an argument (by \parsebrace or \parsearg)
6544 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6545 \def\braceorlinexxx{%
6546 \ifx\nchar\bgroup\else
6547 \expandafter\parsearg
6552 % We need some trickery to remove the optional spaces around the equal
6553 % sign. Just make them active and then expand them all to nothing.
6554 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6555 \def\aliasxxx #1{\aliasyyy#1\relax}
6556 \def\aliasyyy #1=#2\relax{%
6558 \expandafter\let\obeyedspace=\empty
6559 \addtomacrolist{#1}%
6560 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6566 \message{cross references,}
6569 \newif\ifhavexrefs % True if xref values are known.
6570 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6572 % @inforef is relatively simple.
6573 \def\inforef #1{\inforefzzz #1,,,,**}
6574 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6575 node \samp{\ignorespaces#1{}}}
6577 % @node's only job in TeX is to define \lastnode, which is used in
6578 % cross-references. The @node line might or might not have commas, and
6579 % might or might not have spaces before the first comma, like:
6580 % @node foo , bar , ...
6581 % We don't want such trailing spaces in the node name.
6583 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6585 % also remove a trailing comma, in case of something like this:
6586 % @node Help-Cross, , , Cross-refs
6587 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6588 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6591 \let\lastnode=\empty
6593 % Write a cross-reference definition for the current node. #1 is the
6594 % type (Ynumbered, Yappendix, Ynothing).
6597 \ifx\lastnode\empty\else
6598 \setref{\lastnode}{#1}%
6599 \global\let\lastnode=\empty
6603 % @anchor{NAME} -- define xref target at arbitrary point.
6605 \newcount\savesfregister
6607 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6608 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6609 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6611 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6612 % anchor), which consists of three parts:
6613 % 1) NAME-title - the current sectioning name taken from \thissection,
6614 % or the anchor name.
6615 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6616 % empty for anchors.
6617 % 3) NAME-pg - the page number.
6619 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6620 % floats, there is an additional part, which is not written here:
6621 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6627 \atdummies % preserve commands, but don't expand them
6628 \edef\writexrdef##1##2{%
6629 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6630 ##1}{##2}}% these are parameters of \writexrdef
6632 \toks0 = \expandafter{\thissection}%
6633 \immediate \writexrdef{title}{\the\toks0 }%
6634 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6635 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6640 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6641 % the node name, #2 the name of the Info cross-reference, #3 the printed
6642 % node name, #4 the name of the Info file, #5 the name of the printed
6643 % manual. All but the node name can be omitted.
6645 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6646 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6647 \def\ref#1{\xrefX[#1,,,,,,,]}
6648 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6650 \def\printedmanual{\ignorespaces #5}%
6651 \def\printedrefname{\ignorespaces #3}%
6652 \setbox1=\hbox{\printedmanual\unskip}%
6653 \setbox0=\hbox{\printedrefname\unskip}%
6655 % No printed node name was explicitly given.
6656 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6657 % Use the node name inside the square brackets.
6658 \def\printedrefname{\ignorespaces #1}%
6660 % Use the actual chapter/section title appear inside
6661 % the square brackets. Use the real section title if we have it.
6663 % It is in another manual, so we don't have it.
6664 \def\printedrefname{\ignorespaces #1}%
6667 % We know the real title if we have the xref values.
6668 \def\printedrefname{\refx{#1-title}{}}%
6670 % Otherwise just copy the Info node name.
6671 \def\printedrefname{\ignorespaces #1}%
6677 % Make link in pdf output.
6683 % See comments at \activebackslashdouble.
6684 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6685 \backslashparens\pdfxrefdest}%
6687 \ifnum\filenamelength>0
6688 \startlink attr{/Border [0 0 0]}%
6689 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6691 \startlink attr{/Border [0 0 0]}%
6692 goto name{\pdfmkpgn{\pdfxrefdest}}%
6698 % Float references are printed completely differently: "Figure 1.2"
6699 % instead of "[somenode], p.3". We distinguish them by the
6700 % LABEL-title being set to a magic string.
6702 % Have to otherify everything special to allow the \csname to
6703 % include an _ in the xref name, etc.
6706 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6707 \csname XR#1-title\endcsname
6709 \iffloat\Xthisreftitle
6710 % If the user specified the print name (third arg) to the ref,
6711 % print it instead of our usual "Figure 1.2".
6718 % if the user also gave the printed manual name (fifth arg), append
6721 \space \putwordin{} \cite{\printedmanual}%
6724 % node/anchor (non-float) references.
6726 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6727 % insert empty discretionaries after hyphens, which means that it will
6728 % not find a line break at a hyphen in a node names. Since some manuals
6729 % are best written with fairly long node names, containing hyphens, this
6730 % is a loss. Therefore, we give the text of the node name again, so it
6731 % is as if TeX is seeing it for the first time.
6733 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6735 % _ (for example) has to be the character _ for the purposes of the
6736 % control sequence corresponding to the node, but it has to expand
6737 % into the usual \leavevmode...\vrule stuff for purposes of
6738 % printing. So we \turnoffactive for the \refx-snt, back on for the
6739 % printing, back off for the \refx-pg.
6741 % Only output a following space if the -snt ref is nonempty; for
6742 % @unnumbered and @anchor, it won't be.
6743 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6744 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6746 % output the `[mynode]' via a macro so it can be overridden.
6747 \xrefprintnodename\printedrefname
6749 % But we always want a comma and a space:
6752 % output the `page 3'.
6753 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6759 % This macro is called from \xrefX for the `[nodename]' part of xref
6760 % output. It's a separate macro only so it can be changed more easily,
6761 % since square brackets don't work well in some documents. Particularly
6762 % one that Bob is working on :).
6764 \def\xrefprintnodename#1{[#1]}
6766 % Things referred to by \setref.
6772 \putwordChapter@tie \the\chapno
6773 \else \ifnum\subsecno=0
6774 \putwordSection@tie \the\chapno.\the\secno
6775 \else \ifnum\subsubsecno=0
6776 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6778 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6783 \putwordAppendix@tie @char\the\appendixno{}%
6784 \else \ifnum\subsecno=0
6785 \putwordSection@tie @char\the\appendixno.\the\secno
6786 \else \ifnum\subsubsecno=0
6787 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6790 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6794 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6795 % If its value is nonempty, SUFFIX is output afterward.
6801 \expandafter\global\expandafter\let\expandafter\thisrefX
6802 \csname XR#1\endcsname
6805 % If not defined, say something at least.
6806 \angleleft un\-de\-fined\angleright
6809 \message{\linenumber Undefined cross reference `#1'.}%
6812 \global\warnedxrefstrue
6813 \message{Cross reference values unknown; you must run TeX again.}%
6818 % It's defined, so just use it.
6821 #2% Output the suffix in any case.
6824 % This is the macro invoked by entries in the aux file. Usually it's
6825 % just a \def (we prepend XR to the control sequence name to avoid
6826 % collisions). But if this is a float type, we have more work to do.
6829 {% The node name might contain 8-bit characters, which in our current
6830 % implementation are changed to commands like @'e. Don't let these
6831 % mess up the control sequence name.
6834 \xdef\safexrefname{#1}%
6837 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
6839 % Was that xref control sequence that we just defined for a float?
6840 \expandafter\iffloat\csname XR\safexrefname\endcsname
6841 % it was a float, and we have the (safe) float type in \iffloattype.
6842 \expandafter\let\expandafter\floatlist
6843 \csname floatlist\iffloattype\endcsname
6845 % Is this the first time we've seen this float type?
6846 \expandafter\ifx\floatlist\relax
6847 \toks0 = {\do}% yes, so just \do
6849 % had it before, so preserve previous elements in list.
6850 \toks0 = \expandafter{\floatlist\do}%
6853 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6854 % for later use in \listoffloats.
6855 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
6860 % Read the last existing aux file, if any. No error if none exists.
6863 \openin 1 \jobname.aux
6866 \global\havexrefstrue
6871 \def\setupdatafile{%
6872 \catcode`\^^@=\other
6873 \catcode`\^^A=\other
6874 \catcode`\^^B=\other
6875 \catcode`\^^C=\other
6876 \catcode`\^^D=\other
6877 \catcode`\^^E=\other
6878 \catcode`\^^F=\other
6879 \catcode`\^^G=\other
6880 \catcode`\^^H=\other
6881 \catcode`\^^K=\other
6882 \catcode`\^^L=\other
6883 \catcode`\^^N=\other
6884 \catcode`\^^P=\other
6885 \catcode`\^^Q=\other
6886 \catcode`\^^R=\other
6887 \catcode`\^^S=\other
6888 \catcode`\^^T=\other
6889 \catcode`\^^U=\other
6890 \catcode`\^^V=\other
6891 \catcode`\^^W=\other
6892 \catcode`\^^X=\other
6893 \catcode`\^^Z=\other
6894 \catcode`\^^[=\other
6895 \catcode`\^^\=\other
6896 \catcode`\^^]=\other
6897 \catcode`\^^^=\other
6898 \catcode`\^^_=\other
6899 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6900 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6901 % supported in the main text, it doesn't seem desirable. Furthermore,
6902 % that is not enough: for node names that actually contain a ^
6903 % character, we would end up writing a line like this: 'xrdef {'hat
6904 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6905 % argument, and \hat is not an expandable control sequence. It could
6906 % all be worked out, but why? Either we support ^^ or we don't.
6908 % The other change necessary for this was to define \auxhat:
6909 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6910 % and then to call \auxhat in \setq.
6914 % Special characters. Should be turned off anyway, but...
6927 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6929 % This is to support \ in node names and titles, since the \
6930 % characters end up in a \csname. It's easier than
6931 % leaving it active and making its active definition an actual \
6932 % character. What I don't understand is why it works in the *value*
6933 % of the xrdef. Seems like it should be a catcode12 \, and that
6934 % should not typeset properly. But it works, so I'm moving on for
6935 % now. --karl, 15jan04.
6938 % Make the characters 128-255 be printing characters.
6942 \catcode\count1=\other
6943 \advance\count1 by 1
6944 \ifnum \count1<256 \loop \fi
6948 % @ is our escape character in .aux files, and we need braces.
6954 \def\readdatafile#1{%
6961 \message{insertions,}
6962 % including footnotes.
6964 \newcount \footnoteno
6966 % The trailing space in the following definition for supereject is
6967 % vital for proper filling; pages come out unaligned when you do a
6968 % pagealignmacro call if that space before the closing brace is
6969 % removed. (Generally, numeric constants should always be followed by a
6970 % space to prevent strange expansion errors.)
6971 \def\supereject{\par\penalty -20000\footnoteno =0 }
6973 % @footnotestyle is meaningful for info output only.
6974 \let\footnotestyle=\comment
6978 % Auto-number footnotes. Otherwise like plain.
6980 \let\indent=\ptexindent
6981 \let\noindent=\ptexnoindent
6982 \global\advance\footnoteno by \@ne
6983 \edef\thisfootno{$^{\the\footnoteno}$}%
6985 % In case the footnote comes at the end of a sentence, preserve the
6986 % extra spacing after we do the footnote number.
6988 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6990 % Remove inadvertent blank space before typesetting the footnote number.
6996 % Don't bother with the trickery in plain.tex to not require the
6997 % footnote text as a parameter. Our footnotes don't need to be so general.
6999 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7000 % \parseargline) fails inside footnotes because the tokens are fixed when
7001 % the footnote is read. --karl, 16nov96.
7004 \insert\footins\bgroup
7005 % We want to typeset this text as a normal paragraph, even if the
7006 % footnote reference occurs in (for example) a display environment.
7007 % So reset some parameters.
7009 \interlinepenalty\interfootnotelinepenalty
7010 \splittopskip\ht\strutbox % top baseline for broken footnotes
7011 \splitmaxdepth\dp\strutbox
7012 \floatingpenalty\@MM
7017 \parindent\defaultparindent
7021 % Because we use hanging indentation in footnotes, a @noindent appears
7022 % to exdent this text, so make it be a no-op. makeinfo does not use
7023 % hanging indentation so @noindent can still be needed within footnote
7024 % text after an @example or the like (not that this is good style).
7025 \let\noindent = \relax
7027 % Hang the footnote text off the number. Use \everypar in case the
7028 % footnote extends for more than one paragraph.
7029 \everypar = {\hang}%
7030 \textindent{\thisfootno}%
7032 % Don't crash into the line above the footnote text. Since this
7033 % expands into a box, it must come within the paragraph, lest it
7034 % provide a place where TeX can split the footnote.
7036 \futurelet\next\fo@t
7038 }%end \catcode `\@=11
7040 % In case a @footnote appears in a vbox, save the footnote text and create
7041 % the real \insert just after the vbox finished. Otherwise, the insertion
7043 % Similarily, if a @footnote appears inside an alignment, save the footnote
7044 % text to a box and make the \insert when a row of the table is finished.
7045 % And the same can be done for other insert classes. --kasal, 16nov03.
7047 % Replace the \insert primitive by a cheating macro.
7048 % Deeper inside, just make sure that the saved insertions are not spilled
7051 \def\startsavinginserts{%
7052 \ifx \insert\ptexinsert
7053 \let\insert\saveinsert
7055 \let\checkinserts\relax
7059 % This \insert replacement works for both \insert\footins{foo} and
7060 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7063 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7064 \afterassignment\next
7065 % swallow the left brace
7068 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7069 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7071 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7073 \def\placesaveins#1{%
7074 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7078 % eat @SAVE -- beware, all of them have catcode \other:
7080 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7081 \gdef\gobblesave @SAVE{}
7085 \def\newsaveins #1{%
7086 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7089 \def\newsaveinsX #1{%
7090 \csname newbox\endcsname #1%
7091 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7096 \let\checkinserts\empty
7101 % @image. We use the macros from epsf.tex to support this.
7102 % If epsf.tex is not installed and @image is used, we complain.
7104 % Check for and read epsf.tex up front. If we read it only at @image
7105 % time, we might be inside a group, and then its definitions would get
7106 % undone and the next image would fail.
7107 \openin 1 = epsf.tex
7109 % Do not bother showing banner with epsf.tex v2.7k (available in
7110 % doc/epsf.tex and on ctan).
7111 \def\epsfannounce{\toks0 = }%
7116 % We will only complain once about lack of epsf.tex.
7117 \newif\ifwarnednoepsf
7118 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7119 work. It is also included in the Texinfo distribution, or you can get
7120 it from ftp://tug.org/tex/epsf.tex.}
7123 \ifx\epsfbox\undefined
7124 \ifwarnednoepsf \else
7125 \errhelp = \noepsfhelp
7126 \errmessage{epsf.tex not found, images will be ignored}%
7127 \global\warnednoepsftrue
7130 \imagexxx #1,,,,,\finish
7134 % Arguments to @image:
7135 % #1 is (mandatory) image filename; we tack on .eps extension.
7136 % #2 is (optional) width, #3 is (optional) height.
7137 % #4 is (ignored optional) html alt text.
7138 % #5 is (ignored optional) extension.
7139 % #6 is just the usual extra ignored arg for parsing this stuff.
7141 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7142 \catcode`\^^M = 5 % in case we're inside an example
7143 \normalturnoffactive % allow _ et al. in names
7144 % If the image is by itself, center it.
7148 % Usually we'll have text after the image which will insert
7149 % \parskip glue, so insert it here too to equalize the space
7151 \nobreak\vskip\parskip
7158 \dopdfimage{#1}{#2}{#3}%
7160 % \epsfbox itself resets \epsf?size at each figure.
7161 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7162 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7166 \ifimagevmode \egroup \bigbreak \fi % space after the image
7170 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7171 % etc. We don't actually implement floating yet, we always include the
7172 % float "here". But it seemed the best name for the future.
7174 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7176 % There may be a space before second and/or third parameter; delete it.
7177 \def\eatcommaspace#1, {#1,}
7179 % #1 is the optional FLOATTYPE, the text label for this float, typically
7180 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7181 % this float will not be numbered and cannot be referred to.
7183 % #2 is the optional xref label. Also must be present for the float to
7186 % #3 is the optional positioning argument; for now, it is ignored. It
7187 % will somehow specify the positions allowed to float to (here, top, bottom).
7189 % We keep a separate counter for each FLOATTYPE, which we reset at each
7190 % chapter-level command.
7191 \let\resetallfloatnos=\empty
7193 \def\dofloat#1,#2,#3,#4\finish{%
7194 \let\thiscaption=\empty
7195 \let\thisshortcaption=\empty
7197 % don't lose footnotes inside @float.
7199 % BEWARE: when the floats start float, we have to issue warning whenever an
7200 % insert appears inside a float which could possibly float. --kasal, 26may04
7204 % We can't be used inside a paragraph.
7209 \def\floatlabel{#2}%
7210 \def\floatloc{#3}% we do nothing with this yet.
7212 \ifx\floattype\empty
7213 \let\safefloattype=\empty
7216 % the floattype might have accents or other special characters,
7217 % but we need to use it in a control sequence name.
7220 \xdef\safefloattype{\floattype}%
7224 % If label is given but no type, we handle that as the empty type.
7225 \ifx\floatlabel\empty \else
7226 % We want each FLOATTYPE to be numbered separately (Figure 1,
7227 % Table 1, Figure 2, ...). (And if no label, no number.)
7229 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7230 \global\advance\floatno by 1
7233 % This magic value for \thissection is output by \setref as the
7234 % XREFLABEL-title value. \xrefX uses it to distinguish float
7235 % labels (which have a completely different output format) from
7236 % node and anchor labels. And \xrdef uses it to construct the
7239 \edef\thissection{\floatmagic=\safefloattype}%
7240 \setref{\floatlabel}{Yfloat}%
7244 % start with \parskip glue, I guess.
7247 % Don't suppress indentation if a float happens to start a section.
7248 \restorefirstparagraphindent
7251 % we have these possibilities:
7252 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7253 % @float Foo,lbl & no caption: Foo 1.1
7254 % @float Foo & @caption{Cap}: Foo: Cap
7255 % @float Foo & no caption: Foo
7256 % @float ,lbl & Caption{Cap}: 1.1: Cap
7257 % @float ,lbl & no caption: 1.1
7258 % @float & @caption{Cap}: Cap
7259 % @float & no caption:
7262 \let\floatident = \empty
7264 % In all cases, if we have a float type, it comes first.
7265 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7267 % If we have an xref label, the number comes next.
7268 \ifx\floatlabel\empty \else
7269 \ifx\floattype\empty \else % if also had float type, need tie first.
7270 \appendtomacro\floatident{\tie}%
7273 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7276 % Start the printed caption with what we've constructed in
7277 % \floatident, but keep it separate; we need \floatident again.
7278 \let\captionline = \floatident
7280 \ifx\thiscaption\empty \else
7281 \ifx\floatident\empty \else
7282 \appendtomacro\captionline{: }% had ident, so need a colon between
7286 \appendtomacro\captionline{\scanexp\thiscaption}%
7289 % If we have anything to print, print it, with space before.
7290 % Eventually this needs to become an \insert.
7291 \ifx\captionline\empty \else
7295 % Space below caption.
7299 % If have an xref label, write the list of floats info. Do this
7300 % after the caption, to avoid chance of it being a breakpoint.
7301 \ifx\floatlabel\empty \else
7302 % Write the text that goes in the lof to the aux file as
7303 % \floatlabel-lof. Besides \floatident, we include the short
7304 % caption if specified, else the full caption if specified, else nothing.
7308 % since we read the caption text in the macro world, where ^^M
7309 % is turned into a normal character, we have to scan it back, so
7310 % we don't write the literal three characters "^^M" into the aux file.
7312 \xdef\noexpand\gtemp{%
7313 \ifx\thisshortcaption\empty
7320 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7321 \ifx\gtemp\empty \else : \gtemp \fi}}%
7324 \egroup % end of \vtop
7326 % place the captured inserts
7328 % BEWARE: when the floats start floating, we have to issue warning
7329 % whenever an insert appears inside a float which could possibly
7330 % float. --kasal, 26may04
7335 % Append the tokens #2 to the definition of macro #1, not expanding either.
7337 \def\appendtomacro#1#2{%
7338 \expandafter\def\expandafter#1\expandafter{#1#2}%
7341 % @caption, @shortcaption
7343 \def\caption{\docaption\thiscaption}
7344 \def\shortcaption{\docaption\thisshortcaption}
7345 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7346 \def\defcaption#1#2{\egroup \def#1{#2}}
7348 % The parameter is the control sequence identifying the counter we are
7349 % going to use. Create it if it doesn't exist and assign it to \floatno.
7352 % Haven't seen this figure type before.
7353 \csname newcount\endcsname #1%
7355 % Remember to reset this floatno at the next chap.
7356 \expandafter\gdef\expandafter\resetallfloatnos
7357 \expandafter{\resetallfloatnos #1=0 }%
7362 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7363 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7364 % first read the @float command.
7366 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7368 % Magic string used for the XREFLABEL-title value, so \xrefX can
7369 % distinguish floats from other xref types.
7370 \def\floatmagic{!!float!!}
7372 % #1 is the control sequence we are passed; we expand into a conditional
7373 % which is true if #1 represents a float ref. That is, the magic
7374 % \thissection value which we \setref above.
7376 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7378 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7379 % (safe) float type for this float. We set \iffloattype to #2.
7381 \def\doiffloat#1=#2=#3\finish{%
7383 \def\iffloattype{#2}%
7384 \ifx\temp\floatmagic
7387 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7389 \parseargdef\listoffloats{%
7390 \def\floattype{#1}% floattype
7392 % the floattype might have accents or other special characters,
7393 % but we need to use it in a control sequence name.
7396 \xdef\safefloattype{\floattype}%
7399 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7400 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7402 % if the user said @listoffloats foo but never @float foo.
7403 \message{\linenumber No `\safefloattype' floats to list.}%
7407 \leftskip=\tocindent % indent these entries like a toc
7408 \let\do=\listoffloatsdo
7409 \csname floatlist\safefloattype\endcsname
7414 % This is called on each entry in a list of floats. We're passed the
7415 % xref label, in the form LABEL-title, which is how we save it in the
7416 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7417 % has the text we're supposed to typeset here.
7419 % Figures without xref labels will not be included in the list (since
7420 % they won't appear in the aux file).
7422 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7423 \def\listoffloatsdoentry#1-title\finish{{%
7424 % Can't fully expand XR#1-lof because it can contain anything. Just
7425 % pass the control sequence. On the other hand, XR#1-pg is just the
7426 % page number, and we want to fully expand that so we can get a link
7428 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7430 % use the same \entry macro we use to generate the TOC and index.
7431 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7436 \message{localization,}
7438 % @documentlanguage is usually given very early, just after
7439 % @setfilename. If done too late, it may not override everything
7440 % properly. Single argument is the language (de) or locale (de_DE)
7441 % abbreviation. It would be nice if we could set up a hyphenation file.
7444 \catcode`\_ = \active
7446 \parseargdef\documentlanguage{\begingroup
7447 \let_=\normalunderscore % normal _ character for filenames
7448 \tex % read txi-??.tex file in plain TeX.
7449 % Read the file by the name they passed if it exists.
7450 \openin 1 txi-#1.tex
7452 \documentlanguagetrywithoutunderscore{#1_\finish}%
7461 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7464 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7465 \openin 1 txi-#1.tex
7467 \errhelp = \nolanghelp
7468 \errmessage{Cannot read language file txi-#1.tex}%
7475 \newhelp\nolanghelp{The given language definition file cannot be found or
7476 is empty. Maybe you need to install it? In the current directory
7477 should work if nowhere else does.}
7479 % Set the catcode of characters 128 through 255 to the specified number.
7481 \def\setnonasciicharscatcode#1{%
7483 \loop\ifnum\count255<256
7484 \global\catcode\count255=#1
7485 \advance\count255 by 1
7489 \def\setnonasciicharscatcodenonglobal#1{%
7491 \loop\ifnum\count255<256
7492 \catcode\count255=#1
7493 \advance\count255 by 1
7497 % @documentencoding sets the definition of non-ASCII characters
7498 % according to the specified encoding.
7500 \parseargdef\documentencoding{%
7501 % Encoding being declared for the document.
7502 \def\declaredencoding{\csname #1.enc\endcsname}%
7504 % Supported encodings: names converted to tokens in order to be able
7505 % to compare them with \ifx.
7506 \def\ascii{\csname US-ASCII.enc\endcsname}%
7507 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7508 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7509 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7510 \def\utfeight{\csname UTF-8.enc\endcsname}%
7512 \ifx \declaredencoding \ascii
7515 \else \ifx \declaredencoding \lattwo
7516 \setnonasciicharscatcode\active
7519 \else \ifx \declaredencoding \latone
7520 \setnonasciicharscatcode\active
7523 \else \ifx \declaredencoding \latnine
7524 \setnonasciicharscatcode\active
7527 \else \ifx \declaredencoding \utfeight
7528 \setnonasciicharscatcode\active
7532 \message{Unknown document encoding #1, ignoring.}%
7541 % A message to be logged when using a character that isn't available
7542 % the default font encoding (OT1).
7544 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7546 % Take account of \c (plain) vs. \, (Texinfo) difference.
7547 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7549 % First, make active non-ASCII characters in order for them to be
7550 % correctly categorized when TeX reads the replacement text of
7551 % macros containing the character definitions.
7552 \setnonasciicharscatcode\active
7554 % Latin1 (ISO-8859-1) character definitions.
7555 \def\latonechardefs{%
7557 \gdef^^a1{\exclamdown}
7558 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7559 \gdef^^a3{{\pounds}}
7560 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7561 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7562 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7565 \gdef^^a9{\copyright}
7567 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7570 \gdef^^ae{\registeredsymbol}
7573 \gdef^^b0{\textdegree}
7582 \gdef^^b8{\cedilla\ }
7586 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7587 \gdef^^bc{$1\over4$}
7588 \gdef^^bd{$1\over2$}
7589 \gdef^^be{$3\over4$}
7590 \gdef^^bf{\questiondown}
7597 \gdef^^c5{\ringaccent A}
7599 \gdef^^c7{\cedilla C}
7609 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7623 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7631 \gdef^^e5{\ringaccent a}
7633 \gdef^^e7{\cedilla c}
7638 \gdef^^ec{\`{\dotless i}}
7639 \gdef^^ed{\'{\dotless i}}
7640 \gdef^^ee{\^{\dotless i}}
7641 \gdef^^ef{\"{\dotless i}}
7643 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7657 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7661 % Latin9 (ISO-8859-15) encoding character definitions.
7662 \def\latninechardefs{%
7663 % Encoding is almost identical to Latin1.
7676 % Latin2 (ISO-8859-2) character definitions.
7677 \def\lattwochardefs{%
7679 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7682 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7688 \gdef^^aa{\cedilla S}
7693 \gdef^^af{\dotaccent Z}
7695 \gdef^^b0{\textdegree}
7696 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7697 \gdef^^b2{\missingcharmsg{OGONEK}}
7703 \gdef^^b8{\cedilla\ }
7705 \gdef^^ba{\cedilla s}
7710 \gdef^^bf{\dotaccent z}
7719 \gdef^^c7{\cedilla C}
7722 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
7729 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
7738 \gdef^^d9{\ringaccent U}
7743 \gdef^^de{\cedilla T}
7753 \gdef^^e7{\cedilla c}
7756 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
7763 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
7772 \gdef^^f9{\ringaccent u}
7777 \gdef^^fe{\cedilla t}
7778 \gdef^^ff{\dotaccent{}}
7781 % UTF-8 character definitions.
7783 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
7784 % changes for Texinfo conventions. It is included here under the GPL by
7785 % permission from Frank Mittelbach and the LaTeX team.
7791 \gdef\UTFviiiTwoOctets#1#2{\expandafter
7792 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
7794 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
7795 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
7797 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
7798 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
7800 \gdef\UTFviiiDefined#1{%
7802 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
7813 \global\catcode\countUTFx\active
7814 \uccode`\~\countUTFx
7815 \uppercase\expandafter{\UTFviiiTmp}%
7816 \advance\countUTFx by 1
7817 \ifnum\countUTFx < \countUTFy
7818 \expandafter\UTFviiiLoop
7824 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
7830 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
7836 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
7849 \gdef\DeclareUnicodeCharacter#1#2{%
7850 \countUTFz = "#1\relax
7851 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
7854 \def\UTFviiiTwoOctets##1##2{%
7855 \csname u8:##1\string ##2\endcsname}%
7856 \def\UTFviiiThreeOctets##1##2##3{%
7857 \csname u8:##1\string ##2\string ##3\endcsname}%
7858 \def\UTFviiiFourOctets##1##2##3##4{%
7859 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
7860 \expandafter\expandafter\expandafter\expandafter
7861 \expandafter\expandafter\expandafter
7862 \gdef\UTFviiiTmp{#2}%
7865 \gdef\parseXMLCharref{%
7866 \ifnum\countUTFz < "A0\relax
7867 \errhelp = \EMsimple
7868 \errmessage{Cannot define Unicode char value < 00A0}%
7869 \else\ifnum\countUTFz < "800\relax
7871 \parseUTFviiiB C\UTFviiiTwoOctets.,%
7872 \else\ifnum\countUTFz < "10000\relax
7875 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
7880 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
7884 \gdef\parseUTFviiiA#1{%
7885 \countUTFx = \countUTFz
7886 \divide\countUTFz by 64
7887 \countUTFy = \countUTFz
7888 \multiply\countUTFz by 64
7889 \advance\countUTFx by -\countUTFz
7890 \advance\countUTFx by 128
7891 \uccode `#1\countUTFx
7892 \countUTFz = \countUTFy}
7894 \gdef\parseUTFviiiB#1#2#3#4{%
7895 \advance\countUTFz by "#10\relax
7896 \uccode `#3\countUTFz
7897 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
7900 \def\utfeightchardefs{%
7901 \DeclareUnicodeCharacter{00A0}{\tie}
7902 \DeclareUnicodeCharacter{00A1}{\exclamdown}
7903 \DeclareUnicodeCharacter{00A3}{\pounds}
7904 \DeclareUnicodeCharacter{00A8}{\"{ }}
7905 \DeclareUnicodeCharacter{00A9}{\copyright}
7906 \DeclareUnicodeCharacter{00AA}{\ordf}
7907 \DeclareUnicodeCharacter{00AD}{\-}
7908 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
7909 \DeclareUnicodeCharacter{00AF}{\={ }}
7911 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
7912 \DeclareUnicodeCharacter{00B4}{\'{ }}
7913 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
7914 \DeclareUnicodeCharacter{00BA}{\ordm}
7915 \DeclareUnicodeCharacter{00BF}{\questiondown}
7917 \DeclareUnicodeCharacter{00C0}{\`A}
7918 \DeclareUnicodeCharacter{00C1}{\'A}
7919 \DeclareUnicodeCharacter{00C2}{\^A}
7920 \DeclareUnicodeCharacter{00C3}{\~A}
7921 \DeclareUnicodeCharacter{00C4}{\"A}
7922 \DeclareUnicodeCharacter{00C5}{\AA}
7923 \DeclareUnicodeCharacter{00C6}{\AE}
7924 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
7925 \DeclareUnicodeCharacter{00C8}{\`E}
7926 \DeclareUnicodeCharacter{00C9}{\'E}
7927 \DeclareUnicodeCharacter{00CA}{\^E}
7928 \DeclareUnicodeCharacter{00CB}{\"E}
7929 \DeclareUnicodeCharacter{00CC}{\`I}
7930 \DeclareUnicodeCharacter{00CD}{\'I}
7931 \DeclareUnicodeCharacter{00CE}{\^I}
7932 \DeclareUnicodeCharacter{00CF}{\"I}
7934 \DeclareUnicodeCharacter{00D1}{\~N}
7935 \DeclareUnicodeCharacter{00D2}{\`O}
7936 \DeclareUnicodeCharacter{00D3}{\'O}
7937 \DeclareUnicodeCharacter{00D4}{\^O}
7938 \DeclareUnicodeCharacter{00D5}{\~O}
7939 \DeclareUnicodeCharacter{00D6}{\"O}
7940 \DeclareUnicodeCharacter{00D8}{\O}
7941 \DeclareUnicodeCharacter{00D9}{\`U}
7942 \DeclareUnicodeCharacter{00DA}{\'U}
7943 \DeclareUnicodeCharacter{00DB}{\^U}
7944 \DeclareUnicodeCharacter{00DC}{\"U}
7945 \DeclareUnicodeCharacter{00DD}{\'Y}
7946 \DeclareUnicodeCharacter{00DF}{\ss}
7948 \DeclareUnicodeCharacter{00E0}{\`a}
7949 \DeclareUnicodeCharacter{00E1}{\'a}
7950 \DeclareUnicodeCharacter{00E2}{\^a}
7951 \DeclareUnicodeCharacter{00E3}{\~a}
7952 \DeclareUnicodeCharacter{00E4}{\"a}
7953 \DeclareUnicodeCharacter{00E5}{\aa}
7954 \DeclareUnicodeCharacter{00E6}{\ae}
7955 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
7956 \DeclareUnicodeCharacter{00E8}{\`e}
7957 \DeclareUnicodeCharacter{00E9}{\'e}
7958 \DeclareUnicodeCharacter{00EA}{\^e}
7959 \DeclareUnicodeCharacter{00EB}{\"e}
7960 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
7961 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
7962 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
7963 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
7965 \DeclareUnicodeCharacter{00F1}{\~n}
7966 \DeclareUnicodeCharacter{00F2}{\`o}
7967 \DeclareUnicodeCharacter{00F3}{\'o}
7968 \DeclareUnicodeCharacter{00F4}{\^o}
7969 \DeclareUnicodeCharacter{00F5}{\~o}
7970 \DeclareUnicodeCharacter{00F6}{\"o}
7971 \DeclareUnicodeCharacter{00F8}{\o}
7972 \DeclareUnicodeCharacter{00F9}{\`u}
7973 \DeclareUnicodeCharacter{00FA}{\'u}
7974 \DeclareUnicodeCharacter{00FB}{\^u}
7975 \DeclareUnicodeCharacter{00FC}{\"u}
7976 \DeclareUnicodeCharacter{00FD}{\'y}
7977 \DeclareUnicodeCharacter{00FF}{\"y}
7979 \DeclareUnicodeCharacter{0100}{\=A}
7980 \DeclareUnicodeCharacter{0101}{\=a}
7981 \DeclareUnicodeCharacter{0102}{\u{A}}
7982 \DeclareUnicodeCharacter{0103}{\u{a}}
7983 \DeclareUnicodeCharacter{0106}{\'C}
7984 \DeclareUnicodeCharacter{0107}{\'c}
7985 \DeclareUnicodeCharacter{0108}{\^C}
7986 \DeclareUnicodeCharacter{0109}{\^c}
7987 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
7988 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
7989 \DeclareUnicodeCharacter{010C}{\v{C}}
7990 \DeclareUnicodeCharacter{010D}{\v{c}}
7991 \DeclareUnicodeCharacter{010E}{\v{D}}
7993 \DeclareUnicodeCharacter{0112}{\=E}
7994 \DeclareUnicodeCharacter{0113}{\=e}
7995 \DeclareUnicodeCharacter{0114}{\u{E}}
7996 \DeclareUnicodeCharacter{0115}{\u{e}}
7997 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
7998 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
7999 \DeclareUnicodeCharacter{011A}{\v{E}}
8000 \DeclareUnicodeCharacter{011B}{\v{e}}
8001 \DeclareUnicodeCharacter{011C}{\^G}
8002 \DeclareUnicodeCharacter{011D}{\^g}
8003 \DeclareUnicodeCharacter{011E}{\u{G}}
8004 \DeclareUnicodeCharacter{011F}{\u{g}}
8006 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8007 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8008 \DeclareUnicodeCharacter{0124}{\^H}
8009 \DeclareUnicodeCharacter{0125}{\^h}
8010 \DeclareUnicodeCharacter{0128}{\~I}
8011 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8012 \DeclareUnicodeCharacter{012A}{\=I}
8013 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8014 \DeclareUnicodeCharacter{012C}{\u{I}}
8015 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8017 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8018 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8019 \DeclareUnicodeCharacter{0132}{IJ}
8020 \DeclareUnicodeCharacter{0133}{ij}
8021 \DeclareUnicodeCharacter{0134}{\^J}
8022 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8023 \DeclareUnicodeCharacter{0139}{\'L}
8024 \DeclareUnicodeCharacter{013A}{\'l}
8026 \DeclareUnicodeCharacter{0141}{\L}
8027 \DeclareUnicodeCharacter{0142}{\l}
8028 \DeclareUnicodeCharacter{0143}{\'N}
8029 \DeclareUnicodeCharacter{0144}{\'n}
8030 \DeclareUnicodeCharacter{0147}{\v{N}}
8031 \DeclareUnicodeCharacter{0148}{\v{n}}
8032 \DeclareUnicodeCharacter{014C}{\=O}
8033 \DeclareUnicodeCharacter{014D}{\=o}
8034 \DeclareUnicodeCharacter{014E}{\u{O}}
8035 \DeclareUnicodeCharacter{014F}{\u{o}}
8037 \DeclareUnicodeCharacter{0150}{\H{O}}
8038 \DeclareUnicodeCharacter{0151}{\H{o}}
8039 \DeclareUnicodeCharacter{0152}{\OE}
8040 \DeclareUnicodeCharacter{0153}{\oe}
8041 \DeclareUnicodeCharacter{0154}{\'R}
8042 \DeclareUnicodeCharacter{0155}{\'r}
8043 \DeclareUnicodeCharacter{0158}{\v{R}}
8044 \DeclareUnicodeCharacter{0159}{\v{r}}
8045 \DeclareUnicodeCharacter{015A}{\'S}
8046 \DeclareUnicodeCharacter{015B}{\'s}
8047 \DeclareUnicodeCharacter{015C}{\^S}
8048 \DeclareUnicodeCharacter{015D}{\^s}
8049 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8050 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8052 \DeclareUnicodeCharacter{0160}{\v{S}}
8053 \DeclareUnicodeCharacter{0161}{\v{s}}
8054 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8055 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8056 \DeclareUnicodeCharacter{0164}{\v{T}}
8058 \DeclareUnicodeCharacter{0168}{\~U}
8059 \DeclareUnicodeCharacter{0169}{\~u}
8060 \DeclareUnicodeCharacter{016A}{\=U}
8061 \DeclareUnicodeCharacter{016B}{\=u}
8062 \DeclareUnicodeCharacter{016C}{\u{U}}
8063 \DeclareUnicodeCharacter{016D}{\u{u}}
8064 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8065 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8067 \DeclareUnicodeCharacter{0170}{\H{U}}
8068 \DeclareUnicodeCharacter{0171}{\H{u}}
8069 \DeclareUnicodeCharacter{0174}{\^W}
8070 \DeclareUnicodeCharacter{0175}{\^w}
8071 \DeclareUnicodeCharacter{0176}{\^Y}
8072 \DeclareUnicodeCharacter{0177}{\^y}
8073 \DeclareUnicodeCharacter{0178}{\"Y}
8074 \DeclareUnicodeCharacter{0179}{\'Z}
8075 \DeclareUnicodeCharacter{017A}{\'z}
8076 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8077 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8078 \DeclareUnicodeCharacter{017D}{\v{Z}}
8079 \DeclareUnicodeCharacter{017E}{\v{z}}
8081 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8082 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8083 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8084 \DeclareUnicodeCharacter{01C7}{LJ}
8085 \DeclareUnicodeCharacter{01C8}{Lj}
8086 \DeclareUnicodeCharacter{01C9}{lj}
8087 \DeclareUnicodeCharacter{01CA}{NJ}
8088 \DeclareUnicodeCharacter{01CB}{Nj}
8089 \DeclareUnicodeCharacter{01CC}{nj}
8090 \DeclareUnicodeCharacter{01CD}{\v{A}}
8091 \DeclareUnicodeCharacter{01CE}{\v{a}}
8092 \DeclareUnicodeCharacter{01CF}{\v{I}}
8094 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8095 \DeclareUnicodeCharacter{01D1}{\v{O}}
8096 \DeclareUnicodeCharacter{01D2}{\v{o}}
8097 \DeclareUnicodeCharacter{01D3}{\v{U}}
8098 \DeclareUnicodeCharacter{01D4}{\v{u}}
8100 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8101 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8102 \DeclareUnicodeCharacter{01E6}{\v{G}}
8103 \DeclareUnicodeCharacter{01E7}{\v{g}}
8104 \DeclareUnicodeCharacter{01E8}{\v{K}}
8105 \DeclareUnicodeCharacter{01E9}{\v{k}}
8107 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8108 \DeclareUnicodeCharacter{01F1}{DZ}
8109 \DeclareUnicodeCharacter{01F2}{Dz}
8110 \DeclareUnicodeCharacter{01F3}{dz}
8111 \DeclareUnicodeCharacter{01F4}{\'G}
8112 \DeclareUnicodeCharacter{01F5}{\'g}
8113 \DeclareUnicodeCharacter{01F8}{\`N}
8114 \DeclareUnicodeCharacter{01F9}{\`n}
8115 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8116 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8117 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8118 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8120 \DeclareUnicodeCharacter{021E}{\v{H}}
8121 \DeclareUnicodeCharacter{021F}{\v{h}}
8123 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8124 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8125 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8126 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8127 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8128 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8130 \DeclareUnicodeCharacter{0232}{\=Y}
8131 \DeclareUnicodeCharacter{0233}{\=y}
8132 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8134 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8135 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8136 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8137 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8138 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8139 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8140 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8141 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8142 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8143 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8144 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8145 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8147 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8148 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8150 \DeclareUnicodeCharacter{1E20}{\=G}
8151 \DeclareUnicodeCharacter{1E21}{\=g}
8152 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8153 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8154 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8155 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8156 \DeclareUnicodeCharacter{1E26}{\"H}
8157 \DeclareUnicodeCharacter{1E27}{\"h}
8159 \DeclareUnicodeCharacter{1E30}{\'K}
8160 \DeclareUnicodeCharacter{1E31}{\'k}
8161 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8162 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8163 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8164 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8165 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8166 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8167 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8168 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8169 \DeclareUnicodeCharacter{1E3E}{\'M}
8170 \DeclareUnicodeCharacter{1E3F}{\'m}
8172 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8173 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8174 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8175 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8176 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8177 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8178 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8179 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8180 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8181 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8183 \DeclareUnicodeCharacter{1E54}{\'P}
8184 \DeclareUnicodeCharacter{1E55}{\'p}
8185 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8186 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8187 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8188 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8189 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8190 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8191 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8192 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8194 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8195 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8196 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8197 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8198 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8199 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8200 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8201 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8202 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8203 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8205 \DeclareUnicodeCharacter{1E7C}{\~V}
8206 \DeclareUnicodeCharacter{1E7D}{\~v}
8207 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8208 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8210 \DeclareUnicodeCharacter{1E80}{\`W}
8211 \DeclareUnicodeCharacter{1E81}{\`w}
8212 \DeclareUnicodeCharacter{1E82}{\'W}
8213 \DeclareUnicodeCharacter{1E83}{\'w}
8214 \DeclareUnicodeCharacter{1E84}{\"W}
8215 \DeclareUnicodeCharacter{1E85}{\"w}
8216 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8217 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8218 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8219 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8220 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8221 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8222 \DeclareUnicodeCharacter{1E8C}{\"X}
8223 \DeclareUnicodeCharacter{1E8D}{\"x}
8224 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8225 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8227 \DeclareUnicodeCharacter{1E90}{\^Z}
8228 \DeclareUnicodeCharacter{1E91}{\^z}
8229 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8230 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8231 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8232 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8233 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8234 \DeclareUnicodeCharacter{1E97}{\"t}
8235 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8236 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8238 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8239 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8241 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8242 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8243 \DeclareUnicodeCharacter{1EBC}{\~E}
8244 \DeclareUnicodeCharacter{1EBD}{\~e}
8246 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8247 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8248 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8249 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8251 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8252 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8254 \DeclareUnicodeCharacter{1EF2}{\`Y}
8255 \DeclareUnicodeCharacter{1EF3}{\`y}
8256 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8258 \DeclareUnicodeCharacter{1EF8}{\~Y}
8259 \DeclareUnicodeCharacter{1EF9}{\~y}
8261 \DeclareUnicodeCharacter{2013}{--}
8262 \DeclareUnicodeCharacter{2014}{---}
8263 \DeclareUnicodeCharacter{2022}{\bullet}
8264 \DeclareUnicodeCharacter{2026}{\dots}
8265 \DeclareUnicodeCharacter{20AC}{\euro}
8267 \DeclareUnicodeCharacter{2192}{\expansion}
8268 \DeclareUnicodeCharacter{21D2}{\result}
8270 \DeclareUnicodeCharacter{2212}{\minus}
8271 \DeclareUnicodeCharacter{2217}{\point}
8272 \DeclareUnicodeCharacter{2261}{\equiv}
8273 }% end of \utfeightchardefs
8276 % US-ASCII character definitions.
8277 \def\asciichardefs{% nothing need be done
8281 % Make non-ASCII characters printable again for compatibility with
8282 % existing Texinfo documents that may use them, even without declaring a
8283 % document encoding.
8285 \setnonasciicharscatcode \other
8288 \message{formatting,}
8290 \newdimen\defaultparindent \defaultparindent = 15pt
8292 \chapheadingskip = 15pt plus 4pt minus 2pt
8293 \secheadingskip = 12pt plus 3pt minus 2pt
8294 \subsecheadingskip = 9pt plus 2pt minus 2pt
8296 % Prevent underfull vbox error messages.
8299 % Don't be so finicky about underfull hboxes, either.
8302 % Following George Bush, just get rid of widows and orphans.
8306 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8307 % using an old version of TeX, don't do anything. We want the amount of
8308 % stretch added to depend on the line length, hence the dependence on
8309 % \hsize. We call this whenever the paper size is set.
8311 \def\setemergencystretch{%
8312 \ifx\emergencystretch\thisisundefined
8313 % Allow us to assign to \emergencystretch anyway.
8314 \def\emergencystretch{\dimen0}%
8316 \emergencystretch = .15\hsize
8320 % Parameters in order: 1) textheight; 2) textwidth;
8321 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8322 % 7) physical page height; 8) physical page width.
8324 % We also call \setleading{\textleading}, so the caller should define
8325 % \textleading. The caller should also set \parskip.
8327 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8330 \splittopskip = \topskip
8333 \advance\vsize by \topskip
8334 \outervsize = \vsize
8335 \advance\outervsize by 2\topandbottommargin
8336 \pageheight = \vsize
8339 \outerhsize = \hsize
8340 \advance\outerhsize by 0.5in
8343 \normaloffset = #4\relax
8344 \bindingoffset = #5\relax
8347 \pdfpageheight #7\relax
8348 \pdfpagewidth #8\relax
8349 % if we don't reset these, they will remain at "1 true in" of
8350 % whatever layout pdftex was dumped with.
8351 \pdfhorigin = 1 true in
8352 \pdfvorigin = 1 true in
8355 \setleading{\textleading}
8357 \parindent = \defaultparindent
8358 \setemergencystretch
8361 % @letterpaper (the default).
8362 \def\letterpaper{{\globaldefs = 1
8363 \parskip = 3pt plus 2pt minus 1pt
8364 \textleading = 13.2pt
8366 % If page is nothing but text, make it come out even.
8367 \internalpagesizes{46\baselineskip}{6in}%
8369 {\bindingoffset}{36pt}%
8373 % Use @smallbook to reset parameters for 7x9.25 trim size.
8374 \def\smallbook{{\globaldefs = 1
8375 \parskip = 2pt plus 1pt
8378 \internalpagesizes{7.5in}{5in}%
8380 {\bindingoffset}{16pt}%
8383 \lispnarrowing = 0.3in
8386 \contentsrightmargin = 0pt
8387 \defbodyindent = .5cm
8390 % Use @smallerbook to reset parameters for 6x9 trim size.
8391 % (Just testing, parameters still in flux.)
8392 \def\smallerbook{{\globaldefs = 1
8393 \parskip = 1.5pt plus 1pt
8396 \internalpagesizes{7.4in}{4.8in}%
8401 \lispnarrowing = 0.25in
8404 \contentsrightmargin = 0pt
8405 \defbodyindent = .4cm
8408 % Use @afourpaper to print on European A4 paper.
8409 \def\afourpaper{{\globaldefs = 1
8410 \parskip = 3pt plus 2pt minus 1pt
8411 \textleading = 13.2pt
8413 % Double-side printing via postscript on Laserjet 4050
8414 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8415 % To change the settings for a different printer or situation, adjust
8416 % \normaloffset until the front-side and back-side texts align. Then
8417 % do the same for \bindingoffset. You can set these for testing in
8418 % your texinfo source file like this:
8420 % \global\normaloffset = -6mm
8421 % \global\bindingoffset = 10mm
8423 \internalpagesizes{51\baselineskip}{160mm}
8424 {\voffset}{\hoffset}%
8425 {\bindingoffset}{44pt}%
8430 \contentsrightmargin = 0pt
8431 \defbodyindent = 5mm
8434 % Use @afivepaper to print on European A5 paper.
8435 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8436 % He also recommends making @example and @lisp be small.
8437 \def\afivepaper{{\globaldefs = 1
8438 \parskip = 2pt plus 1pt minus 0.1pt
8439 \textleading = 12.5pt
8441 \internalpagesizes{160mm}{120mm}%
8442 {\voffset}{\hoffset}%
8443 {\bindingoffset}{8pt}%
8446 \lispnarrowing = 0.2in
8449 \contentsrightmargin = 0pt
8450 \defbodyindent = 2mm
8454 % A specific text layout, 24x15cm overall, intended for A4 paper.
8455 \def\afourlatex{{\globaldefs = 1
8457 \internalpagesizes{237mm}{150mm}%
8459 {\bindingoffset}{7mm}%
8462 % Must explicitly reset to 0 because we call \afourpaper.
8466 % Use @afourwide to print on A4 paper in landscape format.
8467 \def\afourwide{{\globaldefs = 1
8469 \internalpagesizes{241mm}{165mm}%
8470 {\voffset}{-2.95mm}%
8471 {\bindingoffset}{7mm}%
8476 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8477 % Perhaps we should allow setting the margins, \topskip, \parskip,
8478 % and/or leading, also. Or perhaps we should compute them somehow.
8480 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8481 \def\pagesizesyyy#1,#2,#3\finish{{%
8482 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8485 \parskip = 3pt plus 2pt minus 1pt
8486 \setleading{\textleading}%
8489 \advance\dimen0 by \voffset
8492 \advance\dimen2 by \normaloffset
8494 \internalpagesizes{#1}{\hsize}%
8495 {\voffset}{\normaloffset}%
8496 {\bindingoffset}{44pt}%
8500 % Set default to letter.
8505 \message{and turning on texinfo input format.}
8507 % Define macros to output various characters with catcode for normal text.
8517 \def\normaldoublequote{"}
8520 \def\normalunderscore{_}
8521 \def\normalverticalbar{|}
8523 \def\normalgreater{>}
8525 \def\normaldollar{$}%$ font-lock fix
8527 % This macro is used to make a character print one way in \tt
8528 % (where it can probably be output as-is), and another way in other fonts,
8529 % where something hairier probably needs to be done.
8531 % #1 is what to print if we are indeed using \tt; #2 is what to print
8532 % otherwise. Since all the Computer Modern typewriter fonts have zero
8533 % interword stretch (and shrink), and it is reasonable to expect all
8534 % typewriter fonts to have this, we can check that font parameter.
8536 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8538 % Same as above, but check for italic font. Actually this also catches
8539 % non-italic slanted fonts since it is impossible to distinguish them from
8540 % italic fonts. But since this is only used by $ and it uses \sl anyway
8541 % this is not a problem.
8542 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8544 % Turn off all special characters except @
8545 % (and those which the user can use as if they were ordinary).
8546 % Most of these we simply print from the \tt font, but for some, we can
8547 % use math or other variants that look better in normal text.
8550 \def\activedoublequote{{\tt\char34}}
8551 \let"=\activedoublequote
8553 \def~{{\tt\char126}}
8559 \def_{\ifusingtt\normalunderscore\_}
8561 % Subroutine for the previous macro.
8562 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8565 \def|{{\tt\char124}}
8573 \def+{{\tt \char 43}}
8575 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8577 % If a .fmt file is being used, characters that might appear in a file
8578 % name cannot be active until we have parsed the command line.
8579 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8580 % \otherifyactive is called near the end of this file.
8581 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8583 % Used sometimes to turn off (effectively) the active characters even after
8585 \def\turnoffactive{%
8586 \normalturnoffactive
8592 % \backslashcurfont outputs one backslash character in current font,
8594 \global\chardef\backslashcurfont=`\\
8595 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8597 % \realbackslash is an actual character `\' with catcode other, and
8598 % \doublebackslash is two of them (for the pdf outlines).
8599 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8601 % In texinfo, backslash is an active character; it prints the backslash
8602 % in fixed width font.
8604 @def@normalbackslash{{@tt@backslashcurfont}}
8605 % On startup, @fixbackslash assigns:
8606 % @let \ = @normalbackslash
8608 % \rawbackslash defines an active \ to do \backslashcurfont.
8609 % \otherbackslash defines an active \ to be a literal `\' character with
8611 @gdef@rawbackslash{@let\=@backslashcurfont}
8612 @gdef@otherbackslash{@let\=@realbackslash}
8614 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8615 % the literal character `\'.
8617 @def@normalturnoffactive{%
8618 @let\=@normalbackslash
8619 @let"=@normaldoublequote
8622 @let_=@normalunderscore
8623 @let|=@normalverticalbar
8625 @let>=@normalgreater
8627 @let$=@normaldollar %$ font-lock fix
8631 % Make _ and + \other characters, temporarily.
8632 % This is canceled by @fixbackslash.
8635 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8636 % That is what \eatinput is for; after that, the `\' should revert to printing
8639 @gdef@eatinput input texinfo{@fixbackslash}
8640 @global@let\ = @eatinput
8642 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8643 % the first `\' in the file would cause an error. This macro tries to fix
8644 % that, assuming it is called before the first `\' could plausibly occur.
8645 % Also turn back on active characters that might appear in the input
8646 % file name, in case not using a pre-dumped format.
8648 @gdef@fixbackslash{%
8649 @ifx\@eatinput @let\ = @normalbackslash @fi
8654 % Say @foo, not \foo, in error messages.
8657 % These look ok in all fonts, so just make them not special.
8658 @catcode`@& = @other
8659 @catcode`@# = @other
8660 @catcode`@% = @other
8664 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8665 @c page-delimiter: "^\\\\message"
8666 @c time-stamp-start: "def\\\\texinfoversion{"
8667 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8668 @c time-stamp-end: "}"
8674 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115