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{2011-01-19.09}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011 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\hashChar = `\#
167 \chardef\lquoteChar= `\`
168 \chardef\questChar = `\?
169 \chardef\rquoteChar= `\'
170 \chardef\semiChar = `\;
171 \chardef\slashChar = `\/
172 \chardef\underChar = `\_
178 % The following is used inside several \edef's.
179 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
183 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
184 ap-pen-dix bit-map bit-maps
185 data-base data-bases eshell fall-ing half-way long-est man-u-script
186 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
187 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
189 stand-alone strong-est time-stamp time-stamps which-ever white-space
190 wide-spread wrap-around
193 % Margin to add to right of even pages, to left of odd pages.
194 \newdimen\bindingoffset
195 \newdimen\normaloffset
196 \newdimen\pagewidth \newdimen\pageheight
198 % For a final copy, take out the rectangles
199 % that mark overfull boxes (in case you have decided
200 % that the text looks ok even though it passes the margin).
202 \def\finalout{\overfullrule=0pt }
204 % Sometimes it is convenient to have everything in the transcript file
205 % and nothing on the terminal. We don't just call \tracingall here,
206 % since that produces some useless output on the terminal. We also make
207 % some effort to order the tracing commands to reduce output in the log
208 % file; cf. trace.sty in LaTeX.
210 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
214 \tracinglostchars2 % 2 gives us more in etex
219 \showboxbreadth\maxdimen \showboxdepth\maxdimen
220 \ifx\eTeXversion\undefined\else % etex gives us more logging
227 \tracingcommands3 % 3 gives us more in etex
231 % add check for \lastpenalty to plain's definitions. If the last thing
232 % we did was a \nobreak, we don't want to insert more space.
234 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
235 \removelastskip\penalty-50\smallskip\fi\fi}
236 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
237 \removelastskip\penalty-100\medskip\fi\fi}
238 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
239 \removelastskip\penalty-200\bigskip\fi\fi}
241 % Do @cropmarks to get crop marks.
244 \let\cropmarks = \cropmarkstrue
246 % Dimensions to add cropmarks at corners.
247 % Added by P. A. MacKay, 12 Nov. 1986
249 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
250 \newdimen\cornerlong \cornerlong=1pc
251 \newdimen\cornerthick \cornerthick=.3pt
252 \newdimen\topandbottommargin \topandbottommargin=.75in
254 % Output a mark which sets \thischapter, \thissection and \thiscolor.
255 % We dump everything together because we only have one kind of mark.
256 % This works because we only use \botmark / \topmark, not \firstmark.
258 % A mark contains a subexpression of the \ifcase ... \fi construct.
259 % \get*marks macros below extract the needed part using \ifcase.
261 % Another complication is to let the user choose whether \thischapter
262 % (\thissection) refers to the chapter (section) in effect at the top
263 % of a page, or that at the bottom of a page. The solution is
264 % described on page 260 of The TeXbook. It involves outputting two
265 % marks for the sectioning macros, one before the section break, and
266 % one after. I won't pretend I can describe this better than DEK...
268 \toks0=\expandafter{\lastchapterdefs}%
269 \toks2=\expandafter{\lastsectiondefs}%
270 \toks4=\expandafter{\prevchapterdefs}%
271 \toks6=\expandafter{\prevsectiondefs}%
272 \toks8=\expandafter{\lastcolordefs}%
274 \the\toks0 \the\toks2
275 \noexpand\or \the\toks4 \the\toks6
276 \noexpand\else \the\toks8
279 % \topmark doesn't work for the very first chapter (after the title
280 % page or the contents), so we use \firstmark there -- this gets us
281 % the mark with the chapter defs, unless the user sneaks in, e.g.,
282 % @setcolor (or @url, or @link, etc.) between @contents and the very
284 \def\gettopheadingmarks{%
286 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
288 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
289 \def\getcolormarks{\ifcase2\topmark\fi}
291 % Avoid "undefined control sequence" errors.
292 \def\lastchapterdefs{}
293 \def\lastsectiondefs{}
294 \def\prevchapterdefs{}
295 \def\prevsectiondefs{}
298 % Main output routine.
300 \output = {\onepageout{\pagecontents\PAGE}}
305 % \onepageout takes a vbox as an argument. Note that \pagecontents
306 % does insertions, but you have to call it yourself.
308 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
310 \ifodd\pageno \advance\hoffset by \bindingoffset
311 \else \advance\hoffset by -\bindingoffset\fi
313 % Do this outside of the \shipout so @code etc. will be expanded in
314 % the headline as they should be, not taken literally (outputting ''code).
315 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
316 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
317 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
318 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
321 % Have to do this stuff outside the \shipout because we want it to
322 % take effect in \write's, yet the group defined by the \vbox ends
323 % before the \shipout runs.
325 \indexdummies % don't expand commands in the output.
326 \normalturnoffactive % \ in index entries must not stay \, e.g., if
327 % the page break happens to be in the middle of an example.
328 % We don't want .vr (or whatever) entries like this:
329 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
330 % "\acronym" won't work when it's read back in;
332 % {\code {{\tt \backslashcurfont }acronym}
334 % Do this early so pdf references go to the beginning of the page.
335 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
337 \ifcropmarks \vbox to \outervsize\bgroup
339 \vskip-\topandbottommargin
341 \line{\ewtop\hfil\ewtop}%
344 \vbox{\moveleft\cornerthick\nstop}%
346 \vbox{\moveright\cornerthick\nstop}%
349 \vskip\topandbottommargin
351 \hfil % center the page within the outer (page) hsize.
352 \ifodd\pageno\hskip\bindingoffset\fi
358 \ifdim\ht\footlinebox > 0pt
359 % Only leave this space if the footline is nonempty.
360 % (We lessened \vsize for it in \oddfootingyyy.)
361 % The \baselineskip=24pt in plain's \makefootline has no effect.
367 \egroup % end of \vbox\bgroup
368 \hfil\egroup % end of (centering) \line\bgroup
369 \vskip\topandbottommargin plus1fill minus1fill
370 \boxmaxdepth = \cornerthick
373 \vbox{\moveleft\cornerthick\nsbot}%
375 \vbox{\moveright\cornerthick\nsbot}%
378 \line{\ewbot\hfil\ewbot}%
380 \egroup % \vbox from first cropmarks clause
382 }% end of \shipout\vbox
383 }% end of group with \indexdummies
385 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
388 \newinsert\margin \dimen\margin=\maxdimen
390 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
392 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
393 % marginal hacks, juha@viisa.uucp (Juha Takala)
394 \ifvoid\margin\else % marginal info is present
395 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
396 \dimen@=\dp#1\relax \unvbox#1\relax
397 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
398 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
401 % Here are the rules for the cropmarks. Note that they are
402 % offset so that the space between them is truly \outerhsize or \outervsize
403 % (P. A. MacKay, 12 November, 1986)
405 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
407 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
408 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
410 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
412 % Parse an argument, then pass it to #1. The argument is the rest of
413 % the input line (except we remove a trailing comment). #1 should be a
414 % macro which expects an ordinary undelimited TeX argument.
416 \def\parsearg{\parseargusing{}}
417 \def\parseargusing#1#2{%
423 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
427 \gdef\parseargline#1^^M{%
428 \endgroup % End of the group started in \parsearg.
429 \argremovecomment #1\comment\ArgTerm%
433 % First remove any @comment, then any @c comment.
434 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
435 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
437 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
439 % \argremovec might leave us with trailing space, e.g.,
440 % @end itemize @c foo
441 % This space token undergoes the same procedure and is eventually removed
442 % by \finishparsearg.
444 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
445 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
446 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
449 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
450 \let\temp\finishparsearg
452 \let\temp\argcheckspaces
454 % Put the space token in:
458 % If a _delimited_ argument is enclosed in braces, they get stripped; so
459 % to get _exactly_ the rest of the line, we had to prevent such situation.
460 % We prepended an \empty token at the very beginning and we expand it now,
461 % just before passing the control to \argtorun.
462 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
463 % either the null string, or it ends with \^^M---thus there is no danger
464 % that a pair of braces would be stripped.
466 % But first, we have to remove the trailing space token.
468 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
470 % \parseargdef\foo{...}
471 % is roughly equivalent to
472 % \def\foo{\parsearg\Xfoo}
475 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
476 % favourite TeX trick. --kasal, 16nov03
479 \expandafter \doparseargdef \csname\string#1\endcsname #1%
481 \def\doparseargdef#1#2{%
486 % Several utility definitions with active space:
491 % Make each space character in the input produce a normal interword
492 % space in the output. Don't allow a line break at this space, as this
493 % is used only in environments like @example, where each line of input
494 % should produce a line of output anyway.
496 \gdef\sepspaces{\obeyspaces\let =\tie}
498 % If an index command is used in an @example environment, any spaces
499 % therein should become regular spaces in the raw index file, not the
500 % expansion of \tie (\leavevmode \penalty \@M \ ).
501 \gdef\unsepspaces{\let =\space}
505 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
507 % Define the framework for environments in texinfo.tex. It's used like this:
512 % It's the responsibility of \envdef to insert \begingroup before the
513 % actual body; @end closes the group after calling \Efoo. \envdef also
514 % defines \thisenv, so the current environment is known; @end checks
515 % whether the environment name matches. The \checkenv macro can also be
516 % used to check whether the current environment is the one expected.
518 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
519 % are not treated as environments; they don't open a group. (The
520 % implementation of @end takes care not to call \endgroup in this
524 % At run-time, environments start with this:
525 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
529 % ... but they get defined via ``\envdef\foo{...}'':
530 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
531 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
533 % Check whether we're in the right environment:
542 % Environment mismatch, #1 expected:
545 \errmessage{This command can appear only \inenvironment\temp,
546 not \inenvironment\thisenv}%
548 \def\inenvironment#1{%
550 out of any environment%
552 in environment \expandafter\string#1%
556 % @end foo executes the definition of \Efoo.
557 % But first, it executes a specialized version of \checkenv
560 \if 1\csname iscond.#1\endcsname
562 % The general wording of \badenverr may not be ideal.
563 \expandafter\checkenv\csname#1\endcsname
564 \csname E#1\endcsname
569 \newhelp\EMsimple{Press RETURN to continue.}
572 % Be sure we're in horizontal mode when doing a tie, since we make space
573 % equivalent to this in @example-like environments. Otherwise, a space
574 % at the beginning of a line will start with \penalty -- and
575 % since \penalty is valid in vertical mode, we'd end up putting the
576 % penalty on the vertical list instead of in the new paragraph.
578 % Avoid using \@M directly, because that causes trouble
579 % if the definition is written into an index file.
580 \global\let\tiepenalty = \@M
581 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
584 % @: forces normal size whitespace following.
585 \def\:{\spacefactor=1000 }
587 % @* forces a line break.
588 \def\*{\hfil\break\hbox{}\ignorespaces}
590 % @/ allows a line break.
593 % @. is an end-of-sentence period.
594 \def\.{.\spacefactor=\endofsentencespacefactor\space}
596 % @! is an end-of-sentence bang.
597 \def\!{!\spacefactor=\endofsentencespacefactor\space}
599 % @? is an end-of-sentence query.
600 \def\?{?\spacefactor=\endofsentencespacefactor\space}
602 % @frenchspacing on|off says whether to put extra space after punctuation.
607 \parseargdef\frenchspacing{%
609 \ifx\temp\onword \plainfrenchspacing
610 \else\ifx\temp\offword \plainnonfrenchspacing
613 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
617 % @w prevents a word break. Without the \leavevmode, @w at the
618 % beginning of a paragraph, when TeX is still in vertical mode, would
619 % produce a whole line of output instead of starting the paragraph.
620 \def\w#1{\leavevmode\hbox{#1}}
622 % @group ... @end group forces ... to be all on one page, by enclosing
623 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
624 % to keep its height that of a normal line. According to the rules for
625 % \topskip (p.114 of the TeXbook), the glue inserted is
626 % max (\topskip - \ht (first item), 0). If that height is large,
627 % therefore, no glue is inserted, and the space between the headline and
628 % the text is small, which looks bad.
630 % Another complication is that the group might be very large. This can
631 % cause the glue on the previous page to be unduly stretched, because it
632 % does not have much material. In this case, it's better to add an
633 % explicit \vfill so that the extra space is at the bottom. The
634 % threshold for doing this is if the group is more than \vfilllimit
635 % percent of a page (\vfilllimit can be changed inside of @tex).
641 \ifnum\catcode`\^^M=\active \else
642 \errhelp = \groupinvalidhelp
643 \errmessage{@group invalid in context where filling is enabled}%
647 \setbox\groupbox = \vtop\bgroup
648 % Do @comment since we are called inside an environment such as
649 % @example, where each end-of-line in the input causes an
650 % end-of-line in the output. We don't want the end-of-line after
651 % the `@group' to put extra space in the output. Since @group
652 % should appear on a line by itself (according to the Texinfo
653 % manual), we don't worry about eating any user text.
657 % The \vtop produces a box with normal height and large depth; thus, TeX puts
658 % \baselineskip glue before it, and (when the next line of text is done)
659 % \lineskip glue after it. Thus, space below is not quite equal to space
660 % above. But it's pretty close.
662 % To get correct interline space between the last line of the group
663 % and the first line afterwards, we have to propagate \prevdepth.
664 \endgraf % Not \par, as it may have been set to \lisppar.
665 \global\dimen1 = \prevdepth
666 \egroup % End the \vtop.
667 % \dimen0 is the vertical size of the group's box.
668 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
669 % \dimen2 is how much space is left on the page (more or less).
670 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
671 % if the group doesn't fit on the current page, and it's a big big
672 % group, force a page break.
673 \ifdim \dimen0 > \dimen2
674 \ifdim \pagetotal < \vfilllimit\pageheight
683 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
684 % message, so this ends up printing `@group can only ...'.
686 \newhelp\groupinvalidhelp{%
687 group can only be used in environments such as @example,^^J%
688 where each line of input produces a line of output.}
690 % @need space-in-mils
691 % forces a page break if there is not space-in-mils remaining.
693 \newdimen\mil \mil=0.001in
695 % Old definition--didn't work.
696 %\parseargdef\need{\par %
697 %% This method tries to make TeX break the page naturally
698 %% if the depth of the box does not fit.
700 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
705 % Ensure vertical mode, so we don't make a big box in the middle of a
709 % If the @need value is less than one line space, it's useless.
711 \dimen2 = \ht\strutbox
712 \advance\dimen2 by \dp\strutbox
713 \ifdim\dimen0 > \dimen2
715 % Do a \strut just to make the height of this box be normal, so the
716 % normal leading is inserted relative to the preceding line.
717 % And a page break here is fine.
718 \vtop to #1\mil{\strut\vfil}%
720 % TeX does not even consider page breaks if a penalty added to the
721 % main vertical list is 10000 or more. But in order to see if the
722 % empty box we just added fits on the page, we must make it consider
723 % page breaks. On the other hand, we don't want to actually break the
724 % page after the empty box. So we use a penalty of 9999.
726 % There is an extremely small chance that TeX will actually break the
727 % page at this \penalty, if there are no other feasible breakpoints in
728 % sight. (If the user is using lots of big @group commands, which
729 % almost-but-not-quite fill up a page, TeX will have a hard time doing
730 % good page breaking, for example.) However, I could not construct an
731 % example where a page broke at this \penalty; if it happens in a real
732 % document, then we can reconsider our strategy.
735 % Back up by the size of the box, whether we did a page break or not.
738 % Do not allow a page break right after this kern.
743 % @br forces paragraph break (and is undocumented).
747 % @page forces the start of a new page.
749 \def\page{\par\vfill\supereject}
752 % outputs text on separate line in roman font, starting at standard page margin
754 % This records the amount of indent in the innermost environment.
755 % That's how much \exdent should take out.
756 \newskip\exdentamount
758 % This defn is used inside fill environments such as @defun.
759 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
761 % This defn is used inside nofill environments such as @example.
762 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
763 \leftline{\hskip\leftskip{\rm#1}}}}
765 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
766 % paragraph. For more general purposes, use the \margin insertion
767 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
769 \newskip\inmarginspacing \inmarginspacing=1cm
770 \def\strutdepth{\dp\strutbox}
772 \def\doinmargin#1#2{\strut\vadjust{%
775 \vtop to \strutdepth{%
776 \baselineskip=\strutdepth
778 % if you have multiple lines of stuff to put here, you'll need to
779 % make the vbox yourself of the appropriate size.
781 \llap{\ignorespaces #2\hskip\inmarginspacing}%
783 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
788 \def\inleftmargin{\doinmargin l}
789 \def\inrightmargin{\doinmargin r}
791 % @inmargin{TEXT [, RIGHT-TEXT]}
792 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
793 % else use TEXT for both).
795 \def\inmargin#1{\parseinmargin #1,,\finish}
796 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
797 \setbox0 = \hbox{\ignorespaces #2}%
799 \def\lefttext{#1}% have both texts
802 \def\lefttext{#1}% have only one text
807 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
809 \def\temp{\inleftmargin\lefttext}%
814 % @| inserts a changebar to the left of the current line. It should
815 % surround any changed text. This approach does *not* work if the
816 % change spans more than two lines of output. To handle that, we would
817 % have adopt a much more difficult approach (putting marks into the main
818 % vertical list for the beginning and end of each change). This command
819 % is not documented, not supported, and doesn't work.
822 % \vadjust can only be used in horizontal mode.
825 % Append this vertical mode material after the current line in the output.
827 % We want to insert a rule with the height and depth of the current
828 % leading; that is exactly what \strutbox is supposed to record.
831 % \vadjust-items are inserted at the left edge of the type. So
832 % the \llap here moves out into the left-hand margin.
835 % For a thicker or thinner bar, change the `1pt'.
836 \vrule height\baselineskip width1pt
838 % This is the space between the bar and the text.
844 % @include FILE -- \input text of FILE.
846 \def\include{\parseargusing\filenamecatcodes\includezzz}
851 \makevalueexpandable % we want to expand any @value in FILE.
852 \turnoffactive % and allow special characters in the expansion
853 \indexnofonts % Allow `@@' and other weird things in file names.
854 \wlog{texinfo.tex: doing @include of #1^^J}%
855 \edef\temp{\noexpand\input #1 }%
857 % This trickery is to read FILE outside of a group, in case it makes
863 \def\filenamecatcodes{%
877 \def\pushthisfilestack{%
878 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
880 \def\pushthisfilestackX{%
881 \expandafter\pushthisfilestackY\thisfile\StackTerm
883 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
884 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
887 \def\popthisfilestack{\errthisfilestackempty}
888 \def\errthisfilestackempty{\errmessage{Internal error:
889 the stack of filenames is empty.}}
894 % outputs that line, centered.
896 \parseargdef\center{%
902 \next{\hfil \ignorespaces#1\unskip \hfil}%
907 \advance\hsize by -\leftskip
908 \advance\hsize by -\rightskip
913 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
915 % @sp n outputs n lines of vertical space
917 \parseargdef\sp{\vskip #1\baselineskip}
919 % @comment ...line which is ignored...
920 % @c is the same as @comment
921 % @ignore ... @end ignore is another way to write a comment
923 \def\comment{\begingroup \catcode`\^^M=\other%
924 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
926 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
930 % @paragraphindent NCHARS
931 % We'll use ems for NCHARS, close enough.
932 % NCHARS can also be the word `asis' or `none'.
933 % We cannot feasibly implement @paragraphindent asis, though.
935 \def\asisword{asis} % no translation, these are keywords
938 \parseargdef\paragraphindent{%
943 \defaultparindent = 0pt
945 \defaultparindent = #1em
948 \parindent = \defaultparindent
951 % @exampleindent NCHARS
952 % We'll use ems for NCHARS like @paragraphindent.
953 % It seems @exampleindent asis isn't necessary, but
954 % I preserve it to make it similar to @paragraphindent.
955 \parseargdef\exampleindent{%
962 \lispnarrowing = #1em
967 % @firstparagraphindent WORD
968 % If WORD is `none', then suppress indentation of the first paragraph
969 % after a section heading. If WORD is `insert', then do indent at such
972 % The paragraph indentation is suppressed or not by calling
973 % \suppressfirstparagraphindent, which the sectioning commands do.
974 % We switch the definition of this back and forth according to WORD.
975 % By default, we suppress indentation.
977 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
978 \def\insertword{insert}
980 \parseargdef\firstparagraphindent{%
983 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
984 \else\ifx\temp\insertword
985 \let\suppressfirstparagraphindent = \relax
988 \errmessage{Unknown @firstparagraphindent option `\temp'}%
992 % Here is how we actually suppress indentation. Redefine \everypar to
993 % \kern backwards by \parindent, and then reset itself to empty.
995 % We also make \indent itself not actually do anything until the next
998 \gdef\dosuppressfirstparagraphindent{%
1000 \restorefirstparagraphindent
1004 \restorefirstparagraphindent
1007 \global\everypar = {%
1009 \restorefirstparagraphindent
1013 \gdef\restorefirstparagraphindent{%
1014 \global \let \indent = \ptexindent
1015 \global \let \noindent = \ptexnoindent
1016 \global \everypar = {}%
1020 % @refill is a no-op.
1023 % If working on a large document in chapters, it is convenient to
1024 % be able to disable indexing, cross-referencing, and contents, for test runs.
1025 % This is done with @novalidate (before @setfilename).
1027 \newif\iflinks \linkstrue % by default we want the aux files.
1028 \let\novalidate = \linksfalse
1030 % @setfilename is done at the beginning of every texinfo file.
1031 % So open here the files we need to have open while reading the input.
1032 % This makes it possible to make a .fmt file for texinfo.
1034 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1037 % Open the new aux file. TeX will close it automatically at exit.
1038 \immediate\openout\auxfile=\jobname.aux
1039 \fi % \openindices needs to do some work in any case.
1041 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1043 % If texinfo.cnf is present on the system, read it.
1044 % Useful for site-wide @afourpaper, etc.
1045 \openin 1 texinfo.cnf
1046 \ifeof 1 \else \input texinfo.cnf \fi
1049 \comment % Ignore the actual filename.
1052 % Called from \setfilename.
1064 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1068 % adobe `portable' document format
1072 \newcount\filenamelength
1081 \newif\ifpdfmakepagedest
1083 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1084 % can be set). So we test for \relax and 0 as well as \undefined,
1085 % borrowed from ifpdf.sty.
1086 \ifx\pdfoutput\undefined
1088 \ifx\pdfoutput\relax
1097 % PDF uses PostScript string constants for the names of xref targets,
1098 % for display in the outlines, and in other places. Thus, we have to
1099 % double any backslashes. Otherwise, a name like "\node" will be
1100 % interpreted as a newline (\n), followed by o, d, e. Not good.
1101 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1102 % (and related messages, the final outcome is that it is up to the TeX
1103 % user to double the backslashes and otherwise make the string valid, so
1104 % that's what we do).
1106 % double active backslashes.
1108 {\catcode`\@=0 \catcode`\\=\active
1109 @gdef@activebackslashdouble{%
1111 @let\=@doublebackslash}
1114 % To handle parens, we must adopt a different approach, since parens are
1115 % not active characters. hyperref.dtx (which has the same problem as
1116 % us) handles it with this amazing macro to replace tokens, with minor
1117 % changes for Texinfo. It is included here under the GPL by permission
1118 % from the author, Heiko Oberdiek.
1120 % #1 is the tokens to replace.
1121 % #2 is the replacement.
1122 % #3 is the control sequence with the string.
1124 \def\HyPsdSubst#1#2#3{%
1125 \def\HyPsdReplace##1#1##2\END{%
1131 \HyPsdReplace##2\END
1135 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1137 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1139 % #1 is a control sequence in which to do the replacements.
1140 \def\backslashparens#1{%
1141 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1142 % \lastnode when called from \setref -> \pdfmkdest.
1143 \HyPsdSubst{(}{\realbackslash(}{#1}%
1144 \HyPsdSubst{)}{\realbackslash)}{#1}%
1147 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1148 with PDF output, and none of those formats could be found. (.eps cannot
1149 be supported due to the design of the PDF format; use regular TeX (DVI
1154 % Color manipulation macros based on pdfcolor.tex,
1155 % except using rgb instead of cmyk; the latter is said to render as a
1156 % very dark gray on-screen and a very dark halftone in print, instead
1158 \def\rgbDarkRed{0.50 0.09 0.12}
1159 \def\rgbBlack{0 0 0}
1161 % k sets the color for filling (usual text, etc.);
1162 % K sets the color for stroking (thin rules, e.g., normal _'s).
1163 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1165 % Set color, and create a mark which defines \thiscolor accordingly,
1166 % so that \makeheadline knows which color to restore.
1168 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1173 \def\maincolor{\rgbBlack}
1174 \pdfsetcolor{\maincolor}
1175 \edef\thiscolor{\maincolor}
1176 \def\lastcolordefs{}
1180 \line{\pdfsetcolor{\maincolor}\the\footline}%
1188 % Extract \thiscolor definition from the marks.
1190 % Typeset the headline with \maincolor, then restore the color.
1191 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1199 \pdfcatalog{/PageMode /UseOutlines}
1201 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1202 \def\dopdfimage#1#2#3{%
1203 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1204 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1206 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1207 % others). Let's try in that order.
1208 \let\pdfimgext=\empty
1210 \openin 1 #1.png \ifeof 1
1211 \openin 1 #1.jpg \ifeof 1
1212 \openin 1 #1.jpeg \ifeof 1
1213 \openin 1 #1.JPG \ifeof 1
1214 \openin 1 #1.pdf \ifeof 1
1215 \openin 1 #1.PDF \ifeof 1
1216 \errhelp = \nopdfimagehelp
1217 \errmessage{Could not find image file #1 for pdf}%
1218 \else \gdef\pdfimgext{PDF}%
1220 \else \gdef\pdfimgext{pdf}%
1222 \else \gdef\pdfimgext{JPG}%
1224 \else \gdef\pdfimgext{jpeg}%
1226 \else \gdef\pdfimgext{jpg}%
1228 \else \gdef\pdfimgext{png}%
1233 % without \immediate, ancient pdftex seg faults when the same image is
1234 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1235 \ifnum\pdftexversion < 14
1238 \immediate\pdfximage
1240 \ifdim \wd0 >0pt width \imagewidth \fi
1241 \ifdim \wd2 >0pt height \imageheight \fi
1242 \ifnum\pdftexversion<13
1247 \ifnum\pdftexversion < 14 \else
1248 \pdfrefximage \pdflastximage
1252 % We have to set dummies so commands such as @code, and characters
1253 % such as \, aren't expanded when present in a section title.
1256 \activebackslashdouble
1257 \makevalueexpandable
1258 \def\pdfdestname{#1}%
1259 \backslashparens\pdfdestname
1260 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1263 % used to mark target names; must be expandable.
1266 % by default, use a color that is dark enough to print on paper as
1267 % nearly black, but still distinguishable for online viewing.
1268 \def\urlcolor{\rgbDarkRed}
1269 \def\linkcolor{\rgbDarkRed}
1270 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1272 % Adding outlines to PDF; macros for calculating structure of outlines
1273 % come from Petr Olsak
1274 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1275 \else \csname#1\endcsname \fi}
1276 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1277 \advance\tempnum by 1
1278 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1280 % #1 is the section text, which is what will be displayed in the
1281 % outline by the pdf viewer. #2 is the pdf expression for the number
1282 % of subentries (or empty, for subsubsections). #3 is the node text,
1283 % which might be empty if this toc entry had no corresponding node.
1284 % #4 is the page number
1286 \def\dopdfoutline#1#2#3#4{%
1287 % Generate a link to the node text if that exists; else, use the
1288 % page number. We could generate a destination for the section
1289 % text in the case where a section has no node, but it doesn't
1290 % seem worth the trouble, since most documents are normally structured.
1291 \def\pdfoutlinedest{#3}%
1292 \ifx\pdfoutlinedest\empty
1293 \def\pdfoutlinedest{#4}%
1295 % Doubled backslashes in the name.
1296 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1297 \backslashparens\pdfoutlinedest}%
1300 % Also double the backslashes in the display string.
1301 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1302 \backslashparens\pdfoutlinetext}%
1304 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1307 \def\pdfmakeoutlines{%
1309 % Thanh's hack / proper braces in bookmarks
1310 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1311 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1313 % Read toc silently, to get counts of subentries for \pdfoutline.
1314 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1315 \def\numchapentry##1##2##3##4{%
1316 \def\thischapnum{##2}%
1318 \def\thissubsecnum{0}%
1320 \def\numsecentry##1##2##3##4{%
1321 \advancenumber{chap\thischapnum}%
1322 \def\thissecnum{##2}%
1323 \def\thissubsecnum{0}%
1325 \def\numsubsecentry##1##2##3##4{%
1326 \advancenumber{sec\thissecnum}%
1327 \def\thissubsecnum{##2}%
1329 \def\numsubsubsecentry##1##2##3##4{%
1330 \advancenumber{subsec\thissubsecnum}%
1332 \def\thischapnum{0}%
1334 \def\thissubsecnum{0}%
1336 % use \def rather than \let here because we redefine \chapentry et
1337 % al. a second time, below.
1338 \def\appentry{\numchapentry}%
1339 \def\appsecentry{\numsecentry}%
1340 \def\appsubsecentry{\numsubsecentry}%
1341 \def\appsubsubsecentry{\numsubsubsecentry}%
1342 \def\unnchapentry{\numchapentry}%
1343 \def\unnsecentry{\numsecentry}%
1344 \def\unnsubsecentry{\numsubsecentry}%
1345 \def\unnsubsubsecentry{\numsubsubsecentry}%
1348 % Read toc second time, this time actually producing the outlines.
1349 % The `-' means take the \expnumber as the absolute number of
1350 % subentries, which we calculated on our first read of the .toc above.
1352 % We use the node names as the destinations.
1353 \def\numchapentry##1##2##3##4{%
1354 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1355 \def\numsecentry##1##2##3##4{%
1356 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1357 \def\numsubsecentry##1##2##3##4{%
1358 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1359 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1360 \dopdfoutline{##1}{}{##3}{##4}}%
1362 % PDF outlines are displayed using system fonts, instead of
1363 % document fonts. Therefore we cannot use special characters,
1364 % since the encoding is unknown. For example, the eogonek from
1365 % Latin 2 (0xea) gets translated to a | character. Info from
1366 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1368 % xx to do this right, we have to translate 8-bit characters to
1369 % their "best" equivalent, based on the @documentencoding. Right
1370 % now, I guess we'll just let the pdf reader have its way.
1373 \catcode`\\=\active \otherbackslash
1374 \input \tocreadfilename
1378 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1379 \ifx\PP\D\let\nextsp\relax
1380 \else\let\nextsp\skipspaces
1381 \ifx\p\space\else\addtokens{\filename}{\PP}%
1382 \advance\filenamelength by 1
1386 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1387 \ifnum\pdftexversion < 14
1388 \let \startlink \pdfannotlink
1390 \let \startlink \pdfstartlink
1392 % make a live url in pdf output.
1395 % it seems we really need yet another set of dummies; have not
1396 % tried to figure out what each command should do in the context
1397 % of @url. for now, just make @/ a no-op, that's the only one
1398 % people have actually reported a problem with.
1400 \normalturnoffactive
1403 \makevalueexpandable
1404 % do we want to go so far as to use \indexnofonts instead of just
1405 % special-casing \var here?
1408 \leavevmode\setcolor{\urlcolor}%
1409 \startlink attr{/Border [0 0 0]}%
1410 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1412 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1413 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1414 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1415 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1417 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1419 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1420 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1421 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1423 \ifnum0=\countA\else\makelink\fi
1424 \ifx\first.\let\next=\done\else
1426 \addtokens{\toksB}{\the\toksD}
1427 \ifx\first,\addtokens{\toksB}{\space}\fi
1429 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1431 \def\makelink{\addtokens{\toksB}%
1432 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1434 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1435 \setcolor{\linkcolor}#1\endlink}
1436 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1439 \let\pdfmkdest = \gobble
1440 \let\pdfurl = \gobble
1441 \let\endlink = \relax
1442 \let\setcolor = \gobble
1443 \let\pdfsetcolor = \gobble
1444 \let\pdfmakeoutlines = \relax
1445 \fi % \ifx\pdfoutput
1450 % Change the current font style to #1, remembering it in \curfontstyle.
1451 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1452 % italics, not bold italics.
1454 \def\setfontstyle#1{%
1455 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1456 \csname ten#1\endcsname % change the current font
1459 % Select #1 fonts with the current style.
1461 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1463 \def\rm{\fam=0 \setfontstyle{rm}}
1464 \def\it{\fam=\itfam \setfontstyle{it}}
1465 \def\sl{\fam=\slfam \setfontstyle{sl}}
1466 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1467 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1469 % Unfortunately, we have to override this for titles and the like, since
1470 % in those cases "rm" is bold. Sigh.
1471 \def\rmisbold{\rm\def\curfontstyle{bf}}
1473 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1474 % So we set up a \sf.
1476 \def\sf{\fam=\sffam \setfontstyle{sf}}
1477 \let\li = \sf % Sometimes we call it \li, not \sf.
1479 % We don't need math for this font style.
1480 \def\ttsl{\setfontstyle{ttsl}}
1484 \newdimen\textleading \textleading = 13.2pt
1486 % Set the baselineskip to #1, and the lineskip and strut size
1487 % correspondingly. There is no deep meaning behind these magic numbers
1488 % used as factors; they just match (closely enough) what Knuth defined.
1490 \def\lineskipfactor{.08333}
1491 \def\strutheightpercent{.70833}
1492 \def\strutdepthpercent {.29167}
1494 % can get a sort of poor man's double spacing by redefining this.
1495 \def\baselinefactor{1}
1499 \normalbaselineskip = \baselinefactor\dimen0
1500 \normallineskip = \lineskipfactor\normalbaselineskip
1502 \setbox\strutbox =\hbox{%
1503 \vrule width0pt height\strutheightpercent\baselineskip
1504 depth \strutdepthpercent \baselineskip
1508 % PDF CMaps. See also LaTeX's t1.cmap.
1510 % do nothing with this by default.
1511 \expandafter\let\csname cmapOT1\endcsname\gobble
1512 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1513 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1515 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1516 % (\pdffontattr was introduced many years ago, but people still run
1517 % older pdftex's; it's easy to conditionalize, so we do.)
1518 \ifpdf \ifx\pdffontattr\undefined \else
1520 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1521 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1522 %%DocumentNeededResources: ProcSet (CIDInit)
1523 %%IncludeResource: ProcSet (CIDInit)
1524 %%BeginResource: CMap (TeX-OT1-0)
1525 %%Title: (TeX-OT1-0 TeX OT1 0)
1528 /CIDInit /ProcSet findresource begin
1536 /CMapName /TeX-OT1-0 def
1538 1 begincodespacerange
1594 CMapName currentdict /CMap defineresource pop
1600 \expandafter\edef\csname cmapOT1\endcsname#1{%
1601 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1606 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1607 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1608 %%DocumentNeededResources: ProcSet (CIDInit)
1609 %%IncludeResource: ProcSet (CIDInit)
1610 %%BeginResource: CMap (TeX-OT1IT-0)
1611 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1614 /CIDInit /ProcSet findresource begin
1622 /CMapName /TeX-OT1IT-0 def
1624 1 begincodespacerange
1682 CMapName currentdict /CMap defineresource pop
1688 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1689 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1694 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1695 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1696 %%DocumentNeededResources: ProcSet (CIDInit)
1697 %%IncludeResource: ProcSet (CIDInit)
1698 %%BeginResource: CMap (TeX-OT1TT-0)
1699 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1702 /CIDInit /ProcSet findresource begin
1710 /CMapName /TeX-OT1TT-0 def
1712 1 begincodespacerange
1757 CMapName currentdict /CMap defineresource pop
1763 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1764 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1769 % Set the font macro #1 to the font named #2, adding on the
1770 % specified font prefix (normally `cm').
1771 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1772 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1774 \def\setfont#1#2#3#4#5{%
1775 \font#1=\fontprefix#2#3 scaled #4
1776 \csname cmap#5\endcsname#1%
1778 % This is what gets called when #5 of \setfont is empty.
1780 % emacs-page end of cmaps
1782 % Use cm as the default font prefix.
1783 % To specify the font prefix, you must define \fontprefix
1784 % before you read in texinfo.tex.
1785 \ifx\fontprefix\undefined
1788 % Support font families that don't use the same naming scheme as CM.
1790 \def\rmbshape{bx} %where the normal face is bold
1795 \def\ttslshape{sltt}
1805 % Definitions for a main text size of 11pt. This is the default in
1808 \def\definetextfontsizexi{%
1809 % Text fonts (11.2pt, magstep1).
1810 \def\textnominalsize{11pt}
1811 \edef\mainmagstep{\magstephalf}
1812 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1813 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1814 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1815 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1816 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1817 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1818 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1819 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1820 \font\texti=cmmi10 scaled \mainmagstep
1821 \font\textsy=cmsy10 scaled \mainmagstep
1822 \def\textecsize{1095}
1824 % A few fonts for @defun names and args.
1825 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1826 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1827 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1828 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1830 % Fonts for indices, footnotes, small examples (9pt).
1831 \def\smallnominalsize{9pt}
1832 \setfont\smallrm\rmshape{9}{1000}{OT1}
1833 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1834 \setfont\smallbf\bfshape{10}{900}{OT1}
1835 \setfont\smallit\itshape{9}{1000}{OT1IT}
1836 \setfont\smallsl\slshape{9}{1000}{OT1}
1837 \setfont\smallsf\sfshape{9}{1000}{OT1}
1838 \setfont\smallsc\scshape{10}{900}{OT1}
1839 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1842 \def\smallecsize{0900}
1844 % Fonts for small examples (8pt).
1845 \def\smallernominalsize{8pt}
1846 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1847 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1848 \setfont\smallerbf\bfshape{10}{800}{OT1}
1849 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1850 \setfont\smallersl\slshape{8}{1000}{OT1}
1851 \setfont\smallersf\sfshape{8}{1000}{OT1}
1852 \setfont\smallersc\scshape{10}{800}{OT1}
1853 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1854 \font\smalleri=cmmi8
1855 \font\smallersy=cmsy8
1856 \def\smallerecsize{0800}
1858 % Fonts for title page (20.4pt):
1859 \def\titlenominalsize{20pt}
1860 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1861 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1862 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1863 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1864 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1865 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1866 \let\titlebf=\titlerm
1867 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1868 \font\titlei=cmmi12 scaled \magstep3
1869 \font\titlesy=cmsy10 scaled \magstep4
1870 \def\titleecsize{2074}
1872 % Chapter (and unnumbered) fonts (17.28pt).
1873 \def\chapnominalsize{17pt}
1874 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1875 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1876 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1877 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1878 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1879 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1881 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1882 \font\chapi=cmmi12 scaled \magstep2
1883 \font\chapsy=cmsy10 scaled \magstep3
1884 \def\chapecsize{1728}
1886 % Section fonts (14.4pt).
1887 \def\secnominalsize{14pt}
1888 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1889 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1890 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1891 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1892 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1893 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1895 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1896 \font\seci=cmmi12 scaled \magstep1
1897 \font\secsy=cmsy10 scaled \magstep2
1898 \def\sececsize{1440}
1900 % Subsection fonts (13.15pt).
1901 \def\ssecnominalsize{13pt}
1902 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1903 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1904 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1905 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1906 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1907 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1909 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1910 \font\sseci=cmmi12 scaled \magstephalf
1911 \font\ssecsy=cmsy10 scaled 1315
1912 \def\ssececsize{1200}
1914 % Reduced fonts for @acro in text (10pt).
1915 \def\reducednominalsize{10pt}
1916 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1917 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1918 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1919 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1920 \setfont\reducedsl\slshape{10}{1000}{OT1}
1921 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1922 \setfont\reducedsc\scshape{10}{1000}{OT1}
1923 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1924 \font\reducedi=cmmi10
1925 \font\reducedsy=cmsy10
1926 \def\reducedecsize{1000}
1928 \textleading = 13.2pt % line spacing for 11pt CM
1929 \textfonts % reset the current fonts
1931 } % end of 11pt text font size definitions
1934 % Definitions to make the main text be 10pt Computer Modern, with
1935 % section, chapter, etc., sizes following suit. This is for the GNU
1936 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1937 % future. Used with @smallbook, which sets the leading to 12pt.
1939 \def\definetextfontsizex{%
1940 % Text fonts (10pt).
1941 \def\textnominalsize{10pt}
1942 \edef\mainmagstep{1000}
1943 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1944 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1945 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1946 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1947 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1948 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1949 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1950 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1951 \font\texti=cmmi10 scaled \mainmagstep
1952 \font\textsy=cmsy10 scaled \mainmagstep
1953 \def\textecsize{1000}
1955 % A few fonts for @defun names and args.
1956 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1957 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1958 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1959 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1961 % Fonts for indices, footnotes, small examples (9pt).
1962 \def\smallnominalsize{9pt}
1963 \setfont\smallrm\rmshape{9}{1000}{OT1}
1964 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1965 \setfont\smallbf\bfshape{10}{900}{OT1}
1966 \setfont\smallit\itshape{9}{1000}{OT1IT}
1967 \setfont\smallsl\slshape{9}{1000}{OT1}
1968 \setfont\smallsf\sfshape{9}{1000}{OT1}
1969 \setfont\smallsc\scshape{10}{900}{OT1}
1970 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1973 \def\smallecsize{0900}
1975 % Fonts for small examples (8pt).
1976 \def\smallernominalsize{8pt}
1977 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1978 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1979 \setfont\smallerbf\bfshape{10}{800}{OT1}
1980 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1981 \setfont\smallersl\slshape{8}{1000}{OT1}
1982 \setfont\smallersf\sfshape{8}{1000}{OT1}
1983 \setfont\smallersc\scshape{10}{800}{OT1}
1984 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1985 \font\smalleri=cmmi8
1986 \font\smallersy=cmsy8
1987 \def\smallerecsize{0800}
1989 % Fonts for title page (20.4pt):
1990 \def\titlenominalsize{20pt}
1991 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1992 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1993 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1994 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1995 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1996 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1997 \let\titlebf=\titlerm
1998 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1999 \font\titlei=cmmi12 scaled \magstep3
2000 \font\titlesy=cmsy10 scaled \magstep4
2001 \def\titleecsize{2074}
2003 % Chapter fonts (14.4pt).
2004 \def\chapnominalsize{14pt}
2005 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2006 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2007 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2008 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2009 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2010 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2012 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2013 \font\chapi=cmmi12 scaled \magstep1
2014 \font\chapsy=cmsy10 scaled \magstep2
2015 \def\chapecsize{1440}
2017 % Section fonts (12pt).
2018 \def\secnominalsize{12pt}
2019 \setfont\secrm\rmbshape{12}{1000}{OT1}
2020 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2021 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2022 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2023 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2024 \setfont\secsf\sfbshape{12}{1000}{OT1}
2026 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2028 \font\secsy=cmsy10 scaled \magstep1
2029 \def\sececsize{1200}
2031 % Subsection fonts (10pt).
2032 \def\ssecnominalsize{10pt}
2033 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2034 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2035 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2036 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2037 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2038 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2040 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2043 \def\ssececsize{1000}
2045 % Reduced fonts for @acro in text (9pt).
2046 \def\reducednominalsize{9pt}
2047 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2048 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2049 \setfont\reducedbf\bfshape{10}{900}{OT1}
2050 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2051 \setfont\reducedsl\slshape{9}{1000}{OT1}
2052 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2053 \setfont\reducedsc\scshape{10}{900}{OT1}
2054 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2055 \font\reducedi=cmmi9
2056 \font\reducedsy=cmsy9
2057 \def\reducedecsize{0900}
2059 \divide\parskip by 2 % reduce space between paragraphs
2060 \textleading = 12pt % line spacing for 10pt CM
2061 \textfonts % reset the current fonts
2063 } % end of 10pt text font size definitions
2066 % We provide the user-level command
2068 % (or 11) to redefine the text font size. pt is assumed.
2074 \parseargdef\fonttextsize{%
2075 \def\textsizearg{#1}%
2076 %\wlog{doing @fonttextsize \textsizearg}%
2078 % Set \globaldefs so that documents can use this inside @tex, since
2079 % makeinfo 4.8 does not support it, but we need it nonetheless.
2081 \begingroup \globaldefs=1
2082 \ifx\textsizearg\xword \definetextfontsizex
2083 \else \ifx\textsizearg\xiword \definetextfontsizexi
2086 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2092 % In order for the font changes to affect most math symbols and letters,
2093 % we have to define the \textfont of the standard families. Since
2094 % texinfo doesn't allow for producing subscripts and superscripts except
2095 % in the main text, we don't bother to reset \scriptfont and
2096 % \scriptscriptfont (which would also require loading a lot more fonts).
2098 \def\resetmathfonts{%
2099 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2100 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2101 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2104 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2105 % of just \STYLE. We do this because \STYLE needs to also set the
2106 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2107 % \tenSTYLE to set the current font.
2109 % Each font-changing command also sets the names \lsize (one size lower)
2110 % and \lllsize (three sizes lower). These relative commands are used in
2111 % the LaTeX logo and acronyms.
2113 % This all needs generalizing, badly.
2116 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2117 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2118 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2119 \let\tenttsl=\textttsl
2120 \def\curfontsize{text}%
2121 \def\lsize{reduced}\def\lllsize{smaller}%
2122 \resetmathfonts \setleading{\textleading}}
2124 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2125 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2126 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2127 \let\tenttsl=\titlettsl
2128 \def\curfontsize{title}%
2129 \def\lsize{chap}\def\lllsize{subsec}%
2130 \resetmathfonts \setleading{27pt}}
2131 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2133 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2134 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2135 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2136 \let\tenttsl=\chapttsl
2137 \def\curfontsize{chap}%
2138 \def\lsize{sec}\def\lllsize{text}%
2139 \resetmathfonts \setleading{19pt}}
2141 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2142 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2143 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2144 \let\tenttsl=\secttsl
2145 \def\curfontsize{sec}%
2146 \def\lsize{subsec}\def\lllsize{reduced}%
2147 \resetmathfonts \setleading{16pt}}
2149 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2150 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2151 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2152 \let\tenttsl=\ssecttsl
2153 \def\curfontsize{ssec}%
2154 \def\lsize{text}\def\lllsize{small}%
2155 \resetmathfonts \setleading{15pt}}
2156 \let\subsubsecfonts = \subsecfonts
2158 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2159 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2160 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2161 \let\tenttsl=\reducedttsl
2162 \def\curfontsize{reduced}%
2163 \def\lsize{small}\def\lllsize{smaller}%
2164 \resetmathfonts \setleading{10.5pt}}
2166 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2167 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2168 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2169 \let\tenttsl=\smallttsl
2170 \def\curfontsize{small}%
2171 \def\lsize{smaller}\def\lllsize{smaller}%
2172 \resetmathfonts \setleading{10.5pt}}
2174 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2175 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2176 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2177 \let\tenttsl=\smallerttsl
2178 \def\curfontsize{smaller}%
2179 \def\lsize{smaller}\def\lllsize{smaller}%
2180 \resetmathfonts \setleading{9.5pt}}
2182 % Fonts for short table of contents.
2183 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2184 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2185 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2186 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2188 % Define these just so they can be easily changed for other fonts.
2189 \def\angleleft{$\langle$}
2190 \def\angleright{$\rangle$}
2192 % Set the fonts to use with the @small... environments.
2193 \let\smallexamplefonts = \smallfonts
2195 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2196 % can fit this many characters:
2197 % 8.5x11=86 smallbook=72 a4=90 a5=69
2198 % If we use \scriptfonts (8pt), then we can fit this many characters:
2199 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2200 % For me, subjectively, the few extra characters that fit aren't worth
2201 % the additional smallness of 8pt. So I'm making the default 9pt.
2203 % By the way, for comparison, here's what fits with @example (10pt):
2204 % 8.5x11=71 smallbook=60 a4=75 a5=58
2207 % Set up the default fonts, so we can use them for creating boxes.
2209 \definetextfontsizexi
2214 % Check if we are currently using a typewriter font. Since all the
2215 % Computer Modern typewriter fonts have zero interword stretch (and
2216 % shrink), and it is reasonable to expect all typewriter fonts to have
2217 % this property, we can check that font parameter.
2219 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2221 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2222 % define and register \INITMACRO to be called on markup style changes.
2223 % \INITMACRO can check \currentmarkupstyle for the innermost
2224 % style and the set of \ifmarkupSTYLE switches for all styles
2225 % currently in effect.
2229 %\newif\ifmarkupfile % @file == @samp.
2230 %\newif\ifmarkupoption % @option == @samp.
2233 %\newif\ifmarkupenv % @env == @code.
2234 %\newif\ifmarkupcommand % @command == @code.
2235 \newif\ifmarkuptex % @tex (and part of @math, for now).
2236 \newif\ifmarkupexample
2238 \newif\ifmarkupverbatim
2240 \let\currentmarkupstyle\empty
2242 \def\setupmarkupstyle#1{%
2243 \csname markup#1true\endcsname
2244 \def\currentmarkupstyle{#1}%
2248 \let\markupstylesetup\empty
2250 \def\defmarkupstylesetup#1{%
2251 \expandafter\def\expandafter\markupstylesetup
2252 \expandafter{\markupstylesetup #1}%
2256 % Markup style setup for left and right quotes.
2257 \defmarkupstylesetup\markupsetuplq{%
2258 \expandafter\let\expandafter \temp
2259 \csname markupsetuplq\currentmarkupstyle\endcsname
2260 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2263 \defmarkupstylesetup\markupsetuprq{%
2264 \expandafter\let\expandafter \temp
2265 \csname markupsetuprq\currentmarkupstyle\endcsname
2266 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2273 \gdef\markupsetuplqdefault{\let`\lq}
2274 \gdef\markupsetuprqdefault{\let'\rq}
2276 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2277 \gdef\markupsetcodequoteright{\let'\codequoteright}
2279 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2282 \let\markupsetuplqcode \markupsetcodequoteleft
2283 \let\markupsetuprqcode \markupsetcodequoteright
2285 \let\markupsetuplqexample \markupsetcodequoteleft
2286 \let\markupsetuprqexample \markupsetcodequoteright
2288 \let\markupsetuplqsamp \markupsetcodequoteleft
2289 \let\markupsetuprqsamp \markupsetcodequoteright
2291 \let\markupsetuplqverb \markupsetcodequoteleft
2292 \let\markupsetuprqverb \markupsetcodequoteright
2294 \let\markupsetuplqverbatim \markupsetcodequoteleft
2295 \let\markupsetuprqverbatim \markupsetcodequoteright
2297 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2299 % Allow an option to not replace quotes with a regular directed right
2300 % quote/apostrophe (char 0x27), but instead use the undirected quote
2301 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2302 % the default, but it works for pasting with more pdf viewers (at least
2303 % evince), the lilypond developers report. xpdf does work with the
2306 \def\codequoteright{%
2307 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2308 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2314 % and a similar option for the left quote char vs. a grave accent.
2315 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2316 % the code environments to do likewise.
2318 \def\codequoteleft{%
2319 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2320 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2321 % [Knuth] pp. 380,381,391
2322 % \relax disables Spanish ligatures ?` and !` of \tt font.
2328 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2329 \def\noligaturesquoteleft{\relax\lq}
2331 % Count depth in font-changes, for error checks
2332 \newcount\fontdepth \fontdepth=0
2336 % #1 is the font command (\sl or \it), #2 is the text to slant.
2337 % If we are in a monospaced environment, however, 1) always use \ttsl,
2338 % and 2) do not add an italic correction.
2339 \def\dosmartslant#1#2{%
2341 {{\ttsl #2}\let\next=\relax}%
2342 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2345 \def\smartslanted{\dosmartslant\sl}
2346 \def\smartitalic{\dosmartslant\it}
2348 % Output an italic correction unless \next (presumed to be the following
2349 % character) is such as not to need one.
2350 \def\smartitaliccorrection{%
2357 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2358 % @var is set to this for defun arguments.
2359 \def\ttslanted#1{{\ttsl #1}}
2361 % @cite is like \smartslanted except unconditionally use \sl. We never want
2362 % ttsl for book titles, do we?
2363 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2366 \let\slanted=\smartslanted
2367 \def\var#1{\smartslanted{#1}}
2368 \let\dfn=\smartslanted
2369 \let\emph=\smartitalic
2371 % Explicit font changes: @r, @sc, undocumented @ii.
2372 \def\r#1{{\rm #1}} % roman font
2373 \def\sc#1{{\smallcaps#1}} % smallcaps font
2374 \def\ii#1{{\it #1}} % italic font
2376 % @b, explicit bold. Also @strong.
2380 % @sansserif, explicit sans.
2381 \def\sansserif#1{{\sf #1}}
2383 % We can't just use \exhyphenpenalty, because that only has effect at
2384 % the end of a paragraph. Restore normal hyphenation at the end of the
2385 % group within which \nohyphenation is presumably called.
2387 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2388 \def\restorehyphenation{\hyphenchar\font = `- }
2390 % Set sfcode to normal for the chars that usually have another value.
2391 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2392 % sometimes \x has an active definition that messes things up.
2395 \def\plainfrenchspacing{%
2396 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2397 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2398 \def\endofsentencespacefactor{1000}% for @. and friends
2400 \def\plainnonfrenchspacing{%
2401 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2402 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2403 \def\endofsentencespacefactor{3000}% for @. and friends
2406 \def\endofsentencespacefactor{3000}% default
2408 % @t, explicit typewriter.
2410 {\tt \rawbackslash \plainfrenchspacing #1}%
2415 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2417 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2418 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2420 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2421 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2422 % \vbox{\hrule\kern-0.4pt
2423 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2424 % \kern-0.4pt\hrule}%
2425 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2427 % definition of @key with no lozenge. If the current font is already
2428 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2429 % if it isn't monospace, then use \tt.
2431 \def\key#1{{\setupmarkupstyle{key}%
2433 \ifmonospace\else\tt\fi
2436 % ctrl is no longer a Texinfo command.
2437 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2439 % @file, @option are the same as @samp.
2443 % @code is a modification of @t,
2444 % which makes spaces the same size as normal in the surrounding text.
2447 % Change normal interword space to be same as for the current font.
2448 \spaceskip = \fontdimen2\font
2450 % Switch to typewriter.
2453 % But `\ ' produces the large typewriter interword space.
2454 \def\ {{\spaceskip = 0pt{} }}%
2456 % Turn off hyphenation.
2466 % We *must* turn on hyphenation at `-' and `_' in @code.
2467 % Otherwise, it is too hard to avoid overfull hboxes
2468 % in the Emacs manual, the Library manual, etc.
2470 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2471 % both hyphenation at - and hyphenation within words.
2472 % We must therefore turn them both off (\tclose does that)
2473 % and arrange explicitly to hyphenate at a dash.
2476 \catcode`\-=\active \catcode`\_=\active
2477 \catcode`\'=\active \catcode`\`=\active
2478 \global\let'=\rq \global\let`=\lq % default definitions
2480 \global\def\code{\begingroup
2481 \setupmarkupstyle{code}%
2482 % The following should really be moved into \setupmarkupstyle handlers.
2483 \catcode\dashChar=\active \catcode\underChar=\active
2494 % Handle @url similarly to \code, but allows line breaks after .#?/ (only).
2496 \catcode`\.=\active \catcode`\#=\active
2497 \catcode`\?=\active \catcode`\/=\active
2499 \global\def\urefcode{\begingroup
2500 \setupmarkupstyle{code}%
2501 \catcode\dotChar=\active \catcode\hashChar=\active
2502 \catcode\questChar=\active \catcode\slashChar=\active
2505 \let?\urefcodequestion
2512 \def\codedash{-\discretionary{}{}{}}
2514 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2515 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2516 % will therefore expand the active definition of _, which is us
2517 % (inside @code that is), therefore an endless loop.
2519 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2520 \else\normalunderscore \fi
2521 \discretionary{}{}{}}%
2524 % we put a little stretch before and after the breakable chars, to help
2525 % line breaking of long url's. The unequal skips make look better in
2526 % cmtt at least, especially for dots.
2527 \def\urefprestretch{\nobreak \hskip0pt plus.13em }
2528 \def\urefpoststretch{\allowbreak \hskip0pt plus.1em }
2529 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2530 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2531 \def\urefcodequestion{\urefprestretch ?\urefpoststretch}
2532 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2535 \global\def\urefcodeslashfinish{%
2536 \urefprestretch \slashChar
2537 % Allow line break only after the final / in a sequence of
2538 % slashes, to avoid line break between the slashes in http://.
2539 \ifx\next/\else \urefpoststretch \fi
2542 \def\codex #1{\tclose{#1}\endgroup}
2544 % An additional complication: the above will allow breaks after, e.g.,
2545 % each of the four underscores in __typeof__. This is undesirable in
2546 % some manuals, especially if they don't have long identifiers in
2547 % general. @allowcodebreaks provides a way to control this.
2549 \newif\ifallowcodebreaks \allowcodebreakstrue
2551 \def\keywordtrue{true}
2552 \def\keywordfalse{false}
2554 \parseargdef\allowcodebreaks{%
2556 \ifx\txiarg\keywordtrue
2557 \allowcodebreakstrue
2558 \else\ifx\txiarg\keywordfalse
2559 \allowcodebreaksfalse
2561 \errhelp = \EMsimple
2562 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2566 % @kbd is like @code, except that if the argument is just one @key command,
2567 % then @kbd has no effect.
2568 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2570 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2571 % `example' (@kbd uses ttsl only inside of @example and friends),
2572 % or `code' (@kbd uses normal tty font always).
2573 \parseargdef\kbdinputstyle{%
2575 \ifx\txiarg\worddistinct
2576 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2577 \else\ifx\txiarg\wordexample
2578 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2579 \else\ifx\txiarg\wordcode
2580 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2582 \errhelp = \EMsimple
2583 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2586 \def\worddistinct{distinct}
2587 \def\wordexample{example}
2590 % Default is `distinct'.
2591 \kbdinputstyle distinct
2594 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2595 \ifx\one\xkey\ifx\threex\three \key{#2}%
2596 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2597 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2599 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2600 \let\indicateurl=\code
2604 % @clicksequence{File @click{} Open ...}
2605 \def\clicksequence#1{\begingroup #1\endgroup}
2607 % @clickstyle @arrow (by default)
2608 \parseargdef\clickstyle{\def\click{#1}}
2611 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2612 % second argument specifying the text to display and an optional third
2613 % arg as text to display instead of (rather than in addition to) the url
2614 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2615 % a hypertex \special here.
2617 \def\uref#1{\douref #1,,,\finish}
2618 \def\douref#1,#2,#3,#4\finish{\begingroup
2621 \setbox0 = \hbox{\ignorespaces #3}%
2623 \unhbox0 % third arg given, show only that
2625 \setbox0 = \hbox{\ignorespaces #2}%
2628 \unhbox0 % PDF: 2nd arg given, show only it
2630 % \empty at the end of \scantokens arg gets rid of
2631 % trailing newline (and ultimate spurious whitespace).
2632 \unhbox0\ (\urefcode{\scantokens{#1\empty}})% DVI: 2nd arg given,
2633 % show both it and url
2636 \urefcode{\scantokens{#1\empty}}% only url given, so show it
2642 % @url synonym for @uref, since that's how everyone uses it.
2646 % rms does not like angle brackets --karl, 17may97.
2647 % So now @email is just like @uref, unless we are pdf.
2649 %\def\email#1{\angleleft{\tt #1}\angleright}
2651 \def\email#1{\doemail#1,,\finish}
2652 \def\doemail#1,#2,#3\finish{\begingroup
2655 \setbox0 = \hbox{\ignorespaces #2}%
2656 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2663 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2664 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2666 \def\dmn#1{\thinspace #1}
2668 % @l was never documented to mean ``switch to the Lisp font'',
2669 % and it is not used as such in any manual I can find. We need it for
2670 % Polish suppressed-l. --karl, 22sep96.
2671 %\def\l#1{{\li #1}\null}
2673 % @acronym for "FBI", "NATO", and the like.
2674 % We print this one point size smaller, since it's intended for
2677 \def\acronym#1{\doacronym #1,,\finish}
2678 \def\doacronym#1,#2,#3\finish{%
2679 {\selectfonts\lsize #1}%
2681 \ifx\temp\empty \else
2682 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2686 % @abbr for "Comput. J." and the like.
2687 % No font change, but don't do end-of-sentence spacing.
2689 \def\abbr#1{\doabbr #1,,\finish}
2690 \def\doabbr#1,#2,#3\finish{%
2691 {\plainfrenchspacing #1}%
2693 \ifx\temp\empty \else
2694 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2698 % @asis just yields its argument. Used with @table, for example.
2702 % @math outputs its argument in math mode.
2704 % One complication: _ usually means subscripts, but it could also mean
2705 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2706 % _ active, and distinguish by seeing if the current family is \slfam,
2707 % which is what @var uses.
2709 \catcode`\_ = \active
2710 \gdef\mathunderscore{%
2712 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2715 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2716 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2717 % particular reason), but this is not advertised and we don't care.
2719 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2720 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2725 \let\\ = \mathbackslash
2727 % make the texinfo accent commands work in math mode
2739 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2741 % Some active characters (such as <) are spaced differently in math.
2742 % We have to reset their definitions in case the @math was an argument
2743 % to a command which sets the catcodes (such as @item or @section).
2746 \catcode`^ = \active
2747 \catcode`< = \active
2748 \catcode`> = \active
2749 \catcode`+ = \active
2750 \catcode`' = \active
2756 \let' = \ptexquoteright
2767 % Used to generate quoted braces. Unless we're in typewriter, use
2768 % \ecfont because the CM text fonts do not have braces, and we don't
2769 % want to switch into math.
2770 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2771 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2775 % Definitions to produce \{ and \} commands for indices,
2776 % and @{ and @} for the aux/toc files.
2777 \catcode`\{ = \other \catcode`\} = \other
2778 \catcode`\[ = 1 \catcode`\] = 2
2779 \catcode`\! = 0 \catcode`\\ = \other
2780 !gdef!lbracecmd[\{]%
2781 !gdef!rbracecmd[\}]%
2782 !gdef!lbraceatcmd[@{]%
2783 !gdef!rbraceatcmd[@}]%
2786 % @comma{} to avoid , parsing problems.
2789 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2790 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2792 \let\dotaccent = \ptexdot
2793 \def\ringaccent#1{{\accent23 #1}}
2794 \let\tieaccent = \ptext
2795 \let\ubaraccent = \ptexb
2796 \let\udotaccent = \d
2798 % Other special characters: @questiondown @exclamdown @ordf @ordm
2799 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2800 \def\questiondown{?`}
2802 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2803 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2805 % Dotless i and dotless j, used for accents.
2810 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2811 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2812 \else \errmessage{@dotless can be used only with i or j}%
2816 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2817 % period following counts as ending a sentence. (Idea found in latex.)
2819 \edef\TeX{\TeX \spacefactor=1000 }
2821 % @LaTeX{} logo. Not quite the same results as the definition in
2822 % latex.ltx, since we use a different font for the raised A; it's most
2823 % convenient for us to use an explicitly smaller font, rather than using
2824 % the \scriptstyle font (since we don't reset \scriptstyle and
2825 % \scriptscriptstyle).
2830 \vbox to \ht0{\hbox{%
2831 \ifx\textnominalsize\xwordpt
2832 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2833 % Revert to plain's \scriptsize, which is 7pt.
2834 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2836 % For 11pt, we can use our lllsize.
2837 \selectfonts\lllsize A%
2846 % Some math mode symbols.
2847 \def\bullet{$\ptexbullet$}
2848 \def\geq{\ifmmode \ge\else $\ge$\fi}
2849 \def\leq{\ifmmode \le\else $\le$\fi}
2850 \def\minus{\ifmmode -\else $-$\fi}
2852 % @dots{} outputs an ellipsis using the current font.
2853 % We do .5em per period so that it has the same spacing in the cm
2854 % typewriter fonts as three actual period characters; on the other hand,
2855 % in other typewriter fonts three periods are wider than 1.5em. So do
2856 % whichever is larger.
2860 \setbox0=\hbox{...}% get width of three periods
2867 \hskip 0pt plus.25fil
2868 .\hskip 0pt plus1fil
2869 .\hskip 0pt plus1fil
2870 .\hskip 0pt plus.5fil
2874 % @enddots{} is an end-of-sentence ellipsis.
2878 \spacefactor=\endofsentencespacefactor
2881 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2883 % Since these characters are used in examples, they should be an even number of
2884 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2887 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2888 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2889 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2890 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2891 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2893 % The @error{} command.
2894 % Adapted from the TeXbook's \boxit.
2898 {\tentt \global\dimen0 = 3em}% Width of the box.
2899 \dimen2 = .55pt % Thickness of rules
2900 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2901 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2903 \setbox\errorbox=\hbox to \dimen0{\hfil
2904 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2905 \advance\hsize by -2\dimen2 % Rules.
2907 \hrule height\dimen2
2908 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2909 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2910 \kern3pt\vrule width\dimen2}% Space to right.
2911 \hrule height\dimen2}
2914 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2916 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2918 \def\pounds{{\it\$}}
2920 % @euro{} comes from a separate font, depending on the current style.
2921 % We use the free feym* fonts from the eurosym package by Henrik
2922 % Theiling, which support regular, slanted, bold and bold slanted (and
2923 % "outlined" (blackboard board, sort of) versions, which we don't need).
2924 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2926 % Although only regular is the truly official Euro symbol, we ignore
2927 % that. The Euro is designed to be slightly taller than the regular
2933 % feybo - bold slanted
2935 % There is no good (free) typewriter version, to my knowledge.
2936 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2939 % Also doesn't work in math. Do we need to do math with euro symbols?
2943 \def\euro{{\eurofont e}}
2945 % We set the font at each command, rather than predefining it in
2946 % \textfonts and the other font-switching commands, so that
2947 % installations which never need the symbol don't have to have the
2950 % There is only one designed size (nominal 10pt), so we always scale
2951 % that to the current nominal size.
2953 % By the way, simply using "at 1em" works for cmr10 and the like, but
2954 % does not work for cmbx10 and other extended/shrunken fonts.
2956 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2958 \ifx\curfontstyle\bfstylename
2960 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2963 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2968 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2969 % sometimes we redefine the original macro, and the alias should reflect
2972 % Use LaTeX names for the Icelandic letters.
2973 \def\DH{{\ecfont \char"D0}} % Eth
2974 \def\dh{{\ecfont \char"F0}} % eth
2975 \def\TH{{\ecfont \char"DE}} % Thorn
2976 \def\th{{\ecfont \char"FE}} % thorn
2978 \def\guillemetleft{{\ecfont \char"13}}
2979 \def\guillemotleft{\guillemetleft}
2980 \def\guillemetright{{\ecfont \char"14}}
2981 \def\guillemotright{\guillemetright}
2982 \def\guilsinglleft{{\ecfont \char"0E}}
2983 \def\guilsinglright{{\ecfont \char"0F}}
2984 \def\quotedblbase{{\ecfont \char"12}}
2985 \def\quotesinglbase{{\ecfont \char"0D}}
2987 % This positioning is not perfect (see the ogonek LaTeX package), but
2988 % we have the precomposed glyphs for the most common cases. We put the
2989 % tests to use those glyphs in the single \ogonek macro so we have fewer
2990 % dummy definitions to worry about for index entries, etc.
2992 % ogonek is also used with other letters in Lithuanian (IOU), but using
2993 % the precomposed glyphs for those is not so easy since they aren't in
2997 \ifx\temp\macrocharA\Aogonek
2998 \else\ifx\temp\macrochara\aogonek
2999 \else\ifx\temp\macrocharE\Eogonek
3000 \else\ifx\temp\macrochare\eogonek
3002 \ecfont \setbox0=\hbox{#1}%
3003 \ifdim\ht0=1ex\accent"0C #1%
3004 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3009 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3010 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3011 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3012 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3014 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3016 % We can't distinguish serif/sans and italic/slanted, but this
3017 % is used for crude hacks anyway (like adding French and German
3018 % quotes to documents typeset with CM, where we lose kerning), so
3019 % hopefully nobody will notice/care.
3020 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3021 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3022 \ifx\curfontstyle\bfstylename
3024 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3027 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3032 % @registeredsymbol - R in a circle. The font for the R should really
3033 % be smaller yet, but lllsize is the best we can do for now.
3034 % Adapted from the plain.tex definition of \copyright.
3036 \def\registeredsymbol{%
3037 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3042 % @textdegree - the normal degrees sign.
3044 \def\textdegree{$^\circ$}
3046 % Laurent Siebenmann reports \Orb undefined with:
3047 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3048 % so we'll define it if necessary.
3051 \def\Orb{\mathhexbox20D}
3055 \chardef\quotedblleft="5C
3056 \chardef\quotedblright=`\"
3057 \chardef\quoteleft=`\`
3058 \chardef\quoteright=`\'
3061 \message{page headings,}
3063 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3064 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3066 % First the title page. Must do @settitle before @titlepage.
3068 \newif\iffinishedtitlepage
3070 % Do an implicit @contents or @shortcontents after @end titlepage if the
3071 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3073 \newif\ifsetcontentsaftertitlepage
3074 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3075 \newif\ifsetshortcontentsaftertitlepage
3076 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3078 \parseargdef\shorttitlepage{%
3079 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3080 \endgroup\page\hbox{}\page}
3083 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3085 \parindent=0pt \textfonts
3086 % Leave some space at the very top of the page.
3087 \vglue\titlepagetopglue
3088 % No rule at page bottom unless we print one at the top with @title.
3089 \finishedtitlepagetrue
3091 % Most title ``pages'' are actually two pages long, with space
3092 % at the top of the second. We don't want the ragged left on the second.
3093 \let\oldpage = \page
3095 \iffinishedtitlepage\else
3098 \let\page = \oldpage
3105 \iffinishedtitlepage\else
3108 % It is important to do the page break before ending the group,
3109 % because the headline and footline are only empty inside the group.
3110 % If we use the new definition of \page, we always get a blank page
3111 % after the title page, which we certainly don't want.
3115 % Need this before the \...aftertitlepage checks so that if they are
3116 % in effect the toc pages will come out with page numbers.
3119 % If they want short, they certainly want long too.
3120 \ifsetshortcontentsaftertitlepage
3123 \global\let\shortcontents = \relax
3124 \global\let\contents = \relax
3127 \ifsetcontentsaftertitlepage
3129 \global\let\contents = \relax
3130 \global\let\shortcontents = \relax
3134 \def\finishtitlepage{%
3135 \vskip4pt \hrule height 2pt width \hsize
3136 \vskip\titlepagebottomglue
3137 \finishedtitlepagetrue
3140 %%% Macros to be used within @titlepage:
3142 \let\subtitlerm=\tenrm
3143 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3145 \parseargdef\title{%
3147 \leftline{\titlefonts\rmisbold #1}
3148 % print a rule at the page bottom also.
3149 \finishedtitlepagefalse
3150 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3153 \parseargdef\subtitle{%
3155 {\subtitlefont \rightline{#1}}%
3158 % @author should come last, but may come many times.
3159 % It can also be used inside @quotation.
3161 \parseargdef\author{%
3162 \def\temp{\quotation}%
3164 \def\quotationauthor{#1}% printed in \Equotation.
3167 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3168 {\secfonts\rmisbold \leftline{#1}}%
3173 %%% Set up page headings and footings.
3175 \let\thispage=\folio
3177 \newtoks\evenheadline % headline on even pages
3178 \newtoks\oddheadline % headline on odd pages
3179 \newtoks\evenfootline % footline on even pages
3180 \newtoks\oddfootline % footline on odd pages
3182 % Now make TeX use those variables
3183 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3184 \else \the\evenheadline \fi}}
3185 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3186 \else \the\evenfootline \fi}\HEADINGShook}
3187 \let\HEADINGShook=\relax
3189 % Commands to set those variables.
3190 % For example, this is what @headings on does
3191 % @evenheading @thistitle|@thispage|@thischapter
3192 % @oddheading @thischapter|@thispage|@thistitle
3193 % @evenfooting @thisfile||
3194 % @oddfooting ||@thisfile
3197 \def\evenheading{\parsearg\evenheadingxxx}
3198 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3199 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3200 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3202 \def\oddheading{\parsearg\oddheadingxxx}
3203 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3204 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3205 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3207 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3209 \def\evenfooting{\parsearg\evenfootingxxx}
3210 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3211 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3212 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3214 \def\oddfooting{\parsearg\oddfootingxxx}
3215 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3216 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3217 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3219 % Leave some space for the footline. Hopefully ok to assume
3220 % @evenfooting will not be used by itself.
3221 \global\advance\pageheight by -12pt
3222 \global\advance\vsize by -12pt
3225 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3227 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3228 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3230 % The same set of arguments for:
3235 % @everyheadingmarks
3236 % @everyfootingmarks
3238 \def\evenheadingmarks{\headingmarks{even}{heading}}
3239 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3240 \def\evenfootingmarks{\headingmarks{even}{footing}}
3241 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3242 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3243 \headingmarks{odd}{heading}{#1} }
3244 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3245 \headingmarks{odd}{footing}{#1} }
3246 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3247 \def\headingmarks#1#2#3 {%
3248 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3249 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3252 \everyheadingmarks bottom
3253 \everyfootingmarks bottom
3255 % @headings double turns headings on for double-sided printing.
3256 % @headings single turns headings on for single-sided printing.
3257 % @headings off turns them off.
3258 % @headings on same as @headings double, retained for compatibility.
3259 % @headings after turns on double-sided headings after this page.
3260 % @headings doubleafter turns on double-sided headings after this page.
3261 % @headings singleafter turns on single-sided headings after this page.
3262 % By default, they are off at the start of a document,
3263 % and turned `on' after @end titlepage.
3265 \def\headings #1 {\csname HEADINGS#1\endcsname}
3267 \def\headingsoff{% non-global headings elimination
3268 \evenheadline={\hfil}\evenfootline={\hfil}%
3269 \oddheadline={\hfil}\oddfootline={\hfil}%
3272 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3273 \HEADINGSoff % it's the default
3275 % When we turn headings on, set the page number to 1.
3276 % For double-sided printing, put current file name in lower left corner,
3277 % chapter name on inside top of right hand pages, document
3278 % title on inside top of left hand pages, and page numbers on outside top
3279 % edge of all pages.
3280 \def\HEADINGSdouble{%
3282 \global\evenfootline={\hfil}
3283 \global\oddfootline={\hfil}
3284 \global\evenheadline={\line{\folio\hfil\thistitle}}
3285 \global\oddheadline={\line{\thischapter\hfil\folio}}
3286 \global\let\contentsalignmacro = \chapoddpage
3288 \let\contentsalignmacro = \chappager
3290 % For single-sided printing, chapter title goes across top left of page,
3291 % page number on top right.
3292 \def\HEADINGSsingle{%
3294 \global\evenfootline={\hfil}
3295 \global\oddfootline={\hfil}
3296 \global\evenheadline={\line{\thischapter\hfil\folio}}
3297 \global\oddheadline={\line{\thischapter\hfil\folio}}
3298 \global\let\contentsalignmacro = \chappager
3300 \def\HEADINGSon{\HEADINGSdouble}
3302 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3303 \let\HEADINGSdoubleafter=\HEADINGSafter
3304 \def\HEADINGSdoublex{%
3305 \global\evenfootline={\hfil}
3306 \global\oddfootline={\hfil}
3307 \global\evenheadline={\line{\folio\hfil\thistitle}}
3308 \global\oddheadline={\line{\thischapter\hfil\folio}}
3309 \global\let\contentsalignmacro = \chapoddpage
3312 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3313 \def\HEADINGSsinglex{%
3314 \global\evenfootline={\hfil}
3315 \global\oddfootline={\hfil}
3316 \global\evenheadline={\line{\thischapter\hfil\folio}}
3317 \global\oddheadline={\line{\thischapter\hfil\folio}}
3318 \global\let\contentsalignmacro = \chappager
3321 % Subroutines used in generating headings
3322 % This produces Day Month Year style of output.
3323 % Only define if not already defined, in case a txi-??.tex file has set
3324 % up a different format (e.g., txi-cs.tex does this).
3325 \ifx\today\undefined
3329 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3330 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3331 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3336 % @settitle line... specifies the title of the document, for headings.
3337 % It generates no output of its own.
3338 \def\thistitle{\putwordNoTitle}
3339 \def\settitle{\parsearg{\gdef\thistitle}}
3343 % Tables -- @table, @ftable, @vtable, @item(x).
3345 % default indentation of table text
3346 \newdimen\tableindent \tableindent=.8in
3347 % default indentation of @itemize and @enumerate text
3348 \newdimen\itemindent \itemindent=.3in
3349 % margin between end of table item and start of table text.
3350 \newdimen\itemmargin \itemmargin=.1in
3352 % used internally for \itemindent minus \itemmargin
3355 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3357 % They also define \itemindex
3358 % to index the item name in whatever manner is desired (perhaps none).
3360 \newif\ifitemxneedsnegativevskip
3362 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3364 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3365 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3367 \def\itemzzz #1{\begingroup %
3368 \advance\hsize by -\rightskip
3369 \advance\hsize by -\tableindent
3370 \setbox0=\hbox{\itemindicate{#1}}%
3372 \nobreak % This prevents a break before @itemx.
3374 % If the item text does not fit in the space we have, put it on a line
3375 % by itself, and do not allow a page break either before or after that
3376 % line. We do not start a paragraph here because then if the next
3377 % command is, e.g., @kindex, the whatsit would get put into the
3378 % horizontal list on a line by itself, resulting in extra blank space.
3379 \ifdim \wd0>\itemmax
3381 % Make this a paragraph so we get the \parskip glue and wrapping,
3382 % but leave it ragged-right.
3384 \advance\leftskip by-\tableindent
3385 \advance\hsize by\tableindent
3386 \advance\rightskip by0pt plus1fil\relax
3387 \leavevmode\unhbox0\par
3390 % We're going to be starting a paragraph, but we don't want the
3391 % \parskip glue -- logically it's part of the @item we just started.
3392 \nobreak \vskip-\parskip
3394 % Stop a page break at the \parskip glue coming up. However, if
3395 % what follows is an environment such as @example, there will be no
3396 % \parskip glue; then the negative vskip we just inserted would
3397 % cause the example and the item to crash together. So we use this
3398 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3399 % \parskip glue after all. Section titles are handled this way also.
3403 \itemxneedsnegativevskipfalse
3405 % The item text fits into the space. Start a paragraph, so that the
3406 % following text (if any) will end up on the same line.
3408 % Do this with kerns and \unhbox so that if there is a footnote in
3409 % the item text, it can migrate to the main vertical list and
3410 % eventually be printed.
3411 \nobreak\kern-\tableindent
3412 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3414 \nobreak\kern\dimen0
3416 \itemxneedsnegativevskiptrue
3420 \def\item{\errmessage{@item while not in a list environment}}
3421 \def\itemx{\errmessage{@itemx while not in a list environment}}
3423 % @table, @ftable, @vtable.
3425 \let\itemindex\gobble
3429 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3430 \tablecheck{ftable}%
3433 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3434 \tablecheck{vtable}%
3437 \ifnum \the\catcode`\^^M=\active
3439 \errmessage{This command won't work in this context; perhaps the problem is
3440 that we are \inenvironment\thisenv}%
3441 \def\next{\doignore{#1}}%
3448 \def\itemindicate{#1}%
3453 \makevalueexpandable
3454 \edef\temp{\noexpand\tablez #1\space\space\space}%
3458 \def\tablez #1 #2 #3 #4\endtablez{%
3460 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3461 \ifnum 0#2>0 \tableindent=#2\mil \fi
3462 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3463 \itemmax=\tableindent
3464 \advance \itemmax by -\itemmargin
3465 \advance \leftskip by \tableindent
3466 \exdentamount=\tableindent
3468 \parskip = \smallskipamount
3469 \ifdim \parskip=0pt \parskip=2pt \fi
3470 \let\item = \internalBitem
3471 \let\itemx = \internalBitemx
3473 \def\Etable{\endgraf\afterenvbreak}
3476 \let\Eitemize\Etable
3477 \let\Eenumerate\Etable
3479 % This is the counter used by @enumerate, which is really @itemize
3483 \envdef\itemize{\parsearg\doitemize}
3487 \itemmax=\itemindent
3488 \advance\itemmax by -\itemmargin
3489 \advance\leftskip by \itemindent
3490 \exdentamount=\itemindent
3492 \parskip=\smallskipamount
3493 \ifdim\parskip=0pt \parskip=2pt \fi
3495 % Try typesetting the item mark that if the document erroneously says
3496 % something like @itemize @samp (intending @table), there's an error
3497 % right away at the @itemize. It's not the best error message in the
3498 % world, but it's better than leaving it to the @item. This means if
3499 % the user wants an empty mark, they have to say @w{} not just @w.
3500 \def\itemcontents{#1}%
3501 \setbox0 = \hbox{\itemcontents}%
3503 % @itemize with no arg is equivalent to @itemize @bullet.
3504 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3506 \let\item=\itemizeitem
3509 % Definition of @item while inside @itemize and @enumerate.
3512 \advance\itemno by 1 % for enumerations
3513 {\let\par=\endgraf \smallbreak}% reasonable place to break
3515 % If the document has an @itemize directly after a section title, a
3516 % \nobreak will be last on the list, and \sectionheading will have
3517 % done a \vskip-\parskip. In that case, we don't want to zero
3518 % parskip, or the item text will crash with the heading. On the
3519 % other hand, when there is normal text preceding the item (as there
3520 % usually is), we do want to zero parskip, or there would be too much
3521 % space. In that case, we won't have a \nobreak before. At least
3522 % that's the theory.
3523 \ifnum\lastpenalty<10000 \parskip=0in \fi
3525 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3527 \vadjust{\penalty 1200}}% not good to break after first line of item.
3531 % \splitoff TOKENS\endmark defines \first to be the first token in
3532 % TOKENS, and \rest to be the remainder.
3534 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3536 % Allow an optional argument of an uppercase letter, lowercase letter,
3537 % or number, to specify the first label in the enumerated list. No
3538 % argument is the same as `1'.
3540 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3541 \def\enumeratey #1 #2\endenumeratey{%
3542 % If we were given no argument, pretend we were given `1'.
3544 \ifx\thearg\empty \def\thearg{1}\fi
3546 % Detect if the argument is a single token. If so, it might be a
3547 % letter. Otherwise, the only valid thing it can be is a number.
3548 % (We will always have one token, because of the test we just made.
3549 % This is a good thing, since \splitoff doesn't work given nothing at
3550 % all -- the first parameter is undelimited.)
3551 \expandafter\splitoff\thearg\endmark
3553 % Only one token in the argument. It could still be anything.
3554 % A ``lowercase letter'' is one whose \lccode is nonzero.
3555 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3556 % not equal to itself.
3557 % Otherwise, we assume it's a number.
3559 % We need the \relax at the end of the \ifnum lines to stop TeX from
3560 % continuing to look for a <number>.
3562 \ifnum\lccode\expandafter`\thearg=0\relax
3563 \numericenumerate % a number (we hope)
3566 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3567 \lowercaseenumerate % lowercase letter
3569 \uppercaseenumerate % uppercase letter
3573 % Multiple tokens in the argument. We hope it's a number.
3578 % An @enumerate whose labels are integers. The starting integer is
3581 \def\numericenumerate{%
3583 \startenumeration{\the\itemno}%
3586 % The starting (lowercase) letter is in \thearg.
3587 \def\lowercaseenumerate{%
3588 \itemno = \expandafter`\thearg
3590 % Be sure we're not beyond the end of the alphabet.
3592 \errmessage{No more lowercase letters in @enumerate; get a bigger
3599 % The starting (uppercase) letter is in \thearg.
3600 \def\uppercaseenumerate{%
3601 \itemno = \expandafter`\thearg
3603 % Be sure we're not beyond the end of the alphabet.
3605 \errmessage{No more uppercase letters in @enumerate; get a bigger
3612 % Call \doitemize, adding a period to the first argument and supplying the
3613 % common last two arguments. Also subtract one from the initial value in
3614 % \itemno, since @item increments \itemno.
3616 \def\startenumeration#1{%
3617 \advance\itemno by -1
3618 \doitemize{#1.}\flushcr
3621 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3624 \def\alphaenumerate{\enumerate{a}}
3625 \def\capsenumerate{\enumerate{A}}
3626 \def\Ealphaenumerate{\Eenumerate}
3627 \def\Ecapsenumerate{\Eenumerate}
3630 % @multitable macros
3631 % Amy Hendrickson, 8/18/94, 3/6/96
3633 % @multitable ... @end multitable will make as many columns as desired.
3634 % Contents of each column will wrap at width given in preamble. Width
3635 % can be specified either with sample text given in a template line,
3636 % or in percent of \hsize, the current width of text on page.
3638 % Table can continue over pages but will only break between lines.
3642 % Either define widths of columns in terms of percent of \hsize:
3643 % @multitable @columnfractions .25 .3 .45
3646 % Numbers following @columnfractions are the percent of the total
3647 % current hsize to be used for each column. You may use as many
3648 % columns as desired.
3651 % Or use a template:
3652 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3654 % using the widest term desired in each column.
3656 % Each new table line starts with @item, each subsequent new column
3657 % starts with @tab. Empty columns may be produced by supplying @tab's
3658 % with nothing between them for as many times as empty columns are needed,
3659 % ie, @tab@tab@tab will produce two empty columns.
3661 % @item, @tab do not need to be on their own lines, but it will not hurt
3664 % Sample multitable:
3666 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3667 % @item first col stuff @tab second col stuff @tab third col
3674 % @item first col stuff @tab second col stuff
3675 % @tab Many paragraphs of text may be used in any column.
3677 % They will wrap at the width determined by the template.
3678 % @item@tab@tab This will be in third column.
3681 % Default dimensions may be reset by user.
3682 % @multitableparskip is vertical space between paragraphs in table.
3683 % @multitableparindent is paragraph indent in table.
3684 % @multitablecolmargin is horizontal space to be left between columns.
3685 % @multitablelinespace is space to leave between table items, baseline
3687 % 0pt means it depends on current normal line spacing.
3689 \newskip\multitableparskip
3690 \newskip\multitableparindent
3691 \newdimen\multitablecolspace
3692 \newskip\multitablelinespace
3693 \multitableparskip=0pt
3694 \multitableparindent=6pt
3695 \multitablecolspace=12pt
3696 \multitablelinespace=0pt
3698 % Macros used to set up halign preamble:
3700 \let\endsetuptable\relax
3701 \def\xendsetuptable{\endsetuptable}
3702 \let\columnfractions\relax
3703 \def\xcolumnfractions{\columnfractions}
3706 % #1 is the @columnfraction, usually a decimal number like .5, but might
3707 % be just 1. We just use it, whatever it is.
3709 \def\pickupwholefraction#1 {%
3710 \global\advance\colcount by 1
3711 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3718 \ifx\firstarg\xendsetuptable
3721 \ifx\firstarg\xcolumnfractions
3722 \global\setpercenttrue
3725 \let\go\pickupwholefraction
3727 \global\advance\colcount by 1
3728 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3729 % separator; typically that is always in the input, anyway.
3730 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3733 \ifx\go\pickupwholefraction
3734 % Put the argument back for the \pickupwholefraction call, so
3735 % we'll always have a period there to be parsed.
3736 \def\go{\pickupwholefraction#1}%
3738 \let\go = \setuptable
3744 % multitable-only commands.
3746 % @headitem starts a heading row, which we typeset in bold.
3747 % Assignments have to be global since we are inside the implicit group
3748 % of an alignment entry. \everycr resets \everytab so we don't have to
3749 % undo it ourselves.
3750 \def\headitemfont{\b}% for people to use in the template row; not changeable
3752 \checkenv\multitable
3754 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3755 \the\everytab % for the first item
3758 % A \tab used to include \hskip1sp. But then the space in a template
3759 % line is not enough. That is bad. So let's go back to just `&' until
3760 % we again encounter the problem the 1sp was intended to solve.
3761 % --karl, nathan@acm.org, 20apr99.
3762 \def\tab{\checkenv\multitable &\the\everytab}%
3764 % @multitable ... @end multitable definitions:
3766 \newtoks\everytab % insert after every tab.
3768 \envdef\multitable{%
3772 % @item within a multitable starts a normal row.
3773 % We use \def instead of \let so that if one of the multitable entries
3774 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3775 % \endtemplate) expanding \doitemize.
3780 \setmultitablespacing
3781 \parskip=\multitableparskip
3782 \parindent=\multitableparindent
3788 \global\everytab={}%
3789 \global\colcount=0 % Reset the column counter.
3790 % Check for saved footnotes, etc.
3792 % Keeps underfull box messages off when table breaks over pages.
3794 % Maybe so, but it also creates really weird page breaks when the
3795 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3796 % problem manifests itself, so it can be fixed for real --karl.
3800 \parsearg\domultitable
3802 \def\domultitable#1{%
3803 % To parse everything between @multitable and @item:
3804 \setuptable#1 \endsetuptable
3806 % This preamble sets up a generic column definition, which will
3807 % be used as many times as user calls for columns.
3808 % \vtop will set a single line and will also let text wrap and
3809 % continue for many paragraphs if desired.
3811 \global\advance\colcount by 1
3814 % Use the current \colcount to find the correct column width:
3815 \hsize=\expandafter\csname col\the\colcount\endcsname
3817 % In order to keep entries from bumping into each other
3818 % we will add a \leftskip of \multitablecolspace to all columns after
3821 % If a template has been used, we will add \multitablecolspace
3822 % to the width of each template entry.
3824 % If the user has set preamble in terms of percent of \hsize we will
3825 % use that dimension as the width of the column, and the \leftskip
3826 % will keep entries from bumping into each other. Table will start at
3827 % left margin and final column will justify at right margin.
3829 % Make sure we don't inherit \rightskip from the outer environment.
3832 % The first column will be indented with the surrounding text.
3833 \advance\hsize by\leftskip
3836 % If user has not set preamble in terms of percent of \hsize
3837 % we will advance \hsize by \multitablecolspace.
3838 \advance\hsize by \multitablecolspace
3840 % In either case we will make \leftskip=\multitablecolspace:
3841 \leftskip=\multitablecolspace
3843 % Ignoring space at the beginning and end avoids an occasional spurious
3844 % blank line, when TeX decides to break the line at the space before the
3845 % box from the multistrut, so the strut ends up on a line by itself.
3847 % @multitable @columnfractions .11 .89
3849 % @tab Legal holiday which is valid in major parts of the whole country.
3850 % Is automatically provided with highlighting sequences respectively
3851 % marking characters.
3852 \noindent\ignorespaces##\unskip\multistrut
3857 \egroup % end the \halign
3858 \global\setpercentfalse
3861 \def\setmultitablespacing{%
3862 \def\multistrut{\strut}% just use the standard line spacing
3864 % Compute \multitablelinespace (if not defined by user) for use in
3865 % \multitableparskip calculation. We used define \multistrut based on
3866 % this, but (ironically) that caused the spacing to be off.
3867 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3868 \ifdim\multitablelinespace=0pt
3869 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3870 \global\advance\multitablelinespace by-\ht0
3872 %% Test to see if parskip is larger than space between lines of
3873 %% table. If not, do nothing.
3874 %% If so, set to same dimension as multitablelinespace.
3875 \ifdim\multitableparskip>\multitablelinespace
3876 \global\multitableparskip=\multitablelinespace
3877 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3878 %% than skip between lines in the table.
3880 \ifdim\multitableparskip=0pt
3881 \global\multitableparskip=\multitablelinespace
3882 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3883 %% than skip between lines in the table.
3887 \message{conditionals,}
3889 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3890 % @ifnotxml always succeed. They currently do nothing; we don't
3891 % attempt to check whether the conditionals are properly nested. But we
3892 % have to remember that they are conditionals, so that @end doesn't
3893 % attempt to close an environment group.
3896 \expandafter\let\csname #1\endcsname = \relax
3897 \expandafter\let\csname iscond.#1\endcsname = 1
3900 \makecond{ifnotdocbook}
3901 \makecond{ifnothtml}
3902 \makecond{ifnotinfo}
3903 \makecond{ifnotplaintext}
3906 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3908 \def\direntry{\doignore{direntry}}
3909 \def\documentdescription{\doignore{documentdescription}}
3910 \def\docbook{\doignore{docbook}}
3911 \def\html{\doignore{html}}
3912 \def\ifdocbook{\doignore{ifdocbook}}
3913 \def\ifhtml{\doignore{ifhtml}}
3914 \def\ifinfo{\doignore{ifinfo}}
3915 \def\ifnottex{\doignore{ifnottex}}
3916 \def\ifplaintext{\doignore{ifplaintext}}
3917 \def\ifxml{\doignore{ifxml}}
3918 \def\ignore{\doignore{ignore}}
3919 \def\menu{\doignore{menu}}
3920 \def\xml{\doignore{xml}}
3922 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3924 % A count to remember the depth of nesting.
3925 \newcount\doignorecount
3927 \def\doignore#1{\begingroup
3928 % Scan in ``verbatim'' mode:
3930 \catcode`\@ = \other
3931 \catcode`\{ = \other
3932 \catcode`\} = \other
3934 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3937 % Count number of #1's that we've seen.
3940 % Swallow text until we reach the matching `@end #1'.
3944 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3947 \gdef\dodoignore#1{%
3948 % #1 contains the command name as a string, e.g., `ifinfo'.
3950 % Define a command to find the next `@end #1'.
3951 \long\def\doignoretext##1^^M@end #1{%
3952 \doignoretextyyy##1^^M@#1\_STOP_}%
3954 % And this command to find another #1 command, at the beginning of a
3955 % line. (Otherwise, we would consider a line `@c @ifset', for
3956 % example, to count as an @ifset for nesting.)
3957 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3959 % And now expand that command.
3964 \def\doignoreyyy#1{%
3966 \ifx\temp\empty % Nothing found.
3967 \let\next\doignoretextzzz
3968 \else % Found a nested condition, ...
3969 \advance\doignorecount by 1
3970 \let\next\doignoretextyyy % ..., look for another.
3971 % If we're here, #1 ends with ^^M\ifinfo (for example).
3973 \next #1% the token \_STOP_ is present just after this macro.
3976 % We have to swallow the remaining "\_STOP_".
3978 \def\doignoretextzzz#1{%
3979 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3980 \let\next\enddoignore
3981 \else % Still inside a nested condition.
3982 \advance\doignorecount by -1
3983 \let\next\doignoretext % Look for the next @end.
3988 % Finish off ignored text.
3990 % Ignore anything after the last `@end #1'; this matters in verbatim
3991 % environments, where otherwise the newline after an ignored conditional
3992 % would result in a blank line in the output.
3993 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3997 % @set VAR sets the variable VAR to an empty value.
3998 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4000 % Since we want to separate VAR from REST-OF-LINE (which might be
4001 % empty), we can't just use \parsearg; we have to insert a space of our
4002 % own to delimit the rest of the line, and then take it out again if we
4004 % We rely on the fact that \parsearg sets \catcode`\ =10.
4006 \parseargdef\set{\setyyy#1 \endsetyyy}
4007 \def\setyyy#1 #2\endsetyyy{%
4009 \makevalueexpandable
4011 \edef\next{\gdef\makecsname{SET#1}}%
4019 % Remove the trailing space \setxxx inserted.
4020 \def\setzzz#1 \endsetzzz{\next{#1}}
4022 % @clear VAR clears (i.e., unsets) the variable VAR.
4024 \parseargdef\clear{%
4026 \makevalueexpandable
4027 \global\expandafter\let\csname SET#1\endcsname=\relax
4031 % @value{foo} gets the text saved in variable foo.
4032 \def\value{\begingroup\makevalueexpandable\valuexxx}
4033 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4035 \catcode`\- = \active \catcode`\_ = \active
4037 \gdef\makevalueexpandable{%
4038 \let\value = \expandablevalue
4039 % We don't want these characters active, ...
4040 \catcode`\-=\other \catcode`\_=\other
4041 % ..., but we might end up with active ones in the argument if
4042 % we're called from @code, as @code{@value{foo-bar_}}, though.
4043 % So \let them to their normal equivalents.
4044 \let-\realdash \let_\normalunderscore
4048 % We have this subroutine so that we can handle at least some @value's
4049 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4050 % The command has to be fully expandable (if the variable is set), since
4051 % the result winds up in the index file. This means that if the
4052 % variable's value contains other Texinfo commands, it's almost certain
4053 % it will fail (although perhaps we could fix that with sufficient work
4054 % to do a one-level expansion on the result, instead of complete).
4056 \def\expandablevalue#1{%
4057 \expandafter\ifx\csname SET#1\endcsname\relax
4058 {[No value for ``#1'']}%
4059 \message{Variable `#1', used in @value, is not set.}%
4061 \csname SET#1\endcsname
4065 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4068 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4071 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4074 \makevalueexpandable
4076 \expandafter\ifx\csname SET#2\endcsname\relax
4077 #1% If not set, redefine \next.
4082 \def\ifsetfail{\doignore{ifset}}
4084 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4085 % defined with @set, or has been undefined with @clear.
4087 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4088 % above code: if the variable is not set, do nothing, if it is set,
4089 % then redefine \next to \ifclearfail.
4092 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4093 \def\ifclearfail{\doignore{ifclear}}
4095 % @dircategory CATEGORY -- specify a category of the dir file
4096 % which this file should belong to. Ignore this in TeX.
4097 \let\dircategory=\comment
4099 % @defininfoenclose.
4100 \let\definfoenclose=\comment
4104 % Index generation facilities
4106 % Define \newwrite to be identical to plain tex's \newwrite
4107 % except not \outer, so it can be used within macros and \if's.
4108 \edef\newwrite{\makecsname{ptexnewwrite}}
4110 % \newindex {foo} defines an index named foo.
4111 % It automatically defines \fooindex such that
4112 % \fooindex ...rest of line... puts an entry in the index foo.
4113 % It also defines \fooindfile to be the number of the output channel for
4114 % the file that accumulates this index. The file's extension is foo.
4115 % The name of an index should be no more than 2 characters long
4116 % for the sake of vms.
4120 \expandafter\newwrite \csname#1indfile\endcsname
4121 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4123 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4124 \noexpand\doindex{#1}}
4127 % @defindex foo == \newindex{foo}
4129 \def\defindex{\parsearg\newindex}
4131 % Define @defcodeindex, like @defindex except put all entries in @code.
4133 \def\defcodeindex{\parsearg\newcodeindex}
4135 \def\newcodeindex#1{%
4137 \expandafter\newwrite \csname#1indfile\endcsname
4138 \openout \csname#1indfile\endcsname \jobname.#1
4140 \expandafter\xdef\csname#1index\endcsname{%
4141 \noexpand\docodeindex{#1}}%
4145 % @synindex foo bar makes index foo feed into index bar.
4146 % Do this instead of @defindex foo if you don't want it as a separate index.
4148 % @syncodeindex foo bar similar, but put all entries made for index foo
4151 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4152 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4154 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4155 % #3 the target index (bar).
4156 \def\dosynindex#1#2#3{%
4157 % Only do \closeout if we haven't already done it, else we'll end up
4158 % closing the target index.
4159 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4160 % The \closeout helps reduce unnecessary open files; the limit on the
4161 % Acorn RISC OS is a mere 16 files.
4162 \expandafter\closeout\csname#2indfile\endcsname
4163 \expandafter\let\csname donesynindex#2\endcsname = 1
4165 % redefine \fooindfile:
4166 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4167 \expandafter\let\csname#2indfile\endcsname=\temp
4168 % redefine \fooindex:
4169 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4172 % Define \doindex, the driver for all \fooindex macros.
4173 % Argument #1 is generated by the calling \fooindex macro,
4174 % and it is "foo", the name of the index.
4176 % \doindex just uses \parsearg; it calls \doind for the actual work.
4177 % This is because \doind is more useful to call from other macros.
4179 % There is also \dosubind {index}{topic}{subtopic}
4180 % which makes an entry in a two-level index such as the operation index.
4182 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4183 \def\singleindexer #1{\doind{\indexname}{#1}}
4185 % like the previous two, but they put @code around the argument.
4186 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4187 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4189 % Take care of Texinfo commands that can appear in an index entry.
4190 % Since there are some commands we want to expand, and others we don't,
4191 % we have to laboriously prevent expansion for those that we don't.
4194 \escapechar = `\\ % use backslash in output files.
4195 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4196 \def\ {\realbackslash\space }%
4198 % Need these unexpandable (because we define \tt as a dummy)
4199 % definitions when @{ or @} appear in index entry text. Also, more
4200 % complicated, when \tex is in effect and \{ is a \delimiter again.
4201 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4202 % braces and backslashes are used only as delimiters. Perhaps we
4203 % should define @lbrace and @rbrace commands a la @comma.
4204 \def\{{{\tt\char123}}%
4205 \def\}{{\tt\char125}}%
4207 % I don't entirely understand this, but when an index entry is
4208 % generated from a macro call, the \endinput which \scanmacro inserts
4209 % causes processing to be prematurely terminated. This is,
4210 % apparently, because \indexsorttmp is fully expanded, and \endinput
4211 % is an expandable command. The redefinition below makes \endinput
4212 % disappear altogether for that purpose -- although logging shows that
4213 % processing continues to some further point. On the other hand, it
4214 % seems \endinput does not hurt in the printed index arg, since that
4215 % is still getting written without apparent harm.
4217 % Sample source (mac-idx3.tex, reported by Graham Percival to
4218 % help-texinfo, 22may06):
4219 % @macro funindex {WORD}
4223 % @funindex commtest
4225 % The above is not enough to reproduce the bug, but it gives the flavor.
4227 % Sample whatsit resulting:
4228 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4231 \let\endinput = \empty
4233 % Do the redefinitions.
4237 % For the aux and toc files, @ is the escape character. So we want to
4238 % redefine everything using @ as the escape character (instead of
4239 % \realbackslash, still used for index files). When everything uses @,
4240 % this will be simpler.
4245 \let\{ = \lbraceatcmd
4246 \let\} = \rbraceatcmd
4248 % Do the redefinitions.
4253 % Called from \indexdummies and \atdummies.
4255 \def\commondummies{%
4257 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4258 % preventing its expansion. This is used only for control words,
4259 % not control letters, because the \space would be incorrect for
4260 % control characters, but is needed to separate the control word
4261 % from whatever follows.
4263 % For control letters, we have \definedummyletter, which omits the
4266 % These can be used both for control words that take an argument and
4267 % those that do not. If it is followed by {arg} in the input, then
4268 % that will dutifully get written to the index (or wherever).
4270 \def\definedummyword ##1{\def##1{\string##1\space}}%
4271 \def\definedummyletter##1{\def##1{\string##1}}%
4272 \let\definedummyaccent\definedummyletter
4274 \commondummiesnofonts
4276 \definedummyletter\_%
4277 \definedummyletter\-%
4279 % Non-English letters.
4290 \definedummyword\exclamdown
4294 \definedummyword\ordf
4295 \definedummyword\ordm
4296 \definedummyword\questiondown
4300 % Although these internal commands shouldn't show up, sometimes they do.
4302 \definedummyword\gtr
4303 \definedummyword\hat
4304 \definedummyword\less
4307 \definedummyword\tclose
4310 \definedummyword\LaTeX
4311 \definedummyword\TeX
4313 % Assorted special characters.
4314 \definedummyword\arrow
4315 \definedummyword\bullet
4316 \definedummyword\comma
4317 \definedummyword\copyright
4318 \definedummyword\registeredsymbol
4319 \definedummyword\dots
4320 \definedummyword\enddots
4321 \definedummyword\entrybreak
4322 \definedummyword\equiv
4323 \definedummyword\error
4324 \definedummyword\euro
4325 \definedummyword\expansion
4326 \definedummyword\geq
4327 \definedummyword\guillemetleft
4328 \definedummyword\guillemetright
4329 \definedummyword\guilsinglleft
4330 \definedummyword\guilsinglright
4331 \definedummyword\leq
4332 \definedummyword\minus
4333 \definedummyword\ogonek
4334 \definedummyword\pounds
4335 \definedummyword\point
4336 \definedummyword\print
4337 \definedummyword\quotedblbase
4338 \definedummyword\quotedblleft
4339 \definedummyword\quotedblright
4340 \definedummyword\quoteleft
4341 \definedummyword\quoteright
4342 \definedummyword\quotesinglbase
4343 \definedummyword\result
4344 \definedummyword\textdegree
4346 % We want to disable all macros so that they are not expanded by \write.
4349 \normalturnoffactive
4351 % Handle some cases of @value -- where it does not contain any
4352 % (non-fully-expandable) commands.
4353 \makevalueexpandable
4356 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4358 \def\commondummiesnofonts{%
4359 % Control letters and accents.
4360 \definedummyletter\!%
4361 \definedummyaccent\"%
4362 \definedummyaccent\'%
4363 \definedummyletter\*%
4364 \definedummyaccent\,%
4365 \definedummyletter\.%
4366 \definedummyletter\/%
4367 \definedummyletter\:%
4368 \definedummyaccent\=%
4369 \definedummyletter\?%
4370 \definedummyaccent\^%
4371 \definedummyaccent\`%
4372 \definedummyaccent\~%
4376 \definedummyword\dotaccent
4377 \definedummyword\ogonek
4378 \definedummyword\ringaccent
4379 \definedummyword\tieaccent
4380 \definedummyword\ubaraccent
4381 \definedummyword\udotaccent
4382 \definedummyword\dotless
4384 % Texinfo font commands.
4388 \definedummyword\sansserif
4390 \definedummyword\slanted
4393 % Commands that take arguments.
4394 \definedummyword\acronym
4395 \definedummyword\cite
4396 \definedummyword\code
4397 \definedummyword\command
4398 \definedummyword\dfn
4399 \definedummyword\dmn
4400 \definedummyword\email
4401 \definedummyword\emph
4402 \definedummyword\env
4403 \definedummyword\file
4404 \definedummyword\indicateurl
4405 \definedummyword\kbd
4406 \definedummyword\key
4407 \definedummyword\math
4408 \definedummyword\option
4409 \definedummyword\pxref
4410 \definedummyword\ref
4411 \definedummyword\samp
4412 \definedummyword\strong
4413 \definedummyword\tie
4414 \definedummyword\uref
4415 \definedummyword\url
4416 \definedummyword\var
4417 \definedummyword\verb
4419 \definedummyword\xref
4422 % \indexnofonts is used when outputting the strings to sort the index
4423 % by, and when constructing control sequence names. It eliminates all
4424 % control sequences and just writes whatever the best ASCII sort string
4425 % would be for a given command (usually its argument).
4428 % Accent commands should become @asis.
4429 \def\definedummyaccent##1{\let##1\asis}%
4430 % We can just ignore other control letters.
4431 \def\definedummyletter##1{\let##1\empty}%
4432 % All control words become @asis by default; overrides below.
4433 \let\definedummyword\definedummyaccent
4435 \commondummiesnofonts
4437 % Don't no-op \tt, since it isn't a user-level command
4438 % and is used in the definitions of the active chars like <, >, |, etc.
4439 % Likewise with the other plain tex font commands.
4444 \def\_{\normalunderscore}%
4445 \def\-{}% @- shouldn't affect sorting
4447 % Unfortunately, texindex is not prepared to handle braces in the
4448 % content at all. So for index sorting, we map @{ and @} to strings
4449 % starting with |, since that ASCII character is between ASCII { and }.
4453 % Non-English letters.
4470 \def\questiondown{?}%
4477 % Assorted special characters.
4478 % (The following {} will end up in the sort string, but that's ok.)
4480 \def\bullet{bullet}%
4482 \def\copyright{copyright}%
4488 \def\expansion{==>}%
4490 \def\guillemetleft{<<}%
4491 \def\guillemetright{>>}%
4492 \def\guilsinglleft{<}%
4493 \def\guilsinglright{>}%
4497 \def\pounds{pounds}%
4499 \def\quotedblbase{"}%
4500 \def\quotedblleft{"}%
4501 \def\quotedblright{"}%
4504 \def\quotesinglbase{,}%
4505 \def\registeredsymbol{R}%
4509 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4510 \else \indexlquoteignore \fi
4512 % We need to get rid of all macros, leaving only the arguments (if present).
4513 % Of course this is not nearly correct, but it is the best we can do for now.
4514 % makeinfo does not expand macros in the argument to @deffn, which ends up
4515 % writing an index entry, and texindex isn't prepared for an index sort entry
4516 % that starts with \.
4518 % Since macro invocations are followed by braces, we can just redefine them
4519 % to take a single TeX argument. The case of a macro invocation that
4520 % goes to end-of-line is not handled.
4525 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4526 % ignore left quotes in the sort term.
4527 {\catcode`\`=\active
4528 \gdef\indexlquoteignore{\let`=\empty}}
4530 \let\indexbackslash=0 %overridden during \printindex.
4531 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4533 % Most index entries go through here, but \dosubind is the general case.
4534 % #1 is the index name, #2 is the entry text.
4535 \def\doind#1#2{\dosubind{#1}{#2}{}}
4537 % Workhorse for all \fooindexes.
4538 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4539 % empty if called from \doind, as we usually are (the main exception
4540 % is with most defuns, which call us directly).
4542 \def\dosubind#1#2#3{%
4545 % Store the main index entry text (including the third arg).
4547 % If third arg is present, precede it with a space.
4549 \ifx\thirdarg\empty \else
4550 \toks0 = \expandafter{\the\toks0 \space #3}%
4553 \edef\writeto{\csname#1indfile\endcsname}%
4555 \safewhatsit\dosubindwrite
4560 % Write the entry in \toks0 to the index file:
4562 \def\dosubindwrite{%
4563 % Put the index entry in the margin if desired.
4564 \ifx\SETmarginindex\relax\else
4565 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4568 % Remember, we are within a group.
4569 \indexdummies % Must do this here, since \bf, etc expand at this stage
4570 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4571 % so it will be output as is; and it will print as backslash.
4573 % Process the index entry with all font commands turned off, to
4574 % get the string to sort by.
4576 \edef\temp{\the\toks0}% need full expansion
4577 \xdef\indexsorttmp{\temp}%
4580 % Set up the complete index entry, with both the sort key and
4581 % the original text, including any font commands. We write
4582 % three arguments to \entry to the .?? file (four in the
4583 % subentry case), texindex reduces to two when writing the .??s
4587 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4592 % Take care of unwanted page breaks/skips around a whatsit:
4594 % If a skip is the last thing on the list now, preserve it
4595 % by backing up by \lastskip, doing the \write, then inserting
4596 % the skip again. Otherwise, the whatsit generated by the
4597 % \write or \pdfdest will make \lastskip zero. The result is that
4598 % sequences like this:
4602 % will have extra space inserted, because the \medbreak in the
4603 % start of the @defun won't see the skip inserted by the @end of
4604 % the previous defun.
4606 % But don't do any of this if we're not in vertical mode. We
4607 % don't want to do a \vskip and prematurely end a paragraph.
4609 % Avoid page breaks due to these extra skips, too.
4611 % But wait, there is a catch there:
4612 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4613 % sufficient for this purpose, as it ignores stretch and shrink parts
4614 % of the skip. The only way seems to be to check the textual
4615 % representation of the skip.
4617 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4618 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4620 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4622 \newskip\whatsitskip
4623 \newcount\whatsitpenalty
4627 \def\safewhatsit#1{%
4631 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4632 \whatsitskip = \lastskip
4633 \edef\lastskipmacro{\the\lastskip}%
4634 \whatsitpenalty = \lastpenalty
4636 % If \lastskip is nonzero, that means the last item was a
4637 % skip. And since a skip is discardable, that means this
4638 % -\whatsitskip glue we're inserting is preceded by a
4639 % non-discardable item, therefore it is not a potential
4640 % breakpoint, therefore no \nobreak needed.
4641 \ifx\lastskipmacro\zeroskipmacro
4648 \ifx\lastskipmacro\zeroskipmacro
4649 % If \lastskip was zero, perhaps the last item was a penalty, and
4650 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4651 % to re-insert the same penalty (values >10000 are used for various
4652 % signals); since we just inserted a non-discardable item, any
4653 % following glue (such as a \parskip) would be a breakpoint. For example:
4655 % @deffn deffn-whatever
4656 % @vindex index-whatever
4658 % would allow a break between the index-whatever whatsit
4659 % and the "Description." paragraph.
4660 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4662 % On the other hand, if we had a nonzero \lastskip,
4663 % this make-up glue would be preceded by a non-discardable item
4664 % (the whatsit from the \write), so we must insert a \nobreak.
4665 \nobreak\vskip\whatsitskip
4670 % The index entry written in the file actually looks like
4671 % \entry {sortstring}{page}{topic}
4673 % \entry {sortstring}{page}{topic}{subtopic}
4674 % The texindex program reads in these files and writes files
4675 % containing these kinds of lines:
4677 % before the first topic whose initial is c
4678 % \entry {topic}{pagelist}
4679 % for a topic that is used without subtopics
4681 % for the beginning of a topic that is used with subtopics
4682 % \secondary {subtopic}{pagelist}
4683 % for each subtopic.
4685 % Define the user-accessible indexing commands
4686 % @findex, @vindex, @kindex, @cindex.
4688 \def\findex {\fnindex}
4689 \def\kindex {\kyindex}
4690 \def\cindex {\cpindex}
4691 \def\vindex {\vrindex}
4692 \def\tindex {\tpindex}
4693 \def\pindex {\pgindex}
4695 \def\cindexsub {\begingroup\obeylines\cindexsub}
4697 \gdef\cindexsub "#1" #2^^M{\endgroup %
4698 \dosubind{cp}{#2}{#1}}}
4700 % Define the macros used in formatting output of the sorted index material.
4702 % @printindex causes a particular index (the ??s file) to get printed.
4703 % It does not print any chapter heading (usually an @unnumbered).
4705 \parseargdef\printindex{\begingroup
4706 \dobreak \chapheadingskip{10000}%
4711 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4713 % See if the index file exists and is nonempty.
4714 % Change catcode of @ here so that if the index file contains
4716 % as its first line, TeX doesn't complain about mismatched braces
4717 % (because it thinks @} is a control sequence).
4719 \openin 1 \jobname.#1s
4721 % \enddoublecolumns gets confused if there is no text in the index,
4722 % and it loses the chapter title and the aux file entries for the
4723 % index. The easiest way to prevent this problem is to make sure
4724 % there is some text.
4725 \putwordIndexNonexistent
4728 % If the index file exists but is empty, then \openin leaves \ifeof
4729 % false. We have to make TeX try to read something from the file, so
4730 % it can discover if there is anything in it.
4733 \putwordIndexIsEmpty
4735 % Index files are almost Texinfo source, but we use \ as the escape
4736 % character. It would be better to use @, but that's too big a change
4737 % to make right now.
4738 \def\indexbackslash{\backslashcurfont}%
4749 % These macros are used by the sorted index file itself.
4750 % Change them to control the appearance of the index.
4753 % Some minor font changes for the special characters.
4754 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4756 % Remove any glue we may have, we'll be inserting our own.
4759 % We like breaks before the index initials, so insert a bonus.
4761 \vskip 0pt plus 3\baselineskip
4763 \vskip 0pt plus -3\baselineskip
4765 % Typeset the initial. Making this add up to a whole number of
4766 % baselineskips increases the chance of the dots lining up from column
4767 % to column. It still won't often be perfect, because of the stretch
4768 % we need before each entry, but it's better.
4770 % No shrink because it confuses \balancecolumns.
4771 \vskip 1.67\baselineskip plus .5\baselineskip
4772 \leftline{\secbf #1}%
4773 % Do our best not to break after the initial.
4775 \vskip .33\baselineskip plus .1\baselineskip
4778 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4779 % then page number (#2) flushed to the right margin. It is used for index
4780 % and table of contents entries. The paragraph is indented by \leftskip.
4782 % A straightforward implementation would start like this:
4783 % \def\entry#1#2{...
4784 % But this freezes the catcodes in the argument, and can cause problems to
4785 % @code, which sets - active. This problem was fixed by a kludge---
4786 % ``-'' was active throughout whole index, but this isn't really right.
4787 % The right solution is to prevent \entry from swallowing the whole text.
4792 % Start a new paragraph if necessary, so our assignments below can't
4793 % affect previous text.
4796 % Do not fill out the last line with white space.
4799 % No extra space above this paragraph.
4802 % Do not prefer a separate line ending with a hyphen to fewer lines.
4803 \finalhyphendemerits = 0
4805 % \hangindent is only relevant when the entry text and page number
4806 % don't both fit on one line. In that case, bob suggests starting the
4807 % dots pretty far over on the line. Unfortunately, a large
4808 % indentation looks wrong when the entry text itself is broken across
4809 % lines. So we use a small indentation and put up with long leaders.
4811 % \hangafter is reset to 1 (which is the value we want) at the start
4812 % of each paragraph, so we need not do anything with that.
4815 % When the entry text needs to be broken, just fill out the first line
4817 \rightskip = 0pt plus1fil
4819 % A bit of stretch before each entry for the benefit of balancing
4823 % When reading the text of entry, convert explicit line breaks
4824 % from @* into spaces. The user might give these in long section
4825 % titles, for instance.
4826 \def\*{\unskip\space\ignorespaces}%
4827 \def\entrybreak{\hfil\break}%
4829 % Swallow the left brace of the text (first parameter):
4830 \afterassignment\doentry
4833 \def\entrybreak{\unskip\space\ignorespaces}%
4835 \bgroup % Instead of the swallowed brace.
4837 \aftergroup\finishentry
4838 % And now comes the text of the entry.
4840 \def\finishentry#1{%
4841 % #1 is the page number.
4843 % The following is kludged to not output a line of dots in the index if
4844 % there are no page numbers. The next person who breaks this will be
4845 % cursed by a Unix daemon.
4846 \setbox\boxA = \hbox{#1}%
4847 \ifdim\wd\boxA = 0pt
4851 % If we must, put the page number on a line of its own, and fill out
4852 % this line with blank space. (The \hfil is overwhelmed with the
4853 % fill leaders glue in \indexdotfill if the page number does fit.)
4855 \null\nobreak\indexdotfill % Have leaders before the page number.
4857 % The `\ ' here is removed by the implicit \unskip that TeX does as
4858 % part of (the primitive) \par. Without it, a spurious underfull
4871 % Like plain.tex's \dotfill, except uses up at least 1 em.
4872 \def\indexdotfill{\cleaders
4873 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4875 \def\primary #1{\line{#1\hfil}}
4877 \newskip\secondaryindent \secondaryindent=0.5cm
4878 \def\secondary#1#2{{%
4883 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4885 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4892 % Define two-column mode, which we use to typeset indexes.
4893 % Adapted from the TeXbook, page 416, which is to say,
4894 % the manmac.tex format used to print the TeXbook itself.
4898 \newdimen\doublecolumnhsize
4900 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4901 % Grab any single-column material above us.
4904 % Here is a possibility not foreseen in manmac: if we accumulate a
4905 % whole lot of material, we might end up calling this \output
4906 % routine twice in a row (see the doublecol-lose test, which is
4907 % essentially a couple of indexes with @setchapternewpage off). In
4908 % that case we just ship out what is in \partialpage with the normal
4909 % output routine. Generally, \partialpage will be empty when this
4910 % runs and this will be a no-op. See the indexspread.tex test case.
4911 \ifvoid\partialpage \else
4912 \onepageout{\pagecontents\partialpage}%
4915 \global\setbox\partialpage = \vbox{%
4916 % Unvbox the main output page.
4918 \kern-\topskip \kern\baselineskip
4921 \eject % run that output routine to set \partialpage
4923 % Use the double-column output routine for subsequent pages.
4924 \output = {\doublecolumnout}%
4926 % Change the page size parameters. We could do this once outside this
4927 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4928 % format, but then we repeat the same computation. Repeating a couple
4929 % of assignments once per index is clearly meaningless for the
4930 % execution time, so we may as well do it in one place.
4932 % First we halve the line length, less a little for the gutter between
4933 % the columns. We compute the gutter based on the line length, so it
4934 % changes automatically with the paper format. The magic constant
4935 % below is chosen so that the gutter has the same value (well, +-<1pt)
4936 % as it did when we hard-coded it.
4938 % We put the result in a separate register, \doublecolumhsize, so we
4939 % can restore it in \pagesofar, after \hsize itself has (potentially)
4942 \doublecolumnhsize = \hsize
4943 \advance\doublecolumnhsize by -.04154\hsize
4944 \divide\doublecolumnhsize by 2
4945 \hsize = \doublecolumnhsize
4947 % Double the \vsize as well. (We don't need a separate register here,
4948 % since nobody clobbers \vsize.)
4952 % The double-column output routine for all double-column pages except
4955 \def\doublecolumnout{%
4956 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4957 % Get the available space for the double columns -- the normal
4958 % (undoubled) page height minus any material left over from the
4962 \advance\dimen@ by -\ht\partialpage
4964 % box0 will be the left-hand column, box2 the right.
4965 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4966 \onepageout\pagesofar
4968 \penalty\outputpenalty
4971 % Re-output the contents of the output page -- any previous material,
4972 % followed by the two boxes we just split, in box0 and box2.
4976 \hsize = \doublecolumnhsize
4977 \wd0=\hsize \wd2=\hsize
4978 \hbox to\pagewidth{\box0\hfil\box2}%
4981 % All done with double columns.
4982 \def\enddoublecolumns{%
4983 % The following penalty ensures that the page builder is exercised
4984 % _before_ we change the output routine. This is necessary in the
4985 % following situation:
4987 % The last section of the index consists only of a single entry.
4988 % Before this section, \pagetotal is less than \pagegoal, so no
4989 % break occurs before the last section starts. However, the last
4990 % section, consisting of \initial and the single \entry, does not
4991 % fit on the page and has to be broken off. Without the following
4992 % penalty the page builder will not be exercised until \eject
4993 % below, and by that time we'll already have changed the output
4994 % routine to the \balancecolumns version, so the next-to-last
4995 % double-column page will be processed with \balancecolumns, which
4996 % is wrong: The two columns will go to the main vertical list, with
4997 % the broken-off section in the recent contributions. As soon as
4998 % the output routine finishes, TeX starts reconsidering the page
4999 % break. The two columns and the broken-off section both fit on the
5000 % page, because the two columns now take up only half of the page
5001 % goal. When TeX sees \eject from below which follows the final
5002 % section, it invokes the new output routine that we've set after
5003 % \balancecolumns below; \onepageout will try to fit the two columns
5004 % and the final section into the vbox of \pageheight (see
5005 % \pagebody), causing an overfull box.
5007 % Note that glue won't work here, because glue does not exercise the
5008 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5012 % Split the last of the double-column material. Leave it on the
5013 % current page, no automatic page break.
5016 % If we end up splitting too much material for the current page,
5017 % though, there will be another page break right after this \output
5018 % invocation ends. Having called \balancecolumns once, we do not
5019 % want to call it again. Therefore, reset \output to its normal
5020 % definition right away. (We hope \balancecolumns will never be
5021 % called on to balance too much material, but if it is, this makes
5022 % the output somewhat more palatable.)
5023 \global\output = {\onepageout{\pagecontents\PAGE}}%
5026 \endgroup % started in \begindoublecolumns
5028 % \pagegoal was set to the doubled \vsize above, since we restarted
5029 % the current page. We're now back to normal single-column
5030 % typesetting, so reset \pagegoal to the normal \vsize (after the
5031 % \endgroup where \vsize got restored).
5035 % Called at the end of the double column material.
5036 \def\balancecolumns{%
5037 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5039 \advance\dimen@ by \topskip
5040 \advance\dimen@ by-\baselineskip
5041 \divide\dimen@ by 2 % target to split to
5042 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5043 \splittopskip = \topskip
5044 % Loop until we get a decent breakpoint.
5048 \global\setbox3 = \copy0
5049 \global\setbox1 = \vsplit3 to \dimen@
5051 \global\advance\dimen@ by 1pt
5054 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5055 \setbox0=\vbox to\dimen@{\unvbox1}%
5056 \setbox2=\vbox to\dimen@{\unvbox3}%
5060 \catcode`\@ = \other
5063 \message{sectioning,}
5064 % Chapters, sections, etc.
5066 % Let's start with @part.
5067 \outer\parseargdef\part{\partzzz{#1}}
5071 \vskip.3\vsize % move it down on the page a bit
5073 \noindent \titlefonts\rmisbold #1\par % the text
5074 \let\lastnode=\empty % no node to associate with
5075 \writetocentry{part}{#1}{}% but put it in the toc
5076 \headingsoff % no headline or footline on the part page
5081 % \unnumberedno is an oxymoron. But we count the unnumbered
5082 % sections so that we can refer to them unambiguously in the pdf
5083 % outlines by their "section number". We avoid collisions with chapter
5084 % numbers by starting them at 10000. (If a document ever has 10000
5085 % chapters, we're in trouble anyway, I'm sure.)
5086 \newcount\unnumberedno \unnumberedno = 10000
5088 \newcount\secno \secno=0
5089 \newcount\subsecno \subsecno=0
5090 \newcount\subsubsecno \subsubsecno=0
5092 % This counter is funny since it counts through charcodes of letters A, B, ...
5093 \newcount\appendixno \appendixno = `\@
5095 % \def\appendixletter{\char\the\appendixno}
5096 % We do the following ugly conditional instead of the above simple
5097 % construct for the sake of pdftex, which needs the actual
5098 % letter in the expansion, not just typeset.
5100 \def\appendixletter{%
5101 \ifnum\appendixno=`A A%
5102 \else\ifnum\appendixno=`B B%
5103 \else\ifnum\appendixno=`C C%
5104 \else\ifnum\appendixno=`D D%
5105 \else\ifnum\appendixno=`E E%
5106 \else\ifnum\appendixno=`F F%
5107 \else\ifnum\appendixno=`G G%
5108 \else\ifnum\appendixno=`H H%
5109 \else\ifnum\appendixno=`I I%
5110 \else\ifnum\appendixno=`J J%
5111 \else\ifnum\appendixno=`K K%
5112 \else\ifnum\appendixno=`L L%
5113 \else\ifnum\appendixno=`M M%
5114 \else\ifnum\appendixno=`N N%
5115 \else\ifnum\appendixno=`O O%
5116 \else\ifnum\appendixno=`P P%
5117 \else\ifnum\appendixno=`Q Q%
5118 \else\ifnum\appendixno=`R R%
5119 \else\ifnum\appendixno=`S S%
5120 \else\ifnum\appendixno=`T T%
5121 \else\ifnum\appendixno=`U U%
5122 \else\ifnum\appendixno=`V V%
5123 \else\ifnum\appendixno=`W W%
5124 \else\ifnum\appendixno=`X X%
5125 \else\ifnum\appendixno=`Y Y%
5126 \else\ifnum\appendixno=`Z Z%
5127 % The \the is necessary, despite appearances, because \appendixletter is
5128 % expanded while writing the .toc file. \char\appendixno is not
5129 % expandable, thus it is written literally, thus all appendixes come out
5130 % with the same letter (or @) in the toc without it.
5131 \else\char\the\appendixno
5132 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5133 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5135 % Each @chapter defines these (using marks) as the number+name, number
5136 % and name of the chapter. Page headings and footings can use
5137 % these. @section does likewise.
5139 \def\thischapternum{}
5140 \def\thischaptername{}
5142 \def\thissectionnum{}
5143 \def\thissectionname{}
5145 \newcount\absseclevel % used to calculate proper heading level
5146 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5148 % @raisesections: treat @section as chapter, @subsection as section, etc.
5149 \def\raisesections{\global\advance\secbase by -1}
5150 \let\up=\raisesections % original BFox name
5152 % @lowersections: treat @chapter as section, @section as subsection, etc.
5153 \def\lowersections{\global\advance\secbase by 1}
5154 \let\down=\lowersections % original BFox name
5156 % we only have subsub.
5157 \chardef\maxseclevel = 3
5159 % A numbered section within an unnumbered changes to unnumbered too.
5160 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5161 \chardef\unnlevel = \maxseclevel
5163 % Trace whether the current chapter is an appendix or not:
5164 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5165 \def\chapheadtype{N}
5167 % Choose a heading macro
5168 % #1 is heading type
5169 % #2 is heading level
5170 % #3 is text for heading
5171 \def\genhead#1#2#3{%
5172 % Compute the abs. sec. level:
5174 \advance\absseclevel by \secbase
5175 % Make sure \absseclevel doesn't fall outside the range:
5176 \ifnum \absseclevel < 0
5179 \ifnum \absseclevel > 3
5186 \ifnum \absseclevel < \unnlevel
5187 \chardef\unnlevel = \absseclevel
5190 % Check for appendix sections:
5191 \ifnum \absseclevel = 0
5192 \edef\chapheadtype{\headtype}%
5194 \if \headtype A\if \chapheadtype N%
5195 \errmessage{@appendix... within a non-appendix chapter}%
5198 % Check for numbered within unnumbered:
5199 \ifnum \absseclevel > \unnlevel
5202 \chardef\unnlevel = 3
5205 % Now print the heading:
5209 \or \unnumberedseczzz{#3}%
5210 \or \unnumberedsubseczzz{#3}%
5211 \or \unnumberedsubsubseczzz{#3}%
5217 \or \appendixsectionzzz{#3}%
5218 \or \appendixsubseczzz{#3}%
5219 \or \appendixsubsubseczzz{#3}%
5225 \or \numberedsubseczzz{#3}%
5226 \or \numberedsubsubseczzz{#3}%
5230 \suppressfirstparagraphindent
5234 \def\numhead{\genhead N}
5235 \def\apphead{\genhead A}
5236 \def\unnmhead{\genhead U}
5238 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5239 % all lower-level sectioning counters to zero.
5241 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5242 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5243 \let\chaplevelprefix = \empty
5245 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5247 % section resetting is \global in case the chapter is in a group, such
5248 % as an @include file.
5249 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5250 \global\advance\chapno by 1
5253 \gdef\chaplevelprefix{\the\chapno.}%
5256 % \putwordChapter can contain complex things in translations.
5257 \toks0=\expandafter{\putwordChapter}%
5258 \message{\the\toks0 \space \the\chapno}%
5260 % Write the actual heading.
5261 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5263 % So @section and the like are numbered underneath this chapter.
5264 \global\let\section = \numberedsec
5265 \global\let\subsection = \numberedsubsec
5266 \global\let\subsubsection = \numberedsubsubsec
5269 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5271 \def\appendixzzz#1{%
5272 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5273 \global\advance\appendixno by 1
5274 \gdef\chaplevelprefix{\appendixletter.}%
5277 % \putwordAppendix can contain complex things in translations.
5278 \toks0=\expandafter{\putwordAppendix}%
5279 \message{\the\toks0 \space \appendixletter}%
5281 \chapmacro{#1}{Yappendix}{\appendixletter}%
5283 \global\let\section = \appendixsec
5284 \global\let\subsection = \appendixsubsec
5285 \global\let\subsubsection = \appendixsubsubsec
5288 % normally unnmhead0 calls unnumberedzzz:
5289 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5290 \def\unnumberedzzz#1{%
5291 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5292 \global\advance\unnumberedno by 1
5294 % Since an unnumbered has no number, no prefix for figures.
5295 \global\let\chaplevelprefix = \empty
5298 % This used to be simply \message{#1}, but TeX fully expands the
5299 % argument to \message. Therefore, if #1 contained @-commands, TeX
5300 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5301 % expanded @cite (which turns out to cause errors because \cite is meant
5302 % to be executed, not expanded).
5304 % Anyway, we don't want the fully-expanded definition of @cite to appear
5305 % as a result of the \message, we just want `@cite' itself. We use
5306 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5307 % simply yielding the contents of <toks register>. (We also do this for
5310 \message{(\the\toks0)}%
5312 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5314 \global\let\section = \unnumberedsec
5315 \global\let\subsection = \unnumberedsubsec
5316 \global\let\subsubsection = \unnumberedsubsubsec
5319 % @centerchap is like @unnumbered, but the heading is centered.
5320 \outer\parseargdef\centerchap{%
5321 % Well, we could do the following in a group, but that would break
5322 % an assumption that \chapmacro is called at the outermost level.
5323 % Thus we are safer this way: --kasal, 24feb04
5324 \let\centerparametersmaybe = \centerparameters
5326 \let\centerparametersmaybe = \relax
5329 % @top is like @unnumbered.
5334 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5336 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5337 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5340 % normally calls appendixsectionzzz:
5341 \outer\parseargdef\appendixsection{\apphead1{#1}}
5342 \def\appendixsectionzzz#1{%
5343 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5344 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5346 \let\appendixsec\appendixsection
5348 % normally calls unnumberedseczzz:
5349 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5350 \def\unnumberedseczzz#1{%
5351 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5352 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5357 % normally calls numberedsubseczzz:
5358 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5359 \def\numberedsubseczzz#1{%
5360 \global\subsubsecno=0 \global\advance\subsecno by 1
5361 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5364 % normally calls appendixsubseczzz:
5365 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5366 \def\appendixsubseczzz#1{%
5367 \global\subsubsecno=0 \global\advance\subsecno by 1
5368 \sectionheading{#1}{subsec}{Yappendix}%
5369 {\appendixletter.\the\secno.\the\subsecno}%
5372 % normally calls unnumberedsubseczzz:
5373 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5374 \def\unnumberedsubseczzz#1{%
5375 \global\subsubsecno=0 \global\advance\subsecno by 1
5376 \sectionheading{#1}{subsec}{Ynothing}%
5377 {\the\unnumberedno.\the\secno.\the\subsecno}%
5382 % normally numberedsubsubseczzz:
5383 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5384 \def\numberedsubsubseczzz#1{%
5385 \global\advance\subsubsecno by 1
5386 \sectionheading{#1}{subsubsec}{Ynumbered}%
5387 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5390 % normally appendixsubsubseczzz:
5391 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5392 \def\appendixsubsubseczzz#1{%
5393 \global\advance\subsubsecno by 1
5394 \sectionheading{#1}{subsubsec}{Yappendix}%
5395 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5398 % normally unnumberedsubsubseczzz:
5399 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5400 \def\unnumberedsubsubseczzz#1{%
5401 \global\advance\subsubsecno by 1
5402 \sectionheading{#1}{subsubsec}{Ynothing}%
5403 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5406 % These macros control what the section commands do, according
5407 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5408 % Define them by default for a numbered chapter.
5409 \let\section = \numberedsec
5410 \let\subsection = \numberedsubsec
5411 \let\subsubsection = \numberedsubsubsec
5413 % Define @majorheading, @heading and @subheading
5415 % NOTE on use of \vbox for chapter headings, section headings, and such:
5416 % 1) We use \vbox rather than the earlier \line to permit
5417 % overlong headings to fold.
5418 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5419 % heading is obnoxious; this forbids it.
5420 % 3) Likewise, headings look best if no \parindent is used, and
5421 % if justification is not attempted. Hence \raggedright.
5424 {\advance\chapheadingskip by 10pt \chapbreak }%
5425 \parsearg\chapheadingzzz
5428 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5429 \def\chapheadingzzz#1{%
5430 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5431 \parindent=0pt\ptexraggedright
5432 \rmisbold #1\hfill}}%
5433 \bigskip \par\penalty 200\relax
5434 \suppressfirstparagraphindent
5437 % @heading, @subheading, @subsubheading.
5438 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5439 \suppressfirstparagraphindent}
5440 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5441 \suppressfirstparagraphindent}
5442 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5443 \suppressfirstparagraphindent}
5445 % These macros generate a chapter, section, etc. heading only
5446 % (including whitespace, linebreaking, etc. around it),
5447 % given all the information in convenient, parsed form.
5449 %%% Args are the skip and penalty (usually negative)
5450 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5452 %%% Define plain chapter starts, and page on/off switching for it
5453 % Parameter controlling skip before chapter headings (if needed)
5455 \newskip\chapheadingskip
5457 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5458 \def\chappager{\par\vfill\supereject}
5459 % Because \domark is called before \chapoddpage, the filler page will
5460 % get the headings for the next chapter, which is wrong. But we don't
5461 % care -- we just disable all headings on the filler page.
5473 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5476 \global\let\contentsalignmacro = \chappager
5477 \global\let\pchapsepmacro=\chapbreak
5478 \global\let\pagealignmacro=\chappager}
5481 \global\let\contentsalignmacro = \chappager
5482 \global\let\pchapsepmacro=\chappager
5483 \global\let\pagealignmacro=\chappager
5484 \global\def\HEADINGSon{\HEADINGSsingle}}
5487 \global\let\contentsalignmacro = \chapoddpage
5488 \global\let\pchapsepmacro=\chapoddpage
5489 \global\let\pagealignmacro=\chapoddpage
5490 \global\def\HEADINGSon{\HEADINGSdouble}}
5496 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5497 % Yappendix, Yomitfromtoc), #3 the chapter number.
5499 % To test against our argument.
5500 \def\Ynothingkeyword{Ynothing}
5501 \def\Yomitfromtockeyword{Yomitfromtoc}
5502 \def\Yappendixkeyword{Yappendix}
5504 \def\chapmacro#1#2#3{%
5505 % Insert the first mark before the heading break (see notes for \domark).
5506 \let\prevchapterdefs=\lastchapterdefs
5507 \let\prevsectiondefs=\lastsectiondefs
5508 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5509 \gdef\thissection{}}%
5512 \ifx\temptype\Ynothingkeyword
5513 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5514 \gdef\thischapter{\thischaptername}}%
5515 \else\ifx\temptype\Yomitfromtockeyword
5516 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5517 \gdef\thischapter{}}%
5518 \else\ifx\temptype\Yappendixkeyword
5520 \xdef\lastchapterdefs{%
5521 \gdef\noexpand\thischaptername{\the\toks0}%
5522 \gdef\noexpand\thischapternum{\appendixletter}%
5523 % \noexpand\putwordAppendix avoids expanding indigestible
5524 % commands in some of the translations.
5525 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5526 \noexpand\thischapternum:
5527 \noexpand\thischaptername}%
5531 \xdef\lastchapterdefs{%
5532 \gdef\noexpand\thischaptername{\the\toks0}%
5533 \gdef\noexpand\thischapternum{\the\chapno}%
5534 % \noexpand\putwordChapter avoids expanding indigestible
5535 % commands in some of the translations.
5536 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5537 \noexpand\thischapternum:
5538 \noexpand\thischaptername}%
5542 % Output the mark. Pass it through \safewhatsit, to take care of
5543 % the preceding space.
5546 % Insert the chapter heading break.
5549 % Now the second mark, after the heading break. No break points
5550 % between here and the heading.
5551 \let\prevchapterdefs=\lastchapterdefs
5552 \let\prevsectiondefs=\lastsectiondefs
5556 \chapfonts \rmisbold
5558 % Have to define \lastsection before calling \donoderef, because the
5559 % xref code eventually uses it. On the other hand, it has to be called
5560 % after \pchapsepmacro, or the headline will change too soon.
5561 \gdef\lastsection{#1}%
5563 % Only insert the separating space if we have a chapter/appendix
5564 % number, and don't print the unnumbered ``number''.
5565 \ifx\temptype\Ynothingkeyword
5567 \def\toctype{unnchap}%
5568 \else\ifx\temptype\Yomitfromtockeyword
5569 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5571 \else\ifx\temptype\Yappendixkeyword
5572 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5575 \setbox0 = \hbox{#3\enspace}%
5576 \def\toctype{numchap}%
5579 % Write the toc entry for this chapter. Must come before the
5580 % \donoderef, because we include the current node name in the toc
5581 % entry, and \donoderef resets it to empty.
5582 \writetocentry{\toctype}{#1}{#3}%
5584 % For pdftex, we have to write out the node definition (aka, make
5585 % the pdfdest) after any page break, but before the actual text has
5586 % been typeset. If the destination for the pdf outline is after the
5587 % text, then jumping from the outline may wind up with the text not
5588 % being visible, for instance under high magnification.
5591 % Typeset the actual heading.
5592 \nobreak % Avoid page breaks at the interline glue.
5593 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5594 \hangindent=\wd0 \centerparametersmaybe
5597 \nobreak\bigskip % no page break after a chapter title
5601 % @centerchap -- centered and unnumbered.
5602 \let\centerparametersmaybe = \relax
5603 \def\centerparameters{%
5604 \advance\rightskip by 3\rightskip
5605 \leftskip = \rightskip
5610 % I don't think this chapter style is supported any more, so I'm not
5611 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5613 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5615 \def\unnchfopen #1{%
5616 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5617 \parindent=0pt\ptexraggedright
5618 \rmisbold #1\hfill}}\bigskip \par\nobreak
5620 \def\chfopen #1#2{\chapoddpage {\chapfonts
5621 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5624 \def\centerchfopen #1{%
5625 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5627 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5630 \global\let\chapmacro=\chfopen
5631 \global\let\centerchapmacro=\centerchfopen}
5634 % Section titles. These macros combine the section number parts and
5635 % call the generic \sectionheading to do the printing.
5637 \newskip\secheadingskip
5638 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5640 % Subsection titles.
5641 \newskip\subsecheadingskip
5642 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5644 % Subsubsection titles.
5645 \def\subsubsecheadingskip{\subsecheadingskip}
5646 \def\subsubsecheadingbreak{\subsecheadingbreak}
5649 % Print any size, any type, section title.
5651 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5652 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5655 \def\seckeyword{sec}
5657 \def\sectionheading#1#2#3#4{%
5659 % Switch to the right set of fonts.
5660 \csname #2fonts\endcsname \rmisbold
5662 \def\sectionlevel{#2}%
5665 % Insert first mark before the heading break (see notes for \domark).
5666 \let\prevsectiondefs=\lastsectiondefs
5667 \ifx\temptype\Ynothingkeyword
5668 \ifx\sectionlevel\seckeyword
5669 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5670 \gdef\thissection{\thissectionname}}%
5672 \else\ifx\temptype\Yomitfromtockeyword
5673 % Don't redefine \thissection.
5674 \else\ifx\temptype\Yappendixkeyword
5675 \ifx\sectionlevel\seckeyword
5677 \xdef\lastsectiondefs{%
5678 \gdef\noexpand\thissectionname{\the\toks0}%
5679 \gdef\noexpand\thissectionnum{#4}%
5680 % \noexpand\putwordSection avoids expanding indigestible
5681 % commands in some of the translations.
5682 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5683 \noexpand\thissectionnum:
5684 \noexpand\thissectionname}%
5688 \ifx\sectionlevel\seckeyword
5690 \xdef\lastsectiondefs{%
5691 \gdef\noexpand\thissectionname{\the\toks0}%
5692 \gdef\noexpand\thissectionnum{#4}%
5693 % \noexpand\putwordSection avoids expanding indigestible
5694 % commands in some of the translations.
5695 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5696 \noexpand\thissectionnum:
5697 \noexpand\thissectionname}%
5702 % Go into vertical mode. Usually we'll already be there, but we
5703 % don't want the following whatsit to end up in a preceding paragraph
5704 % if the document didn't happen to have a blank line.
5707 % Output the mark. Pass it through \safewhatsit, to take care of
5708 % the preceding space.
5711 % Insert space above the heading.
5712 \csname #2headingbreak\endcsname
5714 % Now the second mark, after the heading break. No break points
5715 % between here and the heading.
5716 \let\prevsectiondefs=\lastsectiondefs
5719 % Only insert the space after the number if we have a section number.
5720 \ifx\temptype\Ynothingkeyword
5723 \gdef\lastsection{#1}%
5724 \else\ifx\temptype\Yomitfromtockeyword
5725 % for @headings -- no section number, don't include in toc,
5726 % and don't redefine \lastsection.
5729 \let\sectionlevel=\empty
5730 \else\ifx\temptype\Yappendixkeyword
5731 \setbox0 = \hbox{#4\enspace}%
5733 \gdef\lastsection{#1}%
5735 \setbox0 = \hbox{#4\enspace}%
5737 \gdef\lastsection{#1}%
5740 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5741 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5743 % Write the node reference (= pdf destination for pdftex).
5744 % Again, see comments in \chapmacro.
5747 % Interline glue will be inserted when the vbox is completed.
5748 % That glue will be a valid breakpoint for the page, since it'll be
5749 % preceded by a whatsit (usually from the \donoderef, or from the
5750 % \writetocentry if there was no node). We don't want to allow that
5751 % break, since then the whatsits could end up on page n while the
5752 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5755 % Output the actual section heading.
5756 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5757 \hangindent=\wd0 % zero if no section number
5760 % Add extra space after the heading -- half of whatever came above it.
5761 % Don't allow stretch, though.
5762 \kern .5 \csname #2headingskip\endcsname
5764 % Do not let the kern be a potential breakpoint, as it would be if it
5765 % was followed by glue.
5768 % We'll almost certainly start a paragraph next, so don't let that
5769 % glue accumulate. (Not a breakpoint because it's preceded by a
5770 % discardable item.)
5773 % This is purely so the last item on the list is a known \penalty >
5774 % 10000. This is so \startdefun can avoid allowing breakpoints after
5775 % section headings. Otherwise, it would insert a valid breakpoint between:
5777 % @section sec-whatever
5778 % @deffn def-whatever
5784 % Table of contents.
5787 % Write an entry to the toc file, opening it if necessary.
5788 % Called from @chapter, etc.
5790 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5791 % We append the current node name (if any) and page number as additional
5792 % arguments for the \{chap,sec,...}entry macros which will eventually
5793 % read this. The node name is used in the pdf outlines as the
5794 % destination to jump to.
5796 % We open the .toc file for writing here instead of at @setfilename (or
5797 % any other fixed time) so that @contents can be anywhere in the document.
5798 % But if #1 is `omit', then we don't do anything. This is used for the
5799 % table of contents chapter openings themselves.
5801 \newif\iftocfileopened
5802 \def\omitkeyword{omit}%
5804 \def\writetocentry#1#2#3{%
5805 \edef\writetoctype{#1}%
5806 \ifx\writetoctype\omitkeyword \else
5807 \iftocfileopened\else
5808 \immediate\openout\tocfile = \jobname.toc
5809 \global\tocfileopenedtrue
5815 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5821 % Tell \shipout to create a pdf destination on each page, if we're
5822 % writing pdf. These are used in the table of contents. We can't
5823 % just write one on every page because the title pages are numbered
5824 % 1 and 2 (the page numbers aren't printed), and so are the first
5825 % two pages of the document. Thus, we'd have two destinations named
5826 % `1', and two named `2'.
5827 \ifpdf \global\pdfmakepagedesttrue \fi
5831 % These characters do not print properly in the Computer Modern roman
5832 % fonts, so we must take special care. This is more or less redundant
5833 % with the Texinfo input format setup at the end of this file.
5835 \def\activecatcodes{%
5848 % Read the toc file, which is essentially Texinfo input.
5852 \input \tocreadfilename
5855 \newskip\contentsrightmargin \contentsrightmargin=1in
5856 \newcount\savepageno
5857 \newcount\lastnegativepageno \lastnegativepageno = -1
5859 % Prepare to read what we've written to \tocfile.
5861 \def\startcontents#1{%
5862 % If @setchapternewpage on, and @headings double, the contents should
5863 % start on an odd page, unlike chapters. Thus, we maintain
5864 % \contentsalignmacro in parallel with \pagealignmacro.
5865 % From: Torbjorn Granlund <tege@matematik.su.se>
5867 \immediate\closeout\tocfile
5869 % Don't need to put `Contents' or `Short Contents' in the headline.
5870 % It is abundantly clear what they are.
5871 \chapmacro{#1}{Yomitfromtoc}{}%
5873 \savepageno = \pageno
5874 \begingroup % Set up to handle contents files properly.
5875 \raggedbottom % Worry more about breakpoints than the bottom.
5876 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5878 % Roman numerals for page numbers.
5879 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5882 % redefined for the two-volume lispref. We always output on
5883 % \jobname.toc even if this is redefined.
5885 \def\tocreadfilename{\jobname.toc}
5887 % Normal (long) toc.
5890 \startcontents{\putwordTOC}%
5891 \openin 1 \tocreadfilename\space
5896 \contentsalignmacro % in case @setchapternewpage odd is in effect
5902 \lastnegativepageno = \pageno
5903 \global\pageno = \savepageno
5906 % And just the chapters.
5907 \def\summarycontents{%
5908 \startcontents{\putwordShortTOC}%
5910 \let\partentry = \shortpartentry
5911 \let\numchapentry = \shortchapentry
5912 \let\appentry = \shortchapentry
5913 \let\unnchapentry = \shortunnchapentry
5914 % We want a true roman here for the page numbers.
5916 \let\rm=\shortcontrm \let\bf=\shortcontbf
5917 \let\sl=\shortcontsl \let\tt=\shortconttt
5919 \hyphenpenalty = 10000
5920 \advance\baselineskip by 1pt % Open it up a little.
5921 \def\numsecentry##1##2##3##4{}
5922 \let\appsecentry = \numsecentry
5923 \let\unnsecentry = \numsecentry
5924 \let\numsubsecentry = \numsecentry
5925 \let\appsubsecentry = \numsecentry
5926 \let\unnsubsecentry = \numsecentry
5927 \let\numsubsubsecentry = \numsecentry
5928 \let\appsubsubsecentry = \numsecentry
5929 \let\unnsubsubsecentry = \numsecentry
5930 \openin 1 \tocreadfilename\space
5936 \contentsalignmacro % in case @setchapternewpage odd is in effect
5938 \lastnegativepageno = \pageno
5939 \global\pageno = \savepageno
5941 \let\shortcontents = \summarycontents
5943 % Typeset the label for a chapter or appendix for the short contents.
5944 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5946 \def\shortchaplabel#1{%
5947 % This space should be enough, since a single number is .5em, and the
5948 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5949 % But use \hss just in case.
5950 % (This space doesn't include the extra space that gets added after
5951 % the label; that gets put in by \shortchapentry above.)
5953 % We'd like to right-justify chapter numbers, but that looks strange
5954 % with appendix letters. And right-justifying numbers and
5955 % left-justifying letters looks strange when there is less than 10
5956 % chapters. Have to read the whole toc once to know how many chapters
5957 % there are before deciding ...
5958 \hbox to 1em{#1\hss}%
5961 % These macros generate individual entries in the table of contents.
5962 % The first argument is the chapter or section name.
5963 % The last argument is the page number.
5964 % The arguments in between are the chapter number, section number, ...
5966 % Parts, in the main contents. Replace the part number, which doesn't
5967 % exist, with an empty box. Let's hope all the numbers have the same width.
5968 % Also ignore the page number, which is conventionally not printed.
5969 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
5970 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
5972 % Parts, in the short toc.
5973 \def\shortpartentry#1#2#3#4{%
5975 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
5976 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
5979 % Chapters, in the main contents.
5980 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5982 % Chapters, in the short toc.
5983 % See comments in \dochapentry re vbox and related settings.
5984 \def\shortchapentry#1#2#3#4{%
5985 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5988 % Appendices, in the main contents.
5989 % Need the word Appendix, and a fixed-size box.
5991 \def\appendixbox#1{%
5992 % We use M since it's probably the widest letter.
5993 \setbox0 = \hbox{\putwordAppendix{} M}%
5994 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5996 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5998 % Unnumbered chapters.
5999 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6000 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6003 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6004 \let\appsecentry=\numsecentry
6005 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6008 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6009 \let\appsubsecentry=\numsubsecentry
6010 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6012 % And subsubsections.
6013 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6014 \let\appsubsubsecentry=\numsubsubsecentry
6015 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6017 % This parameter controls the indentation of the various levels.
6018 % Same as \defaultparindent.
6019 \newdimen\tocindent \tocindent = 15pt
6021 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6024 % If the toc has to be broken over pages, we want it to be at chapters
6025 % if at all possible; hence the \penalty.
6026 \def\dochapentry#1#2{%
6027 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6030 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6032 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6035 \def\dosecentry#1#2{\begingroup
6036 \secentryfonts \leftskip=\tocindent
6037 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6040 \def\dosubsecentry#1#2{\begingroup
6041 \subsecentryfonts \leftskip=2\tocindent
6042 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6045 \def\dosubsubsecentry#1#2{\begingroup
6046 \subsubsecentryfonts \leftskip=3\tocindent
6047 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6050 % We use the same \entry macro as for the index entries.
6051 \let\tocentry = \entry
6053 % Space between chapter (or whatever) number and the title.
6054 \def\labelspace{\hskip1em \relax}
6056 \def\dopageno#1{{\rm #1}}
6057 \def\doshortpageno#1{{\rm #1}}
6059 \def\chapentryfonts{\secfonts \rm}
6060 \def\secentryfonts{\textfonts}
6061 \def\subsecentryfonts{\textfonts}
6062 \def\subsubsecentryfonts{\textfonts}
6065 \message{environments,}
6066 % @foo ... @end foo.
6068 % @tex ... @end tex escapes into raw TeX temporarily.
6069 % One exception: @ is still an escape character, so that @end tex works.
6070 % But \@ or @@ will get a plain @ character.
6073 \setupmarkupstyle{tex}%
6074 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6075 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6076 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6087 % ' is active in math mode (mathcode"8000). So reset it, and all our
6088 % other math active characters (just in case), to plain's definitions.
6092 \let\bullet=\ptexbullet
6097 \let\equiv=\ptexequiv
6100 \let\indent=\ptexindent
6101 \let\noindent=\ptexnoindent
6108 \expandafter \let\csname top\endcsname=\ptextop % outer
6109 \let\frenchspacing=\plainfrenchspacing
6111 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6112 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6115 % There is no need to define \Etex.
6117 % Define @lisp ... @end lisp.
6118 % @lisp environment forms a group so it can rebind things,
6119 % including the definition of @end lisp (which normally is erroneous).
6121 % Amount to narrow the margins by for @lisp.
6122 \newskip\lispnarrowing \lispnarrowing=0.4in
6124 % This is the definition that ^^M gets inside @lisp, @example, and other
6125 % such environments. \null is better than a space, since it doesn't
6127 \def\lisppar{\null\endgraf}
6129 % This space is always present above and below environments.
6130 \newskip\envskipamount \envskipamount = 0pt
6132 % Make spacing and below environment symmetrical. We use \parskip here
6133 % to help in doing that, since in @example-like environments \parskip
6134 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6135 % start of the next paragraph will insert \parskip.
6137 \def\aboveenvbreak{{%
6138 % =10000 instead of <10000 because of a special case in \itemzzz and
6139 % \sectionheading, q.v.
6140 \ifnum \lastpenalty=10000 \else
6141 \advance\envskipamount by \parskip
6143 \ifdim\lastskip<\envskipamount
6145 % it's not a good place to break if the last penalty was \nobreak
6147 \ifnum\lastpenalty<10000 \penalty-50 \fi
6148 \vskip\envskipamount
6153 \let\afterenvbreak = \aboveenvbreak
6155 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6156 % also clear it, so that its embedded environments do the narrowing again.
6157 \let\nonarrowing=\relax
6159 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6160 % environment contents.
6161 \font\circle=lcircle10
6163 \newdimen\cartouter\newdimen\cartinner
6164 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6165 \circthick=\fontdimen8\circle
6167 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6168 \def\ctr{{\hskip 6pt\circle\char'010}}
6169 \def\cbl{{\circle\char'012\hskip -6pt}}
6170 \def\cbr{{\hskip 6pt\circle\char'011}}
6171 \def\carttop{\hbox to \cartouter{\hskip\lskip
6172 \ctl\leaders\hrule height\circthick\hfil\ctr
6174 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6175 \cbl\leaders\hrule height\circthick\hfil\cbr
6178 \newskip\lskip\newskip\rskip
6181 \ifhmode\par\fi % can't be in the midst of a paragraph.
6183 \lskip=\leftskip \rskip=\rightskip
6184 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6185 \cartinner=\hsize \advance\cartinner by-\lskip
6186 \advance\cartinner by-\rskip
6188 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6189 % side, and for 6pt waste from
6190 % each corner char, and rule thickness
6191 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6192 % Flag to tell @lisp, etc., not to narrow margin.
6193 \let\nonarrowing = t%
6195 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6203 \baselineskip=\normbskip
6204 \lineskip=\normlskip
6207 \comment % For explanation, see the end of \def\group.
6222 % This macro is called at the beginning of all the @example variants,
6224 \newdimen\nonfillparindent
6227 \hfuzz = 12pt % Don't be fussy
6228 \sepspaces % Make spaces be word-separators rather than space tokens.
6229 \let\par = \lisppar % don't ignore blank lines
6230 \obeylines % each line of input is a line of output
6232 % Turn off paragraph indentation but redefine \indent to emulate
6233 % the normal \indent.
6234 \nonfillparindent=\parindent
6236 \let\indent\nonfillindent
6238 \emergencystretch = 0pt % don't try to avoid overfull boxes
6239 \ifx\nonarrowing\relax
6240 \advance \leftskip by \lispnarrowing
6241 \exdentamount=\lispnarrowing
6243 \let\nonarrowing = \relax
6245 \let\exdent=\nofillexdent
6250 % We want to swallow spaces (but not other tokens) after the fake
6251 % @indent in our nonfill-environments, where spaces are normally
6252 % active and set to @tie, resulting in them not being ignored after
6254 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6255 \gdef\nonfillindentcheck{%
6257 \expandafter\nonfillindentgobble%
6259 \leavevmode\nonfillindentbox%
6263 \def\nonfillindentgobble#1{\nonfillindent}
6264 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6266 % If you want all examples etc. small: @set dispenvsize small.
6267 % If you want even small examples the full size: @set dispenvsize nosmall.
6268 % This affects the following displayed environments:
6269 % @example, @display, @format, @lisp
6271 \def\smallword{small}
6272 \def\nosmallword{nosmall}
6273 \let\SETdispenvsize\relax
6274 \def\setnormaldispenv{%
6275 \ifx\SETdispenvsize\smallword
6276 % end paragraph for sake of leading, in case document has no blank
6277 % line. This is redundant with what happens in \aboveenvbreak, but
6278 % we need to do it before changing the fonts, and it's inconvenient
6279 % to change the fonts afterward.
6280 \ifnum \lastpenalty=10000 \else \endgraf \fi
6281 \smallexamplefonts \rm
6284 \def\setsmalldispenv{%
6285 \ifx\SETdispenvsize\nosmallword
6287 \ifnum \lastpenalty=10000 \else \endgraf \fi
6288 \smallexamplefonts \rm
6292 % We often define two environments, @foo and @smallfoo.
6293 % Let's do it in one command. #1 is the env name, #2 the definition.
6294 \def\makedispenvdef#1#2{%
6295 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6296 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6297 \expandafter\let\csname E#1\endcsname \afterenvbreak
6298 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6301 % Define two environment synonyms (#1 and #2) for an environment.
6302 \def\maketwodispenvdef#1#2#3{%
6303 \makedispenvdef{#1}{#3}%
6304 \makedispenvdef{#2}{#3}%
6307 % @lisp: indented, narrowed, typewriter font;
6308 % @example: same as @lisp.
6310 % @smallexample and @smalllisp: use smaller fonts.
6311 % Originally contributed by Pavel@xerox.
6313 \maketwodispenvdef{lisp}{example}{%
6315 \tt\setupmarkupstyle{example}%
6316 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6317 \gobble % eat return
6319 % @display/@smalldisplay: same as @lisp except keep current font.
6321 \makedispenvdef{display}{%
6326 % @format/@smallformat: same as @display except don't narrow margins.
6328 \makedispenvdef{format}{%
6329 \let\nonarrowing = t%
6334 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6336 \let\nonarrowing = t%
6340 \let\Eflushleft = \afterenvbreak
6344 \envdef\flushright{%
6345 \let\nonarrowing = t%
6347 \advance\leftskip by 0pt plus 1fill\relax
6350 \let\Eflushright = \afterenvbreak
6353 % @raggedright does more-or-less normal line breaking but no right
6354 % justification. From plain.tex.
6355 \envdef\raggedright{%
6356 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6358 \let\Eraggedright\par
6360 \envdef\raggedleft{%
6361 \parindent=0pt \leftskip0pt plus2em
6362 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6363 \hbadness=10000 % Last line will usually be underfull, so turn off
6364 % badness reporting.
6366 \let\Eraggedleft\par
6368 \envdef\raggedcenter{%
6369 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6370 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6371 \hbadness=10000 % Last line will usually be underfull, so turn off
6372 % badness reporting.
6374 \let\Eraggedcenter\par
6377 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6378 % and narrows the margins. We keep \parskip nonzero in general, since
6379 % we're doing normal filling. So, when using \aboveenvbreak and
6380 % \afterenvbreak, temporarily make \parskip 0.
6382 \makedispenvdef{quotation}{\quotationstart}
6384 \def\quotationstart{%
6385 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6388 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6389 \ifx\nonarrowing\relax
6390 \advance\leftskip by \lispnarrowing
6391 \advance\rightskip by \lispnarrowing
6392 \exdentamount = \lispnarrowing
6394 \let\nonarrowing = \relax
6396 \parsearg\quotationlabel
6399 % We have retained a nonzero parskip for the environment, since we're
6400 % doing normal filling.
6404 \ifx\quotationauthor\undefined\else
6406 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6408 {\parskip=0pt \afterenvbreak}%
6410 \def\Esmallquotation{\Equotation}
6412 % If we're given an argument, typeset it in bold with a colon after.
6413 \def\quotationlabel#1{%
6415 \ifx\temp\empty \else
6421 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6422 % If we want to allow any <char> as delimiter,
6423 % we need the curly braces so that makeinfo sees the @verb command, eg:
6424 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6426 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6428 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6429 % active too. Otherwise, they get lost as the first character on a
6432 \do\ \do\\\do\{\do\}\do\$\do\&%
6433 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6434 \do\<\do\>\do\|\do\@\do+\do\"%
6435 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6436 % @set txicodequotebacktick will not have effect on @verb and
6437 % @verbatim, and ?` and !` ligatures won't get disabled.
6442 \def\uncatcodespecials{%
6443 \def\do##1{\catcode`##1=\other}\dospecials}
6445 % Setup for the @verb command.
6447 % Eight spaces for a tab
6449 \catcode`\^^I=\active
6450 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6454 \tt % easiest (and conventionally used) font for verbatim
6455 \def\par{\leavevmode\endgraf}%
6456 \setupmarkupstyle{verb}%
6458 % Respect line breaks,
6459 % print special symbols as themselves, and
6460 % make each space count
6461 % must do in this order:
6462 \obeylines \uncatcodespecials \sepspaces
6465 % Setup for the @verbatim environment
6467 % Real tab expansion.
6468 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6470 % We typeset each line of the verbatim in an \hbox, so we can handle
6471 % tabs. The \global is in case the verbatim line starts with an accent,
6472 % or some other command that starts with a begin-group. Otherwise, the
6473 % entire \verbbox would disappear at the corresponding end-group, before
6474 % it is typeset. Meanwhile, we can't have nested verbatim commands
6475 % (can we?), so the \global won't be overwriting itself.
6477 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6480 \catcode`\^^I=\active
6482 \catcode`\^^I=\active
6483 \def^^I{\leavevmode\egroup
6484 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6485 \divide\dimen\verbbox by\tabw
6486 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6487 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6488 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6493 % start the verbatim environment.
6494 \def\setupverbatim{%
6495 \let\nonarrowing = t%
6497 \tt % easiest (and conventionally used) font for verbatim
6498 % The \leavevmode here is for blank lines. Otherwise, we would
6499 % never \starttabox and the \egroup would end verbatim mode.
6500 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6502 \setupmarkupstyle{verbatim}%
6503 % Respect line breaks,
6504 % print special symbols as themselves, and
6505 % make each space count.
6506 % Must do in this order:
6507 \obeylines \uncatcodespecials \sepspaces
6508 \everypar{\starttabbox}%
6511 % Do the @verb magic: verbatim text is quoted by unique
6512 % delimiter characters. Before first delimiter expect a
6513 % right brace, after last delimiter expect closing brace:
6515 % \def\doverb'{'<char>#1<char>'}'{#1}
6517 % [Knuth] p. 382; only eat outer {}
6519 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6520 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6523 \def\verb{\begingroup\setupverb\doverb}
6526 % Do the @verbatim magic: define the macro \doverbatim so that
6527 % the (first) argument ends when '@end verbatim' is reached, ie:
6529 % \def\doverbatim#1@end verbatim{#1}
6531 % For Texinfo it's a lot easier than for LaTeX,
6532 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6533 % we need not redefine '\', '{' and '}'.
6535 % Inspired by LaTeX's verbatim command set [latex.ltx]
6540 % ignore everything up to the first ^^M, that's the newline at the end
6541 % of the @verbatim input line itself. Otherwise we get an extra blank
6542 % line in the output.
6543 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6544 % We really want {...\end verbatim} in the body of the macro, but
6545 % without the active space; thus we have to use \xdef and \gobble.
6549 \setupverbatim\doverbatim
6551 \let\Everbatim = \afterenvbreak
6554 % @verbatiminclude FILE - insert text of file in verbatim environment.
6556 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6558 \def\doverbatiminclude#1{%
6560 \makevalueexpandable
6562 \indexnofonts % Allow `@@' and other weird things in file names.
6563 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6569 % @copying ... @end copying.
6570 % Save the text away for @insertcopying later.
6572 % We save the uninterpreted tokens, rather than creating a box.
6573 % Saving the text in a box would be much easier, but then all the
6574 % typesetting commands (@smallbook, font changes, etc.) have to be done
6575 % beforehand -- and a) we want @copying to be done first in the source
6576 % file; b) letting users define the frontmatter in as flexible order as
6577 % possible is very desirable.
6579 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6580 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6582 \def\insertcopying{%
6584 \parindent = 0pt % paragraph indentation looks wrong on title page
6585 \scanexp\copyingtext
6593 \newskip\defbodyindent \defbodyindent=.4in
6594 \newskip\defargsindent \defargsindent=50pt
6595 \newskip\deflastargmargin \deflastargmargin=18pt
6596 \newcount\defunpenalty
6598 % Start the processing of @deffn:
6600 \ifnum\lastpenalty<10000
6602 \defunpenalty=10003 % Will keep this @deffn together with the
6603 % following @def command, see below.
6605 % If there are two @def commands in a row, we'll have a \nobreak,
6606 % which is there to keep the function description together with its
6607 % header. But if there's nothing but headers, we need to allow a
6608 % break somewhere. Check specifically for penalty 10002, inserted
6609 % by \printdefunline, instead of 10000, since the sectioning
6610 % commands also insert a nobreak penalty, and we don't want to allow
6611 % a break between a section heading and a defun.
6613 % As a minor refinement, we avoid "club" headers by signalling
6614 % with penalty of 10003 after the very first @deffn in the
6615 % sequence (see above), and penalty of 10002 after any following
6617 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6619 % Similarly, after a section heading, do not allow a break.
6620 % But do insert the glue.
6621 \medskip % preceded by discardable penalty, so not a breakpoint
6625 \advance\leftskip by \defbodyindent
6626 \exdentamount=\defbodyindent
6630 % First, check whether we are in the right environment:
6633 % As above, allow line break if we have multiple x headers in a row.
6634 % It's not a great place, though.
6635 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6637 % And now, it's time to reuse the body of the original defun:
6638 \expandafter\gobbledefun#1%
6640 \def\gobbledefun#1\startdefun{}
6642 % \printdefunline \deffnheader{text}
6644 \def\printdefunline#1#2{%
6646 % call \deffnheader:
6649 \interlinepenalty = 10000
6650 \advance\rightskip by 0pt plus 1fil\relax
6652 \nobreak\vskip -\parskip
6653 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6654 % Some of the @defun-type tags do not enable magic parentheses,
6655 % rendering the following check redundant. But we don't optimize.
6660 \def\Edefun{\endgraf\medbreak}
6662 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6663 % the only thing remaining is to define \deffnheader.
6666 \expandafter\let\csname E#1\endcsname = \Edefun
6667 \edef\temp{\noexpand\domakedefun
6668 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6672 % \domakedefun \deffn \deffnx \deffnheader
6674 % Define \deffn and \deffnx, without parameters.
6675 % \deffnheader has to be defined explicitly.
6677 \def\domakedefun#1#2#3{%
6680 \parseargusing\activeparens{\printdefunline#3}%
6682 \def#2{\dodefunx#1}%
6686 %%% Untyped functions:
6688 % @deffn category name args
6689 \makedefun{deffn}{\deffngeneral{}}
6691 % @deffn category class name args
6692 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6694 % \defopon {category on}class name args
6695 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6697 % \deffngeneral {subind}category name args
6699 \def\deffngeneral#1#2 #3 #4\endheader{%
6700 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6701 \dosubind{fn}{\code{#3}}{#1}%
6702 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6705 %%% Typed functions:
6707 % @deftypefn category type name args
6708 \makedefun{deftypefn}{\deftypefngeneral{}}
6710 % @deftypeop category class type name args
6711 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6713 % \deftypeopon {category on}class type name args
6714 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6716 % \deftypefngeneral {subind}category type name args
6718 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6719 \dosubind{fn}{\code{#4}}{#1}%
6720 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6723 %%% Typed variables:
6725 % @deftypevr category type var args
6726 \makedefun{deftypevr}{\deftypecvgeneral{}}
6728 % @deftypecv category class type var args
6729 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6731 % \deftypecvof {category of}class type var args
6732 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6734 % \deftypecvgeneral {subind}category type var args
6736 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6737 \dosubind{vr}{\code{#4}}{#1}%
6738 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6741 %%% Untyped variables:
6743 % @defvr category var args
6744 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6746 % @defcv category class var args
6747 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6749 % \defcvof {category of}class var args
6750 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6753 % @deftp category name args
6754 \makedefun{deftp}#1 #2 #3\endheader{%
6755 \doind{tp}{\code{#2}}%
6756 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6759 % Remaining @defun-like shortcuts:
6760 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6761 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6762 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6763 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6764 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6765 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6766 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6767 \makedefun{defmethod}{\defopon\putwordMethodon}
6768 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6769 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6770 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6772 % \defname, which formats the name of the @def (not the args).
6773 % #1 is the category, such as "Function".
6774 % #2 is the return type, if any.
6775 % #3 is the function name.
6777 % We are followed by (but not passed) the arguments, if any.
6779 \def\defname#1#2#3{%
6780 % Get the values of \leftskip and \rightskip as they were outside the @def...
6781 \advance\leftskip by -\defbodyindent
6783 % How we'll format the type name. Putting it in brackets helps
6784 % distinguish it from the body text that may end up on the next line
6787 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6789 % Figure out line sizes for the paragraph shape.
6790 % The first line needs space for \box0; but if \rightskip is nonzero,
6791 % we need only space for the part of \box0 which exceeds it:
6792 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6793 % The continuations:
6794 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6795 % (plain.tex says that \dimen1 should be used only as global.)
6796 \parshape 2 0in \dimen0 \defargsindent \dimen2
6798 % Put the type name to the right margin.
6801 \hfil\box0 \kern-\hsize
6802 % \hsize has to be shortened this way:
6804 % Intentionally do not respect \rightskip, since we need the space.
6807 % Allow all lines to be underfull without complaint:
6808 \tolerance=10000 \hbadness=10000
6809 \exdentamount=\defbodyindent
6811 % defun fonts. We use typewriter by default (used to be bold) because:
6812 % . we're printing identifiers, they should be in tt in principle.
6813 % . in languages with many accents, such as Czech or French, it's
6814 % common to leave accents off identifiers. The result looks ok in
6815 % tt, but exceedingly strange in rm.
6816 % . we don't want -- and --- to be treated as ligatures.
6817 % . this still does not fix the ?` and !` ligatures, but so far no
6818 % one has made identifiers using them :).
6820 \def\temp{#2}% return value type
6821 \ifx\temp\empty\else \tclose{\temp} \fi
6822 #3% output function name
6824 {\rm\enskip}% hskip 0.5 em of \tenrm
6827 % arguments will be output next, if any.
6830 % Print arguments in slanted roman (not ttsl), inconsistently with using
6831 % tt for the name. This is because literal text is sometimes needed in
6832 % the argument list (groff manual), and ttsl and tt are not very
6833 % distinguishable. Prevent hyphenation at `-' chars.
6836 % use sl by default (not ttsl),
6838 \df \sl \hyphenchar\font=0
6840 % On the other hand, if an argument has two dashes (for instance), we
6841 % want a way to get ttsl. Let's try @var for that.
6842 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6844 \sl\hyphenchar\font=45
6847 % We want ()&[] to print specially on the defun line.
6850 \catcode`\(=\active \catcode`\)=\active
6851 \catcode`\[=\active \catcode`\]=\active
6855 % Make control sequences which act like normal parenthesis chars.
6856 \let\lparen = ( \let\rparen = )
6858 % Be sure that we always have a definition for `(', etc. For example,
6859 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6860 % so TeX would otherwise complain about undefined control sequence.
6863 \global\let(=\lparen \global\let)=\rparen
6864 \global\let[=\lbrack \global\let]=\rbrack
6867 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6868 \gdef\magicamp{\let&=\amprm}
6871 \newcount\parencount
6873 % If we encounter &foo, then turn on ()-hacking afterwards
6875 \def\amprm#1 {\ampseentrue{\bf\ }}
6879 % At the first level, print parens in roman,
6880 % otherwise use the default font.
6881 \ifnum \parencount=1 \rm \fi
6883 % The \sf parens (in \boldbrax) actually are a little bolder than
6884 % the contained text. This is especially needed for [ and ] .
6888 \def\infirstlevel#1{%
6895 \def\bfafterword#1 {#1 \bf}
6898 \global\advance\parencount by 1
6900 \infirstlevel \bfafterword
6905 \global\advance\parencount by -1
6908 \newcount\brackcount
6910 \global\advance\brackcount by 1
6915 \global\advance\brackcount by -1
6918 \def\checkparencounts{%
6919 \ifnum\parencount=0 \else \badparencount \fi
6920 \ifnum\brackcount=0 \else \badbrackcount \fi
6922 % these should not use \errmessage; the glibc manual, at least, actually
6923 % has such constructs (when documenting function pointers).
6924 \def\badparencount{%
6925 \message{Warning: unbalanced parentheses in @def...}%
6926 \global\parencount=0
6928 \def\badbrackcount{%
6929 \message{Warning: unbalanced square brackets in @def...}%
6930 \global\brackcount=0
6937 % To do this right we need a feature of e-TeX, \scantokens,
6938 % which we arrange to emulate with a temporary file in ordinary TeX.
6939 \ifx\eTeXversion\undefined
6940 \newwrite\macscribble
6943 \immediate\openout\macscribble=\jobname.tmp
6944 \immediate\write\macscribble{\the\toks0}%
6945 \immediate\closeout\macscribble
6950 \def\scanmacro#1{\begingroup
6952 \let\xeatspaces\eatspaces
6954 % Undo catcode changes of \startcontents and \doprintindex
6955 % When called from @insertcopying or (short)caption, we need active
6956 % backslash to get it printed correctly. Previously, we had
6957 % \catcode`\\=\other instead. We'll see whether a problem appears
6958 % with macro expansion. --kasal, 19aug04
6959 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6961 % ... and for \example:
6964 % The \empty here causes a following catcode 5 newline to be eaten
6965 % as part of reading whitespace after a control sequence. It does
6966 % not eat a catcode 13 newline. There's no good way to handle the
6967 % two cases. See the Macro Details node in the manual for the
6968 % workaround we currently have to recommend for macros and
6969 % line-oriented commands.
6970 \scantokens{#1\empty}%
6974 \edef\temp{\noexpand\scanmacro{#1}}%
6978 \newcount\paramno % Count of parameters
6979 \newtoks\macname % Macro name
6980 \newif\ifrecursive % Is it recursive?
6982 % List of all defined macros in the form
6983 % \definedummyword\macro1\definedummyword\macro2...
6984 % Currently is also contains all @aliases; the list can be split
6985 % if there is a need.
6988 % Add the macro to \macrolist
6989 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6990 \def\addtomacrolistxxx#1{%
6991 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6992 \xdef\macrolist{\the\toks0}%
6996 % This does \let #1 = #2, with \csnames; that is,
6997 % \let \csname#1\endcsname = \csname#2\endcsname
6998 % (except of course we have to play expansion games).
7002 \csname#1\expandafter\endcsname
7006 % Trim leading and trailing spaces off a string.
7007 % Concepts from aro-bend problem 15 (see CTAN).
7009 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7010 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7011 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7013 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7016 % Trim a single trailing ^^M off a string.
7017 {\catcode`\^^M=\other \catcode`\Q=3%
7018 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7019 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7020 \gdef\eatcrb#1Q#2Q{#1}%
7023 % Macro bodies are absorbed as an argument in a context where
7024 % all characters are catcode 10, 11 or 12, except \ which is active
7025 % (as in normal texinfo). It is necessary to change the definition of \
7026 % to recognize macro arguments; this is the job of \mbodybackslash.
7028 % Non-ASCII encodings make 8-bit characters active, so un-activate
7029 % them to avoid their expansion. Must do this non-globally, to
7030 % confine the change to the current group.
7032 % It's necessary to have hard CRs when the macro is executed. This is
7033 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7034 % body, and then making it the \newlinechar in \scanmacro.
7036 \def\scanctxt{% used as subroutine
7046 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7049 \def\scanargctxt{% used for copying and captions, not macros.
7052 \catcode`\^^M=\other
7055 \def\macrobodyctxt{% used for @macro definitions
7059 \catcode`\^^M=\other
7063 \def\macroargctxt{% used when scanning invocations
7067 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7068 % for the single characters \ { }. Thus, we end up with the "commands"
7069 % that would be written @\ @{ @} in a Texinfo document.
7071 % We already have @{ and @}. For @\, we define it here, and only for
7072 % this purpose, to produce a typewriter backslash (so, the @\ that we
7073 % define for @math can't be used with @macro calls):
7075 \def\\{\normalbackslash}%
7077 % We would like to do this for \, too, since that is what makeinfo does.
7078 % But it is not possible, because Texinfo already has a command @, for a
7079 % cedilla accent. Documents must use @comma{} instead.
7081 % \anythingelse will almost certainly be an error of some kind.
7084 % \mbodybackslash is the definition of \ in @macro bodies.
7085 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7086 % where N is the macro parameter number.
7087 % We define \csname macarg.\endcsname to be \realbackslash, so
7088 % \\ in macro replacement text gets you a backslash.
7090 {\catcode`@=0 @catcode`@\=@active
7091 @gdef@usembodybackslash{@let\=@mbodybackslash}
7092 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7094 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7096 \def\margbackslash#1{\char`\#1 }
7098 \def\macro{\recursivefalse\parsearg\macroxxx}
7099 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7102 \getargs{#1}% now \macname is the macname and \argl the arglist
7103 \ifx\argl\empty % no arguments
7106 \expandafter\parsemargdef \argl;%
7108 \if1\csname ismacro.\the\macname\endcsname
7109 \message{Warning: redefining \the\macname}%
7111 \expandafter\ifx\csname \the\macname\endcsname \relax
7112 \else \errmessage{Macro name \the\macname\space already defined}\fi
7113 \global\cslet{macsave.\the\macname}{\the\macname}%
7114 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7115 \addtomacrolist{\the\macname}%
7117 \begingroup \macrobodyctxt
7118 \ifrecursive \expandafter\parsermacbody
7119 \else \expandafter\parsemacbody
7122 \parseargdef\unmacro{%
7123 \if1\csname ismacro.#1\endcsname
7124 \global\cslet{#1}{macsave.#1}%
7125 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7126 % Remove the macro name from \macrolist:
7128 \expandafter\let\csname#1\endcsname \relax
7129 \let\definedummyword\unmacrodo
7130 \xdef\macrolist{\macrolist}%
7133 \errmessage{Macro #1 not defined}%
7137 % Called by \do from \dounmacro on each macro. The idea is to omit any
7138 % macro definitions that have been changed to \relax.
7144 \noexpand\definedummyword \noexpand#1%
7148 % This makes use of the obscure feature that if the last token of a
7149 % <parameter list> is #, then the preceding argument is delimited by
7150 % an opening brace, and that opening brace is not consumed.
7151 \def\getargs#1{\getargsxxx#1{}}
7152 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7153 \def\getmacname#1 #2\relax{\macname={#1}}
7154 \def\getmacargs#1{\def\argl{#1}}
7156 % Parse the optional {params} list. Set up \paramno and \paramlist
7157 % so \defmacro knows what to do. Define \macarg.blah for each blah
7158 % in the params list to be ##N where N is the position in that list.
7159 % That gets used by \mbodybackslash (above).
7161 % We need to get `macro parameter char #' into several definitions.
7162 % The technique used is stolen from LaTeX: let \hash be something
7163 % unexpandable, insert that wherever you need a #, and then redefine
7164 % it to # just before using the token list produced.
7166 % The same technique is used to protect \eatspaces till just before
7167 % the macro is used.
7169 \def\parsemargdef#1;{%
7170 \paramno=0\def\paramlist{}%
7172 \let\xeatspaces\relax
7173 \parsemargdefxxx#1,;,%
7175 \def\parsemargdefxxx#1,{%
7176 \if#1;\let\next=\relax
7177 \else \let\next=\parsemargdefxxx
7178 \advance\paramno by 1
7179 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7180 {\xeatspaces{\hash\the\paramno}}%
7181 \edef\paramlist{\paramlist\hash\the\paramno,}%
7184 % These two commands read recursive and nonrecursive macro bodies.
7185 % (They're different since rec and nonrec macros end differently.)
7187 \long\def\parsemacbody#1@end macro%
7188 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7189 \long\def\parsermacbody#1@end rmacro%
7190 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7192 % This defines the macro itself. There are six cases: recursive and
7193 % nonrecursive macros of zero, one, and many arguments.
7194 % Much magic with \expandafter here.
7195 % \xdef is used so that macro definitions will survive the file
7196 % they're defined in; @include reads the file inside a group.
7199 \let\hash=##% convert placeholders to macro parameter chars
7203 \expandafter\xdef\csname\the\macname\endcsname{%
7204 \noexpand\scanmacro{\temp}}%
7206 \expandafter\xdef\csname\the\macname\endcsname{%
7207 \bgroup\noexpand\macroargctxt
7208 \noexpand\braceorline
7209 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7210 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7211 \egroup\noexpand\scanmacro{\temp}}%
7213 \expandafter\xdef\csname\the\macname\endcsname{%
7214 \bgroup\noexpand\macroargctxt
7215 \noexpand\csname\the\macname xx\endcsname}%
7216 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7217 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7218 \expandafter\expandafter
7220 \expandafter\expandafter
7221 \csname\the\macname xxx\endcsname
7222 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7227 \expandafter\xdef\csname\the\macname\endcsname{%
7228 \noexpand\norecurse{\the\macname}%
7229 \noexpand\scanmacro{\temp}\egroup}%
7231 \expandafter\xdef\csname\the\macname\endcsname{%
7232 \bgroup\noexpand\macroargctxt
7233 \noexpand\braceorline
7234 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7235 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7237 \noexpand\norecurse{\the\macname}%
7238 \noexpand\scanmacro{\temp}\egroup}%
7240 \expandafter\xdef\csname\the\macname\endcsname{%
7241 \bgroup\noexpand\macroargctxt
7242 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7243 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7244 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7245 \expandafter\expandafter
7247 \expandafter\expandafter
7248 \csname\the\macname xxx\endcsname
7251 \noexpand\norecurse{\the\macname}%
7252 \noexpand\scanmacro{\temp}\egroup}%
7256 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7258 % \braceorline decides whether the next nonwhitespace character is a
7259 % {. If so it reads up to the closing }, if not, it reads the whole
7260 % line. Whatever was read is then fed to the next control sequence
7261 % as an argument (by \parsebrace or \parsearg).
7263 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7264 \def\braceorlinexxx{%
7265 \ifx\nchar\bgroup\else
7266 \expandafter\parsearg
7271 % We need some trickery to remove the optional spaces around the equal
7272 % sign. Make them active and then expand them all to nothing.
7274 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7275 \def\aliasxxx #1{\aliasyyy#1\relax}
7276 \def\aliasyyy #1=#2\relax{%
7278 \expandafter\let\obeyedspace=\empty
7279 \addtomacrolist{#1}%
7280 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7286 \message{cross references,}
7289 \newif\ifhavexrefs % True if xref values are known.
7290 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7292 % @inforef is relatively simple.
7293 \def\inforef #1{\inforefzzz #1,,,,**}
7294 \def\inforefzzz #1,#2,#3,#4**{%
7295 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7296 node \samp{\ignorespaces#1{}}}
7298 % @node's only job in TeX is to define \lastnode, which is used in
7299 % cross-references. The @node line might or might not have commas, and
7300 % might or might not have spaces before the first comma, like:
7301 % @node foo , bar , ...
7302 % We don't want such trailing spaces in the node name.
7304 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7306 % also remove a trailing comma, in case of something like this:
7307 % @node Help-Cross, , , Cross-refs
7308 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7309 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7312 \let\lastnode=\empty
7314 % Write a cross-reference definition for the current node. #1 is the
7315 % type (Ynumbered, Yappendix, Ynothing).
7318 \ifx\lastnode\empty\else
7319 \setref{\lastnode}{#1}%
7320 \global\let\lastnode=\empty
7324 % @anchor{NAME} -- define xref target at arbitrary point.
7326 \newcount\savesfregister
7328 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7329 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7330 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7332 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7333 % anchor), which consists of three parts:
7334 % 1) NAME-title - the current sectioning name taken from \lastsection,
7335 % or the anchor name.
7336 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7337 % empty for anchors.
7338 % 3) NAME-pg - the page number.
7340 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7341 % floats, there is an additional part, which is not written here:
7342 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7348 \atdummies % preserve commands, but don't expand them
7349 \edef\writexrdef##1##2{%
7350 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7351 ##1}{##2}}% these are parameters of \writexrdef
7353 \toks0 = \expandafter{\lastsection}%
7354 \immediate \writexrdef{title}{\the\toks0 }%
7355 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7356 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7361 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7362 % the node name, #2 the name of the Info cross-reference, #3 the printed
7363 % node name, #4 the name of the Info file, #5 the name of the printed
7364 % manual. All but the node name can be omitted.
7366 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7367 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7368 \def\ref#1{\xrefX[#1,,,,,,,]}
7369 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7371 \def\printedmanual{\ignorespaces #5}%
7372 \def\printedrefname{\ignorespaces #3}%
7373 \setbox1=\hbox{\printedmanual\unskip}%
7374 \setbox0=\hbox{\printedrefname\unskip}%
7376 % No printed node name was explicitly given.
7377 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7378 % Use the node name inside the square brackets.
7379 \def\printedrefname{\ignorespaces #1}%
7381 % Use the actual chapter/section title appear inside
7382 % the square brackets. Use the real section title if we have it.
7384 % It is in another manual, so we don't have it.
7385 \def\printedrefname{\ignorespaces #1}%
7388 % We know the real title if we have the xref values.
7389 \def\printedrefname{\refx{#1-title}{}}%
7391 % Otherwise just copy the Info node name.
7392 \def\printedrefname{\ignorespaces #1}%
7398 % Make link in pdf output.
7402 % This expands tokens, so do it after making catcode changes, so _
7403 % etc. don't get their TeX definitions.
7406 % See comments at \activebackslashdouble.
7407 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7408 \backslashparens\pdfxrefdest}%
7411 \startlink attr{/Border [0 0 0]}%
7412 \ifnum\filenamelength>0
7413 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7415 goto name{\pdfmkpgn{\pdfxrefdest}}%
7418 \setcolor{\linkcolor}%
7421 % Float references are printed completely differently: "Figure 1.2"
7422 % instead of "[somenode], p.3". We distinguish them by the
7423 % LABEL-title being set to a magic string.
7425 % Have to otherify everything special to allow the \csname to
7426 % include an _ in the xref name, etc.
7429 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7430 \csname XR#1-title\endcsname
7432 \iffloat\Xthisreftitle
7433 % If the user specified the print name (third arg) to the ref,
7434 % print it instead of our usual "Figure 1.2".
7441 % if the user also gave the printed manual name (fifth arg), append
7444 \space \putwordin{} \cite{\printedmanual}%
7447 % node/anchor (non-float) references.
7449 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7450 % insert empty discretionaries after hyphens, which means that it will
7451 % not find a line break at a hyphen in a node names. Since some manuals
7452 % are best written with fairly long node names, containing hyphens, this
7453 % is a loss. Therefore, we give the text of the node name again, so it
7454 % is as if TeX is seeing it for the first time.
7456 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7458 % _ (for example) has to be the character _ for the purposes of the
7459 % control sequence corresponding to the node, but it has to expand
7460 % into the usual \leavevmode...\vrule stuff for purposes of
7461 % printing. So we \turnoffactive for the \refx-snt, back on for the
7462 % printing, back off for the \refx-pg.
7464 % Only output a following space if the -snt ref is nonempty; for
7465 % @unnumbered and @anchor, it won't be.
7466 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7467 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7469 % output the `[mynode]' via a macro so it can be overridden.
7470 \xrefprintnodename\printedrefname
7472 % But we always want a comma and a space:
7475 % output the `page 3'.
7476 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7482 % This macro is called from \xrefX for the `[nodename]' part of xref
7483 % output. It's a separate macro only so it can be changed more easily,
7484 % since square brackets don't work well in some documents. Particularly
7485 % one that Bob is working on :).
7487 \def\xrefprintnodename#1{[#1]}
7489 % Things referred to by \setref.
7495 \putwordChapter@tie \the\chapno
7496 \else \ifnum\subsecno=0
7497 \putwordSection@tie \the\chapno.\the\secno
7498 \else \ifnum\subsubsecno=0
7499 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7501 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7506 \putwordAppendix@tie @char\the\appendixno{}%
7507 \else \ifnum\subsecno=0
7508 \putwordSection@tie @char\the\appendixno.\the\secno
7509 \else \ifnum\subsubsecno=0
7510 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7513 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7517 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7518 % If its value is nonempty, SUFFIX is output afterward.
7524 \expandafter\global\expandafter\let\expandafter\thisrefX
7525 \csname XR#1\endcsname
7528 % If not defined, say something at least.
7529 \angleleft un\-de\-fined\angleright
7532 {\toks0 = {#1}% avoid expansion of possibly-complex value
7533 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
7536 \global\warnedxrefstrue
7537 \message{Cross reference values unknown; you must run TeX again.}%
7542 % It's defined, so just use it.
7545 #2% Output the suffix in any case.
7548 % This is the macro invoked by entries in the aux file. Usually it's
7549 % just a \def (we prepend XR to the control sequence name to avoid
7550 % collisions). But if this is a float type, we have more work to do.
7553 {% The node name might contain 8-bit characters, which in our current
7554 % implementation are changed to commands like @'e. Don't let these
7555 % mess up the control sequence name.
7558 \xdef\safexrefname{#1}%
7561 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7563 % Was that xref control sequence that we just defined for a float?
7564 \expandafter\iffloat\csname XR\safexrefname\endcsname
7565 % it was a float, and we have the (safe) float type in \iffloattype.
7566 \expandafter\let\expandafter\floatlist
7567 \csname floatlist\iffloattype\endcsname
7569 % Is this the first time we've seen this float type?
7570 \expandafter\ifx\floatlist\relax
7571 \toks0 = {\do}% yes, so just \do
7573 % had it before, so preserve previous elements in list.
7574 \toks0 = \expandafter{\floatlist\do}%
7577 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7578 % for later use in \listoffloats.
7579 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7584 % Read the last existing aux file, if any. No error if none exists.
7587 \openin 1 \jobname.aux
7590 \global\havexrefstrue
7595 \def\setupdatafile{%
7596 \catcode`\^^@=\other
7597 \catcode`\^^A=\other
7598 \catcode`\^^B=\other
7599 \catcode`\^^C=\other
7600 \catcode`\^^D=\other
7601 \catcode`\^^E=\other
7602 \catcode`\^^F=\other
7603 \catcode`\^^G=\other
7604 \catcode`\^^H=\other
7605 \catcode`\^^K=\other
7606 \catcode`\^^L=\other
7607 \catcode`\^^N=\other
7608 \catcode`\^^P=\other
7609 \catcode`\^^Q=\other
7610 \catcode`\^^R=\other
7611 \catcode`\^^S=\other
7612 \catcode`\^^T=\other
7613 \catcode`\^^U=\other
7614 \catcode`\^^V=\other
7615 \catcode`\^^W=\other
7616 \catcode`\^^X=\other
7617 \catcode`\^^Z=\other
7618 \catcode`\^^[=\other
7619 \catcode`\^^\=\other
7620 \catcode`\^^]=\other
7621 \catcode`\^^^=\other
7622 \catcode`\^^_=\other
7623 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7624 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7625 % supported in the main text, it doesn't seem desirable. Furthermore,
7626 % that is not enough: for node names that actually contain a ^
7627 % character, we would end up writing a line like this: 'xrdef {'hat
7628 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7629 % argument, and \hat is not an expandable control sequence. It could
7630 % all be worked out, but why? Either we support ^^ or we don't.
7632 % The other change necessary for this was to define \auxhat:
7633 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7634 % and then to call \auxhat in \setq.
7638 % Special characters. Should be turned off anyway, but...
7651 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7653 % This is to support \ in node names and titles, since the \
7654 % characters end up in a \csname. It's easier than
7655 % leaving it active and making its active definition an actual \
7656 % character. What I don't understand is why it works in the *value*
7657 % of the xrdef. Seems like it should be a catcode12 \, and that
7658 % should not typeset properly. But it works, so I'm moving on for
7659 % now. --karl, 15jan04.
7662 % Make the characters 128-255 be printing characters.
7666 \catcode\count1=\other
7667 \advance\count1 by 1
7668 \ifnum \count1<256 \loop \fi
7672 % @ is our escape character in .aux files, and we need braces.
7678 \def\readdatafile#1{%
7685 \message{insertions,}
7686 % including footnotes.
7688 \newcount \footnoteno
7690 % The trailing space in the following definition for supereject is
7691 % vital for proper filling; pages come out unaligned when you do a
7692 % pagealignmacro call if that space before the closing brace is
7693 % removed. (Generally, numeric constants should always be followed by a
7694 % space to prevent strange expansion errors.)
7695 \def\supereject{\par\penalty -20000\footnoteno =0 }
7697 % @footnotestyle is meaningful for info output only.
7698 \let\footnotestyle=\comment
7702 % Auto-number footnotes. Otherwise like plain.
7704 \let\indent=\ptexindent
7705 \let\noindent=\ptexnoindent
7706 \global\advance\footnoteno by \@ne
7707 \edef\thisfootno{$^{\the\footnoteno}$}%
7709 % In case the footnote comes at the end of a sentence, preserve the
7710 % extra spacing after we do the footnote number.
7712 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7714 % Remove inadvertent blank space before typesetting the footnote number.
7720 % Don't bother with the trickery in plain.tex to not require the
7721 % footnote text as a parameter. Our footnotes don't need to be so general.
7723 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7724 % \parseargline) fails inside footnotes because the tokens are fixed when
7725 % the footnote is read. --karl, 16nov96.
7728 \insert\footins\bgroup
7729 % We want to typeset this text as a normal paragraph, even if the
7730 % footnote reference occurs in (for example) a display environment.
7731 % So reset some parameters.
7733 \interlinepenalty\interfootnotelinepenalty
7734 \splittopskip\ht\strutbox % top baseline for broken footnotes
7735 \splitmaxdepth\dp\strutbox
7736 \floatingpenalty\@MM
7741 \parindent\defaultparindent
7745 % Because we use hanging indentation in footnotes, a @noindent appears
7746 % to exdent this text, so make it be a no-op. makeinfo does not use
7747 % hanging indentation so @noindent can still be needed within footnote
7748 % text after an @example or the like (not that this is good style).
7749 \let\noindent = \relax
7751 % Hang the footnote text off the number. Use \everypar in case the
7752 % footnote extends for more than one paragraph.
7753 \everypar = {\hang}%
7754 \textindent{\thisfootno}%
7756 % Don't crash into the line above the footnote text. Since this
7757 % expands into a box, it must come within the paragraph, lest it
7758 % provide a place where TeX can split the footnote.
7760 \futurelet\next\fo@t
7762 }%end \catcode `\@=11
7764 % In case a @footnote appears in a vbox, save the footnote text and create
7765 % the real \insert just after the vbox finished. Otherwise, the insertion
7767 % Similarly, if a @footnote appears inside an alignment, save the footnote
7768 % text to a box and make the \insert when a row of the table is finished.
7769 % And the same can be done for other insert classes. --kasal, 16nov03.
7771 % Replace the \insert primitive by a cheating macro.
7772 % Deeper inside, just make sure that the saved insertions are not spilled
7775 \def\startsavinginserts{%
7776 \ifx \insert\ptexinsert
7777 \let\insert\saveinsert
7779 \let\checkinserts\relax
7783 % This \insert replacement works for both \insert\footins{foo} and
7784 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7787 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7788 \afterassignment\next
7789 % swallow the left brace
7792 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7793 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7795 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7797 \def\placesaveins#1{%
7798 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7802 % eat @SAVE -- beware, all of them have catcode \other:
7804 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7805 \gdef\gobblesave @SAVE{}
7809 \def\newsaveins #1{%
7810 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7813 \def\newsaveinsX #1{%
7814 \csname newbox\endcsname #1%
7815 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7820 \let\checkinserts\empty
7825 % @image. We use the macros from epsf.tex to support this.
7826 % If epsf.tex is not installed and @image is used, we complain.
7828 % Check for and read epsf.tex up front. If we read it only at @image
7829 % time, we might be inside a group, and then its definitions would get
7830 % undone and the next image would fail.
7831 \openin 1 = epsf.tex
7833 % Do not bother showing banner with epsf.tex v2.7k (available in
7834 % doc/epsf.tex and on ctan).
7835 \def\epsfannounce{\toks0 = }%
7840 % We will only complain once about lack of epsf.tex.
7841 \newif\ifwarnednoepsf
7842 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7843 work. It is also included in the Texinfo distribution, or you can get
7844 it from ftp://tug.org/tex/epsf.tex.}
7847 \ifx\epsfbox\undefined
7848 \ifwarnednoepsf \else
7849 \errhelp = \noepsfhelp
7850 \errmessage{epsf.tex not found, images will be ignored}%
7851 \global\warnednoepsftrue
7854 \imagexxx #1,,,,,\finish
7858 % Arguments to @image:
7859 % #1 is (mandatory) image filename; we tack on .eps extension.
7860 % #2 is (optional) width, #3 is (optional) height.
7861 % #4 is (ignored optional) html alt text.
7862 % #5 is (ignored optional) extension.
7863 % #6 is just the usual extra ignored arg for parsing stuff.
7865 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7866 \catcode`\^^M = 5 % in case we're inside an example
7867 \normalturnoffactive % allow _ et al. in names
7868 % If the image is by itself, center it.
7872 % Usually we'll have text after the image which will insert
7873 % \parskip glue, so insert it here too to equalize the space
7875 \nobreak\vskip\parskip
7879 % Leave vertical mode so that indentation from an enclosing
7880 % environment such as @quotation is respected. On the other hand, if
7881 % it's at the top level, we don't want the normal paragraph indentation.
7886 \dopdfimage{#1}{#2}{#3}%
7888 % \epsfbox itself resets \epsf?size at each figure.
7889 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7890 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7894 \ifimagevmode \medskip \fi % space after the standalone image
7898 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7899 % etc. We don't actually implement floating yet, we always include the
7900 % float "here". But it seemed the best name for the future.
7902 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7904 % There may be a space before second and/or third parameter; delete it.
7905 \def\eatcommaspace#1, {#1,}
7907 % #1 is the optional FLOATTYPE, the text label for this float, typically
7908 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7909 % this float will not be numbered and cannot be referred to.
7911 % #2 is the optional xref label. Also must be present for the float to
7914 % #3 is the optional positioning argument; for now, it is ignored. It
7915 % will somehow specify the positions allowed to float to (here, top, bottom).
7917 % We keep a separate counter for each FLOATTYPE, which we reset at each
7918 % chapter-level command.
7919 \let\resetallfloatnos=\empty
7921 \def\dofloat#1,#2,#3,#4\finish{%
7922 \let\thiscaption=\empty
7923 \let\thisshortcaption=\empty
7925 % don't lose footnotes inside @float.
7927 % BEWARE: when the floats start float, we have to issue warning whenever an
7928 % insert appears inside a float which could possibly float. --kasal, 26may04
7932 % We can't be used inside a paragraph.
7937 \def\floatlabel{#2}%
7938 \def\floatloc{#3}% we do nothing with this yet.
7940 \ifx\floattype\empty
7941 \let\safefloattype=\empty
7944 % the floattype might have accents or other special characters,
7945 % but we need to use it in a control sequence name.
7948 \xdef\safefloattype{\floattype}%
7952 % If label is given but no type, we handle that as the empty type.
7953 \ifx\floatlabel\empty \else
7954 % We want each FLOATTYPE to be numbered separately (Figure 1,
7955 % Table 1, Figure 2, ...). (And if no label, no number.)
7957 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7958 \global\advance\floatno by 1
7961 % This magic value for \lastsection is output by \setref as the
7962 % XREFLABEL-title value. \xrefX uses it to distinguish float
7963 % labels (which have a completely different output format) from
7964 % node and anchor labels. And \xrdef uses it to construct the
7967 \edef\lastsection{\floatmagic=\safefloattype}%
7968 \setref{\floatlabel}{Yfloat}%
7972 % start with \parskip glue, I guess.
7975 % Don't suppress indentation if a float happens to start a section.
7976 \restorefirstparagraphindent
7979 % we have these possibilities:
7980 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7981 % @float Foo,lbl & no caption: Foo 1.1
7982 % @float Foo & @caption{Cap}: Foo: Cap
7983 % @float Foo & no caption: Foo
7984 % @float ,lbl & Caption{Cap}: 1.1: Cap
7985 % @float ,lbl & no caption: 1.1
7986 % @float & @caption{Cap}: Cap
7987 % @float & no caption:
7990 \let\floatident = \empty
7992 % In all cases, if we have a float type, it comes first.
7993 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7995 % If we have an xref label, the number comes next.
7996 \ifx\floatlabel\empty \else
7997 \ifx\floattype\empty \else % if also had float type, need tie first.
7998 \appendtomacro\floatident{\tie}%
8001 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8004 % Start the printed caption with what we've constructed in
8005 % \floatident, but keep it separate; we need \floatident again.
8006 \let\captionline = \floatident
8008 \ifx\thiscaption\empty \else
8009 \ifx\floatident\empty \else
8010 \appendtomacro\captionline{: }% had ident, so need a colon between
8014 \appendtomacro\captionline{\scanexp\thiscaption}%
8017 % If we have anything to print, print it, with space before.
8018 % Eventually this needs to become an \insert.
8019 \ifx\captionline\empty \else
8023 % Space below caption.
8027 % If have an xref label, write the list of floats info. Do this
8028 % after the caption, to avoid chance of it being a breakpoint.
8029 \ifx\floatlabel\empty \else
8030 % Write the text that goes in the lof to the aux file as
8031 % \floatlabel-lof. Besides \floatident, we include the short
8032 % caption if specified, else the full caption if specified, else nothing.
8036 % since we read the caption text in the macro world, where ^^M
8037 % is turned into a normal character, we have to scan it back, so
8038 % we don't write the literal three characters "^^M" into the aux file.
8040 \xdef\noexpand\gtemp{%
8041 \ifx\thisshortcaption\empty
8048 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8049 \ifx\gtemp\empty \else : \gtemp \fi}}%
8052 \egroup % end of \vtop
8054 % place the captured inserts
8056 % BEWARE: when the floats start floating, we have to issue warning
8057 % whenever an insert appears inside a float which could possibly
8058 % float. --kasal, 26may04
8063 % Append the tokens #2 to the definition of macro #1, not expanding either.
8065 \def\appendtomacro#1#2{%
8066 \expandafter\def\expandafter#1\expandafter{#1#2}%
8069 % @caption, @shortcaption
8071 \def\caption{\docaption\thiscaption}
8072 \def\shortcaption{\docaption\thisshortcaption}
8073 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8074 \def\defcaption#1#2{\egroup \def#1{#2}}
8076 % The parameter is the control sequence identifying the counter we are
8077 % going to use. Create it if it doesn't exist and assign it to \floatno.
8080 % Haven't seen this figure type before.
8081 \csname newcount\endcsname #1%
8083 % Remember to reset this floatno at the next chap.
8084 \expandafter\gdef\expandafter\resetallfloatnos
8085 \expandafter{\resetallfloatnos #1=0 }%
8090 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8091 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8092 % first read the @float command.
8094 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8096 % Magic string used for the XREFLABEL-title value, so \xrefX can
8097 % distinguish floats from other xref types.
8098 \def\floatmagic{!!float!!}
8100 % #1 is the control sequence we are passed; we expand into a conditional
8101 % which is true if #1 represents a float ref. That is, the magic
8102 % \lastsection value which we \setref above.
8104 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8106 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8107 % (safe) float type for this float. We set \iffloattype to #2.
8109 \def\doiffloat#1=#2=#3\finish{%
8111 \def\iffloattype{#2}%
8112 \ifx\temp\floatmagic
8115 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8117 \parseargdef\listoffloats{%
8118 \def\floattype{#1}% floattype
8120 % the floattype might have accents or other special characters,
8121 % but we need to use it in a control sequence name.
8124 \xdef\safefloattype{\floattype}%
8127 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8128 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8130 % if the user said @listoffloats foo but never @float foo.
8131 \message{\linenumber No `\safefloattype' floats to list.}%
8135 \leftskip=\tocindent % indent these entries like a toc
8136 \let\do=\listoffloatsdo
8137 \csname floatlist\safefloattype\endcsname
8142 % This is called on each entry in a list of floats. We're passed the
8143 % xref label, in the form LABEL-title, which is how we save it in the
8144 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8145 % has the text we're supposed to typeset here.
8147 % Figures without xref labels will not be included in the list (since
8148 % they won't appear in the aux file).
8150 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8151 \def\listoffloatsdoentry#1-title\finish{{%
8152 % Can't fully expand XR#1-lof because it can contain anything. Just
8153 % pass the control sequence. On the other hand, XR#1-pg is just the
8154 % page number, and we want to fully expand that so we can get a link
8156 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8158 % use the same \entry macro we use to generate the TOC and index.
8159 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8164 \message{localization,}
8166 % For single-language documents, @documentlanguage is usually given very
8167 % early, just after @documentencoding. Single argument is the language
8168 % (de) or locale (de_DE) abbreviation.
8171 \catcode`\_ = \active
8173 \parseargdef\documentlanguage{\begingroup
8174 \let_=\normalunderscore % normal _ character for filenames
8175 \tex % read txi-??.tex file in plain TeX.
8176 % Read the file by the name they passed if it exists.
8177 \openin 1 txi-#1.tex
8179 \documentlanguagetrywithoutunderscore{#1_\finish}%
8181 \globaldefs = 1 % everything in the txi-LL files needs to persist
8185 \endgroup % end raw TeX
8188 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8191 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8192 \openin 1 txi-#1.tex
8194 \errhelp = \nolanghelp
8195 \errmessage{Cannot read language file txi-#1.tex}%
8197 \globaldefs = 1 % everything in the txi-LL files needs to persist
8202 }% end of special _ catcode
8204 \newhelp\nolanghelp{The given language definition file cannot be found or
8205 is empty. Maybe you need to install it? Putting it in the current
8206 directory should work if nowhere else does.}
8208 % This macro is called from txi-??.tex files; the first argument is the
8209 % \language name to set (without the "\lang@" prefix), the second and
8210 % third args are \{left,right}hyphenmin.
8212 % The language names to pass are determined when the format is built.
8213 % See the etex.log file created at that time, e.g.,
8214 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8216 % With TeX Live 2008, etex now includes hyphenation patterns for all
8217 % available languages. This means we can support hyphenation in
8218 % Texinfo, at least to some extent. (This still doesn't solve the
8219 % accented characters problem.)
8222 \def\txisetlanguage#1#2#3{%
8223 % do not set the language if the name is undefined in the current TeX.
8224 \expandafter\ifx\csname lang@#1\endcsname \relax
8225 \message{no patterns for #1}%
8227 \global\language = \csname lang@#1\endcsname
8229 % but there is no harm in adjusting the hyphenmin values regardless.
8230 \global\lefthyphenmin = #2\relax
8231 \global\righthyphenmin = #3\relax
8234 % Helpers for encodings.
8235 % Set the catcode of characters 128 through 255 to the specified number.
8237 \def\setnonasciicharscatcode#1{%
8239 \loop\ifnum\count255<256
8240 \global\catcode\count255=#1\relax
8241 \advance\count255 by 1
8245 \def\setnonasciicharscatcodenonglobal#1{%
8247 \loop\ifnum\count255<256
8248 \catcode\count255=#1\relax
8249 \advance\count255 by 1
8253 % @documentencoding sets the definition of non-ASCII characters
8254 % according to the specified encoding.
8256 \parseargdef\documentencoding{%
8257 % Encoding being declared for the document.
8258 \def\declaredencoding{\csname #1.enc\endcsname}%
8260 % Supported encodings: names converted to tokens in order to be able
8261 % to compare them with \ifx.
8262 \def\ascii{\csname US-ASCII.enc\endcsname}%
8263 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8264 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8265 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8266 \def\utfeight{\csname UTF-8.enc\endcsname}%
8268 \ifx \declaredencoding \ascii
8271 \else \ifx \declaredencoding \lattwo
8272 \setnonasciicharscatcode\active
8275 \else \ifx \declaredencoding \latone
8276 \setnonasciicharscatcode\active
8279 \else \ifx \declaredencoding \latnine
8280 \setnonasciicharscatcode\active
8283 \else \ifx \declaredencoding \utfeight
8284 \setnonasciicharscatcode\active
8288 \message{Unknown document encoding #1, ignoring.}%
8297 % A message to be logged when using a character that isn't available
8298 % the default font encoding (OT1).
8300 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8302 % Take account of \c (plain) vs. \, (Texinfo) difference.
8303 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8305 % First, make active non-ASCII characters in order for them to be
8306 % correctly categorized when TeX reads the replacement text of
8307 % macros containing the character definitions.
8308 \setnonasciicharscatcode\active
8310 % Latin1 (ISO-8859-1) character definitions.
8311 \def\latonechardefs{%
8313 \gdef^^a1{\exclamdown}
8314 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8315 \gdef^^a3{{\pounds}}
8316 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8317 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8318 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8321 \gdef^^a9{\copyright}
8323 \gdef^^ab{\guillemetleft}
8326 \gdef^^ae{\registeredsymbol}
8329 \gdef^^b0{\textdegree}
8338 \gdef^^b8{\cedilla\ }
8342 \gdef^^bb{\guilletright}
8343 \gdef^^bc{$1\over4$}
8344 \gdef^^bd{$1\over2$}
8345 \gdef^^be{$3\over4$}
8346 \gdef^^bf{\questiondown}
8353 \gdef^^c5{\ringaccent A}
8355 \gdef^^c7{\cedilla C}
8387 \gdef^^e5{\ringaccent a}
8389 \gdef^^e7{\cedilla c}
8394 \gdef^^ec{\`{\dotless i}}
8395 \gdef^^ed{\'{\dotless i}}
8396 \gdef^^ee{\^{\dotless i}}
8397 \gdef^^ef{\"{\dotless i}}
8417 % Latin9 (ISO-8859-15) encoding character definitions.
8418 \def\latninechardefs{%
8419 % Encoding is almost identical to Latin1.
8432 % Latin2 (ISO-8859-2) character definitions.
8433 \def\lattwochardefs{%
8435 \gdef^^a1{\ogonek{A}}
8438 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8444 \gdef^^aa{\cedilla S}
8449 \gdef^^af{\dotaccent Z}
8451 \gdef^^b0{\textdegree}
8452 \gdef^^b1{\ogonek{a}}
8453 \gdef^^b2{\ogonek{ }}
8459 \gdef^^b8{\cedilla\ }
8461 \gdef^^ba{\cedilla s}
8466 \gdef^^bf{\dotaccent z}
8475 \gdef^^c7{\cedilla C}
8478 \gdef^^ca{\ogonek{E}}
8494 \gdef^^d9{\ringaccent U}
8499 \gdef^^de{\cedilla T}
8509 \gdef^^e7{\cedilla c}
8512 \gdef^^ea{\ogonek{e}}
8515 \gdef^^ed{\'{\dotless{i}}}
8516 \gdef^^ee{\^{\dotless{i}}}
8528 \gdef^^f9{\ringaccent u}
8533 \gdef^^fe{\cedilla t}
8534 \gdef^^ff{\dotaccent{}}
8537 % UTF-8 character definitions.
8539 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8540 % changes for Texinfo conventions. It is included here under the GPL by
8541 % permission from Frank Mittelbach and the LaTeX team.
8547 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8548 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8550 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8551 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8553 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8554 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8556 \gdef\UTFviiiDefined#1{%
8558 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8569 \global\catcode\countUTFx\active
8570 \uccode`\~\countUTFx
8571 \uppercase\expandafter{\UTFviiiTmp}%
8572 \advance\countUTFx by 1
8573 \ifnum\countUTFx < \countUTFy
8574 \expandafter\UTFviiiLoop
8580 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8586 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8592 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8605 \gdef\DeclareUnicodeCharacter#1#2{%
8606 \countUTFz = "#1\relax
8607 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8610 \def\UTFviiiTwoOctets##1##2{%
8611 \csname u8:##1\string ##2\endcsname}%
8612 \def\UTFviiiThreeOctets##1##2##3{%
8613 \csname u8:##1\string ##2\string ##3\endcsname}%
8614 \def\UTFviiiFourOctets##1##2##3##4{%
8615 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8616 \expandafter\expandafter\expandafter\expandafter
8617 \expandafter\expandafter\expandafter
8618 \gdef\UTFviiiTmp{#2}%
8621 \gdef\parseXMLCharref{%
8622 \ifnum\countUTFz < "A0\relax
8623 \errhelp = \EMsimple
8624 \errmessage{Cannot define Unicode char value < 00A0}%
8625 \else\ifnum\countUTFz < "800\relax
8627 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8628 \else\ifnum\countUTFz < "10000\relax
8631 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8636 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8640 \gdef\parseUTFviiiA#1{%
8641 \countUTFx = \countUTFz
8642 \divide\countUTFz by 64
8643 \countUTFy = \countUTFz
8644 \multiply\countUTFz by 64
8645 \advance\countUTFx by -\countUTFz
8646 \advance\countUTFx by 128
8647 \uccode `#1\countUTFx
8648 \countUTFz = \countUTFy}
8650 \gdef\parseUTFviiiB#1#2#3#4{%
8651 \advance\countUTFz by "#10\relax
8652 \uccode `#3\countUTFz
8653 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8656 \def\utfeightchardefs{%
8657 \DeclareUnicodeCharacter{00A0}{\tie}
8658 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8659 \DeclareUnicodeCharacter{00A3}{\pounds}
8660 \DeclareUnicodeCharacter{00A8}{\"{ }}
8661 \DeclareUnicodeCharacter{00A9}{\copyright}
8662 \DeclareUnicodeCharacter{00AA}{\ordf}
8663 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8664 \DeclareUnicodeCharacter{00AD}{\-}
8665 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8666 \DeclareUnicodeCharacter{00AF}{\={ }}
8668 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8669 \DeclareUnicodeCharacter{00B4}{\'{ }}
8670 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8671 \DeclareUnicodeCharacter{00BA}{\ordm}
8672 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8673 \DeclareUnicodeCharacter{00BF}{\questiondown}
8675 \DeclareUnicodeCharacter{00C0}{\`A}
8676 \DeclareUnicodeCharacter{00C1}{\'A}
8677 \DeclareUnicodeCharacter{00C2}{\^A}
8678 \DeclareUnicodeCharacter{00C3}{\~A}
8679 \DeclareUnicodeCharacter{00C4}{\"A}
8680 \DeclareUnicodeCharacter{00C5}{\AA}
8681 \DeclareUnicodeCharacter{00C6}{\AE}
8682 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8683 \DeclareUnicodeCharacter{00C8}{\`E}
8684 \DeclareUnicodeCharacter{00C9}{\'E}
8685 \DeclareUnicodeCharacter{00CA}{\^E}
8686 \DeclareUnicodeCharacter{00CB}{\"E}
8687 \DeclareUnicodeCharacter{00CC}{\`I}
8688 \DeclareUnicodeCharacter{00CD}{\'I}
8689 \DeclareUnicodeCharacter{00CE}{\^I}
8690 \DeclareUnicodeCharacter{00CF}{\"I}
8692 \DeclareUnicodeCharacter{00D0}{\DH}
8693 \DeclareUnicodeCharacter{00D1}{\~N}
8694 \DeclareUnicodeCharacter{00D2}{\`O}
8695 \DeclareUnicodeCharacter{00D3}{\'O}
8696 \DeclareUnicodeCharacter{00D4}{\^O}
8697 \DeclareUnicodeCharacter{00D5}{\~O}
8698 \DeclareUnicodeCharacter{00D6}{\"O}
8699 \DeclareUnicodeCharacter{00D8}{\O}
8700 \DeclareUnicodeCharacter{00D9}{\`U}
8701 \DeclareUnicodeCharacter{00DA}{\'U}
8702 \DeclareUnicodeCharacter{00DB}{\^U}
8703 \DeclareUnicodeCharacter{00DC}{\"U}
8704 \DeclareUnicodeCharacter{00DD}{\'Y}
8705 \DeclareUnicodeCharacter{00DE}{\TH}
8706 \DeclareUnicodeCharacter{00DF}{\ss}
8708 \DeclareUnicodeCharacter{00E0}{\`a}
8709 \DeclareUnicodeCharacter{00E1}{\'a}
8710 \DeclareUnicodeCharacter{00E2}{\^a}
8711 \DeclareUnicodeCharacter{00E3}{\~a}
8712 \DeclareUnicodeCharacter{00E4}{\"a}
8713 \DeclareUnicodeCharacter{00E5}{\aa}
8714 \DeclareUnicodeCharacter{00E6}{\ae}
8715 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8716 \DeclareUnicodeCharacter{00E8}{\`e}
8717 \DeclareUnicodeCharacter{00E9}{\'e}
8718 \DeclareUnicodeCharacter{00EA}{\^e}
8719 \DeclareUnicodeCharacter{00EB}{\"e}
8720 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8721 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8722 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8723 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8725 \DeclareUnicodeCharacter{00F0}{\dh}
8726 \DeclareUnicodeCharacter{00F1}{\~n}
8727 \DeclareUnicodeCharacter{00F2}{\`o}
8728 \DeclareUnicodeCharacter{00F3}{\'o}
8729 \DeclareUnicodeCharacter{00F4}{\^o}
8730 \DeclareUnicodeCharacter{00F5}{\~o}
8731 \DeclareUnicodeCharacter{00F6}{\"o}
8732 \DeclareUnicodeCharacter{00F8}{\o}
8733 \DeclareUnicodeCharacter{00F9}{\`u}
8734 \DeclareUnicodeCharacter{00FA}{\'u}
8735 \DeclareUnicodeCharacter{00FB}{\^u}
8736 \DeclareUnicodeCharacter{00FC}{\"u}
8737 \DeclareUnicodeCharacter{00FD}{\'y}
8738 \DeclareUnicodeCharacter{00FE}{\th}
8739 \DeclareUnicodeCharacter{00FF}{\"y}
8741 \DeclareUnicodeCharacter{0100}{\=A}
8742 \DeclareUnicodeCharacter{0101}{\=a}
8743 \DeclareUnicodeCharacter{0102}{\u{A}}
8744 \DeclareUnicodeCharacter{0103}{\u{a}}
8745 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8746 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8747 \DeclareUnicodeCharacter{0106}{\'C}
8748 \DeclareUnicodeCharacter{0107}{\'c}
8749 \DeclareUnicodeCharacter{0108}{\^C}
8750 \DeclareUnicodeCharacter{0109}{\^c}
8751 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8752 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8753 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8754 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8755 \DeclareUnicodeCharacter{010C}{\v{C}}
8756 \DeclareUnicodeCharacter{010D}{\v{c}}
8757 \DeclareUnicodeCharacter{010E}{\v{D}}
8759 \DeclareUnicodeCharacter{0112}{\=E}
8760 \DeclareUnicodeCharacter{0113}{\=e}
8761 \DeclareUnicodeCharacter{0114}{\u{E}}
8762 \DeclareUnicodeCharacter{0115}{\u{e}}
8763 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8764 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8765 \DeclareUnicodeCharacter{011A}{\v{E}}
8766 \DeclareUnicodeCharacter{011B}{\v{e}}
8767 \DeclareUnicodeCharacter{011C}{\^G}
8768 \DeclareUnicodeCharacter{011D}{\^g}
8769 \DeclareUnicodeCharacter{011E}{\u{G}}
8770 \DeclareUnicodeCharacter{011F}{\u{g}}
8772 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8773 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8774 \DeclareUnicodeCharacter{0124}{\^H}
8775 \DeclareUnicodeCharacter{0125}{\^h}
8776 \DeclareUnicodeCharacter{0128}{\~I}
8777 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8778 \DeclareUnicodeCharacter{012A}{\=I}
8779 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8780 \DeclareUnicodeCharacter{012C}{\u{I}}
8781 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8783 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8784 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8785 \DeclareUnicodeCharacter{0132}{IJ}
8786 \DeclareUnicodeCharacter{0133}{ij}
8787 \DeclareUnicodeCharacter{0134}{\^J}
8788 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8789 \DeclareUnicodeCharacter{0139}{\'L}
8790 \DeclareUnicodeCharacter{013A}{\'l}
8792 \DeclareUnicodeCharacter{0141}{\L}
8793 \DeclareUnicodeCharacter{0142}{\l}
8794 \DeclareUnicodeCharacter{0143}{\'N}
8795 \DeclareUnicodeCharacter{0144}{\'n}
8796 \DeclareUnicodeCharacter{0147}{\v{N}}
8797 \DeclareUnicodeCharacter{0148}{\v{n}}
8798 \DeclareUnicodeCharacter{014C}{\=O}
8799 \DeclareUnicodeCharacter{014D}{\=o}
8800 \DeclareUnicodeCharacter{014E}{\u{O}}
8801 \DeclareUnicodeCharacter{014F}{\u{o}}
8803 \DeclareUnicodeCharacter{0150}{\H{O}}
8804 \DeclareUnicodeCharacter{0151}{\H{o}}
8805 \DeclareUnicodeCharacter{0152}{\OE}
8806 \DeclareUnicodeCharacter{0153}{\oe}
8807 \DeclareUnicodeCharacter{0154}{\'R}
8808 \DeclareUnicodeCharacter{0155}{\'r}
8809 \DeclareUnicodeCharacter{0158}{\v{R}}
8810 \DeclareUnicodeCharacter{0159}{\v{r}}
8811 \DeclareUnicodeCharacter{015A}{\'S}
8812 \DeclareUnicodeCharacter{015B}{\'s}
8813 \DeclareUnicodeCharacter{015C}{\^S}
8814 \DeclareUnicodeCharacter{015D}{\^s}
8815 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8816 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8818 \DeclareUnicodeCharacter{0160}{\v{S}}
8819 \DeclareUnicodeCharacter{0161}{\v{s}}
8820 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8821 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8822 \DeclareUnicodeCharacter{0164}{\v{T}}
8824 \DeclareUnicodeCharacter{0168}{\~U}
8825 \DeclareUnicodeCharacter{0169}{\~u}
8826 \DeclareUnicodeCharacter{016A}{\=U}
8827 \DeclareUnicodeCharacter{016B}{\=u}
8828 \DeclareUnicodeCharacter{016C}{\u{U}}
8829 \DeclareUnicodeCharacter{016D}{\u{u}}
8830 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8831 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8833 \DeclareUnicodeCharacter{0170}{\H{U}}
8834 \DeclareUnicodeCharacter{0171}{\H{u}}
8835 \DeclareUnicodeCharacter{0174}{\^W}
8836 \DeclareUnicodeCharacter{0175}{\^w}
8837 \DeclareUnicodeCharacter{0176}{\^Y}
8838 \DeclareUnicodeCharacter{0177}{\^y}
8839 \DeclareUnicodeCharacter{0178}{\"Y}
8840 \DeclareUnicodeCharacter{0179}{\'Z}
8841 \DeclareUnicodeCharacter{017A}{\'z}
8842 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8843 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8844 \DeclareUnicodeCharacter{017D}{\v{Z}}
8845 \DeclareUnicodeCharacter{017E}{\v{z}}
8847 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8848 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8849 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8850 \DeclareUnicodeCharacter{01C7}{LJ}
8851 \DeclareUnicodeCharacter{01C8}{Lj}
8852 \DeclareUnicodeCharacter{01C9}{lj}
8853 \DeclareUnicodeCharacter{01CA}{NJ}
8854 \DeclareUnicodeCharacter{01CB}{Nj}
8855 \DeclareUnicodeCharacter{01CC}{nj}
8856 \DeclareUnicodeCharacter{01CD}{\v{A}}
8857 \DeclareUnicodeCharacter{01CE}{\v{a}}
8858 \DeclareUnicodeCharacter{01CF}{\v{I}}
8860 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8861 \DeclareUnicodeCharacter{01D1}{\v{O}}
8862 \DeclareUnicodeCharacter{01D2}{\v{o}}
8863 \DeclareUnicodeCharacter{01D3}{\v{U}}
8864 \DeclareUnicodeCharacter{01D4}{\v{u}}
8866 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8867 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8868 \DeclareUnicodeCharacter{01E6}{\v{G}}
8869 \DeclareUnicodeCharacter{01E7}{\v{g}}
8870 \DeclareUnicodeCharacter{01E8}{\v{K}}
8871 \DeclareUnicodeCharacter{01E9}{\v{k}}
8873 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8874 \DeclareUnicodeCharacter{01F1}{DZ}
8875 \DeclareUnicodeCharacter{01F2}{Dz}
8876 \DeclareUnicodeCharacter{01F3}{dz}
8877 \DeclareUnicodeCharacter{01F4}{\'G}
8878 \DeclareUnicodeCharacter{01F5}{\'g}
8879 \DeclareUnicodeCharacter{01F8}{\`N}
8880 \DeclareUnicodeCharacter{01F9}{\`n}
8881 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8882 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8883 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8884 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8886 \DeclareUnicodeCharacter{021E}{\v{H}}
8887 \DeclareUnicodeCharacter{021F}{\v{h}}
8889 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8890 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8891 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8892 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8893 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8894 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8896 \DeclareUnicodeCharacter{0232}{\=Y}
8897 \DeclareUnicodeCharacter{0233}{\=y}
8898 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8900 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8902 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8903 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8904 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8905 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8906 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8907 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8908 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8909 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8910 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8911 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8912 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8913 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8915 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8916 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8918 \DeclareUnicodeCharacter{1E20}{\=G}
8919 \DeclareUnicodeCharacter{1E21}{\=g}
8920 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8921 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8922 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8923 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8924 \DeclareUnicodeCharacter{1E26}{\"H}
8925 \DeclareUnicodeCharacter{1E27}{\"h}
8927 \DeclareUnicodeCharacter{1E30}{\'K}
8928 \DeclareUnicodeCharacter{1E31}{\'k}
8929 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8930 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8931 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8932 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8933 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8934 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8935 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8936 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8937 \DeclareUnicodeCharacter{1E3E}{\'M}
8938 \DeclareUnicodeCharacter{1E3F}{\'m}
8940 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8941 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8942 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8943 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8944 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8945 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8946 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8947 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8948 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8949 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8951 \DeclareUnicodeCharacter{1E54}{\'P}
8952 \DeclareUnicodeCharacter{1E55}{\'p}
8953 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8954 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8955 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8956 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8957 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8958 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8959 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8960 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8962 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8963 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8964 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8965 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8966 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8967 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8968 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8969 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8970 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8971 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8973 \DeclareUnicodeCharacter{1E7C}{\~V}
8974 \DeclareUnicodeCharacter{1E7D}{\~v}
8975 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8976 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8978 \DeclareUnicodeCharacter{1E80}{\`W}
8979 \DeclareUnicodeCharacter{1E81}{\`w}
8980 \DeclareUnicodeCharacter{1E82}{\'W}
8981 \DeclareUnicodeCharacter{1E83}{\'w}
8982 \DeclareUnicodeCharacter{1E84}{\"W}
8983 \DeclareUnicodeCharacter{1E85}{\"w}
8984 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8985 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8986 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8987 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8988 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8989 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8990 \DeclareUnicodeCharacter{1E8C}{\"X}
8991 \DeclareUnicodeCharacter{1E8D}{\"x}
8992 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8993 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8995 \DeclareUnicodeCharacter{1E90}{\^Z}
8996 \DeclareUnicodeCharacter{1E91}{\^z}
8997 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8998 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8999 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9000 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9001 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9002 \DeclareUnicodeCharacter{1E97}{\"t}
9003 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9004 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9006 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9007 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9009 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9010 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9011 \DeclareUnicodeCharacter{1EBC}{\~E}
9012 \DeclareUnicodeCharacter{1EBD}{\~e}
9014 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9015 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9016 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9017 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9019 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9020 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9022 \DeclareUnicodeCharacter{1EF2}{\`Y}
9023 \DeclareUnicodeCharacter{1EF3}{\`y}
9024 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9026 \DeclareUnicodeCharacter{1EF8}{\~Y}
9027 \DeclareUnicodeCharacter{1EF9}{\~y}
9029 \DeclareUnicodeCharacter{2013}{--}
9030 \DeclareUnicodeCharacter{2014}{---}
9031 \DeclareUnicodeCharacter{2018}{\quoteleft}
9032 \DeclareUnicodeCharacter{2019}{\quoteright}
9033 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9034 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9035 \DeclareUnicodeCharacter{201D}{\quotedblright}
9036 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9037 \DeclareUnicodeCharacter{2022}{\bullet}
9038 \DeclareUnicodeCharacter{2026}{\dots}
9039 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9040 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9041 \DeclareUnicodeCharacter{20AC}{\euro}
9043 \DeclareUnicodeCharacter{2192}{\expansion}
9044 \DeclareUnicodeCharacter{21D2}{\result}
9046 \DeclareUnicodeCharacter{2212}{\minus}
9047 \DeclareUnicodeCharacter{2217}{\point}
9048 \DeclareUnicodeCharacter{2261}{\equiv}
9049 }% end of \utfeightchardefs
9052 % US-ASCII character definitions.
9053 \def\asciichardefs{% nothing need be done
9057 % Make non-ASCII characters printable again for compatibility with
9058 % existing Texinfo documents that may use them, even without declaring a
9059 % document encoding.
9061 \setnonasciicharscatcode \other
9064 \message{formatting,}
9066 \newdimen\defaultparindent \defaultparindent = 15pt
9068 \chapheadingskip = 15pt plus 4pt minus 2pt
9069 \secheadingskip = 12pt plus 3pt minus 2pt
9070 \subsecheadingskip = 9pt plus 2pt minus 2pt
9072 % Prevent underfull vbox error messages.
9075 % Don't be very finicky about underfull hboxes, either.
9078 % Following George Bush, get rid of widows and orphans.
9082 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9083 % using an old version of TeX, don't do anything. We want the amount of
9084 % stretch added to depend on the line length, hence the dependence on
9085 % \hsize. We call this whenever the paper size is set.
9087 \def\setemergencystretch{%
9088 \ifx\emergencystretch\thisisundefined
9089 % Allow us to assign to \emergencystretch anyway.
9090 \def\emergencystretch{\dimen0}%
9092 \emergencystretch = .15\hsize
9096 % Parameters in order: 1) textheight; 2) textwidth;
9097 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9098 % 7) physical page height; 8) physical page width.
9100 % We also call \setleading{\textleading}, so the caller should define
9101 % \textleading. The caller should also set \parskip.
9103 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9106 \splittopskip = \topskip
9109 \advance\vsize by \topskip
9110 \outervsize = \vsize
9111 \advance\outervsize by 2\topandbottommargin
9112 \pageheight = \vsize
9115 \outerhsize = \hsize
9116 \advance\outerhsize by 0.5in
9119 \normaloffset = #4\relax
9120 \bindingoffset = #5\relax
9123 \pdfpageheight #7\relax
9124 \pdfpagewidth #8\relax
9125 % if we don't reset these, they will remain at "1 true in" of
9126 % whatever layout pdftex was dumped with.
9127 \pdfhorigin = 1 true in
9128 \pdfvorigin = 1 true in
9131 \setleading{\textleading}
9133 \parindent = \defaultparindent
9134 \setemergencystretch
9137 % @letterpaper (the default).
9138 \def\letterpaper{{\globaldefs = 1
9139 \parskip = 3pt plus 2pt minus 1pt
9140 \textleading = 13.2pt
9142 % If page is nothing but text, make it come out even.
9143 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9145 {\bindingoffset}{36pt}%
9149 % Use @smallbook to reset parameters for 7x9.25 trim size.
9150 \def\smallbook{{\globaldefs = 1
9151 \parskip = 2pt plus 1pt
9154 \internalpagesizes{7.5in}{5in}%
9156 {\bindingoffset}{16pt}%
9159 \lispnarrowing = 0.3in
9162 \contentsrightmargin = 0pt
9163 \defbodyindent = .5cm
9166 % Use @smallerbook to reset parameters for 6x9 trim size.
9167 % (Just testing, parameters still in flux.)
9168 \def\smallerbook{{\globaldefs = 1
9169 \parskip = 1.5pt plus 1pt
9172 \internalpagesizes{7.4in}{4.8in}%
9177 \lispnarrowing = 0.25in
9180 \contentsrightmargin = 0pt
9181 \defbodyindent = .4cm
9184 % Use @afourpaper to print on European A4 paper.
9185 \def\afourpaper{{\globaldefs = 1
9186 \parskip = 3pt plus 2pt minus 1pt
9187 \textleading = 13.2pt
9189 % Double-side printing via postscript on Laserjet 4050
9190 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9191 % To change the settings for a different printer or situation, adjust
9192 % \normaloffset until the front-side and back-side texts align. Then
9193 % do the same for \bindingoffset. You can set these for testing in
9194 % your texinfo source file like this:
9196 % \global\normaloffset = -6mm
9197 % \global\bindingoffset = 10mm
9199 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9200 {\voffset}{\hoffset}%
9201 {\bindingoffset}{44pt}%
9206 \contentsrightmargin = 0pt
9207 \defbodyindent = 5mm
9210 % Use @afivepaper to print on European A5 paper.
9211 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9212 % He also recommends making @example and @lisp be small.
9213 \def\afivepaper{{\globaldefs = 1
9214 \parskip = 2pt plus 1pt minus 0.1pt
9215 \textleading = 12.5pt
9217 \internalpagesizes{160mm}{120mm}%
9218 {\voffset}{\hoffset}%
9219 {\bindingoffset}{8pt}%
9222 \lispnarrowing = 0.2in
9225 \contentsrightmargin = 0pt
9226 \defbodyindent = 2mm
9230 % A specific text layout, 24x15cm overall, intended for A4 paper.
9231 \def\afourlatex{{\globaldefs = 1
9233 \internalpagesizes{237mm}{150mm}%
9235 {\bindingoffset}{7mm}%
9238 % Must explicitly reset to 0 because we call \afourpaper.
9242 % Use @afourwide to print on A4 paper in landscape format.
9243 \def\afourwide{{\globaldefs = 1
9245 \internalpagesizes{241mm}{165mm}%
9246 {\voffset}{-2.95mm}%
9247 {\bindingoffset}{7mm}%
9252 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9253 % Perhaps we should allow setting the margins, \topskip, \parskip,
9254 % and/or leading, also. Or perhaps we should compute them somehow.
9256 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9257 \def\pagesizesyyy#1,#2,#3\finish{{%
9258 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9261 \parskip = 3pt plus 2pt minus 1pt
9262 \setleading{\textleading}%
9265 \advance\dimen0 by \voffset
9268 \advance\dimen2 by \normaloffset
9270 \internalpagesizes{#1}{\hsize}%
9271 {\voffset}{\normaloffset}%
9272 {\bindingoffset}{44pt}%
9276 % Set default to letter.
9281 \message{and turning on texinfo input format.}
9283 % DEL is a comment character, in case @c does not suffice.
9286 % Define macros to output various characters with catcode for normal text.
9296 \def\normaldoublequote{"}
9299 \def\normalunderscore{_}
9300 \def\normalverticalbar{|}
9302 \def\normalgreater{>}
9304 \def\normaldollar{$}%$ font-lock fix
9306 % This macro is used to make a character print one way in \tt
9307 % (where it can probably be output as-is), and another way in other fonts,
9308 % where something hairier probably needs to be done.
9310 % #1 is what to print if we are indeed using \tt; #2 is what to print
9311 % otherwise. Since all the Computer Modern typewriter fonts have zero
9312 % interword stretch (and shrink), and it is reasonable to expect all
9313 % typewriter fonts to have this, we can check that font parameter.
9315 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9317 % Same as above, but check for italic font. Actually this also catches
9318 % non-italic slanted fonts since it is impossible to distinguish them from
9319 % italic fonts. But since this is only used by $ and it uses \sl anyway
9320 % this is not a problem.
9321 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9323 % Turn off all special characters except @
9324 % (and those which the user can use as if they were ordinary).
9325 % Most of these we simply print from the \tt font, but for some, we can
9326 % use math or other variants that look better in normal text.
9329 \def\activedoublequote{{\tt\char34}}
9330 \let"=\activedoublequote
9332 \def~{{\tt\char126}}
9338 \def_{\ifusingtt\normalunderscore\_}
9340 % Subroutine for the previous macro.
9341 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9344 \def|{{\tt\char124}}
9352 \def+{{\tt \char 43}}
9354 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9356 % If a .fmt file is being used, characters that might appear in a file
9357 % name cannot be active until we have parsed the command line.
9358 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9359 % \otherifyactive is called near the end of this file.
9360 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9362 % Used sometimes to turn off (effectively) the active characters even after
9364 \def\turnoffactive{%
9365 \normalturnoffactive
9371 % \backslashcurfont outputs one backslash character in current font,
9373 \global\chardef\backslashcurfont=`\\
9374 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9376 % \realbackslash is an actual character `\' with catcode other, and
9377 % \doublebackslash is two of them (for the pdf outlines).
9378 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9380 % In texinfo, backslash is an active character; it prints the backslash
9381 % in fixed width font.
9383 @def@normalbackslash{{@tt@backslashcurfont}}
9384 % On startup, @fixbackslash assigns:
9385 % @let \ = @normalbackslash
9387 % \rawbackslash defines an active \ to do \backslashcurfont.
9388 % \otherbackslash defines an active \ to be a literal `\' character with
9390 @gdef@rawbackslash{@let\=@backslashcurfont}
9391 @gdef@otherbackslash{@let\=@realbackslash}
9393 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9394 % the literal character `\'.
9396 @def@normalturnoffactive{%
9397 @let\=@normalbackslash
9398 @let"=@normaldoublequote
9401 @let_=@normalunderscore
9402 @let|=@normalverticalbar
9404 @let>=@normalgreater
9406 @let$=@normaldollar %$ font-lock fix
9407 @markupsetuplqdefault
9408 @markupsetuprqdefault
9412 % Make _ and + \other characters, temporarily.
9413 % This is canceled by @fixbackslash.
9416 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9417 % That is what \eatinput is for; after that, the `\' should revert to printing
9420 @gdef@eatinput input texinfo{@fixbackslash}
9421 @global@let\ = @eatinput
9423 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9424 % the first `\' in the file would cause an error. This macro tries to fix
9425 % that, assuming it is called before the first `\' could plausibly occur.
9426 % Also turn back on active characters that might appear in the input
9427 % file name, in case not using a pre-dumped format.
9429 @gdef@fixbackslash{%
9430 @ifx\@eatinput @let\ = @normalbackslash @fi
9435 % Say @foo, not \foo, in error messages.
9438 % These look ok in all fonts, so just make them not special.
9439 @catcode`@& = @other
9440 @catcode`@# = @other
9441 @catcode`@% = @other
9443 @c Finally, make ` and ' active, so that txicodequoteundirected and
9444 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9445 @c don't make ` and ' active, @code will not get them as active chars.
9446 @c Do this last of all since we use ` in the previous @catcode assignments.
9449 @markupsetuplqdefault
9450 @markupsetuprqdefault
9453 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9454 @c page-delimiter: "^\\\\message"
9455 @c time-stamp-start: "def\\\\texinfoversion{"
9456 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9457 @c time-stamp-end: "}"
9463 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115