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{2010-09-06.17}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
70 % We never want plain's \outer definition of \+ in Texinfo.
71 % For @tex, we can use \tabalign.
74 % Save some plain tex macros whose names we will redefine.
76 \let\ptexbullet=\bullet
84 \let\ptexfootnote=\footnote
88 \let\ptexindent=\indent
89 \let\ptexinsert=\insert
92 \let\ptexnewwrite\newwrite
93 \let\ptexnoindent=\noindent
95 \let\ptexraggedright=\raggedright
101 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\colonChar = `\:
162 \chardef\commaChar = `\,
163 \chardef\dashChar = `\-
164 \chardef\dotChar = `\.
165 \chardef\exclamChar= `\!
166 \chardef\lquoteChar= `\`
167 \chardef\questChar = `\?
168 \chardef\rquoteChar= `\'
169 \chardef\semiChar = `\;
170 \chardef\underChar = `\_
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
191 % Margin to add to right of even pages, to left of odd pages.
192 \newdimen\bindingoffset
193 \newdimen\normaloffset
194 \newdimen\pagewidth \newdimen\pageheight
196 % For a final copy, take out the rectangles
197 % that mark overfull boxes (in case you have decided
198 % that the text looks ok even though it passes the margin).
200 \def\finalout{\overfullrule=0pt }
202 % Sometimes it is convenient to have everything in the transcript file
203 % and nothing on the terminal. We don't just call \tracingall here,
204 % since that produces some useless output on the terminal. We also make
205 % some effort to order the tracing commands to reduce output in the log
206 % file; cf. trace.sty in LaTeX.
208 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
212 \tracinglostchars2 % 2 gives us more in etex
217 \showboxbreadth\maxdimen \showboxdepth\maxdimen
218 \ifx\eTeXversion\undefined\else % etex gives us more logging
225 \tracingcommands3 % 3 gives us more in etex
229 % add check for \lastpenalty to plain's definitions. If the last thing
230 % we did was a \nobreak, we don't want to insert more space.
232 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
233 \removelastskip\penalty-50\smallskip\fi\fi}
234 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
235 \removelastskip\penalty-100\medskip\fi\fi}
236 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
237 \removelastskip\penalty-200\bigskip\fi\fi}
239 % Do @cropmarks to get crop marks.
242 \let\cropmarks = \cropmarkstrue
244 % Dimensions to add cropmarks at corners.
245 % Added by P. A. MacKay, 12 Nov. 1986
247 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
248 \newdimen\cornerlong \cornerlong=1pc
249 \newdimen\cornerthick \cornerthick=.3pt
250 \newdimen\topandbottommargin \topandbottommargin=.75in
252 % Output a mark which sets \thischapter, \thissection and \thiscolor.
253 % We dump everything together because we only have one kind of mark.
254 % This works because we only use \botmark / \topmark, not \firstmark.
256 % A mark contains a subexpression of the \ifcase ... \fi construct.
257 % \get*marks macros below extract the needed part using \ifcase.
259 % Another complication is to let the user choose whether \thischapter
260 % (\thissection) refers to the chapter (section) in effect at the top
261 % of a page, or that at the bottom of a page. The solution is
262 % described on page 260 of The TeXbook. It involves outputting two
263 % marks for the sectioning macros, one before the section break, and
264 % one after. I won't pretend I can describe this better than DEK...
266 \toks0=\expandafter{\lastchapterdefs}%
267 \toks2=\expandafter{\lastsectiondefs}%
268 \toks4=\expandafter{\prevchapterdefs}%
269 \toks6=\expandafter{\prevsectiondefs}%
270 \toks8=\expandafter{\lastcolordefs}%
272 \the\toks0 \the\toks2
273 \noexpand\or \the\toks4 \the\toks6
274 \noexpand\else \the\toks8
277 % \topmark doesn't work for the very first chapter (after the title
278 % page or the contents), so we use \firstmark there -- this gets us
279 % the mark with the chapter defs, unless the user sneaks in, e.g.,
280 % @setcolor (or @url, or @link, etc.) between @contents and the very
282 \def\gettopheadingmarks{%
284 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
286 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
287 \def\getcolormarks{\ifcase2\topmark\fi}
289 % Avoid "undefined control sequence" errors.
290 \def\lastchapterdefs{}
291 \def\lastsectiondefs{}
292 \def\prevchapterdefs{}
293 \def\prevsectiondefs{}
296 % Main output routine.
298 \output = {\onepageout{\pagecontents\PAGE}}
303 % \onepageout takes a vbox as an argument. Note that \pagecontents
304 % does insertions, but you have to call it yourself.
306 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
308 \ifodd\pageno \advance\hoffset by \bindingoffset
309 \else \advance\hoffset by -\bindingoffset\fi
311 % Do this outside of the \shipout so @code etc. will be expanded in
312 % the headline as they should be, not taken literally (outputting ''code).
313 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
314 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
315 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
316 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
319 % Have to do this stuff outside the \shipout because we want it to
320 % take effect in \write's, yet the group defined by the \vbox ends
321 % before the \shipout runs.
323 \indexdummies % don't expand commands in the output.
324 \normalturnoffactive % \ in index entries must not stay \, e.g., if
325 % the page break happens to be in the middle of an example.
326 % We don't want .vr (or whatever) entries like this:
327 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
328 % "\acronym" won't work when it's read back in;
330 % {\code {{\tt \backslashcurfont }acronym}
332 % Do this early so pdf references go to the beginning of the page.
333 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
335 \ifcropmarks \vbox to \outervsize\bgroup
337 \vskip-\topandbottommargin
339 \line{\ewtop\hfil\ewtop}%
342 \vbox{\moveleft\cornerthick\nstop}%
344 \vbox{\moveright\cornerthick\nstop}%
347 \vskip\topandbottommargin
349 \hfil % center the page within the outer (page) hsize.
350 \ifodd\pageno\hskip\bindingoffset\fi
356 \ifdim\ht\footlinebox > 0pt
357 % Only leave this space if the footline is nonempty.
358 % (We lessened \vsize for it in \oddfootingyyy.)
359 % The \baselineskip=24pt in plain's \makefootline has no effect.
365 \egroup % end of \vbox\bgroup
366 \hfil\egroup % end of (centering) \line\bgroup
367 \vskip\topandbottommargin plus1fill minus1fill
368 \boxmaxdepth = \cornerthick
371 \vbox{\moveleft\cornerthick\nsbot}%
373 \vbox{\moveright\cornerthick\nsbot}%
376 \line{\ewbot\hfil\ewbot}%
378 \egroup % \vbox from first cropmarks clause
380 }% end of \shipout\vbox
381 }% end of group with \indexdummies
383 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
386 \newinsert\margin \dimen\margin=\maxdimen
388 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
390 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
391 % marginal hacks, juha@viisa.uucp (Juha Takala)
392 \ifvoid\margin\else % marginal info is present
393 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
394 \dimen@=\dp#1\relax \unvbox#1\relax
395 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
396 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
399 % Here are the rules for the cropmarks. Note that they are
400 % offset so that the space between them is truly \outerhsize or \outervsize
401 % (P. A. MacKay, 12 November, 1986)
403 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
405 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
406 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
408 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
410 % Parse an argument, then pass it to #1. The argument is the rest of
411 % the input line (except we remove a trailing comment). #1 should be a
412 % macro which expects an ordinary undelimited TeX argument.
414 \def\parsearg{\parseargusing{}}
415 \def\parseargusing#1#2{%
421 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
425 \gdef\parseargline#1^^M{%
426 \endgroup % End of the group started in \parsearg.
427 \argremovecomment #1\comment\ArgTerm%
431 % First remove any @comment, then any @c comment.
432 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
433 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
435 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
437 % \argremovec might leave us with trailing space, e.g.,
438 % @end itemize @c foo
439 % This space token undergoes the same procedure and is eventually removed
440 % by \finishparsearg.
442 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
443 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
444 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
447 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
448 \let\temp\finishparsearg
450 \let\temp\argcheckspaces
452 % Put the space token in:
456 % If a _delimited_ argument is enclosed in braces, they get stripped; so
457 % to get _exactly_ the rest of the line, we had to prevent such situation.
458 % We prepended an \empty token at the very beginning and we expand it now,
459 % just before passing the control to \argtorun.
460 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
461 % either the null string, or it ends with \^^M---thus there is no danger
462 % that a pair of braces would be stripped.
464 % But first, we have to remove the trailing space token.
466 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
468 % \parseargdef\foo{...}
469 % is roughly equivalent to
470 % \def\foo{\parsearg\Xfoo}
473 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
474 % favourite TeX trick. --kasal, 16nov03
477 \expandafter \doparseargdef \csname\string#1\endcsname #1%
479 \def\doparseargdef#1#2{%
484 % Several utility definitions with active space:
489 % Make each space character in the input produce a normal interword
490 % space in the output. Don't allow a line break at this space, as this
491 % is used only in environments like @example, where each line of input
492 % should produce a line of output anyway.
494 \gdef\sepspaces{\obeyspaces\let =\tie}
496 % If an index command is used in an @example environment, any spaces
497 % therein should become regular spaces in the raw index file, not the
498 % expansion of \tie (\leavevmode \penalty \@M \ ).
499 \gdef\unsepspaces{\let =\space}
503 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
505 % Define the framework for environments in texinfo.tex. It's used like this:
510 % It's the responsibility of \envdef to insert \begingroup before the
511 % actual body; @end closes the group after calling \Efoo. \envdef also
512 % defines \thisenv, so the current environment is known; @end checks
513 % whether the environment name matches. The \checkenv macro can also be
514 % used to check whether the current environment is the one expected.
516 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
517 % are not treated as environments; they don't open a group. (The
518 % implementation of @end takes care not to call \endgroup in this
522 % At run-time, environments start with this:
523 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
527 % ... but they get defined via ``\envdef\foo{...}'':
528 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
529 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
531 % Check whether we're in the right environment:
540 % Environment mismatch, #1 expected:
543 \errmessage{This command can appear only \inenvironment\temp,
544 not \inenvironment\thisenv}%
546 \def\inenvironment#1{%
548 out of any environment%
550 in environment \expandafter\string#1%
554 % @end foo executes the definition of \Efoo.
555 % But first, it executes a specialized version of \checkenv
558 \if 1\csname iscond.#1\endcsname
560 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
561 \expandafter\checkenv\csname#1\endcsname
562 \csname E#1\endcsname
567 \newhelp\EMsimple{Press RETURN to continue.}
570 % Be sure we're in horizontal mode when doing a tie, since we make space
571 % equivalent to this in @example-like environments. Otherwise, a space
572 % at the beginning of a line will start with \penalty -- and
573 % since \penalty is valid in vertical mode, we'd end up putting the
574 % penalty on the vertical list instead of in the new paragraph.
576 % Avoid using \@M directly, because that causes trouble
577 % if the definition is written into an index file.
578 \global\let\tiepenalty = \@M
579 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
582 % @: forces normal size whitespace following.
583 \def\:{\spacefactor=1000 }
585 % @* forces a line break.
586 \def\*{\hfil\break\hbox{}\ignorespaces}
588 % @/ allows a line break.
591 % @. is an end-of-sentence period.
592 \def\.{.\spacefactor=\endofsentencespacefactor\space}
594 % @! is an end-of-sentence bang.
595 \def\!{!\spacefactor=\endofsentencespacefactor\space}
597 % @? is an end-of-sentence query.
598 \def\?{?\spacefactor=\endofsentencespacefactor\space}
600 % @frenchspacing on|off says whether to put extra space after punctuation.
605 \parseargdef\frenchspacing{%
607 \ifx\temp\onword \plainfrenchspacing
608 \else\ifx\temp\offword \plainnonfrenchspacing
611 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
615 % @w prevents a word break. Without the \leavevmode, @w at the
616 % beginning of a paragraph, when TeX is still in vertical mode, would
617 % produce a whole line of output instead of starting the paragraph.
618 \def\w#1{\leavevmode\hbox{#1}}
620 % @group ... @end group forces ... to be all on one page, by enclosing
621 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
622 % to keep its height that of a normal line. According to the rules for
623 % \topskip (p.114 of the TeXbook), the glue inserted is
624 % max (\topskip - \ht (first item), 0). If that height is large,
625 % therefore, no glue is inserted, and the space between the headline and
626 % the text is small, which looks bad.
628 % Another complication is that the group might be very large. This can
629 % cause the glue on the previous page to be unduly stretched, because it
630 % does not have much material. In this case, it's better to add an
631 % explicit \vfill so that the extra space is at the bottom. The
632 % threshold for doing this is if the group is more than \vfilllimit
633 % percent of a page (\vfilllimit can be changed inside of @tex).
639 \ifnum\catcode`\^^M=\active \else
640 \errhelp = \groupinvalidhelp
641 \errmessage{@group invalid in context where filling is enabled}%
645 \setbox\groupbox = \vtop\bgroup
646 % Do @comment since we are called inside an environment such as
647 % @example, where each end-of-line in the input causes an
648 % end-of-line in the output. We don't want the end-of-line after
649 % the `@group' to put extra space in the output. Since @group
650 % should appear on a line by itself (according to the Texinfo
651 % manual), we don't worry about eating any user text.
655 % The \vtop produces a box with normal height and large depth; thus, TeX puts
656 % \baselineskip glue before it, and (when the next line of text is done)
657 % \lineskip glue after it. Thus, space below is not quite equal to space
658 % above. But it's pretty close.
660 % To get correct interline space between the last line of the group
661 % and the first line afterwards, we have to propagate \prevdepth.
662 \endgraf % Not \par, as it may have been set to \lisppar.
663 \global\dimen1 = \prevdepth
664 \egroup % End the \vtop.
665 % \dimen0 is the vertical size of the group's box.
666 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
667 % \dimen2 is how much space is left on the page (more or less).
668 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
669 % if the group doesn't fit on the current page, and it's a big big
670 % group, force a page break.
671 \ifdim \dimen0 > \dimen2
672 \ifdim \pagetotal < \vfilllimit\pageheight
681 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
682 % message, so this ends up printing `@group can only ...'.
684 \newhelp\groupinvalidhelp{%
685 group can only be used in environments such as @example,^^J%
686 where each line of input produces a line of output.}
688 % @need space-in-mils
689 % forces a page break if there is not space-in-mils remaining.
691 \newdimen\mil \mil=0.001in
693 % Old definition--didn't work.
694 %\parseargdef\need{\par %
695 %% This method tries to make TeX break the page naturally
696 %% if the depth of the box does not fit.
698 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
703 % Ensure vertical mode, so we don't make a big box in the middle of a
707 % If the @need value is less than one line space, it's useless.
709 \dimen2 = \ht\strutbox
710 \advance\dimen2 by \dp\strutbox
711 \ifdim\dimen0 > \dimen2
713 % Do a \strut just to make the height of this box be normal, so the
714 % normal leading is inserted relative to the preceding line.
715 % And a page break here is fine.
716 \vtop to #1\mil{\strut\vfil}%
718 % TeX does not even consider page breaks if a penalty added to the
719 % main vertical list is 10000 or more. But in order to see if the
720 % empty box we just added fits on the page, we must make it consider
721 % page breaks. On the other hand, we don't want to actually break the
722 % page after the empty box. So we use a penalty of 9999.
724 % There is an extremely small chance that TeX will actually break the
725 % page at this \penalty, if there are no other feasible breakpoints in
726 % sight. (If the user is using lots of big @group commands, which
727 % almost-but-not-quite fill up a page, TeX will have a hard time doing
728 % good page breaking, for example.) However, I could not construct an
729 % example where a page broke at this \penalty; if it happens in a real
730 % document, then we can reconsider our strategy.
733 % Back up by the size of the box, whether we did a page break or not.
736 % Do not allow a page break right after this kern.
741 % @br forces paragraph break (and is undocumented).
745 % @page forces the start of a new page.
747 \def\page{\par\vfill\supereject}
750 % outputs text on separate line in roman font, starting at standard page margin
752 % This records the amount of indent in the innermost environment.
753 % That's how much \exdent should take out.
754 \newskip\exdentamount
756 % This defn is used inside fill environments such as @defun.
757 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
759 % This defn is used inside nofill environments such as @example.
760 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
761 \leftline{\hskip\leftskip{\rm#1}}}}
763 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
764 % paragraph. For more general purposes, use the \margin insertion
765 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
767 \newskip\inmarginspacing \inmarginspacing=1cm
768 \def\strutdepth{\dp\strutbox}
770 \def\doinmargin#1#2{\strut\vadjust{%
773 \vtop to \strutdepth{%
774 \baselineskip=\strutdepth
776 % if you have multiple lines of stuff to put here, you'll need to
777 % make the vbox yourself of the appropriate size.
779 \llap{\ignorespaces #2\hskip\inmarginspacing}%
781 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
786 \def\inleftmargin{\doinmargin l}
787 \def\inrightmargin{\doinmargin r}
789 % @inmargin{TEXT [, RIGHT-TEXT]}
790 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
791 % else use TEXT for both).
793 \def\inmargin#1{\parseinmargin #1,,\finish}
794 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
795 \setbox0 = \hbox{\ignorespaces #2}%
797 \def\lefttext{#1}% have both texts
800 \def\lefttext{#1}% have only one text
805 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
807 \def\temp{\inleftmargin\lefttext}%
812 % @| inserts a changebar to the left of the current line. It should
813 % surround any changed text. This approach does *not* work if the
814 % change spans more than two lines of output. To handle that, we would
815 % have adopt a much more difficult approach (putting marks into the main
816 % vertical list for the beginning and end of each change). This command
817 % is not documented, not supported, and doesn't work.
820 % \vadjust can only be used in horizontal mode.
823 % Append this vertical mode material after the current line in the output.
825 % We want to insert a rule with the height and depth of the current
826 % leading; that is exactly what \strutbox is supposed to record.
829 % \vadjust-items are inserted at the left edge of the type. So
830 % the \llap here moves out into the left-hand margin.
833 % For a thicker or thinner bar, change the `1pt'.
834 \vrule height\baselineskip width1pt
836 % This is the space between the bar and the text.
842 % @include FILE -- \input text of FILE.
844 \def\include{\parseargusing\filenamecatcodes\includezzz}
849 \makevalueexpandable % we want to expand any @value in FILE.
850 \turnoffactive % and allow special characters in the expansion
851 \indexnofonts % Allow `@@' and other weird things in file names.
852 \edef\temp{\noexpand\input #1 }%
854 % This trickery is to read FILE outside of a group, in case it makes
860 \def\filenamecatcodes{%
874 \def\pushthisfilestack{%
875 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
877 \def\pushthisfilestackX{%
878 \expandafter\pushthisfilestackY\thisfile\StackTerm
880 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
881 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
884 \def\popthisfilestack{\errthisfilestackempty}
885 \def\errthisfilestackempty{\errmessage{Internal error:
886 the stack of filenames is empty.}}
891 % outputs that line, centered.
893 \parseargdef\center{%
899 \next{\hfil \ignorespaces#1\unskip \hfil}%
904 \advance\hsize by -\leftskip
905 \advance\hsize by -\rightskip
910 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
912 % @sp n outputs n lines of vertical space
914 \parseargdef\sp{\vskip #1\baselineskip}
916 % @comment ...line which is ignored...
917 % @c is the same as @comment
918 % @ignore ... @end ignore is another way to write a comment
920 \def\comment{\begingroup \catcode`\^^M=\other%
921 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
923 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
927 % @paragraphindent NCHARS
928 % We'll use ems for NCHARS, close enough.
929 % NCHARS can also be the word `asis' or `none'.
930 % We cannot feasibly implement @paragraphindent asis, though.
932 \def\asisword{asis} % no translation, these are keywords
935 \parseargdef\paragraphindent{%
940 \defaultparindent = 0pt
942 \defaultparindent = #1em
945 \parindent = \defaultparindent
948 % @exampleindent NCHARS
949 % We'll use ems for NCHARS like @paragraphindent.
950 % It seems @exampleindent asis isn't necessary, but
951 % I preserve it to make it similar to @paragraphindent.
952 \parseargdef\exampleindent{%
959 \lispnarrowing = #1em
964 % @firstparagraphindent WORD
965 % If WORD is `none', then suppress indentation of the first paragraph
966 % after a section heading. If WORD is `insert', then do indent at such
969 % The paragraph indentation is suppressed or not by calling
970 % \suppressfirstparagraphindent, which the sectioning commands do.
971 % We switch the definition of this back and forth according to WORD.
972 % By default, we suppress indentation.
974 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
975 \def\insertword{insert}
977 \parseargdef\firstparagraphindent{%
980 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
981 \else\ifx\temp\insertword
982 \let\suppressfirstparagraphindent = \relax
985 \errmessage{Unknown @firstparagraphindent option `\temp'}%
989 % Here is how we actually suppress indentation. Redefine \everypar to
990 % \kern backwards by \parindent, and then reset itself to empty.
992 % We also make \indent itself not actually do anything until the next
995 \gdef\dosuppressfirstparagraphindent{%
997 \restorefirstparagraphindent
1001 \restorefirstparagraphindent
1004 \global\everypar = {%
1006 \restorefirstparagraphindent
1010 \gdef\restorefirstparagraphindent{%
1011 \global \let \indent = \ptexindent
1012 \global \let \noindent = \ptexnoindent
1013 \global \everypar = {}%
1017 % @refill is a no-op.
1020 % If working on a large document in chapters, it is convenient to
1021 % be able to disable indexing, cross-referencing, and contents, for test runs.
1022 % This is done with @novalidate (before @setfilename).
1024 \newif\iflinks \linkstrue % by default we want the aux files.
1025 \let\novalidate = \linksfalse
1027 % @setfilename is done at the beginning of every texinfo file.
1028 % So open here the files we need to have open while reading the input.
1029 % This makes it possible to make a .fmt file for texinfo.
1031 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1034 % Open the new aux file. TeX will close it automatically at exit.
1035 \immediate\openout\auxfile=\jobname.aux
1036 \fi % \openindices needs to do some work in any case.
1038 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1040 % If texinfo.cnf is present on the system, read it.
1041 % Useful for site-wide @afourpaper, etc.
1042 \openin 1 texinfo.cnf
1043 \ifeof 1 \else \input texinfo.cnf \fi
1046 \comment % Ignore the actual filename.
1049 % Called from \setfilename.
1061 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1065 % adobe `portable' document format
1069 \newcount\filenamelength
1078 \newif\ifpdfmakepagedest
1080 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1081 % can be set). So we test for \relax and 0 as well as \undefined,
1082 % borrowed from ifpdf.sty.
1083 \ifx\pdfoutput\undefined
1085 \ifx\pdfoutput\relax
1094 % PDF uses PostScript string constants for the names of xref targets,
1095 % for display in the outlines, and in other places. Thus, we have to
1096 % double any backslashes. Otherwise, a name like "\node" will be
1097 % interpreted as a newline (\n), followed by o, d, e. Not good.
1098 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1099 % (and related messages, the final outcome is that it is up to the TeX
1100 % user to double the backslashes and otherwise make the string valid, so
1101 % that's what we do).
1103 % double active backslashes.
1105 {\catcode`\@=0 \catcode`\\=\active
1106 @gdef@activebackslashdouble{%
1108 @let\=@doublebackslash}
1111 % To handle parens, we must adopt a different approach, since parens are
1112 % not active characters. hyperref.dtx (which has the same problem as
1113 % us) handles it with this amazing macro to replace tokens, with minor
1114 % changes for Texinfo. It is included here under the GPL by permission
1115 % from the author, Heiko Oberdiek.
1117 % #1 is the tokens to replace.
1118 % #2 is the replacement.
1119 % #3 is the control sequence with the string.
1121 \def\HyPsdSubst#1#2#3{%
1122 \def\HyPsdReplace##1#1##2\END{%
1128 \HyPsdReplace##2\END
1132 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1134 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1136 % #1 is a control sequence in which to do the replacements.
1137 \def\backslashparens#1{%
1138 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1139 % \lastnode when called from \setref -> \pdfmkdest.
1140 \HyPsdSubst{(}{\realbackslash(}{#1}%
1141 \HyPsdSubst{)}{\realbackslash)}{#1}%
1144 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1145 with PDF output, and none of those formats could be found. (.eps cannot
1146 be supported due to the design of the PDF format; use regular TeX (DVI
1151 % Color manipulation macros based on pdfcolor.tex,
1152 % except using rgb instead of cmyk; the latter is said to render as a
1153 % very dark gray on-screen and a very dark halftone in print, instead
1155 \def\rgbDarkRed{0.50 0.09 0.12}
1156 \def\rgbBlack{0 0 0}
1158 % k sets the color for filling (usual text, etc.);
1159 % K sets the color for stroking (thin rules, e.g., normal _'s).
1160 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1162 % Set color, and create a mark which defines \thiscolor accordingly,
1163 % so that \makeheadline knows which color to restore.
1165 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1170 \def\maincolor{\rgbBlack}
1171 \pdfsetcolor{\maincolor}
1172 \edef\thiscolor{\maincolor}
1173 \def\lastcolordefs{}
1177 \line{\pdfsetcolor{\maincolor}\the\footline}%
1185 % Extract \thiscolor definition from the marks.
1187 % Typeset the headline with \maincolor, then restore the color.
1188 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1196 \pdfcatalog{/PageMode /UseOutlines}
1198 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1199 \def\dopdfimage#1#2#3{%
1200 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1201 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1203 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1204 % others). Let's try in that order.
1205 \let\pdfimgext=\empty
1207 \openin 1 #1.png \ifeof 1
1208 \openin 1 #1.jpg \ifeof 1
1209 \openin 1 #1.jpeg \ifeof 1
1210 \openin 1 #1.JPG \ifeof 1
1211 \openin 1 #1.pdf \ifeof 1
1212 \openin 1 #1.PDF \ifeof 1
1213 \errhelp = \nopdfimagehelp
1214 \errmessage{Could not find image file #1 for pdf}%
1215 \else \gdef\pdfimgext{PDF}%
1217 \else \gdef\pdfimgext{pdf}%
1219 \else \gdef\pdfimgext{JPG}%
1221 \else \gdef\pdfimgext{jpeg}%
1223 \else \gdef\pdfimgext{jpg}%
1225 \else \gdef\pdfimgext{png}%
1230 % without \immediate, ancient pdftex seg faults when the same image is
1231 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1232 \ifnum\pdftexversion < 14
1235 \immediate\pdfximage
1237 \ifdim \wd0 >0pt width \imagewidth \fi
1238 \ifdim \wd2 >0pt height \imageheight \fi
1239 \ifnum\pdftexversion<13
1244 \ifnum\pdftexversion < 14 \else
1245 \pdfrefximage \pdflastximage
1249 % We have to set dummies so commands such as @code, and characters
1250 % such as \, aren't expanded when present in a section title.
1253 \activebackslashdouble
1254 \makevalueexpandable
1255 \def\pdfdestname{#1}%
1256 \backslashparens\pdfdestname
1257 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1260 % used to mark target names; must be expandable.
1263 % by default, use a color that is dark enough to print on paper as
1264 % nearly black, but still distinguishable for online viewing.
1265 \def\urlcolor{\rgbDarkRed}
1266 \def\linkcolor{\rgbDarkRed}
1267 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1269 % Adding outlines to PDF; macros for calculating structure of outlines
1270 % come from Petr Olsak
1271 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1272 \else \csname#1\endcsname \fi}
1273 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1274 \advance\tempnum by 1
1275 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1277 % #1 is the section text, which is what will be displayed in the
1278 % outline by the pdf viewer. #2 is the pdf expression for the number
1279 % of subentries (or empty, for subsubsections). #3 is the node text,
1280 % which might be empty if this toc entry had no corresponding node.
1281 % #4 is the page number
1283 \def\dopdfoutline#1#2#3#4{%
1284 % Generate a link to the node text if that exists; else, use the
1285 % page number. We could generate a destination for the section
1286 % text in the case where a section has no node, but it doesn't
1287 % seem worth the trouble, since most documents are normally structured.
1288 \def\pdfoutlinedest{#3}%
1289 \ifx\pdfoutlinedest\empty
1290 \def\pdfoutlinedest{#4}%
1292 % Doubled backslashes in the name.
1293 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1294 \backslashparens\pdfoutlinedest}%
1297 % Also double the backslashes in the display string.
1298 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1299 \backslashparens\pdfoutlinetext}%
1301 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1304 \def\pdfmakeoutlines{%
1306 % Thanh's hack / proper braces in bookmarks
1307 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1308 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1310 % Read toc silently, to get counts of subentries for \pdfoutline.
1311 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1312 \def\numchapentry##1##2##3##4{%
1313 \def\thischapnum{##2}%
1315 \def\thissubsecnum{0}%
1317 \def\numsecentry##1##2##3##4{%
1318 \advancenumber{chap\thischapnum}%
1319 \def\thissecnum{##2}%
1320 \def\thissubsecnum{0}%
1322 \def\numsubsecentry##1##2##3##4{%
1323 \advancenumber{sec\thissecnum}%
1324 \def\thissubsecnum{##2}%
1326 \def\numsubsubsecentry##1##2##3##4{%
1327 \advancenumber{subsec\thissubsecnum}%
1329 \def\thischapnum{0}%
1331 \def\thissubsecnum{0}%
1333 % use \def rather than \let here because we redefine \chapentry et
1334 % al. a second time, below.
1335 \def\appentry{\numchapentry}%
1336 \def\appsecentry{\numsecentry}%
1337 \def\appsubsecentry{\numsubsecentry}%
1338 \def\appsubsubsecentry{\numsubsubsecentry}%
1339 \def\unnchapentry{\numchapentry}%
1340 \def\unnsecentry{\numsecentry}%
1341 \def\unnsubsecentry{\numsubsecentry}%
1342 \def\unnsubsubsecentry{\numsubsubsecentry}%
1345 % Read toc second time, this time actually producing the outlines.
1346 % The `-' means take the \expnumber as the absolute number of
1347 % subentries, which we calculated on our first read of the .toc above.
1349 % We use the node names as the destinations.
1350 \def\numchapentry##1##2##3##4{%
1351 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1352 \def\numsecentry##1##2##3##4{%
1353 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1354 \def\numsubsecentry##1##2##3##4{%
1355 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1356 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1357 \dopdfoutline{##1}{}{##3}{##4}}%
1359 % PDF outlines are displayed using system fonts, instead of
1360 % document fonts. Therefore we cannot use special characters,
1361 % since the encoding is unknown. For example, the eogonek from
1362 % Latin 2 (0xea) gets translated to a | character. Info from
1363 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1365 % xx to do this right, we have to translate 8-bit characters to
1366 % their "best" equivalent, based on the @documentencoding. Right
1367 % now, I guess we'll just let the pdf reader have its way.
1370 \catcode`\\=\active \otherbackslash
1371 \input \tocreadfilename
1375 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1376 \ifx\PP\D\let\nextsp\relax
1377 \else\let\nextsp\skipspaces
1378 \ifx\p\space\else\addtokens{\filename}{\PP}%
1379 \advance\filenamelength by 1
1383 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1384 \ifnum\pdftexversion < 14
1385 \let \startlink \pdfannotlink
1387 \let \startlink \pdfstartlink
1389 % make a live url in pdf output.
1392 % it seems we really need yet another set of dummies; have not
1393 % tried to figure out what each command should do in the context
1394 % of @url. for now, just make @/ a no-op, that's the only one
1395 % people have actually reported a problem with.
1397 \normalturnoffactive
1400 \makevalueexpandable
1401 % do we want to go so far as to use \indexnofonts instead of just
1402 % special-casing \var here?
1405 \leavevmode\setcolor{\urlcolor}%
1406 \startlink attr{/Border [0 0 0]}%
1407 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1409 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1410 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1411 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1412 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1414 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1416 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1417 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1418 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1420 \ifnum0=\countA\else\makelink\fi
1421 \ifx\first.\let\next=\done\else
1423 \addtokens{\toksB}{\the\toksD}
1424 \ifx\first,\addtokens{\toksB}{\space}\fi
1426 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1428 \def\makelink{\addtokens{\toksB}%
1429 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1431 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1432 \setcolor{\linkcolor}#1\endlink}
1433 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1436 \let\pdfmkdest = \gobble
1437 \let\pdfurl = \gobble
1438 \let\endlink = \relax
1439 \let\setcolor = \gobble
1440 \let\pdfsetcolor = \gobble
1441 \let\pdfmakeoutlines = \relax
1442 \fi % \ifx\pdfoutput
1447 % Change the current font style to #1, remembering it in \curfontstyle.
1448 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1449 % italics, not bold italics.
1451 \def\setfontstyle#1{%
1452 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1453 \csname ten#1\endcsname % change the current font
1456 % Select #1 fonts with the current style.
1458 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1460 \def\rm{\fam=0 \setfontstyle{rm}}
1461 \def\it{\fam=\itfam \setfontstyle{it}}
1462 \def\sl{\fam=\slfam \setfontstyle{sl}}
1463 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1464 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1466 % Unfortunately, we have to override this for titles and the like, since
1467 % in those cases "rm" is bold. Sigh.
1468 \def\rmisbold{\rm\def\curfontstyle{bf}}
1470 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1471 % So we set up a \sf.
1473 \def\sf{\fam=\sffam \setfontstyle{sf}}
1474 \let\li = \sf % Sometimes we call it \li, not \sf.
1476 % We don't need math for this font style.
1477 \def\ttsl{\setfontstyle{ttsl}}
1481 \newdimen\textleading \textleading = 13.2pt
1483 % Set the baselineskip to #1, and the lineskip and strut size
1484 % correspondingly. There is no deep meaning behind these magic numbers
1485 % used as factors; they just match (closely enough) what Knuth defined.
1487 \def\lineskipfactor{.08333}
1488 \def\strutheightpercent{.70833}
1489 \def\strutdepthpercent {.29167}
1491 % can get a sort of poor man's double spacing by redefining this.
1492 \def\baselinefactor{1}
1496 \normalbaselineskip = \baselinefactor\dimen0
1497 \normallineskip = \lineskipfactor\normalbaselineskip
1499 \setbox\strutbox =\hbox{%
1500 \vrule width0pt height\strutheightpercent\baselineskip
1501 depth \strutdepthpercent \baselineskip
1505 % PDF CMaps. See also LaTeX's t1.cmap.
1507 % do nothing with this by default.
1508 \expandafter\let\csname cmapOT1\endcsname\gobble
1509 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1510 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1512 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1513 % (\pdffontattr was introduced many years ago, but people still run
1514 % older pdftex's; it's easy to conditionalize, so we do.)
1515 \ifpdf \ifx\pdffontattr\undefined \else
1517 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1518 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1519 %%DocumentNeededResources: ProcSet (CIDInit)
1520 %%IncludeResource: ProcSet (CIDInit)
1521 %%BeginResource: CMap (TeX-OT1-0)
1522 %%Title: (TeX-OT1-0 TeX OT1 0)
1525 /CIDInit /ProcSet findresource begin
1533 /CMapName /TeX-OT1-0 def
1535 1 begincodespacerange
1591 CMapName currentdict /CMap defineresource pop
1597 \expandafter\edef\csname cmapOT1\endcsname#1{%
1598 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1603 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1604 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1605 %%DocumentNeededResources: ProcSet (CIDInit)
1606 %%IncludeResource: ProcSet (CIDInit)
1607 %%BeginResource: CMap (TeX-OT1IT-0)
1608 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1611 /CIDInit /ProcSet findresource begin
1619 /CMapName /TeX-OT1IT-0 def
1621 1 begincodespacerange
1679 CMapName currentdict /CMap defineresource pop
1685 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1686 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1691 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1692 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1693 %%DocumentNeededResources: ProcSet (CIDInit)
1694 %%IncludeResource: ProcSet (CIDInit)
1695 %%BeginResource: CMap (TeX-OT1TT-0)
1696 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1699 /CIDInit /ProcSet findresource begin
1707 /CMapName /TeX-OT1TT-0 def
1709 1 begincodespacerange
1754 CMapName currentdict /CMap defineresource pop
1760 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1761 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1766 % Set the font macro #1 to the font named #2, adding on the
1767 % specified font prefix (normally `cm').
1768 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1769 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1771 \def\setfont#1#2#3#4#5{%
1772 \font#1=\fontprefix#2#3 scaled #4
1773 \csname cmap#5\endcsname#1%
1775 % This is what gets called when #5 of \setfont is empty.
1777 % emacs-page end of cmaps
1779 % Use cm as the default font prefix.
1780 % To specify the font prefix, you must define \fontprefix
1781 % before you read in texinfo.tex.
1782 \ifx\fontprefix\undefined
1785 % Support font families that don't use the same naming scheme as CM.
1787 \def\rmbshape{bx} %where the normal face is bold
1792 \def\ttslshape{sltt}
1802 % Definitions for a main text size of 11pt. This is the default in
1805 \def\definetextfontsizexi{%
1806 % Text fonts (11.2pt, magstep1).
1807 \def\textnominalsize{11pt}
1808 \edef\mainmagstep{\magstephalf}
1809 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1810 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1811 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1812 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1813 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1814 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1815 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1816 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1817 \font\texti=cmmi10 scaled \mainmagstep
1818 \font\textsy=cmsy10 scaled \mainmagstep
1819 \def\textecsize{1095}
1821 % A few fonts for @defun names and args.
1822 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1823 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1824 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1825 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1827 % Fonts for indices, footnotes, small examples (9pt).
1828 \def\smallnominalsize{9pt}
1829 \setfont\smallrm\rmshape{9}{1000}{OT1}
1830 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1831 \setfont\smallbf\bfshape{10}{900}{OT1}
1832 \setfont\smallit\itshape{9}{1000}{OT1IT}
1833 \setfont\smallsl\slshape{9}{1000}{OT1}
1834 \setfont\smallsf\sfshape{9}{1000}{OT1}
1835 \setfont\smallsc\scshape{10}{900}{OT1}
1836 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1839 \def\smallecsize{0900}
1841 % Fonts for small examples (8pt).
1842 \def\smallernominalsize{8pt}
1843 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1844 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1845 \setfont\smallerbf\bfshape{10}{800}{OT1}
1846 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1847 \setfont\smallersl\slshape{8}{1000}{OT1}
1848 \setfont\smallersf\sfshape{8}{1000}{OT1}
1849 \setfont\smallersc\scshape{10}{800}{OT1}
1850 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1851 \font\smalleri=cmmi8
1852 \font\smallersy=cmsy8
1853 \def\smallerecsize{0800}
1855 % Fonts for title page (20.4pt):
1856 \def\titlenominalsize{20pt}
1857 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1858 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1859 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1860 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1861 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1862 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1863 \let\titlebf=\titlerm
1864 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1865 \font\titlei=cmmi12 scaled \magstep3
1866 \font\titlesy=cmsy10 scaled \magstep4
1867 \def\titleecsize{2074}
1869 % Chapter (and unnumbered) fonts (17.28pt).
1870 \def\chapnominalsize{17pt}
1871 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1872 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1873 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1874 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1875 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1876 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1878 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1879 \font\chapi=cmmi12 scaled \magstep2
1880 \font\chapsy=cmsy10 scaled \magstep3
1881 \def\chapecsize{1728}
1883 % Section fonts (14.4pt).
1884 \def\secnominalsize{14pt}
1885 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1886 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1887 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1888 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1889 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1890 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1892 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1893 \font\seci=cmmi12 scaled \magstep1
1894 \font\secsy=cmsy10 scaled \magstep2
1895 \def\sececsize{1440}
1897 % Subsection fonts (13.15pt).
1898 \def\ssecnominalsize{13pt}
1899 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1900 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1901 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1902 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1903 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1904 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1906 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1907 \font\sseci=cmmi12 scaled \magstephalf
1908 \font\ssecsy=cmsy10 scaled 1315
1909 \def\ssececsize{1200}
1911 % Reduced fonts for @acro in text (10pt).
1912 \def\reducednominalsize{10pt}
1913 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1914 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1915 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1916 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1917 \setfont\reducedsl\slshape{10}{1000}{OT1}
1918 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1919 \setfont\reducedsc\scshape{10}{1000}{OT1}
1920 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1921 \font\reducedi=cmmi10
1922 \font\reducedsy=cmsy10
1923 \def\reducedecsize{1000}
1925 \textleading = 13.2pt % line spacing for 11pt CM
1926 \textfonts % reset the current fonts
1928 } % end of 11pt text font size definitions
1931 % Definitions to make the main text be 10pt Computer Modern, with
1932 % section, chapter, etc., sizes following suit. This is for the GNU
1933 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1934 % future. Used with @smallbook, which sets the leading to 12pt.
1936 \def\definetextfontsizex{%
1937 % Text fonts (10pt).
1938 \def\textnominalsize{10pt}
1939 \edef\mainmagstep{1000}
1940 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1941 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1942 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1943 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1944 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1945 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1946 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1947 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1948 \font\texti=cmmi10 scaled \mainmagstep
1949 \font\textsy=cmsy10 scaled \mainmagstep
1950 \def\textecsize{1000}
1952 % A few fonts for @defun names and args.
1953 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1954 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1955 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1956 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1958 % Fonts for indices, footnotes, small examples (9pt).
1959 \def\smallnominalsize{9pt}
1960 \setfont\smallrm\rmshape{9}{1000}{OT1}
1961 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1962 \setfont\smallbf\bfshape{10}{900}{OT1}
1963 \setfont\smallit\itshape{9}{1000}{OT1IT}
1964 \setfont\smallsl\slshape{9}{1000}{OT1}
1965 \setfont\smallsf\sfshape{9}{1000}{OT1}
1966 \setfont\smallsc\scshape{10}{900}{OT1}
1967 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1970 \def\smallecsize{0900}
1972 % Fonts for small examples (8pt).
1973 \def\smallernominalsize{8pt}
1974 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1975 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1976 \setfont\smallerbf\bfshape{10}{800}{OT1}
1977 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1978 \setfont\smallersl\slshape{8}{1000}{OT1}
1979 \setfont\smallersf\sfshape{8}{1000}{OT1}
1980 \setfont\smallersc\scshape{10}{800}{OT1}
1981 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1982 \font\smalleri=cmmi8
1983 \font\smallersy=cmsy8
1984 \def\smallerecsize{0800}
1986 % Fonts for title page (20.4pt):
1987 \def\titlenominalsize{20pt}
1988 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1989 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1990 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1991 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1992 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1993 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1994 \let\titlebf=\titlerm
1995 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1996 \font\titlei=cmmi12 scaled \magstep3
1997 \font\titlesy=cmsy10 scaled \magstep4
1998 \def\titleecsize{2074}
2000 % Chapter fonts (14.4pt).
2001 \def\chapnominalsize{14pt}
2002 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2003 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2004 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2005 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2006 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2007 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2009 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2010 \font\chapi=cmmi12 scaled \magstep1
2011 \font\chapsy=cmsy10 scaled \magstep2
2012 \def\chapecsize{1440}
2014 % Section fonts (12pt).
2015 \def\secnominalsize{12pt}
2016 \setfont\secrm\rmbshape{12}{1000}{OT1}
2017 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2018 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2019 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2020 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2021 \setfont\secsf\sfbshape{12}{1000}{OT1}
2023 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2025 \font\secsy=cmsy10 scaled \magstep1
2026 \def\sececsize{1200}
2028 % Subsection fonts (10pt).
2029 \def\ssecnominalsize{10pt}
2030 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2031 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2032 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2033 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2034 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2035 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2037 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2040 \def\ssececsize{1000}
2042 % Reduced fonts for @acro in text (9pt).
2043 \def\reducednominalsize{9pt}
2044 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2045 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2046 \setfont\reducedbf\bfshape{10}{900}{OT1}
2047 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2048 \setfont\reducedsl\slshape{9}{1000}{OT1}
2049 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2050 \setfont\reducedsc\scshape{10}{900}{OT1}
2051 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2052 \font\reducedi=cmmi9
2053 \font\reducedsy=cmsy9
2054 \def\reducedecsize{0900}
2056 \divide\parskip by 2 % reduce space between paragraphs
2057 \textleading = 12pt % line spacing for 10pt CM
2058 \textfonts % reset the current fonts
2060 } % end of 10pt text font size definitions
2063 % We provide the user-level command
2065 % (or 11) to redefine the text font size. pt is assumed.
2071 \parseargdef\fonttextsize{%
2072 \def\textsizearg{#1}%
2073 \wlog{doing @fonttextsize \textsizearg}%
2075 % Set \globaldefs so that documents can use this inside @tex, since
2076 % makeinfo 4.8 does not support it, but we need it nonetheless.
2078 \begingroup \globaldefs=1
2079 \ifx\textsizearg\xword \definetextfontsizex
2080 \else \ifx\textsizearg\xiword \definetextfontsizexi
2083 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2089 % In order for the font changes to affect most math symbols and letters,
2090 % we have to define the \textfont of the standard families. Since
2091 % texinfo doesn't allow for producing subscripts and superscripts except
2092 % in the main text, we don't bother to reset \scriptfont and
2093 % \scriptscriptfont (which would also require loading a lot more fonts).
2095 \def\resetmathfonts{%
2096 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2097 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2098 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2101 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2102 % of just \STYLE. We do this because \STYLE needs to also set the
2103 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2104 % \tenSTYLE to set the current font.
2106 % Each font-changing command also sets the names \lsize (one size lower)
2107 % and \lllsize (three sizes lower). These relative commands are used in
2108 % the LaTeX logo and acronyms.
2110 % This all needs generalizing, badly.
2113 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2114 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2115 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2116 \let\tenttsl=\textttsl
2117 \def\curfontsize{text}%
2118 \def\lsize{reduced}\def\lllsize{smaller}%
2119 \resetmathfonts \setleading{\textleading}}
2121 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2122 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2123 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2124 \let\tenttsl=\titlettsl
2125 \def\curfontsize{title}%
2126 \def\lsize{chap}\def\lllsize{subsec}%
2127 \resetmathfonts \setleading{27pt}}
2128 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2130 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2131 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2132 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2133 \let\tenttsl=\chapttsl
2134 \def\curfontsize{chap}%
2135 \def\lsize{sec}\def\lllsize{text}%
2136 \resetmathfonts \setleading{19pt}}
2138 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2139 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2140 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2141 \let\tenttsl=\secttsl
2142 \def\curfontsize{sec}%
2143 \def\lsize{subsec}\def\lllsize{reduced}%
2144 \resetmathfonts \setleading{16pt}}
2146 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2147 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2148 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2149 \let\tenttsl=\ssecttsl
2150 \def\curfontsize{ssec}%
2151 \def\lsize{text}\def\lllsize{small}%
2152 \resetmathfonts \setleading{15pt}}
2153 \let\subsubsecfonts = \subsecfonts
2155 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2156 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2157 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2158 \let\tenttsl=\reducedttsl
2159 \def\curfontsize{reduced}%
2160 \def\lsize{small}\def\lllsize{smaller}%
2161 \resetmathfonts \setleading{10.5pt}}
2163 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2164 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2165 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2166 \let\tenttsl=\smallttsl
2167 \def\curfontsize{small}%
2168 \def\lsize{smaller}\def\lllsize{smaller}%
2169 \resetmathfonts \setleading{10.5pt}}
2171 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2172 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2173 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2174 \let\tenttsl=\smallerttsl
2175 \def\curfontsize{smaller}%
2176 \def\lsize{smaller}\def\lllsize{smaller}%
2177 \resetmathfonts \setleading{9.5pt}}
2179 % Fonts for short table of contents.
2180 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2181 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2182 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2183 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2185 % Define these just so they can be easily changed for other fonts.
2186 \def\angleleft{$\langle$}
2187 \def\angleright{$\rangle$}
2189 % Set the fonts to use with the @small... environments.
2190 \let\smallexamplefonts = \smallfonts
2192 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2193 % can fit this many characters:
2194 % 8.5x11=86 smallbook=72 a4=90 a5=69
2195 % If we use \scriptfonts (8pt), then we can fit this many characters:
2196 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2197 % For me, subjectively, the few extra characters that fit aren't worth
2198 % the additional smallness of 8pt. So I'm making the default 9pt.
2200 % By the way, for comparison, here's what fits with @example (10pt):
2201 % 8.5x11=71 smallbook=60 a4=75 a5=58
2204 % Set up the default fonts, so we can use them for creating boxes.
2206 \definetextfontsizexi
2211 % Check if we are currently using a typewriter font. Since all the
2212 % Computer Modern typewriter fonts have zero interword stretch (and
2213 % shrink), and it is reasonable to expect all typewriter fonts to have
2214 % this property, we can check that font parameter.
2216 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2218 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2219 % define and register \INITMACRO to be called on markup style changes.
2220 % \INITMACRO can check \currentmarkupstyle for the innermost
2221 % style and the set of \ifmarkupSTYLE switches for all styles
2222 % currently in effect.
2226 %\newif\ifmarkupfile % @file == @samp.
2227 %\newif\ifmarkupoption % @option == @samp.
2230 %\newif\ifmarkupenv % @env == @code.
2231 %\newif\ifmarkupcommand % @command == @code.
2232 \newif\ifmarkuptex % @tex (and part of @math, for now).
2233 \newif\ifmarkupexample
2235 \newif\ifmarkupverbatim
2237 \let\currentmarkupstyle\empty
2239 \def\setupmarkupstyle#1{%
2240 \csname markup#1true\endcsname
2241 \def\currentmarkupstyle{#1}%
2245 \let\markupstylesetup\empty
2247 \def\defmarkupstylesetup#1{%
2248 \expandafter\def\expandafter\markupstylesetup
2249 \expandafter{\markupstylesetup #1}%
2253 % Markup style setup for left and right quotes.
2254 \defmarkupstylesetup\markupsetuplq{%
2255 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2256 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2259 \defmarkupstylesetup\markupsetuprq{%
2260 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2261 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2268 \gdef\markupsetuplqdefault{\let`\lq}
2269 \gdef\markupsetuprqdefault{\let'\rq}
2271 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2272 \gdef\markupsetcodequoteright{\let'\codequoteright}
2274 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2277 \let\markupsetuplqcode \markupsetcodequoteleft
2278 \let\markupsetuprqcode \markupsetcodequoteright
2280 \let\markupsetuplqexample \markupsetcodequoteleft
2281 \let\markupsetuprqexample \markupsetcodequoteright
2283 \let\markupsetuplqsamp \markupsetcodequoteleft
2284 \let\markupsetuprqsamp \markupsetcodequoteright
2286 \let\markupsetuplqverb \markupsetcodequoteleft
2287 \let\markupsetuprqverb \markupsetcodequoteright
2289 \let\markupsetuplqverbatim \markupsetcodequoteleft
2290 \let\markupsetuprqverbatim \markupsetcodequoteright
2292 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2294 % Allow an option to not replace quotes with a regular directed right
2295 % quote/apostrophe (char 0x27), but instead use the undirected quote
2296 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2297 % the default, but it works for pasting with more pdf viewers (at least
2298 % evince), the lilypond developers report. xpdf does work with the
2301 \def\codequoteright{%
2302 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2303 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2309 % and a similar option for the left quote char vs. a grave accent.
2310 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2311 % the code environments to do likewise.
2313 \def\codequoteleft{%
2314 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2315 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2316 % [Knuth] pp. 380,381,391
2317 % \relax disables Spanish ligatures ?` and !` of \tt font.
2323 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2324 \def\noligaturesquoteleft{\relax\lq}
2326 % Count depth in font-changes, for error checks
2327 \newcount\fontdepth \fontdepth=0
2331 % #1 is the font command (\sl or \it), #2 is the text to slant.
2332 % If we are in a monospaced environment, however, 1) always use \ttsl,
2333 % and 2) do not add an italic correction.
2334 \def\dosmartslant#1#2{%
2336 {{\ttsl #2}\let\next=\relax}%
2337 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2340 \def\smartslanted{\dosmartslant\sl}
2341 \def\smartitalic{\dosmartslant\it}
2343 % Output an italic correction unless \next (presumed to be the following
2344 % character) is such as not to need one.
2345 \def\smartitaliccorrection{%
2352 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2353 % @var is set to this for defun arguments.
2354 \def\ttslanted#1{{\ttsl #1}}
2356 % @cite is like \smartslanted except unconditionally use \sl. We never want
2357 % ttsl for book titles, do we?
2358 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2361 \let\slanted=\smartslanted
2362 \def\var#1{\smartslanted{#1}}
2363 \let\dfn=\smartslanted
2364 \let\emph=\smartitalic
2366 % Explicit font changes: @r, @sc, undocumented @ii.
2367 \def\r#1{{\rm #1}} % roman font
2368 \def\sc#1{{\smallcaps#1}} % smallcaps font
2369 \def\ii#1{{\it #1}} % italic font
2371 % @b, explicit bold. Also @strong.
2375 % @sansserif, explicit sans.
2376 \def\sansserif#1{{\sf #1}}
2378 % We can't just use \exhyphenpenalty, because that only has effect at
2379 % the end of a paragraph. Restore normal hyphenation at the end of the
2380 % group within which \nohyphenation is presumably called.
2382 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2383 \def\restorehyphenation{\hyphenchar\font = `- }
2385 % Set sfcode to normal for the chars that usually have another value.
2386 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2387 % sometimes \x has an active definition that messes things up.
2390 \def\plainfrenchspacing{%
2391 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2392 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2393 \def\endofsentencespacefactor{1000}% for @. and friends
2395 \def\plainnonfrenchspacing{%
2396 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2397 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2398 \def\endofsentencespacefactor{3000}% for @. and friends
2401 \def\endofsentencespacefactor{3000}% default
2403 % @t, explicit typewriter.
2405 {\tt \rawbackslash \plainfrenchspacing #1}%
2410 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2412 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2413 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2415 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2416 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2417 % \vbox{\hrule\kern-0.4pt
2418 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2419 % \kern-0.4pt\hrule}%
2420 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2422 % definition of @key with no lozenge. If the current font is already
2423 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2424 % if it isn't monospace, then use \tt.
2426 \def\key#1{{\setupmarkupstyle{key}%
2428 \ifmonospace\else\tt\fi
2431 % ctrl is no longer a Texinfo command.
2432 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2434 % @file, @option are the same as @samp.
2438 % @code is a modification of @t,
2439 % which makes spaces the same size as normal in the surrounding text.
2442 % Change normal interword space to be same as for the current font.
2443 \spaceskip = \fontdimen2\font
2445 % Switch to typewriter.
2448 % But `\ ' produces the large typewriter interword space.
2449 \def\ {{\spaceskip = 0pt{} }}%
2451 % Turn off hyphenation.
2461 % We *must* turn on hyphenation at `-' and `_' in @code.
2462 % Otherwise, it is too hard to avoid overfull hboxes
2463 % in the Emacs manual, the Library manual, etc.
2465 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2466 % both hyphenation at - and hyphenation within words.
2467 % We must therefore turn them both off (\tclose does that)
2468 % and arrange explicitly to hyphenate at a dash.
2471 \catcode`\-=\active \catcode`\_=\active
2472 \catcode`\'=\active \catcode`\`=\active
2473 \global\let'=\rq \global\let`=\lq % default definitions
2475 \global\def\code{\begingroup
2476 \setupmarkupstyle{code}%
2477 % The following should really be moved into \setupmarkupstyle handlers.
2478 \catcode\dashChar=\active \catcode\underChar=\active
2491 \def\codedash{-\discretionary{}{}{}}
2493 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2494 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2495 % will therefore expand the active definition of _, which is us
2496 % (inside @code that is), therefore an endless loop.
2498 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2499 \else\normalunderscore \fi
2500 \discretionary{}{}{}}%
2503 \def\codex #1{\tclose{#1}\endgroup}
2505 % An additional complication: the above will allow breaks after, e.g.,
2506 % each of the four underscores in __typeof__. This is undesirable in
2507 % some manuals, especially if they don't have long identifiers in
2508 % general. @allowcodebreaks provides a way to control this.
2510 \newif\ifallowcodebreaks \allowcodebreakstrue
2512 \def\keywordtrue{true}
2513 \def\keywordfalse{false}
2515 \parseargdef\allowcodebreaks{%
2517 \ifx\txiarg\keywordtrue
2518 \allowcodebreakstrue
2519 \else\ifx\txiarg\keywordfalse
2520 \allowcodebreaksfalse
2522 \errhelp = \EMsimple
2523 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2527 % @kbd is like @code, except that if the argument is just one @key command,
2528 % then @kbd has no effect.
2529 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2531 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2532 % `example' (@kbd uses ttsl only inside of @example and friends),
2533 % or `code' (@kbd uses normal tty font always).
2534 \parseargdef\kbdinputstyle{%
2536 \ifx\txiarg\worddistinct
2537 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2538 \else\ifx\txiarg\wordexample
2539 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2540 \else\ifx\txiarg\wordcode
2541 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2543 \errhelp = \EMsimple
2544 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2547 \def\worddistinct{distinct}
2548 \def\wordexample{example}
2551 % Default is `distinct'.
2552 \kbdinputstyle distinct
2555 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2556 \ifx\one\xkey\ifx\threex\three \key{#2}%
2557 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2558 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2560 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2561 \let\indicateurl=\code
2565 % @clicksequence{File @click{} Open ...}
2566 \def\clicksequence#1{\begingroup #1\endgroup}
2568 % @clickstyle @arrow (by default)
2569 \parseargdef\clickstyle{\def\click{#1}}
2572 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2573 % second argument specifying the text to display and an optional third
2574 % arg as text to display instead of (rather than in addition to) the url
2575 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2576 % a hypertex \special here.
2578 \def\uref#1{\douref #1,,,\finish}
2579 \def\douref#1,#2,#3,#4\finish{\begingroup
2582 \setbox0 = \hbox{\ignorespaces #3}%
2584 \unhbox0 % third arg given, show only that
2586 \setbox0 = \hbox{\ignorespaces #2}%
2589 \unhbox0 % PDF: 2nd arg given, show only it
2591 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2594 \code{#1}% only url given, so show it
2600 % @url synonym for @uref, since that's how everyone uses it.
2604 % rms does not like angle brackets --karl, 17may97.
2605 % So now @email is just like @uref, unless we are pdf.
2607 %\def\email#1{\angleleft{\tt #1}\angleright}
2609 \def\email#1{\doemail#1,,\finish}
2610 \def\doemail#1,#2,#3\finish{\begingroup
2613 \setbox0 = \hbox{\ignorespaces #2}%
2614 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2621 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2622 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2624 \def\dmn#1{\thinspace #1}
2626 % @l was never documented to mean ``switch to the Lisp font'',
2627 % and it is not used as such in any manual I can find. We need it for
2628 % Polish suppressed-l. --karl, 22sep96.
2629 %\def\l#1{{\li #1}\null}
2631 % @acronym for "FBI", "NATO", and the like.
2632 % We print this one point size smaller, since it's intended for
2635 \def\acronym#1{\doacronym #1,,\finish}
2636 \def\doacronym#1,#2,#3\finish{%
2637 {\selectfonts\lsize #1}%
2639 \ifx\temp\empty \else
2640 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2644 % @abbr for "Comput. J." and the like.
2645 % No font change, but don't do end-of-sentence spacing.
2647 \def\abbr#1{\doabbr #1,,\finish}
2648 \def\doabbr#1,#2,#3\finish{%
2649 {\plainfrenchspacing #1}%
2651 \ifx\temp\empty \else
2652 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2656 % @asis just yields its argument. Used with @table, for example.
2660 % @math outputs its argument in math mode.
2662 % One complication: _ usually means subscripts, but it could also mean
2663 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2664 % _ active, and distinguish by seeing if the current family is \slfam,
2665 % which is what @var uses.
2667 \catcode`\_ = \active
2668 \gdef\mathunderscore{%
2670 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2673 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2674 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2675 % particular reason), but this is not advertised and we don't care.
2677 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2678 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2683 \let\\ = \mathbackslash
2685 % make the texinfo accent commands work in math mode
2697 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2699 % Some active characters (such as <) are spaced differently in math.
2700 % We have to reset their definitions in case the @math was an argument
2701 % to a command which sets the catcodes (such as @item or @section).
2704 \catcode`^ = \active
2705 \catcode`< = \active
2706 \catcode`> = \active
2707 \catcode`+ = \active
2708 \catcode`' = \active
2714 \let' = \ptexquoteright
2725 % Used to generate quoted braces. Unless we're in typewriter, use
2726 % \ecfont because the CM text fonts do not have braces, and we don't
2727 % want to switch into math.
2728 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2729 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2733 % Definitions to produce \{ and \} commands for indices,
2734 % and @{ and @} for the aux/toc files.
2735 \catcode`\{ = \other \catcode`\} = \other
2736 \catcode`\[ = 1 \catcode`\] = 2
2737 \catcode`\! = 0 \catcode`\\ = \other
2738 !gdef!lbracecmd[\{]%
2739 !gdef!rbracecmd[\}]%
2740 !gdef!lbraceatcmd[@{]%
2741 !gdef!rbraceatcmd[@}]%
2744 % @comma{} to avoid , parsing problems.
2747 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2748 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2750 \let\dotaccent = \ptexdot
2751 \def\ringaccent#1{{\accent23 #1}}
2752 \let\tieaccent = \ptext
2753 \let\ubaraccent = \ptexb
2754 \let\udotaccent = \d
2756 % Other special characters: @questiondown @exclamdown @ordf @ordm
2757 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2758 \def\questiondown{?`}
2760 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2761 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2763 % Dotless i and dotless j, used for accents.
2768 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2769 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2770 \else \errmessage{@dotless can be used only with i or j}%
2774 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2775 % period following counts as ending a sentence. (Idea found in latex.)
2777 \edef\TeX{\TeX \spacefactor=1000 }
2779 % @LaTeX{} logo. Not quite the same results as the definition in
2780 % latex.ltx, since we use a different font for the raised A; it's most
2781 % convenient for us to use an explicitly smaller font, rather than using
2782 % the \scriptstyle font (since we don't reset \scriptstyle and
2783 % \scriptscriptstyle).
2788 \vbox to \ht0{\hbox{%
2789 \ifx\textnominalsize\xwordpt
2790 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2791 % Revert to plain's \scriptsize, which is 7pt.
2792 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2794 % For 11pt, we can use our lllsize.
2795 \selectfonts\lllsize A%
2804 % Some math mode symbols.
2805 \def\bullet{$\ptexbullet$}
2806 \def\geq{\ifmmode \ge\else $\ge$\fi}
2807 \def\leq{\ifmmode \le\else $\le$\fi}
2808 \def\minus{\ifmmode -\else $-$\fi}
2810 % @dots{} outputs an ellipsis using the current font.
2811 % We do .5em per period so that it has the same spacing in the cm
2812 % typewriter fonts as three actual period characters; on the other hand,
2813 % in other typewriter fonts three periods are wider than 1.5em. So do
2814 % whichever is larger.
2818 \setbox0=\hbox{...}% get width of three periods
2825 \hskip 0pt plus.25fil
2826 .\hskip 0pt plus1fil
2827 .\hskip 0pt plus1fil
2828 .\hskip 0pt plus.5fil
2832 % @enddots{} is an end-of-sentence ellipsis.
2836 \spacefactor=\endofsentencespacefactor
2839 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2841 % Since these characters are used in examples, they should be an even number of
2842 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2845 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2846 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2847 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2848 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2849 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2851 % The @error{} command.
2852 % Adapted from the TeXbook's \boxit.
2856 {\tentt \global\dimen0 = 3em}% Width of the box.
2857 \dimen2 = .55pt % Thickness of rules
2858 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2859 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2861 \setbox\errorbox=\hbox to \dimen0{\hfil
2862 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2863 \advance\hsize by -2\dimen2 % Rules.
2865 \hrule height\dimen2
2866 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2867 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2868 \kern3pt\vrule width\dimen2}% Space to right.
2869 \hrule height\dimen2}
2872 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2874 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2876 \def\pounds{{\it\$}}
2878 % @euro{} comes from a separate font, depending on the current style.
2879 % We use the free feym* fonts from the eurosym package by Henrik
2880 % Theiling, which support regular, slanted, bold and bold slanted (and
2881 % "outlined" (blackboard board, sort of) versions, which we don't need).
2882 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2884 % Although only regular is the truly official Euro symbol, we ignore
2885 % that. The Euro is designed to be slightly taller than the regular
2891 % feybo - bold slanted
2893 % There is no good (free) typewriter version, to my knowledge.
2894 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2897 % Also doesn't work in math. Do we need to do math with euro symbols?
2901 \def\euro{{\eurofont e}}
2903 % We set the font at each command, rather than predefining it in
2904 % \textfonts and the other font-switching commands, so that
2905 % installations which never need the symbol don't have to have the
2908 % There is only one designed size (nominal 10pt), so we always scale
2909 % that to the current nominal size.
2911 % By the way, simply using "at 1em" works for cmr10 and the like, but
2912 % does not work for cmbx10 and other extended/shrunken fonts.
2914 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2916 \ifx\curfontstyle\bfstylename
2918 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2921 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2926 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2927 % sometimes we redefine the original macro, and the alias should reflect
2930 % Use LaTeX names for the Icelandic letters.
2931 \def\DH{{\ecfont \char"D0}} % Eth
2932 \def\dh{{\ecfont \char"F0}} % eth
2933 \def\TH{{\ecfont \char"DE}} % Thorn
2934 \def\th{{\ecfont \char"FE}} % thorn
2936 \def\guillemetleft{{\ecfont \char"13}}
2937 \def\guillemotleft{\guillemetleft}
2938 \def\guillemetright{{\ecfont \char"14}}
2939 \def\guillemotright{\guillemetright}
2940 \def\guilsinglleft{{\ecfont \char"0E}}
2941 \def\guilsinglright{{\ecfont \char"0F}}
2942 \def\quotedblbase{{\ecfont \char"12}}
2943 \def\quotesinglbase{{\ecfont \char"0D}}
2945 % This positioning is not perfect (see the ogonek LaTeX package), but
2946 % we have the precomposed glyphs for the most common cases. We put the
2947 % tests to use those glyphs in the single \ogonek macro so we have fewer
2948 % dummy definitions to worry about for index entries, etc.
2950 % ogonek is also used with other letters in Lithuanian (IOU), but using
2951 % the precomposed glyphs for those is not so easy since they aren't in
2955 \ifx\temp\macrocharA\Aogonek
2956 \else\ifx\temp\macrochara\aogonek
2957 \else\ifx\temp\macrocharE\Eogonek
2958 \else\ifx\temp\macrochare\eogonek
2960 \ecfont \setbox0=\hbox{#1}%
2961 \ifdim\ht0=1ex\accent"0C #1%
2962 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2967 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2968 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2969 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2970 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2972 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2974 % We can't distinguish serif/sans and italic/slanted, but this
2975 % is used for crude hacks anyway (like adding French and German
2976 % quotes to documents typeset with CM, where we lose kerning), so
2977 % hopefully nobody will notice/care.
2978 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2979 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2980 \ifx\curfontstyle\bfstylename
2982 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2985 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2990 % @registeredsymbol - R in a circle. The font for the R should really
2991 % be smaller yet, but lllsize is the best we can do for now.
2992 % Adapted from the plain.tex definition of \copyright.
2994 \def\registeredsymbol{%
2995 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3000 % @textdegree - the normal degrees sign.
3002 \def\textdegree{$^\circ$}
3004 % Laurent Siebenmann reports \Orb undefined with:
3005 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3006 % so we'll define it if necessary.
3009 \def\Orb{\mathhexbox20D}
3013 \chardef\quotedblleft="5C
3014 \chardef\quotedblright=`\"
3015 \chardef\quoteleft=`\`
3016 \chardef\quoteright=`\'
3019 \message{page headings,}
3021 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3022 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3024 % First the title page. Must do @settitle before @titlepage.
3026 \newif\iffinishedtitlepage
3028 % Do an implicit @contents or @shortcontents after @end titlepage if the
3029 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3031 \newif\ifsetcontentsaftertitlepage
3032 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3033 \newif\ifsetshortcontentsaftertitlepage
3034 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3036 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3037 \endgroup\page\hbox{}\page}
3040 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3042 \parindent=0pt \textfonts
3043 % Leave some space at the very top of the page.
3044 \vglue\titlepagetopglue
3045 % No rule at page bottom unless we print one at the top with @title.
3046 \finishedtitlepagetrue
3048 % Most title ``pages'' are actually two pages long, with space
3049 % at the top of the second. We don't want the ragged left on the second.
3050 \let\oldpage = \page
3052 \iffinishedtitlepage\else
3055 \let\page = \oldpage
3062 \iffinishedtitlepage\else
3065 % It is important to do the page break before ending the group,
3066 % because the headline and footline are only empty inside the group.
3067 % If we use the new definition of \page, we always get a blank page
3068 % after the title page, which we certainly don't want.
3072 % Need this before the \...aftertitlepage checks so that if they are
3073 % in effect the toc pages will come out with page numbers.
3076 % If they want short, they certainly want long too.
3077 \ifsetshortcontentsaftertitlepage
3080 \global\let\shortcontents = \relax
3081 \global\let\contents = \relax
3084 \ifsetcontentsaftertitlepage
3086 \global\let\contents = \relax
3087 \global\let\shortcontents = \relax
3091 \def\finishtitlepage{%
3092 \vskip4pt \hrule height 2pt width \hsize
3093 \vskip\titlepagebottomglue
3094 \finishedtitlepagetrue
3097 %%% Macros to be used within @titlepage:
3099 \let\subtitlerm=\tenrm
3100 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3102 \parseargdef\title{%
3104 \leftline{\titlefonts\rmisbold #1}
3105 % print a rule at the page bottom also.
3106 \finishedtitlepagefalse
3107 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3110 \parseargdef\subtitle{%
3112 {\subtitlefont \rightline{#1}}%
3115 % @author should come last, but may come many times.
3116 % It can also be used inside @quotation.
3118 \parseargdef\author{%
3119 \def\temp{\quotation}%
3121 \def\quotationauthor{#1}% printed in \Equotation.
3124 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3125 {\secfonts\rmisbold \leftline{#1}}%
3130 %%% Set up page headings and footings.
3132 \let\thispage=\folio
3134 \newtoks\evenheadline % headline on even pages
3135 \newtoks\oddheadline % headline on odd pages
3136 \newtoks\evenfootline % footline on even pages
3137 \newtoks\oddfootline % footline on odd pages
3139 % Now make TeX use those variables
3140 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3141 \else \the\evenheadline \fi}}
3142 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3143 \else \the\evenfootline \fi}\HEADINGShook}
3144 \let\HEADINGShook=\relax
3146 % Commands to set those variables.
3147 % For example, this is what @headings on does
3148 % @evenheading @thistitle|@thispage|@thischapter
3149 % @oddheading @thischapter|@thispage|@thistitle
3150 % @evenfooting @thisfile||
3151 % @oddfooting ||@thisfile
3154 \def\evenheading{\parsearg\evenheadingxxx}
3155 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3156 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3157 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3159 \def\oddheading{\parsearg\oddheadingxxx}
3160 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3161 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3162 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3164 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3166 \def\evenfooting{\parsearg\evenfootingxxx}
3167 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3168 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3169 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3171 \def\oddfooting{\parsearg\oddfootingxxx}
3172 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3173 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3174 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3176 % Leave some space for the footline. Hopefully ok to assume
3177 % @evenfooting will not be used by itself.
3178 \global\advance\pageheight by -12pt
3179 \global\advance\vsize by -12pt
3182 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3184 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3185 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3187 % The same set of arguments for:
3192 % @everyheadingmarks
3193 % @everyfootingmarks
3195 \def\evenheadingmarks{\headingmarks{even}{heading}}
3196 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3197 \def\evenfootingmarks{\headingmarks{even}{footing}}
3198 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3199 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3200 \headingmarks{odd}{heading}{#1} }
3201 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3202 \headingmarks{odd}{footing}{#1} }
3203 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3204 \def\headingmarks#1#2#3 {%
3205 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3206 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3209 \everyheadingmarks bottom
3210 \everyfootingmarks bottom
3212 % @headings double turns headings on for double-sided printing.
3213 % @headings single turns headings on for single-sided printing.
3214 % @headings off turns them off.
3215 % @headings on same as @headings double, retained for compatibility.
3216 % @headings after turns on double-sided headings after this page.
3217 % @headings doubleafter turns on double-sided headings after this page.
3218 % @headings singleafter turns on single-sided headings after this page.
3219 % By default, they are off at the start of a document,
3220 % and turned `on' after @end titlepage.
3222 \def\headings #1 {\csname HEADINGS#1\endcsname}
3224 \def\headingsoff{% non-global headings elimination
3225 \evenheadline={\hfil}\evenfootline={\hfil}%
3226 \oddheadline={\hfil}\oddfootline={\hfil}%
3229 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3230 \HEADINGSoff % it's the default
3232 % When we turn headings on, set the page number to 1.
3233 % For double-sided printing, put current file name in lower left corner,
3234 % chapter name on inside top of right hand pages, document
3235 % title on inside top of left hand pages, and page numbers on outside top
3236 % edge of all pages.
3237 \def\HEADINGSdouble{%
3239 \global\evenfootline={\hfil}
3240 \global\oddfootline={\hfil}
3241 \global\evenheadline={\line{\folio\hfil\thistitle}}
3242 \global\oddheadline={\line{\thischapter\hfil\folio}}
3243 \global\let\contentsalignmacro = \chapoddpage
3245 \let\contentsalignmacro = \chappager
3247 % For single-sided printing, chapter title goes across top left of page,
3248 % page number on top right.
3249 \def\HEADINGSsingle{%
3251 \global\evenfootline={\hfil}
3252 \global\oddfootline={\hfil}
3253 \global\evenheadline={\line{\thischapter\hfil\folio}}
3254 \global\oddheadline={\line{\thischapter\hfil\folio}}
3255 \global\let\contentsalignmacro = \chappager
3257 \def\HEADINGSon{\HEADINGSdouble}
3259 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3260 \let\HEADINGSdoubleafter=\HEADINGSafter
3261 \def\HEADINGSdoublex{%
3262 \global\evenfootline={\hfil}
3263 \global\oddfootline={\hfil}
3264 \global\evenheadline={\line{\folio\hfil\thistitle}}
3265 \global\oddheadline={\line{\thischapter\hfil\folio}}
3266 \global\let\contentsalignmacro = \chapoddpage
3269 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3270 \def\HEADINGSsinglex{%
3271 \global\evenfootline={\hfil}
3272 \global\oddfootline={\hfil}
3273 \global\evenheadline={\line{\thischapter\hfil\folio}}
3274 \global\oddheadline={\line{\thischapter\hfil\folio}}
3275 \global\let\contentsalignmacro = \chappager
3278 % Subroutines used in generating headings
3279 % This produces Day Month Year style of output.
3280 % Only define if not already defined, in case a txi-??.tex file has set
3281 % up a different format (e.g., txi-cs.tex does this).
3282 \ifx\today\undefined
3286 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3287 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3288 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3293 % @settitle line... specifies the title of the document, for headings.
3294 % It generates no output of its own.
3295 \def\thistitle{\putwordNoTitle}
3296 \def\settitle{\parsearg{\gdef\thistitle}}
3300 % Tables -- @table, @ftable, @vtable, @item(x).
3302 % default indentation of table text
3303 \newdimen\tableindent \tableindent=.8in
3304 % default indentation of @itemize and @enumerate text
3305 \newdimen\itemindent \itemindent=.3in
3306 % margin between end of table item and start of table text.
3307 \newdimen\itemmargin \itemmargin=.1in
3309 % used internally for \itemindent minus \itemmargin
3312 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3314 % They also define \itemindex
3315 % to index the item name in whatever manner is desired (perhaps none).
3317 \newif\ifitemxneedsnegativevskip
3319 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3321 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3322 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3324 \def\itemzzz #1{\begingroup %
3325 \advance\hsize by -\rightskip
3326 \advance\hsize by -\tableindent
3327 \setbox0=\hbox{\itemindicate{#1}}%
3329 \nobreak % This prevents a break before @itemx.
3331 % If the item text does not fit in the space we have, put it on a line
3332 % by itself, and do not allow a page break either before or after that
3333 % line. We do not start a paragraph here because then if the next
3334 % command is, e.g., @kindex, the whatsit would get put into the
3335 % horizontal list on a line by itself, resulting in extra blank space.
3336 \ifdim \wd0>\itemmax
3338 % Make this a paragraph so we get the \parskip glue and wrapping,
3339 % but leave it ragged-right.
3341 \advance\leftskip by-\tableindent
3342 \advance\hsize by\tableindent
3343 \advance\rightskip by0pt plus1fil\relax
3344 \leavevmode\unhbox0\par
3347 % We're going to be starting a paragraph, but we don't want the
3348 % \parskip glue -- logically it's part of the @item we just started.
3349 \nobreak \vskip-\parskip
3351 % Stop a page break at the \parskip glue coming up. However, if
3352 % what follows is an environment such as @example, there will be no
3353 % \parskip glue; then the negative vskip we just inserted would
3354 % cause the example and the item to crash together. So we use this
3355 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3356 % \parskip glue after all. Section titles are handled this way also.
3360 \itemxneedsnegativevskipfalse
3362 % The item text fits into the space. Start a paragraph, so that the
3363 % following text (if any) will end up on the same line.
3365 % Do this with kerns and \unhbox so that if there is a footnote in
3366 % the item text, it can migrate to the main vertical list and
3367 % eventually be printed.
3368 \nobreak\kern-\tableindent
3369 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3371 \nobreak\kern\dimen0
3373 \itemxneedsnegativevskiptrue
3377 \def\item{\errmessage{@item while not in a list environment}}
3378 \def\itemx{\errmessage{@itemx while not in a list environment}}
3380 % @table, @ftable, @vtable.
3382 \let\itemindex\gobble
3386 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3387 \tablecheck{ftable}%
3390 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3391 \tablecheck{vtable}%
3394 \ifnum \the\catcode`\^^M=\active
3396 \errmessage{This command won't work in this context; perhaps the problem is
3397 that we are \inenvironment\thisenv}%
3398 \def\next{\doignore{#1}}%
3405 \def\itemindicate{#1}%
3410 \makevalueexpandable
3411 \edef\temp{\noexpand\tablez #1\space\space\space}%
3415 \def\tablez #1 #2 #3 #4\endtablez{%
3417 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3418 \ifnum 0#2>0 \tableindent=#2\mil \fi
3419 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3420 \itemmax=\tableindent
3421 \advance \itemmax by -\itemmargin
3422 \advance \leftskip by \tableindent
3423 \exdentamount=\tableindent
3425 \parskip = \smallskipamount
3426 \ifdim \parskip=0pt \parskip=2pt \fi
3427 \let\item = \internalBitem
3428 \let\itemx = \internalBitemx
3430 \def\Etable{\endgraf\afterenvbreak}
3433 \let\Eitemize\Etable
3434 \let\Eenumerate\Etable
3436 % This is the counter used by @enumerate, which is really @itemize
3440 \envdef\itemize{\parsearg\doitemize}
3444 \itemmax=\itemindent
3445 \advance\itemmax by -\itemmargin
3446 \advance\leftskip by \itemindent
3447 \exdentamount=\itemindent
3449 \parskip=\smallskipamount
3450 \ifdim\parskip=0pt \parskip=2pt \fi
3452 % Try typesetting the item mark that if the document erroneously says
3453 % something like @itemize @samp (intending @table), there's an error
3454 % right away at the @itemize. It's not the best error message in the
3455 % world, but it's better than leaving it to the @item. This means if
3456 % the user wants an empty mark, they have to say @w{} not just @w.
3457 \def\itemcontents{#1}%
3458 \setbox0 = \hbox{\itemcontents}%
3460 % @itemize with no arg is equivalent to @itemize @bullet.
3461 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3463 \let\item=\itemizeitem
3466 % Definition of @item while inside @itemize and @enumerate.
3469 \advance\itemno by 1 % for enumerations
3470 {\let\par=\endgraf \smallbreak}% reasonable place to break
3472 % If the document has an @itemize directly after a section title, a
3473 % \nobreak will be last on the list, and \sectionheading will have
3474 % done a \vskip-\parskip. In that case, we don't want to zero
3475 % parskip, or the item text will crash with the heading. On the
3476 % other hand, when there is normal text preceding the item (as there
3477 % usually is), we do want to zero parskip, or there would be too much
3478 % space. In that case, we won't have a \nobreak before. At least
3479 % that's the theory.
3480 \ifnum\lastpenalty<10000 \parskip=0in \fi
3482 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3484 \vadjust{\penalty 1200}}% not good to break after first line of item.
3488 % \splitoff TOKENS\endmark defines \first to be the first token in
3489 % TOKENS, and \rest to be the remainder.
3491 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3493 % Allow an optional argument of an uppercase letter, lowercase letter,
3494 % or number, to specify the first label in the enumerated list. No
3495 % argument is the same as `1'.
3497 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3498 \def\enumeratey #1 #2\endenumeratey{%
3499 % If we were given no argument, pretend we were given `1'.
3501 \ifx\thearg\empty \def\thearg{1}\fi
3503 % Detect if the argument is a single token. If so, it might be a
3504 % letter. Otherwise, the only valid thing it can be is a number.
3505 % (We will always have one token, because of the test we just made.
3506 % This is a good thing, since \splitoff doesn't work given nothing at
3507 % all -- the first parameter is undelimited.)
3508 \expandafter\splitoff\thearg\endmark
3510 % Only one token in the argument. It could still be anything.
3511 % A ``lowercase letter'' is one whose \lccode is nonzero.
3512 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3513 % not equal to itself.
3514 % Otherwise, we assume it's a number.
3516 % We need the \relax at the end of the \ifnum lines to stop TeX from
3517 % continuing to look for a <number>.
3519 \ifnum\lccode\expandafter`\thearg=0\relax
3520 \numericenumerate % a number (we hope)
3523 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3524 \lowercaseenumerate % lowercase letter
3526 \uppercaseenumerate % uppercase letter
3530 % Multiple tokens in the argument. We hope it's a number.
3535 % An @enumerate whose labels are integers. The starting integer is
3538 \def\numericenumerate{%
3540 \startenumeration{\the\itemno}%
3543 % The starting (lowercase) letter is in \thearg.
3544 \def\lowercaseenumerate{%
3545 \itemno = \expandafter`\thearg
3547 % Be sure we're not beyond the end of the alphabet.
3549 \errmessage{No more lowercase letters in @enumerate; get a bigger
3556 % The starting (uppercase) letter is in \thearg.
3557 \def\uppercaseenumerate{%
3558 \itemno = \expandafter`\thearg
3560 % Be sure we're not beyond the end of the alphabet.
3562 \errmessage{No more uppercase letters in @enumerate; get a bigger
3569 % Call \doitemize, adding a period to the first argument and supplying the
3570 % common last two arguments. Also subtract one from the initial value in
3571 % \itemno, since @item increments \itemno.
3573 \def\startenumeration#1{%
3574 \advance\itemno by -1
3575 \doitemize{#1.}\flushcr
3578 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3581 \def\alphaenumerate{\enumerate{a}}
3582 \def\capsenumerate{\enumerate{A}}
3583 \def\Ealphaenumerate{\Eenumerate}
3584 \def\Ecapsenumerate{\Eenumerate}
3587 % @multitable macros
3588 % Amy Hendrickson, 8/18/94, 3/6/96
3590 % @multitable ... @end multitable will make as many columns as desired.
3591 % Contents of each column will wrap at width given in preamble. Width
3592 % can be specified either with sample text given in a template line,
3593 % or in percent of \hsize, the current width of text on page.
3595 % Table can continue over pages but will only break between lines.
3599 % Either define widths of columns in terms of percent of \hsize:
3600 % @multitable @columnfractions .25 .3 .45
3603 % Numbers following @columnfractions are the percent of the total
3604 % current hsize to be used for each column. You may use as many
3605 % columns as desired.
3608 % Or use a template:
3609 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3611 % using the widest term desired in each column.
3613 % Each new table line starts with @item, each subsequent new column
3614 % starts with @tab. Empty columns may be produced by supplying @tab's
3615 % with nothing between them for as many times as empty columns are needed,
3616 % ie, @tab@tab@tab will produce two empty columns.
3618 % @item, @tab do not need to be on their own lines, but it will not hurt
3621 % Sample multitable:
3623 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3624 % @item first col stuff @tab second col stuff @tab third col
3631 % @item first col stuff @tab second col stuff
3632 % @tab Many paragraphs of text may be used in any column.
3634 % They will wrap at the width determined by the template.
3635 % @item@tab@tab This will be in third column.
3638 % Default dimensions may be reset by user.
3639 % @multitableparskip is vertical space between paragraphs in table.
3640 % @multitableparindent is paragraph indent in table.
3641 % @multitablecolmargin is horizontal space to be left between columns.
3642 % @multitablelinespace is space to leave between table items, baseline
3644 % 0pt means it depends on current normal line spacing.
3646 \newskip\multitableparskip
3647 \newskip\multitableparindent
3648 \newdimen\multitablecolspace
3649 \newskip\multitablelinespace
3650 \multitableparskip=0pt
3651 \multitableparindent=6pt
3652 \multitablecolspace=12pt
3653 \multitablelinespace=0pt
3655 % Macros used to set up halign preamble:
3657 \let\endsetuptable\relax
3658 \def\xendsetuptable{\endsetuptable}
3659 \let\columnfractions\relax
3660 \def\xcolumnfractions{\columnfractions}
3663 % #1 is the @columnfraction, usually a decimal number like .5, but might
3664 % be just 1. We just use it, whatever it is.
3666 \def\pickupwholefraction#1 {%
3667 \global\advance\colcount by 1
3668 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3675 \ifx\firstarg\xendsetuptable
3678 \ifx\firstarg\xcolumnfractions
3679 \global\setpercenttrue
3682 \let\go\pickupwholefraction
3684 \global\advance\colcount by 1
3685 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3686 % separator; typically that is always in the input, anyway.
3687 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3690 \ifx\go\pickupwholefraction
3691 % Put the argument back for the \pickupwholefraction call, so
3692 % we'll always have a period there to be parsed.
3693 \def\go{\pickupwholefraction#1}%
3695 \let\go = \setuptable
3701 % multitable-only commands.
3703 % @headitem starts a heading row, which we typeset in bold.
3704 % Assignments have to be global since we are inside the implicit group
3705 % of an alignment entry. \everycr resets \everytab so we don't have to
3706 % undo it ourselves.
3707 \def\headitemfont{\b}% for people to use in the template row; not changeable
3709 \checkenv\multitable
3711 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3712 \the\everytab % for the first item
3715 % A \tab used to include \hskip1sp. But then the space in a template
3716 % line is not enough. That is bad. So let's go back to just `&' until
3717 % we again encounter the problem the 1sp was intended to solve.
3718 % --karl, nathan@acm.org, 20apr99.
3719 \def\tab{\checkenv\multitable &\the\everytab}%
3721 % @multitable ... @end multitable definitions:
3723 \newtoks\everytab % insert after every tab.
3725 \envdef\multitable{%
3729 % @item within a multitable starts a normal row.
3730 % We use \def instead of \let so that if one of the multitable entries
3731 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3732 % \endtemplate) expanding \doitemize.
3737 \setmultitablespacing
3738 \parskip=\multitableparskip
3739 \parindent=\multitableparindent
3745 \global\everytab={}%
3746 \global\colcount=0 % Reset the column counter.
3747 % Check for saved footnotes, etc.
3749 % Keeps underfull box messages off when table breaks over pages.
3751 % Maybe so, but it also creates really weird page breaks when the
3752 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3753 % problem manifests itself, so it can be fixed for real --karl.
3757 \parsearg\domultitable
3759 \def\domultitable#1{%
3760 % To parse everything between @multitable and @item:
3761 \setuptable#1 \endsetuptable
3763 % This preamble sets up a generic column definition, which will
3764 % be used as many times as user calls for columns.
3765 % \vtop will set a single line and will also let text wrap and
3766 % continue for many paragraphs if desired.
3768 \global\advance\colcount by 1
3771 % Use the current \colcount to find the correct column width:
3772 \hsize=\expandafter\csname col\the\colcount\endcsname
3774 % In order to keep entries from bumping into each other
3775 % we will add a \leftskip of \multitablecolspace to all columns after
3778 % If a template has been used, we will add \multitablecolspace
3779 % to the width of each template entry.
3781 % If the user has set preamble in terms of percent of \hsize we will
3782 % use that dimension as the width of the column, and the \leftskip
3783 % will keep entries from bumping into each other. Table will start at
3784 % left margin and final column will justify at right margin.
3786 % Make sure we don't inherit \rightskip from the outer environment.
3789 % The first column will be indented with the surrounding text.
3790 \advance\hsize by\leftskip
3793 % If user has not set preamble in terms of percent of \hsize
3794 % we will advance \hsize by \multitablecolspace.
3795 \advance\hsize by \multitablecolspace
3797 % In either case we will make \leftskip=\multitablecolspace:
3798 \leftskip=\multitablecolspace
3800 % Ignoring space at the beginning and end avoids an occasional spurious
3801 % blank line, when TeX decides to break the line at the space before the
3802 % box from the multistrut, so the strut ends up on a line by itself.
3804 % @multitable @columnfractions .11 .89
3806 % @tab Legal holiday which is valid in major parts of the whole country.
3807 % Is automatically provided with highlighting sequences respectively
3808 % marking characters.
3809 \noindent\ignorespaces##\unskip\multistrut
3814 \egroup % end the \halign
3815 \global\setpercentfalse
3818 \def\setmultitablespacing{%
3819 \def\multistrut{\strut}% just use the standard line spacing
3821 % Compute \multitablelinespace (if not defined by user) for use in
3822 % \multitableparskip calculation. We used define \multistrut based on
3823 % this, but (ironically) that caused the spacing to be off.
3824 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3825 \ifdim\multitablelinespace=0pt
3826 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3827 \global\advance\multitablelinespace by-\ht0
3829 %% Test to see if parskip is larger than space between lines of
3830 %% table. If not, do nothing.
3831 %% If so, set to same dimension as multitablelinespace.
3832 \ifdim\multitableparskip>\multitablelinespace
3833 \global\multitableparskip=\multitablelinespace
3834 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3835 %% than skip between lines in the table.
3837 \ifdim\multitableparskip=0pt
3838 \global\multitableparskip=\multitablelinespace
3839 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3840 %% than skip between lines in the table.
3844 \message{conditionals,}
3846 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3847 % @ifnotxml always succeed. They currently do nothing; we don't
3848 % attempt to check whether the conditionals are properly nested. But we
3849 % have to remember that they are conditionals, so that @end doesn't
3850 % attempt to close an environment group.
3853 \expandafter\let\csname #1\endcsname = \relax
3854 \expandafter\let\csname iscond.#1\endcsname = 1
3857 \makecond{ifnotdocbook}
3858 \makecond{ifnothtml}
3859 \makecond{ifnotinfo}
3860 \makecond{ifnotplaintext}
3863 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3865 \def\direntry{\doignore{direntry}}
3866 \def\documentdescription{\doignore{documentdescription}}
3867 \def\docbook{\doignore{docbook}}
3868 \def\html{\doignore{html}}
3869 \def\ifdocbook{\doignore{ifdocbook}}
3870 \def\ifhtml{\doignore{ifhtml}}
3871 \def\ifinfo{\doignore{ifinfo}}
3872 \def\ifnottex{\doignore{ifnottex}}
3873 \def\ifplaintext{\doignore{ifplaintext}}
3874 \def\ifxml{\doignore{ifxml}}
3875 \def\ignore{\doignore{ignore}}
3876 \def\menu{\doignore{menu}}
3877 \def\xml{\doignore{xml}}
3879 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3881 % A count to remember the depth of nesting.
3882 \newcount\doignorecount
3884 \def\doignore#1{\begingroup
3885 % Scan in ``verbatim'' mode:
3887 \catcode`\@ = \other
3888 \catcode`\{ = \other
3889 \catcode`\} = \other
3891 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3894 % Count number of #1's that we've seen.
3897 % Swallow text until we reach the matching `@end #1'.
3901 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3904 \gdef\dodoignore#1{%
3905 % #1 contains the command name as a string, e.g., `ifinfo'.
3907 % Define a command to find the next `@end #1'.
3908 \long\def\doignoretext##1^^M@end #1{%
3909 \doignoretextyyy##1^^M@#1\_STOP_}%
3911 % And this command to find another #1 command, at the beginning of a
3912 % line. (Otherwise, we would consider a line `@c @ifset', for
3913 % example, to count as an @ifset for nesting.)
3914 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3916 % And now expand that command.
3921 \def\doignoreyyy#1{%
3923 \ifx\temp\empty % Nothing found.
3924 \let\next\doignoretextzzz
3925 \else % Found a nested condition, ...
3926 \advance\doignorecount by 1
3927 \let\next\doignoretextyyy % ..., look for another.
3928 % If we're here, #1 ends with ^^M\ifinfo (for example).
3930 \next #1% the token \_STOP_ is present just after this macro.
3933 % We have to swallow the remaining "\_STOP_".
3935 \def\doignoretextzzz#1{%
3936 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3937 \let\next\enddoignore
3938 \else % Still inside a nested condition.
3939 \advance\doignorecount by -1
3940 \let\next\doignoretext % Look for the next @end.
3945 % Finish off ignored text.
3947 % Ignore anything after the last `@end #1'; this matters in verbatim
3948 % environments, where otherwise the newline after an ignored conditional
3949 % would result in a blank line in the output.
3950 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3954 % @set VAR sets the variable VAR to an empty value.
3955 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3957 % Since we want to separate VAR from REST-OF-LINE (which might be
3958 % empty), we can't just use \parsearg; we have to insert a space of our
3959 % own to delimit the rest of the line, and then take it out again if we
3961 % We rely on the fact that \parsearg sets \catcode`\ =10.
3963 \parseargdef\set{\setyyy#1 \endsetyyy}
3964 \def\setyyy#1 #2\endsetyyy{%
3966 \makevalueexpandable
3968 \edef\next{\gdef\makecsname{SET#1}}%
3976 % Remove the trailing space \setxxx inserted.
3977 \def\setzzz#1 \endsetzzz{\next{#1}}
3979 % @clear VAR clears (i.e., unsets) the variable VAR.
3981 \parseargdef\clear{%
3983 \makevalueexpandable
3984 \global\expandafter\let\csname SET#1\endcsname=\relax
3988 % @value{foo} gets the text saved in variable foo.
3989 \def\value{\begingroup\makevalueexpandable\valuexxx}
3990 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3992 \catcode`\- = \active \catcode`\_ = \active
3994 \gdef\makevalueexpandable{%
3995 \let\value = \expandablevalue
3996 % We don't want these characters active, ...
3997 \catcode`\-=\other \catcode`\_=\other
3998 % ..., but we might end up with active ones in the argument if
3999 % we're called from @code, as @code{@value{foo-bar_}}, though.
4000 % So \let them to their normal equivalents.
4001 \let-\realdash \let_\normalunderscore
4005 % We have this subroutine so that we can handle at least some @value's
4006 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4007 % The command has to be fully expandable (if the variable is set), since
4008 % the result winds up in the index file. This means that if the
4009 % variable's value contains other Texinfo commands, it's almost certain
4010 % it will fail (although perhaps we could fix that with sufficient work
4011 % to do a one-level expansion on the result, instead of complete).
4013 \def\expandablevalue#1{%
4014 \expandafter\ifx\csname SET#1\endcsname\relax
4015 {[No value for ``#1'']}%
4016 \message{Variable `#1', used in @value, is not set.}%
4018 \csname SET#1\endcsname
4022 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4025 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4028 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4031 \makevalueexpandable
4033 \expandafter\ifx\csname SET#2\endcsname\relax
4034 #1% If not set, redefine \next.
4039 \def\ifsetfail{\doignore{ifset}}
4041 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4042 % defined with @set, or has been undefined with @clear.
4044 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4045 % above code: if the variable is not set, do nothing, if it is set,
4046 % then redefine \next to \ifclearfail.
4049 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4050 \def\ifclearfail{\doignore{ifclear}}
4052 % @dircategory CATEGORY -- specify a category of the dir file
4053 % which this file should belong to. Ignore this in TeX.
4054 \let\dircategory=\comment
4056 % @defininfoenclose.
4057 \let\definfoenclose=\comment
4061 % Index generation facilities
4063 % Define \newwrite to be identical to plain tex's \newwrite
4064 % except not \outer, so it can be used within macros and \if's.
4065 \edef\newwrite{\makecsname{ptexnewwrite}}
4067 % \newindex {foo} defines an index named foo.
4068 % It automatically defines \fooindex such that
4069 % \fooindex ...rest of line... puts an entry in the index foo.
4070 % It also defines \fooindfile to be the number of the output channel for
4071 % the file that accumulates this index. The file's extension is foo.
4072 % The name of an index should be no more than 2 characters long
4073 % for the sake of vms.
4077 \expandafter\newwrite \csname#1indfile\endcsname
4078 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4080 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4081 \noexpand\doindex{#1}}
4084 % @defindex foo == \newindex{foo}
4086 \def\defindex{\parsearg\newindex}
4088 % Define @defcodeindex, like @defindex except put all entries in @code.
4090 \def\defcodeindex{\parsearg\newcodeindex}
4092 \def\newcodeindex#1{%
4094 \expandafter\newwrite \csname#1indfile\endcsname
4095 \openout \csname#1indfile\endcsname \jobname.#1
4097 \expandafter\xdef\csname#1index\endcsname{%
4098 \noexpand\docodeindex{#1}}%
4102 % @synindex foo bar makes index foo feed into index bar.
4103 % Do this instead of @defindex foo if you don't want it as a separate index.
4105 % @syncodeindex foo bar similar, but put all entries made for index foo
4108 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4109 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4111 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4112 % #3 the target index (bar).
4113 \def\dosynindex#1#2#3{%
4114 % Only do \closeout if we haven't already done it, else we'll end up
4115 % closing the target index.
4116 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4117 % The \closeout helps reduce unnecessary open files; the limit on the
4118 % Acorn RISC OS is a mere 16 files.
4119 \expandafter\closeout\csname#2indfile\endcsname
4120 \expandafter\let\csname donesynindex#2\endcsname = 1
4122 % redefine \fooindfile:
4123 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4124 \expandafter\let\csname#2indfile\endcsname=\temp
4125 % redefine \fooindex:
4126 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4129 % Define \doindex, the driver for all \fooindex macros.
4130 % Argument #1 is generated by the calling \fooindex macro,
4131 % and it is "foo", the name of the index.
4133 % \doindex just uses \parsearg; it calls \doind for the actual work.
4134 % This is because \doind is more useful to call from other macros.
4136 % There is also \dosubind {index}{topic}{subtopic}
4137 % which makes an entry in a two-level index such as the operation index.
4139 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4140 \def\singleindexer #1{\doind{\indexname}{#1}}
4142 % like the previous two, but they put @code around the argument.
4143 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4144 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4146 % Take care of Texinfo commands that can appear in an index entry.
4147 % Since there are some commands we want to expand, and others we don't,
4148 % we have to laboriously prevent expansion for those that we don't.
4151 \escapechar = `\\ % use backslash in output files.
4152 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4153 \def\ {\realbackslash\space }%
4155 % Need these unexpandable (because we define \tt as a dummy)
4156 % definitions when @{ or @} appear in index entry text. Also, more
4157 % complicated, when \tex is in effect and \{ is a \delimiter again.
4158 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4159 % braces and backslashes are used only as delimiters. Perhaps we
4160 % should define @lbrace and @rbrace commands a la @comma.
4161 \def\{{{\tt\char123}}%
4162 \def\}{{\tt\char125}}%
4164 % I don't entirely understand this, but when an index entry is
4165 % generated from a macro call, the \endinput which \scanmacro inserts
4166 % causes processing to be prematurely terminated. This is,
4167 % apparently, because \indexsorttmp is fully expanded, and \endinput
4168 % is an expandable command. The redefinition below makes \endinput
4169 % disappear altogether for that purpose -- although logging shows that
4170 % processing continues to some further point. On the other hand, it
4171 % seems \endinput does not hurt in the printed index arg, since that
4172 % is still getting written without apparent harm.
4174 % Sample source (mac-idx3.tex, reported by Graham Percival to
4175 % help-texinfo, 22may06):
4176 % @macro funindex {WORD}
4180 % @funindex commtest
4182 % The above is not enough to reproduce the bug, but it gives the flavor.
4184 % Sample whatsit resulting:
4185 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4188 \let\endinput = \empty
4190 % Do the redefinitions.
4194 % For the aux and toc files, @ is the escape character. So we want to
4195 % redefine everything using @ as the escape character (instead of
4196 % \realbackslash, still used for index files). When everything uses @,
4197 % this will be simpler.
4202 \let\{ = \lbraceatcmd
4203 \let\} = \rbraceatcmd
4205 % Do the redefinitions.
4210 % Called from \indexdummies and \atdummies.
4212 \def\commondummies{%
4214 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4215 % preventing its expansion. This is used only for control words,
4216 % not control letters, because the \space would be incorrect for
4217 % control characters, but is needed to separate the control word
4218 % from whatever follows.
4220 % For control letters, we have \definedummyletter, which omits the
4223 % These can be used both for control words that take an argument and
4224 % those that do not. If it is followed by {arg} in the input, then
4225 % that will dutifully get written to the index (or wherever).
4227 \def\definedummyword ##1{\def##1{\string##1\space}}%
4228 \def\definedummyletter##1{\def##1{\string##1}}%
4229 \let\definedummyaccent\definedummyletter
4231 \commondummiesnofonts
4233 \definedummyletter\_%
4234 \definedummyletter\-%
4236 % Non-English letters.
4247 \definedummyword\exclamdown
4251 \definedummyword\ordf
4252 \definedummyword\ordm
4253 \definedummyword\questiondown
4257 % Although these internal commands shouldn't show up, sometimes they do.
4259 \definedummyword\gtr
4260 \definedummyword\hat
4261 \definedummyword\less
4264 \definedummyword\tclose
4267 \definedummyword\LaTeX
4268 \definedummyword\TeX
4270 % Assorted special characters.
4271 \definedummyword\arrow
4272 \definedummyword\bullet
4273 \definedummyword\comma
4274 \definedummyword\copyright
4275 \definedummyword\registeredsymbol
4276 \definedummyword\dots
4277 \definedummyword\enddots
4278 \definedummyword\entrybreak
4279 \definedummyword\equiv
4280 \definedummyword\error
4281 \definedummyword\euro
4282 \definedummyword\expansion
4283 \definedummyword\geq
4284 \definedummyword\guillemetleft
4285 \definedummyword\guillemetright
4286 \definedummyword\guilsinglleft
4287 \definedummyword\guilsinglright
4288 \definedummyword\leq
4289 \definedummyword\minus
4290 \definedummyword\ogonek
4291 \definedummyword\pounds
4292 \definedummyword\point
4293 \definedummyword\print
4294 \definedummyword\quotedblbase
4295 \definedummyword\quotedblleft
4296 \definedummyword\quotedblright
4297 \definedummyword\quoteleft
4298 \definedummyword\quoteright
4299 \definedummyword\quotesinglbase
4300 \definedummyword\result
4301 \definedummyword\textdegree
4303 % We want to disable all macros so that they are not expanded by \write.
4306 \normalturnoffactive
4308 % Handle some cases of @value -- where it does not contain any
4309 % (non-fully-expandable) commands.
4310 \makevalueexpandable
4313 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4315 \def\commondummiesnofonts{%
4316 % Control letters and accents.
4317 \definedummyletter\!%
4318 \definedummyaccent\"%
4319 \definedummyaccent\'%
4320 \definedummyletter\*%
4321 \definedummyaccent\,%
4322 \definedummyletter\.%
4323 \definedummyletter\/%
4324 \definedummyletter\:%
4325 \definedummyaccent\=%
4326 \definedummyletter\?%
4327 \definedummyaccent\^%
4328 \definedummyaccent\`%
4329 \definedummyaccent\~%
4333 \definedummyword\dotaccent
4334 \definedummyword\ogonek
4335 \definedummyword\ringaccent
4336 \definedummyword\tieaccent
4337 \definedummyword\ubaraccent
4338 \definedummyword\udotaccent
4339 \definedummyword\dotless
4341 % Texinfo font commands.
4345 \definedummyword\sansserif
4347 \definedummyword\slanted
4350 % Commands that take arguments.
4351 \definedummyword\acronym
4352 \definedummyword\cite
4353 \definedummyword\code
4354 \definedummyword\command
4355 \definedummyword\dfn
4356 \definedummyword\dmn
4357 \definedummyword\email
4358 \definedummyword\emph
4359 \definedummyword\env
4360 \definedummyword\file
4361 \definedummyword\indicateurl
4362 \definedummyword\kbd
4363 \definedummyword\key
4364 \definedummyword\math
4365 \definedummyword\option
4366 \definedummyword\pxref
4367 \definedummyword\ref
4368 \definedummyword\samp
4369 \definedummyword\strong
4370 \definedummyword\tie
4371 \definedummyword\uref
4372 \definedummyword\url
4373 \definedummyword\var
4374 \definedummyword\verb
4376 \definedummyword\xref
4379 % \indexnofonts is used when outputting the strings to sort the index
4380 % by, and when constructing control sequence names. It eliminates all
4381 % control sequences and just writes whatever the best ASCII sort string
4382 % would be for a given command (usually its argument).
4385 % Accent commands should become @asis.
4386 \def\definedummyaccent##1{\let##1\asis}%
4387 % We can just ignore other control letters.
4388 \def\definedummyletter##1{\let##1\empty}%
4389 % All control words become @asis by default; overrides below.
4390 \let\definedummyword\definedummyaccent
4392 \commondummiesnofonts
4394 % Don't no-op \tt, since it isn't a user-level command
4395 % and is used in the definitions of the active chars like <, >, |, etc.
4396 % Likewise with the other plain tex font commands.
4401 \def\_{\normalunderscore}%
4402 \def\-{}% @- shouldn't affect sorting
4404 % Unfortunately, texindex is not prepared to handle braces in the
4405 % content at all. So for index sorting, we map @{ and @} to strings
4406 % starting with |, since that ASCII character is between ASCII { and }.
4410 % Non-English letters.
4427 \def\questiondown{?}%
4434 % Assorted special characters.
4435 % (The following {} will end up in the sort string, but that's ok.)
4437 \def\bullet{bullet}%
4439 \def\copyright{copyright}%
4445 \def\expansion{==>}%
4447 \def\guillemetleft{<<}%
4448 \def\guillemetright{>>}%
4449 \def\guilsinglleft{<}%
4450 \def\guilsinglright{>}%
4454 \def\pounds{pounds}%
4456 \def\quotedblbase{"}%
4457 \def\quotedblleft{"}%
4458 \def\quotedblright{"}%
4461 \def\quotesinglbase{,}%
4462 \def\registeredsymbol{R}%
4466 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4467 \else \indexlquoteignore \fi
4469 % We need to get rid of all macros, leaving only the arguments (if present).
4470 % Of course this is not nearly correct, but it is the best we can do for now.
4471 % makeinfo does not expand macros in the argument to @deffn, which ends up
4472 % writing an index entry, and texindex isn't prepared for an index sort entry
4473 % that starts with \.
4475 % Since macro invocations are followed by braces, we can just redefine them
4476 % to take a single TeX argument. The case of a macro invocation that
4477 % goes to end-of-line is not handled.
4482 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4483 % ignore left quotes in the sort term.
4484 {\catcode`\`=\active
4485 \gdef\indexlquoteignore{\let`=\empty}}
4487 \let\indexbackslash=0 %overridden during \printindex.
4488 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4490 % Most index entries go through here, but \dosubind is the general case.
4491 % #1 is the index name, #2 is the entry text.
4492 \def\doind#1#2{\dosubind{#1}{#2}{}}
4494 % Workhorse for all \fooindexes.
4495 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4496 % empty if called from \doind, as we usually are (the main exception
4497 % is with most defuns, which call us directly).
4499 \def\dosubind#1#2#3{%
4502 % Store the main index entry text (including the third arg).
4504 % If third arg is present, precede it with a space.
4506 \ifx\thirdarg\empty \else
4507 \toks0 = \expandafter{\the\toks0 \space #3}%
4510 \edef\writeto{\csname#1indfile\endcsname}%
4512 \safewhatsit\dosubindwrite
4517 % Write the entry in \toks0 to the index file:
4519 \def\dosubindwrite{%
4520 % Put the index entry in the margin if desired.
4521 \ifx\SETmarginindex\relax\else
4522 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4525 % Remember, we are within a group.
4526 \indexdummies % Must do this here, since \bf, etc expand at this stage
4527 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4528 % so it will be output as is; and it will print as backslash.
4530 % Process the index entry with all font commands turned off, to
4531 % get the string to sort by.
4533 \edef\temp{\the\toks0}% need full expansion
4534 \xdef\indexsorttmp{\temp}%
4537 % Set up the complete index entry, with both the sort key and
4538 % the original text, including any font commands. We write
4539 % three arguments to \entry to the .?? file (four in the
4540 % subentry case), texindex reduces to two when writing the .??s
4544 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4549 % Take care of unwanted page breaks/skips around a whatsit:
4551 % If a skip is the last thing on the list now, preserve it
4552 % by backing up by \lastskip, doing the \write, then inserting
4553 % the skip again. Otherwise, the whatsit generated by the
4554 % \write or \pdfdest will make \lastskip zero. The result is that
4555 % sequences like this:
4559 % will have extra space inserted, because the \medbreak in the
4560 % start of the @defun won't see the skip inserted by the @end of
4561 % the previous defun.
4563 % But don't do any of this if we're not in vertical mode. We
4564 % don't want to do a \vskip and prematurely end a paragraph.
4566 % Avoid page breaks due to these extra skips, too.
4568 % But wait, there is a catch there:
4569 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4570 % sufficient for this purpose, as it ignores stretch and shrink parts
4571 % of the skip. The only way seems to be to check the textual
4572 % representation of the skip.
4574 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4575 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4577 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4579 \newskip\whatsitskip
4580 \newcount\whatsitpenalty
4584 \def\safewhatsit#1{%
4588 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4589 \whatsitskip = \lastskip
4590 \edef\lastskipmacro{\the\lastskip}%
4591 \whatsitpenalty = \lastpenalty
4593 % If \lastskip is nonzero, that means the last item was a
4594 % skip. And since a skip is discardable, that means this
4595 % -\whatsitskip glue we're inserting is preceded by a
4596 % non-discardable item, therefore it is not a potential
4597 % breakpoint, therefore no \nobreak needed.
4598 \ifx\lastskipmacro\zeroskipmacro
4605 \ifx\lastskipmacro\zeroskipmacro
4606 % If \lastskip was zero, perhaps the last item was a penalty, and
4607 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4608 % to re-insert the same penalty (values >10000 are used for various
4609 % signals); since we just inserted a non-discardable item, any
4610 % following glue (such as a \parskip) would be a breakpoint. For example:
4612 % @deffn deffn-whatever
4613 % @vindex index-whatever
4615 % would allow a break between the index-whatever whatsit
4616 % and the "Description." paragraph.
4617 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4619 % On the other hand, if we had a nonzero \lastskip,
4620 % this make-up glue would be preceded by a non-discardable item
4621 % (the whatsit from the \write), so we must insert a \nobreak.
4622 \nobreak\vskip\whatsitskip
4627 % The index entry written in the file actually looks like
4628 % \entry {sortstring}{page}{topic}
4630 % \entry {sortstring}{page}{topic}{subtopic}
4631 % The texindex program reads in these files and writes files
4632 % containing these kinds of lines:
4634 % before the first topic whose initial is c
4635 % \entry {topic}{pagelist}
4636 % for a topic that is used without subtopics
4638 % for the beginning of a topic that is used with subtopics
4639 % \secondary {subtopic}{pagelist}
4640 % for each subtopic.
4642 % Define the user-accessible indexing commands
4643 % @findex, @vindex, @kindex, @cindex.
4645 \def\findex {\fnindex}
4646 \def\kindex {\kyindex}
4647 \def\cindex {\cpindex}
4648 \def\vindex {\vrindex}
4649 \def\tindex {\tpindex}
4650 \def\pindex {\pgindex}
4652 \def\cindexsub {\begingroup\obeylines\cindexsub}
4654 \gdef\cindexsub "#1" #2^^M{\endgroup %
4655 \dosubind{cp}{#2}{#1}}}
4657 % Define the macros used in formatting output of the sorted index material.
4659 % @printindex causes a particular index (the ??s file) to get printed.
4660 % It does not print any chapter heading (usually an @unnumbered).
4662 \parseargdef\printindex{\begingroup
4663 \dobreak \chapheadingskip{10000}%
4668 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4670 % See if the index file exists and is nonempty.
4671 % Change catcode of @ here so that if the index file contains
4673 % as its first line, TeX doesn't complain about mismatched braces
4674 % (because it thinks @} is a control sequence).
4676 \openin 1 \jobname.#1s
4678 % \enddoublecolumns gets confused if there is no text in the index,
4679 % and it loses the chapter title and the aux file entries for the
4680 % index. The easiest way to prevent this problem is to make sure
4681 % there is some text.
4682 \putwordIndexNonexistent
4685 % If the index file exists but is empty, then \openin leaves \ifeof
4686 % false. We have to make TeX try to read something from the file, so
4687 % it can discover if there is anything in it.
4690 \putwordIndexIsEmpty
4692 % Index files are almost Texinfo source, but we use \ as the escape
4693 % character. It would be better to use @, but that's too big a change
4694 % to make right now.
4695 \def\indexbackslash{\backslashcurfont}%
4706 % These macros are used by the sorted index file itself.
4707 % Change them to control the appearance of the index.
4710 % Some minor font changes for the special characters.
4711 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4713 % Remove any glue we may have, we'll be inserting our own.
4716 % We like breaks before the index initials, so insert a bonus.
4718 \vskip 0pt plus 3\baselineskip
4720 \vskip 0pt plus -3\baselineskip
4722 % Typeset the initial. Making this add up to a whole number of
4723 % baselineskips increases the chance of the dots lining up from column
4724 % to column. It still won't often be perfect, because of the stretch
4725 % we need before each entry, but it's better.
4727 % No shrink because it confuses \balancecolumns.
4728 \vskip 1.67\baselineskip plus .5\baselineskip
4729 \leftline{\secbf #1}%
4730 % Do our best not to break after the initial.
4732 \vskip .33\baselineskip plus .1\baselineskip
4735 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4736 % then page number (#2) flushed to the right margin. It is used for index
4737 % and table of contents entries. The paragraph is indented by \leftskip.
4739 % A straightforward implementation would start like this:
4740 % \def\entry#1#2{...
4741 % But this freezes the catcodes in the argument, and can cause problems to
4742 % @code, which sets - active. This problem was fixed by a kludge---
4743 % ``-'' was active throughout whole index, but this isn't really right.
4744 % The right solution is to prevent \entry from swallowing the whole text.
4749 % Start a new paragraph if necessary, so our assignments below can't
4750 % affect previous text.
4753 % Do not fill out the last line with white space.
4756 % No extra space above this paragraph.
4759 % Do not prefer a separate line ending with a hyphen to fewer lines.
4760 \finalhyphendemerits = 0
4762 % \hangindent is only relevant when the entry text and page number
4763 % don't both fit on one line. In that case, bob suggests starting the
4764 % dots pretty far over on the line. Unfortunately, a large
4765 % indentation looks wrong when the entry text itself is broken across
4766 % lines. So we use a small indentation and put up with long leaders.
4768 % \hangafter is reset to 1 (which is the value we want) at the start
4769 % of each paragraph, so we need not do anything with that.
4772 % When the entry text needs to be broken, just fill out the first line
4774 \rightskip = 0pt plus1fil
4776 % A bit of stretch before each entry for the benefit of balancing
4780 % When reading the text of entry, convert explicit line breaks
4781 % from @* into spaces. The user might give these in long section
4782 % titles, for instance.
4783 \def\*{\unskip\space\ignorespaces}%
4784 \def\entrybreak{\hfil\break}%
4786 % Swallow the left brace of the text (first parameter):
4787 \afterassignment\doentry
4790 \def\entrybreak{\unskip\space\ignorespaces}%
4792 \bgroup % Instead of the swallowed brace.
4794 \aftergroup\finishentry
4795 % And now comes the text of the entry.
4797 \def\finishentry#1{%
4798 % #1 is the page number.
4800 % The following is kludged to not output a line of dots in the index if
4801 % there are no page numbers. The next person who breaks this will be
4802 % cursed by a Unix daemon.
4803 \setbox\boxA = \hbox{#1}%
4804 \ifdim\wd\boxA = 0pt
4808 % If we must, put the page number on a line of its own, and fill out
4809 % this line with blank space. (The \hfil is overwhelmed with the
4810 % fill leaders glue in \indexdotfill if the page number does fit.)
4812 \null\nobreak\indexdotfill % Have leaders before the page number.
4814 % The `\ ' here is removed by the implicit \unskip that TeX does as
4815 % part of (the primitive) \par. Without it, a spurious underfull
4828 % Like plain.tex's \dotfill, except uses up at least 1 em.
4829 \def\indexdotfill{\cleaders
4830 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4832 \def\primary #1{\line{#1\hfil}}
4834 \newskip\secondaryindent \secondaryindent=0.5cm
4835 \def\secondary#1#2{{%
4840 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4842 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4849 % Define two-column mode, which we use to typeset indexes.
4850 % Adapted from the TeXbook, page 416, which is to say,
4851 % the manmac.tex format used to print the TeXbook itself.
4855 \newdimen\doublecolumnhsize
4857 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4858 % Grab any single-column material above us.
4861 % Here is a possibility not foreseen in manmac: if we accumulate a
4862 % whole lot of material, we might end up calling this \output
4863 % routine twice in a row (see the doublecol-lose test, which is
4864 % essentially a couple of indexes with @setchapternewpage off). In
4865 % that case we just ship out what is in \partialpage with the normal
4866 % output routine. Generally, \partialpage will be empty when this
4867 % runs and this will be a no-op. See the indexspread.tex test case.
4868 \ifvoid\partialpage \else
4869 \onepageout{\pagecontents\partialpage}%
4872 \global\setbox\partialpage = \vbox{%
4873 % Unvbox the main output page.
4875 \kern-\topskip \kern\baselineskip
4878 \eject % run that output routine to set \partialpage
4880 % Use the double-column output routine for subsequent pages.
4881 \output = {\doublecolumnout}%
4883 % Change the page size parameters. We could do this once outside this
4884 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4885 % format, but then we repeat the same computation. Repeating a couple
4886 % of assignments once per index is clearly meaningless for the
4887 % execution time, so we may as well do it in one place.
4889 % First we halve the line length, less a little for the gutter between
4890 % the columns. We compute the gutter based on the line length, so it
4891 % changes automatically with the paper format. The magic constant
4892 % below is chosen so that the gutter has the same value (well, +-<1pt)
4893 % as it did when we hard-coded it.
4895 % We put the result in a separate register, \doublecolumhsize, so we
4896 % can restore it in \pagesofar, after \hsize itself has (potentially)
4899 \doublecolumnhsize = \hsize
4900 \advance\doublecolumnhsize by -.04154\hsize
4901 \divide\doublecolumnhsize by 2
4902 \hsize = \doublecolumnhsize
4904 % Double the \vsize as well. (We don't need a separate register here,
4905 % since nobody clobbers \vsize.)
4909 % The double-column output routine for all double-column pages except
4912 \def\doublecolumnout{%
4913 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4914 % Get the available space for the double columns -- the normal
4915 % (undoubled) page height minus any material left over from the
4919 \advance\dimen@ by -\ht\partialpage
4921 % box0 will be the left-hand column, box2 the right.
4922 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4923 \onepageout\pagesofar
4925 \penalty\outputpenalty
4928 % Re-output the contents of the output page -- any previous material,
4929 % followed by the two boxes we just split, in box0 and box2.
4933 \hsize = \doublecolumnhsize
4934 \wd0=\hsize \wd2=\hsize
4935 \hbox to\pagewidth{\box0\hfil\box2}%
4938 % All done with double columns.
4939 \def\enddoublecolumns{%
4940 % The following penalty ensures that the page builder is exercised
4941 % _before_ we change the output routine. This is necessary in the
4942 % following situation:
4944 % The last section of the index consists only of a single entry.
4945 % Before this section, \pagetotal is less than \pagegoal, so no
4946 % break occurs before the last section starts. However, the last
4947 % section, consisting of \initial and the single \entry, does not
4948 % fit on the page and has to be broken off. Without the following
4949 % penalty the page builder will not be exercised until \eject
4950 % below, and by that time we'll already have changed the output
4951 % routine to the \balancecolumns version, so the next-to-last
4952 % double-column page will be processed with \balancecolumns, which
4953 % is wrong: The two columns will go to the main vertical list, with
4954 % the broken-off section in the recent contributions. As soon as
4955 % the output routine finishes, TeX starts reconsidering the page
4956 % break. The two columns and the broken-off section both fit on the
4957 % page, because the two columns now take up only half of the page
4958 % goal. When TeX sees \eject from below which follows the final
4959 % section, it invokes the new output routine that we've set after
4960 % \balancecolumns below; \onepageout will try to fit the two columns
4961 % and the final section into the vbox of \pageheight (see
4962 % \pagebody), causing an overfull box.
4964 % Note that glue won't work here, because glue does not exercise the
4965 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4969 % Split the last of the double-column material. Leave it on the
4970 % current page, no automatic page break.
4973 % If we end up splitting too much material for the current page,
4974 % though, there will be another page break right after this \output
4975 % invocation ends. Having called \balancecolumns once, we do not
4976 % want to call it again. Therefore, reset \output to its normal
4977 % definition right away. (We hope \balancecolumns will never be
4978 % called on to balance too much material, but if it is, this makes
4979 % the output somewhat more palatable.)
4980 \global\output = {\onepageout{\pagecontents\PAGE}}%
4983 \endgroup % started in \begindoublecolumns
4985 % \pagegoal was set to the doubled \vsize above, since we restarted
4986 % the current page. We're now back to normal single-column
4987 % typesetting, so reset \pagegoal to the normal \vsize (after the
4988 % \endgroup where \vsize got restored).
4992 % Called at the end of the double column material.
4993 \def\balancecolumns{%
4994 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4996 \advance\dimen@ by \topskip
4997 \advance\dimen@ by-\baselineskip
4998 \divide\dimen@ by 2 % target to split to
4999 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5000 \splittopskip = \topskip
5001 % Loop until we get a decent breakpoint.
5005 \global\setbox3 = \copy0
5006 \global\setbox1 = \vsplit3 to \dimen@
5008 \global\advance\dimen@ by 1pt
5011 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5012 \setbox0=\vbox to\dimen@{\unvbox1}%
5013 \setbox2=\vbox to\dimen@{\unvbox3}%
5017 \catcode`\@ = \other
5020 \message{sectioning,}
5021 % Chapters, sections, etc.
5023 % Let's start with @part.
5024 \outer\parseargdef\part{\partzzz{#1}}
5028 \vskip.3\vsize % move it down on the page a bit
5030 \noindent \titlefonts\rmisbold #1\par % the text
5031 \let\lastnode=\empty % no node to associate with
5032 \writetocentry{part}{#1}{}% but put it in the toc
5033 \headingsoff % no headline or footline on the part page
5038 % \unnumberedno is an oxymoron. But we count the unnumbered
5039 % sections so that we can refer to them unambiguously in the pdf
5040 % outlines by their "section number". We avoid collisions with chapter
5041 % numbers by starting them at 10000. (If a document ever has 10000
5042 % chapters, we're in trouble anyway, I'm sure.)
5043 \newcount\unnumberedno \unnumberedno = 10000
5045 \newcount\secno \secno=0
5046 \newcount\subsecno \subsecno=0
5047 \newcount\subsubsecno \subsubsecno=0
5049 % This counter is funny since it counts through charcodes of letters A, B, ...
5050 \newcount\appendixno \appendixno = `\@
5052 % \def\appendixletter{\char\the\appendixno}
5053 % We do the following ugly conditional instead of the above simple
5054 % construct for the sake of pdftex, which needs the actual
5055 % letter in the expansion, not just typeset.
5057 \def\appendixletter{%
5058 \ifnum\appendixno=`A A%
5059 \else\ifnum\appendixno=`B B%
5060 \else\ifnum\appendixno=`C C%
5061 \else\ifnum\appendixno=`D D%
5062 \else\ifnum\appendixno=`E E%
5063 \else\ifnum\appendixno=`F F%
5064 \else\ifnum\appendixno=`G G%
5065 \else\ifnum\appendixno=`H H%
5066 \else\ifnum\appendixno=`I I%
5067 \else\ifnum\appendixno=`J J%
5068 \else\ifnum\appendixno=`K K%
5069 \else\ifnum\appendixno=`L L%
5070 \else\ifnum\appendixno=`M M%
5071 \else\ifnum\appendixno=`N N%
5072 \else\ifnum\appendixno=`O O%
5073 \else\ifnum\appendixno=`P P%
5074 \else\ifnum\appendixno=`Q Q%
5075 \else\ifnum\appendixno=`R R%
5076 \else\ifnum\appendixno=`S S%
5077 \else\ifnum\appendixno=`T T%
5078 \else\ifnum\appendixno=`U U%
5079 \else\ifnum\appendixno=`V V%
5080 \else\ifnum\appendixno=`W W%
5081 \else\ifnum\appendixno=`X X%
5082 \else\ifnum\appendixno=`Y Y%
5083 \else\ifnum\appendixno=`Z Z%
5084 % The \the is necessary, despite appearances, because \appendixletter is
5085 % expanded while writing the .toc file. \char\appendixno is not
5086 % expandable, thus it is written literally, thus all appendixes come out
5087 % with the same letter (or @) in the toc without it.
5088 \else\char\the\appendixno
5089 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5090 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5092 % Each @chapter defines these (using marks) as the number+name, number
5093 % and name of the chapter. Page headings and footings can use
5094 % these. @section does likewise.
5096 \def\thischapternum{}
5097 \def\thischaptername{}
5099 \def\thissectionnum{}
5100 \def\thissectionname{}
5102 \newcount\absseclevel % used to calculate proper heading level
5103 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5105 % @raisesections: treat @section as chapter, @subsection as section, etc.
5106 \def\raisesections{\global\advance\secbase by -1}
5107 \let\up=\raisesections % original BFox name
5109 % @lowersections: treat @chapter as section, @section as subsection, etc.
5110 \def\lowersections{\global\advance\secbase by 1}
5111 \let\down=\lowersections % original BFox name
5113 % we only have subsub.
5114 \chardef\maxseclevel = 3
5116 % A numbered section within an unnumbered changes to unnumbered too.
5117 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5118 \chardef\unnlevel = \maxseclevel
5120 % Trace whether the current chapter is an appendix or not:
5121 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5122 \def\chapheadtype{N}
5124 % Choose a heading macro
5125 % #1 is heading type
5126 % #2 is heading level
5127 % #3 is text for heading
5128 \def\genhead#1#2#3{%
5129 % Compute the abs. sec. level:
5131 \advance\absseclevel by \secbase
5132 % Make sure \absseclevel doesn't fall outside the range:
5133 \ifnum \absseclevel < 0
5136 \ifnum \absseclevel > 3
5143 \ifnum \absseclevel < \unnlevel
5144 \chardef\unnlevel = \absseclevel
5147 % Check for appendix sections:
5148 \ifnum \absseclevel = 0
5149 \edef\chapheadtype{\headtype}%
5151 \if \headtype A\if \chapheadtype N%
5152 \errmessage{@appendix... within a non-appendix chapter}%
5155 % Check for numbered within unnumbered:
5156 \ifnum \absseclevel > \unnlevel
5159 \chardef\unnlevel = 3
5162 % Now print the heading:
5166 \or \unnumberedseczzz{#3}%
5167 \or \unnumberedsubseczzz{#3}%
5168 \or \unnumberedsubsubseczzz{#3}%
5174 \or \appendixsectionzzz{#3}%
5175 \or \appendixsubseczzz{#3}%
5176 \or \appendixsubsubseczzz{#3}%
5182 \or \numberedsubseczzz{#3}%
5183 \or \numberedsubsubseczzz{#3}%
5187 \suppressfirstparagraphindent
5191 \def\numhead{\genhead N}
5192 \def\apphead{\genhead A}
5193 \def\unnmhead{\genhead U}
5195 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5196 % all lower-level sectioning counters to zero.
5198 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5199 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5200 \let\chaplevelprefix = \empty
5202 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5204 % section resetting is \global in case the chapter is in a group, such
5205 % as an @include file.
5206 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5207 \global\advance\chapno by 1
5210 \gdef\chaplevelprefix{\the\chapno.}%
5213 % \putwordChapter can contain complex things in translations.
5214 \toks0=\expandafter{\putwordChapter}%
5215 \message{\the\toks0 \space \the\chapno}%
5217 % Write the actual heading.
5218 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5220 % So @section and the like are numbered underneath this chapter.
5221 \global\let\section = \numberedsec
5222 \global\let\subsection = \numberedsubsec
5223 \global\let\subsubsection = \numberedsubsubsec
5226 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5228 \def\appendixzzz#1{%
5229 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5230 \global\advance\appendixno by 1
5231 \gdef\chaplevelprefix{\appendixletter.}%
5234 % \putwordAppendix can contain complex things in translations.
5235 \toks0=\expandafter{\putwordAppendix}%
5236 \message{\the\toks0 \space \appendixletter}%
5238 \chapmacro{#1}{Yappendix}{\appendixletter}%
5240 \global\let\section = \appendixsec
5241 \global\let\subsection = \appendixsubsec
5242 \global\let\subsubsection = \appendixsubsubsec
5245 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5246 \def\unnumberedzzz#1{%
5247 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5248 \global\advance\unnumberedno by 1
5250 % Since an unnumbered has no number, no prefix for figures.
5251 \global\let\chaplevelprefix = \empty
5254 % This used to be simply \message{#1}, but TeX fully expands the
5255 % argument to \message. Therefore, if #1 contained @-commands, TeX
5256 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5257 % expanded @cite (which turns out to cause errors because \cite is meant
5258 % to be executed, not expanded).
5260 % Anyway, we don't want the fully-expanded definition of @cite to appear
5261 % as a result of the \message, we just want `@cite' itself. We use
5262 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5263 % simply yielding the contents of <toks register>. (We also do this for
5266 \message{(\the\toks0)}%
5268 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5270 \global\let\section = \unnumberedsec
5271 \global\let\subsection = \unnumberedsubsec
5272 \global\let\subsubsection = \unnumberedsubsubsec
5275 % @centerchap is like @unnumbered, but the heading is centered.
5276 \outer\parseargdef\centerchap{%
5277 % Well, we could do the following in a group, but that would break
5278 % an assumption that \chapmacro is called at the outermost level.
5279 % Thus we are safer this way: --kasal, 24feb04
5280 \let\centerparametersmaybe = \centerparameters
5282 \let\centerparametersmaybe = \relax
5285 % @top is like @unnumbered.
5289 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5291 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5292 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5295 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5296 \def\appendixsectionzzz#1{%
5297 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5298 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5300 \let\appendixsec\appendixsection
5302 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5303 \def\unnumberedseczzz#1{%
5304 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5305 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5309 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5310 \def\numberedsubseczzz#1{%
5311 \global\subsubsecno=0 \global\advance\subsecno by 1
5312 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5315 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5316 \def\appendixsubseczzz#1{%
5317 \global\subsubsecno=0 \global\advance\subsecno by 1
5318 \sectionheading{#1}{subsec}{Yappendix}%
5319 {\appendixletter.\the\secno.\the\subsecno}%
5322 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5323 \def\unnumberedsubseczzz#1{%
5324 \global\subsubsecno=0 \global\advance\subsecno by 1
5325 \sectionheading{#1}{subsec}{Ynothing}%
5326 {\the\unnumberedno.\the\secno.\the\subsecno}%
5330 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5331 \def\numberedsubsubseczzz#1{%
5332 \global\advance\subsubsecno by 1
5333 \sectionheading{#1}{subsubsec}{Ynumbered}%
5334 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5337 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5338 \def\appendixsubsubseczzz#1{%
5339 \global\advance\subsubsecno by 1
5340 \sectionheading{#1}{subsubsec}{Yappendix}%
5341 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5344 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5345 \def\unnumberedsubsubseczzz#1{%
5346 \global\advance\subsubsecno by 1
5347 \sectionheading{#1}{subsubsec}{Ynothing}%
5348 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5351 % These macros control what the section commands do, according
5352 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5353 % Define them by default for a numbered chapter.
5354 \let\section = \numberedsec
5355 \let\subsection = \numberedsubsec
5356 \let\subsubsection = \numberedsubsubsec
5358 % Define @majorheading, @heading and @subheading
5360 % NOTE on use of \vbox for chapter headings, section headings, and such:
5361 % 1) We use \vbox rather than the earlier \line to permit
5362 % overlong headings to fold.
5363 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5364 % heading is obnoxious; this forbids it.
5365 % 3) Likewise, headings look best if no \parindent is used, and
5366 % if justification is not attempted. Hence \raggedright.
5369 {\advance\chapheadingskip by 10pt \chapbreak }%
5370 \parsearg\chapheadingzzz
5373 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5374 \def\chapheadingzzz#1{%
5375 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5376 \parindent=0pt\ptexraggedright
5377 \rmisbold #1\hfill}}%
5378 \bigskip \par\penalty 200\relax
5379 \suppressfirstparagraphindent
5382 % @heading, @subheading, @subsubheading.
5383 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5384 \suppressfirstparagraphindent}
5385 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5386 \suppressfirstparagraphindent}
5387 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5388 \suppressfirstparagraphindent}
5390 % These macros generate a chapter, section, etc. heading only
5391 % (including whitespace, linebreaking, etc. around it),
5392 % given all the information in convenient, parsed form.
5394 %%% Args are the skip and penalty (usually negative)
5395 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5397 %%% Define plain chapter starts, and page on/off switching for it
5398 % Parameter controlling skip before chapter headings (if needed)
5400 \newskip\chapheadingskip
5402 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5403 \def\chappager{\par\vfill\supereject}
5404 % Because \domark is called before \chapoddpage, the filler page will
5405 % get the headings for the next chapter, which is wrong. But we don't
5406 % care -- we just disable all headings on the filler page.
5418 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5421 \global\let\contentsalignmacro = \chappager
5422 \global\let\pchapsepmacro=\chapbreak
5423 \global\let\pagealignmacro=\chappager}
5426 \global\let\contentsalignmacro = \chappager
5427 \global\let\pchapsepmacro=\chappager
5428 \global\let\pagealignmacro=\chappager
5429 \global\def\HEADINGSon{\HEADINGSsingle}}
5432 \global\let\contentsalignmacro = \chapoddpage
5433 \global\let\pchapsepmacro=\chapoddpage
5434 \global\let\pagealignmacro=\chapoddpage
5435 \global\def\HEADINGSon{\HEADINGSdouble}}
5441 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5442 % Yappendix, Yomitfromtoc), #3 the chapter number.
5444 % To test against our argument.
5445 \def\Ynothingkeyword{Ynothing}
5446 \def\Yomitfromtockeyword{Yomitfromtoc}
5447 \def\Yappendixkeyword{Yappendix}
5449 \def\chapmacro#1#2#3{%
5450 % Insert the first mark before the heading break (see notes for \domark).
5451 \let\prevchapterdefs=\lastchapterdefs
5452 \let\prevsectiondefs=\lastsectiondefs
5453 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5454 \gdef\thissection{}}%
5457 \ifx\temptype\Ynothingkeyword
5458 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5459 \gdef\thischapter{\thischaptername}}%
5460 \else\ifx\temptype\Yomitfromtockeyword
5461 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5462 \gdef\thischapter{}}%
5463 \else\ifx\temptype\Yappendixkeyword
5465 \xdef\lastchapterdefs{%
5466 \gdef\noexpand\thischaptername{\the\toks0}%
5467 \gdef\noexpand\thischapternum{\appendixletter}%
5468 % \noexpand\putwordAppendix avoids expanding indigestible
5469 % commands in some of the translations.
5470 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5471 \noexpand\thischapternum:
5472 \noexpand\thischaptername}%
5476 \xdef\lastchapterdefs{%
5477 \gdef\noexpand\thischaptername{\the\toks0}%
5478 \gdef\noexpand\thischapternum{\the\chapno}%
5479 % \noexpand\putwordChapter avoids expanding indigestible
5480 % commands in some of the translations.
5481 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5482 \noexpand\thischapternum:
5483 \noexpand\thischaptername}%
5487 % Output the mark. Pass it through \safewhatsit, to take care of
5488 % the preceding space.
5491 % Insert the chapter heading break.
5494 % Now the second mark, after the heading break. No break points
5495 % between here and the heading.
5496 \let\prevchapterdefs=\lastchapterdefs
5497 \let\prevsectiondefs=\lastsectiondefs
5501 \chapfonts \rmisbold
5503 % Have to define \lastsection before calling \donoderef, because the
5504 % xref code eventually uses it. On the other hand, it has to be called
5505 % after \pchapsepmacro, or the headline will change too soon.
5506 \gdef\lastsection{#1}%
5508 % Only insert the separating space if we have a chapter/appendix
5509 % number, and don't print the unnumbered ``number''.
5510 \ifx\temptype\Ynothingkeyword
5512 \def\toctype{unnchap}%
5513 \else\ifx\temptype\Yomitfromtockeyword
5514 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5516 \else\ifx\temptype\Yappendixkeyword
5517 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5520 \setbox0 = \hbox{#3\enspace}%
5521 \def\toctype{numchap}%
5524 % Write the toc entry for this chapter. Must come before the
5525 % \donoderef, because we include the current node name in the toc
5526 % entry, and \donoderef resets it to empty.
5527 \writetocentry{\toctype}{#1}{#3}%
5529 % For pdftex, we have to write out the node definition (aka, make
5530 % the pdfdest) after any page break, but before the actual text has
5531 % been typeset. If the destination for the pdf outline is after the
5532 % text, then jumping from the outline may wind up with the text not
5533 % being visible, for instance under high magnification.
5536 % Typeset the actual heading.
5537 \nobreak % Avoid page breaks at the interline glue.
5538 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5539 \hangindent=\wd0 \centerparametersmaybe
5542 \nobreak\bigskip % no page break after a chapter title
5546 % @centerchap -- centered and unnumbered.
5547 \let\centerparametersmaybe = \relax
5548 \def\centerparameters{%
5549 \advance\rightskip by 3\rightskip
5550 \leftskip = \rightskip
5555 % I don't think this chapter style is supported any more, so I'm not
5556 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5558 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5560 \def\unnchfopen #1{%
5561 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5562 \parindent=0pt\ptexraggedright
5563 \rmisbold #1\hfill}}\bigskip \par\nobreak
5565 \def\chfopen #1#2{\chapoddpage {\chapfonts
5566 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5569 \def\centerchfopen #1{%
5570 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5572 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5575 \global\let\chapmacro=\chfopen
5576 \global\let\centerchapmacro=\centerchfopen}
5579 % Section titles. These macros combine the section number parts and
5580 % call the generic \sectionheading to do the printing.
5582 \newskip\secheadingskip
5583 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5585 % Subsection titles.
5586 \newskip\subsecheadingskip
5587 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5589 % Subsubsection titles.
5590 \def\subsubsecheadingskip{\subsecheadingskip}
5591 \def\subsubsecheadingbreak{\subsecheadingbreak}
5594 % Print any size, any type, section title.
5596 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5597 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5600 \def\seckeyword{sec}
5602 \def\sectionheading#1#2#3#4{%
5604 % Switch to the right set of fonts.
5605 \csname #2fonts\endcsname \rmisbold
5607 \def\sectionlevel{#2}%
5610 % Insert first mark before the heading break (see notes for \domark).
5611 \let\prevsectiondefs=\lastsectiondefs
5612 \ifx\temptype\Ynothingkeyword
5613 \ifx\sectionlevel\seckeyword
5614 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5615 \gdef\thissection{\thissectionname}}%
5617 \else\ifx\temptype\Yomitfromtockeyword
5618 % Don't redefine \thissection.
5619 \else\ifx\temptype\Yappendixkeyword
5620 \ifx\sectionlevel\seckeyword
5622 \xdef\lastsectiondefs{%
5623 \gdef\noexpand\thissectionname{\the\toks0}%
5624 \gdef\noexpand\thissectionnum{#4}%
5625 % \noexpand\putwordSection avoids expanding indigestible
5626 % commands in some of the translations.
5627 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5628 \noexpand\thissectionnum:
5629 \noexpand\thissectionname}%
5633 \ifx\sectionlevel\seckeyword
5635 \xdef\lastsectiondefs{%
5636 \gdef\noexpand\thissectionname{\the\toks0}%
5637 \gdef\noexpand\thissectionnum{#4}%
5638 % \noexpand\putwordSection avoids expanding indigestible
5639 % commands in some of the translations.
5640 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5641 \noexpand\thissectionnum:
5642 \noexpand\thissectionname}%
5647 % Go into vertical mode. Usually we'll already be there, but we
5648 % don't want the following whatsit to end up in a preceding paragraph
5649 % if the document didn't happen to have a blank line.
5652 % Output the mark. Pass it through \safewhatsit, to take care of
5653 % the preceding space.
5656 % Insert space above the heading.
5657 \csname #2headingbreak\endcsname
5659 % Now the second mark, after the heading break. No break points
5660 % between here and the heading.
5661 \let\prevsectiondefs=\lastsectiondefs
5664 % Only insert the space after the number if we have a section number.
5665 \ifx\temptype\Ynothingkeyword
5668 \gdef\lastsection{#1}%
5669 \else\ifx\temptype\Yomitfromtockeyword
5670 % for @headings -- no section number, don't include in toc,
5671 % and don't redefine \lastsection.
5674 \let\sectionlevel=\empty
5675 \else\ifx\temptype\Yappendixkeyword
5676 \setbox0 = \hbox{#4\enspace}%
5678 \gdef\lastsection{#1}%
5680 \setbox0 = \hbox{#4\enspace}%
5682 \gdef\lastsection{#1}%
5685 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5686 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5688 % Write the node reference (= pdf destination for pdftex).
5689 % Again, see comments in \chapmacro.
5692 % Interline glue will be inserted when the vbox is completed.
5693 % That glue will be a valid breakpoint for the page, since it'll be
5694 % preceded by a whatsit (usually from the \donoderef, or from the
5695 % \writetocentry if there was no node). We don't want to allow that
5696 % break, since then the whatsits could end up on page n while the
5697 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5700 % Output the actual section heading.
5701 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5702 \hangindent=\wd0 % zero if no section number
5705 % Add extra space after the heading -- half of whatever came above it.
5706 % Don't allow stretch, though.
5707 \kern .5 \csname #2headingskip\endcsname
5709 % Do not let the kern be a potential breakpoint, as it would be if it
5710 % was followed by glue.
5713 % We'll almost certainly start a paragraph next, so don't let that
5714 % glue accumulate. (Not a breakpoint because it's preceded by a
5715 % discardable item.)
5718 % This is purely so the last item on the list is a known \penalty >
5719 % 10000. This is so \startdefun can avoid allowing breakpoints after
5720 % section headings. Otherwise, it would insert a valid breakpoint between:
5722 % @section sec-whatever
5723 % @deffn def-whatever
5729 % Table of contents.
5732 % Write an entry to the toc file, opening it if necessary.
5733 % Called from @chapter, etc.
5735 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5736 % We append the current node name (if any) and page number as additional
5737 % arguments for the \{chap,sec,...}entry macros which will eventually
5738 % read this. The node name is used in the pdf outlines as the
5739 % destination to jump to.
5741 % We open the .toc file for writing here instead of at @setfilename (or
5742 % any other fixed time) so that @contents can be anywhere in the document.
5743 % But if #1 is `omit', then we don't do anything. This is used for the
5744 % table of contents chapter openings themselves.
5746 \newif\iftocfileopened
5747 \def\omitkeyword{omit}%
5749 \def\writetocentry#1#2#3{%
5750 \edef\writetoctype{#1}%
5751 \ifx\writetoctype\omitkeyword \else
5752 \iftocfileopened\else
5753 \immediate\openout\tocfile = \jobname.toc
5754 \global\tocfileopenedtrue
5760 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5766 % Tell \shipout to create a pdf destination on each page, if we're
5767 % writing pdf. These are used in the table of contents. We can't
5768 % just write one on every page because the title pages are numbered
5769 % 1 and 2 (the page numbers aren't printed), and so are the first
5770 % two pages of the document. Thus, we'd have two destinations named
5771 % `1', and two named `2'.
5772 \ifpdf \global\pdfmakepagedesttrue \fi
5776 % These characters do not print properly in the Computer Modern roman
5777 % fonts, so we must take special care. This is more or less redundant
5778 % with the Texinfo input format setup at the end of this file.
5780 \def\activecatcodes{%
5793 % Read the toc file, which is essentially Texinfo input.
5797 \input \tocreadfilename
5800 \newskip\contentsrightmargin \contentsrightmargin=1in
5801 \newcount\savepageno
5802 \newcount\lastnegativepageno \lastnegativepageno = -1
5804 % Prepare to read what we've written to \tocfile.
5806 \def\startcontents#1{%
5807 % If @setchapternewpage on, and @headings double, the contents should
5808 % start on an odd page, unlike chapters. Thus, we maintain
5809 % \contentsalignmacro in parallel with \pagealignmacro.
5810 % From: Torbjorn Granlund <tege@matematik.su.se>
5812 \immediate\closeout\tocfile
5814 % Don't need to put `Contents' or `Short Contents' in the headline.
5815 % It is abundantly clear what they are.
5816 \chapmacro{#1}{Yomitfromtoc}{}%
5818 \savepageno = \pageno
5819 \begingroup % Set up to handle contents files properly.
5820 \raggedbottom % Worry more about breakpoints than the bottom.
5821 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5823 % Roman numerals for page numbers.
5824 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5827 % redefined for the two-volume lispref. We always output on
5828 % \jobname.toc even if this is redefined.
5830 \def\tocreadfilename{\jobname.toc}
5832 % Normal (long) toc.
5835 \startcontents{\putwordTOC}%
5836 \openin 1 \tocreadfilename\space
5841 \contentsalignmacro % in case @setchapternewpage odd is in effect
5847 \lastnegativepageno = \pageno
5848 \global\pageno = \savepageno
5851 % And just the chapters.
5852 \def\summarycontents{%
5853 \startcontents{\putwordShortTOC}%
5855 \let\partentry = \shortpartentry
5856 \let\numchapentry = \shortchapentry
5857 \let\appentry = \shortchapentry
5858 \let\unnchapentry = \shortunnchapentry
5859 % We want a true roman here for the page numbers.
5861 \let\rm=\shortcontrm \let\bf=\shortcontbf
5862 \let\sl=\shortcontsl \let\tt=\shortconttt
5864 \hyphenpenalty = 10000
5865 \advance\baselineskip by 1pt % Open it up a little.
5866 \def\numsecentry##1##2##3##4{}
5867 \let\appsecentry = \numsecentry
5868 \let\unnsecentry = \numsecentry
5869 \let\numsubsecentry = \numsecentry
5870 \let\appsubsecentry = \numsecentry
5871 \let\unnsubsecentry = \numsecentry
5872 \let\numsubsubsecentry = \numsecentry
5873 \let\appsubsubsecentry = \numsecentry
5874 \let\unnsubsubsecentry = \numsecentry
5875 \openin 1 \tocreadfilename\space
5881 \contentsalignmacro % in case @setchapternewpage odd is in effect
5883 \lastnegativepageno = \pageno
5884 \global\pageno = \savepageno
5886 \let\shortcontents = \summarycontents
5888 % Typeset the label for a chapter or appendix for the short contents.
5889 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5891 \def\shortchaplabel#1{%
5892 % This space should be enough, since a single number is .5em, and the
5893 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5894 % But use \hss just in case.
5895 % (This space doesn't include the extra space that gets added after
5896 % the label; that gets put in by \shortchapentry above.)
5898 % We'd like to right-justify chapter numbers, but that looks strange
5899 % with appendix letters. And right-justifying numbers and
5900 % left-justifying letters looks strange when there is less than 10
5901 % chapters. Have to read the whole toc once to know how many chapters
5902 % there are before deciding ...
5903 \hbox to 1em{#1\hss}%
5906 % These macros generate individual entries in the table of contents.
5907 % The first argument is the chapter or section name.
5908 % The last argument is the page number.
5909 % The arguments in between are the chapter number, section number, ...
5911 % Parts, in the main contents. Replace the part number, which doesn't
5912 % exist, with an empty box. Let's hope all the numbers have the same width.
5913 % Also ignore the page number, which is conventionally not printed.
5914 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
5915 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
5917 % Parts, in the short toc.
5918 \def\shortpartentry#1#2#3#4{%
5920 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
5921 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
5924 % Chapters, in the main contents.
5925 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5927 % Chapters, in the short toc.
5928 % See comments in \dochapentry re vbox and related settings.
5929 \def\shortchapentry#1#2#3#4{%
5930 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5933 % Appendices, in the main contents.
5934 % Need the word Appendix, and a fixed-size box.
5936 \def\appendixbox#1{%
5937 % We use M since it's probably the widest letter.
5938 \setbox0 = \hbox{\putwordAppendix{} M}%
5939 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5941 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5943 % Unnumbered chapters.
5944 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5945 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5948 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5949 \let\appsecentry=\numsecentry
5950 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5953 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5954 \let\appsubsecentry=\numsubsecentry
5955 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5957 % And subsubsections.
5958 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5959 \let\appsubsubsecentry=\numsubsubsecentry
5960 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5962 % This parameter controls the indentation of the various levels.
5963 % Same as \defaultparindent.
5964 \newdimen\tocindent \tocindent = 15pt
5966 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5969 % If the toc has to be broken over pages, we want it to be at chapters
5970 % if at all possible; hence the \penalty.
5971 \def\dochapentry#1#2{%
5972 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5975 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5977 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5980 \def\dosecentry#1#2{\begingroup
5981 \secentryfonts \leftskip=\tocindent
5982 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5985 \def\dosubsecentry#1#2{\begingroup
5986 \subsecentryfonts \leftskip=2\tocindent
5987 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5990 \def\dosubsubsecentry#1#2{\begingroup
5991 \subsubsecentryfonts \leftskip=3\tocindent
5992 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5995 % We use the same \entry macro as for the index entries.
5996 \let\tocentry = \entry
5998 % Space between chapter (or whatever) number and the title.
5999 \def\labelspace{\hskip1em \relax}
6001 \def\dopageno#1{{\rm #1}}
6002 \def\doshortpageno#1{{\rm #1}}
6004 \def\chapentryfonts{\secfonts \rm}
6005 \def\secentryfonts{\textfonts}
6006 \def\subsecentryfonts{\textfonts}
6007 \def\subsubsecentryfonts{\textfonts}
6010 \message{environments,}
6011 % @foo ... @end foo.
6013 % @tex ... @end tex escapes into raw TeX temporarily.
6014 % One exception: @ is still an escape character, so that @end tex works.
6015 % But \@ or @@ will get a plain @ character.
6018 \setupmarkupstyle{tex}%
6019 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6020 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6021 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6032 % ' is active in math mode (mathcode"8000). So reset it, and all our
6033 % other math active characters (just in case), to plain's definitions.
6037 \let\bullet=\ptexbullet
6042 \let\equiv=\ptexequiv
6045 \let\indent=\ptexindent
6046 \let\noindent=\ptexnoindent
6053 \expandafter \let\csname top\endcsname=\ptextop % outer
6054 \let\frenchspacing=\plainfrenchspacing
6056 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6057 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6060 % There is no need to define \Etex.
6062 % Define @lisp ... @end lisp.
6063 % @lisp environment forms a group so it can rebind things,
6064 % including the definition of @end lisp (which normally is erroneous).
6066 % Amount to narrow the margins by for @lisp.
6067 \newskip\lispnarrowing \lispnarrowing=0.4in
6069 % This is the definition that ^^M gets inside @lisp, @example, and other
6070 % such environments. \null is better than a space, since it doesn't
6072 \def\lisppar{\null\endgraf}
6074 % This space is always present above and below environments.
6075 \newskip\envskipamount \envskipamount = 0pt
6077 % Make spacing and below environment symmetrical. We use \parskip here
6078 % to help in doing that, since in @example-like environments \parskip
6079 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6080 % start of the next paragraph will insert \parskip.
6082 \def\aboveenvbreak{{%
6083 % =10000 instead of <10000 because of a special case in \itemzzz and
6084 % \sectionheading, q.v.
6085 \ifnum \lastpenalty=10000 \else
6086 \advance\envskipamount by \parskip
6088 \ifdim\lastskip<\envskipamount
6090 % it's not a good place to break if the last penalty was \nobreak
6092 \ifnum\lastpenalty<10000 \penalty-50 \fi
6093 \vskip\envskipamount
6098 \let\afterenvbreak = \aboveenvbreak
6100 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6101 % also clear it, so that its embedded environments do the narrowing again.
6102 \let\nonarrowing=\relax
6104 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6105 % environment contents.
6106 \font\circle=lcircle10
6108 \newdimen\cartouter\newdimen\cartinner
6109 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6110 \circthick=\fontdimen8\circle
6112 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6113 \def\ctr{{\hskip 6pt\circle\char'010}}
6114 \def\cbl{{\circle\char'012\hskip -6pt}}
6115 \def\cbr{{\hskip 6pt\circle\char'011}}
6116 \def\carttop{\hbox to \cartouter{\hskip\lskip
6117 \ctl\leaders\hrule height\circthick\hfil\ctr
6119 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6120 \cbl\leaders\hrule height\circthick\hfil\cbr
6123 \newskip\lskip\newskip\rskip
6126 \ifhmode\par\fi % can't be in the midst of a paragraph.
6128 \lskip=\leftskip \rskip=\rightskip
6129 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6130 \cartinner=\hsize \advance\cartinner by-\lskip
6131 \advance\cartinner by-\rskip
6133 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6134 % side, and for 6pt waste from
6135 % each corner char, and rule thickness
6136 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6137 % Flag to tell @lisp, etc., not to narrow margin.
6138 \let\nonarrowing = t%
6140 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6148 \baselineskip=\normbskip
6149 \lineskip=\normlskip
6152 \comment % For explanation, see the end of \def\group.
6167 % This macro is called at the beginning of all the @example variants,
6169 \newdimen\nonfillparindent
6172 \hfuzz = 12pt % Don't be fussy
6173 \sepspaces % Make spaces be word-separators rather than space tokens.
6174 \let\par = \lisppar % don't ignore blank lines
6175 \obeylines % each line of input is a line of output
6177 % Turn off paragraph indentation but redefine \indent to emulate
6178 % the normal \indent.
6179 \nonfillparindent=\parindent
6181 \let\indent\nonfillindent
6183 \emergencystretch = 0pt % don't try to avoid overfull boxes
6184 \ifx\nonarrowing\relax
6185 \advance \leftskip by \lispnarrowing
6186 \exdentamount=\lispnarrowing
6188 \let\nonarrowing = \relax
6190 \let\exdent=\nofillexdent
6195 % We want to swallow spaces (but not other tokens) after the fake
6196 % @indent in our nonfill-environments, where spaces are normally
6197 % active and set to @tie, resulting in them not being ignored after
6199 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6200 \gdef\nonfillindentcheck{%
6202 \expandafter\nonfillindentgobble%
6204 \leavevmode\nonfillindentbox%
6208 \def\nonfillindentgobble#1{\nonfillindent}
6209 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6211 % If you want all examples etc. small: @set dispenvsize small.
6212 % If you want even small examples the full size: @set dispenvsize nosmall.
6213 % This affects the following displayed environments:
6214 % @example, @display, @format, @lisp
6216 \def\smallword{small}
6217 \def\nosmallword{nosmall}
6218 \let\SETdispenvsize\relax
6219 \def\setnormaldispenv{%
6220 \ifx\SETdispenvsize\smallword
6221 % end paragraph for sake of leading, in case document has no blank
6222 % line. This is redundant with what happens in \aboveenvbreak, but
6223 % we need to do it before changing the fonts, and it's inconvenient
6224 % to change the fonts afterward.
6225 \ifnum \lastpenalty=10000 \else \endgraf \fi
6226 \smallexamplefonts \rm
6229 \def\setsmalldispenv{%
6230 \ifx\SETdispenvsize\nosmallword
6232 \ifnum \lastpenalty=10000 \else \endgraf \fi
6233 \smallexamplefonts \rm
6237 % We often define two environments, @foo and @smallfoo.
6238 % Let's do it in one command. #1 is the env name, #2 the definition.
6239 \def\makedispenvdef#1#2{%
6240 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6241 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6242 \expandafter\let\csname E#1\endcsname \afterenvbreak
6243 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6246 % Define two environment synonyms (#1 and #2) for an environment.
6247 \def\maketwodispenvdef#1#2#3{%
6248 \makedispenvdef{#1}{#3}%
6249 \makedispenvdef{#2}{#3}%
6252 % @lisp: indented, narrowed, typewriter font;
6253 % @example: same as @lisp.
6255 % @smallexample and @smalllisp: use smaller fonts.
6256 % Originally contributed by Pavel@xerox.
6258 \maketwodispenvdef{lisp}{example}{%
6260 \tt\setupmarkupstyle{example}%
6261 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6262 \gobble % eat return
6264 % @display/@smalldisplay: same as @lisp except keep current font.
6266 \makedispenvdef{display}{%
6271 % @format/@smallformat: same as @display except don't narrow margins.
6273 \makedispenvdef{format}{%
6274 \let\nonarrowing = t%
6279 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6281 \let\nonarrowing = t%
6285 \let\Eflushleft = \afterenvbreak
6289 \envdef\flushright{%
6290 \let\nonarrowing = t%
6292 \advance\leftskip by 0pt plus 1fill\relax
6295 \let\Eflushright = \afterenvbreak
6298 % @raggedright does more-or-less normal line breaking but no right
6299 % justification. From plain.tex.
6300 \envdef\raggedright{%
6301 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6303 \let\Eraggedright\par
6305 \envdef\raggedleft{%
6306 \parindent=0pt \leftskip0pt plus2em
6307 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6308 \hbadness=10000 % Last line will usually be underfull, so turn off
6309 % badness reporting.
6311 \let\Eraggedleft\par
6313 \envdef\raggedcenter{%
6314 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6315 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6316 \hbadness=10000 % Last line will usually be underfull, so turn off
6317 % badness reporting.
6319 \let\Eraggedcenter\par
6322 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6323 % and narrows the margins. We keep \parskip nonzero in general, since
6324 % we're doing normal filling. So, when using \aboveenvbreak and
6325 % \afterenvbreak, temporarily make \parskip 0.
6327 \makedispenvdef{quotation}{\quotationstart}
6329 \def\quotationstart{%
6330 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6333 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6334 \ifx\nonarrowing\relax
6335 \advance\leftskip by \lispnarrowing
6336 \advance\rightskip by \lispnarrowing
6337 \exdentamount = \lispnarrowing
6339 \let\nonarrowing = \relax
6341 \parsearg\quotationlabel
6344 % We have retained a nonzero parskip for the environment, since we're
6345 % doing normal filling.
6349 \ifx\quotationauthor\undefined\else
6351 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6353 {\parskip=0pt \afterenvbreak}%
6355 \def\Esmallquotation{\Equotation}
6357 % If we're given an argument, typeset it in bold with a colon after.
6358 \def\quotationlabel#1{%
6360 \ifx\temp\empty \else
6366 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6367 % If we want to allow any <char> as delimiter,
6368 % we need the curly braces so that makeinfo sees the @verb command, eg:
6369 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6371 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6373 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6374 % active too. Otherwise, they get lost as the first character on a
6377 \do\ \do\\\do\{\do\}\do\$\do\&%
6378 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6379 \do\<\do\>\do\|\do\@\do+\do\"%
6380 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6381 % @set txicodequotebacktick will not have effect on @verb and
6382 % @verbatim, and ?` and !` ligatures won't get disabled.
6387 \def\uncatcodespecials{%
6388 \def\do##1{\catcode`##1=\other}\dospecials}
6390 % Setup for the @verb command.
6392 % Eight spaces for a tab
6394 \catcode`\^^I=\active
6395 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6399 \tt % easiest (and conventionally used) font for verbatim
6400 \def\par{\leavevmode\endgraf}%
6401 \setupmarkupstyle{verb}%
6403 % Respect line breaks,
6404 % print special symbols as themselves, and
6405 % make each space count
6406 % must do in this order:
6407 \obeylines \uncatcodespecials \sepspaces
6410 % Setup for the @verbatim environment
6412 % Real tab expansion.
6413 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6415 % We typeset each line of the verbatim in an \hbox, so we can handle
6416 % tabs. The \global is in case the verbatim line starts with an accent,
6417 % or some other command that starts with a begin-group. Otherwise, the
6418 % entire \verbbox would disappear at the corresponding end-group, before
6419 % it is typeset. Meanwhile, we can't have nested verbatim commands
6420 % (can we?), so the \global won't be overwriting itself.
6422 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6425 \catcode`\^^I=\active
6427 \catcode`\^^I=\active
6428 \def^^I{\leavevmode\egroup
6429 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6430 \divide\dimen\verbbox by\tabw
6431 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6432 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6433 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6438 % start the verbatim environment.
6439 \def\setupverbatim{%
6440 \let\nonarrowing = t%
6442 \tt % easiest (and conventionally used) font for verbatim
6443 % The \leavevmode here is for blank lines. Otherwise, we would
6444 % never \starttabox and the \egroup would end verbatim mode.
6445 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6447 \setupmarkupstyle{verbatim}%
6448 % Respect line breaks,
6449 % print special symbols as themselves, and
6450 % make each space count.
6451 % Must do in this order:
6452 \obeylines \uncatcodespecials \sepspaces
6453 \everypar{\starttabbox}%
6456 % Do the @verb magic: verbatim text is quoted by unique
6457 % delimiter characters. Before first delimiter expect a
6458 % right brace, after last delimiter expect closing brace:
6460 % \def\doverb'{'<char>#1<char>'}'{#1}
6462 % [Knuth] p. 382; only eat outer {}
6464 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6465 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6468 \def\verb{\begingroup\setupverb\doverb}
6471 % Do the @verbatim magic: define the macro \doverbatim so that
6472 % the (first) argument ends when '@end verbatim' is reached, ie:
6474 % \def\doverbatim#1@end verbatim{#1}
6476 % For Texinfo it's a lot easier than for LaTeX,
6477 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6478 % we need not redefine '\', '{' and '}'.
6480 % Inspired by LaTeX's verbatim command set [latex.ltx]
6485 % ignore everything up to the first ^^M, that's the newline at the end
6486 % of the @verbatim input line itself. Otherwise we get an extra blank
6487 % line in the output.
6488 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6489 % We really want {...\end verbatim} in the body of the macro, but
6490 % without the active space; thus we have to use \xdef and \gobble.
6494 \setupverbatim\doverbatim
6496 \let\Everbatim = \afterenvbreak
6499 % @verbatiminclude FILE - insert text of file in verbatim environment.
6501 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6503 \def\doverbatiminclude#1{%
6505 \makevalueexpandable
6507 \indexnofonts % Allow `@@' and other weird things in file names.
6513 % @copying ... @end copying.
6514 % Save the text away for @insertcopying later.
6516 % We save the uninterpreted tokens, rather than creating a box.
6517 % Saving the text in a box would be much easier, but then all the
6518 % typesetting commands (@smallbook, font changes, etc.) have to be done
6519 % beforehand -- and a) we want @copying to be done first in the source
6520 % file; b) letting users define the frontmatter in as flexible order as
6521 % possible is very desirable.
6523 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6524 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6526 \def\insertcopying{%
6528 \parindent = 0pt % paragraph indentation looks wrong on title page
6529 \scanexp\copyingtext
6537 \newskip\defbodyindent \defbodyindent=.4in
6538 \newskip\defargsindent \defargsindent=50pt
6539 \newskip\deflastargmargin \deflastargmargin=18pt
6540 \newcount\defunpenalty
6542 % Start the processing of @deffn:
6544 \ifnum\lastpenalty<10000
6546 \defunpenalty=10003 % Will keep this @deffn together with the
6547 % following @def command, see below.
6549 % If there are two @def commands in a row, we'll have a \nobreak,
6550 % which is there to keep the function description together with its
6551 % header. But if there's nothing but headers, we need to allow a
6552 % break somewhere. Check specifically for penalty 10002, inserted
6553 % by \printdefunline, instead of 10000, since the sectioning
6554 % commands also insert a nobreak penalty, and we don't want to allow
6555 % a break between a section heading and a defun.
6557 % As a minor refinement, we avoid "club" headers by signalling
6558 % with penalty of 10003 after the very first @deffn in the
6559 % sequence (see above), and penalty of 10002 after any following
6561 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6563 % Similarly, after a section heading, do not allow a break.
6564 % But do insert the glue.
6565 \medskip % preceded by discardable penalty, so not a breakpoint
6569 \advance\leftskip by \defbodyindent
6570 \exdentamount=\defbodyindent
6574 % First, check whether we are in the right environment:
6577 % As above, allow line break if we have multiple x headers in a row.
6578 % It's not a great place, though.
6579 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6581 % And now, it's time to reuse the body of the original defun:
6582 \expandafter\gobbledefun#1%
6584 \def\gobbledefun#1\startdefun{}
6586 % \printdefunline \deffnheader{text}
6588 \def\printdefunline#1#2{%
6590 % call \deffnheader:
6593 \interlinepenalty = 10000
6594 \advance\rightskip by 0pt plus 1fil\relax
6596 \nobreak\vskip -\parskip
6597 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6598 % Some of the @defun-type tags do not enable magic parentheses,
6599 % rendering the following check redundant. But we don't optimize.
6604 \def\Edefun{\endgraf\medbreak}
6606 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6607 % the only thing remaining is to define \deffnheader.
6610 \expandafter\let\csname E#1\endcsname = \Edefun
6611 \edef\temp{\noexpand\domakedefun
6612 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6616 % \domakedefun \deffn \deffnx \deffnheader
6618 % Define \deffn and \deffnx, without parameters.
6619 % \deffnheader has to be defined explicitly.
6621 \def\domakedefun#1#2#3{%
6624 \parseargusing\activeparens{\printdefunline#3}%
6626 \def#2{\dodefunx#1}%
6630 %%% Untyped functions:
6632 % @deffn category name args
6633 \makedefun{deffn}{\deffngeneral{}}
6635 % @deffn category class name args
6636 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6638 % \defopon {category on}class name args
6639 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6641 % \deffngeneral {subind}category name args
6643 \def\deffngeneral#1#2 #3 #4\endheader{%
6644 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6645 \dosubind{fn}{\code{#3}}{#1}%
6646 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6649 %%% Typed functions:
6651 % @deftypefn category type name args
6652 \makedefun{deftypefn}{\deftypefngeneral{}}
6654 % @deftypeop category class type name args
6655 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6657 % \deftypeopon {category on}class type name args
6658 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6660 % \deftypefngeneral {subind}category type name args
6662 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6663 \dosubind{fn}{\code{#4}}{#1}%
6664 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6667 %%% Typed variables:
6669 % @deftypevr category type var args
6670 \makedefun{deftypevr}{\deftypecvgeneral{}}
6672 % @deftypecv category class type var args
6673 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6675 % \deftypecvof {category of}class type var args
6676 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6678 % \deftypecvgeneral {subind}category type var args
6680 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6681 \dosubind{vr}{\code{#4}}{#1}%
6682 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6685 %%% Untyped variables:
6687 % @defvr category var args
6688 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6690 % @defcv category class var args
6691 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6693 % \defcvof {category of}class var args
6694 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6697 % @deftp category name args
6698 \makedefun{deftp}#1 #2 #3\endheader{%
6699 \doind{tp}{\code{#2}}%
6700 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6703 % Remaining @defun-like shortcuts:
6704 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6705 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6706 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6707 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6708 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6709 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6710 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6711 \makedefun{defmethod}{\defopon\putwordMethodon}
6712 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6713 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6714 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6716 % \defname, which formats the name of the @def (not the args).
6717 % #1 is the category, such as "Function".
6718 % #2 is the return type, if any.
6719 % #3 is the function name.
6721 % We are followed by (but not passed) the arguments, if any.
6723 \def\defname#1#2#3{%
6724 % Get the values of \leftskip and \rightskip as they were outside the @def...
6725 \advance\leftskip by -\defbodyindent
6727 % How we'll format the type name. Putting it in brackets helps
6728 % distinguish it from the body text that may end up on the next line
6731 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6733 % Figure out line sizes for the paragraph shape.
6734 % The first line needs space for \box0; but if \rightskip is nonzero,
6735 % we need only space for the part of \box0 which exceeds it:
6736 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6737 % The continuations:
6738 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6739 % (plain.tex says that \dimen1 should be used only as global.)
6740 \parshape 2 0in \dimen0 \defargsindent \dimen2
6742 % Put the type name to the right margin.
6745 \hfil\box0 \kern-\hsize
6746 % \hsize has to be shortened this way:
6748 % Intentionally do not respect \rightskip, since we need the space.
6751 % Allow all lines to be underfull without complaint:
6752 \tolerance=10000 \hbadness=10000
6753 \exdentamount=\defbodyindent
6755 % defun fonts. We use typewriter by default (used to be bold) because:
6756 % . we're printing identifiers, they should be in tt in principle.
6757 % . in languages with many accents, such as Czech or French, it's
6758 % common to leave accents off identifiers. The result looks ok in
6759 % tt, but exceedingly strange in rm.
6760 % . we don't want -- and --- to be treated as ligatures.
6761 % . this still does not fix the ?` and !` ligatures, but so far no
6762 % one has made identifiers using them :).
6764 \def\temp{#2}% return value type
6765 \ifx\temp\empty\else \tclose{\temp} \fi
6766 #3% output function name
6768 {\rm\enskip}% hskip 0.5 em of \tenrm
6771 % arguments will be output next, if any.
6774 % Print arguments in slanted roman (not ttsl), inconsistently with using
6775 % tt for the name. This is because literal text is sometimes needed in
6776 % the argument list (groff manual), and ttsl and tt are not very
6777 % distinguishable. Prevent hyphenation at `-' chars.
6780 % use sl by default (not ttsl),
6782 \df \sl \hyphenchar\font=0
6784 % On the other hand, if an argument has two dashes (for instance), we
6785 % want a way to get ttsl. Let's try @var for that.
6786 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6788 \sl\hyphenchar\font=45
6791 % We want ()&[] to print specially on the defun line.
6794 \catcode`\(=\active \catcode`\)=\active
6795 \catcode`\[=\active \catcode`\]=\active
6799 % Make control sequences which act like normal parenthesis chars.
6800 \let\lparen = ( \let\rparen = )
6802 % Be sure that we always have a definition for `(', etc. For example,
6803 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6804 % so TeX would otherwise complain about undefined control sequence.
6807 \global\let(=\lparen \global\let)=\rparen
6808 \global\let[=\lbrack \global\let]=\rbrack
6811 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6812 \gdef\magicamp{\let&=\amprm}
6815 \newcount\parencount
6817 % If we encounter &foo, then turn on ()-hacking afterwards
6819 \def\amprm#1 {\ampseentrue{\bf\ }}
6823 % At the first level, print parens in roman,
6824 % otherwise use the default font.
6825 \ifnum \parencount=1 \rm \fi
6827 % The \sf parens (in \boldbrax) actually are a little bolder than
6828 % the contained text. This is especially needed for [ and ] .
6832 \def\infirstlevel#1{%
6839 \def\bfafterword#1 {#1 \bf}
6842 \global\advance\parencount by 1
6844 \infirstlevel \bfafterword
6849 \global\advance\parencount by -1
6852 \newcount\brackcount
6854 \global\advance\brackcount by 1
6859 \global\advance\brackcount by -1
6862 \def\checkparencounts{%
6863 \ifnum\parencount=0 \else \badparencount \fi
6864 \ifnum\brackcount=0 \else \badbrackcount \fi
6866 % these should not use \errmessage; the glibc manual, at least, actually
6867 % has such constructs (when documenting function pointers).
6868 \def\badparencount{%
6869 \message{Warning: unbalanced parentheses in @def...}%
6870 \global\parencount=0
6872 \def\badbrackcount{%
6873 \message{Warning: unbalanced square brackets in @def...}%
6874 \global\brackcount=0
6881 % To do this right we need a feature of e-TeX, \scantokens,
6882 % which we arrange to emulate with a temporary file in ordinary TeX.
6883 \ifx\eTeXversion\undefined
6884 \newwrite\macscribble
6887 \immediate\openout\macscribble=\jobname.tmp
6888 \immediate\write\macscribble{\the\toks0}%
6889 \immediate\closeout\macscribble
6897 \let\xeatspaces\eatspaces
6898 % Undo catcode changes of \startcontents and \doprintindex
6899 % When called from @insertcopying or (short)caption, we need active
6900 % backslash to get it printed correctly. Previously, we had
6901 % \catcode`\\=\other instead. We'll see whether a problem appears
6902 % with macro expansion. --kasal, 19aug04
6903 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6907 % Append \endinput to make sure that TeX does not see the ending newline.
6908 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6910 \scantokens{#1\endinput}%
6915 \edef\temp{\noexpand\scanmacro{#1}}%
6919 \newcount\paramno % Count of parameters
6920 \newtoks\macname % Macro name
6921 \newif\ifrecursive % Is it recursive?
6923 % List of all defined macros in the form
6924 % \definedummyword\macro1\definedummyword\macro2...
6925 % Currently is also contains all @aliases; the list can be split
6926 % if there is a need.
6929 % Add the macro to \macrolist
6930 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6931 \def\addtomacrolistxxx#1{%
6932 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6933 \xdef\macrolist{\the\toks0}%
6937 % This does \let #1 = #2, with \csnames; that is,
6938 % \let \csname#1\endcsname = \csname#2\endcsname
6939 % (except of course we have to play expansion games).
6943 \csname#1\expandafter\endcsname
6947 % Trim leading and trailing spaces off a string.
6948 % Concepts from aro-bend problem 15 (see CTAN).
6950 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6951 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6952 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6954 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6957 % Trim a single trailing ^^M off a string.
6958 {\catcode`\^^M=\other \catcode`\Q=3%
6959 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6960 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6961 \gdef\eatcrb#1Q#2Q{#1}%
6964 % Macro bodies are absorbed as an argument in a context where
6965 % all characters are catcode 10, 11 or 12, except \ which is active
6966 % (as in normal texinfo). It is necessary to change the definition of \
6967 % to recognize macro arguments; this is the job of \mbodybackslash.
6969 % Non-ASCII encodings make 8-bit characters active, so un-activate
6970 % them to avoid their expansion. Must do this non-globally, to
6971 % confine the change to the current group.
6973 % It's necessary to have hard CRs when the macro is executed. This is
6974 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6975 % body, and then making it the \newlinechar in \scanmacro.
6977 \def\scanctxt{% used as subroutine
6987 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6990 \def\scanargctxt{% used for copying and captions, not macros.
6993 \catcode`\^^M=\other
6996 \def\macrobodyctxt{% used for @macro definitions
7000 \catcode`\^^M=\other
7004 \def\macroargctxt{% used when scanning invocations
7008 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7009 % for the single characters \ { }. Thus, we end up with the "commands"
7010 % that would be written @\ @{ @} in a Texinfo document.
7012 % We already have @{ and @}. For @\, we define it here, and only for
7013 % this purpose, to produce a typewriter backslash (so, the @\ that we
7014 % define for @math can't be used with @macro calls):
7016 \def\\{\normalbackslash}%
7018 % We would like to do this for \, too, since that is what makeinfo does.
7019 % But it is not possible, because Texinfo already has a command @, for a
7020 % cedilla accent. Documents must use @comma{} instead.
7022 % \anythingelse will almost certainly be an error of some kind.
7025 % \mbodybackslash is the definition of \ in @macro bodies.
7026 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7027 % where N is the macro parameter number.
7028 % We define \csname macarg.\endcsname to be \realbackslash, so
7029 % \\ in macro replacement text gets you a backslash.
7031 {\catcode`@=0 @catcode`@\=@active
7032 @gdef@usembodybackslash{@let\=@mbodybackslash}
7033 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7035 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7037 \def\margbackslash#1{\char`\#1 }
7039 \def\macro{\recursivefalse\parsearg\macroxxx}
7040 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7043 \getargs{#1}% now \macname is the macname and \argl the arglist
7044 \ifx\argl\empty % no arguments
7047 \expandafter\parsemargdef \argl;%
7049 \if1\csname ismacro.\the\macname\endcsname
7050 \message{Warning: redefining \the\macname}%
7052 \expandafter\ifx\csname \the\macname\endcsname \relax
7053 \else \errmessage{Macro name \the\macname\space already defined}\fi
7054 \global\cslet{macsave.\the\macname}{\the\macname}%
7055 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7056 \addtomacrolist{\the\macname}%
7058 \begingroup \macrobodyctxt
7059 \ifrecursive \expandafter\parsermacbody
7060 \else \expandafter\parsemacbody
7063 \parseargdef\unmacro{%
7064 \if1\csname ismacro.#1\endcsname
7065 \global\cslet{#1}{macsave.#1}%
7066 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7067 % Remove the macro name from \macrolist:
7069 \expandafter\let\csname#1\endcsname \relax
7070 \let\definedummyword\unmacrodo
7071 \xdef\macrolist{\macrolist}%
7074 \errmessage{Macro #1 not defined}%
7078 % Called by \do from \dounmacro on each macro. The idea is to omit any
7079 % macro definitions that have been changed to \relax.
7085 \noexpand\definedummyword \noexpand#1%
7089 % This makes use of the obscure feature that if the last token of a
7090 % <parameter list> is #, then the preceding argument is delimited by
7091 % an opening brace, and that opening brace is not consumed.
7092 \def\getargs#1{\getargsxxx#1{}}
7093 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7094 \def\getmacname#1 #2\relax{\macname={#1}}
7095 \def\getmacargs#1{\def\argl{#1}}
7097 % Parse the optional {params} list. Set up \paramno and \paramlist
7098 % so \defmacro knows what to do. Define \macarg.blah for each blah
7099 % in the params list to be ##N where N is the position in that list.
7100 % That gets used by \mbodybackslash (above).
7102 % We need to get `macro parameter char #' into several definitions.
7103 % The technique used is stolen from LaTeX: let \hash be something
7104 % unexpandable, insert that wherever you need a #, and then redefine
7105 % it to # just before using the token list produced.
7107 % The same technique is used to protect \eatspaces till just before
7108 % the macro is used.
7110 \def\parsemargdef#1;{%
7111 \paramno=0\def\paramlist{}%
7113 \let\xeatspaces\relax
7114 \parsemargdefxxx#1,;,%
7116 \def\parsemargdefxxx#1,{%
7117 \if#1;\let\next=\relax
7118 \else \let\next=\parsemargdefxxx
7119 \advance\paramno by 1
7120 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7121 {\xeatspaces{\hash\the\paramno}}%
7122 \edef\paramlist{\paramlist\hash\the\paramno,}%
7125 % These two commands read recursive and nonrecursive macro bodies.
7126 % (They're different since rec and nonrec macros end differently.)
7128 \long\def\parsemacbody#1@end macro%
7129 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7130 \long\def\parsermacbody#1@end rmacro%
7131 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7133 % This defines the macro itself. There are six cases: recursive and
7134 % nonrecursive macros of zero, one, and many arguments.
7135 % Much magic with \expandafter here.
7136 % \xdef is used so that macro definitions will survive the file
7137 % they're defined in; @include reads the file inside a group.
7140 \let\hash=##% convert placeholders to macro parameter chars
7144 \expandafter\xdef\csname\the\macname\endcsname{%
7145 \noexpand\scanmacro{\temp}}%
7147 \expandafter\xdef\csname\the\macname\endcsname{%
7148 \bgroup\noexpand\macroargctxt
7149 \noexpand\braceorline
7150 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7151 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7152 \egroup\noexpand\scanmacro{\temp}}%
7154 \expandafter\xdef\csname\the\macname\endcsname{%
7155 \bgroup\noexpand\macroargctxt
7156 \noexpand\csname\the\macname xx\endcsname}%
7157 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7158 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7159 \expandafter\expandafter
7161 \expandafter\expandafter
7162 \csname\the\macname xxx\endcsname
7163 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7168 \expandafter\xdef\csname\the\macname\endcsname{%
7169 \noexpand\norecurse{\the\macname}%
7170 \noexpand\scanmacro{\temp}\egroup}%
7172 \expandafter\xdef\csname\the\macname\endcsname{%
7173 \bgroup\noexpand\macroargctxt
7174 \noexpand\braceorline
7175 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7176 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7178 \noexpand\norecurse{\the\macname}%
7179 \noexpand\scanmacro{\temp}\egroup}%
7181 \expandafter\xdef\csname\the\macname\endcsname{%
7182 \bgroup\noexpand\macroargctxt
7183 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7184 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7185 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7186 \expandafter\expandafter
7188 \expandafter\expandafter
7189 \csname\the\macname xxx\endcsname
7192 \noexpand\norecurse{\the\macname}%
7193 \noexpand\scanmacro{\temp}\egroup}%
7197 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7199 % \braceorline decides whether the next nonwhitespace character is a
7200 % {. If so it reads up to the closing }, if not, it reads the whole
7201 % line. Whatever was read is then fed to the next control sequence
7202 % as an argument (by \parsebrace or \parsearg).
7204 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7205 \def\braceorlinexxx{%
7206 \ifx\nchar\bgroup\else
7207 \expandafter\parsearg
7212 % We need some trickery to remove the optional spaces around the equal
7213 % sign. Make them active and then expand them all to nothing.
7215 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7216 \def\aliasxxx #1{\aliasyyy#1\relax}
7217 \def\aliasyyy #1=#2\relax{%
7219 \expandafter\let\obeyedspace=\empty
7220 \addtomacrolist{#1}%
7221 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7227 \message{cross references,}
7230 \newif\ifhavexrefs % True if xref values are known.
7231 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7233 % @inforef is relatively simple.
7234 \def\inforef #1{\inforefzzz #1,,,,**}
7235 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7236 node \samp{\ignorespaces#1{}}}
7238 % @node's only job in TeX is to define \lastnode, which is used in
7239 % cross-references. The @node line might or might not have commas, and
7240 % might or might not have spaces before the first comma, like:
7241 % @node foo , bar , ...
7242 % We don't want such trailing spaces in the node name.
7244 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7246 % also remove a trailing comma, in case of something like this:
7247 % @node Help-Cross, , , Cross-refs
7248 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7249 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7252 \let\lastnode=\empty
7254 % Write a cross-reference definition for the current node. #1 is the
7255 % type (Ynumbered, Yappendix, Ynothing).
7258 \ifx\lastnode\empty\else
7259 \setref{\lastnode}{#1}%
7260 \global\let\lastnode=\empty
7264 % @anchor{NAME} -- define xref target at arbitrary point.
7266 \newcount\savesfregister
7268 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7269 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7270 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7272 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7273 % anchor), which consists of three parts:
7274 % 1) NAME-title - the current sectioning name taken from \lastsection,
7275 % or the anchor name.
7276 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7277 % empty for anchors.
7278 % 3) NAME-pg - the page number.
7280 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7281 % floats, there is an additional part, which is not written here:
7282 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7288 \atdummies % preserve commands, but don't expand them
7289 \edef\writexrdef##1##2{%
7290 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7291 ##1}{##2}}% these are parameters of \writexrdef
7293 \toks0 = \expandafter{\lastsection}%
7294 \immediate \writexrdef{title}{\the\toks0 }%
7295 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7296 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7301 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7302 % the node name, #2 the name of the Info cross-reference, #3 the printed
7303 % node name, #4 the name of the Info file, #5 the name of the printed
7304 % manual. All but the node name can be omitted.
7306 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7307 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7308 \def\ref#1{\xrefX[#1,,,,,,,]}
7309 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7311 \def\printedmanual{\ignorespaces #5}%
7312 \def\printedrefname{\ignorespaces #3}%
7313 \setbox1=\hbox{\printedmanual\unskip}%
7314 \setbox0=\hbox{\printedrefname\unskip}%
7316 % No printed node name was explicitly given.
7317 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7318 % Use the node name inside the square brackets.
7319 \def\printedrefname{\ignorespaces #1}%
7321 % Use the actual chapter/section title appear inside
7322 % the square brackets. Use the real section title if we have it.
7324 % It is in another manual, so we don't have it.
7325 \def\printedrefname{\ignorespaces #1}%
7328 % We know the real title if we have the xref values.
7329 \def\printedrefname{\refx{#1-title}{}}%
7331 % Otherwise just copy the Info node name.
7332 \def\printedrefname{\ignorespaces #1}%
7338 % Make link in pdf output.
7342 % This expands tokens, so do it after making catcode changes, so _
7343 % etc. don't get their TeX definitions.
7346 % See comments at \activebackslashdouble.
7347 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7348 \backslashparens\pdfxrefdest}%
7351 \startlink attr{/Border [0 0 0]}%
7352 \ifnum\filenamelength>0
7353 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7355 goto name{\pdfmkpgn{\pdfxrefdest}}%
7358 \setcolor{\linkcolor}%
7361 % Float references are printed completely differently: "Figure 1.2"
7362 % instead of "[somenode], p.3". We distinguish them by the
7363 % LABEL-title being set to a magic string.
7365 % Have to otherify everything special to allow the \csname to
7366 % include an _ in the xref name, etc.
7369 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7370 \csname XR#1-title\endcsname
7372 \iffloat\Xthisreftitle
7373 % If the user specified the print name (third arg) to the ref,
7374 % print it instead of our usual "Figure 1.2".
7381 % if the user also gave the printed manual name (fifth arg), append
7384 \space \putwordin{} \cite{\printedmanual}%
7387 % node/anchor (non-float) references.
7389 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7390 % insert empty discretionaries after hyphens, which means that it will
7391 % not find a line break at a hyphen in a node names. Since some manuals
7392 % are best written with fairly long node names, containing hyphens, this
7393 % is a loss. Therefore, we give the text of the node name again, so it
7394 % is as if TeX is seeing it for the first time.
7396 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7398 % _ (for example) has to be the character _ for the purposes of the
7399 % control sequence corresponding to the node, but it has to expand
7400 % into the usual \leavevmode...\vrule stuff for purposes of
7401 % printing. So we \turnoffactive for the \refx-snt, back on for the
7402 % printing, back off for the \refx-pg.
7404 % Only output a following space if the -snt ref is nonempty; for
7405 % @unnumbered and @anchor, it won't be.
7406 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7407 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7409 % output the `[mynode]' via a macro so it can be overridden.
7410 \xrefprintnodename\printedrefname
7412 % But we always want a comma and a space:
7415 % output the `page 3'.
7416 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7422 % This macro is called from \xrefX for the `[nodename]' part of xref
7423 % output. It's a separate macro only so it can be changed more easily,
7424 % since square brackets don't work well in some documents. Particularly
7425 % one that Bob is working on :).
7427 \def\xrefprintnodename#1{[#1]}
7429 % Things referred to by \setref.
7435 \putwordChapter@tie \the\chapno
7436 \else \ifnum\subsecno=0
7437 \putwordSection@tie \the\chapno.\the\secno
7438 \else \ifnum\subsubsecno=0
7439 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7441 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7446 \putwordAppendix@tie @char\the\appendixno{}%
7447 \else \ifnum\subsecno=0
7448 \putwordSection@tie @char\the\appendixno.\the\secno
7449 \else \ifnum\subsubsecno=0
7450 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7453 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7457 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7458 % If its value is nonempty, SUFFIX is output afterward.
7464 \expandafter\global\expandafter\let\expandafter\thisrefX
7465 \csname XR#1\endcsname
7468 % If not defined, say something at least.
7469 \angleleft un\-de\-fined\angleright
7472 {\toks0 = {#1}% avoid expansion of possibly-complex value
7473 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
7476 \global\warnedxrefstrue
7477 \message{Cross reference values unknown; you must run TeX again.}%
7482 % It's defined, so just use it.
7485 #2% Output the suffix in any case.
7488 % This is the macro invoked by entries in the aux file. Usually it's
7489 % just a \def (we prepend XR to the control sequence name to avoid
7490 % collisions). But if this is a float type, we have more work to do.
7493 {% The node name might contain 8-bit characters, which in our current
7494 % implementation are changed to commands like @'e. Don't let these
7495 % mess up the control sequence name.
7498 \xdef\safexrefname{#1}%
7501 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7503 % Was that xref control sequence that we just defined for a float?
7504 \expandafter\iffloat\csname XR\safexrefname\endcsname
7505 % it was a float, and we have the (safe) float type in \iffloattype.
7506 \expandafter\let\expandafter\floatlist
7507 \csname floatlist\iffloattype\endcsname
7509 % Is this the first time we've seen this float type?
7510 \expandafter\ifx\floatlist\relax
7511 \toks0 = {\do}% yes, so just \do
7513 % had it before, so preserve previous elements in list.
7514 \toks0 = \expandafter{\floatlist\do}%
7517 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7518 % for later use in \listoffloats.
7519 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7524 % Read the last existing aux file, if any. No error if none exists.
7527 \openin 1 \jobname.aux
7530 \global\havexrefstrue
7535 \def\setupdatafile{%
7536 \catcode`\^^@=\other
7537 \catcode`\^^A=\other
7538 \catcode`\^^B=\other
7539 \catcode`\^^C=\other
7540 \catcode`\^^D=\other
7541 \catcode`\^^E=\other
7542 \catcode`\^^F=\other
7543 \catcode`\^^G=\other
7544 \catcode`\^^H=\other
7545 \catcode`\^^K=\other
7546 \catcode`\^^L=\other
7547 \catcode`\^^N=\other
7548 \catcode`\^^P=\other
7549 \catcode`\^^Q=\other
7550 \catcode`\^^R=\other
7551 \catcode`\^^S=\other
7552 \catcode`\^^T=\other
7553 \catcode`\^^U=\other
7554 \catcode`\^^V=\other
7555 \catcode`\^^W=\other
7556 \catcode`\^^X=\other
7557 \catcode`\^^Z=\other
7558 \catcode`\^^[=\other
7559 \catcode`\^^\=\other
7560 \catcode`\^^]=\other
7561 \catcode`\^^^=\other
7562 \catcode`\^^_=\other
7563 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7564 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7565 % supported in the main text, it doesn't seem desirable. Furthermore,
7566 % that is not enough: for node names that actually contain a ^
7567 % character, we would end up writing a line like this: 'xrdef {'hat
7568 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7569 % argument, and \hat is not an expandable control sequence. It could
7570 % all be worked out, but why? Either we support ^^ or we don't.
7572 % The other change necessary for this was to define \auxhat:
7573 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7574 % and then to call \auxhat in \setq.
7578 % Special characters. Should be turned off anyway, but...
7591 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7593 % This is to support \ in node names and titles, since the \
7594 % characters end up in a \csname. It's easier than
7595 % leaving it active and making its active definition an actual \
7596 % character. What I don't understand is why it works in the *value*
7597 % of the xrdef. Seems like it should be a catcode12 \, and that
7598 % should not typeset properly. But it works, so I'm moving on for
7599 % now. --karl, 15jan04.
7602 % Make the characters 128-255 be printing characters.
7606 \catcode\count1=\other
7607 \advance\count1 by 1
7608 \ifnum \count1<256 \loop \fi
7612 % @ is our escape character in .aux files, and we need braces.
7618 \def\readdatafile#1{%
7625 \message{insertions,}
7626 % including footnotes.
7628 \newcount \footnoteno
7630 % The trailing space in the following definition for supereject is
7631 % vital for proper filling; pages come out unaligned when you do a
7632 % pagealignmacro call if that space before the closing brace is
7633 % removed. (Generally, numeric constants should always be followed by a
7634 % space to prevent strange expansion errors.)
7635 \def\supereject{\par\penalty -20000\footnoteno =0 }
7637 % @footnotestyle is meaningful for info output only.
7638 \let\footnotestyle=\comment
7642 % Auto-number footnotes. Otherwise like plain.
7644 \let\indent=\ptexindent
7645 \let\noindent=\ptexnoindent
7646 \global\advance\footnoteno by \@ne
7647 \edef\thisfootno{$^{\the\footnoteno}$}%
7649 % In case the footnote comes at the end of a sentence, preserve the
7650 % extra spacing after we do the footnote number.
7652 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7654 % Remove inadvertent blank space before typesetting the footnote number.
7660 % Don't bother with the trickery in plain.tex to not require the
7661 % footnote text as a parameter. Our footnotes don't need to be so general.
7663 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7664 % \parseargline) fails inside footnotes because the tokens are fixed when
7665 % the footnote is read. --karl, 16nov96.
7668 \insert\footins\bgroup
7669 % We want to typeset this text as a normal paragraph, even if the
7670 % footnote reference occurs in (for example) a display environment.
7671 % So reset some parameters.
7673 \interlinepenalty\interfootnotelinepenalty
7674 \splittopskip\ht\strutbox % top baseline for broken footnotes
7675 \splitmaxdepth\dp\strutbox
7676 \floatingpenalty\@MM
7681 \parindent\defaultparindent
7685 % Because we use hanging indentation in footnotes, a @noindent appears
7686 % to exdent this text, so make it be a no-op. makeinfo does not use
7687 % hanging indentation so @noindent can still be needed within footnote
7688 % text after an @example or the like (not that this is good style).
7689 \let\noindent = \relax
7691 % Hang the footnote text off the number. Use \everypar in case the
7692 % footnote extends for more than one paragraph.
7693 \everypar = {\hang}%
7694 \textindent{\thisfootno}%
7696 % Don't crash into the line above the footnote text. Since this
7697 % expands into a box, it must come within the paragraph, lest it
7698 % provide a place where TeX can split the footnote.
7700 \futurelet\next\fo@t
7702 }%end \catcode `\@=11
7704 % In case a @footnote appears in a vbox, save the footnote text and create
7705 % the real \insert just after the vbox finished. Otherwise, the insertion
7707 % Similarly, if a @footnote appears inside an alignment, save the footnote
7708 % text to a box and make the \insert when a row of the table is finished.
7709 % And the same can be done for other insert classes. --kasal, 16nov03.
7711 % Replace the \insert primitive by a cheating macro.
7712 % Deeper inside, just make sure that the saved insertions are not spilled
7715 \def\startsavinginserts{%
7716 \ifx \insert\ptexinsert
7717 \let\insert\saveinsert
7719 \let\checkinserts\relax
7723 % This \insert replacement works for both \insert\footins{foo} and
7724 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7727 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7728 \afterassignment\next
7729 % swallow the left brace
7732 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7733 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7735 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7737 \def\placesaveins#1{%
7738 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7742 % eat @SAVE -- beware, all of them have catcode \other:
7744 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7745 \gdef\gobblesave @SAVE{}
7749 \def\newsaveins #1{%
7750 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7753 \def\newsaveinsX #1{%
7754 \csname newbox\endcsname #1%
7755 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7760 \let\checkinserts\empty
7765 % @image. We use the macros from epsf.tex to support this.
7766 % If epsf.tex is not installed and @image is used, we complain.
7768 % Check for and read epsf.tex up front. If we read it only at @image
7769 % time, we might be inside a group, and then its definitions would get
7770 % undone and the next image would fail.
7771 \openin 1 = epsf.tex
7773 % Do not bother showing banner with epsf.tex v2.7k (available in
7774 % doc/epsf.tex and on ctan).
7775 \def\epsfannounce{\toks0 = }%
7780 % We will only complain once about lack of epsf.tex.
7781 \newif\ifwarnednoepsf
7782 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7783 work. It is also included in the Texinfo distribution, or you can get
7784 it from ftp://tug.org/tex/epsf.tex.}
7787 \ifx\epsfbox\undefined
7788 \ifwarnednoepsf \else
7789 \errhelp = \noepsfhelp
7790 \errmessage{epsf.tex not found, images will be ignored}%
7791 \global\warnednoepsftrue
7794 \imagexxx #1,,,,,\finish
7798 % Arguments to @image:
7799 % #1 is (mandatory) image filename; we tack on .eps extension.
7800 % #2 is (optional) width, #3 is (optional) height.
7801 % #4 is (ignored optional) html alt text.
7802 % #5 is (ignored optional) extension.
7803 % #6 is just the usual extra ignored arg for parsing stuff.
7805 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7806 \catcode`\^^M = 5 % in case we're inside an example
7807 \normalturnoffactive % allow _ et al. in names
7808 % If the image is by itself, center it.
7812 % Usually we'll have text after the image which will insert
7813 % \parskip glue, so insert it here too to equalize the space
7815 \nobreak\vskip\parskip
7819 % Leave vertical mode so that indentation from an enclosing
7820 % environment such as @quotation is respected. On the other hand, if
7821 % it's at the top level, we don't want the normal paragraph indentation.
7826 \dopdfimage{#1}{#2}{#3}%
7828 % \epsfbox itself resets \epsf?size at each figure.
7829 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7830 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7834 \ifimagevmode \medskip \fi % space after the standalone image
7838 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7839 % etc. We don't actually implement floating yet, we always include the
7840 % float "here". But it seemed the best name for the future.
7842 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7844 % There may be a space before second and/or third parameter; delete it.
7845 \def\eatcommaspace#1, {#1,}
7847 % #1 is the optional FLOATTYPE, the text label for this float, typically
7848 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7849 % this float will not be numbered and cannot be referred to.
7851 % #2 is the optional xref label. Also must be present for the float to
7854 % #3 is the optional positioning argument; for now, it is ignored. It
7855 % will somehow specify the positions allowed to float to (here, top, bottom).
7857 % We keep a separate counter for each FLOATTYPE, which we reset at each
7858 % chapter-level command.
7859 \let\resetallfloatnos=\empty
7861 \def\dofloat#1,#2,#3,#4\finish{%
7862 \let\thiscaption=\empty
7863 \let\thisshortcaption=\empty
7865 % don't lose footnotes inside @float.
7867 % BEWARE: when the floats start float, we have to issue warning whenever an
7868 % insert appears inside a float which could possibly float. --kasal, 26may04
7872 % We can't be used inside a paragraph.
7877 \def\floatlabel{#2}%
7878 \def\floatloc{#3}% we do nothing with this yet.
7880 \ifx\floattype\empty
7881 \let\safefloattype=\empty
7884 % the floattype might have accents or other special characters,
7885 % but we need to use it in a control sequence name.
7888 \xdef\safefloattype{\floattype}%
7892 % If label is given but no type, we handle that as the empty type.
7893 \ifx\floatlabel\empty \else
7894 % We want each FLOATTYPE to be numbered separately (Figure 1,
7895 % Table 1, Figure 2, ...). (And if no label, no number.)
7897 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7898 \global\advance\floatno by 1
7901 % This magic value for \lastsection is output by \setref as the
7902 % XREFLABEL-title value. \xrefX uses it to distinguish float
7903 % labels (which have a completely different output format) from
7904 % node and anchor labels. And \xrdef uses it to construct the
7907 \edef\lastsection{\floatmagic=\safefloattype}%
7908 \setref{\floatlabel}{Yfloat}%
7912 % start with \parskip glue, I guess.
7915 % Don't suppress indentation if a float happens to start a section.
7916 \restorefirstparagraphindent
7919 % we have these possibilities:
7920 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7921 % @float Foo,lbl & no caption: Foo 1.1
7922 % @float Foo & @caption{Cap}: Foo: Cap
7923 % @float Foo & no caption: Foo
7924 % @float ,lbl & Caption{Cap}: 1.1: Cap
7925 % @float ,lbl & no caption: 1.1
7926 % @float & @caption{Cap}: Cap
7927 % @float & no caption:
7930 \let\floatident = \empty
7932 % In all cases, if we have a float type, it comes first.
7933 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7935 % If we have an xref label, the number comes next.
7936 \ifx\floatlabel\empty \else
7937 \ifx\floattype\empty \else % if also had float type, need tie first.
7938 \appendtomacro\floatident{\tie}%
7941 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7944 % Start the printed caption with what we've constructed in
7945 % \floatident, but keep it separate; we need \floatident again.
7946 \let\captionline = \floatident
7948 \ifx\thiscaption\empty \else
7949 \ifx\floatident\empty \else
7950 \appendtomacro\captionline{: }% had ident, so need a colon between
7954 \appendtomacro\captionline{\scanexp\thiscaption}%
7957 % If we have anything to print, print it, with space before.
7958 % Eventually this needs to become an \insert.
7959 \ifx\captionline\empty \else
7963 % Space below caption.
7967 % If have an xref label, write the list of floats info. Do this
7968 % after the caption, to avoid chance of it being a breakpoint.
7969 \ifx\floatlabel\empty \else
7970 % Write the text that goes in the lof to the aux file as
7971 % \floatlabel-lof. Besides \floatident, we include the short
7972 % caption if specified, else the full caption if specified, else nothing.
7976 % since we read the caption text in the macro world, where ^^M
7977 % is turned into a normal character, we have to scan it back, so
7978 % we don't write the literal three characters "^^M" into the aux file.
7980 \xdef\noexpand\gtemp{%
7981 \ifx\thisshortcaption\empty
7988 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7989 \ifx\gtemp\empty \else : \gtemp \fi}}%
7992 \egroup % end of \vtop
7994 % place the captured inserts
7996 % BEWARE: when the floats start floating, we have to issue warning
7997 % whenever an insert appears inside a float which could possibly
7998 % float. --kasal, 26may04
8003 % Append the tokens #2 to the definition of macro #1, not expanding either.
8005 \def\appendtomacro#1#2{%
8006 \expandafter\def\expandafter#1\expandafter{#1#2}%
8009 % @caption, @shortcaption
8011 \def\caption{\docaption\thiscaption}
8012 \def\shortcaption{\docaption\thisshortcaption}
8013 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8014 \def\defcaption#1#2{\egroup \def#1{#2}}
8016 % The parameter is the control sequence identifying the counter we are
8017 % going to use. Create it if it doesn't exist and assign it to \floatno.
8020 % Haven't seen this figure type before.
8021 \csname newcount\endcsname #1%
8023 % Remember to reset this floatno at the next chap.
8024 \expandafter\gdef\expandafter\resetallfloatnos
8025 \expandafter{\resetallfloatnos #1=0 }%
8030 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8031 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8032 % first read the @float command.
8034 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8036 % Magic string used for the XREFLABEL-title value, so \xrefX can
8037 % distinguish floats from other xref types.
8038 \def\floatmagic{!!float!!}
8040 % #1 is the control sequence we are passed; we expand into a conditional
8041 % which is true if #1 represents a float ref. That is, the magic
8042 % \lastsection value which we \setref above.
8044 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8046 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8047 % (safe) float type for this float. We set \iffloattype to #2.
8049 \def\doiffloat#1=#2=#3\finish{%
8051 \def\iffloattype{#2}%
8052 \ifx\temp\floatmagic
8055 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8057 \parseargdef\listoffloats{%
8058 \def\floattype{#1}% floattype
8060 % the floattype might have accents or other special characters,
8061 % but we need to use it in a control sequence name.
8064 \xdef\safefloattype{\floattype}%
8067 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8068 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8070 % if the user said @listoffloats foo but never @float foo.
8071 \message{\linenumber No `\safefloattype' floats to list.}%
8075 \leftskip=\tocindent % indent these entries like a toc
8076 \let\do=\listoffloatsdo
8077 \csname floatlist\safefloattype\endcsname
8082 % This is called on each entry in a list of floats. We're passed the
8083 % xref label, in the form LABEL-title, which is how we save it in the
8084 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8085 % has the text we're supposed to typeset here.
8087 % Figures without xref labels will not be included in the list (since
8088 % they won't appear in the aux file).
8090 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8091 \def\listoffloatsdoentry#1-title\finish{{%
8092 % Can't fully expand XR#1-lof because it can contain anything. Just
8093 % pass the control sequence. On the other hand, XR#1-pg is just the
8094 % page number, and we want to fully expand that so we can get a link
8096 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8098 % use the same \entry macro we use to generate the TOC and index.
8099 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8104 \message{localization,}
8106 % For single-language documents, @documentlanguage is usually given very
8107 % early, just after @documentencoding. Single argument is the language
8108 % (de) or locale (de_DE) abbreviation.
8111 \catcode`\_ = \active
8113 \parseargdef\documentlanguage{\begingroup
8114 \let_=\normalunderscore % normal _ character for filenames
8115 \tex % read txi-??.tex file in plain TeX.
8116 % Read the file by the name they passed if it exists.
8117 \openin 1 txi-#1.tex
8119 \documentlanguagetrywithoutunderscore{#1_\finish}%
8121 \globaldefs = 1 % everything in the txi-LL files needs to persist
8125 \endgroup % end raw TeX
8128 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8131 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8132 \openin 1 txi-#1.tex
8134 \errhelp = \nolanghelp
8135 \errmessage{Cannot read language file txi-#1.tex}%
8137 \globaldefs = 1 % everything in the txi-LL files needs to persist
8142 }% end of special _ catcode
8144 \newhelp\nolanghelp{The given language definition file cannot be found or
8145 is empty. Maybe you need to install it? Putting it in the current
8146 directory should work if nowhere else does.}
8148 % This macro is called from txi-??.tex files; the first argument is the
8149 % \language name to set (without the "\lang@" prefix), the second and
8150 % third args are \{left,right}hyphenmin.
8152 % The language names to pass are determined when the format is built.
8153 % See the etex.log file created at that time, e.g.,
8154 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8156 % With TeX Live 2008, etex now includes hyphenation patterns for all
8157 % available languages. This means we can support hyphenation in
8158 % Texinfo, at least to some extent. (This still doesn't solve the
8159 % accented characters problem.)
8162 \def\txisetlanguage#1#2#3{%
8163 % do not set the language if the name is undefined in the current TeX.
8164 \expandafter\ifx\csname lang@#1\endcsname \relax
8165 \message{no patterns for #1}%
8167 \global\language = \csname lang@#1\endcsname
8169 % but there is no harm in adjusting the hyphenmin values regardless.
8170 \global\lefthyphenmin = #2\relax
8171 \global\righthyphenmin = #3\relax
8174 % Helpers for encodings.
8175 % Set the catcode of characters 128 through 255 to the specified number.
8177 \def\setnonasciicharscatcode#1{%
8179 \loop\ifnum\count255<256
8180 \global\catcode\count255=#1\relax
8181 \advance\count255 by 1
8185 \def\setnonasciicharscatcodenonglobal#1{%
8187 \loop\ifnum\count255<256
8188 \catcode\count255=#1\relax
8189 \advance\count255 by 1
8193 % @documentencoding sets the definition of non-ASCII characters
8194 % according to the specified encoding.
8196 \parseargdef\documentencoding{%
8197 % Encoding being declared for the document.
8198 \def\declaredencoding{\csname #1.enc\endcsname}%
8200 % Supported encodings: names converted to tokens in order to be able
8201 % to compare them with \ifx.
8202 \def\ascii{\csname US-ASCII.enc\endcsname}%
8203 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8204 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8205 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8206 \def\utfeight{\csname UTF-8.enc\endcsname}%
8208 \ifx \declaredencoding \ascii
8211 \else \ifx \declaredencoding \lattwo
8212 \setnonasciicharscatcode\active
8215 \else \ifx \declaredencoding \latone
8216 \setnonasciicharscatcode\active
8219 \else \ifx \declaredencoding \latnine
8220 \setnonasciicharscatcode\active
8223 \else \ifx \declaredencoding \utfeight
8224 \setnonasciicharscatcode\active
8228 \message{Unknown document encoding #1, ignoring.}%
8237 % A message to be logged when using a character that isn't available
8238 % the default font encoding (OT1).
8240 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8242 % Take account of \c (plain) vs. \, (Texinfo) difference.
8243 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8245 % First, make active non-ASCII characters in order for them to be
8246 % correctly categorized when TeX reads the replacement text of
8247 % macros containing the character definitions.
8248 \setnonasciicharscatcode\active
8250 % Latin1 (ISO-8859-1) character definitions.
8251 \def\latonechardefs{%
8253 \gdef^^a1{\exclamdown}
8254 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8255 \gdef^^a3{{\pounds}}
8256 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8257 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8258 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8261 \gdef^^a9{\copyright}
8263 \gdef^^ab{\guillemetleft}
8266 \gdef^^ae{\registeredsymbol}
8269 \gdef^^b0{\textdegree}
8278 \gdef^^b8{\cedilla\ }
8282 \gdef^^bb{\guilletright}
8283 \gdef^^bc{$1\over4$}
8284 \gdef^^bd{$1\over2$}
8285 \gdef^^be{$3\over4$}
8286 \gdef^^bf{\questiondown}
8293 \gdef^^c5{\ringaccent A}
8295 \gdef^^c7{\cedilla C}
8327 \gdef^^e5{\ringaccent a}
8329 \gdef^^e7{\cedilla c}
8334 \gdef^^ec{\`{\dotless i}}
8335 \gdef^^ed{\'{\dotless i}}
8336 \gdef^^ee{\^{\dotless i}}
8337 \gdef^^ef{\"{\dotless i}}
8357 % Latin9 (ISO-8859-15) encoding character definitions.
8358 \def\latninechardefs{%
8359 % Encoding is almost identical to Latin1.
8372 % Latin2 (ISO-8859-2) character definitions.
8373 \def\lattwochardefs{%
8375 \gdef^^a1{\ogonek{A}}
8378 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8384 \gdef^^aa{\cedilla S}
8389 \gdef^^af{\dotaccent Z}
8391 \gdef^^b0{\textdegree}
8392 \gdef^^b1{\ogonek{a}}
8393 \gdef^^b2{\ogonek{ }}
8399 \gdef^^b8{\cedilla\ }
8401 \gdef^^ba{\cedilla s}
8406 \gdef^^bf{\dotaccent z}
8415 \gdef^^c7{\cedilla C}
8418 \gdef^^ca{\ogonek{E}}
8434 \gdef^^d9{\ringaccent U}
8439 \gdef^^de{\cedilla T}
8449 \gdef^^e7{\cedilla c}
8452 \gdef^^ea{\ogonek{e}}
8455 \gdef^^ed{\'{\dotless{i}}}
8456 \gdef^^ee{\^{\dotless{i}}}
8468 \gdef^^f9{\ringaccent u}
8473 \gdef^^fe{\cedilla t}
8474 \gdef^^ff{\dotaccent{}}
8477 % UTF-8 character definitions.
8479 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8480 % changes for Texinfo conventions. It is included here under the GPL by
8481 % permission from Frank Mittelbach and the LaTeX team.
8487 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8488 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8490 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8491 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8493 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8494 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8496 \gdef\UTFviiiDefined#1{%
8498 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8509 \global\catcode\countUTFx\active
8510 \uccode`\~\countUTFx
8511 \uppercase\expandafter{\UTFviiiTmp}%
8512 \advance\countUTFx by 1
8513 \ifnum\countUTFx < \countUTFy
8514 \expandafter\UTFviiiLoop
8520 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8526 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8532 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8545 \gdef\DeclareUnicodeCharacter#1#2{%
8546 \countUTFz = "#1\relax
8547 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8550 \def\UTFviiiTwoOctets##1##2{%
8551 \csname u8:##1\string ##2\endcsname}%
8552 \def\UTFviiiThreeOctets##1##2##3{%
8553 \csname u8:##1\string ##2\string ##3\endcsname}%
8554 \def\UTFviiiFourOctets##1##2##3##4{%
8555 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8556 \expandafter\expandafter\expandafter\expandafter
8557 \expandafter\expandafter\expandafter
8558 \gdef\UTFviiiTmp{#2}%
8561 \gdef\parseXMLCharref{%
8562 \ifnum\countUTFz < "A0\relax
8563 \errhelp = \EMsimple
8564 \errmessage{Cannot define Unicode char value < 00A0}%
8565 \else\ifnum\countUTFz < "800\relax
8567 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8568 \else\ifnum\countUTFz < "10000\relax
8571 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8576 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8580 \gdef\parseUTFviiiA#1{%
8581 \countUTFx = \countUTFz
8582 \divide\countUTFz by 64
8583 \countUTFy = \countUTFz
8584 \multiply\countUTFz by 64
8585 \advance\countUTFx by -\countUTFz
8586 \advance\countUTFx by 128
8587 \uccode `#1\countUTFx
8588 \countUTFz = \countUTFy}
8590 \gdef\parseUTFviiiB#1#2#3#4{%
8591 \advance\countUTFz by "#10\relax
8592 \uccode `#3\countUTFz
8593 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8596 \def\utfeightchardefs{%
8597 \DeclareUnicodeCharacter{00A0}{\tie}
8598 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8599 \DeclareUnicodeCharacter{00A3}{\pounds}
8600 \DeclareUnicodeCharacter{00A8}{\"{ }}
8601 \DeclareUnicodeCharacter{00A9}{\copyright}
8602 \DeclareUnicodeCharacter{00AA}{\ordf}
8603 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8604 \DeclareUnicodeCharacter{00AD}{\-}
8605 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8606 \DeclareUnicodeCharacter{00AF}{\={ }}
8608 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8609 \DeclareUnicodeCharacter{00B4}{\'{ }}
8610 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8611 \DeclareUnicodeCharacter{00BA}{\ordm}
8612 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8613 \DeclareUnicodeCharacter{00BF}{\questiondown}
8615 \DeclareUnicodeCharacter{00C0}{\`A}
8616 \DeclareUnicodeCharacter{00C1}{\'A}
8617 \DeclareUnicodeCharacter{00C2}{\^A}
8618 \DeclareUnicodeCharacter{00C3}{\~A}
8619 \DeclareUnicodeCharacter{00C4}{\"A}
8620 \DeclareUnicodeCharacter{00C5}{\AA}
8621 \DeclareUnicodeCharacter{00C6}{\AE}
8622 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8623 \DeclareUnicodeCharacter{00C8}{\`E}
8624 \DeclareUnicodeCharacter{00C9}{\'E}
8625 \DeclareUnicodeCharacter{00CA}{\^E}
8626 \DeclareUnicodeCharacter{00CB}{\"E}
8627 \DeclareUnicodeCharacter{00CC}{\`I}
8628 \DeclareUnicodeCharacter{00CD}{\'I}
8629 \DeclareUnicodeCharacter{00CE}{\^I}
8630 \DeclareUnicodeCharacter{00CF}{\"I}
8632 \DeclareUnicodeCharacter{00D0}{\DH}
8633 \DeclareUnicodeCharacter{00D1}{\~N}
8634 \DeclareUnicodeCharacter{00D2}{\`O}
8635 \DeclareUnicodeCharacter{00D3}{\'O}
8636 \DeclareUnicodeCharacter{00D4}{\^O}
8637 \DeclareUnicodeCharacter{00D5}{\~O}
8638 \DeclareUnicodeCharacter{00D6}{\"O}
8639 \DeclareUnicodeCharacter{00D8}{\O}
8640 \DeclareUnicodeCharacter{00D9}{\`U}
8641 \DeclareUnicodeCharacter{00DA}{\'U}
8642 \DeclareUnicodeCharacter{00DB}{\^U}
8643 \DeclareUnicodeCharacter{00DC}{\"U}
8644 \DeclareUnicodeCharacter{00DD}{\'Y}
8645 \DeclareUnicodeCharacter{00DE}{\TH}
8646 \DeclareUnicodeCharacter{00DF}{\ss}
8648 \DeclareUnicodeCharacter{00E0}{\`a}
8649 \DeclareUnicodeCharacter{00E1}{\'a}
8650 \DeclareUnicodeCharacter{00E2}{\^a}
8651 \DeclareUnicodeCharacter{00E3}{\~a}
8652 \DeclareUnicodeCharacter{00E4}{\"a}
8653 \DeclareUnicodeCharacter{00E5}{\aa}
8654 \DeclareUnicodeCharacter{00E6}{\ae}
8655 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8656 \DeclareUnicodeCharacter{00E8}{\`e}
8657 \DeclareUnicodeCharacter{00E9}{\'e}
8658 \DeclareUnicodeCharacter{00EA}{\^e}
8659 \DeclareUnicodeCharacter{00EB}{\"e}
8660 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8661 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8662 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8663 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8665 \DeclareUnicodeCharacter{00F0}{\dh}
8666 \DeclareUnicodeCharacter{00F1}{\~n}
8667 \DeclareUnicodeCharacter{00F2}{\`o}
8668 \DeclareUnicodeCharacter{00F3}{\'o}
8669 \DeclareUnicodeCharacter{00F4}{\^o}
8670 \DeclareUnicodeCharacter{00F5}{\~o}
8671 \DeclareUnicodeCharacter{00F6}{\"o}
8672 \DeclareUnicodeCharacter{00F8}{\o}
8673 \DeclareUnicodeCharacter{00F9}{\`u}
8674 \DeclareUnicodeCharacter{00FA}{\'u}
8675 \DeclareUnicodeCharacter{00FB}{\^u}
8676 \DeclareUnicodeCharacter{00FC}{\"u}
8677 \DeclareUnicodeCharacter{00FD}{\'y}
8678 \DeclareUnicodeCharacter{00FE}{\th}
8679 \DeclareUnicodeCharacter{00FF}{\"y}
8681 \DeclareUnicodeCharacter{0100}{\=A}
8682 \DeclareUnicodeCharacter{0101}{\=a}
8683 \DeclareUnicodeCharacter{0102}{\u{A}}
8684 \DeclareUnicodeCharacter{0103}{\u{a}}
8685 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8686 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8687 \DeclareUnicodeCharacter{0106}{\'C}
8688 \DeclareUnicodeCharacter{0107}{\'c}
8689 \DeclareUnicodeCharacter{0108}{\^C}
8690 \DeclareUnicodeCharacter{0109}{\^c}
8691 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8692 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8693 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8694 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8695 \DeclareUnicodeCharacter{010C}{\v{C}}
8696 \DeclareUnicodeCharacter{010D}{\v{c}}
8697 \DeclareUnicodeCharacter{010E}{\v{D}}
8699 \DeclareUnicodeCharacter{0112}{\=E}
8700 \DeclareUnicodeCharacter{0113}{\=e}
8701 \DeclareUnicodeCharacter{0114}{\u{E}}
8702 \DeclareUnicodeCharacter{0115}{\u{e}}
8703 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8704 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8705 \DeclareUnicodeCharacter{011A}{\v{E}}
8706 \DeclareUnicodeCharacter{011B}{\v{e}}
8707 \DeclareUnicodeCharacter{011C}{\^G}
8708 \DeclareUnicodeCharacter{011D}{\^g}
8709 \DeclareUnicodeCharacter{011E}{\u{G}}
8710 \DeclareUnicodeCharacter{011F}{\u{g}}
8712 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8713 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8714 \DeclareUnicodeCharacter{0124}{\^H}
8715 \DeclareUnicodeCharacter{0125}{\^h}
8716 \DeclareUnicodeCharacter{0128}{\~I}
8717 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8718 \DeclareUnicodeCharacter{012A}{\=I}
8719 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8720 \DeclareUnicodeCharacter{012C}{\u{I}}
8721 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8723 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8724 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8725 \DeclareUnicodeCharacter{0132}{IJ}
8726 \DeclareUnicodeCharacter{0133}{ij}
8727 \DeclareUnicodeCharacter{0134}{\^J}
8728 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8729 \DeclareUnicodeCharacter{0139}{\'L}
8730 \DeclareUnicodeCharacter{013A}{\'l}
8732 \DeclareUnicodeCharacter{0141}{\L}
8733 \DeclareUnicodeCharacter{0142}{\l}
8734 \DeclareUnicodeCharacter{0143}{\'N}
8735 \DeclareUnicodeCharacter{0144}{\'n}
8736 \DeclareUnicodeCharacter{0147}{\v{N}}
8737 \DeclareUnicodeCharacter{0148}{\v{n}}
8738 \DeclareUnicodeCharacter{014C}{\=O}
8739 \DeclareUnicodeCharacter{014D}{\=o}
8740 \DeclareUnicodeCharacter{014E}{\u{O}}
8741 \DeclareUnicodeCharacter{014F}{\u{o}}
8743 \DeclareUnicodeCharacter{0150}{\H{O}}
8744 \DeclareUnicodeCharacter{0151}{\H{o}}
8745 \DeclareUnicodeCharacter{0152}{\OE}
8746 \DeclareUnicodeCharacter{0153}{\oe}
8747 \DeclareUnicodeCharacter{0154}{\'R}
8748 \DeclareUnicodeCharacter{0155}{\'r}
8749 \DeclareUnicodeCharacter{0158}{\v{R}}
8750 \DeclareUnicodeCharacter{0159}{\v{r}}
8751 \DeclareUnicodeCharacter{015A}{\'S}
8752 \DeclareUnicodeCharacter{015B}{\'s}
8753 \DeclareUnicodeCharacter{015C}{\^S}
8754 \DeclareUnicodeCharacter{015D}{\^s}
8755 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8756 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8758 \DeclareUnicodeCharacter{0160}{\v{S}}
8759 \DeclareUnicodeCharacter{0161}{\v{s}}
8760 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8761 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8762 \DeclareUnicodeCharacter{0164}{\v{T}}
8764 \DeclareUnicodeCharacter{0168}{\~U}
8765 \DeclareUnicodeCharacter{0169}{\~u}
8766 \DeclareUnicodeCharacter{016A}{\=U}
8767 \DeclareUnicodeCharacter{016B}{\=u}
8768 \DeclareUnicodeCharacter{016C}{\u{U}}
8769 \DeclareUnicodeCharacter{016D}{\u{u}}
8770 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8771 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8773 \DeclareUnicodeCharacter{0170}{\H{U}}
8774 \DeclareUnicodeCharacter{0171}{\H{u}}
8775 \DeclareUnicodeCharacter{0174}{\^W}
8776 \DeclareUnicodeCharacter{0175}{\^w}
8777 \DeclareUnicodeCharacter{0176}{\^Y}
8778 \DeclareUnicodeCharacter{0177}{\^y}
8779 \DeclareUnicodeCharacter{0178}{\"Y}
8780 \DeclareUnicodeCharacter{0179}{\'Z}
8781 \DeclareUnicodeCharacter{017A}{\'z}
8782 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8783 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8784 \DeclareUnicodeCharacter{017D}{\v{Z}}
8785 \DeclareUnicodeCharacter{017E}{\v{z}}
8787 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8788 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8789 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8790 \DeclareUnicodeCharacter{01C7}{LJ}
8791 \DeclareUnicodeCharacter{01C8}{Lj}
8792 \DeclareUnicodeCharacter{01C9}{lj}
8793 \DeclareUnicodeCharacter{01CA}{NJ}
8794 \DeclareUnicodeCharacter{01CB}{Nj}
8795 \DeclareUnicodeCharacter{01CC}{nj}
8796 \DeclareUnicodeCharacter{01CD}{\v{A}}
8797 \DeclareUnicodeCharacter{01CE}{\v{a}}
8798 \DeclareUnicodeCharacter{01CF}{\v{I}}
8800 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8801 \DeclareUnicodeCharacter{01D1}{\v{O}}
8802 \DeclareUnicodeCharacter{01D2}{\v{o}}
8803 \DeclareUnicodeCharacter{01D3}{\v{U}}
8804 \DeclareUnicodeCharacter{01D4}{\v{u}}
8806 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8807 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8808 \DeclareUnicodeCharacter{01E6}{\v{G}}
8809 \DeclareUnicodeCharacter{01E7}{\v{g}}
8810 \DeclareUnicodeCharacter{01E8}{\v{K}}
8811 \DeclareUnicodeCharacter{01E9}{\v{k}}
8813 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8814 \DeclareUnicodeCharacter{01F1}{DZ}
8815 \DeclareUnicodeCharacter{01F2}{Dz}
8816 \DeclareUnicodeCharacter{01F3}{dz}
8817 \DeclareUnicodeCharacter{01F4}{\'G}
8818 \DeclareUnicodeCharacter{01F5}{\'g}
8819 \DeclareUnicodeCharacter{01F8}{\`N}
8820 \DeclareUnicodeCharacter{01F9}{\`n}
8821 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8822 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8823 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8824 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8826 \DeclareUnicodeCharacter{021E}{\v{H}}
8827 \DeclareUnicodeCharacter{021F}{\v{h}}
8829 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8830 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8831 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8832 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8833 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8834 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8836 \DeclareUnicodeCharacter{0232}{\=Y}
8837 \DeclareUnicodeCharacter{0233}{\=y}
8838 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8840 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8842 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8843 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8844 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8845 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8846 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8847 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8848 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8849 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8850 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8851 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8852 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8853 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8855 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8856 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8858 \DeclareUnicodeCharacter{1E20}{\=G}
8859 \DeclareUnicodeCharacter{1E21}{\=g}
8860 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8861 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8862 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8863 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8864 \DeclareUnicodeCharacter{1E26}{\"H}
8865 \DeclareUnicodeCharacter{1E27}{\"h}
8867 \DeclareUnicodeCharacter{1E30}{\'K}
8868 \DeclareUnicodeCharacter{1E31}{\'k}
8869 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8870 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8871 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8872 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8873 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8874 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8875 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8876 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8877 \DeclareUnicodeCharacter{1E3E}{\'M}
8878 \DeclareUnicodeCharacter{1E3F}{\'m}
8880 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8881 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8882 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8883 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8884 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8885 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8886 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8887 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8888 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8889 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8891 \DeclareUnicodeCharacter{1E54}{\'P}
8892 \DeclareUnicodeCharacter{1E55}{\'p}
8893 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8894 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8895 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8896 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8897 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8898 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8899 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8900 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8902 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8903 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8904 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8905 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8906 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8907 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8908 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8909 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8910 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8911 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8913 \DeclareUnicodeCharacter{1E7C}{\~V}
8914 \DeclareUnicodeCharacter{1E7D}{\~v}
8915 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8916 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8918 \DeclareUnicodeCharacter{1E80}{\`W}
8919 \DeclareUnicodeCharacter{1E81}{\`w}
8920 \DeclareUnicodeCharacter{1E82}{\'W}
8921 \DeclareUnicodeCharacter{1E83}{\'w}
8922 \DeclareUnicodeCharacter{1E84}{\"W}
8923 \DeclareUnicodeCharacter{1E85}{\"w}
8924 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8925 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8926 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8927 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8928 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8929 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8930 \DeclareUnicodeCharacter{1E8C}{\"X}
8931 \DeclareUnicodeCharacter{1E8D}{\"x}
8932 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8933 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8935 \DeclareUnicodeCharacter{1E90}{\^Z}
8936 \DeclareUnicodeCharacter{1E91}{\^z}
8937 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8938 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8939 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8940 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8941 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8942 \DeclareUnicodeCharacter{1E97}{\"t}
8943 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8944 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8946 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8947 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8949 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8950 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8951 \DeclareUnicodeCharacter{1EBC}{\~E}
8952 \DeclareUnicodeCharacter{1EBD}{\~e}
8954 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8955 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8956 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8957 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8959 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8960 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8962 \DeclareUnicodeCharacter{1EF2}{\`Y}
8963 \DeclareUnicodeCharacter{1EF3}{\`y}
8964 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8966 \DeclareUnicodeCharacter{1EF8}{\~Y}
8967 \DeclareUnicodeCharacter{1EF9}{\~y}
8969 \DeclareUnicodeCharacter{2013}{--}
8970 \DeclareUnicodeCharacter{2014}{---}
8971 \DeclareUnicodeCharacter{2018}{\quoteleft}
8972 \DeclareUnicodeCharacter{2019}{\quoteright}
8973 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8974 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8975 \DeclareUnicodeCharacter{201D}{\quotedblright}
8976 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8977 \DeclareUnicodeCharacter{2022}{\bullet}
8978 \DeclareUnicodeCharacter{2026}{\dots}
8979 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8980 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8981 \DeclareUnicodeCharacter{20AC}{\euro}
8983 \DeclareUnicodeCharacter{2192}{\expansion}
8984 \DeclareUnicodeCharacter{21D2}{\result}
8986 \DeclareUnicodeCharacter{2212}{\minus}
8987 \DeclareUnicodeCharacter{2217}{\point}
8988 \DeclareUnicodeCharacter{2261}{\equiv}
8989 }% end of \utfeightchardefs
8992 % US-ASCII character definitions.
8993 \def\asciichardefs{% nothing need be done
8997 % Make non-ASCII characters printable again for compatibility with
8998 % existing Texinfo documents that may use them, even without declaring a
8999 % document encoding.
9001 \setnonasciicharscatcode \other
9004 \message{formatting,}
9006 \newdimen\defaultparindent \defaultparindent = 15pt
9008 \chapheadingskip = 15pt plus 4pt minus 2pt
9009 \secheadingskip = 12pt plus 3pt minus 2pt
9010 \subsecheadingskip = 9pt plus 2pt minus 2pt
9012 % Prevent underfull vbox error messages.
9015 % Don't be very finicky about underfull hboxes, either.
9018 % Following George Bush, get rid of widows and orphans.
9022 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9023 % using an old version of TeX, don't do anything. We want the amount of
9024 % stretch added to depend on the line length, hence the dependence on
9025 % \hsize. We call this whenever the paper size is set.
9027 \def\setemergencystretch{%
9028 \ifx\emergencystretch\thisisundefined
9029 % Allow us to assign to \emergencystretch anyway.
9030 \def\emergencystretch{\dimen0}%
9032 \emergencystretch = .15\hsize
9036 % Parameters in order: 1) textheight; 2) textwidth;
9037 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9038 % 7) physical page height; 8) physical page width.
9040 % We also call \setleading{\textleading}, so the caller should define
9041 % \textleading. The caller should also set \parskip.
9043 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9046 \splittopskip = \topskip
9049 \advance\vsize by \topskip
9050 \outervsize = \vsize
9051 \advance\outervsize by 2\topandbottommargin
9052 \pageheight = \vsize
9055 \outerhsize = \hsize
9056 \advance\outerhsize by 0.5in
9059 \normaloffset = #4\relax
9060 \bindingoffset = #5\relax
9063 \pdfpageheight #7\relax
9064 \pdfpagewidth #8\relax
9065 % if we don't reset these, they will remain at "1 true in" of
9066 % whatever layout pdftex was dumped with.
9067 \pdfhorigin = 1 true in
9068 \pdfvorigin = 1 true in
9071 \setleading{\textleading}
9073 \parindent = \defaultparindent
9074 \setemergencystretch
9077 % @letterpaper (the default).
9078 \def\letterpaper{{\globaldefs = 1
9079 \parskip = 3pt plus 2pt minus 1pt
9080 \textleading = 13.2pt
9082 % If page is nothing but text, make it come out even.
9083 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9085 {\bindingoffset}{36pt}%
9089 % Use @smallbook to reset parameters for 7x9.25 trim size.
9090 \def\smallbook{{\globaldefs = 1
9091 \parskip = 2pt plus 1pt
9094 \internalpagesizes{7.5in}{5in}%
9096 {\bindingoffset}{16pt}%
9099 \lispnarrowing = 0.3in
9102 \contentsrightmargin = 0pt
9103 \defbodyindent = .5cm
9106 % Use @smallerbook to reset parameters for 6x9 trim size.
9107 % (Just testing, parameters still in flux.)
9108 \def\smallerbook{{\globaldefs = 1
9109 \parskip = 1.5pt plus 1pt
9112 \internalpagesizes{7.4in}{4.8in}%
9117 \lispnarrowing = 0.25in
9120 \contentsrightmargin = 0pt
9121 \defbodyindent = .4cm
9124 % Use @afourpaper to print on European A4 paper.
9125 \def\afourpaper{{\globaldefs = 1
9126 \parskip = 3pt plus 2pt minus 1pt
9127 \textleading = 13.2pt
9129 % Double-side printing via postscript on Laserjet 4050
9130 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9131 % To change the settings for a different printer or situation, adjust
9132 % \normaloffset until the front-side and back-side texts align. Then
9133 % do the same for \bindingoffset. You can set these for testing in
9134 % your texinfo source file like this:
9136 % \global\normaloffset = -6mm
9137 % \global\bindingoffset = 10mm
9139 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9140 {\voffset}{\hoffset}%
9141 {\bindingoffset}{44pt}%
9146 \contentsrightmargin = 0pt
9147 \defbodyindent = 5mm
9150 % Use @afivepaper to print on European A5 paper.
9151 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9152 % He also recommends making @example and @lisp be small.
9153 \def\afivepaper{{\globaldefs = 1
9154 \parskip = 2pt plus 1pt minus 0.1pt
9155 \textleading = 12.5pt
9157 \internalpagesizes{160mm}{120mm}%
9158 {\voffset}{\hoffset}%
9159 {\bindingoffset}{8pt}%
9162 \lispnarrowing = 0.2in
9165 \contentsrightmargin = 0pt
9166 \defbodyindent = 2mm
9170 % A specific text layout, 24x15cm overall, intended for A4 paper.
9171 \def\afourlatex{{\globaldefs = 1
9173 \internalpagesizes{237mm}{150mm}%
9175 {\bindingoffset}{7mm}%
9178 % Must explicitly reset to 0 because we call \afourpaper.
9182 % Use @afourwide to print on A4 paper in landscape format.
9183 \def\afourwide{{\globaldefs = 1
9185 \internalpagesizes{241mm}{165mm}%
9186 {\voffset}{-2.95mm}%
9187 {\bindingoffset}{7mm}%
9192 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9193 % Perhaps we should allow setting the margins, \topskip, \parskip,
9194 % and/or leading, also. Or perhaps we should compute them somehow.
9196 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9197 \def\pagesizesyyy#1,#2,#3\finish{{%
9198 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9201 \parskip = 3pt plus 2pt minus 1pt
9202 \setleading{\textleading}%
9205 \advance\dimen0 by \voffset
9208 \advance\dimen2 by \normaloffset
9210 \internalpagesizes{#1}{\hsize}%
9211 {\voffset}{\normaloffset}%
9212 {\bindingoffset}{44pt}%
9216 % Set default to letter.
9221 \message{and turning on texinfo input format.}
9223 % DEL is a comment character, in case @c does not suffice.
9226 % Define macros to output various characters with catcode for normal text.
9236 \def\normaldoublequote{"}
9239 \def\normalunderscore{_}
9240 \def\normalverticalbar{|}
9242 \def\normalgreater{>}
9244 \def\normaldollar{$}%$ font-lock fix
9246 % This macro is used to make a character print one way in \tt
9247 % (where it can probably be output as-is), and another way in other fonts,
9248 % where something hairier probably needs to be done.
9250 % #1 is what to print if we are indeed using \tt; #2 is what to print
9251 % otherwise. Since all the Computer Modern typewriter fonts have zero
9252 % interword stretch (and shrink), and it is reasonable to expect all
9253 % typewriter fonts to have this, we can check that font parameter.
9255 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9257 % Same as above, but check for italic font. Actually this also catches
9258 % non-italic slanted fonts since it is impossible to distinguish them from
9259 % italic fonts. But since this is only used by $ and it uses \sl anyway
9260 % this is not a problem.
9261 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9263 % Turn off all special characters except @
9264 % (and those which the user can use as if they were ordinary).
9265 % Most of these we simply print from the \tt font, but for some, we can
9266 % use math or other variants that look better in normal text.
9269 \def\activedoublequote{{\tt\char34}}
9270 \let"=\activedoublequote
9272 \def~{{\tt\char126}}
9278 \def_{\ifusingtt\normalunderscore\_}
9280 % Subroutine for the previous macro.
9281 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9284 \def|{{\tt\char124}}
9292 \def+{{\tt \char 43}}
9294 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9296 % If a .fmt file is being used, characters that might appear in a file
9297 % name cannot be active until we have parsed the command line.
9298 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9299 % \otherifyactive is called near the end of this file.
9300 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9302 % Used sometimes to turn off (effectively) the active characters even after
9304 \def\turnoffactive{%
9305 \normalturnoffactive
9311 % \backslashcurfont outputs one backslash character in current font,
9313 \global\chardef\backslashcurfont=`\\
9314 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9316 % \realbackslash is an actual character `\' with catcode other, and
9317 % \doublebackslash is two of them (for the pdf outlines).
9318 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9320 % In texinfo, backslash is an active character; it prints the backslash
9321 % in fixed width font.
9323 @def@normalbackslash{{@tt@backslashcurfont}}
9324 % On startup, @fixbackslash assigns:
9325 % @let \ = @normalbackslash
9327 % \rawbackslash defines an active \ to do \backslashcurfont.
9328 % \otherbackslash defines an active \ to be a literal `\' character with
9330 @gdef@rawbackslash{@let\=@backslashcurfont}
9331 @gdef@otherbackslash{@let\=@realbackslash}
9333 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9334 % the literal character `\'.
9336 @def@normalturnoffactive{%
9337 @let\=@normalbackslash
9338 @let"=@normaldoublequote
9341 @let_=@normalunderscore
9342 @let|=@normalverticalbar
9344 @let>=@normalgreater
9346 @let$=@normaldollar %$ font-lock fix
9347 @markupsetuplqdefault
9348 @markupsetuprqdefault
9352 % Make _ and + \other characters, temporarily.
9353 % This is canceled by @fixbackslash.
9356 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9357 % That is what \eatinput is for; after that, the `\' should revert to printing
9360 @gdef@eatinput input texinfo{@fixbackslash}
9361 @global@let\ = @eatinput
9363 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9364 % the first `\' in the file would cause an error. This macro tries to fix
9365 % that, assuming it is called before the first `\' could plausibly occur.
9366 % Also turn back on active characters that might appear in the input
9367 % file name, in case not using a pre-dumped format.
9369 @gdef@fixbackslash{%
9370 @ifx\@eatinput @let\ = @normalbackslash @fi
9375 % Say @foo, not \foo, in error messages.
9378 % These look ok in all fonts, so just make them not special.
9379 @catcode`@& = @other
9380 @catcode`@# = @other
9381 @catcode`@% = @other
9383 @c Finally, make ` and ' active, so that txicodequoteundirected and
9384 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9385 @c don't make ` and ' active, @code will not get them as active chars.
9386 @c Do this last of all since we use ` in the previous @catcode assignments.
9389 @markupsetuplqdefault
9390 @markupsetuprqdefault
9393 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9394 @c page-delimiter: "^\\\\message"
9395 @c time-stamp-start: "def\\\\texinfoversion{"
9396 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9397 @c time-stamp-end: "}"
9403 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115