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-12-24.11}
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\putworderror\undefined \gdef\putworderror{error}\fi
120 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
121 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
122 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
123 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
124 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
125 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
126 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
127 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
128 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
129 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
130 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
131 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
132 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
133 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
134 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
135 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
136 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
138 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
139 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
140 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
141 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
142 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
143 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
144 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
145 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
146 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
147 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
148 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
149 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
151 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
152 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
153 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
154 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
155 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
157 % Since the category of space is not known, we have to be careful.
158 \chardef\spacecat = 10
159 \def\spaceisspace{\catcode`\ =\spacecat}
161 % sometimes characters are active, so we need control sequences.
162 \chardef\ampChar = `\&
163 \chardef\colonChar = `\:
164 \chardef\commaChar = `\,
165 \chardef\dashChar = `\-
166 \chardef\dotChar = `\.
167 \chardef\exclamChar= `\!
168 \chardef\hashChar = `\#
169 \chardef\lquoteChar= `\`
170 \chardef\questChar = `\?
171 \chardef\rquoteChar= `\'
172 \chardef\semiChar = `\;
173 \chardef\slashChar = `\/
174 \chardef\underChar = `\_
180 % The following is used inside several \edef's.
181 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
185 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
186 ap-pen-dix bit-map bit-maps
187 data-base data-bases eshell fall-ing half-way long-est man-u-script
188 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
189 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
191 stand-alone strong-est time-stamp time-stamps which-ever white-space
192 wide-spread wrap-around
195 % Margin to add to right of even pages, to left of odd pages.
196 \newdimen\bindingoffset
197 \newdimen\normaloffset
198 \newdimen\pagewidth \newdimen\pageheight
200 % For a final copy, take out the rectangles
201 % that mark overfull boxes (in case you have decided
202 % that the text looks ok even though it passes the margin).
204 \def\finalout{\overfullrule=0pt }
206 % Sometimes it is convenient to have everything in the transcript file
207 % and nothing on the terminal. We don't just call \tracingall here,
208 % since that produces some useless output on the terminal. We also make
209 % some effort to order the tracing commands to reduce output in the log
210 % file; cf. trace.sty in LaTeX.
212 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
216 \tracinglostchars2 % 2 gives us more in etex
221 \showboxbreadth\maxdimen \showboxdepth\maxdimen
222 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
229 \tracingcommands3 % 3 gives us more in etex
233 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
234 % aren't perfect, it's not the end of the world, being an error message,
237 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
238 \def\doerrormsg#1{\errmessage{#1}}
240 % add check for \lastpenalty to plain's definitions. If the last thing
241 % we did was a \nobreak, we don't want to insert more space.
243 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
244 \removelastskip\penalty-50\smallskip\fi\fi}
245 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
246 \removelastskip\penalty-100\medskip\fi\fi}
247 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
248 \removelastskip\penalty-200\bigskip\fi\fi}
250 % Do @cropmarks to get crop marks.
253 \let\cropmarks = \cropmarkstrue
255 % Dimensions to add cropmarks at corners.
256 % Added by P. A. MacKay, 12 Nov. 1986
258 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
259 \newdimen\cornerlong \cornerlong=1pc
260 \newdimen\cornerthick \cornerthick=.3pt
261 \newdimen\topandbottommargin \topandbottommargin=.75in
263 % Output a mark which sets \thischapter, \thissection and \thiscolor.
264 % We dump everything together because we only have one kind of mark.
265 % This works because we only use \botmark / \topmark, not \firstmark.
267 % A mark contains a subexpression of the \ifcase ... \fi construct.
268 % \get*marks macros below extract the needed part using \ifcase.
270 % Another complication is to let the user choose whether \thischapter
271 % (\thissection) refers to the chapter (section) in effect at the top
272 % of a page, or that at the bottom of a page. The solution is
273 % described on page 260 of The TeXbook. It involves outputting two
274 % marks for the sectioning macros, one before the section break, and
275 % one after. I won't pretend I can describe this better than DEK...
277 \toks0=\expandafter{\lastchapterdefs}%
278 \toks2=\expandafter{\lastsectiondefs}%
279 \toks4=\expandafter{\prevchapterdefs}%
280 \toks6=\expandafter{\prevsectiondefs}%
281 \toks8=\expandafter{\lastcolordefs}%
283 \the\toks0 \the\toks2
284 \noexpand\or \the\toks4 \the\toks6
285 \noexpand\else \the\toks8
288 % \topmark doesn't work for the very first chapter (after the title
289 % page or the contents), so we use \firstmark there -- this gets us
290 % the mark with the chapter defs, unless the user sneaks in, e.g.,
291 % @setcolor (or @url, or @link, etc.) between @contents and the very
293 \def\gettopheadingmarks{%
295 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
297 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
298 \def\getcolormarks{\ifcase2\topmark\fi}
300 % Avoid "undefined control sequence" errors.
301 \def\lastchapterdefs{}
302 \def\lastsectiondefs{}
303 \def\prevchapterdefs{}
304 \def\prevsectiondefs{}
307 % Main output routine.
309 \output = {\onepageout{\pagecontents\PAGE}}
314 % \onepageout takes a vbox as an argument. Note that \pagecontents
315 % does insertions, but you have to call it yourself.
317 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
319 \ifodd\pageno \advance\hoffset by \bindingoffset
320 \else \advance\hoffset by -\bindingoffset\fi
322 % Do this outside of the \shipout so @code etc. will be expanded in
323 % the headline as they should be, not taken literally (outputting ''code).
324 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
325 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
326 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
327 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
330 % Have to do this stuff outside the \shipout because we want it to
331 % take effect in \write's, yet the group defined by the \vbox ends
332 % before the \shipout runs.
334 \indexdummies % don't expand commands in the output.
335 \normalturnoffactive % \ in index entries must not stay \, e.g., if
336 % the page break happens to be in the middle of an example.
337 % We don't want .vr (or whatever) entries like this:
338 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
339 % "\acronym" won't work when it's read back in;
341 % {\code {{\tt \backslashcurfont }acronym}
343 % Do this early so pdf references go to the beginning of the page.
344 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
346 \ifcropmarks \vbox to \outervsize\bgroup
348 \vskip-\topandbottommargin
350 \line{\ewtop\hfil\ewtop}%
353 \vbox{\moveleft\cornerthick\nstop}%
355 \vbox{\moveright\cornerthick\nstop}%
358 \vskip\topandbottommargin
360 \hfil % center the page within the outer (page) hsize.
361 \ifodd\pageno\hskip\bindingoffset\fi
367 \ifdim\ht\footlinebox > 0pt
368 % Only leave this space if the footline is nonempty.
369 % (We lessened \vsize for it in \oddfootingyyy.)
370 % The \baselineskip=24pt in plain's \makefootline has no effect.
376 \egroup % end of \vbox\bgroup
377 \hfil\egroup % end of (centering) \line\bgroup
378 \vskip\topandbottommargin plus1fill minus1fill
379 \boxmaxdepth = \cornerthick
382 \vbox{\moveleft\cornerthick\nsbot}%
384 \vbox{\moveright\cornerthick\nsbot}%
387 \line{\ewbot\hfil\ewbot}%
389 \egroup % \vbox from first cropmarks clause
391 }% end of \shipout\vbox
392 }% end of group with \indexdummies
394 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
397 \newinsert\margin \dimen\margin=\maxdimen
399 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
401 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
402 % marginal hacks, juha@viisa.uucp (Juha Takala)
403 \ifvoid\margin\else % marginal info is present
404 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
405 \dimen@=\dp#1\relax \unvbox#1\relax
406 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
407 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
410 % Here are the rules for the cropmarks. Note that they are
411 % offset so that the space between them is truly \outerhsize or \outervsize
412 % (P. A. MacKay, 12 November, 1986)
414 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
416 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
417 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
419 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
421 % Parse an argument, then pass it to #1. The argument is the rest of
422 % the input line (except we remove a trailing comment). #1 should be a
423 % macro which expects an ordinary undelimited TeX argument.
425 \def\parsearg{\parseargusing{}}
426 \def\parseargusing#1#2{%
432 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
436 \gdef\parseargline#1^^M{%
437 \endgroup % End of the group started in \parsearg.
438 \argremovecomment #1\comment\ArgTerm%
442 % First remove any @comment, then any @c comment.
443 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
444 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
446 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
448 % \argremovec might leave us with trailing space, e.g.,
449 % @end itemize @c foo
450 % This space token undergoes the same procedure and is eventually removed
451 % by \finishparsearg.
453 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
454 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
455 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
458 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
459 \let\temp\finishparsearg
461 \let\temp\argcheckspaces
463 % Put the space token in:
467 % If a _delimited_ argument is enclosed in braces, they get stripped; so
468 % to get _exactly_ the rest of the line, we had to prevent such situation.
469 % We prepended an \empty token at the very beginning and we expand it now,
470 % just before passing the control to \argtorun.
471 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
472 % either the null string, or it ends with \^^M---thus there is no danger
473 % that a pair of braces would be stripped.
475 % But first, we have to remove the trailing space token.
477 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
479 % \parseargdef\foo{...}
480 % is roughly equivalent to
481 % \def\foo{\parsearg\Xfoo}
484 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
485 % favourite TeX trick. --kasal, 16nov03
488 \expandafter \doparseargdef \csname\string#1\endcsname #1%
490 \def\doparseargdef#1#2{%
495 % Several utility definitions with active space:
500 % Make each space character in the input produce a normal interword
501 % space in the output. Don't allow a line break at this space, as this
502 % is used only in environments like @example, where each line of input
503 % should produce a line of output anyway.
505 \gdef\sepspaces{\obeyspaces\let =\tie}
507 % If an index command is used in an @example environment, any spaces
508 % therein should become regular spaces in the raw index file, not the
509 % expansion of \tie (\leavevmode \penalty \@M \ ).
510 \gdef\unsepspaces{\let =\space}
514 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
516 % Define the framework for environments in texinfo.tex. It's used like this:
521 % It's the responsibility of \envdef to insert \begingroup before the
522 % actual body; @end closes the group after calling \Efoo. \envdef also
523 % defines \thisenv, so the current environment is known; @end checks
524 % whether the environment name matches. The \checkenv macro can also be
525 % used to check whether the current environment is the one expected.
527 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
528 % are not treated as environments; they don't open a group. (The
529 % implementation of @end takes care not to call \endgroup in this
533 % At run-time, environments start with this:
534 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
538 % ... but they get defined via ``\envdef\foo{...}'':
539 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
540 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
542 % Check whether we're in the right environment:
551 % Environment mismatch, #1 expected:
554 \errmessage{This command can appear only \inenvironment\temp,
555 not \inenvironment\thisenv}%
557 \def\inenvironment#1{%
559 outside of any environment%
561 in environment \expandafter\string#1%
565 % @end foo executes the definition of \Efoo.
566 % But first, it executes a specialized version of \checkenv
569 \if 1\csname iscond.#1\endcsname
571 % The general wording of \badenverr may not be ideal.
572 \expandafter\checkenv\csname#1\endcsname
573 \csname E#1\endcsname
578 \newhelp\EMsimple{Press RETURN to continue.}
581 % Be sure we're in horizontal mode when doing a tie, since we make space
582 % equivalent to this in @example-like environments. Otherwise, a space
583 % at the beginning of a line will start with \penalty -- and
584 % since \penalty is valid in vertical mode, we'd end up putting the
585 % penalty on the vertical list instead of in the new paragraph.
587 % Avoid using \@M directly, because that causes trouble
588 % if the definition is written into an index file.
589 \global\let\tiepenalty = \@M
590 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
593 % @: forces normal size whitespace following.
594 \def\:{\spacefactor=1000 }
596 % @* forces a line break.
597 \def\*{\hfil\break\hbox{}\ignorespaces}
599 % @/ allows a line break.
602 % @. is an end-of-sentence period.
603 \def\.{.\spacefactor=\endofsentencespacefactor\space}
605 % @! is an end-of-sentence bang.
606 \def\!{!\spacefactor=\endofsentencespacefactor\space}
608 % @? is an end-of-sentence query.
609 \def\?{?\spacefactor=\endofsentencespacefactor\space}
611 % @frenchspacing on|off says whether to put extra space after punctuation.
616 \parseargdef\frenchspacing{%
618 \ifx\temp\onword \plainfrenchspacing
619 \else\ifx\temp\offword \plainnonfrenchspacing
622 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
626 % @w prevents a word break. Without the \leavevmode, @w at the
627 % beginning of a paragraph, when TeX is still in vertical mode, would
628 % produce a whole line of output instead of starting the paragraph.
629 \def\w#1{\leavevmode\hbox{#1}}
631 % @group ... @end group forces ... to be all on one page, by enclosing
632 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
633 % to keep its height that of a normal line. According to the rules for
634 % \topskip (p.114 of the TeXbook), the glue inserted is
635 % max (\topskip - \ht (first item), 0). If that height is large,
636 % therefore, no glue is inserted, and the space between the headline and
637 % the text is small, which looks bad.
639 % Another complication is that the group might be very large. This can
640 % cause the glue on the previous page to be unduly stretched, because it
641 % does not have much material. In this case, it's better to add an
642 % explicit \vfill so that the extra space is at the bottom. The
643 % threshold for doing this is if the group is more than \vfilllimit
644 % percent of a page (\vfilllimit can be changed inside of @tex).
650 \ifnum\catcode`\^^M=\active \else
651 \errhelp = \groupinvalidhelp
652 \errmessage{@group invalid in context where filling is enabled}%
656 \setbox\groupbox = \vtop\bgroup
657 % Do @comment since we are called inside an environment such as
658 % @example, where each end-of-line in the input causes an
659 % end-of-line in the output. We don't want the end-of-line after
660 % the `@group' to put extra space in the output. Since @group
661 % should appear on a line by itself (according to the Texinfo
662 % manual), we don't worry about eating any user text.
666 % The \vtop produces a box with normal height and large depth; thus, TeX puts
667 % \baselineskip glue before it, and (when the next line of text is done)
668 % \lineskip glue after it. Thus, space below is not quite equal to space
669 % above. But it's pretty close.
671 % To get correct interline space between the last line of the group
672 % and the first line afterwards, we have to propagate \prevdepth.
673 \endgraf % Not \par, as it may have been set to \lisppar.
674 \global\dimen1 = \prevdepth
675 \egroup % End the \vtop.
676 % \dimen0 is the vertical size of the group's box.
677 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
678 % \dimen2 is how much space is left on the page (more or less).
679 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
680 % if the group doesn't fit on the current page, and it's a big big
681 % group, force a page break.
682 \ifdim \dimen0 > \dimen2
683 \ifdim \pagetotal < \vfilllimit\pageheight
692 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
693 % message, so this ends up printing `@group can only ...'.
695 \newhelp\groupinvalidhelp{%
696 group can only be used in environments such as @example,^^J%
697 where each line of input produces a line of output.}
699 % @need space-in-mils
700 % forces a page break if there is not space-in-mils remaining.
702 \newdimen\mil \mil=0.001in
705 % Ensure vertical mode, so we don't make a big box in the middle of a
709 % If the @need value is less than one line space, it's useless.
711 \dimen2 = \ht\strutbox
712 \advance\dimen2 by \dp\strutbox
713 \ifdim\dimen0 > \dimen2
715 % Do a \strut just to make the height of this box be normal, so the
716 % normal leading is inserted relative to the preceding line.
717 % And a page break here is fine.
718 \vtop to #1\mil{\strut\vfil}%
720 % TeX does not even consider page breaks if a penalty added to the
721 % main vertical list is 10000 or more. But in order to see if the
722 % empty box we just added fits on the page, we must make it consider
723 % page breaks. On the other hand, we don't want to actually break the
724 % page after the empty box. So we use a penalty of 9999.
726 % There is an extremely small chance that TeX will actually break the
727 % page at this \penalty, if there are no other feasible breakpoints in
728 % sight. (If the user is using lots of big @group commands, which
729 % almost-but-not-quite fill up a page, TeX will have a hard time doing
730 % good page breaking, for example.) However, I could not construct an
731 % example where a page broke at this \penalty; if it happens in a real
732 % document, then we can reconsider our strategy.
735 % Back up by the size of the box, whether we did a page break or not.
738 % Do not allow a page break right after this kern.
743 % @br forces paragraph break (and is undocumented).
747 % @page forces the start of a new page.
749 \def\page{\par\vfill\supereject}
752 % outputs text on separate line in roman font, starting at standard page margin
754 % This records the amount of indent in the innermost environment.
755 % That's how much \exdent should take out.
756 \newskip\exdentamount
758 % This defn is used inside fill environments such as @defun.
759 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
761 % This defn is used inside nofill environments such as @example.
762 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
763 \leftline{\hskip\leftskip{\rm#1}}}}
765 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
766 % paragraph. For more general purposes, use the \margin insertion
767 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
769 \newskip\inmarginspacing \inmarginspacing=1cm
770 \def\strutdepth{\dp\strutbox}
772 \def\doinmargin#1#2{\strut\vadjust{%
775 \vtop to \strutdepth{%
776 \baselineskip=\strutdepth
778 % if you have multiple lines of stuff to put here, you'll need to
779 % make the vbox yourself of the appropriate size.
781 \llap{\ignorespaces #2\hskip\inmarginspacing}%
783 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
788 \def\inleftmargin{\doinmargin l}
789 \def\inrightmargin{\doinmargin r}
791 % @inmargin{TEXT [, RIGHT-TEXT]}
792 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
793 % else use TEXT for both).
795 \def\inmargin#1{\parseinmargin #1,,\finish}
796 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
797 \setbox0 = \hbox{\ignorespaces #2}%
799 \def\lefttext{#1}% have both texts
802 \def\lefttext{#1}% have only one text
807 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
809 \def\temp{\inleftmargin\lefttext}%
814 % @| inserts a changebar to the left of the current line. It should
815 % surround any changed text. This approach does *not* work if the
816 % change spans more than two lines of output. To handle that, we would
817 % have adopt a much more difficult approach (putting marks into the main
818 % vertical list for the beginning and end of each change). This command
819 % is not documented, not supported, and doesn't work.
822 % \vadjust can only be used in horizontal mode.
825 % Append this vertical mode material after the current line in the output.
827 % We want to insert a rule with the height and depth of the current
828 % leading; that is exactly what \strutbox is supposed to record.
831 % \vadjust-items are inserted at the left edge of the type. So
832 % the \llap here moves out into the left-hand margin.
835 % For a thicker or thinner bar, change the `1pt'.
836 \vrule height\baselineskip width1pt
838 % This is the space between the bar and the text.
844 % @include FILE -- \input text of FILE.
846 \def\include{\parseargusing\filenamecatcodes\includezzz}
851 \makevalueexpandable % we want to expand any @value in FILE.
852 \turnoffactive % and allow special characters in the expansion
853 \indexnofonts % Allow `@@' and other weird things in file names.
854 \wlog{texinfo.tex: doing @include of #1^^J}%
855 \edef\temp{\noexpand\input #1 }%
857 % This trickery is to read FILE outside of a group, in case it makes
863 \def\filenamecatcodes{%
877 \def\pushthisfilestack{%
878 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
880 \def\pushthisfilestackX{%
881 \expandafter\pushthisfilestackY\thisfile\StackTerm
883 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
884 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
887 \def\popthisfilestack{\errthisfilestackempty}
888 \def\errthisfilestackempty{\errmessage{Internal error:
889 the stack of filenames is empty.}}
894 % outputs that line, centered.
896 \parseargdef\center{%
902 \next{\hfil \ignorespaces#1\unskip \hfil}%
907 \advance\hsize by -\leftskip
908 \advance\hsize by -\rightskip
913 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
915 % @sp n outputs n lines of vertical space
917 \parseargdef\sp{\vskip #1\baselineskip}
919 % @comment ...line which is ignored...
920 % @c is the same as @comment
921 % @ignore ... @end ignore is another way to write a comment
923 \def\comment{\begingroup \catcode`\^^M=\other%
924 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
926 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
930 % @paragraphindent NCHARS
931 % We'll use ems for NCHARS, close enough.
932 % NCHARS can also be the word `asis' or `none'.
933 % We cannot feasibly implement @paragraphindent asis, though.
935 \def\asisword{asis} % no translation, these are keywords
938 \parseargdef\paragraphindent{%
943 \defaultparindent = 0pt
945 \defaultparindent = #1em
948 \parindent = \defaultparindent
951 % @exampleindent NCHARS
952 % We'll use ems for NCHARS like @paragraphindent.
953 % It seems @exampleindent asis isn't necessary, but
954 % I preserve it to make it similar to @paragraphindent.
955 \parseargdef\exampleindent{%
962 \lispnarrowing = #1em
967 % @firstparagraphindent WORD
968 % If WORD is `none', then suppress indentation of the first paragraph
969 % after a section heading. If WORD is `insert', then do indent at such
972 % The paragraph indentation is suppressed or not by calling
973 % \suppressfirstparagraphindent, which the sectioning commands do.
974 % We switch the definition of this back and forth according to WORD.
975 % By default, we suppress indentation.
977 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
978 \def\insertword{insert}
980 \parseargdef\firstparagraphindent{%
983 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
984 \else\ifx\temp\insertword
985 \let\suppressfirstparagraphindent = \relax
988 \errmessage{Unknown @firstparagraphindent option `\temp'}%
992 % Here is how we actually suppress indentation. Redefine \everypar to
993 % \kern backwards by \parindent, and then reset itself to empty.
995 % We also make \indent itself not actually do anything until the next
998 \gdef\dosuppressfirstparagraphindent{%
1000 \restorefirstparagraphindent
1004 \restorefirstparagraphindent
1007 \global\everypar = {%
1009 \restorefirstparagraphindent
1013 \gdef\restorefirstparagraphindent{%
1014 \global \let \indent = \ptexindent
1015 \global \let \noindent = \ptexnoindent
1016 \global \everypar = {}%
1020 % @refill is a no-op.
1023 % If working on a large document in chapters, it is convenient to
1024 % be able to disable indexing, cross-referencing, and contents, for test runs.
1025 % This is done with @novalidate (before @setfilename).
1027 \newif\iflinks \linkstrue % by default we want the aux files.
1028 \let\novalidate = \linksfalse
1030 % @setfilename is done at the beginning of every texinfo file.
1031 % So open here the files we need to have open while reading the input.
1032 % This makes it possible to make a .fmt file for texinfo.
1034 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1037 % Open the new aux file. TeX will close it automatically at exit.
1038 \immediate\openout\auxfile=\jobname.aux
1039 \fi % \openindices needs to do some work in any case.
1041 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1043 % If texinfo.cnf is present on the system, read it.
1044 % Useful for site-wide @afourpaper, etc.
1045 \openin 1 texinfo.cnf
1046 \ifeof 1 \else \input texinfo.cnf \fi
1049 \comment % Ignore the actual filename.
1052 % Called from \setfilename.
1064 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1068 % adobe `portable' document format
1072 \newcount\filenamelength
1081 \newif\ifpdfmakepagedest
1083 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1084 % can be set). So we test for \relax and 0 as well as being undefined.
1085 \ifx\pdfoutput\thisisundefined
1087 \ifx\pdfoutput\relax
1096 % PDF uses PostScript string constants for the names of xref targets,
1097 % for display in the outlines, and in other places. Thus, we have to
1098 % double any backslashes. Otherwise, a name like "\node" will be
1099 % interpreted as a newline (\n), followed by o, d, e. Not good.
1101 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1102 % related messages. The final outcome is that it is up to the TeX user
1103 % to double the backslashes and otherwise make the string valid, so
1104 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1105 % do this reliably, so we use it.
1107 % #1 is a control sequence in which to do the replacements,
1109 \def\txiescapepdf#1{%
1110 \ifx\pdfescapestring\relax
1111 % No primitive available; should we give a warning or log?
1112 % Many times it won't matter.
1114 % The expandable \pdfescapestring primitive escapes parentheses,
1115 % backslashes, and other special chars.
1116 \xdef#1{\pdfescapestring{#1}}%
1120 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1121 with PDF output, and none of those formats could be found. (.eps cannot
1122 be supported due to the design of the PDF format; use regular TeX (DVI
1127 % Color manipulation macros based on pdfcolor.tex,
1128 % except using rgb instead of cmyk; the latter is said to render as a
1129 % very dark gray on-screen and a very dark halftone in print, instead
1131 \def\rgbDarkRed{0.50 0.09 0.12}
1132 \def\rgbBlack{0 0 0}
1134 % k sets the color for filling (usual text, etc.);
1135 % K sets the color for stroking (thin rules, e.g., normal _'s).
1136 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1138 % Set color, and create a mark which defines \thiscolor accordingly,
1139 % so that \makeheadline knows which color to restore.
1141 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1146 \def\maincolor{\rgbBlack}
1147 \pdfsetcolor{\maincolor}
1148 \edef\thiscolor{\maincolor}
1149 \def\lastcolordefs{}
1153 \line{\pdfsetcolor{\maincolor}\the\footline}%
1161 % Extract \thiscolor definition from the marks.
1163 % Typeset the headline with \maincolor, then restore the color.
1164 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1172 \pdfcatalog{/PageMode /UseOutlines}
1174 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1175 \def\dopdfimage#1#2#3{%
1176 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1177 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1179 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1180 % others). Let's try in that order, PDF first since if
1181 % someone has a scalable image, presumably better to use that than a
1183 \let\pdfimgext=\empty
1185 \openin 1 #1.pdf \ifeof 1
1186 \openin 1 #1.PDF \ifeof 1
1187 \openin 1 #1.png \ifeof 1
1188 \openin 1 #1.jpg \ifeof 1
1189 \openin 1 #1.jpeg \ifeof 1
1190 \openin 1 #1.JPG \ifeof 1
1191 \errhelp = \nopdfimagehelp
1192 \errmessage{Could not find image file #1 for pdf}%
1193 \else \gdef\pdfimgext{JPG}%
1195 \else \gdef\pdfimgext{jpeg}%
1197 \else \gdef\pdfimgext{jpg}%
1199 \else \gdef\pdfimgext{png}%
1201 \else \gdef\pdfimgext{PDF}%
1203 \else \gdef\pdfimgext{pdf}%
1208 % without \immediate, ancient pdftex seg faults when the same image is
1209 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1210 \ifnum\pdftexversion < 14
1213 \immediate\pdfximage
1215 \ifdim \wd0 >0pt width \imagewidth \fi
1216 \ifdim \wd2 >0pt height \imageheight \fi
1217 \ifnum\pdftexversion<13
1222 \ifnum\pdftexversion < 14 \else
1223 \pdfrefximage \pdflastximage
1227 % We have to set dummies so commands such as @code, and characters
1228 % such as \, aren't expanded when present in a section title.
1231 \makevalueexpandable
1232 \def\pdfdestname{#1}%
1233 \txiescapepdf\pdfdestname
1234 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1237 % used to mark target names; must be expandable.
1240 % by default, use a color that is dark enough to print on paper as
1241 % nearly black, but still distinguishable for online viewing.
1242 \def\urlcolor{\rgbDarkRed}
1243 \def\linkcolor{\rgbDarkRed}
1244 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1246 % Adding outlines to PDF; macros for calculating structure of outlines
1247 % come from Petr Olsak
1248 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1249 \else \csname#1\endcsname \fi}
1250 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1251 \advance\tempnum by 1
1252 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1254 % #1 is the section text, which is what will be displayed in the
1255 % outline by the pdf viewer. #2 is the pdf expression for the number
1256 % of subentries (or empty, for subsubsections). #3 is the node text,
1257 % which might be empty if this toc entry had no corresponding node.
1258 % #4 is the page number
1260 \def\dopdfoutline#1#2#3#4{%
1261 % Generate a link to the node text if that exists; else, use the
1262 % page number. We could generate a destination for the section
1263 % text in the case where a section has no node, but it doesn't
1264 % seem worth the trouble, since most documents are normally structured.
1265 \edef\pdfoutlinedest{#3}%
1266 \ifx\pdfoutlinedest\empty
1267 \def\pdfoutlinedest{#4}%
1269 \txiescapepdf\pdfoutlinedest
1272 % Also escape PDF chars in the display string.
1273 \edef\pdfoutlinetext{#1}%
1274 \txiescapepdf\pdfoutlinetext
1276 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1279 \def\pdfmakeoutlines{%
1281 % Read toc silently, to get counts of subentries for \pdfoutline.
1282 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1283 \def\numchapentry##1##2##3##4{%
1284 \def\thischapnum{##2}%
1286 \def\thissubsecnum{0}%
1288 \def\numsecentry##1##2##3##4{%
1289 \advancenumber{chap\thischapnum}%
1290 \def\thissecnum{##2}%
1291 \def\thissubsecnum{0}%
1293 \def\numsubsecentry##1##2##3##4{%
1294 \advancenumber{sec\thissecnum}%
1295 \def\thissubsecnum{##2}%
1297 \def\numsubsubsecentry##1##2##3##4{%
1298 \advancenumber{subsec\thissubsecnum}%
1300 \def\thischapnum{0}%
1302 \def\thissubsecnum{0}%
1304 % use \def rather than \let here because we redefine \chapentry et
1305 % al. a second time, below.
1306 \def\appentry{\numchapentry}%
1307 \def\appsecentry{\numsecentry}%
1308 \def\appsubsecentry{\numsubsecentry}%
1309 \def\appsubsubsecentry{\numsubsubsecentry}%
1310 \def\unnchapentry{\numchapentry}%
1311 \def\unnsecentry{\numsecentry}%
1312 \def\unnsubsecentry{\numsubsecentry}%
1313 \def\unnsubsubsecentry{\numsubsubsecentry}%
1316 % Read toc second time, this time actually producing the outlines.
1317 % The `-' means take the \expnumber as the absolute number of
1318 % subentries, which we calculated on our first read of the .toc above.
1320 % We use the node names as the destinations.
1321 \def\numchapentry##1##2##3##4{%
1322 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1323 \def\numsecentry##1##2##3##4{%
1324 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1325 \def\numsubsecentry##1##2##3##4{%
1326 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1327 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1328 \dopdfoutline{##1}{}{##3}{##4}}%
1330 % PDF outlines are displayed using system fonts, instead of
1331 % document fonts. Therefore we cannot use special characters,
1332 % since the encoding is unknown. For example, the eogonek from
1333 % Latin 2 (0xea) gets translated to a | character. Info from
1334 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1336 % TODO this right, we have to translate 8-bit characters to
1337 % their "best" equivalent, based on the @documentencoding. Too
1338 % much work for too little return. Just use the ASCII equivalents
1339 % we use for the index sort strings.
1343 % We can have normal brace characters in the PDF outlines, unlike
1344 % Texinfo index files. So set that up.
1345 \def\{{\lbracecharliteral}%
1346 \def\}{\rbracecharliteral}%
1347 \catcode`\\=\active \otherbackslash
1348 \input \tocreadfilename
1351 {\catcode`[=1 \catcode`]=2
1352 \catcode`{=\other \catcode`}=\other
1353 \gdef\lbracecharliteral[{]%
1354 \gdef\rbracecharliteral[}]%
1357 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1358 \ifx\PP\D\let\nextsp\relax
1359 \else\let\nextsp\skipspaces
1360 \ifx\p\space\else\addtokens{\filename}{\PP}%
1361 \advance\filenamelength by 1
1365 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1366 \ifnum\pdftexversion < 14
1367 \let \startlink \pdfannotlink
1369 \let \startlink \pdfstartlink
1371 % make a live url in pdf output.
1374 % it seems we really need yet another set of dummies; have not
1375 % tried to figure out what each command should do in the context
1376 % of @url. for now, just make @/ a no-op, that's the only one
1377 % people have actually reported a problem with.
1379 \normalturnoffactive
1382 \makevalueexpandable
1383 % do we want to go so far as to use \indexnofonts instead of just
1384 % special-casing \var here?
1387 \leavevmode\setcolor{\urlcolor}%
1388 \startlink attr{/Border [0 0 0]}%
1389 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1391 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1392 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1393 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1394 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1396 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1398 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1399 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1400 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1402 \ifnum0=\countA\else\makelink\fi
1403 \ifx\first.\let\next=\done\else
1405 \addtokens{\toksB}{\the\toksD}
1406 \ifx\first,\addtokens{\toksB}{\space}\fi
1408 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1410 \def\makelink{\addtokens{\toksB}%
1411 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1413 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1414 \setcolor{\linkcolor}#1\endlink}
1415 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1418 \let\pdfmkdest = \gobble
1419 \let\pdfurl = \gobble
1420 \let\endlink = \relax
1421 \let\setcolor = \gobble
1422 \let\pdfsetcolor = \gobble
1423 \let\pdfmakeoutlines = \relax
1424 \fi % \ifx\pdfoutput
1429 % Change the current font style to #1, remembering it in \curfontstyle.
1430 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1431 % italics, not bold italics.
1433 \def\setfontstyle#1{%
1434 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1435 \csname ten#1\endcsname % change the current font
1438 % Select #1 fonts with the current style.
1440 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1442 \def\rm{\fam=0 \setfontstyle{rm}}
1443 \def\it{\fam=\itfam \setfontstyle{it}}
1444 \def\sl{\fam=\slfam \setfontstyle{sl}}
1445 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1446 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1448 % Unfortunately, we have to override this for titles and the like, since
1449 % in those cases "rm" is bold. Sigh.
1450 \def\rmisbold{\rm\def\curfontstyle{bf}}
1452 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1453 % So we set up a \sf.
1455 \def\sf{\fam=\sffam \setfontstyle{sf}}
1456 \let\li = \sf % Sometimes we call it \li, not \sf.
1458 % We don't need math for this font style.
1459 \def\ttsl{\setfontstyle{ttsl}}
1463 \newdimen\textleading \textleading = 13.2pt
1465 % Set the baselineskip to #1, and the lineskip and strut size
1466 % correspondingly. There is no deep meaning behind these magic numbers
1467 % used as factors; they just match (closely enough) what Knuth defined.
1469 \def\lineskipfactor{.08333}
1470 \def\strutheightpercent{.70833}
1471 \def\strutdepthpercent {.29167}
1473 % can get a sort of poor man's double spacing by redefining this.
1474 \def\baselinefactor{1}
1478 \normalbaselineskip = \baselinefactor\dimen0
1479 \normallineskip = \lineskipfactor\normalbaselineskip
1481 \setbox\strutbox =\hbox{%
1482 \vrule width0pt height\strutheightpercent\baselineskip
1483 depth \strutdepthpercent \baselineskip
1487 % PDF CMaps. See also LaTeX's t1.cmap.
1489 % do nothing with this by default.
1490 \expandafter\let\csname cmapOT1\endcsname\gobble
1491 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1492 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1494 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1495 % (\pdffontattr was introduced many years ago, but people still run
1496 % older pdftex's; it's easy to conditionalize, so we do.)
1497 \ifpdf \ifx\pdffontattr\thisisundefined \else
1499 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1500 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1501 %%DocumentNeededResources: ProcSet (CIDInit)
1502 %%IncludeResource: ProcSet (CIDInit)
1503 %%BeginResource: CMap (TeX-OT1-0)
1504 %%Title: (TeX-OT1-0 TeX OT1 0)
1507 /CIDInit /ProcSet findresource begin
1515 /CMapName /TeX-OT1-0 def
1517 1 begincodespacerange
1573 CMapName currentdict /CMap defineresource pop
1579 \expandafter\edef\csname cmapOT1\endcsname#1{%
1580 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1585 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1586 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1587 %%DocumentNeededResources: ProcSet (CIDInit)
1588 %%IncludeResource: ProcSet (CIDInit)
1589 %%BeginResource: CMap (TeX-OT1IT-0)
1590 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1593 /CIDInit /ProcSet findresource begin
1601 /CMapName /TeX-OT1IT-0 def
1603 1 begincodespacerange
1661 CMapName currentdict /CMap defineresource pop
1667 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1668 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1673 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1674 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1675 %%DocumentNeededResources: ProcSet (CIDInit)
1676 %%IncludeResource: ProcSet (CIDInit)
1677 %%BeginResource: CMap (TeX-OT1TT-0)
1678 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1681 /CIDInit /ProcSet findresource begin
1689 /CMapName /TeX-OT1TT-0 def
1691 1 begincodespacerange
1736 CMapName currentdict /CMap defineresource pop
1742 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1743 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1748 % Set the font macro #1 to the font named #2, adding on the
1749 % specified font prefix (normally `cm').
1750 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1751 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1753 \def\setfont#1#2#3#4#5{%
1754 \font#1=\fontprefix#2#3 scaled #4
1755 \csname cmap#5\endcsname#1%
1757 % This is what gets called when #5 of \setfont is empty.
1759 % emacs-page end of cmaps
1761 % Use cm as the default font prefix.
1762 % To specify the font prefix, you must define \fontprefix
1763 % before you read in texinfo.tex.
1764 \ifx\fontprefix\thisisundefined
1767 % Support font families that don't use the same naming scheme as CM.
1769 \def\rmbshape{bx} %where the normal face is bold
1774 \def\ttslshape{sltt}
1784 % Definitions for a main text size of 11pt. This is the default in
1787 \def\definetextfontsizexi{%
1788 % Text fonts (11.2pt, magstep1).
1789 \def\textnominalsize{11pt}
1790 \edef\mainmagstep{\magstephalf}
1791 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1792 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1793 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1794 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1795 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1796 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1797 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1798 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1799 \font\texti=cmmi10 scaled \mainmagstep
1800 \font\textsy=cmsy10 scaled \mainmagstep
1801 \def\textecsize{1095}
1803 % A few fonts for @defun names and args.
1804 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1805 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1806 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1807 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1809 % Fonts for indices, footnotes, small examples (9pt).
1810 \def\smallnominalsize{9pt}
1811 \setfont\smallrm\rmshape{9}{1000}{OT1}
1812 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1813 \setfont\smallbf\bfshape{10}{900}{OT1}
1814 \setfont\smallit\itshape{9}{1000}{OT1IT}
1815 \setfont\smallsl\slshape{9}{1000}{OT1}
1816 \setfont\smallsf\sfshape{9}{1000}{OT1}
1817 \setfont\smallsc\scshape{10}{900}{OT1}
1818 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1821 \def\smallecsize{0900}
1823 % Fonts for small examples (8pt).
1824 \def\smallernominalsize{8pt}
1825 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1826 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1827 \setfont\smallerbf\bfshape{10}{800}{OT1}
1828 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1829 \setfont\smallersl\slshape{8}{1000}{OT1}
1830 \setfont\smallersf\sfshape{8}{1000}{OT1}
1831 \setfont\smallersc\scshape{10}{800}{OT1}
1832 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1833 \font\smalleri=cmmi8
1834 \font\smallersy=cmsy8
1835 \def\smallerecsize{0800}
1837 % Fonts for title page (20.4pt):
1838 \def\titlenominalsize{20pt}
1839 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1840 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1841 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1842 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1843 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1844 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1845 \let\titlebf=\titlerm
1846 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1847 \font\titlei=cmmi12 scaled \magstep3
1848 \font\titlesy=cmsy10 scaled \magstep4
1849 \def\titleecsize{2074}
1851 % Chapter (and unnumbered) fonts (17.28pt).
1852 \def\chapnominalsize{17pt}
1853 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1854 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1855 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1856 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1857 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1858 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1860 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1861 \font\chapi=cmmi12 scaled \magstep2
1862 \font\chapsy=cmsy10 scaled \magstep3
1863 \def\chapecsize{1728}
1865 % Section fonts (14.4pt).
1866 \def\secnominalsize{14pt}
1867 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1868 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1869 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1870 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1871 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1872 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1874 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1875 \font\seci=cmmi12 scaled \magstep1
1876 \font\secsy=cmsy10 scaled \magstep2
1877 \def\sececsize{1440}
1879 % Subsection fonts (13.15pt).
1880 \def\ssecnominalsize{13pt}
1881 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1882 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1883 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1884 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1885 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1886 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1888 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1889 \font\sseci=cmmi12 scaled \magstephalf
1890 \font\ssecsy=cmsy10 scaled 1315
1891 \def\ssececsize{1200}
1893 % Reduced fonts for @acro in text (10pt).
1894 \def\reducednominalsize{10pt}
1895 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1896 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1897 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1898 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1899 \setfont\reducedsl\slshape{10}{1000}{OT1}
1900 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1901 \setfont\reducedsc\scshape{10}{1000}{OT1}
1902 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1903 \font\reducedi=cmmi10
1904 \font\reducedsy=cmsy10
1905 \def\reducedecsize{1000}
1907 \textleading = 13.2pt % line spacing for 11pt CM
1908 \textfonts % reset the current fonts
1910 } % end of 11pt text font size definitions
1913 % Definitions to make the main text be 10pt Computer Modern, with
1914 % section, chapter, etc., sizes following suit. This is for the GNU
1915 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1916 % future. Used with @smallbook, which sets the leading to 12pt.
1918 \def\definetextfontsizex{%
1919 % Text fonts (10pt).
1920 \def\textnominalsize{10pt}
1921 \edef\mainmagstep{1000}
1922 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1923 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1924 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1925 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1926 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1927 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1928 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1929 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1930 \font\texti=cmmi10 scaled \mainmagstep
1931 \font\textsy=cmsy10 scaled \mainmagstep
1932 \def\textecsize{1000}
1934 % A few fonts for @defun names and args.
1935 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1936 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1937 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1938 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1940 % Fonts for indices, footnotes, small examples (9pt).
1941 \def\smallnominalsize{9pt}
1942 \setfont\smallrm\rmshape{9}{1000}{OT1}
1943 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1944 \setfont\smallbf\bfshape{10}{900}{OT1}
1945 \setfont\smallit\itshape{9}{1000}{OT1IT}
1946 \setfont\smallsl\slshape{9}{1000}{OT1}
1947 \setfont\smallsf\sfshape{9}{1000}{OT1}
1948 \setfont\smallsc\scshape{10}{900}{OT1}
1949 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1952 \def\smallecsize{0900}
1954 % Fonts for small examples (8pt).
1955 \def\smallernominalsize{8pt}
1956 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1957 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1958 \setfont\smallerbf\bfshape{10}{800}{OT1}
1959 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1960 \setfont\smallersl\slshape{8}{1000}{OT1}
1961 \setfont\smallersf\sfshape{8}{1000}{OT1}
1962 \setfont\smallersc\scshape{10}{800}{OT1}
1963 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1964 \font\smalleri=cmmi8
1965 \font\smallersy=cmsy8
1966 \def\smallerecsize{0800}
1968 % Fonts for title page (20.4pt):
1969 \def\titlenominalsize{20pt}
1970 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1971 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1972 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1973 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1974 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1975 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1976 \let\titlebf=\titlerm
1977 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1978 \font\titlei=cmmi12 scaled \magstep3
1979 \font\titlesy=cmsy10 scaled \magstep4
1980 \def\titleecsize{2074}
1982 % Chapter fonts (14.4pt).
1983 \def\chapnominalsize{14pt}
1984 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
1985 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
1986 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
1987 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
1988 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
1989 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
1991 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
1992 \font\chapi=cmmi12 scaled \magstep1
1993 \font\chapsy=cmsy10 scaled \magstep2
1994 \def\chapecsize{1440}
1996 % Section fonts (12pt).
1997 \def\secnominalsize{12pt}
1998 \setfont\secrm\rmbshape{12}{1000}{OT1}
1999 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2000 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2001 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2002 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2003 \setfont\secsf\sfbshape{12}{1000}{OT1}
2005 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2007 \font\secsy=cmsy10 scaled \magstep1
2008 \def\sececsize{1200}
2010 % Subsection fonts (10pt).
2011 \def\ssecnominalsize{10pt}
2012 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2013 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2014 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2015 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2016 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2017 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2019 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2022 \def\ssececsize{1000}
2024 % Reduced fonts for @acro in text (9pt).
2025 \def\reducednominalsize{9pt}
2026 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2027 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2028 \setfont\reducedbf\bfshape{10}{900}{OT1}
2029 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2030 \setfont\reducedsl\slshape{9}{1000}{OT1}
2031 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2032 \setfont\reducedsc\scshape{10}{900}{OT1}
2033 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2034 \font\reducedi=cmmi9
2035 \font\reducedsy=cmsy9
2036 \def\reducedecsize{0900}
2038 \divide\parskip by 2 % reduce space between paragraphs
2039 \textleading = 12pt % line spacing for 10pt CM
2040 \textfonts % reset the current fonts
2042 } % end of 10pt text font size definitions
2045 % We provide the user-level command
2047 % (or 11) to redefine the text font size. pt is assumed.
2053 \parseargdef\fonttextsize{%
2054 \def\textsizearg{#1}%
2055 %\wlog{doing @fonttextsize \textsizearg}%
2057 % Set \globaldefs so that documents can use this inside @tex, since
2058 % makeinfo 4.8 does not support it, but we need it nonetheless.
2060 \begingroup \globaldefs=1
2061 \ifx\textsizearg\xword \definetextfontsizex
2062 \else \ifx\textsizearg\xiword \definetextfontsizexi
2065 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2071 % In order for the font changes to affect most math symbols and letters,
2072 % we have to define the \textfont of the standard families. Since
2073 % texinfo doesn't allow for producing subscripts and superscripts except
2074 % in the main text, we don't bother to reset \scriptfont and
2075 % \scriptscriptfont (which would also require loading a lot more fonts).
2077 \def\resetmathfonts{%
2078 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2079 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2080 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2083 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2084 % of just \STYLE. We do this because \STYLE needs to also set the
2085 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2086 % \tenSTYLE to set the current font.
2088 % Each font-changing command also sets the names \lsize (one size lower)
2089 % and \lllsize (three sizes lower). These relative commands are used in
2090 % the LaTeX logo and acronyms.
2092 % This all needs generalizing, badly.
2095 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2096 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2097 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2098 \let\tenttsl=\textttsl
2099 \def\curfontsize{text}%
2100 \def\lsize{reduced}\def\lllsize{smaller}%
2101 \resetmathfonts \setleading{\textleading}}
2103 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2104 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2105 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2106 \let\tenttsl=\titlettsl
2107 \def\curfontsize{title}%
2108 \def\lsize{chap}\def\lllsize{subsec}%
2109 \resetmathfonts \setleading{27pt}}
2110 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2112 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2113 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2114 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2115 \let\tenttsl=\chapttsl
2116 \def\curfontsize{chap}%
2117 \def\lsize{sec}\def\lllsize{text}%
2118 \resetmathfonts \setleading{19pt}}
2120 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2121 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2122 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2123 \let\tenttsl=\secttsl
2124 \def\curfontsize{sec}%
2125 \def\lsize{subsec}\def\lllsize{reduced}%
2126 \resetmathfonts \setleading{16pt}}
2128 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2129 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2130 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2131 \let\tenttsl=\ssecttsl
2132 \def\curfontsize{ssec}%
2133 \def\lsize{text}\def\lllsize{small}%
2134 \resetmathfonts \setleading{15pt}}
2135 \let\subsubsecfonts = \subsecfonts
2137 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2138 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2139 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2140 \let\tenttsl=\reducedttsl
2141 \def\curfontsize{reduced}%
2142 \def\lsize{small}\def\lllsize{smaller}%
2143 \resetmathfonts \setleading{10.5pt}}
2145 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2146 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2147 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2148 \let\tenttsl=\smallttsl
2149 \def\curfontsize{small}%
2150 \def\lsize{smaller}\def\lllsize{smaller}%
2151 \resetmathfonts \setleading{10.5pt}}
2153 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2154 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2155 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2156 \let\tenttsl=\smallerttsl
2157 \def\curfontsize{smaller}%
2158 \def\lsize{smaller}\def\lllsize{smaller}%
2159 \resetmathfonts \setleading{9.5pt}}
2161 % Fonts for short table of contents.
2162 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2163 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2164 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2165 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2167 % Define these just so they can be easily changed for other fonts.
2168 \def\angleleft{$\langle$}
2169 \def\angleright{$\rangle$}
2171 % Set the fonts to use with the @small... environments.
2172 \let\smallexamplefonts = \smallfonts
2174 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2175 % can fit this many characters:
2176 % 8.5x11=86 smallbook=72 a4=90 a5=69
2177 % If we use \scriptfonts (8pt), then we can fit this many characters:
2178 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2179 % For me, subjectively, the few extra characters that fit aren't worth
2180 % the additional smallness of 8pt. So I'm making the default 9pt.
2182 % By the way, for comparison, here's what fits with @example (10pt):
2183 % 8.5x11=71 smallbook=60 a4=75 a5=58
2186 % Set up the default fonts, so we can use them for creating boxes.
2188 \definetextfontsizexi
2193 % Check if we are currently using a typewriter font. Since all the
2194 % Computer Modern typewriter fonts have zero interword stretch (and
2195 % shrink), and it is reasonable to expect all typewriter fonts to have
2196 % this property, we can check that font parameter.
2198 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2200 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2201 % define and register \INITMACRO to be called on markup style changes.
2202 % \INITMACRO can check \currentmarkupstyle for the innermost
2203 % style and the set of \ifmarkupSTYLE switches for all styles
2204 % currently in effect.
2208 %\newif\ifmarkupfile % @file == @samp.
2209 %\newif\ifmarkupoption % @option == @samp.
2212 %\newif\ifmarkupenv % @env == @code.
2213 %\newif\ifmarkupcommand % @command == @code.
2214 \newif\ifmarkuptex % @tex (and part of @math, for now).
2215 \newif\ifmarkupexample
2217 \newif\ifmarkupverbatim
2219 \let\currentmarkupstyle\empty
2221 \def\setupmarkupstyle#1{%
2222 \csname markup#1true\endcsname
2223 \def\currentmarkupstyle{#1}%
2227 \let\markupstylesetup\empty
2229 \def\defmarkupstylesetup#1{%
2230 \expandafter\def\expandafter\markupstylesetup
2231 \expandafter{\markupstylesetup #1}%
2235 % Markup style setup for left and right quotes.
2236 \defmarkupstylesetup\markupsetuplq{%
2237 \expandafter\let\expandafter \temp
2238 \csname markupsetuplq\currentmarkupstyle\endcsname
2239 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2242 \defmarkupstylesetup\markupsetuprq{%
2243 \expandafter\let\expandafter \temp
2244 \csname markupsetuprq\currentmarkupstyle\endcsname
2245 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2252 \gdef\markupsetuplqdefault{\let`\lq}
2253 \gdef\markupsetuprqdefault{\let'\rq}
2255 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2256 \gdef\markupsetcodequoteright{\let'\codequoteright}
2258 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2261 \let\markupsetuplqcode \markupsetcodequoteleft
2262 \let\markupsetuprqcode \markupsetcodequoteright
2264 \let\markupsetuplqexample \markupsetcodequoteleft
2265 \let\markupsetuprqexample \markupsetcodequoteright
2267 \let\markupsetuplqsamp \markupsetcodequoteleft
2268 \let\markupsetuprqsamp \markupsetcodequoteright
2270 \let\markupsetuplqverb \markupsetcodequoteleft
2271 \let\markupsetuprqverb \markupsetcodequoteright
2273 \let\markupsetuplqverbatim \markupsetcodequoteleft
2274 \let\markupsetuprqverbatim \markupsetcodequoteright
2276 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2278 % Allow an option to not use regular directed right quote/apostrophe
2279 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2280 % The undirected quote is ugly, so don't make it the default, but it
2281 % works for pasting with more pdf viewers (at least evince), the
2282 % lilypond developers report. xpdf does work with the regular 0x27.
2284 \def\codequoteright{%
2285 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2286 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2292 % and a similar option for the left quote char vs. a grave accent.
2293 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2294 % the code environments to do likewise.
2296 \def\codequoteleft{%
2297 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2298 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2299 % [Knuth] pp. 380,381,391
2300 % \relax disables Spanish ligatures ?` and !` of \tt font.
2306 % Commands to set the quote options.
2308 \parseargdef\codequoteundirected{%
2311 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2313 \else\ifx\temp\offword
2314 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2317 \errhelp = \EMsimple
2318 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2322 \parseargdef\codequotebacktick{%
2325 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2327 \else\ifx\temp\offword
2328 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2331 \errhelp = \EMsimple
2332 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2336 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2337 \def\noligaturesquoteleft{\relax\lq}
2339 % Count depth in font-changes, for error checks
2340 \newcount\fontdepth \fontdepth=0
2344 % #1 is the font command (\sl or \it), #2 is the text to slant.
2345 % If we are in a monospaced environment, however, 1) always use \ttsl,
2346 % and 2) do not add an italic correction.
2347 \def\dosmartslant#1#2{%
2349 {{\ttsl #2}\let\next=\relax}%
2350 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2353 \def\smartslanted{\dosmartslant\sl}
2354 \def\smartitalic{\dosmartslant\it}
2356 % Output an italic correction unless \next (presumed to be the following
2357 % character) is such as not to need one.
2358 \def\smartitaliccorrection{%
2367 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2368 % @var is set to this for defun arguments.
2369 \def\ttslanted#1{{\ttsl #1}}
2371 % @cite is like \smartslanted except unconditionally use \sl. We never want
2372 % ttsl for book titles, do we?
2373 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2377 \let\saveaftersmartic = \aftersmartic
2378 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2383 \let\slanted=\smartslanted
2384 \let\dfn=\smartslanted
2385 \let\emph=\smartitalic
2387 % Explicit font changes: @r, @sc, undocumented @ii.
2388 \def\r#1{{\rm #1}} % roman font
2389 \def\sc#1{{\smallcaps#1}} % smallcaps font
2390 \def\ii#1{{\it #1}} % italic font
2392 % @b, explicit bold. Also @strong.
2396 % @sansserif, explicit sans.
2397 \def\sansserif#1{{\sf #1}}
2399 % We can't just use \exhyphenpenalty, because that only has effect at
2400 % the end of a paragraph. Restore normal hyphenation at the end of the
2401 % group within which \nohyphenation is presumably called.
2403 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2404 \def\restorehyphenation{\hyphenchar\font = `- }
2406 % Set sfcode to normal for the chars that usually have another value.
2407 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2408 % sometimes \x has an active definition that messes things up.
2411 \def\plainfrenchspacing{%
2412 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2413 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2414 \def\endofsentencespacefactor{1000}% for @. and friends
2416 \def\plainnonfrenchspacing{%
2417 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2418 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2419 \def\endofsentencespacefactor{3000}% for @. and friends
2422 \def\endofsentencespacefactor{3000}% default
2424 % @t, explicit typewriter.
2426 {\tt \rawbackslash \plainfrenchspacing #1}%
2431 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2433 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2434 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2436 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2437 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2438 % \vbox{\hrule\kern-0.4pt
2439 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2440 % \kern-0.4pt\hrule}%
2441 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2443 % definition of @key with no lozenge. If the current font is already
2444 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2445 % if it isn't monospace, then use \tt.
2447 \def\key#1{{\setupmarkupstyle{key}%
2449 \ifmonospace\else\tt\fi
2452 % ctrl is no longer a Texinfo command.
2453 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2455 % @file, @option are the same as @samp.
2459 % @code is a modification of @t,
2460 % which makes spaces the same size as normal in the surrounding text.
2463 % Change normal interword space to be same as for the current font.
2464 \spaceskip = \fontdimen2\font
2466 % Switch to typewriter.
2469 % But `\ ' produces the large typewriter interword space.
2470 \def\ {{\spaceskip = 0pt{} }}%
2472 % Turn off hyphenation.
2479 \null % reset spacefactor to 1000
2482 % We *must* turn on hyphenation at `-' and `_' in @code.
2483 % Otherwise, it is too hard to avoid overfull hboxes
2484 % in the Emacs manual, the Library manual, etc.
2486 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2487 % both hyphenation at - and hyphenation within words.
2488 % We must therefore turn them both off (\tclose does that)
2489 % and arrange explicitly to hyphenate at a dash.
2492 \catcode`\-=\active \catcode`\_=\active
2493 \catcode`\'=\active \catcode`\`=\active
2494 \global\let'=\rq \global\let`=\lq % default definitions
2496 \global\def\code{\begingroup
2497 \setupmarkupstyle{code}%
2498 % The following should really be moved into \setupmarkupstyle handlers.
2499 \catcode\dashChar=\active \catcode\underChar=\active
2511 \def\codex #1{\tclose{#1}\endgroup}
2514 \def\codedash{-\discretionary{}{}{}}
2516 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2517 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2518 % will therefore expand the active definition of _, which is us
2519 % (inside @code that is), therefore an endless loop.
2521 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2522 \else\normalunderscore \fi
2523 \discretionary{}{}{}}%
2527 % An additional complication: the above will allow breaks after, e.g.,
2528 % each of the four underscores in __typeof__. This is undesirable in
2529 % some manuals, especially if they don't have long identifiers in
2530 % general. @allowcodebreaks provides a way to control this.
2532 \newif\ifallowcodebreaks \allowcodebreakstrue
2534 \def\keywordtrue{true}
2535 \def\keywordfalse{false}
2537 \parseargdef\allowcodebreaks{%
2539 \ifx\txiarg\keywordtrue
2540 \allowcodebreakstrue
2541 \else\ifx\txiarg\keywordfalse
2542 \allowcodebreaksfalse
2544 \errhelp = \EMsimple
2545 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2549 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2550 % second argument specifying the text to display and an optional third
2551 % arg as text to display instead of (rather than in addition to) the url
2552 % itself. First (mandatory) arg is the url.
2553 % (This \urefnobreak definition isn't used now, leaving it for a while
2555 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2556 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2559 \setbox0 = \hbox{\ignorespaces #3}%
2561 \unhbox0 % third arg given, show only that
2563 \setbox0 = \hbox{\ignorespaces #2}%
2566 \unhbox0 % PDF: 2nd arg given, show only it
2568 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2571 \code{#1}% only url given, so show it
2577 % This \urefbreak definition is the active one.
2578 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2579 \let\uref=\urefbreak
2580 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2581 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2584 \setbox0 = \hbox{\ignorespaces #3}%
2586 \unhbox0 % third arg given, show only that
2588 \setbox0 = \hbox{\ignorespaces #2}%
2591 \unhbox0 % PDF: 2nd arg given, show only it
2593 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2596 \urefcode{#1}% only url given, so show it
2602 % Allow line breaks around only a few characters (only).
2604 \catcode\ampChar=\active \catcode\dotChar=\active
2605 \catcode\hashChar=\active \catcode\questChar=\active
2606 \catcode\slashChar=\active
2611 \global\def\urefcode{\begingroup
2612 \setupmarkupstyle{code}%
2622 % By default, they are just regular characters.
2623 \global\def&{\normalamp}
2624 \global\def.{\normaldot}
2625 \global\def#{\normalhash}
2626 \global\def?{\normalquest}
2627 \global\def/{\normalslash}
2630 % we put a little stretch before and after the breakable chars, to help
2631 % line breaking of long url's. The unequal skips make look better in
2632 % cmtt at least, especially for dots.
2633 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2634 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2636 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2637 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2638 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2639 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2640 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2643 \global\def\urefcodeslashfinish{%
2644 \urefprestretch \slashChar
2645 % Allow line break only after the final / in a sequence of
2646 % slashes, to avoid line break between the slashes in http://.
2647 \ifx\next/\else \urefpoststretch \fi
2651 % One more complication: by default we'll break after the special
2652 % characters, but some people like to break before the special chars, so
2653 % allow that. Also allow no breaking at all, for manual control.
2655 \parseargdef\urefbreakstyle{%
2657 \ifx\txiarg\wordnone
2658 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2659 \else\ifx\txiarg\wordbefore
2660 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2661 \else\ifx\txiarg\wordafter
2662 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2664 \errhelp = \EMsimple
2665 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2668 \def\wordafter{after}
2669 \def\wordbefore{before}
2672 \urefbreakstyle after
2674 % @url synonym for @uref, since that's how everyone uses it.
2678 % rms does not like angle brackets --karl, 17may97.
2679 % So now @email is just like @uref, unless we are pdf.
2681 %\def\email#1{\angleleft{\tt #1}\angleright}
2683 \def\email#1{\doemail#1,,\finish}
2684 \def\doemail#1,#2,#3\finish{\begingroup
2687 \setbox0 = \hbox{\ignorespaces #2}%
2688 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2695 % @kbd is like @code, except that if the argument is just one @key command,
2696 % then @kbd has no effect.
2697 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2699 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2700 % `example' (@kbd uses ttsl only inside of @example and friends),
2701 % or `code' (@kbd uses normal tty font always).
2702 \parseargdef\kbdinputstyle{%
2704 \ifx\txiarg\worddistinct
2705 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2706 \else\ifx\txiarg\wordexample
2707 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2708 \else\ifx\txiarg\wordcode
2709 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2711 \errhelp = \EMsimple
2712 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2715 \def\worddistinct{distinct}
2716 \def\wordexample{example}
2719 % Default is `distinct'.
2720 \kbdinputstyle distinct
2723 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2724 \ifx\one\xkey\ifx\threex\three \key{#2}%
2725 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2726 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2728 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2729 \let\indicateurl=\code
2733 % @clicksequence{File @click{} Open ...}
2734 \def\clicksequence#1{\begingroup #1\endgroup}
2736 % @clickstyle @arrow (by default)
2737 \parseargdef\clickstyle{\def\click{#1}}
2740 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2741 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2743 \def\dmn#1{\thinspace #1}
2745 % @l was never documented to mean ``switch to the Lisp font'',
2746 % and it is not used as such in any manual I can find. We need it for
2747 % Polish suppressed-l. --karl, 22sep96.
2748 %\def\l#1{{\li #1}\null}
2750 % @acronym for "FBI", "NATO", and the like.
2751 % We print this one point size smaller, since it's intended for
2754 \def\acronym#1{\doacronym #1,,\finish}
2755 \def\doacronym#1,#2,#3\finish{%
2756 {\selectfonts\lsize #1}%
2758 \ifx\temp\empty \else
2759 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2761 \null % reset \spacefactor=1000
2764 % @abbr for "Comput. J." and the like.
2765 % No font change, but don't do end-of-sentence spacing.
2767 \def\abbr#1{\doabbr #1,,\finish}
2768 \def\doabbr#1,#2,#3\finish{%
2769 {\plainfrenchspacing #1}%
2771 \ifx\temp\empty \else
2772 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2774 \null % reset \spacefactor=1000
2777 % @asis just yields its argument. Used with @table, for example.
2781 % @math outputs its argument in math mode.
2783 % One complication: _ usually means subscripts, but it could also mean
2784 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2785 % _ active, and distinguish by seeing if the current family is \slfam,
2786 % which is what @var uses.
2788 \catcode`\_ = \active
2789 \gdef\mathunderscore{%
2791 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2794 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2795 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2796 % particular reason), but this is not advertised and we don't care.
2798 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2799 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2804 \let\\ = \mathbackslash
2806 % make the texinfo accent commands work in math mode
2818 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2820 % Some active characters (such as <) are spaced differently in math.
2821 % We have to reset their definitions in case the @math was an argument
2822 % to a command which sets the catcodes (such as @item or @section).
2825 \catcode`^ = \active
2826 \catcode`< = \active
2827 \catcode`> = \active
2828 \catcode`+ = \active
2829 \catcode`' = \active
2835 \let' = \ptexquoteright
2846 % Used to generate quoted braces. Unless we're in typewriter, use
2847 % \ecfont because the CM text fonts do not have braces, and we don't
2848 % want to switch into math.
2849 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2850 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2854 % Definitions to produce \{ and \} commands for indices,
2855 % and @{ and @} for the aux/toc files.
2856 \catcode`\{ = \other \catcode`\} = \other
2857 \catcode`\[ = 1 \catcode`\] = 2
2858 \catcode`\! = 0 \catcode`\\ = \other
2859 !gdef!lbracecmd[\{]%
2860 !gdef!rbracecmd[\}]%
2861 !gdef!lbraceatcmd[@{]%
2862 !gdef!rbraceatcmd[@}]%
2865 % @comma{} to avoid , parsing problems.
2868 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2869 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2871 \let\dotaccent = \ptexdot
2872 \def\ringaccent#1{{\accent23 #1}}
2873 \let\tieaccent = \ptext
2874 \let\ubaraccent = \ptexb
2875 \let\udotaccent = \d
2877 % Other special characters: @questiondown @exclamdown @ordf @ordm
2878 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2879 \def\questiondown{?`}
2881 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2882 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2884 % Dotless i and dotless j, used for accents.
2889 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2890 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2891 \else \errmessage{@dotless can be used only with i or j}%
2895 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2896 % period following counts as ending a sentence. (Idea found in latex.)
2898 \edef\TeX{\TeX \spacefactor=1000 }
2900 % @LaTeX{} logo. Not quite the same results as the definition in
2901 % latex.ltx, since we use a different font for the raised A; it's most
2902 % convenient for us to use an explicitly smaller font, rather than using
2903 % the \scriptstyle font (since we don't reset \scriptstyle and
2904 % \scriptscriptstyle).
2909 \vbox to \ht0{\hbox{%
2910 \ifx\textnominalsize\xwordpt
2911 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2912 % Revert to plain's \scriptsize, which is 7pt.
2913 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2915 % For 11pt, we can use our lllsize.
2916 \selectfonts\lllsize A%
2925 % Some math mode symbols.
2926 \def\bullet{$\ptexbullet$}
2927 \def\geq{\ifmmode \ge\else $\ge$\fi}
2928 \def\leq{\ifmmode \le\else $\le$\fi}
2929 \def\minus{\ifmmode -\else $-$\fi}
2931 % @dots{} outputs an ellipsis using the current font.
2932 % We do .5em per period so that it has the same spacing in the cm
2933 % typewriter fonts as three actual period characters; on the other hand,
2934 % in other typewriter fonts three periods are wider than 1.5em. So do
2935 % whichever is larger.
2939 \setbox0=\hbox{...}% get width of three periods
2946 \hskip 0pt plus.25fil
2947 .\hskip 0pt plus1fil
2948 .\hskip 0pt plus1fil
2949 .\hskip 0pt plus.5fil
2953 % @enddots{} is an end-of-sentence ellipsis.
2957 \spacefactor=\endofsentencespacefactor
2960 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2962 % Since these characters are used in examples, they should be an even number of
2963 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2966 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2967 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2968 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2969 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2970 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2972 % The @error{} command.
2973 % Adapted from the TeXbook's \boxit.
2977 {\tentt \global\dimen0 = 3em}% Width of the box.
2978 \dimen2 = .55pt % Thickness of rules
2979 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2980 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
2982 \setbox\errorbox=\hbox to \dimen0{\hfil
2983 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2984 \advance\hsize by -2\dimen2 % Rules.
2986 \hrule height\dimen2
2987 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2988 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2989 \kern3pt\vrule width\dimen2}% Space to right.
2990 \hrule height\dimen2}
2993 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2995 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2997 \def\pounds{{\it\$}}
2999 % @euro{} comes from a separate font, depending on the current style.
3000 % We use the free feym* fonts from the eurosym package by Henrik
3001 % Theiling, which support regular, slanted, bold and bold slanted (and
3002 % "outlined" (blackboard board, sort of) versions, which we don't need).
3003 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3005 % Although only regular is the truly official Euro symbol, we ignore
3006 % that. The Euro is designed to be slightly taller than the regular
3012 % feybo - bold slanted
3014 % There is no good (free) typewriter version, to my knowledge.
3015 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3018 % Also doesn't work in math. Do we need to do math with euro symbols?
3022 \def\euro{{\eurofont e}}
3024 % We set the font at each command, rather than predefining it in
3025 % \textfonts and the other font-switching commands, so that
3026 % installations which never need the symbol don't have to have the
3029 % There is only one designed size (nominal 10pt), so we always scale
3030 % that to the current nominal size.
3032 % By the way, simply using "at 1em" works for cmr10 and the like, but
3033 % does not work for cmbx10 and other extended/shrunken fonts.
3035 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3037 \ifx\curfontstyle\bfstylename
3039 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3042 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3047 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3048 % sometimes we redefine the original macro, and the alias should reflect
3051 % Use LaTeX names for the Icelandic letters.
3052 \def\DH{{\ecfont \char"D0}} % Eth
3053 \def\dh{{\ecfont \char"F0}} % eth
3054 \def\TH{{\ecfont \char"DE}} % Thorn
3055 \def\th{{\ecfont \char"FE}} % thorn
3057 \def\guillemetleft{{\ecfont \char"13}}
3058 \def\guillemotleft{\guillemetleft}
3059 \def\guillemetright{{\ecfont \char"14}}
3060 \def\guillemotright{\guillemetright}
3061 \def\guilsinglleft{{\ecfont \char"0E}}
3062 \def\guilsinglright{{\ecfont \char"0F}}
3063 \def\quotedblbase{{\ecfont \char"12}}
3064 \def\quotesinglbase{{\ecfont \char"0D}}
3066 % This positioning is not perfect (see the ogonek LaTeX package), but
3067 % we have the precomposed glyphs for the most common cases. We put the
3068 % tests to use those glyphs in the single \ogonek macro so we have fewer
3069 % dummy definitions to worry about for index entries, etc.
3071 % ogonek is also used with other letters in Lithuanian (IOU), but using
3072 % the precomposed glyphs for those is not so easy since they aren't in
3076 \ifx\temp\macrocharA\Aogonek
3077 \else\ifx\temp\macrochara\aogonek
3078 \else\ifx\temp\macrocharE\Eogonek
3079 \else\ifx\temp\macrochare\eogonek
3081 \ecfont \setbox0=\hbox{#1}%
3082 \ifdim\ht0=1ex\accent"0C #1%
3083 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3088 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3089 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3090 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3091 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3093 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3095 % We can't distinguish serif/sans and italic/slanted, but this
3096 % is used for crude hacks anyway (like adding French and German
3097 % quotes to documents typeset with CM, where we lose kerning), so
3098 % hopefully nobody will notice/care.
3099 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3100 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3101 \ifx\curfontstyle\bfstylename
3103 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3106 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3111 % @registeredsymbol - R in a circle. The font for the R should really
3112 % be smaller yet, but lllsize is the best we can do for now.
3113 % Adapted from the plain.tex definition of \copyright.
3115 \def\registeredsymbol{%
3116 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3121 % @textdegree - the normal degrees sign.
3123 \def\textdegree{$^\circ$}
3125 % Laurent Siebenmann reports \Orb undefined with:
3126 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3127 % so we'll define it if necessary.
3129 \ifx\Orb\thisisundefined
3130 \def\Orb{\mathhexbox20D}
3134 \chardef\quotedblleft="5C
3135 \chardef\quotedblright=`\"
3136 \chardef\quoteleft=`\`
3137 \chardef\quoteright=`\'
3140 \message{page headings,}
3142 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3143 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3145 % First the title page. Must do @settitle before @titlepage.
3147 \newif\iffinishedtitlepage
3149 % Do an implicit @contents or @shortcontents after @end titlepage if the
3150 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3152 \newif\ifsetcontentsaftertitlepage
3153 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3154 \newif\ifsetshortcontentsaftertitlepage
3155 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3157 \parseargdef\shorttitlepage{%
3158 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3159 \endgroup\page\hbox{}\page}
3162 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3164 \parindent=0pt \textfonts
3165 % Leave some space at the very top of the page.
3166 \vglue\titlepagetopglue
3167 % No rule at page bottom unless we print one at the top with @title.
3168 \finishedtitlepagetrue
3170 % Most title ``pages'' are actually two pages long, with space
3171 % at the top of the second. We don't want the ragged left on the second.
3172 \let\oldpage = \page
3174 \iffinishedtitlepage\else
3177 \let\page = \oldpage
3184 \iffinishedtitlepage\else
3187 % It is important to do the page break before ending the group,
3188 % because the headline and footline are only empty inside the group.
3189 % If we use the new definition of \page, we always get a blank page
3190 % after the title page, which we certainly don't want.
3194 % Need this before the \...aftertitlepage checks so that if they are
3195 % in effect the toc pages will come out with page numbers.
3198 % If they want short, they certainly want long too.
3199 \ifsetshortcontentsaftertitlepage
3202 \global\let\shortcontents = \relax
3203 \global\let\contents = \relax
3206 \ifsetcontentsaftertitlepage
3208 \global\let\contents = \relax
3209 \global\let\shortcontents = \relax
3213 \def\finishtitlepage{%
3214 \vskip4pt \hrule height 2pt width \hsize
3215 \vskip\titlepagebottomglue
3216 \finishedtitlepagetrue
3219 % Macros to be used within @titlepage:
3221 \let\subtitlerm=\tenrm
3222 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3224 \parseargdef\title{%
3226 \leftline{\titlefonts\rmisbold #1}
3227 % print a rule at the page bottom also.
3228 \finishedtitlepagefalse
3229 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3232 \parseargdef\subtitle{%
3234 {\subtitlefont \rightline{#1}}%
3237 % @author should come last, but may come many times.
3238 % It can also be used inside @quotation.
3240 \parseargdef\author{%
3241 \def\temp{\quotation}%
3243 \def\quotationauthor{#1}% printed in \Equotation.
3246 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3247 {\secfonts\rmisbold \leftline{#1}}%
3252 % Set up page headings and footings.
3254 \let\thispage=\folio
3256 \newtoks\evenheadline % headline on even pages
3257 \newtoks\oddheadline % headline on odd pages
3258 \newtoks\evenfootline % footline on even pages
3259 \newtoks\oddfootline % footline on odd pages
3261 % Now make TeX use those variables
3262 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3263 \else \the\evenheadline \fi}}
3264 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3265 \else \the\evenfootline \fi}\HEADINGShook}
3266 \let\HEADINGShook=\relax
3268 % Commands to set those variables.
3269 % For example, this is what @headings on does
3270 % @evenheading @thistitle|@thispage|@thischapter
3271 % @oddheading @thischapter|@thispage|@thistitle
3272 % @evenfooting @thisfile||
3273 % @oddfooting ||@thisfile
3276 \def\evenheading{\parsearg\evenheadingxxx}
3277 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3278 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3279 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3281 \def\oddheading{\parsearg\oddheadingxxx}
3282 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3283 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3284 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3286 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3288 \def\evenfooting{\parsearg\evenfootingxxx}
3289 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3290 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3291 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3293 \def\oddfooting{\parsearg\oddfootingxxx}
3294 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3295 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3296 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3298 % Leave some space for the footline. Hopefully ok to assume
3299 % @evenfooting will not be used by itself.
3300 \global\advance\pageheight by -12pt
3301 \global\advance\vsize by -12pt
3304 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3306 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3307 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3309 % The same set of arguments for:
3314 % @everyheadingmarks
3315 % @everyfootingmarks
3317 \def\evenheadingmarks{\headingmarks{even}{heading}}
3318 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3319 \def\evenfootingmarks{\headingmarks{even}{footing}}
3320 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3321 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3322 \headingmarks{odd}{heading}{#1} }
3323 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3324 \headingmarks{odd}{footing}{#1} }
3325 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3326 \def\headingmarks#1#2#3 {%
3327 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3328 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3331 \everyheadingmarks bottom
3332 \everyfootingmarks bottom
3334 % @headings double turns headings on for double-sided printing.
3335 % @headings single turns headings on for single-sided printing.
3336 % @headings off turns them off.
3337 % @headings on same as @headings double, retained for compatibility.
3338 % @headings after turns on double-sided headings after this page.
3339 % @headings doubleafter turns on double-sided headings after this page.
3340 % @headings singleafter turns on single-sided headings after this page.
3341 % By default, they are off at the start of a document,
3342 % and turned `on' after @end titlepage.
3344 \def\headings #1 {\csname HEADINGS#1\endcsname}
3346 \def\headingsoff{% non-global headings elimination
3347 \evenheadline={\hfil}\evenfootline={\hfil}%
3348 \oddheadline={\hfil}\oddfootline={\hfil}%
3351 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3352 \HEADINGSoff % it's the default
3354 % When we turn headings on, set the page number to 1.
3355 % For double-sided printing, put current file name in lower left corner,
3356 % chapter name on inside top of right hand pages, document
3357 % title on inside top of left hand pages, and page numbers on outside top
3358 % edge of all pages.
3359 \def\HEADINGSdouble{%
3361 \global\evenfootline={\hfil}
3362 \global\oddfootline={\hfil}
3363 \global\evenheadline={\line{\folio\hfil\thistitle}}
3364 \global\oddheadline={\line{\thischapter\hfil\folio}}
3365 \global\let\contentsalignmacro = \chapoddpage
3367 \let\contentsalignmacro = \chappager
3369 % For single-sided printing, chapter title goes across top left of page,
3370 % page number on top right.
3371 \def\HEADINGSsingle{%
3373 \global\evenfootline={\hfil}
3374 \global\oddfootline={\hfil}
3375 \global\evenheadline={\line{\thischapter\hfil\folio}}
3376 \global\oddheadline={\line{\thischapter\hfil\folio}}
3377 \global\let\contentsalignmacro = \chappager
3379 \def\HEADINGSon{\HEADINGSdouble}
3381 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3382 \let\HEADINGSdoubleafter=\HEADINGSafter
3383 \def\HEADINGSdoublex{%
3384 \global\evenfootline={\hfil}
3385 \global\oddfootline={\hfil}
3386 \global\evenheadline={\line{\folio\hfil\thistitle}}
3387 \global\oddheadline={\line{\thischapter\hfil\folio}}
3388 \global\let\contentsalignmacro = \chapoddpage
3391 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3392 \def\HEADINGSsinglex{%
3393 \global\evenfootline={\hfil}
3394 \global\oddfootline={\hfil}
3395 \global\evenheadline={\line{\thischapter\hfil\folio}}
3396 \global\oddheadline={\line{\thischapter\hfil\folio}}
3397 \global\let\contentsalignmacro = \chappager
3400 % Subroutines used in generating headings
3401 % This produces Day Month Year style of output.
3402 % Only define if not already defined, in case a txi-??.tex file has set
3403 % up a different format (e.g., txi-cs.tex does this).
3404 \ifx\today\thisisundefined
3408 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3409 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3410 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3415 % @settitle line... specifies the title of the document, for headings.
3416 % It generates no output of its own.
3417 \def\thistitle{\putwordNoTitle}
3418 \def\settitle{\parsearg{\gdef\thistitle}}
3422 % Tables -- @table, @ftable, @vtable, @item(x).
3424 % default indentation of table text
3425 \newdimen\tableindent \tableindent=.8in
3426 % default indentation of @itemize and @enumerate text
3427 \newdimen\itemindent \itemindent=.3in
3428 % margin between end of table item and start of table text.
3429 \newdimen\itemmargin \itemmargin=.1in
3431 % used internally for \itemindent minus \itemmargin
3434 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3436 % They also define \itemindex
3437 % to index the item name in whatever manner is desired (perhaps none).
3439 \newif\ifitemxneedsnegativevskip
3441 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3443 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3444 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3446 \def\itemzzz #1{\begingroup %
3447 \advance\hsize by -\rightskip
3448 \advance\hsize by -\tableindent
3449 \setbox0=\hbox{\itemindicate{#1}}%
3451 \nobreak % This prevents a break before @itemx.
3453 % If the item text does not fit in the space we have, put it on a line
3454 % by itself, and do not allow a page break either before or after that
3455 % line. We do not start a paragraph here because then if the next
3456 % command is, e.g., @kindex, the whatsit would get put into the
3457 % horizontal list on a line by itself, resulting in extra blank space.
3458 \ifdim \wd0>\itemmax
3460 % Make this a paragraph so we get the \parskip glue and wrapping,
3461 % but leave it ragged-right.
3463 \advance\leftskip by-\tableindent
3464 \advance\hsize by\tableindent
3465 \advance\rightskip by0pt plus1fil\relax
3466 \leavevmode\unhbox0\par
3469 % We're going to be starting a paragraph, but we don't want the
3470 % \parskip glue -- logically it's part of the @item we just started.
3471 \nobreak \vskip-\parskip
3473 % Stop a page break at the \parskip glue coming up. However, if
3474 % what follows is an environment such as @example, there will be no
3475 % \parskip glue; then the negative vskip we just inserted would
3476 % cause the example and the item to crash together. So we use this
3477 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3478 % \parskip glue after all. Section titles are handled this way also.
3482 \itemxneedsnegativevskipfalse
3484 % The item text fits into the space. Start a paragraph, so that the
3485 % following text (if any) will end up on the same line.
3487 % Do this with kerns and \unhbox so that if there is a footnote in
3488 % the item text, it can migrate to the main vertical list and
3489 % eventually be printed.
3490 \nobreak\kern-\tableindent
3491 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3493 \nobreak\kern\dimen0
3495 \itemxneedsnegativevskiptrue
3499 \def\item{\errmessage{@item while not in a list environment}}
3500 \def\itemx{\errmessage{@itemx while not in a list environment}}
3502 % @table, @ftable, @vtable.
3504 \let\itemindex\gobble
3508 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3509 \tablecheck{ftable}%
3512 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3513 \tablecheck{vtable}%
3516 \ifnum \the\catcode`\^^M=\active
3518 \errmessage{This command won't work in this context; perhaps the problem is
3519 that we are \inenvironment\thisenv}%
3520 \def\next{\doignore{#1}}%
3527 \def\itemindicate{#1}%
3532 \makevalueexpandable
3533 \edef\temp{\noexpand\tablez #1\space\space\space}%
3537 \def\tablez #1 #2 #3 #4\endtablez{%
3539 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3540 \ifnum 0#2>0 \tableindent=#2\mil \fi
3541 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3542 \itemmax=\tableindent
3543 \advance \itemmax by -\itemmargin
3544 \advance \leftskip by \tableindent
3545 \exdentamount=\tableindent
3547 \parskip = \smallskipamount
3548 \ifdim \parskip=0pt \parskip=2pt \fi
3549 \let\item = \internalBitem
3550 \let\itemx = \internalBitemx
3552 \def\Etable{\endgraf\afterenvbreak}
3555 \let\Eitemize\Etable
3556 \let\Eenumerate\Etable
3558 % This is the counter used by @enumerate, which is really @itemize
3562 \envdef\itemize{\parsearg\doitemize}
3566 \itemmax=\itemindent
3567 \advance\itemmax by -\itemmargin
3568 \advance\leftskip by \itemindent
3569 \exdentamount=\itemindent
3571 \parskip=\smallskipamount
3572 \ifdim\parskip=0pt \parskip=2pt \fi
3574 % Try typesetting the item mark that if the document erroneously says
3575 % something like @itemize @samp (intending @table), there's an error
3576 % right away at the @itemize. It's not the best error message in the
3577 % world, but it's better than leaving it to the @item. This means if
3578 % the user wants an empty mark, they have to say @w{} not just @w.
3579 \def\itemcontents{#1}%
3580 \setbox0 = \hbox{\itemcontents}%
3582 % @itemize with no arg is equivalent to @itemize @bullet.
3583 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3585 \let\item=\itemizeitem
3588 % Definition of @item while inside @itemize and @enumerate.
3591 \advance\itemno by 1 % for enumerations
3592 {\let\par=\endgraf \smallbreak}% reasonable place to break
3594 % If the document has an @itemize directly after a section title, a
3595 % \nobreak will be last on the list, and \sectionheading will have
3596 % done a \vskip-\parskip. In that case, we don't want to zero
3597 % parskip, or the item text will crash with the heading. On the
3598 % other hand, when there is normal text preceding the item (as there
3599 % usually is), we do want to zero parskip, or there would be too much
3600 % space. In that case, we won't have a \nobreak before. At least
3601 % that's the theory.
3602 \ifnum\lastpenalty<10000 \parskip=0in \fi
3604 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3606 \vadjust{\penalty 1200}}% not good to break after first line of item.
3610 % \splitoff TOKENS\endmark defines \first to be the first token in
3611 % TOKENS, and \rest to be the remainder.
3613 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3615 % Allow an optional argument of an uppercase letter, lowercase letter,
3616 % or number, to specify the first label in the enumerated list. No
3617 % argument is the same as `1'.
3619 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3620 \def\enumeratey #1 #2\endenumeratey{%
3621 % If we were given no argument, pretend we were given `1'.
3623 \ifx\thearg\empty \def\thearg{1}\fi
3625 % Detect if the argument is a single token. If so, it might be a
3626 % letter. Otherwise, the only valid thing it can be is a number.
3627 % (We will always have one token, because of the test we just made.
3628 % This is a good thing, since \splitoff doesn't work given nothing at
3629 % all -- the first parameter is undelimited.)
3630 \expandafter\splitoff\thearg\endmark
3632 % Only one token in the argument. It could still be anything.
3633 % A ``lowercase letter'' is one whose \lccode is nonzero.
3634 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3635 % not equal to itself.
3636 % Otherwise, we assume it's a number.
3638 % We need the \relax at the end of the \ifnum lines to stop TeX from
3639 % continuing to look for a <number>.
3641 \ifnum\lccode\expandafter`\thearg=0\relax
3642 \numericenumerate % a number (we hope)
3645 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3646 \lowercaseenumerate % lowercase letter
3648 \uppercaseenumerate % uppercase letter
3652 % Multiple tokens in the argument. We hope it's a number.
3657 % An @enumerate whose labels are integers. The starting integer is
3660 \def\numericenumerate{%
3662 \startenumeration{\the\itemno}%
3665 % The starting (lowercase) letter is in \thearg.
3666 \def\lowercaseenumerate{%
3667 \itemno = \expandafter`\thearg
3669 % Be sure we're not beyond the end of the alphabet.
3671 \errmessage{No more lowercase letters in @enumerate; get a bigger
3678 % The starting (uppercase) letter is in \thearg.
3679 \def\uppercaseenumerate{%
3680 \itemno = \expandafter`\thearg
3682 % Be sure we're not beyond the end of the alphabet.
3684 \errmessage{No more uppercase letters in @enumerate; get a bigger
3691 % Call \doitemize, adding a period to the first argument and supplying the
3692 % common last two arguments. Also subtract one from the initial value in
3693 % \itemno, since @item increments \itemno.
3695 \def\startenumeration#1{%
3696 \advance\itemno by -1
3697 \doitemize{#1.}\flushcr
3700 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3703 \def\alphaenumerate{\enumerate{a}}
3704 \def\capsenumerate{\enumerate{A}}
3705 \def\Ealphaenumerate{\Eenumerate}
3706 \def\Ecapsenumerate{\Eenumerate}
3709 % @multitable macros
3710 % Amy Hendrickson, 8/18/94, 3/6/96
3712 % @multitable ... @end multitable will make as many columns as desired.
3713 % Contents of each column will wrap at width given in preamble. Width
3714 % can be specified either with sample text given in a template line,
3715 % or in percent of \hsize, the current width of text on page.
3717 % Table can continue over pages but will only break between lines.
3721 % Either define widths of columns in terms of percent of \hsize:
3722 % @multitable @columnfractions .25 .3 .45
3725 % Numbers following @columnfractions are the percent of the total
3726 % current hsize to be used for each column. You may use as many
3727 % columns as desired.
3730 % Or use a template:
3731 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3733 % using the widest term desired in each column.
3735 % Each new table line starts with @item, each subsequent new column
3736 % starts with @tab. Empty columns may be produced by supplying @tab's
3737 % with nothing between them for as many times as empty columns are needed,
3738 % ie, @tab@tab@tab will produce two empty columns.
3740 % @item, @tab do not need to be on their own lines, but it will not hurt
3743 % Sample multitable:
3745 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3746 % @item first col stuff @tab second col stuff @tab third col
3753 % @item first col stuff @tab second col stuff
3754 % @tab Many paragraphs of text may be used in any column.
3756 % They will wrap at the width determined by the template.
3757 % @item@tab@tab This will be in third column.
3760 % Default dimensions may be reset by user.
3761 % @multitableparskip is vertical space between paragraphs in table.
3762 % @multitableparindent is paragraph indent in table.
3763 % @multitablecolmargin is horizontal space to be left between columns.
3764 % @multitablelinespace is space to leave between table items, baseline
3766 % 0pt means it depends on current normal line spacing.
3768 \newskip\multitableparskip
3769 \newskip\multitableparindent
3770 \newdimen\multitablecolspace
3771 \newskip\multitablelinespace
3772 \multitableparskip=0pt
3773 \multitableparindent=6pt
3774 \multitablecolspace=12pt
3775 \multitablelinespace=0pt
3777 % Macros used to set up halign preamble:
3779 \let\endsetuptable\relax
3780 \def\xendsetuptable{\endsetuptable}
3781 \let\columnfractions\relax
3782 \def\xcolumnfractions{\columnfractions}
3785 % #1 is the @columnfraction, usually a decimal number like .5, but might
3786 % be just 1. We just use it, whatever it is.
3788 \def\pickupwholefraction#1 {%
3789 \global\advance\colcount by 1
3790 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3797 \ifx\firstarg\xendsetuptable
3800 \ifx\firstarg\xcolumnfractions
3801 \global\setpercenttrue
3804 \let\go\pickupwholefraction
3806 \global\advance\colcount by 1
3807 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3808 % separator; typically that is always in the input, anyway.
3809 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3812 \ifx\go\pickupwholefraction
3813 % Put the argument back for the \pickupwholefraction call, so
3814 % we'll always have a period there to be parsed.
3815 \def\go{\pickupwholefraction#1}%
3817 \let\go = \setuptable
3823 % multitable-only commands.
3825 % @headitem starts a heading row, which we typeset in bold.
3826 % Assignments have to be global since we are inside the implicit group
3827 % of an alignment entry. \everycr resets \everytab so we don't have to
3828 % undo it ourselves.
3829 \def\headitemfont{\b}% for people to use in the template row; not changeable
3831 \checkenv\multitable
3833 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3834 \the\everytab % for the first item
3837 % A \tab used to include \hskip1sp. But then the space in a template
3838 % line is not enough. That is bad. So let's go back to just `&' until
3839 % we again encounter the problem the 1sp was intended to solve.
3840 % --karl, nathan@acm.org, 20apr99.
3841 \def\tab{\checkenv\multitable &\the\everytab}%
3843 % @multitable ... @end multitable definitions:
3845 \newtoks\everytab % insert after every tab.
3847 \envdef\multitable{%
3851 % @item within a multitable starts a normal row.
3852 % We use \def instead of \let so that if one of the multitable entries
3853 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3854 % \endtemplate) expanding \doitemize.
3859 \setmultitablespacing
3860 \parskip=\multitableparskip
3861 \parindent=\multitableparindent
3867 \global\everytab={}%
3868 \global\colcount=0 % Reset the column counter.
3869 % Check for saved footnotes, etc.
3871 % Keeps underfull box messages off when table breaks over pages.
3873 % Maybe so, but it also creates really weird page breaks when the
3874 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3875 % problem manifests itself, so it can be fixed for real --karl.
3879 \parsearg\domultitable
3881 \def\domultitable#1{%
3882 % To parse everything between @multitable and @item:
3883 \setuptable#1 \endsetuptable
3885 % This preamble sets up a generic column definition, which will
3886 % be used as many times as user calls for columns.
3887 % \vtop will set a single line and will also let text wrap and
3888 % continue for many paragraphs if desired.
3890 \global\advance\colcount by 1
3893 % Use the current \colcount to find the correct column width:
3894 \hsize=\expandafter\csname col\the\colcount\endcsname
3896 % In order to keep entries from bumping into each other
3897 % we will add a \leftskip of \multitablecolspace to all columns after
3900 % If a template has been used, we will add \multitablecolspace
3901 % to the width of each template entry.
3903 % If the user has set preamble in terms of percent of \hsize we will
3904 % use that dimension as the width of the column, and the \leftskip
3905 % will keep entries from bumping into each other. Table will start at
3906 % left margin and final column will justify at right margin.
3908 % Make sure we don't inherit \rightskip from the outer environment.
3911 % The first column will be indented with the surrounding text.
3912 \advance\hsize by\leftskip
3915 % If user has not set preamble in terms of percent of \hsize
3916 % we will advance \hsize by \multitablecolspace.
3917 \advance\hsize by \multitablecolspace
3919 % In either case we will make \leftskip=\multitablecolspace:
3920 \leftskip=\multitablecolspace
3922 % Ignoring space at the beginning and end avoids an occasional spurious
3923 % blank line, when TeX decides to break the line at the space before the
3924 % box from the multistrut, so the strut ends up on a line by itself.
3926 % @multitable @columnfractions .11 .89
3928 % @tab Legal holiday which is valid in major parts of the whole country.
3929 % Is automatically provided with highlighting sequences respectively
3930 % marking characters.
3931 \noindent\ignorespaces##\unskip\multistrut
3936 \egroup % end the \halign
3937 \global\setpercentfalse
3940 \def\setmultitablespacing{%
3941 \def\multistrut{\strut}% just use the standard line spacing
3943 % Compute \multitablelinespace (if not defined by user) for use in
3944 % \multitableparskip calculation. We used define \multistrut based on
3945 % this, but (ironically) that caused the spacing to be off.
3946 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3947 \ifdim\multitablelinespace=0pt
3948 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3949 \global\advance\multitablelinespace by-\ht0
3951 % Test to see if parskip is larger than space between lines of
3952 % table. If not, do nothing.
3953 % If so, set to same dimension as multitablelinespace.
3954 \ifdim\multitableparskip>\multitablelinespace
3955 \global\multitableparskip=\multitablelinespace
3956 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3957 % than skip between lines in the table.
3959 \ifdim\multitableparskip=0pt
3960 \global\multitableparskip=\multitablelinespace
3961 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3962 % than skip between lines in the table.
3966 \message{conditionals,}
3968 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3969 % @ifnotxml always succeed. They currently do nothing; we don't
3970 % attempt to check whether the conditionals are properly nested. But we
3971 % have to remember that they are conditionals, so that @end doesn't
3972 % attempt to close an environment group.
3975 \expandafter\let\csname #1\endcsname = \relax
3976 \expandafter\let\csname iscond.#1\endcsname = 1
3979 \makecond{ifnotdocbook}
3980 \makecond{ifnothtml}
3981 \makecond{ifnotinfo}
3982 \makecond{ifnotplaintext}
3985 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3987 \def\direntry{\doignore{direntry}}
3988 \def\documentdescription{\doignore{documentdescription}}
3989 \def\docbook{\doignore{docbook}}
3990 \def\html{\doignore{html}}
3991 \def\ifdocbook{\doignore{ifdocbook}}
3992 \def\ifhtml{\doignore{ifhtml}}
3993 \def\ifinfo{\doignore{ifinfo}}
3994 \def\ifnottex{\doignore{ifnottex}}
3995 \def\ifplaintext{\doignore{ifplaintext}}
3996 \def\ifxml{\doignore{ifxml}}
3997 \def\ignore{\doignore{ignore}}
3998 \def\menu{\doignore{menu}}
3999 \def\xml{\doignore{xml}}
4001 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4003 % A count to remember the depth of nesting.
4004 \newcount\doignorecount
4006 \def\doignore#1{\begingroup
4007 % Scan in ``verbatim'' mode:
4009 \catcode`\@ = \other
4010 \catcode`\{ = \other
4011 \catcode`\} = \other
4013 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4016 % Count number of #1's that we've seen.
4019 % Swallow text until we reach the matching `@end #1'.
4023 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4026 \gdef\dodoignore#1{%
4027 % #1 contains the command name as a string, e.g., `ifinfo'.
4029 % Define a command to find the next `@end #1'.
4030 \long\def\doignoretext##1^^M@end #1{%
4031 \doignoretextyyy##1^^M@#1\_STOP_}%
4033 % And this command to find another #1 command, at the beginning of a
4034 % line. (Otherwise, we would consider a line `@c @ifset', for
4035 % example, to count as an @ifset for nesting.)
4036 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4038 % And now expand that command.
4043 \def\doignoreyyy#1{%
4045 \ifx\temp\empty % Nothing found.
4046 \let\next\doignoretextzzz
4047 \else % Found a nested condition, ...
4048 \advance\doignorecount by 1
4049 \let\next\doignoretextyyy % ..., look for another.
4050 % If we're here, #1 ends with ^^M\ifinfo (for example).
4052 \next #1% the token \_STOP_ is present just after this macro.
4055 % We have to swallow the remaining "\_STOP_".
4057 \def\doignoretextzzz#1{%
4058 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4059 \let\next\enddoignore
4060 \else % Still inside a nested condition.
4061 \advance\doignorecount by -1
4062 \let\next\doignoretext % Look for the next @end.
4067 % Finish off ignored text.
4069 % Ignore anything after the last `@end #1'; this matters in verbatim
4070 % environments, where otherwise the newline after an ignored conditional
4071 % would result in a blank line in the output.
4072 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4076 % @set VAR sets the variable VAR to an empty value.
4077 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4079 % Since we want to separate VAR from REST-OF-LINE (which might be
4080 % empty), we can't just use \parsearg; we have to insert a space of our
4081 % own to delimit the rest of the line, and then take it out again if we
4083 % We rely on the fact that \parsearg sets \catcode`\ =10.
4085 \parseargdef\set{\setyyy#1 \endsetyyy}
4086 \def\setyyy#1 #2\endsetyyy{%
4088 \makevalueexpandable
4090 \edef\next{\gdef\makecsname{SET#1}}%
4098 % Remove the trailing space \setxxx inserted.
4099 \def\setzzz#1 \endsetzzz{\next{#1}}
4101 % @clear VAR clears (i.e., unsets) the variable VAR.
4103 \parseargdef\clear{%
4105 \makevalueexpandable
4106 \global\expandafter\let\csname SET#1\endcsname=\relax
4110 % @value{foo} gets the text saved in variable foo.
4111 \def\value{\begingroup\makevalueexpandable\valuexxx}
4112 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4114 \catcode`\- = \active \catcode`\_ = \active
4116 \gdef\makevalueexpandable{%
4117 \let\value = \expandablevalue
4118 % We don't want these characters active, ...
4119 \catcode`\-=\other \catcode`\_=\other
4120 % ..., but we might end up with active ones in the argument if
4121 % we're called from @code, as @code{@value{foo-bar_}}, though.
4122 % So \let them to their normal equivalents.
4123 \let-\realdash \let_\normalunderscore
4127 % We have this subroutine so that we can handle at least some @value's
4128 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4129 % The command has to be fully expandable (if the variable is set), since
4130 % the result winds up in the index file. This means that if the
4131 % variable's value contains other Texinfo commands, it's almost certain
4132 % it will fail (although perhaps we could fix that with sufficient work
4133 % to do a one-level expansion on the result, instead of complete).
4135 \def\expandablevalue#1{%
4136 \expandafter\ifx\csname SET#1\endcsname\relax
4137 {[No value for ``#1'']}%
4138 \message{Variable `#1', used in @value, is not set.}%
4140 \csname SET#1\endcsname
4144 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4147 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4150 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4153 \makevalueexpandable
4155 \expandafter\ifx\csname SET#2\endcsname\relax
4156 #1% If not set, redefine \next.
4161 \def\ifsetfail{\doignore{ifset}}
4163 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4164 % defined with @set, or has been undefined with @clear.
4166 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4167 % above code: if the variable is not set, do nothing, if it is set,
4168 % then redefine \next to \ifclearfail.
4171 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4172 \def\ifclearfail{\doignore{ifclear}}
4174 % @dircategory CATEGORY -- specify a category of the dir file
4175 % which this file should belong to. Ignore this in TeX.
4176 \let\dircategory=\comment
4178 % @defininfoenclose.
4179 \let\definfoenclose=\comment
4183 % Index generation facilities
4185 % Define \newwrite to be identical to plain tex's \newwrite
4186 % except not \outer, so it can be used within macros and \if's.
4187 \edef\newwrite{\makecsname{ptexnewwrite}}
4189 % \newindex {foo} defines an index named foo.
4190 % It automatically defines \fooindex such that
4191 % \fooindex ...rest of line... puts an entry in the index foo.
4192 % It also defines \fooindfile to be the number of the output channel for
4193 % the file that accumulates this index. The file's extension is foo.
4194 % The name of an index should be no more than 2 characters long
4195 % for the sake of vms.
4199 \expandafter\newwrite \csname#1indfile\endcsname
4200 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4202 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4203 \noexpand\doindex{#1}}
4206 % @defindex foo == \newindex{foo}
4208 \def\defindex{\parsearg\newindex}
4210 % Define @defcodeindex, like @defindex except put all entries in @code.
4212 \def\defcodeindex{\parsearg\newcodeindex}
4214 \def\newcodeindex#1{%
4216 \expandafter\newwrite \csname#1indfile\endcsname
4217 \openout \csname#1indfile\endcsname \jobname.#1
4219 \expandafter\xdef\csname#1index\endcsname{%
4220 \noexpand\docodeindex{#1}}%
4224 % @synindex foo bar makes index foo feed into index bar.
4225 % Do this instead of @defindex foo if you don't want it as a separate index.
4227 % @syncodeindex foo bar similar, but put all entries made for index foo
4230 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4231 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4233 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4234 % #3 the target index (bar).
4235 \def\dosynindex#1#2#3{%
4236 % Only do \closeout if we haven't already done it, else we'll end up
4237 % closing the target index.
4238 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4239 % The \closeout helps reduce unnecessary open files; the limit on the
4240 % Acorn RISC OS is a mere 16 files.
4241 \expandafter\closeout\csname#2indfile\endcsname
4242 \expandafter\let\csname donesynindex#2\endcsname = 1
4244 % redefine \fooindfile:
4245 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4246 \expandafter\let\csname#2indfile\endcsname=\temp
4247 % redefine \fooindex:
4248 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4251 % Define \doindex, the driver for all \fooindex macros.
4252 % Argument #1 is generated by the calling \fooindex macro,
4253 % and it is "foo", the name of the index.
4255 % \doindex just uses \parsearg; it calls \doind for the actual work.
4256 % This is because \doind is more useful to call from other macros.
4258 % There is also \dosubind {index}{topic}{subtopic}
4259 % which makes an entry in a two-level index such as the operation index.
4261 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4262 \def\singleindexer #1{\doind{\indexname}{#1}}
4264 % like the previous two, but they put @code around the argument.
4265 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4266 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4268 % Take care of Texinfo commands that can appear in an index entry.
4269 % Since there are some commands we want to expand, and others we don't,
4270 % we have to laboriously prevent expansion for those that we don't.
4273 \escapechar = `\\ % use backslash in output files.
4274 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4275 \def\ {\realbackslash\space }%
4277 % Need these unexpandable (because we define \tt as a dummy)
4278 % definitions when @{ or @} appear in index entry text. Also, more
4279 % complicated, when \tex is in effect and \{ is a \delimiter again.
4280 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4281 % braces and backslashes are used only as delimiters. Perhaps we
4282 % should define @lbrace and @rbrace commands a la @comma.
4283 \def\{{{\tt\char123}}%
4284 \def\}{{\tt\char125}}%
4286 % I don't entirely understand this, but when an index entry is
4287 % generated from a macro call, the \endinput which \scanmacro inserts
4288 % causes processing to be prematurely terminated. This is,
4289 % apparently, because \indexsorttmp is fully expanded, and \endinput
4290 % is an expandable command. The redefinition below makes \endinput
4291 % disappear altogether for that purpose -- although logging shows that
4292 % processing continues to some further point. On the other hand, it
4293 % seems \endinput does not hurt in the printed index arg, since that
4294 % is still getting written without apparent harm.
4296 % Sample source (mac-idx3.tex, reported by Graham Percival to
4297 % help-texinfo, 22may06):
4298 % @macro funindex {WORD}
4302 % @funindex commtest
4304 % The above is not enough to reproduce the bug, but it gives the flavor.
4306 % Sample whatsit resulting:
4307 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4310 \let\endinput = \empty
4312 % Do the redefinitions.
4316 % For the aux and toc files, @ is the escape character. So we want to
4317 % redefine everything using @ as the escape character (instead of
4318 % \realbackslash, still used for index files). When everything uses @,
4319 % this will be simpler.
4324 \let\{ = \lbraceatcmd
4325 \let\} = \rbraceatcmd
4327 % Do the redefinitions.
4332 % Called from \indexdummies and \atdummies.
4334 \def\commondummies{%
4336 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4337 % preventing its expansion. This is used only for control words,
4338 % not control letters, because the \space would be incorrect for
4339 % control characters, but is needed to separate the control word
4340 % from whatever follows.
4342 % For control letters, we have \definedummyletter, which omits the
4345 % These can be used both for control words that take an argument and
4346 % those that do not. If it is followed by {arg} in the input, then
4347 % that will dutifully get written to the index (or wherever).
4349 \def\definedummyword ##1{\def##1{\string##1\space}}%
4350 \def\definedummyletter##1{\def##1{\string##1}}%
4351 \let\definedummyaccent\definedummyletter
4353 \commondummiesnofonts
4355 \definedummyletter\_%
4356 \definedummyletter\-%
4358 % Non-English letters.
4369 \definedummyword\exclamdown
4373 \definedummyword\ordf
4374 \definedummyword\ordm
4375 \definedummyword\questiondown
4379 % Although these internal commands shouldn't show up, sometimes they do.
4381 \definedummyword\gtr
4382 \definedummyword\hat
4383 \definedummyword\less
4386 \definedummyword\tclose
4389 \definedummyword\LaTeX
4390 \definedummyword\TeX
4392 % Assorted special characters.
4393 \definedummyword\arrow
4394 \definedummyword\bullet
4395 \definedummyword\comma
4396 \definedummyword\copyright
4397 \definedummyword\registeredsymbol
4398 \definedummyword\dots
4399 \definedummyword\enddots
4400 \definedummyword\entrybreak
4401 \definedummyword\equiv
4402 \definedummyword\error
4403 \definedummyword\euro
4404 \definedummyword\expansion
4405 \definedummyword\geq
4406 \definedummyword\guillemetleft
4407 \definedummyword\guillemetright
4408 \definedummyword\guilsinglleft
4409 \definedummyword\guilsinglright
4410 \definedummyword\leq
4411 \definedummyword\minus
4412 \definedummyword\ogonek
4413 \definedummyword\pounds
4414 \definedummyword\point
4415 \definedummyword\print
4416 \definedummyword\quotedblbase
4417 \definedummyword\quotedblleft
4418 \definedummyword\quotedblright
4419 \definedummyword\quoteleft
4420 \definedummyword\quoteright
4421 \definedummyword\quotesinglbase
4422 \definedummyword\result
4423 \definedummyword\textdegree
4425 % We want to disable all macros so that they are not expanded by \write.
4428 \normalturnoffactive
4430 % Handle some cases of @value -- where it does not contain any
4431 % (non-fully-expandable) commands.
4432 \makevalueexpandable
4435 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4437 \def\commondummiesnofonts{%
4438 % Control letters and accents.
4439 \definedummyletter\!%
4440 \definedummyaccent\"%
4441 \definedummyaccent\'%
4442 \definedummyletter\*%
4443 \definedummyaccent\,%
4444 \definedummyletter\.%
4445 \definedummyletter\/%
4446 \definedummyletter\:%
4447 \definedummyaccent\=%
4448 \definedummyletter\?%
4449 \definedummyaccent\^%
4450 \definedummyaccent\`%
4451 \definedummyaccent\~%
4455 \definedummyword\dotaccent
4456 \definedummyword\ogonek
4457 \definedummyword\ringaccent
4458 \definedummyword\tieaccent
4459 \definedummyword\ubaraccent
4460 \definedummyword\udotaccent
4461 \definedummyword\dotless
4463 % Texinfo font commands.
4467 \definedummyword\sansserif
4469 \definedummyword\slanted
4472 % Commands that take arguments.
4473 \definedummyword\acronym
4474 \definedummyword\anchor
4475 \definedummyword\cite
4476 \definedummyword\code
4477 \definedummyword\command
4478 \definedummyword\dfn
4479 \definedummyword\dmn
4480 \definedummyword\email
4481 \definedummyword\emph
4482 \definedummyword\env
4483 \definedummyword\file
4484 \definedummyword\indicateurl
4485 \definedummyword\kbd
4486 \definedummyword\key
4487 \definedummyword\math
4488 \definedummyword\option
4489 \definedummyword\pxref
4490 \definedummyword\ref
4491 \definedummyword\samp
4492 \definedummyword\strong
4493 \definedummyword\tie
4494 \definedummyword\uref
4495 \definedummyword\url
4496 \definedummyword\var
4497 \definedummyword\verb
4499 \definedummyword\xref
4502 % \indexnofonts is used when outputting the strings to sort the index
4503 % by, and when constructing control sequence names. It eliminates all
4504 % control sequences and just writes whatever the best ASCII sort string
4505 % would be for a given command (usually its argument).
4508 % Accent commands should become @asis.
4509 \def\definedummyaccent##1{\let##1\asis}%
4510 % We can just ignore other control letters.
4511 \def\definedummyletter##1{\let##1\empty}%
4512 % All control words become @asis by default; overrides below.
4513 \let\definedummyword\definedummyaccent
4515 \commondummiesnofonts
4517 % Don't no-op \tt, since it isn't a user-level command
4518 % and is used in the definitions of the active chars like <, >, |, etc.
4519 % Likewise with the other plain tex font commands.
4524 \def\_{\normalunderscore}%
4525 \def\-{}% @- shouldn't affect sorting
4527 % Unfortunately, texindex is not prepared to handle braces in the
4528 % content at all. So for index sorting, we map @{ and @} to strings
4529 % starting with |, since that ASCII character is between ASCII { and }.
4533 % Non-English letters.
4550 \def\questiondown{?}%
4557 % Assorted special characters.
4558 % (The following {} will end up in the sort string, but that's ok.)
4560 \def\bullet{bullet}%
4562 \def\copyright{copyright}%
4568 \def\expansion{==>}%
4570 \def\guillemetleft{<<}%
4571 \def\guillemetright{>>}%
4572 \def\guilsinglleft{<}%
4573 \def\guilsinglright{>}%
4577 \def\pounds{pounds}%
4579 \def\quotedblbase{"}%
4580 \def\quotedblleft{"}%
4581 \def\quotedblright{"}%
4584 \def\quotesinglbase{,}%
4585 \def\registeredsymbol{R}%
4589 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4590 \else \indexlquoteignore \fi
4592 % We need to get rid of all macros, leaving only the arguments (if present).
4593 % Of course this is not nearly correct, but it is the best we can do for now.
4594 % makeinfo does not expand macros in the argument to @deffn, which ends up
4595 % writing an index entry, and texindex isn't prepared for an index sort entry
4596 % that starts with \.
4598 % Since macro invocations are followed by braces, we can just redefine them
4599 % to take a single TeX argument. The case of a macro invocation that
4600 % goes to end-of-line is not handled.
4605 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4606 % ignore left quotes in the sort term.
4607 {\catcode`\`=\active
4608 \gdef\indexlquoteignore{\let`=\empty}}
4610 \let\indexbackslash=0 %overridden during \printindex.
4611 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4613 % Most index entries go through here, but \dosubind is the general case.
4614 % #1 is the index name, #2 is the entry text.
4615 \def\doind#1#2{\dosubind{#1}{#2}{}}
4617 % Workhorse for all \fooindexes.
4618 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4619 % empty if called from \doind, as we usually are (the main exception
4620 % is with most defuns, which call us directly).
4622 \def\dosubind#1#2#3{%
4625 % Store the main index entry text (including the third arg).
4627 % If third arg is present, precede it with a space.
4629 \ifx\thirdarg\empty \else
4630 \toks0 = \expandafter{\the\toks0 \space #3}%
4633 \edef\writeto{\csname#1indfile\endcsname}%
4635 \safewhatsit\dosubindwrite
4640 % Write the entry in \toks0 to the index file:
4642 \def\dosubindwrite{%
4643 % Put the index entry in the margin if desired.
4644 \ifx\SETmarginindex\relax\else
4645 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4648 % Remember, we are within a group.
4649 \indexdummies % Must do this here, since \bf, etc expand at this stage
4650 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4651 % so it will be output as is; and it will print as backslash.
4653 % Process the index entry with all font commands turned off, to
4654 % get the string to sort by.
4656 \edef\temp{\the\toks0}% need full expansion
4657 \xdef\indexsorttmp{\temp}%
4660 % Set up the complete index entry, with both the sort key and
4661 % the original text, including any font commands. We write
4662 % three arguments to \entry to the .?? file (four in the
4663 % subentry case), texindex reduces to two when writing the .??s
4667 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4672 % Take care of unwanted page breaks/skips around a whatsit:
4674 % If a skip is the last thing on the list now, preserve it
4675 % by backing up by \lastskip, doing the \write, then inserting
4676 % the skip again. Otherwise, the whatsit generated by the
4677 % \write or \pdfdest will make \lastskip zero. The result is that
4678 % sequences like this:
4682 % will have extra space inserted, because the \medbreak in the
4683 % start of the @defun won't see the skip inserted by the @end of
4684 % the previous defun.
4686 % But don't do any of this if we're not in vertical mode. We
4687 % don't want to do a \vskip and prematurely end a paragraph.
4689 % Avoid page breaks due to these extra skips, too.
4691 % But wait, there is a catch there:
4692 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4693 % sufficient for this purpose, as it ignores stretch and shrink parts
4694 % of the skip. The only way seems to be to check the textual
4695 % representation of the skip.
4697 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4698 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4700 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4702 \newskip\whatsitskip
4703 \newcount\whatsitpenalty
4707 \def\safewhatsit#1{%
4711 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4712 \whatsitskip = \lastskip
4713 \edef\lastskipmacro{\the\lastskip}%
4714 \whatsitpenalty = \lastpenalty
4716 % If \lastskip is nonzero, that means the last item was a
4717 % skip. And since a skip is discardable, that means this
4718 % -\whatsitskip glue we're inserting is preceded by a
4719 % non-discardable item, therefore it is not a potential
4720 % breakpoint, therefore no \nobreak needed.
4721 \ifx\lastskipmacro\zeroskipmacro
4728 \ifx\lastskipmacro\zeroskipmacro
4729 % If \lastskip was zero, perhaps the last item was a penalty, and
4730 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4731 % to re-insert the same penalty (values >10000 are used for various
4732 % signals); since we just inserted a non-discardable item, any
4733 % following glue (such as a \parskip) would be a breakpoint. For example:
4735 % @deffn deffn-whatever
4736 % @vindex index-whatever
4738 % would allow a break between the index-whatever whatsit
4739 % and the "Description." paragraph.
4740 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4742 % On the other hand, if we had a nonzero \lastskip,
4743 % this make-up glue would be preceded by a non-discardable item
4744 % (the whatsit from the \write), so we must insert a \nobreak.
4745 \nobreak\vskip\whatsitskip
4750 % The index entry written in the file actually looks like
4751 % \entry {sortstring}{page}{topic}
4753 % \entry {sortstring}{page}{topic}{subtopic}
4754 % The texindex program reads in these files and writes files
4755 % containing these kinds of lines:
4757 % before the first topic whose initial is c
4758 % \entry {topic}{pagelist}
4759 % for a topic that is used without subtopics
4761 % for the beginning of a topic that is used with subtopics
4762 % \secondary {subtopic}{pagelist}
4763 % for each subtopic.
4765 % Define the user-accessible indexing commands
4766 % @findex, @vindex, @kindex, @cindex.
4768 \def\findex {\fnindex}
4769 \def\kindex {\kyindex}
4770 \def\cindex {\cpindex}
4771 \def\vindex {\vrindex}
4772 \def\tindex {\tpindex}
4773 \def\pindex {\pgindex}
4775 \def\cindexsub {\begingroup\obeylines\cindexsub}
4777 \gdef\cindexsub "#1" #2^^M{\endgroup %
4778 \dosubind{cp}{#2}{#1}}}
4780 % Define the macros used in formatting output of the sorted index material.
4782 % @printindex causes a particular index (the ??s file) to get printed.
4783 % It does not print any chapter heading (usually an @unnumbered).
4785 \parseargdef\printindex{\begingroup
4786 \dobreak \chapheadingskip{10000}%
4791 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4793 % See if the index file exists and is nonempty.
4794 % Change catcode of @ here so that if the index file contains
4796 % as its first line, TeX doesn't complain about mismatched braces
4797 % (because it thinks @} is a control sequence).
4799 \openin 1 \jobname.#1s
4801 % \enddoublecolumns gets confused if there is no text in the index,
4802 % and it loses the chapter title and the aux file entries for the
4803 % index. The easiest way to prevent this problem is to make sure
4804 % there is some text.
4805 \putwordIndexNonexistent
4808 % If the index file exists but is empty, then \openin leaves \ifeof
4809 % false. We have to make TeX try to read something from the file, so
4810 % it can discover if there is anything in it.
4813 \putwordIndexIsEmpty
4815 % Index files are almost Texinfo source, but we use \ as the escape
4816 % character. It would be better to use @, but that's too big a change
4817 % to make right now.
4818 \def\indexbackslash{\backslashcurfont}%
4829 % These macros are used by the sorted index file itself.
4830 % Change them to control the appearance of the index.
4833 % Some minor font changes for the special characters.
4834 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4836 % Remove any glue we may have, we'll be inserting our own.
4839 % We like breaks before the index initials, so insert a bonus.
4841 \vskip 0pt plus 3\baselineskip
4843 \vskip 0pt plus -3\baselineskip
4845 % Typeset the initial. Making this add up to a whole number of
4846 % baselineskips increases the chance of the dots lining up from column
4847 % to column. It still won't often be perfect, because of the stretch
4848 % we need before each entry, but it's better.
4850 % No shrink because it confuses \balancecolumns.
4851 \vskip 1.67\baselineskip plus .5\baselineskip
4852 \leftline{\secbf #1}%
4853 % Do our best not to break after the initial.
4855 \vskip .33\baselineskip plus .1\baselineskip
4858 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4859 % then page number (#2) flushed to the right margin. It is used for index
4860 % and table of contents entries. The paragraph is indented by \leftskip.
4862 % A straightforward implementation would start like this:
4863 % \def\entry#1#2{...
4864 % But this freezes the catcodes in the argument, and can cause problems to
4865 % @code, which sets - active. This problem was fixed by a kludge---
4866 % ``-'' was active throughout whole index, but this isn't really right.
4867 % The right solution is to prevent \entry from swallowing the whole text.
4872 % Start a new paragraph if necessary, so our assignments below can't
4873 % affect previous text.
4876 % Do not fill out the last line with white space.
4879 % No extra space above this paragraph.
4882 % Do not prefer a separate line ending with a hyphen to fewer lines.
4883 \finalhyphendemerits = 0
4885 % \hangindent is only relevant when the entry text and page number
4886 % don't both fit on one line. In that case, bob suggests starting the
4887 % dots pretty far over on the line. Unfortunately, a large
4888 % indentation looks wrong when the entry text itself is broken across
4889 % lines. So we use a small indentation and put up with long leaders.
4891 % \hangafter is reset to 1 (which is the value we want) at the start
4892 % of each paragraph, so we need not do anything with that.
4895 % When the entry text needs to be broken, just fill out the first line
4897 \rightskip = 0pt plus1fil
4899 % A bit of stretch before each entry for the benefit of balancing
4903 % When reading the text of entry, convert explicit line breaks
4904 % from @* into spaces. The user might give these in long section
4905 % titles, for instance.
4906 \def\*{\unskip\space\ignorespaces}%
4907 \def\entrybreak{\hfil\break}%
4909 % Swallow the left brace of the text (first parameter):
4910 \afterassignment\doentry
4913 \def\entrybreak{\unskip\space\ignorespaces}%
4915 \bgroup % Instead of the swallowed brace.
4917 \aftergroup\finishentry
4918 % And now comes the text of the entry.
4920 \def\finishentry#1{%
4921 % #1 is the page number.
4923 % The following is kludged to not output a line of dots in the index if
4924 % there are no page numbers. The next person who breaks this will be
4925 % cursed by a Unix daemon.
4926 \setbox\boxA = \hbox{#1}%
4927 \ifdim\wd\boxA = 0pt
4931 % If we must, put the page number on a line of its own, and fill out
4932 % this line with blank space. (The \hfil is overwhelmed with the
4933 % fill leaders glue in \indexdotfill if the page number does fit.)
4935 \null\nobreak\indexdotfill % Have leaders before the page number.
4937 % The `\ ' here is removed by the implicit \unskip that TeX does as
4938 % part of (the primitive) \par. Without it, a spurious underfull
4951 % Like plain.tex's \dotfill, except uses up at least 1 em.
4952 \def\indexdotfill{\cleaders
4953 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4955 \def\primary #1{\line{#1\hfil}}
4957 \newskip\secondaryindent \secondaryindent=0.5cm
4958 \def\secondary#1#2{{%
4963 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4965 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4972 % Define two-column mode, which we use to typeset indexes.
4973 % Adapted from the TeXbook, page 416, which is to say,
4974 % the manmac.tex format used to print the TeXbook itself.
4978 \newdimen\doublecolumnhsize
4980 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4981 % Grab any single-column material above us.
4984 % Here is a possibility not foreseen in manmac: if we accumulate a
4985 % whole lot of material, we might end up calling this \output
4986 % routine twice in a row (see the doublecol-lose test, which is
4987 % essentially a couple of indexes with @setchapternewpage off). In
4988 % that case we just ship out what is in \partialpage with the normal
4989 % output routine. Generally, \partialpage will be empty when this
4990 % runs and this will be a no-op. See the indexspread.tex test case.
4991 \ifvoid\partialpage \else
4992 \onepageout{\pagecontents\partialpage}%
4995 \global\setbox\partialpage = \vbox{%
4996 % Unvbox the main output page.
4998 \kern-\topskip \kern\baselineskip
5001 \eject % run that output routine to set \partialpage
5003 % Use the double-column output routine for subsequent pages.
5004 \output = {\doublecolumnout}%
5006 % Change the page size parameters. We could do this once outside this
5007 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5008 % format, but then we repeat the same computation. Repeating a couple
5009 % of assignments once per index is clearly meaningless for the
5010 % execution time, so we may as well do it in one place.
5012 % First we halve the line length, less a little for the gutter between
5013 % the columns. We compute the gutter based on the line length, so it
5014 % changes automatically with the paper format. The magic constant
5015 % below is chosen so that the gutter has the same value (well, +-<1pt)
5016 % as it did when we hard-coded it.
5018 % We put the result in a separate register, \doublecolumhsize, so we
5019 % can restore it in \pagesofar, after \hsize itself has (potentially)
5022 \doublecolumnhsize = \hsize
5023 \advance\doublecolumnhsize by -.04154\hsize
5024 \divide\doublecolumnhsize by 2
5025 \hsize = \doublecolumnhsize
5027 % Double the \vsize as well. (We don't need a separate register here,
5028 % since nobody clobbers \vsize.)
5032 % The double-column output routine for all double-column pages except
5035 \def\doublecolumnout{%
5036 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5037 % Get the available space for the double columns -- the normal
5038 % (undoubled) page height minus any material left over from the
5042 \advance\dimen@ by -\ht\partialpage
5044 % box0 will be the left-hand column, box2 the right.
5045 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5046 \onepageout\pagesofar
5048 \penalty\outputpenalty
5051 % Re-output the contents of the output page -- any previous material,
5052 % followed by the two boxes we just split, in box0 and box2.
5056 \hsize = \doublecolumnhsize
5057 \wd0=\hsize \wd2=\hsize
5058 \hbox to\pagewidth{\box0\hfil\box2}%
5061 % All done with double columns.
5062 \def\enddoublecolumns{%
5063 % The following penalty ensures that the page builder is exercised
5064 % _before_ we change the output routine. This is necessary in the
5065 % following situation:
5067 % The last section of the index consists only of a single entry.
5068 % Before this section, \pagetotal is less than \pagegoal, so no
5069 % break occurs before the last section starts. However, the last
5070 % section, consisting of \initial and the single \entry, does not
5071 % fit on the page and has to be broken off. Without the following
5072 % penalty the page builder will not be exercised until \eject
5073 % below, and by that time we'll already have changed the output
5074 % routine to the \balancecolumns version, so the next-to-last
5075 % double-column page will be processed with \balancecolumns, which
5076 % is wrong: The two columns will go to the main vertical list, with
5077 % the broken-off section in the recent contributions. As soon as
5078 % the output routine finishes, TeX starts reconsidering the page
5079 % break. The two columns and the broken-off section both fit on the
5080 % page, because the two columns now take up only half of the page
5081 % goal. When TeX sees \eject from below which follows the final
5082 % section, it invokes the new output routine that we've set after
5083 % \balancecolumns below; \onepageout will try to fit the two columns
5084 % and the final section into the vbox of \pageheight (see
5085 % \pagebody), causing an overfull box.
5087 % Note that glue won't work here, because glue does not exercise the
5088 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5092 % Split the last of the double-column material. Leave it on the
5093 % current page, no automatic page break.
5096 % If we end up splitting too much material for the current page,
5097 % though, there will be another page break right after this \output
5098 % invocation ends. Having called \balancecolumns once, we do not
5099 % want to call it again. Therefore, reset \output to its normal
5100 % definition right away. (We hope \balancecolumns will never be
5101 % called on to balance too much material, but if it is, this makes
5102 % the output somewhat more palatable.)
5103 \global\output = {\onepageout{\pagecontents\PAGE}}%
5106 \endgroup % started in \begindoublecolumns
5108 % \pagegoal was set to the doubled \vsize above, since we restarted
5109 % the current page. We're now back to normal single-column
5110 % typesetting, so reset \pagegoal to the normal \vsize (after the
5111 % \endgroup where \vsize got restored).
5115 % Called at the end of the double column material.
5116 \def\balancecolumns{%
5117 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5119 \advance\dimen@ by \topskip
5120 \advance\dimen@ by-\baselineskip
5121 \divide\dimen@ by 2 % target to split to
5122 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5123 \splittopskip = \topskip
5124 % Loop until we get a decent breakpoint.
5128 \global\setbox3 = \copy0
5129 \global\setbox1 = \vsplit3 to \dimen@
5131 \global\advance\dimen@ by 1pt
5134 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5135 \setbox0=\vbox to\dimen@{\unvbox1}%
5136 \setbox2=\vbox to\dimen@{\unvbox3}%
5140 \catcode`\@ = \other
5143 \message{sectioning,}
5144 % Chapters, sections, etc.
5146 % Let's start with @part.
5147 \outer\parseargdef\part{\partzzz{#1}}
5151 \vskip.3\vsize % move it down on the page a bit
5153 \noindent \titlefonts\rmisbold #1\par % the text
5154 \let\lastnode=\empty % no node to associate with
5155 \writetocentry{part}{#1}{}% but put it in the toc
5156 \headingsoff % no headline or footline on the part page
5161 % \unnumberedno is an oxymoron. But we count the unnumbered
5162 % sections so that we can refer to them unambiguously in the pdf
5163 % outlines by their "section number". We avoid collisions with chapter
5164 % numbers by starting them at 10000. (If a document ever has 10000
5165 % chapters, we're in trouble anyway, I'm sure.)
5166 \newcount\unnumberedno \unnumberedno = 10000
5168 \newcount\secno \secno=0
5169 \newcount\subsecno \subsecno=0
5170 \newcount\subsubsecno \subsubsecno=0
5172 % This counter is funny since it counts through charcodes of letters A, B, ...
5173 \newcount\appendixno \appendixno = `\@
5175 % \def\appendixletter{\char\the\appendixno}
5176 % We do the following ugly conditional instead of the above simple
5177 % construct for the sake of pdftex, which needs the actual
5178 % letter in the expansion, not just typeset.
5180 \def\appendixletter{%
5181 \ifnum\appendixno=`A A%
5182 \else\ifnum\appendixno=`B B%
5183 \else\ifnum\appendixno=`C C%
5184 \else\ifnum\appendixno=`D D%
5185 \else\ifnum\appendixno=`E E%
5186 \else\ifnum\appendixno=`F F%
5187 \else\ifnum\appendixno=`G G%
5188 \else\ifnum\appendixno=`H H%
5189 \else\ifnum\appendixno=`I I%
5190 \else\ifnum\appendixno=`J J%
5191 \else\ifnum\appendixno=`K K%
5192 \else\ifnum\appendixno=`L L%
5193 \else\ifnum\appendixno=`M M%
5194 \else\ifnum\appendixno=`N N%
5195 \else\ifnum\appendixno=`O O%
5196 \else\ifnum\appendixno=`P P%
5197 \else\ifnum\appendixno=`Q Q%
5198 \else\ifnum\appendixno=`R R%
5199 \else\ifnum\appendixno=`S S%
5200 \else\ifnum\appendixno=`T T%
5201 \else\ifnum\appendixno=`U U%
5202 \else\ifnum\appendixno=`V V%
5203 \else\ifnum\appendixno=`W W%
5204 \else\ifnum\appendixno=`X X%
5205 \else\ifnum\appendixno=`Y Y%
5206 \else\ifnum\appendixno=`Z Z%
5207 % The \the is necessary, despite appearances, because \appendixletter is
5208 % expanded while writing the .toc file. \char\appendixno is not
5209 % expandable, thus it is written literally, thus all appendixes come out
5210 % with the same letter (or @) in the toc without it.
5211 \else\char\the\appendixno
5212 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5213 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5215 % Each @chapter defines these (using marks) as the number+name, number
5216 % and name of the chapter. Page headings and footings can use
5217 % these. @section does likewise.
5219 \def\thischapternum{}
5220 \def\thischaptername{}
5222 \def\thissectionnum{}
5223 \def\thissectionname{}
5225 \newcount\absseclevel % used to calculate proper heading level
5226 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5228 % @raisesections: treat @section as chapter, @subsection as section, etc.
5229 \def\raisesections{\global\advance\secbase by -1}
5230 \let\up=\raisesections % original BFox name
5232 % @lowersections: treat @chapter as section, @section as subsection, etc.
5233 \def\lowersections{\global\advance\secbase by 1}
5234 \let\down=\lowersections % original BFox name
5236 % we only have subsub.
5237 \chardef\maxseclevel = 3
5239 % A numbered section within an unnumbered changes to unnumbered too.
5240 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5241 \chardef\unnlevel = \maxseclevel
5243 % Trace whether the current chapter is an appendix or not:
5244 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5245 \def\chapheadtype{N}
5247 % Choose a heading macro
5248 % #1 is heading type
5249 % #2 is heading level
5250 % #3 is text for heading
5251 \def\genhead#1#2#3{%
5252 % Compute the abs. sec. level:
5254 \advance\absseclevel by \secbase
5255 % Make sure \absseclevel doesn't fall outside the range:
5256 \ifnum \absseclevel < 0
5259 \ifnum \absseclevel > 3
5266 \ifnum \absseclevel < \unnlevel
5267 \chardef\unnlevel = \absseclevel
5270 % Check for appendix sections:
5271 \ifnum \absseclevel = 0
5272 \edef\chapheadtype{\headtype}%
5274 \if \headtype A\if \chapheadtype N%
5275 \errmessage{@appendix... within a non-appendix chapter}%
5278 % Check for numbered within unnumbered:
5279 \ifnum \absseclevel > \unnlevel
5282 \chardef\unnlevel = 3
5285 % Now print the heading:
5289 \or \unnumberedseczzz{#3}%
5290 \or \unnumberedsubseczzz{#3}%
5291 \or \unnumberedsubsubseczzz{#3}%
5297 \or \appendixsectionzzz{#3}%
5298 \or \appendixsubseczzz{#3}%
5299 \or \appendixsubsubseczzz{#3}%
5305 \or \numberedsubseczzz{#3}%
5306 \or \numberedsubsubseczzz{#3}%
5310 \suppressfirstparagraphindent
5314 \def\numhead{\genhead N}
5315 \def\apphead{\genhead A}
5316 \def\unnmhead{\genhead U}
5318 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5319 % all lower-level sectioning counters to zero.
5321 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5322 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5323 \let\chaplevelprefix = \empty
5325 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5327 % section resetting is \global in case the chapter is in a group, such
5328 % as an @include file.
5329 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5330 \global\advance\chapno by 1
5333 \gdef\chaplevelprefix{\the\chapno.}%
5336 % \putwordChapter can contain complex things in translations.
5337 \toks0=\expandafter{\putwordChapter}%
5338 \message{\the\toks0 \space \the\chapno}%
5340 % Write the actual heading.
5341 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5343 % So @section and the like are numbered underneath this chapter.
5344 \global\let\section = \numberedsec
5345 \global\let\subsection = \numberedsubsec
5346 \global\let\subsubsection = \numberedsubsubsec
5349 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5351 \def\appendixzzz#1{%
5352 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5353 \global\advance\appendixno by 1
5354 \gdef\chaplevelprefix{\appendixletter.}%
5357 % \putwordAppendix can contain complex things in translations.
5358 \toks0=\expandafter{\putwordAppendix}%
5359 \message{\the\toks0 \space \appendixletter}%
5361 \chapmacro{#1}{Yappendix}{\appendixletter}%
5363 \global\let\section = \appendixsec
5364 \global\let\subsection = \appendixsubsec
5365 \global\let\subsubsection = \appendixsubsubsec
5368 % normally unnmhead0 calls unnumberedzzz:
5369 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5370 \def\unnumberedzzz#1{%
5371 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5372 \global\advance\unnumberedno by 1
5374 % Since an unnumbered has no number, no prefix for figures.
5375 \global\let\chaplevelprefix = \empty
5378 % This used to be simply \message{#1}, but TeX fully expands the
5379 % argument to \message. Therefore, if #1 contained @-commands, TeX
5380 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5381 % expanded @cite (which turns out to cause errors because \cite is meant
5382 % to be executed, not expanded).
5384 % Anyway, we don't want the fully-expanded definition of @cite to appear
5385 % as a result of the \message, we just want `@cite' itself. We use
5386 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5387 % simply yielding the contents of <toks register>. (We also do this for
5390 \message{(\the\toks0)}%
5392 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5394 \global\let\section = \unnumberedsec
5395 \global\let\subsection = \unnumberedsubsec
5396 \global\let\subsubsection = \unnumberedsubsubsec
5399 % @centerchap is like @unnumbered, but the heading is centered.
5400 \outer\parseargdef\centerchap{%
5401 % Well, we could do the following in a group, but that would break
5402 % an assumption that \chapmacro is called at the outermost level.
5403 % Thus we are safer this way: --kasal, 24feb04
5404 \let\centerparametersmaybe = \centerparameters
5406 \let\centerparametersmaybe = \relax
5409 % @top is like @unnumbered.
5414 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5416 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5417 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5420 % normally calls appendixsectionzzz:
5421 \outer\parseargdef\appendixsection{\apphead1{#1}}
5422 \def\appendixsectionzzz#1{%
5423 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5424 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5426 \let\appendixsec\appendixsection
5428 % normally calls unnumberedseczzz:
5429 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5430 \def\unnumberedseczzz#1{%
5431 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5432 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5437 % normally calls numberedsubseczzz:
5438 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5439 \def\numberedsubseczzz#1{%
5440 \global\subsubsecno=0 \global\advance\subsecno by 1
5441 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5444 % normally calls appendixsubseczzz:
5445 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5446 \def\appendixsubseczzz#1{%
5447 \global\subsubsecno=0 \global\advance\subsecno by 1
5448 \sectionheading{#1}{subsec}{Yappendix}%
5449 {\appendixletter.\the\secno.\the\subsecno}%
5452 % normally calls unnumberedsubseczzz:
5453 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5454 \def\unnumberedsubseczzz#1{%
5455 \global\subsubsecno=0 \global\advance\subsecno by 1
5456 \sectionheading{#1}{subsec}{Ynothing}%
5457 {\the\unnumberedno.\the\secno.\the\subsecno}%
5462 % normally numberedsubsubseczzz:
5463 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5464 \def\numberedsubsubseczzz#1{%
5465 \global\advance\subsubsecno by 1
5466 \sectionheading{#1}{subsubsec}{Ynumbered}%
5467 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5470 % normally appendixsubsubseczzz:
5471 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5472 \def\appendixsubsubseczzz#1{%
5473 \global\advance\subsubsecno by 1
5474 \sectionheading{#1}{subsubsec}{Yappendix}%
5475 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5478 % normally unnumberedsubsubseczzz:
5479 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5480 \def\unnumberedsubsubseczzz#1{%
5481 \global\advance\subsubsecno by 1
5482 \sectionheading{#1}{subsubsec}{Ynothing}%
5483 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5486 % These macros control what the section commands do, according
5487 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5488 % Define them by default for a numbered chapter.
5489 \let\section = \numberedsec
5490 \let\subsection = \numberedsubsec
5491 \let\subsubsection = \numberedsubsubsec
5493 % Define @majorheading, @heading and @subheading
5495 % NOTE on use of \vbox for chapter headings, section headings, and such:
5496 % 1) We use \vbox rather than the earlier \line to permit
5497 % overlong headings to fold.
5498 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5499 % heading is obnoxious; this forbids it.
5500 % 3) Likewise, headings look best if no \parindent is used, and
5501 % if justification is not attempted. Hence \raggedright.
5504 {\advance\chapheadingskip by 10pt \chapbreak }%
5505 \parsearg\chapheadingzzz
5508 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5509 \def\chapheadingzzz#1{%
5510 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5511 \parindent=0pt\ptexraggedright
5512 \rmisbold #1\hfill}}%
5513 \bigskip \par\penalty 200\relax
5514 \suppressfirstparagraphindent
5517 % @heading, @subheading, @subsubheading.
5518 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5519 \suppressfirstparagraphindent}
5520 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5521 \suppressfirstparagraphindent}
5522 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5523 \suppressfirstparagraphindent}
5525 % These macros generate a chapter, section, etc. heading only
5526 % (including whitespace, linebreaking, etc. around it),
5527 % given all the information in convenient, parsed form.
5529 % Args are the skip and penalty (usually negative)
5530 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5532 % Parameter controlling skip before chapter headings (if needed)
5533 \newskip\chapheadingskip
5535 % Define plain chapter starts, and page on/off switching for it.
5536 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5537 \def\chappager{\par\vfill\supereject}
5538 % Because \domark is called before \chapoddpage, the filler page will
5539 % get the headings for the next chapter, which is wrong. But we don't
5540 % care -- we just disable all headings on the filler page.
5552 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5555 \global\let\contentsalignmacro = \chappager
5556 \global\let\pchapsepmacro=\chapbreak
5557 \global\let\pagealignmacro=\chappager}
5560 \global\let\contentsalignmacro = \chappager
5561 \global\let\pchapsepmacro=\chappager
5562 \global\let\pagealignmacro=\chappager
5563 \global\def\HEADINGSon{\HEADINGSsingle}}
5566 \global\let\contentsalignmacro = \chapoddpage
5567 \global\let\pchapsepmacro=\chapoddpage
5568 \global\let\pagealignmacro=\chapoddpage
5569 \global\def\HEADINGSon{\HEADINGSdouble}}
5575 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5576 % Yappendix, Yomitfromtoc), #3 the chapter number.
5578 % To test against our argument.
5579 \def\Ynothingkeyword{Ynothing}
5580 \def\Yomitfromtockeyword{Yomitfromtoc}
5581 \def\Yappendixkeyword{Yappendix}
5583 \def\chapmacro#1#2#3{%
5584 % Insert the first mark before the heading break (see notes for \domark).
5585 \let\prevchapterdefs=\lastchapterdefs
5586 \let\prevsectiondefs=\lastsectiondefs
5587 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5588 \gdef\thissection{}}%
5591 \ifx\temptype\Ynothingkeyword
5592 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5593 \gdef\thischapter{\thischaptername}}%
5594 \else\ifx\temptype\Yomitfromtockeyword
5595 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5596 \gdef\thischapter{}}%
5597 \else\ifx\temptype\Yappendixkeyword
5599 \xdef\lastchapterdefs{%
5600 \gdef\noexpand\thischaptername{\the\toks0}%
5601 \gdef\noexpand\thischapternum{\appendixletter}%
5602 % \noexpand\putwordAppendix avoids expanding indigestible
5603 % commands in some of the translations.
5604 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5605 \noexpand\thischapternum:
5606 \noexpand\thischaptername}%
5610 \xdef\lastchapterdefs{%
5611 \gdef\noexpand\thischaptername{\the\toks0}%
5612 \gdef\noexpand\thischapternum{\the\chapno}%
5613 % \noexpand\putwordChapter avoids expanding indigestible
5614 % commands in some of the translations.
5615 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5616 \noexpand\thischapternum:
5617 \noexpand\thischaptername}%
5621 % Output the mark. Pass it through \safewhatsit, to take care of
5622 % the preceding space.
5625 % Insert the chapter heading break.
5628 % Now the second mark, after the heading break. No break points
5629 % between here and the heading.
5630 \let\prevchapterdefs=\lastchapterdefs
5631 \let\prevsectiondefs=\lastsectiondefs
5635 \chapfonts \rmisbold
5637 % Have to define \lastsection before calling \donoderef, because the
5638 % xref code eventually uses it. On the other hand, it has to be called
5639 % after \pchapsepmacro, or the headline will change too soon.
5640 \gdef\lastsection{#1}%
5642 % Only insert the separating space if we have a chapter/appendix
5643 % number, and don't print the unnumbered ``number''.
5644 \ifx\temptype\Ynothingkeyword
5646 \def\toctype{unnchap}%
5647 \else\ifx\temptype\Yomitfromtockeyword
5648 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5650 \else\ifx\temptype\Yappendixkeyword
5651 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5654 \setbox0 = \hbox{#3\enspace}%
5655 \def\toctype{numchap}%
5658 % Write the toc entry for this chapter. Must come before the
5659 % \donoderef, because we include the current node name in the toc
5660 % entry, and \donoderef resets it to empty.
5661 \writetocentry{\toctype}{#1}{#3}%
5663 % For pdftex, we have to write out the node definition (aka, make
5664 % the pdfdest) after any page break, but before the actual text has
5665 % been typeset. If the destination for the pdf outline is after the
5666 % text, then jumping from the outline may wind up with the text not
5667 % being visible, for instance under high magnification.
5670 % Typeset the actual heading.
5671 \nobreak % Avoid page breaks at the interline glue.
5672 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5673 \hangindent=\wd0 \centerparametersmaybe
5676 \nobreak\bigskip % no page break after a chapter title
5680 % @centerchap -- centered and unnumbered.
5681 \let\centerparametersmaybe = \relax
5682 \def\centerparameters{%
5683 \advance\rightskip by 3\rightskip
5684 \leftskip = \rightskip
5689 % I don't think this chapter style is supported any more, so I'm not
5690 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5692 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5694 \def\unnchfopen #1{%
5695 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5696 \parindent=0pt\ptexraggedright
5697 \rmisbold #1\hfill}}\bigskip \par\nobreak
5699 \def\chfopen #1#2{\chapoddpage {\chapfonts
5700 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5703 \def\centerchfopen #1{%
5704 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5706 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5709 \global\let\chapmacro=\chfopen
5710 \global\let\centerchapmacro=\centerchfopen}
5713 % Section titles. These macros combine the section number parts and
5714 % call the generic \sectionheading to do the printing.
5716 \newskip\secheadingskip
5717 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5719 % Subsection titles.
5720 \newskip\subsecheadingskip
5721 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5723 % Subsubsection titles.
5724 \def\subsubsecheadingskip{\subsecheadingskip}
5725 \def\subsubsecheadingbreak{\subsecheadingbreak}
5728 % Print any size, any type, section title.
5730 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5731 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5734 \def\seckeyword{sec}
5736 \def\sectionheading#1#2#3#4{%
5738 \checkenv{}% should not be in an environment.
5740 % Switch to the right set of fonts.
5741 \csname #2fonts\endcsname \rmisbold
5743 \def\sectionlevel{#2}%
5746 % Insert first mark before the heading break (see notes for \domark).
5747 \let\prevsectiondefs=\lastsectiondefs
5748 \ifx\temptype\Ynothingkeyword
5749 \ifx\sectionlevel\seckeyword
5750 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5751 \gdef\thissection{\thissectionname}}%
5753 \else\ifx\temptype\Yomitfromtockeyword
5754 % Don't redefine \thissection.
5755 \else\ifx\temptype\Yappendixkeyword
5756 \ifx\sectionlevel\seckeyword
5758 \xdef\lastsectiondefs{%
5759 \gdef\noexpand\thissectionname{\the\toks0}%
5760 \gdef\noexpand\thissectionnum{#4}%
5761 % \noexpand\putwordSection avoids expanding indigestible
5762 % commands in some of the translations.
5763 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5764 \noexpand\thissectionnum:
5765 \noexpand\thissectionname}%
5769 \ifx\sectionlevel\seckeyword
5771 \xdef\lastsectiondefs{%
5772 \gdef\noexpand\thissectionname{\the\toks0}%
5773 \gdef\noexpand\thissectionnum{#4}%
5774 % \noexpand\putwordSection avoids expanding indigestible
5775 % commands in some of the translations.
5776 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5777 \noexpand\thissectionnum:
5778 \noexpand\thissectionname}%
5783 % Go into vertical mode. Usually we'll already be there, but we
5784 % don't want the following whatsit to end up in a preceding paragraph
5785 % if the document didn't happen to have a blank line.
5788 % Output the mark. Pass it through \safewhatsit, to take care of
5789 % the preceding space.
5792 % Insert space above the heading.
5793 \csname #2headingbreak\endcsname
5795 % Now the second mark, after the heading break. No break points
5796 % between here and the heading.
5797 \let\prevsectiondefs=\lastsectiondefs
5800 % Only insert the space after the number if we have a section number.
5801 \ifx\temptype\Ynothingkeyword
5804 \gdef\lastsection{#1}%
5805 \else\ifx\temptype\Yomitfromtockeyword
5806 % for @headings -- no section number, don't include in toc,
5807 % and don't redefine \lastsection.
5810 \let\sectionlevel=\empty
5811 \else\ifx\temptype\Yappendixkeyword
5812 \setbox0 = \hbox{#4\enspace}%
5814 \gdef\lastsection{#1}%
5816 \setbox0 = \hbox{#4\enspace}%
5818 \gdef\lastsection{#1}%
5821 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5822 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5824 % Write the node reference (= pdf destination for pdftex).
5825 % Again, see comments in \chapmacro.
5828 % Interline glue will be inserted when the vbox is completed.
5829 % That glue will be a valid breakpoint for the page, since it'll be
5830 % preceded by a whatsit (usually from the \donoderef, or from the
5831 % \writetocentry if there was no node). We don't want to allow that
5832 % break, since then the whatsits could end up on page n while the
5833 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5836 % Output the actual section heading.
5837 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5838 \hangindent=\wd0 % zero if no section number
5841 % Add extra space after the heading -- half of whatever came above it.
5842 % Don't allow stretch, though.
5843 \kern .5 \csname #2headingskip\endcsname
5845 % Do not let the kern be a potential breakpoint, as it would be if it
5846 % was followed by glue.
5849 % We'll almost certainly start a paragraph next, so don't let that
5850 % glue accumulate. (Not a breakpoint because it's preceded by a
5851 % discardable item.)
5854 % This is purely so the last item on the list is a known \penalty >
5855 % 10000. This is so \startdefun can avoid allowing breakpoints after
5856 % section headings. Otherwise, it would insert a valid breakpoint between:
5857 % @section sec-whatever
5858 % @deffn def-whatever
5864 % Table of contents.
5867 % Write an entry to the toc file, opening it if necessary.
5868 % Called from @chapter, etc.
5870 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5871 % We append the current node name (if any) and page number as additional
5872 % arguments for the \{chap,sec,...}entry macros which will eventually
5873 % read this. The node name is used in the pdf outlines as the
5874 % destination to jump to.
5876 % We open the .toc file for writing here instead of at @setfilename (or
5877 % any other fixed time) so that @contents can be anywhere in the document.
5878 % But if #1 is `omit', then we don't do anything. This is used for the
5879 % table of contents chapter openings themselves.
5881 \newif\iftocfileopened
5882 \def\omitkeyword{omit}%
5884 \def\writetocentry#1#2#3{%
5885 \edef\writetoctype{#1}%
5886 \ifx\writetoctype\omitkeyword \else
5887 \iftocfileopened\else
5888 \immediate\openout\tocfile = \jobname.toc
5889 \global\tocfileopenedtrue
5895 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5901 % Tell \shipout to create a pdf destination on each page, if we're
5902 % writing pdf. These are used in the table of contents. We can't
5903 % just write one on every page because the title pages are numbered
5904 % 1 and 2 (the page numbers aren't printed), and so are the first
5905 % two pages of the document. Thus, we'd have two destinations named
5906 % `1', and two named `2'.
5907 \ifpdf \global\pdfmakepagedesttrue \fi
5911 % These characters do not print properly in the Computer Modern roman
5912 % fonts, so we must take special care. This is more or less redundant
5913 % with the Texinfo input format setup at the end of this file.
5915 \def\activecatcodes{%
5928 % Read the toc file, which is essentially Texinfo input.
5932 \input \tocreadfilename
5935 \newskip\contentsrightmargin \contentsrightmargin=1in
5936 \newcount\savepageno
5937 \newcount\lastnegativepageno \lastnegativepageno = -1
5939 % Prepare to read what we've written to \tocfile.
5941 \def\startcontents#1{%
5942 % If @setchapternewpage on, and @headings double, the contents should
5943 % start on an odd page, unlike chapters. Thus, we maintain
5944 % \contentsalignmacro in parallel with \pagealignmacro.
5945 % From: Torbjorn Granlund <tege@matematik.su.se>
5947 \immediate\closeout\tocfile
5949 % Don't need to put `Contents' or `Short Contents' in the headline.
5950 % It is abundantly clear what they are.
5951 \chapmacro{#1}{Yomitfromtoc}{}%
5953 \savepageno = \pageno
5954 \begingroup % Set up to handle contents files properly.
5955 \raggedbottom % Worry more about breakpoints than the bottom.
5956 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5958 % Roman numerals for page numbers.
5959 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5962 % redefined for the two-volume lispref. We always output on
5963 % \jobname.toc even if this is redefined.
5965 \def\tocreadfilename{\jobname.toc}
5967 % Normal (long) toc.
5970 \startcontents{\putwordTOC}%
5971 \openin 1 \tocreadfilename\space
5976 \contentsalignmacro % in case @setchapternewpage odd is in effect
5982 \lastnegativepageno = \pageno
5983 \global\pageno = \savepageno
5986 % And just the chapters.
5987 \def\summarycontents{%
5988 \startcontents{\putwordShortTOC}%
5990 \let\partentry = \shortpartentry
5991 \let\numchapentry = \shortchapentry
5992 \let\appentry = \shortchapentry
5993 \let\unnchapentry = \shortunnchapentry
5994 % We want a true roman here for the page numbers.
5996 \let\rm=\shortcontrm \let\bf=\shortcontbf
5997 \let\sl=\shortcontsl \let\tt=\shortconttt
5999 \hyphenpenalty = 10000
6000 \advance\baselineskip by 1pt % Open it up a little.
6001 \def\numsecentry##1##2##3##4{}
6002 \let\appsecentry = \numsecentry
6003 \let\unnsecentry = \numsecentry
6004 \let\numsubsecentry = \numsecentry
6005 \let\appsubsecentry = \numsecentry
6006 \let\unnsubsecentry = \numsecentry
6007 \let\numsubsubsecentry = \numsecentry
6008 \let\appsubsubsecentry = \numsecentry
6009 \let\unnsubsubsecentry = \numsecentry
6010 \openin 1 \tocreadfilename\space
6016 \contentsalignmacro % in case @setchapternewpage odd is in effect
6018 \lastnegativepageno = \pageno
6019 \global\pageno = \savepageno
6021 \let\shortcontents = \summarycontents
6023 % Typeset the label for a chapter or appendix for the short contents.
6024 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6026 \def\shortchaplabel#1{%
6027 % This space should be enough, since a single number is .5em, and the
6028 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6029 % But use \hss just in case.
6030 % (This space doesn't include the extra space that gets added after
6031 % the label; that gets put in by \shortchapentry above.)
6033 % We'd like to right-justify chapter numbers, but that looks strange
6034 % with appendix letters. And right-justifying numbers and
6035 % left-justifying letters looks strange when there is less than 10
6036 % chapters. Have to read the whole toc once to know how many chapters
6037 % there are before deciding ...
6038 \hbox to 1em{#1\hss}%
6041 % These macros generate individual entries in the table of contents.
6042 % The first argument is the chapter or section name.
6043 % The last argument is the page number.
6044 % The arguments in between are the chapter number, section number, ...
6046 % Parts, in the main contents. Replace the part number, which doesn't
6047 % exist, with an empty box. Let's hope all the numbers have the same width.
6048 % Also ignore the page number, which is conventionally not printed.
6049 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6050 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6052 % Parts, in the short toc.
6053 \def\shortpartentry#1#2#3#4{%
6055 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6056 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6059 % Chapters, in the main contents.
6060 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6062 % Chapters, in the short toc.
6063 % See comments in \dochapentry re vbox and related settings.
6064 \def\shortchapentry#1#2#3#4{%
6065 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6068 % Appendices, in the main contents.
6069 % Need the word Appendix, and a fixed-size box.
6071 \def\appendixbox#1{%
6072 % We use M since it's probably the widest letter.
6073 \setbox0 = \hbox{\putwordAppendix{} M}%
6074 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6076 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6078 % Unnumbered chapters.
6079 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6080 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6083 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6084 \let\appsecentry=\numsecentry
6085 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6088 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6089 \let\appsubsecentry=\numsubsecentry
6090 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6092 % And subsubsections.
6093 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6094 \let\appsubsubsecentry=\numsubsubsecentry
6095 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6097 % This parameter controls the indentation of the various levels.
6098 % Same as \defaultparindent.
6099 \newdimen\tocindent \tocindent = 15pt
6101 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6104 % If the toc has to be broken over pages, we want it to be at chapters
6105 % if at all possible; hence the \penalty.
6106 \def\dochapentry#1#2{%
6107 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6110 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6112 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6115 \def\dosecentry#1#2{\begingroup
6116 \secentryfonts \leftskip=\tocindent
6117 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6120 \def\dosubsecentry#1#2{\begingroup
6121 \subsecentryfonts \leftskip=2\tocindent
6122 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6125 \def\dosubsubsecentry#1#2{\begingroup
6126 \subsubsecentryfonts \leftskip=3\tocindent
6127 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6130 % We use the same \entry macro as for the index entries.
6131 \let\tocentry = \entry
6133 % Space between chapter (or whatever) number and the title.
6134 \def\labelspace{\hskip1em \relax}
6136 \def\dopageno#1{{\rm #1}}
6137 \def\doshortpageno#1{{\rm #1}}
6139 \def\chapentryfonts{\secfonts \rm}
6140 \def\secentryfonts{\textfonts}
6141 \def\subsecentryfonts{\textfonts}
6142 \def\subsubsecentryfonts{\textfonts}
6145 \message{environments,}
6146 % @foo ... @end foo.
6148 % @tex ... @end tex escapes into raw TeX temporarily.
6149 % One exception: @ is still an escape character, so that @end tex works.
6150 % But \@ or @@ will get a plain @ character.
6153 \setupmarkupstyle{tex}%
6154 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6155 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6156 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6167 % ' is active in math mode (mathcode"8000). So reset it, and all our
6168 % other math active characters (just in case), to plain's definitions.
6172 \let\bullet=\ptexbullet
6177 \let\equiv=\ptexequiv
6180 \let\indent=\ptexindent
6181 \let\noindent=\ptexnoindent
6188 \expandafter \let\csname top\endcsname=\ptextop % outer
6189 \let\frenchspacing=\plainfrenchspacing
6191 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6192 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6195 % There is no need to define \Etex.
6197 % Define @lisp ... @end lisp.
6198 % @lisp environment forms a group so it can rebind things,
6199 % including the definition of @end lisp (which normally is erroneous).
6201 % Amount to narrow the margins by for @lisp.
6202 \newskip\lispnarrowing \lispnarrowing=0.4in
6204 % This is the definition that ^^M gets inside @lisp, @example, and other
6205 % such environments. \null is better than a space, since it doesn't
6207 \def\lisppar{\null\endgraf}
6209 % This space is always present above and below environments.
6210 \newskip\envskipamount \envskipamount = 0pt
6212 % Make spacing and below environment symmetrical. We use \parskip here
6213 % to help in doing that, since in @example-like environments \parskip
6214 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6215 % start of the next paragraph will insert \parskip.
6217 \def\aboveenvbreak{{%
6218 % =10000 instead of <10000 because of a special case in \itemzzz and
6219 % \sectionheading, q.v.
6220 \ifnum \lastpenalty=10000 \else
6221 \advance\envskipamount by \parskip
6223 \ifdim\lastskip<\envskipamount
6225 % it's not a good place to break if the last penalty was \nobreak
6227 \ifnum\lastpenalty<10000 \penalty-50 \fi
6228 \vskip\envskipamount
6233 \let\afterenvbreak = \aboveenvbreak
6235 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6236 % also clear it, so that its embedded environments do the narrowing again.
6237 \let\nonarrowing=\relax
6239 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6240 % environment contents.
6241 \font\circle=lcircle10
6243 \newdimen\cartouter\newdimen\cartinner
6244 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6245 \circthick=\fontdimen8\circle
6247 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6248 \def\ctr{{\hskip 6pt\circle\char'010}}
6249 \def\cbl{{\circle\char'012\hskip -6pt}}
6250 \def\cbr{{\hskip 6pt\circle\char'011}}
6251 \def\carttop{\hbox to \cartouter{\hskip\lskip
6252 \ctl\leaders\hrule height\circthick\hfil\ctr
6254 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6255 \cbl\leaders\hrule height\circthick\hfil\cbr
6258 \newskip\lskip\newskip\rskip
6261 \ifhmode\par\fi % can't be in the midst of a paragraph.
6263 \lskip=\leftskip \rskip=\rightskip
6264 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6265 \cartinner=\hsize \advance\cartinner by-\lskip
6266 \advance\cartinner by-\rskip
6268 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6269 % side, and for 6pt waste from
6270 % each corner char, and rule thickness
6271 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6272 % Flag to tell @lisp, etc., not to narrow margin.
6273 \let\nonarrowing = t%
6275 % If this cartouche directly follows a sectioning command, we need the
6276 % \parskip glue (backspaced over by default) or the cartouche can
6277 % collide with the section heading.
6278 \ifnum\lastpenalty>10000 \vskip\parskip \fi
6281 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6289 \baselineskip=\normbskip
6290 \lineskip=\normlskip
6293 \comment % For explanation, see the end of def\group.
6308 % This macro is called at the beginning of all the @example variants,
6310 \newdimen\nonfillparindent
6313 \hfuzz = 12pt % Don't be fussy
6314 \sepspaces % Make spaces be word-separators rather than space tokens.
6315 \let\par = \lisppar % don't ignore blank lines
6316 \obeylines % each line of input is a line of output
6318 % Turn off paragraph indentation but redefine \indent to emulate
6319 % the normal \indent.
6320 \nonfillparindent=\parindent
6322 \let\indent\nonfillindent
6324 \emergencystretch = 0pt % don't try to avoid overfull boxes
6325 \ifx\nonarrowing\relax
6326 \advance \leftskip by \lispnarrowing
6327 \exdentamount=\lispnarrowing
6329 \let\nonarrowing = \relax
6331 \let\exdent=\nofillexdent
6336 % We want to swallow spaces (but not other tokens) after the fake
6337 % @indent in our nonfill-environments, where spaces are normally
6338 % active and set to @tie, resulting in them not being ignored after
6340 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6341 \gdef\nonfillindentcheck{%
6343 \expandafter\nonfillindentgobble%
6345 \leavevmode\nonfillindentbox%
6349 \def\nonfillindentgobble#1{\nonfillindent}
6350 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6352 % If you want all examples etc. small: @set dispenvsize small.
6353 % If you want even small examples the full size: @set dispenvsize nosmall.
6354 % This affects the following displayed environments:
6355 % @example, @display, @format, @lisp
6357 \def\smallword{small}
6358 \def\nosmallword{nosmall}
6359 \let\SETdispenvsize\relax
6360 \def\setnormaldispenv{%
6361 \ifx\SETdispenvsize\smallword
6362 % end paragraph for sake of leading, in case document has no blank
6363 % line. This is redundant with what happens in \aboveenvbreak, but
6364 % we need to do it before changing the fonts, and it's inconvenient
6365 % to change the fonts afterward.
6366 \ifnum \lastpenalty=10000 \else \endgraf \fi
6367 \smallexamplefonts \rm
6370 \def\setsmalldispenv{%
6371 \ifx\SETdispenvsize\nosmallword
6373 \ifnum \lastpenalty=10000 \else \endgraf \fi
6374 \smallexamplefonts \rm
6378 % We often define two environments, @foo and @smallfoo.
6379 % Let's do it in one command. #1 is the env name, #2 the definition.
6380 \def\makedispenvdef#1#2{%
6381 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6382 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6383 \expandafter\let\csname E#1\endcsname \afterenvbreak
6384 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6387 % Define two environment synonyms (#1 and #2) for an environment.
6388 \def\maketwodispenvdef#1#2#3{%
6389 \makedispenvdef{#1}{#3}%
6390 \makedispenvdef{#2}{#3}%
6393 % @lisp: indented, narrowed, typewriter font;
6394 % @example: same as @lisp.
6396 % @smallexample and @smalllisp: use smaller fonts.
6397 % Originally contributed by Pavel@xerox.
6399 \maketwodispenvdef{lisp}{example}{%
6401 \tt\setupmarkupstyle{example}%
6402 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6403 \gobble % eat return
6405 % @display/@smalldisplay: same as @lisp except keep current font.
6407 \makedispenvdef{display}{%
6412 % @format/@smallformat: same as @display except don't narrow margins.
6414 \makedispenvdef{format}{%
6415 \let\nonarrowing = t%
6420 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6422 \let\nonarrowing = t%
6426 \let\Eflushleft = \afterenvbreak
6430 \envdef\flushright{%
6431 \let\nonarrowing = t%
6433 \advance\leftskip by 0pt plus 1fill\relax
6436 \let\Eflushright = \afterenvbreak
6439 % @raggedright does more-or-less normal line breaking but no right
6440 % justification. From plain.tex.
6441 \envdef\raggedright{%
6442 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6444 \let\Eraggedright\par
6446 \envdef\raggedleft{%
6447 \parindent=0pt \leftskip0pt plus2em
6448 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6449 \hbadness=10000 % Last line will usually be underfull, so turn off
6450 % badness reporting.
6452 \let\Eraggedleft\par
6454 \envdef\raggedcenter{%
6455 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6456 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6457 \hbadness=10000 % Last line will usually be underfull, so turn off
6458 % badness reporting.
6460 \let\Eraggedcenter\par
6463 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6464 % and narrows the margins. We keep \parskip nonzero in general, since
6465 % we're doing normal filling. So, when using \aboveenvbreak and
6466 % \afterenvbreak, temporarily make \parskip 0.
6468 \makedispenvdef{quotation}{\quotationstart}
6470 \def\quotationstart{%
6471 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6474 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6475 \ifx\nonarrowing\relax
6476 \advance\leftskip by \lispnarrowing
6477 \advance\rightskip by \lispnarrowing
6478 \exdentamount = \lispnarrowing
6480 \let\nonarrowing = \relax
6482 \parsearg\quotationlabel
6485 % We have retained a nonzero parskip for the environment, since we're
6486 % doing normal filling.
6490 \ifx\quotationauthor\thisisundefined\else
6492 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6494 {\parskip=0pt \afterenvbreak}%
6496 \def\Esmallquotation{\Equotation}
6498 % If we're given an argument, typeset it in bold with a colon after.
6499 \def\quotationlabel#1{%
6501 \ifx\temp\empty \else
6507 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6508 % If we want to allow any <char> as delimiter,
6509 % we need the curly braces so that makeinfo sees the @verb command, eg:
6510 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6512 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6514 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6515 % active too. Otherwise, they get lost as the first character on a
6518 \do\ \do\\\do\{\do\}\do\$\do\&%
6519 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6520 \do\<\do\>\do\|\do\@\do+\do\"%
6521 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6522 % @set txicodequotebacktick will not have effect on @verb and
6523 % @verbatim, and ?` and !` ligatures won't get disabled.
6528 \def\uncatcodespecials{%
6529 \def\do##1{\catcode`##1=\other}\dospecials}
6531 % Setup for the @verb command.
6533 % Eight spaces for a tab
6535 \catcode`\^^I=\active
6536 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6540 \tt % easiest (and conventionally used) font for verbatim
6541 \def\par{\leavevmode\endgraf}%
6542 \setupmarkupstyle{verb}%
6544 % Respect line breaks,
6545 % print special symbols as themselves, and
6546 % make each space count
6547 % must do in this order:
6548 \obeylines \uncatcodespecials \sepspaces
6551 % Setup for the @verbatim environment
6553 % Real tab expansion.
6554 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6556 % We typeset each line of the verbatim in an \hbox, so we can handle
6557 % tabs. The \global is in case the verbatim line starts with an accent,
6558 % or some other command that starts with a begin-group. Otherwise, the
6559 % entire \verbbox would disappear at the corresponding end-group, before
6560 % it is typeset. Meanwhile, we can't have nested verbatim commands
6561 % (can we?), so the \global won't be overwriting itself.
6563 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6566 \catcode`\^^I=\active
6568 \catcode`\^^I=\active
6569 \def^^I{\leavevmode\egroup
6570 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6571 \divide\dimen\verbbox by\tabw
6572 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6573 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6574 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6579 % start the verbatim environment.
6580 \def\setupverbatim{%
6581 \let\nonarrowing = t%
6583 \tt % easiest (and conventionally used) font for verbatim
6584 % The \leavevmode here is for blank lines. Otherwise, we would
6585 % never \starttabox and the \egroup would end verbatim mode.
6586 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6588 \setupmarkupstyle{verbatim}%
6589 % Respect line breaks,
6590 % print special symbols as themselves, and
6591 % make each space count.
6592 % Must do in this order:
6593 \obeylines \uncatcodespecials \sepspaces
6594 \everypar{\starttabbox}%
6597 % Do the @verb magic: verbatim text is quoted by unique
6598 % delimiter characters. Before first delimiter expect a
6599 % right brace, after last delimiter expect closing brace:
6601 % \def\doverb'{'<char>#1<char>'}'{#1}
6603 % [Knuth] p. 382; only eat outer {}
6605 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6606 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6609 \def\verb{\begingroup\setupverb\doverb}
6612 % Do the @verbatim magic: define the macro \doverbatim so that
6613 % the (first) argument ends when '@end verbatim' is reached, ie:
6615 % \def\doverbatim#1@end verbatim{#1}
6617 % For Texinfo it's a lot easier than for LaTeX,
6618 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6619 % we need not redefine '\', '{' and '}'.
6621 % Inspired by LaTeX's verbatim command set [latex.ltx]
6626 % ignore everything up to the first ^^M, that's the newline at the end
6627 % of the @verbatim input line itself. Otherwise we get an extra blank
6628 % line in the output.
6629 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6630 % We really want {...\end verbatim} in the body of the macro, but
6631 % without the active space; thus we have to use \xdef and \gobble.
6635 \setupverbatim\doverbatim
6637 \let\Everbatim = \afterenvbreak
6640 % @verbatiminclude FILE - insert text of file in verbatim environment.
6642 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6644 \def\doverbatiminclude#1{%
6646 \makevalueexpandable
6648 \indexnofonts % Allow `@@' and other weird things in file names.
6649 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6655 % @copying ... @end copying.
6656 % Save the text away for @insertcopying later.
6658 % We save the uninterpreted tokens, rather than creating a box.
6659 % Saving the text in a box would be much easier, but then all the
6660 % typesetting commands (@smallbook, font changes, etc.) have to be done
6661 % beforehand -- and a) we want @copying to be done first in the source
6662 % file; b) letting users define the frontmatter in as flexible order as
6663 % possible is very desirable.
6665 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6666 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6668 \def\insertcopying{%
6670 \parindent = 0pt % paragraph indentation looks wrong on title page
6671 \scanexp\copyingtext
6679 \newskip\defbodyindent \defbodyindent=.4in
6680 \newskip\defargsindent \defargsindent=50pt
6681 \newskip\deflastargmargin \deflastargmargin=18pt
6682 \newcount\defunpenalty
6684 % Start the processing of @deffn:
6686 \ifnum\lastpenalty<10000
6688 \defunpenalty=10003 % Will keep this @deffn together with the
6689 % following @def command, see below.
6691 % If there are two @def commands in a row, we'll have a \nobreak,
6692 % which is there to keep the function description together with its
6693 % header. But if there's nothing but headers, we need to allow a
6694 % break somewhere. Check specifically for penalty 10002, inserted
6695 % by \printdefunline, instead of 10000, since the sectioning
6696 % commands also insert a nobreak penalty, and we don't want to allow
6697 % a break between a section heading and a defun.
6699 % As a further refinement, we avoid "club" headers by signalling
6700 % with penalty of 10003 after the very first @deffn in the
6701 % sequence (see above), and penalty of 10002 after any following
6703 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6705 % Similarly, after a section heading, do not allow a break.
6706 % But do insert the glue.
6707 \medskip % preceded by discardable penalty, so not a breakpoint
6711 \advance\leftskip by \defbodyindent
6712 \exdentamount=\defbodyindent
6716 % First, check whether we are in the right environment:
6719 % As above, allow line break if we have multiple x headers in a row.
6720 % It's not a great place, though.
6721 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6723 % And now, it's time to reuse the body of the original defun:
6724 \expandafter\gobbledefun#1%
6726 \def\gobbledefun#1\startdefun{}
6728 % \printdefunline \deffnheader{text}
6730 \def\printdefunline#1#2{%
6732 % call \deffnheader:
6735 \interlinepenalty = 10000
6736 \advance\rightskip by 0pt plus 1fil\relax
6738 \nobreak\vskip -\parskip
6739 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6740 % Some of the @defun-type tags do not enable magic parentheses,
6741 % rendering the following check redundant. But we don't optimize.
6746 \def\Edefun{\endgraf\medbreak}
6748 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6749 % the only thing remaining is to define \deffnheader.
6752 \expandafter\let\csname E#1\endcsname = \Edefun
6753 \edef\temp{\noexpand\domakedefun
6754 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6758 % \domakedefun \deffn \deffnx \deffnheader
6760 % Define \deffn and \deffnx, without parameters.
6761 % \deffnheader has to be defined explicitly.
6763 \def\domakedefun#1#2#3{%
6766 \doingtypefnfalse % distinguish typed functions from all else
6767 \parseargusing\activeparens{\printdefunline#3}%
6769 \def#2{\dodefunx#1}%
6773 \newif\ifdoingtypefn % doing typed function?
6774 \newif\ifrettypeownline % typeset return type on its own line?
6776 % @deftypefnnewline on|off says whether the return type of typed functions
6777 % are printed on their own line. This affects @deftypefn, @deftypefun,
6778 % @deftypeop, and @deftypemethod.
6780 \parseargdef\deftypefnnewline{%
6783 \expandafter\let\csname SETtxideftypefnnl\endcsname
6785 \else\ifx\temp\offword
6786 \expandafter\let\csname SETtxideftypefnnl\endcsname
6789 \errhelp = \EMsimple
6790 \errmessage{Unknown @txideftypefnnl value `\temp',
6795 % Untyped functions:
6797 % @deffn category name args
6798 \makedefun{deffn}{\deffngeneral{}}
6800 % @deffn category class name args
6801 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6803 % \defopon {category on}class name args
6804 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6806 % \deffngeneral {subind}category name args
6808 \def\deffngeneral#1#2 #3 #4\endheader{%
6809 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6810 \dosubind{fn}{\code{#3}}{#1}%
6811 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6816 % @deftypefn category type name args
6817 \makedefun{deftypefn}{\deftypefngeneral{}}
6819 % @deftypeop category class type name args
6820 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6822 % \deftypeopon {category on}class type name args
6823 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6825 % \deftypefngeneral {subind}category type name args
6827 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6828 \dosubind{fn}{\code{#4}}{#1}%
6830 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6835 % @deftypevr category type var args
6836 \makedefun{deftypevr}{\deftypecvgeneral{}}
6838 % @deftypecv category class type var args
6839 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6841 % \deftypecvof {category of}class type var args
6842 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6844 % \deftypecvgeneral {subind}category type var args
6846 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6847 \dosubind{vr}{\code{#4}}{#1}%
6848 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6851 % Untyped variables:
6853 % @defvr category var args
6854 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6856 % @defcv category class var args
6857 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6859 % \defcvof {category of}class var args
6860 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6864 % @deftp category name args
6865 \makedefun{deftp}#1 #2 #3\endheader{%
6866 \doind{tp}{\code{#2}}%
6867 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6870 % Remaining @defun-like shortcuts:
6871 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6872 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6873 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6874 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6875 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6876 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6877 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6878 \makedefun{defmethod}{\defopon\putwordMethodon}
6879 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6880 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6881 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6883 % \defname, which formats the name of the @def (not the args).
6884 % #1 is the category, such as "Function".
6885 % #2 is the return type, if any.
6886 % #3 is the function name.
6888 % We are followed by (but not passed) the arguments, if any.
6890 \def\defname#1#2#3{%
6892 % Get the values of \leftskip and \rightskip as they were outside the @def...
6893 \advance\leftskip by -\defbodyindent
6895 % Determine if we are typesetting the return type of a typed function
6896 % on a line by itself.
6897 \rettypeownlinefalse
6898 \ifdoingtypefn % doing a typed function specifically?
6899 % then check user option for putting return type on its own line:
6900 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6905 % How we'll format the category name. Putting it in brackets helps
6906 % distinguish it from the body text that may end up on the next line
6909 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6911 % Figure out line sizes for the paragraph shape. We'll always have at
6915 % The first line needs space for \box0; but if \rightskip is nonzero,
6916 % we need only space for the part of \box0 which exceeds it:
6917 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6919 % If doing a return type on its own line, we'll have another line.
6921 \advance\tempnum by 1
6922 \def\maybeshapeline{0in \hsize}%
6924 \def\maybeshapeline{}%
6927 % The continuations:
6928 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6930 % The final paragraph shape:
6931 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
6933 % Put the category name at the right margin.
6936 \hfil\box0 \kern-\hsize
6937 % \hsize has to be shortened this way:
6939 % Intentionally do not respect \rightskip, since we need the space.
6942 % Allow all lines to be underfull without complaint:
6943 \tolerance=10000 \hbadness=10000
6944 \exdentamount=\defbodyindent
6946 % defun fonts. We use typewriter by default (used to be bold) because:
6947 % . we're printing identifiers, they should be in tt in principle.
6948 % . in languages with many accents, such as Czech or French, it's
6949 % common to leave accents off identifiers. The result looks ok in
6950 % tt, but exceedingly strange in rm.
6951 % . we don't want -- and --- to be treated as ligatures.
6952 % . this still does not fix the ?` and !` ligatures, but so far no
6953 % one has made identifiers using them :).
6955 \def\temp{#2}% text of the return type
6956 \ifx\temp\empty\else
6957 \tclose{\temp}% typeset the return type
6959 % put return type on its own line; prohibit line break following:
6960 \hfil\vadjust{\nobreak}\break
6962 \space % type on same line, so just followed by a space
6964 \fi % no return type
6965 #3% output function name
6967 {\rm\enskip}% hskip 0.5 em of \tenrm
6970 % arguments will be output next, if any.
6973 % Print arguments in slanted roman (not ttsl), inconsistently with using
6974 % tt for the name. This is because literal text is sometimes needed in
6975 % the argument list (groff manual), and ttsl and tt are not very
6976 % distinguishable. Prevent hyphenation at `-' chars.
6979 % use sl by default (not ttsl),
6981 \df \sl \hyphenchar\font=0
6983 % On the other hand, if an argument has two dashes (for instance), we
6984 % want a way to get ttsl. Let's try @var for that.
6985 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6987 \sl\hyphenchar\font=45
6990 % We want ()&[] to print specially on the defun line.
6993 \catcode`\(=\active \catcode`\)=\active
6994 \catcode`\[=\active \catcode`\]=\active
6998 % Make control sequences which act like normal parenthesis chars.
6999 \let\lparen = ( \let\rparen = )
7001 % Be sure that we always have a definition for `(', etc. For example,
7002 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7003 % so TeX would otherwise complain about undefined control sequence.
7006 \global\let(=\lparen \global\let)=\rparen
7007 \global\let[=\lbrack \global\let]=\rbrack
7010 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7011 \gdef\magicamp{\let&=\amprm}
7014 \newcount\parencount
7016 % If we encounter &foo, then turn on ()-hacking afterwards
7018 \def\amprm#1 {\ampseentrue{\bf\ }}
7022 % At the first level, print parens in roman,
7023 % otherwise use the default font.
7024 \ifnum \parencount=1 \rm \fi
7026 % The \sf parens (in \boldbrax) actually are a little bolder than
7027 % the contained text. This is especially needed for [ and ] .
7031 \def\infirstlevel#1{%
7038 \def\bfafterword#1 {#1 \bf}
7041 \global\advance\parencount by 1
7043 \infirstlevel \bfafterword
7048 \global\advance\parencount by -1
7051 \newcount\brackcount
7053 \global\advance\brackcount by 1
7058 \global\advance\brackcount by -1
7061 \def\checkparencounts{%
7062 \ifnum\parencount=0 \else \badparencount \fi
7063 \ifnum\brackcount=0 \else \badbrackcount \fi
7065 % these should not use \errmessage; the glibc manual, at least, actually
7066 % has such constructs (when documenting function pointers).
7067 \def\badparencount{%
7068 \message{Warning: unbalanced parentheses in @def...}%
7069 \global\parencount=0
7071 \def\badbrackcount{%
7072 \message{Warning: unbalanced square brackets in @def...}%
7073 \global\brackcount=0
7080 % To do this right we need a feature of e-TeX, \scantokens,
7081 % which we arrange to emulate with a temporary file in ordinary TeX.
7082 \ifx\eTeXversion\thisisundefined
7083 \newwrite\macscribble
7086 \immediate\openout\macscribble=\jobname.tmp
7087 \immediate\write\macscribble{\the\toks0}%
7088 \immediate\closeout\macscribble
7093 \def\scanmacro#1{\begingroup
7095 \let\xeatspaces\eatspaces
7097 % Undo catcode changes of \startcontents and \doprintindex
7098 % When called from @insertcopying or (short)caption, we need active
7099 % backslash to get it printed correctly. Previously, we had
7100 % \catcode`\\=\other instead. We'll see whether a problem appears
7101 % with macro expansion. --kasal, 19aug04
7102 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7104 % ... and for \example:
7107 % The \empty here causes a following catcode 5 newline to be eaten as
7108 % part of reading whitespace after a control sequence. It does not
7109 % eat a catcode 13 newline. There's no good way to handle the two
7110 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7111 % would then have different behavior). See the Macro Details node in
7112 % the manual for the workaround we recommend for macros and
7113 % line-oriented commands.
7115 \scantokens{#1\empty}%
7119 \edef\temp{\noexpand\scanmacro{#1}}%
7123 \newcount\paramno % Count of parameters
7124 \newtoks\macname % Macro name
7125 \newif\ifrecursive % Is it recursive?
7127 % List of all defined macros in the form
7128 % \definedummyword\macro1\definedummyword\macro2...
7129 % Currently is also contains all @aliases; the list can be split
7130 % if there is a need.
7133 % Add the macro to \macrolist
7134 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7135 \def\addtomacrolistxxx#1{%
7136 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7137 \xdef\macrolist{\the\toks0}%
7141 % This does \let #1 = #2, with \csnames; that is,
7142 % \let \csname#1\endcsname = \csname#2\endcsname
7143 % (except of course we have to play expansion games).
7147 \csname#1\expandafter\endcsname
7151 % Trim leading and trailing spaces off a string.
7152 % Concepts from aro-bend problem 15 (see CTAN).
7154 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7155 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7156 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7158 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7161 % Trim a single trailing ^^M off a string.
7162 {\catcode`\^^M=\other \catcode`\Q=3%
7163 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7164 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7165 \gdef\eatcrb#1Q#2Q{#1}%
7168 % Macro bodies are absorbed as an argument in a context where
7169 % all characters are catcode 10, 11 or 12, except \ which is active
7170 % (as in normal texinfo). It is necessary to change the definition of \
7171 % to recognize macro arguments; this is the job of \mbodybackslash.
7173 % Non-ASCII encodings make 8-bit characters active, so un-activate
7174 % them to avoid their expansion. Must do this non-globally, to
7175 % confine the change to the current group.
7177 % It's necessary to have hard CRs when the macro is executed. This is
7178 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7179 % body, and then making it the \newlinechar in \scanmacro.
7181 \def\scanctxt{% used as subroutine
7191 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7194 \def\scanargctxt{% used for copying and captions, not macros.
7197 \catcode`\^^M=\other
7200 \def\macrobodyctxt{% used for @macro definitions
7204 \catcode`\^^M=\other
7208 \def\macroargctxt{% used when scanning invocations
7212 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7213 % for the single characters \ { }. Thus, we end up with the "commands"
7214 % that would be written @\ @{ @} in a Texinfo document.
7216 % We already have @{ and @}. For @\, we define it here, and only for
7217 % this purpose, to produce a typewriter backslash (so, the @\ that we
7218 % define for @math can't be used with @macro calls):
7220 \def\\{\normalbackslash}%
7222 % We would like to do this for \, too, since that is what makeinfo does.
7223 % But it is not possible, because Texinfo already has a command @, for a
7224 % cedilla accent. Documents must use @comma{} instead.
7226 % \anythingelse will almost certainly be an error of some kind.
7229 % \mbodybackslash is the definition of \ in @macro bodies.
7230 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7231 % where N is the macro parameter number.
7232 % We define \csname macarg.\endcsname to be \realbackslash, so
7233 % \\ in macro replacement text gets you a backslash.
7235 {\catcode`@=0 @catcode`@\=@active
7236 @gdef@usembodybackslash{@let\=@mbodybackslash}
7237 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7239 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7241 \def\margbackslash#1{\char`\#1 }
7243 \def\macro{\recursivefalse\parsearg\macroxxx}
7244 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7247 \getargs{#1}% now \macname is the macname and \argl the arglist
7248 \ifx\argl\empty % no arguments
7251 \expandafter\parsemargdef \argl;%
7252 \if\paramno>256\relax
7253 \ifx\eTeXversion\thisisundefined
7254 \errhelp = \EMsimple
7255 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7259 \if1\csname ismacro.\the\macname\endcsname
7260 \message{Warning: redefining \the\macname}%
7262 \expandafter\ifx\csname \the\macname\endcsname \relax
7263 \else \errmessage{Macro name \the\macname\space already defined}\fi
7264 \global\cslet{macsave.\the\macname}{\the\macname}%
7265 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7266 \addtomacrolist{\the\macname}%
7268 \begingroup \macrobodyctxt
7269 \ifrecursive \expandafter\parsermacbody
7270 \else \expandafter\parsemacbody
7273 \parseargdef\unmacro{%
7274 \if1\csname ismacro.#1\endcsname
7275 \global\cslet{#1}{macsave.#1}%
7276 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7277 % Remove the macro name from \macrolist:
7279 \expandafter\let\csname#1\endcsname \relax
7280 \let\definedummyword\unmacrodo
7281 \xdef\macrolist{\macrolist}%
7284 \errmessage{Macro #1 not defined}%
7288 % Called by \do from \dounmacro on each macro. The idea is to omit any
7289 % macro definitions that have been changed to \relax.
7295 \noexpand\definedummyword \noexpand#1%
7299 % This makes use of the obscure feature that if the last token of a
7300 % <parameter list> is #, then the preceding argument is delimited by
7301 % an opening brace, and that opening brace is not consumed.
7302 \def\getargs#1{\getargsxxx#1{}}
7303 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7304 \def\getmacname#1 #2\relax{\macname={#1}}
7305 \def\getmacargs#1{\def\argl{#1}}
7307 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7308 \edef\texiatcatcode{\the\catcode`\@}
7309 \catcode `@=11\relax
7311 % Parse the optional {params} list. Set up \paramno and \paramlist
7312 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7313 % in the params list to some hook where the argument si to be expanded. If
7314 % there are less than 10 arguments that hook is to be replaced by ##N where N
7315 % is the position in that list, that is to say the macro arguments are to be
7316 % defined `a la TeX in the macro body.
7318 % That gets used by \mbodybackslash (above).
7320 % We need to get `macro parameter char #' into several definitions.
7321 % The technique used is stolen from LaTeX: let \hash be something
7322 % unexpandable, insert that wherever you need a #, and then redefine
7323 % it to # just before using the token list produced.
7325 % The same technique is used to protect \eatspaces till just before
7326 % the macro is used.
7328 % If there are 10 or more arguments, a different technique is used, where the
7329 % hook remains in the body, and when macro is to be expanded the body is
7330 % processed again to replace the arguments.
7332 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7333 % argument N value and then \edef the body (nothing else will expand because of
7334 % the catcode regime underwhich the body was input).
7336 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7337 % arguments, you need that no macro has more than 256 arguments, otherwise an
7338 % error is produced.
7339 \def\parsemargdef#1;{%
7340 \paramno=0\def\paramlist{}%
7342 \let\xeatspaces\relax
7343 \parsemargdefxxx#1,;,%
7344 % In case that there are 10 or more arguments we parse again the arguments
7345 % list to set new definitions for the \macarg.BLAH macros corresponding to
7346 % each BLAH argument. It was anyhow needed to parse already once this list
7347 % in order to count the arguments, and as macros with at most 9 arguments
7348 % are by far more frequent than macro with 10 or more arguments, defining
7349 % twice the \macarg.BLAH macros does not cost too much processing power.
7350 \ifnum\paramno<10\relax\else
7352 \parsemmanyargdef@@#1,;,% 10 or more arguments
7355 \def\parsemargdefxxx#1,{%
7356 \if#1;\let\next=\relax
7357 \else \let\next=\parsemargdefxxx
7358 \advance\paramno by 1
7359 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7360 {\xeatspaces{\hash\the\paramno}}%
7361 \edef\paramlist{\paramlist\hash\the\paramno,}%
7364 \def\parsemmanyargdef@@#1,{%
7365 \if#1;\let\next=\relax
7367 \let\next=\parsemmanyargdef@@
7368 \edef\tempb{\eatspaces{#1}}%
7369 \expandafter\def\expandafter\tempa
7370 \expandafter{\csname macarg.\tempb\endcsname}%
7371 % Note that we need some extra \noexpand\noexpand, this is because we
7372 % don't want \the to be expanded in the \parsermacbody as it uses an
7374 \expandafter\edef\tempa
7375 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7376 \advance\paramno by 1\relax
7379 % These two commands read recursive and nonrecursive macro bodies.
7380 % (They're different since rec and nonrec macros end differently.)
7383 \catcode `\@\texiatcatcode
7384 \long\def\parsemacbody#1@end macro%
7385 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7386 \long\def\parsermacbody#1@end rmacro%
7387 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7388 \catcode `\@=11\relax
7393 \long\def\nillm@{\nil@}%
7395 % This macro is expanded during the Texinfo macro expansion, not during its
7396 % definition. It gets all the arguments values and assigns them to macros
7399 % #1 is the macro name
7400 % #2 is the list of argument names
7401 % #3 is the list of argument values
7402 \def\getargvals@#1#2#3{%
7403 \def\macargdeflist@{}%
7404 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7405 \def\paramlist{#2,\nil@}%
7409 \def\argvaluelist{#3,\nil@}%
7420 \ifx\paramlist\nilm@
7421 % Some sanity check needed here that \argvaluelist is also empty.
7422 \ifx\argvaluelist\nillm@
7424 \errhelp = \EMsimple
7425 \errmessage{Too many arguments in macro `\macroname'!}%
7427 \let\next\macargexpandinbody@
7429 \ifx\argvaluelist\nillm@
7430 % No more arguments values passed to macro. Set remaining named-arg
7432 \let\next\setemptyargvalues@
7434 % pop current arg name into \@tempb
7435 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7436 \expandafter\@tempa\expandafter{\paramlist}%
7437 % pop current argument value into \@tempc
7438 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7439 \expandafter\@tempa\expandafter{\argvaluelist}%
7440 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7441 % First place the new argument macro definition into \@tempd
7442 \expandafter\macname\expandafter{\@tempc}%
7443 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7444 \expandafter\def\expandafter\@tempe\expandafter{%
7445 \csname macarg.\@tempb\endcsname}%
7446 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7447 \push@\@tempd\macargdeflist@
7448 \let\next\getargvals@@
7455 \expandafter\expandafter\expandafter\def
7456 \expandafter\expandafter\expandafter#2%
7457 \expandafter\expandafter\expandafter{%
7461 % Replace arguments by their values in the macro body, and place the result
7463 \def\macvalstoargs@{%
7464 % To do this we use the property that token registers that are \the'ed
7465 % within an \edef expand only once. So we are going to place all argument
7466 % values into respective token registers.
7468 % First we save the token context, and initialize argument numbering.
7471 % Then, for each argument number #N, we place the corresponding argument
7472 % value into a new token list register \toks#N
7473 \expandafter\putargsintokens@\saveparamlist@,;,%
7474 % Then, we expand the body so that argument are replaced by their
7475 % values. The trick for values not to be expanded themselves is that they
7476 % are within tokens and that tokens expand only once in an \edef .
7477 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7478 % Now we restore the token stack pointer to free the token list registers
7479 % which we have used, but we make sure that expanded body is saved after
7483 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7486 \def\macargexpandinbody@{%
7487 %% Define the named-macro outside of this group and then close this group.
7491 % First the replace in body the macro arguments by their values, the result
7494 % Then we point at the \norecurse or \gobble (for recursive) macro value
7496 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7497 % Depending on whether it is recursive or not, we need some tailing
7504 % And now we do the real job:
7505 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7509 \def\putargsintokens@#1,{%
7510 \if#1;\let\next\relax
7512 \let\next\putargsintokens@
7513 % First we allocate the new token list register, and give it a temporary
7515 \toksdef\@tempb\the\paramno
7516 % Then we place the argument value into that token list register.
7517 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7518 \expandafter\@tempb\expandafter{\@tempa}%
7519 \advance\paramno by 1\relax
7524 % Save the token stack pointer into macro #1
7525 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7526 % Restore the token stack pointer from number in macro #1
7527 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7528 % newtoks that can be used non \outer .
7529 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7531 % Tailing missing arguments are set to empty
7532 \def\setemptyargvalues@{%
7533 \ifx\paramlist\nilm@
7534 \let\next\macargexpandinbody@
7536 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7537 \let\next\setemptyargvalues@
7542 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7543 \expandafter\def\expandafter\@tempa\expandafter{%
7544 \expandafter\def\csname macarg.#1\endcsname{}}%
7545 \push@\@tempa\macargdeflist@
7549 % #1 is the element target macro
7550 % #2 is the list macro
7551 % #3,#4\endargs@ is the list value
7552 \def\pop@#1#2#3,#4\endargs@{%
7556 \long\def\longpop@#1#2#3,#4\endargs@{%
7561 % This defines a Texinfo @macro. There are eight cases: recursive and
7562 % nonrecursive macros of zero, one, up to nine, and many arguments.
7563 % Much magic with \expandafter here.
7564 % \xdef is used so that macro definitions will survive the file
7565 % they're defined in; @include reads the file inside a group.
7568 \let\hash=##% convert placeholders to macro parameter chars
7572 \expandafter\xdef\csname\the\macname\endcsname{%
7573 \noexpand\scanmacro{\temp}}%
7575 \expandafter\xdef\csname\the\macname\endcsname{%
7576 \bgroup\noexpand\macroargctxt
7577 \noexpand\braceorline
7578 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7579 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7580 \egroup\noexpand\scanmacro{\temp}}%
7582 \ifnum\paramno<10\relax % at most 9
7583 \expandafter\xdef\csname\the\macname\endcsname{%
7584 \bgroup\noexpand\macroargctxt
7585 \noexpand\csname\the\macname xx\endcsname}%
7586 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7587 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7588 \expandafter\expandafter
7590 \expandafter\expandafter
7591 \csname\the\macname xxx\endcsname
7592 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7594 \expandafter\xdef\csname\the\macname\endcsname{%
7595 \noexpand\getargvals@{\the\macname}{\argl}%
7597 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7598 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7604 \expandafter\xdef\csname\the\macname\endcsname{%
7605 \noexpand\norecurse{\the\macname}%
7606 \noexpand\scanmacro{\temp}\egroup}%
7608 \expandafter\xdef\csname\the\macname\endcsname{%
7609 \bgroup\noexpand\macroargctxt
7610 \noexpand\braceorline
7611 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7612 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7614 \noexpand\norecurse{\the\macname}%
7615 \noexpand\scanmacro{\temp}\egroup}%
7617 \ifnum\paramno<10\relax
7618 \expandafter\xdef\csname\the\macname\endcsname{%
7619 \bgroup\noexpand\macroargctxt
7620 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7621 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7622 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7623 \expandafter\expandafter
7625 \expandafter\expandafter
7626 \csname\the\macname xxx\endcsname
7629 \noexpand\norecurse{\the\macname}%
7630 \noexpand\scanmacro{\temp}\egroup}%
7632 \expandafter\xdef\csname\the\macname\endcsname{%
7633 \noexpand\getargvals@{\the\macname}{\argl}%
7635 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7636 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7641 \catcode `\@\texiatcatcode\relax
7643 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7645 % \braceorline decides whether the next nonwhitespace character is a
7646 % {. If so it reads up to the closing }, if not, it reads the whole
7647 % line. Whatever was read is then fed to the next control sequence
7648 % as an argument (by \parsebrace or \parsearg).
7650 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7651 \def\braceorlinexxx{%
7652 \ifx\nchar\bgroup\else
7653 \expandafter\parsearg
7658 % We need some trickery to remove the optional spaces around the equal
7659 % sign. Make them active and then expand them all to nothing.
7661 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7662 \def\aliasxxx #1{\aliasyyy#1\relax}
7663 \def\aliasyyy #1=#2\relax{%
7665 \expandafter\let\obeyedspace=\empty
7666 \addtomacrolist{#1}%
7667 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7673 \message{cross references,}
7676 \newif\ifhavexrefs % True if xref values are known.
7677 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7679 % @inforef is relatively simple.
7680 \def\inforef #1{\inforefzzz #1,,,,**}
7681 \def\inforefzzz #1,#2,#3,#4**{%
7682 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7683 node \samp{\ignorespaces#1{}}}
7685 % @node's only job in TeX is to define \lastnode, which is used in
7686 % cross-references. The @node line might or might not have commas, and
7687 % might or might not have spaces before the first comma, like:
7688 % @node foo , bar , ...
7689 % We don't want such trailing spaces in the node name.
7691 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7693 % also remove a trailing comma, in case of something like this:
7694 % @node Help-Cross, , , Cross-refs
7695 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7696 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7699 \let\lastnode=\empty
7701 % Write a cross-reference definition for the current node. #1 is the
7702 % type (Ynumbered, Yappendix, Ynothing).
7705 \ifx\lastnode\empty\else
7706 \setref{\lastnode}{#1}%
7707 \global\let\lastnode=\empty
7711 % @anchor{NAME} -- define xref target at arbitrary point.
7713 \newcount\savesfregister
7715 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7716 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7717 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7719 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7720 % anchor), which consists of three parts:
7721 % 1) NAME-title - the current sectioning name taken from \lastsection,
7722 % or the anchor name.
7723 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7724 % empty for anchors.
7725 % 3) NAME-pg - the page number.
7727 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7728 % floats, there is an additional part, which is not written here:
7729 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7735 \atdummies % preserve commands, but don't expand them
7736 \edef\writexrdef##1##2{%
7737 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7738 ##1}{##2}}% these are parameters of \writexrdef
7740 \toks0 = \expandafter{\lastsection}%
7741 \immediate \writexrdef{title}{\the\toks0 }%
7742 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7743 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7748 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7749 % automatically in xrefs, if the third arg is not explicitly specified.
7750 % This was provided as a "secret" @set xref-automatic-section-title
7751 % variable, now it's official.
7753 \parseargdef\xrefautomaticsectiontitle{%
7756 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7758 \else\ifx\temp\offword
7759 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7762 \errhelp = \EMsimple
7763 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7769 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7770 % the node name, #2 the name of the Info cross-reference, #3 the printed
7771 % node name, #4 the name of the Info file, #5 the name of the printed
7772 % manual. All but the node name can be omitted.
7774 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7775 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7776 \def\ref#1{\xrefX[#1,,,,,,,]}
7777 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7779 \def\printedmanual{\ignorespaces #5}%
7780 \def\printedrefname{\ignorespaces #3}%
7781 \setbox1=\hbox{\printedmanual\unskip}%
7782 \setbox0=\hbox{\printedrefname\unskip}%
7784 % No printed node name was explicitly given.
7785 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7786 % Use the node name inside the square brackets.
7787 \def\printedrefname{\ignorespaces #1}%
7789 % Use the actual chapter/section title appear inside
7790 % the square brackets. Use the real section title if we have it.
7792 % It is in another manual, so we don't have it.
7793 \def\printedrefname{\ignorespaces #1}%
7796 % We know the real title if we have the xref values.
7797 \def\printedrefname{\refx{#1-title}{}}%
7799 % Otherwise just copy the Info node name.
7800 \def\printedrefname{\ignorespaces #1}%
7806 % Make link in pdf output.
7810 % This expands tokens, so do it after making catcode changes, so _
7811 % etc. don't get their TeX definitions.
7814 \edef\pdfxrefdest{#1}%
7815 \txiescapepdf\pdfxrefdest
7818 \startlink attr{/Border [0 0 0]}%
7819 \ifnum\filenamelength>0
7820 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7822 goto name{\pdfmkpgn{\pdfxrefdest}}%
7825 \setcolor{\linkcolor}%
7828 % Float references are printed completely differently: "Figure 1.2"
7829 % instead of "[somenode], p.3". We distinguish them by the
7830 % LABEL-title being set to a magic string.
7832 % Have to otherify everything special to allow the \csname to
7833 % include an _ in the xref name, etc.
7836 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7837 \csname XR#1-title\endcsname
7839 \iffloat\Xthisreftitle
7840 % If the user specified the print name (third arg) to the ref,
7841 % print it instead of our usual "Figure 1.2".
7848 % if the user also gave the printed manual name (fifth arg), append
7851 \space \putwordin{} \cite{\printedmanual}%
7854 % node/anchor (non-float) references.
7856 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7857 % insert empty discretionaries after hyphens, which means that it will
7858 % not find a line break at a hyphen in a node names. Since some manuals
7859 % are best written with fairly long node names, containing hyphens, this
7860 % is a loss. Therefore, we give the text of the node name again, so it
7861 % is as if TeX is seeing it for the first time.
7863 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7865 % _ (for example) has to be the character _ for the purposes of the
7866 % control sequence corresponding to the node, but it has to expand
7867 % into the usual \leavevmode...\vrule stuff for purposes of
7868 % printing. So we \turnoffactive for the \refx-snt, back on for the
7869 % printing, back off for the \refx-pg.
7871 % Only output a following space if the -snt ref is nonempty; for
7872 % @unnumbered and @anchor, it won't be.
7873 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7874 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7876 % output the `[mynode]' via a macro so it can be overridden.
7877 \xrefprintnodename\printedrefname
7879 % But we always want a comma and a space:
7882 % output the `page 3'.
7883 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7889 % This macro is called from \xrefX for the `[nodename]' part of xref
7890 % output. It's a separate macro only so it can be changed more easily,
7891 % since square brackets don't work well in some documents. Particularly
7892 % one that Bob is working on :).
7894 \def\xrefprintnodename#1{[#1]}
7896 % Things referred to by \setref.
7902 \putwordChapter@tie \the\chapno
7903 \else \ifnum\subsecno=0
7904 \putwordSection@tie \the\chapno.\the\secno
7905 \else \ifnum\subsubsecno=0
7906 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7908 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7913 \putwordAppendix@tie @char\the\appendixno{}%
7914 \else \ifnum\subsecno=0
7915 \putwordSection@tie @char\the\appendixno.\the\secno
7916 \else \ifnum\subsubsecno=0
7917 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7920 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7924 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7925 % If its value is nonempty, SUFFIX is output afterward.
7931 \expandafter\global\expandafter\let\expandafter\thisrefX
7932 \csname XR#1\endcsname
7935 % If not defined, say something at least.
7936 \angleleft un\-de\-fined\angleright
7939 {\toks0 = {#1}% avoid expansion of possibly-complex value
7940 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
7943 \global\warnedxrefstrue
7944 \message{Cross reference values unknown; you must run TeX again.}%
7949 % It's defined, so just use it.
7952 #2% Output the suffix in any case.
7955 % This is the macro invoked by entries in the aux file. Usually it's
7956 % just a \def (we prepend XR to the control sequence name to avoid
7957 % collisions). But if this is a float type, we have more work to do.
7960 {% The node name might contain 8-bit characters, which in our current
7961 % implementation are changed to commands like @'e. Don't let these
7962 % mess up the control sequence name.
7965 \xdef\safexrefname{#1}%
7968 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7970 % Was that xref control sequence that we just defined for a float?
7971 \expandafter\iffloat\csname XR\safexrefname\endcsname
7972 % it was a float, and we have the (safe) float type in \iffloattype.
7973 \expandafter\let\expandafter\floatlist
7974 \csname floatlist\iffloattype\endcsname
7976 % Is this the first time we've seen this float type?
7977 \expandafter\ifx\floatlist\relax
7978 \toks0 = {\do}% yes, so just \do
7980 % had it before, so preserve previous elements in list.
7981 \toks0 = \expandafter{\floatlist\do}%
7984 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7985 % for later use in \listoffloats.
7986 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7991 % Read the last existing aux file, if any. No error if none exists.
7994 \openin 1 \jobname.aux
7997 \global\havexrefstrue
8002 \def\setupdatafile{%
8003 \catcode`\^^@=\other
8004 \catcode`\^^A=\other
8005 \catcode`\^^B=\other
8006 \catcode`\^^C=\other
8007 \catcode`\^^D=\other
8008 \catcode`\^^E=\other
8009 \catcode`\^^F=\other
8010 \catcode`\^^G=\other
8011 \catcode`\^^H=\other
8012 \catcode`\^^K=\other
8013 \catcode`\^^L=\other
8014 \catcode`\^^N=\other
8015 \catcode`\^^P=\other
8016 \catcode`\^^Q=\other
8017 \catcode`\^^R=\other
8018 \catcode`\^^S=\other
8019 \catcode`\^^T=\other
8020 \catcode`\^^U=\other
8021 \catcode`\^^V=\other
8022 \catcode`\^^W=\other
8023 \catcode`\^^X=\other
8024 \catcode`\^^Z=\other
8025 \catcode`\^^[=\other
8026 \catcode`\^^\=\other
8027 \catcode`\^^]=\other
8028 \catcode`\^^^=\other
8029 \catcode`\^^_=\other
8030 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8031 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8032 % supported in the main text, it doesn't seem desirable. Furthermore,
8033 % that is not enough: for node names that actually contain a ^
8034 % character, we would end up writing a line like this: 'xrdef {'hat
8035 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8036 % argument, and \hat is not an expandable control sequence. It could
8037 % all be worked out, but why? Either we support ^^ or we don't.
8039 % The other change necessary for this was to define \auxhat:
8040 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8041 % and then to call \auxhat in \setq.
8045 % Special characters. Should be turned off anyway, but...
8058 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8060 % This is to support \ in node names and titles, since the \
8061 % characters end up in a \csname. It's easier than
8062 % leaving it active and making its active definition an actual \
8063 % character. What I don't understand is why it works in the *value*
8064 % of the xrdef. Seems like it should be a catcode12 \, and that
8065 % should not typeset properly. But it works, so I'm moving on for
8066 % now. --karl, 15jan04.
8069 % Make the characters 128-255 be printing characters.
8073 \catcode\count1=\other
8074 \advance\count1 by 1
8075 \ifnum \count1<256 \loop \fi
8079 % @ is our escape character in .aux files, and we need braces.
8085 \def\readdatafile#1{%
8092 \message{insertions,}
8093 % including footnotes.
8095 \newcount \footnoteno
8097 % The trailing space in the following definition for supereject is
8098 % vital for proper filling; pages come out unaligned when you do a
8099 % pagealignmacro call if that space before the closing brace is
8100 % removed. (Generally, numeric constants should always be followed by a
8101 % space to prevent strange expansion errors.)
8102 \def\supereject{\par\penalty -20000\footnoteno =0 }
8104 % @footnotestyle is meaningful for Info output only.
8105 \let\footnotestyle=\comment
8109 % Auto-number footnotes. Otherwise like plain.
8111 \let\indent=\ptexindent
8112 \let\noindent=\ptexnoindent
8113 \global\advance\footnoteno by \@ne
8114 \edef\thisfootno{$^{\the\footnoteno}$}%
8116 % In case the footnote comes at the end of a sentence, preserve the
8117 % extra spacing after we do the footnote number.
8119 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8121 % Remove inadvertent blank space before typesetting the footnote number.
8127 % Don't bother with the trickery in plain.tex to not require the
8128 % footnote text as a parameter. Our footnotes don't need to be so general.
8130 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8131 % \parseargline) fails inside footnotes because the tokens are fixed when
8132 % the footnote is read. --karl, 16nov96.
8135 \insert\footins\bgroup
8136 % We want to typeset this text as a normal paragraph, even if the
8137 % footnote reference occurs in (for example) a display environment.
8138 % So reset some parameters.
8140 \interlinepenalty\interfootnotelinepenalty
8141 \splittopskip\ht\strutbox % top baseline for broken footnotes
8142 \splitmaxdepth\dp\strutbox
8143 \floatingpenalty\@MM
8148 \parindent\defaultparindent
8152 % Because we use hanging indentation in footnotes, a @noindent appears
8153 % to exdent this text, so make it be a no-op. makeinfo does not use
8154 % hanging indentation so @noindent can still be needed within footnote
8155 % text after an @example or the like (not that this is good style).
8156 \let\noindent = \relax
8158 % Hang the footnote text off the number. Use \everypar in case the
8159 % footnote extends for more than one paragraph.
8160 \everypar = {\hang}%
8161 \textindent{\thisfootno}%
8163 % Don't crash into the line above the footnote text. Since this
8164 % expands into a box, it must come within the paragraph, lest it
8165 % provide a place where TeX can split the footnote.
8168 % Invoke rest of plain TeX footnote routine.
8169 \futurelet\next\fo@t
8171 }%end \catcode `\@=11
8173 % In case a @footnote appears in a vbox, save the footnote text and create
8174 % the real \insert just after the vbox finished. Otherwise, the insertion
8176 % Similarly, if a @footnote appears inside an alignment, save the footnote
8177 % text to a box and make the \insert when a row of the table is finished.
8178 % And the same can be done for other insert classes. --kasal, 16nov03.
8180 % Replace the \insert primitive by a cheating macro.
8181 % Deeper inside, just make sure that the saved insertions are not spilled
8184 \def\startsavinginserts{%
8185 \ifx \insert\ptexinsert
8186 \let\insert\saveinsert
8188 \let\checkinserts\relax
8192 % This \insert replacement works for both \insert\footins{foo} and
8193 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8196 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8197 \afterassignment\next
8198 % swallow the left brace
8201 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8202 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8204 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8206 \def\placesaveins#1{%
8207 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8211 % eat @SAVE -- beware, all of them have catcode \other:
8213 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8214 \gdef\gobblesave @SAVE{}
8218 \def\newsaveins #1{%
8219 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8222 \def\newsaveinsX #1{%
8223 \csname newbox\endcsname #1%
8224 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8229 \let\checkinserts\empty
8234 % @image. We use the macros from epsf.tex to support this.
8235 % If epsf.tex is not installed and @image is used, we complain.
8237 % Check for and read epsf.tex up front. If we read it only at @image
8238 % time, we might be inside a group, and then its definitions would get
8239 % undone and the next image would fail.
8240 \openin 1 = epsf.tex
8242 % Do not bother showing banner with epsf.tex v2.7k (available in
8243 % doc/epsf.tex and on ctan).
8244 \def\epsfannounce{\toks0 = }%
8249 % We will only complain once about lack of epsf.tex.
8250 \newif\ifwarnednoepsf
8251 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8252 work. It is also included in the Texinfo distribution, or you can get
8253 it from ftp://tug.org/tex/epsf.tex.}
8256 \ifx\epsfbox\thisiundefined
8257 \ifwarnednoepsf \else
8258 \errhelp = \noepsfhelp
8259 \errmessage{epsf.tex not found, images will be ignored}%
8260 \global\warnednoepsftrue
8263 \imagexxx #1,,,,,\finish
8267 % Arguments to @image:
8268 % #1 is (mandatory) image filename; we tack on .eps extension.
8269 % #2 is (optional) width, #3 is (optional) height.
8270 % #4 is (ignored optional) html alt text.
8271 % #5 is (ignored optional) extension.
8272 % #6 is just the usual extra ignored arg for parsing stuff.
8274 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8275 \catcode`\^^M = 5 % in case we're inside an example
8276 \normalturnoffactive % allow _ et al. in names
8277 % If the image is by itself, center it.
8281 % Usually we'll have text after the image which will insert
8282 % \parskip glue, so insert it here too to equalize the space
8284 \nobreak\vskip\parskip
8288 % Leave vertical mode so that indentation from an enclosing
8289 % environment such as @quotation is respected. On the other hand, if
8290 % it's at the top level, we don't want the normal paragraph indentation.
8295 \dopdfimage{#1}{#2}{#3}%
8297 % \epsfbox itself resets \epsf?size at each figure.
8298 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8299 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8303 \ifimagevmode \medskip \fi % space after the standalone image
8307 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8308 % etc. We don't actually implement floating yet, we always include the
8309 % float "here". But it seemed the best name for the future.
8311 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8313 % There may be a space before second and/or third parameter; delete it.
8314 \def\eatcommaspace#1, {#1,}
8316 % #1 is the optional FLOATTYPE, the text label for this float, typically
8317 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8318 % this float will not be numbered and cannot be referred to.
8320 % #2 is the optional xref label. Also must be present for the float to
8323 % #3 is the optional positioning argument; for now, it is ignored. It
8324 % will somehow specify the positions allowed to float to (here, top, bottom).
8326 % We keep a separate counter for each FLOATTYPE, which we reset at each
8327 % chapter-level command.
8328 \let\resetallfloatnos=\empty
8330 \def\dofloat#1,#2,#3,#4\finish{%
8331 \let\thiscaption=\empty
8332 \let\thisshortcaption=\empty
8334 % don't lose footnotes inside @float.
8336 % BEWARE: when the floats start float, we have to issue warning whenever an
8337 % insert appears inside a float which could possibly float. --kasal, 26may04
8341 % We can't be used inside a paragraph.
8346 \def\floatlabel{#2}%
8347 \def\floatloc{#3}% we do nothing with this yet.
8349 \ifx\floattype\empty
8350 \let\safefloattype=\empty
8353 % the floattype might have accents or other special characters,
8354 % but we need to use it in a control sequence name.
8357 \xdef\safefloattype{\floattype}%
8361 % If label is given but no type, we handle that as the empty type.
8362 \ifx\floatlabel\empty \else
8363 % We want each FLOATTYPE to be numbered separately (Figure 1,
8364 % Table 1, Figure 2, ...). (And if no label, no number.)
8366 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8367 \global\advance\floatno by 1
8370 % This magic value for \lastsection is output by \setref as the
8371 % XREFLABEL-title value. \xrefX uses it to distinguish float
8372 % labels (which have a completely different output format) from
8373 % node and anchor labels. And \xrdef uses it to construct the
8376 \edef\lastsection{\floatmagic=\safefloattype}%
8377 \setref{\floatlabel}{Yfloat}%
8381 % start with \parskip glue, I guess.
8384 % Don't suppress indentation if a float happens to start a section.
8385 \restorefirstparagraphindent
8388 % we have these possibilities:
8389 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8390 % @float Foo,lbl & no caption: Foo 1.1
8391 % @float Foo & @caption{Cap}: Foo: Cap
8392 % @float Foo & no caption: Foo
8393 % @float ,lbl & Caption{Cap}: 1.1: Cap
8394 % @float ,lbl & no caption: 1.1
8395 % @float & @caption{Cap}: Cap
8396 % @float & no caption:
8399 \let\floatident = \empty
8401 % In all cases, if we have a float type, it comes first.
8402 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8404 % If we have an xref label, the number comes next.
8405 \ifx\floatlabel\empty \else
8406 \ifx\floattype\empty \else % if also had float type, need tie first.
8407 \appendtomacro\floatident{\tie}%
8410 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8413 % Start the printed caption with what we've constructed in
8414 % \floatident, but keep it separate; we need \floatident again.
8415 \let\captionline = \floatident
8417 \ifx\thiscaption\empty \else
8418 \ifx\floatident\empty \else
8419 \appendtomacro\captionline{: }% had ident, so need a colon between
8423 \appendtomacro\captionline{\scanexp\thiscaption}%
8426 % If we have anything to print, print it, with space before.
8427 % Eventually this needs to become an \insert.
8428 \ifx\captionline\empty \else
8432 % Space below caption.
8436 % If have an xref label, write the list of floats info. Do this
8437 % after the caption, to avoid chance of it being a breakpoint.
8438 \ifx\floatlabel\empty \else
8439 % Write the text that goes in the lof to the aux file as
8440 % \floatlabel-lof. Besides \floatident, we include the short
8441 % caption if specified, else the full caption if specified, else nothing.
8445 % since we read the caption text in the macro world, where ^^M
8446 % is turned into a normal character, we have to scan it back, so
8447 % we don't write the literal three characters "^^M" into the aux file.
8449 \xdef\noexpand\gtemp{%
8450 \ifx\thisshortcaption\empty
8457 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8458 \ifx\gtemp\empty \else : \gtemp \fi}}%
8461 \egroup % end of \vtop
8463 % place the captured inserts
8465 % BEWARE: when the floats start floating, we have to issue warning
8466 % whenever an insert appears inside a float which could possibly
8467 % float. --kasal, 26may04
8472 % Append the tokens #2 to the definition of macro #1, not expanding either.
8474 \def\appendtomacro#1#2{%
8475 \expandafter\def\expandafter#1\expandafter{#1#2}%
8478 % @caption, @shortcaption
8480 \def\caption{\docaption\thiscaption}
8481 \def\shortcaption{\docaption\thisshortcaption}
8482 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8483 \def\defcaption#1#2{\egroup \def#1{#2}}
8485 % The parameter is the control sequence identifying the counter we are
8486 % going to use. Create it if it doesn't exist and assign it to \floatno.
8489 % Haven't seen this figure type before.
8490 \csname newcount\endcsname #1%
8492 % Remember to reset this floatno at the next chap.
8493 \expandafter\gdef\expandafter\resetallfloatnos
8494 \expandafter{\resetallfloatnos #1=0 }%
8499 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8500 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8501 % first read the @float command.
8503 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8505 % Magic string used for the XREFLABEL-title value, so \xrefX can
8506 % distinguish floats from other xref types.
8507 \def\floatmagic{!!float!!}
8509 % #1 is the control sequence we are passed; we expand into a conditional
8510 % which is true if #1 represents a float ref. That is, the magic
8511 % \lastsection value which we \setref above.
8513 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8515 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8516 % (safe) float type for this float. We set \iffloattype to #2.
8518 \def\doiffloat#1=#2=#3\finish{%
8520 \def\iffloattype{#2}%
8521 \ifx\temp\floatmagic
8524 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8526 \parseargdef\listoffloats{%
8527 \def\floattype{#1}% floattype
8529 % the floattype might have accents or other special characters,
8530 % but we need to use it in a control sequence name.
8533 \xdef\safefloattype{\floattype}%
8536 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8537 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8539 % if the user said @listoffloats foo but never @float foo.
8540 \message{\linenumber No `\safefloattype' floats to list.}%
8544 \leftskip=\tocindent % indent these entries like a toc
8545 \let\do=\listoffloatsdo
8546 \csname floatlist\safefloattype\endcsname
8551 % This is called on each entry in a list of floats. We're passed the
8552 % xref label, in the form LABEL-title, which is how we save it in the
8553 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8554 % has the text we're supposed to typeset here.
8556 % Figures without xref labels will not be included in the list (since
8557 % they won't appear in the aux file).
8559 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8560 \def\listoffloatsdoentry#1-title\finish{{%
8561 % Can't fully expand XR#1-lof because it can contain anything. Just
8562 % pass the control sequence. On the other hand, XR#1-pg is just the
8563 % page number, and we want to fully expand that so we can get a link
8565 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8567 % use the same \entry macro we use to generate the TOC and index.
8568 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8573 \message{localization,}
8575 % For single-language documents, @documentlanguage is usually given very
8576 % early, just after @documentencoding. Single argument is the language
8577 % (de) or locale (de_DE) abbreviation.
8580 \catcode`\_ = \active
8582 \parseargdef\documentlanguage{\begingroup
8583 \let_=\normalunderscore % normal _ character for filenames
8584 \tex % read txi-??.tex file in plain TeX.
8585 % Read the file by the name they passed if it exists.
8586 \openin 1 txi-#1.tex
8588 \documentlanguagetrywithoutunderscore{#1_\finish}%
8590 \globaldefs = 1 % everything in the txi-LL files needs to persist
8594 \endgroup % end raw TeX
8597 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8600 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8601 \openin 1 txi-#1.tex
8603 \errhelp = \nolanghelp
8604 \errmessage{Cannot read language file txi-#1.tex}%
8606 \globaldefs = 1 % everything in the txi-LL files needs to persist
8611 }% end of special _ catcode
8613 \newhelp\nolanghelp{The given language definition file cannot be found or
8614 is empty. Maybe you need to install it? Putting it in the current
8615 directory should work if nowhere else does.}
8617 % This macro is called from txi-??.tex files; the first argument is the
8618 % \language name to set (without the "\lang@" prefix), the second and
8619 % third args are \{left,right}hyphenmin.
8621 % The language names to pass are determined when the format is built.
8622 % See the etex.log file created at that time, e.g.,
8623 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8625 % With TeX Live 2008, etex now includes hyphenation patterns for all
8626 % available languages. This means we can support hyphenation in
8627 % Texinfo, at least to some extent. (This still doesn't solve the
8628 % accented characters problem.)
8631 \def\txisetlanguage#1#2#3{%
8632 % do not set the language if the name is undefined in the current TeX.
8633 \expandafter\ifx\csname lang@#1\endcsname \relax
8634 \message{no patterns for #1}%
8636 \global\language = \csname lang@#1\endcsname
8638 % but there is no harm in adjusting the hyphenmin values regardless.
8639 \global\lefthyphenmin = #2\relax
8640 \global\righthyphenmin = #3\relax
8643 % Helpers for encodings.
8644 % Set the catcode of characters 128 through 255 to the specified number.
8646 \def\setnonasciicharscatcode#1{%
8648 \loop\ifnum\count255<256
8649 \global\catcode\count255=#1\relax
8650 \advance\count255 by 1
8654 \def\setnonasciicharscatcodenonglobal#1{%
8656 \loop\ifnum\count255<256
8657 \catcode\count255=#1\relax
8658 \advance\count255 by 1
8662 % @documentencoding sets the definition of non-ASCII characters
8663 % according to the specified encoding.
8665 \parseargdef\documentencoding{%
8666 % Encoding being declared for the document.
8667 \def\declaredencoding{\csname #1.enc\endcsname}%
8669 % Supported encodings: names converted to tokens in order to be able
8670 % to compare them with \ifx.
8671 \def\ascii{\csname US-ASCII.enc\endcsname}%
8672 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8673 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8674 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8675 \def\utfeight{\csname UTF-8.enc\endcsname}%
8677 \ifx \declaredencoding \ascii
8680 \else \ifx \declaredencoding \lattwo
8681 \setnonasciicharscatcode\active
8684 \else \ifx \declaredencoding \latone
8685 \setnonasciicharscatcode\active
8688 \else \ifx \declaredencoding \latnine
8689 \setnonasciicharscatcode\active
8692 \else \ifx \declaredencoding \utfeight
8693 \setnonasciicharscatcode\active
8697 \message{Unknown document encoding #1, ignoring.}%
8706 % A message to be logged when using a character that isn't available
8707 % the default font encoding (OT1).
8709 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8711 % Take account of \c (plain) vs. \, (Texinfo) difference.
8712 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8714 % First, make active non-ASCII characters in order for them to be
8715 % correctly categorized when TeX reads the replacement text of
8716 % macros containing the character definitions.
8717 \setnonasciicharscatcode\active
8719 % Latin1 (ISO-8859-1) character definitions.
8720 \def\latonechardefs{%
8722 \gdef^^a1{\exclamdown}
8723 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8724 \gdef^^a3{{\pounds}}
8725 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8726 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8727 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8730 \gdef^^a9{\copyright}
8732 \gdef^^ab{\guillemetleft}
8735 \gdef^^ae{\registeredsymbol}
8738 \gdef^^b0{\textdegree}
8747 \gdef^^b8{\cedilla\ }
8751 \gdef^^bb{\guillemetright}
8752 \gdef^^bc{$1\over4$}
8753 \gdef^^bd{$1\over2$}
8754 \gdef^^be{$3\over4$}
8755 \gdef^^bf{\questiondown}
8762 \gdef^^c5{\ringaccent A}
8764 \gdef^^c7{\cedilla C}
8796 \gdef^^e5{\ringaccent a}
8798 \gdef^^e7{\cedilla c}
8803 \gdef^^ec{\`{\dotless i}}
8804 \gdef^^ed{\'{\dotless i}}
8805 \gdef^^ee{\^{\dotless i}}
8806 \gdef^^ef{\"{\dotless i}}
8826 % Latin9 (ISO-8859-15) encoding character definitions.
8827 \def\latninechardefs{%
8828 % Encoding is almost identical to Latin1.
8841 % Latin2 (ISO-8859-2) character definitions.
8842 \def\lattwochardefs{%
8844 \gdef^^a1{\ogonek{A}}
8847 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8853 \gdef^^aa{\cedilla S}
8858 \gdef^^af{\dotaccent Z}
8860 \gdef^^b0{\textdegree}
8861 \gdef^^b1{\ogonek{a}}
8862 \gdef^^b2{\ogonek{ }}
8868 \gdef^^b8{\cedilla\ }
8870 \gdef^^ba{\cedilla s}
8875 \gdef^^bf{\dotaccent z}
8884 \gdef^^c7{\cedilla C}
8887 \gdef^^ca{\ogonek{E}}
8903 \gdef^^d9{\ringaccent U}
8908 \gdef^^de{\cedilla T}
8918 \gdef^^e7{\cedilla c}
8921 \gdef^^ea{\ogonek{e}}
8924 \gdef^^ed{\'{\dotless{i}}}
8925 \gdef^^ee{\^{\dotless{i}}}
8937 \gdef^^f9{\ringaccent u}
8942 \gdef^^fe{\cedilla t}
8943 \gdef^^ff{\dotaccent{}}
8946 % UTF-8 character definitions.
8948 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8949 % changes for Texinfo conventions. It is included here under the GPL by
8950 % permission from Frank Mittelbach and the LaTeX team.
8956 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8957 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8959 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8960 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8962 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8963 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8965 \gdef\UTFviiiDefined#1{%
8967 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8978 \global\catcode\countUTFx\active
8979 \uccode`\~\countUTFx
8980 \uppercase\expandafter{\UTFviiiTmp}%
8981 \advance\countUTFx by 1
8982 \ifnum\countUTFx < \countUTFy
8983 \expandafter\UTFviiiLoop
8989 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8995 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9001 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9014 \gdef\DeclareUnicodeCharacter#1#2{%
9015 \countUTFz = "#1\relax
9016 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9019 \def\UTFviiiTwoOctets##1##2{%
9020 \csname u8:##1\string ##2\endcsname}%
9021 \def\UTFviiiThreeOctets##1##2##3{%
9022 \csname u8:##1\string ##2\string ##3\endcsname}%
9023 \def\UTFviiiFourOctets##1##2##3##4{%
9024 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9025 \expandafter\expandafter\expandafter\expandafter
9026 \expandafter\expandafter\expandafter
9027 \gdef\UTFviiiTmp{#2}%
9030 \gdef\parseXMLCharref{%
9031 \ifnum\countUTFz < "A0\relax
9032 \errhelp = \EMsimple
9033 \errmessage{Cannot define Unicode char value < 00A0}%
9034 \else\ifnum\countUTFz < "800\relax
9036 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9037 \else\ifnum\countUTFz < "10000\relax
9040 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9045 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9049 \gdef\parseUTFviiiA#1{%
9050 \countUTFx = \countUTFz
9051 \divide\countUTFz by 64
9052 \countUTFy = \countUTFz
9053 \multiply\countUTFz by 64
9054 \advance\countUTFx by -\countUTFz
9055 \advance\countUTFx by 128
9056 \uccode `#1\countUTFx
9057 \countUTFz = \countUTFy}
9059 \gdef\parseUTFviiiB#1#2#3#4{%
9060 \advance\countUTFz by "#10\relax
9061 \uccode `#3\countUTFz
9062 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9065 \def\utfeightchardefs{%
9066 \DeclareUnicodeCharacter{00A0}{\tie}
9067 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9068 \DeclareUnicodeCharacter{00A3}{\pounds}
9069 \DeclareUnicodeCharacter{00A8}{\"{ }}
9070 \DeclareUnicodeCharacter{00A9}{\copyright}
9071 \DeclareUnicodeCharacter{00AA}{\ordf}
9072 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9073 \DeclareUnicodeCharacter{00AD}{\-}
9074 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9075 \DeclareUnicodeCharacter{00AF}{\={ }}
9077 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9078 \DeclareUnicodeCharacter{00B4}{\'{ }}
9079 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9080 \DeclareUnicodeCharacter{00BA}{\ordm}
9081 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9082 \DeclareUnicodeCharacter{00BF}{\questiondown}
9084 \DeclareUnicodeCharacter{00C0}{\`A}
9085 \DeclareUnicodeCharacter{00C1}{\'A}
9086 \DeclareUnicodeCharacter{00C2}{\^A}
9087 \DeclareUnicodeCharacter{00C3}{\~A}
9088 \DeclareUnicodeCharacter{00C4}{\"A}
9089 \DeclareUnicodeCharacter{00C5}{\AA}
9090 \DeclareUnicodeCharacter{00C6}{\AE}
9091 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9092 \DeclareUnicodeCharacter{00C8}{\`E}
9093 \DeclareUnicodeCharacter{00C9}{\'E}
9094 \DeclareUnicodeCharacter{00CA}{\^E}
9095 \DeclareUnicodeCharacter{00CB}{\"E}
9096 \DeclareUnicodeCharacter{00CC}{\`I}
9097 \DeclareUnicodeCharacter{00CD}{\'I}
9098 \DeclareUnicodeCharacter{00CE}{\^I}
9099 \DeclareUnicodeCharacter{00CF}{\"I}
9101 \DeclareUnicodeCharacter{00D0}{\DH}
9102 \DeclareUnicodeCharacter{00D1}{\~N}
9103 \DeclareUnicodeCharacter{00D2}{\`O}
9104 \DeclareUnicodeCharacter{00D3}{\'O}
9105 \DeclareUnicodeCharacter{00D4}{\^O}
9106 \DeclareUnicodeCharacter{00D5}{\~O}
9107 \DeclareUnicodeCharacter{00D6}{\"O}
9108 \DeclareUnicodeCharacter{00D8}{\O}
9109 \DeclareUnicodeCharacter{00D9}{\`U}
9110 \DeclareUnicodeCharacter{00DA}{\'U}
9111 \DeclareUnicodeCharacter{00DB}{\^U}
9112 \DeclareUnicodeCharacter{00DC}{\"U}
9113 \DeclareUnicodeCharacter{00DD}{\'Y}
9114 \DeclareUnicodeCharacter{00DE}{\TH}
9115 \DeclareUnicodeCharacter{00DF}{\ss}
9117 \DeclareUnicodeCharacter{00E0}{\`a}
9118 \DeclareUnicodeCharacter{00E1}{\'a}
9119 \DeclareUnicodeCharacter{00E2}{\^a}
9120 \DeclareUnicodeCharacter{00E3}{\~a}
9121 \DeclareUnicodeCharacter{00E4}{\"a}
9122 \DeclareUnicodeCharacter{00E5}{\aa}
9123 \DeclareUnicodeCharacter{00E6}{\ae}
9124 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9125 \DeclareUnicodeCharacter{00E8}{\`e}
9126 \DeclareUnicodeCharacter{00E9}{\'e}
9127 \DeclareUnicodeCharacter{00EA}{\^e}
9128 \DeclareUnicodeCharacter{00EB}{\"e}
9129 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9130 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9131 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9132 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9134 \DeclareUnicodeCharacter{00F0}{\dh}
9135 \DeclareUnicodeCharacter{00F1}{\~n}
9136 \DeclareUnicodeCharacter{00F2}{\`o}
9137 \DeclareUnicodeCharacter{00F3}{\'o}
9138 \DeclareUnicodeCharacter{00F4}{\^o}
9139 \DeclareUnicodeCharacter{00F5}{\~o}
9140 \DeclareUnicodeCharacter{00F6}{\"o}
9141 \DeclareUnicodeCharacter{00F8}{\o}
9142 \DeclareUnicodeCharacter{00F9}{\`u}
9143 \DeclareUnicodeCharacter{00FA}{\'u}
9144 \DeclareUnicodeCharacter{00FB}{\^u}
9145 \DeclareUnicodeCharacter{00FC}{\"u}
9146 \DeclareUnicodeCharacter{00FD}{\'y}
9147 \DeclareUnicodeCharacter{00FE}{\th}
9148 \DeclareUnicodeCharacter{00FF}{\"y}
9150 \DeclareUnicodeCharacter{0100}{\=A}
9151 \DeclareUnicodeCharacter{0101}{\=a}
9152 \DeclareUnicodeCharacter{0102}{\u{A}}
9153 \DeclareUnicodeCharacter{0103}{\u{a}}
9154 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9155 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9156 \DeclareUnicodeCharacter{0106}{\'C}
9157 \DeclareUnicodeCharacter{0107}{\'c}
9158 \DeclareUnicodeCharacter{0108}{\^C}
9159 \DeclareUnicodeCharacter{0109}{\^c}
9160 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9161 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9162 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9163 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9164 \DeclareUnicodeCharacter{010C}{\v{C}}
9165 \DeclareUnicodeCharacter{010D}{\v{c}}
9166 \DeclareUnicodeCharacter{010E}{\v{D}}
9168 \DeclareUnicodeCharacter{0112}{\=E}
9169 \DeclareUnicodeCharacter{0113}{\=e}
9170 \DeclareUnicodeCharacter{0114}{\u{E}}
9171 \DeclareUnicodeCharacter{0115}{\u{e}}
9172 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9173 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9174 \DeclareUnicodeCharacter{011A}{\v{E}}
9175 \DeclareUnicodeCharacter{011B}{\v{e}}
9176 \DeclareUnicodeCharacter{011C}{\^G}
9177 \DeclareUnicodeCharacter{011D}{\^g}
9178 \DeclareUnicodeCharacter{011E}{\u{G}}
9179 \DeclareUnicodeCharacter{011F}{\u{g}}
9181 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9182 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9183 \DeclareUnicodeCharacter{0124}{\^H}
9184 \DeclareUnicodeCharacter{0125}{\^h}
9185 \DeclareUnicodeCharacter{0128}{\~I}
9186 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9187 \DeclareUnicodeCharacter{012A}{\=I}
9188 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9189 \DeclareUnicodeCharacter{012C}{\u{I}}
9190 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9192 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9193 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9194 \DeclareUnicodeCharacter{0132}{IJ}
9195 \DeclareUnicodeCharacter{0133}{ij}
9196 \DeclareUnicodeCharacter{0134}{\^J}
9197 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9198 \DeclareUnicodeCharacter{0139}{\'L}
9199 \DeclareUnicodeCharacter{013A}{\'l}
9201 \DeclareUnicodeCharacter{0141}{\L}
9202 \DeclareUnicodeCharacter{0142}{\l}
9203 \DeclareUnicodeCharacter{0143}{\'N}
9204 \DeclareUnicodeCharacter{0144}{\'n}
9205 \DeclareUnicodeCharacter{0147}{\v{N}}
9206 \DeclareUnicodeCharacter{0148}{\v{n}}
9207 \DeclareUnicodeCharacter{014C}{\=O}
9208 \DeclareUnicodeCharacter{014D}{\=o}
9209 \DeclareUnicodeCharacter{014E}{\u{O}}
9210 \DeclareUnicodeCharacter{014F}{\u{o}}
9212 \DeclareUnicodeCharacter{0150}{\H{O}}
9213 \DeclareUnicodeCharacter{0151}{\H{o}}
9214 \DeclareUnicodeCharacter{0152}{\OE}
9215 \DeclareUnicodeCharacter{0153}{\oe}
9216 \DeclareUnicodeCharacter{0154}{\'R}
9217 \DeclareUnicodeCharacter{0155}{\'r}
9218 \DeclareUnicodeCharacter{0158}{\v{R}}
9219 \DeclareUnicodeCharacter{0159}{\v{r}}
9220 \DeclareUnicodeCharacter{015A}{\'S}
9221 \DeclareUnicodeCharacter{015B}{\'s}
9222 \DeclareUnicodeCharacter{015C}{\^S}
9223 \DeclareUnicodeCharacter{015D}{\^s}
9224 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9225 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9227 \DeclareUnicodeCharacter{0160}{\v{S}}
9228 \DeclareUnicodeCharacter{0161}{\v{s}}
9229 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9230 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9231 \DeclareUnicodeCharacter{0164}{\v{T}}
9233 \DeclareUnicodeCharacter{0168}{\~U}
9234 \DeclareUnicodeCharacter{0169}{\~u}
9235 \DeclareUnicodeCharacter{016A}{\=U}
9236 \DeclareUnicodeCharacter{016B}{\=u}
9237 \DeclareUnicodeCharacter{016C}{\u{U}}
9238 \DeclareUnicodeCharacter{016D}{\u{u}}
9239 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9240 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9242 \DeclareUnicodeCharacter{0170}{\H{U}}
9243 \DeclareUnicodeCharacter{0171}{\H{u}}
9244 \DeclareUnicodeCharacter{0174}{\^W}
9245 \DeclareUnicodeCharacter{0175}{\^w}
9246 \DeclareUnicodeCharacter{0176}{\^Y}
9247 \DeclareUnicodeCharacter{0177}{\^y}
9248 \DeclareUnicodeCharacter{0178}{\"Y}
9249 \DeclareUnicodeCharacter{0179}{\'Z}
9250 \DeclareUnicodeCharacter{017A}{\'z}
9251 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9252 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9253 \DeclareUnicodeCharacter{017D}{\v{Z}}
9254 \DeclareUnicodeCharacter{017E}{\v{z}}
9256 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9257 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9258 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9259 \DeclareUnicodeCharacter{01C7}{LJ}
9260 \DeclareUnicodeCharacter{01C8}{Lj}
9261 \DeclareUnicodeCharacter{01C9}{lj}
9262 \DeclareUnicodeCharacter{01CA}{NJ}
9263 \DeclareUnicodeCharacter{01CB}{Nj}
9264 \DeclareUnicodeCharacter{01CC}{nj}
9265 \DeclareUnicodeCharacter{01CD}{\v{A}}
9266 \DeclareUnicodeCharacter{01CE}{\v{a}}
9267 \DeclareUnicodeCharacter{01CF}{\v{I}}
9269 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9270 \DeclareUnicodeCharacter{01D1}{\v{O}}
9271 \DeclareUnicodeCharacter{01D2}{\v{o}}
9272 \DeclareUnicodeCharacter{01D3}{\v{U}}
9273 \DeclareUnicodeCharacter{01D4}{\v{u}}
9275 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9276 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9277 \DeclareUnicodeCharacter{01E6}{\v{G}}
9278 \DeclareUnicodeCharacter{01E7}{\v{g}}
9279 \DeclareUnicodeCharacter{01E8}{\v{K}}
9280 \DeclareUnicodeCharacter{01E9}{\v{k}}
9282 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9283 \DeclareUnicodeCharacter{01F1}{DZ}
9284 \DeclareUnicodeCharacter{01F2}{Dz}
9285 \DeclareUnicodeCharacter{01F3}{dz}
9286 \DeclareUnicodeCharacter{01F4}{\'G}
9287 \DeclareUnicodeCharacter{01F5}{\'g}
9288 \DeclareUnicodeCharacter{01F8}{\`N}
9289 \DeclareUnicodeCharacter{01F9}{\`n}
9290 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9291 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9292 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9293 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9295 \DeclareUnicodeCharacter{021E}{\v{H}}
9296 \DeclareUnicodeCharacter{021F}{\v{h}}
9298 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9299 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9300 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9301 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9302 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9303 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9305 \DeclareUnicodeCharacter{0232}{\=Y}
9306 \DeclareUnicodeCharacter{0233}{\=y}
9307 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9309 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9311 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9312 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9313 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9314 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9315 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9316 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9317 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9318 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9319 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9320 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9321 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9322 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9324 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9325 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9327 \DeclareUnicodeCharacter{1E20}{\=G}
9328 \DeclareUnicodeCharacter{1E21}{\=g}
9329 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9330 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9331 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9332 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9333 \DeclareUnicodeCharacter{1E26}{\"H}
9334 \DeclareUnicodeCharacter{1E27}{\"h}
9336 \DeclareUnicodeCharacter{1E30}{\'K}
9337 \DeclareUnicodeCharacter{1E31}{\'k}
9338 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9339 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9340 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9341 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9342 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9343 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9344 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9345 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9346 \DeclareUnicodeCharacter{1E3E}{\'M}
9347 \DeclareUnicodeCharacter{1E3F}{\'m}
9349 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9350 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9351 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9352 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9353 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9354 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9355 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9356 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9357 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9358 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9360 \DeclareUnicodeCharacter{1E54}{\'P}
9361 \DeclareUnicodeCharacter{1E55}{\'p}
9362 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9363 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9364 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9365 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9366 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9367 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9368 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9369 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9371 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9372 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9373 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9374 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9375 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9376 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9377 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9378 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9379 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9380 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9382 \DeclareUnicodeCharacter{1E7C}{\~V}
9383 \DeclareUnicodeCharacter{1E7D}{\~v}
9384 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9385 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9387 \DeclareUnicodeCharacter{1E80}{\`W}
9388 \DeclareUnicodeCharacter{1E81}{\`w}
9389 \DeclareUnicodeCharacter{1E82}{\'W}
9390 \DeclareUnicodeCharacter{1E83}{\'w}
9391 \DeclareUnicodeCharacter{1E84}{\"W}
9392 \DeclareUnicodeCharacter{1E85}{\"w}
9393 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9394 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9395 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9396 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9397 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9398 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9399 \DeclareUnicodeCharacter{1E8C}{\"X}
9400 \DeclareUnicodeCharacter{1E8D}{\"x}
9401 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9402 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9404 \DeclareUnicodeCharacter{1E90}{\^Z}
9405 \DeclareUnicodeCharacter{1E91}{\^z}
9406 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9407 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9408 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9409 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9410 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9411 \DeclareUnicodeCharacter{1E97}{\"t}
9412 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9413 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9415 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9416 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9418 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9419 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9420 \DeclareUnicodeCharacter{1EBC}{\~E}
9421 \DeclareUnicodeCharacter{1EBD}{\~e}
9423 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9424 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9425 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9426 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9428 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9429 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9431 \DeclareUnicodeCharacter{1EF2}{\`Y}
9432 \DeclareUnicodeCharacter{1EF3}{\`y}
9433 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9435 \DeclareUnicodeCharacter{1EF8}{\~Y}
9436 \DeclareUnicodeCharacter{1EF9}{\~y}
9438 \DeclareUnicodeCharacter{2013}{--}
9439 \DeclareUnicodeCharacter{2014}{---}
9440 \DeclareUnicodeCharacter{2018}{\quoteleft}
9441 \DeclareUnicodeCharacter{2019}{\quoteright}
9442 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9443 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9444 \DeclareUnicodeCharacter{201D}{\quotedblright}
9445 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9446 \DeclareUnicodeCharacter{2022}{\bullet}
9447 \DeclareUnicodeCharacter{2026}{\dots}
9448 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9449 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9450 \DeclareUnicodeCharacter{20AC}{\euro}
9452 \DeclareUnicodeCharacter{2192}{\expansion}
9453 \DeclareUnicodeCharacter{21D2}{\result}
9455 \DeclareUnicodeCharacter{2212}{\minus}
9456 \DeclareUnicodeCharacter{2217}{\point}
9457 \DeclareUnicodeCharacter{2261}{\equiv}
9458 }% end of \utfeightchardefs
9461 % US-ASCII character definitions.
9462 \def\asciichardefs{% nothing need be done
9466 % Make non-ASCII characters printable again for compatibility with
9467 % existing Texinfo documents that may use them, even without declaring a
9468 % document encoding.
9470 \setnonasciicharscatcode \other
9473 \message{formatting,}
9475 \newdimen\defaultparindent \defaultparindent = 15pt
9477 \chapheadingskip = 15pt plus 4pt minus 2pt
9478 \secheadingskip = 12pt plus 3pt minus 2pt
9479 \subsecheadingskip = 9pt plus 2pt minus 2pt
9481 % Prevent underfull vbox error messages.
9484 % Don't be very finicky about underfull hboxes, either.
9487 % Following George Bush, get rid of widows and orphans.
9491 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9492 % using an old version of TeX, don't do anything. We want the amount of
9493 % stretch added to depend on the line length, hence the dependence on
9494 % \hsize. We call this whenever the paper size is set.
9496 \def\setemergencystretch{%
9497 \ifx\emergencystretch\thisisundefined
9498 % Allow us to assign to \emergencystretch anyway.
9499 \def\emergencystretch{\dimen0}%
9501 \emergencystretch = .15\hsize
9505 % Parameters in order: 1) textheight; 2) textwidth;
9506 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9507 % 7) physical page height; 8) physical page width.
9509 % We also call \setleading{\textleading}, so the caller should define
9510 % \textleading. The caller should also set \parskip.
9512 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9515 \splittopskip = \topskip
9518 \advance\vsize by \topskip
9519 \outervsize = \vsize
9520 \advance\outervsize by 2\topandbottommargin
9521 \pageheight = \vsize
9524 \outerhsize = \hsize
9525 \advance\outerhsize by 0.5in
9528 \normaloffset = #4\relax
9529 \bindingoffset = #5\relax
9532 \pdfpageheight #7\relax
9533 \pdfpagewidth #8\relax
9534 % if we don't reset these, they will remain at "1 true in" of
9535 % whatever layout pdftex was dumped with.
9536 \pdfhorigin = 1 true in
9537 \pdfvorigin = 1 true in
9540 \setleading{\textleading}
9542 \parindent = \defaultparindent
9543 \setemergencystretch
9546 % @letterpaper (the default).
9547 \def\letterpaper{{\globaldefs = 1
9548 \parskip = 3pt plus 2pt minus 1pt
9549 \textleading = 13.2pt
9551 % If page is nothing but text, make it come out even.
9552 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9554 {\bindingoffset}{36pt}%
9558 % Use @smallbook to reset parameters for 7x9.25 trim size.
9559 \def\smallbook{{\globaldefs = 1
9560 \parskip = 2pt plus 1pt
9563 \internalpagesizes{7.5in}{5in}%
9565 {\bindingoffset}{16pt}%
9568 \lispnarrowing = 0.3in
9571 \contentsrightmargin = 0pt
9572 \defbodyindent = .5cm
9575 % Use @smallerbook to reset parameters for 6x9 trim size.
9576 % (Just testing, parameters still in flux.)
9577 \def\smallerbook{{\globaldefs = 1
9578 \parskip = 1.5pt plus 1pt
9581 \internalpagesizes{7.4in}{4.8in}%
9586 \lispnarrowing = 0.25in
9589 \contentsrightmargin = 0pt
9590 \defbodyindent = .4cm
9593 % Use @afourpaper to print on European A4 paper.
9594 \def\afourpaper{{\globaldefs = 1
9595 \parskip = 3pt plus 2pt minus 1pt
9596 \textleading = 13.2pt
9598 % Double-side printing via postscript on Laserjet 4050
9599 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9600 % To change the settings for a different printer or situation, adjust
9601 % \normaloffset until the front-side and back-side texts align. Then
9602 % do the same for \bindingoffset. You can set these for testing in
9603 % your texinfo source file like this:
9605 % \global\normaloffset = -6mm
9606 % \global\bindingoffset = 10mm
9608 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9609 {\voffset}{\hoffset}%
9610 {\bindingoffset}{44pt}%
9615 \contentsrightmargin = 0pt
9616 \defbodyindent = 5mm
9619 % Use @afivepaper to print on European A5 paper.
9620 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9621 % He also recommends making @example and @lisp be small.
9622 \def\afivepaper{{\globaldefs = 1
9623 \parskip = 2pt plus 1pt minus 0.1pt
9624 \textleading = 12.5pt
9626 \internalpagesizes{160mm}{120mm}%
9627 {\voffset}{\hoffset}%
9628 {\bindingoffset}{8pt}%
9631 \lispnarrowing = 0.2in
9634 \contentsrightmargin = 0pt
9635 \defbodyindent = 2mm
9639 % A specific text layout, 24x15cm overall, intended for A4 paper.
9640 \def\afourlatex{{\globaldefs = 1
9642 \internalpagesizes{237mm}{150mm}%
9644 {\bindingoffset}{7mm}%
9647 % Must explicitly reset to 0 because we call \afourpaper.
9651 % Use @afourwide to print on A4 paper in landscape format.
9652 \def\afourwide{{\globaldefs = 1
9654 \internalpagesizes{241mm}{165mm}%
9655 {\voffset}{-2.95mm}%
9656 {\bindingoffset}{7mm}%
9661 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9662 % Perhaps we should allow setting the margins, \topskip, \parskip,
9663 % and/or leading, also. Or perhaps we should compute them somehow.
9665 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9666 \def\pagesizesyyy#1,#2,#3\finish{{%
9667 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9670 \parskip = 3pt plus 2pt minus 1pt
9671 \setleading{\textleading}%
9674 \advance\dimen0 by \voffset
9677 \advance\dimen2 by \normaloffset
9679 \internalpagesizes{#1}{\hsize}%
9680 {\voffset}{\normaloffset}%
9681 {\bindingoffset}{44pt}%
9685 % Set default to letter.
9690 \message{and turning on texinfo input format.}
9692 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9694 % DEL is a comment character, in case @c does not suffice.
9697 % Define macros to output various characters with catcode for normal text.
9698 \catcode`\"=\other \def\normaldoublequote{"}
9699 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9700 \catcode`\+=\other \def\normalplus{+}
9701 \catcode`\<=\other \def\normalless{<}
9702 \catcode`\>=\other \def\normalgreater{>}
9703 \catcode`\^=\other \def\normalcaret{^}
9704 \catcode`\_=\other \def\normalunderscore{_}
9705 \catcode`\|=\other \def\normalverticalbar{|}
9706 \catcode`\~=\other \def\normaltilde{~}
9708 % This macro is used to make a character print one way in \tt
9709 % (where it can probably be output as-is), and another way in other fonts,
9710 % where something hairier probably needs to be done.
9712 % #1 is what to print if we are indeed using \tt; #2 is what to print
9713 % otherwise. Since all the Computer Modern typewriter fonts have zero
9714 % interword stretch (and shrink), and it is reasonable to expect all
9715 % typewriter fonts to have this, we can check that font parameter.
9717 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9719 % Same as above, but check for italic font. Actually this also catches
9720 % non-italic slanted fonts since it is impossible to distinguish them from
9721 % italic fonts. But since this is only used by $ and it uses \sl anyway
9722 % this is not a problem.
9723 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9725 % Turn off all special characters except @
9726 % (and those which the user can use as if they were ordinary).
9727 % Most of these we simply print from the \tt font, but for some, we can
9728 % use math or other variants that look better in normal text.
9731 \def\activedoublequote{{\tt\char34}}
9732 \let"=\activedoublequote
9734 \def~{{\tt\char126}}
9740 \def_{\ifusingtt\normalunderscore\_}
9742 % Subroutine for the previous macro.
9743 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9746 \def|{{\tt\char124}}
9754 \def+{{\tt \char 43}}
9756 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9758 % If a .fmt file is being used, characters that might appear in a file
9759 % name cannot be active until we have parsed the command line.
9760 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9761 % \otherifyactive is called near the end of this file.
9762 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9764 % Used sometimes to turn off (effectively) the active characters even after
9766 \def\turnoffactive{%
9767 \normalturnoffactive
9773 % \backslashcurfont outputs one backslash character in current font,
9775 \global\chardef\backslashcurfont=`\\
9776 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9778 % \realbackslash is an actual character `\' with catcode other, and
9779 % \doublebackslash is two of them (for the pdf outlines).
9780 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9782 % In texinfo, backslash is an active character; it prints the backslash
9783 % in fixed width font.
9785 @def@normalbackslash{{@tt@backslashcurfont}}
9786 % On startup, @fixbackslash assigns:
9787 % @let \ = @normalbackslash
9789 % \rawbackslash defines an active \ to do \backslashcurfont.
9790 % \otherbackslash defines an active \ to be a literal `\' character with
9792 @gdef@rawbackslash{@let\=@backslashcurfont}
9793 @gdef@otherbackslash{@let\=@realbackslash}
9795 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9796 % the literal character `\'.
9798 @def@normalturnoffactive{%
9799 @let"=@normaldoublequote
9800 @let$=@normaldollar %$ font-lock fix
9803 @let>=@normalgreater
9804 @let\=@normalbackslash
9806 @let_=@normalunderscore
9807 @let|=@normalverticalbar
9809 @markupsetuplqdefault
9810 @markupsetuprqdefault
9814 % Make _ and + \other characters, temporarily.
9815 % This is canceled by @fixbackslash.
9818 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9819 % That is what \eatinput is for; after that, the `\' should revert to printing
9822 @gdef@eatinput input texinfo{@fixbackslash}
9823 @global@let\ = @eatinput
9825 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9826 % the first `\' in the file would cause an error. This macro tries to fix
9827 % that, assuming it is called before the first `\' could plausibly occur.
9828 % Also turn back on active characters that might appear in the input
9829 % file name, in case not using a pre-dumped format.
9831 @gdef@fixbackslash{%
9832 @ifx\@eatinput @let\ = @normalbackslash @fi
9837 % Say @foo, not \foo, in error messages.
9840 % These (along with & and #) are made active for url-breaking, so need
9841 % active definitions as the normal characters.
9846 % These look ok in all fonts, so just make them not special.
9847 @catcode`@& = @other @def@normalamp{&}
9848 @catcode`@# = @other @def@normalhash{#}
9849 @catcode`@% = @other @def@normalpercent{%}
9851 @c Finally, make ` and ' active, so that txicodequoteundirected and
9852 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9853 @c don't make ` and ' active, @code will not get them as active chars.
9854 @c Do this last of all since we use ` in the previous @catcode assignments.
9857 @markupsetuplqdefault
9858 @markupsetuprqdefault
9861 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9862 @c page-delimiter: "^\\\\message"
9863 @c time-stamp-start: "def\\\\texinfoversion{"
9864 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9865 @c time-stamp-end: "}"
9871 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115