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-08-14.15}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009 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 % except using rgb instead of cmyk; the latter is said to render as a
1337 % very dark gray on-screen and a very dark halftone in print, instead
1339 \def\rgbDarkRed{0.50 0.09 0.12}
1340 \def\rgbBlack{0 0 0}
1342 % k sets the color for filling (usual text, etc.);
1343 % K sets the color for stroking (thin rules, e.g., normal _'s).
1344 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1346 % Set color, and create a mark which defines \thiscolor accordingly,
1347 % so that \makeheadline knows which color to restore.
1349 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1354 \def\maincolor{\rgbBlack}
1355 \pdfsetcolor{\maincolor}
1356 \edef\thiscolor{\maincolor}
1357 \def\lastcolordefs{}
1361 \line{\pdfsetcolor{\maincolor}\the\footline}%
1369 % Extract \thiscolor definition from the marks.
1371 % Typeset the headline with \maincolor, then restore the color.
1372 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1380 \pdfcatalog{/PageMode /UseOutlines}
1382 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1383 \def\dopdfimage#1#2#3{%
1384 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1385 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1387 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1388 % others). Let's try in that order.
1389 \let\pdfimgext=\empty
1391 \openin 1 #1.png \ifeof 1
1392 \openin 1 #1.jpg \ifeof 1
1393 \openin 1 #1.jpeg \ifeof 1
1394 \openin 1 #1.JPG \ifeof 1
1395 \openin 1 #1.pdf \ifeof 1
1396 \openin 1 #1.PDF \ifeof 1
1397 \errhelp = \nopdfimagehelp
1398 \errmessage{Could not find image file #1 for pdf}%
1399 \else \gdef\pdfimgext{PDF}%
1401 \else \gdef\pdfimgext{pdf}%
1403 \else \gdef\pdfimgext{JPG}%
1405 \else \gdef\pdfimgext{jpeg}%
1407 \else \gdef\pdfimgext{jpg}%
1409 \else \gdef\pdfimgext{png}%
1414 % without \immediate, ancient pdftex seg faults when the same image is
1415 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1416 \ifnum\pdftexversion < 14
1419 \immediate\pdfximage
1421 \ifdim \wd0 >0pt width \imagewidth \fi
1422 \ifdim \wd2 >0pt height \imageheight \fi
1423 \ifnum\pdftexversion<13
1428 \ifnum\pdftexversion < 14 \else
1429 \pdfrefximage \pdflastximage
1433 % We have to set dummies so commands such as @code, and characters
1434 % such as \, aren't expanded when present in a section title.
1437 \activebackslashdouble
1438 \makevalueexpandable
1439 \def\pdfdestname{#1}%
1440 \backslashparens\pdfdestname
1441 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1444 % used to mark target names; must be expandable.
1447 % by default, use a color that is dark enough to print on paper as
1448 % nearly black, but still distinguishable for online viewing.
1449 \def\urlcolor{\rgbDarkRed}
1450 \def\linkcolor{\rgbDarkRed}
1451 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1453 % Adding outlines to PDF; macros for calculating structure of outlines
1454 % come from Petr Olsak
1455 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1456 \else \csname#1\endcsname \fi}
1457 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1458 \advance\tempnum by 1
1459 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1461 % #1 is the section text, which is what will be displayed in the
1462 % outline by the pdf viewer. #2 is the pdf expression for the number
1463 % of subentries (or empty, for subsubsections). #3 is the node text,
1464 % which might be empty if this toc entry had no corresponding node.
1465 % #4 is the page number
1467 \def\dopdfoutline#1#2#3#4{%
1468 % Generate a link to the node text if that exists; else, use the
1469 % page number. We could generate a destination for the section
1470 % text in the case where a section has no node, but it doesn't
1471 % seem worth the trouble, since most documents are normally structured.
1472 \def\pdfoutlinedest{#3}%
1473 \ifx\pdfoutlinedest\empty
1474 \def\pdfoutlinedest{#4}%
1476 % Doubled backslashes in the name.
1477 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1478 \backslashparens\pdfoutlinedest}%
1481 % Also double the backslashes in the display string.
1482 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1483 \backslashparens\pdfoutlinetext}%
1485 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1488 \def\pdfmakeoutlines{%
1490 % Thanh's hack / proper braces in bookmarks
1491 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1492 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1494 % Read toc silently, to get counts of subentries for \pdfoutline.
1495 \def\numchapentry##1##2##3##4{%
1496 \def\thischapnum{##2}%
1498 \def\thissubsecnum{0}%
1500 \def\numsecentry##1##2##3##4{%
1501 \advancenumber{chap\thischapnum}%
1502 \def\thissecnum{##2}%
1503 \def\thissubsecnum{0}%
1505 \def\numsubsecentry##1##2##3##4{%
1506 \advancenumber{sec\thissecnum}%
1507 \def\thissubsecnum{##2}%
1509 \def\numsubsubsecentry##1##2##3##4{%
1510 \advancenumber{subsec\thissubsecnum}%
1512 \def\thischapnum{0}%
1514 \def\thissubsecnum{0}%
1516 % use \def rather than \let here because we redefine \chapentry et
1517 % al. a second time, below.
1518 \def\appentry{\numchapentry}%
1519 \def\appsecentry{\numsecentry}%
1520 \def\appsubsecentry{\numsubsecentry}%
1521 \def\appsubsubsecentry{\numsubsubsecentry}%
1522 \def\unnchapentry{\numchapentry}%
1523 \def\unnsecentry{\numsecentry}%
1524 \def\unnsubsecentry{\numsubsecentry}%
1525 \def\unnsubsubsecentry{\numsubsubsecentry}%
1528 % Read toc second time, this time actually producing the outlines.
1529 % The `-' means take the \expnumber as the absolute number of
1530 % subentries, which we calculated on our first read of the .toc above.
1532 % We use the node names as the destinations.
1533 \def\numchapentry##1##2##3##4{%
1534 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1535 \def\numsecentry##1##2##3##4{%
1536 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1537 \def\numsubsecentry##1##2##3##4{%
1538 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1539 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1540 \dopdfoutline{##1}{}{##3}{##4}}%
1542 % PDF outlines are displayed using system fonts, instead of
1543 % document fonts. Therefore we cannot use special characters,
1544 % since the encoding is unknown. For example, the eogonek from
1545 % Latin 2 (0xea) gets translated to a | character. Info from
1546 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1548 % xx to do this right, we have to translate 8-bit characters to
1549 % their "best" equivalent, based on the @documentencoding. Right
1550 % now, I guess we'll just let the pdf reader have its way.
1553 \catcode`\\=\active \otherbackslash
1554 \input \tocreadfilename
1558 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1559 \ifx\PP\D\let\nextsp\relax
1560 \else\let\nextsp\skipspaces
1561 \ifx\p\space\else\addtokens{\filename}{\PP}%
1562 \advance\filenamelength by 1
1566 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1567 \ifnum\pdftexversion < 14
1568 \let \startlink \pdfannotlink
1570 \let \startlink \pdfstartlink
1572 % make a live url in pdf output.
1575 % it seems we really need yet another set of dummies; have not
1576 % tried to figure out what each command should do in the context
1577 % of @url. for now, just make @/ a no-op, that's the only one
1578 % people have actually reported a problem with.
1580 \normalturnoffactive
1583 \makevalueexpandable
1584 % do we want to go so far as to use \indexnofonts instead of just
1585 % special-casing \var here?
1588 \leavevmode\setcolor{\urlcolor}%
1589 \startlink attr{/Border [0 0 0]}%
1590 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1592 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1593 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1594 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1595 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1597 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1599 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1600 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1601 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1603 \ifnum0=\countA\else\makelink\fi
1604 \ifx\first.\let\next=\done\else
1606 \addtokens{\toksB}{\the\toksD}
1607 \ifx\first,\addtokens{\toksB}{\space}\fi
1609 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1611 \def\makelink{\addtokens{\toksB}%
1612 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1614 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1615 \setcolor{\linkcolor}#1\endlink}
1616 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1619 \let\pdfmkdest = \gobble
1620 \let\pdfurl = \gobble
1621 \let\endlink = \relax
1622 \let\setcolor = \gobble
1623 \let\pdfsetcolor = \gobble
1624 \let\pdfmakeoutlines = \relax
1625 \fi % \ifx\pdfoutput
1630 % Change the current font style to #1, remembering it in \curfontstyle.
1631 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1632 % italics, not bold italics.
1634 \def\setfontstyle#1{%
1635 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1636 \csname ten#1\endcsname % change the current font
1639 % Select #1 fonts with the current style.
1641 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1643 \def\rm{\fam=0 \setfontstyle{rm}}
1644 \def\it{\fam=\itfam \setfontstyle{it}}
1645 \def\sl{\fam=\slfam \setfontstyle{sl}}
1646 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1647 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1649 % Unfortunately, we have to override this for titles and the like, since
1650 % in those cases "rm" is bold. Sigh.
1651 \def\rmisbold{\rm\def\curfontstyle{bf}}
1653 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1654 % So we set up a \sf.
1656 \def\sf{\fam=\sffam \setfontstyle{sf}}
1657 \let\li = \sf % Sometimes we call it \li, not \sf.
1659 % We don't need math for this font style.
1660 \def\ttsl{\setfontstyle{ttsl}}
1664 \newdimen\textleading \textleading = 13.2pt
1666 % Set the baselineskip to #1, and the lineskip and strut size
1667 % correspondingly. There is no deep meaning behind these magic numbers
1668 % used as factors; they just match (closely enough) what Knuth defined.
1670 \def\lineskipfactor{.08333}
1671 \def\strutheightpercent{.70833}
1672 \def\strutdepthpercent {.29167}
1674 % can get a sort of poor man's double spacing by redefining this.
1675 \def\baselinefactor{1}
1679 \normalbaselineskip = \baselinefactor\dimen0
1680 \normallineskip = \lineskipfactor\normalbaselineskip
1682 \setbox\strutbox =\hbox{%
1683 \vrule width0pt height\strutheightpercent\baselineskip
1684 depth \strutdepthpercent \baselineskip
1688 % PDF CMaps. See also LaTeX's t1.cmap.
1690 % do nothing with this by default.
1691 \expandafter\let\csname cmapOT1\endcsname\gobble
1692 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1693 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1695 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1696 % (\pdffontattr was introduced many years ago, but people still run
1697 % older pdftex's; it's easy to conditionalize, so we do.)
1698 \ifpdf \ifx\pdffontattr\undefined \else
1700 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1701 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1702 %%DocumentNeededResources: ProcSet (CIDInit)
1703 %%IncludeResource: ProcSet (CIDInit)
1704 %%BeginResource: CMap (TeX-OT1-0)
1705 %%Title: (TeX-OT1-0 TeX OT1 0)
1708 /CIDInit /ProcSet findresource begin
1716 /CMapName /TeX-OT1-0 def
1718 1 begincodespacerange
1774 CMapName currentdict /CMap defineresource pop
1780 \expandafter\edef\csname cmapOT1\endcsname#1{%
1781 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1786 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1787 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1788 %%DocumentNeededResources: ProcSet (CIDInit)
1789 %%IncludeResource: ProcSet (CIDInit)
1790 %%BeginResource: CMap (TeX-OT1IT-0)
1791 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1794 /CIDInit /ProcSet findresource begin
1802 /CMapName /TeX-OT1IT-0 def
1804 1 begincodespacerange
1862 CMapName currentdict /CMap defineresource pop
1868 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1869 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1874 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1875 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1876 %%DocumentNeededResources: ProcSet (CIDInit)
1877 %%IncludeResource: ProcSet (CIDInit)
1878 %%BeginResource: CMap (TeX-OT1TT-0)
1879 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1882 /CIDInit /ProcSet findresource begin
1890 /CMapName /TeX-OT1TT-0 def
1892 1 begincodespacerange
1937 CMapName currentdict /CMap defineresource pop
1943 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1944 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1949 % Set the font macro #1 to the font named #2, adding on the
1950 % specified font prefix (normally `cm').
1951 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1952 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1954 \def\setfont#1#2#3#4#5{%
1955 \font#1=\fontprefix#2#3 scaled #4
1956 \csname cmap#5\endcsname#1%
1958 % This is what gets called when #5 of \setfont is empty.
1960 % emacs-page end of cmaps
1962 % Use cm as the default font prefix.
1963 % To specify the font prefix, you must define \fontprefix
1964 % before you read in texinfo.tex.
1965 \ifx\fontprefix\undefined
1968 % Support font families that don't use the same naming scheme as CM.
1970 \def\rmbshape{bx} %where the normal face is bold
1975 \def\ttslshape{sltt}
1985 % Definitions for a main text size of 11pt. This is the default in
1988 \def\definetextfontsizexi{%
1989 % Text fonts (11.2pt, magstep1).
1990 \def\textnominalsize{11pt}
1991 \edef\mainmagstep{\magstephalf}
1992 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1993 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1994 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1995 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1996 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1997 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1998 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1999 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2000 \font\texti=cmmi10 scaled \mainmagstep
2001 \font\textsy=cmsy10 scaled \mainmagstep
2002 \def\textecsize{1095}
2004 % A few fonts for @defun names and args.
2005 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2006 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2007 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2008 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2010 % Fonts for indices, footnotes, small examples (9pt).
2011 \def\smallnominalsize{9pt}
2012 \setfont\smallrm\rmshape{9}{1000}{OT1}
2013 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2014 \setfont\smallbf\bfshape{10}{900}{OT1}
2015 \setfont\smallit\itshape{9}{1000}{OT1IT}
2016 \setfont\smallsl\slshape{9}{1000}{OT1}
2017 \setfont\smallsf\sfshape{9}{1000}{OT1}
2018 \setfont\smallsc\scshape{10}{900}{OT1}
2019 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2022 \def\smallecsize{0900}
2024 % Fonts for small examples (8pt).
2025 \def\smallernominalsize{8pt}
2026 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2027 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2028 \setfont\smallerbf\bfshape{10}{800}{OT1}
2029 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2030 \setfont\smallersl\slshape{8}{1000}{OT1}
2031 \setfont\smallersf\sfshape{8}{1000}{OT1}
2032 \setfont\smallersc\scshape{10}{800}{OT1}
2033 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2034 \font\smalleri=cmmi8
2035 \font\smallersy=cmsy8
2036 \def\smallerecsize{0800}
2038 % Fonts for title page (20.4pt):
2039 \def\titlenominalsize{20pt}
2040 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2041 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2042 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2043 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2044 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2045 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2046 \let\titlebf=\titlerm
2047 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2048 \font\titlei=cmmi12 scaled \magstep3
2049 \font\titlesy=cmsy10 scaled \magstep4
2050 \def\titleecsize{2074}
2052 % Chapter (and unnumbered) fonts (17.28pt).
2053 \def\chapnominalsize{17pt}
2054 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2055 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2056 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2057 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2058 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2059 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2061 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2062 \font\chapi=cmmi12 scaled \magstep2
2063 \font\chapsy=cmsy10 scaled \magstep3
2064 \def\chapecsize{1728}
2066 % Section fonts (14.4pt).
2067 \def\secnominalsize{14pt}
2068 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2069 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2070 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2071 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2072 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2073 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2075 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2076 \font\seci=cmmi12 scaled \magstep1
2077 \font\secsy=cmsy10 scaled \magstep2
2078 \def\sececsize{1440}
2080 % Subsection fonts (13.15pt).
2081 \def\ssecnominalsize{13pt}
2082 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2083 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2084 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2085 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2086 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2087 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2089 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2090 \font\sseci=cmmi12 scaled \magstephalf
2091 \font\ssecsy=cmsy10 scaled 1315
2092 \def\ssececsize{1200}
2094 % Reduced fonts for @acro in text (10pt).
2095 \def\reducednominalsize{10pt}
2096 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2097 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2098 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2099 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2100 \setfont\reducedsl\slshape{10}{1000}{OT1}
2101 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2102 \setfont\reducedsc\scshape{10}{1000}{OT1}
2103 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2104 \font\reducedi=cmmi10
2105 \font\reducedsy=cmsy10
2106 \def\reducedecsize{1000}
2108 % reset the current fonts
2111 } % end of 11pt text font size definitions
2114 % Definitions to make the main text be 10pt Computer Modern, with
2115 % section, chapter, etc., sizes following suit. This is for the GNU
2116 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2117 % future. Used with @smallbook, which sets the leading to 12pt.
2119 \def\definetextfontsizex{%
2120 % Text fonts (10pt).
2121 \def\textnominalsize{10pt}
2122 \edef\mainmagstep{1000}
2123 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2124 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2125 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2126 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2127 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2128 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2129 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2130 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2131 \font\texti=cmmi10 scaled \mainmagstep
2132 \font\textsy=cmsy10 scaled \mainmagstep
2133 \def\textecsize{1000}
2135 % A few fonts for @defun names and args.
2136 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2137 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2138 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2140 % Fonts for indices, footnotes, small examples (9pt).
2141 \def\smallnominalsize{9pt}
2142 \setfont\smallrm\rmshape{9}{1000}{OT1}
2143 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2144 \setfont\smallbf\bfshape{10}{900}{OT1}
2145 \setfont\smallit\itshape{9}{1000}{OT1IT}
2146 \setfont\smallsl\slshape{9}{1000}{OT1}
2147 \setfont\smallsf\sfshape{9}{1000}{OT1}
2148 \setfont\smallsc\scshape{10}{900}{OT1}
2149 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2152 \def\smallecsize{0900}
2154 % Fonts for small examples (8pt).
2155 \def\smallernominalsize{8pt}
2156 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2157 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2158 \setfont\smallerbf\bfshape{10}{800}{OT1}
2159 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2160 \setfont\smallersl\slshape{8}{1000}{OT1}
2161 \setfont\smallersf\sfshape{8}{1000}{OT1}
2162 \setfont\smallersc\scshape{10}{800}{OT1}
2163 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2164 \font\smalleri=cmmi8
2165 \font\smallersy=cmsy8
2166 \def\smallerecsize{0800}
2168 % Fonts for title page (20.4pt):
2169 \def\titlenominalsize{20pt}
2170 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2171 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2172 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2173 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2174 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2175 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2176 \let\titlebf=\titlerm
2177 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2178 \font\titlei=cmmi12 scaled \magstep3
2179 \font\titlesy=cmsy10 scaled \magstep4
2180 \def\titleecsize{2074}
2182 % Chapter fonts (14.4pt).
2183 \def\chapnominalsize{14pt}
2184 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2185 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2186 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2187 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2188 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2189 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2191 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2192 \font\chapi=cmmi12 scaled \magstep1
2193 \font\chapsy=cmsy10 scaled \magstep2
2194 \def\chapecsize{1440}
2196 % Section fonts (12pt).
2197 \def\secnominalsize{12pt}
2198 \setfont\secrm\rmbshape{12}{1000}{OT1}
2199 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2200 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2201 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2202 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2203 \setfont\secsf\sfbshape{12}{1000}{OT1}
2205 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2207 \font\secsy=cmsy10 scaled \magstep1
2208 \def\sececsize{1200}
2210 % Subsection fonts (10pt).
2211 \def\ssecnominalsize{10pt}
2212 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2213 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2214 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2215 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2216 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2217 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2219 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2222 \def\ssececsize{1000}
2224 % Reduced fonts for @acro in text (9pt).
2225 \def\reducednominalsize{9pt}
2226 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2227 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2228 \setfont\reducedbf\bfshape{10}{900}{OT1}
2229 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2230 \setfont\reducedsl\slshape{9}{1000}{OT1}
2231 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2232 \setfont\reducedsc\scshape{10}{900}{OT1}
2233 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2234 \font\reducedi=cmmi9
2235 \font\reducedsy=cmsy9
2236 \def\reducedecsize{0900}
2238 % reduce space between paragraphs
2239 \divide\parskip by 2
2241 % reset the current fonts
2244 } % end of 10pt text font size definitions
2247 % We provide the user-level command
2249 % (or 11) to redefine the text font size. pt is assumed.
2254 \parseargdef\fonttextsize{%
2255 \def\textsizearg{#1}%
2256 \wlog{doing @fonttextsize \textsizearg}%
2258 % Set \globaldefs so that documents can use this inside @tex, since
2259 % makeinfo 4.8 does not support it, but we need it nonetheless.
2261 \begingroup \globaldefs=1
2262 \ifx\textsizearg\xword \definetextfontsizex
2263 \else \ifx\textsizearg\xiword \definetextfontsizexi
2266 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2272 % In order for the font changes to affect most math symbols and letters,
2273 % we have to define the \textfont of the standard families. Since
2274 % texinfo doesn't allow for producing subscripts and superscripts except
2275 % in the main text, we don't bother to reset \scriptfont and
2276 % \scriptscriptfont (which would also require loading a lot more fonts).
2278 \def\resetmathfonts{%
2279 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2280 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2281 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2284 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2285 % of just \STYLE. We do this because \STYLE needs to also set the
2286 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2287 % \tenSTYLE to set the current font.
2289 % Each font-changing command also sets the names \lsize (one size lower)
2290 % and \lllsize (three sizes lower). These relative commands are used in
2291 % the LaTeX logo and acronyms.
2293 % This all needs generalizing, badly.
2296 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2297 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2298 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2299 \let\tenttsl=\textttsl
2300 \def\curfontsize{text}%
2301 \def\lsize{reduced}\def\lllsize{smaller}%
2302 \resetmathfonts \setleading{\textleading}}
2304 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2305 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2306 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2307 \let\tenttsl=\titlettsl
2308 \def\curfontsize{title}%
2309 \def\lsize{chap}\def\lllsize{subsec}%
2310 \resetmathfonts \setleading{25pt}}
2311 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2313 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2314 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2315 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2316 \let\tenttsl=\chapttsl
2317 \def\curfontsize{chap}%
2318 \def\lsize{sec}\def\lllsize{text}%
2319 \resetmathfonts \setleading{19pt}}
2321 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2322 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2323 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2324 \let\tenttsl=\secttsl
2325 \def\curfontsize{sec}%
2326 \def\lsize{subsec}\def\lllsize{reduced}%
2327 \resetmathfonts \setleading{16pt}}
2329 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2330 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2331 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2332 \let\tenttsl=\ssecttsl
2333 \def\curfontsize{ssec}%
2334 \def\lsize{text}\def\lllsize{small}%
2335 \resetmathfonts \setleading{15pt}}
2336 \let\subsubsecfonts = \subsecfonts
2338 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2339 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2340 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2341 \let\tenttsl=\reducedttsl
2342 \def\curfontsize{reduced}%
2343 \def\lsize{small}\def\lllsize{smaller}%
2344 \resetmathfonts \setleading{10.5pt}}
2346 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2347 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2348 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2349 \let\tenttsl=\smallttsl
2350 \def\curfontsize{small}%
2351 \def\lsize{smaller}\def\lllsize{smaller}%
2352 \resetmathfonts \setleading{10.5pt}}
2354 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2355 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2356 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2357 \let\tenttsl=\smallerttsl
2358 \def\curfontsize{smaller}%
2359 \def\lsize{smaller}\def\lllsize{smaller}%
2360 \resetmathfonts \setleading{9.5pt}}
2362 % Fonts for short table of contents.
2363 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2364 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2365 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2366 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2368 % Define these just so they can be easily changed for other fonts.
2369 \def\angleleft{$\langle$}
2370 \def\angleright{$\rangle$}
2372 % Set the fonts to use with the @small... environments.
2373 \let\smallexamplefonts = \smallfonts
2375 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2376 % can fit this many characters:
2377 % 8.5x11=86 smallbook=72 a4=90 a5=69
2378 % If we use \scriptfonts (8pt), then we can fit this many characters:
2379 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2380 % For me, subjectively, the few extra characters that fit aren't worth
2381 % the additional smallness of 8pt. So I'm making the default 9pt.
2383 % By the way, for comparison, here's what fits with @example (10pt):
2384 % 8.5x11=71 smallbook=60 a4=75 a5=58
2387 % Set up the default fonts, so we can use them for creating boxes.
2389 \definetextfontsizexi
2394 % Check if we are currently using a typewriter font. Since all the
2395 % Computer Modern typewriter fonts have zero interword stretch (and
2396 % shrink), and it is reasonable to expect all typewriter fonts to have
2397 % this property, we can check that font parameter.
2399 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2401 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2402 % define and register \INITMACRO to be called on markup style changes.
2403 % \INITMACRO can check \currentmarkupstyle for the innermost
2404 % style and the set of \ifmarkupSTYLE switches for all styles
2405 % currently in effect.
2409 %\newif\ifmarkupfile % @file == @samp.
2410 %\newif\ifmarkupoption % @option == @samp.
2413 %\newif\ifmarkupenv % @env == @code.
2414 %\newif\ifmarkupcommand % @command == @code.
2415 \newif\ifmarkuptex % @tex (and part of @math, for now).
2416 \newif\ifmarkupexample
2418 \newif\ifmarkupverbatim
2420 \let\currentmarkupstyle\empty
2422 \def\setupmarkupstyle#1{%
2423 \csname markup#1true\endcsname
2424 \def\currentmarkupstyle{#1}%
2428 \let\markupstylesetup\empty
2430 \def\defmarkupstylesetup#1{%
2431 \expandafter\def\expandafter\markupstylesetup
2432 \expandafter{\markupstylesetup #1}%
2436 % Markup style setup for left and right quotes.
2437 \defmarkupstylesetup\markupsetuplq{%
2438 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2439 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2442 \defmarkupstylesetup\markupsetuprq{%
2443 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2444 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2451 \gdef\markupsetuplqdefault{\let`\lq}
2452 \gdef\markupsetuprqdefault{\let'\rq}
2454 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2455 \gdef\markupsetcodequoteright{\let'\codequoteright}
2457 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2460 \let\markupsetuplqcode \markupsetcodequoteleft
2461 \let\markupsetuprqcode \markupsetcodequoteright
2462 \let\markupsetuplqexample \markupsetcodequoteleft
2463 \let\markupsetuprqexample \markupsetcodequoteright
2464 \let\markupsetuplqverb \markupsetcodequoteleft
2465 \let\markupsetuprqverb \markupsetcodequoteright
2466 \let\markupsetuplqverbatim \markupsetcodequoteleft
2467 \let\markupsetuprqverbatim \markupsetcodequoteright
2469 \let\markupsetuplqsamp \markupsetnoligaturesquoteleft
2470 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2472 % Allow an option to not replace quotes with a regular directed right
2473 % quote/apostrophe (char 0x27), but instead use the undirected quote
2474 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2475 % the default, but it works for pasting with more pdf viewers (at least
2476 % evince), the lilypond developers report. xpdf does work with the
2479 \def\codequoteright{%
2480 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2481 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2487 % and a similar option for the left quote char vs. a grave accent.
2488 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2489 % the code environments to do likewise.
2491 \def\codequoteleft{%
2492 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2493 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2494 % [Knuth] pp. 380,381,391
2495 % \relax disables Spanish ligatures ?` and !` of \tt font.
2501 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2502 \def\noligaturesquoteleft{\relax\lq}
2504 % Count depth in font-changes, for error checks
2505 \newcount\fontdepth \fontdepth=0
2507 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2508 %% serif) and @ii for TeX italic
2510 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2511 % unless the following character is such as not to need one.
2512 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2513 \ptexslash\fi\fi\fi}
2514 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2515 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2517 % like \smartslanted except unconditionally uses \ttsl.
2518 % @var is set to this for defun arguments.
2519 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2521 % @cite is like \smartslanted except unconditionally use \sl. We never want
2522 % ttsl for book titles, do we?
2523 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2526 \let\slanted=\smartslanted
2527 \def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}}
2528 \let\dfn=\smartslanted
2529 \let\emph=\smartitalic
2531 % Explicit font changes: @r, @sc, undocumented @ii.
2532 \def\r#1{{\rm #1}} % roman font
2533 \def\sc#1{{\smallcaps#1}} % smallcaps font
2534 \def\ii#1{{\it #1}} % italic font
2536 % @b, explicit bold. Also @strong.
2540 % @sansserif, explicit sans.
2541 \def\sansserif#1{{\sf #1}}
2543 % We can't just use \exhyphenpenalty, because that only has effect at
2544 % the end of a paragraph. Restore normal hyphenation at the end of the
2545 % group within which \nohyphenation is presumably called.
2547 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2548 \def\restorehyphenation{\hyphenchar\font = `- }
2550 % Set sfcode to normal for the chars that usually have another value.
2551 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2552 % sometimes \x has an active definition that messes things up.
2555 \def\plainfrenchspacing{%
2556 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2557 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2558 \def\endofsentencespacefactor{1000}% for @. and friends
2560 \def\plainnonfrenchspacing{%
2561 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2562 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2563 \def\endofsentencespacefactor{3000}% for @. and friends
2566 \def\endofsentencespacefactor{3000}% default
2568 % @t, explicit typewriter.
2570 {\tt \rawbackslash \plainfrenchspacing #1}%
2575 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2577 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2578 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2580 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2581 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2582 % \vbox{\hrule\kern-0.4pt
2583 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2584 % \kern-0.4pt\hrule}%
2585 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2587 % definition of @key with no lozenge. If the current font is already
2588 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2589 % if it isn't monospace, then use \tt.
2591 \def\key#1{{\setupmarkupstyle{key}%
2593 \ifmonospace\else\tt\fi
2596 % ctrl is no longer a Texinfo command.
2597 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2599 % @file, @option are the same as @samp.
2603 % @code is a modification of @t,
2604 % which makes spaces the same size as normal in the surrounding text.
2607 % Change normal interword space to be same as for the current font.
2608 \spaceskip = \fontdimen2\font
2610 % Switch to typewriter.
2613 % But `\ ' produces the large typewriter interword space.
2614 \def\ {{\spaceskip = 0pt{} }}%
2616 % Turn off hyphenation.
2626 % We *must* turn on hyphenation at `-' and `_' in @code.
2627 % Otherwise, it is too hard to avoid overfull hboxes
2628 % in the Emacs manual, the Library manual, etc.
2630 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2631 % both hyphenation at - and hyphenation within words.
2632 % We must therefore turn them both off (\tclose does that)
2633 % and arrange explicitly to hyphenate at a dash.
2636 \catcode`\-=\active \catcode`\_=\active
2637 \catcode`\'=\active \catcode`\`=\active
2638 \global\let'=\rq \global\let`=\lq % default definitions
2640 \global\def\code{\begingroup
2641 \setupmarkupstyle{code}%
2642 % The following should really be moved into \setupmarkupstyle handlers.
2643 \catcode\dashChar=\active \catcode\underChar=\active
2656 \def\codedash{-\discretionary{}{}{}}
2658 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2659 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2660 % will therefore expand the active definition of _, which is us
2661 % (inside @code that is), therefore an endless loop.
2663 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2664 \else\normalunderscore \fi
2665 \discretionary{}{}{}}%
2668 \def\codex #1{\tclose{#1}\endgroup}
2670 % An additional complication: the above will allow breaks after, e.g.,
2671 % each of the four underscores in __typeof__. This is undesirable in
2672 % some manuals, especially if they don't have long identifiers in
2673 % general. @allowcodebreaks provides a way to control this.
2675 \newif\ifallowcodebreaks \allowcodebreakstrue
2677 \def\keywordtrue{true}
2678 \def\keywordfalse{false}
2680 \parseargdef\allowcodebreaks{%
2682 \ifx\txiarg\keywordtrue
2683 \allowcodebreakstrue
2684 \else\ifx\txiarg\keywordfalse
2685 \allowcodebreaksfalse
2687 \errhelp = \EMsimple
2688 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2692 % @kbd is like @code, except that if the argument is just one @key command,
2693 % then @kbd has no effect.
2694 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2696 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2697 % `example' (@kbd uses ttsl only inside of @example and friends),
2698 % or `code' (@kbd uses normal tty font always).
2699 \parseargdef\kbdinputstyle{%
2701 \ifx\txiarg\worddistinct
2702 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2703 \else\ifx\txiarg\wordexample
2704 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2705 \else\ifx\txiarg\wordcode
2706 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2708 \errhelp = \EMsimple
2709 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2712 \def\worddistinct{distinct}
2713 \def\wordexample{example}
2716 % Default is `distinct'.
2717 \kbdinputstyle distinct
2720 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2721 \ifx\one\xkey\ifx\threex\three \key{#2}%
2722 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2723 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2725 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2726 \let\indicateurl=\code
2730 % @clicksequence{File @click{} Open ...}
2731 \def\clicksequence#1{\begingroup #1\endgroup}
2733 % @clickstyle @arrow (by default)
2734 \parseargdef\clickstyle{\def\click{#1}}
2737 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2738 % second argument specifying the text to display and an optional third
2739 % arg as text to display instead of (rather than in addition to) the url
2740 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2741 % a hypertex \special here.
2743 \def\uref#1{\douref #1,,,\finish}
2744 \def\douref#1,#2,#3,#4\finish{\begingroup
2747 \setbox0 = \hbox{\ignorespaces #3}%
2749 \unhbox0 % third arg given, show only that
2751 \setbox0 = \hbox{\ignorespaces #2}%
2754 \unhbox0 % PDF: 2nd arg given, show only it
2756 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2759 \code{#1}% only url given, so show it
2765 % @url synonym for @uref, since that's how everyone uses it.
2769 % rms does not like angle brackets --karl, 17may97.
2770 % So now @email is just like @uref, unless we are pdf.
2772 %\def\email#1{\angleleft{\tt #1}\angleright}
2774 \def\email#1{\doemail#1,,\finish}
2775 \def\doemail#1,#2,#3\finish{\begingroup
2778 \setbox0 = \hbox{\ignorespaces #2}%
2779 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2786 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2787 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2789 \def\dmn#1{\thinspace #1}
2791 % @l was never documented to mean ``switch to the Lisp font'',
2792 % and it is not used as such in any manual I can find. We need it for
2793 % Polish suppressed-l. --karl, 22sep96.
2794 %\def\l#1{{\li #1}\null}
2796 % @acronym for "FBI", "NATO", and the like.
2797 % We print this one point size smaller, since it's intended for
2800 \def\acronym#1{\doacronym #1,,\finish}
2801 \def\doacronym#1,#2,#3\finish{%
2802 {\selectfonts\lsize #1}%
2804 \ifx\temp\empty \else
2805 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2809 % @abbr for "Comput. J." and the like.
2810 % No font change, but don't do end-of-sentence spacing.
2812 \def\abbr#1{\doabbr #1,,\finish}
2813 \def\doabbr#1,#2,#3\finish{%
2814 {\plainfrenchspacing #1}%
2816 \ifx\temp\empty \else
2817 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2824 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2826 % Since these characters are used in examples, they should be an even number of
2827 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2830 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2831 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2832 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2833 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2834 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2836 % The @error{} command.
2837 % Adapted from the TeXbook's \boxit.
2841 {\tentt \global\dimen0 = 3em}% Width of the box.
2842 \dimen2 = .55pt % Thickness of rules
2843 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2844 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2846 \setbox\errorbox=\hbox to \dimen0{\hfil
2847 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2848 \advance\hsize by -2\dimen2 % Rules.
2850 \hrule height\dimen2
2851 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2852 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2853 \kern3pt\vrule width\dimen2}% Space to right.
2854 \hrule height\dimen2}
2857 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2859 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2861 \def\pounds{{\it\$}}
2863 % @euro{} comes from a separate font, depending on the current style.
2864 % We use the free feym* fonts from the eurosym package by Henrik
2865 % Theiling, which support regular, slanted, bold and bold slanted (and
2866 % "outlined" (blackboard board, sort of) versions, which we don't need).
2867 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2869 % Although only regular is the truly official Euro symbol, we ignore
2870 % that. The Euro is designed to be slightly taller than the regular
2876 % feybo - bold slanted
2878 % There is no good (free) typewriter version, to my knowledge.
2879 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2882 % Also doesn't work in math. Do we need to do math with euro symbols?
2886 \def\euro{{\eurofont e}}
2888 % We set the font at each command, rather than predefining it in
2889 % \textfonts and the other font-switching commands, so that
2890 % installations which never need the symbol don't have to have the
2893 % There is only one designed size (nominal 10pt), so we always scale
2894 % that to the current nominal size.
2896 % By the way, simply using "at 1em" works for cmr10 and the like, but
2897 % does not work for cmbx10 and other extended/shrunken fonts.
2899 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2901 \ifx\curfontstyle\bfstylename
2903 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2906 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2911 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2912 % sometimes we redefine the original macro, and the alias should reflect
2915 % Use LaTeX names for the Icelandic letters.
2916 \def\DH{{\ecfont \char"D0}} % Eth
2917 \def\dh{{\ecfont \char"F0}} % eth
2918 \def\TH{{\ecfont \char"DE}} % Thorn
2919 \def\th{{\ecfont \char"FE}} % thorn
2921 \def\guillemetleft{{\ecfont \char"13}}
2922 \def\guillemotleft{\guillemetleft}
2923 \def\guillemetright{{\ecfont \char"14}}
2924 \def\guillemotright{\guillemetright}
2925 \def\guilsinglleft{{\ecfont \char"0E}}
2926 \def\guilsinglright{{\ecfont \char"0F}}
2927 \def\quotedblbase{{\ecfont \char"12}}
2928 \def\quotesinglbase{{\ecfont \char"0D}}
2930 % This positioning is not perfect (see the ogonek LaTeX package), but
2931 % we have the precomposed glyphs for the most common cases. We put the
2932 % tests to use those glyphs in the single \ogonek macro so we have fewer
2933 % dummy definitions to worry about for index entries, etc.
2935 % ogonek is also used with other letters in Lithuanian (IOU), but using
2936 % the precomposed glyphs for those is not so easy since they aren't in
2940 \ifx\temp\macrocharA\Aogonek
2941 \else\ifx\temp\macrochara\aogonek
2942 \else\ifx\temp\macrocharE\Eogonek
2943 \else\ifx\temp\macrochare\eogonek
2945 \ecfont \setbox0=\hbox{#1}%
2946 \ifdim\ht0=1ex\accent"0C #1%
2947 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2952 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2953 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2954 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2955 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2957 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2959 % We can't distinguish serif/sans and italic/slanted, but this
2960 % is used for crude hacks anyway (like adding French and German
2961 % quotes to documents typeset with CM, where we lose kerning), so
2962 % hopefully nobody will notice/care.
2963 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2964 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2965 \ifx\curfontstyle\bfstylename
2967 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2970 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2975 % @registeredsymbol - R in a circle. The font for the R should really
2976 % be smaller yet, but lllsize is the best we can do for now.
2977 % Adapted from the plain.tex definition of \copyright.
2979 \def\registeredsymbol{%
2980 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2985 % @textdegree - the normal degrees sign.
2987 \def\textdegree{$^\circ$}
2989 % Laurent Siebenmann reports \Orb undefined with:
2990 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2991 % so we'll define it if necessary.
2994 \def\Orb{\mathhexbox20D}
2998 \chardef\quotedblleft="5C
2999 \chardef\quotedblright=`\"
3000 \chardef\quoteleft=`\`
3001 \chardef\quoteright=`\'
3004 \message{page headings,}
3006 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3007 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3009 % First the title page. Must do @settitle before @titlepage.
3011 \newif\iffinishedtitlepage
3013 % Do an implicit @contents or @shortcontents after @end titlepage if the
3014 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3016 \newif\ifsetcontentsaftertitlepage
3017 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3018 \newif\ifsetshortcontentsaftertitlepage
3019 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3021 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3022 \endgroup\page\hbox{}\page}
3025 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3027 \parindent=0pt \textfonts
3028 % Leave some space at the very top of the page.
3029 \vglue\titlepagetopglue
3030 % No rule at page bottom unless we print one at the top with @title.
3031 \finishedtitlepagetrue
3033 % Most title ``pages'' are actually two pages long, with space
3034 % at the top of the second. We don't want the ragged left on the second.
3035 \let\oldpage = \page
3037 \iffinishedtitlepage\else
3040 \let\page = \oldpage
3047 \iffinishedtitlepage\else
3050 % It is important to do the page break before ending the group,
3051 % because the headline and footline are only empty inside the group.
3052 % If we use the new definition of \page, we always get a blank page
3053 % after the title page, which we certainly don't want.
3057 % Need this before the \...aftertitlepage checks so that if they are
3058 % in effect the toc pages will come out with page numbers.
3061 % If they want short, they certainly want long too.
3062 \ifsetshortcontentsaftertitlepage
3065 \global\let\shortcontents = \relax
3066 \global\let\contents = \relax
3069 \ifsetcontentsaftertitlepage
3071 \global\let\contents = \relax
3072 \global\let\shortcontents = \relax
3076 \def\finishtitlepage{%
3077 \vskip4pt \hrule height 2pt width \hsize
3078 \vskip\titlepagebottomglue
3079 \finishedtitlepagetrue
3082 %%% Macros to be used within @titlepage:
3084 \let\subtitlerm=\tenrm
3085 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3087 \parseargdef\title{%
3089 \leftline{\titlefonts\rmisbold #1}
3090 % print a rule at the page bottom also.
3091 \finishedtitlepagefalse
3092 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3095 \parseargdef\subtitle{%
3097 {\subtitlefont \rightline{#1}}%
3100 % @author should come last, but may come many times.
3101 % It can also be used inside @quotation.
3103 \parseargdef\author{%
3104 \def\temp{\quotation}%
3106 \def\quotationauthor{#1}% printed in \Equotation.
3109 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3110 {\secfonts\rmisbold \leftline{#1}}%
3115 %%% Set up page headings and footings.
3117 \let\thispage=\folio
3119 \newtoks\evenheadline % headline on even pages
3120 \newtoks\oddheadline % headline on odd pages
3121 \newtoks\evenfootline % footline on even pages
3122 \newtoks\oddfootline % footline on odd pages
3124 % Now make TeX use those variables
3125 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3126 \else \the\evenheadline \fi}}
3127 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3128 \else \the\evenfootline \fi}\HEADINGShook}
3129 \let\HEADINGShook=\relax
3131 % Commands to set those variables.
3132 % For example, this is what @headings on does
3133 % @evenheading @thistitle|@thispage|@thischapter
3134 % @oddheading @thischapter|@thispage|@thistitle
3135 % @evenfooting @thisfile||
3136 % @oddfooting ||@thisfile
3139 \def\evenheading{\parsearg\evenheadingxxx}
3140 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3141 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3142 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3144 \def\oddheading{\parsearg\oddheadingxxx}
3145 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3146 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3147 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3149 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3151 \def\evenfooting{\parsearg\evenfootingxxx}
3152 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3153 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3154 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3156 \def\oddfooting{\parsearg\oddfootingxxx}
3157 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3158 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3159 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3161 % Leave some space for the footline. Hopefully ok to assume
3162 % @evenfooting will not be used by itself.
3163 \global\advance\pageheight by -12pt
3164 \global\advance\vsize by -12pt
3167 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3169 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3170 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3172 % The same set of arguments for:
3177 % @everyheadingmarks
3178 % @everyfootingmarks
3180 \def\evenheadingmarks{\headingmarks{even}{heading}}
3181 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3182 \def\evenfootingmarks{\headingmarks{even}{footing}}
3183 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3184 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3185 \headingmarks{odd}{heading}{#1} }
3186 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3187 \headingmarks{odd}{footing}{#1} }
3188 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3189 \def\headingmarks#1#2#3 {%
3190 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3191 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3194 \everyheadingmarks bottom
3195 \everyfootingmarks bottom
3197 % @headings double turns headings on for double-sided printing.
3198 % @headings single turns headings on for single-sided printing.
3199 % @headings off turns them off.
3200 % @headings on same as @headings double, retained for compatibility.
3201 % @headings after turns on double-sided headings after this page.
3202 % @headings doubleafter turns on double-sided headings after this page.
3203 % @headings singleafter turns on single-sided headings after this page.
3204 % By default, they are off at the start of a document,
3205 % and turned `on' after @end titlepage.
3207 \def\headings #1 {\csname HEADINGS#1\endcsname}
3210 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3211 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3213 % When we turn headings on, set the page number to 1.
3214 % For double-sided printing, put current file name in lower left corner,
3215 % chapter name on inside top of right hand pages, document
3216 % title on inside top of left hand pages, and page numbers on outside top
3217 % edge of all pages.
3218 \def\HEADINGSdouble{%
3220 \global\evenfootline={\hfil}
3221 \global\oddfootline={\hfil}
3222 \global\evenheadline={\line{\folio\hfil\thistitle}}
3223 \global\oddheadline={\line{\thischapter\hfil\folio}}
3224 \global\let\contentsalignmacro = \chapoddpage
3226 \let\contentsalignmacro = \chappager
3228 % For single-sided printing, chapter title goes across top left of page,
3229 % page number on top right.
3230 \def\HEADINGSsingle{%
3232 \global\evenfootline={\hfil}
3233 \global\oddfootline={\hfil}
3234 \global\evenheadline={\line{\thischapter\hfil\folio}}
3235 \global\oddheadline={\line{\thischapter\hfil\folio}}
3236 \global\let\contentsalignmacro = \chappager
3238 \def\HEADINGSon{\HEADINGSdouble}
3240 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3241 \let\HEADINGSdoubleafter=\HEADINGSafter
3242 \def\HEADINGSdoublex{%
3243 \global\evenfootline={\hfil}
3244 \global\oddfootline={\hfil}
3245 \global\evenheadline={\line{\folio\hfil\thistitle}}
3246 \global\oddheadline={\line{\thischapter\hfil\folio}}
3247 \global\let\contentsalignmacro = \chapoddpage
3250 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3251 \def\HEADINGSsinglex{%
3252 \global\evenfootline={\hfil}
3253 \global\oddfootline={\hfil}
3254 \global\evenheadline={\line{\thischapter\hfil\folio}}
3255 \global\oddheadline={\line{\thischapter\hfil\folio}}
3256 \global\let\contentsalignmacro = \chappager
3259 % Subroutines used in generating headings
3260 % This produces Day Month Year style of output.
3261 % Only define if not already defined, in case a txi-??.tex file has set
3262 % up a different format (e.g., txi-cs.tex does this).
3263 \ifx\today\undefined
3267 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3268 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3269 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3274 % @settitle line... specifies the title of the document, for headings.
3275 % It generates no output of its own.
3276 \def\thistitle{\putwordNoTitle}
3277 \def\settitle{\parsearg{\gdef\thistitle}}
3281 % Tables -- @table, @ftable, @vtable, @item(x).
3283 % default indentation of table text
3284 \newdimen\tableindent \tableindent=.8in
3285 % default indentation of @itemize and @enumerate text
3286 \newdimen\itemindent \itemindent=.3in
3287 % margin between end of table item and start of table text.
3288 \newdimen\itemmargin \itemmargin=.1in
3290 % used internally for \itemindent minus \itemmargin
3293 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3295 % They also define \itemindex
3296 % to index the item name in whatever manner is desired (perhaps none).
3298 \newif\ifitemxneedsnegativevskip
3300 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3302 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3303 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3305 \def\itemzzz #1{\begingroup %
3306 \advance\hsize by -\rightskip
3307 \advance\hsize by -\tableindent
3308 \setbox0=\hbox{\itemindicate{#1}}%
3310 \nobreak % This prevents a break before @itemx.
3312 % If the item text does not fit in the space we have, put it on a line
3313 % by itself, and do not allow a page break either before or after that
3314 % line. We do not start a paragraph here because then if the next
3315 % command is, e.g., @kindex, the whatsit would get put into the
3316 % horizontal list on a line by itself, resulting in extra blank space.
3317 \ifdim \wd0>\itemmax
3319 % Make this a paragraph so we get the \parskip glue and wrapping,
3320 % but leave it ragged-right.
3322 \advance\leftskip by-\tableindent
3323 \advance\hsize by\tableindent
3324 \advance\rightskip by0pt plus1fil
3325 \leavevmode\unhbox0\par
3328 % We're going to be starting a paragraph, but we don't want the
3329 % \parskip glue -- logically it's part of the @item we just started.
3330 \nobreak \vskip-\parskip
3332 % Stop a page break at the \parskip glue coming up. However, if
3333 % what follows is an environment such as @example, there will be no
3334 % \parskip glue; then the negative vskip we just inserted would
3335 % cause the example and the item to crash together. So we use this
3336 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3337 % \parskip glue after all. Section titles are handled this way also.
3341 \itemxneedsnegativevskipfalse
3343 % The item text fits into the space. Start a paragraph, so that the
3344 % following text (if any) will end up on the same line.
3346 % Do this with kerns and \unhbox so that if there is a footnote in
3347 % the item text, it can migrate to the main vertical list and
3348 % eventually be printed.
3349 \nobreak\kern-\tableindent
3350 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3352 \nobreak\kern\dimen0
3354 \itemxneedsnegativevskiptrue
3358 \def\item{\errmessage{@item while not in a list environment}}
3359 \def\itemx{\errmessage{@itemx while not in a list environment}}
3361 % @table, @ftable, @vtable.
3363 \let\itemindex\gobble
3367 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3368 \tablecheck{ftable}%
3371 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3372 \tablecheck{vtable}%
3375 \ifnum \the\catcode`\^^M=\active
3377 \errmessage{This command won't work in this context; perhaps the problem is
3378 that we are \inenvironment\thisenv}%
3379 \def\next{\doignore{#1}}%
3386 \def\itemindicate{#1}%
3391 \makevalueexpandable
3392 \edef\temp{\noexpand\tablez #1\space\space\space}%
3396 \def\tablez #1 #2 #3 #4\endtablez{%
3398 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3399 \ifnum 0#2>0 \tableindent=#2\mil \fi
3400 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3401 \itemmax=\tableindent
3402 \advance \itemmax by -\itemmargin
3403 \advance \leftskip by \tableindent
3404 \exdentamount=\tableindent
3406 \parskip = \smallskipamount
3407 \ifdim \parskip=0pt \parskip=2pt \fi
3408 \let\item = \internalBitem
3409 \let\itemx = \internalBitemx
3411 \def\Etable{\endgraf\afterenvbreak}
3414 \let\Eitemize\Etable
3415 \let\Eenumerate\Etable
3417 % This is the counter used by @enumerate, which is really @itemize
3421 \envdef\itemize{\parsearg\doitemize}
3425 \itemmax=\itemindent
3426 \advance\itemmax by -\itemmargin
3427 \advance\leftskip by \itemindent
3428 \exdentamount=\itemindent
3430 \parskip=\smallskipamount
3431 \ifdim\parskip=0pt \parskip=2pt \fi
3433 % Try typesetting the item mark that if the document erroneously says
3434 % something like @itemize @samp (intending @table), there's an error
3435 % right away at the @itemize. It's not the best error message in the
3436 % world, but it's better than leaving it to the @item. This means if
3437 % the user wants an empty mark, they have to say @w{} not just @w.
3438 \def\itemcontents{#1}%
3439 \setbox0 = \hbox{\itemcontents}%
3441 % @itemize with no arg is equivalent to @itemize @bullet.
3442 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3444 \let\item=\itemizeitem
3447 % Definition of @item while inside @itemize and @enumerate.
3450 \advance\itemno by 1 % for enumerations
3451 {\let\par=\endgraf \smallbreak}% reasonable place to break
3453 % If the document has an @itemize directly after a section title, a
3454 % \nobreak will be last on the list, and \sectionheading will have
3455 % done a \vskip-\parskip. In that case, we don't want to zero
3456 % parskip, or the item text will crash with the heading. On the
3457 % other hand, when there is normal text preceding the item (as there
3458 % usually is), we do want to zero parskip, or there would be too much
3459 % space. In that case, we won't have a \nobreak before. At least
3460 % that's the theory.
3461 \ifnum\lastpenalty<10000 \parskip=0in \fi
3463 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3465 \vadjust{\penalty 1200}}% not good to break after first line of item.
3469 % \splitoff TOKENS\endmark defines \first to be the first token in
3470 % TOKENS, and \rest to be the remainder.
3472 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3474 % Allow an optional argument of an uppercase letter, lowercase letter,
3475 % or number, to specify the first label in the enumerated list. No
3476 % argument is the same as `1'.
3478 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3479 \def\enumeratey #1 #2\endenumeratey{%
3480 % If we were given no argument, pretend we were given `1'.
3482 \ifx\thearg\empty \def\thearg{1}\fi
3484 % Detect if the argument is a single token. If so, it might be a
3485 % letter. Otherwise, the only valid thing it can be is a number.
3486 % (We will always have one token, because of the test we just made.
3487 % This is a good thing, since \splitoff doesn't work given nothing at
3488 % all -- the first parameter is undelimited.)
3489 \expandafter\splitoff\thearg\endmark
3491 % Only one token in the argument. It could still be anything.
3492 % A ``lowercase letter'' is one whose \lccode is nonzero.
3493 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3494 % not equal to itself.
3495 % Otherwise, we assume it's a number.
3497 % We need the \relax at the end of the \ifnum lines to stop TeX from
3498 % continuing to look for a <number>.
3500 \ifnum\lccode\expandafter`\thearg=0\relax
3501 \numericenumerate % a number (we hope)
3504 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3505 \lowercaseenumerate % lowercase letter
3507 \uppercaseenumerate % uppercase letter
3511 % Multiple tokens in the argument. We hope it's a number.
3516 % An @enumerate whose labels are integers. The starting integer is
3519 \def\numericenumerate{%
3521 \startenumeration{\the\itemno}%
3524 % The starting (lowercase) letter is in \thearg.
3525 \def\lowercaseenumerate{%
3526 \itemno = \expandafter`\thearg
3528 % Be sure we're not beyond the end of the alphabet.
3530 \errmessage{No more lowercase letters in @enumerate; get a bigger
3537 % The starting (uppercase) letter is in \thearg.
3538 \def\uppercaseenumerate{%
3539 \itemno = \expandafter`\thearg
3541 % Be sure we're not beyond the end of the alphabet.
3543 \errmessage{No more uppercase letters in @enumerate; get a bigger
3550 % Call \doitemize, adding a period to the first argument and supplying the
3551 % common last two arguments. Also subtract one from the initial value in
3552 % \itemno, since @item increments \itemno.
3554 \def\startenumeration#1{%
3555 \advance\itemno by -1
3556 \doitemize{#1.}\flushcr
3559 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3562 \def\alphaenumerate{\enumerate{a}}
3563 \def\capsenumerate{\enumerate{A}}
3564 \def\Ealphaenumerate{\Eenumerate}
3565 \def\Ecapsenumerate{\Eenumerate}
3568 % @multitable macros
3569 % Amy Hendrickson, 8/18/94, 3/6/96
3571 % @multitable ... @end multitable will make as many columns as desired.
3572 % Contents of each column will wrap at width given in preamble. Width
3573 % can be specified either with sample text given in a template line,
3574 % or in percent of \hsize, the current width of text on page.
3576 % Table can continue over pages but will only break between lines.
3580 % Either define widths of columns in terms of percent of \hsize:
3581 % @multitable @columnfractions .25 .3 .45
3584 % Numbers following @columnfractions are the percent of the total
3585 % current hsize to be used for each column. You may use as many
3586 % columns as desired.
3589 % Or use a template:
3590 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3592 % using the widest term desired in each column.
3594 % Each new table line starts with @item, each subsequent new column
3595 % starts with @tab. Empty columns may be produced by supplying @tab's
3596 % with nothing between them for as many times as empty columns are needed,
3597 % ie, @tab@tab@tab will produce two empty columns.
3599 % @item, @tab do not need to be on their own lines, but it will not hurt
3602 % Sample multitable:
3604 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3605 % @item first col stuff @tab second col stuff @tab third col
3612 % @item first col stuff @tab second col stuff
3613 % @tab Many paragraphs of text may be used in any column.
3615 % They will wrap at the width determined by the template.
3616 % @item@tab@tab This will be in third column.
3619 % Default dimensions may be reset by user.
3620 % @multitableparskip is vertical space between paragraphs in table.
3621 % @multitableparindent is paragraph indent in table.
3622 % @multitablecolmargin is horizontal space to be left between columns.
3623 % @multitablelinespace is space to leave between table items, baseline
3625 % 0pt means it depends on current normal line spacing.
3627 \newskip\multitableparskip
3628 \newskip\multitableparindent
3629 \newdimen\multitablecolspace
3630 \newskip\multitablelinespace
3631 \multitableparskip=0pt
3632 \multitableparindent=6pt
3633 \multitablecolspace=12pt
3634 \multitablelinespace=0pt
3636 % Macros used to set up halign preamble:
3638 \let\endsetuptable\relax
3639 \def\xendsetuptable{\endsetuptable}
3640 \let\columnfractions\relax
3641 \def\xcolumnfractions{\columnfractions}
3644 % #1 is the @columnfraction, usually a decimal number like .5, but might
3645 % be just 1. We just use it, whatever it is.
3647 \def\pickupwholefraction#1 {%
3648 \global\advance\colcount by 1
3649 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3656 \ifx\firstarg\xendsetuptable
3659 \ifx\firstarg\xcolumnfractions
3660 \global\setpercenttrue
3663 \let\go\pickupwholefraction
3665 \global\advance\colcount by 1
3666 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3667 % separator; typically that is always in the input, anyway.
3668 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3671 \ifx\go\pickupwholefraction
3672 % Put the argument back for the \pickupwholefraction call, so
3673 % we'll always have a period there to be parsed.
3674 \def\go{\pickupwholefraction#1}%
3676 \let\go = \setuptable
3682 % multitable-only commands.
3684 % @headitem starts a heading row, which we typeset in bold.
3685 % Assignments have to be global since we are inside the implicit group
3686 % of an alignment entry. \everycr resets \everytab so we don't have to
3687 % undo it ourselves.
3688 \def\headitemfont{\b}% for people to use in the template row; not changeable
3690 \checkenv\multitable
3692 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3693 \the\everytab % for the first item
3696 % A \tab used to include \hskip1sp. But then the space in a template
3697 % line is not enough. That is bad. So let's go back to just `&' until
3698 % we again encounter the problem the 1sp was intended to solve.
3699 % --karl, nathan@acm.org, 20apr99.
3700 \def\tab{\checkenv\multitable &\the\everytab}%
3702 % @multitable ... @end multitable definitions:
3704 \newtoks\everytab % insert after every tab.
3706 \envdef\multitable{%
3710 % @item within a multitable starts a normal row.
3711 % We use \def instead of \let so that if one of the multitable entries
3712 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3713 % \endtemplate) expanding \doitemize.
3718 \setmultitablespacing
3719 \parskip=\multitableparskip
3720 \parindent=\multitableparindent
3726 \global\everytab={}%
3727 \global\colcount=0 % Reset the column counter.
3728 % Check for saved footnotes, etc.
3730 % Keeps underfull box messages off when table breaks over pages.
3732 % Maybe so, but it also creates really weird page breaks when the
3733 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3734 % problem manifests itself, so it can be fixed for real --karl.
3738 \parsearg\domultitable
3740 \def\domultitable#1{%
3741 % To parse everything between @multitable and @item:
3742 \setuptable#1 \endsetuptable
3744 % This preamble sets up a generic column definition, which will
3745 % be used as many times as user calls for columns.
3746 % \vtop will set a single line and will also let text wrap and
3747 % continue for many paragraphs if desired.
3749 \global\advance\colcount by 1
3752 % Use the current \colcount to find the correct column width:
3753 \hsize=\expandafter\csname col\the\colcount\endcsname
3755 % In order to keep entries from bumping into each other
3756 % we will add a \leftskip of \multitablecolspace to all columns after
3759 % If a template has been used, we will add \multitablecolspace
3760 % to the width of each template entry.
3762 % If the user has set preamble in terms of percent of \hsize we will
3763 % use that dimension as the width of the column, and the \leftskip
3764 % will keep entries from bumping into each other. Table will start at
3765 % left margin and final column will justify at right margin.
3767 % Make sure we don't inherit \rightskip from the outer environment.
3770 % The first column will be indented with the surrounding text.
3771 \advance\hsize by\leftskip
3774 % If user has not set preamble in terms of percent of \hsize
3775 % we will advance \hsize by \multitablecolspace.
3776 \advance\hsize by \multitablecolspace
3778 % In either case we will make \leftskip=\multitablecolspace:
3779 \leftskip=\multitablecolspace
3781 % Ignoring space at the beginning and end avoids an occasional spurious
3782 % blank line, when TeX decides to break the line at the space before the
3783 % box from the multistrut, so the strut ends up on a line by itself.
3785 % @multitable @columnfractions .11 .89
3787 % @tab Legal holiday which is valid in major parts of the whole country.
3788 % Is automatically provided with highlighting sequences respectively
3789 % marking characters.
3790 \noindent\ignorespaces##\unskip\multistrut
3795 \egroup % end the \halign
3796 \global\setpercentfalse
3799 \def\setmultitablespacing{%
3800 \def\multistrut{\strut}% just use the standard line spacing
3802 % Compute \multitablelinespace (if not defined by user) for use in
3803 % \multitableparskip calculation. We used define \multistrut based on
3804 % this, but (ironically) that caused the spacing to be off.
3805 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3806 \ifdim\multitablelinespace=0pt
3807 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3808 \global\advance\multitablelinespace by-\ht0
3810 %% Test to see if parskip is larger than space between lines of
3811 %% table. If not, do nothing.
3812 %% If so, set to same dimension as multitablelinespace.
3813 \ifdim\multitableparskip>\multitablelinespace
3814 \global\multitableparskip=\multitablelinespace
3815 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3816 %% than skip between lines in the table.
3818 \ifdim\multitableparskip=0pt
3819 \global\multitableparskip=\multitablelinespace
3820 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3821 %% than skip between lines in the table.
3825 \message{conditionals,}
3827 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3828 % @ifnotxml always succeed. They currently do nothing; we don't
3829 % attempt to check whether the conditionals are properly nested. But we
3830 % have to remember that they are conditionals, so that @end doesn't
3831 % attempt to close an environment group.
3834 \expandafter\let\csname #1\endcsname = \relax
3835 \expandafter\let\csname iscond.#1\endcsname = 1
3838 \makecond{ifnotdocbook}
3839 \makecond{ifnothtml}
3840 \makecond{ifnotinfo}
3841 \makecond{ifnotplaintext}
3844 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3846 \def\direntry{\doignore{direntry}}
3847 \def\documentdescription{\doignore{documentdescription}}
3848 \def\docbook{\doignore{docbook}}
3849 \def\html{\doignore{html}}
3850 \def\ifdocbook{\doignore{ifdocbook}}
3851 \def\ifhtml{\doignore{ifhtml}}
3852 \def\ifinfo{\doignore{ifinfo}}
3853 \def\ifnottex{\doignore{ifnottex}}
3854 \def\ifplaintext{\doignore{ifplaintext}}
3855 \def\ifxml{\doignore{ifxml}}
3856 \def\ignore{\doignore{ignore}}
3857 \def\menu{\doignore{menu}}
3858 \def\xml{\doignore{xml}}
3860 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3862 % A count to remember the depth of nesting.
3863 \newcount\doignorecount
3865 \def\doignore#1{\begingroup
3866 % Scan in ``verbatim'' mode:
3868 \catcode`\@ = \other
3869 \catcode`\{ = \other
3870 \catcode`\} = \other
3872 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3875 % Count number of #1's that we've seen.
3878 % Swallow text until we reach the matching `@end #1'.
3882 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3885 \gdef\dodoignore#1{%
3886 % #1 contains the command name as a string, e.g., `ifinfo'.
3888 % Define a command to find the next `@end #1'.
3889 \long\def\doignoretext##1^^M@end #1{%
3890 \doignoretextyyy##1^^M@#1\_STOP_}%
3892 % And this command to find another #1 command, at the beginning of a
3893 % line. (Otherwise, we would consider a line `@c @ifset', for
3894 % example, to count as an @ifset for nesting.)
3895 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3897 % And now expand that command.
3902 \def\doignoreyyy#1{%
3904 \ifx\temp\empty % Nothing found.
3905 \let\next\doignoretextzzz
3906 \else % Found a nested condition, ...
3907 \advance\doignorecount by 1
3908 \let\next\doignoretextyyy % ..., look for another.
3909 % If we're here, #1 ends with ^^M\ifinfo (for example).
3911 \next #1% the token \_STOP_ is present just after this macro.
3914 % We have to swallow the remaining "\_STOP_".
3916 \def\doignoretextzzz#1{%
3917 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3918 \let\next\enddoignore
3919 \else % Still inside a nested condition.
3920 \advance\doignorecount by -1
3921 \let\next\doignoretext % Look for the next @end.
3926 % Finish off ignored text.
3928 % Ignore anything after the last `@end #1'; this matters in verbatim
3929 % environments, where otherwise the newline after an ignored conditional
3930 % would result in a blank line in the output.
3931 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3935 % @set VAR sets the variable VAR to an empty value.
3936 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3938 % Since we want to separate VAR from REST-OF-LINE (which might be
3939 % empty), we can't just use \parsearg; we have to insert a space of our
3940 % own to delimit the rest of the line, and then take it out again if we
3942 % We rely on the fact that \parsearg sets \catcode`\ =10.
3944 \parseargdef\set{\setyyy#1 \endsetyyy}
3945 \def\setyyy#1 #2\endsetyyy{%
3947 \makevalueexpandable
3949 \edef\next{\gdef\makecsname{SET#1}}%
3957 % Remove the trailing space \setxxx inserted.
3958 \def\setzzz#1 \endsetzzz{\next{#1}}
3960 % @clear VAR clears (i.e., unsets) the variable VAR.
3962 \parseargdef\clear{%
3964 \makevalueexpandable
3965 \global\expandafter\let\csname SET#1\endcsname=\relax
3969 % @value{foo} gets the text saved in variable foo.
3970 \def\value{\begingroup\makevalueexpandable\valuexxx}
3971 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3973 \catcode`\- = \active \catcode`\_ = \active
3975 \gdef\makevalueexpandable{%
3976 \let\value = \expandablevalue
3977 % We don't want these characters active, ...
3978 \catcode`\-=\other \catcode`\_=\other
3979 % ..., but we might end up with active ones in the argument if
3980 % we're called from @code, as @code{@value{foo-bar_}}, though.
3981 % So \let them to their normal equivalents.
3982 \let-\realdash \let_\normalunderscore
3986 % We have this subroutine so that we can handle at least some @value's
3987 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3988 % The command has to be fully expandable (if the variable is set), since
3989 % the result winds up in the index file. This means that if the
3990 % variable's value contains other Texinfo commands, it's almost certain
3991 % it will fail (although perhaps we could fix that with sufficient work
3992 % to do a one-level expansion on the result, instead of complete).
3994 \def\expandablevalue#1{%
3995 \expandafter\ifx\csname SET#1\endcsname\relax
3996 {[No value for ``#1'']}%
3997 \message{Variable `#1', used in @value, is not set.}%
3999 \csname SET#1\endcsname
4003 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4006 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4009 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4012 \makevalueexpandable
4014 \expandafter\ifx\csname SET#2\endcsname\relax
4015 #1% If not set, redefine \next.
4020 \def\ifsetfail{\doignore{ifset}}
4022 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4023 % defined with @set, or has been undefined with @clear.
4025 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4026 % above code: if the variable is not set, do nothing, if it is set,
4027 % then redefine \next to \ifclearfail.
4030 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4031 \def\ifclearfail{\doignore{ifclear}}
4033 % @dircategory CATEGORY -- specify a category of the dir file
4034 % which this file should belong to. Ignore this in TeX.
4035 \let\dircategory=\comment
4037 % @defininfoenclose.
4038 \let\definfoenclose=\comment
4042 % Index generation facilities
4044 % Define \newwrite to be identical to plain tex's \newwrite
4045 % except not \outer, so it can be used within macros and \if's.
4046 \edef\newwrite{\makecsname{ptexnewwrite}}
4048 % \newindex {foo} defines an index named foo.
4049 % It automatically defines \fooindex such that
4050 % \fooindex ...rest of line... puts an entry in the index foo.
4051 % It also defines \fooindfile to be the number of the output channel for
4052 % the file that accumulates this index. The file's extension is foo.
4053 % The name of an index should be no more than 2 characters long
4054 % for the sake of vms.
4058 \expandafter\newwrite \csname#1indfile\endcsname
4059 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4061 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4062 \noexpand\doindex{#1}}
4065 % @defindex foo == \newindex{foo}
4067 \def\defindex{\parsearg\newindex}
4069 % Define @defcodeindex, like @defindex except put all entries in @code.
4071 \def\defcodeindex{\parsearg\newcodeindex}
4073 \def\newcodeindex#1{%
4075 \expandafter\newwrite \csname#1indfile\endcsname
4076 \openout \csname#1indfile\endcsname \jobname.#1
4078 \expandafter\xdef\csname#1index\endcsname{%
4079 \noexpand\docodeindex{#1}}%
4083 % @synindex foo bar makes index foo feed into index bar.
4084 % Do this instead of @defindex foo if you don't want it as a separate index.
4086 % @syncodeindex foo bar similar, but put all entries made for index foo
4089 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4090 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4092 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4093 % #3 the target index (bar).
4094 \def\dosynindex#1#2#3{%
4095 % Only do \closeout if we haven't already done it, else we'll end up
4096 % closing the target index.
4097 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4098 % The \closeout helps reduce unnecessary open files; the limit on the
4099 % Acorn RISC OS is a mere 16 files.
4100 \expandafter\closeout\csname#2indfile\endcsname
4101 \expandafter\let\csname donesynindex#2\endcsname = 1
4103 % redefine \fooindfile:
4104 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4105 \expandafter\let\csname#2indfile\endcsname=\temp
4106 % redefine \fooindex:
4107 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4110 % Define \doindex, the driver for all \fooindex macros.
4111 % Argument #1 is generated by the calling \fooindex macro,
4112 % and it is "foo", the name of the index.
4114 % \doindex just uses \parsearg; it calls \doind for the actual work.
4115 % This is because \doind is more useful to call from other macros.
4117 % There is also \dosubind {index}{topic}{subtopic}
4118 % which makes an entry in a two-level index such as the operation index.
4120 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4121 \def\singleindexer #1{\doind{\indexname}{#1}}
4123 % like the previous two, but they put @code around the argument.
4124 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4125 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4127 % Take care of Texinfo commands that can appear in an index entry.
4128 % Since there are some commands we want to expand, and others we don't,
4129 % we have to laboriously prevent expansion for those that we don't.
4132 \escapechar = `\\ % use backslash in output files.
4133 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4134 \def\ {\realbackslash\space }%
4136 % Need these in case \tex is in effect and \{ is a \delimiter again.
4137 % But can't use \lbracecmd and \rbracecmd because texindex assumes
4138 % braces and backslashes are used only as delimiters.
4142 % I don't entirely understand this, but when an index entry is
4143 % generated from a macro call, the \endinput which \scanmacro inserts
4144 % causes processing to be prematurely terminated. This is,
4145 % apparently, because \indexsorttmp is fully expanded, and \endinput
4146 % is an expandable command. The redefinition below makes \endinput
4147 % disappear altogether for that purpose -- although logging shows that
4148 % processing continues to some further point. On the other hand, it
4149 % seems \endinput does not hurt in the printed index arg, since that
4150 % is still getting written without apparent harm.
4152 % Sample source (mac-idx3.tex, reported by Graham Percival to
4153 % help-texinfo, 22may06):
4154 % @macro funindex {WORD}
4158 % @funindex commtest
4160 % The above is not enough to reproduce the bug, but it gives the flavor.
4162 % Sample whatsit resulting:
4163 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4166 \let\endinput = \empty
4168 % Do the redefinitions.
4172 % For the aux and toc files, @ is the escape character. So we want to
4173 % redefine everything using @ as the escape character (instead of
4174 % \realbackslash, still used for index files). When everything uses @,
4175 % this will be simpler.
4180 \let\{ = \lbraceatcmd
4181 \let\} = \rbraceatcmd
4183 % Do the redefinitions.
4188 % Called from \indexdummies and \atdummies.
4190 \def\commondummies{%
4192 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4193 % preventing its expansion. This is used only for control% words,
4194 % not control letters, because the \space would be incorrect for
4195 % control characters, but is needed to separate the control word
4196 % from whatever follows.
4198 % For control letters, we have \definedummyletter, which omits the
4201 % These can be used both for control words that take an argument and
4202 % those that do not. If it is followed by {arg} in the input, then
4203 % that will dutifully get written to the index (or wherever).
4205 \def\definedummyword ##1{\def##1{\string##1\space}}%
4206 \def\definedummyletter##1{\def##1{\string##1}}%
4207 \let\definedummyaccent\definedummyletter
4209 \commondummiesnofonts
4211 \definedummyletter\_%
4213 % Non-English letters.
4224 \definedummyword\exclamdown
4228 \definedummyword\ordf
4229 \definedummyword\ordm
4230 \definedummyword\questiondown
4234 % Although these internal commands shouldn't show up, sometimes they do.
4236 \definedummyword\gtr
4237 \definedummyword\hat
4238 \definedummyword\less
4241 \definedummyword\tclose
4244 \definedummyword\LaTeX
4245 \definedummyword\TeX
4247 % Assorted special characters.
4248 \definedummyword\bullet
4249 \definedummyword\comma
4250 \definedummyword\copyright
4251 \definedummyword\registeredsymbol
4252 \definedummyword\dots
4253 \definedummyword\enddots
4254 \definedummyword\equiv
4255 \definedummyword\error
4256 \definedummyword\euro
4257 \definedummyword\guillemetleft
4258 \definedummyword\guillemetright
4259 \definedummyword\guilsinglleft
4260 \definedummyword\guilsinglright
4261 \definedummyword\expansion
4262 \definedummyword\minus
4263 \definedummyword\ogonek
4264 \definedummyword\pounds
4265 \definedummyword\point
4266 \definedummyword\print
4267 \definedummyword\quotedblbase
4268 \definedummyword\quotedblleft
4269 \definedummyword\quotedblright
4270 \definedummyword\quoteleft
4271 \definedummyword\quoteright
4272 \definedummyword\quotesinglbase
4273 \definedummyword\result
4274 \definedummyword\textdegree
4276 % We want to disable all macros so that they are not expanded by \write.
4279 \normalturnoffactive
4281 % Handle some cases of @value -- where it does not contain any
4282 % (non-fully-expandable) commands.
4283 \makevalueexpandable
4286 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4288 \def\commondummiesnofonts{%
4289 % Control letters and accents.
4290 \definedummyletter\!%
4291 \definedummyaccent\"%
4292 \definedummyaccent\'%
4293 \definedummyletter\*%
4294 \definedummyaccent\,%
4295 \definedummyletter\.%
4296 \definedummyletter\/%
4297 \definedummyletter\:%
4298 \definedummyaccent\=%
4299 \definedummyletter\?%
4300 \definedummyaccent\^%
4301 \definedummyaccent\`%
4302 \definedummyaccent\~%
4306 \definedummyword\dotaccent
4307 \definedummyword\ogonek
4308 \definedummyword\ringaccent
4309 \definedummyword\tieaccent
4310 \definedummyword\ubaraccent
4311 \definedummyword\udotaccent
4312 \definedummyword\dotless
4314 % Texinfo font commands.
4321 % Commands that take arguments.
4322 \definedummyword\acronym
4323 \definedummyword\cite
4324 \definedummyword\code
4325 \definedummyword\command
4326 \definedummyword\dfn
4327 \definedummyword\email
4328 \definedummyword\emph
4329 \definedummyword\env
4330 \definedummyword\file
4331 \definedummyword\kbd
4332 \definedummyword\key
4333 \definedummyword\math
4334 \definedummyword\option
4335 \definedummyword\pxref
4336 \definedummyword\ref
4337 \definedummyword\samp
4338 \definedummyword\strong
4339 \definedummyword\tie
4340 \definedummyword\uref
4341 \definedummyword\url
4342 \definedummyword\var
4343 \definedummyword\verb
4345 \definedummyword\xref
4348 % \indexnofonts is used when outputting the strings to sort the index
4349 % by, and when constructing control sequence names. It eliminates all
4350 % control sequences and just writes whatever the best ASCII sort string
4351 % would be for a given command (usually its argument).
4354 % Accent commands should become @asis.
4355 \def\definedummyaccent##1{\let##1\asis}%
4356 % We can just ignore other control letters.
4357 \def\definedummyletter##1{\let##1\empty}%
4358 % Hopefully, all control words can become @asis.
4359 \let\definedummyword\definedummyaccent
4361 \commondummiesnofonts
4363 % Don't no-op \tt, since it isn't a user-level command
4364 % and is used in the definitions of the active chars like <, >, |, etc.
4365 % Likewise with the other plain tex font commands.
4370 % how to handle braces?
4371 \def\_{\normalunderscore}%
4373 % Non-English letters.
4390 \def\questiondown{?}%
4397 % Assorted special characters.
4398 % (The following {} will end up in the sort string, but that's ok.)
4399 \def\bullet{bullet}%
4401 \def\copyright{copyright}%
4407 \def\expansion{==>}%
4408 \def\guillemetleft{<<}%
4409 \def\guillemetright{>>}%
4410 \def\guilsinglleft{<}%
4411 \def\guilsinglright{>}%
4414 \def\pounds{pounds}%
4416 \def\quotedblbase{"}%
4417 \def\quotedblleft{"}%
4418 \def\quotedblright{"}%
4421 \def\quotesinglbase{,}%
4422 \def\registeredsymbol{R}%
4426 % We need to get rid of all macros, leaving only the arguments (if present).
4427 % Of course this is not nearly correct, but it is the best we can do for now.
4428 % makeinfo does not expand macros in the argument to @deffn, which ends up
4429 % writing an index entry, and texindex isn't prepared for an index sort entry
4430 % that starts with \.
4432 % Since macro invocations are followed by braces, we can just redefine them
4433 % to take a single TeX argument. The case of a macro invocation that
4434 % goes to end-of-line is not handled.
4439 \let\indexbackslash=0 %overridden during \printindex.
4440 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4442 % Most index entries go through here, but \dosubind is the general case.
4443 % #1 is the index name, #2 is the entry text.
4444 \def\doind#1#2{\dosubind{#1}{#2}{}}
4446 % Workhorse for all \fooindexes.
4447 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4448 % empty if called from \doind, as we usually are (the main exception
4449 % is with most defuns, which call us directly).
4451 \def\dosubind#1#2#3{%
4454 % Store the main index entry text (including the third arg).
4456 % If third arg is present, precede it with a space.
4458 \ifx\thirdarg\empty \else
4459 \toks0 = \expandafter{\the\toks0 \space #3}%
4462 \edef\writeto{\csname#1indfile\endcsname}%
4464 \safewhatsit\dosubindwrite
4469 % Write the entry in \toks0 to the index file:
4471 \def\dosubindwrite{%
4472 % Put the index entry in the margin if desired.
4473 \ifx\SETmarginindex\relax\else
4474 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4477 % Remember, we are within a group.
4478 \indexdummies % Must do this here, since \bf, etc expand at this stage
4479 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4480 % so it will be output as is; and it will print as backslash.
4482 % Process the index entry with all font commands turned off, to
4483 % get the string to sort by.
4485 \edef\temp{\the\toks0}% need full expansion
4486 \xdef\indexsorttmp{\temp}%
4489 % Set up the complete index entry, with both the sort key and
4490 % the original text, including any font commands. We write
4491 % three arguments to \entry to the .?? file (four in the
4492 % subentry case), texindex reduces to two when writing the .??s
4496 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4501 % Take care of unwanted page breaks/skips around a whatsit:
4503 % If a skip is the last thing on the list now, preserve it
4504 % by backing up by \lastskip, doing the \write, then inserting
4505 % the skip again. Otherwise, the whatsit generated by the
4506 % \write or \pdfdest will make \lastskip zero. The result is that
4507 % sequences like this:
4511 % will have extra space inserted, because the \medbreak in the
4512 % start of the @defun won't see the skip inserted by the @end of
4513 % the previous defun.
4515 % But don't do any of this if we're not in vertical mode. We
4516 % don't want to do a \vskip and prematurely end a paragraph.
4518 % Avoid page breaks due to these extra skips, too.
4520 % But wait, there is a catch there:
4521 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4522 % sufficient for this purpose, as it ignores stretch and shrink parts
4523 % of the skip. The only way seems to be to check the textual
4524 % representation of the skip.
4526 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4527 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4529 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4531 \newskip\whatsitskip
4532 \newcount\whatsitpenalty
4536 \def\safewhatsit#1{%
4540 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4541 \whatsitskip = \lastskip
4542 \edef\lastskipmacro{\the\lastskip}%
4543 \whatsitpenalty = \lastpenalty
4545 % If \lastskip is nonzero, that means the last item was a
4546 % skip. And since a skip is discardable, that means this
4547 % -\whatsitskip glue we're inserting is preceded by a
4548 % non-discardable item, therefore it is not a potential
4549 % breakpoint, therefore no \nobreak needed.
4550 \ifx\lastskipmacro\zeroskipmacro
4557 \ifx\lastskipmacro\zeroskipmacro
4558 % If \lastskip was zero, perhaps the last item was a penalty, and
4559 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4560 % to re-insert the same penalty (values >10000 are used for various
4561 % signals); since we just inserted a non-discardable item, any
4562 % following glue (such as a \parskip) would be a breakpoint. For example:
4564 % @deffn deffn-whatever
4565 % @vindex index-whatever
4567 % would allow a break between the index-whatever whatsit
4568 % and the "Description." paragraph.
4569 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4571 % On the other hand, if we had a nonzero \lastskip,
4572 % this make-up glue would be preceded by a non-discardable item
4573 % (the whatsit from the \write), so we must insert a \nobreak.
4574 \nobreak\vskip\whatsitskip
4579 % The index entry written in the file actually looks like
4580 % \entry {sortstring}{page}{topic}
4582 % \entry {sortstring}{page}{topic}{subtopic}
4583 % The texindex program reads in these files and writes files
4584 % containing these kinds of lines:
4586 % before the first topic whose initial is c
4587 % \entry {topic}{pagelist}
4588 % for a topic that is used without subtopics
4590 % for the beginning of a topic that is used with subtopics
4591 % \secondary {subtopic}{pagelist}
4592 % for each subtopic.
4594 % Define the user-accessible indexing commands
4595 % @findex, @vindex, @kindex, @cindex.
4597 \def\findex {\fnindex}
4598 \def\kindex {\kyindex}
4599 \def\cindex {\cpindex}
4600 \def\vindex {\vrindex}
4601 \def\tindex {\tpindex}
4602 \def\pindex {\pgindex}
4604 \def\cindexsub {\begingroup\obeylines\cindexsub}
4606 \gdef\cindexsub "#1" #2^^M{\endgroup %
4607 \dosubind{cp}{#2}{#1}}}
4609 % Define the macros used in formatting output of the sorted index material.
4611 % @printindex causes a particular index (the ??s file) to get printed.
4612 % It does not print any chapter heading (usually an @unnumbered).
4614 \parseargdef\printindex{\begingroup
4615 \dobreak \chapheadingskip{10000}%
4620 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4622 % See if the index file exists and is nonempty.
4623 % Change catcode of @ here so that if the index file contains
4625 % as its first line, TeX doesn't complain about mismatched braces
4626 % (because it thinks @} is a control sequence).
4628 \openin 1 \jobname.#1s
4630 % \enddoublecolumns gets confused if there is no text in the index,
4631 % and it loses the chapter title and the aux file entries for the
4632 % index. The easiest way to prevent this problem is to make sure
4633 % there is some text.
4634 \putwordIndexNonexistent
4637 % If the index file exists but is empty, then \openin leaves \ifeof
4638 % false. We have to make TeX try to read something from the file, so
4639 % it can discover if there is anything in it.
4642 \putwordIndexIsEmpty
4644 % Index files are almost Texinfo source, but we use \ as the escape
4645 % character. It would be better to use @, but that's too big a change
4646 % to make right now.
4647 \def\indexbackslash{\backslashcurfont}%
4658 % These macros are used by the sorted index file itself.
4659 % Change them to control the appearance of the index.
4662 % Some minor font changes for the special characters.
4663 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4665 % Remove any glue we may have, we'll be inserting our own.
4668 % We like breaks before the index initials, so insert a bonus.
4670 \vskip 0pt plus 3\baselineskip
4672 \vskip 0pt plus -3\baselineskip
4674 % Typeset the initial. Making this add up to a whole number of
4675 % baselineskips increases the chance of the dots lining up from column
4676 % to column. It still won't often be perfect, because of the stretch
4677 % we need before each entry, but it's better.
4679 % No shrink because it confuses \balancecolumns.
4680 \vskip 1.67\baselineskip plus .5\baselineskip
4681 \leftline{\secbf #1}%
4682 % Do our best not to break after the initial.
4684 \vskip .33\baselineskip plus .1\baselineskip
4687 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4688 % then page number (#2) flushed to the right margin. It is used for index
4689 % and table of contents entries. The paragraph is indented by \leftskip.
4691 % A straightforward implementation would start like this:
4692 % \def\entry#1#2{...
4693 % But this freezes the catcodes in the argument, and can cause problems to
4694 % @code, which sets - active. This problem was fixed by a kludge---
4695 % ``-'' was active throughout whole index, but this isn't really right.
4697 % The right solution is to prevent \entry from swallowing the whole text.
4702 % Start a new paragraph if necessary, so our assignments below can't
4703 % affect previous text.
4706 % Do not fill out the last line with white space.
4709 % No extra space above this paragraph.
4712 % Do not prefer a separate line ending with a hyphen to fewer lines.
4713 \finalhyphendemerits = 0
4715 % \hangindent is only relevant when the entry text and page number
4716 % don't both fit on one line. In that case, bob suggests starting the
4717 % dots pretty far over on the line. Unfortunately, a large
4718 % indentation looks wrong when the entry text itself is broken across
4719 % lines. So we use a small indentation and put up with long leaders.
4721 % \hangafter is reset to 1 (which is the value we want) at the start
4722 % of each paragraph, so we need not do anything with that.
4725 % When the entry text needs to be broken, just fill out the first line
4727 \rightskip = 0pt plus1fil
4729 % A bit of stretch before each entry for the benefit of balancing
4733 % Swallow the left brace of the text (first parameter):
4734 \afterassignment\doentry
4738 \bgroup % Instead of the swallowed brace.
4740 \aftergroup\finishentry
4741 % And now comes the text of the entry.
4743 \def\finishentry#1{%
4744 % #1 is the page number.
4746 % The following is kludged to not output a line of dots in the index if
4747 % there are no page numbers. The next person who breaks this will be
4748 % cursed by a Unix daemon.
4749 \setbox\boxA = \hbox{#1}%
4750 \ifdim\wd\boxA = 0pt
4754 % If we must, put the page number on a line of its own, and fill out
4755 % this line with blank space. (The \hfil is overwhelmed with the
4756 % fill leaders glue in \indexdotfill if the page number does fit.)
4758 \null\nobreak\indexdotfill % Have leaders before the page number.
4760 % The `\ ' here is removed by the implicit \unskip that TeX does as
4761 % part of (the primitive) \par. Without it, a spurious underfull
4774 % Like plain.tex's \dotfill, except uses up at least 1 em.
4775 \def\indexdotfill{\cleaders
4776 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4778 \def\primary #1{\line{#1\hfil}}
4780 \newskip\secondaryindent \secondaryindent=0.5cm
4781 \def\secondary#1#2{{%
4786 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4788 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4795 % Define two-column mode, which we use to typeset indexes.
4796 % Adapted from the TeXbook, page 416, which is to say,
4797 % the manmac.tex format used to print the TeXbook itself.
4801 \newdimen\doublecolumnhsize
4803 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4804 % Grab any single-column material above us.
4807 % Here is a possibility not foreseen in manmac: if we accumulate a
4808 % whole lot of material, we might end up calling this \output
4809 % routine twice in a row (see the doublecol-lose test, which is
4810 % essentially a couple of indexes with @setchapternewpage off). In
4811 % that case we just ship out what is in \partialpage with the normal
4812 % output routine. Generally, \partialpage will be empty when this
4813 % runs and this will be a no-op. See the indexspread.tex test case.
4814 \ifvoid\partialpage \else
4815 \onepageout{\pagecontents\partialpage}%
4818 \global\setbox\partialpage = \vbox{%
4819 % Unvbox the main output page.
4821 \kern-\topskip \kern\baselineskip
4824 \eject % run that output routine to set \partialpage
4826 % Use the double-column output routine for subsequent pages.
4827 \output = {\doublecolumnout}%
4829 % Change the page size parameters. We could do this once outside this
4830 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4831 % format, but then we repeat the same computation. Repeating a couple
4832 % of assignments once per index is clearly meaningless for the
4833 % execution time, so we may as well do it in one place.
4835 % First we halve the line length, less a little for the gutter between
4836 % the columns. We compute the gutter based on the line length, so it
4837 % changes automatically with the paper format. The magic constant
4838 % below is chosen so that the gutter has the same value (well, +-<1pt)
4839 % as it did when we hard-coded it.
4841 % We put the result in a separate register, \doublecolumhsize, so we
4842 % can restore it in \pagesofar, after \hsize itself has (potentially)
4845 \doublecolumnhsize = \hsize
4846 \advance\doublecolumnhsize by -.04154\hsize
4847 \divide\doublecolumnhsize by 2
4848 \hsize = \doublecolumnhsize
4850 % Double the \vsize as well. (We don't need a separate register here,
4851 % since nobody clobbers \vsize.)
4855 % The double-column output routine for all double-column pages except
4858 \def\doublecolumnout{%
4859 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4860 % Get the available space for the double columns -- the normal
4861 % (undoubled) page height minus any material left over from the
4865 \advance\dimen@ by -\ht\partialpage
4867 % box0 will be the left-hand column, box2 the right.
4868 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4869 \onepageout\pagesofar
4871 \penalty\outputpenalty
4874 % Re-output the contents of the output page -- any previous material,
4875 % followed by the two boxes we just split, in box0 and box2.
4879 \hsize = \doublecolumnhsize
4880 \wd0=\hsize \wd2=\hsize
4881 \hbox to\pagewidth{\box0\hfil\box2}%
4884 % All done with double columns.
4885 \def\enddoublecolumns{%
4886 % The following penalty ensures that the page builder is exercised
4887 % _before_ we change the output routine. This is necessary in the
4888 % following situation:
4890 % The last section of the index consists only of a single entry.
4891 % Before this section, \pagetotal is less than \pagegoal, so no
4892 % break occurs before the last section starts. However, the last
4893 % section, consisting of \initial and the single \entry, does not
4894 % fit on the page and has to be broken off. Without the following
4895 % penalty the page builder will not be exercised until \eject
4896 % below, and by that time we'll already have changed the output
4897 % routine to the \balancecolumns version, so the next-to-last
4898 % double-column page will be processed with \balancecolumns, which
4899 % is wrong: The two columns will go to the main vertical list, with
4900 % the broken-off section in the recent contributions. As soon as
4901 % the output routine finishes, TeX starts reconsidering the page
4902 % break. The two columns and the broken-off section both fit on the
4903 % page, because the two columns now take up only half of the page
4904 % goal. When TeX sees \eject from below which follows the final
4905 % section, it invokes the new output routine that we've set after
4906 % \balancecolumns below; \onepageout will try to fit the two columns
4907 % and the final section into the vbox of \pageheight (see
4908 % \pagebody), causing an overfull box.
4910 % Note that glue won't work here, because glue does not exercise the
4911 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4915 % Split the last of the double-column material. Leave it on the
4916 % current page, no automatic page break.
4919 % If we end up splitting too much material for the current page,
4920 % though, there will be another page break right after this \output
4921 % invocation ends. Having called \balancecolumns once, we do not
4922 % want to call it again. Therefore, reset \output to its normal
4923 % definition right away. (We hope \balancecolumns will never be
4924 % called on to balance too much material, but if it is, this makes
4925 % the output somewhat more palatable.)
4926 \global\output = {\onepageout{\pagecontents\PAGE}}%
4929 \endgroup % started in \begindoublecolumns
4931 % \pagegoal was set to the doubled \vsize above, since we restarted
4932 % the current page. We're now back to normal single-column
4933 % typesetting, so reset \pagegoal to the normal \vsize (after the
4934 % \endgroup where \vsize got restored).
4938 % Called at the end of the double column material.
4939 \def\balancecolumns{%
4940 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4942 \advance\dimen@ by \topskip
4943 \advance\dimen@ by-\baselineskip
4944 \divide\dimen@ by 2 % target to split to
4945 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4946 \splittopskip = \topskip
4947 % Loop until we get a decent breakpoint.
4951 \global\setbox3 = \copy0
4952 \global\setbox1 = \vsplit3 to \dimen@
4954 \global\advance\dimen@ by 1pt
4957 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4958 \setbox0=\vbox to\dimen@{\unvbox1}%
4959 \setbox2=\vbox to\dimen@{\unvbox3}%
4963 \catcode`\@ = \other
4966 \message{sectioning,}
4967 % Chapters, sections, etc.
4969 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4970 % sections so that we can refer to them unambiguously in the pdf
4971 % outlines by their "section number". We avoid collisions with chapter
4972 % numbers by starting them at 10000. (If a document ever has 10000
4973 % chapters, we're in trouble anyway, I'm sure.)
4974 \newcount\unnumberedno \unnumberedno = 10000
4976 \newcount\secno \secno=0
4977 \newcount\subsecno \subsecno=0
4978 \newcount\subsubsecno \subsubsecno=0
4980 % This counter is funny since it counts through charcodes of letters A, B, ...
4981 \newcount\appendixno \appendixno = `\@
4983 % \def\appendixletter{\char\the\appendixno}
4984 % We do the following ugly conditional instead of the above simple
4985 % construct for the sake of pdftex, which needs the actual
4986 % letter in the expansion, not just typeset.
4988 \def\appendixletter{%
4989 \ifnum\appendixno=`A A%
4990 \else\ifnum\appendixno=`B B%
4991 \else\ifnum\appendixno=`C C%
4992 \else\ifnum\appendixno=`D D%
4993 \else\ifnum\appendixno=`E E%
4994 \else\ifnum\appendixno=`F F%
4995 \else\ifnum\appendixno=`G G%
4996 \else\ifnum\appendixno=`H H%
4997 \else\ifnum\appendixno=`I I%
4998 \else\ifnum\appendixno=`J J%
4999 \else\ifnum\appendixno=`K K%
5000 \else\ifnum\appendixno=`L L%
5001 \else\ifnum\appendixno=`M M%
5002 \else\ifnum\appendixno=`N N%
5003 \else\ifnum\appendixno=`O O%
5004 \else\ifnum\appendixno=`P P%
5005 \else\ifnum\appendixno=`Q Q%
5006 \else\ifnum\appendixno=`R R%
5007 \else\ifnum\appendixno=`S S%
5008 \else\ifnum\appendixno=`T T%
5009 \else\ifnum\appendixno=`U U%
5010 \else\ifnum\appendixno=`V V%
5011 \else\ifnum\appendixno=`W W%
5012 \else\ifnum\appendixno=`X X%
5013 \else\ifnum\appendixno=`Y Y%
5014 \else\ifnum\appendixno=`Z Z%
5015 % The \the is necessary, despite appearances, because \appendixletter is
5016 % expanded while writing the .toc file. \char\appendixno is not
5017 % expandable, thus it is written literally, thus all appendixes come out
5018 % with the same letter (or @) in the toc without it.
5019 \else\char\the\appendixno
5020 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5021 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5023 % Each @chapter defines these (using marks) as the number+name, number
5024 % and name of the chapter. Page headings and footings can use
5025 % these. @section does likewise.
5027 \def\thischapternum{}
5028 \def\thischaptername{}
5030 \def\thissectionnum{}
5031 \def\thissectionname{}
5033 \newcount\absseclevel % used to calculate proper heading level
5034 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5036 % @raisesections: treat @section as chapter, @subsection as section, etc.
5037 \def\raisesections{\global\advance\secbase by -1}
5038 \let\up=\raisesections % original BFox name
5040 % @lowersections: treat @chapter as section, @section as subsection, etc.
5041 \def\lowersections{\global\advance\secbase by 1}
5042 \let\down=\lowersections % original BFox name
5044 % we only have subsub.
5045 \chardef\maxseclevel = 3
5047 % A numbered section within an unnumbered changes to unnumbered too.
5048 % To achive this, remember the "biggest" unnum. sec. we are currently in:
5049 \chardef\unmlevel = \maxseclevel
5051 % Trace whether the current chapter is an appendix or not:
5052 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5053 \def\chapheadtype{N}
5055 % Choose a heading macro
5056 % #1 is heading type
5057 % #2 is heading level
5058 % #3 is text for heading
5059 \def\genhead#1#2#3{%
5060 % Compute the abs. sec. level:
5062 \advance\absseclevel by \secbase
5063 % Make sure \absseclevel doesn't fall outside the range:
5064 \ifnum \absseclevel < 0
5067 \ifnum \absseclevel > 3
5074 \ifnum \absseclevel < \unmlevel
5075 \chardef\unmlevel = \absseclevel
5078 % Check for appendix sections:
5079 \ifnum \absseclevel = 0
5080 \edef\chapheadtype{\headtype}%
5082 \if \headtype A\if \chapheadtype N%
5083 \errmessage{@appendix... within a non-appendix chapter}%
5086 % Check for numbered within unnumbered:
5087 \ifnum \absseclevel > \unmlevel
5090 \chardef\unmlevel = 3
5093 % Now print the heading:
5097 \or \unnumberedseczzz{#3}%
5098 \or \unnumberedsubseczzz{#3}%
5099 \or \unnumberedsubsubseczzz{#3}%
5105 \or \appendixsectionzzz{#3}%
5106 \or \appendixsubseczzz{#3}%
5107 \or \appendixsubsubseczzz{#3}%
5113 \or \numberedsubseczzz{#3}%
5114 \or \numberedsubsubseczzz{#3}%
5118 \suppressfirstparagraphindent
5122 \def\numhead{\genhead N}
5123 \def\apphead{\genhead A}
5124 \def\unnmhead{\genhead U}
5126 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5127 % all lower-level sectioning counters to zero.
5129 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5130 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5131 \let\chaplevelprefix = \empty
5133 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5135 % section resetting is \global in case the chapter is in a group, such
5136 % as an @include file.
5137 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5138 \global\advance\chapno by 1
5141 \gdef\chaplevelprefix{\the\chapno.}%
5144 % \putwordChapter can contain complex things in translations.
5145 \toks0=\expandafter{\putwordChapter}%
5146 \message{\the\toks0 \space \the\chapno}%
5148 % Write the actual heading.
5149 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5151 % So @section and the like are numbered underneath this chapter.
5152 \global\let\section = \numberedsec
5153 \global\let\subsection = \numberedsubsec
5154 \global\let\subsubsection = \numberedsubsubsec
5157 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5159 \def\appendixzzz#1{%
5160 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5161 \global\advance\appendixno by 1
5162 \gdef\chaplevelprefix{\appendixletter.}%
5165 % \putwordAppendix can contain complex things in translations.
5166 \toks0=\expandafter{\putwordAppendix}%
5167 \message{\the\toks0 \space \appendixletter}%
5169 \chapmacro{#1}{Yappendix}{\appendixletter}%
5171 \global\let\section = \appendixsec
5172 \global\let\subsection = \appendixsubsec
5173 \global\let\subsubsection = \appendixsubsubsec
5176 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5177 \def\unnumberedzzz#1{%
5178 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5179 \global\advance\unnumberedno by 1
5181 % Since an unnumbered has no number, no prefix for figures.
5182 \global\let\chaplevelprefix = \empty
5185 % This used to be simply \message{#1}, but TeX fully expands the
5186 % argument to \message. Therefore, if #1 contained @-commands, TeX
5187 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5188 % expanded @cite (which turns out to cause errors because \cite is meant
5189 % to be executed, not expanded).
5191 % Anyway, we don't want the fully-expanded definition of @cite to appear
5192 % as a result of the \message, we just want `@cite' itself. We use
5193 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5194 % simply yielding the contents of <toks register>. (We also do this for
5197 \message{(\the\toks0)}%
5199 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5201 \global\let\section = \unnumberedsec
5202 \global\let\subsection = \unnumberedsubsec
5203 \global\let\subsubsection = \unnumberedsubsubsec
5206 % @centerchap is like @unnumbered, but the heading is centered.
5207 \outer\parseargdef\centerchap{%
5208 % Well, we could do the following in a group, but that would break
5209 % an assumption that \chapmacro is called at the outermost level.
5210 % Thus we are safer this way: --kasal, 24feb04
5211 \let\centerparametersmaybe = \centerparameters
5213 \let\centerparametersmaybe = \relax
5216 % @top is like @unnumbered.
5220 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5222 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5223 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5226 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5227 \def\appendixsectionzzz#1{%
5228 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5229 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5231 \let\appendixsec\appendixsection
5233 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5234 \def\unnumberedseczzz#1{%
5235 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5236 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5240 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5241 \def\numberedsubseczzz#1{%
5242 \global\subsubsecno=0 \global\advance\subsecno by 1
5243 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5246 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5247 \def\appendixsubseczzz#1{%
5248 \global\subsubsecno=0 \global\advance\subsecno by 1
5249 \sectionheading{#1}{subsec}{Yappendix}%
5250 {\appendixletter.\the\secno.\the\subsecno}%
5253 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5254 \def\unnumberedsubseczzz#1{%
5255 \global\subsubsecno=0 \global\advance\subsecno by 1
5256 \sectionheading{#1}{subsec}{Ynothing}%
5257 {\the\unnumberedno.\the\secno.\the\subsecno}%
5261 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5262 \def\numberedsubsubseczzz#1{%
5263 \global\advance\subsubsecno by 1
5264 \sectionheading{#1}{subsubsec}{Ynumbered}%
5265 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5268 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5269 \def\appendixsubsubseczzz#1{%
5270 \global\advance\subsubsecno by 1
5271 \sectionheading{#1}{subsubsec}{Yappendix}%
5272 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5275 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5276 \def\unnumberedsubsubseczzz#1{%
5277 \global\advance\subsubsecno by 1
5278 \sectionheading{#1}{subsubsec}{Ynothing}%
5279 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5282 % These macros control what the section commands do, according
5283 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5284 % Define them by default for a numbered chapter.
5285 \let\section = \numberedsec
5286 \let\subsection = \numberedsubsec
5287 \let\subsubsection = \numberedsubsubsec
5289 % Define @majorheading, @heading and @subheading
5291 % NOTE on use of \vbox for chapter headings, section headings, and such:
5292 % 1) We use \vbox rather than the earlier \line to permit
5293 % overlong headings to fold.
5294 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5295 % heading is obnoxious; this forbids it.
5296 % 3) Likewise, headings look best if no \parindent is used, and
5297 % if justification is not attempted. Hence \raggedright.
5300 {\advance\chapheadingskip by 10pt \chapbreak }%
5301 \parsearg\chapheadingzzz
5304 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5305 \def\chapheadingzzz#1{%
5306 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5307 \parindent=0pt\ptexraggedright
5308 \rmisbold #1\hfill}}%
5309 \bigskip \par\penalty 200\relax
5310 \suppressfirstparagraphindent
5313 % @heading, @subheading, @subsubheading.
5314 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5315 \suppressfirstparagraphindent}
5316 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5317 \suppressfirstparagraphindent}
5318 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5319 \suppressfirstparagraphindent}
5321 % These macros generate a chapter, section, etc. heading only
5322 % (including whitespace, linebreaking, etc. around it),
5323 % given all the information in convenient, parsed form.
5325 %%% Args are the skip and penalty (usually negative)
5326 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5328 %%% Define plain chapter starts, and page on/off switching for it
5329 % Parameter controlling skip before chapter headings (if needed)
5331 \newskip\chapheadingskip
5333 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5334 \def\chappager{\par\vfill\supereject}
5335 % Because \domark is called before \chapoddpage, the filler page will
5336 % get the headings for the next chapter, which is wrong. But we don't
5337 % care -- we just disable all headings on the filler page.
5342 \evenheadline={\hfil}\evenfootline={\hfil}%
5343 \oddheadline={\hfil}\oddfootline={\hfil}%
5350 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5353 \global\let\contentsalignmacro = \chappager
5354 \global\let\pchapsepmacro=\chapbreak
5355 \global\let\pagealignmacro=\chappager}
5358 \global\let\contentsalignmacro = \chappager
5359 \global\let\pchapsepmacro=\chappager
5360 \global\let\pagealignmacro=\chappager
5361 \global\def\HEADINGSon{\HEADINGSsingle}}
5364 \global\let\contentsalignmacro = \chapoddpage
5365 \global\let\pchapsepmacro=\chapoddpage
5366 \global\let\pagealignmacro=\chapoddpage
5367 \global\def\HEADINGSon{\HEADINGSdouble}}
5373 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5374 % Yappendix, Yomitfromtoc), #3 the chapter number.
5376 % To test against our argument.
5377 \def\Ynothingkeyword{Ynothing}
5378 \def\Yomitfromtockeyword{Yomitfromtoc}
5379 \def\Yappendixkeyword{Yappendix}
5381 \def\chapmacro#1#2#3{%
5382 % Insert the first mark before the heading break (see notes for \domark).
5383 \let\prevchapterdefs=\lastchapterdefs
5384 \let\prevsectiondefs=\lastsectiondefs
5385 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5386 \gdef\thissection{}}%
5389 \ifx\temptype\Ynothingkeyword
5390 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5391 \gdef\thischapter{\thischaptername}}%
5392 \else\ifx\temptype\Yomitfromtockeyword
5393 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5394 \gdef\thischapter{}}%
5395 \else\ifx\temptype\Yappendixkeyword
5397 \xdef\lastchapterdefs{%
5398 \gdef\noexpand\thischaptername{\the\toks0}%
5399 \gdef\noexpand\thischapternum{\appendixletter}%
5400 % \noexpand\putwordAppendix avoids expanding indigestible
5401 % commands in some of the translations.
5402 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5403 \noexpand\thischapternum:
5404 \noexpand\thischaptername}%
5408 \xdef\lastchapterdefs{%
5409 \gdef\noexpand\thischaptername{\the\toks0}%
5410 \gdef\noexpand\thischapternum{\the\chapno}%
5411 % \noexpand\putwordChapter avoids expanding indigestible
5412 % commands in some of the translations.
5413 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5414 \noexpand\thischapternum:
5415 \noexpand\thischaptername}%
5419 % Output the mark. Pass it through \safewhatsit, to take care of
5420 % the preceding space.
5423 % Insert the chapter heading break.
5426 % Now the second mark, after the heading break. No break points
5427 % between here and the heading.
5428 \let\prevchapterdefs=\lastchapterdefs
5429 \let\prevsectiondefs=\lastsectiondefs
5433 \chapfonts \rmisbold
5435 % Have to define \lastsection before calling \donoderef, because the
5436 % xref code eventually uses it. On the other hand, it has to be called
5437 % after \pchapsepmacro, or the headline will change too soon.
5438 \gdef\lastsection{#1}%
5440 % Only insert the separating space if we have a chapter/appendix
5441 % number, and don't print the unnumbered ``number''.
5442 \ifx\temptype\Ynothingkeyword
5444 \def\toctype{unnchap}%
5445 \else\ifx\temptype\Yomitfromtockeyword
5446 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5448 \else\ifx\temptype\Yappendixkeyword
5449 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5452 \setbox0 = \hbox{#3\enspace}%
5453 \def\toctype{numchap}%
5456 % Write the toc entry for this chapter. Must come before the
5457 % \donoderef, because we include the current node name in the toc
5458 % entry, and \donoderef resets it to empty.
5459 \writetocentry{\toctype}{#1}{#3}%
5461 % For pdftex, we have to write out the node definition (aka, make
5462 % the pdfdest) after any page break, but before the actual text has
5463 % been typeset. If the destination for the pdf outline is after the
5464 % text, then jumping from the outline may wind up with the text not
5465 % being visible, for instance under high magnification.
5468 % Typeset the actual heading.
5469 \nobreak % Avoid page breaks at the interline glue.
5470 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5471 \hangindent=\wd0 \centerparametersmaybe
5474 \nobreak\bigskip % no page break after a chapter title
5478 % @centerchap -- centered and unnumbered.
5479 \let\centerparametersmaybe = \relax
5480 \def\centerparameters{%
5481 \advance\rightskip by 3\rightskip
5482 \leftskip = \rightskip
5487 % I don't think this chapter style is supported any more, so I'm not
5488 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5490 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5492 \def\unnchfopen #1{%
5493 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5494 \parindent=0pt\ptexraggedright
5495 \rmisbold #1\hfill}}\bigskip \par\nobreak
5497 \def\chfopen #1#2{\chapoddpage {\chapfonts
5498 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5501 \def\centerchfopen #1{%
5502 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5504 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5507 \global\let\chapmacro=\chfopen
5508 \global\let\centerchapmacro=\centerchfopen}
5511 % Section titles. These macros combine the section number parts and
5512 % call the generic \sectionheading to do the printing.
5514 \newskip\secheadingskip
5515 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5517 % Subsection titles.
5518 \newskip\subsecheadingskip
5519 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5521 % Subsubsection titles.
5522 \def\subsubsecheadingskip{\subsecheadingskip}
5523 \def\subsubsecheadingbreak{\subsecheadingbreak}
5526 % Print any size, any type, section title.
5528 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5529 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5532 \def\seckeyword{sec}
5534 \def\sectionheading#1#2#3#4{%
5536 % Switch to the right set of fonts.
5537 \csname #2fonts\endcsname \rmisbold
5539 \def\sectionlevel{#2}%
5542 % Insert first mark before the heading break (see notes for \domark).
5543 \let\prevsectiondefs=\lastsectiondefs
5544 \ifx\temptype\Ynothingkeyword
5545 \ifx\sectionlevel\seckeyword
5546 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5547 \gdef\thissection{\thissectionname}}%
5549 \else\ifx\temptype\Yomitfromtockeyword
5550 % Don't redefine \thissection.
5551 \else\ifx\temptype\Yappendixkeyword
5552 \ifx\sectionlevel\seckeyword
5554 \xdef\lastsectiondefs{%
5555 \gdef\noexpand\thissectionname{\the\toks0}%
5556 \gdef\noexpand\thissectionnum{#4}%
5557 % \noexpand\putwordSection avoids expanding indigestible
5558 % commands in some of the translations.
5559 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5560 \noexpand\thissectionnum:
5561 \noexpand\thissectionname}%
5565 \ifx\sectionlevel\seckeyword
5567 \xdef\lastsectiondefs{%
5568 \gdef\noexpand\thissectionname{\the\toks0}%
5569 \gdef\noexpand\thissectionnum{#4}%
5570 % \noexpand\putwordSection avoids expanding indigestible
5571 % commands in some of the translations.
5572 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5573 \noexpand\thissectionnum:
5574 \noexpand\thissectionname}%
5579 % Go into vertical mode. Usually we'll already be there, but we
5580 % don't want the following whatsit to end up in a preceding paragraph
5581 % if the document didn't happen to have a blank line.
5584 % Output the mark. Pass it through \safewhatsit, to take care of
5585 % the preceding space.
5588 % Insert space above the heading.
5589 \csname #2headingbreak\endcsname
5591 % Now the second mark, after the heading break. No break points
5592 % between here and the heading.
5593 \let\prevsectiondefs=\lastsectiondefs
5596 % Only insert the space after the number if we have a section number.
5597 \ifx\temptype\Ynothingkeyword
5600 \gdef\lastsection{#1}%
5601 \else\ifx\temptype\Yomitfromtockeyword
5602 % for @headings -- no section number, don't include in toc,
5603 % and don't redefine \lastsection.
5606 \let\sectionlevel=\empty
5607 \else\ifx\temptype\Yappendixkeyword
5608 \setbox0 = \hbox{#4\enspace}%
5610 \gdef\lastsection{#1}%
5612 \setbox0 = \hbox{#4\enspace}%
5614 \gdef\lastsection{#1}%
5617 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5618 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5620 % Write the node reference (= pdf destination for pdftex).
5621 % Again, see comments in \chapmacro.
5624 % Interline glue will be inserted when the vbox is completed.
5625 % That glue will be a valid breakpoint for the page, since it'll be
5626 % preceded by a whatsit (usually from the \donoderef, or from the
5627 % \writetocentry if there was no node). We don't want to allow that
5628 % break, since then the whatsits could end up on page n while the
5629 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5632 % Output the actual section heading.
5633 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5634 \hangindent=\wd0 % zero if no section number
5637 % Add extra space after the heading -- half of whatever came above it.
5638 % Don't allow stretch, though.
5639 \kern .5 \csname #2headingskip\endcsname
5641 % Do not let the kern be a potential breakpoint, as it would be if it
5642 % was followed by glue.
5645 % We'll almost certainly start a paragraph next, so don't let that
5646 % glue accumulate. (Not a breakpoint because it's preceded by a
5647 % discardable item.)
5650 % This is purely so the last item on the list is a known \penalty >
5651 % 10000. This is so \startdefun can avoid allowing breakpoints after
5652 % section headings. Otherwise, it would insert a valid breakpoint between:
5654 % @section sec-whatever
5655 % @deffn def-whatever
5661 % Table of contents.
5664 % Write an entry to the toc file, opening it if necessary.
5665 % Called from @chapter, etc.
5667 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5668 % We append the current node name (if any) and page number as additional
5669 % arguments for the \{chap,sec,...}entry macros which will eventually
5670 % read this. The node name is used in the pdf outlines as the
5671 % destination to jump to.
5673 % We open the .toc file for writing here instead of at @setfilename (or
5674 % any other fixed time) so that @contents can be anywhere in the document.
5675 % But if #1 is `omit', then we don't do anything. This is used for the
5676 % table of contents chapter openings themselves.
5678 \newif\iftocfileopened
5679 \def\omitkeyword{omit}%
5681 \def\writetocentry#1#2#3{%
5682 \edef\writetoctype{#1}%
5683 \ifx\writetoctype\omitkeyword \else
5684 \iftocfileopened\else
5685 \immediate\openout\tocfile = \jobname.toc
5686 \global\tocfileopenedtrue
5692 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5698 % Tell \shipout to create a pdf destination on each page, if we're
5699 % writing pdf. These are used in the table of contents. We can't
5700 % just write one on every page because the title pages are numbered
5701 % 1 and 2 (the page numbers aren't printed), and so are the first
5702 % two pages of the document. Thus, we'd have two destinations named
5703 % `1', and two named `2'.
5704 \ifpdf \global\pdfmakepagedesttrue \fi
5708 % These characters do not print properly in the Computer Modern roman
5709 % fonts, so we must take special care. This is more or less redundant
5710 % with the Texinfo input format setup at the end of this file.
5712 \def\activecatcodes{%
5725 % Read the toc file, which is essentially Texinfo input.
5729 \input \tocreadfilename
5732 \newskip\contentsrightmargin \contentsrightmargin=1in
5733 \newcount\savepageno
5734 \newcount\lastnegativepageno \lastnegativepageno = -1
5736 % Prepare to read what we've written to \tocfile.
5738 \def\startcontents#1{%
5739 % If @setchapternewpage on, and @headings double, the contents should
5740 % start on an odd page, unlike chapters. Thus, we maintain
5741 % \contentsalignmacro in parallel with \pagealignmacro.
5742 % From: Torbjorn Granlund <tege@matematik.su.se>
5744 \immediate\closeout\tocfile
5746 % Don't need to put `Contents' or `Short Contents' in the headline.
5747 % It is abundantly clear what they are.
5748 \chapmacro{#1}{Yomitfromtoc}{}%
5750 \savepageno = \pageno
5751 \begingroup % Set up to handle contents files properly.
5752 \raggedbottom % Worry more about breakpoints than the bottom.
5753 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5755 % Roman numerals for page numbers.
5756 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5759 % redefined for the two-volume lispref. We always output on
5760 % \jobname.toc even if this is redefined.
5762 \def\tocreadfilename{\jobname.toc}
5764 % Normal (long) toc.
5767 \startcontents{\putwordTOC}%
5768 \openin 1 \tocreadfilename\space
5773 \contentsalignmacro % in case @setchapternewpage odd is in effect
5779 \lastnegativepageno = \pageno
5780 \global\pageno = \savepageno
5783 % And just the chapters.
5784 \def\summarycontents{%
5785 \startcontents{\putwordShortTOC}%
5787 \let\numchapentry = \shortchapentry
5788 \let\appentry = \shortchapentry
5789 \let\unnchapentry = \shortunnchapentry
5790 % We want a true roman here for the page numbers.
5792 \let\rm=\shortcontrm \let\bf=\shortcontbf
5793 \let\sl=\shortcontsl \let\tt=\shortconttt
5795 \hyphenpenalty = 10000
5796 \advance\baselineskip by 1pt % Open it up a little.
5797 \def\numsecentry##1##2##3##4{}
5798 \let\appsecentry = \numsecentry
5799 \let\unnsecentry = \numsecentry
5800 \let\numsubsecentry = \numsecentry
5801 \let\appsubsecentry = \numsecentry
5802 \let\unnsubsecentry = \numsecentry
5803 \let\numsubsubsecentry = \numsecentry
5804 \let\appsubsubsecentry = \numsecentry
5805 \let\unnsubsubsecentry = \numsecentry
5806 \openin 1 \tocreadfilename\space
5812 \contentsalignmacro % in case @setchapternewpage odd is in effect
5814 \lastnegativepageno = \pageno
5815 \global\pageno = \savepageno
5817 \let\shortcontents = \summarycontents
5819 % Typeset the label for a chapter or appendix for the short contents.
5820 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5822 \def\shortchaplabel#1{%
5823 % This space should be enough, since a single number is .5em, and the
5824 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5825 % But use \hss just in case.
5826 % (This space doesn't include the extra space that gets added after
5827 % the label; that gets put in by \shortchapentry above.)
5829 % We'd like to right-justify chapter numbers, but that looks strange
5830 % with appendix letters. And right-justifying numbers and
5831 % left-justifying letters looks strange when there is less than 10
5832 % chapters. Have to read the whole toc once to know how many chapters
5833 % there are before deciding ...
5834 \hbox to 1em{#1\hss}%
5837 % These macros generate individual entries in the table of contents.
5838 % The first argument is the chapter or section name.
5839 % The last argument is the page number.
5840 % The arguments in between are the chapter number, section number, ...
5842 % Chapters, in the main contents.
5843 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5845 % Chapters, in the short toc.
5846 % See comments in \dochapentry re vbox and related settings.
5847 \def\shortchapentry#1#2#3#4{%
5848 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5851 % Appendices, in the main contents.
5852 % Need the word Appendix, and a fixed-size box.
5854 \def\appendixbox#1{%
5855 % We use M since it's probably the widest letter.
5856 \setbox0 = \hbox{\putwordAppendix{} M}%
5857 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5859 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5861 % Unnumbered chapters.
5862 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5863 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5866 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5867 \let\appsecentry=\numsecentry
5868 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5871 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5872 \let\appsubsecentry=\numsubsecentry
5873 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5875 % And subsubsections.
5876 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5877 \let\appsubsubsecentry=\numsubsubsecentry
5878 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5880 % This parameter controls the indentation of the various levels.
5881 % Same as \defaultparindent.
5882 \newdimen\tocindent \tocindent = 15pt
5884 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5887 % If the toc has to be broken over pages, we want it to be at chapters
5888 % if at all possible; hence the \penalty.
5889 \def\dochapentry#1#2{%
5890 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5893 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5895 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5898 \def\dosecentry#1#2{\begingroup
5899 \secentryfonts \leftskip=\tocindent
5900 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5903 \def\dosubsecentry#1#2{\begingroup
5904 \subsecentryfonts \leftskip=2\tocindent
5905 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5908 \def\dosubsubsecentry#1#2{\begingroup
5909 \subsubsecentryfonts \leftskip=3\tocindent
5910 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5913 % We use the same \entry macro as for the index entries.
5914 \let\tocentry = \entry
5916 % Space between chapter (or whatever) number and the title.
5917 \def\labelspace{\hskip1em \relax}
5919 \def\dopageno#1{{\rm #1}}
5920 \def\doshortpageno#1{{\rm #1}}
5922 \def\chapentryfonts{\secfonts \rm}
5923 \def\secentryfonts{\textfonts}
5924 \def\subsecentryfonts{\textfonts}
5925 \def\subsubsecentryfonts{\textfonts}
5928 \message{environments,}
5929 % @foo ... @end foo.
5931 % @tex ... @end tex escapes into raw Tex temporarily.
5932 % One exception: @ is still an escape character, so that @end tex works.
5933 % But \@ or @@ will get a plain tex @ character.
5936 \setupmarkupstyle{tex}%
5937 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5938 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5939 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5951 \let\bullet=\ptexbullet
5956 \let\equiv=\ptexequiv
5959 \let\indent=\ptexindent
5960 \let\noindent=\ptexnoindent
5967 \expandafter \let\csname top\endcsname=\ptextop % outer
5968 \let\frenchspacing=\plainfrenchspacing
5970 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5971 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5974 % There is no need to define \Etex.
5976 % Define @lisp ... @end lisp.
5977 % @lisp environment forms a group so it can rebind things,
5978 % including the definition of @end lisp (which normally is erroneous).
5980 % Amount to narrow the margins by for @lisp.
5981 \newskip\lispnarrowing \lispnarrowing=0.4in
5983 % This is the definition that ^^M gets inside @lisp, @example, and other
5984 % such environments. \null is better than a space, since it doesn't
5986 \def\lisppar{\null\endgraf}
5988 % This space is always present above and below environments.
5989 \newskip\envskipamount \envskipamount = 0pt
5991 % Make spacing and below environment symmetrical. We use \parskip here
5992 % to help in doing that, since in @example-like environments \parskip
5993 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5994 % start of the next paragraph will insert \parskip.
5996 \def\aboveenvbreak{{%
5997 % =10000 instead of <10000 because of a special case in \itemzzz and
5998 % \sectionheading, q.v.
5999 \ifnum \lastpenalty=10000 \else
6000 \advance\envskipamount by \parskip
6002 \ifdim\lastskip<\envskipamount
6004 % it's not a good place to break if the last penalty was \nobreak
6006 \ifnum\lastpenalty<10000 \penalty-50 \fi
6007 \vskip\envskipamount
6012 \let\afterenvbreak = \aboveenvbreak
6014 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6015 % also clear it, so that its embedded environments do the narrowing again.
6016 \let\nonarrowing=\relax
6018 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6019 % environment contents.
6020 \font\circle=lcircle10
6022 \newdimen\cartouter\newdimen\cartinner
6023 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6024 \circthick=\fontdimen8\circle
6026 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6027 \def\ctr{{\hskip 6pt\circle\char'010}}
6028 \def\cbl{{\circle\char'012\hskip -6pt}}
6029 \def\cbr{{\hskip 6pt\circle\char'011}}
6030 \def\carttop{\hbox to \cartouter{\hskip\lskip
6031 \ctl\leaders\hrule height\circthick\hfil\ctr
6033 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6034 \cbl\leaders\hrule height\circthick\hfil\cbr
6037 \newskip\lskip\newskip\rskip
6040 \ifhmode\par\fi % can't be in the midst of a paragraph.
6042 \lskip=\leftskip \rskip=\rightskip
6043 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6044 \cartinner=\hsize \advance\cartinner by-\lskip
6045 \advance\cartinner by-\rskip
6047 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6048 % side, and for 6pt waste from
6049 % each corner char, and rule thickness
6050 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6051 % Flag to tell @lisp, etc., not to narrow margin.
6052 \let\nonarrowing = t%
6054 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6062 \baselineskip=\normbskip
6063 \lineskip=\normlskip
6066 \comment % For explanation, see the end of \def\group.
6081 % This macro is called at the beginning of all the @example variants,
6083 \newdimen\nonfillparindent
6086 \hfuzz = 12pt % Don't be fussy
6087 \sepspaces % Make spaces be word-separators rather than space tokens.
6088 \let\par = \lisppar % don't ignore blank lines
6089 \obeylines % each line of input is a line of output
6091 % Turn off paragraph indentation but redefine \indent to emulate
6092 % the normal \indent.
6093 \nonfillparindent=\parindent
6095 \let\indent\nonfillindent
6097 \emergencystretch = 0pt % don't try to avoid overfull boxes
6098 \ifx\nonarrowing\relax
6099 \advance \leftskip by \lispnarrowing
6100 \exdentamount=\lispnarrowing
6102 \let\nonarrowing = \relax
6104 \let\exdent=\nofillexdent
6109 % We want to swallow spaces (but not other tokens) after the fake
6110 % @indent in our nonfill-environments, where spaces are normally
6111 % active and set to @tie, resulting in them not being ignored after
6113 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6114 \gdef\nonfillindentcheck{%
6116 \expandafter\nonfillindentgobble%
6118 \leavevmode\nonfillindentbox%
6122 \def\nonfillindentgobble#1{\nonfillindent}
6123 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6125 % If you want all examples etc. small: @set dispenvsize small.
6126 % If you want even small examples the full size: @set dispenvsize nosmall.
6127 % This affects the following displayed environments:
6128 % @example, @display, @format, @lisp
6130 \def\smallword{small}
6131 \def\nosmallword{nosmall}
6132 \let\SETdispenvsize\relax
6133 \def\setnormaldispenv{%
6134 \ifx\SETdispenvsize\smallword
6135 % end paragraph for sake of leading, in case document has no blank
6136 % line. This is redundant with what happens in \aboveenvbreak, but
6137 % we need to do it before changing the fonts, and it's inconvenient
6138 % to change the fonts afterward.
6139 \ifnum \lastpenalty=10000 \else \endgraf \fi
6140 \smallexamplefonts \rm
6143 \def\setsmalldispenv{%
6144 \ifx\SETdispenvsize\nosmallword
6146 \ifnum \lastpenalty=10000 \else \endgraf \fi
6147 \smallexamplefonts \rm
6151 % We often define two environments, @foo and @smallfoo.
6152 % Let's do it by one command:
6153 \def\makedispenv #1#2{
6154 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
6155 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
6156 \expandafter\let\csname E#1\endcsname \afterenvbreak
6157 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6160 % Define two synonyms:
6161 \def\maketwodispenvs #1#2#3{
6162 \makedispenv{#1}{#3}
6163 \makedispenv{#2}{#3}
6166 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
6168 % @smallexample and @smalllisp: use smaller fonts.
6169 % Originally contributed by Pavel@xerox.
6171 \maketwodispenvs {lisp}{example}{%
6173 \tt\setupmarkupstyle{example}%
6174 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6175 \gobble % eat return
6177 % @display/@smalldisplay: same as @lisp except keep current font.
6179 \makedispenv {display}{%
6184 % @format/@smallformat: same as @display except don't narrow margins.
6186 \makedispenv{format}{%
6187 \let\nonarrowing = t%
6192 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6194 \let\nonarrowing = t%
6198 \let\Eflushleft = \afterenvbreak
6202 \envdef\flushright{%
6203 \let\nonarrowing = t%
6205 \advance\leftskip by 0pt plus 1fill
6208 \let\Eflushright = \afterenvbreak
6211 % @raggedright does more-or-less normal line breaking but no right
6212 % justification. From plain.tex.
6213 \envdef\raggedright{%
6214 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6216 \let\Eraggedright\par
6218 \envdef\raggedleft{%
6219 \parindent=0pt \leftskip0pt plus2em
6220 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6221 \hbadness=10000 % Last line will usually be underfull, so turn off
6222 % badness reporting.
6224 \let\Eraggedleft\par
6226 \envdef\raggedcenter{%
6227 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6228 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6229 \hbadness=10000 % Last line will usually be underfull, so turn off
6230 % badness reporting.
6232 \let\Eraggedcenter\par
6235 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6236 % and narrows the margins. We keep \parskip nonzero in general, since
6237 % we're doing normal filling. So, when using \aboveenvbreak and
6238 % \afterenvbreak, temporarily make \parskip 0.
6240 \def\quotationstart{%
6241 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6244 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6245 \ifx\nonarrowing\relax
6246 \advance\leftskip by \lispnarrowing
6247 \advance\rightskip by \lispnarrowing
6248 \exdentamount = \lispnarrowing
6250 \let\nonarrowing = \relax
6252 \parsearg\quotationlabel
6260 \envdef\smallquotation{%
6264 \let\Esmallquotation = \Equotation
6266 % We have retained a nonzero parskip for the environment, since we're
6267 % doing normal filling.
6271 \ifx\quotationauthor\undefined\else
6273 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6275 {\parskip=0pt \afterenvbreak}%
6278 % If we're given an argument, typeset it in bold with a colon after.
6279 \def\quotationlabel#1{%
6281 \ifx\temp\empty \else
6287 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6288 % If we want to allow any <char> as delimiter,
6289 % we need the curly braces so that makeinfo sees the @verb command, eg:
6290 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6292 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6294 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6295 % active too. Otherwise, they get lost as the first character on a
6298 \do\ \do\\\do\{\do\}\do\$\do\&%
6299 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6300 \do\<\do\>\do\|\do\@\do+\do\"%
6301 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6302 % @set txicodequotebacktick will not have effect on @verb and
6303 % @verbatim, and ?` and !` ligatures won't get disabled.
6308 \def\uncatcodespecials{%
6309 \def\do##1{\catcode`##1=\other}\dospecials}
6311 % Setup for the @verb command.
6313 % Eight spaces for a tab
6315 \catcode`\^^I=\active
6316 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6320 \tt % easiest (and conventionally used) font for verbatim
6321 \def\par{\leavevmode\endgraf}%
6322 \setupmarkupstyle{verb}%
6324 % Respect line breaks,
6325 % print special symbols as themselves, and
6326 % make each space count
6327 % must do in this order:
6328 \obeylines \uncatcodespecials \sepspaces
6331 % Setup for the @verbatim environment
6333 % Real tab expansion
6334 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6336 \def\starttabbox{\setbox0=\hbox\bgroup}
6339 \catcode`\^^I=\active
6341 \catcode`\^^I=\active
6342 \def^^I{\leavevmode\egroup
6343 \dimen0=\wd0 % the width so far, or since the previous tab
6344 \divide\dimen0 by\tabw
6345 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6346 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6347 \wd0=\dimen0 \box0 \starttabbox
6352 % start the verbatim environment.
6353 \def\setupverbatim{%
6354 \let\nonarrowing = t%
6356 % Easiest (and conventionally used) font for verbatim
6358 \def\par{\leavevmode\egroup\box0\endgraf}%
6360 \setupmarkupstyle{verbatim}%
6361 % Respect line breaks,
6362 % print special symbols as themselves, and
6363 % make each space count
6364 % must do in this order:
6365 \obeylines \uncatcodespecials \sepspaces
6366 \everypar{\starttabbox}%
6369 % Do the @verb magic: verbatim text is quoted by unique
6370 % delimiter characters. Before first delimiter expect a
6371 % right brace, after last delimiter expect closing brace:
6373 % \def\doverb'{'<char>#1<char>'}'{#1}
6375 % [Knuth] p. 382; only eat outer {}
6377 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6378 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6381 \def\verb{\begingroup\setupverb\doverb}
6384 % Do the @verbatim magic: define the macro \doverbatim so that
6385 % the (first) argument ends when '@end verbatim' is reached, ie:
6387 % \def\doverbatim#1@end verbatim{#1}
6389 % For Texinfo it's a lot easier than for LaTeX,
6390 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6391 % we need not redefine '\', '{' and '}'.
6393 % Inspired by LaTeX's verbatim command set [latex.ltx]
6398 % ignore everything up to the first ^^M, that's the newline at the end
6399 % of the @verbatim input line itself. Otherwise we get an extra blank
6400 % line in the output.
6401 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6402 % We really want {...\end verbatim} in the body of the macro, but
6403 % without the active space; thus we have to use \xdef and \gobble.
6407 \setupverbatim\doverbatim
6409 \let\Everbatim = \afterenvbreak
6412 % @verbatiminclude FILE - insert text of file in verbatim environment.
6414 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6416 \def\doverbatiminclude#1{%
6418 \makevalueexpandable
6420 \indexnofonts % Allow `@@' and other weird things in file names.
6426 % @copying ... @end copying.
6427 % Save the text away for @insertcopying later.
6429 % We save the uninterpreted tokens, rather than creating a box.
6430 % Saving the text in a box would be much easier, but then all the
6431 % typesetting commands (@smallbook, font changes, etc.) have to be done
6432 % beforehand -- and a) we want @copying to be done first in the source
6433 % file; b) letting users define the frontmatter in as flexible order as
6434 % possible is very desirable.
6436 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6437 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6439 \def\insertcopying{%
6441 \parindent = 0pt % paragraph indentation looks wrong on title page
6442 \scanexp\copyingtext
6450 \newskip\defbodyindent \defbodyindent=.4in
6451 \newskip\defargsindent \defargsindent=50pt
6452 \newskip\deflastargmargin \deflastargmargin=18pt
6453 \newcount\defunpenalty
6455 % Start the processing of @deffn:
6457 \ifnum\lastpenalty<10000
6459 \defunpenalty=10003 % Will keep this @deffn together with the
6460 % following @def command, see below.
6462 % If there are two @def commands in a row, we'll have a \nobreak,
6463 % which is there to keep the function description together with its
6464 % header. But if there's nothing but headers, we need to allow a
6465 % break somewhere. Check specifically for penalty 10002, inserted
6466 % by \printdefunline, instead of 10000, since the sectioning
6467 % commands also insert a nobreak penalty, and we don't want to allow
6468 % a break between a section heading and a defun.
6470 % As a minor refinement, we avoid "club" headers by signalling
6471 % with penalty of 10003 after the very first @deffn in the
6472 % sequence (see above), and penalty of 10002 after any following
6474 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6476 % Similarly, after a section heading, do not allow a break.
6477 % But do insert the glue.
6478 \medskip % preceded by discardable penalty, so not a breakpoint
6482 \advance\leftskip by \defbodyindent
6483 \exdentamount=\defbodyindent
6487 % First, check whether we are in the right environment:
6490 % As above, allow line break if we have multiple x headers in a row.
6491 % It's not a great place, though.
6492 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6494 % And now, it's time to reuse the body of the original defun:
6495 \expandafter\gobbledefun#1%
6497 \def\gobbledefun#1\startdefun{}
6499 % \printdefunline \deffnheader{text}
6501 \def\printdefunline#1#2{%
6503 % call \deffnheader:
6506 \interlinepenalty = 10000
6507 \advance\rightskip by 0pt plus 1fil
6509 \nobreak\vskip -\parskip
6510 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6511 % Some of the @defun-type tags do not enable magic parentheses,
6512 % rendering the following check redundant. But we don't optimize.
6517 \def\Edefun{\endgraf\medbreak}
6519 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6520 % the only thing remaining is to define \deffnheader.
6523 \expandafter\let\csname E#1\endcsname = \Edefun
6524 \edef\temp{\noexpand\domakedefun
6525 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6529 % \domakedefun \deffn \deffnx \deffnheader
6531 % Define \deffn and \deffnx, without parameters.
6532 % \deffnheader has to be defined explicitly.
6534 \def\domakedefun#1#2#3{%
6537 \parseargusing\activeparens{\printdefunline#3}%
6539 \def#2{\dodefunx#1}%
6543 %%% Untyped functions:
6545 % @deffn category name args
6546 \makedefun{deffn}{\deffngeneral{}}
6548 % @deffn category class name args
6549 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6551 % \defopon {category on}class name args
6552 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6554 % \deffngeneral {subind}category name args
6556 \def\deffngeneral#1#2 #3 #4\endheader{%
6557 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6558 \dosubind{fn}{\code{#3}}{#1}%
6559 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6562 %%% Typed functions:
6564 % @deftypefn category type name args
6565 \makedefun{deftypefn}{\deftypefngeneral{}}
6567 % @deftypeop category class type name args
6568 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6570 % \deftypeopon {category on}class type name args
6571 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6573 % \deftypefngeneral {subind}category type name args
6575 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6576 \dosubind{fn}{\code{#4}}{#1}%
6577 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6580 %%% Typed variables:
6582 % @deftypevr category type var args
6583 \makedefun{deftypevr}{\deftypecvgeneral{}}
6585 % @deftypecv category class type var args
6586 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6588 % \deftypecvof {category of}class type var args
6589 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6591 % \deftypecvgeneral {subind}category type var args
6593 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6594 \dosubind{vr}{\code{#4}}{#1}%
6595 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6598 %%% Untyped variables:
6600 % @defvr category var args
6601 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6603 % @defcv category class var args
6604 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6606 % \defcvof {category of}class var args
6607 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6610 % @deftp category name args
6611 \makedefun{deftp}#1 #2 #3\endheader{%
6612 \doind{tp}{\code{#2}}%
6613 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6616 % Remaining @defun-like shortcuts:
6617 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6618 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6619 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6620 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6621 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6622 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6623 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6624 \makedefun{defmethod}{\defopon\putwordMethodon}
6625 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6626 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6627 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6629 % \defname, which formats the name of the @def (not the args).
6630 % #1 is the category, such as "Function".
6631 % #2 is the return type, if any.
6632 % #3 is the function name.
6634 % We are followed by (but not passed) the arguments, if any.
6636 \def\defname#1#2#3{%
6637 % Get the values of \leftskip and \rightskip as they were outside the @def...
6638 \advance\leftskip by -\defbodyindent
6640 % How we'll format the type name. Putting it in brackets helps
6641 % distinguish it from the body text that may end up on the next line
6644 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6646 % Figure out line sizes for the paragraph shape.
6647 % The first line needs space for \box0; but if \rightskip is nonzero,
6648 % we need only space for the part of \box0 which exceeds it:
6649 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6650 % The continuations:
6651 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6652 % (plain.tex says that \dimen1 should be used only as global.)
6653 \parshape 2 0in \dimen0 \defargsindent \dimen2
6655 % Put the type name to the right margin.
6658 \hfil\box0 \kern-\hsize
6659 % \hsize has to be shortened this way:
6661 % Intentionally do not respect \rightskip, since we need the space.
6664 % Allow all lines to be underfull without complaint:
6665 \tolerance=10000 \hbadness=10000
6666 \exdentamount=\defbodyindent
6668 % defun fonts. We use typewriter by default (used to be bold) because:
6669 % . we're printing identifiers, they should be in tt in principle.
6670 % . in languages with many accents, such as Czech or French, it's
6671 % common to leave accents off identifiers. The result looks ok in
6672 % tt, but exceedingly strange in rm.
6673 % . we don't want -- and --- to be treated as ligatures.
6674 % . this still does not fix the ?` and !` ligatures, but so far no
6675 % one has made identifiers using them :).
6677 \def\temp{#2}% return value type
6678 \ifx\temp\empty\else \tclose{\temp} \fi
6679 #3% output function name
6681 {\rm\enskip}% hskip 0.5 em of \tenrm
6684 % arguments will be output next, if any.
6687 % Print arguments in slanted roman (not ttsl), inconsistently with using
6688 % tt for the name. This is because literal text is sometimes needed in
6689 % the argument list (groff manual), and ttsl and tt are not very
6690 % distinguishable. Prevent hyphenation at `-' chars.
6693 % use sl by default (not ttsl),
6695 \df \sl \hyphenchar\font=0
6697 % On the other hand, if an argument has two dashes (for instance), we
6698 % want a way to get ttsl. Let's try @var for that.
6699 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6701 \sl\hyphenchar\font=45
6704 % We want ()&[] to print specially on the defun line.
6707 \catcode`\(=\active \catcode`\)=\active
6708 \catcode`\[=\active \catcode`\]=\active
6712 % Make control sequences which act like normal parenthesis chars.
6713 \let\lparen = ( \let\rparen = )
6715 % Be sure that we always have a definition for `(', etc. For example,
6716 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6717 % so TeX would otherwise complain about undefined control sequence.
6720 \global\let(=\lparen \global\let)=\rparen
6721 \global\let[=\lbrack \global\let]=\rbrack
6724 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6725 \gdef\magicamp{\let&=\amprm}
6728 \newcount\parencount
6730 % If we encounter &foo, then turn on ()-hacking afterwards
6732 \def\amprm#1 {\ampseentrue{\bf\ }}
6736 % At the first level, print parens in roman,
6737 % otherwise use the default font.
6738 \ifnum \parencount=1 \rm \fi
6740 % The \sf parens (in \boldbrax) actually are a little bolder than
6741 % the contained text. This is especially needed for [ and ] .
6745 \def\infirstlevel#1{%
6752 \def\bfafterword#1 {#1 \bf}
6755 \global\advance\parencount by 1
6757 \infirstlevel \bfafterword
6762 \global\advance\parencount by -1
6765 \newcount\brackcount
6767 \global\advance\brackcount by 1
6772 \global\advance\brackcount by -1
6775 \def\checkparencounts{%
6776 \ifnum\parencount=0 \else \badparencount \fi
6777 \ifnum\brackcount=0 \else \badbrackcount \fi
6779 % these should not use \errmessage; the glibc manual, at least, actually
6780 % has such constructs (when documenting function pointers).
6781 \def\badparencount{%
6782 \message{Warning: unbalanced parentheses in @def...}%
6783 \global\parencount=0
6785 \def\badbrackcount{%
6786 \message{Warning: unbalanced square brackets in @def...}%
6787 \global\brackcount=0
6794 % To do this right we need a feature of e-TeX, \scantokens,
6795 % which we arrange to emulate with a temporary file in ordinary TeX.
6796 \ifx\eTeXversion\undefined
6797 \newwrite\macscribble
6800 \immediate\openout\macscribble=\jobname.tmp
6801 \immediate\write\macscribble{\the\toks0}%
6802 \immediate\closeout\macscribble
6810 \let\xeatspaces\eatspaces
6811 % Undo catcode changes of \startcontents and \doprintindex
6812 % When called from @insertcopying or (short)caption, we need active
6813 % backslash to get it printed correctly. Previously, we had
6814 % \catcode`\\=\other instead. We'll see whether a problem appears
6815 % with macro expansion. --kasal, 19aug04
6816 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6820 % Append \endinput to make sure that TeX does not see the ending newline.
6821 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6823 \scantokens{#1\endinput}%
6828 \edef\temp{\noexpand\scanmacro{#1}}%
6832 \newcount\paramno % Count of parameters
6833 \newtoks\macname % Macro name
6834 \newif\ifrecursive % Is it recursive?
6836 % List of all defined macros in the form
6837 % \definedummyword\macro1\definedummyword\macro2...
6838 % Currently is also contains all @aliases; the list can be split
6839 % if there is a need.
6842 % Add the macro to \macrolist
6843 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6844 \def\addtomacrolistxxx#1{%
6845 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6846 \xdef\macrolist{\the\toks0}%
6850 % This does \let #1 = #2, with \csnames; that is,
6851 % \let \csname#1\endcsname = \csname#2\endcsname
6852 % (except of course we have to play expansion games).
6856 \csname#1\expandafter\endcsname
6860 % Trim leading and trailing spaces off a string.
6861 % Concepts from aro-bend problem 15 (see CTAN).
6863 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6864 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6865 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6867 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6870 % Trim a single trailing ^^M off a string.
6871 {\catcode`\^^M=\other \catcode`\Q=3%
6872 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6873 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6874 \gdef\eatcrb#1Q#2Q{#1}%
6877 % Macro bodies are absorbed as an argument in a context where
6878 % all characters are catcode 10, 11 or 12, except \ which is active
6879 % (as in normal texinfo). It is necessary to change the definition of \.
6881 % Non-ASCII encodings make 8-bit characters active, so un-activate
6882 % them to avoid their expansion. Must do this non-globally, to
6883 % confine the change to the current group.
6885 % It's necessary to have hard CRs when the macro is executed. This is
6886 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6887 % body, and then making it the \newlinechar in \scanmacro.
6899 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6905 \catcode`\^^M=\other
6908 \def\macrobodyctxt{%
6912 \catcode`\^^M=\other
6921 % \mbodybackslash is the definition of \ in @macro bodies.
6922 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6923 % where N is the macro parameter number.
6924 % We define \csname macarg.\endcsname to be \realbackslash, so
6925 % \\ in macro replacement text gets you a backslash.
6927 {\catcode`@=0 @catcode`@\=@active
6928 @gdef@usembodybackslash{@let\=@mbodybackslash}
6929 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6931 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6933 \def\macro{\recursivefalse\parsearg\macroxxx}
6934 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6937 \getargs{#1}% now \macname is the macname and \argl the arglist
6938 \ifx\argl\empty % no arguments
6941 \expandafter\parsemargdef \argl;%
6943 \if1\csname ismacro.\the\macname\endcsname
6944 \message{Warning: redefining \the\macname}%
6946 \expandafter\ifx\csname \the\macname\endcsname \relax
6947 \else \errmessage{Macro name \the\macname\space already defined}\fi
6948 \global\cslet{macsave.\the\macname}{\the\macname}%
6949 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6950 \addtomacrolist{\the\macname}%
6952 \begingroup \macrobodyctxt
6953 \ifrecursive \expandafter\parsermacbody
6954 \else \expandafter\parsemacbody
6957 \parseargdef\unmacro{%
6958 \if1\csname ismacro.#1\endcsname
6959 \global\cslet{#1}{macsave.#1}%
6960 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6961 % Remove the macro name from \macrolist:
6963 \expandafter\let\csname#1\endcsname \relax
6964 \let\definedummyword\unmacrodo
6965 \xdef\macrolist{\macrolist}%
6968 \errmessage{Macro #1 not defined}%
6972 % Called by \do from \dounmacro on each macro. The idea is to omit any
6973 % macro definitions that have been changed to \relax.
6979 \noexpand\definedummyword \noexpand#1%
6983 % This makes use of the obscure feature that if the last token of a
6984 % <parameter list> is #, then the preceding argument is delimited by
6985 % an opening brace, and that opening brace is not consumed.
6986 \def\getargs#1{\getargsxxx#1{}}
6987 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6988 \def\getmacname #1 #2\relax{\macname={#1}}
6989 \def\getmacargs#1{\def\argl{#1}}
6991 % Parse the optional {params} list. Set up \paramno and \paramlist
6992 % so \defmacro knows what to do. Define \macarg.blah for each blah
6993 % in the params list, to be ##N where N is the position in that list.
6994 % That gets used by \mbodybackslash (above).
6996 % We need to get `macro parameter char #' into several definitions.
6997 % The technique used is stolen from LaTeX: let \hash be something
6998 % unexpandable, insert that wherever you need a #, and then redefine
6999 % it to # just before using the token list produced.
7001 % The same technique is used to protect \eatspaces till just before
7002 % the macro is used.
7004 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
7005 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
7006 \def\parsemargdefxxx#1,{%
7007 \if#1;\let\next=\relax
7008 \else \let\next=\parsemargdefxxx
7009 \advance\paramno by 1%
7010 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7011 {\xeatspaces{\hash\the\paramno}}%
7012 \edef\paramlist{\paramlist\hash\the\paramno,}%
7015 % These two commands read recursive and nonrecursive macro bodies.
7016 % (They're different since rec and nonrec macros end differently.)
7018 \long\def\parsemacbody#1@end macro%
7019 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7020 \long\def\parsermacbody#1@end rmacro%
7021 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7023 % This defines the macro itself. There are six cases: recursive and
7024 % nonrecursive macros of zero, one, and many arguments.
7025 % Much magic with \expandafter here.
7026 % \xdef is used so that macro definitions will survive the file
7027 % they're defined in; @include reads the file inside a group.
7029 \let\hash=##% convert placeholders to macro parameter chars
7033 \expandafter\xdef\csname\the\macname\endcsname{%
7034 \noexpand\scanmacro{\temp}}%
7036 \expandafter\xdef\csname\the\macname\endcsname{%
7037 \bgroup\noexpand\macroargctxt
7038 \noexpand\braceorline
7039 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7040 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7041 \egroup\noexpand\scanmacro{\temp}}%
7043 \expandafter\xdef\csname\the\macname\endcsname{%
7044 \bgroup\noexpand\macroargctxt
7045 \noexpand\csname\the\macname xx\endcsname}%
7046 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7047 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7048 \expandafter\expandafter
7050 \expandafter\expandafter
7051 \csname\the\macname xxx\endcsname
7052 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7057 \expandafter\xdef\csname\the\macname\endcsname{%
7058 \noexpand\norecurse{\the\macname}%
7059 \noexpand\scanmacro{\temp}\egroup}%
7061 \expandafter\xdef\csname\the\macname\endcsname{%
7062 \bgroup\noexpand\macroargctxt
7063 \noexpand\braceorline
7064 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7065 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7067 \noexpand\norecurse{\the\macname}%
7068 \noexpand\scanmacro{\temp}\egroup}%
7070 \expandafter\xdef\csname\the\macname\endcsname{%
7071 \bgroup\noexpand\macroargctxt
7072 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7073 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7074 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7075 \expandafter\expandafter
7077 \expandafter\expandafter
7078 \csname\the\macname xxx\endcsname
7081 \noexpand\norecurse{\the\macname}%
7082 \noexpand\scanmacro{\temp}\egroup}%
7086 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7088 % \braceorline decides whether the next nonwhitespace character is a
7089 % {. If so it reads up to the closing }, if not, it reads the whole
7090 % line. Whatever was read is then fed to the next control sequence
7091 % as an argument (by \parsebrace or \parsearg)
7092 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7093 \def\braceorlinexxx{%
7094 \ifx\nchar\bgroup\else
7095 \expandafter\parsearg
7100 % We need some trickery to remove the optional spaces around the equal
7101 % sign. Just make them active and then expand them all to nothing.
7102 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7103 \def\aliasxxx #1{\aliasyyy#1\relax}
7104 \def\aliasyyy #1=#2\relax{%
7106 \expandafter\let\obeyedspace=\empty
7107 \addtomacrolist{#1}%
7108 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7114 \message{cross references,}
7117 \newif\ifhavexrefs % True if xref values are known.
7118 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7120 % @inforef is relatively simple.
7121 \def\inforef #1{\inforefzzz #1,,,,**}
7122 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7123 node \samp{\ignorespaces#1{}}}
7125 % @node's only job in TeX is to define \lastnode, which is used in
7126 % cross-references. The @node line might or might not have commas, and
7127 % might or might not have spaces before the first comma, like:
7128 % @node foo , bar , ...
7129 % We don't want such trailing spaces in the node name.
7131 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7133 % also remove a trailing comma, in case of something like this:
7134 % @node Help-Cross, , , Cross-refs
7135 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7136 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7139 \let\lastnode=\empty
7141 % Write a cross-reference definition for the current node. #1 is the
7142 % type (Ynumbered, Yappendix, Ynothing).
7145 \ifx\lastnode\empty\else
7146 \setref{\lastnode}{#1}%
7147 \global\let\lastnode=\empty
7151 % @anchor{NAME} -- define xref target at arbitrary point.
7153 \newcount\savesfregister
7155 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7156 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7157 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7159 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7160 % anchor), which consists of three parts:
7161 % 1) NAME-title - the current sectioning name taken from \lastsection,
7162 % or the anchor name.
7163 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7164 % empty for anchors.
7165 % 3) NAME-pg - the page number.
7167 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7168 % floats, there is an additional part, which is not written here:
7169 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7175 \atdummies % preserve commands, but don't expand them
7176 \edef\writexrdef##1##2{%
7177 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7178 ##1}{##2}}% these are parameters of \writexrdef
7180 \toks0 = \expandafter{\lastsection}%
7181 \immediate \writexrdef{title}{\the\toks0 }%
7182 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7183 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7188 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7189 % the node name, #2 the name of the Info cross-reference, #3 the printed
7190 % node name, #4 the name of the Info file, #5 the name of the printed
7191 % manual. All but the node name can be omitted.
7193 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7194 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7195 \def\ref#1{\xrefX[#1,,,,,,,]}
7196 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7198 \def\printedmanual{\ignorespaces #5}%
7199 \def\printedrefname{\ignorespaces #3}%
7200 \setbox1=\hbox{\printedmanual\unskip}%
7201 \setbox0=\hbox{\printedrefname\unskip}%
7203 % No printed node name was explicitly given.
7204 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7205 % Use the node name inside the square brackets.
7206 \def\printedrefname{\ignorespaces #1}%
7208 % Use the actual chapter/section title appear inside
7209 % the square brackets. Use the real section title if we have it.
7211 % It is in another manual, so we don't have it.
7212 \def\printedrefname{\ignorespaces #1}%
7215 % We know the real title if we have the xref values.
7216 \def\printedrefname{\refx{#1-title}{}}%
7218 % Otherwise just copy the Info node name.
7219 \def\printedrefname{\ignorespaces #1}%
7225 % Make link in pdf output.
7229 % This expands tokens, so do it after making catcode changes, so _
7230 % etc. don't get their TeX definitions.
7233 % See comments at \activebackslashdouble.
7234 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7235 \backslashparens\pdfxrefdest}%
7238 \startlink attr{/Border [0 0 0]}%
7239 \ifnum\filenamelength>0
7240 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7242 goto name{\pdfmkpgn{\pdfxrefdest}}%
7245 \setcolor{\linkcolor}%
7248 % Float references are printed completely differently: "Figure 1.2"
7249 % instead of "[somenode], p.3". We distinguish them by the
7250 % LABEL-title being set to a magic string.
7252 % Have to otherify everything special to allow the \csname to
7253 % include an _ in the xref name, etc.
7256 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7257 \csname XR#1-title\endcsname
7259 \iffloat\Xthisreftitle
7260 % If the user specified the print name (third arg) to the ref,
7261 % print it instead of our usual "Figure 1.2".
7268 % if the user also gave the printed manual name (fifth arg), append
7271 \space \putwordin{} \cite{\printedmanual}%
7274 % node/anchor (non-float) references.
7276 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7277 % insert empty discretionaries after hyphens, which means that it will
7278 % not find a line break at a hyphen in a node names. Since some manuals
7279 % are best written with fairly long node names, containing hyphens, this
7280 % is a loss. Therefore, we give the text of the node name again, so it
7281 % is as if TeX is seeing it for the first time.
7283 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7285 % _ (for example) has to be the character _ for the purposes of the
7286 % control sequence corresponding to the node, but it has to expand
7287 % into the usual \leavevmode...\vrule stuff for purposes of
7288 % printing. So we \turnoffactive for the \refx-snt, back on for the
7289 % printing, back off for the \refx-pg.
7291 % Only output a following space if the -snt ref is nonempty; for
7292 % @unnumbered and @anchor, it won't be.
7293 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7294 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7296 % output the `[mynode]' via a macro so it can be overridden.
7297 \xrefprintnodename\printedrefname
7299 % But we always want a comma and a space:
7302 % output the `page 3'.
7303 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7309 % This macro is called from \xrefX for the `[nodename]' part of xref
7310 % output. It's a separate macro only so it can be changed more easily,
7311 % since square brackets don't work well in some documents. Particularly
7312 % one that Bob is working on :).
7314 \def\xrefprintnodename#1{[#1]}
7316 % Things referred to by \setref.
7322 \putwordChapter@tie \the\chapno
7323 \else \ifnum\subsecno=0
7324 \putwordSection@tie \the\chapno.\the\secno
7325 \else \ifnum\subsubsecno=0
7326 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7328 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7333 \putwordAppendix@tie @char\the\appendixno{}%
7334 \else \ifnum\subsecno=0
7335 \putwordSection@tie @char\the\appendixno.\the\secno
7336 \else \ifnum\subsubsecno=0
7337 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7340 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7344 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7345 % If its value is nonempty, SUFFIX is output afterward.
7351 \expandafter\global\expandafter\let\expandafter\thisrefX
7352 \csname XR#1\endcsname
7355 % If not defined, say something at least.
7356 \angleleft un\-de\-fined\angleright
7359 \message{\linenumber Undefined cross reference `#1'.}%
7362 \global\warnedxrefstrue
7363 \message{Cross reference values unknown; you must run TeX again.}%
7368 % It's defined, so just use it.
7371 #2% Output the suffix in any case.
7374 % This is the macro invoked by entries in the aux file. Usually it's
7375 % just a \def (we prepend XR to the control sequence name to avoid
7376 % collisions). But if this is a float type, we have more work to do.
7379 {% The node name might contain 8-bit characters, which in our current
7380 % implementation are changed to commands like @'e. Don't let these
7381 % mess up the control sequence name.
7384 \xdef\safexrefname{#1}%
7387 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7389 % Was that xref control sequence that we just defined for a float?
7390 \expandafter\iffloat\csname XR\safexrefname\endcsname
7391 % it was a float, and we have the (safe) float type in \iffloattype.
7392 \expandafter\let\expandafter\floatlist
7393 \csname floatlist\iffloattype\endcsname
7395 % Is this the first time we've seen this float type?
7396 \expandafter\ifx\floatlist\relax
7397 \toks0 = {\do}% yes, so just \do
7399 % had it before, so preserve previous elements in list.
7400 \toks0 = \expandafter{\floatlist\do}%
7403 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7404 % for later use in \listoffloats.
7405 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7410 % Read the last existing aux file, if any. No error if none exists.
7413 \openin 1 \jobname.aux
7416 \global\havexrefstrue
7421 \def\setupdatafile{%
7422 \catcode`\^^@=\other
7423 \catcode`\^^A=\other
7424 \catcode`\^^B=\other
7425 \catcode`\^^C=\other
7426 \catcode`\^^D=\other
7427 \catcode`\^^E=\other
7428 \catcode`\^^F=\other
7429 \catcode`\^^G=\other
7430 \catcode`\^^H=\other
7431 \catcode`\^^K=\other
7432 \catcode`\^^L=\other
7433 \catcode`\^^N=\other
7434 \catcode`\^^P=\other
7435 \catcode`\^^Q=\other
7436 \catcode`\^^R=\other
7437 \catcode`\^^S=\other
7438 \catcode`\^^T=\other
7439 \catcode`\^^U=\other
7440 \catcode`\^^V=\other
7441 \catcode`\^^W=\other
7442 \catcode`\^^X=\other
7443 \catcode`\^^Z=\other
7444 \catcode`\^^[=\other
7445 \catcode`\^^\=\other
7446 \catcode`\^^]=\other
7447 \catcode`\^^^=\other
7448 \catcode`\^^_=\other
7449 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7450 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7451 % supported in the main text, it doesn't seem desirable. Furthermore,
7452 % that is not enough: for node names that actually contain a ^
7453 % character, we would end up writing a line like this: 'xrdef {'hat
7454 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7455 % argument, and \hat is not an expandable control sequence. It could
7456 % all be worked out, but why? Either we support ^^ or we don't.
7458 % The other change necessary for this was to define \auxhat:
7459 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7460 % and then to call \auxhat in \setq.
7464 % Special characters. Should be turned off anyway, but...
7477 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7479 % This is to support \ in node names and titles, since the \
7480 % characters end up in a \csname. It's easier than
7481 % leaving it active and making its active definition an actual \
7482 % character. What I don't understand is why it works in the *value*
7483 % of the xrdef. Seems like it should be a catcode12 \, and that
7484 % should not typeset properly. But it works, so I'm moving on for
7485 % now. --karl, 15jan04.
7488 % Make the characters 128-255 be printing characters.
7492 \catcode\count1=\other
7493 \advance\count1 by 1
7494 \ifnum \count1<256 \loop \fi
7498 % @ is our escape character in .aux files, and we need braces.
7504 \def\readdatafile#1{%
7511 \message{insertions,}
7512 % including footnotes.
7514 \newcount \footnoteno
7516 % The trailing space in the following definition for supereject is
7517 % vital for proper filling; pages come out unaligned when you do a
7518 % pagealignmacro call if that space before the closing brace is
7519 % removed. (Generally, numeric constants should always be followed by a
7520 % space to prevent strange expansion errors.)
7521 \def\supereject{\par\penalty -20000\footnoteno =0 }
7523 % @footnotestyle is meaningful for info output only.
7524 \let\footnotestyle=\comment
7528 % Auto-number footnotes. Otherwise like plain.
7530 \let\indent=\ptexindent
7531 \let\noindent=\ptexnoindent
7532 \global\advance\footnoteno by \@ne
7533 \edef\thisfootno{$^{\the\footnoteno}$}%
7535 % In case the footnote comes at the end of a sentence, preserve the
7536 % extra spacing after we do the footnote number.
7538 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7540 % Remove inadvertent blank space before typesetting the footnote number.
7546 % Don't bother with the trickery in plain.tex to not require the
7547 % footnote text as a parameter. Our footnotes don't need to be so general.
7549 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7550 % \parseargline) fails inside footnotes because the tokens are fixed when
7551 % the footnote is read. --karl, 16nov96.
7554 \insert\footins\bgroup
7555 % We want to typeset this text as a normal paragraph, even if the
7556 % footnote reference occurs in (for example) a display environment.
7557 % So reset some parameters.
7559 \interlinepenalty\interfootnotelinepenalty
7560 \splittopskip\ht\strutbox % top baseline for broken footnotes
7561 \splitmaxdepth\dp\strutbox
7562 \floatingpenalty\@MM
7567 \parindent\defaultparindent
7571 % Because we use hanging indentation in footnotes, a @noindent appears
7572 % to exdent this text, so make it be a no-op. makeinfo does not use
7573 % hanging indentation so @noindent can still be needed within footnote
7574 % text after an @example or the like (not that this is good style).
7575 \let\noindent = \relax
7577 % Hang the footnote text off the number. Use \everypar in case the
7578 % footnote extends for more than one paragraph.
7579 \everypar = {\hang}%
7580 \textindent{\thisfootno}%
7582 % Don't crash into the line above the footnote text. Since this
7583 % expands into a box, it must come within the paragraph, lest it
7584 % provide a place where TeX can split the footnote.
7586 \futurelet\next\fo@t
7588 }%end \catcode `\@=11
7590 % In case a @footnote appears in a vbox, save the footnote text and create
7591 % the real \insert just after the vbox finished. Otherwise, the insertion
7593 % Similarly, if a @footnote appears inside an alignment, save the footnote
7594 % text to a box and make the \insert when a row of the table is finished.
7595 % And the same can be done for other insert classes. --kasal, 16nov03.
7597 % Replace the \insert primitive by a cheating macro.
7598 % Deeper inside, just make sure that the saved insertions are not spilled
7601 \def\startsavinginserts{%
7602 \ifx \insert\ptexinsert
7603 \let\insert\saveinsert
7605 \let\checkinserts\relax
7609 % This \insert replacement works for both \insert\footins{foo} and
7610 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7613 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7614 \afterassignment\next
7615 % swallow the left brace
7618 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7619 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7621 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7623 \def\placesaveins#1{%
7624 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7628 % eat @SAVE -- beware, all of them have catcode \other:
7630 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7631 \gdef\gobblesave @SAVE{}
7635 \def\newsaveins #1{%
7636 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7639 \def\newsaveinsX #1{%
7640 \csname newbox\endcsname #1%
7641 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7646 \let\checkinserts\empty
7651 % @image. We use the macros from epsf.tex to support this.
7652 % If epsf.tex is not installed and @image is used, we complain.
7654 % Check for and read epsf.tex up front. If we read it only at @image
7655 % time, we might be inside a group, and then its definitions would get
7656 % undone and the next image would fail.
7657 \openin 1 = epsf.tex
7659 % Do not bother showing banner with epsf.tex v2.7k (available in
7660 % doc/epsf.tex and on ctan).
7661 \def\epsfannounce{\toks0 = }%
7666 % We will only complain once about lack of epsf.tex.
7667 \newif\ifwarnednoepsf
7668 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7669 work. It is also included in the Texinfo distribution, or you can get
7670 it from ftp://tug.org/tex/epsf.tex.}
7673 \ifx\epsfbox\undefined
7674 \ifwarnednoepsf \else
7675 \errhelp = \noepsfhelp
7676 \errmessage{epsf.tex not found, images will be ignored}%
7677 \global\warnednoepsftrue
7680 \imagexxx #1,,,,,\finish
7684 % Arguments to @image:
7685 % #1 is (mandatory) image filename; we tack on .eps extension.
7686 % #2 is (optional) width, #3 is (optional) height.
7687 % #4 is (ignored optional) html alt text.
7688 % #5 is (ignored optional) extension.
7689 % #6 is just the usual extra ignored arg for parsing this stuff.
7691 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7692 \catcode`\^^M = 5 % in case we're inside an example
7693 \normalturnoffactive % allow _ et al. in names
7694 % If the image is by itself, center it.
7698 % Usually we'll have text after the image which will insert
7699 % \parskip glue, so insert it here too to equalize the space
7701 \nobreak\vskip\parskip
7705 % Leave vertical mode so that indentation from an enclosing
7706 % environment such as @quotation is respected. On the other hand, if
7707 % it's at the top level, we don't want the normal paragraph indentation.
7712 \dopdfimage{#1}{#2}{#3}%
7714 % \epsfbox itself resets \epsf?size at each figure.
7715 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7716 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7720 \ifimagevmode \medskip \fi % space after the standalone image
7724 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7725 % etc. We don't actually implement floating yet, we always include the
7726 % float "here". But it seemed the best name for the future.
7728 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7730 % There may be a space before second and/or third parameter; delete it.
7731 \def\eatcommaspace#1, {#1,}
7733 % #1 is the optional FLOATTYPE, the text label for this float, typically
7734 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7735 % this float will not be numbered and cannot be referred to.
7737 % #2 is the optional xref label. Also must be present for the float to
7740 % #3 is the optional positioning argument; for now, it is ignored. It
7741 % will somehow specify the positions allowed to float to (here, top, bottom).
7743 % We keep a separate counter for each FLOATTYPE, which we reset at each
7744 % chapter-level command.
7745 \let\resetallfloatnos=\empty
7747 \def\dofloat#1,#2,#3,#4\finish{%
7748 \let\thiscaption=\empty
7749 \let\thisshortcaption=\empty
7751 % don't lose footnotes inside @float.
7753 % BEWARE: when the floats start float, we have to issue warning whenever an
7754 % insert appears inside a float which could possibly float. --kasal, 26may04
7758 % We can't be used inside a paragraph.
7763 \def\floatlabel{#2}%
7764 \def\floatloc{#3}% we do nothing with this yet.
7766 \ifx\floattype\empty
7767 \let\safefloattype=\empty
7770 % the floattype might have accents or other special characters,
7771 % but we need to use it in a control sequence name.
7774 \xdef\safefloattype{\floattype}%
7778 % If label is given but no type, we handle that as the empty type.
7779 \ifx\floatlabel\empty \else
7780 % We want each FLOATTYPE to be numbered separately (Figure 1,
7781 % Table 1, Figure 2, ...). (And if no label, no number.)
7783 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7784 \global\advance\floatno by 1
7787 % This magic value for \lastsection is output by \setref as the
7788 % XREFLABEL-title value. \xrefX uses it to distinguish float
7789 % labels (which have a completely different output format) from
7790 % node and anchor labels. And \xrdef uses it to construct the
7793 \edef\lastsection{\floatmagic=\safefloattype}%
7794 \setref{\floatlabel}{Yfloat}%
7798 % start with \parskip glue, I guess.
7801 % Don't suppress indentation if a float happens to start a section.
7802 \restorefirstparagraphindent
7805 % we have these possibilities:
7806 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7807 % @float Foo,lbl & no caption: Foo 1.1
7808 % @float Foo & @caption{Cap}: Foo: Cap
7809 % @float Foo & no caption: Foo
7810 % @float ,lbl & Caption{Cap}: 1.1: Cap
7811 % @float ,lbl & no caption: 1.1
7812 % @float & @caption{Cap}: Cap
7813 % @float & no caption:
7816 \let\floatident = \empty
7818 % In all cases, if we have a float type, it comes first.
7819 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7821 % If we have an xref label, the number comes next.
7822 \ifx\floatlabel\empty \else
7823 \ifx\floattype\empty \else % if also had float type, need tie first.
7824 \appendtomacro\floatident{\tie}%
7827 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7830 % Start the printed caption with what we've constructed in
7831 % \floatident, but keep it separate; we need \floatident again.
7832 \let\captionline = \floatident
7834 \ifx\thiscaption\empty \else
7835 \ifx\floatident\empty \else
7836 \appendtomacro\captionline{: }% had ident, so need a colon between
7840 \appendtomacro\captionline{\scanexp\thiscaption}%
7843 % If we have anything to print, print it, with space before.
7844 % Eventually this needs to become an \insert.
7845 \ifx\captionline\empty \else
7849 % Space below caption.
7853 % If have an xref label, write the list of floats info. Do this
7854 % after the caption, to avoid chance of it being a breakpoint.
7855 \ifx\floatlabel\empty \else
7856 % Write the text that goes in the lof to the aux file as
7857 % \floatlabel-lof. Besides \floatident, we include the short
7858 % caption if specified, else the full caption if specified, else nothing.
7862 % since we read the caption text in the macro world, where ^^M
7863 % is turned into a normal character, we have to scan it back, so
7864 % we don't write the literal three characters "^^M" into the aux file.
7866 \xdef\noexpand\gtemp{%
7867 \ifx\thisshortcaption\empty
7874 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7875 \ifx\gtemp\empty \else : \gtemp \fi}}%
7878 \egroup % end of \vtop
7880 % place the captured inserts
7882 % BEWARE: when the floats start floating, we have to issue warning
7883 % whenever an insert appears inside a float which could possibly
7884 % float. --kasal, 26may04
7889 % Append the tokens #2 to the definition of macro #1, not expanding either.
7891 \def\appendtomacro#1#2{%
7892 \expandafter\def\expandafter#1\expandafter{#1#2}%
7895 % @caption, @shortcaption
7897 \def\caption{\docaption\thiscaption}
7898 \def\shortcaption{\docaption\thisshortcaption}
7899 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7900 \def\defcaption#1#2{\egroup \def#1{#2}}
7902 % The parameter is the control sequence identifying the counter we are
7903 % going to use. Create it if it doesn't exist and assign it to \floatno.
7906 % Haven't seen this figure type before.
7907 \csname newcount\endcsname #1%
7909 % Remember to reset this floatno at the next chap.
7910 \expandafter\gdef\expandafter\resetallfloatnos
7911 \expandafter{\resetallfloatnos #1=0 }%
7916 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7917 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7918 % first read the @float command.
7920 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7922 % Magic string used for the XREFLABEL-title value, so \xrefX can
7923 % distinguish floats from other xref types.
7924 \def\floatmagic{!!float!!}
7926 % #1 is the control sequence we are passed; we expand into a conditional
7927 % which is true if #1 represents a float ref. That is, the magic
7928 % \lastsection value which we \setref above.
7930 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7932 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7933 % (safe) float type for this float. We set \iffloattype to #2.
7935 \def\doiffloat#1=#2=#3\finish{%
7937 \def\iffloattype{#2}%
7938 \ifx\temp\floatmagic
7941 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7943 \parseargdef\listoffloats{%
7944 \def\floattype{#1}% floattype
7946 % the floattype might have accents or other special characters,
7947 % but we need to use it in a control sequence name.
7950 \xdef\safefloattype{\floattype}%
7953 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7954 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7956 % if the user said @listoffloats foo but never @float foo.
7957 \message{\linenumber No `\safefloattype' floats to list.}%
7961 \leftskip=\tocindent % indent these entries like a toc
7962 \let\do=\listoffloatsdo
7963 \csname floatlist\safefloattype\endcsname
7968 % This is called on each entry in a list of floats. We're passed the
7969 % xref label, in the form LABEL-title, which is how we save it in the
7970 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7971 % has the text we're supposed to typeset here.
7973 % Figures without xref labels will not be included in the list (since
7974 % they won't appear in the aux file).
7976 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7977 \def\listoffloatsdoentry#1-title\finish{{%
7978 % Can't fully expand XR#1-lof because it can contain anything. Just
7979 % pass the control sequence. On the other hand, XR#1-pg is just the
7980 % page number, and we want to fully expand that so we can get a link
7982 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7984 % use the same \entry macro we use to generate the TOC and index.
7985 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7990 \message{localization,}
7992 % For single-language documents, @documentlanguage is usually given very
7993 % early, just after @documentencoding. Single argument is the language
7994 % (de) or locale (de_DE) abbreviation.
7997 \catcode`\_ = \active
7999 \parseargdef\documentlanguage{\begingroup
8000 \let_=\normalunderscore % normal _ character for filenames
8001 \tex % read txi-??.tex file in plain TeX.
8002 % Read the file by the name they passed if it exists.
8003 \openin 1 txi-#1.tex
8005 \documentlanguagetrywithoutunderscore{#1_\finish}%
8007 \globaldefs = 1 % everything in the txi-LL files needs to persist
8011 \endgroup % end raw TeX
8014 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8017 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8018 \openin 1 txi-#1.tex
8020 \errhelp = \nolanghelp
8021 \errmessage{Cannot read language file txi-#1.tex}%
8023 \globaldefs = 1 % everything in the txi-LL files needs to persist
8028 }% end of special _ catcode
8030 \newhelp\nolanghelp{The given language definition file cannot be found or
8031 is empty. Maybe you need to install it? Putting it in the current
8032 directory should work if nowhere else does.}
8034 % This macro is called from txi-??.tex files; the first argument is the
8035 % \language name to set (without the "\lang@" prefix), the second and
8036 % third args are \{left,right}hyphenmin.
8038 % The language names to pass are determined when the format is built.
8039 % See the etex.log file created at that time, e.g.,
8040 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8042 % With TeX Live 2008, etex now includes hyphenation patterns for all
8043 % available languages. This means we can support hyphenation in
8044 % Texinfo, at least to some extent. (This still doesn't solve the
8045 % accented characters problem.)
8048 \def\txisetlanguage#1#2#3{%
8049 % do not set the language if the name is undefined in the current TeX.
8050 \expandafter\ifx\csname lang@#1\endcsname \relax
8051 \message{no patterns for #1}%
8053 \global\language = \csname lang@#1\endcsname
8055 % but there is no harm in adjusting the hyphenmin values regardless.
8056 \global\lefthyphenmin = #2\relax
8057 \global\righthyphenmin = #3\relax
8060 % Helpers for encodings.
8061 % Set the catcode of characters 128 through 255 to the specified number.
8063 \def\setnonasciicharscatcode#1{%
8065 \loop\ifnum\count255<256
8066 \global\catcode\count255=#1\relax
8067 \advance\count255 by 1
8071 \def\setnonasciicharscatcodenonglobal#1{%
8073 \loop\ifnum\count255<256
8074 \catcode\count255=#1\relax
8075 \advance\count255 by 1
8079 % @documentencoding sets the definition of non-ASCII characters
8080 % according to the specified encoding.
8082 \parseargdef\documentencoding{%
8083 % Encoding being declared for the document.
8084 \def\declaredencoding{\csname #1.enc\endcsname}%
8086 % Supported encodings: names converted to tokens in order to be able
8087 % to compare them with \ifx.
8088 \def\ascii{\csname US-ASCII.enc\endcsname}%
8089 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8090 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8091 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8092 \def\utfeight{\csname UTF-8.enc\endcsname}%
8094 \ifx \declaredencoding \ascii
8097 \else \ifx \declaredencoding \lattwo
8098 \setnonasciicharscatcode\active
8101 \else \ifx \declaredencoding \latone
8102 \setnonasciicharscatcode\active
8105 \else \ifx \declaredencoding \latnine
8106 \setnonasciicharscatcode\active
8109 \else \ifx \declaredencoding \utfeight
8110 \setnonasciicharscatcode\active
8114 \message{Unknown document encoding #1, ignoring.}%
8123 % A message to be logged when using a character that isn't available
8124 % the default font encoding (OT1).
8126 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8128 % Take account of \c (plain) vs. \, (Texinfo) difference.
8129 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8131 % First, make active non-ASCII characters in order for them to be
8132 % correctly categorized when TeX reads the replacement text of
8133 % macros containing the character definitions.
8134 \setnonasciicharscatcode\active
8136 % Latin1 (ISO-8859-1) character definitions.
8137 \def\latonechardefs{%
8139 \gdef^^a1{\exclamdown}
8140 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8141 \gdef^^a3{{\pounds}}
8142 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8143 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8144 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8147 \gdef^^a9{\copyright}
8149 \gdef^^ab{\guillemetleft}
8152 \gdef^^ae{\registeredsymbol}
8155 \gdef^^b0{\textdegree}
8164 \gdef^^b8{\cedilla\ }
8168 \gdef^^bb{\guilletright}
8169 \gdef^^bc{$1\over4$}
8170 \gdef^^bd{$1\over2$}
8171 \gdef^^be{$3\over4$}
8172 \gdef^^bf{\questiondown}
8179 \gdef^^c5{\ringaccent A}
8181 \gdef^^c7{\cedilla C}
8213 \gdef^^e5{\ringaccent a}
8215 \gdef^^e7{\cedilla c}
8220 \gdef^^ec{\`{\dotless i}}
8221 \gdef^^ed{\'{\dotless i}}
8222 \gdef^^ee{\^{\dotless i}}
8223 \gdef^^ef{\"{\dotless i}}
8243 % Latin9 (ISO-8859-15) encoding character definitions.
8244 \def\latninechardefs{%
8245 % Encoding is almost identical to Latin1.
8258 % Latin2 (ISO-8859-2) character definitions.
8259 \def\lattwochardefs{%
8261 \gdef^^a1{\ogonek{A}}
8264 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8270 \gdef^^aa{\cedilla S}
8275 \gdef^^af{\dotaccent Z}
8277 \gdef^^b0{\textdegree}
8278 \gdef^^b1{\ogonek{a}}
8279 \gdef^^b2{\ogonek{ }}
8285 \gdef^^b8{\cedilla\ }
8287 \gdef^^ba{\cedilla s}
8292 \gdef^^bf{\dotaccent z}
8301 \gdef^^c7{\cedilla C}
8304 \gdef^^ca{\ogonek{E}}
8320 \gdef^^d9{\ringaccent U}
8325 \gdef^^de{\cedilla T}
8335 \gdef^^e7{\cedilla c}
8338 \gdef^^ea{\ogonek{e}}
8354 \gdef^^f9{\ringaccent u}
8359 \gdef^^fe{\cedilla t}
8360 \gdef^^ff{\dotaccent{}}
8363 % UTF-8 character definitions.
8365 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8366 % changes for Texinfo conventions. It is included here under the GPL by
8367 % permission from Frank Mittelbach and the LaTeX team.
8373 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8374 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8376 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8377 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8379 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8380 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8382 \gdef\UTFviiiDefined#1{%
8384 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8395 \global\catcode\countUTFx\active
8396 \uccode`\~\countUTFx
8397 \uppercase\expandafter{\UTFviiiTmp}%
8398 \advance\countUTFx by 1
8399 \ifnum\countUTFx < \countUTFy
8400 \expandafter\UTFviiiLoop
8406 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8412 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8418 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8431 \gdef\DeclareUnicodeCharacter#1#2{%
8432 \countUTFz = "#1\relax
8433 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8436 \def\UTFviiiTwoOctets##1##2{%
8437 \csname u8:##1\string ##2\endcsname}%
8438 \def\UTFviiiThreeOctets##1##2##3{%
8439 \csname u8:##1\string ##2\string ##3\endcsname}%
8440 \def\UTFviiiFourOctets##1##2##3##4{%
8441 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8442 \expandafter\expandafter\expandafter\expandafter
8443 \expandafter\expandafter\expandafter
8444 \gdef\UTFviiiTmp{#2}%
8447 \gdef\parseXMLCharref{%
8448 \ifnum\countUTFz < "A0\relax
8449 \errhelp = \EMsimple
8450 \errmessage{Cannot define Unicode char value < 00A0}%
8451 \else\ifnum\countUTFz < "800\relax
8453 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8454 \else\ifnum\countUTFz < "10000\relax
8457 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8462 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8466 \gdef\parseUTFviiiA#1{%
8467 \countUTFx = \countUTFz
8468 \divide\countUTFz by 64
8469 \countUTFy = \countUTFz
8470 \multiply\countUTFz by 64
8471 \advance\countUTFx by -\countUTFz
8472 \advance\countUTFx by 128
8473 \uccode `#1\countUTFx
8474 \countUTFz = \countUTFy}
8476 \gdef\parseUTFviiiB#1#2#3#4{%
8477 \advance\countUTFz by "#10\relax
8478 \uccode `#3\countUTFz
8479 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8482 \def\utfeightchardefs{%
8483 \DeclareUnicodeCharacter{00A0}{\tie}
8484 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8485 \DeclareUnicodeCharacter{00A3}{\pounds}
8486 \DeclareUnicodeCharacter{00A8}{\"{ }}
8487 \DeclareUnicodeCharacter{00A9}{\copyright}
8488 \DeclareUnicodeCharacter{00AA}{\ordf}
8489 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8490 \DeclareUnicodeCharacter{00AD}{\-}
8491 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8492 \DeclareUnicodeCharacter{00AF}{\={ }}
8494 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8495 \DeclareUnicodeCharacter{00B4}{\'{ }}
8496 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8497 \DeclareUnicodeCharacter{00BA}{\ordm}
8498 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8499 \DeclareUnicodeCharacter{00BF}{\questiondown}
8501 \DeclareUnicodeCharacter{00C0}{\`A}
8502 \DeclareUnicodeCharacter{00C1}{\'A}
8503 \DeclareUnicodeCharacter{00C2}{\^A}
8504 \DeclareUnicodeCharacter{00C3}{\~A}
8505 \DeclareUnicodeCharacter{00C4}{\"A}
8506 \DeclareUnicodeCharacter{00C5}{\AA}
8507 \DeclareUnicodeCharacter{00C6}{\AE}
8508 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8509 \DeclareUnicodeCharacter{00C8}{\`E}
8510 \DeclareUnicodeCharacter{00C9}{\'E}
8511 \DeclareUnicodeCharacter{00CA}{\^E}
8512 \DeclareUnicodeCharacter{00CB}{\"E}
8513 \DeclareUnicodeCharacter{00CC}{\`I}
8514 \DeclareUnicodeCharacter{00CD}{\'I}
8515 \DeclareUnicodeCharacter{00CE}{\^I}
8516 \DeclareUnicodeCharacter{00CF}{\"I}
8518 \DeclareUnicodeCharacter{00D0}{\DH}
8519 \DeclareUnicodeCharacter{00D1}{\~N}
8520 \DeclareUnicodeCharacter{00D2}{\`O}
8521 \DeclareUnicodeCharacter{00D3}{\'O}
8522 \DeclareUnicodeCharacter{00D4}{\^O}
8523 \DeclareUnicodeCharacter{00D5}{\~O}
8524 \DeclareUnicodeCharacter{00D6}{\"O}
8525 \DeclareUnicodeCharacter{00D8}{\O}
8526 \DeclareUnicodeCharacter{00D9}{\`U}
8527 \DeclareUnicodeCharacter{00DA}{\'U}
8528 \DeclareUnicodeCharacter{00DB}{\^U}
8529 \DeclareUnicodeCharacter{00DC}{\"U}
8530 \DeclareUnicodeCharacter{00DD}{\'Y}
8531 \DeclareUnicodeCharacter{00DE}{\TH}
8532 \DeclareUnicodeCharacter{00DF}{\ss}
8534 \DeclareUnicodeCharacter{00E0}{\`a}
8535 \DeclareUnicodeCharacter{00E1}{\'a}
8536 \DeclareUnicodeCharacter{00E2}{\^a}
8537 \DeclareUnicodeCharacter{00E3}{\~a}
8538 \DeclareUnicodeCharacter{00E4}{\"a}
8539 \DeclareUnicodeCharacter{00E5}{\aa}
8540 \DeclareUnicodeCharacter{00E6}{\ae}
8541 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8542 \DeclareUnicodeCharacter{00E8}{\`e}
8543 \DeclareUnicodeCharacter{00E9}{\'e}
8544 \DeclareUnicodeCharacter{00EA}{\^e}
8545 \DeclareUnicodeCharacter{00EB}{\"e}
8546 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8547 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8548 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8549 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8551 \DeclareUnicodeCharacter{00F0}{\dh}
8552 \DeclareUnicodeCharacter{00F1}{\~n}
8553 \DeclareUnicodeCharacter{00F2}{\`o}
8554 \DeclareUnicodeCharacter{00F3}{\'o}
8555 \DeclareUnicodeCharacter{00F4}{\^o}
8556 \DeclareUnicodeCharacter{00F5}{\~o}
8557 \DeclareUnicodeCharacter{00F6}{\"o}
8558 \DeclareUnicodeCharacter{00F8}{\o}
8559 \DeclareUnicodeCharacter{00F9}{\`u}
8560 \DeclareUnicodeCharacter{00FA}{\'u}
8561 \DeclareUnicodeCharacter{00FB}{\^u}
8562 \DeclareUnicodeCharacter{00FC}{\"u}
8563 \DeclareUnicodeCharacter{00FD}{\'y}
8564 \DeclareUnicodeCharacter{00FE}{\th}
8565 \DeclareUnicodeCharacter{00FF}{\"y}
8567 \DeclareUnicodeCharacter{0100}{\=A}
8568 \DeclareUnicodeCharacter{0101}{\=a}
8569 \DeclareUnicodeCharacter{0102}{\u{A}}
8570 \DeclareUnicodeCharacter{0103}{\u{a}}
8571 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8572 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8573 \DeclareUnicodeCharacter{0106}{\'C}
8574 \DeclareUnicodeCharacter{0107}{\'c}
8575 \DeclareUnicodeCharacter{0108}{\^C}
8576 \DeclareUnicodeCharacter{0109}{\^c}
8577 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8578 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8579 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8580 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8581 \DeclareUnicodeCharacter{010C}{\v{C}}
8582 \DeclareUnicodeCharacter{010D}{\v{c}}
8583 \DeclareUnicodeCharacter{010E}{\v{D}}
8585 \DeclareUnicodeCharacter{0112}{\=E}
8586 \DeclareUnicodeCharacter{0113}{\=e}
8587 \DeclareUnicodeCharacter{0114}{\u{E}}
8588 \DeclareUnicodeCharacter{0115}{\u{e}}
8589 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8590 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8591 \DeclareUnicodeCharacter{011A}{\v{E}}
8592 \DeclareUnicodeCharacter{011B}{\v{e}}
8593 \DeclareUnicodeCharacter{011C}{\^G}
8594 \DeclareUnicodeCharacter{011D}{\^g}
8595 \DeclareUnicodeCharacter{011E}{\u{G}}
8596 \DeclareUnicodeCharacter{011F}{\u{g}}
8598 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8599 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8600 \DeclareUnicodeCharacter{0124}{\^H}
8601 \DeclareUnicodeCharacter{0125}{\^h}
8602 \DeclareUnicodeCharacter{0128}{\~I}
8603 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8604 \DeclareUnicodeCharacter{012A}{\=I}
8605 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8606 \DeclareUnicodeCharacter{012C}{\u{I}}
8607 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8609 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8610 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8611 \DeclareUnicodeCharacter{0132}{IJ}
8612 \DeclareUnicodeCharacter{0133}{ij}
8613 \DeclareUnicodeCharacter{0134}{\^J}
8614 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8615 \DeclareUnicodeCharacter{0139}{\'L}
8616 \DeclareUnicodeCharacter{013A}{\'l}
8618 \DeclareUnicodeCharacter{0141}{\L}
8619 \DeclareUnicodeCharacter{0142}{\l}
8620 \DeclareUnicodeCharacter{0143}{\'N}
8621 \DeclareUnicodeCharacter{0144}{\'n}
8622 \DeclareUnicodeCharacter{0147}{\v{N}}
8623 \DeclareUnicodeCharacter{0148}{\v{n}}
8624 \DeclareUnicodeCharacter{014C}{\=O}
8625 \DeclareUnicodeCharacter{014D}{\=o}
8626 \DeclareUnicodeCharacter{014E}{\u{O}}
8627 \DeclareUnicodeCharacter{014F}{\u{o}}
8629 \DeclareUnicodeCharacter{0150}{\H{O}}
8630 \DeclareUnicodeCharacter{0151}{\H{o}}
8631 \DeclareUnicodeCharacter{0152}{\OE}
8632 \DeclareUnicodeCharacter{0153}{\oe}
8633 \DeclareUnicodeCharacter{0154}{\'R}
8634 \DeclareUnicodeCharacter{0155}{\'r}
8635 \DeclareUnicodeCharacter{0158}{\v{R}}
8636 \DeclareUnicodeCharacter{0159}{\v{r}}
8637 \DeclareUnicodeCharacter{015A}{\'S}
8638 \DeclareUnicodeCharacter{015B}{\'s}
8639 \DeclareUnicodeCharacter{015C}{\^S}
8640 \DeclareUnicodeCharacter{015D}{\^s}
8641 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8642 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8644 \DeclareUnicodeCharacter{0160}{\v{S}}
8645 \DeclareUnicodeCharacter{0161}{\v{s}}
8646 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8647 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8648 \DeclareUnicodeCharacter{0164}{\v{T}}
8650 \DeclareUnicodeCharacter{0168}{\~U}
8651 \DeclareUnicodeCharacter{0169}{\~u}
8652 \DeclareUnicodeCharacter{016A}{\=U}
8653 \DeclareUnicodeCharacter{016B}{\=u}
8654 \DeclareUnicodeCharacter{016C}{\u{U}}
8655 \DeclareUnicodeCharacter{016D}{\u{u}}
8656 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8657 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8659 \DeclareUnicodeCharacter{0170}{\H{U}}
8660 \DeclareUnicodeCharacter{0171}{\H{u}}
8661 \DeclareUnicodeCharacter{0174}{\^W}
8662 \DeclareUnicodeCharacter{0175}{\^w}
8663 \DeclareUnicodeCharacter{0176}{\^Y}
8664 \DeclareUnicodeCharacter{0177}{\^y}
8665 \DeclareUnicodeCharacter{0178}{\"Y}
8666 \DeclareUnicodeCharacter{0179}{\'Z}
8667 \DeclareUnicodeCharacter{017A}{\'z}
8668 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8669 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8670 \DeclareUnicodeCharacter{017D}{\v{Z}}
8671 \DeclareUnicodeCharacter{017E}{\v{z}}
8673 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8674 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8675 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8676 \DeclareUnicodeCharacter{01C7}{LJ}
8677 \DeclareUnicodeCharacter{01C8}{Lj}
8678 \DeclareUnicodeCharacter{01C9}{lj}
8679 \DeclareUnicodeCharacter{01CA}{NJ}
8680 \DeclareUnicodeCharacter{01CB}{Nj}
8681 \DeclareUnicodeCharacter{01CC}{nj}
8682 \DeclareUnicodeCharacter{01CD}{\v{A}}
8683 \DeclareUnicodeCharacter{01CE}{\v{a}}
8684 \DeclareUnicodeCharacter{01CF}{\v{I}}
8686 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8687 \DeclareUnicodeCharacter{01D1}{\v{O}}
8688 \DeclareUnicodeCharacter{01D2}{\v{o}}
8689 \DeclareUnicodeCharacter{01D3}{\v{U}}
8690 \DeclareUnicodeCharacter{01D4}{\v{u}}
8692 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8693 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8694 \DeclareUnicodeCharacter{01E6}{\v{G}}
8695 \DeclareUnicodeCharacter{01E7}{\v{g}}
8696 \DeclareUnicodeCharacter{01E8}{\v{K}}
8697 \DeclareUnicodeCharacter{01E9}{\v{k}}
8699 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8700 \DeclareUnicodeCharacter{01F1}{DZ}
8701 \DeclareUnicodeCharacter{01F2}{Dz}
8702 \DeclareUnicodeCharacter{01F3}{dz}
8703 \DeclareUnicodeCharacter{01F4}{\'G}
8704 \DeclareUnicodeCharacter{01F5}{\'g}
8705 \DeclareUnicodeCharacter{01F8}{\`N}
8706 \DeclareUnicodeCharacter{01F9}{\`n}
8707 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8708 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8709 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8710 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8712 \DeclareUnicodeCharacter{021E}{\v{H}}
8713 \DeclareUnicodeCharacter{021F}{\v{h}}
8715 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8716 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8717 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8718 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8719 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8720 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8722 \DeclareUnicodeCharacter{0232}{\=Y}
8723 \DeclareUnicodeCharacter{0233}{\=y}
8724 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8726 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8728 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8729 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8730 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8731 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8732 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8733 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8734 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8735 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8736 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8737 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8738 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8739 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8741 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8742 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8744 \DeclareUnicodeCharacter{1E20}{\=G}
8745 \DeclareUnicodeCharacter{1E21}{\=g}
8746 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8747 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8748 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8749 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8750 \DeclareUnicodeCharacter{1E26}{\"H}
8751 \DeclareUnicodeCharacter{1E27}{\"h}
8753 \DeclareUnicodeCharacter{1E30}{\'K}
8754 \DeclareUnicodeCharacter{1E31}{\'k}
8755 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8756 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8757 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8758 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8759 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8760 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8761 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8762 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8763 \DeclareUnicodeCharacter{1E3E}{\'M}
8764 \DeclareUnicodeCharacter{1E3F}{\'m}
8766 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8767 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8768 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8769 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8770 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8771 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8772 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8773 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8774 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8775 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8777 \DeclareUnicodeCharacter{1E54}{\'P}
8778 \DeclareUnicodeCharacter{1E55}{\'p}
8779 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8780 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8781 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8782 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8783 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8784 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8785 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8786 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8788 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8789 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8790 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8791 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8792 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8793 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8794 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8795 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8796 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8797 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8799 \DeclareUnicodeCharacter{1E7C}{\~V}
8800 \DeclareUnicodeCharacter{1E7D}{\~v}
8801 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8802 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8804 \DeclareUnicodeCharacter{1E80}{\`W}
8805 \DeclareUnicodeCharacter{1E81}{\`w}
8806 \DeclareUnicodeCharacter{1E82}{\'W}
8807 \DeclareUnicodeCharacter{1E83}{\'w}
8808 \DeclareUnicodeCharacter{1E84}{\"W}
8809 \DeclareUnicodeCharacter{1E85}{\"w}
8810 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8811 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8812 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8813 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8814 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8815 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8816 \DeclareUnicodeCharacter{1E8C}{\"X}
8817 \DeclareUnicodeCharacter{1E8D}{\"x}
8818 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8819 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8821 \DeclareUnicodeCharacter{1E90}{\^Z}
8822 \DeclareUnicodeCharacter{1E91}{\^z}
8823 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8824 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8825 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8826 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8827 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8828 \DeclareUnicodeCharacter{1E97}{\"t}
8829 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8830 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8832 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8833 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8835 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8836 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8837 \DeclareUnicodeCharacter{1EBC}{\~E}
8838 \DeclareUnicodeCharacter{1EBD}{\~e}
8840 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8841 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8842 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8843 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8845 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8846 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8848 \DeclareUnicodeCharacter{1EF2}{\`Y}
8849 \DeclareUnicodeCharacter{1EF3}{\`y}
8850 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8852 \DeclareUnicodeCharacter{1EF8}{\~Y}
8853 \DeclareUnicodeCharacter{1EF9}{\~y}
8855 \DeclareUnicodeCharacter{2013}{--}
8856 \DeclareUnicodeCharacter{2014}{---}
8857 \DeclareUnicodeCharacter{2018}{\quoteleft}
8858 \DeclareUnicodeCharacter{2019}{\quoteright}
8859 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8860 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8861 \DeclareUnicodeCharacter{201D}{\quotedblright}
8862 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8863 \DeclareUnicodeCharacter{2022}{\bullet}
8864 \DeclareUnicodeCharacter{2026}{\dots}
8865 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8866 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8867 \DeclareUnicodeCharacter{20AC}{\euro}
8869 \DeclareUnicodeCharacter{2192}{\expansion}
8870 \DeclareUnicodeCharacter{21D2}{\result}
8872 \DeclareUnicodeCharacter{2212}{\minus}
8873 \DeclareUnicodeCharacter{2217}{\point}
8874 \DeclareUnicodeCharacter{2261}{\equiv}
8875 }% end of \utfeightchardefs
8878 % US-ASCII character definitions.
8879 \def\asciichardefs{% nothing need be done
8883 % Make non-ASCII characters printable again for compatibility with
8884 % existing Texinfo documents that may use them, even without declaring a
8885 % document encoding.
8887 \setnonasciicharscatcode \other
8890 \message{formatting,}
8892 \newdimen\defaultparindent \defaultparindent = 15pt
8894 \chapheadingskip = 15pt plus 4pt minus 2pt
8895 \secheadingskip = 12pt plus 3pt minus 2pt
8896 \subsecheadingskip = 9pt plus 2pt minus 2pt
8898 % Prevent underfull vbox error messages.
8901 % Don't be so finicky about underfull hboxes, either.
8904 % Following George Bush, get rid of widows and orphans.
8908 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8909 % using an old version of TeX, don't do anything. We want the amount of
8910 % stretch added to depend on the line length, hence the dependence on
8911 % \hsize. We call this whenever the paper size is set.
8913 \def\setemergencystretch{%
8914 \ifx\emergencystretch\thisisundefined
8915 % Allow us to assign to \emergencystretch anyway.
8916 \def\emergencystretch{\dimen0}%
8918 \emergencystretch = .15\hsize
8922 % Parameters in order: 1) textheight; 2) textwidth;
8923 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8924 % 7) physical page height; 8) physical page width.
8926 % We also call \setleading{\textleading}, so the caller should define
8927 % \textleading. The caller should also set \parskip.
8929 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8932 \splittopskip = \topskip
8935 \advance\vsize by \topskip
8936 \outervsize = \vsize
8937 \advance\outervsize by 2\topandbottommargin
8938 \pageheight = \vsize
8941 \outerhsize = \hsize
8942 \advance\outerhsize by 0.5in
8945 \normaloffset = #4\relax
8946 \bindingoffset = #5\relax
8949 \pdfpageheight #7\relax
8950 \pdfpagewidth #8\relax
8951 % if we don't reset these, they will remain at "1 true in" of
8952 % whatever layout pdftex was dumped with.
8953 \pdfhorigin = 1 true in
8954 \pdfvorigin = 1 true in
8957 \setleading{\textleading}
8959 \parindent = \defaultparindent
8960 \setemergencystretch
8963 % @letterpaper (the default).
8964 \def\letterpaper{{\globaldefs = 1
8965 \parskip = 3pt plus 2pt minus 1pt
8966 \textleading = 13.2pt
8968 % If page is nothing but text, make it come out even.
8969 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8971 {\bindingoffset}{36pt}%
8975 % Use @smallbook to reset parameters for 7x9.25 trim size.
8976 \def\smallbook{{\globaldefs = 1
8977 \parskip = 2pt plus 1pt
8980 \internalpagesizes{7.5in}{5in}%
8982 {\bindingoffset}{16pt}%
8985 \lispnarrowing = 0.3in
8988 \contentsrightmargin = 0pt
8989 \defbodyindent = .5cm
8992 % Use @smallerbook to reset parameters for 6x9 trim size.
8993 % (Just testing, parameters still in flux.)
8994 \def\smallerbook{{\globaldefs = 1
8995 \parskip = 1.5pt plus 1pt
8998 \internalpagesizes{7.4in}{4.8in}%
9003 \lispnarrowing = 0.25in
9006 \contentsrightmargin = 0pt
9007 \defbodyindent = .4cm
9010 % Use @afourpaper to print on European A4 paper.
9011 \def\afourpaper{{\globaldefs = 1
9012 \parskip = 3pt plus 2pt minus 1pt
9013 \textleading = 13.2pt
9015 % Double-side printing via postscript on Laserjet 4050
9016 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9017 % To change the settings for a different printer or situation, adjust
9018 % \normaloffset until the front-side and back-side texts align. Then
9019 % do the same for \bindingoffset. You can set these for testing in
9020 % your texinfo source file like this:
9022 % \global\normaloffset = -6mm
9023 % \global\bindingoffset = 10mm
9025 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9026 {\voffset}{\hoffset}%
9027 {\bindingoffset}{44pt}%
9032 \contentsrightmargin = 0pt
9033 \defbodyindent = 5mm
9036 % Use @afivepaper to print on European A5 paper.
9037 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9038 % He also recommends making @example and @lisp be small.
9039 \def\afivepaper{{\globaldefs = 1
9040 \parskip = 2pt plus 1pt minus 0.1pt
9041 \textleading = 12.5pt
9043 \internalpagesizes{160mm}{120mm}%
9044 {\voffset}{\hoffset}%
9045 {\bindingoffset}{8pt}%
9048 \lispnarrowing = 0.2in
9051 \contentsrightmargin = 0pt
9052 \defbodyindent = 2mm
9056 % A specific text layout, 24x15cm overall, intended for A4 paper.
9057 \def\afourlatex{{\globaldefs = 1
9059 \internalpagesizes{237mm}{150mm}%
9061 {\bindingoffset}{7mm}%
9064 % Must explicitly reset to 0 because we call \afourpaper.
9068 % Use @afourwide to print on A4 paper in landscape format.
9069 \def\afourwide{{\globaldefs = 1
9071 \internalpagesizes{241mm}{165mm}%
9072 {\voffset}{-2.95mm}%
9073 {\bindingoffset}{7mm}%
9078 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9079 % Perhaps we should allow setting the margins, \topskip, \parskip,
9080 % and/or leading, also. Or perhaps we should compute them somehow.
9082 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9083 \def\pagesizesyyy#1,#2,#3\finish{{%
9084 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9087 \parskip = 3pt plus 2pt minus 1pt
9088 \setleading{\textleading}%
9091 \advance\dimen0 by \voffset
9094 \advance\dimen2 by \normaloffset
9096 \internalpagesizes{#1}{\hsize}%
9097 {\voffset}{\normaloffset}%
9098 {\bindingoffset}{44pt}%
9102 % Set default to letter.
9107 \message{and turning on texinfo input format.}
9109 % DEL is a comment character, in case @c does not suffice.
9112 % Define macros to output various characters with catcode for normal text.
9122 \def\normaldoublequote{"}
9125 \def\normalunderscore{_}
9126 \def\normalverticalbar{|}
9128 \def\normalgreater{>}
9130 \def\normaldollar{$}%$ font-lock fix
9132 % This macro is used to make a character print one way in \tt
9133 % (where it can probably be output as-is), and another way in other fonts,
9134 % where something hairier probably needs to be done.
9136 % #1 is what to print if we are indeed using \tt; #2 is what to print
9137 % otherwise. Since all the Computer Modern typewriter fonts have zero
9138 % interword stretch (and shrink), and it is reasonable to expect all
9139 % typewriter fonts to have this, we can check that font parameter.
9141 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9143 % Same as above, but check for italic font. Actually this also catches
9144 % non-italic slanted fonts since it is impossible to distinguish them from
9145 % italic fonts. But since this is only used by $ and it uses \sl anyway
9146 % this is not a problem.
9147 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9149 % Turn off all special characters except @
9150 % (and those which the user can use as if they were ordinary).
9151 % Most of these we simply print from the \tt font, but for some, we can
9152 % use math or other variants that look better in normal text.
9155 \def\activedoublequote{{\tt\char34}}
9156 \let"=\activedoublequote
9158 \def~{{\tt\char126}}
9164 \def_{\ifusingtt\normalunderscore\_}
9166 % Subroutine for the previous macro.
9167 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9170 \def|{{\tt\char124}}
9178 \def+{{\tt \char 43}}
9180 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9182 % If a .fmt file is being used, characters that might appear in a file
9183 % name cannot be active until we have parsed the command line.
9184 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9185 % \otherifyactive is called near the end of this file.
9186 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9188 % Used sometimes to turn off (effectively) the active characters even after
9190 \def\turnoffactive{%
9191 \normalturnoffactive
9197 % \backslashcurfont outputs one backslash character in current font,
9199 \global\chardef\backslashcurfont=`\\
9200 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9202 % \realbackslash is an actual character `\' with catcode other, and
9203 % \doublebackslash is two of them (for the pdf outlines).
9204 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9206 % In texinfo, backslash is an active character; it prints the backslash
9207 % in fixed width font.
9209 @def@normalbackslash{{@tt@backslashcurfont}}
9210 % On startup, @fixbackslash assigns:
9211 % @let \ = @normalbackslash
9213 % \rawbackslash defines an active \ to do \backslashcurfont.
9214 % \otherbackslash defines an active \ to be a literal `\' character with
9216 @gdef@rawbackslash{@let\=@backslashcurfont}
9217 @gdef@otherbackslash{@let\=@realbackslash}
9219 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9220 % the literal character `\'.
9222 @def@normalturnoffactive{%
9223 @let\=@normalbackslash
9224 @let"=@normaldoublequote
9227 @let_=@normalunderscore
9228 @let|=@normalverticalbar
9230 @let>=@normalgreater
9232 @let$=@normaldollar %$ font-lock fix
9233 @markupsetuplqdefault
9234 @markupsetuprqdefault
9238 % Make _ and + \other characters, temporarily.
9239 % This is canceled by @fixbackslash.
9242 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9243 % That is what \eatinput is for; after that, the `\' should revert to printing
9246 @gdef@eatinput input texinfo{@fixbackslash}
9247 @global@let\ = @eatinput
9249 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9250 % the first `\' in the file would cause an error. This macro tries to fix
9251 % that, assuming it is called before the first `\' could plausibly occur.
9252 % Also turn back on active characters that might appear in the input
9253 % file name, in case not using a pre-dumped format.
9255 @gdef@fixbackslash{%
9256 @ifx\@eatinput @let\ = @normalbackslash @fi
9261 % Say @foo, not \foo, in error messages.
9264 % These look ok in all fonts, so just make them not special.
9265 @catcode`@& = @other
9266 @catcode`@# = @other
9267 @catcode`@% = @other
9269 @c Finally, make ` and ' active, so that txicodequoteundirected and
9270 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9271 @c don't make ` and ' active, @code will not get them as active chars.
9272 @c Do this last of all since we use ` in the previous @catcode assignments.
9275 @markupsetuplqdefault
9276 @markupsetuprqdefault
9279 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9280 @c page-delimiter: "^\\\\message"
9281 @c time-stamp-start: "def\\\\texinfoversion{"
9282 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9283 @c time-stamp-end: "}"
9289 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115