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-11-09.15}
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 % add check for \lastpenalty to plain's definitions. If the last thing
234 % we did was a \nobreak, we don't want to insert more space.
236 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
237 \removelastskip\penalty-50\smallskip\fi\fi}
238 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
239 \removelastskip\penalty-100\medskip\fi\fi}
240 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
241 \removelastskip\penalty-200\bigskip\fi\fi}
243 % Do @cropmarks to get crop marks.
246 \let\cropmarks = \cropmarkstrue
248 % Dimensions to add cropmarks at corners.
249 % Added by P. A. MacKay, 12 Nov. 1986
251 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
252 \newdimen\cornerlong \cornerlong=1pc
253 \newdimen\cornerthick \cornerthick=.3pt
254 \newdimen\topandbottommargin \topandbottommargin=.75in
256 % Output a mark which sets \thischapter, \thissection and \thiscolor.
257 % We dump everything together because we only have one kind of mark.
258 % This works because we only use \botmark / \topmark, not \firstmark.
260 % A mark contains a subexpression of the \ifcase ... \fi construct.
261 % \get*marks macros below extract the needed part using \ifcase.
263 % Another complication is to let the user choose whether \thischapter
264 % (\thissection) refers to the chapter (section) in effect at the top
265 % of a page, or that at the bottom of a page. The solution is
266 % described on page 260 of The TeXbook. It involves outputting two
267 % marks for the sectioning macros, one before the section break, and
268 % one after. I won't pretend I can describe this better than DEK...
270 \toks0=\expandafter{\lastchapterdefs}%
271 \toks2=\expandafter{\lastsectiondefs}%
272 \toks4=\expandafter{\prevchapterdefs}%
273 \toks6=\expandafter{\prevsectiondefs}%
274 \toks8=\expandafter{\lastcolordefs}%
276 \the\toks0 \the\toks2
277 \noexpand\or \the\toks4 \the\toks6
278 \noexpand\else \the\toks8
281 % \topmark doesn't work for the very first chapter (after the title
282 % page or the contents), so we use \firstmark there -- this gets us
283 % the mark with the chapter defs, unless the user sneaks in, e.g.,
284 % @setcolor (or @url, or @link, etc.) between @contents and the very
286 \def\gettopheadingmarks{%
288 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
290 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
291 \def\getcolormarks{\ifcase2\topmark\fi}
293 % Avoid "undefined control sequence" errors.
294 \def\lastchapterdefs{}
295 \def\lastsectiondefs{}
296 \def\prevchapterdefs{}
297 \def\prevsectiondefs{}
300 % Main output routine.
302 \output = {\onepageout{\pagecontents\PAGE}}
307 % \onepageout takes a vbox as an argument. Note that \pagecontents
308 % does insertions, but you have to call it yourself.
310 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
312 \ifodd\pageno \advance\hoffset by \bindingoffset
313 \else \advance\hoffset by -\bindingoffset\fi
315 % Do this outside of the \shipout so @code etc. will be expanded in
316 % the headline as they should be, not taken literally (outputting ''code).
317 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
318 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
319 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
320 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
323 % Have to do this stuff outside the \shipout because we want it to
324 % take effect in \write's, yet the group defined by the \vbox ends
325 % before the \shipout runs.
327 \indexdummies % don't expand commands in the output.
328 \normalturnoffactive % \ in index entries must not stay \, e.g., if
329 % the page break happens to be in the middle of an example.
330 % We don't want .vr (or whatever) entries like this:
331 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
332 % "\acronym" won't work when it's read back in;
334 % {\code {{\tt \backslashcurfont }acronym}
336 % Do this early so pdf references go to the beginning of the page.
337 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
339 \ifcropmarks \vbox to \outervsize\bgroup
341 \vskip-\topandbottommargin
343 \line{\ewtop\hfil\ewtop}%
346 \vbox{\moveleft\cornerthick\nstop}%
348 \vbox{\moveright\cornerthick\nstop}%
351 \vskip\topandbottommargin
353 \hfil % center the page within the outer (page) hsize.
354 \ifodd\pageno\hskip\bindingoffset\fi
360 \ifdim\ht\footlinebox > 0pt
361 % Only leave this space if the footline is nonempty.
362 % (We lessened \vsize for it in \oddfootingyyy.)
363 % The \baselineskip=24pt in plain's \makefootline has no effect.
369 \egroup % end of \vbox\bgroup
370 \hfil\egroup % end of (centering) \line\bgroup
371 \vskip\topandbottommargin plus1fill minus1fill
372 \boxmaxdepth = \cornerthick
375 \vbox{\moveleft\cornerthick\nsbot}%
377 \vbox{\moveright\cornerthick\nsbot}%
380 \line{\ewbot\hfil\ewbot}%
382 \egroup % \vbox from first cropmarks clause
384 }% end of \shipout\vbox
385 }% end of group with \indexdummies
387 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
390 \newinsert\margin \dimen\margin=\maxdimen
392 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
394 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
395 % marginal hacks, juha@viisa.uucp (Juha Takala)
396 \ifvoid\margin\else % marginal info is present
397 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
398 \dimen@=\dp#1\relax \unvbox#1\relax
399 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
400 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
403 % Here are the rules for the cropmarks. Note that they are
404 % offset so that the space between them is truly \outerhsize or \outervsize
405 % (P. A. MacKay, 12 November, 1986)
407 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
409 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
410 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
412 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
414 % Parse an argument, then pass it to #1. The argument is the rest of
415 % the input line (except we remove a trailing comment). #1 should be a
416 % macro which expects an ordinary undelimited TeX argument.
418 \def\parsearg{\parseargusing{}}
419 \def\parseargusing#1#2{%
425 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
429 \gdef\parseargline#1^^M{%
430 \endgroup % End of the group started in \parsearg.
431 \argremovecomment #1\comment\ArgTerm%
435 % First remove any @comment, then any @c comment.
436 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
437 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
439 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
441 % \argremovec might leave us with trailing space, e.g.,
442 % @end itemize @c foo
443 % This space token undergoes the same procedure and is eventually removed
444 % by \finishparsearg.
446 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
447 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
448 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
451 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
452 \let\temp\finishparsearg
454 \let\temp\argcheckspaces
456 % Put the space token in:
460 % If a _delimited_ argument is enclosed in braces, they get stripped; so
461 % to get _exactly_ the rest of the line, we had to prevent such situation.
462 % We prepended an \empty token at the very beginning and we expand it now,
463 % just before passing the control to \argtorun.
464 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
465 % either the null string, or it ends with \^^M---thus there is no danger
466 % that a pair of braces would be stripped.
468 % But first, we have to remove the trailing space token.
470 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
472 % \parseargdef\foo{...}
473 % is roughly equivalent to
474 % \def\foo{\parsearg\Xfoo}
477 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
478 % favourite TeX trick. --kasal, 16nov03
481 \expandafter \doparseargdef \csname\string#1\endcsname #1%
483 \def\doparseargdef#1#2{%
488 % Several utility definitions with active space:
493 % Make each space character in the input produce a normal interword
494 % space in the output. Don't allow a line break at this space, as this
495 % is used only in environments like @example, where each line of input
496 % should produce a line of output anyway.
498 \gdef\sepspaces{\obeyspaces\let =\tie}
500 % If an index command is used in an @example environment, any spaces
501 % therein should become regular spaces in the raw index file, not the
502 % expansion of \tie (\leavevmode \penalty \@M \ ).
503 \gdef\unsepspaces{\let =\space}
507 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
509 % Define the framework for environments in texinfo.tex. It's used like this:
514 % It's the responsibility of \envdef to insert \begingroup before the
515 % actual body; @end closes the group after calling \Efoo. \envdef also
516 % defines \thisenv, so the current environment is known; @end checks
517 % whether the environment name matches. The \checkenv macro can also be
518 % used to check whether the current environment is the one expected.
520 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
521 % are not treated as environments; they don't open a group. (The
522 % implementation of @end takes care not to call \endgroup in this
526 % At run-time, environments start with this:
527 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
531 % ... but they get defined via ``\envdef\foo{...}'':
532 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
533 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
535 % Check whether we're in the right environment:
544 % Environment mismatch, #1 expected:
547 \errmessage{This command can appear only \inenvironment\temp,
548 not \inenvironment\thisenv}%
550 \def\inenvironment#1{%
552 outside of any environment%
554 in environment \expandafter\string#1%
558 % @end foo executes the definition of \Efoo.
559 % But first, it executes a specialized version of \checkenv
562 \if 1\csname iscond.#1\endcsname
564 % The general wording of \badenverr may not be ideal.
565 \expandafter\checkenv\csname#1\endcsname
566 \csname E#1\endcsname
571 \newhelp\EMsimple{Press RETURN to continue.}
574 % Be sure we're in horizontal mode when doing a tie, since we make space
575 % equivalent to this in @example-like environments. Otherwise, a space
576 % at the beginning of a line will start with \penalty -- and
577 % since \penalty is valid in vertical mode, we'd end up putting the
578 % penalty on the vertical list instead of in the new paragraph.
580 % Avoid using \@M directly, because that causes trouble
581 % if the definition is written into an index file.
582 \global\let\tiepenalty = \@M
583 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
586 % @: forces normal size whitespace following.
587 \def\:{\spacefactor=1000 }
589 % @* forces a line break.
590 \def\*{\hfil\break\hbox{}\ignorespaces}
592 % @/ allows a line break.
595 % @. is an end-of-sentence period.
596 \def\.{.\spacefactor=\endofsentencespacefactor\space}
598 % @! is an end-of-sentence bang.
599 \def\!{!\spacefactor=\endofsentencespacefactor\space}
601 % @? is an end-of-sentence query.
602 \def\?{?\spacefactor=\endofsentencespacefactor\space}
604 % @frenchspacing on|off says whether to put extra space after punctuation.
609 \parseargdef\frenchspacing{%
611 \ifx\temp\onword \plainfrenchspacing
612 \else\ifx\temp\offword \plainnonfrenchspacing
615 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
619 % @w prevents a word break. Without the \leavevmode, @w at the
620 % beginning of a paragraph, when TeX is still in vertical mode, would
621 % produce a whole line of output instead of starting the paragraph.
622 \def\w#1{\leavevmode\hbox{#1}}
624 % @group ... @end group forces ... to be all on one page, by enclosing
625 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
626 % to keep its height that of a normal line. According to the rules for
627 % \topskip (p.114 of the TeXbook), the glue inserted is
628 % max (\topskip - \ht (first item), 0). If that height is large,
629 % therefore, no glue is inserted, and the space between the headline and
630 % the text is small, which looks bad.
632 % Another complication is that the group might be very large. This can
633 % cause the glue on the previous page to be unduly stretched, because it
634 % does not have much material. In this case, it's better to add an
635 % explicit \vfill so that the extra space is at the bottom. The
636 % threshold for doing this is if the group is more than \vfilllimit
637 % percent of a page (\vfilllimit can be changed inside of @tex).
643 \ifnum\catcode`\^^M=\active \else
644 \errhelp = \groupinvalidhelp
645 \errmessage{@group invalid in context where filling is enabled}%
649 \setbox\groupbox = \vtop\bgroup
650 % Do @comment since we are called inside an environment such as
651 % @example, where each end-of-line in the input causes an
652 % end-of-line in the output. We don't want the end-of-line after
653 % the `@group' to put extra space in the output. Since @group
654 % should appear on a line by itself (according to the Texinfo
655 % manual), we don't worry about eating any user text.
659 % The \vtop produces a box with normal height and large depth; thus, TeX puts
660 % \baselineskip glue before it, and (when the next line of text is done)
661 % \lineskip glue after it. Thus, space below is not quite equal to space
662 % above. But it's pretty close.
664 % To get correct interline space between the last line of the group
665 % and the first line afterwards, we have to propagate \prevdepth.
666 \endgraf % Not \par, as it may have been set to \lisppar.
667 \global\dimen1 = \prevdepth
668 \egroup % End the \vtop.
669 % \dimen0 is the vertical size of the group's box.
670 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
671 % \dimen2 is how much space is left on the page (more or less).
672 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
673 % if the group doesn't fit on the current page, and it's a big big
674 % group, force a page break.
675 \ifdim \dimen0 > \dimen2
676 \ifdim \pagetotal < \vfilllimit\pageheight
685 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
686 % message, so this ends up printing `@group can only ...'.
688 \newhelp\groupinvalidhelp{%
689 group can only be used in environments such as @example,^^J%
690 where each line of input produces a line of output.}
692 % @need space-in-mils
693 % forces a page break if there is not space-in-mils remaining.
695 \newdimen\mil \mil=0.001in
698 % Ensure vertical mode, so we don't make a big box in the middle of a
702 % If the @need value is less than one line space, it's useless.
704 \dimen2 = \ht\strutbox
705 \advance\dimen2 by \dp\strutbox
706 \ifdim\dimen0 > \dimen2
708 % Do a \strut just to make the height of this box be normal, so the
709 % normal leading is inserted relative to the preceding line.
710 % And a page break here is fine.
711 \vtop to #1\mil{\strut\vfil}%
713 % TeX does not even consider page breaks if a penalty added to the
714 % main vertical list is 10000 or more. But in order to see if the
715 % empty box we just added fits on the page, we must make it consider
716 % page breaks. On the other hand, we don't want to actually break the
717 % page after the empty box. So we use a penalty of 9999.
719 % There is an extremely small chance that TeX will actually break the
720 % page at this \penalty, if there are no other feasible breakpoints in
721 % sight. (If the user is using lots of big @group commands, which
722 % almost-but-not-quite fill up a page, TeX will have a hard time doing
723 % good page breaking, for example.) However, I could not construct an
724 % example where a page broke at this \penalty; if it happens in a real
725 % document, then we can reconsider our strategy.
728 % Back up by the size of the box, whether we did a page break or not.
731 % Do not allow a page break right after this kern.
736 % @br forces paragraph break (and is undocumented).
740 % @page forces the start of a new page.
742 \def\page{\par\vfill\supereject}
745 % outputs text on separate line in roman font, starting at standard page margin
747 % This records the amount of indent in the innermost environment.
748 % That's how much \exdent should take out.
749 \newskip\exdentamount
751 % This defn is used inside fill environments such as @defun.
752 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
754 % This defn is used inside nofill environments such as @example.
755 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
756 \leftline{\hskip\leftskip{\rm#1}}}}
758 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
759 % paragraph. For more general purposes, use the \margin insertion
760 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
762 \newskip\inmarginspacing \inmarginspacing=1cm
763 \def\strutdepth{\dp\strutbox}
765 \def\doinmargin#1#2{\strut\vadjust{%
768 \vtop to \strutdepth{%
769 \baselineskip=\strutdepth
771 % if you have multiple lines of stuff to put here, you'll need to
772 % make the vbox yourself of the appropriate size.
774 \llap{\ignorespaces #2\hskip\inmarginspacing}%
776 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
781 \def\inleftmargin{\doinmargin l}
782 \def\inrightmargin{\doinmargin r}
784 % @inmargin{TEXT [, RIGHT-TEXT]}
785 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
786 % else use TEXT for both).
788 \def\inmargin#1{\parseinmargin #1,,\finish}
789 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
790 \setbox0 = \hbox{\ignorespaces #2}%
792 \def\lefttext{#1}% have both texts
795 \def\lefttext{#1}% have only one text
800 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
802 \def\temp{\inleftmargin\lefttext}%
807 % @| inserts a changebar to the left of the current line. It should
808 % surround any changed text. This approach does *not* work if the
809 % change spans more than two lines of output. To handle that, we would
810 % have adopt a much more difficult approach (putting marks into the main
811 % vertical list for the beginning and end of each change). This command
812 % is not documented, not supported, and doesn't work.
815 % \vadjust can only be used in horizontal mode.
818 % Append this vertical mode material after the current line in the output.
820 % We want to insert a rule with the height and depth of the current
821 % leading; that is exactly what \strutbox is supposed to record.
824 % \vadjust-items are inserted at the left edge of the type. So
825 % the \llap here moves out into the left-hand margin.
828 % For a thicker or thinner bar, change the `1pt'.
829 \vrule height\baselineskip width1pt
831 % This is the space between the bar and the text.
837 % @include FILE -- \input text of FILE.
839 \def\include{\parseargusing\filenamecatcodes\includezzz}
844 \makevalueexpandable % we want to expand any @value in FILE.
845 \turnoffactive % and allow special characters in the expansion
846 \indexnofonts % Allow `@@' and other weird things in file names.
847 \wlog{texinfo.tex: doing @include of #1^^J}%
848 \edef\temp{\noexpand\input #1 }%
850 % This trickery is to read FILE outside of a group, in case it makes
856 \def\filenamecatcodes{%
870 \def\pushthisfilestack{%
871 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
873 \def\pushthisfilestackX{%
874 \expandafter\pushthisfilestackY\thisfile\StackTerm
876 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
877 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
880 \def\popthisfilestack{\errthisfilestackempty}
881 \def\errthisfilestackempty{\errmessage{Internal error:
882 the stack of filenames is empty.}}
887 % outputs that line, centered.
889 \parseargdef\center{%
895 \next{\hfil \ignorespaces#1\unskip \hfil}%
900 \advance\hsize by -\leftskip
901 \advance\hsize by -\rightskip
906 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
908 % @sp n outputs n lines of vertical space
910 \parseargdef\sp{\vskip #1\baselineskip}
912 % @comment ...line which is ignored...
913 % @c is the same as @comment
914 % @ignore ... @end ignore is another way to write a comment
916 \def\comment{\begingroup \catcode`\^^M=\other%
917 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
919 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
923 % @paragraphindent NCHARS
924 % We'll use ems for NCHARS, close enough.
925 % NCHARS can also be the word `asis' or `none'.
926 % We cannot feasibly implement @paragraphindent asis, though.
928 \def\asisword{asis} % no translation, these are keywords
931 \parseargdef\paragraphindent{%
936 \defaultparindent = 0pt
938 \defaultparindent = #1em
941 \parindent = \defaultparindent
944 % @exampleindent NCHARS
945 % We'll use ems for NCHARS like @paragraphindent.
946 % It seems @exampleindent asis isn't necessary, but
947 % I preserve it to make it similar to @paragraphindent.
948 \parseargdef\exampleindent{%
955 \lispnarrowing = #1em
960 % @firstparagraphindent WORD
961 % If WORD is `none', then suppress indentation of the first paragraph
962 % after a section heading. If WORD is `insert', then do indent at such
965 % The paragraph indentation is suppressed or not by calling
966 % \suppressfirstparagraphindent, which the sectioning commands do.
967 % We switch the definition of this back and forth according to WORD.
968 % By default, we suppress indentation.
970 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
971 \def\insertword{insert}
973 \parseargdef\firstparagraphindent{%
976 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
977 \else\ifx\temp\insertword
978 \let\suppressfirstparagraphindent = \relax
981 \errmessage{Unknown @firstparagraphindent option `\temp'}%
985 % Here is how we actually suppress indentation. Redefine \everypar to
986 % \kern backwards by \parindent, and then reset itself to empty.
988 % We also make \indent itself not actually do anything until the next
991 \gdef\dosuppressfirstparagraphindent{%
993 \restorefirstparagraphindent
997 \restorefirstparagraphindent
1000 \global\everypar = {%
1002 \restorefirstparagraphindent
1006 \gdef\restorefirstparagraphindent{%
1007 \global \let \indent = \ptexindent
1008 \global \let \noindent = \ptexnoindent
1009 \global \everypar = {}%
1013 % @refill is a no-op.
1016 % If working on a large document in chapters, it is convenient to
1017 % be able to disable indexing, cross-referencing, and contents, for test runs.
1018 % This is done with @novalidate (before @setfilename).
1020 \newif\iflinks \linkstrue % by default we want the aux files.
1021 \let\novalidate = \linksfalse
1023 % @setfilename is done at the beginning of every texinfo file.
1024 % So open here the files we need to have open while reading the input.
1025 % This makes it possible to make a .fmt file for texinfo.
1027 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1030 % Open the new aux file. TeX will close it automatically at exit.
1031 \immediate\openout\auxfile=\jobname.aux
1032 \fi % \openindices needs to do some work in any case.
1034 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1036 % If texinfo.cnf is present on the system, read it.
1037 % Useful for site-wide @afourpaper, etc.
1038 \openin 1 texinfo.cnf
1039 \ifeof 1 \else \input texinfo.cnf \fi
1042 \comment % Ignore the actual filename.
1045 % Called from \setfilename.
1057 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1061 % adobe `portable' document format
1065 \newcount\filenamelength
1074 \newif\ifpdfmakepagedest
1076 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1077 % can be set). So we test for \relax and 0 as well as being undefined.
1078 \ifx\pdfoutput\thisisundefined
1080 \ifx\pdfoutput\relax
1089 % PDF uses PostScript string constants for the names of xref targets,
1090 % for display in the outlines, and in other places. Thus, we have to
1091 % double any backslashes. Otherwise, a name like "\node" will be
1092 % interpreted as a newline (\n), followed by o, d, e. Not good.
1093 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1094 % (and related messages, the final outcome is that it is up to the TeX
1095 % user to double the backslashes and otherwise make the string valid, so
1096 % that's what we do).
1098 % double active backslashes.
1100 {\catcode`\@=0 \catcode`\\=\active
1101 @gdef@activebackslashdouble{%
1103 @let\=@doublebackslash}
1106 % To handle parens, we must adopt a different approach, since parens are
1107 % not active characters. hyperref.dtx (which has the same problem as
1108 % us) handles it with this amazing macro to replace tokens, with minor
1109 % changes for Texinfo. It is included here under the GPL by permission
1110 % from the author, Heiko Oberdiek.
1112 % #1 is the tokens to replace.
1113 % #2 is the replacement.
1114 % #3 is the control sequence with the string.
1116 \def\HyPsdSubst#1#2#3{%
1117 \def\HyPsdReplace##1#1##2\END{%
1123 \HyPsdReplace##2\END
1127 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1129 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1131 % #1 is a control sequence in which to do the replacements.
1132 \def\backslashparens#1{%
1133 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1134 % \lastnode when called from \setref -> \pdfmkdest.
1135 \HyPsdSubst{(}{\realbackslash(}{#1}%
1136 \HyPsdSubst{)}{\realbackslash)}{#1}%
1139 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1140 with PDF output, and none of those formats could be found. (.eps cannot
1141 be supported due to the design of the PDF format; use regular TeX (DVI
1146 % Color manipulation macros based on pdfcolor.tex,
1147 % except using rgb instead of cmyk; the latter is said to render as a
1148 % very dark gray on-screen and a very dark halftone in print, instead
1150 \def\rgbDarkRed{0.50 0.09 0.12}
1151 \def\rgbBlack{0 0 0}
1153 % k sets the color for filling (usual text, etc.);
1154 % K sets the color for stroking (thin rules, e.g., normal _'s).
1155 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1157 % Set color, and create a mark which defines \thiscolor accordingly,
1158 % so that \makeheadline knows which color to restore.
1160 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1165 \def\maincolor{\rgbBlack}
1166 \pdfsetcolor{\maincolor}
1167 \edef\thiscolor{\maincolor}
1168 \def\lastcolordefs{}
1172 \line{\pdfsetcolor{\maincolor}\the\footline}%
1180 % Extract \thiscolor definition from the marks.
1182 % Typeset the headline with \maincolor, then restore the color.
1183 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1191 \pdfcatalog{/PageMode /UseOutlines}
1193 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1194 \def\dopdfimage#1#2#3{%
1195 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1196 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1198 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1199 % others). Let's try in that order, PDF first since if
1200 % someone has a scalable image, presumably better to use that than a
1202 \let\pdfimgext=\empty
1204 \openin 1 #1.pdf \ifeof 1
1205 \openin 1 #1.PDF \ifeof 1
1206 \openin 1 #1.png \ifeof 1
1207 \openin 1 #1.jpg \ifeof 1
1208 \openin 1 #1.jpeg \ifeof 1
1209 \openin 1 #1.JPG \ifeof 1
1210 \errhelp = \nopdfimagehelp
1211 \errmessage{Could not find image file #1 for pdf}%
1212 \else \gdef\pdfimgext{JPG}%
1214 \else \gdef\pdfimgext{jpeg}%
1216 \else \gdef\pdfimgext{jpg}%
1218 \else \gdef\pdfimgext{png}%
1220 \else \gdef\pdfimgext{PDF}%
1222 \else \gdef\pdfimgext{pdf}%
1227 % without \immediate, ancient pdftex seg faults when the same image is
1228 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1229 \ifnum\pdftexversion < 14
1232 \immediate\pdfximage
1234 \ifdim \wd0 >0pt width \imagewidth \fi
1235 \ifdim \wd2 >0pt height \imageheight \fi
1236 \ifnum\pdftexversion<13
1241 \ifnum\pdftexversion < 14 \else
1242 \pdfrefximage \pdflastximage
1246 % We have to set dummies so commands such as @code, and characters
1247 % such as \, aren't expanded when present in a section title.
1250 \activebackslashdouble
1251 \makevalueexpandable
1252 \def\pdfdestname{#1}%
1253 \backslashparens\pdfdestname
1254 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1257 % used to mark target names; must be expandable.
1260 % by default, use a color that is dark enough to print on paper as
1261 % nearly black, but still distinguishable for online viewing.
1262 \def\urlcolor{\rgbDarkRed}
1263 \def\linkcolor{\rgbDarkRed}
1264 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1266 % Adding outlines to PDF; macros for calculating structure of outlines
1267 % come from Petr Olsak
1268 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1269 \else \csname#1\endcsname \fi}
1270 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1271 \advance\tempnum by 1
1272 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1274 % #1 is the section text, which is what will be displayed in the
1275 % outline by the pdf viewer. #2 is the pdf expression for the number
1276 % of subentries (or empty, for subsubsections). #3 is the node text,
1277 % which might be empty if this toc entry had no corresponding node.
1278 % #4 is the page number
1280 \def\dopdfoutline#1#2#3#4{%
1281 % Generate a link to the node text if that exists; else, use the
1282 % page number. We could generate a destination for the section
1283 % text in the case where a section has no node, but it doesn't
1284 % seem worth the trouble, since most documents are normally structured.
1285 \def\pdfoutlinedest{#3}%
1286 \ifx\pdfoutlinedest\empty
1287 \def\pdfoutlinedest{#4}%
1289 % Doubled backslashes in the name.
1290 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1291 \backslashparens\pdfoutlinedest}%
1294 % Also double the backslashes in the display string.
1295 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1296 \backslashparens\pdfoutlinetext}%
1298 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1301 \def\pdfmakeoutlines{%
1303 % Thanh's hack / proper braces in bookmarks
1304 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1305 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1307 % Read toc silently, to get counts of subentries for \pdfoutline.
1308 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1309 \def\numchapentry##1##2##3##4{%
1310 \def\thischapnum{##2}%
1312 \def\thissubsecnum{0}%
1314 \def\numsecentry##1##2##3##4{%
1315 \advancenumber{chap\thischapnum}%
1316 \def\thissecnum{##2}%
1317 \def\thissubsecnum{0}%
1319 \def\numsubsecentry##1##2##3##4{%
1320 \advancenumber{sec\thissecnum}%
1321 \def\thissubsecnum{##2}%
1323 \def\numsubsubsecentry##1##2##3##4{%
1324 \advancenumber{subsec\thissubsecnum}%
1326 \def\thischapnum{0}%
1328 \def\thissubsecnum{0}%
1330 % use \def rather than \let here because we redefine \chapentry et
1331 % al. a second time, below.
1332 \def\appentry{\numchapentry}%
1333 \def\appsecentry{\numsecentry}%
1334 \def\appsubsecentry{\numsubsecentry}%
1335 \def\appsubsubsecentry{\numsubsubsecentry}%
1336 \def\unnchapentry{\numchapentry}%
1337 \def\unnsecentry{\numsecentry}%
1338 \def\unnsubsecentry{\numsubsecentry}%
1339 \def\unnsubsubsecentry{\numsubsubsecentry}%
1342 % Read toc second time, this time actually producing the outlines.
1343 % The `-' means take the \expnumber as the absolute number of
1344 % subentries, which we calculated on our first read of the .toc above.
1346 % We use the node names as the destinations.
1347 \def\numchapentry##1##2##3##4{%
1348 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1349 \def\numsecentry##1##2##3##4{%
1350 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1351 \def\numsubsecentry##1##2##3##4{%
1352 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1353 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1354 \dopdfoutline{##1}{}{##3}{##4}}%
1356 % PDF outlines are displayed using system fonts, instead of
1357 % document fonts. Therefore we cannot use special characters,
1358 % since the encoding is unknown. For example, the eogonek from
1359 % Latin 2 (0xea) gets translated to a | character. Info from
1360 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1362 % xx to do this right, we have to translate 8-bit characters to
1363 % their "best" equivalent, based on the @documentencoding. Right
1364 % now, I guess we'll just let the pdf reader have its way.
1367 \catcode`\\=\active \otherbackslash
1368 \input \tocreadfilename
1372 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1373 \ifx\PP\D\let\nextsp\relax
1374 \else\let\nextsp\skipspaces
1375 \ifx\p\space\else\addtokens{\filename}{\PP}%
1376 \advance\filenamelength by 1
1380 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1381 \ifnum\pdftexversion < 14
1382 \let \startlink \pdfannotlink
1384 \let \startlink \pdfstartlink
1386 % make a live url in pdf output.
1389 % it seems we really need yet another set of dummies; have not
1390 % tried to figure out what each command should do in the context
1391 % of @url. for now, just make @/ a no-op, that's the only one
1392 % people have actually reported a problem with.
1394 \normalturnoffactive
1397 \makevalueexpandable
1398 % do we want to go so far as to use \indexnofonts instead of just
1399 % special-casing \var here?
1402 \leavevmode\setcolor{\urlcolor}%
1403 \startlink attr{/Border [0 0 0]}%
1404 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1406 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1407 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1408 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1409 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1411 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1413 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1414 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1415 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1417 \ifnum0=\countA\else\makelink\fi
1418 \ifx\first.\let\next=\done\else
1420 \addtokens{\toksB}{\the\toksD}
1421 \ifx\first,\addtokens{\toksB}{\space}\fi
1423 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1425 \def\makelink{\addtokens{\toksB}%
1426 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1428 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1429 \setcolor{\linkcolor}#1\endlink}
1430 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1433 \let\pdfmkdest = \gobble
1434 \let\pdfurl = \gobble
1435 \let\endlink = \relax
1436 \let\setcolor = \gobble
1437 \let\pdfsetcolor = \gobble
1438 \let\pdfmakeoutlines = \relax
1439 \fi % \ifx\pdfoutput
1444 % Change the current font style to #1, remembering it in \curfontstyle.
1445 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1446 % italics, not bold italics.
1448 \def\setfontstyle#1{%
1449 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1450 \csname ten#1\endcsname % change the current font
1453 % Select #1 fonts with the current style.
1455 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1457 \def\rm{\fam=0 \setfontstyle{rm}}
1458 \def\it{\fam=\itfam \setfontstyle{it}}
1459 \def\sl{\fam=\slfam \setfontstyle{sl}}
1460 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1461 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1463 % Unfortunately, we have to override this for titles and the like, since
1464 % in those cases "rm" is bold. Sigh.
1465 \def\rmisbold{\rm\def\curfontstyle{bf}}
1467 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1468 % So we set up a \sf.
1470 \def\sf{\fam=\sffam \setfontstyle{sf}}
1471 \let\li = \sf % Sometimes we call it \li, not \sf.
1473 % We don't need math for this font style.
1474 \def\ttsl{\setfontstyle{ttsl}}
1478 \newdimen\textleading \textleading = 13.2pt
1480 % Set the baselineskip to #1, and the lineskip and strut size
1481 % correspondingly. There is no deep meaning behind these magic numbers
1482 % used as factors; they just match (closely enough) what Knuth defined.
1484 \def\lineskipfactor{.08333}
1485 \def\strutheightpercent{.70833}
1486 \def\strutdepthpercent {.29167}
1488 % can get a sort of poor man's double spacing by redefining this.
1489 \def\baselinefactor{1}
1493 \normalbaselineskip = \baselinefactor\dimen0
1494 \normallineskip = \lineskipfactor\normalbaselineskip
1496 \setbox\strutbox =\hbox{%
1497 \vrule width0pt height\strutheightpercent\baselineskip
1498 depth \strutdepthpercent \baselineskip
1502 % PDF CMaps. See also LaTeX's t1.cmap.
1504 % do nothing with this by default.
1505 \expandafter\let\csname cmapOT1\endcsname\gobble
1506 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1507 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1509 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1510 % (\pdffontattr was introduced many years ago, but people still run
1511 % older pdftex's; it's easy to conditionalize, so we do.)
1512 \ifpdf \ifx\pdffontattr\thisisundefined \else
1514 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1515 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1516 %%DocumentNeededResources: ProcSet (CIDInit)
1517 %%IncludeResource: ProcSet (CIDInit)
1518 %%BeginResource: CMap (TeX-OT1-0)
1519 %%Title: (TeX-OT1-0 TeX OT1 0)
1522 /CIDInit /ProcSet findresource begin
1530 /CMapName /TeX-OT1-0 def
1532 1 begincodespacerange
1588 CMapName currentdict /CMap defineresource pop
1594 \expandafter\edef\csname cmapOT1\endcsname#1{%
1595 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1600 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1601 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1602 %%DocumentNeededResources: ProcSet (CIDInit)
1603 %%IncludeResource: ProcSet (CIDInit)
1604 %%BeginResource: CMap (TeX-OT1IT-0)
1605 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1608 /CIDInit /ProcSet findresource begin
1616 /CMapName /TeX-OT1IT-0 def
1618 1 begincodespacerange
1676 CMapName currentdict /CMap defineresource pop
1682 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1683 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1688 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1689 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1690 %%DocumentNeededResources: ProcSet (CIDInit)
1691 %%IncludeResource: ProcSet (CIDInit)
1692 %%BeginResource: CMap (TeX-OT1TT-0)
1693 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1696 /CIDInit /ProcSet findresource begin
1704 /CMapName /TeX-OT1TT-0 def
1706 1 begincodespacerange
1751 CMapName currentdict /CMap defineresource pop
1757 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1758 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1763 % Set the font macro #1 to the font named #2, adding on the
1764 % specified font prefix (normally `cm').
1765 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1766 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1768 \def\setfont#1#2#3#4#5{%
1769 \font#1=\fontprefix#2#3 scaled #4
1770 \csname cmap#5\endcsname#1%
1772 % This is what gets called when #5 of \setfont is empty.
1774 % emacs-page end of cmaps
1776 % Use cm as the default font prefix.
1777 % To specify the font prefix, you must define \fontprefix
1778 % before you read in texinfo.tex.
1779 \ifx\fontprefix\thisisundefined
1782 % Support font families that don't use the same naming scheme as CM.
1784 \def\rmbshape{bx} %where the normal face is bold
1789 \def\ttslshape{sltt}
1799 % Definitions for a main text size of 11pt. This is the default in
1802 \def\definetextfontsizexi{%
1803 % Text fonts (11.2pt, magstep1).
1804 \def\textnominalsize{11pt}
1805 \edef\mainmagstep{\magstephalf}
1806 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1807 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1808 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1809 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1810 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1811 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1812 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1813 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1814 \font\texti=cmmi10 scaled \mainmagstep
1815 \font\textsy=cmsy10 scaled \mainmagstep
1816 \def\textecsize{1095}
1818 % A few fonts for @defun names and args.
1819 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1820 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1821 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1822 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1824 % Fonts for indices, footnotes, small examples (9pt).
1825 \def\smallnominalsize{9pt}
1826 \setfont\smallrm\rmshape{9}{1000}{OT1}
1827 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1828 \setfont\smallbf\bfshape{10}{900}{OT1}
1829 \setfont\smallit\itshape{9}{1000}{OT1IT}
1830 \setfont\smallsl\slshape{9}{1000}{OT1}
1831 \setfont\smallsf\sfshape{9}{1000}{OT1}
1832 \setfont\smallsc\scshape{10}{900}{OT1}
1833 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1836 \def\smallecsize{0900}
1838 % Fonts for small examples (8pt).
1839 \def\smallernominalsize{8pt}
1840 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1841 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1842 \setfont\smallerbf\bfshape{10}{800}{OT1}
1843 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1844 \setfont\smallersl\slshape{8}{1000}{OT1}
1845 \setfont\smallersf\sfshape{8}{1000}{OT1}
1846 \setfont\smallersc\scshape{10}{800}{OT1}
1847 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1848 \font\smalleri=cmmi8
1849 \font\smallersy=cmsy8
1850 \def\smallerecsize{0800}
1852 % Fonts for title page (20.4pt):
1853 \def\titlenominalsize{20pt}
1854 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1855 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1856 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1857 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1858 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1859 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1860 \let\titlebf=\titlerm
1861 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1862 \font\titlei=cmmi12 scaled \magstep3
1863 \font\titlesy=cmsy10 scaled \magstep4
1864 \def\titleecsize{2074}
1866 % Chapter (and unnumbered) fonts (17.28pt).
1867 \def\chapnominalsize{17pt}
1868 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1869 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1870 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1871 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1872 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1873 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1875 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1876 \font\chapi=cmmi12 scaled \magstep2
1877 \font\chapsy=cmsy10 scaled \magstep3
1878 \def\chapecsize{1728}
1880 % Section fonts (14.4pt).
1881 \def\secnominalsize{14pt}
1882 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1883 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1884 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1885 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1886 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1887 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1889 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1890 \font\seci=cmmi12 scaled \magstep1
1891 \font\secsy=cmsy10 scaled \magstep2
1892 \def\sececsize{1440}
1894 % Subsection fonts (13.15pt).
1895 \def\ssecnominalsize{13pt}
1896 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1897 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1898 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1899 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1900 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1901 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1903 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1904 \font\sseci=cmmi12 scaled \magstephalf
1905 \font\ssecsy=cmsy10 scaled 1315
1906 \def\ssececsize{1200}
1908 % Reduced fonts for @acro in text (10pt).
1909 \def\reducednominalsize{10pt}
1910 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1911 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1912 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1913 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1914 \setfont\reducedsl\slshape{10}{1000}{OT1}
1915 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1916 \setfont\reducedsc\scshape{10}{1000}{OT1}
1917 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1918 \font\reducedi=cmmi10
1919 \font\reducedsy=cmsy10
1920 \def\reducedecsize{1000}
1922 \textleading = 13.2pt % line spacing for 11pt CM
1923 \textfonts % reset the current fonts
1925 } % end of 11pt text font size definitions
1928 % Definitions to make the main text be 10pt Computer Modern, with
1929 % section, chapter, etc., sizes following suit. This is for the GNU
1930 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1931 % future. Used with @smallbook, which sets the leading to 12pt.
1933 \def\definetextfontsizex{%
1934 % Text fonts (10pt).
1935 \def\textnominalsize{10pt}
1936 \edef\mainmagstep{1000}
1937 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1938 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1939 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1940 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1941 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1942 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1943 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1944 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1945 \font\texti=cmmi10 scaled \mainmagstep
1946 \font\textsy=cmsy10 scaled \mainmagstep
1947 \def\textecsize{1000}
1949 % A few fonts for @defun names and args.
1950 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1951 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1952 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1953 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1955 % Fonts for indices, footnotes, small examples (9pt).
1956 \def\smallnominalsize{9pt}
1957 \setfont\smallrm\rmshape{9}{1000}{OT1}
1958 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1959 \setfont\smallbf\bfshape{10}{900}{OT1}
1960 \setfont\smallit\itshape{9}{1000}{OT1IT}
1961 \setfont\smallsl\slshape{9}{1000}{OT1}
1962 \setfont\smallsf\sfshape{9}{1000}{OT1}
1963 \setfont\smallsc\scshape{10}{900}{OT1}
1964 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1967 \def\smallecsize{0900}
1969 % Fonts for small examples (8pt).
1970 \def\smallernominalsize{8pt}
1971 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1972 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1973 \setfont\smallerbf\bfshape{10}{800}{OT1}
1974 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1975 \setfont\smallersl\slshape{8}{1000}{OT1}
1976 \setfont\smallersf\sfshape{8}{1000}{OT1}
1977 \setfont\smallersc\scshape{10}{800}{OT1}
1978 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1979 \font\smalleri=cmmi8
1980 \font\smallersy=cmsy8
1981 \def\smallerecsize{0800}
1983 % Fonts for title page (20.4pt):
1984 \def\titlenominalsize{20pt}
1985 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1986 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1987 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1988 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1989 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1990 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1991 \let\titlebf=\titlerm
1992 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1993 \font\titlei=cmmi12 scaled \magstep3
1994 \font\titlesy=cmsy10 scaled \magstep4
1995 \def\titleecsize{2074}
1997 % Chapter fonts (14.4pt).
1998 \def\chapnominalsize{14pt}
1999 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2000 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2001 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2002 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2003 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2004 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2006 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2007 \font\chapi=cmmi12 scaled \magstep1
2008 \font\chapsy=cmsy10 scaled \magstep2
2009 \def\chapecsize{1440}
2011 % Section fonts (12pt).
2012 \def\secnominalsize{12pt}
2013 \setfont\secrm\rmbshape{12}{1000}{OT1}
2014 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2015 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2016 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2017 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2018 \setfont\secsf\sfbshape{12}{1000}{OT1}
2020 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2022 \font\secsy=cmsy10 scaled \magstep1
2023 \def\sececsize{1200}
2025 % Subsection fonts (10pt).
2026 \def\ssecnominalsize{10pt}
2027 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2028 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2029 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2030 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2031 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2032 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2034 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2037 \def\ssececsize{1000}
2039 % Reduced fonts for @acro in text (9pt).
2040 \def\reducednominalsize{9pt}
2041 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2042 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2043 \setfont\reducedbf\bfshape{10}{900}{OT1}
2044 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2045 \setfont\reducedsl\slshape{9}{1000}{OT1}
2046 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2047 \setfont\reducedsc\scshape{10}{900}{OT1}
2048 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2049 \font\reducedi=cmmi9
2050 \font\reducedsy=cmsy9
2051 \def\reducedecsize{0900}
2053 \divide\parskip by 2 % reduce space between paragraphs
2054 \textleading = 12pt % line spacing for 10pt CM
2055 \textfonts % reset the current fonts
2057 } % end of 10pt text font size definitions
2060 % We provide the user-level command
2062 % (or 11) to redefine the text font size. pt is assumed.
2068 \parseargdef\fonttextsize{%
2069 \def\textsizearg{#1}%
2070 %\wlog{doing @fonttextsize \textsizearg}%
2072 % Set \globaldefs so that documents can use this inside @tex, since
2073 % makeinfo 4.8 does not support it, but we need it nonetheless.
2075 \begingroup \globaldefs=1
2076 \ifx\textsizearg\xword \definetextfontsizex
2077 \else \ifx\textsizearg\xiword \definetextfontsizexi
2080 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2086 % In order for the font changes to affect most math symbols and letters,
2087 % we have to define the \textfont of the standard families. Since
2088 % texinfo doesn't allow for producing subscripts and superscripts except
2089 % in the main text, we don't bother to reset \scriptfont and
2090 % \scriptscriptfont (which would also require loading a lot more fonts).
2092 \def\resetmathfonts{%
2093 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2094 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2095 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2098 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2099 % of just \STYLE. We do this because \STYLE needs to also set the
2100 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2101 % \tenSTYLE to set the current font.
2103 % Each font-changing command also sets the names \lsize (one size lower)
2104 % and \lllsize (three sizes lower). These relative commands are used in
2105 % the LaTeX logo and acronyms.
2107 % This all needs generalizing, badly.
2110 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2111 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2112 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2113 \let\tenttsl=\textttsl
2114 \def\curfontsize{text}%
2115 \def\lsize{reduced}\def\lllsize{smaller}%
2116 \resetmathfonts \setleading{\textleading}}
2118 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2119 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2120 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2121 \let\tenttsl=\titlettsl
2122 \def\curfontsize{title}%
2123 \def\lsize{chap}\def\lllsize{subsec}%
2124 \resetmathfonts \setleading{27pt}}
2125 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2127 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2128 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2129 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2130 \let\tenttsl=\chapttsl
2131 \def\curfontsize{chap}%
2132 \def\lsize{sec}\def\lllsize{text}%
2133 \resetmathfonts \setleading{19pt}}
2135 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2136 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2137 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2138 \let\tenttsl=\secttsl
2139 \def\curfontsize{sec}%
2140 \def\lsize{subsec}\def\lllsize{reduced}%
2141 \resetmathfonts \setleading{16pt}}
2143 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2144 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2145 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2146 \let\tenttsl=\ssecttsl
2147 \def\curfontsize{ssec}%
2148 \def\lsize{text}\def\lllsize{small}%
2149 \resetmathfonts \setleading{15pt}}
2150 \let\subsubsecfonts = \subsecfonts
2152 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2153 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2154 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2155 \let\tenttsl=\reducedttsl
2156 \def\curfontsize{reduced}%
2157 \def\lsize{small}\def\lllsize{smaller}%
2158 \resetmathfonts \setleading{10.5pt}}
2160 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2161 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2162 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2163 \let\tenttsl=\smallttsl
2164 \def\curfontsize{small}%
2165 \def\lsize{smaller}\def\lllsize{smaller}%
2166 \resetmathfonts \setleading{10.5pt}}
2168 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2169 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2170 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2171 \let\tenttsl=\smallerttsl
2172 \def\curfontsize{smaller}%
2173 \def\lsize{smaller}\def\lllsize{smaller}%
2174 \resetmathfonts \setleading{9.5pt}}
2176 % Fonts for short table of contents.
2177 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2178 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2179 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2180 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2182 % Define these just so they can be easily changed for other fonts.
2183 \def\angleleft{$\langle$}
2184 \def\angleright{$\rangle$}
2186 % Set the fonts to use with the @small... environments.
2187 \let\smallexamplefonts = \smallfonts
2189 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2190 % can fit this many characters:
2191 % 8.5x11=86 smallbook=72 a4=90 a5=69
2192 % If we use \scriptfonts (8pt), then we can fit this many characters:
2193 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2194 % For me, subjectively, the few extra characters that fit aren't worth
2195 % the additional smallness of 8pt. So I'm making the default 9pt.
2197 % By the way, for comparison, here's what fits with @example (10pt):
2198 % 8.5x11=71 smallbook=60 a4=75 a5=58
2201 % Set up the default fonts, so we can use them for creating boxes.
2203 \definetextfontsizexi
2208 % Check if we are currently using a typewriter font. Since all the
2209 % Computer Modern typewriter fonts have zero interword stretch (and
2210 % shrink), and it is reasonable to expect all typewriter fonts to have
2211 % this property, we can check that font parameter.
2213 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2215 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2216 % define and register \INITMACRO to be called on markup style changes.
2217 % \INITMACRO can check \currentmarkupstyle for the innermost
2218 % style and the set of \ifmarkupSTYLE switches for all styles
2219 % currently in effect.
2223 %\newif\ifmarkupfile % @file == @samp.
2224 %\newif\ifmarkupoption % @option == @samp.
2227 %\newif\ifmarkupenv % @env == @code.
2228 %\newif\ifmarkupcommand % @command == @code.
2229 \newif\ifmarkuptex % @tex (and part of @math, for now).
2230 \newif\ifmarkupexample
2232 \newif\ifmarkupverbatim
2234 \let\currentmarkupstyle\empty
2236 \def\setupmarkupstyle#1{%
2237 \csname markup#1true\endcsname
2238 \def\currentmarkupstyle{#1}%
2242 \let\markupstylesetup\empty
2244 \def\defmarkupstylesetup#1{%
2245 \expandafter\def\expandafter\markupstylesetup
2246 \expandafter{\markupstylesetup #1}%
2250 % Markup style setup for left and right quotes.
2251 \defmarkupstylesetup\markupsetuplq{%
2252 \expandafter\let\expandafter \temp
2253 \csname markupsetuplq\currentmarkupstyle\endcsname
2254 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2257 \defmarkupstylesetup\markupsetuprq{%
2258 \expandafter\let\expandafter \temp
2259 \csname markupsetuprq\currentmarkupstyle\endcsname
2260 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2267 \gdef\markupsetuplqdefault{\let`\lq}
2268 \gdef\markupsetuprqdefault{\let'\rq}
2270 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2271 \gdef\markupsetcodequoteright{\let'\codequoteright}
2273 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2276 \let\markupsetuplqcode \markupsetcodequoteleft
2277 \let\markupsetuprqcode \markupsetcodequoteright
2279 \let\markupsetuplqexample \markupsetcodequoteleft
2280 \let\markupsetuprqexample \markupsetcodequoteright
2282 \let\markupsetuplqsamp \markupsetcodequoteleft
2283 \let\markupsetuprqsamp \markupsetcodequoteright
2285 \let\markupsetuplqverb \markupsetcodequoteleft
2286 \let\markupsetuprqverb \markupsetcodequoteright
2288 \let\markupsetuplqverbatim \markupsetcodequoteleft
2289 \let\markupsetuprqverbatim \markupsetcodequoteright
2291 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2293 % Allow an option to not use regular directed right quote/apostrophe
2294 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2295 % The undirected quote is ugly, so don't make it the default, but it
2296 % works for pasting with more pdf viewers (at least evince), the
2297 % lilypond developers report. xpdf does work with the regular 0x27.
2299 \def\codequoteright{%
2300 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2301 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2307 % and a similar option for the left quote char vs. a grave accent.
2308 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2309 % the code environments to do likewise.
2311 \def\codequoteleft{%
2312 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2313 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2314 % [Knuth] pp. 380,381,391
2315 % \relax disables Spanish ligatures ?` and !` of \tt font.
2321 % Commands to set the quote options.
2323 \parseargdef\codequoteundirected{%
2326 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2328 \else\ifx\temp\offword
2329 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2332 \errhelp = \EMsimple
2333 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2337 \parseargdef\codequotebacktick{%
2340 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2342 \else\ifx\temp\offword
2343 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2346 \errhelp = \EMsimple
2347 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2351 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2352 \def\noligaturesquoteleft{\relax\lq}
2354 % Count depth in font-changes, for error checks
2355 \newcount\fontdepth \fontdepth=0
2359 % #1 is the font command (\sl or \it), #2 is the text to slant.
2360 % If we are in a monospaced environment, however, 1) always use \ttsl,
2361 % and 2) do not add an italic correction.
2362 \def\dosmartslant#1#2{%
2364 {{\ttsl #2}\let\next=\relax}%
2365 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2368 \def\smartslanted{\dosmartslant\sl}
2369 \def\smartitalic{\dosmartslant\it}
2371 % Output an italic correction unless \next (presumed to be the following
2372 % character) is such as not to need one.
2373 \def\smartitaliccorrection{%
2382 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2383 % @var is set to this for defun arguments.
2384 \def\ttslanted#1{{\ttsl #1}}
2386 % @cite is like \smartslanted except unconditionally use \sl. We never want
2387 % ttsl for book titles, do we?
2388 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2392 \let\saveaftersmartic = \aftersmartic
2393 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2398 \let\slanted=\smartslanted
2399 \let\dfn=\smartslanted
2400 \let\emph=\smartitalic
2402 % Explicit font changes: @r, @sc, undocumented @ii.
2403 \def\r#1{{\rm #1}} % roman font
2404 \def\sc#1{{\smallcaps#1}} % smallcaps font
2405 \def\ii#1{{\it #1}} % italic font
2407 % @b, explicit bold. Also @strong.
2411 % @sansserif, explicit sans.
2412 \def\sansserif#1{{\sf #1}}
2414 % We can't just use \exhyphenpenalty, because that only has effect at
2415 % the end of a paragraph. Restore normal hyphenation at the end of the
2416 % group within which \nohyphenation is presumably called.
2418 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2419 \def\restorehyphenation{\hyphenchar\font = `- }
2421 % Set sfcode to normal for the chars that usually have another value.
2422 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2423 % sometimes \x has an active definition that messes things up.
2426 \def\plainfrenchspacing{%
2427 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2428 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2429 \def\endofsentencespacefactor{1000}% for @. and friends
2431 \def\plainnonfrenchspacing{%
2432 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2433 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2434 \def\endofsentencespacefactor{3000}% for @. and friends
2437 \def\endofsentencespacefactor{3000}% default
2439 % @t, explicit typewriter.
2441 {\tt \rawbackslash \plainfrenchspacing #1}%
2446 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2448 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2449 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2451 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2452 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2453 % \vbox{\hrule\kern-0.4pt
2454 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2455 % \kern-0.4pt\hrule}%
2456 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2458 % definition of @key with no lozenge. If the current font is already
2459 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2460 % if it isn't monospace, then use \tt.
2462 \def\key#1{{\setupmarkupstyle{key}%
2464 \ifmonospace\else\tt\fi
2467 % ctrl is no longer a Texinfo command.
2468 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2470 % @file, @option are the same as @samp.
2474 % @code is a modification of @t,
2475 % which makes spaces the same size as normal in the surrounding text.
2478 % Change normal interword space to be same as for the current font.
2479 \spaceskip = \fontdimen2\font
2481 % Switch to typewriter.
2484 % But `\ ' produces the large typewriter interword space.
2485 \def\ {{\spaceskip = 0pt{} }}%
2487 % Turn off hyphenation.
2494 \null % reset spacefactor to 1000
2497 % We *must* turn on hyphenation at `-' and `_' in @code.
2498 % Otherwise, it is too hard to avoid overfull hboxes
2499 % in the Emacs manual, the Library manual, etc.
2501 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2502 % both hyphenation at - and hyphenation within words.
2503 % We must therefore turn them both off (\tclose does that)
2504 % and arrange explicitly to hyphenate at a dash.
2507 \catcode`\-=\active \catcode`\_=\active
2508 \catcode`\'=\active \catcode`\`=\active
2509 \global\let'=\rq \global\let`=\lq % default definitions
2511 \global\def\code{\begingroup
2512 \setupmarkupstyle{code}%
2513 % The following should really be moved into \setupmarkupstyle handlers.
2514 \catcode\dashChar=\active \catcode\underChar=\active
2526 \def\codex #1{\tclose{#1}\endgroup}
2529 \def\codedash{-\discretionary{}{}{}}
2531 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2532 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2533 % will therefore expand the active definition of _, which is us
2534 % (inside @code that is), therefore an endless loop.
2536 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2537 \else\normalunderscore \fi
2538 \discretionary{}{}{}}%
2542 % An additional complication: the above will allow breaks after, e.g.,
2543 % each of the four underscores in __typeof__. This is undesirable in
2544 % some manuals, especially if they don't have long identifiers in
2545 % general. @allowcodebreaks provides a way to control this.
2547 \newif\ifallowcodebreaks \allowcodebreakstrue
2549 \def\keywordtrue{true}
2550 \def\keywordfalse{false}
2552 \parseargdef\allowcodebreaks{%
2554 \ifx\txiarg\keywordtrue
2555 \allowcodebreakstrue
2556 \else\ifx\txiarg\keywordfalse
2557 \allowcodebreaksfalse
2559 \errhelp = \EMsimple
2560 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2564 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2565 % second argument specifying the text to display and an optional third
2566 % arg as text to display instead of (rather than in addition to) the url
2567 % itself. First (mandatory) arg is the url.
2568 % (This \urefnobreak definition isn't used now, leaving it for a while
2570 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2571 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2574 \setbox0 = \hbox{\ignorespaces #3}%
2576 \unhbox0 % third arg given, show only that
2578 \setbox0 = \hbox{\ignorespaces #2}%
2581 \unhbox0 % PDF: 2nd arg given, show only it
2583 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2586 \code{#1}% only url given, so show it
2592 % This \urefbreak definition is the active one.
2593 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2594 \let\uref=\urefbreak
2595 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2596 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2599 \setbox0 = \hbox{\ignorespaces #3}%
2601 \unhbox0 % third arg given, show only that
2603 \setbox0 = \hbox{\ignorespaces #2}%
2606 \unhbox0 % PDF: 2nd arg given, show only it
2608 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2611 \urefcode{#1}% only url given, so show it
2617 % Allow line breaks around only a few characters (only).
2619 \catcode\ampChar=\active \catcode\dotChar=\active
2620 \catcode\hashChar=\active \catcode\questChar=\active
2621 \catcode\slashChar=\active
2626 \global\def\urefcode{\begingroup
2627 \setupmarkupstyle{code}%
2637 % By default, they are just regular characters.
2638 \global\def&{\normalamp}
2639 \global\def.{\normaldot}
2640 \global\def#{\normalhash}
2641 \global\def?{\normalquest}
2642 \global\def/{\normalslash}
2645 % we put a little stretch before and after the breakable chars, to help
2646 % line breaking of long url's. The unequal skips make look better in
2647 % cmtt at least, especially for dots.
2648 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2649 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2651 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2652 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2653 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2654 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2655 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2658 \global\def\urefcodeslashfinish{%
2659 \urefprestretch \slashChar
2660 % Allow line break only after the final / in a sequence of
2661 % slashes, to avoid line break between the slashes in http://.
2662 \ifx\next/\else \urefpoststretch \fi
2666 % One more complication: by default we'll break after the special
2667 % characters, but some people like to break before the special chars, so
2668 % allow that. Also allow no breaking at all, for manual control.
2670 \parseargdef\urefbreakstyle{%
2672 \ifx\txiarg\wordnone
2673 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2674 \else\ifx\txiarg\wordbefore
2675 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2676 \else\ifx\txiarg\wordafter
2677 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2679 \errhelp = \EMsimple
2680 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2683 \def\wordafter{after}
2684 \def\wordbefore{before}
2687 \urefbreakstyle after
2689 % @url synonym for @uref, since that's how everyone uses it.
2693 % rms does not like angle brackets --karl, 17may97.
2694 % So now @email is just like @uref, unless we are pdf.
2696 %\def\email#1{\angleleft{\tt #1}\angleright}
2698 \def\email#1{\doemail#1,,\finish}
2699 \def\doemail#1,#2,#3\finish{\begingroup
2702 \setbox0 = \hbox{\ignorespaces #2}%
2703 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2710 % @kbd is like @code, except that if the argument is just one @key command,
2711 % then @kbd has no effect.
2712 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2714 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2715 % `example' (@kbd uses ttsl only inside of @example and friends),
2716 % or `code' (@kbd uses normal tty font always).
2717 \parseargdef\kbdinputstyle{%
2719 \ifx\txiarg\worddistinct
2720 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2721 \else\ifx\txiarg\wordexample
2722 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2723 \else\ifx\txiarg\wordcode
2724 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2726 \errhelp = \EMsimple
2727 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2730 \def\worddistinct{distinct}
2731 \def\wordexample{example}
2734 % Default is `distinct'.
2735 \kbdinputstyle distinct
2738 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2739 \ifx\one\xkey\ifx\threex\three \key{#2}%
2740 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2741 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2743 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2744 \let\indicateurl=\code
2748 % @clicksequence{File @click{} Open ...}
2749 \def\clicksequence#1{\begingroup #1\endgroup}
2751 % @clickstyle @arrow (by default)
2752 \parseargdef\clickstyle{\def\click{#1}}
2755 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2756 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2758 \def\dmn#1{\thinspace #1}
2760 % @l was never documented to mean ``switch to the Lisp font'',
2761 % and it is not used as such in any manual I can find. We need it for
2762 % Polish suppressed-l. --karl, 22sep96.
2763 %\def\l#1{{\li #1}\null}
2765 % @acronym for "FBI", "NATO", and the like.
2766 % We print this one point size smaller, since it's intended for
2769 \def\acronym#1{\doacronym #1,,\finish}
2770 \def\doacronym#1,#2,#3\finish{%
2771 {\selectfonts\lsize #1}%
2773 \ifx\temp\empty \else
2774 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2776 \null % reset \spacefactor=1000
2779 % @abbr for "Comput. J." and the like.
2780 % No font change, but don't do end-of-sentence spacing.
2782 \def\abbr#1{\doabbr #1,,\finish}
2783 \def\doabbr#1,#2,#3\finish{%
2784 {\plainfrenchspacing #1}%
2786 \ifx\temp\empty \else
2787 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2789 \null % reset \spacefactor=1000
2792 % @asis just yields its argument. Used with @table, for example.
2796 % @math outputs its argument in math mode.
2798 % One complication: _ usually means subscripts, but it could also mean
2799 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2800 % _ active, and distinguish by seeing if the current family is \slfam,
2801 % which is what @var uses.
2803 \catcode`\_ = \active
2804 \gdef\mathunderscore{%
2806 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2809 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2810 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2811 % particular reason), but this is not advertised and we don't care.
2813 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2814 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2819 \let\\ = \mathbackslash
2821 % make the texinfo accent commands work in math mode
2833 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2835 % Some active characters (such as <) are spaced differently in math.
2836 % We have to reset their definitions in case the @math was an argument
2837 % to a command which sets the catcodes (such as @item or @section).
2840 \catcode`^ = \active
2841 \catcode`< = \active
2842 \catcode`> = \active
2843 \catcode`+ = \active
2844 \catcode`' = \active
2850 \let' = \ptexquoteright
2861 % Used to generate quoted braces. Unless we're in typewriter, use
2862 % \ecfont because the CM text fonts do not have braces, and we don't
2863 % want to switch into math.
2864 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2865 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2869 % Definitions to produce \{ and \} commands for indices,
2870 % and @{ and @} for the aux/toc files.
2871 \catcode`\{ = \other \catcode`\} = \other
2872 \catcode`\[ = 1 \catcode`\] = 2
2873 \catcode`\! = 0 \catcode`\\ = \other
2874 !gdef!lbracecmd[\{]%
2875 !gdef!rbracecmd[\}]%
2876 !gdef!lbraceatcmd[@{]%
2877 !gdef!rbraceatcmd[@}]%
2880 % @comma{} to avoid , parsing problems.
2883 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2884 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2886 \let\dotaccent = \ptexdot
2887 \def\ringaccent#1{{\accent23 #1}}
2888 \let\tieaccent = \ptext
2889 \let\ubaraccent = \ptexb
2890 \let\udotaccent = \d
2892 % Other special characters: @questiondown @exclamdown @ordf @ordm
2893 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2894 \def\questiondown{?`}
2896 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2897 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2899 % Dotless i and dotless j, used for accents.
2904 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2905 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2906 \else \errmessage{@dotless can be used only with i or j}%
2910 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2911 % period following counts as ending a sentence. (Idea found in latex.)
2913 \edef\TeX{\TeX \spacefactor=1000 }
2915 % @LaTeX{} logo. Not quite the same results as the definition in
2916 % latex.ltx, since we use a different font for the raised A; it's most
2917 % convenient for us to use an explicitly smaller font, rather than using
2918 % the \scriptstyle font (since we don't reset \scriptstyle and
2919 % \scriptscriptstyle).
2924 \vbox to \ht0{\hbox{%
2925 \ifx\textnominalsize\xwordpt
2926 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2927 % Revert to plain's \scriptsize, which is 7pt.
2928 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2930 % For 11pt, we can use our lllsize.
2931 \selectfonts\lllsize A%
2940 % Some math mode symbols.
2941 \def\bullet{$\ptexbullet$}
2942 \def\geq{\ifmmode \ge\else $\ge$\fi}
2943 \def\leq{\ifmmode \le\else $\le$\fi}
2944 \def\minus{\ifmmode -\else $-$\fi}
2946 % @dots{} outputs an ellipsis using the current font.
2947 % We do .5em per period so that it has the same spacing in the cm
2948 % typewriter fonts as three actual period characters; on the other hand,
2949 % in other typewriter fonts three periods are wider than 1.5em. So do
2950 % whichever is larger.
2954 \setbox0=\hbox{...}% get width of three periods
2961 \hskip 0pt plus.25fil
2962 .\hskip 0pt plus1fil
2963 .\hskip 0pt plus1fil
2964 .\hskip 0pt plus.5fil
2968 % @enddots{} is an end-of-sentence ellipsis.
2972 \spacefactor=\endofsentencespacefactor
2975 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2977 % Since these characters are used in examples, they should be an even number of
2978 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2981 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2982 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2983 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2984 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2985 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2987 % The @error{} command.
2988 % Adapted from the TeXbook's \boxit.
2992 {\tentt \global\dimen0 = 3em}% Width of the box.
2993 \dimen2 = .55pt % Thickness of rules
2994 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2995 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
2997 \setbox\errorbox=\hbox to \dimen0{\hfil
2998 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2999 \advance\hsize by -2\dimen2 % Rules.
3001 \hrule height\dimen2
3002 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3003 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3004 \kern3pt\vrule width\dimen2}% Space to right.
3005 \hrule height\dimen2}
3008 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3010 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3012 \def\pounds{{\it\$}}
3014 % @euro{} comes from a separate font, depending on the current style.
3015 % We use the free feym* fonts from the eurosym package by Henrik
3016 % Theiling, which support regular, slanted, bold and bold slanted (and
3017 % "outlined" (blackboard board, sort of) versions, which we don't need).
3018 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3020 % Although only regular is the truly official Euro symbol, we ignore
3021 % that. The Euro is designed to be slightly taller than the regular
3027 % feybo - bold slanted
3029 % There is no good (free) typewriter version, to my knowledge.
3030 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3033 % Also doesn't work in math. Do we need to do math with euro symbols?
3037 \def\euro{{\eurofont e}}
3039 % We set the font at each command, rather than predefining it in
3040 % \textfonts and the other font-switching commands, so that
3041 % installations which never need the symbol don't have to have the
3044 % There is only one designed size (nominal 10pt), so we always scale
3045 % that to the current nominal size.
3047 % By the way, simply using "at 1em" works for cmr10 and the like, but
3048 % does not work for cmbx10 and other extended/shrunken fonts.
3050 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3052 \ifx\curfontstyle\bfstylename
3054 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3057 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3062 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3063 % sometimes we redefine the original macro, and the alias should reflect
3066 % Use LaTeX names for the Icelandic letters.
3067 \def\DH{{\ecfont \char"D0}} % Eth
3068 \def\dh{{\ecfont \char"F0}} % eth
3069 \def\TH{{\ecfont \char"DE}} % Thorn
3070 \def\th{{\ecfont \char"FE}} % thorn
3072 \def\guillemetleft{{\ecfont \char"13}}
3073 \def\guillemotleft{\guillemetleft}
3074 \def\guillemetright{{\ecfont \char"14}}
3075 \def\guillemotright{\guillemetright}
3076 \def\guilsinglleft{{\ecfont \char"0E}}
3077 \def\guilsinglright{{\ecfont \char"0F}}
3078 \def\quotedblbase{{\ecfont \char"12}}
3079 \def\quotesinglbase{{\ecfont \char"0D}}
3081 % This positioning is not perfect (see the ogonek LaTeX package), but
3082 % we have the precomposed glyphs for the most common cases. We put the
3083 % tests to use those glyphs in the single \ogonek macro so we have fewer
3084 % dummy definitions to worry about for index entries, etc.
3086 % ogonek is also used with other letters in Lithuanian (IOU), but using
3087 % the precomposed glyphs for those is not so easy since they aren't in
3091 \ifx\temp\macrocharA\Aogonek
3092 \else\ifx\temp\macrochara\aogonek
3093 \else\ifx\temp\macrocharE\Eogonek
3094 \else\ifx\temp\macrochare\eogonek
3096 \ecfont \setbox0=\hbox{#1}%
3097 \ifdim\ht0=1ex\accent"0C #1%
3098 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3103 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3104 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3105 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3106 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3108 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3110 % We can't distinguish serif/sans and italic/slanted, but this
3111 % is used for crude hacks anyway (like adding French and German
3112 % quotes to documents typeset with CM, where we lose kerning), so
3113 % hopefully nobody will notice/care.
3114 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3115 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3116 \ifx\curfontstyle\bfstylename
3118 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3121 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3126 % @registeredsymbol - R in a circle. The font for the R should really
3127 % be smaller yet, but lllsize is the best we can do for now.
3128 % Adapted from the plain.tex definition of \copyright.
3130 \def\registeredsymbol{%
3131 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3136 % @textdegree - the normal degrees sign.
3138 \def\textdegree{$^\circ$}
3140 % Laurent Siebenmann reports \Orb undefined with:
3141 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3142 % so we'll define it if necessary.
3144 \ifx\Orb\thisisundefined
3145 \def\Orb{\mathhexbox20D}
3149 \chardef\quotedblleft="5C
3150 \chardef\quotedblright=`\"
3151 \chardef\quoteleft=`\`
3152 \chardef\quoteright=`\'
3155 \message{page headings,}
3157 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3158 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3160 % First the title page. Must do @settitle before @titlepage.
3162 \newif\iffinishedtitlepage
3164 % Do an implicit @contents or @shortcontents after @end titlepage if the
3165 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3167 \newif\ifsetcontentsaftertitlepage
3168 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3169 \newif\ifsetshortcontentsaftertitlepage
3170 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3172 \parseargdef\shorttitlepage{%
3173 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3174 \endgroup\page\hbox{}\page}
3177 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3179 \parindent=0pt \textfonts
3180 % Leave some space at the very top of the page.
3181 \vglue\titlepagetopglue
3182 % No rule at page bottom unless we print one at the top with @title.
3183 \finishedtitlepagetrue
3185 % Most title ``pages'' are actually two pages long, with space
3186 % at the top of the second. We don't want the ragged left on the second.
3187 \let\oldpage = \page
3189 \iffinishedtitlepage\else
3192 \let\page = \oldpage
3199 \iffinishedtitlepage\else
3202 % It is important to do the page break before ending the group,
3203 % because the headline and footline are only empty inside the group.
3204 % If we use the new definition of \page, we always get a blank page
3205 % after the title page, which we certainly don't want.
3209 % Need this before the \...aftertitlepage checks so that if they are
3210 % in effect the toc pages will come out with page numbers.
3213 % If they want short, they certainly want long too.
3214 \ifsetshortcontentsaftertitlepage
3217 \global\let\shortcontents = \relax
3218 \global\let\contents = \relax
3221 \ifsetcontentsaftertitlepage
3223 \global\let\contents = \relax
3224 \global\let\shortcontents = \relax
3228 \def\finishtitlepage{%
3229 \vskip4pt \hrule height 2pt width \hsize
3230 \vskip\titlepagebottomglue
3231 \finishedtitlepagetrue
3234 % Macros to be used within @titlepage:
3236 \let\subtitlerm=\tenrm
3237 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3239 \parseargdef\title{%
3241 \leftline{\titlefonts\rmisbold #1}
3242 % print a rule at the page bottom also.
3243 \finishedtitlepagefalse
3244 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3247 \parseargdef\subtitle{%
3249 {\subtitlefont \rightline{#1}}%
3252 % @author should come last, but may come many times.
3253 % It can also be used inside @quotation.
3255 \parseargdef\author{%
3256 \def\temp{\quotation}%
3258 \def\quotationauthor{#1}% printed in \Equotation.
3261 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3262 {\secfonts\rmisbold \leftline{#1}}%
3267 % Set up page headings and footings.
3269 \let\thispage=\folio
3271 \newtoks\evenheadline % headline on even pages
3272 \newtoks\oddheadline % headline on odd pages
3273 \newtoks\evenfootline % footline on even pages
3274 \newtoks\oddfootline % footline on odd pages
3276 % Now make TeX use those variables
3277 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3278 \else \the\evenheadline \fi}}
3279 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3280 \else \the\evenfootline \fi}\HEADINGShook}
3281 \let\HEADINGShook=\relax
3283 % Commands to set those variables.
3284 % For example, this is what @headings on does
3285 % @evenheading @thistitle|@thispage|@thischapter
3286 % @oddheading @thischapter|@thispage|@thistitle
3287 % @evenfooting @thisfile||
3288 % @oddfooting ||@thisfile
3291 \def\evenheading{\parsearg\evenheadingxxx}
3292 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3293 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3294 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3296 \def\oddheading{\parsearg\oddheadingxxx}
3297 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3298 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3299 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3301 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3303 \def\evenfooting{\parsearg\evenfootingxxx}
3304 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3305 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3306 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3308 \def\oddfooting{\parsearg\oddfootingxxx}
3309 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3310 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3311 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3313 % Leave some space for the footline. Hopefully ok to assume
3314 % @evenfooting will not be used by itself.
3315 \global\advance\pageheight by -12pt
3316 \global\advance\vsize by -12pt
3319 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3321 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3322 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3324 % The same set of arguments for:
3329 % @everyheadingmarks
3330 % @everyfootingmarks
3332 \def\evenheadingmarks{\headingmarks{even}{heading}}
3333 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3334 \def\evenfootingmarks{\headingmarks{even}{footing}}
3335 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3336 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3337 \headingmarks{odd}{heading}{#1} }
3338 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3339 \headingmarks{odd}{footing}{#1} }
3340 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3341 \def\headingmarks#1#2#3 {%
3342 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3343 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3346 \everyheadingmarks bottom
3347 \everyfootingmarks bottom
3349 % @headings double turns headings on for double-sided printing.
3350 % @headings single turns headings on for single-sided printing.
3351 % @headings off turns them off.
3352 % @headings on same as @headings double, retained for compatibility.
3353 % @headings after turns on double-sided headings after this page.
3354 % @headings doubleafter turns on double-sided headings after this page.
3355 % @headings singleafter turns on single-sided headings after this page.
3356 % By default, they are off at the start of a document,
3357 % and turned `on' after @end titlepage.
3359 \def\headings #1 {\csname HEADINGS#1\endcsname}
3361 \def\headingsoff{% non-global headings elimination
3362 \evenheadline={\hfil}\evenfootline={\hfil}%
3363 \oddheadline={\hfil}\oddfootline={\hfil}%
3366 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3367 \HEADINGSoff % it's the default
3369 % When we turn headings on, set the page number to 1.
3370 % For double-sided printing, put current file name in lower left corner,
3371 % chapter name on inside top of right hand pages, document
3372 % title on inside top of left hand pages, and page numbers on outside top
3373 % edge of all pages.
3374 \def\HEADINGSdouble{%
3376 \global\evenfootline={\hfil}
3377 \global\oddfootline={\hfil}
3378 \global\evenheadline={\line{\folio\hfil\thistitle}}
3379 \global\oddheadline={\line{\thischapter\hfil\folio}}
3380 \global\let\contentsalignmacro = \chapoddpage
3382 \let\contentsalignmacro = \chappager
3384 % For single-sided printing, chapter title goes across top left of page,
3385 % page number on top right.
3386 \def\HEADINGSsingle{%
3388 \global\evenfootline={\hfil}
3389 \global\oddfootline={\hfil}
3390 \global\evenheadline={\line{\thischapter\hfil\folio}}
3391 \global\oddheadline={\line{\thischapter\hfil\folio}}
3392 \global\let\contentsalignmacro = \chappager
3394 \def\HEADINGSon{\HEADINGSdouble}
3396 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3397 \let\HEADINGSdoubleafter=\HEADINGSafter
3398 \def\HEADINGSdoublex{%
3399 \global\evenfootline={\hfil}
3400 \global\oddfootline={\hfil}
3401 \global\evenheadline={\line{\folio\hfil\thistitle}}
3402 \global\oddheadline={\line{\thischapter\hfil\folio}}
3403 \global\let\contentsalignmacro = \chapoddpage
3406 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3407 \def\HEADINGSsinglex{%
3408 \global\evenfootline={\hfil}
3409 \global\oddfootline={\hfil}
3410 \global\evenheadline={\line{\thischapter\hfil\folio}}
3411 \global\oddheadline={\line{\thischapter\hfil\folio}}
3412 \global\let\contentsalignmacro = \chappager
3415 % Subroutines used in generating headings
3416 % This produces Day Month Year style of output.
3417 % Only define if not already defined, in case a txi-??.tex file has set
3418 % up a different format (e.g., txi-cs.tex does this).
3419 \ifx\today\thisisundefined
3423 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3424 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3425 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3430 % @settitle line... specifies the title of the document, for headings.
3431 % It generates no output of its own.
3432 \def\thistitle{\putwordNoTitle}
3433 \def\settitle{\parsearg{\gdef\thistitle}}
3437 % Tables -- @table, @ftable, @vtable, @item(x).
3439 % default indentation of table text
3440 \newdimen\tableindent \tableindent=.8in
3441 % default indentation of @itemize and @enumerate text
3442 \newdimen\itemindent \itemindent=.3in
3443 % margin between end of table item and start of table text.
3444 \newdimen\itemmargin \itemmargin=.1in
3446 % used internally for \itemindent minus \itemmargin
3449 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3451 % They also define \itemindex
3452 % to index the item name in whatever manner is desired (perhaps none).
3454 \newif\ifitemxneedsnegativevskip
3456 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3458 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3459 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3461 \def\itemzzz #1{\begingroup %
3462 \advance\hsize by -\rightskip
3463 \advance\hsize by -\tableindent
3464 \setbox0=\hbox{\itemindicate{#1}}%
3466 \nobreak % This prevents a break before @itemx.
3468 % If the item text does not fit in the space we have, put it on a line
3469 % by itself, and do not allow a page break either before or after that
3470 % line. We do not start a paragraph here because then if the next
3471 % command is, e.g., @kindex, the whatsit would get put into the
3472 % horizontal list on a line by itself, resulting in extra blank space.
3473 \ifdim \wd0>\itemmax
3475 % Make this a paragraph so we get the \parskip glue and wrapping,
3476 % but leave it ragged-right.
3478 \advance\leftskip by-\tableindent
3479 \advance\hsize by\tableindent
3480 \advance\rightskip by0pt plus1fil\relax
3481 \leavevmode\unhbox0\par
3484 % We're going to be starting a paragraph, but we don't want the
3485 % \parskip glue -- logically it's part of the @item we just started.
3486 \nobreak \vskip-\parskip
3488 % Stop a page break at the \parskip glue coming up. However, if
3489 % what follows is an environment such as @example, there will be no
3490 % \parskip glue; then the negative vskip we just inserted would
3491 % cause the example and the item to crash together. So we use this
3492 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3493 % \parskip glue after all. Section titles are handled this way also.
3497 \itemxneedsnegativevskipfalse
3499 % The item text fits into the space. Start a paragraph, so that the
3500 % following text (if any) will end up on the same line.
3502 % Do this with kerns and \unhbox so that if there is a footnote in
3503 % the item text, it can migrate to the main vertical list and
3504 % eventually be printed.
3505 \nobreak\kern-\tableindent
3506 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3508 \nobreak\kern\dimen0
3510 \itemxneedsnegativevskiptrue
3514 \def\item{\errmessage{@item while not in a list environment}}
3515 \def\itemx{\errmessage{@itemx while not in a list environment}}
3517 % @table, @ftable, @vtable.
3519 \let\itemindex\gobble
3523 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3524 \tablecheck{ftable}%
3527 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3528 \tablecheck{vtable}%
3531 \ifnum \the\catcode`\^^M=\active
3533 \errmessage{This command won't work in this context; perhaps the problem is
3534 that we are \inenvironment\thisenv}%
3535 \def\next{\doignore{#1}}%
3542 \def\itemindicate{#1}%
3547 \makevalueexpandable
3548 \edef\temp{\noexpand\tablez #1\space\space\space}%
3552 \def\tablez #1 #2 #3 #4\endtablez{%
3554 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3555 \ifnum 0#2>0 \tableindent=#2\mil \fi
3556 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3557 \itemmax=\tableindent
3558 \advance \itemmax by -\itemmargin
3559 \advance \leftskip by \tableindent
3560 \exdentamount=\tableindent
3562 \parskip = \smallskipamount
3563 \ifdim \parskip=0pt \parskip=2pt \fi
3564 \let\item = \internalBitem
3565 \let\itemx = \internalBitemx
3567 \def\Etable{\endgraf\afterenvbreak}
3570 \let\Eitemize\Etable
3571 \let\Eenumerate\Etable
3573 % This is the counter used by @enumerate, which is really @itemize
3577 \envdef\itemize{\parsearg\doitemize}
3581 \itemmax=\itemindent
3582 \advance\itemmax by -\itemmargin
3583 \advance\leftskip by \itemindent
3584 \exdentamount=\itemindent
3586 \parskip=\smallskipamount
3587 \ifdim\parskip=0pt \parskip=2pt \fi
3589 % Try typesetting the item mark that if the document erroneously says
3590 % something like @itemize @samp (intending @table), there's an error
3591 % right away at the @itemize. It's not the best error message in the
3592 % world, but it's better than leaving it to the @item. This means if
3593 % the user wants an empty mark, they have to say @w{} not just @w.
3594 \def\itemcontents{#1}%
3595 \setbox0 = \hbox{\itemcontents}%
3597 % @itemize with no arg is equivalent to @itemize @bullet.
3598 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3600 \let\item=\itemizeitem
3603 % Definition of @item while inside @itemize and @enumerate.
3606 \advance\itemno by 1 % for enumerations
3607 {\let\par=\endgraf \smallbreak}% reasonable place to break
3609 % If the document has an @itemize directly after a section title, a
3610 % \nobreak will be last on the list, and \sectionheading will have
3611 % done a \vskip-\parskip. In that case, we don't want to zero
3612 % parskip, or the item text will crash with the heading. On the
3613 % other hand, when there is normal text preceding the item (as there
3614 % usually is), we do want to zero parskip, or there would be too much
3615 % space. In that case, we won't have a \nobreak before. At least
3616 % that's the theory.
3617 \ifnum\lastpenalty<10000 \parskip=0in \fi
3619 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3621 \vadjust{\penalty 1200}}% not good to break after first line of item.
3625 % \splitoff TOKENS\endmark defines \first to be the first token in
3626 % TOKENS, and \rest to be the remainder.
3628 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3630 % Allow an optional argument of an uppercase letter, lowercase letter,
3631 % or number, to specify the first label in the enumerated list. No
3632 % argument is the same as `1'.
3634 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3635 \def\enumeratey #1 #2\endenumeratey{%
3636 % If we were given no argument, pretend we were given `1'.
3638 \ifx\thearg\empty \def\thearg{1}\fi
3640 % Detect if the argument is a single token. If so, it might be a
3641 % letter. Otherwise, the only valid thing it can be is a number.
3642 % (We will always have one token, because of the test we just made.
3643 % This is a good thing, since \splitoff doesn't work given nothing at
3644 % all -- the first parameter is undelimited.)
3645 \expandafter\splitoff\thearg\endmark
3647 % Only one token in the argument. It could still be anything.
3648 % A ``lowercase letter'' is one whose \lccode is nonzero.
3649 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3650 % not equal to itself.
3651 % Otherwise, we assume it's a number.
3653 % We need the \relax at the end of the \ifnum lines to stop TeX from
3654 % continuing to look for a <number>.
3656 \ifnum\lccode\expandafter`\thearg=0\relax
3657 \numericenumerate % a number (we hope)
3660 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3661 \lowercaseenumerate % lowercase letter
3663 \uppercaseenumerate % uppercase letter
3667 % Multiple tokens in the argument. We hope it's a number.
3672 % An @enumerate whose labels are integers. The starting integer is
3675 \def\numericenumerate{%
3677 \startenumeration{\the\itemno}%
3680 % The starting (lowercase) letter is in \thearg.
3681 \def\lowercaseenumerate{%
3682 \itemno = \expandafter`\thearg
3684 % Be sure we're not beyond the end of the alphabet.
3686 \errmessage{No more lowercase letters in @enumerate; get a bigger
3693 % The starting (uppercase) letter is in \thearg.
3694 \def\uppercaseenumerate{%
3695 \itemno = \expandafter`\thearg
3697 % Be sure we're not beyond the end of the alphabet.
3699 \errmessage{No more uppercase letters in @enumerate; get a bigger
3706 % Call \doitemize, adding a period to the first argument and supplying the
3707 % common last two arguments. Also subtract one from the initial value in
3708 % \itemno, since @item increments \itemno.
3710 \def\startenumeration#1{%
3711 \advance\itemno by -1
3712 \doitemize{#1.}\flushcr
3715 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3718 \def\alphaenumerate{\enumerate{a}}
3719 \def\capsenumerate{\enumerate{A}}
3720 \def\Ealphaenumerate{\Eenumerate}
3721 \def\Ecapsenumerate{\Eenumerate}
3724 % @multitable macros
3725 % Amy Hendrickson, 8/18/94, 3/6/96
3727 % @multitable ... @end multitable will make as many columns as desired.
3728 % Contents of each column will wrap at width given in preamble. Width
3729 % can be specified either with sample text given in a template line,
3730 % or in percent of \hsize, the current width of text on page.
3732 % Table can continue over pages but will only break between lines.
3736 % Either define widths of columns in terms of percent of \hsize:
3737 % @multitable @columnfractions .25 .3 .45
3740 % Numbers following @columnfractions are the percent of the total
3741 % current hsize to be used for each column. You may use as many
3742 % columns as desired.
3745 % Or use a template:
3746 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3748 % using the widest term desired in each column.
3750 % Each new table line starts with @item, each subsequent new column
3751 % starts with @tab. Empty columns may be produced by supplying @tab's
3752 % with nothing between them for as many times as empty columns are needed,
3753 % ie, @tab@tab@tab will produce two empty columns.
3755 % @item, @tab do not need to be on their own lines, but it will not hurt
3758 % Sample multitable:
3760 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3761 % @item first col stuff @tab second col stuff @tab third col
3768 % @item first col stuff @tab second col stuff
3769 % @tab Many paragraphs of text may be used in any column.
3771 % They will wrap at the width determined by the template.
3772 % @item@tab@tab This will be in third column.
3775 % Default dimensions may be reset by user.
3776 % @multitableparskip is vertical space between paragraphs in table.
3777 % @multitableparindent is paragraph indent in table.
3778 % @multitablecolmargin is horizontal space to be left between columns.
3779 % @multitablelinespace is space to leave between table items, baseline
3781 % 0pt means it depends on current normal line spacing.
3783 \newskip\multitableparskip
3784 \newskip\multitableparindent
3785 \newdimen\multitablecolspace
3786 \newskip\multitablelinespace
3787 \multitableparskip=0pt
3788 \multitableparindent=6pt
3789 \multitablecolspace=12pt
3790 \multitablelinespace=0pt
3792 % Macros used to set up halign preamble:
3794 \let\endsetuptable\relax
3795 \def\xendsetuptable{\endsetuptable}
3796 \let\columnfractions\relax
3797 \def\xcolumnfractions{\columnfractions}
3800 % #1 is the @columnfraction, usually a decimal number like .5, but might
3801 % be just 1. We just use it, whatever it is.
3803 \def\pickupwholefraction#1 {%
3804 \global\advance\colcount by 1
3805 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3812 \ifx\firstarg\xendsetuptable
3815 \ifx\firstarg\xcolumnfractions
3816 \global\setpercenttrue
3819 \let\go\pickupwholefraction
3821 \global\advance\colcount by 1
3822 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3823 % separator; typically that is always in the input, anyway.
3824 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3827 \ifx\go\pickupwholefraction
3828 % Put the argument back for the \pickupwholefraction call, so
3829 % we'll always have a period there to be parsed.
3830 \def\go{\pickupwholefraction#1}%
3832 \let\go = \setuptable
3838 % multitable-only commands.
3840 % @headitem starts a heading row, which we typeset in bold.
3841 % Assignments have to be global since we are inside the implicit group
3842 % of an alignment entry. \everycr resets \everytab so we don't have to
3843 % undo it ourselves.
3844 \def\headitemfont{\b}% for people to use in the template row; not changeable
3846 \checkenv\multitable
3848 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3849 \the\everytab % for the first item
3852 % A \tab used to include \hskip1sp. But then the space in a template
3853 % line is not enough. That is bad. So let's go back to just `&' until
3854 % we again encounter the problem the 1sp was intended to solve.
3855 % --karl, nathan@acm.org, 20apr99.
3856 \def\tab{\checkenv\multitable &\the\everytab}%
3858 % @multitable ... @end multitable definitions:
3860 \newtoks\everytab % insert after every tab.
3862 \envdef\multitable{%
3866 % @item within a multitable starts a normal row.
3867 % We use \def instead of \let so that if one of the multitable entries
3868 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3869 % \endtemplate) expanding \doitemize.
3874 \setmultitablespacing
3875 \parskip=\multitableparskip
3876 \parindent=\multitableparindent
3882 \global\everytab={}%
3883 \global\colcount=0 % Reset the column counter.
3884 % Check for saved footnotes, etc.
3886 % Keeps underfull box messages off when table breaks over pages.
3888 % Maybe so, but it also creates really weird page breaks when the
3889 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3890 % problem manifests itself, so it can be fixed for real --karl.
3894 \parsearg\domultitable
3896 \def\domultitable#1{%
3897 % To parse everything between @multitable and @item:
3898 \setuptable#1 \endsetuptable
3900 % This preamble sets up a generic column definition, which will
3901 % be used as many times as user calls for columns.
3902 % \vtop will set a single line and will also let text wrap and
3903 % continue for many paragraphs if desired.
3905 \global\advance\colcount by 1
3908 % Use the current \colcount to find the correct column width:
3909 \hsize=\expandafter\csname col\the\colcount\endcsname
3911 % In order to keep entries from bumping into each other
3912 % we will add a \leftskip of \multitablecolspace to all columns after
3915 % If a template has been used, we will add \multitablecolspace
3916 % to the width of each template entry.
3918 % If the user has set preamble in terms of percent of \hsize we will
3919 % use that dimension as the width of the column, and the \leftskip
3920 % will keep entries from bumping into each other. Table will start at
3921 % left margin and final column will justify at right margin.
3923 % Make sure we don't inherit \rightskip from the outer environment.
3926 % The first column will be indented with the surrounding text.
3927 \advance\hsize by\leftskip
3930 % If user has not set preamble in terms of percent of \hsize
3931 % we will advance \hsize by \multitablecolspace.
3932 \advance\hsize by \multitablecolspace
3934 % In either case we will make \leftskip=\multitablecolspace:
3935 \leftskip=\multitablecolspace
3937 % Ignoring space at the beginning and end avoids an occasional spurious
3938 % blank line, when TeX decides to break the line at the space before the
3939 % box from the multistrut, so the strut ends up on a line by itself.
3941 % @multitable @columnfractions .11 .89
3943 % @tab Legal holiday which is valid in major parts of the whole country.
3944 % Is automatically provided with highlighting sequences respectively
3945 % marking characters.
3946 \noindent\ignorespaces##\unskip\multistrut
3951 \egroup % end the \halign
3952 \global\setpercentfalse
3955 \def\setmultitablespacing{%
3956 \def\multistrut{\strut}% just use the standard line spacing
3958 % Compute \multitablelinespace (if not defined by user) for use in
3959 % \multitableparskip calculation. We used define \multistrut based on
3960 % this, but (ironically) that caused the spacing to be off.
3961 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3962 \ifdim\multitablelinespace=0pt
3963 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3964 \global\advance\multitablelinespace by-\ht0
3966 % Test to see if parskip is larger than space between lines of
3967 % table. If not, do nothing.
3968 % If so, set to same dimension as multitablelinespace.
3969 \ifdim\multitableparskip>\multitablelinespace
3970 \global\multitableparskip=\multitablelinespace
3971 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3972 % than skip between lines in the table.
3974 \ifdim\multitableparskip=0pt
3975 \global\multitableparskip=\multitablelinespace
3976 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3977 % than skip between lines in the table.
3981 \message{conditionals,}
3983 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3984 % @ifnotxml always succeed. They currently do nothing; we don't
3985 % attempt to check whether the conditionals are properly nested. But we
3986 % have to remember that they are conditionals, so that @end doesn't
3987 % attempt to close an environment group.
3990 \expandafter\let\csname #1\endcsname = \relax
3991 \expandafter\let\csname iscond.#1\endcsname = 1
3994 \makecond{ifnotdocbook}
3995 \makecond{ifnothtml}
3996 \makecond{ifnotinfo}
3997 \makecond{ifnotplaintext}
4000 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4002 \def\direntry{\doignore{direntry}}
4003 \def\documentdescription{\doignore{documentdescription}}
4004 \def\docbook{\doignore{docbook}}
4005 \def\html{\doignore{html}}
4006 \def\ifdocbook{\doignore{ifdocbook}}
4007 \def\ifhtml{\doignore{ifhtml}}
4008 \def\ifinfo{\doignore{ifinfo}}
4009 \def\ifnottex{\doignore{ifnottex}}
4010 \def\ifplaintext{\doignore{ifplaintext}}
4011 \def\ifxml{\doignore{ifxml}}
4012 \def\ignore{\doignore{ignore}}
4013 \def\menu{\doignore{menu}}
4014 \def\xml{\doignore{xml}}
4016 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4018 % A count to remember the depth of nesting.
4019 \newcount\doignorecount
4021 \def\doignore#1{\begingroup
4022 % Scan in ``verbatim'' mode:
4024 \catcode`\@ = \other
4025 \catcode`\{ = \other
4026 \catcode`\} = \other
4028 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4031 % Count number of #1's that we've seen.
4034 % Swallow text until we reach the matching `@end #1'.
4038 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4041 \gdef\dodoignore#1{%
4042 % #1 contains the command name as a string, e.g., `ifinfo'.
4044 % Define a command to find the next `@end #1'.
4045 \long\def\doignoretext##1^^M@end #1{%
4046 \doignoretextyyy##1^^M@#1\_STOP_}%
4048 % And this command to find another #1 command, at the beginning of a
4049 % line. (Otherwise, we would consider a line `@c @ifset', for
4050 % example, to count as an @ifset for nesting.)
4051 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4053 % And now expand that command.
4058 \def\doignoreyyy#1{%
4060 \ifx\temp\empty % Nothing found.
4061 \let\next\doignoretextzzz
4062 \else % Found a nested condition, ...
4063 \advance\doignorecount by 1
4064 \let\next\doignoretextyyy % ..., look for another.
4065 % If we're here, #1 ends with ^^M\ifinfo (for example).
4067 \next #1% the token \_STOP_ is present just after this macro.
4070 % We have to swallow the remaining "\_STOP_".
4072 \def\doignoretextzzz#1{%
4073 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4074 \let\next\enddoignore
4075 \else % Still inside a nested condition.
4076 \advance\doignorecount by -1
4077 \let\next\doignoretext % Look for the next @end.
4082 % Finish off ignored text.
4084 % Ignore anything after the last `@end #1'; this matters in verbatim
4085 % environments, where otherwise the newline after an ignored conditional
4086 % would result in a blank line in the output.
4087 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4091 % @set VAR sets the variable VAR to an empty value.
4092 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4094 % Since we want to separate VAR from REST-OF-LINE (which might be
4095 % empty), we can't just use \parsearg; we have to insert a space of our
4096 % own to delimit the rest of the line, and then take it out again if we
4098 % We rely on the fact that \parsearg sets \catcode`\ =10.
4100 \parseargdef\set{\setyyy#1 \endsetyyy}
4101 \def\setyyy#1 #2\endsetyyy{%
4103 \makevalueexpandable
4105 \edef\next{\gdef\makecsname{SET#1}}%
4113 % Remove the trailing space \setxxx inserted.
4114 \def\setzzz#1 \endsetzzz{\next{#1}}
4116 % @clear VAR clears (i.e., unsets) the variable VAR.
4118 \parseargdef\clear{%
4120 \makevalueexpandable
4121 \global\expandafter\let\csname SET#1\endcsname=\relax
4125 % @value{foo} gets the text saved in variable foo.
4126 \def\value{\begingroup\makevalueexpandable\valuexxx}
4127 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4129 \catcode`\- = \active \catcode`\_ = \active
4131 \gdef\makevalueexpandable{%
4132 \let\value = \expandablevalue
4133 % We don't want these characters active, ...
4134 \catcode`\-=\other \catcode`\_=\other
4135 % ..., but we might end up with active ones in the argument if
4136 % we're called from @code, as @code{@value{foo-bar_}}, though.
4137 % So \let them to their normal equivalents.
4138 \let-\realdash \let_\normalunderscore
4142 % We have this subroutine so that we can handle at least some @value's
4143 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4144 % The command has to be fully expandable (if the variable is set), since
4145 % the result winds up in the index file. This means that if the
4146 % variable's value contains other Texinfo commands, it's almost certain
4147 % it will fail (although perhaps we could fix that with sufficient work
4148 % to do a one-level expansion on the result, instead of complete).
4150 \def\expandablevalue#1{%
4151 \expandafter\ifx\csname SET#1\endcsname\relax
4152 {[No value for ``#1'']}%
4153 \message{Variable `#1', used in @value, is not set.}%
4155 \csname SET#1\endcsname
4159 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4162 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4165 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4168 \makevalueexpandable
4170 \expandafter\ifx\csname SET#2\endcsname\relax
4171 #1% If not set, redefine \next.
4176 \def\ifsetfail{\doignore{ifset}}
4178 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4179 % defined with @set, or has been undefined with @clear.
4181 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4182 % above code: if the variable is not set, do nothing, if it is set,
4183 % then redefine \next to \ifclearfail.
4186 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4187 \def\ifclearfail{\doignore{ifclear}}
4189 % @dircategory CATEGORY -- specify a category of the dir file
4190 % which this file should belong to. Ignore this in TeX.
4191 \let\dircategory=\comment
4193 % @defininfoenclose.
4194 \let\definfoenclose=\comment
4198 % Index generation facilities
4200 % Define \newwrite to be identical to plain tex's \newwrite
4201 % except not \outer, so it can be used within macros and \if's.
4202 \edef\newwrite{\makecsname{ptexnewwrite}}
4204 % \newindex {foo} defines an index named foo.
4205 % It automatically defines \fooindex such that
4206 % \fooindex ...rest of line... puts an entry in the index foo.
4207 % It also defines \fooindfile to be the number of the output channel for
4208 % the file that accumulates this index. The file's extension is foo.
4209 % The name of an index should be no more than 2 characters long
4210 % for the sake of vms.
4214 \expandafter\newwrite \csname#1indfile\endcsname
4215 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4217 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4218 \noexpand\doindex{#1}}
4221 % @defindex foo == \newindex{foo}
4223 \def\defindex{\parsearg\newindex}
4225 % Define @defcodeindex, like @defindex except put all entries in @code.
4227 \def\defcodeindex{\parsearg\newcodeindex}
4229 \def\newcodeindex#1{%
4231 \expandafter\newwrite \csname#1indfile\endcsname
4232 \openout \csname#1indfile\endcsname \jobname.#1
4234 \expandafter\xdef\csname#1index\endcsname{%
4235 \noexpand\docodeindex{#1}}%
4239 % @synindex foo bar makes index foo feed into index bar.
4240 % Do this instead of @defindex foo if you don't want it as a separate index.
4242 % @syncodeindex foo bar similar, but put all entries made for index foo
4245 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4246 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4248 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4249 % #3 the target index (bar).
4250 \def\dosynindex#1#2#3{%
4251 % Only do \closeout if we haven't already done it, else we'll end up
4252 % closing the target index.
4253 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4254 % The \closeout helps reduce unnecessary open files; the limit on the
4255 % Acorn RISC OS is a mere 16 files.
4256 \expandafter\closeout\csname#2indfile\endcsname
4257 \expandafter\let\csname donesynindex#2\endcsname = 1
4259 % redefine \fooindfile:
4260 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4261 \expandafter\let\csname#2indfile\endcsname=\temp
4262 % redefine \fooindex:
4263 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4266 % Define \doindex, the driver for all \fooindex macros.
4267 % Argument #1 is generated by the calling \fooindex macro,
4268 % and it is "foo", the name of the index.
4270 % \doindex just uses \parsearg; it calls \doind for the actual work.
4271 % This is because \doind is more useful to call from other macros.
4273 % There is also \dosubind {index}{topic}{subtopic}
4274 % which makes an entry in a two-level index such as the operation index.
4276 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4277 \def\singleindexer #1{\doind{\indexname}{#1}}
4279 % like the previous two, but they put @code around the argument.
4280 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4281 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4283 % Take care of Texinfo commands that can appear in an index entry.
4284 % Since there are some commands we want to expand, and others we don't,
4285 % we have to laboriously prevent expansion for those that we don't.
4288 \escapechar = `\\ % use backslash in output files.
4289 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4290 \def\ {\realbackslash\space }%
4292 % Need these unexpandable (because we define \tt as a dummy)
4293 % definitions when @{ or @} appear in index entry text. Also, more
4294 % complicated, when \tex is in effect and \{ is a \delimiter again.
4295 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4296 % braces and backslashes are used only as delimiters. Perhaps we
4297 % should define @lbrace and @rbrace commands a la @comma.
4298 \def\{{{\tt\char123}}%
4299 \def\}{{\tt\char125}}%
4301 % I don't entirely understand this, but when an index entry is
4302 % generated from a macro call, the \endinput which \scanmacro inserts
4303 % causes processing to be prematurely terminated. This is,
4304 % apparently, because \indexsorttmp is fully expanded, and \endinput
4305 % is an expandable command. The redefinition below makes \endinput
4306 % disappear altogether for that purpose -- although logging shows that
4307 % processing continues to some further point. On the other hand, it
4308 % seems \endinput does not hurt in the printed index arg, since that
4309 % is still getting written without apparent harm.
4311 % Sample source (mac-idx3.tex, reported by Graham Percival to
4312 % help-texinfo, 22may06):
4313 % @macro funindex {WORD}
4317 % @funindex commtest
4319 % The above is not enough to reproduce the bug, but it gives the flavor.
4321 % Sample whatsit resulting:
4322 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4325 \let\endinput = \empty
4327 % Do the redefinitions.
4331 % For the aux and toc files, @ is the escape character. So we want to
4332 % redefine everything using @ as the escape character (instead of
4333 % \realbackslash, still used for index files). When everything uses @,
4334 % this will be simpler.
4339 \let\{ = \lbraceatcmd
4340 \let\} = \rbraceatcmd
4342 % Do the redefinitions.
4347 % Called from \indexdummies and \atdummies.
4349 \def\commondummies{%
4351 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4352 % preventing its expansion. This is used only for control words,
4353 % not control letters, because the \space would be incorrect for
4354 % control characters, but is needed to separate the control word
4355 % from whatever follows.
4357 % For control letters, we have \definedummyletter, which omits the
4360 % These can be used both for control words that take an argument and
4361 % those that do not. If it is followed by {arg} in the input, then
4362 % that will dutifully get written to the index (or wherever).
4364 \def\definedummyword ##1{\def##1{\string##1\space}}%
4365 \def\definedummyletter##1{\def##1{\string##1}}%
4366 \let\definedummyaccent\definedummyletter
4368 \commondummiesnofonts
4370 \definedummyletter\_%
4371 \definedummyletter\-%
4373 % Non-English letters.
4384 \definedummyword\exclamdown
4388 \definedummyword\ordf
4389 \definedummyword\ordm
4390 \definedummyword\questiondown
4394 % Although these internal commands shouldn't show up, sometimes they do.
4396 \definedummyword\gtr
4397 \definedummyword\hat
4398 \definedummyword\less
4401 \definedummyword\tclose
4404 \definedummyword\LaTeX
4405 \definedummyword\TeX
4407 % Assorted special characters.
4408 \definedummyword\arrow
4409 \definedummyword\bullet
4410 \definedummyword\comma
4411 \definedummyword\copyright
4412 \definedummyword\registeredsymbol
4413 \definedummyword\dots
4414 \definedummyword\enddots
4415 \definedummyword\entrybreak
4416 \definedummyword\equiv
4417 \definedummyword\error
4418 \definedummyword\euro
4419 \definedummyword\expansion
4420 \definedummyword\geq
4421 \definedummyword\guillemetleft
4422 \definedummyword\guillemetright
4423 \definedummyword\guilsinglleft
4424 \definedummyword\guilsinglright
4425 \definedummyword\leq
4426 \definedummyword\minus
4427 \definedummyword\ogonek
4428 \definedummyword\pounds
4429 \definedummyword\point
4430 \definedummyword\print
4431 \definedummyword\quotedblbase
4432 \definedummyword\quotedblleft
4433 \definedummyword\quotedblright
4434 \definedummyword\quoteleft
4435 \definedummyword\quoteright
4436 \definedummyword\quotesinglbase
4437 \definedummyword\result
4438 \definedummyword\textdegree
4440 % We want to disable all macros so that they are not expanded by \write.
4443 \normalturnoffactive
4445 % Handle some cases of @value -- where it does not contain any
4446 % (non-fully-expandable) commands.
4447 \makevalueexpandable
4450 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4452 \def\commondummiesnofonts{%
4453 % Control letters and accents.
4454 \definedummyletter\!%
4455 \definedummyaccent\"%
4456 \definedummyaccent\'%
4457 \definedummyletter\*%
4458 \definedummyaccent\,%
4459 \definedummyletter\.%
4460 \definedummyletter\/%
4461 \definedummyletter\:%
4462 \definedummyaccent\=%
4463 \definedummyletter\?%
4464 \definedummyaccent\^%
4465 \definedummyaccent\`%
4466 \definedummyaccent\~%
4470 \definedummyword\dotaccent
4471 \definedummyword\ogonek
4472 \definedummyword\ringaccent
4473 \definedummyword\tieaccent
4474 \definedummyword\ubaraccent
4475 \definedummyword\udotaccent
4476 \definedummyword\dotless
4478 % Texinfo font commands.
4482 \definedummyword\sansserif
4484 \definedummyword\slanted
4487 % Commands that take arguments.
4488 \definedummyword\acronym
4489 \definedummyword\cite
4490 \definedummyword\code
4491 \definedummyword\command
4492 \definedummyword\dfn
4493 \definedummyword\dmn
4494 \definedummyword\email
4495 \definedummyword\emph
4496 \definedummyword\env
4497 \definedummyword\file
4498 \definedummyword\indicateurl
4499 \definedummyword\kbd
4500 \definedummyword\key
4501 \definedummyword\math
4502 \definedummyword\option
4503 \definedummyword\pxref
4504 \definedummyword\ref
4505 \definedummyword\samp
4506 \definedummyword\strong
4507 \definedummyword\tie
4508 \definedummyword\uref
4509 \definedummyword\url
4510 \definedummyword\var
4511 \definedummyword\verb
4513 \definedummyword\xref
4516 % \indexnofonts is used when outputting the strings to sort the index
4517 % by, and when constructing control sequence names. It eliminates all
4518 % control sequences and just writes whatever the best ASCII sort string
4519 % would be for a given command (usually its argument).
4522 % Accent commands should become @asis.
4523 \def\definedummyaccent##1{\let##1\asis}%
4524 % We can just ignore other control letters.
4525 \def\definedummyletter##1{\let##1\empty}%
4526 % All control words become @asis by default; overrides below.
4527 \let\definedummyword\definedummyaccent
4529 \commondummiesnofonts
4531 % Don't no-op \tt, since it isn't a user-level command
4532 % and is used in the definitions of the active chars like <, >, |, etc.
4533 % Likewise with the other plain tex font commands.
4538 \def\_{\normalunderscore}%
4539 \def\-{}% @- shouldn't affect sorting
4541 % Unfortunately, texindex is not prepared to handle braces in the
4542 % content at all. So for index sorting, we map @{ and @} to strings
4543 % starting with |, since that ASCII character is between ASCII { and }.
4547 % Non-English letters.
4564 \def\questiondown{?}%
4571 % Assorted special characters.
4572 % (The following {} will end up in the sort string, but that's ok.)
4574 \def\bullet{bullet}%
4576 \def\copyright{copyright}%
4582 \def\expansion{==>}%
4584 \def\guillemetleft{<<}%
4585 \def\guillemetright{>>}%
4586 \def\guilsinglleft{<}%
4587 \def\guilsinglright{>}%
4591 \def\pounds{pounds}%
4593 \def\quotedblbase{"}%
4594 \def\quotedblleft{"}%
4595 \def\quotedblright{"}%
4598 \def\quotesinglbase{,}%
4599 \def\registeredsymbol{R}%
4603 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4604 \else \indexlquoteignore \fi
4606 % We need to get rid of all macros, leaving only the arguments (if present).
4607 % Of course this is not nearly correct, but it is the best we can do for now.
4608 % makeinfo does not expand macros in the argument to @deffn, which ends up
4609 % writing an index entry, and texindex isn't prepared for an index sort entry
4610 % that starts with \.
4612 % Since macro invocations are followed by braces, we can just redefine them
4613 % to take a single TeX argument. The case of a macro invocation that
4614 % goes to end-of-line is not handled.
4619 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4620 % ignore left quotes in the sort term.
4621 {\catcode`\`=\active
4622 \gdef\indexlquoteignore{\let`=\empty}}
4624 \let\indexbackslash=0 %overridden during \printindex.
4625 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4627 % Most index entries go through here, but \dosubind is the general case.
4628 % #1 is the index name, #2 is the entry text.
4629 \def\doind#1#2{\dosubind{#1}{#2}{}}
4631 % Workhorse for all \fooindexes.
4632 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4633 % empty if called from \doind, as we usually are (the main exception
4634 % is with most defuns, which call us directly).
4636 \def\dosubind#1#2#3{%
4639 % Store the main index entry text (including the third arg).
4641 % If third arg is present, precede it with a space.
4643 \ifx\thirdarg\empty \else
4644 \toks0 = \expandafter{\the\toks0 \space #3}%
4647 \edef\writeto{\csname#1indfile\endcsname}%
4649 \safewhatsit\dosubindwrite
4654 % Write the entry in \toks0 to the index file:
4656 \def\dosubindwrite{%
4657 % Put the index entry in the margin if desired.
4658 \ifx\SETmarginindex\relax\else
4659 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4662 % Remember, we are within a group.
4663 \indexdummies % Must do this here, since \bf, etc expand at this stage
4664 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4665 % so it will be output as is; and it will print as backslash.
4667 % Process the index entry with all font commands turned off, to
4668 % get the string to sort by.
4670 \edef\temp{\the\toks0}% need full expansion
4671 \xdef\indexsorttmp{\temp}%
4674 % Set up the complete index entry, with both the sort key and
4675 % the original text, including any font commands. We write
4676 % three arguments to \entry to the .?? file (four in the
4677 % subentry case), texindex reduces to two when writing the .??s
4681 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4686 % Take care of unwanted page breaks/skips around a whatsit:
4688 % If a skip is the last thing on the list now, preserve it
4689 % by backing up by \lastskip, doing the \write, then inserting
4690 % the skip again. Otherwise, the whatsit generated by the
4691 % \write or \pdfdest will make \lastskip zero. The result is that
4692 % sequences like this:
4696 % will have extra space inserted, because the \medbreak in the
4697 % start of the @defun won't see the skip inserted by the @end of
4698 % the previous defun.
4700 % But don't do any of this if we're not in vertical mode. We
4701 % don't want to do a \vskip and prematurely end a paragraph.
4703 % Avoid page breaks due to these extra skips, too.
4705 % But wait, there is a catch there:
4706 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4707 % sufficient for this purpose, as it ignores stretch and shrink parts
4708 % of the skip. The only way seems to be to check the textual
4709 % representation of the skip.
4711 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4712 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4714 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4716 \newskip\whatsitskip
4717 \newcount\whatsitpenalty
4721 \def\safewhatsit#1{%
4725 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4726 \whatsitskip = \lastskip
4727 \edef\lastskipmacro{\the\lastskip}%
4728 \whatsitpenalty = \lastpenalty
4730 % If \lastskip is nonzero, that means the last item was a
4731 % skip. And since a skip is discardable, that means this
4732 % -\whatsitskip glue we're inserting is preceded by a
4733 % non-discardable item, therefore it is not a potential
4734 % breakpoint, therefore no \nobreak needed.
4735 \ifx\lastskipmacro\zeroskipmacro
4742 \ifx\lastskipmacro\zeroskipmacro
4743 % If \lastskip was zero, perhaps the last item was a penalty, and
4744 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4745 % to re-insert the same penalty (values >10000 are used for various
4746 % signals); since we just inserted a non-discardable item, any
4747 % following glue (such as a \parskip) would be a breakpoint. For example:
4749 % @deffn deffn-whatever
4750 % @vindex index-whatever
4752 % would allow a break between the index-whatever whatsit
4753 % and the "Description." paragraph.
4754 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4756 % On the other hand, if we had a nonzero \lastskip,
4757 % this make-up glue would be preceded by a non-discardable item
4758 % (the whatsit from the \write), so we must insert a \nobreak.
4759 \nobreak\vskip\whatsitskip
4764 % The index entry written in the file actually looks like
4765 % \entry {sortstring}{page}{topic}
4767 % \entry {sortstring}{page}{topic}{subtopic}
4768 % The texindex program reads in these files and writes files
4769 % containing these kinds of lines:
4771 % before the first topic whose initial is c
4772 % \entry {topic}{pagelist}
4773 % for a topic that is used without subtopics
4775 % for the beginning of a topic that is used with subtopics
4776 % \secondary {subtopic}{pagelist}
4777 % for each subtopic.
4779 % Define the user-accessible indexing commands
4780 % @findex, @vindex, @kindex, @cindex.
4782 \def\findex {\fnindex}
4783 \def\kindex {\kyindex}
4784 \def\cindex {\cpindex}
4785 \def\vindex {\vrindex}
4786 \def\tindex {\tpindex}
4787 \def\pindex {\pgindex}
4789 \def\cindexsub {\begingroup\obeylines\cindexsub}
4791 \gdef\cindexsub "#1" #2^^M{\endgroup %
4792 \dosubind{cp}{#2}{#1}}}
4794 % Define the macros used in formatting output of the sorted index material.
4796 % @printindex causes a particular index (the ??s file) to get printed.
4797 % It does not print any chapter heading (usually an @unnumbered).
4799 \parseargdef\printindex{\begingroup
4800 \dobreak \chapheadingskip{10000}%
4805 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4807 % See if the index file exists and is nonempty.
4808 % Change catcode of @ here so that if the index file contains
4810 % as its first line, TeX doesn't complain about mismatched braces
4811 % (because it thinks @} is a control sequence).
4813 \openin 1 \jobname.#1s
4815 % \enddoublecolumns gets confused if there is no text in the index,
4816 % and it loses the chapter title and the aux file entries for the
4817 % index. The easiest way to prevent this problem is to make sure
4818 % there is some text.
4819 \putwordIndexNonexistent
4822 % If the index file exists but is empty, then \openin leaves \ifeof
4823 % false. We have to make TeX try to read something from the file, so
4824 % it can discover if there is anything in it.
4827 \putwordIndexIsEmpty
4829 % Index files are almost Texinfo source, but we use \ as the escape
4830 % character. It would be better to use @, but that's too big a change
4831 % to make right now.
4832 \def\indexbackslash{\backslashcurfont}%
4843 % These macros are used by the sorted index file itself.
4844 % Change them to control the appearance of the index.
4847 % Some minor font changes for the special characters.
4848 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4850 % Remove any glue we may have, we'll be inserting our own.
4853 % We like breaks before the index initials, so insert a bonus.
4855 \vskip 0pt plus 3\baselineskip
4857 \vskip 0pt plus -3\baselineskip
4859 % Typeset the initial. Making this add up to a whole number of
4860 % baselineskips increases the chance of the dots lining up from column
4861 % to column. It still won't often be perfect, because of the stretch
4862 % we need before each entry, but it's better.
4864 % No shrink because it confuses \balancecolumns.
4865 \vskip 1.67\baselineskip plus .5\baselineskip
4866 \leftline{\secbf #1}%
4867 % Do our best not to break after the initial.
4869 \vskip .33\baselineskip plus .1\baselineskip
4872 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4873 % then page number (#2) flushed to the right margin. It is used for index
4874 % and table of contents entries. The paragraph is indented by \leftskip.
4876 % A straightforward implementation would start like this:
4877 % \def\entry#1#2{...
4878 % But this freezes the catcodes in the argument, and can cause problems to
4879 % @code, which sets - active. This problem was fixed by a kludge---
4880 % ``-'' was active throughout whole index, but this isn't really right.
4881 % The right solution is to prevent \entry from swallowing the whole text.
4886 % Start a new paragraph if necessary, so our assignments below can't
4887 % affect previous text.
4890 % Do not fill out the last line with white space.
4893 % No extra space above this paragraph.
4896 % Do not prefer a separate line ending with a hyphen to fewer lines.
4897 \finalhyphendemerits = 0
4899 % \hangindent is only relevant when the entry text and page number
4900 % don't both fit on one line. In that case, bob suggests starting the
4901 % dots pretty far over on the line. Unfortunately, a large
4902 % indentation looks wrong when the entry text itself is broken across
4903 % lines. So we use a small indentation and put up with long leaders.
4905 % \hangafter is reset to 1 (which is the value we want) at the start
4906 % of each paragraph, so we need not do anything with that.
4909 % When the entry text needs to be broken, just fill out the first line
4911 \rightskip = 0pt plus1fil
4913 % A bit of stretch before each entry for the benefit of balancing
4917 % When reading the text of entry, convert explicit line breaks
4918 % from @* into spaces. The user might give these in long section
4919 % titles, for instance.
4920 \def\*{\unskip\space\ignorespaces}%
4921 \def\entrybreak{\hfil\break}%
4923 % Swallow the left brace of the text (first parameter):
4924 \afterassignment\doentry
4927 \def\entrybreak{\unskip\space\ignorespaces}%
4929 \bgroup % Instead of the swallowed brace.
4931 \aftergroup\finishentry
4932 % And now comes the text of the entry.
4934 \def\finishentry#1{%
4935 % #1 is the page number.
4937 % The following is kludged to not output a line of dots in the index if
4938 % there are no page numbers. The next person who breaks this will be
4939 % cursed by a Unix daemon.
4940 \setbox\boxA = \hbox{#1}%
4941 \ifdim\wd\boxA = 0pt
4945 % If we must, put the page number on a line of its own, and fill out
4946 % this line with blank space. (The \hfil is overwhelmed with the
4947 % fill leaders glue in \indexdotfill if the page number does fit.)
4949 \null\nobreak\indexdotfill % Have leaders before the page number.
4951 % The `\ ' here is removed by the implicit \unskip that TeX does as
4952 % part of (the primitive) \par. Without it, a spurious underfull
4965 % Like plain.tex's \dotfill, except uses up at least 1 em.
4966 \def\indexdotfill{\cleaders
4967 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4969 \def\primary #1{\line{#1\hfil}}
4971 \newskip\secondaryindent \secondaryindent=0.5cm
4972 \def\secondary#1#2{{%
4977 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4979 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4986 % Define two-column mode, which we use to typeset indexes.
4987 % Adapted from the TeXbook, page 416, which is to say,
4988 % the manmac.tex format used to print the TeXbook itself.
4992 \newdimen\doublecolumnhsize
4994 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4995 % Grab any single-column material above us.
4998 % Here is a possibility not foreseen in manmac: if we accumulate a
4999 % whole lot of material, we might end up calling this \output
5000 % routine twice in a row (see the doublecol-lose test, which is
5001 % essentially a couple of indexes with @setchapternewpage off). In
5002 % that case we just ship out what is in \partialpage with the normal
5003 % output routine. Generally, \partialpage will be empty when this
5004 % runs and this will be a no-op. See the indexspread.tex test case.
5005 \ifvoid\partialpage \else
5006 \onepageout{\pagecontents\partialpage}%
5009 \global\setbox\partialpage = \vbox{%
5010 % Unvbox the main output page.
5012 \kern-\topskip \kern\baselineskip
5015 \eject % run that output routine to set \partialpage
5017 % Use the double-column output routine for subsequent pages.
5018 \output = {\doublecolumnout}%
5020 % Change the page size parameters. We could do this once outside this
5021 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5022 % format, but then we repeat the same computation. Repeating a couple
5023 % of assignments once per index is clearly meaningless for the
5024 % execution time, so we may as well do it in one place.
5026 % First we halve the line length, less a little for the gutter between
5027 % the columns. We compute the gutter based on the line length, so it
5028 % changes automatically with the paper format. The magic constant
5029 % below is chosen so that the gutter has the same value (well, +-<1pt)
5030 % as it did when we hard-coded it.
5032 % We put the result in a separate register, \doublecolumhsize, so we
5033 % can restore it in \pagesofar, after \hsize itself has (potentially)
5036 \doublecolumnhsize = \hsize
5037 \advance\doublecolumnhsize by -.04154\hsize
5038 \divide\doublecolumnhsize by 2
5039 \hsize = \doublecolumnhsize
5041 % Double the \vsize as well. (We don't need a separate register here,
5042 % since nobody clobbers \vsize.)
5046 % The double-column output routine for all double-column pages except
5049 \def\doublecolumnout{%
5050 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5051 % Get the available space for the double columns -- the normal
5052 % (undoubled) page height minus any material left over from the
5056 \advance\dimen@ by -\ht\partialpage
5058 % box0 will be the left-hand column, box2 the right.
5059 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5060 \onepageout\pagesofar
5062 \penalty\outputpenalty
5065 % Re-output the contents of the output page -- any previous material,
5066 % followed by the two boxes we just split, in box0 and box2.
5070 \hsize = \doublecolumnhsize
5071 \wd0=\hsize \wd2=\hsize
5072 \hbox to\pagewidth{\box0\hfil\box2}%
5075 % All done with double columns.
5076 \def\enddoublecolumns{%
5077 % The following penalty ensures that the page builder is exercised
5078 % _before_ we change the output routine. This is necessary in the
5079 % following situation:
5081 % The last section of the index consists only of a single entry.
5082 % Before this section, \pagetotal is less than \pagegoal, so no
5083 % break occurs before the last section starts. However, the last
5084 % section, consisting of \initial and the single \entry, does not
5085 % fit on the page and has to be broken off. Without the following
5086 % penalty the page builder will not be exercised until \eject
5087 % below, and by that time we'll already have changed the output
5088 % routine to the \balancecolumns version, so the next-to-last
5089 % double-column page will be processed with \balancecolumns, which
5090 % is wrong: The two columns will go to the main vertical list, with
5091 % the broken-off section in the recent contributions. As soon as
5092 % the output routine finishes, TeX starts reconsidering the page
5093 % break. The two columns and the broken-off section both fit on the
5094 % page, because the two columns now take up only half of the page
5095 % goal. When TeX sees \eject from below which follows the final
5096 % section, it invokes the new output routine that we've set after
5097 % \balancecolumns below; \onepageout will try to fit the two columns
5098 % and the final section into the vbox of \pageheight (see
5099 % \pagebody), causing an overfull box.
5101 % Note that glue won't work here, because glue does not exercise the
5102 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5106 % Split the last of the double-column material. Leave it on the
5107 % current page, no automatic page break.
5110 % If we end up splitting too much material for the current page,
5111 % though, there will be another page break right after this \output
5112 % invocation ends. Having called \balancecolumns once, we do not
5113 % want to call it again. Therefore, reset \output to its normal
5114 % definition right away. (We hope \balancecolumns will never be
5115 % called on to balance too much material, but if it is, this makes
5116 % the output somewhat more palatable.)
5117 \global\output = {\onepageout{\pagecontents\PAGE}}%
5120 \endgroup % started in \begindoublecolumns
5122 % \pagegoal was set to the doubled \vsize above, since we restarted
5123 % the current page. We're now back to normal single-column
5124 % typesetting, so reset \pagegoal to the normal \vsize (after the
5125 % \endgroup where \vsize got restored).
5129 % Called at the end of the double column material.
5130 \def\balancecolumns{%
5131 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5133 \advance\dimen@ by \topskip
5134 \advance\dimen@ by-\baselineskip
5135 \divide\dimen@ by 2 % target to split to
5136 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5137 \splittopskip = \topskip
5138 % Loop until we get a decent breakpoint.
5142 \global\setbox3 = \copy0
5143 \global\setbox1 = \vsplit3 to \dimen@
5145 \global\advance\dimen@ by 1pt
5148 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5149 \setbox0=\vbox to\dimen@{\unvbox1}%
5150 \setbox2=\vbox to\dimen@{\unvbox3}%
5154 \catcode`\@ = \other
5157 \message{sectioning,}
5158 % Chapters, sections, etc.
5160 % Let's start with @part.
5161 \outer\parseargdef\part{\partzzz{#1}}
5165 \vskip.3\vsize % move it down on the page a bit
5167 \noindent \titlefonts\rmisbold #1\par % the text
5168 \let\lastnode=\empty % no node to associate with
5169 \writetocentry{part}{#1}{}% but put it in the toc
5170 \headingsoff % no headline or footline on the part page
5175 % \unnumberedno is an oxymoron. But we count the unnumbered
5176 % sections so that we can refer to them unambiguously in the pdf
5177 % outlines by their "section number". We avoid collisions with chapter
5178 % numbers by starting them at 10000. (If a document ever has 10000
5179 % chapters, we're in trouble anyway, I'm sure.)
5180 \newcount\unnumberedno \unnumberedno = 10000
5182 \newcount\secno \secno=0
5183 \newcount\subsecno \subsecno=0
5184 \newcount\subsubsecno \subsubsecno=0
5186 % This counter is funny since it counts through charcodes of letters A, B, ...
5187 \newcount\appendixno \appendixno = `\@
5189 % \def\appendixletter{\char\the\appendixno}
5190 % We do the following ugly conditional instead of the above simple
5191 % construct for the sake of pdftex, which needs the actual
5192 % letter in the expansion, not just typeset.
5194 \def\appendixletter{%
5195 \ifnum\appendixno=`A A%
5196 \else\ifnum\appendixno=`B B%
5197 \else\ifnum\appendixno=`C C%
5198 \else\ifnum\appendixno=`D D%
5199 \else\ifnum\appendixno=`E E%
5200 \else\ifnum\appendixno=`F F%
5201 \else\ifnum\appendixno=`G G%
5202 \else\ifnum\appendixno=`H H%
5203 \else\ifnum\appendixno=`I I%
5204 \else\ifnum\appendixno=`J J%
5205 \else\ifnum\appendixno=`K K%
5206 \else\ifnum\appendixno=`L L%
5207 \else\ifnum\appendixno=`M M%
5208 \else\ifnum\appendixno=`N N%
5209 \else\ifnum\appendixno=`O O%
5210 \else\ifnum\appendixno=`P P%
5211 \else\ifnum\appendixno=`Q Q%
5212 \else\ifnum\appendixno=`R R%
5213 \else\ifnum\appendixno=`S S%
5214 \else\ifnum\appendixno=`T T%
5215 \else\ifnum\appendixno=`U U%
5216 \else\ifnum\appendixno=`V V%
5217 \else\ifnum\appendixno=`W W%
5218 \else\ifnum\appendixno=`X X%
5219 \else\ifnum\appendixno=`Y Y%
5220 \else\ifnum\appendixno=`Z Z%
5221 % The \the is necessary, despite appearances, because \appendixletter is
5222 % expanded while writing the .toc file. \char\appendixno is not
5223 % expandable, thus it is written literally, thus all appendixes come out
5224 % with the same letter (or @) in the toc without it.
5225 \else\char\the\appendixno
5226 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5227 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5229 % Each @chapter defines these (using marks) as the number+name, number
5230 % and name of the chapter. Page headings and footings can use
5231 % these. @section does likewise.
5233 \def\thischapternum{}
5234 \def\thischaptername{}
5236 \def\thissectionnum{}
5237 \def\thissectionname{}
5239 \newcount\absseclevel % used to calculate proper heading level
5240 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5242 % @raisesections: treat @section as chapter, @subsection as section, etc.
5243 \def\raisesections{\global\advance\secbase by -1}
5244 \let\up=\raisesections % original BFox name
5246 % @lowersections: treat @chapter as section, @section as subsection, etc.
5247 \def\lowersections{\global\advance\secbase by 1}
5248 \let\down=\lowersections % original BFox name
5250 % we only have subsub.
5251 \chardef\maxseclevel = 3
5253 % A numbered section within an unnumbered changes to unnumbered too.
5254 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5255 \chardef\unnlevel = \maxseclevel
5257 % Trace whether the current chapter is an appendix or not:
5258 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5259 \def\chapheadtype{N}
5261 % Choose a heading macro
5262 % #1 is heading type
5263 % #2 is heading level
5264 % #3 is text for heading
5265 \def\genhead#1#2#3{%
5266 % Compute the abs. sec. level:
5268 \advance\absseclevel by \secbase
5269 % Make sure \absseclevel doesn't fall outside the range:
5270 \ifnum \absseclevel < 0
5273 \ifnum \absseclevel > 3
5280 \ifnum \absseclevel < \unnlevel
5281 \chardef\unnlevel = \absseclevel
5284 % Check for appendix sections:
5285 \ifnum \absseclevel = 0
5286 \edef\chapheadtype{\headtype}%
5288 \if \headtype A\if \chapheadtype N%
5289 \errmessage{@appendix... within a non-appendix chapter}%
5292 % Check for numbered within unnumbered:
5293 \ifnum \absseclevel > \unnlevel
5296 \chardef\unnlevel = 3
5299 % Now print the heading:
5303 \or \unnumberedseczzz{#3}%
5304 \or \unnumberedsubseczzz{#3}%
5305 \or \unnumberedsubsubseczzz{#3}%
5311 \or \appendixsectionzzz{#3}%
5312 \or \appendixsubseczzz{#3}%
5313 \or \appendixsubsubseczzz{#3}%
5319 \or \numberedsubseczzz{#3}%
5320 \or \numberedsubsubseczzz{#3}%
5324 \suppressfirstparagraphindent
5328 \def\numhead{\genhead N}
5329 \def\apphead{\genhead A}
5330 \def\unnmhead{\genhead U}
5332 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5333 % all lower-level sectioning counters to zero.
5335 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5336 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5337 \let\chaplevelprefix = \empty
5339 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5341 % section resetting is \global in case the chapter is in a group, such
5342 % as an @include file.
5343 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5344 \global\advance\chapno by 1
5347 \gdef\chaplevelprefix{\the\chapno.}%
5350 % \putwordChapter can contain complex things in translations.
5351 \toks0=\expandafter{\putwordChapter}%
5352 \message{\the\toks0 \space \the\chapno}%
5354 % Write the actual heading.
5355 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5357 % So @section and the like are numbered underneath this chapter.
5358 \global\let\section = \numberedsec
5359 \global\let\subsection = \numberedsubsec
5360 \global\let\subsubsection = \numberedsubsubsec
5363 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5365 \def\appendixzzz#1{%
5366 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5367 \global\advance\appendixno by 1
5368 \gdef\chaplevelprefix{\appendixletter.}%
5371 % \putwordAppendix can contain complex things in translations.
5372 \toks0=\expandafter{\putwordAppendix}%
5373 \message{\the\toks0 \space \appendixletter}%
5375 \chapmacro{#1}{Yappendix}{\appendixletter}%
5377 \global\let\section = \appendixsec
5378 \global\let\subsection = \appendixsubsec
5379 \global\let\subsubsection = \appendixsubsubsec
5382 % normally unnmhead0 calls unnumberedzzz:
5383 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5384 \def\unnumberedzzz#1{%
5385 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5386 \global\advance\unnumberedno by 1
5388 % Since an unnumbered has no number, no prefix for figures.
5389 \global\let\chaplevelprefix = \empty
5392 % This used to be simply \message{#1}, but TeX fully expands the
5393 % argument to \message. Therefore, if #1 contained @-commands, TeX
5394 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5395 % expanded @cite (which turns out to cause errors because \cite is meant
5396 % to be executed, not expanded).
5398 % Anyway, we don't want the fully-expanded definition of @cite to appear
5399 % as a result of the \message, we just want `@cite' itself. We use
5400 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5401 % simply yielding the contents of <toks register>. (We also do this for
5404 \message{(\the\toks0)}%
5406 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5408 \global\let\section = \unnumberedsec
5409 \global\let\subsection = \unnumberedsubsec
5410 \global\let\subsubsection = \unnumberedsubsubsec
5413 % @centerchap is like @unnumbered, but the heading is centered.
5414 \outer\parseargdef\centerchap{%
5415 % Well, we could do the following in a group, but that would break
5416 % an assumption that \chapmacro is called at the outermost level.
5417 % Thus we are safer this way: --kasal, 24feb04
5418 \let\centerparametersmaybe = \centerparameters
5420 \let\centerparametersmaybe = \relax
5423 % @top is like @unnumbered.
5428 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5430 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5431 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5434 % normally calls appendixsectionzzz:
5435 \outer\parseargdef\appendixsection{\apphead1{#1}}
5436 \def\appendixsectionzzz#1{%
5437 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5438 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5440 \let\appendixsec\appendixsection
5442 % normally calls unnumberedseczzz:
5443 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5444 \def\unnumberedseczzz#1{%
5445 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5446 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5451 % normally calls numberedsubseczzz:
5452 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5453 \def\numberedsubseczzz#1{%
5454 \global\subsubsecno=0 \global\advance\subsecno by 1
5455 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5458 % normally calls appendixsubseczzz:
5459 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5460 \def\appendixsubseczzz#1{%
5461 \global\subsubsecno=0 \global\advance\subsecno by 1
5462 \sectionheading{#1}{subsec}{Yappendix}%
5463 {\appendixletter.\the\secno.\the\subsecno}%
5466 % normally calls unnumberedsubseczzz:
5467 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5468 \def\unnumberedsubseczzz#1{%
5469 \global\subsubsecno=0 \global\advance\subsecno by 1
5470 \sectionheading{#1}{subsec}{Ynothing}%
5471 {\the\unnumberedno.\the\secno.\the\subsecno}%
5476 % normally numberedsubsubseczzz:
5477 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5478 \def\numberedsubsubseczzz#1{%
5479 \global\advance\subsubsecno by 1
5480 \sectionheading{#1}{subsubsec}{Ynumbered}%
5481 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5484 % normally appendixsubsubseczzz:
5485 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5486 \def\appendixsubsubseczzz#1{%
5487 \global\advance\subsubsecno by 1
5488 \sectionheading{#1}{subsubsec}{Yappendix}%
5489 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5492 % normally unnumberedsubsubseczzz:
5493 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5494 \def\unnumberedsubsubseczzz#1{%
5495 \global\advance\subsubsecno by 1
5496 \sectionheading{#1}{subsubsec}{Ynothing}%
5497 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5500 % These macros control what the section commands do, according
5501 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5502 % Define them by default for a numbered chapter.
5503 \let\section = \numberedsec
5504 \let\subsection = \numberedsubsec
5505 \let\subsubsection = \numberedsubsubsec
5507 % Define @majorheading, @heading and @subheading
5509 % NOTE on use of \vbox for chapter headings, section headings, and such:
5510 % 1) We use \vbox rather than the earlier \line to permit
5511 % overlong headings to fold.
5512 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5513 % heading is obnoxious; this forbids it.
5514 % 3) Likewise, headings look best if no \parindent is used, and
5515 % if justification is not attempted. Hence \raggedright.
5518 {\advance\chapheadingskip by 10pt \chapbreak }%
5519 \parsearg\chapheadingzzz
5522 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5523 \def\chapheadingzzz#1{%
5524 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5525 \parindent=0pt\ptexraggedright
5526 \rmisbold #1\hfill}}%
5527 \bigskip \par\penalty 200\relax
5528 \suppressfirstparagraphindent
5531 % @heading, @subheading, @subsubheading.
5532 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5533 \suppressfirstparagraphindent}
5534 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5535 \suppressfirstparagraphindent}
5536 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5537 \suppressfirstparagraphindent}
5539 % These macros generate a chapter, section, etc. heading only
5540 % (including whitespace, linebreaking, etc. around it),
5541 % given all the information in convenient, parsed form.
5543 % Args are the skip and penalty (usually negative)
5544 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5546 % Parameter controlling skip before chapter headings (if needed)
5547 \newskip\chapheadingskip
5549 % Define plain chapter starts, and page on/off switching for it.
5550 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5551 \def\chappager{\par\vfill\supereject}
5552 % Because \domark is called before \chapoddpage, the filler page will
5553 % get the headings for the next chapter, which is wrong. But we don't
5554 % care -- we just disable all headings on the filler page.
5566 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5569 \global\let\contentsalignmacro = \chappager
5570 \global\let\pchapsepmacro=\chapbreak
5571 \global\let\pagealignmacro=\chappager}
5574 \global\let\contentsalignmacro = \chappager
5575 \global\let\pchapsepmacro=\chappager
5576 \global\let\pagealignmacro=\chappager
5577 \global\def\HEADINGSon{\HEADINGSsingle}}
5580 \global\let\contentsalignmacro = \chapoddpage
5581 \global\let\pchapsepmacro=\chapoddpage
5582 \global\let\pagealignmacro=\chapoddpage
5583 \global\def\HEADINGSon{\HEADINGSdouble}}
5589 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5590 % Yappendix, Yomitfromtoc), #3 the chapter number.
5592 % To test against our argument.
5593 \def\Ynothingkeyword{Ynothing}
5594 \def\Yomitfromtockeyword{Yomitfromtoc}
5595 \def\Yappendixkeyword{Yappendix}
5597 \def\chapmacro#1#2#3{%
5598 % Insert the first mark before the heading break (see notes for \domark).
5599 \let\prevchapterdefs=\lastchapterdefs
5600 \let\prevsectiondefs=\lastsectiondefs
5601 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5602 \gdef\thissection{}}%
5605 \ifx\temptype\Ynothingkeyword
5606 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5607 \gdef\thischapter{\thischaptername}}%
5608 \else\ifx\temptype\Yomitfromtockeyword
5609 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5610 \gdef\thischapter{}}%
5611 \else\ifx\temptype\Yappendixkeyword
5613 \xdef\lastchapterdefs{%
5614 \gdef\noexpand\thischaptername{\the\toks0}%
5615 \gdef\noexpand\thischapternum{\appendixletter}%
5616 % \noexpand\putwordAppendix avoids expanding indigestible
5617 % commands in some of the translations.
5618 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5619 \noexpand\thischapternum:
5620 \noexpand\thischaptername}%
5624 \xdef\lastchapterdefs{%
5625 \gdef\noexpand\thischaptername{\the\toks0}%
5626 \gdef\noexpand\thischapternum{\the\chapno}%
5627 % \noexpand\putwordChapter avoids expanding indigestible
5628 % commands in some of the translations.
5629 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5630 \noexpand\thischapternum:
5631 \noexpand\thischaptername}%
5635 % Output the mark. Pass it through \safewhatsit, to take care of
5636 % the preceding space.
5639 % Insert the chapter heading break.
5642 % Now the second mark, after the heading break. No break points
5643 % between here and the heading.
5644 \let\prevchapterdefs=\lastchapterdefs
5645 \let\prevsectiondefs=\lastsectiondefs
5649 \chapfonts \rmisbold
5651 % Have to define \lastsection before calling \donoderef, because the
5652 % xref code eventually uses it. On the other hand, it has to be called
5653 % after \pchapsepmacro, or the headline will change too soon.
5654 \gdef\lastsection{#1}%
5656 % Only insert the separating space if we have a chapter/appendix
5657 % number, and don't print the unnumbered ``number''.
5658 \ifx\temptype\Ynothingkeyword
5660 \def\toctype{unnchap}%
5661 \else\ifx\temptype\Yomitfromtockeyword
5662 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5664 \else\ifx\temptype\Yappendixkeyword
5665 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5668 \setbox0 = \hbox{#3\enspace}%
5669 \def\toctype{numchap}%
5672 % Write the toc entry for this chapter. Must come before the
5673 % \donoderef, because we include the current node name in the toc
5674 % entry, and \donoderef resets it to empty.
5675 \writetocentry{\toctype}{#1}{#3}%
5677 % For pdftex, we have to write out the node definition (aka, make
5678 % the pdfdest) after any page break, but before the actual text has
5679 % been typeset. If the destination for the pdf outline is after the
5680 % text, then jumping from the outline may wind up with the text not
5681 % being visible, for instance under high magnification.
5684 % Typeset the actual heading.
5685 \nobreak % Avoid page breaks at the interline glue.
5686 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5687 \hangindent=\wd0 \centerparametersmaybe
5690 \nobreak\bigskip % no page break after a chapter title
5694 % @centerchap -- centered and unnumbered.
5695 \let\centerparametersmaybe = \relax
5696 \def\centerparameters{%
5697 \advance\rightskip by 3\rightskip
5698 \leftskip = \rightskip
5703 % I don't think this chapter style is supported any more, so I'm not
5704 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5706 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5708 \def\unnchfopen #1{%
5709 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5710 \parindent=0pt\ptexraggedright
5711 \rmisbold #1\hfill}}\bigskip \par\nobreak
5713 \def\chfopen #1#2{\chapoddpage {\chapfonts
5714 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5717 \def\centerchfopen #1{%
5718 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5720 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5723 \global\let\chapmacro=\chfopen
5724 \global\let\centerchapmacro=\centerchfopen}
5727 % Section titles. These macros combine the section number parts and
5728 % call the generic \sectionheading to do the printing.
5730 \newskip\secheadingskip
5731 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5733 % Subsection titles.
5734 \newskip\subsecheadingskip
5735 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5737 % Subsubsection titles.
5738 \def\subsubsecheadingskip{\subsecheadingskip}
5739 \def\subsubsecheadingbreak{\subsecheadingbreak}
5742 % Print any size, any type, section title.
5744 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5745 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5748 \def\seckeyword{sec}
5750 \def\sectionheading#1#2#3#4{%
5752 \checkenv{}% should not be in an environment.
5754 % Switch to the right set of fonts.
5755 \csname #2fonts\endcsname \rmisbold
5757 \def\sectionlevel{#2}%
5760 % Insert first mark before the heading break (see notes for \domark).
5761 \let\prevsectiondefs=\lastsectiondefs
5762 \ifx\temptype\Ynothingkeyword
5763 \ifx\sectionlevel\seckeyword
5764 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5765 \gdef\thissection{\thissectionname}}%
5767 \else\ifx\temptype\Yomitfromtockeyword
5768 % Don't redefine \thissection.
5769 \else\ifx\temptype\Yappendixkeyword
5770 \ifx\sectionlevel\seckeyword
5772 \xdef\lastsectiondefs{%
5773 \gdef\noexpand\thissectionname{\the\toks0}%
5774 \gdef\noexpand\thissectionnum{#4}%
5775 % \noexpand\putwordSection avoids expanding indigestible
5776 % commands in some of the translations.
5777 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5778 \noexpand\thissectionnum:
5779 \noexpand\thissectionname}%
5783 \ifx\sectionlevel\seckeyword
5785 \xdef\lastsectiondefs{%
5786 \gdef\noexpand\thissectionname{\the\toks0}%
5787 \gdef\noexpand\thissectionnum{#4}%
5788 % \noexpand\putwordSection avoids expanding indigestible
5789 % commands in some of the translations.
5790 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5791 \noexpand\thissectionnum:
5792 \noexpand\thissectionname}%
5797 % Go into vertical mode. Usually we'll already be there, but we
5798 % don't want the following whatsit to end up in a preceding paragraph
5799 % if the document didn't happen to have a blank line.
5802 % Output the mark. Pass it through \safewhatsit, to take care of
5803 % the preceding space.
5806 % Insert space above the heading.
5807 \csname #2headingbreak\endcsname
5809 % Now the second mark, after the heading break. No break points
5810 % between here and the heading.
5811 \let\prevsectiondefs=\lastsectiondefs
5814 % Only insert the space after the number if we have a section number.
5815 \ifx\temptype\Ynothingkeyword
5818 \gdef\lastsection{#1}%
5819 \else\ifx\temptype\Yomitfromtockeyword
5820 % for @headings -- no section number, don't include in toc,
5821 % and don't redefine \lastsection.
5824 \let\sectionlevel=\empty
5825 \else\ifx\temptype\Yappendixkeyword
5826 \setbox0 = \hbox{#4\enspace}%
5828 \gdef\lastsection{#1}%
5830 \setbox0 = \hbox{#4\enspace}%
5832 \gdef\lastsection{#1}%
5835 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5836 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5838 % Write the node reference (= pdf destination for pdftex).
5839 % Again, see comments in \chapmacro.
5842 % Interline glue will be inserted when the vbox is completed.
5843 % That glue will be a valid breakpoint for the page, since it'll be
5844 % preceded by a whatsit (usually from the \donoderef, or from the
5845 % \writetocentry if there was no node). We don't want to allow that
5846 % break, since then the whatsits could end up on page n while the
5847 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5850 % Output the actual section heading.
5851 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5852 \hangindent=\wd0 % zero if no section number
5855 % Add extra space after the heading -- half of whatever came above it.
5856 % Don't allow stretch, though.
5857 \kern .5 \csname #2headingskip\endcsname
5859 % Do not let the kern be a potential breakpoint, as it would be if it
5860 % was followed by glue.
5863 % We'll almost certainly start a paragraph next, so don't let that
5864 % glue accumulate. (Not a breakpoint because it's preceded by a
5865 % discardable item.)
5868 % This is purely so the last item on the list is a known \penalty >
5869 % 10000. This is so \startdefun can avoid allowing breakpoints after
5870 % section headings. Otherwise, it would insert a valid breakpoint between:
5871 % @section sec-whatever
5872 % @deffn def-whatever
5878 % Table of contents.
5881 % Write an entry to the toc file, opening it if necessary.
5882 % Called from @chapter, etc.
5884 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5885 % We append the current node name (if any) and page number as additional
5886 % arguments for the \{chap,sec,...}entry macros which will eventually
5887 % read this. The node name is used in the pdf outlines as the
5888 % destination to jump to.
5890 % We open the .toc file for writing here instead of at @setfilename (or
5891 % any other fixed time) so that @contents can be anywhere in the document.
5892 % But if #1 is `omit', then we don't do anything. This is used for the
5893 % table of contents chapter openings themselves.
5895 \newif\iftocfileopened
5896 \def\omitkeyword{omit}%
5898 \def\writetocentry#1#2#3{%
5899 \edef\writetoctype{#1}%
5900 \ifx\writetoctype\omitkeyword \else
5901 \iftocfileopened\else
5902 \immediate\openout\tocfile = \jobname.toc
5903 \global\tocfileopenedtrue
5909 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5915 % Tell \shipout to create a pdf destination on each page, if we're
5916 % writing pdf. These are used in the table of contents. We can't
5917 % just write one on every page because the title pages are numbered
5918 % 1 and 2 (the page numbers aren't printed), and so are the first
5919 % two pages of the document. Thus, we'd have two destinations named
5920 % `1', and two named `2'.
5921 \ifpdf \global\pdfmakepagedesttrue \fi
5925 % These characters do not print properly in the Computer Modern roman
5926 % fonts, so we must take special care. This is more or less redundant
5927 % with the Texinfo input format setup at the end of this file.
5929 \def\activecatcodes{%
5942 % Read the toc file, which is essentially Texinfo input.
5946 \input \tocreadfilename
5949 \newskip\contentsrightmargin \contentsrightmargin=1in
5950 \newcount\savepageno
5951 \newcount\lastnegativepageno \lastnegativepageno = -1
5953 % Prepare to read what we've written to \tocfile.
5955 \def\startcontents#1{%
5956 % If @setchapternewpage on, and @headings double, the contents should
5957 % start on an odd page, unlike chapters. Thus, we maintain
5958 % \contentsalignmacro in parallel with \pagealignmacro.
5959 % From: Torbjorn Granlund <tege@matematik.su.se>
5961 \immediate\closeout\tocfile
5963 % Don't need to put `Contents' or `Short Contents' in the headline.
5964 % It is abundantly clear what they are.
5965 \chapmacro{#1}{Yomitfromtoc}{}%
5967 \savepageno = \pageno
5968 \begingroup % Set up to handle contents files properly.
5969 \raggedbottom % Worry more about breakpoints than the bottom.
5970 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5972 % Roman numerals for page numbers.
5973 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5976 % redefined for the two-volume lispref. We always output on
5977 % \jobname.toc even if this is redefined.
5979 \def\tocreadfilename{\jobname.toc}
5981 % Normal (long) toc.
5984 \startcontents{\putwordTOC}%
5985 \openin 1 \tocreadfilename\space
5990 \contentsalignmacro % in case @setchapternewpage odd is in effect
5996 \lastnegativepageno = \pageno
5997 \global\pageno = \savepageno
6000 % And just the chapters.
6001 \def\summarycontents{%
6002 \startcontents{\putwordShortTOC}%
6004 \let\partentry = \shortpartentry
6005 \let\numchapentry = \shortchapentry
6006 \let\appentry = \shortchapentry
6007 \let\unnchapentry = \shortunnchapentry
6008 % We want a true roman here for the page numbers.
6010 \let\rm=\shortcontrm \let\bf=\shortcontbf
6011 \let\sl=\shortcontsl \let\tt=\shortconttt
6013 \hyphenpenalty = 10000
6014 \advance\baselineskip by 1pt % Open it up a little.
6015 \def\numsecentry##1##2##3##4{}
6016 \let\appsecentry = \numsecentry
6017 \let\unnsecentry = \numsecentry
6018 \let\numsubsecentry = \numsecentry
6019 \let\appsubsecentry = \numsecentry
6020 \let\unnsubsecentry = \numsecentry
6021 \let\numsubsubsecentry = \numsecentry
6022 \let\appsubsubsecentry = \numsecentry
6023 \let\unnsubsubsecentry = \numsecentry
6024 \openin 1 \tocreadfilename\space
6030 \contentsalignmacro % in case @setchapternewpage odd is in effect
6032 \lastnegativepageno = \pageno
6033 \global\pageno = \savepageno
6035 \let\shortcontents = \summarycontents
6037 % Typeset the label for a chapter or appendix for the short contents.
6038 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6040 \def\shortchaplabel#1{%
6041 % This space should be enough, since a single number is .5em, and the
6042 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6043 % But use \hss just in case.
6044 % (This space doesn't include the extra space that gets added after
6045 % the label; that gets put in by \shortchapentry above.)
6047 % We'd like to right-justify chapter numbers, but that looks strange
6048 % with appendix letters. And right-justifying numbers and
6049 % left-justifying letters looks strange when there is less than 10
6050 % chapters. Have to read the whole toc once to know how many chapters
6051 % there are before deciding ...
6052 \hbox to 1em{#1\hss}%
6055 % These macros generate individual entries in the table of contents.
6056 % The first argument is the chapter or section name.
6057 % The last argument is the page number.
6058 % The arguments in between are the chapter number, section number, ...
6060 % Parts, in the main contents. Replace the part number, which doesn't
6061 % exist, with an empty box. Let's hope all the numbers have the same width.
6062 % Also ignore the page number, which is conventionally not printed.
6063 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6064 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6066 % Parts, in the short toc.
6067 \def\shortpartentry#1#2#3#4{%
6069 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6070 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6073 % Chapters, in the main contents.
6074 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6076 % Chapters, in the short toc.
6077 % See comments in \dochapentry re vbox and related settings.
6078 \def\shortchapentry#1#2#3#4{%
6079 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6082 % Appendices, in the main contents.
6083 % Need the word Appendix, and a fixed-size box.
6085 \def\appendixbox#1{%
6086 % We use M since it's probably the widest letter.
6087 \setbox0 = \hbox{\putwordAppendix{} M}%
6088 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6090 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6092 % Unnumbered chapters.
6093 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6094 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6097 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6098 \let\appsecentry=\numsecentry
6099 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6102 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6103 \let\appsubsecentry=\numsubsecentry
6104 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6106 % And subsubsections.
6107 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6108 \let\appsubsubsecentry=\numsubsubsecentry
6109 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6111 % This parameter controls the indentation of the various levels.
6112 % Same as \defaultparindent.
6113 \newdimen\tocindent \tocindent = 15pt
6115 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6118 % If the toc has to be broken over pages, we want it to be at chapters
6119 % if at all possible; hence the \penalty.
6120 \def\dochapentry#1#2{%
6121 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6124 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6126 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6129 \def\dosecentry#1#2{\begingroup
6130 \secentryfonts \leftskip=\tocindent
6131 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6134 \def\dosubsecentry#1#2{\begingroup
6135 \subsecentryfonts \leftskip=2\tocindent
6136 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6139 \def\dosubsubsecentry#1#2{\begingroup
6140 \subsubsecentryfonts \leftskip=3\tocindent
6141 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6144 % We use the same \entry macro as for the index entries.
6145 \let\tocentry = \entry
6147 % Space between chapter (or whatever) number and the title.
6148 \def\labelspace{\hskip1em \relax}
6150 \def\dopageno#1{{\rm #1}}
6151 \def\doshortpageno#1{{\rm #1}}
6153 \def\chapentryfonts{\secfonts \rm}
6154 \def\secentryfonts{\textfonts}
6155 \def\subsecentryfonts{\textfonts}
6156 \def\subsubsecentryfonts{\textfonts}
6159 \message{environments,}
6160 % @foo ... @end foo.
6162 % @tex ... @end tex escapes into raw TeX temporarily.
6163 % One exception: @ is still an escape character, so that @end tex works.
6164 % But \@ or @@ will get a plain @ character.
6167 \setupmarkupstyle{tex}%
6168 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6169 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6170 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6181 % ' is active in math mode (mathcode"8000). So reset it, and all our
6182 % other math active characters (just in case), to plain's definitions.
6186 \let\bullet=\ptexbullet
6191 \let\equiv=\ptexequiv
6194 \let\indent=\ptexindent
6195 \let\noindent=\ptexnoindent
6202 \expandafter \let\csname top\endcsname=\ptextop % outer
6203 \let\frenchspacing=\plainfrenchspacing
6205 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6206 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6209 % There is no need to define \Etex.
6211 % Define @lisp ... @end lisp.
6212 % @lisp environment forms a group so it can rebind things,
6213 % including the definition of @end lisp (which normally is erroneous).
6215 % Amount to narrow the margins by for @lisp.
6216 \newskip\lispnarrowing \lispnarrowing=0.4in
6218 % This is the definition that ^^M gets inside @lisp, @example, and other
6219 % such environments. \null is better than a space, since it doesn't
6221 \def\lisppar{\null\endgraf}
6223 % This space is always present above and below environments.
6224 \newskip\envskipamount \envskipamount = 0pt
6226 % Make spacing and below environment symmetrical. We use \parskip here
6227 % to help in doing that, since in @example-like environments \parskip
6228 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6229 % start of the next paragraph will insert \parskip.
6231 \def\aboveenvbreak{{%
6232 % =10000 instead of <10000 because of a special case in \itemzzz and
6233 % \sectionheading, q.v.
6234 \ifnum \lastpenalty=10000 \else
6235 \advance\envskipamount by \parskip
6237 \ifdim\lastskip<\envskipamount
6239 % it's not a good place to break if the last penalty was \nobreak
6241 \ifnum\lastpenalty<10000 \penalty-50 \fi
6242 \vskip\envskipamount
6247 \let\afterenvbreak = \aboveenvbreak
6249 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6250 % also clear it, so that its embedded environments do the narrowing again.
6251 \let\nonarrowing=\relax
6253 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6254 % environment contents.
6255 \font\circle=lcircle10
6257 \newdimen\cartouter\newdimen\cartinner
6258 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6259 \circthick=\fontdimen8\circle
6261 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6262 \def\ctr{{\hskip 6pt\circle\char'010}}
6263 \def\cbl{{\circle\char'012\hskip -6pt}}
6264 \def\cbr{{\hskip 6pt\circle\char'011}}
6265 \def\carttop{\hbox to \cartouter{\hskip\lskip
6266 \ctl\leaders\hrule height\circthick\hfil\ctr
6268 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6269 \cbl\leaders\hrule height\circthick\hfil\cbr
6272 \newskip\lskip\newskip\rskip
6275 \ifhmode\par\fi % can't be in the midst of a paragraph.
6277 \lskip=\leftskip \rskip=\rightskip
6278 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6279 \cartinner=\hsize \advance\cartinner by-\lskip
6280 \advance\cartinner by-\rskip
6282 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6283 % side, and for 6pt waste from
6284 % each corner char, and rule thickness
6285 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6286 % Flag to tell @lisp, etc., not to narrow margin.
6287 \let\nonarrowing = t%
6289 % If this cartouche directly follows a sectioning command, we need the
6290 % \parskip glue (backspaced over by default) or the cartouche can
6291 % collide with the section heading.
6292 \ifnum\lastpenalty>10000 \vskip\parskip \fi
6295 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6303 \baselineskip=\normbskip
6304 \lineskip=\normlskip
6307 \comment % For explanation, see the end of def\group.
6322 % This macro is called at the beginning of all the @example variants,
6324 \newdimen\nonfillparindent
6327 \hfuzz = 12pt % Don't be fussy
6328 \sepspaces % Make spaces be word-separators rather than space tokens.
6329 \let\par = \lisppar % don't ignore blank lines
6330 \obeylines % each line of input is a line of output
6332 % Turn off paragraph indentation but redefine \indent to emulate
6333 % the normal \indent.
6334 \nonfillparindent=\parindent
6336 \let\indent\nonfillindent
6338 \emergencystretch = 0pt % don't try to avoid overfull boxes
6339 \ifx\nonarrowing\relax
6340 \advance \leftskip by \lispnarrowing
6341 \exdentamount=\lispnarrowing
6343 \let\nonarrowing = \relax
6345 \let\exdent=\nofillexdent
6350 % We want to swallow spaces (but not other tokens) after the fake
6351 % @indent in our nonfill-environments, where spaces are normally
6352 % active and set to @tie, resulting in them not being ignored after
6354 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6355 \gdef\nonfillindentcheck{%
6357 \expandafter\nonfillindentgobble%
6359 \leavevmode\nonfillindentbox%
6363 \def\nonfillindentgobble#1{\nonfillindent}
6364 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6366 % If you want all examples etc. small: @set dispenvsize small.
6367 % If you want even small examples the full size: @set dispenvsize nosmall.
6368 % This affects the following displayed environments:
6369 % @example, @display, @format, @lisp
6371 \def\smallword{small}
6372 \def\nosmallword{nosmall}
6373 \let\SETdispenvsize\relax
6374 \def\setnormaldispenv{%
6375 \ifx\SETdispenvsize\smallword
6376 % end paragraph for sake of leading, in case document has no blank
6377 % line. This is redundant with what happens in \aboveenvbreak, but
6378 % we need to do it before changing the fonts, and it's inconvenient
6379 % to change the fonts afterward.
6380 \ifnum \lastpenalty=10000 \else \endgraf \fi
6381 \smallexamplefonts \rm
6384 \def\setsmalldispenv{%
6385 \ifx\SETdispenvsize\nosmallword
6387 \ifnum \lastpenalty=10000 \else \endgraf \fi
6388 \smallexamplefonts \rm
6392 % We often define two environments, @foo and @smallfoo.
6393 % Let's do it in one command. #1 is the env name, #2 the definition.
6394 \def\makedispenvdef#1#2{%
6395 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6396 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6397 \expandafter\let\csname E#1\endcsname \afterenvbreak
6398 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6401 % Define two environment synonyms (#1 and #2) for an environment.
6402 \def\maketwodispenvdef#1#2#3{%
6403 \makedispenvdef{#1}{#3}%
6404 \makedispenvdef{#2}{#3}%
6407 % @lisp: indented, narrowed, typewriter font;
6408 % @example: same as @lisp.
6410 % @smallexample and @smalllisp: use smaller fonts.
6411 % Originally contributed by Pavel@xerox.
6413 \maketwodispenvdef{lisp}{example}{%
6415 \tt\setupmarkupstyle{example}%
6416 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6417 \gobble % eat return
6419 % @display/@smalldisplay: same as @lisp except keep current font.
6421 \makedispenvdef{display}{%
6426 % @format/@smallformat: same as @display except don't narrow margins.
6428 \makedispenvdef{format}{%
6429 \let\nonarrowing = t%
6434 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6436 \let\nonarrowing = t%
6440 \let\Eflushleft = \afterenvbreak
6444 \envdef\flushright{%
6445 \let\nonarrowing = t%
6447 \advance\leftskip by 0pt plus 1fill\relax
6450 \let\Eflushright = \afterenvbreak
6453 % @raggedright does more-or-less normal line breaking but no right
6454 % justification. From plain.tex.
6455 \envdef\raggedright{%
6456 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6458 \let\Eraggedright\par
6460 \envdef\raggedleft{%
6461 \parindent=0pt \leftskip0pt plus2em
6462 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6463 \hbadness=10000 % Last line will usually be underfull, so turn off
6464 % badness reporting.
6466 \let\Eraggedleft\par
6468 \envdef\raggedcenter{%
6469 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6470 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6471 \hbadness=10000 % Last line will usually be underfull, so turn off
6472 % badness reporting.
6474 \let\Eraggedcenter\par
6477 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6478 % and narrows the margins. We keep \parskip nonzero in general, since
6479 % we're doing normal filling. So, when using \aboveenvbreak and
6480 % \afterenvbreak, temporarily make \parskip 0.
6482 \makedispenvdef{quotation}{\quotationstart}
6484 \def\quotationstart{%
6485 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6488 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6489 \ifx\nonarrowing\relax
6490 \advance\leftskip by \lispnarrowing
6491 \advance\rightskip by \lispnarrowing
6492 \exdentamount = \lispnarrowing
6494 \let\nonarrowing = \relax
6496 \parsearg\quotationlabel
6499 % We have retained a nonzero parskip for the environment, since we're
6500 % doing normal filling.
6504 \ifx\quotationauthor\thisisundefined\else
6506 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6508 {\parskip=0pt \afterenvbreak}%
6510 \def\Esmallquotation{\Equotation}
6512 % If we're given an argument, typeset it in bold with a colon after.
6513 \def\quotationlabel#1{%
6515 \ifx\temp\empty \else
6521 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6522 % If we want to allow any <char> as delimiter,
6523 % we need the curly braces so that makeinfo sees the @verb command, eg:
6524 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6526 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6528 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6529 % active too. Otherwise, they get lost as the first character on a
6532 \do\ \do\\\do\{\do\}\do\$\do\&%
6533 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6534 \do\<\do\>\do\|\do\@\do+\do\"%
6535 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6536 % @set txicodequotebacktick will not have effect on @verb and
6537 % @verbatim, and ?` and !` ligatures won't get disabled.
6542 \def\uncatcodespecials{%
6543 \def\do##1{\catcode`##1=\other}\dospecials}
6545 % Setup for the @verb command.
6547 % Eight spaces for a tab
6549 \catcode`\^^I=\active
6550 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6554 \tt % easiest (and conventionally used) font for verbatim
6555 \def\par{\leavevmode\endgraf}%
6556 \setupmarkupstyle{verb}%
6558 % Respect line breaks,
6559 % print special symbols as themselves, and
6560 % make each space count
6561 % must do in this order:
6562 \obeylines \uncatcodespecials \sepspaces
6565 % Setup for the @verbatim environment
6567 % Real tab expansion.
6568 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6570 % We typeset each line of the verbatim in an \hbox, so we can handle
6571 % tabs. The \global is in case the verbatim line starts with an accent,
6572 % or some other command that starts with a begin-group. Otherwise, the
6573 % entire \verbbox would disappear at the corresponding end-group, before
6574 % it is typeset. Meanwhile, we can't have nested verbatim commands
6575 % (can we?), so the \global won't be overwriting itself.
6577 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6580 \catcode`\^^I=\active
6582 \catcode`\^^I=\active
6583 \def^^I{\leavevmode\egroup
6584 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6585 \divide\dimen\verbbox by\tabw
6586 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6587 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6588 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6593 % start the verbatim environment.
6594 \def\setupverbatim{%
6595 \let\nonarrowing = t%
6597 \tt % easiest (and conventionally used) font for verbatim
6598 % The \leavevmode here is for blank lines. Otherwise, we would
6599 % never \starttabox and the \egroup would end verbatim mode.
6600 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6602 \setupmarkupstyle{verbatim}%
6603 % Respect line breaks,
6604 % print special symbols as themselves, and
6605 % make each space count.
6606 % Must do in this order:
6607 \obeylines \uncatcodespecials \sepspaces
6608 \everypar{\starttabbox}%
6611 % Do the @verb magic: verbatim text is quoted by unique
6612 % delimiter characters. Before first delimiter expect a
6613 % right brace, after last delimiter expect closing brace:
6615 % \def\doverb'{'<char>#1<char>'}'{#1}
6617 % [Knuth] p. 382; only eat outer {}
6619 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6620 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6623 \def\verb{\begingroup\setupverb\doverb}
6626 % Do the @verbatim magic: define the macro \doverbatim so that
6627 % the (first) argument ends when '@end verbatim' is reached, ie:
6629 % \def\doverbatim#1@end verbatim{#1}
6631 % For Texinfo it's a lot easier than for LaTeX,
6632 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6633 % we need not redefine '\', '{' and '}'.
6635 % Inspired by LaTeX's verbatim command set [latex.ltx]
6640 % ignore everything up to the first ^^M, that's the newline at the end
6641 % of the @verbatim input line itself. Otherwise we get an extra blank
6642 % line in the output.
6643 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6644 % We really want {...\end verbatim} in the body of the macro, but
6645 % without the active space; thus we have to use \xdef and \gobble.
6649 \setupverbatim\doverbatim
6651 \let\Everbatim = \afterenvbreak
6654 % @verbatiminclude FILE - insert text of file in verbatim environment.
6656 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6658 \def\doverbatiminclude#1{%
6660 \makevalueexpandable
6662 \indexnofonts % Allow `@@' and other weird things in file names.
6663 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6669 % @copying ... @end copying.
6670 % Save the text away for @insertcopying later.
6672 % We save the uninterpreted tokens, rather than creating a box.
6673 % Saving the text in a box would be much easier, but then all the
6674 % typesetting commands (@smallbook, font changes, etc.) have to be done
6675 % beforehand -- and a) we want @copying to be done first in the source
6676 % file; b) letting users define the frontmatter in as flexible order as
6677 % possible is very desirable.
6679 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6680 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6682 \def\insertcopying{%
6684 \parindent = 0pt % paragraph indentation looks wrong on title page
6685 \scanexp\copyingtext
6693 \newskip\defbodyindent \defbodyindent=.4in
6694 \newskip\defargsindent \defargsindent=50pt
6695 \newskip\deflastargmargin \deflastargmargin=18pt
6696 \newcount\defunpenalty
6698 % Start the processing of @deffn:
6700 \ifnum\lastpenalty<10000
6702 \defunpenalty=10003 % Will keep this @deffn together with the
6703 % following @def command, see below.
6705 % If there are two @def commands in a row, we'll have a \nobreak,
6706 % which is there to keep the function description together with its
6707 % header. But if there's nothing but headers, we need to allow a
6708 % break somewhere. Check specifically for penalty 10002, inserted
6709 % by \printdefunline, instead of 10000, since the sectioning
6710 % commands also insert a nobreak penalty, and we don't want to allow
6711 % a break between a section heading and a defun.
6713 % As a further refinement, we avoid "club" headers by signalling
6714 % with penalty of 10003 after the very first @deffn in the
6715 % sequence (see above), and penalty of 10002 after any following
6717 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6719 % Similarly, after a section heading, do not allow a break.
6720 % But do insert the glue.
6721 \medskip % preceded by discardable penalty, so not a breakpoint
6725 \advance\leftskip by \defbodyindent
6726 \exdentamount=\defbodyindent
6730 % First, check whether we are in the right environment:
6733 % As above, allow line break if we have multiple x headers in a row.
6734 % It's not a great place, though.
6735 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6737 % And now, it's time to reuse the body of the original defun:
6738 \expandafter\gobbledefun#1%
6740 \def\gobbledefun#1\startdefun{}
6742 % \printdefunline \deffnheader{text}
6744 \def\printdefunline#1#2{%
6746 % call \deffnheader:
6749 \interlinepenalty = 10000
6750 \advance\rightskip by 0pt plus 1fil\relax
6752 \nobreak\vskip -\parskip
6753 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6754 % Some of the @defun-type tags do not enable magic parentheses,
6755 % rendering the following check redundant. But we don't optimize.
6760 \def\Edefun{\endgraf\medbreak}
6762 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6763 % the only thing remaining is to define \deffnheader.
6766 \expandafter\let\csname E#1\endcsname = \Edefun
6767 \edef\temp{\noexpand\domakedefun
6768 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6772 % \domakedefun \deffn \deffnx \deffnheader
6774 % Define \deffn and \deffnx, without parameters.
6775 % \deffnheader has to be defined explicitly.
6777 \def\domakedefun#1#2#3{%
6780 \doingtypefnfalse % distinguish typed functions from all else
6781 \parseargusing\activeparens{\printdefunline#3}%
6783 \def#2{\dodefunx#1}%
6787 \newif\ifdoingtypefn % doing typed function?
6788 \newif\ifrettypeownline % typeset return type on its own line?
6790 % @deftypefnnewline on|off says whether the return type of typed functions
6791 % are printed on their own line. This affects @deftypefn, @deftypefun,
6792 % @deftypeop, and @deftypemethod.
6794 \parseargdef\deftypefnnewline{%
6797 \expandafter\let\csname SETtxideftypefnnl\endcsname
6799 \else\ifx\temp\offword
6800 \expandafter\let\csname SETtxideftypefnnl\endcsname
6803 \errhelp = \EMsimple
6804 \errmessage{Unknown @txideftypefnnl value `\temp',
6809 % Untyped functions:
6811 % @deffn category name args
6812 \makedefun{deffn}{\deffngeneral{}}
6814 % @deffn category class name args
6815 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6817 % \defopon {category on}class name args
6818 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6820 % \deffngeneral {subind}category name args
6822 \def\deffngeneral#1#2 #3 #4\endheader{%
6823 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6824 \dosubind{fn}{\code{#3}}{#1}%
6825 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6830 % @deftypefn category type name args
6831 \makedefun{deftypefn}{\deftypefngeneral{}}
6833 % @deftypeop category class type name args
6834 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6836 % \deftypeopon {category on}class type name args
6837 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6839 % \deftypefngeneral {subind}category type name args
6841 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6842 \dosubind{fn}{\code{#4}}{#1}%
6844 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6849 % @deftypevr category type var args
6850 \makedefun{deftypevr}{\deftypecvgeneral{}}
6852 % @deftypecv category class type var args
6853 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6855 % \deftypecvof {category of}class type var args
6856 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6858 % \deftypecvgeneral {subind}category type var args
6860 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6861 \dosubind{vr}{\code{#4}}{#1}%
6862 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6865 % Untyped variables:
6867 % @defvr category var args
6868 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6870 % @defcv category class var args
6871 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6873 % \defcvof {category of}class var args
6874 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6878 % @deftp category name args
6879 \makedefun{deftp}#1 #2 #3\endheader{%
6880 \doind{tp}{\code{#2}}%
6881 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6884 % Remaining @defun-like shortcuts:
6885 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6886 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6887 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6888 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6889 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6890 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6891 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6892 \makedefun{defmethod}{\defopon\putwordMethodon}
6893 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6894 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6895 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6897 % \defname, which formats the name of the @def (not the args).
6898 % #1 is the category, such as "Function".
6899 % #2 is the return type, if any.
6900 % #3 is the function name.
6902 % We are followed by (but not passed) the arguments, if any.
6904 \def\defname#1#2#3{%
6906 % Get the values of \leftskip and \rightskip as they were outside the @def...
6907 \advance\leftskip by -\defbodyindent
6909 % Determine if we are typesetting the return type of a typed function
6910 % on a line by itself.
6911 \rettypeownlinefalse
6912 \ifdoingtypefn % doing a typed function specifically?
6913 % then check user option for putting return type on its own line:
6914 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6919 % How we'll format the category name. Putting it in brackets helps
6920 % distinguish it from the body text that may end up on the next line
6923 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6925 % Figure out line sizes for the paragraph shape. We'll always have at
6929 % The first line needs space for \box0; but if \rightskip is nonzero,
6930 % we need only space for the part of \box0 which exceeds it:
6931 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6933 % If doing a return type on its own line, we'll have another line.
6935 \advance\tempnum by 1
6936 \def\maybeshapeline{0in \hsize}%
6938 \def\maybeshapeline{}%
6941 % The continuations:
6942 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6944 % The final paragraph shape:
6945 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
6947 % Put the category name at the right margin.
6950 \hfil\box0 \kern-\hsize
6951 % \hsize has to be shortened this way:
6953 % Intentionally do not respect \rightskip, since we need the space.
6956 % Allow all lines to be underfull without complaint:
6957 \tolerance=10000 \hbadness=10000
6958 \exdentamount=\defbodyindent
6960 % defun fonts. We use typewriter by default (used to be bold) because:
6961 % . we're printing identifiers, they should be in tt in principle.
6962 % . in languages with many accents, such as Czech or French, it's
6963 % common to leave accents off identifiers. The result looks ok in
6964 % tt, but exceedingly strange in rm.
6965 % . we don't want -- and --- to be treated as ligatures.
6966 % . this still does not fix the ?` and !` ligatures, but so far no
6967 % one has made identifiers using them :).
6969 \def\temp{#2}% text of the return type
6970 \ifx\temp\empty\else
6971 \tclose{\temp}% typeset the return type
6973 % put return type on its own line; prohibit line break following:
6974 \hfil\vadjust{\nobreak}\break
6976 \space % type on same line, so just followed by a space
6978 \fi % no return type
6979 #3% output function name
6981 {\rm\enskip}% hskip 0.5 em of \tenrm
6984 % arguments will be output next, if any.
6987 % Print arguments in slanted roman (not ttsl), inconsistently with using
6988 % tt for the name. This is because literal text is sometimes needed in
6989 % the argument list (groff manual), and ttsl and tt are not very
6990 % distinguishable. Prevent hyphenation at `-' chars.
6993 % use sl by default (not ttsl),
6995 \df \sl \hyphenchar\font=0
6997 % On the other hand, if an argument has two dashes (for instance), we
6998 % want a way to get ttsl. Let's try @var for that.
6999 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7001 \sl\hyphenchar\font=45
7004 % We want ()&[] to print specially on the defun line.
7007 \catcode`\(=\active \catcode`\)=\active
7008 \catcode`\[=\active \catcode`\]=\active
7012 % Make control sequences which act like normal parenthesis chars.
7013 \let\lparen = ( \let\rparen = )
7015 % Be sure that we always have a definition for `(', etc. For example,
7016 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7017 % so TeX would otherwise complain about undefined control sequence.
7020 \global\let(=\lparen \global\let)=\rparen
7021 \global\let[=\lbrack \global\let]=\rbrack
7024 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7025 \gdef\magicamp{\let&=\amprm}
7028 \newcount\parencount
7030 % If we encounter &foo, then turn on ()-hacking afterwards
7032 \def\amprm#1 {\ampseentrue{\bf\ }}
7036 % At the first level, print parens in roman,
7037 % otherwise use the default font.
7038 \ifnum \parencount=1 \rm \fi
7040 % The \sf parens (in \boldbrax) actually are a little bolder than
7041 % the contained text. This is especially needed for [ and ] .
7045 \def\infirstlevel#1{%
7052 \def\bfafterword#1 {#1 \bf}
7055 \global\advance\parencount by 1
7057 \infirstlevel \bfafterword
7062 \global\advance\parencount by -1
7065 \newcount\brackcount
7067 \global\advance\brackcount by 1
7072 \global\advance\brackcount by -1
7075 \def\checkparencounts{%
7076 \ifnum\parencount=0 \else \badparencount \fi
7077 \ifnum\brackcount=0 \else \badbrackcount \fi
7079 % these should not use \errmessage; the glibc manual, at least, actually
7080 % has such constructs (when documenting function pointers).
7081 \def\badparencount{%
7082 \message{Warning: unbalanced parentheses in @def...}%
7083 \global\parencount=0
7085 \def\badbrackcount{%
7086 \message{Warning: unbalanced square brackets in @def...}%
7087 \global\brackcount=0
7094 % To do this right we need a feature of e-TeX, \scantokens,
7095 % which we arrange to emulate with a temporary file in ordinary TeX.
7096 \ifx\eTeXversion\thisisundefined
7097 \newwrite\macscribble
7100 \immediate\openout\macscribble=\jobname.tmp
7101 \immediate\write\macscribble{\the\toks0}%
7102 \immediate\closeout\macscribble
7107 \def\scanmacro#1{\begingroup
7109 \let\xeatspaces\eatspaces
7111 % Undo catcode changes of \startcontents and \doprintindex
7112 % When called from @insertcopying or (short)caption, we need active
7113 % backslash to get it printed correctly. Previously, we had
7114 % \catcode`\\=\other instead. We'll see whether a problem appears
7115 % with macro expansion. --kasal, 19aug04
7116 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7118 % ... and for \example:
7121 % The \empty here causes a following catcode 5 newline to be eaten as
7122 % part of reading whitespace after a control sequence. It does not
7123 % eat a catcode 13 newline. There's no good way to handle the two
7124 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7125 % would then have different behavior). See the Macro Details node in
7126 % the manual for the workaround we recommend for macros and
7127 % line-oriented commands.
7129 \scantokens{#1\empty}%
7133 \edef\temp{\noexpand\scanmacro{#1}}%
7137 \newcount\paramno % Count of parameters
7138 \newtoks\macname % Macro name
7139 \newif\ifrecursive % Is it recursive?
7141 % List of all defined macros in the form
7142 % \definedummyword\macro1\definedummyword\macro2...
7143 % Currently is also contains all @aliases; the list can be split
7144 % if there is a need.
7147 % Add the macro to \macrolist
7148 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7149 \def\addtomacrolistxxx#1{%
7150 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7151 \xdef\macrolist{\the\toks0}%
7155 % This does \let #1 = #2, with \csnames; that is,
7156 % \let \csname#1\endcsname = \csname#2\endcsname
7157 % (except of course we have to play expansion games).
7161 \csname#1\expandafter\endcsname
7165 % Trim leading and trailing spaces off a string.
7166 % Concepts from aro-bend problem 15 (see CTAN).
7168 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7169 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7170 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7172 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7175 % Trim a single trailing ^^M off a string.
7176 {\catcode`\^^M=\other \catcode`\Q=3%
7177 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7178 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7179 \gdef\eatcrb#1Q#2Q{#1}%
7182 % Macro bodies are absorbed as an argument in a context where
7183 % all characters are catcode 10, 11 or 12, except \ which is active
7184 % (as in normal texinfo). It is necessary to change the definition of \
7185 % to recognize macro arguments; this is the job of \mbodybackslash.
7187 % Non-ASCII encodings make 8-bit characters active, so un-activate
7188 % them to avoid their expansion. Must do this non-globally, to
7189 % confine the change to the current group.
7191 % It's necessary to have hard CRs when the macro is executed. This is
7192 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7193 % body, and then making it the \newlinechar in \scanmacro.
7195 \def\scanctxt{% used as subroutine
7205 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7208 \def\scanargctxt{% used for copying and captions, not macros.
7211 \catcode`\^^M=\other
7214 \def\macrobodyctxt{% used for @macro definitions
7218 \catcode`\^^M=\other
7222 \def\macroargctxt{% used when scanning invocations
7226 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7227 % for the single characters \ { }. Thus, we end up with the "commands"
7228 % that would be written @\ @{ @} in a Texinfo document.
7230 % We already have @{ and @}. For @\, we define it here, and only for
7231 % this purpose, to produce a typewriter backslash (so, the @\ that we
7232 % define for @math can't be used with @macro calls):
7234 \def\\{\normalbackslash}%
7236 % We would like to do this for \, too, since that is what makeinfo does.
7237 % But it is not possible, because Texinfo already has a command @, for a
7238 % cedilla accent. Documents must use @comma{} instead.
7240 % \anythingelse will almost certainly be an error of some kind.
7243 % \mbodybackslash is the definition of \ in @macro bodies.
7244 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7245 % where N is the macro parameter number.
7246 % We define \csname macarg.\endcsname to be \realbackslash, so
7247 % \\ in macro replacement text gets you a backslash.
7249 {\catcode`@=0 @catcode`@\=@active
7250 @gdef@usembodybackslash{@let\=@mbodybackslash}
7251 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7253 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7255 \def\margbackslash#1{\char`\#1 }
7257 \def\macro{\recursivefalse\parsearg\macroxxx}
7258 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7261 \getargs{#1}% now \macname is the macname and \argl the arglist
7262 \ifx\argl\empty % no arguments
7265 \expandafter\parsemargdef \argl;%
7266 \if\paramno>256\relax
7267 \ifx\eTeXversion\thisisundefined
7268 \errhelp = \EMsimple
7269 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7273 \if1\csname ismacro.\the\macname\endcsname
7274 \message{Warning: redefining \the\macname}%
7276 \expandafter\ifx\csname \the\macname\endcsname \relax
7277 \else \errmessage{Macro name \the\macname\space already defined}\fi
7278 \global\cslet{macsave.\the\macname}{\the\macname}%
7279 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7280 \addtomacrolist{\the\macname}%
7282 \begingroup \macrobodyctxt
7283 \ifrecursive \expandafter\parsermacbody
7284 \else \expandafter\parsemacbody
7287 \parseargdef\unmacro{%
7288 \if1\csname ismacro.#1\endcsname
7289 \global\cslet{#1}{macsave.#1}%
7290 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7291 % Remove the macro name from \macrolist:
7293 \expandafter\let\csname#1\endcsname \relax
7294 \let\definedummyword\unmacrodo
7295 \xdef\macrolist{\macrolist}%
7298 \errmessage{Macro #1 not defined}%
7302 % Called by \do from \dounmacro on each macro. The idea is to omit any
7303 % macro definitions that have been changed to \relax.
7309 \noexpand\definedummyword \noexpand#1%
7313 % This makes use of the obscure feature that if the last token of a
7314 % <parameter list> is #, then the preceding argument is delimited by
7315 % an opening brace, and that opening brace is not consumed.
7316 \def\getargs#1{\getargsxxx#1{}}
7317 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7318 \def\getmacname#1 #2\relax{\macname={#1}}
7319 \def\getmacargs#1{\def\argl{#1}}
7321 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7322 \edef\texiatcatcode{\the\catcode`\@}
7323 \catcode `@=11\relax
7325 % Parse the optional {params} list. Set up \paramno and \paramlist
7326 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7327 % in the params list to some hook where the argument si to be expanded. If
7328 % there are less than 10 arguments that hook is to be replaced by ##N where N
7329 % is the position in that list, that is to say the macro arguments are to be
7330 % defined `a la TeX in the macro body.
7332 % That gets used by \mbodybackslash (above).
7334 % We need to get `macro parameter char #' into several definitions.
7335 % The technique used is stolen from LaTeX: let \hash be something
7336 % unexpandable, insert that wherever you need a #, and then redefine
7337 % it to # just before using the token list produced.
7339 % The same technique is used to protect \eatspaces till just before
7340 % the macro is used.
7342 % If there are 10 or more arguments, a different technique is used, where the
7343 % hook remains in the body, and when macro is to be expanded the body is
7344 % processed again to replace the arguments.
7346 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7347 % argument N value and then \edef the body (nothing else will expand because of
7348 % the catcode regime underwhich the body was input).
7350 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7351 % arguments, you need that no macro has more than 256 arguments, otherwise an
7352 % error is produced.
7353 \def\parsemargdef#1;{%
7354 \paramno=0\def\paramlist{}%
7356 \let\xeatspaces\relax
7357 \parsemargdefxxx#1,;,%
7358 % In case that there are 10 or more arguments we parse again the arguments
7359 % list to set new definitions for the \macarg.BLAH macros corresponding to
7360 % each BLAH argument. It was anyhow needed to parse already once this list
7361 % in order to count the arguments, and as macros with at most 9 arguments
7362 % are by far more frequent than macro with 10 or more arguments, defining
7363 % twice the \macarg.BLAH macros does not cost too much processing power.
7364 \ifnum\paramno<10\relax\else
7366 \parsemmanyargdef@@#1,;,% 10 or more arguments
7369 \def\parsemargdefxxx#1,{%
7370 \if#1;\let\next=\relax
7371 \else \let\next=\parsemargdefxxx
7372 \advance\paramno by 1
7373 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7374 {\xeatspaces{\hash\the\paramno}}%
7375 \edef\paramlist{\paramlist\hash\the\paramno,}%
7378 \def\parsemmanyargdef@@#1,{%
7379 \if#1;\let\next=\relax
7381 \let\next=\parsemmanyargdef@@
7382 \edef\tempb{\eatspaces{#1}}%
7383 \expandafter\def\expandafter\tempa
7384 \expandafter{\csname macarg.\tempb\endcsname}%
7385 % Note that we need some extra \noexpand\noexpand, this is because we
7386 % don't want \the to be expanded in the \parsermacbody as it uses an
7388 \expandafter\edef\tempa
7389 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7390 \advance\paramno by 1\relax
7393 % These two commands read recursive and nonrecursive macro bodies.
7394 % (They're different since rec and nonrec macros end differently.)
7397 \catcode `\@\texiatcatcode
7398 \long\def\parsemacbody#1@end macro%
7399 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7400 \long\def\parsermacbody#1@end rmacro%
7401 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7402 \catcode `\@=11\relax
7407 \long\def\nillm@{\nil@}%
7409 % This macro is expanded during the Texinfo macro expansion, not during its
7410 % definition. It gets all the arguments values and assigns them to macros
7413 % #1 is the macro name
7414 % #2 is the list of argument names
7415 % #3 is the list of argument values
7416 \def\getargvals@#1#2#3{%
7417 \def\macargdeflist@{}%
7418 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7419 \def\paramlist{#2,\nil@}%
7423 \def\argvaluelist{#3,\nil@}%
7434 \ifx\paramlist\nilm@
7435 % Some sanity check needed here that \argvaluelist is also empty.
7436 \ifx\argvaluelist\nillm@
7438 \errhelp = \EMsimple
7439 \errmessage{Too many arguments in macro `\macroname'!}%
7441 \let\next\macargexpandinbody@
7443 \ifx\argvaluelist\nillm@
7444 % No more arguments values passed to macro. Set remaining named-arg
7446 \let\next\setemptyargvalues@
7448 % pop current arg name into \@tempb
7449 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7450 \expandafter\@tempa\expandafter{\paramlist}%
7451 % pop current argument value into \@tempc
7452 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7453 \expandafter\@tempa\expandafter{\argvaluelist}%
7454 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7455 % First place the new argument macro definition into \@tempd
7456 \expandafter\macname\expandafter{\@tempc}%
7457 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7458 \expandafter\def\expandafter\@tempe\expandafter{%
7459 \csname macarg.\@tempb\endcsname}%
7460 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7461 \push@\@tempd\macargdeflist@
7462 \let\next\getargvals@@
7469 \expandafter\expandafter\expandafter\def
7470 \expandafter\expandafter\expandafter#2%
7471 \expandafter\expandafter\expandafter{%
7475 % Replace arguments by their values in the macro body, and place the result
7477 \def\macvalstoargs@{%
7478 % To do this we use the property that token registers that are \the'ed
7479 % within an \edef expand only once. So we are going to place all argument
7480 % values into respective token registers.
7482 % First we save the token context, and initialize argument numbering.
7485 % Then, for each argument number #N, we place the corresponding argument
7486 % value into a new token list register \toks#N
7487 \expandafter\putargsintokens@\saveparamlist@,;,%
7488 % Then, we expand the body so that argument are replaced by their
7489 % values. The trick for values not to be expanded themselves is that they
7490 % are within tokens and that tokens expand only once in an \edef .
7491 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7492 % Now we restore the token stack pointer to free the token list registers
7493 % which we have used, but we make sure that expanded body is saved after
7497 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7500 \def\macargexpandinbody@{%
7501 %% Define the named-macro outside of this group and then close this group.
7505 % First the replace in body the macro arguments by their values, the result
7508 % Then we point at the \norecurse or \gobble (for recursive) macro value
7510 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7511 % Depending on whether it is recursive or not, we need some tailing
7518 % And now we do the real job:
7519 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7523 \def\putargsintokens@#1,{%
7524 \if#1;\let\next\relax
7526 \let\next\putargsintokens@
7527 % First we allocate the new token list register, and give it a temporary
7529 \toksdef\@tempb\the\paramno
7530 % Then we place the argument value into that token list register.
7531 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7532 \expandafter\@tempb\expandafter{\@tempa}%
7533 \advance\paramno by 1\relax
7538 % Save the token stack pointer into macro #1
7539 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7540 % Restore the token stack pointer from number in macro #1
7541 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7542 % newtoks that can be used non \outer .
7543 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7545 % Tailing missing arguments are set to empty
7546 \def\setemptyargvalues@{%
7547 \ifx\paramlist\nilm@
7548 \let\next\macargexpandinbody@
7550 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7551 \let\next\setemptyargvalues@
7556 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7557 \expandafter\def\expandafter\@tempa\expandafter{%
7558 \expandafter\def\csname macarg.#1\endcsname{}}%
7559 \push@\@tempa\macargdeflist@
7563 % #1 is the element target macro
7564 % #2 is the list macro
7565 % #3,#4\endargs@ is the list value
7566 \def\pop@#1#2#3,#4\endargs@{%
7570 \long\def\longpop@#1#2#3,#4\endargs@{%
7575 % This defines a Texinfo @macro. There are eight cases: recursive and
7576 % nonrecursive macros of zero, one, up to nine, and many arguments.
7577 % Much magic with \expandafter here.
7578 % \xdef is used so that macro definitions will survive the file
7579 % they're defined in; @include reads the file inside a group.
7582 \let\hash=##% convert placeholders to macro parameter chars
7586 \expandafter\xdef\csname\the\macname\endcsname{%
7587 \noexpand\scanmacro{\temp}}%
7589 \expandafter\xdef\csname\the\macname\endcsname{%
7590 \bgroup\noexpand\macroargctxt
7591 \noexpand\braceorline
7592 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7593 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7594 \egroup\noexpand\scanmacro{\temp}}%
7596 \ifnum\paramno<10\relax % at most 9
7597 \expandafter\xdef\csname\the\macname\endcsname{%
7598 \bgroup\noexpand\macroargctxt
7599 \noexpand\csname\the\macname xx\endcsname}%
7600 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7601 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7602 \expandafter\expandafter
7604 \expandafter\expandafter
7605 \csname\the\macname xxx\endcsname
7606 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7608 \expandafter\xdef\csname\the\macname\endcsname{%
7609 \noexpand\getargvals@{\the\macname}{\argl}%
7611 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7612 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7618 \expandafter\xdef\csname\the\macname\endcsname{%
7619 \noexpand\norecurse{\the\macname}%
7620 \noexpand\scanmacro{\temp}\egroup}%
7622 \expandafter\xdef\csname\the\macname\endcsname{%
7623 \bgroup\noexpand\macroargctxt
7624 \noexpand\braceorline
7625 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7626 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7628 \noexpand\norecurse{\the\macname}%
7629 \noexpand\scanmacro{\temp}\egroup}%
7631 \ifnum\paramno<10\relax
7632 \expandafter\xdef\csname\the\macname\endcsname{%
7633 \bgroup\noexpand\macroargctxt
7634 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7635 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7636 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7637 \expandafter\expandafter
7639 \expandafter\expandafter
7640 \csname\the\macname xxx\endcsname
7643 \noexpand\norecurse{\the\macname}%
7644 \noexpand\scanmacro{\temp}\egroup}%
7646 \expandafter\xdef\csname\the\macname\endcsname{%
7647 \noexpand\getargvals@{\the\macname}{\argl}%
7649 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7650 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7655 \catcode `\@\texiatcatcode\relax
7657 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7659 % \braceorline decides whether the next nonwhitespace character is a
7660 % {. If so it reads up to the closing }, if not, it reads the whole
7661 % line. Whatever was read is then fed to the next control sequence
7662 % as an argument (by \parsebrace or \parsearg).
7664 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7665 \def\braceorlinexxx{%
7666 \ifx\nchar\bgroup\else
7667 \expandafter\parsearg
7672 % We need some trickery to remove the optional spaces around the equal
7673 % sign. Make them active and then expand them all to nothing.
7675 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7676 \def\aliasxxx #1{\aliasyyy#1\relax}
7677 \def\aliasyyy #1=#2\relax{%
7679 \expandafter\let\obeyedspace=\empty
7680 \addtomacrolist{#1}%
7681 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7687 \message{cross references,}
7690 \newif\ifhavexrefs % True if xref values are known.
7691 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7693 % @inforef is relatively simple.
7694 \def\inforef #1{\inforefzzz #1,,,,**}
7695 \def\inforefzzz #1,#2,#3,#4**{%
7696 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7697 node \samp{\ignorespaces#1{}}}
7699 % @node's only job in TeX is to define \lastnode, which is used in
7700 % cross-references. The @node line might or might not have commas, and
7701 % might or might not have spaces before the first comma, like:
7702 % @node foo , bar , ...
7703 % We don't want such trailing spaces in the node name.
7705 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7707 % also remove a trailing comma, in case of something like this:
7708 % @node Help-Cross, , , Cross-refs
7709 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7710 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7713 \let\lastnode=\empty
7715 % Write a cross-reference definition for the current node. #1 is the
7716 % type (Ynumbered, Yappendix, Ynothing).
7719 \ifx\lastnode\empty\else
7720 \setref{\lastnode}{#1}%
7721 \global\let\lastnode=\empty
7725 % @anchor{NAME} -- define xref target at arbitrary point.
7727 \newcount\savesfregister
7729 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7730 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7731 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7733 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7734 % anchor), which consists of three parts:
7735 % 1) NAME-title - the current sectioning name taken from \lastsection,
7736 % or the anchor name.
7737 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7738 % empty for anchors.
7739 % 3) NAME-pg - the page number.
7741 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7742 % floats, there is an additional part, which is not written here:
7743 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7749 \atdummies % preserve commands, but don't expand them
7750 \edef\writexrdef##1##2{%
7751 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7752 ##1}{##2}}% these are parameters of \writexrdef
7754 \toks0 = \expandafter{\lastsection}%
7755 \immediate \writexrdef{title}{\the\toks0 }%
7756 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7757 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7762 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7763 % automatically in xrefs, if the third arg is not explicitly specified.
7764 % This was provided as a "secret" @set xref-automatic-section-title
7765 % variable, now it's official.
7767 \parseargdef\xrefautomaticsectiontitle{%
7770 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7772 \else\ifx\temp\offword
7773 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7776 \errhelp = \EMsimple
7777 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7783 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7784 % the node name, #2 the name of the Info cross-reference, #3 the printed
7785 % node name, #4 the name of the Info file, #5 the name of the printed
7786 % manual. All but the node name can be omitted.
7788 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7789 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7790 \def\ref#1{\xrefX[#1,,,,,,,]}
7791 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7793 \def\printedmanual{\ignorespaces #5}%
7794 \def\printedrefname{\ignorespaces #3}%
7795 \setbox1=\hbox{\printedmanual\unskip}%
7796 \setbox0=\hbox{\printedrefname\unskip}%
7798 % No printed node name was explicitly given.
7799 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7800 % Use the node name inside the square brackets.
7801 \def\printedrefname{\ignorespaces #1}%
7803 % Use the actual chapter/section title appear inside
7804 % the square brackets. Use the real section title if we have it.
7806 % It is in another manual, so we don't have it.
7807 \def\printedrefname{\ignorespaces #1}%
7810 % We know the real title if we have the xref values.
7811 \def\printedrefname{\refx{#1-title}{}}%
7813 % Otherwise just copy the Info node name.
7814 \def\printedrefname{\ignorespaces #1}%
7820 % Make link in pdf output.
7824 % This expands tokens, so do it after making catcode changes, so _
7825 % etc. don't get their TeX definitions.
7828 % See comments at \activebackslashdouble.
7829 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7830 \backslashparens\pdfxrefdest}%
7833 \startlink attr{/Border [0 0 0]}%
7834 \ifnum\filenamelength>0
7835 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7837 goto name{\pdfmkpgn{\pdfxrefdest}}%
7840 \setcolor{\linkcolor}%
7843 % Float references are printed completely differently: "Figure 1.2"
7844 % instead of "[somenode], p.3". We distinguish them by the
7845 % LABEL-title being set to a magic string.
7847 % Have to otherify everything special to allow the \csname to
7848 % include an _ in the xref name, etc.
7851 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7852 \csname XR#1-title\endcsname
7854 \iffloat\Xthisreftitle
7855 % If the user specified the print name (third arg) to the ref,
7856 % print it instead of our usual "Figure 1.2".
7863 % if the user also gave the printed manual name (fifth arg), append
7866 \space \putwordin{} \cite{\printedmanual}%
7869 % node/anchor (non-float) references.
7871 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7872 % insert empty discretionaries after hyphens, which means that it will
7873 % not find a line break at a hyphen in a node names. Since some manuals
7874 % are best written with fairly long node names, containing hyphens, this
7875 % is a loss. Therefore, we give the text of the node name again, so it
7876 % is as if TeX is seeing it for the first time.
7878 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7880 % _ (for example) has to be the character _ for the purposes of the
7881 % control sequence corresponding to the node, but it has to expand
7882 % into the usual \leavevmode...\vrule stuff for purposes of
7883 % printing. So we \turnoffactive for the \refx-snt, back on for the
7884 % printing, back off for the \refx-pg.
7886 % Only output a following space if the -snt ref is nonempty; for
7887 % @unnumbered and @anchor, it won't be.
7888 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7889 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7891 % output the `[mynode]' via a macro so it can be overridden.
7892 \xrefprintnodename\printedrefname
7894 % But we always want a comma and a space:
7897 % output the `page 3'.
7898 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7904 % This macro is called from \xrefX for the `[nodename]' part of xref
7905 % output. It's a separate macro only so it can be changed more easily,
7906 % since square brackets don't work well in some documents. Particularly
7907 % one that Bob is working on :).
7909 \def\xrefprintnodename#1{[#1]}
7911 % Things referred to by \setref.
7917 \putwordChapter@tie \the\chapno
7918 \else \ifnum\subsecno=0
7919 \putwordSection@tie \the\chapno.\the\secno
7920 \else \ifnum\subsubsecno=0
7921 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7923 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7928 \putwordAppendix@tie @char\the\appendixno{}%
7929 \else \ifnum\subsecno=0
7930 \putwordSection@tie @char\the\appendixno.\the\secno
7931 \else \ifnum\subsubsecno=0
7932 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7935 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7939 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7940 % If its value is nonempty, SUFFIX is output afterward.
7946 \expandafter\global\expandafter\let\expandafter\thisrefX
7947 \csname XR#1\endcsname
7950 % If not defined, say something at least.
7951 \angleleft un\-de\-fined\angleright
7954 {\toks0 = {#1}% avoid expansion of possibly-complex value
7955 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
7958 \global\warnedxrefstrue
7959 \message{Cross reference values unknown; you must run TeX again.}%
7964 % It's defined, so just use it.
7967 #2% Output the suffix in any case.
7970 % This is the macro invoked by entries in the aux file. Usually it's
7971 % just a \def (we prepend XR to the control sequence name to avoid
7972 % collisions). But if this is a float type, we have more work to do.
7975 {% The node name might contain 8-bit characters, which in our current
7976 % implementation are changed to commands like @'e. Don't let these
7977 % mess up the control sequence name.
7980 \xdef\safexrefname{#1}%
7983 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7985 % Was that xref control sequence that we just defined for a float?
7986 \expandafter\iffloat\csname XR\safexrefname\endcsname
7987 % it was a float, and we have the (safe) float type in \iffloattype.
7988 \expandafter\let\expandafter\floatlist
7989 \csname floatlist\iffloattype\endcsname
7991 % Is this the first time we've seen this float type?
7992 \expandafter\ifx\floatlist\relax
7993 \toks0 = {\do}% yes, so just \do
7995 % had it before, so preserve previous elements in list.
7996 \toks0 = \expandafter{\floatlist\do}%
7999 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8000 % for later use in \listoffloats.
8001 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8006 % Read the last existing aux file, if any. No error if none exists.
8009 \openin 1 \jobname.aux
8012 \global\havexrefstrue
8017 \def\setupdatafile{%
8018 \catcode`\^^@=\other
8019 \catcode`\^^A=\other
8020 \catcode`\^^B=\other
8021 \catcode`\^^C=\other
8022 \catcode`\^^D=\other
8023 \catcode`\^^E=\other
8024 \catcode`\^^F=\other
8025 \catcode`\^^G=\other
8026 \catcode`\^^H=\other
8027 \catcode`\^^K=\other
8028 \catcode`\^^L=\other
8029 \catcode`\^^N=\other
8030 \catcode`\^^P=\other
8031 \catcode`\^^Q=\other
8032 \catcode`\^^R=\other
8033 \catcode`\^^S=\other
8034 \catcode`\^^T=\other
8035 \catcode`\^^U=\other
8036 \catcode`\^^V=\other
8037 \catcode`\^^W=\other
8038 \catcode`\^^X=\other
8039 \catcode`\^^Z=\other
8040 \catcode`\^^[=\other
8041 \catcode`\^^\=\other
8042 \catcode`\^^]=\other
8043 \catcode`\^^^=\other
8044 \catcode`\^^_=\other
8045 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8046 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8047 % supported in the main text, it doesn't seem desirable. Furthermore,
8048 % that is not enough: for node names that actually contain a ^
8049 % character, we would end up writing a line like this: 'xrdef {'hat
8050 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8051 % argument, and \hat is not an expandable control sequence. It could
8052 % all be worked out, but why? Either we support ^^ or we don't.
8054 % The other change necessary for this was to define \auxhat:
8055 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8056 % and then to call \auxhat in \setq.
8060 % Special characters. Should be turned off anyway, but...
8073 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8075 % This is to support \ in node names and titles, since the \
8076 % characters end up in a \csname. It's easier than
8077 % leaving it active and making its active definition an actual \
8078 % character. What I don't understand is why it works in the *value*
8079 % of the xrdef. Seems like it should be a catcode12 \, and that
8080 % should not typeset properly. But it works, so I'm moving on for
8081 % now. --karl, 15jan04.
8084 % Make the characters 128-255 be printing characters.
8088 \catcode\count1=\other
8089 \advance\count1 by 1
8090 \ifnum \count1<256 \loop \fi
8094 % @ is our escape character in .aux files, and we need braces.
8100 \def\readdatafile#1{%
8107 \message{insertions,}
8108 % including footnotes.
8110 \newcount \footnoteno
8112 % The trailing space in the following definition for supereject is
8113 % vital for proper filling; pages come out unaligned when you do a
8114 % pagealignmacro call if that space before the closing brace is
8115 % removed. (Generally, numeric constants should always be followed by a
8116 % space to prevent strange expansion errors.)
8117 \def\supereject{\par\penalty -20000\footnoteno =0 }
8119 % @footnotestyle is meaningful for Info output only.
8120 \let\footnotestyle=\comment
8124 % Auto-number footnotes. Otherwise like plain.
8126 \let\indent=\ptexindent
8127 \let\noindent=\ptexnoindent
8128 \global\advance\footnoteno by \@ne
8129 \edef\thisfootno{$^{\the\footnoteno}$}%
8131 % In case the footnote comes at the end of a sentence, preserve the
8132 % extra spacing after we do the footnote number.
8134 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8136 % Remove inadvertent blank space before typesetting the footnote number.
8142 % Don't bother with the trickery in plain.tex to not require the
8143 % footnote text as a parameter. Our footnotes don't need to be so general.
8145 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8146 % \parseargline) fails inside footnotes because the tokens are fixed when
8147 % the footnote is read. --karl, 16nov96.
8150 \insert\footins\bgroup
8151 % We want to typeset this text as a normal paragraph, even if the
8152 % footnote reference occurs in (for example) a display environment.
8153 % So reset some parameters.
8155 \interlinepenalty\interfootnotelinepenalty
8156 \splittopskip\ht\strutbox % top baseline for broken footnotes
8157 \splitmaxdepth\dp\strutbox
8158 \floatingpenalty\@MM
8163 \parindent\defaultparindent
8167 % Because we use hanging indentation in footnotes, a @noindent appears
8168 % to exdent this text, so make it be a no-op. makeinfo does not use
8169 % hanging indentation so @noindent can still be needed within footnote
8170 % text after an @example or the like (not that this is good style).
8171 \let\noindent = \relax
8173 % Hang the footnote text off the number. Use \everypar in case the
8174 % footnote extends for more than one paragraph.
8175 \everypar = {\hang}%
8176 \textindent{\thisfootno}%
8178 % Don't crash into the line above the footnote text. Since this
8179 % expands into a box, it must come within the paragraph, lest it
8180 % provide a place where TeX can split the footnote.
8183 % Invoke rest of plain TeX footnote routine.
8184 \futurelet\next\fo@t
8186 }%end \catcode `\@=11
8188 % In case a @footnote appears in a vbox, save the footnote text and create
8189 % the real \insert just after the vbox finished. Otherwise, the insertion
8191 % Similarly, if a @footnote appears inside an alignment, save the footnote
8192 % text to a box and make the \insert when a row of the table is finished.
8193 % And the same can be done for other insert classes. --kasal, 16nov03.
8195 % Replace the \insert primitive by a cheating macro.
8196 % Deeper inside, just make sure that the saved insertions are not spilled
8199 \def\startsavinginserts{%
8200 \ifx \insert\ptexinsert
8201 \let\insert\saveinsert
8203 \let\checkinserts\relax
8207 % This \insert replacement works for both \insert\footins{foo} and
8208 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8211 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8212 \afterassignment\next
8213 % swallow the left brace
8216 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8217 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8219 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8221 \def\placesaveins#1{%
8222 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8226 % eat @SAVE -- beware, all of them have catcode \other:
8228 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8229 \gdef\gobblesave @SAVE{}
8233 \def\newsaveins #1{%
8234 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8237 \def\newsaveinsX #1{%
8238 \csname newbox\endcsname #1%
8239 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8244 \let\checkinserts\empty
8249 % @image. We use the macros from epsf.tex to support this.
8250 % If epsf.tex is not installed and @image is used, we complain.
8252 % Check for and read epsf.tex up front. If we read it only at @image
8253 % time, we might be inside a group, and then its definitions would get
8254 % undone and the next image would fail.
8255 \openin 1 = epsf.tex
8257 % Do not bother showing banner with epsf.tex v2.7k (available in
8258 % doc/epsf.tex and on ctan).
8259 \def\epsfannounce{\toks0 = }%
8264 % We will only complain once about lack of epsf.tex.
8265 \newif\ifwarnednoepsf
8266 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8267 work. It is also included in the Texinfo distribution, or you can get
8268 it from ftp://tug.org/tex/epsf.tex.}
8271 \ifx\epsfbox\thisiundefined
8272 \ifwarnednoepsf \else
8273 \errhelp = \noepsfhelp
8274 \errmessage{epsf.tex not found, images will be ignored}%
8275 \global\warnednoepsftrue
8278 \imagexxx #1,,,,,\finish
8282 % Arguments to @image:
8283 % #1 is (mandatory) image filename; we tack on .eps extension.
8284 % #2 is (optional) width, #3 is (optional) height.
8285 % #4 is (ignored optional) html alt text.
8286 % #5 is (ignored optional) extension.
8287 % #6 is just the usual extra ignored arg for parsing stuff.
8289 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8290 \catcode`\^^M = 5 % in case we're inside an example
8291 \normalturnoffactive % allow _ et al. in names
8292 % If the image is by itself, center it.
8296 % Usually we'll have text after the image which will insert
8297 % \parskip glue, so insert it here too to equalize the space
8299 \nobreak\vskip\parskip
8303 % Leave vertical mode so that indentation from an enclosing
8304 % environment such as @quotation is respected. On the other hand, if
8305 % it's at the top level, we don't want the normal paragraph indentation.
8310 \dopdfimage{#1}{#2}{#3}%
8312 % \epsfbox itself resets \epsf?size at each figure.
8313 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8314 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8318 \ifimagevmode \medskip \fi % space after the standalone image
8322 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8323 % etc. We don't actually implement floating yet, we always include the
8324 % float "here". But it seemed the best name for the future.
8326 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8328 % There may be a space before second and/or third parameter; delete it.
8329 \def\eatcommaspace#1, {#1,}
8331 % #1 is the optional FLOATTYPE, the text label for this float, typically
8332 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8333 % this float will not be numbered and cannot be referred to.
8335 % #2 is the optional xref label. Also must be present for the float to
8338 % #3 is the optional positioning argument; for now, it is ignored. It
8339 % will somehow specify the positions allowed to float to (here, top, bottom).
8341 % We keep a separate counter for each FLOATTYPE, which we reset at each
8342 % chapter-level command.
8343 \let\resetallfloatnos=\empty
8345 \def\dofloat#1,#2,#3,#4\finish{%
8346 \let\thiscaption=\empty
8347 \let\thisshortcaption=\empty
8349 % don't lose footnotes inside @float.
8351 % BEWARE: when the floats start float, we have to issue warning whenever an
8352 % insert appears inside a float which could possibly float. --kasal, 26may04
8356 % We can't be used inside a paragraph.
8361 \def\floatlabel{#2}%
8362 \def\floatloc{#3}% we do nothing with this yet.
8364 \ifx\floattype\empty
8365 \let\safefloattype=\empty
8368 % the floattype might have accents or other special characters,
8369 % but we need to use it in a control sequence name.
8372 \xdef\safefloattype{\floattype}%
8376 % If label is given but no type, we handle that as the empty type.
8377 \ifx\floatlabel\empty \else
8378 % We want each FLOATTYPE to be numbered separately (Figure 1,
8379 % Table 1, Figure 2, ...). (And if no label, no number.)
8381 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8382 \global\advance\floatno by 1
8385 % This magic value for \lastsection is output by \setref as the
8386 % XREFLABEL-title value. \xrefX uses it to distinguish float
8387 % labels (which have a completely different output format) from
8388 % node and anchor labels. And \xrdef uses it to construct the
8391 \edef\lastsection{\floatmagic=\safefloattype}%
8392 \setref{\floatlabel}{Yfloat}%
8396 % start with \parskip glue, I guess.
8399 % Don't suppress indentation if a float happens to start a section.
8400 \restorefirstparagraphindent
8403 % we have these possibilities:
8404 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8405 % @float Foo,lbl & no caption: Foo 1.1
8406 % @float Foo & @caption{Cap}: Foo: Cap
8407 % @float Foo & no caption: Foo
8408 % @float ,lbl & Caption{Cap}: 1.1: Cap
8409 % @float ,lbl & no caption: 1.1
8410 % @float & @caption{Cap}: Cap
8411 % @float & no caption:
8414 \let\floatident = \empty
8416 % In all cases, if we have a float type, it comes first.
8417 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8419 % If we have an xref label, the number comes next.
8420 \ifx\floatlabel\empty \else
8421 \ifx\floattype\empty \else % if also had float type, need tie first.
8422 \appendtomacro\floatident{\tie}%
8425 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8428 % Start the printed caption with what we've constructed in
8429 % \floatident, but keep it separate; we need \floatident again.
8430 \let\captionline = \floatident
8432 \ifx\thiscaption\empty \else
8433 \ifx\floatident\empty \else
8434 \appendtomacro\captionline{: }% had ident, so need a colon between
8438 \appendtomacro\captionline{\scanexp\thiscaption}%
8441 % If we have anything to print, print it, with space before.
8442 % Eventually this needs to become an \insert.
8443 \ifx\captionline\empty \else
8447 % Space below caption.
8451 % If have an xref label, write the list of floats info. Do this
8452 % after the caption, to avoid chance of it being a breakpoint.
8453 \ifx\floatlabel\empty \else
8454 % Write the text that goes in the lof to the aux file as
8455 % \floatlabel-lof. Besides \floatident, we include the short
8456 % caption if specified, else the full caption if specified, else nothing.
8460 % since we read the caption text in the macro world, where ^^M
8461 % is turned into a normal character, we have to scan it back, so
8462 % we don't write the literal three characters "^^M" into the aux file.
8464 \xdef\noexpand\gtemp{%
8465 \ifx\thisshortcaption\empty
8472 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8473 \ifx\gtemp\empty \else : \gtemp \fi}}%
8476 \egroup % end of \vtop
8478 % place the captured inserts
8480 % BEWARE: when the floats start floating, we have to issue warning
8481 % whenever an insert appears inside a float which could possibly
8482 % float. --kasal, 26may04
8487 % Append the tokens #2 to the definition of macro #1, not expanding either.
8489 \def\appendtomacro#1#2{%
8490 \expandafter\def\expandafter#1\expandafter{#1#2}%
8493 % @caption, @shortcaption
8495 \def\caption{\docaption\thiscaption}
8496 \def\shortcaption{\docaption\thisshortcaption}
8497 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8498 \def\defcaption#1#2{\egroup \def#1{#2}}
8500 % The parameter is the control sequence identifying the counter we are
8501 % going to use. Create it if it doesn't exist and assign it to \floatno.
8504 % Haven't seen this figure type before.
8505 \csname newcount\endcsname #1%
8507 % Remember to reset this floatno at the next chap.
8508 \expandafter\gdef\expandafter\resetallfloatnos
8509 \expandafter{\resetallfloatnos #1=0 }%
8514 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8515 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8516 % first read the @float command.
8518 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8520 % Magic string used for the XREFLABEL-title value, so \xrefX can
8521 % distinguish floats from other xref types.
8522 \def\floatmagic{!!float!!}
8524 % #1 is the control sequence we are passed; we expand into a conditional
8525 % which is true if #1 represents a float ref. That is, the magic
8526 % \lastsection value which we \setref above.
8528 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8530 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8531 % (safe) float type for this float. We set \iffloattype to #2.
8533 \def\doiffloat#1=#2=#3\finish{%
8535 \def\iffloattype{#2}%
8536 \ifx\temp\floatmagic
8539 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8541 \parseargdef\listoffloats{%
8542 \def\floattype{#1}% floattype
8544 % the floattype might have accents or other special characters,
8545 % but we need to use it in a control sequence name.
8548 \xdef\safefloattype{\floattype}%
8551 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8552 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8554 % if the user said @listoffloats foo but never @float foo.
8555 \message{\linenumber No `\safefloattype' floats to list.}%
8559 \leftskip=\tocindent % indent these entries like a toc
8560 \let\do=\listoffloatsdo
8561 \csname floatlist\safefloattype\endcsname
8566 % This is called on each entry in a list of floats. We're passed the
8567 % xref label, in the form LABEL-title, which is how we save it in the
8568 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8569 % has the text we're supposed to typeset here.
8571 % Figures without xref labels will not be included in the list (since
8572 % they won't appear in the aux file).
8574 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8575 \def\listoffloatsdoentry#1-title\finish{{%
8576 % Can't fully expand XR#1-lof because it can contain anything. Just
8577 % pass the control sequence. On the other hand, XR#1-pg is just the
8578 % page number, and we want to fully expand that so we can get a link
8580 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8582 % use the same \entry macro we use to generate the TOC and index.
8583 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8588 \message{localization,}
8590 % For single-language documents, @documentlanguage is usually given very
8591 % early, just after @documentencoding. Single argument is the language
8592 % (de) or locale (de_DE) abbreviation.
8595 \catcode`\_ = \active
8597 \parseargdef\documentlanguage{\begingroup
8598 \let_=\normalunderscore % normal _ character for filenames
8599 \tex % read txi-??.tex file in plain TeX.
8600 % Read the file by the name they passed if it exists.
8601 \openin 1 txi-#1.tex
8603 \documentlanguagetrywithoutunderscore{#1_\finish}%
8605 \globaldefs = 1 % everything in the txi-LL files needs to persist
8609 \endgroup % end raw TeX
8612 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8615 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8616 \openin 1 txi-#1.tex
8618 \errhelp = \nolanghelp
8619 \errmessage{Cannot read language file txi-#1.tex}%
8621 \globaldefs = 1 % everything in the txi-LL files needs to persist
8626 }% end of special _ catcode
8628 \newhelp\nolanghelp{The given language definition file cannot be found or
8629 is empty. Maybe you need to install it? Putting it in the current
8630 directory should work if nowhere else does.}
8632 % This macro is called from txi-??.tex files; the first argument is the
8633 % \language name to set (without the "\lang@" prefix), the second and
8634 % third args are \{left,right}hyphenmin.
8636 % The language names to pass are determined when the format is built.
8637 % See the etex.log file created at that time, e.g.,
8638 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8640 % With TeX Live 2008, etex now includes hyphenation patterns for all
8641 % available languages. This means we can support hyphenation in
8642 % Texinfo, at least to some extent. (This still doesn't solve the
8643 % accented characters problem.)
8646 \def\txisetlanguage#1#2#3{%
8647 % do not set the language if the name is undefined in the current TeX.
8648 \expandafter\ifx\csname lang@#1\endcsname \relax
8649 \message{no patterns for #1}%
8651 \global\language = \csname lang@#1\endcsname
8653 % but there is no harm in adjusting the hyphenmin values regardless.
8654 \global\lefthyphenmin = #2\relax
8655 \global\righthyphenmin = #3\relax
8658 % Helpers for encodings.
8659 % Set the catcode of characters 128 through 255 to the specified number.
8661 \def\setnonasciicharscatcode#1{%
8663 \loop\ifnum\count255<256
8664 \global\catcode\count255=#1\relax
8665 \advance\count255 by 1
8669 \def\setnonasciicharscatcodenonglobal#1{%
8671 \loop\ifnum\count255<256
8672 \catcode\count255=#1\relax
8673 \advance\count255 by 1
8677 % @documentencoding sets the definition of non-ASCII characters
8678 % according to the specified encoding.
8680 \parseargdef\documentencoding{%
8681 % Encoding being declared for the document.
8682 \def\declaredencoding{\csname #1.enc\endcsname}%
8684 % Supported encodings: names converted to tokens in order to be able
8685 % to compare them with \ifx.
8686 \def\ascii{\csname US-ASCII.enc\endcsname}%
8687 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8688 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8689 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8690 \def\utfeight{\csname UTF-8.enc\endcsname}%
8692 \ifx \declaredencoding \ascii
8695 \else \ifx \declaredencoding \lattwo
8696 \setnonasciicharscatcode\active
8699 \else \ifx \declaredencoding \latone
8700 \setnonasciicharscatcode\active
8703 \else \ifx \declaredencoding \latnine
8704 \setnonasciicharscatcode\active
8707 \else \ifx \declaredencoding \utfeight
8708 \setnonasciicharscatcode\active
8712 \message{Unknown document encoding #1, ignoring.}%
8721 % A message to be logged when using a character that isn't available
8722 % the default font encoding (OT1).
8724 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8726 % Take account of \c (plain) vs. \, (Texinfo) difference.
8727 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8729 % First, make active non-ASCII characters in order for them to be
8730 % correctly categorized when TeX reads the replacement text of
8731 % macros containing the character definitions.
8732 \setnonasciicharscatcode\active
8734 % Latin1 (ISO-8859-1) character definitions.
8735 \def\latonechardefs{%
8737 \gdef^^a1{\exclamdown}
8738 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8739 \gdef^^a3{{\pounds}}
8740 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8741 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8742 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8745 \gdef^^a9{\copyright}
8747 \gdef^^ab{\guillemetleft}
8750 \gdef^^ae{\registeredsymbol}
8753 \gdef^^b0{\textdegree}
8762 \gdef^^b8{\cedilla\ }
8766 \gdef^^bb{\guillemetright}
8767 \gdef^^bc{$1\over4$}
8768 \gdef^^bd{$1\over2$}
8769 \gdef^^be{$3\over4$}
8770 \gdef^^bf{\questiondown}
8777 \gdef^^c5{\ringaccent A}
8779 \gdef^^c7{\cedilla C}
8811 \gdef^^e5{\ringaccent a}
8813 \gdef^^e7{\cedilla c}
8818 \gdef^^ec{\`{\dotless i}}
8819 \gdef^^ed{\'{\dotless i}}
8820 \gdef^^ee{\^{\dotless i}}
8821 \gdef^^ef{\"{\dotless i}}
8841 % Latin9 (ISO-8859-15) encoding character definitions.
8842 \def\latninechardefs{%
8843 % Encoding is almost identical to Latin1.
8856 % Latin2 (ISO-8859-2) character definitions.
8857 \def\lattwochardefs{%
8859 \gdef^^a1{\ogonek{A}}
8862 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8868 \gdef^^aa{\cedilla S}
8873 \gdef^^af{\dotaccent Z}
8875 \gdef^^b0{\textdegree}
8876 \gdef^^b1{\ogonek{a}}
8877 \gdef^^b2{\ogonek{ }}
8883 \gdef^^b8{\cedilla\ }
8885 \gdef^^ba{\cedilla s}
8890 \gdef^^bf{\dotaccent z}
8899 \gdef^^c7{\cedilla C}
8902 \gdef^^ca{\ogonek{E}}
8918 \gdef^^d9{\ringaccent U}
8923 \gdef^^de{\cedilla T}
8933 \gdef^^e7{\cedilla c}
8936 \gdef^^ea{\ogonek{e}}
8939 \gdef^^ed{\'{\dotless{i}}}
8940 \gdef^^ee{\^{\dotless{i}}}
8952 \gdef^^f9{\ringaccent u}
8957 \gdef^^fe{\cedilla t}
8958 \gdef^^ff{\dotaccent{}}
8961 % UTF-8 character definitions.
8963 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8964 % changes for Texinfo conventions. It is included here under the GPL by
8965 % permission from Frank Mittelbach and the LaTeX team.
8971 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8972 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8974 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8975 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8977 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8978 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8980 \gdef\UTFviiiDefined#1{%
8982 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8993 \global\catcode\countUTFx\active
8994 \uccode`\~\countUTFx
8995 \uppercase\expandafter{\UTFviiiTmp}%
8996 \advance\countUTFx by 1
8997 \ifnum\countUTFx < \countUTFy
8998 \expandafter\UTFviiiLoop
9004 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9010 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9016 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9029 \gdef\DeclareUnicodeCharacter#1#2{%
9030 \countUTFz = "#1\relax
9031 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9034 \def\UTFviiiTwoOctets##1##2{%
9035 \csname u8:##1\string ##2\endcsname}%
9036 \def\UTFviiiThreeOctets##1##2##3{%
9037 \csname u8:##1\string ##2\string ##3\endcsname}%
9038 \def\UTFviiiFourOctets##1##2##3##4{%
9039 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9040 \expandafter\expandafter\expandafter\expandafter
9041 \expandafter\expandafter\expandafter
9042 \gdef\UTFviiiTmp{#2}%
9045 \gdef\parseXMLCharref{%
9046 \ifnum\countUTFz < "A0\relax
9047 \errhelp = \EMsimple
9048 \errmessage{Cannot define Unicode char value < 00A0}%
9049 \else\ifnum\countUTFz < "800\relax
9051 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9052 \else\ifnum\countUTFz < "10000\relax
9055 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9060 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9064 \gdef\parseUTFviiiA#1{%
9065 \countUTFx = \countUTFz
9066 \divide\countUTFz by 64
9067 \countUTFy = \countUTFz
9068 \multiply\countUTFz by 64
9069 \advance\countUTFx by -\countUTFz
9070 \advance\countUTFx by 128
9071 \uccode `#1\countUTFx
9072 \countUTFz = \countUTFy}
9074 \gdef\parseUTFviiiB#1#2#3#4{%
9075 \advance\countUTFz by "#10\relax
9076 \uccode `#3\countUTFz
9077 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9080 \def\utfeightchardefs{%
9081 \DeclareUnicodeCharacter{00A0}{\tie}
9082 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9083 \DeclareUnicodeCharacter{00A3}{\pounds}
9084 \DeclareUnicodeCharacter{00A8}{\"{ }}
9085 \DeclareUnicodeCharacter{00A9}{\copyright}
9086 \DeclareUnicodeCharacter{00AA}{\ordf}
9087 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9088 \DeclareUnicodeCharacter{00AD}{\-}
9089 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9090 \DeclareUnicodeCharacter{00AF}{\={ }}
9092 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9093 \DeclareUnicodeCharacter{00B4}{\'{ }}
9094 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9095 \DeclareUnicodeCharacter{00BA}{\ordm}
9096 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9097 \DeclareUnicodeCharacter{00BF}{\questiondown}
9099 \DeclareUnicodeCharacter{00C0}{\`A}
9100 \DeclareUnicodeCharacter{00C1}{\'A}
9101 \DeclareUnicodeCharacter{00C2}{\^A}
9102 \DeclareUnicodeCharacter{00C3}{\~A}
9103 \DeclareUnicodeCharacter{00C4}{\"A}
9104 \DeclareUnicodeCharacter{00C5}{\AA}
9105 \DeclareUnicodeCharacter{00C6}{\AE}
9106 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9107 \DeclareUnicodeCharacter{00C8}{\`E}
9108 \DeclareUnicodeCharacter{00C9}{\'E}
9109 \DeclareUnicodeCharacter{00CA}{\^E}
9110 \DeclareUnicodeCharacter{00CB}{\"E}
9111 \DeclareUnicodeCharacter{00CC}{\`I}
9112 \DeclareUnicodeCharacter{00CD}{\'I}
9113 \DeclareUnicodeCharacter{00CE}{\^I}
9114 \DeclareUnicodeCharacter{00CF}{\"I}
9116 \DeclareUnicodeCharacter{00D0}{\DH}
9117 \DeclareUnicodeCharacter{00D1}{\~N}
9118 \DeclareUnicodeCharacter{00D2}{\`O}
9119 \DeclareUnicodeCharacter{00D3}{\'O}
9120 \DeclareUnicodeCharacter{00D4}{\^O}
9121 \DeclareUnicodeCharacter{00D5}{\~O}
9122 \DeclareUnicodeCharacter{00D6}{\"O}
9123 \DeclareUnicodeCharacter{00D8}{\O}
9124 \DeclareUnicodeCharacter{00D9}{\`U}
9125 \DeclareUnicodeCharacter{00DA}{\'U}
9126 \DeclareUnicodeCharacter{00DB}{\^U}
9127 \DeclareUnicodeCharacter{00DC}{\"U}
9128 \DeclareUnicodeCharacter{00DD}{\'Y}
9129 \DeclareUnicodeCharacter{00DE}{\TH}
9130 \DeclareUnicodeCharacter{00DF}{\ss}
9132 \DeclareUnicodeCharacter{00E0}{\`a}
9133 \DeclareUnicodeCharacter{00E1}{\'a}
9134 \DeclareUnicodeCharacter{00E2}{\^a}
9135 \DeclareUnicodeCharacter{00E3}{\~a}
9136 \DeclareUnicodeCharacter{00E4}{\"a}
9137 \DeclareUnicodeCharacter{00E5}{\aa}
9138 \DeclareUnicodeCharacter{00E6}{\ae}
9139 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9140 \DeclareUnicodeCharacter{00E8}{\`e}
9141 \DeclareUnicodeCharacter{00E9}{\'e}
9142 \DeclareUnicodeCharacter{00EA}{\^e}
9143 \DeclareUnicodeCharacter{00EB}{\"e}
9144 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9145 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9146 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9147 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9149 \DeclareUnicodeCharacter{00F0}{\dh}
9150 \DeclareUnicodeCharacter{00F1}{\~n}
9151 \DeclareUnicodeCharacter{00F2}{\`o}
9152 \DeclareUnicodeCharacter{00F3}{\'o}
9153 \DeclareUnicodeCharacter{00F4}{\^o}
9154 \DeclareUnicodeCharacter{00F5}{\~o}
9155 \DeclareUnicodeCharacter{00F6}{\"o}
9156 \DeclareUnicodeCharacter{00F8}{\o}
9157 \DeclareUnicodeCharacter{00F9}{\`u}
9158 \DeclareUnicodeCharacter{00FA}{\'u}
9159 \DeclareUnicodeCharacter{00FB}{\^u}
9160 \DeclareUnicodeCharacter{00FC}{\"u}
9161 \DeclareUnicodeCharacter{00FD}{\'y}
9162 \DeclareUnicodeCharacter{00FE}{\th}
9163 \DeclareUnicodeCharacter{00FF}{\"y}
9165 \DeclareUnicodeCharacter{0100}{\=A}
9166 \DeclareUnicodeCharacter{0101}{\=a}
9167 \DeclareUnicodeCharacter{0102}{\u{A}}
9168 \DeclareUnicodeCharacter{0103}{\u{a}}
9169 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9170 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9171 \DeclareUnicodeCharacter{0106}{\'C}
9172 \DeclareUnicodeCharacter{0107}{\'c}
9173 \DeclareUnicodeCharacter{0108}{\^C}
9174 \DeclareUnicodeCharacter{0109}{\^c}
9175 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9176 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9177 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9178 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9179 \DeclareUnicodeCharacter{010C}{\v{C}}
9180 \DeclareUnicodeCharacter{010D}{\v{c}}
9181 \DeclareUnicodeCharacter{010E}{\v{D}}
9183 \DeclareUnicodeCharacter{0112}{\=E}
9184 \DeclareUnicodeCharacter{0113}{\=e}
9185 \DeclareUnicodeCharacter{0114}{\u{E}}
9186 \DeclareUnicodeCharacter{0115}{\u{e}}
9187 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9188 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9189 \DeclareUnicodeCharacter{011A}{\v{E}}
9190 \DeclareUnicodeCharacter{011B}{\v{e}}
9191 \DeclareUnicodeCharacter{011C}{\^G}
9192 \DeclareUnicodeCharacter{011D}{\^g}
9193 \DeclareUnicodeCharacter{011E}{\u{G}}
9194 \DeclareUnicodeCharacter{011F}{\u{g}}
9196 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9197 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9198 \DeclareUnicodeCharacter{0124}{\^H}
9199 \DeclareUnicodeCharacter{0125}{\^h}
9200 \DeclareUnicodeCharacter{0128}{\~I}
9201 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9202 \DeclareUnicodeCharacter{012A}{\=I}
9203 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9204 \DeclareUnicodeCharacter{012C}{\u{I}}
9205 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9207 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9208 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9209 \DeclareUnicodeCharacter{0132}{IJ}
9210 \DeclareUnicodeCharacter{0133}{ij}
9211 \DeclareUnicodeCharacter{0134}{\^J}
9212 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9213 \DeclareUnicodeCharacter{0139}{\'L}
9214 \DeclareUnicodeCharacter{013A}{\'l}
9216 \DeclareUnicodeCharacter{0141}{\L}
9217 \DeclareUnicodeCharacter{0142}{\l}
9218 \DeclareUnicodeCharacter{0143}{\'N}
9219 \DeclareUnicodeCharacter{0144}{\'n}
9220 \DeclareUnicodeCharacter{0147}{\v{N}}
9221 \DeclareUnicodeCharacter{0148}{\v{n}}
9222 \DeclareUnicodeCharacter{014C}{\=O}
9223 \DeclareUnicodeCharacter{014D}{\=o}
9224 \DeclareUnicodeCharacter{014E}{\u{O}}
9225 \DeclareUnicodeCharacter{014F}{\u{o}}
9227 \DeclareUnicodeCharacter{0150}{\H{O}}
9228 \DeclareUnicodeCharacter{0151}{\H{o}}
9229 \DeclareUnicodeCharacter{0152}{\OE}
9230 \DeclareUnicodeCharacter{0153}{\oe}
9231 \DeclareUnicodeCharacter{0154}{\'R}
9232 \DeclareUnicodeCharacter{0155}{\'r}
9233 \DeclareUnicodeCharacter{0158}{\v{R}}
9234 \DeclareUnicodeCharacter{0159}{\v{r}}
9235 \DeclareUnicodeCharacter{015A}{\'S}
9236 \DeclareUnicodeCharacter{015B}{\'s}
9237 \DeclareUnicodeCharacter{015C}{\^S}
9238 \DeclareUnicodeCharacter{015D}{\^s}
9239 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9240 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9242 \DeclareUnicodeCharacter{0160}{\v{S}}
9243 \DeclareUnicodeCharacter{0161}{\v{s}}
9244 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9245 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9246 \DeclareUnicodeCharacter{0164}{\v{T}}
9248 \DeclareUnicodeCharacter{0168}{\~U}
9249 \DeclareUnicodeCharacter{0169}{\~u}
9250 \DeclareUnicodeCharacter{016A}{\=U}
9251 \DeclareUnicodeCharacter{016B}{\=u}
9252 \DeclareUnicodeCharacter{016C}{\u{U}}
9253 \DeclareUnicodeCharacter{016D}{\u{u}}
9254 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9255 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9257 \DeclareUnicodeCharacter{0170}{\H{U}}
9258 \DeclareUnicodeCharacter{0171}{\H{u}}
9259 \DeclareUnicodeCharacter{0174}{\^W}
9260 \DeclareUnicodeCharacter{0175}{\^w}
9261 \DeclareUnicodeCharacter{0176}{\^Y}
9262 \DeclareUnicodeCharacter{0177}{\^y}
9263 \DeclareUnicodeCharacter{0178}{\"Y}
9264 \DeclareUnicodeCharacter{0179}{\'Z}
9265 \DeclareUnicodeCharacter{017A}{\'z}
9266 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9267 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9268 \DeclareUnicodeCharacter{017D}{\v{Z}}
9269 \DeclareUnicodeCharacter{017E}{\v{z}}
9271 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9272 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9273 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9274 \DeclareUnicodeCharacter{01C7}{LJ}
9275 \DeclareUnicodeCharacter{01C8}{Lj}
9276 \DeclareUnicodeCharacter{01C9}{lj}
9277 \DeclareUnicodeCharacter{01CA}{NJ}
9278 \DeclareUnicodeCharacter{01CB}{Nj}
9279 \DeclareUnicodeCharacter{01CC}{nj}
9280 \DeclareUnicodeCharacter{01CD}{\v{A}}
9281 \DeclareUnicodeCharacter{01CE}{\v{a}}
9282 \DeclareUnicodeCharacter{01CF}{\v{I}}
9284 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9285 \DeclareUnicodeCharacter{01D1}{\v{O}}
9286 \DeclareUnicodeCharacter{01D2}{\v{o}}
9287 \DeclareUnicodeCharacter{01D3}{\v{U}}
9288 \DeclareUnicodeCharacter{01D4}{\v{u}}
9290 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9291 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9292 \DeclareUnicodeCharacter{01E6}{\v{G}}
9293 \DeclareUnicodeCharacter{01E7}{\v{g}}
9294 \DeclareUnicodeCharacter{01E8}{\v{K}}
9295 \DeclareUnicodeCharacter{01E9}{\v{k}}
9297 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9298 \DeclareUnicodeCharacter{01F1}{DZ}
9299 \DeclareUnicodeCharacter{01F2}{Dz}
9300 \DeclareUnicodeCharacter{01F3}{dz}
9301 \DeclareUnicodeCharacter{01F4}{\'G}
9302 \DeclareUnicodeCharacter{01F5}{\'g}
9303 \DeclareUnicodeCharacter{01F8}{\`N}
9304 \DeclareUnicodeCharacter{01F9}{\`n}
9305 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9306 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9307 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9308 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9310 \DeclareUnicodeCharacter{021E}{\v{H}}
9311 \DeclareUnicodeCharacter{021F}{\v{h}}
9313 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9314 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9315 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9316 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9317 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9318 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9320 \DeclareUnicodeCharacter{0232}{\=Y}
9321 \DeclareUnicodeCharacter{0233}{\=y}
9322 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9324 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9326 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9327 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9328 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9329 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9330 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9331 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9332 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9333 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9334 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9335 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9336 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9337 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9339 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9340 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9342 \DeclareUnicodeCharacter{1E20}{\=G}
9343 \DeclareUnicodeCharacter{1E21}{\=g}
9344 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9345 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9346 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9347 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9348 \DeclareUnicodeCharacter{1E26}{\"H}
9349 \DeclareUnicodeCharacter{1E27}{\"h}
9351 \DeclareUnicodeCharacter{1E30}{\'K}
9352 \DeclareUnicodeCharacter{1E31}{\'k}
9353 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9354 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9355 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9356 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9357 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9358 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9359 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9360 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9361 \DeclareUnicodeCharacter{1E3E}{\'M}
9362 \DeclareUnicodeCharacter{1E3F}{\'m}
9364 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9365 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9366 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9367 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9368 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9369 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9370 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9371 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9372 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9373 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9375 \DeclareUnicodeCharacter{1E54}{\'P}
9376 \DeclareUnicodeCharacter{1E55}{\'p}
9377 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9378 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9379 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9380 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9381 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9382 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9383 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9384 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9386 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9387 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9388 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9389 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9390 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9391 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9392 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9393 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9394 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9395 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9397 \DeclareUnicodeCharacter{1E7C}{\~V}
9398 \DeclareUnicodeCharacter{1E7D}{\~v}
9399 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9400 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9402 \DeclareUnicodeCharacter{1E80}{\`W}
9403 \DeclareUnicodeCharacter{1E81}{\`w}
9404 \DeclareUnicodeCharacter{1E82}{\'W}
9405 \DeclareUnicodeCharacter{1E83}{\'w}
9406 \DeclareUnicodeCharacter{1E84}{\"W}
9407 \DeclareUnicodeCharacter{1E85}{\"w}
9408 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9409 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9410 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9411 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9412 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9413 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9414 \DeclareUnicodeCharacter{1E8C}{\"X}
9415 \DeclareUnicodeCharacter{1E8D}{\"x}
9416 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9417 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9419 \DeclareUnicodeCharacter{1E90}{\^Z}
9420 \DeclareUnicodeCharacter{1E91}{\^z}
9421 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9422 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9423 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9424 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9425 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9426 \DeclareUnicodeCharacter{1E97}{\"t}
9427 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9428 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9430 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9431 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9433 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9434 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9435 \DeclareUnicodeCharacter{1EBC}{\~E}
9436 \DeclareUnicodeCharacter{1EBD}{\~e}
9438 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9439 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9440 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9441 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9443 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9444 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9446 \DeclareUnicodeCharacter{1EF2}{\`Y}
9447 \DeclareUnicodeCharacter{1EF3}{\`y}
9448 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9450 \DeclareUnicodeCharacter{1EF8}{\~Y}
9451 \DeclareUnicodeCharacter{1EF9}{\~y}
9453 \DeclareUnicodeCharacter{2013}{--}
9454 \DeclareUnicodeCharacter{2014}{---}
9455 \DeclareUnicodeCharacter{2018}{\quoteleft}
9456 \DeclareUnicodeCharacter{2019}{\quoteright}
9457 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9458 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9459 \DeclareUnicodeCharacter{201D}{\quotedblright}
9460 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9461 \DeclareUnicodeCharacter{2022}{\bullet}
9462 \DeclareUnicodeCharacter{2026}{\dots}
9463 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9464 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9465 \DeclareUnicodeCharacter{20AC}{\euro}
9467 \DeclareUnicodeCharacter{2192}{\expansion}
9468 \DeclareUnicodeCharacter{21D2}{\result}
9470 \DeclareUnicodeCharacter{2212}{\minus}
9471 \DeclareUnicodeCharacter{2217}{\point}
9472 \DeclareUnicodeCharacter{2261}{\equiv}
9473 }% end of \utfeightchardefs
9476 % US-ASCII character definitions.
9477 \def\asciichardefs{% nothing need be done
9481 % Make non-ASCII characters printable again for compatibility with
9482 % existing Texinfo documents that may use them, even without declaring a
9483 % document encoding.
9485 \setnonasciicharscatcode \other
9488 \message{formatting,}
9490 \newdimen\defaultparindent \defaultparindent = 15pt
9492 \chapheadingskip = 15pt plus 4pt minus 2pt
9493 \secheadingskip = 12pt plus 3pt minus 2pt
9494 \subsecheadingskip = 9pt plus 2pt minus 2pt
9496 % Prevent underfull vbox error messages.
9499 % Don't be very finicky about underfull hboxes, either.
9502 % Following George Bush, get rid of widows and orphans.
9506 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9507 % using an old version of TeX, don't do anything. We want the amount of
9508 % stretch added to depend on the line length, hence the dependence on
9509 % \hsize. We call this whenever the paper size is set.
9511 \def\setemergencystretch{%
9512 \ifx\emergencystretch\thisisundefined
9513 % Allow us to assign to \emergencystretch anyway.
9514 \def\emergencystretch{\dimen0}%
9516 \emergencystretch = .15\hsize
9520 % Parameters in order: 1) textheight; 2) textwidth;
9521 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9522 % 7) physical page height; 8) physical page width.
9524 % We also call \setleading{\textleading}, so the caller should define
9525 % \textleading. The caller should also set \parskip.
9527 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9530 \splittopskip = \topskip
9533 \advance\vsize by \topskip
9534 \outervsize = \vsize
9535 \advance\outervsize by 2\topandbottommargin
9536 \pageheight = \vsize
9539 \outerhsize = \hsize
9540 \advance\outerhsize by 0.5in
9543 \normaloffset = #4\relax
9544 \bindingoffset = #5\relax
9547 \pdfpageheight #7\relax
9548 \pdfpagewidth #8\relax
9549 % if we don't reset these, they will remain at "1 true in" of
9550 % whatever layout pdftex was dumped with.
9551 \pdfhorigin = 1 true in
9552 \pdfvorigin = 1 true in
9555 \setleading{\textleading}
9557 \parindent = \defaultparindent
9558 \setemergencystretch
9561 % @letterpaper (the default).
9562 \def\letterpaper{{\globaldefs = 1
9563 \parskip = 3pt plus 2pt minus 1pt
9564 \textleading = 13.2pt
9566 % If page is nothing but text, make it come out even.
9567 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9569 {\bindingoffset}{36pt}%
9573 % Use @smallbook to reset parameters for 7x9.25 trim size.
9574 \def\smallbook{{\globaldefs = 1
9575 \parskip = 2pt plus 1pt
9578 \internalpagesizes{7.5in}{5in}%
9580 {\bindingoffset}{16pt}%
9583 \lispnarrowing = 0.3in
9586 \contentsrightmargin = 0pt
9587 \defbodyindent = .5cm
9590 % Use @smallerbook to reset parameters for 6x9 trim size.
9591 % (Just testing, parameters still in flux.)
9592 \def\smallerbook{{\globaldefs = 1
9593 \parskip = 1.5pt plus 1pt
9596 \internalpagesizes{7.4in}{4.8in}%
9601 \lispnarrowing = 0.25in
9604 \contentsrightmargin = 0pt
9605 \defbodyindent = .4cm
9608 % Use @afourpaper to print on European A4 paper.
9609 \def\afourpaper{{\globaldefs = 1
9610 \parskip = 3pt plus 2pt minus 1pt
9611 \textleading = 13.2pt
9613 % Double-side printing via postscript on Laserjet 4050
9614 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9615 % To change the settings for a different printer or situation, adjust
9616 % \normaloffset until the front-side and back-side texts align. Then
9617 % do the same for \bindingoffset. You can set these for testing in
9618 % your texinfo source file like this:
9620 % \global\normaloffset = -6mm
9621 % \global\bindingoffset = 10mm
9623 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9624 {\voffset}{\hoffset}%
9625 {\bindingoffset}{44pt}%
9630 \contentsrightmargin = 0pt
9631 \defbodyindent = 5mm
9634 % Use @afivepaper to print on European A5 paper.
9635 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9636 % He also recommends making @example and @lisp be small.
9637 \def\afivepaper{{\globaldefs = 1
9638 \parskip = 2pt plus 1pt minus 0.1pt
9639 \textleading = 12.5pt
9641 \internalpagesizes{160mm}{120mm}%
9642 {\voffset}{\hoffset}%
9643 {\bindingoffset}{8pt}%
9646 \lispnarrowing = 0.2in
9649 \contentsrightmargin = 0pt
9650 \defbodyindent = 2mm
9654 % A specific text layout, 24x15cm overall, intended for A4 paper.
9655 \def\afourlatex{{\globaldefs = 1
9657 \internalpagesizes{237mm}{150mm}%
9659 {\bindingoffset}{7mm}%
9662 % Must explicitly reset to 0 because we call \afourpaper.
9666 % Use @afourwide to print on A4 paper in landscape format.
9667 \def\afourwide{{\globaldefs = 1
9669 \internalpagesizes{241mm}{165mm}%
9670 {\voffset}{-2.95mm}%
9671 {\bindingoffset}{7mm}%
9676 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9677 % Perhaps we should allow setting the margins, \topskip, \parskip,
9678 % and/or leading, also. Or perhaps we should compute them somehow.
9680 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9681 \def\pagesizesyyy#1,#2,#3\finish{{%
9682 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9685 \parskip = 3pt plus 2pt minus 1pt
9686 \setleading{\textleading}%
9689 \advance\dimen0 by \voffset
9692 \advance\dimen2 by \normaloffset
9694 \internalpagesizes{#1}{\hsize}%
9695 {\voffset}{\normaloffset}%
9696 {\bindingoffset}{44pt}%
9700 % Set default to letter.
9705 \message{and turning on texinfo input format.}
9707 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9709 % DEL is a comment character, in case @c does not suffice.
9712 % Define macros to output various characters with catcode for normal text.
9713 \catcode`\"=\other \def\normaldoublequote{"}
9714 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9715 \catcode`\+=\other \def\normalplus{+}
9716 \catcode`\<=\other \def\normalless{<}
9717 \catcode`\>=\other \def\normalgreater{>}
9718 \catcode`\^=\other \def\normalcaret{^}
9719 \catcode`\_=\other \def\normalunderscore{_}
9720 \catcode`\|=\other \def\normalverticalbar{|}
9721 \catcode`\~=\other \def\normaltilde{~}
9723 % This macro is used to make a character print one way in \tt
9724 % (where it can probably be output as-is), and another way in other fonts,
9725 % where something hairier probably needs to be done.
9727 % #1 is what to print if we are indeed using \tt; #2 is what to print
9728 % otherwise. Since all the Computer Modern typewriter fonts have zero
9729 % interword stretch (and shrink), and it is reasonable to expect all
9730 % typewriter fonts to have this, we can check that font parameter.
9732 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9734 % Same as above, but check for italic font. Actually this also catches
9735 % non-italic slanted fonts since it is impossible to distinguish them from
9736 % italic fonts. But since this is only used by $ and it uses \sl anyway
9737 % this is not a problem.
9738 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9740 % Turn off all special characters except @
9741 % (and those which the user can use as if they were ordinary).
9742 % Most of these we simply print from the \tt font, but for some, we can
9743 % use math or other variants that look better in normal text.
9746 \def\activedoublequote{{\tt\char34}}
9747 \let"=\activedoublequote
9749 \def~{{\tt\char126}}
9755 \def_{\ifusingtt\normalunderscore\_}
9757 % Subroutine for the previous macro.
9758 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9761 \def|{{\tt\char124}}
9769 \def+{{\tt \char 43}}
9771 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9773 % If a .fmt file is being used, characters that might appear in a file
9774 % name cannot be active until we have parsed the command line.
9775 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9776 % \otherifyactive is called near the end of this file.
9777 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9779 % Used sometimes to turn off (effectively) the active characters even after
9781 \def\turnoffactive{%
9782 \normalturnoffactive
9788 % \backslashcurfont outputs one backslash character in current font,
9790 \global\chardef\backslashcurfont=`\\
9791 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9793 % \realbackslash is an actual character `\' with catcode other, and
9794 % \doublebackslash is two of them (for the pdf outlines).
9795 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9797 % In texinfo, backslash is an active character; it prints the backslash
9798 % in fixed width font.
9800 @def@normalbackslash{{@tt@backslashcurfont}}
9801 % On startup, @fixbackslash assigns:
9802 % @let \ = @normalbackslash
9804 % \rawbackslash defines an active \ to do \backslashcurfont.
9805 % \otherbackslash defines an active \ to be a literal `\' character with
9807 @gdef@rawbackslash{@let\=@backslashcurfont}
9808 @gdef@otherbackslash{@let\=@realbackslash}
9810 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9811 % the literal character `\'.
9813 @def@normalturnoffactive{%
9814 @let"=@normaldoublequote
9815 @let$=@normaldollar %$ font-lock fix
9818 @let>=@normalgreater
9819 @let\=@normalbackslash
9821 @let_=@normalunderscore
9822 @let|=@normalverticalbar
9824 @markupsetuplqdefault
9825 @markupsetuprqdefault
9829 % Make _ and + \other characters, temporarily.
9830 % This is canceled by @fixbackslash.
9833 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9834 % That is what \eatinput is for; after that, the `\' should revert to printing
9837 @gdef@eatinput input texinfo{@fixbackslash}
9838 @global@let\ = @eatinput
9840 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9841 % the first `\' in the file would cause an error. This macro tries to fix
9842 % that, assuming it is called before the first `\' could plausibly occur.
9843 % Also turn back on active characters that might appear in the input
9844 % file name, in case not using a pre-dumped format.
9846 @gdef@fixbackslash{%
9847 @ifx\@eatinput @let\ = @normalbackslash @fi
9852 % Say @foo, not \foo, in error messages.
9855 % These (along with & and #) are made active for url-breaking, so need
9856 % active definitions as the normal characters.
9861 % These look ok in all fonts, so just make them not special.
9862 @catcode`@& = @other @def@normalamp{&}
9863 @catcode`@# = @other @def@normalhash{#}
9864 @catcode`@% = @other @def@normalpercent{%}
9866 @c Finally, make ` and ' active, so that txicodequoteundirected and
9867 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9868 @c don't make ` and ' active, @code will not get them as active chars.
9869 @c Do this last of all since we use ` in the previous @catcode assignments.
9872 @markupsetuplqdefault
9873 @markupsetuprqdefault
9876 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9877 @c page-delimiter: "^\\\\message"
9878 @c time-stamp-start: "def\\\\texinfoversion{"
9879 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9880 @c time-stamp-end: "}"
9886 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115