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-05.10}
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\relax \unvbox#1\relax
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 % Color manipulation macros from pdfcolor.tex.
1265 \def\cmykDarkRed{0.28 1 1 0.35}
1266 \def\cmykBlack{0 0 0 1}
1268 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1269 \def\setcolor#1{\mark{#1}\pdfsetcolor{#1}}
1271 \def\maincolor{\cmykBlack}
1272 \pdfsetcolor{\maincolor}
1276 \line{\pdfsetcolor{\maincolor}\the\footline}}
1280 \ifx\M\empty\let\M=\maincolor\fi
1281 \vbox to 0pt{\vskip-22.5pt
1282 \line{\vbox to8.5pt{}%
1283 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\M}}\vss}%
1287 \pdfcatalog{/PageMode /UseOutlines}
1289 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1290 \def\dopdfimage#1#2#3{%
1291 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1292 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1294 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1295 % others). Let's try in that order.
1296 \let\pdfimgext=\empty
1298 \openin 1 #1.png \ifeof 1
1299 \openin 1 #1.jpg \ifeof 1
1300 \openin 1 #1.jpeg \ifeof 1
1301 \openin 1 #1.JPG \ifeof 1
1302 \openin 1 #1.pdf \ifeof 1
1303 \errhelp = \nopdfimagehelp
1304 \errmessage{Could not find image file #1 for pdf}%
1305 \else \gdef\pdfimgext{pdf}%
1307 \else \gdef\pdfimgext{JPG}%
1309 \else \gdef\pdfimgext{jpeg}%
1311 \else \gdef\pdfimgext{jpg}%
1313 \else \gdef\pdfimgext{png}%
1318 % without \immediate, pdftex seg faults when the same image is
1319 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1320 \ifnum\pdftexversion < 14
1323 \immediate\pdfximage
1325 \ifdim \wd0 >0pt width \imagewidth \fi
1326 \ifdim \wd2 >0pt height \imageheight \fi
1327 \ifnum\pdftexversion<13
1332 \ifnum\pdftexversion < 14 \else
1333 \pdfrefximage \pdflastximage
1337 % We have to set dummies so commands such as @code, and characters
1338 % such as \, aren't expanded when present in a section title.
1341 \activebackslashdouble
1342 \makevalueexpandable
1343 \def\pdfdestname{#1}%
1344 \backslashparens\pdfdestname
1345 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1348 % used to mark target names; must be expandable.
1351 % by default, use a color that is dark enough to print on paper as
1352 % nearly black, but still distinguishable for online viewing.
1353 \def\urlcolor{\cmykDarkRed}
1354 \def\linkcolor{\cmykDarkRed}
1355 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1357 % Adding outlines to PDF; macros for calculating structure of outlines
1358 % come from Petr Olsak
1359 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1360 \else \csname#1\endcsname \fi}
1361 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1362 \advance\tempnum by 1
1363 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1365 % #1 is the section text, which is what will be displayed in the
1366 % outline by the pdf viewer. #2 is the pdf expression for the number
1367 % of subentries (or empty, for subsubsections). #3 is the node text,
1368 % which might be empty if this toc entry had no corresponding node.
1369 % #4 is the page number
1371 \def\dopdfoutline#1#2#3#4{%
1372 % Generate a link to the node text if that exists; else, use the
1373 % page number. We could generate a destination for the section
1374 % text in the case where a section has no node, but it doesn't
1375 % seem worth the trouble, since most documents are normally structured.
1376 \def\pdfoutlinedest{#3}%
1377 \ifx\pdfoutlinedest\empty
1378 \def\pdfoutlinedest{#4}%
1380 % Doubled backslashes in the name.
1381 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1382 \backslashparens\pdfoutlinedest}%
1385 % Also double the backslashes in the display string.
1386 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1387 \backslashparens\pdfoutlinetext}%
1389 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1392 \def\pdfmakeoutlines{%
1394 % Thanh's hack / proper braces in bookmarks
1395 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1396 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1398 % Read toc silently, to get counts of subentries for \pdfoutline.
1399 \def\numchapentry##1##2##3##4{%
1400 \def\thischapnum{##2}%
1402 \def\thissubsecnum{0}%
1404 \def\numsecentry##1##2##3##4{%
1405 \advancenumber{chap\thischapnum}%
1406 \def\thissecnum{##2}%
1407 \def\thissubsecnum{0}%
1409 \def\numsubsecentry##1##2##3##4{%
1410 \advancenumber{sec\thissecnum}%
1411 \def\thissubsecnum{##2}%
1413 \def\numsubsubsecentry##1##2##3##4{%
1414 \advancenumber{subsec\thissubsecnum}%
1416 \def\thischapnum{0}%
1418 \def\thissubsecnum{0}%
1420 % use \def rather than \let here because we redefine \chapentry et
1421 % al. a second time, below.
1422 \def\appentry{\numchapentry}%
1423 \def\appsecentry{\numsecentry}%
1424 \def\appsubsecentry{\numsubsecentry}%
1425 \def\appsubsubsecentry{\numsubsubsecentry}%
1426 \def\unnchapentry{\numchapentry}%
1427 \def\unnsecentry{\numsecentry}%
1428 \def\unnsubsecentry{\numsubsecentry}%
1429 \def\unnsubsubsecentry{\numsubsubsecentry}%
1432 % Read toc second time, this time actually producing the outlines.
1433 % The `-' means take the \expnumber as the absolute number of
1434 % subentries, which we calculated on our first read of the .toc above.
1436 % We use the node names as the destinations.
1437 \def\numchapentry##1##2##3##4{%
1438 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1439 \def\numsecentry##1##2##3##4{%
1440 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1441 \def\numsubsecentry##1##2##3##4{%
1442 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1443 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1444 \dopdfoutline{##1}{}{##3}{##4}}%
1446 % PDF outlines are displayed using system fonts, instead of
1447 % document fonts. Therefore we cannot use special characters,
1448 % since the encoding is unknown. For example, the eogonek from
1449 % Latin 2 (0xea) gets translated to a | character. Info from
1450 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1452 % xx to do this right, we have to translate 8-bit characters to
1453 % their "best" equivalent, based on the @documentencoding. Right
1454 % now, I guess we'll just let the pdf reader have its way.
1457 \catcode`\\=\active \otherbackslash
1458 \input \tocreadfilename
1462 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1463 \ifx\PP\D\let\nextsp\relax
1464 \else\let\nextsp\skipspaces
1465 \ifx\p\space\else\addtokens{\filename}{\PP}%
1466 \advance\filenamelength by 1
1470 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1471 \ifnum\pdftexversion < 14
1472 \let \startlink \pdfannotlink
1474 \let \startlink \pdfstartlink
1476 % make a live url in pdf output.
1479 % it seems we really need yet another set of dummies; have not
1480 % tried to figure out what each command should do in the context
1481 % of @url. for now, just make @/ a no-op, that's the only one
1482 % people have actually reported a problem with.
1484 \normalturnoffactive
1487 \makevalueexpandable
1488 \leavevmode\setcolor{\urlcolor}%
1489 \startlink attr{/Border [0 0 0]}%
1490 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1492 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1493 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1494 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1495 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1497 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1499 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1500 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1501 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1503 \ifnum0=\countA\else\makelink\fi
1504 \ifx\first.\let\next=\done\else
1506 \addtokens{\toksB}{\the\toksD}
1507 \ifx\first,\addtokens{\toksB}{\space}\fi
1509 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1511 \def\makelink{\addtokens{\toksB}%
1512 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1514 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1515 \setcolor{\linkcolor}#1\endlink}
1516 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1518 \let\pdfmkdest = \gobble
1519 \let\pdfurl = \gobble
1520 \let\endlink = \relax
1521 \let\setcolor = \gobble
1522 \let\pdfsetcolor = \gobble
1523 \let\pdfmakeoutlines = \relax
1524 \fi % \ifx\pdfoutput
1529 % Change the current font style to #1, remembering it in \curfontstyle.
1530 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1531 % italics, not bold italics.
1533 \def\setfontstyle#1{%
1534 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1535 \csname ten#1\endcsname % change the current font
1538 % Select #1 fonts with the current style.
1540 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1542 \def\rm{\fam=0 \setfontstyle{rm}}
1543 \def\it{\fam=\itfam \setfontstyle{it}}
1544 \def\sl{\fam=\slfam \setfontstyle{sl}}
1545 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1546 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1548 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1549 % So we set up a \sf.
1551 \def\sf{\fam=\sffam \setfontstyle{sf}}
1552 \let\li = \sf % Sometimes we call it \li, not \sf.
1554 % We don't need math for this font style.
1555 \def\ttsl{\setfontstyle{ttsl}}
1559 \newdimen\textleading \textleading = 13.2pt
1561 % Set the baselineskip to #1, and the lineskip and strut size
1562 % correspondingly. There is no deep meaning behind these magic numbers
1563 % used as factors; they just match (closely enough) what Knuth defined.
1565 \def\lineskipfactor{.08333}
1566 \def\strutheightpercent{.70833}
1567 \def\strutdepthpercent {.29167}
1570 \normalbaselineskip = #1\relax
1571 \normallineskip = \lineskipfactor\normalbaselineskip
1573 \setbox\strutbox =\hbox{%
1574 \vrule width0pt height\strutheightpercent\baselineskip
1575 depth \strutdepthpercent \baselineskip
1580 % PDF CMaps. See also LaTeX's t1.cmap.
1585 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1586 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1587 %%DocumentNeededResources: ProcSet (CIDInit)
1588 %%IncludeResource: ProcSet (CIDInit)
1589 %%BeginResource: CMap (TeX-OT1-0)
1590 %%Title: (TeX-OT1-0 TeX OT1 0)
1593 /CIDInit /ProcSet findresource begin
1601 /CMapName /TeX-OT1-0 def
1603 1 begincodespacerange
1659 CMapName currentdict /CMap defineresource pop
1665 \expandafter\edef\csname cmapOT1\endcsname#1{%
1666 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1671 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1672 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1673 %%DocumentNeededResources: ProcSet (CIDInit)
1674 %%IncludeResource: ProcSet (CIDInit)
1675 %%BeginResource: CMap (TeX-OT1IT-0)
1676 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1679 /CIDInit /ProcSet findresource begin
1687 /CMapName /TeX-OT1IT-0 def
1689 1 begincodespacerange
1747 CMapName currentdict /CMap defineresource pop
1753 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1754 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1759 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1760 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1761 %%DocumentNeededResources: ProcSet (CIDInit)
1762 %%IncludeResource: ProcSet (CIDInit)
1763 %%BeginResource: CMap (TeX-OT1TT-0)
1764 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1767 /CIDInit /ProcSet findresource begin
1775 /CMapName /TeX-OT1TT-0 def
1777 1 begincodespacerange
1822 CMapName currentdict /CMap defineresource pop
1828 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1829 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1832 \expandafter\let\csname cmapOT1\endcsname\gobble
1833 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1834 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1838 % Set the font macro #1 to the font named #2, adding on the
1839 % specified font prefix (normally `cm').
1840 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1841 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1843 \def\setfont#1#2#3#4#5{%
1844 \font#1=\fontprefix#2#3 scaled #4
1845 \csname cmap#5\endcsname#1%
1847 % This is what gets called when #5 of \setfont is empty.
1851 % Use cm as the default font prefix.
1852 % To specify the font prefix, you must define \fontprefix
1853 % before you read in texinfo.tex.
1854 \ifx\fontprefix\undefined
1857 % Support font families that don't use the same naming scheme as CM.
1859 \def\rmbshape{bx} %where the normal face is bold
1864 \def\ttslshape{sltt}
1874 % Definitions for a main text size of 11pt. This is the default in
1877 \def\definetextfontsizexi{%
1878 % Text fonts (11.2pt, magstep1).
1879 \def\textnominalsize{11pt}
1880 \edef\mainmagstep{\magstephalf}
1881 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1882 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1883 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1884 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1885 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1886 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1887 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1888 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1889 \font\texti=cmmi10 scaled \mainmagstep
1890 \font\textsy=cmsy10 scaled \mainmagstep
1892 % A few fonts for @defun names and args.
1893 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1894 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1895 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1896 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1898 % Fonts for indices, footnotes, small examples (9pt).
1899 \def\smallnominalsize{9pt}
1900 \setfont\smallrm\rmshape{9}{1000}{OT1}
1901 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1902 \setfont\smallbf\bfshape{10}{900}{OT1}
1903 \setfont\smallit\itshape{9}{1000}{OT1IT}
1904 \setfont\smallsl\slshape{9}{1000}{OT1}
1905 \setfont\smallsf\sfshape{9}{1000}{OT1}
1906 \setfont\smallsc\scshape{10}{900}{OT1}
1907 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1911 % Fonts for small examples (8pt).
1912 \def\smallernominalsize{8pt}
1913 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1914 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1915 \setfont\smallerbf\bfshape{10}{800}{OT1}
1916 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1917 \setfont\smallersl\slshape{8}{1000}{OT1}
1918 \setfont\smallersf\sfshape{8}{1000}{OT1}
1919 \setfont\smallersc\scshape{10}{800}{OT1}
1920 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1921 \font\smalleri=cmmi8
1922 \font\smallersy=cmsy8
1924 % Fonts for title page (20.4pt):
1925 \def\titlenominalsize{20pt}
1926 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1927 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1928 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1929 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1930 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1931 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1932 \let\titlebf=\titlerm
1933 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1934 \font\titlei=cmmi12 scaled \magstep3
1935 \font\titlesy=cmsy10 scaled \magstep4
1936 \def\authorrm{\secrm}
1937 \def\authortt{\sectt}
1939 % Chapter (and unnumbered) fonts (17.28pt).
1940 \def\chapnominalsize{17pt}
1941 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1942 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1943 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1944 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1945 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1946 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1948 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1949 \font\chapi=cmmi12 scaled \magstep2
1950 \font\chapsy=cmsy10 scaled \magstep3
1952 % Section fonts (14.4pt).
1953 \def\secnominalsize{14pt}
1954 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1955 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1956 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1957 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1958 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1959 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1961 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1962 \font\seci=cmmi12 scaled \magstep1
1963 \font\secsy=cmsy10 scaled \magstep2
1965 % Subsection fonts (13.15pt).
1966 \def\ssecnominalsize{13pt}
1967 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1968 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1969 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1970 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1971 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1972 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1974 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1975 \font\sseci=cmmi12 scaled \magstephalf
1976 \font\ssecsy=cmsy10 scaled 1315
1978 % Reduced fonts for @acro in text (10pt).
1979 \def\reducednominalsize{10pt}
1980 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1981 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1982 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1983 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1984 \setfont\reducedsl\slshape{10}{1000}{OT1}
1985 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1986 \setfont\reducedsc\scshape{10}{1000}{OT1}
1987 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1988 \font\reducedi=cmmi10
1989 \font\reducedsy=cmsy10
1991 % reset the current fonts
1994 } % end of 11pt text font size definitions
1997 % Definitions to make the main text be 10pt Computer Modern, with
1998 % section, chapter, etc., sizes following suit. This is for the GNU
1999 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2000 % future. Used with @smallbook, which sets the leading to 12pt.
2002 \def\definetextfontsizex{%
2003 % Text fonts (10pt).
2004 \def\textnominalsize{10pt}
2005 \edef\mainmagstep{1000}
2006 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2007 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2008 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2009 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2010 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2011 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2012 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2013 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2014 \font\texti=cmmi10 scaled \mainmagstep
2015 \font\textsy=cmsy10 scaled \mainmagstep
2017 % A few fonts for @defun names and args.
2018 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2019 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2020 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2021 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2023 % Fonts for indices, footnotes, small examples (9pt).
2024 \def\smallnominalsize{9pt}
2025 \setfont\smallrm\rmshape{9}{1000}{OT1}
2026 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2027 \setfont\smallbf\bfshape{10}{900}{OT1}
2028 \setfont\smallit\itshape{9}{1000}{OT1IT}
2029 \setfont\smallsl\slshape{9}{1000}{OT1}
2030 \setfont\smallsf\sfshape{9}{1000}{OT1}
2031 \setfont\smallsc\scshape{10}{900}{OT1}
2032 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2036 % Fonts for small examples (8pt).
2037 \def\smallernominalsize{8pt}
2038 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2039 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2040 \setfont\smallerbf\bfshape{10}{800}{OT1}
2041 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2042 \setfont\smallersl\slshape{8}{1000}{OT1}
2043 \setfont\smallersf\sfshape{8}{1000}{OT1}
2044 \setfont\smallersc\scshape{10}{800}{OT1}
2045 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2046 \font\smalleri=cmmi8
2047 \font\smallersy=cmsy8
2049 % Fonts for title page (20.4pt):
2050 \def\titlenominalsize{20pt}
2051 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2052 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2053 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2054 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2055 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2056 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2057 \let\titlebf=\titlerm
2058 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2059 \font\titlei=cmmi12 scaled \magstep3
2060 \font\titlesy=cmsy10 scaled \magstep4
2061 \def\authorrm{\secrm}
2062 \def\authortt{\sectt}
2064 % Chapter fonts (14.4pt).
2065 \def\chapnominalsize{14pt}
2066 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2067 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2068 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2069 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2070 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2071 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2073 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2074 \font\chapi=cmmi12 scaled \magstep1
2075 \font\chapsy=cmsy10 scaled \magstep2
2077 % Section fonts (12pt).
2078 \def\secnominalsize{12pt}
2079 \setfont\secrm\rmbshape{12}{1000}{OT1}
2080 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2081 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2082 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2083 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2084 \setfont\secsf\sfbshape{12}{1000}{OT1}
2086 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2088 \font\secsy=cmsy10 scaled \magstep1
2090 % Subsection fonts (10pt).
2091 \def\ssecnominalsize{10pt}
2092 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2093 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2094 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2095 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2096 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2097 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2099 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2103 % Reduced fonts for @acro in text (9pt).
2104 \def\reducednominalsize{9pt}
2105 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2106 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2107 \setfont\reducedbf\bfshape{10}{900}{OT1}
2108 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2109 \setfont\reducedsl\slshape{9}{1000}{OT1}
2110 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2111 \setfont\reducedsc\scshape{10}{900}{OT1}
2112 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2113 \font\reducedi=cmmi9
2114 \font\reducedsy=cmsy9
2116 % reduce space between paragraphs
2117 \divide\parskip by 2
2119 % reset the current fonts
2122 } % end of 10pt text font size definitions
2125 % We provide the user-level command
2127 % (or 11) to redefine the text font size. pt is assumed.
2132 \parseargdef\fonttextsize{%
2133 \def\textsizearg{#1}%
2134 \wlog{doing @fonttextsize \textsizearg}%
2136 % Set \globaldefs so that documents can use this inside @tex, since
2137 % makeinfo 4.8 does not support it, but we need it nonetheless.
2139 \begingroup \globaldefs=1
2140 \ifx\textsizearg\xword \definetextfontsizex
2141 \else \ifx\textsizearg\xiword \definetextfontsizexi
2144 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2150 % In order for the font changes to affect most math symbols and letters,
2151 % we have to define the \textfont of the standard families. Since
2152 % texinfo doesn't allow for producing subscripts and superscripts except
2153 % in the main text, we don't bother to reset \scriptfont and
2154 % \scriptscriptfont (which would also require loading a lot more fonts).
2156 \def\resetmathfonts{%
2157 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2158 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2159 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2162 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2163 % of just \STYLE. We do this because \STYLE needs to also set the
2164 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2165 % \tenSTYLE to set the current font.
2167 % Each font-changing command also sets the names \lsize (one size lower)
2168 % and \lllsize (three sizes lower). These relative commands are used in
2169 % the LaTeX logo and acronyms.
2171 % This all needs generalizing, badly.
2174 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2175 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2176 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2177 \let\tenttsl=\textttsl
2178 \def\curfontsize{text}%
2179 \def\lsize{reduced}\def\lllsize{smaller}%
2180 \resetmathfonts \setleading{\textleading}}
2182 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2183 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2184 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2185 \let\tenttsl=\titlettsl
2186 \def\curfontsize{title}%
2187 \def\lsize{chap}\def\lllsize{subsec}%
2188 \resetmathfonts \setleading{25pt}}
2189 \def\titlefont#1{{\titlefonts\rm #1}}
2191 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2192 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2193 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2194 \let\tenttsl=\chapttsl
2195 \def\curfontsize{chap}%
2196 \def\lsize{sec}\def\lllsize{text}%
2197 \resetmathfonts \setleading{19pt}}
2199 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2200 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2201 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2202 \let\tenttsl=\secttsl
2203 \def\curfontsize{sec}%
2204 \def\lsize{subsec}\def\lllsize{reduced}%
2205 \resetmathfonts \setleading{16pt}}
2207 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2208 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2209 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2210 \let\tenttsl=\ssecttsl
2211 \def\curfontsize{ssec}%
2212 \def\lsize{text}\def\lllsize{small}%
2213 \resetmathfonts \setleading{15pt}}
2214 \let\subsubsecfonts = \subsecfonts
2216 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2217 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2218 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2219 \let\tenttsl=\reducedttsl
2220 \def\curfontsize{reduced}%
2221 \def\lsize{small}\def\lllsize{smaller}%
2222 \resetmathfonts \setleading{10.5pt}}
2224 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2225 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2226 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2227 \let\tenttsl=\smallttsl
2228 \def\curfontsize{small}%
2229 \def\lsize{smaller}\def\lllsize{smaller}%
2230 \resetmathfonts \setleading{10.5pt}}
2232 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2233 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2234 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2235 \let\tenttsl=\smallerttsl
2236 \def\curfontsize{smaller}%
2237 \def\lsize{smaller}\def\lllsize{smaller}%
2238 \resetmathfonts \setleading{9.5pt}}
2240 % Set the fonts to use with the @small... environments.
2241 \let\smallexamplefonts = \smallfonts
2243 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2244 % can fit this many characters:
2245 % 8.5x11=86 smallbook=72 a4=90 a5=69
2246 % If we use \scriptfonts (8pt), then we can fit this many characters:
2247 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2248 % For me, subjectively, the few extra characters that fit aren't worth
2249 % the additional smallness of 8pt. So I'm making the default 9pt.
2251 % By the way, for comparison, here's what fits with @example (10pt):
2252 % 8.5x11=71 smallbook=60 a4=75 a5=58
2254 % I wish the USA used A4 paper.
2258 % Set up the default fonts, so we can use them for creating boxes.
2260 \definetextfontsizexi
2262 % Define these so they can be easily changed for other fonts.
2263 \def\angleleft{$\langle$}
2264 \def\angleright{$\rangle$}
2266 % Count depth in font-changes, for error checks
2267 \newcount\fontdepth \fontdepth=0
2269 % Fonts for short table of contents.
2270 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2271 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2272 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2273 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2275 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2276 %% serif) and @ii for TeX italic
2278 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2279 % unless the following character is such as not to need one.
2280 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2281 \ptexslash\fi\fi\fi}
2282 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2283 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2285 % like \smartslanted except unconditionally uses \ttsl.
2286 % @var is set to this for defun arguments.
2287 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2289 % like \smartslanted except unconditionally use \sl. We never want
2290 % ttsl for book titles, do we?
2291 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2294 \let\slanted=\smartslanted
2295 \let\var=\smartslanted
2296 \let\dfn=\smartslanted
2297 \let\emph=\smartitalic
2299 % @b, explicit bold.
2303 % @sansserif, explicit sans.
2304 \def\sansserif#1{{\sf #1}}
2306 % We can't just use \exhyphenpenalty, because that only has effect at
2307 % the end of a paragraph. Restore normal hyphenation at the end of the
2308 % group within which \nohyphenation is presumably called.
2310 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2311 \def\restorehyphenation{\hyphenchar\font = `- }
2313 % Set sfcode to normal for the chars that usually have another value.
2314 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2315 % sometimes \x has an active definition that messes things up.
2318 \def\plainfrenchspacing{%
2319 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2320 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2321 \def\endofsentencespacefactor{1000}% for @. and friends
2323 \def\plainnonfrenchspacing{%
2324 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2325 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2326 \def\endofsentencespacefactor{3000}% for @. and friends
2329 \def\endofsentencespacefactor{3000}% default
2332 {\tt \rawbackslash \plainfrenchspacing #1}%
2335 \def\samp#1{`\tclose{#1}'\null}
2336 \setfont\keyrm\rmshape{8}{1000}{OT1}
2338 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2339 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2340 \vbox{\hrule\kern-0.4pt
2341 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2343 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2344 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2345 % The old definition, with no lozenge:
2346 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2347 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2349 % @file, @option are the same as @samp.
2353 % @code is a modification of @t,
2354 % which makes spaces the same size as normal in the surrounding text.
2357 % Change normal interword space to be same as for the current font.
2358 \spaceskip = \fontdimen2\font
2360 % Switch to typewriter.
2363 % But `\ ' produces the large typewriter interword space.
2364 \def\ {{\spaceskip = 0pt{} }}%
2366 % Turn off hyphenation.
2376 % We *must* turn on hyphenation at `-' and `_' in @code.
2377 % Otherwise, it is too hard to avoid overfull hboxes
2378 % in the Emacs manual, the Library manual, etc.
2380 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2381 % both hyphenation at - and hyphenation within words.
2382 % We must therefore turn them both off (\tclose does that)
2383 % and arrange explicitly to hyphenate at a dash.
2386 \catcode`\-=\active \catcode`\_=\active
2387 \catcode`\'=\active \catcode`\`=\active
2389 \global\def\code{\begingroup
2390 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2391 \let'\codequoteright \let`\codequoteleft
2393 \catcode\dashChar=\active \catcode\underChar=\active
2406 \def\codedash{-\discretionary{}{}{}}
2408 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2409 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2410 % will therefore expand the active definition of _, which is us
2411 % (inside @code that is), therefore an endless loop.
2413 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2414 \else\normalunderscore \fi
2415 \discretionary{}{}{}}%
2418 \def\codex #1{\tclose{#1}\endgroup}
2420 % An additional complication: the above will allow breaks after, e.g.,
2421 % each of the four underscores in __typeof__. This is undesirable in
2422 % some manuals, especially if they don't have long identifiers in
2423 % general. @allowcodebreaks provides a way to control this.
2425 \newif\ifallowcodebreaks \allowcodebreakstrue
2427 \def\keywordtrue{true}
2428 \def\keywordfalse{false}
2430 \parseargdef\allowcodebreaks{%
2432 \ifx\txiarg\keywordtrue
2433 \allowcodebreakstrue
2434 \else\ifx\txiarg\keywordfalse
2435 \allowcodebreaksfalse
2437 \errhelp = \EMsimple
2438 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2442 % @kbd is like @code, except that if the argument is just one @key command,
2443 % then @kbd has no effect.
2445 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2446 % `example' (@kbd uses ttsl only inside of @example and friends),
2447 % or `code' (@kbd uses normal tty font always).
2448 \parseargdef\kbdinputstyle{%
2450 \ifx\txiarg\worddistinct
2451 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2452 \else\ifx\txiarg\wordexample
2453 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2454 \else\ifx\txiarg\wordcode
2455 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2457 \errhelp = \EMsimple
2458 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2461 \def\worddistinct{distinct}
2462 \def\wordexample{example}
2465 % Default is `distinct.'
2466 \kbdinputstyle distinct
2469 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2470 \ifx\one\xkey\ifx\threex\three \key{#2}%
2471 \else{\tclose{\kbdfont\look}}\fi
2472 \else{\tclose{\kbdfont\look}}\fi}
2474 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2475 \let\indicateurl=\code
2479 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2480 % second argument specifying the text to display and an optional third
2481 % arg as text to display instead of (rather than in addition to) the url
2482 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2483 % a hypertex \special here.
2485 \def\uref#1{\douref #1,,,\finish}
2486 \def\douref#1,#2,#3,#4\finish{\begingroup
2489 \setbox0 = \hbox{\ignorespaces #3}%
2491 \unhbox0 % third arg given, show only that
2493 \setbox0 = \hbox{\ignorespaces #2}%
2496 \unhbox0 % PDF: 2nd arg given, show only it
2498 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2501 \code{#1}% only url given, so show it
2507 % @url synonym for @uref, since that's how everyone uses it.
2511 % rms does not like angle brackets --karl, 17may97.
2512 % So now @email is just like @uref, unless we are pdf.
2514 %\def\email#1{\angleleft{\tt #1}\angleright}
2516 \def\email#1{\doemail#1,,\finish}
2517 \def\doemail#1,#2,#3\finish{\begingroup
2520 \setbox0 = \hbox{\ignorespaces #2}%
2521 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2528 % Check if we are currently using a typewriter font. Since all the
2529 % Computer Modern typewriter fonts have zero interword stretch (and
2530 % shrink), and it is reasonable to expect all typewriter fonts to have
2531 % this property, we can check that font parameter.
2533 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2535 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2536 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2538 \def\dmn#1{\thinspace #1}
2540 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2542 % @l was never documented to mean ``switch to the Lisp font'',
2543 % and it is not used as such in any manual I can find. We need it for
2544 % Polish suppressed-l. --karl, 22sep96.
2545 %\def\l#1{{\li #1}\null}
2547 % Explicit font changes: @r, @sc, undocumented @ii.
2548 \def\r#1{{\rm #1}} % roman font
2549 \def\sc#1{{\smallcaps#1}} % smallcaps font
2550 \def\ii#1{{\it #1}} % italic font
2552 % @acronym for "FBI", "NATO", and the like.
2553 % We print this one point size smaller, since it's intended for
2556 \def\acronym#1{\doacronym #1,,\finish}
2557 \def\doacronym#1,#2,#3\finish{%
2558 {\selectfonts\lsize #1}%
2560 \ifx\temp\empty \else
2561 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2565 % @abbr for "Comput. J." and the like.
2566 % No font change, but don't do end-of-sentence spacing.
2568 \def\abbr#1{\doabbr #1,,\finish}
2569 \def\doabbr#1,#2,#3\finish{%
2570 {\plainfrenchspacing #1}%
2572 \ifx\temp\empty \else
2573 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2577 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2579 \def\pounds{{\it\$}}
2581 % @euro{} comes from a separate font, depending on the current style.
2582 % We use the free feym* fonts from the eurosym package by Henrik
2583 % Theiling, which support regular, slanted, bold and bold slanted (and
2584 % "outlined" (blackboard board, sort of) versions, which we don't need).
2585 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2587 % Although only regular is the truly official Euro symbol, we ignore
2588 % that. The Euro is designed to be slightly taller than the regular
2594 % feybo - bold slanted
2596 % There is no good (free) typewriter version, to my knowledge.
2597 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2600 % Also doesn't work in math. Do we need to do math with euro symbols?
2604 \def\euro{{\eurofont e}}
2606 % We set the font at each command, rather than predefining it in
2607 % \textfonts and the other font-switching commands, so that
2608 % installations which never need the symbol don't have to have the
2611 % There is only one designed size (nominal 10pt), so we always scale
2612 % that to the current nominal size.
2614 % By the way, simply using "at 1em" works for cmr10 and the like, but
2615 % does not work for cmbx10 and other extended/shrunken fonts.
2617 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2619 \ifx\curfontstyle\bfstylename
2621 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2624 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2629 % @registeredsymbol - R in a circle. The font for the R should really
2630 % be smaller yet, but lllsize is the best we can do for now.
2631 % Adapted from the plain.tex definition of \copyright.
2633 \def\registeredsymbol{%
2634 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2639 % @textdegree - the normal degrees sign.
2641 \def\textdegree{$^\circ$}
2643 % Laurent Siebenmann reports \Orb undefined with:
2644 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2645 % so we'll define it if necessary.
2648 \def\Orb{\mathhexbox20D}
2652 \message{page headings,}
2654 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2655 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2657 % First the title page. Must do @settitle before @titlepage.
2659 \newif\iffinishedtitlepage
2661 % Do an implicit @contents or @shortcontents after @end titlepage if the
2662 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2664 \newif\ifsetcontentsaftertitlepage
2665 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2666 \newif\ifsetshortcontentsaftertitlepage
2667 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2669 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2670 \endgroup\page\hbox{}\page}
2673 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2675 \parindent=0pt \textfonts
2676 % Leave some space at the very top of the page.
2677 \vglue\titlepagetopglue
2678 % No rule at page bottom unless we print one at the top with @title.
2679 \finishedtitlepagetrue
2681 % Most title ``pages'' are actually two pages long, with space
2682 % at the top of the second. We don't want the ragged left on the second.
2683 \let\oldpage = \page
2685 \iffinishedtitlepage\else
2688 \let\page = \oldpage
2695 \iffinishedtitlepage\else
2698 % It is important to do the page break before ending the group,
2699 % because the headline and footline are only empty inside the group.
2700 % If we use the new definition of \page, we always get a blank page
2701 % after the title page, which we certainly don't want.
2705 % Need this before the \...aftertitlepage checks so that if they are
2706 % in effect the toc pages will come out with page numbers.
2709 % If they want short, they certainly want long too.
2710 \ifsetshortcontentsaftertitlepage
2713 \global\let\shortcontents = \relax
2714 \global\let\contents = \relax
2717 \ifsetcontentsaftertitlepage
2719 \global\let\contents = \relax
2720 \global\let\shortcontents = \relax
2724 \def\finishtitlepage{%
2725 \vskip4pt \hrule height 2pt width \hsize
2726 \vskip\titlepagebottomglue
2727 \finishedtitlepagetrue
2730 %%% Macros to be used within @titlepage:
2732 \let\subtitlerm=\tenrm
2733 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2735 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2738 \parseargdef\title{%
2740 \leftline{\titlefonts\rm #1}
2741 % print a rule at the page bottom also.
2742 \finishedtitlepagefalse
2743 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2746 \parseargdef\subtitle{%
2748 {\subtitlefont \rightline{#1}}%
2751 % @author should come last, but may come many times.
2752 % It can also be used inside @quotation.
2754 \parseargdef\author{%
2755 \def\temp{\quotation}%
2757 \def\quotationauthor{#1}% printed in \Equotation.
2760 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2761 {\authorfont \leftline{#1}}%
2766 %%% Set up page headings and footings.
2768 \let\thispage=\folio
2770 \newtoks\evenheadline % headline on even pages
2771 \newtoks\oddheadline % headline on odd pages
2772 \newtoks\evenfootline % footline on even pages
2773 \newtoks\oddfootline % footline on odd pages
2775 % Now make TeX use those variables
2776 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2777 \else \the\evenheadline \fi}}
2778 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2779 \else \the\evenfootline \fi}\HEADINGShook}
2780 \let\HEADINGShook=\relax
2782 % Commands to set those variables.
2783 % For example, this is what @headings on does
2784 % @evenheading @thistitle|@thispage|@thischapter
2785 % @oddheading @thischapter|@thispage|@thistitle
2786 % @evenfooting @thisfile||
2787 % @oddfooting ||@thisfile
2790 \def\evenheading{\parsearg\evenheadingxxx}
2791 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2792 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2793 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2795 \def\oddheading{\parsearg\oddheadingxxx}
2796 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2797 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2798 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2800 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2802 \def\evenfooting{\parsearg\evenfootingxxx}
2803 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2804 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2805 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2807 \def\oddfooting{\parsearg\oddfootingxxx}
2808 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2809 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2810 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2812 % Leave some space for the footline. Hopefully ok to assume
2813 % @evenfooting will not be used by itself.
2814 \global\advance\pageheight by -12pt
2815 \global\advance\vsize by -12pt
2818 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2821 % @headings double turns headings on for double-sided printing.
2822 % @headings single turns headings on for single-sided printing.
2823 % @headings off turns them off.
2824 % @headings on same as @headings double, retained for compatibility.
2825 % @headings after turns on double-sided headings after this page.
2826 % @headings doubleafter turns on double-sided headings after this page.
2827 % @headings singleafter turns on single-sided headings after this page.
2828 % By default, they are off at the start of a document,
2829 % and turned `on' after @end titlepage.
2831 \def\headings #1 {\csname HEADINGS#1\endcsname}
2834 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2835 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2837 % When we turn headings on, set the page number to 1.
2838 % For double-sided printing, put current file name in lower left corner,
2839 % chapter name on inside top of right hand pages, document
2840 % title on inside top of left hand pages, and page numbers on outside top
2841 % edge of all pages.
2842 \def\HEADINGSdouble{%
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
2850 \let\contentsalignmacro = \chappager
2852 % For single-sided printing, chapter title goes across top left of page,
2853 % page number on top right.
2854 \def\HEADINGSsingle{%
2856 \global\evenfootline={\hfil}
2857 \global\oddfootline={\hfil}
2858 \global\evenheadline={\line{\thischapter\hfil\folio}}
2859 \global\oddheadline={\line{\thischapter\hfil\folio}}
2860 \global\let\contentsalignmacro = \chappager
2862 \def\HEADINGSon{\HEADINGSdouble}
2864 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2865 \let\HEADINGSdoubleafter=\HEADINGSafter
2866 \def\HEADINGSdoublex{%
2867 \global\evenfootline={\hfil}
2868 \global\oddfootline={\hfil}
2869 \global\evenheadline={\line{\folio\hfil\thistitle}}
2870 \global\oddheadline={\line{\thischapter\hfil\folio}}
2871 \global\let\contentsalignmacro = \chapoddpage
2874 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2875 \def\HEADINGSsinglex{%
2876 \global\evenfootline={\hfil}
2877 \global\oddfootline={\hfil}
2878 \global\evenheadline={\line{\thischapter\hfil\folio}}
2879 \global\oddheadline={\line{\thischapter\hfil\folio}}
2880 \global\let\contentsalignmacro = \chappager
2883 % Subroutines used in generating headings
2884 % This produces Day Month Year style of output.
2885 % Only define if not already defined, in case a txi-??.tex file has set
2886 % up a different format (e.g., txi-cs.tex does this).
2887 \ifx\today\undefined
2891 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2892 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2893 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2898 % @settitle line... specifies the title of the document, for headings.
2899 % It generates no output of its own.
2900 \def\thistitle{\putwordNoTitle}
2901 \def\settitle{\parsearg{\gdef\thistitle}}
2905 % Tables -- @table, @ftable, @vtable, @item(x).
2907 % default indentation of table text
2908 \newdimen\tableindent \tableindent=.8in
2909 % default indentation of @itemize and @enumerate text
2910 \newdimen\itemindent \itemindent=.3in
2911 % margin between end of table item and start of table text.
2912 \newdimen\itemmargin \itemmargin=.1in
2914 % used internally for \itemindent minus \itemmargin
2917 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2919 % They also define \itemindex
2920 % to index the item name in whatever manner is desired (perhaps none).
2922 \newif\ifitemxneedsnegativevskip
2924 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2926 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2927 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2929 \def\itemzzz #1{\begingroup %
2930 \advance\hsize by -\rightskip
2931 \advance\hsize by -\tableindent
2932 \setbox0=\hbox{\itemindicate{#1}}%
2934 \nobreak % This prevents a break before @itemx.
2936 % If the item text does not fit in the space we have, put it on a line
2937 % by itself, and do not allow a page break either before or after that
2938 % line. We do not start a paragraph here because then if the next
2939 % command is, e.g., @kindex, the whatsit would get put into the
2940 % horizontal list on a line by itself, resulting in extra blank space.
2941 \ifdim \wd0>\itemmax
2943 % Make this a paragraph so we get the \parskip glue and wrapping,
2944 % but leave it ragged-right.
2946 \advance\leftskip by-\tableindent
2947 \advance\hsize by\tableindent
2948 \advance\rightskip by0pt plus1fil
2949 \leavevmode\unhbox0\par
2952 % We're going to be starting a paragraph, but we don't want the
2953 % \parskip glue -- logically it's part of the @item we just started.
2954 \nobreak \vskip-\parskip
2956 % Stop a page break at the \parskip glue coming up. However, if
2957 % what follows is an environment such as @example, there will be no
2958 % \parskip glue; then the negative vskip we just inserted would
2959 % cause the example and the item to crash together. So we use this
2960 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2961 % \parskip glue after all. Section titles are handled this way also.
2965 \itemxneedsnegativevskipfalse
2967 % The item text fits into the space. Start a paragraph, so that the
2968 % following text (if any) will end up on the same line.
2970 % Do this with kerns and \unhbox so that if there is a footnote in
2971 % the item text, it can migrate to the main vertical list and
2972 % eventually be printed.
2973 \nobreak\kern-\tableindent
2974 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2976 \nobreak\kern\dimen0
2978 \itemxneedsnegativevskiptrue
2982 \def\item{\errmessage{@item while not in a list environment}}
2983 \def\itemx{\errmessage{@itemx while not in a list environment}}
2985 % @table, @ftable, @vtable.
2987 \let\itemindex\gobble
2991 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2992 \tablecheck{ftable}%
2995 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2996 \tablecheck{vtable}%
2999 \ifnum \the\catcode`\^^M=\active
3001 \errmessage{This command won't work in this context; perhaps the problem is
3002 that we are \inenvironment\thisenv}%
3003 \def\next{\doignore{#1}}%
3010 \def\itemindicate{#1}%
3015 \makevalueexpandable
3016 \edef\temp{\noexpand\tablez #1\space\space\space}%
3020 \def\tablez #1 #2 #3 #4\endtablez{%
3022 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3023 \ifnum 0#2>0 \tableindent=#2\mil \fi
3024 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3025 \itemmax=\tableindent
3026 \advance \itemmax by -\itemmargin
3027 \advance \leftskip by \tableindent
3028 \exdentamount=\tableindent
3030 \parskip = \smallskipamount
3031 \ifdim \parskip=0pt \parskip=2pt \fi
3032 \let\item = \internalBitem
3033 \let\itemx = \internalBitemx
3035 \def\Etable{\endgraf\afterenvbreak}
3038 \let\Eitemize\Etable
3039 \let\Eenumerate\Etable
3041 % This is the counter used by @enumerate, which is really @itemize
3045 \envdef\itemize{\parsearg\doitemize}
3049 \itemmax=\itemindent
3050 \advance\itemmax by -\itemmargin
3051 \advance\leftskip by \itemindent
3052 \exdentamount=\itemindent
3054 \parskip=\smallskipamount
3055 \ifdim\parskip=0pt \parskip=2pt \fi
3056 \def\itemcontents{#1}%
3057 % @itemize with no arg is equivalent to @itemize @bullet.
3058 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3059 \let\item=\itemizeitem
3062 % Definition of @item while inside @itemize and @enumerate.
3065 \advance\itemno by 1 % for enumerations
3066 {\let\par=\endgraf \smallbreak}% reasonable place to break
3068 % If the document has an @itemize directly after a section title, a
3069 % \nobreak will be last on the list, and \sectionheading will have
3070 % done a \vskip-\parskip. In that case, we don't want to zero
3071 % parskip, or the item text will crash with the heading. On the
3072 % other hand, when there is normal text preceding the item (as there
3073 % usually is), we do want to zero parskip, or there would be too much
3074 % space. In that case, we won't have a \nobreak before. At least
3075 % that's the theory.
3076 \ifnum\lastpenalty<10000 \parskip=0in \fi
3078 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3079 \vadjust{\penalty 1200}}% not good to break after first line of item.
3083 % \splitoff TOKENS\endmark defines \first to be the first token in
3084 % TOKENS, and \rest to be the remainder.
3086 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3088 % Allow an optional argument of an uppercase letter, lowercase letter,
3089 % or number, to specify the first label in the enumerated list. No
3090 % argument is the same as `1'.
3092 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3093 \def\enumeratey #1 #2\endenumeratey{%
3094 % If we were given no argument, pretend we were given `1'.
3096 \ifx\thearg\empty \def\thearg{1}\fi
3098 % Detect if the argument is a single token. If so, it might be a
3099 % letter. Otherwise, the only valid thing it can be is a number.
3100 % (We will always have one token, because of the test we just made.
3101 % This is a good thing, since \splitoff doesn't work given nothing at
3102 % all -- the first parameter is undelimited.)
3103 \expandafter\splitoff\thearg\endmark
3105 % Only one token in the argument. It could still be anything.
3106 % A ``lowercase letter'' is one whose \lccode is nonzero.
3107 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3108 % not equal to itself.
3109 % Otherwise, we assume it's a number.
3111 % We need the \relax at the end of the \ifnum lines to stop TeX from
3112 % continuing to look for a <number>.
3114 \ifnum\lccode\expandafter`\thearg=0\relax
3115 \numericenumerate % a number (we hope)
3118 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3119 \lowercaseenumerate % lowercase letter
3121 \uppercaseenumerate % uppercase letter
3125 % Multiple tokens in the argument. We hope it's a number.
3130 % An @enumerate whose labels are integers. The starting integer is
3133 \def\numericenumerate{%
3135 \startenumeration{\the\itemno}%
3138 % The starting (lowercase) letter is in \thearg.
3139 \def\lowercaseenumerate{%
3140 \itemno = \expandafter`\thearg
3142 % Be sure we're not beyond the end of the alphabet.
3144 \errmessage{No more lowercase letters in @enumerate; get a bigger
3151 % The starting (uppercase) letter is in \thearg.
3152 \def\uppercaseenumerate{%
3153 \itemno = \expandafter`\thearg
3155 % Be sure we're not beyond the end of the alphabet.
3157 \errmessage{No more uppercase letters in @enumerate; get a bigger
3164 % Call \doitemize, adding a period to the first argument and supplying the
3165 % common last two arguments. Also subtract one from the initial value in
3166 % \itemno, since @item increments \itemno.
3168 \def\startenumeration#1{%
3169 \advance\itemno by -1
3170 \doitemize{#1.}\flushcr
3173 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3176 \def\alphaenumerate{\enumerate{a}}
3177 \def\capsenumerate{\enumerate{A}}
3178 \def\Ealphaenumerate{\Eenumerate}
3179 \def\Ecapsenumerate{\Eenumerate}
3182 % @multitable macros
3183 % Amy Hendrickson, 8/18/94, 3/6/96
3185 % @multitable ... @end multitable will make as many columns as desired.
3186 % Contents of each column will wrap at width given in preamble. Width
3187 % can be specified either with sample text given in a template line,
3188 % or in percent of \hsize, the current width of text on page.
3190 % Table can continue over pages but will only break between lines.
3194 % Either define widths of columns in terms of percent of \hsize:
3195 % @multitable @columnfractions .25 .3 .45
3198 % Numbers following @columnfractions are the percent of the total
3199 % current hsize to be used for each column. You may use as many
3200 % columns as desired.
3203 % Or use a template:
3204 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3206 % using the widest term desired in each column.
3208 % Each new table line starts with @item, each subsequent new column
3209 % starts with @tab. Empty columns may be produced by supplying @tab's
3210 % with nothing between them for as many times as empty columns are needed,
3211 % ie, @tab@tab@tab will produce two empty columns.
3213 % @item, @tab do not need to be on their own lines, but it will not hurt
3216 % Sample multitable:
3218 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3219 % @item first col stuff @tab second col stuff @tab third col
3226 % @item first col stuff @tab second col stuff
3227 % @tab Many paragraphs of text may be used in any column.
3229 % They will wrap at the width determined by the template.
3230 % @item@tab@tab This will be in third column.
3233 % Default dimensions may be reset by user.
3234 % @multitableparskip is vertical space between paragraphs in table.
3235 % @multitableparindent is paragraph indent in table.
3236 % @multitablecolmargin is horizontal space to be left between columns.
3237 % @multitablelinespace is space to leave between table items, baseline
3239 % 0pt means it depends on current normal line spacing.
3241 \newskip\multitableparskip
3242 \newskip\multitableparindent
3243 \newdimen\multitablecolspace
3244 \newskip\multitablelinespace
3245 \multitableparskip=0pt
3246 \multitableparindent=6pt
3247 \multitablecolspace=12pt
3248 \multitablelinespace=0pt
3250 % Macros used to set up halign preamble:
3252 \let\endsetuptable\relax
3253 \def\xendsetuptable{\endsetuptable}
3254 \let\columnfractions\relax
3255 \def\xcolumnfractions{\columnfractions}
3258 % #1 is the @columnfraction, usually a decimal number like .5, but might
3259 % be just 1. We just use it, whatever it is.
3261 \def\pickupwholefraction#1 {%
3262 \global\advance\colcount by 1
3263 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3270 \ifx\firstarg\xendsetuptable
3273 \ifx\firstarg\xcolumnfractions
3274 \global\setpercenttrue
3277 \let\go\pickupwholefraction
3279 \global\advance\colcount by 1
3280 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3281 % separator; typically that is always in the input, anyway.
3282 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3285 \ifx\go\pickupwholefraction
3286 % Put the argument back for the \pickupwholefraction call, so
3287 % we'll always have a period there to be parsed.
3288 \def\go{\pickupwholefraction#1}%
3290 \let\go = \setuptable
3296 % multitable-only commands.
3298 % @headitem starts a heading row, which we typeset in bold.
3299 % Assignments have to be global since we are inside the implicit group
3300 % of an alignment entry. Note that \everycr resets \everytab.
3301 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3303 % A \tab used to include \hskip1sp. But then the space in a template
3304 % line is not enough. That is bad. So let's go back to just `&' until
3305 % we encounter the problem it was intended to solve again.
3306 % --karl, nathan@acm.org, 20apr99.
3307 \def\tab{\checkenv\multitable &\the\everytab}%
3309 % @multitable ... @end multitable definitions:
3311 \newtoks\everytab % insert after every tab.
3313 \envdef\multitable{%
3317 % @item within a multitable starts a normal row.
3318 % We use \def instead of \let so that if one of the multitable entries
3319 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3320 % \endtemplate) expanding \doitemize.
3325 \setmultitablespacing
3326 \parskip=\multitableparskip
3327 \parindent=\multitableparindent
3333 \global\everytab={}%
3334 \global\colcount=0 % Reset the column counter.
3335 % Check for saved footnotes, etc.
3337 % Keeps underfull box messages off when table breaks over pages.
3339 % Maybe so, but it also creates really weird page breaks when the
3340 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3341 % problem manifests itself, so it can be fixed for real --karl.
3345 \parsearg\domultitable
3347 \def\domultitable#1{%
3348 % To parse everything between @multitable and @item:
3349 \setuptable#1 \endsetuptable
3351 % This preamble sets up a generic column definition, which will
3352 % be used as many times as user calls for columns.
3353 % \vtop will set a single line and will also let text wrap and
3354 % continue for many paragraphs if desired.
3356 \global\advance\colcount by 1
3359 % Use the current \colcount to find the correct column width:
3360 \hsize=\expandafter\csname col\the\colcount\endcsname
3362 % In order to keep entries from bumping into each other
3363 % we will add a \leftskip of \multitablecolspace to all columns after
3366 % If a template has been used, we will add \multitablecolspace
3367 % to the width of each template entry.
3369 % If the user has set preamble in terms of percent of \hsize we will
3370 % use that dimension as the width of the column, and the \leftskip
3371 % will keep entries from bumping into each other. Table will start at
3372 % left margin and final column will justify at right margin.
3374 % Make sure we don't inherit \rightskip from the outer environment.
3377 % The first column will be indented with the surrounding text.
3378 \advance\hsize by\leftskip
3381 % If user has not set preamble in terms of percent of \hsize
3382 % we will advance \hsize by \multitablecolspace.
3383 \advance\hsize by \multitablecolspace
3385 % In either case we will make \leftskip=\multitablecolspace:
3386 \leftskip=\multitablecolspace
3388 % Ignoring space at the beginning and end avoids an occasional spurious
3389 % blank line, when TeX decides to break the line at the space before the
3390 % box from the multistrut, so the strut ends up on a line by itself.
3392 % @multitable @columnfractions .11 .89
3394 % @tab Legal holiday which is valid in major parts of the whole country.
3395 % Is automatically provided with highlighting sequences respectively
3396 % marking characters.
3397 \noindent\ignorespaces##\unskip\multistrut
3402 \egroup % end the \halign
3403 \global\setpercentfalse
3406 \def\setmultitablespacing{%
3407 \def\multistrut{\strut}% just use the standard line spacing
3409 % Compute \multitablelinespace (if not defined by user) for use in
3410 % \multitableparskip calculation. We used define \multistrut based on
3411 % this, but (ironically) that caused the spacing to be off.
3412 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3413 \ifdim\multitablelinespace=0pt
3414 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3415 \global\advance\multitablelinespace by-\ht0
3417 %% Test to see if parskip is larger than space between lines of
3418 %% table. If not, do nothing.
3419 %% If so, set to same dimension as multitablelinespace.
3420 \ifdim\multitableparskip>\multitablelinespace
3421 \global\multitableparskip=\multitablelinespace
3422 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3423 %% than skip between lines in the table.
3425 \ifdim\multitableparskip=0pt
3426 \global\multitableparskip=\multitablelinespace
3427 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3428 %% than skip between lines in the table.
3432 \message{conditionals,}
3434 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3435 % @ifnotxml always succeed. They currently do nothing; we don't
3436 % attempt to check whether the conditionals are properly nested. But we
3437 % have to remember that they are conditionals, so that @end doesn't
3438 % attempt to close an environment group.
3441 \expandafter\let\csname #1\endcsname = \relax
3442 \expandafter\let\csname iscond.#1\endcsname = 1
3445 \makecond{ifnotdocbook}
3446 \makecond{ifnothtml}
3447 \makecond{ifnotinfo}
3448 \makecond{ifnotplaintext}
3451 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3453 \def\direntry{\doignore{direntry}}
3454 \def\documentdescription{\doignore{documentdescription}}
3455 \def\docbook{\doignore{docbook}}
3456 \def\html{\doignore{html}}
3457 \def\ifdocbook{\doignore{ifdocbook}}
3458 \def\ifhtml{\doignore{ifhtml}}
3459 \def\ifinfo{\doignore{ifinfo}}
3460 \def\ifnottex{\doignore{ifnottex}}
3461 \def\ifplaintext{\doignore{ifplaintext}}
3462 \def\ifxml{\doignore{ifxml}}
3463 \def\ignore{\doignore{ignore}}
3464 \def\menu{\doignore{menu}}
3465 \def\xml{\doignore{xml}}
3467 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3469 % A count to remember the depth of nesting.
3470 \newcount\doignorecount
3472 \def\doignore#1{\begingroup
3473 % Scan in ``verbatim'' mode:
3475 \catcode`\@ = \other
3476 \catcode`\{ = \other
3477 \catcode`\} = \other
3479 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3482 % Count number of #1's that we've seen.
3485 % Swallow text until we reach the matching `@end #1'.
3489 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3492 \gdef\dodoignore#1{%
3493 % #1 contains the command name as a string, e.g., `ifinfo'.
3495 % Define a command to find the next `@end #1'.
3496 \long\def\doignoretext##1^^M@end #1{%
3497 \doignoretextyyy##1^^M@#1\_STOP_}%
3499 % And this command to find another #1 command, at the beginning of a
3500 % line. (Otherwise, we would consider a line `@c @ifset', for
3501 % example, to count as an @ifset for nesting.)
3502 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3504 % And now expand that command.
3509 \def\doignoreyyy#1{%
3511 \ifx\temp\empty % Nothing found.
3512 \let\next\doignoretextzzz
3513 \else % Found a nested condition, ...
3514 \advance\doignorecount by 1
3515 \let\next\doignoretextyyy % ..., look for another.
3516 % If we're here, #1 ends with ^^M\ifinfo (for example).
3518 \next #1% the token \_STOP_ is present just after this macro.
3521 % We have to swallow the remaining "\_STOP_".
3523 \def\doignoretextzzz#1{%
3524 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3525 \let\next\enddoignore
3526 \else % Still inside a nested condition.
3527 \advance\doignorecount by -1
3528 \let\next\doignoretext % Look for the next @end.
3533 % Finish off ignored text.
3535 % Ignore anything after the last `@end #1'; this matters in verbatim
3536 % environments, where otherwise the newline after an ignored conditional
3537 % would result in a blank line in the output.
3538 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3542 % @set VAR sets the variable VAR to an empty value.
3543 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3545 % Since we want to separate VAR from REST-OF-LINE (which might be
3546 % empty), we can't just use \parsearg; we have to insert a space of our
3547 % own to delimit the rest of the line, and then take it out again if we
3549 % We rely on the fact that \parsearg sets \catcode`\ =10.
3551 \parseargdef\set{\setyyy#1 \endsetyyy}
3552 \def\setyyy#1 #2\endsetyyy{%
3554 \makevalueexpandable
3556 \edef\next{\gdef\makecsname{SET#1}}%
3564 % Remove the trailing space \setxxx inserted.
3565 \def\setzzz#1 \endsetzzz{\next{#1}}
3567 % @clear VAR clears (i.e., unsets) the variable VAR.
3569 \parseargdef\clear{%
3571 \makevalueexpandable
3572 \global\expandafter\let\csname SET#1\endcsname=\relax
3576 % @value{foo} gets the text saved in variable foo.
3577 \def\value{\begingroup\makevalueexpandable\valuexxx}
3578 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3580 \catcode`\- = \active \catcode`\_ = \active
3582 \gdef\makevalueexpandable{%
3583 \let\value = \expandablevalue
3584 % We don't want these characters active, ...
3585 \catcode`\-=\other \catcode`\_=\other
3586 % ..., but we might end up with active ones in the argument if
3587 % we're called from @code, as @code{@value{foo-bar_}}, though.
3588 % So \let them to their normal equivalents.
3589 \let-\realdash \let_\normalunderscore
3593 % We have this subroutine so that we can handle at least some @value's
3594 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3595 % The command has to be fully expandable (if the variable is set), since
3596 % the result winds up in the index file. This means that if the
3597 % variable's value contains other Texinfo commands, it's almost certain
3598 % it will fail (although perhaps we could fix that with sufficient work
3599 % to do a one-level expansion on the result, instead of complete).
3601 \def\expandablevalue#1{%
3602 \expandafter\ifx\csname SET#1\endcsname\relax
3603 {[No value for ``#1'']}%
3604 \message{Variable `#1', used in @value, is not set.}%
3606 \csname SET#1\endcsname
3610 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3613 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3616 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3619 \makevalueexpandable
3621 \expandafter\ifx\csname SET#2\endcsname\relax
3622 #1% If not set, redefine \next.
3627 \def\ifsetfail{\doignore{ifset}}
3629 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3630 % defined with @set, or has been undefined with @clear.
3632 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3633 % above code: if the variable is not set, do nothing, if it is set,
3634 % then redefine \next to \ifclearfail.
3637 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3638 \def\ifclearfail{\doignore{ifclear}}
3640 % @dircategory CATEGORY -- specify a category of the dir file
3641 % which this file should belong to. Ignore this in TeX.
3642 \let\dircategory=\comment
3644 % @defininfoenclose.
3645 \let\definfoenclose=\comment
3649 % Index generation facilities
3651 % Define \newwrite to be identical to plain tex's \newwrite
3652 % except not \outer, so it can be used within macros and \if's.
3653 \edef\newwrite{\makecsname{ptexnewwrite}}
3655 % \newindex {foo} defines an index named foo.
3656 % It automatically defines \fooindex such that
3657 % \fooindex ...rest of line... puts an entry in the index foo.
3658 % It also defines \fooindfile to be the number of the output channel for
3659 % the file that accumulates this index. The file's extension is foo.
3660 % The name of an index should be no more than 2 characters long
3661 % for the sake of vms.
3665 \expandafter\newwrite \csname#1indfile\endcsname
3666 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3668 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3669 \noexpand\doindex{#1}}
3672 % @defindex foo == \newindex{foo}
3674 \def\defindex{\parsearg\newindex}
3676 % Define @defcodeindex, like @defindex except put all entries in @code.
3678 \def\defcodeindex{\parsearg\newcodeindex}
3680 \def\newcodeindex#1{%
3682 \expandafter\newwrite \csname#1indfile\endcsname
3683 \openout \csname#1indfile\endcsname \jobname.#1
3685 \expandafter\xdef\csname#1index\endcsname{%
3686 \noexpand\docodeindex{#1}}%
3690 % @synindex foo bar makes index foo feed into index bar.
3691 % Do this instead of @defindex foo if you don't want it as a separate index.
3693 % @syncodeindex foo bar similar, but put all entries made for index foo
3696 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3697 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3699 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3700 % #3 the target index (bar).
3701 \def\dosynindex#1#2#3{%
3702 % Only do \closeout if we haven't already done it, else we'll end up
3703 % closing the target index.
3704 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3705 % The \closeout helps reduce unnecessary open files; the limit on the
3706 % Acorn RISC OS is a mere 16 files.
3707 \expandafter\closeout\csname#2indfile\endcsname
3708 \expandafter\let\csname\donesynindex#2\endcsname = 1
3710 % redefine \fooindfile:
3711 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3712 \expandafter\let\csname#2indfile\endcsname=\temp
3713 % redefine \fooindex:
3714 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3717 % Define \doindex, the driver for all \fooindex macros.
3718 % Argument #1 is generated by the calling \fooindex macro,
3719 % and it is "foo", the name of the index.
3721 % \doindex just uses \parsearg; it calls \doind for the actual work.
3722 % This is because \doind is more useful to call from other macros.
3724 % There is also \dosubind {index}{topic}{subtopic}
3725 % which makes an entry in a two-level index such as the operation index.
3727 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3728 \def\singleindexer #1{\doind{\indexname}{#1}}
3730 % like the previous two, but they put @code around the argument.
3731 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3732 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3734 % Take care of Texinfo commands that can appear in an index entry.
3735 % Since there are some commands we want to expand, and others we don't,
3736 % we have to laboriously prevent expansion for those that we don't.
3739 \escapechar = `\\ % use backslash in output files.
3740 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3741 \def\ {\realbackslash\space }%
3743 % Need these in case \tex is in effect and \{ is a \delimiter again.
3744 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3745 % braces and backslashes are used only as delimiters.
3749 % I don't entirely understand this, but when an index entry is
3750 % generated from a macro call, the \endinput which \scanmacro inserts
3751 % causes processing to be prematurely terminated. This is,
3752 % apparently, because \indexsorttmp is fully expanded, and \endinput
3753 % is an expandable command. The redefinition below makes \endinput
3754 % disappear altogether for that purpose -- although logging shows that
3755 % processing continues to some further point. On the other hand, it
3756 % seems \endinput does not hurt in the printed index arg, since that
3757 % is still getting written without apparent harm.
3759 % Sample source (mac-idx3.tex, reported by Graham Percival to
3760 % help-texinfo, 22may06):
3761 % @macro funindex {WORD}
3765 % @funindex commtest
3767 % The above is not enough to reproduce the bug, but it gives the flavor.
3769 % Sample whatsit resulting:
3770 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3773 \let\endinput = \empty
3775 % Do the redefinitions.
3779 % For the aux and toc files, @ is the escape character. So we want to
3780 % redefine everything using @ as the escape character (instead of
3781 % \realbackslash, still used for index files). When everything uses @,
3782 % this will be simpler.
3787 \let\{ = \lbraceatcmd
3788 \let\} = \rbraceatcmd
3790 % Do the redefinitions.
3795 % Called from \indexdummies and \atdummies.
3797 \def\commondummies{%
3799 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3800 % preventing its expansion. This is used only for control% words,
3801 % not control letters, because the \space would be incorrect for
3802 % control characters, but is needed to separate the control word
3803 % from whatever follows.
3805 % For control letters, we have \definedummyletter, which omits the
3808 % These can be used both for control words that take an argument and
3809 % those that do not. If it is followed by {arg} in the input, then
3810 % that will dutifully get written to the index (or wherever).
3812 \def\definedummyword ##1{\def##1{\string##1\space}}%
3813 \def\definedummyletter##1{\def##1{\string##1}}%
3814 \let\definedummyaccent\definedummyletter
3816 \commondummiesnofonts
3818 \definedummyletter\_%
3820 % Non-English letters.
3832 \definedummyword\exclamdown
3833 \definedummyword\questiondown
3834 \definedummyword\ordf
3835 \definedummyword\ordm
3837 % Although these internal commands shouldn't show up, sometimes they do.
3839 \definedummyword\gtr
3840 \definedummyword\hat
3841 \definedummyword\less
3844 \definedummyword\tclose
3847 \definedummyword\LaTeX
3848 \definedummyword\TeX
3850 % Assorted special characters.
3851 \definedummyword\bullet
3852 \definedummyword\comma
3853 \definedummyword\copyright
3854 \definedummyword\registeredsymbol
3855 \definedummyword\dots
3856 \definedummyword\enddots
3857 \definedummyword\equiv
3858 \definedummyword\error
3859 \definedummyword\euro
3860 \definedummyword\expansion
3861 \definedummyword\minus
3862 \definedummyword\pounds
3863 \definedummyword\point
3864 \definedummyword\print
3865 \definedummyword\result
3866 \definedummyword\textdegree
3868 % We want to disable all macros so that they are not expanded by \write.
3871 \normalturnoffactive
3873 % Handle some cases of @value -- where it does not contain any
3874 % (non-fully-expandable) commands.
3875 \makevalueexpandable
3878 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3880 \def\commondummiesnofonts{%
3881 % Control letters and accents.
3882 \definedummyletter\!%
3883 \definedummyaccent\"%
3884 \definedummyaccent\'%
3885 \definedummyletter\*%
3886 \definedummyaccent\,%
3887 \definedummyletter\.%
3888 \definedummyletter\/%
3889 \definedummyletter\:%
3890 \definedummyaccent\=%
3891 \definedummyletter\?%
3892 \definedummyaccent\^%
3893 \definedummyaccent\`%
3894 \definedummyaccent\~%
3898 \definedummyword\dotaccent
3899 \definedummyword\ringaccent
3900 \definedummyword\tieaccent
3901 \definedummyword\ubaraccent
3902 \definedummyword\udotaccent
3903 \definedummyword\dotless
3905 % Texinfo font commands.
3912 % Commands that take arguments.
3913 \definedummyword\acronym
3914 \definedummyword\cite
3915 \definedummyword\code
3916 \definedummyword\command
3917 \definedummyword\dfn
3918 \definedummyword\emph
3919 \definedummyword\env
3920 \definedummyword\file
3921 \definedummyword\kbd
3922 \definedummyword\key
3923 \definedummyword\math
3924 \definedummyword\option
3925 \definedummyword\pxref
3926 \definedummyword\ref
3927 \definedummyword\samp
3928 \definedummyword\strong
3929 \definedummyword\tie
3930 \definedummyword\uref
3931 \definedummyword\url
3932 \definedummyword\var
3933 \definedummyword\verb
3935 \definedummyword\xref
3938 % \indexnofonts is used when outputting the strings to sort the index
3939 % by, and when constructing control sequence names. It eliminates all
3940 % control sequences and just writes whatever the best ASCII sort string
3941 % would be for a given command (usually its argument).
3944 % Accent commands should become @asis.
3945 \def\definedummyaccent##1{\let##1\asis}%
3946 % We can just ignore other control letters.
3947 \def\definedummyletter##1{\let##1\empty}%
3948 % Hopefully, all control words can become @asis.
3949 \let\definedummyword\definedummyaccent
3951 \commondummiesnofonts
3953 % Don't no-op \tt, since it isn't a user-level command
3954 % and is used in the definitions of the active chars like <, >, |, etc.
3955 % Likewise with the other plain tex font commands.
3960 % how to handle braces?
3961 \def\_{\normalunderscore}%
3963 % Non-English letters.
3976 \def\questiondown{?}%
3983 % Assorted special characters.
3984 % (The following {} will end up in the sort string, but that's ok.)
3985 \def\bullet{bullet}%
3987 \def\copyright{copyright}%
3988 \def\registeredsymbol{R}%
3994 \def\expansion{==>}%
3996 \def\pounds{pounds}%
4000 \def\textdegree{degrees}%
4002 % We need to get rid of all macros, leaving only the arguments (if present).
4003 % Of course this is not nearly correct, but it is the best we can do for now.
4004 % makeinfo does not expand macros in the argument to @deffn, which ends up
4005 % writing an index entry, and texindex isn't prepared for an index sort entry
4006 % that starts with \.
4008 % Since macro invocations are followed by braces, we can just redefine them
4009 % to take a single TeX argument. The case of a macro invocation that
4010 % goes to end-of-line is not handled.
4015 \let\indexbackslash=0 %overridden during \printindex.
4016 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4018 % Most index entries go through here, but \dosubind is the general case.
4019 % #1 is the index name, #2 is the entry text.
4020 \def\doind#1#2{\dosubind{#1}{#2}{}}
4022 % Workhorse for all \fooindexes.
4023 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4024 % empty if called from \doind, as we usually are (the main exception
4025 % is with most defuns, which call us directly).
4027 \def\dosubind#1#2#3{%
4030 % Store the main index entry text (including the third arg).
4032 % If third arg is present, precede it with a space.
4034 \ifx\thirdarg\empty \else
4035 \toks0 = \expandafter{\the\toks0 \space #3}%
4038 \edef\writeto{\csname#1indfile\endcsname}%
4040 \safewhatsit\dosubindwrite
4045 % Write the entry in \toks0 to the index file:
4047 \def\dosubindwrite{%
4048 % Put the index entry in the margin if desired.
4049 \ifx\SETmarginindex\relax\else
4050 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4053 % Remember, we are within a group.
4054 \indexdummies % Must do this here, since \bf, etc expand at this stage
4055 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4056 % so it will be output as is; and it will print as backslash.
4058 % Process the index entry with all font commands turned off, to
4059 % get the string to sort by.
4061 \edef\temp{\the\toks0}% need full expansion
4062 \xdef\indexsorttmp{\temp}%
4065 % Set up the complete index entry, with both the sort key and
4066 % the original text, including any font commands. We write
4067 % three arguments to \entry to the .?? file (four in the
4068 % subentry case), texindex reduces to two when writing the .??s
4072 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4077 % Take care of unwanted page breaks/skips around a whatsit:
4079 % If a skip is the last thing on the list now, preserve it
4080 % by backing up by \lastskip, doing the \write, then inserting
4081 % the skip again. Otherwise, the whatsit generated by the
4082 % \write or \pdfdest will make \lastskip zero. The result is that
4083 % sequences like this:
4087 % will have extra space inserted, because the \medbreak in the
4088 % start of the @defun won't see the skip inserted by the @end of
4089 % the previous defun.
4091 % But don't do any of this if we're not in vertical mode. We
4092 % don't want to do a \vskip and prematurely end a paragraph.
4094 % Avoid page breaks due to these extra skips, too.
4096 % But wait, there is a catch there:
4097 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4098 % sufficient for this purpose, as it ignores stretch and shrink parts
4099 % of the skip. The only way seems to be to check the textual
4100 % representation of the skip.
4102 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4103 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4105 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4107 \newskip\whatsitskip
4108 \newcount\whatsitpenalty
4112 \def\safewhatsit#1{%
4116 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4117 \whatsitskip = \lastskip
4118 \edef\lastskipmacro{\the\lastskip}%
4119 \whatsitpenalty = \lastpenalty
4121 % If \lastskip is nonzero, that means the last item was a
4122 % skip. And since a skip is discardable, that means this
4123 % -\whatsitskip glue we're inserting is preceded by a
4124 % non-discardable item, therefore it is not a potential
4125 % breakpoint, therefore no \nobreak needed.
4126 \ifx\lastskipmacro\zeroskipmacro
4133 \ifx\lastskipmacro\zeroskipmacro
4134 % If \lastskip was zero, perhaps the last item was a penalty, and
4135 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4136 % to re-insert the same penalty (values >10000 are used for various
4137 % signals); since we just inserted a non-discardable item, any
4138 % following glue (such as a \parskip) would be a breakpoint. For example:
4140 % @deffn deffn-whatever
4141 % @vindex index-whatever
4143 % would allow a break between the index-whatever whatsit
4144 % and the "Description." paragraph.
4145 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4147 % On the other hand, if we had a nonzero \lastskip,
4148 % this make-up glue would be preceded by a non-discardable item
4149 % (the whatsit from the \write), so we must insert a \nobreak.
4150 \nobreak\vskip\whatsitskip
4155 % The index entry written in the file actually looks like
4156 % \entry {sortstring}{page}{topic}
4158 % \entry {sortstring}{page}{topic}{subtopic}
4159 % The texindex program reads in these files and writes files
4160 % containing these kinds of lines:
4162 % before the first topic whose initial is c
4163 % \entry {topic}{pagelist}
4164 % for a topic that is used without subtopics
4166 % for the beginning of a topic that is used with subtopics
4167 % \secondary {subtopic}{pagelist}
4168 % for each subtopic.
4170 % Define the user-accessible indexing commands
4171 % @findex, @vindex, @kindex, @cindex.
4173 \def\findex {\fnindex}
4174 \def\kindex {\kyindex}
4175 \def\cindex {\cpindex}
4176 \def\vindex {\vrindex}
4177 \def\tindex {\tpindex}
4178 \def\pindex {\pgindex}
4180 \def\cindexsub {\begingroup\obeylines\cindexsub}
4182 \gdef\cindexsub "#1" #2^^M{\endgroup %
4183 \dosubind{cp}{#2}{#1}}}
4185 % Define the macros used in formatting output of the sorted index material.
4187 % @printindex causes a particular index (the ??s file) to get printed.
4188 % It does not print any chapter heading (usually an @unnumbered).
4190 \parseargdef\printindex{\begingroup
4191 \dobreak \chapheadingskip{10000}%
4196 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4198 % See if the index file exists and is nonempty.
4199 % Change catcode of @ here so that if the index file contains
4201 % as its first line, TeX doesn't complain about mismatched braces
4202 % (because it thinks @} is a control sequence).
4204 \openin 1 \jobname.#1s
4206 % \enddoublecolumns gets confused if there is no text in the index,
4207 % and it loses the chapter title and the aux file entries for the
4208 % index. The easiest way to prevent this problem is to make sure
4209 % there is some text.
4210 \putwordIndexNonexistent
4213 % If the index file exists but is empty, then \openin leaves \ifeof
4214 % false. We have to make TeX try to read something from the file, so
4215 % it can discover if there is anything in it.
4218 \putwordIndexIsEmpty
4220 % Index files are almost Texinfo source, but we use \ as the escape
4221 % character. It would be better to use @, but that's too big a change
4222 % to make right now.
4223 \def\indexbackslash{\backslashcurfont}%
4234 % These macros are used by the sorted index file itself.
4235 % Change them to control the appearance of the index.
4238 % Some minor font changes for the special characters.
4239 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4241 % Remove any glue we may have, we'll be inserting our own.
4244 % We like breaks before the index initials, so insert a bonus.
4246 \vskip 0pt plus 3\baselineskip
4248 \vskip 0pt plus -3\baselineskip
4250 % Typeset the initial. Making this add up to a whole number of
4251 % baselineskips increases the chance of the dots lining up from column
4252 % to column. It still won't often be perfect, because of the stretch
4253 % we need before each entry, but it's better.
4255 % No shrink because it confuses \balancecolumns.
4256 \vskip 1.67\baselineskip plus .5\baselineskip
4257 \leftline{\secbf #1}%
4258 % Do our best not to break after the initial.
4260 \vskip .33\baselineskip plus .1\baselineskip
4263 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4264 % then page number (#2) flushed to the right margin. It is used for index
4265 % and table of contents entries. The paragraph is indented by \leftskip.
4267 % A straightforward implementation would start like this:
4268 % \def\entry#1#2{...
4269 % But this frozes the catcodes in the argument, and can cause problems to
4270 % @code, which sets - active. This problem was fixed by a kludge---
4271 % ``-'' was active throughout whole index, but this isn't really right.
4273 % The right solution is to prevent \entry from swallowing the whole text.
4278 % Start a new paragraph if necessary, so our assignments below can't
4279 % affect previous text.
4282 % Do not fill out the last line with white space.
4285 % No extra space above this paragraph.
4288 % Do not prefer a separate line ending with a hyphen to fewer lines.
4289 \finalhyphendemerits = 0
4291 % \hangindent is only relevant when the entry text and page number
4292 % don't both fit on one line. In that case, bob suggests starting the
4293 % dots pretty far over on the line. Unfortunately, a large
4294 % indentation looks wrong when the entry text itself is broken across
4295 % lines. So we use a small indentation and put up with long leaders.
4297 % \hangafter is reset to 1 (which is the value we want) at the start
4298 % of each paragraph, so we need not do anything with that.
4301 % When the entry text needs to be broken, just fill out the first line
4303 \rightskip = 0pt plus1fil
4305 % A bit of stretch before each entry for the benefit of balancing
4309 % Swallow the left brace of the text (first parameter):
4310 \afterassignment\doentry
4314 \bgroup % Instead of the swallowed brace.
4316 \aftergroup\finishentry
4317 % And now comes the text of the entry.
4319 \def\finishentry#1{%
4320 % #1 is the page number.
4322 % The following is kludged to not output a line of dots in the index if
4323 % there are no page numbers. The next person who breaks this will be
4324 % cursed by a Unix daemon.
4325 \setbox\boxA = \hbox{#1}%
4326 \ifdim\wd\boxA = 0pt
4330 % If we must, put the page number on a line of its own, and fill out
4331 % this line with blank space. (The \hfil is overwhelmed with the
4332 % fill leaders glue in \indexdotfill if the page number does fit.)
4334 \null\nobreak\indexdotfill % Have leaders before the page number.
4336 % The `\ ' here is removed by the implicit \unskip that TeX does as
4337 % part of (the primitive) \par. Without it, a spurious underfull
4350 % Like plain.tex's \dotfill, except uses up at least 1 em.
4351 \def\indexdotfill{\cleaders
4352 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4354 \def\primary #1{\line{#1\hfil}}
4356 \newskip\secondaryindent \secondaryindent=0.5cm
4357 \def\secondary#1#2{{%
4362 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4364 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4371 % Define two-column mode, which we use to typeset indexes.
4372 % Adapted from the TeXbook, page 416, which is to say,
4373 % the manmac.tex format used to print the TeXbook itself.
4377 \newdimen\doublecolumnhsize
4379 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4380 % Grab any single-column material above us.
4383 % Here is a possibility not foreseen in manmac: if we accumulate a
4384 % whole lot of material, we might end up calling this \output
4385 % routine twice in a row (see the doublecol-lose test, which is
4386 % essentially a couple of indexes with @setchapternewpage off). In
4387 % that case we just ship out what is in \partialpage with the normal
4388 % output routine. Generally, \partialpage will be empty when this
4389 % runs and this will be a no-op. See the indexspread.tex test case.
4390 \ifvoid\partialpage \else
4391 \onepageout{\pagecontents\partialpage}%
4394 \global\setbox\partialpage = \vbox{%
4395 % Unvbox the main output page.
4397 \kern-\topskip \kern\baselineskip
4400 \eject % run that output routine to set \partialpage
4402 % Use the double-column output routine for subsequent pages.
4403 \output = {\doublecolumnout}%
4405 % Change the page size parameters. We could do this once outside this
4406 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4407 % format, but then we repeat the same computation. Repeating a couple
4408 % of assignments once per index is clearly meaningless for the
4409 % execution time, so we may as well do it in one place.
4411 % First we halve the line length, less a little for the gutter between
4412 % the columns. We compute the gutter based on the line length, so it
4413 % changes automatically with the paper format. The magic constant
4414 % below is chosen so that the gutter has the same value (well, +-<1pt)
4415 % as it did when we hard-coded it.
4417 % We put the result in a separate register, \doublecolumhsize, so we
4418 % can restore it in \pagesofar, after \hsize itself has (potentially)
4421 \doublecolumnhsize = \hsize
4422 \advance\doublecolumnhsize by -.04154\hsize
4423 \divide\doublecolumnhsize by 2
4424 \hsize = \doublecolumnhsize
4426 % Double the \vsize as well. (We don't need a separate register here,
4427 % since nobody clobbers \vsize.)
4431 % The double-column output routine for all double-column pages except
4434 \def\doublecolumnout{%
4435 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4436 % Get the available space for the double columns -- the normal
4437 % (undoubled) page height minus any material left over from the
4441 \advance\dimen@ by -\ht\partialpage
4443 % box0 will be the left-hand column, box2 the right.
4444 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4445 \onepageout\pagesofar
4447 \penalty\outputpenalty
4450 % Re-output the contents of the output page -- any previous material,
4451 % followed by the two boxes we just split, in box0 and box2.
4455 \hsize = \doublecolumnhsize
4456 \wd0=\hsize \wd2=\hsize
4457 \hbox to\pagewidth{\box0\hfil\box2}%
4460 % All done with double columns.
4461 \def\enddoublecolumns{%
4462 % The following penalty ensures that the page builder is exercised
4463 % _before_ we change the output routine. This is necessary in the
4464 % following situation:
4466 % The last section of the index consists only of a single entry.
4467 % Before this section, \pagetotal is less than \pagegoal, so no
4468 % break occurs before the last section starts. However, the last
4469 % section, consisting of \initial and the single \entry, does not
4470 % fit on the page and has to be broken off. Without the following
4471 % penalty the page builder will not be exercised until \eject
4472 % below, and by that time we'll already have changed the output
4473 % routine to the \balancecolumns version, so the next-to-last
4474 % double-column page will be processed with \balancecolumns, which
4475 % is wrong: The two columns will go to the main vertical list, with
4476 % the broken-off section in the recent contributions. As soon as
4477 % the output routine finishes, TeX starts reconsidering the page
4478 % break. The two columns and the broken-off section both fit on the
4479 % page, because the two columns now take up only half of the page
4480 % goal. When TeX sees \eject from below which follows the final
4481 % section, it invokes the new output routine that we've set after
4482 % \balancecolumns below; \onepageout will try to fit the two columns
4483 % and the final section into the vbox of \pageheight (see
4484 % \pagebody), causing an overfull box.
4486 % Note that glue won't work here, because glue does not exercise the
4487 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4491 % Split the last of the double-column material. Leave it on the
4492 % current page, no automatic page break.
4495 % If we end up splitting too much material for the current page,
4496 % though, there will be another page break right after this \output
4497 % invocation ends. Having called \balancecolumns once, we do not
4498 % want to call it again. Therefore, reset \output to its normal
4499 % definition right away. (We hope \balancecolumns will never be
4500 % called on to balance too much material, but if it is, this makes
4501 % the output somewhat more palatable.)
4502 \global\output = {\onepageout{\pagecontents\PAGE}}%
4505 \endgroup % started in \begindoublecolumns
4507 % \pagegoal was set to the doubled \vsize above, since we restarted
4508 % the current page. We're now back to normal single-column
4509 % typesetting, so reset \pagegoal to the normal \vsize (after the
4510 % \endgroup where \vsize got restored).
4514 % Called at the end of the double column material.
4515 \def\balancecolumns{%
4516 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4518 \advance\dimen@ by \topskip
4519 \advance\dimen@ by-\baselineskip
4520 \divide\dimen@ by 2 % target to split to
4521 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4522 \splittopskip = \topskip
4523 % Loop until we get a decent breakpoint.
4527 \global\setbox3 = \copy0
4528 \global\setbox1 = \vsplit3 to \dimen@
4530 \global\advance\dimen@ by 1pt
4533 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4534 \setbox0=\vbox to\dimen@{\unvbox1}%
4535 \setbox2=\vbox to\dimen@{\unvbox3}%
4539 \catcode`\@ = \other
4542 \message{sectioning,}
4543 % Chapters, sections, etc.
4545 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4546 % sections so that we can refer to them unambiguously in the pdf
4547 % outlines by their "section number". We avoid collisions with chapter
4548 % numbers by starting them at 10000. (If a document ever has 10000
4549 % chapters, we're in trouble anyway, I'm sure.)
4550 \newcount\unnumberedno \unnumberedno = 10000
4552 \newcount\secno \secno=0
4553 \newcount\subsecno \subsecno=0
4554 \newcount\subsubsecno \subsubsecno=0
4556 % This counter is funny since it counts through charcodes of letters A, B, ...
4557 \newcount\appendixno \appendixno = `\@
4559 % \def\appendixletter{\char\the\appendixno}
4560 % We do the following ugly conditional instead of the above simple
4561 % construct for the sake of pdftex, which needs the actual
4562 % letter in the expansion, not just typeset.
4564 \def\appendixletter{%
4565 \ifnum\appendixno=`A A%
4566 \else\ifnum\appendixno=`B B%
4567 \else\ifnum\appendixno=`C C%
4568 \else\ifnum\appendixno=`D D%
4569 \else\ifnum\appendixno=`E E%
4570 \else\ifnum\appendixno=`F F%
4571 \else\ifnum\appendixno=`G G%
4572 \else\ifnum\appendixno=`H H%
4573 \else\ifnum\appendixno=`I I%
4574 \else\ifnum\appendixno=`J J%
4575 \else\ifnum\appendixno=`K K%
4576 \else\ifnum\appendixno=`L L%
4577 \else\ifnum\appendixno=`M M%
4578 \else\ifnum\appendixno=`N N%
4579 \else\ifnum\appendixno=`O O%
4580 \else\ifnum\appendixno=`P P%
4581 \else\ifnum\appendixno=`Q Q%
4582 \else\ifnum\appendixno=`R R%
4583 \else\ifnum\appendixno=`S S%
4584 \else\ifnum\appendixno=`T T%
4585 \else\ifnum\appendixno=`U U%
4586 \else\ifnum\appendixno=`V V%
4587 \else\ifnum\appendixno=`W W%
4588 \else\ifnum\appendixno=`X X%
4589 \else\ifnum\appendixno=`Y Y%
4590 \else\ifnum\appendixno=`Z Z%
4591 % The \the is necessary, despite appearances, because \appendixletter is
4592 % expanded while writing the .toc file. \char\appendixno is not
4593 % expandable, thus it is written literally, thus all appendixes come out
4594 % with the same letter (or @) in the toc without it.
4595 \else\char\the\appendixno
4596 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4597 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4599 % Each @chapter defines this as the name of the chapter.
4600 % page headings and footings can use it. @section does likewise.
4601 % However, they are not reliable, because we don't use marks.
4605 \newcount\absseclevel % used to calculate proper heading level
4606 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4608 % @raisesections: treat @section as chapter, @subsection as section, etc.
4609 \def\raisesections{\global\advance\secbase by -1}
4610 \let\up=\raisesections % original BFox name
4612 % @lowersections: treat @chapter as section, @section as subsection, etc.
4613 \def\lowersections{\global\advance\secbase by 1}
4614 \let\down=\lowersections % original BFox name
4616 % we only have subsub.
4617 \chardef\maxseclevel = 3
4619 % A numbered section within an unnumbered changes to unnumbered too.
4620 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4621 \chardef\unmlevel = \maxseclevel
4623 % Trace whether the current chapter is an appendix or not:
4624 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4625 \def\chapheadtype{N}
4627 % Choose a heading macro
4628 % #1 is heading type
4629 % #2 is heading level
4630 % #3 is text for heading
4631 \def\genhead#1#2#3{%
4632 % Compute the abs. sec. level:
4634 \advance\absseclevel by \secbase
4635 % Make sure \absseclevel doesn't fall outside the range:
4636 \ifnum \absseclevel < 0
4639 \ifnum \absseclevel > 3
4646 \ifnum \absseclevel < \unmlevel
4647 \chardef\unmlevel = \absseclevel
4650 % Check for appendix sections:
4651 \ifnum \absseclevel = 0
4652 \edef\chapheadtype{\headtype}%
4654 \if \headtype A\if \chapheadtype N%
4655 \errmessage{@appendix... within a non-appendix chapter}%
4658 % Check for numbered within unnumbered:
4659 \ifnum \absseclevel > \unmlevel
4662 \chardef\unmlevel = 3
4665 % Now print the heading:
4669 \or \unnumberedseczzz{#3}%
4670 \or \unnumberedsubseczzz{#3}%
4671 \or \unnumberedsubsubseczzz{#3}%
4677 \or \appendixsectionzzz{#3}%
4678 \or \appendixsubseczzz{#3}%
4679 \or \appendixsubsubseczzz{#3}%
4685 \or \numberedsubseczzz{#3}%
4686 \or \numberedsubsubseczzz{#3}%
4690 \suppressfirstparagraphindent
4694 \def\numhead{\genhead N}
4695 \def\apphead{\genhead A}
4696 \def\unnmhead{\genhead U}
4698 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4699 % all lower-level sectioning counters to zero.
4701 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4702 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4703 \let\chaplevelprefix = \empty
4705 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4707 % section resetting is \global in case the chapter is in a group, such
4708 % as an @include file.
4709 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4710 \global\advance\chapno by 1
4713 \gdef\chaplevelprefix{\the\chapno.}%
4716 \message{\putwordChapter\space \the\chapno}%
4718 % Write the actual heading.
4719 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4721 % So @section and the like are numbered underneath this chapter.
4722 \global\let\section = \numberedsec
4723 \global\let\subsection = \numberedsubsec
4724 \global\let\subsubsection = \numberedsubsubsec
4727 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4728 \def\appendixzzz#1{%
4729 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4730 \global\advance\appendixno by 1
4731 \gdef\chaplevelprefix{\appendixletter.}%
4734 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4735 \message{\appendixnum}%
4737 \chapmacro{#1}{Yappendix}{\appendixletter}%
4739 \global\let\section = \appendixsec
4740 \global\let\subsection = \appendixsubsec
4741 \global\let\subsubsection = \appendixsubsubsec
4744 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4745 \def\unnumberedzzz#1{%
4746 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4747 \global\advance\unnumberedno by 1
4749 % Since an unnumbered has no number, no prefix for figures.
4750 \global\let\chaplevelprefix = \empty
4753 % This used to be simply \message{#1}, but TeX fully expands the
4754 % argument to \message. Therefore, if #1 contained @-commands, TeX
4755 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4756 % expanded @cite (which turns out to cause errors because \cite is meant
4757 % to be executed, not expanded).
4759 % Anyway, we don't want the fully-expanded definition of @cite to appear
4760 % as a result of the \message, we just want `@cite' itself. We use
4761 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4762 % simply yielding the contents of <toks register>. (We also do this for
4765 \message{(\the\toks0)}%
4767 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4769 \global\let\section = \unnumberedsec
4770 \global\let\subsection = \unnumberedsubsec
4771 \global\let\subsubsection = \unnumberedsubsubsec
4774 % @centerchap is like @unnumbered, but the heading is centered.
4775 \outer\parseargdef\centerchap{%
4776 % Well, we could do the following in a group, but that would break
4777 % an assumption that \chapmacro is called at the outermost level.
4778 % Thus we are safer this way: --kasal, 24feb04
4779 \let\centerparametersmaybe = \centerparameters
4781 \let\centerparametersmaybe = \relax
4784 % @top is like @unnumbered.
4788 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4790 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4791 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4794 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4795 \def\appendixsectionzzz#1{%
4796 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4797 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4799 \let\appendixsec\appendixsection
4801 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4802 \def\unnumberedseczzz#1{%
4803 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4804 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4808 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4809 \def\numberedsubseczzz#1{%
4810 \global\subsubsecno=0 \global\advance\subsecno by 1
4811 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4814 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4815 \def\appendixsubseczzz#1{%
4816 \global\subsubsecno=0 \global\advance\subsecno by 1
4817 \sectionheading{#1}{subsec}{Yappendix}%
4818 {\appendixletter.\the\secno.\the\subsecno}%
4821 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4822 \def\unnumberedsubseczzz#1{%
4823 \global\subsubsecno=0 \global\advance\subsecno by 1
4824 \sectionheading{#1}{subsec}{Ynothing}%
4825 {\the\unnumberedno.\the\secno.\the\subsecno}%
4829 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4830 \def\numberedsubsubseczzz#1{%
4831 \global\advance\subsubsecno by 1
4832 \sectionheading{#1}{subsubsec}{Ynumbered}%
4833 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4836 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4837 \def\appendixsubsubseczzz#1{%
4838 \global\advance\subsubsecno by 1
4839 \sectionheading{#1}{subsubsec}{Yappendix}%
4840 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4843 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4844 \def\unnumberedsubsubseczzz#1{%
4845 \global\advance\subsubsecno by 1
4846 \sectionheading{#1}{subsubsec}{Ynothing}%
4847 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4850 % These macros control what the section commands do, according
4851 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4852 % Define them by default for a numbered chapter.
4853 \let\section = \numberedsec
4854 \let\subsection = \numberedsubsec
4855 \let\subsubsection = \numberedsubsubsec
4857 % Define @majorheading, @heading and @subheading
4859 % NOTE on use of \vbox for chapter headings, section headings, and such:
4860 % 1) We use \vbox rather than the earlier \line to permit
4861 % overlong headings to fold.
4862 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4863 % heading is obnoxious; this forbids it.
4864 % 3) Likewise, headings look best if no \parindent is used, and
4865 % if justification is not attempted. Hence \raggedright.
4869 {\advance\chapheadingskip by 10pt \chapbreak }%
4870 \parsearg\chapheadingzzz
4873 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4874 \def\chapheadingzzz#1{%
4875 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4876 \parindent=0pt\raggedright
4878 \bigskip \par\penalty 200\relax
4879 \suppressfirstparagraphindent
4882 % @heading, @subheading, @subsubheading.
4883 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4884 \suppressfirstparagraphindent}
4885 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4886 \suppressfirstparagraphindent}
4887 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4888 \suppressfirstparagraphindent}
4890 % These macros generate a chapter, section, etc. heading only
4891 % (including whitespace, linebreaking, etc. around it),
4892 % given all the information in convenient, parsed form.
4894 %%% Args are the skip and penalty (usually negative)
4895 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4897 %%% Define plain chapter starts, and page on/off switching for it
4898 % Parameter controlling skip before chapter headings (if needed)
4900 \newskip\chapheadingskip
4902 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4903 \def\chappager{\par\vfill\supereject}
4904 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4906 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4909 \global\let\contentsalignmacro = \chappager
4910 \global\let\pchapsepmacro=\chapbreak
4911 \global\let\pagealignmacro=\chappager}
4914 \global\let\contentsalignmacro = \chappager
4915 \global\let\pchapsepmacro=\chappager
4916 \global\let\pagealignmacro=\chappager
4917 \global\def\HEADINGSon{\HEADINGSsingle}}
4920 \global\let\contentsalignmacro = \chapoddpage
4921 \global\let\pchapsepmacro=\chapoddpage
4922 \global\let\pagealignmacro=\chapoddpage
4923 \global\def\HEADINGSon{\HEADINGSdouble}}
4929 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4930 % Yappendix, Yomitfromtoc), #3 the chapter number.
4932 % To test against our argument.
4933 \def\Ynothingkeyword{Ynothing}
4934 \def\Yomitfromtockeyword{Yomitfromtoc}
4935 \def\Yappendixkeyword{Yappendix}
4937 \def\chapmacro#1#2#3{%
4942 % Have to define \thissection before calling \donoderef, because the
4943 % xref code eventually uses it. On the other hand, it has to be called
4944 % after \pchapsepmacro, or the headline will change too soon.
4945 \gdef\thissection{#1}%
4946 \gdef\thischaptername{#1}%
4948 % Only insert the separating space if we have a chapter/appendix
4949 % number, and don't print the unnumbered ``number''.
4951 \ifx\temptype\Ynothingkeyword
4953 \def\toctype{unnchap}%
4954 \gdef\thischapternum{}%
4955 \gdef\thischapter{#1}%
4956 \else\ifx\temptype\Yomitfromtockeyword
4957 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4959 \gdef\thischapternum{}%
4960 \gdef\thischapter{}%
4961 \else\ifx\temptype\Yappendixkeyword
4962 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4964 \xdef\thischapternum{\appendixletter}%
4965 % We don't substitute the actual chapter name into \thischapter
4966 % because we don't want its macros evaluated now. And we don't
4967 % use \thissection because that changes with each section.
4969 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4970 \noexpand\thischaptername}%
4972 \setbox0 = \hbox{#3\enspace}%
4973 \def\toctype{numchap}%
4974 \xdef\thischapternum{\the\chapno}%
4975 \xdef\thischapter{\putwordChapter{} \the\chapno:
4976 \noexpand\thischaptername}%
4979 % Write the toc entry for this chapter. Must come before the
4980 % \donoderef, because we include the current node name in the toc
4981 % entry, and \donoderef resets it to empty.
4982 \writetocentry{\toctype}{#1}{#3}%
4984 % For pdftex, we have to write out the node definition (aka, make
4985 % the pdfdest) after any page break, but before the actual text has
4986 % been typeset. If the destination for the pdf outline is after the
4987 % text, then jumping from the outline may wind up with the text not
4988 % being visible, for instance under high magnification.
4991 % Typeset the actual heading.
4992 \nobreak % Avoid page breaks at the interline glue.
4993 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4994 \hangindent=\wd0 \centerparametersmaybe
4997 \nobreak\bigskip % no page break after a chapter title
5001 % @centerchap -- centered and unnumbered.
5002 \let\centerparametersmaybe = \relax
5003 \def\centerparameters{%
5004 \advance\rightskip by 3\rightskip
5005 \leftskip = \rightskip
5010 % I don't think this chapter style is supported any more, so I'm not
5011 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5013 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5015 \def\unnchfopen #1{%
5016 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5017 \parindent=0pt\raggedright
5018 \rm #1\hfill}}\bigskip \par\nobreak
5020 \def\chfopen #1#2{\chapoddpage {\chapfonts
5021 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5024 \def\centerchfopen #1{%
5025 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5027 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5030 \global\let\chapmacro=\chfopen
5031 \global\let\centerchapmacro=\centerchfopen}
5034 % Section titles. These macros combine the section number parts and
5035 % call the generic \sectionheading to do the printing.
5037 \newskip\secheadingskip
5038 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5040 % Subsection titles.
5041 \newskip\subsecheadingskip
5042 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5044 % Subsubsection titles.
5045 \def\subsubsecheadingskip{\subsecheadingskip}
5046 \def\subsubsecheadingbreak{\subsecheadingbreak}
5049 % Print any size, any type, section title.
5051 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5052 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5055 \def\sectionheading#1#2#3#4{%
5057 % Switch to the right set of fonts.
5058 \csname #2fonts\endcsname \rm
5060 % Insert space above the heading.
5061 \csname #2headingbreak\endcsname
5063 % Only insert the space after the number if we have a section number.
5064 \def\sectionlevel{#2}%
5067 \ifx\temptype\Ynothingkeyword
5070 \gdef\thissection{#1}%
5071 \else\ifx\temptype\Yomitfromtockeyword
5072 % for @headings -- no section number, don't include in toc,
5073 % and don't redefine \thissection.
5076 \let\sectionlevel=\empty
5077 \else\ifx\temptype\Yappendixkeyword
5078 \setbox0 = \hbox{#4\enspace}%
5080 \gdef\thissection{#1}%
5082 \setbox0 = \hbox{#4\enspace}%
5084 \gdef\thissection{#1}%
5087 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5088 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5090 % Write the node reference (= pdf destination for pdftex).
5091 % Again, see comments in \chapmacro.
5094 % Interline glue will be inserted when the vbox is completed.
5095 % That glue will be a valid breakpoint for the page, since it'll be
5096 % preceded by a whatsit (usually from the \donoderef, or from the
5097 % \writetocentry if there was no node). We don't want to allow that
5098 % break, since then the whatsits could end up on page n while the
5099 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5102 % Output the actual section heading.
5103 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5104 \hangindent=\wd0 % zero if no section number
5107 % Add extra space after the heading -- half of whatever came above it.
5108 % Don't allow stretch, though.
5109 \kern .5 \csname #2headingskip\endcsname
5111 % Do not let the kern be a potential breakpoint, as it would be if it
5112 % was followed by glue.
5115 % We'll almost certainly start a paragraph next, so don't let that
5116 % glue accumulate. (Not a breakpoint because it's preceded by a
5117 % discardable item.)
5120 % This is purely so the last item on the list is a known \penalty >
5121 % 10000. This is so \startdefun can avoid allowing breakpoints after
5122 % section headings. Otherwise, it would insert a valid breakpoint between:
5124 % @section sec-whatever
5125 % @deffn def-whatever
5131 % Table of contents.
5134 % Write an entry to the toc file, opening it if necessary.
5135 % Called from @chapter, etc.
5137 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5138 % We append the current node name (if any) and page number as additional
5139 % arguments for the \{chap,sec,...}entry macros which will eventually
5140 % read this. The node name is used in the pdf outlines as the
5141 % destination to jump to.
5143 % We open the .toc file for writing here instead of at @setfilename (or
5144 % any other fixed time) so that @contents can be anywhere in the document.
5145 % But if #1 is `omit', then we don't do anything. This is used for the
5146 % table of contents chapter openings themselves.
5148 \newif\iftocfileopened
5149 \def\omitkeyword{omit}%
5151 \def\writetocentry#1#2#3{%
5152 \edef\writetoctype{#1}%
5153 \ifx\writetoctype\omitkeyword \else
5154 \iftocfileopened\else
5155 \immediate\openout\tocfile = \jobname.toc
5156 \global\tocfileopenedtrue
5162 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5168 % Tell \shipout to create a pdf destination on each page, if we're
5169 % writing pdf. These are used in the table of contents. We can't
5170 % just write one on every page because the title pages are numbered
5171 % 1 and 2 (the page numbers aren't printed), and so are the first
5172 % two pages of the document. Thus, we'd have two destinations named
5173 % `1', and two named `2'.
5174 \ifpdf \global\pdfmakepagedesttrue \fi
5178 % These characters do not print properly in the Computer Modern roman
5179 % fonts, so we must take special care. This is more or less redundant
5180 % with the Texinfo input format setup at the end of this file.
5182 \def\activecatcodes{%
5195 % Read the toc file, which is essentially Texinfo input.
5199 \input \tocreadfilename
5202 \newskip\contentsrightmargin \contentsrightmargin=1in
5203 \newcount\savepageno
5204 \newcount\lastnegativepageno \lastnegativepageno = -1
5206 % Prepare to read what we've written to \tocfile.
5208 \def\startcontents#1{%
5209 % If @setchapternewpage on, and @headings double, the contents should
5210 % start on an odd page, unlike chapters. Thus, we maintain
5211 % \contentsalignmacro in parallel with \pagealignmacro.
5212 % From: Torbjorn Granlund <tege@matematik.su.se>
5214 \immediate\closeout\tocfile
5216 % Don't need to put `Contents' or `Short Contents' in the headline.
5217 % It is abundantly clear what they are.
5219 \chapmacro{#1}{Yomitfromtoc}{}%
5221 \savepageno = \pageno
5222 \begingroup % Set up to handle contents files properly.
5223 \raggedbottom % Worry more about breakpoints than the bottom.
5224 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5226 % Roman numerals for page numbers.
5227 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5230 % redefined for the two-volume lispref. We always output on
5231 % \jobname.toc even if this is redefined.
5233 \def\tocreadfilename{\jobname.toc}
5235 % Normal (long) toc.
5238 \startcontents{\putwordTOC}%
5239 \openin 1 \tocreadfilename\space
5244 \contentsalignmacro % in case @setchapternewpage odd is in effect
5250 \lastnegativepageno = \pageno
5251 \global\pageno = \savepageno
5254 % And just the chapters.
5255 \def\summarycontents{%
5256 \startcontents{\putwordShortTOC}%
5258 \let\numchapentry = \shortchapentry
5259 \let\appentry = \shortchapentry
5260 \let\unnchapentry = \shortunnchapentry
5261 % We want a true roman here for the page numbers.
5263 \let\rm=\shortcontrm \let\bf=\shortcontbf
5264 \let\sl=\shortcontsl \let\tt=\shortconttt
5266 \hyphenpenalty = 10000
5267 \advance\baselineskip by 1pt % Open it up a little.
5268 \def\numsecentry##1##2##3##4{}
5269 \let\appsecentry = \numsecentry
5270 \let\unnsecentry = \numsecentry
5271 \let\numsubsecentry = \numsecentry
5272 \let\appsubsecentry = \numsecentry
5273 \let\unnsubsecentry = \numsecentry
5274 \let\numsubsubsecentry = \numsecentry
5275 \let\appsubsubsecentry = \numsecentry
5276 \let\unnsubsubsecentry = \numsecentry
5277 \openin 1 \tocreadfilename\space
5283 \contentsalignmacro % in case @setchapternewpage odd is in effect
5285 \lastnegativepageno = \pageno
5286 \global\pageno = \savepageno
5288 \let\shortcontents = \summarycontents
5290 % Typeset the label for a chapter or appendix for the short contents.
5291 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5293 \def\shortchaplabel#1{%
5294 % This space should be enough, since a single number is .5em, and the
5295 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5296 % But use \hss just in case.
5297 % (This space doesn't include the extra space that gets added after
5298 % the label; that gets put in by \shortchapentry above.)
5300 % We'd like to right-justify chapter numbers, but that looks strange
5301 % with appendix letters. And right-justifying numbers and
5302 % left-justifying letters looks strange when there is less than 10
5303 % chapters. Have to read the whole toc once to know how many chapters
5304 % there are before deciding ...
5305 \hbox to 1em{#1\hss}%
5308 % These macros generate individual entries in the table of contents.
5309 % The first argument is the chapter or section name.
5310 % The last argument is the page number.
5311 % The arguments in between are the chapter number, section number, ...
5313 % Chapters, in the main contents.
5314 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5316 % Chapters, in the short toc.
5317 % See comments in \dochapentry re vbox and related settings.
5318 \def\shortchapentry#1#2#3#4{%
5319 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5322 % Appendices, in the main contents.
5323 % Need the word Appendix, and a fixed-size box.
5325 \def\appendixbox#1{%
5326 % We use M since it's probably the widest letter.
5327 \setbox0 = \hbox{\putwordAppendix{} M}%
5328 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5330 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5332 % Unnumbered chapters.
5333 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5334 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5337 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5338 \let\appsecentry=\numsecentry
5339 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5342 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5343 \let\appsubsecentry=\numsubsecentry
5344 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5346 % And subsubsections.
5347 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5348 \let\appsubsubsecentry=\numsubsubsecentry
5349 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5351 % This parameter controls the indentation of the various levels.
5352 % Same as \defaultparindent.
5353 \newdimen\tocindent \tocindent = 15pt
5355 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5358 % If the toc has to be broken over pages, we want it to be at chapters
5359 % if at all possible; hence the \penalty.
5360 \def\dochapentry#1#2{%
5361 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5364 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5366 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5369 \def\dosecentry#1#2{\begingroup
5370 \secentryfonts \leftskip=\tocindent
5371 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5374 \def\dosubsecentry#1#2{\begingroup
5375 \subsecentryfonts \leftskip=2\tocindent
5376 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5379 \def\dosubsubsecentry#1#2{\begingroup
5380 \subsubsecentryfonts \leftskip=3\tocindent
5381 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5384 % We use the same \entry macro as for the index entries.
5385 \let\tocentry = \entry
5387 % Space between chapter (or whatever) number and the title.
5388 \def\labelspace{\hskip1em \relax}
5390 \def\dopageno#1{{\rm #1}}
5391 \def\doshortpageno#1{{\rm #1}}
5393 \def\chapentryfonts{\secfonts \rm}
5394 \def\secentryfonts{\textfonts}
5395 \def\subsecentryfonts{\textfonts}
5396 \def\subsubsecentryfonts{\textfonts}
5399 \message{environments,}
5400 % @foo ... @end foo.
5402 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5404 % Since these characters are used in examples, it should be an even number of
5405 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5408 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5409 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5410 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5411 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5413 % The @error{} command.
5414 % Adapted from the TeXbook's \boxit.
5418 {\tentt \global\dimen0 = 3em}% Width of the box.
5419 \dimen2 = .55pt % Thickness of rules
5420 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5421 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5423 \setbox\errorbox=\hbox to \dimen0{\hfil
5424 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5425 \advance\hsize by -2\dimen2 % Rules.
5427 \hrule height\dimen2
5428 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5429 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5430 \kern3pt\vrule width\dimen2}% Space to right.
5431 \hrule height\dimen2}
5434 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5436 % @tex ... @end tex escapes into raw Tex temporarily.
5437 % One exception: @ is still an escape character, so that @end tex works.
5438 % But \@ or @@ will get a plain tex @ character.
5441 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5442 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5443 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5453 \let\bullet=\ptexbullet
5458 \let\equiv=\ptexequiv
5461 \let\indent=\ptexindent
5462 \let\noindent=\ptexnoindent
5469 \let\frenchspacing=\plainfrenchspacing
5471 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5472 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5475 % There is no need to define \Etex.
5477 % Define @lisp ... @end lisp.
5478 % @lisp environment forms a group so it can rebind things,
5479 % including the definition of @end lisp (which normally is erroneous).
5481 % Amount to narrow the margins by for @lisp.
5482 \newskip\lispnarrowing \lispnarrowing=0.4in
5484 % This is the definition that ^^M gets inside @lisp, @example, and other
5485 % such environments. \null is better than a space, since it doesn't
5487 \def\lisppar{\null\endgraf}
5489 % This space is always present above and below environments.
5490 \newskip\envskipamount \envskipamount = 0pt
5492 % Make spacing and below environment symmetrical. We use \parskip here
5493 % to help in doing that, since in @example-like environments \parskip
5494 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5495 % start of the next paragraph will insert \parskip.
5497 \def\aboveenvbreak{{%
5498 % =10000 instead of <10000 because of a special case in \itemzzz and
5499 % \sectionheading, q.v.
5500 \ifnum \lastpenalty=10000 \else
5501 \advance\envskipamount by \parskip
5503 \ifdim\lastskip<\envskipamount
5505 % it's not a good place to break if the last penalty was \nobreak
5507 \ifnum\lastpenalty<10000 \penalty-50 \fi
5508 \vskip\envskipamount
5513 \let\afterenvbreak = \aboveenvbreak
5515 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5516 % also clear it, so that its embedded environments do the narrowing again.
5517 \let\nonarrowing=\relax
5519 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5520 % environment contents.
5521 \font\circle=lcircle10
5523 \newdimen\cartouter\newdimen\cartinner
5524 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5525 \circthick=\fontdimen8\circle
5527 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5528 \def\ctr{{\hskip 6pt\circle\char'010}}
5529 \def\cbl{{\circle\char'012\hskip -6pt}}
5530 \def\cbr{{\hskip 6pt\circle\char'011}}
5531 \def\carttop{\hbox to \cartouter{\hskip\lskip
5532 \ctl\leaders\hrule height\circthick\hfil\ctr
5534 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5535 \cbl\leaders\hrule height\circthick\hfil\cbr
5538 \newskip\lskip\newskip\rskip
5541 \ifhmode\par\fi % can't be in the midst of a paragraph.
5543 \lskip=\leftskip \rskip=\rightskip
5544 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5545 \cartinner=\hsize \advance\cartinner by-\lskip
5546 \advance\cartinner by-\rskip
5548 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5549 % side, and for 6pt waste from
5550 % each corner char, and rule thickness
5551 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5552 % Flag to tell @lisp, etc., not to narrow margin.
5553 \let\nonarrowing = t%
5555 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5563 \baselineskip=\normbskip
5564 \lineskip=\normlskip
5567 \comment % For explanation, see the end of \def\group.
5582 % This macro is called at the beginning of all the @example variants,
5586 \hfuzz = 12pt % Don't be fussy
5587 \sepspaces % Make spaces be word-separators rather than space tokens.
5588 \let\par = \lisppar % don't ignore blank lines
5589 \obeylines % each line of input is a line of output
5592 \emergencystretch = 0pt % don't try to avoid overfull boxes
5593 \ifx\nonarrowing\relax
5594 \advance \leftskip by \lispnarrowing
5595 \exdentamount=\lispnarrowing
5597 \let\nonarrowing = \relax
5599 \let\exdent=\nofillexdent
5602 % If you want all examples etc. small: @set dispenvsize small.
5603 % If you want even small examples the full size: @set dispenvsize nosmall.
5604 % This affects the following displayed environments:
5605 % @example, @display, @format, @lisp
5607 \def\smallword{small}
5608 \def\nosmallword{nosmall}
5609 \let\SETdispenvsize\relax
5610 \def\setnormaldispenv{%
5611 \ifx\SETdispenvsize\smallword
5612 % end paragraph for sake of leading, in case document has no blank
5613 % line. This is redundant with what happens in \aboveenvbreak, but
5614 % we need to do it before changing the fonts, and it's inconvenient
5615 % to change the fonts afterward.
5616 \ifnum \lastpenalty=10000 \else \endgraf \fi
5617 \smallexamplefonts \rm
5620 \def\setsmalldispenv{%
5621 \ifx\SETdispenvsize\nosmallword
5623 \ifnum \lastpenalty=10000 \else \endgraf \fi
5624 \smallexamplefonts \rm
5628 % We often define two environments, @foo and @smallfoo.
5629 % Let's do it by one command:
5630 \def\makedispenv #1#2{
5631 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5632 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5633 \expandafter\let\csname E#1\endcsname \afterenvbreak
5634 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5637 % Define two synonyms:
5638 \def\maketwodispenvs #1#2#3{
5639 \makedispenv{#1}{#3}
5640 \makedispenv{#2}{#3}
5643 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5645 % @smallexample and @smalllisp: use smaller fonts.
5646 % Originally contributed by Pavel@xerox.
5648 \maketwodispenvs {lisp}{example}{%
5651 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5652 \gobble % eat return
5654 % @display/@smalldisplay: same as @lisp except keep current font.
5656 \makedispenv {display}{%
5661 % @format/@smallformat: same as @display except don't narrow margins.
5663 \makedispenv{format}{%
5664 \let\nonarrowing = t%
5669 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5671 \let\nonarrowing = t%
5675 \let\Eflushleft = \afterenvbreak
5679 \envdef\flushright{%
5680 \let\nonarrowing = t%
5682 \advance\leftskip by 0pt plus 1fill
5685 \let\Eflushright = \afterenvbreak
5688 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5689 % and narrows the margins. We keep \parskip nonzero in general, since
5690 % we're doing normal filling. So, when using \aboveenvbreak and
5691 % \afterenvbreak, temporarily make \parskip 0.
5694 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5697 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5698 \ifx\nonarrowing\relax
5699 \advance\leftskip by \lispnarrowing
5700 \advance\rightskip by \lispnarrowing
5701 \exdentamount = \lispnarrowing
5703 \let\nonarrowing = \relax
5705 \parsearg\quotationlabel
5708 % We have retained a nonzero parskip for the environment, since we're
5709 % doing normal filling.
5713 \ifx\quotationauthor\undefined\else
5715 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5717 {\parskip=0pt \afterenvbreak}%
5720 % If we're given an argument, typeset it in bold with a colon after.
5721 \def\quotationlabel#1{%
5723 \ifx\temp\empty \else
5729 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5730 % If we want to allow any <char> as delimiter,
5731 % we need the curly braces so that makeinfo sees the @verb command, eg:
5732 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5734 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5736 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5737 % active too. Otherwise, they get lost as the first character on a
5740 \do\ \do\\\do\{\do\}\do\$\do\&%
5741 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5742 \do\<\do\>\do\|\do\@\do+\do\"%
5746 \def\uncatcodespecials{%
5747 \def\do##1{\catcode`##1=\other}\dospecials}
5749 % [Knuth] pp. 380,381,391
5750 % Disable Spanish ligatures ?` and !` of \tt font
5752 \catcode`\`=\active\gdef`{\relax\lq}
5755 % Setup for the @verb command.
5757 % Eight spaces for a tab
5759 \catcode`\^^I=\active
5760 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5764 \tt % easiest (and conventionally used) font for verbatim
5765 \def\par{\leavevmode\endgraf}%
5768 % Respect line breaks,
5769 % print special symbols as themselves, and
5770 % make each space count
5771 % must do in this order:
5772 \obeylines \uncatcodespecials \sepspaces
5775 % Setup for the @verbatim environment
5777 % Real tab expansion
5778 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5780 \def\starttabbox{\setbox0=\hbox\bgroup}
5782 % Allow an option to not replace quotes with a regular directed right
5783 % quote/apostrophe (char 0x27), but instead use the undirected quote
5784 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5785 % the default, but it works for pasting with more pdf viewers (at least
5786 % evince), the lilypond developers report. xpdf does work with the
5789 \def\codequoteright{%
5790 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
5791 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5797 % and a similar option for the left quote char vs. a grave accent.
5798 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5799 % the code environments to do likewise.
5801 \def\codequoteleft{%
5802 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
5803 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5810 \catcode`\^^I=\active
5812 \catcode`\^^I=\active
5813 \def^^I{\leavevmode\egroup
5814 \dimen0=\wd0 % the width so far, or since the previous tab
5815 \divide\dimen0 by\tabw
5816 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5817 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5818 \wd0=\dimen0 \box0 \starttabbox
5822 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
5825 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
5827 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
5830 % start the verbatim environment.
5831 \def\setupverbatim{%
5832 \let\nonarrowing = t%
5834 % Easiest (and conventionally used) font for verbatim
5836 \def\par{\leavevmode\egroup\box0\endgraf}%
5840 % Respect line breaks,
5841 % print special symbols as themselves, and
5842 % make each space count
5843 % must do in this order:
5844 \obeylines \uncatcodespecials \sepspaces
5845 \everypar{\starttabbox}%
5848 % Do the @verb magic: verbatim text is quoted by unique
5849 % delimiter characters. Before first delimiter expect a
5850 % right brace, after last delimiter expect closing brace:
5852 % \def\doverb'{'<char>#1<char>'}'{#1}
5854 % [Knuth] p. 382; only eat outer {}
5856 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5857 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5860 \def\verb{\begingroup\setupverb\doverb}
5863 % Do the @verbatim magic: define the macro \doverbatim so that
5864 % the (first) argument ends when '@end verbatim' is reached, ie:
5866 % \def\doverbatim#1@end verbatim{#1}
5868 % For Texinfo it's a lot easier than for LaTeX,
5869 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5870 % we need not redefine '\', '{' and '}'.
5872 % Inspired by LaTeX's verbatim command set [latex.ltx]
5877 % ignore everything up to the first ^^M, that's the newline at the end
5878 % of the @verbatim input line itself. Otherwise we get an extra blank
5879 % line in the output.
5880 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5881 % We really want {...\end verbatim} in the body of the macro, but
5882 % without the active space; thus we have to use \xdef and \gobble.
5886 \setupverbatim\doverbatim
5888 \let\Everbatim = \afterenvbreak
5891 % @verbatiminclude FILE - insert text of file in verbatim environment.
5893 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5895 \def\doverbatiminclude#1{%
5897 \makevalueexpandable
5904 % @copying ... @end copying.
5905 % Save the text away for @insertcopying later.
5907 % We save the uninterpreted tokens, rather than creating a box.
5908 % Saving the text in a box would be much easier, but then all the
5909 % typesetting commands (@smallbook, font changes, etc.) have to be done
5910 % beforehand -- and a) we want @copying to be done first in the source
5911 % file; b) letting users define the frontmatter in as flexible order as
5912 % possible is very desirable.
5914 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5915 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5917 \def\insertcopying{%
5919 \parindent = 0pt % paragraph indentation looks wrong on title page
5920 \scanexp\copyingtext
5928 \newskip\defbodyindent \defbodyindent=.4in
5929 \newskip\defargsindent \defargsindent=50pt
5930 \newskip\deflastargmargin \deflastargmargin=18pt
5931 \newcount\defunpenalty
5933 % Start the processing of @deffn:
5935 \ifnum\lastpenalty<10000
5937 \defunpenalty=10003 % Will keep this @deffn together with the
5938 % following @def command, see below.
5940 % If there are two @def commands in a row, we'll have a \nobreak,
5941 % which is there to keep the function description together with its
5942 % header. But if there's nothing but headers, we need to allow a
5943 % break somewhere. Check specifically for penalty 10002, inserted
5944 % by \printdefunline, instead of 10000, since the sectioning
5945 % commands also insert a nobreak penalty, and we don't want to allow
5946 % a break between a section heading and a defun.
5948 % As a minor refinement, we avoid "club" headers by signalling
5949 % with penalty of 10003 after the very first @deffn in the
5950 % sequence (see above), and penalty of 10002 after any following
5952 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
5954 % Similarly, after a section heading, do not allow a break.
5955 % But do insert the glue.
5956 \medskip % preceded by discardable penalty, so not a breakpoint
5960 \advance\leftskip by \defbodyindent
5961 \exdentamount=\defbodyindent
5965 % First, check whether we are in the right environment:
5968 % As above, allow line break if we have multiple x headers in a row.
5969 % It's not a great place, though.
5970 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
5972 % And now, it's time to reuse the body of the original defun:
5973 \expandafter\gobbledefun#1%
5975 \def\gobbledefun#1\startdefun{}
5977 % \printdefunline \deffnheader{text}
5979 \def\printdefunline#1#2{%
5981 % call \deffnheader:
5984 \interlinepenalty = 10000
5985 \advance\rightskip by 0pt plus 1fil
5987 \nobreak\vskip -\parskip
5988 \penalty\defunpenalty % signal to \startdefun and \dodefunx
5989 % Some of the @defun-type tags do not enable magic parentheses,
5990 % rendering the following check redundant. But we don't optimize.
5995 \def\Edefun{\endgraf\medbreak}
5997 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5998 % the only thing remainnig is to define \deffnheader.
6001 \expandafter\let\csname E#1\endcsname = \Edefun
6002 \edef\temp{\noexpand\domakedefun
6003 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6007 % \domakedefun \deffn \deffnx \deffnheader
6009 % Define \deffn and \deffnx, without parameters.
6010 % \deffnheader has to be defined explicitly.
6012 \def\domakedefun#1#2#3{%
6015 \parseargusing\activeparens{\printdefunline#3}%
6017 \def#2{\dodefunx#1}%
6021 %%% Untyped functions:
6023 % @deffn category name args
6024 \makedefun{deffn}{\deffngeneral{}}
6026 % @deffn category class name args
6027 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6029 % \defopon {category on}class name args
6030 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6032 % \deffngeneral {subind}category name args
6034 \def\deffngeneral#1#2 #3 #4\endheader{%
6035 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6036 \dosubind{fn}{\code{#3}}{#1}%
6037 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6040 %%% Typed functions:
6042 % @deftypefn category type name args
6043 \makedefun{deftypefn}{\deftypefngeneral{}}
6045 % @deftypeop category class type name args
6046 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6048 % \deftypeopon {category on}class type name args
6049 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6051 % \deftypefngeneral {subind}category type name args
6053 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6054 \dosubind{fn}{\code{#4}}{#1}%
6055 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6058 %%% Typed variables:
6060 % @deftypevr category type var args
6061 \makedefun{deftypevr}{\deftypecvgeneral{}}
6063 % @deftypecv category class type var args
6064 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6066 % \deftypecvof {category of}class type var args
6067 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6069 % \deftypecvgeneral {subind}category type var args
6071 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6072 \dosubind{vr}{\code{#4}}{#1}%
6073 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6076 %%% Untyped variables:
6078 % @defvr category var args
6079 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6081 % @defcv category class var args
6082 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6084 % \defcvof {category of}class var args
6085 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6088 % @deftp category name args
6089 \makedefun{deftp}#1 #2 #3\endheader{%
6090 \doind{tp}{\code{#2}}%
6091 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6094 % Remaining @defun-like shortcuts:
6095 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6096 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6097 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6098 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6099 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6100 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6101 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6102 \makedefun{defmethod}{\defopon\putwordMethodon}
6103 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6104 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6105 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6107 % \defname, which formats the name of the @def (not the args).
6108 % #1 is the category, such as "Function".
6109 % #2 is the return type, if any.
6110 % #3 is the function name.
6112 % We are followed by (but not passed) the arguments, if any.
6114 \def\defname#1#2#3{%
6115 % Get the values of \leftskip and \rightskip as they were outside the @def...
6116 \advance\leftskip by -\defbodyindent
6118 % How we'll format the type name. Putting it in brackets helps
6119 % distinguish it from the body text that may end up on the next line
6122 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6124 % Figure out line sizes for the paragraph shape.
6125 % The first line needs space for \box0; but if \rightskip is nonzero,
6126 % we need only space for the part of \box0 which exceeds it:
6127 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6128 % The continuations:
6129 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6130 % (plain.tex says that \dimen1 should be used only as global.)
6131 \parshape 2 0in \dimen0 \defargsindent \dimen2
6133 % Put the type name to the right margin.
6136 \hfil\box0 \kern-\hsize
6137 % \hsize has to be shortened this way:
6139 % Intentionally do not respect \rightskip, since we need the space.
6142 % Allow all lines to be underfull without complaint:
6143 \tolerance=10000 \hbadness=10000
6144 \exdentamount=\defbodyindent
6146 % defun fonts. We use typewriter by default (used to be bold) because:
6147 % . we're printing identifiers, they should be in tt in principle.
6148 % . in languages with many accents, such as Czech or French, it's
6149 % common to leave accents off identifiers. The result looks ok in
6150 % tt, but exceedingly strange in rm.
6151 % . we don't want -- and --- to be treated as ligatures.
6152 % . this still does not fix the ?` and !` ligatures, but so far no
6153 % one has made identifiers using them :).
6155 \def\temp{#2}% return value type
6156 \ifx\temp\empty\else \tclose{\temp} \fi
6157 #3% output function name
6159 {\rm\enskip}% hskip 0.5 em of \tenrm
6162 % arguments will be output next, if any.
6165 % Print arguments in slanted roman (not ttsl), inconsistently with using
6166 % tt for the name. This is because literal text is sometimes needed in
6167 % the argument list (groff manual), and ttsl and tt are not very
6168 % distinguishable. Prevent hyphenation at `-' chars.
6171 % use sl by default (not ttsl),
6173 \df \sl \hyphenchar\font=0
6175 % On the other hand, if an argument has two dashes (for instance), we
6176 % want a way to get ttsl. Let's try @var for that.
6179 \sl\hyphenchar\font=45
6182 % We want ()&[] to print specially on the defun line.
6185 \catcode`\(=\active \catcode`\)=\active
6186 \catcode`\[=\active \catcode`\]=\active
6190 % Make control sequences which act like normal parenthesis chars.
6191 \let\lparen = ( \let\rparen = )
6193 % Be sure that we always have a definition for `(', etc. For example,
6194 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6195 % so TeX would otherwise complain about undefined control sequence.
6198 \global\let(=\lparen \global\let)=\rparen
6199 \global\let[=\lbrack \global\let]=\rbrack
6202 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6203 \gdef\magicamp{\let&=\amprm}
6206 \newcount\parencount
6208 % If we encounter &foo, then turn on ()-hacking afterwards
6210 \def\amprm#1 {\ampseentrue{\bf\ }}
6214 % At the first level, print parens in roman,
6215 % otherwise use the default font.
6216 \ifnum \parencount=1 \rm \fi
6218 % The \sf parens (in \boldbrax) actually are a little bolder than
6219 % the contained text. This is especially needed for [ and ] .
6223 \def\infirstlevel#1{%
6230 \def\bfafterword#1 {#1 \bf}
6233 \global\advance\parencount by 1
6235 \infirstlevel \bfafterword
6240 \global\advance\parencount by -1
6243 \newcount\brackcount
6245 \global\advance\brackcount by 1
6250 \global\advance\brackcount by -1
6253 \def\checkparencounts{%
6254 \ifnum\parencount=0 \else \badparencount \fi
6255 \ifnum\brackcount=0 \else \badbrackcount \fi
6257 \def\badparencount{%
6258 \errmessage{Unbalanced parentheses in @def}%
6259 \global\parencount=0
6261 \def\badbrackcount{%
6262 \errmessage{Unbalanced square braces in @def}%
6263 \global\brackcount=0
6270 % To do this right we need a feature of e-TeX, \scantokens,
6271 % which we arrange to emulate with a temporary file in ordinary TeX.
6272 \ifx\eTeXversion\undefined
6273 \newwrite\macscribble
6276 \immediate\openout\macscribble=\jobname.tmp
6277 \immediate\write\macscribble{\the\toks0}%
6278 \immediate\closeout\macscribble
6286 \let\xeatspaces\eatspaces
6287 % Undo catcode changes of \startcontents and \doprintindex
6288 % When called from @insertcopying or (short)caption, we need active
6289 % backslash to get it printed correctly. Previously, we had
6290 % \catcode`\\=\other instead. We'll see whether a problem appears
6291 % with macro expansion. --kasal, 19aug04
6292 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6296 % Append \endinput to make sure that TeX does not see the ending newline.
6297 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6299 \scantokens{#1\endinput}%
6304 \edef\temp{\noexpand\scanmacro{#1}}%
6308 \newcount\paramno % Count of parameters
6309 \newtoks\macname % Macro name
6310 \newif\ifrecursive % Is it recursive?
6312 % List of all defined macros in the form
6313 % \definedummyword\macro1\definedummyword\macro2...
6314 % Currently is also contains all @aliases; the list can be split
6315 % if there is a need.
6318 % Add the macro to \macrolist
6319 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6320 \def\addtomacrolistxxx#1{%
6321 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6322 \xdef\macrolist{\the\toks0}%
6326 % This does \let #1 = #2, with \csnames; that is,
6327 % \let \csname#1\endcsname = \csname#2\endcsname
6328 % (except of course we have to play expansion games).
6332 \csname#1\expandafter\endcsname
6336 % Trim leading and trailing spaces off a string.
6337 % Concepts from aro-bend problem 15 (see CTAN).
6339 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6340 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6341 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6343 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6346 % Trim a single trailing ^^M off a string.
6347 {\catcode`\^^M=\other \catcode`\Q=3%
6348 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6349 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6350 \gdef\eatcrb#1Q#2Q{#1}%
6353 % Macro bodies are absorbed as an argument in a context where
6354 % all characters are catcode 10, 11 or 12, except \ which is active
6355 % (as in normal texinfo). It is necessary to change the definition of \.
6357 % Non-ASCII encodings make 8-bit characters active, so un-activate
6358 % them to avoid their expansion. Must do this non-globally, to
6359 % confine the change to the current group.
6361 % It's necessary to have hard CRs when the macro is executed. This is
6362 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6363 % body, and then making it the \newlinechar in \scanmacro.
6375 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6381 \catcode`\^^M=\other
6384 \def\macrobodyctxt{%
6388 \catcode`\^^M=\other
6397 % \mbodybackslash is the definition of \ in @macro bodies.
6398 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6399 % where N is the macro parameter number.
6400 % We define \csname macarg.\endcsname to be \realbackslash, so
6401 % \\ in macro replacement text gets you a backslash.
6403 {\catcode`@=0 @catcode`@\=@active
6404 @gdef@usembodybackslash{@let\=@mbodybackslash}
6405 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6407 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6409 \def\macro{\recursivefalse\parsearg\macroxxx}
6410 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6413 \getargs{#1}% now \macname is the macname and \argl the arglist
6414 \ifx\argl\empty % no arguments
6417 \expandafter\parsemargdef \argl;%
6419 \if1\csname ismacro.\the\macname\endcsname
6420 \message{Warning: redefining \the\macname}%
6422 \expandafter\ifx\csname \the\macname\endcsname \relax
6423 \else \errmessage{Macro name \the\macname\space already defined}\fi
6424 \global\cslet{macsave.\the\macname}{\the\macname}%
6425 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6426 \addtomacrolist{\the\macname}%
6428 \begingroup \macrobodyctxt
6429 \ifrecursive \expandafter\parsermacbody
6430 \else \expandafter\parsemacbody
6433 \parseargdef\unmacro{%
6434 \if1\csname ismacro.#1\endcsname
6435 \global\cslet{#1}{macsave.#1}%
6436 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6437 % Remove the macro name from \macrolist:
6439 \expandafter\let\csname#1\endcsname \relax
6440 \let\definedummyword\unmacrodo
6441 \xdef\macrolist{\macrolist}%
6444 \errmessage{Macro #1 not defined}%
6448 % Called by \do from \dounmacro on each macro. The idea is to omit any
6449 % macro definitions that have been changed to \relax.
6455 \noexpand\definedummyword \noexpand#1%
6459 % This makes use of the obscure feature that if the last token of a
6460 % <parameter list> is #, then the preceding argument is delimited by
6461 % an opening brace, and that opening brace is not consumed.
6462 \def\getargs#1{\getargsxxx#1{}}
6463 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6464 \def\getmacname #1 #2\relax{\macname={#1}}
6465 \def\getmacargs#1{\def\argl{#1}}
6467 % Parse the optional {params} list. Set up \paramno and \paramlist
6468 % so \defmacro knows what to do. Define \macarg.blah for each blah
6469 % in the params list, to be ##N where N is the position in that list.
6470 % That gets used by \mbodybackslash (above).
6472 % We need to get `macro parameter char #' into several definitions.
6473 % The technique used is stolen from LaTeX: let \hash be something
6474 % unexpandable, insert that wherever you need a #, and then redefine
6475 % it to # just before using the token list produced.
6477 % The same technique is used to protect \eatspaces till just before
6478 % the macro is used.
6480 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6481 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6482 \def\parsemargdefxxx#1,{%
6483 \if#1;\let\next=\relax
6484 \else \let\next=\parsemargdefxxx
6485 \advance\paramno by 1%
6486 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6487 {\xeatspaces{\hash\the\paramno}}%
6488 \edef\paramlist{\paramlist\hash\the\paramno,}%
6491 % These two commands read recursive and nonrecursive macro bodies.
6492 % (They're different since rec and nonrec macros end differently.)
6494 \long\def\parsemacbody#1@end macro%
6495 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6496 \long\def\parsermacbody#1@end rmacro%
6497 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6499 % This defines the macro itself. There are six cases: recursive and
6500 % nonrecursive macros of zero, one, and many arguments.
6501 % Much magic with \expandafter here.
6502 % \xdef is used so that macro definitions will survive the file
6503 % they're defined in; @include reads the file inside a group.
6505 \let\hash=##% convert placeholders to macro parameter chars
6509 \expandafter\xdef\csname\the\macname\endcsname{%
6510 \noexpand\scanmacro{\temp}}%
6512 \expandafter\xdef\csname\the\macname\endcsname{%
6513 \bgroup\noexpand\macroargctxt
6514 \noexpand\braceorline
6515 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6516 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6517 \egroup\noexpand\scanmacro{\temp}}%
6519 \expandafter\xdef\csname\the\macname\endcsname{%
6520 \bgroup\noexpand\macroargctxt
6521 \noexpand\csname\the\macname xx\endcsname}%
6522 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6523 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6524 \expandafter\expandafter
6526 \expandafter\expandafter
6527 \csname\the\macname xxx\endcsname
6528 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6533 \expandafter\xdef\csname\the\macname\endcsname{%
6534 \noexpand\norecurse{\the\macname}%
6535 \noexpand\scanmacro{\temp}\egroup}%
6537 \expandafter\xdef\csname\the\macname\endcsname{%
6538 \bgroup\noexpand\macroargctxt
6539 \noexpand\braceorline
6540 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6541 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6543 \noexpand\norecurse{\the\macname}%
6544 \noexpand\scanmacro{\temp}\egroup}%
6546 \expandafter\xdef\csname\the\macname\endcsname{%
6547 \bgroup\noexpand\macroargctxt
6548 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6549 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6550 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6551 \expandafter\expandafter
6553 \expandafter\expandafter
6554 \csname\the\macname xxx\endcsname
6557 \noexpand\norecurse{\the\macname}%
6558 \noexpand\scanmacro{\temp}\egroup}%
6562 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6564 % \braceorline decides whether the next nonwhitespace character is a
6565 % {. If so it reads up to the closing }, if not, it reads the whole
6566 % line. Whatever was read is then fed to the next control sequence
6567 % as an argument (by \parsebrace or \parsearg)
6568 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6569 \def\braceorlinexxx{%
6570 \ifx\nchar\bgroup\else
6571 \expandafter\parsearg
6576 % We need some trickery to remove the optional spaces around the equal
6577 % sign. Just make them active and then expand them all to nothing.
6578 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6579 \def\aliasxxx #1{\aliasyyy#1\relax}
6580 \def\aliasyyy #1=#2\relax{%
6582 \expandafter\let\obeyedspace=\empty
6583 \addtomacrolist{#1}%
6584 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6590 \message{cross references,}
6593 \newif\ifhavexrefs % True if xref values are known.
6594 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6596 % @inforef is relatively simple.
6597 \def\inforef #1{\inforefzzz #1,,,,**}
6598 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6599 node \samp{\ignorespaces#1{}}}
6601 % @node's only job in TeX is to define \lastnode, which is used in
6602 % cross-references. The @node line might or might not have commas, and
6603 % might or might not have spaces before the first comma, like:
6604 % @node foo , bar , ...
6605 % We don't want such trailing spaces in the node name.
6607 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6609 % also remove a trailing comma, in case of something like this:
6610 % @node Help-Cross, , , Cross-refs
6611 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6612 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6615 \let\lastnode=\empty
6617 % Write a cross-reference definition for the current node. #1 is the
6618 % type (Ynumbered, Yappendix, Ynothing).
6621 \ifx\lastnode\empty\else
6622 \setref{\lastnode}{#1}%
6623 \global\let\lastnode=\empty
6627 % @anchor{NAME} -- define xref target at arbitrary point.
6629 \newcount\savesfregister
6631 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6632 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6633 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6635 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6636 % anchor), which consists of three parts:
6637 % 1) NAME-title - the current sectioning name taken from \thissection,
6638 % or the anchor name.
6639 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6640 % empty for anchors.
6641 % 3) NAME-pg - the page number.
6643 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6644 % floats, there is an additional part, which is not written here:
6645 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6651 \atdummies % preserve commands, but don't expand them
6652 \edef\writexrdef##1##2{%
6653 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6654 ##1}{##2}}% these are parameters of \writexrdef
6656 \toks0 = \expandafter{\thissection}%
6657 \immediate \writexrdef{title}{\the\toks0 }%
6658 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6659 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6664 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6665 % the node name, #2 the name of the Info cross-reference, #3 the printed
6666 % node name, #4 the name of the Info file, #5 the name of the printed
6667 % manual. All but the node name can be omitted.
6669 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6670 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6671 \def\ref#1{\xrefX[#1,,,,,,,]}
6672 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6674 \def\printedmanual{\ignorespaces #5}%
6675 \def\printedrefname{\ignorespaces #3}%
6676 \setbox1=\hbox{\printedmanual\unskip}%
6677 \setbox0=\hbox{\printedrefname\unskip}%
6679 % No printed node name was explicitly given.
6680 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6681 % Use the node name inside the square brackets.
6682 \def\printedrefname{\ignorespaces #1}%
6684 % Use the actual chapter/section title appear inside
6685 % the square brackets. Use the real section title if we have it.
6687 % It is in another manual, so we don't have it.
6688 \def\printedrefname{\ignorespaces #1}%
6691 % We know the real title if we have the xref values.
6692 \def\printedrefname{\refx{#1-title}{}}%
6694 % Otherwise just copy the Info node name.
6695 \def\printedrefname{\ignorespaces #1}%
6701 % Make link in pdf output.
6707 % See comments at \activebackslashdouble.
6708 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6709 \backslashparens\pdfxrefdest}%
6711 \ifnum\filenamelength>0
6712 \startlink attr{/Border [0 0 0]}%
6713 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6715 \startlink attr{/Border [0 0 0]}%
6716 goto name{\pdfmkpgn{\pdfxrefdest}}%
6719 \setcolor{\linkcolor}%
6722 % Float references are printed completely differently: "Figure 1.2"
6723 % instead of "[somenode], p.3". We distinguish them by the
6724 % LABEL-title being set to a magic string.
6726 % Have to otherify everything special to allow the \csname to
6727 % include an _ in the xref name, etc.
6730 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6731 \csname XR#1-title\endcsname
6733 \iffloat\Xthisreftitle
6734 % If the user specified the print name (third arg) to the ref,
6735 % print it instead of our usual "Figure 1.2".
6742 % if the user also gave the printed manual name (fifth arg), append
6745 \space \putwordin{} \cite{\printedmanual}%
6748 % node/anchor (non-float) references.
6750 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6751 % insert empty discretionaries after hyphens, which means that it will
6752 % not find a line break at a hyphen in a node names. Since some manuals
6753 % are best written with fairly long node names, containing hyphens, this
6754 % is a loss. Therefore, we give the text of the node name again, so it
6755 % is as if TeX is seeing it for the first time.
6757 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6759 % _ (for example) has to be the character _ for the purposes of the
6760 % control sequence corresponding to the node, but it has to expand
6761 % into the usual \leavevmode...\vrule stuff for purposes of
6762 % printing. So we \turnoffactive for the \refx-snt, back on for the
6763 % printing, back off for the \refx-pg.
6765 % Only output a following space if the -snt ref is nonempty; for
6766 % @unnumbered and @anchor, it won't be.
6767 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6768 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6770 % output the `[mynode]' via a macro so it can be overridden.
6771 \xrefprintnodename\printedrefname
6773 % But we always want a comma and a space:
6776 % output the `page 3'.
6777 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6783 % This macro is called from \xrefX for the `[nodename]' part of xref
6784 % output. It's a separate macro only so it can be changed more easily,
6785 % since square brackets don't work well in some documents. Particularly
6786 % one that Bob is working on :).
6788 \def\xrefprintnodename#1{[#1]}
6790 % Things referred to by \setref.
6796 \putwordChapter@tie \the\chapno
6797 \else \ifnum\subsecno=0
6798 \putwordSection@tie \the\chapno.\the\secno
6799 \else \ifnum\subsubsecno=0
6800 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6802 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6807 \putwordAppendix@tie @char\the\appendixno{}%
6808 \else \ifnum\subsecno=0
6809 \putwordSection@tie @char\the\appendixno.\the\secno
6810 \else \ifnum\subsubsecno=0
6811 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6814 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6818 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6819 % If its value is nonempty, SUFFIX is output afterward.
6825 \expandafter\global\expandafter\let\expandafter\thisrefX
6826 \csname XR#1\endcsname
6829 % If not defined, say something at least.
6830 \angleleft un\-de\-fined\angleright
6833 \message{\linenumber Undefined cross reference `#1'.}%
6836 \global\warnedxrefstrue
6837 \message{Cross reference values unknown; you must run TeX again.}%
6842 % It's defined, so just use it.
6845 #2% Output the suffix in any case.
6848 % This is the macro invoked by entries in the aux file. Usually it's
6849 % just a \def (we prepend XR to the control sequence name to avoid
6850 % collisions). But if this is a float type, we have more work to do.
6853 {% The node name might contain 8-bit characters, which in our current
6854 % implementation are changed to commands like @'e. Don't let these
6855 % mess up the control sequence name.
6858 \xdef\safexrefname{#1}%
6861 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
6863 % Was that xref control sequence that we just defined for a float?
6864 \expandafter\iffloat\csname XR\safexrefname\endcsname
6865 % it was a float, and we have the (safe) float type in \iffloattype.
6866 \expandafter\let\expandafter\floatlist
6867 \csname floatlist\iffloattype\endcsname
6869 % Is this the first time we've seen this float type?
6870 \expandafter\ifx\floatlist\relax
6871 \toks0 = {\do}% yes, so just \do
6873 % had it before, so preserve previous elements in list.
6874 \toks0 = \expandafter{\floatlist\do}%
6877 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6878 % for later use in \listoffloats.
6879 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
6884 % Read the last existing aux file, if any. No error if none exists.
6887 \openin 1 \jobname.aux
6890 \global\havexrefstrue
6895 \def\setupdatafile{%
6896 \catcode`\^^@=\other
6897 \catcode`\^^A=\other
6898 \catcode`\^^B=\other
6899 \catcode`\^^C=\other
6900 \catcode`\^^D=\other
6901 \catcode`\^^E=\other
6902 \catcode`\^^F=\other
6903 \catcode`\^^G=\other
6904 \catcode`\^^H=\other
6905 \catcode`\^^K=\other
6906 \catcode`\^^L=\other
6907 \catcode`\^^N=\other
6908 \catcode`\^^P=\other
6909 \catcode`\^^Q=\other
6910 \catcode`\^^R=\other
6911 \catcode`\^^S=\other
6912 \catcode`\^^T=\other
6913 \catcode`\^^U=\other
6914 \catcode`\^^V=\other
6915 \catcode`\^^W=\other
6916 \catcode`\^^X=\other
6917 \catcode`\^^Z=\other
6918 \catcode`\^^[=\other
6919 \catcode`\^^\=\other
6920 \catcode`\^^]=\other
6921 \catcode`\^^^=\other
6922 \catcode`\^^_=\other
6923 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6924 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6925 % supported in the main text, it doesn't seem desirable. Furthermore,
6926 % that is not enough: for node names that actually contain a ^
6927 % character, we would end up writing a line like this: 'xrdef {'hat
6928 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6929 % argument, and \hat is not an expandable control sequence. It could
6930 % all be worked out, but why? Either we support ^^ or we don't.
6932 % The other change necessary for this was to define \auxhat:
6933 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6934 % and then to call \auxhat in \setq.
6938 % Special characters. Should be turned off anyway, but...
6951 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6953 % This is to support \ in node names and titles, since the \
6954 % characters end up in a \csname. It's easier than
6955 % leaving it active and making its active definition an actual \
6956 % character. What I don't understand is why it works in the *value*
6957 % of the xrdef. Seems like it should be a catcode12 \, and that
6958 % should not typeset properly. But it works, so I'm moving on for
6959 % now. --karl, 15jan04.
6962 % Make the characters 128-255 be printing characters.
6966 \catcode\count1=\other
6967 \advance\count1 by 1
6968 \ifnum \count1<256 \loop \fi
6972 % @ is our escape character in .aux files, and we need braces.
6978 \def\readdatafile#1{%
6985 \message{insertions,}
6986 % including footnotes.
6988 \newcount \footnoteno
6990 % The trailing space in the following definition for supereject is
6991 % vital for proper filling; pages come out unaligned when you do a
6992 % pagealignmacro call if that space before the closing brace is
6993 % removed. (Generally, numeric constants should always be followed by a
6994 % space to prevent strange expansion errors.)
6995 \def\supereject{\par\penalty -20000\footnoteno =0 }
6997 % @footnotestyle is meaningful for info output only.
6998 \let\footnotestyle=\comment
7002 % Auto-number footnotes. Otherwise like plain.
7004 \let\indent=\ptexindent
7005 \let\noindent=\ptexnoindent
7006 \global\advance\footnoteno by \@ne
7007 \edef\thisfootno{$^{\the\footnoteno}$}%
7009 % In case the footnote comes at the end of a sentence, preserve the
7010 % extra spacing after we do the footnote number.
7012 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7014 % Remove inadvertent blank space before typesetting the footnote number.
7020 % Don't bother with the trickery in plain.tex to not require the
7021 % footnote text as a parameter. Our footnotes don't need to be so general.
7023 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7024 % \parseargline) fails inside footnotes because the tokens are fixed when
7025 % the footnote is read. --karl, 16nov96.
7028 \insert\footins\bgroup
7029 % We want to typeset this text as a normal paragraph, even if the
7030 % footnote reference occurs in (for example) a display environment.
7031 % So reset some parameters.
7033 \interlinepenalty\interfootnotelinepenalty
7034 \splittopskip\ht\strutbox % top baseline for broken footnotes
7035 \splitmaxdepth\dp\strutbox
7036 \floatingpenalty\@MM
7041 \parindent\defaultparindent
7045 % Because we use hanging indentation in footnotes, a @noindent appears
7046 % to exdent this text, so make it be a no-op. makeinfo does not use
7047 % hanging indentation so @noindent can still be needed within footnote
7048 % text after an @example or the like (not that this is good style).
7049 \let\noindent = \relax
7051 % Hang the footnote text off the number. Use \everypar in case the
7052 % footnote extends for more than one paragraph.
7053 \everypar = {\hang}%
7054 \textindent{\thisfootno}%
7056 % Don't crash into the line above the footnote text. Since this
7057 % expands into a box, it must come within the paragraph, lest it
7058 % provide a place where TeX can split the footnote.
7060 \futurelet\next\fo@t
7062 }%end \catcode `\@=11
7064 % In case a @footnote appears in a vbox, save the footnote text and create
7065 % the real \insert just after the vbox finished. Otherwise, the insertion
7067 % Similarily, if a @footnote appears inside an alignment, save the footnote
7068 % text to a box and make the \insert when a row of the table is finished.
7069 % And the same can be done for other insert classes. --kasal, 16nov03.
7071 % Replace the \insert primitive by a cheating macro.
7072 % Deeper inside, just make sure that the saved insertions are not spilled
7075 \def\startsavinginserts{%
7076 \ifx \insert\ptexinsert
7077 \let\insert\saveinsert
7079 \let\checkinserts\relax
7083 % This \insert replacement works for both \insert\footins{foo} and
7084 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7087 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7088 \afterassignment\next
7089 % swallow the left brace
7092 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7093 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7095 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7097 \def\placesaveins#1{%
7098 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7102 % eat @SAVE -- beware, all of them have catcode \other:
7104 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7105 \gdef\gobblesave @SAVE{}
7109 \def\newsaveins #1{%
7110 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7113 \def\newsaveinsX #1{%
7114 \csname newbox\endcsname #1%
7115 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7120 \let\checkinserts\empty
7125 % @image. We use the macros from epsf.tex to support this.
7126 % If epsf.tex is not installed and @image is used, we complain.
7128 % Check for and read epsf.tex up front. If we read it only at @image
7129 % time, we might be inside a group, and then its definitions would get
7130 % undone and the next image would fail.
7131 \openin 1 = epsf.tex
7133 % Do not bother showing banner with epsf.tex v2.7k (available in
7134 % doc/epsf.tex and on ctan).
7135 \def\epsfannounce{\toks0 = }%
7140 % We will only complain once about lack of epsf.tex.
7141 \newif\ifwarnednoepsf
7142 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7143 work. It is also included in the Texinfo distribution, or you can get
7144 it from ftp://tug.org/tex/epsf.tex.}
7147 \ifx\epsfbox\undefined
7148 \ifwarnednoepsf \else
7149 \errhelp = \noepsfhelp
7150 \errmessage{epsf.tex not found, images will be ignored}%
7151 \global\warnednoepsftrue
7154 \imagexxx #1,,,,,\finish
7158 % Arguments to @image:
7159 % #1 is (mandatory) image filename; we tack on .eps extension.
7160 % #2 is (optional) width, #3 is (optional) height.
7161 % #4 is (ignored optional) html alt text.
7162 % #5 is (ignored optional) extension.
7163 % #6 is just the usual extra ignored arg for parsing this stuff.
7165 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7166 \catcode`\^^M = 5 % in case we're inside an example
7167 \normalturnoffactive % allow _ et al. in names
7168 % If the image is by itself, center it.
7172 % Usually we'll have text after the image which will insert
7173 % \parskip glue, so insert it here too to equalize the space
7175 \nobreak\vskip\parskip
7182 \dopdfimage{#1}{#2}{#3}%
7184 % \epsfbox itself resets \epsf?size at each figure.
7185 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7186 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7190 \ifimagevmode \egroup \bigbreak \fi % space after the image
7194 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7195 % etc. We don't actually implement floating yet, we always include the
7196 % float "here". But it seemed the best name for the future.
7198 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7200 % There may be a space before second and/or third parameter; delete it.
7201 \def\eatcommaspace#1, {#1,}
7203 % #1 is the optional FLOATTYPE, the text label for this float, typically
7204 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7205 % this float will not be numbered and cannot be referred to.
7207 % #2 is the optional xref label. Also must be present for the float to
7210 % #3 is the optional positioning argument; for now, it is ignored. It
7211 % will somehow specify the positions allowed to float to (here, top, bottom).
7213 % We keep a separate counter for each FLOATTYPE, which we reset at each
7214 % chapter-level command.
7215 \let\resetallfloatnos=\empty
7217 \def\dofloat#1,#2,#3,#4\finish{%
7218 \let\thiscaption=\empty
7219 \let\thisshortcaption=\empty
7221 % don't lose footnotes inside @float.
7223 % BEWARE: when the floats start float, we have to issue warning whenever an
7224 % insert appears inside a float which could possibly float. --kasal, 26may04
7228 % We can't be used inside a paragraph.
7233 \def\floatlabel{#2}%
7234 \def\floatloc{#3}% we do nothing with this yet.
7236 \ifx\floattype\empty
7237 \let\safefloattype=\empty
7240 % the floattype might have accents or other special characters,
7241 % but we need to use it in a control sequence name.
7244 \xdef\safefloattype{\floattype}%
7248 % If label is given but no type, we handle that as the empty type.
7249 \ifx\floatlabel\empty \else
7250 % We want each FLOATTYPE to be numbered separately (Figure 1,
7251 % Table 1, Figure 2, ...). (And if no label, no number.)
7253 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7254 \global\advance\floatno by 1
7257 % This magic value for \thissection is output by \setref as the
7258 % XREFLABEL-title value. \xrefX uses it to distinguish float
7259 % labels (which have a completely different output format) from
7260 % node and anchor labels. And \xrdef uses it to construct the
7263 \edef\thissection{\floatmagic=\safefloattype}%
7264 \setref{\floatlabel}{Yfloat}%
7268 % start with \parskip glue, I guess.
7271 % Don't suppress indentation if a float happens to start a section.
7272 \restorefirstparagraphindent
7275 % we have these possibilities:
7276 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7277 % @float Foo,lbl & no caption: Foo 1.1
7278 % @float Foo & @caption{Cap}: Foo: Cap
7279 % @float Foo & no caption: Foo
7280 % @float ,lbl & Caption{Cap}: 1.1: Cap
7281 % @float ,lbl & no caption: 1.1
7282 % @float & @caption{Cap}: Cap
7283 % @float & no caption:
7286 \let\floatident = \empty
7288 % In all cases, if we have a float type, it comes first.
7289 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7291 % If we have an xref label, the number comes next.
7292 \ifx\floatlabel\empty \else
7293 \ifx\floattype\empty \else % if also had float type, need tie first.
7294 \appendtomacro\floatident{\tie}%
7297 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7300 % Start the printed caption with what we've constructed in
7301 % \floatident, but keep it separate; we need \floatident again.
7302 \let\captionline = \floatident
7304 \ifx\thiscaption\empty \else
7305 \ifx\floatident\empty \else
7306 \appendtomacro\captionline{: }% had ident, so need a colon between
7310 \appendtomacro\captionline{\scanexp\thiscaption}%
7313 % If we have anything to print, print it, with space before.
7314 % Eventually this needs to become an \insert.
7315 \ifx\captionline\empty \else
7319 % Space below caption.
7323 % If have an xref label, write the list of floats info. Do this
7324 % after the caption, to avoid chance of it being a breakpoint.
7325 \ifx\floatlabel\empty \else
7326 % Write the text that goes in the lof to the aux file as
7327 % \floatlabel-lof. Besides \floatident, we include the short
7328 % caption if specified, else the full caption if specified, else nothing.
7332 % since we read the caption text in the macro world, where ^^M
7333 % is turned into a normal character, we have to scan it back, so
7334 % we don't write the literal three characters "^^M" into the aux file.
7336 \xdef\noexpand\gtemp{%
7337 \ifx\thisshortcaption\empty
7344 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7345 \ifx\gtemp\empty \else : \gtemp \fi}}%
7348 \egroup % end of \vtop
7350 % place the captured inserts
7352 % BEWARE: when the floats start floating, we have to issue warning
7353 % whenever an insert appears inside a float which could possibly
7354 % float. --kasal, 26may04
7359 % Append the tokens #2 to the definition of macro #1, not expanding either.
7361 \def\appendtomacro#1#2{%
7362 \expandafter\def\expandafter#1\expandafter{#1#2}%
7365 % @caption, @shortcaption
7367 \def\caption{\docaption\thiscaption}
7368 \def\shortcaption{\docaption\thisshortcaption}
7369 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7370 \def\defcaption#1#2{\egroup \def#1{#2}}
7372 % The parameter is the control sequence identifying the counter we are
7373 % going to use. Create it if it doesn't exist and assign it to \floatno.
7376 % Haven't seen this figure type before.
7377 \csname newcount\endcsname #1%
7379 % Remember to reset this floatno at the next chap.
7380 \expandafter\gdef\expandafter\resetallfloatnos
7381 \expandafter{\resetallfloatnos #1=0 }%
7386 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7387 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7388 % first read the @float command.
7390 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7392 % Magic string used for the XREFLABEL-title value, so \xrefX can
7393 % distinguish floats from other xref types.
7394 \def\floatmagic{!!float!!}
7396 % #1 is the control sequence we are passed; we expand into a conditional
7397 % which is true if #1 represents a float ref. That is, the magic
7398 % \thissection value which we \setref above.
7400 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7402 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7403 % (safe) float type for this float. We set \iffloattype to #2.
7405 \def\doiffloat#1=#2=#3\finish{%
7407 \def\iffloattype{#2}%
7408 \ifx\temp\floatmagic
7411 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7413 \parseargdef\listoffloats{%
7414 \def\floattype{#1}% floattype
7416 % the floattype might have accents or other special characters,
7417 % but we need to use it in a control sequence name.
7420 \xdef\safefloattype{\floattype}%
7423 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7424 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7426 % if the user said @listoffloats foo but never @float foo.
7427 \message{\linenumber No `\safefloattype' floats to list.}%
7431 \leftskip=\tocindent % indent these entries like a toc
7432 \let\do=\listoffloatsdo
7433 \csname floatlist\safefloattype\endcsname
7438 % This is called on each entry in a list of floats. We're passed the
7439 % xref label, in the form LABEL-title, which is how we save it in the
7440 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7441 % has the text we're supposed to typeset here.
7443 % Figures without xref labels will not be included in the list (since
7444 % they won't appear in the aux file).
7446 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7447 \def\listoffloatsdoentry#1-title\finish{{%
7448 % Can't fully expand XR#1-lof because it can contain anything. Just
7449 % pass the control sequence. On the other hand, XR#1-pg is just the
7450 % page number, and we want to fully expand that so we can get a link
7452 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7454 % use the same \entry macro we use to generate the TOC and index.
7455 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7460 \message{localization,}
7462 % @documentlanguage is usually given very early, just after
7463 % @setfilename. If done too late, it may not override everything
7464 % properly. Single argument is the language (de) or locale (de_DE)
7465 % abbreviation. It would be nice if we could set up a hyphenation file.
7468 \catcode`\_ = \active
7470 \parseargdef\documentlanguage{\begingroup
7471 \let_=\normalunderscore % normal _ character for filenames
7472 \tex % read txi-??.tex file in plain TeX.
7473 % Read the file by the name they passed if it exists.
7474 \openin 1 txi-#1.tex
7476 \documentlanguagetrywithoutunderscore{#1_\finish}%
7485 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7488 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7489 \openin 1 txi-#1.tex
7491 \errhelp = \nolanghelp
7492 \errmessage{Cannot read language file txi-#1.tex}%
7499 \newhelp\nolanghelp{The given language definition file cannot be found or
7500 is empty. Maybe you need to install it? In the current directory
7501 should work if nowhere else does.}
7503 % Set the catcode of characters 128 through 255 to the specified number.
7505 \def\setnonasciicharscatcode#1{%
7507 \loop\ifnum\count255<256
7508 \global\catcode\count255=#1\relax
7509 \advance\count255 by 1
7513 \def\setnonasciicharscatcodenonglobal#1{%
7515 \loop\ifnum\count255<256
7516 \catcode\count255=#1\relax
7517 \advance\count255 by 1
7521 % @documentencoding sets the definition of non-ASCII characters
7522 % according to the specified encoding.
7524 \parseargdef\documentencoding{%
7525 % Encoding being declared for the document.
7526 \def\declaredencoding{\csname #1.enc\endcsname}%
7528 % Supported encodings: names converted to tokens in order to be able
7529 % to compare them with \ifx.
7530 \def\ascii{\csname US-ASCII.enc\endcsname}%
7531 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7532 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7533 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7534 \def\utfeight{\csname UTF-8.enc\endcsname}%
7536 \ifx \declaredencoding \ascii
7539 \else \ifx \declaredencoding \lattwo
7540 \setnonasciicharscatcode\active
7543 \else \ifx \declaredencoding \latone
7544 \setnonasciicharscatcode\active
7547 \else \ifx \declaredencoding \latnine
7548 \setnonasciicharscatcode\active
7551 \else \ifx \declaredencoding \utfeight
7552 \setnonasciicharscatcode\active
7556 \message{Unknown document encoding #1, ignoring.}%
7565 % A message to be logged when using a character that isn't available
7566 % the default font encoding (OT1).
7568 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7570 % Take account of \c (plain) vs. \, (Texinfo) difference.
7571 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7573 % First, make active non-ASCII characters in order for them to be
7574 % correctly categorized when TeX reads the replacement text of
7575 % macros containing the character definitions.
7576 \setnonasciicharscatcode\active
7578 % Latin1 (ISO-8859-1) character definitions.
7579 \def\latonechardefs{%
7581 \gdef^^a1{\exclamdown}
7582 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7583 \gdef^^a3{{\pounds}}
7584 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7585 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7586 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7589 \gdef^^a9{\copyright}
7591 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7594 \gdef^^ae{\registeredsymbol}
7597 \gdef^^b0{\textdegree}
7606 \gdef^^b8{\cedilla\ }
7610 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7611 \gdef^^bc{$1\over4$}
7612 \gdef^^bd{$1\over2$}
7613 \gdef^^be{$3\over4$}
7614 \gdef^^bf{\questiondown}
7621 \gdef^^c5{\ringaccent A}
7623 \gdef^^c7{\cedilla C}
7633 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7647 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7655 \gdef^^e5{\ringaccent a}
7657 \gdef^^e7{\cedilla c}
7662 \gdef^^ec{\`{\dotless i}}
7663 \gdef^^ed{\'{\dotless i}}
7664 \gdef^^ee{\^{\dotless i}}
7665 \gdef^^ef{\"{\dotless i}}
7667 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7681 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7685 % Latin9 (ISO-8859-15) encoding character definitions.
7686 \def\latninechardefs{%
7687 % Encoding is almost identical to Latin1.
7700 % Latin2 (ISO-8859-2) character definitions.
7701 \def\lattwochardefs{%
7703 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7706 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7712 \gdef^^aa{\cedilla S}
7717 \gdef^^af{\dotaccent Z}
7719 \gdef^^b0{\textdegree}
7720 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7721 \gdef^^b2{\missingcharmsg{OGONEK}}
7727 \gdef^^b8{\cedilla\ }
7729 \gdef^^ba{\cedilla s}
7734 \gdef^^bf{\dotaccent z}
7743 \gdef^^c7{\cedilla C}
7746 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
7753 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
7762 \gdef^^d9{\ringaccent U}
7767 \gdef^^de{\cedilla T}
7777 \gdef^^e7{\cedilla c}
7780 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
7787 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
7796 \gdef^^f9{\ringaccent u}
7801 \gdef^^fe{\cedilla t}
7802 \gdef^^ff{\dotaccent{}}
7805 % UTF-8 character definitions.
7807 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
7808 % changes for Texinfo conventions. It is included here under the GPL by
7809 % permission from Frank Mittelbach and the LaTeX team.
7815 \gdef\UTFviiiTwoOctets#1#2{\expandafter
7816 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
7818 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
7819 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
7821 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
7822 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
7824 \gdef\UTFviiiDefined#1{%
7826 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
7837 \global\catcode\countUTFx\active
7838 \uccode`\~\countUTFx
7839 \uppercase\expandafter{\UTFviiiTmp}%
7840 \advance\countUTFx by 1
7841 \ifnum\countUTFx < \countUTFy
7842 \expandafter\UTFviiiLoop
7848 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
7854 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
7860 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
7873 \gdef\DeclareUnicodeCharacter#1#2{%
7874 \countUTFz = "#1\relax
7875 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
7878 \def\UTFviiiTwoOctets##1##2{%
7879 \csname u8:##1\string ##2\endcsname}%
7880 \def\UTFviiiThreeOctets##1##2##3{%
7881 \csname u8:##1\string ##2\string ##3\endcsname}%
7882 \def\UTFviiiFourOctets##1##2##3##4{%
7883 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
7884 \expandafter\expandafter\expandafter\expandafter
7885 \expandafter\expandafter\expandafter
7886 \gdef\UTFviiiTmp{#2}%
7889 \gdef\parseXMLCharref{%
7890 \ifnum\countUTFz < "A0\relax
7891 \errhelp = \EMsimple
7892 \errmessage{Cannot define Unicode char value < 00A0}%
7893 \else\ifnum\countUTFz < "800\relax
7895 \parseUTFviiiB C\UTFviiiTwoOctets.,%
7896 \else\ifnum\countUTFz < "10000\relax
7899 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
7904 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
7908 \gdef\parseUTFviiiA#1{%
7909 \countUTFx = \countUTFz
7910 \divide\countUTFz by 64
7911 \countUTFy = \countUTFz
7912 \multiply\countUTFz by 64
7913 \advance\countUTFx by -\countUTFz
7914 \advance\countUTFx by 128
7915 \uccode `#1\countUTFx
7916 \countUTFz = \countUTFy}
7918 \gdef\parseUTFviiiB#1#2#3#4{%
7919 \advance\countUTFz by "#10\relax
7920 \uccode `#3\countUTFz
7921 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
7924 \def\utfeightchardefs{%
7925 \DeclareUnicodeCharacter{00A0}{\tie}
7926 \DeclareUnicodeCharacter{00A1}{\exclamdown}
7927 \DeclareUnicodeCharacter{00A3}{\pounds}
7928 \DeclareUnicodeCharacter{00A8}{\"{ }}
7929 \DeclareUnicodeCharacter{00A9}{\copyright}
7930 \DeclareUnicodeCharacter{00AA}{\ordf}
7931 \DeclareUnicodeCharacter{00AD}{\-}
7932 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
7933 \DeclareUnicodeCharacter{00AF}{\={ }}
7935 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
7936 \DeclareUnicodeCharacter{00B4}{\'{ }}
7937 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
7938 \DeclareUnicodeCharacter{00BA}{\ordm}
7939 \DeclareUnicodeCharacter{00BF}{\questiondown}
7941 \DeclareUnicodeCharacter{00C0}{\`A}
7942 \DeclareUnicodeCharacter{00C1}{\'A}
7943 \DeclareUnicodeCharacter{00C2}{\^A}
7944 \DeclareUnicodeCharacter{00C3}{\~A}
7945 \DeclareUnicodeCharacter{00C4}{\"A}
7946 \DeclareUnicodeCharacter{00C5}{\AA}
7947 \DeclareUnicodeCharacter{00C6}{\AE}
7948 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
7949 \DeclareUnicodeCharacter{00C8}{\`E}
7950 \DeclareUnicodeCharacter{00C9}{\'E}
7951 \DeclareUnicodeCharacter{00CA}{\^E}
7952 \DeclareUnicodeCharacter{00CB}{\"E}
7953 \DeclareUnicodeCharacter{00CC}{\`I}
7954 \DeclareUnicodeCharacter{00CD}{\'I}
7955 \DeclareUnicodeCharacter{00CE}{\^I}
7956 \DeclareUnicodeCharacter{00CF}{\"I}
7958 \DeclareUnicodeCharacter{00D1}{\~N}
7959 \DeclareUnicodeCharacter{00D2}{\`O}
7960 \DeclareUnicodeCharacter{00D3}{\'O}
7961 \DeclareUnicodeCharacter{00D4}{\^O}
7962 \DeclareUnicodeCharacter{00D5}{\~O}
7963 \DeclareUnicodeCharacter{00D6}{\"O}
7964 \DeclareUnicodeCharacter{00D8}{\O}
7965 \DeclareUnicodeCharacter{00D9}{\`U}
7966 \DeclareUnicodeCharacter{00DA}{\'U}
7967 \DeclareUnicodeCharacter{00DB}{\^U}
7968 \DeclareUnicodeCharacter{00DC}{\"U}
7969 \DeclareUnicodeCharacter{00DD}{\'Y}
7970 \DeclareUnicodeCharacter{00DF}{\ss}
7972 \DeclareUnicodeCharacter{00E0}{\`a}
7973 \DeclareUnicodeCharacter{00E1}{\'a}
7974 \DeclareUnicodeCharacter{00E2}{\^a}
7975 \DeclareUnicodeCharacter{00E3}{\~a}
7976 \DeclareUnicodeCharacter{00E4}{\"a}
7977 \DeclareUnicodeCharacter{00E5}{\aa}
7978 \DeclareUnicodeCharacter{00E6}{\ae}
7979 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
7980 \DeclareUnicodeCharacter{00E8}{\`e}
7981 \DeclareUnicodeCharacter{00E9}{\'e}
7982 \DeclareUnicodeCharacter{00EA}{\^e}
7983 \DeclareUnicodeCharacter{00EB}{\"e}
7984 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
7985 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
7986 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
7987 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
7989 \DeclareUnicodeCharacter{00F1}{\~n}
7990 \DeclareUnicodeCharacter{00F2}{\`o}
7991 \DeclareUnicodeCharacter{00F3}{\'o}
7992 \DeclareUnicodeCharacter{00F4}{\^o}
7993 \DeclareUnicodeCharacter{00F5}{\~o}
7994 \DeclareUnicodeCharacter{00F6}{\"o}
7995 \DeclareUnicodeCharacter{00F8}{\o}
7996 \DeclareUnicodeCharacter{00F9}{\`u}
7997 \DeclareUnicodeCharacter{00FA}{\'u}
7998 \DeclareUnicodeCharacter{00FB}{\^u}
7999 \DeclareUnicodeCharacter{00FC}{\"u}
8000 \DeclareUnicodeCharacter{00FD}{\'y}
8001 \DeclareUnicodeCharacter{00FF}{\"y}
8003 \DeclareUnicodeCharacter{0100}{\=A}
8004 \DeclareUnicodeCharacter{0101}{\=a}
8005 \DeclareUnicodeCharacter{0102}{\u{A}}
8006 \DeclareUnicodeCharacter{0103}{\u{a}}
8007 \DeclareUnicodeCharacter{0106}{\'C}
8008 \DeclareUnicodeCharacter{0107}{\'c}
8009 \DeclareUnicodeCharacter{0108}{\^C}
8010 \DeclareUnicodeCharacter{0109}{\^c}
8011 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8012 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8013 \DeclareUnicodeCharacter{010C}{\v{C}}
8014 \DeclareUnicodeCharacter{010D}{\v{c}}
8015 \DeclareUnicodeCharacter{010E}{\v{D}}
8017 \DeclareUnicodeCharacter{0112}{\=E}
8018 \DeclareUnicodeCharacter{0113}{\=e}
8019 \DeclareUnicodeCharacter{0114}{\u{E}}
8020 \DeclareUnicodeCharacter{0115}{\u{e}}
8021 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8022 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8023 \DeclareUnicodeCharacter{011A}{\v{E}}
8024 \DeclareUnicodeCharacter{011B}{\v{e}}
8025 \DeclareUnicodeCharacter{011C}{\^G}
8026 \DeclareUnicodeCharacter{011D}{\^g}
8027 \DeclareUnicodeCharacter{011E}{\u{G}}
8028 \DeclareUnicodeCharacter{011F}{\u{g}}
8030 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8031 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8032 \DeclareUnicodeCharacter{0124}{\^H}
8033 \DeclareUnicodeCharacter{0125}{\^h}
8034 \DeclareUnicodeCharacter{0128}{\~I}
8035 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8036 \DeclareUnicodeCharacter{012A}{\=I}
8037 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8038 \DeclareUnicodeCharacter{012C}{\u{I}}
8039 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8041 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8042 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8043 \DeclareUnicodeCharacter{0132}{IJ}
8044 \DeclareUnicodeCharacter{0133}{ij}
8045 \DeclareUnicodeCharacter{0134}{\^J}
8046 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8047 \DeclareUnicodeCharacter{0139}{\'L}
8048 \DeclareUnicodeCharacter{013A}{\'l}
8050 \DeclareUnicodeCharacter{0141}{\L}
8051 \DeclareUnicodeCharacter{0142}{\l}
8052 \DeclareUnicodeCharacter{0143}{\'N}
8053 \DeclareUnicodeCharacter{0144}{\'n}
8054 \DeclareUnicodeCharacter{0147}{\v{N}}
8055 \DeclareUnicodeCharacter{0148}{\v{n}}
8056 \DeclareUnicodeCharacter{014C}{\=O}
8057 \DeclareUnicodeCharacter{014D}{\=o}
8058 \DeclareUnicodeCharacter{014E}{\u{O}}
8059 \DeclareUnicodeCharacter{014F}{\u{o}}
8061 \DeclareUnicodeCharacter{0150}{\H{O}}
8062 \DeclareUnicodeCharacter{0151}{\H{o}}
8063 \DeclareUnicodeCharacter{0152}{\OE}
8064 \DeclareUnicodeCharacter{0153}{\oe}
8065 \DeclareUnicodeCharacter{0154}{\'R}
8066 \DeclareUnicodeCharacter{0155}{\'r}
8067 \DeclareUnicodeCharacter{0158}{\v{R}}
8068 \DeclareUnicodeCharacter{0159}{\v{r}}
8069 \DeclareUnicodeCharacter{015A}{\'S}
8070 \DeclareUnicodeCharacter{015B}{\'s}
8071 \DeclareUnicodeCharacter{015C}{\^S}
8072 \DeclareUnicodeCharacter{015D}{\^s}
8073 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8074 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8076 \DeclareUnicodeCharacter{0160}{\v{S}}
8077 \DeclareUnicodeCharacter{0161}{\v{s}}
8078 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8079 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8080 \DeclareUnicodeCharacter{0164}{\v{T}}
8082 \DeclareUnicodeCharacter{0168}{\~U}
8083 \DeclareUnicodeCharacter{0169}{\~u}
8084 \DeclareUnicodeCharacter{016A}{\=U}
8085 \DeclareUnicodeCharacter{016B}{\=u}
8086 \DeclareUnicodeCharacter{016C}{\u{U}}
8087 \DeclareUnicodeCharacter{016D}{\u{u}}
8088 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8089 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8091 \DeclareUnicodeCharacter{0170}{\H{U}}
8092 \DeclareUnicodeCharacter{0171}{\H{u}}
8093 \DeclareUnicodeCharacter{0174}{\^W}
8094 \DeclareUnicodeCharacter{0175}{\^w}
8095 \DeclareUnicodeCharacter{0176}{\^Y}
8096 \DeclareUnicodeCharacter{0177}{\^y}
8097 \DeclareUnicodeCharacter{0178}{\"Y}
8098 \DeclareUnicodeCharacter{0179}{\'Z}
8099 \DeclareUnicodeCharacter{017A}{\'z}
8100 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8101 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8102 \DeclareUnicodeCharacter{017D}{\v{Z}}
8103 \DeclareUnicodeCharacter{017E}{\v{z}}
8105 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8106 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8107 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8108 \DeclareUnicodeCharacter{01C7}{LJ}
8109 \DeclareUnicodeCharacter{01C8}{Lj}
8110 \DeclareUnicodeCharacter{01C9}{lj}
8111 \DeclareUnicodeCharacter{01CA}{NJ}
8112 \DeclareUnicodeCharacter{01CB}{Nj}
8113 \DeclareUnicodeCharacter{01CC}{nj}
8114 \DeclareUnicodeCharacter{01CD}{\v{A}}
8115 \DeclareUnicodeCharacter{01CE}{\v{a}}
8116 \DeclareUnicodeCharacter{01CF}{\v{I}}
8118 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8119 \DeclareUnicodeCharacter{01D1}{\v{O}}
8120 \DeclareUnicodeCharacter{01D2}{\v{o}}
8121 \DeclareUnicodeCharacter{01D3}{\v{U}}
8122 \DeclareUnicodeCharacter{01D4}{\v{u}}
8124 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8125 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8126 \DeclareUnicodeCharacter{01E6}{\v{G}}
8127 \DeclareUnicodeCharacter{01E7}{\v{g}}
8128 \DeclareUnicodeCharacter{01E8}{\v{K}}
8129 \DeclareUnicodeCharacter{01E9}{\v{k}}
8131 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8132 \DeclareUnicodeCharacter{01F1}{DZ}
8133 \DeclareUnicodeCharacter{01F2}{Dz}
8134 \DeclareUnicodeCharacter{01F3}{dz}
8135 \DeclareUnicodeCharacter{01F4}{\'G}
8136 \DeclareUnicodeCharacter{01F5}{\'g}
8137 \DeclareUnicodeCharacter{01F8}{\`N}
8138 \DeclareUnicodeCharacter{01F9}{\`n}
8139 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8140 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8141 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8142 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8144 \DeclareUnicodeCharacter{021E}{\v{H}}
8145 \DeclareUnicodeCharacter{021F}{\v{h}}
8147 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8148 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8149 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8150 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8151 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8152 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8154 \DeclareUnicodeCharacter{0232}{\=Y}
8155 \DeclareUnicodeCharacter{0233}{\=y}
8156 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8158 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8159 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8160 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8161 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8162 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8163 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8164 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8165 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8166 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8167 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8168 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8169 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8171 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8172 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8174 \DeclareUnicodeCharacter{1E20}{\=G}
8175 \DeclareUnicodeCharacter{1E21}{\=g}
8176 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8177 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8178 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8179 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8180 \DeclareUnicodeCharacter{1E26}{\"H}
8181 \DeclareUnicodeCharacter{1E27}{\"h}
8183 \DeclareUnicodeCharacter{1E30}{\'K}
8184 \DeclareUnicodeCharacter{1E31}{\'k}
8185 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8186 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8187 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8188 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8189 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8190 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8191 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8192 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8193 \DeclareUnicodeCharacter{1E3E}{\'M}
8194 \DeclareUnicodeCharacter{1E3F}{\'m}
8196 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8197 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8198 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8199 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8200 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8201 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8202 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8203 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8204 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8205 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8207 \DeclareUnicodeCharacter{1E54}{\'P}
8208 \DeclareUnicodeCharacter{1E55}{\'p}
8209 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8210 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8211 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8212 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8213 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8214 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8215 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8216 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8218 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8219 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8220 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8221 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8222 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8223 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8224 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8225 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8226 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8227 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8229 \DeclareUnicodeCharacter{1E7C}{\~V}
8230 \DeclareUnicodeCharacter{1E7D}{\~v}
8231 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8232 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8234 \DeclareUnicodeCharacter{1E80}{\`W}
8235 \DeclareUnicodeCharacter{1E81}{\`w}
8236 \DeclareUnicodeCharacter{1E82}{\'W}
8237 \DeclareUnicodeCharacter{1E83}{\'w}
8238 \DeclareUnicodeCharacter{1E84}{\"W}
8239 \DeclareUnicodeCharacter{1E85}{\"w}
8240 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8241 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8242 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8243 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8244 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8245 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8246 \DeclareUnicodeCharacter{1E8C}{\"X}
8247 \DeclareUnicodeCharacter{1E8D}{\"x}
8248 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8249 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8251 \DeclareUnicodeCharacter{1E90}{\^Z}
8252 \DeclareUnicodeCharacter{1E91}{\^z}
8253 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8254 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8255 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8256 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8257 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8258 \DeclareUnicodeCharacter{1E97}{\"t}
8259 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8260 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8262 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8263 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8265 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8266 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8267 \DeclareUnicodeCharacter{1EBC}{\~E}
8268 \DeclareUnicodeCharacter{1EBD}{\~e}
8270 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8271 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8272 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8273 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8275 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8276 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8278 \DeclareUnicodeCharacter{1EF2}{\`Y}
8279 \DeclareUnicodeCharacter{1EF3}{\`y}
8280 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8282 \DeclareUnicodeCharacter{1EF8}{\~Y}
8283 \DeclareUnicodeCharacter{1EF9}{\~y}
8285 \DeclareUnicodeCharacter{2013}{--}
8286 \DeclareUnicodeCharacter{2014}{---}
8287 \DeclareUnicodeCharacter{2022}{\bullet}
8288 \DeclareUnicodeCharacter{2026}{\dots}
8289 \DeclareUnicodeCharacter{20AC}{\euro}
8291 \DeclareUnicodeCharacter{2192}{\expansion}
8292 \DeclareUnicodeCharacter{21D2}{\result}
8294 \DeclareUnicodeCharacter{2212}{\minus}
8295 \DeclareUnicodeCharacter{2217}{\point}
8296 \DeclareUnicodeCharacter{2261}{\equiv}
8297 }% end of \utfeightchardefs
8300 % US-ASCII character definitions.
8301 \def\asciichardefs{% nothing need be done
8305 % Make non-ASCII characters printable again for compatibility with
8306 % existing Texinfo documents that may use them, even without declaring a
8307 % document encoding.
8309 \setnonasciicharscatcode \other
8312 \message{formatting,}
8314 \newdimen\defaultparindent \defaultparindent = 15pt
8316 \chapheadingskip = 15pt plus 4pt minus 2pt
8317 \secheadingskip = 12pt plus 3pt minus 2pt
8318 \subsecheadingskip = 9pt plus 2pt minus 2pt
8320 % Prevent underfull vbox error messages.
8323 % Don't be so finicky about underfull hboxes, either.
8326 % Following George Bush, just get rid of widows and orphans.
8330 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8331 % using an old version of TeX, don't do anything. We want the amount of
8332 % stretch added to depend on the line length, hence the dependence on
8333 % \hsize. We call this whenever the paper size is set.
8335 \def\setemergencystretch{%
8336 \ifx\emergencystretch\thisisundefined
8337 % Allow us to assign to \emergencystretch anyway.
8338 \def\emergencystretch{\dimen0}%
8340 \emergencystretch = .15\hsize
8344 % Parameters in order: 1) textheight; 2) textwidth;
8345 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8346 % 7) physical page height; 8) physical page width.
8348 % We also call \setleading{\textleading}, so the caller should define
8349 % \textleading. The caller should also set \parskip.
8351 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8354 \splittopskip = \topskip
8357 \advance\vsize by \topskip
8358 \outervsize = \vsize
8359 \advance\outervsize by 2\topandbottommargin
8360 \pageheight = \vsize
8363 \outerhsize = \hsize
8364 \advance\outerhsize by 0.5in
8367 \normaloffset = #4\relax
8368 \bindingoffset = #5\relax
8371 \pdfpageheight #7\relax
8372 \pdfpagewidth #8\relax
8373 % if we don't reset these, they will remain at "1 true in" of
8374 % whatever layout pdftex was dumped with.
8375 \pdfhorigin = 1 true in
8376 \pdfvorigin = 1 true in
8379 \setleading{\textleading}
8381 \parindent = \defaultparindent
8382 \setemergencystretch
8385 % @letterpaper (the default).
8386 \def\letterpaper{{\globaldefs = 1
8387 \parskip = 3pt plus 2pt minus 1pt
8388 \textleading = 13.2pt
8390 % If page is nothing but text, make it come out even.
8391 \internalpagesizes{46\baselineskip}{6in}%
8393 {\bindingoffset}{36pt}%
8397 % Use @smallbook to reset parameters for 7x9.25 trim size.
8398 \def\smallbook{{\globaldefs = 1
8399 \parskip = 2pt plus 1pt
8402 \internalpagesizes{7.5in}{5in}%
8404 {\bindingoffset}{16pt}%
8407 \lispnarrowing = 0.3in
8410 \contentsrightmargin = 0pt
8411 \defbodyindent = .5cm
8414 % Use @smallerbook to reset parameters for 6x9 trim size.
8415 % (Just testing, parameters still in flux.)
8416 \def\smallerbook{{\globaldefs = 1
8417 \parskip = 1.5pt plus 1pt
8420 \internalpagesizes{7.4in}{4.8in}%
8425 \lispnarrowing = 0.25in
8428 \contentsrightmargin = 0pt
8429 \defbodyindent = .4cm
8432 % Use @afourpaper to print on European A4 paper.
8433 \def\afourpaper{{\globaldefs = 1
8434 \parskip = 3pt plus 2pt minus 1pt
8435 \textleading = 13.2pt
8437 % Double-side printing via postscript on Laserjet 4050
8438 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8439 % To change the settings for a different printer or situation, adjust
8440 % \normaloffset until the front-side and back-side texts align. Then
8441 % do the same for \bindingoffset. You can set these for testing in
8442 % your texinfo source file like this:
8444 % \global\normaloffset = -6mm
8445 % \global\bindingoffset = 10mm
8447 \internalpagesizes{51\baselineskip}{160mm}
8448 {\voffset}{\hoffset}%
8449 {\bindingoffset}{44pt}%
8454 \contentsrightmargin = 0pt
8455 \defbodyindent = 5mm
8458 % Use @afivepaper to print on European A5 paper.
8459 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8460 % He also recommends making @example and @lisp be small.
8461 \def\afivepaper{{\globaldefs = 1
8462 \parskip = 2pt plus 1pt minus 0.1pt
8463 \textleading = 12.5pt
8465 \internalpagesizes{160mm}{120mm}%
8466 {\voffset}{\hoffset}%
8467 {\bindingoffset}{8pt}%
8470 \lispnarrowing = 0.2in
8473 \contentsrightmargin = 0pt
8474 \defbodyindent = 2mm
8478 % A specific text layout, 24x15cm overall, intended for A4 paper.
8479 \def\afourlatex{{\globaldefs = 1
8481 \internalpagesizes{237mm}{150mm}%
8483 {\bindingoffset}{7mm}%
8486 % Must explicitly reset to 0 because we call \afourpaper.
8490 % Use @afourwide to print on A4 paper in landscape format.
8491 \def\afourwide{{\globaldefs = 1
8493 \internalpagesizes{241mm}{165mm}%
8494 {\voffset}{-2.95mm}%
8495 {\bindingoffset}{7mm}%
8500 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8501 % Perhaps we should allow setting the margins, \topskip, \parskip,
8502 % and/or leading, also. Or perhaps we should compute them somehow.
8504 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8505 \def\pagesizesyyy#1,#2,#3\finish{{%
8506 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8509 \parskip = 3pt plus 2pt minus 1pt
8510 \setleading{\textleading}%
8513 \advance\dimen0 by \voffset
8516 \advance\dimen2 by \normaloffset
8518 \internalpagesizes{#1}{\hsize}%
8519 {\voffset}{\normaloffset}%
8520 {\bindingoffset}{44pt}%
8524 % Set default to letter.
8529 \message{and turning on texinfo input format.}
8531 % Define macros to output various characters with catcode for normal text.
8541 \def\normaldoublequote{"}
8544 \def\normalunderscore{_}
8545 \def\normalverticalbar{|}
8547 \def\normalgreater{>}
8549 \def\normaldollar{$}%$ font-lock fix
8551 % This macro is used to make a character print one way in \tt
8552 % (where it can probably be output as-is), and another way in other fonts,
8553 % where something hairier probably needs to be done.
8555 % #1 is what to print if we are indeed using \tt; #2 is what to print
8556 % otherwise. Since all the Computer Modern typewriter fonts have zero
8557 % interword stretch (and shrink), and it is reasonable to expect all
8558 % typewriter fonts to have this, we can check that font parameter.
8560 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8562 % Same as above, but check for italic font. Actually this also catches
8563 % non-italic slanted fonts since it is impossible to distinguish them from
8564 % italic fonts. But since this is only used by $ and it uses \sl anyway
8565 % this is not a problem.
8566 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8568 % Turn off all special characters except @
8569 % (and those which the user can use as if they were ordinary).
8570 % Most of these we simply print from the \tt font, but for some, we can
8571 % use math or other variants that look better in normal text.
8574 \def\activedoublequote{{\tt\char34}}
8575 \let"=\activedoublequote
8577 \def~{{\tt\char126}}
8583 \def_{\ifusingtt\normalunderscore\_}
8585 % Subroutine for the previous macro.
8586 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8589 \def|{{\tt\char124}}
8597 \def+{{\tt \char 43}}
8599 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8601 % If a .fmt file is being used, characters that might appear in a file
8602 % name cannot be active until we have parsed the command line.
8603 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8604 % \otherifyactive is called near the end of this file.
8605 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8607 % Used sometimes to turn off (effectively) the active characters even after
8609 \def\turnoffactive{%
8610 \normalturnoffactive
8616 % \backslashcurfont outputs one backslash character in current font,
8618 \global\chardef\backslashcurfont=`\\
8619 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8621 % \realbackslash is an actual character `\' with catcode other, and
8622 % \doublebackslash is two of them (for the pdf outlines).
8623 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8625 % In texinfo, backslash is an active character; it prints the backslash
8626 % in fixed width font.
8628 @def@normalbackslash{{@tt@backslashcurfont}}
8629 % On startup, @fixbackslash assigns:
8630 % @let \ = @normalbackslash
8632 % \rawbackslash defines an active \ to do \backslashcurfont.
8633 % \otherbackslash defines an active \ to be a literal `\' character with
8635 @gdef@rawbackslash{@let\=@backslashcurfont}
8636 @gdef@otherbackslash{@let\=@realbackslash}
8638 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8639 % the literal character `\'.
8641 @def@normalturnoffactive{%
8642 @let\=@normalbackslash
8643 @let"=@normaldoublequote
8646 @let_=@normalunderscore
8647 @let|=@normalverticalbar
8649 @let>=@normalgreater
8651 @let$=@normaldollar %$ font-lock fix
8655 % Make _ and + \other characters, temporarily.
8656 % This is canceled by @fixbackslash.
8659 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8660 % That is what \eatinput is for; after that, the `\' should revert to printing
8663 @gdef@eatinput input texinfo{@fixbackslash}
8664 @global@let\ = @eatinput
8666 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8667 % the first `\' in the file would cause an error. This macro tries to fix
8668 % that, assuming it is called before the first `\' could plausibly occur.
8669 % Also turn back on active characters that might appear in the input
8670 % file name, in case not using a pre-dumped format.
8672 @gdef@fixbackslash{%
8673 @ifx\@eatinput @let\ = @normalbackslash @fi
8678 % Say @foo, not \foo, in error messages.
8681 % These look ok in all fonts, so just make them not special.
8682 @catcode`@& = @other
8683 @catcode`@# = @other
8684 @catcode`@% = @other
8688 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8689 @c page-delimiter: "^\\\\message"
8690 @c time-stamp-start: "def\\\\texinfoversion{"
8691 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8692 @c time-stamp-end: "}"
8698 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115