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{2011-10-19.08}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011 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}
70 % We never want plain's \outer definition of \+ in Texinfo.
71 % For @tex, we can use \tabalign.
74 % Save some plain tex macros whose names we will redefine.
76 \let\ptexbullet=\bullet
84 \let\ptexfootnote=\footnote
88 \let\ptexindent=\indent
89 \let\ptexinsert=\insert
92 \let\ptexnewwrite\newwrite
93 \let\ptexnoindent=\noindent
95 \let\ptexraggedright=\raggedright
101 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\ampChar = `\&
162 \chardef\colonChar = `\:
163 \chardef\commaChar = `\,
164 \chardef\dashChar = `\-
165 \chardef\dotChar = `\.
166 \chardef\exclamChar= `\!
167 \chardef\hashChar = `\#
168 \chardef\lquoteChar= `\`
169 \chardef\questChar = `\?
170 \chardef\rquoteChar= `\'
171 \chardef\semiChar = `\;
172 \chardef\slashChar = `\/
173 \chardef\underChar = `\_
179 % The following is used inside several \edef's.
180 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
184 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
185 ap-pen-dix bit-map bit-maps
186 data-base data-bases eshell fall-ing half-way long-est man-u-script
187 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
188 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
190 stand-alone strong-est time-stamp time-stamps which-ever white-space
191 wide-spread wrap-around
194 % Margin to add to right of even pages, to left of odd pages.
195 \newdimen\bindingoffset
196 \newdimen\normaloffset
197 \newdimen\pagewidth \newdimen\pageheight
199 % For a final copy, take out the rectangles
200 % that mark overfull boxes (in case you have decided
201 % that the text looks ok even though it passes the margin).
203 \def\finalout{\overfullrule=0pt }
205 % Sometimes it is convenient to have everything in the transcript file
206 % and nothing on the terminal. We don't just call \tracingall here,
207 % since that produces some useless output on the terminal. We also make
208 % some effort to order the tracing commands to reduce output in the log
209 % file; cf. trace.sty in LaTeX.
211 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
215 \tracinglostchars2 % 2 gives us more in etex
220 \showboxbreadth\maxdimen \showboxdepth\maxdimen
221 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
228 \tracingcommands3 % 3 gives us more in etex
232 % add check for \lastpenalty to plain's definitions. If the last thing
233 % we did was a \nobreak, we don't want to insert more space.
235 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
236 \removelastskip\penalty-50\smallskip\fi\fi}
237 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
238 \removelastskip\penalty-100\medskip\fi\fi}
239 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
240 \removelastskip\penalty-200\bigskip\fi\fi}
242 % Do @cropmarks to get crop marks.
245 \let\cropmarks = \cropmarkstrue
247 % Dimensions to add cropmarks at corners.
248 % Added by P. A. MacKay, 12 Nov. 1986
250 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
251 \newdimen\cornerlong \cornerlong=1pc
252 \newdimen\cornerthick \cornerthick=.3pt
253 \newdimen\topandbottommargin \topandbottommargin=.75in
255 % Output a mark which sets \thischapter, \thissection and \thiscolor.
256 % We dump everything together because we only have one kind of mark.
257 % This works because we only use \botmark / \topmark, not \firstmark.
259 % A mark contains a subexpression of the \ifcase ... \fi construct.
260 % \get*marks macros below extract the needed part using \ifcase.
262 % Another complication is to let the user choose whether \thischapter
263 % (\thissection) refers to the chapter (section) in effect at the top
264 % of a page, or that at the bottom of a page. The solution is
265 % described on page 260 of The TeXbook. It involves outputting two
266 % marks for the sectioning macros, one before the section break, and
267 % one after. I won't pretend I can describe this better than DEK...
269 \toks0=\expandafter{\lastchapterdefs}%
270 \toks2=\expandafter{\lastsectiondefs}%
271 \toks4=\expandafter{\prevchapterdefs}%
272 \toks6=\expandafter{\prevsectiondefs}%
273 \toks8=\expandafter{\lastcolordefs}%
275 \the\toks0 \the\toks2
276 \noexpand\or \the\toks4 \the\toks6
277 \noexpand\else \the\toks8
280 % \topmark doesn't work for the very first chapter (after the title
281 % page or the contents), so we use \firstmark there -- this gets us
282 % the mark with the chapter defs, unless the user sneaks in, e.g.,
283 % @setcolor (or @url, or @link, etc.) between @contents and the very
285 \def\gettopheadingmarks{%
287 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
289 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
290 \def\getcolormarks{\ifcase2\topmark\fi}
292 % Avoid "undefined control sequence" errors.
293 \def\lastchapterdefs{}
294 \def\lastsectiondefs{}
295 \def\prevchapterdefs{}
296 \def\prevsectiondefs{}
299 % Main output routine.
301 \output = {\onepageout{\pagecontents\PAGE}}
306 % \onepageout takes a vbox as an argument. Note that \pagecontents
307 % does insertions, but you have to call it yourself.
309 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
311 \ifodd\pageno \advance\hoffset by \bindingoffset
312 \else \advance\hoffset by -\bindingoffset\fi
314 % Do this outside of the \shipout so @code etc. will be expanded in
315 % the headline as they should be, not taken literally (outputting ''code).
316 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
317 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
318 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
319 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
322 % Have to do this stuff outside the \shipout because we want it to
323 % take effect in \write's, yet the group defined by the \vbox ends
324 % before the \shipout runs.
326 \indexdummies % don't expand commands in the output.
327 \normalturnoffactive % \ in index entries must not stay \, e.g., if
328 % the page break happens to be in the middle of an example.
329 % We don't want .vr (or whatever) entries like this:
330 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
331 % "\acronym" won't work when it's read back in;
333 % {\code {{\tt \backslashcurfont }acronym}
335 % Do this early so pdf references go to the beginning of the page.
336 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
338 \ifcropmarks \vbox to \outervsize\bgroup
340 \vskip-\topandbottommargin
342 \line{\ewtop\hfil\ewtop}%
345 \vbox{\moveleft\cornerthick\nstop}%
347 \vbox{\moveright\cornerthick\nstop}%
350 \vskip\topandbottommargin
352 \hfil % center the page within the outer (page) hsize.
353 \ifodd\pageno\hskip\bindingoffset\fi
359 \ifdim\ht\footlinebox > 0pt
360 % Only leave this space if the footline is nonempty.
361 % (We lessened \vsize for it in \oddfootingyyy.)
362 % The \baselineskip=24pt in plain's \makefootline has no effect.
368 \egroup % end of \vbox\bgroup
369 \hfil\egroup % end of (centering) \line\bgroup
370 \vskip\topandbottommargin plus1fill minus1fill
371 \boxmaxdepth = \cornerthick
374 \vbox{\moveleft\cornerthick\nsbot}%
376 \vbox{\moveright\cornerthick\nsbot}%
379 \line{\ewbot\hfil\ewbot}%
381 \egroup % \vbox from first cropmarks clause
383 }% end of \shipout\vbox
384 }% end of group with \indexdummies
386 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
389 \newinsert\margin \dimen\margin=\maxdimen
391 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
393 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
394 % marginal hacks, juha@viisa.uucp (Juha Takala)
395 \ifvoid\margin\else % marginal info is present
396 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
397 \dimen@=\dp#1\relax \unvbox#1\relax
398 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
399 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
402 % Here are the rules for the cropmarks. Note that they are
403 % offset so that the space between them is truly \outerhsize or \outervsize
404 % (P. A. MacKay, 12 November, 1986)
406 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
408 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
409 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
411 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
413 % Parse an argument, then pass it to #1. The argument is the rest of
414 % the input line (except we remove a trailing comment). #1 should be a
415 % macro which expects an ordinary undelimited TeX argument.
417 \def\parsearg{\parseargusing{}}
418 \def\parseargusing#1#2{%
424 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
428 \gdef\parseargline#1^^M{%
429 \endgroup % End of the group started in \parsearg.
430 \argremovecomment #1\comment\ArgTerm%
434 % First remove any @comment, then any @c comment.
435 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
436 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
438 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
440 % \argremovec might leave us with trailing space, e.g.,
441 % @end itemize @c foo
442 % This space token undergoes the same procedure and is eventually removed
443 % by \finishparsearg.
445 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
446 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
447 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
450 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
451 \let\temp\finishparsearg
453 \let\temp\argcheckspaces
455 % Put the space token in:
459 % If a _delimited_ argument is enclosed in braces, they get stripped; so
460 % to get _exactly_ the rest of the line, we had to prevent such situation.
461 % We prepended an \empty token at the very beginning and we expand it now,
462 % just before passing the control to \argtorun.
463 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
464 % either the null string, or it ends with \^^M---thus there is no danger
465 % that a pair of braces would be stripped.
467 % But first, we have to remove the trailing space token.
469 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
471 % \parseargdef\foo{...}
472 % is roughly equivalent to
473 % \def\foo{\parsearg\Xfoo}
476 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
477 % favourite TeX trick. --kasal, 16nov03
480 \expandafter \doparseargdef \csname\string#1\endcsname #1%
482 \def\doparseargdef#1#2{%
487 % Several utility definitions with active space:
492 % Make each space character in the input produce a normal interword
493 % space in the output. Don't allow a line break at this space, as this
494 % is used only in environments like @example, where each line of input
495 % should produce a line of output anyway.
497 \gdef\sepspaces{\obeyspaces\let =\tie}
499 % If an index command is used in an @example environment, any spaces
500 % therein should become regular spaces in the raw index file, not the
501 % expansion of \tie (\leavevmode \penalty \@M \ ).
502 \gdef\unsepspaces{\let =\space}
506 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
508 % Define the framework for environments in texinfo.tex. It's used like this:
513 % It's the responsibility of \envdef to insert \begingroup before the
514 % actual body; @end closes the group after calling \Efoo. \envdef also
515 % defines \thisenv, so the current environment is known; @end checks
516 % whether the environment name matches. The \checkenv macro can also be
517 % used to check whether the current environment is the one expected.
519 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
520 % are not treated as environments; they don't open a group. (The
521 % implementation of @end takes care not to call \endgroup in this
525 % At run-time, environments start with this:
526 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
530 % ... but they get defined via ``\envdef\foo{...}'':
531 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
532 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
534 % Check whether we're in the right environment:
543 % Environment mismatch, #1 expected:
546 \errmessage{This command can appear only \inenvironment\temp,
547 not \inenvironment\thisenv}%
549 \def\inenvironment#1{%
551 outside of any environment%
553 in environment \expandafter\string#1%
557 % @end foo executes the definition of \Efoo.
558 % But first, it executes a specialized version of \checkenv
561 \if 1\csname iscond.#1\endcsname
563 % The general wording of \badenverr may not be ideal.
564 \expandafter\checkenv\csname#1\endcsname
565 \csname E#1\endcsname
570 \newhelp\EMsimple{Press RETURN to continue.}
573 % Be sure we're in horizontal mode when doing a tie, since we make space
574 % equivalent to this in @example-like environments. Otherwise, a space
575 % at the beginning of a line will start with \penalty -- and
576 % since \penalty is valid in vertical mode, we'd end up putting the
577 % penalty on the vertical list instead of in the new paragraph.
579 % Avoid using \@M directly, because that causes trouble
580 % if the definition is written into an index file.
581 \global\let\tiepenalty = \@M
582 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
585 % @: forces normal size whitespace following.
586 \def\:{\spacefactor=1000 }
588 % @* forces a line break.
589 \def\*{\hfil\break\hbox{}\ignorespaces}
591 % @/ allows a line break.
594 % @. is an end-of-sentence period.
595 \def\.{.\spacefactor=\endofsentencespacefactor\space}
597 % @! is an end-of-sentence bang.
598 \def\!{!\spacefactor=\endofsentencespacefactor\space}
600 % @? is an end-of-sentence query.
601 \def\?{?\spacefactor=\endofsentencespacefactor\space}
603 % @frenchspacing on|off says whether to put extra space after punctuation.
608 \parseargdef\frenchspacing{%
610 \ifx\temp\onword \plainfrenchspacing
611 \else\ifx\temp\offword \plainnonfrenchspacing
614 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
618 % @w prevents a word break. Without the \leavevmode, @w at the
619 % beginning of a paragraph, when TeX is still in vertical mode, would
620 % produce a whole line of output instead of starting the paragraph.
621 \def\w#1{\leavevmode\hbox{#1}}
623 % @group ... @end group forces ... to be all on one page, by enclosing
624 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
625 % to keep its height that of a normal line. According to the rules for
626 % \topskip (p.114 of the TeXbook), the glue inserted is
627 % max (\topskip - \ht (first item), 0). If that height is large,
628 % therefore, no glue is inserted, and the space between the headline and
629 % the text is small, which looks bad.
631 % Another complication is that the group might be very large. This can
632 % cause the glue on the previous page to be unduly stretched, because it
633 % does not have much material. In this case, it's better to add an
634 % explicit \vfill so that the extra space is at the bottom. The
635 % threshold for doing this is if the group is more than \vfilllimit
636 % percent of a page (\vfilllimit can be changed inside of @tex).
642 \ifnum\catcode`\^^M=\active \else
643 \errhelp = \groupinvalidhelp
644 \errmessage{@group invalid in context where filling is enabled}%
648 \setbox\groupbox = \vtop\bgroup
649 % Do @comment since we are called inside an environment such as
650 % @example, where each end-of-line in the input causes an
651 % end-of-line in the output. We don't want the end-of-line after
652 % the `@group' to put extra space in the output. Since @group
653 % should appear on a line by itself (according to the Texinfo
654 % manual), we don't worry about eating any user text.
658 % The \vtop produces a box with normal height and large depth; thus, TeX puts
659 % \baselineskip glue before it, and (when the next line of text is done)
660 % \lineskip glue after it. Thus, space below is not quite equal to space
661 % above. But it's pretty close.
663 % To get correct interline space between the last line of the group
664 % and the first line afterwards, we have to propagate \prevdepth.
665 \endgraf % Not \par, as it may have been set to \lisppar.
666 \global\dimen1 = \prevdepth
667 \egroup % End the \vtop.
668 % \dimen0 is the vertical size of the group's box.
669 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
670 % \dimen2 is how much space is left on the page (more or less).
671 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
672 % if the group doesn't fit on the current page, and it's a big big
673 % group, force a page break.
674 \ifdim \dimen0 > \dimen2
675 \ifdim \pagetotal < \vfilllimit\pageheight
684 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
685 % message, so this ends up printing `@group can only ...'.
687 \newhelp\groupinvalidhelp{%
688 group can only be used in environments such as @example,^^J%
689 where each line of input produces a line of output.}
691 % @need space-in-mils
692 % forces a page break if there is not space-in-mils remaining.
694 \newdimen\mil \mil=0.001in
697 % Ensure vertical mode, so we don't make a big box in the middle of a
701 % If the @need value is less than one line space, it's useless.
703 \dimen2 = \ht\strutbox
704 \advance\dimen2 by \dp\strutbox
705 \ifdim\dimen0 > \dimen2
707 % Do a \strut just to make the height of this box be normal, so the
708 % normal leading is inserted relative to the preceding line.
709 % And a page break here is fine.
710 \vtop to #1\mil{\strut\vfil}%
712 % TeX does not even consider page breaks if a penalty added to the
713 % main vertical list is 10000 or more. But in order to see if the
714 % empty box we just added fits on the page, we must make it consider
715 % page breaks. On the other hand, we don't want to actually break the
716 % page after the empty box. So we use a penalty of 9999.
718 % There is an extremely small chance that TeX will actually break the
719 % page at this \penalty, if there are no other feasible breakpoints in
720 % sight. (If the user is using lots of big @group commands, which
721 % almost-but-not-quite fill up a page, TeX will have a hard time doing
722 % good page breaking, for example.) However, I could not construct an
723 % example where a page broke at this \penalty; if it happens in a real
724 % document, then we can reconsider our strategy.
727 % Back up by the size of the box, whether we did a page break or not.
730 % Do not allow a page break right after this kern.
735 % @br forces paragraph break (and is undocumented).
739 % @page forces the start of a new page.
741 \def\page{\par\vfill\supereject}
744 % outputs text on separate line in roman font, starting at standard page margin
746 % This records the amount of indent in the innermost environment.
747 % That's how much \exdent should take out.
748 \newskip\exdentamount
750 % This defn is used inside fill environments such as @defun.
751 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
753 % This defn is used inside nofill environments such as @example.
754 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
755 \leftline{\hskip\leftskip{\rm#1}}}}
757 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
758 % paragraph. For more general purposes, use the \margin insertion
759 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
761 \newskip\inmarginspacing \inmarginspacing=1cm
762 \def\strutdepth{\dp\strutbox}
764 \def\doinmargin#1#2{\strut\vadjust{%
767 \vtop to \strutdepth{%
768 \baselineskip=\strutdepth
770 % if you have multiple lines of stuff to put here, you'll need to
771 % make the vbox yourself of the appropriate size.
773 \llap{\ignorespaces #2\hskip\inmarginspacing}%
775 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
780 \def\inleftmargin{\doinmargin l}
781 \def\inrightmargin{\doinmargin r}
783 % @inmargin{TEXT [, RIGHT-TEXT]}
784 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
785 % else use TEXT for both).
787 \def\inmargin#1{\parseinmargin #1,,\finish}
788 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
789 \setbox0 = \hbox{\ignorespaces #2}%
791 \def\lefttext{#1}% have both texts
794 \def\lefttext{#1}% have only one text
799 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
801 \def\temp{\inleftmargin\lefttext}%
806 % @| inserts a changebar to the left of the current line. It should
807 % surround any changed text. This approach does *not* work if the
808 % change spans more than two lines of output. To handle that, we would
809 % have adopt a much more difficult approach (putting marks into the main
810 % vertical list for the beginning and end of each change). This command
811 % is not documented, not supported, and doesn't work.
814 % \vadjust can only be used in horizontal mode.
817 % Append this vertical mode material after the current line in the output.
819 % We want to insert a rule with the height and depth of the current
820 % leading; that is exactly what \strutbox is supposed to record.
823 % \vadjust-items are inserted at the left edge of the type. So
824 % the \llap here moves out into the left-hand margin.
827 % For a thicker or thinner bar, change the `1pt'.
828 \vrule height\baselineskip width1pt
830 % This is the space between the bar and the text.
836 % @include FILE -- \input text of FILE.
838 \def\include{\parseargusing\filenamecatcodes\includezzz}
843 \makevalueexpandable % we want to expand any @value in FILE.
844 \turnoffactive % and allow special characters in the expansion
845 \indexnofonts % Allow `@@' and other weird things in file names.
846 \wlog{texinfo.tex: doing @include of #1^^J}%
847 \edef\temp{\noexpand\input #1 }%
849 % This trickery is to read FILE outside of a group, in case it makes
855 \def\filenamecatcodes{%
869 \def\pushthisfilestack{%
870 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
872 \def\pushthisfilestackX{%
873 \expandafter\pushthisfilestackY\thisfile\StackTerm
875 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
876 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
879 \def\popthisfilestack{\errthisfilestackempty}
880 \def\errthisfilestackempty{\errmessage{Internal error:
881 the stack of filenames is empty.}}
886 % outputs that line, centered.
888 \parseargdef\center{%
894 \next{\hfil \ignorespaces#1\unskip \hfil}%
899 \advance\hsize by -\leftskip
900 \advance\hsize by -\rightskip
905 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
907 % @sp n outputs n lines of vertical space
909 \parseargdef\sp{\vskip #1\baselineskip}
911 % @comment ...line which is ignored...
912 % @c is the same as @comment
913 % @ignore ... @end ignore is another way to write a comment
915 \def\comment{\begingroup \catcode`\^^M=\other%
916 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
918 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
922 % @paragraphindent NCHARS
923 % We'll use ems for NCHARS, close enough.
924 % NCHARS can also be the word `asis' or `none'.
925 % We cannot feasibly implement @paragraphindent asis, though.
927 \def\asisword{asis} % no translation, these are keywords
930 \parseargdef\paragraphindent{%
935 \defaultparindent = 0pt
937 \defaultparindent = #1em
940 \parindent = \defaultparindent
943 % @exampleindent NCHARS
944 % We'll use ems for NCHARS like @paragraphindent.
945 % It seems @exampleindent asis isn't necessary, but
946 % I preserve it to make it similar to @paragraphindent.
947 \parseargdef\exampleindent{%
954 \lispnarrowing = #1em
959 % @firstparagraphindent WORD
960 % If WORD is `none', then suppress indentation of the first paragraph
961 % after a section heading. If WORD is `insert', then do indent at such
964 % The paragraph indentation is suppressed or not by calling
965 % \suppressfirstparagraphindent, which the sectioning commands do.
966 % We switch the definition of this back and forth according to WORD.
967 % By default, we suppress indentation.
969 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
970 \def\insertword{insert}
972 \parseargdef\firstparagraphindent{%
975 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
976 \else\ifx\temp\insertword
977 \let\suppressfirstparagraphindent = \relax
980 \errmessage{Unknown @firstparagraphindent option `\temp'}%
984 % Here is how we actually suppress indentation. Redefine \everypar to
985 % \kern backwards by \parindent, and then reset itself to empty.
987 % We also make \indent itself not actually do anything until the next
990 \gdef\dosuppressfirstparagraphindent{%
992 \restorefirstparagraphindent
996 \restorefirstparagraphindent
999 \global\everypar = {%
1001 \restorefirstparagraphindent
1005 \gdef\restorefirstparagraphindent{%
1006 \global \let \indent = \ptexindent
1007 \global \let \noindent = \ptexnoindent
1008 \global \everypar = {}%
1012 % @refill is a no-op.
1015 % If working on a large document in chapters, it is convenient to
1016 % be able to disable indexing, cross-referencing, and contents, for test runs.
1017 % This is done with @novalidate (before @setfilename).
1019 \newif\iflinks \linkstrue % by default we want the aux files.
1020 \let\novalidate = \linksfalse
1022 % @setfilename is done at the beginning of every texinfo file.
1023 % So open here the files we need to have open while reading the input.
1024 % This makes it possible to make a .fmt file for texinfo.
1026 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1029 % Open the new aux file. TeX will close it automatically at exit.
1030 \immediate\openout\auxfile=\jobname.aux
1031 \fi % \openindices needs to do some work in any case.
1033 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1035 % If texinfo.cnf is present on the system, read it.
1036 % Useful for site-wide @afourpaper, etc.
1037 \openin 1 texinfo.cnf
1038 \ifeof 1 \else \input texinfo.cnf \fi
1041 \comment % Ignore the actual filename.
1044 % Called from \setfilename.
1056 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1060 % adobe `portable' document format
1064 \newcount\filenamelength
1073 \newif\ifpdfmakepagedest
1075 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1076 % can be set). So we test for \relax and 0 as well as being undefined.
1077 \ifx\pdfoutput\thisisundefined
1079 \ifx\pdfoutput\relax
1088 % PDF uses PostScript string constants for the names of xref targets,
1089 % for display in the outlines, and in other places. Thus, we have to
1090 % double any backslashes. Otherwise, a name like "\node" will be
1091 % interpreted as a newline (\n), followed by o, d, e. Not good.
1092 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1093 % (and related messages, the final outcome is that it is up to the TeX
1094 % user to double the backslashes and otherwise make the string valid, so
1095 % that's what we do).
1097 % double active backslashes.
1099 {\catcode`\@=0 \catcode`\\=\active
1100 @gdef@activebackslashdouble{%
1102 @let\=@doublebackslash}
1105 % To handle parens, we must adopt a different approach, since parens are
1106 % not active characters. hyperref.dtx (which has the same problem as
1107 % us) handles it with this amazing macro to replace tokens, with minor
1108 % changes for Texinfo. It is included here under the GPL by permission
1109 % from the author, Heiko Oberdiek.
1111 % #1 is the tokens to replace.
1112 % #2 is the replacement.
1113 % #3 is the control sequence with the string.
1115 \def\HyPsdSubst#1#2#3{%
1116 \def\HyPsdReplace##1#1##2\END{%
1122 \HyPsdReplace##2\END
1126 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1128 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1130 % #1 is a control sequence in which to do the replacements.
1131 \def\backslashparens#1{%
1132 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1133 % \lastnode when called from \setref -> \pdfmkdest.
1134 \HyPsdSubst{(}{\realbackslash(}{#1}%
1135 \HyPsdSubst{)}{\realbackslash)}{#1}%
1138 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1139 with PDF output, and none of those formats could be found. (.eps cannot
1140 be supported due to the design of the PDF format; use regular TeX (DVI
1145 % Color manipulation macros based on pdfcolor.tex,
1146 % except using rgb instead of cmyk; the latter is said to render as a
1147 % very dark gray on-screen and a very dark halftone in print, instead
1149 \def\rgbDarkRed{0.50 0.09 0.12}
1150 \def\rgbBlack{0 0 0}
1152 % k sets the color for filling (usual text, etc.);
1153 % K sets the color for stroking (thin rules, e.g., normal _'s).
1154 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1156 % Set color, and create a mark which defines \thiscolor accordingly,
1157 % so that \makeheadline knows which color to restore.
1159 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1164 \def\maincolor{\rgbBlack}
1165 \pdfsetcolor{\maincolor}
1166 \edef\thiscolor{\maincolor}
1167 \def\lastcolordefs{}
1171 \line{\pdfsetcolor{\maincolor}\the\footline}%
1179 % Extract \thiscolor definition from the marks.
1181 % Typeset the headline with \maincolor, then restore the color.
1182 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1190 \pdfcatalog{/PageMode /UseOutlines}
1192 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1193 \def\dopdfimage#1#2#3{%
1194 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1195 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1197 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1198 % others). Let's try in that order.
1199 \let\pdfimgext=\empty
1201 \openin 1 #1.png \ifeof 1
1202 \openin 1 #1.jpg \ifeof 1
1203 \openin 1 #1.jpeg \ifeof 1
1204 \openin 1 #1.JPG \ifeof 1
1205 \openin 1 #1.pdf \ifeof 1
1206 \openin 1 #1.PDF \ifeof 1
1207 \errhelp = \nopdfimagehelp
1208 \errmessage{Could not find image file #1 for pdf}%
1209 \else \gdef\pdfimgext{PDF}%
1211 \else \gdef\pdfimgext{pdf}%
1213 \else \gdef\pdfimgext{JPG}%
1215 \else \gdef\pdfimgext{jpeg}%
1217 \else \gdef\pdfimgext{jpg}%
1219 \else \gdef\pdfimgext{png}%
1224 % without \immediate, ancient pdftex seg faults when the same image is
1225 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1226 \ifnum\pdftexversion < 14
1229 \immediate\pdfximage
1231 \ifdim \wd0 >0pt width \imagewidth \fi
1232 \ifdim \wd2 >0pt height \imageheight \fi
1233 \ifnum\pdftexversion<13
1238 \ifnum\pdftexversion < 14 \else
1239 \pdfrefximage \pdflastximage
1243 % We have to set dummies so commands such as @code, and characters
1244 % such as \, aren't expanded when present in a section title.
1247 \activebackslashdouble
1248 \makevalueexpandable
1249 \def\pdfdestname{#1}%
1250 \backslashparens\pdfdestname
1251 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1254 % used to mark target names; must be expandable.
1257 % by default, use a color that is dark enough to print on paper as
1258 % nearly black, but still distinguishable for online viewing.
1259 \def\urlcolor{\rgbDarkRed}
1260 \def\linkcolor{\rgbDarkRed}
1261 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1263 % Adding outlines to PDF; macros for calculating structure of outlines
1264 % come from Petr Olsak
1265 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1266 \else \csname#1\endcsname \fi}
1267 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1268 \advance\tempnum by 1
1269 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1271 % #1 is the section text, which is what will be displayed in the
1272 % outline by the pdf viewer. #2 is the pdf expression for the number
1273 % of subentries (or empty, for subsubsections). #3 is the node text,
1274 % which might be empty if this toc entry had no corresponding node.
1275 % #4 is the page number
1277 \def\dopdfoutline#1#2#3#4{%
1278 % Generate a link to the node text if that exists; else, use the
1279 % page number. We could generate a destination for the section
1280 % text in the case where a section has no node, but it doesn't
1281 % seem worth the trouble, since most documents are normally structured.
1282 \def\pdfoutlinedest{#3}%
1283 \ifx\pdfoutlinedest\empty
1284 \def\pdfoutlinedest{#4}%
1286 % Doubled backslashes in the name.
1287 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1288 \backslashparens\pdfoutlinedest}%
1291 % Also double the backslashes in the display string.
1292 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1293 \backslashparens\pdfoutlinetext}%
1295 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1298 \def\pdfmakeoutlines{%
1300 % Thanh's hack / proper braces in bookmarks
1301 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1302 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1304 % Read toc silently, to get counts of subentries for \pdfoutline.
1305 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1306 \def\numchapentry##1##2##3##4{%
1307 \def\thischapnum{##2}%
1309 \def\thissubsecnum{0}%
1311 \def\numsecentry##1##2##3##4{%
1312 \advancenumber{chap\thischapnum}%
1313 \def\thissecnum{##2}%
1314 \def\thissubsecnum{0}%
1316 \def\numsubsecentry##1##2##3##4{%
1317 \advancenumber{sec\thissecnum}%
1318 \def\thissubsecnum{##2}%
1320 \def\numsubsubsecentry##1##2##3##4{%
1321 \advancenumber{subsec\thissubsecnum}%
1323 \def\thischapnum{0}%
1325 \def\thissubsecnum{0}%
1327 % use \def rather than \let here because we redefine \chapentry et
1328 % al. a second time, below.
1329 \def\appentry{\numchapentry}%
1330 \def\appsecentry{\numsecentry}%
1331 \def\appsubsecentry{\numsubsecentry}%
1332 \def\appsubsubsecentry{\numsubsubsecentry}%
1333 \def\unnchapentry{\numchapentry}%
1334 \def\unnsecentry{\numsecentry}%
1335 \def\unnsubsecentry{\numsubsecentry}%
1336 \def\unnsubsubsecentry{\numsubsubsecentry}%
1339 % Read toc second time, this time actually producing the outlines.
1340 % The `-' means take the \expnumber as the absolute number of
1341 % subentries, which we calculated on our first read of the .toc above.
1343 % We use the node names as the destinations.
1344 \def\numchapentry##1##2##3##4{%
1345 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1346 \def\numsecentry##1##2##3##4{%
1347 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1348 \def\numsubsecentry##1##2##3##4{%
1349 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1350 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1351 \dopdfoutline{##1}{}{##3}{##4}}%
1353 % PDF outlines are displayed using system fonts, instead of
1354 % document fonts. Therefore we cannot use special characters,
1355 % since the encoding is unknown. For example, the eogonek from
1356 % Latin 2 (0xea) gets translated to a | character. Info from
1357 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1359 % xx to do this right, we have to translate 8-bit characters to
1360 % their "best" equivalent, based on the @documentencoding. Right
1361 % now, I guess we'll just let the pdf reader have its way.
1364 \catcode`\\=\active \otherbackslash
1365 \input \tocreadfilename
1369 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1370 \ifx\PP\D\let\nextsp\relax
1371 \else\let\nextsp\skipspaces
1372 \ifx\p\space\else\addtokens{\filename}{\PP}%
1373 \advance\filenamelength by 1
1377 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1378 \ifnum\pdftexversion < 14
1379 \let \startlink \pdfannotlink
1381 \let \startlink \pdfstartlink
1383 % make a live url in pdf output.
1386 % it seems we really need yet another set of dummies; have not
1387 % tried to figure out what each command should do in the context
1388 % of @url. for now, just make @/ a no-op, that's the only one
1389 % people have actually reported a problem with.
1391 \normalturnoffactive
1394 \makevalueexpandable
1395 % do we want to go so far as to use \indexnofonts instead of just
1396 % special-casing \var here?
1399 \leavevmode\setcolor{\urlcolor}%
1400 \startlink attr{/Border [0 0 0]}%
1401 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1403 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1404 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1405 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1406 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1408 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1410 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1411 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1412 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1414 \ifnum0=\countA\else\makelink\fi
1415 \ifx\first.\let\next=\done\else
1417 \addtokens{\toksB}{\the\toksD}
1418 \ifx\first,\addtokens{\toksB}{\space}\fi
1420 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1422 \def\makelink{\addtokens{\toksB}%
1423 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1425 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1426 \setcolor{\linkcolor}#1\endlink}
1427 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1430 \let\pdfmkdest = \gobble
1431 \let\pdfurl = \gobble
1432 \let\endlink = \relax
1433 \let\setcolor = \gobble
1434 \let\pdfsetcolor = \gobble
1435 \let\pdfmakeoutlines = \relax
1436 \fi % \ifx\pdfoutput
1441 % Change the current font style to #1, remembering it in \curfontstyle.
1442 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1443 % italics, not bold italics.
1445 \def\setfontstyle#1{%
1446 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1447 \csname ten#1\endcsname % change the current font
1450 % Select #1 fonts with the current style.
1452 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1454 \def\rm{\fam=0 \setfontstyle{rm}}
1455 \def\it{\fam=\itfam \setfontstyle{it}}
1456 \def\sl{\fam=\slfam \setfontstyle{sl}}
1457 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1458 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1460 % Unfortunately, we have to override this for titles and the like, since
1461 % in those cases "rm" is bold. Sigh.
1462 \def\rmisbold{\rm\def\curfontstyle{bf}}
1464 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1465 % So we set up a \sf.
1467 \def\sf{\fam=\sffam \setfontstyle{sf}}
1468 \let\li = \sf % Sometimes we call it \li, not \sf.
1470 % We don't need math for this font style.
1471 \def\ttsl{\setfontstyle{ttsl}}
1475 \newdimen\textleading \textleading = 13.2pt
1477 % Set the baselineskip to #1, and the lineskip and strut size
1478 % correspondingly. There is no deep meaning behind these magic numbers
1479 % used as factors; they just match (closely enough) what Knuth defined.
1481 \def\lineskipfactor{.08333}
1482 \def\strutheightpercent{.70833}
1483 \def\strutdepthpercent {.29167}
1485 % can get a sort of poor man's double spacing by redefining this.
1486 \def\baselinefactor{1}
1490 \normalbaselineskip = \baselinefactor\dimen0
1491 \normallineskip = \lineskipfactor\normalbaselineskip
1493 \setbox\strutbox =\hbox{%
1494 \vrule width0pt height\strutheightpercent\baselineskip
1495 depth \strutdepthpercent \baselineskip
1499 % PDF CMaps. See also LaTeX's t1.cmap.
1501 % do nothing with this by default.
1502 \expandafter\let\csname cmapOT1\endcsname\gobble
1503 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1504 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1506 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1507 % (\pdffontattr was introduced many years ago, but people still run
1508 % older pdftex's; it's easy to conditionalize, so we do.)
1509 \ifpdf \ifx\pdffontattr\thisisundefined \else
1511 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1512 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1513 %%DocumentNeededResources: ProcSet (CIDInit)
1514 %%IncludeResource: ProcSet (CIDInit)
1515 %%BeginResource: CMap (TeX-OT1-0)
1516 %%Title: (TeX-OT1-0 TeX OT1 0)
1519 /CIDInit /ProcSet findresource begin
1527 /CMapName /TeX-OT1-0 def
1529 1 begincodespacerange
1585 CMapName currentdict /CMap defineresource pop
1591 \expandafter\edef\csname cmapOT1\endcsname#1{%
1592 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1597 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1598 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1599 %%DocumentNeededResources: ProcSet (CIDInit)
1600 %%IncludeResource: ProcSet (CIDInit)
1601 %%BeginResource: CMap (TeX-OT1IT-0)
1602 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1605 /CIDInit /ProcSet findresource begin
1613 /CMapName /TeX-OT1IT-0 def
1615 1 begincodespacerange
1673 CMapName currentdict /CMap defineresource pop
1679 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1680 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1685 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1686 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1687 %%DocumentNeededResources: ProcSet (CIDInit)
1688 %%IncludeResource: ProcSet (CIDInit)
1689 %%BeginResource: CMap (TeX-OT1TT-0)
1690 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1693 /CIDInit /ProcSet findresource begin
1701 /CMapName /TeX-OT1TT-0 def
1703 1 begincodespacerange
1748 CMapName currentdict /CMap defineresource pop
1754 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1755 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1760 % Set the font macro #1 to the font named #2, adding on the
1761 % specified font prefix (normally `cm').
1762 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1763 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1765 \def\setfont#1#2#3#4#5{%
1766 \font#1=\fontprefix#2#3 scaled #4
1767 \csname cmap#5\endcsname#1%
1769 % This is what gets called when #5 of \setfont is empty.
1771 % emacs-page end of cmaps
1773 % Use cm as the default font prefix.
1774 % To specify the font prefix, you must define \fontprefix
1775 % before you read in texinfo.tex.
1776 \ifx\fontprefix\thisisundefined
1779 % Support font families that don't use the same naming scheme as CM.
1781 \def\rmbshape{bx} %where the normal face is bold
1786 \def\ttslshape{sltt}
1796 % Definitions for a main text size of 11pt. This is the default in
1799 \def\definetextfontsizexi{%
1800 % Text fonts (11.2pt, magstep1).
1801 \def\textnominalsize{11pt}
1802 \edef\mainmagstep{\magstephalf}
1803 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1804 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1805 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1806 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1807 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1808 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1809 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1810 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1811 \font\texti=cmmi10 scaled \mainmagstep
1812 \font\textsy=cmsy10 scaled \mainmagstep
1813 \def\textecsize{1095}
1815 % A few fonts for @defun names and args.
1816 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1817 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1818 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1819 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1821 % Fonts for indices, footnotes, small examples (9pt).
1822 \def\smallnominalsize{9pt}
1823 \setfont\smallrm\rmshape{9}{1000}{OT1}
1824 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1825 \setfont\smallbf\bfshape{10}{900}{OT1}
1826 \setfont\smallit\itshape{9}{1000}{OT1IT}
1827 \setfont\smallsl\slshape{9}{1000}{OT1}
1828 \setfont\smallsf\sfshape{9}{1000}{OT1}
1829 \setfont\smallsc\scshape{10}{900}{OT1}
1830 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1833 \def\smallecsize{0900}
1835 % Fonts for small examples (8pt).
1836 \def\smallernominalsize{8pt}
1837 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1838 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1839 \setfont\smallerbf\bfshape{10}{800}{OT1}
1840 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1841 \setfont\smallersl\slshape{8}{1000}{OT1}
1842 \setfont\smallersf\sfshape{8}{1000}{OT1}
1843 \setfont\smallersc\scshape{10}{800}{OT1}
1844 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1845 \font\smalleri=cmmi8
1846 \font\smallersy=cmsy8
1847 \def\smallerecsize{0800}
1849 % Fonts for title page (20.4pt):
1850 \def\titlenominalsize{20pt}
1851 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1852 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1853 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1854 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1855 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1856 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1857 \let\titlebf=\titlerm
1858 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1859 \font\titlei=cmmi12 scaled \magstep3
1860 \font\titlesy=cmsy10 scaled \magstep4
1861 \def\titleecsize{2074}
1863 % Chapter (and unnumbered) fonts (17.28pt).
1864 \def\chapnominalsize{17pt}
1865 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1866 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1867 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1868 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1869 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1870 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1872 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1873 \font\chapi=cmmi12 scaled \magstep2
1874 \font\chapsy=cmsy10 scaled \magstep3
1875 \def\chapecsize{1728}
1877 % Section fonts (14.4pt).
1878 \def\secnominalsize{14pt}
1879 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1880 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1881 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1882 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1883 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1884 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1886 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1887 \font\seci=cmmi12 scaled \magstep1
1888 \font\secsy=cmsy10 scaled \magstep2
1889 \def\sececsize{1440}
1891 % Subsection fonts (13.15pt).
1892 \def\ssecnominalsize{13pt}
1893 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1894 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1895 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1896 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1897 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1898 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1900 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1901 \font\sseci=cmmi12 scaled \magstephalf
1902 \font\ssecsy=cmsy10 scaled 1315
1903 \def\ssececsize{1200}
1905 % Reduced fonts for @acro in text (10pt).
1906 \def\reducednominalsize{10pt}
1907 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1908 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1909 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1910 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1911 \setfont\reducedsl\slshape{10}{1000}{OT1}
1912 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1913 \setfont\reducedsc\scshape{10}{1000}{OT1}
1914 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1915 \font\reducedi=cmmi10
1916 \font\reducedsy=cmsy10
1917 \def\reducedecsize{1000}
1919 \textleading = 13.2pt % line spacing for 11pt CM
1920 \textfonts % reset the current fonts
1922 } % end of 11pt text font size definitions
1925 % Definitions to make the main text be 10pt Computer Modern, with
1926 % section, chapter, etc., sizes following suit. This is for the GNU
1927 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1928 % future. Used with @smallbook, which sets the leading to 12pt.
1930 \def\definetextfontsizex{%
1931 % Text fonts (10pt).
1932 \def\textnominalsize{10pt}
1933 \edef\mainmagstep{1000}
1934 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1935 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1936 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1937 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1938 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1939 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1940 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1941 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1942 \font\texti=cmmi10 scaled \mainmagstep
1943 \font\textsy=cmsy10 scaled \mainmagstep
1944 \def\textecsize{1000}
1946 % A few fonts for @defun names and args.
1947 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1948 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1949 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1950 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1952 % Fonts for indices, footnotes, small examples (9pt).
1953 \def\smallnominalsize{9pt}
1954 \setfont\smallrm\rmshape{9}{1000}{OT1}
1955 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1956 \setfont\smallbf\bfshape{10}{900}{OT1}
1957 \setfont\smallit\itshape{9}{1000}{OT1IT}
1958 \setfont\smallsl\slshape{9}{1000}{OT1}
1959 \setfont\smallsf\sfshape{9}{1000}{OT1}
1960 \setfont\smallsc\scshape{10}{900}{OT1}
1961 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1964 \def\smallecsize{0900}
1966 % Fonts for small examples (8pt).
1967 \def\smallernominalsize{8pt}
1968 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1969 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1970 \setfont\smallerbf\bfshape{10}{800}{OT1}
1971 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1972 \setfont\smallersl\slshape{8}{1000}{OT1}
1973 \setfont\smallersf\sfshape{8}{1000}{OT1}
1974 \setfont\smallersc\scshape{10}{800}{OT1}
1975 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1976 \font\smalleri=cmmi8
1977 \font\smallersy=cmsy8
1978 \def\smallerecsize{0800}
1980 % Fonts for title page (20.4pt):
1981 \def\titlenominalsize{20pt}
1982 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1983 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1984 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1985 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1986 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1987 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1988 \let\titlebf=\titlerm
1989 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1990 \font\titlei=cmmi12 scaled \magstep3
1991 \font\titlesy=cmsy10 scaled \magstep4
1992 \def\titleecsize{2074}
1994 % Chapter fonts (14.4pt).
1995 \def\chapnominalsize{14pt}
1996 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
1997 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
1998 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
1999 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2000 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2001 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2003 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2004 \font\chapi=cmmi12 scaled \magstep1
2005 \font\chapsy=cmsy10 scaled \magstep2
2006 \def\chapecsize{1440}
2008 % Section fonts (12pt).
2009 \def\secnominalsize{12pt}
2010 \setfont\secrm\rmbshape{12}{1000}{OT1}
2011 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2012 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2013 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2014 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2015 \setfont\secsf\sfbshape{12}{1000}{OT1}
2017 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2019 \font\secsy=cmsy10 scaled \magstep1
2020 \def\sececsize{1200}
2022 % Subsection fonts (10pt).
2023 \def\ssecnominalsize{10pt}
2024 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2025 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2026 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2027 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2028 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2029 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2031 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2034 \def\ssececsize{1000}
2036 % Reduced fonts for @acro in text (9pt).
2037 \def\reducednominalsize{9pt}
2038 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2039 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2040 \setfont\reducedbf\bfshape{10}{900}{OT1}
2041 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2042 \setfont\reducedsl\slshape{9}{1000}{OT1}
2043 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2044 \setfont\reducedsc\scshape{10}{900}{OT1}
2045 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2046 \font\reducedi=cmmi9
2047 \font\reducedsy=cmsy9
2048 \def\reducedecsize{0900}
2050 \divide\parskip by 2 % reduce space between paragraphs
2051 \textleading = 12pt % line spacing for 10pt CM
2052 \textfonts % reset the current fonts
2054 } % end of 10pt text font size definitions
2057 % We provide the user-level command
2059 % (or 11) to redefine the text font size. pt is assumed.
2065 \parseargdef\fonttextsize{%
2066 \def\textsizearg{#1}%
2067 %\wlog{doing @fonttextsize \textsizearg}%
2069 % Set \globaldefs so that documents can use this inside @tex, since
2070 % makeinfo 4.8 does not support it, but we need it nonetheless.
2072 \begingroup \globaldefs=1
2073 \ifx\textsizearg\xword \definetextfontsizex
2074 \else \ifx\textsizearg\xiword \definetextfontsizexi
2077 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2083 % In order for the font changes to affect most math symbols and letters,
2084 % we have to define the \textfont of the standard families. Since
2085 % texinfo doesn't allow for producing subscripts and superscripts except
2086 % in the main text, we don't bother to reset \scriptfont and
2087 % \scriptscriptfont (which would also require loading a lot more fonts).
2089 \def\resetmathfonts{%
2090 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2091 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2092 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2095 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2096 % of just \STYLE. We do this because \STYLE needs to also set the
2097 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2098 % \tenSTYLE to set the current font.
2100 % Each font-changing command also sets the names \lsize (one size lower)
2101 % and \lllsize (three sizes lower). These relative commands are used in
2102 % the LaTeX logo and acronyms.
2104 % This all needs generalizing, badly.
2107 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2108 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2109 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2110 \let\tenttsl=\textttsl
2111 \def\curfontsize{text}%
2112 \def\lsize{reduced}\def\lllsize{smaller}%
2113 \resetmathfonts \setleading{\textleading}}
2115 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2116 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2117 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2118 \let\tenttsl=\titlettsl
2119 \def\curfontsize{title}%
2120 \def\lsize{chap}\def\lllsize{subsec}%
2121 \resetmathfonts \setleading{27pt}}
2122 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2124 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2125 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2126 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2127 \let\tenttsl=\chapttsl
2128 \def\curfontsize{chap}%
2129 \def\lsize{sec}\def\lllsize{text}%
2130 \resetmathfonts \setleading{19pt}}
2132 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2133 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2134 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2135 \let\tenttsl=\secttsl
2136 \def\curfontsize{sec}%
2137 \def\lsize{subsec}\def\lllsize{reduced}%
2138 \resetmathfonts \setleading{16pt}}
2140 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2141 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2142 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2143 \let\tenttsl=\ssecttsl
2144 \def\curfontsize{ssec}%
2145 \def\lsize{text}\def\lllsize{small}%
2146 \resetmathfonts \setleading{15pt}}
2147 \let\subsubsecfonts = \subsecfonts
2149 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2150 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2151 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2152 \let\tenttsl=\reducedttsl
2153 \def\curfontsize{reduced}%
2154 \def\lsize{small}\def\lllsize{smaller}%
2155 \resetmathfonts \setleading{10.5pt}}
2157 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2158 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2159 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2160 \let\tenttsl=\smallttsl
2161 \def\curfontsize{small}%
2162 \def\lsize{smaller}\def\lllsize{smaller}%
2163 \resetmathfonts \setleading{10.5pt}}
2165 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2166 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2167 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2168 \let\tenttsl=\smallerttsl
2169 \def\curfontsize{smaller}%
2170 \def\lsize{smaller}\def\lllsize{smaller}%
2171 \resetmathfonts \setleading{9.5pt}}
2173 % Fonts for short table of contents.
2174 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2175 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2176 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2177 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2179 % Define these just so they can be easily changed for other fonts.
2180 \def\angleleft{$\langle$}
2181 \def\angleright{$\rangle$}
2183 % Set the fonts to use with the @small... environments.
2184 \let\smallexamplefonts = \smallfonts
2186 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2187 % can fit this many characters:
2188 % 8.5x11=86 smallbook=72 a4=90 a5=69
2189 % If we use \scriptfonts (8pt), then we can fit this many characters:
2190 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2191 % For me, subjectively, the few extra characters that fit aren't worth
2192 % the additional smallness of 8pt. So I'm making the default 9pt.
2194 % By the way, for comparison, here's what fits with @example (10pt):
2195 % 8.5x11=71 smallbook=60 a4=75 a5=58
2198 % Set up the default fonts, so we can use them for creating boxes.
2200 \definetextfontsizexi
2205 % Check if we are currently using a typewriter font. Since all the
2206 % Computer Modern typewriter fonts have zero interword stretch (and
2207 % shrink), and it is reasonable to expect all typewriter fonts to have
2208 % this property, we can check that font parameter.
2210 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2212 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2213 % define and register \INITMACRO to be called on markup style changes.
2214 % \INITMACRO can check \currentmarkupstyle for the innermost
2215 % style and the set of \ifmarkupSTYLE switches for all styles
2216 % currently in effect.
2220 %\newif\ifmarkupfile % @file == @samp.
2221 %\newif\ifmarkupoption % @option == @samp.
2224 %\newif\ifmarkupenv % @env == @code.
2225 %\newif\ifmarkupcommand % @command == @code.
2226 \newif\ifmarkuptex % @tex (and part of @math, for now).
2227 \newif\ifmarkupexample
2229 \newif\ifmarkupverbatim
2231 \let\currentmarkupstyle\empty
2233 \def\setupmarkupstyle#1{%
2234 \csname markup#1true\endcsname
2235 \def\currentmarkupstyle{#1}%
2239 \let\markupstylesetup\empty
2241 \def\defmarkupstylesetup#1{%
2242 \expandafter\def\expandafter\markupstylesetup
2243 \expandafter{\markupstylesetup #1}%
2247 % Markup style setup for left and right quotes.
2248 \defmarkupstylesetup\markupsetuplq{%
2249 \expandafter\let\expandafter \temp
2250 \csname markupsetuplq\currentmarkupstyle\endcsname
2251 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2254 \defmarkupstylesetup\markupsetuprq{%
2255 \expandafter\let\expandafter \temp
2256 \csname markupsetuprq\currentmarkupstyle\endcsname
2257 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2264 \gdef\markupsetuplqdefault{\let`\lq}
2265 \gdef\markupsetuprqdefault{\let'\rq}
2267 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2268 \gdef\markupsetcodequoteright{\let'\codequoteright}
2270 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2273 \let\markupsetuplqcode \markupsetcodequoteleft
2274 \let\markupsetuprqcode \markupsetcodequoteright
2276 \let\markupsetuplqexample \markupsetcodequoteleft
2277 \let\markupsetuprqexample \markupsetcodequoteright
2279 \let\markupsetuplqsamp \markupsetcodequoteleft
2280 \let\markupsetuprqsamp \markupsetcodequoteright
2282 \let\markupsetuplqverb \markupsetcodequoteleft
2283 \let\markupsetuprqverb \markupsetcodequoteright
2285 \let\markupsetuplqverbatim \markupsetcodequoteleft
2286 \let\markupsetuprqverbatim \markupsetcodequoteright
2288 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2290 % Allow an option to not use regular directed right quote/apostrophe
2291 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2292 % The undirected quote is ugly, so don't make it the default, but it
2293 % works for pasting with more pdf viewers (at least evince), the
2294 % lilypond developers report. xpdf does work with the regular 0x27.
2296 \def\codequoteright{%
2297 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2298 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2304 % and a similar option for the left quote char vs. a grave accent.
2305 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2306 % the code environments to do likewise.
2308 \def\codequoteleft{%
2309 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2310 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2311 % [Knuth] pp. 380,381,391
2312 % \relax disables Spanish ligatures ?` and !` of \tt font.
2318 % Commands to set the quote options.
2320 \parseargdef\codequoteundirected{%
2323 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2325 \else\ifx\temp\offword
2326 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2329 \errhelp = \EMsimple
2330 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2334 \parseargdef\codequotebacktick{%
2337 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2339 \else\ifx\temp\offword
2340 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2343 \errhelp = \EMsimple
2344 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2348 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2349 \def\noligaturesquoteleft{\relax\lq}
2351 % Count depth in font-changes, for error checks
2352 \newcount\fontdepth \fontdepth=0
2356 % #1 is the font command (\sl or \it), #2 is the text to slant.
2357 % If we are in a monospaced environment, however, 1) always use \ttsl,
2358 % and 2) do not add an italic correction.
2359 \def\dosmartslant#1#2{%
2361 {{\ttsl #2}\let\next=\relax}%
2362 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2365 \def\smartslanted{\dosmartslant\sl}
2366 \def\smartitalic{\dosmartslant\it}
2368 % Output an italic correction unless \next (presumed to be the following
2369 % character) is such as not to need one.
2370 \def\smartitaliccorrection{%
2379 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2380 % @var is set to this for defun arguments.
2381 \def\ttslanted#1{{\ttsl #1}}
2383 % @cite is like \smartslanted except unconditionally use \sl. We never want
2384 % ttsl for book titles, do we?
2385 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2389 \let\saveaftersmartic = \aftersmartic
2390 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2395 \let\slanted=\smartslanted
2396 \let\dfn=\smartslanted
2397 \let\emph=\smartitalic
2399 % Explicit font changes: @r, @sc, undocumented @ii.
2400 \def\r#1{{\rm #1}} % roman font
2401 \def\sc#1{{\smallcaps#1}} % smallcaps font
2402 \def\ii#1{{\it #1}} % italic font
2404 % @b, explicit bold. Also @strong.
2408 % @sansserif, explicit sans.
2409 \def\sansserif#1{{\sf #1}}
2411 % We can't just use \exhyphenpenalty, because that only has effect at
2412 % the end of a paragraph. Restore normal hyphenation at the end of the
2413 % group within which \nohyphenation is presumably called.
2415 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2416 \def\restorehyphenation{\hyphenchar\font = `- }
2418 % Set sfcode to normal for the chars that usually have another value.
2419 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2420 % sometimes \x has an active definition that messes things up.
2423 \def\plainfrenchspacing{%
2424 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2425 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2426 \def\endofsentencespacefactor{1000}% for @. and friends
2428 \def\plainnonfrenchspacing{%
2429 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2430 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2431 \def\endofsentencespacefactor{3000}% for @. and friends
2434 \def\endofsentencespacefactor{3000}% default
2436 % @t, explicit typewriter.
2438 {\tt \rawbackslash \plainfrenchspacing #1}%
2443 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2445 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2446 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2448 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2449 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2450 % \vbox{\hrule\kern-0.4pt
2451 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2452 % \kern-0.4pt\hrule}%
2453 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2455 % definition of @key with no lozenge. If the current font is already
2456 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2457 % if it isn't monospace, then use \tt.
2459 \def\key#1{{\setupmarkupstyle{key}%
2461 \ifmonospace\else\tt\fi
2464 % ctrl is no longer a Texinfo command.
2465 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2467 % @file, @option are the same as @samp.
2471 % @code is a modification of @t,
2472 % which makes spaces the same size as normal in the surrounding text.
2475 % Change normal interword space to be same as for the current font.
2476 \spaceskip = \fontdimen2\font
2478 % Switch to typewriter.
2481 % But `\ ' produces the large typewriter interword space.
2482 \def\ {{\spaceskip = 0pt{} }}%
2484 % Turn off hyphenation.
2491 \null % reset spacefactor to 1000
2494 % We *must* turn on hyphenation at `-' and `_' in @code.
2495 % Otherwise, it is too hard to avoid overfull hboxes
2496 % in the Emacs manual, the Library manual, etc.
2498 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2499 % both hyphenation at - and hyphenation within words.
2500 % We must therefore turn them both off (\tclose does that)
2501 % and arrange explicitly to hyphenate at a dash.
2504 \catcode`\-=\active \catcode`\_=\active
2505 \catcode`\'=\active \catcode`\`=\active
2506 \global\let'=\rq \global\let`=\lq % default definitions
2508 \global\def\code{\begingroup
2509 \setupmarkupstyle{code}%
2510 % The following should really be moved into \setupmarkupstyle handlers.
2511 \catcode\dashChar=\active \catcode\underChar=\active
2523 \def\codex #1{\tclose{#1}\endgroup}
2526 \def\codedash{-\discretionary{}{}{}}
2528 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2529 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2530 % will therefore expand the active definition of _, which is us
2531 % (inside @code that is), therefore an endless loop.
2533 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2534 \else\normalunderscore \fi
2535 \discretionary{}{}{}}%
2539 % An additional complication: the above will allow breaks after, e.g.,
2540 % each of the four underscores in __typeof__. This is undesirable in
2541 % some manuals, especially if they don't have long identifiers in
2542 % general. @allowcodebreaks provides a way to control this.
2544 \newif\ifallowcodebreaks \allowcodebreakstrue
2546 \def\keywordtrue{true}
2547 \def\keywordfalse{false}
2549 \parseargdef\allowcodebreaks{%
2551 \ifx\txiarg\keywordtrue
2552 \allowcodebreakstrue
2553 \else\ifx\txiarg\keywordfalse
2554 \allowcodebreaksfalse
2556 \errhelp = \EMsimple
2557 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2561 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2562 % second argument specifying the text to display and an optional third
2563 % arg as text to display instead of (rather than in addition to) the url
2564 % itself. First (mandatory) arg is the url.
2565 % (This \urefnobreak definition isn't used now, leaving it for a while
2567 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2568 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2571 \setbox0 = \hbox{\ignorespaces #3}%
2573 \unhbox0 % third arg given, show only that
2575 \setbox0 = \hbox{\ignorespaces #2}%
2578 \unhbox0 % PDF: 2nd arg given, show only it
2580 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2583 \code{#1}% only url given, so show it
2589 % This \urefbreak definition is the active one.
2590 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2591 \let\uref=\urefbreak
2592 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2593 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2596 \setbox0 = \hbox{\ignorespaces #3}%
2598 \unhbox0 % third arg given, show only that
2600 \setbox0 = \hbox{\ignorespaces #2}%
2603 \unhbox0 % PDF: 2nd arg given, show only it
2605 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2608 \urefcode{#1}% only url given, so show it
2614 % Allow line breaks around only a few characters (only).
2616 \catcode\ampChar=\active \catcode\dotChar=\active
2617 \catcode\hashChar=\active \catcode\questChar=\active
2618 \catcode\slashChar=\active
2623 \global\def\urefcode{\begingroup
2624 \setupmarkupstyle{code}%
2634 % By default, they are just regular characters.
2635 \global\def&{\normalamp}
2636 \global\def.{\normaldot}
2637 \global\def#{\normalhash}
2638 \global\def?{\normalquest}
2639 \global\def/{\normalslash}
2642 % we put a little stretch before and after the breakable chars, to help
2643 % line breaking of long url's. The unequal skips make look better in
2644 % cmtt at least, especially for dots.
2645 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2646 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2648 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2649 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2650 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2651 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2652 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2655 \global\def\urefcodeslashfinish{%
2656 \urefprestretch \slashChar
2657 % Allow line break only after the final / in a sequence of
2658 % slashes, to avoid line break between the slashes in http://.
2659 \ifx\next/\else \urefpoststretch \fi
2663 % One more complication: by default we'll break after the special
2664 % characters, but some people like to break before the special chars, so
2665 % allow that. Also allow no breaking at all, for manual control.
2667 \parseargdef\urefbreakstyle{%
2669 \ifx\txiarg\wordnone
2670 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2671 \else\ifx\txiarg\wordbefore
2672 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2673 \else\ifx\txiarg\wordafter
2674 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2676 \errhelp = \EMsimple
2677 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2680 \def\wordafter{after}
2681 \def\wordbefore{before}
2684 \urefbreakstyle after
2686 % @url synonym for @uref, since that's how everyone uses it.
2690 % rms does not like angle brackets --karl, 17may97.
2691 % So now @email is just like @uref, unless we are pdf.
2693 %\def\email#1{\angleleft{\tt #1}\angleright}
2695 \def\email#1{\doemail#1,,\finish}
2696 \def\doemail#1,#2,#3\finish{\begingroup
2699 \setbox0 = \hbox{\ignorespaces #2}%
2700 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2707 % @kbd is like @code, except that if the argument is just one @key command,
2708 % then @kbd has no effect.
2709 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2711 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2712 % `example' (@kbd uses ttsl only inside of @example and friends),
2713 % or `code' (@kbd uses normal tty font always).
2714 \parseargdef\kbdinputstyle{%
2716 \ifx\txiarg\worddistinct
2717 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2718 \else\ifx\txiarg\wordexample
2719 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2720 \else\ifx\txiarg\wordcode
2721 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2723 \errhelp = \EMsimple
2724 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2727 \def\worddistinct{distinct}
2728 \def\wordexample{example}
2731 % Default is `distinct'.
2732 \kbdinputstyle distinct
2735 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2736 \ifx\one\xkey\ifx\threex\three \key{#2}%
2737 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2738 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2740 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2741 \let\indicateurl=\code
2745 % @clicksequence{File @click{} Open ...}
2746 \def\clicksequence#1{\begingroup #1\endgroup}
2748 % @clickstyle @arrow (by default)
2749 \parseargdef\clickstyle{\def\click{#1}}
2752 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2753 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2755 \def\dmn#1{\thinspace #1}
2757 % @l was never documented to mean ``switch to the Lisp font'',
2758 % and it is not used as such in any manual I can find. We need it for
2759 % Polish suppressed-l. --karl, 22sep96.
2760 %\def\l#1{{\li #1}\null}
2762 % @acronym for "FBI", "NATO", and the like.
2763 % We print this one point size smaller, since it's intended for
2766 \def\acronym#1{\doacronym #1,,\finish}
2767 \def\doacronym#1,#2,#3\finish{%
2768 {\selectfonts\lsize #1}%
2770 \ifx\temp\empty \else
2771 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2773 \null % reset \spacefactor=1000
2776 % @abbr for "Comput. J." and the like.
2777 % No font change, but don't do end-of-sentence spacing.
2779 \def\abbr#1{\doabbr #1,,\finish}
2780 \def\doabbr#1,#2,#3\finish{%
2781 {\plainfrenchspacing #1}%
2783 \ifx\temp\empty \else
2784 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2786 \null % reset \spacefactor=1000
2789 % @asis just yields its argument. Used with @table, for example.
2793 % @math outputs its argument in math mode.
2795 % One complication: _ usually means subscripts, but it could also mean
2796 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2797 % _ active, and distinguish by seeing if the current family is \slfam,
2798 % which is what @var uses.
2800 \catcode`\_ = \active
2801 \gdef\mathunderscore{%
2803 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2806 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2807 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2808 % particular reason), but this is not advertised and we don't care.
2810 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2811 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2816 \let\\ = \mathbackslash
2818 % make the texinfo accent commands work in math mode
2830 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2832 % Some active characters (such as <) are spaced differently in math.
2833 % We have to reset their definitions in case the @math was an argument
2834 % to a command which sets the catcodes (such as @item or @section).
2837 \catcode`^ = \active
2838 \catcode`< = \active
2839 \catcode`> = \active
2840 \catcode`+ = \active
2841 \catcode`' = \active
2847 \let' = \ptexquoteright
2858 % Used to generate quoted braces. Unless we're in typewriter, use
2859 % \ecfont because the CM text fonts do not have braces, and we don't
2860 % want to switch into math.
2861 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2862 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2866 % Definitions to produce \{ and \} commands for indices,
2867 % and @{ and @} for the aux/toc files.
2868 \catcode`\{ = \other \catcode`\} = \other
2869 \catcode`\[ = 1 \catcode`\] = 2
2870 \catcode`\! = 0 \catcode`\\ = \other
2871 !gdef!lbracecmd[\{]%
2872 !gdef!rbracecmd[\}]%
2873 !gdef!lbraceatcmd[@{]%
2874 !gdef!rbraceatcmd[@}]%
2877 % @comma{} to avoid , parsing problems.
2880 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2881 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2883 \let\dotaccent = \ptexdot
2884 \def\ringaccent#1{{\accent23 #1}}
2885 \let\tieaccent = \ptext
2886 \let\ubaraccent = \ptexb
2887 \let\udotaccent = \d
2889 % Other special characters: @questiondown @exclamdown @ordf @ordm
2890 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2891 \def\questiondown{?`}
2893 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2894 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2896 % Dotless i and dotless j, used for accents.
2901 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2902 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2903 \else \errmessage{@dotless can be used only with i or j}%
2907 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2908 % period following counts as ending a sentence. (Idea found in latex.)
2910 \edef\TeX{\TeX \spacefactor=1000 }
2912 % @LaTeX{} logo. Not quite the same results as the definition in
2913 % latex.ltx, since we use a different font for the raised A; it's most
2914 % convenient for us to use an explicitly smaller font, rather than using
2915 % the \scriptstyle font (since we don't reset \scriptstyle and
2916 % \scriptscriptstyle).
2921 \vbox to \ht0{\hbox{%
2922 \ifx\textnominalsize\xwordpt
2923 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2924 % Revert to plain's \scriptsize, which is 7pt.
2925 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2927 % For 11pt, we can use our lllsize.
2928 \selectfonts\lllsize A%
2937 % Some math mode symbols.
2938 \def\bullet{$\ptexbullet$}
2939 \def\geq{\ifmmode \ge\else $\ge$\fi}
2940 \def\leq{\ifmmode \le\else $\le$\fi}
2941 \def\minus{\ifmmode -\else $-$\fi}
2943 % @dots{} outputs an ellipsis using the current font.
2944 % We do .5em per period so that it has the same spacing in the cm
2945 % typewriter fonts as three actual period characters; on the other hand,
2946 % in other typewriter fonts three periods are wider than 1.5em. So do
2947 % whichever is larger.
2951 \setbox0=\hbox{...}% get width of three periods
2958 \hskip 0pt plus.25fil
2959 .\hskip 0pt plus1fil
2960 .\hskip 0pt plus1fil
2961 .\hskip 0pt plus.5fil
2965 % @enddots{} is an end-of-sentence ellipsis.
2969 \spacefactor=\endofsentencespacefactor
2972 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2974 % Since these characters are used in examples, they should be an even number of
2975 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2978 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2979 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2980 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2981 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2982 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2984 % The @error{} command.
2985 % Adapted from the TeXbook's \boxit.
2989 {\tentt \global\dimen0 = 3em}% Width of the box.
2990 \dimen2 = .55pt % Thickness of rules
2991 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2992 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2994 \setbox\errorbox=\hbox to \dimen0{\hfil
2995 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2996 \advance\hsize by -2\dimen2 % Rules.
2998 \hrule height\dimen2
2999 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3000 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3001 \kern3pt\vrule width\dimen2}% Space to right.
3002 \hrule height\dimen2}
3005 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3007 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3009 \def\pounds{{\it\$}}
3011 % @euro{} comes from a separate font, depending on the current style.
3012 % We use the free feym* fonts from the eurosym package by Henrik
3013 % Theiling, which support regular, slanted, bold and bold slanted (and
3014 % "outlined" (blackboard board, sort of) versions, which we don't need).
3015 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3017 % Although only regular is the truly official Euro symbol, we ignore
3018 % that. The Euro is designed to be slightly taller than the regular
3024 % feybo - bold slanted
3026 % There is no good (free) typewriter version, to my knowledge.
3027 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3030 % Also doesn't work in math. Do we need to do math with euro symbols?
3034 \def\euro{{\eurofont e}}
3036 % We set the font at each command, rather than predefining it in
3037 % \textfonts and the other font-switching commands, so that
3038 % installations which never need the symbol don't have to have the
3041 % There is only one designed size (nominal 10pt), so we always scale
3042 % that to the current nominal size.
3044 % By the way, simply using "at 1em" works for cmr10 and the like, but
3045 % does not work for cmbx10 and other extended/shrunken fonts.
3047 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3049 \ifx\curfontstyle\bfstylename
3051 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3054 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3059 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3060 % sometimes we redefine the original macro, and the alias should reflect
3063 % Use LaTeX names for the Icelandic letters.
3064 \def\DH{{\ecfont \char"D0}} % Eth
3065 \def\dh{{\ecfont \char"F0}} % eth
3066 \def\TH{{\ecfont \char"DE}} % Thorn
3067 \def\th{{\ecfont \char"FE}} % thorn
3069 \def\guillemetleft{{\ecfont \char"13}}
3070 \def\guillemotleft{\guillemetleft}
3071 \def\guillemetright{{\ecfont \char"14}}
3072 \def\guillemotright{\guillemetright}
3073 \def\guilsinglleft{{\ecfont \char"0E}}
3074 \def\guilsinglright{{\ecfont \char"0F}}
3075 \def\quotedblbase{{\ecfont \char"12}}
3076 \def\quotesinglbase{{\ecfont \char"0D}}
3078 % This positioning is not perfect (see the ogonek LaTeX package), but
3079 % we have the precomposed glyphs for the most common cases. We put the
3080 % tests to use those glyphs in the single \ogonek macro so we have fewer
3081 % dummy definitions to worry about for index entries, etc.
3083 % ogonek is also used with other letters in Lithuanian (IOU), but using
3084 % the precomposed glyphs for those is not so easy since they aren't in
3088 \ifx\temp\macrocharA\Aogonek
3089 \else\ifx\temp\macrochara\aogonek
3090 \else\ifx\temp\macrocharE\Eogonek
3091 \else\ifx\temp\macrochare\eogonek
3093 \ecfont \setbox0=\hbox{#1}%
3094 \ifdim\ht0=1ex\accent"0C #1%
3095 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3100 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3101 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3102 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3103 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3105 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3107 % We can't distinguish serif/sans and italic/slanted, but this
3108 % is used for crude hacks anyway (like adding French and German
3109 % quotes to documents typeset with CM, where we lose kerning), so
3110 % hopefully nobody will notice/care.
3111 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3112 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3113 \ifx\curfontstyle\bfstylename
3115 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3118 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3123 % @registeredsymbol - R in a circle. The font for the R should really
3124 % be smaller yet, but lllsize is the best we can do for now.
3125 % Adapted from the plain.tex definition of \copyright.
3127 \def\registeredsymbol{%
3128 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3133 % @textdegree - the normal degrees sign.
3135 \def\textdegree{$^\circ$}
3137 % Laurent Siebenmann reports \Orb undefined with:
3138 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3139 % so we'll define it if necessary.
3141 \ifx\Orb\thisisundefined
3142 \def\Orb{\mathhexbox20D}
3146 \chardef\quotedblleft="5C
3147 \chardef\quotedblright=`\"
3148 \chardef\quoteleft=`\`
3149 \chardef\quoteright=`\'
3152 \message{page headings,}
3154 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3155 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3157 % First the title page. Must do @settitle before @titlepage.
3159 \newif\iffinishedtitlepage
3161 % Do an implicit @contents or @shortcontents after @end titlepage if the
3162 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3164 \newif\ifsetcontentsaftertitlepage
3165 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3166 \newif\ifsetshortcontentsaftertitlepage
3167 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3169 \parseargdef\shorttitlepage{%
3170 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3171 \endgroup\page\hbox{}\page}
3174 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3176 \parindent=0pt \textfonts
3177 % Leave some space at the very top of the page.
3178 \vglue\titlepagetopglue
3179 % No rule at page bottom unless we print one at the top with @title.
3180 \finishedtitlepagetrue
3182 % Most title ``pages'' are actually two pages long, with space
3183 % at the top of the second. We don't want the ragged left on the second.
3184 \let\oldpage = \page
3186 \iffinishedtitlepage\else
3189 \let\page = \oldpage
3196 \iffinishedtitlepage\else
3199 % It is important to do the page break before ending the group,
3200 % because the headline and footline are only empty inside the group.
3201 % If we use the new definition of \page, we always get a blank page
3202 % after the title page, which we certainly don't want.
3206 % Need this before the \...aftertitlepage checks so that if they are
3207 % in effect the toc pages will come out with page numbers.
3210 % If they want short, they certainly want long too.
3211 \ifsetshortcontentsaftertitlepage
3214 \global\let\shortcontents = \relax
3215 \global\let\contents = \relax
3218 \ifsetcontentsaftertitlepage
3220 \global\let\contents = \relax
3221 \global\let\shortcontents = \relax
3225 \def\finishtitlepage{%
3226 \vskip4pt \hrule height 2pt width \hsize
3227 \vskip\titlepagebottomglue
3228 \finishedtitlepagetrue
3231 % Macros to be used within @titlepage:
3233 \let\subtitlerm=\tenrm
3234 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3236 \parseargdef\title{%
3238 \leftline{\titlefonts\rmisbold #1}
3239 % print a rule at the page bottom also.
3240 \finishedtitlepagefalse
3241 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3244 \parseargdef\subtitle{%
3246 {\subtitlefont \rightline{#1}}%
3249 % @author should come last, but may come many times.
3250 % It can also be used inside @quotation.
3252 \parseargdef\author{%
3253 \def\temp{\quotation}%
3255 \def\quotationauthor{#1}% printed in \Equotation.
3258 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3259 {\secfonts\rmisbold \leftline{#1}}%
3264 % Set up page headings and footings.
3266 \let\thispage=\folio
3268 \newtoks\evenheadline % headline on even pages
3269 \newtoks\oddheadline % headline on odd pages
3270 \newtoks\evenfootline % footline on even pages
3271 \newtoks\oddfootline % footline on odd pages
3273 % Now make TeX use those variables
3274 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3275 \else \the\evenheadline \fi}}
3276 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3277 \else \the\evenfootline \fi}\HEADINGShook}
3278 \let\HEADINGShook=\relax
3280 % Commands to set those variables.
3281 % For example, this is what @headings on does
3282 % @evenheading @thistitle|@thispage|@thischapter
3283 % @oddheading @thischapter|@thispage|@thistitle
3284 % @evenfooting @thisfile||
3285 % @oddfooting ||@thisfile
3288 \def\evenheading{\parsearg\evenheadingxxx}
3289 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3290 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3291 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3293 \def\oddheading{\parsearg\oddheadingxxx}
3294 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3295 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3296 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3298 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3300 \def\evenfooting{\parsearg\evenfootingxxx}
3301 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3302 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3303 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3305 \def\oddfooting{\parsearg\oddfootingxxx}
3306 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3307 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3308 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3310 % Leave some space for the footline. Hopefully ok to assume
3311 % @evenfooting will not be used by itself.
3312 \global\advance\pageheight by -12pt
3313 \global\advance\vsize by -12pt
3316 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3318 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3319 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3321 % The same set of arguments for:
3326 % @everyheadingmarks
3327 % @everyfootingmarks
3329 \def\evenheadingmarks{\headingmarks{even}{heading}}
3330 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3331 \def\evenfootingmarks{\headingmarks{even}{footing}}
3332 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3333 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3334 \headingmarks{odd}{heading}{#1} }
3335 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3336 \headingmarks{odd}{footing}{#1} }
3337 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3338 \def\headingmarks#1#2#3 {%
3339 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3340 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3343 \everyheadingmarks bottom
3344 \everyfootingmarks bottom
3346 % @headings double turns headings on for double-sided printing.
3347 % @headings single turns headings on for single-sided printing.
3348 % @headings off turns them off.
3349 % @headings on same as @headings double, retained for compatibility.
3350 % @headings after turns on double-sided headings after this page.
3351 % @headings doubleafter turns on double-sided headings after this page.
3352 % @headings singleafter turns on single-sided headings after this page.
3353 % By default, they are off at the start of a document,
3354 % and turned `on' after @end titlepage.
3356 \def\headings #1 {\csname HEADINGS#1\endcsname}
3358 \def\headingsoff{% non-global headings elimination
3359 \evenheadline={\hfil}\evenfootline={\hfil}%
3360 \oddheadline={\hfil}\oddfootline={\hfil}%
3363 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3364 \HEADINGSoff % it's the default
3366 % When we turn headings on, set the page number to 1.
3367 % For double-sided printing, put current file name in lower left corner,
3368 % chapter name on inside top of right hand pages, document
3369 % title on inside top of left hand pages, and page numbers on outside top
3370 % edge of all pages.
3371 \def\HEADINGSdouble{%
3373 \global\evenfootline={\hfil}
3374 \global\oddfootline={\hfil}
3375 \global\evenheadline={\line{\folio\hfil\thistitle}}
3376 \global\oddheadline={\line{\thischapter\hfil\folio}}
3377 \global\let\contentsalignmacro = \chapoddpage
3379 \let\contentsalignmacro = \chappager
3381 % For single-sided printing, chapter title goes across top left of page,
3382 % page number on top right.
3383 \def\HEADINGSsingle{%
3385 \global\evenfootline={\hfil}
3386 \global\oddfootline={\hfil}
3387 \global\evenheadline={\line{\thischapter\hfil\folio}}
3388 \global\oddheadline={\line{\thischapter\hfil\folio}}
3389 \global\let\contentsalignmacro = \chappager
3391 \def\HEADINGSon{\HEADINGSdouble}
3393 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3394 \let\HEADINGSdoubleafter=\HEADINGSafter
3395 \def\HEADINGSdoublex{%
3396 \global\evenfootline={\hfil}
3397 \global\oddfootline={\hfil}
3398 \global\evenheadline={\line{\folio\hfil\thistitle}}
3399 \global\oddheadline={\line{\thischapter\hfil\folio}}
3400 \global\let\contentsalignmacro = \chapoddpage
3403 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3404 \def\HEADINGSsinglex{%
3405 \global\evenfootline={\hfil}
3406 \global\oddfootline={\hfil}
3407 \global\evenheadline={\line{\thischapter\hfil\folio}}
3408 \global\oddheadline={\line{\thischapter\hfil\folio}}
3409 \global\let\contentsalignmacro = \chappager
3412 % Subroutines used in generating headings
3413 % This produces Day Month Year style of output.
3414 % Only define if not already defined, in case a txi-??.tex file has set
3415 % up a different format (e.g., txi-cs.tex does this).
3416 \ifx\today\thisisundefined
3420 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3421 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3422 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3427 % @settitle line... specifies the title of the document, for headings.
3428 % It generates no output of its own.
3429 \def\thistitle{\putwordNoTitle}
3430 \def\settitle{\parsearg{\gdef\thistitle}}
3434 % Tables -- @table, @ftable, @vtable, @item(x).
3436 % default indentation of table text
3437 \newdimen\tableindent \tableindent=.8in
3438 % default indentation of @itemize and @enumerate text
3439 \newdimen\itemindent \itemindent=.3in
3440 % margin between end of table item and start of table text.
3441 \newdimen\itemmargin \itemmargin=.1in
3443 % used internally for \itemindent minus \itemmargin
3446 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3448 % They also define \itemindex
3449 % to index the item name in whatever manner is desired (perhaps none).
3451 \newif\ifitemxneedsnegativevskip
3453 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3455 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3456 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3458 \def\itemzzz #1{\begingroup %
3459 \advance\hsize by -\rightskip
3460 \advance\hsize by -\tableindent
3461 \setbox0=\hbox{\itemindicate{#1}}%
3463 \nobreak % This prevents a break before @itemx.
3465 % If the item text does not fit in the space we have, put it on a line
3466 % by itself, and do not allow a page break either before or after that
3467 % line. We do not start a paragraph here because then if the next
3468 % command is, e.g., @kindex, the whatsit would get put into the
3469 % horizontal list on a line by itself, resulting in extra blank space.
3470 \ifdim \wd0>\itemmax
3472 % Make this a paragraph so we get the \parskip glue and wrapping,
3473 % but leave it ragged-right.
3475 \advance\leftskip by-\tableindent
3476 \advance\hsize by\tableindent
3477 \advance\rightskip by0pt plus1fil\relax
3478 \leavevmode\unhbox0\par
3481 % We're going to be starting a paragraph, but we don't want the
3482 % \parskip glue -- logically it's part of the @item we just started.
3483 \nobreak \vskip-\parskip
3485 % Stop a page break at the \parskip glue coming up. However, if
3486 % what follows is an environment such as @example, there will be no
3487 % \parskip glue; then the negative vskip we just inserted would
3488 % cause the example and the item to crash together. So we use this
3489 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3490 % \parskip glue after all. Section titles are handled this way also.
3494 \itemxneedsnegativevskipfalse
3496 % The item text fits into the space. Start a paragraph, so that the
3497 % following text (if any) will end up on the same line.
3499 % Do this with kerns and \unhbox so that if there is a footnote in
3500 % the item text, it can migrate to the main vertical list and
3501 % eventually be printed.
3502 \nobreak\kern-\tableindent
3503 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3505 \nobreak\kern\dimen0
3507 \itemxneedsnegativevskiptrue
3511 \def\item{\errmessage{@item while not in a list environment}}
3512 \def\itemx{\errmessage{@itemx while not in a list environment}}
3514 % @table, @ftable, @vtable.
3516 \let\itemindex\gobble
3520 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3521 \tablecheck{ftable}%
3524 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3525 \tablecheck{vtable}%
3528 \ifnum \the\catcode`\^^M=\active
3530 \errmessage{This command won't work in this context; perhaps the problem is
3531 that we are \inenvironment\thisenv}%
3532 \def\next{\doignore{#1}}%
3539 \def\itemindicate{#1}%
3544 \makevalueexpandable
3545 \edef\temp{\noexpand\tablez #1\space\space\space}%
3549 \def\tablez #1 #2 #3 #4\endtablez{%
3551 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3552 \ifnum 0#2>0 \tableindent=#2\mil \fi
3553 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3554 \itemmax=\tableindent
3555 \advance \itemmax by -\itemmargin
3556 \advance \leftskip by \tableindent
3557 \exdentamount=\tableindent
3559 \parskip = \smallskipamount
3560 \ifdim \parskip=0pt \parskip=2pt \fi
3561 \let\item = \internalBitem
3562 \let\itemx = \internalBitemx
3564 \def\Etable{\endgraf\afterenvbreak}
3567 \let\Eitemize\Etable
3568 \let\Eenumerate\Etable
3570 % This is the counter used by @enumerate, which is really @itemize
3574 \envdef\itemize{\parsearg\doitemize}
3578 \itemmax=\itemindent
3579 \advance\itemmax by -\itemmargin
3580 \advance\leftskip by \itemindent
3581 \exdentamount=\itemindent
3583 \parskip=\smallskipamount
3584 \ifdim\parskip=0pt \parskip=2pt \fi
3586 % Try typesetting the item mark that if the document erroneously says
3587 % something like @itemize @samp (intending @table), there's an error
3588 % right away at the @itemize. It's not the best error message in the
3589 % world, but it's better than leaving it to the @item. This means if
3590 % the user wants an empty mark, they have to say @w{} not just @w.
3591 \def\itemcontents{#1}%
3592 \setbox0 = \hbox{\itemcontents}%
3594 % @itemize with no arg is equivalent to @itemize @bullet.
3595 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3597 \let\item=\itemizeitem
3600 % Definition of @item while inside @itemize and @enumerate.
3603 \advance\itemno by 1 % for enumerations
3604 {\let\par=\endgraf \smallbreak}% reasonable place to break
3606 % If the document has an @itemize directly after a section title, a
3607 % \nobreak will be last on the list, and \sectionheading will have
3608 % done a \vskip-\parskip. In that case, we don't want to zero
3609 % parskip, or the item text will crash with the heading. On the
3610 % other hand, when there is normal text preceding the item (as there
3611 % usually is), we do want to zero parskip, or there would be too much
3612 % space. In that case, we won't have a \nobreak before. At least
3613 % that's the theory.
3614 \ifnum\lastpenalty<10000 \parskip=0in \fi
3616 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3618 \vadjust{\penalty 1200}}% not good to break after first line of item.
3622 % \splitoff TOKENS\endmark defines \first to be the first token in
3623 % TOKENS, and \rest to be the remainder.
3625 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3627 % Allow an optional argument of an uppercase letter, lowercase letter,
3628 % or number, to specify the first label in the enumerated list. No
3629 % argument is the same as `1'.
3631 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3632 \def\enumeratey #1 #2\endenumeratey{%
3633 % If we were given no argument, pretend we were given `1'.
3635 \ifx\thearg\empty \def\thearg{1}\fi
3637 % Detect if the argument is a single token. If so, it might be a
3638 % letter. Otherwise, the only valid thing it can be is a number.
3639 % (We will always have one token, because of the test we just made.
3640 % This is a good thing, since \splitoff doesn't work given nothing at
3641 % all -- the first parameter is undelimited.)
3642 \expandafter\splitoff\thearg\endmark
3644 % Only one token in the argument. It could still be anything.
3645 % A ``lowercase letter'' is one whose \lccode is nonzero.
3646 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3647 % not equal to itself.
3648 % Otherwise, we assume it's a number.
3650 % We need the \relax at the end of the \ifnum lines to stop TeX from
3651 % continuing to look for a <number>.
3653 \ifnum\lccode\expandafter`\thearg=0\relax
3654 \numericenumerate % a number (we hope)
3657 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3658 \lowercaseenumerate % lowercase letter
3660 \uppercaseenumerate % uppercase letter
3664 % Multiple tokens in the argument. We hope it's a number.
3669 % An @enumerate whose labels are integers. The starting integer is
3672 \def\numericenumerate{%
3674 \startenumeration{\the\itemno}%
3677 % The starting (lowercase) letter is in \thearg.
3678 \def\lowercaseenumerate{%
3679 \itemno = \expandafter`\thearg
3681 % Be sure we're not beyond the end of the alphabet.
3683 \errmessage{No more lowercase letters in @enumerate; get a bigger
3690 % The starting (uppercase) letter is in \thearg.
3691 \def\uppercaseenumerate{%
3692 \itemno = \expandafter`\thearg
3694 % Be sure we're not beyond the end of the alphabet.
3696 \errmessage{No more uppercase letters in @enumerate; get a bigger
3703 % Call \doitemize, adding a period to the first argument and supplying the
3704 % common last two arguments. Also subtract one from the initial value in
3705 % \itemno, since @item increments \itemno.
3707 \def\startenumeration#1{%
3708 \advance\itemno by -1
3709 \doitemize{#1.}\flushcr
3712 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3715 \def\alphaenumerate{\enumerate{a}}
3716 \def\capsenumerate{\enumerate{A}}
3717 \def\Ealphaenumerate{\Eenumerate}
3718 \def\Ecapsenumerate{\Eenumerate}
3721 % @multitable macros
3722 % Amy Hendrickson, 8/18/94, 3/6/96
3724 % @multitable ... @end multitable will make as many columns as desired.
3725 % Contents of each column will wrap at width given in preamble. Width
3726 % can be specified either with sample text given in a template line,
3727 % or in percent of \hsize, the current width of text on page.
3729 % Table can continue over pages but will only break between lines.
3733 % Either define widths of columns in terms of percent of \hsize:
3734 % @multitable @columnfractions .25 .3 .45
3737 % Numbers following @columnfractions are the percent of the total
3738 % current hsize to be used for each column. You may use as many
3739 % columns as desired.
3742 % Or use a template:
3743 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3745 % using the widest term desired in each column.
3747 % Each new table line starts with @item, each subsequent new column
3748 % starts with @tab. Empty columns may be produced by supplying @tab's
3749 % with nothing between them for as many times as empty columns are needed,
3750 % ie, @tab@tab@tab will produce two empty columns.
3752 % @item, @tab do not need to be on their own lines, but it will not hurt
3755 % Sample multitable:
3757 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3758 % @item first col stuff @tab second col stuff @tab third col
3765 % @item first col stuff @tab second col stuff
3766 % @tab Many paragraphs of text may be used in any column.
3768 % They will wrap at the width determined by the template.
3769 % @item@tab@tab This will be in third column.
3772 % Default dimensions may be reset by user.
3773 % @multitableparskip is vertical space between paragraphs in table.
3774 % @multitableparindent is paragraph indent in table.
3775 % @multitablecolmargin is horizontal space to be left between columns.
3776 % @multitablelinespace is space to leave between table items, baseline
3778 % 0pt means it depends on current normal line spacing.
3780 \newskip\multitableparskip
3781 \newskip\multitableparindent
3782 \newdimen\multitablecolspace
3783 \newskip\multitablelinespace
3784 \multitableparskip=0pt
3785 \multitableparindent=6pt
3786 \multitablecolspace=12pt
3787 \multitablelinespace=0pt
3789 % Macros used to set up halign preamble:
3791 \let\endsetuptable\relax
3792 \def\xendsetuptable{\endsetuptable}
3793 \let\columnfractions\relax
3794 \def\xcolumnfractions{\columnfractions}
3797 % #1 is the @columnfraction, usually a decimal number like .5, but might
3798 % be just 1. We just use it, whatever it is.
3800 \def\pickupwholefraction#1 {%
3801 \global\advance\colcount by 1
3802 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3809 \ifx\firstarg\xendsetuptable
3812 \ifx\firstarg\xcolumnfractions
3813 \global\setpercenttrue
3816 \let\go\pickupwholefraction
3818 \global\advance\colcount by 1
3819 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3820 % separator; typically that is always in the input, anyway.
3821 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3824 \ifx\go\pickupwholefraction
3825 % Put the argument back for the \pickupwholefraction call, so
3826 % we'll always have a period there to be parsed.
3827 \def\go{\pickupwholefraction#1}%
3829 \let\go = \setuptable
3835 % multitable-only commands.
3837 % @headitem starts a heading row, which we typeset in bold.
3838 % Assignments have to be global since we are inside the implicit group
3839 % of an alignment entry. \everycr resets \everytab so we don't have to
3840 % undo it ourselves.
3841 \def\headitemfont{\b}% for people to use in the template row; not changeable
3843 \checkenv\multitable
3845 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3846 \the\everytab % for the first item
3849 % A \tab used to include \hskip1sp. But then the space in a template
3850 % line is not enough. That is bad. So let's go back to just `&' until
3851 % we again encounter the problem the 1sp was intended to solve.
3852 % --karl, nathan@acm.org, 20apr99.
3853 \def\tab{\checkenv\multitable &\the\everytab}%
3855 % @multitable ... @end multitable definitions:
3857 \newtoks\everytab % insert after every tab.
3859 \envdef\multitable{%
3863 % @item within a multitable starts a normal row.
3864 % We use \def instead of \let so that if one of the multitable entries
3865 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3866 % \endtemplate) expanding \doitemize.
3871 \setmultitablespacing
3872 \parskip=\multitableparskip
3873 \parindent=\multitableparindent
3879 \global\everytab={}%
3880 \global\colcount=0 % Reset the column counter.
3881 % Check for saved footnotes, etc.
3883 % Keeps underfull box messages off when table breaks over pages.
3885 % Maybe so, but it also creates really weird page breaks when the
3886 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3887 % problem manifests itself, so it can be fixed for real --karl.
3891 \parsearg\domultitable
3893 \def\domultitable#1{%
3894 % To parse everything between @multitable and @item:
3895 \setuptable#1 \endsetuptable
3897 % This preamble sets up a generic column definition, which will
3898 % be used as many times as user calls for columns.
3899 % \vtop will set a single line and will also let text wrap and
3900 % continue for many paragraphs if desired.
3902 \global\advance\colcount by 1
3905 % Use the current \colcount to find the correct column width:
3906 \hsize=\expandafter\csname col\the\colcount\endcsname
3908 % In order to keep entries from bumping into each other
3909 % we will add a \leftskip of \multitablecolspace to all columns after
3912 % If a template has been used, we will add \multitablecolspace
3913 % to the width of each template entry.
3915 % If the user has set preamble in terms of percent of \hsize we will
3916 % use that dimension as the width of the column, and the \leftskip
3917 % will keep entries from bumping into each other. Table will start at
3918 % left margin and final column will justify at right margin.
3920 % Make sure we don't inherit \rightskip from the outer environment.
3923 % The first column will be indented with the surrounding text.
3924 \advance\hsize by\leftskip
3927 % If user has not set preamble in terms of percent of \hsize
3928 % we will advance \hsize by \multitablecolspace.
3929 \advance\hsize by \multitablecolspace
3931 % In either case we will make \leftskip=\multitablecolspace:
3932 \leftskip=\multitablecolspace
3934 % Ignoring space at the beginning and end avoids an occasional spurious
3935 % blank line, when TeX decides to break the line at the space before the
3936 % box from the multistrut, so the strut ends up on a line by itself.
3938 % @multitable @columnfractions .11 .89
3940 % @tab Legal holiday which is valid in major parts of the whole country.
3941 % Is automatically provided with highlighting sequences respectively
3942 % marking characters.
3943 \noindent\ignorespaces##\unskip\multistrut
3948 \egroup % end the \halign
3949 \global\setpercentfalse
3952 \def\setmultitablespacing{%
3953 \def\multistrut{\strut}% just use the standard line spacing
3955 % Compute \multitablelinespace (if not defined by user) for use in
3956 % \multitableparskip calculation. We used define \multistrut based on
3957 % this, but (ironically) that caused the spacing to be off.
3958 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3959 \ifdim\multitablelinespace=0pt
3960 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3961 \global\advance\multitablelinespace by-\ht0
3963 % Test to see if parskip is larger than space between lines of
3964 % table. If not, do nothing.
3965 % If so, set to same dimension as multitablelinespace.
3966 \ifdim\multitableparskip>\multitablelinespace
3967 \global\multitableparskip=\multitablelinespace
3968 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3969 % than skip between lines in the table.
3971 \ifdim\multitableparskip=0pt
3972 \global\multitableparskip=\multitablelinespace
3973 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3974 % than skip between lines in the table.
3978 \message{conditionals,}
3980 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3981 % @ifnotxml always succeed. They currently do nothing; we don't
3982 % attempt to check whether the conditionals are properly nested. But we
3983 % have to remember that they are conditionals, so that @end doesn't
3984 % attempt to close an environment group.
3987 \expandafter\let\csname #1\endcsname = \relax
3988 \expandafter\let\csname iscond.#1\endcsname = 1
3991 \makecond{ifnotdocbook}
3992 \makecond{ifnothtml}
3993 \makecond{ifnotinfo}
3994 \makecond{ifnotplaintext}
3997 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3999 \def\direntry{\doignore{direntry}}
4000 \def\documentdescription{\doignore{documentdescription}}
4001 \def\docbook{\doignore{docbook}}
4002 \def\html{\doignore{html}}
4003 \def\ifdocbook{\doignore{ifdocbook}}
4004 \def\ifhtml{\doignore{ifhtml}}
4005 \def\ifinfo{\doignore{ifinfo}}
4006 \def\ifnottex{\doignore{ifnottex}}
4007 \def\ifplaintext{\doignore{ifplaintext}}
4008 \def\ifxml{\doignore{ifxml}}
4009 \def\ignore{\doignore{ignore}}
4010 \def\menu{\doignore{menu}}
4011 \def\xml{\doignore{xml}}
4013 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4015 % A count to remember the depth of nesting.
4016 \newcount\doignorecount
4018 \def\doignore#1{\begingroup
4019 % Scan in ``verbatim'' mode:
4021 \catcode`\@ = \other
4022 \catcode`\{ = \other
4023 \catcode`\} = \other
4025 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4028 % Count number of #1's that we've seen.
4031 % Swallow text until we reach the matching `@end #1'.
4035 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4038 \gdef\dodoignore#1{%
4039 % #1 contains the command name as a string, e.g., `ifinfo'.
4041 % Define a command to find the next `@end #1'.
4042 \long\def\doignoretext##1^^M@end #1{%
4043 \doignoretextyyy##1^^M@#1\_STOP_}%
4045 % And this command to find another #1 command, at the beginning of a
4046 % line. (Otherwise, we would consider a line `@c @ifset', for
4047 % example, to count as an @ifset for nesting.)
4048 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4050 % And now expand that command.
4055 \def\doignoreyyy#1{%
4057 \ifx\temp\empty % Nothing found.
4058 \let\next\doignoretextzzz
4059 \else % Found a nested condition, ...
4060 \advance\doignorecount by 1
4061 \let\next\doignoretextyyy % ..., look for another.
4062 % If we're here, #1 ends with ^^M\ifinfo (for example).
4064 \next #1% the token \_STOP_ is present just after this macro.
4067 % We have to swallow the remaining "\_STOP_".
4069 \def\doignoretextzzz#1{%
4070 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4071 \let\next\enddoignore
4072 \else % Still inside a nested condition.
4073 \advance\doignorecount by -1
4074 \let\next\doignoretext % Look for the next @end.
4079 % Finish off ignored text.
4081 % Ignore anything after the last `@end #1'; this matters in verbatim
4082 % environments, where otherwise the newline after an ignored conditional
4083 % would result in a blank line in the output.
4084 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4088 % @set VAR sets the variable VAR to an empty value.
4089 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4091 % Since we want to separate VAR from REST-OF-LINE (which might be
4092 % empty), we can't just use \parsearg; we have to insert a space of our
4093 % own to delimit the rest of the line, and then take it out again if we
4095 % We rely on the fact that \parsearg sets \catcode`\ =10.
4097 \parseargdef\set{\setyyy#1 \endsetyyy}
4098 \def\setyyy#1 #2\endsetyyy{%
4100 \makevalueexpandable
4102 \edef\next{\gdef\makecsname{SET#1}}%
4110 % Remove the trailing space \setxxx inserted.
4111 \def\setzzz#1 \endsetzzz{\next{#1}}
4113 % @clear VAR clears (i.e., unsets) the variable VAR.
4115 \parseargdef\clear{%
4117 \makevalueexpandable
4118 \global\expandafter\let\csname SET#1\endcsname=\relax
4122 % @value{foo} gets the text saved in variable foo.
4123 \def\value{\begingroup\makevalueexpandable\valuexxx}
4124 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4126 \catcode`\- = \active \catcode`\_ = \active
4128 \gdef\makevalueexpandable{%
4129 \let\value = \expandablevalue
4130 % We don't want these characters active, ...
4131 \catcode`\-=\other \catcode`\_=\other
4132 % ..., but we might end up with active ones in the argument if
4133 % we're called from @code, as @code{@value{foo-bar_}}, though.
4134 % So \let them to their normal equivalents.
4135 \let-\realdash \let_\normalunderscore
4139 % We have this subroutine so that we can handle at least some @value's
4140 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4141 % The command has to be fully expandable (if the variable is set), since
4142 % the result winds up in the index file. This means that if the
4143 % variable's value contains other Texinfo commands, it's almost certain
4144 % it will fail (although perhaps we could fix that with sufficient work
4145 % to do a one-level expansion on the result, instead of complete).
4147 \def\expandablevalue#1{%
4148 \expandafter\ifx\csname SET#1\endcsname\relax
4149 {[No value for ``#1'']}%
4150 \message{Variable `#1', used in @value, is not set.}%
4152 \csname SET#1\endcsname
4156 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4159 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4162 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4165 \makevalueexpandable
4167 \expandafter\ifx\csname SET#2\endcsname\relax
4168 #1% If not set, redefine \next.
4173 \def\ifsetfail{\doignore{ifset}}
4175 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4176 % defined with @set, or has been undefined with @clear.
4178 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4179 % above code: if the variable is not set, do nothing, if it is set,
4180 % then redefine \next to \ifclearfail.
4183 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4184 \def\ifclearfail{\doignore{ifclear}}
4186 % @dircategory CATEGORY -- specify a category of the dir file
4187 % which this file should belong to. Ignore this in TeX.
4188 \let\dircategory=\comment
4190 % @defininfoenclose.
4191 \let\definfoenclose=\comment
4195 % Index generation facilities
4197 % Define \newwrite to be identical to plain tex's \newwrite
4198 % except not \outer, so it can be used within macros and \if's.
4199 \edef\newwrite{\makecsname{ptexnewwrite}}
4201 % \newindex {foo} defines an index named foo.
4202 % It automatically defines \fooindex such that
4203 % \fooindex ...rest of line... puts an entry in the index foo.
4204 % It also defines \fooindfile to be the number of the output channel for
4205 % the file that accumulates this index. The file's extension is foo.
4206 % The name of an index should be no more than 2 characters long
4207 % for the sake of vms.
4211 \expandafter\newwrite \csname#1indfile\endcsname
4212 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4214 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4215 \noexpand\doindex{#1}}
4218 % @defindex foo == \newindex{foo}
4220 \def\defindex{\parsearg\newindex}
4222 % Define @defcodeindex, like @defindex except put all entries in @code.
4224 \def\defcodeindex{\parsearg\newcodeindex}
4226 \def\newcodeindex#1{%
4228 \expandafter\newwrite \csname#1indfile\endcsname
4229 \openout \csname#1indfile\endcsname \jobname.#1
4231 \expandafter\xdef\csname#1index\endcsname{%
4232 \noexpand\docodeindex{#1}}%
4236 % @synindex foo bar makes index foo feed into index bar.
4237 % Do this instead of @defindex foo if you don't want it as a separate index.
4239 % @syncodeindex foo bar similar, but put all entries made for index foo
4242 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4243 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4245 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4246 % #3 the target index (bar).
4247 \def\dosynindex#1#2#3{%
4248 % Only do \closeout if we haven't already done it, else we'll end up
4249 % closing the target index.
4250 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4251 % The \closeout helps reduce unnecessary open files; the limit on the
4252 % Acorn RISC OS is a mere 16 files.
4253 \expandafter\closeout\csname#2indfile\endcsname
4254 \expandafter\let\csname donesynindex#2\endcsname = 1
4256 % redefine \fooindfile:
4257 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4258 \expandafter\let\csname#2indfile\endcsname=\temp
4259 % redefine \fooindex:
4260 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4263 % Define \doindex, the driver for all \fooindex macros.
4264 % Argument #1 is generated by the calling \fooindex macro,
4265 % and it is "foo", the name of the index.
4267 % \doindex just uses \parsearg; it calls \doind for the actual work.
4268 % This is because \doind is more useful to call from other macros.
4270 % There is also \dosubind {index}{topic}{subtopic}
4271 % which makes an entry in a two-level index such as the operation index.
4273 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4274 \def\singleindexer #1{\doind{\indexname}{#1}}
4276 % like the previous two, but they put @code around the argument.
4277 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4278 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4280 % Take care of Texinfo commands that can appear in an index entry.
4281 % Since there are some commands we want to expand, and others we don't,
4282 % we have to laboriously prevent expansion for those that we don't.
4285 \escapechar = `\\ % use backslash in output files.
4286 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4287 \def\ {\realbackslash\space }%
4289 % Need these unexpandable (because we define \tt as a dummy)
4290 % definitions when @{ or @} appear in index entry text. Also, more
4291 % complicated, when \tex is in effect and \{ is a \delimiter again.
4292 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4293 % braces and backslashes are used only as delimiters. Perhaps we
4294 % should define @lbrace and @rbrace commands a la @comma.
4295 \def\{{{\tt\char123}}%
4296 \def\}{{\tt\char125}}%
4298 % I don't entirely understand this, but when an index entry is
4299 % generated from a macro call, the \endinput which \scanmacro inserts
4300 % causes processing to be prematurely terminated. This is,
4301 % apparently, because \indexsorttmp is fully expanded, and \endinput
4302 % is an expandable command. The redefinition below makes \endinput
4303 % disappear altogether for that purpose -- although logging shows that
4304 % processing continues to some further point. On the other hand, it
4305 % seems \endinput does not hurt in the printed index arg, since that
4306 % is still getting written without apparent harm.
4308 % Sample source (mac-idx3.tex, reported by Graham Percival to
4309 % help-texinfo, 22may06):
4310 % @macro funindex {WORD}
4314 % @funindex commtest
4316 % The above is not enough to reproduce the bug, but it gives the flavor.
4318 % Sample whatsit resulting:
4319 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4322 \let\endinput = \empty
4324 % Do the redefinitions.
4328 % For the aux and toc files, @ is the escape character. So we want to
4329 % redefine everything using @ as the escape character (instead of
4330 % \realbackslash, still used for index files). When everything uses @,
4331 % this will be simpler.
4336 \let\{ = \lbraceatcmd
4337 \let\} = \rbraceatcmd
4339 % Do the redefinitions.
4344 % Called from \indexdummies and \atdummies.
4346 \def\commondummies{%
4348 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4349 % preventing its expansion. This is used only for control words,
4350 % not control letters, because the \space would be incorrect for
4351 % control characters, but is needed to separate the control word
4352 % from whatever follows.
4354 % For control letters, we have \definedummyletter, which omits the
4357 % These can be used both for control words that take an argument and
4358 % those that do not. If it is followed by {arg} in the input, then
4359 % that will dutifully get written to the index (or wherever).
4361 \def\definedummyword ##1{\def##1{\string##1\space}}%
4362 \def\definedummyletter##1{\def##1{\string##1}}%
4363 \let\definedummyaccent\definedummyletter
4365 \commondummiesnofonts
4367 \definedummyletter\_%
4368 \definedummyletter\-%
4370 % Non-English letters.
4381 \definedummyword\exclamdown
4385 \definedummyword\ordf
4386 \definedummyword\ordm
4387 \definedummyword\questiondown
4391 % Although these internal commands shouldn't show up, sometimes they do.
4393 \definedummyword\gtr
4394 \definedummyword\hat
4395 \definedummyword\less
4398 \definedummyword\tclose
4401 \definedummyword\LaTeX
4402 \definedummyword\TeX
4404 % Assorted special characters.
4405 \definedummyword\arrow
4406 \definedummyword\bullet
4407 \definedummyword\comma
4408 \definedummyword\copyright
4409 \definedummyword\registeredsymbol
4410 \definedummyword\dots
4411 \definedummyword\enddots
4412 \definedummyword\entrybreak
4413 \definedummyword\equiv
4414 \definedummyword\error
4415 \definedummyword\euro
4416 \definedummyword\expansion
4417 \definedummyword\geq
4418 \definedummyword\guillemetleft
4419 \definedummyword\guillemetright
4420 \definedummyword\guilsinglleft
4421 \definedummyword\guilsinglright
4422 \definedummyword\leq
4423 \definedummyword\minus
4424 \definedummyword\ogonek
4425 \definedummyword\pounds
4426 \definedummyword\point
4427 \definedummyword\print
4428 \definedummyword\quotedblbase
4429 \definedummyword\quotedblleft
4430 \definedummyword\quotedblright
4431 \definedummyword\quoteleft
4432 \definedummyword\quoteright
4433 \definedummyword\quotesinglbase
4434 \definedummyword\result
4435 \definedummyword\textdegree
4437 % We want to disable all macros so that they are not expanded by \write.
4440 \normalturnoffactive
4442 % Handle some cases of @value -- where it does not contain any
4443 % (non-fully-expandable) commands.
4444 \makevalueexpandable
4447 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4449 \def\commondummiesnofonts{%
4450 % Control letters and accents.
4451 \definedummyletter\!%
4452 \definedummyaccent\"%
4453 \definedummyaccent\'%
4454 \definedummyletter\*%
4455 \definedummyaccent\,%
4456 \definedummyletter\.%
4457 \definedummyletter\/%
4458 \definedummyletter\:%
4459 \definedummyaccent\=%
4460 \definedummyletter\?%
4461 \definedummyaccent\^%
4462 \definedummyaccent\`%
4463 \definedummyaccent\~%
4467 \definedummyword\dotaccent
4468 \definedummyword\ogonek
4469 \definedummyword\ringaccent
4470 \definedummyword\tieaccent
4471 \definedummyword\ubaraccent
4472 \definedummyword\udotaccent
4473 \definedummyword\dotless
4475 % Texinfo font commands.
4479 \definedummyword\sansserif
4481 \definedummyword\slanted
4484 % Commands that take arguments.
4485 \definedummyword\acronym
4486 \definedummyword\cite
4487 \definedummyword\code
4488 \definedummyword\command
4489 \definedummyword\dfn
4490 \definedummyword\dmn
4491 \definedummyword\email
4492 \definedummyword\emph
4493 \definedummyword\env
4494 \definedummyword\file
4495 \definedummyword\indicateurl
4496 \definedummyword\kbd
4497 \definedummyword\key
4498 \definedummyword\math
4499 \definedummyword\option
4500 \definedummyword\pxref
4501 \definedummyword\ref
4502 \definedummyword\samp
4503 \definedummyword\strong
4504 \definedummyword\tie
4505 \definedummyword\uref
4506 \definedummyword\url
4507 \definedummyword\var
4508 \definedummyword\verb
4510 \definedummyword\xref
4513 % \indexnofonts is used when outputting the strings to sort the index
4514 % by, and when constructing control sequence names. It eliminates all
4515 % control sequences and just writes whatever the best ASCII sort string
4516 % would be for a given command (usually its argument).
4519 % Accent commands should become @asis.
4520 \def\definedummyaccent##1{\let##1\asis}%
4521 % We can just ignore other control letters.
4522 \def\definedummyletter##1{\let##1\empty}%
4523 % All control words become @asis by default; overrides below.
4524 \let\definedummyword\definedummyaccent
4526 \commondummiesnofonts
4528 % Don't no-op \tt, since it isn't a user-level command
4529 % and is used in the definitions of the active chars like <, >, |, etc.
4530 % Likewise with the other plain tex font commands.
4535 \def\_{\normalunderscore}%
4536 \def\-{}% @- shouldn't affect sorting
4538 % Unfortunately, texindex is not prepared to handle braces in the
4539 % content at all. So for index sorting, we map @{ and @} to strings
4540 % starting with |, since that ASCII character is between ASCII { and }.
4544 % Non-English letters.
4561 \def\questiondown{?}%
4568 % Assorted special characters.
4569 % (The following {} will end up in the sort string, but that's ok.)
4571 \def\bullet{bullet}%
4573 \def\copyright{copyright}%
4579 \def\expansion{==>}%
4581 \def\guillemetleft{<<}%
4582 \def\guillemetright{>>}%
4583 \def\guilsinglleft{<}%
4584 \def\guilsinglright{>}%
4588 \def\pounds{pounds}%
4590 \def\quotedblbase{"}%
4591 \def\quotedblleft{"}%
4592 \def\quotedblright{"}%
4595 \def\quotesinglbase{,}%
4596 \def\registeredsymbol{R}%
4600 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4601 \else \indexlquoteignore \fi
4603 % We need to get rid of all macros, leaving only the arguments (if present).
4604 % Of course this is not nearly correct, but it is the best we can do for now.
4605 % makeinfo does not expand macros in the argument to @deffn, which ends up
4606 % writing an index entry, and texindex isn't prepared for an index sort entry
4607 % that starts with \.
4609 % Since macro invocations are followed by braces, we can just redefine them
4610 % to take a single TeX argument. The case of a macro invocation that
4611 % goes to end-of-line is not handled.
4616 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4617 % ignore left quotes in the sort term.
4618 {\catcode`\`=\active
4619 \gdef\indexlquoteignore{\let`=\empty}}
4621 \let\indexbackslash=0 %overridden during \printindex.
4622 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4624 % Most index entries go through here, but \dosubind is the general case.
4625 % #1 is the index name, #2 is the entry text.
4626 \def\doind#1#2{\dosubind{#1}{#2}{}}
4628 % Workhorse for all \fooindexes.
4629 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4630 % empty if called from \doind, as we usually are (the main exception
4631 % is with most defuns, which call us directly).
4633 \def\dosubind#1#2#3{%
4636 % Store the main index entry text (including the third arg).
4638 % If third arg is present, precede it with a space.
4640 \ifx\thirdarg\empty \else
4641 \toks0 = \expandafter{\the\toks0 \space #3}%
4644 \edef\writeto{\csname#1indfile\endcsname}%
4646 \safewhatsit\dosubindwrite
4651 % Write the entry in \toks0 to the index file:
4653 \def\dosubindwrite{%
4654 % Put the index entry in the margin if desired.
4655 \ifx\SETmarginindex\relax\else
4656 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4659 % Remember, we are within a group.
4660 \indexdummies % Must do this here, since \bf, etc expand at this stage
4661 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4662 % so it will be output as is; and it will print as backslash.
4664 % Process the index entry with all font commands turned off, to
4665 % get the string to sort by.
4667 \edef\temp{\the\toks0}% need full expansion
4668 \xdef\indexsorttmp{\temp}%
4671 % Set up the complete index entry, with both the sort key and
4672 % the original text, including any font commands. We write
4673 % three arguments to \entry to the .?? file (four in the
4674 % subentry case), texindex reduces to two when writing the .??s
4678 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4683 % Take care of unwanted page breaks/skips around a whatsit:
4685 % If a skip is the last thing on the list now, preserve it
4686 % by backing up by \lastskip, doing the \write, then inserting
4687 % the skip again. Otherwise, the whatsit generated by the
4688 % \write or \pdfdest will make \lastskip zero. The result is that
4689 % sequences like this:
4693 % will have extra space inserted, because the \medbreak in the
4694 % start of the @defun won't see the skip inserted by the @end of
4695 % the previous defun.
4697 % But don't do any of this if we're not in vertical mode. We
4698 % don't want to do a \vskip and prematurely end a paragraph.
4700 % Avoid page breaks due to these extra skips, too.
4702 % But wait, there is a catch there:
4703 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4704 % sufficient for this purpose, as it ignores stretch and shrink parts
4705 % of the skip. The only way seems to be to check the textual
4706 % representation of the skip.
4708 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4709 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4711 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4713 \newskip\whatsitskip
4714 \newcount\whatsitpenalty
4718 \def\safewhatsit#1{%
4722 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4723 \whatsitskip = \lastskip
4724 \edef\lastskipmacro{\the\lastskip}%
4725 \whatsitpenalty = \lastpenalty
4727 % If \lastskip is nonzero, that means the last item was a
4728 % skip. And since a skip is discardable, that means this
4729 % -\whatsitskip glue we're inserting is preceded by a
4730 % non-discardable item, therefore it is not a potential
4731 % breakpoint, therefore no \nobreak needed.
4732 \ifx\lastskipmacro\zeroskipmacro
4739 \ifx\lastskipmacro\zeroskipmacro
4740 % If \lastskip was zero, perhaps the last item was a penalty, and
4741 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4742 % to re-insert the same penalty (values >10000 are used for various
4743 % signals); since we just inserted a non-discardable item, any
4744 % following glue (such as a \parskip) would be a breakpoint. For example:
4746 % @deffn deffn-whatever
4747 % @vindex index-whatever
4749 % would allow a break between the index-whatever whatsit
4750 % and the "Description." paragraph.
4751 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4753 % On the other hand, if we had a nonzero \lastskip,
4754 % this make-up glue would be preceded by a non-discardable item
4755 % (the whatsit from the \write), so we must insert a \nobreak.
4756 \nobreak\vskip\whatsitskip
4761 % The index entry written in the file actually looks like
4762 % \entry {sortstring}{page}{topic}
4764 % \entry {sortstring}{page}{topic}{subtopic}
4765 % The texindex program reads in these files and writes files
4766 % containing these kinds of lines:
4768 % before the first topic whose initial is c
4769 % \entry {topic}{pagelist}
4770 % for a topic that is used without subtopics
4772 % for the beginning of a topic that is used with subtopics
4773 % \secondary {subtopic}{pagelist}
4774 % for each subtopic.
4776 % Define the user-accessible indexing commands
4777 % @findex, @vindex, @kindex, @cindex.
4779 \def\findex {\fnindex}
4780 \def\kindex {\kyindex}
4781 \def\cindex {\cpindex}
4782 \def\vindex {\vrindex}
4783 \def\tindex {\tpindex}
4784 \def\pindex {\pgindex}
4786 \def\cindexsub {\begingroup\obeylines\cindexsub}
4788 \gdef\cindexsub "#1" #2^^M{\endgroup %
4789 \dosubind{cp}{#2}{#1}}}
4791 % Define the macros used in formatting output of the sorted index material.
4793 % @printindex causes a particular index (the ??s file) to get printed.
4794 % It does not print any chapter heading (usually an @unnumbered).
4796 \parseargdef\printindex{\begingroup
4797 \dobreak \chapheadingskip{10000}%
4802 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4804 % See if the index file exists and is nonempty.
4805 % Change catcode of @ here so that if the index file contains
4807 % as its first line, TeX doesn't complain about mismatched braces
4808 % (because it thinks @} is a control sequence).
4810 \openin 1 \jobname.#1s
4812 % \enddoublecolumns gets confused if there is no text in the index,
4813 % and it loses the chapter title and the aux file entries for the
4814 % index. The easiest way to prevent this problem is to make sure
4815 % there is some text.
4816 \putwordIndexNonexistent
4819 % If the index file exists but is empty, then \openin leaves \ifeof
4820 % false. We have to make TeX try to read something from the file, so
4821 % it can discover if there is anything in it.
4824 \putwordIndexIsEmpty
4826 % Index files are almost Texinfo source, but we use \ as the escape
4827 % character. It would be better to use @, but that's too big a change
4828 % to make right now.
4829 \def\indexbackslash{\backslashcurfont}%
4840 % These macros are used by the sorted index file itself.
4841 % Change them to control the appearance of the index.
4844 % Some minor font changes for the special characters.
4845 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4847 % Remove any glue we may have, we'll be inserting our own.
4850 % We like breaks before the index initials, so insert a bonus.
4852 \vskip 0pt plus 3\baselineskip
4854 \vskip 0pt plus -3\baselineskip
4856 % Typeset the initial. Making this add up to a whole number of
4857 % baselineskips increases the chance of the dots lining up from column
4858 % to column. It still won't often be perfect, because of the stretch
4859 % we need before each entry, but it's better.
4861 % No shrink because it confuses \balancecolumns.
4862 \vskip 1.67\baselineskip plus .5\baselineskip
4863 \leftline{\secbf #1}%
4864 % Do our best not to break after the initial.
4866 \vskip .33\baselineskip plus .1\baselineskip
4869 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4870 % then page number (#2) flushed to the right margin. It is used for index
4871 % and table of contents entries. The paragraph is indented by \leftskip.
4873 % A straightforward implementation would start like this:
4874 % \def\entry#1#2{...
4875 % But this freezes the catcodes in the argument, and can cause problems to
4876 % @code, which sets - active. This problem was fixed by a kludge---
4877 % ``-'' was active throughout whole index, but this isn't really right.
4878 % The right solution is to prevent \entry from swallowing the whole text.
4883 % Start a new paragraph if necessary, so our assignments below can't
4884 % affect previous text.
4887 % Do not fill out the last line with white space.
4890 % No extra space above this paragraph.
4893 % Do not prefer a separate line ending with a hyphen to fewer lines.
4894 \finalhyphendemerits = 0
4896 % \hangindent is only relevant when the entry text and page number
4897 % don't both fit on one line. In that case, bob suggests starting the
4898 % dots pretty far over on the line. Unfortunately, a large
4899 % indentation looks wrong when the entry text itself is broken across
4900 % lines. So we use a small indentation and put up with long leaders.
4902 % \hangafter is reset to 1 (which is the value we want) at the start
4903 % of each paragraph, so we need not do anything with that.
4906 % When the entry text needs to be broken, just fill out the first line
4908 \rightskip = 0pt plus1fil
4910 % A bit of stretch before each entry for the benefit of balancing
4914 % When reading the text of entry, convert explicit line breaks
4915 % from @* into spaces. The user might give these in long section
4916 % titles, for instance.
4917 \def\*{\unskip\space\ignorespaces}%
4918 \def\entrybreak{\hfil\break}%
4920 % Swallow the left brace of the text (first parameter):
4921 \afterassignment\doentry
4924 \def\entrybreak{\unskip\space\ignorespaces}%
4926 \bgroup % Instead of the swallowed brace.
4928 \aftergroup\finishentry
4929 % And now comes the text of the entry.
4931 \def\finishentry#1{%
4932 % #1 is the page number.
4934 % The following is kludged to not output a line of dots in the index if
4935 % there are no page numbers. The next person who breaks this will be
4936 % cursed by a Unix daemon.
4937 \setbox\boxA = \hbox{#1}%
4938 \ifdim\wd\boxA = 0pt
4942 % If we must, put the page number on a line of its own, and fill out
4943 % this line with blank space. (The \hfil is overwhelmed with the
4944 % fill leaders glue in \indexdotfill if the page number does fit.)
4946 \null\nobreak\indexdotfill % Have leaders before the page number.
4948 % The `\ ' here is removed by the implicit \unskip that TeX does as
4949 % part of (the primitive) \par. Without it, a spurious underfull
4962 % Like plain.tex's \dotfill, except uses up at least 1 em.
4963 \def\indexdotfill{\cleaders
4964 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4966 \def\primary #1{\line{#1\hfil}}
4968 \newskip\secondaryindent \secondaryindent=0.5cm
4969 \def\secondary#1#2{{%
4974 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4976 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4983 % Define two-column mode, which we use to typeset indexes.
4984 % Adapted from the TeXbook, page 416, which is to say,
4985 % the manmac.tex format used to print the TeXbook itself.
4989 \newdimen\doublecolumnhsize
4991 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4992 % Grab any single-column material above us.
4995 % Here is a possibility not foreseen in manmac: if we accumulate a
4996 % whole lot of material, we might end up calling this \output
4997 % routine twice in a row (see the doublecol-lose test, which is
4998 % essentially a couple of indexes with @setchapternewpage off). In
4999 % that case we just ship out what is in \partialpage with the normal
5000 % output routine. Generally, \partialpage will be empty when this
5001 % runs and this will be a no-op. See the indexspread.tex test case.
5002 \ifvoid\partialpage \else
5003 \onepageout{\pagecontents\partialpage}%
5006 \global\setbox\partialpage = \vbox{%
5007 % Unvbox the main output page.
5009 \kern-\topskip \kern\baselineskip
5012 \eject % run that output routine to set \partialpage
5014 % Use the double-column output routine for subsequent pages.
5015 \output = {\doublecolumnout}%
5017 % Change the page size parameters. We could do this once outside this
5018 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5019 % format, but then we repeat the same computation. Repeating a couple
5020 % of assignments once per index is clearly meaningless for the
5021 % execution time, so we may as well do it in one place.
5023 % First we halve the line length, less a little for the gutter between
5024 % the columns. We compute the gutter based on the line length, so it
5025 % changes automatically with the paper format. The magic constant
5026 % below is chosen so that the gutter has the same value (well, +-<1pt)
5027 % as it did when we hard-coded it.
5029 % We put the result in a separate register, \doublecolumhsize, so we
5030 % can restore it in \pagesofar, after \hsize itself has (potentially)
5033 \doublecolumnhsize = \hsize
5034 \advance\doublecolumnhsize by -.04154\hsize
5035 \divide\doublecolumnhsize by 2
5036 \hsize = \doublecolumnhsize
5038 % Double the \vsize as well. (We don't need a separate register here,
5039 % since nobody clobbers \vsize.)
5043 % The double-column output routine for all double-column pages except
5046 \def\doublecolumnout{%
5047 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5048 % Get the available space for the double columns -- the normal
5049 % (undoubled) page height minus any material left over from the
5053 \advance\dimen@ by -\ht\partialpage
5055 % box0 will be the left-hand column, box2 the right.
5056 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5057 \onepageout\pagesofar
5059 \penalty\outputpenalty
5062 % Re-output the contents of the output page -- any previous material,
5063 % followed by the two boxes we just split, in box0 and box2.
5067 \hsize = \doublecolumnhsize
5068 \wd0=\hsize \wd2=\hsize
5069 \hbox to\pagewidth{\box0\hfil\box2}%
5072 % All done with double columns.
5073 \def\enddoublecolumns{%
5074 % The following penalty ensures that the page builder is exercised
5075 % _before_ we change the output routine. This is necessary in the
5076 % following situation:
5078 % The last section of the index consists only of a single entry.
5079 % Before this section, \pagetotal is less than \pagegoal, so no
5080 % break occurs before the last section starts. However, the last
5081 % section, consisting of \initial and the single \entry, does not
5082 % fit on the page and has to be broken off. Without the following
5083 % penalty the page builder will not be exercised until \eject
5084 % below, and by that time we'll already have changed the output
5085 % routine to the \balancecolumns version, so the next-to-last
5086 % double-column page will be processed with \balancecolumns, which
5087 % is wrong: The two columns will go to the main vertical list, with
5088 % the broken-off section in the recent contributions. As soon as
5089 % the output routine finishes, TeX starts reconsidering the page
5090 % break. The two columns and the broken-off section both fit on the
5091 % page, because the two columns now take up only half of the page
5092 % goal. When TeX sees \eject from below which follows the final
5093 % section, it invokes the new output routine that we've set after
5094 % \balancecolumns below; \onepageout will try to fit the two columns
5095 % and the final section into the vbox of \pageheight (see
5096 % \pagebody), causing an overfull box.
5098 % Note that glue won't work here, because glue does not exercise the
5099 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5103 % Split the last of the double-column material. Leave it on the
5104 % current page, no automatic page break.
5107 % If we end up splitting too much material for the current page,
5108 % though, there will be another page break right after this \output
5109 % invocation ends. Having called \balancecolumns once, we do not
5110 % want to call it again. Therefore, reset \output to its normal
5111 % definition right away. (We hope \balancecolumns will never be
5112 % called on to balance too much material, but if it is, this makes
5113 % the output somewhat more palatable.)
5114 \global\output = {\onepageout{\pagecontents\PAGE}}%
5117 \endgroup % started in \begindoublecolumns
5119 % \pagegoal was set to the doubled \vsize above, since we restarted
5120 % the current page. We're now back to normal single-column
5121 % typesetting, so reset \pagegoal to the normal \vsize (after the
5122 % \endgroup where \vsize got restored).
5126 % Called at the end of the double column material.
5127 \def\balancecolumns{%
5128 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5130 \advance\dimen@ by \topskip
5131 \advance\dimen@ by-\baselineskip
5132 \divide\dimen@ by 2 % target to split to
5133 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5134 \splittopskip = \topskip
5135 % Loop until we get a decent breakpoint.
5139 \global\setbox3 = \copy0
5140 \global\setbox1 = \vsplit3 to \dimen@
5142 \global\advance\dimen@ by 1pt
5145 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5146 \setbox0=\vbox to\dimen@{\unvbox1}%
5147 \setbox2=\vbox to\dimen@{\unvbox3}%
5151 \catcode`\@ = \other
5154 \message{sectioning,}
5155 % Chapters, sections, etc.
5157 % Let's start with @part.
5158 \outer\parseargdef\part{\partzzz{#1}}
5162 \vskip.3\vsize % move it down on the page a bit
5164 \noindent \titlefonts\rmisbold #1\par % the text
5165 \let\lastnode=\empty % no node to associate with
5166 \writetocentry{part}{#1}{}% but put it in the toc
5167 \headingsoff % no headline or footline on the part page
5172 % \unnumberedno is an oxymoron. But we count the unnumbered
5173 % sections so that we can refer to them unambiguously in the pdf
5174 % outlines by their "section number". We avoid collisions with chapter
5175 % numbers by starting them at 10000. (If a document ever has 10000
5176 % chapters, we're in trouble anyway, I'm sure.)
5177 \newcount\unnumberedno \unnumberedno = 10000
5179 \newcount\secno \secno=0
5180 \newcount\subsecno \subsecno=0
5181 \newcount\subsubsecno \subsubsecno=0
5183 % This counter is funny since it counts through charcodes of letters A, B, ...
5184 \newcount\appendixno \appendixno = `\@
5186 % \def\appendixletter{\char\the\appendixno}
5187 % We do the following ugly conditional instead of the above simple
5188 % construct for the sake of pdftex, which needs the actual
5189 % letter in the expansion, not just typeset.
5191 \def\appendixletter{%
5192 \ifnum\appendixno=`A A%
5193 \else\ifnum\appendixno=`B B%
5194 \else\ifnum\appendixno=`C C%
5195 \else\ifnum\appendixno=`D D%
5196 \else\ifnum\appendixno=`E E%
5197 \else\ifnum\appendixno=`F F%
5198 \else\ifnum\appendixno=`G G%
5199 \else\ifnum\appendixno=`H H%
5200 \else\ifnum\appendixno=`I I%
5201 \else\ifnum\appendixno=`J J%
5202 \else\ifnum\appendixno=`K K%
5203 \else\ifnum\appendixno=`L L%
5204 \else\ifnum\appendixno=`M M%
5205 \else\ifnum\appendixno=`N N%
5206 \else\ifnum\appendixno=`O O%
5207 \else\ifnum\appendixno=`P P%
5208 \else\ifnum\appendixno=`Q Q%
5209 \else\ifnum\appendixno=`R R%
5210 \else\ifnum\appendixno=`S S%
5211 \else\ifnum\appendixno=`T T%
5212 \else\ifnum\appendixno=`U U%
5213 \else\ifnum\appendixno=`V V%
5214 \else\ifnum\appendixno=`W W%
5215 \else\ifnum\appendixno=`X X%
5216 \else\ifnum\appendixno=`Y Y%
5217 \else\ifnum\appendixno=`Z Z%
5218 % The \the is necessary, despite appearances, because \appendixletter is
5219 % expanded while writing the .toc file. \char\appendixno is not
5220 % expandable, thus it is written literally, thus all appendixes come out
5221 % with the same letter (or @) in the toc without it.
5222 \else\char\the\appendixno
5223 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5224 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5226 % Each @chapter defines these (using marks) as the number+name, number
5227 % and name of the chapter. Page headings and footings can use
5228 % these. @section does likewise.
5230 \def\thischapternum{}
5231 \def\thischaptername{}
5233 \def\thissectionnum{}
5234 \def\thissectionname{}
5236 \newcount\absseclevel % used to calculate proper heading level
5237 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5239 % @raisesections: treat @section as chapter, @subsection as section, etc.
5240 \def\raisesections{\global\advance\secbase by -1}
5241 \let\up=\raisesections % original BFox name
5243 % @lowersections: treat @chapter as section, @section as subsection, etc.
5244 \def\lowersections{\global\advance\secbase by 1}
5245 \let\down=\lowersections % original BFox name
5247 % we only have subsub.
5248 \chardef\maxseclevel = 3
5250 % A numbered section within an unnumbered changes to unnumbered too.
5251 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5252 \chardef\unnlevel = \maxseclevel
5254 % Trace whether the current chapter is an appendix or not:
5255 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5256 \def\chapheadtype{N}
5258 % Choose a heading macro
5259 % #1 is heading type
5260 % #2 is heading level
5261 % #3 is text for heading
5262 \def\genhead#1#2#3{%
5263 % Compute the abs. sec. level:
5265 \advance\absseclevel by \secbase
5266 % Make sure \absseclevel doesn't fall outside the range:
5267 \ifnum \absseclevel < 0
5270 \ifnum \absseclevel > 3
5277 \ifnum \absseclevel < \unnlevel
5278 \chardef\unnlevel = \absseclevel
5281 % Check for appendix sections:
5282 \ifnum \absseclevel = 0
5283 \edef\chapheadtype{\headtype}%
5285 \if \headtype A\if \chapheadtype N%
5286 \errmessage{@appendix... within a non-appendix chapter}%
5289 % Check for numbered within unnumbered:
5290 \ifnum \absseclevel > \unnlevel
5293 \chardef\unnlevel = 3
5296 % Now print the heading:
5300 \or \unnumberedseczzz{#3}%
5301 \or \unnumberedsubseczzz{#3}%
5302 \or \unnumberedsubsubseczzz{#3}%
5308 \or \appendixsectionzzz{#3}%
5309 \or \appendixsubseczzz{#3}%
5310 \or \appendixsubsubseczzz{#3}%
5316 \or \numberedsubseczzz{#3}%
5317 \or \numberedsubsubseczzz{#3}%
5321 \suppressfirstparagraphindent
5325 \def\numhead{\genhead N}
5326 \def\apphead{\genhead A}
5327 \def\unnmhead{\genhead U}
5329 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5330 % all lower-level sectioning counters to zero.
5332 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5333 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5334 \let\chaplevelprefix = \empty
5336 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5338 % section resetting is \global in case the chapter is in a group, such
5339 % as an @include file.
5340 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5341 \global\advance\chapno by 1
5344 \gdef\chaplevelprefix{\the\chapno.}%
5347 % \putwordChapter can contain complex things in translations.
5348 \toks0=\expandafter{\putwordChapter}%
5349 \message{\the\toks0 \space \the\chapno}%
5351 % Write the actual heading.
5352 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5354 % So @section and the like are numbered underneath this chapter.
5355 \global\let\section = \numberedsec
5356 \global\let\subsection = \numberedsubsec
5357 \global\let\subsubsection = \numberedsubsubsec
5360 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5362 \def\appendixzzz#1{%
5363 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5364 \global\advance\appendixno by 1
5365 \gdef\chaplevelprefix{\appendixletter.}%
5368 % \putwordAppendix can contain complex things in translations.
5369 \toks0=\expandafter{\putwordAppendix}%
5370 \message{\the\toks0 \space \appendixletter}%
5372 \chapmacro{#1}{Yappendix}{\appendixletter}%
5374 \global\let\section = \appendixsec
5375 \global\let\subsection = \appendixsubsec
5376 \global\let\subsubsection = \appendixsubsubsec
5379 % normally unnmhead0 calls unnumberedzzz:
5380 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5381 \def\unnumberedzzz#1{%
5382 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5383 \global\advance\unnumberedno by 1
5385 % Since an unnumbered has no number, no prefix for figures.
5386 \global\let\chaplevelprefix = \empty
5389 % This used to be simply \message{#1}, but TeX fully expands the
5390 % argument to \message. Therefore, if #1 contained @-commands, TeX
5391 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5392 % expanded @cite (which turns out to cause errors because \cite is meant
5393 % to be executed, not expanded).
5395 % Anyway, we don't want the fully-expanded definition of @cite to appear
5396 % as a result of the \message, we just want `@cite' itself. We use
5397 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5398 % simply yielding the contents of <toks register>. (We also do this for
5401 \message{(\the\toks0)}%
5403 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5405 \global\let\section = \unnumberedsec
5406 \global\let\subsection = \unnumberedsubsec
5407 \global\let\subsubsection = \unnumberedsubsubsec
5410 % @centerchap is like @unnumbered, but the heading is centered.
5411 \outer\parseargdef\centerchap{%
5412 % Well, we could do the following in a group, but that would break
5413 % an assumption that \chapmacro is called at the outermost level.
5414 % Thus we are safer this way: --kasal, 24feb04
5415 \let\centerparametersmaybe = \centerparameters
5417 \let\centerparametersmaybe = \relax
5420 % @top is like @unnumbered.
5425 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5427 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5428 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5431 % normally calls appendixsectionzzz:
5432 \outer\parseargdef\appendixsection{\apphead1{#1}}
5433 \def\appendixsectionzzz#1{%
5434 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5435 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5437 \let\appendixsec\appendixsection
5439 % normally calls unnumberedseczzz:
5440 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5441 \def\unnumberedseczzz#1{%
5442 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5443 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5448 % normally calls numberedsubseczzz:
5449 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5450 \def\numberedsubseczzz#1{%
5451 \global\subsubsecno=0 \global\advance\subsecno by 1
5452 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5455 % normally calls appendixsubseczzz:
5456 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5457 \def\appendixsubseczzz#1{%
5458 \global\subsubsecno=0 \global\advance\subsecno by 1
5459 \sectionheading{#1}{subsec}{Yappendix}%
5460 {\appendixletter.\the\secno.\the\subsecno}%
5463 % normally calls unnumberedsubseczzz:
5464 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5465 \def\unnumberedsubseczzz#1{%
5466 \global\subsubsecno=0 \global\advance\subsecno by 1
5467 \sectionheading{#1}{subsec}{Ynothing}%
5468 {\the\unnumberedno.\the\secno.\the\subsecno}%
5473 % normally numberedsubsubseczzz:
5474 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5475 \def\numberedsubsubseczzz#1{%
5476 \global\advance\subsubsecno by 1
5477 \sectionheading{#1}{subsubsec}{Ynumbered}%
5478 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5481 % normally appendixsubsubseczzz:
5482 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5483 \def\appendixsubsubseczzz#1{%
5484 \global\advance\subsubsecno by 1
5485 \sectionheading{#1}{subsubsec}{Yappendix}%
5486 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5489 % normally unnumberedsubsubseczzz:
5490 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5491 \def\unnumberedsubsubseczzz#1{%
5492 \global\advance\subsubsecno by 1
5493 \sectionheading{#1}{subsubsec}{Ynothing}%
5494 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5497 % These macros control what the section commands do, according
5498 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5499 % Define them by default for a numbered chapter.
5500 \let\section = \numberedsec
5501 \let\subsection = \numberedsubsec
5502 \let\subsubsection = \numberedsubsubsec
5504 % Define @majorheading, @heading and @subheading
5506 % NOTE on use of \vbox for chapter headings, section headings, and such:
5507 % 1) We use \vbox rather than the earlier \line to permit
5508 % overlong headings to fold.
5509 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5510 % heading is obnoxious; this forbids it.
5511 % 3) Likewise, headings look best if no \parindent is used, and
5512 % if justification is not attempted. Hence \raggedright.
5515 {\advance\chapheadingskip by 10pt \chapbreak }%
5516 \parsearg\chapheadingzzz
5519 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5520 \def\chapheadingzzz#1{%
5521 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5522 \parindent=0pt\ptexraggedright
5523 \rmisbold #1\hfill}}%
5524 \bigskip \par\penalty 200\relax
5525 \suppressfirstparagraphindent
5528 % @heading, @subheading, @subsubheading.
5529 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5530 \suppressfirstparagraphindent}
5531 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5532 \suppressfirstparagraphindent}
5533 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5534 \suppressfirstparagraphindent}
5536 % These macros generate a chapter, section, etc. heading only
5537 % (including whitespace, linebreaking, etc. around it),
5538 % given all the information in convenient, parsed form.
5540 % Args are the skip and penalty (usually negative)
5541 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5543 % Parameter controlling skip before chapter headings (if needed)
5544 \newskip\chapheadingskip
5546 % Define plain chapter starts, and page on/off switching for it.
5547 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5548 \def\chappager{\par\vfill\supereject}
5549 % Because \domark is called before \chapoddpage, the filler page will
5550 % get the headings for the next chapter, which is wrong. But we don't
5551 % care -- we just disable all headings on the filler page.
5563 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5566 \global\let\contentsalignmacro = \chappager
5567 \global\let\pchapsepmacro=\chapbreak
5568 \global\let\pagealignmacro=\chappager}
5571 \global\let\contentsalignmacro = \chappager
5572 \global\let\pchapsepmacro=\chappager
5573 \global\let\pagealignmacro=\chappager
5574 \global\def\HEADINGSon{\HEADINGSsingle}}
5577 \global\let\contentsalignmacro = \chapoddpage
5578 \global\let\pchapsepmacro=\chapoddpage
5579 \global\let\pagealignmacro=\chapoddpage
5580 \global\def\HEADINGSon{\HEADINGSdouble}}
5586 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5587 % Yappendix, Yomitfromtoc), #3 the chapter number.
5589 % To test against our argument.
5590 \def\Ynothingkeyword{Ynothing}
5591 \def\Yomitfromtockeyword{Yomitfromtoc}
5592 \def\Yappendixkeyword{Yappendix}
5594 \def\chapmacro#1#2#3{%
5595 % Insert the first mark before the heading break (see notes for \domark).
5596 \let\prevchapterdefs=\lastchapterdefs
5597 \let\prevsectiondefs=\lastsectiondefs
5598 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5599 \gdef\thissection{}}%
5602 \ifx\temptype\Ynothingkeyword
5603 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5604 \gdef\thischapter{\thischaptername}}%
5605 \else\ifx\temptype\Yomitfromtockeyword
5606 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5607 \gdef\thischapter{}}%
5608 \else\ifx\temptype\Yappendixkeyword
5610 \xdef\lastchapterdefs{%
5611 \gdef\noexpand\thischaptername{\the\toks0}%
5612 \gdef\noexpand\thischapternum{\appendixletter}%
5613 % \noexpand\putwordAppendix avoids expanding indigestible
5614 % commands in some of the translations.
5615 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5616 \noexpand\thischapternum:
5617 \noexpand\thischaptername}%
5621 \xdef\lastchapterdefs{%
5622 \gdef\noexpand\thischaptername{\the\toks0}%
5623 \gdef\noexpand\thischapternum{\the\chapno}%
5624 % \noexpand\putwordChapter avoids expanding indigestible
5625 % commands in some of the translations.
5626 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5627 \noexpand\thischapternum:
5628 \noexpand\thischaptername}%
5632 % Output the mark. Pass it through \safewhatsit, to take care of
5633 % the preceding space.
5636 % Insert the chapter heading break.
5639 % Now the second mark, after the heading break. No break points
5640 % between here and the heading.
5641 \let\prevchapterdefs=\lastchapterdefs
5642 \let\prevsectiondefs=\lastsectiondefs
5646 \chapfonts \rmisbold
5648 % Have to define \lastsection before calling \donoderef, because the
5649 % xref code eventually uses it. On the other hand, it has to be called
5650 % after \pchapsepmacro, or the headline will change too soon.
5651 \gdef\lastsection{#1}%
5653 % Only insert the separating space if we have a chapter/appendix
5654 % number, and don't print the unnumbered ``number''.
5655 \ifx\temptype\Ynothingkeyword
5657 \def\toctype{unnchap}%
5658 \else\ifx\temptype\Yomitfromtockeyword
5659 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5661 \else\ifx\temptype\Yappendixkeyword
5662 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5665 \setbox0 = \hbox{#3\enspace}%
5666 \def\toctype{numchap}%
5669 % Write the toc entry for this chapter. Must come before the
5670 % \donoderef, because we include the current node name in the toc
5671 % entry, and \donoderef resets it to empty.
5672 \writetocentry{\toctype}{#1}{#3}%
5674 % For pdftex, we have to write out the node definition (aka, make
5675 % the pdfdest) after any page break, but before the actual text has
5676 % been typeset. If the destination for the pdf outline is after the
5677 % text, then jumping from the outline may wind up with the text not
5678 % being visible, for instance under high magnification.
5681 % Typeset the actual heading.
5682 \nobreak % Avoid page breaks at the interline glue.
5683 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5684 \hangindent=\wd0 \centerparametersmaybe
5687 \nobreak\bigskip % no page break after a chapter title
5691 % @centerchap -- centered and unnumbered.
5692 \let\centerparametersmaybe = \relax
5693 \def\centerparameters{%
5694 \advance\rightskip by 3\rightskip
5695 \leftskip = \rightskip
5700 % I don't think this chapter style is supported any more, so I'm not
5701 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5703 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5705 \def\unnchfopen #1{%
5706 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5707 \parindent=0pt\ptexraggedright
5708 \rmisbold #1\hfill}}\bigskip \par\nobreak
5710 \def\chfopen #1#2{\chapoddpage {\chapfonts
5711 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5714 \def\centerchfopen #1{%
5715 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5717 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5720 \global\let\chapmacro=\chfopen
5721 \global\let\centerchapmacro=\centerchfopen}
5724 % Section titles. These macros combine the section number parts and
5725 % call the generic \sectionheading to do the printing.
5727 \newskip\secheadingskip
5728 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5730 % Subsection titles.
5731 \newskip\subsecheadingskip
5732 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5734 % Subsubsection titles.
5735 \def\subsubsecheadingskip{\subsecheadingskip}
5736 \def\subsubsecheadingbreak{\subsecheadingbreak}
5739 % Print any size, any type, section title.
5741 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5742 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5745 \def\seckeyword{sec}
5747 \def\sectionheading#1#2#3#4{%
5749 \checkenv{}% should not be in an environment.
5751 % Switch to the right set of fonts.
5752 \csname #2fonts\endcsname \rmisbold
5754 \def\sectionlevel{#2}%
5757 % Insert first mark before the heading break (see notes for \domark).
5758 \let\prevsectiondefs=\lastsectiondefs
5759 \ifx\temptype\Ynothingkeyword
5760 \ifx\sectionlevel\seckeyword
5761 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5762 \gdef\thissection{\thissectionname}}%
5764 \else\ifx\temptype\Yomitfromtockeyword
5765 % Don't redefine \thissection.
5766 \else\ifx\temptype\Yappendixkeyword
5767 \ifx\sectionlevel\seckeyword
5769 \xdef\lastsectiondefs{%
5770 \gdef\noexpand\thissectionname{\the\toks0}%
5771 \gdef\noexpand\thissectionnum{#4}%
5772 % \noexpand\putwordSection avoids expanding indigestible
5773 % commands in some of the translations.
5774 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5775 \noexpand\thissectionnum:
5776 \noexpand\thissectionname}%
5780 \ifx\sectionlevel\seckeyword
5782 \xdef\lastsectiondefs{%
5783 \gdef\noexpand\thissectionname{\the\toks0}%
5784 \gdef\noexpand\thissectionnum{#4}%
5785 % \noexpand\putwordSection avoids expanding indigestible
5786 % commands in some of the translations.
5787 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5788 \noexpand\thissectionnum:
5789 \noexpand\thissectionname}%
5794 % Go into vertical mode. Usually we'll already be there, but we
5795 % don't want the following whatsit to end up in a preceding paragraph
5796 % if the document didn't happen to have a blank line.
5799 % Output the mark. Pass it through \safewhatsit, to take care of
5800 % the preceding space.
5803 % Insert space above the heading.
5804 \csname #2headingbreak\endcsname
5806 % Now the second mark, after the heading break. No break points
5807 % between here and the heading.
5808 \let\prevsectiondefs=\lastsectiondefs
5811 % Only insert the space after the number if we have a section number.
5812 \ifx\temptype\Ynothingkeyword
5815 \gdef\lastsection{#1}%
5816 \else\ifx\temptype\Yomitfromtockeyword
5817 % for @headings -- no section number, don't include in toc,
5818 % and don't redefine \lastsection.
5821 \let\sectionlevel=\empty
5822 \else\ifx\temptype\Yappendixkeyword
5823 \setbox0 = \hbox{#4\enspace}%
5825 \gdef\lastsection{#1}%
5827 \setbox0 = \hbox{#4\enspace}%
5829 \gdef\lastsection{#1}%
5832 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5833 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5835 % Write the node reference (= pdf destination for pdftex).
5836 % Again, see comments in \chapmacro.
5839 % Interline glue will be inserted when the vbox is completed.
5840 % That glue will be a valid breakpoint for the page, since it'll be
5841 % preceded by a whatsit (usually from the \donoderef, or from the
5842 % \writetocentry if there was no node). We don't want to allow that
5843 % break, since then the whatsits could end up on page n while the
5844 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5847 % Output the actual section heading.
5848 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5849 \hangindent=\wd0 % zero if no section number
5852 % Add extra space after the heading -- half of whatever came above it.
5853 % Don't allow stretch, though.
5854 \kern .5 \csname #2headingskip\endcsname
5856 % Do not let the kern be a potential breakpoint, as it would be if it
5857 % was followed by glue.
5860 % We'll almost certainly start a paragraph next, so don't let that
5861 % glue accumulate. (Not a breakpoint because it's preceded by a
5862 % discardable item.)
5865 % This is purely so the last item on the list is a known \penalty >
5866 % 10000. This is so \startdefun can avoid allowing breakpoints after
5867 % section headings. Otherwise, it would insert a valid breakpoint between:
5868 % @section sec-whatever
5869 % @deffn def-whatever
5875 % Table of contents.
5878 % Write an entry to the toc file, opening it if necessary.
5879 % Called from @chapter, etc.
5881 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5882 % We append the current node name (if any) and page number as additional
5883 % arguments for the \{chap,sec,...}entry macros which will eventually
5884 % read this. The node name is used in the pdf outlines as the
5885 % destination to jump to.
5887 % We open the .toc file for writing here instead of at @setfilename (or
5888 % any other fixed time) so that @contents can be anywhere in the document.
5889 % But if #1 is `omit', then we don't do anything. This is used for the
5890 % table of contents chapter openings themselves.
5892 \newif\iftocfileopened
5893 \def\omitkeyword{omit}%
5895 \def\writetocentry#1#2#3{%
5896 \edef\writetoctype{#1}%
5897 \ifx\writetoctype\omitkeyword \else
5898 \iftocfileopened\else
5899 \immediate\openout\tocfile = \jobname.toc
5900 \global\tocfileopenedtrue
5906 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5912 % Tell \shipout to create a pdf destination on each page, if we're
5913 % writing pdf. These are used in the table of contents. We can't
5914 % just write one on every page because the title pages are numbered
5915 % 1 and 2 (the page numbers aren't printed), and so are the first
5916 % two pages of the document. Thus, we'd have two destinations named
5917 % `1', and two named `2'.
5918 \ifpdf \global\pdfmakepagedesttrue \fi
5922 % These characters do not print properly in the Computer Modern roman
5923 % fonts, so we must take special care. This is more or less redundant
5924 % with the Texinfo input format setup at the end of this file.
5926 \def\activecatcodes{%
5939 % Read the toc file, which is essentially Texinfo input.
5943 \input \tocreadfilename
5946 \newskip\contentsrightmargin \contentsrightmargin=1in
5947 \newcount\savepageno
5948 \newcount\lastnegativepageno \lastnegativepageno = -1
5950 % Prepare to read what we've written to \tocfile.
5952 \def\startcontents#1{%
5953 % If @setchapternewpage on, and @headings double, the contents should
5954 % start on an odd page, unlike chapters. Thus, we maintain
5955 % \contentsalignmacro in parallel with \pagealignmacro.
5956 % From: Torbjorn Granlund <tege@matematik.su.se>
5958 \immediate\closeout\tocfile
5960 % Don't need to put `Contents' or `Short Contents' in the headline.
5961 % It is abundantly clear what they are.
5962 \chapmacro{#1}{Yomitfromtoc}{}%
5964 \savepageno = \pageno
5965 \begingroup % Set up to handle contents files properly.
5966 \raggedbottom % Worry more about breakpoints than the bottom.
5967 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5969 % Roman numerals for page numbers.
5970 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5973 % redefined for the two-volume lispref. We always output on
5974 % \jobname.toc even if this is redefined.
5976 \def\tocreadfilename{\jobname.toc}
5978 % Normal (long) toc.
5981 \startcontents{\putwordTOC}%
5982 \openin 1 \tocreadfilename\space
5987 \contentsalignmacro % in case @setchapternewpage odd is in effect
5993 \lastnegativepageno = \pageno
5994 \global\pageno = \savepageno
5997 % And just the chapters.
5998 \def\summarycontents{%
5999 \startcontents{\putwordShortTOC}%
6001 \let\partentry = \shortpartentry
6002 \let\numchapentry = \shortchapentry
6003 \let\appentry = \shortchapentry
6004 \let\unnchapentry = \shortunnchapentry
6005 % We want a true roman here for the page numbers.
6007 \let\rm=\shortcontrm \let\bf=\shortcontbf
6008 \let\sl=\shortcontsl \let\tt=\shortconttt
6010 \hyphenpenalty = 10000
6011 \advance\baselineskip by 1pt % Open it up a little.
6012 \def\numsecentry##1##2##3##4{}
6013 \let\appsecentry = \numsecentry
6014 \let\unnsecentry = \numsecentry
6015 \let\numsubsecentry = \numsecentry
6016 \let\appsubsecentry = \numsecentry
6017 \let\unnsubsecentry = \numsecentry
6018 \let\numsubsubsecentry = \numsecentry
6019 \let\appsubsubsecentry = \numsecentry
6020 \let\unnsubsubsecentry = \numsecentry
6021 \openin 1 \tocreadfilename\space
6027 \contentsalignmacro % in case @setchapternewpage odd is in effect
6029 \lastnegativepageno = \pageno
6030 \global\pageno = \savepageno
6032 \let\shortcontents = \summarycontents
6034 % Typeset the label for a chapter or appendix for the short contents.
6035 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6037 \def\shortchaplabel#1{%
6038 % This space should be enough, since a single number is .5em, and the
6039 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6040 % But use \hss just in case.
6041 % (This space doesn't include the extra space that gets added after
6042 % the label; that gets put in by \shortchapentry above.)
6044 % We'd like to right-justify chapter numbers, but that looks strange
6045 % with appendix letters. And right-justifying numbers and
6046 % left-justifying letters looks strange when there is less than 10
6047 % chapters. Have to read the whole toc once to know how many chapters
6048 % there are before deciding ...
6049 \hbox to 1em{#1\hss}%
6052 % These macros generate individual entries in the table of contents.
6053 % The first argument is the chapter or section name.
6054 % The last argument is the page number.
6055 % The arguments in between are the chapter number, section number, ...
6057 % Parts, in the main contents. Replace the part number, which doesn't
6058 % exist, with an empty box. Let's hope all the numbers have the same width.
6059 % Also ignore the page number, which is conventionally not printed.
6060 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6061 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6063 % Parts, in the short toc.
6064 \def\shortpartentry#1#2#3#4{%
6066 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6067 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6070 % Chapters, in the main contents.
6071 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6073 % Chapters, in the short toc.
6074 % See comments in \dochapentry re vbox and related settings.
6075 \def\shortchapentry#1#2#3#4{%
6076 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6079 % Appendices, in the main contents.
6080 % Need the word Appendix, and a fixed-size box.
6082 \def\appendixbox#1{%
6083 % We use M since it's probably the widest letter.
6084 \setbox0 = \hbox{\putwordAppendix{} M}%
6085 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6087 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6089 % Unnumbered chapters.
6090 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6091 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6094 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6095 \let\appsecentry=\numsecentry
6096 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6099 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6100 \let\appsubsecentry=\numsubsecentry
6101 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6103 % And subsubsections.
6104 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6105 \let\appsubsubsecentry=\numsubsubsecentry
6106 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6108 % This parameter controls the indentation of the various levels.
6109 % Same as \defaultparindent.
6110 \newdimen\tocindent \tocindent = 15pt
6112 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6115 % If the toc has to be broken over pages, we want it to be at chapters
6116 % if at all possible; hence the \penalty.
6117 \def\dochapentry#1#2{%
6118 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6121 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6123 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6126 \def\dosecentry#1#2{\begingroup
6127 \secentryfonts \leftskip=\tocindent
6128 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6131 \def\dosubsecentry#1#2{\begingroup
6132 \subsecentryfonts \leftskip=2\tocindent
6133 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6136 \def\dosubsubsecentry#1#2{\begingroup
6137 \subsubsecentryfonts \leftskip=3\tocindent
6138 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6141 % We use the same \entry macro as for the index entries.
6142 \let\tocentry = \entry
6144 % Space between chapter (or whatever) number and the title.
6145 \def\labelspace{\hskip1em \relax}
6147 \def\dopageno#1{{\rm #1}}
6148 \def\doshortpageno#1{{\rm #1}}
6150 \def\chapentryfonts{\secfonts \rm}
6151 \def\secentryfonts{\textfonts}
6152 \def\subsecentryfonts{\textfonts}
6153 \def\subsubsecentryfonts{\textfonts}
6156 \message{environments,}
6157 % @foo ... @end foo.
6159 % @tex ... @end tex escapes into raw TeX temporarily.
6160 % One exception: @ is still an escape character, so that @end tex works.
6161 % But \@ or @@ will get a plain @ character.
6164 \setupmarkupstyle{tex}%
6165 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6166 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6167 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6178 % ' is active in math mode (mathcode"8000). So reset it, and all our
6179 % other math active characters (just in case), to plain's definitions.
6183 \let\bullet=\ptexbullet
6188 \let\equiv=\ptexequiv
6191 \let\indent=\ptexindent
6192 \let\noindent=\ptexnoindent
6199 \expandafter \let\csname top\endcsname=\ptextop % outer
6200 \let\frenchspacing=\plainfrenchspacing
6202 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6203 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6206 % There is no need to define \Etex.
6208 % Define @lisp ... @end lisp.
6209 % @lisp environment forms a group so it can rebind things,
6210 % including the definition of @end lisp (which normally is erroneous).
6212 % Amount to narrow the margins by for @lisp.
6213 \newskip\lispnarrowing \lispnarrowing=0.4in
6215 % This is the definition that ^^M gets inside @lisp, @example, and other
6216 % such environments. \null is better than a space, since it doesn't
6218 \def\lisppar{\null\endgraf}
6220 % This space is always present above and below environments.
6221 \newskip\envskipamount \envskipamount = 0pt
6223 % Make spacing and below environment symmetrical. We use \parskip here
6224 % to help in doing that, since in @example-like environments \parskip
6225 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6226 % start of the next paragraph will insert \parskip.
6228 \def\aboveenvbreak{{%
6229 % =10000 instead of <10000 because of a special case in \itemzzz and
6230 % \sectionheading, q.v.
6231 \ifnum \lastpenalty=10000 \else
6232 \advance\envskipamount by \parskip
6234 \ifdim\lastskip<\envskipamount
6236 % it's not a good place to break if the last penalty was \nobreak
6238 \ifnum\lastpenalty<10000 \penalty-50 \fi
6239 \vskip\envskipamount
6244 \let\afterenvbreak = \aboveenvbreak
6246 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6247 % also clear it, so that its embedded environments do the narrowing again.
6248 \let\nonarrowing=\relax
6250 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6251 % environment contents.
6252 \font\circle=lcircle10
6254 \newdimen\cartouter\newdimen\cartinner
6255 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6256 \circthick=\fontdimen8\circle
6258 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6259 \def\ctr{{\hskip 6pt\circle\char'010}}
6260 \def\cbl{{\circle\char'012\hskip -6pt}}
6261 \def\cbr{{\hskip 6pt\circle\char'011}}
6262 \def\carttop{\hbox to \cartouter{\hskip\lskip
6263 \ctl\leaders\hrule height\circthick\hfil\ctr
6265 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6266 \cbl\leaders\hrule height\circthick\hfil\cbr
6269 \newskip\lskip\newskip\rskip
6272 \ifhmode\par\fi % can't be in the midst of a paragraph.
6274 \lskip=\leftskip \rskip=\rightskip
6275 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6276 \cartinner=\hsize \advance\cartinner by-\lskip
6277 \advance\cartinner by-\rskip
6279 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6280 % side, and for 6pt waste from
6281 % each corner char, and rule thickness
6282 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6283 % Flag to tell @lisp, etc., not to narrow margin.
6284 \let\nonarrowing = t%
6286 % If this cartouche directly follows a sectioning command, we need the
6287 % \parskip glue (backspaced over by default) or the cartouche can
6288 % collide with the section heading.
6289 \ifnum\lastpenalty>10000 \vskip\parskip \fi
6292 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6300 \baselineskip=\normbskip
6301 \lineskip=\normlskip
6304 \comment % For explanation, see the end of def\group.
6319 % This macro is called at the beginning of all the @example variants,
6321 \newdimen\nonfillparindent
6324 \hfuzz = 12pt % Don't be fussy
6325 \sepspaces % Make spaces be word-separators rather than space tokens.
6326 \let\par = \lisppar % don't ignore blank lines
6327 \obeylines % each line of input is a line of output
6329 % Turn off paragraph indentation but redefine \indent to emulate
6330 % the normal \indent.
6331 \nonfillparindent=\parindent
6333 \let\indent\nonfillindent
6335 \emergencystretch = 0pt % don't try to avoid overfull boxes
6336 \ifx\nonarrowing\relax
6337 \advance \leftskip by \lispnarrowing
6338 \exdentamount=\lispnarrowing
6340 \let\nonarrowing = \relax
6342 \let\exdent=\nofillexdent
6347 % We want to swallow spaces (but not other tokens) after the fake
6348 % @indent in our nonfill-environments, where spaces are normally
6349 % active and set to @tie, resulting in them not being ignored after
6351 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6352 \gdef\nonfillindentcheck{%
6354 \expandafter\nonfillindentgobble%
6356 \leavevmode\nonfillindentbox%
6360 \def\nonfillindentgobble#1{\nonfillindent}
6361 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6363 % If you want all examples etc. small: @set dispenvsize small.
6364 % If you want even small examples the full size: @set dispenvsize nosmall.
6365 % This affects the following displayed environments:
6366 % @example, @display, @format, @lisp
6368 \def\smallword{small}
6369 \def\nosmallword{nosmall}
6370 \let\SETdispenvsize\relax
6371 \def\setnormaldispenv{%
6372 \ifx\SETdispenvsize\smallword
6373 % end paragraph for sake of leading, in case document has no blank
6374 % line. This is redundant with what happens in \aboveenvbreak, but
6375 % we need to do it before changing the fonts, and it's inconvenient
6376 % to change the fonts afterward.
6377 \ifnum \lastpenalty=10000 \else \endgraf \fi
6378 \smallexamplefonts \rm
6381 \def\setsmalldispenv{%
6382 \ifx\SETdispenvsize\nosmallword
6384 \ifnum \lastpenalty=10000 \else \endgraf \fi
6385 \smallexamplefonts \rm
6389 % We often define two environments, @foo and @smallfoo.
6390 % Let's do it in one command. #1 is the env name, #2 the definition.
6391 \def\makedispenvdef#1#2{%
6392 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6393 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6394 \expandafter\let\csname E#1\endcsname \afterenvbreak
6395 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6398 % Define two environment synonyms (#1 and #2) for an environment.
6399 \def\maketwodispenvdef#1#2#3{%
6400 \makedispenvdef{#1}{#3}%
6401 \makedispenvdef{#2}{#3}%
6404 % @lisp: indented, narrowed, typewriter font;
6405 % @example: same as @lisp.
6407 % @smallexample and @smalllisp: use smaller fonts.
6408 % Originally contributed by Pavel@xerox.
6410 \maketwodispenvdef{lisp}{example}{%
6412 \tt\setupmarkupstyle{example}%
6413 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6414 \gobble % eat return
6416 % @display/@smalldisplay: same as @lisp except keep current font.
6418 \makedispenvdef{display}{%
6423 % @format/@smallformat: same as @display except don't narrow margins.
6425 \makedispenvdef{format}{%
6426 \let\nonarrowing = t%
6431 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6433 \let\nonarrowing = t%
6437 \let\Eflushleft = \afterenvbreak
6441 \envdef\flushright{%
6442 \let\nonarrowing = t%
6444 \advance\leftskip by 0pt plus 1fill\relax
6447 \let\Eflushright = \afterenvbreak
6450 % @raggedright does more-or-less normal line breaking but no right
6451 % justification. From plain.tex.
6452 \envdef\raggedright{%
6453 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6455 \let\Eraggedright\par
6457 \envdef\raggedleft{%
6458 \parindent=0pt \leftskip0pt plus2em
6459 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6460 \hbadness=10000 % Last line will usually be underfull, so turn off
6461 % badness reporting.
6463 \let\Eraggedleft\par
6465 \envdef\raggedcenter{%
6466 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6467 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6468 \hbadness=10000 % Last line will usually be underfull, so turn off
6469 % badness reporting.
6471 \let\Eraggedcenter\par
6474 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6475 % and narrows the margins. We keep \parskip nonzero in general, since
6476 % we're doing normal filling. So, when using \aboveenvbreak and
6477 % \afterenvbreak, temporarily make \parskip 0.
6479 \makedispenvdef{quotation}{\quotationstart}
6481 \def\quotationstart{%
6482 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6485 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6486 \ifx\nonarrowing\relax
6487 \advance\leftskip by \lispnarrowing
6488 \advance\rightskip by \lispnarrowing
6489 \exdentamount = \lispnarrowing
6491 \let\nonarrowing = \relax
6493 \parsearg\quotationlabel
6496 % We have retained a nonzero parskip for the environment, since we're
6497 % doing normal filling.
6501 \ifx\quotationauthor\thisisundefined\else
6503 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6505 {\parskip=0pt \afterenvbreak}%
6507 \def\Esmallquotation{\Equotation}
6509 % If we're given an argument, typeset it in bold with a colon after.
6510 \def\quotationlabel#1{%
6512 \ifx\temp\empty \else
6518 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6519 % If we want to allow any <char> as delimiter,
6520 % we need the curly braces so that makeinfo sees the @verb command, eg:
6521 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6523 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6525 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6526 % active too. Otherwise, they get lost as the first character on a
6529 \do\ \do\\\do\{\do\}\do\$\do\&%
6530 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6531 \do\<\do\>\do\|\do\@\do+\do\"%
6532 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6533 % @set txicodequotebacktick will not have effect on @verb and
6534 % @verbatim, and ?` and !` ligatures won't get disabled.
6539 \def\uncatcodespecials{%
6540 \def\do##1{\catcode`##1=\other}\dospecials}
6542 % Setup for the @verb command.
6544 % Eight spaces for a tab
6546 \catcode`\^^I=\active
6547 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6551 \tt % easiest (and conventionally used) font for verbatim
6552 \def\par{\leavevmode\endgraf}%
6553 \setupmarkupstyle{verb}%
6555 % Respect line breaks,
6556 % print special symbols as themselves, and
6557 % make each space count
6558 % must do in this order:
6559 \obeylines \uncatcodespecials \sepspaces
6562 % Setup for the @verbatim environment
6564 % Real tab expansion.
6565 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6567 % We typeset each line of the verbatim in an \hbox, so we can handle
6568 % tabs. The \global is in case the verbatim line starts with an accent,
6569 % or some other command that starts with a begin-group. Otherwise, the
6570 % entire \verbbox would disappear at the corresponding end-group, before
6571 % it is typeset. Meanwhile, we can't have nested verbatim commands
6572 % (can we?), so the \global won't be overwriting itself.
6574 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6577 \catcode`\^^I=\active
6579 \catcode`\^^I=\active
6580 \def^^I{\leavevmode\egroup
6581 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6582 \divide\dimen\verbbox by\tabw
6583 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6584 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6585 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6590 % start the verbatim environment.
6591 \def\setupverbatim{%
6592 \let\nonarrowing = t%
6594 \tt % easiest (and conventionally used) font for verbatim
6595 % The \leavevmode here is for blank lines. Otherwise, we would
6596 % never \starttabox and the \egroup would end verbatim mode.
6597 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6599 \setupmarkupstyle{verbatim}%
6600 % Respect line breaks,
6601 % print special symbols as themselves, and
6602 % make each space count.
6603 % Must do in this order:
6604 \obeylines \uncatcodespecials \sepspaces
6605 \everypar{\starttabbox}%
6608 % Do the @verb magic: verbatim text is quoted by unique
6609 % delimiter characters. Before first delimiter expect a
6610 % right brace, after last delimiter expect closing brace:
6612 % \def\doverb'{'<char>#1<char>'}'{#1}
6614 % [Knuth] p. 382; only eat outer {}
6616 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6617 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6620 \def\verb{\begingroup\setupverb\doverb}
6623 % Do the @verbatim magic: define the macro \doverbatim so that
6624 % the (first) argument ends when '@end verbatim' is reached, ie:
6626 % \def\doverbatim#1@end verbatim{#1}
6628 % For Texinfo it's a lot easier than for LaTeX,
6629 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6630 % we need not redefine '\', '{' and '}'.
6632 % Inspired by LaTeX's verbatim command set [latex.ltx]
6637 % ignore everything up to the first ^^M, that's the newline at the end
6638 % of the @verbatim input line itself. Otherwise we get an extra blank
6639 % line in the output.
6640 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6641 % We really want {...\end verbatim} in the body of the macro, but
6642 % without the active space; thus we have to use \xdef and \gobble.
6646 \setupverbatim\doverbatim
6648 \let\Everbatim = \afterenvbreak
6651 % @verbatiminclude FILE - insert text of file in verbatim environment.
6653 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6655 \def\doverbatiminclude#1{%
6657 \makevalueexpandable
6659 \indexnofonts % Allow `@@' and other weird things in file names.
6660 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6666 % @copying ... @end copying.
6667 % Save the text away for @insertcopying later.
6669 % We save the uninterpreted tokens, rather than creating a box.
6670 % Saving the text in a box would be much easier, but then all the
6671 % typesetting commands (@smallbook, font changes, etc.) have to be done
6672 % beforehand -- and a) we want @copying to be done first in the source
6673 % file; b) letting users define the frontmatter in as flexible order as
6674 % possible is very desirable.
6676 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6677 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6679 \def\insertcopying{%
6681 \parindent = 0pt % paragraph indentation looks wrong on title page
6682 \scanexp\copyingtext
6690 \newskip\defbodyindent \defbodyindent=.4in
6691 \newskip\defargsindent \defargsindent=50pt
6692 \newskip\deflastargmargin \deflastargmargin=18pt
6693 \newcount\defunpenalty
6695 % Start the processing of @deffn:
6697 \ifnum\lastpenalty<10000
6699 \defunpenalty=10003 % Will keep this @deffn together with the
6700 % following @def command, see below.
6702 % If there are two @def commands in a row, we'll have a \nobreak,
6703 % which is there to keep the function description together with its
6704 % header. But if there's nothing but headers, we need to allow a
6705 % break somewhere. Check specifically for penalty 10002, inserted
6706 % by \printdefunline, instead of 10000, since the sectioning
6707 % commands also insert a nobreak penalty, and we don't want to allow
6708 % a break between a section heading and a defun.
6710 % As a further refinement, we avoid "club" headers by signalling
6711 % with penalty of 10003 after the very first @deffn in the
6712 % sequence (see above), and penalty of 10002 after any following
6714 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6716 % Similarly, after a section heading, do not allow a break.
6717 % But do insert the glue.
6718 \medskip % preceded by discardable penalty, so not a breakpoint
6722 \advance\leftskip by \defbodyindent
6723 \exdentamount=\defbodyindent
6727 % First, check whether we are in the right environment:
6730 % As above, allow line break if we have multiple x headers in a row.
6731 % It's not a great place, though.
6732 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6734 % And now, it's time to reuse the body of the original defun:
6735 \expandafter\gobbledefun#1%
6737 \def\gobbledefun#1\startdefun{}
6739 % \printdefunline \deffnheader{text}
6741 \def\printdefunline#1#2{%
6743 % call \deffnheader:
6746 \interlinepenalty = 10000
6747 \advance\rightskip by 0pt plus 1fil\relax
6749 \nobreak\vskip -\parskip
6750 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6751 % Some of the @defun-type tags do not enable magic parentheses,
6752 % rendering the following check redundant. But we don't optimize.
6757 \def\Edefun{\endgraf\medbreak}
6759 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6760 % the only thing remaining is to define \deffnheader.
6763 \expandafter\let\csname E#1\endcsname = \Edefun
6764 \edef\temp{\noexpand\domakedefun
6765 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6769 % \domakedefun \deffn \deffnx \deffnheader
6771 % Define \deffn and \deffnx, without parameters.
6772 % \deffnheader has to be defined explicitly.
6774 \def\domakedefun#1#2#3{%
6777 \doingtypefnfalse % distinguish typed functions from all else
6778 \parseargusing\activeparens{\printdefunline#3}%
6780 \def#2{\dodefunx#1}%
6784 \newif\ifdoingtypefn % doing typed function?
6785 \newif\ifrettypeownline % typeset return type on its own line?
6787 % @deftypefnnewline on|off says whether the return type of typed functions
6788 % are printed on their own line. This affects @deftypefn, @deftypefun,
6789 % @deftypeop, and @deftypemethod.
6791 \parseargdef\deftypefnnewline{%
6794 \expandafter\let\csname SETtxideftypefnnl\endcsname
6796 \else\ifx\temp\offword
6797 \expandafter\let\csname SETtxideftypefnnl\endcsname
6800 \errhelp = \EMsimple
6801 \errmessage{Unknown @txideftypefnnl value `\temp',
6806 % Untyped functions:
6808 % @deffn category name args
6809 \makedefun{deffn}{\deffngeneral{}}
6811 % @deffn category class name args
6812 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6814 % \defopon {category on}class name args
6815 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6817 % \deffngeneral {subind}category name args
6819 \def\deffngeneral#1#2 #3 #4\endheader{%
6820 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6821 \dosubind{fn}{\code{#3}}{#1}%
6822 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6827 % @deftypefn category type name args
6828 \makedefun{deftypefn}{\deftypefngeneral{}}
6830 % @deftypeop category class type name args
6831 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6833 % \deftypeopon {category on}class type name args
6834 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6836 % \deftypefngeneral {subind}category type name args
6838 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6839 \dosubind{fn}{\code{#4}}{#1}%
6841 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6846 % @deftypevr category type var args
6847 \makedefun{deftypevr}{\deftypecvgeneral{}}
6849 % @deftypecv category class type var args
6850 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6852 % \deftypecvof {category of}class type var args
6853 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6855 % \deftypecvgeneral {subind}category type var args
6857 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6858 \dosubind{vr}{\code{#4}}{#1}%
6859 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6862 % Untyped variables:
6864 % @defvr category var args
6865 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6867 % @defcv category class var args
6868 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6870 % \defcvof {category of}class var args
6871 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6875 % @deftp category name args
6876 \makedefun{deftp}#1 #2 #3\endheader{%
6877 \doind{tp}{\code{#2}}%
6878 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6881 % Remaining @defun-like shortcuts:
6882 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6883 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6884 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6885 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6886 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6887 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6888 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6889 \makedefun{defmethod}{\defopon\putwordMethodon}
6890 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6891 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6892 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6894 % \defname, which formats the name of the @def (not the args).
6895 % #1 is the category, such as "Function".
6896 % #2 is the return type, if any.
6897 % #3 is the function name.
6899 % We are followed by (but not passed) the arguments, if any.
6901 \def\defname#1#2#3{%
6903 % Get the values of \leftskip and \rightskip as they were outside the @def...
6904 \advance\leftskip by -\defbodyindent
6906 % Determine if we are typesetting the return type of a typed function
6907 % on a line by itself.
6908 \rettypeownlinefalse
6909 \ifdoingtypefn % doing a typed function specifically?
6910 % then check user option for putting return type on its own line:
6911 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6916 % How we'll format the category name. Putting it in brackets helps
6917 % distinguish it from the body text that may end up on the next line
6920 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6922 % Figure out line sizes for the paragraph shape. We'll always have at
6926 % The first line needs space for \box0; but if \rightskip is nonzero,
6927 % we need only space for the part of \box0 which exceeds it:
6928 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6930 % If doing a return type on its own line, we'll have another line.
6932 \advance\tempnum by 1
6933 \def\maybeshapeline{0in \hsize}%
6935 \def\maybeshapeline{}%
6938 % The continuations:
6939 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6941 % The final paragraph shape:
6942 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
6944 % Put the category name at the right margin.
6947 \hfil\box0 \kern-\hsize
6948 % \hsize has to be shortened this way:
6950 % Intentionally do not respect \rightskip, since we need the space.
6953 % Allow all lines to be underfull without complaint:
6954 \tolerance=10000 \hbadness=10000
6955 \exdentamount=\defbodyindent
6957 % defun fonts. We use typewriter by default (used to be bold) because:
6958 % . we're printing identifiers, they should be in tt in principle.
6959 % . in languages with many accents, such as Czech or French, it's
6960 % common to leave accents off identifiers. The result looks ok in
6961 % tt, but exceedingly strange in rm.
6962 % . we don't want -- and --- to be treated as ligatures.
6963 % . this still does not fix the ?` and !` ligatures, but so far no
6964 % one has made identifiers using them :).
6966 \def\temp{#2}% text of the return type
6967 \ifx\temp\empty\else
6968 \tclose{\temp}% typeset the return type
6970 % put return type on its own line; prohibit line break following:
6971 \hfil\vadjust{\nobreak}\break
6973 \space % type on same line, so just followed by a space
6975 \fi % no return type
6976 #3% output function name
6978 {\rm\enskip}% hskip 0.5 em of \tenrm
6981 % arguments will be output next, if any.
6984 % Print arguments in slanted roman (not ttsl), inconsistently with using
6985 % tt for the name. This is because literal text is sometimes needed in
6986 % the argument list (groff manual), and ttsl and tt are not very
6987 % distinguishable. Prevent hyphenation at `-' chars.
6990 % use sl by default (not ttsl),
6992 \df \sl \hyphenchar\font=0
6994 % On the other hand, if an argument has two dashes (for instance), we
6995 % want a way to get ttsl. Let's try @var for that.
6996 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6998 \sl\hyphenchar\font=45
7001 % We want ()&[] to print specially on the defun line.
7004 \catcode`\(=\active \catcode`\)=\active
7005 \catcode`\[=\active \catcode`\]=\active
7009 % Make control sequences which act like normal parenthesis chars.
7010 \let\lparen = ( \let\rparen = )
7012 % Be sure that we always have a definition for `(', etc. For example,
7013 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7014 % so TeX would otherwise complain about undefined control sequence.
7017 \global\let(=\lparen \global\let)=\rparen
7018 \global\let[=\lbrack \global\let]=\rbrack
7021 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7022 \gdef\magicamp{\let&=\amprm}
7025 \newcount\parencount
7027 % If we encounter &foo, then turn on ()-hacking afterwards
7029 \def\amprm#1 {\ampseentrue{\bf\ }}
7033 % At the first level, print parens in roman,
7034 % otherwise use the default font.
7035 \ifnum \parencount=1 \rm \fi
7037 % The \sf parens (in \boldbrax) actually are a little bolder than
7038 % the contained text. This is especially needed for [ and ] .
7042 \def\infirstlevel#1{%
7049 \def\bfafterword#1 {#1 \bf}
7052 \global\advance\parencount by 1
7054 \infirstlevel \bfafterword
7059 \global\advance\parencount by -1
7062 \newcount\brackcount
7064 \global\advance\brackcount by 1
7069 \global\advance\brackcount by -1
7072 \def\checkparencounts{%
7073 \ifnum\parencount=0 \else \badparencount \fi
7074 \ifnum\brackcount=0 \else \badbrackcount \fi
7076 % these should not use \errmessage; the glibc manual, at least, actually
7077 % has such constructs (when documenting function pointers).
7078 \def\badparencount{%
7079 \message{Warning: unbalanced parentheses in @def...}%
7080 \global\parencount=0
7082 \def\badbrackcount{%
7083 \message{Warning: unbalanced square brackets in @def...}%
7084 \global\brackcount=0
7091 % To do this right we need a feature of e-TeX, \scantokens,
7092 % which we arrange to emulate with a temporary file in ordinary TeX.
7093 \ifx\eTeXversion\thisisundefined
7094 \newwrite\macscribble
7097 \immediate\openout\macscribble=\jobname.tmp
7098 \immediate\write\macscribble{\the\toks0}%
7099 \immediate\closeout\macscribble
7104 \def\scanmacro#1{\begingroup
7106 \let\xeatspaces\eatspaces
7108 % Undo catcode changes of \startcontents and \doprintindex
7109 % When called from @insertcopying or (short)caption, we need active
7110 % backslash to get it printed correctly. Previously, we had
7111 % \catcode`\\=\other instead. We'll see whether a problem appears
7112 % with macro expansion. --kasal, 19aug04
7113 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7115 % ... and for \example:
7118 % The \empty here causes a following catcode 5 newline to be eaten as
7119 % part of reading whitespace after a control sequence. It does not
7120 % eat a catcode 13 newline. There's no good way to handle the two
7121 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7122 % would then have different behavior). See the Macro Details node in
7123 % the manual for the workaround we recommend for macros and
7124 % line-oriented commands.
7126 \scantokens{#1\empty}%
7130 \edef\temp{\noexpand\scanmacro{#1}}%
7134 \newcount\paramno % Count of parameters
7135 \newtoks\macname % Macro name
7136 \newif\ifrecursive % Is it recursive?
7138 % List of all defined macros in the form
7139 % \definedummyword\macro1\definedummyword\macro2...
7140 % Currently is also contains all @aliases; the list can be split
7141 % if there is a need.
7144 % Add the macro to \macrolist
7145 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7146 \def\addtomacrolistxxx#1{%
7147 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7148 \xdef\macrolist{\the\toks0}%
7152 % This does \let #1 = #2, with \csnames; that is,
7153 % \let \csname#1\endcsname = \csname#2\endcsname
7154 % (except of course we have to play expansion games).
7158 \csname#1\expandafter\endcsname
7162 % Trim leading and trailing spaces off a string.
7163 % Concepts from aro-bend problem 15 (see CTAN).
7165 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7166 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7167 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7169 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7172 % Trim a single trailing ^^M off a string.
7173 {\catcode`\^^M=\other \catcode`\Q=3%
7174 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7175 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7176 \gdef\eatcrb#1Q#2Q{#1}%
7179 % Macro bodies are absorbed as an argument in a context where
7180 % all characters are catcode 10, 11 or 12, except \ which is active
7181 % (as in normal texinfo). It is necessary to change the definition of \
7182 % to recognize macro arguments; this is the job of \mbodybackslash.
7184 % Non-ASCII encodings make 8-bit characters active, so un-activate
7185 % them to avoid their expansion. Must do this non-globally, to
7186 % confine the change to the current group.
7188 % It's necessary to have hard CRs when the macro is executed. This is
7189 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7190 % body, and then making it the \newlinechar in \scanmacro.
7192 \def\scanctxt{% used as subroutine
7202 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7205 \def\scanargctxt{% used for copying and captions, not macros.
7208 \catcode`\^^M=\other
7211 \def\macrobodyctxt{% used for @macro definitions
7215 \catcode`\^^M=\other
7219 \def\macroargctxt{% used when scanning invocations
7223 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7224 % for the single characters \ { }. Thus, we end up with the "commands"
7225 % that would be written @\ @{ @} in a Texinfo document.
7227 % We already have @{ and @}. For @\, we define it here, and only for
7228 % this purpose, to produce a typewriter backslash (so, the @\ that we
7229 % define for @math can't be used with @macro calls):
7231 \def\\{\normalbackslash}%
7233 % We would like to do this for \, too, since that is what makeinfo does.
7234 % But it is not possible, because Texinfo already has a command @, for a
7235 % cedilla accent. Documents must use @comma{} instead.
7237 % \anythingelse will almost certainly be an error of some kind.
7240 % \mbodybackslash is the definition of \ in @macro bodies.
7241 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7242 % where N is the macro parameter number.
7243 % We define \csname macarg.\endcsname to be \realbackslash, so
7244 % \\ in macro replacement text gets you a backslash.
7246 {\catcode`@=0 @catcode`@\=@active
7247 @gdef@usembodybackslash{@let\=@mbodybackslash}
7248 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7250 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7252 \def\margbackslash#1{\char`\#1 }
7254 \def\macro{\recursivefalse\parsearg\macroxxx}
7255 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7258 \getargs{#1}% now \macname is the macname and \argl the arglist
7259 \ifx\argl\empty % no arguments
7262 \expandafter\parsemargdef \argl;%
7263 \if\paramno>256\relax
7264 \ifx\eTeXversion\thisisundefined
7265 \errhelp = \EMsimple
7266 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7270 \if1\csname ismacro.\the\macname\endcsname
7271 \message{Warning: redefining \the\macname}%
7273 \expandafter\ifx\csname \the\macname\endcsname \relax
7274 \else \errmessage{Macro name \the\macname\space already defined}\fi
7275 \global\cslet{macsave.\the\macname}{\the\macname}%
7276 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7277 \addtomacrolist{\the\macname}%
7279 \begingroup \macrobodyctxt
7280 \ifrecursive \expandafter\parsermacbody
7281 \else \expandafter\parsemacbody
7284 \parseargdef\unmacro{%
7285 \if1\csname ismacro.#1\endcsname
7286 \global\cslet{#1}{macsave.#1}%
7287 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7288 % Remove the macro name from \macrolist:
7290 \expandafter\let\csname#1\endcsname \relax
7291 \let\definedummyword\unmacrodo
7292 \xdef\macrolist{\macrolist}%
7295 \errmessage{Macro #1 not defined}%
7299 % Called by \do from \dounmacro on each macro. The idea is to omit any
7300 % macro definitions that have been changed to \relax.
7306 \noexpand\definedummyword \noexpand#1%
7310 % This makes use of the obscure feature that if the last token of a
7311 % <parameter list> is #, then the preceding argument is delimited by
7312 % an opening brace, and that opening brace is not consumed.
7313 \def\getargs#1{\getargsxxx#1{}}
7314 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7315 \def\getmacname#1 #2\relax{\macname={#1}}
7316 \def\getmacargs#1{\def\argl{#1}}
7318 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7319 \edef\texiatcatcode{\the\catcode`\@}
7320 \catcode `@=11\relax
7322 % Parse the optional {params} list. Set up \paramno and \paramlist
7323 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7324 % in the params list to some hook where the argument si to be expanded. If
7325 % there are less than 10 arguments that hook is to be replaced by ##N where N
7326 % is the position in that list, that is to say the macro arguments are to be
7327 % defined `a la TeX in the macro body.
7329 % That gets used by \mbodybackslash (above).
7331 % We need to get `macro parameter char #' into several definitions.
7332 % The technique used is stolen from LaTeX: let \hash be something
7333 % unexpandable, insert that wherever you need a #, and then redefine
7334 % it to # just before using the token list produced.
7336 % The same technique is used to protect \eatspaces till just before
7337 % the macro is used.
7339 % If there are 10 or more arguments, a different technique is used, where the
7340 % hook remains in the body, and when macro is to be expanded the body is
7341 % processed again to replace the arguments.
7343 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7344 % argument N value and then \edef the body (nothing else will expand because of
7345 % the catcode regime underwhich the body was input).
7347 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7348 % arguments, you need that no macro has more than 256 arguments, otherwise an
7349 % error is produced.
7350 \def\parsemargdef#1;{%
7351 \paramno=0\def\paramlist{}%
7353 \let\xeatspaces\relax
7354 \parsemargdefxxx#1,;,%
7355 % In case that there are 10 or more arguments we parse again the arguments
7356 % list to set new definitions for the \macarg.BLAH macros corresponding to
7357 % each BLAH argument. It was anyhow needed to parse already once this list
7358 % in order to count the arguments, and as macros with at most 9 arguments
7359 % are by far more frequent than macro with 10 or more arguments, defining
7360 % twice the \macarg.BLAH macros does not cost too much processing power.
7361 \ifnum\paramno<10\relax\else
7363 \parsemmanyargdef@@#1,;,% 10 or more arguments
7366 \def\parsemargdefxxx#1,{%
7367 \if#1;\let\next=\relax
7368 \else \let\next=\parsemargdefxxx
7369 \advance\paramno by 1
7370 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7371 {\xeatspaces{\hash\the\paramno}}%
7372 \edef\paramlist{\paramlist\hash\the\paramno,}%
7375 \def\parsemmanyargdef@@#1,{%
7376 \if#1;\let\next=\relax
7378 \let\next=\parsemmanyargdef@@
7379 \edef\tempb{\eatspaces{#1}}%
7380 \expandafter\def\expandafter\tempa
7381 \expandafter{\csname macarg.\tempb\endcsname}%
7382 % Note that we need some extra \noexpand\noexpand, this is because we
7383 % don't want \the to be expanded in the \parsermacbody as it uses an
7385 \expandafter\edef\tempa
7386 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7387 \advance\paramno by 1\relax
7390 % These two commands read recursive and nonrecursive macro bodies.
7391 % (They're different since rec and nonrec macros end differently.)
7394 \catcode `\@\texiatcatcode
7395 \long\def\parsemacbody#1@end macro%
7396 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7397 \long\def\parsermacbody#1@end rmacro%
7398 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7399 \catcode `\@=11\relax
7404 \long\def\nillm@{\nil@}%
7406 % This macro is expanded during the Texinfo macro expansion, not during its
7407 % definition. It gets all the arguments values and assigns them to macros
7410 % #1 is the macro name
7411 % #2 is the list of argument names
7412 % #3 is the list of argument values
7413 \def\getargvals@#1#2#3{%
7414 \def\macargdeflist@{}%
7415 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7416 \def\paramlist{#2,\nil@}%
7420 \def\argvaluelist{#3,\nil@}%
7431 \ifx\paramlist\nilm@
7432 % Some sanity check needed here that \argvaluelist is also empty.
7433 \ifx\argvaluelist\nillm@
7435 \errhelp = \EMsimple
7436 \errmessage{Too many arguments in macro `\macroname'!}%
7438 \let\next\macargexpandinbody@
7440 \ifx\argvaluelist\nillm@
7441 % No more arguments values passed to macro. Set remaining named-arg
7443 \let\next\setemptyargvalues@
7445 % pop current arg name into \@tempb
7446 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7447 \expandafter\@tempa\expandafter{\paramlist}%
7448 % pop current argument value into \@tempc
7449 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7450 \expandafter\@tempa\expandafter{\argvaluelist}%
7451 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7452 % First place the new argument macro definition into \@tempd
7453 \expandafter\macname\expandafter{\@tempc}%
7454 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7455 \expandafter\def\expandafter\@tempe\expandafter{%
7456 \csname macarg.\@tempb\endcsname}%
7457 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7458 \push@\@tempd\macargdeflist@
7459 \let\next\getargvals@@
7466 \expandafter\expandafter\expandafter\def
7467 \expandafter\expandafter\expandafter#2%
7468 \expandafter\expandafter\expandafter{%
7472 % Replace arguments by their values in the macro body, and place the result
7474 \def\macvalstoargs@{%
7475 % To do this we use the property that token registers that are \the'ed
7476 % within an \edef expand only once. So we are going to place all argument
7477 % values into respective token registers.
7479 % First we save the token context, and initialize argument numbering.
7482 % Then, for each argument number #N, we place the corresponding argument
7483 % value into a new token list register \toks#N
7484 \expandafter\putargsintokens@\saveparamlist@,;,%
7485 % Then, we expand the body so that argument are replaced by their
7486 % values. The trick for values not to be expanded themselves is that they
7487 % are within tokens and that tokens expand only once in an \edef .
7488 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7489 % Now we restore the token stack pointer to free the token list registers
7490 % which we have used, but we make sure that expanded body is saved after
7494 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7497 \def\macargexpandinbody@{%
7498 %% Define the named-macro outside of this group and then close this group.
7502 % First the replace in body the macro arguments by their values, the result
7505 % Then we point at the \norecurse or \gobble (for recursive) macro value
7507 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7508 % Depending on whether it is recursive or not, we need some tailing
7515 % And now we do the real job:
7516 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7520 \def\putargsintokens@#1,{%
7521 \if#1;\let\next\relax
7523 \let\next\putargsintokens@
7524 % First we allocate the new token list register, and give it a temporary
7526 \toksdef\@tempb\the\paramno
7527 % Then we place the argument value into that token list register.
7528 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7529 \expandafter\@tempb\expandafter{\@tempa}%
7530 \advance\paramno by 1\relax
7535 % Save the token stack pointer into macro #1
7536 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7537 % Restore the token stack pointer from number in macro #1
7538 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7539 % newtoks that can be used non \outer .
7540 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7542 % Tailing missing arguments are set to empty
7543 \def\setemptyargvalues@{%
7544 \ifx\paramlist\nilm@
7545 \let\next\macargexpandinbody@
7547 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7548 \let\next\setemptyargvalues@
7553 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7554 \expandafter\def\expandafter\@tempa\expandafter{%
7555 \expandafter\def\csname macarg.#1\endcsname{}}%
7556 \push@\@tempa\macargdeflist@
7560 % #1 is the element target macro
7561 % #2 is the list macro
7562 % #3,#4\endargs@ is the list value
7563 \def\pop@#1#2#3,#4\endargs@{%
7567 \long\def\longpop@#1#2#3,#4\endargs@{%
7572 % This defines a Texinfo @macro. There are eight cases: recursive and
7573 % nonrecursive macros of zero, one, up to nine, and many arguments.
7574 % Much magic with \expandafter here.
7575 % \xdef is used so that macro definitions will survive the file
7576 % they're defined in; @include reads the file inside a group.
7579 \let\hash=##% convert placeholders to macro parameter chars
7583 \expandafter\xdef\csname\the\macname\endcsname{%
7584 \noexpand\scanmacro{\temp}}%
7586 \expandafter\xdef\csname\the\macname\endcsname{%
7587 \bgroup\noexpand\macroargctxt
7588 \noexpand\braceorline
7589 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7590 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7591 \egroup\noexpand\scanmacro{\temp}}%
7593 \ifnum\paramno<10\relax % at most 9
7594 \expandafter\xdef\csname\the\macname\endcsname{%
7595 \bgroup\noexpand\macroargctxt
7596 \noexpand\csname\the\macname xx\endcsname}%
7597 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7598 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7599 \expandafter\expandafter
7601 \expandafter\expandafter
7602 \csname\the\macname xxx\endcsname
7603 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7605 \expandafter\xdef\csname\the\macname\endcsname{%
7606 \noexpand\getargvals@{\the\macname}{\argl}%
7608 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7609 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7615 \expandafter\xdef\csname\the\macname\endcsname{%
7616 \noexpand\norecurse{\the\macname}%
7617 \noexpand\scanmacro{\temp}\egroup}%
7619 \expandafter\xdef\csname\the\macname\endcsname{%
7620 \bgroup\noexpand\macroargctxt
7621 \noexpand\braceorline
7622 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7623 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7625 \noexpand\norecurse{\the\macname}%
7626 \noexpand\scanmacro{\temp}\egroup}%
7628 \ifnum\paramno<10\relax
7629 \expandafter\xdef\csname\the\macname\endcsname{%
7630 \bgroup\noexpand\macroargctxt
7631 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7632 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7633 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7634 \expandafter\expandafter
7636 \expandafter\expandafter
7637 \csname\the\macname xxx\endcsname
7640 \noexpand\norecurse{\the\macname}%
7641 \noexpand\scanmacro{\temp}\egroup}%
7643 \expandafter\xdef\csname\the\macname\endcsname{%
7644 \noexpand\getargvals@{\the\macname}{\argl}%
7646 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7647 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7652 \catcode `\@\texiatcatcode\relax
7654 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7656 % \braceorline decides whether the next nonwhitespace character is a
7657 % {. If so it reads up to the closing }, if not, it reads the whole
7658 % line. Whatever was read is then fed to the next control sequence
7659 % as an argument (by \parsebrace or \parsearg).
7661 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7662 \def\braceorlinexxx{%
7663 \ifx\nchar\bgroup\else
7664 \expandafter\parsearg
7669 % We need some trickery to remove the optional spaces around the equal
7670 % sign. Make them active and then expand them all to nothing.
7672 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7673 \def\aliasxxx #1{\aliasyyy#1\relax}
7674 \def\aliasyyy #1=#2\relax{%
7676 \expandafter\let\obeyedspace=\empty
7677 \addtomacrolist{#1}%
7678 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7684 \message{cross references,}
7687 \newif\ifhavexrefs % True if xref values are known.
7688 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7690 % @inforef is relatively simple.
7691 \def\inforef #1{\inforefzzz #1,,,,**}
7692 \def\inforefzzz #1,#2,#3,#4**{%
7693 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7694 node \samp{\ignorespaces#1{}}}
7696 % @node's only job in TeX is to define \lastnode, which is used in
7697 % cross-references. The @node line might or might not have commas, and
7698 % might or might not have spaces before the first comma, like:
7699 % @node foo , bar , ...
7700 % We don't want such trailing spaces in the node name.
7702 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7704 % also remove a trailing comma, in case of something like this:
7705 % @node Help-Cross, , , Cross-refs
7706 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7707 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7710 \let\lastnode=\empty
7712 % Write a cross-reference definition for the current node. #1 is the
7713 % type (Ynumbered, Yappendix, Ynothing).
7716 \ifx\lastnode\empty\else
7717 \setref{\lastnode}{#1}%
7718 \global\let\lastnode=\empty
7722 % @anchor{NAME} -- define xref target at arbitrary point.
7724 \newcount\savesfregister
7726 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7727 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7728 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7730 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7731 % anchor), which consists of three parts:
7732 % 1) NAME-title - the current sectioning name taken from \lastsection,
7733 % or the anchor name.
7734 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7735 % empty for anchors.
7736 % 3) NAME-pg - the page number.
7738 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7739 % floats, there is an additional part, which is not written here:
7740 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7746 \atdummies % preserve commands, but don't expand them
7747 \edef\writexrdef##1##2{%
7748 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7749 ##1}{##2}}% these are parameters of \writexrdef
7751 \toks0 = \expandafter{\lastsection}%
7752 \immediate \writexrdef{title}{\the\toks0 }%
7753 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7754 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7759 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7760 % automatically in xrefs, if the third arg is not explicitly specified.
7761 % This was provided as a "secret" @set xref-automatic-section-title
7762 % variable, now it's official.
7764 \parseargdef\xrefautomaticsectiontitle{%
7767 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7769 \else\ifx\temp\offword
7770 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7773 \errhelp = \EMsimple
7774 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7780 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7781 % the node name, #2 the name of the Info cross-reference, #3 the printed
7782 % node name, #4 the name of the Info file, #5 the name of the printed
7783 % manual. All but the node name can be omitted.
7785 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7786 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7787 \def\ref#1{\xrefX[#1,,,,,,,]}
7788 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7790 \def\printedmanual{\ignorespaces #5}%
7791 \def\printedrefname{\ignorespaces #3}%
7792 \setbox1=\hbox{\printedmanual\unskip}%
7793 \setbox0=\hbox{\printedrefname\unskip}%
7795 % No printed node name was explicitly given.
7796 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7797 % Use the node name inside the square brackets.
7798 \def\printedrefname{\ignorespaces #1}%
7800 % Use the actual chapter/section title appear inside
7801 % the square brackets. Use the real section title if we have it.
7803 % It is in another manual, so we don't have it.
7804 \def\printedrefname{\ignorespaces #1}%
7807 % We know the real title if we have the xref values.
7808 \def\printedrefname{\refx{#1-title}{}}%
7810 % Otherwise just copy the Info node name.
7811 \def\printedrefname{\ignorespaces #1}%
7817 % Make link in pdf output.
7821 % This expands tokens, so do it after making catcode changes, so _
7822 % etc. don't get their TeX definitions.
7825 % See comments at \activebackslashdouble.
7826 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7827 \backslashparens\pdfxrefdest}%
7830 \startlink attr{/Border [0 0 0]}%
7831 \ifnum\filenamelength>0
7832 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7834 goto name{\pdfmkpgn{\pdfxrefdest}}%
7837 \setcolor{\linkcolor}%
7840 % Float references are printed completely differently: "Figure 1.2"
7841 % instead of "[somenode], p.3". We distinguish them by the
7842 % LABEL-title being set to a magic string.
7844 % Have to otherify everything special to allow the \csname to
7845 % include an _ in the xref name, etc.
7848 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7849 \csname XR#1-title\endcsname
7851 \iffloat\Xthisreftitle
7852 % If the user specified the print name (third arg) to the ref,
7853 % print it instead of our usual "Figure 1.2".
7860 % if the user also gave the printed manual name (fifth arg), append
7863 \space \putwordin{} \cite{\printedmanual}%
7866 % node/anchor (non-float) references.
7868 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7869 % insert empty discretionaries after hyphens, which means that it will
7870 % not find a line break at a hyphen in a node names. Since some manuals
7871 % are best written with fairly long node names, containing hyphens, this
7872 % is a loss. Therefore, we give the text of the node name again, so it
7873 % is as if TeX is seeing it for the first time.
7875 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7877 % _ (for example) has to be the character _ for the purposes of the
7878 % control sequence corresponding to the node, but it has to expand
7879 % into the usual \leavevmode...\vrule stuff for purposes of
7880 % printing. So we \turnoffactive for the \refx-snt, back on for the
7881 % printing, back off for the \refx-pg.
7883 % Only output a following space if the -snt ref is nonempty; for
7884 % @unnumbered and @anchor, it won't be.
7885 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7886 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7888 % output the `[mynode]' via a macro so it can be overridden.
7889 \xrefprintnodename\printedrefname
7891 % But we always want a comma and a space:
7894 % output the `page 3'.
7895 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7901 % This macro is called from \xrefX for the `[nodename]' part of xref
7902 % output. It's a separate macro only so it can be changed more easily,
7903 % since square brackets don't work well in some documents. Particularly
7904 % one that Bob is working on :).
7906 \def\xrefprintnodename#1{[#1]}
7908 % Things referred to by \setref.
7914 \putwordChapter@tie \the\chapno
7915 \else \ifnum\subsecno=0
7916 \putwordSection@tie \the\chapno.\the\secno
7917 \else \ifnum\subsubsecno=0
7918 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7920 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7925 \putwordAppendix@tie @char\the\appendixno{}%
7926 \else \ifnum\subsecno=0
7927 \putwordSection@tie @char\the\appendixno.\the\secno
7928 \else \ifnum\subsubsecno=0
7929 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7932 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7936 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7937 % If its value is nonempty, SUFFIX is output afterward.
7943 \expandafter\global\expandafter\let\expandafter\thisrefX
7944 \csname XR#1\endcsname
7947 % If not defined, say something at least.
7948 \angleleft un\-de\-fined\angleright
7951 {\toks0 = {#1}% avoid expansion of possibly-complex value
7952 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
7955 \global\warnedxrefstrue
7956 \message{Cross reference values unknown; you must run TeX again.}%
7961 % It's defined, so just use it.
7964 #2% Output the suffix in any case.
7967 % This is the macro invoked by entries in the aux file. Usually it's
7968 % just a \def (we prepend XR to the control sequence name to avoid
7969 % collisions). But if this is a float type, we have more work to do.
7972 {% The node name might contain 8-bit characters, which in our current
7973 % implementation are changed to commands like @'e. Don't let these
7974 % mess up the control sequence name.
7977 \xdef\safexrefname{#1}%
7980 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7982 % Was that xref control sequence that we just defined for a float?
7983 \expandafter\iffloat\csname XR\safexrefname\endcsname
7984 % it was a float, and we have the (safe) float type in \iffloattype.
7985 \expandafter\let\expandafter\floatlist
7986 \csname floatlist\iffloattype\endcsname
7988 % Is this the first time we've seen this float type?
7989 \expandafter\ifx\floatlist\relax
7990 \toks0 = {\do}% yes, so just \do
7992 % had it before, so preserve previous elements in list.
7993 \toks0 = \expandafter{\floatlist\do}%
7996 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7997 % for later use in \listoffloats.
7998 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8003 % Read the last existing aux file, if any. No error if none exists.
8006 \openin 1 \jobname.aux
8009 \global\havexrefstrue
8014 \def\setupdatafile{%
8015 \catcode`\^^@=\other
8016 \catcode`\^^A=\other
8017 \catcode`\^^B=\other
8018 \catcode`\^^C=\other
8019 \catcode`\^^D=\other
8020 \catcode`\^^E=\other
8021 \catcode`\^^F=\other
8022 \catcode`\^^G=\other
8023 \catcode`\^^H=\other
8024 \catcode`\^^K=\other
8025 \catcode`\^^L=\other
8026 \catcode`\^^N=\other
8027 \catcode`\^^P=\other
8028 \catcode`\^^Q=\other
8029 \catcode`\^^R=\other
8030 \catcode`\^^S=\other
8031 \catcode`\^^T=\other
8032 \catcode`\^^U=\other
8033 \catcode`\^^V=\other
8034 \catcode`\^^W=\other
8035 \catcode`\^^X=\other
8036 \catcode`\^^Z=\other
8037 \catcode`\^^[=\other
8038 \catcode`\^^\=\other
8039 \catcode`\^^]=\other
8040 \catcode`\^^^=\other
8041 \catcode`\^^_=\other
8042 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8043 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8044 % supported in the main text, it doesn't seem desirable. Furthermore,
8045 % that is not enough: for node names that actually contain a ^
8046 % character, we would end up writing a line like this: 'xrdef {'hat
8047 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8048 % argument, and \hat is not an expandable control sequence. It could
8049 % all be worked out, but why? Either we support ^^ or we don't.
8051 % The other change necessary for this was to define \auxhat:
8052 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8053 % and then to call \auxhat in \setq.
8057 % Special characters. Should be turned off anyway, but...
8070 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8072 % This is to support \ in node names and titles, since the \
8073 % characters end up in a \csname. It's easier than
8074 % leaving it active and making its active definition an actual \
8075 % character. What I don't understand is why it works in the *value*
8076 % of the xrdef. Seems like it should be a catcode12 \, and that
8077 % should not typeset properly. But it works, so I'm moving on for
8078 % now. --karl, 15jan04.
8081 % Make the characters 128-255 be printing characters.
8085 \catcode\count1=\other
8086 \advance\count1 by 1
8087 \ifnum \count1<256 \loop \fi
8091 % @ is our escape character in .aux files, and we need braces.
8097 \def\readdatafile#1{%
8104 \message{insertions,}
8105 % including footnotes.
8107 \newcount \footnoteno
8109 % The trailing space in the following definition for supereject is
8110 % vital for proper filling; pages come out unaligned when you do a
8111 % pagealignmacro call if that space before the closing brace is
8112 % removed. (Generally, numeric constants should always be followed by a
8113 % space to prevent strange expansion errors.)
8114 \def\supereject{\par\penalty -20000\footnoteno =0 }
8116 % @footnotestyle is meaningful for Info output only.
8117 \let\footnotestyle=\comment
8121 % Auto-number footnotes. Otherwise like plain.
8123 \let\indent=\ptexindent
8124 \let\noindent=\ptexnoindent
8125 \global\advance\footnoteno by \@ne
8126 \edef\thisfootno{$^{\the\footnoteno}$}%
8128 % In case the footnote comes at the end of a sentence, preserve the
8129 % extra spacing after we do the footnote number.
8131 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8133 % Remove inadvertent blank space before typesetting the footnote number.
8139 % Don't bother with the trickery in plain.tex to not require the
8140 % footnote text as a parameter. Our footnotes don't need to be so general.
8142 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8143 % \parseargline) fails inside footnotes because the tokens are fixed when
8144 % the footnote is read. --karl, 16nov96.
8147 \insert\footins\bgroup
8148 % We want to typeset this text as a normal paragraph, even if the
8149 % footnote reference occurs in (for example) a display environment.
8150 % So reset some parameters.
8152 \interlinepenalty\interfootnotelinepenalty
8153 \splittopskip\ht\strutbox % top baseline for broken footnotes
8154 \splitmaxdepth\dp\strutbox
8155 \floatingpenalty\@MM
8160 \parindent\defaultparindent
8164 % Because we use hanging indentation in footnotes, a @noindent appears
8165 % to exdent this text, so make it be a no-op. makeinfo does not use
8166 % hanging indentation so @noindent can still be needed within footnote
8167 % text after an @example or the like (not that this is good style).
8168 \let\noindent = \relax
8170 % Hang the footnote text off the number. Use \everypar in case the
8171 % footnote extends for more than one paragraph.
8172 \everypar = {\hang}%
8173 \textindent{\thisfootno}%
8175 % Don't crash into the line above the footnote text. Since this
8176 % expands into a box, it must come within the paragraph, lest it
8177 % provide a place where TeX can split the footnote.
8180 % Invoke rest of plain TeX footnote routine.
8181 \futurelet\next\fo@t
8183 }%end \catcode `\@=11
8185 % In case a @footnote appears in a vbox, save the footnote text and create
8186 % the real \insert just after the vbox finished. Otherwise, the insertion
8188 % Similarly, if a @footnote appears inside an alignment, save the footnote
8189 % text to a box and make the \insert when a row of the table is finished.
8190 % And the same can be done for other insert classes. --kasal, 16nov03.
8192 % Replace the \insert primitive by a cheating macro.
8193 % Deeper inside, just make sure that the saved insertions are not spilled
8196 \def\startsavinginserts{%
8197 \ifx \insert\ptexinsert
8198 \let\insert\saveinsert
8200 \let\checkinserts\relax
8204 % This \insert replacement works for both \insert\footins{foo} and
8205 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8208 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8209 \afterassignment\next
8210 % swallow the left brace
8213 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8214 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8216 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8218 \def\placesaveins#1{%
8219 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8223 % eat @SAVE -- beware, all of them have catcode \other:
8225 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8226 \gdef\gobblesave @SAVE{}
8230 \def\newsaveins #1{%
8231 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8234 \def\newsaveinsX #1{%
8235 \csname newbox\endcsname #1%
8236 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8241 \let\checkinserts\empty
8246 % @image. We use the macros from epsf.tex to support this.
8247 % If epsf.tex is not installed and @image is used, we complain.
8249 % Check for and read epsf.tex up front. If we read it only at @image
8250 % time, we might be inside a group, and then its definitions would get
8251 % undone and the next image would fail.
8252 \openin 1 = epsf.tex
8254 % Do not bother showing banner with epsf.tex v2.7k (available in
8255 % doc/epsf.tex and on ctan).
8256 \def\epsfannounce{\toks0 = }%
8261 % We will only complain once about lack of epsf.tex.
8262 \newif\ifwarnednoepsf
8263 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8264 work. It is also included in the Texinfo distribution, or you can get
8265 it from ftp://tug.org/tex/epsf.tex.}
8268 \ifx\epsfbox\thisiundefined
8269 \ifwarnednoepsf \else
8270 \errhelp = \noepsfhelp
8271 \errmessage{epsf.tex not found, images will be ignored}%
8272 \global\warnednoepsftrue
8275 \imagexxx #1,,,,,\finish
8279 % Arguments to @image:
8280 % #1 is (mandatory) image filename; we tack on .eps extension.
8281 % #2 is (optional) width, #3 is (optional) height.
8282 % #4 is (ignored optional) html alt text.
8283 % #5 is (ignored optional) extension.
8284 % #6 is just the usual extra ignored arg for parsing stuff.
8286 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8287 \catcode`\^^M = 5 % in case we're inside an example
8288 \normalturnoffactive % allow _ et al. in names
8289 % If the image is by itself, center it.
8293 % Usually we'll have text after the image which will insert
8294 % \parskip glue, so insert it here too to equalize the space
8296 \nobreak\vskip\parskip
8300 % Leave vertical mode so that indentation from an enclosing
8301 % environment such as @quotation is respected. On the other hand, if
8302 % it's at the top level, we don't want the normal paragraph indentation.
8307 \dopdfimage{#1}{#2}{#3}%
8309 % \epsfbox itself resets \epsf?size at each figure.
8310 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8311 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8315 \ifimagevmode \medskip \fi % space after the standalone image
8319 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8320 % etc. We don't actually implement floating yet, we always include the
8321 % float "here". But it seemed the best name for the future.
8323 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8325 % There may be a space before second and/or third parameter; delete it.
8326 \def\eatcommaspace#1, {#1,}
8328 % #1 is the optional FLOATTYPE, the text label for this float, typically
8329 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8330 % this float will not be numbered and cannot be referred to.
8332 % #2 is the optional xref label. Also must be present for the float to
8335 % #3 is the optional positioning argument; for now, it is ignored. It
8336 % will somehow specify the positions allowed to float to (here, top, bottom).
8338 % We keep a separate counter for each FLOATTYPE, which we reset at each
8339 % chapter-level command.
8340 \let\resetallfloatnos=\empty
8342 \def\dofloat#1,#2,#3,#4\finish{%
8343 \let\thiscaption=\empty
8344 \let\thisshortcaption=\empty
8346 % don't lose footnotes inside @float.
8348 % BEWARE: when the floats start float, we have to issue warning whenever an
8349 % insert appears inside a float which could possibly float. --kasal, 26may04
8353 % We can't be used inside a paragraph.
8358 \def\floatlabel{#2}%
8359 \def\floatloc{#3}% we do nothing with this yet.
8361 \ifx\floattype\empty
8362 \let\safefloattype=\empty
8365 % the floattype might have accents or other special characters,
8366 % but we need to use it in a control sequence name.
8369 \xdef\safefloattype{\floattype}%
8373 % If label is given but no type, we handle that as the empty type.
8374 \ifx\floatlabel\empty \else
8375 % We want each FLOATTYPE to be numbered separately (Figure 1,
8376 % Table 1, Figure 2, ...). (And if no label, no number.)
8378 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8379 \global\advance\floatno by 1
8382 % This magic value for \lastsection is output by \setref as the
8383 % XREFLABEL-title value. \xrefX uses it to distinguish float
8384 % labels (which have a completely different output format) from
8385 % node and anchor labels. And \xrdef uses it to construct the
8388 \edef\lastsection{\floatmagic=\safefloattype}%
8389 \setref{\floatlabel}{Yfloat}%
8393 % start with \parskip glue, I guess.
8396 % Don't suppress indentation if a float happens to start a section.
8397 \restorefirstparagraphindent
8400 % we have these possibilities:
8401 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8402 % @float Foo,lbl & no caption: Foo 1.1
8403 % @float Foo & @caption{Cap}: Foo: Cap
8404 % @float Foo & no caption: Foo
8405 % @float ,lbl & Caption{Cap}: 1.1: Cap
8406 % @float ,lbl & no caption: 1.1
8407 % @float & @caption{Cap}: Cap
8408 % @float & no caption:
8411 \let\floatident = \empty
8413 % In all cases, if we have a float type, it comes first.
8414 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8416 % If we have an xref label, the number comes next.
8417 \ifx\floatlabel\empty \else
8418 \ifx\floattype\empty \else % if also had float type, need tie first.
8419 \appendtomacro\floatident{\tie}%
8422 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8425 % Start the printed caption with what we've constructed in
8426 % \floatident, but keep it separate; we need \floatident again.
8427 \let\captionline = \floatident
8429 \ifx\thiscaption\empty \else
8430 \ifx\floatident\empty \else
8431 \appendtomacro\captionline{: }% had ident, so need a colon between
8435 \appendtomacro\captionline{\scanexp\thiscaption}%
8438 % If we have anything to print, print it, with space before.
8439 % Eventually this needs to become an \insert.
8440 \ifx\captionline\empty \else
8444 % Space below caption.
8448 % If have an xref label, write the list of floats info. Do this
8449 % after the caption, to avoid chance of it being a breakpoint.
8450 \ifx\floatlabel\empty \else
8451 % Write the text that goes in the lof to the aux file as
8452 % \floatlabel-lof. Besides \floatident, we include the short
8453 % caption if specified, else the full caption if specified, else nothing.
8457 % since we read the caption text in the macro world, where ^^M
8458 % is turned into a normal character, we have to scan it back, so
8459 % we don't write the literal three characters "^^M" into the aux file.
8461 \xdef\noexpand\gtemp{%
8462 \ifx\thisshortcaption\empty
8469 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8470 \ifx\gtemp\empty \else : \gtemp \fi}}%
8473 \egroup % end of \vtop
8475 % place the captured inserts
8477 % BEWARE: when the floats start floating, we have to issue warning
8478 % whenever an insert appears inside a float which could possibly
8479 % float. --kasal, 26may04
8484 % Append the tokens #2 to the definition of macro #1, not expanding either.
8486 \def\appendtomacro#1#2{%
8487 \expandafter\def\expandafter#1\expandafter{#1#2}%
8490 % @caption, @shortcaption
8492 \def\caption{\docaption\thiscaption}
8493 \def\shortcaption{\docaption\thisshortcaption}
8494 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8495 \def\defcaption#1#2{\egroup \def#1{#2}}
8497 % The parameter is the control sequence identifying the counter we are
8498 % going to use. Create it if it doesn't exist and assign it to \floatno.
8501 % Haven't seen this figure type before.
8502 \csname newcount\endcsname #1%
8504 % Remember to reset this floatno at the next chap.
8505 \expandafter\gdef\expandafter\resetallfloatnos
8506 \expandafter{\resetallfloatnos #1=0 }%
8511 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8512 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8513 % first read the @float command.
8515 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8517 % Magic string used for the XREFLABEL-title value, so \xrefX can
8518 % distinguish floats from other xref types.
8519 \def\floatmagic{!!float!!}
8521 % #1 is the control sequence we are passed; we expand into a conditional
8522 % which is true if #1 represents a float ref. That is, the magic
8523 % \lastsection value which we \setref above.
8525 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8527 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8528 % (safe) float type for this float. We set \iffloattype to #2.
8530 \def\doiffloat#1=#2=#3\finish{%
8532 \def\iffloattype{#2}%
8533 \ifx\temp\floatmagic
8536 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8538 \parseargdef\listoffloats{%
8539 \def\floattype{#1}% floattype
8541 % the floattype might have accents or other special characters,
8542 % but we need to use it in a control sequence name.
8545 \xdef\safefloattype{\floattype}%
8548 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8549 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8551 % if the user said @listoffloats foo but never @float foo.
8552 \message{\linenumber No `\safefloattype' floats to list.}%
8556 \leftskip=\tocindent % indent these entries like a toc
8557 \let\do=\listoffloatsdo
8558 \csname floatlist\safefloattype\endcsname
8563 % This is called on each entry in a list of floats. We're passed the
8564 % xref label, in the form LABEL-title, which is how we save it in the
8565 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8566 % has the text we're supposed to typeset here.
8568 % Figures without xref labels will not be included in the list (since
8569 % they won't appear in the aux file).
8571 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8572 \def\listoffloatsdoentry#1-title\finish{{%
8573 % Can't fully expand XR#1-lof because it can contain anything. Just
8574 % pass the control sequence. On the other hand, XR#1-pg is just the
8575 % page number, and we want to fully expand that so we can get a link
8577 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8579 % use the same \entry macro we use to generate the TOC and index.
8580 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8585 \message{localization,}
8587 % For single-language documents, @documentlanguage is usually given very
8588 % early, just after @documentencoding. Single argument is the language
8589 % (de) or locale (de_DE) abbreviation.
8592 \catcode`\_ = \active
8594 \parseargdef\documentlanguage{\begingroup
8595 \let_=\normalunderscore % normal _ character for filenames
8596 \tex % read txi-??.tex file in plain TeX.
8597 % Read the file by the name they passed if it exists.
8598 \openin 1 txi-#1.tex
8600 \documentlanguagetrywithoutunderscore{#1_\finish}%
8602 \globaldefs = 1 % everything in the txi-LL files needs to persist
8606 \endgroup % end raw TeX
8609 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8612 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8613 \openin 1 txi-#1.tex
8615 \errhelp = \nolanghelp
8616 \errmessage{Cannot read language file txi-#1.tex}%
8618 \globaldefs = 1 % everything in the txi-LL files needs to persist
8623 }% end of special _ catcode
8625 \newhelp\nolanghelp{The given language definition file cannot be found or
8626 is empty. Maybe you need to install it? Putting it in the current
8627 directory should work if nowhere else does.}
8629 % This macro is called from txi-??.tex files; the first argument is the
8630 % \language name to set (without the "\lang@" prefix), the second and
8631 % third args are \{left,right}hyphenmin.
8633 % The language names to pass are determined when the format is built.
8634 % See the etex.log file created at that time, e.g.,
8635 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8637 % With TeX Live 2008, etex now includes hyphenation patterns for all
8638 % available languages. This means we can support hyphenation in
8639 % Texinfo, at least to some extent. (This still doesn't solve the
8640 % accented characters problem.)
8643 \def\txisetlanguage#1#2#3{%
8644 % do not set the language if the name is undefined in the current TeX.
8645 \expandafter\ifx\csname lang@#1\endcsname \relax
8646 \message{no patterns for #1}%
8648 \global\language = \csname lang@#1\endcsname
8650 % but there is no harm in adjusting the hyphenmin values regardless.
8651 \global\lefthyphenmin = #2\relax
8652 \global\righthyphenmin = #3\relax
8655 % Helpers for encodings.
8656 % Set the catcode of characters 128 through 255 to the specified number.
8658 \def\setnonasciicharscatcode#1{%
8660 \loop\ifnum\count255<256
8661 \global\catcode\count255=#1\relax
8662 \advance\count255 by 1
8666 \def\setnonasciicharscatcodenonglobal#1{%
8668 \loop\ifnum\count255<256
8669 \catcode\count255=#1\relax
8670 \advance\count255 by 1
8674 % @documentencoding sets the definition of non-ASCII characters
8675 % according to the specified encoding.
8677 \parseargdef\documentencoding{%
8678 % Encoding being declared for the document.
8679 \def\declaredencoding{\csname #1.enc\endcsname}%
8681 % Supported encodings: names converted to tokens in order to be able
8682 % to compare them with \ifx.
8683 \def\ascii{\csname US-ASCII.enc\endcsname}%
8684 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8685 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8686 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8687 \def\utfeight{\csname UTF-8.enc\endcsname}%
8689 \ifx \declaredencoding \ascii
8692 \else \ifx \declaredencoding \lattwo
8693 \setnonasciicharscatcode\active
8696 \else \ifx \declaredencoding \latone
8697 \setnonasciicharscatcode\active
8700 \else \ifx \declaredencoding \latnine
8701 \setnonasciicharscatcode\active
8704 \else \ifx \declaredencoding \utfeight
8705 \setnonasciicharscatcode\active
8709 \message{Unknown document encoding #1, ignoring.}%
8718 % A message to be logged when using a character that isn't available
8719 % the default font encoding (OT1).
8721 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8723 % Take account of \c (plain) vs. \, (Texinfo) difference.
8724 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8726 % First, make active non-ASCII characters in order for them to be
8727 % correctly categorized when TeX reads the replacement text of
8728 % macros containing the character definitions.
8729 \setnonasciicharscatcode\active
8731 % Latin1 (ISO-8859-1) character definitions.
8732 \def\latonechardefs{%
8734 \gdef^^a1{\exclamdown}
8735 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8736 \gdef^^a3{{\pounds}}
8737 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8738 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8739 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8742 \gdef^^a9{\copyright}
8744 \gdef^^ab{\guillemetleft}
8747 \gdef^^ae{\registeredsymbol}
8750 \gdef^^b0{\textdegree}
8759 \gdef^^b8{\cedilla\ }
8763 \gdef^^bb{\guillemetright}
8764 \gdef^^bc{$1\over4$}
8765 \gdef^^bd{$1\over2$}
8766 \gdef^^be{$3\over4$}
8767 \gdef^^bf{\questiondown}
8774 \gdef^^c5{\ringaccent A}
8776 \gdef^^c7{\cedilla C}
8808 \gdef^^e5{\ringaccent a}
8810 \gdef^^e7{\cedilla c}
8815 \gdef^^ec{\`{\dotless i}}
8816 \gdef^^ed{\'{\dotless i}}
8817 \gdef^^ee{\^{\dotless i}}
8818 \gdef^^ef{\"{\dotless i}}
8838 % Latin9 (ISO-8859-15) encoding character definitions.
8839 \def\latninechardefs{%
8840 % Encoding is almost identical to Latin1.
8853 % Latin2 (ISO-8859-2) character definitions.
8854 \def\lattwochardefs{%
8856 \gdef^^a1{\ogonek{A}}
8859 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8865 \gdef^^aa{\cedilla S}
8870 \gdef^^af{\dotaccent Z}
8872 \gdef^^b0{\textdegree}
8873 \gdef^^b1{\ogonek{a}}
8874 \gdef^^b2{\ogonek{ }}
8880 \gdef^^b8{\cedilla\ }
8882 \gdef^^ba{\cedilla s}
8887 \gdef^^bf{\dotaccent z}
8896 \gdef^^c7{\cedilla C}
8899 \gdef^^ca{\ogonek{E}}
8915 \gdef^^d9{\ringaccent U}
8920 \gdef^^de{\cedilla T}
8930 \gdef^^e7{\cedilla c}
8933 \gdef^^ea{\ogonek{e}}
8936 \gdef^^ed{\'{\dotless{i}}}
8937 \gdef^^ee{\^{\dotless{i}}}
8949 \gdef^^f9{\ringaccent u}
8954 \gdef^^fe{\cedilla t}
8955 \gdef^^ff{\dotaccent{}}
8958 % UTF-8 character definitions.
8960 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8961 % changes for Texinfo conventions. It is included here under the GPL by
8962 % permission from Frank Mittelbach and the LaTeX team.
8968 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8969 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8971 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8972 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8974 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8975 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8977 \gdef\UTFviiiDefined#1{%
8979 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8990 \global\catcode\countUTFx\active
8991 \uccode`\~\countUTFx
8992 \uppercase\expandafter{\UTFviiiTmp}%
8993 \advance\countUTFx by 1
8994 \ifnum\countUTFx < \countUTFy
8995 \expandafter\UTFviiiLoop
9001 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9007 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9013 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9026 \gdef\DeclareUnicodeCharacter#1#2{%
9027 \countUTFz = "#1\relax
9028 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9031 \def\UTFviiiTwoOctets##1##2{%
9032 \csname u8:##1\string ##2\endcsname}%
9033 \def\UTFviiiThreeOctets##1##2##3{%
9034 \csname u8:##1\string ##2\string ##3\endcsname}%
9035 \def\UTFviiiFourOctets##1##2##3##4{%
9036 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9037 \expandafter\expandafter\expandafter\expandafter
9038 \expandafter\expandafter\expandafter
9039 \gdef\UTFviiiTmp{#2}%
9042 \gdef\parseXMLCharref{%
9043 \ifnum\countUTFz < "A0\relax
9044 \errhelp = \EMsimple
9045 \errmessage{Cannot define Unicode char value < 00A0}%
9046 \else\ifnum\countUTFz < "800\relax
9048 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9049 \else\ifnum\countUTFz < "10000\relax
9052 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9057 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9061 \gdef\parseUTFviiiA#1{%
9062 \countUTFx = \countUTFz
9063 \divide\countUTFz by 64
9064 \countUTFy = \countUTFz
9065 \multiply\countUTFz by 64
9066 \advance\countUTFx by -\countUTFz
9067 \advance\countUTFx by 128
9068 \uccode `#1\countUTFx
9069 \countUTFz = \countUTFy}
9071 \gdef\parseUTFviiiB#1#2#3#4{%
9072 \advance\countUTFz by "#10\relax
9073 \uccode `#3\countUTFz
9074 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9077 \def\utfeightchardefs{%
9078 \DeclareUnicodeCharacter{00A0}{\tie}
9079 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9080 \DeclareUnicodeCharacter{00A3}{\pounds}
9081 \DeclareUnicodeCharacter{00A8}{\"{ }}
9082 \DeclareUnicodeCharacter{00A9}{\copyright}
9083 \DeclareUnicodeCharacter{00AA}{\ordf}
9084 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9085 \DeclareUnicodeCharacter{00AD}{\-}
9086 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9087 \DeclareUnicodeCharacter{00AF}{\={ }}
9089 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9090 \DeclareUnicodeCharacter{00B4}{\'{ }}
9091 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9092 \DeclareUnicodeCharacter{00BA}{\ordm}
9093 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9094 \DeclareUnicodeCharacter{00BF}{\questiondown}
9096 \DeclareUnicodeCharacter{00C0}{\`A}
9097 \DeclareUnicodeCharacter{00C1}{\'A}
9098 \DeclareUnicodeCharacter{00C2}{\^A}
9099 \DeclareUnicodeCharacter{00C3}{\~A}
9100 \DeclareUnicodeCharacter{00C4}{\"A}
9101 \DeclareUnicodeCharacter{00C5}{\AA}
9102 \DeclareUnicodeCharacter{00C6}{\AE}
9103 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9104 \DeclareUnicodeCharacter{00C8}{\`E}
9105 \DeclareUnicodeCharacter{00C9}{\'E}
9106 \DeclareUnicodeCharacter{00CA}{\^E}
9107 \DeclareUnicodeCharacter{00CB}{\"E}
9108 \DeclareUnicodeCharacter{00CC}{\`I}
9109 \DeclareUnicodeCharacter{00CD}{\'I}
9110 \DeclareUnicodeCharacter{00CE}{\^I}
9111 \DeclareUnicodeCharacter{00CF}{\"I}
9113 \DeclareUnicodeCharacter{00D0}{\DH}
9114 \DeclareUnicodeCharacter{00D1}{\~N}
9115 \DeclareUnicodeCharacter{00D2}{\`O}
9116 \DeclareUnicodeCharacter{00D3}{\'O}
9117 \DeclareUnicodeCharacter{00D4}{\^O}
9118 \DeclareUnicodeCharacter{00D5}{\~O}
9119 \DeclareUnicodeCharacter{00D6}{\"O}
9120 \DeclareUnicodeCharacter{00D8}{\O}
9121 \DeclareUnicodeCharacter{00D9}{\`U}
9122 \DeclareUnicodeCharacter{00DA}{\'U}
9123 \DeclareUnicodeCharacter{00DB}{\^U}
9124 \DeclareUnicodeCharacter{00DC}{\"U}
9125 \DeclareUnicodeCharacter{00DD}{\'Y}
9126 \DeclareUnicodeCharacter{00DE}{\TH}
9127 \DeclareUnicodeCharacter{00DF}{\ss}
9129 \DeclareUnicodeCharacter{00E0}{\`a}
9130 \DeclareUnicodeCharacter{00E1}{\'a}
9131 \DeclareUnicodeCharacter{00E2}{\^a}
9132 \DeclareUnicodeCharacter{00E3}{\~a}
9133 \DeclareUnicodeCharacter{00E4}{\"a}
9134 \DeclareUnicodeCharacter{00E5}{\aa}
9135 \DeclareUnicodeCharacter{00E6}{\ae}
9136 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9137 \DeclareUnicodeCharacter{00E8}{\`e}
9138 \DeclareUnicodeCharacter{00E9}{\'e}
9139 \DeclareUnicodeCharacter{00EA}{\^e}
9140 \DeclareUnicodeCharacter{00EB}{\"e}
9141 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9142 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9143 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9144 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9146 \DeclareUnicodeCharacter{00F0}{\dh}
9147 \DeclareUnicodeCharacter{00F1}{\~n}
9148 \DeclareUnicodeCharacter{00F2}{\`o}
9149 \DeclareUnicodeCharacter{00F3}{\'o}
9150 \DeclareUnicodeCharacter{00F4}{\^o}
9151 \DeclareUnicodeCharacter{00F5}{\~o}
9152 \DeclareUnicodeCharacter{00F6}{\"o}
9153 \DeclareUnicodeCharacter{00F8}{\o}
9154 \DeclareUnicodeCharacter{00F9}{\`u}
9155 \DeclareUnicodeCharacter{00FA}{\'u}
9156 \DeclareUnicodeCharacter{00FB}{\^u}
9157 \DeclareUnicodeCharacter{00FC}{\"u}
9158 \DeclareUnicodeCharacter{00FD}{\'y}
9159 \DeclareUnicodeCharacter{00FE}{\th}
9160 \DeclareUnicodeCharacter{00FF}{\"y}
9162 \DeclareUnicodeCharacter{0100}{\=A}
9163 \DeclareUnicodeCharacter{0101}{\=a}
9164 \DeclareUnicodeCharacter{0102}{\u{A}}
9165 \DeclareUnicodeCharacter{0103}{\u{a}}
9166 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9167 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9168 \DeclareUnicodeCharacter{0106}{\'C}
9169 \DeclareUnicodeCharacter{0107}{\'c}
9170 \DeclareUnicodeCharacter{0108}{\^C}
9171 \DeclareUnicodeCharacter{0109}{\^c}
9172 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9173 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9174 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9175 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9176 \DeclareUnicodeCharacter{010C}{\v{C}}
9177 \DeclareUnicodeCharacter{010D}{\v{c}}
9178 \DeclareUnicodeCharacter{010E}{\v{D}}
9180 \DeclareUnicodeCharacter{0112}{\=E}
9181 \DeclareUnicodeCharacter{0113}{\=e}
9182 \DeclareUnicodeCharacter{0114}{\u{E}}
9183 \DeclareUnicodeCharacter{0115}{\u{e}}
9184 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9185 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9186 \DeclareUnicodeCharacter{011A}{\v{E}}
9187 \DeclareUnicodeCharacter{011B}{\v{e}}
9188 \DeclareUnicodeCharacter{011C}{\^G}
9189 \DeclareUnicodeCharacter{011D}{\^g}
9190 \DeclareUnicodeCharacter{011E}{\u{G}}
9191 \DeclareUnicodeCharacter{011F}{\u{g}}
9193 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9194 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9195 \DeclareUnicodeCharacter{0124}{\^H}
9196 \DeclareUnicodeCharacter{0125}{\^h}
9197 \DeclareUnicodeCharacter{0128}{\~I}
9198 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9199 \DeclareUnicodeCharacter{012A}{\=I}
9200 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9201 \DeclareUnicodeCharacter{012C}{\u{I}}
9202 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9204 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9205 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9206 \DeclareUnicodeCharacter{0132}{IJ}
9207 \DeclareUnicodeCharacter{0133}{ij}
9208 \DeclareUnicodeCharacter{0134}{\^J}
9209 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9210 \DeclareUnicodeCharacter{0139}{\'L}
9211 \DeclareUnicodeCharacter{013A}{\'l}
9213 \DeclareUnicodeCharacter{0141}{\L}
9214 \DeclareUnicodeCharacter{0142}{\l}
9215 \DeclareUnicodeCharacter{0143}{\'N}
9216 \DeclareUnicodeCharacter{0144}{\'n}
9217 \DeclareUnicodeCharacter{0147}{\v{N}}
9218 \DeclareUnicodeCharacter{0148}{\v{n}}
9219 \DeclareUnicodeCharacter{014C}{\=O}
9220 \DeclareUnicodeCharacter{014D}{\=o}
9221 \DeclareUnicodeCharacter{014E}{\u{O}}
9222 \DeclareUnicodeCharacter{014F}{\u{o}}
9224 \DeclareUnicodeCharacter{0150}{\H{O}}
9225 \DeclareUnicodeCharacter{0151}{\H{o}}
9226 \DeclareUnicodeCharacter{0152}{\OE}
9227 \DeclareUnicodeCharacter{0153}{\oe}
9228 \DeclareUnicodeCharacter{0154}{\'R}
9229 \DeclareUnicodeCharacter{0155}{\'r}
9230 \DeclareUnicodeCharacter{0158}{\v{R}}
9231 \DeclareUnicodeCharacter{0159}{\v{r}}
9232 \DeclareUnicodeCharacter{015A}{\'S}
9233 \DeclareUnicodeCharacter{015B}{\'s}
9234 \DeclareUnicodeCharacter{015C}{\^S}
9235 \DeclareUnicodeCharacter{015D}{\^s}
9236 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9237 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9239 \DeclareUnicodeCharacter{0160}{\v{S}}
9240 \DeclareUnicodeCharacter{0161}{\v{s}}
9241 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9242 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9243 \DeclareUnicodeCharacter{0164}{\v{T}}
9245 \DeclareUnicodeCharacter{0168}{\~U}
9246 \DeclareUnicodeCharacter{0169}{\~u}
9247 \DeclareUnicodeCharacter{016A}{\=U}
9248 \DeclareUnicodeCharacter{016B}{\=u}
9249 \DeclareUnicodeCharacter{016C}{\u{U}}
9250 \DeclareUnicodeCharacter{016D}{\u{u}}
9251 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9252 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9254 \DeclareUnicodeCharacter{0170}{\H{U}}
9255 \DeclareUnicodeCharacter{0171}{\H{u}}
9256 \DeclareUnicodeCharacter{0174}{\^W}
9257 \DeclareUnicodeCharacter{0175}{\^w}
9258 \DeclareUnicodeCharacter{0176}{\^Y}
9259 \DeclareUnicodeCharacter{0177}{\^y}
9260 \DeclareUnicodeCharacter{0178}{\"Y}
9261 \DeclareUnicodeCharacter{0179}{\'Z}
9262 \DeclareUnicodeCharacter{017A}{\'z}
9263 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9264 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9265 \DeclareUnicodeCharacter{017D}{\v{Z}}
9266 \DeclareUnicodeCharacter{017E}{\v{z}}
9268 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9269 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9270 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9271 \DeclareUnicodeCharacter{01C7}{LJ}
9272 \DeclareUnicodeCharacter{01C8}{Lj}
9273 \DeclareUnicodeCharacter{01C9}{lj}
9274 \DeclareUnicodeCharacter{01CA}{NJ}
9275 \DeclareUnicodeCharacter{01CB}{Nj}
9276 \DeclareUnicodeCharacter{01CC}{nj}
9277 \DeclareUnicodeCharacter{01CD}{\v{A}}
9278 \DeclareUnicodeCharacter{01CE}{\v{a}}
9279 \DeclareUnicodeCharacter{01CF}{\v{I}}
9281 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9282 \DeclareUnicodeCharacter{01D1}{\v{O}}
9283 \DeclareUnicodeCharacter{01D2}{\v{o}}
9284 \DeclareUnicodeCharacter{01D3}{\v{U}}
9285 \DeclareUnicodeCharacter{01D4}{\v{u}}
9287 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9288 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9289 \DeclareUnicodeCharacter{01E6}{\v{G}}
9290 \DeclareUnicodeCharacter{01E7}{\v{g}}
9291 \DeclareUnicodeCharacter{01E8}{\v{K}}
9292 \DeclareUnicodeCharacter{01E9}{\v{k}}
9294 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9295 \DeclareUnicodeCharacter{01F1}{DZ}
9296 \DeclareUnicodeCharacter{01F2}{Dz}
9297 \DeclareUnicodeCharacter{01F3}{dz}
9298 \DeclareUnicodeCharacter{01F4}{\'G}
9299 \DeclareUnicodeCharacter{01F5}{\'g}
9300 \DeclareUnicodeCharacter{01F8}{\`N}
9301 \DeclareUnicodeCharacter{01F9}{\`n}
9302 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9303 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9304 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9305 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9307 \DeclareUnicodeCharacter{021E}{\v{H}}
9308 \DeclareUnicodeCharacter{021F}{\v{h}}
9310 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9311 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9312 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9313 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9314 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9315 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9317 \DeclareUnicodeCharacter{0232}{\=Y}
9318 \DeclareUnicodeCharacter{0233}{\=y}
9319 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9321 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9323 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9324 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9325 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9326 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9327 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9328 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9329 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9330 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9331 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9332 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9333 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9334 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9336 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9337 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9339 \DeclareUnicodeCharacter{1E20}{\=G}
9340 \DeclareUnicodeCharacter{1E21}{\=g}
9341 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9342 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9343 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9344 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9345 \DeclareUnicodeCharacter{1E26}{\"H}
9346 \DeclareUnicodeCharacter{1E27}{\"h}
9348 \DeclareUnicodeCharacter{1E30}{\'K}
9349 \DeclareUnicodeCharacter{1E31}{\'k}
9350 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9351 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9352 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9353 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9354 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9355 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9356 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9357 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9358 \DeclareUnicodeCharacter{1E3E}{\'M}
9359 \DeclareUnicodeCharacter{1E3F}{\'m}
9361 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9362 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9363 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9364 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9365 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9366 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9367 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9368 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9369 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9370 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9372 \DeclareUnicodeCharacter{1E54}{\'P}
9373 \DeclareUnicodeCharacter{1E55}{\'p}
9374 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9375 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9376 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9377 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9378 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9379 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9380 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9381 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9383 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9384 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9385 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9386 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9387 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9388 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9389 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9390 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9391 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9392 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9394 \DeclareUnicodeCharacter{1E7C}{\~V}
9395 \DeclareUnicodeCharacter{1E7D}{\~v}
9396 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9397 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9399 \DeclareUnicodeCharacter{1E80}{\`W}
9400 \DeclareUnicodeCharacter{1E81}{\`w}
9401 \DeclareUnicodeCharacter{1E82}{\'W}
9402 \DeclareUnicodeCharacter{1E83}{\'w}
9403 \DeclareUnicodeCharacter{1E84}{\"W}
9404 \DeclareUnicodeCharacter{1E85}{\"w}
9405 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9406 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9407 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9408 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9409 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9410 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9411 \DeclareUnicodeCharacter{1E8C}{\"X}
9412 \DeclareUnicodeCharacter{1E8D}{\"x}
9413 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9414 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9416 \DeclareUnicodeCharacter{1E90}{\^Z}
9417 \DeclareUnicodeCharacter{1E91}{\^z}
9418 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9419 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9420 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9421 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9422 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9423 \DeclareUnicodeCharacter{1E97}{\"t}
9424 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9425 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9427 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9428 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9430 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9431 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9432 \DeclareUnicodeCharacter{1EBC}{\~E}
9433 \DeclareUnicodeCharacter{1EBD}{\~e}
9435 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9436 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9437 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9438 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9440 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9441 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9443 \DeclareUnicodeCharacter{1EF2}{\`Y}
9444 \DeclareUnicodeCharacter{1EF3}{\`y}
9445 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9447 \DeclareUnicodeCharacter{1EF8}{\~Y}
9448 \DeclareUnicodeCharacter{1EF9}{\~y}
9450 \DeclareUnicodeCharacter{2013}{--}
9451 \DeclareUnicodeCharacter{2014}{---}
9452 \DeclareUnicodeCharacter{2018}{\quoteleft}
9453 \DeclareUnicodeCharacter{2019}{\quoteright}
9454 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9455 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9456 \DeclareUnicodeCharacter{201D}{\quotedblright}
9457 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9458 \DeclareUnicodeCharacter{2022}{\bullet}
9459 \DeclareUnicodeCharacter{2026}{\dots}
9460 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9461 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9462 \DeclareUnicodeCharacter{20AC}{\euro}
9464 \DeclareUnicodeCharacter{2192}{\expansion}
9465 \DeclareUnicodeCharacter{21D2}{\result}
9467 \DeclareUnicodeCharacter{2212}{\minus}
9468 \DeclareUnicodeCharacter{2217}{\point}
9469 \DeclareUnicodeCharacter{2261}{\equiv}
9470 }% end of \utfeightchardefs
9473 % US-ASCII character definitions.
9474 \def\asciichardefs{% nothing need be done
9478 % Make non-ASCII characters printable again for compatibility with
9479 % existing Texinfo documents that may use them, even without declaring a
9480 % document encoding.
9482 \setnonasciicharscatcode \other
9485 \message{formatting,}
9487 \newdimen\defaultparindent \defaultparindent = 15pt
9489 \chapheadingskip = 15pt plus 4pt minus 2pt
9490 \secheadingskip = 12pt plus 3pt minus 2pt
9491 \subsecheadingskip = 9pt plus 2pt minus 2pt
9493 % Prevent underfull vbox error messages.
9496 % Don't be very finicky about underfull hboxes, either.
9499 % Following George Bush, get rid of widows and orphans.
9503 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9504 % using an old version of TeX, don't do anything. We want the amount of
9505 % stretch added to depend on the line length, hence the dependence on
9506 % \hsize. We call this whenever the paper size is set.
9508 \def\setemergencystretch{%
9509 \ifx\emergencystretch\thisisundefined
9510 % Allow us to assign to \emergencystretch anyway.
9511 \def\emergencystretch{\dimen0}%
9513 \emergencystretch = .15\hsize
9517 % Parameters in order: 1) textheight; 2) textwidth;
9518 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9519 % 7) physical page height; 8) physical page width.
9521 % We also call \setleading{\textleading}, so the caller should define
9522 % \textleading. The caller should also set \parskip.
9524 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9527 \splittopskip = \topskip
9530 \advance\vsize by \topskip
9531 \outervsize = \vsize
9532 \advance\outervsize by 2\topandbottommargin
9533 \pageheight = \vsize
9536 \outerhsize = \hsize
9537 \advance\outerhsize by 0.5in
9540 \normaloffset = #4\relax
9541 \bindingoffset = #5\relax
9544 \pdfpageheight #7\relax
9545 \pdfpagewidth #8\relax
9546 % if we don't reset these, they will remain at "1 true in" of
9547 % whatever layout pdftex was dumped with.
9548 \pdfhorigin = 1 true in
9549 \pdfvorigin = 1 true in
9552 \setleading{\textleading}
9554 \parindent = \defaultparindent
9555 \setemergencystretch
9558 % @letterpaper (the default).
9559 \def\letterpaper{{\globaldefs = 1
9560 \parskip = 3pt plus 2pt minus 1pt
9561 \textleading = 13.2pt
9563 % If page is nothing but text, make it come out even.
9564 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9566 {\bindingoffset}{36pt}%
9570 % Use @smallbook to reset parameters for 7x9.25 trim size.
9571 \def\smallbook{{\globaldefs = 1
9572 \parskip = 2pt plus 1pt
9575 \internalpagesizes{7.5in}{5in}%
9577 {\bindingoffset}{16pt}%
9580 \lispnarrowing = 0.3in
9583 \contentsrightmargin = 0pt
9584 \defbodyindent = .5cm
9587 % Use @smallerbook to reset parameters for 6x9 trim size.
9588 % (Just testing, parameters still in flux.)
9589 \def\smallerbook{{\globaldefs = 1
9590 \parskip = 1.5pt plus 1pt
9593 \internalpagesizes{7.4in}{4.8in}%
9598 \lispnarrowing = 0.25in
9601 \contentsrightmargin = 0pt
9602 \defbodyindent = .4cm
9605 % Use @afourpaper to print on European A4 paper.
9606 \def\afourpaper{{\globaldefs = 1
9607 \parskip = 3pt plus 2pt minus 1pt
9608 \textleading = 13.2pt
9610 % Double-side printing via postscript on Laserjet 4050
9611 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9612 % To change the settings for a different printer or situation, adjust
9613 % \normaloffset until the front-side and back-side texts align. Then
9614 % do the same for \bindingoffset. You can set these for testing in
9615 % your texinfo source file like this:
9617 % \global\normaloffset = -6mm
9618 % \global\bindingoffset = 10mm
9620 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9621 {\voffset}{\hoffset}%
9622 {\bindingoffset}{44pt}%
9627 \contentsrightmargin = 0pt
9628 \defbodyindent = 5mm
9631 % Use @afivepaper to print on European A5 paper.
9632 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9633 % He also recommends making @example and @lisp be small.
9634 \def\afivepaper{{\globaldefs = 1
9635 \parskip = 2pt plus 1pt minus 0.1pt
9636 \textleading = 12.5pt
9638 \internalpagesizes{160mm}{120mm}%
9639 {\voffset}{\hoffset}%
9640 {\bindingoffset}{8pt}%
9643 \lispnarrowing = 0.2in
9646 \contentsrightmargin = 0pt
9647 \defbodyindent = 2mm
9651 % A specific text layout, 24x15cm overall, intended for A4 paper.
9652 \def\afourlatex{{\globaldefs = 1
9654 \internalpagesizes{237mm}{150mm}%
9656 {\bindingoffset}{7mm}%
9659 % Must explicitly reset to 0 because we call \afourpaper.
9663 % Use @afourwide to print on A4 paper in landscape format.
9664 \def\afourwide{{\globaldefs = 1
9666 \internalpagesizes{241mm}{165mm}%
9667 {\voffset}{-2.95mm}%
9668 {\bindingoffset}{7mm}%
9673 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9674 % Perhaps we should allow setting the margins, \topskip, \parskip,
9675 % and/or leading, also. Or perhaps we should compute them somehow.
9677 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9678 \def\pagesizesyyy#1,#2,#3\finish{{%
9679 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9682 \parskip = 3pt plus 2pt minus 1pt
9683 \setleading{\textleading}%
9686 \advance\dimen0 by \voffset
9689 \advance\dimen2 by \normaloffset
9691 \internalpagesizes{#1}{\hsize}%
9692 {\voffset}{\normaloffset}%
9693 {\bindingoffset}{44pt}%
9697 % Set default to letter.
9702 \message{and turning on texinfo input format.}
9704 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9706 % DEL is a comment character, in case @c does not suffice.
9709 % Define macros to output various characters with catcode for normal text.
9710 \catcode`\"=\other \def\normaldoublequote{"}
9711 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9712 \catcode`\+=\other \def\normalplus{+}
9713 \catcode`\<=\other \def\normalless{<}
9714 \catcode`\>=\other \def\normalgreater{>}
9715 \catcode`\^=\other \def\normalcaret{^}
9716 \catcode`\_=\other \def\normalunderscore{_}
9717 \catcode`\|=\other \def\normalverticalbar{|}
9718 \catcode`\~=\other \def\normaltilde{~}
9720 % This macro is used to make a character print one way in \tt
9721 % (where it can probably be output as-is), and another way in other fonts,
9722 % where something hairier probably needs to be done.
9724 % #1 is what to print if we are indeed using \tt; #2 is what to print
9725 % otherwise. Since all the Computer Modern typewriter fonts have zero
9726 % interword stretch (and shrink), and it is reasonable to expect all
9727 % typewriter fonts to have this, we can check that font parameter.
9729 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9731 % Same as above, but check for italic font. Actually this also catches
9732 % non-italic slanted fonts since it is impossible to distinguish them from
9733 % italic fonts. But since this is only used by $ and it uses \sl anyway
9734 % this is not a problem.
9735 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9737 % Turn off all special characters except @
9738 % (and those which the user can use as if they were ordinary).
9739 % Most of these we simply print from the \tt font, but for some, we can
9740 % use math or other variants that look better in normal text.
9743 \def\activedoublequote{{\tt\char34}}
9744 \let"=\activedoublequote
9746 \def~{{\tt\char126}}
9752 \def_{\ifusingtt\normalunderscore\_}
9754 % Subroutine for the previous macro.
9755 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9758 \def|{{\tt\char124}}
9766 \def+{{\tt \char 43}}
9768 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9770 % If a .fmt file is being used, characters that might appear in a file
9771 % name cannot be active until we have parsed the command line.
9772 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9773 % \otherifyactive is called near the end of this file.
9774 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9776 % Used sometimes to turn off (effectively) the active characters even after
9778 \def\turnoffactive{%
9779 \normalturnoffactive
9785 % \backslashcurfont outputs one backslash character in current font,
9787 \global\chardef\backslashcurfont=`\\
9788 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9790 % \realbackslash is an actual character `\' with catcode other, and
9791 % \doublebackslash is two of them (for the pdf outlines).
9792 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9794 % In texinfo, backslash is an active character; it prints the backslash
9795 % in fixed width font.
9797 @def@normalbackslash{{@tt@backslashcurfont}}
9798 % On startup, @fixbackslash assigns:
9799 % @let \ = @normalbackslash
9801 % \rawbackslash defines an active \ to do \backslashcurfont.
9802 % \otherbackslash defines an active \ to be a literal `\' character with
9804 @gdef@rawbackslash{@let\=@backslashcurfont}
9805 @gdef@otherbackslash{@let\=@realbackslash}
9807 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9808 % the literal character `\'.
9810 @def@normalturnoffactive{%
9811 @let"=@normaldoublequote
9812 @let$=@normaldollar %$ font-lock fix
9815 @let>=@normalgreater
9816 @let\=@normalbackslash
9818 @let_=@normalunderscore
9819 @let|=@normalverticalbar
9821 @markupsetuplqdefault
9822 @markupsetuprqdefault
9826 % Make _ and + \other characters, temporarily.
9827 % This is canceled by @fixbackslash.
9830 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9831 % That is what \eatinput is for; after that, the `\' should revert to printing
9834 @gdef@eatinput input texinfo{@fixbackslash}
9835 @global@let\ = @eatinput
9837 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9838 % the first `\' in the file would cause an error. This macro tries to fix
9839 % that, assuming it is called before the first `\' could plausibly occur.
9840 % Also turn back on active characters that might appear in the input
9841 % file name, in case not using a pre-dumped format.
9843 @gdef@fixbackslash{%
9844 @ifx\@eatinput @let\ = @normalbackslash @fi
9849 % Say @foo, not \foo, in error messages.
9852 % These (along with & and #) are made active for url-breaking, so need
9853 % active definitions as the normal characters.
9858 % These look ok in all fonts, so just make them not special.
9859 @catcode`@& = @other @def@normalamp{&}
9860 @catcode`@# = @other @def@normalhash{#}
9861 @catcode`@% = @other @def@normalpercent{%}
9863 @c Finally, make ` and ' active, so that txicodequoteundirected and
9864 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9865 @c don't make ` and ' active, @code will not get them as active chars.
9866 @c Do this last of all since we use ` in the previous @catcode assignments.
9869 @markupsetuplqdefault
9870 @markupsetuprqdefault
9873 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9874 @c page-delimiter: "^\\\\message"
9875 @c time-stamp-start: "def\\\\texinfoversion{"
9876 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9877 @c time-stamp-end: "}"
9883 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115