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{2015-08-21.13}
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, 2015
11 % Free Software Foundation, Inc.
13 % This texinfo.tex file is free software: you can redistribute it and/or
14 % modify it under the terms of the GNU General Public License as
15 % published by the Free Software Foundation, either version 3 of the
16 % License, or (at your option) any later version.
18 % This texinfo.tex file is distributed in the hope that it will be
19 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
20 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 % General Public License for more details.
23 % You should have received a copy of the GNU General Public License
24 % along with this program. If not, see <http://www.gnu.org/licenses/>.
26 % As a special exception, when this file is read by TeX when processing
27 % a Texinfo source document, you may use the result without
28 % restriction. This Exception is an additional permission under section 7
29 % of the GNU General Public License, version 3 ("GPLv3").
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
34 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
35 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
76 % Save some plain tex macros whose names we will redefine.
78 \let\ptexbullet=\bullet
86 \let\ptexfootnote=\footnote
90 \let\ptexindent=\indent
91 \let\ptexinsert=\insert
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=\noindent
97 \let\ptexraggedright=\raggedright
105 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
107 % If this character appears in an error message or help string, it
108 % starts a new line in the output.
111 % Use TeX 3.0's \inputlineno to get the line number, for better error
112 % messages, but if we're using an old version of TeX, don't do anything.
114 \ifx\inputlineno\thisisundefined
115 \let\linenumber = \empty % Pre-3.0.
117 \def\linenumber{l.\the\inputlineno:\space}
120 % Set up fixed words for English if not already set.
121 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
122 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
123 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
124 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
125 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
126 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
127 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
128 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
129 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
130 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
131 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
132 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
133 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
134 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
135 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
136 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
137 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
138 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
139 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
140 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
142 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
143 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
144 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
145 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
146 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
147 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
148 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
149 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
150 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
151 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
152 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
153 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
155 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
156 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
157 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
158 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
159 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
161 % Since the category of space is not known, we have to be careful.
162 \chardef\spacecat = 10
163 \def\spaceisspace{\catcode`\ =\spacecat}
165 % sometimes characters are active, so we need control sequences.
166 \chardef\ampChar = `\&
167 \chardef\colonChar = `\:
168 \chardef\commaChar = `\,
169 \chardef\dashChar = `\-
170 \chardef\dotChar = `\.
171 \chardef\exclamChar= `\!
172 \chardef\hashChar = `\#
173 \chardef\lquoteChar= `\`
174 \chardef\questChar = `\?
175 \chardef\rquoteChar= `\'
176 \chardef\semiChar = `\;
177 \chardef\slashChar = `\/
178 \chardef\underChar = `\_
184 % The following is used inside several \edef's.
185 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
189 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
190 ap-pen-dix bit-map bit-maps
191 data-base data-bases eshell fall-ing half-way long-est man-u-script
192 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
193 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
195 stand-alone strong-est time-stamp time-stamps which-ever white-space
196 wide-spread wrap-around
199 % Margin to add to right of even pages, to left of odd pages.
200 \newdimen\bindingoffset
201 \newdimen\normaloffset
202 \newdimen\pagewidth \newdimen\pageheight
204 % For a final copy, take out the rectangles
205 % that mark overfull boxes (in case you have decided
206 % that the text looks ok even though it passes the margin).
208 \def\finalout{\overfullrule=0pt }
210 % Sometimes it is convenient to have everything in the transcript file
211 % and nothing on the terminal. We don't just call \tracingall here,
212 % since that produces some useless output on the terminal. We also make
213 % some effort to order the tracing commands to reduce output in the log
214 % file; cf. trace.sty in LaTeX.
216 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
220 \tracinglostchars2 % 2 gives us more in etex
225 \showboxbreadth\maxdimen \showboxdepth\maxdimen
226 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
233 \tracingcommands3 % 3 gives us more in etex
237 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
238 % aren't perfect, it's not the end of the world, being an error message,
241 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
242 \def\doerrormsg#1{\errmessage{#1}}
244 % add check for \lastpenalty to plain's definitions. If the last thing
245 % we did was a \nobreak, we don't want to insert more space.
247 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
248 \removelastskip\penalty-50\smallskip\fi\fi}
249 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
250 \removelastskip\penalty-100\medskip\fi\fi}
251 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
252 \removelastskip\penalty-200\bigskip\fi\fi}
254 % Do @cropmarks to get crop marks.
257 \let\cropmarks = \cropmarkstrue
259 % Dimensions to add cropmarks at corners.
260 % Added by P. A. MacKay, 12 Nov. 1986
262 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
263 \newdimen\cornerlong \cornerlong=1pc
264 \newdimen\cornerthick \cornerthick=.3pt
265 \newdimen\topandbottommargin \topandbottommargin=.75in
267 % Output a mark which sets \thischapter, \thissection and \thiscolor.
268 % We dump everything together because we only have one kind of mark.
269 % This works because we only use \botmark / \topmark, not \firstmark.
271 % A mark contains a subexpression of the \ifcase ... \fi construct.
272 % \get*marks macros below extract the needed part using \ifcase.
274 % Another complication is to let the user choose whether \thischapter
275 % (\thissection) refers to the chapter (section) in effect at the top
276 % of a page, or that at the bottom of a page. The solution is
277 % described on page 260 of The TeXbook. It involves outputting two
278 % marks for the sectioning macros, one before the section break, and
279 % one after. I won't pretend I can describe this better than DEK...
282 \toks0=\expandafter{\lastchapterdefs}%
283 \toks2=\expandafter{\lastsectiondefs}%
284 \toks4=\expandafter{\prevchapterdefs}%
285 \toks6=\expandafter{\prevsectiondefs}%
286 \toks8=\expandafter{\lastcolordefs}%
288 \the\toks0 \the\toks2 % 0: top marks (\last...)
289 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
290 \noexpand\else \the\toks8 % 2: color marks
293 % \topmark doesn't work for the very first chapter (after the title
294 % page or the contents), so we use \firstmark there -- this gets us
295 % the mark with the chapter defs, unless the user sneaks in, e.g.,
296 % @setcolor (or @url, or @link, etc.) between @contents and the very
298 \def\gettopheadingmarks{%
300 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
302 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
303 \def\getcolormarks{\ifcase2\topmark\fi}
305 % Avoid "undefined control sequence" errors.
306 \def\lastchapterdefs{}
307 \def\lastsectiondefs{}
309 \def\prevchapterdefs{}
310 \def\prevsectiondefs{}
313 % Main output routine.
315 \output = {\onepageout{\pagecontents\PAGE}}
320 % \onepageout takes a vbox as an argument. Note that \pagecontents
321 % does insertions, but you have to call it yourself.
323 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
325 \ifodd\pageno \advance\hoffset by \bindingoffset
326 \else \advance\hoffset by -\bindingoffset\fi
328 % Do this outside of the \shipout so @code etc. will be expanded in
329 % the headline as they should be, not taken literally (outputting ''code).
330 \def\commmonheadfootline{\let\hsize=\pagewidth \texinfochars}
332 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
333 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
335 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
336 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
339 % Have to do this stuff outside the \shipout because we want it to
340 % take effect in \write's, yet the group defined by the \vbox ends
341 % before the \shipout runs.
343 \indexdummies % don't expand commands in the output.
344 \normalturnoffactive % \ in index entries must not stay \, e.g., if
345 % the page break happens to be in the middle of an example.
346 % We don't want .vr (or whatever) entries like this:
347 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
348 % "\acronym" won't work when it's read back in;
350 % {\code {{\tt \backslashcurfont }acronym}
352 % Do this early so pdf references go to the beginning of the page.
353 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
355 \ifcropmarks \vbox to \outervsize\bgroup
357 \vskip-\topandbottommargin
359 \line{\ewtop\hfil\ewtop}%
362 \vbox{\moveleft\cornerthick\nstop}%
364 \vbox{\moveright\cornerthick\nstop}%
367 \vskip\topandbottommargin
369 \hfil % center the page within the outer (page) hsize.
370 \ifodd\pageno\hskip\bindingoffset\fi
376 \ifdim\ht\footlinebox > 0pt
377 % Only leave this space if the footline is nonempty.
378 % (We lessened \vsize for it in \oddfootingyyy.)
379 % The \baselineskip=24pt in plain's \makefootline has no effect.
385 \egroup % end of \vbox\bgroup
386 \hfil\egroup % end of (centering) \line\bgroup
387 \vskip\topandbottommargin plus1fill minus1fill
388 \boxmaxdepth = \cornerthick
391 \vbox{\moveleft\cornerthick\nsbot}%
393 \vbox{\moveright\cornerthick\nsbot}%
396 \line{\ewbot\hfil\ewbot}%
398 \egroup % \vbox from first cropmarks clause
400 }% end of \shipout\vbox
401 }% end of group with \indexdummies
403 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
406 \newinsert\margin \dimen\margin=\maxdimen
408 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
410 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
411 % marginal hacks, juha@viisa.uucp (Juha Takala)
412 \ifvoid\margin\else % marginal info is present
413 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
414 \dimen@=\dp#1\relax \unvbox#1\relax
415 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
416 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
419 % Here are the rules for the cropmarks. Note that they are
420 % offset so that the space between them is truly \outerhsize or \outervsize
421 % (P. A. MacKay, 12 November, 1986)
423 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
425 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
426 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
428 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
433 % Parse an argument, then pass it to #1. The argument is the rest of
434 % the input line (except we remove a trailing comment). #1 should be a
435 % macro which expects an ordinary undelimited TeX argument.
436 % For example, \def\foo{\parsearg\fooxxx}.
438 \def\parsearg{\parseargusing{}}
439 \def\parseargusing#1#2{%
445 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
449 \gdef\parseargline#1^^M{%
450 \endgroup % End of the group started in \parsearg.
451 \argremovecomment #1\comment\ArgTerm%
455 % First remove any @comment, then any @c comment. Also remove a @texinfoc
456 % comment (see \scanmacro for details). Pass the result on to \argcheckspaces.
457 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
458 \def\argremovec#1\c#2\ArgTerm{\argremovetexinfoc #1\texinfoc\ArgTerm}
459 \def\argremovetexinfoc#1\texinfoc#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
461 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
463 % \argremovec might leave us with trailing space, e.g.,
464 % @end itemize @c foo
465 % This space token undergoes the same procedure and is eventually removed
466 % by \finishparsearg.
468 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
469 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
470 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
473 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
474 \let\temp\finishparsearg
476 \let\temp\argcheckspaces
478 % Put the space token in:
482 % If a _delimited_ argument is enclosed in braces, they get stripped; so
483 % to get _exactly_ the rest of the line, we had to prevent such situation.
484 % We prepended an \empty token at the very beginning and we expand it now,
485 % just before passing the control to \argtorun.
486 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
487 % either the null string, or it ends with \^^M---thus there is no danger
488 % that a pair of braces would be stripped.
490 % But first, we have to remove the trailing space token.
492 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
494 % \parseargdef\foo{...}
495 % is roughly equivalent to
496 % \def\foo{\parsearg\Xfoo}
499 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
500 % favourite TeX trick. --kasal, 16nov03
503 \expandafter \doparseargdef \csname\string#1\endcsname #1%
505 \def\doparseargdef#1#2{%
510 % Several utility definitions with active space:
515 % Make each space character in the input produce a normal interword
516 % space in the output. Don't allow a line break at this space, as this
517 % is used only in environments like @example, where each line of input
518 % should produce a line of output anyway.
520 \gdef\sepspaces{\obeyspaces\let =\tie}
522 % If an index command is used in an @example environment, any spaces
523 % therein should become regular spaces in the raw index file, not the
524 % expansion of \tie (\leavevmode \penalty \@M \ ).
525 \gdef\unsepspaces{\let =\space}
529 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
531 % Define the framework for environments in texinfo.tex. It's used like this:
536 % It's the responsibility of \envdef to insert \begingroup before the
537 % actual body; @end closes the group after calling \Efoo. \envdef also
538 % defines \thisenv, so the current environment is known; @end checks
539 % whether the environment name matches. The \checkenv macro can also be
540 % used to check whether the current environment is the one expected.
542 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
543 % are not treated as environments; they don't open a group. (The
544 % implementation of @end takes care not to call \endgroup in this
548 % At run-time, environments start with this:
549 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
553 % ... but they get defined via ``\envdef\foo{...}'':
554 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
555 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
557 % Check whether we're in the right environment:
566 % Environment mismatch, #1 expected:
569 \errmessage{This command can appear only \inenvironment\temp,
570 not \inenvironment\thisenv}%
572 \def\inenvironment#1{%
574 outside of any environment%
576 in environment \expandafter\string#1%
580 % @end foo executes the definition of \Efoo.
581 % But first, it executes a specialized version of \checkenv
584 \if 1\csname iscond.#1\endcsname
586 % The general wording of \badenverr may not be ideal.
587 \expandafter\checkenv\csname#1\endcsname
588 \csname E#1\endcsname
593 \newhelp\EMsimple{Press RETURN to continue.}
596 % Be sure we're in horizontal mode when doing a tie, since we make space
597 % equivalent to this in @example-like environments. Otherwise, a space
598 % at the beginning of a line will start with \penalty -- and
599 % since \penalty is valid in vertical mode, we'd end up putting the
600 % penalty on the vertical list instead of in the new paragraph.
602 % Avoid using \@M directly, because that causes trouble
603 % if the definition is written into an index file.
604 \global\let\tiepenalty = \@M
605 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
608 % @: forces normal size whitespace following.
609 \def\:{\spacefactor=1000 }
611 % @* forces a line break.
612 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
614 % @/ allows a line break.
617 % @. is an end-of-sentence period.
618 \def\.{.\spacefactor=\endofsentencespacefactor\space}
620 % @! is an end-of-sentence bang.
621 \def\!{!\spacefactor=\endofsentencespacefactor\space}
623 % @? is an end-of-sentence query.
624 \def\?{?\spacefactor=\endofsentencespacefactor\space}
626 % @frenchspacing on|off says whether to put extra space after punctuation.
631 \parseargdef\frenchspacing{%
633 \ifx\temp\onword \plainfrenchspacing
634 \else\ifx\temp\offword \plainnonfrenchspacing
637 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
641 % @w prevents a word break. Without the \leavevmode, @w at the
642 % beginning of a paragraph, when TeX is still in vertical mode, would
643 % produce a whole line of output instead of starting the paragraph.
644 \def\w#1{\leavevmode\hbox{#1}}
646 % @group ... @end group forces ... to be all on one page, by enclosing
647 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
648 % to keep its height that of a normal line. According to the rules for
649 % \topskip (p.114 of the TeXbook), the glue inserted is
650 % max (\topskip - \ht (first item), 0). If that height is large,
651 % therefore, no glue is inserted, and the space between the headline and
652 % the text is small, which looks bad.
654 % Another complication is that the group might be very large. This can
655 % cause the glue on the previous page to be unduly stretched, because it
656 % does not have much material. In this case, it's better to add an
657 % explicit \vfill so that the extra space is at the bottom. The
658 % threshold for doing this is if the group is more than \vfilllimit
659 % percent of a page (\vfilllimit can be changed inside of @tex).
665 \ifnum\catcode`\^^M=\active \else
666 \errhelp = \groupinvalidhelp
667 \errmessage{@group invalid in context where filling is enabled}%
671 \setbox\groupbox = \vtop\bgroup
672 % Do @comment since we are called inside an environment such as
673 % @example, where each end-of-line in the input causes an
674 % end-of-line in the output. We don't want the end-of-line after
675 % the `@group' to put extra space in the output. Since @group
676 % should appear on a line by itself (according to the Texinfo
677 % manual), we don't worry about eating any user text.
681 % The \vtop produces a box with normal height and large depth; thus, TeX puts
682 % \baselineskip glue before it, and (when the next line of text is done)
683 % \lineskip glue after it. Thus, space below is not quite equal to space
684 % above. But it's pretty close.
686 % To get correct interline space between the last line of the group
687 % and the first line afterwards, we have to propagate \prevdepth.
688 \endgraf % Not \par, as it may have been set to \lisppar.
689 \global\dimen1 = \prevdepth
690 \egroup % End the \vtop.
691 % \dimen0 is the vertical size of the group's box.
692 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
693 % \dimen2 is how much space is left on the page (more or less).
694 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
695 % if the group doesn't fit on the current page, and it's a big big
696 % group, force a page break.
697 \ifdim \dimen0 > \dimen2
698 \ifdim \pagetotal < \vfilllimit\pageheight
707 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
708 % message, so this ends up printing `@group can only ...'.
710 \newhelp\groupinvalidhelp{%
711 group can only be used in environments such as @example,^^J%
712 where each line of input produces a line of output.}
714 % @need space-in-mils
715 % forces a page break if there is not space-in-mils remaining.
717 \newdimen\mil \mil=0.001in
720 % Ensure vertical mode, so we don't make a big box in the middle of a
724 % If the @need value is less than one line space, it's useless.
726 \dimen2 = \ht\strutbox
727 \advance\dimen2 by \dp\strutbox
728 \ifdim\dimen0 > \dimen2
730 % Do a \strut just to make the height of this box be normal, so the
731 % normal leading is inserted relative to the preceding line.
732 % And a page break here is fine.
733 \vtop to #1\mil{\strut\vfil}%
735 % TeX does not even consider page breaks if a penalty added to the
736 % main vertical list is 10000 or more. But in order to see if the
737 % empty box we just added fits on the page, we must make it consider
738 % page breaks. On the other hand, we don't want to actually break the
739 % page after the empty box. So we use a penalty of 9999.
741 % There is an extremely small chance that TeX will actually break the
742 % page at this \penalty, if there are no other feasible breakpoints in
743 % sight. (If the user is using lots of big @group commands, which
744 % almost-but-not-quite fill up a page, TeX will have a hard time doing
745 % good page breaking, for example.) However, I could not construct an
746 % example where a page broke at this \penalty; if it happens in a real
747 % document, then we can reconsider our strategy.
750 % Back up by the size of the box, whether we did a page break or not.
753 % Do not allow a page break right after this kern.
758 % @br forces paragraph break (and is undocumented).
762 % @page forces the start of a new page.
764 \def\page{\par\vfill\supereject}
767 % outputs text on separate line in roman font, starting at standard page margin
769 % This records the amount of indent in the innermost environment.
770 % That's how much \exdent should take out.
771 \newskip\exdentamount
773 % This defn is used inside fill environments such as @defun.
774 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
776 % This defn is used inside nofill environments such as @example.
777 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
778 \leftline{\hskip\leftskip{\rm#1}}}}
780 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
781 % paragraph. For more general purposes, use the \margin insertion
782 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
784 \newskip\inmarginspacing \inmarginspacing=1cm
785 \def\strutdepth{\dp\strutbox}
787 \def\doinmargin#1#2{\strut\vadjust{%
790 \vtop to \strutdepth{%
791 \baselineskip=\strutdepth
793 % if you have multiple lines of stuff to put here, you'll need to
794 % make the vbox yourself of the appropriate size.
796 \llap{\ignorespaces #2\hskip\inmarginspacing}%
798 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
803 \def\inleftmargin{\doinmargin l}
804 \def\inrightmargin{\doinmargin r}
806 % @inmargin{TEXT [, RIGHT-TEXT]}
807 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
808 % else use TEXT for both).
810 \def\inmargin#1{\parseinmargin #1,,\finish}
811 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
812 \setbox0 = \hbox{\ignorespaces #2}%
814 \def\lefttext{#1}% have both texts
817 \def\lefttext{#1}% have only one text
822 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
824 \def\temp{\inleftmargin\lefttext}%
829 % @| inserts a changebar to the left of the current line. It should
830 % surround any changed text. This approach does *not* work if the
831 % change spans more than two lines of output. To handle that, we would
832 % have adopt a much more difficult approach (putting marks into the main
833 % vertical list for the beginning and end of each change). This command
834 % is not documented, not supported, and doesn't work.
837 % \vadjust can only be used in horizontal mode.
840 % Append this vertical mode material after the current line in the output.
842 % We want to insert a rule with the height and depth of the current
843 % leading; that is exactly what \strutbox is supposed to record.
846 % \vadjust-items are inserted at the left edge of the type. So
847 % the \llap here moves out into the left-hand margin.
850 % For a thicker or thinner bar, change the `1pt'.
851 \vrule height\baselineskip width1pt
853 % This is the space between the bar and the text.
859 % @include FILE -- \input text of FILE.
861 \def\include{\parseargusing\filenamecatcodes\includezzz}
866 \makevalueexpandable % we want to expand any @value in FILE.
867 \turnoffactive % and allow special characters in the expansion
868 \indexnofonts % Allow `@@' and other weird things in file names.
869 \wlog{texinfo.tex: doing @include of #1^^J}%
870 \edef\temp{\noexpand\input #1 }%
872 % This trickery is to read FILE outside of a group, in case it makes
878 \def\filenamecatcodes{%
892 \def\pushthisfilestack{%
893 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
895 \def\pushthisfilestackX{%
896 \expandafter\pushthisfilestackY\thisfile\StackTerm
898 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
899 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
902 \def\popthisfilestack{\errthisfilestackempty}
903 \def\errthisfilestackempty{\errmessage{Internal error:
904 the stack of filenames is empty.}}
909 % outputs that line, centered.
911 \parseargdef\center{%
913 \let\centersub\centerH
915 \let\centersub\centerV
917 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
918 \let\centersub\relax % don't let the definition persist, just in case
922 \advance\hsize by -\leftskip
923 \advance\hsize by -\rightskip
928 \newcount\centerpenalty
930 % The idea here is the same as in \startdefun, \cartouche, etc.: if
931 % @center is the first thing after a section heading, we need to wipe
932 % out the negative parskip inserted by \sectionheading, but still
933 % prevent a page break here.
934 \centerpenalty = \lastpenalty
935 \ifnum\centerpenalty>10000 \vskip\parskip \fi
936 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
937 \line{\kern\leftskip #1\kern\rightskip}%
940 % @sp n outputs n lines of vertical space
942 \parseargdef\sp{\vskip #1\baselineskip}
944 % @comment ...line which is ignored...
945 % @c is the same as @comment
946 % @ignore ... @end ignore is another way to write a comment
948 \def\comment{\begingroup \catcode`\^^M=\active%
949 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other\commentxxx}%
951 {\catcode`\^^M=\active%
952 \gdef\commentxxx#1^^M{\endgroup%
953 \futurelet\nexttoken\commentxxxx}%
954 \gdef\commentxxxx{\ifx\nexttoken\aftermacro\expandafter\comment\fi}%
957 \def\c{\begingroup \catcode`\^^M=\active%
958 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
960 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
961 % See comment in \scanmacro about why the definitions of @c and @comment differ
963 % @paragraphindent NCHARS
964 % We'll use ems for NCHARS, close enough.
965 % NCHARS can also be the word `asis' or `none'.
966 % We cannot feasibly implement @paragraphindent asis, though.
968 \def\asisword{asis} % no translation, these are keywords
971 \parseargdef\paragraphindent{%
976 \defaultparindent = 0pt
978 \defaultparindent = #1em
981 \parindent = \defaultparindent
984 % @exampleindent NCHARS
985 % We'll use ems for NCHARS like @paragraphindent.
986 % It seems @exampleindent asis isn't necessary, but
987 % I preserve it to make it similar to @paragraphindent.
988 \parseargdef\exampleindent{%
995 \lispnarrowing = #1em
1000 % @firstparagraphindent WORD
1001 % If WORD is `none', then suppress indentation of the first paragraph
1002 % after a section heading. If WORD is `insert', then do indent at such
1005 % The paragraph indentation is suppressed or not by calling
1006 % \suppressfirstparagraphindent, which the sectioning commands do.
1007 % We switch the definition of this back and forth according to WORD.
1008 % By default, we suppress indentation.
1010 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1011 \def\insertword{insert}
1013 \parseargdef\firstparagraphindent{%
1016 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1017 \else\ifx\temp\insertword
1018 \let\suppressfirstparagraphindent = \relax
1020 \errhelp = \EMsimple
1021 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1025 % Here is how we actually suppress indentation. Redefine \everypar to
1026 % \kern backwards by \parindent, and then reset itself to empty.
1028 % We also make \indent itself not actually do anything until the next
1031 \gdef\dosuppressfirstparagraphindent{%
1032 \gdef\indent {\restorefirstparagraphindent \indent}%
1033 \gdef\noindent{\restorefirstparagraphindent \noindent}%
1034 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
1037 \gdef\restorefirstparagraphindent{%
1038 \global\let\indent = \ptexindent
1039 \global\let\noindent = \ptexnoindent
1040 \global\everypar = {}%
1044 % @refill is a no-op.
1047 % If working on a large document in chapters, it is convenient to
1048 % be able to disable indexing, cross-referencing, and contents, for test runs.
1049 % This is done with @novalidate (before @setfilename).
1051 \newif\iflinks \linkstrue % by default we want the aux files.
1052 \let\novalidate = \linksfalse
1054 % @setfilename is done at the beginning of every texinfo file.
1055 % So open here the files we need to have open while reading the input.
1056 % This makes it possible to make a .fmt file for texinfo.
1058 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1061 % Open the new aux file. TeX will close it automatically at exit.
1062 \immediate\openout\auxfile=\jobname.aux
1063 \fi % \openindices needs to do some work in any case.
1065 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1067 % If texinfo.cnf is present on the system, read it.
1068 % Useful for site-wide @afourpaper, etc.
1069 \openin 1 texinfo.cnf
1070 \ifeof 1 \else \input texinfo.cnf \fi
1073 \comment % Ignore the actual filename.
1076 % Called from \setfilename.
1088 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1092 % adobe `portable' document format
1096 \newcount\filenamelength
1105 \newif\ifpdfmakepagedest
1107 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1108 % can be set). So we test for \relax and 0 as well as being undefined.
1109 \ifx\pdfoutput\thisisundefined
1111 \ifx\pdfoutput\relax
1120 % PDF uses PostScript string constants for the names of xref targets,
1121 % for display in the outlines, and in other places. Thus, we have to
1122 % double any backslashes. Otherwise, a name like "\node" will be
1123 % interpreted as a newline (\n), followed by o, d, e. Not good.
1125 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1126 % related messages. The final outcome is that it is up to the TeX user
1127 % to double the backslashes and otherwise make the string valid, so
1128 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1129 % do this reliably, so we use it.
1131 % #1 is a control sequence in which to do the replacements,
1133 \def\txiescapepdf#1{%
1134 \ifx\pdfescapestring\thisisundefined
1135 % No primitive available; should we give a warning or log?
1136 % Many times it won't matter.
1138 % The expandable \pdfescapestring primitive escapes parentheses,
1139 % backslashes, and other special chars.
1140 \xdef#1{\pdfescapestring{#1}}%
1144 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1145 with PDF output, and none of those formats could be found. (.eps cannot
1146 be supported due to the design of the PDF format; use regular TeX (DVI
1151 % Color manipulation macros using ideas from pdfcolor.tex,
1152 % except using rgb instead of cmyk; the latter is said to render as a
1153 % very dark gray on-screen and a very dark halftone in print, instead
1154 % of actual black. The dark red here is dark enough to print on paper as
1155 % nearly black, but still distinguishable for online viewing. We use
1156 % black by default, though.
1157 \def\rgbDarkRed{0.50 0.09 0.12}
1158 \def\rgbBlack{0 0 0}
1160 % k sets the color for filling (usual text, etc.);
1161 % K sets the color for stroking (thin rules, e.g., normal _'s).
1162 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1164 % Set color, and create a mark which defines \thiscolor accordingly,
1165 % so that \makeheadline knows which color to restore.
1167 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1172 \def\maincolor{\rgbBlack}
1173 \pdfsetcolor{\maincolor}
1174 \edef\thiscolor{\maincolor}
1175 \def\lastcolordefs{}
1179 \line{\pdfsetcolor{\maincolor}\the\footline}%
1187 % Extract \thiscolor definition from the marks.
1189 % Typeset the headline with \maincolor, then restore the color.
1190 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1198 \pdfcatalog{/PageMode /UseOutlines}
1200 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1201 \def\dopdfimage#1#2#3{%
1202 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1203 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1205 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1206 % others). Let's try in that order, PDF first since if
1207 % someone has a scalable image, presumably better to use that than a
1209 \let\pdfimgext=\empty
1211 \openin 1 #1.pdf \ifeof 1
1212 \openin 1 #1.PDF \ifeof 1
1213 \openin 1 #1.png \ifeof 1
1214 \openin 1 #1.jpg \ifeof 1
1215 \openin 1 #1.jpeg \ifeof 1
1216 \openin 1 #1.JPG \ifeof 1
1217 \errhelp = \nopdfimagehelp
1218 \errmessage{Could not find image file #1 for pdf}%
1219 \else \gdef\pdfimgext{JPG}%
1221 \else \gdef\pdfimgext{jpeg}%
1223 \else \gdef\pdfimgext{jpg}%
1225 \else \gdef\pdfimgext{png}%
1227 \else \gdef\pdfimgext{PDF}%
1229 \else \gdef\pdfimgext{pdf}%
1234 % without \immediate, ancient pdftex seg faults when the same image is
1235 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1236 \ifnum\pdftexversion < 14
1239 \immediate\pdfximage
1241 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1242 \ifdim \wd2 >0pt height \pdfimageheight \fi
1243 \ifnum\pdftexversion<13
1248 \ifnum\pdftexversion < 14 \else
1249 \pdfrefximage \pdflastximage
1253 % We have to set dummies so commands such as @code, and characters
1254 % such as \, aren't expanded when present in a section title.
1257 \makevalueexpandable
1258 \def\pdfdestname{#1}%
1259 \txiescapepdf\pdfdestname
1260 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1263 % used to mark target names; must be expandable.
1266 % by default, use black for everything.
1267 \def\urlcolor{\rgbBlack}
1268 \def\linkcolor{\rgbBlack}
1269 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1271 % Adding outlines to PDF; macros for calculating structure of outlines
1272 % come from Petr Olsak
1273 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1274 \else \csname#1\endcsname \fi}
1275 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1276 \advance\tempnum by 1
1277 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1279 % #1 is the section text, which is what will be displayed in the
1280 % outline by the pdf viewer. #2 is the pdf expression for the number
1281 % of subentries (or empty, for subsubsections). #3 is the node text,
1282 % which might be empty if this toc entry had no corresponding node.
1283 % #4 is the page number
1285 \def\dopdfoutline#1#2#3#4{%
1286 % Generate a link to the node text if that exists; else, use the
1287 % page number. We could generate a destination for the section
1288 % text in the case where a section has no node, but it doesn't
1289 % seem worth the trouble, since most documents are normally structured.
1290 \edef\pdfoutlinedest{#3}%
1291 \ifx\pdfoutlinedest\empty
1292 \def\pdfoutlinedest{#4}%
1294 \txiescapepdf\pdfoutlinedest
1297 % Also escape PDF chars in the display string.
1298 \edef\pdfoutlinetext{#1}%
1299 \txiescapepdf\pdfoutlinetext
1301 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1304 \def\pdfmakeoutlines{%
1306 % Read toc silently, to get counts of subentries for \pdfoutline.
1307 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1308 \def\numchapentry##1##2##3##4{%
1309 \def\thischapnum{##2}%
1311 \def\thissubsecnum{0}%
1313 \def\numsecentry##1##2##3##4{%
1314 \advancenumber{chap\thischapnum}%
1315 \def\thissecnum{##2}%
1316 \def\thissubsecnum{0}%
1318 \def\numsubsecentry##1##2##3##4{%
1319 \advancenumber{sec\thissecnum}%
1320 \def\thissubsecnum{##2}%
1322 \def\numsubsubsecentry##1##2##3##4{%
1323 \advancenumber{subsec\thissubsecnum}%
1325 \def\thischapnum{0}%
1327 \def\thissubsecnum{0}%
1329 % use \def rather than \let here because we redefine \chapentry et
1330 % al. a second time, below.
1331 \def\appentry{\numchapentry}%
1332 \def\appsecentry{\numsecentry}%
1333 \def\appsubsecentry{\numsubsecentry}%
1334 \def\appsubsubsecentry{\numsubsubsecentry}%
1335 \def\unnchapentry{\numchapentry}%
1336 \def\unnsecentry{\numsecentry}%
1337 \def\unnsubsecentry{\numsubsecentry}%
1338 \def\unnsubsubsecentry{\numsubsubsecentry}%
1341 % Read toc second time, this time actually producing the outlines.
1342 % The `-' means take the \expnumber as the absolute number of
1343 % subentries, which we calculated on our first read of the .toc above.
1345 % We use the node names as the destinations.
1346 \def\numchapentry##1##2##3##4{%
1347 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1348 \def\numsecentry##1##2##3##4{%
1349 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1350 \def\numsubsecentry##1##2##3##4{%
1351 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1352 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1353 \dopdfoutline{##1}{}{##3}{##4}}%
1355 % PDF outlines are displayed using system fonts, instead of
1356 % document fonts. Therefore we cannot use special characters,
1357 % since the encoding is unknown. For example, the eogonek from
1358 % Latin 2 (0xea) gets translated to a | character. Info from
1359 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1361 % TODO this right, we have to translate 8-bit characters to
1362 % their "best" equivalent, based on the @documentencoding. Too
1363 % much work for too little return. Just use the ASCII equivalents
1364 % we use for the index sort strings.
1368 % We can have normal brace characters in the PDF outlines, unlike
1369 % Texinfo index files. So set that up.
1370 \def\{{\lbracecharliteral}%
1371 \def\}{\rbracecharliteral}%
1372 \catcode`\\=\active \otherbackslash
1373 \input \tocreadfilename
1376 {\catcode`[=1 \catcode`]=2
1377 \catcode`{=\other \catcode`}=\other
1378 \gdef\lbracecharliteral[{]%
1379 \gdef\rbracecharliteral[}]%
1382 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1383 \ifx\PP\D\let\nextsp\relax
1384 \else\let\nextsp\skipspaces
1385 \addtokens{\filename}{\PP}%
1386 \advance\filenamelength by 1
1389 \def\getfilename#1{%
1391 % If we don't expand the argument now, \skipspaces will get
1392 % snagged on things like "@value{foo}".
1394 \expandafter\skipspaces\temp|\relax
1396 \ifnum\pdftexversion < 14
1397 \let \startlink \pdfannotlink
1399 \let \startlink \pdfstartlink
1401 % make a live url in pdf output.
1404 % it seems we really need yet another set of dummies; have not
1405 % tried to figure out what each command should do in the context
1406 % of @url. for now, just make @/ a no-op, that's the only one
1407 % people have actually reported a problem with.
1409 \normalturnoffactive
1412 \makevalueexpandable
1413 % do we want to go so far as to use \indexnofonts instead of just
1414 % special-casing \var here?
1417 \leavevmode\setcolor{\urlcolor}%
1418 \startlink attr{/Border [0 0 0]}%
1419 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1421 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1422 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1423 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1424 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1426 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1428 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1429 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1430 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1432 \ifnum0=\countA\else\makelink\fi
1433 \ifx\first.\let\next=\done\else
1435 \addtokens{\toksB}{\the\toksD}
1436 \ifx\first,\addtokens{\toksB}{\space}\fi
1438 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1440 \def\makelink{\addtokens{\toksB}%
1441 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1443 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1444 \setcolor{\linkcolor}#1\endlink}
1445 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1448 \let\pdfmkdest = \gobble
1449 \let\pdfurl = \gobble
1450 \let\endlink = \relax
1451 \let\setcolor = \gobble
1452 \let\pdfsetcolor = \gobble
1453 \let\pdfmakeoutlines = \relax
1454 \fi % \ifx\pdfoutput
1459 % Change the current font style to #1, remembering it in \curfontstyle.
1460 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1461 % italics, not bold italics.
1463 \def\setfontstyle#1{%
1464 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1465 \csname ten#1\endcsname % change the current font
1468 % Select #1 fonts with the current style.
1470 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1472 \def\rm{\fam=0 \setfontstyle{rm}}
1473 \def\it{\fam=\itfam \setfontstyle{it}}
1474 \def\sl{\fam=\slfam \setfontstyle{sl}}
1475 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1476 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1478 % Unfortunately, we have to override this for titles and the like, since
1479 % in those cases "rm" is bold. Sigh.
1480 \def\rmisbold{\rm\def\curfontstyle{bf}}
1482 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1483 % So we set up a \sf.
1485 \def\sf{\fam=\sffam \setfontstyle{sf}}
1486 \let\li = \sf % Sometimes we call it \li, not \sf.
1488 % We don't need math for this font style.
1489 \def\ttsl{\setfontstyle{ttsl}}
1492 % Set the baselineskip to #1, and the lineskip and strut size
1493 % correspondingly. There is no deep meaning behind these magic numbers
1494 % used as factors; they just match (closely enough) what Knuth defined.
1496 \def\lineskipfactor{.08333}
1497 \def\strutheightpercent{.70833}
1498 \def\strutdepthpercent {.29167}
1500 % can get a sort of poor man's double spacing by redefining this.
1501 \def\baselinefactor{1}
1503 \newdimen\textleading
1506 \normalbaselineskip = \baselinefactor\dimen0
1507 \normallineskip = \lineskipfactor\normalbaselineskip
1509 \setbox\strutbox =\hbox{%
1510 \vrule width0pt height\strutheightpercent\baselineskip
1511 depth \strutdepthpercent \baselineskip
1515 % PDF CMaps. See also LaTeX's t1.cmap.
1517 % do nothing with this by default.
1518 \expandafter\let\csname cmapOT1\endcsname\gobble
1519 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1520 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1522 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1523 % (\pdffontattr was introduced many years ago, but people still run
1524 % older pdftex's; it's easy to conditionalize, so we do.)
1525 \ifpdf \ifx\pdffontattr\thisisundefined \else
1527 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1528 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1529 %%DocumentNeededResources: ProcSet (CIDInit)
1530 %%IncludeResource: ProcSet (CIDInit)
1531 %%BeginResource: CMap (TeX-OT1-0)
1532 %%Title: (TeX-OT1-0 TeX OT1 0)
1535 /CIDInit /ProcSet findresource begin
1543 /CMapName /TeX-OT1-0 def
1545 1 begincodespacerange
1601 CMapName currentdict /CMap defineresource pop
1607 \expandafter\edef\csname cmapOT1\endcsname#1{%
1608 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1613 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1614 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1615 %%DocumentNeededResources: ProcSet (CIDInit)
1616 %%IncludeResource: ProcSet (CIDInit)
1617 %%BeginResource: CMap (TeX-OT1IT-0)
1618 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1621 /CIDInit /ProcSet findresource begin
1629 /CMapName /TeX-OT1IT-0 def
1631 1 begincodespacerange
1689 CMapName currentdict /CMap defineresource pop
1695 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1696 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1701 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1702 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1703 %%DocumentNeededResources: ProcSet (CIDInit)
1704 %%IncludeResource: ProcSet (CIDInit)
1705 %%BeginResource: CMap (TeX-OT1TT-0)
1706 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1709 /CIDInit /ProcSet findresource begin
1717 /CMapName /TeX-OT1TT-0 def
1719 1 begincodespacerange
1764 CMapName currentdict /CMap defineresource pop
1770 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1771 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1776 % Set the font macro #1 to the font named \fontprefix#2.
1777 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1778 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1786 \def\setfont#1#2#3#4#5{%
1787 \font#1=\fontprefix#2#3 scaled #4
1788 \csname cmap#5\endcsname#1%
1790 % This is what gets called when #5 of \setfont is empty.
1795 % Use cm as the default font prefix.
1796 % To specify the font prefix, you must define \fontprefix
1797 % before you read in texinfo.tex.
1798 \ifx\fontprefix\thisisundefined
1801 % Support font families that don't use the same naming scheme as CM.
1803 \def\rmbshape{bx} % where the normal face is bold
1808 \def\ttslshape{sltt}
1818 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1820 \def\definetextfontsizexi{%
1821 % Text fonts (11.2pt, magstep1).
1822 \def\textnominalsize{11pt}
1823 \edef\mainmagstep{\magstephalf}
1824 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1825 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1826 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1827 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1828 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1829 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1830 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1831 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1832 \font\texti=cmmi10 scaled \mainmagstep
1833 \font\textsy=cmsy10 scaled \mainmagstep
1834 \def\textecsize{1095}
1836 % A few fonts for @defun names and args.
1837 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1838 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1839 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1840 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1842 % Fonts for indices, footnotes, small examples (9pt).
1843 \def\smallnominalsize{9pt}
1844 \setfont\smallrm\rmshape{9}{1000}{OT1}
1845 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1846 \setfont\smallbf\bfshape{10}{900}{OT1}
1847 \setfont\smallit\itshape{9}{1000}{OT1IT}
1848 \setfont\smallsl\slshape{9}{1000}{OT1}
1849 \setfont\smallsf\sfshape{9}{1000}{OT1}
1850 \setfont\smallsc\scshape{10}{900}{OT1}
1851 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1854 \def\smallecsize{0900}
1856 % Fonts for small examples (8pt).
1857 \def\smallernominalsize{8pt}
1858 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1859 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1860 \setfont\smallerbf\bfshape{10}{800}{OT1}
1861 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1862 \setfont\smallersl\slshape{8}{1000}{OT1}
1863 \setfont\smallersf\sfshape{8}{1000}{OT1}
1864 \setfont\smallersc\scshape{10}{800}{OT1}
1865 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1866 \font\smalleri=cmmi8
1867 \font\smallersy=cmsy8
1868 \def\smallerecsize{0800}
1870 % Fonts for title page (20.4pt):
1871 \def\titlenominalsize{20pt}
1872 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1873 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1874 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1875 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1876 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1877 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1878 \let\titlebf=\titlerm
1879 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1880 \font\titlei=cmmi12 scaled \magstep3
1881 \font\titlesy=cmsy10 scaled \magstep4
1882 \def\titleecsize{2074}
1884 % Chapter (and unnumbered) fonts (17.28pt).
1885 \def\chapnominalsize{17pt}
1886 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1887 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1888 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1889 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1890 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1891 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1893 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1894 \font\chapi=cmmi12 scaled \magstep2
1895 \font\chapsy=cmsy10 scaled \magstep3
1896 \def\chapecsize{1728}
1898 % Section fonts (14.4pt).
1899 \def\secnominalsize{14pt}
1900 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1901 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
1902 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1903 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1904 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1905 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1906 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1908 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1909 \font\seci=cmmi12 scaled \magstep1
1910 \font\secsy=cmsy10 scaled \magstep2
1911 \def\sececsize{1440}
1913 % Subsection fonts (13.15pt).
1914 \def\ssecnominalsize{13pt}
1915 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1916 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1917 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1918 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1919 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1920 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1922 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1923 \font\sseci=cmmi12 scaled \magstephalf
1924 \font\ssecsy=cmsy10 scaled 1315
1925 \def\ssececsize{1200}
1927 % Reduced fonts for @acro in text (10pt).
1928 \def\reducednominalsize{10pt}
1929 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1930 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1931 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1932 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1933 \setfont\reducedsl\slshape{10}{1000}{OT1}
1934 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1935 \setfont\reducedsc\scshape{10}{1000}{OT1}
1936 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1937 \font\reducedi=cmmi10
1938 \font\reducedsy=cmsy10
1939 \def\reducedecsize{1000}
1941 \textleading = 13.2pt % line spacing for 11pt CM
1942 \textfonts % reset the current fonts
1944 } % end of 11pt text font size definitions, \definetextfontsizexi
1947 % Definitions to make the main text be 10pt Computer Modern, with
1948 % section, chapter, etc., sizes following suit. This is for the GNU
1949 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1950 % future. Used with @smallbook, which sets the leading to 12pt.
1952 \def\definetextfontsizex{%
1953 % Text fonts (10pt).
1954 \def\textnominalsize{10pt}
1955 \edef\mainmagstep{1000}
1956 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1957 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1958 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1959 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1960 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1961 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1962 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1963 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1964 \font\texti=cmmi10 scaled \mainmagstep
1965 \font\textsy=cmsy10 scaled \mainmagstep
1966 \def\textecsize{1000}
1968 % A few fonts for @defun names and args.
1969 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1970 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1971 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1972 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1974 % Fonts for indices, footnotes, small examples (9pt).
1975 \def\smallnominalsize{9pt}
1976 \setfont\smallrm\rmshape{9}{1000}{OT1}
1977 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1978 \setfont\smallbf\bfshape{10}{900}{OT1}
1979 \setfont\smallit\itshape{9}{1000}{OT1IT}
1980 \setfont\smallsl\slshape{9}{1000}{OT1}
1981 \setfont\smallsf\sfshape{9}{1000}{OT1}
1982 \setfont\smallsc\scshape{10}{900}{OT1}
1983 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1986 \def\smallecsize{0900}
1988 % Fonts for small examples (8pt).
1989 \def\smallernominalsize{8pt}
1990 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1991 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1992 \setfont\smallerbf\bfshape{10}{800}{OT1}
1993 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1994 \setfont\smallersl\slshape{8}{1000}{OT1}
1995 \setfont\smallersf\sfshape{8}{1000}{OT1}
1996 \setfont\smallersc\scshape{10}{800}{OT1}
1997 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1998 \font\smalleri=cmmi8
1999 \font\smallersy=cmsy8
2000 \def\smallerecsize{0800}
2002 % Fonts for title page (20.4pt):
2003 \def\titlenominalsize{20pt}
2004 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2005 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2006 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2007 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2008 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2009 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2010 \let\titlebf=\titlerm
2011 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2012 \font\titlei=cmmi12 scaled \magstep3
2013 \font\titlesy=cmsy10 scaled \magstep4
2014 \def\titleecsize{2074}
2016 % Chapter fonts (14.4pt).
2017 \def\chapnominalsize{14pt}
2018 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2019 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2020 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2021 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2022 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2023 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2025 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2026 \font\chapi=cmmi12 scaled \magstep1
2027 \font\chapsy=cmsy10 scaled \magstep2
2028 \def\chapecsize{1440}
2030 % Section fonts (12pt).
2031 \def\secnominalsize{12pt}
2032 \setfont\secrm\rmbshape{12}{1000}{OT1}
2033 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2034 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2035 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2036 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2037 \setfont\secsf\sfbshape{12}{1000}{OT1}
2039 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2041 \font\secsy=cmsy10 scaled \magstep1
2042 \def\sececsize{1200}
2044 % Subsection fonts (10pt).
2045 \def\ssecnominalsize{10pt}
2046 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2047 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2048 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2049 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2050 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2051 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2053 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2056 \def\ssececsize{1000}
2058 % Reduced fonts for @acro in text (9pt).
2059 \def\reducednominalsize{9pt}
2060 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2061 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2062 \setfont\reducedbf\bfshape{10}{900}{OT1}
2063 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2064 \setfont\reducedsl\slshape{9}{1000}{OT1}
2065 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2066 \setfont\reducedsc\scshape{10}{900}{OT1}
2067 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2068 \font\reducedi=cmmi9
2069 \font\reducedsy=cmsy9
2070 \def\reducedecsize{0900}
2072 \divide\parskip by 2 % reduce space between paragraphs
2073 \textleading = 12pt % line spacing for 10pt CM
2074 \textfonts % reset the current fonts
2076 } % end of 10pt text font size definitions, \definetextfontsizex
2079 % We provide the user-level command
2081 % (or 11) to redefine the text font size. pt is assumed.
2087 \parseargdef\fonttextsize{%
2088 \def\textsizearg{#1}%
2089 %\wlog{doing @fonttextsize \textsizearg}%
2091 % Set \globaldefs so that documents can use this inside @tex, since
2092 % makeinfo 4.8 does not support it, but we need it nonetheless.
2094 \begingroup \globaldefs=1
2095 \ifx\textsizearg\xword \definetextfontsizex
2096 \else \ifx\textsizearg\xiword \definetextfontsizexi
2099 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2104 % In order for the font changes to affect most math symbols and letters,
2105 % we have to define the \textfont of the standard families. We don't
2106 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2108 \def\resetmathfonts{%
2109 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2110 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2111 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2114 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2115 % of just \STYLE. We do this because \STYLE needs to also set the
2116 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2117 % \tenSTYLE to set the current font.
2119 % Each font-changing command also sets the names \lsize (one size lower)
2120 % and \lllsize (three sizes lower). These relative commands are used
2121 % in, e.g., the LaTeX logo and acronyms.
2123 % This all needs generalizing, badly.
2126 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2127 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2128 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2129 \let\tenttsl=\textttsl
2130 \def\curfontsize{text}%
2131 \def\lsize{reduced}\def\lllsize{smaller}%
2132 \resetmathfonts \setleading{\textleading}}
2134 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2135 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2136 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2137 \let\tenttsl=\titlettsl
2138 \def\curfontsize{title}%
2139 \def\lsize{chap}\def\lllsize{subsec}%
2140 \resetmathfonts \setleading{27pt}}
2141 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2143 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2144 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2145 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2146 \let\tenttsl=\chapttsl
2147 \def\curfontsize{chap}%
2148 \def\lsize{sec}\def\lllsize{text}%
2149 \resetmathfonts \setleading{19pt}}
2151 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2152 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2153 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2154 \let\tenttsl=\secttsl
2155 \def\curfontsize{sec}%
2156 \def\lsize{subsec}\def\lllsize{reduced}%
2157 \resetmathfonts \setleading{17pt}}
2159 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2160 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2161 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2162 \let\tenttsl=\ssecttsl
2163 \def\curfontsize{ssec}%
2164 \def\lsize{text}\def\lllsize{small}%
2165 \resetmathfonts \setleading{15pt}}
2166 \let\subsubsecfonts = \subsecfonts
2168 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2169 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2170 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2171 \let\tenttsl=\reducedttsl
2172 \def\curfontsize{reduced}%
2173 \def\lsize{small}\def\lllsize{smaller}%
2174 \resetmathfonts \setleading{10.5pt}}
2176 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2177 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2178 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2179 \let\tenttsl=\smallttsl
2180 \def\curfontsize{small}%
2181 \def\lsize{smaller}\def\lllsize{smaller}%
2182 \resetmathfonts \setleading{10.5pt}}
2184 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2185 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2186 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2187 \let\tenttsl=\smallerttsl
2188 \def\curfontsize{smaller}%
2189 \def\lsize{smaller}\def\lllsize{smaller}%
2190 \resetmathfonts \setleading{9.5pt}}
2192 % Fonts for short table of contents.
2193 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2194 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2195 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2196 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2198 % Define these just so they can be easily changed for other fonts.
2199 \def\angleleft{$\langle$}
2200 \def\angleright{$\rangle$}
2202 % Set the fonts to use with the @small... environments.
2203 \let\smallexamplefonts = \smallfonts
2205 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2206 % can fit this many characters:
2207 % 8.5x11=86 smallbook=72 a4=90 a5=69
2208 % If we use \scriptfonts (8pt), then we can fit this many characters:
2209 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2210 % For me, subjectively, the few extra characters that fit aren't worth
2211 % the additional smallness of 8pt. So I'm making the default 9pt.
2213 % By the way, for comparison, here's what fits with @example (10pt):
2214 % 8.5x11=71 smallbook=60 a4=75 a5=58
2217 % Set up the default fonts, so we can use them for creating boxes.
2219 \definetextfontsizexi
2224 % Check if we are currently using a typewriter font. Since all the
2225 % Computer Modern typewriter fonts have zero interword stretch (and
2226 % shrink), and it is reasonable to expect all typewriter fonts to have
2227 % this property, we can check that font parameter.
2229 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2231 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2232 % define and register \INITMACRO to be called on markup style changes.
2233 % \INITMACRO can check \currentmarkupstyle for the innermost
2234 % style and the set of \ifmarkupSTYLE switches for all styles
2235 % currently in effect.
2239 %\newif\ifmarkupfile % @file == @samp.
2240 %\newif\ifmarkupoption % @option == @samp.
2243 %\newif\ifmarkupenv % @env == @code.
2244 %\newif\ifmarkupcommand % @command == @code.
2245 \newif\ifmarkuptex % @tex (and part of @math, for now).
2246 \newif\ifmarkupexample
2248 \newif\ifmarkupverbatim
2250 \let\currentmarkupstyle\empty
2252 \def\setupmarkupstyle#1{%
2253 \csname markup#1true\endcsname
2254 \def\currentmarkupstyle{#1}%
2258 \let\markupstylesetup\empty
2260 \def\defmarkupstylesetup#1{%
2261 \expandafter\def\expandafter\markupstylesetup
2262 \expandafter{\markupstylesetup #1}%
2266 % Markup style setup for left and right quotes.
2267 \defmarkupstylesetup\markupsetuplq{%
2268 \expandafter\let\expandafter \temp
2269 \csname markupsetuplq\currentmarkupstyle\endcsname
2270 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2273 \defmarkupstylesetup\markupsetuprq{%
2274 \expandafter\let\expandafter \temp
2275 \csname markupsetuprq\currentmarkupstyle\endcsname
2276 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2283 \gdef\markupsetuplqdefault{\let`\lq}
2284 \gdef\markupsetuprqdefault{\let'\rq}
2286 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2287 \gdef\markupsetcodequoteright{\let'\codequoteright}
2290 \let\markupsetuplqcode \markupsetcodequoteleft
2291 \let\markupsetuprqcode \markupsetcodequoteright
2293 \let\markupsetuplqexample \markupsetcodequoteleft
2294 \let\markupsetuprqexample \markupsetcodequoteright
2296 \let\markupsetuplqkbd \markupsetcodequoteleft
2297 \let\markupsetuprqkbd \markupsetcodequoteright
2299 \let\markupsetuplqsamp \markupsetcodequoteleft
2300 \let\markupsetuprqsamp \markupsetcodequoteright
2302 \let\markupsetuplqverb \markupsetcodequoteleft
2303 \let\markupsetuprqverb \markupsetcodequoteright
2305 \let\markupsetuplqverbatim \markupsetcodequoteleft
2306 \let\markupsetuprqverbatim \markupsetcodequoteright
2308 % Allow an option to not use regular directed right quote/apostrophe
2309 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2310 % The undirected quote is ugly, so don't make it the default, but it
2311 % works for pasting with more pdf viewers (at least evince), the
2312 % lilypond developers report. xpdf does work with the regular 0x27.
2314 \def\codequoteright{%
2315 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2316 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2322 % and a similar option for the left quote char vs. a grave accent.
2323 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2324 % the code environments to do likewise.
2326 \def\codequoteleft{%
2327 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2328 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2329 % [Knuth] pp. 380,381,391
2330 % \relax disables Spanish ligatures ?` and !` of \tt font.
2336 % Commands to set the quote options.
2338 \parseargdef\codequoteundirected{%
2341 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2343 \else\ifx\temp\offword
2344 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2347 \errhelp = \EMsimple
2348 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2352 \parseargdef\codequotebacktick{%
2355 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2357 \else\ifx\temp\offword
2358 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2361 \errhelp = \EMsimple
2362 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2366 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2367 \def\noligaturesquoteleft{\relax\lq}
2369 % Count depth in font-changes, for error checks
2370 \newcount\fontdepth \fontdepth=0
2374 % #1 is the font command (\sl or \it), #2 is the text to slant.
2375 % If we are in a monospaced environment, however, 1) always use \ttsl,
2376 % and 2) do not add an italic correction.
2377 \def\dosmartslant#1#2{%
2379 {{\ttsl #2}\let\next=\relax}%
2380 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2383 \def\smartslanted{\dosmartslant\sl}
2384 \def\smartitalic{\dosmartslant\it}
2386 % Output an italic correction unless \next (presumed to be the following
2387 % character) is such as not to need one.
2388 \def\smartitaliccorrection{%
2393 \else\ifx\next\comma%
2399 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2400 \def\ttslanted#1{{\ttsl #1}}
2402 % @cite is like \smartslanted except unconditionally use \sl. We never want
2403 % ttsl for book titles, do we?
2404 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2408 \let\saveaftersmartic = \aftersmartic
2409 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2414 \let\slanted=\smartslanted
2415 \let\dfn=\smartslanted
2416 \let\emph=\smartitalic
2418 % Explicit font changes: @r, @sc, undocumented @ii.
2419 \def\r#1{{\rm #1}} % roman font
2420 \def\sc#1{{\smallcaps#1}} % smallcaps font
2421 \def\ii#1{{\it #1}} % italic font
2423 % @b, explicit bold. Also @strong.
2427 % @sansserif, explicit sans.
2428 \def\sansserif#1{{\sf #1}}
2430 % We can't just use \exhyphenpenalty, because that only has effect at
2431 % the end of a paragraph. Restore normal hyphenation at the end of the
2432 % group within which \nohyphenation is presumably called.
2434 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2435 \def\restorehyphenation{\hyphenchar\font = `- }
2437 % Set sfcode to normal for the chars that usually have another value.
2438 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2439 % sometimes \x has an active definition that messes things up.
2442 \def\plainfrenchspacing{%
2443 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2444 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2445 \def\endofsentencespacefactor{1000}% for @. and friends
2447 \def\plainnonfrenchspacing{%
2448 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2449 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2450 \def\endofsentencespacefactor{3000}% for @. and friends
2453 \def\endofsentencespacefactor{3000}% default
2455 % @t, explicit typewriter.
2457 {\tt \rawbackslash \plainfrenchspacing #1}%
2462 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2464 % @indicateurl is \samp, that is, with quotes.
2465 \let\indicateurl=\samp
2467 % @code (and similar) prints in typewriter, but with spaces the same
2468 % size as normal in the surrounding text, without hyphenation, etc.
2469 % This is a subroutine for that.
2472 % Change normal interword space to be same as for the current font.
2473 \spaceskip = \fontdimen2\font
2475 % Switch to typewriter.
2478 % But `\ ' produces the large typewriter interword space.
2479 \def\ {{\spaceskip = 0pt{} }}%
2481 % Turn off hyphenation.
2488 \null % reset spacefactor to 1000
2491 % We *must* turn on hyphenation at `-' and `_' in @code.
2492 % (But see \codedashfinish below.)
2493 % Otherwise, it is too hard to avoid overfull hboxes
2494 % in the Emacs manual, the Library manual, etc.
2496 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2497 % both hyphenation at - and hyphenation within words.
2498 % We must therefore turn them both off (\tclose does that)
2499 % and arrange explicitly to hyphenate at a dash. -- rms.
2501 \catcode`\-=\active \catcode`\_=\active
2502 \catcode`\'=\active \catcode`\`=\active
2503 \global\let'=\rq \global\let`=\lq % default definitions
2505 \global\def\code{\begingroup
2506 \setupmarkupstyle{code}%
2507 % The following should really be moved into \setupmarkupstyle handlers.
2508 \catcode\dashChar=\active \catcode\underChar=\active
2516 % Given -foo (with a single dash), we do not want to allow a break
2518 \global\let\codedashprev=\codedash
2523 \gdef\codedash{\futurelet\next\codedashfinish}
2524 \gdef\codedashfinish{%
2525 \normaldash % always output the dash character itself.
2527 % Now, output a discretionary to allow a line break, unless
2528 % (a) the next character is a -, or
2529 % (b) the preceding character is a -.
2530 % E.g., given --posix, we do not want to allow a break after either -.
2531 % Given --foo-bar, we do want to allow a break between the - and the b.
2532 \ifx\next\codedash \else
2533 \ifx\codedashprev\codedash
2534 \else \discretionary{}{}{}\fi
2536 % we need the space after the = for the case when \next itself is a
2537 % space token; it would get swallowed otherwise. As in @code{- a}.
2538 \global\let\codedashprev= \next
2543 \def\codex #1{\tclose{#1}\endgroup}
2546 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2547 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2548 % will therefore expand the active definition of _, which is us
2549 % (inside @code that is), therefore an endless loop.
2551 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2552 \else\normalunderscore \fi
2553 \discretionary{}{}{}}%
2557 % An additional complication: the above will allow breaks after, e.g.,
2558 % each of the four underscores in __typeof__. This is bad.
2559 % @allowcodebreaks provides a document-level way to turn breaking at -
2562 \newif\ifallowcodebreaks \allowcodebreakstrue
2564 \def\keywordtrue{true}
2565 \def\keywordfalse{false}
2567 \parseargdef\allowcodebreaks{%
2569 \ifx\txiarg\keywordtrue
2570 \allowcodebreakstrue
2571 \else\ifx\txiarg\keywordfalse
2572 \allowcodebreaksfalse
2574 \errhelp = \EMsimple
2575 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2579 % For @command, @env, @file, @option quotes seem unnecessary,
2580 % so use \code rather than \samp.
2586 % @uref (abbreviation for `urlref') aka @url takes an optional
2587 % (comma-separated) second argument specifying the text to display and
2588 % an optional third arg as text to display instead of (rather than in
2589 % addition to) the url itself. First (mandatory) arg is the url.
2591 % TeX-only option to allow changing PDF output to show only the second
2592 % arg (if given), and not the url (which is then just the link target).
2593 \newif\ifurefurlonlylink
2595 % The main macro is \urefbreak, which allows breaking at expected
2596 % places within the url. (There used to be another version, which
2597 % didn't support automatic breaking.)
2598 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2599 \let\uref=\urefbreak
2601 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2602 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2605 \setbox0 = \hbox{\ignorespaces #3}%
2607 \unhbox0 % third arg given, show only that
2609 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2613 % PDF plus option to not display url, show just arg
2616 % PDF, normally display both arg and url for consistency,
2617 % visibility, if the pdf is eventually used to print, etc.
2618 \unhbox0\ (\urefcode{#1})%
2621 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2624 \urefcode{#1}% only url given, so show it
2630 % Allow line breaks around only a few characters (only).
2632 \catcode\ampChar=\active \catcode\dotChar=\active
2633 \catcode\hashChar=\active \catcode\questChar=\active
2634 \catcode\slashChar=\active
2639 \global\def\urefcode{\begingroup
2640 \setupmarkupstyle{code}%
2650 % By default, they are just regular characters.
2651 \global\def&{\normalamp}
2652 \global\def.{\normaldot}
2653 \global\def#{\normalhash}
2654 \global\def?{\normalquest}
2655 \global\def/{\normalslash}
2658 % we put a little stretch before and after the breakable chars, to help
2659 % line breaking of long url's. The unequal skips make look better in
2660 % cmtt at least, especially for dots.
2661 \def\urefprestretchamount{.13em}
2662 \def\urefpoststretchamount{.1em}
2663 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
2664 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
2666 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2667 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2668 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2669 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2670 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2673 \global\def\urefcodeslashfinish{%
2674 \urefprestretch \slashChar
2675 % Allow line break only after the final / in a sequence of
2676 % slashes, to avoid line break between the slashes in http://.
2677 \ifx\next/\else \urefpoststretch \fi
2681 % One more complication: by default we'll break after the special
2682 % characters, but some people like to break before the special chars, so
2683 % allow that. Also allow no breaking at all, for manual control.
2685 \parseargdef\urefbreakstyle{%
2687 \ifx\txiarg\wordnone
2688 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2689 \else\ifx\txiarg\wordbefore
2690 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2691 \else\ifx\txiarg\wordafter
2692 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2694 \errhelp = \EMsimple
2695 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2698 \def\wordafter{after}
2699 \def\wordbefore{before}
2702 \urefbreakstyle after
2704 % @url synonym for @uref, since that's how everyone uses it.
2708 % rms does not like angle brackets --karl, 17may97.
2709 % So now @email is just like @uref, unless we are pdf.
2711 %\def\email#1{\angleleft{\tt #1}\angleright}
2713 \def\email#1{\doemail#1,,\finish}
2714 \def\doemail#1,#2,#3\finish{\begingroup
2717 \setbox0 = \hbox{\ignorespaces #2}%
2718 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2725 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2726 % `example' (@kbd uses ttsl only inside of @example and friends),
2727 % or `code' (@kbd uses normal tty font always).
2728 \parseargdef\kbdinputstyle{%
2730 \ifx\txiarg\worddistinct
2731 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2732 \else\ifx\txiarg\wordexample
2733 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2734 \else\ifx\txiarg\wordcode
2735 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2737 \errhelp = \EMsimple
2738 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2741 \def\worddistinct{distinct}
2742 \def\wordexample{example}
2745 % Default is `distinct'.
2746 \kbdinputstyle distinct
2748 % @kbd is like @code, except that if the argument is just one @key command,
2749 % then @kbd has no effect.
2750 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2753 \def\kbdsub#1#2#3\par{%
2754 \def\one{#1}\def\three{#3}\def\threex{??}%
2755 \ifx\one\xkey\ifx\threex\three \key{#2}%
2756 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2757 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2760 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2761 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2763 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2764 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2765 % \vbox{\hrule\kern-0.4pt
2766 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2767 % \kern-0.4pt\hrule}%
2768 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2770 % definition of @key with no lozenge. If the current font is already
2771 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2772 % if it isn't monospace, then use \tt.
2774 \def\key#1{{\setupmarkupstyle{key}%
2776 \ifmonospace\else\tt\fi
2779 % @clicksequence{File @click{} Open ...}
2780 \def\clicksequence#1{\begingroup #1\endgroup}
2782 % @clickstyle @arrow (by default)
2783 \parseargdef\clickstyle{\def\click{#1}}
2786 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2787 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2789 \def\dmn#1{\thinspace #1}
2791 % @l was never documented to mean ``switch to the Lisp font'',
2792 % and it is not used as such in any manual I can find. We need it for
2793 % Polish suppressed-l. --karl, 22sep96.
2794 %\def\l#1{{\li #1}\null}
2796 % @acronym for "FBI", "NATO", and the like.
2797 % We print this one point size smaller, since it's intended for
2800 \def\acronym#1{\doacronym #1,,\finish}
2801 \def\doacronym#1,#2,#3\finish{%
2802 {\selectfonts\lsize #1}%
2804 \ifx\temp\empty \else
2805 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2807 \null % reset \spacefactor=1000
2810 % @abbr for "Comput. J." and the like.
2811 % No font change, but don't do end-of-sentence spacing.
2813 \def\abbr#1{\doabbr #1,,\finish}
2814 \def\doabbr#1,#2,#3\finish{%
2815 {\plainfrenchspacing #1}%
2817 \ifx\temp\empty \else
2818 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2820 \null % reset \spacefactor=1000
2823 % @asis just yields its argument. Used with @table, for example.
2827 % @math outputs its argument in math mode.
2829 % One complication: _ usually means subscripts, but it could also mean
2830 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2831 % _ active, and distinguish by seeing if the current family is \slfam,
2832 % which is what @var uses.
2834 \catcode`\_ = \active
2835 \gdef\mathunderscore{%
2837 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2840 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2841 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2842 % particular reason), but this is not advertised and we don't care.
2844 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2845 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2850 \let\\ = \mathbackslash
2852 % make the texinfo accent commands work in math mode
2862 % have to provide another name for sup operator
2866 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2868 % Some active characters (such as <) are spaced differently in math.
2869 % We have to reset their definitions in case the @math was an argument
2870 % to a command which sets the catcodes (such as @item or @section).
2873 \catcode`^ = \active
2874 \catcode`< = \active
2875 \catcode`> = \active
2876 \catcode`+ = \active
2877 \catcode`' = \active
2883 \let' = \ptexquoteright
2887 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
2888 % If in text, use math to place as sub/superscript, but switch
2889 % into text mode, with smaller fonts. This is a different font than the
2890 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
2891 % fix it (significant additions to font machinery) until someone notices.
2893 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
2894 \def\finishsub#1{$\sb{\hbox{\selectfonts\lllsize #1}}$}%
2896 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
2897 \def\finishsup#1{$\ptexsp{\hbox{\selectfonts\lllsize #1}}$}%
2899 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2900 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2901 % except specified as a normal braced arg, so no newlines to worry about.
2903 \def\outfmtnametex{tex}
2905 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2906 \long\def\doinlinefmt#1,#2,\finish{%
2907 \def\inlinefmtname{#1}%
2908 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2911 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2912 % FMTNAME is tex, else ELSE-TEXT.
2913 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
2914 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
2915 \def\inlinefmtname{#1}%
2916 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2919 % For raw, must switch into @tex before parsing the argument, to avoid
2920 % setting catcodes prematurely. Doing it this way means that, for
2921 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2922 % ignored. But this isn't important because if people want a literal
2923 % *right* brace they would have to use a command anyway, so they may as
2924 % well use a command to get a left brace too. We could re-use the
2925 % delimiter character idea from \verb, but it seems like overkill.
2927 \long\def\inlineraw{\tex \doinlineraw}
2928 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2929 \def\doinlinerawtwo#1,#2,\finish{%
2930 \def\inlinerawname{#1}%
2931 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2932 \endgroup % close group opened by \tex.
2935 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2937 \long\def\inlineifset#1{\doinlineifset #1,\finish}
2938 \long\def\doinlineifset#1,#2,\finish{%
2939 \def\inlinevarname{#1}%
2940 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
2941 \else\ignorespaces#2\fi
2944 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2946 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
2947 \long\def\doinlineifclear#1,#2,\finish{%
2948 \def\inlinevarname{#1}%
2949 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
2956 % @@ prints an @, as does @atchar{}.
2960 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2961 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2962 % not have braces, and we don't want to switch into math.
2963 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2964 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2965 \let\{=\mylbrace \let\lbracechar=\{
2966 \let\}=\myrbrace \let\rbracechar=\}
2968 % Definitions to produce \{ and \} commands for indices,
2969 % and @{ and @} for the aux/toc files.
2970 \catcode`\{ = \other \catcode`\} = \other
2971 \catcode`\[ = 1 \catcode`\] = 2
2972 \catcode`\! = 0 \catcode`\\ = \other
2973 !gdef!lbracecmd[\{]%
2974 !gdef!rbracecmd[\}]%
2975 !gdef!lbraceatcmd[@{]%
2976 !gdef!rbraceatcmd[@}]%
2979 % @comma{} to avoid , parsing problems.
2982 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2983 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2985 \let\dotaccent = \ptexdot
2986 \def\ringaccent#1{{\accent23 #1}}
2987 \let\tieaccent = \ptext
2988 \let\ubaraccent = \ptexb
2989 \let\udotaccent = \d
2991 % Other special characters: @questiondown @exclamdown @ordf @ordm
2992 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2993 \def\questiondown{?`}
2995 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2996 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2998 % Dotless i and dotless j, used for accents.
3003 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3004 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3005 \else \errmessage{@dotless can be used only with i or j}%
3009 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3010 % period following counts as ending a sentence. (Idea found in latex.)
3012 \edef\TeX{\TeX \spacefactor=1000 }
3014 % @LaTeX{} logo. Not quite the same results as the definition in
3015 % latex.ltx, since we use a different font for the raised A; it's most
3016 % convenient for us to use an explicitly smaller font, rather than using
3017 % the \scriptstyle font (since we don't reset \scriptstyle and
3018 % \scriptscriptstyle).
3023 \vbox to \ht0{\hbox{%
3024 \ifx\textnominalsize\xwordpt
3025 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3026 % Revert to plain's \scriptsize, which is 7pt.
3027 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3029 % For 11pt, we can use our lllsize.
3030 \selectfonts\lllsize A%
3039 % Some math mode symbols. Define \ensuremath to switch into math mode
3040 % unless we are already there. Expansion tricks may not be needed here,
3041 % but safer, and can't hurt.
3042 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3043 \def\ensuredmath#1{$\relax#1$}
3045 \def\bullet{\ensuremath\ptexbullet}
3046 \def\geq{\ensuremath\ge}
3047 \def\leq{\ensuremath\le}
3048 \def\minus{\ensuremath-}
3050 % @dots{} outputs an ellipsis using the current font.
3051 % We do .5em per period so that it has the same spacing in the cm
3052 % typewriter fonts as three actual period characters; on the other hand,
3053 % in other typewriter fonts three periods are wider than 1.5em. So do
3054 % whichever is larger.
3058 \setbox0=\hbox{...}% get width of three periods
3065 \hskip 0pt plus.25fil
3066 .\hskip 0pt plus1fil
3067 .\hskip 0pt plus1fil
3068 .\hskip 0pt plus.5fil
3072 % @enddots{} is an end-of-sentence ellipsis.
3076 \spacefactor=\endofsentencespacefactor
3079 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3081 % Since these characters are used in examples, they should be an even number of
3082 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3085 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3086 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3087 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3088 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3089 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3091 % The @error{} command.
3092 % Adapted from the TeXbook's \boxit.
3096 {\tentt \global\dimen0 = 3em}% Width of the box.
3097 \dimen2 = .55pt % Thickness of rules
3098 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3099 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3101 \setbox\errorbox=\hbox to \dimen0{\hfil
3102 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3103 \advance\hsize by -2\dimen2 % Rules.
3105 \hrule height\dimen2
3106 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3107 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3108 \kern3pt\vrule width\dimen2}% Space to right.
3109 \hrule height\dimen2}
3112 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3114 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3116 \def\pounds{{\it\$}}
3118 % @euro{} comes from a separate font, depending on the current style.
3119 % We use the free feym* fonts from the eurosym package by Henrik
3120 % Theiling, which support regular, slanted, bold and bold slanted (and
3121 % "outlined" (blackboard board, sort of) versions, which we don't need).
3122 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3124 % Although only regular is the truly official Euro symbol, we ignore
3125 % that. The Euro is designed to be slightly taller than the regular
3131 % feybo - bold slanted
3133 % There is no good (free) typewriter version, to my knowledge.
3134 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3137 % Also doesn't work in math. Do we need to do math with euro symbols?
3141 \def\euro{{\eurofont e}}
3143 % We set the font at each command, rather than predefining it in
3144 % \textfonts and the other font-switching commands, so that
3145 % installations which never need the symbol don't have to have the
3148 % There is only one designed size (nominal 10pt), so we always scale
3149 % that to the current nominal size.
3151 % By the way, simply using "at 1em" works for cmr10 and the like, but
3152 % does not work for cmbx10 and other extended/shrunken fonts.
3154 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3156 \ifx\curfontstyle\bfstylename
3158 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3161 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3166 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3167 % sometimes we redefine the original macro, and the alias should reflect
3170 % Use LaTeX names for the Icelandic letters.
3171 \def\DH{{\ecfont \char"D0}} % Eth
3172 \def\dh{{\ecfont \char"F0}} % eth
3173 \def\TH{{\ecfont \char"DE}} % Thorn
3174 \def\th{{\ecfont \char"FE}} % thorn
3176 \def\guillemetleft{{\ecfont \char"13}}
3177 \def\guillemotleft{\guillemetleft}
3178 \def\guillemetright{{\ecfont \char"14}}
3179 \def\guillemotright{\guillemetright}
3180 \def\guilsinglleft{{\ecfont \char"0E}}
3181 \def\guilsinglright{{\ecfont \char"0F}}
3182 \def\quotedblbase{{\ecfont \char"12}}
3183 \def\quotesinglbase{{\ecfont \char"0D}}
3185 % This positioning is not perfect (see the ogonek LaTeX package), but
3186 % we have the precomposed glyphs for the most common cases. We put the
3187 % tests to use those glyphs in the single \ogonek macro so we have fewer
3188 % dummy definitions to worry about for index entries, etc.
3190 % ogonek is also used with other letters in Lithuanian (IOU), but using
3191 % the precomposed glyphs for those is not so easy since they aren't in
3195 \ifx\temp\macrocharA\Aogonek
3196 \else\ifx\temp\macrochara\aogonek
3197 \else\ifx\temp\macrocharE\Eogonek
3198 \else\ifx\temp\macrochare\eogonek
3200 \ecfont \setbox0=\hbox{#1}%
3201 \ifdim\ht0=1ex\accent"0C #1%
3202 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3207 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3208 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3209 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3210 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3212 % Use the European Computer Modern fonts (cm-super in outline format)
3213 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3214 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3215 % package and follow the same conventions.
3217 \def\ecfont{\etcfont{e}}
3218 \def\tcfont{\etcfont{t}}
3221 % We can't distinguish serif/sans and italic/slanted, but this
3222 % is used for crude hacks anyway (like adding French and German
3223 % quotes to documents typeset with CM, where we lose kerning), so
3224 % hopefully nobody will notice/care.
3225 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3226 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3229 \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3231 \ifx\curfontstyle\bfstylename
3233 \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3236 \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3242 % @registeredsymbol - R in a circle. The font for the R should really
3243 % be smaller yet, but lllsize is the best we can do for now.
3244 % Adapted from the plain.tex definition of \copyright.
3246 \def\registeredsymbol{%
3247 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3252 % @textdegree - the normal degrees sign.
3254 \def\textdegree{$^\circ$}
3256 % Laurent Siebenmann reports \Orb undefined with:
3257 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3258 % so we'll define it if necessary.
3260 \ifx\Orb\thisisundefined
3261 \def\Orb{\mathhexbox20D}
3265 \chardef\quotedblleft="5C
3266 \chardef\quotedblright=`\"
3267 \chardef\quoteleft=`\`
3268 \chardef\quoteright=`\'
3271 \message{page headings,}
3273 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3274 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3276 % First the title page. Must do @settitle before @titlepage.
3278 \newif\iffinishedtitlepage
3280 % Do an implicit @contents or @shortcontents after @end titlepage if the
3281 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3283 \newif\ifsetcontentsaftertitlepage
3284 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3285 \newif\ifsetshortcontentsaftertitlepage
3286 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3288 \parseargdef\shorttitlepage{%
3289 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3290 \endgroup\page\hbox{}\page}
3293 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3295 \parindent=0pt \textfonts
3296 % Leave some space at the very top of the page.
3297 \vglue\titlepagetopglue
3298 % No rule at page bottom unless we print one at the top with @title.
3299 \finishedtitlepagetrue
3301 % Most title ``pages'' are actually two pages long, with space
3302 % at the top of the second. We don't want the ragged left on the second.
3303 \let\oldpage = \page
3305 \iffinishedtitlepage\else
3308 \let\page = \oldpage
3315 \iffinishedtitlepage\else
3318 % It is important to do the page break before ending the group,
3319 % because the headline and footline are only empty inside the group.
3320 % If we use the new definition of \page, we always get a blank page
3321 % after the title page, which we certainly don't want.
3325 % Need this before the \...aftertitlepage checks so that if they are
3326 % in effect the toc pages will come out with page numbers.
3329 % If they want short, they certainly want long too.
3330 \ifsetshortcontentsaftertitlepage
3333 \global\let\shortcontents = \relax
3334 \global\let\contents = \relax
3337 \ifsetcontentsaftertitlepage
3339 \global\let\contents = \relax
3340 \global\let\shortcontents = \relax
3344 \def\finishtitlepage{%
3345 \vskip4pt \hrule height 2pt width \hsize
3346 \vskip\titlepagebottomglue
3347 \finishedtitlepagetrue
3350 % Settings used for typesetting titles: no hyphenation, no indentation,
3351 % don't worry much about spacing, ragged right. This should be used
3352 % inside a \vbox, and fonts need to be set appropriately first. Because
3353 % it is always used for titles, nothing else, we call \rmisbold. \par
3354 % should be specified before the end of the \vbox, since a vbox is a group.
3356 \def\raggedtitlesettings{%
3358 \hyphenpenalty=10000
3364 % Macros to be used within @titlepage:
3366 \let\subtitlerm=\tenrm
3367 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3369 \parseargdef\title{%
3371 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3372 % print a rule at the page bottom also.
3373 \finishedtitlepagefalse
3374 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3377 \parseargdef\subtitle{%
3379 {\subtitlefont \rightline{#1}}%
3382 % @author should come last, but may come many times.
3383 % It can also be used inside @quotation.
3385 \parseargdef\author{%
3386 \def\temp{\quotation}%
3388 \def\quotationauthor{#1}% printed in \Equotation.
3391 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3392 {\secfonts\rmisbold \leftline{#1}}%
3397 % Set up page headings and footings.
3399 \let\thispage=\folio
3401 \newtoks\evenheadline % headline on even pages
3402 \newtoks\oddheadline % headline on odd pages
3403 \newtoks\evenfootline % footline on even pages
3404 \newtoks\oddfootline % footline on odd pages
3406 % Now make TeX use those variables
3407 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3408 \else \the\evenheadline \fi}}
3409 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3410 \else \the\evenfootline \fi}\HEADINGShook}
3411 \let\HEADINGShook=\relax
3413 % Commands to set those variables.
3414 % For example, this is what @headings on does
3415 % @evenheading @thistitle|@thispage|@thischapter
3416 % @oddheading @thischapter|@thispage|@thistitle
3417 % @evenfooting @thisfile||
3418 % @oddfooting ||@thisfile
3421 \def\evenheading{\parsearg\evenheadingxxx}
3422 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3423 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3424 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3426 \def\oddheading{\parsearg\oddheadingxxx}
3427 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3428 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3429 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3431 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3433 \def\evenfooting{\parsearg\evenfootingxxx}
3434 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3435 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3436 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3438 \def\oddfooting{\parsearg\oddfootingxxx}
3439 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3440 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3441 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3443 % Leave some space for the footline. Hopefully ok to assume
3444 % @evenfooting will not be used by itself.
3445 \global\advance\pageheight by -12pt
3446 \global\advance\vsize by -12pt
3449 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3451 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3452 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3454 % The same set of arguments for:
3459 % @everyheadingmarks
3460 % @everyfootingmarks
3462 \def\evenheadingmarks{\headingmarks{even}{heading}}
3463 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3464 \def\evenfootingmarks{\headingmarks{even}{footing}}
3465 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3466 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3467 \headingmarks{odd}{heading}{#1} }
3468 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3469 \headingmarks{odd}{footing}{#1} }
3470 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3471 \def\headingmarks#1#2#3 {%
3472 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3473 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3476 \everyheadingmarks bottom
3477 \everyfootingmarks bottom
3479 % @headings double turns headings on for double-sided printing.
3480 % @headings single turns headings on for single-sided printing.
3481 % @headings off turns them off.
3482 % @headings on same as @headings double, retained for compatibility.
3483 % @headings after turns on double-sided headings after this page.
3484 % @headings doubleafter turns on double-sided headings after this page.
3485 % @headings singleafter turns on single-sided headings after this page.
3486 % By default, they are off at the start of a document,
3487 % and turned `on' after @end titlepage.
3489 \def\headings #1 {\csname HEADINGS#1\endcsname}
3491 \def\headingsoff{% non-global headings elimination
3492 \evenheadline={\hfil}\evenfootline={\hfil}%
3493 \oddheadline={\hfil}\oddfootline={\hfil}%
3496 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3497 \HEADINGSoff % it's the default
3499 % When we turn headings on, set the page number to 1.
3500 % For double-sided printing, put current file name in lower left corner,
3501 % chapter name on inside top of right hand pages, document
3502 % title on inside top of left hand pages, and page numbers on outside top
3503 % edge of all pages.
3504 \def\HEADINGSdouble{%
3506 \global\evenfootline={\hfil}
3507 \global\oddfootline={\hfil}
3508 \global\evenheadline={\line{\folio\hfil\thistitle}}
3509 \global\oddheadline={\line{\thischapter\hfil\folio}}
3510 \global\let\contentsalignmacro = \chapoddpage
3512 \let\contentsalignmacro = \chappager
3514 % For single-sided printing, chapter title goes across top left of page,
3515 % page number on top right.
3516 \def\HEADINGSsingle{%
3518 \global\evenfootline={\hfil}
3519 \global\oddfootline={\hfil}
3520 \global\evenheadline={\line{\thischapter\hfil\folio}}
3521 \global\oddheadline={\line{\thischapter\hfil\folio}}
3522 \global\let\contentsalignmacro = \chappager
3524 \def\HEADINGSon{\HEADINGSdouble}
3526 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3527 \let\HEADINGSdoubleafter=\HEADINGSafter
3528 \def\HEADINGSdoublex{%
3529 \global\evenfootline={\hfil}
3530 \global\oddfootline={\hfil}
3531 \global\evenheadline={\line{\folio\hfil\thistitle}}
3532 \global\oddheadline={\line{\thischapter\hfil\folio}}
3533 \global\let\contentsalignmacro = \chapoddpage
3536 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3537 \def\HEADINGSsinglex{%
3538 \global\evenfootline={\hfil}
3539 \global\oddfootline={\hfil}
3540 \global\evenheadline={\line{\thischapter\hfil\folio}}
3541 \global\oddheadline={\line{\thischapter\hfil\folio}}
3542 \global\let\contentsalignmacro = \chappager
3545 % Subroutines used in generating headings
3546 % This produces Day Month Year style of output.
3547 % Only define if not already defined, in case a txi-??.tex file has set
3548 % up a different format (e.g., txi-cs.tex does this).
3549 \ifx\today\thisisundefined
3553 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3554 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3555 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3560 % @settitle line... specifies the title of the document, for headings.
3561 % It generates no output of its own.
3562 \def\thistitle{\putwordNoTitle}
3563 \def\settitle{\parsearg{\gdef\thistitle}}
3567 % Tables -- @table, @ftable, @vtable, @item(x).
3569 % default indentation of table text
3570 \newdimen\tableindent \tableindent=.8in
3571 % default indentation of @itemize and @enumerate text
3572 \newdimen\itemindent \itemindent=.3in
3573 % margin between end of table item and start of table text.
3574 \newdimen\itemmargin \itemmargin=.1in
3576 % used internally for \itemindent minus \itemmargin
3579 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3581 % They also define \itemindex
3582 % to index the item name in whatever manner is desired (perhaps none).
3584 \newif\ifitemxneedsnegativevskip
3586 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3588 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3589 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3591 \def\itemzzz #1{\begingroup %
3592 \advance\hsize by -\rightskip
3593 \advance\hsize by -\tableindent
3594 \setbox0=\hbox{\itemindicate{#1}}%
3596 \nobreak % This prevents a break before @itemx.
3598 % If the item text does not fit in the space we have, put it on a line
3599 % by itself, and do not allow a page break either before or after that
3600 % line. We do not start a paragraph here because then if the next
3601 % command is, e.g., @kindex, the whatsit would get put into the
3602 % horizontal list on a line by itself, resulting in extra blank space.
3603 \ifdim \wd0>\itemmax
3605 % Make this a paragraph so we get the \parskip glue and wrapping,
3606 % but leave it ragged-right.
3608 \advance\leftskip by-\tableindent
3609 \advance\hsize by\tableindent
3610 \advance\rightskip by0pt plus1fil\relax
3611 \leavevmode\unhbox0\par
3614 % We're going to be starting a paragraph, but we don't want the
3615 % \parskip glue -- logically it's part of the @item we just started.
3616 \nobreak \vskip-\parskip
3618 % Stop a page break at the \parskip glue coming up. However, if
3619 % what follows is an environment such as @example, there will be no
3620 % \parskip glue; then the negative vskip we just inserted would
3621 % cause the example and the item to crash together. So we use this
3622 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3623 % \parskip glue after all. Section titles are handled this way also.
3627 \itemxneedsnegativevskipfalse
3629 % The item text fits into the space. Start a paragraph, so that the
3630 % following text (if any) will end up on the same line.
3632 % Do this with kerns and \unhbox so that if there is a footnote in
3633 % the item text, it can migrate to the main vertical list and
3634 % eventually be printed.
3635 \nobreak\kern-\tableindent
3636 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3638 \nobreak\kern\dimen0
3640 \itemxneedsnegativevskiptrue
3644 \def\item{\errmessage{@item while not in a list environment}}
3645 \def\itemx{\errmessage{@itemx while not in a list environment}}
3647 % @table, @ftable, @vtable.
3649 \let\itemindex\gobble
3653 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3654 \tablecheck{ftable}%
3657 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3658 \tablecheck{vtable}%
3661 \ifnum \the\catcode`\^^M=\active
3663 \errmessage{This command won't work in this context; perhaps the problem is
3664 that we are \inenvironment\thisenv}%
3665 \def\next{\doignore{#1}}%
3672 \def\itemindicate{#1}%
3677 \makevalueexpandable
3678 \edef\temp{\noexpand\tablez #1\space\space\space}%
3682 \def\tablez #1 #2 #3 #4\endtablez{%
3684 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3685 \ifnum 0#2>0 \tableindent=#2\mil \fi
3686 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3687 \itemmax=\tableindent
3688 \advance \itemmax by -\itemmargin
3689 \advance \leftskip by \tableindent
3690 \exdentamount=\tableindent
3692 \parskip = \smallskipamount
3693 \ifdim \parskip=0pt \parskip=2pt \fi
3694 \let\item = \internalBitem
3695 \let\itemx = \internalBitemx
3697 \def\Etable{\endgraf\afterenvbreak}
3700 \let\Eitemize\Etable
3701 \let\Eenumerate\Etable
3703 % This is the counter used by @enumerate, which is really @itemize
3707 \envdef\itemize{\parsearg\doitemize}
3711 \itemmax=\itemindent
3712 \advance\itemmax by -\itemmargin
3713 \advance\leftskip by \itemindent
3714 \exdentamount=\itemindent
3716 \parskip=\smallskipamount
3717 \ifdim\parskip=0pt \parskip=2pt \fi
3719 % Try typesetting the item mark so that if the document erroneously says
3720 % something like @itemize @samp (intending @table), there's an error
3721 % right away at the @itemize. It's not the best error message in the
3722 % world, but it's better than leaving it to the @item. This means if
3723 % the user wants an empty mark, they have to say @w{} not just @w.
3724 \def\itemcontents{#1}%
3725 \setbox0 = \hbox{\itemcontents}%
3727 % @itemize with no arg is equivalent to @itemize @bullet.
3728 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3730 \let\item=\itemizeitem
3733 % Definition of @item while inside @itemize and @enumerate.
3736 \advance\itemno by 1 % for enumerations
3737 {\let\par=\endgraf \smallbreak}% reasonable place to break
3739 % If the document has an @itemize directly after a section title, a
3740 % \nobreak will be last on the list, and \sectionheading will have
3741 % done a \vskip-\parskip. In that case, we don't want to zero
3742 % parskip, or the item text will crash with the heading. On the
3743 % other hand, when there is normal text preceding the item (as there
3744 % usually is), we do want to zero parskip, or there would be too much
3745 % space. In that case, we won't have a \nobreak before. At least
3746 % that's the theory.
3747 \ifnum\lastpenalty<10000 \parskip=0in \fi
3749 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3751 \vadjust{\penalty 1200}}% not good to break after first line of item.
3755 % \splitoff TOKENS\endmark defines \first to be the first token in
3756 % TOKENS, and \rest to be the remainder.
3758 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3760 % Allow an optional argument of an uppercase letter, lowercase letter,
3761 % or number, to specify the first label in the enumerated list. No
3762 % argument is the same as `1'.
3764 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3765 \def\enumeratey #1 #2\endenumeratey{%
3766 % If we were given no argument, pretend we were given `1'.
3768 \ifx\thearg\empty \def\thearg{1}\fi
3770 % Detect if the argument is a single token. If so, it might be a
3771 % letter. Otherwise, the only valid thing it can be is a number.
3772 % (We will always have one token, because of the test we just made.
3773 % This is a good thing, since \splitoff doesn't work given nothing at
3774 % all -- the first parameter is undelimited.)
3775 \expandafter\splitoff\thearg\endmark
3777 % Only one token in the argument. It could still be anything.
3778 % A ``lowercase letter'' is one whose \lccode is nonzero.
3779 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3780 % not equal to itself.
3781 % Otherwise, we assume it's a number.
3783 % We need the \relax at the end of the \ifnum lines to stop TeX from
3784 % continuing to look for a <number>.
3786 \ifnum\lccode\expandafter`\thearg=0\relax
3787 \numericenumerate % a number (we hope)
3790 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3791 \lowercaseenumerate % lowercase letter
3793 \uppercaseenumerate % uppercase letter
3797 % Multiple tokens in the argument. We hope it's a number.
3802 % An @enumerate whose labels are integers. The starting integer is
3805 \def\numericenumerate{%
3807 \startenumeration{\the\itemno}%
3810 % The starting (lowercase) letter is in \thearg.
3811 \def\lowercaseenumerate{%
3812 \itemno = \expandafter`\thearg
3814 % Be sure we're not beyond the end of the alphabet.
3816 \errmessage{No more lowercase letters in @enumerate; get a bigger
3823 % The starting (uppercase) letter is in \thearg.
3824 \def\uppercaseenumerate{%
3825 \itemno = \expandafter`\thearg
3827 % Be sure we're not beyond the end of the alphabet.
3829 \errmessage{No more uppercase letters in @enumerate; get a bigger
3836 % Call \doitemize, adding a period to the first argument and supplying the
3837 % common last two arguments. Also subtract one from the initial value in
3838 % \itemno, since @item increments \itemno.
3840 \def\startenumeration#1{%
3841 \advance\itemno by -1
3842 \doitemize{#1.}\flushcr
3845 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3848 \def\alphaenumerate{\enumerate{a}}
3849 \def\capsenumerate{\enumerate{A}}
3850 \def\Ealphaenumerate{\Eenumerate}
3851 \def\Ecapsenumerate{\Eenumerate}
3854 % @multitable macros
3855 % Amy Hendrickson, 8/18/94, 3/6/96
3857 % @multitable ... @end multitable will make as many columns as desired.
3858 % Contents of each column will wrap at width given in preamble. Width
3859 % can be specified either with sample text given in a template line,
3860 % or in percent of \hsize, the current width of text on page.
3862 % Table can continue over pages but will only break between lines.
3866 % Either define widths of columns in terms of percent of \hsize:
3867 % @multitable @columnfractions .25 .3 .45
3870 % Numbers following @columnfractions are the percent of the total
3871 % current hsize to be used for each column. You may use as many
3872 % columns as desired.
3875 % Or use a template:
3876 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3878 % using the widest term desired in each column.
3880 % Each new table line starts with @item, each subsequent new column
3881 % starts with @tab. Empty columns may be produced by supplying @tab's
3882 % with nothing between them for as many times as empty columns are needed,
3883 % ie, @tab@tab@tab will produce two empty columns.
3885 % @item, @tab do not need to be on their own lines, but it will not hurt
3888 % Sample multitable:
3890 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3891 % @item first col stuff @tab second col stuff @tab third col
3898 % @item first col stuff @tab second col stuff
3899 % @tab Many paragraphs of text may be used in any column.
3901 % They will wrap at the width determined by the template.
3902 % @item@tab@tab This will be in third column.
3905 % Default dimensions may be reset by user.
3906 % @multitableparskip is vertical space between paragraphs in table.
3907 % @multitableparindent is paragraph indent in table.
3908 % @multitablecolmargin is horizontal space to be left between columns.
3909 % @multitablelinespace is space to leave between table items, baseline
3911 % 0pt means it depends on current normal line spacing.
3913 \newskip\multitableparskip
3914 \newskip\multitableparindent
3915 \newdimen\multitablecolspace
3916 \newskip\multitablelinespace
3917 \multitableparskip=0pt
3918 \multitableparindent=6pt
3919 \multitablecolspace=12pt
3920 \multitablelinespace=0pt
3922 % Macros used to set up halign preamble:
3924 \let\endsetuptable\relax
3925 \def\xendsetuptable{\endsetuptable}
3926 \let\columnfractions\relax
3927 \def\xcolumnfractions{\columnfractions}
3930 % #1 is the @columnfraction, usually a decimal number like .5, but might
3931 % be just 1. We just use it, whatever it is.
3933 \def\pickupwholefraction#1 {%
3934 \global\advance\colcount by 1
3935 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3942 \ifx\firstarg\xendsetuptable
3945 \ifx\firstarg\xcolumnfractions
3946 \global\setpercenttrue
3949 \let\go\pickupwholefraction
3951 \global\advance\colcount by 1
3952 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3953 % separator; typically that is always in the input, anyway.
3954 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3957 \ifx\go\pickupwholefraction
3958 % Put the argument back for the \pickupwholefraction call, so
3959 % we'll always have a period there to be parsed.
3960 \def\go{\pickupwholefraction#1}%
3962 \let\go = \setuptable
3968 % multitable-only commands.
3970 % @headitem starts a heading row, which we typeset in bold. Assignments
3971 % have to be global since we are inside the implicit group of an
3972 % alignment entry. \everycr below resets \everytab so we don't have to
3973 % undo it ourselves.
3974 \def\headitemfont{\b}% for people to use in the template row; not changeable
3976 \checkenv\multitable
3978 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3979 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3980 \the\everytab % for the first item
3983 % default for tables with no headings.
3984 \let\headitemcrhook=\relax
3986 % A \tab used to include \hskip1sp. But then the space in a template
3987 % line is not enough. That is bad. So let's go back to just `&' until
3988 % we again encounter the problem the 1sp was intended to solve.
3989 % --karl, nathan@acm.org, 20apr99.
3990 \def\tab{\checkenv\multitable &\the\everytab}%
3992 % @multitable ... @end multitable definitions:
3994 \newtoks\everytab % insert after every tab.
3996 \envdef\multitable{%
4000 % @item within a multitable starts a normal row.
4001 % We use \def instead of \let so that if one of the multitable entries
4002 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4003 % \endtemplate) expanding \doitemize.
4008 \setmultitablespacing
4009 \parskip=\multitableparskip
4010 \parindent=\multitableparindent
4016 \global\everytab={}% Reset from possible headitem.
4017 \global\colcount=0 % Reset the column counter.
4019 % Check for saved footnotes, etc.:
4022 % Perhaps a \nobreak, then reset:
4024 \global\let\headitemcrhook=\relax
4028 \parsearg\domultitable
4030 \def\domultitable#1{%
4031 % To parse everything between @multitable and @item:
4032 \setuptable#1 \endsetuptable
4034 % This preamble sets up a generic column definition, which will
4035 % be used as many times as user calls for columns.
4036 % \vtop will set a single line and will also let text wrap and
4037 % continue for many paragraphs if desired.
4039 \global\advance\colcount by 1
4042 % Use the current \colcount to find the correct column width:
4043 \hsize=\expandafter\csname col\the\colcount\endcsname
4045 % In order to keep entries from bumping into each other
4046 % we will add a \leftskip of \multitablecolspace to all columns after
4049 % If a template has been used, we will add \multitablecolspace
4050 % to the width of each template entry.
4052 % If the user has set preamble in terms of percent of \hsize we will
4053 % use that dimension as the width of the column, and the \leftskip
4054 % will keep entries from bumping into each other. Table will start at
4055 % left margin and final column will justify at right margin.
4057 % Make sure we don't inherit \rightskip from the outer environment.
4060 % The first column will be indented with the surrounding text.
4061 \advance\hsize by\leftskip
4064 % If user has not set preamble in terms of percent of \hsize
4065 % we will advance \hsize by \multitablecolspace.
4066 \advance\hsize by \multitablecolspace
4068 % In either case we will make \leftskip=\multitablecolspace:
4069 \leftskip=\multitablecolspace
4071 % Ignoring space at the beginning and end avoids an occasional spurious
4072 % blank line, when TeX decides to break the line at the space before the
4073 % box from the multistrut, so the strut ends up on a line by itself.
4075 % @multitable @columnfractions .11 .89
4077 % @tab Legal holiday which is valid in major parts of the whole country.
4078 % Is automatically provided with highlighting sequences respectively
4079 % marking characters.
4080 \noindent\ignorespaces##\unskip\multistrut
4085 \egroup % end the \halign
4086 \global\setpercentfalse
4089 \def\setmultitablespacing{%
4090 \def\multistrut{\strut}% just use the standard line spacing
4092 % Compute \multitablelinespace (if not defined by user) for use in
4093 % \multitableparskip calculation. We used define \multistrut based on
4094 % this, but (ironically) that caused the spacing to be off.
4095 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4096 \ifdim\multitablelinespace=0pt
4097 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4098 \global\advance\multitablelinespace by-\ht0
4100 % Test to see if parskip is larger than space between lines of
4101 % table. If not, do nothing.
4102 % If so, set to same dimension as multitablelinespace.
4103 \ifdim\multitableparskip>\multitablelinespace
4104 \global\multitableparskip=\multitablelinespace
4105 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4106 % than skip between lines in the table.
4108 \ifdim\multitableparskip=0pt
4109 \global\multitableparskip=\multitablelinespace
4110 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4111 % than skip between lines in the table.
4115 \message{conditionals,}
4117 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4118 % @ifnotxml always succeed. They currently do nothing; we don't
4119 % attempt to check whether the conditionals are properly nested. But we
4120 % have to remember that they are conditionals, so that @end doesn't
4121 % attempt to close an environment group.
4124 \expandafter\let\csname #1\endcsname = \relax
4125 \expandafter\let\csname iscond.#1\endcsname = 1
4128 \makecond{ifnotdocbook}
4129 \makecond{ifnothtml}
4130 \makecond{ifnotinfo}
4131 \makecond{ifnotplaintext}
4134 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4136 \def\direntry{\doignore{direntry}}
4137 \def\documentdescription{\doignore{documentdescription}}
4138 \def\docbook{\doignore{docbook}}
4139 \def\html{\doignore{html}}
4140 \def\ifdocbook{\doignore{ifdocbook}}
4141 \def\ifhtml{\doignore{ifhtml}}
4142 \def\ifinfo{\doignore{ifinfo}}
4143 \def\ifnottex{\doignore{ifnottex}}
4144 \def\ifplaintext{\doignore{ifplaintext}}
4145 \def\ifxml{\doignore{ifxml}}
4146 \def\ignore{\doignore{ignore}}
4147 \def\menu{\doignore{menu}}
4148 \def\xml{\doignore{xml}}
4150 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4152 % A count to remember the depth of nesting.
4153 \newcount\doignorecount
4155 \def\doignore#1{\begingroup
4156 % Scan in ``verbatim'' mode:
4158 \catcode`\@ = \other
4159 \catcode`\{ = \other
4160 \catcode`\} = \other
4162 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4165 % Count number of #1's that we've seen.
4168 % Swallow text until we reach the matching `@end #1'.
4172 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4175 \gdef\dodoignore#1{%
4176 % #1 contains the command name as a string, e.g., `ifinfo'.
4178 % Define a command to find the next `@end #1'.
4179 \long\def\doignoretext##1^^M@end #1{%
4180 \doignoretextyyy##1^^M@#1\_STOP_}%
4182 % And this command to find another #1 command, at the beginning of a
4183 % line. (Otherwise, we would consider a line `@c @ifset', for
4184 % example, to count as an @ifset for nesting.)
4185 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4187 % And now expand that command.
4192 \def\doignoreyyy#1{%
4194 \ifx\temp\empty % Nothing found.
4195 \let\next\doignoretextzzz
4196 \else % Found a nested condition, ...
4197 \advance\doignorecount by 1
4198 \let\next\doignoretextyyy % ..., look for another.
4199 % If we're here, #1 ends with ^^M\ifinfo (for example).
4201 \next #1% the token \_STOP_ is present just after this macro.
4204 % We have to swallow the remaining "\_STOP_".
4206 \def\doignoretextzzz#1{%
4207 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4208 \let\next\enddoignore
4209 \else % Still inside a nested condition.
4210 \advance\doignorecount by -1
4211 \let\next\doignoretext % Look for the next @end.
4216 % Finish off ignored text.
4218 % Ignore anything after the last `@end #1'; this matters in verbatim
4219 % environments, where otherwise the newline after an ignored conditional
4220 % would result in a blank line in the output.
4221 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4225 % @set VAR sets the variable VAR to an empty value.
4226 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4228 % Since we want to separate VAR from REST-OF-LINE (which might be
4229 % empty), we can't just use \parsearg; we have to insert a space of our
4230 % own to delimit the rest of the line, and then take it out again if we
4232 % We rely on the fact that \parsearg sets \catcode`\ =10.
4234 \parseargdef\set{\setyyy#1 \endsetyyy}
4235 \def\setyyy#1 #2\endsetyyy{%
4237 \makevalueexpandable
4239 \edef\next{\gdef\makecsname{SET#1}}%
4247 % Remove the trailing space \setxxx inserted.
4248 \def\setzzz#1 \endsetzzz{\next{#1}}
4250 % @clear VAR clears (i.e., unsets) the variable VAR.
4252 \parseargdef\clear{%
4254 \makevalueexpandable
4255 \global\expandafter\let\csname SET#1\endcsname=\relax
4259 % @value{foo} gets the text saved in variable foo.
4260 \def\value{\begingroup\makevalueexpandable\valuexxx}
4261 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4263 \catcode`\-=\active \catcode`\_=\active
4265 \gdef\makevalueexpandable{%
4266 \let\value = \expandablevalue
4267 % We don't want these characters active, ...
4268 \catcode`\-=\other \catcode`\_=\other
4269 % ..., but we might end up with active ones in the argument if
4270 % we're called from @code, as @code{@value{foo-bar_}}, though.
4271 % So \let them to their normal equivalents.
4272 \let-\normaldash \let_\normalunderscore
4276 % We have this subroutine so that we can handle at least some @value's
4277 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4278 % The command has to be fully expandable (if the variable is set), since
4279 % the result winds up in the index file. This means that if the
4280 % variable's value contains other Texinfo commands, it's almost certain
4281 % it will fail (although perhaps we could fix that with sufficient work
4282 % to do a one-level expansion on the result, instead of complete).
4284 % Unfortunately, this has the consequence that when _ is in the *value*
4285 % of an @set, it does not print properly in the roman fonts (get the cmr
4286 % dot accent at position 126 instead). No fix comes to mind, and it's
4287 % been this way since 2003 or earlier, so just ignore it.
4289 \def\expandablevalue#1{%
4290 \expandafter\ifx\csname SET#1\endcsname\relax
4291 {[No value for ``#1'']}%
4292 \message{Variable `#1', used in @value, is not set.}%
4294 \csname SET#1\endcsname
4298 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4301 % To get the special treatment we need for `@end ifset,' we call
4302 % \makecond and then redefine.
4305 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4308 \makevalueexpandable
4310 \expandafter\ifx\csname SET#2\endcsname\relax
4311 #1% If not set, redefine \next.
4316 \def\ifsetfail{\doignore{ifset}}
4318 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4319 % defined with @set, or has been undefined with @clear.
4321 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4322 % above code: if the variable is not set, do nothing, if it is set,
4323 % then redefine \next to \ifclearfail.
4326 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4327 \def\ifclearfail{\doignore{ifclear}}
4329 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4330 % without the @) is in fact defined. We can only feasibly check at the
4331 % TeX level, so something like `mathcode' is going to considered
4332 % defined even though it is not a Texinfo command.
4334 \makecond{ifcommanddefined}
4335 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4337 \def\doifcmddefined#1#2{{%
4338 \makevalueexpandable
4340 \expandafter\ifx\csname #2\endcsname\relax
4341 #1% If not defined, \let\next as above.
4346 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4348 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4349 \makecond{ifcommandnotdefined}
4350 \def\ifcommandnotdefined{%
4351 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4352 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4354 % Set the `txicommandconditionals' variable, so documents have a way to
4355 % test if the @ifcommand...defined conditionals are available.
4356 \set txicommandconditionals
4358 % @dircategory CATEGORY -- specify a category of the dir file
4359 % which this file should belong to. Ignore this in TeX.
4360 \let\dircategory=\comment
4362 % @defininfoenclose.
4363 \let\definfoenclose=\comment
4367 % Index generation facilities
4369 % Define \newwrite to be identical to plain tex's \newwrite
4370 % except not \outer, so it can be used within macros and \if's.
4371 \edef\newwrite{\makecsname{ptexnewwrite}}
4373 % \newindex {foo} defines an index named foo.
4374 % It automatically defines \fooindex such that
4375 % \fooindex ...rest of line... puts an entry in the index foo.
4376 % It also defines \fooindfile to be the number of the output channel for
4377 % the file that accumulates this index. The file's extension is foo.
4378 % The name of an index should be no more than 2 characters long
4379 % for the sake of vms.
4383 \expandafter\newwrite \csname#1indfile\endcsname
4384 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4386 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4387 \noexpand\doindex{#1}}
4390 % @defindex foo == \newindex{foo}
4392 \def\defindex{\parsearg\newindex}
4394 % Define @defcodeindex, like @defindex except put all entries in @code.
4396 \def\defcodeindex{\parsearg\newcodeindex}
4398 \def\newcodeindex#1{%
4400 \expandafter\newwrite \csname#1indfile\endcsname
4401 \openout \csname#1indfile\endcsname \jobname.#1
4403 \expandafter\xdef\csname#1index\endcsname{%
4404 \noexpand\docodeindex{#1}}%
4408 % @synindex foo bar makes index foo feed into index bar.
4409 % Do this instead of @defindex foo if you don't want it as a separate index.
4411 % @syncodeindex foo bar similar, but put all entries made for index foo
4414 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4415 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4417 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4418 % #3 the target index (bar).
4419 \def\dosynindex#1#2#3{%
4420 % Only do \closeout if we haven't already done it, else we'll end up
4421 % closing the target index.
4422 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4423 % The \closeout helps reduce unnecessary open files; the limit on the
4424 % Acorn RISC OS is a mere 16 files.
4425 \expandafter\closeout\csname#2indfile\endcsname
4426 \expandafter\let\csname donesynindex#2\endcsname = 1
4428 % redefine \fooindfile:
4429 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4430 \expandafter\let\csname#2indfile\endcsname=\temp
4431 % redefine \fooindex:
4432 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4435 % Define \doindex, the driver for all \fooindex macros.
4436 % Argument #1 is generated by the calling \fooindex macro,
4437 % and it is "foo", the name of the index.
4439 % \doindex just uses \parsearg; it calls \doind for the actual work.
4440 % This is because \doind is more useful to call from other macros.
4442 % There is also \dosubind {index}{topic}{subtopic}
4443 % which makes an entry in a two-level index such as the operation index.
4445 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4446 \def\singleindexer #1{\doind{\indexname}{#1}}
4448 % like the previous two, but they put @code around the argument.
4449 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4450 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4452 % Take care of Texinfo commands that can appear in an index entry.
4453 % Since there are some commands we want to expand, and others we don't,
4454 % we have to laboriously prevent expansion for those that we don't.
4457 \escapechar = `\\ % use backslash in output files.
4458 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4459 \def\ {\realbackslash\space }%
4461 % Need these unexpandable (because we define \tt as a dummy)
4462 % definitions when @{ or @} appear in index entry text. Also, more
4463 % complicated, when \tex is in effect and \{ is a \delimiter again.
4464 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4465 % braces and backslashes are used only as delimiters. Perhaps we
4466 % should use @lbracechar and @rbracechar?
4467 \def\{{{\tt\char123}}%
4468 \def\}{{\tt\char125}}%
4470 % Do the redefinitions.
4474 % For the aux and toc files, @ is the escape character. So we want to
4475 % redefine everything using @ as the escape character (instead of
4476 % \realbackslash, still used for index files). When everything uses @,
4477 % this will be simpler.
4482 \let\{ = \lbraceatcmd
4483 \let\} = \rbraceatcmd
4485 % Do the redefinitions.
4490 % Called from \indexdummies and \atdummies.
4492 \def\commondummies{%
4493 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4494 % preventing its expansion. This is used only for control words,
4495 % not control letters, because the \space would be incorrect for
4496 % control characters, but is needed to separate the control word
4497 % from whatever follows.
4499 % For control letters, we have \definedummyletter, which omits the
4502 % These can be used both for control words that take an argument and
4503 % those that do not. If it is followed by {arg} in the input, then
4504 % that will dutifully get written to the index (or wherever).
4506 \def\definedummyword ##1{\def##1{\string##1\space}}%
4507 \def\definedummyletter##1{\def##1{\string##1}}%
4508 \let\definedummyaccent\definedummyletter
4510 \commondummiesnofonts
4512 \definedummyletter\_%
4513 \definedummyletter\-%
4515 % Non-English letters.
4526 \definedummyword\exclamdown
4530 \definedummyword\ordf
4531 \definedummyword\ordm
4532 \definedummyword\questiondown
4536 % Although these internal commands shouldn't show up, sometimes they do.
4538 \definedummyword\gtr
4539 \definedummyword\hat
4540 \definedummyword\less
4543 \definedummyword\tclose
4546 \definedummyword\LaTeX
4547 \definedummyword\TeX
4549 % Assorted special characters.
4550 \definedummyword\arrow
4551 \definedummyword\bullet
4552 \definedummyword\comma
4553 \definedummyword\copyright
4554 \definedummyword\registeredsymbol
4555 \definedummyword\dots
4556 \definedummyword\enddots
4557 \definedummyword\entrybreak
4558 \definedummyword\equiv
4559 \definedummyword\error
4560 \definedummyword\euro
4561 \definedummyword\expansion
4562 \definedummyword\geq
4563 \definedummyword\guillemetleft
4564 \definedummyword\guillemetright
4565 \definedummyword\guilsinglleft
4566 \definedummyword\guilsinglright
4567 \definedummyword\lbracechar
4568 \definedummyword\leq
4569 \definedummyword\mathopsup
4570 \definedummyword\minus
4571 \definedummyword\ogonek
4572 \definedummyword\pounds
4573 \definedummyword\point
4574 \definedummyword\print
4575 \definedummyword\quotedblbase
4576 \definedummyword\quotedblleft
4577 \definedummyword\quotedblright
4578 \definedummyword\quoteleft
4579 \definedummyword\quoteright
4580 \definedummyword\quotesinglbase
4581 \definedummyword\rbracechar
4582 \definedummyword\result
4583 \definedummyword\sub
4584 \definedummyword\sup
4585 \definedummyword\textdegree
4587 % We want to disable all macros so that they are not expanded by \write.
4590 \normalturnoffactive
4592 % Handle some cases of @value -- where it does not contain any
4593 % (non-fully-expandable) commands.
4594 \makevalueexpandable
4597 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4599 \def\commondummiesnofonts{%
4600 % Control letters and accents.
4601 \definedummyletter\!%
4602 \definedummyaccent\"%
4603 \definedummyaccent\'%
4604 \definedummyletter\*%
4605 \definedummyaccent\,%
4606 \definedummyletter\.%
4607 \definedummyletter\/%
4608 \definedummyletter\:%
4609 \definedummyaccent\=%
4610 \definedummyletter\?%
4611 \definedummyaccent\^%
4612 \definedummyaccent\`%
4613 \definedummyaccent\~%
4617 \definedummyword\dotaccent
4618 \definedummyword\ogonek
4619 \definedummyword\ringaccent
4620 \definedummyword\tieaccent
4621 \definedummyword\ubaraccent
4622 \definedummyword\udotaccent
4623 \definedummyword\dotless
4625 % Texinfo font commands.
4629 \definedummyword\sansserif
4631 \definedummyword\slanted
4634 % Commands that take arguments.
4635 \definedummyword\abbr
4636 \definedummyword\acronym
4637 \definedummyword\anchor
4638 \definedummyword\cite
4639 \definedummyword\code
4640 \definedummyword\command
4641 \definedummyword\dfn
4642 \definedummyword\dmn
4643 \definedummyword\email
4644 \definedummyword\emph
4645 \definedummyword\env
4646 \definedummyword\file
4647 \definedummyword\image
4648 \definedummyword\indicateurl
4649 \definedummyword\inforef
4650 \definedummyword\kbd
4651 \definedummyword\key
4652 \definedummyword\math
4653 \definedummyword\option
4654 \definedummyword\pxref
4655 \definedummyword\ref
4656 \definedummyword\samp
4657 \definedummyword\strong
4658 \definedummyword\tie
4660 \definedummyword\uref
4661 \definedummyword\url
4662 \definedummyword\var
4663 \definedummyword\verb
4665 \definedummyword\xref
4668 % @macro mkind{arg1,arg2}
4672 % The space after the comma will end up in the temporary definition
4673 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4674 % expanded for the sake of the index, so we end up just seeing "bar".
4675 \let\xeatspaces = \eatspaces
4678 % For testing: output @{ and @} in index sort strings as \{ and \}.
4679 \newif\ifusebracesinindexes
4681 % \indexnofonts is used when outputting the strings to sort the index
4682 % by, and when constructing control sequence names. It eliminates all
4683 % control sequences and just writes whatever the best ASCII sort string
4684 % would be for a given command (usually its argument).
4687 % Accent commands should become @asis.
4688 \def\definedummyaccent##1{\let##1\asis}%
4689 % We can just ignore other control letters.
4690 \def\definedummyletter##1{\let##1\empty}%
4691 % All control words become @asis by default; overrides below.
4692 \let\definedummyword\definedummyaccent
4694 \commondummiesnofonts
4696 % Don't no-op \tt, since it isn't a user-level command
4697 % and is used in the definitions of the active chars like <, >, |, etc.
4698 % Likewise with the other plain tex font commands.
4703 \def\_{\normalunderscore}%
4704 \def\-{}% @- shouldn't affect sorting
4706 % Unfortunately, texindex is not prepared to handle braces in the
4707 % content at all. So for index sorting, we map @{ and @} to strings
4708 % starting with |, since that ASCII character is between ASCII { and }.
4709 \ifusebracesinindexes
4710 \def\lbracechar{\lbracecmd}%
4711 \def\rbracechar{\rbracecmd}%
4713 \def\lbracechar{|a}%
4714 \def\rbracechar{|b}%
4720 % Non-English letters.
4737 \def\questiondown{?}%
4744 % Assorted special characters.
4745 % (The following {} will end up in the sort string, but that's ok.)
4747 \def\bullet{bullet}%
4749 \def\copyright{copyright}%
4755 \def\expansion{==>}%
4757 \def\guillemetleft{<<}%
4758 \def\guillemetright{>>}%
4759 \def\guilsinglleft{<}%
4760 \def\guilsinglright{>}%
4764 \def\pounds{pounds}%
4766 \def\quotedblbase{"}%
4767 \def\quotedblleft{"}%
4768 \def\quotedblright{"}%
4771 \def\quotesinglbase{,}%
4772 \def\registeredsymbol{R}%
4776 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4777 \else \indexlquoteignore \fi
4779 % We need to get rid of all macros, leaving only the arguments (if present).
4780 % Of course this is not nearly correct, but it is the best we can do for now.
4781 % makeinfo does not expand macros in the argument to @deffn, which ends up
4782 % writing an index entry, and texindex isn't prepared for an index sort entry
4783 % that starts with \.
4785 % Since macro invocations are followed by braces, we can just redefine them
4786 % to take a single TeX argument. The case of a macro invocation that
4787 % goes to end-of-line is not handled.
4792 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4793 % ignore left quotes in the sort term.
4794 {\catcode`\`=\active
4795 \gdef\indexlquoteignore{\let`=\empty}}
4797 \let\indexbackslash=0 %overridden during \printindex.
4798 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4800 % Most index entries go through here, but \dosubind is the general case.
4801 % #1 is the index name, #2 is the entry text.
4802 \def\doind#1#2{\dosubind{#1}{#2}{}}
4804 % Workhorse for all \fooindexes.
4805 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4806 % empty if called from \doind, as we usually are (the main exception
4807 % is with most defuns, which call us directly).
4809 \def\dosubind#1#2#3{%
4812 % Store the main index entry text (including the third arg).
4814 % If third arg is present, precede it with a space.
4816 \ifx\thirdarg\empty \else
4817 \toks0 = \expandafter{\the\toks0 \space #3}%
4820 \edef\writeto{\csname#1indfile\endcsname}%
4822 \safewhatsit\dosubindwrite
4827 % Write the entry in \toks0 to the index file:
4829 \def\dosubindwrite{%
4830 % Put the index entry in the margin if desired.
4831 \ifx\SETmarginindex\relax\else
4832 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4835 % Remember, we are within a group.
4836 \indexdummies % Must do this here, since \bf, etc expand at this stage
4837 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4838 % so it will be output as is; and it will print as backslash.
4840 % Process the index entry with all font commands turned off, to
4841 % get the string to sort by.
4843 \edef\temp{\the\toks0}% need full expansion
4844 \xdef\indexsorttmp{\temp}%
4847 % Set up the complete index entry, with both the sort key and
4848 % the original text, including any font commands. We write
4849 % three arguments to \entry to the .?? file (four in the
4850 % subentry case), texindex reduces to two when writing the .??s
4854 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4859 % Take care of unwanted page breaks/skips around a whatsit:
4861 % If a skip is the last thing on the list now, preserve it
4862 % by backing up by \lastskip, doing the \write, then inserting
4863 % the skip again. Otherwise, the whatsit generated by the
4864 % \write or \pdfdest will make \lastskip zero. The result is that
4865 % sequences like this:
4869 % will have extra space inserted, because the \medbreak in the
4870 % start of the @defun won't see the skip inserted by the @end of
4871 % the previous defun.
4873 % But don't do any of this if we're not in vertical mode. We
4874 % don't want to do a \vskip and prematurely end a paragraph.
4876 % Avoid page breaks due to these extra skips, too.
4878 % But wait, there is a catch there:
4879 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4880 % sufficient for this purpose, as it ignores stretch and shrink parts
4881 % of the skip. The only way seems to be to check the textual
4882 % representation of the skip.
4884 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4885 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4887 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4889 \newskip\whatsitskip
4890 \newcount\whatsitpenalty
4894 \def\safewhatsit#1{\ifhmode
4897 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4898 \whatsitskip = \lastskip
4899 \edef\lastskipmacro{\the\lastskip}%
4900 \whatsitpenalty = \lastpenalty
4902 % If \lastskip is nonzero, that means the last item was a
4903 % skip. And since a skip is discardable, that means this
4904 % -\whatsitskip glue we're inserting is preceded by a
4905 % non-discardable item, therefore it is not a potential
4906 % breakpoint, therefore no \nobreak needed.
4907 \ifx\lastskipmacro\zeroskipmacro
4914 \ifx\lastskipmacro\zeroskipmacro
4915 % If \lastskip was zero, perhaps the last item was a penalty, and
4916 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4917 % to re-insert the same penalty (values >10000 are used for various
4918 % signals); since we just inserted a non-discardable item, any
4919 % following glue (such as a \parskip) would be a breakpoint. For example:
4920 % @deffn deffn-whatever
4921 % @vindex index-whatever
4923 % would allow a break between the index-whatever whatsit
4924 % and the "Description." paragraph.
4925 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4927 % On the other hand, if we had a nonzero \lastskip,
4928 % this make-up glue would be preceded by a non-discardable item
4929 % (the whatsit from the \write), so we must insert a \nobreak.
4930 \nobreak\vskip\whatsitskip
4934 % The index entry written in the file actually looks like
4935 % \entry {sortstring}{page}{topic}
4937 % \entry {sortstring}{page}{topic}{subtopic}
4938 % The texindex program reads in these files and writes files
4939 % containing these kinds of lines:
4941 % before the first topic whose initial is c
4942 % \entry {topic}{pagelist}
4943 % for a topic that is used without subtopics
4945 % for the beginning of a topic that is used with subtopics
4946 % \secondary {subtopic}{pagelist}
4947 % for each subtopic.
4949 % Define the user-accessible indexing commands
4950 % @findex, @vindex, @kindex, @cindex.
4952 \def\findex {\fnindex}
4953 \def\kindex {\kyindex}
4954 \def\cindex {\cpindex}
4955 \def\vindex {\vrindex}
4956 \def\tindex {\tpindex}
4957 \def\pindex {\pgindex}
4959 \def\cindexsub {\begingroup\obeylines\cindexsub}
4961 \gdef\cindexsub "#1" #2^^M{\endgroup %
4962 \dosubind{cp}{#2}{#1}}}
4964 % Define the macros used in formatting output of the sorted index material.
4966 % @printindex causes a particular index (the ??s file) to get printed.
4967 % It does not print any chapter heading (usually an @unnumbered).
4969 \parseargdef\printindex{\begingroup
4970 \dobreak \chapheadingskip{10000}%
4975 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4977 % See if the index file exists and is nonempty.
4978 % Change catcode of @ here so that if the index file contains
4980 % as its first line, TeX doesn't complain about mismatched braces
4981 % (because it thinks @} is a control sequence).
4983 \openin 1 \jobname.#1s
4985 % \enddoublecolumns gets confused if there is no text in the index,
4986 % and it loses the chapter title and the aux file entries for the
4987 % index. The easiest way to prevent this problem is to make sure
4988 % there is some text.
4989 \putwordIndexNonexistent
4992 % If the index file exists but is empty, then \openin leaves \ifeof
4993 % false. We have to make TeX try to read something from the file, so
4994 % it can discover if there is anything in it.
4997 \putwordIndexIsEmpty
4999 % Index files are almost Texinfo source, but we use \ as the escape
5000 % character. It would be better to use @, but that's too big a change
5001 % to make right now.
5002 \def\indexbackslash{\backslashcurfont}%
5013 % These macros are used by the sorted index file itself.
5014 % Change them to control the appearance of the index.
5017 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5018 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5020 \gdef\initialfonts{%
5023 % Some changes for non-alphabetic characters. Using the glyphs from the
5024 % math fonts looks more consistent than the typewriter font used elsewhere
5025 % for these characters.
5026 % Can't get bold backslash so don't use bold forward slash
5028 \def/{{\secrmnotbold \normalslash}}
5030 \def-{{\normalhyphen\normalhyphen}}
5034 \leavevmode \kern.07em \vbox{\hrule width.33em height.06ex}\kern .07em }
5038 \def+{$\normalplus$}
5039 \let"=\normaldoublequote
5049 % Remove any glue we may have, we'll be inserting our own.
5052 % We like breaks before the index initials, so insert a bonus.
5054 \vskip 0pt plus 3\baselineskip
5056 \vskip 0pt plus -3\baselineskip
5058 % Typeset the initial. Making this add up to a whole number of
5059 % baselineskips increases the chance of the dots lining up from column
5060 % to column. It still won't often be perfect, because of the stretch
5061 % we need before each entry, but it's better.
5063 % No shrink because it confuses \balancecolumns.
5064 \vskip 1.67\baselineskip plus .5\baselineskip
5065 \leftline{\secbf #1}%
5066 % Do our best not to break after the initial.
5068 \vskip .33\baselineskip plus .1\baselineskip
5069 \egroup % \initialfonts
5072 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5073 % then page number (#2) flushed to the right margin. It is used for index
5074 % and table of contents entries. The paragraph is indented by \leftskip.
5076 % A straightforward implementation would start like this:
5077 % \def\entry#1#2{...
5078 % But this freezes the catcodes in the argument, and can cause problems to
5079 % @code, which sets - active. This problem was fixed by a kludge---
5080 % ``-'' was active throughout whole index, but this isn't really right.
5081 % The right solution is to prevent \entry from swallowing the whole text.
5086 % Start a new paragraph if necessary, so our assignments below can't
5087 % affect previous text.
5090 % Do not fill out the last line with white space.
5093 % No extra space above this paragraph.
5096 % Do not prefer a separate line ending with a hyphen to fewer lines.
5097 \finalhyphendemerits = 0
5099 % \hangindent is only relevant when the entry text and page number
5100 % don't both fit on one line. In that case, bob suggests starting the
5101 % dots pretty far over on the line. Unfortunately, a large
5102 % indentation looks wrong when the entry text itself is broken across
5103 % lines. So we use a small indentation and put up with long leaders.
5105 % \hangafter is reset to 1 (which is the value we want) at the start
5106 % of each paragraph, so we need not do anything with that.
5109 % When the entry text needs to be broken, just fill out the first line
5111 \rightskip = 0pt plus1fil
5113 % A bit of stretch before each entry for the benefit of balancing
5117 % When reading the text of entry, convert explicit line breaks
5118 % from @* into spaces. The user might give these in long section
5119 % titles, for instance.
5120 \def\*{\unskip\space\ignorespaces}%
5121 \def\entrybreak{\hfil\break}%
5123 % Swallow the left brace of the text (first parameter):
5124 \afterassignment\doentry
5127 \def\entrybreak{\unskip\space\ignorespaces}%
5129 \bgroup % Instead of the swallowed brace.
5131 \aftergroup\finishentry
5132 % And now comes the text of the entry.
5134 \def\finishentry#1{%
5135 % #1 is the page number.
5137 % The following is kludged to not output a line of dots in the index if
5138 % there are no page numbers. The next person who breaks this will be
5139 % cursed by a Unix daemon.
5140 \setbox\boxA = \hbox{#1}%
5141 \ifdim\wd\boxA = 0pt
5145 % If we must, put the page number on a line of its own, and fill out
5146 % this line with blank space. (The \hfil is overwhelmed with the
5147 % fill leaders glue in \indexdotfill if the page number does fit.)
5149 \null\nobreak\indexdotfill % Have leaders before the page number.
5151 % The `\ ' here is removed by the implicit \unskip that TeX does as
5152 % part of (the primitive) \par. Without it, a spurious underfull
5165 % Like plain.tex's \dotfill, except uses up at least 1 em.
5166 \def\indexdotfill{\cleaders
5167 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5169 \def\primary #1{\line{#1\hfil}}
5171 \newskip\secondaryindent \secondaryindent=0.5cm
5172 \def\secondary#1#2{{%
5177 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5179 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5186 % Define two-column mode, which we use to typeset indexes.
5187 % Adapted from the TeXbook, page 416, which is to say,
5188 % the manmac.tex format used to print the TeXbook itself.
5192 \newdimen\doublecolumnhsize
5194 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5195 % Grab any single-column material above us.
5198 % Here is a possibility not foreseen in manmac: if we accumulate a
5199 % whole lot of material, we might end up calling this \output
5200 % routine twice in a row (see the doublecol-lose test, which is
5201 % essentially a couple of indexes with @setchapternewpage off). In
5202 % that case we just ship out what is in \partialpage with the normal
5203 % output routine. Generally, \partialpage will be empty when this
5204 % runs and this will be a no-op. See the indexspread.tex test case.
5205 \ifvoid\partialpage \else
5206 \onepageout{\pagecontents\partialpage}%
5209 \global\setbox\partialpage = \vbox{%
5210 % Unvbox the main output page.
5212 \kern-\topskip \kern\baselineskip
5215 \eject % run that output routine to set \partialpage
5217 % Use the double-column output routine for subsequent pages.
5218 \output = {\doublecolumnout}%
5220 % Change the page size parameters. We could do this once outside this
5221 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5222 % format, but then we repeat the same computation. Repeating a couple
5223 % of assignments once per index is clearly meaningless for the
5224 % execution time, so we may as well do it in one place.
5226 % First we halve the line length, less a little for the gutter between
5227 % the columns. We compute the gutter based on the line length, so it
5228 % changes automatically with the paper format. The magic constant
5229 % below is chosen so that the gutter has the same value (well, +-<1pt)
5230 % as it did when we hard-coded it.
5232 % We put the result in a separate register, \doublecolumhsize, so we
5233 % can restore it in \pagesofar, after \hsize itself has (potentially)
5236 \doublecolumnhsize = \hsize
5237 \advance\doublecolumnhsize by -.04154\hsize
5238 \divide\doublecolumnhsize by 2
5239 \hsize = \doublecolumnhsize
5241 % Double the \vsize as well. (We don't need a separate register here,
5242 % since nobody clobbers \vsize.)
5246 % The double-column output routine for all double-column pages except
5249 \def\doublecolumnout{%
5250 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5251 % Get the available space for the double columns -- the normal
5252 % (undoubled) page height minus any material left over from the
5256 \advance\dimen@ by -\ht\partialpage
5258 % box0 will be the left-hand column, box2 the right.
5259 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5260 \onepageout\pagesofar
5262 \penalty\outputpenalty
5265 % Re-output the contents of the output page -- any previous material,
5266 % followed by the two boxes we just split, in box0 and box2.
5270 \hsize = \doublecolumnhsize
5271 \wd0=\hsize \wd2=\hsize
5272 \hbox to\pagewidth{\box0\hfil\box2}%
5275 % All done with double columns.
5276 \def\enddoublecolumns{%
5277 % The following penalty ensures that the page builder is exercised
5278 % _before_ we change the output routine. This is necessary in the
5279 % following situation:
5281 % The last section of the index consists only of a single entry.
5282 % Before this section, \pagetotal is less than \pagegoal, so no
5283 % break occurs before the last section starts. However, the last
5284 % section, consisting of \initial and the single \entry, does not
5285 % fit on the page and has to be broken off. Without the following
5286 % penalty the page builder will not be exercised until \eject
5287 % below, and by that time we'll already have changed the output
5288 % routine to the \balancecolumns version, so the next-to-last
5289 % double-column page will be processed with \balancecolumns, which
5290 % is wrong: The two columns will go to the main vertical list, with
5291 % the broken-off section in the recent contributions. As soon as
5292 % the output routine finishes, TeX starts reconsidering the page
5293 % break. The two columns and the broken-off section both fit on the
5294 % page, because the two columns now take up only half of the page
5295 % goal. When TeX sees \eject from below which follows the final
5296 % section, it invokes the new output routine that we've set after
5297 % \balancecolumns below; \onepageout will try to fit the two columns
5298 % and the final section into the vbox of \pageheight (see
5299 % \pagebody), causing an overfull box.
5301 % Note that glue won't work here, because glue does not exercise the
5302 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5306 % Split the last of the double-column material. Leave it on the
5307 % current page, no automatic page break.
5310 % If we end up splitting too much material for the current page,
5311 % though, there will be another page break right after this \output
5312 % invocation ends. Having called \balancecolumns once, we do not
5313 % want to call it again. Therefore, reset \output to its normal
5314 % definition right away. (We hope \balancecolumns will never be
5315 % called on to balance too much material, but if it is, this makes
5316 % the output somewhat more palatable.)
5317 \global\output = {\onepageout{\pagecontents\PAGE}}%
5320 \endgroup % started in \begindoublecolumns
5322 % \pagegoal was set to the doubled \vsize above, since we restarted
5323 % the current page. We're now back to normal single-column
5324 % typesetting, so reset \pagegoal to the normal \vsize (after the
5325 % \endgroup where \vsize got restored).
5329 % Called at the end of the double column material.
5330 \def\balancecolumns{%
5331 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5333 \advance\dimen@ by \topskip
5334 \advance\dimen@ by-\baselineskip
5335 \divide\dimen@ by 2 % target to split to
5336 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5337 \splittopskip = \topskip
5338 % Loop until we get a decent breakpoint.
5342 \global\setbox3 = \copy0
5343 \global\setbox1 = \vsplit3 to \dimen@
5345 \global\advance\dimen@ by 1pt
5348 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5349 \setbox0=\vbox to\dimen@{\unvbox1}%
5350 \setbox2=\vbox to\dimen@{\unvbox3}%
5354 \catcode`\@ = \other
5357 \message{sectioning,}
5358 % Chapters, sections, etc.
5360 % Let's start with @part.
5361 \outer\parseargdef\part{\partzzz{#1}}
5365 \vskip.3\vsize % move it down on the page a bit
5367 \noindent \titlefonts\rmisbold #1\par % the text
5368 \let\lastnode=\empty % no node to associate with
5369 \writetocentry{part}{#1}{}% but put it in the toc
5370 \headingsoff % no headline or footline on the part page
5375 % \unnumberedno is an oxymoron. But we count the unnumbered
5376 % sections so that we can refer to them unambiguously in the pdf
5377 % outlines by their "section number". We avoid collisions with chapter
5378 % numbers by starting them at 10000. (If a document ever has 10000
5379 % chapters, we're in trouble anyway, I'm sure.)
5380 \newcount\unnumberedno \unnumberedno = 10000
5382 \newcount\secno \secno=0
5383 \newcount\subsecno \subsecno=0
5384 \newcount\subsubsecno \subsubsecno=0
5386 % This counter is funny since it counts through charcodes of letters A, B, ...
5387 \newcount\appendixno \appendixno = `\@
5389 % \def\appendixletter{\char\the\appendixno}
5390 % We do the following ugly conditional instead of the above simple
5391 % construct for the sake of pdftex, which needs the actual
5392 % letter in the expansion, not just typeset.
5394 \def\appendixletter{%
5395 \ifnum\appendixno=`A A%
5396 \else\ifnum\appendixno=`B B%
5397 \else\ifnum\appendixno=`C C%
5398 \else\ifnum\appendixno=`D D%
5399 \else\ifnum\appendixno=`E E%
5400 \else\ifnum\appendixno=`F F%
5401 \else\ifnum\appendixno=`G G%
5402 \else\ifnum\appendixno=`H H%
5403 \else\ifnum\appendixno=`I I%
5404 \else\ifnum\appendixno=`J J%
5405 \else\ifnum\appendixno=`K K%
5406 \else\ifnum\appendixno=`L L%
5407 \else\ifnum\appendixno=`M M%
5408 \else\ifnum\appendixno=`N N%
5409 \else\ifnum\appendixno=`O O%
5410 \else\ifnum\appendixno=`P P%
5411 \else\ifnum\appendixno=`Q Q%
5412 \else\ifnum\appendixno=`R R%
5413 \else\ifnum\appendixno=`S S%
5414 \else\ifnum\appendixno=`T T%
5415 \else\ifnum\appendixno=`U U%
5416 \else\ifnum\appendixno=`V V%
5417 \else\ifnum\appendixno=`W W%
5418 \else\ifnum\appendixno=`X X%
5419 \else\ifnum\appendixno=`Y Y%
5420 \else\ifnum\appendixno=`Z Z%
5421 % The \the is necessary, despite appearances, because \appendixletter is
5422 % expanded while writing the .toc file. \char\appendixno is not
5423 % expandable, thus it is written literally, thus all appendixes come out
5424 % with the same letter (or @) in the toc without it.
5425 \else\char\the\appendixno
5426 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5427 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5429 % Each @chapter defines these (using marks) as the number+name, number
5430 % and name of the chapter. Page headings and footings can use
5431 % these. @section does likewise.
5433 \def\thischapternum{}
5434 \def\thischaptername{}
5436 \def\thissectionnum{}
5437 \def\thissectionname{}
5439 \newcount\absseclevel % used to calculate proper heading level
5440 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5442 % @raisesections: treat @section as chapter, @subsection as section, etc.
5443 \def\raisesections{\global\advance\secbase by -1}
5444 \let\up=\raisesections % original BFox name
5446 % @lowersections: treat @chapter as section, @section as subsection, etc.
5447 \def\lowersections{\global\advance\secbase by 1}
5448 \let\down=\lowersections % original BFox name
5450 % we only have subsub.
5451 \chardef\maxseclevel = 3
5453 % A numbered section within an unnumbered changes to unnumbered too.
5454 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5455 \chardef\unnlevel = \maxseclevel
5457 % Trace whether the current chapter is an appendix or not:
5458 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5459 \def\chapheadtype{N}
5461 % Choose a heading macro
5462 % #1 is heading type
5463 % #2 is heading level
5464 % #3 is text for heading
5465 \def\genhead#1#2#3{%
5466 % Compute the abs. sec. level:
5468 \advance\absseclevel by \secbase
5469 % Make sure \absseclevel doesn't fall outside the range:
5470 \ifnum \absseclevel < 0
5473 \ifnum \absseclevel > 3
5480 \ifnum \absseclevel < \unnlevel
5481 \chardef\unnlevel = \absseclevel
5484 % Check for appendix sections:
5485 \ifnum \absseclevel = 0
5486 \edef\chapheadtype{\headtype}%
5488 \if \headtype A\if \chapheadtype N%
5489 \errmessage{@appendix... within a non-appendix chapter}%
5492 % Check for numbered within unnumbered:
5493 \ifnum \absseclevel > \unnlevel
5496 \chardef\unnlevel = 3
5499 % Now print the heading:
5503 \or \unnumberedseczzz{#3}%
5504 \or \unnumberedsubseczzz{#3}%
5505 \or \unnumberedsubsubseczzz{#3}%
5511 \or \appendixsectionzzz{#3}%
5512 \or \appendixsubseczzz{#3}%
5513 \or \appendixsubsubseczzz{#3}%
5519 \or \numberedsubseczzz{#3}%
5520 \or \numberedsubsubseczzz{#3}%
5524 \suppressfirstparagraphindent
5528 \def\numhead{\genhead N}
5529 \def\apphead{\genhead A}
5530 \def\unnmhead{\genhead U}
5532 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5533 % all lower-level sectioning counters to zero.
5535 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5536 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5537 \let\chaplevelprefix = \empty
5539 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5541 % section resetting is \global in case the chapter is in a group, such
5542 % as an @include file.
5543 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5544 \global\advance\chapno by 1
5547 \gdef\chaplevelprefix{\the\chapno.}%
5550 % \putwordChapter can contain complex things in translations.
5551 \toks0=\expandafter{\putwordChapter}%
5552 \message{\the\toks0 \space \the\chapno}%
5554 % Write the actual heading.
5555 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5557 % So @section and the like are numbered underneath this chapter.
5558 \global\let\section = \numberedsec
5559 \global\let\subsection = \numberedsubsec
5560 \global\let\subsubsection = \numberedsubsubsec
5563 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5565 \def\appendixzzz#1{%
5566 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5567 \global\advance\appendixno by 1
5568 \gdef\chaplevelprefix{\appendixletter.}%
5571 % \putwordAppendix can contain complex things in translations.
5572 \toks0=\expandafter{\putwordAppendix}%
5573 \message{\the\toks0 \space \appendixletter}%
5575 \chapmacro{#1}{Yappendix}{\appendixletter}%
5577 \global\let\section = \appendixsec
5578 \global\let\subsection = \appendixsubsec
5579 \global\let\subsubsection = \appendixsubsubsec
5582 % normally unnmhead0 calls unnumberedzzz:
5583 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5584 \def\unnumberedzzz#1{%
5585 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5586 \global\advance\unnumberedno by 1
5588 % Since an unnumbered has no number, no prefix for figures.
5589 \global\let\chaplevelprefix = \empty
5592 % This used to be simply \message{#1}, but TeX fully expands the
5593 % argument to \message. Therefore, if #1 contained @-commands, TeX
5594 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5595 % expanded @cite (which turns out to cause errors because \cite is meant
5596 % to be executed, not expanded).
5598 % Anyway, we don't want the fully-expanded definition of @cite to appear
5599 % as a result of the \message, we just want `@cite' itself. We use
5600 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5601 % simply yielding the contents of <toks register>. (We also do this for
5604 \message{(\the\toks0)}%
5606 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5608 \global\let\section = \unnumberedsec
5609 \global\let\subsection = \unnumberedsubsec
5610 \global\let\subsubsection = \unnumberedsubsubsec
5613 % @centerchap is like @unnumbered, but the heading is centered.
5614 \outer\parseargdef\centerchap{%
5615 % Well, we could do the following in a group, but that would break
5616 % an assumption that \chapmacro is called at the outermost level.
5617 % Thus we are safer this way: --kasal, 24feb04
5618 \let\centerparametersmaybe = \centerparameters
5620 \let\centerparametersmaybe = \relax
5623 % @top is like @unnumbered.
5628 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5630 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5631 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5634 % normally calls appendixsectionzzz:
5635 \outer\parseargdef\appendixsection{\apphead1{#1}}
5636 \def\appendixsectionzzz#1{%
5637 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5638 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5640 \let\appendixsec\appendixsection
5642 % normally calls unnumberedseczzz:
5643 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5644 \def\unnumberedseczzz#1{%
5645 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5646 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5651 % normally calls numberedsubseczzz:
5652 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5653 \def\numberedsubseczzz#1{%
5654 \global\subsubsecno=0 \global\advance\subsecno by 1
5655 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5658 % normally calls appendixsubseczzz:
5659 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5660 \def\appendixsubseczzz#1{%
5661 \global\subsubsecno=0 \global\advance\subsecno by 1
5662 \sectionheading{#1}{subsec}{Yappendix}%
5663 {\appendixletter.\the\secno.\the\subsecno}%
5666 % normally calls unnumberedsubseczzz:
5667 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5668 \def\unnumberedsubseczzz#1{%
5669 \global\subsubsecno=0 \global\advance\subsecno by 1
5670 \sectionheading{#1}{subsec}{Ynothing}%
5671 {\the\unnumberedno.\the\secno.\the\subsecno}%
5676 % normally numberedsubsubseczzz:
5677 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5678 \def\numberedsubsubseczzz#1{%
5679 \global\advance\subsubsecno by 1
5680 \sectionheading{#1}{subsubsec}{Ynumbered}%
5681 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5684 % normally appendixsubsubseczzz:
5685 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5686 \def\appendixsubsubseczzz#1{%
5687 \global\advance\subsubsecno by 1
5688 \sectionheading{#1}{subsubsec}{Yappendix}%
5689 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5692 % normally unnumberedsubsubseczzz:
5693 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5694 \def\unnumberedsubsubseczzz#1{%
5695 \global\advance\subsubsecno by 1
5696 \sectionheading{#1}{subsubsec}{Ynothing}%
5697 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5700 % These macros control what the section commands do, according
5701 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5702 % Define them by default for a numbered chapter.
5703 \let\section = \numberedsec
5704 \let\subsection = \numberedsubsec
5705 \let\subsubsection = \numberedsubsubsec
5707 % Define @majorheading, @heading and @subheading
5710 {\advance\chapheadingskip by 10pt \chapbreak }%
5711 \parsearg\chapheadingzzz
5714 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5715 \def\chapheadingzzz#1{%
5716 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5717 \nobreak\bigskip \nobreak
5718 \suppressfirstparagraphindent
5721 % @heading, @subheading, @subsubheading.
5722 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5723 \suppressfirstparagraphindent}
5724 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5725 \suppressfirstparagraphindent}
5726 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5727 \suppressfirstparagraphindent}
5729 % These macros generate a chapter, section, etc. heading only
5730 % (including whitespace, linebreaking, etc. around it),
5731 % given all the information in convenient, parsed form.
5733 % Args are the skip and penalty (usually negative)
5734 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5736 % Parameter controlling skip before chapter headings (if needed)
5737 \newskip\chapheadingskip
5739 % Define plain chapter starts, and page on/off switching for it.
5740 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5741 \def\chappager{\par\vfill\supereject}
5742 % Because \domark is called before \chapoddpage, the filler page will
5743 % get the headings for the next chapter, which is wrong. But we don't
5744 % care -- we just disable all headings on the filler page.
5756 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5759 \global\let\contentsalignmacro = \chappager
5760 \global\let\pchapsepmacro=\chapbreak
5761 \global\let\pagealignmacro=\chappager}
5764 \global\let\contentsalignmacro = \chappager
5765 \global\let\pchapsepmacro=\chappager
5766 \global\let\pagealignmacro=\chappager
5767 \global\def\HEADINGSon{\HEADINGSsingle}}
5770 \global\let\contentsalignmacro = \chapoddpage
5771 \global\let\pchapsepmacro=\chapoddpage
5772 \global\let\pagealignmacro=\chapoddpage
5773 \global\def\HEADINGSon{\HEADINGSdouble}}
5779 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5780 % Yappendix, Yomitfromtoc), #3 the chapter number.
5781 % Not used for @heading series.
5783 % To test against our argument.
5784 \def\Ynothingkeyword{Ynothing}
5785 \def\Yappendixkeyword{Yappendix}
5786 \def\Yomitfromtockeyword{Yomitfromtoc}
5788 \def\chapmacro#1#2#3{%
5789 \checkenv{}% chapters, etc., should not start inside an environment.
5791 % Insert the first mark before the heading break (see notes for \domark).
5792 \let\prevchapterdefs=\lastchapterdefs
5793 \let\prevsectiondefs=\lastsectiondefs
5794 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5795 \gdef\thissection{}}%
5798 \ifx\temptype\Ynothingkeyword
5799 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5800 \gdef\thischapter{\thischaptername}}%
5801 \else\ifx\temptype\Yomitfromtockeyword
5802 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5803 \gdef\thischapter{}}%
5804 \else\ifx\temptype\Yappendixkeyword
5806 \xdef\lastchapterdefs{%
5807 \gdef\noexpand\thischaptername{\the\toks0}%
5808 \gdef\noexpand\thischapternum{\appendixletter}%
5809 % \noexpand\putwordAppendix avoids expanding indigestible
5810 % commands in some of the translations.
5811 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5812 \noexpand\thischapternum:
5813 \noexpand\thischaptername}%
5817 \xdef\lastchapterdefs{%
5818 \gdef\noexpand\thischaptername{\the\toks0}%
5819 \gdef\noexpand\thischapternum{\the\chapno}%
5820 % \noexpand\putwordChapter avoids expanding indigestible
5821 % commands in some of the translations.
5822 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5823 \noexpand\thischapternum:
5824 \noexpand\thischaptername}%
5828 % Output the mark. Pass it through \safewhatsit, to take care of
5829 % the preceding space.
5832 % Insert the chapter heading break.
5835 % Now the second mark, after the heading break. No break points
5836 % between here and the heading.
5837 \let\prevchapterdefs=\lastchapterdefs
5838 \let\prevsectiondefs=\lastsectiondefs
5842 \chapfonts \rmisbold
5843 \let\footnote=\errfootnoteheading % give better error message
5845 % Have to define \lastsection before calling \donoderef, because the
5846 % xref code eventually uses it. On the other hand, it has to be called
5847 % after \pchapsepmacro, or the headline will change too soon.
5848 \gdef\lastsection{#1}%
5850 % Only insert the separating space if we have a chapter/appendix
5851 % number, and don't print the unnumbered ``number''.
5852 \ifx\temptype\Ynothingkeyword
5854 \def\toctype{unnchap}%
5855 \else\ifx\temptype\Yomitfromtockeyword
5856 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5858 \else\ifx\temptype\Yappendixkeyword
5859 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5862 \setbox0 = \hbox{#3\enspace}%
5863 \def\toctype{numchap}%
5866 % Write the toc entry for this chapter. Must come before the
5867 % \donoderef, because we include the current node name in the toc
5868 % entry, and \donoderef resets it to empty.
5869 \writetocentry{\toctype}{#1}{#3}%
5871 % For pdftex, we have to write out the node definition (aka, make
5872 % the pdfdest) after any page break, but before the actual text has
5873 % been typeset. If the destination for the pdf outline is after the
5874 % text, then jumping from the outline may wind up with the text not
5875 % being visible, for instance under high magnification.
5878 % Typeset the actual heading.
5879 \nobreak % Avoid page breaks at the interline glue.
5880 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5883 \nobreak\bigskip % no page break after a chapter title
5887 % @centerchap -- centered and unnumbered.
5888 \let\centerparametersmaybe = \relax
5889 \def\centerparameters{%
5890 \advance\rightskip by 3\rightskip
5891 \leftskip = \rightskip
5896 % I don't think this chapter style is supported any more, so I'm not
5897 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5899 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5901 \def\unnchfopen #1{%
5903 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5904 \nobreak\bigskip\nobreak
5906 \def\chfopen #1#2{\chapoddpage {\chapfonts
5907 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5910 \def\centerchfopen #1{%
5912 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5913 \nobreak\bigskip \nobreak
5916 \global\let\chapmacro=\chfopen
5917 \global\let\centerchapmacro=\centerchfopen}
5920 % Section titles. These macros combine the section number parts and
5921 % call the generic \sectionheading to do the printing.
5923 \newskip\secheadingskip
5924 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5926 % Subsection titles.
5927 \newskip\subsecheadingskip
5928 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5930 % Subsubsection titles.
5931 \def\subsubsecheadingskip{\subsecheadingskip}
5932 \def\subsubsecheadingbreak{\subsecheadingbreak}
5935 % Print any size, any type, section title.
5937 % #1 is the text of the title,
5938 % #2 is the section level (sec/subsec/subsubsec),
5939 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
5940 % #4 is the section number.
5942 \def\seckeyword{sec}
5944 \def\sectionheading#1#2#3#4{%
5946 \def\sectionlevel{#2}%
5949 % It is ok for the @heading series commands to appear inside an
5950 % environment (it's been historically allowed, though the logic is
5951 % dubious), but not the others.
5952 \ifx\temptype\Yomitfromtockeyword\else
5953 \checkenv{}% non-@*heading should not be in an environment.
5955 \let\footnote=\errfootnoteheading
5957 % Switch to the right set of fonts.
5958 \csname #2fonts\endcsname \rmisbold
5960 % Insert first mark before the heading break (see notes for \domark).
5961 \let\prevsectiondefs=\lastsectiondefs
5962 \ifx\temptype\Ynothingkeyword
5963 \ifx\sectionlevel\seckeyword
5964 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5965 \gdef\thissection{\thissectionname}}%
5967 \else\ifx\temptype\Yomitfromtockeyword
5968 % Don't redefine \thissection.
5969 \else\ifx\temptype\Yappendixkeyword
5970 \ifx\sectionlevel\seckeyword
5972 \xdef\lastsectiondefs{%
5973 \gdef\noexpand\thissectionname{\the\toks0}%
5974 \gdef\noexpand\thissectionnum{#4}%
5975 % \noexpand\putwordSection avoids expanding indigestible
5976 % commands in some of the translations.
5977 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5978 \noexpand\thissectionnum:
5979 \noexpand\thissectionname}%
5983 \ifx\sectionlevel\seckeyword
5985 \xdef\lastsectiondefs{%
5986 \gdef\noexpand\thissectionname{\the\toks0}%
5987 \gdef\noexpand\thissectionnum{#4}%
5988 % \noexpand\putwordSection avoids expanding indigestible
5989 % commands in some of the translations.
5990 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5991 \noexpand\thissectionnum:
5992 \noexpand\thissectionname}%
5997 % Go into vertical mode. Usually we'll already be there, but we
5998 % don't want the following whatsit to end up in a preceding paragraph
5999 % if the document didn't happen to have a blank line.
6002 % Output the mark. Pass it through \safewhatsit, to take care of
6003 % the preceding space.
6006 % Insert space above the heading.
6007 \csname #2headingbreak\endcsname
6009 % Now the second mark, after the heading break. No break points
6010 % between here and the heading.
6011 \global\let\prevsectiondefs=\lastsectiondefs
6014 % Only insert the space after the number if we have a section number.
6015 \ifx\temptype\Ynothingkeyword
6018 \gdef\lastsection{#1}%
6019 \else\ifx\temptype\Yomitfromtockeyword
6020 % for @headings -- no section number, don't include in toc,
6021 % and don't redefine \lastsection.
6024 \let\sectionlevel=\empty
6025 \else\ifx\temptype\Yappendixkeyword
6026 \setbox0 = \hbox{#4\enspace}%
6028 \gdef\lastsection{#1}%
6030 \setbox0 = \hbox{#4\enspace}%
6032 \gdef\lastsection{#1}%
6035 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6036 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6038 % Write the node reference (= pdf destination for pdftex).
6039 % Again, see comments in \chapmacro.
6042 % Interline glue will be inserted when the vbox is completed.
6043 % That glue will be a valid breakpoint for the page, since it'll be
6044 % preceded by a whatsit (usually from the \donoderef, or from the
6045 % \writetocentry if there was no node). We don't want to allow that
6046 % break, since then the whatsits could end up on page n while the
6047 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6050 % Output the actual section heading.
6051 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6052 \hangindent=\wd0 % zero if no section number
6055 % Add extra space after the heading -- half of whatever came above it.
6056 % Don't allow stretch, though.
6057 \kern .5 \csname #2headingskip\endcsname
6059 % Do not let the kern be a potential breakpoint, as it would be if it
6060 % was followed by glue.
6063 % We'll almost certainly start a paragraph next, so don't let that
6064 % glue accumulate. (Not a breakpoint because it's preceded by a
6065 % discardable item.) However, when a paragraph is not started next
6066 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6067 % or the negative glue will cause weirdly wrong output, typically
6068 % obscuring the section heading with something else.
6071 % This is so the last item on the main vertical list is a known
6072 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6073 % and do the needful.
6079 % Table of contents.
6082 % Write an entry to the toc file, opening it if necessary.
6083 % Called from @chapter, etc.
6085 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6086 % We append the current node name (if any) and page number as additional
6087 % arguments for the \{chap,sec,...}entry macros which will eventually
6088 % read this. The node name is used in the pdf outlines as the
6089 % destination to jump to.
6091 % We open the .toc file for writing here instead of at @setfilename (or
6092 % any other fixed time) so that @contents can be anywhere in the document.
6093 % But if #1 is `omit', then we don't do anything. This is used for the
6094 % table of contents chapter openings themselves.
6096 \newif\iftocfileopened
6097 \def\omitkeyword{omit}%
6099 \def\writetocentry#1#2#3{%
6100 \edef\writetoctype{#1}%
6101 \ifx\writetoctype\omitkeyword \else
6102 \iftocfileopened\else
6103 \immediate\openout\tocfile = \jobname.toc
6104 \global\tocfileopenedtrue
6110 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6116 % Tell \shipout to create a pdf destination on each page, if we're
6117 % writing pdf. These are used in the table of contents. We can't
6118 % just write one on every page because the title pages are numbered
6119 % 1 and 2 (the page numbers aren't printed), and so are the first
6120 % two pages of the document. Thus, we'd have two destinations named
6121 % `1', and two named `2'.
6122 \ifpdf \global\pdfmakepagedesttrue \fi
6126 % These characters do not print properly in the Computer Modern roman
6127 % fonts, so we must take special care. This is more or less redundant
6128 % with the Texinfo input format setup at the end of this file.
6130 \def\activecatcodes{%
6143 % Read the toc file, which is essentially Texinfo input.
6147 \input \tocreadfilename
6150 \newskip\contentsrightmargin \contentsrightmargin=1in
6151 \newcount\savepageno
6152 \newcount\lastnegativepageno \lastnegativepageno = -1
6154 % Prepare to read what we've written to \tocfile.
6156 \def\startcontents#1{%
6157 % If @setchapternewpage on, and @headings double, the contents should
6158 % start on an odd page, unlike chapters. Thus, we maintain
6159 % \contentsalignmacro in parallel with \pagealignmacro.
6160 % From: Torbjorn Granlund <tege@matematik.su.se>
6162 \immediate\closeout\tocfile
6164 % Don't need to put `Contents' or `Short Contents' in the headline.
6165 % It is abundantly clear what they are.
6166 \chapmacro{#1}{Yomitfromtoc}{}%
6168 \savepageno = \pageno
6169 \begingroup % Set up to handle contents files properly.
6170 \raggedbottom % Worry more about breakpoints than the bottom.
6171 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6173 % Roman numerals for page numbers.
6174 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6177 % redefined for the two-volume lispref. We always output on
6178 % \jobname.toc even if this is redefined.
6180 \def\tocreadfilename{\jobname.toc}
6182 % Normal (long) toc.
6185 \startcontents{\putwordTOC}%
6186 \openin 1 \tocreadfilename\space
6191 \contentsalignmacro % in case @setchapternewpage odd is in effect
6197 \lastnegativepageno = \pageno
6198 \global\pageno = \savepageno
6201 % And just the chapters.
6202 \def\summarycontents{%
6203 \startcontents{\putwordShortTOC}%
6205 \let\partentry = \shortpartentry
6206 \let\numchapentry = \shortchapentry
6207 \let\appentry = \shortchapentry
6208 \let\unnchapentry = \shortunnchapentry
6209 % We want a true roman here for the page numbers.
6211 \let\rm=\shortcontrm \let\bf=\shortcontbf
6212 \let\sl=\shortcontsl \let\tt=\shortconttt
6214 \hyphenpenalty = 10000
6215 \advance\baselineskip by 1pt % Open it up a little.
6216 \def\numsecentry##1##2##3##4{}
6217 \let\appsecentry = \numsecentry
6218 \let\unnsecentry = \numsecentry
6219 \let\numsubsecentry = \numsecentry
6220 \let\appsubsecentry = \numsecentry
6221 \let\unnsubsecentry = \numsecentry
6222 \let\numsubsubsecentry = \numsecentry
6223 \let\appsubsubsecentry = \numsecentry
6224 \let\unnsubsubsecentry = \numsecentry
6225 \openin 1 \tocreadfilename\space
6231 \contentsalignmacro % in case @setchapternewpage odd is in effect
6233 \lastnegativepageno = \pageno
6234 \global\pageno = \savepageno
6236 \let\shortcontents = \summarycontents
6238 % Typeset the label for a chapter or appendix for the short contents.
6239 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6241 \def\shortchaplabel#1{%
6242 % This space should be enough, since a single number is .5em, and the
6243 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6244 % But use \hss just in case.
6245 % (This space doesn't include the extra space that gets added after
6246 % the label; that gets put in by \shortchapentry above.)
6248 % We'd like to right-justify chapter numbers, but that looks strange
6249 % with appendix letters. And right-justifying numbers and
6250 % left-justifying letters looks strange when there is less than 10
6251 % chapters. Have to read the whole toc once to know how many chapters
6252 % there are before deciding ...
6253 \hbox to 1em{#1\hss}%
6256 % These macros generate individual entries in the table of contents.
6257 % The first argument is the chapter or section name.
6258 % The last argument is the page number.
6259 % The arguments in between are the chapter number, section number, ...
6261 % Parts, in the main contents. Replace the part number, which doesn't
6262 % exist, with an empty box. Let's hope all the numbers have the same width.
6263 % Also ignore the page number, which is conventionally not printed.
6264 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6265 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6267 % Parts, in the short toc.
6268 \def\shortpartentry#1#2#3#4{%
6270 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6271 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6274 % Chapters, in the main contents.
6275 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6277 % Chapters, in the short toc.
6278 % See comments in \dochapentry re vbox and related settings.
6279 \def\shortchapentry#1#2#3#4{%
6280 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6283 % Appendices, in the main contents.
6284 % Need the word Appendix, and a fixed-size box.
6286 \def\appendixbox#1{%
6287 % We use M since it's probably the widest letter.
6288 \setbox0 = \hbox{\putwordAppendix{} M}%
6289 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6291 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6293 % Unnumbered chapters.
6294 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6295 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6298 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6299 \let\appsecentry=\numsecentry
6300 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6303 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6304 \let\appsubsecentry=\numsubsecentry
6305 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6307 % And subsubsections.
6308 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6309 \let\appsubsubsecentry=\numsubsubsecentry
6310 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6312 % This parameter controls the indentation of the various levels.
6313 % Same as \defaultparindent.
6314 \newdimen\tocindent \tocindent = 15pt
6316 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6319 % If the toc has to be broken over pages, we want it to be at chapters
6320 % if at all possible; hence the \penalty.
6321 \def\dochapentry#1#2{%
6322 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6325 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6327 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6330 \def\dosecentry#1#2{\begingroup
6331 \secentryfonts \leftskip=\tocindent
6332 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6335 \def\dosubsecentry#1#2{\begingroup
6336 \subsecentryfonts \leftskip=2\tocindent
6337 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6340 \def\dosubsubsecentry#1#2{\begingroup
6341 \subsubsecentryfonts \leftskip=3\tocindent
6342 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6345 % We use the same \entry macro as for the index entries.
6346 \let\tocentry = \entry
6348 % Space between chapter (or whatever) number and the title.
6349 \def\labelspace{\hskip1em \relax}
6351 \def\dopageno#1{{\rm #1}}
6352 \def\doshortpageno#1{{\rm #1}}
6354 \def\chapentryfonts{\secfonts \rm}
6355 \def\secentryfonts{\textfonts}
6356 \def\subsecentryfonts{\textfonts}
6357 \def\subsubsecentryfonts{\textfonts}
6360 \message{environments,}
6361 % @foo ... @end foo.
6363 % @tex ... @end tex escapes into raw TeX temporarily.
6364 % One exception: @ is still an escape character, so that @end tex works.
6365 % But \@ or @@ will get a plain @ character.
6368 \setupmarkupstyle{tex}%
6369 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6370 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6371 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6382 % ' is active in math mode (mathcode"8000). So reset it, and all our
6383 % other math active characters (just in case), to plain's definitions.
6386 % Inverse of the list at the beginning of the file.
6388 \let\bullet=\ptexbullet
6393 \let\equiv=\ptexequiv
6396 \let\indent=\ptexindent
6397 \let\noindent=\ptexnoindent
6404 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6406 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
6407 \let\frenchspacing=\plainfrenchspacing
6409 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6410 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6413 % There is no need to define \Etex.
6415 % Define @lisp ... @end lisp.
6416 % @lisp environment forms a group so it can rebind things,
6417 % including the definition of @end lisp (which normally is erroneous).
6419 % Amount to narrow the margins by for @lisp.
6420 \newskip\lispnarrowing \lispnarrowing=0.4in
6422 % This is the definition that ^^M gets inside @lisp, @example, and other
6423 % such environments. \null is better than a space, since it doesn't
6425 \def\lisppar{\null\endgraf}
6427 % This space is always present above and below environments.
6428 \newskip\envskipamount \envskipamount = 0pt
6430 % Make spacing and below environment symmetrical. We use \parskip here
6431 % to help in doing that, since in @example-like environments \parskip
6432 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6433 % start of the next paragraph will insert \parskip.
6435 \def\aboveenvbreak{{%
6436 % =10000 instead of <10000 because of a special case in \itemzzz and
6437 % \sectionheading, q.v.
6438 \ifnum \lastpenalty=10000 \else
6439 \advance\envskipamount by \parskip
6441 \ifdim\lastskip<\envskipamount
6443 % it's not a good place to break if the last penalty was \nobreak
6445 \ifnum\lastpenalty<10000 \penalty-50 \fi
6446 \vskip\envskipamount
6451 \let\afterenvbreak = \aboveenvbreak
6453 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6454 % also clear it, so that its embedded environments do the narrowing again.
6455 \let\nonarrowing=\relax
6457 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6458 % environment contents.
6459 \font\circle=lcircle10
6461 \newdimen\cartouter\newdimen\cartinner
6462 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6463 \circthick=\fontdimen8\circle
6465 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6466 \def\ctr{{\hskip 6pt\circle\char'010}}
6467 \def\cbl{{\circle\char'012\hskip -6pt}}
6468 \def\cbr{{\hskip 6pt\circle\char'011}}
6469 \def\carttop{\hbox to \cartouter{\hskip\lskip
6470 \ctl\leaders\hrule height\circthick\hfil\ctr
6472 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6473 \cbl\leaders\hrule height\circthick\hfil\cbr
6476 \newskip\lskip\newskip\rskip
6479 \ifhmode\par\fi % can't be in the midst of a paragraph.
6481 \lskip=\leftskip \rskip=\rightskip
6482 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6483 \cartinner=\hsize \advance\cartinner by-\lskip
6484 \advance\cartinner by-\rskip
6486 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6487 % side, and for 6pt waste from
6488 % each corner char, and rule thickness
6489 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6491 % If this cartouche directly follows a sectioning command, we need the
6492 % \parskip glue (backspaced over by default) or the cartouche can
6493 % collide with the section heading.
6494 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6497 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6505 \baselineskip=\normbskip
6506 \lineskip=\normlskip
6509 \comment % For explanation, see the end of def\group.
6524 % This macro is called at the beginning of all the @example variants,
6526 \newdimen\nonfillparindent
6529 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6530 \sepspaces % Make spaces be word-separators rather than space tokens.
6531 \let\par = \lisppar % don't ignore blank lines
6532 \obeylines % each line of input is a line of output
6534 % Turn off paragraph indentation but redefine \indent to emulate
6535 % the normal \indent.
6536 \nonfillparindent=\parindent
6538 \let\indent\nonfillindent
6540 \emergencystretch = 0pt % don't try to avoid overfull boxes
6541 \ifx\nonarrowing\relax
6542 \advance \leftskip by \lispnarrowing
6543 \exdentamount=\lispnarrowing
6545 \let\nonarrowing = \relax
6547 \let\exdent=\nofillexdent
6552 % We want to swallow spaces (but not other tokens) after the fake
6553 % @indent in our nonfill-environments, where spaces are normally
6554 % active and set to @tie, resulting in them not being ignored after
6556 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6557 \gdef\nonfillindentcheck{%
6559 \expandafter\nonfillindentgobble%
6561 \leavevmode\nonfillindentbox%
6565 \def\nonfillindentgobble#1{\nonfillindent}
6566 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6568 % If you want all examples etc. small: @set dispenvsize small.
6569 % If you want even small examples the full size: @set dispenvsize nosmall.
6570 % This affects the following displayed environments:
6571 % @example, @display, @format, @lisp
6573 \def\smallword{small}
6574 \def\nosmallword{nosmall}
6575 \let\SETdispenvsize\relax
6576 \def\setnormaldispenv{%
6577 \ifx\SETdispenvsize\smallword
6578 % end paragraph for sake of leading, in case document has no blank
6579 % line. This is redundant with what happens in \aboveenvbreak, but
6580 % we need to do it before changing the fonts, and it's inconvenient
6581 % to change the fonts afterward.
6582 \ifnum \lastpenalty=10000 \else \endgraf \fi
6583 \smallexamplefonts \rm
6586 \def\setsmalldispenv{%
6587 \ifx\SETdispenvsize\nosmallword
6589 \ifnum \lastpenalty=10000 \else \endgraf \fi
6590 \smallexamplefonts \rm
6594 % We often define two environments, @foo and @smallfoo.
6595 % Let's do it in one command. #1 is the env name, #2 the definition.
6596 \def\makedispenvdef#1#2{%
6597 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6598 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6599 \expandafter\let\csname E#1\endcsname \afterenvbreak
6600 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6603 % Define two environment synonyms (#1 and #2) for an environment.
6604 \def\maketwodispenvdef#1#2#3{%
6605 \makedispenvdef{#1}{#3}%
6606 \makedispenvdef{#2}{#3}%
6609 % @lisp: indented, narrowed, typewriter font;
6610 % @example: same as @lisp.
6612 % @smallexample and @smalllisp: use smaller fonts.
6613 % Originally contributed by Pavel@xerox.
6615 \maketwodispenvdef{lisp}{example}{%
6617 \tt\setupmarkupstyle{example}%
6618 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6619 \gobble % eat return
6621 % @display/@smalldisplay: same as @lisp except keep current font.
6623 \makedispenvdef{display}{%
6628 % @format/@smallformat: same as @display except don't narrow margins.
6630 \makedispenvdef{format}{%
6631 \let\nonarrowing = t%
6636 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6638 \let\nonarrowing = t%
6642 \let\Eflushleft = \afterenvbreak
6646 \envdef\flushright{%
6647 \let\nonarrowing = t%
6649 \advance\leftskip by 0pt plus 1fill\relax
6652 \let\Eflushright = \afterenvbreak
6655 % @raggedright does more-or-less normal line breaking but no right
6656 % justification. From plain.tex. Don't stretch around special
6657 % characters in urls in this environment, since the stretch at the right
6659 \envdef\raggedright{%
6660 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
6661 \def\urefprestretchamount{0pt}%
6662 \def\urefpoststretchamount{0pt}%
6664 \let\Eraggedright\par
6666 \envdef\raggedleft{%
6667 \parindent=0pt \leftskip0pt plus2em
6668 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6669 \hbadness=10000 % Last line will usually be underfull, so turn off
6670 % badness reporting.
6672 \let\Eraggedleft\par
6674 \envdef\raggedcenter{%
6675 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6676 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6677 \hbadness=10000 % Last line will usually be underfull, so turn off
6678 % badness reporting.
6680 \let\Eraggedcenter\par
6683 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6684 % and narrows the margins. We keep \parskip nonzero in general, since
6685 % we're doing normal filling. So, when using \aboveenvbreak and
6686 % \afterenvbreak, temporarily make \parskip 0.
6688 \makedispenvdef{quotation}{\quotationstart}
6690 \def\quotationstart{%
6691 \indentedblockstart % same as \indentedblock, but increase right margin too.
6692 \ifx\nonarrowing\relax
6693 \advance\rightskip by \lispnarrowing
6695 \parsearg\quotationlabel
6698 % We have retained a nonzero parskip for the environment, since we're
6699 % doing normal filling.
6703 \ifx\quotationauthor\thisisundefined\else
6705 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6707 {\parskip=0pt \afterenvbreak}%
6709 \def\Esmallquotation{\Equotation}
6711 % If we're given an argument, typeset it in bold with a colon after.
6712 \def\quotationlabel#1{%
6714 \ifx\temp\empty \else
6719 % @indentedblock is like @quotation, but indents only on the left and
6720 % has no optional argument.
6722 \makedispenvdef{indentedblock}{\indentedblockstart}
6724 \def\indentedblockstart{%
6725 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6728 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6729 \ifx\nonarrowing\relax
6730 \advance\leftskip by \lispnarrowing
6731 \exdentamount = \lispnarrowing
6733 \let\nonarrowing = \relax
6737 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6739 \def\Eindentedblock{%
6741 {\parskip=0pt \afterenvbreak}%
6743 \def\Esmallindentedblock{\Eindentedblock}
6746 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6747 % If we want to allow any <char> as delimiter,
6748 % we need the curly braces so that makeinfo sees the @verb command, eg:
6749 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6751 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6753 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6754 % active too. Otherwise, they get lost as the first character on a
6757 \do\ \do\\\do\{\do\}\do\$\do\&%
6758 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6759 \do\<\do\>\do\|\do\@\do+\do\"%
6760 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6761 % @set txicodequotebacktick will not have effect on @verb and
6762 % @verbatim, and ?` and !` ligatures won't get disabled.
6767 \def\uncatcodespecials{%
6768 \def\do##1{\catcode`##1=\other}\dospecials}
6770 % Setup for the @verb command.
6772 % Eight spaces for a tab
6774 \catcode`\^^I=\active
6775 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6779 \tt % easiest (and conventionally used) font for verbatim
6780 \def\par{\leavevmode\endgraf}%
6781 \setupmarkupstyle{verb}%
6783 % Respect line breaks,
6784 % print special symbols as themselves, and
6785 % make each space count
6786 % must do in this order:
6787 \obeylines \uncatcodespecials \sepspaces
6790 % Setup for the @verbatim environment
6792 % Real tab expansion.
6793 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6795 % We typeset each line of the verbatim in an \hbox, so we can handle
6796 % tabs. The \global is in case the verbatim line starts with an accent,
6797 % or some other command that starts with a begin-group. Otherwise, the
6798 % entire \verbbox would disappear at the corresponding end-group, before
6799 % it is typeset. Meanwhile, we can't have nested verbatim commands
6800 % (can we?), so the \global won't be overwriting itself.
6802 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6805 \catcode`\^^I=\active
6807 \catcode`\^^I=\active
6808 \def^^I{\leavevmode\egroup
6809 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6810 \divide\dimen\verbbox by\tabw
6811 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6812 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6813 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6818 % start the verbatim environment.
6819 \def\setupverbatim{%
6820 \let\nonarrowing = t%
6822 \tt % easiest (and conventionally used) font for verbatim
6823 % The \leavevmode here is for blank lines. Otherwise, we would
6824 % never \starttabox and the \egroup would end verbatim mode.
6825 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6827 \setupmarkupstyle{verbatim}%
6828 % Respect line breaks,
6829 % print special symbols as themselves, and
6830 % make each space count.
6831 % Must do in this order:
6832 \obeylines \uncatcodespecials \sepspaces
6833 \everypar{\starttabbox}%
6836 % Do the @verb magic: verbatim text is quoted by unique
6837 % delimiter characters. Before first delimiter expect a
6838 % right brace, after last delimiter expect closing brace:
6840 % \def\doverb'{'<char>#1<char>'}'{#1}
6842 % [Knuth] p. 382; only eat outer {}
6844 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6845 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6848 \def\verb{\begingroup\setupverb\doverb}
6851 % Do the @verbatim magic: define the macro \doverbatim so that
6852 % the (first) argument ends when '@end verbatim' is reached, ie:
6854 % \def\doverbatim#1@end verbatim{#1}
6856 % For Texinfo it's a lot easier than for LaTeX,
6857 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6858 % we need not redefine '\', '{' and '}'.
6860 % Inspired by LaTeX's verbatim command set [latex.ltx]
6865 % ignore everything up to the first ^^M, that's the newline at the end
6866 % of the @verbatim input line itself. Otherwise we get an extra blank
6867 % line in the output.
6868 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6869 % We really want {...\end verbatim} in the body of the macro, but
6870 % without the active space; thus we have to use \xdef and \gobble.
6874 \setupverbatim\doverbatim
6876 \let\Everbatim = \afterenvbreak
6879 % @verbatiminclude FILE - insert text of file in verbatim environment.
6881 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6883 \def\doverbatiminclude#1{%
6885 \makevalueexpandable
6887 \indexnofonts % Allow `@@' and other weird things in file names.
6888 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6894 % @copying ... @end copying.
6895 % Save the text away for @insertcopying later.
6897 % We save the uninterpreted tokens, rather than creating a box.
6898 % Saving the text in a box would be much easier, but then all the
6899 % typesetting commands (@smallbook, font changes, etc.) have to be done
6900 % beforehand -- and a) we want @copying to be done first in the source
6901 % file; b) letting users define the frontmatter in as flexible order as
6902 % possible is desirable.
6904 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6905 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6907 \def\insertcopying{%
6909 \parindent = 0pt % paragraph indentation looks wrong on title page
6910 \scanexp\copyingtext
6918 \newskip\defbodyindent \defbodyindent=.4in
6919 \newskip\defargsindent \defargsindent=50pt
6920 \newskip\deflastargmargin \deflastargmargin=18pt
6921 \newcount\defunpenalty
6923 % Start the processing of @deffn:
6925 \ifnum\lastpenalty<10000
6927 \defunpenalty=10003 % Will keep this @deffn together with the
6928 % following @def command, see below.
6930 % If there are two @def commands in a row, we'll have a \nobreak,
6931 % which is there to keep the function description together with its
6932 % header. But if there's nothing but headers, we need to allow a
6933 % break somewhere. Check specifically for penalty 10002, inserted
6934 % by \printdefunline, instead of 10000, since the sectioning
6935 % commands also insert a nobreak penalty, and we don't want to allow
6936 % a break between a section heading and a defun.
6938 % As a further refinement, we avoid "club" headers by signalling
6939 % with penalty of 10003 after the very first @deffn in the
6940 % sequence (see above), and penalty of 10002 after any following
6942 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6944 % Similarly, after a section heading, do not allow a break.
6945 % But do insert the glue.
6946 \medskip % preceded by discardable penalty, so not a breakpoint
6950 \advance\leftskip by \defbodyindent
6951 \exdentamount=\defbodyindent
6955 % First, check whether we are in the right environment:
6958 % As above, allow line break if we have multiple x headers in a row.
6959 % It's not a great place, though.
6960 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6962 % And now, it's time to reuse the body of the original defun:
6963 \expandafter\gobbledefun#1%
6965 \def\gobbledefun#1\startdefun{}
6967 % \printdefunline \deffnheader{text}
6969 \def\printdefunline#1#2{%
6971 % call \deffnheader:
6974 \interlinepenalty = 10000
6975 \advance\rightskip by 0pt plus 1fil\relax
6977 \nobreak\vskip -\parskip
6978 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6979 % Some of the @defun-type tags do not enable magic parentheses,
6980 % rendering the following check redundant. But we don't optimize.
6985 \def\Edefun{\endgraf\medbreak}
6987 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6988 % the only thing remaining is to define \deffnheader.
6991 \expandafter\let\csname E#1\endcsname = \Edefun
6992 \edef\temp{\noexpand\domakedefun
6993 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6997 % \domakedefun \deffn \deffnx \deffnheader
6999 % Define \deffn and \deffnx, without parameters.
7000 % \deffnheader has to be defined explicitly.
7002 \def\domakedefun#1#2#3{%
7005 \doingtypefnfalse % distinguish typed functions from all else
7006 \parseargusing\activeparens{\printdefunline#3}%
7008 \def#2{\dodefunx#1}%
7012 \newif\ifdoingtypefn % doing typed function?
7013 \newif\ifrettypeownline % typeset return type on its own line?
7015 % @deftypefnnewline on|off says whether the return type of typed functions
7016 % are printed on their own line. This affects @deftypefn, @deftypefun,
7017 % @deftypeop, and @deftypemethod.
7019 \parseargdef\deftypefnnewline{%
7022 \expandafter\let\csname SETtxideftypefnnl\endcsname
7024 \else\ifx\temp\offword
7025 \expandafter\let\csname SETtxideftypefnnl\endcsname
7028 \errhelp = \EMsimple
7029 \errmessage{Unknown @txideftypefnnl value `\temp',
7034 % Untyped functions:
7036 % @deffn category name args
7037 \makedefun{deffn}{\deffngeneral{}}
7039 % @deffn category class name args
7040 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7042 % \defopon {category on}class name args
7043 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7045 % \deffngeneral {subind}category name args
7047 \def\deffngeneral#1#2 #3 #4\endheader{%
7048 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7049 \dosubind{fn}{\code{#3}}{#1}%
7050 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7055 % @deftypefn category type name args
7056 \makedefun{deftypefn}{\deftypefngeneral{}}
7058 % @deftypeop category class type name args
7059 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7061 % \deftypeopon {category on}class type name args
7062 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7064 % \deftypefngeneral {subind}category type name args
7066 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7067 \dosubind{fn}{\code{#4}}{#1}%
7069 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7074 % @deftypevr category type var args
7075 \makedefun{deftypevr}{\deftypecvgeneral{}}
7077 % @deftypecv category class type var args
7078 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7080 % \deftypecvof {category of}class type var args
7081 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7083 % \deftypecvgeneral {subind}category type var args
7085 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7086 \dosubind{vr}{\code{#4}}{#1}%
7087 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7090 % Untyped variables:
7092 % @defvr category var args
7093 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7095 % @defcv category class var args
7096 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7098 % \defcvof {category of}class var args
7099 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7103 % @deftp category name args
7104 \makedefun{deftp}#1 #2 #3\endheader{%
7105 \doind{tp}{\code{#2}}%
7106 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7109 % Remaining @defun-like shortcuts:
7110 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7111 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7112 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7113 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7114 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7115 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7116 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7117 \makedefun{defmethod}{\defopon\putwordMethodon}
7118 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7119 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7120 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7122 % \defname, which formats the name of the @def (not the args).
7123 % #1 is the category, such as "Function".
7124 % #2 is the return type, if any.
7125 % #3 is the function name.
7127 % We are followed by (but not passed) the arguments, if any.
7129 \def\defname#1#2#3{%
7131 % Get the values of \leftskip and \rightskip as they were outside the @def...
7132 \advance\leftskip by -\defbodyindent
7134 % Determine if we are typesetting the return type of a typed function
7135 % on a line by itself.
7136 \rettypeownlinefalse
7137 \ifdoingtypefn % doing a typed function specifically?
7138 % then check user option for putting return type on its own line:
7139 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7144 % How we'll format the category name. Putting it in brackets helps
7145 % distinguish it from the body text that may end up on the next line
7148 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7150 % Figure out line sizes for the paragraph shape. We'll always have at
7154 % The first line needs space for \box0; but if \rightskip is nonzero,
7155 % we need only space for the part of \box0 which exceeds it:
7156 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7158 % If doing a return type on its own line, we'll have another line.
7160 \advance\tempnum by 1
7161 \def\maybeshapeline{0in \hsize}%
7163 \def\maybeshapeline{}%
7166 % The continuations:
7167 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7169 % The final paragraph shape:
7170 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7172 % Put the category name at the right margin.
7175 \hfil\box0 \kern-\hsize
7176 % \hsize has to be shortened this way:
7178 % Intentionally do not respect \rightskip, since we need the space.
7181 % Allow all lines to be underfull without complaint:
7182 \tolerance=10000 \hbadness=10000
7183 \exdentamount=\defbodyindent
7185 % defun fonts. We use typewriter by default (used to be bold) because:
7186 % . we're printing identifiers, they should be in tt in principle.
7187 % . in languages with many accents, such as Czech or French, it's
7188 % common to leave accents off identifiers. The result looks ok in
7189 % tt, but exceedingly strange in rm.
7190 % . we don't want -- and --- to be treated as ligatures.
7191 % . this still does not fix the ?` and !` ligatures, but so far no
7192 % one has made identifiers using them :).
7194 \def\temp{#2}% text of the return type
7195 \ifx\temp\empty\else
7196 \tclose{\temp}% typeset the return type
7198 % put return type on its own line; prohibit line break following:
7199 \hfil\vadjust{\nobreak}\break
7201 \space % type on same line, so just followed by a space
7203 \fi % no return type
7204 #3% output function name
7206 {\rm\enskip}% hskip 0.5 em of \tenrm
7209 % arguments will be output next, if any.
7212 % Print arguments in slanted roman (not ttsl), inconsistently with using
7213 % tt for the name. This is because literal text is sometimes needed in
7214 % the argument list (groff manual), and ttsl and tt are not very
7215 % distinguishable. Prevent hyphenation at `-' chars.
7218 % use sl by default (not ttsl),
7220 \df \sl \hyphenchar\font=0
7222 % On the other hand, if an argument has two dashes (for instance), we
7223 % want a way to get ttsl. We used to recommend @var for that, so
7224 % leave the code in, but it's strange for @var to lead to typewriter.
7225 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7226 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7227 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7229 \sl\hyphenchar\font=45
7232 % We want ()&[] to print specially on the defun line.
7235 \catcode`\(=\active \catcode`\)=\active
7236 \catcode`\[=\active \catcode`\]=\active
7240 % Make control sequences which act like normal parenthesis chars.
7241 \let\lparen = ( \let\rparen = )
7243 % Be sure that we always have a definition for `(', etc. For example,
7244 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7245 % so TeX would otherwise complain about undefined control sequence.
7248 \global\let(=\lparen \global\let)=\rparen
7249 \global\let[=\lbrack \global\let]=\rbrack
7252 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7253 \gdef\magicamp{\let&=\amprm}
7256 \newcount\parencount
7258 % If we encounter &foo, then turn on ()-hacking afterwards
7260 \def\amprm#1 {\ampseentrue{\bf\ }}
7264 % At the first level, print parens in roman,
7265 % otherwise use the default font.
7266 \ifnum \parencount=1 \rm \fi
7268 % The \sf parens (in \boldbrax) actually are a little bolder than
7269 % the contained text. This is especially needed for [ and ] .
7273 \def\infirstlevel#1{%
7280 \def\bfafterword#1 {#1 \bf}
7283 \global\advance\parencount by 1
7285 \infirstlevel \bfafterword
7290 \global\advance\parencount by -1
7293 \newcount\brackcount
7295 \global\advance\brackcount by 1
7300 \global\advance\brackcount by -1
7303 \def\checkparencounts{%
7304 \ifnum\parencount=0 \else \badparencount \fi
7305 \ifnum\brackcount=0 \else \badbrackcount \fi
7307 % these should not use \errmessage; the glibc manual, at least, actually
7308 % has such constructs (when documenting function pointers).
7309 \def\badparencount{%
7310 \message{Warning: unbalanced parentheses in @def...}%
7311 \global\parencount=0
7313 \def\badbrackcount{%
7314 \message{Warning: unbalanced square brackets in @def...}%
7315 \global\brackcount=0
7322 % To do this right we need a feature of e-TeX, \scantokens,
7323 % which we arrange to emulate with a temporary file in ordinary TeX.
7324 \ifx\eTeXversion\thisisundefined
7325 \newwrite\macscribble
7328 \immediate\openout\macscribble=\jobname.tmp
7329 \immediate\write\macscribble{\the\toks0}%
7330 \immediate\closeout\macscribble
7335 \let\aftermacroxxx\relax
7336 \def\aftermacro{\aftermacroxxx}
7338 % alias because \c means cedilla in @tex or @math
7341 % Used at the time of macro expansion.
7342 % Argument is macro body with arguments substituted
7345 \let\xeatspaces\eatspaces
7347 % Process the macro body under the current catcode regime.
7348 \scantokens{#1\texinfoc}\aftermacro%
7350 % The \c is to remove the \newlinechar added by \scantokens, and
7351 % can be noticed by \parsearg.
7352 % The \aftermacro allows a \comment at the end of the macro definition
7353 % to duplicate itself past the final \newlinechar added by \scantokens:
7354 % this is used in the definition of \group to comment out a newline. We
7355 % don't do the same for \c to support Texinfo files with macros that ended
7356 % with a @c, which should no longer be necessary.
7357 % We avoid surrounding the call to \scantokens with \bgroup and \egroup
7358 % to allow macros to open or close groups themselves.
7363 % Undo catcode changes of \startcontents and \printindex
7364 % When called from @insertcopying or (short)caption, we need active
7365 % backslash to get it printed correctly.
7366 % FIXME: This may not be needed.
7367 %\catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7368 \edef\temp{\noexpand\scanmacro{#1}}%
7373 \newcount\paramno % Count of parameters
7374 \newtoks\macname % Macro name
7375 \newif\ifrecursive % Is it recursive?
7377 % List of all defined macros in the form
7378 % \definedummyword\macro1\definedummyword\macro2...
7379 % Currently is also contains all @aliases; the list can be split
7380 % if there is a need.
7383 % Add the macro to \macrolist
7384 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7385 \def\addtomacrolistxxx#1{%
7386 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7387 \xdef\macrolist{\the\toks0}%
7391 % This does \let #1 = #2, with \csnames; that is,
7392 % \let \csname#1\endcsname = \csname#2\endcsname
7393 % (except of course we have to play expansion games).
7397 \csname#1\expandafter\endcsname
7401 % Trim leading and trailing spaces off a string.
7402 % Concepts from aro-bend problem 15 (see CTAN).
7404 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7405 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7406 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7408 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7411 % Trim a single trailing ^^M off a string.
7412 {\catcode`\^^M=\other \catcode`\Q=3%
7413 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7414 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7415 \gdef\eatcrb#1Q#2Q{#1}%
7418 % Macro bodies are absorbed as an argument in a context where
7419 % all characters are catcode 10, 11 or 12, except \ which is active
7420 % (as in normal texinfo). It is necessary to change the definition of \
7421 % to recognize macro arguments; this is the job of \mbodybackslash.
7423 % Non-ASCII encodings make 8-bit characters active, so un-activate
7424 % them to avoid their expansion. Must do this non-globally, to
7425 % confine the change to the current group.
7427 % It's necessary to have hard CRs when the macro is executed. This is
7428 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7429 % body, and then making it the \newlinechar in \scanmacro.
7431 \def\scanctxt{% used as subroutine
7440 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7443 \def\scanargctxt{% used for copying and captions, not macros.
7447 \catcode`\^^M=\other
7450 \def\macrobodyctxt{% used for @macro definitions
7456 \catcode`\^^M=\other
7460 % Used when scanning braced macro arguments. Note, however, that catcode
7461 % changes here are ineffectual if the macro invocation was nested inside
7462 % an argument to another Texinfo command.
7468 \def\\{\normalbackslash}%
7470 \def\macrolineargctxt{% used for whole-line arguments without braces
7476 % \mbodybackslash is the definition of \ in @macro bodies.
7477 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7478 % where N is the macro parameter number.
7479 % We define \csname macarg.\endcsname to be \realbackslash, so
7480 % \\ in macro replacement text gets you a backslash.
7482 {\catcode`@=0 @catcode`@\=@active
7483 @gdef@usembodybackslash{@let\=@mbodybackslash}
7484 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7486 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7488 \def\margbackslash#1{\char`\#1 }
7490 \def\macro{\recursivefalse\parsearg\macroxxx}
7491 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7494 \getargs{#1}% now \macname is the macname and \argl the arglist
7495 \ifx\argl\empty % no arguments
7498 \expandafter\parsemargdef \argl;%
7499 \if\paramno>256\relax
7500 \ifx\eTeXversion\thisisundefined
7501 \errhelp = \EMsimple
7502 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7506 \if1\csname ismacro.\the\macname\endcsname
7507 \message{Warning: redefining \the\macname}%
7509 \expandafter\ifx\csname \the\macname\endcsname \relax
7510 \else \errmessage{Macro name \the\macname\space already defined}\fi
7511 \global\cslet{macsave.\the\macname}{\the\macname}%
7512 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7513 \addtomacrolist{\the\macname}%
7515 \begingroup \macrobodyctxt
7516 \ifrecursive \expandafter\parsermacbody
7517 \else \expandafter\parsemacbody
7520 \parseargdef\unmacro{%
7521 \if1\csname ismacro.#1\endcsname
7522 \global\cslet{#1}{macsave.#1}%
7523 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7524 % Remove the macro name from \macrolist:
7526 \expandafter\let\csname#1\endcsname \relax
7527 \let\definedummyword\unmacrodo
7528 \xdef\macrolist{\macrolist}%
7531 \errmessage{Macro #1 not defined}%
7535 % Called by \do from \dounmacro on each macro. The idea is to omit any
7536 % macro definitions that have been changed to \relax.
7542 \noexpand\definedummyword \noexpand#1%
7546 % This makes use of the obscure feature that if the last token of a
7547 % <parameter list> is #, then the preceding argument is delimited by
7548 % an opening brace, and that opening brace is not consumed.
7550 \def\getargs#1{\getargsxxx#1{}}
7551 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7552 \def\getmacname#1 #2\relax{\macname={#1}}
7553 \def\getmacargs#1{\def\argl{#1}}
7555 % For macro processing make @ a letter so that we can make
7556 % private-to-Texinfo macro names.
7557 \edef\texiatcatcode{\the\catcode`\@}
7558 \catcode `@=11\relax
7560 % Parse the optional {params} list. Set up \paramno and \paramlist
7561 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7562 % in the params list to some hook where the argument is to be expanded. If
7563 % there are less than 10 arguments that hook is to be replaced by ##N where N
7564 % is the position in that list, that is to say the macro arguments are to be
7565 % defined `a la TeX in the macro body.
7567 % That gets used by \mbodybackslash (above).
7569 % We need to get `macro parameter char #' into several definitions.
7570 % The technique used is stolen from LaTeX: let \hash be something
7571 % unexpandable, insert that wherever you need a #, and then redefine
7572 % it to # just before using the token list produced.
7574 % The same technique is used to protect \eatspaces till just before
7575 % the macro is used.
7577 % If there are 10 or more arguments, a different technique is used, where the
7578 % hook remains in the body, and when macro is to be expanded the body is
7579 % processed again to replace the arguments.
7581 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7582 % argument N value and then \edef the body (nothing else will expand because of
7583 % the catcode regime underwhich the body was input).
7585 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7586 % arguments, no macro can have more than 256 arguments (else error).
7588 \def\parsemargdef#1;{%
7589 \paramno=0\def\paramlist{}%
7591 \let\xeatspaces\relax
7592 \parsemargdefxxx#1,;,%
7593 % In case that there are 10 or more arguments we parse again the arguments
7594 % list to set new definitions for the \macarg.BLAH macros corresponding to
7595 % each BLAH argument. It was anyhow needed to parse already once this list
7596 % in order to count the arguments, and as macros with at most 9 arguments
7597 % are by far more frequent than macro with 10 or more arguments, defining
7598 % twice the \macarg.BLAH macros does not cost too much processing power.
7599 \ifnum\paramno<10\relax\else
7601 \parsemmanyargdef@@#1,;,% 10 or more arguments
7604 \def\parsemargdefxxx#1,{%
7605 \if#1;\let\next=\relax
7606 \else \let\next=\parsemargdefxxx
7607 \advance\paramno by 1
7608 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7609 {\xeatspaces{\hash\the\paramno}}%
7610 \edef\paramlist{\paramlist\hash\the\paramno,}%
7613 \def\parsemmanyargdef@@#1,{%
7614 \if#1;\let\next=\relax
7616 \let\next=\parsemmanyargdef@@
7617 \edef\tempb{\eatspaces{#1}}%
7618 \expandafter\def\expandafter\tempa
7619 \expandafter{\csname macarg.\tempb\endcsname}%
7620 % Note that we need some extra \noexpand\noexpand, this is because we
7621 % don't want \the to be expanded in the \parsermacbody as it uses an
7623 \expandafter\edef\tempa
7624 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7625 \advance\paramno by 1\relax
7628 % These two commands read recursive and nonrecursive macro bodies.
7629 % (They're different since rec and nonrec macros end differently.)
7630 % Set \temp to the body of the macro, and call \defmacro.
7631 \catcode `\@\texiatcatcode
7632 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
7633 \xdef\temp{\eatcr{#1}}\endgroup\defmacro}}%
7634 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
7635 \xdef\temp{\eatcr{#1}}\endgroup\defmacro}}%
7636 \catcode `\@=11\relax
7641 \long\def\nillm@{\nil@}%
7643 % This macro is expanded during the Texinfo macro expansion, not during its
7644 % definition. It gets all the arguments' values and assigns them to macros
7647 % #1 is the macro name
7648 % #2 is the list of argument names
7649 % #3 is the list of argument values
7650 \def\getargvals@#1#2#3{%
7651 \def\macargdeflist@{}%
7652 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7653 \def\paramlist{#2,\nil@}%
7657 \def\argvaluelist{#3,\nil@}%
7666 % Internal for \getargsval@.
7669 \ifx\paramlist\nilm@
7670 % Some sanity check needed here that \argvaluelist is also empty.
7671 \ifx\argvaluelist\nillm@
7673 \errhelp = \EMsimple
7674 \errmessage{Too many arguments in macro `\macroname'!}%
7676 \let\next\macargexpandinbody@
7678 \ifx\argvaluelist\nillm@
7679 % No more arguments values passed to macro. Set remaining named-arg
7681 \let\next\setemptyargvalues@
7683 % pop current arg name into \@tempb
7684 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7685 \expandafter\@tempa\expandafter{\paramlist}%
7686 % pop current argument value into \@tempc
7687 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7688 \expandafter\@tempa\expandafter{\argvaluelist}%
7689 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7690 % First place the new argument macro definition into \@tempd
7691 \expandafter\macname\expandafter{\@tempc}%
7692 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7693 \expandafter\def\expandafter\@tempe\expandafter{%
7694 \csname macarg.\@tempb\endcsname}%
7695 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7696 \push@\@tempd\macargdeflist@
7697 \let\next\getargvals@@
7704 \expandafter\expandafter\expandafter\def
7705 \expandafter\expandafter\expandafter#2%
7706 \expandafter\expandafter\expandafter{%
7710 % Replace arguments by their values in the macro body, and place the result
7713 \def\macvalstoargs@{%
7714 % To do this we use the property that token registers that are \the'ed
7715 % within an \edef expand only once. So we are going to place all argument
7716 % values into respective token registers.
7718 % First we save the token context, and initialize argument numbering.
7721 % Then, for each argument number #N, we place the corresponding argument
7722 % value into a new token list register \toks#N
7723 \expandafter\putargsintokens@\saveparamlist@,;,%
7724 % Then, we expand the body so that argument are replaced by their
7725 % values. The trick for values not to be expanded themselves is that they
7726 % are within tokens and that tokens expand only once in an \edef .
7727 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7728 % Now we restore the token stack pointer to free the token list registers
7729 % which we have used, but we make sure that expanded body is saved after
7733 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7736 % Define the named-macro outside of this group and then close this group.
7738 \def\macargexpandinbody@{%
7742 % First the replace in body the macro arguments by their values, the result
7745 % Then we point at the \norecurse or \gobble (for recursive) macro value
7747 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7748 % Depending on whether it is recursive or not, we need some tailing
7755 % And now we do the real job:
7756 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7760 \def\putargsintokens@#1,{%
7761 \if#1;\let\next\relax
7763 \let\next\putargsintokens@
7764 % First we allocate the new token list register, and give it a temporary
7766 \toksdef\@tempb\the\paramno
7767 % Then we place the argument value into that token list register.
7768 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7769 \expandafter\@tempb\expandafter{\@tempa}%
7770 \advance\paramno by 1\relax
7775 % Save the token stack pointer into macro #1:
7776 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7778 % Restore the token stack pointer from number in macro #1:
7779 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef
7780 \expandafter\@cclvi#1\relax}
7781 % Variant \newtoks that can be used non-\outer:
7782 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7784 % Tailing missing arguments are set to empty.
7786 \def\setemptyargvalues@{%
7787 \ifx\paramlist\nilm@
7788 \let\next\macargexpandinbody@
7790 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7791 \let\next\setemptyargvalues@
7796 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7797 \expandafter\def\expandafter\@tempa\expandafter{%
7798 \expandafter\def\csname macarg.#1\endcsname{}}%
7799 \push@\@tempa\macargdeflist@
7803 % #1 is the element target macro
7804 % #2 is the list macro
7805 % #3,#4\endargs@ is the list value
7806 \def\pop@#1#2#3,#4\endargs@{%
7810 \long\def\longpop@#1#2#3,#4\endargs@{%
7815 % This defines a Texinfo @macro. \temp has the body of the macro in it.
7816 % There are eight cases: recursive and nonrecursive macros of zero, one,
7817 % up to nine, and many arguments.
7818 % Much magic with \expandafter here.
7819 % \xdef is used so that macro definitions will survive the file
7820 % they're defined in; @include reads the file inside a group.
7823 \let\hash=##% convert placeholders to macro parameter chars
7824 \ifrecursive %%%%%%%%%%%%%% Recursive %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7827 \expandafter\xdef\csname\the\macname\endcsname{%
7828 \noexpand\scanmacro{\temp}}%
7830 \expandafter\xdef\csname\the\macname\endcsname{%
7832 \noexpand\braceorline
7833 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7834 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7835 \egroup\noexpand\scanmacro{\temp}}%
7837 \ifnum\paramno<10\relax % at most 9
7838 \expandafter\xdef\csname\the\macname\endcsname{%
7839 \bgroup\noexpand\macroargctxt
7840 \noexpand\csname\the\macname xx\endcsname}%
7841 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7842 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7843 \expandafter\expandafter
7845 \expandafter\expandafter
7846 \csname\the\macname xxx\endcsname
7847 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7849 \expandafter\xdef\csname\the\macname\endcsname{%
7850 \noexpand\getargvals@{\the\macname}{\argl}%
7852 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7853 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7856 \else %%%%%%%%%%%%%%%%%%%%%% Non-recursive %%%%%%%%%%%%%%%%%%%%%%%%%%
7859 \expandafter\xdef\csname\the\macname\endcsname{%
7860 \noexpand\scanmacro{\temp}}%
7862 \expandafter\xdef\csname\the\macname\endcsname{%
7864 \noexpand\braceorline
7865 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7866 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7868 \noexpand\scanmacro{\temp}%
7871 \ifnum\paramno<10\relax
7872 \expandafter\xdef\csname\the\macname\endcsname{%
7873 \bgroup\noexpand\macroargctxt
7874 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7875 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7876 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7877 \expandafter\expandafter
7879 \expandafter\expandafter
7880 \csname\the\macname xxx\endcsname
7883 \noexpand\scanmacro{\temp}%
7886 \expandafter\xdef\csname\the\macname\endcsname{%
7887 \noexpand\getargvals@{\the\macname}{\argl}%
7889 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7890 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7895 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
7897 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7900 {\catcode`\@=0 \catcode`\\=13
7903 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
7904 % compressed to one.
7905 @gdef@passargtomacro#1#2{%
7907 @def@pending_backslash{}%
7908 @def@finish{@finish}%
7910 @let@next_token=@relax
7911 @add_segment#2\@finish\%
7914 % Input stream is just after a backslash. If the next token is not a
7915 % backslash, process the rest of the argument; otherwise, remove the next
7918 @futurelet@next_token@look_aheadzzz}
7919 @gdef@look_aheadzzz{%
7921 @let@next=@gobble_and_check_finish
7923 @let@next=@add_segment
7927 % Double backslash found. Add a single backslash here.
7928 @gdef@gobble_and_check_finish#1{%
7930 @def@pending_backslash{}%
7931 @futurelet@next_token@add_segment
7934 % append a backslash to \arg_result
7935 @gdef@add_the_backslash{%
7936 @expandafter@gdef@expandafter@arg_result@expandafter{@arg_result\}%
7939 % Input stream is either at the start of the argument, or just after a
7940 % backslash sequence, either a lone backslash, or a doubled backslash.
7941 % \next_token contains the first token in the input stream: if it is \finish,
7942 % finish; otherwise, append to \arg_result the segment of the argument up until
7943 % the next backslash. \pending_backslash contains a backslash to represent
7944 % a backslash just before the start of the input stream that has not been
7945 % added to \arg_result.
7946 @gdef@add_segment#1\{%
7947 @ifx@next_token@finish
7948 @let@next=@call_the_macro%
7950 @let@next=@look_ahead
7952 % append to @arg_result
7953 % token list registers might be better
7954 @expandafter@expandafter@expandafter@gdef
7955 @expandafter@expandafter@expandafter@arg_result
7956 @expandafter@expandafter@expandafter{%
7957 @expandafter@arg_result
7958 @pending_backslash#1}%
7959 @def@pending_backslash{\}%
7962 @gdef@call_the_macro{@expandafter@the_macro@expandafter{@arg_result}}
7966 % \braceorline MAC is used for a one-argument macro MAC. It checks
7967 % whether the next non-whitespace character is a {. It sets the context
7968 % for reading the argument (slightly different in the two cases). Then,
7969 % to read the argument, in the whole-line case, it then calls the regular
7970 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
7972 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7973 \def\braceorlinexxx{%
7976 \expandafter\passargtomacro
7978 \macrolineargctxt\expandafter\parsearg
7983 % We need some trickery to remove the optional spaces around the equal
7984 % sign. Make them active and then expand them all to nothing.
7986 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7987 \def\aliasxxx #1{\aliasyyy#1\relax}
7988 \def\aliasyyy #1=#2\relax{%
7990 \expandafter\let\obeyedspace=\empty
7991 \addtomacrolist{#1}%
7992 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7998 \message{cross references,}
8001 \newif\ifhavexrefs % True if xref values are known.
8002 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
8004 % @inforef is relatively simple.
8005 \def\inforef #1{\inforefzzz #1,,,,**}
8006 \def\inforefzzz #1,#2,#3,#4**{%
8007 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8008 node \samp{\ignorespaces#1{}}}
8010 % @node's only job in TeX is to define \lastnode, which is used in
8011 % cross-references. The @node line might or might not have commas, and
8012 % might or might not have spaces before the first comma, like:
8013 % @node foo , bar , ...
8014 % We don't want such trailing spaces in the node name.
8016 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8018 % also remove a trailing comma, in case of something like this:
8019 % @node Help-Cross, , , Cross-refs
8020 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8021 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
8024 \let\lastnode=\empty
8026 % Write a cross-reference definition for the current node. #1 is the
8027 % type (Ynumbered, Yappendix, Ynothing).
8030 \ifx\lastnode\empty\else
8031 \setref{\lastnode}{#1}%
8032 \global\let\lastnode=\empty
8036 % @anchor{NAME} -- define xref target at arbitrary point.
8038 \newcount\savesfregister
8040 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8041 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8042 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8044 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8045 % anchor), which consists of three parts:
8046 % 1) NAME-title - the current sectioning name taken from \lastsection,
8047 % or the anchor name.
8048 % 2) NAME-snt - section number and type, passed as the SNT arg, or
8049 % empty for anchors.
8050 % 3) NAME-pg - the page number.
8052 % This is called from \donoderef, \anchor, and \dofloat. In the case of
8053 % floats, there is an additional part, which is not written here:
8054 % 4) NAME-lof - the text as it should appear in a @listoffloats.
8060 \atdummies % preserve commands, but don't expand them
8061 \edef\writexrdef##1##2{%
8062 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8063 ##1}{##2}}% these are parameters of \writexrdef
8065 \toks0 = \expandafter{\lastsection}%
8066 \immediate \writexrdef{title}{\the\toks0 }%
8067 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8068 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8073 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8074 % automatically in xrefs, if the third arg is not explicitly specified.
8075 % This was provided as a "secret" @set xref-automatic-section-title
8076 % variable, now it's official.
8078 \parseargdef\xrefautomaticsectiontitle{%
8081 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8083 \else\ifx\temp\offword
8084 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8087 \errhelp = \EMsimple
8088 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8094 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
8095 % the node name, #2 the name of the Info cross-reference, #3 the printed
8096 % node name, #4 the name of the Info file, #5 the name of the printed
8097 % manual. All but the node name can be omitted.
8099 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
8100 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
8101 \def\ref#1{\xrefX[#1,,,,,,,]}
8104 \newbox\printedrefnamebox
8105 \newbox\infofilenamebox
8106 \newbox\printedmanualbox
8108 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8111 % Get args without leading/trailing spaces.
8112 \def\printedrefname{\ignorespaces #3}%
8113 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8115 \def\infofilename{\ignorespaces #4}%
8116 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8118 \def\printedmanual{\ignorespaces #5}%
8119 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
8121 % If the printed reference name (arg #3) was not explicitly given in
8122 % the @xref, figure out what we want to use.
8123 \ifdim \wd\printedrefnamebox = 0pt
8124 % No printed node name was explicitly given.
8125 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8126 % Not auto section-title: use node name inside the square brackets.
8127 \def\printedrefname{\ignorespaces #1}%
8129 % Auto section-title: use chapter/section title inside
8130 % the square brackets if we have it.
8131 \ifdim \wd\printedmanualbox > 0pt
8132 % It is in another manual, so we don't have it; use node name.
8133 \def\printedrefname{\ignorespaces #1}%
8136 % We (should) know the real title if we have the xref values.
8137 \def\printedrefname{\refx{#1-title}{}}%
8139 % Otherwise just copy the Info node name.
8140 \def\printedrefname{\ignorespaces #1}%
8146 % Make link in pdf output.
8150 \makevalueexpandable
8151 % This expands tokens, so do it after making catcode changes, so _
8152 % etc. don't get their TeX definitions. This ignores all spaces in
8153 % #4, including (wrongly) those in the middle of the filename.
8156 % This (wrongly) does not take account of leading or trailing
8157 % spaces in #1, which should be ignored.
8158 \edef\pdfxrefdest{#1}%
8159 \ifx\pdfxrefdest\empty
8160 \def\pdfxrefdest{Top}% no empty targets
8162 \txiescapepdf\pdfxrefdest % escape PDF special chars
8166 \startlink attr{/Border [0 0 0]}%
8167 \ifnum\filenamelength>0
8168 goto file{\the\filename.pdf} name{\pdfxrefdest}%
8170 goto name{\pdfmkpgn{\pdfxrefdest}}%
8173 \setcolor{\linkcolor}%
8176 % Float references are printed completely differently: "Figure 1.2"
8177 % instead of "[somenode], p.3". We distinguish them by the
8178 % LABEL-title being set to a magic string.
8180 % Have to otherify everything special to allow the \csname to
8181 % include an _ in the xref name, etc.
8184 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8185 \csname XR#1-title\endcsname
8187 \iffloat\Xthisreftitle
8188 % If the user specified the print name (third arg) to the ref,
8189 % print it instead of our usual "Figure 1.2".
8190 \ifdim\wd\printedrefnamebox = 0pt
8196 % If the user also gave the printed manual name (fifth arg), append
8198 \ifdim \wd\printedmanualbox > 0pt
8199 \space \putwordin{} \cite{\printedmanual}%
8202 % node/anchor (non-float) references.
8204 % If we use \unhbox to print the node names, TeX does not insert
8205 % empty discretionaries after hyphens, which means that it will not
8206 % find a line break at a hyphen in a node names. Since some manuals
8207 % are best written with fairly long node names, containing hyphens,
8208 % this is a loss. Therefore, we give the text of the node name
8209 % again, so it is as if TeX is seeing it for the first time.
8211 \ifdim \wd\printedmanualbox > 0pt
8212 % Cross-manual reference with a printed manual name.
8214 \crossmanualxref{\cite{\printedmanual\unskip}}%
8216 \else\ifdim \wd\infofilenamebox > 0pt
8217 % Cross-manual reference with only an info filename (arg 4), no
8218 % printed manual name (arg 5). This is essentially the same as
8219 % the case above; we output the filename, since we have nothing else.
8221 \crossmanualxref{\code{\infofilename\unskip}}%
8224 % Reference within this manual.
8226 % _ (for example) has to be the character _ for the purposes of the
8227 % control sequence corresponding to the node, but it has to expand
8228 % into the usual \leavevmode...\vrule stuff for purposes of
8229 % printing. So we \turnoffactive for the \refx-snt, back on for the
8230 % printing, back off for the \refx-pg.
8232 % Only output a following space if the -snt ref is nonempty; for
8233 % @unnumbered and @anchor, it won't be.
8234 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8235 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8237 % output the `[mynode]' via the macro below so it can be overridden.
8238 \xrefprintnodename\printedrefname
8240 % But we always want a comma and a space:
8243 % output the `page 3'.
8244 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8250 % Output a cross-manual xref to #1. Used just above (twice).
8252 % Only include the text "Section ``foo'' in" if the foo is neither
8253 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8254 % "see The Foo Manual", the idea being to refer to the whole manual.
8256 % But, this being TeX, we can't easily compare our node name against the
8257 % string "Top" while ignoring the possible spaces before and after in
8258 % the input. By adding the arbitrary 7sp below, we make it much less
8259 % likely that a real node name would have the same width as "Top" (e.g.,
8260 % in a monospaced font). Hopefully it will never happen in practice.
8262 % For the same basic reason, we retypeset the "Top" at every
8263 % reference, since the current font is indeterminate.
8265 \def\crossmanualxref#1{%
8266 \setbox\toprefbox = \hbox{Top\kern7sp}%
8267 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8268 \ifdim \wd2 > 7sp % nonempty?
8269 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8270 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8276 % This macro is called from \xrefX for the `[nodename]' part of xref
8277 % output. It's a separate macro only so it can be changed more easily,
8278 % since square brackets don't work well in some documents. Particularly
8279 % one that Bob is working on :).
8281 \def\xrefprintnodename#1{[#1]}
8283 % Things referred to by \setref.
8289 \putwordChapter@tie \the\chapno
8290 \else \ifnum\subsecno=0
8291 \putwordSection@tie \the\chapno.\the\secno
8292 \else \ifnum\subsubsecno=0
8293 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8295 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8300 \putwordAppendix@tie @char\the\appendixno{}%
8301 \else \ifnum\subsecno=0
8302 \putwordSection@tie @char\the\appendixno.\the\secno
8303 \else \ifnum\subsubsecno=0
8304 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8307 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8311 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8312 % If its value is nonempty, SUFFIX is output afterward.
8318 \expandafter\global\expandafter\let\expandafter\thisrefX
8319 \csname XR#1\endcsname
8322 % If not defined, say something at least.
8323 \angleleft un\-de\-fined\angleright
8326 {\toks0 = {#1}% avoid expansion of possibly-complex value
8327 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8330 \global\warnedxrefstrue
8331 \message{Cross reference values unknown; you must run TeX again.}%
8336 % It's defined, so just use it.
8339 #2% Output the suffix in any case.
8342 % This is the macro invoked by entries in the aux file. Usually it's
8343 % just a \def (we prepend XR to the control sequence name to avoid
8344 % collisions). But if this is a float type, we have more work to do.
8347 {% The node name might contain 8-bit characters, which in our current
8348 % implementation are changed to commands like @'e. Don't let these
8349 % mess up the control sequence name.
8352 \xdef\safexrefname{#1}%
8355 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8357 % Was that xref control sequence that we just defined for a float?
8358 \expandafter\iffloat\csname XR\safexrefname\endcsname
8359 % it was a float, and we have the (safe) float type in \iffloattype.
8360 \expandafter\let\expandafter\floatlist
8361 \csname floatlist\iffloattype\endcsname
8363 % Is this the first time we've seen this float type?
8364 \expandafter\ifx\floatlist\relax
8365 \toks0 = {\do}% yes, so just \do
8367 % had it before, so preserve previous elements in list.
8368 \toks0 = \expandafter{\floatlist\do}%
8371 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8372 % for later use in \listoffloats.
8373 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8378 % Read the last existing aux file, if any. No error if none exists.
8381 \openin 1 \jobname.aux
8384 \global\havexrefstrue
8389 \def\setupdatafile{%
8390 \catcode`\^^@=\other
8391 \catcode`\^^A=\other
8392 \catcode`\^^B=\other
8393 \catcode`\^^C=\other
8394 \catcode`\^^D=\other
8395 \catcode`\^^E=\other
8396 \catcode`\^^F=\other
8397 \catcode`\^^G=\other
8398 \catcode`\^^H=\other
8399 \catcode`\^^K=\other
8400 \catcode`\^^L=\other
8401 \catcode`\^^N=\other
8402 \catcode`\^^P=\other
8403 \catcode`\^^Q=\other
8404 \catcode`\^^R=\other
8405 \catcode`\^^S=\other
8406 \catcode`\^^T=\other
8407 \catcode`\^^U=\other
8408 \catcode`\^^V=\other
8409 \catcode`\^^W=\other
8410 \catcode`\^^X=\other
8411 \catcode`\^^Z=\other
8412 \catcode`\^^[=\other
8413 \catcode`\^^\=\other
8414 \catcode`\^^]=\other
8415 \catcode`\^^^=\other
8416 \catcode`\^^_=\other
8417 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8418 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8419 % supported in the main text, it doesn't seem desirable. Furthermore,
8420 % that is not enough: for node names that actually contain a ^
8421 % character, we would end up writing a line like this: 'xrdef {'hat
8422 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8423 % argument, and \hat is not an expandable control sequence. It could
8424 % all be worked out, but why? Either we support ^^ or we don't.
8426 % The other change necessary for this was to define \auxhat:
8427 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8428 % and then to call \auxhat in \setq.
8432 % Special characters. Should be turned off anyway, but...
8445 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8447 % This is to support \ in node names and titles, since the \
8448 % characters end up in a \csname. It's easier than
8449 % leaving it active and making its active definition an actual \
8450 % character. What I don't understand is why it works in the *value*
8451 % of the xrdef. Seems like it should be a catcode12 \, and that
8452 % should not typeset properly. But it works, so I'm moving on for
8453 % now. --karl, 15jan04.
8456 % Make the characters 128-255 be printing characters.
8457 {\setnonasciicharscatcodenonglobal\other}%
8459 % @ is our escape character in .aux files, and we need braces.
8465 \def\readdatafile#1{%
8472 \message{insertions,}
8473 % including footnotes.
8475 \newcount \footnoteno
8477 % The trailing space in the following definition for supereject is
8478 % vital for proper filling; pages come out unaligned when you do a
8479 % pagealignmacro call if that space before the closing brace is
8480 % removed. (Generally, numeric constants should always be followed by a
8481 % space to prevent strange expansion errors.)
8482 \def\supereject{\par\penalty -20000\footnoteno =0 }
8484 % @footnotestyle is meaningful for Info output only.
8485 \let\footnotestyle=\comment
8489 % Auto-number footnotes. Otherwise like plain.
8491 \global\advance\footnoteno by \@ne
8492 \edef\thisfootno{$^{\the\footnoteno}$}%
8494 % In case the footnote comes at the end of a sentence, preserve the
8495 % extra spacing after we do the footnote number.
8497 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8499 % Remove inadvertent blank space before typesetting the footnote number.
8505 % Don't bother with the trickery in plain.tex to not require the
8506 % footnote text as a parameter. Our footnotes don't need to be so general.
8508 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8509 % \parseargline) fails inside footnotes because the tokens are fixed when
8510 % the footnote is read. --karl, 16nov96.
8513 \insert\footins\bgroup
8515 % Nested footnotes are not supported in TeX, that would take a lot
8516 % more work. (\startsavinginserts does not suffice.)
8517 \let\footnote=\errfootnotenest
8519 % We want to typeset this text as a normal paragraph, even if the
8520 % footnote reference occurs in (for example) a display environment.
8521 % So reset some parameters.
8523 \interlinepenalty\interfootnotelinepenalty
8524 \splittopskip\ht\strutbox % top baseline for broken footnotes
8525 \splitmaxdepth\dp\strutbox
8526 \floatingpenalty\@MM
8531 \parindent\defaultparindent
8535 % Because we use hanging indentation in footnotes, a @noindent appears
8536 % to exdent this text, so make it be a no-op. makeinfo does not use
8537 % hanging indentation so @noindent can still be needed within footnote
8538 % text after an @example or the like (not that this is good style).
8539 \let\noindent = \relax
8541 % Hang the footnote text off the number. Use \everypar in case the
8542 % footnote extends for more than one paragraph.
8543 \everypar = {\hang}%
8544 \textindent{\thisfootno}%
8546 % Don't crash into the line above the footnote text. Since this
8547 % expands into a box, it must come within the paragraph, lest it
8548 % provide a place where TeX can split the footnote.
8551 % Invoke rest of plain TeX footnote routine.
8552 \futurelet\next\fo@t
8554 }%end \catcode `\@=11
8556 \def\errfootnotenest{%
8558 \errmessage{Nested footnotes not supported in texinfo.tex,
8559 even though they work in makeinfo; sorry}
8562 \def\errfootnoteheading{%
8564 \errmessage{Footnotes in chapters, sections, etc., are not supported}
8567 % In case a @footnote appears in a vbox, save the footnote text and create
8568 % the real \insert just after the vbox finished. Otherwise, the insertion
8570 % Similarly, if a @footnote appears inside an alignment, save the footnote
8571 % text to a box and make the \insert when a row of the table is finished.
8572 % And the same can be done for other insert classes. --kasal, 16nov03.
8574 % Replace the \insert primitive by a cheating macro.
8575 % Deeper inside, just make sure that the saved insertions are not spilled
8578 \def\startsavinginserts{%
8579 \ifx \insert\ptexinsert
8580 \let\insert\saveinsert
8582 \let\checkinserts\relax
8586 % This \insert replacement works for both \insert\footins{foo} and
8587 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8590 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8591 \afterassignment\next
8592 % swallow the left brace
8595 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8596 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8598 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8600 \def\placesaveins#1{%
8601 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8605 % eat @SAVE -- beware, all of them have catcode \other:
8607 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8608 \gdef\gobblesave @SAVE{}
8612 \def\newsaveins #1{%
8613 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8616 \def\newsaveinsX #1{%
8617 \csname newbox\endcsname #1%
8618 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8623 \let\checkinserts\empty
8628 % @image. We use the macros from epsf.tex to support this.
8629 % If epsf.tex is not installed and @image is used, we complain.
8631 % Check for and read epsf.tex up front. If we read it only at @image
8632 % time, we might be inside a group, and then its definitions would get
8633 % undone and the next image would fail.
8634 \openin 1 = epsf.tex
8636 % Do not bother showing banner with epsf.tex v2.7k (available in
8637 % doc/epsf.tex and on ctan).
8638 \def\epsfannounce{\toks0 = }%
8643 % We will only complain once about lack of epsf.tex.
8644 \newif\ifwarnednoepsf
8645 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8646 work. It is also included in the Texinfo distribution, or you can get
8647 it from ftp://tug.org/tex/epsf.tex.}
8650 \ifx\epsfbox\thisisundefined
8651 \ifwarnednoepsf \else
8652 \errhelp = \noepsfhelp
8653 \errmessage{epsf.tex not found, images will be ignored}%
8654 \global\warnednoepsftrue
8657 \imagexxx #1,,,,,\finish
8661 % Arguments to @image:
8662 % #1 is (mandatory) image filename; we tack on .eps extension.
8663 % #2 is (optional) width, #3 is (optional) height.
8664 % #4 is (ignored optional) html alt text.
8665 % #5 is (ignored optional) extension.
8666 % #6 is just the usual extra ignored arg for parsing stuff.
8668 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8669 \catcode`\^^M = 5 % in case we're inside an example
8670 \normalturnoffactive % allow _ et al. in names
8671 % If the image is by itself, center it.
8674 \else \ifx\centersub\centerV
8675 % for @center @image, we need a vbox so we can have our vertical space
8677 \vbox\bgroup % vbox has better behavior than vtop herev
8682 % Usually we'll have text after the image which will insert
8683 % \parskip glue, so insert it here too to equalize the space
8685 \nobreak\vskip\parskip
8689 % Leave vertical mode so that indentation from an enclosing
8690 % environment such as @quotation is respected.
8691 % However, if we're at the top level, we don't want the
8692 % normal paragraph indentation.
8693 % On the other hand, if we are in the case of @center @image, we don't
8694 % want to start a paragraph, which will create a hsize-width box and
8695 % eradicate the centering.
8696 \ifx\centersub\centerV\else \noindent \fi
8700 \dopdfimage{#1}{#2}{#3}%
8702 % \epsfbox itself resets \epsf?size at each figure.
8703 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8704 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8709 \medskip % space after a standalone image
8711 \ifx\centersub\centerV \egroup \fi
8715 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8716 % etc. We don't actually implement floating yet, we always include the
8717 % float "here". But it seemed the best name for the future.
8719 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8721 % There may be a space before second and/or third parameter; delete it.
8722 \def\eatcommaspace#1, {#1,}
8724 % #1 is the optional FLOATTYPE, the text label for this float, typically
8725 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8726 % this float will not be numbered and cannot be referred to.
8728 % #2 is the optional xref label. Also must be present for the float to
8731 % #3 is the optional positioning argument; for now, it is ignored. It
8732 % will somehow specify the positions allowed to float to (here, top, bottom).
8734 % We keep a separate counter for each FLOATTYPE, which we reset at each
8735 % chapter-level command.
8736 \let\resetallfloatnos=\empty
8738 \def\dofloat#1,#2,#3,#4\finish{%
8739 \let\thiscaption=\empty
8740 \let\thisshortcaption=\empty
8742 % don't lose footnotes inside @float.
8744 % BEWARE: when the floats start float, we have to issue warning whenever an
8745 % insert appears inside a float which could possibly float. --kasal, 26may04
8749 % We can't be used inside a paragraph.
8754 \def\floatlabel{#2}%
8755 \def\floatloc{#3}% we do nothing with this yet.
8757 \ifx\floattype\empty
8758 \let\safefloattype=\empty
8761 % the floattype might have accents or other special characters,
8762 % but we need to use it in a control sequence name.
8765 \xdef\safefloattype{\floattype}%
8769 % If label is given but no type, we handle that as the empty type.
8770 \ifx\floatlabel\empty \else
8771 % We want each FLOATTYPE to be numbered separately (Figure 1,
8772 % Table 1, Figure 2, ...). (And if no label, no number.)
8774 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8775 \global\advance\floatno by 1
8778 % This magic value for \lastsection is output by \setref as the
8779 % XREFLABEL-title value. \xrefX uses it to distinguish float
8780 % labels (which have a completely different output format) from
8781 % node and anchor labels. And \xrdef uses it to construct the
8784 \edef\lastsection{\floatmagic=\safefloattype}%
8785 \setref{\floatlabel}{Yfloat}%
8789 % start with \parskip glue, I guess.
8792 % Don't suppress indentation if a float happens to start a section.
8793 \restorefirstparagraphindent
8796 % we have these possibilities:
8797 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8798 % @float Foo,lbl & no caption: Foo 1.1
8799 % @float Foo & @caption{Cap}: Foo: Cap
8800 % @float Foo & no caption: Foo
8801 % @float ,lbl & Caption{Cap}: 1.1: Cap
8802 % @float ,lbl & no caption: 1.1
8803 % @float & @caption{Cap}: Cap
8804 % @float & no caption:
8807 \let\floatident = \empty
8809 % In all cases, if we have a float type, it comes first.
8810 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8812 % If we have an xref label, the number comes next.
8813 \ifx\floatlabel\empty \else
8814 \ifx\floattype\empty \else % if also had float type, need tie first.
8815 \appendtomacro\floatident{\tie}%
8818 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8821 % Start the printed caption with what we've constructed in
8822 % \floatident, but keep it separate; we need \floatident again.
8823 \let\captionline = \floatident
8825 \ifx\thiscaption\empty \else
8826 \ifx\floatident\empty \else
8827 \appendtomacro\captionline{: }% had ident, so need a colon between
8831 \appendtomacro\captionline{\scanexp\thiscaption}%
8834 % If we have anything to print, print it, with space before.
8835 % Eventually this needs to become an \insert.
8836 \ifx\captionline\empty \else
8840 % Space below caption.
8844 % If have an xref label, write the list of floats info. Do this
8845 % after the caption, to avoid chance of it being a breakpoint.
8846 \ifx\floatlabel\empty \else
8847 % Write the text that goes in the lof to the aux file as
8848 % \floatlabel-lof. Besides \floatident, we include the short
8849 % caption if specified, else the full caption if specified, else nothing.
8853 % since we read the caption text in the macro world, where ^^M
8854 % is turned into a normal character, we have to scan it back, so
8855 % we don't write the literal three characters "^^M" into the aux file.
8857 \xdef\noexpand\gtemp{%
8858 \ifx\thisshortcaption\empty
8865 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8866 \ifx\gtemp\empty \else : \gtemp \fi}}%
8869 \egroup % end of \vtop
8871 % place the captured inserts
8873 % BEWARE: when the floats start floating, we have to issue warning
8874 % whenever an insert appears inside a float which could possibly
8875 % float. --kasal, 26may04
8880 % Append the tokens #2 to the definition of macro #1, not expanding either.
8882 \def\appendtomacro#1#2{%
8883 \expandafter\def\expandafter#1\expandafter{#1#2}%
8886 % @caption, @shortcaption
8888 \def\caption{\docaption\thiscaption}
8889 \def\shortcaption{\docaption\thisshortcaption}
8890 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8891 \def\defcaption#1#2{\egroup \def#1{#2}}
8893 % The parameter is the control sequence identifying the counter we are
8894 % going to use. Create it if it doesn't exist and assign it to \floatno.
8897 % Haven't seen this figure type before.
8898 \csname newcount\endcsname #1%
8900 % Remember to reset this floatno at the next chap.
8901 \expandafter\gdef\expandafter\resetallfloatnos
8902 \expandafter{\resetallfloatnos #1=0 }%
8907 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8908 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8909 % first read the @float command.
8911 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8913 % Magic string used for the XREFLABEL-title value, so \xrefX can
8914 % distinguish floats from other xref types.
8915 \def\floatmagic{!!float!!}
8917 % #1 is the control sequence we are passed; we expand into a conditional
8918 % which is true if #1 represents a float ref. That is, the magic
8919 % \lastsection value which we \setref above.
8921 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8923 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8924 % (safe) float type for this float. We set \iffloattype to #2.
8926 \def\doiffloat#1=#2=#3\finish{%
8928 \def\iffloattype{#2}%
8929 \ifx\temp\floatmagic
8932 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8934 \parseargdef\listoffloats{%
8935 \def\floattype{#1}% floattype
8937 % the floattype might have accents or other special characters,
8938 % but we need to use it in a control sequence name.
8941 \xdef\safefloattype{\floattype}%
8944 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8945 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8947 % if the user said @listoffloats foo but never @float foo.
8948 \message{\linenumber No `\safefloattype' floats to list.}%
8952 \leftskip=\tocindent % indent these entries like a toc
8953 \let\do=\listoffloatsdo
8954 \csname floatlist\safefloattype\endcsname
8959 % This is called on each entry in a list of floats. We're passed the
8960 % xref label, in the form LABEL-title, which is how we save it in the
8961 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8962 % has the text we're supposed to typeset here.
8964 % Figures without xref labels will not be included in the list (since
8965 % they won't appear in the aux file).
8967 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8968 \def\listoffloatsdoentry#1-title\finish{{%
8969 % Can't fully expand XR#1-lof because it can contain anything. Just
8970 % pass the control sequence. On the other hand, XR#1-pg is just the
8971 % page number, and we want to fully expand that so we can get a link
8973 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8975 % use the same \entry macro we use to generate the TOC and index.
8976 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8981 \message{localization,}
8983 % For single-language documents, @documentlanguage is usually given very
8984 % early, just after @documentencoding. Single argument is the language
8985 % (de) or locale (de_DE) abbreviation.
8988 \catcode`\_ = \active
8990 \parseargdef\documentlanguage{%
8991 \tex % read txi-??.tex file in plain TeX.
8992 % Read the file by the name they passed if it exists.
8993 \let_ = \normalunderscore % normal _ character for filename test
8994 \openin 1 txi-#1.tex
8996 \documentlanguagetrywithoutunderscore #1_\finish
8998 \globaldefs = 1 % everything in the txi-LL files needs to persist
9002 \endgroup % end raw TeX
9005 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9008 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9009 \openin 1 txi-#1.tex
9011 \errhelp = \nolanghelp
9012 \errmessage{Cannot read language file txi-#1.tex}%
9014 \globaldefs = 1 % everything in the txi-LL files needs to persist
9019 }% end of special _ catcode
9021 \newhelp\nolanghelp{The given language definition file cannot be found or
9022 is empty. Maybe you need to install it? Putting it in the current
9023 directory should work if nowhere else does.}
9025 % This macro is called from txi-??.tex files; the first argument is the
9026 % \language name to set (without the "\lang@" prefix), the second and
9027 % third args are \{left,right}hyphenmin.
9029 % The language names to pass are determined when the format is built.
9030 % See the etex.log file created at that time, e.g.,
9031 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9033 % With TeX Live 2008, etex now includes hyphenation patterns for all
9034 % available languages. This means we can support hyphenation in
9035 % Texinfo, at least to some extent. (This still doesn't solve the
9036 % accented characters problem.)
9039 \def\txisetlanguage#1#2#3{%
9040 % do not set the language if the name is undefined in the current TeX.
9041 \expandafter\ifx\csname lang@#1\endcsname \relax
9042 \message{no patterns for #1}%
9044 \global\language = \csname lang@#1\endcsname
9046 % but there is no harm in adjusting the hyphenmin values regardless.
9047 \global\lefthyphenmin = #2\relax
9048 \global\righthyphenmin = #3\relax
9051 % Helpers for encodings.
9052 % Set the catcode of characters 128 through 255 to the specified number.
9054 \def\setnonasciicharscatcode#1{%
9056 \loop\ifnum\count255<256
9057 \global\catcode\count255=#1\relax
9058 \advance\count255 by 1
9062 \def\setnonasciicharscatcodenonglobal#1{%
9064 \loop\ifnum\count255<256
9065 \catcode\count255=#1\relax
9066 \advance\count255 by 1
9070 % @documentencoding sets the definition of non-ASCII characters
9071 % according to the specified encoding.
9073 \parseargdef\documentencoding{%
9074 % Encoding being declared for the document.
9075 \def\declaredencoding{\csname #1.enc\endcsname}%
9077 % Supported encodings: names converted to tokens in order to be able
9078 % to compare them with \ifx.
9079 \def\ascii{\csname US-ASCII.enc\endcsname}%
9080 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9081 \def\latone{\csname ISO-8859-1.enc\endcsname}%
9082 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9083 \def\utfeight{\csname UTF-8.enc\endcsname}%
9085 \ifx \declaredencoding \ascii
9088 \else \ifx \declaredencoding \lattwo
9089 \setnonasciicharscatcode\active
9092 \else \ifx \declaredencoding \latone
9093 \setnonasciicharscatcode\active
9096 \else \ifx \declaredencoding \latnine
9097 \setnonasciicharscatcode\active
9100 \else \ifx \declaredencoding \utfeight
9101 \setnonasciicharscatcode\active
9102 % since we already invoked \utfeightchardefs at the top level
9103 % (below), do not re-invoke it, then our check for duplicated
9104 % definitions triggers. Making non-ascii chars active is enough.
9107 \message{Ignoring unknown document encoding: #1.}%
9117 % A message to be logged when using a character that isn't available
9118 % the default font encoding (OT1).
9120 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9122 % Take account of \c (plain) vs. \, (Texinfo) difference.
9123 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9125 % First, make active non-ASCII characters in order for them to be
9126 % correctly categorized when TeX reads the replacement text of
9127 % macros containing the character definitions.
9128 \setnonasciicharscatcode\active
9130 % Latin1 (ISO-8859-1) character definitions.
9131 \def\latonechardefs{%
9133 \gdef^^a1{\exclamdown}
9134 \gdef^^a2{{\tcfont \char162}} % cent
9136 \gdef^^a4{{\tcfont \char164}} % currency
9137 \gdef^^a5{{\tcfont \char165}} % yen
9138 \gdef^^a6{{\tcfont \char166}} % broken bar
9141 \gdef^^a9{\copyright}
9143 \gdef^^ab{\guillemetleft}
9144 \gdef^^ac{\ensuremath\lnot}
9146 \gdef^^ae{\registeredsymbol}
9149 \gdef^^b0{\textdegree}
9156 \gdef^^b7{\ensuremath\cdot}
9157 \gdef^^b8{\cedilla\ }
9160 \gdef^^bb{\guillemetright}
9161 \gdef^^bc{$1\over4$}
9162 \gdef^^bd{$1\over2$}
9163 \gdef^^be{$3\over4$}
9164 \gdef^^bf{\questiondown}
9171 \gdef^^c5{\ringaccent A}
9173 \gdef^^c7{\cedilla C}
9205 \gdef^^e5{\ringaccent a}
9207 \gdef^^e7{\cedilla c}
9212 \gdef^^ec{\`{\dotless i}}
9213 \gdef^^ed{\'{\dotless i}}
9214 \gdef^^ee{\^{\dotless i}}
9215 \gdef^^ef{\"{\dotless i}}
9235 % Latin9 (ISO-8859-15) encoding character definitions.
9236 \def\latninechardefs{%
9237 % Encoding is almost identical to Latin1.
9250 % Latin2 (ISO-8859-2) character definitions.
9251 \def\lattwochardefs{%
9253 \gdef^^a1{\ogonek{A}}
9256 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9262 \gdef^^aa{\cedilla S}
9267 \gdef^^af{\dotaccent Z}
9269 \gdef^^b0{\textdegree}
9270 \gdef^^b1{\ogonek{a}}
9271 \gdef^^b2{\ogonek{ }}
9277 \gdef^^b8{\cedilla\ }
9279 \gdef^^ba{\cedilla s}
9284 \gdef^^bf{\dotaccent z}
9293 \gdef^^c7{\cedilla C}
9296 \gdef^^ca{\ogonek{E}}
9312 \gdef^^d9{\ringaccent U}
9317 \gdef^^de{\cedilla T}
9327 \gdef^^e7{\cedilla c}
9330 \gdef^^ea{\ogonek{e}}
9333 \gdef^^ed{\'{\dotless{i}}}
9334 \gdef^^ee{\^{\dotless{i}}}
9346 \gdef^^f9{\ringaccent u}
9351 \gdef^^fe{\cedilla t}
9352 \gdef^^ff{\dotaccent{}}
9355 % UTF-8 character definitions.
9357 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9358 % changes for Texinfo conventions. It is included here under the GPL by
9359 % permission from Frank Mittelbach and the LaTeX team.
9365 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9366 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9368 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9369 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9371 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9372 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9374 \gdef\UTFviiiDefined#1{%
9376 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9387 \global\catcode\countUTFx\active
9388 \uccode`\~\countUTFx
9389 \uppercase\expandafter{\UTFviiiTmp}%
9390 \advance\countUTFx by 1
9391 \ifnum\countUTFx < \countUTFy
9392 \expandafter\UTFviiiLoop
9398 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9404 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9410 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9414 \def\globallet{\global\let} % save some \expandafter's below
9416 % @U{xxxx} to produce U+xxxx, if we support it.
9418 \expandafter\ifx\csname uni:#1\endcsname \relax
9419 \errhelp = \EMsimple
9420 \errmessage{Unicode character U+#1 not supported, sorry}%
9422 \csname uni:#1\endcsname
9434 \gdef\DeclareUnicodeCharacter#1#2{%
9435 \countUTFz = "#1\relax
9436 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9439 \def\UTFviiiTwoOctets##1##2{%
9440 \csname u8:##1\string ##2\endcsname}%
9441 \def\UTFviiiThreeOctets##1##2##3{%
9442 \csname u8:##1\string ##2\string ##3\endcsname}%
9443 \def\UTFviiiFourOctets##1##2##3##4{%
9444 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9445 \expandafter\expandafter\expandafter\expandafter
9446 \expandafter\expandafter\expandafter
9447 \gdef\UTFviiiTmp{#2}%
9449 \expandafter\ifx\csname uni:#1\endcsname \relax \else
9450 \errmessage{Internal error, already defined: #1}%
9453 % define an additional control sequence for this code point.
9454 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
9457 \gdef\parseXMLCharref{%
9458 \ifnum\countUTFz < "A0\relax
9459 \errhelp = \EMsimple
9460 \errmessage{Cannot define Unicode char value < 00A0}%
9461 \else\ifnum\countUTFz < "800\relax
9463 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9464 \else\ifnum\countUTFz < "10000\relax
9467 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9472 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9476 \gdef\parseUTFviiiA#1{%
9477 \countUTFx = \countUTFz
9478 \divide\countUTFz by 64
9479 \countUTFy = \countUTFz
9480 \multiply\countUTFz by 64
9481 \advance\countUTFx by -\countUTFz
9482 \advance\countUTFx by 128
9483 \uccode `#1\countUTFx
9484 \countUTFz = \countUTFy}
9486 \gdef\parseUTFviiiB#1#2#3#4{%
9487 \advance\countUTFz by "#10\relax
9488 \uccode `#3\countUTFz
9489 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9492 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
9493 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
9494 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
9495 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
9496 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
9498 % Many of our renditions are less than wonderful, and all the missing
9499 % characters are available somewhere. Loading the necessary fonts
9500 % awaits user request. We can't truly support Unicode without
9501 % reimplementing everything that's been done in LaTeX for many years,
9502 % plus probably using luatex or xetex, and who knows what else.
9503 % We won't be doing that here in this simple file. But we can try to at
9504 % least make most of the characters not bomb out.
9506 \def\utfeightchardefs{%
9507 \DeclareUnicodeCharacter{00A0}{\tie}
9508 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9509 \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
9510 \DeclareUnicodeCharacter{00A3}{\pounds}
9511 \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
9512 \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
9513 \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
9514 \DeclareUnicodeCharacter{00A7}{\S}
9515 \DeclareUnicodeCharacter{00A8}{\"{ }}
9516 \DeclareUnicodeCharacter{00A9}{\copyright}
9517 \DeclareUnicodeCharacter{00AA}{\ordf}
9518 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9519 \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}
9520 \DeclareUnicodeCharacter{00AD}{\-}
9521 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9522 \DeclareUnicodeCharacter{00AF}{\={ }}
9524 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9525 \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}
9526 \DeclareUnicodeCharacter{00B2}{$^2$}
9527 \DeclareUnicodeCharacter{00B3}{$^3$}
9528 \DeclareUnicodeCharacter{00B4}{\'{ }}
9529 \DeclareUnicodeCharacter{00B5}{$\mu$}
9530 \DeclareUnicodeCharacter{00B6}{\P}
9531 \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}
9532 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9533 \DeclareUnicodeCharacter{00B9}{$^1$}
9534 \DeclareUnicodeCharacter{00BA}{\ordm}
9535 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9536 \DeclareUnicodeCharacter{00BC}{$1\over4$}
9537 \DeclareUnicodeCharacter{00BD}{$1\over2$}
9538 \DeclareUnicodeCharacter{00BE}{$3\over4$}
9539 \DeclareUnicodeCharacter{00BF}{\questiondown}
9541 \DeclareUnicodeCharacter{00C0}{\`A}
9542 \DeclareUnicodeCharacter{00C1}{\'A}
9543 \DeclareUnicodeCharacter{00C2}{\^A}
9544 \DeclareUnicodeCharacter{00C3}{\~A}
9545 \DeclareUnicodeCharacter{00C4}{\"A}
9546 \DeclareUnicodeCharacter{00C5}{\AA}
9547 \DeclareUnicodeCharacter{00C6}{\AE}
9548 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9549 \DeclareUnicodeCharacter{00C8}{\`E}
9550 \DeclareUnicodeCharacter{00C9}{\'E}
9551 \DeclareUnicodeCharacter{00CA}{\^E}
9552 \DeclareUnicodeCharacter{00CB}{\"E}
9553 \DeclareUnicodeCharacter{00CC}{\`I}
9554 \DeclareUnicodeCharacter{00CD}{\'I}
9555 \DeclareUnicodeCharacter{00CE}{\^I}
9556 \DeclareUnicodeCharacter{00CF}{\"I}
9558 \DeclareUnicodeCharacter{00D0}{\DH}
9559 \DeclareUnicodeCharacter{00D1}{\~N}
9560 \DeclareUnicodeCharacter{00D2}{\`O}
9561 \DeclareUnicodeCharacter{00D3}{\'O}
9562 \DeclareUnicodeCharacter{00D4}{\^O}
9563 \DeclareUnicodeCharacter{00D5}{\~O}
9564 \DeclareUnicodeCharacter{00D6}{\"O}
9565 \DeclareUnicodeCharacter{00D7}{\ensuremath\times}
9566 \DeclareUnicodeCharacter{00D8}{\O}
9567 \DeclareUnicodeCharacter{00D9}{\`U}
9568 \DeclareUnicodeCharacter{00DA}{\'U}
9569 \DeclareUnicodeCharacter{00DB}{\^U}
9570 \DeclareUnicodeCharacter{00DC}{\"U}
9571 \DeclareUnicodeCharacter{00DD}{\'Y}
9572 \DeclareUnicodeCharacter{00DE}{\TH}
9573 \DeclareUnicodeCharacter{00DF}{\ss}
9575 \DeclareUnicodeCharacter{00E0}{\`a}
9576 \DeclareUnicodeCharacter{00E1}{\'a}
9577 \DeclareUnicodeCharacter{00E2}{\^a}
9578 \DeclareUnicodeCharacter{00E3}{\~a}
9579 \DeclareUnicodeCharacter{00E4}{\"a}
9580 \DeclareUnicodeCharacter{00E5}{\aa}
9581 \DeclareUnicodeCharacter{00E6}{\ae}
9582 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9583 \DeclareUnicodeCharacter{00E8}{\`e}
9584 \DeclareUnicodeCharacter{00E9}{\'e}
9585 \DeclareUnicodeCharacter{00EA}{\^e}
9586 \DeclareUnicodeCharacter{00EB}{\"e}
9587 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9588 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9589 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9590 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9592 \DeclareUnicodeCharacter{00F0}{\dh}
9593 \DeclareUnicodeCharacter{00F1}{\~n}
9594 \DeclareUnicodeCharacter{00F2}{\`o}
9595 \DeclareUnicodeCharacter{00F3}{\'o}
9596 \DeclareUnicodeCharacter{00F4}{\^o}
9597 \DeclareUnicodeCharacter{00F5}{\~o}
9598 \DeclareUnicodeCharacter{00F6}{\"o}
9599 \DeclareUnicodeCharacter{00F7}{\ensuremath\div}
9600 \DeclareUnicodeCharacter{00F8}{\o}
9601 \DeclareUnicodeCharacter{00F9}{\`u}
9602 \DeclareUnicodeCharacter{00FA}{\'u}
9603 \DeclareUnicodeCharacter{00FB}{\^u}
9604 \DeclareUnicodeCharacter{00FC}{\"u}
9605 \DeclareUnicodeCharacter{00FD}{\'y}
9606 \DeclareUnicodeCharacter{00FE}{\th}
9607 \DeclareUnicodeCharacter{00FF}{\"y}
9609 \DeclareUnicodeCharacter{0100}{\=A}
9610 \DeclareUnicodeCharacter{0101}{\=a}
9611 \DeclareUnicodeCharacter{0102}{\u{A}}
9612 \DeclareUnicodeCharacter{0103}{\u{a}}
9613 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9614 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9615 \DeclareUnicodeCharacter{0106}{\'C}
9616 \DeclareUnicodeCharacter{0107}{\'c}
9617 \DeclareUnicodeCharacter{0108}{\^C}
9618 \DeclareUnicodeCharacter{0109}{\^c}
9619 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9620 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9621 \DeclareUnicodeCharacter{010C}{\v{C}}
9622 \DeclareUnicodeCharacter{010D}{\v{c}}
9623 \DeclareUnicodeCharacter{010E}{\v{D}}
9624 \DeclareUnicodeCharacter{010F}{d'}
9626 \DeclareUnicodeCharacter{0110}{\DH}
9627 \DeclareUnicodeCharacter{0111}{\dh}
9628 \DeclareUnicodeCharacter{0112}{\=E}
9629 \DeclareUnicodeCharacter{0113}{\=e}
9630 \DeclareUnicodeCharacter{0114}{\u{E}}
9631 \DeclareUnicodeCharacter{0115}{\u{e}}
9632 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9633 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9634 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9635 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9636 \DeclareUnicodeCharacter{011A}{\v{E}}
9637 \DeclareUnicodeCharacter{011B}{\v{e}}
9638 \DeclareUnicodeCharacter{011C}{\^G}
9639 \DeclareUnicodeCharacter{011D}{\^g}
9640 \DeclareUnicodeCharacter{011E}{\u{G}}
9641 \DeclareUnicodeCharacter{011F}{\u{g}}
9643 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9644 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9645 \DeclareUnicodeCharacter{0122}{\cedilla{G}}
9646 \DeclareUnicodeCharacter{0123}{\cedilla{g}}
9647 \DeclareUnicodeCharacter{0124}{\^H}
9648 \DeclareUnicodeCharacter{0125}{\^h}
9649 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}
9650 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}
9651 \DeclareUnicodeCharacter{0128}{\~I}
9652 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9653 \DeclareUnicodeCharacter{012A}{\=I}
9654 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9655 \DeclareUnicodeCharacter{012C}{\u{I}}
9656 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9657 \DeclareUnicodeCharacter{012E}{\ogonek{I}}
9658 \DeclareUnicodeCharacter{012F}{\ogonek{i}}
9660 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9661 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9662 \DeclareUnicodeCharacter{0132}{IJ}
9663 \DeclareUnicodeCharacter{0133}{ij}
9664 \DeclareUnicodeCharacter{0134}{\^J}
9665 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9666 \DeclareUnicodeCharacter{0136}{\cedilla{K}}
9667 \DeclareUnicodeCharacter{0137}{\cedilla{k}}
9668 \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}
9669 \DeclareUnicodeCharacter{0139}{\'L}
9670 \DeclareUnicodeCharacter{013A}{\'l}
9671 \DeclareUnicodeCharacter{013B}{\cedilla{L}}
9672 \DeclareUnicodeCharacter{013C}{\cedilla{l}}
9673 \DeclareUnicodeCharacter{013D}{L'}% should kern
9674 \DeclareUnicodeCharacter{013E}{l'}% should kern
9675 \DeclareUnicodeCharacter{013F}{L\U{00B7}}
9677 \DeclareUnicodeCharacter{0140}{l\U{00B7}}
9678 \DeclareUnicodeCharacter{0141}{\L}
9679 \DeclareUnicodeCharacter{0142}{\l}
9680 \DeclareUnicodeCharacter{0143}{\'N}
9681 \DeclareUnicodeCharacter{0144}{\'n}
9682 \DeclareUnicodeCharacter{0145}{\cedilla{N}}
9683 \DeclareUnicodeCharacter{0146}{\cedilla{n}}
9684 \DeclareUnicodeCharacter{0147}{\v{N}}
9685 \DeclareUnicodeCharacter{0148}{\v{n}}
9686 \DeclareUnicodeCharacter{0149}{'n}
9687 \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}
9688 \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}
9689 \DeclareUnicodeCharacter{014C}{\=O}
9690 \DeclareUnicodeCharacter{014D}{\=o}
9691 \DeclareUnicodeCharacter{014E}{\u{O}}
9692 \DeclareUnicodeCharacter{014F}{\u{o}}
9694 \DeclareUnicodeCharacter{0150}{\H{O}}
9695 \DeclareUnicodeCharacter{0151}{\H{o}}
9696 \DeclareUnicodeCharacter{0152}{\OE}
9697 \DeclareUnicodeCharacter{0153}{\oe}
9698 \DeclareUnicodeCharacter{0154}{\'R}
9699 \DeclareUnicodeCharacter{0155}{\'r}
9700 \DeclareUnicodeCharacter{0156}{\cedilla{R}}
9701 \DeclareUnicodeCharacter{0157}{\cedilla{r}}
9702 \DeclareUnicodeCharacter{0158}{\v{R}}
9703 \DeclareUnicodeCharacter{0159}{\v{r}}
9704 \DeclareUnicodeCharacter{015A}{\'S}
9705 \DeclareUnicodeCharacter{015B}{\'s}
9706 \DeclareUnicodeCharacter{015C}{\^S}
9707 \DeclareUnicodeCharacter{015D}{\^s}
9708 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9709 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9711 \DeclareUnicodeCharacter{0160}{\v{S}}
9712 \DeclareUnicodeCharacter{0161}{\v{s}}
9713 \DeclareUnicodeCharacter{0162}{\cedilla{T}}
9714 \DeclareUnicodeCharacter{0163}{\cedilla{t}}
9715 \DeclareUnicodeCharacter{0164}{\v{T}}
9716 \DeclareUnicodeCharacter{0165}{\v{t}}
9717 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}
9718 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}
9719 \DeclareUnicodeCharacter{0168}{\~U}
9720 \DeclareUnicodeCharacter{0169}{\~u}
9721 \DeclareUnicodeCharacter{016A}{\=U}
9722 \DeclareUnicodeCharacter{016B}{\=u}
9723 \DeclareUnicodeCharacter{016C}{\u{U}}
9724 \DeclareUnicodeCharacter{016D}{\u{u}}
9725 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9726 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9728 \DeclareUnicodeCharacter{0170}{\H{U}}
9729 \DeclareUnicodeCharacter{0171}{\H{u}}
9730 \DeclareUnicodeCharacter{0172}{\ogonek{U}}
9731 \DeclareUnicodeCharacter{0173}{\ogonek{u}}
9732 \DeclareUnicodeCharacter{0174}{\^W}
9733 \DeclareUnicodeCharacter{0175}{\^w}
9734 \DeclareUnicodeCharacter{0176}{\^Y}
9735 \DeclareUnicodeCharacter{0177}{\^y}
9736 \DeclareUnicodeCharacter{0178}{\"Y}
9737 \DeclareUnicodeCharacter{0179}{\'Z}
9738 \DeclareUnicodeCharacter{017A}{\'z}
9739 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9740 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9741 \DeclareUnicodeCharacter{017D}{\v{Z}}
9742 \DeclareUnicodeCharacter{017E}{\v{z}}
9743 \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}
9745 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9746 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9747 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9748 \DeclareUnicodeCharacter{01C7}{LJ}
9749 \DeclareUnicodeCharacter{01C8}{Lj}
9750 \DeclareUnicodeCharacter{01C9}{lj}
9751 \DeclareUnicodeCharacter{01CA}{NJ}
9752 \DeclareUnicodeCharacter{01CB}{Nj}
9753 \DeclareUnicodeCharacter{01CC}{nj}
9754 \DeclareUnicodeCharacter{01CD}{\v{A}}
9755 \DeclareUnicodeCharacter{01CE}{\v{a}}
9756 \DeclareUnicodeCharacter{01CF}{\v{I}}
9758 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9759 \DeclareUnicodeCharacter{01D1}{\v{O}}
9760 \DeclareUnicodeCharacter{01D2}{\v{o}}
9761 \DeclareUnicodeCharacter{01D3}{\v{U}}
9762 \DeclareUnicodeCharacter{01D4}{\v{u}}
9764 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9765 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9766 \DeclareUnicodeCharacter{01E6}{\v{G}}
9767 \DeclareUnicodeCharacter{01E7}{\v{g}}
9768 \DeclareUnicodeCharacter{01E8}{\v{K}}
9769 \DeclareUnicodeCharacter{01E9}{\v{k}}
9771 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9772 \DeclareUnicodeCharacter{01F1}{DZ}
9773 \DeclareUnicodeCharacter{01F2}{Dz}
9774 \DeclareUnicodeCharacter{01F3}{dz}
9775 \DeclareUnicodeCharacter{01F4}{\'G}
9776 \DeclareUnicodeCharacter{01F5}{\'g}
9777 \DeclareUnicodeCharacter{01F8}{\`N}
9778 \DeclareUnicodeCharacter{01F9}{\`n}
9779 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9780 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9781 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9782 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9784 \DeclareUnicodeCharacter{021E}{\v{H}}
9785 \DeclareUnicodeCharacter{021F}{\v{h}}
9787 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9788 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9789 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9790 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9791 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9792 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9794 \DeclareUnicodeCharacter{0232}{\=Y}
9795 \DeclareUnicodeCharacter{0233}{\=y}
9796 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9798 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9800 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9801 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9802 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9803 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9804 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9805 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9806 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9807 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9808 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9809 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9810 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9811 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9813 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9814 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9816 \DeclareUnicodeCharacter{1E20}{\=G}
9817 \DeclareUnicodeCharacter{1E21}{\=g}
9818 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9819 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9820 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9821 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9822 \DeclareUnicodeCharacter{1E26}{\"H}
9823 \DeclareUnicodeCharacter{1E27}{\"h}
9825 \DeclareUnicodeCharacter{1E30}{\'K}
9826 \DeclareUnicodeCharacter{1E31}{\'k}
9827 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9828 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9829 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9830 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9831 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9832 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9833 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9834 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9835 \DeclareUnicodeCharacter{1E3E}{\'M}
9836 \DeclareUnicodeCharacter{1E3F}{\'m}
9838 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9839 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9840 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9841 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9842 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9843 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9844 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9845 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9846 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9847 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9849 \DeclareUnicodeCharacter{1E54}{\'P}
9850 \DeclareUnicodeCharacter{1E55}{\'p}
9851 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9852 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9853 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9854 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9855 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9856 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9857 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9858 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9860 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9861 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9862 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9863 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9864 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9865 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9866 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9867 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9868 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9869 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9871 \DeclareUnicodeCharacter{1E7C}{\~V}
9872 \DeclareUnicodeCharacter{1E7D}{\~v}
9873 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9874 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9876 \DeclareUnicodeCharacter{1E80}{\`W}
9877 \DeclareUnicodeCharacter{1E81}{\`w}
9878 \DeclareUnicodeCharacter{1E82}{\'W}
9879 \DeclareUnicodeCharacter{1E83}{\'w}
9880 \DeclareUnicodeCharacter{1E84}{\"W}
9881 \DeclareUnicodeCharacter{1E85}{\"w}
9882 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9883 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9884 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9885 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9886 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9887 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9888 \DeclareUnicodeCharacter{1E8C}{\"X}
9889 \DeclareUnicodeCharacter{1E8D}{\"x}
9890 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9891 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9893 \DeclareUnicodeCharacter{1E90}{\^Z}
9894 \DeclareUnicodeCharacter{1E91}{\^z}
9895 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9896 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9897 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9898 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9899 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9900 \DeclareUnicodeCharacter{1E97}{\"t}
9901 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9902 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9904 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9905 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9907 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9908 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9909 \DeclareUnicodeCharacter{1EBC}{\~E}
9910 \DeclareUnicodeCharacter{1EBD}{\~e}
9912 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9913 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9914 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9915 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9917 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9918 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9920 \DeclareUnicodeCharacter{1EF2}{\`Y}
9921 \DeclareUnicodeCharacter{1EF3}{\`y}
9922 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9924 \DeclareUnicodeCharacter{1EF8}{\~Y}
9925 \DeclareUnicodeCharacter{1EF9}{\~y}
9927 \DeclareUnicodeCharacter{2013}{--}
9928 \DeclareUnicodeCharacter{2014}{---}
9929 \DeclareUnicodeCharacter{2018}{\quoteleft}
9930 \DeclareUnicodeCharacter{2019}{\quoteright}
9931 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9932 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9933 \DeclareUnicodeCharacter{201D}{\quotedblright}
9934 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9935 \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}
9936 \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}
9937 \DeclareUnicodeCharacter{2022}{\bullet}
9938 \DeclareUnicodeCharacter{2026}{\dots}
9939 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9940 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9941 \DeclareUnicodeCharacter{20AC}{\euro}
9943 \DeclareUnicodeCharacter{2192}{\expansion}
9944 \DeclareUnicodeCharacter{21D2}{\result}
9946 \DeclareUnicodeCharacter{2212}{\minus}
9947 \DeclareUnicodeCharacter{2217}{\point}
9948 \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}
9949 \DeclareUnicodeCharacter{2261}{\equiv}
9950 }% end of \utfeightchardefs
9952 % US-ASCII character definitions.
9953 \def\asciichardefs{% nothing need be done
9957 % Latin1 (ISO-8859-1) character definitions.
9958 \def\nonasciistringdefs{%
9959 \setnonasciicharscatcode\active
9960 \def\defstringchar##1{\def##1{\string##1}}%
9962 \defstringchar^^80\defstringchar^^81\defstringchar^^82\defstringchar^^83%
9963 \defstringchar^^84\defstringchar^^85\defstringchar^^86\defstringchar^^87%
9964 \defstringchar^^88\defstringchar^^89\defstringchar^^8a\defstringchar^^8b%
9965 \defstringchar^^8c\defstringchar^^8d\defstringchar^^8e\defstringchar^^8f%
9967 \defstringchar^^90\defstringchar^^91\defstringchar^^92\defstringchar^^93%
9968 \defstringchar^^94\defstringchar^^95\defstringchar^^96\defstringchar^^97%
9969 \defstringchar^^98\defstringchar^^99\defstringchar^^9a\defstringchar^^9b%
9970 \defstringchar^^9c\defstringchar^^9d\defstringchar^^9e\defstringchar^^9f%
9972 \defstringchar^^a0\defstringchar^^a1\defstringchar^^a2\defstringchar^^a3%
9973 \defstringchar^^a4\defstringchar^^a5\defstringchar^^a6\defstringchar^^a7%
9974 \defstringchar^^a8\defstringchar^^a9\defstringchar^^aa\defstringchar^^ab%
9975 \defstringchar^^ac\defstringchar^^ad\defstringchar^^ae\defstringchar^^af%
9977 \defstringchar^^b0\defstringchar^^b1\defstringchar^^b2\defstringchar^^b3%
9978 \defstringchar^^b4\defstringchar^^b5\defstringchar^^b6\defstringchar^^b7%
9979 \defstringchar^^b8\defstringchar^^b9\defstringchar^^ba\defstringchar^^bb%
9980 \defstringchar^^bc\defstringchar^^bd\defstringchar^^be\defstringchar^^bf%
9982 \defstringchar^^c0\defstringchar^^c1\defstringchar^^c2\defstringchar^^c3%
9983 \defstringchar^^c4\defstringchar^^c5\defstringchar^^c6\defstringchar^^c7%
9984 \defstringchar^^c8\defstringchar^^c9\defstringchar^^ca\defstringchar^^cb%
9985 \defstringchar^^cc\defstringchar^^cd\defstringchar^^ce\defstringchar^^cf%
9987 \defstringchar^^d0\defstringchar^^d1\defstringchar^^d2\defstringchar^^d3%
9988 \defstringchar^^d4\defstringchar^^d5\defstringchar^^d6\defstringchar^^d7%
9989 \defstringchar^^d8\defstringchar^^d9\defstringchar^^da\defstringchar^^db%
9990 \defstringchar^^dc\defstringchar^^dd\defstringchar^^de\defstringchar^^df%
9992 \defstringchar^^e0\defstringchar^^e1\defstringchar^^e2\defstringchar^^e3%
9993 \defstringchar^^e4\defstringchar^^e5\defstringchar^^e6\defstringchar^^e7%
9994 \defstringchar^^e8\defstringchar^^e9\defstringchar^^ea\defstringchar^^eb%
9995 \defstringchar^^ec\defstringchar^^ed\defstringchar^^ee\defstringchar^^ef%
9997 \defstringchar^^f0\defstringchar^^f1\defstringchar^^f2\defstringchar^^f3%
9998 \defstringchar^^f4\defstringchar^^f5\defstringchar^^f6\defstringchar^^f7%
9999 \defstringchar^^f8\defstringchar^^f9\defstringchar^^fa\defstringchar^^fb%
10000 \defstringchar^^fc\defstringchar^^fd\defstringchar^^fe\defstringchar^^ff%
10004 % define all the unicode characters we know about, for the sake of @U.
10008 % Make non-ASCII characters printable again for compatibility with
10009 % existing Texinfo documents that may use them, even without declaring a
10010 % document encoding.
10012 \setnonasciicharscatcode \other
10015 \message{formatting,}
10017 \newdimen\defaultparindent \defaultparindent = 15pt
10019 \chapheadingskip = 15pt plus 4pt minus 2pt
10020 \secheadingskip = 12pt plus 3pt minus 2pt
10021 \subsecheadingskip = 9pt plus 2pt minus 2pt
10023 % Prevent underfull vbox error messages.
10026 % Don't be very finicky about underfull hboxes, either.
10029 % Following George Bush, get rid of widows and orphans.
10030 \widowpenalty=10000
10033 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
10034 % using an old version of TeX, don't do anything. We want the amount of
10035 % stretch added to depend on the line length, hence the dependence on
10036 % \hsize. We call this whenever the paper size is set.
10038 \def\setemergencystretch{%
10039 \ifx\emergencystretch\thisisundefined
10040 % Allow us to assign to \emergencystretch anyway.
10041 \def\emergencystretch{\dimen0}%
10043 \emergencystretch = .15\hsize
10047 % Parameters in order: 1) textheight; 2) textwidth;
10048 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
10049 % 7) physical page height; 8) physical page width.
10051 % We also call \setleading{\textleading}, so the caller should define
10052 % \textleading. The caller should also set \parskip.
10054 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
10055 \voffset = #3\relax
10056 \topskip = #6\relax
10057 \splittopskip = \topskip
10060 \advance\vsize by \topskip
10061 \outervsize = \vsize
10062 \advance\outervsize by 2\topandbottommargin
10063 \pageheight = \vsize
10066 \outerhsize = \hsize
10067 \advance\outerhsize by 0.5in
10068 \pagewidth = \hsize
10070 \normaloffset = #4\relax
10071 \bindingoffset = #5\relax
10074 \pdfpageheight #7\relax
10075 \pdfpagewidth #8\relax
10076 % if we don't reset these, they will remain at "1 true in" of
10077 % whatever layout pdftex was dumped with.
10078 \pdfhorigin = 1 true in
10079 \pdfvorigin = 1 true in
10082 \setleading{\textleading}
10084 \parindent = \defaultparindent
10085 \setemergencystretch
10088 % @letterpaper (the default).
10089 \def\letterpaper{{\globaldefs = 1
10090 \parskip = 3pt plus 2pt minus 1pt
10091 \textleading = 13.2pt
10093 % If page is nothing but text, make it come out even.
10094 \internalpagesizes{607.2pt}{6in}% that's 46 lines
10096 {\bindingoffset}{36pt}%
10100 % Use @smallbook to reset parameters for 7x9.25 trim size.
10101 \def\smallbook{{\globaldefs = 1
10102 \parskip = 2pt plus 1pt
10103 \textleading = 12pt
10105 \internalpagesizes{7.5in}{5in}%
10107 {\bindingoffset}{16pt}%
10110 \lispnarrowing = 0.3in
10113 \contentsrightmargin = 0pt
10114 \defbodyindent = .5cm
10117 % Use @smallerbook to reset parameters for 6x9 trim size.
10118 % (Just testing, parameters still in flux.)
10119 \def\smallerbook{{\globaldefs = 1
10120 \parskip = 1.5pt plus 1pt
10121 \textleading = 12pt
10123 \internalpagesizes{7.4in}{4.8in}%
10128 \lispnarrowing = 0.25in
10131 \contentsrightmargin = 0pt
10132 \defbodyindent = .4cm
10135 % Use @afourpaper to print on European A4 paper.
10136 \def\afourpaper{{\globaldefs = 1
10137 \parskip = 3pt plus 2pt minus 1pt
10138 \textleading = 13.2pt
10140 % Double-side printing via postscript on Laserjet 4050
10141 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
10142 % To change the settings for a different printer or situation, adjust
10143 % \normaloffset until the front-side and back-side texts align. Then
10144 % do the same for \bindingoffset. You can set these for testing in
10145 % your texinfo source file like this:
10147 % \global\normaloffset = -6mm
10148 % \global\bindingoffset = 10mm
10150 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
10151 {\voffset}{\hoffset}%
10152 {\bindingoffset}{44pt}%
10157 \contentsrightmargin = 0pt
10158 \defbodyindent = 5mm
10161 % Use @afivepaper to print on European A5 paper.
10162 % From romildo@urano.iceb.ufop.br, 2 July 2000.
10163 % He also recommends making @example and @lisp be small.
10164 \def\afivepaper{{\globaldefs = 1
10165 \parskip = 2pt plus 1pt minus 0.1pt
10166 \textleading = 12.5pt
10168 \internalpagesizes{160mm}{120mm}%
10169 {\voffset}{\hoffset}%
10170 {\bindingoffset}{8pt}%
10173 \lispnarrowing = 0.2in
10176 \contentsrightmargin = 0pt
10177 \defbodyindent = 2mm
10178 \tableindent = 12mm
10181 % A specific text layout, 24x15cm overall, intended for A4 paper.
10182 \def\afourlatex{{\globaldefs = 1
10184 \internalpagesizes{237mm}{150mm}%
10186 {\bindingoffset}{7mm}%
10189 % Must explicitly reset to 0 because we call \afourpaper.
10193 % Use @afourwide to print on A4 paper in landscape format.
10194 \def\afourwide{{\globaldefs = 1
10196 \internalpagesizes{241mm}{165mm}%
10197 {\voffset}{-2.95mm}%
10198 {\bindingoffset}{7mm}%
10203 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
10204 % Perhaps we should allow setting the margins, \topskip, \parskip,
10205 % and/or leading, also. Or perhaps we should compute them somehow.
10207 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
10208 \def\pagesizesyyy#1,#2,#3\finish{{%
10209 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
10212 \parskip = 3pt plus 2pt minus 1pt
10213 \setleading{\textleading}%
10216 \advance\dimen0 by \voffset
10219 \advance\dimen2 by \normaloffset
10221 \internalpagesizes{#1}{\hsize}%
10222 {\voffset}{\normaloffset}%
10223 {\bindingoffset}{44pt}%
10224 {\dimen0}{\dimen2}%
10227 % Set default to letter.
10232 \message{and turning on texinfo input format.}
10234 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
10236 % DEL is a comment character, in case @c does not suffice.
10239 % Define macros to output various characters with catcode for normal text.
10240 \catcode`\"=\other \def\normaldoublequote{"}
10241 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
10242 \catcode`\+=\other \def\normalplus{+}
10243 \catcode`\<=\other \def\normalless{<}
10244 \catcode`\>=\other \def\normalgreater{>}
10245 \catcode`\^=\other \def\normalcaret{^}
10246 \catcode`\_=\other \def\normalunderscore{_}
10247 \catcode`\|=\other \def\normalverticalbar{|}
10248 \catcode`\~=\other \def\normaltilde{~}
10250 % This macro is used to make a character print one way in \tt
10251 % (where it can probably be output as-is), and another way in other fonts,
10252 % where something hairier probably needs to be done.
10254 % #1 is what to print if we are indeed using \tt; #2 is what to print
10255 % otherwise. Since all the Computer Modern typewriter fonts have zero
10256 % interword stretch (and shrink), and it is reasonable to expect all
10257 % typewriter fonts to have this, we can check that font parameter.
10259 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
10261 % Same as above, but check for italic font. Actually this also catches
10262 % non-italic slanted fonts since it is impossible to distinguish them from
10263 % italic fonts. But since this is only used by $ and it uses \sl anyway
10264 % this is not a problem.
10265 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
10267 % Turn off all special characters except @
10268 % (and those which the user can use as if they were ordinary).
10269 % Most of these we simply print from the \tt font, but for some, we can
10270 % use math or other variants that look better in normal text.
10272 \catcode`\"=\active
10273 \def\activedoublequote{{\tt\char34}}
10274 \let"=\activedoublequote
10275 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
10276 \chardef\hatchar=`\^
10277 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
10279 \catcode`\_=\active
10280 \def_{\ifusingtt\normalunderscore\_}
10282 % Subroutine for the previous macro.
10283 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
10285 \catcode`\|=\active
10286 \def|{{\tt\char124}}
10289 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
10291 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
10292 \catcode`\+=\active \def+{{\tt \char 43}}
10293 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
10295 % used for headline/footline in the output routine, in case the page
10296 % breaks in the middle of an @tex block.
10297 \def\texinfochars{%
10298 \let< = \activeless
10300 \let~ = \activetilde
10302 \markupsetuplqdefault \markupsetuprqdefault
10304 \let\i = \smartitalic
10305 % in principle, all other definitions in \tex have to be undone too.
10308 % If a .fmt file is being used, characters that might appear in a file
10309 % name cannot be active until we have parsed the command line.
10310 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10311 % \otherifyactive is called near the end of this file.
10312 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
10314 % Used sometimes to turn off (effectively) the active characters even after
10316 \def\turnoffactive{%
10317 \normalturnoffactive
10323 % \backslashcurfont outputs one backslash character in current font,
10325 \global\chardef\backslashcurfont=`\\
10326 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
10328 % \realbackslash is an actual character `\' with catcode other, and
10329 % \doublebackslash is two of them (for the pdf outlines).
10330 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
10332 % In texinfo, backslash is an active character; it prints the backslash
10333 % in fixed width font.
10334 \catcode`\\=\active % @ for escape char from now on.
10336 % The story here is that in math mode, the \char of \backslashcurfont
10337 % ends up printing the roman \ from the math symbol font (because \char
10338 % in math mode uses the \mathcode, and plain.tex sets
10339 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10340 % print a typewriter backslash, hence we use an explicit \mathchar,
10341 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10342 % ignored family value; char position "5C). We can't use " for the
10343 % usual hex value because it has already been made active.
10344 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10345 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10347 % On startup, @fixbackslash assigns:
10348 % @let \ = @normalbackslash
10349 % \rawbackslash defines an active \ to do \backslashcurfont.
10350 % \otherbackslash defines an active \ to be a literal `\' character with
10351 % catcode other. We switch back and forth between these.
10352 @gdef@rawbackslash{@let\=@backslashcurfont}
10353 @gdef@otherbackslash{@let\=@realbackslash}
10355 @gdef@usemathbackslash{@def@backslashcurfont{@math{@backslash}}}
10357 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10358 % the literal character `\'. Also revert - to its normal character, in
10359 % case the active - from code has slipped in.
10361 {@catcode`- = @active
10362 @gdef@normalturnoffactive{%
10363 @nonasciistringdefs
10365 @let"=@normaldoublequote
10366 @let$=@normaldollar %$ font-lock fix
10369 @let>=@normalgreater
10370 @let\=@normalbackslash
10372 @let_=@normalunderscore
10373 @let|=@normalverticalbar
10375 @markupsetuplqdefault
10376 @markupsetuprqdefault
10381 % Make _ and + \other characters, temporarily.
10382 % This is canceled by @fixbackslash.
10385 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10386 % That is what \eatinput is for; after that, the `\' should revert to printing
10389 @gdef@eatinput input texinfo{@fixbackslash}
10390 @global@let\ = @eatinput
10392 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10393 % the first `\' in the file would cause an error. This macro tries to fix
10394 % that, assuming it is called before the first `\' could plausibly occur.
10395 % Also turn back on active characters that might appear in the input
10396 % file name, in case not using a pre-dumped format.
10398 @gdef@fixbackslash{%
10399 @ifx\@eatinput @let\ = @normalbackslash @fi
10401 @catcode`@_=@active
10404 % Say @foo, not \foo, in error messages.
10407 % These (along with & and #) are made active for url-breaking, so need
10408 % active definitions as the normal characters.
10410 @def@normalquest{?}
10411 @def@normalslash{/}
10413 % These look ok in all fonts, so just make them not special.
10414 % @hashchar{} gets its own user-level command, because of #line.
10415 @catcode`@& = @other @def@normalamp{&}
10416 @catcode`@# = @other @def@normalhash{#}
10417 @catcode`@% = @other @def@normalpercent{%}
10419 @let @hashchar = @normalhash
10421 @c Finally, make ` and ' active, so that txicodequoteundirected and
10422 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10423 @c don't make ` and ' active, @code will not get them as active chars.
10424 @c Do this last of all since we use ` in the previous @catcode assignments.
10425 @catcode`@'=@active
10426 @catcode`@`=@active
10427 @markupsetuplqdefault
10428 @markupsetuprqdefault
10430 @c Local variables:
10431 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10432 @c page-delimiter: "^\\\\message\\|emacs-page"
10433 @c time-stamp-start: "def\\\\texinfoversion{"
10434 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10435 @c time-stamp-end: "}"
10441 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115