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{2008-02-28.18}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008 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
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % Since the category of space is not known, we have to be careful.
156 \chardef\spacecat = 10
157 \def\spaceisspace{\catcode`\ =\spacecat}
159 % sometimes characters are active, so we need control sequences.
160 \chardef\colonChar = `\:
161 \chardef\commaChar = `\,
162 \chardef\dashChar = `\-
163 \chardef\dotChar = `\.
164 \chardef\exclamChar= `\!
165 \chardef\lquoteChar= `\`
166 \chardef\questChar = `\?
167 \chardef\rquoteChar= `\'
168 \chardef\semiChar = `\;
169 \chardef\underChar = `\_
175 % The following is used inside several \edef's.
176 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
180 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
181 ap-pen-dix bit-map bit-maps
182 data-base data-bases eshell fall-ing half-way long-est man-u-script
183 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
184 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 stand-alone strong-est time-stamp time-stamps which-ever white-space
187 wide-spread wrap-around
190 % Margin to add to right of even pages, to left of odd pages.
191 \newdimen\bindingoffset
192 \newdimen\normaloffset
193 \newdimen\pagewidth \newdimen\pageheight
195 % For a final copy, take out the rectangles
196 % that mark overfull boxes (in case you have decided
197 % that the text looks ok even though it passes the margin).
199 \def\finalout{\overfullrule=0pt}
201 % @| inserts a changebar to the left of the current line. It should
202 % surround any changed text. This approach does *not* work if the
203 % change spans more than two lines of output. To handle that, we would
204 % have adopt a much more difficult approach (putting marks into the main
205 % vertical list for the beginning and end of each change).
208 % \vadjust can only be used in horizontal mode.
211 % Append this vertical mode material after the current line in the output.
213 % We want to insert a rule with the height and depth of the current
214 % leading; that is exactly what \strutbox is supposed to record.
217 % \vadjust-items are inserted at the left edge of the type. So
218 % the \llap here moves out into the left-hand margin.
221 % For a thicker or thinner bar, change the `1pt'.
222 \vrule height\baselineskip width1pt
224 % This is the space between the bar and the text.
230 % Sometimes it is convenient to have everything in the transcript file
231 % and nothing on the terminal. We don't just call \tracingall here,
232 % since that produces some useless output on the terminal. We also make
233 % some effort to order the tracing commands to reduce output in the log
234 % file; cf. trace.sty in LaTeX.
236 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
240 \tracinglostchars2 % 2 gives us more in etex
245 \showboxbreadth\maxdimen \showboxdepth\maxdimen
246 \ifx\eTeXversion\undefined\else % etex gives us more logging
253 \tracingcommands3 % 3 gives us more in etex
257 % add check for \lastpenalty to plain's definitions. If the last thing
258 % we did was a \nobreak, we don't want to insert more space.
260 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
261 \removelastskip\penalty-50\smallskip\fi\fi}
262 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
263 \removelastskip\penalty-100\medskip\fi\fi}
264 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
265 \removelastskip\penalty-200\bigskip\fi\fi}
267 % For @cropmarks command.
268 % Do @cropmarks to get crop marks.
271 \let\cropmarks = \cropmarkstrue
273 % Dimensions to add cropmarks at corners.
274 % Added by P. A. MacKay, 12 Nov. 1986
276 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
277 \newdimen\cornerlong \cornerlong=1pc
278 \newdimen\cornerthick \cornerthick=.3pt
279 \newdimen\topandbottommargin \topandbottommargin=.75in
281 % Output a mark which sets \thischapter, \thissection and \thiscolor.
282 % We dump everything together because we only have one kind of mark.
283 % This works because we only use \botmark / \topmark, not \firstmark.
285 % A mark contains a subexpression of the \ifcase ... \fi construct.
286 % \get*marks macros below extract the needed part using \ifcase.
288 % Another complication is to let the user choose whether \thischapter
289 % (\thissection) refers to the chapter (section) in effect at the top
290 % of a page, or that at the bottom of a page. The solution is
291 % described on page 260 of The TeXbook. It involves outputting two
292 % marks for the sectioning macros, one before the section break, and
293 % one after. I won't pretend I can describe this better than DEK...
295 \toks0=\expandafter{\lastchapterdefs}%
296 \toks2=\expandafter{\lastsectiondefs}%
297 \toks4=\expandafter{\prevchapterdefs}%
298 \toks6=\expandafter{\prevsectiondefs}%
299 \toks8=\expandafter{\lastcolordefs}%
301 \the\toks0 \the\toks2
302 \noexpand\or \the\toks4 \the\toks6
303 \noexpand\else \the\toks8
306 % \topmark doesn't work for the very first chapter (after the title
307 % page or the contents), so we use \firstmark there -- this gets us
308 % the mark with the chapter defs, unless the user sneaks in, e.g.,
309 % @setcolor (or @url, or @link, etc.) between @contents and the very
311 \def\gettopheadingmarks{%
313 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
315 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
316 \def\getcolormarks{\ifcase2\topmark\fi}
318 % Avoid "undefined control sequence" errors.
319 \def\lastchapterdefs{}
320 \def\lastsectiondefs{}
321 \def\prevchapterdefs{}
322 \def\prevsectiondefs{}
325 % Main output routine.
327 \output = {\onepageout{\pagecontents\PAGE}}
332 % \onepageout takes a vbox as an argument. Note that \pagecontents
333 % does insertions, but you have to call it yourself.
335 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
337 \ifodd\pageno \advance\hoffset by \bindingoffset
338 \else \advance\hoffset by -\bindingoffset\fi
340 % Do this outside of the \shipout so @code etc. will be expanded in
341 % the headline as they should be, not taken literally (outputting ''code).
342 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
343 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
344 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
345 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
348 % Have to do this stuff outside the \shipout because we want it to
349 % take effect in \write's, yet the group defined by the \vbox ends
350 % before the \shipout runs.
352 \indexdummies % don't expand commands in the output.
353 \normalturnoffactive % \ in index entries must not stay \, e.g., if
354 % the page break happens to be in the middle of an example.
355 % We don't want .vr (or whatever) entries like this:
356 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
357 % "\acronym" won't work when it's read back in;
359 % {\code {{\tt \backslashcurfont }acronym}
361 % Do this early so pdf references go to the beginning of the page.
362 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
364 \ifcropmarks \vbox to \outervsize\bgroup
366 \vskip-\topandbottommargin
368 \line{\ewtop\hfil\ewtop}%
371 \vbox{\moveleft\cornerthick\nstop}%
373 \vbox{\moveright\cornerthick\nstop}%
376 \vskip\topandbottommargin
378 \hfil % center the page within the outer (page) hsize.
379 \ifodd\pageno\hskip\bindingoffset\fi
385 \ifdim\ht\footlinebox > 0pt
386 % Only leave this space if the footline is nonempty.
387 % (We lessened \vsize for it in \oddfootingyyy.)
388 % The \baselineskip=24pt in plain's \makefootline has no effect.
394 \egroup % end of \vbox\bgroup
395 \hfil\egroup % end of (centering) \line\bgroup
396 \vskip\topandbottommargin plus1fill minus1fill
397 \boxmaxdepth = \cornerthick
400 \vbox{\moveleft\cornerthick\nsbot}%
402 \vbox{\moveright\cornerthick\nsbot}%
405 \line{\ewbot\hfil\ewbot}%
407 \egroup % \vbox from first cropmarks clause
409 }% end of \shipout\vbox
410 }% end of group with \indexdummies
412 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
415 \newinsert\margin \dimen\margin=\maxdimen
417 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
419 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
420 % marginal hacks, juha@viisa.uucp (Juha Takala)
421 \ifvoid\margin\else % marginal info is present
422 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
423 \dimen@=\dp#1\relax \unvbox#1\relax
424 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
425 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
428 % Here are the rules for the cropmarks. Note that they are
429 % offset so that the space between them is truly \outerhsize or \outervsize
430 % (P. A. MacKay, 12 November, 1986)
432 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
434 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
435 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
437 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
439 % Parse an argument, then pass it to #1. The argument is the rest of
440 % the input line (except we remove a trailing comment). #1 should be a
441 % macro which expects an ordinary undelimited TeX argument.
443 \def\parsearg{\parseargusing{}}
444 \def\parseargusing#1#2{%
450 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
454 \gdef\parseargline#1^^M{%
455 \endgroup % End of the group started in \parsearg.
456 \argremovecomment #1\comment\ArgTerm%
460 % First remove any @comment, then any @c comment.
461 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
462 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
464 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
466 % \argremovec might leave us with trailing space, e.g.,
467 % @end itemize @c foo
468 % This space token undergoes the same procedure and is eventually removed
469 % by \finishparsearg.
471 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
472 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
473 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
476 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
477 \let\temp\finishparsearg
479 \let\temp\argcheckspaces
481 % Put the space token in:
485 % If a _delimited_ argument is enclosed in braces, they get stripped; so
486 % to get _exactly_ the rest of the line, we had to prevent such situation.
487 % We prepended an \empty token at the very beginning and we expand it now,
488 % just before passing the control to \argtorun.
489 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
490 % either the null string, or it ends with \^^M---thus there is no danger
491 % that a pair of braces would be stripped.
493 % But first, we have to remove the trailing space token.
495 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
497 % \parseargdef\foo{...}
498 % is roughly equivalent to
499 % \def\foo{\parsearg\Xfoo}
502 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
503 % favourite TeX trick. --kasal, 16nov03
506 \expandafter \doparseargdef \csname\string#1\endcsname #1%
508 \def\doparseargdef#1#2{%
513 % Several utility definitions with active space:
518 % Make each space character in the input produce a normal interword
519 % space in the output. Don't allow a line break at this space, as this
520 % is used only in environments like @example, where each line of input
521 % should produce a line of output anyway.
523 \gdef\sepspaces{\obeyspaces\let =\tie}
525 % If an index command is used in an @example environment, any spaces
526 % therein should become regular spaces in the raw index file, not the
527 % expansion of \tie (\leavevmode \penalty \@M \ ).
528 \gdef\unsepspaces{\let =\space}
532 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
534 % Define the framework for environments in texinfo.tex. It's used like this:
539 % It's the responsibility of \envdef to insert \begingroup before the
540 % actual body; @end closes the group after calling \Efoo. \envdef also
541 % defines \thisenv, so the current environment is known; @end checks
542 % whether the environment name matches. The \checkenv macro can also be
543 % used to check whether the current environment is the one expected.
545 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
546 % are not treated as enviroments; they don't open a group. (The
547 % implementation of @end takes care not to call \endgroup in this
551 % At runtime, environments start with this:
552 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
556 % ... but they get defined via ``\envdef\foo{...}'':
557 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
558 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
560 % Check whether we're in the right environment:
569 % Evironment mismatch, #1 expected:
572 \errmessage{This command can appear only \inenvironment\temp,
573 not \inenvironment\thisenv}%
575 \def\inenvironment#1{%
577 out of any environment%
579 in environment \expandafter\string#1%
583 % @end foo executes the definition of \Efoo.
584 % But first, it executes a specialized version of \checkenv
587 \if 1\csname iscond.#1\endcsname
589 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
590 \expandafter\checkenv\csname#1\endcsname
591 \csname E#1\endcsname
596 \newhelp\EMsimple{Press RETURN to continue.}
599 %% Simple single-character @ commands
602 % Kludge this until the fonts are right (grr).
605 % This is turned off because it was never documented
606 % and you can use @w{...} around a quote to suppress ligatures.
607 %% Define @` and @' to be the same as ` and '
608 %% but suppressing ligatures.
612 % Used to generate quoted braces.
613 \def\mylbrace {{\tt\char123}}
614 \def\myrbrace {{\tt\char125}}
618 % Definitions to produce \{ and \} commands for indices,
619 % and @{ and @} for the aux/toc files.
620 \catcode`\{ = \other \catcode`\} = \other
621 \catcode`\[ = 1 \catcode`\] = 2
622 \catcode`\! = 0 \catcode`\\ = \other
625 !gdef!lbraceatcmd[@{]%
626 !gdef!rbraceatcmd[@}]%
629 % @comma{} to avoid , parsing problems.
632 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
633 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
636 \def\ringaccent#1{{\accent23 #1}}
641 % Other special characters: @questiondown @exclamdown @ordf @ordm
642 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
643 \def\questiondown{?`}
645 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
646 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
648 % Dotless i and dotless j, used for accents.
653 \ifx\temp\imacro \ptexi
654 \else\ifx\temp\jmacro \j
655 \else \errmessage{@dotless can be used only with i or j}%
659 % The \TeX{} logo, as in plain, but resetting the spacing so that a
660 % period following counts as ending a sentence. (Idea found in latex.)
662 \edef\TeX{\TeX \spacefactor=1000 }
664 % @LaTeX{} logo. Not quite the same results as the definition in
665 % latex.ltx, since we use a different font for the raised A; it's most
666 % convenient for us to use an explicitly smaller font, rather than using
667 % the \scriptstyle font (since we don't reset \scriptstyle and
668 % \scriptscriptstyle).
673 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
678 % Be sure we're in horizontal mode when doing a tie, since we make space
679 % equivalent to this in @example-like environments. Otherwise, a space
680 % at the beginning of a line will start with \penalty -- and
681 % since \penalty is valid in vertical mode, we'd end up putting the
682 % penalty on the vertical list instead of in the new paragraph.
684 % Avoid using \@M directly, because that causes trouble
685 % if the definition is written into an index file.
686 \global\let\tiepenalty = \@M
687 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
690 % @: forces normal size whitespace following.
691 \def\:{\spacefactor=1000 }
693 % @* forces a line break.
694 \def\*{\hfil\break\hbox{}\ignorespaces}
696 % @/ allows a line break.
699 % @. is an end-of-sentence period.
700 \def\.{.\spacefactor=\endofsentencespacefactor\space}
702 % @! is an end-of-sentence bang.
703 \def\!{!\spacefactor=\endofsentencespacefactor\space}
705 % @? is an end-of-sentence query.
706 \def\?{?\spacefactor=\endofsentencespacefactor\space}
708 % @frenchspacing on|off says whether to put extra space after punctuation.
713 \parseargdef\frenchspacing{%
715 \ifx\temp\onword \plainfrenchspacing
716 \else\ifx\temp\offword \plainnonfrenchspacing
719 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
723 % @w prevents a word break. Without the \leavevmode, @w at the
724 % beginning of a paragraph, when TeX is still in vertical mode, would
725 % produce a whole line of output instead of starting the paragraph.
726 \def\w#1{\leavevmode\hbox{#1}}
728 % @group ... @end group forces ... to be all on one page, by enclosing
729 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
730 % to keep its height that of a normal line. According to the rules for
731 % \topskip (p.114 of the TeXbook), the glue inserted is
732 % max (\topskip - \ht (first item), 0). If that height is large,
733 % therefore, no glue is inserted, and the space between the headline and
734 % the text is small, which looks bad.
736 % Another complication is that the group might be very large. This can
737 % cause the glue on the previous page to be unduly stretched, because it
738 % does not have much material. In this case, it's better to add an
739 % explicit \vfill so that the extra space is at the bottom. The
740 % threshold for doing this is if the group is more than \vfilllimit
741 % percent of a page (\vfilllimit can be changed inside of @tex).
747 \ifnum\catcode`\^^M=\active \else
748 \errhelp = \groupinvalidhelp
749 \errmessage{@group invalid in context where filling is enabled}%
753 \setbox\groupbox = \vtop\bgroup
754 % Do @comment since we are called inside an environment such as
755 % @example, where each end-of-line in the input causes an
756 % end-of-line in the output. We don't want the end-of-line after
757 % the `@group' to put extra space in the output. Since @group
758 % should appear on a line by itself (according to the Texinfo
759 % manual), we don't worry about eating any user text.
763 % The \vtop produces a box with normal height and large depth; thus, TeX puts
764 % \baselineskip glue before it, and (when the next line of text is done)
765 % \lineskip glue after it. Thus, space below is not quite equal to space
766 % above. But it's pretty close.
768 % To get correct interline space between the last line of the group
769 % and the first line afterwards, we have to propagate \prevdepth.
770 \endgraf % Not \par, as it may have been set to \lisppar.
771 \global\dimen1 = \prevdepth
772 \egroup % End the \vtop.
773 % \dimen0 is the vertical size of the group's box.
774 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
775 % \dimen2 is how much space is left on the page (more or less).
776 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
777 % if the group doesn't fit on the current page, and it's a big big
778 % group, force a page break.
779 \ifdim \dimen0 > \dimen2
780 \ifdim \pagetotal < \vfilllimit\pageheight
789 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
790 % message, so this ends up printing `@group can only ...'.
792 \newhelp\groupinvalidhelp{%
793 group can only be used in environments such as @example,^^J%
794 where each line of input produces a line of output.}
796 % @need space-in-mils
797 % forces a page break if there is not space-in-mils remaining.
799 \newdimen\mil \mil=0.001in
801 % Old definition--didn't work.
802 %\parseargdef\need{\par %
803 %% This method tries to make TeX break the page naturally
804 %% if the depth of the box does not fit.
806 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
811 % Ensure vertical mode, so we don't make a big box in the middle of a
815 % If the @need value is less than one line space, it's useless.
817 \dimen2 = \ht\strutbox
818 \advance\dimen2 by \dp\strutbox
819 \ifdim\dimen0 > \dimen2
821 % Do a \strut just to make the height of this box be normal, so the
822 % normal leading is inserted relative to the preceding line.
823 % And a page break here is fine.
824 \vtop to #1\mil{\strut\vfil}%
826 % TeX does not even consider page breaks if a penalty added to the
827 % main vertical list is 10000 or more. But in order to see if the
828 % empty box we just added fits on the page, we must make it consider
829 % page breaks. On the other hand, we don't want to actually break the
830 % page after the empty box. So we use a penalty of 9999.
832 % There is an extremely small chance that TeX will actually break the
833 % page at this \penalty, if there are no other feasible breakpoints in
834 % sight. (If the user is using lots of big @group commands, which
835 % almost-but-not-quite fill up a page, TeX will have a hard time doing
836 % good page breaking, for example.) However, I could not construct an
837 % example where a page broke at this \penalty; if it happens in a real
838 % document, then we can reconsider our strategy.
841 % Back up by the size of the box, whether we did a page break or not.
844 % Do not allow a page break right after this kern.
849 % @br forces paragraph break (and is undocumented).
853 % @page forces the start of a new page.
855 \def\page{\par\vfill\supereject}
858 % outputs text on separate line in roman font, starting at standard page margin
860 % This records the amount of indent in the innermost environment.
861 % That's how much \exdent should take out.
862 \newskip\exdentamount
864 % This defn is used inside fill environments such as @defun.
865 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
867 % This defn is used inside nofill environments such as @example.
868 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
869 \leftline{\hskip\leftskip{\rm#1}}}}
871 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
872 % paragraph. For more general purposes, use the \margin insertion
873 % class. WHICH is `l' or `r'.
875 \newskip\inmarginspacing \inmarginspacing=1cm
876 \def\strutdepth{\dp\strutbox}
878 \def\doinmargin#1#2{\strut\vadjust{%
881 \vtop to \strutdepth{%
882 \baselineskip=\strutdepth
884 % if you have multiple lines of stuff to put here, you'll need to
885 % make the vbox yourself of the appropriate size.
887 \llap{\ignorespaces #2\hskip\inmarginspacing}%
889 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
894 \def\inleftmargin{\doinmargin l}
895 \def\inrightmargin{\doinmargin r}
897 % @inmargin{TEXT [, RIGHT-TEXT]}
898 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
899 % else use TEXT for both).
901 \def\inmargin#1{\parseinmargin #1,,\finish}
902 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
903 \setbox0 = \hbox{\ignorespaces #2}%
905 \def\lefttext{#1}% have both texts
908 \def\lefttext{#1}% have only one text
913 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
915 \def\temp{\inleftmargin\lefttext}%
920 % @include FILE -- \input text of FILE.
922 \def\include{\parseargusing\filenamecatcodes\includezzz}
927 \makevalueexpandable % we want to expand any @value in FILE.
928 \edef\temp{\noexpand\input #1 }%
930 % This trickery is to read FILE outside of a group, in case it makes
936 \def\filenamecatcodes{%
948 \def\pushthisfilestack{%
949 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
951 \def\pushthisfilestackX{%
952 \expandafter\pushthisfilestackY\thisfile\StackTerm
954 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
955 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
958 \def\popthisfilestack{\errthisfilestackempty}
959 \def\errthisfilestackempty{\errmessage{Internal error:
960 the stack of filenames is empty.}}
965 % outputs that line, centered.
967 \parseargdef\center{%
973 \next{\hfil \ignorespaces#1\unskip \hfil}%
978 \advance\hsize by -\leftskip
979 \advance\hsize by -\rightskip
984 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
986 % @sp n outputs n lines of vertical space
988 \parseargdef\sp{\vskip #1\baselineskip}
990 % @comment ...line which is ignored...
991 % @c is the same as @comment
992 % @ignore ... @end ignore is another way to write a comment
994 \def\comment{\begingroup \catcode`\^^M=\other%
995 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
997 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1001 % @paragraphindent NCHARS
1002 % We'll use ems for NCHARS, close enough.
1003 % NCHARS can also be the word `asis' or `none'.
1004 % We cannot feasibly implement @paragraphindent asis, though.
1006 \def\asisword{asis} % no translation, these are keywords
1009 \parseargdef\paragraphindent{%
1014 \defaultparindent = 0pt
1016 \defaultparindent = #1em
1019 \parindent = \defaultparindent
1022 % @exampleindent NCHARS
1023 % We'll use ems for NCHARS like @paragraphindent.
1024 % It seems @exampleindent asis isn't necessary, but
1025 % I preserve it to make it similar to @paragraphindent.
1026 \parseargdef\exampleindent{%
1031 \lispnarrowing = 0pt
1033 \lispnarrowing = #1em
1038 % @firstparagraphindent WORD
1039 % If WORD is `none', then suppress indentation of the first paragraph
1040 % after a section heading. If WORD is `insert', then do indent at such
1043 % The paragraph indentation is suppressed or not by calling
1044 % \suppressfirstparagraphindent, which the sectioning commands do.
1045 % We switch the definition of this back and forth according to WORD.
1046 % By default, we suppress indentation.
1048 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1049 \def\insertword{insert}
1051 \parseargdef\firstparagraphindent{%
1054 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1055 \else\ifx\temp\insertword
1056 \let\suppressfirstparagraphindent = \relax
1058 \errhelp = \EMsimple
1059 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1063 % Here is how we actually suppress indentation. Redefine \everypar to
1064 % \kern backwards by \parindent, and then reset itself to empty.
1066 % We also make \indent itself not actually do anything until the next
1069 \gdef\dosuppressfirstparagraphindent{%
1071 \restorefirstparagraphindent
1075 \restorefirstparagraphindent
1078 \global\everypar = {%
1080 \restorefirstparagraphindent
1084 \gdef\restorefirstparagraphindent{%
1085 \global \let \indent = \ptexindent
1086 \global \let \noindent = \ptexnoindent
1087 \global \everypar = {}%
1091 % @asis just yields its argument. Used with @table, for example.
1095 % @math outputs its argument in math mode.
1097 % One complication: _ usually means subscripts, but it could also mean
1098 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1099 % _ active, and distinguish by seeing if the current family is \slfam,
1100 % which is what @var uses.
1102 \catcode`\_ = \active
1103 \gdef\mathunderscore{%
1105 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1108 % Another complication: we want \\ (and @\) to output a \ character.
1109 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1110 % this is not advertised and we don't care. Texinfo does not
1111 % otherwise define @\.
1113 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1114 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1119 \let\\ = \mathbackslash
1123 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1125 % Some active characters (such as <) are spaced differently in math.
1126 % We have to reset their definitions in case the @math was an argument
1127 % to a command which sets the catcodes (such as @item or @section).
1130 \catcode`^ = \active
1131 \catcode`< = \active
1132 \catcode`> = \active
1133 \catcode`+ = \active
1142 % @bullet and @minus need the same treatment as @math, just above.
1143 \def\bullet{$\ptexbullet$}
1146 % @dots{} outputs an ellipsis using the current font.
1147 % We do .5em per period so that it has the same spacing in the cm
1148 % typewriter fonts as three actual period characters; on the other hand,
1149 % in other typewriter fonts three periods are wider than 1.5em. So do
1150 % whichever is larger.
1154 \setbox0=\hbox{...}% get width of three periods
1161 \hskip 0pt plus.25fil
1162 .\hskip 0pt plus1fil
1163 .\hskip 0pt plus1fil
1164 .\hskip 0pt plus.5fil
1168 % @enddots{} is an end-of-sentence ellipsis.
1172 \spacefactor=\endofsentencespacefactor
1175 % @comma{} is so commas can be inserted into text without messing up
1176 % Texinfo's parsing.
1180 % @refill is a no-op.
1183 % If working on a large document in chapters, it is convenient to
1184 % be able to disable indexing, cross-referencing, and contents, for test runs.
1185 % This is done with @novalidate (before @setfilename).
1187 \newif\iflinks \linkstrue % by default we want the aux files.
1188 \let\novalidate = \linksfalse
1190 % @setfilename is done at the beginning of every texinfo file.
1191 % So open here the files we need to have open while reading the input.
1192 % This makes it possible to make a .fmt file for texinfo.
1194 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1197 % Open the new aux file. TeX will close it automatically at exit.
1198 \immediate\openout\auxfile=\jobname.aux
1199 \fi % \openindices needs to do some work in any case.
1201 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1203 % If texinfo.cnf is present on the system, read it.
1204 % Useful for site-wide @afourpaper, etc.
1205 \openin 1 texinfo.cnf
1206 \ifeof 1 \else \input texinfo.cnf \fi
1209 \comment % Ignore the actual filename.
1212 % Called from \setfilename.
1224 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1228 % adobe `portable' document format
1232 \newcount\filenamelength
1241 \newif\ifpdfmakepagedest
1243 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1244 % can be set). So we test for \relax and 0 as well as \undefined,
1245 % borrowed from ifpdf.sty.
1246 \ifx\pdfoutput\undefined
1248 \ifx\pdfoutput\relax
1257 % PDF uses PostScript string constants for the names of xref targets,
1258 % for display in the outlines, and in other places. Thus, we have to
1259 % double any backslashes. Otherwise, a name like "\node" will be
1260 % interpreted as a newline (\n), followed by o, d, e. Not good.
1261 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1262 % (and related messages, the final outcome is that it is up to the TeX
1263 % user to double the backslashes and otherwise make the string valid, so
1264 % that's what we do).
1266 % double active backslashes.
1268 {\catcode`\@=0 \catcode`\\=\active
1269 @gdef@activebackslashdouble{%
1271 @let\=@doublebackslash}
1274 % To handle parens, we must adopt a different approach, since parens are
1275 % not active characters. hyperref.dtx (which has the same problem as
1276 % us) handles it with this amazing macro to replace tokens, with minor
1277 % changes for Texinfo. It is included here under the GPL by permission
1278 % from the author, Heiko Oberdiek.
1280 % #1 is the tokens to replace.
1281 % #2 is the replacement.
1282 % #3 is the control sequence with the string.
1284 \def\HyPsdSubst#1#2#3{%
1285 \def\HyPsdReplace##1#1##2\END{%
1291 \HyPsdReplace##2\END
1295 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1297 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1299 % #1 is a control sequence in which to do the replacements.
1300 \def\backslashparens#1{%
1301 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1302 % \lastnode when called from \setref -> \pdfmkdest.
1303 \HyPsdSubst{(}{\realbackslash(}{#1}%
1304 \HyPsdSubst{)}{\realbackslash)}{#1}%
1307 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1308 with PDF output, and none of those formats could be found. (.eps cannot
1309 be supported due to the design of the PDF format; use regular TeX (DVI
1314 % Color manipulation macros based on pdfcolor.tex.
1315 \def\cmykDarkRed{0.28 1 1 0.35}
1316 \def\cmykBlack{0 0 0 1}
1318 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1319 % Set color, and create a mark which defines \thiscolor accordingly,
1320 % so that \makeheadline knows which color to restore.
1322 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1327 \def\maincolor{\cmykBlack}
1328 \pdfsetcolor{\maincolor}
1329 \edef\thiscolor{\maincolor}
1330 \def\lastcolordefs{}
1334 \line{\pdfsetcolor{\maincolor}\the\footline}%
1342 % Extract \thiscolor definition from the marks.
1344 % Typeset the headline with \maincolor, then restore the color.
1345 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1353 \pdfcatalog{/PageMode /UseOutlines}
1355 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1356 \def\dopdfimage#1#2#3{%
1357 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1358 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1360 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1361 % others). Let's try in that order.
1362 \let\pdfimgext=\empty
1364 \openin 1 #1.png \ifeof 1
1365 \openin 1 #1.jpg \ifeof 1
1366 \openin 1 #1.jpeg \ifeof 1
1367 \openin 1 #1.JPG \ifeof 1
1368 \openin 1 #1.pdf \ifeof 1
1369 \errhelp = \nopdfimagehelp
1370 \errmessage{Could not find image file #1 for pdf}%
1371 \else \gdef\pdfimgext{pdf}%
1373 \else \gdef\pdfimgext{JPG}%
1375 \else \gdef\pdfimgext{jpeg}%
1377 \else \gdef\pdfimgext{jpg}%
1379 \else \gdef\pdfimgext{png}%
1384 % without \immediate, pdftex seg faults when the same image is
1385 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1386 \ifnum\pdftexversion < 14
1389 \immediate\pdfximage
1391 \ifdim \wd0 >0pt width \imagewidth \fi
1392 \ifdim \wd2 >0pt height \imageheight \fi
1393 \ifnum\pdftexversion<13
1398 \ifnum\pdftexversion < 14 \else
1399 \pdfrefximage \pdflastximage
1403 % We have to set dummies so commands such as @code, and characters
1404 % such as \, aren't expanded when present in a section title.
1407 \activebackslashdouble
1408 \makevalueexpandable
1409 \def\pdfdestname{#1}%
1410 \backslashparens\pdfdestname
1411 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1414 % used to mark target names; must be expandable.
1417 % by default, use a color that is dark enough to print on paper as
1418 % nearly black, but still distinguishable for online viewing.
1419 \def\urlcolor{\cmykDarkRed}
1420 \def\linkcolor{\cmykDarkRed}
1421 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1423 % Adding outlines to PDF; macros for calculating structure of outlines
1424 % come from Petr Olsak
1425 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1426 \else \csname#1\endcsname \fi}
1427 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1428 \advance\tempnum by 1
1429 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1431 % #1 is the section text, which is what will be displayed in the
1432 % outline by the pdf viewer. #2 is the pdf expression for the number
1433 % of subentries (or empty, for subsubsections). #3 is the node text,
1434 % which might be empty if this toc entry had no corresponding node.
1435 % #4 is the page number
1437 \def\dopdfoutline#1#2#3#4{%
1438 % Generate a link to the node text if that exists; else, use the
1439 % page number. We could generate a destination for the section
1440 % text in the case where a section has no node, but it doesn't
1441 % seem worth the trouble, since most documents are normally structured.
1442 \def\pdfoutlinedest{#3}%
1443 \ifx\pdfoutlinedest\empty
1444 \def\pdfoutlinedest{#4}%
1446 % Doubled backslashes in the name.
1447 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1448 \backslashparens\pdfoutlinedest}%
1451 % Also double the backslashes in the display string.
1452 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1453 \backslashparens\pdfoutlinetext}%
1455 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1458 \def\pdfmakeoutlines{%
1460 % Thanh's hack / proper braces in bookmarks
1461 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1462 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1464 % Read toc silently, to get counts of subentries for \pdfoutline.
1465 \def\numchapentry##1##2##3##4{%
1466 \def\thischapnum{##2}%
1468 \def\thissubsecnum{0}%
1470 \def\numsecentry##1##2##3##4{%
1471 \advancenumber{chap\thischapnum}%
1472 \def\thissecnum{##2}%
1473 \def\thissubsecnum{0}%
1475 \def\numsubsecentry##1##2##3##4{%
1476 \advancenumber{sec\thissecnum}%
1477 \def\thissubsecnum{##2}%
1479 \def\numsubsubsecentry##1##2##3##4{%
1480 \advancenumber{subsec\thissubsecnum}%
1482 \def\thischapnum{0}%
1484 \def\thissubsecnum{0}%
1486 % use \def rather than \let here because we redefine \chapentry et
1487 % al. a second time, below.
1488 \def\appentry{\numchapentry}%
1489 \def\appsecentry{\numsecentry}%
1490 \def\appsubsecentry{\numsubsecentry}%
1491 \def\appsubsubsecentry{\numsubsubsecentry}%
1492 \def\unnchapentry{\numchapentry}%
1493 \def\unnsecentry{\numsecentry}%
1494 \def\unnsubsecentry{\numsubsecentry}%
1495 \def\unnsubsubsecentry{\numsubsubsecentry}%
1498 % Read toc second time, this time actually producing the outlines.
1499 % The `-' means take the \expnumber as the absolute number of
1500 % subentries, which we calculated on our first read of the .toc above.
1502 % We use the node names as the destinations.
1503 \def\numchapentry##1##2##3##4{%
1504 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1505 \def\numsecentry##1##2##3##4{%
1506 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1507 \def\numsubsecentry##1##2##3##4{%
1508 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1509 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1510 \dopdfoutline{##1}{}{##3}{##4}}%
1512 % PDF outlines are displayed using system fonts, instead of
1513 % document fonts. Therefore we cannot use special characters,
1514 % since the encoding is unknown. For example, the eogonek from
1515 % Latin 2 (0xea) gets translated to a | character. Info from
1516 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1518 % xx to do this right, we have to translate 8-bit characters to
1519 % their "best" equivalent, based on the @documentencoding. Right
1520 % now, I guess we'll just let the pdf reader have its way.
1523 \catcode`\\=\active \otherbackslash
1524 \input \tocreadfilename
1528 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1529 \ifx\PP\D\let\nextsp\relax
1530 \else\let\nextsp\skipspaces
1531 \ifx\p\space\else\addtokens{\filename}{\PP}%
1532 \advance\filenamelength by 1
1536 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1537 \ifnum\pdftexversion < 14
1538 \let \startlink \pdfannotlink
1540 \let \startlink \pdfstartlink
1542 % make a live url in pdf output.
1545 % it seems we really need yet another set of dummies; have not
1546 % tried to figure out what each command should do in the context
1547 % of @url. for now, just make @/ a no-op, that's the only one
1548 % people have actually reported a problem with.
1550 \normalturnoffactive
1553 \makevalueexpandable
1554 \leavevmode\setcolor{\urlcolor}%
1555 \startlink attr{/Border [0 0 0]}%
1556 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1558 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1559 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1560 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1561 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1563 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1565 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1566 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1567 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1569 \ifnum0=\countA\else\makelink\fi
1570 \ifx\first.\let\next=\done\else
1572 \addtokens{\toksB}{\the\toksD}
1573 \ifx\first,\addtokens{\toksB}{\space}\fi
1575 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1577 \def\makelink{\addtokens{\toksB}%
1578 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1580 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1581 \setcolor{\linkcolor}#1\endlink}
1582 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1584 \let\pdfmkdest = \gobble
1585 \let\pdfurl = \gobble
1586 \let\endlink = \relax
1587 \let\setcolor = \gobble
1588 \let\pdfsetcolor = \gobble
1589 \let\pdfmakeoutlines = \relax
1590 \fi % \ifx\pdfoutput
1595 % Change the current font style to #1, remembering it in \curfontstyle.
1596 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1597 % italics, not bold italics.
1599 \def\setfontstyle#1{%
1600 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1601 \csname ten#1\endcsname % change the current font
1604 % Select #1 fonts with the current style.
1606 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1608 \def\rm{\fam=0 \setfontstyle{rm}}
1609 \def\it{\fam=\itfam \setfontstyle{it}}
1610 \def\sl{\fam=\slfam \setfontstyle{sl}}
1611 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1612 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1614 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1615 % So we set up a \sf.
1617 \def\sf{\fam=\sffam \setfontstyle{sf}}
1618 \let\li = \sf % Sometimes we call it \li, not \sf.
1620 % We don't need math for this font style.
1621 \def\ttsl{\setfontstyle{ttsl}}
1625 \newdimen\textleading \textleading = 13.2pt
1627 % Set the baselineskip to #1, and the lineskip and strut size
1628 % correspondingly. There is no deep meaning behind these magic numbers
1629 % used as factors; they just match (closely enough) what Knuth defined.
1631 \def\lineskipfactor{.08333}
1632 \def\strutheightpercent{.70833}
1633 \def\strutdepthpercent {.29167}
1635 % can get a sort of poor man's double spacing by redefining this.
1636 \def\baselinefactor{1}
1640 \normalbaselineskip = \baselinefactor\dimen0
1641 \normallineskip = \lineskipfactor\normalbaselineskip
1643 \setbox\strutbox =\hbox{%
1644 \vrule width0pt height\strutheightpercent\baselineskip
1645 depth \strutdepthpercent \baselineskip
1649 % PDF CMaps. See also LaTeX's t1.cmap.
1651 % do nothing with this by default.
1652 \expandafter\let\csname cmapOT1\endcsname\gobble
1653 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1654 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1656 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1657 % (\pdffontattr was introduced many years ago, but people still run
1658 % older pdftex's; it's easy to conditionalize, so we do.)
1659 \ifpdf \ifx\pdffontattr\undefined \else
1661 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1662 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1663 %%DocumentNeededResources: ProcSet (CIDInit)
1664 %%IncludeResource: ProcSet (CIDInit)
1665 %%BeginResource: CMap (TeX-OT1-0)
1666 %%Title: (TeX-OT1-0 TeX OT1 0)
1669 /CIDInit /ProcSet findresource begin
1677 /CMapName /TeX-OT1-0 def
1679 1 begincodespacerange
1735 CMapName currentdict /CMap defineresource pop
1741 \expandafter\edef\csname cmapOT1\endcsname#1{%
1742 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1747 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1748 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1749 %%DocumentNeededResources: ProcSet (CIDInit)
1750 %%IncludeResource: ProcSet (CIDInit)
1751 %%BeginResource: CMap (TeX-OT1IT-0)
1752 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1755 /CIDInit /ProcSet findresource begin
1763 /CMapName /TeX-OT1IT-0 def
1765 1 begincodespacerange
1823 CMapName currentdict /CMap defineresource pop
1829 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1830 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1835 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1836 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1837 %%DocumentNeededResources: ProcSet (CIDInit)
1838 %%IncludeResource: ProcSet (CIDInit)
1839 %%BeginResource: CMap (TeX-OT1TT-0)
1840 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1843 /CIDInit /ProcSet findresource begin
1851 /CMapName /TeX-OT1TT-0 def
1853 1 begincodespacerange
1898 CMapName currentdict /CMap defineresource pop
1904 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1905 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1910 % Set the font macro #1 to the font named #2, adding on the
1911 % specified font prefix (normally `cm').
1912 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1913 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1915 \def\setfont#1#2#3#4#5{%
1916 \font#1=\fontprefix#2#3 scaled #4
1917 \csname cmap#5\endcsname#1%
1919 % This is what gets called when #5 of \setfont is empty.
1921 % emacs-page end of cmaps
1923 % Use cm as the default font prefix.
1924 % To specify the font prefix, you must define \fontprefix
1925 % before you read in texinfo.tex.
1926 \ifx\fontprefix\undefined
1929 % Support font families that don't use the same naming scheme as CM.
1931 \def\rmbshape{bx} %where the normal face is bold
1936 \def\ttslshape{sltt}
1946 % Definitions for a main text size of 11pt. This is the default in
1949 \def\definetextfontsizexi{%
1950 % Text fonts (11.2pt, magstep1).
1951 \def\textnominalsize{11pt}
1952 \edef\mainmagstep{\magstephalf}
1953 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1954 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1955 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1956 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1957 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1958 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1959 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1960 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1961 \font\texti=cmmi10 scaled \mainmagstep
1962 \font\textsy=cmsy10 scaled \mainmagstep
1963 \def\textecsize{1095}
1965 % A few fonts for @defun names and args.
1966 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1967 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1968 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1969 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1971 % Fonts for indices, footnotes, small examples (9pt).
1972 \def\smallnominalsize{9pt}
1973 \setfont\smallrm\rmshape{9}{1000}{OT1}
1974 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1975 \setfont\smallbf\bfshape{10}{900}{OT1}
1976 \setfont\smallit\itshape{9}{1000}{OT1IT}
1977 \setfont\smallsl\slshape{9}{1000}{OT1}
1978 \setfont\smallsf\sfshape{9}{1000}{OT1}
1979 \setfont\smallsc\scshape{10}{900}{OT1}
1980 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1983 \def\smallecsize{0900}
1985 % Fonts for small examples (8pt).
1986 \def\smallernominalsize{8pt}
1987 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1988 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1989 \setfont\smallerbf\bfshape{10}{800}{OT1}
1990 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1991 \setfont\smallersl\slshape{8}{1000}{OT1}
1992 \setfont\smallersf\sfshape{8}{1000}{OT1}
1993 \setfont\smallersc\scshape{10}{800}{OT1}
1994 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1995 \font\smalleri=cmmi8
1996 \font\smallersy=cmsy8
1997 \def\smallerecsize{0800}
1999 % Fonts for title page (20.4pt):
2000 \def\titlenominalsize{20pt}
2001 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2002 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2003 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2004 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2005 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2006 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2007 \let\titlebf=\titlerm
2008 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2009 \font\titlei=cmmi12 scaled \magstep3
2010 \font\titlesy=cmsy10 scaled \magstep4
2011 \def\authorrm{\secrm}
2012 \def\authortt{\sectt}
2013 \def\titleecsize{2074}
2015 % Chapter (and unnumbered) fonts (17.28pt).
2016 \def\chapnominalsize{17pt}
2017 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2018 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2019 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2020 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2021 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2022 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2024 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2025 \font\chapi=cmmi12 scaled \magstep2
2026 \font\chapsy=cmsy10 scaled \magstep3
2027 \def\chapecsize{1728}
2029 % Section fonts (14.4pt).
2030 \def\secnominalsize{14pt}
2031 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2032 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2033 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2034 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2035 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2036 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2038 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2039 \font\seci=cmmi12 scaled \magstep1
2040 \font\secsy=cmsy10 scaled \magstep2
2041 \def\sececsize{1440}
2043 % Subsection fonts (13.15pt).
2044 \def\ssecnominalsize{13pt}
2045 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2046 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2047 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2048 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2049 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2050 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2052 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2053 \font\sseci=cmmi12 scaled \magstephalf
2054 \font\ssecsy=cmsy10 scaled 1315
2055 \def\ssececsize{1200}
2057 % Reduced fonts for @acro in text (10pt).
2058 \def\reducednominalsize{10pt}
2059 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2060 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2061 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2062 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2063 \setfont\reducedsl\slshape{10}{1000}{OT1}
2064 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2065 \setfont\reducedsc\scshape{10}{1000}{OT1}
2066 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2067 \font\reducedi=cmmi10
2068 \font\reducedsy=cmsy10
2069 \def\reducedecsize{1000}
2071 % reset the current fonts
2074 } % end of 11pt text font size definitions
2077 % Definitions to make the main text be 10pt Computer Modern, with
2078 % section, chapter, etc., sizes following suit. This is for the GNU
2079 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2080 % future. Used with @smallbook, which sets the leading to 12pt.
2082 \def\definetextfontsizex{%
2083 % Text fonts (10pt).
2084 \def\textnominalsize{10pt}
2085 \edef\mainmagstep{1000}
2086 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2087 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2088 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2089 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2090 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2091 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2092 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2093 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2094 \font\texti=cmmi10 scaled \mainmagstep
2095 \font\textsy=cmsy10 scaled \mainmagstep
2096 \def\textecsize{1000}
2098 % A few fonts for @defun names and args.
2099 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2100 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2101 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2102 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2104 % Fonts for indices, footnotes, small examples (9pt).
2105 \def\smallnominalsize{9pt}
2106 \setfont\smallrm\rmshape{9}{1000}{OT1}
2107 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2108 \setfont\smallbf\bfshape{10}{900}{OT1}
2109 \setfont\smallit\itshape{9}{1000}{OT1IT}
2110 \setfont\smallsl\slshape{9}{1000}{OT1}
2111 \setfont\smallsf\sfshape{9}{1000}{OT1}
2112 \setfont\smallsc\scshape{10}{900}{OT1}
2113 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2116 \def\smallecsize{0900}
2118 % Fonts for small examples (8pt).
2119 \def\smallernominalsize{8pt}
2120 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2121 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2122 \setfont\smallerbf\bfshape{10}{800}{OT1}
2123 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2124 \setfont\smallersl\slshape{8}{1000}{OT1}
2125 \setfont\smallersf\sfshape{8}{1000}{OT1}
2126 \setfont\smallersc\scshape{10}{800}{OT1}
2127 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2128 \font\smalleri=cmmi8
2129 \font\smallersy=cmsy8
2130 \def\smallerecsize{0800}
2132 % Fonts for title page (20.4pt):
2133 \def\titlenominalsize{20pt}
2134 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2135 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2136 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2137 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2138 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2139 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2140 \let\titlebf=\titlerm
2141 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2142 \font\titlei=cmmi12 scaled \magstep3
2143 \font\titlesy=cmsy10 scaled \magstep4
2144 \def\authorrm{\secrm}
2145 \def\authortt{\sectt}
2146 \def\titleecsize{2074}
2148 % Chapter fonts (14.4pt).
2149 \def\chapnominalsize{14pt}
2150 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2151 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2152 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2153 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2154 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2155 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2157 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2158 \font\chapi=cmmi12 scaled \magstep1
2159 \font\chapsy=cmsy10 scaled \magstep2
2160 \def\chapecsize{1440}
2162 % Section fonts (12pt).
2163 \def\secnominalsize{12pt}
2164 \setfont\secrm\rmbshape{12}{1000}{OT1}
2165 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2166 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2167 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2168 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2169 \setfont\secsf\sfbshape{12}{1000}{OT1}
2171 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2173 \font\secsy=cmsy10 scaled \magstep1
2174 \def\sececsize{1200}
2176 % Subsection fonts (10pt).
2177 \def\ssecnominalsize{10pt}
2178 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2179 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2180 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2181 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2182 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2183 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2185 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2188 \def\ssececsize{1000}
2190 % Reduced fonts for @acro in text (9pt).
2191 \def\reducednominalsize{9pt}
2192 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2193 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2194 \setfont\reducedbf\bfshape{10}{900}{OT1}
2195 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2196 \setfont\reducedsl\slshape{9}{1000}{OT1}
2197 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2198 \setfont\reducedsc\scshape{10}{900}{OT1}
2199 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2200 \font\reducedi=cmmi9
2201 \font\reducedsy=cmsy9
2202 \def\reducedecsize{0900}
2204 % reduce space between paragraphs
2205 \divide\parskip by 2
2207 % reset the current fonts
2210 } % end of 10pt text font size definitions
2213 % We provide the user-level command
2215 % (or 11) to redefine the text font size. pt is assumed.
2220 \parseargdef\fonttextsize{%
2221 \def\textsizearg{#1}%
2222 \wlog{doing @fonttextsize \textsizearg}%
2224 % Set \globaldefs so that documents can use this inside @tex, since
2225 % makeinfo 4.8 does not support it, but we need it nonetheless.
2227 \begingroup \globaldefs=1
2228 \ifx\textsizearg\xword \definetextfontsizex
2229 \else \ifx\textsizearg\xiword \definetextfontsizexi
2232 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2238 % In order for the font changes to affect most math symbols and letters,
2239 % we have to define the \textfont of the standard families. Since
2240 % texinfo doesn't allow for producing subscripts and superscripts except
2241 % in the main text, we don't bother to reset \scriptfont and
2242 % \scriptscriptfont (which would also require loading a lot more fonts).
2244 \def\resetmathfonts{%
2245 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2246 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2247 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2250 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2251 % of just \STYLE. We do this because \STYLE needs to also set the
2252 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2253 % \tenSTYLE to set the current font.
2255 % Each font-changing command also sets the names \lsize (one size lower)
2256 % and \lllsize (three sizes lower). These relative commands are used in
2257 % the LaTeX logo and acronyms.
2259 % This all needs generalizing, badly.
2262 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2263 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2264 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2265 \let\tenttsl=\textttsl
2266 \def\curfontsize{text}%
2267 \def\lsize{reduced}\def\lllsize{smaller}%
2268 \resetmathfonts \setleading{\textleading}}
2270 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2271 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2272 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2273 \let\tenttsl=\titlettsl
2274 \def\curfontsize{title}%
2275 \def\lsize{chap}\def\lllsize{subsec}%
2276 \resetmathfonts \setleading{25pt}}
2277 \def\titlefont#1{{\titlefonts\rm #1}}
2279 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2280 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2281 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2282 \let\tenttsl=\chapttsl
2283 \def\curfontsize{chap}%
2284 \def\lsize{sec}\def\lllsize{text}%
2285 \resetmathfonts \setleading{19pt}}
2287 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2288 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2289 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2290 \let\tenttsl=\secttsl
2291 \def\curfontsize{sec}%
2292 \def\lsize{subsec}\def\lllsize{reduced}%
2293 \resetmathfonts \setleading{16pt}}
2295 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2296 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2297 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2298 \let\tenttsl=\ssecttsl
2299 \def\curfontsize{ssec}%
2300 \def\lsize{text}\def\lllsize{small}%
2301 \resetmathfonts \setleading{15pt}}
2302 \let\subsubsecfonts = \subsecfonts
2304 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2305 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2306 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2307 \let\tenttsl=\reducedttsl
2308 \def\curfontsize{reduced}%
2309 \def\lsize{small}\def\lllsize{smaller}%
2310 \resetmathfonts \setleading{10.5pt}}
2312 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2313 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2314 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2315 \let\tenttsl=\smallttsl
2316 \def\curfontsize{small}%
2317 \def\lsize{smaller}\def\lllsize{smaller}%
2318 \resetmathfonts \setleading{10.5pt}}
2320 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2321 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2322 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2323 \let\tenttsl=\smallerttsl
2324 \def\curfontsize{smaller}%
2325 \def\lsize{smaller}\def\lllsize{smaller}%
2326 \resetmathfonts \setleading{9.5pt}}
2328 % Set the fonts to use with the @small... environments.
2329 \let\smallexamplefonts = \smallfonts
2331 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2332 % can fit this many characters:
2333 % 8.5x11=86 smallbook=72 a4=90 a5=69
2334 % If we use \scriptfonts (8pt), then we can fit this many characters:
2335 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2336 % For me, subjectively, the few extra characters that fit aren't worth
2337 % the additional smallness of 8pt. So I'm making the default 9pt.
2339 % By the way, for comparison, here's what fits with @example (10pt):
2340 % 8.5x11=71 smallbook=60 a4=75 a5=58
2342 % I wish the USA used A4 paper.
2346 % Set up the default fonts, so we can use them for creating boxes.
2348 \definetextfontsizexi
2350 % Define these so they can be easily changed for other fonts.
2351 \def\angleleft{$\langle$}
2352 \def\angleright{$\rangle$}
2354 % Count depth in font-changes, for error checks
2355 \newcount\fontdepth \fontdepth=0
2357 % Fonts for short table of contents.
2358 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2359 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2360 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2361 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2363 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2364 %% serif) and @ii for TeX italic
2366 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2367 % unless the following character is such as not to need one.
2368 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2369 \ptexslash\fi\fi\fi}
2370 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2371 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2373 % like \smartslanted except unconditionally uses \ttsl.
2374 % @var is set to this for defun arguments.
2375 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2377 % like \smartslanted except unconditionally use \sl. We never want
2378 % ttsl for book titles, do we?
2379 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2382 \let\slanted=\smartslanted
2383 \let\var=\smartslanted
2384 \let\dfn=\smartslanted
2385 \let\emph=\smartitalic
2387 % @b, explicit bold.
2391 % @sansserif, explicit sans.
2392 \def\sansserif#1{{\sf #1}}
2394 % We can't just use \exhyphenpenalty, because that only has effect at
2395 % the end of a paragraph. Restore normal hyphenation at the end of the
2396 % group within which \nohyphenation is presumably called.
2398 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2399 \def\restorehyphenation{\hyphenchar\font = `- }
2401 % Set sfcode to normal for the chars that usually have another value.
2402 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2403 % sometimes \x has an active definition that messes things up.
2406 \def\plainfrenchspacing{%
2407 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2408 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2409 \def\endofsentencespacefactor{1000}% for @. and friends
2411 \def\plainnonfrenchspacing{%
2412 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2413 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2414 \def\endofsentencespacefactor{3000}% for @. and friends
2417 \def\endofsentencespacefactor{3000}% default
2420 {\tt \rawbackslash \plainfrenchspacing #1}%
2423 \def\samp#1{`\tclose{#1}'\null}
2424 \setfont\keyrm\rmshape{8}{1000}{OT1}
2426 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2427 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2428 \vbox{\hrule\kern-0.4pt
2429 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2431 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2432 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2433 % The old definition, with no lozenge:
2434 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2435 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2437 % @file, @option are the same as @samp.
2441 % @code is a modification of @t,
2442 % which makes spaces the same size as normal in the surrounding text.
2445 % Change normal interword space to be same as for the current font.
2446 \spaceskip = \fontdimen2\font
2448 % Switch to typewriter.
2451 % But `\ ' produces the large typewriter interword space.
2452 \def\ {{\spaceskip = 0pt{} }}%
2454 % Turn off hyphenation.
2464 % We *must* turn on hyphenation at `-' and `_' in @code.
2465 % Otherwise, it is too hard to avoid overfull hboxes
2466 % in the Emacs manual, the Library manual, etc.
2468 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2469 % both hyphenation at - and hyphenation within words.
2470 % We must therefore turn them both off (\tclose does that)
2471 % and arrange explicitly to hyphenate at a dash.
2474 \catcode`\-=\active \catcode`\_=\active
2475 \catcode`\'=\active \catcode`\`=\active
2477 \global\def\code{\begingroup
2478 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2479 \let'\codequoteright \let`\codequoteleft
2481 \catcode\dashChar=\active \catcode\underChar=\active
2494 \def\codedash{-\discretionary{}{}{}}
2496 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2497 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2498 % will therefore expand the active definition of _, which is us
2499 % (inside @code that is), therefore an endless loop.
2501 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2502 \else\normalunderscore \fi
2503 \discretionary{}{}{}}%
2506 \def\codex #1{\tclose{#1}\endgroup}
2508 % An additional complication: the above will allow breaks after, e.g.,
2509 % each of the four underscores in __typeof__. This is undesirable in
2510 % some manuals, especially if they don't have long identifiers in
2511 % general. @allowcodebreaks provides a way to control this.
2513 \newif\ifallowcodebreaks \allowcodebreakstrue
2515 \def\keywordtrue{true}
2516 \def\keywordfalse{false}
2518 \parseargdef\allowcodebreaks{%
2520 \ifx\txiarg\keywordtrue
2521 \allowcodebreakstrue
2522 \else\ifx\txiarg\keywordfalse
2523 \allowcodebreaksfalse
2525 \errhelp = \EMsimple
2526 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2530 % @kbd is like @code, except that if the argument is just one @key command,
2531 % then @kbd has no effect.
2533 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2534 % `example' (@kbd uses ttsl only inside of @example and friends),
2535 % or `code' (@kbd uses normal tty font always).
2536 \parseargdef\kbdinputstyle{%
2538 \ifx\txiarg\worddistinct
2539 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2540 \else\ifx\txiarg\wordexample
2541 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2542 \else\ifx\txiarg\wordcode
2543 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2545 \errhelp = \EMsimple
2546 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2549 \def\worddistinct{distinct}
2550 \def\wordexample{example}
2553 % Default is `distinct.'
2554 \kbdinputstyle distinct
2557 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2558 \ifx\one\xkey\ifx\threex\three \key{#2}%
2559 \else{\tclose{\kbdfont\look}}\fi
2560 \else{\tclose{\kbdfont\look}}\fi}
2562 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2563 \let\indicateurl=\code
2567 % @clicksequence{File @click{} Open ...}
2568 \def\clicksequence#1{\begingroup #1\endgroup}
2570 % @clickstyle @arrow (by default)
2571 \parseargdef\clickstyle{\def\click{#1}}
2574 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2575 % second argument specifying the text to display and an optional third
2576 % arg as text to display instead of (rather than in addition to) the url
2577 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2578 % a hypertex \special here.
2580 \def\uref#1{\douref #1,,,\finish}
2581 \def\douref#1,#2,#3,#4\finish{\begingroup
2584 \setbox0 = \hbox{\ignorespaces #3}%
2586 \unhbox0 % third arg given, show only that
2588 \setbox0 = \hbox{\ignorespaces #2}%
2591 \unhbox0 % PDF: 2nd arg given, show only it
2593 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2596 \code{#1}% only url given, so show it
2602 % @url synonym for @uref, since that's how everyone uses it.
2606 % rms does not like angle brackets --karl, 17may97.
2607 % So now @email is just like @uref, unless we are pdf.
2609 %\def\email#1{\angleleft{\tt #1}\angleright}
2611 \def\email#1{\doemail#1,,\finish}
2612 \def\doemail#1,#2,#3\finish{\begingroup
2615 \setbox0 = \hbox{\ignorespaces #2}%
2616 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2623 % Check if we are currently using a typewriter font. Since all the
2624 % Computer Modern typewriter fonts have zero interword stretch (and
2625 % shrink), and it is reasonable to expect all typewriter fonts to have
2626 % this property, we can check that font parameter.
2628 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2630 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2631 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2633 \def\dmn#1{\thinspace #1}
2635 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2637 % @l was never documented to mean ``switch to the Lisp font'',
2638 % and it is not used as such in any manual I can find. We need it for
2639 % Polish suppressed-l. --karl, 22sep96.
2640 %\def\l#1{{\li #1}\null}
2642 % Explicit font changes: @r, @sc, undocumented @ii.
2643 \def\r#1{{\rm #1}} % roman font
2644 \def\sc#1{{\smallcaps#1}} % smallcaps font
2645 \def\ii#1{{\it #1}} % italic font
2647 % @acronym for "FBI", "NATO", and the like.
2648 % We print this one point size smaller, since it's intended for
2651 \def\acronym#1{\doacronym #1,,\finish}
2652 \def\doacronym#1,#2,#3\finish{%
2653 {\selectfonts\lsize #1}%
2655 \ifx\temp\empty \else
2656 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2660 % @abbr for "Comput. J." and the like.
2661 % No font change, but don't do end-of-sentence spacing.
2663 \def\abbr#1{\doabbr #1,,\finish}
2664 \def\doabbr#1,#2,#3\finish{%
2665 {\plainfrenchspacing #1}%
2667 \ifx\temp\empty \else
2668 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2672 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2674 \def\pounds{{\it\$}}
2676 % @euro{} comes from a separate font, depending on the current style.
2677 % We use the free feym* fonts from the eurosym package by Henrik
2678 % Theiling, which support regular, slanted, bold and bold slanted (and
2679 % "outlined" (blackboard board, sort of) versions, which we don't need).
2680 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2682 % Although only regular is the truly official Euro symbol, we ignore
2683 % that. The Euro is designed to be slightly taller than the regular
2689 % feybo - bold slanted
2691 % There is no good (free) typewriter version, to my knowledge.
2692 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2695 % Also doesn't work in math. Do we need to do math with euro symbols?
2699 \def\euro{{\eurofont e}}
2701 % We set the font at each command, rather than predefining it in
2702 % \textfonts and the other font-switching commands, so that
2703 % installations which never need the symbol don't have to have the
2706 % There is only one designed size (nominal 10pt), so we always scale
2707 % that to the current nominal size.
2709 % By the way, simply using "at 1em" works for cmr10 and the like, but
2710 % does not work for cmbx10 and other extended/shrunken fonts.
2712 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2714 \ifx\curfontstyle\bfstylename
2716 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2719 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2724 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2725 % use \let for the aliases, because sometimes we redefine the original
2726 % macro, and the alias should reflect the redefinition.
2727 \def\guillemetleft{{\ecfont \char"13}}
2728 \def\guillemotleft{\guillemetleft}
2729 \def\guillemetright{{\ecfont \char"14}}
2730 \def\guillemotright{\guillemetright}
2731 \def\guilsinglleft{{\ecfont \char"0E}}
2732 \def\guilsinglright{{\ecfont \char"0F}}
2733 \def\quotedblbase{{\ecfont \char"12}}
2734 \def\quotesinglbase{{\ecfont \char"0D}}
2737 % We can't distinguish serif/sanserif and italic/slanted, but this
2738 % is used for crude hacks anyway (like adding French and German
2739 % quotes to documents typeset with CM, where we lose kerning), so
2740 % hopefully nobody will notice/care.
2741 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2742 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2743 \ifx\curfontstyle\bfstylename
2745 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2748 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2753 % @registeredsymbol - R in a circle. The font for the R should really
2754 % be smaller yet, but lllsize is the best we can do for now.
2755 % Adapted from the plain.tex definition of \copyright.
2757 \def\registeredsymbol{%
2758 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2763 % @textdegree - the normal degrees sign.
2765 \def\textdegree{$^\circ$}
2767 % Laurent Siebenmann reports \Orb undefined with:
2768 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2769 % so we'll define it if necessary.
2772 \def\Orb{\mathhexbox20D}
2776 \chardef\quotedblleft="5C
2777 \chardef\quotedblright=`\"
2778 \chardef\quoteleft=`\`
2779 \chardef\quoteright=`\'
2782 \message{page headings,}
2784 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2785 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2787 % First the title page. Must do @settitle before @titlepage.
2789 \newif\iffinishedtitlepage
2791 % Do an implicit @contents or @shortcontents after @end titlepage if the
2792 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2794 \newif\ifsetcontentsaftertitlepage
2795 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2796 \newif\ifsetshortcontentsaftertitlepage
2797 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2799 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2800 \endgroup\page\hbox{}\page}
2803 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2805 \parindent=0pt \textfonts
2806 % Leave some space at the very top of the page.
2807 \vglue\titlepagetopglue
2808 % No rule at page bottom unless we print one at the top with @title.
2809 \finishedtitlepagetrue
2811 % Most title ``pages'' are actually two pages long, with space
2812 % at the top of the second. We don't want the ragged left on the second.
2813 \let\oldpage = \page
2815 \iffinishedtitlepage\else
2818 \let\page = \oldpage
2825 \iffinishedtitlepage\else
2828 % It is important to do the page break before ending the group,
2829 % because the headline and footline are only empty inside the group.
2830 % If we use the new definition of \page, we always get a blank page
2831 % after the title page, which we certainly don't want.
2835 % Need this before the \...aftertitlepage checks so that if they are
2836 % in effect the toc pages will come out with page numbers.
2839 % If they want short, they certainly want long too.
2840 \ifsetshortcontentsaftertitlepage
2843 \global\let\shortcontents = \relax
2844 \global\let\contents = \relax
2847 \ifsetcontentsaftertitlepage
2849 \global\let\contents = \relax
2850 \global\let\shortcontents = \relax
2854 \def\finishtitlepage{%
2855 \vskip4pt \hrule height 2pt width \hsize
2856 \vskip\titlepagebottomglue
2857 \finishedtitlepagetrue
2860 %%% Macros to be used within @titlepage:
2862 \let\subtitlerm=\tenrm
2863 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2865 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2868 \parseargdef\title{%
2870 \leftline{\titlefonts\rm #1}
2871 % print a rule at the page bottom also.
2872 \finishedtitlepagefalse
2873 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2876 \parseargdef\subtitle{%
2878 {\subtitlefont \rightline{#1}}%
2881 % @author should come last, but may come many times.
2882 % It can also be used inside @quotation.
2884 \parseargdef\author{%
2885 \def\temp{\quotation}%
2887 \def\quotationauthor{#1}% printed in \Equotation.
2890 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2891 {\authorfont \leftline{#1}}%
2896 %%% Set up page headings and footings.
2898 \let\thispage=\folio
2900 \newtoks\evenheadline % headline on even pages
2901 \newtoks\oddheadline % headline on odd pages
2902 \newtoks\evenfootline % footline on even pages
2903 \newtoks\oddfootline % footline on odd pages
2905 % Now make TeX use those variables
2906 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2907 \else \the\evenheadline \fi}}
2908 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2909 \else \the\evenfootline \fi}\HEADINGShook}
2910 \let\HEADINGShook=\relax
2912 % Commands to set those variables.
2913 % For example, this is what @headings on does
2914 % @evenheading @thistitle|@thispage|@thischapter
2915 % @oddheading @thischapter|@thispage|@thistitle
2916 % @evenfooting @thisfile||
2917 % @oddfooting ||@thisfile
2920 \def\evenheading{\parsearg\evenheadingxxx}
2921 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2922 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2923 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2925 \def\oddheading{\parsearg\oddheadingxxx}
2926 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2927 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2928 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2930 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2932 \def\evenfooting{\parsearg\evenfootingxxx}
2933 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2934 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2935 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2937 \def\oddfooting{\parsearg\oddfootingxxx}
2938 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2939 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2940 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2942 % Leave some space for the footline. Hopefully ok to assume
2943 % @evenfooting will not be used by itself.
2944 \global\advance\pageheight by -12pt
2945 \global\advance\vsize by -12pt
2948 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2950 % @evenheadingmarks top \thischapter <- chapter at the top of a page
2951 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
2953 % The same set of arguments for:
2958 % @everyheadingmarks
2959 % @everyfootingmarks
2961 \def\evenheadingmarks{\headingmarks{even}{heading}}
2962 \def\oddheadingmarks{\headingmarks{odd}{heading}}
2963 \def\evenfootingmarks{\headingmarks{even}{footing}}
2964 \def\oddfootingmarks{\headingmarks{odd}{footing}}
2965 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
2966 \headingmarks{odd}{heading}{#1} }
2967 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
2968 \headingmarks{odd}{footing}{#1} }
2969 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
2970 \def\headingmarks#1#2#3 {%
2971 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
2972 \global\expandafter\let\csname get#1#2marks\endcsname \temp
2975 \everyheadingmarks bottom
2976 \everyfootingmarks bottom
2978 % @headings double turns headings on for double-sided printing.
2979 % @headings single turns headings on for single-sided printing.
2980 % @headings off turns them off.
2981 % @headings on same as @headings double, retained for compatibility.
2982 % @headings after turns on double-sided headings after this page.
2983 % @headings doubleafter turns on double-sided headings after this page.
2984 % @headings singleafter turns on single-sided headings after this page.
2985 % By default, they are off at the start of a document,
2986 % and turned `on' after @end titlepage.
2988 \def\headings #1 {\csname HEADINGS#1\endcsname}
2991 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2992 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2994 % When we turn headings on, set the page number to 1.
2995 % For double-sided printing, put current file name in lower left corner,
2996 % chapter name on inside top of right hand pages, document
2997 % title on inside top of left hand pages, and page numbers on outside top
2998 % edge of all pages.
2999 \def\HEADINGSdouble{%
3001 \global\evenfootline={\hfil}
3002 \global\oddfootline={\hfil}
3003 \global\evenheadline={\line{\folio\hfil\thistitle}}
3004 \global\oddheadline={\line{\thischapter\hfil\folio}}
3005 \global\let\contentsalignmacro = \chapoddpage
3007 \let\contentsalignmacro = \chappager
3009 % For single-sided printing, chapter title goes across top left of page,
3010 % page number on top right.
3011 \def\HEADINGSsingle{%
3013 \global\evenfootline={\hfil}
3014 \global\oddfootline={\hfil}
3015 \global\evenheadline={\line{\thischapter\hfil\folio}}
3016 \global\oddheadline={\line{\thischapter\hfil\folio}}
3017 \global\let\contentsalignmacro = \chappager
3019 \def\HEADINGSon{\HEADINGSdouble}
3021 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3022 \let\HEADINGSdoubleafter=\HEADINGSafter
3023 \def\HEADINGSdoublex{%
3024 \global\evenfootline={\hfil}
3025 \global\oddfootline={\hfil}
3026 \global\evenheadline={\line{\folio\hfil\thistitle}}
3027 \global\oddheadline={\line{\thischapter\hfil\folio}}
3028 \global\let\contentsalignmacro = \chapoddpage
3031 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3032 \def\HEADINGSsinglex{%
3033 \global\evenfootline={\hfil}
3034 \global\oddfootline={\hfil}
3035 \global\evenheadline={\line{\thischapter\hfil\folio}}
3036 \global\oddheadline={\line{\thischapter\hfil\folio}}
3037 \global\let\contentsalignmacro = \chappager
3040 % Subroutines used in generating headings
3041 % This produces Day Month Year style of output.
3042 % Only define if not already defined, in case a txi-??.tex file has set
3043 % up a different format (e.g., txi-cs.tex does this).
3044 \ifx\today\undefined
3048 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3049 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3050 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3055 % @settitle line... specifies the title of the document, for headings.
3056 % It generates no output of its own.
3057 \def\thistitle{\putwordNoTitle}
3058 \def\settitle{\parsearg{\gdef\thistitle}}
3062 % Tables -- @table, @ftable, @vtable, @item(x).
3064 % default indentation of table text
3065 \newdimen\tableindent \tableindent=.8in
3066 % default indentation of @itemize and @enumerate text
3067 \newdimen\itemindent \itemindent=.3in
3068 % margin between end of table item and start of table text.
3069 \newdimen\itemmargin \itemmargin=.1in
3071 % used internally for \itemindent minus \itemmargin
3074 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3076 % They also define \itemindex
3077 % to index the item name in whatever manner is desired (perhaps none).
3079 \newif\ifitemxneedsnegativevskip
3081 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3083 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3084 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3086 \def\itemzzz #1{\begingroup %
3087 \advance\hsize by -\rightskip
3088 \advance\hsize by -\tableindent
3089 \setbox0=\hbox{\itemindicate{#1}}%
3091 \nobreak % This prevents a break before @itemx.
3093 % If the item text does not fit in the space we have, put it on a line
3094 % by itself, and do not allow a page break either before or after that
3095 % line. We do not start a paragraph here because then if the next
3096 % command is, e.g., @kindex, the whatsit would get put into the
3097 % horizontal list on a line by itself, resulting in extra blank space.
3098 \ifdim \wd0>\itemmax
3100 % Make this a paragraph so we get the \parskip glue and wrapping,
3101 % but leave it ragged-right.
3103 \advance\leftskip by-\tableindent
3104 \advance\hsize by\tableindent
3105 \advance\rightskip by0pt plus1fil
3106 \leavevmode\unhbox0\par
3109 % We're going to be starting a paragraph, but we don't want the
3110 % \parskip glue -- logically it's part of the @item we just started.
3111 \nobreak \vskip-\parskip
3113 % Stop a page break at the \parskip glue coming up. However, if
3114 % what follows is an environment such as @example, there will be no
3115 % \parskip glue; then the negative vskip we just inserted would
3116 % cause the example and the item to crash together. So we use this
3117 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3118 % \parskip glue after all. Section titles are handled this way also.
3122 \itemxneedsnegativevskipfalse
3124 % The item text fits into the space. Start a paragraph, so that the
3125 % following text (if any) will end up on the same line.
3127 % Do this with kerns and \unhbox so that if there is a footnote in
3128 % the item text, it can migrate to the main vertical list and
3129 % eventually be printed.
3130 \nobreak\kern-\tableindent
3131 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3133 \nobreak\kern\dimen0
3135 \itemxneedsnegativevskiptrue
3139 \def\item{\errmessage{@item while not in a list environment}}
3140 \def\itemx{\errmessage{@itemx while not in a list environment}}
3142 % @table, @ftable, @vtable.
3144 \let\itemindex\gobble
3148 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3149 \tablecheck{ftable}%
3152 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3153 \tablecheck{vtable}%
3156 \ifnum \the\catcode`\^^M=\active
3158 \errmessage{This command won't work in this context; perhaps the problem is
3159 that we are \inenvironment\thisenv}%
3160 \def\next{\doignore{#1}}%
3167 \def\itemindicate{#1}%
3172 \makevalueexpandable
3173 \edef\temp{\noexpand\tablez #1\space\space\space}%
3177 \def\tablez #1 #2 #3 #4\endtablez{%
3179 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3180 \ifnum 0#2>0 \tableindent=#2\mil \fi
3181 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3182 \itemmax=\tableindent
3183 \advance \itemmax by -\itemmargin
3184 \advance \leftskip by \tableindent
3185 \exdentamount=\tableindent
3187 \parskip = \smallskipamount
3188 \ifdim \parskip=0pt \parskip=2pt \fi
3189 \let\item = \internalBitem
3190 \let\itemx = \internalBitemx
3192 \def\Etable{\endgraf\afterenvbreak}
3195 \let\Eitemize\Etable
3196 \let\Eenumerate\Etable
3198 % This is the counter used by @enumerate, which is really @itemize
3202 \envdef\itemize{\parsearg\doitemize}
3206 \itemmax=\itemindent
3207 \advance\itemmax by -\itemmargin
3208 \advance\leftskip by \itemindent
3209 \exdentamount=\itemindent
3211 \parskip=\smallskipamount
3212 \ifdim\parskip=0pt \parskip=2pt \fi
3213 \def\itemcontents{#1}%
3214 % @itemize with no arg is equivalent to @itemize @bullet.
3215 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3216 \let\item=\itemizeitem
3219 % Definition of @item while inside @itemize and @enumerate.
3222 \advance\itemno by 1 % for enumerations
3223 {\let\par=\endgraf \smallbreak}% reasonable place to break
3225 % If the document has an @itemize directly after a section title, a
3226 % \nobreak will be last on the list, and \sectionheading will have
3227 % done a \vskip-\parskip. In that case, we don't want to zero
3228 % parskip, or the item text will crash with the heading. On the
3229 % other hand, when there is normal text preceding the item (as there
3230 % usually is), we do want to zero parskip, or there would be too much
3231 % space. In that case, we won't have a \nobreak before. At least
3232 % that's the theory.
3233 \ifnum\lastpenalty<10000 \parskip=0in \fi
3235 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3236 \vadjust{\penalty 1200}}% not good to break after first line of item.
3240 % \splitoff TOKENS\endmark defines \first to be the first token in
3241 % TOKENS, and \rest to be the remainder.
3243 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3245 % Allow an optional argument of an uppercase letter, lowercase letter,
3246 % or number, to specify the first label in the enumerated list. No
3247 % argument is the same as `1'.
3249 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3250 \def\enumeratey #1 #2\endenumeratey{%
3251 % If we were given no argument, pretend we were given `1'.
3253 \ifx\thearg\empty \def\thearg{1}\fi
3255 % Detect if the argument is a single token. If so, it might be a
3256 % letter. Otherwise, the only valid thing it can be is a number.
3257 % (We will always have one token, because of the test we just made.
3258 % This is a good thing, since \splitoff doesn't work given nothing at
3259 % all -- the first parameter is undelimited.)
3260 \expandafter\splitoff\thearg\endmark
3262 % Only one token in the argument. It could still be anything.
3263 % A ``lowercase letter'' is one whose \lccode is nonzero.
3264 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3265 % not equal to itself.
3266 % Otherwise, we assume it's a number.
3268 % We need the \relax at the end of the \ifnum lines to stop TeX from
3269 % continuing to look for a <number>.
3271 \ifnum\lccode\expandafter`\thearg=0\relax
3272 \numericenumerate % a number (we hope)
3275 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3276 \lowercaseenumerate % lowercase letter
3278 \uppercaseenumerate % uppercase letter
3282 % Multiple tokens in the argument. We hope it's a number.
3287 % An @enumerate whose labels are integers. The starting integer is
3290 \def\numericenumerate{%
3292 \startenumeration{\the\itemno}%
3295 % The starting (lowercase) letter is in \thearg.
3296 \def\lowercaseenumerate{%
3297 \itemno = \expandafter`\thearg
3299 % Be sure we're not beyond the end of the alphabet.
3301 \errmessage{No more lowercase letters in @enumerate; get a bigger
3308 % The starting (uppercase) letter is in \thearg.
3309 \def\uppercaseenumerate{%
3310 \itemno = \expandafter`\thearg
3312 % Be sure we're not beyond the end of the alphabet.
3314 \errmessage{No more uppercase letters in @enumerate; get a bigger
3321 % Call \doitemize, adding a period to the first argument and supplying the
3322 % common last two arguments. Also subtract one from the initial value in
3323 % \itemno, since @item increments \itemno.
3325 \def\startenumeration#1{%
3326 \advance\itemno by -1
3327 \doitemize{#1.}\flushcr
3330 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3333 \def\alphaenumerate{\enumerate{a}}
3334 \def\capsenumerate{\enumerate{A}}
3335 \def\Ealphaenumerate{\Eenumerate}
3336 \def\Ecapsenumerate{\Eenumerate}
3339 % @multitable macros
3340 % Amy Hendrickson, 8/18/94, 3/6/96
3342 % @multitable ... @end multitable will make as many columns as desired.
3343 % Contents of each column will wrap at width given in preamble. Width
3344 % can be specified either with sample text given in a template line,
3345 % or in percent of \hsize, the current width of text on page.
3347 % Table can continue over pages but will only break between lines.
3351 % Either define widths of columns in terms of percent of \hsize:
3352 % @multitable @columnfractions .25 .3 .45
3355 % Numbers following @columnfractions are the percent of the total
3356 % current hsize to be used for each column. You may use as many
3357 % columns as desired.
3360 % Or use a template:
3361 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3363 % using the widest term desired in each column.
3365 % Each new table line starts with @item, each subsequent new column
3366 % starts with @tab. Empty columns may be produced by supplying @tab's
3367 % with nothing between them for as many times as empty columns are needed,
3368 % ie, @tab@tab@tab will produce two empty columns.
3370 % @item, @tab do not need to be on their own lines, but it will not hurt
3373 % Sample multitable:
3375 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3376 % @item first col stuff @tab second col stuff @tab third col
3383 % @item first col stuff @tab second col stuff
3384 % @tab Many paragraphs of text may be used in any column.
3386 % They will wrap at the width determined by the template.
3387 % @item@tab@tab This will be in third column.
3390 % Default dimensions may be reset by user.
3391 % @multitableparskip is vertical space between paragraphs in table.
3392 % @multitableparindent is paragraph indent in table.
3393 % @multitablecolmargin is horizontal space to be left between columns.
3394 % @multitablelinespace is space to leave between table items, baseline
3396 % 0pt means it depends on current normal line spacing.
3398 \newskip\multitableparskip
3399 \newskip\multitableparindent
3400 \newdimen\multitablecolspace
3401 \newskip\multitablelinespace
3402 \multitableparskip=0pt
3403 \multitableparindent=6pt
3404 \multitablecolspace=12pt
3405 \multitablelinespace=0pt
3407 % Macros used to set up halign preamble:
3409 \let\endsetuptable\relax
3410 \def\xendsetuptable{\endsetuptable}
3411 \let\columnfractions\relax
3412 \def\xcolumnfractions{\columnfractions}
3415 % #1 is the @columnfraction, usually a decimal number like .5, but might
3416 % be just 1. We just use it, whatever it is.
3418 \def\pickupwholefraction#1 {%
3419 \global\advance\colcount by 1
3420 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3427 \ifx\firstarg\xendsetuptable
3430 \ifx\firstarg\xcolumnfractions
3431 \global\setpercenttrue
3434 \let\go\pickupwholefraction
3436 \global\advance\colcount by 1
3437 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3438 % separator; typically that is always in the input, anyway.
3439 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3442 \ifx\go\pickupwholefraction
3443 % Put the argument back for the \pickupwholefraction call, so
3444 % we'll always have a period there to be parsed.
3445 \def\go{\pickupwholefraction#1}%
3447 \let\go = \setuptable
3453 % multitable-only commands.
3455 % @headitem starts a heading row, which we typeset in bold.
3456 % Assignments have to be global since we are inside the implicit group
3457 % of an alignment entry. Note that \everycr resets \everytab.
3458 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3460 % A \tab used to include \hskip1sp. But then the space in a template
3461 % line is not enough. That is bad. So let's go back to just `&' until
3462 % we encounter the problem it was intended to solve again.
3463 % --karl, nathan@acm.org, 20apr99.
3464 \def\tab{\checkenv\multitable &\the\everytab}%
3466 % @multitable ... @end multitable definitions:
3468 \newtoks\everytab % insert after every tab.
3470 \envdef\multitable{%
3474 % @item within a multitable starts a normal row.
3475 % We use \def instead of \let so that if one of the multitable entries
3476 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3477 % \endtemplate) expanding \doitemize.
3482 \setmultitablespacing
3483 \parskip=\multitableparskip
3484 \parindent=\multitableparindent
3490 \global\everytab={}%
3491 \global\colcount=0 % Reset the column counter.
3492 % Check for saved footnotes, etc.
3494 % Keeps underfull box messages off when table breaks over pages.
3496 % Maybe so, but it also creates really weird page breaks when the
3497 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3498 % problem manifests itself, so it can be fixed for real --karl.
3502 \parsearg\domultitable
3504 \def\domultitable#1{%
3505 % To parse everything between @multitable and @item:
3506 \setuptable#1 \endsetuptable
3508 % This preamble sets up a generic column definition, which will
3509 % be used as many times as user calls for columns.
3510 % \vtop will set a single line and will also let text wrap and
3511 % continue for many paragraphs if desired.
3513 \global\advance\colcount by 1
3516 % Use the current \colcount to find the correct column width:
3517 \hsize=\expandafter\csname col\the\colcount\endcsname
3519 % In order to keep entries from bumping into each other
3520 % we will add a \leftskip of \multitablecolspace to all columns after
3523 % If a template has been used, we will add \multitablecolspace
3524 % to the width of each template entry.
3526 % If the user has set preamble in terms of percent of \hsize we will
3527 % use that dimension as the width of the column, and the \leftskip
3528 % will keep entries from bumping into each other. Table will start at
3529 % left margin and final column will justify at right margin.
3531 % Make sure we don't inherit \rightskip from the outer environment.
3534 % The first column will be indented with the surrounding text.
3535 \advance\hsize by\leftskip
3538 % If user has not set preamble in terms of percent of \hsize
3539 % we will advance \hsize by \multitablecolspace.
3540 \advance\hsize by \multitablecolspace
3542 % In either case we will make \leftskip=\multitablecolspace:
3543 \leftskip=\multitablecolspace
3545 % Ignoring space at the beginning and end avoids an occasional spurious
3546 % blank line, when TeX decides to break the line at the space before the
3547 % box from the multistrut, so the strut ends up on a line by itself.
3549 % @multitable @columnfractions .11 .89
3551 % @tab Legal holiday which is valid in major parts of the whole country.
3552 % Is automatically provided with highlighting sequences respectively
3553 % marking characters.
3554 \noindent\ignorespaces##\unskip\multistrut
3559 \egroup % end the \halign
3560 \global\setpercentfalse
3563 \def\setmultitablespacing{%
3564 \def\multistrut{\strut}% just use the standard line spacing
3566 % Compute \multitablelinespace (if not defined by user) for use in
3567 % \multitableparskip calculation. We used define \multistrut based on
3568 % this, but (ironically) that caused the spacing to be off.
3569 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3570 \ifdim\multitablelinespace=0pt
3571 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3572 \global\advance\multitablelinespace by-\ht0
3574 %% Test to see if parskip is larger than space between lines of
3575 %% table. If not, do nothing.
3576 %% If so, set to same dimension as multitablelinespace.
3577 \ifdim\multitableparskip>\multitablelinespace
3578 \global\multitableparskip=\multitablelinespace
3579 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3580 %% than skip between lines in the table.
3582 \ifdim\multitableparskip=0pt
3583 \global\multitableparskip=\multitablelinespace
3584 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3585 %% than skip between lines in the table.
3589 \message{conditionals,}
3591 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3592 % @ifnotxml always succeed. They currently do nothing; we don't
3593 % attempt to check whether the conditionals are properly nested. But we
3594 % have to remember that they are conditionals, so that @end doesn't
3595 % attempt to close an environment group.
3598 \expandafter\let\csname #1\endcsname = \relax
3599 \expandafter\let\csname iscond.#1\endcsname = 1
3602 \makecond{ifnotdocbook}
3603 \makecond{ifnothtml}
3604 \makecond{ifnotinfo}
3605 \makecond{ifnotplaintext}
3608 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3610 \def\direntry{\doignore{direntry}}
3611 \def\documentdescription{\doignore{documentdescription}}
3612 \def\docbook{\doignore{docbook}}
3613 \def\html{\doignore{html}}
3614 \def\ifdocbook{\doignore{ifdocbook}}
3615 \def\ifhtml{\doignore{ifhtml}}
3616 \def\ifinfo{\doignore{ifinfo}}
3617 \def\ifnottex{\doignore{ifnottex}}
3618 \def\ifplaintext{\doignore{ifplaintext}}
3619 \def\ifxml{\doignore{ifxml}}
3620 \def\ignore{\doignore{ignore}}
3621 \def\menu{\doignore{menu}}
3622 \def\xml{\doignore{xml}}
3624 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3626 % A count to remember the depth of nesting.
3627 \newcount\doignorecount
3629 \def\doignore#1{\begingroup
3630 % Scan in ``verbatim'' mode:
3632 \catcode`\@ = \other
3633 \catcode`\{ = \other
3634 \catcode`\} = \other
3636 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3639 % Count number of #1's that we've seen.
3642 % Swallow text until we reach the matching `@end #1'.
3646 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3649 \gdef\dodoignore#1{%
3650 % #1 contains the command name as a string, e.g., `ifinfo'.
3652 % Define a command to find the next `@end #1'.
3653 \long\def\doignoretext##1^^M@end #1{%
3654 \doignoretextyyy##1^^M@#1\_STOP_}%
3656 % And this command to find another #1 command, at the beginning of a
3657 % line. (Otherwise, we would consider a line `@c @ifset', for
3658 % example, to count as an @ifset for nesting.)
3659 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3661 % And now expand that command.
3666 \def\doignoreyyy#1{%
3668 \ifx\temp\empty % Nothing found.
3669 \let\next\doignoretextzzz
3670 \else % Found a nested condition, ...
3671 \advance\doignorecount by 1
3672 \let\next\doignoretextyyy % ..., look for another.
3673 % If we're here, #1 ends with ^^M\ifinfo (for example).
3675 \next #1% the token \_STOP_ is present just after this macro.
3678 % We have to swallow the remaining "\_STOP_".
3680 \def\doignoretextzzz#1{%
3681 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3682 \let\next\enddoignore
3683 \else % Still inside a nested condition.
3684 \advance\doignorecount by -1
3685 \let\next\doignoretext % Look for the next @end.
3690 % Finish off ignored text.
3692 % Ignore anything after the last `@end #1'; this matters in verbatim
3693 % environments, where otherwise the newline after an ignored conditional
3694 % would result in a blank line in the output.
3695 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3699 % @set VAR sets the variable VAR to an empty value.
3700 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3702 % Since we want to separate VAR from REST-OF-LINE (which might be
3703 % empty), we can't just use \parsearg; we have to insert a space of our
3704 % own to delimit the rest of the line, and then take it out again if we
3706 % We rely on the fact that \parsearg sets \catcode`\ =10.
3708 \parseargdef\set{\setyyy#1 \endsetyyy}
3709 \def\setyyy#1 #2\endsetyyy{%
3711 \makevalueexpandable
3713 \edef\next{\gdef\makecsname{SET#1}}%
3721 % Remove the trailing space \setxxx inserted.
3722 \def\setzzz#1 \endsetzzz{\next{#1}}
3724 % @clear VAR clears (i.e., unsets) the variable VAR.
3726 \parseargdef\clear{%
3728 \makevalueexpandable
3729 \global\expandafter\let\csname SET#1\endcsname=\relax
3733 % @value{foo} gets the text saved in variable foo.
3734 \def\value{\begingroup\makevalueexpandable\valuexxx}
3735 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3737 \catcode`\- = \active \catcode`\_ = \active
3739 \gdef\makevalueexpandable{%
3740 \let\value = \expandablevalue
3741 % We don't want these characters active, ...
3742 \catcode`\-=\other \catcode`\_=\other
3743 % ..., but we might end up with active ones in the argument if
3744 % we're called from @code, as @code{@value{foo-bar_}}, though.
3745 % So \let them to their normal equivalents.
3746 \let-\realdash \let_\normalunderscore
3750 % We have this subroutine so that we can handle at least some @value's
3751 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3752 % The command has to be fully expandable (if the variable is set), since
3753 % the result winds up in the index file. This means that if the
3754 % variable's value contains other Texinfo commands, it's almost certain
3755 % it will fail (although perhaps we could fix that with sufficient work
3756 % to do a one-level expansion on the result, instead of complete).
3758 \def\expandablevalue#1{%
3759 \expandafter\ifx\csname SET#1\endcsname\relax
3760 {[No value for ``#1'']}%
3761 \message{Variable `#1', used in @value, is not set.}%
3763 \csname SET#1\endcsname
3767 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3770 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3773 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3776 \makevalueexpandable
3778 \expandafter\ifx\csname SET#2\endcsname\relax
3779 #1% If not set, redefine \next.
3784 \def\ifsetfail{\doignore{ifset}}
3786 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3787 % defined with @set, or has been undefined with @clear.
3789 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3790 % above code: if the variable is not set, do nothing, if it is set,
3791 % then redefine \next to \ifclearfail.
3794 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3795 \def\ifclearfail{\doignore{ifclear}}
3797 % @dircategory CATEGORY -- specify a category of the dir file
3798 % which this file should belong to. Ignore this in TeX.
3799 \let\dircategory=\comment
3801 % @defininfoenclose.
3802 \let\definfoenclose=\comment
3806 % Index generation facilities
3808 % Define \newwrite to be identical to plain tex's \newwrite
3809 % except not \outer, so it can be used within macros and \if's.
3810 \edef\newwrite{\makecsname{ptexnewwrite}}
3812 % \newindex {foo} defines an index named foo.
3813 % It automatically defines \fooindex such that
3814 % \fooindex ...rest of line... puts an entry in the index foo.
3815 % It also defines \fooindfile to be the number of the output channel for
3816 % the file that accumulates this index. The file's extension is foo.
3817 % The name of an index should be no more than 2 characters long
3818 % for the sake of vms.
3822 \expandafter\newwrite \csname#1indfile\endcsname
3823 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3825 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3826 \noexpand\doindex{#1}}
3829 % @defindex foo == \newindex{foo}
3831 \def\defindex{\parsearg\newindex}
3833 % Define @defcodeindex, like @defindex except put all entries in @code.
3835 \def\defcodeindex{\parsearg\newcodeindex}
3837 \def\newcodeindex#1{%
3839 \expandafter\newwrite \csname#1indfile\endcsname
3840 \openout \csname#1indfile\endcsname \jobname.#1
3842 \expandafter\xdef\csname#1index\endcsname{%
3843 \noexpand\docodeindex{#1}}%
3847 % @synindex foo bar makes index foo feed into index bar.
3848 % Do this instead of @defindex foo if you don't want it as a separate index.
3850 % @syncodeindex foo bar similar, but put all entries made for index foo
3853 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3854 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3856 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3857 % #3 the target index (bar).
3858 \def\dosynindex#1#2#3{%
3859 % Only do \closeout if we haven't already done it, else we'll end up
3860 % closing the target index.
3861 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3862 % The \closeout helps reduce unnecessary open files; the limit on the
3863 % Acorn RISC OS is a mere 16 files.
3864 \expandafter\closeout\csname#2indfile\endcsname
3865 \expandafter\let\csname\donesynindex#2\endcsname = 1
3867 % redefine \fooindfile:
3868 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3869 \expandafter\let\csname#2indfile\endcsname=\temp
3870 % redefine \fooindex:
3871 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3874 % Define \doindex, the driver for all \fooindex macros.
3875 % Argument #1 is generated by the calling \fooindex macro,
3876 % and it is "foo", the name of the index.
3878 % \doindex just uses \parsearg; it calls \doind for the actual work.
3879 % This is because \doind is more useful to call from other macros.
3881 % There is also \dosubind {index}{topic}{subtopic}
3882 % which makes an entry in a two-level index such as the operation index.
3884 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3885 \def\singleindexer #1{\doind{\indexname}{#1}}
3887 % like the previous two, but they put @code around the argument.
3888 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3889 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3891 % Take care of Texinfo commands that can appear in an index entry.
3892 % Since there are some commands we want to expand, and others we don't,
3893 % we have to laboriously prevent expansion for those that we don't.
3896 \escapechar = `\\ % use backslash in output files.
3897 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3898 \def\ {\realbackslash\space }%
3900 % Need these in case \tex is in effect and \{ is a \delimiter again.
3901 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3902 % braces and backslashes are used only as delimiters.
3906 % I don't entirely understand this, but when an index entry is
3907 % generated from a macro call, the \endinput which \scanmacro inserts
3908 % causes processing to be prematurely terminated. This is,
3909 % apparently, because \indexsorttmp is fully expanded, and \endinput
3910 % is an expandable command. The redefinition below makes \endinput
3911 % disappear altogether for that purpose -- although logging shows that
3912 % processing continues to some further point. On the other hand, it
3913 % seems \endinput does not hurt in the printed index arg, since that
3914 % is still getting written without apparent harm.
3916 % Sample source (mac-idx3.tex, reported by Graham Percival to
3917 % help-texinfo, 22may06):
3918 % @macro funindex {WORD}
3922 % @funindex commtest
3924 % The above is not enough to reproduce the bug, but it gives the flavor.
3926 % Sample whatsit resulting:
3927 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3930 \let\endinput = \empty
3932 % Do the redefinitions.
3936 % For the aux and toc files, @ is the escape character. So we want to
3937 % redefine everything using @ as the escape character (instead of
3938 % \realbackslash, still used for index files). When everything uses @,
3939 % this will be simpler.
3944 \let\{ = \lbraceatcmd
3945 \let\} = \rbraceatcmd
3947 % Do the redefinitions.
3952 % Called from \indexdummies and \atdummies.
3954 \def\commondummies{%
3956 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3957 % preventing its expansion. This is used only for control% words,
3958 % not control letters, because the \space would be incorrect for
3959 % control characters, but is needed to separate the control word
3960 % from whatever follows.
3962 % For control letters, we have \definedummyletter, which omits the
3965 % These can be used both for control words that take an argument and
3966 % those that do not. If it is followed by {arg} in the input, then
3967 % that will dutifully get written to the index (or wherever).
3969 \def\definedummyword ##1{\def##1{\string##1\space}}%
3970 \def\definedummyletter##1{\def##1{\string##1}}%
3971 \let\definedummyaccent\definedummyletter
3973 \commondummiesnofonts
3975 \definedummyletter\_%
3977 % Non-English letters.
3989 \definedummyword\exclamdown
3990 \definedummyword\questiondown
3991 \definedummyword\ordf
3992 \definedummyword\ordm
3994 % Although these internal commands shouldn't show up, sometimes they do.
3996 \definedummyword\gtr
3997 \definedummyword\hat
3998 \definedummyword\less
4001 \definedummyword\tclose
4004 \definedummyword\LaTeX
4005 \definedummyword\TeX
4007 % Assorted special characters.
4008 \definedummyword\bullet
4009 \definedummyword\comma
4010 \definedummyword\copyright
4011 \definedummyword\registeredsymbol
4012 \definedummyword\dots
4013 \definedummyword\enddots
4014 \definedummyword\equiv
4015 \definedummyword\error
4016 \definedummyword\euro
4017 \definedummyword\guillemetleft
4018 \definedummyword\guillemetright
4019 \definedummyword\guilsinglleft
4020 \definedummyword\guilsinglright
4021 \definedummyword\expansion
4022 \definedummyword\minus
4023 \definedummyword\pounds
4024 \definedummyword\point
4025 \definedummyword\print
4026 \definedummyword\quotedblbase
4027 \definedummyword\quotedblleft
4028 \definedummyword\quotedblright
4029 \definedummyword\quoteleft
4030 \definedummyword\quoteright
4031 \definedummyword\quotesinglbase
4032 \definedummyword\result
4033 \definedummyword\textdegree
4035 % We want to disable all macros so that they are not expanded by \write.
4038 \normalturnoffactive
4040 % Handle some cases of @value -- where it does not contain any
4041 % (non-fully-expandable) commands.
4042 \makevalueexpandable
4045 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4047 \def\commondummiesnofonts{%
4048 % Control letters and accents.
4049 \definedummyletter\!%
4050 \definedummyaccent\"%
4051 \definedummyaccent\'%
4052 \definedummyletter\*%
4053 \definedummyaccent\,%
4054 \definedummyletter\.%
4055 \definedummyletter\/%
4056 \definedummyletter\:%
4057 \definedummyaccent\=%
4058 \definedummyletter\?%
4059 \definedummyaccent\^%
4060 \definedummyaccent\`%
4061 \definedummyaccent\~%
4065 \definedummyword\dotaccent
4066 \definedummyword\ringaccent
4067 \definedummyword\tieaccent
4068 \definedummyword\ubaraccent
4069 \definedummyword\udotaccent
4070 \definedummyword\dotless
4072 % Texinfo font commands.
4079 % Commands that take arguments.
4080 \definedummyword\acronym
4081 \definedummyword\cite
4082 \definedummyword\code
4083 \definedummyword\command
4084 \definedummyword\dfn
4085 \definedummyword\emph
4086 \definedummyword\env
4087 \definedummyword\file
4088 \definedummyword\kbd
4089 \definedummyword\key
4090 \definedummyword\math
4091 \definedummyword\option
4092 \definedummyword\pxref
4093 \definedummyword\ref
4094 \definedummyword\samp
4095 \definedummyword\strong
4096 \definedummyword\tie
4097 \definedummyword\uref
4098 \definedummyword\url
4099 \definedummyword\var
4100 \definedummyword\verb
4102 \definedummyword\xref
4105 % \indexnofonts is used when outputting the strings to sort the index
4106 % by, and when constructing control sequence names. It eliminates all
4107 % control sequences and just writes whatever the best ASCII sort string
4108 % would be for a given command (usually its argument).
4111 % Accent commands should become @asis.
4112 \def\definedummyaccent##1{\let##1\asis}%
4113 % We can just ignore other control letters.
4114 \def\definedummyletter##1{\let##1\empty}%
4115 % Hopefully, all control words can become @asis.
4116 \let\definedummyword\definedummyaccent
4118 \commondummiesnofonts
4120 % Don't no-op \tt, since it isn't a user-level command
4121 % and is used in the definitions of the active chars like <, >, |, etc.
4122 % Likewise with the other plain tex font commands.
4127 % how to handle braces?
4128 \def\_{\normalunderscore}%
4130 % Non-English letters.
4143 \def\questiondown{?}%
4150 % Assorted special characters.
4151 % (The following {} will end up in the sort string, but that's ok.)
4152 \def\bullet{bullet}%
4154 \def\copyright{copyright}%
4155 \def\registeredsymbol{R}%
4161 \def\guillemetleft{<<}%
4162 \def\guillemetright{>>}%
4163 \def\guilsinglleft{<}%
4164 \def\guilsinglright{>}%
4165 \def\expansion{==>}%
4167 \def\pounds{pounds}%
4170 \def\quotedblbase{"}%
4171 \def\quotedblleft{"}%
4172 \def\quotedblright{"}%
4175 \def\quotesinglbase{,}%
4177 \def\textdegree{degrees}%
4179 % We need to get rid of all macros, leaving only the arguments (if present).
4180 % Of course this is not nearly correct, but it is the best we can do for now.
4181 % makeinfo does not expand macros in the argument to @deffn, which ends up
4182 % writing an index entry, and texindex isn't prepared for an index sort entry
4183 % that starts with \.
4185 % Since macro invocations are followed by braces, we can just redefine them
4186 % to take a single TeX argument. The case of a macro invocation that
4187 % goes to end-of-line is not handled.
4192 \let\indexbackslash=0 %overridden during \printindex.
4193 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4195 % Most index entries go through here, but \dosubind is the general case.
4196 % #1 is the index name, #2 is the entry text.
4197 \def\doind#1#2{\dosubind{#1}{#2}{}}
4199 % Workhorse for all \fooindexes.
4200 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4201 % empty if called from \doind, as we usually are (the main exception
4202 % is with most defuns, which call us directly).
4204 \def\dosubind#1#2#3{%
4207 % Store the main index entry text (including the third arg).
4209 % If third arg is present, precede it with a space.
4211 \ifx\thirdarg\empty \else
4212 \toks0 = \expandafter{\the\toks0 \space #3}%
4215 \edef\writeto{\csname#1indfile\endcsname}%
4217 \safewhatsit\dosubindwrite
4222 % Write the entry in \toks0 to the index file:
4224 \def\dosubindwrite{%
4225 % Put the index entry in the margin if desired.
4226 \ifx\SETmarginindex\relax\else
4227 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4230 % Remember, we are within a group.
4231 \indexdummies % Must do this here, since \bf, etc expand at this stage
4232 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4233 % so it will be output as is; and it will print as backslash.
4235 % Process the index entry with all font commands turned off, to
4236 % get the string to sort by.
4238 \edef\temp{\the\toks0}% need full expansion
4239 \xdef\indexsorttmp{\temp}%
4242 % Set up the complete index entry, with both the sort key and
4243 % the original text, including any font commands. We write
4244 % three arguments to \entry to the .?? file (four in the
4245 % subentry case), texindex reduces to two when writing the .??s
4249 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4254 % Take care of unwanted page breaks/skips around a whatsit:
4256 % If a skip is the last thing on the list now, preserve it
4257 % by backing up by \lastskip, doing the \write, then inserting
4258 % the skip again. Otherwise, the whatsit generated by the
4259 % \write or \pdfdest will make \lastskip zero. The result is that
4260 % sequences like this:
4264 % will have extra space inserted, because the \medbreak in the
4265 % start of the @defun won't see the skip inserted by the @end of
4266 % the previous defun.
4268 % But don't do any of this if we're not in vertical mode. We
4269 % don't want to do a \vskip and prematurely end a paragraph.
4271 % Avoid page breaks due to these extra skips, too.
4273 % But wait, there is a catch there:
4274 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4275 % sufficient for this purpose, as it ignores stretch and shrink parts
4276 % of the skip. The only way seems to be to check the textual
4277 % representation of the skip.
4279 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4280 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4282 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4284 \newskip\whatsitskip
4285 \newcount\whatsitpenalty
4289 \def\safewhatsit#1{%
4293 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4294 \whatsitskip = \lastskip
4295 \edef\lastskipmacro{\the\lastskip}%
4296 \whatsitpenalty = \lastpenalty
4298 % If \lastskip is nonzero, that means the last item was a
4299 % skip. And since a skip is discardable, that means this
4300 % -\whatsitskip glue we're inserting is preceded by a
4301 % non-discardable item, therefore it is not a potential
4302 % breakpoint, therefore no \nobreak needed.
4303 \ifx\lastskipmacro\zeroskipmacro
4310 \ifx\lastskipmacro\zeroskipmacro
4311 % If \lastskip was zero, perhaps the last item was a penalty, and
4312 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4313 % to re-insert the same penalty (values >10000 are used for various
4314 % signals); since we just inserted a non-discardable item, any
4315 % following glue (such as a \parskip) would be a breakpoint. For example:
4317 % @deffn deffn-whatever
4318 % @vindex index-whatever
4320 % would allow a break between the index-whatever whatsit
4321 % and the "Description." paragraph.
4322 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4324 % On the other hand, if we had a nonzero \lastskip,
4325 % this make-up glue would be preceded by a non-discardable item
4326 % (the whatsit from the \write), so we must insert a \nobreak.
4327 \nobreak\vskip\whatsitskip
4332 % The index entry written in the file actually looks like
4333 % \entry {sortstring}{page}{topic}
4335 % \entry {sortstring}{page}{topic}{subtopic}
4336 % The texindex program reads in these files and writes files
4337 % containing these kinds of lines:
4339 % before the first topic whose initial is c
4340 % \entry {topic}{pagelist}
4341 % for a topic that is used without subtopics
4343 % for the beginning of a topic that is used with subtopics
4344 % \secondary {subtopic}{pagelist}
4345 % for each subtopic.
4347 % Define the user-accessible indexing commands
4348 % @findex, @vindex, @kindex, @cindex.
4350 \def\findex {\fnindex}
4351 \def\kindex {\kyindex}
4352 \def\cindex {\cpindex}
4353 \def\vindex {\vrindex}
4354 \def\tindex {\tpindex}
4355 \def\pindex {\pgindex}
4357 \def\cindexsub {\begingroup\obeylines\cindexsub}
4359 \gdef\cindexsub "#1" #2^^M{\endgroup %
4360 \dosubind{cp}{#2}{#1}}}
4362 % Define the macros used in formatting output of the sorted index material.
4364 % @printindex causes a particular index (the ??s file) to get printed.
4365 % It does not print any chapter heading (usually an @unnumbered).
4367 \parseargdef\printindex{\begingroup
4368 \dobreak \chapheadingskip{10000}%
4373 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4375 % See if the index file exists and is nonempty.
4376 % Change catcode of @ here so that if the index file contains
4378 % as its first line, TeX doesn't complain about mismatched braces
4379 % (because it thinks @} is a control sequence).
4381 \openin 1 \jobname.#1s
4383 % \enddoublecolumns gets confused if there is no text in the index,
4384 % and it loses the chapter title and the aux file entries for the
4385 % index. The easiest way to prevent this problem is to make sure
4386 % there is some text.
4387 \putwordIndexNonexistent
4390 % If the index file exists but is empty, then \openin leaves \ifeof
4391 % false. We have to make TeX try to read something from the file, so
4392 % it can discover if there is anything in it.
4395 \putwordIndexIsEmpty
4397 % Index files are almost Texinfo source, but we use \ as the escape
4398 % character. It would be better to use @, but that's too big a change
4399 % to make right now.
4400 \def\indexbackslash{\backslashcurfont}%
4411 % These macros are used by the sorted index file itself.
4412 % Change them to control the appearance of the index.
4415 % Some minor font changes for the special characters.
4416 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4418 % Remove any glue we may have, we'll be inserting our own.
4421 % We like breaks before the index initials, so insert a bonus.
4423 \vskip 0pt plus 3\baselineskip
4425 \vskip 0pt plus -3\baselineskip
4427 % Typeset the initial. Making this add up to a whole number of
4428 % baselineskips increases the chance of the dots lining up from column
4429 % to column. It still won't often be perfect, because of the stretch
4430 % we need before each entry, but it's better.
4432 % No shrink because it confuses \balancecolumns.
4433 \vskip 1.67\baselineskip plus .5\baselineskip
4434 \leftline{\secbf #1}%
4435 % Do our best not to break after the initial.
4437 \vskip .33\baselineskip plus .1\baselineskip
4440 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4441 % then page number (#2) flushed to the right margin. It is used for index
4442 % and table of contents entries. The paragraph is indented by \leftskip.
4444 % A straightforward implementation would start like this:
4445 % \def\entry#1#2{...
4446 % But this frozes the catcodes in the argument, and can cause problems to
4447 % @code, which sets - active. This problem was fixed by a kludge---
4448 % ``-'' was active throughout whole index, but this isn't really right.
4450 % The right solution is to prevent \entry from swallowing the whole text.
4455 % Start a new paragraph if necessary, so our assignments below can't
4456 % affect previous text.
4459 % Do not fill out the last line with white space.
4462 % No extra space above this paragraph.
4465 % Do not prefer a separate line ending with a hyphen to fewer lines.
4466 \finalhyphendemerits = 0
4468 % \hangindent is only relevant when the entry text and page number
4469 % don't both fit on one line. In that case, bob suggests starting the
4470 % dots pretty far over on the line. Unfortunately, a large
4471 % indentation looks wrong when the entry text itself is broken across
4472 % lines. So we use a small indentation and put up with long leaders.
4474 % \hangafter is reset to 1 (which is the value we want) at the start
4475 % of each paragraph, so we need not do anything with that.
4478 % When the entry text needs to be broken, just fill out the first line
4480 \rightskip = 0pt plus1fil
4482 % A bit of stretch before each entry for the benefit of balancing
4486 % Swallow the left brace of the text (first parameter):
4487 \afterassignment\doentry
4491 \bgroup % Instead of the swallowed brace.
4493 \aftergroup\finishentry
4494 % And now comes the text of the entry.
4496 \def\finishentry#1{%
4497 % #1 is the page number.
4499 % The following is kludged to not output a line of dots in the index if
4500 % there are no page numbers. The next person who breaks this will be
4501 % cursed by a Unix daemon.
4502 \setbox\boxA = \hbox{#1}%
4503 \ifdim\wd\boxA = 0pt
4507 % If we must, put the page number on a line of its own, and fill out
4508 % this line with blank space. (The \hfil is overwhelmed with the
4509 % fill leaders glue in \indexdotfill if the page number does fit.)
4511 \null\nobreak\indexdotfill % Have leaders before the page number.
4513 % The `\ ' here is removed by the implicit \unskip that TeX does as
4514 % part of (the primitive) \par. Without it, a spurious underfull
4527 % Like plain.tex's \dotfill, except uses up at least 1 em.
4528 \def\indexdotfill{\cleaders
4529 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4531 \def\primary #1{\line{#1\hfil}}
4533 \newskip\secondaryindent \secondaryindent=0.5cm
4534 \def\secondary#1#2{{%
4539 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4541 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4548 % Define two-column mode, which we use to typeset indexes.
4549 % Adapted from the TeXbook, page 416, which is to say,
4550 % the manmac.tex format used to print the TeXbook itself.
4554 \newdimen\doublecolumnhsize
4556 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4557 % Grab any single-column material above us.
4560 % Here is a possibility not foreseen in manmac: if we accumulate a
4561 % whole lot of material, we might end up calling this \output
4562 % routine twice in a row (see the doublecol-lose test, which is
4563 % essentially a couple of indexes with @setchapternewpage off). In
4564 % that case we just ship out what is in \partialpage with the normal
4565 % output routine. Generally, \partialpage will be empty when this
4566 % runs and this will be a no-op. See the indexspread.tex test case.
4567 \ifvoid\partialpage \else
4568 \onepageout{\pagecontents\partialpage}%
4571 \global\setbox\partialpage = \vbox{%
4572 % Unvbox the main output page.
4574 \kern-\topskip \kern\baselineskip
4577 \eject % run that output routine to set \partialpage
4579 % Use the double-column output routine for subsequent pages.
4580 \output = {\doublecolumnout}%
4582 % Change the page size parameters. We could do this once outside this
4583 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4584 % format, but then we repeat the same computation. Repeating a couple
4585 % of assignments once per index is clearly meaningless for the
4586 % execution time, so we may as well do it in one place.
4588 % First we halve the line length, less a little for the gutter between
4589 % the columns. We compute the gutter based on the line length, so it
4590 % changes automatically with the paper format. The magic constant
4591 % below is chosen so that the gutter has the same value (well, +-<1pt)
4592 % as it did when we hard-coded it.
4594 % We put the result in a separate register, \doublecolumhsize, so we
4595 % can restore it in \pagesofar, after \hsize itself has (potentially)
4598 \doublecolumnhsize = \hsize
4599 \advance\doublecolumnhsize by -.04154\hsize
4600 \divide\doublecolumnhsize by 2
4601 \hsize = \doublecolumnhsize
4603 % Double the \vsize as well. (We don't need a separate register here,
4604 % since nobody clobbers \vsize.)
4608 % The double-column output routine for all double-column pages except
4611 \def\doublecolumnout{%
4612 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4613 % Get the available space for the double columns -- the normal
4614 % (undoubled) page height minus any material left over from the
4618 \advance\dimen@ by -\ht\partialpage
4620 % box0 will be the left-hand column, box2 the right.
4621 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4622 \onepageout\pagesofar
4624 \penalty\outputpenalty
4627 % Re-output the contents of the output page -- any previous material,
4628 % followed by the two boxes we just split, in box0 and box2.
4632 \hsize = \doublecolumnhsize
4633 \wd0=\hsize \wd2=\hsize
4634 \hbox to\pagewidth{\box0\hfil\box2}%
4637 % All done with double columns.
4638 \def\enddoublecolumns{%
4639 % The following penalty ensures that the page builder is exercised
4640 % _before_ we change the output routine. This is necessary in the
4641 % following situation:
4643 % The last section of the index consists only of a single entry.
4644 % Before this section, \pagetotal is less than \pagegoal, so no
4645 % break occurs before the last section starts. However, the last
4646 % section, consisting of \initial and the single \entry, does not
4647 % fit on the page and has to be broken off. Without the following
4648 % penalty the page builder will not be exercised until \eject
4649 % below, and by that time we'll already have changed the output
4650 % routine to the \balancecolumns version, so the next-to-last
4651 % double-column page will be processed with \balancecolumns, which
4652 % is wrong: The two columns will go to the main vertical list, with
4653 % the broken-off section in the recent contributions. As soon as
4654 % the output routine finishes, TeX starts reconsidering the page
4655 % break. The two columns and the broken-off section both fit on the
4656 % page, because the two columns now take up only half of the page
4657 % goal. When TeX sees \eject from below which follows the final
4658 % section, it invokes the new output routine that we've set after
4659 % \balancecolumns below; \onepageout will try to fit the two columns
4660 % and the final section into the vbox of \pageheight (see
4661 % \pagebody), causing an overfull box.
4663 % Note that glue won't work here, because glue does not exercise the
4664 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4668 % Split the last of the double-column material. Leave it on the
4669 % current page, no automatic page break.
4672 % If we end up splitting too much material for the current page,
4673 % though, there will be another page break right after this \output
4674 % invocation ends. Having called \balancecolumns once, we do not
4675 % want to call it again. Therefore, reset \output to its normal
4676 % definition right away. (We hope \balancecolumns will never be
4677 % called on to balance too much material, but if it is, this makes
4678 % the output somewhat more palatable.)
4679 \global\output = {\onepageout{\pagecontents\PAGE}}%
4682 \endgroup % started in \begindoublecolumns
4684 % \pagegoal was set to the doubled \vsize above, since we restarted
4685 % the current page. We're now back to normal single-column
4686 % typesetting, so reset \pagegoal to the normal \vsize (after the
4687 % \endgroup where \vsize got restored).
4691 % Called at the end of the double column material.
4692 \def\balancecolumns{%
4693 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4695 \advance\dimen@ by \topskip
4696 \advance\dimen@ by-\baselineskip
4697 \divide\dimen@ by 2 % target to split to
4698 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4699 \splittopskip = \topskip
4700 % Loop until we get a decent breakpoint.
4704 \global\setbox3 = \copy0
4705 \global\setbox1 = \vsplit3 to \dimen@
4707 \global\advance\dimen@ by 1pt
4710 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4711 \setbox0=\vbox to\dimen@{\unvbox1}%
4712 \setbox2=\vbox to\dimen@{\unvbox3}%
4716 \catcode`\@ = \other
4719 \message{sectioning,}
4720 % Chapters, sections, etc.
4722 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4723 % sections so that we can refer to them unambiguously in the pdf
4724 % outlines by their "section number". We avoid collisions with chapter
4725 % numbers by starting them at 10000. (If a document ever has 10000
4726 % chapters, we're in trouble anyway, I'm sure.)
4727 \newcount\unnumberedno \unnumberedno = 10000
4729 \newcount\secno \secno=0
4730 \newcount\subsecno \subsecno=0
4731 \newcount\subsubsecno \subsubsecno=0
4733 % This counter is funny since it counts through charcodes of letters A, B, ...
4734 \newcount\appendixno \appendixno = `\@
4736 % \def\appendixletter{\char\the\appendixno}
4737 % We do the following ugly conditional instead of the above simple
4738 % construct for the sake of pdftex, which needs the actual
4739 % letter in the expansion, not just typeset.
4741 \def\appendixletter{%
4742 \ifnum\appendixno=`A A%
4743 \else\ifnum\appendixno=`B B%
4744 \else\ifnum\appendixno=`C C%
4745 \else\ifnum\appendixno=`D D%
4746 \else\ifnum\appendixno=`E E%
4747 \else\ifnum\appendixno=`F F%
4748 \else\ifnum\appendixno=`G G%
4749 \else\ifnum\appendixno=`H H%
4750 \else\ifnum\appendixno=`I I%
4751 \else\ifnum\appendixno=`J J%
4752 \else\ifnum\appendixno=`K K%
4753 \else\ifnum\appendixno=`L L%
4754 \else\ifnum\appendixno=`M M%
4755 \else\ifnum\appendixno=`N N%
4756 \else\ifnum\appendixno=`O O%
4757 \else\ifnum\appendixno=`P P%
4758 \else\ifnum\appendixno=`Q Q%
4759 \else\ifnum\appendixno=`R R%
4760 \else\ifnum\appendixno=`S S%
4761 \else\ifnum\appendixno=`T T%
4762 \else\ifnum\appendixno=`U U%
4763 \else\ifnum\appendixno=`V V%
4764 \else\ifnum\appendixno=`W W%
4765 \else\ifnum\appendixno=`X X%
4766 \else\ifnum\appendixno=`Y Y%
4767 \else\ifnum\appendixno=`Z Z%
4768 % The \the is necessary, despite appearances, because \appendixletter is
4769 % expanded while writing the .toc file. \char\appendixno is not
4770 % expandable, thus it is written literally, thus all appendixes come out
4771 % with the same letter (or @) in the toc without it.
4772 \else\char\the\appendixno
4773 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4774 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4776 % Each @chapter defines these (using marks) as the number+name, number
4777 % and name of the chapter. Page headings and footings can use
4778 % these. @section does likewise.
4780 \def\thischapternum{}
4781 \def\thischaptername{}
4783 \def\thissectionnum{}
4784 \def\thissectionname{}
4786 \newcount\absseclevel % used to calculate proper heading level
4787 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4789 % @raisesections: treat @section as chapter, @subsection as section, etc.
4790 \def\raisesections{\global\advance\secbase by -1}
4791 \let\up=\raisesections % original BFox name
4793 % @lowersections: treat @chapter as section, @section as subsection, etc.
4794 \def\lowersections{\global\advance\secbase by 1}
4795 \let\down=\lowersections % original BFox name
4797 % we only have subsub.
4798 \chardef\maxseclevel = 3
4800 % A numbered section within an unnumbered changes to unnumbered too.
4801 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4802 \chardef\unmlevel = \maxseclevel
4804 % Trace whether the current chapter is an appendix or not:
4805 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4806 \def\chapheadtype{N}
4808 % Choose a heading macro
4809 % #1 is heading type
4810 % #2 is heading level
4811 % #3 is text for heading
4812 \def\genhead#1#2#3{%
4813 % Compute the abs. sec. level:
4815 \advance\absseclevel by \secbase
4816 % Make sure \absseclevel doesn't fall outside the range:
4817 \ifnum \absseclevel < 0
4820 \ifnum \absseclevel > 3
4827 \ifnum \absseclevel < \unmlevel
4828 \chardef\unmlevel = \absseclevel
4831 % Check for appendix sections:
4832 \ifnum \absseclevel = 0
4833 \edef\chapheadtype{\headtype}%
4835 \if \headtype A\if \chapheadtype N%
4836 \errmessage{@appendix... within a non-appendix chapter}%
4839 % Check for numbered within unnumbered:
4840 \ifnum \absseclevel > \unmlevel
4843 \chardef\unmlevel = 3
4846 % Now print the heading:
4850 \or \unnumberedseczzz{#3}%
4851 \or \unnumberedsubseczzz{#3}%
4852 \or \unnumberedsubsubseczzz{#3}%
4858 \or \appendixsectionzzz{#3}%
4859 \or \appendixsubseczzz{#3}%
4860 \or \appendixsubsubseczzz{#3}%
4866 \or \numberedsubseczzz{#3}%
4867 \or \numberedsubsubseczzz{#3}%
4871 \suppressfirstparagraphindent
4875 \def\numhead{\genhead N}
4876 \def\apphead{\genhead A}
4877 \def\unnmhead{\genhead U}
4879 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4880 % all lower-level sectioning counters to zero.
4882 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4883 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4884 \let\chaplevelprefix = \empty
4886 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4888 % section resetting is \global in case the chapter is in a group, such
4889 % as an @include file.
4890 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4891 \global\advance\chapno by 1
4894 \gdef\chaplevelprefix{\the\chapno.}%
4897 \message{\putwordChapter\space \the\chapno}%
4899 % Write the actual heading.
4900 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4902 % So @section and the like are numbered underneath this chapter.
4903 \global\let\section = \numberedsec
4904 \global\let\subsection = \numberedsubsec
4905 \global\let\subsubsection = \numberedsubsubsec
4908 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4909 \def\appendixzzz#1{%
4910 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4911 \global\advance\appendixno by 1
4912 \gdef\chaplevelprefix{\appendixletter.}%
4915 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4916 \message{\appendixnum}%
4918 \chapmacro{#1}{Yappendix}{\appendixletter}%
4920 \global\let\section = \appendixsec
4921 \global\let\subsection = \appendixsubsec
4922 \global\let\subsubsection = \appendixsubsubsec
4925 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4926 \def\unnumberedzzz#1{%
4927 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4928 \global\advance\unnumberedno by 1
4930 % Since an unnumbered has no number, no prefix for figures.
4931 \global\let\chaplevelprefix = \empty
4934 % This used to be simply \message{#1}, but TeX fully expands the
4935 % argument to \message. Therefore, if #1 contained @-commands, TeX
4936 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4937 % expanded @cite (which turns out to cause errors because \cite is meant
4938 % to be executed, not expanded).
4940 % Anyway, we don't want the fully-expanded definition of @cite to appear
4941 % as a result of the \message, we just want `@cite' itself. We use
4942 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4943 % simply yielding the contents of <toks register>. (We also do this for
4946 \message{(\the\toks0)}%
4948 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4950 \global\let\section = \unnumberedsec
4951 \global\let\subsection = \unnumberedsubsec
4952 \global\let\subsubsection = \unnumberedsubsubsec
4955 % @centerchap is like @unnumbered, but the heading is centered.
4956 \outer\parseargdef\centerchap{%
4957 % Well, we could do the following in a group, but that would break
4958 % an assumption that \chapmacro is called at the outermost level.
4959 % Thus we are safer this way: --kasal, 24feb04
4960 \let\centerparametersmaybe = \centerparameters
4962 \let\centerparametersmaybe = \relax
4965 % @top is like @unnumbered.
4969 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4971 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4972 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4975 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4976 \def\appendixsectionzzz#1{%
4977 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4978 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4980 \let\appendixsec\appendixsection
4982 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4983 \def\unnumberedseczzz#1{%
4984 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4985 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4989 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4990 \def\numberedsubseczzz#1{%
4991 \global\subsubsecno=0 \global\advance\subsecno by 1
4992 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4995 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4996 \def\appendixsubseczzz#1{%
4997 \global\subsubsecno=0 \global\advance\subsecno by 1
4998 \sectionheading{#1}{subsec}{Yappendix}%
4999 {\appendixletter.\the\secno.\the\subsecno}%
5002 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5003 \def\unnumberedsubseczzz#1{%
5004 \global\subsubsecno=0 \global\advance\subsecno by 1
5005 \sectionheading{#1}{subsec}{Ynothing}%
5006 {\the\unnumberedno.\the\secno.\the\subsecno}%
5010 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5011 \def\numberedsubsubseczzz#1{%
5012 \global\advance\subsubsecno by 1
5013 \sectionheading{#1}{subsubsec}{Ynumbered}%
5014 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5017 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5018 \def\appendixsubsubseczzz#1{%
5019 \global\advance\subsubsecno by 1
5020 \sectionheading{#1}{subsubsec}{Yappendix}%
5021 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5024 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5025 \def\unnumberedsubsubseczzz#1{%
5026 \global\advance\subsubsecno by 1
5027 \sectionheading{#1}{subsubsec}{Ynothing}%
5028 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5031 % These macros control what the section commands do, according
5032 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5033 % Define them by default for a numbered chapter.
5034 \let\section = \numberedsec
5035 \let\subsection = \numberedsubsec
5036 \let\subsubsection = \numberedsubsubsec
5038 % Define @majorheading, @heading and @subheading
5040 % NOTE on use of \vbox for chapter headings, section headings, and such:
5041 % 1) We use \vbox rather than the earlier \line to permit
5042 % overlong headings to fold.
5043 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5044 % heading is obnoxious; this forbids it.
5045 % 3) Likewise, headings look best if no \parindent is used, and
5046 % if justification is not attempted. Hence \raggedright.
5050 {\advance\chapheadingskip by 10pt \chapbreak }%
5051 \parsearg\chapheadingzzz
5054 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5055 \def\chapheadingzzz#1{%
5056 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5057 \parindent=0pt\raggedright
5059 \bigskip \par\penalty 200\relax
5060 \suppressfirstparagraphindent
5063 % @heading, @subheading, @subsubheading.
5064 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5065 \suppressfirstparagraphindent}
5066 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5067 \suppressfirstparagraphindent}
5068 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5069 \suppressfirstparagraphindent}
5071 % These macros generate a chapter, section, etc. heading only
5072 % (including whitespace, linebreaking, etc. around it),
5073 % given all the information in convenient, parsed form.
5075 %%% Args are the skip and penalty (usually negative)
5076 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5078 %%% Define plain chapter starts, and page on/off switching for it
5079 % Parameter controlling skip before chapter headings (if needed)
5081 \newskip\chapheadingskip
5083 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5084 \def\chappager{\par\vfill\supereject}
5085 % Because \domark is called before \chapoddpage, the filler page will
5086 % get the headings for the next chapter, which is wrong. But we don't
5087 % care -- we just disable all headings on the filler page.
5092 \evenheadline={\hfil}\evenfootline={\hfil}%
5093 \oddheadline={\hfil}\oddfootline={\hfil}%
5100 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5103 \global\let\contentsalignmacro = \chappager
5104 \global\let\pchapsepmacro=\chapbreak
5105 \global\let\pagealignmacro=\chappager}
5108 \global\let\contentsalignmacro = \chappager
5109 \global\let\pchapsepmacro=\chappager
5110 \global\let\pagealignmacro=\chappager
5111 \global\def\HEADINGSon{\HEADINGSsingle}}
5114 \global\let\contentsalignmacro = \chapoddpage
5115 \global\let\pchapsepmacro=\chapoddpage
5116 \global\let\pagealignmacro=\chapoddpage
5117 \global\def\HEADINGSon{\HEADINGSdouble}}
5123 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5124 % Yappendix, Yomitfromtoc), #3 the chapter number.
5126 % To test against our argument.
5127 \def\Ynothingkeyword{Ynothing}
5128 \def\Yomitfromtockeyword{Yomitfromtoc}
5129 \def\Yappendixkeyword{Yappendix}
5131 \def\chapmacro#1#2#3{%
5132 % Insert the first mark before the heading break (see notes for \domark).
5133 \let\prevchapterdefs=\lastchapterdefs
5134 \let\prevsectiondefs=\lastsectiondefs
5135 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5136 \gdef\thissection{}}%
5139 \ifx\temptype\Ynothingkeyword
5140 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5141 \gdef\thischapter{\thischaptername}}%
5142 \else\ifx\temptype\Yomitfromtockeyword
5143 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5144 \gdef\thischapter{}}%
5145 \else\ifx\temptype\Yappendixkeyword
5147 \xdef\lastchapterdefs{%
5148 \gdef\noexpand\thischaptername{\the\toks0}%
5149 \gdef\noexpand\thischapternum{\appendixletter}%
5150 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5151 \noexpand\thischaptername}%
5155 \xdef\lastchapterdefs{%
5156 \gdef\noexpand\thischaptername{\the\toks0}%
5157 \gdef\noexpand\thischapternum{\the\chapno}%
5158 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5159 \noexpand\thischaptername}%
5163 % Output the mark. Pass it through \safewhatsit, to take care of
5164 % the preceding space.
5167 % Insert the chapter heading break.
5170 % Now the second mark, after the heading break. No break points
5171 % between here and the heading.
5172 \let\prevchapterdefs=\lastchapterdefs
5173 \let\prevsectiondefs=\lastsectiondefs
5179 % Have to define \lastsection before calling \donoderef, because the
5180 % xref code eventually uses it. On the other hand, it has to be called
5181 % after \pchapsepmacro, or the headline will change too soon.
5182 \gdef\lastsection{#1}%
5184 % Only insert the separating space if we have a chapter/appendix
5185 % number, and don't print the unnumbered ``number''.
5186 \ifx\temptype\Ynothingkeyword
5188 \def\toctype{unnchap}%
5189 \else\ifx\temptype\Yomitfromtockeyword
5190 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5192 \else\ifx\temptype\Yappendixkeyword
5193 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5196 \setbox0 = \hbox{#3\enspace}%
5197 \def\toctype{numchap}%
5200 % Write the toc entry for this chapter. Must come before the
5201 % \donoderef, because we include the current node name in the toc
5202 % entry, and \donoderef resets it to empty.
5203 \writetocentry{\toctype}{#1}{#3}%
5205 % For pdftex, we have to write out the node definition (aka, make
5206 % the pdfdest) after any page break, but before the actual text has
5207 % been typeset. If the destination for the pdf outline is after the
5208 % text, then jumping from the outline may wind up with the text not
5209 % being visible, for instance under high magnification.
5212 % Typeset the actual heading.
5213 \nobreak % Avoid page breaks at the interline glue.
5214 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5215 \hangindent=\wd0 \centerparametersmaybe
5218 \nobreak\bigskip % no page break after a chapter title
5222 % @centerchap -- centered and unnumbered.
5223 \let\centerparametersmaybe = \relax
5224 \def\centerparameters{%
5225 \advance\rightskip by 3\rightskip
5226 \leftskip = \rightskip
5231 % I don't think this chapter style is supported any more, so I'm not
5232 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5234 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5236 \def\unnchfopen #1{%
5237 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5238 \parindent=0pt\raggedright
5239 \rm #1\hfill}}\bigskip \par\nobreak
5241 \def\chfopen #1#2{\chapoddpage {\chapfonts
5242 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5245 \def\centerchfopen #1{%
5246 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5248 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5251 \global\let\chapmacro=\chfopen
5252 \global\let\centerchapmacro=\centerchfopen}
5255 % Section titles. These macros combine the section number parts and
5256 % call the generic \sectionheading to do the printing.
5258 \newskip\secheadingskip
5259 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5261 % Subsection titles.
5262 \newskip\subsecheadingskip
5263 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5265 % Subsubsection titles.
5266 \def\subsubsecheadingskip{\subsecheadingskip}
5267 \def\subsubsecheadingbreak{\subsecheadingbreak}
5270 % Print any size, any type, section title.
5272 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5273 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5276 \def\seckeyword{sec}
5278 \def\sectionheading#1#2#3#4{%
5280 % Switch to the right set of fonts.
5281 \csname #2fonts\endcsname \rm
5283 \def\sectionlevel{#2}%
5286 % Insert first mark before the heading break (see notes for \domark).
5287 \let\prevsectiondefs=\lastsectiondefs
5288 \ifx\temptype\Ynothingkeyword
5289 \ifx\sectionlevel\seckeyword
5290 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5291 \gdef\thissection{\thissectionname}}%
5293 \else\ifx\temptype\Yomitfromtockeyword
5294 % Don't redefine \thissection.
5295 \else\ifx\temptype\Yappendixkeyword
5296 \ifx\sectionlevel\seckeyword
5298 \xdef\lastsectiondefs{%
5299 \gdef\noexpand\thissectionname{\the\toks0}%
5300 \gdef\noexpand\thissectionnum{#4}%
5301 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5302 \noexpand\thissectionname}%
5306 \ifx\sectionlevel\seckeyword
5308 \xdef\lastsectiondefs{%
5309 \gdef\noexpand\thissectionname{\the\toks0}%
5310 \gdef\noexpand\thissectionnum{#4}%
5311 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5312 \noexpand\thissectionname}%
5317 % Output the mark. Pass it through \safewhatsit, to take care of
5318 % the preceding space.
5321 % Insert space above the heading.
5322 \csname #2headingbreak\endcsname
5324 % Now the second mark, after the heading break. No break points
5325 % between here and the heading.
5326 \let\prevsectiondefs=\lastsectiondefs
5329 % Only insert the space after the number if we have a section number.
5330 \ifx\temptype\Ynothingkeyword
5333 \gdef\lastsection{#1}%
5334 \else\ifx\temptype\Yomitfromtockeyword
5335 % for @headings -- no section number, don't include in toc,
5336 % and don't redefine \lastsection.
5339 \let\sectionlevel=\empty
5340 \else\ifx\temptype\Yappendixkeyword
5341 \setbox0 = \hbox{#4\enspace}%
5343 \gdef\lastsection{#1}%
5345 \setbox0 = \hbox{#4\enspace}%
5347 \gdef\lastsection{#1}%
5350 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5351 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5353 % Write the node reference (= pdf destination for pdftex).
5354 % Again, see comments in \chapmacro.
5357 % Interline glue will be inserted when the vbox is completed.
5358 % That glue will be a valid breakpoint for the page, since it'll be
5359 % preceded by a whatsit (usually from the \donoderef, or from the
5360 % \writetocentry if there was no node). We don't want to allow that
5361 % break, since then the whatsits could end up on page n while the
5362 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5365 % Output the actual section heading.
5366 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5367 \hangindent=\wd0 % zero if no section number
5370 % Add extra space after the heading -- half of whatever came above it.
5371 % Don't allow stretch, though.
5372 \kern .5 \csname #2headingskip\endcsname
5374 % Do not let the kern be a potential breakpoint, as it would be if it
5375 % was followed by glue.
5378 % We'll almost certainly start a paragraph next, so don't let that
5379 % glue accumulate. (Not a breakpoint because it's preceded by a
5380 % discardable item.)
5383 % This is purely so the last item on the list is a known \penalty >
5384 % 10000. This is so \startdefun can avoid allowing breakpoints after
5385 % section headings. Otherwise, it would insert a valid breakpoint between:
5387 % @section sec-whatever
5388 % @deffn def-whatever
5394 % Table of contents.
5397 % Write an entry to the toc file, opening it if necessary.
5398 % Called from @chapter, etc.
5400 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5401 % We append the current node name (if any) and page number as additional
5402 % arguments for the \{chap,sec,...}entry macros which will eventually
5403 % read this. The node name is used in the pdf outlines as the
5404 % destination to jump to.
5406 % We open the .toc file for writing here instead of at @setfilename (or
5407 % any other fixed time) so that @contents can be anywhere in the document.
5408 % But if #1 is `omit', then we don't do anything. This is used for the
5409 % table of contents chapter openings themselves.
5411 \newif\iftocfileopened
5412 \def\omitkeyword{omit}%
5414 \def\writetocentry#1#2#3{%
5415 \edef\writetoctype{#1}%
5416 \ifx\writetoctype\omitkeyword \else
5417 \iftocfileopened\else
5418 \immediate\openout\tocfile = \jobname.toc
5419 \global\tocfileopenedtrue
5425 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5431 % Tell \shipout to create a pdf destination on each page, if we're
5432 % writing pdf. These are used in the table of contents. We can't
5433 % just write one on every page because the title pages are numbered
5434 % 1 and 2 (the page numbers aren't printed), and so are the first
5435 % two pages of the document. Thus, we'd have two destinations named
5436 % `1', and two named `2'.
5437 \ifpdf \global\pdfmakepagedesttrue \fi
5441 % These characters do not print properly in the Computer Modern roman
5442 % fonts, so we must take special care. This is more or less redundant
5443 % with the Texinfo input format setup at the end of this file.
5445 \def\activecatcodes{%
5458 % Read the toc file, which is essentially Texinfo input.
5462 \input \tocreadfilename
5465 \newskip\contentsrightmargin \contentsrightmargin=1in
5466 \newcount\savepageno
5467 \newcount\lastnegativepageno \lastnegativepageno = -1
5469 % Prepare to read what we've written to \tocfile.
5471 \def\startcontents#1{%
5472 % If @setchapternewpage on, and @headings double, the contents should
5473 % start on an odd page, unlike chapters. Thus, we maintain
5474 % \contentsalignmacro in parallel with \pagealignmacro.
5475 % From: Torbjorn Granlund <tege@matematik.su.se>
5477 \immediate\closeout\tocfile
5479 % Don't need to put `Contents' or `Short Contents' in the headline.
5480 % It is abundantly clear what they are.
5481 \chapmacro{#1}{Yomitfromtoc}{}%
5483 \savepageno = \pageno
5484 \begingroup % Set up to handle contents files properly.
5485 \raggedbottom % Worry more about breakpoints than the bottom.
5486 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5488 % Roman numerals for page numbers.
5489 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5492 % redefined for the two-volume lispref. We always output on
5493 % \jobname.toc even if this is redefined.
5495 \def\tocreadfilename{\jobname.toc}
5497 % Normal (long) toc.
5500 \startcontents{\putwordTOC}%
5501 \openin 1 \tocreadfilename\space
5506 \contentsalignmacro % in case @setchapternewpage odd is in effect
5512 \lastnegativepageno = \pageno
5513 \global\pageno = \savepageno
5516 % And just the chapters.
5517 \def\summarycontents{%
5518 \startcontents{\putwordShortTOC}%
5520 \let\numchapentry = \shortchapentry
5521 \let\appentry = \shortchapentry
5522 \let\unnchapentry = \shortunnchapentry
5523 % We want a true roman here for the page numbers.
5525 \let\rm=\shortcontrm \let\bf=\shortcontbf
5526 \let\sl=\shortcontsl \let\tt=\shortconttt
5528 \hyphenpenalty = 10000
5529 \advance\baselineskip by 1pt % Open it up a little.
5530 \def\numsecentry##1##2##3##4{}
5531 \let\appsecentry = \numsecentry
5532 \let\unnsecentry = \numsecentry
5533 \let\numsubsecentry = \numsecentry
5534 \let\appsubsecentry = \numsecentry
5535 \let\unnsubsecentry = \numsecentry
5536 \let\numsubsubsecentry = \numsecentry
5537 \let\appsubsubsecentry = \numsecentry
5538 \let\unnsubsubsecentry = \numsecentry
5539 \openin 1 \tocreadfilename\space
5545 \contentsalignmacro % in case @setchapternewpage odd is in effect
5547 \lastnegativepageno = \pageno
5548 \global\pageno = \savepageno
5550 \let\shortcontents = \summarycontents
5552 % Typeset the label for a chapter or appendix for the short contents.
5553 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5555 \def\shortchaplabel#1{%
5556 % This space should be enough, since a single number is .5em, and the
5557 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5558 % But use \hss just in case.
5559 % (This space doesn't include the extra space that gets added after
5560 % the label; that gets put in by \shortchapentry above.)
5562 % We'd like to right-justify chapter numbers, but that looks strange
5563 % with appendix letters. And right-justifying numbers and
5564 % left-justifying letters looks strange when there is less than 10
5565 % chapters. Have to read the whole toc once to know how many chapters
5566 % there are before deciding ...
5567 \hbox to 1em{#1\hss}%
5570 % These macros generate individual entries in the table of contents.
5571 % The first argument is the chapter or section name.
5572 % The last argument is the page number.
5573 % The arguments in between are the chapter number, section number, ...
5575 % Chapters, in the main contents.
5576 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5578 % Chapters, in the short toc.
5579 % See comments in \dochapentry re vbox and related settings.
5580 \def\shortchapentry#1#2#3#4{%
5581 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5584 % Appendices, in the main contents.
5585 % Need the word Appendix, and a fixed-size box.
5587 \def\appendixbox#1{%
5588 % We use M since it's probably the widest letter.
5589 \setbox0 = \hbox{\putwordAppendix{} M}%
5590 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5592 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5594 % Unnumbered chapters.
5595 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5596 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5599 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5600 \let\appsecentry=\numsecentry
5601 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5604 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5605 \let\appsubsecentry=\numsubsecentry
5606 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5608 % And subsubsections.
5609 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5610 \let\appsubsubsecentry=\numsubsubsecentry
5611 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5613 % This parameter controls the indentation of the various levels.
5614 % Same as \defaultparindent.
5615 \newdimen\tocindent \tocindent = 15pt
5617 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5620 % If the toc has to be broken over pages, we want it to be at chapters
5621 % if at all possible; hence the \penalty.
5622 \def\dochapentry#1#2{%
5623 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5626 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5628 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5631 \def\dosecentry#1#2{\begingroup
5632 \secentryfonts \leftskip=\tocindent
5633 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5636 \def\dosubsecentry#1#2{\begingroup
5637 \subsecentryfonts \leftskip=2\tocindent
5638 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5641 \def\dosubsubsecentry#1#2{\begingroup
5642 \subsubsecentryfonts \leftskip=3\tocindent
5643 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5646 % We use the same \entry macro as for the index entries.
5647 \let\tocentry = \entry
5649 % Space between chapter (or whatever) number and the title.
5650 \def\labelspace{\hskip1em \relax}
5652 \def\dopageno#1{{\rm #1}}
5653 \def\doshortpageno#1{{\rm #1}}
5655 \def\chapentryfonts{\secfonts \rm}
5656 \def\secentryfonts{\textfonts}
5657 \def\subsecentryfonts{\textfonts}
5658 \def\subsubsecentryfonts{\textfonts}
5661 \message{environments,}
5662 % @foo ... @end foo.
5664 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5666 % Since these characters are used in examples, they should be an even number of
5667 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5670 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5671 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5672 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5673 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5674 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5676 % The @error{} command.
5677 % Adapted from the TeXbook's \boxit.
5681 {\tentt \global\dimen0 = 3em}% Width of the box.
5682 \dimen2 = .55pt % Thickness of rules
5683 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5684 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5686 \setbox\errorbox=\hbox to \dimen0{\hfil
5687 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5688 \advance\hsize by -2\dimen2 % Rules.
5690 \hrule height\dimen2
5691 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5692 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5693 \kern3pt\vrule width\dimen2}% Space to right.
5694 \hrule height\dimen2}
5697 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5699 % @tex ... @end tex escapes into raw Tex temporarily.
5700 % One exception: @ is still an escape character, so that @end tex works.
5701 % But \@ or @@ will get a plain tex @ character.
5704 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5705 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5706 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5716 \let\bullet=\ptexbullet
5721 \let\equiv=\ptexequiv
5724 \let\indent=\ptexindent
5725 \let\noindent=\ptexnoindent
5732 \expandafter \let\csname top\endcsname=\ptextop % outer
5733 \let\frenchspacing=\plainfrenchspacing
5735 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5736 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5739 % There is no need to define \Etex.
5741 % Define @lisp ... @end lisp.
5742 % @lisp environment forms a group so it can rebind things,
5743 % including the definition of @end lisp (which normally is erroneous).
5745 % Amount to narrow the margins by for @lisp.
5746 \newskip\lispnarrowing \lispnarrowing=0.4in
5748 % This is the definition that ^^M gets inside @lisp, @example, and other
5749 % such environments. \null is better than a space, since it doesn't
5751 \def\lisppar{\null\endgraf}
5753 % This space is always present above and below environments.
5754 \newskip\envskipamount \envskipamount = 0pt
5756 % Make spacing and below environment symmetrical. We use \parskip here
5757 % to help in doing that, since in @example-like environments \parskip
5758 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5759 % start of the next paragraph will insert \parskip.
5761 \def\aboveenvbreak{{%
5762 % =10000 instead of <10000 because of a special case in \itemzzz and
5763 % \sectionheading, q.v.
5764 \ifnum \lastpenalty=10000 \else
5765 \advance\envskipamount by \parskip
5767 \ifdim\lastskip<\envskipamount
5769 % it's not a good place to break if the last penalty was \nobreak
5771 \ifnum\lastpenalty<10000 \penalty-50 \fi
5772 \vskip\envskipamount
5777 \let\afterenvbreak = \aboveenvbreak
5779 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5780 % also clear it, so that its embedded environments do the narrowing again.
5781 \let\nonarrowing=\relax
5783 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5784 % environment contents.
5785 \font\circle=lcircle10
5787 \newdimen\cartouter\newdimen\cartinner
5788 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5789 \circthick=\fontdimen8\circle
5791 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5792 \def\ctr{{\hskip 6pt\circle\char'010}}
5793 \def\cbl{{\circle\char'012\hskip -6pt}}
5794 \def\cbr{{\hskip 6pt\circle\char'011}}
5795 \def\carttop{\hbox to \cartouter{\hskip\lskip
5796 \ctl\leaders\hrule height\circthick\hfil\ctr
5798 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5799 \cbl\leaders\hrule height\circthick\hfil\cbr
5802 \newskip\lskip\newskip\rskip
5805 \ifhmode\par\fi % can't be in the midst of a paragraph.
5807 \lskip=\leftskip \rskip=\rightskip
5808 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5809 \cartinner=\hsize \advance\cartinner by-\lskip
5810 \advance\cartinner by-\rskip
5812 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5813 % side, and for 6pt waste from
5814 % each corner char, and rule thickness
5815 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5816 % Flag to tell @lisp, etc., not to narrow margin.
5817 \let\nonarrowing = t%
5819 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5827 \baselineskip=\normbskip
5828 \lineskip=\normlskip
5831 \comment % For explanation, see the end of \def\group.
5846 % This macro is called at the beginning of all the @example variants,
5850 \hfuzz = 12pt % Don't be fussy
5851 \sepspaces % Make spaces be word-separators rather than space tokens.
5852 \let\par = \lisppar % don't ignore blank lines
5853 \obeylines % each line of input is a line of output
5856 \emergencystretch = 0pt % don't try to avoid overfull boxes
5857 \ifx\nonarrowing\relax
5858 \advance \leftskip by \lispnarrowing
5859 \exdentamount=\lispnarrowing
5861 \let\nonarrowing = \relax
5863 \let\exdent=\nofillexdent
5866 % If you want all examples etc. small: @set dispenvsize small.
5867 % If you want even small examples the full size: @set dispenvsize nosmall.
5868 % This affects the following displayed environments:
5869 % @example, @display, @format, @lisp
5871 \def\smallword{small}
5872 \def\nosmallword{nosmall}
5873 \let\SETdispenvsize\relax
5874 \def\setnormaldispenv{%
5875 \ifx\SETdispenvsize\smallword
5876 % end paragraph for sake of leading, in case document has no blank
5877 % line. This is redundant with what happens in \aboveenvbreak, but
5878 % we need to do it before changing the fonts, and it's inconvenient
5879 % to change the fonts afterward.
5880 \ifnum \lastpenalty=10000 \else \endgraf \fi
5881 \smallexamplefonts \rm
5884 \def\setsmalldispenv{%
5885 \ifx\SETdispenvsize\nosmallword
5887 \ifnum \lastpenalty=10000 \else \endgraf \fi
5888 \smallexamplefonts \rm
5892 % We often define two environments, @foo and @smallfoo.
5893 % Let's do it by one command:
5894 \def\makedispenv #1#2{
5895 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5896 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5897 \expandafter\let\csname E#1\endcsname \afterenvbreak
5898 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5901 % Define two synonyms:
5902 \def\maketwodispenvs #1#2#3{
5903 \makedispenv{#1}{#3}
5904 \makedispenv{#2}{#3}
5907 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5909 % @smallexample and @smalllisp: use smaller fonts.
5910 % Originally contributed by Pavel@xerox.
5912 \maketwodispenvs {lisp}{example}{%
5915 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5916 \gobble % eat return
5918 % @display/@smalldisplay: same as @lisp except keep current font.
5920 \makedispenv {display}{%
5925 % @format/@smallformat: same as @display except don't narrow margins.
5927 \makedispenv{format}{%
5928 \let\nonarrowing = t%
5933 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5935 \let\nonarrowing = t%
5939 \let\Eflushleft = \afterenvbreak
5943 \envdef\flushright{%
5944 \let\nonarrowing = t%
5946 \advance\leftskip by 0pt plus 1fill
5949 \let\Eflushright = \afterenvbreak
5952 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5953 % and narrows the margins. We keep \parskip nonzero in general, since
5954 % we're doing normal filling. So, when using \aboveenvbreak and
5955 % \afterenvbreak, temporarily make \parskip 0.
5958 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5961 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5962 \ifx\nonarrowing\relax
5963 \advance\leftskip by \lispnarrowing
5964 \advance\rightskip by \lispnarrowing
5965 \exdentamount = \lispnarrowing
5967 \let\nonarrowing = \relax
5969 \parsearg\quotationlabel
5972 % We have retained a nonzero parskip for the environment, since we're
5973 % doing normal filling.
5977 \ifx\quotationauthor\undefined\else
5979 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5981 {\parskip=0pt \afterenvbreak}%
5984 % If we're given an argument, typeset it in bold with a colon after.
5985 \def\quotationlabel#1{%
5987 \ifx\temp\empty \else
5993 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5994 % If we want to allow any <char> as delimiter,
5995 % we need the curly braces so that makeinfo sees the @verb command, eg:
5996 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5998 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6000 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6001 % active too. Otherwise, they get lost as the first character on a
6004 \do\ \do\\\do\{\do\}\do\$\do\&%
6005 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6006 \do\<\do\>\do\|\do\@\do+\do\"%
6010 \def\uncatcodespecials{%
6011 \def\do##1{\catcode`##1=\other}\dospecials}
6013 % [Knuth] pp. 380,381,391
6014 % Disable Spanish ligatures ?` and !` of \tt font
6016 \catcode`\`=\active\gdef`{\relax\lq}
6019 % Setup for the @verb command.
6021 % Eight spaces for a tab
6023 \catcode`\^^I=\active
6024 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6028 \tt % easiest (and conventionally used) font for verbatim
6029 \def\par{\leavevmode\endgraf}%
6032 % Respect line breaks,
6033 % print special symbols as themselves, and
6034 % make each space count
6035 % must do in this order:
6036 \obeylines \uncatcodespecials \sepspaces
6039 % Setup for the @verbatim environment
6041 % Real tab expansion
6042 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6044 \def\starttabbox{\setbox0=\hbox\bgroup}
6046 % Allow an option to not replace quotes with a regular directed right
6047 % quote/apostrophe (char 0x27), but instead use the undirected quote
6048 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
6049 % the default, but it works for pasting with more pdf viewers (at least
6050 % evince), the lilypond developers report. xpdf does work with the
6053 \def\codequoteright{%
6054 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6055 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6061 % and a similar option for the left quote char vs. a grave accent.
6062 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6063 % the code environments to do likewise.
6065 \def\codequoteleft{%
6066 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6067 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6074 \catcode`\^^I=\active
6076 \catcode`\^^I=\active
6077 \def^^I{\leavevmode\egroup
6078 \dimen0=\wd0 % the width so far, or since the previous tab
6079 \divide\dimen0 by\tabw
6080 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6081 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6082 \wd0=\dimen0 \box0 \starttabbox
6086 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6089 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6091 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6094 % start the verbatim environment.
6095 \def\setupverbatim{%
6096 \let\nonarrowing = t%
6098 % Easiest (and conventionally used) font for verbatim
6100 \def\par{\leavevmode\egroup\box0\endgraf}%
6104 % Respect line breaks,
6105 % print special symbols as themselves, and
6106 % make each space count
6107 % must do in this order:
6108 \obeylines \uncatcodespecials \sepspaces
6109 \everypar{\starttabbox}%
6112 % Do the @verb magic: verbatim text is quoted by unique
6113 % delimiter characters. Before first delimiter expect a
6114 % right brace, after last delimiter expect closing brace:
6116 % \def\doverb'{'<char>#1<char>'}'{#1}
6118 % [Knuth] p. 382; only eat outer {}
6120 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6121 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6124 \def\verb{\begingroup\setupverb\doverb}
6127 % Do the @verbatim magic: define the macro \doverbatim so that
6128 % the (first) argument ends when '@end verbatim' is reached, ie:
6130 % \def\doverbatim#1@end verbatim{#1}
6132 % For Texinfo it's a lot easier than for LaTeX,
6133 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6134 % we need not redefine '\', '{' and '}'.
6136 % Inspired by LaTeX's verbatim command set [latex.ltx]
6141 % ignore everything up to the first ^^M, that's the newline at the end
6142 % of the @verbatim input line itself. Otherwise we get an extra blank
6143 % line in the output.
6144 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6145 % We really want {...\end verbatim} in the body of the macro, but
6146 % without the active space; thus we have to use \xdef and \gobble.
6150 \setupverbatim\doverbatim
6152 \let\Everbatim = \afterenvbreak
6155 % @verbatiminclude FILE - insert text of file in verbatim environment.
6157 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6159 \def\doverbatiminclude#1{%
6161 \makevalueexpandable
6168 % @copying ... @end copying.
6169 % Save the text away for @insertcopying later.
6171 % We save the uninterpreted tokens, rather than creating a box.
6172 % Saving the text in a box would be much easier, but then all the
6173 % typesetting commands (@smallbook, font changes, etc.) have to be done
6174 % beforehand -- and a) we want @copying to be done first in the source
6175 % file; b) letting users define the frontmatter in as flexible order as
6176 % possible is very desirable.
6178 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6179 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6181 \def\insertcopying{%
6183 \parindent = 0pt % paragraph indentation looks wrong on title page
6184 \scanexp\copyingtext
6192 \newskip\defbodyindent \defbodyindent=.4in
6193 \newskip\defargsindent \defargsindent=50pt
6194 \newskip\deflastargmargin \deflastargmargin=18pt
6195 \newcount\defunpenalty
6197 % Start the processing of @deffn:
6199 \ifnum\lastpenalty<10000
6201 \defunpenalty=10003 % Will keep this @deffn together with the
6202 % following @def command, see below.
6204 % If there are two @def commands in a row, we'll have a \nobreak,
6205 % which is there to keep the function description together with its
6206 % header. But if there's nothing but headers, we need to allow a
6207 % break somewhere. Check specifically for penalty 10002, inserted
6208 % by \printdefunline, instead of 10000, since the sectioning
6209 % commands also insert a nobreak penalty, and we don't want to allow
6210 % a break between a section heading and a defun.
6212 % As a minor refinement, we avoid "club" headers by signalling
6213 % with penalty of 10003 after the very first @deffn in the
6214 % sequence (see above), and penalty of 10002 after any following
6216 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6218 % Similarly, after a section heading, do not allow a break.
6219 % But do insert the glue.
6220 \medskip % preceded by discardable penalty, so not a breakpoint
6224 \advance\leftskip by \defbodyindent
6225 \exdentamount=\defbodyindent
6229 % First, check whether we are in the right environment:
6232 % As above, allow line break if we have multiple x headers in a row.
6233 % It's not a great place, though.
6234 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6236 % And now, it's time to reuse the body of the original defun:
6237 \expandafter\gobbledefun#1%
6239 \def\gobbledefun#1\startdefun{}
6241 % \printdefunline \deffnheader{text}
6243 \def\printdefunline#1#2{%
6245 % call \deffnheader:
6248 \interlinepenalty = 10000
6249 \advance\rightskip by 0pt plus 1fil
6251 \nobreak\vskip -\parskip
6252 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6253 % Some of the @defun-type tags do not enable magic parentheses,
6254 % rendering the following check redundant. But we don't optimize.
6259 \def\Edefun{\endgraf\medbreak}
6261 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6262 % the only thing remainnig is to define \deffnheader.
6265 \expandafter\let\csname E#1\endcsname = \Edefun
6266 \edef\temp{\noexpand\domakedefun
6267 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6271 % \domakedefun \deffn \deffnx \deffnheader
6273 % Define \deffn and \deffnx, without parameters.
6274 % \deffnheader has to be defined explicitly.
6276 \def\domakedefun#1#2#3{%
6279 \parseargusing\activeparens{\printdefunline#3}%
6281 \def#2{\dodefunx#1}%
6285 %%% Untyped functions:
6287 % @deffn category name args
6288 \makedefun{deffn}{\deffngeneral{}}
6290 % @deffn category class name args
6291 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6293 % \defopon {category on}class name args
6294 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6296 % \deffngeneral {subind}category name args
6298 \def\deffngeneral#1#2 #3 #4\endheader{%
6299 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6300 \dosubind{fn}{\code{#3}}{#1}%
6301 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6304 %%% Typed functions:
6306 % @deftypefn category type name args
6307 \makedefun{deftypefn}{\deftypefngeneral{}}
6309 % @deftypeop category class type name args
6310 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6312 % \deftypeopon {category on}class type name args
6313 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6315 % \deftypefngeneral {subind}category type name args
6317 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6318 \dosubind{fn}{\code{#4}}{#1}%
6319 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6322 %%% Typed variables:
6324 % @deftypevr category type var args
6325 \makedefun{deftypevr}{\deftypecvgeneral{}}
6327 % @deftypecv category class type var args
6328 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6330 % \deftypecvof {category of}class type var args
6331 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6333 % \deftypecvgeneral {subind}category type var args
6335 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6336 \dosubind{vr}{\code{#4}}{#1}%
6337 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6340 %%% Untyped variables:
6342 % @defvr category var args
6343 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6345 % @defcv category class var args
6346 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6348 % \defcvof {category of}class var args
6349 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6352 % @deftp category name args
6353 \makedefun{deftp}#1 #2 #3\endheader{%
6354 \doind{tp}{\code{#2}}%
6355 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6358 % Remaining @defun-like shortcuts:
6359 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6360 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6361 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6362 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6363 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6364 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6365 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6366 \makedefun{defmethod}{\defopon\putwordMethodon}
6367 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6368 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6369 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6371 % \defname, which formats the name of the @def (not the args).
6372 % #1 is the category, such as "Function".
6373 % #2 is the return type, if any.
6374 % #3 is the function name.
6376 % We are followed by (but not passed) the arguments, if any.
6378 \def\defname#1#2#3{%
6379 % Get the values of \leftskip and \rightskip as they were outside the @def...
6380 \advance\leftskip by -\defbodyindent
6382 % How we'll format the type name. Putting it in brackets helps
6383 % distinguish it from the body text that may end up on the next line
6386 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6388 % Figure out line sizes for the paragraph shape.
6389 % The first line needs space for \box0; but if \rightskip is nonzero,
6390 % we need only space for the part of \box0 which exceeds it:
6391 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6392 % The continuations:
6393 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6394 % (plain.tex says that \dimen1 should be used only as global.)
6395 \parshape 2 0in \dimen0 \defargsindent \dimen2
6397 % Put the type name to the right margin.
6400 \hfil\box0 \kern-\hsize
6401 % \hsize has to be shortened this way:
6403 % Intentionally do not respect \rightskip, since we need the space.
6406 % Allow all lines to be underfull without complaint:
6407 \tolerance=10000 \hbadness=10000
6408 \exdentamount=\defbodyindent
6410 % defun fonts. We use typewriter by default (used to be bold) because:
6411 % . we're printing identifiers, they should be in tt in principle.
6412 % . in languages with many accents, such as Czech or French, it's
6413 % common to leave accents off identifiers. The result looks ok in
6414 % tt, but exceedingly strange in rm.
6415 % . we don't want -- and --- to be treated as ligatures.
6416 % . this still does not fix the ?` and !` ligatures, but so far no
6417 % one has made identifiers using them :).
6419 \def\temp{#2}% return value type
6420 \ifx\temp\empty\else \tclose{\temp} \fi
6421 #3% output function name
6423 {\rm\enskip}% hskip 0.5 em of \tenrm
6426 % arguments will be output next, if any.
6429 % Print arguments in slanted roman (not ttsl), inconsistently with using
6430 % tt for the name. This is because literal text is sometimes needed in
6431 % the argument list (groff manual), and ttsl and tt are not very
6432 % distinguishable. Prevent hyphenation at `-' chars.
6435 % use sl by default (not ttsl),
6437 \df \sl \hyphenchar\font=0
6439 % On the other hand, if an argument has two dashes (for instance), we
6440 % want a way to get ttsl. Let's try @var for that.
6443 \sl\hyphenchar\font=45
6446 % We want ()&[] to print specially on the defun line.
6449 \catcode`\(=\active \catcode`\)=\active
6450 \catcode`\[=\active \catcode`\]=\active
6454 % Make control sequences which act like normal parenthesis chars.
6455 \let\lparen = ( \let\rparen = )
6457 % Be sure that we always have a definition for `(', etc. For example,
6458 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6459 % so TeX would otherwise complain about undefined control sequence.
6462 \global\let(=\lparen \global\let)=\rparen
6463 \global\let[=\lbrack \global\let]=\rbrack
6466 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6467 \gdef\magicamp{\let&=\amprm}
6470 \newcount\parencount
6472 % If we encounter &foo, then turn on ()-hacking afterwards
6474 \def\amprm#1 {\ampseentrue{\bf\ }}
6478 % At the first level, print parens in roman,
6479 % otherwise use the default font.
6480 \ifnum \parencount=1 \rm \fi
6482 % The \sf parens (in \boldbrax) actually are a little bolder than
6483 % the contained text. This is especially needed for [ and ] .
6487 \def\infirstlevel#1{%
6494 \def\bfafterword#1 {#1 \bf}
6497 \global\advance\parencount by 1
6499 \infirstlevel \bfafterword
6504 \global\advance\parencount by -1
6507 \newcount\brackcount
6509 \global\advance\brackcount by 1
6514 \global\advance\brackcount by -1
6517 \def\checkparencounts{%
6518 \ifnum\parencount=0 \else \badparencount \fi
6519 \ifnum\brackcount=0 \else \badbrackcount \fi
6521 % these should not use \errmessage; the glibc manual, at least, actually
6522 % has such constructs (when documenting function pointers).
6523 \def\badparencount{%
6524 \message{Warning: unbalanced parentheses in @def...}%
6525 \global\parencount=0
6527 \def\badbrackcount{%
6528 \message{Warning: unbalanced square brackets in @def...}%
6529 \global\brackcount=0
6536 % To do this right we need a feature of e-TeX, \scantokens,
6537 % which we arrange to emulate with a temporary file in ordinary TeX.
6538 \ifx\eTeXversion\undefined
6539 \newwrite\macscribble
6542 \immediate\openout\macscribble=\jobname.tmp
6543 \immediate\write\macscribble{\the\toks0}%
6544 \immediate\closeout\macscribble
6552 \let\xeatspaces\eatspaces
6553 % Undo catcode changes of \startcontents and \doprintindex
6554 % When called from @insertcopying or (short)caption, we need active
6555 % backslash to get it printed correctly. Previously, we had
6556 % \catcode`\\=\other instead. We'll see whether a problem appears
6557 % with macro expansion. --kasal, 19aug04
6558 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6562 % Append \endinput to make sure that TeX does not see the ending newline.
6563 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6565 \scantokens{#1\endinput}%
6570 \edef\temp{\noexpand\scanmacro{#1}}%
6574 \newcount\paramno % Count of parameters
6575 \newtoks\macname % Macro name
6576 \newif\ifrecursive % Is it recursive?
6578 % List of all defined macros in the form
6579 % \definedummyword\macro1\definedummyword\macro2...
6580 % Currently is also contains all @aliases; the list can be split
6581 % if there is a need.
6584 % Add the macro to \macrolist
6585 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6586 \def\addtomacrolistxxx#1{%
6587 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6588 \xdef\macrolist{\the\toks0}%
6592 % This does \let #1 = #2, with \csnames; that is,
6593 % \let \csname#1\endcsname = \csname#2\endcsname
6594 % (except of course we have to play expansion games).
6598 \csname#1\expandafter\endcsname
6602 % Trim leading and trailing spaces off a string.
6603 % Concepts from aro-bend problem 15 (see CTAN).
6605 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6606 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6607 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6609 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6612 % Trim a single trailing ^^M off a string.
6613 {\catcode`\^^M=\other \catcode`\Q=3%
6614 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6615 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6616 \gdef\eatcrb#1Q#2Q{#1}%
6619 % Macro bodies are absorbed as an argument in a context where
6620 % all characters are catcode 10, 11 or 12, except \ which is active
6621 % (as in normal texinfo). It is necessary to change the definition of \.
6623 % Non-ASCII encodings make 8-bit characters active, so un-activate
6624 % them to avoid their expansion. Must do this non-globally, to
6625 % confine the change to the current group.
6627 % It's necessary to have hard CRs when the macro is executed. This is
6628 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6629 % body, and then making it the \newlinechar in \scanmacro.
6641 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6647 \catcode`\^^M=\other
6650 \def\macrobodyctxt{%
6654 \catcode`\^^M=\other
6663 % \mbodybackslash is the definition of \ in @macro bodies.
6664 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6665 % where N is the macro parameter number.
6666 % We define \csname macarg.\endcsname to be \realbackslash, so
6667 % \\ in macro replacement text gets you a backslash.
6669 {\catcode`@=0 @catcode`@\=@active
6670 @gdef@usembodybackslash{@let\=@mbodybackslash}
6671 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6673 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6675 \def\macro{\recursivefalse\parsearg\macroxxx}
6676 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6679 \getargs{#1}% now \macname is the macname and \argl the arglist
6680 \ifx\argl\empty % no arguments
6683 \expandafter\parsemargdef \argl;%
6685 \if1\csname ismacro.\the\macname\endcsname
6686 \message{Warning: redefining \the\macname}%
6688 \expandafter\ifx\csname \the\macname\endcsname \relax
6689 \else \errmessage{Macro name \the\macname\space already defined}\fi
6690 \global\cslet{macsave.\the\macname}{\the\macname}%
6691 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6692 \addtomacrolist{\the\macname}%
6694 \begingroup \macrobodyctxt
6695 \ifrecursive \expandafter\parsermacbody
6696 \else \expandafter\parsemacbody
6699 \parseargdef\unmacro{%
6700 \if1\csname ismacro.#1\endcsname
6701 \global\cslet{#1}{macsave.#1}%
6702 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6703 % Remove the macro name from \macrolist:
6705 \expandafter\let\csname#1\endcsname \relax
6706 \let\definedummyword\unmacrodo
6707 \xdef\macrolist{\macrolist}%
6710 \errmessage{Macro #1 not defined}%
6714 % Called by \do from \dounmacro on each macro. The idea is to omit any
6715 % macro definitions that have been changed to \relax.
6721 \noexpand\definedummyword \noexpand#1%
6725 % This makes use of the obscure feature that if the last token of a
6726 % <parameter list> is #, then the preceding argument is delimited by
6727 % an opening brace, and that opening brace is not consumed.
6728 \def\getargs#1{\getargsxxx#1{}}
6729 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6730 \def\getmacname #1 #2\relax{\macname={#1}}
6731 \def\getmacargs#1{\def\argl{#1}}
6733 % Parse the optional {params} list. Set up \paramno and \paramlist
6734 % so \defmacro knows what to do. Define \macarg.blah for each blah
6735 % in the params list, to be ##N where N is the position in that list.
6736 % That gets used by \mbodybackslash (above).
6738 % We need to get `macro parameter char #' into several definitions.
6739 % The technique used is stolen from LaTeX: let \hash be something
6740 % unexpandable, insert that wherever you need a #, and then redefine
6741 % it to # just before using the token list produced.
6743 % The same technique is used to protect \eatspaces till just before
6744 % the macro is used.
6746 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6747 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6748 \def\parsemargdefxxx#1,{%
6749 \if#1;\let\next=\relax
6750 \else \let\next=\parsemargdefxxx
6751 \advance\paramno by 1%
6752 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6753 {\xeatspaces{\hash\the\paramno}}%
6754 \edef\paramlist{\paramlist\hash\the\paramno,}%
6757 % These two commands read recursive and nonrecursive macro bodies.
6758 % (They're different since rec and nonrec macros end differently.)
6760 \long\def\parsemacbody#1@end macro%
6761 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6762 \long\def\parsermacbody#1@end rmacro%
6763 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6765 % This defines the macro itself. There are six cases: recursive and
6766 % nonrecursive macros of zero, one, and many arguments.
6767 % Much magic with \expandafter here.
6768 % \xdef is used so that macro definitions will survive the file
6769 % they're defined in; @include reads the file inside a group.
6771 \let\hash=##% convert placeholders to macro parameter chars
6775 \expandafter\xdef\csname\the\macname\endcsname{%
6776 \noexpand\scanmacro{\temp}}%
6778 \expandafter\xdef\csname\the\macname\endcsname{%
6779 \bgroup\noexpand\macroargctxt
6780 \noexpand\braceorline
6781 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6782 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6783 \egroup\noexpand\scanmacro{\temp}}%
6785 \expandafter\xdef\csname\the\macname\endcsname{%
6786 \bgroup\noexpand\macroargctxt
6787 \noexpand\csname\the\macname xx\endcsname}%
6788 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6789 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6790 \expandafter\expandafter
6792 \expandafter\expandafter
6793 \csname\the\macname xxx\endcsname
6794 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6799 \expandafter\xdef\csname\the\macname\endcsname{%
6800 \noexpand\norecurse{\the\macname}%
6801 \noexpand\scanmacro{\temp}\egroup}%
6803 \expandafter\xdef\csname\the\macname\endcsname{%
6804 \bgroup\noexpand\macroargctxt
6805 \noexpand\braceorline
6806 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6807 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6809 \noexpand\norecurse{\the\macname}%
6810 \noexpand\scanmacro{\temp}\egroup}%
6812 \expandafter\xdef\csname\the\macname\endcsname{%
6813 \bgroup\noexpand\macroargctxt
6814 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6815 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6816 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6817 \expandafter\expandafter
6819 \expandafter\expandafter
6820 \csname\the\macname xxx\endcsname
6823 \noexpand\norecurse{\the\macname}%
6824 \noexpand\scanmacro{\temp}\egroup}%
6828 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6830 % \braceorline decides whether the next nonwhitespace character is a
6831 % {. If so it reads up to the closing }, if not, it reads the whole
6832 % line. Whatever was read is then fed to the next control sequence
6833 % as an argument (by \parsebrace or \parsearg)
6834 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6835 \def\braceorlinexxx{%
6836 \ifx\nchar\bgroup\else
6837 \expandafter\parsearg
6842 % We need some trickery to remove the optional spaces around the equal
6843 % sign. Just make them active and then expand them all to nothing.
6844 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6845 \def\aliasxxx #1{\aliasyyy#1\relax}
6846 \def\aliasyyy #1=#2\relax{%
6848 \expandafter\let\obeyedspace=\empty
6849 \addtomacrolist{#1}%
6850 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6856 \message{cross references,}
6859 \newif\ifhavexrefs % True if xref values are known.
6860 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6862 % @inforef is relatively simple.
6863 \def\inforef #1{\inforefzzz #1,,,,**}
6864 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6865 node \samp{\ignorespaces#1{}}}
6867 % @node's only job in TeX is to define \lastnode, which is used in
6868 % cross-references. The @node line might or might not have commas, and
6869 % might or might not have spaces before the first comma, like:
6870 % @node foo , bar , ...
6871 % We don't want such trailing spaces in the node name.
6873 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6875 % also remove a trailing comma, in case of something like this:
6876 % @node Help-Cross, , , Cross-refs
6877 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6878 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6881 \let\lastnode=\empty
6883 % Write a cross-reference definition for the current node. #1 is the
6884 % type (Ynumbered, Yappendix, Ynothing).
6887 \ifx\lastnode\empty\else
6888 \setref{\lastnode}{#1}%
6889 \global\let\lastnode=\empty
6893 % @anchor{NAME} -- define xref target at arbitrary point.
6895 \newcount\savesfregister
6897 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6898 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6899 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6901 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6902 % anchor), which consists of three parts:
6903 % 1) NAME-title - the current sectioning name taken from \lastsection,
6904 % or the anchor name.
6905 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6906 % empty for anchors.
6907 % 3) NAME-pg - the page number.
6909 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6910 % floats, there is an additional part, which is not written here:
6911 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6917 \atdummies % preserve commands, but don't expand them
6918 \edef\writexrdef##1##2{%
6919 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6920 ##1}{##2}}% these are parameters of \writexrdef
6922 \toks0 = \expandafter{\lastsection}%
6923 \immediate \writexrdef{title}{\the\toks0 }%
6924 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6925 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6930 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6931 % the node name, #2 the name of the Info cross-reference, #3 the printed
6932 % node name, #4 the name of the Info file, #5 the name of the printed
6933 % manual. All but the node name can be omitted.
6935 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6936 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6937 \def\ref#1{\xrefX[#1,,,,,,,]}
6938 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6940 \def\printedmanual{\ignorespaces #5}%
6941 \def\printedrefname{\ignorespaces #3}%
6942 \setbox1=\hbox{\printedmanual\unskip}%
6943 \setbox0=\hbox{\printedrefname\unskip}%
6945 % No printed node name was explicitly given.
6946 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6947 % Use the node name inside the square brackets.
6948 \def\printedrefname{\ignorespaces #1}%
6950 % Use the actual chapter/section title appear inside
6951 % the square brackets. Use the real section title if we have it.
6953 % It is in another manual, so we don't have it.
6954 \def\printedrefname{\ignorespaces #1}%
6957 % We know the real title if we have the xref values.
6958 \def\printedrefname{\refx{#1-title}{}}%
6960 % Otherwise just copy the Info node name.
6961 \def\printedrefname{\ignorespaces #1}%
6967 % Make link in pdf output.
6973 % See comments at \activebackslashdouble.
6974 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6975 \backslashparens\pdfxrefdest}%
6977 \ifnum\filenamelength>0
6978 \startlink attr{/Border [0 0 0]}%
6979 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6981 \startlink attr{/Border [0 0 0]}%
6982 goto name{\pdfmkpgn{\pdfxrefdest}}%
6985 \setcolor{\linkcolor}%
6988 % Float references are printed completely differently: "Figure 1.2"
6989 % instead of "[somenode], p.3". We distinguish them by the
6990 % LABEL-title being set to a magic string.
6992 % Have to otherify everything special to allow the \csname to
6993 % include an _ in the xref name, etc.
6996 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6997 \csname XR#1-title\endcsname
6999 \iffloat\Xthisreftitle
7000 % If the user specified the print name (third arg) to the ref,
7001 % print it instead of our usual "Figure 1.2".
7008 % if the user also gave the printed manual name (fifth arg), append
7011 \space \putwordin{} \cite{\printedmanual}%
7014 % node/anchor (non-float) references.
7016 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7017 % insert empty discretionaries after hyphens, which means that it will
7018 % not find a line break at a hyphen in a node names. Since some manuals
7019 % are best written with fairly long node names, containing hyphens, this
7020 % is a loss. Therefore, we give the text of the node name again, so it
7021 % is as if TeX is seeing it for the first time.
7023 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7025 % _ (for example) has to be the character _ for the purposes of the
7026 % control sequence corresponding to the node, but it has to expand
7027 % into the usual \leavevmode...\vrule stuff for purposes of
7028 % printing. So we \turnoffactive for the \refx-snt, back on for the
7029 % printing, back off for the \refx-pg.
7031 % Only output a following space if the -snt ref is nonempty; for
7032 % @unnumbered and @anchor, it won't be.
7033 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7034 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7036 % output the `[mynode]' via a macro so it can be overridden.
7037 \xrefprintnodename\printedrefname
7039 % But we always want a comma and a space:
7042 % output the `page 3'.
7043 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7049 % This macro is called from \xrefX for the `[nodename]' part of xref
7050 % output. It's a separate macro only so it can be changed more easily,
7051 % since square brackets don't work well in some documents. Particularly
7052 % one that Bob is working on :).
7054 \def\xrefprintnodename#1{[#1]}
7056 % Things referred to by \setref.
7062 \putwordChapter@tie \the\chapno
7063 \else \ifnum\subsecno=0
7064 \putwordSection@tie \the\chapno.\the\secno
7065 \else \ifnum\subsubsecno=0
7066 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7068 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7073 \putwordAppendix@tie @char\the\appendixno{}%
7074 \else \ifnum\subsecno=0
7075 \putwordSection@tie @char\the\appendixno.\the\secno
7076 \else \ifnum\subsubsecno=0
7077 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7080 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7084 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7085 % If its value is nonempty, SUFFIX is output afterward.
7091 \expandafter\global\expandafter\let\expandafter\thisrefX
7092 \csname XR#1\endcsname
7095 % If not defined, say something at least.
7096 \angleleft un\-de\-fined\angleright
7099 \message{\linenumber Undefined cross reference `#1'.}%
7102 \global\warnedxrefstrue
7103 \message{Cross reference values unknown; you must run TeX again.}%
7108 % It's defined, so just use it.
7111 #2% Output the suffix in any case.
7114 % This is the macro invoked by entries in the aux file. Usually it's
7115 % just a \def (we prepend XR to the control sequence name to avoid
7116 % collisions). But if this is a float type, we have more work to do.
7119 {% The node name might contain 8-bit characters, which in our current
7120 % implementation are changed to commands like @'e. Don't let these
7121 % mess up the control sequence name.
7124 \xdef\safexrefname{#1}%
7127 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7129 % Was that xref control sequence that we just defined for a float?
7130 \expandafter\iffloat\csname XR\safexrefname\endcsname
7131 % it was a float, and we have the (safe) float type in \iffloattype.
7132 \expandafter\let\expandafter\floatlist
7133 \csname floatlist\iffloattype\endcsname
7135 % Is this the first time we've seen this float type?
7136 \expandafter\ifx\floatlist\relax
7137 \toks0 = {\do}% yes, so just \do
7139 % had it before, so preserve previous elements in list.
7140 \toks0 = \expandafter{\floatlist\do}%
7143 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7144 % for later use in \listoffloats.
7145 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7150 % Read the last existing aux file, if any. No error if none exists.
7153 \openin 1 \jobname.aux
7156 \global\havexrefstrue
7161 \def\setupdatafile{%
7162 \catcode`\^^@=\other
7163 \catcode`\^^A=\other
7164 \catcode`\^^B=\other
7165 \catcode`\^^C=\other
7166 \catcode`\^^D=\other
7167 \catcode`\^^E=\other
7168 \catcode`\^^F=\other
7169 \catcode`\^^G=\other
7170 \catcode`\^^H=\other
7171 \catcode`\^^K=\other
7172 \catcode`\^^L=\other
7173 \catcode`\^^N=\other
7174 \catcode`\^^P=\other
7175 \catcode`\^^Q=\other
7176 \catcode`\^^R=\other
7177 \catcode`\^^S=\other
7178 \catcode`\^^T=\other
7179 \catcode`\^^U=\other
7180 \catcode`\^^V=\other
7181 \catcode`\^^W=\other
7182 \catcode`\^^X=\other
7183 \catcode`\^^Z=\other
7184 \catcode`\^^[=\other
7185 \catcode`\^^\=\other
7186 \catcode`\^^]=\other
7187 \catcode`\^^^=\other
7188 \catcode`\^^_=\other
7189 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7190 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7191 % supported in the main text, it doesn't seem desirable. Furthermore,
7192 % that is not enough: for node names that actually contain a ^
7193 % character, we would end up writing a line like this: 'xrdef {'hat
7194 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7195 % argument, and \hat is not an expandable control sequence. It could
7196 % all be worked out, but why? Either we support ^^ or we don't.
7198 % The other change necessary for this was to define \auxhat:
7199 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7200 % and then to call \auxhat in \setq.
7204 % Special characters. Should be turned off anyway, but...
7217 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7219 % This is to support \ in node names and titles, since the \
7220 % characters end up in a \csname. It's easier than
7221 % leaving it active and making its active definition an actual \
7222 % character. What I don't understand is why it works in the *value*
7223 % of the xrdef. Seems like it should be a catcode12 \, and that
7224 % should not typeset properly. But it works, so I'm moving on for
7225 % now. --karl, 15jan04.
7228 % Make the characters 128-255 be printing characters.
7232 \catcode\count1=\other
7233 \advance\count1 by 1
7234 \ifnum \count1<256 \loop \fi
7238 % @ is our escape character in .aux files, and we need braces.
7244 \def\readdatafile#1{%
7251 \message{insertions,}
7252 % including footnotes.
7254 \newcount \footnoteno
7256 % The trailing space in the following definition for supereject is
7257 % vital for proper filling; pages come out unaligned when you do a
7258 % pagealignmacro call if that space before the closing brace is
7259 % removed. (Generally, numeric constants should always be followed by a
7260 % space to prevent strange expansion errors.)
7261 \def\supereject{\par\penalty -20000\footnoteno =0 }
7263 % @footnotestyle is meaningful for info output only.
7264 \let\footnotestyle=\comment
7268 % Auto-number footnotes. Otherwise like plain.
7270 \let\indent=\ptexindent
7271 \let\noindent=\ptexnoindent
7272 \global\advance\footnoteno by \@ne
7273 \edef\thisfootno{$^{\the\footnoteno}$}%
7275 % In case the footnote comes at the end of a sentence, preserve the
7276 % extra spacing after we do the footnote number.
7278 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7280 % Remove inadvertent blank space before typesetting the footnote number.
7286 % Don't bother with the trickery in plain.tex to not require the
7287 % footnote text as a parameter. Our footnotes don't need to be so general.
7289 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7290 % \parseargline) fails inside footnotes because the tokens are fixed when
7291 % the footnote is read. --karl, 16nov96.
7294 \insert\footins\bgroup
7295 % We want to typeset this text as a normal paragraph, even if the
7296 % footnote reference occurs in (for example) a display environment.
7297 % So reset some parameters.
7299 \interlinepenalty\interfootnotelinepenalty
7300 \splittopskip\ht\strutbox % top baseline for broken footnotes
7301 \splitmaxdepth\dp\strutbox
7302 \floatingpenalty\@MM
7307 \parindent\defaultparindent
7311 % Because we use hanging indentation in footnotes, a @noindent appears
7312 % to exdent this text, so make it be a no-op. makeinfo does not use
7313 % hanging indentation so @noindent can still be needed within footnote
7314 % text after an @example or the like (not that this is good style).
7315 \let\noindent = \relax
7317 % Hang the footnote text off the number. Use \everypar in case the
7318 % footnote extends for more than one paragraph.
7319 \everypar = {\hang}%
7320 \textindent{\thisfootno}%
7322 % Don't crash into the line above the footnote text. Since this
7323 % expands into a box, it must come within the paragraph, lest it
7324 % provide a place where TeX can split the footnote.
7326 \futurelet\next\fo@t
7328 }%end \catcode `\@=11
7330 % In case a @footnote appears in a vbox, save the footnote text and create
7331 % the real \insert just after the vbox finished. Otherwise, the insertion
7333 % Similarily, if a @footnote appears inside an alignment, save the footnote
7334 % text to a box and make the \insert when a row of the table is finished.
7335 % And the same can be done for other insert classes. --kasal, 16nov03.
7337 % Replace the \insert primitive by a cheating macro.
7338 % Deeper inside, just make sure that the saved insertions are not spilled
7341 \def\startsavinginserts{%
7342 \ifx \insert\ptexinsert
7343 \let\insert\saveinsert
7345 \let\checkinserts\relax
7349 % This \insert replacement works for both \insert\footins{foo} and
7350 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7353 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7354 \afterassignment\next
7355 % swallow the left brace
7358 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7359 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7361 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7363 \def\placesaveins#1{%
7364 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7368 % eat @SAVE -- beware, all of them have catcode \other:
7370 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7371 \gdef\gobblesave @SAVE{}
7375 \def\newsaveins #1{%
7376 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7379 \def\newsaveinsX #1{%
7380 \csname newbox\endcsname #1%
7381 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7386 \let\checkinserts\empty
7391 % @image. We use the macros from epsf.tex to support this.
7392 % If epsf.tex is not installed and @image is used, we complain.
7394 % Check for and read epsf.tex up front. If we read it only at @image
7395 % time, we might be inside a group, and then its definitions would get
7396 % undone and the next image would fail.
7397 \openin 1 = epsf.tex
7399 % Do not bother showing banner with epsf.tex v2.7k (available in
7400 % doc/epsf.tex and on ctan).
7401 \def\epsfannounce{\toks0 = }%
7406 % We will only complain once about lack of epsf.tex.
7407 \newif\ifwarnednoepsf
7408 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7409 work. It is also included in the Texinfo distribution, or you can get
7410 it from ftp://tug.org/tex/epsf.tex.}
7413 \ifx\epsfbox\undefined
7414 \ifwarnednoepsf \else
7415 \errhelp = \noepsfhelp
7416 \errmessage{epsf.tex not found, images will be ignored}%
7417 \global\warnednoepsftrue
7420 \imagexxx #1,,,,,\finish
7424 % Arguments to @image:
7425 % #1 is (mandatory) image filename; we tack on .eps extension.
7426 % #2 is (optional) width, #3 is (optional) height.
7427 % #4 is (ignored optional) html alt text.
7428 % #5 is (ignored optional) extension.
7429 % #6 is just the usual extra ignored arg for parsing this stuff.
7431 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7432 \catcode`\^^M = 5 % in case we're inside an example
7433 \normalturnoffactive % allow _ et al. in names
7434 % If the image is by itself, center it.
7438 % Usually we'll have text after the image which will insert
7439 % \parskip glue, so insert it here too to equalize the space
7441 \nobreak\vskip\parskip
7448 \dopdfimage{#1}{#2}{#3}%
7450 % \epsfbox itself resets \epsf?size at each figure.
7451 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7452 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7456 \ifimagevmode \egroup \bigbreak \fi % space after the image
7460 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7461 % etc. We don't actually implement floating yet, we always include the
7462 % float "here". But it seemed the best name for the future.
7464 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7466 % There may be a space before second and/or third parameter; delete it.
7467 \def\eatcommaspace#1, {#1,}
7469 % #1 is the optional FLOATTYPE, the text label for this float, typically
7470 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7471 % this float will not be numbered and cannot be referred to.
7473 % #2 is the optional xref label. Also must be present for the float to
7476 % #3 is the optional positioning argument; for now, it is ignored. It
7477 % will somehow specify the positions allowed to float to (here, top, bottom).
7479 % We keep a separate counter for each FLOATTYPE, which we reset at each
7480 % chapter-level command.
7481 \let\resetallfloatnos=\empty
7483 \def\dofloat#1,#2,#3,#4\finish{%
7484 \let\thiscaption=\empty
7485 \let\thisshortcaption=\empty
7487 % don't lose footnotes inside @float.
7489 % BEWARE: when the floats start float, we have to issue warning whenever an
7490 % insert appears inside a float which could possibly float. --kasal, 26may04
7494 % We can't be used inside a paragraph.
7499 \def\floatlabel{#2}%
7500 \def\floatloc{#3}% we do nothing with this yet.
7502 \ifx\floattype\empty
7503 \let\safefloattype=\empty
7506 % the floattype might have accents or other special characters,
7507 % but we need to use it in a control sequence name.
7510 \xdef\safefloattype{\floattype}%
7514 % If label is given but no type, we handle that as the empty type.
7515 \ifx\floatlabel\empty \else
7516 % We want each FLOATTYPE to be numbered separately (Figure 1,
7517 % Table 1, Figure 2, ...). (And if no label, no number.)
7519 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7520 \global\advance\floatno by 1
7523 % This magic value for \lastsection is output by \setref as the
7524 % XREFLABEL-title value. \xrefX uses it to distinguish float
7525 % labels (which have a completely different output format) from
7526 % node and anchor labels. And \xrdef uses it to construct the
7529 \edef\lastsection{\floatmagic=\safefloattype}%
7530 \setref{\floatlabel}{Yfloat}%
7534 % start with \parskip glue, I guess.
7537 % Don't suppress indentation if a float happens to start a section.
7538 \restorefirstparagraphindent
7541 % we have these possibilities:
7542 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7543 % @float Foo,lbl & no caption: Foo 1.1
7544 % @float Foo & @caption{Cap}: Foo: Cap
7545 % @float Foo & no caption: Foo
7546 % @float ,lbl & Caption{Cap}: 1.1: Cap
7547 % @float ,lbl & no caption: 1.1
7548 % @float & @caption{Cap}: Cap
7549 % @float & no caption:
7552 \let\floatident = \empty
7554 % In all cases, if we have a float type, it comes first.
7555 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7557 % If we have an xref label, the number comes next.
7558 \ifx\floatlabel\empty \else
7559 \ifx\floattype\empty \else % if also had float type, need tie first.
7560 \appendtomacro\floatident{\tie}%
7563 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7566 % Start the printed caption with what we've constructed in
7567 % \floatident, but keep it separate; we need \floatident again.
7568 \let\captionline = \floatident
7570 \ifx\thiscaption\empty \else
7571 \ifx\floatident\empty \else
7572 \appendtomacro\captionline{: }% had ident, so need a colon between
7576 \appendtomacro\captionline{\scanexp\thiscaption}%
7579 % If we have anything to print, print it, with space before.
7580 % Eventually this needs to become an \insert.
7581 \ifx\captionline\empty \else
7585 % Space below caption.
7589 % If have an xref label, write the list of floats info. Do this
7590 % after the caption, to avoid chance of it being a breakpoint.
7591 \ifx\floatlabel\empty \else
7592 % Write the text that goes in the lof to the aux file as
7593 % \floatlabel-lof. Besides \floatident, we include the short
7594 % caption if specified, else the full caption if specified, else nothing.
7598 % since we read the caption text in the macro world, where ^^M
7599 % is turned into a normal character, we have to scan it back, so
7600 % we don't write the literal three characters "^^M" into the aux file.
7602 \xdef\noexpand\gtemp{%
7603 \ifx\thisshortcaption\empty
7610 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7611 \ifx\gtemp\empty \else : \gtemp \fi}}%
7614 \egroup % end of \vtop
7616 % place the captured inserts
7618 % BEWARE: when the floats start floating, we have to issue warning
7619 % whenever an insert appears inside a float which could possibly
7620 % float. --kasal, 26may04
7625 % Append the tokens #2 to the definition of macro #1, not expanding either.
7627 \def\appendtomacro#1#2{%
7628 \expandafter\def\expandafter#1\expandafter{#1#2}%
7631 % @caption, @shortcaption
7633 \def\caption{\docaption\thiscaption}
7634 \def\shortcaption{\docaption\thisshortcaption}
7635 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7636 \def\defcaption#1#2{\egroup \def#1{#2}}
7638 % The parameter is the control sequence identifying the counter we are
7639 % going to use. Create it if it doesn't exist and assign it to \floatno.
7642 % Haven't seen this figure type before.
7643 \csname newcount\endcsname #1%
7645 % Remember to reset this floatno at the next chap.
7646 \expandafter\gdef\expandafter\resetallfloatnos
7647 \expandafter{\resetallfloatnos #1=0 }%
7652 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7653 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7654 % first read the @float command.
7656 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7658 % Magic string used for the XREFLABEL-title value, so \xrefX can
7659 % distinguish floats from other xref types.
7660 \def\floatmagic{!!float!!}
7662 % #1 is the control sequence we are passed; we expand into a conditional
7663 % which is true if #1 represents a float ref. That is, the magic
7664 % \lastsection value which we \setref above.
7666 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7668 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7669 % (safe) float type for this float. We set \iffloattype to #2.
7671 \def\doiffloat#1=#2=#3\finish{%
7673 \def\iffloattype{#2}%
7674 \ifx\temp\floatmagic
7677 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7679 \parseargdef\listoffloats{%
7680 \def\floattype{#1}% floattype
7682 % the floattype might have accents or other special characters,
7683 % but we need to use it in a control sequence name.
7686 \xdef\safefloattype{\floattype}%
7689 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7690 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7692 % if the user said @listoffloats foo but never @float foo.
7693 \message{\linenumber No `\safefloattype' floats to list.}%
7697 \leftskip=\tocindent % indent these entries like a toc
7698 \let\do=\listoffloatsdo
7699 \csname floatlist\safefloattype\endcsname
7704 % This is called on each entry in a list of floats. We're passed the
7705 % xref label, in the form LABEL-title, which is how we save it in the
7706 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7707 % has the text we're supposed to typeset here.
7709 % Figures without xref labels will not be included in the list (since
7710 % they won't appear in the aux file).
7712 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7713 \def\listoffloatsdoentry#1-title\finish{{%
7714 % Can't fully expand XR#1-lof because it can contain anything. Just
7715 % pass the control sequence. On the other hand, XR#1-pg is just the
7716 % page number, and we want to fully expand that so we can get a link
7718 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7720 % use the same \entry macro we use to generate the TOC and index.
7721 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7726 \message{localization,}
7728 % @documentlanguage is usually given very early, just after
7729 % @setfilename. If done too late, it may not override everything
7730 % properly. Single argument is the language (de) or locale (de_DE)
7731 % abbreviation. It would be nice if we could set up a hyphenation file.
7734 \catcode`\_ = \active
7736 \parseargdef\documentlanguage{\begingroup
7737 \let_=\normalunderscore % normal _ character for filenames
7738 \tex % read txi-??.tex file in plain TeX.
7739 % Read the file by the name they passed if it exists.
7740 \openin 1 txi-#1.tex
7742 \documentlanguagetrywithoutunderscore{#1_\finish}%
7751 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7754 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7755 \openin 1 txi-#1.tex
7757 \errhelp = \nolanghelp
7758 \errmessage{Cannot read language file txi-#1.tex}%
7765 \newhelp\nolanghelp{The given language definition file cannot be found or
7766 is empty. Maybe you need to install it? In the current directory
7767 should work if nowhere else does.}
7769 % Set the catcode of characters 128 through 255 to the specified number.
7771 \def\setnonasciicharscatcode#1{%
7773 \loop\ifnum\count255<256
7774 \global\catcode\count255=#1\relax
7775 \advance\count255 by 1
7779 \def\setnonasciicharscatcodenonglobal#1{%
7781 \loop\ifnum\count255<256
7782 \catcode\count255=#1\relax
7783 \advance\count255 by 1
7787 % @documentencoding sets the definition of non-ASCII characters
7788 % according to the specified encoding.
7790 \parseargdef\documentencoding{%
7791 % Encoding being declared for the document.
7792 \def\declaredencoding{\csname #1.enc\endcsname}%
7794 % Supported encodings: names converted to tokens in order to be able
7795 % to compare them with \ifx.
7796 \def\ascii{\csname US-ASCII.enc\endcsname}%
7797 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7798 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7799 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7800 \def\utfeight{\csname UTF-8.enc\endcsname}%
7802 \ifx \declaredencoding \ascii
7805 \else \ifx \declaredencoding \lattwo
7806 \setnonasciicharscatcode\active
7809 \else \ifx \declaredencoding \latone
7810 \setnonasciicharscatcode\active
7813 \else \ifx \declaredencoding \latnine
7814 \setnonasciicharscatcode\active
7817 \else \ifx \declaredencoding \utfeight
7818 \setnonasciicharscatcode\active
7822 \message{Unknown document encoding #1, ignoring.}%
7831 % A message to be logged when using a character that isn't available
7832 % the default font encoding (OT1).
7834 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7836 % Take account of \c (plain) vs. \, (Texinfo) difference.
7837 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7839 % First, make active non-ASCII characters in order for them to be
7840 % correctly categorized when TeX reads the replacement text of
7841 % macros containing the character definitions.
7842 \setnonasciicharscatcode\active
7844 % Latin1 (ISO-8859-1) character definitions.
7845 \def\latonechardefs{%
7847 \gdef^^a1{\exclamdown}
7848 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7849 \gdef^^a3{{\pounds}}
7850 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7851 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7852 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7855 \gdef^^a9{\copyright}
7857 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7860 \gdef^^ae{\registeredsymbol}
7863 \gdef^^b0{\textdegree}
7872 \gdef^^b8{\cedilla\ }
7876 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7877 \gdef^^bc{$1\over4$}
7878 \gdef^^bd{$1\over2$}
7879 \gdef^^be{$3\over4$}
7880 \gdef^^bf{\questiondown}
7887 \gdef^^c5{\ringaccent A}
7889 \gdef^^c7{\cedilla C}
7899 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7913 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7921 \gdef^^e5{\ringaccent a}
7923 \gdef^^e7{\cedilla c}
7928 \gdef^^ec{\`{\dotless i}}
7929 \gdef^^ed{\'{\dotless i}}
7930 \gdef^^ee{\^{\dotless i}}
7931 \gdef^^ef{\"{\dotless i}}
7933 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7947 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7951 % Latin9 (ISO-8859-15) encoding character definitions.
7952 \def\latninechardefs{%
7953 % Encoding is almost identical to Latin1.
7966 % Latin2 (ISO-8859-2) character definitions.
7967 \def\lattwochardefs{%
7969 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7972 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7978 \gdef^^aa{\cedilla S}
7983 \gdef^^af{\dotaccent Z}
7985 \gdef^^b0{\textdegree}
7986 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7987 \gdef^^b2{\missingcharmsg{OGONEK}}
7993 \gdef^^b8{\cedilla\ }
7995 \gdef^^ba{\cedilla s}
8000 \gdef^^bf{\dotaccent z}
8009 \gdef^^c7{\cedilla C}
8012 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
8019 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8028 \gdef^^d9{\ringaccent U}
8033 \gdef^^de{\cedilla T}
8043 \gdef^^e7{\cedilla c}
8046 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
8053 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8062 \gdef^^f9{\ringaccent u}
8067 \gdef^^fe{\cedilla t}
8068 \gdef^^ff{\dotaccent{}}
8071 % UTF-8 character definitions.
8073 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8074 % changes for Texinfo conventions. It is included here under the GPL by
8075 % permission from Frank Mittelbach and the LaTeX team.
8081 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8082 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8084 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8085 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8087 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8088 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8090 \gdef\UTFviiiDefined#1{%
8092 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8103 \global\catcode\countUTFx\active
8104 \uccode`\~\countUTFx
8105 \uppercase\expandafter{\UTFviiiTmp}%
8106 \advance\countUTFx by 1
8107 \ifnum\countUTFx < \countUTFy
8108 \expandafter\UTFviiiLoop
8114 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8120 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8126 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8139 \gdef\DeclareUnicodeCharacter#1#2{%
8140 \countUTFz = "#1\relax
8141 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8144 \def\UTFviiiTwoOctets##1##2{%
8145 \csname u8:##1\string ##2\endcsname}%
8146 \def\UTFviiiThreeOctets##1##2##3{%
8147 \csname u8:##1\string ##2\string ##3\endcsname}%
8148 \def\UTFviiiFourOctets##1##2##3##4{%
8149 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8150 \expandafter\expandafter\expandafter\expandafter
8151 \expandafter\expandafter\expandafter
8152 \gdef\UTFviiiTmp{#2}%
8155 \gdef\parseXMLCharref{%
8156 \ifnum\countUTFz < "A0\relax
8157 \errhelp = \EMsimple
8158 \errmessage{Cannot define Unicode char value < 00A0}%
8159 \else\ifnum\countUTFz < "800\relax
8161 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8162 \else\ifnum\countUTFz < "10000\relax
8165 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8170 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8174 \gdef\parseUTFviiiA#1{%
8175 \countUTFx = \countUTFz
8176 \divide\countUTFz by 64
8177 \countUTFy = \countUTFz
8178 \multiply\countUTFz by 64
8179 \advance\countUTFx by -\countUTFz
8180 \advance\countUTFx by 128
8181 \uccode `#1\countUTFx
8182 \countUTFz = \countUTFy}
8184 \gdef\parseUTFviiiB#1#2#3#4{%
8185 \advance\countUTFz by "#10\relax
8186 \uccode `#3\countUTFz
8187 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8190 \def\utfeightchardefs{%
8191 \DeclareUnicodeCharacter{00A0}{\tie}
8192 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8193 \DeclareUnicodeCharacter{00A3}{\pounds}
8194 \DeclareUnicodeCharacter{00A8}{\"{ }}
8195 \DeclareUnicodeCharacter{00A9}{\copyright}
8196 \DeclareUnicodeCharacter{00AA}{\ordf}
8197 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8198 \DeclareUnicodeCharacter{00AD}{\-}
8199 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8200 \DeclareUnicodeCharacter{00AF}{\={ }}
8202 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8203 \DeclareUnicodeCharacter{00B4}{\'{ }}
8204 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8205 \DeclareUnicodeCharacter{00BA}{\ordm}
8206 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8207 \DeclareUnicodeCharacter{00BF}{\questiondown}
8209 \DeclareUnicodeCharacter{00C0}{\`A}
8210 \DeclareUnicodeCharacter{00C1}{\'A}
8211 \DeclareUnicodeCharacter{00C2}{\^A}
8212 \DeclareUnicodeCharacter{00C3}{\~A}
8213 \DeclareUnicodeCharacter{00C4}{\"A}
8214 \DeclareUnicodeCharacter{00C5}{\AA}
8215 \DeclareUnicodeCharacter{00C6}{\AE}
8216 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8217 \DeclareUnicodeCharacter{00C8}{\`E}
8218 \DeclareUnicodeCharacter{00C9}{\'E}
8219 \DeclareUnicodeCharacter{00CA}{\^E}
8220 \DeclareUnicodeCharacter{00CB}{\"E}
8221 \DeclareUnicodeCharacter{00CC}{\`I}
8222 \DeclareUnicodeCharacter{00CD}{\'I}
8223 \DeclareUnicodeCharacter{00CE}{\^I}
8224 \DeclareUnicodeCharacter{00CF}{\"I}
8226 \DeclareUnicodeCharacter{00D1}{\~N}
8227 \DeclareUnicodeCharacter{00D2}{\`O}
8228 \DeclareUnicodeCharacter{00D3}{\'O}
8229 \DeclareUnicodeCharacter{00D4}{\^O}
8230 \DeclareUnicodeCharacter{00D5}{\~O}
8231 \DeclareUnicodeCharacter{00D6}{\"O}
8232 \DeclareUnicodeCharacter{00D8}{\O}
8233 \DeclareUnicodeCharacter{00D9}{\`U}
8234 \DeclareUnicodeCharacter{00DA}{\'U}
8235 \DeclareUnicodeCharacter{00DB}{\^U}
8236 \DeclareUnicodeCharacter{00DC}{\"U}
8237 \DeclareUnicodeCharacter{00DD}{\'Y}
8238 \DeclareUnicodeCharacter{00DF}{\ss}
8240 \DeclareUnicodeCharacter{00E0}{\`a}
8241 \DeclareUnicodeCharacter{00E1}{\'a}
8242 \DeclareUnicodeCharacter{00E2}{\^a}
8243 \DeclareUnicodeCharacter{00E3}{\~a}
8244 \DeclareUnicodeCharacter{00E4}{\"a}
8245 \DeclareUnicodeCharacter{00E5}{\aa}
8246 \DeclareUnicodeCharacter{00E6}{\ae}
8247 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8248 \DeclareUnicodeCharacter{00E8}{\`e}
8249 \DeclareUnicodeCharacter{00E9}{\'e}
8250 \DeclareUnicodeCharacter{00EA}{\^e}
8251 \DeclareUnicodeCharacter{00EB}{\"e}
8252 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8253 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8254 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8255 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8257 \DeclareUnicodeCharacter{00F1}{\~n}
8258 \DeclareUnicodeCharacter{00F2}{\`o}
8259 \DeclareUnicodeCharacter{00F3}{\'o}
8260 \DeclareUnicodeCharacter{00F4}{\^o}
8261 \DeclareUnicodeCharacter{00F5}{\~o}
8262 \DeclareUnicodeCharacter{00F6}{\"o}
8263 \DeclareUnicodeCharacter{00F8}{\o}
8264 \DeclareUnicodeCharacter{00F9}{\`u}
8265 \DeclareUnicodeCharacter{00FA}{\'u}
8266 \DeclareUnicodeCharacter{00FB}{\^u}
8267 \DeclareUnicodeCharacter{00FC}{\"u}
8268 \DeclareUnicodeCharacter{00FD}{\'y}
8269 \DeclareUnicodeCharacter{00FF}{\"y}
8271 \DeclareUnicodeCharacter{0100}{\=A}
8272 \DeclareUnicodeCharacter{0101}{\=a}
8273 \DeclareUnicodeCharacter{0102}{\u{A}}
8274 \DeclareUnicodeCharacter{0103}{\u{a}}
8275 \DeclareUnicodeCharacter{0106}{\'C}
8276 \DeclareUnicodeCharacter{0107}{\'c}
8277 \DeclareUnicodeCharacter{0108}{\^C}
8278 \DeclareUnicodeCharacter{0109}{\^c}
8279 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8280 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8281 \DeclareUnicodeCharacter{010C}{\v{C}}
8282 \DeclareUnicodeCharacter{010D}{\v{c}}
8283 \DeclareUnicodeCharacter{010E}{\v{D}}
8285 \DeclareUnicodeCharacter{0112}{\=E}
8286 \DeclareUnicodeCharacter{0113}{\=e}
8287 \DeclareUnicodeCharacter{0114}{\u{E}}
8288 \DeclareUnicodeCharacter{0115}{\u{e}}
8289 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8290 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8291 \DeclareUnicodeCharacter{011A}{\v{E}}
8292 \DeclareUnicodeCharacter{011B}{\v{e}}
8293 \DeclareUnicodeCharacter{011C}{\^G}
8294 \DeclareUnicodeCharacter{011D}{\^g}
8295 \DeclareUnicodeCharacter{011E}{\u{G}}
8296 \DeclareUnicodeCharacter{011F}{\u{g}}
8298 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8299 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8300 \DeclareUnicodeCharacter{0124}{\^H}
8301 \DeclareUnicodeCharacter{0125}{\^h}
8302 \DeclareUnicodeCharacter{0128}{\~I}
8303 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8304 \DeclareUnicodeCharacter{012A}{\=I}
8305 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8306 \DeclareUnicodeCharacter{012C}{\u{I}}
8307 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8309 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8310 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8311 \DeclareUnicodeCharacter{0132}{IJ}
8312 \DeclareUnicodeCharacter{0133}{ij}
8313 \DeclareUnicodeCharacter{0134}{\^J}
8314 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8315 \DeclareUnicodeCharacter{0139}{\'L}
8316 \DeclareUnicodeCharacter{013A}{\'l}
8318 \DeclareUnicodeCharacter{0141}{\L}
8319 \DeclareUnicodeCharacter{0142}{\l}
8320 \DeclareUnicodeCharacter{0143}{\'N}
8321 \DeclareUnicodeCharacter{0144}{\'n}
8322 \DeclareUnicodeCharacter{0147}{\v{N}}
8323 \DeclareUnicodeCharacter{0148}{\v{n}}
8324 \DeclareUnicodeCharacter{014C}{\=O}
8325 \DeclareUnicodeCharacter{014D}{\=o}
8326 \DeclareUnicodeCharacter{014E}{\u{O}}
8327 \DeclareUnicodeCharacter{014F}{\u{o}}
8329 \DeclareUnicodeCharacter{0150}{\H{O}}
8330 \DeclareUnicodeCharacter{0151}{\H{o}}
8331 \DeclareUnicodeCharacter{0152}{\OE}
8332 \DeclareUnicodeCharacter{0153}{\oe}
8333 \DeclareUnicodeCharacter{0154}{\'R}
8334 \DeclareUnicodeCharacter{0155}{\'r}
8335 \DeclareUnicodeCharacter{0158}{\v{R}}
8336 \DeclareUnicodeCharacter{0159}{\v{r}}
8337 \DeclareUnicodeCharacter{015A}{\'S}
8338 \DeclareUnicodeCharacter{015B}{\'s}
8339 \DeclareUnicodeCharacter{015C}{\^S}
8340 \DeclareUnicodeCharacter{015D}{\^s}
8341 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8342 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8344 \DeclareUnicodeCharacter{0160}{\v{S}}
8345 \DeclareUnicodeCharacter{0161}{\v{s}}
8346 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8347 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8348 \DeclareUnicodeCharacter{0164}{\v{T}}
8350 \DeclareUnicodeCharacter{0168}{\~U}
8351 \DeclareUnicodeCharacter{0169}{\~u}
8352 \DeclareUnicodeCharacter{016A}{\=U}
8353 \DeclareUnicodeCharacter{016B}{\=u}
8354 \DeclareUnicodeCharacter{016C}{\u{U}}
8355 \DeclareUnicodeCharacter{016D}{\u{u}}
8356 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8357 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8359 \DeclareUnicodeCharacter{0170}{\H{U}}
8360 \DeclareUnicodeCharacter{0171}{\H{u}}
8361 \DeclareUnicodeCharacter{0174}{\^W}
8362 \DeclareUnicodeCharacter{0175}{\^w}
8363 \DeclareUnicodeCharacter{0176}{\^Y}
8364 \DeclareUnicodeCharacter{0177}{\^y}
8365 \DeclareUnicodeCharacter{0178}{\"Y}
8366 \DeclareUnicodeCharacter{0179}{\'Z}
8367 \DeclareUnicodeCharacter{017A}{\'z}
8368 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8369 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8370 \DeclareUnicodeCharacter{017D}{\v{Z}}
8371 \DeclareUnicodeCharacter{017E}{\v{z}}
8373 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8374 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8375 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8376 \DeclareUnicodeCharacter{01C7}{LJ}
8377 \DeclareUnicodeCharacter{01C8}{Lj}
8378 \DeclareUnicodeCharacter{01C9}{lj}
8379 \DeclareUnicodeCharacter{01CA}{NJ}
8380 \DeclareUnicodeCharacter{01CB}{Nj}
8381 \DeclareUnicodeCharacter{01CC}{nj}
8382 \DeclareUnicodeCharacter{01CD}{\v{A}}
8383 \DeclareUnicodeCharacter{01CE}{\v{a}}
8384 \DeclareUnicodeCharacter{01CF}{\v{I}}
8386 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8387 \DeclareUnicodeCharacter{01D1}{\v{O}}
8388 \DeclareUnicodeCharacter{01D2}{\v{o}}
8389 \DeclareUnicodeCharacter{01D3}{\v{U}}
8390 \DeclareUnicodeCharacter{01D4}{\v{u}}
8392 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8393 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8394 \DeclareUnicodeCharacter{01E6}{\v{G}}
8395 \DeclareUnicodeCharacter{01E7}{\v{g}}
8396 \DeclareUnicodeCharacter{01E8}{\v{K}}
8397 \DeclareUnicodeCharacter{01E9}{\v{k}}
8399 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8400 \DeclareUnicodeCharacter{01F1}{DZ}
8401 \DeclareUnicodeCharacter{01F2}{Dz}
8402 \DeclareUnicodeCharacter{01F3}{dz}
8403 \DeclareUnicodeCharacter{01F4}{\'G}
8404 \DeclareUnicodeCharacter{01F5}{\'g}
8405 \DeclareUnicodeCharacter{01F8}{\`N}
8406 \DeclareUnicodeCharacter{01F9}{\`n}
8407 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8408 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8409 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8410 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8412 \DeclareUnicodeCharacter{021E}{\v{H}}
8413 \DeclareUnicodeCharacter{021F}{\v{h}}
8415 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8416 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8417 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8418 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8419 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8420 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8422 \DeclareUnicodeCharacter{0232}{\=Y}
8423 \DeclareUnicodeCharacter{0233}{\=y}
8424 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8426 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8427 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8428 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8429 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8430 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8431 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8432 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8433 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8434 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8435 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8436 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8437 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8439 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8440 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8442 \DeclareUnicodeCharacter{1E20}{\=G}
8443 \DeclareUnicodeCharacter{1E21}{\=g}
8444 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8445 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8446 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8447 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8448 \DeclareUnicodeCharacter{1E26}{\"H}
8449 \DeclareUnicodeCharacter{1E27}{\"h}
8451 \DeclareUnicodeCharacter{1E30}{\'K}
8452 \DeclareUnicodeCharacter{1E31}{\'k}
8453 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8454 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8455 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8456 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8457 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8458 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8459 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8460 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8461 \DeclareUnicodeCharacter{1E3E}{\'M}
8462 \DeclareUnicodeCharacter{1E3F}{\'m}
8464 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8465 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8466 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8467 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8468 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8469 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8470 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8471 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8472 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8473 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8475 \DeclareUnicodeCharacter{1E54}{\'P}
8476 \DeclareUnicodeCharacter{1E55}{\'p}
8477 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8478 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8479 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8480 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8481 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8482 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8483 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8484 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8486 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8487 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8488 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8489 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8490 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8491 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8492 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8493 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8494 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8495 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8497 \DeclareUnicodeCharacter{1E7C}{\~V}
8498 \DeclareUnicodeCharacter{1E7D}{\~v}
8499 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8500 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8502 \DeclareUnicodeCharacter{1E80}{\`W}
8503 \DeclareUnicodeCharacter{1E81}{\`w}
8504 \DeclareUnicodeCharacter{1E82}{\'W}
8505 \DeclareUnicodeCharacter{1E83}{\'w}
8506 \DeclareUnicodeCharacter{1E84}{\"W}
8507 \DeclareUnicodeCharacter{1E85}{\"w}
8508 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8509 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8510 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8511 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8512 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8513 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8514 \DeclareUnicodeCharacter{1E8C}{\"X}
8515 \DeclareUnicodeCharacter{1E8D}{\"x}
8516 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8517 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8519 \DeclareUnicodeCharacter{1E90}{\^Z}
8520 \DeclareUnicodeCharacter{1E91}{\^z}
8521 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8522 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8523 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8524 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8525 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8526 \DeclareUnicodeCharacter{1E97}{\"t}
8527 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8528 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8530 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8531 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8533 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8534 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8535 \DeclareUnicodeCharacter{1EBC}{\~E}
8536 \DeclareUnicodeCharacter{1EBD}{\~e}
8538 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8539 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8540 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8541 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8543 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8544 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8546 \DeclareUnicodeCharacter{1EF2}{\`Y}
8547 \DeclareUnicodeCharacter{1EF3}{\`y}
8548 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8550 \DeclareUnicodeCharacter{1EF8}{\~Y}
8551 \DeclareUnicodeCharacter{1EF9}{\~y}
8553 \DeclareUnicodeCharacter{2013}{--}
8554 \DeclareUnicodeCharacter{2014}{---}
8555 \DeclareUnicodeCharacter{2018}{\quoteleft}
8556 \DeclareUnicodeCharacter{2019}{\quoteright}
8557 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8558 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8559 \DeclareUnicodeCharacter{201D}{\quotedblright}
8560 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8561 \DeclareUnicodeCharacter{2022}{\bullet}
8562 \DeclareUnicodeCharacter{2026}{\dots}
8563 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8564 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8565 \DeclareUnicodeCharacter{20AC}{\euro}
8567 \DeclareUnicodeCharacter{2192}{\expansion}
8568 \DeclareUnicodeCharacter{21D2}{\result}
8570 \DeclareUnicodeCharacter{2212}{\minus}
8571 \DeclareUnicodeCharacter{2217}{\point}
8572 \DeclareUnicodeCharacter{2261}{\equiv}
8573 }% end of \utfeightchardefs
8576 % US-ASCII character definitions.
8577 \def\asciichardefs{% nothing need be done
8581 % Make non-ASCII characters printable again for compatibility with
8582 % existing Texinfo documents that may use them, even without declaring a
8583 % document encoding.
8585 \setnonasciicharscatcode \other
8588 \message{formatting,}
8590 \newdimen\defaultparindent \defaultparindent = 15pt
8592 \chapheadingskip = 15pt plus 4pt minus 2pt
8593 \secheadingskip = 12pt plus 3pt minus 2pt
8594 \subsecheadingskip = 9pt plus 2pt minus 2pt
8596 % Prevent underfull vbox error messages.
8599 % Don't be so finicky about underfull hboxes, either.
8602 % Following George Bush, get rid of widows and orphans.
8606 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8607 % using an old version of TeX, don't do anything. We want the amount of
8608 % stretch added to depend on the line length, hence the dependence on
8609 % \hsize. We call this whenever the paper size is set.
8611 \def\setemergencystretch{%
8612 \ifx\emergencystretch\thisisundefined
8613 % Allow us to assign to \emergencystretch anyway.
8614 \def\emergencystretch{\dimen0}%
8616 \emergencystretch = .15\hsize
8620 % Parameters in order: 1) textheight; 2) textwidth;
8621 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8622 % 7) physical page height; 8) physical page width.
8624 % We also call \setleading{\textleading}, so the caller should define
8625 % \textleading. The caller should also set \parskip.
8627 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8630 \splittopskip = \topskip
8633 \advance\vsize by \topskip
8634 \outervsize = \vsize
8635 \advance\outervsize by 2\topandbottommargin
8636 \pageheight = \vsize
8639 \outerhsize = \hsize
8640 \advance\outerhsize by 0.5in
8643 \normaloffset = #4\relax
8644 \bindingoffset = #5\relax
8647 \pdfpageheight #7\relax
8648 \pdfpagewidth #8\relax
8649 % if we don't reset these, they will remain at "1 true in" of
8650 % whatever layout pdftex was dumped with.
8651 \pdfhorigin = 1 true in
8652 \pdfvorigin = 1 true in
8655 \setleading{\textleading}
8657 \parindent = \defaultparindent
8658 \setemergencystretch
8661 % @letterpaper (the default).
8662 \def\letterpaper{{\globaldefs = 1
8663 \parskip = 3pt plus 2pt minus 1pt
8664 \textleading = 13.2pt
8666 % If page is nothing but text, make it come out even.
8667 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8669 {\bindingoffset}{36pt}%
8673 % Use @smallbook to reset parameters for 7x9.25 trim size.
8674 \def\smallbook{{\globaldefs = 1
8675 \parskip = 2pt plus 1pt
8678 \internalpagesizes{7.5in}{5in}%
8680 {\bindingoffset}{16pt}%
8683 \lispnarrowing = 0.3in
8686 \contentsrightmargin = 0pt
8687 \defbodyindent = .5cm
8690 % Use @smallerbook to reset parameters for 6x9 trim size.
8691 % (Just testing, parameters still in flux.)
8692 \def\smallerbook{{\globaldefs = 1
8693 \parskip = 1.5pt plus 1pt
8696 \internalpagesizes{7.4in}{4.8in}%
8701 \lispnarrowing = 0.25in
8704 \contentsrightmargin = 0pt
8705 \defbodyindent = .4cm
8708 % Use @afourpaper to print on European A4 paper.
8709 \def\afourpaper{{\globaldefs = 1
8710 \parskip = 3pt plus 2pt minus 1pt
8711 \textleading = 13.2pt
8713 % Double-side printing via postscript on Laserjet 4050
8714 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8715 % To change the settings for a different printer or situation, adjust
8716 % \normaloffset until the front-side and back-side texts align. Then
8717 % do the same for \bindingoffset. You can set these for testing in
8718 % your texinfo source file like this:
8720 % \global\normaloffset = -6mm
8721 % \global\bindingoffset = 10mm
8723 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8724 {\voffset}{\hoffset}%
8725 {\bindingoffset}{44pt}%
8730 \contentsrightmargin = 0pt
8731 \defbodyindent = 5mm
8734 % Use @afivepaper to print on European A5 paper.
8735 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8736 % He also recommends making @example and @lisp be small.
8737 \def\afivepaper{{\globaldefs = 1
8738 \parskip = 2pt plus 1pt minus 0.1pt
8739 \textleading = 12.5pt
8741 \internalpagesizes{160mm}{120mm}%
8742 {\voffset}{\hoffset}%
8743 {\bindingoffset}{8pt}%
8746 \lispnarrowing = 0.2in
8749 \contentsrightmargin = 0pt
8750 \defbodyindent = 2mm
8754 % A specific text layout, 24x15cm overall, intended for A4 paper.
8755 \def\afourlatex{{\globaldefs = 1
8757 \internalpagesizes{237mm}{150mm}%
8759 {\bindingoffset}{7mm}%
8762 % Must explicitly reset to 0 because we call \afourpaper.
8766 % Use @afourwide to print on A4 paper in landscape format.
8767 \def\afourwide{{\globaldefs = 1
8769 \internalpagesizes{241mm}{165mm}%
8770 {\voffset}{-2.95mm}%
8771 {\bindingoffset}{7mm}%
8776 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8777 % Perhaps we should allow setting the margins, \topskip, \parskip,
8778 % and/or leading, also. Or perhaps we should compute them somehow.
8780 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8781 \def\pagesizesyyy#1,#2,#3\finish{{%
8782 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8785 \parskip = 3pt plus 2pt minus 1pt
8786 \setleading{\textleading}%
8789 \advance\dimen0 by \voffset
8792 \advance\dimen2 by \normaloffset
8794 \internalpagesizes{#1}{\hsize}%
8795 {\voffset}{\normaloffset}%
8796 {\bindingoffset}{44pt}%
8800 % Set default to letter.
8805 \message{and turning on texinfo input format.}
8807 % Define macros to output various characters with catcode for normal text.
8817 \def\normaldoublequote{"}
8820 \def\normalunderscore{_}
8821 \def\normalverticalbar{|}
8823 \def\normalgreater{>}
8825 \def\normaldollar{$}%$ font-lock fix
8827 % This macro is used to make a character print one way in \tt
8828 % (where it can probably be output as-is), and another way in other fonts,
8829 % where something hairier probably needs to be done.
8831 % #1 is what to print if we are indeed using \tt; #2 is what to print
8832 % otherwise. Since all the Computer Modern typewriter fonts have zero
8833 % interword stretch (and shrink), and it is reasonable to expect all
8834 % typewriter fonts to have this, we can check that font parameter.
8836 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8838 % Same as above, but check for italic font. Actually this also catches
8839 % non-italic slanted fonts since it is impossible to distinguish them from
8840 % italic fonts. But since this is only used by $ and it uses \sl anyway
8841 % this is not a problem.
8842 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8844 % Turn off all special characters except @
8845 % (and those which the user can use as if they were ordinary).
8846 % Most of these we simply print from the \tt font, but for some, we can
8847 % use math or other variants that look better in normal text.
8850 \def\activedoublequote{{\tt\char34}}
8851 \let"=\activedoublequote
8853 \def~{{\tt\char126}}
8859 \def_{\ifusingtt\normalunderscore\_}
8861 % Subroutine for the previous macro.
8862 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8865 \def|{{\tt\char124}}
8873 \def+{{\tt \char 43}}
8875 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8877 % If a .fmt file is being used, characters that might appear in a file
8878 % name cannot be active until we have parsed the command line.
8879 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8880 % \otherifyactive is called near the end of this file.
8881 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8883 % Used sometimes to turn off (effectively) the active characters even after
8885 \def\turnoffactive{%
8886 \normalturnoffactive
8892 % \backslashcurfont outputs one backslash character in current font,
8894 \global\chardef\backslashcurfont=`\\
8895 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8897 % \realbackslash is an actual character `\' with catcode other, and
8898 % \doublebackslash is two of them (for the pdf outlines).
8899 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8901 % In texinfo, backslash is an active character; it prints the backslash
8902 % in fixed width font.
8904 @def@normalbackslash{{@tt@backslashcurfont}}
8905 % On startup, @fixbackslash assigns:
8906 % @let \ = @normalbackslash
8908 % \rawbackslash defines an active \ to do \backslashcurfont.
8909 % \otherbackslash defines an active \ to be a literal `\' character with
8911 @gdef@rawbackslash{@let\=@backslashcurfont}
8912 @gdef@otherbackslash{@let\=@realbackslash}
8914 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8915 % the literal character `\'.
8917 @def@normalturnoffactive{%
8918 @let\=@normalbackslash
8919 @let"=@normaldoublequote
8922 @let_=@normalunderscore
8923 @let|=@normalverticalbar
8925 @let>=@normalgreater
8927 @let$=@normaldollar %$ font-lock fix
8931 % Make _ and + \other characters, temporarily.
8932 % This is canceled by @fixbackslash.
8935 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8936 % That is what \eatinput is for; after that, the `\' should revert to printing
8939 @gdef@eatinput input texinfo{@fixbackslash}
8940 @global@let\ = @eatinput
8942 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8943 % the first `\' in the file would cause an error. This macro tries to fix
8944 % that, assuming it is called before the first `\' could plausibly occur.
8945 % Also turn back on active characters that might appear in the input
8946 % file name, in case not using a pre-dumped format.
8948 @gdef@fixbackslash{%
8949 @ifx\@eatinput @let\ = @normalbackslash @fi
8954 % Say @foo, not \foo, in error messages.
8957 % These look ok in all fonts, so just make them not special.
8958 @catcode`@& = @other
8959 @catcode`@# = @other
8960 @catcode`@% = @other
8964 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8965 @c page-delimiter: "^\\\\message"
8966 @c time-stamp-start: "def\\\\texinfoversion{"
8967 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8968 @c time-stamp-end: "}"
8974 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115