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{2009-03-21.17}
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 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
75 % Save some plain tex macros whose names we will redefine.
77 \let\ptexbullet=\bullet
85 \let\ptexfootnote=\footnote
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
102 \global\let\ptexquoteright'}% Math-mode def from plain.tex.
103 \let\ptexraggedright=\raggedright
105 % If this character appears in an error message or help string, it
106 % starts a new line in the output.
109 % Use TeX 3.0's \inputlineno to get the line number, for better error
110 % messages, but if we're using an old version of TeX, don't do anything.
112 \ifx\inputlineno\thisisundefined
113 \let\linenumber = \empty % Pre-3.0.
115 \def\linenumber{l.\the\inputlineno:\space}
118 % Set up fixed words for English if not already set.
119 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
120 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
121 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
122 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
123 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
124 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
125 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
126 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
127 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
128 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
129 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
130 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
131 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
132 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
133 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
134 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
135 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
136 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
137 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
139 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
140 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
141 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
142 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
143 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
144 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
145 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
146 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
147 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
148 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
149 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
150 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
152 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
153 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
154 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
155 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
156 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
158 % Since the category of space is not known, we have to be careful.
159 \chardef\spacecat = 10
160 \def\spaceisspace{\catcode`\ =\spacecat}
162 % sometimes characters are active, so we need control sequences.
163 \chardef\colonChar = `\:
164 \chardef\commaChar = `\,
165 \chardef\dashChar = `\-
166 \chardef\dotChar = `\.
167 \chardef\exclamChar= `\!
168 \chardef\lquoteChar= `\`
169 \chardef\questChar = `\?
170 \chardef\rquoteChar= `\'
171 \chardef\semiChar = `\;
172 \chardef\underChar = `\_
178 % The following is used inside several \edef's.
179 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
183 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
184 ap-pen-dix bit-map bit-maps
185 data-base data-bases eshell fall-ing half-way long-est man-u-script
186 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
187 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
189 stand-alone strong-est time-stamp time-stamps which-ever white-space
190 wide-spread wrap-around
193 % Margin to add to right of even pages, to left of odd pages.
194 \newdimen\bindingoffset
195 \newdimen\normaloffset
196 \newdimen\pagewidth \newdimen\pageheight
198 % For a final copy, take out the rectangles
199 % that mark overfull boxes (in case you have decided
200 % that the text looks ok even though it passes the margin).
202 \def\finalout{\overfullrule=0pt}
204 % @| inserts a changebar to the left of the current line. It should
205 % surround any changed text. This approach does *not* work if the
206 % change spans more than two lines of output. To handle that, we would
207 % have adopt a much more difficult approach (putting marks into the main
208 % vertical list for the beginning and end of each change).
211 % \vadjust can only be used in horizontal mode.
214 % Append this vertical mode material after the current line in the output.
216 % We want to insert a rule with the height and depth of the current
217 % leading; that is exactly what \strutbox is supposed to record.
220 % \vadjust-items are inserted at the left edge of the type. So
221 % the \llap here moves out into the left-hand margin.
224 % For a thicker or thinner bar, change the `1pt'.
225 \vrule height\baselineskip width1pt
227 % This is the space between the bar and the text.
233 % Sometimes it is convenient to have everything in the transcript file
234 % and nothing on the terminal. We don't just call \tracingall here,
235 % since that produces some useless output on the terminal. We also make
236 % some effort to order the tracing commands to reduce output in the log
237 % file; cf. trace.sty in LaTeX.
239 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
243 \tracinglostchars2 % 2 gives us more in etex
248 \showboxbreadth\maxdimen \showboxdepth\maxdimen
249 \ifx\eTeXversion\undefined\else % etex gives us more logging
256 \tracingcommands3 % 3 gives us more in etex
260 % add check for \lastpenalty to plain's definitions. If the last thing
261 % we did was a \nobreak, we don't want to insert more space.
263 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
264 \removelastskip\penalty-50\smallskip\fi\fi}
265 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
266 \removelastskip\penalty-100\medskip\fi\fi}
267 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
268 \removelastskip\penalty-200\bigskip\fi\fi}
270 % For @cropmarks command.
271 % Do @cropmarks to get crop marks.
274 \let\cropmarks = \cropmarkstrue
276 % Dimensions to add cropmarks at corners.
277 % Added by P. A. MacKay, 12 Nov. 1986
279 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
280 \newdimen\cornerlong \cornerlong=1pc
281 \newdimen\cornerthick \cornerthick=.3pt
282 \newdimen\topandbottommargin \topandbottommargin=.75in
284 % Output a mark which sets \thischapter, \thissection and \thiscolor.
285 % We dump everything together because we only have one kind of mark.
286 % This works because we only use \botmark / \topmark, not \firstmark.
288 % A mark contains a subexpression of the \ifcase ... \fi construct.
289 % \get*marks macros below extract the needed part using \ifcase.
291 % Another complication is to let the user choose whether \thischapter
292 % (\thissection) refers to the chapter (section) in effect at the top
293 % of a page, or that at the bottom of a page. The solution is
294 % described on page 260 of The TeXbook. It involves outputting two
295 % marks for the sectioning macros, one before the section break, and
296 % one after. I won't pretend I can describe this better than DEK...
298 \toks0=\expandafter{\lastchapterdefs}%
299 \toks2=\expandafter{\lastsectiondefs}%
300 \toks4=\expandafter{\prevchapterdefs}%
301 \toks6=\expandafter{\prevsectiondefs}%
302 \toks8=\expandafter{\lastcolordefs}%
304 \the\toks0 \the\toks2
305 \noexpand\or \the\toks4 \the\toks6
306 \noexpand\else \the\toks8
309 % \topmark doesn't work for the very first chapter (after the title
310 % page or the contents), so we use \firstmark there -- this gets us
311 % the mark with the chapter defs, unless the user sneaks in, e.g.,
312 % @setcolor (or @url, or @link, etc.) between @contents and the very
314 \def\gettopheadingmarks{%
316 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
318 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
319 \def\getcolormarks{\ifcase2\topmark\fi}
321 % Avoid "undefined control sequence" errors.
322 \def\lastchapterdefs{}
323 \def\lastsectiondefs{}
324 \def\prevchapterdefs{}
325 \def\prevsectiondefs{}
328 % Main output routine.
330 \output = {\onepageout{\pagecontents\PAGE}}
335 % \onepageout takes a vbox as an argument. Note that \pagecontents
336 % does insertions, but you have to call it yourself.
338 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
340 \ifodd\pageno \advance\hoffset by \bindingoffset
341 \else \advance\hoffset by -\bindingoffset\fi
343 % Do this outside of the \shipout so @code etc. will be expanded in
344 % the headline as they should be, not taken literally (outputting ''code).
345 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
346 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
347 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
348 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
351 % Have to do this stuff outside the \shipout because we want it to
352 % take effect in \write's, yet the group defined by the \vbox ends
353 % before the \shipout runs.
355 \indexdummies % don't expand commands in the output.
356 \normalturnoffactive % \ in index entries must not stay \, e.g., if
357 % the page break happens to be in the middle of an example.
358 % We don't want .vr (or whatever) entries like this:
359 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
360 % "\acronym" won't work when it's read back in;
362 % {\code {{\tt \backslashcurfont }acronym}
364 % Do this early so pdf references go to the beginning of the page.
365 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
367 \ifcropmarks \vbox to \outervsize\bgroup
369 \vskip-\topandbottommargin
371 \line{\ewtop\hfil\ewtop}%
374 \vbox{\moveleft\cornerthick\nstop}%
376 \vbox{\moveright\cornerthick\nstop}%
379 \vskip\topandbottommargin
381 \hfil % center the page within the outer (page) hsize.
382 \ifodd\pageno\hskip\bindingoffset\fi
388 \ifdim\ht\footlinebox > 0pt
389 % Only leave this space if the footline is nonempty.
390 % (We lessened \vsize for it in \oddfootingyyy.)
391 % The \baselineskip=24pt in plain's \makefootline has no effect.
397 \egroup % end of \vbox\bgroup
398 \hfil\egroup % end of (centering) \line\bgroup
399 \vskip\topandbottommargin plus1fill minus1fill
400 \boxmaxdepth = \cornerthick
403 \vbox{\moveleft\cornerthick\nsbot}%
405 \vbox{\moveright\cornerthick\nsbot}%
408 \line{\ewbot\hfil\ewbot}%
410 \egroup % \vbox from first cropmarks clause
412 }% end of \shipout\vbox
413 }% end of group with \indexdummies
415 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
418 \newinsert\margin \dimen\margin=\maxdimen
420 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
422 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
423 % marginal hacks, juha@viisa.uucp (Juha Takala)
424 \ifvoid\margin\else % marginal info is present
425 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
426 \dimen@=\dp#1\relax \unvbox#1\relax
427 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
428 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
431 % Here are the rules for the cropmarks. Note that they are
432 % offset so that the space between them is truly \outerhsize or \outervsize
433 % (P. A. MacKay, 12 November, 1986)
435 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
437 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
438 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
440 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
442 % Parse an argument, then pass it to #1. The argument is the rest of
443 % the input line (except we remove a trailing comment). #1 should be a
444 % macro which expects an ordinary undelimited TeX argument.
446 \def\parsearg{\parseargusing{}}
447 \def\parseargusing#1#2{%
453 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
457 \gdef\parseargline#1^^M{%
458 \endgroup % End of the group started in \parsearg.
459 \argremovecomment #1\comment\ArgTerm%
463 % First remove any @comment, then any @c comment.
464 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
465 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
467 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
469 % \argremovec might leave us with trailing space, e.g.,
470 % @end itemize @c foo
471 % This space token undergoes the same procedure and is eventually removed
472 % by \finishparsearg.
474 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
475 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
476 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
479 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
480 \let\temp\finishparsearg
482 \let\temp\argcheckspaces
484 % Put the space token in:
488 % If a _delimited_ argument is enclosed in braces, they get stripped; so
489 % to get _exactly_ the rest of the line, we had to prevent such situation.
490 % We prepended an \empty token at the very beginning and we expand it now,
491 % just before passing the control to \argtorun.
492 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
493 % either the null string, or it ends with \^^M---thus there is no danger
494 % that a pair of braces would be stripped.
496 % But first, we have to remove the trailing space token.
498 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
500 % \parseargdef\foo{...}
501 % is roughly equivalent to
502 % \def\foo{\parsearg\Xfoo}
505 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
506 % favourite TeX trick. --kasal, 16nov03
509 \expandafter \doparseargdef \csname\string#1\endcsname #1%
511 \def\doparseargdef#1#2{%
516 % Several utility definitions with active space:
521 % Make each space character in the input produce a normal interword
522 % space in the output. Don't allow a line break at this space, as this
523 % is used only in environments like @example, where each line of input
524 % should produce a line of output anyway.
526 \gdef\sepspaces{\obeyspaces\let =\tie}
528 % If an index command is used in an @example environment, any spaces
529 % therein should become regular spaces in the raw index file, not the
530 % expansion of \tie (\leavevmode \penalty \@M \ ).
531 \gdef\unsepspaces{\let =\space}
535 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
537 % Define the framework for environments in texinfo.tex. It's used like this:
542 % It's the responsibility of \envdef to insert \begingroup before the
543 % actual body; @end closes the group after calling \Efoo. \envdef also
544 % defines \thisenv, so the current environment is known; @end checks
545 % whether the environment name matches. The \checkenv macro can also be
546 % used to check whether the current environment is the one expected.
548 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
549 % are not treated as environments; they don't open a group. (The
550 % implementation of @end takes care not to call \endgroup in this
554 % At run-time, environments start with this:
555 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
559 % ... but they get defined via ``\envdef\foo{...}'':
560 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
561 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
563 % Check whether we're in the right environment:
572 % Environment mismatch, #1 expected:
575 \errmessage{This command can appear only \inenvironment\temp,
576 not \inenvironment\thisenv}%
578 \def\inenvironment#1{%
580 out of any environment%
582 in environment \expandafter\string#1%
586 % @end foo executes the definition of \Efoo.
587 % But first, it executes a specialized version of \checkenv
590 \if 1\csname iscond.#1\endcsname
592 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
593 \expandafter\checkenv\csname#1\endcsname
594 \csname E#1\endcsname
599 \newhelp\EMsimple{Press RETURN to continue.}
602 %% Simple single-character @ commands
605 % Kludge this until the fonts are right (grr).
608 % This is turned off because it was never documented
609 % and you can use @w{...} around a quote to suppress ligatures.
610 %% Define @` and @' to be the same as ` and '
611 %% but suppressing ligatures.
615 % Used to generate quoted braces.
616 \def\mylbrace {{\tt\char123}}
617 \def\myrbrace {{\tt\char125}}
621 % Definitions to produce \{ and \} commands for indices,
622 % and @{ and @} for the aux/toc files.
623 \catcode`\{ = \other \catcode`\} = \other
624 \catcode`\[ = 1 \catcode`\] = 2
625 \catcode`\! = 0 \catcode`\\ = \other
628 !gdef!lbraceatcmd[@{]%
629 !gdef!rbraceatcmd[@}]%
632 % @comma{} to avoid , parsing problems.
635 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
636 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
639 \def\ringaccent#1{{\accent23 #1}}
644 % Other special characters: @questiondown @exclamdown @ordf @ordm
645 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
646 \def\questiondown{?`}
648 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
649 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
651 % Dotless i and dotless j, used for accents.
656 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
657 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
658 \else \errmessage{@dotless can be used only with i or j}%
662 % The \TeX{} logo, as in plain, but resetting the spacing so that a
663 % period following counts as ending a sentence. (Idea found in latex.)
665 \edef\TeX{\TeX \spacefactor=1000 }
667 % @LaTeX{} logo. Not quite the same results as the definition in
668 % latex.ltx, since we use a different font for the raised A; it's most
669 % convenient for us to use an explicitly smaller font, rather than using
670 % the \scriptstyle font (since we don't reset \scriptstyle and
671 % \scriptscriptstyle).
676 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
681 % Be sure we're in horizontal mode when doing a tie, since we make space
682 % equivalent to this in @example-like environments. Otherwise, a space
683 % at the beginning of a line will start with \penalty -- and
684 % since \penalty is valid in vertical mode, we'd end up putting the
685 % penalty on the vertical list instead of in the new paragraph.
687 % Avoid using \@M directly, because that causes trouble
688 % if the definition is written into an index file.
689 \global\let\tiepenalty = \@M
690 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
693 % @: forces normal size whitespace following.
694 \def\:{\spacefactor=1000 }
696 % @* forces a line break.
697 \def\*{\hfil\break\hbox{}\ignorespaces}
699 % @/ allows a line break.
702 % @. is an end-of-sentence period.
703 \def\.{.\spacefactor=\endofsentencespacefactor\space}
705 % @! is an end-of-sentence bang.
706 \def\!{!\spacefactor=\endofsentencespacefactor\space}
708 % @? is an end-of-sentence query.
709 \def\?{?\spacefactor=\endofsentencespacefactor\space}
711 % @frenchspacing on|off says whether to put extra space after punctuation.
716 \parseargdef\frenchspacing{%
718 \ifx\temp\onword \plainfrenchspacing
719 \else\ifx\temp\offword \plainnonfrenchspacing
722 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
726 % @w prevents a word break. Without the \leavevmode, @w at the
727 % beginning of a paragraph, when TeX is still in vertical mode, would
728 % produce a whole line of output instead of starting the paragraph.
729 \def\w#1{\leavevmode\hbox{#1}}
731 % @group ... @end group forces ... to be all on one page, by enclosing
732 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
733 % to keep its height that of a normal line. According to the rules for
734 % \topskip (p.114 of the TeXbook), the glue inserted is
735 % max (\topskip - \ht (first item), 0). If that height is large,
736 % therefore, no glue is inserted, and the space between the headline and
737 % the text is small, which looks bad.
739 % Another complication is that the group might be very large. This can
740 % cause the glue on the previous page to be unduly stretched, because it
741 % does not have much material. In this case, it's better to add an
742 % explicit \vfill so that the extra space is at the bottom. The
743 % threshold for doing this is if the group is more than \vfilllimit
744 % percent of a page (\vfilllimit can be changed inside of @tex).
750 \ifnum\catcode`\^^M=\active \else
751 \errhelp = \groupinvalidhelp
752 \errmessage{@group invalid in context where filling is enabled}%
756 \setbox\groupbox = \vtop\bgroup
757 % Do @comment since we are called inside an environment such as
758 % @example, where each end-of-line in the input causes an
759 % end-of-line in the output. We don't want the end-of-line after
760 % the `@group' to put extra space in the output. Since @group
761 % should appear on a line by itself (according to the Texinfo
762 % manual), we don't worry about eating any user text.
766 % The \vtop produces a box with normal height and large depth; thus, TeX puts
767 % \baselineskip glue before it, and (when the next line of text is done)
768 % \lineskip glue after it. Thus, space below is not quite equal to space
769 % above. But it's pretty close.
771 % To get correct interline space between the last line of the group
772 % and the first line afterwards, we have to propagate \prevdepth.
773 \endgraf % Not \par, as it may have been set to \lisppar.
774 \global\dimen1 = \prevdepth
775 \egroup % End the \vtop.
776 % \dimen0 is the vertical size of the group's box.
777 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
778 % \dimen2 is how much space is left on the page (more or less).
779 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
780 % if the group doesn't fit on the current page, and it's a big big
781 % group, force a page break.
782 \ifdim \dimen0 > \dimen2
783 \ifdim \pagetotal < \vfilllimit\pageheight
792 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
793 % message, so this ends up printing `@group can only ...'.
795 \newhelp\groupinvalidhelp{%
796 group can only be used in environments such as @example,^^J%
797 where each line of input produces a line of output.}
799 % @need space-in-mils
800 % forces a page break if there is not space-in-mils remaining.
802 \newdimen\mil \mil=0.001in
804 % Old definition--didn't work.
805 %\parseargdef\need{\par %
806 %% This method tries to make TeX break the page naturally
807 %% if the depth of the box does not fit.
809 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
814 % Ensure vertical mode, so we don't make a big box in the middle of a
818 % If the @need value is less than one line space, it's useless.
820 \dimen2 = \ht\strutbox
821 \advance\dimen2 by \dp\strutbox
822 \ifdim\dimen0 > \dimen2
824 % Do a \strut just to make the height of this box be normal, so the
825 % normal leading is inserted relative to the preceding line.
826 % And a page break here is fine.
827 \vtop to #1\mil{\strut\vfil}%
829 % TeX does not even consider page breaks if a penalty added to the
830 % main vertical list is 10000 or more. But in order to see if the
831 % empty box we just added fits on the page, we must make it consider
832 % page breaks. On the other hand, we don't want to actually break the
833 % page after the empty box. So we use a penalty of 9999.
835 % There is an extremely small chance that TeX will actually break the
836 % page at this \penalty, if there are no other feasible breakpoints in
837 % sight. (If the user is using lots of big @group commands, which
838 % almost-but-not-quite fill up a page, TeX will have a hard time doing
839 % good page breaking, for example.) However, I could not construct an
840 % example where a page broke at this \penalty; if it happens in a real
841 % document, then we can reconsider our strategy.
844 % Back up by the size of the box, whether we did a page break or not.
847 % Do not allow a page break right after this kern.
852 % @br forces paragraph break (and is undocumented).
856 % @page forces the start of a new page.
858 \def\page{\par\vfill\supereject}
861 % outputs text on separate line in roman font, starting at standard page margin
863 % This records the amount of indent in the innermost environment.
864 % That's how much \exdent should take out.
865 \newskip\exdentamount
867 % This defn is used inside fill environments such as @defun.
868 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
870 % This defn is used inside nofill environments such as @example.
871 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
872 \leftline{\hskip\leftskip{\rm#1}}}}
874 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
875 % paragraph. For more general purposes, use the \margin insertion
876 % class. WHICH is `l' or `r'.
878 \newskip\inmarginspacing \inmarginspacing=1cm
879 \def\strutdepth{\dp\strutbox}
881 \def\doinmargin#1#2{\strut\vadjust{%
884 \vtop to \strutdepth{%
885 \baselineskip=\strutdepth
887 % if you have multiple lines of stuff to put here, you'll need to
888 % make the vbox yourself of the appropriate size.
890 \llap{\ignorespaces #2\hskip\inmarginspacing}%
892 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
897 \def\inleftmargin{\doinmargin l}
898 \def\inrightmargin{\doinmargin r}
900 % @inmargin{TEXT [, RIGHT-TEXT]}
901 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
902 % else use TEXT for both).
904 \def\inmargin#1{\parseinmargin #1,,\finish}
905 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
906 \setbox0 = \hbox{\ignorespaces #2}%
908 \def\lefttext{#1}% have both texts
911 \def\lefttext{#1}% have only one text
916 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
918 \def\temp{\inleftmargin\lefttext}%
923 % @include FILE -- \input text of FILE.
925 \def\include{\parseargusing\filenamecatcodes\includezzz}
930 \makevalueexpandable % we want to expand any @value in FILE.
931 \turnoffactive % and allow special characters in the expansion
932 \indexnofonts % Allow `@@' and other weird things in file names.
933 \edef\temp{\noexpand\input #1 }%
935 % This trickery is to read FILE outside of a group, in case it makes
941 \def\filenamecatcodes{%
955 \def\pushthisfilestack{%
956 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
958 \def\pushthisfilestackX{%
959 \expandafter\pushthisfilestackY\thisfile\StackTerm
961 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
962 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
965 \def\popthisfilestack{\errthisfilestackempty}
966 \def\errthisfilestackempty{\errmessage{Internal error:
967 the stack of filenames is empty.}}
972 % outputs that line, centered.
974 \parseargdef\center{%
980 \next{\hfil \ignorespaces#1\unskip \hfil}%
985 \advance\hsize by -\leftskip
986 \advance\hsize by -\rightskip
991 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
993 % @sp n outputs n lines of vertical space
995 \parseargdef\sp{\vskip #1\baselineskip}
997 % @comment ...line which is ignored...
998 % @c is the same as @comment
999 % @ignore ... @end ignore is another way to write a comment
1001 \def\comment{\begingroup \catcode`\^^M=\other%
1002 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
1004 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1008 % @paragraphindent NCHARS
1009 % We'll use ems for NCHARS, close enough.
1010 % NCHARS can also be the word `asis' or `none'.
1011 % We cannot feasibly implement @paragraphindent asis, though.
1013 \def\asisword{asis} % no translation, these are keywords
1016 \parseargdef\paragraphindent{%
1021 \defaultparindent = 0pt
1023 \defaultparindent = #1em
1026 \parindent = \defaultparindent
1029 % @exampleindent NCHARS
1030 % We'll use ems for NCHARS like @paragraphindent.
1031 % It seems @exampleindent asis isn't necessary, but
1032 % I preserve it to make it similar to @paragraphindent.
1033 \parseargdef\exampleindent{%
1038 \lispnarrowing = 0pt
1040 \lispnarrowing = #1em
1045 % @firstparagraphindent WORD
1046 % If WORD is `none', then suppress indentation of the first paragraph
1047 % after a section heading. If WORD is `insert', then do indent at such
1050 % The paragraph indentation is suppressed or not by calling
1051 % \suppressfirstparagraphindent, which the sectioning commands do.
1052 % We switch the definition of this back and forth according to WORD.
1053 % By default, we suppress indentation.
1055 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1056 \def\insertword{insert}
1058 \parseargdef\firstparagraphindent{%
1061 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1062 \else\ifx\temp\insertword
1063 \let\suppressfirstparagraphindent = \relax
1065 \errhelp = \EMsimple
1066 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1070 % Here is how we actually suppress indentation. Redefine \everypar to
1071 % \kern backwards by \parindent, and then reset itself to empty.
1073 % We also make \indent itself not actually do anything until the next
1076 \gdef\dosuppressfirstparagraphindent{%
1078 \restorefirstparagraphindent
1082 \restorefirstparagraphindent
1085 \global\everypar = {%
1087 \restorefirstparagraphindent
1091 \gdef\restorefirstparagraphindent{%
1092 \global \let \indent = \ptexindent
1093 \global \let \noindent = \ptexnoindent
1094 \global \everypar = {}%
1098 % @asis just yields its argument. Used with @table, for example.
1102 % @math outputs its argument in math mode.
1104 % One complication: _ usually means subscripts, but it could also mean
1105 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1106 % _ active, and distinguish by seeing if the current family is \slfam,
1107 % which is what @var uses.
1109 \catcode`\_ = \active
1110 \gdef\mathunderscore{%
1112 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1115 % Another complication: we want \\ (and @\) to output a \ character.
1116 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1117 % this is not advertised and we don't care. Texinfo does not
1118 % otherwise define @\.
1120 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1121 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1126 \let\\ = \mathbackslash
1128 % make the texinfo accent commands work in math mode
1140 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1142 % Some active characters (such as <) are spaced differently in math.
1143 % We have to reset their definitions in case the @math was an argument
1144 % to a command which sets the catcodes (such as @item or @section).
1147 \catcode`^ = \active
1148 \catcode`< = \active
1149 \catcode`> = \active
1150 \catcode`+ = \active
1151 \catcode`' = \active
1157 \let' = \ptexquoteright
1161 % Some math mode symbols.
1162 \def\bullet{$\ptexbullet$}
1163 \def\geq{\ifmmode \ge\else $\ge$\fi}
1164 \def\leq{\ifmmode \le\else $\le$\fi}
1165 \def\minus{\ifmmode -\else $-$\fi}
1167 % @dots{} outputs an ellipsis using the current font.
1168 % We do .5em per period so that it has the same spacing in the cm
1169 % typewriter fonts as three actual period characters; on the other hand,
1170 % in other typewriter fonts three periods are wider than 1.5em. So do
1171 % whichever is larger.
1175 \setbox0=\hbox{...}% get width of three periods
1182 \hskip 0pt plus.25fil
1183 .\hskip 0pt plus1fil
1184 .\hskip 0pt plus1fil
1185 .\hskip 0pt plus.5fil
1189 % @enddots{} is an end-of-sentence ellipsis.
1193 \spacefactor=\endofsentencespacefactor
1196 % @comma{} is so commas can be inserted into text without messing up
1197 % Texinfo's parsing.
1201 % @refill is a no-op.
1204 % If working on a large document in chapters, it is convenient to
1205 % be able to disable indexing, cross-referencing, and contents, for test runs.
1206 % This is done with @novalidate (before @setfilename).
1208 \newif\iflinks \linkstrue % by default we want the aux files.
1209 \let\novalidate = \linksfalse
1211 % @setfilename is done at the beginning of every texinfo file.
1212 % So open here the files we need to have open while reading the input.
1213 % This makes it possible to make a .fmt file for texinfo.
1215 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1218 % Open the new aux file. TeX will close it automatically at exit.
1219 \immediate\openout\auxfile=\jobname.aux
1220 \fi % \openindices needs to do some work in any case.
1222 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1224 % If texinfo.cnf is present on the system, read it.
1225 % Useful for site-wide @afourpaper, etc.
1226 \openin 1 texinfo.cnf
1227 \ifeof 1 \else \input texinfo.cnf \fi
1230 \comment % Ignore the actual filename.
1233 % Called from \setfilename.
1245 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1249 % adobe `portable' document format
1253 \newcount\filenamelength
1262 \newif\ifpdfmakepagedest
1264 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1265 % can be set). So we test for \relax and 0 as well as \undefined,
1266 % borrowed from ifpdf.sty.
1267 \ifx\pdfoutput\undefined
1269 \ifx\pdfoutput\relax
1278 % PDF uses PostScript string constants for the names of xref targets,
1279 % for display in the outlines, and in other places. Thus, we have to
1280 % double any backslashes. Otherwise, a name like "\node" will be
1281 % interpreted as a newline (\n), followed by o, d, e. Not good.
1282 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1283 % (and related messages, the final outcome is that it is up to the TeX
1284 % user to double the backslashes and otherwise make the string valid, so
1285 % that's what we do).
1287 % double active backslashes.
1289 {\catcode`\@=0 \catcode`\\=\active
1290 @gdef@activebackslashdouble{%
1292 @let\=@doublebackslash}
1295 % To handle parens, we must adopt a different approach, since parens are
1296 % not active characters. hyperref.dtx (which has the same problem as
1297 % us) handles it with this amazing macro to replace tokens, with minor
1298 % changes for Texinfo. It is included here under the GPL by permission
1299 % from the author, Heiko Oberdiek.
1301 % #1 is the tokens to replace.
1302 % #2 is the replacement.
1303 % #3 is the control sequence with the string.
1305 \def\HyPsdSubst#1#2#3{%
1306 \def\HyPsdReplace##1#1##2\END{%
1312 \HyPsdReplace##2\END
1316 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1318 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1320 % #1 is a control sequence in which to do the replacements.
1321 \def\backslashparens#1{%
1322 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1323 % \lastnode when called from \setref -> \pdfmkdest.
1324 \HyPsdSubst{(}{\realbackslash(}{#1}%
1325 \HyPsdSubst{)}{\realbackslash)}{#1}%
1328 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1329 with PDF output, and none of those formats could be found. (.eps cannot
1330 be supported due to the design of the PDF format; use regular TeX (DVI
1335 % Color manipulation macros based on pdfcolor.tex.
1336 \def\cmykDarkRed{0.28 1 1 0.35}
1337 \def\cmykBlack{0 0 0 1}
1339 % k sets the color for filling (usual text, etc.);
1340 % K sets the color for stroking (thin rules, e.g., normal _'s).
1341 \def\pdfsetcolor#1{\pdfliteral{#1 k #1 K}}
1343 % Set color, and create a mark which defines \thiscolor accordingly,
1344 % so that \makeheadline knows which color to restore.
1346 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1351 \def\maincolor{\cmykBlack}
1352 \pdfsetcolor{\maincolor}
1353 \edef\thiscolor{\maincolor}
1354 \def\lastcolordefs{}
1358 \line{\pdfsetcolor{\maincolor}\the\footline}%
1366 % Extract \thiscolor definition from the marks.
1368 % Typeset the headline with \maincolor, then restore the color.
1369 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1377 \pdfcatalog{/PageMode /UseOutlines}
1379 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1380 \def\dopdfimage#1#2#3{%
1381 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1382 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1384 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1385 % others). Let's try in that order.
1386 \let\pdfimgext=\empty
1388 \openin 1 #1.png \ifeof 1
1389 \openin 1 #1.jpg \ifeof 1
1390 \openin 1 #1.jpeg \ifeof 1
1391 \openin 1 #1.JPG \ifeof 1
1392 \openin 1 #1.pdf \ifeof 1
1393 \openin 1 #1.PDF \ifeof 1
1394 \errhelp = \nopdfimagehelp
1395 \errmessage{Could not find image file #1 for pdf}%
1396 \else \gdef\pdfimgext{PDF}%
1398 \else \gdef\pdfimgext{pdf}%
1400 \else \gdef\pdfimgext{JPG}%
1402 \else \gdef\pdfimgext{jpeg}%
1404 \else \gdef\pdfimgext{jpg}%
1406 \else \gdef\pdfimgext{png}%
1411 % without \immediate, ancient pdftex seg faults when the same image is
1412 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1413 \ifnum\pdftexversion < 14
1416 \immediate\pdfximage
1418 \ifdim \wd0 >0pt width \imagewidth \fi
1419 \ifdim \wd2 >0pt height \imageheight \fi
1420 \ifnum\pdftexversion<13
1425 \ifnum\pdftexversion < 14 \else
1426 \pdfrefximage \pdflastximage
1430 % We have to set dummies so commands such as @code, and characters
1431 % such as \, aren't expanded when present in a section title.
1434 \activebackslashdouble
1435 \makevalueexpandable
1436 \def\pdfdestname{#1}%
1437 \backslashparens\pdfdestname
1438 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1441 % used to mark target names; must be expandable.
1444 % by default, use a color that is dark enough to print on paper as
1445 % nearly black, but still distinguishable for online viewing.
1446 \def\urlcolor{\cmykDarkRed}
1447 \def\linkcolor{\cmykDarkRed}
1448 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1450 % Adding outlines to PDF; macros for calculating structure of outlines
1451 % come from Petr Olsak
1452 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1453 \else \csname#1\endcsname \fi}
1454 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1455 \advance\tempnum by 1
1456 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1458 % #1 is the section text, which is what will be displayed in the
1459 % outline by the pdf viewer. #2 is the pdf expression for the number
1460 % of subentries (or empty, for subsubsections). #3 is the node text,
1461 % which might be empty if this toc entry had no corresponding node.
1462 % #4 is the page number
1464 \def\dopdfoutline#1#2#3#4{%
1465 % Generate a link to the node text if that exists; else, use the
1466 % page number. We could generate a destination for the section
1467 % text in the case where a section has no node, but it doesn't
1468 % seem worth the trouble, since most documents are normally structured.
1469 \def\pdfoutlinedest{#3}%
1470 \ifx\pdfoutlinedest\empty
1471 \def\pdfoutlinedest{#4}%
1473 % Doubled backslashes in the name.
1474 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1475 \backslashparens\pdfoutlinedest}%
1478 % Also double the backslashes in the display string.
1479 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1480 \backslashparens\pdfoutlinetext}%
1482 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1485 \def\pdfmakeoutlines{%
1487 % Thanh's hack / proper braces in bookmarks
1488 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1489 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1491 % Read toc silently, to get counts of subentries for \pdfoutline.
1492 \def\numchapentry##1##2##3##4{%
1493 \def\thischapnum{##2}%
1495 \def\thissubsecnum{0}%
1497 \def\numsecentry##1##2##3##4{%
1498 \advancenumber{chap\thischapnum}%
1499 \def\thissecnum{##2}%
1500 \def\thissubsecnum{0}%
1502 \def\numsubsecentry##1##2##3##4{%
1503 \advancenumber{sec\thissecnum}%
1504 \def\thissubsecnum{##2}%
1506 \def\numsubsubsecentry##1##2##3##4{%
1507 \advancenumber{subsec\thissubsecnum}%
1509 \def\thischapnum{0}%
1511 \def\thissubsecnum{0}%
1513 % use \def rather than \let here because we redefine \chapentry et
1514 % al. a second time, below.
1515 \def\appentry{\numchapentry}%
1516 \def\appsecentry{\numsecentry}%
1517 \def\appsubsecentry{\numsubsecentry}%
1518 \def\appsubsubsecentry{\numsubsubsecentry}%
1519 \def\unnchapentry{\numchapentry}%
1520 \def\unnsecentry{\numsecentry}%
1521 \def\unnsubsecentry{\numsubsecentry}%
1522 \def\unnsubsubsecentry{\numsubsubsecentry}%
1525 % Read toc second time, this time actually producing the outlines.
1526 % The `-' means take the \expnumber as the absolute number of
1527 % subentries, which we calculated on our first read of the .toc above.
1529 % We use the node names as the destinations.
1530 \def\numchapentry##1##2##3##4{%
1531 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1532 \def\numsecentry##1##2##3##4{%
1533 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1534 \def\numsubsecentry##1##2##3##4{%
1535 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1536 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1537 \dopdfoutline{##1}{}{##3}{##4}}%
1539 % PDF outlines are displayed using system fonts, instead of
1540 % document fonts. Therefore we cannot use special characters,
1541 % since the encoding is unknown. For example, the eogonek from
1542 % Latin 2 (0xea) gets translated to a | character. Info from
1543 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1545 % xx to do this right, we have to translate 8-bit characters to
1546 % their "best" equivalent, based on the @documentencoding. Right
1547 % now, I guess we'll just let the pdf reader have its way.
1550 \catcode`\\=\active \otherbackslash
1551 \input \tocreadfilename
1555 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1556 \ifx\PP\D\let\nextsp\relax
1557 \else\let\nextsp\skipspaces
1558 \ifx\p\space\else\addtokens{\filename}{\PP}%
1559 \advance\filenamelength by 1
1563 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1564 \ifnum\pdftexversion < 14
1565 \let \startlink \pdfannotlink
1567 \let \startlink \pdfstartlink
1569 % make a live url in pdf output.
1572 % it seems we really need yet another set of dummies; have not
1573 % tried to figure out what each command should do in the context
1574 % of @url. for now, just make @/ a no-op, that's the only one
1575 % people have actually reported a problem with.
1577 \normalturnoffactive
1580 \makevalueexpandable
1581 % do we want to go so far as to use \indexnofonts instead of just
1582 % special-casing \var here?
1585 \leavevmode\setcolor{\urlcolor}%
1586 \startlink attr{/Border [0 0 0]}%
1587 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1589 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1590 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1591 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1592 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1594 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1596 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1597 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1598 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1600 \ifnum0=\countA\else\makelink\fi
1601 \ifx\first.\let\next=\done\else
1603 \addtokens{\toksB}{\the\toksD}
1604 \ifx\first,\addtokens{\toksB}{\space}\fi
1606 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1608 \def\makelink{\addtokens{\toksB}%
1609 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1611 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1612 \setcolor{\linkcolor}#1\endlink}
1613 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1616 \let\pdfmkdest = \gobble
1617 \let\pdfurl = \gobble
1618 \let\endlink = \relax
1619 \let\setcolor = \gobble
1620 \let\pdfsetcolor = \gobble
1621 \let\pdfmakeoutlines = \relax
1622 \fi % \ifx\pdfoutput
1627 % Change the current font style to #1, remembering it in \curfontstyle.
1628 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1629 % italics, not bold italics.
1631 \def\setfontstyle#1{%
1632 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1633 \csname ten#1\endcsname % change the current font
1636 % Select #1 fonts with the current style.
1638 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1640 \def\rm{\fam=0 \setfontstyle{rm}}
1641 \def\it{\fam=\itfam \setfontstyle{it}}
1642 \def\sl{\fam=\slfam \setfontstyle{sl}}
1643 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1644 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1646 % Unfortunately, we have to override this for titles and the like, since
1647 % in those cases "rm" is bold. Sigh.
1648 \def\rmisbold{\rm\def\curfontstyle{bf}}
1650 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1651 % So we set up a \sf.
1653 \def\sf{\fam=\sffam \setfontstyle{sf}}
1654 \let\li = \sf % Sometimes we call it \li, not \sf.
1656 % We don't need math for this font style.
1657 \def\ttsl{\setfontstyle{ttsl}}
1661 \newdimen\textleading \textleading = 13.2pt
1663 % Set the baselineskip to #1, and the lineskip and strut size
1664 % correspondingly. There is no deep meaning behind these magic numbers
1665 % used as factors; they just match (closely enough) what Knuth defined.
1667 \def\lineskipfactor{.08333}
1668 \def\strutheightpercent{.70833}
1669 \def\strutdepthpercent {.29167}
1671 % can get a sort of poor man's double spacing by redefining this.
1672 \def\baselinefactor{1}
1676 \normalbaselineskip = \baselinefactor\dimen0
1677 \normallineskip = \lineskipfactor\normalbaselineskip
1679 \setbox\strutbox =\hbox{%
1680 \vrule width0pt height\strutheightpercent\baselineskip
1681 depth \strutdepthpercent \baselineskip
1685 % PDF CMaps. See also LaTeX's t1.cmap.
1687 % do nothing with this by default.
1688 \expandafter\let\csname cmapOT1\endcsname\gobble
1689 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1690 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1692 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1693 % (\pdffontattr was introduced many years ago, but people still run
1694 % older pdftex's; it's easy to conditionalize, so we do.)
1695 \ifpdf \ifx\pdffontattr\undefined \else
1697 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1698 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1699 %%DocumentNeededResources: ProcSet (CIDInit)
1700 %%IncludeResource: ProcSet (CIDInit)
1701 %%BeginResource: CMap (TeX-OT1-0)
1702 %%Title: (TeX-OT1-0 TeX OT1 0)
1705 /CIDInit /ProcSet findresource begin
1713 /CMapName /TeX-OT1-0 def
1715 1 begincodespacerange
1771 CMapName currentdict /CMap defineresource pop
1777 \expandafter\edef\csname cmapOT1\endcsname#1{%
1778 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1783 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1784 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1785 %%DocumentNeededResources: ProcSet (CIDInit)
1786 %%IncludeResource: ProcSet (CIDInit)
1787 %%BeginResource: CMap (TeX-OT1IT-0)
1788 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1791 /CIDInit /ProcSet findresource begin
1799 /CMapName /TeX-OT1IT-0 def
1801 1 begincodespacerange
1859 CMapName currentdict /CMap defineresource pop
1865 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1866 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1871 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1872 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1873 %%DocumentNeededResources: ProcSet (CIDInit)
1874 %%IncludeResource: ProcSet (CIDInit)
1875 %%BeginResource: CMap (TeX-OT1TT-0)
1876 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1879 /CIDInit /ProcSet findresource begin
1887 /CMapName /TeX-OT1TT-0 def
1889 1 begincodespacerange
1934 CMapName currentdict /CMap defineresource pop
1940 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1941 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1946 % Set the font macro #1 to the font named #2, adding on the
1947 % specified font prefix (normally `cm').
1948 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1949 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1951 \def\setfont#1#2#3#4#5{%
1952 \font#1=\fontprefix#2#3 scaled #4
1953 \csname cmap#5\endcsname#1%
1955 % This is what gets called when #5 of \setfont is empty.
1957 % emacs-page end of cmaps
1959 % Use cm as the default font prefix.
1960 % To specify the font prefix, you must define \fontprefix
1961 % before you read in texinfo.tex.
1962 \ifx\fontprefix\undefined
1965 % Support font families that don't use the same naming scheme as CM.
1967 \def\rmbshape{bx} %where the normal face is bold
1972 \def\ttslshape{sltt}
1982 % Definitions for a main text size of 11pt. This is the default in
1985 \def\definetextfontsizexi{%
1986 % Text fonts (11.2pt, magstep1).
1987 \def\textnominalsize{11pt}
1988 \edef\mainmagstep{\magstephalf}
1989 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1990 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1991 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1992 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1993 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1994 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1995 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1996 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1997 \font\texti=cmmi10 scaled \mainmagstep
1998 \font\textsy=cmsy10 scaled \mainmagstep
1999 \def\textecsize{1095}
2001 % A few fonts for @defun names and args.
2002 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2003 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2004 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2005 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2007 % Fonts for indices, footnotes, small examples (9pt).
2008 \def\smallnominalsize{9pt}
2009 \setfont\smallrm\rmshape{9}{1000}{OT1}
2010 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2011 \setfont\smallbf\bfshape{10}{900}{OT1}
2012 \setfont\smallit\itshape{9}{1000}{OT1IT}
2013 \setfont\smallsl\slshape{9}{1000}{OT1}
2014 \setfont\smallsf\sfshape{9}{1000}{OT1}
2015 \setfont\smallsc\scshape{10}{900}{OT1}
2016 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2019 \def\smallecsize{0900}
2021 % Fonts for small examples (8pt).
2022 \def\smallernominalsize{8pt}
2023 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2024 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2025 \setfont\smallerbf\bfshape{10}{800}{OT1}
2026 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2027 \setfont\smallersl\slshape{8}{1000}{OT1}
2028 \setfont\smallersf\sfshape{8}{1000}{OT1}
2029 \setfont\smallersc\scshape{10}{800}{OT1}
2030 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2031 \font\smalleri=cmmi8
2032 \font\smallersy=cmsy8
2033 \def\smallerecsize{0800}
2035 % Fonts for title page (20.4pt):
2036 \def\titlenominalsize{20pt}
2037 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2038 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2039 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2040 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2041 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2042 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2043 \let\titlebf=\titlerm
2044 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2045 \font\titlei=cmmi12 scaled \magstep3
2046 \font\titlesy=cmsy10 scaled \magstep4
2047 \def\titleecsize{2074}
2049 % Chapter (and unnumbered) fonts (17.28pt).
2050 \def\chapnominalsize{17pt}
2051 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2052 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2053 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2054 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2055 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2056 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2058 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2059 \font\chapi=cmmi12 scaled \magstep2
2060 \font\chapsy=cmsy10 scaled \magstep3
2061 \def\chapecsize{1728}
2063 % Section fonts (14.4pt).
2064 \def\secnominalsize{14pt}
2065 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2066 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2067 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2068 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2069 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2070 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2072 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2073 \font\seci=cmmi12 scaled \magstep1
2074 \font\secsy=cmsy10 scaled \magstep2
2075 \def\sececsize{1440}
2077 % Subsection fonts (13.15pt).
2078 \def\ssecnominalsize{13pt}
2079 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2080 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2081 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2082 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2083 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2084 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2086 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2087 \font\sseci=cmmi12 scaled \magstephalf
2088 \font\ssecsy=cmsy10 scaled 1315
2089 \def\ssececsize{1200}
2091 % Reduced fonts for @acro in text (10pt).
2092 \def\reducednominalsize{10pt}
2093 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2094 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2095 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2096 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2097 \setfont\reducedsl\slshape{10}{1000}{OT1}
2098 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2099 \setfont\reducedsc\scshape{10}{1000}{OT1}
2100 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2101 \font\reducedi=cmmi10
2102 \font\reducedsy=cmsy10
2103 \def\reducedecsize{1000}
2105 % reset the current fonts
2108 } % end of 11pt text font size definitions
2111 % Definitions to make the main text be 10pt Computer Modern, with
2112 % section, chapter, etc., sizes following suit. This is for the GNU
2113 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2114 % future. Used with @smallbook, which sets the leading to 12pt.
2116 \def\definetextfontsizex{%
2117 % Text fonts (10pt).
2118 \def\textnominalsize{10pt}
2119 \edef\mainmagstep{1000}
2120 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2121 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2122 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2123 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2124 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2125 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2126 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2127 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2128 \font\texti=cmmi10 scaled \mainmagstep
2129 \font\textsy=cmsy10 scaled \mainmagstep
2130 \def\textecsize{1000}
2132 % A few fonts for @defun names and args.
2133 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2134 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2135 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2136 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2138 % Fonts for indices, footnotes, small examples (9pt).
2139 \def\smallnominalsize{9pt}
2140 \setfont\smallrm\rmshape{9}{1000}{OT1}
2141 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2142 \setfont\smallbf\bfshape{10}{900}{OT1}
2143 \setfont\smallit\itshape{9}{1000}{OT1IT}
2144 \setfont\smallsl\slshape{9}{1000}{OT1}
2145 \setfont\smallsf\sfshape{9}{1000}{OT1}
2146 \setfont\smallsc\scshape{10}{900}{OT1}
2147 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2150 \def\smallecsize{0900}
2152 % Fonts for small examples (8pt).
2153 \def\smallernominalsize{8pt}
2154 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2155 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2156 \setfont\smallerbf\bfshape{10}{800}{OT1}
2157 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2158 \setfont\smallersl\slshape{8}{1000}{OT1}
2159 \setfont\smallersf\sfshape{8}{1000}{OT1}
2160 \setfont\smallersc\scshape{10}{800}{OT1}
2161 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2162 \font\smalleri=cmmi8
2163 \font\smallersy=cmsy8
2164 \def\smallerecsize{0800}
2166 % Fonts for title page (20.4pt):
2167 \def\titlenominalsize{20pt}
2168 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2169 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2170 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2171 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2172 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2173 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2174 \let\titlebf=\titlerm
2175 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2176 \font\titlei=cmmi12 scaled \magstep3
2177 \font\titlesy=cmsy10 scaled \magstep4
2178 \def\titleecsize{2074}
2180 % Chapter fonts (14.4pt).
2181 \def\chapnominalsize{14pt}
2182 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2183 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2184 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2185 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2186 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2187 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2189 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2190 \font\chapi=cmmi12 scaled \magstep1
2191 \font\chapsy=cmsy10 scaled \magstep2
2192 \def\chapecsize{1440}
2194 % Section fonts (12pt).
2195 \def\secnominalsize{12pt}
2196 \setfont\secrm\rmbshape{12}{1000}{OT1}
2197 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2198 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2199 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2200 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2201 \setfont\secsf\sfbshape{12}{1000}{OT1}
2203 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2205 \font\secsy=cmsy10 scaled \magstep1
2206 \def\sececsize{1200}
2208 % Subsection fonts (10pt).
2209 \def\ssecnominalsize{10pt}
2210 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2211 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2212 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2213 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2214 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2215 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2217 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2220 \def\ssececsize{1000}
2222 % Reduced fonts for @acro in text (9pt).
2223 \def\reducednominalsize{9pt}
2224 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2225 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2226 \setfont\reducedbf\bfshape{10}{900}{OT1}
2227 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2228 \setfont\reducedsl\slshape{9}{1000}{OT1}
2229 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2230 \setfont\reducedsc\scshape{10}{900}{OT1}
2231 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2232 \font\reducedi=cmmi9
2233 \font\reducedsy=cmsy9
2234 \def\reducedecsize{0900}
2236 % reduce space between paragraphs
2237 \divide\parskip by 2
2239 % reset the current fonts
2242 } % end of 10pt text font size definitions
2245 % We provide the user-level command
2247 % (or 11) to redefine the text font size. pt is assumed.
2252 \parseargdef\fonttextsize{%
2253 \def\textsizearg{#1}%
2254 \wlog{doing @fonttextsize \textsizearg}%
2256 % Set \globaldefs so that documents can use this inside @tex, since
2257 % makeinfo 4.8 does not support it, but we need it nonetheless.
2259 \begingroup \globaldefs=1
2260 \ifx\textsizearg\xword \definetextfontsizex
2261 \else \ifx\textsizearg\xiword \definetextfontsizexi
2264 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2270 % In order for the font changes to affect most math symbols and letters,
2271 % we have to define the \textfont of the standard families. Since
2272 % texinfo doesn't allow for producing subscripts and superscripts except
2273 % in the main text, we don't bother to reset \scriptfont and
2274 % \scriptscriptfont (which would also require loading a lot more fonts).
2276 \def\resetmathfonts{%
2277 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2278 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2279 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2282 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2283 % of just \STYLE. We do this because \STYLE needs to also set the
2284 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2285 % \tenSTYLE to set the current font.
2287 % Each font-changing command also sets the names \lsize (one size lower)
2288 % and \lllsize (three sizes lower). These relative commands are used in
2289 % the LaTeX logo and acronyms.
2291 % This all needs generalizing, badly.
2294 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2295 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2296 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2297 \let\tenttsl=\textttsl
2298 \def\curfontsize{text}%
2299 \def\lsize{reduced}\def\lllsize{smaller}%
2300 \resetmathfonts \setleading{\textleading}}
2302 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2303 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2304 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2305 \let\tenttsl=\titlettsl
2306 \def\curfontsize{title}%
2307 \def\lsize{chap}\def\lllsize{subsec}%
2308 \resetmathfonts \setleading{25pt}}
2309 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2311 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2312 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2313 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2314 \let\tenttsl=\chapttsl
2315 \def\curfontsize{chap}%
2316 \def\lsize{sec}\def\lllsize{text}%
2317 \resetmathfonts \setleading{19pt}}
2319 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2320 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2321 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2322 \let\tenttsl=\secttsl
2323 \def\curfontsize{sec}%
2324 \def\lsize{subsec}\def\lllsize{reduced}%
2325 \resetmathfonts \setleading{16pt}}
2327 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2328 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2329 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2330 \let\tenttsl=\ssecttsl
2331 \def\curfontsize{ssec}%
2332 \def\lsize{text}\def\lllsize{small}%
2333 \resetmathfonts \setleading{15pt}}
2334 \let\subsubsecfonts = \subsecfonts
2336 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2337 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2338 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2339 \let\tenttsl=\reducedttsl
2340 \def\curfontsize{reduced}%
2341 \def\lsize{small}\def\lllsize{smaller}%
2342 \resetmathfonts \setleading{10.5pt}}
2344 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2345 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2346 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2347 \let\tenttsl=\smallttsl
2348 \def\curfontsize{small}%
2349 \def\lsize{smaller}\def\lllsize{smaller}%
2350 \resetmathfonts \setleading{10.5pt}}
2352 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2353 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2354 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2355 \let\tenttsl=\smallerttsl
2356 \def\curfontsize{smaller}%
2357 \def\lsize{smaller}\def\lllsize{smaller}%
2358 \resetmathfonts \setleading{9.5pt}}
2360 % Fonts for short table of contents.
2361 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2362 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2363 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2364 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2366 % Define these just so they can be easily changed for other fonts.
2367 \def\angleleft{$\langle$}
2368 \def\angleright{$\rangle$}
2370 % Set the fonts to use with the @small... environments.
2371 \let\smallexamplefonts = \smallfonts
2373 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2374 % can fit this many characters:
2375 % 8.5x11=86 smallbook=72 a4=90 a5=69
2376 % If we use \scriptfonts (8pt), then we can fit this many characters:
2377 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2378 % For me, subjectively, the few extra characters that fit aren't worth
2379 % the additional smallness of 8pt. So I'm making the default 9pt.
2381 % By the way, for comparison, here's what fits with @example (10pt):
2382 % 8.5x11=71 smallbook=60 a4=75 a5=58
2385 % Set up the default fonts, so we can use them for creating boxes.
2387 \definetextfontsizexi
2392 % Check if we are currently using a typewriter font. Since all the
2393 % Computer Modern typewriter fonts have zero interword stretch (and
2394 % shrink), and it is reasonable to expect all typewriter fonts to have
2395 % this property, we can check that font parameter.
2397 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2399 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2400 % define and register \INITMACRO to be called on markup style changes.
2401 % \INITMACRO can check \currentmarkupstyle for the innermost
2402 % style and the set of \ifmarkupSTYLE switches for all styles
2403 % currently in effect.
2407 %\newif\ifmarkupfile % @file == @samp.
2408 %\newif\ifmarkupoption % @option == @samp.
2411 %\newif\ifmarkupenv % @env == @code.
2412 %\newif\ifmarkupcommand % @command == @code.
2413 \newif\ifmarkuptex % @tex (and part of @math, for now).
2414 \newif\ifmarkupexample
2416 \newif\ifmarkupverbatim
2418 \let\currentmarkupstyle\empty
2420 \def\setupmarkupstyle#1{%
2421 \csname markup#1true\endcsname
2422 \def\currentmarkupstyle{#1}%
2426 \let\markupstylesetup\empty
2428 \def\defmarkupstylesetup#1{%
2429 \expandafter\def\expandafter\markupstylesetup
2430 \expandafter{\markupstylesetup #1}%
2434 % Markup style setup for left and right quotes.
2435 \defmarkupstylesetup\markupsetuplq{%
2436 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2437 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2440 \defmarkupstylesetup\markupsetuprq{%
2441 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2442 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2449 \gdef\markupsetuplqdefault{\let`\lq}
2450 \gdef\markupsetuprqdefault{\let'\rq}
2452 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2453 \gdef\markupsetcodequoteright{\let'\codequoteright}
2455 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2458 \let\markupsetuplqcode \markupsetcodequoteleft
2459 \let\markupsetuprqcode \markupsetcodequoteright
2460 \let\markupsetuplqexample \markupsetcodequoteleft
2461 \let\markupsetuprqexample \markupsetcodequoteright
2462 \let\markupsetuplqverb \markupsetcodequoteleft
2463 \let\markupsetuprqverb \markupsetcodequoteright
2464 \let\markupsetuplqverbatim \markupsetcodequoteleft
2465 \let\markupsetuprqverbatim \markupsetcodequoteright
2467 \let\markupsetuplqsamp \markupsetnoligaturesquoteleft
2468 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2470 % Allow an option to not replace quotes with a regular directed right
2471 % quote/apostrophe (char 0x27), but instead use the undirected quote
2472 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2473 % the default, but it works for pasting with more pdf viewers (at least
2474 % evince), the lilypond developers report. xpdf does work with the
2477 \def\codequoteright{%
2478 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2479 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2485 % and a similar option for the left quote char vs. a grave accent.
2486 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2487 % the code environments to do likewise.
2489 \def\codequoteleft{%
2490 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2491 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2492 % [Knuth] pp. 380,381,391
2493 % \relax disables Spanish ligatures ?` and !` of \tt font.
2499 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2500 \def\noligaturesquoteleft{\relax\lq}
2502 % Count depth in font-changes, for error checks
2503 \newcount\fontdepth \fontdepth=0
2505 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2506 %% serif) and @ii for TeX italic
2508 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2509 % unless the following character is such as not to need one.
2510 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2511 \ptexslash\fi\fi\fi}
2512 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2513 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2515 % like \smartslanted except unconditionally uses \ttsl.
2516 % @var is set to this for defun arguments.
2517 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2519 % @cite is like \smartslanted except unconditionally use \sl. We never want
2520 % ttsl for book titles, do we?
2521 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2524 \let\slanted=\smartslanted
2525 \def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}}
2526 \let\dfn=\smartslanted
2527 \let\emph=\smartitalic
2529 % Explicit font changes: @r, @sc, undocumented @ii.
2530 \def\r#1{{\rm #1}} % roman font
2531 \def\sc#1{{\smallcaps#1}} % smallcaps font
2532 \def\ii#1{{\it #1}} % italic font
2534 % @b, explicit bold. Also @strong.
2538 % @sansserif, explicit sans.
2539 \def\sansserif#1{{\sf #1}}
2541 % We can't just use \exhyphenpenalty, because that only has effect at
2542 % the end of a paragraph. Restore normal hyphenation at the end of the
2543 % group within which \nohyphenation is presumably called.
2545 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2546 \def\restorehyphenation{\hyphenchar\font = `- }
2548 % Set sfcode to normal for the chars that usually have another value.
2549 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2550 % sometimes \x has an active definition that messes things up.
2553 \def\plainfrenchspacing{%
2554 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2555 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2556 \def\endofsentencespacefactor{1000}% for @. and friends
2558 \def\plainnonfrenchspacing{%
2559 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2560 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2561 \def\endofsentencespacefactor{3000}% for @. and friends
2564 \def\endofsentencespacefactor{3000}% default
2566 % @t, explicit typewriter.
2568 {\tt \rawbackslash \plainfrenchspacing #1}%
2573 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2575 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2576 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2578 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2579 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2580 % \vbox{\hrule\kern-0.4pt
2581 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2582 % \kern-0.4pt\hrule}%
2583 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2585 % definition of @key with no lozenge. If the current font is already
2586 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2587 % if it isn't monospace, then use \tt.
2589 \def\key#1{{\setupmarkupstyle{key}%
2591 \ifmonospace\else\tt\fi
2594 % ctrl is no longer a Texinfo command.
2595 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2597 % @file, @option are the same as @samp.
2601 % @code is a modification of @t,
2602 % which makes spaces the same size as normal in the surrounding text.
2605 % Change normal interword space to be same as for the current font.
2606 \spaceskip = \fontdimen2\font
2608 % Switch to typewriter.
2611 % But `\ ' produces the large typewriter interword space.
2612 \def\ {{\spaceskip = 0pt{} }}%
2614 % Turn off hyphenation.
2624 % We *must* turn on hyphenation at `-' and `_' in @code.
2625 % Otherwise, it is too hard to avoid overfull hboxes
2626 % in the Emacs manual, the Library manual, etc.
2628 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2629 % both hyphenation at - and hyphenation within words.
2630 % We must therefore turn them both off (\tclose does that)
2631 % and arrange explicitly to hyphenate at a dash.
2634 \catcode`\-=\active \catcode`\_=\active
2635 \catcode`\'=\active \catcode`\`=\active
2636 \global\let'=\rq \global\let`=\lq % default definitions
2638 \global\def\code{\begingroup
2639 \setupmarkupstyle{code}%
2640 % The following should really be moved into \setupmarkupstyle handlers.
2641 \catcode\dashChar=\active \catcode\underChar=\active
2654 \def\codedash{-\discretionary{}{}{}}
2656 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2657 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2658 % will therefore expand the active definition of _, which is us
2659 % (inside @code that is), therefore an endless loop.
2661 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2662 \else\normalunderscore \fi
2663 \discretionary{}{}{}}%
2666 \def\codex #1{\tclose{#1}\endgroup}
2668 % An additional complication: the above will allow breaks after, e.g.,
2669 % each of the four underscores in __typeof__. This is undesirable in
2670 % some manuals, especially if they don't have long identifiers in
2671 % general. @allowcodebreaks provides a way to control this.
2673 \newif\ifallowcodebreaks \allowcodebreakstrue
2675 \def\keywordtrue{true}
2676 \def\keywordfalse{false}
2678 \parseargdef\allowcodebreaks{%
2680 \ifx\txiarg\keywordtrue
2681 \allowcodebreakstrue
2682 \else\ifx\txiarg\keywordfalse
2683 \allowcodebreaksfalse
2685 \errhelp = \EMsimple
2686 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2690 % @kbd is like @code, except that if the argument is just one @key command,
2691 % then @kbd has no effect.
2692 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2694 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2695 % `example' (@kbd uses ttsl only inside of @example and friends),
2696 % or `code' (@kbd uses normal tty font always).
2697 \parseargdef\kbdinputstyle{%
2699 \ifx\txiarg\worddistinct
2700 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2701 \else\ifx\txiarg\wordexample
2702 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2703 \else\ifx\txiarg\wordcode
2704 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2706 \errhelp = \EMsimple
2707 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2710 \def\worddistinct{distinct}
2711 \def\wordexample{example}
2714 % Default is `distinct'.
2715 \kbdinputstyle distinct
2718 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2719 \ifx\one\xkey\ifx\threex\three \key{#2}%
2720 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2721 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2723 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2724 \let\indicateurl=\code
2728 % @clicksequence{File @click{} Open ...}
2729 \def\clicksequence#1{\begingroup #1\endgroup}
2731 % @clickstyle @arrow (by default)
2732 \parseargdef\clickstyle{\def\click{#1}}
2735 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2736 % second argument specifying the text to display and an optional third
2737 % arg as text to display instead of (rather than in addition to) the url
2738 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2739 % a hypertex \special here.
2741 \def\uref#1{\douref #1,,,\finish}
2742 \def\douref#1,#2,#3,#4\finish{\begingroup
2745 \setbox0 = \hbox{\ignorespaces #3}%
2747 \unhbox0 % third arg given, show only that
2749 \setbox0 = \hbox{\ignorespaces #2}%
2752 \unhbox0 % PDF: 2nd arg given, show only it
2754 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2757 \code{#1}% only url given, so show it
2763 % @url synonym for @uref, since that's how everyone uses it.
2767 % rms does not like angle brackets --karl, 17may97.
2768 % So now @email is just like @uref, unless we are pdf.
2770 %\def\email#1{\angleleft{\tt #1}\angleright}
2772 \def\email#1{\doemail#1,,\finish}
2773 \def\doemail#1,#2,#3\finish{\begingroup
2776 \setbox0 = \hbox{\ignorespaces #2}%
2777 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2784 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2785 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2787 \def\dmn#1{\thinspace #1}
2789 % @l was never documented to mean ``switch to the Lisp font'',
2790 % and it is not used as such in any manual I can find. We need it for
2791 % Polish suppressed-l. --karl, 22sep96.
2792 %\def\l#1{{\li #1}\null}
2794 % @acronym for "FBI", "NATO", and the like.
2795 % We print this one point size smaller, since it's intended for
2798 \def\acronym#1{\doacronym #1,,\finish}
2799 \def\doacronym#1,#2,#3\finish{%
2800 {\selectfonts\lsize #1}%
2802 \ifx\temp\empty \else
2803 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2807 % @abbr for "Comput. J." and the like.
2808 % No font change, but don't do end-of-sentence spacing.
2810 \def\abbr#1{\doabbr #1,,\finish}
2811 \def\doabbr#1,#2,#3\finish{%
2812 {\plainfrenchspacing #1}%
2814 \ifx\temp\empty \else
2815 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2822 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2824 % Since these characters are used in examples, they should be an even number of
2825 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2828 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2829 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2830 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2831 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2832 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2834 % The @error{} command.
2835 % Adapted from the TeXbook's \boxit.
2839 {\tentt \global\dimen0 = 3em}% Width of the box.
2840 \dimen2 = .55pt % Thickness of rules
2841 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2842 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2844 \setbox\errorbox=\hbox to \dimen0{\hfil
2845 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2846 \advance\hsize by -2\dimen2 % Rules.
2848 \hrule height\dimen2
2849 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2850 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2851 \kern3pt\vrule width\dimen2}% Space to right.
2852 \hrule height\dimen2}
2855 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2857 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2859 \def\pounds{{\it\$}}
2861 % @euro{} comes from a separate font, depending on the current style.
2862 % We use the free feym* fonts from the eurosym package by Henrik
2863 % Theiling, which support regular, slanted, bold and bold slanted (and
2864 % "outlined" (blackboard board, sort of) versions, which we don't need).
2865 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2867 % Although only regular is the truly official Euro symbol, we ignore
2868 % that. The Euro is designed to be slightly taller than the regular
2874 % feybo - bold slanted
2876 % There is no good (free) typewriter version, to my knowledge.
2877 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2880 % Also doesn't work in math. Do we need to do math with euro symbols?
2884 \def\euro{{\eurofont e}}
2886 % We set the font at each command, rather than predefining it in
2887 % \textfonts and the other font-switching commands, so that
2888 % installations which never need the symbol don't have to have the
2891 % There is only one designed size (nominal 10pt), so we always scale
2892 % that to the current nominal size.
2894 % By the way, simply using "at 1em" works for cmr10 and the like, but
2895 % does not work for cmbx10 and other extended/shrunken fonts.
2897 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2899 \ifx\curfontstyle\bfstylename
2901 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2904 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2909 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2910 % sometimes we redefine the original macro, and the alias should reflect
2913 % Use LaTeX names for the Icelandic letters.
2914 \def\DH{{\ecfont \char"D0}} % Eth
2915 \def\dh{{\ecfont \char"F0}} % eth
2916 \def\TH{{\ecfont \char"DE}} % Thorn
2917 \def\th{{\ecfont \char"FE}} % thorn
2919 \def\guillemetleft{{\ecfont \char"13}}
2920 \def\guillemotleft{\guillemetleft}
2921 \def\guillemetright{{\ecfont \char"14}}
2922 \def\guillemotright{\guillemetright}
2923 \def\guilsinglleft{{\ecfont \char"0E}}
2924 \def\guilsinglright{{\ecfont \char"0F}}
2925 \def\quotedblbase{{\ecfont \char"12}}
2926 \def\quotesinglbase{{\ecfont \char"0D}}
2928 % This positioning is not perfect (see the ogonek LaTeX package), but
2929 % we have the precomposed glyphs for the most common cases. We put the
2930 % tests to use those glyphs in the single \ogonek macro so we have fewer
2931 % dummy definitions to worry about for index entries, etc.
2933 % ogonek is also used with other letters in Lithuanian (IOU), but using
2934 % the precomposed glyphs for those is not so easy since they aren't in
2938 \ifx\temp\macrocharA\Aogonek
2939 \else\ifx\temp\macrochara\aogonek
2940 \else\ifx\temp\macrocharE\Eogonek
2941 \else\ifx\temp\macrochare\eogonek
2943 \ecfont \setbox0=\hbox{#1}%
2944 \ifdim\ht0=1ex\accent"0C #1%
2945 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2950 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2951 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2952 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2953 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2955 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2957 % We can't distinguish serif/sans and italic/slanted, but this
2958 % is used for crude hacks anyway (like adding French and German
2959 % quotes to documents typeset with CM, where we lose kerning), so
2960 % hopefully nobody will notice/care.
2961 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2962 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2963 \ifx\curfontstyle\bfstylename
2965 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2968 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2973 % @registeredsymbol - R in a circle. The font for the R should really
2974 % be smaller yet, but lllsize is the best we can do for now.
2975 % Adapted from the plain.tex definition of \copyright.
2977 \def\registeredsymbol{%
2978 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2983 % @textdegree - the normal degrees sign.
2985 \def\textdegree{$^\circ$}
2987 % Laurent Siebenmann reports \Orb undefined with:
2988 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2989 % so we'll define it if necessary.
2992 \def\Orb{\mathhexbox20D}
2996 \chardef\quotedblleft="5C
2997 \chardef\quotedblright=`\"
2998 \chardef\quoteleft=`\`
2999 \chardef\quoteright=`\'
3002 \message{page headings,}
3004 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3005 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3007 % First the title page. Must do @settitle before @titlepage.
3009 \newif\iffinishedtitlepage
3011 % Do an implicit @contents or @shortcontents after @end titlepage if the
3012 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3014 \newif\ifsetcontentsaftertitlepage
3015 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3016 \newif\ifsetshortcontentsaftertitlepage
3017 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3019 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3020 \endgroup\page\hbox{}\page}
3023 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3025 \parindent=0pt \textfonts
3026 % Leave some space at the very top of the page.
3027 \vglue\titlepagetopglue
3028 % No rule at page bottom unless we print one at the top with @title.
3029 \finishedtitlepagetrue
3031 % Most title ``pages'' are actually two pages long, with space
3032 % at the top of the second. We don't want the ragged left on the second.
3033 \let\oldpage = \page
3035 \iffinishedtitlepage\else
3038 \let\page = \oldpage
3045 \iffinishedtitlepage\else
3048 % It is important to do the page break before ending the group,
3049 % because the headline and footline are only empty inside the group.
3050 % If we use the new definition of \page, we always get a blank page
3051 % after the title page, which we certainly don't want.
3055 % Need this before the \...aftertitlepage checks so that if they are
3056 % in effect the toc pages will come out with page numbers.
3059 % If they want short, they certainly want long too.
3060 \ifsetshortcontentsaftertitlepage
3063 \global\let\shortcontents = \relax
3064 \global\let\contents = \relax
3067 \ifsetcontentsaftertitlepage
3069 \global\let\contents = \relax
3070 \global\let\shortcontents = \relax
3074 \def\finishtitlepage{%
3075 \vskip4pt \hrule height 2pt width \hsize
3076 \vskip\titlepagebottomglue
3077 \finishedtitlepagetrue
3080 %%% Macros to be used within @titlepage:
3082 \let\subtitlerm=\tenrm
3083 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3085 \parseargdef\title{%
3087 \leftline{\titlefonts\rmisbold #1}
3088 % print a rule at the page bottom also.
3089 \finishedtitlepagefalse
3090 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3093 \parseargdef\subtitle{%
3095 {\subtitlefont \rightline{#1}}%
3098 % @author should come last, but may come many times.
3099 % It can also be used inside @quotation.
3101 \parseargdef\author{%
3102 \def\temp{\quotation}%
3104 \def\quotationauthor{#1}% printed in \Equotation.
3107 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3108 {\secfonts\rmisbold \leftline{#1}}%
3113 %%% Set up page headings and footings.
3115 \let\thispage=\folio
3117 \newtoks\evenheadline % headline on even pages
3118 \newtoks\oddheadline % headline on odd pages
3119 \newtoks\evenfootline % footline on even pages
3120 \newtoks\oddfootline % footline on odd pages
3122 % Now make TeX use those variables
3123 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3124 \else \the\evenheadline \fi}}
3125 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3126 \else \the\evenfootline \fi}\HEADINGShook}
3127 \let\HEADINGShook=\relax
3129 % Commands to set those variables.
3130 % For example, this is what @headings on does
3131 % @evenheading @thistitle|@thispage|@thischapter
3132 % @oddheading @thischapter|@thispage|@thistitle
3133 % @evenfooting @thisfile||
3134 % @oddfooting ||@thisfile
3137 \def\evenheading{\parsearg\evenheadingxxx}
3138 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3139 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3140 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3142 \def\oddheading{\parsearg\oddheadingxxx}
3143 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3144 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3145 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3147 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3149 \def\evenfooting{\parsearg\evenfootingxxx}
3150 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3151 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3152 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3154 \def\oddfooting{\parsearg\oddfootingxxx}
3155 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3156 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3157 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3159 % Leave some space for the footline. Hopefully ok to assume
3160 % @evenfooting will not be used by itself.
3161 \global\advance\pageheight by -12pt
3162 \global\advance\vsize by -12pt
3165 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3167 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3168 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3170 % The same set of arguments for:
3175 % @everyheadingmarks
3176 % @everyfootingmarks
3178 \def\evenheadingmarks{\headingmarks{even}{heading}}
3179 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3180 \def\evenfootingmarks{\headingmarks{even}{footing}}
3181 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3182 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3183 \headingmarks{odd}{heading}{#1} }
3184 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3185 \headingmarks{odd}{footing}{#1} }
3186 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3187 \def\headingmarks#1#2#3 {%
3188 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3189 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3192 \everyheadingmarks bottom
3193 \everyfootingmarks bottom
3195 % @headings double turns headings on for double-sided printing.
3196 % @headings single turns headings on for single-sided printing.
3197 % @headings off turns them off.
3198 % @headings on same as @headings double, retained for compatibility.
3199 % @headings after turns on double-sided headings after this page.
3200 % @headings doubleafter turns on double-sided headings after this page.
3201 % @headings singleafter turns on single-sided headings after this page.
3202 % By default, they are off at the start of a document,
3203 % and turned `on' after @end titlepage.
3205 \def\headings #1 {\csname HEADINGS#1\endcsname}
3208 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3209 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3211 % When we turn headings on, set the page number to 1.
3212 % For double-sided printing, put current file name in lower left corner,
3213 % chapter name on inside top of right hand pages, document
3214 % title on inside top of left hand pages, and page numbers on outside top
3215 % edge of all pages.
3216 \def\HEADINGSdouble{%
3218 \global\evenfootline={\hfil}
3219 \global\oddfootline={\hfil}
3220 \global\evenheadline={\line{\folio\hfil\thistitle}}
3221 \global\oddheadline={\line{\thischapter\hfil\folio}}
3222 \global\let\contentsalignmacro = \chapoddpage
3224 \let\contentsalignmacro = \chappager
3226 % For single-sided printing, chapter title goes across top left of page,
3227 % page number on top right.
3228 \def\HEADINGSsingle{%
3230 \global\evenfootline={\hfil}
3231 \global\oddfootline={\hfil}
3232 \global\evenheadline={\line{\thischapter\hfil\folio}}
3233 \global\oddheadline={\line{\thischapter\hfil\folio}}
3234 \global\let\contentsalignmacro = \chappager
3236 \def\HEADINGSon{\HEADINGSdouble}
3238 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3239 \let\HEADINGSdoubleafter=\HEADINGSafter
3240 \def\HEADINGSdoublex{%
3241 \global\evenfootline={\hfil}
3242 \global\oddfootline={\hfil}
3243 \global\evenheadline={\line{\folio\hfil\thistitle}}
3244 \global\oddheadline={\line{\thischapter\hfil\folio}}
3245 \global\let\contentsalignmacro = \chapoddpage
3248 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3249 \def\HEADINGSsinglex{%
3250 \global\evenfootline={\hfil}
3251 \global\oddfootline={\hfil}
3252 \global\evenheadline={\line{\thischapter\hfil\folio}}
3253 \global\oddheadline={\line{\thischapter\hfil\folio}}
3254 \global\let\contentsalignmacro = \chappager
3257 % Subroutines used in generating headings
3258 % This produces Day Month Year style of output.
3259 % Only define if not already defined, in case a txi-??.tex file has set
3260 % up a different format (e.g., txi-cs.tex does this).
3261 \ifx\today\undefined
3265 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3266 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3267 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3272 % @settitle line... specifies the title of the document, for headings.
3273 % It generates no output of its own.
3274 \def\thistitle{\putwordNoTitle}
3275 \def\settitle{\parsearg{\gdef\thistitle}}
3279 % Tables -- @table, @ftable, @vtable, @item(x).
3281 % default indentation of table text
3282 \newdimen\tableindent \tableindent=.8in
3283 % default indentation of @itemize and @enumerate text
3284 \newdimen\itemindent \itemindent=.3in
3285 % margin between end of table item and start of table text.
3286 \newdimen\itemmargin \itemmargin=.1in
3288 % used internally for \itemindent minus \itemmargin
3291 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3293 % They also define \itemindex
3294 % to index the item name in whatever manner is desired (perhaps none).
3296 \newif\ifitemxneedsnegativevskip
3298 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3300 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3301 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3303 \def\itemzzz #1{\begingroup %
3304 \advance\hsize by -\rightskip
3305 \advance\hsize by -\tableindent
3306 \setbox0=\hbox{\itemindicate{#1}}%
3308 \nobreak % This prevents a break before @itemx.
3310 % If the item text does not fit in the space we have, put it on a line
3311 % by itself, and do not allow a page break either before or after that
3312 % line. We do not start a paragraph here because then if the next
3313 % command is, e.g., @kindex, the whatsit would get put into the
3314 % horizontal list on a line by itself, resulting in extra blank space.
3315 \ifdim \wd0>\itemmax
3317 % Make this a paragraph so we get the \parskip glue and wrapping,
3318 % but leave it ragged-right.
3320 \advance\leftskip by-\tableindent
3321 \advance\hsize by\tableindent
3322 \advance\rightskip by0pt plus1fil
3323 \leavevmode\unhbox0\par
3326 % We're going to be starting a paragraph, but we don't want the
3327 % \parskip glue -- logically it's part of the @item we just started.
3328 \nobreak \vskip-\parskip
3330 % Stop a page break at the \parskip glue coming up. However, if
3331 % what follows is an environment such as @example, there will be no
3332 % \parskip glue; then the negative vskip we just inserted would
3333 % cause the example and the item to crash together. So we use this
3334 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3335 % \parskip glue after all. Section titles are handled this way also.
3339 \itemxneedsnegativevskipfalse
3341 % The item text fits into the space. Start a paragraph, so that the
3342 % following text (if any) will end up on the same line.
3344 % Do this with kerns and \unhbox so that if there is a footnote in
3345 % the item text, it can migrate to the main vertical list and
3346 % eventually be printed.
3347 \nobreak\kern-\tableindent
3348 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3350 \nobreak\kern\dimen0
3352 \itemxneedsnegativevskiptrue
3356 \def\item{\errmessage{@item while not in a list environment}}
3357 \def\itemx{\errmessage{@itemx while not in a list environment}}
3359 % @table, @ftable, @vtable.
3361 \let\itemindex\gobble
3365 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3366 \tablecheck{ftable}%
3369 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3370 \tablecheck{vtable}%
3373 \ifnum \the\catcode`\^^M=\active
3375 \errmessage{This command won't work in this context; perhaps the problem is
3376 that we are \inenvironment\thisenv}%
3377 \def\next{\doignore{#1}}%
3384 \def\itemindicate{#1}%
3389 \makevalueexpandable
3390 \edef\temp{\noexpand\tablez #1\space\space\space}%
3394 \def\tablez #1 #2 #3 #4\endtablez{%
3396 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3397 \ifnum 0#2>0 \tableindent=#2\mil \fi
3398 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3399 \itemmax=\tableindent
3400 \advance \itemmax by -\itemmargin
3401 \advance \leftskip by \tableindent
3402 \exdentamount=\tableindent
3404 \parskip = \smallskipamount
3405 \ifdim \parskip=0pt \parskip=2pt \fi
3406 \let\item = \internalBitem
3407 \let\itemx = \internalBitemx
3409 \def\Etable{\endgraf\afterenvbreak}
3412 \let\Eitemize\Etable
3413 \let\Eenumerate\Etable
3415 % This is the counter used by @enumerate, which is really @itemize
3419 \envdef\itemize{\parsearg\doitemize}
3423 \itemmax=\itemindent
3424 \advance\itemmax by -\itemmargin
3425 \advance\leftskip by \itemindent
3426 \exdentamount=\itemindent
3428 \parskip=\smallskipamount
3429 \ifdim\parskip=0pt \parskip=2pt \fi
3431 % Try typesetting the item mark that if the document erroneously says
3432 % something like @itemize @samp (intending @table), there's an error
3433 % right away at the @itemize. It's not the best error message in the
3434 % world, but it's better than leaving it to the @item. This means if
3435 % the user wants an empty mark, they have to say @w{} not just @w.
3436 \def\itemcontents{#1}%
3437 \setbox0 = \hbox{\itemcontents}%
3439 % @itemize with no arg is equivalent to @itemize @bullet.
3440 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3442 \let\item=\itemizeitem
3445 % Definition of @item while inside @itemize and @enumerate.
3448 \advance\itemno by 1 % for enumerations
3449 {\let\par=\endgraf \smallbreak}% reasonable place to break
3451 % If the document has an @itemize directly after a section title, a
3452 % \nobreak will be last on the list, and \sectionheading will have
3453 % done a \vskip-\parskip. In that case, we don't want to zero
3454 % parskip, or the item text will crash with the heading. On the
3455 % other hand, when there is normal text preceding the item (as there
3456 % usually is), we do want to zero parskip, or there would be too much
3457 % space. In that case, we won't have a \nobreak before. At least
3458 % that's the theory.
3459 \ifnum\lastpenalty<10000 \parskip=0in \fi
3461 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3463 \vadjust{\penalty 1200}}% not good to break after first line of item.
3467 % \splitoff TOKENS\endmark defines \first to be the first token in
3468 % TOKENS, and \rest to be the remainder.
3470 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3472 % Allow an optional argument of an uppercase letter, lowercase letter,
3473 % or number, to specify the first label in the enumerated list. No
3474 % argument is the same as `1'.
3476 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3477 \def\enumeratey #1 #2\endenumeratey{%
3478 % If we were given no argument, pretend we were given `1'.
3480 \ifx\thearg\empty \def\thearg{1}\fi
3482 % Detect if the argument is a single token. If so, it might be a
3483 % letter. Otherwise, the only valid thing it can be is a number.
3484 % (We will always have one token, because of the test we just made.
3485 % This is a good thing, since \splitoff doesn't work given nothing at
3486 % all -- the first parameter is undelimited.)
3487 \expandafter\splitoff\thearg\endmark
3489 % Only one token in the argument. It could still be anything.
3490 % A ``lowercase letter'' is one whose \lccode is nonzero.
3491 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3492 % not equal to itself.
3493 % Otherwise, we assume it's a number.
3495 % We need the \relax at the end of the \ifnum lines to stop TeX from
3496 % continuing to look for a <number>.
3498 \ifnum\lccode\expandafter`\thearg=0\relax
3499 \numericenumerate % a number (we hope)
3502 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3503 \lowercaseenumerate % lowercase letter
3505 \uppercaseenumerate % uppercase letter
3509 % Multiple tokens in the argument. We hope it's a number.
3514 % An @enumerate whose labels are integers. The starting integer is
3517 \def\numericenumerate{%
3519 \startenumeration{\the\itemno}%
3522 % The starting (lowercase) letter is in \thearg.
3523 \def\lowercaseenumerate{%
3524 \itemno = \expandafter`\thearg
3526 % Be sure we're not beyond the end of the alphabet.
3528 \errmessage{No more lowercase letters in @enumerate; get a bigger
3535 % The starting (uppercase) letter is in \thearg.
3536 \def\uppercaseenumerate{%
3537 \itemno = \expandafter`\thearg
3539 % Be sure we're not beyond the end of the alphabet.
3541 \errmessage{No more uppercase letters in @enumerate; get a bigger
3548 % Call \doitemize, adding a period to the first argument and supplying the
3549 % common last two arguments. Also subtract one from the initial value in
3550 % \itemno, since @item increments \itemno.
3552 \def\startenumeration#1{%
3553 \advance\itemno by -1
3554 \doitemize{#1.}\flushcr
3557 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3560 \def\alphaenumerate{\enumerate{a}}
3561 \def\capsenumerate{\enumerate{A}}
3562 \def\Ealphaenumerate{\Eenumerate}
3563 \def\Ecapsenumerate{\Eenumerate}
3566 % @multitable macros
3567 % Amy Hendrickson, 8/18/94, 3/6/96
3569 % @multitable ... @end multitable will make as many columns as desired.
3570 % Contents of each column will wrap at width given in preamble. Width
3571 % can be specified either with sample text given in a template line,
3572 % or in percent of \hsize, the current width of text on page.
3574 % Table can continue over pages but will only break between lines.
3578 % Either define widths of columns in terms of percent of \hsize:
3579 % @multitable @columnfractions .25 .3 .45
3582 % Numbers following @columnfractions are the percent of the total
3583 % current hsize to be used for each column. You may use as many
3584 % columns as desired.
3587 % Or use a template:
3588 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3590 % using the widest term desired in each column.
3592 % Each new table line starts with @item, each subsequent new column
3593 % starts with @tab. Empty columns may be produced by supplying @tab's
3594 % with nothing between them for as many times as empty columns are needed,
3595 % ie, @tab@tab@tab will produce two empty columns.
3597 % @item, @tab do not need to be on their own lines, but it will not hurt
3600 % Sample multitable:
3602 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3603 % @item first col stuff @tab second col stuff @tab third col
3610 % @item first col stuff @tab second col stuff
3611 % @tab Many paragraphs of text may be used in any column.
3613 % They will wrap at the width determined by the template.
3614 % @item@tab@tab This will be in third column.
3617 % Default dimensions may be reset by user.
3618 % @multitableparskip is vertical space between paragraphs in table.
3619 % @multitableparindent is paragraph indent in table.
3620 % @multitablecolmargin is horizontal space to be left between columns.
3621 % @multitablelinespace is space to leave between table items, baseline
3623 % 0pt means it depends on current normal line spacing.
3625 \newskip\multitableparskip
3626 \newskip\multitableparindent
3627 \newdimen\multitablecolspace
3628 \newskip\multitablelinespace
3629 \multitableparskip=0pt
3630 \multitableparindent=6pt
3631 \multitablecolspace=12pt
3632 \multitablelinespace=0pt
3634 % Macros used to set up halign preamble:
3636 \let\endsetuptable\relax
3637 \def\xendsetuptable{\endsetuptable}
3638 \let\columnfractions\relax
3639 \def\xcolumnfractions{\columnfractions}
3642 % #1 is the @columnfraction, usually a decimal number like .5, but might
3643 % be just 1. We just use it, whatever it is.
3645 \def\pickupwholefraction#1 {%
3646 \global\advance\colcount by 1
3647 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3654 \ifx\firstarg\xendsetuptable
3657 \ifx\firstarg\xcolumnfractions
3658 \global\setpercenttrue
3661 \let\go\pickupwholefraction
3663 \global\advance\colcount by 1
3664 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3665 % separator; typically that is always in the input, anyway.
3666 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3669 \ifx\go\pickupwholefraction
3670 % Put the argument back for the \pickupwholefraction call, so
3671 % we'll always have a period there to be parsed.
3672 \def\go{\pickupwholefraction#1}%
3674 \let\go = \setuptable
3680 % multitable-only commands.
3682 % @headitem starts a heading row, which we typeset in bold.
3683 % Assignments have to be global since we are inside the implicit group
3684 % of an alignment entry. \everycr resets \everytab so we don't have to
3685 % undo it ourselves.
3686 \def\headitemfont{\b}% for people to use in the template row; not changeable
3688 \checkenv\multitable
3690 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3691 \the\everytab % for the first item
3694 % A \tab used to include \hskip1sp. But then the space in a template
3695 % line is not enough. That is bad. So let's go back to just `&' until
3696 % we again encounter the problem the 1sp was intended to solve.
3697 % --karl, nathan@acm.org, 20apr99.
3698 \def\tab{\checkenv\multitable &\the\everytab}%
3700 % @multitable ... @end multitable definitions:
3702 \newtoks\everytab % insert after every tab.
3704 \envdef\multitable{%
3708 % @item within a multitable starts a normal row.
3709 % We use \def instead of \let so that if one of the multitable entries
3710 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3711 % \endtemplate) expanding \doitemize.
3716 \setmultitablespacing
3717 \parskip=\multitableparskip
3718 \parindent=\multitableparindent
3724 \global\everytab={}%
3725 \global\colcount=0 % Reset the column counter.
3726 % Check for saved footnotes, etc.
3728 % Keeps underfull box messages off when table breaks over pages.
3730 % Maybe so, but it also creates really weird page breaks when the
3731 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3732 % problem manifests itself, so it can be fixed for real --karl.
3736 \parsearg\domultitable
3738 \def\domultitable#1{%
3739 % To parse everything between @multitable and @item:
3740 \setuptable#1 \endsetuptable
3742 % This preamble sets up a generic column definition, which will
3743 % be used as many times as user calls for columns.
3744 % \vtop will set a single line and will also let text wrap and
3745 % continue for many paragraphs if desired.
3747 \global\advance\colcount by 1
3750 % Use the current \colcount to find the correct column width:
3751 \hsize=\expandafter\csname col\the\colcount\endcsname
3753 % In order to keep entries from bumping into each other
3754 % we will add a \leftskip of \multitablecolspace to all columns after
3757 % If a template has been used, we will add \multitablecolspace
3758 % to the width of each template entry.
3760 % If the user has set preamble in terms of percent of \hsize we will
3761 % use that dimension as the width of the column, and the \leftskip
3762 % will keep entries from bumping into each other. Table will start at
3763 % left margin and final column will justify at right margin.
3765 % Make sure we don't inherit \rightskip from the outer environment.
3768 % The first column will be indented with the surrounding text.
3769 \advance\hsize by\leftskip
3772 % If user has not set preamble in terms of percent of \hsize
3773 % we will advance \hsize by \multitablecolspace.
3774 \advance\hsize by \multitablecolspace
3776 % In either case we will make \leftskip=\multitablecolspace:
3777 \leftskip=\multitablecolspace
3779 % Ignoring space at the beginning and end avoids an occasional spurious
3780 % blank line, when TeX decides to break the line at the space before the
3781 % box from the multistrut, so the strut ends up on a line by itself.
3783 % @multitable @columnfractions .11 .89
3785 % @tab Legal holiday which is valid in major parts of the whole country.
3786 % Is automatically provided with highlighting sequences respectively
3787 % marking characters.
3788 \noindent\ignorespaces##\unskip\multistrut
3793 \egroup % end the \halign
3794 \global\setpercentfalse
3797 \def\setmultitablespacing{%
3798 \def\multistrut{\strut}% just use the standard line spacing
3800 % Compute \multitablelinespace (if not defined by user) for use in
3801 % \multitableparskip calculation. We used define \multistrut based on
3802 % this, but (ironically) that caused the spacing to be off.
3803 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3804 \ifdim\multitablelinespace=0pt
3805 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3806 \global\advance\multitablelinespace by-\ht0
3808 %% Test to see if parskip is larger than space between lines of
3809 %% table. If not, do nothing.
3810 %% If so, set to same dimension as multitablelinespace.
3811 \ifdim\multitableparskip>\multitablelinespace
3812 \global\multitableparskip=\multitablelinespace
3813 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3814 %% than skip between lines in the table.
3816 \ifdim\multitableparskip=0pt
3817 \global\multitableparskip=\multitablelinespace
3818 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3819 %% than skip between lines in the table.
3823 \message{conditionals,}
3825 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3826 % @ifnotxml always succeed. They currently do nothing; we don't
3827 % attempt to check whether the conditionals are properly nested. But we
3828 % have to remember that they are conditionals, so that @end doesn't
3829 % attempt to close an environment group.
3832 \expandafter\let\csname #1\endcsname = \relax
3833 \expandafter\let\csname iscond.#1\endcsname = 1
3836 \makecond{ifnotdocbook}
3837 \makecond{ifnothtml}
3838 \makecond{ifnotinfo}
3839 \makecond{ifnotplaintext}
3842 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3844 \def\direntry{\doignore{direntry}}
3845 \def\documentdescription{\doignore{documentdescription}}
3846 \def\docbook{\doignore{docbook}}
3847 \def\html{\doignore{html}}
3848 \def\ifdocbook{\doignore{ifdocbook}}
3849 \def\ifhtml{\doignore{ifhtml}}
3850 \def\ifinfo{\doignore{ifinfo}}
3851 \def\ifnottex{\doignore{ifnottex}}
3852 \def\ifplaintext{\doignore{ifplaintext}}
3853 \def\ifxml{\doignore{ifxml}}
3854 \def\ignore{\doignore{ignore}}
3855 \def\menu{\doignore{menu}}
3856 \def\xml{\doignore{xml}}
3858 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3860 % A count to remember the depth of nesting.
3861 \newcount\doignorecount
3863 \def\doignore#1{\begingroup
3864 % Scan in ``verbatim'' mode:
3866 \catcode`\@ = \other
3867 \catcode`\{ = \other
3868 \catcode`\} = \other
3870 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3873 % Count number of #1's that we've seen.
3876 % Swallow text until we reach the matching `@end #1'.
3880 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3883 \gdef\dodoignore#1{%
3884 % #1 contains the command name as a string, e.g., `ifinfo'.
3886 % Define a command to find the next `@end #1'.
3887 \long\def\doignoretext##1^^M@end #1{%
3888 \doignoretextyyy##1^^M@#1\_STOP_}%
3890 % And this command to find another #1 command, at the beginning of a
3891 % line. (Otherwise, we would consider a line `@c @ifset', for
3892 % example, to count as an @ifset for nesting.)
3893 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3895 % And now expand that command.
3900 \def\doignoreyyy#1{%
3902 \ifx\temp\empty % Nothing found.
3903 \let\next\doignoretextzzz
3904 \else % Found a nested condition, ...
3905 \advance\doignorecount by 1
3906 \let\next\doignoretextyyy % ..., look for another.
3907 % If we're here, #1 ends with ^^M\ifinfo (for example).
3909 \next #1% the token \_STOP_ is present just after this macro.
3912 % We have to swallow the remaining "\_STOP_".
3914 \def\doignoretextzzz#1{%
3915 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3916 \let\next\enddoignore
3917 \else % Still inside a nested condition.
3918 \advance\doignorecount by -1
3919 \let\next\doignoretext % Look for the next @end.
3924 % Finish off ignored text.
3926 % Ignore anything after the last `@end #1'; this matters in verbatim
3927 % environments, where otherwise the newline after an ignored conditional
3928 % would result in a blank line in the output.
3929 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3933 % @set VAR sets the variable VAR to an empty value.
3934 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3936 % Since we want to separate VAR from REST-OF-LINE (which might be
3937 % empty), we can't just use \parsearg; we have to insert a space of our
3938 % own to delimit the rest of the line, and then take it out again if we
3940 % We rely on the fact that \parsearg sets \catcode`\ =10.
3942 \parseargdef\set{\setyyy#1 \endsetyyy}
3943 \def\setyyy#1 #2\endsetyyy{%
3945 \makevalueexpandable
3947 \edef\next{\gdef\makecsname{SET#1}}%
3955 % Remove the trailing space \setxxx inserted.
3956 \def\setzzz#1 \endsetzzz{\next{#1}}
3958 % @clear VAR clears (i.e., unsets) the variable VAR.
3960 \parseargdef\clear{%
3962 \makevalueexpandable
3963 \global\expandafter\let\csname SET#1\endcsname=\relax
3967 % @value{foo} gets the text saved in variable foo.
3968 \def\value{\begingroup\makevalueexpandable\valuexxx}
3969 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3971 \catcode`\- = \active \catcode`\_ = \active
3973 \gdef\makevalueexpandable{%
3974 \let\value = \expandablevalue
3975 % We don't want these characters active, ...
3976 \catcode`\-=\other \catcode`\_=\other
3977 % ..., but we might end up with active ones in the argument if
3978 % we're called from @code, as @code{@value{foo-bar_}}, though.
3979 % So \let them to their normal equivalents.
3980 \let-\realdash \let_\normalunderscore
3984 % We have this subroutine so that we can handle at least some @value's
3985 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3986 % The command has to be fully expandable (if the variable is set), since
3987 % the result winds up in the index file. This means that if the
3988 % variable's value contains other Texinfo commands, it's almost certain
3989 % it will fail (although perhaps we could fix that with sufficient work
3990 % to do a one-level expansion on the result, instead of complete).
3992 \def\expandablevalue#1{%
3993 \expandafter\ifx\csname SET#1\endcsname\relax
3994 {[No value for ``#1'']}%
3995 \message{Variable `#1', used in @value, is not set.}%
3997 \csname SET#1\endcsname
4001 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4004 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4007 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4010 \makevalueexpandable
4012 \expandafter\ifx\csname SET#2\endcsname\relax
4013 #1% If not set, redefine \next.
4018 \def\ifsetfail{\doignore{ifset}}
4020 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4021 % defined with @set, or has been undefined with @clear.
4023 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4024 % above code: if the variable is not set, do nothing, if it is set,
4025 % then redefine \next to \ifclearfail.
4028 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4029 \def\ifclearfail{\doignore{ifclear}}
4031 % @dircategory CATEGORY -- specify a category of the dir file
4032 % which this file should belong to. Ignore this in TeX.
4033 \let\dircategory=\comment
4035 % @defininfoenclose.
4036 \let\definfoenclose=\comment
4040 % Index generation facilities
4042 % Define \newwrite to be identical to plain tex's \newwrite
4043 % except not \outer, so it can be used within macros and \if's.
4044 \edef\newwrite{\makecsname{ptexnewwrite}}
4046 % \newindex {foo} defines an index named foo.
4047 % It automatically defines \fooindex such that
4048 % \fooindex ...rest of line... puts an entry in the index foo.
4049 % It also defines \fooindfile to be the number of the output channel for
4050 % the file that accumulates this index. The file's extension is foo.
4051 % The name of an index should be no more than 2 characters long
4052 % for the sake of vms.
4056 \expandafter\newwrite \csname#1indfile\endcsname
4057 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4059 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4060 \noexpand\doindex{#1}}
4063 % @defindex foo == \newindex{foo}
4065 \def\defindex{\parsearg\newindex}
4067 % Define @defcodeindex, like @defindex except put all entries in @code.
4069 \def\defcodeindex{\parsearg\newcodeindex}
4071 \def\newcodeindex#1{%
4073 \expandafter\newwrite \csname#1indfile\endcsname
4074 \openout \csname#1indfile\endcsname \jobname.#1
4076 \expandafter\xdef\csname#1index\endcsname{%
4077 \noexpand\docodeindex{#1}}%
4081 % @synindex foo bar makes index foo feed into index bar.
4082 % Do this instead of @defindex foo if you don't want it as a separate index.
4084 % @syncodeindex foo bar similar, but put all entries made for index foo
4087 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4088 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4090 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4091 % #3 the target index (bar).
4092 \def\dosynindex#1#2#3{%
4093 % Only do \closeout if we haven't already done it, else we'll end up
4094 % closing the target index.
4095 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4096 % The \closeout helps reduce unnecessary open files; the limit on the
4097 % Acorn RISC OS is a mere 16 files.
4098 \expandafter\closeout\csname#2indfile\endcsname
4099 \expandafter\let\csname donesynindex#2\endcsname = 1
4101 % redefine \fooindfile:
4102 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4103 \expandafter\let\csname#2indfile\endcsname=\temp
4104 % redefine \fooindex:
4105 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4108 % Define \doindex, the driver for all \fooindex macros.
4109 % Argument #1 is generated by the calling \fooindex macro,
4110 % and it is "foo", the name of the index.
4112 % \doindex just uses \parsearg; it calls \doind for the actual work.
4113 % This is because \doind is more useful to call from other macros.
4115 % There is also \dosubind {index}{topic}{subtopic}
4116 % which makes an entry in a two-level index such as the operation index.
4118 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4119 \def\singleindexer #1{\doind{\indexname}{#1}}
4121 % like the previous two, but they put @code around the argument.
4122 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4123 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4125 % Take care of Texinfo commands that can appear in an index entry.
4126 % Since there are some commands we want to expand, and others we don't,
4127 % we have to laboriously prevent expansion for those that we don't.
4130 \escapechar = `\\ % use backslash in output files.
4131 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4132 \def\ {\realbackslash\space }%
4134 % Need these in case \tex is in effect and \{ is a \delimiter again.
4135 % But can't use \lbracecmd and \rbracecmd because texindex assumes
4136 % braces and backslashes are used only as delimiters.
4140 % I don't entirely understand this, but when an index entry is
4141 % generated from a macro call, the \endinput which \scanmacro inserts
4142 % causes processing to be prematurely terminated. This is,
4143 % apparently, because \indexsorttmp is fully expanded, and \endinput
4144 % is an expandable command. The redefinition below makes \endinput
4145 % disappear altogether for that purpose -- although logging shows that
4146 % processing continues to some further point. On the other hand, it
4147 % seems \endinput does not hurt in the printed index arg, since that
4148 % is still getting written without apparent harm.
4150 % Sample source (mac-idx3.tex, reported by Graham Percival to
4151 % help-texinfo, 22may06):
4152 % @macro funindex {WORD}
4156 % @funindex commtest
4158 % The above is not enough to reproduce the bug, but it gives the flavor.
4160 % Sample whatsit resulting:
4161 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4164 \let\endinput = \empty
4166 % Do the redefinitions.
4170 % For the aux and toc files, @ is the escape character. So we want to
4171 % redefine everything using @ as the escape character (instead of
4172 % \realbackslash, still used for index files). When everything uses @,
4173 % this will be simpler.
4178 \let\{ = \lbraceatcmd
4179 \let\} = \rbraceatcmd
4181 % Do the redefinitions.
4186 % Called from \indexdummies and \atdummies.
4188 \def\commondummies{%
4190 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4191 % preventing its expansion. This is used only for control% words,
4192 % not control letters, because the \space would be incorrect for
4193 % control characters, but is needed to separate the control word
4194 % from whatever follows.
4196 % For control letters, we have \definedummyletter, which omits the
4199 % These can be used both for control words that take an argument and
4200 % those that do not. If it is followed by {arg} in the input, then
4201 % that will dutifully get written to the index (or wherever).
4203 \def\definedummyword ##1{\def##1{\string##1\space}}%
4204 \def\definedummyletter##1{\def##1{\string##1}}%
4205 \let\definedummyaccent\definedummyletter
4207 \commondummiesnofonts
4209 \definedummyletter\_%
4211 % Non-English letters.
4222 \definedummyword\exclamdown
4226 \definedummyword\ordf
4227 \definedummyword\ordm
4228 \definedummyword\questiondown
4232 % Although these internal commands shouldn't show up, sometimes they do.
4234 \definedummyword\gtr
4235 \definedummyword\hat
4236 \definedummyword\less
4239 \definedummyword\tclose
4242 \definedummyword\LaTeX
4243 \definedummyword\TeX
4245 % Assorted special characters.
4246 \definedummyword\bullet
4247 \definedummyword\comma
4248 \definedummyword\copyright
4249 \definedummyword\registeredsymbol
4250 \definedummyword\dots
4251 \definedummyword\enddots
4252 \definedummyword\equiv
4253 \definedummyword\error
4254 \definedummyword\euro
4255 \definedummyword\guillemetleft
4256 \definedummyword\guillemetright
4257 \definedummyword\guilsinglleft
4258 \definedummyword\guilsinglright
4259 \definedummyword\expansion
4260 \definedummyword\minus
4261 \definedummyword\ogonek
4262 \definedummyword\pounds
4263 \definedummyword\point
4264 \definedummyword\print
4265 \definedummyword\quotedblbase
4266 \definedummyword\quotedblleft
4267 \definedummyword\quotedblright
4268 \definedummyword\quoteleft
4269 \definedummyword\quoteright
4270 \definedummyword\quotesinglbase
4271 \definedummyword\result
4272 \definedummyword\textdegree
4274 % We want to disable all macros so that they are not expanded by \write.
4277 \normalturnoffactive
4279 % Handle some cases of @value -- where it does not contain any
4280 % (non-fully-expandable) commands.
4281 \makevalueexpandable
4284 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4286 \def\commondummiesnofonts{%
4287 % Control letters and accents.
4288 \definedummyletter\!%
4289 \definedummyaccent\"%
4290 \definedummyaccent\'%
4291 \definedummyletter\*%
4292 \definedummyaccent\,%
4293 \definedummyletter\.%
4294 \definedummyletter\/%
4295 \definedummyletter\:%
4296 \definedummyaccent\=%
4297 \definedummyletter\?%
4298 \definedummyaccent\^%
4299 \definedummyaccent\`%
4300 \definedummyaccent\~%
4304 \definedummyword\dotaccent
4305 \definedummyword\ogonek
4306 \definedummyword\ringaccent
4307 \definedummyword\tieaccent
4308 \definedummyword\ubaraccent
4309 \definedummyword\udotaccent
4310 \definedummyword\dotless
4312 % Texinfo font commands.
4319 % Commands that take arguments.
4320 \definedummyword\acronym
4321 \definedummyword\cite
4322 \definedummyword\code
4323 \definedummyword\command
4324 \definedummyword\dfn
4325 \definedummyword\emph
4326 \definedummyword\env
4327 \definedummyword\file
4328 \definedummyword\kbd
4329 \definedummyword\key
4330 \definedummyword\math
4331 \definedummyword\option
4332 \definedummyword\pxref
4333 \definedummyword\ref
4334 \definedummyword\samp
4335 \definedummyword\strong
4336 \definedummyword\tie
4337 \definedummyword\uref
4338 \definedummyword\url
4339 \definedummyword\var
4340 \definedummyword\verb
4342 \definedummyword\xref
4345 % \indexnofonts is used when outputting the strings to sort the index
4346 % by, and when constructing control sequence names. It eliminates all
4347 % control sequences and just writes whatever the best ASCII sort string
4348 % would be for a given command (usually its argument).
4351 % Accent commands should become @asis.
4352 \def\definedummyaccent##1{\let##1\asis}%
4353 % We can just ignore other control letters.
4354 \def\definedummyletter##1{\let##1\empty}%
4355 % Hopefully, all control words can become @asis.
4356 \let\definedummyword\definedummyaccent
4358 \commondummiesnofonts
4360 % Don't no-op \tt, since it isn't a user-level command
4361 % and is used in the definitions of the active chars like <, >, |, etc.
4362 % Likewise with the other plain tex font commands.
4367 % how to handle braces?
4368 \def\_{\normalunderscore}%
4370 % Non-English letters.
4387 \def\questiondown{?}%
4394 % Assorted special characters.
4395 % (The following {} will end up in the sort string, but that's ok.)
4396 \def\bullet{bullet}%
4398 \def\copyright{copyright}%
4399 \def\registeredsymbol{R}%
4405 \def\guillemetleft{<<}%
4406 \def\guillemetright{>>}%
4407 \def\guilsinglleft{<}%
4408 \def\guilsinglright{>}%
4409 \def\expansion{==>}%
4411 \def\pounds{pounds}%
4414 \def\quotedblbase{"}%
4415 \def\quotedblleft{"}%
4416 \def\quotedblright{"}%
4419 \def\quotesinglbase{,}%
4421 \def\textdegree{degrees}%
4423 % We need to get rid of all macros, leaving only the arguments (if present).
4424 % Of course this is not nearly correct, but it is the best we can do for now.
4425 % makeinfo does not expand macros in the argument to @deffn, which ends up
4426 % writing an index entry, and texindex isn't prepared for an index sort entry
4427 % that starts with \.
4429 % Since macro invocations are followed by braces, we can just redefine them
4430 % to take a single TeX argument. The case of a macro invocation that
4431 % goes to end-of-line is not handled.
4436 \let\indexbackslash=0 %overridden during \printindex.
4437 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4439 % Most index entries go through here, but \dosubind is the general case.
4440 % #1 is the index name, #2 is the entry text.
4441 \def\doind#1#2{\dosubind{#1}{#2}{}}
4443 % Workhorse for all \fooindexes.
4444 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4445 % empty if called from \doind, as we usually are (the main exception
4446 % is with most defuns, which call us directly).
4448 \def\dosubind#1#2#3{%
4451 % Store the main index entry text (including the third arg).
4453 % If third arg is present, precede it with a space.
4455 \ifx\thirdarg\empty \else
4456 \toks0 = \expandafter{\the\toks0 \space #3}%
4459 \edef\writeto{\csname#1indfile\endcsname}%
4461 \safewhatsit\dosubindwrite
4466 % Write the entry in \toks0 to the index file:
4468 \def\dosubindwrite{%
4469 % Put the index entry in the margin if desired.
4470 \ifx\SETmarginindex\relax\else
4471 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4474 % Remember, we are within a group.
4475 \indexdummies % Must do this here, since \bf, etc expand at this stage
4476 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4477 % so it will be output as is; and it will print as backslash.
4479 % Process the index entry with all font commands turned off, to
4480 % get the string to sort by.
4482 \edef\temp{\the\toks0}% need full expansion
4483 \xdef\indexsorttmp{\temp}%
4486 % Set up the complete index entry, with both the sort key and
4487 % the original text, including any font commands. We write
4488 % three arguments to \entry to the .?? file (four in the
4489 % subentry case), texindex reduces to two when writing the .??s
4493 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4498 % Take care of unwanted page breaks/skips around a whatsit:
4500 % If a skip is the last thing on the list now, preserve it
4501 % by backing up by \lastskip, doing the \write, then inserting
4502 % the skip again. Otherwise, the whatsit generated by the
4503 % \write or \pdfdest will make \lastskip zero. The result is that
4504 % sequences like this:
4508 % will have extra space inserted, because the \medbreak in the
4509 % start of the @defun won't see the skip inserted by the @end of
4510 % the previous defun.
4512 % But don't do any of this if we're not in vertical mode. We
4513 % don't want to do a \vskip and prematurely end a paragraph.
4515 % Avoid page breaks due to these extra skips, too.
4517 % But wait, there is a catch there:
4518 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4519 % sufficient for this purpose, as it ignores stretch and shrink parts
4520 % of the skip. The only way seems to be to check the textual
4521 % representation of the skip.
4523 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4524 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4526 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4528 \newskip\whatsitskip
4529 \newcount\whatsitpenalty
4533 \def\safewhatsit#1{%
4537 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4538 \whatsitskip = \lastskip
4539 \edef\lastskipmacro{\the\lastskip}%
4540 \whatsitpenalty = \lastpenalty
4542 % If \lastskip is nonzero, that means the last item was a
4543 % skip. And since a skip is discardable, that means this
4544 % -\whatsitskip glue we're inserting is preceded by a
4545 % non-discardable item, therefore it is not a potential
4546 % breakpoint, therefore no \nobreak needed.
4547 \ifx\lastskipmacro\zeroskipmacro
4554 \ifx\lastskipmacro\zeroskipmacro
4555 % If \lastskip was zero, perhaps the last item was a penalty, and
4556 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4557 % to re-insert the same penalty (values >10000 are used for various
4558 % signals); since we just inserted a non-discardable item, any
4559 % following glue (such as a \parskip) would be a breakpoint. For example:
4561 % @deffn deffn-whatever
4562 % @vindex index-whatever
4564 % would allow a break between the index-whatever whatsit
4565 % and the "Description." paragraph.
4566 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4568 % On the other hand, if we had a nonzero \lastskip,
4569 % this make-up glue would be preceded by a non-discardable item
4570 % (the whatsit from the \write), so we must insert a \nobreak.
4571 \nobreak\vskip\whatsitskip
4576 % The index entry written in the file actually looks like
4577 % \entry {sortstring}{page}{topic}
4579 % \entry {sortstring}{page}{topic}{subtopic}
4580 % The texindex program reads in these files and writes files
4581 % containing these kinds of lines:
4583 % before the first topic whose initial is c
4584 % \entry {topic}{pagelist}
4585 % for a topic that is used without subtopics
4587 % for the beginning of a topic that is used with subtopics
4588 % \secondary {subtopic}{pagelist}
4589 % for each subtopic.
4591 % Define the user-accessible indexing commands
4592 % @findex, @vindex, @kindex, @cindex.
4594 \def\findex {\fnindex}
4595 \def\kindex {\kyindex}
4596 \def\cindex {\cpindex}
4597 \def\vindex {\vrindex}
4598 \def\tindex {\tpindex}
4599 \def\pindex {\pgindex}
4601 \def\cindexsub {\begingroup\obeylines\cindexsub}
4603 \gdef\cindexsub "#1" #2^^M{\endgroup %
4604 \dosubind{cp}{#2}{#1}}}
4606 % Define the macros used in formatting output of the sorted index material.
4608 % @printindex causes a particular index (the ??s file) to get printed.
4609 % It does not print any chapter heading (usually an @unnumbered).
4611 \parseargdef\printindex{\begingroup
4612 \dobreak \chapheadingskip{10000}%
4617 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4619 % See if the index file exists and is nonempty.
4620 % Change catcode of @ here so that if the index file contains
4622 % as its first line, TeX doesn't complain about mismatched braces
4623 % (because it thinks @} is a control sequence).
4625 \openin 1 \jobname.#1s
4627 % \enddoublecolumns gets confused if there is no text in the index,
4628 % and it loses the chapter title and the aux file entries for the
4629 % index. The easiest way to prevent this problem is to make sure
4630 % there is some text.
4631 \putwordIndexNonexistent
4634 % If the index file exists but is empty, then \openin leaves \ifeof
4635 % false. We have to make TeX try to read something from the file, so
4636 % it can discover if there is anything in it.
4639 \putwordIndexIsEmpty
4641 % Index files are almost Texinfo source, but we use \ as the escape
4642 % character. It would be better to use @, but that's too big a change
4643 % to make right now.
4644 \def\indexbackslash{\backslashcurfont}%
4655 % These macros are used by the sorted index file itself.
4656 % Change them to control the appearance of the index.
4659 % Some minor font changes for the special characters.
4660 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4662 % Remove any glue we may have, we'll be inserting our own.
4665 % We like breaks before the index initials, so insert a bonus.
4667 \vskip 0pt plus 3\baselineskip
4669 \vskip 0pt plus -3\baselineskip
4671 % Typeset the initial. Making this add up to a whole number of
4672 % baselineskips increases the chance of the dots lining up from column
4673 % to column. It still won't often be perfect, because of the stretch
4674 % we need before each entry, but it's better.
4676 % No shrink because it confuses \balancecolumns.
4677 \vskip 1.67\baselineskip plus .5\baselineskip
4678 \leftline{\secbf #1}%
4679 % Do our best not to break after the initial.
4681 \vskip .33\baselineskip plus .1\baselineskip
4684 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4685 % then page number (#2) flushed to the right margin. It is used for index
4686 % and table of contents entries. The paragraph is indented by \leftskip.
4688 % A straightforward implementation would start like this:
4689 % \def\entry#1#2{...
4690 % But this freezes the catcodes in the argument, and can cause problems to
4691 % @code, which sets - active. This problem was fixed by a kludge---
4692 % ``-'' was active throughout whole index, but this isn't really right.
4694 % The right solution is to prevent \entry from swallowing the whole text.
4699 % Start a new paragraph if necessary, so our assignments below can't
4700 % affect previous text.
4703 % Do not fill out the last line with white space.
4706 % No extra space above this paragraph.
4709 % Do not prefer a separate line ending with a hyphen to fewer lines.
4710 \finalhyphendemerits = 0
4712 % \hangindent is only relevant when the entry text and page number
4713 % don't both fit on one line. In that case, bob suggests starting the
4714 % dots pretty far over on the line. Unfortunately, a large
4715 % indentation looks wrong when the entry text itself is broken across
4716 % lines. So we use a small indentation and put up with long leaders.
4718 % \hangafter is reset to 1 (which is the value we want) at the start
4719 % of each paragraph, so we need not do anything with that.
4722 % When the entry text needs to be broken, just fill out the first line
4724 \rightskip = 0pt plus1fil
4726 % A bit of stretch before each entry for the benefit of balancing
4730 % Swallow the left brace of the text (first parameter):
4731 \afterassignment\doentry
4735 \bgroup % Instead of the swallowed brace.
4737 \aftergroup\finishentry
4738 % And now comes the text of the entry.
4740 \def\finishentry#1{%
4741 % #1 is the page number.
4743 % The following is kludged to not output a line of dots in the index if
4744 % there are no page numbers. The next person who breaks this will be
4745 % cursed by a Unix daemon.
4746 \setbox\boxA = \hbox{#1}%
4747 \ifdim\wd\boxA = 0pt
4751 % If we must, put the page number on a line of its own, and fill out
4752 % this line with blank space. (The \hfil is overwhelmed with the
4753 % fill leaders glue in \indexdotfill if the page number does fit.)
4755 \null\nobreak\indexdotfill % Have leaders before the page number.
4757 % The `\ ' here is removed by the implicit \unskip that TeX does as
4758 % part of (the primitive) \par. Without it, a spurious underfull
4771 % Like plain.tex's \dotfill, except uses up at least 1 em.
4772 \def\indexdotfill{\cleaders
4773 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4775 \def\primary #1{\line{#1\hfil}}
4777 \newskip\secondaryindent \secondaryindent=0.5cm
4778 \def\secondary#1#2{{%
4783 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4785 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4792 % Define two-column mode, which we use to typeset indexes.
4793 % Adapted from the TeXbook, page 416, which is to say,
4794 % the manmac.tex format used to print the TeXbook itself.
4798 \newdimen\doublecolumnhsize
4800 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4801 % Grab any single-column material above us.
4804 % Here is a possibility not foreseen in manmac: if we accumulate a
4805 % whole lot of material, we might end up calling this \output
4806 % routine twice in a row (see the doublecol-lose test, which is
4807 % essentially a couple of indexes with @setchapternewpage off). In
4808 % that case we just ship out what is in \partialpage with the normal
4809 % output routine. Generally, \partialpage will be empty when this
4810 % runs and this will be a no-op. See the indexspread.tex test case.
4811 \ifvoid\partialpage \else
4812 \onepageout{\pagecontents\partialpage}%
4815 \global\setbox\partialpage = \vbox{%
4816 % Unvbox the main output page.
4818 \kern-\topskip \kern\baselineskip
4821 \eject % run that output routine to set \partialpage
4823 % Use the double-column output routine for subsequent pages.
4824 \output = {\doublecolumnout}%
4826 % Change the page size parameters. We could do this once outside this
4827 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4828 % format, but then we repeat the same computation. Repeating a couple
4829 % of assignments once per index is clearly meaningless for the
4830 % execution time, so we may as well do it in one place.
4832 % First we halve the line length, less a little for the gutter between
4833 % the columns. We compute the gutter based on the line length, so it
4834 % changes automatically with the paper format. The magic constant
4835 % below is chosen so that the gutter has the same value (well, +-<1pt)
4836 % as it did when we hard-coded it.
4838 % We put the result in a separate register, \doublecolumhsize, so we
4839 % can restore it in \pagesofar, after \hsize itself has (potentially)
4842 \doublecolumnhsize = \hsize
4843 \advance\doublecolumnhsize by -.04154\hsize
4844 \divide\doublecolumnhsize by 2
4845 \hsize = \doublecolumnhsize
4847 % Double the \vsize as well. (We don't need a separate register here,
4848 % since nobody clobbers \vsize.)
4852 % The double-column output routine for all double-column pages except
4855 \def\doublecolumnout{%
4856 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4857 % Get the available space for the double columns -- the normal
4858 % (undoubled) page height minus any material left over from the
4862 \advance\dimen@ by -\ht\partialpage
4864 % box0 will be the left-hand column, box2 the right.
4865 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4866 \onepageout\pagesofar
4868 \penalty\outputpenalty
4871 % Re-output the contents of the output page -- any previous material,
4872 % followed by the two boxes we just split, in box0 and box2.
4876 \hsize = \doublecolumnhsize
4877 \wd0=\hsize \wd2=\hsize
4878 \hbox to\pagewidth{\box0\hfil\box2}%
4881 % All done with double columns.
4882 \def\enddoublecolumns{%
4883 % The following penalty ensures that the page builder is exercised
4884 % _before_ we change the output routine. This is necessary in the
4885 % following situation:
4887 % The last section of the index consists only of a single entry.
4888 % Before this section, \pagetotal is less than \pagegoal, so no
4889 % break occurs before the last section starts. However, the last
4890 % section, consisting of \initial and the single \entry, does not
4891 % fit on the page and has to be broken off. Without the following
4892 % penalty the page builder will not be exercised until \eject
4893 % below, and by that time we'll already have changed the output
4894 % routine to the \balancecolumns version, so the next-to-last
4895 % double-column page will be processed with \balancecolumns, which
4896 % is wrong: The two columns will go to the main vertical list, with
4897 % the broken-off section in the recent contributions. As soon as
4898 % the output routine finishes, TeX starts reconsidering the page
4899 % break. The two columns and the broken-off section both fit on the
4900 % page, because the two columns now take up only half of the page
4901 % goal. When TeX sees \eject from below which follows the final
4902 % section, it invokes the new output routine that we've set after
4903 % \balancecolumns below; \onepageout will try to fit the two columns
4904 % and the final section into the vbox of \pageheight (see
4905 % \pagebody), causing an overfull box.
4907 % Note that glue won't work here, because glue does not exercise the
4908 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4912 % Split the last of the double-column material. Leave it on the
4913 % current page, no automatic page break.
4916 % If we end up splitting too much material for the current page,
4917 % though, there will be another page break right after this \output
4918 % invocation ends. Having called \balancecolumns once, we do not
4919 % want to call it again. Therefore, reset \output to its normal
4920 % definition right away. (We hope \balancecolumns will never be
4921 % called on to balance too much material, but if it is, this makes
4922 % the output somewhat more palatable.)
4923 \global\output = {\onepageout{\pagecontents\PAGE}}%
4926 \endgroup % started in \begindoublecolumns
4928 % \pagegoal was set to the doubled \vsize above, since we restarted
4929 % the current page. We're now back to normal single-column
4930 % typesetting, so reset \pagegoal to the normal \vsize (after the
4931 % \endgroup where \vsize got restored).
4935 % Called at the end of the double column material.
4936 \def\balancecolumns{%
4937 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4939 \advance\dimen@ by \topskip
4940 \advance\dimen@ by-\baselineskip
4941 \divide\dimen@ by 2 % target to split to
4942 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4943 \splittopskip = \topskip
4944 % Loop until we get a decent breakpoint.
4948 \global\setbox3 = \copy0
4949 \global\setbox1 = \vsplit3 to \dimen@
4951 \global\advance\dimen@ by 1pt
4954 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4955 \setbox0=\vbox to\dimen@{\unvbox1}%
4956 \setbox2=\vbox to\dimen@{\unvbox3}%
4960 \catcode`\@ = \other
4963 \message{sectioning,}
4964 % Chapters, sections, etc.
4966 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4967 % sections so that we can refer to them unambiguously in the pdf
4968 % outlines by their "section number". We avoid collisions with chapter
4969 % numbers by starting them at 10000. (If a document ever has 10000
4970 % chapters, we're in trouble anyway, I'm sure.)
4971 \newcount\unnumberedno \unnumberedno = 10000
4973 \newcount\secno \secno=0
4974 \newcount\subsecno \subsecno=0
4975 \newcount\subsubsecno \subsubsecno=0
4977 % This counter is funny since it counts through charcodes of letters A, B, ...
4978 \newcount\appendixno \appendixno = `\@
4980 % \def\appendixletter{\char\the\appendixno}
4981 % We do the following ugly conditional instead of the above simple
4982 % construct for the sake of pdftex, which needs the actual
4983 % letter in the expansion, not just typeset.
4985 \def\appendixletter{%
4986 \ifnum\appendixno=`A A%
4987 \else\ifnum\appendixno=`B B%
4988 \else\ifnum\appendixno=`C C%
4989 \else\ifnum\appendixno=`D D%
4990 \else\ifnum\appendixno=`E E%
4991 \else\ifnum\appendixno=`F F%
4992 \else\ifnum\appendixno=`G G%
4993 \else\ifnum\appendixno=`H H%
4994 \else\ifnum\appendixno=`I I%
4995 \else\ifnum\appendixno=`J J%
4996 \else\ifnum\appendixno=`K K%
4997 \else\ifnum\appendixno=`L L%
4998 \else\ifnum\appendixno=`M M%
4999 \else\ifnum\appendixno=`N N%
5000 \else\ifnum\appendixno=`O O%
5001 \else\ifnum\appendixno=`P P%
5002 \else\ifnum\appendixno=`Q Q%
5003 \else\ifnum\appendixno=`R R%
5004 \else\ifnum\appendixno=`S S%
5005 \else\ifnum\appendixno=`T T%
5006 \else\ifnum\appendixno=`U U%
5007 \else\ifnum\appendixno=`V V%
5008 \else\ifnum\appendixno=`W W%
5009 \else\ifnum\appendixno=`X X%
5010 \else\ifnum\appendixno=`Y Y%
5011 \else\ifnum\appendixno=`Z Z%
5012 % The \the is necessary, despite appearances, because \appendixletter is
5013 % expanded while writing the .toc file. \char\appendixno is not
5014 % expandable, thus it is written literally, thus all appendixes come out
5015 % with the same letter (or @) in the toc without it.
5016 \else\char\the\appendixno
5017 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5018 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5020 % Each @chapter defines these (using marks) as the number+name, number
5021 % and name of the chapter. Page headings and footings can use
5022 % these. @section does likewise.
5024 \def\thischapternum{}
5025 \def\thischaptername{}
5027 \def\thissectionnum{}
5028 \def\thissectionname{}
5030 \newcount\absseclevel % used to calculate proper heading level
5031 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5033 % @raisesections: treat @section as chapter, @subsection as section, etc.
5034 \def\raisesections{\global\advance\secbase by -1}
5035 \let\up=\raisesections % original BFox name
5037 % @lowersections: treat @chapter as section, @section as subsection, etc.
5038 \def\lowersections{\global\advance\secbase by 1}
5039 \let\down=\lowersections % original BFox name
5041 % we only have subsub.
5042 \chardef\maxseclevel = 3
5044 % A numbered section within an unnumbered changes to unnumbered too.
5045 % To achive this, remember the "biggest" unnum. sec. we are currently in:
5046 \chardef\unmlevel = \maxseclevel
5048 % Trace whether the current chapter is an appendix or not:
5049 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5050 \def\chapheadtype{N}
5052 % Choose a heading macro
5053 % #1 is heading type
5054 % #2 is heading level
5055 % #3 is text for heading
5056 \def\genhead#1#2#3{%
5057 % Compute the abs. sec. level:
5059 \advance\absseclevel by \secbase
5060 % Make sure \absseclevel doesn't fall outside the range:
5061 \ifnum \absseclevel < 0
5064 \ifnum \absseclevel > 3
5071 \ifnum \absseclevel < \unmlevel
5072 \chardef\unmlevel = \absseclevel
5075 % Check for appendix sections:
5076 \ifnum \absseclevel = 0
5077 \edef\chapheadtype{\headtype}%
5079 \if \headtype A\if \chapheadtype N%
5080 \errmessage{@appendix... within a non-appendix chapter}%
5083 % Check for numbered within unnumbered:
5084 \ifnum \absseclevel > \unmlevel
5087 \chardef\unmlevel = 3
5090 % Now print the heading:
5094 \or \unnumberedseczzz{#3}%
5095 \or \unnumberedsubseczzz{#3}%
5096 \or \unnumberedsubsubseczzz{#3}%
5102 \or \appendixsectionzzz{#3}%
5103 \or \appendixsubseczzz{#3}%
5104 \or \appendixsubsubseczzz{#3}%
5110 \or \numberedsubseczzz{#3}%
5111 \or \numberedsubsubseczzz{#3}%
5115 \suppressfirstparagraphindent
5119 \def\numhead{\genhead N}
5120 \def\apphead{\genhead A}
5121 \def\unnmhead{\genhead U}
5123 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5124 % all lower-level sectioning counters to zero.
5126 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5127 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5128 \let\chaplevelprefix = \empty
5130 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5132 % section resetting is \global in case the chapter is in a group, such
5133 % as an @include file.
5134 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5135 \global\advance\chapno by 1
5138 \gdef\chaplevelprefix{\the\chapno.}%
5141 \message{\putwordChapter\space \the\chapno}%
5143 % Write the actual heading.
5144 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5146 % So @section and the like are numbered underneath this chapter.
5147 \global\let\section = \numberedsec
5148 \global\let\subsection = \numberedsubsec
5149 \global\let\subsubsection = \numberedsubsubsec
5152 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5154 \def\appendixzzz#1{%
5155 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5156 \global\advance\appendixno by 1
5157 \gdef\chaplevelprefix{\appendixletter.}%
5160 \def\appendixnum{\putwordAppendix\space \appendixletter}%
5161 \message{\appendixnum}%
5163 \chapmacro{#1}{Yappendix}{\appendixletter}%
5165 \global\let\section = \appendixsec
5166 \global\let\subsection = \appendixsubsec
5167 \global\let\subsubsection = \appendixsubsubsec
5170 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5171 \def\unnumberedzzz#1{%
5172 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5173 \global\advance\unnumberedno by 1
5175 % Since an unnumbered has no number, no prefix for figures.
5176 \global\let\chaplevelprefix = \empty
5179 % This used to be simply \message{#1}, but TeX fully expands the
5180 % argument to \message. Therefore, if #1 contained @-commands, TeX
5181 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5182 % expanded @cite (which turns out to cause errors because \cite is meant
5183 % to be executed, not expanded).
5185 % Anyway, we don't want the fully-expanded definition of @cite to appear
5186 % as a result of the \message, we just want `@cite' itself. We use
5187 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5188 % simply yielding the contents of <toks register>. (We also do this for
5191 \message{(\the\toks0)}%
5193 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5195 \global\let\section = \unnumberedsec
5196 \global\let\subsection = \unnumberedsubsec
5197 \global\let\subsubsection = \unnumberedsubsubsec
5200 % @centerchap is like @unnumbered, but the heading is centered.
5201 \outer\parseargdef\centerchap{%
5202 % Well, we could do the following in a group, but that would break
5203 % an assumption that \chapmacro is called at the outermost level.
5204 % Thus we are safer this way: --kasal, 24feb04
5205 \let\centerparametersmaybe = \centerparameters
5207 \let\centerparametersmaybe = \relax
5210 % @top is like @unnumbered.
5214 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5216 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5217 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5220 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5221 \def\appendixsectionzzz#1{%
5222 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5223 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5225 \let\appendixsec\appendixsection
5227 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5228 \def\unnumberedseczzz#1{%
5229 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5230 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5234 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5235 \def\numberedsubseczzz#1{%
5236 \global\subsubsecno=0 \global\advance\subsecno by 1
5237 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5240 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5241 \def\appendixsubseczzz#1{%
5242 \global\subsubsecno=0 \global\advance\subsecno by 1
5243 \sectionheading{#1}{subsec}{Yappendix}%
5244 {\appendixletter.\the\secno.\the\subsecno}%
5247 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5248 \def\unnumberedsubseczzz#1{%
5249 \global\subsubsecno=0 \global\advance\subsecno by 1
5250 \sectionheading{#1}{subsec}{Ynothing}%
5251 {\the\unnumberedno.\the\secno.\the\subsecno}%
5255 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5256 \def\numberedsubsubseczzz#1{%
5257 \global\advance\subsubsecno by 1
5258 \sectionheading{#1}{subsubsec}{Ynumbered}%
5259 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5262 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5263 \def\appendixsubsubseczzz#1{%
5264 \global\advance\subsubsecno by 1
5265 \sectionheading{#1}{subsubsec}{Yappendix}%
5266 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5269 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5270 \def\unnumberedsubsubseczzz#1{%
5271 \global\advance\subsubsecno by 1
5272 \sectionheading{#1}{subsubsec}{Ynothing}%
5273 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5276 % These macros control what the section commands do, according
5277 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5278 % Define them by default for a numbered chapter.
5279 \let\section = \numberedsec
5280 \let\subsection = \numberedsubsec
5281 \let\subsubsection = \numberedsubsubsec
5283 % Define @majorheading, @heading and @subheading
5285 % NOTE on use of \vbox for chapter headings, section headings, and such:
5286 % 1) We use \vbox rather than the earlier \line to permit
5287 % overlong headings to fold.
5288 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5289 % heading is obnoxious; this forbids it.
5290 % 3) Likewise, headings look best if no \parindent is used, and
5291 % if justification is not attempted. Hence \raggedright.
5294 {\advance\chapheadingskip by 10pt \chapbreak }%
5295 \parsearg\chapheadingzzz
5298 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5299 \def\chapheadingzzz#1{%
5300 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5301 \parindent=0pt\ptexraggedright
5302 \rmisbold #1\hfill}}%
5303 \bigskip \par\penalty 200\relax
5304 \suppressfirstparagraphindent
5307 % @heading, @subheading, @subsubheading.
5308 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5309 \suppressfirstparagraphindent}
5310 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5311 \suppressfirstparagraphindent}
5312 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5313 \suppressfirstparagraphindent}
5315 % These macros generate a chapter, section, etc. heading only
5316 % (including whitespace, linebreaking, etc. around it),
5317 % given all the information in convenient, parsed form.
5319 %%% Args are the skip and penalty (usually negative)
5320 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5322 %%% Define plain chapter starts, and page on/off switching for it
5323 % Parameter controlling skip before chapter headings (if needed)
5325 \newskip\chapheadingskip
5327 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5328 \def\chappager{\par\vfill\supereject}
5329 % Because \domark is called before \chapoddpage, the filler page will
5330 % get the headings for the next chapter, which is wrong. But we don't
5331 % care -- we just disable all headings on the filler page.
5336 \evenheadline={\hfil}\evenfootline={\hfil}%
5337 \oddheadline={\hfil}\oddfootline={\hfil}%
5344 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5347 \global\let\contentsalignmacro = \chappager
5348 \global\let\pchapsepmacro=\chapbreak
5349 \global\let\pagealignmacro=\chappager}
5352 \global\let\contentsalignmacro = \chappager
5353 \global\let\pchapsepmacro=\chappager
5354 \global\let\pagealignmacro=\chappager
5355 \global\def\HEADINGSon{\HEADINGSsingle}}
5358 \global\let\contentsalignmacro = \chapoddpage
5359 \global\let\pchapsepmacro=\chapoddpage
5360 \global\let\pagealignmacro=\chapoddpage
5361 \global\def\HEADINGSon{\HEADINGSdouble}}
5367 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5368 % Yappendix, Yomitfromtoc), #3 the chapter number.
5370 % To test against our argument.
5371 \def\Ynothingkeyword{Ynothing}
5372 \def\Yomitfromtockeyword{Yomitfromtoc}
5373 \def\Yappendixkeyword{Yappendix}
5375 \def\chapmacro#1#2#3{%
5376 % Insert the first mark before the heading break (see notes for \domark).
5377 \let\prevchapterdefs=\lastchapterdefs
5378 \let\prevsectiondefs=\lastsectiondefs
5379 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5380 \gdef\thissection{}}%
5383 \ifx\temptype\Ynothingkeyword
5384 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5385 \gdef\thischapter{\thischaptername}}%
5386 \else\ifx\temptype\Yomitfromtockeyword
5387 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5388 \gdef\thischapter{}}%
5389 \else\ifx\temptype\Yappendixkeyword
5391 \xdef\lastchapterdefs{%
5392 \gdef\noexpand\thischaptername{\the\toks0}%
5393 \gdef\noexpand\thischapternum{\appendixletter}%
5394 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5395 \noexpand\thischaptername}%
5399 \xdef\lastchapterdefs{%
5400 \gdef\noexpand\thischaptername{\the\toks0}%
5401 \gdef\noexpand\thischapternum{\the\chapno}%
5402 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5403 \noexpand\thischaptername}%
5407 % Output the mark. Pass it through \safewhatsit, to take care of
5408 % the preceding space.
5411 % Insert the chapter heading break.
5414 % Now the second mark, after the heading break. No break points
5415 % between here and the heading.
5416 \let\prevchapterdefs=\lastchapterdefs
5417 \let\prevsectiondefs=\lastsectiondefs
5421 \chapfonts \rmisbold
5423 % Have to define \lastsection before calling \donoderef, because the
5424 % xref code eventually uses it. On the other hand, it has to be called
5425 % after \pchapsepmacro, or the headline will change too soon.
5426 \gdef\lastsection{#1}%
5428 % Only insert the separating space if we have a chapter/appendix
5429 % number, and don't print the unnumbered ``number''.
5430 \ifx\temptype\Ynothingkeyword
5432 \def\toctype{unnchap}%
5433 \else\ifx\temptype\Yomitfromtockeyword
5434 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5436 \else\ifx\temptype\Yappendixkeyword
5437 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5440 \setbox0 = \hbox{#3\enspace}%
5441 \def\toctype{numchap}%
5444 % Write the toc entry for this chapter. Must come before the
5445 % \donoderef, because we include the current node name in the toc
5446 % entry, and \donoderef resets it to empty.
5447 \writetocentry{\toctype}{#1}{#3}%
5449 % For pdftex, we have to write out the node definition (aka, make
5450 % the pdfdest) after any page break, but before the actual text has
5451 % been typeset. If the destination for the pdf outline is after the
5452 % text, then jumping from the outline may wind up with the text not
5453 % being visible, for instance under high magnification.
5456 % Typeset the actual heading.
5457 \nobreak % Avoid page breaks at the interline glue.
5458 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5459 \hangindent=\wd0 \centerparametersmaybe
5462 \nobreak\bigskip % no page break after a chapter title
5466 % @centerchap -- centered and unnumbered.
5467 \let\centerparametersmaybe = \relax
5468 \def\centerparameters{%
5469 \advance\rightskip by 3\rightskip
5470 \leftskip = \rightskip
5475 % I don't think this chapter style is supported any more, so I'm not
5476 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5478 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5480 \def\unnchfopen #1{%
5481 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5482 \parindent=0pt\ptexraggedright
5483 \rmisbold #1\hfill}}\bigskip \par\nobreak
5485 \def\chfopen #1#2{\chapoddpage {\chapfonts
5486 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5489 \def\centerchfopen #1{%
5490 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5492 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5495 \global\let\chapmacro=\chfopen
5496 \global\let\centerchapmacro=\centerchfopen}
5499 % Section titles. These macros combine the section number parts and
5500 % call the generic \sectionheading to do the printing.
5502 \newskip\secheadingskip
5503 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5505 % Subsection titles.
5506 \newskip\subsecheadingskip
5507 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5509 % Subsubsection titles.
5510 \def\subsubsecheadingskip{\subsecheadingskip}
5511 \def\subsubsecheadingbreak{\subsecheadingbreak}
5514 % Print any size, any type, section title.
5516 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5517 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5520 \def\seckeyword{sec}
5522 \def\sectionheading#1#2#3#4{%
5524 % Switch to the right set of fonts.
5525 \csname #2fonts\endcsname \rmisbold
5527 \def\sectionlevel{#2}%
5530 % Insert first mark before the heading break (see notes for \domark).
5531 \let\prevsectiondefs=\lastsectiondefs
5532 \ifx\temptype\Ynothingkeyword
5533 \ifx\sectionlevel\seckeyword
5534 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5535 \gdef\thissection{\thissectionname}}%
5537 \else\ifx\temptype\Yomitfromtockeyword
5538 % Don't redefine \thissection.
5539 \else\ifx\temptype\Yappendixkeyword
5540 \ifx\sectionlevel\seckeyword
5542 \xdef\lastsectiondefs{%
5543 \gdef\noexpand\thissectionname{\the\toks0}%
5544 \gdef\noexpand\thissectionnum{#4}%
5545 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5546 \noexpand\thissectionname}%
5550 \ifx\sectionlevel\seckeyword
5552 \xdef\lastsectiondefs{%
5553 \gdef\noexpand\thissectionname{\the\toks0}%
5554 \gdef\noexpand\thissectionnum{#4}%
5555 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5556 \noexpand\thissectionname}%
5561 % Go into vertical mode. Usually we'll already be there, but we
5562 % don't want the following whatsit to end up in a preceding paragraph
5563 % if the document didn't happen to have a blank line.
5566 % Output the mark. Pass it through \safewhatsit, to take care of
5567 % the preceding space.
5570 % Insert space above the heading.
5571 \csname #2headingbreak\endcsname
5573 % Now the second mark, after the heading break. No break points
5574 % between here and the heading.
5575 \let\prevsectiondefs=\lastsectiondefs
5578 % Only insert the space after the number if we have a section number.
5579 \ifx\temptype\Ynothingkeyword
5582 \gdef\lastsection{#1}%
5583 \else\ifx\temptype\Yomitfromtockeyword
5584 % for @headings -- no section number, don't include in toc,
5585 % and don't redefine \lastsection.
5588 \let\sectionlevel=\empty
5589 \else\ifx\temptype\Yappendixkeyword
5590 \setbox0 = \hbox{#4\enspace}%
5592 \gdef\lastsection{#1}%
5594 \setbox0 = \hbox{#4\enspace}%
5596 \gdef\lastsection{#1}%
5599 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5600 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5602 % Write the node reference (= pdf destination for pdftex).
5603 % Again, see comments in \chapmacro.
5606 % Interline glue will be inserted when the vbox is completed.
5607 % That glue will be a valid breakpoint for the page, since it'll be
5608 % preceded by a whatsit (usually from the \donoderef, or from the
5609 % \writetocentry if there was no node). We don't want to allow that
5610 % break, since then the whatsits could end up on page n while the
5611 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5614 % Output the actual section heading.
5615 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5616 \hangindent=\wd0 % zero if no section number
5619 % Add extra space after the heading -- half of whatever came above it.
5620 % Don't allow stretch, though.
5621 \kern .5 \csname #2headingskip\endcsname
5623 % Do not let the kern be a potential breakpoint, as it would be if it
5624 % was followed by glue.
5627 % We'll almost certainly start a paragraph next, so don't let that
5628 % glue accumulate. (Not a breakpoint because it's preceded by a
5629 % discardable item.)
5632 % This is purely so the last item on the list is a known \penalty >
5633 % 10000. This is so \startdefun can avoid allowing breakpoints after
5634 % section headings. Otherwise, it would insert a valid breakpoint between:
5636 % @section sec-whatever
5637 % @deffn def-whatever
5643 % Table of contents.
5646 % Write an entry to the toc file, opening it if necessary.
5647 % Called from @chapter, etc.
5649 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5650 % We append the current node name (if any) and page number as additional
5651 % arguments for the \{chap,sec,...}entry macros which will eventually
5652 % read this. The node name is used in the pdf outlines as the
5653 % destination to jump to.
5655 % We open the .toc file for writing here instead of at @setfilename (or
5656 % any other fixed time) so that @contents can be anywhere in the document.
5657 % But if #1 is `omit', then we don't do anything. This is used for the
5658 % table of contents chapter openings themselves.
5660 \newif\iftocfileopened
5661 \def\omitkeyword{omit}%
5663 \def\writetocentry#1#2#3{%
5664 \edef\writetoctype{#1}%
5665 \ifx\writetoctype\omitkeyword \else
5666 \iftocfileopened\else
5667 \immediate\openout\tocfile = \jobname.toc
5668 \global\tocfileopenedtrue
5674 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5680 % Tell \shipout to create a pdf destination on each page, if we're
5681 % writing pdf. These are used in the table of contents. We can't
5682 % just write one on every page because the title pages are numbered
5683 % 1 and 2 (the page numbers aren't printed), and so are the first
5684 % two pages of the document. Thus, we'd have two destinations named
5685 % `1', and two named `2'.
5686 \ifpdf \global\pdfmakepagedesttrue \fi
5690 % These characters do not print properly in the Computer Modern roman
5691 % fonts, so we must take special care. This is more or less redundant
5692 % with the Texinfo input format setup at the end of this file.
5694 \def\activecatcodes{%
5707 % Read the toc file, which is essentially Texinfo input.
5711 \input \tocreadfilename
5714 \newskip\contentsrightmargin \contentsrightmargin=1in
5715 \newcount\savepageno
5716 \newcount\lastnegativepageno \lastnegativepageno = -1
5718 % Prepare to read what we've written to \tocfile.
5720 \def\startcontents#1{%
5721 % If @setchapternewpage on, and @headings double, the contents should
5722 % start on an odd page, unlike chapters. Thus, we maintain
5723 % \contentsalignmacro in parallel with \pagealignmacro.
5724 % From: Torbjorn Granlund <tege@matematik.su.se>
5726 \immediate\closeout\tocfile
5728 % Don't need to put `Contents' or `Short Contents' in the headline.
5729 % It is abundantly clear what they are.
5730 \chapmacro{#1}{Yomitfromtoc}{}%
5732 \savepageno = \pageno
5733 \begingroup % Set up to handle contents files properly.
5734 \raggedbottom % Worry more about breakpoints than the bottom.
5735 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5737 % Roman numerals for page numbers.
5738 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5741 % redefined for the two-volume lispref. We always output on
5742 % \jobname.toc even if this is redefined.
5744 \def\tocreadfilename{\jobname.toc}
5746 % Normal (long) toc.
5749 \startcontents{\putwordTOC}%
5750 \openin 1 \tocreadfilename\space
5755 \contentsalignmacro % in case @setchapternewpage odd is in effect
5761 \lastnegativepageno = \pageno
5762 \global\pageno = \savepageno
5765 % And just the chapters.
5766 \def\summarycontents{%
5767 \startcontents{\putwordShortTOC}%
5769 \let\numchapentry = \shortchapentry
5770 \let\appentry = \shortchapentry
5771 \let\unnchapentry = \shortunnchapentry
5772 % We want a true roman here for the page numbers.
5774 \let\rm=\shortcontrm \let\bf=\shortcontbf
5775 \let\sl=\shortcontsl \let\tt=\shortconttt
5777 \hyphenpenalty = 10000
5778 \advance\baselineskip by 1pt % Open it up a little.
5779 \def\numsecentry##1##2##3##4{}
5780 \let\appsecentry = \numsecentry
5781 \let\unnsecentry = \numsecentry
5782 \let\numsubsecentry = \numsecentry
5783 \let\appsubsecentry = \numsecentry
5784 \let\unnsubsecentry = \numsecentry
5785 \let\numsubsubsecentry = \numsecentry
5786 \let\appsubsubsecentry = \numsecentry
5787 \let\unnsubsubsecentry = \numsecentry
5788 \openin 1 \tocreadfilename\space
5794 \contentsalignmacro % in case @setchapternewpage odd is in effect
5796 \lastnegativepageno = \pageno
5797 \global\pageno = \savepageno
5799 \let\shortcontents = \summarycontents
5801 % Typeset the label for a chapter or appendix for the short contents.
5802 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5804 \def\shortchaplabel#1{%
5805 % This space should be enough, since a single number is .5em, and the
5806 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5807 % But use \hss just in case.
5808 % (This space doesn't include the extra space that gets added after
5809 % the label; that gets put in by \shortchapentry above.)
5811 % We'd like to right-justify chapter numbers, but that looks strange
5812 % with appendix letters. And right-justifying numbers and
5813 % left-justifying letters looks strange when there is less than 10
5814 % chapters. Have to read the whole toc once to know how many chapters
5815 % there are before deciding ...
5816 \hbox to 1em{#1\hss}%
5819 % These macros generate individual entries in the table of contents.
5820 % The first argument is the chapter or section name.
5821 % The last argument is the page number.
5822 % The arguments in between are the chapter number, section number, ...
5824 % Chapters, in the main contents.
5825 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5827 % Chapters, in the short toc.
5828 % See comments in \dochapentry re vbox and related settings.
5829 \def\shortchapentry#1#2#3#4{%
5830 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5833 % Appendices, in the main contents.
5834 % Need the word Appendix, and a fixed-size box.
5836 \def\appendixbox#1{%
5837 % We use M since it's probably the widest letter.
5838 \setbox0 = \hbox{\putwordAppendix{} M}%
5839 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5841 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5843 % Unnumbered chapters.
5844 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5845 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5848 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5849 \let\appsecentry=\numsecentry
5850 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5853 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5854 \let\appsubsecentry=\numsubsecentry
5855 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5857 % And subsubsections.
5858 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5859 \let\appsubsubsecentry=\numsubsubsecentry
5860 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5862 % This parameter controls the indentation of the various levels.
5863 % Same as \defaultparindent.
5864 \newdimen\tocindent \tocindent = 15pt
5866 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5869 % If the toc has to be broken over pages, we want it to be at chapters
5870 % if at all possible; hence the \penalty.
5871 \def\dochapentry#1#2{%
5872 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5875 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5877 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5880 \def\dosecentry#1#2{\begingroup
5881 \secentryfonts \leftskip=\tocindent
5882 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5885 \def\dosubsecentry#1#2{\begingroup
5886 \subsecentryfonts \leftskip=2\tocindent
5887 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5890 \def\dosubsubsecentry#1#2{\begingroup
5891 \subsubsecentryfonts \leftskip=3\tocindent
5892 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5895 % We use the same \entry macro as for the index entries.
5896 \let\tocentry = \entry
5898 % Space between chapter (or whatever) number and the title.
5899 \def\labelspace{\hskip1em \relax}
5901 \def\dopageno#1{{\rm #1}}
5902 \def\doshortpageno#1{{\rm #1}}
5904 \def\chapentryfonts{\secfonts \rm}
5905 \def\secentryfonts{\textfonts}
5906 \def\subsecentryfonts{\textfonts}
5907 \def\subsubsecentryfonts{\textfonts}
5910 \message{environments,}
5911 % @foo ... @end foo.
5913 % @tex ... @end tex escapes into raw Tex temporarily.
5914 % One exception: @ is still an escape character, so that @end tex works.
5915 % But \@ or @@ will get a plain tex @ character.
5918 \setupmarkupstyle{tex}%
5919 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5920 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5921 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5933 \let\bullet=\ptexbullet
5938 \let\equiv=\ptexequiv
5941 \let\indent=\ptexindent
5942 \let\noindent=\ptexnoindent
5949 \expandafter \let\csname top\endcsname=\ptextop % outer
5950 \let\frenchspacing=\plainfrenchspacing
5952 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5953 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5956 % There is no need to define \Etex.
5958 % Define @lisp ... @end lisp.
5959 % @lisp environment forms a group so it can rebind things,
5960 % including the definition of @end lisp (which normally is erroneous).
5962 % Amount to narrow the margins by for @lisp.
5963 \newskip\lispnarrowing \lispnarrowing=0.4in
5965 % This is the definition that ^^M gets inside @lisp, @example, and other
5966 % such environments. \null is better than a space, since it doesn't
5968 \def\lisppar{\null\endgraf}
5970 % This space is always present above and below environments.
5971 \newskip\envskipamount \envskipamount = 0pt
5973 % Make spacing and below environment symmetrical. We use \parskip here
5974 % to help in doing that, since in @example-like environments \parskip
5975 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5976 % start of the next paragraph will insert \parskip.
5978 \def\aboveenvbreak{{%
5979 % =10000 instead of <10000 because of a special case in \itemzzz and
5980 % \sectionheading, q.v.
5981 \ifnum \lastpenalty=10000 \else
5982 \advance\envskipamount by \parskip
5984 \ifdim\lastskip<\envskipamount
5986 % it's not a good place to break if the last penalty was \nobreak
5988 \ifnum\lastpenalty<10000 \penalty-50 \fi
5989 \vskip\envskipamount
5994 \let\afterenvbreak = \aboveenvbreak
5996 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5997 % also clear it, so that its embedded environments do the narrowing again.
5998 \let\nonarrowing=\relax
6000 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6001 % environment contents.
6002 \font\circle=lcircle10
6004 \newdimen\cartouter\newdimen\cartinner
6005 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6006 \circthick=\fontdimen8\circle
6008 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6009 \def\ctr{{\hskip 6pt\circle\char'010}}
6010 \def\cbl{{\circle\char'012\hskip -6pt}}
6011 \def\cbr{{\hskip 6pt\circle\char'011}}
6012 \def\carttop{\hbox to \cartouter{\hskip\lskip
6013 \ctl\leaders\hrule height\circthick\hfil\ctr
6015 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6016 \cbl\leaders\hrule height\circthick\hfil\cbr
6019 \newskip\lskip\newskip\rskip
6022 \ifhmode\par\fi % can't be in the midst of a paragraph.
6024 \lskip=\leftskip \rskip=\rightskip
6025 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6026 \cartinner=\hsize \advance\cartinner by-\lskip
6027 \advance\cartinner by-\rskip
6029 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6030 % side, and for 6pt waste from
6031 % each corner char, and rule thickness
6032 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6033 % Flag to tell @lisp, etc., not to narrow margin.
6034 \let\nonarrowing = t%
6036 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6044 \baselineskip=\normbskip
6045 \lineskip=\normlskip
6048 \comment % For explanation, see the end of \def\group.
6063 % This macro is called at the beginning of all the @example variants,
6065 \newdimen\nonfillparindent
6068 \hfuzz = 12pt % Don't be fussy
6069 \sepspaces % Make spaces be word-separators rather than space tokens.
6070 \let\par = \lisppar % don't ignore blank lines
6071 \obeylines % each line of input is a line of output
6073 % Turn off paragraph indentation but redefine \indent to emulate
6074 % the normal \indent.
6075 \nonfillparindent=\parindent
6077 \let\indent\nonfillindent
6079 \emergencystretch = 0pt % don't try to avoid overfull boxes
6080 \ifx\nonarrowing\relax
6081 \advance \leftskip by \lispnarrowing
6082 \exdentamount=\lispnarrowing
6084 \let\nonarrowing = \relax
6086 \let\exdent=\nofillexdent
6091 % We want to swallow spaces (but not other tokens) after the fake
6092 % @indent in our nonfill-environments, where spaces are normally
6093 % active and set to @tie, resulting in them not being ignored after
6095 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6096 \gdef\nonfillindentcheck{%
6098 \expandafter\nonfillindentgobble%
6100 \leavevmode\nonfillindentbox%
6104 \def\nonfillindentgobble#1{\nonfillindent}
6105 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6107 % If you want all examples etc. small: @set dispenvsize small.
6108 % If you want even small examples the full size: @set dispenvsize nosmall.
6109 % This affects the following displayed environments:
6110 % @example, @display, @format, @lisp
6112 \def\smallword{small}
6113 \def\nosmallword{nosmall}
6114 \let\SETdispenvsize\relax
6115 \def\setnormaldispenv{%
6116 \ifx\SETdispenvsize\smallword
6117 % end paragraph for sake of leading, in case document has no blank
6118 % line. This is redundant with what happens in \aboveenvbreak, but
6119 % we need to do it before changing the fonts, and it's inconvenient
6120 % to change the fonts afterward.
6121 \ifnum \lastpenalty=10000 \else \endgraf \fi
6122 \smallexamplefonts \rm
6125 \def\setsmalldispenv{%
6126 \ifx\SETdispenvsize\nosmallword
6128 \ifnum \lastpenalty=10000 \else \endgraf \fi
6129 \smallexamplefonts \rm
6133 % We often define two environments, @foo and @smallfoo.
6134 % Let's do it by one command:
6135 \def\makedispenv #1#2{
6136 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
6137 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
6138 \expandafter\let\csname E#1\endcsname \afterenvbreak
6139 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6142 % Define two synonyms:
6143 \def\maketwodispenvs #1#2#3{
6144 \makedispenv{#1}{#3}
6145 \makedispenv{#2}{#3}
6148 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
6150 % @smallexample and @smalllisp: use smaller fonts.
6151 % Originally contributed by Pavel@xerox.
6153 \maketwodispenvs {lisp}{example}{%
6155 \tt\setupmarkupstyle{example}%
6156 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6157 \gobble % eat return
6159 % @display/@smalldisplay: same as @lisp except keep current font.
6161 \makedispenv {display}{%
6166 % @format/@smallformat: same as @display except don't narrow margins.
6168 \makedispenv{format}{%
6169 \let\nonarrowing = t%
6174 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6176 \let\nonarrowing = t%
6180 \let\Eflushleft = \afterenvbreak
6184 \envdef\flushright{%
6185 \let\nonarrowing = t%
6187 \advance\leftskip by 0pt plus 1fill
6190 \let\Eflushright = \afterenvbreak
6193 % @raggedright does more-or-less normal line breaking but no right
6194 % justification. From plain.tex.
6195 \envdef\raggedright{%
6196 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6198 \let\Eraggedright\par
6200 \envdef\raggedleft{%
6201 \parindent=0pt \leftskip0pt plus2em
6202 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6203 \hbadness=10000 % Last line will usually be underfull, so turn off
6204 % badness reporting.
6206 \let\Eraggedleft\par
6208 \envdef\raggedcenter{%
6209 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6210 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6211 \hbadness=10000 % Last line will usually be underfull, so turn off
6212 % badness reporting.
6214 \let\Eraggedcenter\par
6217 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6218 % and narrows the margins. We keep \parskip nonzero in general, since
6219 % we're doing normal filling. So, when using \aboveenvbreak and
6220 % \afterenvbreak, temporarily make \parskip 0.
6222 \def\quotationstart{%
6223 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6226 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6227 \ifx\nonarrowing\relax
6228 \advance\leftskip by \lispnarrowing
6229 \advance\rightskip by \lispnarrowing
6230 \exdentamount = \lispnarrowing
6232 \let\nonarrowing = \relax
6234 \parsearg\quotationlabel
6242 \envdef\smallquotation{%
6246 \let\Esmallquotation = \Equotation
6248 % We have retained a nonzero parskip for the environment, since we're
6249 % doing normal filling.
6253 \ifx\quotationauthor\undefined\else
6255 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6257 {\parskip=0pt \afterenvbreak}%
6260 % If we're given an argument, typeset it in bold with a colon after.
6261 \def\quotationlabel#1{%
6263 \ifx\temp\empty \else
6269 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6270 % If we want to allow any <char> as delimiter,
6271 % we need the curly braces so that makeinfo sees the @verb command, eg:
6272 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6274 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6276 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6277 % active too. Otherwise, they get lost as the first character on a
6280 \do\ \do\\\do\{\do\}\do\$\do\&%
6281 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6282 \do\<\do\>\do\|\do\@\do+\do\"%
6283 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6284 % @set txicodequotebacktick will not have effect on @verb and
6285 % @verbatim, and ?` and !` ligatures won't get disabled.
6290 \def\uncatcodespecials{%
6291 \def\do##1{\catcode`##1=\other}\dospecials}
6293 % Setup for the @verb command.
6295 % Eight spaces for a tab
6297 \catcode`\^^I=\active
6298 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6302 \tt % easiest (and conventionally used) font for verbatim
6303 \def\par{\leavevmode\endgraf}%
6304 \setupmarkupstyle{verb}%
6306 % Respect line breaks,
6307 % print special symbols as themselves, and
6308 % make each space count
6309 % must do in this order:
6310 \obeylines \uncatcodespecials \sepspaces
6313 % Setup for the @verbatim environment
6315 % Real tab expansion
6316 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6318 \def\starttabbox{\setbox0=\hbox\bgroup}
6321 \catcode`\^^I=\active
6323 \catcode`\^^I=\active
6324 \def^^I{\leavevmode\egroup
6325 \dimen0=\wd0 % the width so far, or since the previous tab
6326 \divide\dimen0 by\tabw
6327 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6328 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6329 \wd0=\dimen0 \box0 \starttabbox
6334 % start the verbatim environment.
6335 \def\setupverbatim{%
6336 \let\nonarrowing = t%
6338 % Easiest (and conventionally used) font for verbatim
6340 \def\par{\leavevmode\egroup\box0\endgraf}%
6342 \setupmarkupstyle{verbatim}%
6343 % Respect line breaks,
6344 % print special symbols as themselves, and
6345 % make each space count
6346 % must do in this order:
6347 \obeylines \uncatcodespecials \sepspaces
6348 \everypar{\starttabbox}%
6351 % Do the @verb magic: verbatim text is quoted by unique
6352 % delimiter characters. Before first delimiter expect a
6353 % right brace, after last delimiter expect closing brace:
6355 % \def\doverb'{'<char>#1<char>'}'{#1}
6357 % [Knuth] p. 382; only eat outer {}
6359 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6360 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6363 \def\verb{\begingroup\setupverb\doverb}
6366 % Do the @verbatim magic: define the macro \doverbatim so that
6367 % the (first) argument ends when '@end verbatim' is reached, ie:
6369 % \def\doverbatim#1@end verbatim{#1}
6371 % For Texinfo it's a lot easier than for LaTeX,
6372 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6373 % we need not redefine '\', '{' and '}'.
6375 % Inspired by LaTeX's verbatim command set [latex.ltx]
6380 % ignore everything up to the first ^^M, that's the newline at the end
6381 % of the @verbatim input line itself. Otherwise we get an extra blank
6382 % line in the output.
6383 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6384 % We really want {...\end verbatim} in the body of the macro, but
6385 % without the active space; thus we have to use \xdef and \gobble.
6389 \setupverbatim\doverbatim
6391 \let\Everbatim = \afterenvbreak
6394 % @verbatiminclude FILE - insert text of file in verbatim environment.
6396 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6398 \def\doverbatiminclude#1{%
6400 \makevalueexpandable
6402 \indexnofonts % Allow `@@' and other weird things in file names.
6408 % @copying ... @end copying.
6409 % Save the text away for @insertcopying later.
6411 % We save the uninterpreted tokens, rather than creating a box.
6412 % Saving the text in a box would be much easier, but then all the
6413 % typesetting commands (@smallbook, font changes, etc.) have to be done
6414 % beforehand -- and a) we want @copying to be done first in the source
6415 % file; b) letting users define the frontmatter in as flexible order as
6416 % possible is very desirable.
6418 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6419 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6421 \def\insertcopying{%
6423 \parindent = 0pt % paragraph indentation looks wrong on title page
6424 \scanexp\copyingtext
6432 \newskip\defbodyindent \defbodyindent=.4in
6433 \newskip\defargsindent \defargsindent=50pt
6434 \newskip\deflastargmargin \deflastargmargin=18pt
6435 \newcount\defunpenalty
6437 % Start the processing of @deffn:
6439 \ifnum\lastpenalty<10000
6441 \defunpenalty=10003 % Will keep this @deffn together with the
6442 % following @def command, see below.
6444 % If there are two @def commands in a row, we'll have a \nobreak,
6445 % which is there to keep the function description together with its
6446 % header. But if there's nothing but headers, we need to allow a
6447 % break somewhere. Check specifically for penalty 10002, inserted
6448 % by \printdefunline, instead of 10000, since the sectioning
6449 % commands also insert a nobreak penalty, and we don't want to allow
6450 % a break between a section heading and a defun.
6452 % As a minor refinement, we avoid "club" headers by signalling
6453 % with penalty of 10003 after the very first @deffn in the
6454 % sequence (see above), and penalty of 10002 after any following
6456 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6458 % Similarly, after a section heading, do not allow a break.
6459 % But do insert the glue.
6460 \medskip % preceded by discardable penalty, so not a breakpoint
6464 \advance\leftskip by \defbodyindent
6465 \exdentamount=\defbodyindent
6469 % First, check whether we are in the right environment:
6472 % As above, allow line break if we have multiple x headers in a row.
6473 % It's not a great place, though.
6474 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6476 % And now, it's time to reuse the body of the original defun:
6477 \expandafter\gobbledefun#1%
6479 \def\gobbledefun#1\startdefun{}
6481 % \printdefunline \deffnheader{text}
6483 \def\printdefunline#1#2{%
6485 % call \deffnheader:
6488 \interlinepenalty = 10000
6489 \advance\rightskip by 0pt plus 1fil
6491 \nobreak\vskip -\parskip
6492 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6493 % Some of the @defun-type tags do not enable magic parentheses,
6494 % rendering the following check redundant. But we don't optimize.
6499 \def\Edefun{\endgraf\medbreak}
6501 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6502 % the only thing remaining is to define \deffnheader.
6505 \expandafter\let\csname E#1\endcsname = \Edefun
6506 \edef\temp{\noexpand\domakedefun
6507 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6511 % \domakedefun \deffn \deffnx \deffnheader
6513 % Define \deffn and \deffnx, without parameters.
6514 % \deffnheader has to be defined explicitly.
6516 \def\domakedefun#1#2#3{%
6519 \parseargusing\activeparens{\printdefunline#3}%
6521 \def#2{\dodefunx#1}%
6525 %%% Untyped functions:
6527 % @deffn category name args
6528 \makedefun{deffn}{\deffngeneral{}}
6530 % @deffn category class name args
6531 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6533 % \defopon {category on}class name args
6534 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6536 % \deffngeneral {subind}category name args
6538 \def\deffngeneral#1#2 #3 #4\endheader{%
6539 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6540 \dosubind{fn}{\code{#3}}{#1}%
6541 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6544 %%% Typed functions:
6546 % @deftypefn category type name args
6547 \makedefun{deftypefn}{\deftypefngeneral{}}
6549 % @deftypeop category class type name args
6550 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6552 % \deftypeopon {category on}class type name args
6553 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6555 % \deftypefngeneral {subind}category type name args
6557 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6558 \dosubind{fn}{\code{#4}}{#1}%
6559 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6562 %%% Typed variables:
6564 % @deftypevr category type var args
6565 \makedefun{deftypevr}{\deftypecvgeneral{}}
6567 % @deftypecv category class type var args
6568 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6570 % \deftypecvof {category of}class type var args
6571 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6573 % \deftypecvgeneral {subind}category type var args
6575 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6576 \dosubind{vr}{\code{#4}}{#1}%
6577 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6580 %%% Untyped variables:
6582 % @defvr category var args
6583 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6585 % @defcv category class var args
6586 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6588 % \defcvof {category of}class var args
6589 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6592 % @deftp category name args
6593 \makedefun{deftp}#1 #2 #3\endheader{%
6594 \doind{tp}{\code{#2}}%
6595 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6598 % Remaining @defun-like shortcuts:
6599 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6600 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6601 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6602 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6603 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6604 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6605 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6606 \makedefun{defmethod}{\defopon\putwordMethodon}
6607 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6608 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6609 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6611 % \defname, which formats the name of the @def (not the args).
6612 % #1 is the category, such as "Function".
6613 % #2 is the return type, if any.
6614 % #3 is the function name.
6616 % We are followed by (but not passed) the arguments, if any.
6618 \def\defname#1#2#3{%
6619 % Get the values of \leftskip and \rightskip as they were outside the @def...
6620 \advance\leftskip by -\defbodyindent
6622 % How we'll format the type name. Putting it in brackets helps
6623 % distinguish it from the body text that may end up on the next line
6626 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6628 % Figure out line sizes for the paragraph shape.
6629 % The first line needs space for \box0; but if \rightskip is nonzero,
6630 % we need only space for the part of \box0 which exceeds it:
6631 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6632 % The continuations:
6633 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6634 % (plain.tex says that \dimen1 should be used only as global.)
6635 \parshape 2 0in \dimen0 \defargsindent \dimen2
6637 % Put the type name to the right margin.
6640 \hfil\box0 \kern-\hsize
6641 % \hsize has to be shortened this way:
6643 % Intentionally do not respect \rightskip, since we need the space.
6646 % Allow all lines to be underfull without complaint:
6647 \tolerance=10000 \hbadness=10000
6648 \exdentamount=\defbodyindent
6650 % defun fonts. We use typewriter by default (used to be bold) because:
6651 % . we're printing identifiers, they should be in tt in principle.
6652 % . in languages with many accents, such as Czech or French, it's
6653 % common to leave accents off identifiers. The result looks ok in
6654 % tt, but exceedingly strange in rm.
6655 % . we don't want -- and --- to be treated as ligatures.
6656 % . this still does not fix the ?` and !` ligatures, but so far no
6657 % one has made identifiers using them :).
6659 \def\temp{#2}% return value type
6660 \ifx\temp\empty\else \tclose{\temp} \fi
6661 #3% output function name
6663 {\rm\enskip}% hskip 0.5 em of \tenrm
6666 % arguments will be output next, if any.
6669 % Print arguments in slanted roman (not ttsl), inconsistently with using
6670 % tt for the name. This is because literal text is sometimes needed in
6671 % the argument list (groff manual), and ttsl and tt are not very
6672 % distinguishable. Prevent hyphenation at `-' chars.
6675 % use sl by default (not ttsl),
6677 \df \sl \hyphenchar\font=0
6679 % On the other hand, if an argument has two dashes (for instance), we
6680 % want a way to get ttsl. Let's try @var for that.
6681 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6683 \sl\hyphenchar\font=45
6686 % We want ()&[] to print specially on the defun line.
6689 \catcode`\(=\active \catcode`\)=\active
6690 \catcode`\[=\active \catcode`\]=\active
6694 % Make control sequences which act like normal parenthesis chars.
6695 \let\lparen = ( \let\rparen = )
6697 % Be sure that we always have a definition for `(', etc. For example,
6698 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6699 % so TeX would otherwise complain about undefined control sequence.
6702 \global\let(=\lparen \global\let)=\rparen
6703 \global\let[=\lbrack \global\let]=\rbrack
6706 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6707 \gdef\magicamp{\let&=\amprm}
6710 \newcount\parencount
6712 % If we encounter &foo, then turn on ()-hacking afterwards
6714 \def\amprm#1 {\ampseentrue{\bf\ }}
6718 % At the first level, print parens in roman,
6719 % otherwise use the default font.
6720 \ifnum \parencount=1 \rm \fi
6722 % The \sf parens (in \boldbrax) actually are a little bolder than
6723 % the contained text. This is especially needed for [ and ] .
6727 \def\infirstlevel#1{%
6734 \def\bfafterword#1 {#1 \bf}
6737 \global\advance\parencount by 1
6739 \infirstlevel \bfafterword
6744 \global\advance\parencount by -1
6747 \newcount\brackcount
6749 \global\advance\brackcount by 1
6754 \global\advance\brackcount by -1
6757 \def\checkparencounts{%
6758 \ifnum\parencount=0 \else \badparencount \fi
6759 \ifnum\brackcount=0 \else \badbrackcount \fi
6761 % these should not use \errmessage; the glibc manual, at least, actually
6762 % has such constructs (when documenting function pointers).
6763 \def\badparencount{%
6764 \message{Warning: unbalanced parentheses in @def...}%
6765 \global\parencount=0
6767 \def\badbrackcount{%
6768 \message{Warning: unbalanced square brackets in @def...}%
6769 \global\brackcount=0
6776 % To do this right we need a feature of e-TeX, \scantokens,
6777 % which we arrange to emulate with a temporary file in ordinary TeX.
6778 \ifx\eTeXversion\undefined
6779 \newwrite\macscribble
6782 \immediate\openout\macscribble=\jobname.tmp
6783 \immediate\write\macscribble{\the\toks0}%
6784 \immediate\closeout\macscribble
6792 \let\xeatspaces\eatspaces
6793 % Undo catcode changes of \startcontents and \doprintindex
6794 % When called from @insertcopying or (short)caption, we need active
6795 % backslash to get it printed correctly. Previously, we had
6796 % \catcode`\\=\other instead. We'll see whether a problem appears
6797 % with macro expansion. --kasal, 19aug04
6798 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6802 % Append \endinput to make sure that TeX does not see the ending newline.
6803 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6805 \scantokens{#1\endinput}%
6810 \edef\temp{\noexpand\scanmacro{#1}}%
6814 \newcount\paramno % Count of parameters
6815 \newtoks\macname % Macro name
6816 \newif\ifrecursive % Is it recursive?
6818 % List of all defined macros in the form
6819 % \definedummyword\macro1\definedummyword\macro2...
6820 % Currently is also contains all @aliases; the list can be split
6821 % if there is a need.
6824 % Add the macro to \macrolist
6825 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6826 \def\addtomacrolistxxx#1{%
6827 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6828 \xdef\macrolist{\the\toks0}%
6832 % This does \let #1 = #2, with \csnames; that is,
6833 % \let \csname#1\endcsname = \csname#2\endcsname
6834 % (except of course we have to play expansion games).
6838 \csname#1\expandafter\endcsname
6842 % Trim leading and trailing spaces off a string.
6843 % Concepts from aro-bend problem 15 (see CTAN).
6845 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6846 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6847 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6849 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6852 % Trim a single trailing ^^M off a string.
6853 {\catcode`\^^M=\other \catcode`\Q=3%
6854 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6855 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6856 \gdef\eatcrb#1Q#2Q{#1}%
6859 % Macro bodies are absorbed as an argument in a context where
6860 % all characters are catcode 10, 11 or 12, except \ which is active
6861 % (as in normal texinfo). It is necessary to change the definition of \.
6863 % Non-ASCII encodings make 8-bit characters active, so un-activate
6864 % them to avoid their expansion. Must do this non-globally, to
6865 % confine the change to the current group.
6867 % It's necessary to have hard CRs when the macro is executed. This is
6868 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6869 % body, and then making it the \newlinechar in \scanmacro.
6881 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6887 \catcode`\^^M=\other
6890 \def\macrobodyctxt{%
6894 \catcode`\^^M=\other
6903 % \mbodybackslash is the definition of \ in @macro bodies.
6904 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6905 % where N is the macro parameter number.
6906 % We define \csname macarg.\endcsname to be \realbackslash, so
6907 % \\ in macro replacement text gets you a backslash.
6909 {\catcode`@=0 @catcode`@\=@active
6910 @gdef@usembodybackslash{@let\=@mbodybackslash}
6911 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6913 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6915 \def\macro{\recursivefalse\parsearg\macroxxx}
6916 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6919 \getargs{#1}% now \macname is the macname and \argl the arglist
6920 \ifx\argl\empty % no arguments
6923 \expandafter\parsemargdef \argl;%
6925 \if1\csname ismacro.\the\macname\endcsname
6926 \message{Warning: redefining \the\macname}%
6928 \expandafter\ifx\csname \the\macname\endcsname \relax
6929 \else \errmessage{Macro name \the\macname\space already defined}\fi
6930 \global\cslet{macsave.\the\macname}{\the\macname}%
6931 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6932 \addtomacrolist{\the\macname}%
6934 \begingroup \macrobodyctxt
6935 \ifrecursive \expandafter\parsermacbody
6936 \else \expandafter\parsemacbody
6939 \parseargdef\unmacro{%
6940 \if1\csname ismacro.#1\endcsname
6941 \global\cslet{#1}{macsave.#1}%
6942 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6943 % Remove the macro name from \macrolist:
6945 \expandafter\let\csname#1\endcsname \relax
6946 \let\definedummyword\unmacrodo
6947 \xdef\macrolist{\macrolist}%
6950 \errmessage{Macro #1 not defined}%
6954 % Called by \do from \dounmacro on each macro. The idea is to omit any
6955 % macro definitions that have been changed to \relax.
6961 \noexpand\definedummyword \noexpand#1%
6965 % This makes use of the obscure feature that if the last token of a
6966 % <parameter list> is #, then the preceding argument is delimited by
6967 % an opening brace, and that opening brace is not consumed.
6968 \def\getargs#1{\getargsxxx#1{}}
6969 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6970 \def\getmacname #1 #2\relax{\macname={#1}}
6971 \def\getmacargs#1{\def\argl{#1}}
6973 % Parse the optional {params} list. Set up \paramno and \paramlist
6974 % so \defmacro knows what to do. Define \macarg.blah for each blah
6975 % in the params list, to be ##N where N is the position in that list.
6976 % That gets used by \mbodybackslash (above).
6978 % We need to get `macro parameter char #' into several definitions.
6979 % The technique used is stolen from LaTeX: let \hash be something
6980 % unexpandable, insert that wherever you need a #, and then redefine
6981 % it to # just before using the token list produced.
6983 % The same technique is used to protect \eatspaces till just before
6984 % the macro is used.
6986 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6987 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6988 \def\parsemargdefxxx#1,{%
6989 \if#1;\let\next=\relax
6990 \else \let\next=\parsemargdefxxx
6991 \advance\paramno by 1%
6992 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6993 {\xeatspaces{\hash\the\paramno}}%
6994 \edef\paramlist{\paramlist\hash\the\paramno,}%
6997 % These two commands read recursive and nonrecursive macro bodies.
6998 % (They're different since rec and nonrec macros end differently.)
7000 \long\def\parsemacbody#1@end macro%
7001 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7002 \long\def\parsermacbody#1@end rmacro%
7003 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7005 % This defines the macro itself. There are six cases: recursive and
7006 % nonrecursive macros of zero, one, and many arguments.
7007 % Much magic with \expandafter here.
7008 % \xdef is used so that macro definitions will survive the file
7009 % they're defined in; @include reads the file inside a group.
7011 \let\hash=##% convert placeholders to macro parameter chars
7015 \expandafter\xdef\csname\the\macname\endcsname{%
7016 \noexpand\scanmacro{\temp}}%
7018 \expandafter\xdef\csname\the\macname\endcsname{%
7019 \bgroup\noexpand\macroargctxt
7020 \noexpand\braceorline
7021 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7022 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7023 \egroup\noexpand\scanmacro{\temp}}%
7025 \expandafter\xdef\csname\the\macname\endcsname{%
7026 \bgroup\noexpand\macroargctxt
7027 \noexpand\csname\the\macname xx\endcsname}%
7028 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7029 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7030 \expandafter\expandafter
7032 \expandafter\expandafter
7033 \csname\the\macname xxx\endcsname
7034 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7039 \expandafter\xdef\csname\the\macname\endcsname{%
7040 \noexpand\norecurse{\the\macname}%
7041 \noexpand\scanmacro{\temp}\egroup}%
7043 \expandafter\xdef\csname\the\macname\endcsname{%
7044 \bgroup\noexpand\macroargctxt
7045 \noexpand\braceorline
7046 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7047 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7049 \noexpand\norecurse{\the\macname}%
7050 \noexpand\scanmacro{\temp}\egroup}%
7052 \expandafter\xdef\csname\the\macname\endcsname{%
7053 \bgroup\noexpand\macroargctxt
7054 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7055 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7056 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7057 \expandafter\expandafter
7059 \expandafter\expandafter
7060 \csname\the\macname xxx\endcsname
7063 \noexpand\norecurse{\the\macname}%
7064 \noexpand\scanmacro{\temp}\egroup}%
7068 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7070 % \braceorline decides whether the next nonwhitespace character is a
7071 % {. If so it reads up to the closing }, if not, it reads the whole
7072 % line. Whatever was read is then fed to the next control sequence
7073 % as an argument (by \parsebrace or \parsearg)
7074 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7075 \def\braceorlinexxx{%
7076 \ifx\nchar\bgroup\else
7077 \expandafter\parsearg
7082 % We need some trickery to remove the optional spaces around the equal
7083 % sign. Just make them active and then expand them all to nothing.
7084 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7085 \def\aliasxxx #1{\aliasyyy#1\relax}
7086 \def\aliasyyy #1=#2\relax{%
7088 \expandafter\let\obeyedspace=\empty
7089 \addtomacrolist{#1}%
7090 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7096 \message{cross references,}
7099 \newif\ifhavexrefs % True if xref values are known.
7100 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7102 % @inforef is relatively simple.
7103 \def\inforef #1{\inforefzzz #1,,,,**}
7104 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7105 node \samp{\ignorespaces#1{}}}
7107 % @node's only job in TeX is to define \lastnode, which is used in
7108 % cross-references. The @node line might or might not have commas, and
7109 % might or might not have spaces before the first comma, like:
7110 % @node foo , bar , ...
7111 % We don't want such trailing spaces in the node name.
7113 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7115 % also remove a trailing comma, in case of something like this:
7116 % @node Help-Cross, , , Cross-refs
7117 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7118 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7121 \let\lastnode=\empty
7123 % Write a cross-reference definition for the current node. #1 is the
7124 % type (Ynumbered, Yappendix, Ynothing).
7127 \ifx\lastnode\empty\else
7128 \setref{\lastnode}{#1}%
7129 \global\let\lastnode=\empty
7133 % @anchor{NAME} -- define xref target at arbitrary point.
7135 \newcount\savesfregister
7137 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7138 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7139 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7141 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7142 % anchor), which consists of three parts:
7143 % 1) NAME-title - the current sectioning name taken from \lastsection,
7144 % or the anchor name.
7145 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7146 % empty for anchors.
7147 % 3) NAME-pg - the page number.
7149 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7150 % floats, there is an additional part, which is not written here:
7151 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7157 \atdummies % preserve commands, but don't expand them
7158 \edef\writexrdef##1##2{%
7159 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7160 ##1}{##2}}% these are parameters of \writexrdef
7162 \toks0 = \expandafter{\lastsection}%
7163 \immediate \writexrdef{title}{\the\toks0 }%
7164 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7165 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7170 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7171 % the node name, #2 the name of the Info cross-reference, #3 the printed
7172 % node name, #4 the name of the Info file, #5 the name of the printed
7173 % manual. All but the node name can be omitted.
7175 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7176 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7177 \def\ref#1{\xrefX[#1,,,,,,,]}
7178 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7180 \def\printedmanual{\ignorespaces #5}%
7181 \def\printedrefname{\ignorespaces #3}%
7182 \setbox1=\hbox{\printedmanual\unskip}%
7183 \setbox0=\hbox{\printedrefname\unskip}%
7185 % No printed node name was explicitly given.
7186 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7187 % Use the node name inside the square brackets.
7188 \def\printedrefname{\ignorespaces #1}%
7190 % Use the actual chapter/section title appear inside
7191 % the square brackets. Use the real section title if we have it.
7193 % It is in another manual, so we don't have it.
7194 \def\printedrefname{\ignorespaces #1}%
7197 % We know the real title if we have the xref values.
7198 \def\printedrefname{\refx{#1-title}{}}%
7200 % Otherwise just copy the Info node name.
7201 \def\printedrefname{\ignorespaces #1}%
7207 % Make link in pdf output.
7211 % This expands tokens, so do it after making catcode changes, so _
7212 % etc. don't get their TeX definitions.
7215 % See comments at \activebackslashdouble.
7216 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7217 \backslashparens\pdfxrefdest}%
7220 \startlink attr{/Border [0 0 0]}%
7221 \ifnum\filenamelength>0
7222 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7224 goto name{\pdfmkpgn{\pdfxrefdest}}%
7227 \setcolor{\linkcolor}%
7230 % Float references are printed completely differently: "Figure 1.2"
7231 % instead of "[somenode], p.3". We distinguish them by the
7232 % LABEL-title being set to a magic string.
7234 % Have to otherify everything special to allow the \csname to
7235 % include an _ in the xref name, etc.
7238 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7239 \csname XR#1-title\endcsname
7241 \iffloat\Xthisreftitle
7242 % If the user specified the print name (third arg) to the ref,
7243 % print it instead of our usual "Figure 1.2".
7250 % if the user also gave the printed manual name (fifth arg), append
7253 \space \putwordin{} \cite{\printedmanual}%
7256 % node/anchor (non-float) references.
7258 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7259 % insert empty discretionaries after hyphens, which means that it will
7260 % not find a line break at a hyphen in a node names. Since some manuals
7261 % are best written with fairly long node names, containing hyphens, this
7262 % is a loss. Therefore, we give the text of the node name again, so it
7263 % is as if TeX is seeing it for the first time.
7265 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7267 % _ (for example) has to be the character _ for the purposes of the
7268 % control sequence corresponding to the node, but it has to expand
7269 % into the usual \leavevmode...\vrule stuff for purposes of
7270 % printing. So we \turnoffactive for the \refx-snt, back on for the
7271 % printing, back off for the \refx-pg.
7273 % Only output a following space if the -snt ref is nonempty; for
7274 % @unnumbered and @anchor, it won't be.
7275 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7276 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7278 % output the `[mynode]' via a macro so it can be overridden.
7279 \xrefprintnodename\printedrefname
7281 % But we always want a comma and a space:
7284 % output the `page 3'.
7285 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7291 % This macro is called from \xrefX for the `[nodename]' part of xref
7292 % output. It's a separate macro only so it can be changed more easily,
7293 % since square brackets don't work well in some documents. Particularly
7294 % one that Bob is working on :).
7296 \def\xrefprintnodename#1{[#1]}
7298 % Things referred to by \setref.
7304 \putwordChapter@tie \the\chapno
7305 \else \ifnum\subsecno=0
7306 \putwordSection@tie \the\chapno.\the\secno
7307 \else \ifnum\subsubsecno=0
7308 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7310 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7315 \putwordAppendix@tie @char\the\appendixno{}%
7316 \else \ifnum\subsecno=0
7317 \putwordSection@tie @char\the\appendixno.\the\secno
7318 \else \ifnum\subsubsecno=0
7319 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7322 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7326 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7327 % If its value is nonempty, SUFFIX is output afterward.
7333 \expandafter\global\expandafter\let\expandafter\thisrefX
7334 \csname XR#1\endcsname
7337 % If not defined, say something at least.
7338 \angleleft un\-de\-fined\angleright
7341 \message{\linenumber Undefined cross reference `#1'.}%
7344 \global\warnedxrefstrue
7345 \message{Cross reference values unknown; you must run TeX again.}%
7350 % It's defined, so just use it.
7353 #2% Output the suffix in any case.
7356 % This is the macro invoked by entries in the aux file. Usually it's
7357 % just a \def (we prepend XR to the control sequence name to avoid
7358 % collisions). But if this is a float type, we have more work to do.
7361 {% The node name might contain 8-bit characters, which in our current
7362 % implementation are changed to commands like @'e. Don't let these
7363 % mess up the control sequence name.
7366 \xdef\safexrefname{#1}%
7369 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7371 % Was that xref control sequence that we just defined for a float?
7372 \expandafter\iffloat\csname XR\safexrefname\endcsname
7373 % it was a float, and we have the (safe) float type in \iffloattype.
7374 \expandafter\let\expandafter\floatlist
7375 \csname floatlist\iffloattype\endcsname
7377 % Is this the first time we've seen this float type?
7378 \expandafter\ifx\floatlist\relax
7379 \toks0 = {\do}% yes, so just \do
7381 % had it before, so preserve previous elements in list.
7382 \toks0 = \expandafter{\floatlist\do}%
7385 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7386 % for later use in \listoffloats.
7387 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7392 % Read the last existing aux file, if any. No error if none exists.
7395 \openin 1 \jobname.aux
7398 \global\havexrefstrue
7403 \def\setupdatafile{%
7404 \catcode`\^^@=\other
7405 \catcode`\^^A=\other
7406 \catcode`\^^B=\other
7407 \catcode`\^^C=\other
7408 \catcode`\^^D=\other
7409 \catcode`\^^E=\other
7410 \catcode`\^^F=\other
7411 \catcode`\^^G=\other
7412 \catcode`\^^H=\other
7413 \catcode`\^^K=\other
7414 \catcode`\^^L=\other
7415 \catcode`\^^N=\other
7416 \catcode`\^^P=\other
7417 \catcode`\^^Q=\other
7418 \catcode`\^^R=\other
7419 \catcode`\^^S=\other
7420 \catcode`\^^T=\other
7421 \catcode`\^^U=\other
7422 \catcode`\^^V=\other
7423 \catcode`\^^W=\other
7424 \catcode`\^^X=\other
7425 \catcode`\^^Z=\other
7426 \catcode`\^^[=\other
7427 \catcode`\^^\=\other
7428 \catcode`\^^]=\other
7429 \catcode`\^^^=\other
7430 \catcode`\^^_=\other
7431 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7432 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7433 % supported in the main text, it doesn't seem desirable. Furthermore,
7434 % that is not enough: for node names that actually contain a ^
7435 % character, we would end up writing a line like this: 'xrdef {'hat
7436 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7437 % argument, and \hat is not an expandable control sequence. It could
7438 % all be worked out, but why? Either we support ^^ or we don't.
7440 % The other change necessary for this was to define \auxhat:
7441 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7442 % and then to call \auxhat in \setq.
7446 % Special characters. Should be turned off anyway, but...
7459 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7461 % This is to support \ in node names and titles, since the \
7462 % characters end up in a \csname. It's easier than
7463 % leaving it active and making its active definition an actual \
7464 % character. What I don't understand is why it works in the *value*
7465 % of the xrdef. Seems like it should be a catcode12 \, and that
7466 % should not typeset properly. But it works, so I'm moving on for
7467 % now. --karl, 15jan04.
7470 % Make the characters 128-255 be printing characters.
7474 \catcode\count1=\other
7475 \advance\count1 by 1
7476 \ifnum \count1<256 \loop \fi
7480 % @ is our escape character in .aux files, and we need braces.
7486 \def\readdatafile#1{%
7493 \message{insertions,}
7494 % including footnotes.
7496 \newcount \footnoteno
7498 % The trailing space in the following definition for supereject is
7499 % vital for proper filling; pages come out unaligned when you do a
7500 % pagealignmacro call if that space before the closing brace is
7501 % removed. (Generally, numeric constants should always be followed by a
7502 % space to prevent strange expansion errors.)
7503 \def\supereject{\par\penalty -20000\footnoteno =0 }
7505 % @footnotestyle is meaningful for info output only.
7506 \let\footnotestyle=\comment
7510 % Auto-number footnotes. Otherwise like plain.
7512 \let\indent=\ptexindent
7513 \let\noindent=\ptexnoindent
7514 \global\advance\footnoteno by \@ne
7515 \edef\thisfootno{$^{\the\footnoteno}$}%
7517 % In case the footnote comes at the end of a sentence, preserve the
7518 % extra spacing after we do the footnote number.
7520 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7522 % Remove inadvertent blank space before typesetting the footnote number.
7528 % Don't bother with the trickery in plain.tex to not require the
7529 % footnote text as a parameter. Our footnotes don't need to be so general.
7531 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7532 % \parseargline) fails inside footnotes because the tokens are fixed when
7533 % the footnote is read. --karl, 16nov96.
7536 \insert\footins\bgroup
7537 % We want to typeset this text as a normal paragraph, even if the
7538 % footnote reference occurs in (for example) a display environment.
7539 % So reset some parameters.
7541 \interlinepenalty\interfootnotelinepenalty
7542 \splittopskip\ht\strutbox % top baseline for broken footnotes
7543 \splitmaxdepth\dp\strutbox
7544 \floatingpenalty\@MM
7549 \parindent\defaultparindent
7553 % Because we use hanging indentation in footnotes, a @noindent appears
7554 % to exdent this text, so make it be a no-op. makeinfo does not use
7555 % hanging indentation so @noindent can still be needed within footnote
7556 % text after an @example or the like (not that this is good style).
7557 \let\noindent = \relax
7559 % Hang the footnote text off the number. Use \everypar in case the
7560 % footnote extends for more than one paragraph.
7561 \everypar = {\hang}%
7562 \textindent{\thisfootno}%
7564 % Don't crash into the line above the footnote text. Since this
7565 % expands into a box, it must come within the paragraph, lest it
7566 % provide a place where TeX can split the footnote.
7568 \futurelet\next\fo@t
7570 }%end \catcode `\@=11
7572 % In case a @footnote appears in a vbox, save the footnote text and create
7573 % the real \insert just after the vbox finished. Otherwise, the insertion
7575 % Similarly, if a @footnote appears inside an alignment, save the footnote
7576 % text to a box and make the \insert when a row of the table is finished.
7577 % And the same can be done for other insert classes. --kasal, 16nov03.
7579 % Replace the \insert primitive by a cheating macro.
7580 % Deeper inside, just make sure that the saved insertions are not spilled
7583 \def\startsavinginserts{%
7584 \ifx \insert\ptexinsert
7585 \let\insert\saveinsert
7587 \let\checkinserts\relax
7591 % This \insert replacement works for both \insert\footins{foo} and
7592 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7595 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7596 \afterassignment\next
7597 % swallow the left brace
7600 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7601 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7603 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7605 \def\placesaveins#1{%
7606 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7610 % eat @SAVE -- beware, all of them have catcode \other:
7612 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7613 \gdef\gobblesave @SAVE{}
7617 \def\newsaveins #1{%
7618 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7621 \def\newsaveinsX #1{%
7622 \csname newbox\endcsname #1%
7623 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7628 \let\checkinserts\empty
7633 % @image. We use the macros from epsf.tex to support this.
7634 % If epsf.tex is not installed and @image is used, we complain.
7636 % Check for and read epsf.tex up front. If we read it only at @image
7637 % time, we might be inside a group, and then its definitions would get
7638 % undone and the next image would fail.
7639 \openin 1 = epsf.tex
7641 % Do not bother showing banner with epsf.tex v2.7k (available in
7642 % doc/epsf.tex and on ctan).
7643 \def\epsfannounce{\toks0 = }%
7648 % We will only complain once about lack of epsf.tex.
7649 \newif\ifwarnednoepsf
7650 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7651 work. It is also included in the Texinfo distribution, or you can get
7652 it from ftp://tug.org/tex/epsf.tex.}
7655 \ifx\epsfbox\undefined
7656 \ifwarnednoepsf \else
7657 \errhelp = \noepsfhelp
7658 \errmessage{epsf.tex not found, images will be ignored}%
7659 \global\warnednoepsftrue
7662 \imagexxx #1,,,,,\finish
7666 % Arguments to @image:
7667 % #1 is (mandatory) image filename; we tack on .eps extension.
7668 % #2 is (optional) width, #3 is (optional) height.
7669 % #4 is (ignored optional) html alt text.
7670 % #5 is (ignored optional) extension.
7671 % #6 is just the usual extra ignored arg for parsing this stuff.
7673 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7674 \catcode`\^^M = 5 % in case we're inside an example
7675 \normalturnoffactive % allow _ et al. in names
7676 % If the image is by itself, center it.
7680 % Usually we'll have text after the image which will insert
7681 % \parskip glue, so insert it here too to equalize the space
7683 \nobreak\vskip\parskip
7687 % Leave vertical mode so that indentation from an enclosing
7688 % environment such as @quotation is respected. On the other hand, if
7689 % it's at the top level, we don't want the normal paragraph indentation.
7694 \dopdfimage{#1}{#2}{#3}%
7696 % \epsfbox itself resets \epsf?size at each figure.
7697 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7698 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7702 \ifimagevmode \medskip \fi % space after the standalone image
7706 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7707 % etc. We don't actually implement floating yet, we always include the
7708 % float "here". But it seemed the best name for the future.
7710 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7712 % There may be a space before second and/or third parameter; delete it.
7713 \def\eatcommaspace#1, {#1,}
7715 % #1 is the optional FLOATTYPE, the text label for this float, typically
7716 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7717 % this float will not be numbered and cannot be referred to.
7719 % #2 is the optional xref label. Also must be present for the float to
7722 % #3 is the optional positioning argument; for now, it is ignored. It
7723 % will somehow specify the positions allowed to float to (here, top, bottom).
7725 % We keep a separate counter for each FLOATTYPE, which we reset at each
7726 % chapter-level command.
7727 \let\resetallfloatnos=\empty
7729 \def\dofloat#1,#2,#3,#4\finish{%
7730 \let\thiscaption=\empty
7731 \let\thisshortcaption=\empty
7733 % don't lose footnotes inside @float.
7735 % BEWARE: when the floats start float, we have to issue warning whenever an
7736 % insert appears inside a float which could possibly float. --kasal, 26may04
7740 % We can't be used inside a paragraph.
7745 \def\floatlabel{#2}%
7746 \def\floatloc{#3}% we do nothing with this yet.
7748 \ifx\floattype\empty
7749 \let\safefloattype=\empty
7752 % the floattype might have accents or other special characters,
7753 % but we need to use it in a control sequence name.
7756 \xdef\safefloattype{\floattype}%
7760 % If label is given but no type, we handle that as the empty type.
7761 \ifx\floatlabel\empty \else
7762 % We want each FLOATTYPE to be numbered separately (Figure 1,
7763 % Table 1, Figure 2, ...). (And if no label, no number.)
7765 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7766 \global\advance\floatno by 1
7769 % This magic value for \lastsection is output by \setref as the
7770 % XREFLABEL-title value. \xrefX uses it to distinguish float
7771 % labels (which have a completely different output format) from
7772 % node and anchor labels. And \xrdef uses it to construct the
7775 \edef\lastsection{\floatmagic=\safefloattype}%
7776 \setref{\floatlabel}{Yfloat}%
7780 % start with \parskip glue, I guess.
7783 % Don't suppress indentation if a float happens to start a section.
7784 \restorefirstparagraphindent
7787 % we have these possibilities:
7788 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7789 % @float Foo,lbl & no caption: Foo 1.1
7790 % @float Foo & @caption{Cap}: Foo: Cap
7791 % @float Foo & no caption: Foo
7792 % @float ,lbl & Caption{Cap}: 1.1: Cap
7793 % @float ,lbl & no caption: 1.1
7794 % @float & @caption{Cap}: Cap
7795 % @float & no caption:
7798 \let\floatident = \empty
7800 % In all cases, if we have a float type, it comes first.
7801 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7803 % If we have an xref label, the number comes next.
7804 \ifx\floatlabel\empty \else
7805 \ifx\floattype\empty \else % if also had float type, need tie first.
7806 \appendtomacro\floatident{\tie}%
7809 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7812 % Start the printed caption with what we've constructed in
7813 % \floatident, but keep it separate; we need \floatident again.
7814 \let\captionline = \floatident
7816 \ifx\thiscaption\empty \else
7817 \ifx\floatident\empty \else
7818 \appendtomacro\captionline{: }% had ident, so need a colon between
7822 \appendtomacro\captionline{\scanexp\thiscaption}%
7825 % If we have anything to print, print it, with space before.
7826 % Eventually this needs to become an \insert.
7827 \ifx\captionline\empty \else
7831 % Space below caption.
7835 % If have an xref label, write the list of floats info. Do this
7836 % after the caption, to avoid chance of it being a breakpoint.
7837 \ifx\floatlabel\empty \else
7838 % Write the text that goes in the lof to the aux file as
7839 % \floatlabel-lof. Besides \floatident, we include the short
7840 % caption if specified, else the full caption if specified, else nothing.
7844 % since we read the caption text in the macro world, where ^^M
7845 % is turned into a normal character, we have to scan it back, so
7846 % we don't write the literal three characters "^^M" into the aux file.
7848 \xdef\noexpand\gtemp{%
7849 \ifx\thisshortcaption\empty
7856 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7857 \ifx\gtemp\empty \else : \gtemp \fi}}%
7860 \egroup % end of \vtop
7862 % place the captured inserts
7864 % BEWARE: when the floats start floating, we have to issue warning
7865 % whenever an insert appears inside a float which could possibly
7866 % float. --kasal, 26may04
7871 % Append the tokens #2 to the definition of macro #1, not expanding either.
7873 \def\appendtomacro#1#2{%
7874 \expandafter\def\expandafter#1\expandafter{#1#2}%
7877 % @caption, @shortcaption
7879 \def\caption{\docaption\thiscaption}
7880 \def\shortcaption{\docaption\thisshortcaption}
7881 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7882 \def\defcaption#1#2{\egroup \def#1{#2}}
7884 % The parameter is the control sequence identifying the counter we are
7885 % going to use. Create it if it doesn't exist and assign it to \floatno.
7888 % Haven't seen this figure type before.
7889 \csname newcount\endcsname #1%
7891 % Remember to reset this floatno at the next chap.
7892 \expandafter\gdef\expandafter\resetallfloatnos
7893 \expandafter{\resetallfloatnos #1=0 }%
7898 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7899 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7900 % first read the @float command.
7902 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7904 % Magic string used for the XREFLABEL-title value, so \xrefX can
7905 % distinguish floats from other xref types.
7906 \def\floatmagic{!!float!!}
7908 % #1 is the control sequence we are passed; we expand into a conditional
7909 % which is true if #1 represents a float ref. That is, the magic
7910 % \lastsection value which we \setref above.
7912 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7914 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7915 % (safe) float type for this float. We set \iffloattype to #2.
7917 \def\doiffloat#1=#2=#3\finish{%
7919 \def\iffloattype{#2}%
7920 \ifx\temp\floatmagic
7923 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7925 \parseargdef\listoffloats{%
7926 \def\floattype{#1}% floattype
7928 % the floattype might have accents or other special characters,
7929 % but we need to use it in a control sequence name.
7932 \xdef\safefloattype{\floattype}%
7935 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7936 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7938 % if the user said @listoffloats foo but never @float foo.
7939 \message{\linenumber No `\safefloattype' floats to list.}%
7943 \leftskip=\tocindent % indent these entries like a toc
7944 \let\do=\listoffloatsdo
7945 \csname floatlist\safefloattype\endcsname
7950 % This is called on each entry in a list of floats. We're passed the
7951 % xref label, in the form LABEL-title, which is how we save it in the
7952 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7953 % has the text we're supposed to typeset here.
7955 % Figures without xref labels will not be included in the list (since
7956 % they won't appear in the aux file).
7958 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7959 \def\listoffloatsdoentry#1-title\finish{{%
7960 % Can't fully expand XR#1-lof because it can contain anything. Just
7961 % pass the control sequence. On the other hand, XR#1-pg is just the
7962 % page number, and we want to fully expand that so we can get a link
7964 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7966 % use the same \entry macro we use to generate the TOC and index.
7967 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7972 \message{localization,}
7974 % For single-language documents, @documentlanguage is usually given very
7975 % early, just after @documentencoding. Single argument is the language
7976 % (de) or locale (de_DE) abbreviation.
7979 \catcode`\_ = \active
7981 \parseargdef\documentlanguage{\begingroup
7982 \let_=\normalunderscore % normal _ character for filenames
7983 \tex % read txi-??.tex file in plain TeX.
7984 % Read the file by the name they passed if it exists.
7985 \openin 1 txi-#1.tex
7987 \documentlanguagetrywithoutunderscore{#1_\finish}%
7989 \globaldefs = 1 % everything in the txi-LL files needs to persist
7993 \endgroup % end raw TeX
7995 }% end of special _ catcode
7997 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8000 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
8001 \openin 1 txi-#1.tex
8003 \errhelp = \nolanghelp
8004 \errmessage{Cannot read language file txi-#1.tex}%
8006 \globaldefs = 1 % everything in the txi-LL files needs to persist
8012 \newhelp\nolanghelp{The given language definition file cannot be found or
8013 is empty. Maybe you need to install it? Putting it in the current
8014 directory should work if nowhere else does.}
8016 % This macro is called from txi-??.tex files; the first argument is the
8017 % \language name to set (without the "\lang@" prefix), the second and
8018 % third args are \{left,right}hyphenmin.
8020 % The language names to pass are determined when the format is built.
8021 % See the etex.log file created at that time, e.g.,
8022 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8024 % With TeX Live 2008, etex now includes hyphenation patterns for all
8025 % available languages. This means we can support hyphenation in
8026 % Texinfo, at least to some extent. (This still doesn't solve the
8027 % accented characters problem.)
8030 \def\txisetlanguage#1#2#3{%
8031 % do not set the language if the name is undefined in the current TeX.
8032 \expandafter\ifx\csname lang@#1\endcsname \relax
8033 \message{no patterns for #1}%
8035 \global\language = \csname lang@#1\endcsname
8037 % but there is no harm in adjusting the hyphenmin values regardless.
8038 \global\lefthyphenmin = #2\relax
8039 \global\righthyphenmin = #3\relax
8042 % Helpers for encodings.
8043 % Set the catcode of characters 128 through 255 to the specified number.
8045 \def\setnonasciicharscatcode#1{%
8047 \loop\ifnum\count255<256
8048 \global\catcode\count255=#1\relax
8049 \advance\count255 by 1
8053 \def\setnonasciicharscatcodenonglobal#1{%
8055 \loop\ifnum\count255<256
8056 \catcode\count255=#1\relax
8057 \advance\count255 by 1
8061 % @documentencoding sets the definition of non-ASCII characters
8062 % according to the specified encoding.
8064 \parseargdef\documentencoding{%
8065 % Encoding being declared for the document.
8066 \def\declaredencoding{\csname #1.enc\endcsname}%
8068 % Supported encodings: names converted to tokens in order to be able
8069 % to compare them with \ifx.
8070 \def\ascii{\csname US-ASCII.enc\endcsname}%
8071 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8072 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8073 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8074 \def\utfeight{\csname UTF-8.enc\endcsname}%
8076 \ifx \declaredencoding \ascii
8079 \else \ifx \declaredencoding \lattwo
8080 \setnonasciicharscatcode\active
8083 \else \ifx \declaredencoding \latone
8084 \setnonasciicharscatcode\active
8087 \else \ifx \declaredencoding \latnine
8088 \setnonasciicharscatcode\active
8091 \else \ifx \declaredencoding \utfeight
8092 \setnonasciicharscatcode\active
8096 \message{Unknown document encoding #1, ignoring.}%
8105 % A message to be logged when using a character that isn't available
8106 % the default font encoding (OT1).
8108 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8110 % Take account of \c (plain) vs. \, (Texinfo) difference.
8111 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8113 % First, make active non-ASCII characters in order for them to be
8114 % correctly categorized when TeX reads the replacement text of
8115 % macros containing the character definitions.
8116 \setnonasciicharscatcode\active
8118 % Latin1 (ISO-8859-1) character definitions.
8119 \def\latonechardefs{%
8121 \gdef^^a1{\exclamdown}
8122 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8123 \gdef^^a3{{\pounds}}
8124 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8125 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8126 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8129 \gdef^^a9{\copyright}
8131 \gdef^^ab{\guillemetleft}
8134 \gdef^^ae{\registeredsymbol}
8137 \gdef^^b0{\textdegree}
8146 \gdef^^b8{\cedilla\ }
8150 \gdef^^bb{\guilletright}
8151 \gdef^^bc{$1\over4$}
8152 \gdef^^bd{$1\over2$}
8153 \gdef^^be{$3\over4$}
8154 \gdef^^bf{\questiondown}
8161 \gdef^^c5{\ringaccent A}
8163 \gdef^^c7{\cedilla C}
8195 \gdef^^e5{\ringaccent a}
8197 \gdef^^e7{\cedilla c}
8202 \gdef^^ec{\`{\dotless i}}
8203 \gdef^^ed{\'{\dotless i}}
8204 \gdef^^ee{\^{\dotless i}}
8205 \gdef^^ef{\"{\dotless i}}
8225 % Latin9 (ISO-8859-15) encoding character definitions.
8226 \def\latninechardefs{%
8227 % Encoding is almost identical to Latin1.
8240 % Latin2 (ISO-8859-2) character definitions.
8241 \def\lattwochardefs{%
8243 \gdef^^a1{\ogonek{A}}
8246 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8252 \gdef^^aa{\cedilla S}
8257 \gdef^^af{\dotaccent Z}
8259 \gdef^^b0{\textdegree}
8260 \gdef^^b1{\ogonek{a}}
8261 \gdef^^b2{\ogonek{ }}
8267 \gdef^^b8{\cedilla\ }
8269 \gdef^^ba{\cedilla s}
8274 \gdef^^bf{\dotaccent z}
8283 \gdef^^c7{\cedilla C}
8286 \gdef^^ca{\ogonek{E}}
8302 \gdef^^d9{\ringaccent U}
8307 \gdef^^de{\cedilla T}
8317 \gdef^^e7{\cedilla c}
8320 \gdef^^ea{\ogonek{e}}
8336 \gdef^^f9{\ringaccent u}
8341 \gdef^^fe{\cedilla t}
8342 \gdef^^ff{\dotaccent{}}
8345 % UTF-8 character definitions.
8347 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8348 % changes for Texinfo conventions. It is included here under the GPL by
8349 % permission from Frank Mittelbach and the LaTeX team.
8355 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8356 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8358 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8359 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8361 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8362 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8364 \gdef\UTFviiiDefined#1{%
8366 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8377 \global\catcode\countUTFx\active
8378 \uccode`\~\countUTFx
8379 \uppercase\expandafter{\UTFviiiTmp}%
8380 \advance\countUTFx by 1
8381 \ifnum\countUTFx < \countUTFy
8382 \expandafter\UTFviiiLoop
8388 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8394 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8400 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8413 \gdef\DeclareUnicodeCharacter#1#2{%
8414 \countUTFz = "#1\relax
8415 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8418 \def\UTFviiiTwoOctets##1##2{%
8419 \csname u8:##1\string ##2\endcsname}%
8420 \def\UTFviiiThreeOctets##1##2##3{%
8421 \csname u8:##1\string ##2\string ##3\endcsname}%
8422 \def\UTFviiiFourOctets##1##2##3##4{%
8423 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8424 \expandafter\expandafter\expandafter\expandafter
8425 \expandafter\expandafter\expandafter
8426 \gdef\UTFviiiTmp{#2}%
8429 \gdef\parseXMLCharref{%
8430 \ifnum\countUTFz < "A0\relax
8431 \errhelp = \EMsimple
8432 \errmessage{Cannot define Unicode char value < 00A0}%
8433 \else\ifnum\countUTFz < "800\relax
8435 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8436 \else\ifnum\countUTFz < "10000\relax
8439 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8444 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8448 \gdef\parseUTFviiiA#1{%
8449 \countUTFx = \countUTFz
8450 \divide\countUTFz by 64
8451 \countUTFy = \countUTFz
8452 \multiply\countUTFz by 64
8453 \advance\countUTFx by -\countUTFz
8454 \advance\countUTFx by 128
8455 \uccode `#1\countUTFx
8456 \countUTFz = \countUTFy}
8458 \gdef\parseUTFviiiB#1#2#3#4{%
8459 \advance\countUTFz by "#10\relax
8460 \uccode `#3\countUTFz
8461 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8464 \def\utfeightchardefs{%
8465 \DeclareUnicodeCharacter{00A0}{\tie}
8466 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8467 \DeclareUnicodeCharacter{00A3}{\pounds}
8468 \DeclareUnicodeCharacter{00A8}{\"{ }}
8469 \DeclareUnicodeCharacter{00A9}{\copyright}
8470 \DeclareUnicodeCharacter{00AA}{\ordf}
8471 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8472 \DeclareUnicodeCharacter{00AD}{\-}
8473 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8474 \DeclareUnicodeCharacter{00AF}{\={ }}
8476 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8477 \DeclareUnicodeCharacter{00B4}{\'{ }}
8478 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8479 \DeclareUnicodeCharacter{00BA}{\ordm}
8480 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8481 \DeclareUnicodeCharacter{00BF}{\questiondown}
8483 \DeclareUnicodeCharacter{00C0}{\`A}
8484 \DeclareUnicodeCharacter{00C1}{\'A}
8485 \DeclareUnicodeCharacter{00C2}{\^A}
8486 \DeclareUnicodeCharacter{00C3}{\~A}
8487 \DeclareUnicodeCharacter{00C4}{\"A}
8488 \DeclareUnicodeCharacter{00C5}{\AA}
8489 \DeclareUnicodeCharacter{00C6}{\AE}
8490 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8491 \DeclareUnicodeCharacter{00C8}{\`E}
8492 \DeclareUnicodeCharacter{00C9}{\'E}
8493 \DeclareUnicodeCharacter{00CA}{\^E}
8494 \DeclareUnicodeCharacter{00CB}{\"E}
8495 \DeclareUnicodeCharacter{00CC}{\`I}
8496 \DeclareUnicodeCharacter{00CD}{\'I}
8497 \DeclareUnicodeCharacter{00CE}{\^I}
8498 \DeclareUnicodeCharacter{00CF}{\"I}
8500 \DeclareUnicodeCharacter{00D0}{\DH}
8501 \DeclareUnicodeCharacter{00D1}{\~N}
8502 \DeclareUnicodeCharacter{00D2}{\`O}
8503 \DeclareUnicodeCharacter{00D3}{\'O}
8504 \DeclareUnicodeCharacter{00D4}{\^O}
8505 \DeclareUnicodeCharacter{00D5}{\~O}
8506 \DeclareUnicodeCharacter{00D6}{\"O}
8507 \DeclareUnicodeCharacter{00D8}{\O}
8508 \DeclareUnicodeCharacter{00D9}{\`U}
8509 \DeclareUnicodeCharacter{00DA}{\'U}
8510 \DeclareUnicodeCharacter{00DB}{\^U}
8511 \DeclareUnicodeCharacter{00DC}{\"U}
8512 \DeclareUnicodeCharacter{00DD}{\'Y}
8513 \DeclareUnicodeCharacter{00DE}{\TH}
8514 \DeclareUnicodeCharacter{00DF}{\ss}
8516 \DeclareUnicodeCharacter{00E0}{\`a}
8517 \DeclareUnicodeCharacter{00E1}{\'a}
8518 \DeclareUnicodeCharacter{00E2}{\^a}
8519 \DeclareUnicodeCharacter{00E3}{\~a}
8520 \DeclareUnicodeCharacter{00E4}{\"a}
8521 \DeclareUnicodeCharacter{00E5}{\aa}
8522 \DeclareUnicodeCharacter{00E6}{\ae}
8523 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8524 \DeclareUnicodeCharacter{00E8}{\`e}
8525 \DeclareUnicodeCharacter{00E9}{\'e}
8526 \DeclareUnicodeCharacter{00EA}{\^e}
8527 \DeclareUnicodeCharacter{00EB}{\"e}
8528 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8529 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8530 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8531 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8533 \DeclareUnicodeCharacter{00F0}{\dh}
8534 \DeclareUnicodeCharacter{00F1}{\~n}
8535 \DeclareUnicodeCharacter{00F2}{\`o}
8536 \DeclareUnicodeCharacter{00F3}{\'o}
8537 \DeclareUnicodeCharacter{00F4}{\^o}
8538 \DeclareUnicodeCharacter{00F5}{\~o}
8539 \DeclareUnicodeCharacter{00F6}{\"o}
8540 \DeclareUnicodeCharacter{00F8}{\o}
8541 \DeclareUnicodeCharacter{00F9}{\`u}
8542 \DeclareUnicodeCharacter{00FA}{\'u}
8543 \DeclareUnicodeCharacter{00FB}{\^u}
8544 \DeclareUnicodeCharacter{00FC}{\"u}
8545 \DeclareUnicodeCharacter{00FD}{\'y}
8546 \DeclareUnicodeCharacter{00FE}{\th}
8547 \DeclareUnicodeCharacter{00FF}{\"y}
8549 \DeclareUnicodeCharacter{0100}{\=A}
8550 \DeclareUnicodeCharacter{0101}{\=a}
8551 \DeclareUnicodeCharacter{0102}{\u{A}}
8552 \DeclareUnicodeCharacter{0103}{\u{a}}
8553 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8554 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8555 \DeclareUnicodeCharacter{0106}{\'C}
8556 \DeclareUnicodeCharacter{0107}{\'c}
8557 \DeclareUnicodeCharacter{0108}{\^C}
8558 \DeclareUnicodeCharacter{0109}{\^c}
8559 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8560 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8561 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8562 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8563 \DeclareUnicodeCharacter{010C}{\v{C}}
8564 \DeclareUnicodeCharacter{010D}{\v{c}}
8565 \DeclareUnicodeCharacter{010E}{\v{D}}
8567 \DeclareUnicodeCharacter{0112}{\=E}
8568 \DeclareUnicodeCharacter{0113}{\=e}
8569 \DeclareUnicodeCharacter{0114}{\u{E}}
8570 \DeclareUnicodeCharacter{0115}{\u{e}}
8571 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8572 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8573 \DeclareUnicodeCharacter{011A}{\v{E}}
8574 \DeclareUnicodeCharacter{011B}{\v{e}}
8575 \DeclareUnicodeCharacter{011C}{\^G}
8576 \DeclareUnicodeCharacter{011D}{\^g}
8577 \DeclareUnicodeCharacter{011E}{\u{G}}
8578 \DeclareUnicodeCharacter{011F}{\u{g}}
8580 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8581 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8582 \DeclareUnicodeCharacter{0124}{\^H}
8583 \DeclareUnicodeCharacter{0125}{\^h}
8584 \DeclareUnicodeCharacter{0128}{\~I}
8585 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8586 \DeclareUnicodeCharacter{012A}{\=I}
8587 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8588 \DeclareUnicodeCharacter{012C}{\u{I}}
8589 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8591 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8592 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8593 \DeclareUnicodeCharacter{0132}{IJ}
8594 \DeclareUnicodeCharacter{0133}{ij}
8595 \DeclareUnicodeCharacter{0134}{\^J}
8596 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8597 \DeclareUnicodeCharacter{0139}{\'L}
8598 \DeclareUnicodeCharacter{013A}{\'l}
8600 \DeclareUnicodeCharacter{0141}{\L}
8601 \DeclareUnicodeCharacter{0142}{\l}
8602 \DeclareUnicodeCharacter{0143}{\'N}
8603 \DeclareUnicodeCharacter{0144}{\'n}
8604 \DeclareUnicodeCharacter{0147}{\v{N}}
8605 \DeclareUnicodeCharacter{0148}{\v{n}}
8606 \DeclareUnicodeCharacter{014C}{\=O}
8607 \DeclareUnicodeCharacter{014D}{\=o}
8608 \DeclareUnicodeCharacter{014E}{\u{O}}
8609 \DeclareUnicodeCharacter{014F}{\u{o}}
8611 \DeclareUnicodeCharacter{0150}{\H{O}}
8612 \DeclareUnicodeCharacter{0151}{\H{o}}
8613 \DeclareUnicodeCharacter{0152}{\OE}
8614 \DeclareUnicodeCharacter{0153}{\oe}
8615 \DeclareUnicodeCharacter{0154}{\'R}
8616 \DeclareUnicodeCharacter{0155}{\'r}
8617 \DeclareUnicodeCharacter{0158}{\v{R}}
8618 \DeclareUnicodeCharacter{0159}{\v{r}}
8619 \DeclareUnicodeCharacter{015A}{\'S}
8620 \DeclareUnicodeCharacter{015B}{\'s}
8621 \DeclareUnicodeCharacter{015C}{\^S}
8622 \DeclareUnicodeCharacter{015D}{\^s}
8623 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8624 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8626 \DeclareUnicodeCharacter{0160}{\v{S}}
8627 \DeclareUnicodeCharacter{0161}{\v{s}}
8628 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8629 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8630 \DeclareUnicodeCharacter{0164}{\v{T}}
8632 \DeclareUnicodeCharacter{0168}{\~U}
8633 \DeclareUnicodeCharacter{0169}{\~u}
8634 \DeclareUnicodeCharacter{016A}{\=U}
8635 \DeclareUnicodeCharacter{016B}{\=u}
8636 \DeclareUnicodeCharacter{016C}{\u{U}}
8637 \DeclareUnicodeCharacter{016D}{\u{u}}
8638 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8639 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8641 \DeclareUnicodeCharacter{0170}{\H{U}}
8642 \DeclareUnicodeCharacter{0171}{\H{u}}
8643 \DeclareUnicodeCharacter{0174}{\^W}
8644 \DeclareUnicodeCharacter{0175}{\^w}
8645 \DeclareUnicodeCharacter{0176}{\^Y}
8646 \DeclareUnicodeCharacter{0177}{\^y}
8647 \DeclareUnicodeCharacter{0178}{\"Y}
8648 \DeclareUnicodeCharacter{0179}{\'Z}
8649 \DeclareUnicodeCharacter{017A}{\'z}
8650 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8651 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8652 \DeclareUnicodeCharacter{017D}{\v{Z}}
8653 \DeclareUnicodeCharacter{017E}{\v{z}}
8655 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8656 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8657 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8658 \DeclareUnicodeCharacter{01C7}{LJ}
8659 \DeclareUnicodeCharacter{01C8}{Lj}
8660 \DeclareUnicodeCharacter{01C9}{lj}
8661 \DeclareUnicodeCharacter{01CA}{NJ}
8662 \DeclareUnicodeCharacter{01CB}{Nj}
8663 \DeclareUnicodeCharacter{01CC}{nj}
8664 \DeclareUnicodeCharacter{01CD}{\v{A}}
8665 \DeclareUnicodeCharacter{01CE}{\v{a}}
8666 \DeclareUnicodeCharacter{01CF}{\v{I}}
8668 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8669 \DeclareUnicodeCharacter{01D1}{\v{O}}
8670 \DeclareUnicodeCharacter{01D2}{\v{o}}
8671 \DeclareUnicodeCharacter{01D3}{\v{U}}
8672 \DeclareUnicodeCharacter{01D4}{\v{u}}
8674 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8675 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8676 \DeclareUnicodeCharacter{01E6}{\v{G}}
8677 \DeclareUnicodeCharacter{01E7}{\v{g}}
8678 \DeclareUnicodeCharacter{01E8}{\v{K}}
8679 \DeclareUnicodeCharacter{01E9}{\v{k}}
8681 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8682 \DeclareUnicodeCharacter{01F1}{DZ}
8683 \DeclareUnicodeCharacter{01F2}{Dz}
8684 \DeclareUnicodeCharacter{01F3}{dz}
8685 \DeclareUnicodeCharacter{01F4}{\'G}
8686 \DeclareUnicodeCharacter{01F5}{\'g}
8687 \DeclareUnicodeCharacter{01F8}{\`N}
8688 \DeclareUnicodeCharacter{01F9}{\`n}
8689 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8690 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8691 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8692 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8694 \DeclareUnicodeCharacter{021E}{\v{H}}
8695 \DeclareUnicodeCharacter{021F}{\v{h}}
8697 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8698 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8699 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8700 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8701 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8702 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8704 \DeclareUnicodeCharacter{0232}{\=Y}
8705 \DeclareUnicodeCharacter{0233}{\=y}
8706 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8708 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8710 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8711 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8712 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8713 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8714 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8715 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8716 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8717 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8718 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8719 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8720 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8721 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8723 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8724 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8726 \DeclareUnicodeCharacter{1E20}{\=G}
8727 \DeclareUnicodeCharacter{1E21}{\=g}
8728 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8729 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8730 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8731 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8732 \DeclareUnicodeCharacter{1E26}{\"H}
8733 \DeclareUnicodeCharacter{1E27}{\"h}
8735 \DeclareUnicodeCharacter{1E30}{\'K}
8736 \DeclareUnicodeCharacter{1E31}{\'k}
8737 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8738 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8739 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8740 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8741 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8742 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8743 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8744 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8745 \DeclareUnicodeCharacter{1E3E}{\'M}
8746 \DeclareUnicodeCharacter{1E3F}{\'m}
8748 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8749 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8750 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8751 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8752 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8753 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8754 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8755 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8756 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8757 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8759 \DeclareUnicodeCharacter{1E54}{\'P}
8760 \DeclareUnicodeCharacter{1E55}{\'p}
8761 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8762 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8763 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8764 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8765 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8766 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8767 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8768 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8770 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8771 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8772 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8773 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8774 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8775 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8776 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8777 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8778 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8779 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8781 \DeclareUnicodeCharacter{1E7C}{\~V}
8782 \DeclareUnicodeCharacter{1E7D}{\~v}
8783 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8784 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8786 \DeclareUnicodeCharacter{1E80}{\`W}
8787 \DeclareUnicodeCharacter{1E81}{\`w}
8788 \DeclareUnicodeCharacter{1E82}{\'W}
8789 \DeclareUnicodeCharacter{1E83}{\'w}
8790 \DeclareUnicodeCharacter{1E84}{\"W}
8791 \DeclareUnicodeCharacter{1E85}{\"w}
8792 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8793 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8794 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8795 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8796 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8797 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8798 \DeclareUnicodeCharacter{1E8C}{\"X}
8799 \DeclareUnicodeCharacter{1E8D}{\"x}
8800 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8801 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8803 \DeclareUnicodeCharacter{1E90}{\^Z}
8804 \DeclareUnicodeCharacter{1E91}{\^z}
8805 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8806 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8807 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8808 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8809 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8810 \DeclareUnicodeCharacter{1E97}{\"t}
8811 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8812 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8814 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8815 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8817 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8818 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8819 \DeclareUnicodeCharacter{1EBC}{\~E}
8820 \DeclareUnicodeCharacter{1EBD}{\~e}
8822 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8823 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8824 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8825 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8827 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8828 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8830 \DeclareUnicodeCharacter{1EF2}{\`Y}
8831 \DeclareUnicodeCharacter{1EF3}{\`y}
8832 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8834 \DeclareUnicodeCharacter{1EF8}{\~Y}
8835 \DeclareUnicodeCharacter{1EF9}{\~y}
8837 \DeclareUnicodeCharacter{2013}{--}
8838 \DeclareUnicodeCharacter{2014}{---}
8839 \DeclareUnicodeCharacter{2018}{\quoteleft}
8840 \DeclareUnicodeCharacter{2019}{\quoteright}
8841 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8842 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8843 \DeclareUnicodeCharacter{201D}{\quotedblright}
8844 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8845 \DeclareUnicodeCharacter{2022}{\bullet}
8846 \DeclareUnicodeCharacter{2026}{\dots}
8847 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8848 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8849 \DeclareUnicodeCharacter{20AC}{\euro}
8851 \DeclareUnicodeCharacter{2192}{\expansion}
8852 \DeclareUnicodeCharacter{21D2}{\result}
8854 \DeclareUnicodeCharacter{2212}{\minus}
8855 \DeclareUnicodeCharacter{2217}{\point}
8856 \DeclareUnicodeCharacter{2261}{\equiv}
8857 }% end of \utfeightchardefs
8860 % US-ASCII character definitions.
8861 \def\asciichardefs{% nothing need be done
8865 % Make non-ASCII characters printable again for compatibility with
8866 % existing Texinfo documents that may use them, even without declaring a
8867 % document encoding.
8869 \setnonasciicharscatcode \other
8872 \message{formatting,}
8874 \newdimen\defaultparindent \defaultparindent = 15pt
8876 \chapheadingskip = 15pt plus 4pt minus 2pt
8877 \secheadingskip = 12pt plus 3pt minus 2pt
8878 \subsecheadingskip = 9pt plus 2pt minus 2pt
8880 % Prevent underfull vbox error messages.
8883 % Don't be so finicky about underfull hboxes, either.
8886 % Following George Bush, get rid of widows and orphans.
8890 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8891 % using an old version of TeX, don't do anything. We want the amount of
8892 % stretch added to depend on the line length, hence the dependence on
8893 % \hsize. We call this whenever the paper size is set.
8895 \def\setemergencystretch{%
8896 \ifx\emergencystretch\thisisundefined
8897 % Allow us to assign to \emergencystretch anyway.
8898 \def\emergencystretch{\dimen0}%
8900 \emergencystretch = .15\hsize
8904 % Parameters in order: 1) textheight; 2) textwidth;
8905 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8906 % 7) physical page height; 8) physical page width.
8908 % We also call \setleading{\textleading}, so the caller should define
8909 % \textleading. The caller should also set \parskip.
8911 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8914 \splittopskip = \topskip
8917 \advance\vsize by \topskip
8918 \outervsize = \vsize
8919 \advance\outervsize by 2\topandbottommargin
8920 \pageheight = \vsize
8923 \outerhsize = \hsize
8924 \advance\outerhsize by 0.5in
8927 \normaloffset = #4\relax
8928 \bindingoffset = #5\relax
8931 \pdfpageheight #7\relax
8932 \pdfpagewidth #8\relax
8933 % if we don't reset these, they will remain at "1 true in" of
8934 % whatever layout pdftex was dumped with.
8935 \pdfhorigin = 1 true in
8936 \pdfvorigin = 1 true in
8939 \setleading{\textleading}
8941 \parindent = \defaultparindent
8942 \setemergencystretch
8945 % @letterpaper (the default).
8946 \def\letterpaper{{\globaldefs = 1
8947 \parskip = 3pt plus 2pt minus 1pt
8948 \textleading = 13.2pt
8950 % If page is nothing but text, make it come out even.
8951 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8953 {\bindingoffset}{36pt}%
8957 % Use @smallbook to reset parameters for 7x9.25 trim size.
8958 \def\smallbook{{\globaldefs = 1
8959 \parskip = 2pt plus 1pt
8962 \internalpagesizes{7.5in}{5in}%
8964 {\bindingoffset}{16pt}%
8967 \lispnarrowing = 0.3in
8970 \contentsrightmargin = 0pt
8971 \defbodyindent = .5cm
8974 % Use @smallerbook to reset parameters for 6x9 trim size.
8975 % (Just testing, parameters still in flux.)
8976 \def\smallerbook{{\globaldefs = 1
8977 \parskip = 1.5pt plus 1pt
8980 \internalpagesizes{7.4in}{4.8in}%
8985 \lispnarrowing = 0.25in
8988 \contentsrightmargin = 0pt
8989 \defbodyindent = .4cm
8992 % Use @afourpaper to print on European A4 paper.
8993 \def\afourpaper{{\globaldefs = 1
8994 \parskip = 3pt plus 2pt minus 1pt
8995 \textleading = 13.2pt
8997 % Double-side printing via postscript on Laserjet 4050
8998 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8999 % To change the settings for a different printer or situation, adjust
9000 % \normaloffset until the front-side and back-side texts align. Then
9001 % do the same for \bindingoffset. You can set these for testing in
9002 % your texinfo source file like this:
9004 % \global\normaloffset = -6mm
9005 % \global\bindingoffset = 10mm
9007 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9008 {\voffset}{\hoffset}%
9009 {\bindingoffset}{44pt}%
9014 \contentsrightmargin = 0pt
9015 \defbodyindent = 5mm
9018 % Use @afivepaper to print on European A5 paper.
9019 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9020 % He also recommends making @example and @lisp be small.
9021 \def\afivepaper{{\globaldefs = 1
9022 \parskip = 2pt plus 1pt minus 0.1pt
9023 \textleading = 12.5pt
9025 \internalpagesizes{160mm}{120mm}%
9026 {\voffset}{\hoffset}%
9027 {\bindingoffset}{8pt}%
9030 \lispnarrowing = 0.2in
9033 \contentsrightmargin = 0pt
9034 \defbodyindent = 2mm
9038 % A specific text layout, 24x15cm overall, intended for A4 paper.
9039 \def\afourlatex{{\globaldefs = 1
9041 \internalpagesizes{237mm}{150mm}%
9043 {\bindingoffset}{7mm}%
9046 % Must explicitly reset to 0 because we call \afourpaper.
9050 % Use @afourwide to print on A4 paper in landscape format.
9051 \def\afourwide{{\globaldefs = 1
9053 \internalpagesizes{241mm}{165mm}%
9054 {\voffset}{-2.95mm}%
9055 {\bindingoffset}{7mm}%
9060 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9061 % Perhaps we should allow setting the margins, \topskip, \parskip,
9062 % and/or leading, also. Or perhaps we should compute them somehow.
9064 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9065 \def\pagesizesyyy#1,#2,#3\finish{{%
9066 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9069 \parskip = 3pt plus 2pt minus 1pt
9070 \setleading{\textleading}%
9073 \advance\dimen0 by \voffset
9076 \advance\dimen2 by \normaloffset
9078 \internalpagesizes{#1}{\hsize}%
9079 {\voffset}{\normaloffset}%
9080 {\bindingoffset}{44pt}%
9084 % Set default to letter.
9089 \message{and turning on texinfo input format.}
9091 % DEL is a comment character, in case @c does not suffice.
9094 % Define macros to output various characters with catcode for normal text.
9104 \def\normaldoublequote{"}
9107 \def\normalunderscore{_}
9108 \def\normalverticalbar{|}
9110 \def\normalgreater{>}
9112 \def\normaldollar{$}%$ font-lock fix
9114 % This macro is used to make a character print one way in \tt
9115 % (where it can probably be output as-is), and another way in other fonts,
9116 % where something hairier probably needs to be done.
9118 % #1 is what to print if we are indeed using \tt; #2 is what to print
9119 % otherwise. Since all the Computer Modern typewriter fonts have zero
9120 % interword stretch (and shrink), and it is reasonable to expect all
9121 % typewriter fonts to have this, we can check that font parameter.
9123 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9125 % Same as above, but check for italic font. Actually this also catches
9126 % non-italic slanted fonts since it is impossible to distinguish them from
9127 % italic fonts. But since this is only used by $ and it uses \sl anyway
9128 % this is not a problem.
9129 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9131 % Turn off all special characters except @
9132 % (and those which the user can use as if they were ordinary).
9133 % Most of these we simply print from the \tt font, but for some, we can
9134 % use math or other variants that look better in normal text.
9137 \def\activedoublequote{{\tt\char34}}
9138 \let"=\activedoublequote
9140 \def~{{\tt\char126}}
9146 \def_{\ifusingtt\normalunderscore\_}
9148 % Subroutine for the previous macro.
9149 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9152 \def|{{\tt\char124}}
9160 \def+{{\tt \char 43}}
9162 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9164 % If a .fmt file is being used, characters that might appear in a file
9165 % name cannot be active until we have parsed the command line.
9166 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9167 % \otherifyactive is called near the end of this file.
9168 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9170 % Used sometimes to turn off (effectively) the active characters even after
9172 \def\turnoffactive{%
9173 \normalturnoffactive
9179 % \backslashcurfont outputs one backslash character in current font,
9181 \global\chardef\backslashcurfont=`\\
9182 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9184 % \realbackslash is an actual character `\' with catcode other, and
9185 % \doublebackslash is two of them (for the pdf outlines).
9186 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9188 % In texinfo, backslash is an active character; it prints the backslash
9189 % in fixed width font.
9191 @def@normalbackslash{{@tt@backslashcurfont}}
9192 % On startup, @fixbackslash assigns:
9193 % @let \ = @normalbackslash
9195 % \rawbackslash defines an active \ to do \backslashcurfont.
9196 % \otherbackslash defines an active \ to be a literal `\' character with
9198 @gdef@rawbackslash{@let\=@backslashcurfont}
9199 @gdef@otherbackslash{@let\=@realbackslash}
9201 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9202 % the literal character `\'.
9204 @def@normalturnoffactive{%
9205 @let\=@normalbackslash
9206 @let"=@normaldoublequote
9209 @let_=@normalunderscore
9210 @let|=@normalverticalbar
9212 @let>=@normalgreater
9214 @let$=@normaldollar %$ font-lock fix
9215 @markupsetuplqdefault
9216 @markupsetuprqdefault
9220 % Make _ and + \other characters, temporarily.
9221 % This is canceled by @fixbackslash.
9224 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9225 % That is what \eatinput is for; after that, the `\' should revert to printing
9228 @gdef@eatinput input texinfo{@fixbackslash}
9229 @global@let\ = @eatinput
9231 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9232 % the first `\' in the file would cause an error. This macro tries to fix
9233 % that, assuming it is called before the first `\' could plausibly occur.
9234 % Also turn back on active characters that might appear in the input
9235 % file name, in case not using a pre-dumped format.
9237 @gdef@fixbackslash{%
9238 @ifx\@eatinput @let\ = @normalbackslash @fi
9243 % Say @foo, not \foo, in error messages.
9246 % These look ok in all fonts, so just make them not special.
9247 @catcode`@& = @other
9248 @catcode`@# = @other
9249 @catcode`@% = @other
9251 @c Finally, make ` and ' active, so that txicodequoteundirected and
9252 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9253 @c don't make ` and ' active, @code will not get them as active chars.
9254 @c Do this last of all since we use ` in the previous @catcode assignments.
9257 @markupsetuplqdefault
9258 @markupsetuprqdefault
9261 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9262 @c page-delimiter: "^\\\\message"
9263 @c time-stamp-start: "def\\\\texinfoversion{"
9264 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9265 @c time-stamp-end: "}"
9271 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115