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{2014-10-29.10}
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, 2012, 2013, 2014 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 Exception is an additional permission under section 7
28 % of the GNU General Public License, version 3 ("GPLv3").
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
33 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
34 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
35 % The texinfo.tex in any given distribution could well be out
36 % of date, so if that's what you're using, please check.
38 % Send bug reports to bug-texinfo@gnu.org. Please include including a
39 % complete document in each bug report with which we can reproduce the
40 % problem. Patches are, of course, greatly appreciated.
42 % To process a Texinfo manual with TeX, it's most reliable to use the
43 % texi2dvi shell script that comes with the distribution. For a simple
44 % manual foo.texi, however, you can get away with this:
49 % dvips foo.dvi -o # or whatever; this makes foo.ps.
50 % The extra TeX runs get the cross-reference information correct.
51 % Sometimes one run after texindex suffices, and sometimes you need more
52 % than two; texi2dvi does it as many times as necessary.
54 % It is possible to adapt texinfo.tex for other languages, to some
55 % extent. You can get the existing language-specific files from the
56 % full Texinfo distribution.
58 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
61 \message{Loading texinfo [version \texinfoversion]:}
63 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active}
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
75 % Save some plain tex macros whose names we will redefine.
77 \let\ptexbullet=\bullet
85 \let\ptexfootnote=\footnote
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
96 \let\ptexraggedright=\raggedright
102 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
104 % If this character appears in an error message or help string, it
105 % starts a new line in the output.
108 % Use TeX 3.0's \inputlineno to get the line number, for better error
109 % messages, but if we're using an old version of TeX, don't do anything.
111 \ifx\inputlineno\thisisundefined
112 \let\linenumber = \empty % Pre-3.0.
114 \def\linenumber{l.\the\inputlineno:\space}
117 % Set up fixed words for English if not already set.
118 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
119 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
120 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
121 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
122 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
123 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
124 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
125 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
126 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
127 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
128 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
129 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
130 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
131 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
132 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
133 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
134 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
135 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
136 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
137 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
139 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
140 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
141 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
142 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
143 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
144 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
145 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
146 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
147 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
148 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
149 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
150 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
152 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
153 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
154 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
155 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
156 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
158 % Since the category of space is not known, we have to be careful.
159 \chardef\spacecat = 10
160 \def\spaceisspace{\catcode`\ =\spacecat}
162 % sometimes characters are active, so we need control sequences.
163 \chardef\ampChar = `\&
164 \chardef\colonChar = `\:
165 \chardef\commaChar = `\,
166 \chardef\dashChar = `\-
167 \chardef\dotChar = `\.
168 \chardef\exclamChar= `\!
169 \chardef\hashChar = `\#
170 \chardef\lquoteChar= `\`
171 \chardef\questChar = `\?
172 \chardef\rquoteChar= `\'
173 \chardef\semiChar = `\;
174 \chardef\slashChar = `\/
175 \chardef\underChar = `\_
181 % The following is used inside several \edef's.
182 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
186 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
187 ap-pen-dix bit-map bit-maps
188 data-base data-bases eshell fall-ing half-way long-est man-u-script
189 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
190 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
192 stand-alone strong-est time-stamp time-stamps which-ever white-space
193 wide-spread wrap-around
196 % Margin to add to right of even pages, to left of odd pages.
197 \newdimen\bindingoffset
198 \newdimen\normaloffset
199 \newdimen\pagewidth \newdimen\pageheight
201 % For a final copy, take out the rectangles
202 % that mark overfull boxes (in case you have decided
203 % that the text looks ok even though it passes the margin).
205 \def\finalout{\overfullrule=0pt }
207 % Sometimes it is convenient to have everything in the transcript file
208 % and nothing on the terminal. We don't just call \tracingall here,
209 % since that produces some useless output on the terminal. We also make
210 % some effort to order the tracing commands to reduce output in the log
211 % file; cf. trace.sty in LaTeX.
213 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
217 \tracinglostchars2 % 2 gives us more in etex
222 \showboxbreadth\maxdimen \showboxdepth\maxdimen
223 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
230 \tracingcommands3 % 3 gives us more in etex
234 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
235 % aren't perfect, it's not the end of the world, being an error message,
238 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
239 \def\doerrormsg#1{\errmessage{#1}}
241 % add check for \lastpenalty to plain's definitions. If the last thing
242 % we did was a \nobreak, we don't want to insert more space.
244 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
245 \removelastskip\penalty-50\smallskip\fi\fi}
246 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
247 \removelastskip\penalty-100\medskip\fi\fi}
248 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
249 \removelastskip\penalty-200\bigskip\fi\fi}
251 % Do @cropmarks to get crop marks.
254 \let\cropmarks = \cropmarkstrue
256 % Dimensions to add cropmarks at corners.
257 % Added by P. A. MacKay, 12 Nov. 1986
259 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
260 \newdimen\cornerlong \cornerlong=1pc
261 \newdimen\cornerthick \cornerthick=.3pt
262 \newdimen\topandbottommargin \topandbottommargin=.75in
264 % Output a mark which sets \thischapter, \thissection and \thiscolor.
265 % We dump everything together because we only have one kind of mark.
266 % This works because we only use \botmark / \topmark, not \firstmark.
268 % A mark contains a subexpression of the \ifcase ... \fi construct.
269 % \get*marks macros below extract the needed part using \ifcase.
271 % Another complication is to let the user choose whether \thischapter
272 % (\thissection) refers to the chapter (section) in effect at the top
273 % of a page, or that at the bottom of a page. The solution is
274 % described on page 260 of The TeXbook. It involves outputting two
275 % marks for the sectioning macros, one before the section break, and
276 % one after. I won't pretend I can describe this better than DEK...
278 \toks0=\expandafter{\lastchapterdefs}%
279 \toks2=\expandafter{\lastsectiondefs}%
280 \toks4=\expandafter{\prevchapterdefs}%
281 \toks6=\expandafter{\prevsectiondefs}%
282 \toks8=\expandafter{\lastcolordefs}%
284 \the\toks0 \the\toks2 % 0: top marks (\last...)
285 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
286 \noexpand\else \the\toks8 % 2: color marks
289 % \topmark doesn't work for the very first chapter (after the title
290 % page or the contents), so we use \firstmark there -- this gets us
291 % the mark with the chapter defs, unless the user sneaks in, e.g.,
292 % @setcolor (or @url, or @link, etc.) between @contents and the very
294 \def\gettopheadingmarks{%
296 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
298 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
299 \def\getcolormarks{\ifcase2\topmark\fi}
301 % Avoid "undefined control sequence" errors.
302 \def\lastchapterdefs{}
303 \def\lastsectiondefs{}
304 \def\prevchapterdefs{}
305 \def\prevsectiondefs{}
308 % Main output routine.
310 \output = {\onepageout{\pagecontents\PAGE}}
315 % \onepageout takes a vbox as an argument. Note that \pagecontents
316 % does insertions, but you have to call it yourself.
318 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
320 \ifodd\pageno \advance\hoffset by \bindingoffset
321 \else \advance\hoffset by -\bindingoffset\fi
323 % Do this outside of the \shipout so @code etc. will be expanded in
324 % the headline as they should be, not taken literally (outputting ''code).
325 \def\commmonheadfootline{\let\hsize=\pagewidth \texinfochars}
327 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
328 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
330 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
331 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
334 % Have to do this stuff outside the \shipout because we want it to
335 % take effect in \write's, yet the group defined by the \vbox ends
336 % before the \shipout runs.
338 \indexdummies % don't expand commands in the output.
339 \normalturnoffactive % \ in index entries must not stay \, e.g., if
340 % the page break happens to be in the middle of an example.
341 % We don't want .vr (or whatever) entries like this:
342 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
343 % "\acronym" won't work when it's read back in;
345 % {\code {{\tt \backslashcurfont }acronym}
347 % Do this early so pdf references go to the beginning of the page.
348 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
350 \ifcropmarks \vbox to \outervsize\bgroup
352 \vskip-\topandbottommargin
354 \line{\ewtop\hfil\ewtop}%
357 \vbox{\moveleft\cornerthick\nstop}%
359 \vbox{\moveright\cornerthick\nstop}%
362 \vskip\topandbottommargin
364 \hfil % center the page within the outer (page) hsize.
365 \ifodd\pageno\hskip\bindingoffset\fi
371 \ifdim\ht\footlinebox > 0pt
372 % Only leave this space if the footline is nonempty.
373 % (We lessened \vsize for it in \oddfootingyyy.)
374 % The \baselineskip=24pt in plain's \makefootline has no effect.
380 \egroup % end of \vbox\bgroup
381 \hfil\egroup % end of (centering) \line\bgroup
382 \vskip\topandbottommargin plus1fill minus1fill
383 \boxmaxdepth = \cornerthick
386 \vbox{\moveleft\cornerthick\nsbot}%
388 \vbox{\moveright\cornerthick\nsbot}%
391 \line{\ewbot\hfil\ewbot}%
393 \egroup % \vbox from first cropmarks clause
395 }% end of \shipout\vbox
396 }% end of group with \indexdummies
398 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
401 \newinsert\margin \dimen\margin=\maxdimen
403 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
405 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
406 % marginal hacks, juha@viisa.uucp (Juha Takala)
407 \ifvoid\margin\else % marginal info is present
408 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
409 \dimen@=\dp#1\relax \unvbox#1\relax
410 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
411 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
414 % Here are the rules for the cropmarks. Note that they are
415 % offset so that the space between them is truly \outerhsize or \outervsize
416 % (P. A. MacKay, 12 November, 1986)
418 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
420 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
421 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
423 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
425 % Parse an argument, then pass it to #1. The argument is the rest of
426 % the input line (except we remove a trailing comment). #1 should be a
427 % macro which expects an ordinary undelimited TeX argument.
429 \def\parsearg{\parseargusing{}}
430 \def\parseargusing#1#2{%
436 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
440 \gdef\parseargline#1^^M{%
441 \endgroup % End of the group started in \parsearg.
442 \argremovecomment #1\comment\ArgTerm%
446 % First remove any @comment, then any @c comment.
447 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
448 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
450 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
452 % \argremovec might leave us with trailing space, e.g.,
453 % @end itemize @c foo
454 % This space token undergoes the same procedure and is eventually removed
455 % by \finishparsearg.
457 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
458 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
459 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
462 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
463 \let\temp\finishparsearg
465 \let\temp\argcheckspaces
467 % Put the space token in:
471 % If a _delimited_ argument is enclosed in braces, they get stripped; so
472 % to get _exactly_ the rest of the line, we had to prevent such situation.
473 % We prepended an \empty token at the very beginning and we expand it now,
474 % just before passing the control to \argtorun.
475 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
476 % either the null string, or it ends with \^^M---thus there is no danger
477 % that a pair of braces would be stripped.
479 % But first, we have to remove the trailing space token.
481 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
483 % \parseargdef\foo{...}
484 % is roughly equivalent to
485 % \def\foo{\parsearg\Xfoo}
488 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
489 % favourite TeX trick. --kasal, 16nov03
492 \expandafter \doparseargdef \csname\string#1\endcsname #1%
494 \def\doparseargdef#1#2{%
499 % Several utility definitions with active space:
504 % Make each space character in the input produce a normal interword
505 % space in the output. Don't allow a line break at this space, as this
506 % is used only in environments like @example, where each line of input
507 % should produce a line of output anyway.
509 \gdef\sepspaces{\obeyspaces\let =\tie}
511 % If an index command is used in an @example environment, any spaces
512 % therein should become regular spaces in the raw index file, not the
513 % expansion of \tie (\leavevmode \penalty \@M \ ).
514 \gdef\unsepspaces{\let =\space}
518 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
520 % Define the framework for environments in texinfo.tex. It's used like this:
525 % It's the responsibility of \envdef to insert \begingroup before the
526 % actual body; @end closes the group after calling \Efoo. \envdef also
527 % defines \thisenv, so the current environment is known; @end checks
528 % whether the environment name matches. The \checkenv macro can also be
529 % used to check whether the current environment is the one expected.
531 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
532 % are not treated as environments; they don't open a group. (The
533 % implementation of @end takes care not to call \endgroup in this
537 % At run-time, environments start with this:
538 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
542 % ... but they get defined via ``\envdef\foo{...}'':
543 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
544 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
546 % Check whether we're in the right environment:
555 % Environment mismatch, #1 expected:
558 \errmessage{This command can appear only \inenvironment\temp,
559 not \inenvironment\thisenv}%
561 \def\inenvironment#1{%
563 outside of any environment%
565 in environment \expandafter\string#1%
569 % @end foo executes the definition of \Efoo.
570 % But first, it executes a specialized version of \checkenv
573 \if 1\csname iscond.#1\endcsname
575 % The general wording of \badenverr may not be ideal.
576 \expandafter\checkenv\csname#1\endcsname
577 \csname E#1\endcsname
582 \newhelp\EMsimple{Press RETURN to continue.}
585 % Be sure we're in horizontal mode when doing a tie, since we make space
586 % equivalent to this in @example-like environments. Otherwise, a space
587 % at the beginning of a line will start with \penalty -- and
588 % since \penalty is valid in vertical mode, we'd end up putting the
589 % penalty on the vertical list instead of in the new paragraph.
591 % Avoid using \@M directly, because that causes trouble
592 % if the definition is written into an index file.
593 \global\let\tiepenalty = \@M
594 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
597 % @: forces normal size whitespace following.
598 \def\:{\spacefactor=1000 }
600 % @* forces a line break.
601 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
603 % @/ allows a line break.
606 % @. is an end-of-sentence period.
607 \def\.{.\spacefactor=\endofsentencespacefactor\space}
609 % @! is an end-of-sentence bang.
610 \def\!{!\spacefactor=\endofsentencespacefactor\space}
612 % @? is an end-of-sentence query.
613 \def\?{?\spacefactor=\endofsentencespacefactor\space}
615 % @frenchspacing on|off says whether to put extra space after punctuation.
620 \parseargdef\frenchspacing{%
622 \ifx\temp\onword \plainfrenchspacing
623 \else\ifx\temp\offword \plainnonfrenchspacing
626 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
630 % @w prevents a word break. Without the \leavevmode, @w at the
631 % beginning of a paragraph, when TeX is still in vertical mode, would
632 % produce a whole line of output instead of starting the paragraph.
633 \def\w#1{\leavevmode\hbox{#1}}
635 % @group ... @end group forces ... to be all on one page, by enclosing
636 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
637 % to keep its height that of a normal line. According to the rules for
638 % \topskip (p.114 of the TeXbook), the glue inserted is
639 % max (\topskip - \ht (first item), 0). If that height is large,
640 % therefore, no glue is inserted, and the space between the headline and
641 % the text is small, which looks bad.
643 % Another complication is that the group might be very large. This can
644 % cause the glue on the previous page to be unduly stretched, because it
645 % does not have much material. In this case, it's better to add an
646 % explicit \vfill so that the extra space is at the bottom. The
647 % threshold for doing this is if the group is more than \vfilllimit
648 % percent of a page (\vfilllimit can be changed inside of @tex).
654 \ifnum\catcode`\^^M=\active \else
655 \errhelp = \groupinvalidhelp
656 \errmessage{@group invalid in context where filling is enabled}%
660 \setbox\groupbox = \vtop\bgroup
661 % Do @comment since we are called inside an environment such as
662 % @example, where each end-of-line in the input causes an
663 % end-of-line in the output. We don't want the end-of-line after
664 % the `@group' to put extra space in the output. Since @group
665 % should appear on a line by itself (according to the Texinfo
666 % manual), we don't worry about eating any user text.
670 % The \vtop produces a box with normal height and large depth; thus, TeX puts
671 % \baselineskip glue before it, and (when the next line of text is done)
672 % \lineskip glue after it. Thus, space below is not quite equal to space
673 % above. But it's pretty close.
675 % To get correct interline space between the last line of the group
676 % and the first line afterwards, we have to propagate \prevdepth.
677 \endgraf % Not \par, as it may have been set to \lisppar.
678 \global\dimen1 = \prevdepth
679 \egroup % End the \vtop.
680 % \dimen0 is the vertical size of the group's box.
681 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
682 % \dimen2 is how much space is left on the page (more or less).
683 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
684 % if the group doesn't fit on the current page, and it's a big big
685 % group, force a page break.
686 \ifdim \dimen0 > \dimen2
687 \ifdim \pagetotal < \vfilllimit\pageheight
696 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
697 % message, so this ends up printing `@group can only ...'.
699 \newhelp\groupinvalidhelp{%
700 group can only be used in environments such as @example,^^J%
701 where each line of input produces a line of output.}
703 % @need space-in-mils
704 % forces a page break if there is not space-in-mils remaining.
706 \newdimen\mil \mil=0.001in
709 % Ensure vertical mode, so we don't make a big box in the middle of a
713 % If the @need value is less than one line space, it's useless.
715 \dimen2 = \ht\strutbox
716 \advance\dimen2 by \dp\strutbox
717 \ifdim\dimen0 > \dimen2
719 % Do a \strut just to make the height of this box be normal, so the
720 % normal leading is inserted relative to the preceding line.
721 % And a page break here is fine.
722 \vtop to #1\mil{\strut\vfil}%
724 % TeX does not even consider page breaks if a penalty added to the
725 % main vertical list is 10000 or more. But in order to see if the
726 % empty box we just added fits on the page, we must make it consider
727 % page breaks. On the other hand, we don't want to actually break the
728 % page after the empty box. So we use a penalty of 9999.
730 % There is an extremely small chance that TeX will actually break the
731 % page at this \penalty, if there are no other feasible breakpoints in
732 % sight. (If the user is using lots of big @group commands, which
733 % almost-but-not-quite fill up a page, TeX will have a hard time doing
734 % good page breaking, for example.) However, I could not construct an
735 % example where a page broke at this \penalty; if it happens in a real
736 % document, then we can reconsider our strategy.
739 % Back up by the size of the box, whether we did a page break or not.
742 % Do not allow a page break right after this kern.
747 % @br forces paragraph break (and is undocumented).
751 % @page forces the start of a new page.
753 \def\page{\par\vfill\supereject}
756 % outputs text on separate line in roman font, starting at standard page margin
758 % This records the amount of indent in the innermost environment.
759 % That's how much \exdent should take out.
760 \newskip\exdentamount
762 % This defn is used inside fill environments such as @defun.
763 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
765 % This defn is used inside nofill environments such as @example.
766 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
767 \leftline{\hskip\leftskip{\rm#1}}}}
769 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
770 % paragraph. For more general purposes, use the \margin insertion
771 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
773 \newskip\inmarginspacing \inmarginspacing=1cm
774 \def\strutdepth{\dp\strutbox}
776 \def\doinmargin#1#2{\strut\vadjust{%
779 \vtop to \strutdepth{%
780 \baselineskip=\strutdepth
782 % if you have multiple lines of stuff to put here, you'll need to
783 % make the vbox yourself of the appropriate size.
785 \llap{\ignorespaces #2\hskip\inmarginspacing}%
787 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
792 \def\inleftmargin{\doinmargin l}
793 \def\inrightmargin{\doinmargin r}
795 % @inmargin{TEXT [, RIGHT-TEXT]}
796 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
797 % else use TEXT for both).
799 \def\inmargin#1{\parseinmargin #1,,\finish}
800 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
801 \setbox0 = \hbox{\ignorespaces #2}%
803 \def\lefttext{#1}% have both texts
806 \def\lefttext{#1}% have only one text
811 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
813 \def\temp{\inleftmargin\lefttext}%
818 % @| inserts a changebar to the left of the current line. It should
819 % surround any changed text. This approach does *not* work if the
820 % change spans more than two lines of output. To handle that, we would
821 % have adopt a much more difficult approach (putting marks into the main
822 % vertical list for the beginning and end of each change). This command
823 % is not documented, not supported, and doesn't work.
826 % \vadjust can only be used in horizontal mode.
829 % Append this vertical mode material after the current line in the output.
831 % We want to insert a rule with the height and depth of the current
832 % leading; that is exactly what \strutbox is supposed to record.
835 % \vadjust-items are inserted at the left edge of the type. So
836 % the \llap here moves out into the left-hand margin.
839 % For a thicker or thinner bar, change the `1pt'.
840 \vrule height\baselineskip width1pt
842 % This is the space between the bar and the text.
848 % @include FILE -- \input text of FILE.
850 \def\include{\parseargusing\filenamecatcodes\includezzz}
855 \makevalueexpandable % we want to expand any @value in FILE.
856 \turnoffactive % and allow special characters in the expansion
857 \indexnofonts % Allow `@@' and other weird things in file names.
858 \wlog{texinfo.tex: doing @include of #1^^J}%
859 \edef\temp{\noexpand\input #1 }%
861 % This trickery is to read FILE outside of a group, in case it makes
867 \def\filenamecatcodes{%
881 \def\pushthisfilestack{%
882 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
884 \def\pushthisfilestackX{%
885 \expandafter\pushthisfilestackY\thisfile\StackTerm
887 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
888 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
891 \def\popthisfilestack{\errthisfilestackempty}
892 \def\errthisfilestackempty{\errmessage{Internal error:
893 the stack of filenames is empty.}}
898 % outputs that line, centered.
900 \parseargdef\center{%
902 \let\centersub\centerH
904 \let\centersub\centerV
906 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
907 \let\centersub\relax % don't let the definition persist, just in case
911 \advance\hsize by -\leftskip
912 \advance\hsize by -\rightskip
917 \newcount\centerpenalty
919 % The idea here is the same as in \startdefun, \cartouche, etc.: if
920 % @center is the first thing after a section heading, we need to wipe
921 % out the negative parskip inserted by \sectionheading, but still
922 % prevent a page break here.
923 \centerpenalty = \lastpenalty
924 \ifnum\centerpenalty>10000 \vskip\parskip \fi
925 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
926 \line{\kern\leftskip #1\kern\rightskip}%
929 % @sp n outputs n lines of vertical space
931 \parseargdef\sp{\vskip #1\baselineskip}
933 % @comment ...line which is ignored...
934 % @c is the same as @comment
935 % @ignore ... @end ignore is another way to write a comment
937 \def\comment{\begingroup \catcode`\^^M=\other%
938 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
940 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
944 % @paragraphindent NCHARS
945 % We'll use ems for NCHARS, close enough.
946 % NCHARS can also be the word `asis' or `none'.
947 % We cannot feasibly implement @paragraphindent asis, though.
949 \def\asisword{asis} % no translation, these are keywords
952 \parseargdef\paragraphindent{%
957 \defaultparindent = 0pt
959 \defaultparindent = #1em
962 \parindent = \defaultparindent
965 % @exampleindent NCHARS
966 % We'll use ems for NCHARS like @paragraphindent.
967 % It seems @exampleindent asis isn't necessary, but
968 % I preserve it to make it similar to @paragraphindent.
969 \parseargdef\exampleindent{%
976 \lispnarrowing = #1em
981 % @firstparagraphindent WORD
982 % If WORD is `none', then suppress indentation of the first paragraph
983 % after a section heading. If WORD is `insert', then do indent at such
986 % The paragraph indentation is suppressed or not by calling
987 % \suppressfirstparagraphindent, which the sectioning commands do.
988 % We switch the definition of this back and forth according to WORD.
989 % By default, we suppress indentation.
991 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
992 \def\insertword{insert}
994 \parseargdef\firstparagraphindent{%
997 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
998 \else\ifx\temp\insertword
999 \let\suppressfirstparagraphindent = \relax
1001 \errhelp = \EMsimple
1002 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1006 % Here is how we actually suppress indentation. Redefine \everypar to
1007 % \kern backwards by \parindent, and then reset itself to empty.
1009 % We also make \indent itself not actually do anything until the next
1012 \gdef\dosuppressfirstparagraphindent{%
1014 \restorefirstparagraphindent
1018 \restorefirstparagraphindent
1021 \global\everypar = {%
1023 \restorefirstparagraphindent
1027 \gdef\restorefirstparagraphindent{%
1028 \global \let \indent = \ptexindent
1029 \global \let \noindent = \ptexnoindent
1030 \global \everypar = {}%
1034 % @refill is a no-op.
1037 % If working on a large document in chapters, it is convenient to
1038 % be able to disable indexing, cross-referencing, and contents, for test runs.
1039 % This is done with @novalidate (before @setfilename).
1041 \newif\iflinks \linkstrue % by default we want the aux files.
1042 \let\novalidate = \linksfalse
1044 % @setfilename is done at the beginning of every texinfo file.
1045 % So open here the files we need to have open while reading the input.
1046 % This makes it possible to make a .fmt file for texinfo.
1048 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1051 % Open the new aux file. TeX will close it automatically at exit.
1052 \immediate\openout\auxfile=\jobname.aux
1053 \fi % \openindices needs to do some work in any case.
1055 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1057 % If texinfo.cnf is present on the system, read it.
1058 % Useful for site-wide @afourpaper, etc.
1059 \openin 1 texinfo.cnf
1060 \ifeof 1 \else \input texinfo.cnf \fi
1063 \comment % Ignore the actual filename.
1066 % Called from \setfilename.
1078 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1082 % adobe `portable' document format
1086 \newcount\filenamelength
1095 \newif\ifpdfmakepagedest
1097 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1098 % can be set). So we test for \relax and 0 as well as being undefined.
1099 \ifx\pdfoutput\thisisundefined
1101 \ifx\pdfoutput\relax
1110 % PDF uses PostScript string constants for the names of xref targets,
1111 % for display in the outlines, and in other places. Thus, we have to
1112 % double any backslashes. Otherwise, a name like "\node" will be
1113 % interpreted as a newline (\n), followed by o, d, e. Not good.
1115 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1116 % related messages. The final outcome is that it is up to the TeX user
1117 % to double the backslashes and otherwise make the string valid, so
1118 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1119 % do this reliably, so we use it.
1121 % #1 is a control sequence in which to do the replacements,
1123 \def\txiescapepdf#1{%
1124 \ifx\pdfescapestring\thisisundefined
1125 % No primitive available; should we give a warning or log?
1126 % Many times it won't matter.
1128 % The expandable \pdfescapestring primitive escapes parentheses,
1129 % backslashes, and other special chars.
1130 \xdef#1{\pdfescapestring{#1}}%
1134 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1135 with PDF output, and none of those formats could be found. (.eps cannot
1136 be supported due to the design of the PDF format; use regular TeX (DVI
1141 % Color manipulation macros using ideas from pdfcolor.tex,
1142 % except using rgb instead of cmyk; the latter is said to render as a
1143 % very dark gray on-screen and a very dark halftone in print, instead
1144 % of actual black. The dark red here is dark enough to print on paper as
1145 % nearly black, but still distinguishable for online viewing. We use
1146 % black by default, though.
1147 \def\rgbDarkRed{0.50 0.09 0.12}
1148 \def\rgbBlack{0 0 0}
1150 % k sets the color for filling (usual text, etc.);
1151 % K sets the color for stroking (thin rules, e.g., normal _'s).
1152 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1154 % Set color, and create a mark which defines \thiscolor accordingly,
1155 % so that \makeheadline knows which color to restore.
1157 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1162 \def\maincolor{\rgbBlack}
1163 \pdfsetcolor{\maincolor}
1164 \edef\thiscolor{\maincolor}
1165 \def\lastcolordefs{}
1169 \line{\pdfsetcolor{\maincolor}\the\footline}%
1177 % Extract \thiscolor definition from the marks.
1179 % Typeset the headline with \maincolor, then restore the color.
1180 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1188 \pdfcatalog{/PageMode /UseOutlines}
1190 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1191 \def\dopdfimage#1#2#3{%
1192 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1193 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1195 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1196 % others). Let's try in that order, PDF first since if
1197 % someone has a scalable image, presumably better to use that than a
1199 \let\pdfimgext=\empty
1201 \openin 1 #1.pdf \ifeof 1
1202 \openin 1 #1.PDF \ifeof 1
1203 \openin 1 #1.png \ifeof 1
1204 \openin 1 #1.jpg \ifeof 1
1205 \openin 1 #1.jpeg \ifeof 1
1206 \openin 1 #1.JPG \ifeof 1
1207 \errhelp = \nopdfimagehelp
1208 \errmessage{Could not find image file #1 for pdf}%
1209 \else \gdef\pdfimgext{JPG}%
1211 \else \gdef\pdfimgext{jpeg}%
1213 \else \gdef\pdfimgext{jpg}%
1215 \else \gdef\pdfimgext{png}%
1217 \else \gdef\pdfimgext{PDF}%
1219 \else \gdef\pdfimgext{pdf}%
1224 % without \immediate, ancient pdftex seg faults when the same image is
1225 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1226 \ifnum\pdftexversion < 14
1229 \immediate\pdfximage
1231 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1232 \ifdim \wd2 >0pt height \pdfimageheight \fi
1233 \ifnum\pdftexversion<13
1238 \ifnum\pdftexversion < 14 \else
1239 \pdfrefximage \pdflastximage
1243 % We have to set dummies so commands such as @code, and characters
1244 % such as \, aren't expanded when present in a section title.
1247 \makevalueexpandable
1248 \def\pdfdestname{#1}%
1249 \txiescapepdf\pdfdestname
1250 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1253 % used to mark target names; must be expandable.
1256 % by default, use black for everything.
1257 \def\urlcolor{\rgbBlack}
1258 \def\linkcolor{\rgbBlack}
1259 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1261 % Adding outlines to PDF; macros for calculating structure of outlines
1262 % come from Petr Olsak
1263 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1264 \else \csname#1\endcsname \fi}
1265 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1266 \advance\tempnum by 1
1267 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1269 % #1 is the section text, which is what will be displayed in the
1270 % outline by the pdf viewer. #2 is the pdf expression for the number
1271 % of subentries (or empty, for subsubsections). #3 is the node text,
1272 % which might be empty if this toc entry had no corresponding node.
1273 % #4 is the page number
1275 \def\dopdfoutline#1#2#3#4{%
1276 % Generate a link to the node text if that exists; else, use the
1277 % page number. We could generate a destination for the section
1278 % text in the case where a section has no node, but it doesn't
1279 % seem worth the trouble, since most documents are normally structured.
1280 \edef\pdfoutlinedest{#3}%
1281 \ifx\pdfoutlinedest\empty
1282 \def\pdfoutlinedest{#4}%
1284 \txiescapepdf\pdfoutlinedest
1287 % Also escape PDF chars in the display string.
1288 \edef\pdfoutlinetext{#1}%
1289 \txiescapepdf\pdfoutlinetext
1291 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1294 \def\pdfmakeoutlines{%
1296 % Read toc silently, to get counts of subentries for \pdfoutline.
1297 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1298 \def\numchapentry##1##2##3##4{%
1299 \def\thischapnum{##2}%
1301 \def\thissubsecnum{0}%
1303 \def\numsecentry##1##2##3##4{%
1304 \advancenumber{chap\thischapnum}%
1305 \def\thissecnum{##2}%
1306 \def\thissubsecnum{0}%
1308 \def\numsubsecentry##1##2##3##4{%
1309 \advancenumber{sec\thissecnum}%
1310 \def\thissubsecnum{##2}%
1312 \def\numsubsubsecentry##1##2##3##4{%
1313 \advancenumber{subsec\thissubsecnum}%
1315 \def\thischapnum{0}%
1317 \def\thissubsecnum{0}%
1319 % use \def rather than \let here because we redefine \chapentry et
1320 % al. a second time, below.
1321 \def\appentry{\numchapentry}%
1322 \def\appsecentry{\numsecentry}%
1323 \def\appsubsecentry{\numsubsecentry}%
1324 \def\appsubsubsecentry{\numsubsubsecentry}%
1325 \def\unnchapentry{\numchapentry}%
1326 \def\unnsecentry{\numsecentry}%
1327 \def\unnsubsecentry{\numsubsecentry}%
1328 \def\unnsubsubsecentry{\numsubsubsecentry}%
1331 % Read toc second time, this time actually producing the outlines.
1332 % The `-' means take the \expnumber as the absolute number of
1333 % subentries, which we calculated on our first read of the .toc above.
1335 % We use the node names as the destinations.
1336 \def\numchapentry##1##2##3##4{%
1337 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1338 \def\numsecentry##1##2##3##4{%
1339 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1340 \def\numsubsecentry##1##2##3##4{%
1341 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1342 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1343 \dopdfoutline{##1}{}{##3}{##4}}%
1345 % PDF outlines are displayed using system fonts, instead of
1346 % document fonts. Therefore we cannot use special characters,
1347 % since the encoding is unknown. For example, the eogonek from
1348 % Latin 2 (0xea) gets translated to a | character. Info from
1349 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1351 % TODO this right, we have to translate 8-bit characters to
1352 % their "best" equivalent, based on the @documentencoding. Too
1353 % much work for too little return. Just use the ASCII equivalents
1354 % we use for the index sort strings.
1358 % We can have normal brace characters in the PDF outlines, unlike
1359 % Texinfo index files. So set that up.
1360 \def\{{\lbracecharliteral}%
1361 \def\}{\rbracecharliteral}%
1362 \catcode`\\=\active \otherbackslash
1363 \input \tocreadfilename
1366 {\catcode`[=1 \catcode`]=2
1367 \catcode`{=\other \catcode`}=\other
1368 \gdef\lbracecharliteral[{]%
1369 \gdef\rbracecharliteral[}]%
1372 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1373 \ifx\PP\D\let\nextsp\relax
1374 \else\let\nextsp\skipspaces
1375 \addtokens{\filename}{\PP}%
1376 \advance\filenamelength by 1
1379 \def\getfilename#1{%
1381 % If we don't expand the argument now, \skipspaces will get
1382 % snagged on things like "@value{foo}".
1384 \expandafter\skipspaces\temp|\relax
1386 \ifnum\pdftexversion < 14
1387 \let \startlink \pdfannotlink
1389 \let \startlink \pdfstartlink
1391 % make a live url in pdf output.
1394 % it seems we really need yet another set of dummies; have not
1395 % tried to figure out what each command should do in the context
1396 % of @url. for now, just make @/ a no-op, that's the only one
1397 % people have actually reported a problem with.
1399 \normalturnoffactive
1402 \makevalueexpandable
1403 % do we want to go so far as to use \indexnofonts instead of just
1404 % special-casing \var here?
1407 \leavevmode\setcolor{\urlcolor}%
1408 \startlink attr{/Border [0 0 0]}%
1409 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1411 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1412 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1413 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1414 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1416 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1418 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1419 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1420 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1422 \ifnum0=\countA\else\makelink\fi
1423 \ifx\first.\let\next=\done\else
1425 \addtokens{\toksB}{\the\toksD}
1426 \ifx\first,\addtokens{\toksB}{\space}\fi
1428 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1430 \def\makelink{\addtokens{\toksB}%
1431 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1433 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1434 \setcolor{\linkcolor}#1\endlink}
1435 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1438 \let\pdfmkdest = \gobble
1439 \let\pdfurl = \gobble
1440 \let\endlink = \relax
1441 \let\setcolor = \gobble
1442 \let\pdfsetcolor = \gobble
1443 \let\pdfmakeoutlines = \relax
1444 \fi % \ifx\pdfoutput
1449 % Change the current font style to #1, remembering it in \curfontstyle.
1450 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1451 % italics, not bold italics.
1453 \def\setfontstyle#1{%
1454 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1455 \csname ten#1\endcsname % change the current font
1458 % Select #1 fonts with the current style.
1460 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1462 \def\rm{\fam=0 \setfontstyle{rm}}
1463 \def\it{\fam=\itfam \setfontstyle{it}}
1464 \def\sl{\fam=\slfam \setfontstyle{sl}}
1465 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1466 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1468 % Unfortunately, we have to override this for titles and the like, since
1469 % in those cases "rm" is bold. Sigh.
1470 \def\rmisbold{\rm\def\curfontstyle{bf}}
1472 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1473 % So we set up a \sf.
1475 \def\sf{\fam=\sffam \setfontstyle{sf}}
1476 \let\li = \sf % Sometimes we call it \li, not \sf.
1478 % We don't need math for this font style.
1479 \def\ttsl{\setfontstyle{ttsl}}
1482 % Set the baselineskip to #1, and the lineskip and strut size
1483 % correspondingly. There is no deep meaning behind these magic numbers
1484 % used as factors; they just match (closely enough) what Knuth defined.
1486 \def\lineskipfactor{.08333}
1487 \def\strutheightpercent{.70833}
1488 \def\strutdepthpercent {.29167}
1490 % can get a sort of poor man's double spacing by redefining this.
1491 \def\baselinefactor{1}
1493 \newdimen\textleading
1496 \normalbaselineskip = \baselinefactor\dimen0
1497 \normallineskip = \lineskipfactor\normalbaselineskip
1499 \setbox\strutbox =\hbox{%
1500 \vrule width0pt height\strutheightpercent\baselineskip
1501 depth \strutdepthpercent \baselineskip
1505 % PDF CMaps. See also LaTeX's t1.cmap.
1507 % do nothing with this by default.
1508 \expandafter\let\csname cmapOT1\endcsname\gobble
1509 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1510 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1512 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1513 % (\pdffontattr was introduced many years ago, but people still run
1514 % older pdftex's; it's easy to conditionalize, so we do.)
1515 \ifpdf \ifx\pdffontattr\thisisundefined \else
1517 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1518 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1519 %%DocumentNeededResources: ProcSet (CIDInit)
1520 %%IncludeResource: ProcSet (CIDInit)
1521 %%BeginResource: CMap (TeX-OT1-0)
1522 %%Title: (TeX-OT1-0 TeX OT1 0)
1525 /CIDInit /ProcSet findresource begin
1533 /CMapName /TeX-OT1-0 def
1535 1 begincodespacerange
1591 CMapName currentdict /CMap defineresource pop
1597 \expandafter\edef\csname cmapOT1\endcsname#1{%
1598 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1603 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1604 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1605 %%DocumentNeededResources: ProcSet (CIDInit)
1606 %%IncludeResource: ProcSet (CIDInit)
1607 %%BeginResource: CMap (TeX-OT1IT-0)
1608 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1611 /CIDInit /ProcSet findresource begin
1619 /CMapName /TeX-OT1IT-0 def
1621 1 begincodespacerange
1679 CMapName currentdict /CMap defineresource pop
1685 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1686 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1691 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1692 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1693 %%DocumentNeededResources: ProcSet (CIDInit)
1694 %%IncludeResource: ProcSet (CIDInit)
1695 %%BeginResource: CMap (TeX-OT1TT-0)
1696 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1699 /CIDInit /ProcSet findresource begin
1707 /CMapName /TeX-OT1TT-0 def
1709 1 begincodespacerange
1754 CMapName currentdict /CMap defineresource pop
1760 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1761 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1766 % Set the font macro #1 to the font named \fontprefix#2.
1767 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1768 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1776 \def\setfont#1#2#3#4#5{%
1777 \font#1=\fontprefix#2#3 scaled #4
1778 \csname cmap#5\endcsname#1%
1780 % This is what gets called when #5 of \setfont is empty.
1785 % Use cm as the default font prefix.
1786 % To specify the font prefix, you must define \fontprefix
1787 % before you read in texinfo.tex.
1788 \ifx\fontprefix\thisisundefined
1791 % Support font families that don't use the same naming scheme as CM.
1793 \def\rmbshape{bx} % where the normal face is bold
1798 \def\ttslshape{sltt}
1808 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1810 \def\definetextfontsizexi{%
1811 % Text fonts (11.2pt, magstep1).
1812 \def\textnominalsize{11pt}
1813 \edef\mainmagstep{\magstephalf}
1814 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1815 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1816 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1817 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1818 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1819 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1820 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1821 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1822 \font\texti=cmmi10 scaled \mainmagstep
1823 \font\textsy=cmsy10 scaled \mainmagstep
1824 \def\textecsize{1095}
1826 % A few fonts for @defun names and args.
1827 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1828 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1829 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1830 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1832 % Fonts for indices, footnotes, small examples (9pt).
1833 \def\smallnominalsize{9pt}
1834 \setfont\smallrm\rmshape{9}{1000}{OT1}
1835 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1836 \setfont\smallbf\bfshape{10}{900}{OT1}
1837 \setfont\smallit\itshape{9}{1000}{OT1IT}
1838 \setfont\smallsl\slshape{9}{1000}{OT1}
1839 \setfont\smallsf\sfshape{9}{1000}{OT1}
1840 \setfont\smallsc\scshape{10}{900}{OT1}
1841 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1844 \def\smallecsize{0900}
1846 % Fonts for small examples (8pt).
1847 \def\smallernominalsize{8pt}
1848 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1849 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1850 \setfont\smallerbf\bfshape{10}{800}{OT1}
1851 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1852 \setfont\smallersl\slshape{8}{1000}{OT1}
1853 \setfont\smallersf\sfshape{8}{1000}{OT1}
1854 \setfont\smallersc\scshape{10}{800}{OT1}
1855 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1856 \font\smalleri=cmmi8
1857 \font\smallersy=cmsy8
1858 \def\smallerecsize{0800}
1860 % Fonts for title page (20.4pt):
1861 \def\titlenominalsize{20pt}
1862 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1863 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1864 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1865 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1866 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1867 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1868 \let\titlebf=\titlerm
1869 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1870 \font\titlei=cmmi12 scaled \magstep3
1871 \font\titlesy=cmsy10 scaled \magstep4
1872 \def\titleecsize{2074}
1874 % Chapter (and unnumbered) fonts (17.28pt).
1875 \def\chapnominalsize{17pt}
1876 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1877 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1878 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1879 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1880 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1881 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1883 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1884 \font\chapi=cmmi12 scaled \magstep2
1885 \font\chapsy=cmsy10 scaled \magstep3
1886 \def\chapecsize{1728}
1888 % Section fonts (14.4pt).
1889 \def\secnominalsize{14pt}
1890 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1891 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1892 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1893 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1894 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1895 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1897 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1898 \font\seci=cmmi12 scaled \magstep1
1899 \font\secsy=cmsy10 scaled \magstep2
1900 \def\sececsize{1440}
1902 % Subsection fonts (13.15pt).
1903 \def\ssecnominalsize{13pt}
1904 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1905 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1906 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1907 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1908 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1909 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1911 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1912 \font\sseci=cmmi12 scaled \magstephalf
1913 \font\ssecsy=cmsy10 scaled 1315
1914 \def\ssececsize{1200}
1916 % Reduced fonts for @acro in text (10pt).
1917 \def\reducednominalsize{10pt}
1918 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1919 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1920 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1921 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1922 \setfont\reducedsl\slshape{10}{1000}{OT1}
1923 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1924 \setfont\reducedsc\scshape{10}{1000}{OT1}
1925 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1926 \font\reducedi=cmmi10
1927 \font\reducedsy=cmsy10
1928 \def\reducedecsize{1000}
1930 \textleading = 13.2pt % line spacing for 11pt CM
1931 \textfonts % reset the current fonts
1933 } % end of 11pt text font size definitions, \definetextfontsizexi
1936 % Definitions to make the main text be 10pt Computer Modern, with
1937 % section, chapter, etc., sizes following suit. This is for the GNU
1938 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1939 % future. Used with @smallbook, which sets the leading to 12pt.
1941 \def\definetextfontsizex{%
1942 % Text fonts (10pt).
1943 \def\textnominalsize{10pt}
1944 \edef\mainmagstep{1000}
1945 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1946 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1947 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1948 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1949 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1950 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1951 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1952 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1953 \font\texti=cmmi10 scaled \mainmagstep
1954 \font\textsy=cmsy10 scaled \mainmagstep
1955 \def\textecsize{1000}
1957 % A few fonts for @defun names and args.
1958 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1959 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1960 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1961 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1963 % Fonts for indices, footnotes, small examples (9pt).
1964 \def\smallnominalsize{9pt}
1965 \setfont\smallrm\rmshape{9}{1000}{OT1}
1966 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1967 \setfont\smallbf\bfshape{10}{900}{OT1}
1968 \setfont\smallit\itshape{9}{1000}{OT1IT}
1969 \setfont\smallsl\slshape{9}{1000}{OT1}
1970 \setfont\smallsf\sfshape{9}{1000}{OT1}
1971 \setfont\smallsc\scshape{10}{900}{OT1}
1972 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1975 \def\smallecsize{0900}
1977 % Fonts for small examples (8pt).
1978 \def\smallernominalsize{8pt}
1979 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1980 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1981 \setfont\smallerbf\bfshape{10}{800}{OT1}
1982 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1983 \setfont\smallersl\slshape{8}{1000}{OT1}
1984 \setfont\smallersf\sfshape{8}{1000}{OT1}
1985 \setfont\smallersc\scshape{10}{800}{OT1}
1986 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1987 \font\smalleri=cmmi8
1988 \font\smallersy=cmsy8
1989 \def\smallerecsize{0800}
1991 % Fonts for title page (20.4pt):
1992 \def\titlenominalsize{20pt}
1993 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1994 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1995 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1996 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1997 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1998 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1999 \let\titlebf=\titlerm
2000 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2001 \font\titlei=cmmi12 scaled \magstep3
2002 \font\titlesy=cmsy10 scaled \magstep4
2003 \def\titleecsize{2074}
2005 % Chapter fonts (14.4pt).
2006 \def\chapnominalsize{14pt}
2007 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2008 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2009 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2010 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2011 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2012 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2014 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2015 \font\chapi=cmmi12 scaled \magstep1
2016 \font\chapsy=cmsy10 scaled \magstep2
2017 \def\chapecsize{1440}
2019 % Section fonts (12pt).
2020 \def\secnominalsize{12pt}
2021 \setfont\secrm\rmbshape{12}{1000}{OT1}
2022 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2023 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2024 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2025 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2026 \setfont\secsf\sfbshape{12}{1000}{OT1}
2028 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2030 \font\secsy=cmsy10 scaled \magstep1
2031 \def\sececsize{1200}
2033 % Subsection fonts (10pt).
2034 \def\ssecnominalsize{10pt}
2035 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2036 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2037 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2038 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2039 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2040 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2042 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2045 \def\ssececsize{1000}
2047 % Reduced fonts for @acro in text (9pt).
2048 \def\reducednominalsize{9pt}
2049 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2050 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2051 \setfont\reducedbf\bfshape{10}{900}{OT1}
2052 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2053 \setfont\reducedsl\slshape{9}{1000}{OT1}
2054 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2055 \setfont\reducedsc\scshape{10}{900}{OT1}
2056 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2057 \font\reducedi=cmmi9
2058 \font\reducedsy=cmsy9
2059 \def\reducedecsize{0900}
2061 \divide\parskip by 2 % reduce space between paragraphs
2062 \textleading = 12pt % line spacing for 10pt CM
2063 \textfonts % reset the current fonts
2065 } % end of 10pt text font size definitions, \definetextfontsizex
2068 % We provide the user-level command
2070 % (or 11) to redefine the text font size. pt is assumed.
2076 \parseargdef\fonttextsize{%
2077 \def\textsizearg{#1}%
2078 %\wlog{doing @fonttextsize \textsizearg}%
2080 % Set \globaldefs so that documents can use this inside @tex, since
2081 % makeinfo 4.8 does not support it, but we need it nonetheless.
2083 \begingroup \globaldefs=1
2084 \ifx\textsizearg\xword \definetextfontsizex
2085 \else \ifx\textsizearg\xiword \definetextfontsizexi
2088 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2094 % In order for the font changes to affect most math symbols and letters,
2095 % we have to define the \textfont of the standard families. Since
2096 % texinfo doesn't allow for producing subscripts and superscripts except
2097 % in the main text, we don't bother to reset \scriptfont and
2098 % \scriptscriptfont (which would also require loading a lot more fonts).
2100 \def\resetmathfonts{%
2101 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2102 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2103 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2106 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2107 % of just \STYLE. We do this because \STYLE needs to also set the
2108 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2109 % \tenSTYLE to set the current font.
2111 % Each font-changing command also sets the names \lsize (one size lower)
2112 % and \lllsize (three sizes lower). These relative commands are used in
2113 % the LaTeX logo and acronyms.
2115 % This all needs generalizing, badly.
2118 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2119 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2120 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2121 \let\tenttsl=\textttsl
2122 \def\curfontsize{text}%
2123 \def\lsize{reduced}\def\lllsize{smaller}%
2124 \resetmathfonts \setleading{\textleading}}
2126 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2127 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2128 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2129 \let\tenttsl=\titlettsl
2130 \def\curfontsize{title}%
2131 \def\lsize{chap}\def\lllsize{subsec}%
2132 \resetmathfonts \setleading{27pt}}
2133 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2135 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2136 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2137 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2138 \let\tenttsl=\chapttsl
2139 \def\curfontsize{chap}%
2140 \def\lsize{sec}\def\lllsize{text}%
2141 \resetmathfonts \setleading{19pt}}
2143 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2144 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2145 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2146 \let\tenttsl=\secttsl
2147 \def\curfontsize{sec}%
2148 \def\lsize{subsec}\def\lllsize{reduced}%
2149 \resetmathfonts \setleading{17pt}}
2151 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2152 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2153 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2154 \let\tenttsl=\ssecttsl
2155 \def\curfontsize{ssec}%
2156 \def\lsize{text}\def\lllsize{small}%
2157 \resetmathfonts \setleading{15pt}}
2158 \let\subsubsecfonts = \subsecfonts
2160 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2161 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2162 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2163 \let\tenttsl=\reducedttsl
2164 \def\curfontsize{reduced}%
2165 \def\lsize{small}\def\lllsize{smaller}%
2166 \resetmathfonts \setleading{10.5pt}}
2168 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2169 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2170 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2171 \let\tenttsl=\smallttsl
2172 \def\curfontsize{small}%
2173 \def\lsize{smaller}\def\lllsize{smaller}%
2174 \resetmathfonts \setleading{10.5pt}}
2176 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2177 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2178 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2179 \let\tenttsl=\smallerttsl
2180 \def\curfontsize{smaller}%
2181 \def\lsize{smaller}\def\lllsize{smaller}%
2182 \resetmathfonts \setleading{9.5pt}}
2184 % Fonts for short table of contents.
2185 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2186 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2187 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2188 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2190 % Define these just so they can be easily changed for other fonts.
2191 \def\angleleft{$\langle$}
2192 \def\angleright{$\rangle$}
2194 % Set the fonts to use with the @small... environments.
2195 \let\smallexamplefonts = \smallfonts
2197 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2198 % can fit this many characters:
2199 % 8.5x11=86 smallbook=72 a4=90 a5=69
2200 % If we use \scriptfonts (8pt), then we can fit this many characters:
2201 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2202 % For me, subjectively, the few extra characters that fit aren't worth
2203 % the additional smallness of 8pt. So I'm making the default 9pt.
2205 % By the way, for comparison, here's what fits with @example (10pt):
2206 % 8.5x11=71 smallbook=60 a4=75 a5=58
2209 % Set up the default fonts, so we can use them for creating boxes.
2211 \definetextfontsizexi
2216 % Check if we are currently using a typewriter font. Since all the
2217 % Computer Modern typewriter fonts have zero interword stretch (and
2218 % shrink), and it is reasonable to expect all typewriter fonts to have
2219 % this property, we can check that font parameter.
2221 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2223 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2224 % define and register \INITMACRO to be called on markup style changes.
2225 % \INITMACRO can check \currentmarkupstyle for the innermost
2226 % style and the set of \ifmarkupSTYLE switches for all styles
2227 % currently in effect.
2231 %\newif\ifmarkupfile % @file == @samp.
2232 %\newif\ifmarkupoption % @option == @samp.
2235 %\newif\ifmarkupenv % @env == @code.
2236 %\newif\ifmarkupcommand % @command == @code.
2237 \newif\ifmarkuptex % @tex (and part of @math, for now).
2238 \newif\ifmarkupexample
2240 \newif\ifmarkupverbatim
2242 \let\currentmarkupstyle\empty
2244 \def\setupmarkupstyle#1{%
2245 \csname markup#1true\endcsname
2246 \def\currentmarkupstyle{#1}%
2250 \let\markupstylesetup\empty
2252 \def\defmarkupstylesetup#1{%
2253 \expandafter\def\expandafter\markupstylesetup
2254 \expandafter{\markupstylesetup #1}%
2258 % Markup style setup for left and right quotes.
2259 \defmarkupstylesetup\markupsetuplq{%
2260 \expandafter\let\expandafter \temp
2261 \csname markupsetuplq\currentmarkupstyle\endcsname
2262 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2265 \defmarkupstylesetup\markupsetuprq{%
2266 \expandafter\let\expandafter \temp
2267 \csname markupsetuprq\currentmarkupstyle\endcsname
2268 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2275 \gdef\markupsetuplqdefault{\let`\lq}
2276 \gdef\markupsetuprqdefault{\let'\rq}
2278 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2279 \gdef\markupsetcodequoteright{\let'\codequoteright}
2282 \let\markupsetuplqcode \markupsetcodequoteleft
2283 \let\markupsetuprqcode \markupsetcodequoteright
2285 \let\markupsetuplqexample \markupsetcodequoteleft
2286 \let\markupsetuprqexample \markupsetcodequoteright
2288 \let\markupsetuplqkbd \markupsetcodequoteleft
2289 \let\markupsetuprqkbd \markupsetcodequoteright
2291 \let\markupsetuplqsamp \markupsetcodequoteleft
2292 \let\markupsetuprqsamp \markupsetcodequoteright
2294 \let\markupsetuplqverb \markupsetcodequoteleft
2295 \let\markupsetuprqverb \markupsetcodequoteright
2297 \let\markupsetuplqverbatim \markupsetcodequoteleft
2298 \let\markupsetuprqverbatim \markupsetcodequoteright
2300 % Allow an option to not use regular directed right quote/apostrophe
2301 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2302 % The undirected quote is ugly, so don't make it the default, but it
2303 % works for pasting with more pdf viewers (at least evince), the
2304 % lilypond developers report. xpdf does work with the regular 0x27.
2306 \def\codequoteright{%
2307 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2308 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2314 % and a similar option for the left quote char vs. a grave accent.
2315 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2316 % the code environments to do likewise.
2318 \def\codequoteleft{%
2319 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2320 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2321 % [Knuth] pp. 380,381,391
2322 % \relax disables Spanish ligatures ?` and !` of \tt font.
2328 % Commands to set the quote options.
2330 \parseargdef\codequoteundirected{%
2333 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2335 \else\ifx\temp\offword
2336 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2339 \errhelp = \EMsimple
2340 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2344 \parseargdef\codequotebacktick{%
2347 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2349 \else\ifx\temp\offword
2350 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2353 \errhelp = \EMsimple
2354 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2358 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2359 \def\noligaturesquoteleft{\relax\lq}
2361 % Count depth in font-changes, for error checks
2362 \newcount\fontdepth \fontdepth=0
2366 % #1 is the font command (\sl or \it), #2 is the text to slant.
2367 % If we are in a monospaced environment, however, 1) always use \ttsl,
2368 % and 2) do not add an italic correction.
2369 \def\dosmartslant#1#2{%
2371 {{\ttsl #2}\let\next=\relax}%
2372 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2375 \def\smartslanted{\dosmartslant\sl}
2376 \def\smartitalic{\dosmartslant\it}
2378 % Output an italic correction unless \next (presumed to be the following
2379 % character) is such as not to need one.
2380 \def\smartitaliccorrection{%
2385 \else\ifx\next\comma%
2391 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2392 \def\ttslanted#1{{\ttsl #1}}
2394 % @cite is like \smartslanted except unconditionally use \sl. We never want
2395 % ttsl for book titles, do we?
2396 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2400 \let\saveaftersmartic = \aftersmartic
2401 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2406 \let\slanted=\smartslanted
2407 \let\dfn=\smartslanted
2408 \let\emph=\smartitalic
2410 % Explicit font changes: @r, @sc, undocumented @ii.
2411 \def\r#1{{\rm #1}} % roman font
2412 \def\sc#1{{\smallcaps#1}} % smallcaps font
2413 \def\ii#1{{\it #1}} % italic font
2415 % @b, explicit bold. Also @strong.
2419 % @sansserif, explicit sans.
2420 \def\sansserif#1{{\sf #1}}
2422 % We can't just use \exhyphenpenalty, because that only has effect at
2423 % the end of a paragraph. Restore normal hyphenation at the end of the
2424 % group within which \nohyphenation is presumably called.
2426 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2427 \def\restorehyphenation{\hyphenchar\font = `- }
2429 % Set sfcode to normal for the chars that usually have another value.
2430 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2431 % sometimes \x has an active definition that messes things up.
2434 \def\plainfrenchspacing{%
2435 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2436 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2437 \def\endofsentencespacefactor{1000}% for @. and friends
2439 \def\plainnonfrenchspacing{%
2440 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2441 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2442 \def\endofsentencespacefactor{3000}% for @. and friends
2445 \def\endofsentencespacefactor{3000}% default
2447 % @t, explicit typewriter.
2449 {\tt \rawbackslash \plainfrenchspacing #1}%
2454 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2456 % @indicateurl is \samp, that is, with quotes.
2457 \let\indicateurl=\samp
2459 % @code (and similar) prints in typewriter, but with spaces the same
2460 % size as normal in the surrounding text, without hyphenation, etc.
2461 % This is a subroutine for that.
2464 % Change normal interword space to be same as for the current font.
2465 \spaceskip = \fontdimen2\font
2467 % Switch to typewriter.
2470 % But `\ ' produces the large typewriter interword space.
2471 \def\ {{\spaceskip = 0pt{} }}%
2473 % Turn off hyphenation.
2480 \null % reset spacefactor to 1000
2483 % We *must* turn on hyphenation at `-' and `_' in @code.
2484 % (But see \codedashfinish below.)
2485 % Otherwise, it is too hard to avoid overfull hboxes
2486 % in the Emacs manual, the Library manual, etc.
2488 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2489 % both hyphenation at - and hyphenation within words.
2490 % We must therefore turn them both off (\tclose does that)
2491 % and arrange explicitly to hyphenate at a dash. -- rms.
2493 \catcode`\-=\active \catcode`\_=\active
2494 \catcode`\'=\active \catcode`\`=\active
2495 \global\let'=\rq \global\let`=\lq % default definitions
2497 \global\def\code{\begingroup
2498 \setupmarkupstyle{code}%
2499 % The following should really be moved into \setupmarkupstyle handlers.
2500 \catcode\dashChar=\active \catcode\underChar=\active
2508 % Given -foo (with a single dash), we do not want to allow a break
2510 \global\let\codedashprev=\codedash
2515 \gdef\codedash{\futurelet\next\codedashfinish}
2516 \gdef\codedashfinish{%
2517 \normaldash % always output the dash character itself.
2519 % Now, output a discretionary to allow a line break, unless
2520 % (a) the next character is a -, or
2521 % (b) the preceding character is a -.
2522 % E.g., given --posix, we do not want to allow a break after either -.
2523 % Given --foo-bar, we do want to allow a break between the - and the b.
2524 \ifx\next\codedash \else
2525 \ifx\codedashprev\codedash
2526 \else \discretionary{}{}{}\fi
2528 % we need the space after the = for the case when \next itself is a
2529 % space token; it would get swallowed otherwise. As in @code{- a}.
2530 \global\let\codedashprev= \next
2535 \def\codex #1{\tclose{#1}\endgroup}
2538 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2539 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2540 % will therefore expand the active definition of _, which is us
2541 % (inside @code that is), therefore an endless loop.
2543 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2544 \else\normalunderscore \fi
2545 \discretionary{}{}{}}%
2549 % An additional complication: the above will allow breaks after, e.g.,
2550 % each of the four underscores in __typeof__. This is bad.
2551 % @allowcodebreaks provides a document-level way to turn breaking at -
2554 \newif\ifallowcodebreaks \allowcodebreakstrue
2556 \def\keywordtrue{true}
2557 \def\keywordfalse{false}
2559 \parseargdef\allowcodebreaks{%
2561 \ifx\txiarg\keywordtrue
2562 \allowcodebreakstrue
2563 \else\ifx\txiarg\keywordfalse
2564 \allowcodebreaksfalse
2566 \errhelp = \EMsimple
2567 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2571 % For @command, @env, @file, @option quotes seem unnecessary,
2572 % so use \code rather than \samp.
2578 % @uref (abbreviation for `urlref') aka @url takes an optional
2579 % (comma-separated) second argument specifying the text to display and
2580 % an optional third arg as text to display instead of (rather than in
2581 % addition to) the url itself. First (mandatory) arg is the url.
2583 % TeX-only option to allow changing PDF output to show only the second
2584 % arg (if given), and not the url (which is then just the link target).
2585 \newif\ifurefurlonlylink
2587 % The main macro is \urefbreak, which allows breaking at expected
2588 % places within the url. (There used to be another version, which
2589 % didn't support automatic breaking.)
2590 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2591 \let\uref=\urefbreak
2593 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2594 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2597 \setbox0 = \hbox{\ignorespaces #3}%
2599 \unhbox0 % third arg given, show only that
2601 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2605 % PDF plus option to not display url, show just arg
2608 % PDF, normally display both arg and url for consistency,
2609 % visibility, if the pdf is eventually used to print, etc.
2610 \unhbox0\ (\urefcode{#1})%
2613 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2616 \urefcode{#1}% only url given, so show it
2622 % Allow line breaks around only a few characters (only).
2624 \catcode\ampChar=\active \catcode\dotChar=\active
2625 \catcode\hashChar=\active \catcode\questChar=\active
2626 \catcode\slashChar=\active
2631 \global\def\urefcode{\begingroup
2632 \setupmarkupstyle{code}%
2642 % By default, they are just regular characters.
2643 \global\def&{\normalamp}
2644 \global\def.{\normaldot}
2645 \global\def#{\normalhash}
2646 \global\def?{\normalquest}
2647 \global\def/{\normalslash}
2650 % we put a little stretch before and after the breakable chars, to help
2651 % line breaking of long url's. The unequal skips make look better in
2652 % cmtt at least, especially for dots.
2653 \def\urefprestretchamount{.13em}
2654 \def\urefpoststretchamount{.1em}
2655 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
2656 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
2658 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2659 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2660 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2661 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2662 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2665 \global\def\urefcodeslashfinish{%
2666 \urefprestretch \slashChar
2667 % Allow line break only after the final / in a sequence of
2668 % slashes, to avoid line break between the slashes in http://.
2669 \ifx\next/\else \urefpoststretch \fi
2673 % One more complication: by default we'll break after the special
2674 % characters, but some people like to break before the special chars, so
2675 % allow that. Also allow no breaking at all, for manual control.
2677 \parseargdef\urefbreakstyle{%
2679 \ifx\txiarg\wordnone
2680 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2681 \else\ifx\txiarg\wordbefore
2682 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2683 \else\ifx\txiarg\wordafter
2684 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2686 \errhelp = \EMsimple
2687 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2690 \def\wordafter{after}
2691 \def\wordbefore{before}
2694 \urefbreakstyle after
2696 % @url synonym for @uref, since that's how everyone uses it.
2700 % rms does not like angle brackets --karl, 17may97.
2701 % So now @email is just like @uref, unless we are pdf.
2703 %\def\email#1{\angleleft{\tt #1}\angleright}
2705 \def\email#1{\doemail#1,,\finish}
2706 \def\doemail#1,#2,#3\finish{\begingroup
2709 \setbox0 = \hbox{\ignorespaces #2}%
2710 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2717 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2718 % `example' (@kbd uses ttsl only inside of @example and friends),
2719 % or `code' (@kbd uses normal tty font always).
2720 \parseargdef\kbdinputstyle{%
2722 \ifx\txiarg\worddistinct
2723 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2724 \else\ifx\txiarg\wordexample
2725 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2726 \else\ifx\txiarg\wordcode
2727 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2729 \errhelp = \EMsimple
2730 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2733 \def\worddistinct{distinct}
2734 \def\wordexample{example}
2737 % Default is `distinct'.
2738 \kbdinputstyle distinct
2740 % @kbd is like @code, except that if the argument is just one @key command,
2741 % then @kbd has no effect.
2742 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2745 \def\kbdsub#1#2#3\par{%
2746 \def\one{#1}\def\three{#3}\def\threex{??}%
2747 \ifx\one\xkey\ifx\threex\three \key{#2}%
2748 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2749 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2752 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2753 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2755 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2756 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2757 % \vbox{\hrule\kern-0.4pt
2758 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2759 % \kern-0.4pt\hrule}%
2760 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2762 % definition of @key with no lozenge. If the current font is already
2763 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2764 % if it isn't monospace, then use \tt.
2766 \def\key#1{{\setupmarkupstyle{key}%
2768 \ifmonospace\else\tt\fi
2771 % @clicksequence{File @click{} Open ...}
2772 \def\clicksequence#1{\begingroup #1\endgroup}
2774 % @clickstyle @arrow (by default)
2775 \parseargdef\clickstyle{\def\click{#1}}
2778 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2779 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2781 \def\dmn#1{\thinspace #1}
2783 % @l was never documented to mean ``switch to the Lisp font'',
2784 % and it is not used as such in any manual I can find. We need it for
2785 % Polish suppressed-l. --karl, 22sep96.
2786 %\def\l#1{{\li #1}\null}
2788 % @acronym for "FBI", "NATO", and the like.
2789 % We print this one point size smaller, since it's intended for
2792 \def\acronym#1{\doacronym #1,,\finish}
2793 \def\doacronym#1,#2,#3\finish{%
2794 {\selectfonts\lsize #1}%
2796 \ifx\temp\empty \else
2797 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2799 \null % reset \spacefactor=1000
2802 % @abbr for "Comput. J." and the like.
2803 % No font change, but don't do end-of-sentence spacing.
2805 \def\abbr#1{\doabbr #1,,\finish}
2806 \def\doabbr#1,#2,#3\finish{%
2807 {\plainfrenchspacing #1}%
2809 \ifx\temp\empty \else
2810 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2812 \null % reset \spacefactor=1000
2815 % @asis just yields its argument. Used with @table, for example.
2819 % @math outputs its argument in math mode.
2821 % One complication: _ usually means subscripts, but it could also mean
2822 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2823 % _ active, and distinguish by seeing if the current family is \slfam,
2824 % which is what @var uses.
2826 \catcode`\_ = \active
2827 \gdef\mathunderscore{%
2829 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2832 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2833 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2834 % particular reason), but this is not advertised and we don't care.
2836 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2837 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2842 \let\\ = \mathbackslash
2844 % make the texinfo accent commands work in math mode
2856 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2858 % Some active characters (such as <) are spaced differently in math.
2859 % We have to reset their definitions in case the @math was an argument
2860 % to a command which sets the catcodes (such as @item or @section).
2863 \catcode`^ = \active
2864 \catcode`< = \active
2865 \catcode`> = \active
2866 \catcode`+ = \active
2867 \catcode`' = \active
2873 \let' = \ptexquoteright
2877 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2878 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2880 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2881 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2882 % except specified as a normal braced arg, so no newlines to worry about.
2884 \def\outfmtnametex{tex}
2886 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2887 \long\def\doinlinefmt#1,#2,\finish{%
2888 \def\inlinefmtname{#1}%
2889 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2892 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2893 % FMTNAME is tex, else ELSE-TEXT.
2894 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
2895 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
2896 \def\inlinefmtname{#1}%
2897 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2900 % For raw, must switch into @tex before parsing the argument, to avoid
2901 % setting catcodes prematurely. Doing it this way means that, for
2902 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2903 % ignored. But this isn't important because if people want a literal
2904 % *right* brace they would have to use a command anyway, so they may as
2905 % well use a command to get a left brace too. We could re-use the
2906 % delimiter character idea from \verb, but it seems like overkill.
2908 \long\def\inlineraw{\tex \doinlineraw}
2909 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2910 \def\doinlinerawtwo#1,#2,\finish{%
2911 \def\inlinerawname{#1}%
2912 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2913 \endgroup % close group opened by \tex.
2916 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2918 \long\def\inlineifset#1{\doinlineifset #1,\finish}
2919 \long\def\doinlineifset#1,#2,\finish{%
2920 \def\inlinevarname{#1}%
2921 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
2922 \else\ignorespaces#2\fi
2925 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2927 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
2928 \long\def\doinlineifclear#1,#2,\finish{%
2929 \def\inlinevarname{#1}%
2930 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
2937 % @@ prints an @, as does @atchar{}.
2941 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2942 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2943 % not have braces, and we don't want to switch into math.
2944 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2945 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2946 \let\{=\mylbrace \let\lbracechar=\{
2947 \let\}=\myrbrace \let\rbracechar=\}
2949 % Definitions to produce \{ and \} commands for indices,
2950 % and @{ and @} for the aux/toc files.
2951 \catcode`\{ = \other \catcode`\} = \other
2952 \catcode`\[ = 1 \catcode`\] = 2
2953 \catcode`\! = 0 \catcode`\\ = \other
2954 !gdef!lbracecmd[\{]%
2955 !gdef!rbracecmd[\}]%
2956 !gdef!lbraceatcmd[@{]%
2957 !gdef!rbraceatcmd[@}]%
2960 % @comma{} to avoid , parsing problems.
2963 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2964 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2966 \let\dotaccent = \ptexdot
2967 \def\ringaccent#1{{\accent23 #1}}
2968 \let\tieaccent = \ptext
2969 \let\ubaraccent = \ptexb
2970 \let\udotaccent = \d
2972 % Other special characters: @questiondown @exclamdown @ordf @ordm
2973 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2974 \def\questiondown{?`}
2976 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2977 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2979 % Dotless i and dotless j, used for accents.
2984 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2985 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2986 \else \errmessage{@dotless can be used only with i or j}%
2990 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2991 % period following counts as ending a sentence. (Idea found in latex.)
2993 \edef\TeX{\TeX \spacefactor=1000 }
2995 % @LaTeX{} logo. Not quite the same results as the definition in
2996 % latex.ltx, since we use a different font for the raised A; it's most
2997 % convenient for us to use an explicitly smaller font, rather than using
2998 % the \scriptstyle font (since we don't reset \scriptstyle and
2999 % \scriptscriptstyle).
3004 \vbox to \ht0{\hbox{%
3005 \ifx\textnominalsize\xwordpt
3006 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3007 % Revert to plain's \scriptsize, which is 7pt.
3008 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3010 % For 11pt, we can use our lllsize.
3011 \selectfonts\lllsize A%
3020 % Some math mode symbols.
3021 \def\bullet{$\ptexbullet$}
3022 \def\geq{\ifmmode \ge\else $\ge$\fi}
3023 \def\leq{\ifmmode \le\else $\le$\fi}
3024 \def\minus{\ifmmode -\else $-$\fi}
3026 % @dots{} outputs an ellipsis using the current font.
3027 % We do .5em per period so that it has the same spacing in the cm
3028 % typewriter fonts as three actual period characters; on the other hand,
3029 % in other typewriter fonts three periods are wider than 1.5em. So do
3030 % whichever is larger.
3034 \setbox0=\hbox{...}% get width of three periods
3041 \hskip 0pt plus.25fil
3042 .\hskip 0pt plus1fil
3043 .\hskip 0pt plus1fil
3044 .\hskip 0pt plus.5fil
3048 % @enddots{} is an end-of-sentence ellipsis.
3052 \spacefactor=\endofsentencespacefactor
3055 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3057 % Since these characters are used in examples, they should be an even number of
3058 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3061 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3062 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3063 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3064 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3065 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3067 % The @error{} command.
3068 % Adapted from the TeXbook's \boxit.
3072 {\tentt \global\dimen0 = 3em}% Width of the box.
3073 \dimen2 = .55pt % Thickness of rules
3074 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3075 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3077 \setbox\errorbox=\hbox to \dimen0{\hfil
3078 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3079 \advance\hsize by -2\dimen2 % Rules.
3081 \hrule height\dimen2
3082 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3083 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3084 \kern3pt\vrule width\dimen2}% Space to right.
3085 \hrule height\dimen2}
3088 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3090 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3092 \def\pounds{{\it\$}}
3094 % @euro{} comes from a separate font, depending on the current style.
3095 % We use the free feym* fonts from the eurosym package by Henrik
3096 % Theiling, which support regular, slanted, bold and bold slanted (and
3097 % "outlined" (blackboard board, sort of) versions, which we don't need).
3098 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3100 % Although only regular is the truly official Euro symbol, we ignore
3101 % that. The Euro is designed to be slightly taller than the regular
3107 % feybo - bold slanted
3109 % There is no good (free) typewriter version, to my knowledge.
3110 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3113 % Also doesn't work in math. Do we need to do math with euro symbols?
3117 \def\euro{{\eurofont e}}
3119 % We set the font at each command, rather than predefining it in
3120 % \textfonts and the other font-switching commands, so that
3121 % installations which never need the symbol don't have to have the
3124 % There is only one designed size (nominal 10pt), so we always scale
3125 % that to the current nominal size.
3127 % By the way, simply using "at 1em" works for cmr10 and the like, but
3128 % does not work for cmbx10 and other extended/shrunken fonts.
3130 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3132 \ifx\curfontstyle\bfstylename
3134 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3137 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3142 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3143 % sometimes we redefine the original macro, and the alias should reflect
3146 % Use LaTeX names for the Icelandic letters.
3147 \def\DH{{\ecfont \char"D0}} % Eth
3148 \def\dh{{\ecfont \char"F0}} % eth
3149 \def\TH{{\ecfont \char"DE}} % Thorn
3150 \def\th{{\ecfont \char"FE}} % thorn
3152 \def\guillemetleft{{\ecfont \char"13}}
3153 \def\guillemotleft{\guillemetleft}
3154 \def\guillemetright{{\ecfont \char"14}}
3155 \def\guillemotright{\guillemetright}
3156 \def\guilsinglleft{{\ecfont \char"0E}}
3157 \def\guilsinglright{{\ecfont \char"0F}}
3158 \def\quotedblbase{{\ecfont \char"12}}
3159 \def\quotesinglbase{{\ecfont \char"0D}}
3161 % This positioning is not perfect (see the ogonek LaTeX package), but
3162 % we have the precomposed glyphs for the most common cases. We put the
3163 % tests to use those glyphs in the single \ogonek macro so we have fewer
3164 % dummy definitions to worry about for index entries, etc.
3166 % ogonek is also used with other letters in Lithuanian (IOU), but using
3167 % the precomposed glyphs for those is not so easy since they aren't in
3171 \ifx\temp\macrocharA\Aogonek
3172 \else\ifx\temp\macrochara\aogonek
3173 \else\ifx\temp\macrocharE\Eogonek
3174 \else\ifx\temp\macrochare\eogonek
3176 \ecfont \setbox0=\hbox{#1}%
3177 \ifdim\ht0=1ex\accent"0C #1%
3178 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3183 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3184 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3185 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3186 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3188 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3190 % We can't distinguish serif/sans and italic/slanted, but this
3191 % is used for crude hacks anyway (like adding French and German
3192 % quotes to documents typeset with CM, where we lose kerning), so
3193 % hopefully nobody will notice/care.
3194 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3195 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3198 \font\thisecfont = ectt\ecsize \space at \nominalsize
3200 \ifx\curfontstyle\bfstylename
3202 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3205 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3211 % @registeredsymbol - R in a circle. The font for the R should really
3212 % be smaller yet, but lllsize is the best we can do for now.
3213 % Adapted from the plain.tex definition of \copyright.
3215 \def\registeredsymbol{%
3216 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3221 % @textdegree - the normal degrees sign.
3223 \def\textdegree{$^\circ$}
3225 % Laurent Siebenmann reports \Orb undefined with:
3226 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3227 % so we'll define it if necessary.
3229 \ifx\Orb\thisisundefined
3230 \def\Orb{\mathhexbox20D}
3234 \chardef\quotedblleft="5C
3235 \chardef\quotedblright=`\"
3236 \chardef\quoteleft=`\`
3237 \chardef\quoteright=`\'
3240 \message{page headings,}
3242 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3243 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3245 % First the title page. Must do @settitle before @titlepage.
3247 \newif\iffinishedtitlepage
3249 % Do an implicit @contents or @shortcontents after @end titlepage if the
3250 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3252 \newif\ifsetcontentsaftertitlepage
3253 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3254 \newif\ifsetshortcontentsaftertitlepage
3255 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3257 \parseargdef\shorttitlepage{%
3258 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3259 \endgroup\page\hbox{}\page}
3262 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3264 \parindent=0pt \textfonts
3265 % Leave some space at the very top of the page.
3266 \vglue\titlepagetopglue
3267 % No rule at page bottom unless we print one at the top with @title.
3268 \finishedtitlepagetrue
3270 % Most title ``pages'' are actually two pages long, with space
3271 % at the top of the second. We don't want the ragged left on the second.
3272 \let\oldpage = \page
3274 \iffinishedtitlepage\else
3277 \let\page = \oldpage
3284 \iffinishedtitlepage\else
3287 % It is important to do the page break before ending the group,
3288 % because the headline and footline are only empty inside the group.
3289 % If we use the new definition of \page, we always get a blank page
3290 % after the title page, which we certainly don't want.
3294 % Need this before the \...aftertitlepage checks so that if they are
3295 % in effect the toc pages will come out with page numbers.
3298 % If they want short, they certainly want long too.
3299 \ifsetshortcontentsaftertitlepage
3302 \global\let\shortcontents = \relax
3303 \global\let\contents = \relax
3306 \ifsetcontentsaftertitlepage
3308 \global\let\contents = \relax
3309 \global\let\shortcontents = \relax
3313 \def\finishtitlepage{%
3314 \vskip4pt \hrule height 2pt width \hsize
3315 \vskip\titlepagebottomglue
3316 \finishedtitlepagetrue
3319 % Settings used for typesetting titles: no hyphenation, no indentation,
3320 % don't worry much about spacing, ragged right. This should be used
3321 % inside a \vbox, and fonts need to be set appropriately first. Because
3322 % it is always used for titles, nothing else, we call \rmisbold. \par
3323 % should be specified before the end of the \vbox, since a vbox is a group.
3325 \def\raggedtitlesettings{%
3327 \hyphenpenalty=10000
3333 % Macros to be used within @titlepage:
3335 \let\subtitlerm=\tenrm
3336 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3338 \parseargdef\title{%
3340 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3341 % print a rule at the page bottom also.
3342 \finishedtitlepagefalse
3343 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3346 \parseargdef\subtitle{%
3348 {\subtitlefont \rightline{#1}}%
3351 % @author should come last, but may come many times.
3352 % It can also be used inside @quotation.
3354 \parseargdef\author{%
3355 \def\temp{\quotation}%
3357 \def\quotationauthor{#1}% printed in \Equotation.
3360 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3361 {\secfonts\rmisbold \leftline{#1}}%
3366 % Set up page headings and footings.
3368 \let\thispage=\folio
3370 \newtoks\evenheadline % headline on even pages
3371 \newtoks\oddheadline % headline on odd pages
3372 \newtoks\evenfootline % footline on even pages
3373 \newtoks\oddfootline % footline on odd pages
3375 % Now make TeX use those variables
3376 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3377 \else \the\evenheadline \fi}}
3378 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3379 \else \the\evenfootline \fi}\HEADINGShook}
3380 \let\HEADINGShook=\relax
3382 % Commands to set those variables.
3383 % For example, this is what @headings on does
3384 % @evenheading @thistitle|@thispage|@thischapter
3385 % @oddheading @thischapter|@thispage|@thistitle
3386 % @evenfooting @thisfile||
3387 % @oddfooting ||@thisfile
3390 \def\evenheading{\parsearg\evenheadingxxx}
3391 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3392 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3393 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3395 \def\oddheading{\parsearg\oddheadingxxx}
3396 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3397 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3398 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3400 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3402 \def\evenfooting{\parsearg\evenfootingxxx}
3403 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3404 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3405 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3407 \def\oddfooting{\parsearg\oddfootingxxx}
3408 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3409 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3410 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3412 % Leave some space for the footline. Hopefully ok to assume
3413 % @evenfooting will not be used by itself.
3414 \global\advance\pageheight by -12pt
3415 \global\advance\vsize by -12pt
3418 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3420 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3421 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3423 % The same set of arguments for:
3428 % @everyheadingmarks
3429 % @everyfootingmarks
3431 \def\evenheadingmarks{\headingmarks{even}{heading}}
3432 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3433 \def\evenfootingmarks{\headingmarks{even}{footing}}
3434 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3435 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3436 \headingmarks{odd}{heading}{#1} }
3437 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3438 \headingmarks{odd}{footing}{#1} }
3439 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3440 \def\headingmarks#1#2#3 {%
3441 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3442 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3445 \everyheadingmarks bottom
3446 \everyfootingmarks bottom
3448 % @headings double turns headings on for double-sided printing.
3449 % @headings single turns headings on for single-sided printing.
3450 % @headings off turns them off.
3451 % @headings on same as @headings double, retained for compatibility.
3452 % @headings after turns on double-sided headings after this page.
3453 % @headings doubleafter turns on double-sided headings after this page.
3454 % @headings singleafter turns on single-sided headings after this page.
3455 % By default, they are off at the start of a document,
3456 % and turned `on' after @end titlepage.
3458 \def\headings #1 {\csname HEADINGS#1\endcsname}
3460 \def\headingsoff{% non-global headings elimination
3461 \evenheadline={\hfil}\evenfootline={\hfil}%
3462 \oddheadline={\hfil}\oddfootline={\hfil}%
3465 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3466 \HEADINGSoff % it's the default
3468 % When we turn headings on, set the page number to 1.
3469 % For double-sided printing, put current file name in lower left corner,
3470 % chapter name on inside top of right hand pages, document
3471 % title on inside top of left hand pages, and page numbers on outside top
3472 % edge of all pages.
3473 \def\HEADINGSdouble{%
3475 \global\evenfootline={\hfil}
3476 \global\oddfootline={\hfil}
3477 \global\evenheadline={\line{\folio\hfil\thistitle}}
3478 \global\oddheadline={\line{\thischapter\hfil\folio}}
3479 \global\let\contentsalignmacro = \chapoddpage
3481 \let\contentsalignmacro = \chappager
3483 % For single-sided printing, chapter title goes across top left of page,
3484 % page number on top right.
3485 \def\HEADINGSsingle{%
3487 \global\evenfootline={\hfil}
3488 \global\oddfootline={\hfil}
3489 \global\evenheadline={\line{\thischapter\hfil\folio}}
3490 \global\oddheadline={\line{\thischapter\hfil\folio}}
3491 \global\let\contentsalignmacro = \chappager
3493 \def\HEADINGSon{\HEADINGSdouble}
3495 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3496 \let\HEADINGSdoubleafter=\HEADINGSafter
3497 \def\HEADINGSdoublex{%
3498 \global\evenfootline={\hfil}
3499 \global\oddfootline={\hfil}
3500 \global\evenheadline={\line{\folio\hfil\thistitle}}
3501 \global\oddheadline={\line{\thischapter\hfil\folio}}
3502 \global\let\contentsalignmacro = \chapoddpage
3505 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3506 \def\HEADINGSsinglex{%
3507 \global\evenfootline={\hfil}
3508 \global\oddfootline={\hfil}
3509 \global\evenheadline={\line{\thischapter\hfil\folio}}
3510 \global\oddheadline={\line{\thischapter\hfil\folio}}
3511 \global\let\contentsalignmacro = \chappager
3514 % Subroutines used in generating headings
3515 % This produces Day Month Year style of output.
3516 % Only define if not already defined, in case a txi-??.tex file has set
3517 % up a different format (e.g., txi-cs.tex does this).
3518 \ifx\today\thisisundefined
3522 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3523 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3524 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3529 % @settitle line... specifies the title of the document, for headings.
3530 % It generates no output of its own.
3531 \def\thistitle{\putwordNoTitle}
3532 \def\settitle{\parsearg{\gdef\thistitle}}
3536 % Tables -- @table, @ftable, @vtable, @item(x).
3538 % default indentation of table text
3539 \newdimen\tableindent \tableindent=.8in
3540 % default indentation of @itemize and @enumerate text
3541 \newdimen\itemindent \itemindent=.3in
3542 % margin between end of table item and start of table text.
3543 \newdimen\itemmargin \itemmargin=.1in
3545 % used internally for \itemindent minus \itemmargin
3548 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3550 % They also define \itemindex
3551 % to index the item name in whatever manner is desired (perhaps none).
3553 \newif\ifitemxneedsnegativevskip
3555 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3557 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3558 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3560 \def\itemzzz #1{\begingroup %
3561 \advance\hsize by -\rightskip
3562 \advance\hsize by -\tableindent
3563 \setbox0=\hbox{\itemindicate{#1}}%
3565 \nobreak % This prevents a break before @itemx.
3567 % If the item text does not fit in the space we have, put it on a line
3568 % by itself, and do not allow a page break either before or after that
3569 % line. We do not start a paragraph here because then if the next
3570 % command is, e.g., @kindex, the whatsit would get put into the
3571 % horizontal list on a line by itself, resulting in extra blank space.
3572 \ifdim \wd0>\itemmax
3574 % Make this a paragraph so we get the \parskip glue and wrapping,
3575 % but leave it ragged-right.
3577 \advance\leftskip by-\tableindent
3578 \advance\hsize by\tableindent
3579 \advance\rightskip by0pt plus1fil\relax
3580 \leavevmode\unhbox0\par
3583 % We're going to be starting a paragraph, but we don't want the
3584 % \parskip glue -- logically it's part of the @item we just started.
3585 \nobreak \vskip-\parskip
3587 % Stop a page break at the \parskip glue coming up. However, if
3588 % what follows is an environment such as @example, there will be no
3589 % \parskip glue; then the negative vskip we just inserted would
3590 % cause the example and the item to crash together. So we use this
3591 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3592 % \parskip glue after all. Section titles are handled this way also.
3596 \itemxneedsnegativevskipfalse
3598 % The item text fits into the space. Start a paragraph, so that the
3599 % following text (if any) will end up on the same line.
3601 % Do this with kerns and \unhbox so that if there is a footnote in
3602 % the item text, it can migrate to the main vertical list and
3603 % eventually be printed.
3604 \nobreak\kern-\tableindent
3605 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3607 \nobreak\kern\dimen0
3609 \itemxneedsnegativevskiptrue
3613 \def\item{\errmessage{@item while not in a list environment}}
3614 \def\itemx{\errmessage{@itemx while not in a list environment}}
3616 % @table, @ftable, @vtable.
3618 \let\itemindex\gobble
3622 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3623 \tablecheck{ftable}%
3626 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3627 \tablecheck{vtable}%
3630 \ifnum \the\catcode`\^^M=\active
3632 \errmessage{This command won't work in this context; perhaps the problem is
3633 that we are \inenvironment\thisenv}%
3634 \def\next{\doignore{#1}}%
3641 \def\itemindicate{#1}%
3646 \makevalueexpandable
3647 \edef\temp{\noexpand\tablez #1\space\space\space}%
3651 \def\tablez #1 #2 #3 #4\endtablez{%
3653 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3654 \ifnum 0#2>0 \tableindent=#2\mil \fi
3655 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3656 \itemmax=\tableindent
3657 \advance \itemmax by -\itemmargin
3658 \advance \leftskip by \tableindent
3659 \exdentamount=\tableindent
3661 \parskip = \smallskipamount
3662 \ifdim \parskip=0pt \parskip=2pt \fi
3663 \let\item = \internalBitem
3664 \let\itemx = \internalBitemx
3666 \def\Etable{\endgraf\afterenvbreak}
3669 \let\Eitemize\Etable
3670 \let\Eenumerate\Etable
3672 % This is the counter used by @enumerate, which is really @itemize
3676 \envdef\itemize{\parsearg\doitemize}
3680 \itemmax=\itemindent
3681 \advance\itemmax by -\itemmargin
3682 \advance\leftskip by \itemindent
3683 \exdentamount=\itemindent
3685 \parskip=\smallskipamount
3686 \ifdim\parskip=0pt \parskip=2pt \fi
3688 % Try typesetting the item mark so that if the document erroneously says
3689 % something like @itemize @samp (intending @table), there's an error
3690 % right away at the @itemize. It's not the best error message in the
3691 % world, but it's better than leaving it to the @item. This means if
3692 % the user wants an empty mark, they have to say @w{} not just @w.
3693 \def\itemcontents{#1}%
3694 \setbox0 = \hbox{\itemcontents}%
3696 % @itemize with no arg is equivalent to @itemize @bullet.
3697 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3699 \let\item=\itemizeitem
3702 % Definition of @item while inside @itemize and @enumerate.
3705 \advance\itemno by 1 % for enumerations
3706 {\let\par=\endgraf \smallbreak}% reasonable place to break
3708 % If the document has an @itemize directly after a section title, a
3709 % \nobreak will be last on the list, and \sectionheading will have
3710 % done a \vskip-\parskip. In that case, we don't want to zero
3711 % parskip, or the item text will crash with the heading. On the
3712 % other hand, when there is normal text preceding the item (as there
3713 % usually is), we do want to zero parskip, or there would be too much
3714 % space. In that case, we won't have a \nobreak before. At least
3715 % that's the theory.
3716 \ifnum\lastpenalty<10000 \parskip=0in \fi
3718 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3720 \vadjust{\penalty 1200}}% not good to break after first line of item.
3724 % \splitoff TOKENS\endmark defines \first to be the first token in
3725 % TOKENS, and \rest to be the remainder.
3727 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3729 % Allow an optional argument of an uppercase letter, lowercase letter,
3730 % or number, to specify the first label in the enumerated list. No
3731 % argument is the same as `1'.
3733 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3734 \def\enumeratey #1 #2\endenumeratey{%
3735 % If we were given no argument, pretend we were given `1'.
3737 \ifx\thearg\empty \def\thearg{1}\fi
3739 % Detect if the argument is a single token. If so, it might be a
3740 % letter. Otherwise, the only valid thing it can be is a number.
3741 % (We will always have one token, because of the test we just made.
3742 % This is a good thing, since \splitoff doesn't work given nothing at
3743 % all -- the first parameter is undelimited.)
3744 \expandafter\splitoff\thearg\endmark
3746 % Only one token in the argument. It could still be anything.
3747 % A ``lowercase letter'' is one whose \lccode is nonzero.
3748 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3749 % not equal to itself.
3750 % Otherwise, we assume it's a number.
3752 % We need the \relax at the end of the \ifnum lines to stop TeX from
3753 % continuing to look for a <number>.
3755 \ifnum\lccode\expandafter`\thearg=0\relax
3756 \numericenumerate % a number (we hope)
3759 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3760 \lowercaseenumerate % lowercase letter
3762 \uppercaseenumerate % uppercase letter
3766 % Multiple tokens in the argument. We hope it's a number.
3771 % An @enumerate whose labels are integers. The starting integer is
3774 \def\numericenumerate{%
3776 \startenumeration{\the\itemno}%
3779 % The starting (lowercase) letter is in \thearg.
3780 \def\lowercaseenumerate{%
3781 \itemno = \expandafter`\thearg
3783 % Be sure we're not beyond the end of the alphabet.
3785 \errmessage{No more lowercase letters in @enumerate; get a bigger
3792 % The starting (uppercase) letter is in \thearg.
3793 \def\uppercaseenumerate{%
3794 \itemno = \expandafter`\thearg
3796 % Be sure we're not beyond the end of the alphabet.
3798 \errmessage{No more uppercase letters in @enumerate; get a bigger
3805 % Call \doitemize, adding a period to the first argument and supplying the
3806 % common last two arguments. Also subtract one from the initial value in
3807 % \itemno, since @item increments \itemno.
3809 \def\startenumeration#1{%
3810 \advance\itemno by -1
3811 \doitemize{#1.}\flushcr
3814 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3817 \def\alphaenumerate{\enumerate{a}}
3818 \def\capsenumerate{\enumerate{A}}
3819 \def\Ealphaenumerate{\Eenumerate}
3820 \def\Ecapsenumerate{\Eenumerate}
3823 % @multitable macros
3824 % Amy Hendrickson, 8/18/94, 3/6/96
3826 % @multitable ... @end multitable will make as many columns as desired.
3827 % Contents of each column will wrap at width given in preamble. Width
3828 % can be specified either with sample text given in a template line,
3829 % or in percent of \hsize, the current width of text on page.
3831 % Table can continue over pages but will only break between lines.
3835 % Either define widths of columns in terms of percent of \hsize:
3836 % @multitable @columnfractions .25 .3 .45
3839 % Numbers following @columnfractions are the percent of the total
3840 % current hsize to be used for each column. You may use as many
3841 % columns as desired.
3844 % Or use a template:
3845 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3847 % using the widest term desired in each column.
3849 % Each new table line starts with @item, each subsequent new column
3850 % starts with @tab. Empty columns may be produced by supplying @tab's
3851 % with nothing between them for as many times as empty columns are needed,
3852 % ie, @tab@tab@tab will produce two empty columns.
3854 % @item, @tab do not need to be on their own lines, but it will not hurt
3857 % Sample multitable:
3859 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3860 % @item first col stuff @tab second col stuff @tab third col
3867 % @item first col stuff @tab second col stuff
3868 % @tab Many paragraphs of text may be used in any column.
3870 % They will wrap at the width determined by the template.
3871 % @item@tab@tab This will be in third column.
3874 % Default dimensions may be reset by user.
3875 % @multitableparskip is vertical space between paragraphs in table.
3876 % @multitableparindent is paragraph indent in table.
3877 % @multitablecolmargin is horizontal space to be left between columns.
3878 % @multitablelinespace is space to leave between table items, baseline
3880 % 0pt means it depends on current normal line spacing.
3882 \newskip\multitableparskip
3883 \newskip\multitableparindent
3884 \newdimen\multitablecolspace
3885 \newskip\multitablelinespace
3886 \multitableparskip=0pt
3887 \multitableparindent=6pt
3888 \multitablecolspace=12pt
3889 \multitablelinespace=0pt
3891 % Macros used to set up halign preamble:
3893 \let\endsetuptable\relax
3894 \def\xendsetuptable{\endsetuptable}
3895 \let\columnfractions\relax
3896 \def\xcolumnfractions{\columnfractions}
3899 % #1 is the @columnfraction, usually a decimal number like .5, but might
3900 % be just 1. We just use it, whatever it is.
3902 \def\pickupwholefraction#1 {%
3903 \global\advance\colcount by 1
3904 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3911 \ifx\firstarg\xendsetuptable
3914 \ifx\firstarg\xcolumnfractions
3915 \global\setpercenttrue
3918 \let\go\pickupwholefraction
3920 \global\advance\colcount by 1
3921 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3922 % separator; typically that is always in the input, anyway.
3923 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3926 \ifx\go\pickupwholefraction
3927 % Put the argument back for the \pickupwholefraction call, so
3928 % we'll always have a period there to be parsed.
3929 \def\go{\pickupwholefraction#1}%
3931 \let\go = \setuptable
3937 % multitable-only commands.
3939 % @headitem starts a heading row, which we typeset in bold. Assignments
3940 % have to be global since we are inside the implicit group of an
3941 % alignment entry. \everycr below resets \everytab so we don't have to
3942 % undo it ourselves.
3943 \def\headitemfont{\b}% for people to use in the template row; not changeable
3945 \checkenv\multitable
3947 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3948 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3949 \the\everytab % for the first item
3952 % default for tables with no headings.
3953 \let\headitemcrhook=\relax
3955 % A \tab used to include \hskip1sp. But then the space in a template
3956 % line is not enough. That is bad. So let's go back to just `&' until
3957 % we again encounter the problem the 1sp was intended to solve.
3958 % --karl, nathan@acm.org, 20apr99.
3959 \def\tab{\checkenv\multitable &\the\everytab}%
3961 % @multitable ... @end multitable definitions:
3963 \newtoks\everytab % insert after every tab.
3965 \envdef\multitable{%
3969 % @item within a multitable starts a normal row.
3970 % We use \def instead of \let so that if one of the multitable entries
3971 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3972 % \endtemplate) expanding \doitemize.
3977 \setmultitablespacing
3978 \parskip=\multitableparskip
3979 \parindent=\multitableparindent
3985 \global\everytab={}% Reset from possible headitem.
3986 \global\colcount=0 % Reset the column counter.
3988 % Check for saved footnotes, etc.:
3991 % Perhaps a \nobreak, then reset:
3993 \global\let\headitemcrhook=\relax
3997 \parsearg\domultitable
3999 \def\domultitable#1{%
4000 % To parse everything between @multitable and @item:
4001 \setuptable#1 \endsetuptable
4003 % This preamble sets up a generic column definition, which will
4004 % be used as many times as user calls for columns.
4005 % \vtop will set a single line and will also let text wrap and
4006 % continue for many paragraphs if desired.
4008 \global\advance\colcount by 1
4011 % Use the current \colcount to find the correct column width:
4012 \hsize=\expandafter\csname col\the\colcount\endcsname
4014 % In order to keep entries from bumping into each other
4015 % we will add a \leftskip of \multitablecolspace to all columns after
4018 % If a template has been used, we will add \multitablecolspace
4019 % to the width of each template entry.
4021 % If the user has set preamble in terms of percent of \hsize we will
4022 % use that dimension as the width of the column, and the \leftskip
4023 % will keep entries from bumping into each other. Table will start at
4024 % left margin and final column will justify at right margin.
4026 % Make sure we don't inherit \rightskip from the outer environment.
4029 % The first column will be indented with the surrounding text.
4030 \advance\hsize by\leftskip
4033 % If user has not set preamble in terms of percent of \hsize
4034 % we will advance \hsize by \multitablecolspace.
4035 \advance\hsize by \multitablecolspace
4037 % In either case we will make \leftskip=\multitablecolspace:
4038 \leftskip=\multitablecolspace
4040 % Ignoring space at the beginning and end avoids an occasional spurious
4041 % blank line, when TeX decides to break the line at the space before the
4042 % box from the multistrut, so the strut ends up on a line by itself.
4044 % @multitable @columnfractions .11 .89
4046 % @tab Legal holiday which is valid in major parts of the whole country.
4047 % Is automatically provided with highlighting sequences respectively
4048 % marking characters.
4049 \noindent\ignorespaces##\unskip\multistrut
4054 \egroup % end the \halign
4055 \global\setpercentfalse
4058 \def\setmultitablespacing{%
4059 \def\multistrut{\strut}% just use the standard line spacing
4061 % Compute \multitablelinespace (if not defined by user) for use in
4062 % \multitableparskip calculation. We used define \multistrut based on
4063 % this, but (ironically) that caused the spacing to be off.
4064 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4065 \ifdim\multitablelinespace=0pt
4066 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4067 \global\advance\multitablelinespace by-\ht0
4069 % Test to see if parskip is larger than space between lines of
4070 % table. If not, do nothing.
4071 % If so, set to same dimension as multitablelinespace.
4072 \ifdim\multitableparskip>\multitablelinespace
4073 \global\multitableparskip=\multitablelinespace
4074 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4075 % than skip between lines in the table.
4077 \ifdim\multitableparskip=0pt
4078 \global\multitableparskip=\multitablelinespace
4079 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4080 % than skip between lines in the table.
4084 \message{conditionals,}
4086 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4087 % @ifnotxml always succeed. They currently do nothing; we don't
4088 % attempt to check whether the conditionals are properly nested. But we
4089 % have to remember that they are conditionals, so that @end doesn't
4090 % attempt to close an environment group.
4093 \expandafter\let\csname #1\endcsname = \relax
4094 \expandafter\let\csname iscond.#1\endcsname = 1
4097 \makecond{ifnotdocbook}
4098 \makecond{ifnothtml}
4099 \makecond{ifnotinfo}
4100 \makecond{ifnotplaintext}
4103 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4105 \def\direntry{\doignore{direntry}}
4106 \def\documentdescription{\doignore{documentdescription}}
4107 \def\docbook{\doignore{docbook}}
4108 \def\html{\doignore{html}}
4109 \def\ifdocbook{\doignore{ifdocbook}}
4110 \def\ifhtml{\doignore{ifhtml}}
4111 \def\ifinfo{\doignore{ifinfo}}
4112 \def\ifnottex{\doignore{ifnottex}}
4113 \def\ifplaintext{\doignore{ifplaintext}}
4114 \def\ifxml{\doignore{ifxml}}
4115 \def\ignore{\doignore{ignore}}
4116 \def\menu{\doignore{menu}}
4117 \def\xml{\doignore{xml}}
4119 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4121 % A count to remember the depth of nesting.
4122 \newcount\doignorecount
4124 \def\doignore#1{\begingroup
4125 % Scan in ``verbatim'' mode:
4127 \catcode`\@ = \other
4128 \catcode`\{ = \other
4129 \catcode`\} = \other
4131 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4134 % Count number of #1's that we've seen.
4137 % Swallow text until we reach the matching `@end #1'.
4141 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4144 \gdef\dodoignore#1{%
4145 % #1 contains the command name as a string, e.g., `ifinfo'.
4147 % Define a command to find the next `@end #1'.
4148 \long\def\doignoretext##1^^M@end #1{%
4149 \doignoretextyyy##1^^M@#1\_STOP_}%
4151 % And this command to find another #1 command, at the beginning of a
4152 % line. (Otherwise, we would consider a line `@c @ifset', for
4153 % example, to count as an @ifset for nesting.)
4154 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4156 % And now expand that command.
4161 \def\doignoreyyy#1{%
4163 \ifx\temp\empty % Nothing found.
4164 \let\next\doignoretextzzz
4165 \else % Found a nested condition, ...
4166 \advance\doignorecount by 1
4167 \let\next\doignoretextyyy % ..., look for another.
4168 % If we're here, #1 ends with ^^M\ifinfo (for example).
4170 \next #1% the token \_STOP_ is present just after this macro.
4173 % We have to swallow the remaining "\_STOP_".
4175 \def\doignoretextzzz#1{%
4176 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4177 \let\next\enddoignore
4178 \else % Still inside a nested condition.
4179 \advance\doignorecount by -1
4180 \let\next\doignoretext % Look for the next @end.
4185 % Finish off ignored text.
4187 % Ignore anything after the last `@end #1'; this matters in verbatim
4188 % environments, where otherwise the newline after an ignored conditional
4189 % would result in a blank line in the output.
4190 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4194 % @set VAR sets the variable VAR to an empty value.
4195 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4197 % Since we want to separate VAR from REST-OF-LINE (which might be
4198 % empty), we can't just use \parsearg; we have to insert a space of our
4199 % own to delimit the rest of the line, and then take it out again if we
4201 % We rely on the fact that \parsearg sets \catcode`\ =10.
4203 \parseargdef\set{\setyyy#1 \endsetyyy}
4204 \def\setyyy#1 #2\endsetyyy{%
4206 \makevalueexpandable
4208 \edef\next{\gdef\makecsname{SET#1}}%
4216 % Remove the trailing space \setxxx inserted.
4217 \def\setzzz#1 \endsetzzz{\next{#1}}
4219 % @clear VAR clears (i.e., unsets) the variable VAR.
4221 \parseargdef\clear{%
4223 \makevalueexpandable
4224 \global\expandafter\let\csname SET#1\endcsname=\relax
4228 % @value{foo} gets the text saved in variable foo.
4229 \def\value{\begingroup\makevalueexpandable\valuexxx}
4230 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4232 \catcode`\-=\active \catcode`\_=\active
4234 \gdef\makevalueexpandable{%
4235 \let\value = \expandablevalue
4236 % We don't want these characters active, ...
4237 \catcode`\-=\other \catcode`\_=\other
4238 % ..., but we might end up with active ones in the argument if
4239 % we're called from @code, as @code{@value{foo-bar_}}, though.
4240 % So \let them to their normal equivalents.
4241 \let-\normaldash \let_\normalunderscore
4245 % We have this subroutine so that we can handle at least some @value's
4246 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4247 % The command has to be fully expandable (if the variable is set), since
4248 % the result winds up in the index file. This means that if the
4249 % variable's value contains other Texinfo commands, it's almost certain
4250 % it will fail (although perhaps we could fix that with sufficient work
4251 % to do a one-level expansion on the result, instead of complete).
4253 % Unfortunately, this has the consequence that when _ is in the *value*
4254 % of an @set, it does not print properly in the roman fonts (get the cmr
4255 % dot accent at position 126 instead). No fix comes to mind, and it's
4256 % been this way since 2003 or earlier, so just ignore it.
4258 \def\expandablevalue#1{%
4259 \expandafter\ifx\csname SET#1\endcsname\relax
4260 {[No value for ``#1'']}%
4261 \message{Variable `#1', used in @value, is not set.}%
4263 \csname SET#1\endcsname
4267 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4270 % To get the special treatment we need for `@end ifset,' we call
4271 % \makecond and then redefine.
4274 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4277 \makevalueexpandable
4279 \expandafter\ifx\csname SET#2\endcsname\relax
4280 #1% If not set, redefine \next.
4285 \def\ifsetfail{\doignore{ifset}}
4287 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4288 % defined with @set, or has been undefined with @clear.
4290 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4291 % above code: if the variable is not set, do nothing, if it is set,
4292 % then redefine \next to \ifclearfail.
4295 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4296 \def\ifclearfail{\doignore{ifclear}}
4298 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4299 % without the @) is in fact defined. We can only feasibly check at the
4300 % TeX level, so something like `mathcode' is going to considered
4301 % defined even though it is not a Texinfo command.
4303 \makecond{ifcommanddefined}
4304 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4306 \def\doifcmddefined#1#2{{%
4307 \makevalueexpandable
4309 \expandafter\ifx\csname #2\endcsname\relax
4310 #1% If not defined, \let\next as above.
4315 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4317 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4318 \makecond{ifcommandnotdefined}
4319 \def\ifcommandnotdefined{%
4320 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4321 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4323 % Set the `txicommandconditionals' variable, so documents have a way to
4324 % test if the @ifcommand...defined conditionals are available.
4325 \set txicommandconditionals
4327 % @dircategory CATEGORY -- specify a category of the dir file
4328 % which this file should belong to. Ignore this in TeX.
4329 \let\dircategory=\comment
4331 % @defininfoenclose.
4332 \let\definfoenclose=\comment
4336 % Index generation facilities
4338 % Define \newwrite to be identical to plain tex's \newwrite
4339 % except not \outer, so it can be used within macros and \if's.
4340 \edef\newwrite{\makecsname{ptexnewwrite}}
4342 % \newindex {foo} defines an index named foo.
4343 % It automatically defines \fooindex such that
4344 % \fooindex ...rest of line... puts an entry in the index foo.
4345 % It also defines \fooindfile to be the number of the output channel for
4346 % the file that accumulates this index. The file's extension is foo.
4347 % The name of an index should be no more than 2 characters long
4348 % for the sake of vms.
4352 \expandafter\newwrite \csname#1indfile\endcsname
4353 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4355 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4356 \noexpand\doindex{#1}}
4359 % @defindex foo == \newindex{foo}
4361 \def\defindex{\parsearg\newindex}
4363 % Define @defcodeindex, like @defindex except put all entries in @code.
4365 \def\defcodeindex{\parsearg\newcodeindex}
4367 \def\newcodeindex#1{%
4369 \expandafter\newwrite \csname#1indfile\endcsname
4370 \openout \csname#1indfile\endcsname \jobname.#1
4372 \expandafter\xdef\csname#1index\endcsname{%
4373 \noexpand\docodeindex{#1}}%
4377 % @synindex foo bar makes index foo feed into index bar.
4378 % Do this instead of @defindex foo if you don't want it as a separate index.
4380 % @syncodeindex foo bar similar, but put all entries made for index foo
4383 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4384 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4386 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4387 % #3 the target index (bar).
4388 \def\dosynindex#1#2#3{%
4389 % Only do \closeout if we haven't already done it, else we'll end up
4390 % closing the target index.
4391 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4392 % The \closeout helps reduce unnecessary open files; the limit on the
4393 % Acorn RISC OS is a mere 16 files.
4394 \expandafter\closeout\csname#2indfile\endcsname
4395 \expandafter\let\csname donesynindex#2\endcsname = 1
4397 % redefine \fooindfile:
4398 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4399 \expandafter\let\csname#2indfile\endcsname=\temp
4400 % redefine \fooindex:
4401 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4404 % Define \doindex, the driver for all \fooindex macros.
4405 % Argument #1 is generated by the calling \fooindex macro,
4406 % and it is "foo", the name of the index.
4408 % \doindex just uses \parsearg; it calls \doind for the actual work.
4409 % This is because \doind is more useful to call from other macros.
4411 % There is also \dosubind {index}{topic}{subtopic}
4412 % which makes an entry in a two-level index such as the operation index.
4414 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4415 \def\singleindexer #1{\doind{\indexname}{#1}}
4417 % like the previous two, but they put @code around the argument.
4418 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4419 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4421 % Take care of Texinfo commands that can appear in an index entry.
4422 % Since there are some commands we want to expand, and others we don't,
4423 % we have to laboriously prevent expansion for those that we don't.
4426 \escapechar = `\\ % use backslash in output files.
4427 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4428 \def\ {\realbackslash\space }%
4430 % Need these unexpandable (because we define \tt as a dummy)
4431 % definitions when @{ or @} appear in index entry text. Also, more
4432 % complicated, when \tex is in effect and \{ is a \delimiter again.
4433 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4434 % braces and backslashes are used only as delimiters. Perhaps we
4435 % should use @lbracechar and @rbracechar?
4436 \def\{{{\tt\char123}}%
4437 \def\}{{\tt\char125}}%
4439 % I don't entirely understand this, but when an index entry is
4440 % generated from a macro call, the \endinput which \scanmacro inserts
4441 % causes processing to be prematurely terminated. This is,
4442 % apparently, because \indexsorttmp is fully expanded, and \endinput
4443 % is an expandable command. The redefinition below makes \endinput
4444 % disappear altogether for that purpose -- although logging shows that
4445 % processing continues to some further point. On the other hand, it
4446 % seems \endinput does not hurt in the printed index arg, since that
4447 % is still getting written without apparent harm.
4449 % Sample source (mac-idx3.tex, reported by Graham Percival to
4450 % help-texinfo, 22may06):
4451 % @macro funindex {WORD}
4455 % @funindex commtest
4456 % This is not enough to reproduce the bug, but it gives the flavor.
4458 % Sample whatsit resulting:
4459 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4462 \let\endinput = \empty
4464 % Do the redefinitions.
4468 % For the aux and toc files, @ is the escape character. So we want to
4469 % redefine everything using @ as the escape character (instead of
4470 % \realbackslash, still used for index files). When everything uses @,
4471 % this will be simpler.
4476 \let\{ = \lbraceatcmd
4477 \let\} = \rbraceatcmd
4479 % Do the redefinitions.
4484 % Called from \indexdummies and \atdummies.
4486 \def\commondummies{%
4488 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4489 % preventing its expansion. This is used only for control words,
4490 % not control letters, because the \space would be incorrect for
4491 % control characters, but is needed to separate the control word
4492 % from whatever follows.
4494 % For control letters, we have \definedummyletter, which omits the
4497 % These can be used both for control words that take an argument and
4498 % those that do not. If it is followed by {arg} in the input, then
4499 % that will dutifully get written to the index (or wherever).
4501 \def\definedummyword ##1{\def##1{\string##1\space}}%
4502 \def\definedummyletter##1{\def##1{\string##1}}%
4503 \let\definedummyaccent\definedummyletter
4505 \commondummiesnofonts
4507 \definedummyletter\_%
4508 \definedummyletter\-%
4510 % Non-English letters.
4521 \definedummyword\exclamdown
4525 \definedummyword\ordf
4526 \definedummyword\ordm
4527 \definedummyword\questiondown
4531 % Although these internal commands shouldn't show up, sometimes they do.
4533 \definedummyword\gtr
4534 \definedummyword\hat
4535 \definedummyword\less
4538 \definedummyword\tclose
4541 \definedummyword\LaTeX
4542 \definedummyword\TeX
4544 % Assorted special characters.
4545 \definedummyword\arrow
4546 \definedummyword\bullet
4547 \definedummyword\comma
4548 \definedummyword\copyright
4549 \definedummyword\registeredsymbol
4550 \definedummyword\dots
4551 \definedummyword\enddots
4552 \definedummyword\entrybreak
4553 \definedummyword\equiv
4554 \definedummyword\error
4555 \definedummyword\euro
4556 \definedummyword\expansion
4557 \definedummyword\geq
4558 \definedummyword\guillemetleft
4559 \definedummyword\guillemetright
4560 \definedummyword\guilsinglleft
4561 \definedummyword\guilsinglright
4562 \definedummyword\lbracechar
4563 \definedummyword\leq
4564 \definedummyword\minus
4565 \definedummyword\ogonek
4566 \definedummyword\pounds
4567 \definedummyword\point
4568 \definedummyword\print
4569 \definedummyword\quotedblbase
4570 \definedummyword\quotedblleft
4571 \definedummyword\quotedblright
4572 \definedummyword\quoteleft
4573 \definedummyword\quoteright
4574 \definedummyword\quotesinglbase
4575 \definedummyword\rbracechar
4576 \definedummyword\result
4577 \definedummyword\textdegree
4579 % We want to disable all macros so that they are not expanded by \write.
4582 \normalturnoffactive
4584 % Handle some cases of @value -- where it does not contain any
4585 % (non-fully-expandable) commands.
4586 \makevalueexpandable
4589 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4591 \def\commondummiesnofonts{%
4592 % Control letters and accents.
4593 \definedummyletter\!%
4594 \definedummyaccent\"%
4595 \definedummyaccent\'%
4596 \definedummyletter\*%
4597 \definedummyaccent\,%
4598 \definedummyletter\.%
4599 \definedummyletter\/%
4600 \definedummyletter\:%
4601 \definedummyaccent\=%
4602 \definedummyletter\?%
4603 \definedummyaccent\^%
4604 \definedummyaccent\`%
4605 \definedummyaccent\~%
4609 \definedummyword\dotaccent
4610 \definedummyword\ogonek
4611 \definedummyword\ringaccent
4612 \definedummyword\tieaccent
4613 \definedummyword\ubaraccent
4614 \definedummyword\udotaccent
4615 \definedummyword\dotless
4617 % Texinfo font commands.
4621 \definedummyword\sansserif
4623 \definedummyword\slanted
4626 % Commands that take arguments.
4627 \definedummyword\abbr
4628 \definedummyword\acronym
4629 \definedummyword\anchor
4630 \definedummyword\cite
4631 \definedummyword\code
4632 \definedummyword\command
4633 \definedummyword\dfn
4634 \definedummyword\dmn
4635 \definedummyword\email
4636 \definedummyword\emph
4637 \definedummyword\env
4638 \definedummyword\file
4639 \definedummyword\image
4640 \definedummyword\indicateurl
4641 \definedummyword\inforef
4642 \definedummyword\kbd
4643 \definedummyword\key
4644 \definedummyword\math
4645 \definedummyword\option
4646 \definedummyword\pxref
4647 \definedummyword\ref
4648 \definedummyword\samp
4649 \definedummyword\strong
4650 \definedummyword\tie
4651 \definedummyword\uref
4652 \definedummyword\url
4653 \definedummyword\var
4654 \definedummyword\verb
4656 \definedummyword\xref
4659 % @macro mkind{arg1,arg2}
4663 % The space after the comma will end up in the temporary definition
4664 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4665 % expanded for the sake of the index, so we end up just seeing "bar".
4666 \let\xeatspaces = \eatspaces
4669 % For testing: output @{ and @} in index sort strings as \{ and \}.
4670 \newif\ifusebracesinindexes
4672 % \indexnofonts is used when outputting the strings to sort the index
4673 % by, and when constructing control sequence names. It eliminates all
4674 % control sequences and just writes whatever the best ASCII sort string
4675 % would be for a given command (usually its argument).
4678 % Accent commands should become @asis.
4679 \def\definedummyaccent##1{\let##1\asis}%
4680 % We can just ignore other control letters.
4681 \def\definedummyletter##1{\let##1\empty}%
4682 % All control words become @asis by default; overrides below.
4683 \let\definedummyword\definedummyaccent
4685 \commondummiesnofonts
4687 % Don't no-op \tt, since it isn't a user-level command
4688 % and is used in the definitions of the active chars like <, >, |, etc.
4689 % Likewise with the other plain tex font commands.
4694 \def\_{\normalunderscore}%
4695 \def\-{}% @- shouldn't affect sorting
4697 % Unfortunately, texindex is not prepared to handle braces in the
4698 % content at all. So for index sorting, we map @{ and @} to strings
4699 % starting with |, since that ASCII character is between ASCII { and }.
4700 \ifusebracesinindexes
4701 \def\lbracechar{\lbracecmd}%
4702 \def\rbracechar{\rbracecmd}%
4704 \def\lbracechar{|a}%
4705 \def\rbracechar{|b}%
4711 % Non-English letters.
4728 \def\questiondown{?}%
4735 % Assorted special characters.
4736 % (The following {} will end up in the sort string, but that's ok.)
4738 \def\bullet{bullet}%
4740 \def\copyright{copyright}%
4746 \def\expansion{==>}%
4748 \def\guillemetleft{<<}%
4749 \def\guillemetright{>>}%
4750 \def\guilsinglleft{<}%
4751 \def\guilsinglright{>}%
4755 \def\pounds{pounds}%
4757 \def\quotedblbase{"}%
4758 \def\quotedblleft{"}%
4759 \def\quotedblright{"}%
4762 \def\quotesinglbase{,}%
4763 \def\registeredsymbol{R}%
4767 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4768 \else \indexlquoteignore \fi
4770 % We need to get rid of all macros, leaving only the arguments (if present).
4771 % Of course this is not nearly correct, but it is the best we can do for now.
4772 % makeinfo does not expand macros in the argument to @deffn, which ends up
4773 % writing an index entry, and texindex isn't prepared for an index sort entry
4774 % that starts with \.
4776 % Since macro invocations are followed by braces, we can just redefine them
4777 % to take a single TeX argument. The case of a macro invocation that
4778 % goes to end-of-line is not handled.
4783 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4784 % ignore left quotes in the sort term.
4785 {\catcode`\`=\active
4786 \gdef\indexlquoteignore{\let`=\empty}}
4788 \let\indexbackslash=0 %overridden during \printindex.
4789 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4791 % Most index entries go through here, but \dosubind is the general case.
4792 % #1 is the index name, #2 is the entry text.
4793 \def\doind#1#2{\dosubind{#1}{#2}{}}
4795 % Workhorse for all \fooindexes.
4796 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4797 % empty if called from \doind, as we usually are (the main exception
4798 % is with most defuns, which call us directly).
4800 \def\dosubind#1#2#3{%
4803 % Store the main index entry text (including the third arg).
4805 % If third arg is present, precede it with a space.
4807 \ifx\thirdarg\empty \else
4808 \toks0 = \expandafter{\the\toks0 \space #3}%
4811 \edef\writeto{\csname#1indfile\endcsname}%
4813 \safewhatsit\dosubindwrite
4818 % Write the entry in \toks0 to the index file:
4820 \def\dosubindwrite{%
4821 % Put the index entry in the margin if desired.
4822 \ifx\SETmarginindex\relax\else
4823 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4826 % Remember, we are within a group.
4827 \indexdummies % Must do this here, since \bf, etc expand at this stage
4828 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4829 % so it will be output as is; and it will print as backslash.
4831 % Process the index entry with all font commands turned off, to
4832 % get the string to sort by.
4834 \edef\temp{\the\toks0}% need full expansion
4835 \xdef\indexsorttmp{\temp}%
4838 % Set up the complete index entry, with both the sort key and
4839 % the original text, including any font commands. We write
4840 % three arguments to \entry to the .?? file (four in the
4841 % subentry case), texindex reduces to two when writing the .??s
4845 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4850 % Take care of unwanted page breaks/skips around a whatsit:
4852 % If a skip is the last thing on the list now, preserve it
4853 % by backing up by \lastskip, doing the \write, then inserting
4854 % the skip again. Otherwise, the whatsit generated by the
4855 % \write or \pdfdest will make \lastskip zero. The result is that
4856 % sequences like this:
4860 % will have extra space inserted, because the \medbreak in the
4861 % start of the @defun won't see the skip inserted by the @end of
4862 % the previous defun.
4864 % But don't do any of this if we're not in vertical mode. We
4865 % don't want to do a \vskip and prematurely end a paragraph.
4867 % Avoid page breaks due to these extra skips, too.
4869 % But wait, there is a catch there:
4870 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4871 % sufficient for this purpose, as it ignores stretch and shrink parts
4872 % of the skip. The only way seems to be to check the textual
4873 % representation of the skip.
4875 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4876 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4878 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4880 \newskip\whatsitskip
4881 \newcount\whatsitpenalty
4885 \def\safewhatsit#1{\ifhmode
4888 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4889 \whatsitskip = \lastskip
4890 \edef\lastskipmacro{\the\lastskip}%
4891 \whatsitpenalty = \lastpenalty
4893 % If \lastskip is nonzero, that means the last item was a
4894 % skip. And since a skip is discardable, that means this
4895 % -\whatsitskip glue we're inserting is preceded by a
4896 % non-discardable item, therefore it is not a potential
4897 % breakpoint, therefore no \nobreak needed.
4898 \ifx\lastskipmacro\zeroskipmacro
4905 \ifx\lastskipmacro\zeroskipmacro
4906 % If \lastskip was zero, perhaps the last item was a penalty, and
4907 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4908 % to re-insert the same penalty (values >10000 are used for various
4909 % signals); since we just inserted a non-discardable item, any
4910 % following glue (such as a \parskip) would be a breakpoint. For example:
4911 % @deffn deffn-whatever
4912 % @vindex index-whatever
4914 % would allow a break between the index-whatever whatsit
4915 % and the "Description." paragraph.
4916 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4918 % On the other hand, if we had a nonzero \lastskip,
4919 % this make-up glue would be preceded by a non-discardable item
4920 % (the whatsit from the \write), so we must insert a \nobreak.
4921 \nobreak\vskip\whatsitskip
4925 % The index entry written in the file actually looks like
4926 % \entry {sortstring}{page}{topic}
4928 % \entry {sortstring}{page}{topic}{subtopic}
4929 % The texindex program reads in these files and writes files
4930 % containing these kinds of lines:
4932 % before the first topic whose initial is c
4933 % \entry {topic}{pagelist}
4934 % for a topic that is used without subtopics
4936 % for the beginning of a topic that is used with subtopics
4937 % \secondary {subtopic}{pagelist}
4938 % for each subtopic.
4940 % Define the user-accessible indexing commands
4941 % @findex, @vindex, @kindex, @cindex.
4943 \def\findex {\fnindex}
4944 \def\kindex {\kyindex}
4945 \def\cindex {\cpindex}
4946 \def\vindex {\vrindex}
4947 \def\tindex {\tpindex}
4948 \def\pindex {\pgindex}
4950 \def\cindexsub {\begingroup\obeylines\cindexsub}
4952 \gdef\cindexsub "#1" #2^^M{\endgroup %
4953 \dosubind{cp}{#2}{#1}}}
4955 % Define the macros used in formatting output of the sorted index material.
4957 % @printindex causes a particular index (the ??s file) to get printed.
4958 % It does not print any chapter heading (usually an @unnumbered).
4960 \parseargdef\printindex{\begingroup
4961 \dobreak \chapheadingskip{10000}%
4966 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4968 % See if the index file exists and is nonempty.
4969 % Change catcode of @ here so that if the index file contains
4971 % as its first line, TeX doesn't complain about mismatched braces
4972 % (because it thinks @} is a control sequence).
4974 \openin 1 \jobname.#1s
4976 % \enddoublecolumns gets confused if there is no text in the index,
4977 % and it loses the chapter title and the aux file entries for the
4978 % index. The easiest way to prevent this problem is to make sure
4979 % there is some text.
4980 \putwordIndexNonexistent
4983 % If the index file exists but is empty, then \openin leaves \ifeof
4984 % false. We have to make TeX try to read something from the file, so
4985 % it can discover if there is anything in it.
4988 \putwordIndexIsEmpty
4990 % Index files are almost Texinfo source, but we use \ as the escape
4991 % character. It would be better to use @, but that's too big a change
4992 % to make right now.
4993 \def\indexbackslash{\backslashcurfont}%
5004 % These macros are used by the sorted index file itself.
5005 % Change them to control the appearance of the index.
5008 % Some minor font changes for the special characters.
5009 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
5011 % Remove any glue we may have, we'll be inserting our own.
5014 % We like breaks before the index initials, so insert a bonus.
5016 \vskip 0pt plus 3\baselineskip
5018 \vskip 0pt plus -3\baselineskip
5020 % Typeset the initial. Making this add up to a whole number of
5021 % baselineskips increases the chance of the dots lining up from column
5022 % to column. It still won't often be perfect, because of the stretch
5023 % we need before each entry, but it's better.
5025 % No shrink because it confuses \balancecolumns.
5026 \vskip 1.67\baselineskip plus .5\baselineskip
5027 \leftline{\secbf #1}%
5028 % Do our best not to break after the initial.
5030 \vskip .33\baselineskip plus .1\baselineskip
5033 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5034 % then page number (#2) flushed to the right margin. It is used for index
5035 % and table of contents entries. The paragraph is indented by \leftskip.
5037 % A straightforward implementation would start like this:
5038 % \def\entry#1#2{...
5039 % But this freezes the catcodes in the argument, and can cause problems to
5040 % @code, which sets - active. This problem was fixed by a kludge---
5041 % ``-'' was active throughout whole index, but this isn't really right.
5042 % The right solution is to prevent \entry from swallowing the whole text.
5047 % Start a new paragraph if necessary, so our assignments below can't
5048 % affect previous text.
5051 % Do not fill out the last line with white space.
5054 % No extra space above this paragraph.
5057 % Do not prefer a separate line ending with a hyphen to fewer lines.
5058 \finalhyphendemerits = 0
5060 % \hangindent is only relevant when the entry text and page number
5061 % don't both fit on one line. In that case, bob suggests starting the
5062 % dots pretty far over on the line. Unfortunately, a large
5063 % indentation looks wrong when the entry text itself is broken across
5064 % lines. So we use a small indentation and put up with long leaders.
5066 % \hangafter is reset to 1 (which is the value we want) at the start
5067 % of each paragraph, so we need not do anything with that.
5070 % When the entry text needs to be broken, just fill out the first line
5072 \rightskip = 0pt plus1fil
5074 % A bit of stretch before each entry for the benefit of balancing
5078 % When reading the text of entry, convert explicit line breaks
5079 % from @* into spaces. The user might give these in long section
5080 % titles, for instance.
5081 \def\*{\unskip\space\ignorespaces}%
5082 \def\entrybreak{\hfil\break}%
5084 % Swallow the left brace of the text (first parameter):
5085 \afterassignment\doentry
5088 \def\entrybreak{\unskip\space\ignorespaces}%
5090 \bgroup % Instead of the swallowed brace.
5092 \aftergroup\finishentry
5093 % And now comes the text of the entry.
5095 \def\finishentry#1{%
5096 % #1 is the page number.
5098 % The following is kludged to not output a line of dots in the index if
5099 % there are no page numbers. The next person who breaks this will be
5100 % cursed by a Unix daemon.
5101 \setbox\boxA = \hbox{#1}%
5102 \ifdim\wd\boxA = 0pt
5106 % If we must, put the page number on a line of its own, and fill out
5107 % this line with blank space. (The \hfil is overwhelmed with the
5108 % fill leaders glue in \indexdotfill if the page number does fit.)
5110 \null\nobreak\indexdotfill % Have leaders before the page number.
5112 % The `\ ' here is removed by the implicit \unskip that TeX does as
5113 % part of (the primitive) \par. Without it, a spurious underfull
5126 % Like plain.tex's \dotfill, except uses up at least 1 em.
5127 \def\indexdotfill{\cleaders
5128 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5130 \def\primary #1{\line{#1\hfil}}
5132 \newskip\secondaryindent \secondaryindent=0.5cm
5133 \def\secondary#1#2{{%
5138 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5140 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5147 % Define two-column mode, which we use to typeset indexes.
5148 % Adapted from the TeXbook, page 416, which is to say,
5149 % the manmac.tex format used to print the TeXbook itself.
5153 \newdimen\doublecolumnhsize
5155 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5156 % Grab any single-column material above us.
5159 % Here is a possibility not foreseen in manmac: if we accumulate a
5160 % whole lot of material, we might end up calling this \output
5161 % routine twice in a row (see the doublecol-lose test, which is
5162 % essentially a couple of indexes with @setchapternewpage off). In
5163 % that case we just ship out what is in \partialpage with the normal
5164 % output routine. Generally, \partialpage will be empty when this
5165 % runs and this will be a no-op. See the indexspread.tex test case.
5166 \ifvoid\partialpage \else
5167 \onepageout{\pagecontents\partialpage}%
5170 \global\setbox\partialpage = \vbox{%
5171 % Unvbox the main output page.
5173 \kern-\topskip \kern\baselineskip
5176 \eject % run that output routine to set \partialpage
5178 % Use the double-column output routine for subsequent pages.
5179 \output = {\doublecolumnout}%
5181 % Change the page size parameters. We could do this once outside this
5182 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5183 % format, but then we repeat the same computation. Repeating a couple
5184 % of assignments once per index is clearly meaningless for the
5185 % execution time, so we may as well do it in one place.
5187 % First we halve the line length, less a little for the gutter between
5188 % the columns. We compute the gutter based on the line length, so it
5189 % changes automatically with the paper format. The magic constant
5190 % below is chosen so that the gutter has the same value (well, +-<1pt)
5191 % as it did when we hard-coded it.
5193 % We put the result in a separate register, \doublecolumhsize, so we
5194 % can restore it in \pagesofar, after \hsize itself has (potentially)
5197 \doublecolumnhsize = \hsize
5198 \advance\doublecolumnhsize by -.04154\hsize
5199 \divide\doublecolumnhsize by 2
5200 \hsize = \doublecolumnhsize
5202 % Double the \vsize as well. (We don't need a separate register here,
5203 % since nobody clobbers \vsize.)
5207 % The double-column output routine for all double-column pages except
5210 \def\doublecolumnout{%
5211 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5212 % Get the available space for the double columns -- the normal
5213 % (undoubled) page height minus any material left over from the
5217 \advance\dimen@ by -\ht\partialpage
5219 % box0 will be the left-hand column, box2 the right.
5220 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5221 \onepageout\pagesofar
5223 \penalty\outputpenalty
5226 % Re-output the contents of the output page -- any previous material,
5227 % followed by the two boxes we just split, in box0 and box2.
5231 \hsize = \doublecolumnhsize
5232 \wd0=\hsize \wd2=\hsize
5233 \hbox to\pagewidth{\box0\hfil\box2}%
5236 % All done with double columns.
5237 \def\enddoublecolumns{%
5238 % The following penalty ensures that the page builder is exercised
5239 % _before_ we change the output routine. This is necessary in the
5240 % following situation:
5242 % The last section of the index consists only of a single entry.
5243 % Before this section, \pagetotal is less than \pagegoal, so no
5244 % break occurs before the last section starts. However, the last
5245 % section, consisting of \initial and the single \entry, does not
5246 % fit on the page and has to be broken off. Without the following
5247 % penalty the page builder will not be exercised until \eject
5248 % below, and by that time we'll already have changed the output
5249 % routine to the \balancecolumns version, so the next-to-last
5250 % double-column page will be processed with \balancecolumns, which
5251 % is wrong: The two columns will go to the main vertical list, with
5252 % the broken-off section in the recent contributions. As soon as
5253 % the output routine finishes, TeX starts reconsidering the page
5254 % break. The two columns and the broken-off section both fit on the
5255 % page, because the two columns now take up only half of the page
5256 % goal. When TeX sees \eject from below which follows the final
5257 % section, it invokes the new output routine that we've set after
5258 % \balancecolumns below; \onepageout will try to fit the two columns
5259 % and the final section into the vbox of \pageheight (see
5260 % \pagebody), causing an overfull box.
5262 % Note that glue won't work here, because glue does not exercise the
5263 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5267 % Split the last of the double-column material. Leave it on the
5268 % current page, no automatic page break.
5271 % If we end up splitting too much material for the current page,
5272 % though, there will be another page break right after this \output
5273 % invocation ends. Having called \balancecolumns once, we do not
5274 % want to call it again. Therefore, reset \output to its normal
5275 % definition right away. (We hope \balancecolumns will never be
5276 % called on to balance too much material, but if it is, this makes
5277 % the output somewhat more palatable.)
5278 \global\output = {\onepageout{\pagecontents\PAGE}}%
5281 \endgroup % started in \begindoublecolumns
5283 % \pagegoal was set to the doubled \vsize above, since we restarted
5284 % the current page. We're now back to normal single-column
5285 % typesetting, so reset \pagegoal to the normal \vsize (after the
5286 % \endgroup where \vsize got restored).
5290 % Called at the end of the double column material.
5291 \def\balancecolumns{%
5292 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5294 \advance\dimen@ by \topskip
5295 \advance\dimen@ by-\baselineskip
5296 \divide\dimen@ by 2 % target to split to
5297 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5298 \splittopskip = \topskip
5299 % Loop until we get a decent breakpoint.
5303 \global\setbox3 = \copy0
5304 \global\setbox1 = \vsplit3 to \dimen@
5306 \global\advance\dimen@ by 1pt
5309 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5310 \setbox0=\vbox to\dimen@{\unvbox1}%
5311 \setbox2=\vbox to\dimen@{\unvbox3}%
5315 \catcode`\@ = \other
5318 \message{sectioning,}
5319 % Chapters, sections, etc.
5321 % Let's start with @part.
5322 \outer\parseargdef\part{\partzzz{#1}}
5326 \vskip.3\vsize % move it down on the page a bit
5328 \noindent \titlefonts\rmisbold #1\par % the text
5329 \let\lastnode=\empty % no node to associate with
5330 \writetocentry{part}{#1}{}% but put it in the toc
5331 \headingsoff % no headline or footline on the part page
5336 % \unnumberedno is an oxymoron. But we count the unnumbered
5337 % sections so that we can refer to them unambiguously in the pdf
5338 % outlines by their "section number". We avoid collisions with chapter
5339 % numbers by starting them at 10000. (If a document ever has 10000
5340 % chapters, we're in trouble anyway, I'm sure.)
5341 \newcount\unnumberedno \unnumberedno = 10000
5343 \newcount\secno \secno=0
5344 \newcount\subsecno \subsecno=0
5345 \newcount\subsubsecno \subsubsecno=0
5347 % This counter is funny since it counts through charcodes of letters A, B, ...
5348 \newcount\appendixno \appendixno = `\@
5350 % \def\appendixletter{\char\the\appendixno}
5351 % We do the following ugly conditional instead of the above simple
5352 % construct for the sake of pdftex, which needs the actual
5353 % letter in the expansion, not just typeset.
5355 \def\appendixletter{%
5356 \ifnum\appendixno=`A A%
5357 \else\ifnum\appendixno=`B B%
5358 \else\ifnum\appendixno=`C C%
5359 \else\ifnum\appendixno=`D D%
5360 \else\ifnum\appendixno=`E E%
5361 \else\ifnum\appendixno=`F F%
5362 \else\ifnum\appendixno=`G G%
5363 \else\ifnum\appendixno=`H H%
5364 \else\ifnum\appendixno=`I I%
5365 \else\ifnum\appendixno=`J J%
5366 \else\ifnum\appendixno=`K K%
5367 \else\ifnum\appendixno=`L L%
5368 \else\ifnum\appendixno=`M M%
5369 \else\ifnum\appendixno=`N N%
5370 \else\ifnum\appendixno=`O O%
5371 \else\ifnum\appendixno=`P P%
5372 \else\ifnum\appendixno=`Q Q%
5373 \else\ifnum\appendixno=`R R%
5374 \else\ifnum\appendixno=`S S%
5375 \else\ifnum\appendixno=`T T%
5376 \else\ifnum\appendixno=`U U%
5377 \else\ifnum\appendixno=`V V%
5378 \else\ifnum\appendixno=`W W%
5379 \else\ifnum\appendixno=`X X%
5380 \else\ifnum\appendixno=`Y Y%
5381 \else\ifnum\appendixno=`Z Z%
5382 % The \the is necessary, despite appearances, because \appendixletter is
5383 % expanded while writing the .toc file. \char\appendixno is not
5384 % expandable, thus it is written literally, thus all appendixes come out
5385 % with the same letter (or @) in the toc without it.
5386 \else\char\the\appendixno
5387 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5388 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5390 % Each @chapter defines these (using marks) as the number+name, number
5391 % and name of the chapter. Page headings and footings can use
5392 % these. @section does likewise.
5394 \def\thischapternum{}
5395 \def\thischaptername{}
5397 \def\thissectionnum{}
5398 \def\thissectionname{}
5400 \newcount\absseclevel % used to calculate proper heading level
5401 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5403 % @raisesections: treat @section as chapter, @subsection as section, etc.
5404 \def\raisesections{\global\advance\secbase by -1}
5405 \let\up=\raisesections % original BFox name
5407 % @lowersections: treat @chapter as section, @section as subsection, etc.
5408 \def\lowersections{\global\advance\secbase by 1}
5409 \let\down=\lowersections % original BFox name
5411 % we only have subsub.
5412 \chardef\maxseclevel = 3
5414 % A numbered section within an unnumbered changes to unnumbered too.
5415 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5416 \chardef\unnlevel = \maxseclevel
5418 % Trace whether the current chapter is an appendix or not:
5419 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5420 \def\chapheadtype{N}
5422 % Choose a heading macro
5423 % #1 is heading type
5424 % #2 is heading level
5425 % #3 is text for heading
5426 \def\genhead#1#2#3{%
5427 % Compute the abs. sec. level:
5429 \advance\absseclevel by \secbase
5430 % Make sure \absseclevel doesn't fall outside the range:
5431 \ifnum \absseclevel < 0
5434 \ifnum \absseclevel > 3
5441 \ifnum \absseclevel < \unnlevel
5442 \chardef\unnlevel = \absseclevel
5445 % Check for appendix sections:
5446 \ifnum \absseclevel = 0
5447 \edef\chapheadtype{\headtype}%
5449 \if \headtype A\if \chapheadtype N%
5450 \errmessage{@appendix... within a non-appendix chapter}%
5453 % Check for numbered within unnumbered:
5454 \ifnum \absseclevel > \unnlevel
5457 \chardef\unnlevel = 3
5460 % Now print the heading:
5464 \or \unnumberedseczzz{#3}%
5465 \or \unnumberedsubseczzz{#3}%
5466 \or \unnumberedsubsubseczzz{#3}%
5472 \or \appendixsectionzzz{#3}%
5473 \or \appendixsubseczzz{#3}%
5474 \or \appendixsubsubseczzz{#3}%
5480 \or \numberedsubseczzz{#3}%
5481 \or \numberedsubsubseczzz{#3}%
5485 \suppressfirstparagraphindent
5489 \def\numhead{\genhead N}
5490 \def\apphead{\genhead A}
5491 \def\unnmhead{\genhead U}
5493 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5494 % all lower-level sectioning counters to zero.
5496 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5497 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5498 \let\chaplevelprefix = \empty
5500 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5502 % section resetting is \global in case the chapter is in a group, such
5503 % as an @include file.
5504 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5505 \global\advance\chapno by 1
5508 \gdef\chaplevelprefix{\the\chapno.}%
5511 % \putwordChapter can contain complex things in translations.
5512 \toks0=\expandafter{\putwordChapter}%
5513 \message{\the\toks0 \space \the\chapno}%
5515 % Write the actual heading.
5516 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5518 % So @section and the like are numbered underneath this chapter.
5519 \global\let\section = \numberedsec
5520 \global\let\subsection = \numberedsubsec
5521 \global\let\subsubsection = \numberedsubsubsec
5524 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5526 \def\appendixzzz#1{%
5527 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5528 \global\advance\appendixno by 1
5529 \gdef\chaplevelprefix{\appendixletter.}%
5532 % \putwordAppendix can contain complex things in translations.
5533 \toks0=\expandafter{\putwordAppendix}%
5534 \message{\the\toks0 \space \appendixletter}%
5536 \chapmacro{#1}{Yappendix}{\appendixletter}%
5538 \global\let\section = \appendixsec
5539 \global\let\subsection = \appendixsubsec
5540 \global\let\subsubsection = \appendixsubsubsec
5543 % normally unnmhead0 calls unnumberedzzz:
5544 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5545 \def\unnumberedzzz#1{%
5546 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5547 \global\advance\unnumberedno by 1
5549 % Since an unnumbered has no number, no prefix for figures.
5550 \global\let\chaplevelprefix = \empty
5553 % This used to be simply \message{#1}, but TeX fully expands the
5554 % argument to \message. Therefore, if #1 contained @-commands, TeX
5555 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5556 % expanded @cite (which turns out to cause errors because \cite is meant
5557 % to be executed, not expanded).
5559 % Anyway, we don't want the fully-expanded definition of @cite to appear
5560 % as a result of the \message, we just want `@cite' itself. We use
5561 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5562 % simply yielding the contents of <toks register>. (We also do this for
5565 \message{(\the\toks0)}%
5567 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5569 \global\let\section = \unnumberedsec
5570 \global\let\subsection = \unnumberedsubsec
5571 \global\let\subsubsection = \unnumberedsubsubsec
5574 % @centerchap is like @unnumbered, but the heading is centered.
5575 \outer\parseargdef\centerchap{%
5576 % Well, we could do the following in a group, but that would break
5577 % an assumption that \chapmacro is called at the outermost level.
5578 % Thus we are safer this way: --kasal, 24feb04
5579 \let\centerparametersmaybe = \centerparameters
5581 \let\centerparametersmaybe = \relax
5584 % @top is like @unnumbered.
5589 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5591 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5592 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5595 % normally calls appendixsectionzzz:
5596 \outer\parseargdef\appendixsection{\apphead1{#1}}
5597 \def\appendixsectionzzz#1{%
5598 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5599 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5601 \let\appendixsec\appendixsection
5603 % normally calls unnumberedseczzz:
5604 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5605 \def\unnumberedseczzz#1{%
5606 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5607 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5612 % normally calls numberedsubseczzz:
5613 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5614 \def\numberedsubseczzz#1{%
5615 \global\subsubsecno=0 \global\advance\subsecno by 1
5616 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5619 % normally calls appendixsubseczzz:
5620 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5621 \def\appendixsubseczzz#1{%
5622 \global\subsubsecno=0 \global\advance\subsecno by 1
5623 \sectionheading{#1}{subsec}{Yappendix}%
5624 {\appendixletter.\the\secno.\the\subsecno}%
5627 % normally calls unnumberedsubseczzz:
5628 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5629 \def\unnumberedsubseczzz#1{%
5630 \global\subsubsecno=0 \global\advance\subsecno by 1
5631 \sectionheading{#1}{subsec}{Ynothing}%
5632 {\the\unnumberedno.\the\secno.\the\subsecno}%
5637 % normally numberedsubsubseczzz:
5638 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5639 \def\numberedsubsubseczzz#1{%
5640 \global\advance\subsubsecno by 1
5641 \sectionheading{#1}{subsubsec}{Ynumbered}%
5642 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5645 % normally appendixsubsubseczzz:
5646 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5647 \def\appendixsubsubseczzz#1{%
5648 \global\advance\subsubsecno by 1
5649 \sectionheading{#1}{subsubsec}{Yappendix}%
5650 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5653 % normally unnumberedsubsubseczzz:
5654 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5655 \def\unnumberedsubsubseczzz#1{%
5656 \global\advance\subsubsecno by 1
5657 \sectionheading{#1}{subsubsec}{Ynothing}%
5658 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5661 % These macros control what the section commands do, according
5662 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5663 % Define them by default for a numbered chapter.
5664 \let\section = \numberedsec
5665 \let\subsection = \numberedsubsec
5666 \let\subsubsection = \numberedsubsubsec
5668 % Define @majorheading, @heading and @subheading
5671 {\advance\chapheadingskip by 10pt \chapbreak }%
5672 \parsearg\chapheadingzzz
5675 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5676 \def\chapheadingzzz#1{%
5677 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5678 \nobreak\bigskip \nobreak
5679 \suppressfirstparagraphindent
5682 % @heading, @subheading, @subsubheading.
5683 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5684 \suppressfirstparagraphindent}
5685 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5686 \suppressfirstparagraphindent}
5687 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5688 \suppressfirstparagraphindent}
5690 % These macros generate a chapter, section, etc. heading only
5691 % (including whitespace, linebreaking, etc. around it),
5692 % given all the information in convenient, parsed form.
5694 % Args are the skip and penalty (usually negative)
5695 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5697 % Parameter controlling skip before chapter headings (if needed)
5698 \newskip\chapheadingskip
5700 % Define plain chapter starts, and page on/off switching for it.
5701 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5702 \def\chappager{\par\vfill\supereject}
5703 % Because \domark is called before \chapoddpage, the filler page will
5704 % get the headings for the next chapter, which is wrong. But we don't
5705 % care -- we just disable all headings on the filler page.
5717 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5720 \global\let\contentsalignmacro = \chappager
5721 \global\let\pchapsepmacro=\chapbreak
5722 \global\let\pagealignmacro=\chappager}
5725 \global\let\contentsalignmacro = \chappager
5726 \global\let\pchapsepmacro=\chappager
5727 \global\let\pagealignmacro=\chappager
5728 \global\def\HEADINGSon{\HEADINGSsingle}}
5731 \global\let\contentsalignmacro = \chapoddpage
5732 \global\let\pchapsepmacro=\chapoddpage
5733 \global\let\pagealignmacro=\chapoddpage
5734 \global\def\HEADINGSon{\HEADINGSdouble}}
5740 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5741 % Yappendix, Yomitfromtoc), #3 the chapter number.
5742 % Not used for @heading series.
5744 % To test against our argument.
5745 \def\Ynothingkeyword{Ynothing}
5746 \def\Yappendixkeyword{Yappendix}
5747 \def\Yomitfromtockeyword{Yomitfromtoc}
5749 \def\chapmacro#1#2#3{%
5750 \checkenv{}% chapters, etc., should not start inside an environment.
5752 % Insert the first mark before the heading break (see notes for \domark).
5753 \let\prevchapterdefs=\lastchapterdefs
5754 \let\prevsectiondefs=\lastsectiondefs
5755 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5756 \gdef\thissection{}}%
5759 \ifx\temptype\Ynothingkeyword
5760 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5761 \gdef\thischapter{\thischaptername}}%
5762 \else\ifx\temptype\Yomitfromtockeyword
5763 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5764 \gdef\thischapter{}}%
5765 \else\ifx\temptype\Yappendixkeyword
5767 \xdef\lastchapterdefs{%
5768 \gdef\noexpand\thischaptername{\the\toks0}%
5769 \gdef\noexpand\thischapternum{\appendixletter}%
5770 % \noexpand\putwordAppendix avoids expanding indigestible
5771 % commands in some of the translations.
5772 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5773 \noexpand\thischapternum:
5774 \noexpand\thischaptername}%
5778 \xdef\lastchapterdefs{%
5779 \gdef\noexpand\thischaptername{\the\toks0}%
5780 \gdef\noexpand\thischapternum{\the\chapno}%
5781 % \noexpand\putwordChapter avoids expanding indigestible
5782 % commands in some of the translations.
5783 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5784 \noexpand\thischapternum:
5785 \noexpand\thischaptername}%
5789 % Output the mark. Pass it through \safewhatsit, to take care of
5790 % the preceding space.
5793 % Insert the chapter heading break.
5796 % Now the second mark, after the heading break. No break points
5797 % between here and the heading.
5798 \let\prevchapterdefs=\lastchapterdefs
5799 \let\prevsectiondefs=\lastsectiondefs
5803 \chapfonts \rmisbold
5805 % Have to define \lastsection before calling \donoderef, because the
5806 % xref code eventually uses it. On the other hand, it has to be called
5807 % after \pchapsepmacro, or the headline will change too soon.
5808 \gdef\lastsection{#1}%
5810 % Only insert the separating space if we have a chapter/appendix
5811 % number, and don't print the unnumbered ``number''.
5812 \ifx\temptype\Ynothingkeyword
5814 \def\toctype{unnchap}%
5815 \else\ifx\temptype\Yomitfromtockeyword
5816 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5818 \else\ifx\temptype\Yappendixkeyword
5819 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5822 \setbox0 = \hbox{#3\enspace}%
5823 \def\toctype{numchap}%
5826 % Write the toc entry for this chapter. Must come before the
5827 % \donoderef, because we include the current node name in the toc
5828 % entry, and \donoderef resets it to empty.
5829 \writetocentry{\toctype}{#1}{#3}%
5831 % For pdftex, we have to write out the node definition (aka, make
5832 % the pdfdest) after any page break, but before the actual text has
5833 % been typeset. If the destination for the pdf outline is after the
5834 % text, then jumping from the outline may wind up with the text not
5835 % being visible, for instance under high magnification.
5838 % Typeset the actual heading.
5839 \nobreak % Avoid page breaks at the interline glue.
5840 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5843 \nobreak\bigskip % no page break after a chapter title
5847 % @centerchap -- centered and unnumbered.
5848 \let\centerparametersmaybe = \relax
5849 \def\centerparameters{%
5850 \advance\rightskip by 3\rightskip
5851 \leftskip = \rightskip
5856 % I don't think this chapter style is supported any more, so I'm not
5857 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5859 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5861 \def\unnchfopen #1{%
5863 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5864 \nobreak\bigskip\nobreak
5866 \def\chfopen #1#2{\chapoddpage {\chapfonts
5867 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5870 \def\centerchfopen #1{%
5872 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5873 \nobreak\bigskip \nobreak
5876 \global\let\chapmacro=\chfopen
5877 \global\let\centerchapmacro=\centerchfopen}
5880 % Section titles. These macros combine the section number parts and
5881 % call the generic \sectionheading to do the printing.
5883 \newskip\secheadingskip
5884 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5886 % Subsection titles.
5887 \newskip\subsecheadingskip
5888 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5890 % Subsubsection titles.
5891 \def\subsubsecheadingskip{\subsecheadingskip}
5892 \def\subsubsecheadingbreak{\subsecheadingbreak}
5895 % Print any size, any type, section title.
5897 % #1 is the text of the title,
5898 % #2 is the section level (sec/subsec/subsubsec),
5899 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
5900 % #4 is the section number.
5902 \def\seckeyword{sec}
5904 \def\sectionheading#1#2#3#4{%
5906 \def\sectionlevel{#2}%
5909 % It is ok for the @heading series commands to appear inside an
5910 % environment (it's been historically allowed, though the logic is
5911 % dubious), but not the others.
5912 \ifx\temptype\Yomitfromtockeyword\else
5913 \checkenv{}% non-@*heading should not be in an environment.
5916 % Switch to the right set of fonts.
5917 \csname #2fonts\endcsname \rmisbold
5919 % Insert first mark before the heading break (see notes for \domark).
5920 \let\prevsectiondefs=\lastsectiondefs
5921 \ifx\temptype\Ynothingkeyword
5922 \ifx\sectionlevel\seckeyword
5923 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5924 \gdef\thissection{\thissectionname}}%
5926 \else\ifx\temptype\Yomitfromtockeyword
5927 % Don't redefine \thissection.
5928 \else\ifx\temptype\Yappendixkeyword
5929 \ifx\sectionlevel\seckeyword
5931 \xdef\lastsectiondefs{%
5932 \gdef\noexpand\thissectionname{\the\toks0}%
5933 \gdef\noexpand\thissectionnum{#4}%
5934 % \noexpand\putwordSection avoids expanding indigestible
5935 % commands in some of the translations.
5936 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5937 \noexpand\thissectionnum:
5938 \noexpand\thissectionname}%
5942 \ifx\sectionlevel\seckeyword
5944 \xdef\lastsectiondefs{%
5945 \gdef\noexpand\thissectionname{\the\toks0}%
5946 \gdef\noexpand\thissectionnum{#4}%
5947 % \noexpand\putwordSection avoids expanding indigestible
5948 % commands in some of the translations.
5949 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5950 \noexpand\thissectionnum:
5951 \noexpand\thissectionname}%
5956 % Go into vertical mode. Usually we'll already be there, but we
5957 % don't want the following whatsit to end up in a preceding paragraph
5958 % if the document didn't happen to have a blank line.
5961 % Output the mark. Pass it through \safewhatsit, to take care of
5962 % the preceding space.
5965 % Insert space above the heading.
5966 \csname #2headingbreak\endcsname
5968 % Now the second mark, after the heading break. No break points
5969 % between here and the heading.
5970 \global\let\prevsectiondefs=\lastsectiondefs
5973 % Only insert the space after the number if we have a section number.
5974 \ifx\temptype\Ynothingkeyword
5977 \gdef\lastsection{#1}%
5978 \else\ifx\temptype\Yomitfromtockeyword
5979 % for @headings -- no section number, don't include in toc,
5980 % and don't redefine \lastsection.
5983 \let\sectionlevel=\empty
5984 \else\ifx\temptype\Yappendixkeyword
5985 \setbox0 = \hbox{#4\enspace}%
5987 \gdef\lastsection{#1}%
5989 \setbox0 = \hbox{#4\enspace}%
5991 \gdef\lastsection{#1}%
5994 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5995 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5997 % Write the node reference (= pdf destination for pdftex).
5998 % Again, see comments in \chapmacro.
6001 % Interline glue will be inserted when the vbox is completed.
6002 % That glue will be a valid breakpoint for the page, since it'll be
6003 % preceded by a whatsit (usually from the \donoderef, or from the
6004 % \writetocentry if there was no node). We don't want to allow that
6005 % break, since then the whatsits could end up on page n while the
6006 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6009 % Output the actual section heading.
6010 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6011 \hangindent=\wd0 % zero if no section number
6014 % Add extra space after the heading -- half of whatever came above it.
6015 % Don't allow stretch, though.
6016 \kern .5 \csname #2headingskip\endcsname
6018 % Do not let the kern be a potential breakpoint, as it would be if it
6019 % was followed by glue.
6022 % We'll almost certainly start a paragraph next, so don't let that
6023 % glue accumulate. (Not a breakpoint because it's preceded by a
6024 % discardable item.) However, when a paragraph is not started next
6025 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6026 % or the negative glue will cause weirdly wrong output, typically
6027 % obscuring the section heading with something else.
6030 % This is so the last item on the main vertical list is a known
6031 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6032 % and do the needful.
6038 % Table of contents.
6041 % Write an entry to the toc file, opening it if necessary.
6042 % Called from @chapter, etc.
6044 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6045 % We append the current node name (if any) and page number as additional
6046 % arguments for the \{chap,sec,...}entry macros which will eventually
6047 % read this. The node name is used in the pdf outlines as the
6048 % destination to jump to.
6050 % We open the .toc file for writing here instead of at @setfilename (or
6051 % any other fixed time) so that @contents can be anywhere in the document.
6052 % But if #1 is `omit', then we don't do anything. This is used for the
6053 % table of contents chapter openings themselves.
6055 \newif\iftocfileopened
6056 \def\omitkeyword{omit}%
6058 \def\writetocentry#1#2#3{%
6059 \edef\writetoctype{#1}%
6060 \ifx\writetoctype\omitkeyword \else
6061 \iftocfileopened\else
6062 \immediate\openout\tocfile = \jobname.toc
6063 \global\tocfileopenedtrue
6069 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6075 % Tell \shipout to create a pdf destination on each page, if we're
6076 % writing pdf. These are used in the table of contents. We can't
6077 % just write one on every page because the title pages are numbered
6078 % 1 and 2 (the page numbers aren't printed), and so are the first
6079 % two pages of the document. Thus, we'd have two destinations named
6080 % `1', and two named `2'.
6081 \ifpdf \global\pdfmakepagedesttrue \fi
6085 % These characters do not print properly in the Computer Modern roman
6086 % fonts, so we must take special care. This is more or less redundant
6087 % with the Texinfo input format setup at the end of this file.
6089 \def\activecatcodes{%
6102 % Read the toc file, which is essentially Texinfo input.
6106 \input \tocreadfilename
6109 \newskip\contentsrightmargin \contentsrightmargin=1in
6110 \newcount\savepageno
6111 \newcount\lastnegativepageno \lastnegativepageno = -1
6113 % Prepare to read what we've written to \tocfile.
6115 \def\startcontents#1{%
6116 % If @setchapternewpage on, and @headings double, the contents should
6117 % start on an odd page, unlike chapters. Thus, we maintain
6118 % \contentsalignmacro in parallel with \pagealignmacro.
6119 % From: Torbjorn Granlund <tege@matematik.su.se>
6121 \immediate\closeout\tocfile
6123 % Don't need to put `Contents' or `Short Contents' in the headline.
6124 % It is abundantly clear what they are.
6125 \chapmacro{#1}{Yomitfromtoc}{}%
6127 \savepageno = \pageno
6128 \begingroup % Set up to handle contents files properly.
6129 \raggedbottom % Worry more about breakpoints than the bottom.
6130 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6132 % Roman numerals for page numbers.
6133 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6136 % redefined for the two-volume lispref. We always output on
6137 % \jobname.toc even if this is redefined.
6139 \def\tocreadfilename{\jobname.toc}
6141 % Normal (long) toc.
6144 \startcontents{\putwordTOC}%
6145 \openin 1 \tocreadfilename\space
6150 \contentsalignmacro % in case @setchapternewpage odd is in effect
6156 \lastnegativepageno = \pageno
6157 \global\pageno = \savepageno
6160 % And just the chapters.
6161 \def\summarycontents{%
6162 \startcontents{\putwordShortTOC}%
6164 \let\partentry = \shortpartentry
6165 \let\numchapentry = \shortchapentry
6166 \let\appentry = \shortchapentry
6167 \let\unnchapentry = \shortunnchapentry
6168 % We want a true roman here for the page numbers.
6170 \let\rm=\shortcontrm \let\bf=\shortcontbf
6171 \let\sl=\shortcontsl \let\tt=\shortconttt
6173 \hyphenpenalty = 10000
6174 \advance\baselineskip by 1pt % Open it up a little.
6175 \def\numsecentry##1##2##3##4{}
6176 \let\appsecentry = \numsecentry
6177 \let\unnsecentry = \numsecentry
6178 \let\numsubsecentry = \numsecentry
6179 \let\appsubsecentry = \numsecentry
6180 \let\unnsubsecentry = \numsecentry
6181 \let\numsubsubsecentry = \numsecentry
6182 \let\appsubsubsecentry = \numsecentry
6183 \let\unnsubsubsecentry = \numsecentry
6184 \openin 1 \tocreadfilename\space
6190 \contentsalignmacro % in case @setchapternewpage odd is in effect
6192 \lastnegativepageno = \pageno
6193 \global\pageno = \savepageno
6195 \let\shortcontents = \summarycontents
6197 % Typeset the label for a chapter or appendix for the short contents.
6198 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6200 \def\shortchaplabel#1{%
6201 % This space should be enough, since a single number is .5em, and the
6202 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6203 % But use \hss just in case.
6204 % (This space doesn't include the extra space that gets added after
6205 % the label; that gets put in by \shortchapentry above.)
6207 % We'd like to right-justify chapter numbers, but that looks strange
6208 % with appendix letters. And right-justifying numbers and
6209 % left-justifying letters looks strange when there is less than 10
6210 % chapters. Have to read the whole toc once to know how many chapters
6211 % there are before deciding ...
6212 \hbox to 1em{#1\hss}%
6215 % These macros generate individual entries in the table of contents.
6216 % The first argument is the chapter or section name.
6217 % The last argument is the page number.
6218 % The arguments in between are the chapter number, section number, ...
6220 % Parts, in the main contents. Replace the part number, which doesn't
6221 % exist, with an empty box. Let's hope all the numbers have the same width.
6222 % Also ignore the page number, which is conventionally not printed.
6223 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6224 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6226 % Parts, in the short toc.
6227 \def\shortpartentry#1#2#3#4{%
6229 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6230 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6233 % Chapters, in the main contents.
6234 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6236 % Chapters, in the short toc.
6237 % See comments in \dochapentry re vbox and related settings.
6238 \def\shortchapentry#1#2#3#4{%
6239 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6242 % Appendices, in the main contents.
6243 % Need the word Appendix, and a fixed-size box.
6245 \def\appendixbox#1{%
6246 % We use M since it's probably the widest letter.
6247 \setbox0 = \hbox{\putwordAppendix{} M}%
6248 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6250 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6252 % Unnumbered chapters.
6253 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6254 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6257 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6258 \let\appsecentry=\numsecentry
6259 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6262 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6263 \let\appsubsecentry=\numsubsecentry
6264 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6266 % And subsubsections.
6267 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6268 \let\appsubsubsecentry=\numsubsubsecentry
6269 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6271 % This parameter controls the indentation of the various levels.
6272 % Same as \defaultparindent.
6273 \newdimen\tocindent \tocindent = 15pt
6275 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6278 % If the toc has to be broken over pages, we want it to be at chapters
6279 % if at all possible; hence the \penalty.
6280 \def\dochapentry#1#2{%
6281 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6284 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6286 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6289 \def\dosecentry#1#2{\begingroup
6290 \secentryfonts \leftskip=\tocindent
6291 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6294 \def\dosubsecentry#1#2{\begingroup
6295 \subsecentryfonts \leftskip=2\tocindent
6296 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6299 \def\dosubsubsecentry#1#2{\begingroup
6300 \subsubsecentryfonts \leftskip=3\tocindent
6301 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6304 % We use the same \entry macro as for the index entries.
6305 \let\tocentry = \entry
6307 % Space between chapter (or whatever) number and the title.
6308 \def\labelspace{\hskip1em \relax}
6310 \def\dopageno#1{{\rm #1}}
6311 \def\doshortpageno#1{{\rm #1}}
6313 \def\chapentryfonts{\secfonts \rm}
6314 \def\secentryfonts{\textfonts}
6315 \def\subsecentryfonts{\textfonts}
6316 \def\subsubsecentryfonts{\textfonts}
6319 \message{environments,}
6320 % @foo ... @end foo.
6322 % @tex ... @end tex escapes into raw TeX temporarily.
6323 % One exception: @ is still an escape character, so that @end tex works.
6324 % But \@ or @@ will get a plain @ character.
6327 \setupmarkupstyle{tex}%
6328 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6329 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6330 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6341 % ' is active in math mode (mathcode"8000). So reset it, and all our
6342 % other math active characters (just in case), to plain's definitions.
6346 \let\bullet=\ptexbullet
6351 \let\equiv=\ptexequiv
6354 \let\indent=\ptexindent
6355 \let\noindent=\ptexnoindent
6362 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
6363 \let\frenchspacing=\plainfrenchspacing
6365 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6366 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6369 % There is no need to define \Etex.
6371 % Define @lisp ... @end lisp.
6372 % @lisp environment forms a group so it can rebind things,
6373 % including the definition of @end lisp (which normally is erroneous).
6375 % Amount to narrow the margins by for @lisp.
6376 \newskip\lispnarrowing \lispnarrowing=0.4in
6378 % This is the definition that ^^M gets inside @lisp, @example, and other
6379 % such environments. \null is better than a space, since it doesn't
6381 \def\lisppar{\null\endgraf}
6383 % This space is always present above and below environments.
6384 \newskip\envskipamount \envskipamount = 0pt
6386 % Make spacing and below environment symmetrical. We use \parskip here
6387 % to help in doing that, since in @example-like environments \parskip
6388 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6389 % start of the next paragraph will insert \parskip.
6391 \def\aboveenvbreak{{%
6392 % =10000 instead of <10000 because of a special case in \itemzzz and
6393 % \sectionheading, q.v.
6394 \ifnum \lastpenalty=10000 \else
6395 \advance\envskipamount by \parskip
6397 \ifdim\lastskip<\envskipamount
6399 % it's not a good place to break if the last penalty was \nobreak
6401 \ifnum\lastpenalty<10000 \penalty-50 \fi
6402 \vskip\envskipamount
6407 \let\afterenvbreak = \aboveenvbreak
6409 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6410 % also clear it, so that its embedded environments do the narrowing again.
6411 \let\nonarrowing=\relax
6413 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6414 % environment contents.
6415 \font\circle=lcircle10
6417 \newdimen\cartouter\newdimen\cartinner
6418 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6419 \circthick=\fontdimen8\circle
6421 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6422 \def\ctr{{\hskip 6pt\circle\char'010}}
6423 \def\cbl{{\circle\char'012\hskip -6pt}}
6424 \def\cbr{{\hskip 6pt\circle\char'011}}
6425 \def\carttop{\hbox to \cartouter{\hskip\lskip
6426 \ctl\leaders\hrule height\circthick\hfil\ctr
6428 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6429 \cbl\leaders\hrule height\circthick\hfil\cbr
6432 \newskip\lskip\newskip\rskip
6435 \ifhmode\par\fi % can't be in the midst of a paragraph.
6437 \lskip=\leftskip \rskip=\rightskip
6438 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6439 \cartinner=\hsize \advance\cartinner by-\lskip
6440 \advance\cartinner by-\rskip
6442 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6443 % side, and for 6pt waste from
6444 % each corner char, and rule thickness
6445 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6447 % If this cartouche directly follows a sectioning command, we need the
6448 % \parskip glue (backspaced over by default) or the cartouche can
6449 % collide with the section heading.
6450 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6453 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6461 \baselineskip=\normbskip
6462 \lineskip=\normlskip
6465 \comment % For explanation, see the end of def\group.
6480 % This macro is called at the beginning of all the @example variants,
6482 \newdimen\nonfillparindent
6485 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6486 \sepspaces % Make spaces be word-separators rather than space tokens.
6487 \let\par = \lisppar % don't ignore blank lines
6488 \obeylines % each line of input is a line of output
6490 % Turn off paragraph indentation but redefine \indent to emulate
6491 % the normal \indent.
6492 \nonfillparindent=\parindent
6494 \let\indent\nonfillindent
6496 \emergencystretch = 0pt % don't try to avoid overfull boxes
6497 \ifx\nonarrowing\relax
6498 \advance \leftskip by \lispnarrowing
6499 \exdentamount=\lispnarrowing
6501 \let\nonarrowing = \relax
6503 \let\exdent=\nofillexdent
6508 % We want to swallow spaces (but not other tokens) after the fake
6509 % @indent in our nonfill-environments, where spaces are normally
6510 % active and set to @tie, resulting in them not being ignored after
6512 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6513 \gdef\nonfillindentcheck{%
6515 \expandafter\nonfillindentgobble%
6517 \leavevmode\nonfillindentbox%
6521 \def\nonfillindentgobble#1{\nonfillindent}
6522 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6524 % If you want all examples etc. small: @set dispenvsize small.
6525 % If you want even small examples the full size: @set dispenvsize nosmall.
6526 % This affects the following displayed environments:
6527 % @example, @display, @format, @lisp
6529 \def\smallword{small}
6530 \def\nosmallword{nosmall}
6531 \let\SETdispenvsize\relax
6532 \def\setnormaldispenv{%
6533 \ifx\SETdispenvsize\smallword
6534 % end paragraph for sake of leading, in case document has no blank
6535 % line. This is redundant with what happens in \aboveenvbreak, but
6536 % we need to do it before changing the fonts, and it's inconvenient
6537 % to change the fonts afterward.
6538 \ifnum \lastpenalty=10000 \else \endgraf \fi
6539 \smallexamplefonts \rm
6542 \def\setsmalldispenv{%
6543 \ifx\SETdispenvsize\nosmallword
6545 \ifnum \lastpenalty=10000 \else \endgraf \fi
6546 \smallexamplefonts \rm
6550 % We often define two environments, @foo and @smallfoo.
6551 % Let's do it in one command. #1 is the env name, #2 the definition.
6552 \def\makedispenvdef#1#2{%
6553 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6554 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6555 \expandafter\let\csname E#1\endcsname \afterenvbreak
6556 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6559 % Define two environment synonyms (#1 and #2) for an environment.
6560 \def\maketwodispenvdef#1#2#3{%
6561 \makedispenvdef{#1}{#3}%
6562 \makedispenvdef{#2}{#3}%
6565 % @lisp: indented, narrowed, typewriter font;
6566 % @example: same as @lisp.
6568 % @smallexample and @smalllisp: use smaller fonts.
6569 % Originally contributed by Pavel@xerox.
6571 \maketwodispenvdef{lisp}{example}{%
6573 \tt\setupmarkupstyle{example}%
6574 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6575 \gobble % eat return
6577 % @display/@smalldisplay: same as @lisp except keep current font.
6579 \makedispenvdef{display}{%
6584 % @format/@smallformat: same as @display except don't narrow margins.
6586 \makedispenvdef{format}{%
6587 \let\nonarrowing = t%
6592 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6594 \let\nonarrowing = t%
6598 \let\Eflushleft = \afterenvbreak
6602 \envdef\flushright{%
6603 \let\nonarrowing = t%
6605 \advance\leftskip by 0pt plus 1fill\relax
6608 \let\Eflushright = \afterenvbreak
6611 % @raggedright does more-or-less normal line breaking but no right
6612 % justification. From plain.tex. Don't stretch around special
6613 % characters in urls in this environment, since the stretch at the right
6615 \envdef\raggedright{%
6616 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
6617 \def\urefprestretchamount{0pt}%
6618 \def\urefpoststretchamount{0pt}%
6620 \let\Eraggedright\par
6622 \envdef\raggedleft{%
6623 \parindent=0pt \leftskip0pt plus2em
6624 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6625 \hbadness=10000 % Last line will usually be underfull, so turn off
6626 % badness reporting.
6628 \let\Eraggedleft\par
6630 \envdef\raggedcenter{%
6631 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6632 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6633 \hbadness=10000 % Last line will usually be underfull, so turn off
6634 % badness reporting.
6636 \let\Eraggedcenter\par
6639 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6640 % and narrows the margins. We keep \parskip nonzero in general, since
6641 % we're doing normal filling. So, when using \aboveenvbreak and
6642 % \afterenvbreak, temporarily make \parskip 0.
6644 \makedispenvdef{quotation}{\quotationstart}
6646 \def\quotationstart{%
6647 \indentedblockstart % same as \indentedblock, but increase right margin too.
6648 \ifx\nonarrowing\relax
6649 \advance\rightskip by \lispnarrowing
6651 \parsearg\quotationlabel
6654 % We have retained a nonzero parskip for the environment, since we're
6655 % doing normal filling.
6659 \ifx\quotationauthor\thisisundefined\else
6661 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6663 {\parskip=0pt \afterenvbreak}%
6665 \def\Esmallquotation{\Equotation}
6667 % If we're given an argument, typeset it in bold with a colon after.
6668 \def\quotationlabel#1{%
6670 \ifx\temp\empty \else
6675 % @indentedblock is like @quotation, but indents only on the left and
6676 % has no optional argument.
6678 \makedispenvdef{indentedblock}{\indentedblockstart}
6680 \def\indentedblockstart{%
6681 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6684 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6685 \ifx\nonarrowing\relax
6686 \advance\leftskip by \lispnarrowing
6687 \exdentamount = \lispnarrowing
6689 \let\nonarrowing = \relax
6693 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6695 \def\Eindentedblock{%
6697 {\parskip=0pt \afterenvbreak}%
6699 \def\Esmallindentedblock{\Eindentedblock}
6702 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6703 % If we want to allow any <char> as delimiter,
6704 % we need the curly braces so that makeinfo sees the @verb command, eg:
6705 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6707 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6709 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6710 % active too. Otherwise, they get lost as the first character on a
6713 \do\ \do\\\do\{\do\}\do\$\do\&%
6714 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6715 \do\<\do\>\do\|\do\@\do+\do\"%
6716 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6717 % @set txicodequotebacktick will not have effect on @verb and
6718 % @verbatim, and ?` and !` ligatures won't get disabled.
6723 \def\uncatcodespecials{%
6724 \def\do##1{\catcode`##1=\other}\dospecials}
6726 % Setup for the @verb command.
6728 % Eight spaces for a tab
6730 \catcode`\^^I=\active
6731 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6735 \tt % easiest (and conventionally used) font for verbatim
6736 \def\par{\leavevmode\endgraf}%
6737 \setupmarkupstyle{verb}%
6739 % Respect line breaks,
6740 % print special symbols as themselves, and
6741 % make each space count
6742 % must do in this order:
6743 \obeylines \uncatcodespecials \sepspaces
6746 % Setup for the @verbatim environment
6748 % Real tab expansion.
6749 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6751 % We typeset each line of the verbatim in an \hbox, so we can handle
6752 % tabs. The \global is in case the verbatim line starts with an accent,
6753 % or some other command that starts with a begin-group. Otherwise, the
6754 % entire \verbbox would disappear at the corresponding end-group, before
6755 % it is typeset. Meanwhile, we can't have nested verbatim commands
6756 % (can we?), so the \global won't be overwriting itself.
6758 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6761 \catcode`\^^I=\active
6763 \catcode`\^^I=\active
6764 \def^^I{\leavevmode\egroup
6765 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6766 \divide\dimen\verbbox by\tabw
6767 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6768 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6769 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6774 % start the verbatim environment.
6775 \def\setupverbatim{%
6776 \let\nonarrowing = t%
6778 \tt % easiest (and conventionally used) font for verbatim
6779 % The \leavevmode here is for blank lines. Otherwise, we would
6780 % never \starttabox and the \egroup would end verbatim mode.
6781 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6783 \setupmarkupstyle{verbatim}%
6784 % Respect line breaks,
6785 % print special symbols as themselves, and
6786 % make each space count.
6787 % Must do in this order:
6788 \obeylines \uncatcodespecials \sepspaces
6789 \everypar{\starttabbox}%
6792 % Do the @verb magic: verbatim text is quoted by unique
6793 % delimiter characters. Before first delimiter expect a
6794 % right brace, after last delimiter expect closing brace:
6796 % \def\doverb'{'<char>#1<char>'}'{#1}
6798 % [Knuth] p. 382; only eat outer {}
6800 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6801 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6804 \def\verb{\begingroup\setupverb\doverb}
6807 % Do the @verbatim magic: define the macro \doverbatim so that
6808 % the (first) argument ends when '@end verbatim' is reached, ie:
6810 % \def\doverbatim#1@end verbatim{#1}
6812 % For Texinfo it's a lot easier than for LaTeX,
6813 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6814 % we need not redefine '\', '{' and '}'.
6816 % Inspired by LaTeX's verbatim command set [latex.ltx]
6821 % ignore everything up to the first ^^M, that's the newline at the end
6822 % of the @verbatim input line itself. Otherwise we get an extra blank
6823 % line in the output.
6824 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6825 % We really want {...\end verbatim} in the body of the macro, but
6826 % without the active space; thus we have to use \xdef and \gobble.
6830 \setupverbatim\doverbatim
6832 \let\Everbatim = \afterenvbreak
6835 % @verbatiminclude FILE - insert text of file in verbatim environment.
6837 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6839 \def\doverbatiminclude#1{%
6841 \makevalueexpandable
6843 \indexnofonts % Allow `@@' and other weird things in file names.
6844 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6850 % @copying ... @end copying.
6851 % Save the text away for @insertcopying later.
6853 % We save the uninterpreted tokens, rather than creating a box.
6854 % Saving the text in a box would be much easier, but then all the
6855 % typesetting commands (@smallbook, font changes, etc.) have to be done
6856 % beforehand -- and a) we want @copying to be done first in the source
6857 % file; b) letting users define the frontmatter in as flexible order as
6858 % possible is very desirable.
6860 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6861 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6863 \def\insertcopying{%
6865 \parindent = 0pt % paragraph indentation looks wrong on title page
6866 \scanexp\copyingtext
6874 \newskip\defbodyindent \defbodyindent=.4in
6875 \newskip\defargsindent \defargsindent=50pt
6876 \newskip\deflastargmargin \deflastargmargin=18pt
6877 \newcount\defunpenalty
6879 % Start the processing of @deffn:
6881 \ifnum\lastpenalty<10000
6883 \defunpenalty=10003 % Will keep this @deffn together with the
6884 % following @def command, see below.
6886 % If there are two @def commands in a row, we'll have a \nobreak,
6887 % which is there to keep the function description together with its
6888 % header. But if there's nothing but headers, we need to allow a
6889 % break somewhere. Check specifically for penalty 10002, inserted
6890 % by \printdefunline, instead of 10000, since the sectioning
6891 % commands also insert a nobreak penalty, and we don't want to allow
6892 % a break between a section heading and a defun.
6894 % As a further refinement, we avoid "club" headers by signalling
6895 % with penalty of 10003 after the very first @deffn in the
6896 % sequence (see above), and penalty of 10002 after any following
6898 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6900 % Similarly, after a section heading, do not allow a break.
6901 % But do insert the glue.
6902 \medskip % preceded by discardable penalty, so not a breakpoint
6906 \advance\leftskip by \defbodyindent
6907 \exdentamount=\defbodyindent
6911 % First, check whether we are in the right environment:
6914 % As above, allow line break if we have multiple x headers in a row.
6915 % It's not a great place, though.
6916 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6918 % And now, it's time to reuse the body of the original defun:
6919 \expandafter\gobbledefun#1%
6921 \def\gobbledefun#1\startdefun{}
6923 % \printdefunline \deffnheader{text}
6925 \def\printdefunline#1#2{%
6927 % call \deffnheader:
6930 \interlinepenalty = 10000
6931 \advance\rightskip by 0pt plus 1fil\relax
6933 \nobreak\vskip -\parskip
6934 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6935 % Some of the @defun-type tags do not enable magic parentheses,
6936 % rendering the following check redundant. But we don't optimize.
6941 \def\Edefun{\endgraf\medbreak}
6943 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6944 % the only thing remaining is to define \deffnheader.
6947 \expandafter\let\csname E#1\endcsname = \Edefun
6948 \edef\temp{\noexpand\domakedefun
6949 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6953 % \domakedefun \deffn \deffnx \deffnheader
6955 % Define \deffn and \deffnx, without parameters.
6956 % \deffnheader has to be defined explicitly.
6958 \def\domakedefun#1#2#3{%
6961 \doingtypefnfalse % distinguish typed functions from all else
6962 \parseargusing\activeparens{\printdefunline#3}%
6964 \def#2{\dodefunx#1}%
6968 \newif\ifdoingtypefn % doing typed function?
6969 \newif\ifrettypeownline % typeset return type on its own line?
6971 % @deftypefnnewline on|off says whether the return type of typed functions
6972 % are printed on their own line. This affects @deftypefn, @deftypefun,
6973 % @deftypeop, and @deftypemethod.
6975 \parseargdef\deftypefnnewline{%
6978 \expandafter\let\csname SETtxideftypefnnl\endcsname
6980 \else\ifx\temp\offword
6981 \expandafter\let\csname SETtxideftypefnnl\endcsname
6984 \errhelp = \EMsimple
6985 \errmessage{Unknown @txideftypefnnl value `\temp',
6990 % Untyped functions:
6992 % @deffn category name args
6993 \makedefun{deffn}{\deffngeneral{}}
6995 % @deffn category class name args
6996 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6998 % \defopon {category on}class name args
6999 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7001 % \deffngeneral {subind}category name args
7003 \def\deffngeneral#1#2 #3 #4\endheader{%
7004 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7005 \dosubind{fn}{\code{#3}}{#1}%
7006 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7011 % @deftypefn category type name args
7012 \makedefun{deftypefn}{\deftypefngeneral{}}
7014 % @deftypeop category class type name args
7015 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7017 % \deftypeopon {category on}class type name args
7018 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7020 % \deftypefngeneral {subind}category type name args
7022 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7023 \dosubind{fn}{\code{#4}}{#1}%
7025 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7030 % @deftypevr category type var args
7031 \makedefun{deftypevr}{\deftypecvgeneral{}}
7033 % @deftypecv category class type var args
7034 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7036 % \deftypecvof {category of}class type var args
7037 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7039 % \deftypecvgeneral {subind}category type var args
7041 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7042 \dosubind{vr}{\code{#4}}{#1}%
7043 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7046 % Untyped variables:
7048 % @defvr category var args
7049 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7051 % @defcv category class var args
7052 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7054 % \defcvof {category of}class var args
7055 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7059 % @deftp category name args
7060 \makedefun{deftp}#1 #2 #3\endheader{%
7061 \doind{tp}{\code{#2}}%
7062 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7065 % Remaining @defun-like shortcuts:
7066 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7067 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7068 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7069 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7070 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7071 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7072 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7073 \makedefun{defmethod}{\defopon\putwordMethodon}
7074 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7075 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7076 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7078 % \defname, which formats the name of the @def (not the args).
7079 % #1 is the category, such as "Function".
7080 % #2 is the return type, if any.
7081 % #3 is the function name.
7083 % We are followed by (but not passed) the arguments, if any.
7085 \def\defname#1#2#3{%
7087 % Get the values of \leftskip and \rightskip as they were outside the @def...
7088 \advance\leftskip by -\defbodyindent
7090 % Determine if we are typesetting the return type of a typed function
7091 % on a line by itself.
7092 \rettypeownlinefalse
7093 \ifdoingtypefn % doing a typed function specifically?
7094 % then check user option for putting return type on its own line:
7095 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7100 % How we'll format the category name. Putting it in brackets helps
7101 % distinguish it from the body text that may end up on the next line
7104 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7106 % Figure out line sizes for the paragraph shape. We'll always have at
7110 % The first line needs space for \box0; but if \rightskip is nonzero,
7111 % we need only space for the part of \box0 which exceeds it:
7112 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7114 % If doing a return type on its own line, we'll have another line.
7116 \advance\tempnum by 1
7117 \def\maybeshapeline{0in \hsize}%
7119 \def\maybeshapeline{}%
7122 % The continuations:
7123 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7125 % The final paragraph shape:
7126 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7128 % Put the category name at the right margin.
7131 \hfil\box0 \kern-\hsize
7132 % \hsize has to be shortened this way:
7134 % Intentionally do not respect \rightskip, since we need the space.
7137 % Allow all lines to be underfull without complaint:
7138 \tolerance=10000 \hbadness=10000
7139 \exdentamount=\defbodyindent
7141 % defun fonts. We use typewriter by default (used to be bold) because:
7142 % . we're printing identifiers, they should be in tt in principle.
7143 % . in languages with many accents, such as Czech or French, it's
7144 % common to leave accents off identifiers. The result looks ok in
7145 % tt, but exceedingly strange in rm.
7146 % . we don't want -- and --- to be treated as ligatures.
7147 % . this still does not fix the ?` and !` ligatures, but so far no
7148 % one has made identifiers using them :).
7150 \def\temp{#2}% text of the return type
7151 \ifx\temp\empty\else
7152 \tclose{\temp}% typeset the return type
7154 % put return type on its own line; prohibit line break following:
7155 \hfil\vadjust{\nobreak}\break
7157 \space % type on same line, so just followed by a space
7159 \fi % no return type
7160 #3% output function name
7162 {\rm\enskip}% hskip 0.5 em of \tenrm
7165 % arguments will be output next, if any.
7168 % Print arguments in slanted roman (not ttsl), inconsistently with using
7169 % tt for the name. This is because literal text is sometimes needed in
7170 % the argument list (groff manual), and ttsl and tt are not very
7171 % distinguishable. Prevent hyphenation at `-' chars.
7174 % use sl by default (not ttsl),
7176 \df \sl \hyphenchar\font=0
7178 % On the other hand, if an argument has two dashes (for instance), we
7179 % want a way to get ttsl. We used to recommend @var for that, so
7180 % leave the code in, but it's strange for @var to lead to typewriter.
7181 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7182 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7183 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7185 \sl\hyphenchar\font=45
7188 % We want ()&[] to print specially on the defun line.
7191 \catcode`\(=\active \catcode`\)=\active
7192 \catcode`\[=\active \catcode`\]=\active
7196 % Make control sequences which act like normal parenthesis chars.
7197 \let\lparen = ( \let\rparen = )
7199 % Be sure that we always have a definition for `(', etc. For example,
7200 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7201 % so TeX would otherwise complain about undefined control sequence.
7204 \global\let(=\lparen \global\let)=\rparen
7205 \global\let[=\lbrack \global\let]=\rbrack
7208 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7209 \gdef\magicamp{\let&=\amprm}
7212 \newcount\parencount
7214 % If we encounter &foo, then turn on ()-hacking afterwards
7216 \def\amprm#1 {\ampseentrue{\bf\ }}
7220 % At the first level, print parens in roman,
7221 % otherwise use the default font.
7222 \ifnum \parencount=1 \rm \fi
7224 % The \sf parens (in \boldbrax) actually are a little bolder than
7225 % the contained text. This is especially needed for [ and ] .
7229 \def\infirstlevel#1{%
7236 \def\bfafterword#1 {#1 \bf}
7239 \global\advance\parencount by 1
7241 \infirstlevel \bfafterword
7246 \global\advance\parencount by -1
7249 \newcount\brackcount
7251 \global\advance\brackcount by 1
7256 \global\advance\brackcount by -1
7259 \def\checkparencounts{%
7260 \ifnum\parencount=0 \else \badparencount \fi
7261 \ifnum\brackcount=0 \else \badbrackcount \fi
7263 % these should not use \errmessage; the glibc manual, at least, actually
7264 % has such constructs (when documenting function pointers).
7265 \def\badparencount{%
7266 \message{Warning: unbalanced parentheses in @def...}%
7267 \global\parencount=0
7269 \def\badbrackcount{%
7270 \message{Warning: unbalanced square brackets in @def...}%
7271 \global\brackcount=0
7278 % To do this right we need a feature of e-TeX, \scantokens,
7279 % which we arrange to emulate with a temporary file in ordinary TeX.
7280 \ifx\eTeXversion\thisisundefined
7281 \newwrite\macscribble
7284 \immediate\openout\macscribble=\jobname.tmp
7285 \immediate\write\macscribble{\the\toks0}%
7286 \immediate\closeout\macscribble
7291 \def\scanmacro#1{\begingroup
7293 \let\xeatspaces\eatspaces
7295 % Undo catcode changes of \startcontents and \doprintindex
7296 % When called from @insertcopying or (short)caption, we need active
7297 % backslash to get it printed correctly. Previously, we had
7298 % \catcode`\\=\other instead. We'll see whether a problem appears
7299 % with macro expansion. --kasal, 19aug04
7300 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7302 % ... and for \example:
7305 % The \empty here causes a following catcode 5 newline to be eaten as
7306 % part of reading whitespace after a control sequence. It does not
7307 % eat a catcode 13 newline. There's no good way to handle the two
7308 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7309 % would then have different behavior). See the Macro Details node in
7310 % the manual for the workaround we recommend for macros and
7311 % line-oriented commands.
7313 \scantokens{#1\empty}%
7317 \edef\temp{\noexpand\scanmacro{#1}}%
7321 \newcount\paramno % Count of parameters
7322 \newtoks\macname % Macro name
7323 \newif\ifrecursive % Is it recursive?
7325 % List of all defined macros in the form
7326 % \definedummyword\macro1\definedummyword\macro2...
7327 % Currently is also contains all @aliases; the list can be split
7328 % if there is a need.
7331 % Add the macro to \macrolist
7332 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7333 \def\addtomacrolistxxx#1{%
7334 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7335 \xdef\macrolist{\the\toks0}%
7339 % This does \let #1 = #2, with \csnames; that is,
7340 % \let \csname#1\endcsname = \csname#2\endcsname
7341 % (except of course we have to play expansion games).
7345 \csname#1\expandafter\endcsname
7349 % Trim leading and trailing spaces off a string.
7350 % Concepts from aro-bend problem 15 (see CTAN).
7352 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7353 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7354 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7356 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7359 % Trim a single trailing ^^M off a string.
7360 {\catcode`\^^M=\other \catcode`\Q=3%
7361 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7362 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7363 \gdef\eatcrb#1Q#2Q{#1}%
7366 % Macro bodies are absorbed as an argument in a context where
7367 % all characters are catcode 10, 11 or 12, except \ which is active
7368 % (as in normal texinfo). It is necessary to change the definition of \
7369 % to recognize macro arguments; this is the job of \mbodybackslash.
7371 % Non-ASCII encodings make 8-bit characters active, so un-activate
7372 % them to avoid their expansion. Must do this non-globally, to
7373 % confine the change to the current group.
7375 % It's necessary to have hard CRs when the macro is executed. This is
7376 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7377 % body, and then making it the \newlinechar in \scanmacro.
7379 \def\scanctxt{% used as subroutine
7389 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7392 \def\scanargctxt{% used for copying and captions, not macros.
7395 \catcode`\^^M=\other
7398 \def\macrobodyctxt{% used for @macro definitions
7402 \catcode`\^^M=\other
7406 \def\macroargctxt{% used when scanning invocations
7410 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7411 % for the single characters \ { }. Thus, we end up with the "commands"
7412 % that would be written @\ @{ @} in a Texinfo document.
7414 % We already have @{ and @}. For @\, we define it here, and only for
7415 % this purpose, to produce a typewriter backslash (so, the @\ that we
7416 % define for @math can't be used with @macro calls):
7418 \def\\{\normalbackslash}%
7420 % We would like to do this for \, too, since that is what makeinfo does.
7421 % But it is not possible, because Texinfo already has a command @, for a
7422 % cedilla accent. Documents must use @comma{} instead.
7424 % \anythingelse will almost certainly be an error of some kind.
7427 % \mbodybackslash is the definition of \ in @macro bodies.
7428 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7429 % where N is the macro parameter number.
7430 % We define \csname macarg.\endcsname to be \realbackslash, so
7431 % \\ in macro replacement text gets you a backslash.
7433 {\catcode`@=0 @catcode`@\=@active
7434 @gdef@usembodybackslash{@let\=@mbodybackslash}
7435 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7437 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7439 \def\margbackslash#1{\char`\#1 }
7441 \def\macro{\recursivefalse\parsearg\macroxxx}
7442 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7445 \getargs{#1}% now \macname is the macname and \argl the arglist
7446 \ifx\argl\empty % no arguments
7449 \expandafter\parsemargdef \argl;%
7450 \if\paramno>256\relax
7451 \ifx\eTeXversion\thisisundefined
7452 \errhelp = \EMsimple
7453 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7457 \if1\csname ismacro.\the\macname\endcsname
7458 \message{Warning: redefining \the\macname}%
7460 \expandafter\ifx\csname \the\macname\endcsname \relax
7461 \else \errmessage{Macro name \the\macname\space already defined}\fi
7462 \global\cslet{macsave.\the\macname}{\the\macname}%
7463 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7464 \addtomacrolist{\the\macname}%
7466 \begingroup \macrobodyctxt
7467 \ifrecursive \expandafter\parsermacbody
7468 \else \expandafter\parsemacbody
7471 \parseargdef\unmacro{%
7472 \if1\csname ismacro.#1\endcsname
7473 \global\cslet{#1}{macsave.#1}%
7474 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7475 % Remove the macro name from \macrolist:
7477 \expandafter\let\csname#1\endcsname \relax
7478 \let\definedummyword\unmacrodo
7479 \xdef\macrolist{\macrolist}%
7482 \errmessage{Macro #1 not defined}%
7486 % Called by \do from \dounmacro on each macro. The idea is to omit any
7487 % macro definitions that have been changed to \relax.
7493 \noexpand\definedummyword \noexpand#1%
7497 % This makes use of the obscure feature that if the last token of a
7498 % <parameter list> is #, then the preceding argument is delimited by
7499 % an opening brace, and that opening brace is not consumed.
7500 \def\getargs#1{\getargsxxx#1{}}
7501 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7502 \def\getmacname#1 #2\relax{\macname={#1}}
7503 \def\getmacargs#1{\def\argl{#1}}
7505 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7506 \edef\texiatcatcode{\the\catcode`\@}
7507 \catcode `@=11\relax
7509 % Parse the optional {params} list. Set up \paramno and \paramlist
7510 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7511 % in the params list to some hook where the argument is to be expanded. If
7512 % there are less than 10 arguments that hook is to be replaced by ##N where N
7513 % is the position in that list, that is to say the macro arguments are to be
7514 % defined `a la TeX in the macro body.
7516 % That gets used by \mbodybackslash (above).
7518 % We need to get `macro parameter char #' into several definitions.
7519 % The technique used is stolen from LaTeX: let \hash be something
7520 % unexpandable, insert that wherever you need a #, and then redefine
7521 % it to # just before using the token list produced.
7523 % The same technique is used to protect \eatspaces till just before
7524 % the macro is used.
7526 % If there are 10 or more arguments, a different technique is used, where the
7527 % hook remains in the body, and when macro is to be expanded the body is
7528 % processed again to replace the arguments.
7530 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7531 % argument N value and then \edef the body (nothing else will expand because of
7532 % the catcode regime underwhich the body was input).
7534 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7535 % arguments, you need that no macro has more than 256 arguments, otherwise an
7536 % error is produced.
7537 \def\parsemargdef#1;{%
7538 \paramno=0\def\paramlist{}%
7540 \let\xeatspaces\relax
7541 \parsemargdefxxx#1,;,%
7542 % In case that there are 10 or more arguments we parse again the arguments
7543 % list to set new definitions for the \macarg.BLAH macros corresponding to
7544 % each BLAH argument. It was anyhow needed to parse already once this list
7545 % in order to count the arguments, and as macros with at most 9 arguments
7546 % are by far more frequent than macro with 10 or more arguments, defining
7547 % twice the \macarg.BLAH macros does not cost too much processing power.
7548 \ifnum\paramno<10\relax\else
7550 \parsemmanyargdef@@#1,;,% 10 or more arguments
7553 \def\parsemargdefxxx#1,{%
7554 \if#1;\let\next=\relax
7555 \else \let\next=\parsemargdefxxx
7556 \advance\paramno by 1
7557 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7558 {\xeatspaces{\hash\the\paramno}}%
7559 \edef\paramlist{\paramlist\hash\the\paramno,}%
7562 \def\parsemmanyargdef@@#1,{%
7563 \if#1;\let\next=\relax
7565 \let\next=\parsemmanyargdef@@
7566 \edef\tempb{\eatspaces{#1}}%
7567 \expandafter\def\expandafter\tempa
7568 \expandafter{\csname macarg.\tempb\endcsname}%
7569 % Note that we need some extra \noexpand\noexpand, this is because we
7570 % don't want \the to be expanded in the \parsermacbody as it uses an
7572 \expandafter\edef\tempa
7573 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7574 \advance\paramno by 1\relax
7577 % These two commands read recursive and nonrecursive macro bodies.
7578 % (They're different since rec and nonrec macros end differently.)
7581 \catcode `\@\texiatcatcode
7582 \long\def\parsemacbody#1@end macro%
7583 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7584 \long\def\parsermacbody#1@end rmacro%
7585 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7586 \catcode `\@=11\relax
7591 \long\def\nillm@{\nil@}%
7593 % This macro is expanded during the Texinfo macro expansion, not during its
7594 % definition. It gets all the arguments values and assigns them to macros
7597 % #1 is the macro name
7598 % #2 is the list of argument names
7599 % #3 is the list of argument values
7600 \def\getargvals@#1#2#3{%
7601 \def\macargdeflist@{}%
7602 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7603 \def\paramlist{#2,\nil@}%
7607 \def\argvaluelist{#3,\nil@}%
7618 \ifx\paramlist\nilm@
7619 % Some sanity check needed here that \argvaluelist is also empty.
7620 \ifx\argvaluelist\nillm@
7622 \errhelp = \EMsimple
7623 \errmessage{Too many arguments in macro `\macroname'!}%
7625 \let\next\macargexpandinbody@
7627 \ifx\argvaluelist\nillm@
7628 % No more arguments values passed to macro. Set remaining named-arg
7630 \let\next\setemptyargvalues@
7632 % pop current arg name into \@tempb
7633 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7634 \expandafter\@tempa\expandafter{\paramlist}%
7635 % pop current argument value into \@tempc
7636 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7637 \expandafter\@tempa\expandafter{\argvaluelist}%
7638 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7639 % First place the new argument macro definition into \@tempd
7640 \expandafter\macname\expandafter{\@tempc}%
7641 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7642 \expandafter\def\expandafter\@tempe\expandafter{%
7643 \csname macarg.\@tempb\endcsname}%
7644 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7645 \push@\@tempd\macargdeflist@
7646 \let\next\getargvals@@
7653 \expandafter\expandafter\expandafter\def
7654 \expandafter\expandafter\expandafter#2%
7655 \expandafter\expandafter\expandafter{%
7659 % Replace arguments by their values in the macro body, and place the result
7661 \def\macvalstoargs@{%
7662 % To do this we use the property that token registers that are \the'ed
7663 % within an \edef expand only once. So we are going to place all argument
7664 % values into respective token registers.
7666 % First we save the token context, and initialize argument numbering.
7669 % Then, for each argument number #N, we place the corresponding argument
7670 % value into a new token list register \toks#N
7671 \expandafter\putargsintokens@\saveparamlist@,;,%
7672 % Then, we expand the body so that argument are replaced by their
7673 % values. The trick for values not to be expanded themselves is that they
7674 % are within tokens and that tokens expand only once in an \edef .
7675 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7676 % Now we restore the token stack pointer to free the token list registers
7677 % which we have used, but we make sure that expanded body is saved after
7681 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7684 \def\macargexpandinbody@{%
7685 %% Define the named-macro outside of this group and then close this group.
7689 % First the replace in body the macro arguments by their values, the result
7692 % Then we point at the \norecurse or \gobble (for recursive) macro value
7694 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7695 % Depending on whether it is recursive or not, we need some tailing
7702 % And now we do the real job:
7703 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7707 \def\putargsintokens@#1,{%
7708 \if#1;\let\next\relax
7710 \let\next\putargsintokens@
7711 % First we allocate the new token list register, and give it a temporary
7713 \toksdef\@tempb\the\paramno
7714 % Then we place the argument value into that token list register.
7715 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7716 \expandafter\@tempb\expandafter{\@tempa}%
7717 \advance\paramno by 1\relax
7722 % Save the token stack pointer into macro #1
7723 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7724 % Restore the token stack pointer from number in macro #1
7725 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7726 % newtoks that can be used non \outer .
7727 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7729 % Tailing missing arguments are set to empty
7730 \def\setemptyargvalues@{%
7731 \ifx\paramlist\nilm@
7732 \let\next\macargexpandinbody@
7734 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7735 \let\next\setemptyargvalues@
7740 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7741 \expandafter\def\expandafter\@tempa\expandafter{%
7742 \expandafter\def\csname macarg.#1\endcsname{}}%
7743 \push@\@tempa\macargdeflist@
7747 % #1 is the element target macro
7748 % #2 is the list macro
7749 % #3,#4\endargs@ is the list value
7750 \def\pop@#1#2#3,#4\endargs@{%
7754 \long\def\longpop@#1#2#3,#4\endargs@{%
7759 % This defines a Texinfo @macro. There are eight cases: recursive and
7760 % nonrecursive macros of zero, one, up to nine, and many arguments.
7761 % Much magic with \expandafter here.
7762 % \xdef is used so that macro definitions will survive the file
7763 % they're defined in; @include reads the file inside a group.
7766 \let\hash=##% convert placeholders to macro parameter chars
7770 \expandafter\xdef\csname\the\macname\endcsname{%
7771 \noexpand\scanmacro{\temp}}%
7773 \expandafter\xdef\csname\the\macname\endcsname{%
7774 \bgroup\noexpand\macroargctxt
7775 \noexpand\braceorline
7776 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7777 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7778 \egroup\noexpand\scanmacro{\temp}}%
7780 \ifnum\paramno<10\relax % at most 9
7781 \expandafter\xdef\csname\the\macname\endcsname{%
7782 \bgroup\noexpand\macroargctxt
7783 \noexpand\csname\the\macname xx\endcsname}%
7784 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7785 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7786 \expandafter\expandafter
7788 \expandafter\expandafter
7789 \csname\the\macname xxx\endcsname
7790 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7792 \expandafter\xdef\csname\the\macname\endcsname{%
7793 \noexpand\getargvals@{\the\macname}{\argl}%
7795 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7796 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7802 \expandafter\xdef\csname\the\macname\endcsname{%
7803 \noexpand\norecurse{\the\macname}%
7804 \noexpand\scanmacro{\temp}\egroup}%
7806 \expandafter\xdef\csname\the\macname\endcsname{%
7807 \bgroup\noexpand\macroargctxt
7808 \noexpand\braceorline
7809 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7810 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7812 \noexpand\norecurse{\the\macname}%
7813 \noexpand\scanmacro{\temp}\egroup}%
7815 \ifnum\paramno<10\relax
7816 \expandafter\xdef\csname\the\macname\endcsname{%
7817 \bgroup\noexpand\macroargctxt
7818 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7819 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7820 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7821 \expandafter\expandafter
7823 \expandafter\expandafter
7824 \csname\the\macname xxx\endcsname
7827 \noexpand\norecurse{\the\macname}%
7828 \noexpand\scanmacro{\temp}\egroup}%
7830 \expandafter\xdef\csname\the\macname\endcsname{%
7831 \noexpand\getargvals@{\the\macname}{\argl}%
7833 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7834 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7839 \catcode `\@\texiatcatcode\relax
7841 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7843 % \braceorline decides whether the next nonwhitespace character is a
7844 % {. If so it reads up to the closing }, if not, it reads the whole
7845 % line. Whatever was read is then fed to the next control sequence
7846 % as an argument (by \parsebrace or \parsearg).
7848 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7849 \def\braceorlinexxx{%
7850 \ifx\nchar\bgroup\else
7851 \expandafter\parsearg
7856 % We need some trickery to remove the optional spaces around the equal
7857 % sign. Make them active and then expand them all to nothing.
7859 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7860 \def\aliasxxx #1{\aliasyyy#1\relax}
7861 \def\aliasyyy #1=#2\relax{%
7863 \expandafter\let\obeyedspace=\empty
7864 \addtomacrolist{#1}%
7865 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7871 \message{cross references,}
7874 \newif\ifhavexrefs % True if xref values are known.
7875 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7877 % @inforef is relatively simple.
7878 \def\inforef #1{\inforefzzz #1,,,,**}
7879 \def\inforefzzz #1,#2,#3,#4**{%
7880 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7881 node \samp{\ignorespaces#1{}}}
7883 % @node's only job in TeX is to define \lastnode, which is used in
7884 % cross-references. The @node line might or might not have commas, and
7885 % might or might not have spaces before the first comma, like:
7886 % @node foo , bar , ...
7887 % We don't want such trailing spaces in the node name.
7889 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7891 % also remove a trailing comma, in case of something like this:
7892 % @node Help-Cross, , , Cross-refs
7893 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7894 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7897 \let\lastnode=\empty
7899 % Write a cross-reference definition for the current node. #1 is the
7900 % type (Ynumbered, Yappendix, Ynothing).
7903 \ifx\lastnode\empty\else
7904 \setref{\lastnode}{#1}%
7905 \global\let\lastnode=\empty
7909 % @anchor{NAME} -- define xref target at arbitrary point.
7911 \newcount\savesfregister
7913 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7914 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7915 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7917 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7918 % anchor), which consists of three parts:
7919 % 1) NAME-title - the current sectioning name taken from \lastsection,
7920 % or the anchor name.
7921 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7922 % empty for anchors.
7923 % 3) NAME-pg - the page number.
7925 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7926 % floats, there is an additional part, which is not written here:
7927 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7933 \atdummies % preserve commands, but don't expand them
7934 \edef\writexrdef##1##2{%
7935 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7936 ##1}{##2}}% these are parameters of \writexrdef
7938 \toks0 = \expandafter{\lastsection}%
7939 \immediate \writexrdef{title}{\the\toks0 }%
7940 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7941 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7946 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7947 % automatically in xrefs, if the third arg is not explicitly specified.
7948 % This was provided as a "secret" @set xref-automatic-section-title
7949 % variable, now it's official.
7951 \parseargdef\xrefautomaticsectiontitle{%
7954 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7956 \else\ifx\temp\offword
7957 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7960 \errhelp = \EMsimple
7961 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7967 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7968 % the node name, #2 the name of the Info cross-reference, #3 the printed
7969 % node name, #4 the name of the Info file, #5 the name of the printed
7970 % manual. All but the node name can be omitted.
7972 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7973 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7974 \def\ref#1{\xrefX[#1,,,,,,,]}
7977 \newbox\printedrefnamebox
7978 \newbox\infofilenamebox
7979 \newbox\printedmanualbox
7981 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7984 % Get args without leading/trailing spaces.
7985 \def\printedrefname{\ignorespaces #3}%
7986 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7988 \def\infofilename{\ignorespaces #4}%
7989 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7991 \def\printedmanual{\ignorespaces #5}%
7992 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7994 % If the printed reference name (arg #3) was not explicitly given in
7995 % the @xref, figure out what we want to use.
7996 \ifdim \wd\printedrefnamebox = 0pt
7997 % No printed node name was explicitly given.
7998 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7999 % Not auto section-title: use node name inside the square brackets.
8000 \def\printedrefname{\ignorespaces #1}%
8002 % Auto section-title: use chapter/section title inside
8003 % the square brackets if we have it.
8004 \ifdim \wd\printedmanualbox > 0pt
8005 % It is in another manual, so we don't have it; use node name.
8006 \def\printedrefname{\ignorespaces #1}%
8009 % We (should) know the real title if we have the xref values.
8010 \def\printedrefname{\refx{#1-title}{}}%
8012 % Otherwise just copy the Info node name.
8013 \def\printedrefname{\ignorespaces #1}%
8019 % Make link in pdf output.
8023 \makevalueexpandable
8024 % This expands tokens, so do it after making catcode changes, so _
8025 % etc. don't get their TeX definitions. This ignores all spaces in
8026 % #4, including (wrongly) those in the middle of the filename.
8029 % This (wrongly) does not take account of leading or trailing
8030 % spaces in #1, which should be ignored.
8031 \edef\pdfxrefdest{#1}%
8032 \ifx\pdfxrefdest\empty
8033 \def\pdfxrefdest{Top}% no empty targets
8035 \txiescapepdf\pdfxrefdest % escape PDF special chars
8039 \startlink attr{/Border [0 0 0]}%
8040 \ifnum\filenamelength>0
8041 goto file{\the\filename.pdf} name{\pdfxrefdest}%
8043 goto name{\pdfmkpgn{\pdfxrefdest}}%
8046 \setcolor{\linkcolor}%
8049 % Float references are printed completely differently: "Figure 1.2"
8050 % instead of "[somenode], p.3". We distinguish them by the
8051 % LABEL-title being set to a magic string.
8053 % Have to otherify everything special to allow the \csname to
8054 % include an _ in the xref name, etc.
8057 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8058 \csname XR#1-title\endcsname
8060 \iffloat\Xthisreftitle
8061 % If the user specified the print name (third arg) to the ref,
8062 % print it instead of our usual "Figure 1.2".
8063 \ifdim\wd\printedrefnamebox = 0pt
8069 % If the user also gave the printed manual name (fifth arg), append
8071 \ifdim \wd\printedmanualbox > 0pt
8072 \space \putwordin{} \cite{\printedmanual}%
8075 % node/anchor (non-float) references.
8077 % If we use \unhbox to print the node names, TeX does not insert
8078 % empty discretionaries after hyphens, which means that it will not
8079 % find a line break at a hyphen in a node names. Since some manuals
8080 % are best written with fairly long node names, containing hyphens,
8081 % this is a loss. Therefore, we give the text of the node name
8082 % again, so it is as if TeX is seeing it for the first time.
8084 \ifdim \wd\printedmanualbox > 0pt
8085 % Cross-manual reference with a printed manual name.
8087 \crossmanualxref{\cite{\printedmanual\unskip}}%
8089 \else\ifdim \wd\infofilenamebox > 0pt
8090 % Cross-manual reference with only an info filename (arg 4), no
8091 % printed manual name (arg 5). This is essentially the same as
8092 % the case above; we output the filename, since we have nothing else.
8094 \crossmanualxref{\code{\infofilename\unskip}}%
8097 % Reference within this manual.
8099 % _ (for example) has to be the character _ for the purposes of the
8100 % control sequence corresponding to the node, but it has to expand
8101 % into the usual \leavevmode...\vrule stuff for purposes of
8102 % printing. So we \turnoffactive for the \refx-snt, back on for the
8103 % printing, back off for the \refx-pg.
8105 % Only output a following space if the -snt ref is nonempty; for
8106 % @unnumbered and @anchor, it won't be.
8107 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8108 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8110 % output the `[mynode]' via the macro below so it can be overridden.
8111 \xrefprintnodename\printedrefname
8113 % But we always want a comma and a space:
8116 % output the `page 3'.
8117 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8123 % Output a cross-manual xref to #1. Used just above (twice).
8125 % Only include the text "Section ``foo'' in" if the foo is neither
8126 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8127 % "see The Foo Manual", the idea being to refer to the whole manual.
8129 % But, this being TeX, we can't easily compare our node name against the
8130 % string "Top" while ignoring the possible spaces before and after in
8131 % the input. By adding the arbitrary 7sp below, we make it much less
8132 % likely that a real node name would have the same width as "Top" (e.g.,
8133 % in a monospaced font). Hopefully it will never happen in practice.
8135 % For the same basic reason, we retypeset the "Top" at every
8136 % reference, since the current font is indeterminate.
8138 \def\crossmanualxref#1{%
8139 \setbox\toprefbox = \hbox{Top\kern7sp}%
8140 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8141 \ifdim \wd2 > 7sp % nonempty?
8142 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8143 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8149 % This macro is called from \xrefX for the `[nodename]' part of xref
8150 % output. It's a separate macro only so it can be changed more easily,
8151 % since square brackets don't work well in some documents. Particularly
8152 % one that Bob is working on :).
8154 \def\xrefprintnodename#1{[#1]}
8156 % Things referred to by \setref.
8162 \putwordChapter@tie \the\chapno
8163 \else \ifnum\subsecno=0
8164 \putwordSection@tie \the\chapno.\the\secno
8165 \else \ifnum\subsubsecno=0
8166 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8168 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8173 \putwordAppendix@tie @char\the\appendixno{}%
8174 \else \ifnum\subsecno=0
8175 \putwordSection@tie @char\the\appendixno.\the\secno
8176 \else \ifnum\subsubsecno=0
8177 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8180 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8184 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8185 % If its value is nonempty, SUFFIX is output afterward.
8191 \expandafter\global\expandafter\let\expandafter\thisrefX
8192 \csname XR#1\endcsname
8195 % If not defined, say something at least.
8196 \angleleft un\-de\-fined\angleright
8199 {\toks0 = {#1}% avoid expansion of possibly-complex value
8200 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8203 \global\warnedxrefstrue
8204 \message{Cross reference values unknown; you must run TeX again.}%
8209 % It's defined, so just use it.
8212 #2% Output the suffix in any case.
8215 % This is the macro invoked by entries in the aux file. Usually it's
8216 % just a \def (we prepend XR to the control sequence name to avoid
8217 % collisions). But if this is a float type, we have more work to do.
8220 {% The node name might contain 8-bit characters, which in our current
8221 % implementation are changed to commands like @'e. Don't let these
8222 % mess up the control sequence name.
8225 \xdef\safexrefname{#1}%
8228 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8230 % Was that xref control sequence that we just defined for a float?
8231 \expandafter\iffloat\csname XR\safexrefname\endcsname
8232 % it was a float, and we have the (safe) float type in \iffloattype.
8233 \expandafter\let\expandafter\floatlist
8234 \csname floatlist\iffloattype\endcsname
8236 % Is this the first time we've seen this float type?
8237 \expandafter\ifx\floatlist\relax
8238 \toks0 = {\do}% yes, so just \do
8240 % had it before, so preserve previous elements in list.
8241 \toks0 = \expandafter{\floatlist\do}%
8244 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8245 % for later use in \listoffloats.
8246 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8251 % Read the last existing aux file, if any. No error if none exists.
8254 \openin 1 \jobname.aux
8257 \global\havexrefstrue
8262 \def\setupdatafile{%
8263 \catcode`\^^@=\other
8264 \catcode`\^^A=\other
8265 \catcode`\^^B=\other
8266 \catcode`\^^C=\other
8267 \catcode`\^^D=\other
8268 \catcode`\^^E=\other
8269 \catcode`\^^F=\other
8270 \catcode`\^^G=\other
8271 \catcode`\^^H=\other
8272 \catcode`\^^K=\other
8273 \catcode`\^^L=\other
8274 \catcode`\^^N=\other
8275 \catcode`\^^P=\other
8276 \catcode`\^^Q=\other
8277 \catcode`\^^R=\other
8278 \catcode`\^^S=\other
8279 \catcode`\^^T=\other
8280 \catcode`\^^U=\other
8281 \catcode`\^^V=\other
8282 \catcode`\^^W=\other
8283 \catcode`\^^X=\other
8284 \catcode`\^^Z=\other
8285 \catcode`\^^[=\other
8286 \catcode`\^^\=\other
8287 \catcode`\^^]=\other
8288 \catcode`\^^^=\other
8289 \catcode`\^^_=\other
8290 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8291 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8292 % supported in the main text, it doesn't seem desirable. Furthermore,
8293 % that is not enough: for node names that actually contain a ^
8294 % character, we would end up writing a line like this: 'xrdef {'hat
8295 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8296 % argument, and \hat is not an expandable control sequence. It could
8297 % all be worked out, but why? Either we support ^^ or we don't.
8299 % The other change necessary for this was to define \auxhat:
8300 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8301 % and then to call \auxhat in \setq.
8305 % Special characters. Should be turned off anyway, but...
8318 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8320 % This is to support \ in node names and titles, since the \
8321 % characters end up in a \csname. It's easier than
8322 % leaving it active and making its active definition an actual \
8323 % character. What I don't understand is why it works in the *value*
8324 % of the xrdef. Seems like it should be a catcode12 \, and that
8325 % should not typeset properly. But it works, so I'm moving on for
8326 % now. --karl, 15jan04.
8329 % Make the characters 128-255 be printing characters.
8333 \catcode\count1=\other
8334 \advance\count1 by 1
8335 \ifnum \count1<256 \loop \fi
8339 % @ is our escape character in .aux files, and we need braces.
8345 \def\readdatafile#1{%
8352 \message{insertions,}
8353 % including footnotes.
8355 \newcount \footnoteno
8357 % The trailing space in the following definition for supereject is
8358 % vital for proper filling; pages come out unaligned when you do a
8359 % pagealignmacro call if that space before the closing brace is
8360 % removed. (Generally, numeric constants should always be followed by a
8361 % space to prevent strange expansion errors.)
8362 \def\supereject{\par\penalty -20000\footnoteno =0 }
8364 % @footnotestyle is meaningful for Info output only.
8365 \let\footnotestyle=\comment
8369 % Auto-number footnotes. Otherwise like plain.
8371 \let\indent=\ptexindent
8372 \let\noindent=\ptexnoindent
8374 \global\advance\footnoteno by \@ne
8375 \edef\thisfootno{$^{\the\footnoteno}$}%
8377 % In case the footnote comes at the end of a sentence, preserve the
8378 % extra spacing after we do the footnote number.
8380 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8382 % Remove inadvertent blank space before typesetting the footnote number.
8388 % Don't bother with the trickery in plain.tex to not require the
8389 % footnote text as a parameter. Our footnotes don't need to be so general.
8391 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8392 % \parseargline) fails inside footnotes because the tokens are fixed when
8393 % the footnote is read. --karl, 16nov96.
8396 \insert\footins\bgroup
8398 % Nested footnotes are not supported in TeX, that would take a lot
8399 % more work. (\startsavinginserts does not suffice.)
8400 \let\footnote=\errfootnote
8402 % We want to typeset this text as a normal paragraph, even if the
8403 % footnote reference occurs in (for example) a display environment.
8404 % So reset some parameters.
8406 \interlinepenalty\interfootnotelinepenalty
8407 \splittopskip\ht\strutbox % top baseline for broken footnotes
8408 \splitmaxdepth\dp\strutbox
8409 \floatingpenalty\@MM
8414 \parindent\defaultparindent
8418 % Because we use hanging indentation in footnotes, a @noindent appears
8419 % to exdent this text, so make it be a no-op. makeinfo does not use
8420 % hanging indentation so @noindent can still be needed within footnote
8421 % text after an @example or the like (not that this is good style).
8422 \let\noindent = \relax
8424 % Hang the footnote text off the number. Use \everypar in case the
8425 % footnote extends for more than one paragraph.
8426 \everypar = {\hang}%
8427 \textindent{\thisfootno}%
8429 % Don't crash into the line above the footnote text. Since this
8430 % expands into a box, it must come within the paragraph, lest it
8431 % provide a place where TeX can split the footnote.
8434 % Invoke rest of plain TeX footnote routine.
8435 \futurelet\next\fo@t
8437 }%end \catcode `\@=11
8441 \errmessage{Nested footnotes not supported in texinfo.tex,
8442 even though they work in makeinfo; sorry}
8445 % In case a @footnote appears in a vbox, save the footnote text and create
8446 % the real \insert just after the vbox finished. Otherwise, the insertion
8448 % Similarly, if a @footnote appears inside an alignment, save the footnote
8449 % text to a box and make the \insert when a row of the table is finished.
8450 % And the same can be done for other insert classes. --kasal, 16nov03.
8452 % Replace the \insert primitive by a cheating macro.
8453 % Deeper inside, just make sure that the saved insertions are not spilled
8456 \def\startsavinginserts{%
8457 \ifx \insert\ptexinsert
8458 \let\insert\saveinsert
8460 \let\checkinserts\relax
8464 % This \insert replacement works for both \insert\footins{foo} and
8465 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8468 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8469 \afterassignment\next
8470 % swallow the left brace
8473 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8474 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8476 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8478 \def\placesaveins#1{%
8479 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8483 % eat @SAVE -- beware, all of them have catcode \other:
8485 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8486 \gdef\gobblesave @SAVE{}
8490 \def\newsaveins #1{%
8491 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8494 \def\newsaveinsX #1{%
8495 \csname newbox\endcsname #1%
8496 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8501 \let\checkinserts\empty
8506 % @image. We use the macros from epsf.tex to support this.
8507 % If epsf.tex is not installed and @image is used, we complain.
8509 % Check for and read epsf.tex up front. If we read it only at @image
8510 % time, we might be inside a group, and then its definitions would get
8511 % undone and the next image would fail.
8512 \openin 1 = epsf.tex
8514 % Do not bother showing banner with epsf.tex v2.7k (available in
8515 % doc/epsf.tex and on ctan).
8516 \def\epsfannounce{\toks0 = }%
8521 % We will only complain once about lack of epsf.tex.
8522 \newif\ifwarnednoepsf
8523 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8524 work. It is also included in the Texinfo distribution, or you can get
8525 it from ftp://tug.org/tex/epsf.tex.}
8528 \ifx\epsfbox\thisisundefined
8529 \ifwarnednoepsf \else
8530 \errhelp = \noepsfhelp
8531 \errmessage{epsf.tex not found, images will be ignored}%
8532 \global\warnednoepsftrue
8535 \imagexxx #1,,,,,\finish
8539 % Arguments to @image:
8540 % #1 is (mandatory) image filename; we tack on .eps extension.
8541 % #2 is (optional) width, #3 is (optional) height.
8542 % #4 is (ignored optional) html alt text.
8543 % #5 is (ignored optional) extension.
8544 % #6 is just the usual extra ignored arg for parsing stuff.
8546 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8547 \catcode`\^^M = 5 % in case we're inside an example
8548 \normalturnoffactive % allow _ et al. in names
8549 % If the image is by itself, center it.
8552 \else \ifx\centersub\centerV
8553 % for @center @image, we need a vbox so we can have our vertical space
8555 \vbox\bgroup % vbox has better behavior than vtop herev
8560 % Usually we'll have text after the image which will insert
8561 % \parskip glue, so insert it here too to equalize the space
8563 \nobreak\vskip\parskip
8567 % Leave vertical mode so that indentation from an enclosing
8568 % environment such as @quotation is respected.
8569 % However, if we're at the top level, we don't want the
8570 % normal paragraph indentation.
8571 % On the other hand, if we are in the case of @center @image, we don't
8572 % want to start a paragraph, which will create a hsize-width box and
8573 % eradicate the centering.
8574 \ifx\centersub\centerV\else \noindent \fi
8578 \dopdfimage{#1}{#2}{#3}%
8580 % \epsfbox itself resets \epsf?size at each figure.
8581 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8582 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8587 \medskip % space after a standalone image
8589 \ifx\centersub\centerV \egroup \fi
8593 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8594 % etc. We don't actually implement floating yet, we always include the
8595 % float "here". But it seemed the best name for the future.
8597 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8599 % There may be a space before second and/or third parameter; delete it.
8600 \def\eatcommaspace#1, {#1,}
8602 % #1 is the optional FLOATTYPE, the text label for this float, typically
8603 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8604 % this float will not be numbered and cannot be referred to.
8606 % #2 is the optional xref label. Also must be present for the float to
8609 % #3 is the optional positioning argument; for now, it is ignored. It
8610 % will somehow specify the positions allowed to float to (here, top, bottom).
8612 % We keep a separate counter for each FLOATTYPE, which we reset at each
8613 % chapter-level command.
8614 \let\resetallfloatnos=\empty
8616 \def\dofloat#1,#2,#3,#4\finish{%
8617 \let\thiscaption=\empty
8618 \let\thisshortcaption=\empty
8620 % don't lose footnotes inside @float.
8622 % BEWARE: when the floats start float, we have to issue warning whenever an
8623 % insert appears inside a float which could possibly float. --kasal, 26may04
8627 % We can't be used inside a paragraph.
8632 \def\floatlabel{#2}%
8633 \def\floatloc{#3}% we do nothing with this yet.
8635 \ifx\floattype\empty
8636 \let\safefloattype=\empty
8639 % the floattype might have accents or other special characters,
8640 % but we need to use it in a control sequence name.
8643 \xdef\safefloattype{\floattype}%
8647 % If label is given but no type, we handle that as the empty type.
8648 \ifx\floatlabel\empty \else
8649 % We want each FLOATTYPE to be numbered separately (Figure 1,
8650 % Table 1, Figure 2, ...). (And if no label, no number.)
8652 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8653 \global\advance\floatno by 1
8656 % This magic value for \lastsection is output by \setref as the
8657 % XREFLABEL-title value. \xrefX uses it to distinguish float
8658 % labels (which have a completely different output format) from
8659 % node and anchor labels. And \xrdef uses it to construct the
8662 \edef\lastsection{\floatmagic=\safefloattype}%
8663 \setref{\floatlabel}{Yfloat}%
8667 % start with \parskip glue, I guess.
8670 % Don't suppress indentation if a float happens to start a section.
8671 \restorefirstparagraphindent
8674 % we have these possibilities:
8675 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8676 % @float Foo,lbl & no caption: Foo 1.1
8677 % @float Foo & @caption{Cap}: Foo: Cap
8678 % @float Foo & no caption: Foo
8679 % @float ,lbl & Caption{Cap}: 1.1: Cap
8680 % @float ,lbl & no caption: 1.1
8681 % @float & @caption{Cap}: Cap
8682 % @float & no caption:
8685 \let\floatident = \empty
8687 % In all cases, if we have a float type, it comes first.
8688 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8690 % If we have an xref label, the number comes next.
8691 \ifx\floatlabel\empty \else
8692 \ifx\floattype\empty \else % if also had float type, need tie first.
8693 \appendtomacro\floatident{\tie}%
8696 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8699 % Start the printed caption with what we've constructed in
8700 % \floatident, but keep it separate; we need \floatident again.
8701 \let\captionline = \floatident
8703 \ifx\thiscaption\empty \else
8704 \ifx\floatident\empty \else
8705 \appendtomacro\captionline{: }% had ident, so need a colon between
8709 \appendtomacro\captionline{\scanexp\thiscaption}%
8712 % If we have anything to print, print it, with space before.
8713 % Eventually this needs to become an \insert.
8714 \ifx\captionline\empty \else
8718 % Space below caption.
8722 % If have an xref label, write the list of floats info. Do this
8723 % after the caption, to avoid chance of it being a breakpoint.
8724 \ifx\floatlabel\empty \else
8725 % Write the text that goes in the lof to the aux file as
8726 % \floatlabel-lof. Besides \floatident, we include the short
8727 % caption if specified, else the full caption if specified, else nothing.
8731 % since we read the caption text in the macro world, where ^^M
8732 % is turned into a normal character, we have to scan it back, so
8733 % we don't write the literal three characters "^^M" into the aux file.
8735 \xdef\noexpand\gtemp{%
8736 \ifx\thisshortcaption\empty
8743 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8744 \ifx\gtemp\empty \else : \gtemp \fi}}%
8747 \egroup % end of \vtop
8749 % place the captured inserts
8751 % BEWARE: when the floats start floating, we have to issue warning
8752 % whenever an insert appears inside a float which could possibly
8753 % float. --kasal, 26may04
8758 % Append the tokens #2 to the definition of macro #1, not expanding either.
8760 \def\appendtomacro#1#2{%
8761 \expandafter\def\expandafter#1\expandafter{#1#2}%
8764 % @caption, @shortcaption
8766 \def\caption{\docaption\thiscaption}
8767 \def\shortcaption{\docaption\thisshortcaption}
8768 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8769 \def\defcaption#1#2{\egroup \def#1{#2}}
8771 % The parameter is the control sequence identifying the counter we are
8772 % going to use. Create it if it doesn't exist and assign it to \floatno.
8775 % Haven't seen this figure type before.
8776 \csname newcount\endcsname #1%
8778 % Remember to reset this floatno at the next chap.
8779 \expandafter\gdef\expandafter\resetallfloatnos
8780 \expandafter{\resetallfloatnos #1=0 }%
8785 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8786 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8787 % first read the @float command.
8789 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8791 % Magic string used for the XREFLABEL-title value, so \xrefX can
8792 % distinguish floats from other xref types.
8793 \def\floatmagic{!!float!!}
8795 % #1 is the control sequence we are passed; we expand into a conditional
8796 % which is true if #1 represents a float ref. That is, the magic
8797 % \lastsection value which we \setref above.
8799 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8801 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8802 % (safe) float type for this float. We set \iffloattype to #2.
8804 \def\doiffloat#1=#2=#3\finish{%
8806 \def\iffloattype{#2}%
8807 \ifx\temp\floatmagic
8810 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8812 \parseargdef\listoffloats{%
8813 \def\floattype{#1}% floattype
8815 % the floattype might have accents or other special characters,
8816 % but we need to use it in a control sequence name.
8819 \xdef\safefloattype{\floattype}%
8822 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8823 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8825 % if the user said @listoffloats foo but never @float foo.
8826 \message{\linenumber No `\safefloattype' floats to list.}%
8830 \leftskip=\tocindent % indent these entries like a toc
8831 \let\do=\listoffloatsdo
8832 \csname floatlist\safefloattype\endcsname
8837 % This is called on each entry in a list of floats. We're passed the
8838 % xref label, in the form LABEL-title, which is how we save it in the
8839 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8840 % has the text we're supposed to typeset here.
8842 % Figures without xref labels will not be included in the list (since
8843 % they won't appear in the aux file).
8845 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8846 \def\listoffloatsdoentry#1-title\finish{{%
8847 % Can't fully expand XR#1-lof because it can contain anything. Just
8848 % pass the control sequence. On the other hand, XR#1-pg is just the
8849 % page number, and we want to fully expand that so we can get a link
8851 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8853 % use the same \entry macro we use to generate the TOC and index.
8854 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8859 \message{localization,}
8861 % For single-language documents, @documentlanguage is usually given very
8862 % early, just after @documentencoding. Single argument is the language
8863 % (de) or locale (de_DE) abbreviation.
8866 \catcode`\_ = \active
8868 \parseargdef\documentlanguage{%
8869 \tex % read txi-??.tex file in plain TeX.
8870 % Read the file by the name they passed if it exists.
8871 \let_ = \normalunderscore % normal _ character for filename test
8872 \openin 1 txi-#1.tex
8874 \documentlanguagetrywithoutunderscore #1_\finish
8876 \globaldefs = 1 % everything in the txi-LL files needs to persist
8880 \endgroup % end raw TeX
8883 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8886 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8887 \openin 1 txi-#1.tex
8889 \errhelp = \nolanghelp
8890 \errmessage{Cannot read language file txi-#1.tex}%
8892 \globaldefs = 1 % everything in the txi-LL files needs to persist
8897 }% end of special _ catcode
8899 \newhelp\nolanghelp{The given language definition file cannot be found or
8900 is empty. Maybe you need to install it? Putting it in the current
8901 directory should work if nowhere else does.}
8903 % This macro is called from txi-??.tex files; the first argument is the
8904 % \language name to set (without the "\lang@" prefix), the second and
8905 % third args are \{left,right}hyphenmin.
8907 % The language names to pass are determined when the format is built.
8908 % See the etex.log file created at that time, e.g.,
8909 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8911 % With TeX Live 2008, etex now includes hyphenation patterns for all
8912 % available languages. This means we can support hyphenation in
8913 % Texinfo, at least to some extent. (This still doesn't solve the
8914 % accented characters problem.)
8917 \def\txisetlanguage#1#2#3{%
8918 % do not set the language if the name is undefined in the current TeX.
8919 \expandafter\ifx\csname lang@#1\endcsname \relax
8920 \message{no patterns for #1}%
8922 \global\language = \csname lang@#1\endcsname
8924 % but there is no harm in adjusting the hyphenmin values regardless.
8925 \global\lefthyphenmin = #2\relax
8926 \global\righthyphenmin = #3\relax
8929 % Helpers for encodings.
8930 % Set the catcode of characters 128 through 255 to the specified number.
8932 \def\setnonasciicharscatcode#1{%
8934 \loop\ifnum\count255<256
8935 \global\catcode\count255=#1\relax
8936 \advance\count255 by 1
8940 \def\setnonasciicharscatcodenonglobal#1{%
8942 \loop\ifnum\count255<256
8943 \catcode\count255=#1\relax
8944 \advance\count255 by 1
8948 % @documentencoding sets the definition of non-ASCII characters
8949 % according to the specified encoding.
8951 \parseargdef\documentencoding{%
8952 % Encoding being declared for the document.
8953 \def\declaredencoding{\csname #1.enc\endcsname}%
8955 % Supported encodings: names converted to tokens in order to be able
8956 % to compare them with \ifx.
8957 \def\ascii{\csname US-ASCII.enc\endcsname}%
8958 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8959 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8960 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8961 \def\utfeight{\csname UTF-8.enc\endcsname}%
8963 \ifx \declaredencoding \ascii
8966 \else \ifx \declaredencoding \lattwo
8967 \setnonasciicharscatcode\active
8970 \else \ifx \declaredencoding \latone
8971 \setnonasciicharscatcode\active
8974 \else \ifx \declaredencoding \latnine
8975 \setnonasciicharscatcode\active
8978 \else \ifx \declaredencoding \utfeight
8979 \setnonasciicharscatcode\active
8983 \message{Unknown document encoding #1, ignoring.}%
8992 % A message to be logged when using a character that isn't available
8993 % the default font encoding (OT1).
8995 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8997 % Take account of \c (plain) vs. \, (Texinfo) difference.
8998 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9000 % First, make active non-ASCII characters in order for them to be
9001 % correctly categorized when TeX reads the replacement text of
9002 % macros containing the character definitions.
9003 \setnonasciicharscatcode\active
9005 % Latin1 (ISO-8859-1) character definitions.
9006 \def\latonechardefs{%
9008 \gdef^^a1{\exclamdown}
9009 \gdef^^a2{\missingcharmsg{CENT SIGN}}
9010 \gdef^^a3{{\pounds}}
9011 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9012 \gdef^^a5{\missingcharmsg{YEN SIGN}}
9013 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
9016 \gdef^^a9{\copyright}
9018 \gdef^^ab{\guillemetleft}
9021 \gdef^^ae{\registeredsymbol}
9024 \gdef^^b0{\textdegree}
9033 \gdef^^b8{\cedilla\ }
9037 \gdef^^bb{\guillemetright}
9038 \gdef^^bc{$1\over4$}
9039 \gdef^^bd{$1\over2$}
9040 \gdef^^be{$3\over4$}
9041 \gdef^^bf{\questiondown}
9048 \gdef^^c5{\ringaccent A}
9050 \gdef^^c7{\cedilla C}
9082 \gdef^^e5{\ringaccent a}
9084 \gdef^^e7{\cedilla c}
9089 \gdef^^ec{\`{\dotless i}}
9090 \gdef^^ed{\'{\dotless i}}
9091 \gdef^^ee{\^{\dotless i}}
9092 \gdef^^ef{\"{\dotless i}}
9112 % Latin9 (ISO-8859-15) encoding character definitions.
9113 \def\latninechardefs{%
9114 % Encoding is almost identical to Latin1.
9127 % Latin2 (ISO-8859-2) character definitions.
9128 \def\lattwochardefs{%
9130 \gdef^^a1{\ogonek{A}}
9133 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9139 \gdef^^aa{\cedilla S}
9144 \gdef^^af{\dotaccent Z}
9146 \gdef^^b0{\textdegree}
9147 \gdef^^b1{\ogonek{a}}
9148 \gdef^^b2{\ogonek{ }}
9154 \gdef^^b8{\cedilla\ }
9156 \gdef^^ba{\cedilla s}
9161 \gdef^^bf{\dotaccent z}
9170 \gdef^^c7{\cedilla C}
9173 \gdef^^ca{\ogonek{E}}
9189 \gdef^^d9{\ringaccent U}
9194 \gdef^^de{\cedilla T}
9204 \gdef^^e7{\cedilla c}
9207 \gdef^^ea{\ogonek{e}}
9210 \gdef^^ed{\'{\dotless{i}}}
9211 \gdef^^ee{\^{\dotless{i}}}
9223 \gdef^^f9{\ringaccent u}
9228 \gdef^^fe{\cedilla t}
9229 \gdef^^ff{\dotaccent{}}
9232 % UTF-8 character definitions.
9234 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9235 % changes for Texinfo conventions. It is included here under the GPL by
9236 % permission from Frank Mittelbach and the LaTeX team.
9242 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9243 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9245 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9246 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9248 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9249 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9251 \gdef\UTFviiiDefined#1{%
9253 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9264 \global\catcode\countUTFx\active
9265 \uccode`\~\countUTFx
9266 \uppercase\expandafter{\UTFviiiTmp}%
9267 \advance\countUTFx by 1
9268 \ifnum\countUTFx < \countUTFy
9269 \expandafter\UTFviiiLoop
9275 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9281 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9287 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9300 \gdef\DeclareUnicodeCharacter#1#2{%
9301 \countUTFz = "#1\relax
9302 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9305 \def\UTFviiiTwoOctets##1##2{%
9306 \csname u8:##1\string ##2\endcsname}%
9307 \def\UTFviiiThreeOctets##1##2##3{%
9308 \csname u8:##1\string ##2\string ##3\endcsname}%
9309 \def\UTFviiiFourOctets##1##2##3##4{%
9310 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9311 \expandafter\expandafter\expandafter\expandafter
9312 \expandafter\expandafter\expandafter
9313 \gdef\UTFviiiTmp{#2}%
9316 \gdef\parseXMLCharref{%
9317 \ifnum\countUTFz < "A0\relax
9318 \errhelp = \EMsimple
9319 \errmessage{Cannot define Unicode char value < 00A0}%
9320 \else\ifnum\countUTFz < "800\relax
9322 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9323 \else\ifnum\countUTFz < "10000\relax
9326 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9331 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9335 \gdef\parseUTFviiiA#1{%
9336 \countUTFx = \countUTFz
9337 \divide\countUTFz by 64
9338 \countUTFy = \countUTFz
9339 \multiply\countUTFz by 64
9340 \advance\countUTFx by -\countUTFz
9341 \advance\countUTFx by 128
9342 \uccode `#1\countUTFx
9343 \countUTFz = \countUTFy}
9345 \gdef\parseUTFviiiB#1#2#3#4{%
9346 \advance\countUTFz by "#10\relax
9347 \uccode `#3\countUTFz
9348 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9351 \def\utfeightchardefs{%
9352 \DeclareUnicodeCharacter{00A0}{\tie}
9353 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9354 \DeclareUnicodeCharacter{00A3}{\pounds}
9355 \DeclareUnicodeCharacter{00A8}{\"{ }}
9356 \DeclareUnicodeCharacter{00A9}{\copyright}
9357 \DeclareUnicodeCharacter{00AA}{\ordf}
9358 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9359 \DeclareUnicodeCharacter{00AD}{\-}
9360 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9361 \DeclareUnicodeCharacter{00AF}{\={ }}
9363 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9364 \DeclareUnicodeCharacter{00B4}{\'{ }}
9365 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9366 \DeclareUnicodeCharacter{00BA}{\ordm}
9367 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9368 \DeclareUnicodeCharacter{00BF}{\questiondown}
9370 \DeclareUnicodeCharacter{00C0}{\`A}
9371 \DeclareUnicodeCharacter{00C1}{\'A}
9372 \DeclareUnicodeCharacter{00C2}{\^A}
9373 \DeclareUnicodeCharacter{00C3}{\~A}
9374 \DeclareUnicodeCharacter{00C4}{\"A}
9375 \DeclareUnicodeCharacter{00C5}{\AA}
9376 \DeclareUnicodeCharacter{00C6}{\AE}
9377 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9378 \DeclareUnicodeCharacter{00C8}{\`E}
9379 \DeclareUnicodeCharacter{00C9}{\'E}
9380 \DeclareUnicodeCharacter{00CA}{\^E}
9381 \DeclareUnicodeCharacter{00CB}{\"E}
9382 \DeclareUnicodeCharacter{00CC}{\`I}
9383 \DeclareUnicodeCharacter{00CD}{\'I}
9384 \DeclareUnicodeCharacter{00CE}{\^I}
9385 \DeclareUnicodeCharacter{00CF}{\"I}
9387 \DeclareUnicodeCharacter{00D0}{\DH}
9388 \DeclareUnicodeCharacter{00D1}{\~N}
9389 \DeclareUnicodeCharacter{00D2}{\`O}
9390 \DeclareUnicodeCharacter{00D3}{\'O}
9391 \DeclareUnicodeCharacter{00D4}{\^O}
9392 \DeclareUnicodeCharacter{00D5}{\~O}
9393 \DeclareUnicodeCharacter{00D6}{\"O}
9394 \DeclareUnicodeCharacter{00D8}{\O}
9395 \DeclareUnicodeCharacter{00D9}{\`U}
9396 \DeclareUnicodeCharacter{00DA}{\'U}
9397 \DeclareUnicodeCharacter{00DB}{\^U}
9398 \DeclareUnicodeCharacter{00DC}{\"U}
9399 \DeclareUnicodeCharacter{00DD}{\'Y}
9400 \DeclareUnicodeCharacter{00DE}{\TH}
9401 \DeclareUnicodeCharacter{00DF}{\ss}
9403 \DeclareUnicodeCharacter{00E0}{\`a}
9404 \DeclareUnicodeCharacter{00E1}{\'a}
9405 \DeclareUnicodeCharacter{00E2}{\^a}
9406 \DeclareUnicodeCharacter{00E3}{\~a}
9407 \DeclareUnicodeCharacter{00E4}{\"a}
9408 \DeclareUnicodeCharacter{00E5}{\aa}
9409 \DeclareUnicodeCharacter{00E6}{\ae}
9410 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9411 \DeclareUnicodeCharacter{00E8}{\`e}
9412 \DeclareUnicodeCharacter{00E9}{\'e}
9413 \DeclareUnicodeCharacter{00EA}{\^e}
9414 \DeclareUnicodeCharacter{00EB}{\"e}
9415 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9416 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9417 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9418 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9420 \DeclareUnicodeCharacter{00F0}{\dh}
9421 \DeclareUnicodeCharacter{00F1}{\~n}
9422 \DeclareUnicodeCharacter{00F2}{\`o}
9423 \DeclareUnicodeCharacter{00F3}{\'o}
9424 \DeclareUnicodeCharacter{00F4}{\^o}
9425 \DeclareUnicodeCharacter{00F5}{\~o}
9426 \DeclareUnicodeCharacter{00F6}{\"o}
9427 \DeclareUnicodeCharacter{00F8}{\o}
9428 \DeclareUnicodeCharacter{00F9}{\`u}
9429 \DeclareUnicodeCharacter{00FA}{\'u}
9430 \DeclareUnicodeCharacter{00FB}{\^u}
9431 \DeclareUnicodeCharacter{00FC}{\"u}
9432 \DeclareUnicodeCharacter{00FD}{\'y}
9433 \DeclareUnicodeCharacter{00FE}{\th}
9434 \DeclareUnicodeCharacter{00FF}{\"y}
9436 \DeclareUnicodeCharacter{0100}{\=A}
9437 \DeclareUnicodeCharacter{0101}{\=a}
9438 \DeclareUnicodeCharacter{0102}{\u{A}}
9439 \DeclareUnicodeCharacter{0103}{\u{a}}
9440 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9441 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9442 \DeclareUnicodeCharacter{0106}{\'C}
9443 \DeclareUnicodeCharacter{0107}{\'c}
9444 \DeclareUnicodeCharacter{0108}{\^C}
9445 \DeclareUnicodeCharacter{0109}{\^c}
9446 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9447 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9448 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9449 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9450 \DeclareUnicodeCharacter{010C}{\v{C}}
9451 \DeclareUnicodeCharacter{010D}{\v{c}}
9452 \DeclareUnicodeCharacter{010E}{\v{D}}
9454 \DeclareUnicodeCharacter{0112}{\=E}
9455 \DeclareUnicodeCharacter{0113}{\=e}
9456 \DeclareUnicodeCharacter{0114}{\u{E}}
9457 \DeclareUnicodeCharacter{0115}{\u{e}}
9458 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9459 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9460 \DeclareUnicodeCharacter{011A}{\v{E}}
9461 \DeclareUnicodeCharacter{011B}{\v{e}}
9462 \DeclareUnicodeCharacter{011C}{\^G}
9463 \DeclareUnicodeCharacter{011D}{\^g}
9464 \DeclareUnicodeCharacter{011E}{\u{G}}
9465 \DeclareUnicodeCharacter{011F}{\u{g}}
9467 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9468 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9469 \DeclareUnicodeCharacter{0124}{\^H}
9470 \DeclareUnicodeCharacter{0125}{\^h}
9471 \DeclareUnicodeCharacter{0128}{\~I}
9472 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9473 \DeclareUnicodeCharacter{012A}{\=I}
9474 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9475 \DeclareUnicodeCharacter{012C}{\u{I}}
9476 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9478 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9479 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9480 \DeclareUnicodeCharacter{0132}{IJ}
9481 \DeclareUnicodeCharacter{0133}{ij}
9482 \DeclareUnicodeCharacter{0134}{\^J}
9483 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9484 \DeclareUnicodeCharacter{0139}{\'L}
9485 \DeclareUnicodeCharacter{013A}{\'l}
9487 \DeclareUnicodeCharacter{0141}{\L}
9488 \DeclareUnicodeCharacter{0142}{\l}
9489 \DeclareUnicodeCharacter{0143}{\'N}
9490 \DeclareUnicodeCharacter{0144}{\'n}
9491 \DeclareUnicodeCharacter{0147}{\v{N}}
9492 \DeclareUnicodeCharacter{0148}{\v{n}}
9493 \DeclareUnicodeCharacter{014C}{\=O}
9494 \DeclareUnicodeCharacter{014D}{\=o}
9495 \DeclareUnicodeCharacter{014E}{\u{O}}
9496 \DeclareUnicodeCharacter{014F}{\u{o}}
9498 \DeclareUnicodeCharacter{0150}{\H{O}}
9499 \DeclareUnicodeCharacter{0151}{\H{o}}
9500 \DeclareUnicodeCharacter{0152}{\OE}
9501 \DeclareUnicodeCharacter{0153}{\oe}
9502 \DeclareUnicodeCharacter{0154}{\'R}
9503 \DeclareUnicodeCharacter{0155}{\'r}
9504 \DeclareUnicodeCharacter{0158}{\v{R}}
9505 \DeclareUnicodeCharacter{0159}{\v{r}}
9506 \DeclareUnicodeCharacter{015A}{\'S}
9507 \DeclareUnicodeCharacter{015B}{\'s}
9508 \DeclareUnicodeCharacter{015C}{\^S}
9509 \DeclareUnicodeCharacter{015D}{\^s}
9510 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9511 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9513 \DeclareUnicodeCharacter{0160}{\v{S}}
9514 \DeclareUnicodeCharacter{0161}{\v{s}}
9515 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9516 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9517 \DeclareUnicodeCharacter{0164}{\v{T}}
9519 \DeclareUnicodeCharacter{0168}{\~U}
9520 \DeclareUnicodeCharacter{0169}{\~u}
9521 \DeclareUnicodeCharacter{016A}{\=U}
9522 \DeclareUnicodeCharacter{016B}{\=u}
9523 \DeclareUnicodeCharacter{016C}{\u{U}}
9524 \DeclareUnicodeCharacter{016D}{\u{u}}
9525 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9526 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9528 \DeclareUnicodeCharacter{0170}{\H{U}}
9529 \DeclareUnicodeCharacter{0171}{\H{u}}
9530 \DeclareUnicodeCharacter{0174}{\^W}
9531 \DeclareUnicodeCharacter{0175}{\^w}
9532 \DeclareUnicodeCharacter{0176}{\^Y}
9533 \DeclareUnicodeCharacter{0177}{\^y}
9534 \DeclareUnicodeCharacter{0178}{\"Y}
9535 \DeclareUnicodeCharacter{0179}{\'Z}
9536 \DeclareUnicodeCharacter{017A}{\'z}
9537 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9538 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9539 \DeclareUnicodeCharacter{017D}{\v{Z}}
9540 \DeclareUnicodeCharacter{017E}{\v{z}}
9542 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9543 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9544 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9545 \DeclareUnicodeCharacter{01C7}{LJ}
9546 \DeclareUnicodeCharacter{01C8}{Lj}
9547 \DeclareUnicodeCharacter{01C9}{lj}
9548 \DeclareUnicodeCharacter{01CA}{NJ}
9549 \DeclareUnicodeCharacter{01CB}{Nj}
9550 \DeclareUnicodeCharacter{01CC}{nj}
9551 \DeclareUnicodeCharacter{01CD}{\v{A}}
9552 \DeclareUnicodeCharacter{01CE}{\v{a}}
9553 \DeclareUnicodeCharacter{01CF}{\v{I}}
9555 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9556 \DeclareUnicodeCharacter{01D1}{\v{O}}
9557 \DeclareUnicodeCharacter{01D2}{\v{o}}
9558 \DeclareUnicodeCharacter{01D3}{\v{U}}
9559 \DeclareUnicodeCharacter{01D4}{\v{u}}
9561 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9562 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9563 \DeclareUnicodeCharacter{01E6}{\v{G}}
9564 \DeclareUnicodeCharacter{01E7}{\v{g}}
9565 \DeclareUnicodeCharacter{01E8}{\v{K}}
9566 \DeclareUnicodeCharacter{01E9}{\v{k}}
9568 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9569 \DeclareUnicodeCharacter{01F1}{DZ}
9570 \DeclareUnicodeCharacter{01F2}{Dz}
9571 \DeclareUnicodeCharacter{01F3}{dz}
9572 \DeclareUnicodeCharacter{01F4}{\'G}
9573 \DeclareUnicodeCharacter{01F5}{\'g}
9574 \DeclareUnicodeCharacter{01F8}{\`N}
9575 \DeclareUnicodeCharacter{01F9}{\`n}
9576 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9577 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9578 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9579 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9581 \DeclareUnicodeCharacter{021E}{\v{H}}
9582 \DeclareUnicodeCharacter{021F}{\v{h}}
9584 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9585 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9586 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9587 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9588 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9589 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9591 \DeclareUnicodeCharacter{0232}{\=Y}
9592 \DeclareUnicodeCharacter{0233}{\=y}
9593 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9595 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9597 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9598 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9599 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9600 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9601 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9602 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9603 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9604 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9605 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9606 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9607 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9608 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9610 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9611 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9613 \DeclareUnicodeCharacter{1E20}{\=G}
9614 \DeclareUnicodeCharacter{1E21}{\=g}
9615 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9616 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9617 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9618 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9619 \DeclareUnicodeCharacter{1E26}{\"H}
9620 \DeclareUnicodeCharacter{1E27}{\"h}
9622 \DeclareUnicodeCharacter{1E30}{\'K}
9623 \DeclareUnicodeCharacter{1E31}{\'k}
9624 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9625 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9626 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9627 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9628 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9629 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9630 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9631 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9632 \DeclareUnicodeCharacter{1E3E}{\'M}
9633 \DeclareUnicodeCharacter{1E3F}{\'m}
9635 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9636 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9637 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9638 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9639 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9640 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9641 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9642 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9643 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9644 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9646 \DeclareUnicodeCharacter{1E54}{\'P}
9647 \DeclareUnicodeCharacter{1E55}{\'p}
9648 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9649 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9650 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9651 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9652 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9653 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9654 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9655 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9657 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9658 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9659 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9660 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9661 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9662 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9663 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9664 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9665 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9666 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9668 \DeclareUnicodeCharacter{1E7C}{\~V}
9669 \DeclareUnicodeCharacter{1E7D}{\~v}
9670 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9671 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9673 \DeclareUnicodeCharacter{1E80}{\`W}
9674 \DeclareUnicodeCharacter{1E81}{\`w}
9675 \DeclareUnicodeCharacter{1E82}{\'W}
9676 \DeclareUnicodeCharacter{1E83}{\'w}
9677 \DeclareUnicodeCharacter{1E84}{\"W}
9678 \DeclareUnicodeCharacter{1E85}{\"w}
9679 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9680 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9681 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9682 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9683 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9684 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9685 \DeclareUnicodeCharacter{1E8C}{\"X}
9686 \DeclareUnicodeCharacter{1E8D}{\"x}
9687 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9688 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9690 \DeclareUnicodeCharacter{1E90}{\^Z}
9691 \DeclareUnicodeCharacter{1E91}{\^z}
9692 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9693 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9694 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9695 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9696 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9697 \DeclareUnicodeCharacter{1E97}{\"t}
9698 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9699 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9701 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9702 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9704 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9705 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9706 \DeclareUnicodeCharacter{1EBC}{\~E}
9707 \DeclareUnicodeCharacter{1EBD}{\~e}
9709 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9710 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9711 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9712 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9714 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9715 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9717 \DeclareUnicodeCharacter{1EF2}{\`Y}
9718 \DeclareUnicodeCharacter{1EF3}{\`y}
9719 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9721 \DeclareUnicodeCharacter{1EF8}{\~Y}
9722 \DeclareUnicodeCharacter{1EF9}{\~y}
9724 \DeclareUnicodeCharacter{2013}{--}
9725 \DeclareUnicodeCharacter{2014}{---}
9726 \DeclareUnicodeCharacter{2018}{\quoteleft}
9727 \DeclareUnicodeCharacter{2019}{\quoteright}
9728 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9729 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9730 \DeclareUnicodeCharacter{201D}{\quotedblright}
9731 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9732 \DeclareUnicodeCharacter{2022}{\bullet}
9733 \DeclareUnicodeCharacter{2026}{\dots}
9734 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9735 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9736 \DeclareUnicodeCharacter{20AC}{\euro}
9738 \DeclareUnicodeCharacter{2192}{\expansion}
9739 \DeclareUnicodeCharacter{21D2}{\result}
9741 \DeclareUnicodeCharacter{2212}{\minus}
9742 \DeclareUnicodeCharacter{2217}{\point}
9743 \DeclareUnicodeCharacter{2261}{\equiv}
9744 }% end of \utfeightchardefs
9747 % US-ASCII character definitions.
9748 \def\asciichardefs{% nothing need be done
9752 % Make non-ASCII characters printable again for compatibility with
9753 % existing Texinfo documents that may use them, even without declaring a
9754 % document encoding.
9756 \setnonasciicharscatcode \other
9759 \message{formatting,}
9761 \newdimen\defaultparindent \defaultparindent = 15pt
9763 \chapheadingskip = 15pt plus 4pt minus 2pt
9764 \secheadingskip = 12pt plus 3pt minus 2pt
9765 \subsecheadingskip = 9pt plus 2pt minus 2pt
9767 % Prevent underfull vbox error messages.
9770 % Don't be very finicky about underfull hboxes, either.
9773 % Following George Bush, get rid of widows and orphans.
9777 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9778 % using an old version of TeX, don't do anything. We want the amount of
9779 % stretch added to depend on the line length, hence the dependence on
9780 % \hsize. We call this whenever the paper size is set.
9782 \def\setemergencystretch{%
9783 \ifx\emergencystretch\thisisundefined
9784 % Allow us to assign to \emergencystretch anyway.
9785 \def\emergencystretch{\dimen0}%
9787 \emergencystretch = .15\hsize
9791 % Parameters in order: 1) textheight; 2) textwidth;
9792 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9793 % 7) physical page height; 8) physical page width.
9795 % We also call \setleading{\textleading}, so the caller should define
9796 % \textleading. The caller should also set \parskip.
9798 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9801 \splittopskip = \topskip
9804 \advance\vsize by \topskip
9805 \outervsize = \vsize
9806 \advance\outervsize by 2\topandbottommargin
9807 \pageheight = \vsize
9810 \outerhsize = \hsize
9811 \advance\outerhsize by 0.5in
9814 \normaloffset = #4\relax
9815 \bindingoffset = #5\relax
9818 \pdfpageheight #7\relax
9819 \pdfpagewidth #8\relax
9820 % if we don't reset these, they will remain at "1 true in" of
9821 % whatever layout pdftex was dumped with.
9822 \pdfhorigin = 1 true in
9823 \pdfvorigin = 1 true in
9826 \setleading{\textleading}
9828 \parindent = \defaultparindent
9829 \setemergencystretch
9832 % @letterpaper (the default).
9833 \def\letterpaper{{\globaldefs = 1
9834 \parskip = 3pt plus 2pt minus 1pt
9835 \textleading = 13.2pt
9837 % If page is nothing but text, make it come out even.
9838 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9840 {\bindingoffset}{36pt}%
9844 % Use @smallbook to reset parameters for 7x9.25 trim size.
9845 \def\smallbook{{\globaldefs = 1
9846 \parskip = 2pt plus 1pt
9849 \internalpagesizes{7.5in}{5in}%
9851 {\bindingoffset}{16pt}%
9854 \lispnarrowing = 0.3in
9857 \contentsrightmargin = 0pt
9858 \defbodyindent = .5cm
9861 % Use @smallerbook to reset parameters for 6x9 trim size.
9862 % (Just testing, parameters still in flux.)
9863 \def\smallerbook{{\globaldefs = 1
9864 \parskip = 1.5pt plus 1pt
9867 \internalpagesizes{7.4in}{4.8in}%
9872 \lispnarrowing = 0.25in
9875 \contentsrightmargin = 0pt
9876 \defbodyindent = .4cm
9879 % Use @afourpaper to print on European A4 paper.
9880 \def\afourpaper{{\globaldefs = 1
9881 \parskip = 3pt plus 2pt minus 1pt
9882 \textleading = 13.2pt
9884 % Double-side printing via postscript on Laserjet 4050
9885 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9886 % To change the settings for a different printer or situation, adjust
9887 % \normaloffset until the front-side and back-side texts align. Then
9888 % do the same for \bindingoffset. You can set these for testing in
9889 % your texinfo source file like this:
9891 % \global\normaloffset = -6mm
9892 % \global\bindingoffset = 10mm
9894 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9895 {\voffset}{\hoffset}%
9896 {\bindingoffset}{44pt}%
9901 \contentsrightmargin = 0pt
9902 \defbodyindent = 5mm
9905 % Use @afivepaper to print on European A5 paper.
9906 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9907 % He also recommends making @example and @lisp be small.
9908 \def\afivepaper{{\globaldefs = 1
9909 \parskip = 2pt plus 1pt minus 0.1pt
9910 \textleading = 12.5pt
9912 \internalpagesizes{160mm}{120mm}%
9913 {\voffset}{\hoffset}%
9914 {\bindingoffset}{8pt}%
9917 \lispnarrowing = 0.2in
9920 \contentsrightmargin = 0pt
9921 \defbodyindent = 2mm
9925 % A specific text layout, 24x15cm overall, intended for A4 paper.
9926 \def\afourlatex{{\globaldefs = 1
9928 \internalpagesizes{237mm}{150mm}%
9930 {\bindingoffset}{7mm}%
9933 % Must explicitly reset to 0 because we call \afourpaper.
9937 % Use @afourwide to print on A4 paper in landscape format.
9938 \def\afourwide{{\globaldefs = 1
9940 \internalpagesizes{241mm}{165mm}%
9941 {\voffset}{-2.95mm}%
9942 {\bindingoffset}{7mm}%
9947 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9948 % Perhaps we should allow setting the margins, \topskip, \parskip,
9949 % and/or leading, also. Or perhaps we should compute them somehow.
9951 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9952 \def\pagesizesyyy#1,#2,#3\finish{{%
9953 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9956 \parskip = 3pt plus 2pt minus 1pt
9957 \setleading{\textleading}%
9960 \advance\dimen0 by \voffset
9963 \advance\dimen2 by \normaloffset
9965 \internalpagesizes{#1}{\hsize}%
9966 {\voffset}{\normaloffset}%
9967 {\bindingoffset}{44pt}%
9971 % Set default to letter.
9976 \message{and turning on texinfo input format.}
9978 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9980 % DEL is a comment character, in case @c does not suffice.
9983 % Define macros to output various characters with catcode for normal text.
9984 \catcode`\"=\other \def\normaldoublequote{"}
9985 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9986 \catcode`\+=\other \def\normalplus{+}
9987 \catcode`\<=\other \def\normalless{<}
9988 \catcode`\>=\other \def\normalgreater{>}
9989 \catcode`\^=\other \def\normalcaret{^}
9990 \catcode`\_=\other \def\normalunderscore{_}
9991 \catcode`\|=\other \def\normalverticalbar{|}
9992 \catcode`\~=\other \def\normaltilde{~}
9994 % This macro is used to make a character print one way in \tt
9995 % (where it can probably be output as-is), and another way in other fonts,
9996 % where something hairier probably needs to be done.
9998 % #1 is what to print if we are indeed using \tt; #2 is what to print
9999 % otherwise. Since all the Computer Modern typewriter fonts have zero
10000 % interword stretch (and shrink), and it is reasonable to expect all
10001 % typewriter fonts to have this, we can check that font parameter.
10003 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
10005 % Same as above, but check for italic font. Actually this also catches
10006 % non-italic slanted fonts since it is impossible to distinguish them from
10007 % italic fonts. But since this is only used by $ and it uses \sl anyway
10008 % this is not a problem.
10009 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
10011 % Turn off all special characters except @
10012 % (and those which the user can use as if they were ordinary).
10013 % Most of these we simply print from the \tt font, but for some, we can
10014 % use math or other variants that look better in normal text.
10016 \catcode`\"=\active
10017 \def\activedoublequote{{\tt\char34}}
10018 \let"=\activedoublequote
10019 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
10021 \catcode`\^=\active \def\activehat{{\tt \hat}} \let^ = \activehat
10023 \catcode`\_=\active
10024 \def_{\ifusingtt\normalunderscore\_}
10026 % Subroutine for the previous macro.
10027 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
10029 \catcode`\|=\active
10030 \def|{{\tt\char124}}
10033 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
10035 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
10036 \catcode`\+=\active \def+{{\tt \char 43}}
10037 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
10039 % used for headline/footline in the output routine, in case the page
10040 % breaks in the middle of an @tex block.
10041 \def\texinfochars{%
10042 \let< = \activeless
10044 \let~ = \activetilde
10046 \markupsetuplqdefault \markupsetuprqdefault
10048 \let\i = \smartitalic
10049 % in principle, all other definitions in \tex have to be undone too.
10052 % If a .fmt file is being used, characters that might appear in a file
10053 % name cannot be active until we have parsed the command line.
10054 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10055 % \otherifyactive is called near the end of this file.
10056 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
10058 % Used sometimes to turn off (effectively) the active characters even after
10060 \def\turnoffactive{%
10061 \normalturnoffactive
10067 % \backslashcurfont outputs one backslash character in current font,
10069 \global\chardef\backslashcurfont=`\\
10070 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
10072 % \realbackslash is an actual character `\' with catcode other, and
10073 % \doublebackslash is two of them (for the pdf outlines).
10074 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
10076 % In texinfo, backslash is an active character; it prints the backslash
10077 % in fixed width font.
10078 \catcode`\\=\active % @ for escape char from now on.
10080 % The story here is that in math mode, the \char of \backslashcurfont
10081 % ends up printing the roman \ from the math symbol font (because \char
10082 % in math mode uses the \mathcode, and plain.tex sets
10083 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10084 % print a typewriter backslash, hence we use an explicit \mathchar,
10085 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10086 % ignored family value; char position "5C). We can't use " for the
10087 % usual hex value because it has already been made active.
10088 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10089 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10091 % On startup, @fixbackslash assigns:
10092 % @let \ = @normalbackslash
10093 % \rawbackslash defines an active \ to do \backslashcurfont.
10094 % \otherbackslash defines an active \ to be a literal `\' character with
10095 % catcode other. We switch back and forth between these.
10096 @gdef@rawbackslash{@let\=@backslashcurfont}
10097 @gdef@otherbackslash{@let\=@realbackslash}
10099 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10100 % the literal character `\'. Also revert - to its normal character, in
10101 % case the active - from code has slipped in.
10103 {@catcode`- = @active
10104 @gdef@normalturnoffactive{%
10106 @let"=@normaldoublequote
10107 @let$=@normaldollar %$ font-lock fix
10110 @let>=@normalgreater
10111 @let\=@normalbackslash
10113 @let_=@normalunderscore
10114 @let|=@normalverticalbar
10116 @markupsetuplqdefault
10117 @markupsetuprqdefault
10122 % Make _ and + \other characters, temporarily.
10123 % This is canceled by @fixbackslash.
10126 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10127 % That is what \eatinput is for; after that, the `\' should revert to printing
10130 @gdef@eatinput input texinfo{@fixbackslash}
10131 @global@let\ = @eatinput
10133 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10134 % the first `\' in the file would cause an error. This macro tries to fix
10135 % that, assuming it is called before the first `\' could plausibly occur.
10136 % Also turn back on active characters that might appear in the input
10137 % file name, in case not using a pre-dumped format.
10139 @gdef@fixbackslash{%
10140 @ifx\@eatinput @let\ = @normalbackslash @fi
10142 @catcode`@_=@active
10145 % Say @foo, not \foo, in error messages.
10148 % These (along with & and #) are made active for url-breaking, so need
10149 % active definitions as the normal characters.
10151 @def@normalquest{?}
10152 @def@normalslash{/}
10154 % These look ok in all fonts, so just make them not special.
10155 % @hashchar{} gets its own user-level command, because of #line.
10156 @catcode`@& = @other @def@normalamp{&}
10157 @catcode`@# = @other @def@normalhash{#}
10158 @catcode`@% = @other @def@normalpercent{%}
10160 @let @hashchar = @normalhash
10162 @c Finally, make ` and ' active, so that txicodequoteundirected and
10163 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10164 @c don't make ` and ' active, @code will not get them as active chars.
10165 @c Do this last of all since we use ` in the previous @catcode assignments.
10166 @catcode`@'=@active
10167 @catcode`@`=@active
10168 @markupsetuplqdefault
10169 @markupsetuprqdefault
10171 @c Local variables:
10172 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10173 @c page-delimiter: "^\\\\message"
10174 @c time-stamp-start: "def\\\\texinfoversion{"
10175 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10176 @c time-stamp-end: "}"
10182 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115