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{2013-08-20.10}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. This Exception is an additional permission under section 7
28 % of the GNU General Public License, version 3 ("GPLv3").
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
33 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
34 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
35 % The texinfo.tex in any given distribution could well be out
36 % of date, so if that's what you're using, please check.
38 % Send bug reports to bug-texinfo@gnu.org. Please include including a
39 % complete document in each bug report with which we can reproduce the
40 % problem. Patches are, of course, greatly appreciated.
42 % To process a Texinfo manual with TeX, it's most reliable to use the
43 % texi2dvi shell script that comes with the distribution. For a simple
44 % manual foo.texi, however, you can get away with this:
49 % dvips foo.dvi -o # or whatever; this makes foo.ps.
50 % The extra TeX runs get the cross-reference information correct.
51 % Sometimes one run after texindex suffices, and sometimes you need more
52 % than two; texi2dvi does it as many times as necessary.
54 % It is possible to adapt texinfo.tex for other languages, to some
55 % extent. You can get the existing language-specific files from the
56 % full Texinfo distribution.
58 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
61 \message{Loading texinfo [version \texinfoversion]:}
63 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active}
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
75 % Save some plain tex macros whose names we will redefine.
77 \let\ptexbullet=\bullet
85 \let\ptexfootnote=\footnote
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
96 \let\ptexraggedright=\raggedright
102 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
104 % If this character appears in an error message or help string, it
105 % starts a new line in the output.
108 % Use TeX 3.0's \inputlineno to get the line number, for better error
109 % messages, but if we're using an old version of TeX, don't do anything.
111 \ifx\inputlineno\thisisundefined
112 \let\linenumber = \empty % Pre-3.0.
114 \def\linenumber{l.\the\inputlineno:\space}
117 % Set up fixed words for English if not already set.
118 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
119 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
120 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
121 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
122 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
123 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
124 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
125 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
126 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
127 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
128 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
129 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
130 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
131 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
132 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
133 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
134 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
135 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
136 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
137 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
139 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
140 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
141 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
142 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
143 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
144 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
145 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
146 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
147 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
148 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
149 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
150 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
152 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
153 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
154 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
155 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
156 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
158 % Since the category of space is not known, we have to be careful.
159 \chardef\spacecat = 10
160 \def\spaceisspace{\catcode`\ =\spacecat}
162 % sometimes characters are active, so we need control sequences.
163 \chardef\ampChar = `\&
164 \chardef\colonChar = `\:
165 \chardef\commaChar = `\,
166 \chardef\dashChar = `\-
167 \chardef\dotChar = `\.
168 \chardef\exclamChar= `\!
169 \chardef\hashChar = `\#
170 \chardef\lquoteChar= `\`
171 \chardef\questChar = `\?
172 \chardef\rquoteChar= `\'
173 \chardef\semiChar = `\;
174 \chardef\slashChar = `\/
175 \chardef\underChar = `\_
181 % The following is used inside several \edef's.
182 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
186 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
187 ap-pen-dix bit-map bit-maps
188 data-base data-bases eshell fall-ing half-way long-est man-u-script
189 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
190 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
192 stand-alone strong-est time-stamp time-stamps which-ever white-space
193 wide-spread wrap-around
196 % Margin to add to right of even pages, to left of odd pages.
197 \newdimen\bindingoffset
198 \newdimen\normaloffset
199 \newdimen\pagewidth \newdimen\pageheight
201 % For a final copy, take out the rectangles
202 % that mark overfull boxes (in case you have decided
203 % that the text looks ok even though it passes the margin).
205 \def\finalout{\overfullrule=0pt }
207 % Sometimes it is convenient to have everything in the transcript file
208 % and nothing on the terminal. We don't just call \tracingall here,
209 % since that produces some useless output on the terminal. We also make
210 % some effort to order the tracing commands to reduce output in the log
211 % file; cf. trace.sty in LaTeX.
213 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
217 \tracinglostchars2 % 2 gives us more in etex
222 \showboxbreadth\maxdimen \showboxdepth\maxdimen
223 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
230 \tracingcommands3 % 3 gives us more in etex
234 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
235 % aren't perfect, it's not the end of the world, being an error message,
238 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
239 \def\doerrormsg#1{\errmessage{#1}}
241 % add check for \lastpenalty to plain's definitions. If the last thing
242 % we did was a \nobreak, we don't want to insert more space.
244 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
245 \removelastskip\penalty-50\smallskip\fi\fi}
246 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
247 \removelastskip\penalty-100\medskip\fi\fi}
248 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
249 \removelastskip\penalty-200\bigskip\fi\fi}
251 % Do @cropmarks to get crop marks.
254 \let\cropmarks = \cropmarkstrue
256 % Dimensions to add cropmarks at corners.
257 % Added by P. A. MacKay, 12 Nov. 1986
259 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
260 \newdimen\cornerlong \cornerlong=1pc
261 \newdimen\cornerthick \cornerthick=.3pt
262 \newdimen\topandbottommargin \topandbottommargin=.75in
264 % Output a mark which sets \thischapter, \thissection and \thiscolor.
265 % We dump everything together because we only have one kind of mark.
266 % This works because we only use \botmark / \topmark, not \firstmark.
268 % A mark contains a subexpression of the \ifcase ... \fi construct.
269 % \get*marks macros below extract the needed part using \ifcase.
271 % Another complication is to let the user choose whether \thischapter
272 % (\thissection) refers to the chapter (section) in effect at the top
273 % of a page, or that at the bottom of a page. The solution is
274 % described on page 260 of The TeXbook. It involves outputting two
275 % marks for the sectioning macros, one before the section break, and
276 % one after. I won't pretend I can describe this better than DEK...
278 \toks0=\expandafter{\lastchapterdefs}%
279 \toks2=\expandafter{\lastsectiondefs}%
280 \toks4=\expandafter{\prevchapterdefs}%
281 \toks6=\expandafter{\prevsectiondefs}%
282 \toks8=\expandafter{\lastcolordefs}%
284 \the\toks0 \the\toks2 % 0: top marks (\last...)
285 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
286 \noexpand\else \the\toks8 % 2: color marks
289 % \topmark doesn't work for the very first chapter (after the title
290 % page or the contents), so we use \firstmark there -- this gets us
291 % the mark with the chapter defs, unless the user sneaks in, e.g.,
292 % @setcolor (or @url, or @link, etc.) between @contents and the very
294 \def\gettopheadingmarks{%
296 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
298 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
299 \def\getcolormarks{\ifcase2\topmark\fi}
301 % Avoid "undefined control sequence" errors.
302 \def\lastchapterdefs{}
303 \def\lastsectiondefs{}
304 \def\prevchapterdefs{}
305 \def\prevsectiondefs{}
308 % Main output routine.
310 \output = {\onepageout{\pagecontents\PAGE}}
315 % \onepageout takes a vbox as an argument. Note that \pagecontents
316 % does insertions, but you have to call it yourself.
318 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
320 \ifodd\pageno \advance\hoffset by \bindingoffset
321 \else \advance\hoffset by -\bindingoffset\fi
323 % Do this outside of the \shipout so @code etc. will be expanded in
324 % the headline as they should be, not taken literally (outputting ''code).
325 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
326 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
327 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
328 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
331 % Have to do this stuff outside the \shipout because we want it to
332 % take effect in \write's, yet the group defined by the \vbox ends
333 % before the \shipout runs.
335 \indexdummies % don't expand commands in the output.
336 \normalturnoffactive % \ in index entries must not stay \, e.g., if
337 % the page break happens to be in the middle of an example.
338 % We don't want .vr (or whatever) entries like this:
339 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
340 % "\acronym" won't work when it's read back in;
342 % {\code {{\tt \backslashcurfont }acronym}
344 % Do this early so pdf references go to the beginning of the page.
345 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
347 \ifcropmarks \vbox to \outervsize\bgroup
349 \vskip-\topandbottommargin
351 \line{\ewtop\hfil\ewtop}%
354 \vbox{\moveleft\cornerthick\nstop}%
356 \vbox{\moveright\cornerthick\nstop}%
359 \vskip\topandbottommargin
361 \hfil % center the page within the outer (page) hsize.
362 \ifodd\pageno\hskip\bindingoffset\fi
368 \ifdim\ht\footlinebox > 0pt
369 % Only leave this space if the footline is nonempty.
370 % (We lessened \vsize for it in \oddfootingyyy.)
371 % The \baselineskip=24pt in plain's \makefootline has no effect.
377 \egroup % end of \vbox\bgroup
378 \hfil\egroup % end of (centering) \line\bgroup
379 \vskip\topandbottommargin plus1fill minus1fill
380 \boxmaxdepth = \cornerthick
383 \vbox{\moveleft\cornerthick\nsbot}%
385 \vbox{\moveright\cornerthick\nsbot}%
388 \line{\ewbot\hfil\ewbot}%
390 \egroup % \vbox from first cropmarks clause
392 }% end of \shipout\vbox
393 }% end of group with \indexdummies
395 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
398 \newinsert\margin \dimen\margin=\maxdimen
400 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
402 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
404 \ifvoid\margin\else % marginal info is present
405 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
406 \dimen@=\dp#1\relax \unvbox#1\relax
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
408 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
411 % Here are the rules for the cropmarks. Note that they are
412 % offset so that the space between them is truly \outerhsize or \outervsize
413 % (P. A. MacKay, 12 November, 1986)
415 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
417 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
418 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
420 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
422 % Parse an argument, then pass it to #1. The argument is the rest of
423 % the input line (except we remove a trailing comment). #1 should be a
424 % macro which expects an ordinary undelimited TeX argument.
426 \def\parsearg{\parseargusing{}}
427 \def\parseargusing#1#2{%
433 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
437 \gdef\parseargline#1^^M{%
438 \endgroup % End of the group started in \parsearg.
439 \argremovecomment #1\comment\ArgTerm%
443 % First remove any @comment, then any @c comment.
444 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
445 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
447 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
449 % \argremovec might leave us with trailing space, e.g.,
450 % @end itemize @c foo
451 % This space token undergoes the same procedure and is eventually removed
452 % by \finishparsearg.
454 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
455 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
456 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
459 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
460 \let\temp\finishparsearg
462 \let\temp\argcheckspaces
464 % Put the space token in:
468 % If a _delimited_ argument is enclosed in braces, they get stripped; so
469 % to get _exactly_ the rest of the line, we had to prevent such situation.
470 % We prepended an \empty token at the very beginning and we expand it now,
471 % just before passing the control to \argtorun.
472 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
473 % either the null string, or it ends with \^^M---thus there is no danger
474 % that a pair of braces would be stripped.
476 % But first, we have to remove the trailing space token.
478 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
480 % \parseargdef\foo{...}
481 % is roughly equivalent to
482 % \def\foo{\parsearg\Xfoo}
485 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
486 % favourite TeX trick. --kasal, 16nov03
489 \expandafter \doparseargdef \csname\string#1\endcsname #1%
491 \def\doparseargdef#1#2{%
496 % Several utility definitions with active space:
501 % Make each space character in the input produce a normal interword
502 % space in the output. Don't allow a line break at this space, as this
503 % is used only in environments like @example, where each line of input
504 % should produce a line of output anyway.
506 \gdef\sepspaces{\obeyspaces\let =\tie}
508 % If an index command is used in an @example environment, any spaces
509 % therein should become regular spaces in the raw index file, not the
510 % expansion of \tie (\leavevmode \penalty \@M \ ).
511 \gdef\unsepspaces{\let =\space}
515 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
517 % Define the framework for environments in texinfo.tex. It's used like this:
522 % It's the responsibility of \envdef to insert \begingroup before the
523 % actual body; @end closes the group after calling \Efoo. \envdef also
524 % defines \thisenv, so the current environment is known; @end checks
525 % whether the environment name matches. The \checkenv macro can also be
526 % used to check whether the current environment is the one expected.
528 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
529 % are not treated as environments; they don't open a group. (The
530 % implementation of @end takes care not to call \endgroup in this
534 % At run-time, environments start with this:
535 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
539 % ... but they get defined via ``\envdef\foo{...}'':
540 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
541 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
543 % Check whether we're in the right environment:
552 % Environment mismatch, #1 expected:
555 \errmessage{This command can appear only \inenvironment\temp,
556 not \inenvironment\thisenv}%
558 \def\inenvironment#1{%
560 outside of any environment%
562 in environment \expandafter\string#1%
566 % @end foo executes the definition of \Efoo.
567 % But first, it executes a specialized version of \checkenv
570 \if 1\csname iscond.#1\endcsname
572 % The general wording of \badenverr may not be ideal.
573 \expandafter\checkenv\csname#1\endcsname
574 \csname E#1\endcsname
579 \newhelp\EMsimple{Press RETURN to continue.}
582 % Be sure we're in horizontal mode when doing a tie, since we make space
583 % equivalent to this in @example-like environments. Otherwise, a space
584 % at the beginning of a line will start with \penalty -- and
585 % since \penalty is valid in vertical mode, we'd end up putting the
586 % penalty on the vertical list instead of in the new paragraph.
588 % Avoid using \@M directly, because that causes trouble
589 % if the definition is written into an index file.
590 \global\let\tiepenalty = \@M
591 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
594 % @: forces normal size whitespace following.
595 \def\:{\spacefactor=1000 }
597 % @* forces a line break.
598 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
600 % @/ allows a line break.
603 % @. is an end-of-sentence period.
604 \def\.{.\spacefactor=\endofsentencespacefactor\space}
606 % @! is an end-of-sentence bang.
607 \def\!{!\spacefactor=\endofsentencespacefactor\space}
609 % @? is an end-of-sentence query.
610 \def\?{?\spacefactor=\endofsentencespacefactor\space}
612 % @frenchspacing on|off says whether to put extra space after punctuation.
617 \parseargdef\frenchspacing{%
619 \ifx\temp\onword \plainfrenchspacing
620 \else\ifx\temp\offword \plainnonfrenchspacing
623 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
627 % @w prevents a word break. Without the \leavevmode, @w at the
628 % beginning of a paragraph, when TeX is still in vertical mode, would
629 % produce a whole line of output instead of starting the paragraph.
630 \def\w#1{\leavevmode\hbox{#1}}
632 % @group ... @end group forces ... to be all on one page, by enclosing
633 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
634 % to keep its height that of a normal line. According to the rules for
635 % \topskip (p.114 of the TeXbook), the glue inserted is
636 % max (\topskip - \ht (first item), 0). If that height is large,
637 % therefore, no glue is inserted, and the space between the headline and
638 % the text is small, which looks bad.
640 % Another complication is that the group might be very large. This can
641 % cause the glue on the previous page to be unduly stretched, because it
642 % does not have much material. In this case, it's better to add an
643 % explicit \vfill so that the extra space is at the bottom. The
644 % threshold for doing this is if the group is more than \vfilllimit
645 % percent of a page (\vfilllimit can be changed inside of @tex).
651 \ifnum\catcode`\^^M=\active \else
652 \errhelp = \groupinvalidhelp
653 \errmessage{@group invalid in context where filling is enabled}%
657 \setbox\groupbox = \vtop\bgroup
658 % Do @comment since we are called inside an environment such as
659 % @example, where each end-of-line in the input causes an
660 % end-of-line in the output. We don't want the end-of-line after
661 % the `@group' to put extra space in the output. Since @group
662 % should appear on a line by itself (according to the Texinfo
663 % manual), we don't worry about eating any user text.
667 % The \vtop produces a box with normal height and large depth; thus, TeX puts
668 % \baselineskip glue before it, and (when the next line of text is done)
669 % \lineskip glue after it. Thus, space below is not quite equal to space
670 % above. But it's pretty close.
672 % To get correct interline space between the last line of the group
673 % and the first line afterwards, we have to propagate \prevdepth.
674 \endgraf % Not \par, as it may have been set to \lisppar.
675 \global\dimen1 = \prevdepth
676 \egroup % End the \vtop.
677 % \dimen0 is the vertical size of the group's box.
678 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
679 % \dimen2 is how much space is left on the page (more or less).
680 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
681 % if the group doesn't fit on the current page, and it's a big big
682 % group, force a page break.
683 \ifdim \dimen0 > \dimen2
684 \ifdim \pagetotal < \vfilllimit\pageheight
693 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
694 % message, so this ends up printing `@group can only ...'.
696 \newhelp\groupinvalidhelp{%
697 group can only be used in environments such as @example,^^J%
698 where each line of input produces a line of output.}
700 % @need space-in-mils
701 % forces a page break if there is not space-in-mils remaining.
703 \newdimen\mil \mil=0.001in
706 % Ensure vertical mode, so we don't make a big box in the middle of a
710 % If the @need value is less than one line space, it's useless.
712 \dimen2 = \ht\strutbox
713 \advance\dimen2 by \dp\strutbox
714 \ifdim\dimen0 > \dimen2
716 % Do a \strut just to make the height of this box be normal, so the
717 % normal leading is inserted relative to the preceding line.
718 % And a page break here is fine.
719 \vtop to #1\mil{\strut\vfil}%
721 % TeX does not even consider page breaks if a penalty added to the
722 % main vertical list is 10000 or more. But in order to see if the
723 % empty box we just added fits on the page, we must make it consider
724 % page breaks. On the other hand, we don't want to actually break the
725 % page after the empty box. So we use a penalty of 9999.
727 % There is an extremely small chance that TeX will actually break the
728 % page at this \penalty, if there are no other feasible breakpoints in
729 % sight. (If the user is using lots of big @group commands, which
730 % almost-but-not-quite fill up a page, TeX will have a hard time doing
731 % good page breaking, for example.) However, I could not construct an
732 % example where a page broke at this \penalty; if it happens in a real
733 % document, then we can reconsider our strategy.
736 % Back up by the size of the box, whether we did a page break or not.
739 % Do not allow a page break right after this kern.
744 % @br forces paragraph break (and is undocumented).
748 % @page forces the start of a new page.
750 \def\page{\par\vfill\supereject}
753 % outputs text on separate line in roman font, starting at standard page margin
755 % This records the amount of indent in the innermost environment.
756 % That's how much \exdent should take out.
757 \newskip\exdentamount
759 % This defn is used inside fill environments such as @defun.
760 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
762 % This defn is used inside nofill environments such as @example.
763 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
764 \leftline{\hskip\leftskip{\rm#1}}}}
766 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
767 % paragraph. For more general purposes, use the \margin insertion
768 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
770 \newskip\inmarginspacing \inmarginspacing=1cm
771 \def\strutdepth{\dp\strutbox}
773 \def\doinmargin#1#2{\strut\vadjust{%
776 \vtop to \strutdepth{%
777 \baselineskip=\strutdepth
779 % if you have multiple lines of stuff to put here, you'll need to
780 % make the vbox yourself of the appropriate size.
782 \llap{\ignorespaces #2\hskip\inmarginspacing}%
784 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
789 \def\inleftmargin{\doinmargin l}
790 \def\inrightmargin{\doinmargin r}
792 % @inmargin{TEXT [, RIGHT-TEXT]}
793 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
794 % else use TEXT for both).
796 \def\inmargin#1{\parseinmargin #1,,\finish}
797 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
798 \setbox0 = \hbox{\ignorespaces #2}%
800 \def\lefttext{#1}% have both texts
803 \def\lefttext{#1}% have only one text
808 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
810 \def\temp{\inleftmargin\lefttext}%
815 % @| inserts a changebar to the left of the current line. It should
816 % surround any changed text. This approach does *not* work if the
817 % change spans more than two lines of output. To handle that, we would
818 % have adopt a much more difficult approach (putting marks into the main
819 % vertical list for the beginning and end of each change). This command
820 % is not documented, not supported, and doesn't work.
823 % \vadjust can only be used in horizontal mode.
826 % Append this vertical mode material after the current line in the output.
828 % We want to insert a rule with the height and depth of the current
829 % leading; that is exactly what \strutbox is supposed to record.
832 % \vadjust-items are inserted at the left edge of the type. So
833 % the \llap here moves out into the left-hand margin.
836 % For a thicker or thinner bar, change the `1pt'.
837 \vrule height\baselineskip width1pt
839 % This is the space between the bar and the text.
845 % @include FILE -- \input text of FILE.
847 \def\include{\parseargusing\filenamecatcodes\includezzz}
852 \makevalueexpandable % we want to expand any @value in FILE.
853 \turnoffactive % and allow special characters in the expansion
854 \indexnofonts % Allow `@@' and other weird things in file names.
855 \wlog{texinfo.tex: doing @include of #1^^J}%
856 \edef\temp{\noexpand\input #1 }%
858 % This trickery is to read FILE outside of a group, in case it makes
864 \def\filenamecatcodes{%
878 \def\pushthisfilestack{%
879 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
881 \def\pushthisfilestackX{%
882 \expandafter\pushthisfilestackY\thisfile\StackTerm
884 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
885 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
888 \def\popthisfilestack{\errthisfilestackempty}
889 \def\errthisfilestackempty{\errmessage{Internal error:
890 the stack of filenames is empty.}}
895 % outputs that line, centered.
897 \parseargdef\center{%
899 \let\centersub\centerH
901 \let\centersub\centerV
903 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
904 \let\centersub\relax % don't let the definition persist, just in case
908 \advance\hsize by -\leftskip
909 \advance\hsize by -\rightskip
914 \newcount\centerpenalty
916 % The idea here is the same as in \startdefun, \cartouche, etc.: if
917 % @center is the first thing after a section heading, we need to wipe
918 % out the negative parskip inserted by \sectionheading, but still
919 % prevent a page break here.
920 \centerpenalty = \lastpenalty
921 \ifnum\centerpenalty>10000 \vskip\parskip \fi
922 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
923 \line{\kern\leftskip #1\kern\rightskip}%
926 % @sp n outputs n lines of vertical space
928 \parseargdef\sp{\vskip #1\baselineskip}
930 % @comment ...line which is ignored...
931 % @c is the same as @comment
932 % @ignore ... @end ignore is another way to write a comment
934 \def\comment{\begingroup \catcode`\^^M=\other%
935 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
937 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
941 % @paragraphindent NCHARS
942 % We'll use ems for NCHARS, close enough.
943 % NCHARS can also be the word `asis' or `none'.
944 % We cannot feasibly implement @paragraphindent asis, though.
946 \def\asisword{asis} % no translation, these are keywords
949 \parseargdef\paragraphindent{%
954 \defaultparindent = 0pt
956 \defaultparindent = #1em
959 \parindent = \defaultparindent
962 % @exampleindent NCHARS
963 % We'll use ems for NCHARS like @paragraphindent.
964 % It seems @exampleindent asis isn't necessary, but
965 % I preserve it to make it similar to @paragraphindent.
966 \parseargdef\exampleindent{%
973 \lispnarrowing = #1em
978 % @firstparagraphindent WORD
979 % If WORD is `none', then suppress indentation of the first paragraph
980 % after a section heading. If WORD is `insert', then do indent at such
983 % The paragraph indentation is suppressed or not by calling
984 % \suppressfirstparagraphindent, which the sectioning commands do.
985 % We switch the definition of this back and forth according to WORD.
986 % By default, we suppress indentation.
988 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
989 \def\insertword{insert}
991 \parseargdef\firstparagraphindent{%
994 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
995 \else\ifx\temp\insertword
996 \let\suppressfirstparagraphindent = \relax
999 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1003 % Here is how we actually suppress indentation. Redefine \everypar to
1004 % \kern backwards by \parindent, and then reset itself to empty.
1006 % We also make \indent itself not actually do anything until the next
1009 \gdef\dosuppressfirstparagraphindent{%
1011 \restorefirstparagraphindent
1015 \restorefirstparagraphindent
1018 \global\everypar = {%
1020 \restorefirstparagraphindent
1024 \gdef\restorefirstparagraphindent{%
1025 \global \let \indent = \ptexindent
1026 \global \let \noindent = \ptexnoindent
1027 \global \everypar = {}%
1031 % @refill is a no-op.
1034 % If working on a large document in chapters, it is convenient to
1035 % be able to disable indexing, cross-referencing, and contents, for test runs.
1036 % This is done with @novalidate (before @setfilename).
1038 \newif\iflinks \linkstrue % by default we want the aux files.
1039 \let\novalidate = \linksfalse
1041 % @setfilename is done at the beginning of every texinfo file.
1042 % So open here the files we need to have open while reading the input.
1043 % This makes it possible to make a .fmt file for texinfo.
1045 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1048 % Open the new aux file. TeX will close it automatically at exit.
1049 \immediate\openout\auxfile=\jobname.aux
1050 \fi % \openindices needs to do some work in any case.
1052 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1054 % If texinfo.cnf is present on the system, read it.
1055 % Useful for site-wide @afourpaper, etc.
1056 \openin 1 texinfo.cnf
1057 \ifeof 1 \else \input texinfo.cnf \fi
1060 \comment % Ignore the actual filename.
1063 % Called from \setfilename.
1075 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1079 % adobe `portable' document format
1083 \newcount\filenamelength
1092 \newif\ifpdfmakepagedest
1094 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1095 % can be set). So we test for \relax and 0 as well as being undefined.
1096 \ifx\pdfoutput\thisisundefined
1098 \ifx\pdfoutput\relax
1107 % PDF uses PostScript string constants for the names of xref targets,
1108 % for display in the outlines, and in other places. Thus, we have to
1109 % double any backslashes. Otherwise, a name like "\node" will be
1110 % interpreted as a newline (\n), followed by o, d, e. Not good.
1112 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1113 % related messages. The final outcome is that it is up to the TeX user
1114 % to double the backslashes and otherwise make the string valid, so
1115 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1116 % do this reliably, so we use it.
1118 % #1 is a control sequence in which to do the replacements,
1120 \def\txiescapepdf#1{%
1121 \ifx\pdfescapestring\thisisundefined
1122 % No primitive available; should we give a warning or log?
1123 % Many times it won't matter.
1125 % The expandable \pdfescapestring primitive escapes parentheses,
1126 % backslashes, and other special chars.
1127 \xdef#1{\pdfescapestring{#1}}%
1131 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1132 with PDF output, and none of those formats could be found. (.eps cannot
1133 be supported due to the design of the PDF format; use regular TeX (DVI
1138 % Color manipulation macros based on pdfcolor.tex,
1139 % except using rgb instead of cmyk; the latter is said to render as a
1140 % very dark gray on-screen and a very dark halftone in print, instead
1142 \def\rgbDarkRed{0.50 0.09 0.12}
1143 \def\rgbBlack{0 0 0}
1145 % k sets the color for filling (usual text, etc.);
1146 % K sets the color for stroking (thin rules, e.g., normal _'s).
1147 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1149 % Set color, and create a mark which defines \thiscolor accordingly,
1150 % so that \makeheadline knows which color to restore.
1152 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1157 \def\maincolor{\rgbBlack}
1158 \pdfsetcolor{\maincolor}
1159 \edef\thiscolor{\maincolor}
1160 \def\lastcolordefs{}
1164 \line{\pdfsetcolor{\maincolor}\the\footline}%
1172 % Extract \thiscolor definition from the marks.
1174 % Typeset the headline with \maincolor, then restore the color.
1175 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1183 \pdfcatalog{/PageMode /UseOutlines}
1185 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1186 \def\dopdfimage#1#2#3{%
1187 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1188 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1190 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1191 % others). Let's try in that order, PDF first since if
1192 % someone has a scalable image, presumably better to use that than a
1194 \let\pdfimgext=\empty
1196 \openin 1 #1.pdf \ifeof 1
1197 \openin 1 #1.PDF \ifeof 1
1198 \openin 1 #1.png \ifeof 1
1199 \openin 1 #1.jpg \ifeof 1
1200 \openin 1 #1.jpeg \ifeof 1
1201 \openin 1 #1.JPG \ifeof 1
1202 \errhelp = \nopdfimagehelp
1203 \errmessage{Could not find image file #1 for pdf}%
1204 \else \gdef\pdfimgext{JPG}%
1206 \else \gdef\pdfimgext{jpeg}%
1208 \else \gdef\pdfimgext{jpg}%
1210 \else \gdef\pdfimgext{png}%
1212 \else \gdef\pdfimgext{PDF}%
1214 \else \gdef\pdfimgext{pdf}%
1219 % without \immediate, ancient pdftex seg faults when the same image is
1220 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1221 \ifnum\pdftexversion < 14
1224 \immediate\pdfximage
1226 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1227 \ifdim \wd2 >0pt height \pdfimageheight \fi
1228 \ifnum\pdftexversion<13
1233 \ifnum\pdftexversion < 14 \else
1234 \pdfrefximage \pdflastximage
1238 % We have to set dummies so commands such as @code, and characters
1239 % such as \, aren't expanded when present in a section title.
1242 \makevalueexpandable
1243 \def\pdfdestname{#1}%
1244 \txiescapepdf\pdfdestname
1245 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1248 % used to mark target names; must be expandable.
1251 % by default, use a color that is dark enough to print on paper as
1252 % nearly black, but still distinguishable for online viewing.
1253 \def\urlcolor{\rgbDarkRed}
1254 \def\linkcolor{\rgbDarkRed}
1255 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1257 % Adding outlines to PDF; macros for calculating structure of outlines
1258 % come from Petr Olsak
1259 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1260 \else \csname#1\endcsname \fi}
1261 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1262 \advance\tempnum by 1
1263 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1265 % #1 is the section text, which is what will be displayed in the
1266 % outline by the pdf viewer. #2 is the pdf expression for the number
1267 % of subentries (or empty, for subsubsections). #3 is the node text,
1268 % which might be empty if this toc entry had no corresponding node.
1269 % #4 is the page number
1271 \def\dopdfoutline#1#2#3#4{%
1272 % Generate a link to the node text if that exists; else, use the
1273 % page number. We could generate a destination for the section
1274 % text in the case where a section has no node, but it doesn't
1275 % seem worth the trouble, since most documents are normally structured.
1276 \edef\pdfoutlinedest{#3}%
1277 \ifx\pdfoutlinedest\empty
1278 \def\pdfoutlinedest{#4}%
1280 \txiescapepdf\pdfoutlinedest
1283 % Also escape PDF chars in the display string.
1284 \edef\pdfoutlinetext{#1}%
1285 \txiescapepdf\pdfoutlinetext
1287 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1290 \def\pdfmakeoutlines{%
1292 % Read toc silently, to get counts of subentries for \pdfoutline.
1293 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1294 \def\numchapentry##1##2##3##4{%
1295 \def\thischapnum{##2}%
1297 \def\thissubsecnum{0}%
1299 \def\numsecentry##1##2##3##4{%
1300 \advancenumber{chap\thischapnum}%
1301 \def\thissecnum{##2}%
1302 \def\thissubsecnum{0}%
1304 \def\numsubsecentry##1##2##3##4{%
1305 \advancenumber{sec\thissecnum}%
1306 \def\thissubsecnum{##2}%
1308 \def\numsubsubsecentry##1##2##3##4{%
1309 \advancenumber{subsec\thissubsecnum}%
1311 \def\thischapnum{0}%
1313 \def\thissubsecnum{0}%
1315 % use \def rather than \let here because we redefine \chapentry et
1316 % al. a second time, below.
1317 \def\appentry{\numchapentry}%
1318 \def\appsecentry{\numsecentry}%
1319 \def\appsubsecentry{\numsubsecentry}%
1320 \def\appsubsubsecentry{\numsubsubsecentry}%
1321 \def\unnchapentry{\numchapentry}%
1322 \def\unnsecentry{\numsecentry}%
1323 \def\unnsubsecentry{\numsubsecentry}%
1324 \def\unnsubsubsecentry{\numsubsubsecentry}%
1327 % Read toc second time, this time actually producing the outlines.
1328 % The `-' means take the \expnumber as the absolute number of
1329 % subentries, which we calculated on our first read of the .toc above.
1331 % We use the node names as the destinations.
1332 \def\numchapentry##1##2##3##4{%
1333 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1334 \def\numsecentry##1##2##3##4{%
1335 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1336 \def\numsubsecentry##1##2##3##4{%
1337 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1338 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1339 \dopdfoutline{##1}{}{##3}{##4}}%
1341 % PDF outlines are displayed using system fonts, instead of
1342 % document fonts. Therefore we cannot use special characters,
1343 % since the encoding is unknown. For example, the eogonek from
1344 % Latin 2 (0xea) gets translated to a | character. Info from
1345 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1347 % TODO this right, we have to translate 8-bit characters to
1348 % their "best" equivalent, based on the @documentencoding. Too
1349 % much work for too little return. Just use the ASCII equivalents
1350 % we use for the index sort strings.
1354 % We can have normal brace characters in the PDF outlines, unlike
1355 % Texinfo index files. So set that up.
1356 \def\{{\lbracecharliteral}%
1357 \def\}{\rbracecharliteral}%
1358 \catcode`\\=\active \otherbackslash
1359 \input \tocreadfilename
1362 {\catcode`[=1 \catcode`]=2
1363 \catcode`{=\other \catcode`}=\other
1364 \gdef\lbracecharliteral[{]%
1365 \gdef\rbracecharliteral[}]%
1368 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1369 \ifx\PP\D\let\nextsp\relax
1370 \else\let\nextsp\skipspaces
1371 \addtokens{\filename}{\PP}%
1372 \advance\filenamelength by 1
1375 \def\getfilename#1{%
1377 % If we don't expand the argument now, \skipspaces will get
1378 % snagged on things like "@value{foo}".
1380 \expandafter\skipspaces\temp|\relax
1382 \ifnum\pdftexversion < 14
1383 \let \startlink \pdfannotlink
1385 \let \startlink \pdfstartlink
1387 % make a live url in pdf output.
1390 % it seems we really need yet another set of dummies; have not
1391 % tried to figure out what each command should do in the context
1392 % of @url. for now, just make @/ a no-op, that's the only one
1393 % people have actually reported a problem with.
1395 \normalturnoffactive
1398 \makevalueexpandable
1399 % do we want to go so far as to use \indexnofonts instead of just
1400 % special-casing \var here?
1403 \leavevmode\setcolor{\urlcolor}%
1404 \startlink attr{/Border [0 0 0]}%
1405 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1407 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1408 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1409 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1410 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1412 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1414 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1415 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1416 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1418 \ifnum0=\countA\else\makelink\fi
1419 \ifx\first.\let\next=\done\else
1421 \addtokens{\toksB}{\the\toksD}
1422 \ifx\first,\addtokens{\toksB}{\space}\fi
1424 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1426 \def\makelink{\addtokens{\toksB}%
1427 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1429 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1430 \setcolor{\linkcolor}#1\endlink}
1431 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1434 \let\pdfmkdest = \gobble
1435 \let\pdfurl = \gobble
1436 \let\endlink = \relax
1437 \let\setcolor = \gobble
1438 \let\pdfsetcolor = \gobble
1439 \let\pdfmakeoutlines = \relax
1440 \fi % \ifx\pdfoutput
1445 % Change the current font style to #1, remembering it in \curfontstyle.
1446 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1447 % italics, not bold italics.
1449 \def\setfontstyle#1{%
1450 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1451 \csname ten#1\endcsname % change the current font
1454 % Select #1 fonts with the current style.
1456 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1458 \def\rm{\fam=0 \setfontstyle{rm}}
1459 \def\it{\fam=\itfam \setfontstyle{it}}
1460 \def\sl{\fam=\slfam \setfontstyle{sl}}
1461 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1462 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1464 % Unfortunately, we have to override this for titles and the like, since
1465 % in those cases "rm" is bold. Sigh.
1466 \def\rmisbold{\rm\def\curfontstyle{bf}}
1468 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1469 % So we set up a \sf.
1471 \def\sf{\fam=\sffam \setfontstyle{sf}}
1472 \let\li = \sf % Sometimes we call it \li, not \sf.
1474 % We don't need math for this font style.
1475 \def\ttsl{\setfontstyle{ttsl}}
1478 % Set the baselineskip to #1, and the lineskip and strut size
1479 % correspondingly. There is no deep meaning behind these magic numbers
1480 % used as factors; they just match (closely enough) what Knuth defined.
1482 \def\lineskipfactor{.08333}
1483 \def\strutheightpercent{.70833}
1484 \def\strutdepthpercent {.29167}
1486 % can get a sort of poor man's double spacing by redefining this.
1487 \def\baselinefactor{1}
1489 \newdimen\textleading
1492 \normalbaselineskip = \baselinefactor\dimen0
1493 \normallineskip = \lineskipfactor\normalbaselineskip
1495 \setbox\strutbox =\hbox{%
1496 \vrule width0pt height\strutheightpercent\baselineskip
1497 depth \strutdepthpercent \baselineskip
1501 % PDF CMaps. See also LaTeX's t1.cmap.
1503 % do nothing with this by default.
1504 \expandafter\let\csname cmapOT1\endcsname\gobble
1505 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1506 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1508 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1509 % (\pdffontattr was introduced many years ago, but people still run
1510 % older pdftex's; it's easy to conditionalize, so we do.)
1511 \ifpdf \ifx\pdffontattr\thisisundefined \else
1513 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1514 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1515 %%DocumentNeededResources: ProcSet (CIDInit)
1516 %%IncludeResource: ProcSet (CIDInit)
1517 %%BeginResource: CMap (TeX-OT1-0)
1518 %%Title: (TeX-OT1-0 TeX OT1 0)
1521 /CIDInit /ProcSet findresource begin
1529 /CMapName /TeX-OT1-0 def
1531 1 begincodespacerange
1587 CMapName currentdict /CMap defineresource pop
1593 \expandafter\edef\csname cmapOT1\endcsname#1{%
1594 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1599 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1600 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1601 %%DocumentNeededResources: ProcSet (CIDInit)
1602 %%IncludeResource: ProcSet (CIDInit)
1603 %%BeginResource: CMap (TeX-OT1IT-0)
1604 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1607 /CIDInit /ProcSet findresource begin
1615 /CMapName /TeX-OT1IT-0 def
1617 1 begincodespacerange
1675 CMapName currentdict /CMap defineresource pop
1681 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1682 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1687 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1688 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1689 %%DocumentNeededResources: ProcSet (CIDInit)
1690 %%IncludeResource: ProcSet (CIDInit)
1691 %%BeginResource: CMap (TeX-OT1TT-0)
1692 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1695 /CIDInit /ProcSet findresource begin
1703 /CMapName /TeX-OT1TT-0 def
1705 1 begincodespacerange
1750 CMapName currentdict /CMap defineresource pop
1756 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1757 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1762 % Set the font macro #1 to the font named \fontprefix#2.
1763 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1764 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1772 \def\setfont#1#2#3#4#5{%
1773 \font#1=\fontprefix#2#3 scaled #4
1774 \csname cmap#5\endcsname#1%
1776 % This is what gets called when #5 of \setfont is empty.
1781 % Use cm as the default font prefix.
1782 % To specify the font prefix, you must define \fontprefix
1783 % before you read in texinfo.tex.
1784 \ifx\fontprefix\thisisundefined
1787 % Support font families that don't use the same naming scheme as CM.
1789 \def\rmbshape{bx} % where the normal face is bold
1794 \def\ttslshape{sltt}
1804 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1806 \def\definetextfontsizexi{%
1807 % Text fonts (11.2pt, magstep1).
1808 \def\textnominalsize{11pt}
1809 \edef\mainmagstep{\magstephalf}
1810 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1811 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1812 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1813 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1814 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1815 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1816 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1817 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1818 \font\texti=cmmi10 scaled \mainmagstep
1819 \font\textsy=cmsy10 scaled \mainmagstep
1820 \def\textecsize{1095}
1822 % A few fonts for @defun names and args.
1823 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1824 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1825 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1826 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1828 % Fonts for indices, footnotes, small examples (9pt).
1829 \def\smallnominalsize{9pt}
1830 \setfont\smallrm\rmshape{9}{1000}{OT1}
1831 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1832 \setfont\smallbf\bfshape{10}{900}{OT1}
1833 \setfont\smallit\itshape{9}{1000}{OT1IT}
1834 \setfont\smallsl\slshape{9}{1000}{OT1}
1835 \setfont\smallsf\sfshape{9}{1000}{OT1}
1836 \setfont\smallsc\scshape{10}{900}{OT1}
1837 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1840 \def\smallecsize{0900}
1842 % Fonts for small examples (8pt).
1843 \def\smallernominalsize{8pt}
1844 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1845 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1846 \setfont\smallerbf\bfshape{10}{800}{OT1}
1847 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1848 \setfont\smallersl\slshape{8}{1000}{OT1}
1849 \setfont\smallersf\sfshape{8}{1000}{OT1}
1850 \setfont\smallersc\scshape{10}{800}{OT1}
1851 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1852 \font\smalleri=cmmi8
1853 \font\smallersy=cmsy8
1854 \def\smallerecsize{0800}
1856 % Fonts for title page (20.4pt):
1857 \def\titlenominalsize{20pt}
1858 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1859 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1860 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1861 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1862 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1863 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1864 \let\titlebf=\titlerm
1865 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1866 \font\titlei=cmmi12 scaled \magstep3
1867 \font\titlesy=cmsy10 scaled \magstep4
1868 \def\titleecsize{2074}
1870 % Chapter (and unnumbered) fonts (17.28pt).
1871 \def\chapnominalsize{17pt}
1872 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1873 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1874 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1875 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1876 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1877 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1879 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1880 \font\chapi=cmmi12 scaled \magstep2
1881 \font\chapsy=cmsy10 scaled \magstep3
1882 \def\chapecsize{1728}
1884 % Section fonts (14.4pt).
1885 \def\secnominalsize{14pt}
1886 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1887 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1888 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1889 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1890 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1891 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1893 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1894 \font\seci=cmmi12 scaled \magstep1
1895 \font\secsy=cmsy10 scaled \magstep2
1896 \def\sececsize{1440}
1898 % Subsection fonts (13.15pt).
1899 \def\ssecnominalsize{13pt}
1900 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1901 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1902 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1903 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1904 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1905 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1907 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1908 \font\sseci=cmmi12 scaled \magstephalf
1909 \font\ssecsy=cmsy10 scaled 1315
1910 \def\ssececsize{1200}
1912 % Reduced fonts for @acro in text (10pt).
1913 \def\reducednominalsize{10pt}
1914 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1915 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1916 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1917 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1918 \setfont\reducedsl\slshape{10}{1000}{OT1}
1919 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1920 \setfont\reducedsc\scshape{10}{1000}{OT1}
1921 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1922 \font\reducedi=cmmi10
1923 \font\reducedsy=cmsy10
1924 \def\reducedecsize{1000}
1926 \textleading = 13.2pt % line spacing for 11pt CM
1927 \textfonts % reset the current fonts
1929 } % end of 11pt text font size definitions, \definetextfontsizexi
1932 % Definitions to make the main text be 10pt Computer Modern, with
1933 % section, chapter, etc., sizes following suit. This is for the GNU
1934 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1935 % future. Used with @smallbook, which sets the leading to 12pt.
1937 \def\definetextfontsizex{%
1938 % Text fonts (10pt).
1939 \def\textnominalsize{10pt}
1940 \edef\mainmagstep{1000}
1941 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1942 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1943 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1944 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1945 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1946 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1947 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1948 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1949 \font\texti=cmmi10 scaled \mainmagstep
1950 \font\textsy=cmsy10 scaled \mainmagstep
1951 \def\textecsize{1000}
1953 % A few fonts for @defun names and args.
1954 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1955 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1956 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1957 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1959 % Fonts for indices, footnotes, small examples (9pt).
1960 \def\smallnominalsize{9pt}
1961 \setfont\smallrm\rmshape{9}{1000}{OT1}
1962 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1963 \setfont\smallbf\bfshape{10}{900}{OT1}
1964 \setfont\smallit\itshape{9}{1000}{OT1IT}
1965 \setfont\smallsl\slshape{9}{1000}{OT1}
1966 \setfont\smallsf\sfshape{9}{1000}{OT1}
1967 \setfont\smallsc\scshape{10}{900}{OT1}
1968 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1971 \def\smallecsize{0900}
1973 % Fonts for small examples (8pt).
1974 \def\smallernominalsize{8pt}
1975 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1976 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1977 \setfont\smallerbf\bfshape{10}{800}{OT1}
1978 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1979 \setfont\smallersl\slshape{8}{1000}{OT1}
1980 \setfont\smallersf\sfshape{8}{1000}{OT1}
1981 \setfont\smallersc\scshape{10}{800}{OT1}
1982 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1983 \font\smalleri=cmmi8
1984 \font\smallersy=cmsy8
1985 \def\smallerecsize{0800}
1987 % Fonts for title page (20.4pt):
1988 \def\titlenominalsize{20pt}
1989 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1990 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1991 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1992 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1993 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1994 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1995 \let\titlebf=\titlerm
1996 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1997 \font\titlei=cmmi12 scaled \magstep3
1998 \font\titlesy=cmsy10 scaled \magstep4
1999 \def\titleecsize{2074}
2001 % Chapter fonts (14.4pt).
2002 \def\chapnominalsize{14pt}
2003 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2004 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2005 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2006 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2007 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2008 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2010 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2011 \font\chapi=cmmi12 scaled \magstep1
2012 \font\chapsy=cmsy10 scaled \magstep2
2013 \def\chapecsize{1440}
2015 % Section fonts (12pt).
2016 \def\secnominalsize{12pt}
2017 \setfont\secrm\rmbshape{12}{1000}{OT1}
2018 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2019 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2020 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2021 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2022 \setfont\secsf\sfbshape{12}{1000}{OT1}
2024 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2026 \font\secsy=cmsy10 scaled \magstep1
2027 \def\sececsize{1200}
2029 % Subsection fonts (10pt).
2030 \def\ssecnominalsize{10pt}
2031 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2032 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2033 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2034 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2035 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2036 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2038 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2041 \def\ssececsize{1000}
2043 % Reduced fonts for @acro in text (9pt).
2044 \def\reducednominalsize{9pt}
2045 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2046 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2047 \setfont\reducedbf\bfshape{10}{900}{OT1}
2048 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2049 \setfont\reducedsl\slshape{9}{1000}{OT1}
2050 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2051 \setfont\reducedsc\scshape{10}{900}{OT1}
2052 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2053 \font\reducedi=cmmi9
2054 \font\reducedsy=cmsy9
2055 \def\reducedecsize{0900}
2057 \divide\parskip by 2 % reduce space between paragraphs
2058 \textleading = 12pt % line spacing for 10pt CM
2059 \textfonts % reset the current fonts
2061 } % end of 10pt text font size definitions, \definetextfontsizex
2064 % We provide the user-level command
2066 % (or 11) to redefine the text font size. pt is assumed.
2072 \parseargdef\fonttextsize{%
2073 \def\textsizearg{#1}%
2074 %\wlog{doing @fonttextsize \textsizearg}%
2076 % Set \globaldefs so that documents can use this inside @tex, since
2077 % makeinfo 4.8 does not support it, but we need it nonetheless.
2079 \begingroup \globaldefs=1
2080 \ifx\textsizearg\xword \definetextfontsizex
2081 \else \ifx\textsizearg\xiword \definetextfontsizexi
2084 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2090 % In order for the font changes to affect most math symbols and letters,
2091 % we have to define the \textfont of the standard families. Since
2092 % texinfo doesn't allow for producing subscripts and superscripts except
2093 % in the main text, we don't bother to reset \scriptfont and
2094 % \scriptscriptfont (which would also require loading a lot more fonts).
2096 \def\resetmathfonts{%
2097 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2098 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2099 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2102 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2103 % of just \STYLE. We do this because \STYLE needs to also set the
2104 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2105 % \tenSTYLE to set the current font.
2107 % Each font-changing command also sets the names \lsize (one size lower)
2108 % and \lllsize (three sizes lower). These relative commands are used in
2109 % the LaTeX logo and acronyms.
2111 % This all needs generalizing, badly.
2114 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2115 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2116 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2117 \let\tenttsl=\textttsl
2118 \def\curfontsize{text}%
2119 \def\lsize{reduced}\def\lllsize{smaller}%
2120 \resetmathfonts \setleading{\textleading}}
2122 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2123 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2124 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2125 \let\tenttsl=\titlettsl
2126 \def\curfontsize{title}%
2127 \def\lsize{chap}\def\lllsize{subsec}%
2128 \resetmathfonts \setleading{27pt}}
2129 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2131 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2132 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2133 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2134 \let\tenttsl=\chapttsl
2135 \def\curfontsize{chap}%
2136 \def\lsize{sec}\def\lllsize{text}%
2137 \resetmathfonts \setleading{19pt}}
2139 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2140 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2141 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2142 \let\tenttsl=\secttsl
2143 \def\curfontsize{sec}%
2144 \def\lsize{subsec}\def\lllsize{reduced}%
2145 \resetmathfonts \setleading{16pt}}
2147 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2148 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2149 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2150 \let\tenttsl=\ssecttsl
2151 \def\curfontsize{ssec}%
2152 \def\lsize{text}\def\lllsize{small}%
2153 \resetmathfonts \setleading{15pt}}
2154 \let\subsubsecfonts = \subsecfonts
2156 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2157 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2158 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2159 \let\tenttsl=\reducedttsl
2160 \def\curfontsize{reduced}%
2161 \def\lsize{small}\def\lllsize{smaller}%
2162 \resetmathfonts \setleading{10.5pt}}
2164 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2165 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2166 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2167 \let\tenttsl=\smallttsl
2168 \def\curfontsize{small}%
2169 \def\lsize{smaller}\def\lllsize{smaller}%
2170 \resetmathfonts \setleading{10.5pt}}
2172 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2173 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2174 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2175 \let\tenttsl=\smallerttsl
2176 \def\curfontsize{smaller}%
2177 \def\lsize{smaller}\def\lllsize{smaller}%
2178 \resetmathfonts \setleading{9.5pt}}
2180 % Fonts for short table of contents.
2181 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2182 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2183 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2184 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2186 % Define these just so they can be easily changed for other fonts.
2187 \def\angleleft{$\langle$}
2188 \def\angleright{$\rangle$}
2190 % Set the fonts to use with the @small... environments.
2191 \let\smallexamplefonts = \smallfonts
2193 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2194 % can fit this many characters:
2195 % 8.5x11=86 smallbook=72 a4=90 a5=69
2196 % If we use \scriptfonts (8pt), then we can fit this many characters:
2197 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2198 % For me, subjectively, the few extra characters that fit aren't worth
2199 % the additional smallness of 8pt. So I'm making the default 9pt.
2201 % By the way, for comparison, here's what fits with @example (10pt):
2202 % 8.5x11=71 smallbook=60 a4=75 a5=58
2205 % Set up the default fonts, so we can use them for creating boxes.
2207 \definetextfontsizexi
2212 % Check if we are currently using a typewriter font. Since all the
2213 % Computer Modern typewriter fonts have zero interword stretch (and
2214 % shrink), and it is reasonable to expect all typewriter fonts to have
2215 % this property, we can check that font parameter.
2217 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2219 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2220 % define and register \INITMACRO to be called on markup style changes.
2221 % \INITMACRO can check \currentmarkupstyle for the innermost
2222 % style and the set of \ifmarkupSTYLE switches for all styles
2223 % currently in effect.
2227 %\newif\ifmarkupfile % @file == @samp.
2228 %\newif\ifmarkupoption % @option == @samp.
2231 %\newif\ifmarkupenv % @env == @code.
2232 %\newif\ifmarkupcommand % @command == @code.
2233 \newif\ifmarkuptex % @tex (and part of @math, for now).
2234 \newif\ifmarkupexample
2236 \newif\ifmarkupverbatim
2238 \let\currentmarkupstyle\empty
2240 \def\setupmarkupstyle#1{%
2241 \csname markup#1true\endcsname
2242 \def\currentmarkupstyle{#1}%
2246 \let\markupstylesetup\empty
2248 \def\defmarkupstylesetup#1{%
2249 \expandafter\def\expandafter\markupstylesetup
2250 \expandafter{\markupstylesetup #1}%
2254 % Markup style setup for left and right quotes.
2255 \defmarkupstylesetup\markupsetuplq{%
2256 \expandafter\let\expandafter \temp
2257 \csname markupsetuplq\currentmarkupstyle\endcsname
2258 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2261 \defmarkupstylesetup\markupsetuprq{%
2262 \expandafter\let\expandafter \temp
2263 \csname markupsetuprq\currentmarkupstyle\endcsname
2264 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2271 \gdef\markupsetuplqdefault{\let`\lq}
2272 \gdef\markupsetuprqdefault{\let'\rq}
2274 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2275 \gdef\markupsetcodequoteright{\let'\codequoteright}
2278 \let\markupsetuplqcode \markupsetcodequoteleft
2279 \let\markupsetuprqcode \markupsetcodequoteright
2281 \let\markupsetuplqexample \markupsetcodequoteleft
2282 \let\markupsetuprqexample \markupsetcodequoteright
2284 \let\markupsetuplqkbd \markupsetcodequoteleft
2285 \let\markupsetuprqkbd \markupsetcodequoteright
2287 \let\markupsetuplqsamp \markupsetcodequoteleft
2288 \let\markupsetuprqsamp \markupsetcodequoteright
2290 \let\markupsetuplqverb \markupsetcodequoteleft
2291 \let\markupsetuprqverb \markupsetcodequoteright
2293 \let\markupsetuplqverbatim \markupsetcodequoteleft
2294 \let\markupsetuprqverbatim \markupsetcodequoteright
2296 % Allow an option to not use regular directed right quote/apostrophe
2297 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2298 % The undirected quote is ugly, so don't make it the default, but it
2299 % works for pasting with more pdf viewers (at least evince), the
2300 % lilypond developers report. xpdf does work with the regular 0x27.
2302 \def\codequoteright{%
2303 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2304 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2310 % and a similar option for the left quote char vs. a grave accent.
2311 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2312 % the code environments to do likewise.
2314 \def\codequoteleft{%
2315 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2316 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2317 % [Knuth] pp. 380,381,391
2318 % \relax disables Spanish ligatures ?` and !` of \tt font.
2324 % Commands to set the quote options.
2326 \parseargdef\codequoteundirected{%
2329 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2331 \else\ifx\temp\offword
2332 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2335 \errhelp = \EMsimple
2336 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2340 \parseargdef\codequotebacktick{%
2343 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2345 \else\ifx\temp\offword
2346 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2349 \errhelp = \EMsimple
2350 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2354 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2355 \def\noligaturesquoteleft{\relax\lq}
2357 % Count depth in font-changes, for error checks
2358 \newcount\fontdepth \fontdepth=0
2362 % #1 is the font command (\sl or \it), #2 is the text to slant.
2363 % If we are in a monospaced environment, however, 1) always use \ttsl,
2364 % and 2) do not add an italic correction.
2365 \def\dosmartslant#1#2{%
2367 {{\ttsl #2}\let\next=\relax}%
2368 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2371 \def\smartslanted{\dosmartslant\sl}
2372 \def\smartitalic{\dosmartslant\it}
2374 % Output an italic correction unless \next (presumed to be the following
2375 % character) is such as not to need one.
2376 \def\smartitaliccorrection{%
2381 \else\ifx\next\comma%
2387 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2388 \def\ttslanted#1{{\ttsl #1}}
2390 % @cite is like \smartslanted except unconditionally use \sl. We never want
2391 % ttsl for book titles, do we?
2392 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2396 \let\saveaftersmartic = \aftersmartic
2397 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2402 \let\slanted=\smartslanted
2403 \let\dfn=\smartslanted
2404 \let\emph=\smartitalic
2406 % Explicit font changes: @r, @sc, undocumented @ii.
2407 \def\r#1{{\rm #1}} % roman font
2408 \def\sc#1{{\smallcaps#1}} % smallcaps font
2409 \def\ii#1{{\it #1}} % italic font
2411 % @b, explicit bold. Also @strong.
2415 % @sansserif, explicit sans.
2416 \def\sansserif#1{{\sf #1}}
2418 % We can't just use \exhyphenpenalty, because that only has effect at
2419 % the end of a paragraph. Restore normal hyphenation at the end of the
2420 % group within which \nohyphenation is presumably called.
2422 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2423 \def\restorehyphenation{\hyphenchar\font = `- }
2425 % Set sfcode to normal for the chars that usually have another value.
2426 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2427 % sometimes \x has an active definition that messes things up.
2430 \def\plainfrenchspacing{%
2431 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2432 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2433 \def\endofsentencespacefactor{1000}% for @. and friends
2435 \def\plainnonfrenchspacing{%
2436 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2437 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2438 \def\endofsentencespacefactor{3000}% for @. and friends
2441 \def\endofsentencespacefactor{3000}% default
2443 % @t, explicit typewriter.
2445 {\tt \rawbackslash \plainfrenchspacing #1}%
2450 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2452 % @indicateurl is \samp, that is, with quotes.
2453 \let\indicateurl=\samp
2455 % @code (and similar) prints in typewriter, but with spaces the same
2456 % size as normal in the surrounding text, without hyphenation, etc.
2457 % This is a subroutine for that.
2460 % Change normal interword space to be same as for the current font.
2461 \spaceskip = \fontdimen2\font
2463 % Switch to typewriter.
2466 % But `\ ' produces the large typewriter interword space.
2467 \def\ {{\spaceskip = 0pt{} }}%
2469 % Turn off hyphenation.
2476 \null % reset spacefactor to 1000
2479 % We *must* turn on hyphenation at `-' and `_' in @code.
2480 % (But see \codedashfinish below.)
2481 % Otherwise, it is too hard to avoid overfull hboxes
2482 % in the Emacs manual, the Library manual, etc.
2484 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2485 % both hyphenation at - and hyphenation within words.
2486 % We must therefore turn them both off (\tclose does that)
2487 % and arrange explicitly to hyphenate at a dash. -- rms.
2489 \catcode`\-=\active \catcode`\_=\active
2490 \catcode`\'=\active \catcode`\`=\active
2491 \global\let'=\rq \global\let`=\lq % default definitions
2493 \global\def\code{\begingroup
2494 \setupmarkupstyle{code}%
2495 % The following should really be moved into \setupmarkupstyle handlers.
2496 \catcode\dashChar=\active \catcode\underChar=\active
2504 % Given -foo (with a single dash), we do not want to allow a break
2506 \global\let\codedashprev=\codedash
2511 \gdef\codedash{\futurelet\next\codedashfinish}
2512 \gdef\codedashfinish{%
2513 \normaldash % always output the dash character itself.
2515 % Now, output a discretionary to allow a line break, unless
2516 % (a) the next character is a -, or
2517 % (b) the preceding character is a -.
2518 % E.g., given --posix, we do not want to allow a break after either -.
2519 % Given --foo-bar, we do want to allow a break between the - and the b.
2520 \ifx\next\codedash \else
2521 \ifx\codedashprev\codedash
2522 \else \discretionary{}{}{}\fi
2524 % we need the space after the = for the case when \next itself is a
2525 % space token; it would get swallowed otherwise. As in @code{- a}.
2526 \global\let\codedashprev= \next
2531 \def\codex #1{\tclose{#1}\endgroup}
2534 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2535 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2536 % will therefore expand the active definition of _, which is us
2537 % (inside @code that is), therefore an endless loop.
2539 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2540 \else\normalunderscore \fi
2541 \discretionary{}{}{}}%
2545 % An additional complication: the above will allow breaks after, e.g.,
2546 % each of the four underscores in __typeof__. This is bad.
2547 % @allowcodebreaks provides a document-level way to turn breaking at -
2550 \newif\ifallowcodebreaks \allowcodebreakstrue
2552 \def\keywordtrue{true}
2553 \def\keywordfalse{false}
2555 \parseargdef\allowcodebreaks{%
2557 \ifx\txiarg\keywordtrue
2558 \allowcodebreakstrue
2559 \else\ifx\txiarg\keywordfalse
2560 \allowcodebreaksfalse
2562 \errhelp = \EMsimple
2563 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2567 % For @command, @env, @file, @option quotes seem unnecessary,
2568 % so use \code rather than \samp.
2574 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2575 % second argument specifying the text to display and an optional third
2576 % arg as text to display instead of (rather than in addition to) the url
2577 % itself. First (mandatory) arg is the url.
2578 % (This \urefnobreak definition isn't used now, leaving it for a while
2580 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2581 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2584 \setbox0 = \hbox{\ignorespaces #3}%
2586 \unhbox0 % third arg given, show only that
2588 \setbox0 = \hbox{\ignorespaces #2}%
2591 \unhbox0 % PDF: 2nd arg given, show only it
2593 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2596 \code{#1}% only url given, so show it
2602 % This \urefbreak definition is the active one.
2603 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2604 \let\uref=\urefbreak
2605 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2606 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2609 \setbox0 = \hbox{\ignorespaces #3}%
2611 \unhbox0 % third arg given, show only that
2613 \setbox0 = \hbox{\ignorespaces #2}%
2616 \unhbox0 % PDF: 2nd arg given, show only it
2618 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2621 \urefcode{#1}% only url given, so show it
2627 % Allow line breaks around only a few characters (only).
2629 \catcode\ampChar=\active \catcode\dotChar=\active
2630 \catcode\hashChar=\active \catcode\questChar=\active
2631 \catcode\slashChar=\active
2636 \global\def\urefcode{\begingroup
2637 \setupmarkupstyle{code}%
2647 % By default, they are just regular characters.
2648 \global\def&{\normalamp}
2649 \global\def.{\normaldot}
2650 \global\def#{\normalhash}
2651 \global\def?{\normalquest}
2652 \global\def/{\normalslash}
2655 % we put a little stretch before and after the breakable chars, to help
2656 % line breaking of long url's. The unequal skips make look better in
2657 % cmtt at least, especially for dots.
2658 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2659 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2661 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2662 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2663 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2664 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2665 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2668 \global\def\urefcodeslashfinish{%
2669 \urefprestretch \slashChar
2670 % Allow line break only after the final / in a sequence of
2671 % slashes, to avoid line break between the slashes in http://.
2672 \ifx\next/\else \urefpoststretch \fi
2676 % One more complication: by default we'll break after the special
2677 % characters, but some people like to break before the special chars, so
2678 % allow that. Also allow no breaking at all, for manual control.
2680 \parseargdef\urefbreakstyle{%
2682 \ifx\txiarg\wordnone
2683 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2684 \else\ifx\txiarg\wordbefore
2685 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2686 \else\ifx\txiarg\wordafter
2687 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2689 \errhelp = \EMsimple
2690 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2693 \def\wordafter{after}
2694 \def\wordbefore{before}
2697 \urefbreakstyle after
2699 % @url synonym for @uref, since that's how everyone uses it.
2703 % rms does not like angle brackets --karl, 17may97.
2704 % So now @email is just like @uref, unless we are pdf.
2706 %\def\email#1{\angleleft{\tt #1}\angleright}
2708 \def\email#1{\doemail#1,,\finish}
2709 \def\doemail#1,#2,#3\finish{\begingroup
2712 \setbox0 = \hbox{\ignorespaces #2}%
2713 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2720 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2721 % `example' (@kbd uses ttsl only inside of @example and friends),
2722 % or `code' (@kbd uses normal tty font always).
2723 \parseargdef\kbdinputstyle{%
2725 \ifx\txiarg\worddistinct
2726 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2727 \else\ifx\txiarg\wordexample
2728 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2729 \else\ifx\txiarg\wordcode
2730 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2732 \errhelp = \EMsimple
2733 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2736 \def\worddistinct{distinct}
2737 \def\wordexample{example}
2740 % Default is `distinct'.
2741 \kbdinputstyle distinct
2743 % @kbd is like @code, except that if the argument is just one @key command,
2744 % then @kbd has no effect.
2745 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2748 \def\kbdsub#1#2#3\par{%
2749 \def\one{#1}\def\three{#3}\def\threex{??}%
2750 \ifx\one\xkey\ifx\threex\three \key{#2}%
2751 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2752 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2755 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2756 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2758 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2759 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2760 % \vbox{\hrule\kern-0.4pt
2761 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2762 % \kern-0.4pt\hrule}%
2763 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2765 % definition of @key with no lozenge. If the current font is already
2766 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2767 % if it isn't monospace, then use \tt.
2769 \def\key#1{{\setupmarkupstyle{key}%
2771 \ifmonospace\else\tt\fi
2774 % @clicksequence{File @click{} Open ...}
2775 \def\clicksequence#1{\begingroup #1\endgroup}
2777 % @clickstyle @arrow (by default)
2778 \parseargdef\clickstyle{\def\click{#1}}
2781 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2782 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2784 \def\dmn#1{\thinspace #1}
2786 % @l was never documented to mean ``switch to the Lisp font'',
2787 % and it is not used as such in any manual I can find. We need it for
2788 % Polish suppressed-l. --karl, 22sep96.
2789 %\def\l#1{{\li #1}\null}
2791 % @acronym for "FBI", "NATO", and the like.
2792 % We print this one point size smaller, since it's intended for
2795 \def\acronym#1{\doacronym #1,,\finish}
2796 \def\doacronym#1,#2,#3\finish{%
2797 {\selectfonts\lsize #1}%
2799 \ifx\temp\empty \else
2800 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2802 \null % reset \spacefactor=1000
2805 % @abbr for "Comput. J." and the like.
2806 % No font change, but don't do end-of-sentence spacing.
2808 \def\abbr#1{\doabbr #1,,\finish}
2809 \def\doabbr#1,#2,#3\finish{%
2810 {\plainfrenchspacing #1}%
2812 \ifx\temp\empty \else
2813 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2815 \null % reset \spacefactor=1000
2818 % @asis just yields its argument. Used with @table, for example.
2822 % @math outputs its argument in math mode.
2824 % One complication: _ usually means subscripts, but it could also mean
2825 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2826 % _ active, and distinguish by seeing if the current family is \slfam,
2827 % which is what @var uses.
2829 \catcode`\_ = \active
2830 \gdef\mathunderscore{%
2832 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2835 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2836 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2837 % particular reason), but this is not advertised and we don't care.
2839 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2840 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2845 \let\\ = \mathbackslash
2847 % make the texinfo accent commands work in math mode
2859 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2861 % Some active characters (such as <) are spaced differently in math.
2862 % We have to reset their definitions in case the @math was an argument
2863 % to a command which sets the catcodes (such as @item or @section).
2866 \catcode`^ = \active
2867 \catcode`< = \active
2868 \catcode`> = \active
2869 \catcode`+ = \active
2870 \catcode`' = \active
2876 \let' = \ptexquoteright
2880 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2881 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2883 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2884 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2885 % except specified as a normal braced arg, so no newlines to worry about.
2887 \def\outfmtnametex{tex}
2889 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2890 \long\def\doinlinefmt#1,#2,\finish{%
2891 \def\inlinefmtname{#1}%
2892 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2894 % For raw, must switch into @tex before parsing the argument, to avoid
2895 % setting catcodes prematurely. Doing it this way means that, for
2896 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2897 % ignored. But this isn't important because if people want a literal
2898 % *right* brace they would have to use a command anyway, so they may as
2899 % well use a command to get a left brace too. We could re-use the
2900 % delimiter character idea from \verb, but it seems like overkill.
2902 \long\def\inlineraw{\tex \doinlineraw}
2903 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2904 \def\doinlinerawtwo#1,#2,\finish{%
2905 \def\inlinerawname{#1}%
2906 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2907 \endgroup % close group opened by \tex.
2914 % @@ prints an @, as does @atchar{}.
2918 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2919 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2920 % not have braces, and we don't want to switch into math.
2921 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2922 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2923 \let\{=\mylbrace \let\lbracechar=\{
2924 \let\}=\myrbrace \let\rbracechar=\}
2926 % Definitions to produce \{ and \} commands for indices,
2927 % and @{ and @} for the aux/toc files.
2928 \catcode`\{ = \other \catcode`\} = \other
2929 \catcode`\[ = 1 \catcode`\] = 2
2930 \catcode`\! = 0 \catcode`\\ = \other
2931 !gdef!lbracecmd[\{]%
2932 !gdef!rbracecmd[\}]%
2933 !gdef!lbraceatcmd[@{]%
2934 !gdef!rbraceatcmd[@}]%
2937 % @comma{} to avoid , parsing problems.
2940 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2941 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2943 \let\dotaccent = \ptexdot
2944 \def\ringaccent#1{{\accent23 #1}}
2945 \let\tieaccent = \ptext
2946 \let\ubaraccent = \ptexb
2947 \let\udotaccent = \d
2949 % Other special characters: @questiondown @exclamdown @ordf @ordm
2950 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2951 \def\questiondown{?`}
2953 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2954 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2956 % Dotless i and dotless j, used for accents.
2961 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2962 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2963 \else \errmessage{@dotless can be used only with i or j}%
2967 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2968 % period following counts as ending a sentence. (Idea found in latex.)
2970 \edef\TeX{\TeX \spacefactor=1000 }
2972 % @LaTeX{} logo. Not quite the same results as the definition in
2973 % latex.ltx, since we use a different font for the raised A; it's most
2974 % convenient for us to use an explicitly smaller font, rather than using
2975 % the \scriptstyle font (since we don't reset \scriptstyle and
2976 % \scriptscriptstyle).
2981 \vbox to \ht0{\hbox{%
2982 \ifx\textnominalsize\xwordpt
2983 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2984 % Revert to plain's \scriptsize, which is 7pt.
2985 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2987 % For 11pt, we can use our lllsize.
2988 \selectfonts\lllsize A%
2997 % Some math mode symbols.
2998 \def\bullet{$\ptexbullet$}
2999 \def\geq{\ifmmode \ge\else $\ge$\fi}
3000 \def\leq{\ifmmode \le\else $\le$\fi}
3001 \def\minus{\ifmmode -\else $-$\fi}
3003 % @dots{} outputs an ellipsis using the current font.
3004 % We do .5em per period so that it has the same spacing in the cm
3005 % typewriter fonts as three actual period characters; on the other hand,
3006 % in other typewriter fonts three periods are wider than 1.5em. So do
3007 % whichever is larger.
3011 \setbox0=\hbox{...}% get width of three periods
3018 \hskip 0pt plus.25fil
3019 .\hskip 0pt plus1fil
3020 .\hskip 0pt plus1fil
3021 .\hskip 0pt plus.5fil
3025 % @enddots{} is an end-of-sentence ellipsis.
3029 \spacefactor=\endofsentencespacefactor
3032 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3034 % Since these characters are used in examples, they should be an even number of
3035 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3038 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3039 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3040 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3041 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3042 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3044 % The @error{} command.
3045 % Adapted from the TeXbook's \boxit.
3049 {\tentt \global\dimen0 = 3em}% Width of the box.
3050 \dimen2 = .55pt % Thickness of rules
3051 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3052 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3054 \setbox\errorbox=\hbox to \dimen0{\hfil
3055 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3056 \advance\hsize by -2\dimen2 % Rules.
3058 \hrule height\dimen2
3059 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3060 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3061 \kern3pt\vrule width\dimen2}% Space to right.
3062 \hrule height\dimen2}
3065 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3067 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3069 \def\pounds{{\it\$}}
3071 % @euro{} comes from a separate font, depending on the current style.
3072 % We use the free feym* fonts from the eurosym package by Henrik
3073 % Theiling, which support regular, slanted, bold and bold slanted (and
3074 % "outlined" (blackboard board, sort of) versions, which we don't need).
3075 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3077 % Although only regular is the truly official Euro symbol, we ignore
3078 % that. The Euro is designed to be slightly taller than the regular
3084 % feybo - bold slanted
3086 % There is no good (free) typewriter version, to my knowledge.
3087 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3090 % Also doesn't work in math. Do we need to do math with euro symbols?
3094 \def\euro{{\eurofont e}}
3096 % We set the font at each command, rather than predefining it in
3097 % \textfonts and the other font-switching commands, so that
3098 % installations which never need the symbol don't have to have the
3101 % There is only one designed size (nominal 10pt), so we always scale
3102 % that to the current nominal size.
3104 % By the way, simply using "at 1em" works for cmr10 and the like, but
3105 % does not work for cmbx10 and other extended/shrunken fonts.
3107 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3109 \ifx\curfontstyle\bfstylename
3111 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3114 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3119 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3120 % sometimes we redefine the original macro, and the alias should reflect
3123 % Use LaTeX names for the Icelandic letters.
3124 \def\DH{{\ecfont \char"D0}} % Eth
3125 \def\dh{{\ecfont \char"F0}} % eth
3126 \def\TH{{\ecfont \char"DE}} % Thorn
3127 \def\th{{\ecfont \char"FE}} % thorn
3129 \def\guillemetleft{{\ecfont \char"13}}
3130 \def\guillemotleft{\guillemetleft}
3131 \def\guillemetright{{\ecfont \char"14}}
3132 \def\guillemotright{\guillemetright}
3133 \def\guilsinglleft{{\ecfont \char"0E}}
3134 \def\guilsinglright{{\ecfont \char"0F}}
3135 \def\quotedblbase{{\ecfont \char"12}}
3136 \def\quotesinglbase{{\ecfont \char"0D}}
3138 % This positioning is not perfect (see the ogonek LaTeX package), but
3139 % we have the precomposed glyphs for the most common cases. We put the
3140 % tests to use those glyphs in the single \ogonek macro so we have fewer
3141 % dummy definitions to worry about for index entries, etc.
3143 % ogonek is also used with other letters in Lithuanian (IOU), but using
3144 % the precomposed glyphs for those is not so easy since they aren't in
3148 \ifx\temp\macrocharA\Aogonek
3149 \else\ifx\temp\macrochara\aogonek
3150 \else\ifx\temp\macrocharE\Eogonek
3151 \else\ifx\temp\macrochare\eogonek
3153 \ecfont \setbox0=\hbox{#1}%
3154 \ifdim\ht0=1ex\accent"0C #1%
3155 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3160 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3161 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3162 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3163 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3165 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3167 % We can't distinguish serif/sans and italic/slanted, but this
3168 % is used for crude hacks anyway (like adding French and German
3169 % quotes to documents typeset with CM, where we lose kerning), so
3170 % hopefully nobody will notice/care.
3171 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3172 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3175 \font\thisecfont = ectt\ecsize \space at \nominalsize
3177 \ifx\curfontstyle\bfstylename
3179 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3182 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3188 % @registeredsymbol - R in a circle. The font for the R should really
3189 % be smaller yet, but lllsize is the best we can do for now.
3190 % Adapted from the plain.tex definition of \copyright.
3192 \def\registeredsymbol{%
3193 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3198 % @textdegree - the normal degrees sign.
3200 \def\textdegree{$^\circ$}
3202 % Laurent Siebenmann reports \Orb undefined with:
3203 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3204 % so we'll define it if necessary.
3206 \ifx\Orb\thisisundefined
3207 \def\Orb{\mathhexbox20D}
3211 \chardef\quotedblleft="5C
3212 \chardef\quotedblright=`\"
3213 \chardef\quoteleft=`\`
3214 \chardef\quoteright=`\'
3217 \message{page headings,}
3219 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3220 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3222 % First the title page. Must do @settitle before @titlepage.
3224 \newif\iffinishedtitlepage
3226 % Do an implicit @contents or @shortcontents after @end titlepage if the
3227 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3229 \newif\ifsetcontentsaftertitlepage
3230 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3231 \newif\ifsetshortcontentsaftertitlepage
3232 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3234 \parseargdef\shorttitlepage{%
3235 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3236 \endgroup\page\hbox{}\page}
3239 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3241 \parindent=0pt \textfonts
3242 % Leave some space at the very top of the page.
3243 \vglue\titlepagetopglue
3244 % No rule at page bottom unless we print one at the top with @title.
3245 \finishedtitlepagetrue
3247 % Most title ``pages'' are actually two pages long, with space
3248 % at the top of the second. We don't want the ragged left on the second.
3249 \let\oldpage = \page
3251 \iffinishedtitlepage\else
3254 \let\page = \oldpage
3261 \iffinishedtitlepage\else
3264 % It is important to do the page break before ending the group,
3265 % because the headline and footline are only empty inside the group.
3266 % If we use the new definition of \page, we always get a blank page
3267 % after the title page, which we certainly don't want.
3271 % Need this before the \...aftertitlepage checks so that if they are
3272 % in effect the toc pages will come out with page numbers.
3275 % If they want short, they certainly want long too.
3276 \ifsetshortcontentsaftertitlepage
3279 \global\let\shortcontents = \relax
3280 \global\let\contents = \relax
3283 \ifsetcontentsaftertitlepage
3285 \global\let\contents = \relax
3286 \global\let\shortcontents = \relax
3290 \def\finishtitlepage{%
3291 \vskip4pt \hrule height 2pt width \hsize
3292 \vskip\titlepagebottomglue
3293 \finishedtitlepagetrue
3296 % Settings used for typesetting titles: no hyphenation, no indentation,
3297 % don't worry much about spacing, ragged right. This should be used
3298 % inside a \vbox, and fonts need to be set appropriately first. Because
3299 % it is always used for titles, nothing else, we call \rmisbold. \par
3300 % should be specified before the end of the \vbox, since a vbox is a group.
3302 \def\raggedtitlesettings{%
3304 \hyphenpenalty=10000
3310 % Macros to be used within @titlepage:
3312 \let\subtitlerm=\tenrm
3313 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3315 \parseargdef\title{%
3317 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3318 % print a rule at the page bottom also.
3319 \finishedtitlepagefalse
3320 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3323 \parseargdef\subtitle{%
3325 {\subtitlefont \rightline{#1}}%
3328 % @author should come last, but may come many times.
3329 % It can also be used inside @quotation.
3331 \parseargdef\author{%
3332 \def\temp{\quotation}%
3334 \def\quotationauthor{#1}% printed in \Equotation.
3337 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3338 {\secfonts\rmisbold \leftline{#1}}%
3343 % Set up page headings and footings.
3345 \let\thispage=\folio
3347 \newtoks\evenheadline % headline on even pages
3348 \newtoks\oddheadline % headline on odd pages
3349 \newtoks\evenfootline % footline on even pages
3350 \newtoks\oddfootline % footline on odd pages
3352 % Now make TeX use those variables
3353 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3354 \else \the\evenheadline \fi}}
3355 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3356 \else \the\evenfootline \fi}\HEADINGShook}
3357 \let\HEADINGShook=\relax
3359 % Commands to set those variables.
3360 % For example, this is what @headings on does
3361 % @evenheading @thistitle|@thispage|@thischapter
3362 % @oddheading @thischapter|@thispage|@thistitle
3363 % @evenfooting @thisfile||
3364 % @oddfooting ||@thisfile
3367 \def\evenheading{\parsearg\evenheadingxxx}
3368 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3369 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3370 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3372 \def\oddheading{\parsearg\oddheadingxxx}
3373 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3374 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3375 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3377 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3379 \def\evenfooting{\parsearg\evenfootingxxx}
3380 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3381 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3382 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3384 \def\oddfooting{\parsearg\oddfootingxxx}
3385 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3386 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3387 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3389 % Leave some space for the footline. Hopefully ok to assume
3390 % @evenfooting will not be used by itself.
3391 \global\advance\pageheight by -12pt
3392 \global\advance\vsize by -12pt
3395 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3397 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3398 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3400 % The same set of arguments for:
3405 % @everyheadingmarks
3406 % @everyfootingmarks
3408 \def\evenheadingmarks{\headingmarks{even}{heading}}
3409 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3410 \def\evenfootingmarks{\headingmarks{even}{footing}}
3411 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3412 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3413 \headingmarks{odd}{heading}{#1} }
3414 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3415 \headingmarks{odd}{footing}{#1} }
3416 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3417 \def\headingmarks#1#2#3 {%
3418 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3419 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3422 \everyheadingmarks bottom
3423 \everyfootingmarks bottom
3425 % @headings double turns headings on for double-sided printing.
3426 % @headings single turns headings on for single-sided printing.
3427 % @headings off turns them off.
3428 % @headings on same as @headings double, retained for compatibility.
3429 % @headings after turns on double-sided headings after this page.
3430 % @headings doubleafter turns on double-sided headings after this page.
3431 % @headings singleafter turns on single-sided headings after this page.
3432 % By default, they are off at the start of a document,
3433 % and turned `on' after @end titlepage.
3435 \def\headings #1 {\csname HEADINGS#1\endcsname}
3437 \def\headingsoff{% non-global headings elimination
3438 \evenheadline={\hfil}\evenfootline={\hfil}%
3439 \oddheadline={\hfil}\oddfootline={\hfil}%
3442 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3443 \HEADINGSoff % it's the default
3445 % When we turn headings on, set the page number to 1.
3446 % For double-sided printing, put current file name in lower left corner,
3447 % chapter name on inside top of right hand pages, document
3448 % title on inside top of left hand pages, and page numbers on outside top
3449 % edge of all pages.
3450 \def\HEADINGSdouble{%
3452 \global\evenfootline={\hfil}
3453 \global\oddfootline={\hfil}
3454 \global\evenheadline={\line{\folio\hfil\thistitle}}
3455 \global\oddheadline={\line{\thischapter\hfil\folio}}
3456 \global\let\contentsalignmacro = \chapoddpage
3458 \let\contentsalignmacro = \chappager
3460 % For single-sided printing, chapter title goes across top left of page,
3461 % page number on top right.
3462 \def\HEADINGSsingle{%
3464 \global\evenfootline={\hfil}
3465 \global\oddfootline={\hfil}
3466 \global\evenheadline={\line{\thischapter\hfil\folio}}
3467 \global\oddheadline={\line{\thischapter\hfil\folio}}
3468 \global\let\contentsalignmacro = \chappager
3470 \def\HEADINGSon{\HEADINGSdouble}
3472 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3473 \let\HEADINGSdoubleafter=\HEADINGSafter
3474 \def\HEADINGSdoublex{%
3475 \global\evenfootline={\hfil}
3476 \global\oddfootline={\hfil}
3477 \global\evenheadline={\line{\folio\hfil\thistitle}}
3478 \global\oddheadline={\line{\thischapter\hfil\folio}}
3479 \global\let\contentsalignmacro = \chapoddpage
3482 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3483 \def\HEADINGSsinglex{%
3484 \global\evenfootline={\hfil}
3485 \global\oddfootline={\hfil}
3486 \global\evenheadline={\line{\thischapter\hfil\folio}}
3487 \global\oddheadline={\line{\thischapter\hfil\folio}}
3488 \global\let\contentsalignmacro = \chappager
3491 % Subroutines used in generating headings
3492 % This produces Day Month Year style of output.
3493 % Only define if not already defined, in case a txi-??.tex file has set
3494 % up a different format (e.g., txi-cs.tex does this).
3495 \ifx\today\thisisundefined
3499 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3500 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3501 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3506 % @settitle line... specifies the title of the document, for headings.
3507 % It generates no output of its own.
3508 \def\thistitle{\putwordNoTitle}
3509 \def\settitle{\parsearg{\gdef\thistitle}}
3513 % Tables -- @table, @ftable, @vtable, @item(x).
3515 % default indentation of table text
3516 \newdimen\tableindent \tableindent=.8in
3517 % default indentation of @itemize and @enumerate text
3518 \newdimen\itemindent \itemindent=.3in
3519 % margin between end of table item and start of table text.
3520 \newdimen\itemmargin \itemmargin=.1in
3522 % used internally for \itemindent minus \itemmargin
3525 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3527 % They also define \itemindex
3528 % to index the item name in whatever manner is desired (perhaps none).
3530 \newif\ifitemxneedsnegativevskip
3532 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3534 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3535 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3537 \def\itemzzz #1{\begingroup %
3538 \advance\hsize by -\rightskip
3539 \advance\hsize by -\tableindent
3540 \setbox0=\hbox{\itemindicate{#1}}%
3542 \nobreak % This prevents a break before @itemx.
3544 % If the item text does not fit in the space we have, put it on a line
3545 % by itself, and do not allow a page break either before or after that
3546 % line. We do not start a paragraph here because then if the next
3547 % command is, e.g., @kindex, the whatsit would get put into the
3548 % horizontal list on a line by itself, resulting in extra blank space.
3549 \ifdim \wd0>\itemmax
3551 % Make this a paragraph so we get the \parskip glue and wrapping,
3552 % but leave it ragged-right.
3554 \advance\leftskip by-\tableindent
3555 \advance\hsize by\tableindent
3556 \advance\rightskip by0pt plus1fil\relax
3557 \leavevmode\unhbox0\par
3560 % We're going to be starting a paragraph, but we don't want the
3561 % \parskip glue -- logically it's part of the @item we just started.
3562 \nobreak \vskip-\parskip
3564 % Stop a page break at the \parskip glue coming up. However, if
3565 % what follows is an environment such as @example, there will be no
3566 % \parskip glue; then the negative vskip we just inserted would
3567 % cause the example and the item to crash together. So we use this
3568 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3569 % \parskip glue after all. Section titles are handled this way also.
3573 \itemxneedsnegativevskipfalse
3575 % The item text fits into the space. Start a paragraph, so that the
3576 % following text (if any) will end up on the same line.
3578 % Do this with kerns and \unhbox so that if there is a footnote in
3579 % the item text, it can migrate to the main vertical list and
3580 % eventually be printed.
3581 \nobreak\kern-\tableindent
3582 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3584 \nobreak\kern\dimen0
3586 \itemxneedsnegativevskiptrue
3590 \def\item{\errmessage{@item while not in a list environment}}
3591 \def\itemx{\errmessage{@itemx while not in a list environment}}
3593 % @table, @ftable, @vtable.
3595 \let\itemindex\gobble
3599 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3600 \tablecheck{ftable}%
3603 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3604 \tablecheck{vtable}%
3607 \ifnum \the\catcode`\^^M=\active
3609 \errmessage{This command won't work in this context; perhaps the problem is
3610 that we are \inenvironment\thisenv}%
3611 \def\next{\doignore{#1}}%
3618 \def\itemindicate{#1}%
3623 \makevalueexpandable
3624 \edef\temp{\noexpand\tablez #1\space\space\space}%
3628 \def\tablez #1 #2 #3 #4\endtablez{%
3630 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3631 \ifnum 0#2>0 \tableindent=#2\mil \fi
3632 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3633 \itemmax=\tableindent
3634 \advance \itemmax by -\itemmargin
3635 \advance \leftskip by \tableindent
3636 \exdentamount=\tableindent
3638 \parskip = \smallskipamount
3639 \ifdim \parskip=0pt \parskip=2pt \fi
3640 \let\item = \internalBitem
3641 \let\itemx = \internalBitemx
3643 \def\Etable{\endgraf\afterenvbreak}
3646 \let\Eitemize\Etable
3647 \let\Eenumerate\Etable
3649 % This is the counter used by @enumerate, which is really @itemize
3653 \envdef\itemize{\parsearg\doitemize}
3657 \itemmax=\itemindent
3658 \advance\itemmax by -\itemmargin
3659 \advance\leftskip by \itemindent
3660 \exdentamount=\itemindent
3662 \parskip=\smallskipamount
3663 \ifdim\parskip=0pt \parskip=2pt \fi
3665 % Try typesetting the item mark that if the document erroneously says
3666 % something like @itemize @samp (intending @table), there's an error
3667 % right away at the @itemize. It's not the best error message in the
3668 % world, but it's better than leaving it to the @item. This means if
3669 % the user wants an empty mark, they have to say @w{} not just @w.
3670 \def\itemcontents{#1}%
3671 \setbox0 = \hbox{\itemcontents}%
3673 % @itemize with no arg is equivalent to @itemize @bullet.
3674 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3676 \let\item=\itemizeitem
3679 % Definition of @item while inside @itemize and @enumerate.
3682 \advance\itemno by 1 % for enumerations
3683 {\let\par=\endgraf \smallbreak}% reasonable place to break
3685 % If the document has an @itemize directly after a section title, a
3686 % \nobreak will be last on the list, and \sectionheading will have
3687 % done a \vskip-\parskip. In that case, we don't want to zero
3688 % parskip, or the item text will crash with the heading. On the
3689 % other hand, when there is normal text preceding the item (as there
3690 % usually is), we do want to zero parskip, or there would be too much
3691 % space. In that case, we won't have a \nobreak before. At least
3692 % that's the theory.
3693 \ifnum\lastpenalty<10000 \parskip=0in \fi
3695 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3697 \vadjust{\penalty 1200}}% not good to break after first line of item.
3701 % \splitoff TOKENS\endmark defines \first to be the first token in
3702 % TOKENS, and \rest to be the remainder.
3704 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3706 % Allow an optional argument of an uppercase letter, lowercase letter,
3707 % or number, to specify the first label in the enumerated list. No
3708 % argument is the same as `1'.
3710 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3711 \def\enumeratey #1 #2\endenumeratey{%
3712 % If we were given no argument, pretend we were given `1'.
3714 \ifx\thearg\empty \def\thearg{1}\fi
3716 % Detect if the argument is a single token. If so, it might be a
3717 % letter. Otherwise, the only valid thing it can be is a number.
3718 % (We will always have one token, because of the test we just made.
3719 % This is a good thing, since \splitoff doesn't work given nothing at
3720 % all -- the first parameter is undelimited.)
3721 \expandafter\splitoff\thearg\endmark
3723 % Only one token in the argument. It could still be anything.
3724 % A ``lowercase letter'' is one whose \lccode is nonzero.
3725 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3726 % not equal to itself.
3727 % Otherwise, we assume it's a number.
3729 % We need the \relax at the end of the \ifnum lines to stop TeX from
3730 % continuing to look for a <number>.
3732 \ifnum\lccode\expandafter`\thearg=0\relax
3733 \numericenumerate % a number (we hope)
3736 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3737 \lowercaseenumerate % lowercase letter
3739 \uppercaseenumerate % uppercase letter
3743 % Multiple tokens in the argument. We hope it's a number.
3748 % An @enumerate whose labels are integers. The starting integer is
3751 \def\numericenumerate{%
3753 \startenumeration{\the\itemno}%
3756 % The starting (lowercase) letter is in \thearg.
3757 \def\lowercaseenumerate{%
3758 \itemno = \expandafter`\thearg
3760 % Be sure we're not beyond the end of the alphabet.
3762 \errmessage{No more lowercase letters in @enumerate; get a bigger
3769 % The starting (uppercase) letter is in \thearg.
3770 \def\uppercaseenumerate{%
3771 \itemno = \expandafter`\thearg
3773 % Be sure we're not beyond the end of the alphabet.
3775 \errmessage{No more uppercase letters in @enumerate; get a bigger
3782 % Call \doitemize, adding a period to the first argument and supplying the
3783 % common last two arguments. Also subtract one from the initial value in
3784 % \itemno, since @item increments \itemno.
3786 \def\startenumeration#1{%
3787 \advance\itemno by -1
3788 \doitemize{#1.}\flushcr
3791 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3794 \def\alphaenumerate{\enumerate{a}}
3795 \def\capsenumerate{\enumerate{A}}
3796 \def\Ealphaenumerate{\Eenumerate}
3797 \def\Ecapsenumerate{\Eenumerate}
3800 % @multitable macros
3801 % Amy Hendrickson, 8/18/94, 3/6/96
3803 % @multitable ... @end multitable will make as many columns as desired.
3804 % Contents of each column will wrap at width given in preamble. Width
3805 % can be specified either with sample text given in a template line,
3806 % or in percent of \hsize, the current width of text on page.
3808 % Table can continue over pages but will only break between lines.
3812 % Either define widths of columns in terms of percent of \hsize:
3813 % @multitable @columnfractions .25 .3 .45
3816 % Numbers following @columnfractions are the percent of the total
3817 % current hsize to be used for each column. You may use as many
3818 % columns as desired.
3821 % Or use a template:
3822 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3824 % using the widest term desired in each column.
3826 % Each new table line starts with @item, each subsequent new column
3827 % starts with @tab. Empty columns may be produced by supplying @tab's
3828 % with nothing between them for as many times as empty columns are needed,
3829 % ie, @tab@tab@tab will produce two empty columns.
3831 % @item, @tab do not need to be on their own lines, but it will not hurt
3834 % Sample multitable:
3836 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3837 % @item first col stuff @tab second col stuff @tab third col
3844 % @item first col stuff @tab second col stuff
3845 % @tab Many paragraphs of text may be used in any column.
3847 % They will wrap at the width determined by the template.
3848 % @item@tab@tab This will be in third column.
3851 % Default dimensions may be reset by user.
3852 % @multitableparskip is vertical space between paragraphs in table.
3853 % @multitableparindent is paragraph indent in table.
3854 % @multitablecolmargin is horizontal space to be left between columns.
3855 % @multitablelinespace is space to leave between table items, baseline
3857 % 0pt means it depends on current normal line spacing.
3859 \newskip\multitableparskip
3860 \newskip\multitableparindent
3861 \newdimen\multitablecolspace
3862 \newskip\multitablelinespace
3863 \multitableparskip=0pt
3864 \multitableparindent=6pt
3865 \multitablecolspace=12pt
3866 \multitablelinespace=0pt
3868 % Macros used to set up halign preamble:
3870 \let\endsetuptable\relax
3871 \def\xendsetuptable{\endsetuptable}
3872 \let\columnfractions\relax
3873 \def\xcolumnfractions{\columnfractions}
3876 % #1 is the @columnfraction, usually a decimal number like .5, but might
3877 % be just 1. We just use it, whatever it is.
3879 \def\pickupwholefraction#1 {%
3880 \global\advance\colcount by 1
3881 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3888 \ifx\firstarg\xendsetuptable
3891 \ifx\firstarg\xcolumnfractions
3892 \global\setpercenttrue
3895 \let\go\pickupwholefraction
3897 \global\advance\colcount by 1
3898 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3899 % separator; typically that is always in the input, anyway.
3900 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3903 \ifx\go\pickupwholefraction
3904 % Put the argument back for the \pickupwholefraction call, so
3905 % we'll always have a period there to be parsed.
3906 \def\go{\pickupwholefraction#1}%
3908 \let\go = \setuptable
3914 % multitable-only commands.
3916 % @headitem starts a heading row, which we typeset in bold.
3917 % Assignments have to be global since we are inside the implicit group
3918 % of an alignment entry. \everycr resets \everytab so we don't have to
3919 % undo it ourselves.
3920 \def\headitemfont{\b}% for people to use in the template row; not changeable
3922 \checkenv\multitable
3924 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3925 \the\everytab % for the first item
3928 % A \tab used to include \hskip1sp. But then the space in a template
3929 % line is not enough. That is bad. So let's go back to just `&' until
3930 % we again encounter the problem the 1sp was intended to solve.
3931 % --karl, nathan@acm.org, 20apr99.
3932 \def\tab{\checkenv\multitable &\the\everytab}%
3934 % @multitable ... @end multitable definitions:
3936 \newtoks\everytab % insert after every tab.
3938 \envdef\multitable{%
3942 % @item within a multitable starts a normal row.
3943 % We use \def instead of \let so that if one of the multitable entries
3944 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3945 % \endtemplate) expanding \doitemize.
3950 \setmultitablespacing
3951 \parskip=\multitableparskip
3952 \parindent=\multitableparindent
3958 \global\everytab={}%
3959 \global\colcount=0 % Reset the column counter.
3960 % Check for saved footnotes, etc.
3962 % Keeps underfull box messages off when table breaks over pages.
3964 % Maybe so, but it also creates really weird page breaks when the
3965 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3966 % problem manifests itself, so it can be fixed for real --karl.
3970 \parsearg\domultitable
3972 \def\domultitable#1{%
3973 % To parse everything between @multitable and @item:
3974 \setuptable#1 \endsetuptable
3976 % This preamble sets up a generic column definition, which will
3977 % be used as many times as user calls for columns.
3978 % \vtop will set a single line and will also let text wrap and
3979 % continue for many paragraphs if desired.
3981 \global\advance\colcount by 1
3984 % Use the current \colcount to find the correct column width:
3985 \hsize=\expandafter\csname col\the\colcount\endcsname
3987 % In order to keep entries from bumping into each other
3988 % we will add a \leftskip of \multitablecolspace to all columns after
3991 % If a template has been used, we will add \multitablecolspace
3992 % to the width of each template entry.
3994 % If the user has set preamble in terms of percent of \hsize we will
3995 % use that dimension as the width of the column, and the \leftskip
3996 % will keep entries from bumping into each other. Table will start at
3997 % left margin and final column will justify at right margin.
3999 % Make sure we don't inherit \rightskip from the outer environment.
4002 % The first column will be indented with the surrounding text.
4003 \advance\hsize by\leftskip
4006 % If user has not set preamble in terms of percent of \hsize
4007 % we will advance \hsize by \multitablecolspace.
4008 \advance\hsize by \multitablecolspace
4010 % In either case we will make \leftskip=\multitablecolspace:
4011 \leftskip=\multitablecolspace
4013 % Ignoring space at the beginning and end avoids an occasional spurious
4014 % blank line, when TeX decides to break the line at the space before the
4015 % box from the multistrut, so the strut ends up on a line by itself.
4017 % @multitable @columnfractions .11 .89
4019 % @tab Legal holiday which is valid in major parts of the whole country.
4020 % Is automatically provided with highlighting sequences respectively
4021 % marking characters.
4022 \noindent\ignorespaces##\unskip\multistrut
4027 \egroup % end the \halign
4028 \global\setpercentfalse
4031 \def\setmultitablespacing{%
4032 \def\multistrut{\strut}% just use the standard line spacing
4034 % Compute \multitablelinespace (if not defined by user) for use in
4035 % \multitableparskip calculation. We used define \multistrut based on
4036 % this, but (ironically) that caused the spacing to be off.
4037 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4038 \ifdim\multitablelinespace=0pt
4039 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4040 \global\advance\multitablelinespace by-\ht0
4042 % Test to see if parskip is larger than space between lines of
4043 % table. If not, do nothing.
4044 % If so, set to same dimension as multitablelinespace.
4045 \ifdim\multitableparskip>\multitablelinespace
4046 \global\multitableparskip=\multitablelinespace
4047 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4048 % than skip between lines in the table.
4050 \ifdim\multitableparskip=0pt
4051 \global\multitableparskip=\multitablelinespace
4052 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4053 % than skip between lines in the table.
4057 \message{conditionals,}
4059 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4060 % @ifnotxml always succeed. They currently do nothing; we don't
4061 % attempt to check whether the conditionals are properly nested. But we
4062 % have to remember that they are conditionals, so that @end doesn't
4063 % attempt to close an environment group.
4066 \expandafter\let\csname #1\endcsname = \relax
4067 \expandafter\let\csname iscond.#1\endcsname = 1
4070 \makecond{ifnotdocbook}
4071 \makecond{ifnothtml}
4072 \makecond{ifnotinfo}
4073 \makecond{ifnotplaintext}
4076 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4078 \def\direntry{\doignore{direntry}}
4079 \def\documentdescription{\doignore{documentdescription}}
4080 \def\docbook{\doignore{docbook}}
4081 \def\html{\doignore{html}}
4082 \def\ifdocbook{\doignore{ifdocbook}}
4083 \def\ifhtml{\doignore{ifhtml}}
4084 \def\ifinfo{\doignore{ifinfo}}
4085 \def\ifnottex{\doignore{ifnottex}}
4086 \def\ifplaintext{\doignore{ifplaintext}}
4087 \def\ifxml{\doignore{ifxml}}
4088 \def\ignore{\doignore{ignore}}
4089 \def\menu{\doignore{menu}}
4090 \def\xml{\doignore{xml}}
4092 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4094 % A count to remember the depth of nesting.
4095 \newcount\doignorecount
4097 \def\doignore#1{\begingroup
4098 % Scan in ``verbatim'' mode:
4100 \catcode`\@ = \other
4101 \catcode`\{ = \other
4102 \catcode`\} = \other
4104 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4107 % Count number of #1's that we've seen.
4110 % Swallow text until we reach the matching `@end #1'.
4114 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4117 \gdef\dodoignore#1{%
4118 % #1 contains the command name as a string, e.g., `ifinfo'.
4120 % Define a command to find the next `@end #1'.
4121 \long\def\doignoretext##1^^M@end #1{%
4122 \doignoretextyyy##1^^M@#1\_STOP_}%
4124 % And this command to find another #1 command, at the beginning of a
4125 % line. (Otherwise, we would consider a line `@c @ifset', for
4126 % example, to count as an @ifset for nesting.)
4127 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4129 % And now expand that command.
4134 \def\doignoreyyy#1{%
4136 \ifx\temp\empty % Nothing found.
4137 \let\next\doignoretextzzz
4138 \else % Found a nested condition, ...
4139 \advance\doignorecount by 1
4140 \let\next\doignoretextyyy % ..., look for another.
4141 % If we're here, #1 ends with ^^M\ifinfo (for example).
4143 \next #1% the token \_STOP_ is present just after this macro.
4146 % We have to swallow the remaining "\_STOP_".
4148 \def\doignoretextzzz#1{%
4149 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4150 \let\next\enddoignore
4151 \else % Still inside a nested condition.
4152 \advance\doignorecount by -1
4153 \let\next\doignoretext % Look for the next @end.
4158 % Finish off ignored text.
4160 % Ignore anything after the last `@end #1'; this matters in verbatim
4161 % environments, where otherwise the newline after an ignored conditional
4162 % would result in a blank line in the output.
4163 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4167 % @set VAR sets the variable VAR to an empty value.
4168 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4170 % Since we want to separate VAR from REST-OF-LINE (which might be
4171 % empty), we can't just use \parsearg; we have to insert a space of our
4172 % own to delimit the rest of the line, and then take it out again if we
4174 % We rely on the fact that \parsearg sets \catcode`\ =10.
4176 \parseargdef\set{\setyyy#1 \endsetyyy}
4177 \def\setyyy#1 #2\endsetyyy{%
4179 \makevalueexpandable
4181 \edef\next{\gdef\makecsname{SET#1}}%
4189 % Remove the trailing space \setxxx inserted.
4190 \def\setzzz#1 \endsetzzz{\next{#1}}
4192 % @clear VAR clears (i.e., unsets) the variable VAR.
4194 \parseargdef\clear{%
4196 \makevalueexpandable
4197 \global\expandafter\let\csname SET#1\endcsname=\relax
4201 % @value{foo} gets the text saved in variable foo.
4202 \def\value{\begingroup\makevalueexpandable\valuexxx}
4203 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4205 \catcode`\- = \active \catcode`\_ = \active
4207 \gdef\makevalueexpandable{%
4208 \let\value = \expandablevalue
4209 % We don't want these characters active, ...
4210 \catcode`\-=\other \catcode`\_=\other
4211 % ..., but we might end up with active ones in the argument if
4212 % we're called from @code, as @code{@value{foo-bar_}}, though.
4213 % So \let them to their normal equivalents.
4214 \let-\normaldash \let_\normalunderscore
4218 % We have this subroutine so that we can handle at least some @value's
4219 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4220 % The command has to be fully expandable (if the variable is set), since
4221 % the result winds up in the index file. This means that if the
4222 % variable's value contains other Texinfo commands, it's almost certain
4223 % it will fail (although perhaps we could fix that with sufficient work
4224 % to do a one-level expansion on the result, instead of complete).
4226 \def\expandablevalue#1{%
4227 \expandafter\ifx\csname SET#1\endcsname\relax
4228 {[No value for ``#1'']}%
4229 \message{Variable `#1', used in @value, is not set.}%
4231 \csname SET#1\endcsname
4235 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4238 % To get the special treatment we need for `@end ifset,' we call
4239 % \makecond and then redefine.
4242 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4245 \makevalueexpandable
4247 \expandafter\ifx\csname SET#2\endcsname\relax
4248 #1% If not set, redefine \next.
4253 \def\ifsetfail{\doignore{ifset}}
4255 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4256 % defined with @set, or has been undefined with @clear.
4258 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4259 % above code: if the variable is not set, do nothing, if it is set,
4260 % then redefine \next to \ifclearfail.
4263 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4264 \def\ifclearfail{\doignore{ifclear}}
4266 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4267 % without the @) is in fact defined. We can only feasibly check at the
4268 % TeX level, so something like `mathcode' is going to considered
4269 % defined even though it is not a Texinfo command.
4271 \makecond{ifcommanddefined}
4272 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4274 \def\doifcmddefined#1#2{{%
4275 \makevalueexpandable
4277 \expandafter\ifx\csname #2\endcsname\relax
4278 #1% If not defined, \let\next as above.
4283 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4285 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4286 \makecond{ifcommandnotdefined}
4287 \def\ifcommandnotdefined{%
4288 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4289 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4291 % Set the `txicommandconditionals' variable, so documents have a way to
4292 % test if the @ifcommand...defined conditionals are available.
4293 \set txicommandconditionals
4295 % @dircategory CATEGORY -- specify a category of the dir file
4296 % which this file should belong to. Ignore this in TeX.
4297 \let\dircategory=\comment
4299 % @defininfoenclose.
4300 \let\definfoenclose=\comment
4304 % Index generation facilities
4306 % Define \newwrite to be identical to plain tex's \newwrite
4307 % except not \outer, so it can be used within macros and \if's.
4308 \edef\newwrite{\makecsname{ptexnewwrite}}
4310 % \newindex {foo} defines an index named foo.
4311 % It automatically defines \fooindex such that
4312 % \fooindex ...rest of line... puts an entry in the index foo.
4313 % It also defines \fooindfile to be the number of the output channel for
4314 % the file that accumulates this index. The file's extension is foo.
4315 % The name of an index should be no more than 2 characters long
4316 % for the sake of vms.
4320 \expandafter\newwrite \csname#1indfile\endcsname
4321 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4323 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4324 \noexpand\doindex{#1}}
4327 % @defindex foo == \newindex{foo}
4329 \def\defindex{\parsearg\newindex}
4331 % Define @defcodeindex, like @defindex except put all entries in @code.
4333 \def\defcodeindex{\parsearg\newcodeindex}
4335 \def\newcodeindex#1{%
4337 \expandafter\newwrite \csname#1indfile\endcsname
4338 \openout \csname#1indfile\endcsname \jobname.#1
4340 \expandafter\xdef\csname#1index\endcsname{%
4341 \noexpand\docodeindex{#1}}%
4345 % @synindex foo bar makes index foo feed into index bar.
4346 % Do this instead of @defindex foo if you don't want it as a separate index.
4348 % @syncodeindex foo bar similar, but put all entries made for index foo
4351 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4352 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4354 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4355 % #3 the target index (bar).
4356 \def\dosynindex#1#2#3{%
4357 % Only do \closeout if we haven't already done it, else we'll end up
4358 % closing the target index.
4359 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4360 % The \closeout helps reduce unnecessary open files; the limit on the
4361 % Acorn RISC OS is a mere 16 files.
4362 \expandafter\closeout\csname#2indfile\endcsname
4363 \expandafter\let\csname donesynindex#2\endcsname = 1
4365 % redefine \fooindfile:
4366 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4367 \expandafter\let\csname#2indfile\endcsname=\temp
4368 % redefine \fooindex:
4369 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4372 % Define \doindex, the driver for all \fooindex macros.
4373 % Argument #1 is generated by the calling \fooindex macro,
4374 % and it is "foo", the name of the index.
4376 % \doindex just uses \parsearg; it calls \doind for the actual work.
4377 % This is because \doind is more useful to call from other macros.
4379 % There is also \dosubind {index}{topic}{subtopic}
4380 % which makes an entry in a two-level index such as the operation index.
4382 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4383 \def\singleindexer #1{\doind{\indexname}{#1}}
4385 % like the previous two, but they put @code around the argument.
4386 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4387 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4389 % Take care of Texinfo commands that can appear in an index entry.
4390 % Since there are some commands we want to expand, and others we don't,
4391 % we have to laboriously prevent expansion for those that we don't.
4394 \escapechar = `\\ % use backslash in output files.
4395 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4396 \def\ {\realbackslash\space }%
4398 % Need these unexpandable (because we define \tt as a dummy)
4399 % definitions when @{ or @} appear in index entry text. Also, more
4400 % complicated, when \tex is in effect and \{ is a \delimiter again.
4401 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4402 % braces and backslashes are used only as delimiters. Perhaps we
4403 % should define @lbrace and @rbrace commands a la @comma.
4404 \def\{{{\tt\char123}}%
4405 \def\}{{\tt\char125}}%
4407 % I don't entirely understand this, but when an index entry is
4408 % generated from a macro call, the \endinput which \scanmacro inserts
4409 % causes processing to be prematurely terminated. This is,
4410 % apparently, because \indexsorttmp is fully expanded, and \endinput
4411 % is an expandable command. The redefinition below makes \endinput
4412 % disappear altogether for that purpose -- although logging shows that
4413 % processing continues to some further point. On the other hand, it
4414 % seems \endinput does not hurt in the printed index arg, since that
4415 % is still getting written without apparent harm.
4417 % Sample source (mac-idx3.tex, reported by Graham Percival to
4418 % help-texinfo, 22may06):
4419 % @macro funindex {WORD}
4423 % @funindex commtest
4425 % The above is not enough to reproduce the bug, but it gives the flavor.
4427 % Sample whatsit resulting:
4428 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4431 \let\endinput = \empty
4433 % Do the redefinitions.
4437 % For the aux and toc files, @ is the escape character. So we want to
4438 % redefine everything using @ as the escape character (instead of
4439 % \realbackslash, still used for index files). When everything uses @,
4440 % this will be simpler.
4445 \let\{ = \lbraceatcmd
4446 \let\} = \rbraceatcmd
4448 % Do the redefinitions.
4453 % Called from \indexdummies and \atdummies.
4455 \def\commondummies{%
4457 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4458 % preventing its expansion. This is used only for control words,
4459 % not control letters, because the \space would be incorrect for
4460 % control characters, but is needed to separate the control word
4461 % from whatever follows.
4463 % For control letters, we have \definedummyletter, which omits the
4466 % These can be used both for control words that take an argument and
4467 % those that do not. If it is followed by {arg} in the input, then
4468 % that will dutifully get written to the index (or wherever).
4470 \def\definedummyword ##1{\def##1{\string##1\space}}%
4471 \def\definedummyletter##1{\def##1{\string##1}}%
4472 \let\definedummyaccent\definedummyletter
4474 \commondummiesnofonts
4476 \definedummyletter\_%
4477 \definedummyletter\-%
4479 % Non-English letters.
4490 \definedummyword\exclamdown
4494 \definedummyword\ordf
4495 \definedummyword\ordm
4496 \definedummyword\questiondown
4500 % Although these internal commands shouldn't show up, sometimes they do.
4502 \definedummyword\gtr
4503 \definedummyword\hat
4504 \definedummyword\less
4507 \definedummyword\tclose
4510 \definedummyword\LaTeX
4511 \definedummyword\TeX
4513 % Assorted special characters.
4514 \definedummyword\arrow
4515 \definedummyword\bullet
4516 \definedummyword\comma
4517 \definedummyword\copyright
4518 \definedummyword\registeredsymbol
4519 \definedummyword\dots
4520 \definedummyword\enddots
4521 \definedummyword\entrybreak
4522 \definedummyword\equiv
4523 \definedummyword\error
4524 \definedummyword\euro
4525 \definedummyword\expansion
4526 \definedummyword\geq
4527 \definedummyword\guillemetleft
4528 \definedummyword\guillemetright
4529 \definedummyword\guilsinglleft
4530 \definedummyword\guilsinglright
4531 \definedummyword\lbracechar
4532 \definedummyword\leq
4533 \definedummyword\minus
4534 \definedummyword\ogonek
4535 \definedummyword\pounds
4536 \definedummyword\point
4537 \definedummyword\print
4538 \definedummyword\quotedblbase
4539 \definedummyword\quotedblleft
4540 \definedummyword\quotedblright
4541 \definedummyword\quoteleft
4542 \definedummyword\quoteright
4543 \definedummyword\quotesinglbase
4544 \definedummyword\rbracechar
4545 \definedummyword\result
4546 \definedummyword\textdegree
4548 % We want to disable all macros so that they are not expanded by \write.
4551 \normalturnoffactive
4553 % Handle some cases of @value -- where it does not contain any
4554 % (non-fully-expandable) commands.
4555 \makevalueexpandable
4558 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4560 \def\commondummiesnofonts{%
4561 % Control letters and accents.
4562 \definedummyletter\!%
4563 \definedummyaccent\"%
4564 \definedummyaccent\'%
4565 \definedummyletter\*%
4566 \definedummyaccent\,%
4567 \definedummyletter\.%
4568 \definedummyletter\/%
4569 \definedummyletter\:%
4570 \definedummyaccent\=%
4571 \definedummyletter\?%
4572 \definedummyaccent\^%
4573 \definedummyaccent\`%
4574 \definedummyaccent\~%
4578 \definedummyword\dotaccent
4579 \definedummyword\ogonek
4580 \definedummyword\ringaccent
4581 \definedummyword\tieaccent
4582 \definedummyword\ubaraccent
4583 \definedummyword\udotaccent
4584 \definedummyword\dotless
4586 % Texinfo font commands.
4590 \definedummyword\sansserif
4592 \definedummyword\slanted
4595 % Commands that take arguments.
4596 \definedummyword\abbr
4597 \definedummyword\acronym
4598 \definedummyword\anchor
4599 \definedummyword\cite
4600 \definedummyword\code
4601 \definedummyword\command
4602 \definedummyword\dfn
4603 \definedummyword\dmn
4604 \definedummyword\email
4605 \definedummyword\emph
4606 \definedummyword\env
4607 \definedummyword\file
4608 \definedummyword\image
4609 \definedummyword\indicateurl
4610 \definedummyword\inforef
4611 \definedummyword\kbd
4612 \definedummyword\key
4613 \definedummyword\math
4614 \definedummyword\option
4615 \definedummyword\pxref
4616 \definedummyword\ref
4617 \definedummyword\samp
4618 \definedummyword\strong
4619 \definedummyword\tie
4620 \definedummyword\uref
4621 \definedummyword\url
4622 \definedummyword\var
4623 \definedummyword\verb
4625 \definedummyword\xref
4628 % \indexnofonts is used when outputting the strings to sort the index
4629 % by, and when constructing control sequence names. It eliminates all
4630 % control sequences and just writes whatever the best ASCII sort string
4631 % would be for a given command (usually its argument).
4634 % Accent commands should become @asis.
4635 \def\definedummyaccent##1{\let##1\asis}%
4636 % We can just ignore other control letters.
4637 \def\definedummyletter##1{\let##1\empty}%
4638 % All control words become @asis by default; overrides below.
4639 \let\definedummyword\definedummyaccent
4641 \commondummiesnofonts
4643 % Don't no-op \tt, since it isn't a user-level command
4644 % and is used in the definitions of the active chars like <, >, |, etc.
4645 % Likewise with the other plain tex font commands.
4650 \def\_{\normalunderscore}%
4651 \def\-{}% @- shouldn't affect sorting
4653 % Unfortunately, texindex is not prepared to handle braces in the
4654 % content at all. So for index sorting, we map @{ and @} to strings
4655 % starting with |, since that ASCII character is between ASCII { and }.
4657 \def\lbracechar{|a}%
4660 \def\rbracechar{|b}%
4662 % Non-English letters.
4679 \def\questiondown{?}%
4686 % Assorted special characters.
4687 % (The following {} will end up in the sort string, but that's ok.)
4689 \def\bullet{bullet}%
4691 \def\copyright{copyright}%
4697 \def\expansion{==>}%
4699 \def\guillemetleft{<<}%
4700 \def\guillemetright{>>}%
4701 \def\guilsinglleft{<}%
4702 \def\guilsinglright{>}%
4706 \def\pounds{pounds}%
4708 \def\quotedblbase{"}%
4709 \def\quotedblleft{"}%
4710 \def\quotedblright{"}%
4713 \def\quotesinglbase{,}%
4714 \def\registeredsymbol{R}%
4718 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4719 \else \indexlquoteignore \fi
4721 % We need to get rid of all macros, leaving only the arguments (if present).
4722 % Of course this is not nearly correct, but it is the best we can do for now.
4723 % makeinfo does not expand macros in the argument to @deffn, which ends up
4724 % writing an index entry, and texindex isn't prepared for an index sort entry
4725 % that starts with \.
4727 % Since macro invocations are followed by braces, we can just redefine them
4728 % to take a single TeX argument. The case of a macro invocation that
4729 % goes to end-of-line is not handled.
4734 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4735 % ignore left quotes in the sort term.
4736 {\catcode`\`=\active
4737 \gdef\indexlquoteignore{\let`=\empty}}
4739 \let\indexbackslash=0 %overridden during \printindex.
4740 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4742 % Most index entries go through here, but \dosubind is the general case.
4743 % #1 is the index name, #2 is the entry text.
4744 \def\doind#1#2{\dosubind{#1}{#2}{}}
4746 % Workhorse for all \fooindexes.
4747 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4748 % empty if called from \doind, as we usually are (the main exception
4749 % is with most defuns, which call us directly).
4751 \def\dosubind#1#2#3{%
4754 % Store the main index entry text (including the third arg).
4756 % If third arg is present, precede it with a space.
4758 \ifx\thirdarg\empty \else
4759 \toks0 = \expandafter{\the\toks0 \space #3}%
4762 \edef\writeto{\csname#1indfile\endcsname}%
4764 \safewhatsit\dosubindwrite
4769 % Write the entry in \toks0 to the index file:
4771 \def\dosubindwrite{%
4772 % Put the index entry in the margin if desired.
4773 \ifx\SETmarginindex\relax\else
4774 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4777 % Remember, we are within a group.
4778 \indexdummies % Must do this here, since \bf, etc expand at this stage
4779 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4780 % so it will be output as is; and it will print as backslash.
4782 % Process the index entry with all font commands turned off, to
4783 % get the string to sort by.
4785 \edef\temp{\the\toks0}% need full expansion
4786 \xdef\indexsorttmp{\temp}%
4789 % Set up the complete index entry, with both the sort key and
4790 % the original text, including any font commands. We write
4791 % three arguments to \entry to the .?? file (four in the
4792 % subentry case), texindex reduces to two when writing the .??s
4796 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4801 % Take care of unwanted page breaks/skips around a whatsit:
4803 % If a skip is the last thing on the list now, preserve it
4804 % by backing up by \lastskip, doing the \write, then inserting
4805 % the skip again. Otherwise, the whatsit generated by the
4806 % \write or \pdfdest will make \lastskip zero. The result is that
4807 % sequences like this:
4811 % will have extra space inserted, because the \medbreak in the
4812 % start of the @defun won't see the skip inserted by the @end of
4813 % the previous defun.
4815 % But don't do any of this if we're not in vertical mode. We
4816 % don't want to do a \vskip and prematurely end a paragraph.
4818 % Avoid page breaks due to these extra skips, too.
4820 % But wait, there is a catch there:
4821 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4822 % sufficient for this purpose, as it ignores stretch and shrink parts
4823 % of the skip. The only way seems to be to check the textual
4824 % representation of the skip.
4826 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4827 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4829 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4831 \newskip\whatsitskip
4832 \newcount\whatsitpenalty
4836 \def\safewhatsit#1{\ifhmode
4839 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4840 \whatsitskip = \lastskip
4841 \edef\lastskipmacro{\the\lastskip}%
4842 \whatsitpenalty = \lastpenalty
4844 % If \lastskip is nonzero, that means the last item was a
4845 % skip. And since a skip is discardable, that means this
4846 % -\whatsitskip glue we're inserting is preceded by a
4847 % non-discardable item, therefore it is not a potential
4848 % breakpoint, therefore no \nobreak needed.
4849 \ifx\lastskipmacro\zeroskipmacro
4856 \ifx\lastskipmacro\zeroskipmacro
4857 % If \lastskip was zero, perhaps the last item was a penalty, and
4858 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4859 % to re-insert the same penalty (values >10000 are used for various
4860 % signals); since we just inserted a non-discardable item, any
4861 % following glue (such as a \parskip) would be a breakpoint. For example:
4862 % @deffn deffn-whatever
4863 % @vindex index-whatever
4865 % would allow a break between the index-whatever whatsit
4866 % and the "Description." paragraph.
4867 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4869 % On the other hand, if we had a nonzero \lastskip,
4870 % this make-up glue would be preceded by a non-discardable item
4871 % (the whatsit from the \write), so we must insert a \nobreak.
4872 \nobreak\vskip\whatsitskip
4876 % The index entry written in the file actually looks like
4877 % \entry {sortstring}{page}{topic}
4879 % \entry {sortstring}{page}{topic}{subtopic}
4880 % The texindex program reads in these files and writes files
4881 % containing these kinds of lines:
4883 % before the first topic whose initial is c
4884 % \entry {topic}{pagelist}
4885 % for a topic that is used without subtopics
4887 % for the beginning of a topic that is used with subtopics
4888 % \secondary {subtopic}{pagelist}
4889 % for each subtopic.
4891 % Define the user-accessible indexing commands
4892 % @findex, @vindex, @kindex, @cindex.
4894 \def\findex {\fnindex}
4895 \def\kindex {\kyindex}
4896 \def\cindex {\cpindex}
4897 \def\vindex {\vrindex}
4898 \def\tindex {\tpindex}
4899 \def\pindex {\pgindex}
4901 \def\cindexsub {\begingroup\obeylines\cindexsub}
4903 \gdef\cindexsub "#1" #2^^M{\endgroup %
4904 \dosubind{cp}{#2}{#1}}}
4906 % Define the macros used in formatting output of the sorted index material.
4908 % @printindex causes a particular index (the ??s file) to get printed.
4909 % It does not print any chapter heading (usually an @unnumbered).
4911 \parseargdef\printindex{\begingroup
4912 \dobreak \chapheadingskip{10000}%
4917 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4919 % See if the index file exists and is nonempty.
4920 % Change catcode of @ here so that if the index file contains
4922 % as its first line, TeX doesn't complain about mismatched braces
4923 % (because it thinks @} is a control sequence).
4925 \openin 1 \jobname.#1s
4927 % \enddoublecolumns gets confused if there is no text in the index,
4928 % and it loses the chapter title and the aux file entries for the
4929 % index. The easiest way to prevent this problem is to make sure
4930 % there is some text.
4931 \putwordIndexNonexistent
4934 % If the index file exists but is empty, then \openin leaves \ifeof
4935 % false. We have to make TeX try to read something from the file, so
4936 % it can discover if there is anything in it.
4939 \putwordIndexIsEmpty
4941 % Index files are almost Texinfo source, but we use \ as the escape
4942 % character. It would be better to use @, but that's too big a change
4943 % to make right now.
4944 \def\indexbackslash{\backslashcurfont}%
4955 % These macros are used by the sorted index file itself.
4956 % Change them to control the appearance of the index.
4959 % Some minor font changes for the special characters.
4960 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4962 % Remove any glue we may have, we'll be inserting our own.
4965 % We like breaks before the index initials, so insert a bonus.
4967 \vskip 0pt plus 3\baselineskip
4969 \vskip 0pt plus -3\baselineskip
4971 % Typeset the initial. Making this add up to a whole number of
4972 % baselineskips increases the chance of the dots lining up from column
4973 % to column. It still won't often be perfect, because of the stretch
4974 % we need before each entry, but it's better.
4976 % No shrink because it confuses \balancecolumns.
4977 \vskip 1.67\baselineskip plus .5\baselineskip
4978 \leftline{\secbf #1}%
4979 % Do our best not to break after the initial.
4981 \vskip .33\baselineskip plus .1\baselineskip
4984 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4985 % then page number (#2) flushed to the right margin. It is used for index
4986 % and table of contents entries. The paragraph is indented by \leftskip.
4988 % A straightforward implementation would start like this:
4989 % \def\entry#1#2{...
4990 % But this freezes the catcodes in the argument, and can cause problems to
4991 % @code, which sets - active. This problem was fixed by a kludge---
4992 % ``-'' was active throughout whole index, but this isn't really right.
4993 % The right solution is to prevent \entry from swallowing the whole text.
4998 % Start a new paragraph if necessary, so our assignments below can't
4999 % affect previous text.
5002 % Do not fill out the last line with white space.
5005 % No extra space above this paragraph.
5008 % Do not prefer a separate line ending with a hyphen to fewer lines.
5009 \finalhyphendemerits = 0
5011 % \hangindent is only relevant when the entry text and page number
5012 % don't both fit on one line. In that case, bob suggests starting the
5013 % dots pretty far over on the line. Unfortunately, a large
5014 % indentation looks wrong when the entry text itself is broken across
5015 % lines. So we use a small indentation and put up with long leaders.
5017 % \hangafter is reset to 1 (which is the value we want) at the start
5018 % of each paragraph, so we need not do anything with that.
5021 % When the entry text needs to be broken, just fill out the first line
5023 \rightskip = 0pt plus1fil
5025 % A bit of stretch before each entry for the benefit of balancing
5029 % When reading the text of entry, convert explicit line breaks
5030 % from @* into spaces. The user might give these in long section
5031 % titles, for instance.
5032 \def\*{\unskip\space\ignorespaces}%
5033 \def\entrybreak{\hfil\break}%
5035 % Swallow the left brace of the text (first parameter):
5036 \afterassignment\doentry
5039 \def\entrybreak{\unskip\space\ignorespaces}%
5041 \bgroup % Instead of the swallowed brace.
5043 \aftergroup\finishentry
5044 % And now comes the text of the entry.
5046 \def\finishentry#1{%
5047 % #1 is the page number.
5049 % The following is kludged to not output a line of dots in the index if
5050 % there are no page numbers. The next person who breaks this will be
5051 % cursed by a Unix daemon.
5052 \setbox\boxA = \hbox{#1}%
5053 \ifdim\wd\boxA = 0pt
5057 % If we must, put the page number on a line of its own, and fill out
5058 % this line with blank space. (The \hfil is overwhelmed with the
5059 % fill leaders glue in \indexdotfill if the page number does fit.)
5061 \null\nobreak\indexdotfill % Have leaders before the page number.
5063 % The `\ ' here is removed by the implicit \unskip that TeX does as
5064 % part of (the primitive) \par. Without it, a spurious underfull
5077 % Like plain.tex's \dotfill, except uses up at least 1 em.
5078 \def\indexdotfill{\cleaders
5079 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5081 \def\primary #1{\line{#1\hfil}}
5083 \newskip\secondaryindent \secondaryindent=0.5cm
5084 \def\secondary#1#2{{%
5089 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5091 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5098 % Define two-column mode, which we use to typeset indexes.
5099 % Adapted from the TeXbook, page 416, which is to say,
5100 % the manmac.tex format used to print the TeXbook itself.
5104 \newdimen\doublecolumnhsize
5106 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5107 % Grab any single-column material above us.
5110 % Here is a possibility not foreseen in manmac: if we accumulate a
5111 % whole lot of material, we might end up calling this \output
5112 % routine twice in a row (see the doublecol-lose test, which is
5113 % essentially a couple of indexes with @setchapternewpage off). In
5114 % that case we just ship out what is in \partialpage with the normal
5115 % output routine. Generally, \partialpage will be empty when this
5116 % runs and this will be a no-op. See the indexspread.tex test case.
5117 \ifvoid\partialpage \else
5118 \onepageout{\pagecontents\partialpage}%
5121 \global\setbox\partialpage = \vbox{%
5122 % Unvbox the main output page.
5124 \kern-\topskip \kern\baselineskip
5127 \eject % run that output routine to set \partialpage
5129 % Use the double-column output routine for subsequent pages.
5130 \output = {\doublecolumnout}%
5132 % Change the page size parameters. We could do this once outside this
5133 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5134 % format, but then we repeat the same computation. Repeating a couple
5135 % of assignments once per index is clearly meaningless for the
5136 % execution time, so we may as well do it in one place.
5138 % First we halve the line length, less a little for the gutter between
5139 % the columns. We compute the gutter based on the line length, so it
5140 % changes automatically with the paper format. The magic constant
5141 % below is chosen so that the gutter has the same value (well, +-<1pt)
5142 % as it did when we hard-coded it.
5144 % We put the result in a separate register, \doublecolumhsize, so we
5145 % can restore it in \pagesofar, after \hsize itself has (potentially)
5148 \doublecolumnhsize = \hsize
5149 \advance\doublecolumnhsize by -.04154\hsize
5150 \divide\doublecolumnhsize by 2
5151 \hsize = \doublecolumnhsize
5153 % Double the \vsize as well. (We don't need a separate register here,
5154 % since nobody clobbers \vsize.)
5158 % The double-column output routine for all double-column pages except
5161 \def\doublecolumnout{%
5162 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5163 % Get the available space for the double columns -- the normal
5164 % (undoubled) page height minus any material left over from the
5168 \advance\dimen@ by -\ht\partialpage
5170 % box0 will be the left-hand column, box2 the right.
5171 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5172 \onepageout\pagesofar
5174 \penalty\outputpenalty
5177 % Re-output the contents of the output page -- any previous material,
5178 % followed by the two boxes we just split, in box0 and box2.
5182 \hsize = \doublecolumnhsize
5183 \wd0=\hsize \wd2=\hsize
5184 \hbox to\pagewidth{\box0\hfil\box2}%
5187 % All done with double columns.
5188 \def\enddoublecolumns{%
5189 % The following penalty ensures that the page builder is exercised
5190 % _before_ we change the output routine. This is necessary in the
5191 % following situation:
5193 % The last section of the index consists only of a single entry.
5194 % Before this section, \pagetotal is less than \pagegoal, so no
5195 % break occurs before the last section starts. However, the last
5196 % section, consisting of \initial and the single \entry, does not
5197 % fit on the page and has to be broken off. Without the following
5198 % penalty the page builder will not be exercised until \eject
5199 % below, and by that time we'll already have changed the output
5200 % routine to the \balancecolumns version, so the next-to-last
5201 % double-column page will be processed with \balancecolumns, which
5202 % is wrong: The two columns will go to the main vertical list, with
5203 % the broken-off section in the recent contributions. As soon as
5204 % the output routine finishes, TeX starts reconsidering the page
5205 % break. The two columns and the broken-off section both fit on the
5206 % page, because the two columns now take up only half of the page
5207 % goal. When TeX sees \eject from below which follows the final
5208 % section, it invokes the new output routine that we've set after
5209 % \balancecolumns below; \onepageout will try to fit the two columns
5210 % and the final section into the vbox of \pageheight (see
5211 % \pagebody), causing an overfull box.
5213 % Note that glue won't work here, because glue does not exercise the
5214 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5218 % Split the last of the double-column material. Leave it on the
5219 % current page, no automatic page break.
5222 % If we end up splitting too much material for the current page,
5223 % though, there will be another page break right after this \output
5224 % invocation ends. Having called \balancecolumns once, we do not
5225 % want to call it again. Therefore, reset \output to its normal
5226 % definition right away. (We hope \balancecolumns will never be
5227 % called on to balance too much material, but if it is, this makes
5228 % the output somewhat more palatable.)
5229 \global\output = {\onepageout{\pagecontents\PAGE}}%
5232 \endgroup % started in \begindoublecolumns
5234 % \pagegoal was set to the doubled \vsize above, since we restarted
5235 % the current page. We're now back to normal single-column
5236 % typesetting, so reset \pagegoal to the normal \vsize (after the
5237 % \endgroup where \vsize got restored).
5241 % Called at the end of the double column material.
5242 \def\balancecolumns{%
5243 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5245 \advance\dimen@ by \topskip
5246 \advance\dimen@ by-\baselineskip
5247 \divide\dimen@ by 2 % target to split to
5248 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5249 \splittopskip = \topskip
5250 % Loop until we get a decent breakpoint.
5254 \global\setbox3 = \copy0
5255 \global\setbox1 = \vsplit3 to \dimen@
5257 \global\advance\dimen@ by 1pt
5260 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5261 \setbox0=\vbox to\dimen@{\unvbox1}%
5262 \setbox2=\vbox to\dimen@{\unvbox3}%
5266 \catcode`\@ = \other
5269 \message{sectioning,}
5270 % Chapters, sections, etc.
5272 % Let's start with @part.
5273 \outer\parseargdef\part{\partzzz{#1}}
5277 \vskip.3\vsize % move it down on the page a bit
5279 \noindent \titlefonts\rmisbold #1\par % the text
5280 \let\lastnode=\empty % no node to associate with
5281 \writetocentry{part}{#1}{}% but put it in the toc
5282 \headingsoff % no headline or footline on the part page
5287 % \unnumberedno is an oxymoron. But we count the unnumbered
5288 % sections so that we can refer to them unambiguously in the pdf
5289 % outlines by their "section number". We avoid collisions with chapter
5290 % numbers by starting them at 10000. (If a document ever has 10000
5291 % chapters, we're in trouble anyway, I'm sure.)
5292 \newcount\unnumberedno \unnumberedno = 10000
5294 \newcount\secno \secno=0
5295 \newcount\subsecno \subsecno=0
5296 \newcount\subsubsecno \subsubsecno=0
5298 % This counter is funny since it counts through charcodes of letters A, B, ...
5299 \newcount\appendixno \appendixno = `\@
5301 % \def\appendixletter{\char\the\appendixno}
5302 % We do the following ugly conditional instead of the above simple
5303 % construct for the sake of pdftex, which needs the actual
5304 % letter in the expansion, not just typeset.
5306 \def\appendixletter{%
5307 \ifnum\appendixno=`A A%
5308 \else\ifnum\appendixno=`B B%
5309 \else\ifnum\appendixno=`C C%
5310 \else\ifnum\appendixno=`D D%
5311 \else\ifnum\appendixno=`E E%
5312 \else\ifnum\appendixno=`F F%
5313 \else\ifnum\appendixno=`G G%
5314 \else\ifnum\appendixno=`H H%
5315 \else\ifnum\appendixno=`I I%
5316 \else\ifnum\appendixno=`J J%
5317 \else\ifnum\appendixno=`K K%
5318 \else\ifnum\appendixno=`L L%
5319 \else\ifnum\appendixno=`M M%
5320 \else\ifnum\appendixno=`N N%
5321 \else\ifnum\appendixno=`O O%
5322 \else\ifnum\appendixno=`P P%
5323 \else\ifnum\appendixno=`Q Q%
5324 \else\ifnum\appendixno=`R R%
5325 \else\ifnum\appendixno=`S S%
5326 \else\ifnum\appendixno=`T T%
5327 \else\ifnum\appendixno=`U U%
5328 \else\ifnum\appendixno=`V V%
5329 \else\ifnum\appendixno=`W W%
5330 \else\ifnum\appendixno=`X X%
5331 \else\ifnum\appendixno=`Y Y%
5332 \else\ifnum\appendixno=`Z Z%
5333 % The \the is necessary, despite appearances, because \appendixletter is
5334 % expanded while writing the .toc file. \char\appendixno is not
5335 % expandable, thus it is written literally, thus all appendixes come out
5336 % with the same letter (or @) in the toc without it.
5337 \else\char\the\appendixno
5338 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5339 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5341 % Each @chapter defines these (using marks) as the number+name, number
5342 % and name of the chapter. Page headings and footings can use
5343 % these. @section does likewise.
5345 \def\thischapternum{}
5346 \def\thischaptername{}
5348 \def\thissectionnum{}
5349 \def\thissectionname{}
5351 \newcount\absseclevel % used to calculate proper heading level
5352 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5354 % @raisesections: treat @section as chapter, @subsection as section, etc.
5355 \def\raisesections{\global\advance\secbase by -1}
5356 \let\up=\raisesections % original BFox name
5358 % @lowersections: treat @chapter as section, @section as subsection, etc.
5359 \def\lowersections{\global\advance\secbase by 1}
5360 \let\down=\lowersections % original BFox name
5362 % we only have subsub.
5363 \chardef\maxseclevel = 3
5365 % A numbered section within an unnumbered changes to unnumbered too.
5366 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5367 \chardef\unnlevel = \maxseclevel
5369 % Trace whether the current chapter is an appendix or not:
5370 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5371 \def\chapheadtype{N}
5373 % Choose a heading macro
5374 % #1 is heading type
5375 % #2 is heading level
5376 % #3 is text for heading
5377 \def\genhead#1#2#3{%
5378 % Compute the abs. sec. level:
5380 \advance\absseclevel by \secbase
5381 % Make sure \absseclevel doesn't fall outside the range:
5382 \ifnum \absseclevel < 0
5385 \ifnum \absseclevel > 3
5392 \ifnum \absseclevel < \unnlevel
5393 \chardef\unnlevel = \absseclevel
5396 % Check for appendix sections:
5397 \ifnum \absseclevel = 0
5398 \edef\chapheadtype{\headtype}%
5400 \if \headtype A\if \chapheadtype N%
5401 \errmessage{@appendix... within a non-appendix chapter}%
5404 % Check for numbered within unnumbered:
5405 \ifnum \absseclevel > \unnlevel
5408 \chardef\unnlevel = 3
5411 % Now print the heading:
5415 \or \unnumberedseczzz{#3}%
5416 \or \unnumberedsubseczzz{#3}%
5417 \or \unnumberedsubsubseczzz{#3}%
5423 \or \appendixsectionzzz{#3}%
5424 \or \appendixsubseczzz{#3}%
5425 \or \appendixsubsubseczzz{#3}%
5431 \or \numberedsubseczzz{#3}%
5432 \or \numberedsubsubseczzz{#3}%
5436 \suppressfirstparagraphindent
5440 \def\numhead{\genhead N}
5441 \def\apphead{\genhead A}
5442 \def\unnmhead{\genhead U}
5444 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5445 % all lower-level sectioning counters to zero.
5447 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5448 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5449 \let\chaplevelprefix = \empty
5451 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5453 % section resetting is \global in case the chapter is in a group, such
5454 % as an @include file.
5455 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5456 \global\advance\chapno by 1
5459 \gdef\chaplevelprefix{\the\chapno.}%
5462 % \putwordChapter can contain complex things in translations.
5463 \toks0=\expandafter{\putwordChapter}%
5464 \message{\the\toks0 \space \the\chapno}%
5466 % Write the actual heading.
5467 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5469 % So @section and the like are numbered underneath this chapter.
5470 \global\let\section = \numberedsec
5471 \global\let\subsection = \numberedsubsec
5472 \global\let\subsubsection = \numberedsubsubsec
5475 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5477 \def\appendixzzz#1{%
5478 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5479 \global\advance\appendixno by 1
5480 \gdef\chaplevelprefix{\appendixletter.}%
5483 % \putwordAppendix can contain complex things in translations.
5484 \toks0=\expandafter{\putwordAppendix}%
5485 \message{\the\toks0 \space \appendixletter}%
5487 \chapmacro{#1}{Yappendix}{\appendixletter}%
5489 \global\let\section = \appendixsec
5490 \global\let\subsection = \appendixsubsec
5491 \global\let\subsubsection = \appendixsubsubsec
5494 % normally unnmhead0 calls unnumberedzzz:
5495 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5496 \def\unnumberedzzz#1{%
5497 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5498 \global\advance\unnumberedno by 1
5500 % Since an unnumbered has no number, no prefix for figures.
5501 \global\let\chaplevelprefix = \empty
5504 % This used to be simply \message{#1}, but TeX fully expands the
5505 % argument to \message. Therefore, if #1 contained @-commands, TeX
5506 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5507 % expanded @cite (which turns out to cause errors because \cite is meant
5508 % to be executed, not expanded).
5510 % Anyway, we don't want the fully-expanded definition of @cite to appear
5511 % as a result of the \message, we just want `@cite' itself. We use
5512 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5513 % simply yielding the contents of <toks register>. (We also do this for
5516 \message{(\the\toks0)}%
5518 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5520 \global\let\section = \unnumberedsec
5521 \global\let\subsection = \unnumberedsubsec
5522 \global\let\subsubsection = \unnumberedsubsubsec
5525 % @centerchap is like @unnumbered, but the heading is centered.
5526 \outer\parseargdef\centerchap{%
5527 % Well, we could do the following in a group, but that would break
5528 % an assumption that \chapmacro is called at the outermost level.
5529 % Thus we are safer this way: --kasal, 24feb04
5530 \let\centerparametersmaybe = \centerparameters
5532 \let\centerparametersmaybe = \relax
5535 % @top is like @unnumbered.
5540 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5542 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5543 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5546 % normally calls appendixsectionzzz:
5547 \outer\parseargdef\appendixsection{\apphead1{#1}}
5548 \def\appendixsectionzzz#1{%
5549 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5550 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5552 \let\appendixsec\appendixsection
5554 % normally calls unnumberedseczzz:
5555 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5556 \def\unnumberedseczzz#1{%
5557 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5558 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5563 % normally calls numberedsubseczzz:
5564 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5565 \def\numberedsubseczzz#1{%
5566 \global\subsubsecno=0 \global\advance\subsecno by 1
5567 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5570 % normally calls appendixsubseczzz:
5571 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5572 \def\appendixsubseczzz#1{%
5573 \global\subsubsecno=0 \global\advance\subsecno by 1
5574 \sectionheading{#1}{subsec}{Yappendix}%
5575 {\appendixletter.\the\secno.\the\subsecno}%
5578 % normally calls unnumberedsubseczzz:
5579 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5580 \def\unnumberedsubseczzz#1{%
5581 \global\subsubsecno=0 \global\advance\subsecno by 1
5582 \sectionheading{#1}{subsec}{Ynothing}%
5583 {\the\unnumberedno.\the\secno.\the\subsecno}%
5588 % normally numberedsubsubseczzz:
5589 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5590 \def\numberedsubsubseczzz#1{%
5591 \global\advance\subsubsecno by 1
5592 \sectionheading{#1}{subsubsec}{Ynumbered}%
5593 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5596 % normally appendixsubsubseczzz:
5597 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5598 \def\appendixsubsubseczzz#1{%
5599 \global\advance\subsubsecno by 1
5600 \sectionheading{#1}{subsubsec}{Yappendix}%
5601 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5604 % normally unnumberedsubsubseczzz:
5605 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5606 \def\unnumberedsubsubseczzz#1{%
5607 \global\advance\subsubsecno by 1
5608 \sectionheading{#1}{subsubsec}{Ynothing}%
5609 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5612 % These macros control what the section commands do, according
5613 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5614 % Define them by default for a numbered chapter.
5615 \let\section = \numberedsec
5616 \let\subsection = \numberedsubsec
5617 \let\subsubsection = \numberedsubsubsec
5619 % Define @majorheading, @heading and @subheading
5622 {\advance\chapheadingskip by 10pt \chapbreak }%
5623 \parsearg\chapheadingzzz
5626 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5627 \def\chapheadingzzz#1{%
5628 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5629 \nobreak\bigskip \nobreak
5630 \suppressfirstparagraphindent
5633 % @heading, @subheading, @subsubheading.
5634 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5635 \suppressfirstparagraphindent}
5636 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5637 \suppressfirstparagraphindent}
5638 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5639 \suppressfirstparagraphindent}
5641 % These macros generate a chapter, section, etc. heading only
5642 % (including whitespace, linebreaking, etc. around it),
5643 % given all the information in convenient, parsed form.
5645 % Args are the skip and penalty (usually negative)
5646 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5648 % Parameter controlling skip before chapter headings (if needed)
5649 \newskip\chapheadingskip
5651 % Define plain chapter starts, and page on/off switching for it.
5652 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5653 \def\chappager{\par\vfill\supereject}
5654 % Because \domark is called before \chapoddpage, the filler page will
5655 % get the headings for the next chapter, which is wrong. But we don't
5656 % care -- we just disable all headings on the filler page.
5668 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5671 \global\let\contentsalignmacro = \chappager
5672 \global\let\pchapsepmacro=\chapbreak
5673 \global\let\pagealignmacro=\chappager}
5676 \global\let\contentsalignmacro = \chappager
5677 \global\let\pchapsepmacro=\chappager
5678 \global\let\pagealignmacro=\chappager
5679 \global\def\HEADINGSon{\HEADINGSsingle}}
5682 \global\let\contentsalignmacro = \chapoddpage
5683 \global\let\pchapsepmacro=\chapoddpage
5684 \global\let\pagealignmacro=\chapoddpage
5685 \global\def\HEADINGSon{\HEADINGSdouble}}
5691 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5692 % Yappendix, Yomitfromtoc), #3 the chapter number.
5694 % To test against our argument.
5695 \def\Ynothingkeyword{Ynothing}
5696 \def\Yomitfromtockeyword{Yomitfromtoc}
5697 \def\Yappendixkeyword{Yappendix}
5699 \def\chapmacro#1#2#3{%
5700 % Insert the first mark before the heading break (see notes for \domark).
5701 \let\prevchapterdefs=\lastchapterdefs
5702 \let\prevsectiondefs=\lastsectiondefs
5703 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5704 \gdef\thissection{}}%
5707 \ifx\temptype\Ynothingkeyword
5708 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5709 \gdef\thischapter{\thischaptername}}%
5710 \else\ifx\temptype\Yomitfromtockeyword
5711 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5712 \gdef\thischapter{}}%
5713 \else\ifx\temptype\Yappendixkeyword
5715 \xdef\lastchapterdefs{%
5716 \gdef\noexpand\thischaptername{\the\toks0}%
5717 \gdef\noexpand\thischapternum{\appendixletter}%
5718 % \noexpand\putwordAppendix avoids expanding indigestible
5719 % commands in some of the translations.
5720 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5721 \noexpand\thischapternum:
5722 \noexpand\thischaptername}%
5726 \xdef\lastchapterdefs{%
5727 \gdef\noexpand\thischaptername{\the\toks0}%
5728 \gdef\noexpand\thischapternum{\the\chapno}%
5729 % \noexpand\putwordChapter avoids expanding indigestible
5730 % commands in some of the translations.
5731 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5732 \noexpand\thischapternum:
5733 \noexpand\thischaptername}%
5737 % Output the mark. Pass it through \safewhatsit, to take care of
5738 % the preceding space.
5741 % Insert the chapter heading break.
5744 % Now the second mark, after the heading break. No break points
5745 % between here and the heading.
5746 \let\prevchapterdefs=\lastchapterdefs
5747 \let\prevsectiondefs=\lastsectiondefs
5751 \chapfonts \rmisbold
5753 % Have to define \lastsection before calling \donoderef, because the
5754 % xref code eventually uses it. On the other hand, it has to be called
5755 % after \pchapsepmacro, or the headline will change too soon.
5756 \gdef\lastsection{#1}%
5758 % Only insert the separating space if we have a chapter/appendix
5759 % number, and don't print the unnumbered ``number''.
5760 \ifx\temptype\Ynothingkeyword
5762 \def\toctype{unnchap}%
5763 \else\ifx\temptype\Yomitfromtockeyword
5764 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5766 \else\ifx\temptype\Yappendixkeyword
5767 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5770 \setbox0 = \hbox{#3\enspace}%
5771 \def\toctype{numchap}%
5774 % Write the toc entry for this chapter. Must come before the
5775 % \donoderef, because we include the current node name in the toc
5776 % entry, and \donoderef resets it to empty.
5777 \writetocentry{\toctype}{#1}{#3}%
5779 % For pdftex, we have to write out the node definition (aka, make
5780 % the pdfdest) after any page break, but before the actual text has
5781 % been typeset. If the destination for the pdf outline is after the
5782 % text, then jumping from the outline may wind up with the text not
5783 % being visible, for instance under high magnification.
5786 % Typeset the actual heading.
5787 \nobreak % Avoid page breaks at the interline glue.
5788 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5791 \nobreak\bigskip % no page break after a chapter title
5795 % @centerchap -- centered and unnumbered.
5796 \let\centerparametersmaybe = \relax
5797 \def\centerparameters{%
5798 \advance\rightskip by 3\rightskip
5799 \leftskip = \rightskip
5804 % I don't think this chapter style is supported any more, so I'm not
5805 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5807 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5809 \def\unnchfopen #1{%
5811 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5812 \nobreak\bigskip\nobreak
5814 \def\chfopen #1#2{\chapoddpage {\chapfonts
5815 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5818 \def\centerchfopen #1{%
5820 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5821 \nobreak\bigskip \nobreak
5824 \global\let\chapmacro=\chfopen
5825 \global\let\centerchapmacro=\centerchfopen}
5828 % Section titles. These macros combine the section number parts and
5829 % call the generic \sectionheading to do the printing.
5831 \newskip\secheadingskip
5832 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5834 % Subsection titles.
5835 \newskip\subsecheadingskip
5836 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5838 % Subsubsection titles.
5839 \def\subsubsecheadingskip{\subsecheadingskip}
5840 \def\subsubsecheadingbreak{\subsecheadingbreak}
5843 % Print any size, any type, section title.
5845 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5846 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5849 \def\seckeyword{sec}
5851 \def\sectionheading#1#2#3#4{%
5853 \checkenv{}% should not be in an environment.
5855 % Switch to the right set of fonts.
5856 \csname #2fonts\endcsname \rmisbold
5858 \def\sectionlevel{#2}%
5861 % Insert first mark before the heading break (see notes for \domark).
5862 \let\prevsectiondefs=\lastsectiondefs
5863 \ifx\temptype\Ynothingkeyword
5864 \ifx\sectionlevel\seckeyword
5865 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5866 \gdef\thissection{\thissectionname}}%
5868 \else\ifx\temptype\Yomitfromtockeyword
5869 % Don't redefine \thissection.
5870 \else\ifx\temptype\Yappendixkeyword
5871 \ifx\sectionlevel\seckeyword
5873 \xdef\lastsectiondefs{%
5874 \gdef\noexpand\thissectionname{\the\toks0}%
5875 \gdef\noexpand\thissectionnum{#4}%
5876 % \noexpand\putwordSection avoids expanding indigestible
5877 % commands in some of the translations.
5878 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5879 \noexpand\thissectionnum:
5880 \noexpand\thissectionname}%
5884 \ifx\sectionlevel\seckeyword
5886 \xdef\lastsectiondefs{%
5887 \gdef\noexpand\thissectionname{\the\toks0}%
5888 \gdef\noexpand\thissectionnum{#4}%
5889 % \noexpand\putwordSection avoids expanding indigestible
5890 % commands in some of the translations.
5891 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5892 \noexpand\thissectionnum:
5893 \noexpand\thissectionname}%
5898 % Go into vertical mode. Usually we'll already be there, but we
5899 % don't want the following whatsit to end up in a preceding paragraph
5900 % if the document didn't happen to have a blank line.
5903 % Output the mark. Pass it through \safewhatsit, to take care of
5904 % the preceding space.
5907 % Insert space above the heading.
5908 \csname #2headingbreak\endcsname
5910 % Now the second mark, after the heading break. No break points
5911 % between here and the heading.
5912 \global\let\prevsectiondefs=\lastsectiondefs
5915 % Only insert the space after the number if we have a section number.
5916 \ifx\temptype\Ynothingkeyword
5919 \gdef\lastsection{#1}%
5920 \else\ifx\temptype\Yomitfromtockeyword
5921 % for @headings -- no section number, don't include in toc,
5922 % and don't redefine \lastsection.
5925 \let\sectionlevel=\empty
5926 \else\ifx\temptype\Yappendixkeyword
5927 \setbox0 = \hbox{#4\enspace}%
5929 \gdef\lastsection{#1}%
5931 \setbox0 = \hbox{#4\enspace}%
5933 \gdef\lastsection{#1}%
5936 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5937 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5939 % Write the node reference (= pdf destination for pdftex).
5940 % Again, see comments in \chapmacro.
5943 % Interline glue will be inserted when the vbox is completed.
5944 % That glue will be a valid breakpoint for the page, since it'll be
5945 % preceded by a whatsit (usually from the \donoderef, or from the
5946 % \writetocentry if there was no node). We don't want to allow that
5947 % break, since then the whatsits could end up on page n while the
5948 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5951 % Output the actual section heading.
5952 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5953 \hangindent=\wd0 % zero if no section number
5956 % Add extra space after the heading -- half of whatever came above it.
5957 % Don't allow stretch, though.
5958 \kern .5 \csname #2headingskip\endcsname
5960 % Do not let the kern be a potential breakpoint, as it would be if it
5961 % was followed by glue.
5964 % We'll almost certainly start a paragraph next, so don't let that
5965 % glue accumulate. (Not a breakpoint because it's preceded by a
5966 % discardable item.) However, when a paragraph is not started next
5967 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5968 % or the negative glue will cause weirdly wrong output, typically
5969 % obscuring the section heading with something else.
5972 % This is so the last item on the main vertical list is a known
5973 % \penalty > 10000, so \startdefun, etc., can recognize the situation
5974 % and do the needful.
5980 % Table of contents.
5983 % Write an entry to the toc file, opening it if necessary.
5984 % Called from @chapter, etc.
5986 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5987 % We append the current node name (if any) and page number as additional
5988 % arguments for the \{chap,sec,...}entry macros which will eventually
5989 % read this. The node name is used in the pdf outlines as the
5990 % destination to jump to.
5992 % We open the .toc file for writing here instead of at @setfilename (or
5993 % any other fixed time) so that @contents can be anywhere in the document.
5994 % But if #1 is `omit', then we don't do anything. This is used for the
5995 % table of contents chapter openings themselves.
5997 \newif\iftocfileopened
5998 \def\omitkeyword{omit}%
6000 \def\writetocentry#1#2#3{%
6001 \edef\writetoctype{#1}%
6002 \ifx\writetoctype\omitkeyword \else
6003 \iftocfileopened\else
6004 \immediate\openout\tocfile = \jobname.toc
6005 \global\tocfileopenedtrue
6011 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6017 % Tell \shipout to create a pdf destination on each page, if we're
6018 % writing pdf. These are used in the table of contents. We can't
6019 % just write one on every page because the title pages are numbered
6020 % 1 and 2 (the page numbers aren't printed), and so are the first
6021 % two pages of the document. Thus, we'd have two destinations named
6022 % `1', and two named `2'.
6023 \ifpdf \global\pdfmakepagedesttrue \fi
6027 % These characters do not print properly in the Computer Modern roman
6028 % fonts, so we must take special care. This is more or less redundant
6029 % with the Texinfo input format setup at the end of this file.
6031 \def\activecatcodes{%
6044 % Read the toc file, which is essentially Texinfo input.
6048 \input \tocreadfilename
6051 \newskip\contentsrightmargin \contentsrightmargin=1in
6052 \newcount\savepageno
6053 \newcount\lastnegativepageno \lastnegativepageno = -1
6055 % Prepare to read what we've written to \tocfile.
6057 \def\startcontents#1{%
6058 % If @setchapternewpage on, and @headings double, the contents should
6059 % start on an odd page, unlike chapters. Thus, we maintain
6060 % \contentsalignmacro in parallel with \pagealignmacro.
6061 % From: Torbjorn Granlund <tege@matematik.su.se>
6063 \immediate\closeout\tocfile
6065 % Don't need to put `Contents' or `Short Contents' in the headline.
6066 % It is abundantly clear what they are.
6067 \chapmacro{#1}{Yomitfromtoc}{}%
6069 \savepageno = \pageno
6070 \begingroup % Set up to handle contents files properly.
6071 \raggedbottom % Worry more about breakpoints than the bottom.
6072 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6074 % Roman numerals for page numbers.
6075 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6078 % redefined for the two-volume lispref. We always output on
6079 % \jobname.toc even if this is redefined.
6081 \def\tocreadfilename{\jobname.toc}
6083 % Normal (long) toc.
6086 \startcontents{\putwordTOC}%
6087 \openin 1 \tocreadfilename\space
6092 \contentsalignmacro % in case @setchapternewpage odd is in effect
6098 \lastnegativepageno = \pageno
6099 \global\pageno = \savepageno
6102 % And just the chapters.
6103 \def\summarycontents{%
6104 \startcontents{\putwordShortTOC}%
6106 \let\partentry = \shortpartentry
6107 \let\numchapentry = \shortchapentry
6108 \let\appentry = \shortchapentry
6109 \let\unnchapentry = \shortunnchapentry
6110 % We want a true roman here for the page numbers.
6112 \let\rm=\shortcontrm \let\bf=\shortcontbf
6113 \let\sl=\shortcontsl \let\tt=\shortconttt
6115 \hyphenpenalty = 10000
6116 \advance\baselineskip by 1pt % Open it up a little.
6117 \def\numsecentry##1##2##3##4{}
6118 \let\appsecentry = \numsecentry
6119 \let\unnsecentry = \numsecentry
6120 \let\numsubsecentry = \numsecentry
6121 \let\appsubsecentry = \numsecentry
6122 \let\unnsubsecentry = \numsecentry
6123 \let\numsubsubsecentry = \numsecentry
6124 \let\appsubsubsecentry = \numsecentry
6125 \let\unnsubsubsecentry = \numsecentry
6126 \openin 1 \tocreadfilename\space
6132 \contentsalignmacro % in case @setchapternewpage odd is in effect
6134 \lastnegativepageno = \pageno
6135 \global\pageno = \savepageno
6137 \let\shortcontents = \summarycontents
6139 % Typeset the label for a chapter or appendix for the short contents.
6140 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6142 \def\shortchaplabel#1{%
6143 % This space should be enough, since a single number is .5em, and the
6144 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6145 % But use \hss just in case.
6146 % (This space doesn't include the extra space that gets added after
6147 % the label; that gets put in by \shortchapentry above.)
6149 % We'd like to right-justify chapter numbers, but that looks strange
6150 % with appendix letters. And right-justifying numbers and
6151 % left-justifying letters looks strange when there is less than 10
6152 % chapters. Have to read the whole toc once to know how many chapters
6153 % there are before deciding ...
6154 \hbox to 1em{#1\hss}%
6157 % These macros generate individual entries in the table of contents.
6158 % The first argument is the chapter or section name.
6159 % The last argument is the page number.
6160 % The arguments in between are the chapter number, section number, ...
6162 % Parts, in the main contents. Replace the part number, which doesn't
6163 % exist, with an empty box. Let's hope all the numbers have the same width.
6164 % Also ignore the page number, which is conventionally not printed.
6165 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6166 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6168 % Parts, in the short toc.
6169 \def\shortpartentry#1#2#3#4{%
6171 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6172 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6175 % Chapters, in the main contents.
6176 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6178 % Chapters, in the short toc.
6179 % See comments in \dochapentry re vbox and related settings.
6180 \def\shortchapentry#1#2#3#4{%
6181 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6184 % Appendices, in the main contents.
6185 % Need the word Appendix, and a fixed-size box.
6187 \def\appendixbox#1{%
6188 % We use M since it's probably the widest letter.
6189 \setbox0 = \hbox{\putwordAppendix{} M}%
6190 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6192 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6194 % Unnumbered chapters.
6195 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6196 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6199 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6200 \let\appsecentry=\numsecentry
6201 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6204 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6205 \let\appsubsecentry=\numsubsecentry
6206 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6208 % And subsubsections.
6209 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6210 \let\appsubsubsecentry=\numsubsubsecentry
6211 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6213 % This parameter controls the indentation of the various levels.
6214 % Same as \defaultparindent.
6215 \newdimen\tocindent \tocindent = 15pt
6217 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6220 % If the toc has to be broken over pages, we want it to be at chapters
6221 % if at all possible; hence the \penalty.
6222 \def\dochapentry#1#2{%
6223 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6226 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6228 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6231 \def\dosecentry#1#2{\begingroup
6232 \secentryfonts \leftskip=\tocindent
6233 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6236 \def\dosubsecentry#1#2{\begingroup
6237 \subsecentryfonts \leftskip=2\tocindent
6238 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6241 \def\dosubsubsecentry#1#2{\begingroup
6242 \subsubsecentryfonts \leftskip=3\tocindent
6243 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6246 % We use the same \entry macro as for the index entries.
6247 \let\tocentry = \entry
6249 % Space between chapter (or whatever) number and the title.
6250 \def\labelspace{\hskip1em \relax}
6252 \def\dopageno#1{{\rm #1}}
6253 \def\doshortpageno#1{{\rm #1}}
6255 \def\chapentryfonts{\secfonts \rm}
6256 \def\secentryfonts{\textfonts}
6257 \def\subsecentryfonts{\textfonts}
6258 \def\subsubsecentryfonts{\textfonts}
6261 \message{environments,}
6262 % @foo ... @end foo.
6264 % @tex ... @end tex escapes into raw TeX temporarily.
6265 % One exception: @ is still an escape character, so that @end tex works.
6266 % But \@ or @@ will get a plain @ character.
6269 \setupmarkupstyle{tex}%
6270 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6271 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6272 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6283 % ' is active in math mode (mathcode"8000). So reset it, and all our
6284 % other math active characters (just in case), to plain's definitions.
6288 \let\bullet=\ptexbullet
6293 \let\equiv=\ptexequiv
6296 \let\indent=\ptexindent
6297 \let\noindent=\ptexnoindent
6304 \expandafter \let\csname top\endcsname=\ptextop % outer
6305 \let\frenchspacing=\plainfrenchspacing
6307 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6308 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6311 % There is no need to define \Etex.
6313 % Define @lisp ... @end lisp.
6314 % @lisp environment forms a group so it can rebind things,
6315 % including the definition of @end lisp (which normally is erroneous).
6317 % Amount to narrow the margins by for @lisp.
6318 \newskip\lispnarrowing \lispnarrowing=0.4in
6320 % This is the definition that ^^M gets inside @lisp, @example, and other
6321 % such environments. \null is better than a space, since it doesn't
6323 \def\lisppar{\null\endgraf}
6325 % This space is always present above and below environments.
6326 \newskip\envskipamount \envskipamount = 0pt
6328 % Make spacing and below environment symmetrical. We use \parskip here
6329 % to help in doing that, since in @example-like environments \parskip
6330 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6331 % start of the next paragraph will insert \parskip.
6333 \def\aboveenvbreak{{%
6334 % =10000 instead of <10000 because of a special case in \itemzzz and
6335 % \sectionheading, q.v.
6336 \ifnum \lastpenalty=10000 \else
6337 \advance\envskipamount by \parskip
6339 \ifdim\lastskip<\envskipamount
6341 % it's not a good place to break if the last penalty was \nobreak
6343 \ifnum\lastpenalty<10000 \penalty-50 \fi
6344 \vskip\envskipamount
6349 \let\afterenvbreak = \aboveenvbreak
6351 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6352 % also clear it, so that its embedded environments do the narrowing again.
6353 \let\nonarrowing=\relax
6355 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6356 % environment contents.
6357 \font\circle=lcircle10
6359 \newdimen\cartouter\newdimen\cartinner
6360 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6361 \circthick=\fontdimen8\circle
6363 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6364 \def\ctr{{\hskip 6pt\circle\char'010}}
6365 \def\cbl{{\circle\char'012\hskip -6pt}}
6366 \def\cbr{{\hskip 6pt\circle\char'011}}
6367 \def\carttop{\hbox to \cartouter{\hskip\lskip
6368 \ctl\leaders\hrule height\circthick\hfil\ctr
6370 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6371 \cbl\leaders\hrule height\circthick\hfil\cbr
6374 \newskip\lskip\newskip\rskip
6377 \ifhmode\par\fi % can't be in the midst of a paragraph.
6379 \lskip=\leftskip \rskip=\rightskip
6380 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6381 \cartinner=\hsize \advance\cartinner by-\lskip
6382 \advance\cartinner by-\rskip
6384 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6385 % side, and for 6pt waste from
6386 % each corner char, and rule thickness
6387 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6388 % Flag to tell @lisp, etc., not to narrow margin.
6389 \let\nonarrowing = t%
6391 % If this cartouche directly follows a sectioning command, we need the
6392 % \parskip glue (backspaced over by default) or the cartouche can
6393 % collide with the section heading.
6394 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6397 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6405 \baselineskip=\normbskip
6406 \lineskip=\normlskip
6409 \comment % For explanation, see the end of def\group.
6424 % This macro is called at the beginning of all the @example variants,
6426 \newdimen\nonfillparindent
6429 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6430 \sepspaces % Make spaces be word-separators rather than space tokens.
6431 \let\par = \lisppar % don't ignore blank lines
6432 \obeylines % each line of input is a line of output
6434 % Turn off paragraph indentation but redefine \indent to emulate
6435 % the normal \indent.
6436 \nonfillparindent=\parindent
6438 \let\indent\nonfillindent
6440 \emergencystretch = 0pt % don't try to avoid overfull boxes
6441 \ifx\nonarrowing\relax
6442 \advance \leftskip by \lispnarrowing
6443 \exdentamount=\lispnarrowing
6445 \let\nonarrowing = \relax
6447 \let\exdent=\nofillexdent
6452 % We want to swallow spaces (but not other tokens) after the fake
6453 % @indent in our nonfill-environments, where spaces are normally
6454 % active and set to @tie, resulting in them not being ignored after
6456 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6457 \gdef\nonfillindentcheck{%
6459 \expandafter\nonfillindentgobble%
6461 \leavevmode\nonfillindentbox%
6465 \def\nonfillindentgobble#1{\nonfillindent}
6466 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6468 % If you want all examples etc. small: @set dispenvsize small.
6469 % If you want even small examples the full size: @set dispenvsize nosmall.
6470 % This affects the following displayed environments:
6471 % @example, @display, @format, @lisp
6473 \def\smallword{small}
6474 \def\nosmallword{nosmall}
6475 \let\SETdispenvsize\relax
6476 \def\setnormaldispenv{%
6477 \ifx\SETdispenvsize\smallword
6478 % end paragraph for sake of leading, in case document has no blank
6479 % line. This is redundant with what happens in \aboveenvbreak, but
6480 % we need to do it before changing the fonts, and it's inconvenient
6481 % to change the fonts afterward.
6482 \ifnum \lastpenalty=10000 \else \endgraf \fi
6483 \smallexamplefonts \rm
6486 \def\setsmalldispenv{%
6487 \ifx\SETdispenvsize\nosmallword
6489 \ifnum \lastpenalty=10000 \else \endgraf \fi
6490 \smallexamplefonts \rm
6494 % We often define two environments, @foo and @smallfoo.
6495 % Let's do it in one command. #1 is the env name, #2 the definition.
6496 \def\makedispenvdef#1#2{%
6497 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6498 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6499 \expandafter\let\csname E#1\endcsname \afterenvbreak
6500 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6503 % Define two environment synonyms (#1 and #2) for an environment.
6504 \def\maketwodispenvdef#1#2#3{%
6505 \makedispenvdef{#1}{#3}%
6506 \makedispenvdef{#2}{#3}%
6509 % @lisp: indented, narrowed, typewriter font;
6510 % @example: same as @lisp.
6512 % @smallexample and @smalllisp: use smaller fonts.
6513 % Originally contributed by Pavel@xerox.
6515 \maketwodispenvdef{lisp}{example}{%
6517 \tt\setupmarkupstyle{example}%
6518 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6519 \gobble % eat return
6521 % @display/@smalldisplay: same as @lisp except keep current font.
6523 \makedispenvdef{display}{%
6528 % @format/@smallformat: same as @display except don't narrow margins.
6530 \makedispenvdef{format}{%
6531 \let\nonarrowing = t%
6536 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6538 \let\nonarrowing = t%
6542 \let\Eflushleft = \afterenvbreak
6546 \envdef\flushright{%
6547 \let\nonarrowing = t%
6549 \advance\leftskip by 0pt plus 1fill\relax
6552 \let\Eflushright = \afterenvbreak
6555 % @raggedright does more-or-less normal line breaking but no right
6556 % justification. From plain.tex.
6557 \envdef\raggedright{%
6558 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6560 \let\Eraggedright\par
6562 \envdef\raggedleft{%
6563 \parindent=0pt \leftskip0pt plus2em
6564 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6565 \hbadness=10000 % Last line will usually be underfull, so turn off
6566 % badness reporting.
6568 \let\Eraggedleft\par
6570 \envdef\raggedcenter{%
6571 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6572 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6573 \hbadness=10000 % Last line will usually be underfull, so turn off
6574 % badness reporting.
6576 \let\Eraggedcenter\par
6579 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6580 % and narrows the margins. We keep \parskip nonzero in general, since
6581 % we're doing normal filling. So, when using \aboveenvbreak and
6582 % \afterenvbreak, temporarily make \parskip 0.
6584 \makedispenvdef{quotation}{\quotationstart}
6586 \def\quotationstart{%
6587 \indentedblockstart % same as \indentedblock, but increase right margin too.
6588 \ifx\nonarrowing\relax
6589 \advance\rightskip by \lispnarrowing
6591 \parsearg\quotationlabel
6594 % We have retained a nonzero parskip for the environment, since we're
6595 % doing normal filling.
6599 \ifx\quotationauthor\thisisundefined\else
6601 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6603 {\parskip=0pt \afterenvbreak}%
6605 \def\Esmallquotation{\Equotation}
6607 % If we're given an argument, typeset it in bold with a colon after.
6608 \def\quotationlabel#1{%
6610 \ifx\temp\empty \else
6615 % @indentedblock is like @quotation, but indents only on the left and
6616 % has no optional argument.
6618 \makedispenvdef{indentedblock}{\indentedblockstart}
6620 \def\indentedblockstart{%
6621 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6624 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6625 \ifx\nonarrowing\relax
6626 \advance\leftskip by \lispnarrowing
6627 \exdentamount = \lispnarrowing
6629 \let\nonarrowing = \relax
6633 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6635 \def\Eindentedblock{%
6637 {\parskip=0pt \afterenvbreak}%
6639 \def\Esmallindentedblock{\Eindentedblock}
6642 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6643 % If we want to allow any <char> as delimiter,
6644 % we need the curly braces so that makeinfo sees the @verb command, eg:
6645 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6647 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6649 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6650 % active too. Otherwise, they get lost as the first character on a
6653 \do\ \do\\\do\{\do\}\do\$\do\&%
6654 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6655 \do\<\do\>\do\|\do\@\do+\do\"%
6656 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6657 % @set txicodequotebacktick will not have effect on @verb and
6658 % @verbatim, and ?` and !` ligatures won't get disabled.
6663 \def\uncatcodespecials{%
6664 \def\do##1{\catcode`##1=\other}\dospecials}
6666 % Setup for the @verb command.
6668 % Eight spaces for a tab
6670 \catcode`\^^I=\active
6671 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6675 \tt % easiest (and conventionally used) font for verbatim
6676 \def\par{\leavevmode\endgraf}%
6677 \setupmarkupstyle{verb}%
6679 % Respect line breaks,
6680 % print special symbols as themselves, and
6681 % make each space count
6682 % must do in this order:
6683 \obeylines \uncatcodespecials \sepspaces
6686 % Setup for the @verbatim environment
6688 % Real tab expansion.
6689 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6691 % We typeset each line of the verbatim in an \hbox, so we can handle
6692 % tabs. The \global is in case the verbatim line starts with an accent,
6693 % or some other command that starts with a begin-group. Otherwise, the
6694 % entire \verbbox would disappear at the corresponding end-group, before
6695 % it is typeset. Meanwhile, we can't have nested verbatim commands
6696 % (can we?), so the \global won't be overwriting itself.
6698 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6701 \catcode`\^^I=\active
6703 \catcode`\^^I=\active
6704 \def^^I{\leavevmode\egroup
6705 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6706 \divide\dimen\verbbox by\tabw
6707 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6708 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6709 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6714 % start the verbatim environment.
6715 \def\setupverbatim{%
6716 \let\nonarrowing = t%
6718 \tt % easiest (and conventionally used) font for verbatim
6719 % The \leavevmode here is for blank lines. Otherwise, we would
6720 % never \starttabox and the \egroup would end verbatim mode.
6721 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6723 \setupmarkupstyle{verbatim}%
6724 % Respect line breaks,
6725 % print special symbols as themselves, and
6726 % make each space count.
6727 % Must do in this order:
6728 \obeylines \uncatcodespecials \sepspaces
6729 \everypar{\starttabbox}%
6732 % Do the @verb magic: verbatim text is quoted by unique
6733 % delimiter characters. Before first delimiter expect a
6734 % right brace, after last delimiter expect closing brace:
6736 % \def\doverb'{'<char>#1<char>'}'{#1}
6738 % [Knuth] p. 382; only eat outer {}
6740 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6741 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6744 \def\verb{\begingroup\setupverb\doverb}
6747 % Do the @verbatim magic: define the macro \doverbatim so that
6748 % the (first) argument ends when '@end verbatim' is reached, ie:
6750 % \def\doverbatim#1@end verbatim{#1}
6752 % For Texinfo it's a lot easier than for LaTeX,
6753 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6754 % we need not redefine '\', '{' and '}'.
6756 % Inspired by LaTeX's verbatim command set [latex.ltx]
6761 % ignore everything up to the first ^^M, that's the newline at the end
6762 % of the @verbatim input line itself. Otherwise we get an extra blank
6763 % line in the output.
6764 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6765 % We really want {...\end verbatim} in the body of the macro, but
6766 % without the active space; thus we have to use \xdef and \gobble.
6770 \setupverbatim\doverbatim
6772 \let\Everbatim = \afterenvbreak
6775 % @verbatiminclude FILE - insert text of file in verbatim environment.
6777 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6779 \def\doverbatiminclude#1{%
6781 \makevalueexpandable
6783 \indexnofonts % Allow `@@' and other weird things in file names.
6784 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6790 % @copying ... @end copying.
6791 % Save the text away for @insertcopying later.
6793 % We save the uninterpreted tokens, rather than creating a box.
6794 % Saving the text in a box would be much easier, but then all the
6795 % typesetting commands (@smallbook, font changes, etc.) have to be done
6796 % beforehand -- and a) we want @copying to be done first in the source
6797 % file; b) letting users define the frontmatter in as flexible order as
6798 % possible is very desirable.
6800 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6801 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6803 \def\insertcopying{%
6805 \parindent = 0pt % paragraph indentation looks wrong on title page
6806 \scanexp\copyingtext
6814 \newskip\defbodyindent \defbodyindent=.4in
6815 \newskip\defargsindent \defargsindent=50pt
6816 \newskip\deflastargmargin \deflastargmargin=18pt
6817 \newcount\defunpenalty
6819 % Start the processing of @deffn:
6821 \ifnum\lastpenalty<10000
6823 \defunpenalty=10003 % Will keep this @deffn together with the
6824 % following @def command, see below.
6826 % If there are two @def commands in a row, we'll have a \nobreak,
6827 % which is there to keep the function description together with its
6828 % header. But if there's nothing but headers, we need to allow a
6829 % break somewhere. Check specifically for penalty 10002, inserted
6830 % by \printdefunline, instead of 10000, since the sectioning
6831 % commands also insert a nobreak penalty, and we don't want to allow
6832 % a break between a section heading and a defun.
6834 % As a further refinement, we avoid "club" headers by signalling
6835 % with penalty of 10003 after the very first @deffn in the
6836 % sequence (see above), and penalty of 10002 after any following
6838 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6840 % Similarly, after a section heading, do not allow a break.
6841 % But do insert the glue.
6842 \medskip % preceded by discardable penalty, so not a breakpoint
6846 \advance\leftskip by \defbodyindent
6847 \exdentamount=\defbodyindent
6851 % First, check whether we are in the right environment:
6854 % As above, allow line break if we have multiple x headers in a row.
6855 % It's not a great place, though.
6856 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6858 % And now, it's time to reuse the body of the original defun:
6859 \expandafter\gobbledefun#1%
6861 \def\gobbledefun#1\startdefun{}
6863 % \printdefunline \deffnheader{text}
6865 \def\printdefunline#1#2{%
6867 % call \deffnheader:
6870 \interlinepenalty = 10000
6871 \advance\rightskip by 0pt plus 1fil\relax
6873 \nobreak\vskip -\parskip
6874 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6875 % Some of the @defun-type tags do not enable magic parentheses,
6876 % rendering the following check redundant. But we don't optimize.
6881 \def\Edefun{\endgraf\medbreak}
6883 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6884 % the only thing remaining is to define \deffnheader.
6887 \expandafter\let\csname E#1\endcsname = \Edefun
6888 \edef\temp{\noexpand\domakedefun
6889 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6893 % \domakedefun \deffn \deffnx \deffnheader
6895 % Define \deffn and \deffnx, without parameters.
6896 % \deffnheader has to be defined explicitly.
6898 \def\domakedefun#1#2#3{%
6901 \doingtypefnfalse % distinguish typed functions from all else
6902 \parseargusing\activeparens{\printdefunline#3}%
6904 \def#2{\dodefunx#1}%
6908 \newif\ifdoingtypefn % doing typed function?
6909 \newif\ifrettypeownline % typeset return type on its own line?
6911 % @deftypefnnewline on|off says whether the return type of typed functions
6912 % are printed on their own line. This affects @deftypefn, @deftypefun,
6913 % @deftypeop, and @deftypemethod.
6915 \parseargdef\deftypefnnewline{%
6918 \expandafter\let\csname SETtxideftypefnnl\endcsname
6920 \else\ifx\temp\offword
6921 \expandafter\let\csname SETtxideftypefnnl\endcsname
6924 \errhelp = \EMsimple
6925 \errmessage{Unknown @txideftypefnnl value `\temp',
6930 % Untyped functions:
6932 % @deffn category name args
6933 \makedefun{deffn}{\deffngeneral{}}
6935 % @deffn category class name args
6936 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6938 % \defopon {category on}class name args
6939 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6941 % \deffngeneral {subind}category name args
6943 \def\deffngeneral#1#2 #3 #4\endheader{%
6944 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6945 \dosubind{fn}{\code{#3}}{#1}%
6946 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6951 % @deftypefn category type name args
6952 \makedefun{deftypefn}{\deftypefngeneral{}}
6954 % @deftypeop category class type name args
6955 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6957 % \deftypeopon {category on}class type name args
6958 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6960 % \deftypefngeneral {subind}category type name args
6962 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6963 \dosubind{fn}{\code{#4}}{#1}%
6965 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6970 % @deftypevr category type var args
6971 \makedefun{deftypevr}{\deftypecvgeneral{}}
6973 % @deftypecv category class type var args
6974 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6976 % \deftypecvof {category of}class type var args
6977 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6979 % \deftypecvgeneral {subind}category type var args
6981 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6982 \dosubind{vr}{\code{#4}}{#1}%
6983 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6986 % Untyped variables:
6988 % @defvr category var args
6989 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6991 % @defcv category class var args
6992 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6994 % \defcvof {category of}class var args
6995 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6999 % @deftp category name args
7000 \makedefun{deftp}#1 #2 #3\endheader{%
7001 \doind{tp}{\code{#2}}%
7002 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7005 % Remaining @defun-like shortcuts:
7006 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7007 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7008 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7009 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7010 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7011 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7012 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7013 \makedefun{defmethod}{\defopon\putwordMethodon}
7014 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7015 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7016 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7018 % \defname, which formats the name of the @def (not the args).
7019 % #1 is the category, such as "Function".
7020 % #2 is the return type, if any.
7021 % #3 is the function name.
7023 % We are followed by (but not passed) the arguments, if any.
7025 \def\defname#1#2#3{%
7027 % Get the values of \leftskip and \rightskip as they were outside the @def...
7028 \advance\leftskip by -\defbodyindent
7030 % Determine if we are typesetting the return type of a typed function
7031 % on a line by itself.
7032 \rettypeownlinefalse
7033 \ifdoingtypefn % doing a typed function specifically?
7034 % then check user option for putting return type on its own line:
7035 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7040 % How we'll format the category name. Putting it in brackets helps
7041 % distinguish it from the body text that may end up on the next line
7044 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7046 % Figure out line sizes for the paragraph shape. We'll always have at
7050 % The first line needs space for \box0; but if \rightskip is nonzero,
7051 % we need only space for the part of \box0 which exceeds it:
7052 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7054 % If doing a return type on its own line, we'll have another line.
7056 \advance\tempnum by 1
7057 \def\maybeshapeline{0in \hsize}%
7059 \def\maybeshapeline{}%
7062 % The continuations:
7063 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7065 % The final paragraph shape:
7066 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7068 % Put the category name at the right margin.
7071 \hfil\box0 \kern-\hsize
7072 % \hsize has to be shortened this way:
7074 % Intentionally do not respect \rightskip, since we need the space.
7077 % Allow all lines to be underfull without complaint:
7078 \tolerance=10000 \hbadness=10000
7079 \exdentamount=\defbodyindent
7081 % defun fonts. We use typewriter by default (used to be bold) because:
7082 % . we're printing identifiers, they should be in tt in principle.
7083 % . in languages with many accents, such as Czech or French, it's
7084 % common to leave accents off identifiers. The result looks ok in
7085 % tt, but exceedingly strange in rm.
7086 % . we don't want -- and --- to be treated as ligatures.
7087 % . this still does not fix the ?` and !` ligatures, but so far no
7088 % one has made identifiers using them :).
7090 \def\temp{#2}% text of the return type
7091 \ifx\temp\empty\else
7092 \tclose{\temp}% typeset the return type
7094 % put return type on its own line; prohibit line break following:
7095 \hfil\vadjust{\nobreak}\break
7097 \space % type on same line, so just followed by a space
7099 \fi % no return type
7100 #3% output function name
7102 {\rm\enskip}% hskip 0.5 em of \tenrm
7105 % arguments will be output next, if any.
7108 % Print arguments in slanted roman (not ttsl), inconsistently with using
7109 % tt for the name. This is because literal text is sometimes needed in
7110 % the argument list (groff manual), and ttsl and tt are not very
7111 % distinguishable. Prevent hyphenation at `-' chars.
7114 % use sl by default (not ttsl),
7116 \df \sl \hyphenchar\font=0
7118 % On the other hand, if an argument has two dashes (for instance), we
7119 % want a way to get ttsl. We used to recommend @var for that, so
7120 % leave the code in, but it's strange for @var to lead to typewriter.
7121 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7122 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7123 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7125 \sl\hyphenchar\font=45
7128 % We want ()&[] to print specially on the defun line.
7131 \catcode`\(=\active \catcode`\)=\active
7132 \catcode`\[=\active \catcode`\]=\active
7136 % Make control sequences which act like normal parenthesis chars.
7137 \let\lparen = ( \let\rparen = )
7139 % Be sure that we always have a definition for `(', etc. For example,
7140 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7141 % so TeX would otherwise complain about undefined control sequence.
7144 \global\let(=\lparen \global\let)=\rparen
7145 \global\let[=\lbrack \global\let]=\rbrack
7148 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7149 \gdef\magicamp{\let&=\amprm}
7152 \newcount\parencount
7154 % If we encounter &foo, then turn on ()-hacking afterwards
7156 \def\amprm#1 {\ampseentrue{\bf\ }}
7160 % At the first level, print parens in roman,
7161 % otherwise use the default font.
7162 \ifnum \parencount=1 \rm \fi
7164 % The \sf parens (in \boldbrax) actually are a little bolder than
7165 % the contained text. This is especially needed for [ and ] .
7169 \def\infirstlevel#1{%
7176 \def\bfafterword#1 {#1 \bf}
7179 \global\advance\parencount by 1
7181 \infirstlevel \bfafterword
7186 \global\advance\parencount by -1
7189 \newcount\brackcount
7191 \global\advance\brackcount by 1
7196 \global\advance\brackcount by -1
7199 \def\checkparencounts{%
7200 \ifnum\parencount=0 \else \badparencount \fi
7201 \ifnum\brackcount=0 \else \badbrackcount \fi
7203 % these should not use \errmessage; the glibc manual, at least, actually
7204 % has such constructs (when documenting function pointers).
7205 \def\badparencount{%
7206 \message{Warning: unbalanced parentheses in @def...}%
7207 \global\parencount=0
7209 \def\badbrackcount{%
7210 \message{Warning: unbalanced square brackets in @def...}%
7211 \global\brackcount=0
7218 % To do this right we need a feature of e-TeX, \scantokens,
7219 % which we arrange to emulate with a temporary file in ordinary TeX.
7220 \ifx\eTeXversion\thisisundefined
7221 \newwrite\macscribble
7224 \immediate\openout\macscribble=\jobname.tmp
7225 \immediate\write\macscribble{\the\toks0}%
7226 \immediate\closeout\macscribble
7231 \def\scanmacro#1{\begingroup
7233 \let\xeatspaces\eatspaces
7235 % Undo catcode changes of \startcontents and \doprintindex
7236 % When called from @insertcopying or (short)caption, we need active
7237 % backslash to get it printed correctly. Previously, we had
7238 % \catcode`\\=\other instead. We'll see whether a problem appears
7239 % with macro expansion. --kasal, 19aug04
7240 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7242 % ... and for \example:
7245 % The \empty here causes a following catcode 5 newline to be eaten as
7246 % part of reading whitespace after a control sequence. It does not
7247 % eat a catcode 13 newline. There's no good way to handle the two
7248 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7249 % would then have different behavior). See the Macro Details node in
7250 % the manual for the workaround we recommend for macros and
7251 % line-oriented commands.
7253 \scantokens{#1\empty}%
7257 \edef\temp{\noexpand\scanmacro{#1}}%
7261 \newcount\paramno % Count of parameters
7262 \newtoks\macname % Macro name
7263 \newif\ifrecursive % Is it recursive?
7265 % List of all defined macros in the form
7266 % \definedummyword\macro1\definedummyword\macro2...
7267 % Currently is also contains all @aliases; the list can be split
7268 % if there is a need.
7271 % Add the macro to \macrolist
7272 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7273 \def\addtomacrolistxxx#1{%
7274 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7275 \xdef\macrolist{\the\toks0}%
7279 % This does \let #1 = #2, with \csnames; that is,
7280 % \let \csname#1\endcsname = \csname#2\endcsname
7281 % (except of course we have to play expansion games).
7285 \csname#1\expandafter\endcsname
7289 % Trim leading and trailing spaces off a string.
7290 % Concepts from aro-bend problem 15 (see CTAN).
7292 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7293 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7294 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7296 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7299 % Trim a single trailing ^^M off a string.
7300 {\catcode`\^^M=\other \catcode`\Q=3%
7301 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7302 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7303 \gdef\eatcrb#1Q#2Q{#1}%
7306 % Macro bodies are absorbed as an argument in a context where
7307 % all characters are catcode 10, 11 or 12, except \ which is active
7308 % (as in normal texinfo). It is necessary to change the definition of \
7309 % to recognize macro arguments; this is the job of \mbodybackslash.
7311 % Non-ASCII encodings make 8-bit characters active, so un-activate
7312 % them to avoid their expansion. Must do this non-globally, to
7313 % confine the change to the current group.
7315 % It's necessary to have hard CRs when the macro is executed. This is
7316 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7317 % body, and then making it the \newlinechar in \scanmacro.
7319 \def\scanctxt{% used as subroutine
7329 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7332 \def\scanargctxt{% used for copying and captions, not macros.
7335 \catcode`\^^M=\other
7338 \def\macrobodyctxt{% used for @macro definitions
7342 \catcode`\^^M=\other
7346 \def\macroargctxt{% used when scanning invocations
7350 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7351 % for the single characters \ { }. Thus, we end up with the "commands"
7352 % that would be written @\ @{ @} in a Texinfo document.
7354 % We already have @{ and @}. For @\, we define it here, and only for
7355 % this purpose, to produce a typewriter backslash (so, the @\ that we
7356 % define for @math can't be used with @macro calls):
7358 \def\\{\normalbackslash}%
7360 % We would like to do this for \, too, since that is what makeinfo does.
7361 % But it is not possible, because Texinfo already has a command @, for a
7362 % cedilla accent. Documents must use @comma{} instead.
7364 % \anythingelse will almost certainly be an error of some kind.
7367 % \mbodybackslash is the definition of \ in @macro bodies.
7368 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7369 % where N is the macro parameter number.
7370 % We define \csname macarg.\endcsname to be \realbackslash, so
7371 % \\ in macro replacement text gets you a backslash.
7373 {\catcode`@=0 @catcode`@\=@active
7374 @gdef@usembodybackslash{@let\=@mbodybackslash}
7375 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7377 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7379 \def\margbackslash#1{\char`\#1 }
7381 \def\macro{\recursivefalse\parsearg\macroxxx}
7382 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7385 \getargs{#1}% now \macname is the macname and \argl the arglist
7386 \ifx\argl\empty % no arguments
7389 \expandafter\parsemargdef \argl;%
7390 \if\paramno>256\relax
7391 \ifx\eTeXversion\thisisundefined
7392 \errhelp = \EMsimple
7393 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7397 \if1\csname ismacro.\the\macname\endcsname
7398 \message{Warning: redefining \the\macname}%
7400 \expandafter\ifx\csname \the\macname\endcsname \relax
7401 \else \errmessage{Macro name \the\macname\space already defined}\fi
7402 \global\cslet{macsave.\the\macname}{\the\macname}%
7403 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7404 \addtomacrolist{\the\macname}%
7406 \begingroup \macrobodyctxt
7407 \ifrecursive \expandafter\parsermacbody
7408 \else \expandafter\parsemacbody
7411 \parseargdef\unmacro{%
7412 \if1\csname ismacro.#1\endcsname
7413 \global\cslet{#1}{macsave.#1}%
7414 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7415 % Remove the macro name from \macrolist:
7417 \expandafter\let\csname#1\endcsname \relax
7418 \let\definedummyword\unmacrodo
7419 \xdef\macrolist{\macrolist}%
7422 \errmessage{Macro #1 not defined}%
7426 % Called by \do from \dounmacro on each macro. The idea is to omit any
7427 % macro definitions that have been changed to \relax.
7433 \noexpand\definedummyword \noexpand#1%
7437 % This makes use of the obscure feature that if the last token of a
7438 % <parameter list> is #, then the preceding argument is delimited by
7439 % an opening brace, and that opening brace is not consumed.
7440 \def\getargs#1{\getargsxxx#1{}}
7441 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7442 \def\getmacname#1 #2\relax{\macname={#1}}
7443 \def\getmacargs#1{\def\argl{#1}}
7445 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7446 \edef\texiatcatcode{\the\catcode`\@}
7447 \catcode `@=11\relax
7449 % Parse the optional {params} list. Set up \paramno and \paramlist
7450 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7451 % in the params list to some hook where the argument si to be expanded. If
7452 % there are less than 10 arguments that hook is to be replaced by ##N where N
7453 % is the position in that list, that is to say the macro arguments are to be
7454 % defined `a la TeX in the macro body.
7456 % That gets used by \mbodybackslash (above).
7458 % We need to get `macro parameter char #' into several definitions.
7459 % The technique used is stolen from LaTeX: let \hash be something
7460 % unexpandable, insert that wherever you need a #, and then redefine
7461 % it to # just before using the token list produced.
7463 % The same technique is used to protect \eatspaces till just before
7464 % the macro is used.
7466 % If there are 10 or more arguments, a different technique is used, where the
7467 % hook remains in the body, and when macro is to be expanded the body is
7468 % processed again to replace the arguments.
7470 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7471 % argument N value and then \edef the body (nothing else will expand because of
7472 % the catcode regime underwhich the body was input).
7474 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7475 % arguments, you need that no macro has more than 256 arguments, otherwise an
7476 % error is produced.
7477 \def\parsemargdef#1;{%
7478 \paramno=0\def\paramlist{}%
7480 \let\xeatspaces\relax
7481 \parsemargdefxxx#1,;,%
7482 % In case that there are 10 or more arguments we parse again the arguments
7483 % list to set new definitions for the \macarg.BLAH macros corresponding to
7484 % each BLAH argument. It was anyhow needed to parse already once this list
7485 % in order to count the arguments, and as macros with at most 9 arguments
7486 % are by far more frequent than macro with 10 or more arguments, defining
7487 % twice the \macarg.BLAH macros does not cost too much processing power.
7488 \ifnum\paramno<10\relax\else
7490 \parsemmanyargdef@@#1,;,% 10 or more arguments
7493 \def\parsemargdefxxx#1,{%
7494 \if#1;\let\next=\relax
7495 \else \let\next=\parsemargdefxxx
7496 \advance\paramno by 1
7497 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7498 {\xeatspaces{\hash\the\paramno}}%
7499 \edef\paramlist{\paramlist\hash\the\paramno,}%
7502 \def\parsemmanyargdef@@#1,{%
7503 \if#1;\let\next=\relax
7505 \let\next=\parsemmanyargdef@@
7506 \edef\tempb{\eatspaces{#1}}%
7507 \expandafter\def\expandafter\tempa
7508 \expandafter{\csname macarg.\tempb\endcsname}%
7509 % Note that we need some extra \noexpand\noexpand, this is because we
7510 % don't want \the to be expanded in the \parsermacbody as it uses an
7512 \expandafter\edef\tempa
7513 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7514 \advance\paramno by 1\relax
7517 % These two commands read recursive and nonrecursive macro bodies.
7518 % (They're different since rec and nonrec macros end differently.)
7521 \catcode `\@\texiatcatcode
7522 \long\def\parsemacbody#1@end macro%
7523 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7524 \long\def\parsermacbody#1@end rmacro%
7525 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7526 \catcode `\@=11\relax
7531 \long\def\nillm@{\nil@}%
7533 % This macro is expanded during the Texinfo macro expansion, not during its
7534 % definition. It gets all the arguments values and assigns them to macros
7537 % #1 is the macro name
7538 % #2 is the list of argument names
7539 % #3 is the list of argument values
7540 \def\getargvals@#1#2#3{%
7541 \def\macargdeflist@{}%
7542 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7543 \def\paramlist{#2,\nil@}%
7547 \def\argvaluelist{#3,\nil@}%
7558 \ifx\paramlist\nilm@
7559 % Some sanity check needed here that \argvaluelist is also empty.
7560 \ifx\argvaluelist\nillm@
7562 \errhelp = \EMsimple
7563 \errmessage{Too many arguments in macro `\macroname'!}%
7565 \let\next\macargexpandinbody@
7567 \ifx\argvaluelist\nillm@
7568 % No more arguments values passed to macro. Set remaining named-arg
7570 \let\next\setemptyargvalues@
7572 % pop current arg name into \@tempb
7573 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7574 \expandafter\@tempa\expandafter{\paramlist}%
7575 % pop current argument value into \@tempc
7576 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7577 \expandafter\@tempa\expandafter{\argvaluelist}%
7578 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7579 % First place the new argument macro definition into \@tempd
7580 \expandafter\macname\expandafter{\@tempc}%
7581 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7582 \expandafter\def\expandafter\@tempe\expandafter{%
7583 \csname macarg.\@tempb\endcsname}%
7584 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7585 \push@\@tempd\macargdeflist@
7586 \let\next\getargvals@@
7593 \expandafter\expandafter\expandafter\def
7594 \expandafter\expandafter\expandafter#2%
7595 \expandafter\expandafter\expandafter{%
7599 % Replace arguments by their values in the macro body, and place the result
7601 \def\macvalstoargs@{%
7602 % To do this we use the property that token registers that are \the'ed
7603 % within an \edef expand only once. So we are going to place all argument
7604 % values into respective token registers.
7606 % First we save the token context, and initialize argument numbering.
7609 % Then, for each argument number #N, we place the corresponding argument
7610 % value into a new token list register \toks#N
7611 \expandafter\putargsintokens@\saveparamlist@,;,%
7612 % Then, we expand the body so that argument are replaced by their
7613 % values. The trick for values not to be expanded themselves is that they
7614 % are within tokens and that tokens expand only once in an \edef .
7615 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7616 % Now we restore the token stack pointer to free the token list registers
7617 % which we have used, but we make sure that expanded body is saved after
7621 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7624 \def\macargexpandinbody@{%
7625 %% Define the named-macro outside of this group and then close this group.
7629 % First the replace in body the macro arguments by their values, the result
7632 % Then we point at the \norecurse or \gobble (for recursive) macro value
7634 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7635 % Depending on whether it is recursive or not, we need some tailing
7642 % And now we do the real job:
7643 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7647 \def\putargsintokens@#1,{%
7648 \if#1;\let\next\relax
7650 \let\next\putargsintokens@
7651 % First we allocate the new token list register, and give it a temporary
7653 \toksdef\@tempb\the\paramno
7654 % Then we place the argument value into that token list register.
7655 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7656 \expandafter\@tempb\expandafter{\@tempa}%
7657 \advance\paramno by 1\relax
7662 % Save the token stack pointer into macro #1
7663 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7664 % Restore the token stack pointer from number in macro #1
7665 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7666 % newtoks that can be used non \outer .
7667 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7669 % Tailing missing arguments are set to empty
7670 \def\setemptyargvalues@{%
7671 \ifx\paramlist\nilm@
7672 \let\next\macargexpandinbody@
7674 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7675 \let\next\setemptyargvalues@
7680 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7681 \expandafter\def\expandafter\@tempa\expandafter{%
7682 \expandafter\def\csname macarg.#1\endcsname{}}%
7683 \push@\@tempa\macargdeflist@
7687 % #1 is the element target macro
7688 % #2 is the list macro
7689 % #3,#4\endargs@ is the list value
7690 \def\pop@#1#2#3,#4\endargs@{%
7694 \long\def\longpop@#1#2#3,#4\endargs@{%
7699 % This defines a Texinfo @macro. There are eight cases: recursive and
7700 % nonrecursive macros of zero, one, up to nine, and many arguments.
7701 % Much magic with \expandafter here.
7702 % \xdef is used so that macro definitions will survive the file
7703 % they're defined in; @include reads the file inside a group.
7706 \let\hash=##% convert placeholders to macro parameter chars
7710 \expandafter\xdef\csname\the\macname\endcsname{%
7711 \noexpand\scanmacro{\temp}}%
7713 \expandafter\xdef\csname\the\macname\endcsname{%
7714 \bgroup\noexpand\macroargctxt
7715 \noexpand\braceorline
7716 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7717 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7718 \egroup\noexpand\scanmacro{\temp}}%
7720 \ifnum\paramno<10\relax % at most 9
7721 \expandafter\xdef\csname\the\macname\endcsname{%
7722 \bgroup\noexpand\macroargctxt
7723 \noexpand\csname\the\macname xx\endcsname}%
7724 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7725 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7726 \expandafter\expandafter
7728 \expandafter\expandafter
7729 \csname\the\macname xxx\endcsname
7730 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7732 \expandafter\xdef\csname\the\macname\endcsname{%
7733 \noexpand\getargvals@{\the\macname}{\argl}%
7735 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7736 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7742 \expandafter\xdef\csname\the\macname\endcsname{%
7743 \noexpand\norecurse{\the\macname}%
7744 \noexpand\scanmacro{\temp}\egroup}%
7746 \expandafter\xdef\csname\the\macname\endcsname{%
7747 \bgroup\noexpand\macroargctxt
7748 \noexpand\braceorline
7749 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7750 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7752 \noexpand\norecurse{\the\macname}%
7753 \noexpand\scanmacro{\temp}\egroup}%
7755 \ifnum\paramno<10\relax
7756 \expandafter\xdef\csname\the\macname\endcsname{%
7757 \bgroup\noexpand\macroargctxt
7758 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7759 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7760 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7761 \expandafter\expandafter
7763 \expandafter\expandafter
7764 \csname\the\macname xxx\endcsname
7767 \noexpand\norecurse{\the\macname}%
7768 \noexpand\scanmacro{\temp}\egroup}%
7770 \expandafter\xdef\csname\the\macname\endcsname{%
7771 \noexpand\getargvals@{\the\macname}{\argl}%
7773 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7774 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7779 \catcode `\@\texiatcatcode\relax
7781 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7783 % \braceorline decides whether the next nonwhitespace character is a
7784 % {. If so it reads up to the closing }, if not, it reads the whole
7785 % line. Whatever was read is then fed to the next control sequence
7786 % as an argument (by \parsebrace or \parsearg).
7788 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7789 \def\braceorlinexxx{%
7790 \ifx\nchar\bgroup\else
7791 \expandafter\parsearg
7796 % We need some trickery to remove the optional spaces around the equal
7797 % sign. Make them active and then expand them all to nothing.
7799 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7800 \def\aliasxxx #1{\aliasyyy#1\relax}
7801 \def\aliasyyy #1=#2\relax{%
7803 \expandafter\let\obeyedspace=\empty
7804 \addtomacrolist{#1}%
7805 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7811 \message{cross references,}
7814 \newif\ifhavexrefs % True if xref values are known.
7815 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7817 % @inforef is relatively simple.
7818 \def\inforef #1{\inforefzzz #1,,,,**}
7819 \def\inforefzzz #1,#2,#3,#4**{%
7820 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7821 node \samp{\ignorespaces#1{}}}
7823 % @node's only job in TeX is to define \lastnode, which is used in
7824 % cross-references. The @node line might or might not have commas, and
7825 % might or might not have spaces before the first comma, like:
7826 % @node foo , bar , ...
7827 % We don't want such trailing spaces in the node name.
7829 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7831 % also remove a trailing comma, in case of something like this:
7832 % @node Help-Cross, , , Cross-refs
7833 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7834 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7837 \let\lastnode=\empty
7839 % Write a cross-reference definition for the current node. #1 is the
7840 % type (Ynumbered, Yappendix, Ynothing).
7843 \ifx\lastnode\empty\else
7844 \setref{\lastnode}{#1}%
7845 \global\let\lastnode=\empty
7849 % @anchor{NAME} -- define xref target at arbitrary point.
7851 \newcount\savesfregister
7853 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7854 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7855 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7857 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7858 % anchor), which consists of three parts:
7859 % 1) NAME-title - the current sectioning name taken from \lastsection,
7860 % or the anchor name.
7861 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7862 % empty for anchors.
7863 % 3) NAME-pg - the page number.
7865 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7866 % floats, there is an additional part, which is not written here:
7867 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7873 \atdummies % preserve commands, but don't expand them
7874 \edef\writexrdef##1##2{%
7875 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7876 ##1}{##2}}% these are parameters of \writexrdef
7878 \toks0 = \expandafter{\lastsection}%
7879 \immediate \writexrdef{title}{\the\toks0 }%
7880 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7881 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7886 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7887 % automatically in xrefs, if the third arg is not explicitly specified.
7888 % This was provided as a "secret" @set xref-automatic-section-title
7889 % variable, now it's official.
7891 \parseargdef\xrefautomaticsectiontitle{%
7894 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7896 \else\ifx\temp\offword
7897 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7900 \errhelp = \EMsimple
7901 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7907 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7908 % the node name, #2 the name of the Info cross-reference, #3 the printed
7909 % node name, #4 the name of the Info file, #5 the name of the printed
7910 % manual. All but the node name can be omitted.
7912 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7913 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7914 \def\ref#1{\xrefX[#1,,,,,,,]}
7917 \newbox\printedrefnamebox
7918 \newbox\infofilenamebox
7919 \newbox\printedmanualbox
7921 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7924 % Get args without leading/trailing spaces.
7925 \def\printedrefname{\ignorespaces #3}%
7926 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7928 \def\infofilename{\ignorespaces #4}%
7929 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7931 \def\printedmanual{\ignorespaces #5}%
7932 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7934 % If the printed reference name (arg #3) was not explicitly given in
7935 % the @xref, figure out what we want to use.
7936 \ifdim \wd\printedrefnamebox = 0pt
7937 % No printed node name was explicitly given.
7938 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7939 % Not auto section-title: use node name inside the square brackets.
7940 \def\printedrefname{\ignorespaces #1}%
7942 % Auto section-title: use chapter/section title inside
7943 % the square brackets if we have it.
7944 \ifdim \wd\printedmanualbox > 0pt
7945 % It is in another manual, so we don't have it; use node name.
7946 \def\printedrefname{\ignorespaces #1}%
7949 % We (should) know the real title if we have the xref values.
7950 \def\printedrefname{\refx{#1-title}{}}%
7952 % Otherwise just copy the Info node name.
7953 \def\printedrefname{\ignorespaces #1}%
7959 % Make link in pdf output.
7963 \makevalueexpandable
7964 % This expands tokens, so do it after making catcode changes, so _
7965 % etc. don't get their TeX definitions. This ignores all spaces in
7966 % #4, including (wrongly) those in the middle of the filename.
7969 % This (wrongly) does not take account of leading or trailing
7970 % spaces in #1, which should be ignored.
7971 \edef\pdfxrefdest{#1}%
7972 \ifx\pdfxrefdest\empty
7973 \def\pdfxrefdest{Top}% no empty targets
7975 \txiescapepdf\pdfxrefdest % escape PDF special chars
7979 \startlink attr{/Border [0 0 0]}%
7980 \ifnum\filenamelength>0
7981 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7983 goto name{\pdfmkpgn{\pdfxrefdest}}%
7986 \setcolor{\linkcolor}%
7989 % Float references are printed completely differently: "Figure 1.2"
7990 % instead of "[somenode], p.3". We distinguish them by the
7991 % LABEL-title being set to a magic string.
7993 % Have to otherify everything special to allow the \csname to
7994 % include an _ in the xref name, etc.
7997 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7998 \csname XR#1-title\endcsname
8000 \iffloat\Xthisreftitle
8001 % If the user specified the print name (third arg) to the ref,
8002 % print it instead of our usual "Figure 1.2".
8003 \ifdim\wd\printedrefnamebox = 0pt
8009 % If the user also gave the printed manual name (fifth arg), append
8011 \ifdim \wd\printedmanualbox > 0pt
8012 \space \putwordin{} \cite{\printedmanual}%
8015 % node/anchor (non-float) references.
8017 % If we use \unhbox to print the node names, TeX does not insert
8018 % empty discretionaries after hyphens, which means that it will not
8019 % find a line break at a hyphen in a node names. Since some manuals
8020 % are best written with fairly long node names, containing hyphens,
8021 % this is a loss. Therefore, we give the text of the node name
8022 % again, so it is as if TeX is seeing it for the first time.
8024 \ifdim \wd\printedmanualbox > 0pt
8025 % Cross-manual reference with a printed manual name.
8027 \crossmanualxref{\cite{\printedmanual\unskip}}%
8029 \else\ifdim \wd\infofilenamebox > 0pt
8030 % Cross-manual reference with only an info filename (arg 4), no
8031 % printed manual name (arg 5). This is essentially the same as
8032 % the case above; we output the filename, since we have nothing else.
8034 \crossmanualxref{\code{\infofilename\unskip}}%
8037 % Reference within this manual.
8039 % _ (for example) has to be the character _ for the purposes of the
8040 % control sequence corresponding to the node, but it has to expand
8041 % into the usual \leavevmode...\vrule stuff for purposes of
8042 % printing. So we \turnoffactive for the \refx-snt, back on for the
8043 % printing, back off for the \refx-pg.
8045 % Only output a following space if the -snt ref is nonempty; for
8046 % @unnumbered and @anchor, it won't be.
8047 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8048 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8050 % output the `[mynode]' via the macro below so it can be overridden.
8051 \xrefprintnodename\printedrefname
8053 % But we always want a comma and a space:
8056 % output the `page 3'.
8057 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8063 % Output a cross-manual xref to #1. Used just above (twice).
8065 % Only include the text "Section ``foo'' in" if the foo is neither
8066 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8067 % "see The Foo Manual", the idea being to refer to the whole manual.
8069 % But, this being TeX, we can't easily compare our node name against the
8070 % string "Top" while ignoring the possible spaces before and after in
8071 % the input. By adding the arbitrary 7sp below, we make it much less
8072 % likely that a real node name would have the same width as "Top" (e.g.,
8073 % in a monospaced font). Hopefully it will never happen in practice.
8075 % For the same basic reason, we retypeset the "Top" at every
8076 % reference, since the current font is indeterminate.
8078 \def\crossmanualxref#1{%
8079 \setbox\toprefbox = \hbox{Top\kern7sp}%
8080 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8081 \ifdim \wd2 > 7sp % nonempty?
8082 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8083 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8089 % This macro is called from \xrefX for the `[nodename]' part of xref
8090 % output. It's a separate macro only so it can be changed more easily,
8091 % since square brackets don't work well in some documents. Particularly
8092 % one that Bob is working on :).
8094 \def\xrefprintnodename#1{[#1]}
8096 % Things referred to by \setref.
8102 \putwordChapter@tie \the\chapno
8103 \else \ifnum\subsecno=0
8104 \putwordSection@tie \the\chapno.\the\secno
8105 \else \ifnum\subsubsecno=0
8106 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8108 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8113 \putwordAppendix@tie @char\the\appendixno{}%
8114 \else \ifnum\subsecno=0
8115 \putwordSection@tie @char\the\appendixno.\the\secno
8116 \else \ifnum\subsubsecno=0
8117 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8120 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8124 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8125 % If its value is nonempty, SUFFIX is output afterward.
8131 \expandafter\global\expandafter\let\expandafter\thisrefX
8132 \csname XR#1\endcsname
8135 % If not defined, say something at least.
8136 \angleleft un\-de\-fined\angleright
8139 {\toks0 = {#1}% avoid expansion of possibly-complex value
8140 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8143 \global\warnedxrefstrue
8144 \message{Cross reference values unknown; you must run TeX again.}%
8149 % It's defined, so just use it.
8152 #2% Output the suffix in any case.
8155 % This is the macro invoked by entries in the aux file. Usually it's
8156 % just a \def (we prepend XR to the control sequence name to avoid
8157 % collisions). But if this is a float type, we have more work to do.
8160 {% The node name might contain 8-bit characters, which in our current
8161 % implementation are changed to commands like @'e. Don't let these
8162 % mess up the control sequence name.
8165 \xdef\safexrefname{#1}%
8168 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8170 % Was that xref control sequence that we just defined for a float?
8171 \expandafter\iffloat\csname XR\safexrefname\endcsname
8172 % it was a float, and we have the (safe) float type in \iffloattype.
8173 \expandafter\let\expandafter\floatlist
8174 \csname floatlist\iffloattype\endcsname
8176 % Is this the first time we've seen this float type?
8177 \expandafter\ifx\floatlist\relax
8178 \toks0 = {\do}% yes, so just \do
8180 % had it before, so preserve previous elements in list.
8181 \toks0 = \expandafter{\floatlist\do}%
8184 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8185 % for later use in \listoffloats.
8186 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8191 % Read the last existing aux file, if any. No error if none exists.
8194 \openin 1 \jobname.aux
8197 \global\havexrefstrue
8202 \def\setupdatafile{%
8203 \catcode`\^^@=\other
8204 \catcode`\^^A=\other
8205 \catcode`\^^B=\other
8206 \catcode`\^^C=\other
8207 \catcode`\^^D=\other
8208 \catcode`\^^E=\other
8209 \catcode`\^^F=\other
8210 \catcode`\^^G=\other
8211 \catcode`\^^H=\other
8212 \catcode`\^^K=\other
8213 \catcode`\^^L=\other
8214 \catcode`\^^N=\other
8215 \catcode`\^^P=\other
8216 \catcode`\^^Q=\other
8217 \catcode`\^^R=\other
8218 \catcode`\^^S=\other
8219 \catcode`\^^T=\other
8220 \catcode`\^^U=\other
8221 \catcode`\^^V=\other
8222 \catcode`\^^W=\other
8223 \catcode`\^^X=\other
8224 \catcode`\^^Z=\other
8225 \catcode`\^^[=\other
8226 \catcode`\^^\=\other
8227 \catcode`\^^]=\other
8228 \catcode`\^^^=\other
8229 \catcode`\^^_=\other
8230 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8231 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8232 % supported in the main text, it doesn't seem desirable. Furthermore,
8233 % that is not enough: for node names that actually contain a ^
8234 % character, we would end up writing a line like this: 'xrdef {'hat
8235 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8236 % argument, and \hat is not an expandable control sequence. It could
8237 % all be worked out, but why? Either we support ^^ or we don't.
8239 % The other change necessary for this was to define \auxhat:
8240 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8241 % and then to call \auxhat in \setq.
8245 % Special characters. Should be turned off anyway, but...
8258 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8260 % This is to support \ in node names and titles, since the \
8261 % characters end up in a \csname. It's easier than
8262 % leaving it active and making its active definition an actual \
8263 % character. What I don't understand is why it works in the *value*
8264 % of the xrdef. Seems like it should be a catcode12 \, and that
8265 % should not typeset properly. But it works, so I'm moving on for
8266 % now. --karl, 15jan04.
8269 % Make the characters 128-255 be printing characters.
8273 \catcode\count1=\other
8274 \advance\count1 by 1
8275 \ifnum \count1<256 \loop \fi
8279 % @ is our escape character in .aux files, and we need braces.
8285 \def\readdatafile#1{%
8292 \message{insertions,}
8293 % including footnotes.
8295 \newcount \footnoteno
8297 % The trailing space in the following definition for supereject is
8298 % vital for proper filling; pages come out unaligned when you do a
8299 % pagealignmacro call if that space before the closing brace is
8300 % removed. (Generally, numeric constants should always be followed by a
8301 % space to prevent strange expansion errors.)
8302 \def\supereject{\par\penalty -20000\footnoteno =0 }
8304 % @footnotestyle is meaningful for Info output only.
8305 \let\footnotestyle=\comment
8309 % Auto-number footnotes. Otherwise like plain.
8311 \let\indent=\ptexindent
8312 \let\noindent=\ptexnoindent
8313 \global\advance\footnoteno by \@ne
8314 \edef\thisfootno{$^{\the\footnoteno}$}%
8316 % In case the footnote comes at the end of a sentence, preserve the
8317 % extra spacing after we do the footnote number.
8319 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8321 % Remove inadvertent blank space before typesetting the footnote number.
8327 % Don't bother with the trickery in plain.tex to not require the
8328 % footnote text as a parameter. Our footnotes don't need to be so general.
8330 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8331 % \parseargline) fails inside footnotes because the tokens are fixed when
8332 % the footnote is read. --karl, 16nov96.
8335 \insert\footins\bgroup
8336 % We want to typeset this text as a normal paragraph, even if the
8337 % footnote reference occurs in (for example) a display environment.
8338 % So reset some parameters.
8340 \interlinepenalty\interfootnotelinepenalty
8341 \splittopskip\ht\strutbox % top baseline for broken footnotes
8342 \splitmaxdepth\dp\strutbox
8343 \floatingpenalty\@MM
8348 \parindent\defaultparindent
8352 % Because we use hanging indentation in footnotes, a @noindent appears
8353 % to exdent this text, so make it be a no-op. makeinfo does not use
8354 % hanging indentation so @noindent can still be needed within footnote
8355 % text after an @example or the like (not that this is good style).
8356 \let\noindent = \relax
8358 % Hang the footnote text off the number. Use \everypar in case the
8359 % footnote extends for more than one paragraph.
8360 \everypar = {\hang}%
8361 \textindent{\thisfootno}%
8363 % Don't crash into the line above the footnote text. Since this
8364 % expands into a box, it must come within the paragraph, lest it
8365 % provide a place where TeX can split the footnote.
8368 % Invoke rest of plain TeX footnote routine.
8369 \futurelet\next\fo@t
8371 }%end \catcode `\@=11
8373 % In case a @footnote appears in a vbox, save the footnote text and create
8374 % the real \insert just after the vbox finished. Otherwise, the insertion
8376 % Similarly, if a @footnote appears inside an alignment, save the footnote
8377 % text to a box and make the \insert when a row of the table is finished.
8378 % And the same can be done for other insert classes. --kasal, 16nov03.
8380 % Replace the \insert primitive by a cheating macro.
8381 % Deeper inside, just make sure that the saved insertions are not spilled
8384 \def\startsavinginserts{%
8385 \ifx \insert\ptexinsert
8386 \let\insert\saveinsert
8388 \let\checkinserts\relax
8392 % This \insert replacement works for both \insert\footins{foo} and
8393 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8396 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8397 \afterassignment\next
8398 % swallow the left brace
8401 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8402 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8404 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8406 \def\placesaveins#1{%
8407 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8411 % eat @SAVE -- beware, all of them have catcode \other:
8413 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8414 \gdef\gobblesave @SAVE{}
8418 \def\newsaveins #1{%
8419 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8422 \def\newsaveinsX #1{%
8423 \csname newbox\endcsname #1%
8424 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8429 \let\checkinserts\empty
8434 % @image. We use the macros from epsf.tex to support this.
8435 % If epsf.tex is not installed and @image is used, we complain.
8437 % Check for and read epsf.tex up front. If we read it only at @image
8438 % time, we might be inside a group, and then its definitions would get
8439 % undone and the next image would fail.
8440 \openin 1 = epsf.tex
8442 % Do not bother showing banner with epsf.tex v2.7k (available in
8443 % doc/epsf.tex and on ctan).
8444 \def\epsfannounce{\toks0 = }%
8449 % We will only complain once about lack of epsf.tex.
8450 \newif\ifwarnednoepsf
8451 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8452 work. It is also included in the Texinfo distribution, or you can get
8453 it from ftp://tug.org/tex/epsf.tex.}
8456 \ifx\epsfbox\thisisundefined
8457 \ifwarnednoepsf \else
8458 \errhelp = \noepsfhelp
8459 \errmessage{epsf.tex not found, images will be ignored}%
8460 \global\warnednoepsftrue
8463 \imagexxx #1,,,,,\finish
8467 % Arguments to @image:
8468 % #1 is (mandatory) image filename; we tack on .eps extension.
8469 % #2 is (optional) width, #3 is (optional) height.
8470 % #4 is (ignored optional) html alt text.
8471 % #5 is (ignored optional) extension.
8472 % #6 is just the usual extra ignored arg for parsing stuff.
8474 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8475 \catcode`\^^M = 5 % in case we're inside an example
8476 \normalturnoffactive % allow _ et al. in names
8477 % If the image is by itself, center it.
8480 \else \ifx\centersub\centerV
8481 % for @center @image, we need a vbox so we can have our vertical space
8483 \vbox\bgroup % vbox has better behavior than vtop herev
8488 % Usually we'll have text after the image which will insert
8489 % \parskip glue, so insert it here too to equalize the space
8491 \nobreak\vskip\parskip
8495 % Leave vertical mode so that indentation from an enclosing
8496 % environment such as @quotation is respected.
8497 % However, if we're at the top level, we don't want the
8498 % normal paragraph indentation.
8499 % On the other hand, if we are in the case of @center @image, we don't
8500 % want to start a paragraph, which will create a hsize-width box and
8501 % eradicate the centering.
8502 \ifx\centersub\centerV\else \noindent \fi
8506 \dopdfimage{#1}{#2}{#3}%
8508 % \epsfbox itself resets \epsf?size at each figure.
8509 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8510 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8515 \medskip % space after a standalone image
8517 \ifx\centersub\centerV \egroup \fi
8521 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8522 % etc. We don't actually implement floating yet, we always include the
8523 % float "here". But it seemed the best name for the future.
8525 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8527 % There may be a space before second and/or third parameter; delete it.
8528 \def\eatcommaspace#1, {#1,}
8530 % #1 is the optional FLOATTYPE, the text label for this float, typically
8531 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8532 % this float will not be numbered and cannot be referred to.
8534 % #2 is the optional xref label. Also must be present for the float to
8537 % #3 is the optional positioning argument; for now, it is ignored. It
8538 % will somehow specify the positions allowed to float to (here, top, bottom).
8540 % We keep a separate counter for each FLOATTYPE, which we reset at each
8541 % chapter-level command.
8542 \let\resetallfloatnos=\empty
8544 \def\dofloat#1,#2,#3,#4\finish{%
8545 \let\thiscaption=\empty
8546 \let\thisshortcaption=\empty
8548 % don't lose footnotes inside @float.
8550 % BEWARE: when the floats start float, we have to issue warning whenever an
8551 % insert appears inside a float which could possibly float. --kasal, 26may04
8555 % We can't be used inside a paragraph.
8560 \def\floatlabel{#2}%
8561 \def\floatloc{#3}% we do nothing with this yet.
8563 \ifx\floattype\empty
8564 \let\safefloattype=\empty
8567 % the floattype might have accents or other special characters,
8568 % but we need to use it in a control sequence name.
8571 \xdef\safefloattype{\floattype}%
8575 % If label is given but no type, we handle that as the empty type.
8576 \ifx\floatlabel\empty \else
8577 % We want each FLOATTYPE to be numbered separately (Figure 1,
8578 % Table 1, Figure 2, ...). (And if no label, no number.)
8580 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8581 \global\advance\floatno by 1
8584 % This magic value for \lastsection is output by \setref as the
8585 % XREFLABEL-title value. \xrefX uses it to distinguish float
8586 % labels (which have a completely different output format) from
8587 % node and anchor labels. And \xrdef uses it to construct the
8590 \edef\lastsection{\floatmagic=\safefloattype}%
8591 \setref{\floatlabel}{Yfloat}%
8595 % start with \parskip glue, I guess.
8598 % Don't suppress indentation if a float happens to start a section.
8599 \restorefirstparagraphindent
8602 % we have these possibilities:
8603 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8604 % @float Foo,lbl & no caption: Foo 1.1
8605 % @float Foo & @caption{Cap}: Foo: Cap
8606 % @float Foo & no caption: Foo
8607 % @float ,lbl & Caption{Cap}: 1.1: Cap
8608 % @float ,lbl & no caption: 1.1
8609 % @float & @caption{Cap}: Cap
8610 % @float & no caption:
8613 \let\floatident = \empty
8615 % In all cases, if we have a float type, it comes first.
8616 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8618 % If we have an xref label, the number comes next.
8619 \ifx\floatlabel\empty \else
8620 \ifx\floattype\empty \else % if also had float type, need tie first.
8621 \appendtomacro\floatident{\tie}%
8624 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8627 % Start the printed caption with what we've constructed in
8628 % \floatident, but keep it separate; we need \floatident again.
8629 \let\captionline = \floatident
8631 \ifx\thiscaption\empty \else
8632 \ifx\floatident\empty \else
8633 \appendtomacro\captionline{: }% had ident, so need a colon between
8637 \appendtomacro\captionline{\scanexp\thiscaption}%
8640 % If we have anything to print, print it, with space before.
8641 % Eventually this needs to become an \insert.
8642 \ifx\captionline\empty \else
8646 % Space below caption.
8650 % If have an xref label, write the list of floats info. Do this
8651 % after the caption, to avoid chance of it being a breakpoint.
8652 \ifx\floatlabel\empty \else
8653 % Write the text that goes in the lof to the aux file as
8654 % \floatlabel-lof. Besides \floatident, we include the short
8655 % caption if specified, else the full caption if specified, else nothing.
8659 % since we read the caption text in the macro world, where ^^M
8660 % is turned into a normal character, we have to scan it back, so
8661 % we don't write the literal three characters "^^M" into the aux file.
8663 \xdef\noexpand\gtemp{%
8664 \ifx\thisshortcaption\empty
8671 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8672 \ifx\gtemp\empty \else : \gtemp \fi}}%
8675 \egroup % end of \vtop
8677 % place the captured inserts
8679 % BEWARE: when the floats start floating, we have to issue warning
8680 % whenever an insert appears inside a float which could possibly
8681 % float. --kasal, 26may04
8686 % Append the tokens #2 to the definition of macro #1, not expanding either.
8688 \def\appendtomacro#1#2{%
8689 \expandafter\def\expandafter#1\expandafter{#1#2}%
8692 % @caption, @shortcaption
8694 \def\caption{\docaption\thiscaption}
8695 \def\shortcaption{\docaption\thisshortcaption}
8696 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8697 \def\defcaption#1#2{\egroup \def#1{#2}}
8699 % The parameter is the control sequence identifying the counter we are
8700 % going to use. Create it if it doesn't exist and assign it to \floatno.
8703 % Haven't seen this figure type before.
8704 \csname newcount\endcsname #1%
8706 % Remember to reset this floatno at the next chap.
8707 \expandafter\gdef\expandafter\resetallfloatnos
8708 \expandafter{\resetallfloatnos #1=0 }%
8713 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8714 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8715 % first read the @float command.
8717 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8719 % Magic string used for the XREFLABEL-title value, so \xrefX can
8720 % distinguish floats from other xref types.
8721 \def\floatmagic{!!float!!}
8723 % #1 is the control sequence we are passed; we expand into a conditional
8724 % which is true if #1 represents a float ref. That is, the magic
8725 % \lastsection value which we \setref above.
8727 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8729 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8730 % (safe) float type for this float. We set \iffloattype to #2.
8732 \def\doiffloat#1=#2=#3\finish{%
8734 \def\iffloattype{#2}%
8735 \ifx\temp\floatmagic
8738 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8740 \parseargdef\listoffloats{%
8741 \def\floattype{#1}% floattype
8743 % the floattype might have accents or other special characters,
8744 % but we need to use it in a control sequence name.
8747 \xdef\safefloattype{\floattype}%
8750 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8751 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8753 % if the user said @listoffloats foo but never @float foo.
8754 \message{\linenumber No `\safefloattype' floats to list.}%
8758 \leftskip=\tocindent % indent these entries like a toc
8759 \let\do=\listoffloatsdo
8760 \csname floatlist\safefloattype\endcsname
8765 % This is called on each entry in a list of floats. We're passed the
8766 % xref label, in the form LABEL-title, which is how we save it in the
8767 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8768 % has the text we're supposed to typeset here.
8770 % Figures without xref labels will not be included in the list (since
8771 % they won't appear in the aux file).
8773 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8774 \def\listoffloatsdoentry#1-title\finish{{%
8775 % Can't fully expand XR#1-lof because it can contain anything. Just
8776 % pass the control sequence. On the other hand, XR#1-pg is just the
8777 % page number, and we want to fully expand that so we can get a link
8779 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8781 % use the same \entry macro we use to generate the TOC and index.
8782 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8787 \message{localization,}
8789 % For single-language documents, @documentlanguage is usually given very
8790 % early, just after @documentencoding. Single argument is the language
8791 % (de) or locale (de_DE) abbreviation.
8794 \catcode`\_ = \active
8796 \parseargdef\documentlanguage{\begingroup
8797 \let_=\normalunderscore % normal _ character for filenames
8798 \tex % read txi-??.tex file in plain TeX.
8799 % Read the file by the name they passed if it exists.
8800 \openin 1 txi-#1.tex
8802 \documentlanguagetrywithoutunderscore{#1_\finish}%
8804 \globaldefs = 1 % everything in the txi-LL files needs to persist
8808 \endgroup % end raw TeX
8811 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8814 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8815 \openin 1 txi-#1.tex
8817 \errhelp = \nolanghelp
8818 \errmessage{Cannot read language file txi-#1.tex}%
8820 \globaldefs = 1 % everything in the txi-LL files needs to persist
8825 }% end of special _ catcode
8827 \newhelp\nolanghelp{The given language definition file cannot be found or
8828 is empty. Maybe you need to install it? Putting it in the current
8829 directory should work if nowhere else does.}
8831 % This macro is called from txi-??.tex files; the first argument is the
8832 % \language name to set (without the "\lang@" prefix), the second and
8833 % third args are \{left,right}hyphenmin.
8835 % The language names to pass are determined when the format is built.
8836 % See the etex.log file created at that time, e.g.,
8837 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8839 % With TeX Live 2008, etex now includes hyphenation patterns for all
8840 % available languages. This means we can support hyphenation in
8841 % Texinfo, at least to some extent. (This still doesn't solve the
8842 % accented characters problem.)
8845 \def\txisetlanguage#1#2#3{%
8846 % do not set the language if the name is undefined in the current TeX.
8847 \expandafter\ifx\csname lang@#1\endcsname \relax
8848 \message{no patterns for #1}%
8850 \global\language = \csname lang@#1\endcsname
8852 % but there is no harm in adjusting the hyphenmin values regardless.
8853 \global\lefthyphenmin = #2\relax
8854 \global\righthyphenmin = #3\relax
8857 % Helpers for encodings.
8858 % Set the catcode of characters 128 through 255 to the specified number.
8860 \def\setnonasciicharscatcode#1{%
8862 \loop\ifnum\count255<256
8863 \global\catcode\count255=#1\relax
8864 \advance\count255 by 1
8868 \def\setnonasciicharscatcodenonglobal#1{%
8870 \loop\ifnum\count255<256
8871 \catcode\count255=#1\relax
8872 \advance\count255 by 1
8876 % @documentencoding sets the definition of non-ASCII characters
8877 % according to the specified encoding.
8879 \parseargdef\documentencoding{%
8880 % Encoding being declared for the document.
8881 \def\declaredencoding{\csname #1.enc\endcsname}%
8883 % Supported encodings: names converted to tokens in order to be able
8884 % to compare them with \ifx.
8885 \def\ascii{\csname US-ASCII.enc\endcsname}%
8886 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8887 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8888 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8889 \def\utfeight{\csname UTF-8.enc\endcsname}%
8891 \ifx \declaredencoding \ascii
8894 \else \ifx \declaredencoding \lattwo
8895 \setnonasciicharscatcode\active
8898 \else \ifx \declaredencoding \latone
8899 \setnonasciicharscatcode\active
8902 \else \ifx \declaredencoding \latnine
8903 \setnonasciicharscatcode\active
8906 \else \ifx \declaredencoding \utfeight
8907 \setnonasciicharscatcode\active
8911 \message{Unknown document encoding #1, ignoring.}%
8920 % A message to be logged when using a character that isn't available
8921 % the default font encoding (OT1).
8923 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8925 % Take account of \c (plain) vs. \, (Texinfo) difference.
8926 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8928 % First, make active non-ASCII characters in order for them to be
8929 % correctly categorized when TeX reads the replacement text of
8930 % macros containing the character definitions.
8931 \setnonasciicharscatcode\active
8933 % Latin1 (ISO-8859-1) character definitions.
8934 \def\latonechardefs{%
8936 \gdef^^a1{\exclamdown}
8937 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8938 \gdef^^a3{{\pounds}}
8939 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8940 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8941 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8944 \gdef^^a9{\copyright}
8946 \gdef^^ab{\guillemetleft}
8949 \gdef^^ae{\registeredsymbol}
8952 \gdef^^b0{\textdegree}
8961 \gdef^^b8{\cedilla\ }
8965 \gdef^^bb{\guillemetright}
8966 \gdef^^bc{$1\over4$}
8967 \gdef^^bd{$1\over2$}
8968 \gdef^^be{$3\over4$}
8969 \gdef^^bf{\questiondown}
8976 \gdef^^c5{\ringaccent A}
8978 \gdef^^c7{\cedilla C}
9010 \gdef^^e5{\ringaccent a}
9012 \gdef^^e7{\cedilla c}
9017 \gdef^^ec{\`{\dotless i}}
9018 \gdef^^ed{\'{\dotless i}}
9019 \gdef^^ee{\^{\dotless i}}
9020 \gdef^^ef{\"{\dotless i}}
9040 % Latin9 (ISO-8859-15) encoding character definitions.
9041 \def\latninechardefs{%
9042 % Encoding is almost identical to Latin1.
9055 % Latin2 (ISO-8859-2) character definitions.
9056 \def\lattwochardefs{%
9058 \gdef^^a1{\ogonek{A}}
9061 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9067 \gdef^^aa{\cedilla S}
9072 \gdef^^af{\dotaccent Z}
9074 \gdef^^b0{\textdegree}
9075 \gdef^^b1{\ogonek{a}}
9076 \gdef^^b2{\ogonek{ }}
9082 \gdef^^b8{\cedilla\ }
9084 \gdef^^ba{\cedilla s}
9089 \gdef^^bf{\dotaccent z}
9098 \gdef^^c7{\cedilla C}
9101 \gdef^^ca{\ogonek{E}}
9117 \gdef^^d9{\ringaccent U}
9122 \gdef^^de{\cedilla T}
9132 \gdef^^e7{\cedilla c}
9135 \gdef^^ea{\ogonek{e}}
9138 \gdef^^ed{\'{\dotless{i}}}
9139 \gdef^^ee{\^{\dotless{i}}}
9151 \gdef^^f9{\ringaccent u}
9156 \gdef^^fe{\cedilla t}
9157 \gdef^^ff{\dotaccent{}}
9160 % UTF-8 character definitions.
9162 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9163 % changes for Texinfo conventions. It is included here under the GPL by
9164 % permission from Frank Mittelbach and the LaTeX team.
9170 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9171 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9173 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9174 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9176 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9177 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9179 \gdef\UTFviiiDefined#1{%
9181 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9192 \global\catcode\countUTFx\active
9193 \uccode`\~\countUTFx
9194 \uppercase\expandafter{\UTFviiiTmp}%
9195 \advance\countUTFx by 1
9196 \ifnum\countUTFx < \countUTFy
9197 \expandafter\UTFviiiLoop
9203 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9209 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9215 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9228 \gdef\DeclareUnicodeCharacter#1#2{%
9229 \countUTFz = "#1\relax
9230 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9233 \def\UTFviiiTwoOctets##1##2{%
9234 \csname u8:##1\string ##2\endcsname}%
9235 \def\UTFviiiThreeOctets##1##2##3{%
9236 \csname u8:##1\string ##2\string ##3\endcsname}%
9237 \def\UTFviiiFourOctets##1##2##3##4{%
9238 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9239 \expandafter\expandafter\expandafter\expandafter
9240 \expandafter\expandafter\expandafter
9241 \gdef\UTFviiiTmp{#2}%
9244 \gdef\parseXMLCharref{%
9245 \ifnum\countUTFz < "A0\relax
9246 \errhelp = \EMsimple
9247 \errmessage{Cannot define Unicode char value < 00A0}%
9248 \else\ifnum\countUTFz < "800\relax
9250 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9251 \else\ifnum\countUTFz < "10000\relax
9254 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9259 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9263 \gdef\parseUTFviiiA#1{%
9264 \countUTFx = \countUTFz
9265 \divide\countUTFz by 64
9266 \countUTFy = \countUTFz
9267 \multiply\countUTFz by 64
9268 \advance\countUTFx by -\countUTFz
9269 \advance\countUTFx by 128
9270 \uccode `#1\countUTFx
9271 \countUTFz = \countUTFy}
9273 \gdef\parseUTFviiiB#1#2#3#4{%
9274 \advance\countUTFz by "#10\relax
9275 \uccode `#3\countUTFz
9276 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9279 \def\utfeightchardefs{%
9280 \DeclareUnicodeCharacter{00A0}{\tie}
9281 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9282 \DeclareUnicodeCharacter{00A3}{\pounds}
9283 \DeclareUnicodeCharacter{00A8}{\"{ }}
9284 \DeclareUnicodeCharacter{00A9}{\copyright}
9285 \DeclareUnicodeCharacter{00AA}{\ordf}
9286 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9287 \DeclareUnicodeCharacter{00AD}{\-}
9288 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9289 \DeclareUnicodeCharacter{00AF}{\={ }}
9291 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9292 \DeclareUnicodeCharacter{00B4}{\'{ }}
9293 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9294 \DeclareUnicodeCharacter{00BA}{\ordm}
9295 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9296 \DeclareUnicodeCharacter{00BF}{\questiondown}
9298 \DeclareUnicodeCharacter{00C0}{\`A}
9299 \DeclareUnicodeCharacter{00C1}{\'A}
9300 \DeclareUnicodeCharacter{00C2}{\^A}
9301 \DeclareUnicodeCharacter{00C3}{\~A}
9302 \DeclareUnicodeCharacter{00C4}{\"A}
9303 \DeclareUnicodeCharacter{00C5}{\AA}
9304 \DeclareUnicodeCharacter{00C6}{\AE}
9305 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9306 \DeclareUnicodeCharacter{00C8}{\`E}
9307 \DeclareUnicodeCharacter{00C9}{\'E}
9308 \DeclareUnicodeCharacter{00CA}{\^E}
9309 \DeclareUnicodeCharacter{00CB}{\"E}
9310 \DeclareUnicodeCharacter{00CC}{\`I}
9311 \DeclareUnicodeCharacter{00CD}{\'I}
9312 \DeclareUnicodeCharacter{00CE}{\^I}
9313 \DeclareUnicodeCharacter{00CF}{\"I}
9315 \DeclareUnicodeCharacter{00D0}{\DH}
9316 \DeclareUnicodeCharacter{00D1}{\~N}
9317 \DeclareUnicodeCharacter{00D2}{\`O}
9318 \DeclareUnicodeCharacter{00D3}{\'O}
9319 \DeclareUnicodeCharacter{00D4}{\^O}
9320 \DeclareUnicodeCharacter{00D5}{\~O}
9321 \DeclareUnicodeCharacter{00D6}{\"O}
9322 \DeclareUnicodeCharacter{00D8}{\O}
9323 \DeclareUnicodeCharacter{00D9}{\`U}
9324 \DeclareUnicodeCharacter{00DA}{\'U}
9325 \DeclareUnicodeCharacter{00DB}{\^U}
9326 \DeclareUnicodeCharacter{00DC}{\"U}
9327 \DeclareUnicodeCharacter{00DD}{\'Y}
9328 \DeclareUnicodeCharacter{00DE}{\TH}
9329 \DeclareUnicodeCharacter{00DF}{\ss}
9331 \DeclareUnicodeCharacter{00E0}{\`a}
9332 \DeclareUnicodeCharacter{00E1}{\'a}
9333 \DeclareUnicodeCharacter{00E2}{\^a}
9334 \DeclareUnicodeCharacter{00E3}{\~a}
9335 \DeclareUnicodeCharacter{00E4}{\"a}
9336 \DeclareUnicodeCharacter{00E5}{\aa}
9337 \DeclareUnicodeCharacter{00E6}{\ae}
9338 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9339 \DeclareUnicodeCharacter{00E8}{\`e}
9340 \DeclareUnicodeCharacter{00E9}{\'e}
9341 \DeclareUnicodeCharacter{00EA}{\^e}
9342 \DeclareUnicodeCharacter{00EB}{\"e}
9343 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9344 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9345 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9346 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9348 \DeclareUnicodeCharacter{00F0}{\dh}
9349 \DeclareUnicodeCharacter{00F1}{\~n}
9350 \DeclareUnicodeCharacter{00F2}{\`o}
9351 \DeclareUnicodeCharacter{00F3}{\'o}
9352 \DeclareUnicodeCharacter{00F4}{\^o}
9353 \DeclareUnicodeCharacter{00F5}{\~o}
9354 \DeclareUnicodeCharacter{00F6}{\"o}
9355 \DeclareUnicodeCharacter{00F8}{\o}
9356 \DeclareUnicodeCharacter{00F9}{\`u}
9357 \DeclareUnicodeCharacter{00FA}{\'u}
9358 \DeclareUnicodeCharacter{00FB}{\^u}
9359 \DeclareUnicodeCharacter{00FC}{\"u}
9360 \DeclareUnicodeCharacter{00FD}{\'y}
9361 \DeclareUnicodeCharacter{00FE}{\th}
9362 \DeclareUnicodeCharacter{00FF}{\"y}
9364 \DeclareUnicodeCharacter{0100}{\=A}
9365 \DeclareUnicodeCharacter{0101}{\=a}
9366 \DeclareUnicodeCharacter{0102}{\u{A}}
9367 \DeclareUnicodeCharacter{0103}{\u{a}}
9368 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9369 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9370 \DeclareUnicodeCharacter{0106}{\'C}
9371 \DeclareUnicodeCharacter{0107}{\'c}
9372 \DeclareUnicodeCharacter{0108}{\^C}
9373 \DeclareUnicodeCharacter{0109}{\^c}
9374 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9375 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9376 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9377 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9378 \DeclareUnicodeCharacter{010C}{\v{C}}
9379 \DeclareUnicodeCharacter{010D}{\v{c}}
9380 \DeclareUnicodeCharacter{010E}{\v{D}}
9382 \DeclareUnicodeCharacter{0112}{\=E}
9383 \DeclareUnicodeCharacter{0113}{\=e}
9384 \DeclareUnicodeCharacter{0114}{\u{E}}
9385 \DeclareUnicodeCharacter{0115}{\u{e}}
9386 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9387 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9388 \DeclareUnicodeCharacter{011A}{\v{E}}
9389 \DeclareUnicodeCharacter{011B}{\v{e}}
9390 \DeclareUnicodeCharacter{011C}{\^G}
9391 \DeclareUnicodeCharacter{011D}{\^g}
9392 \DeclareUnicodeCharacter{011E}{\u{G}}
9393 \DeclareUnicodeCharacter{011F}{\u{g}}
9395 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9396 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9397 \DeclareUnicodeCharacter{0124}{\^H}
9398 \DeclareUnicodeCharacter{0125}{\^h}
9399 \DeclareUnicodeCharacter{0128}{\~I}
9400 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9401 \DeclareUnicodeCharacter{012A}{\=I}
9402 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9403 \DeclareUnicodeCharacter{012C}{\u{I}}
9404 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9406 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9407 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9408 \DeclareUnicodeCharacter{0132}{IJ}
9409 \DeclareUnicodeCharacter{0133}{ij}
9410 \DeclareUnicodeCharacter{0134}{\^J}
9411 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9412 \DeclareUnicodeCharacter{0139}{\'L}
9413 \DeclareUnicodeCharacter{013A}{\'l}
9415 \DeclareUnicodeCharacter{0141}{\L}
9416 \DeclareUnicodeCharacter{0142}{\l}
9417 \DeclareUnicodeCharacter{0143}{\'N}
9418 \DeclareUnicodeCharacter{0144}{\'n}
9419 \DeclareUnicodeCharacter{0147}{\v{N}}
9420 \DeclareUnicodeCharacter{0148}{\v{n}}
9421 \DeclareUnicodeCharacter{014C}{\=O}
9422 \DeclareUnicodeCharacter{014D}{\=o}
9423 \DeclareUnicodeCharacter{014E}{\u{O}}
9424 \DeclareUnicodeCharacter{014F}{\u{o}}
9426 \DeclareUnicodeCharacter{0150}{\H{O}}
9427 \DeclareUnicodeCharacter{0151}{\H{o}}
9428 \DeclareUnicodeCharacter{0152}{\OE}
9429 \DeclareUnicodeCharacter{0153}{\oe}
9430 \DeclareUnicodeCharacter{0154}{\'R}
9431 \DeclareUnicodeCharacter{0155}{\'r}
9432 \DeclareUnicodeCharacter{0158}{\v{R}}
9433 \DeclareUnicodeCharacter{0159}{\v{r}}
9434 \DeclareUnicodeCharacter{015A}{\'S}
9435 \DeclareUnicodeCharacter{015B}{\'s}
9436 \DeclareUnicodeCharacter{015C}{\^S}
9437 \DeclareUnicodeCharacter{015D}{\^s}
9438 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9439 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9441 \DeclareUnicodeCharacter{0160}{\v{S}}
9442 \DeclareUnicodeCharacter{0161}{\v{s}}
9443 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9444 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9445 \DeclareUnicodeCharacter{0164}{\v{T}}
9447 \DeclareUnicodeCharacter{0168}{\~U}
9448 \DeclareUnicodeCharacter{0169}{\~u}
9449 \DeclareUnicodeCharacter{016A}{\=U}
9450 \DeclareUnicodeCharacter{016B}{\=u}
9451 \DeclareUnicodeCharacter{016C}{\u{U}}
9452 \DeclareUnicodeCharacter{016D}{\u{u}}
9453 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9454 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9456 \DeclareUnicodeCharacter{0170}{\H{U}}
9457 \DeclareUnicodeCharacter{0171}{\H{u}}
9458 \DeclareUnicodeCharacter{0174}{\^W}
9459 \DeclareUnicodeCharacter{0175}{\^w}
9460 \DeclareUnicodeCharacter{0176}{\^Y}
9461 \DeclareUnicodeCharacter{0177}{\^y}
9462 \DeclareUnicodeCharacter{0178}{\"Y}
9463 \DeclareUnicodeCharacter{0179}{\'Z}
9464 \DeclareUnicodeCharacter{017A}{\'z}
9465 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9466 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9467 \DeclareUnicodeCharacter{017D}{\v{Z}}
9468 \DeclareUnicodeCharacter{017E}{\v{z}}
9470 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9471 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9472 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9473 \DeclareUnicodeCharacter{01C7}{LJ}
9474 \DeclareUnicodeCharacter{01C8}{Lj}
9475 \DeclareUnicodeCharacter{01C9}{lj}
9476 \DeclareUnicodeCharacter{01CA}{NJ}
9477 \DeclareUnicodeCharacter{01CB}{Nj}
9478 \DeclareUnicodeCharacter{01CC}{nj}
9479 \DeclareUnicodeCharacter{01CD}{\v{A}}
9480 \DeclareUnicodeCharacter{01CE}{\v{a}}
9481 \DeclareUnicodeCharacter{01CF}{\v{I}}
9483 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9484 \DeclareUnicodeCharacter{01D1}{\v{O}}
9485 \DeclareUnicodeCharacter{01D2}{\v{o}}
9486 \DeclareUnicodeCharacter{01D3}{\v{U}}
9487 \DeclareUnicodeCharacter{01D4}{\v{u}}
9489 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9490 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9491 \DeclareUnicodeCharacter{01E6}{\v{G}}
9492 \DeclareUnicodeCharacter{01E7}{\v{g}}
9493 \DeclareUnicodeCharacter{01E8}{\v{K}}
9494 \DeclareUnicodeCharacter{01E9}{\v{k}}
9496 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9497 \DeclareUnicodeCharacter{01F1}{DZ}
9498 \DeclareUnicodeCharacter{01F2}{Dz}
9499 \DeclareUnicodeCharacter{01F3}{dz}
9500 \DeclareUnicodeCharacter{01F4}{\'G}
9501 \DeclareUnicodeCharacter{01F5}{\'g}
9502 \DeclareUnicodeCharacter{01F8}{\`N}
9503 \DeclareUnicodeCharacter{01F9}{\`n}
9504 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9505 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9506 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9507 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9509 \DeclareUnicodeCharacter{021E}{\v{H}}
9510 \DeclareUnicodeCharacter{021F}{\v{h}}
9512 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9513 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9514 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9515 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9516 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9517 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9519 \DeclareUnicodeCharacter{0232}{\=Y}
9520 \DeclareUnicodeCharacter{0233}{\=y}
9521 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9523 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9525 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9526 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9527 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9528 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9529 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9530 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9531 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9532 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9533 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9534 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9535 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9536 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9538 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9539 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9541 \DeclareUnicodeCharacter{1E20}{\=G}
9542 \DeclareUnicodeCharacter{1E21}{\=g}
9543 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9544 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9545 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9546 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9547 \DeclareUnicodeCharacter{1E26}{\"H}
9548 \DeclareUnicodeCharacter{1E27}{\"h}
9550 \DeclareUnicodeCharacter{1E30}{\'K}
9551 \DeclareUnicodeCharacter{1E31}{\'k}
9552 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9553 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9554 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9555 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9556 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9557 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9558 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9559 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9560 \DeclareUnicodeCharacter{1E3E}{\'M}
9561 \DeclareUnicodeCharacter{1E3F}{\'m}
9563 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9564 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9565 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9566 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9567 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9568 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9569 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9570 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9571 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9572 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9574 \DeclareUnicodeCharacter{1E54}{\'P}
9575 \DeclareUnicodeCharacter{1E55}{\'p}
9576 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9577 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9578 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9579 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9580 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9581 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9582 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9583 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9585 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9586 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9587 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9588 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9589 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9590 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9591 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9592 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9593 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9594 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9596 \DeclareUnicodeCharacter{1E7C}{\~V}
9597 \DeclareUnicodeCharacter{1E7D}{\~v}
9598 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9599 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9601 \DeclareUnicodeCharacter{1E80}{\`W}
9602 \DeclareUnicodeCharacter{1E81}{\`w}
9603 \DeclareUnicodeCharacter{1E82}{\'W}
9604 \DeclareUnicodeCharacter{1E83}{\'w}
9605 \DeclareUnicodeCharacter{1E84}{\"W}
9606 \DeclareUnicodeCharacter{1E85}{\"w}
9607 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9608 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9609 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9610 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9611 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9612 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9613 \DeclareUnicodeCharacter{1E8C}{\"X}
9614 \DeclareUnicodeCharacter{1E8D}{\"x}
9615 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9616 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9618 \DeclareUnicodeCharacter{1E90}{\^Z}
9619 \DeclareUnicodeCharacter{1E91}{\^z}
9620 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9621 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9622 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9623 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9624 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9625 \DeclareUnicodeCharacter{1E97}{\"t}
9626 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9627 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9629 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9630 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9632 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9633 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9634 \DeclareUnicodeCharacter{1EBC}{\~E}
9635 \DeclareUnicodeCharacter{1EBD}{\~e}
9637 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9638 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9639 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9640 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9642 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9643 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9645 \DeclareUnicodeCharacter{1EF2}{\`Y}
9646 \DeclareUnicodeCharacter{1EF3}{\`y}
9647 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9649 \DeclareUnicodeCharacter{1EF8}{\~Y}
9650 \DeclareUnicodeCharacter{1EF9}{\~y}
9652 \DeclareUnicodeCharacter{2013}{--}
9653 \DeclareUnicodeCharacter{2014}{---}
9654 \DeclareUnicodeCharacter{2018}{\quoteleft}
9655 \DeclareUnicodeCharacter{2019}{\quoteright}
9656 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9657 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9658 \DeclareUnicodeCharacter{201D}{\quotedblright}
9659 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9660 \DeclareUnicodeCharacter{2022}{\bullet}
9661 \DeclareUnicodeCharacter{2026}{\dots}
9662 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9663 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9664 \DeclareUnicodeCharacter{20AC}{\euro}
9666 \DeclareUnicodeCharacter{2192}{\expansion}
9667 \DeclareUnicodeCharacter{21D2}{\result}
9669 \DeclareUnicodeCharacter{2212}{\minus}
9670 \DeclareUnicodeCharacter{2217}{\point}
9671 \DeclareUnicodeCharacter{2261}{\equiv}
9672 }% end of \utfeightchardefs
9675 % US-ASCII character definitions.
9676 \def\asciichardefs{% nothing need be done
9680 % Make non-ASCII characters printable again for compatibility with
9681 % existing Texinfo documents that may use them, even without declaring a
9682 % document encoding.
9684 \setnonasciicharscatcode \other
9687 \message{formatting,}
9689 \newdimen\defaultparindent \defaultparindent = 15pt
9691 \chapheadingskip = 15pt plus 4pt minus 2pt
9692 \secheadingskip = 12pt plus 3pt minus 2pt
9693 \subsecheadingskip = 9pt plus 2pt minus 2pt
9695 % Prevent underfull vbox error messages.
9698 % Don't be very finicky about underfull hboxes, either.
9701 % Following George Bush, get rid of widows and orphans.
9705 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9706 % using an old version of TeX, don't do anything. We want the amount of
9707 % stretch added to depend on the line length, hence the dependence on
9708 % \hsize. We call this whenever the paper size is set.
9710 \def\setemergencystretch{%
9711 \ifx\emergencystretch\thisisundefined
9712 % Allow us to assign to \emergencystretch anyway.
9713 \def\emergencystretch{\dimen0}%
9715 \emergencystretch = .15\hsize
9719 % Parameters in order: 1) textheight; 2) textwidth;
9720 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9721 % 7) physical page height; 8) physical page width.
9723 % We also call \setleading{\textleading}, so the caller should define
9724 % \textleading. The caller should also set \parskip.
9726 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9729 \splittopskip = \topskip
9732 \advance\vsize by \topskip
9733 \outervsize = \vsize
9734 \advance\outervsize by 2\topandbottommargin
9735 \pageheight = \vsize
9738 \outerhsize = \hsize
9739 \advance\outerhsize by 0.5in
9742 \normaloffset = #4\relax
9743 \bindingoffset = #5\relax
9746 \pdfpageheight #7\relax
9747 \pdfpagewidth #8\relax
9748 % if we don't reset these, they will remain at "1 true in" of
9749 % whatever layout pdftex was dumped with.
9750 \pdfhorigin = 1 true in
9751 \pdfvorigin = 1 true in
9754 \setleading{\textleading}
9756 \parindent = \defaultparindent
9757 \setemergencystretch
9760 % @letterpaper (the default).
9761 \def\letterpaper{{\globaldefs = 1
9762 \parskip = 3pt plus 2pt minus 1pt
9763 \textleading = 13.2pt
9765 % If page is nothing but text, make it come out even.
9766 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9768 {\bindingoffset}{36pt}%
9772 % Use @smallbook to reset parameters for 7x9.25 trim size.
9773 \def\smallbook{{\globaldefs = 1
9774 \parskip = 2pt plus 1pt
9777 \internalpagesizes{7.5in}{5in}%
9779 {\bindingoffset}{16pt}%
9782 \lispnarrowing = 0.3in
9785 \contentsrightmargin = 0pt
9786 \defbodyindent = .5cm
9789 % Use @smallerbook to reset parameters for 6x9 trim size.
9790 % (Just testing, parameters still in flux.)
9791 \def\smallerbook{{\globaldefs = 1
9792 \parskip = 1.5pt plus 1pt
9795 \internalpagesizes{7.4in}{4.8in}%
9800 \lispnarrowing = 0.25in
9803 \contentsrightmargin = 0pt
9804 \defbodyindent = .4cm
9807 % Use @afourpaper to print on European A4 paper.
9808 \def\afourpaper{{\globaldefs = 1
9809 \parskip = 3pt plus 2pt minus 1pt
9810 \textleading = 13.2pt
9812 % Double-side printing via postscript on Laserjet 4050
9813 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9814 % To change the settings for a different printer or situation, adjust
9815 % \normaloffset until the front-side and back-side texts align. Then
9816 % do the same for \bindingoffset. You can set these for testing in
9817 % your texinfo source file like this:
9819 % \global\normaloffset = -6mm
9820 % \global\bindingoffset = 10mm
9822 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9823 {\voffset}{\hoffset}%
9824 {\bindingoffset}{44pt}%
9829 \contentsrightmargin = 0pt
9830 \defbodyindent = 5mm
9833 % Use @afivepaper to print on European A5 paper.
9834 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9835 % He also recommends making @example and @lisp be small.
9836 \def\afivepaper{{\globaldefs = 1
9837 \parskip = 2pt plus 1pt minus 0.1pt
9838 \textleading = 12.5pt
9840 \internalpagesizes{160mm}{120mm}%
9841 {\voffset}{\hoffset}%
9842 {\bindingoffset}{8pt}%
9845 \lispnarrowing = 0.2in
9848 \contentsrightmargin = 0pt
9849 \defbodyindent = 2mm
9853 % A specific text layout, 24x15cm overall, intended for A4 paper.
9854 \def\afourlatex{{\globaldefs = 1
9856 \internalpagesizes{237mm}{150mm}%
9858 {\bindingoffset}{7mm}%
9861 % Must explicitly reset to 0 because we call \afourpaper.
9865 % Use @afourwide to print on A4 paper in landscape format.
9866 \def\afourwide{{\globaldefs = 1
9868 \internalpagesizes{241mm}{165mm}%
9869 {\voffset}{-2.95mm}%
9870 {\bindingoffset}{7mm}%
9875 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9876 % Perhaps we should allow setting the margins, \topskip, \parskip,
9877 % and/or leading, also. Or perhaps we should compute them somehow.
9879 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9880 \def\pagesizesyyy#1,#2,#3\finish{{%
9881 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9884 \parskip = 3pt plus 2pt minus 1pt
9885 \setleading{\textleading}%
9888 \advance\dimen0 by \voffset
9891 \advance\dimen2 by \normaloffset
9893 \internalpagesizes{#1}{\hsize}%
9894 {\voffset}{\normaloffset}%
9895 {\bindingoffset}{44pt}%
9899 % Set default to letter.
9904 \message{and turning on texinfo input format.}
9906 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9908 % DEL is a comment character, in case @c does not suffice.
9911 % Define macros to output various characters with catcode for normal text.
9912 \catcode`\"=\other \def\normaldoublequote{"}
9913 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9914 \catcode`\+=\other \def\normalplus{+}
9915 \catcode`\<=\other \def\normalless{<}
9916 \catcode`\>=\other \def\normalgreater{>}
9917 \catcode`\^=\other \def\normalcaret{^}
9918 \catcode`\_=\other \def\normalunderscore{_}
9919 \catcode`\|=\other \def\normalverticalbar{|}
9920 \catcode`\~=\other \def\normaltilde{~}
9922 % This macro is used to make a character print one way in \tt
9923 % (where it can probably be output as-is), and another way in other fonts,
9924 % where something hairier probably needs to be done.
9926 % #1 is what to print if we are indeed using \tt; #2 is what to print
9927 % otherwise. Since all the Computer Modern typewriter fonts have zero
9928 % interword stretch (and shrink), and it is reasonable to expect all
9929 % typewriter fonts to have this, we can check that font parameter.
9931 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9933 % Same as above, but check for italic font. Actually this also catches
9934 % non-italic slanted fonts since it is impossible to distinguish them from
9935 % italic fonts. But since this is only used by $ and it uses \sl anyway
9936 % this is not a problem.
9937 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9939 % Turn off all special characters except @
9940 % (and those which the user can use as if they were ordinary).
9941 % Most of these we simply print from the \tt font, but for some, we can
9942 % use math or other variants that look better in normal text.
9945 \def\activedoublequote{{\tt\char34}}
9946 \let"=\activedoublequote
9948 \def~{{\tt\char126}}
9954 \def_{\ifusingtt\normalunderscore\_}
9956 % Subroutine for the previous macro.
9957 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9960 \def|{{\tt\char124}}
9968 \def+{{\tt \char 43}}
9970 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9972 % If a .fmt file is being used, characters that might appear in a file
9973 % name cannot be active until we have parsed the command line.
9974 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9975 % \otherifyactive is called near the end of this file.
9976 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9978 % Used sometimes to turn off (effectively) the active characters even after
9980 \def\turnoffactive{%
9981 \normalturnoffactive
9987 % \backslashcurfont outputs one backslash character in current font,
9989 \global\chardef\backslashcurfont=`\\
9990 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9992 % \realbackslash is an actual character `\' with catcode other, and
9993 % \doublebackslash is two of them (for the pdf outlines).
9994 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9996 % In texinfo, backslash is an active character; it prints the backslash
9997 % in fixed width font.
9998 \catcode`\\=\active % @ for escape char from now on.
10000 % The story here is that in math mode, the \char of \backslashcurfont
10001 % ends up printing the roman \ from the math symbol font (because \char
10002 % in math mode uses the \mathcode, and plain.tex sets
10003 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10004 % print a typewriter backslash, hence we use an explicit \mathchar,
10005 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10006 % ignored family value; char position "5C). We can't use " for the
10007 % usual hex value because it has already been made active.
10008 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10009 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10011 % On startup, @fixbackslash assigns:
10012 % @let \ = @normalbackslash
10013 % \rawbackslash defines an active \ to do \backslashcurfont.
10014 % \otherbackslash defines an active \ to be a literal `\' character with
10015 % catcode other. We switch back and forth between these.
10016 @gdef@rawbackslash{@let\=@backslashcurfont}
10017 @gdef@otherbackslash{@let\=@realbackslash}
10019 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10020 % the literal character `\'. Also revert - to its normal character, in
10021 % case the active - from code has slipped in.
10023 {@catcode`- = @active
10024 @gdef@normalturnoffactive{%
10026 @let"=@normaldoublequote
10027 @let$=@normaldollar %$ font-lock fix
10030 @let>=@normalgreater
10031 @let\=@normalbackslash
10033 @let_=@normalunderscore
10034 @let|=@normalverticalbar
10036 @markupsetuplqdefault
10037 @markupsetuprqdefault
10042 % Make _ and + \other characters, temporarily.
10043 % This is canceled by @fixbackslash.
10046 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10047 % That is what \eatinput is for; after that, the `\' should revert to printing
10050 @gdef@eatinput input texinfo{@fixbackslash}
10051 @global@let\ = @eatinput
10053 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10054 % the first `\' in the file would cause an error. This macro tries to fix
10055 % that, assuming it is called before the first `\' could plausibly occur.
10056 % Also turn back on active characters that might appear in the input
10057 % file name, in case not using a pre-dumped format.
10059 @gdef@fixbackslash{%
10060 @ifx\@eatinput @let\ = @normalbackslash @fi
10062 @catcode`@_=@active
10065 % Say @foo, not \foo, in error messages.
10068 % These (along with & and #) are made active for url-breaking, so need
10069 % active definitions as the normal characters.
10071 @def@normalquest{?}
10072 @def@normalslash{/}
10074 % These look ok in all fonts, so just make them not special.
10075 % @hashchar{} gets its own user-level command, because of #line.
10076 @catcode`@& = @other @def@normalamp{&}
10077 @catcode`@# = @other @def@normalhash{#}
10078 @catcode`@% = @other @def@normalpercent{%}
10080 @let @hashchar = @normalhash
10082 @c Finally, make ` and ' active, so that txicodequoteundirected and
10083 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10084 @c don't make ` and ' active, @code will not get them as active chars.
10085 @c Do this last of all since we use ` in the previous @catcode assignments.
10086 @catcode`@'=@active
10087 @catcode`@`=@active
10088 @markupsetuplqdefault
10089 @markupsetuprqdefault
10091 @c Local variables:
10092 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10093 @c page-delimiter: "^\\\\message"
10094 @c time-stamp-start: "def\\\\texinfoversion{"
10095 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10096 @c time-stamp-end: "}"
10102 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115