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{2003-07-27.17}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at
14 % your option) any later version.
16 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details.
21 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 % Boston, MA 02111-1307, USA.
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org),
36 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
40 % The texinfo.tex in any given Texinfo distribution could well be out
41 % of date, so if that's what you're using, please check.
43 % Send bug reports to bug-texinfo@gnu.org. Please include including a
44 % complete document in each bug report with which we can reproduce the
45 % problem. Patches are, of course, greatly appreciated.
47 % To process a Texinfo manual with TeX, it's most reliable to use the
48 % texi2dvi shell script that comes with the distribution. For a simple
49 % manual foo.texi, however, you can get away with this:
54 % dvips foo.dvi -o # or whatever; this makes foo.ps.
55 % The extra TeX runs get the cross-reference information correct.
56 % Sometimes one run after texindex suffices, and sometimes you need more
57 % than two; texi2dvi does it as many times as necessary.
59 % It is possible to adapt texinfo.tex for other languages, to some
60 % extent. You can get the existing language-specific files from the
61 % full Texinfo distribution.
63 \message{Loading texinfo [version \texinfoversion]:}
65 % If in a .fmt file, print the version number
66 % and turn on active characters that we couldn't do earlier because
67 % they might have appeared in the input file name.
68 \everyjob{\message{[Texinfo version \texinfoversion]}%
69 \catcode`+=\active \catcode`\_=\active}
74 % We never want plain's \outer definition of \+ in Texinfo.
75 % For @tex, we can use \tabalign.
78 % Save some plain tex macros whose names we will redefine.
80 \let\ptexbullet=\bullet
91 \let\ptexindent=\indent
100 % If this character appears in an error message or help string, it
101 % starts a new line in the output.
104 % Set up fixed words for English if not already set.
105 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
106 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
107 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
108 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
109 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
110 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
111 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
112 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
113 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
114 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
115 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
116 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
117 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
118 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
119 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
120 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
121 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
122 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
123 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
125 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
126 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
127 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
128 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
129 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
130 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
131 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
132 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
133 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
134 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
135 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
136 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
138 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
139 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
140 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
141 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
142 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
143 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
144 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
146 % In some macros, we cannot use the `\? notation---the left quote is
147 % in some cases the escape char.
148 \chardef\colonChar = `\:
149 \chardef\commaChar = `\,
150 \chardef\dotChar = `\.
151 \chardef\equalChar = `\=
152 \chardef\exclamChar= `\!
153 \chardef\questChar = `\?
154 \chardef\semiChar = `\;
155 \chardef\spaceChar = `\ %
156 \chardef\underChar = `\_
162 % True if #1 is the empty string, i.e., called like `\ifempty{}'.
164 \def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}%
165 \def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}%
168 \hyphenation{ap-pen-dix}
170 \hyphenation{mini-buf-fer mini-buf-fers}
171 \hyphenation{time-stamp}
172 \hyphenation{white-space}
174 % Margin to add to right of even pages, to left of odd pages.
175 \newdimen\bindingoffset
176 \newdimen\normaloffset
177 \newdimen\pagewidth \newdimen\pageheight
179 % Sometimes it is convenient to have everything in the transcript file
180 % and nothing on the terminal. We don't just call \tracingall here,
181 % since that produces some useless output on the terminal. We also make
182 % some effort to order the tracing commands to reduce output in the log
183 % file; cf. trace.sty in LaTeX.
185 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
189 \tracinglostchars2 % 2 gives us more in etex
194 \showboxbreadth\maxdimen \showboxdepth\maxdimen
195 \ifx\eTeXversion\undefined\else % etex gives us more logging
202 \tracingcommands3 % 3 gives us more in etex
203 \errorcontextlines\maxdimen
206 % add check for \lastpenalty to plain's definitions. If the last thing
207 % we did was a \nobreak, we don't want to insert more space.
209 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
210 \removelastskip\penalty-50\smallskip\fi\fi}
211 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
212 \removelastskip\penalty-100\medskip\fi\fi}
213 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
214 \removelastskip\penalty-200\bigskip\fi\fi}
216 % For @cropmarks command.
217 % Do @cropmarks to get crop marks.
220 \let\cropmarks = \cropmarkstrue
222 % Dimensions to add cropmarks at corners.
223 % Added by P. A. MacKay, 12 Nov. 1986
225 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
226 \newdimen\cornerlong \cornerlong=1pc
227 \newdimen\cornerthick \cornerthick=.3pt
228 \newdimen\topandbottommargin \topandbottommargin=.75in
230 % Main output routine.
232 \output = {\onepageout{\pagecontents\PAGE}}
237 % \onepageout takes a vbox as an argument. Note that \pagecontents
238 % does insertions, but you have to call it yourself.
240 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
242 \ifodd\pageno \advance\hoffset by \bindingoffset
243 \else \advance\hoffset by -\bindingoffset\fi
245 % Do this outside of the \shipout so @code etc. will be expanded in
246 % the headline as they should be, not taken literally (outputting ''code).
247 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
248 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
251 % Have to do this stuff outside the \shipout because we want it to
252 % take effect in \write's, yet the group defined by the \vbox ends
253 % before the \shipout runs.
255 \escapechar = `\\ % use backslash in output files.
256 \indexdummies % don't expand commands in the output.
257 \normalturnoffactive % \ in index entries must not stay \, e.g., if
258 % the page break happens to be in the middle of an example.
260 % Do this early so pdf references go to the beginning of the page.
261 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
263 \ifcropmarks \vbox to \outervsize\bgroup
265 \vskip-\topandbottommargin
267 \line{\ewtop\hfil\ewtop}%
270 \vbox{\moveleft\cornerthick\nstop}%
272 \vbox{\moveright\cornerthick\nstop}%
275 \vskip\topandbottommargin
277 \hfil % center the page within the outer (page) hsize.
278 \ifodd\pageno\hskip\bindingoffset\fi
284 \ifdim\ht\footlinebox > 0pt
285 % Only leave this space if the footline is nonempty.
286 % (We lessened \vsize for it in \oddfootingxxx.)
287 % The \baselineskip=24pt in plain's \makefootline has no effect.
288 \vskip 2\baselineskip
293 \egroup % end of \vbox\bgroup
294 \hfil\egroup % end of (centering) \line\bgroup
295 \vskip\topandbottommargin plus1fill minus1fill
296 \boxmaxdepth = \cornerthick
299 \vbox{\moveleft\cornerthick\nsbot}%
301 \vbox{\moveright\cornerthick\nsbot}%
304 \line{\ewbot\hfil\ewbot}%
306 \egroup % \vbox from first cropmarks clause
308 }% end of \shipout\vbox
309 }% end of group with \normalturnoffactive
311 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
314 \newinsert\margin \dimen\margin=\maxdimen
316 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
318 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
319 % marginal hacks, juha@viisa.uucp (Juha Takala)
320 \ifvoid\margin\else % marginal info is present
321 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
322 \dimen@=\dp#1 \unvbox#1
323 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
324 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
327 % Here are the rules for the cropmarks. Note that they are
328 % offset so that the space between them is truly \outerhsize or \outervsize
329 % (P. A. MacKay, 12 November, 1986)
331 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
333 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
334 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
336 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
338 % Parse an argument, then pass it to #1. The argument is the rest of
339 % the input line (except we remove a trailing comment). #1 should be a
340 % macro which expects an ordinary undelimited TeX argument.
346 \futurelet\temp\parseargx
349 % If the next token is an obeyed space (from an @example environment or
350 % the like), remove it and recurse. Otherwise, we're done.
352 % \obeyedspace is defined far below, after the definition of \sepspaces.
353 \ifx\obeyedspace\temp
354 \expandafter\parseargdiscardspace
356 \expandafter\parseargline
360 % Remove a single space (as the delimiter token to the macro call).
362 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
365 \gdef\parseargline#1^^M{%
366 \endgroup % End of the group started in \parsearg.
368 % First remove any @c comment, then any @comment.
369 % Result of each macro is put in \toks0.
370 \argremovec #1\c\relax %
371 \expandafter\argremovecomment \the\toks0 \comment\relax %
373 % Call the caller's macro, saved as \next in \parsearg.
374 \expandafter\next\expandafter{\the\toks0}%
378 % Since all \c{,omment} does is throw away the argument, we can let TeX
379 % do that for us. The \relax here is matched by the \relax in the call
380 % in \parseargline; it could be more or less anything, its purpose is
381 % just to delimit the argument to the \c.
382 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
383 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
385 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
386 % @end itemize @c foo
387 % will have two active spaces as part of the argument with the
388 % `itemize'. Here we remove all active spaces from #1, and assign the
391 % This loses if there are any *other* active characters besides spaces
392 % in the argument -- _ ^ +, for example -- since they get expanded.
393 % Fortunately, Texinfo does not define any such commands. (If it ever
394 % does, the catcode of the characters in questionwill have to be changed
395 % here.) But this means we cannot call \removeactivespaces as part of
396 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
397 % that \parsearg gets might well have any character at all in it.
399 \def\removeactivespaces#1{%
403 \global\toks0 = \expandafter{\temp}%
407 % Change the active space to expand to nothing.
411 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
415 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
417 %% These are used to keep @begin/@end levels from running away
418 %% Call \inENV within environments (after a \begingroup)
419 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
421 \ifENV\errmessage{Still within an environment; press RETURN to continue}
422 \endgroup\fi} % This is not perfect, but it should reduce lossage
424 % @begin foo is the same as @foo, for now.
425 \newhelp\EMsimple{Press RETURN to continue.}
427 \outer\def\begin{\parsearg\beginxxx}
430 \expandafter\ifx\csname #1\endcsname\relax
431 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
432 \csname #1\endcsname\fi}
434 % @end foo executes the definition of \Efoo.
436 \def\end{\parsearg\endxxx}
438 \removeactivespaces{#1}%
439 \edef\endthing{\the\toks0}%
441 \expandafter\ifx\csname E\endthing\endcsname\relax
442 \expandafter\ifx\csname \endthing\endcsname\relax
443 % There's no \foo, i.e., no ``environment'' foo.
445 \errmessage{Undefined command `@end \endthing'}%
447 \unmatchedenderror\endthing
450 % Everything's ok; the right environment has been started.
451 \csname E\endthing\endcsname
455 % There is an environment #1, but it hasn't been started. Give an error.
457 \def\unmatchedenderror#1{%
459 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
462 % Define the control sequence \E#1 to give an unmatched @end error.
464 \def\defineunmatchedend#1{%
465 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
469 %% Simple single-character @ commands
472 % Kludge this until the fonts are right (grr).
475 % This is turned off because it was never documented
476 % and you can use @w{...} around a quote to suppress ligatures.
477 %% Define @` and @' to be the same as ` and '
478 %% but suppressing ligatures.
482 % Used to generate quoted braces.
483 \def\mylbrace {{\tt\char123}}
484 \def\myrbrace {{\tt\char125}}
488 % Definitions to produce \{ and \} commands for indices,
489 % and @{ and @} for the aux file.
490 \catcode`\{ = \other \catcode`\} = \other
491 \catcode`\[ = 1 \catcode`\] = 2
492 \catcode`\! = 0 \catcode`\\ = \other
495 !gdef!lbraceatcmd[@{]%
496 !gdef!rbraceatcmd[@}]%
499 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
500 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
503 \def\ringaccent#1{{\accent23 #1}}
508 % Other special characters: @questiondown @exclamdown
509 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
510 \def\questiondown{?`}
513 % Dotless i and dotless j, used for accents.
518 \ifx\temp\imacro \ptexi
519 \else\ifx\temp\jmacro \j
520 \else \errmessage{@dotless can be used only with i or j}%
524 % Be sure we're in horizontal mode when doing a tie, since we make space
525 % equivalent to this in @example-like environments. Otherwise, a space
526 % at the beginning of a line will start with \penalty -- and
527 % since \penalty is valid in vertical mode, we'd end up putting the
528 % penalty on the vertical list instead of in the new paragraph.
530 % Avoid using \@M directly, because that causes trouble
531 % if the definition is written into an index file.
532 \global\let\tiepenalty = \@M
533 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
536 % @: forces normal size whitespace following.
537 \def\:{\spacefactor=1000 }
539 % @* forces a line break.
540 \def\*{\hfil\break\hbox{}\ignorespaces}
542 % @/ allows a line break.
545 % @. is an end-of-sentence period.
546 \def\.{.\spacefactor=3000 }
548 % @! is an end-of-sentence bang.
549 \def\!{!\spacefactor=3000 }
551 % @? is an end-of-sentence query.
552 \def\?{?\spacefactor=3000 }
554 % @w prevents a word break. Without the \leavevmode, @w at the
555 % beginning of a paragraph, when TeX is still in vertical mode, would
556 % produce a whole line of output instead of starting the paragraph.
557 \def\w#1{\leavevmode\hbox{#1}}
559 % @group ... @end group forces ... to be all on one page, by enclosing
560 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
561 % to keep its height that of a normal line. According to the rules for
562 % \topskip (p.114 of the TeXbook), the glue inserted is
563 % max (\topskip - \ht (first item), 0). If that height is large,
564 % therefore, no glue is inserted, and the space between the headline and
565 % the text is small, which looks bad.
567 % Another complication is that the group might be very large. This can
568 % cause the glue on the previous page to be unduly stretched, because it
569 % does not have much material. In this case, it's better to add an
570 % explicit \vfill so that the extra space is at the bottom. The
571 % threshold for doing this is if the group is more than \vfilllimit
572 % percent of a page (\vfilllimit can be changed inside of @tex).
577 \def\group{\begingroup
578 \ifnum\catcode13=\active \else
579 \errhelp = \groupinvalidhelp
580 \errmessage{@group invalid in context where filling is enabled}%
583 % The \vtop we start below produces a box with normal height and large
584 % depth; thus, TeX puts \baselineskip glue before it, and (when the
585 % next line of text is done) \lineskip glue after it. (See p.82 of
586 % the TeXbook.) Thus, space below is not quite equal to space
587 % above. But it's pretty close.
589 \egroup % End the \vtop.
590 % \dimen0 is the vertical size of the group's box.
591 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
592 % \dimen2 is how much space is left on the page (more or less).
593 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
594 % if the group doesn't fit on the current page, and it's a big big
595 % group, force a page break.
596 \ifdim \dimen0 > \dimen2
597 \ifdim \pagetotal < \vfilllimit\pageheight
602 \endgroup % End the \group.
605 \setbox\groupbox = \vtop\bgroup
606 % We have to put a strut on the last line in case the @group is in
607 % the midst of an example, rather than completely enclosing it.
608 % Otherwise, the interline space between the last line of the group
609 % and the first line afterwards is too small. But we can't put the
610 % strut in \Egroup, since there it would be on a line by itself.
611 % Hence this just inserts a strut at the beginning of each line.
612 \everypar = {\strut}%
614 % Since we have a strut on every line, we don't need any of TeX's
615 % normal interline spacing.
618 % OK, but now we have to do something about blank
619 % lines in the input in @example-like environments, which normally
620 % just turn into \lisppar, which will insert no space now that we've
621 % turned off the interline space. Simplest is to make them be an
624 \edef\par{\leavevmode \par}%
626 % Reset ^^M's definition to new definition of \par.
630 % Do @comment since we are called inside an environment such as
631 % @example, where each end-of-line in the input causes an
632 % end-of-line in the output. We don't want the end-of-line after
633 % the `@group' to put extra space in the output. Since @group
634 % should appear on a line by itself (according to the Texinfo
635 % manual), we don't worry about eating any user text.
639 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
640 % message, so this ends up printing `@group can only ...'.
642 \newhelp\groupinvalidhelp{%
643 group can only be used in environments such as @example,^^J%
644 where each line of input produces a line of output.}
646 % @need space-in-mils
647 % forces a page break if there is not space-in-mils remaining.
649 \newdimen\mil \mil=0.001in
651 \def\need{\parsearg\needx}
653 % Old definition--didn't work.
654 %\def\needx #1{\par %
655 %% This method tries to make TeX break the page naturally
656 %% if the depth of the box does not fit.
658 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
663 % Ensure vertical mode, so we don't make a big box in the middle of a
667 % If the @need value is less than one line space, it's useless.
669 \dimen2 = \ht\strutbox
670 \advance\dimen2 by \dp\strutbox
671 \ifdim\dimen0 > \dimen2
673 % Do a \strut just to make the height of this box be normal, so the
674 % normal leading is inserted relative to the preceding line.
675 % And a page break here is fine.
676 \vtop to #1\mil{\strut\vfil}%
678 % TeX does not even consider page breaks if a penalty added to the
679 % main vertical list is 10000 or more. But in order to see if the
680 % empty box we just added fits on the page, we must make it consider
681 % page breaks. On the other hand, we don't want to actually break the
682 % page after the empty box. So we use a penalty of 9999.
684 % There is an extremely small chance that TeX will actually break the
685 % page at this \penalty, if there are no other feasible breakpoints in
686 % sight. (If the user is using lots of big @group commands, which
687 % almost-but-not-quite fill up a page, TeX will have a hard time doing
688 % good page breaking, for example.) However, I could not construct an
689 % example where a page broke at this \penalty; if it happens in a real
690 % document, then we can reconsider our strategy.
693 % Back up by the size of the box, whether we did a page break or not.
696 % Do not allow a page break right after this kern.
701 % @br forces paragraph break
705 % @dots{} output an ellipsis using the current font.
706 % We do .5em per period so that it has the same spacing in a typewriter
707 % font as three actual period characters.
712 \hskip 0pt plus 0.25fil minus 0.25fil
714 \hskip 0pt plus 0.5fil minus 0.5fil
718 % @enddots{} is an end-of-sentence ellipsis.
723 \hskip 0pt plus 0.25fil minus 0.25fil
725 \hskip 0pt plus 0.5fil minus 0.5fil
730 % @page forces the start of a new page.
732 \def\page{\par\vfill\supereject}
735 % outputs text on separate line in roman font, starting at standard page margin
737 % This records the amount of indent in the innermost environment.
738 % That's how much \exdent should take out.
739 \newskip\exdentamount
741 % This defn is used inside fill environments such as @defun.
742 \def\exdent{\parsearg\exdentyyy}
743 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
745 % This defn is used inside nofill environments such as @example.
746 \def\nofillexdent{\parsearg\nofillexdentyyy}
747 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
748 \leftline{\hskip\leftskip{\rm#1}}}}
750 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
751 % paragraph. For more general purposes, use the \margin insertion
752 % class. WHICH is `l' or `r'.
754 \newskip\inmarginspacing \inmarginspacing=1cm
755 \def\strutdepth{\dp\strutbox}
757 \def\doinmargin#1#2{\strut\vadjust{%
760 \vtop to \strutdepth{%
761 \baselineskip=\strutdepth
763 % if you have multiple lines of stuff to put here, you'll need to
764 % make the vbox yourself of the appropriate size.
766 \llap{\ignorespaces #2\hskip\inmarginspacing}%
768 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
773 \def\inleftmargin{\doinmargin l}
774 \def\inrightmargin{\doinmargin r}
776 % @inmargin{TEXT [, RIGHT-TEXT]}
777 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
778 % else use TEXT for both).
780 \def\inmargin#1{\parseinmargin #1,,\finish}
781 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
782 \setbox0 = \hbox{\ignorespaces #2}%
784 \def\lefttext{#1}% have both texts
787 \def\lefttext{#1}% have only one text
792 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
794 \def\temp{\inleftmargin\lefttext}%
799 % @include file insert text of that file as input.
800 % Allow normal characters that we make active in the argument (a file name).
801 \def\include{\begingroup
810 \parsearg\includezzz}
811 % Restore active chars for included file.
812 \def\includezzz#1{\endgroup\begingroup
813 % Read the included file in a group so nested @include's work.
815 \let\value=\expandablevalue
822 % outputs that line, centered.
824 \def\center{\parsearg\docenter}
826 \ifhmode \hfil\break \fi
827 \advance\hsize by -\leftskip
828 \advance\hsize by -\rightskip
829 \line{\hfil \ignorespaces#1\unskip \hfil}%
833 % @sp n outputs n lines of vertical space
835 \def\sp{\parsearg\spxxx}
836 \def\spxxx #1{\vskip #1\baselineskip}
838 % @comment ...line which is ignored...
839 % @c is the same as @comment
840 % @ignore ... @end ignore is another way to write a comment
842 \def\comment{\begingroup \catcode`\^^M=\other%
843 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
845 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
849 % @paragraphindent NCHARS
850 % We'll use ems for NCHARS, close enough.
851 % NCHARS can also be the word `asis' or `none'.
852 % We cannot feasibly implement @paragraphindent asis, though.
854 \def\asisword{asis} % no translation, these are keywords
857 \def\paragraphindent{\parsearg\doparagraphindent}
858 \def\doparagraphindent#1{%
863 \defaultparindent = 0pt
865 \defaultparindent = #1em
868 \parindent = \defaultparindent
871 % @exampleindent NCHARS
872 % We'll use ems for NCHARS like @paragraphindent.
873 % It seems @exampleindent asis isn't necessary, but
874 % I preserve it to make it similar to @paragraphindent.
875 \def\exampleindent{\parsearg\doexampleindent}
876 \def\doexampleindent#1{%
883 \lispnarrowing = #1em
888 % @firstparagraphindent WORD
889 % If WORD is `none', then suppress indentation of the first paragraph
890 % after a section heading. If WORD is `insert', then do indent at such
893 % The paragraph indentation is suppressed or not by calling
894 % \suppressfirstparagraphindent, which the sectioning commands do.
895 % We switch the definition of this back and forth according to WORD.
896 % By default, we suppress indentation.
898 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
899 \newdimen\currentparindent
901 \def\insertword{insert}
903 \def\firstparagraphindent{\parsearg\dofirstparagraphindent}
904 \def\dofirstparagraphindent#1{%
907 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
908 \else\ifx\temp\insertword
909 \let\suppressfirstparagraphindent = \relax
912 \errmessage{Unknown @firstparagraphindent option `\temp'}%
916 % Here is how we actually suppress indentation. Redefine \everypar to
917 % \kern backwards by \parindent, and then reset itself to empty.
919 % We also make \indent itself not actually do anything until the next
922 \gdef\dosuppressfirstparagraphindent{%
924 \global\let\indent=\ptexindent
925 \global\everypar = {}%
927 \global\everypar = {%
929 \global\let\indent=\ptexindent
930 \global\everypar = {}%
935 % @asis just yields its argument. Used with @table, for example.
939 % @math outputs its argument in math mode.
940 % We don't use $'s directly in the definition of \math because we need
941 % to set catcodes according to plain TeX first, to allow for subscripts,
942 % superscripts, special math chars, etc.
944 \let\implicitmath = $%$ font-lock fix
946 % One complication: _ usually means subscripts, but it could also mean
947 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
948 % _ within @math be active (mathcode "8000), and distinguish by seeing
949 % if the current family is \slfam, which is what @var uses.
951 {\catcode\underChar = \active
952 \gdef\mathunderscore{%
953 \catcode\underChar=\active
954 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
957 % Another complication: we want \\ (and @\) to output a \ character.
958 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
959 % this is not advertised and we don't care. Texinfo does not
960 % otherwise define @\.
962 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
963 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
967 \mathcode`\_="8000 \mathunderscore
968 \let\\ = \mathbackslash
970 \implicitmath\finishmath}
971 \def\finishmath#1{#1\implicitmath\Etex}
973 % Some active characters (such as <) are spaced differently in math.
974 % We have to reset their definitions in case the @math was an
975 % argument to a command which set the catcodes (such as @item or @section).
990 % @bullet and @minus need the same treatment as @math, just above.
991 \def\bullet{\implicitmath\ptexbullet\implicitmath}
992 \def\minus{\implicitmath-\implicitmath}
994 % @refill is a no-op.
997 % If working on a large document in chapters, it is convenient to
998 % be able to disable indexing, cross-referencing, and contents, for test runs.
999 % This is done with @novalidate (before @setfilename).
1001 \newif\iflinks \linkstrue % by default we want the aux files.
1002 \let\novalidate = \linksfalse
1004 % @setfilename is done at the beginning of every texinfo file.
1005 % So open here the files we need to have open while reading the input.
1006 % This makes it possible to make a .fmt file for texinfo.
1010 \fi % \openindices needs to do some work in any case.
1012 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1013 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
1015 % If texinfo.cnf is present on the system, read it.
1016 % Useful for site-wide @afourpaper, etc.
1017 % Just to be on the safe side, close the input stream before the \input.
1018 \openin 1 texinfo.cnf
1019 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
1023 \comment % Ignore the actual filename.
1026 % Called from \setfilename.
1038 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1042 % adobe `portable' document format
1046 \newcount\filenamelength
1055 \newif\ifpdfmakepagedest
1057 \ifx\pdfoutput\undefined
1059 \let\pdfmkdest = \gobble
1060 \let\pdfurl = \gobble
1061 \let\endlink = \relax
1062 \let\linkcolor = \relax
1063 \let\pdfmakeoutlines = \relax
1068 \def\dopdfimage#1#2#3{%
1069 \def\imagewidth{#2}%
1070 \def\imageheight{#3}%
1071 % without \immediate, pdftex seg faults when the same image is
1072 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1073 \ifnum\pdftexversion < 14
1076 \immediate\pdfximage
1078 \ifx\empty\imagewidth\else width \imagewidth \fi
1079 \ifx\empty\imageheight\else height \imageheight \fi
1080 \ifnum\pdftexversion<13
1085 \ifnum\pdftexversion < 14 \else
1086 \pdfrefximage \pdflastximage
1088 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
1090 \let\linkcolor = \Blue % was Cyan, but that seems light?
1091 \def\endlink{\Black\pdfendlink}
1092 % Adding outlines to PDF; macros for calculating structure of outlines
1093 % come from Petr Olsak
1094 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1095 \else \csname#1\endcsname \fi}
1096 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1097 \advance\tempnum by1
1098 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1099 \def\pdfmakeoutlines{{%
1100 \openin 1 \jobname.toc
1101 \ifeof 1\else\begingroup
1103 % Thanh's hack / proper braces in bookmarks
1104 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1105 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1107 \def\chapentry ##1##2##3{}
1108 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1109 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1110 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1111 \let\appendixentry = \chapentry
1112 \let\unnumbchapentry = \chapentry
1113 \let\unnumbsecentry = \secentry
1114 \let\unnumbsubsecentry = \subsecentry
1115 \let\unnumbsubsubsecentry = \subsubsecentry
1117 \def\chapentry ##1##2##3{%
1118 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1119 \def\secentry ##1##2##3##4{%
1120 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1121 \def\subsecentry ##1##2##3##4##5{%
1122 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1123 \def\subsubsecentry ##1##2##3##4##5##6{%
1124 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1125 \let\appendixentry = \chapentry
1126 \let\unnumbchapentry = \chapentry
1127 \let\unnumbsecentry = \secentry
1128 \let\unnumbsubsecentry = \subsecentry
1129 \let\unnumbsubsubsecentry = \subsubsecentry
1131 % Make special characters normal for writing to the pdf file.
1139 \def\makelinks #1,{%
1140 \def\params{#1}\def\E{END}%
1142 \let\nextmakelinks=\relax
1144 \let\nextmakelinks=\makelinks
1145 \ifnum\lnkcount>0,\fi
1147 \startlink attr{/Border [0 0 0]}
1148 goto name{\pdfmkpgn{\the\pgn}}%
1150 \advance\lnkcount by 1%
1155 \def\picknum#1{\expandafter\pn#1}
1166 \def\ppn#1{\pgn=#1\gobble}
1167 \def\ppnn{\pgn=\first}
1168 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1169 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1170 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1171 \ifx\PP\D\let\nextsp\relax
1172 \else\let\nextsp\skipspaces
1173 \ifx\p\space\else\addtokens{\filename}{\PP}%
1174 \advance\filenamelength by 1
1178 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1179 \ifnum\pdftexversion < 14
1180 \let \startlink \pdfannotlink
1182 \let \startlink \pdfstartlink
1186 \normalturnoffactive\def\@{@}%
1187 \let\value=\expandablevalue
1189 \startlink attr{/Border [0 0 0]}%
1190 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1193 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1194 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1195 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1196 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1198 \expandafter\poptoks\the\toksA|ENDTOKS|
1200 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1201 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1202 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1204 \ifnum0=\countA\else\makelink\fi
1205 \ifx\first.\let\next=\done\else
1207 \addtokens{\toksB}{\the\toksD}
1208 \ifx\first,\addtokens{\toksB}{\space}\fi
1210 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1212 \def\makelink{\addtokens{\toksB}%
1213 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1215 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1216 \linkcolor #1\endlink}
1217 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1218 \fi % \ifx\pdfoutput
1222 % Font-change commands.
1224 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1225 % So we set up a \sf analogous to plain's \rm, etc.
1227 \def\sf{\fam=\sffam \tensf}
1228 \let\li = \sf % Sometimes we call it \li, not \sf.
1230 % We don't need math for this one.
1234 \newdimen\textleading \textleading = 13.2pt
1236 % Set the baselineskip to #1, and the lineskip and strut size
1237 % correspondingly. There is no deep meaning behind these magic numbers
1238 % used as factors; they just match (closely enough) what Knuth defined.
1240 \def\lineskipfactor{.08333}
1241 \def\strutheightpercent{.70833}
1242 \def\strutdepthpercent {.29167}
1245 \normalbaselineskip = #1\relax
1246 \normallineskip = \lineskipfactor\normalbaselineskip
1248 \setbox\strutbox =\hbox{%
1249 \vrule width0pt height\strutheightpercent\baselineskip
1250 depth \strutdepthpercent \baselineskip
1254 % Set the font macro #1 to the font named #2, adding on the
1255 % specified font prefix (normally `cm').
1256 % #3 is the font's design size, #4 is a scale factor
1257 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1259 % Use cm as the default font prefix.
1260 % To specify the font prefix, you must define \fontprefix
1261 % before you read in texinfo.tex.
1262 \ifx\fontprefix\undefined
1265 % Support font families that don't use the same naming scheme as CM.
1267 \def\rmbshape{bx} %where the normal face is bold
1272 \def\ttslshape{sltt}
1282 \newcount\mainmagstep
1284 % not really supported.
1285 \mainmagstep=\magstep1
1286 \setfont\textrm\rmshape{12}{1000}
1287 \setfont\texttt\ttshape{12}{1000}
1289 \mainmagstep=\magstephalf
1290 \setfont\textrm\rmshape{10}{\mainmagstep}
1291 \setfont\texttt\ttshape{10}{\mainmagstep}
1293 % Instead of cmb10, you may want to use cmbx10.
1294 % cmbx10 is a prettier font on its own, but cmb10
1295 % looks better when embedded in a line with cmr10
1296 % (in Bob's opinion).
1297 \setfont\textbf\bfshape{10}{\mainmagstep}
1298 \setfont\textit\itshape{10}{\mainmagstep}
1299 \setfont\textsl\slshape{10}{\mainmagstep}
1300 \setfont\textsf\sfshape{10}{\mainmagstep}
1301 \setfont\textsc\scshape{10}{\mainmagstep}
1302 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1303 \font\texti=cmmi10 scaled \mainmagstep
1304 \font\textsy=cmsy10 scaled \mainmagstep
1306 % A few fonts for @defun, etc.
1307 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1308 \setfont\deftt\ttshape{10}{\magstep1}
1309 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1311 % Fonts for indices, footnotes, small examples (9pt).
1312 \setfont\smallrm\rmshape{9}{1000}
1313 \setfont\smalltt\ttshape{9}{1000}
1314 \setfont\smallbf\bfshape{10}{900}
1315 \setfont\smallit\itshape{9}{1000}
1316 \setfont\smallsl\slshape{9}{1000}
1317 \setfont\smallsf\sfshape{9}{1000}
1318 \setfont\smallsc\scshape{10}{900}
1319 \setfont\smallttsl\ttslshape{10}{900}
1323 % Fonts for small examples (8pt).
1324 \setfont\smallerrm\rmshape{8}{1000}
1325 \setfont\smallertt\ttshape{8}{1000}
1326 \setfont\smallerbf\bfshape{10}{800}
1327 \setfont\smallerit\itshape{8}{1000}
1328 \setfont\smallersl\slshape{8}{1000}
1329 \setfont\smallersf\sfshape{8}{1000}
1330 \setfont\smallersc\scshape{10}{800}
1331 \setfont\smallerttsl\ttslshape{10}{800}
1332 \font\smalleri=cmmi8
1333 \font\smallersy=cmsy8
1335 % Fonts for title page:
1336 \setfont\titlerm\rmbshape{12}{\magstep3}
1337 \setfont\titleit\itbshape{10}{\magstep4}
1338 \setfont\titlesl\slbshape{10}{\magstep4}
1339 \setfont\titlett\ttbshape{12}{\magstep3}
1340 \setfont\titlettsl\ttslshape{10}{\magstep4}
1341 \setfont\titlesf\sfbshape{17}{\magstep1}
1342 \let\titlebf=\titlerm
1343 \setfont\titlesc\scbshape{10}{\magstep4}
1344 \font\titlei=cmmi12 scaled \magstep3
1345 \font\titlesy=cmsy10 scaled \magstep4
1346 \def\authorrm{\secrm}
1347 \def\authortt{\sectt}
1349 % Chapter (and unnumbered) fonts (17.28pt).
1350 \setfont\chaprm\rmbshape{12}{\magstep2}
1351 \setfont\chapit\itbshape{10}{\magstep3}
1352 \setfont\chapsl\slbshape{10}{\magstep3}
1353 \setfont\chaptt\ttbshape{12}{\magstep2}
1354 \setfont\chapttsl\ttslshape{10}{\magstep3}
1355 \setfont\chapsf\sfbshape{17}{1000}
1357 \setfont\chapsc\scbshape{10}{\magstep3}
1358 \font\chapi=cmmi12 scaled \magstep2
1359 \font\chapsy=cmsy10 scaled \magstep3
1361 % Section fonts (14.4pt).
1362 \setfont\secrm\rmbshape{12}{\magstep1}
1363 \setfont\secit\itbshape{10}{\magstep2}
1364 \setfont\secsl\slbshape{10}{\magstep2}
1365 \setfont\sectt\ttbshape{12}{\magstep1}
1366 \setfont\secttsl\ttslshape{10}{\magstep2}
1367 \setfont\secsf\sfbshape{12}{\magstep1}
1369 \setfont\secsc\scbshape{10}{\magstep2}
1370 \font\seci=cmmi12 scaled \magstep1
1371 \font\secsy=cmsy10 scaled \magstep2
1373 % Subsection fonts (13.15pt).
1374 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1375 \setfont\ssecit\itbshape{10}{1315}
1376 \setfont\ssecsl\slbshape{10}{1315}
1377 \setfont\ssectt\ttbshape{12}{\magstephalf}
1378 \setfont\ssecttsl\ttslshape{10}{1315}
1379 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1381 \setfont\ssecsc\scbshape{10}{\magstep1}
1382 \font\sseci=cmmi12 scaled \magstephalf
1383 \font\ssecsy=cmsy10 scaled 1315
1384 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1385 % but that is not a standard magnification.
1387 % In order for the font changes to affect most math symbols and letters,
1388 % we have to define the \textfont of the standard families. Since
1389 % texinfo doesn't allow for producing subscripts and superscripts except
1390 % in the main text, we don't bother to reset \scriptfont and
1391 % \scriptscriptfont (which would also require loading a lot more fonts).
1393 \def\resetmathfonts{%
1394 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1395 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1396 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1399 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1400 % of just \STYLE. We do this so that font changes will continue to work
1401 % in math mode, where it is the current \fam that is relevant in most
1402 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1403 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1404 % redefine \bf itself.
1406 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1407 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1408 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1409 \resetmathfonts \setleading{\textleading}}
1411 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1412 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1413 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1414 \let\tenttsl=\titlettsl
1415 \resetmathfonts \setleading{25pt}}
1416 \def\titlefont#1{{\titlefonts\rm #1}}
1418 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1419 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1420 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1421 \resetmathfonts \setleading{19pt}}
1423 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1424 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1425 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1426 \resetmathfonts \setleading{16pt}}
1428 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1429 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1430 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1431 \resetmathfonts \setleading{15pt}}
1432 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1434 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1435 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1436 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1437 \let\tenttsl=\smallttsl
1438 \resetmathfonts \setleading{10.5pt}}
1440 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1441 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1442 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1443 \let\tenttsl=\smallerttsl
1444 \resetmathfonts \setleading{9.5pt}}
1446 % Set the fonts to use with the @small... environments.
1447 \let\smallexamplefonts = \smallfonts
1449 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1450 % can fit this many characters:
1451 % 8.5x11=86 smallbook=72 a4=90 a5=69
1452 % If we use \smallerfonts (8pt), then we can fit this many characters:
1453 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1454 % For me, subjectively, the few extra characters that fit aren't worth
1455 % the additional smallness of 8pt. So I'm making the default 9pt.
1457 % By the way, for comparison, here's what fits with @example (10pt):
1458 % 8.5x11=71 smallbook=60 a4=75 a5=58
1460 % I wish we used A4 paper on this side of the Atlantic.
1465 % Set up the default fonts, so we can use them for creating boxes.
1469 % Define these so they can be easily changed for other fonts.
1470 \def\angleleft{$\langle$}
1471 \def\angleright{$\rangle$}
1473 % Count depth in font-changes, for error checks
1474 \newcount\fontdepth \fontdepth=0
1476 % Fonts for short table of contents.
1477 \setfont\shortcontrm\rmshape{12}{1000}
1478 \setfont\shortcontbf\bxshape{12}{1000}
1479 \setfont\shortcontsl\slshape{12}{1000}
1480 \setfont\shortconttt\ttshape{12}{1000}
1482 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1483 %% serif) and @ii for TeX italic
1485 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1486 % unless the following character is such as not to need one.
1487 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1488 \ptexslash\fi\fi\fi}
1489 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1490 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1493 \let\var=\smartslanted
1494 \let\dfn=\smartslanted
1495 \let\emph=\smartitalic
1496 \let\cite=\smartslanted
1501 % We can't just use \exhyphenpenalty, because that only has effect at
1502 % the end of a paragraph. Restore normal hyphenation at the end of the
1503 % group within which \nohyphenation is presumably called.
1505 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1506 \def\restorehyphenation{\hyphenchar\font = `- }
1508 % Set sfcode to normal for the chars that usually have another value.
1509 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1510 % sometimes \x has an active definition that messes things up.
1513 \def\frenchspacing{%
1514 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1515 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1520 {\tt \rawbackslash \frenchspacing #1}%
1524 \def\samp#1{`\tclose{#1}'\null}
1525 \setfont\keyrm\rmshape{8}{1000}
1527 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1528 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1529 \vbox{\hrule\kern-0.4pt
1530 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1532 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1533 % The old definition, with no lozenge:
1534 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1535 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1537 % @file, @option are the same as @samp.
1541 % @code is a modification of @t,
1542 % which makes spaces the same size as normal in the surrounding text.
1545 % Change normal interword space to be same as for the current font.
1546 \spaceskip = \fontdimen2\font
1548 % Switch to typewriter.
1551 % But `\ ' produces the large typewriter interword space.
1552 \def\ {{\spaceskip = 0pt{} }}%
1554 % Turn off hyphenation.
1564 % We *must* turn on hyphenation at `-' and `_' in \code.
1565 % Otherwise, it is too hard to avoid overfull hboxes
1566 % in the Emacs manual, the Library manual, etc.
1568 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1569 % both hyphenation at - and hyphenation within words.
1570 % We must therefore turn them both off (\tclose does that)
1571 % and arrange explicitly to hyphenate at a dash.
1577 \global\def\code{\begingroup
1578 \catcode`\-=\active \let-\codedash
1579 \catcode`\_=\active \let_\codeunder
1583 % If we end up with any active - characters when handling the index,
1584 % just treat them as a normal -.
1585 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1589 \def\codedash{-\discretionary{}{}{}}
1591 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1592 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1593 % will therefore expand the active definition of _, which is us
1594 % (inside @code that is), therefore an endless loop.
1596 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1597 \else\normalunderscore \fi
1598 \discretionary{}{}{}}%
1601 \def\codex #1{\tclose{#1}\endgroup}
1603 % @kbd is like @code, except that if the argument is just one @key command,
1604 % then @kbd has no effect.
1606 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1607 % `example' (@kbd uses ttsl only inside of @example and friends),
1608 % or `code' (@kbd uses normal tty font always).
1609 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1610 \def\kbdinputstylexxx#1{%
1612 \ifx\arg\worddistinct
1613 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1614 \else\ifx\arg\wordexample
1615 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1616 \else\ifx\arg\wordcode
1617 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1619 \errhelp = \EMsimple
1620 \errmessage{Unknown @kbdinputstyle option `\arg'}%
1623 \def\worddistinct{distinct}
1624 \def\wordexample{example}
1627 % Default is `distinct.'
1628 \kbdinputstyle distinct
1631 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1632 \ifx\one\xkey\ifx\threex\three \key{#2}%
1633 \else{\tclose{\kbdfont\look}}\fi
1634 \else{\tclose{\kbdfont\look}}\fi}
1636 % For @url, @env, @command quotes seem unnecessary, so use \code.
1641 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1642 % second argument specifying the text to display and an optional third
1643 % arg as text to display instead of (rather than in addition to) the url
1644 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1645 % a hypertex \special here.
1647 \def\uref#1{\douref #1,,,\finish}
1648 \def\douref#1,#2,#3,#4\finish{\begingroup
1651 \setbox0 = \hbox{\ignorespaces #3}%
1653 \unhbox0 % third arg given, show only that
1655 \setbox0 = \hbox{\ignorespaces #2}%
1658 \unhbox0 % PDF: 2nd arg given, show only it
1660 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1663 \code{#1}% only url given, so show it
1669 % rms does not like angle brackets --karl, 17may97.
1670 % So now @email is just like @uref, unless we are pdf.
1672 %\def\email#1{\angleleft{\tt #1}\angleright}
1674 \def\email#1{\doemail#1,,\finish}
1675 \def\doemail#1,#2,#3\finish{\begingroup
1678 \setbox0 = \hbox{\ignorespaces #2}%
1679 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1686 % Check if we are currently using a typewriter font. Since all the
1687 % Computer Modern typewriter fonts have zero interword stretch (and
1688 % shrink), and it is reasonable to expect all typewriter fonts to have
1689 % this property, we can check that font parameter.
1691 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1693 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1694 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1696 \def\dmn#1{\thinspace #1}
1698 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1700 % @l was never documented to mean ``switch to the Lisp font'',
1701 % and it is not used as such in any manual I can find. We need it for
1702 % Polish suppressed-l. --karl, 22sep96.
1703 %\def\l#1{{\li #1}\null}
1705 % Explicit font changes: @r, @sc, undocumented @ii.
1706 \def\r#1{{\rm #1}} % roman font
1707 \def\sc#1{{\smallcaps#1}} % smallcaps font
1708 \def\ii#1{{\it #1}} % italic font
1710 % @acronym downcases the argument and prints in smallcaps.
1711 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1713 % @pounds{} is a sterling sign.
1714 \def\pounds{{\it\$}}
1716 % @registeredsymbol - R in a circle. For now, only works in text size;
1717 % we'd have to redo the font mechanism to change the \scriptstyle and
1718 % \scriptscriptstyle font sizes to make it look right in headings.
1719 % Adapted from the plain.tex definition of \copyright.
1721 \def\registeredsymbol{%
1722 $^{{\ooalign{\hfil\raise.07ex\hbox{$\scriptstyle\rm R$}\hfil\crcr\Orb}}%
1727 \message{page headings,}
1729 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1730 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1732 % First the title page. Must do @settitle before @titlepage.
1734 \newif\iffinishedtitlepage
1736 % Do an implicit @contents or @shortcontents after @end titlepage if the
1737 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1739 \newif\ifsetcontentsaftertitlepage
1740 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1741 \newif\ifsetshortcontentsaftertitlepage
1742 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1744 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1745 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1746 \endgroup\page\hbox{}\page}
1748 \def\titlepage{\begingroup \parindent=0pt \textfonts
1749 \let\subtitlerm=\tenrm
1750 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1752 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1755 % Leave some space at the very top of the page.
1756 \vglue\titlepagetopglue
1758 % Now you can print the title using @title.
1759 \def\title{\parsearg\titlezzz}%
1760 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1761 % print a rule at the page bottom also.
1762 \finishedtitlepagefalse
1763 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1764 % No rule at page bottom unless we print one at the top with @title.
1765 \finishedtitlepagetrue
1767 % Now you can put text using @subtitle.
1768 \def\subtitle{\parsearg\subtitlezzz}%
1769 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1771 % @author should come last, but may come many times.
1772 \def\author{\parsearg\authorzzz}%
1773 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1774 {\authorfont \leftline{##1}}}%
1776 % Most title ``pages'' are actually two pages long, with space
1777 % at the top of the second. We don't want the ragged left on the second.
1778 \let\oldpage = \page
1780 \iffinishedtitlepage\else
1784 \let\page = \oldpage
1786 % \def\page{\oldpage \hbox{}}
1790 \iffinishedtitlepage\else
1793 % It is important to do the page break before ending the group,
1794 % because the headline and footline are only empty inside the group.
1795 % If we use the new definition of \page, we always get a blank page
1796 % after the title page, which we certainly don't want.
1800 % Need this before the \...aftertitlepage checks so that if they are
1801 % in effect the toc pages will come out with page numbers.
1804 % If they want short, they certainly want long too.
1805 \ifsetshortcontentsaftertitlepage
1808 \global\let\shortcontents = \relax
1809 \global\let\contents = \relax
1812 \ifsetcontentsaftertitlepage
1814 \global\let\contents = \relax
1815 \global\let\shortcontents = \relax
1819 \def\finishtitlepage{%
1820 \vskip4pt \hrule height 2pt width \hsize
1821 \vskip\titlepagebottomglue
1822 \finishedtitlepagetrue
1825 %%% Set up page headings and footings.
1827 \let\thispage=\folio
1829 \newtoks\evenheadline % headline on even pages
1830 \newtoks\oddheadline % headline on odd pages
1831 \newtoks\evenfootline % footline on even pages
1832 \newtoks\oddfootline % footline on odd pages
1834 % Now make Tex use those variables
1835 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1836 \else \the\evenheadline \fi}}
1837 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1838 \else \the\evenfootline \fi}\HEADINGShook}
1839 \let\HEADINGShook=\relax
1841 % Commands to set those variables.
1842 % For example, this is what @headings on does
1843 % @evenheading @thistitle|@thispage|@thischapter
1844 % @oddheading @thischapter|@thispage|@thistitle
1845 % @evenfooting @thisfile||
1846 % @oddfooting ||@thisfile
1848 \def\evenheading{\parsearg\evenheadingxxx}
1849 \def\oddheading{\parsearg\oddheadingxxx}
1850 \def\everyheading{\parsearg\everyheadingxxx}
1852 \def\evenfooting{\parsearg\evenfootingxxx}
1853 \def\oddfooting{\parsearg\oddfootingxxx}
1854 \def\everyfooting{\parsearg\everyfootingxxx}
1858 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1859 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1860 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1862 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1863 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1864 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1866 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1868 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1869 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1870 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1872 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1873 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1874 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1876 % Leave some space for the footline. Hopefully ok to assume
1877 % @evenfooting will not be used by itself.
1878 \global\advance\pageheight by -\baselineskip
1879 \global\advance\vsize by -\baselineskip
1882 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1884 }% unbind the catcode of @.
1886 % @headings double turns headings on for double-sided printing.
1887 % @headings single turns headings on for single-sided printing.
1888 % @headings off turns them off.
1889 % @headings on same as @headings double, retained for compatibility.
1890 % @headings after turns on double-sided headings after this page.
1891 % @headings doubleafter turns on double-sided headings after this page.
1892 % @headings singleafter turns on single-sided headings after this page.
1893 % By default, they are off at the start of a document,
1894 % and turned `on' after @end titlepage.
1896 \def\headings #1 {\csname HEADINGS#1\endcsname}
1899 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1900 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1902 % When we turn headings on, set the page number to 1.
1903 % For double-sided printing, put current file name in lower left corner,
1904 % chapter name on inside top of right hand pages, document
1905 % title on inside top of left hand pages, and page numbers on outside top
1906 % edge of all pages.
1907 \def\HEADINGSdouble{
1909 \global\evenfootline={\hfil}
1910 \global\oddfootline={\hfil}
1911 \global\evenheadline={\line{\folio\hfil\thistitle}}
1912 \global\oddheadline={\line{\thischapter\hfil\folio}}
1913 \global\let\contentsalignmacro = \chapoddpage
1915 \let\contentsalignmacro = \chappager
1917 % For single-sided printing, chapter title goes across top left of page,
1918 % page number on top right.
1919 \def\HEADINGSsingle{
1921 \global\evenfootline={\hfil}
1922 \global\oddfootline={\hfil}
1923 \global\evenheadline={\line{\thischapter\hfil\folio}}
1924 \global\oddheadline={\line{\thischapter\hfil\folio}}
1925 \global\let\contentsalignmacro = \chappager
1927 \def\HEADINGSon{\HEADINGSdouble}
1929 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1930 \let\HEADINGSdoubleafter=\HEADINGSafter
1931 \def\HEADINGSdoublex{%
1932 \global\evenfootline={\hfil}
1933 \global\oddfootline={\hfil}
1934 \global\evenheadline={\line{\folio\hfil\thistitle}}
1935 \global\oddheadline={\line{\thischapter\hfil\folio}}
1936 \global\let\contentsalignmacro = \chapoddpage
1939 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1940 \def\HEADINGSsinglex{%
1941 \global\evenfootline={\hfil}
1942 \global\oddfootline={\hfil}
1943 \global\evenheadline={\line{\thischapter\hfil\folio}}
1944 \global\oddheadline={\line{\thischapter\hfil\folio}}
1945 \global\let\contentsalignmacro = \chappager
1948 % Subroutines used in generating headings
1949 % This produces Day Month Year style of output.
1950 % Only define if not already defined, in case a txi-??.tex file has set
1951 % up a different format (e.g., txi-cs.tex does this).
1952 \ifx\today\undefined
1956 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1957 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1958 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1963 % @settitle line... specifies the title of the document, for headings.
1964 % It generates no output of its own.
1965 \def\thistitle{\putwordNoTitle}
1966 \def\settitle{\parsearg\settitlezzz}
1967 \def\settitlezzz #1{\gdef\thistitle{#1}}
1971 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1973 % default indentation of table text
1974 \newdimen\tableindent \tableindent=.8in
1975 % default indentation of @itemize and @enumerate text
1976 \newdimen\itemindent \itemindent=.3in
1977 % margin between end of table item and start of table text.
1978 \newdimen\itemmargin \itemmargin=.1in
1980 % used internally for \itemindent minus \itemmargin
1983 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1985 % They also define \itemindex
1986 % to index the item name in whatever manner is desired (perhaps none).
1988 \newif\ifitemxneedsnegativevskip
1990 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1992 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1993 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1995 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1996 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1998 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1999 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
2001 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
2004 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
2007 \def\itemzzz #1{\begingroup %
2008 \advance\hsize by -\rightskip
2009 \advance\hsize by -\tableindent
2010 \setbox0=\hbox{\itemfont{#1}}%
2012 \nobreak % This prevents a break before @itemx.
2014 % If the item text does not fit in the space we have, put it on a line
2015 % by itself, and do not allow a page break either before or after that
2016 % line. We do not start a paragraph here because then if the next
2017 % command is, e.g., @kindex, the whatsit would get put into the
2018 % horizontal list on a line by itself, resulting in extra blank space.
2019 \ifdim \wd0>\itemmax
2021 % Make this a paragraph so we get the \parskip glue and wrapping,
2022 % but leave it ragged-right.
2024 \advance\leftskip by-\tableindent
2025 \advance\hsize by\tableindent
2026 \advance\rightskip by0pt plus1fil
2027 \leavevmode\unhbox0\par
2030 % We're going to be starting a paragraph, but we don't want the
2031 % \parskip glue -- logically it's part of the @item we just started.
2032 \nobreak \vskip-\parskip
2034 % Stop a page break at the \parskip glue coming up. (Unfortunately
2035 % we can't prevent a possible page break at the following
2036 % \baselineskip glue.) However, if what follows is an environment
2037 % such as @example, there will be no \parskip glue; then
2038 % the negative vskip we just would cause the example and the item to
2039 % crash together. So we use this bizarre value of 10001 as a signal
2040 % to \aboveenvbreak to insert \parskip glue after all.
2041 % (Possibly there are other commands that could be followed by
2042 % @example which need the same treatment, but not section titles; or
2043 % maybe section titles are the only special case and they should be
2047 \itemxneedsnegativevskipfalse
2049 % The item text fits into the space. Start a paragraph, so that the
2050 % following text (if any) will end up on the same line.
2052 % Do this with kerns and \unhbox so that if there is a footnote in
2053 % the item text, it can migrate to the main vertical list and
2054 % eventually be printed.
2055 \nobreak\kern-\tableindent
2056 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2058 \nobreak\kern\dimen0
2060 \itemxneedsnegativevskiptrue
2064 \def\item{\errmessage{@item while not in a table}}
2065 \def\itemx{\errmessage{@itemx while not in a table}}
2066 \def\kitem{\errmessage{@kitem while not in a table}}
2067 \def\kitemx{\errmessage{@kitemx while not in a table}}
2068 \def\xitem{\errmessage{@xitem while not in a table}}
2069 \def\xitemx{\errmessage{@xitemx while not in a table}}
2071 % Contains a kludge to get @end[description] to work.
2072 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
2074 % @table, @ftable, @vtable.
2075 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
2076 {\obeylines\obeyspaces%
2077 \gdef\tablex #1^^M{%
2078 \tabley\dontindex#1 \endtabley}}
2080 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
2081 {\obeylines\obeyspaces%
2082 \gdef\ftablex #1^^M{%
2083 \tabley\fnitemindex#1 \endtabley
2084 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
2085 \let\Etable=\relax}}
2087 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
2088 {\obeylines\obeyspaces%
2089 \gdef\vtablex #1^^M{%
2090 \tabley\vritemindex#1 \endtabley
2091 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
2092 \let\Etable=\relax}}
2095 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
2096 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
2099 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
2100 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
2102 \def\tablez #1#2#3#4#5#6{%
2105 \def\Edescription{\Etable}% Necessary kludge.
2107 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
2108 \ifnum 0#4>0 \tableindent=#4\mil \fi %
2109 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
2111 \itemmax=\tableindent %
2112 \advance \itemmax by -\itemmargin %
2113 \advance \leftskip by \tableindent %
2114 \exdentamount=\tableindent
2116 \parskip = \smallskipamount
2117 \ifdim \parskip=0pt \parskip=2pt \fi%
2118 \def\Etable{\endgraf\afterenvbreak\endgroup}%
2119 \let\item = \internalBitem %
2120 \let\itemx = \internalBitemx %
2121 \let\kitem = \internalBkitem %
2122 \let\kitemx = \internalBkitemx %
2123 \let\xitem = \internalBxitem %
2124 \let\xitemx = \internalBxitemx %
2127 % This is the counter used by @enumerate, which is really @itemize
2131 \def\itemize{\parsearg\itemizezzz}
2133 \def\itemizezzz #1{%
2134 \begingroup % ended by the @end itemize
2135 \itemizey {#1}{\Eitemize}
2140 \itemmax=\itemindent
2141 \advance\itemmax by -\itemmargin
2142 \advance\leftskip by \itemindent
2143 \exdentamount=\itemindent
2145 \parskip=\smallskipamount
2146 \ifdim\parskip=0pt \parskip=2pt \fi
2147 \def#2{\endgraf\afterenvbreak\endgroup}%
2148 \def\itemcontents{#1}%
2149 % @itemize with no arg is equivalent to @itemize @bullet.
2150 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2151 \let\item=\itemizeitem
2154 % \splitoff TOKENS\endmark defines \first to be the first token in
2155 % TOKENS, and \rest to be the remainder.
2157 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2159 % Allow an optional argument of an uppercase letter, lowercase letter,
2160 % or number, to specify the first label in the enumerated list. No
2161 % argument is the same as `1'.
2163 \def\enumerate{\parsearg\enumeratezzz}
2164 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2165 \def\enumeratey #1 #2\endenumeratey{%
2166 \begingroup % ended by the @end enumerate
2168 % If we were given no argument, pretend we were given `1'.
2170 \ifx\thearg\empty \def\thearg{1}\fi
2172 % Detect if the argument is a single token. If so, it might be a
2173 % letter. Otherwise, the only valid thing it can be is a number.
2174 % (We will always have one token, because of the test we just made.
2175 % This is a good thing, since \splitoff doesn't work given nothing at
2176 % all -- the first parameter is undelimited.)
2177 \expandafter\splitoff\thearg\endmark
2179 % Only one token in the argument. It could still be anything.
2180 % A ``lowercase letter'' is one whose \lccode is nonzero.
2181 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2182 % not equal to itself.
2183 % Otherwise, we assume it's a number.
2185 % We need the \relax at the end of the \ifnum lines to stop TeX from
2186 % continuing to look for a <number>.
2188 \ifnum\lccode\expandafter`\thearg=0\relax
2189 \numericenumerate % a number (we hope)
2192 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2193 \lowercaseenumerate % lowercase letter
2195 \uppercaseenumerate % uppercase letter
2199 % Multiple tokens in the argument. We hope it's a number.
2204 % An @enumerate whose labels are integers. The starting integer is
2207 \def\numericenumerate{%
2209 \startenumeration{\the\itemno}%
2212 % The starting (lowercase) letter is in \thearg.
2213 \def\lowercaseenumerate{%
2214 \itemno = \expandafter`\thearg
2216 % Be sure we're not beyond the end of the alphabet.
2218 \errmessage{No more lowercase letters in @enumerate; get a bigger
2225 % The starting (uppercase) letter is in \thearg.
2226 \def\uppercaseenumerate{%
2227 \itemno = \expandafter`\thearg
2229 % Be sure we're not beyond the end of the alphabet.
2231 \errmessage{No more uppercase letters in @enumerate; get a bigger
2238 % Call itemizey, adding a period to the first argument and supplying the
2239 % common last two arguments. Also subtract one from the initial value in
2240 % \itemno, since @item increments \itemno.
2242 \def\startenumeration#1{%
2243 \advance\itemno by -1
2244 \itemizey{#1.}\Eenumerate\flushcr
2247 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2250 \def\alphaenumerate{\enumerate{a}}
2251 \def\capsenumerate{\enumerate{A}}
2252 \def\Ealphaenumerate{\Eenumerate}
2253 \def\Ecapsenumerate{\Eenumerate}
2255 % Definition of @item while inside @itemize.
2258 \advance\itemno by 1
2259 {\let\par=\endgraf \smallbreak}%
2260 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2261 {\parskip=0in \hskip 0pt
2262 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2263 \vadjust{\penalty 1200}}%
2266 % @multitable macros
2267 % Amy Hendrickson, 8/18/94, 3/6/96
2269 % @multitable ... @end multitable will make as many columns as desired.
2270 % Contents of each column will wrap at width given in preamble. Width
2271 % can be specified either with sample text given in a template line,
2272 % or in percent of \hsize, the current width of text on page.
2274 % Table can continue over pages but will only break between lines.
2278 % Either define widths of columns in terms of percent of \hsize:
2279 % @multitable @columnfractions .25 .3 .45
2282 % Numbers following @columnfractions are the percent of the total
2283 % current hsize to be used for each column. You may use as many
2284 % columns as desired.
2287 % Or use a template:
2288 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2290 % using the widest term desired in each column.
2292 % For those who want to use more than one line's worth of words in
2293 % the preamble, break the line within one argument and it
2294 % will parse correctly, i.e.,
2296 % @multitable {Column 1 template} {Column 2 template} {Column 3
2299 % @multitable {Column 1 template} {Column 2 template}
2300 % {Column 3 template}
2302 % Each new table line starts with @item, each subsequent new column
2303 % starts with @tab. Empty columns may be produced by supplying @tab's
2304 % with nothing between them for as many times as empty columns are needed,
2305 % ie, @tab@tab@tab will produce two empty columns.
2307 % @item, @tab, @multitable or @end multitable do not need to be on their
2308 % own lines, but it will not hurt if they are.
2310 % Sample multitable:
2312 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2313 % @item first col stuff @tab second col stuff @tab third col
2320 % @item first col stuff @tab second col stuff
2321 % @tab Many paragraphs of text may be used in any column.
2323 % They will wrap at the width determined by the template.
2324 % @item@tab@tab This will be in third column.
2327 % Default dimensions may be reset by user.
2328 % @multitableparskip is vertical space between paragraphs in table.
2329 % @multitableparindent is paragraph indent in table.
2330 % @multitablecolmargin is horizontal space to be left between columns.
2331 % @multitablelinespace is space to leave between table items, baseline
2333 % 0pt means it depends on current normal line spacing.
2335 \newskip\multitableparskip
2336 \newskip\multitableparindent
2337 \newdimen\multitablecolspace
2338 \newskip\multitablelinespace
2339 \multitableparskip=0pt
2340 \multitableparindent=6pt
2341 \multitablecolspace=12pt
2342 \multitablelinespace=0pt
2344 % Macros used to set up halign preamble:
2346 \let\endsetuptable\relax
2347 \def\xendsetuptable{\endsetuptable}
2348 \let\columnfractions\relax
2349 \def\xcolumnfractions{\columnfractions}
2352 % #1 is the part of the @columnfraction before the decimal point, which
2353 % is presumably either 0 or the empty string (but we don't check, we
2354 % just throw it away). #2 is the decimal part, which we use as the
2355 % percent of \hsize for this column.
2356 \def\pickupwholefraction#1.#2 {%
2357 \global\advance\colcount by 1
2358 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2365 \ifx\firstarg\xendsetuptable
2368 \ifx\firstarg\xcolumnfractions
2369 \global\setpercenttrue
2372 \let\go\pickupwholefraction
2374 \global\advance\colcount by 1
2375 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2376 % separator; typically that is always in the input, anyway.
2377 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2380 \ifx\go\pickupwholefraction
2381 % Put the argument back for the \pickupwholefraction call, so
2382 % we'll always have a period there to be parsed.
2383 \def\go{\pickupwholefraction#1}%
2385 \let\go = \setuptable
2391 % @multitable ... @end multitable definitions:
2393 \def\multitable{\parsearg\dotable}
2394 \def\dotable#1{\bgroup
2396 \let\item=\crcrwithfootnotes
2397 % A \tab used to include \hskip1sp. But then the space in a template
2398 % line is not enough. That is bad. So let's go back to just & until
2399 % we encounter the problem it was intended to solve again. --karl,
2400 % nathan@acm.org, 20apr99.
2402 \let\startfootins=\startsavedfootnote
2405 \setmultitablespacing
2406 \parskip=\multitableparskip
2407 \parindent=\multitableparindent
2411 \global\setpercentfalse
2412 \crcrwithfootnotes\crcr
2416 % To parse everything between @multitable and @item:
2417 \setuptable#1 \endsetuptable
2419 % \everycr will reset column counter, \colcount, at the end of
2420 % each line. Every column entry will cause \colcount to advance by one.
2421 % The table preamble
2422 % looks at the current \colcount to find the correct column width.
2425 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2426 % Maybe so, but it also creates really weird page breaks when the table
2427 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2428 % manifests itself, so it can be fixed for real --karl.
2429 \global\colcount=0\relax}}%
2431 % This preamble sets up a generic column definition, which will
2432 % be used as many times as user calls for columns.
2433 % \vtop will set a single line and will also let text wrap and
2434 % continue for many paragraphs if desired.
2435 \halign\bgroup&\global\advance\colcount by 1\relax
2436 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2438 % In order to keep entries from bumping into each other
2439 % we will add a \leftskip of \multitablecolspace to all columns after
2442 % If a template has been used, we will add \multitablecolspace
2443 % to the width of each template entry.
2445 % If the user has set preamble in terms of percent of \hsize we will
2446 % use that dimension as the width of the column, and the \leftskip
2447 % will keep entries from bumping into each other. Table will start at
2448 % left margin and final column will justify at right margin.
2450 % Make sure we don't inherit \rightskip from the outer environment.
2453 % The first column will be indented with the surrounding text.
2454 \advance\hsize by\leftskip
2457 % If user has not set preamble in terms of percent of \hsize
2458 % we will advance \hsize by \multitablecolspace.
2459 \advance\hsize by \multitablecolspace
2461 % In either case we will make \leftskip=\multitablecolspace:
2462 \leftskip=\multitablecolspace
2464 % Ignoring space at the beginning and end avoids an occasional spurious
2465 % blank line, when TeX decides to break the line at the space before the
2466 % box from the multistrut, so the strut ends up on a line by itself.
2468 % @multitable @columnfractions .11 .89
2470 % @tab Legal holiday which is valid in major parts of the whole country.
2471 % Is automatically provided with highlighting sequences respectively marking
2473 \noindent\ignorespaces##\unskip\multistrut}\cr
2476 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2477 % If so, do nothing. If not, give it an appropriate dimension based on
2478 % current baselineskip.
2479 \ifdim\multitablelinespace=0pt
2480 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2481 \global\advance\multitablelinespace by-\ht0
2482 %% strut to put in table in case some entry doesn't have descenders,
2483 %% to keep lines equally spaced
2484 \let\multistrut = \strut
2486 %% FIXME: what is \box0 supposed to be?
2487 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2489 %% Test to see if parskip is larger than space between lines of
2490 %% table. If not, do nothing.
2491 %% If so, set to same dimension as multitablelinespace.
2492 \ifdim\multitableparskip>\multitablelinespace
2493 \global\multitableparskip=\multitablelinespace
2494 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2495 %% than skip between lines in the table.
2497 \ifdim\multitableparskip=0pt
2498 \global\multitableparskip=\multitablelinespace
2499 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2500 %% than skip between lines in the table.
2503 % In case a @footnote appears inside an alignment, save the footnote
2504 % text to a box and make the \insert when a row of the table is
2505 % finished. Otherwise, the insertion is lost, it never migrates to the
2506 % main vertical list. --kasal, 22jan03.
2508 \newbox\savedfootnotes
2510 % \dotable \let's \startfootins to this, so that \dofootnote will call
2511 % it instead of starting the insertion right away.
2512 \def\startsavedfootnote{%
2513 \global\setbox\savedfootnotes = \vbox\bgroup
2514 \unvbox\savedfootnotes
2516 \def\crcrwithfootnotes{%
2518 \ifvoid\savedfootnotes \else
2519 \noalign{\insert\footins{\box\savedfootnotes}}%
2523 \message{conditionals,}
2524 % Prevent errors for section commands.
2525 % Used in @ignore and in failing conditionals.
2526 \def\ignoresections{%
2527 \let\appendix=\relax
2528 \let\appendixsec=\relax
2529 \let\appendixsection=\relax
2530 \let\appendixsubsec=\relax
2531 \let\appendixsubsection=\relax
2532 \let\appendixsubsubsec=\relax
2533 \let\appendixsubsubsection=\relax
2536 \let\centerchap=\relax
2538 \let\contents=\relax
2540 \let\smallbook=\relax
2542 \let\subsection=\relax
2543 \let\subsubsec=\relax
2544 \let\subsubsection=\relax
2545 \let\titlepage=\relax
2547 \let\unnumbered=\relax
2548 \let\unnumberedsec=\relax
2549 \let\unnumberedsection=\relax
2550 \let\unnumberedsubsec=\relax
2551 \let\unnumberedsubsection=\relax
2552 \let\unnumberedsubsubsec=\relax
2553 \let\unnumberedsubsubsection=\relax
2556 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2558 \def\direntry{\doignore{direntry}}
2559 \def\documentdescriptionword{documentdescription}
2560 \def\documentdescription{\doignore{documentdescription}}
2561 \def\html{\doignore{html}}
2562 \def\ifhtml{\doignore{ifhtml}}
2563 \def\ifinfo{\doignore{ifinfo}}
2564 \def\ifnottex{\doignore{ifnottex}}
2565 \def\ifplaintext{\doignore{ifplaintext}}
2566 \def\ifxml{\doignore{ifxml}}
2567 \def\ignore{\doignore{ignore}}
2568 \def\menu{\doignore{menu}}
2569 \def\xml{\doignore{xml}}
2571 % @dircategory CATEGORY -- specify a category of the dir file
2572 % which this file should belong to. Ignore this in TeX.
2573 \let\dircategory = \comment
2575 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2577 % A count to remember the depth of nesting.
2578 \newcount\doignorecount \doignorecount = 0
2580 \def\doignore#1{\begingroup
2581 % Don't complain about control sequences we have declared \outer.
2584 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2585 \catcode\spaceChar = 10
2587 % Ignore braces, so mismatched braces don't cause trouble.
2591 % Count number of #1's that we've seen.
2594 % Swallow text until we reach the matching `@end #1'.
2595 \expandafter \dodoignore \csname#1\endcsname {#1}%
2598 { \catcode`@=11 % We want to use \ST@P which cannot appear in texinfo source.
2601 \gdef\dodoignore#1#2{%
2602 % #1 contains, e.g., \ifinfo, a.k.a. @ifinfo.
2603 % #2 contains the string `ifinfo'.
2605 % Define a command to find the next "@end #2", which must be on a line
2607 \long\def\doignoretext##1^^M\end #2{\doignoretextyyy##1#1\ST@P}%
2608 % And this command to find another #1 command.
2609 \long\def\doignoretextyyy##1#1##2\ST@P{\doignoreyyy{##2}\ST@P}%
2611 % And now expand that command.
2617 \def\doignoreyyy#1{%
2619 \ifx\temp\empty % Nothing found.
2620 \let\next\doignoretextzzz
2621 \else % Found a nested condition, ...
2622 \advance\doignorecount by 1
2623 \let\next\doignoretextyyy % ..., look for another.
2624 % If we're here, #1 ends with \ifinfo (for example).
2626 \next #1% the token \ST@P is present just after this macro.
2629 % We have to swallow the remaining "\ST@P".
2631 \def\doignoretextzzz#1{%
2632 \ifnum\doignorecount = 0 % We have just found the outermost @end.
2633 \let\next\enddoignore
2634 \else % Still inside a nested condition.
2635 \advance\doignorecount by -1
2636 \let\next\doignoretext % Look for the next @end.
2641 % Finish off ignored text.
2642 \def\enddoignore{\endgroup\ignorespaces}
2645 % @set VAR sets the variable VAR to an empty value.
2646 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2648 % Since we want to separate VAR from REST-OF-LINE (which might be
2649 % empty), we can't just use \parsearg; we have to insert a space of our
2650 % own to delimit the rest of the line, and then take it out again if we
2651 % didn't need it. Make sure the catcode of space is correct to avoid
2652 % losing inside @example, for instance.
2654 \def\set{\begingroup\catcode` =10
2655 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2657 \def\setxxx#1{\setyyy#1 \endsetyyy}
2658 \def\setyyy#1 #2\endsetyyy{%
2660 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2661 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2665 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2666 % \next or other control sequences that we've defined might get us into
2667 % an infinite loop. Consider `@set foo @cite{bar}'.
2668 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2670 % @clear VAR clears (i.e., unsets) the variable VAR.
2672 \def\clear{\parsearg\clearxxx}
2673 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2675 % @value{foo} gets the text saved in variable foo.
2677 \catcode`\_ = \active
2679 % We might end up with active _ or - characters in the argument if
2680 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2681 % such active characters to their normal equivalents.
2682 \gdef\value{\begingroup
2683 \catcode`\-=\other \catcode`\_=\other
2684 \indexbreaks \let_\normalunderscore
2687 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2689 % We have this subroutine so that we can handle at least some @value's
2690 % properly in indexes (we \let\value to this in \indexdummies). Ones
2691 % whose names contain - or _ still won't work, but we can't do anything
2692 % about that. The command has to be fully expandable (if the variable
2693 % is set), since the result winds up in the index file. This means that
2694 % if the variable's value contains other Texinfo commands, it's almost
2695 % certain it will fail (although perhaps we could fix that with
2696 % sufficient work to do a one-level expansion on the result, instead of
2699 \def\expandablevalue#1{%
2700 \expandafter\ifx\csname SET#1\endcsname\relax
2701 {[No value for ``#1'']}%
2702 \message{Variable `#1', used in @value, is not set.}%
2704 \csname SET#1\endcsname
2708 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2711 \def\ifset{\parsearg\doifset}
2713 \expandafter\ifx\csname SET#1\endcsname\relax
2714 \let\next=\ifsetfail
2716 \let\next=\ifsetsucceed
2720 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2721 \def\ifsetfail{\doignore{ifset}}
2722 \defineunmatchedend{ifset}
2724 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2725 % defined with @set, or has been undefined with @clear.
2727 \def\ifclear{\parsearg\doifclear}
2729 \expandafter\ifx\csname SET#1\endcsname\relax
2730 \let\next=\ifclearsucceed
2732 \let\next=\ifclearfail
2736 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2737 \def\ifclearfail{\doignore{ifclear}}
2738 \defineunmatchedend{ifclear}
2740 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2741 % read the text following, through the first @end iftex (etc.). Make
2742 % `@end iftex' (etc.) valid only after an @iftex.
2744 \def\iftex{\conditionalsucceed{iftex}}
2745 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2746 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2747 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2748 \defineunmatchedend{iftex}
2749 \defineunmatchedend{ifnothtml}
2750 \defineunmatchedend{ifnotinfo}
2751 \defineunmatchedend{ifnotplaintext}
2753 % True conditional. Since \set globally defines its variables, we can
2754 % just start and end a group (to keep the @end definition undefined at
2757 \def\conditionalsucceed#1{\begingroup
2758 \expandafter\def\csname E#1\endcsname{\endgroup}%
2761 % @defininfoenclose.
2762 \let\definfoenclose=\comment
2766 % Index generation facilities
2768 % Define \newwrite to be identical to plain tex's \newwrite
2769 % except not \outer, so it can be used within \newindex.
2771 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2773 % \newindex {foo} defines an index named foo.
2774 % It automatically defines \fooindex such that
2775 % \fooindex ...rest of line... puts an entry in the index foo.
2776 % It also defines \fooindfile to be the number of the output channel for
2777 % the file that accumulates this index. The file's extension is foo.
2778 % The name of an index should be no more than 2 characters long
2779 % for the sake of vms.
2783 \expandafter\newwrite \csname#1indfile\endcsname
2784 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2786 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2787 \noexpand\doindex{#1}}
2790 % @defindex foo == \newindex{foo}
2792 \def\defindex{\parsearg\newindex}
2794 % Define @defcodeindex, like @defindex except put all entries in @code.
2796 \def\defcodeindex{\parsearg\newcodeindex}
2798 \def\newcodeindex#1{%
2800 \expandafter\newwrite \csname#1indfile\endcsname
2801 \openout \csname#1indfile\endcsname \jobname.#1
2803 \expandafter\xdef\csname#1index\endcsname{%
2804 \noexpand\docodeindex{#1}}%
2808 % @synindex foo bar makes index foo feed into index bar.
2809 % Do this instead of @defindex foo if you don't want it as a separate index.
2811 % @syncodeindex foo bar similar, but put all entries made for index foo
2814 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2815 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2817 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2818 % #3 the target index (bar).
2819 \def\dosynindex#1#2#3{%
2820 % Only do \closeout if we haven't already done it, else we'll end up
2821 % closing the target index.
2822 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2823 % The \closeout helps reduce unnecessary open files; the limit on the
2824 % Acorn RISC OS is a mere 16 files.
2825 \expandafter\closeout\csname#2indfile\endcsname
2826 \expandafter\let\csname\donesynindex#2\endcsname = 1
2828 % redefine \fooindfile:
2829 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2830 \expandafter\let\csname#2indfile\endcsname=\temp
2831 % redefine \fooindex:
2832 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2835 % Define \doindex, the driver for all \fooindex macros.
2836 % Argument #1 is generated by the calling \fooindex macro,
2837 % and it is "foo", the name of the index.
2839 % \doindex just uses \parsearg; it calls \doind for the actual work.
2840 % This is because \doind is more useful to call from other macros.
2842 % There is also \dosubind {index}{topic}{subtopic}
2843 % which makes an entry in a two-level index such as the operation index.
2845 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2846 \def\singleindexer #1{\doind{\indexname}{#1}}
2848 % like the previous two, but they put @code around the argument.
2849 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2850 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2852 % Take care of Texinfo commands that can appear in an index entry.
2853 % Since there are some commands we want to expand, and others we don't,
2854 % we have to laboriously prevent expansion for those that we don't.
2857 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2858 \def\ {\realbackslash\space }%
2859 % Need these in case \tex is in effect and \{ is a \delimiter again.
2860 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2861 % braces and backslashes are used only as delimiters.
2865 % \definedummyword defines \#1 as \realbackslash #1\space, thus
2866 % effectively preventing its expansion. This is used only for control
2867 % words, not control letters, because the \space would be incorrect
2868 % for control characters, but is needed to separate the control word
2869 % from whatever follows.
2871 % For control letters, we have \definedummyletter, which omits the
2874 % These can be used both for control words that take an argument and
2875 % those that do not. If it is followed by {arg} in the input, then
2876 % that will dutifully get written to the index (or wherever).
2878 \def\definedummyword##1{%
2879 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
2881 \def\definedummyletter##1{%
2882 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
2885 % Do the redefinitions.
2889 % For the aux file, @ is the escape character. So we want to redefine
2890 % everything using @ instead of \realbackslash. When everything uses
2891 % @, this will be simpler.
2896 \let\{ = \lbraceatcmd
2897 \let\} = \rbraceatcmd
2899 % (See comments in \indexdummies.)
2900 \def\definedummyword##1{%
2901 \expandafter\def\csname ##1\endcsname{@##1\space}%
2903 \def\definedummyletter##1{%
2904 \expandafter\def\csname ##1\endcsname{@##1}%
2907 % Do the redefinitions.
2911 % Called from \indexdummies and \atdummies. \definedummyword and
2912 % \definedummyletter must be defined first.
2914 \def\commondummies{%
2916 \normalturnoffactive
2918 % Control letters and accents.
2919 \definedummyletter{_}%
2920 \definedummyletter{,}%
2921 \definedummyletter{"}%
2922 \definedummyletter{`}%
2923 \definedummyletter{'}%
2924 \definedummyletter{^}%
2925 \definedummyletter{~}%
2926 \definedummyletter{=}%
2927 \definedummyword{u}%
2928 \definedummyword{v}%
2929 \definedummyword{H}%
2930 \definedummyword{dotaccent}%
2931 \definedummyword{ringaccent}%
2932 \definedummyword{tieaccent}%
2933 \definedummyword{ubaraccent}%
2934 \definedummyword{udotaccent}%
2935 \definedummyword{dotless}%
2937 % Other non-English letters.
2938 \definedummyword{AA}%
2939 \definedummyword{AE}%
2940 \definedummyword{L}%
2941 \definedummyword{OE}%
2942 \definedummyword{O}%
2943 \definedummyword{aa}%
2944 \definedummyword{ae}%
2945 \definedummyword{l}%
2946 \definedummyword{oe}%
2947 \definedummyword{o}%
2948 \definedummyword{ss}%
2950 % Although these internal commands shouldn't show up, sometimes they do.
2951 \definedummyword{bf}%
2952 \definedummyword{gtr}%
2953 \definedummyword{hat}%
2954 \definedummyword{less}%
2955 \definedummyword{sf}%
2956 \definedummyword{sl}%
2957 \definedummyword{tclose}%
2958 \definedummyword{tt}%
2960 % Texinfo font commands.
2961 \definedummyword{b}%
2962 \definedummyword{i}%
2963 \definedummyword{r}%
2964 \definedummyword{sc}%
2965 \definedummyword{t}%
2967 \definedummyword{TeX}%
2968 \definedummyword{acronym}%
2969 \definedummyword{cite}%
2970 \definedummyword{code}%
2971 \definedummyword{command}%
2972 \definedummyword{dfn}%
2973 \definedummyword{dots}%
2974 \definedummyword{emph}%
2975 \definedummyword{env}%
2976 \definedummyword{file}%
2977 \definedummyword{kbd}%
2978 \definedummyword{key}%
2979 \definedummyword{math}%
2980 \definedummyword{option}%
2981 \definedummyword{samp}%
2982 \definedummyword{strong}%
2983 \definedummyword{uref}%
2984 \definedummyword{url}%
2985 \definedummyword{var}%
2986 \definedummyword{w}%
2988 % Assorted special characters.
2989 \definedummyword{bullet}%
2990 \definedummyword{copyright}%
2991 \definedummyword{dots}%
2992 \definedummyword{enddots}%
2993 \definedummyword{equiv}%
2994 \definedummyword{error}%
2995 \definedummyword{expansion}%
2996 \definedummyword{minus}%
2997 \definedummyword{pounds}%
2998 \definedummyword{point}%
2999 \definedummyword{print}%
3000 \definedummyword{result}%
3002 % Handle some cases of @value -- where the variable name does not
3003 % contain - or _, and the value does not contain any
3004 % (non-fully-expandable) commands.
3005 \let\value = \expandablevalue
3007 % Normal spaces, not active ones.
3010 % No macro expansion.
3014 % If an index command is used in an @example environment, any spaces
3015 % therein should become regular spaces in the raw index file, not the
3016 % expansion of \tie (\leavevmode \penalty \@M \ ).
3018 \gdef\unsepspaces{\obeyspaces\let =\space}}
3021 % \indexnofonts is used when outputting the strings to sort the index
3022 % by, and when constructing control sequence names. It eliminates all
3023 % control sequences and just writes whatever the best ASCII sort string
3024 % would be for a given command (usually its argument).
3026 \def\indexdummytex{TeX}
3027 \def\indexdummydots{...}
3032 % how to handle braces?
3033 \def\_{\normalunderscore}%
3045 \let\dotaccent=\asis
3046 \let\ringaccent=\asis
3047 \let\tieaccent=\asis
3048 \let\ubaraccent=\asis
3049 \let\udotaccent=\asis
3052 % Other non-English letters.
3065 \def\questiondown{?}%
3067 % Don't no-op \tt, since it isn't a user-level command
3068 % and is used in the definitions of the active chars like <, >, |, etc.
3069 % Likewise with the other plain tex font commands.
3072 % Texinfo font commands.
3079 \let\TeX=\indexdummytex
3085 \let\dots=\indexdummydots
3101 \let\indexbackslash=0 %overridden during \printindex.
3102 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3104 % For \ifx comparisons.
3105 \def\emptymacro{\empty}
3107 % Most index entries go through here, but \dosubind is the general case.
3109 \def\doind#1#2{\dosubind{#1}{#2}\empty}
3111 % Workhorse for all \fooindexes.
3112 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3113 % \empty if called from \doind, as we usually are. The main exception
3114 % is with defuns, which call us directly.
3116 \def\dosubind#1#2#3{%
3117 % Put the index entry in the margin if desired.
3118 \ifx\SETmarginindex\relax\else
3119 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
3122 \count255=\lastpenalty
3124 \indexdummies % Must do this here, since \bf, etc expand at this stage
3127 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3128 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3129 % so it will be output as is; and it will print as backslash.
3131 % The main index entry text.
3134 % If third arg is present, precede it with space in sort key.
3136 \ifx\thirdarg\emptymacro \else
3137 % If the third (subentry) arg is present, add it to the index
3139 \toks0 = \expandafter{\the\toks0 \space #3}%
3142 % Process the index entry with all font commands turned off, to
3143 % get the string to sort by.
3145 \edef\temp{\the\toks0}% need full expansion
3146 \xdef\indexsorttmp{\temp}%
3149 % Set up the complete index entry, with both the sort key and
3150 % the original text, including any font commands. We write
3151 % three arguments to \entry to the .?? file (four in the
3152 % subentry case), texindex reduces to two when writing the .??s
3155 \write\csname#1indfile\endcsname{%
3156 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3159 % If a skip is the last thing on the list now, preserve it
3160 % by backing up by \lastskip, doing the \write, then inserting
3161 % the skip again. Otherwise, the whatsit generated by the
3162 % \write will make \lastskip zero. The result is that sequences
3167 % will have extra space inserted, because the \medbreak in the
3168 % start of the @defun won't see the skip inserted by the @end of
3169 % the previous defun.
3171 % But don't do any of this if we're not in vertical mode. We
3172 % don't want to do a \vskip and prematurely end a paragraph.
3174 % Avoid page breaks due to these extra skips, too.
3179 \ifdim\lastskip = 0pt \else \nobreak\vskip-\skip0 \fi
3182 \temp % do the write
3184 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3192 % The index entry written in the file actually looks like
3193 % \entry {sortstring}{page}{topic}
3195 % \entry {sortstring}{page}{topic}{subtopic}
3196 % The texindex program reads in these files and writes files
3197 % containing these kinds of lines:
3199 % before the first topic whose initial is c
3200 % \entry {topic}{pagelist}
3201 % for a topic that is used without subtopics
3203 % for the beginning of a topic that is used with subtopics
3204 % \secondary {subtopic}{pagelist}
3205 % for each subtopic.
3207 % Define the user-accessible indexing commands
3208 % @findex, @vindex, @kindex, @cindex.
3210 \def\findex {\fnindex}
3211 \def\kindex {\kyindex}
3212 \def\cindex {\cpindex}
3213 \def\vindex {\vrindex}
3214 \def\tindex {\tpindex}
3215 \def\pindex {\pgindex}
3217 \def\cindexsub {\begingroup\obeylines\cindexsub}
3219 \gdef\cindexsub "#1" #2^^M{\endgroup %
3220 \dosubind{cp}{#2}{#1}}}
3222 % Define the macros used in formatting output of the sorted index material.
3224 % @printindex causes a particular index (the ??s file) to get printed.
3225 % It does not print any chapter heading (usually an @unnumbered).
3227 \def\printindex{\parsearg\doprintindex}
3228 \def\doprintindex#1{\begingroup
3229 \dobreak \chapheadingskip{10000}%
3233 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3236 % See if the index file exists and is nonempty.
3237 % Change catcode of @ here so that if the index file contains
3239 % as its first line, TeX doesn't complain about mismatched braces
3240 % (because it thinks @} is a control sequence).
3242 \openin 1 \jobname.#1s
3244 % \enddoublecolumns gets confused if there is no text in the index,
3245 % and it loses the chapter title and the aux file entries for the
3246 % index. The easiest way to prevent this problem is to make sure
3247 % there is some text.
3248 \putwordIndexNonexistent
3251 % If the index file exists but is empty, then \openin leaves \ifeof
3252 % false. We have to make TeX try to read something from the file, so
3253 % it can discover if there is anything in it.
3256 \putwordIndexIsEmpty
3258 % Index files are almost Texinfo source, but we use \ as the escape
3259 % character. It would be better to use @, but that's too big a change
3260 % to make right now.
3261 \def\indexbackslash{\rawbackslashxx}%
3272 % These macros are used by the sorted index file itself.
3273 % Change them to control the appearance of the index.
3276 % Some minor font changes for the special characters.
3277 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3279 % Remove any glue we may have, we'll be inserting our own.
3282 % We like breaks before the index initials, so insert a bonus.
3285 % Typeset the initial. Making this add up to a whole number of
3286 % baselineskips increases the chance of the dots lining up from column
3287 % to column. It still won't often be perfect, because of the stretch
3288 % we need before each entry, but it's better.
3290 % No shrink because it confuses \balancecolumns.
3291 \vskip 1.67\baselineskip plus .5\baselineskip
3292 \leftline{\secbf #1}%
3293 \vskip .33\baselineskip plus .1\baselineskip
3295 % Do our best not to break after the initial.
3299 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3300 % flush to the right margin. It is used for index and table of contents
3301 % entries. The paragraph is indented by \leftskip.
3303 \def\entry#1#2{\begingroup
3305 % Start a new paragraph if necessary, so our assignments below can't
3306 % affect previous text.
3309 % Do not fill out the last line with white space.
3312 % No extra space above this paragraph.
3315 % Do not prefer a separate line ending with a hyphen to fewer lines.
3316 \finalhyphendemerits = 0
3318 % \hangindent is only relevant when the entry text and page number
3319 % don't both fit on one line. In that case, bob suggests starting the
3320 % dots pretty far over on the line. Unfortunately, a large
3321 % indentation looks wrong when the entry text itself is broken across
3322 % lines. So we use a small indentation and put up with long leaders.
3324 % \hangafter is reset to 1 (which is the value we want) at the start
3325 % of each paragraph, so we need not do anything with that.
3328 % When the entry text needs to be broken, just fill out the first line
3330 \rightskip = 0pt plus1fil
3332 % A bit of stretch before each entry for the benefit of balancing columns.
3335 % Start a ``paragraph'' for the index entry so the line breaking
3336 % parameters we've set above will have an effect.
3339 % Insert the text of the index entry. TeX will do line-breaking on it.
3341 % The following is kludged to not output a line of dots in the index if
3342 % there are no page numbers. The next person who breaks this will be
3343 % cursed by a Unix daemon.
3346 \edef\tempc{\tempa}%
3347 \edef\tempd{\tempb}%
3348 \ifx\tempc\tempd\ \else%
3350 % If we must, put the page number on a line of its own, and fill out
3351 % this line with blank space. (The \hfil is overwhelmed with the
3352 % fill leaders glue in \indexdotfill if the page number does fit.)
3354 \null\nobreak\indexdotfill % Have leaders before the page number.
3356 % The `\ ' here is removed by the implicit \unskip that TeX does as
3357 % part of (the primitive) \par. Without it, a spurious underfull
3360 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3362 \ #2% The page number ends the paragraph.
3368 % Like \dotfill except takes at least 1 em.
3369 \def\indexdotfill{\cleaders
3370 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3372 \def\primary #1{\line{#1\hfil}}
3374 \newskip\secondaryindent \secondaryindent=0.5cm
3375 \def\secondary#1#2{{%
3380 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3382 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3389 % Define two-column mode, which we use to typeset indexes.
3390 % Adapted from the TeXbook, page 416, which is to say,
3391 % the manmac.tex format used to print the TeXbook itself.
3395 \newdimen\doublecolumnhsize
3397 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3398 % Grab any single-column material above us.
3401 % Here is a possibility not foreseen in manmac: if we accumulate a
3402 % whole lot of material, we might end up calling this \output
3403 % routine twice in a row (see the doublecol-lose test, which is
3404 % essentially a couple of indexes with @setchapternewpage off). In
3405 % that case we just ship out what is in \partialpage with the normal
3406 % output routine. Generally, \partialpage will be empty when this
3407 % runs and this will be a no-op. See the indexspread.tex test case.
3408 \ifvoid\partialpage \else
3409 \onepageout{\pagecontents\partialpage}%
3412 \global\setbox\partialpage = \vbox{%
3413 % Unvbox the main output page.
3415 \kern-\topskip \kern\baselineskip
3418 \eject % run that output routine to set \partialpage
3420 % Use the double-column output routine for subsequent pages.
3421 \output = {\doublecolumnout}%
3423 % Change the page size parameters. We could do this once outside this
3424 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3425 % format, but then we repeat the same computation. Repeating a couple
3426 % of assignments once per index is clearly meaningless for the
3427 % execution time, so we may as well do it in one place.
3429 % First we halve the line length, less a little for the gutter between
3430 % the columns. We compute the gutter based on the line length, so it
3431 % changes automatically with the paper format. The magic constant
3432 % below is chosen so that the gutter has the same value (well, +-<1pt)
3433 % as it did when we hard-coded it.
3435 % We put the result in a separate register, \doublecolumhsize, so we
3436 % can restore it in \pagesofar, after \hsize itself has (potentially)
3439 \doublecolumnhsize = \hsize
3440 \advance\doublecolumnhsize by -.04154\hsize
3441 \divide\doublecolumnhsize by 2
3442 \hsize = \doublecolumnhsize
3444 % Double the \vsize as well. (We don't need a separate register here,
3445 % since nobody clobbers \vsize.)
3449 % The double-column output routine for all double-column pages except
3452 \def\doublecolumnout{%
3453 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3454 % Get the available space for the double columns -- the normal
3455 % (undoubled) page height minus any material left over from the
3459 \advance\dimen@ by -\ht\partialpage
3461 % box0 will be the left-hand column, box2 the right.
3462 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3463 \onepageout\pagesofar
3465 \penalty\outputpenalty
3468 % Re-output the contents of the output page -- any previous material,
3469 % followed by the two boxes we just split, in box0 and box2.
3473 \hsize = \doublecolumnhsize
3474 \wd0=\hsize \wd2=\hsize
3475 \hbox to\pagewidth{\box0\hfil\box2}%
3478 % All done with double columns.
3479 \def\enddoublecolumns{%
3481 % Split the last of the double-column material. Leave it on the
3482 % current page, no automatic page break.
3485 % If we end up splitting too much material for the current page,
3486 % though, there will be another page break right after this \output
3487 % invocation ends. Having called \balancecolumns once, we do not
3488 % want to call it again. Therefore, reset \output to its normal
3489 % definition right away. (We hope \balancecolumns will never be
3490 % called on to balance too much material, but if it is, this makes
3491 % the output somewhat more palatable.)
3492 \global\output = {\onepageout{\pagecontents\PAGE}}%
3495 \endgroup % started in \begindoublecolumns
3497 % \pagegoal was set to the doubled \vsize above, since we restarted
3498 % the current page. We're now back to normal single-column
3499 % typesetting, so reset \pagegoal to the normal \vsize (after the
3500 % \endgroup where \vsize got restored).
3504 % Called at the end of the double column material.
3505 \def\balancecolumns{%
3506 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3508 \advance\dimen@ by \topskip
3509 \advance\dimen@ by-\baselineskip
3510 \divide\dimen@ by 2 % target to split to
3511 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3512 \splittopskip = \topskip
3513 % Loop until we get a decent breakpoint.
3517 \global\setbox3 = \copy0
3518 \global\setbox1 = \vsplit3 to \dimen@
3520 \global\advance\dimen@ by 1pt
3523 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3524 \setbox0=\vbox to\dimen@{\unvbox1}%
3525 \setbox2=\vbox to\dimen@{\unvbox3}%
3529 \catcode`\@ = \other
3532 \message{sectioning,}
3533 % Chapters, sections, etc.
3536 \newcount\secno \secno=0
3537 \newcount\subsecno \subsecno=0
3538 \newcount\subsubsecno \subsubsecno=0
3540 % This counter is funny since it counts through charcodes of letters A, B, ...
3541 \newcount\appendixno \appendixno = `\@
3542 % \def\appendixletter{\char\the\appendixno}
3543 % We do the following for the sake of pdftex, which needs the actual
3544 % letter in the expansion, not just typeset.
3545 \def\appendixletter{%
3546 \ifnum\appendixno=`A A%
3547 \else\ifnum\appendixno=`B B%
3548 \else\ifnum\appendixno=`C C%
3549 \else\ifnum\appendixno=`D D%
3550 \else\ifnum\appendixno=`E E%
3551 \else\ifnum\appendixno=`F F%
3552 \else\ifnum\appendixno=`G G%
3553 \else\ifnum\appendixno=`H H%
3554 \else\ifnum\appendixno=`I I%
3555 \else\ifnum\appendixno=`J J%
3556 \else\ifnum\appendixno=`K K%
3557 \else\ifnum\appendixno=`L L%
3558 \else\ifnum\appendixno=`M M%
3559 \else\ifnum\appendixno=`N N%
3560 \else\ifnum\appendixno=`O O%
3561 \else\ifnum\appendixno=`P P%
3562 \else\ifnum\appendixno=`Q Q%
3563 \else\ifnum\appendixno=`R R%
3564 \else\ifnum\appendixno=`S S%
3565 \else\ifnum\appendixno=`T T%
3566 \else\ifnum\appendixno=`U U%
3567 \else\ifnum\appendixno=`V V%
3568 \else\ifnum\appendixno=`W W%
3569 \else\ifnum\appendixno=`X X%
3570 \else\ifnum\appendixno=`Y Y%
3571 \else\ifnum\appendixno=`Z Z%
3572 % The \the is necessary, despite appearances, because \appendixletter is
3573 % expanded while writing the .toc file. \char\appendixno is not
3574 % expandable, thus it is written literally, thus all appendixes come out
3575 % with the same letter (or @) in the toc without it.
3576 \else\char\the\appendixno
3577 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3578 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3580 % Each @chapter defines this as the name of the chapter.
3581 % page headings and footings can use it. @section does likewise.
3585 \newcount\absseclevel % used to calculate proper heading level
3586 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3588 % @raisesections: treat @section as chapter, @subsection as section, etc.
3589 \def\raisesections{\global\advance\secbase by -1}
3590 \let\up=\raisesections % original BFox name
3592 % @lowersections: treat @chapter as section, @section as subsection, etc.
3593 \def\lowersections{\global\advance\secbase by 1}
3594 \let\down=\lowersections % original BFox name
3596 % Choose a numbered-heading macro
3597 % #1 is heading level if unmodified by @raisesections or @lowersections
3598 % #2 is text for heading
3599 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3605 \numberedsubseczzz{#2}
3607 \numberedsubsubseczzz{#2}
3609 \ifnum \absseclevel<0
3612 \numberedsubsubseczzz{#2}
3615 \suppressfirstparagraphindent
3618 % like \numhead, but chooses appendix heading levels
3619 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3623 \appendixsectionzzz{#2}
3625 \appendixsubseczzz{#2}
3627 \appendixsubsubseczzz{#2}
3629 \ifnum \absseclevel<0
3632 \appendixsubsubseczzz{#2}
3635 \suppressfirstparagraphindent
3638 % like \numhead, but chooses numberless heading levels
3639 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3643 \unnumberedseczzz{#2}
3645 \unnumberedsubseczzz{#2}
3647 \unnumberedsubsubseczzz{#2}
3649 \ifnum \absseclevel<0
3652 \unnumberedsubsubseczzz{#2}
3655 \suppressfirstparagraphindent
3658 % @chapter, @appendix, @unnumbered.
3659 \def\thischaptername{No Chapter Title}
3660 \outer\def\chapter{\parsearg\chapteryyy}
3661 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3662 \def\chapterzzz #1{%
3663 \secno=0 \subsecno=0 \subsubsecno=0
3664 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3665 \chapmacro {#1}{\the\chapno}%
3666 \gdef\thissection{#1}%
3667 \gdef\thischaptername{#1}%
3668 % We don't substitute the actual chapter name into \thischapter
3669 % because we don't want its macros evaluated now.
3670 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3671 \writetocentry{chap}{#1}{{\the\chapno}}
3673 \global\let\section = \numberedsec
3674 \global\let\subsection = \numberedsubsec
3675 \global\let\subsubsection = \numberedsubsubsec
3678 % we use \chapno to avoid indenting back
3679 \def\appendixbox#1{%
3680 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3681 \hbox to \wd0{#1\hss}}
3683 \outer\def\appendix{\parsearg\appendixyyy}
3684 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3685 \def\appendixzzz #1{%
3686 \secno=0 \subsecno=0 \subsubsecno=0
3687 \global\advance \appendixno by 1
3688 \message{\putwordAppendix\space \appendixletter}%
3689 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3690 \gdef\thissection{#1}%
3691 \gdef\thischaptername{#1}%
3692 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3693 \writetocentry{appendix}{#1}{{\appendixletter}}
3695 \global\let\section = \appendixsec
3696 \global\let\subsection = \appendixsubsec
3697 \global\let\subsubsection = \appendixsubsubsec
3700 % @centerchap is like @unnumbered, but the heading is centered.
3701 \outer\def\centerchap{\parsearg\centerchapyyy}
3702 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3704 % @top is like @unnumbered.
3705 \outer\def\top{\parsearg\unnumberedyyy}
3707 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3708 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3709 \def\unnumberedzzz #1{%
3710 \secno=0 \subsecno=0 \subsubsecno=0
3712 % This used to be simply \message{#1}, but TeX fully expands the
3713 % argument to \message. Therefore, if #1 contained @-commands, TeX
3714 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3715 % expanded @cite (which turns out to cause errors because \cite is meant
3716 % to be executed, not expanded).
3718 % Anyway, we don't want the fully-expanded definition of @cite to appear
3719 % as a result of the \message, we just want `@cite' itself. We use
3720 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3721 % simply yielding the contents of <toks register>. (We also do this for
3723 \toks0 = {#1}\message{(\the\toks0)}%
3725 \unnumbchapmacro {#1}%
3726 \gdef\thischapter{#1}\gdef\thissection{#1}%
3727 \writetocentry{unnumbchap}{#1}{{\the\chapno}}
3729 \global\let\section = \unnumberedsec
3730 \global\let\subsection = \unnumberedsubsec
3731 \global\let\subsubsection = \unnumberedsubsubsec
3735 \outer\def\numberedsec{\parsearg\secyyy}
3736 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3738 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3739 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3740 \writetocentry{sec}{#1}{{\the\chapno}{\the\secno}}
3745 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3746 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3747 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3748 \def\appendixsectionzzz #1{%
3749 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3750 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3751 \writetocentry{sec}{#1}{{\appendixletter}{\the\secno}}
3756 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3757 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3758 \def\unnumberedseczzz #1{%
3759 \plainsecheading {#1}\gdef\thissection{#1}%
3760 \writetocentry{unnumbsec}{#1}{{\the\chapno}{\the\secno}}
3766 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3767 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3768 \def\numberedsubseczzz #1{%
3769 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3770 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3771 \writetocentry{subsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3776 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3777 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3778 \def\appendixsubseczzz #1{%
3779 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3780 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3781 \writetocentry{subsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}}
3786 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3787 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3788 \def\unnumberedsubseczzz #1{%
3789 \plainsubsecheading {#1}\gdef\thissection{#1}%
3790 \writetocentry{unnumbsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3796 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3797 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3798 \def\numberedsubsubseczzz #1{%
3799 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3800 \subsubsecheading {#1}
3801 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3802 \writetocentry{subsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3807 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3808 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3809 \def\appendixsubsubseczzz #1{%
3810 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3811 \subsubsecheading {#1}
3812 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3813 \writetocentry{subsubsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3818 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3819 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3820 \def\unnumberedsubsubseczzz #1{%
3821 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3822 \writetocentry{unnumbsubsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3827 % These are variants which are not "outer", so they can appear in @ifinfo.
3828 % Actually, they should now be obsolete; ordinary section commands should work.
3829 \def\infotop{\parsearg\unnumberedzzz}
3830 \def\infounnumbered{\parsearg\unnumberedzzz}
3831 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3832 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3833 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3835 \def\infoappendix{\parsearg\appendixzzz}
3836 \def\infoappendixsec{\parsearg\appendixseczzz}
3837 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3838 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3840 \def\infochapter{\parsearg\chapterzzz}
3841 \def\infosection{\parsearg\sectionzzz}
3842 \def\infosubsection{\parsearg\subsectionzzz}
3843 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3845 % These macros control what the section commands do, according
3846 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3847 % Define them by default for a numbered chapter.
3848 \global\let\section = \numberedsec
3849 \global\let\subsection = \numberedsubsec
3850 \global\let\subsubsection = \numberedsubsubsec
3852 % Define @majorheading, @heading and @subheading
3854 % NOTE on use of \vbox for chapter headings, section headings, and such:
3855 % 1) We use \vbox rather than the earlier \line to permit
3856 % overlong headings to fold.
3857 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3858 % heading is obnoxious; this forbids it.
3859 % 3) Likewise, headings look best if no \parindent is used, and
3860 % if justification is not attempted. Hence \raggedright.
3864 {\advance\chapheadingskip by 10pt \chapbreak }%
3865 \parsearg\chapheadingzzz
3868 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
3869 \def\chapheadingzzz #1{%
3870 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3871 \parindent=0pt\raggedright
3873 \bigskip \par\penalty 200\relax
3874 \suppressfirstparagraphindent
3877 % @heading, @subheading, @subsubheading.
3878 \def\heading{\parsearg\doheading}
3879 \def\subheading{\parsearg\dosubheading}
3880 \def\subsubheading{\parsearg\dosubsubheading}
3881 \def\doheading#1{\plainsecheading{#1}\suppressfirstparagraphindent}
3882 \def\dosubheading#1{\plainsubsecheading{#1}\suppressfirstparagraphindent}
3883 \def\dosubsubheading#1{\plainsubsubsecheading{#1}\suppressfirstparagraphindent}
3885 % These macros generate a chapter, section, etc. heading only
3886 % (including whitespace, linebreaking, etc. around it),
3887 % given all the information in convenient, parsed form.
3889 %%% Args are the skip and penalty (usually negative)
3890 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3892 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3894 %%% Define plain chapter starts, and page on/off switching for it
3895 % Parameter controlling skip before chapter headings (if needed)
3897 \newskip\chapheadingskip
3899 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3900 \def\chappager{\par\vfill\supereject}
3901 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
3903 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3906 \global\let\contentsalignmacro = \chappager
3907 \global\let\pchapsepmacro=\chapbreak
3908 \global\let\pagealignmacro=\chappager}
3911 \global\let\contentsalignmacro = \chappager
3912 \global\let\pchapsepmacro=\chappager
3913 \global\let\pagealignmacro=\chappager
3914 \global\def\HEADINGSon{\HEADINGSsingle}}
3917 \global\let\contentsalignmacro = \chapoddpage
3918 \global\let\pchapsepmacro=\chapoddpage
3919 \global\let\pagealignmacro=\chapoddpage
3920 \global\def\HEADINGSon{\HEADINGSdouble}}
3925 \global\let\chapmacro=\chfplain
3926 \global\let\unnumbchapmacro=\unnchfplain
3927 \global\let\centerchapmacro=\centerchfplain}
3929 % Plain chapter opening.
3930 % #1 is the text, #2 the chapter number or empty if unnumbered.
3936 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3937 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3938 \hangindent = \wd0 \centerparametersmaybe
3941 \nobreak\bigskip % no page break after a chapter title
3945 % Plain opening for unnumbered.
3946 \def\unnchfplain#1{\chfplain{#1}{}}
3948 % @centerchap -- centered and unnumbered.
3949 \let\centerparametersmaybe = \relax
3950 \def\centerchfplain#1{{%
3951 \def\centerparametersmaybe{%
3952 \advance\rightskip by 3\rightskip
3953 \leftskip = \rightskip
3959 \CHAPFplain % The default
3961 \def\unnchfopen #1{%
3962 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3963 \parindent=0pt\raggedright
3964 \rm #1\hfill}}\bigskip \par\nobreak
3967 \def\chfopen #1#2{\chapoddpage {\chapfonts
3968 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3972 \def\centerchfopen #1{%
3973 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3975 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3979 \global\let\chapmacro=\chfopen
3980 \global\let\unnumbchapmacro=\unnchfopen
3981 \global\let\centerchapmacro=\centerchfopen}
3985 \newskip\secheadingskip
3986 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
3987 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3988 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3990 % Subsection titles.
3991 \newskip \subsecheadingskip
3992 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
3993 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3994 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3996 % Subsubsection titles.
3997 \let\subsubsecheadingskip = \subsecheadingskip
3998 \let\subsubsecheadingbreak = \subsecheadingbreak
3999 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
4000 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
4003 % Print any size section title.
4005 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
4006 % number (maybe empty), #3 the text.
4007 \def\sectionheading#1#2#3{%
4009 \expandafter\advance\csname #1headingskip\endcsname by \parskip
4010 \csname #1headingbreak\endcsname
4013 % Switch to the right set of fonts.
4014 \csname #1fonts\endcsname \rm
4016 % Only insert the separating space if we have a section number.
4018 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
4020 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4021 \hangindent = \wd0 % zero if no section number
4024 % Add extra space after the heading -- either a line space or a
4025 % paragraph space, whichever is more. (Some people like to set
4026 % \parskip to large values for some reason.) Don't allow stretch, though.
4028 \ifdim\parskip>\normalbaselineskip
4031 \kern\normalbaselineskip
4038 % Table of contents.
4041 % Write an entry to the toc file, opening it if necessary.
4042 % Called from @chapter, etc. We supply {\folio} at the end of the
4043 % argument, which will end up as the last argument to the \...entry macro.
4045 % Usage: \writetocentry{chap}{The Name of The Game}{{\the\chapno}}
4046 % We open the .toc file for writing here instead of at @setfilename (or
4047 % any other fixed time) so that @contents can be anywhere in the document.
4049 \newif\iftocfileopened
4050 \def\writetocentry#1#2#3{%
4051 \iftocfileopened\else
4052 \immediate\openout\tocfile = \jobname.toc
4053 \global\tocfileopenedtrue
4058 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}#3{\folio}}}%
4062 % Tell \shipout to create a page destination if we're doing pdf, which
4063 % will be the target of the links in the table of contents. We can't
4064 % just do it on every page because the title pages are numbered 1 and
4065 % 2 (the page numbers aren't printed), and so are the first two pages
4066 % of the document. Thus, we'd have two destinations named `1', and
4068 \ifpdf \pdfmakepagedesttrue \fi
4071 \newskip\contentsrightmargin \contentsrightmargin=1in
4072 \newcount\savepageno
4073 \newcount\lastnegativepageno \lastnegativepageno = -1
4075 % Finish up the main text and prepare to read what we've written
4078 \def\startcontents#1{%
4079 % If @setchapternewpage on, and @headings double, the contents should
4080 % start on an odd page, unlike chapters. Thus, we maintain
4081 % \contentsalignmacro in parallel with \pagealignmacro.
4082 % From: Torbjorn Granlund <tege@matematik.su.se>
4084 \immediate\closeout\tocfile
4086 % Don't need to put `Contents' or `Short Contents' in the headline.
4087 % It is abundantly clear what they are.
4088 \unnumbchapmacro{#1}\def\thischapter{}%
4089 \savepageno = \pageno
4090 \begingroup % Set up to handle contents files properly.
4091 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4092 % We can't do this, because then an actual ^ in a section
4093 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4094 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4095 \raggedbottom % Worry more about breakpoints than the bottom.
4096 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4098 % Roman numerals for page numbers.
4099 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4103 % Normal (long) toc.
4105 \startcontents{\putwordTOC}%
4106 \openin 1 \jobname.toc
4112 \contentsalignmacro % in case @setchapternewpage odd is in effect
4115 \lastnegativepageno = \pageno
4116 \global\pageno = \savepageno
4119 % And just the chapters.
4120 \def\summarycontents{%
4121 \startcontents{\putwordShortTOC}%
4123 \let\chapentry = \shortchapentry
4124 \let\appendixentry = \shortappendixentry
4125 \let\unnumbchapentry = \shortunnumberedentry
4126 % We want a true roman here for the page numbers.
4128 \let\rm=\shortcontrm \let\bf=\shortcontbf
4129 \let\sl=\shortcontsl \let\tt=\shortconttt
4131 \hyphenpenalty = 10000
4132 \advance\baselineskip by 1pt % Open it up a little.
4133 \def\secentry ##1##2##3##4{}
4134 \def\subsecentry ##1##2##3##4##5{}
4135 \def\subsubsecentry ##1##2##3##4##5##6{}
4136 \let\unnumbsecentry = \secentry
4137 \let\unnumbsubsecentry = \subsecentry
4138 \let\unnumbsubsubsecentry = \subsubsecentry
4139 \openin 1 \jobname.toc
4145 \contentsalignmacro % in case @setchapternewpage odd is in effect
4147 \lastnegativepageno = \pageno
4148 \global\pageno = \savepageno
4150 \let\shortcontents = \summarycontents
4153 \pdfcatalog{/PageMode /UseOutlines}%
4156 % These macros generate individual entries in the table of contents.
4157 % The first argument is the chapter or section name.
4158 % The last argument is the page number.
4159 % The arguments in between are the chapter number, section number, ...
4161 % Chapters, in the main contents.
4162 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4164 % Chapters, in the short toc.
4165 % See comments in \dochapentry re vbox and related settings.
4166 \def\shortchapentry#1#2#3{%
4167 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4170 % Appendices, in the main contents.
4171 \def\appendixentry#1#2#3{%
4172 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4174 % Appendices, in the short toc.
4175 \let\shortappendixentry = \shortchapentry
4177 % Typeset the label for a chapter or appendix for the short contents.
4178 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4179 % We could simplify the code here by writing out an \appendixentry
4180 % command in the toc file for appendices, instead of using \chapentry
4181 % for both, but it doesn't seem worth it.
4183 \newdimen\shortappendixwidth
4185 \def\shortchaplabel#1{%
4186 % This space should be enough, since a single number is .5em, and the
4187 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4188 % But use \hss just in case.
4189 % (This space doesn't include the extra space that gets added after
4190 % the label; that gets put in by \shortchapentry above.)
4192 \hbox to \dimen0{#1\hss}%
4195 % Unnumbered chapters.
4196 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4197 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4200 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4201 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4204 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4205 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4207 % And subsubsections.
4208 \def\subsubsecentry#1#2#3#4#5#6{%
4209 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4210 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4212 % This parameter controls the indentation of the various levels.
4213 \newdimen\tocindent \tocindent = 3pc
4215 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4218 % If the toc has to be broken over pages, we want it to be at chapters
4219 % if at all possible; hence the \penalty.
4220 \def\dochapentry#1#2{%
4221 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4224 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4226 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4229 \def\dosecentry#1#2{\begingroup
4230 \secentryfonts \leftskip=\tocindent
4231 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4234 \def\dosubsecentry#1#2{\begingroup
4235 \subsecentryfonts \leftskip=2\tocindent
4236 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4239 \def\dosubsubsecentry#1#2{\begingroup
4240 \subsubsecentryfonts \leftskip=3\tocindent
4241 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4244 % Final typesetting of a toc entry; we use the same \entry macro as for
4245 % the index entries, but we want to suppress hyphenation here. (We
4246 % can't do that in the \entry macro, since index entries might consist
4247 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4248 \def\tocentry#1#2{\begingroup
4249 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4250 % Do not use \turnoffactive in these arguments. Since the toc is
4251 % typeset in cmr, characters such as _ would come out wrong; we
4252 % have to do the usual translation tricks.
4256 % Space between chapter (or whatever) number and the title.
4257 \def\labelspace{\hskip1em \relax}
4259 \def\dopageno#1{{\rm #1}}
4260 \def\doshortpageno#1{{\rm #1}}
4262 \def\chapentryfonts{\secfonts \rm}
4263 \def\secentryfonts{\textfonts}
4264 \let\subsecentryfonts = \textfonts
4265 \let\subsubsecentryfonts = \textfonts
4268 \message{environments,}
4269 % @foo ... @end foo.
4271 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4273 % Since these characters are used in examples, it should be an even number of
4274 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4277 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4278 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4279 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4280 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4282 % The @error{} command.
4283 % Adapted from the TeXbook's \boxit.
4287 {\tentt \global\dimen0 = 3em}% Width of the box.
4288 \dimen2 = .55pt % Thickness of rules
4289 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4290 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4292 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4293 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4294 \advance\hsize by -2\dimen2 % Rules.
4296 \hrule height\dimen2
4297 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4298 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4299 \kern3pt\vrule width\dimen2}% Space to right.
4300 \hrule height\dimen2}
4303 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4305 % @tex ... @end tex escapes into raw Tex temporarily.
4306 % One exception: @ is still an escape character, so that @end tex works.
4307 % But \@ or @@ will get a plain tex @ character.
4309 \def\tex{\begingroup
4310 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4311 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4312 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4323 \let\bullet=\ptexbullet
4328 \let\equiv=\ptexequiv
4331 \let\indent=\ptexindent
4339 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4340 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4342 \let\Etex=\endgroup}
4344 % Define @lisp ... @end lisp.
4345 % @lisp does a \begingroup so it can rebind things,
4346 % including the definition of @end lisp (which normally is erroneous).
4348 % Amount to narrow the margins by for @lisp.
4349 \newskip\lispnarrowing \lispnarrowing=0.4in
4351 % This is the definition that ^^M gets inside @lisp, @example, and other
4352 % such environments. \null is better than a space, since it doesn't
4354 \def\lisppar{\null\endgraf}
4356 % Make each space character in the input produce a normal interword
4357 % space in the output. Don't allow a line break at this space, as this
4358 % is used only in environments like @example, where each line of input
4359 % should produce a line of output anyway.
4362 \gdef\sepspaces{\obeyspaces\let =\tie}}
4364 % Define \obeyedspace to be our active space, whatever it is. This is
4365 % for use in \parsearg.
4367 \global\let\obeyedspace= }
4369 % This space is always present above and below environments.
4370 \newskip\envskipamount \envskipamount = 0pt
4372 % Make spacing and below environment symmetrical. We use \parskip here
4373 % to help in doing that, since in @example-like environments \parskip
4374 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4375 % start of the next paragraph will insert \parskip.
4377 \def\aboveenvbreak{{%
4378 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4379 \ifnum \lastpenalty=10000 \else
4380 \advance\envskipamount by \parskip
4382 \ifdim\lastskip<\envskipamount
4384 % it's not a good place to break if the last penalty was \nobreak
4386 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4387 \vskip\envskipamount
4392 \let\afterenvbreak = \aboveenvbreak
4394 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4395 \let\nonarrowing=\relax
4397 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4398 % environment contents.
4399 \font\circle=lcircle10
4401 \newdimen\cartouter\newdimen\cartinner
4402 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4403 \circthick=\fontdimen8\circle
4405 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4406 \def\ctr{{\hskip 6pt\circle\char'010}}
4407 \def\cbl{{\circle\char'012\hskip -6pt}}
4408 \def\cbr{{\hskip 6pt\circle\char'011}}
4409 \def\carttop{\hbox to \cartouter{\hskip\lskip
4410 \ctl\leaders\hrule height\circthick\hfil\ctr
4412 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4413 \cbl\leaders\hrule height\circthick\hfil\cbr
4416 \newskip\lskip\newskip\rskip
4419 \par % can't be in the midst of a paragraph.
4421 \lskip=\leftskip \rskip=\rightskip
4422 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4423 \cartinner=\hsize \advance\cartinner by-\lskip
4424 \advance\cartinner by-\rskip
4426 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4427 % side, and for 6pt waste from
4428 % each corner char, and rule thickness
4429 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4430 % Flag to tell @lisp, etc., not to narrow margin.
4431 \let\nonarrowing=\comment
4433 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4442 \baselineskip=\normbskip
4443 \lineskip=\normlskip
4459 % This macro is called at the beginning of all the @example variants,
4463 \inENV % This group ends at the end of the body
4464 \hfuzz = 12pt % Don't be fussy
4465 \sepspaces % Make spaces be word-separators rather than space tokens.
4466 \let\par = \lisppar % don't ignore blank lines
4467 \obeylines % each line of input is a line of output
4470 \emergencystretch = 0pt % don't try to avoid overfull boxes
4471 % @cartouche defines \nonarrowing to inhibit narrowing
4472 % at next level down.
4473 \ifx\nonarrowing\relax
4474 \advance \leftskip by \lispnarrowing
4475 \exdentamount=\lispnarrowing
4476 \let\exdent=\nofillexdent
4477 \let\nonarrowing=\relax
4481 % Define the \E... control sequence only if we are inside the particular
4482 % environment, so the error checking in \end will work.
4484 % To end an @example-like environment, we first end the paragraph (via
4485 % \afterenvbreak's vertical glue), and then the group. That way we keep
4486 % the zero \parskip that the environments set -- \parskip glue will be
4487 % inserted at the beginning of the next paragraph in the document, after
4490 \def\nonfillfinish{\afterenvbreak\endgroup}
4492 % @lisp: indented, narrowed, typewriter font.
4493 \def\lisp{\begingroup
4495 \let\Elisp = \nonfillfinish
4497 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4498 \gobble % eat return
4501 % @example: Same as @lisp.
4502 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4504 % @smallexample and @smalllisp: use smaller fonts.
4505 % Originally contributed by Pavel@xerox.
4506 \def\smalllisp{\begingroup
4507 \def\Esmalllisp{\nonfillfinish\endgroup}%
4508 \def\Esmallexample{\nonfillfinish\endgroup}%
4512 \let\smallexample = \smalllisp
4515 % @display: same as @lisp except keep current font.
4517 \def\display{\begingroup
4519 \let\Edisplay = \nonfillfinish
4523 % @smalldisplay: @display plus smaller fonts.
4525 \def\smalldisplay{\begingroup
4526 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4527 \smallexamplefonts \rm
4531 % @format: same as @display except don't narrow margins.
4533 \def\format{\begingroup
4534 \let\nonarrowing = t
4536 \let\Eformat = \nonfillfinish
4540 % @smallformat: @format plus smaller fonts.
4542 \def\smallformat{\begingroup
4543 \def\Esmallformat{\nonfillfinish\endgroup}%
4544 \smallexamplefonts \rm
4548 % @flushleft (same as @format).
4550 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4554 \def\flushright{\begingroup
4555 \let\nonarrowing = t
4557 \let\Eflushright = \nonfillfinish
4558 \advance\leftskip by 0pt plus 1fill
4563 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4564 % and narrows the margins.
4567 \begingroup\inENV %This group ends at the end of the @quotation body
4568 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4570 % We have retained a nonzero parskip for the environment, since we're
4571 % doing normal filling. So to avoid extra space below the environment...
4572 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4574 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4575 \ifx\nonarrowing\relax
4576 \advance\leftskip by \lispnarrowing
4577 \advance\rightskip by \lispnarrowing
4578 \exdentamount = \lispnarrowing
4579 \let\nonarrowing = \relax
4584 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4585 % If we want to allow any <char> as delimiter,
4586 % we need the curly braces so that makeinfo sees the @verb command, eg:
4587 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4589 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4591 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4592 % active too. Otherwise, they get lost as the first character on a
4595 \do\ \do\\\do\{\do\}\do\$\do\&%
4596 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4597 \do\<\do\>\do\|\do\@\do+\do\"%
4601 \def\uncatcodespecials{%
4602 \def\do##1{\catcode`##1=12}\dospecials}
4604 % [Knuth] pp. 380,381,391
4605 % Disable Spanish ligatures ?` and !` of \tt font
4607 \catcode`\`=\active\gdef`{\relax\lq}
4610 % Setup for the @verb command.
4612 % Eight spaces for a tab
4614 \catcode`\^^I=\active
4615 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4619 \tt % easiest (and conventionally used) font for verbatim
4620 \def\par{\leavevmode\endgraf}%
4623 % Respect line breaks,
4624 % print special symbols as themselves, and
4625 % make each space count
4626 % must do in this order:
4627 \obeylines \uncatcodespecials \sepspaces
4630 % Setup for the @verbatim environment
4632 % Real tab expansion
4633 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4635 \def\starttabbox{\setbox0=\hbox\bgroup}
4637 \catcode`\^^I=\active
4639 \catcode`\^^I=\active
4640 \def^^I{\leavevmode\egroup
4641 \dimen0=\wd0 % the width so far, or since the previous tab
4642 \divide\dimen0 by\tabw
4643 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4644 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4645 \wd0=\dimen0 \box0 \starttabbox
4649 \def\setupverbatim{%
4650 % Easiest (and conventionally used) font for verbatim
4652 \def\par{\leavevmode\egroup\box0\endgraf}%
4655 % Respect line breaks,
4656 % print special symbols as themselves, and
4657 % make each space count
4658 % must do in this order:
4659 \obeylines \uncatcodespecials \sepspaces
4660 \everypar{\starttabbox}%
4663 % Do the @verb magic: verbatim text is quoted by unique
4664 % delimiter characters. Before first delimiter expect a
4665 % right brace, after last delimiter expect closing brace:
4667 % \def\doverb'{'<char>#1<char>'}'{#1}
4669 % [Knuth] p. 382; only eat outer {}
4671 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4672 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4675 \def\verb{\begingroup\setupverb\doverb}
4678 % Do the @verbatim magic: define the macro \doverbatim so that
4679 % the (first) argument ends when '@end verbatim' is reached, ie:
4681 % \def\doverbatim#1@end verbatim{#1}
4683 % For Texinfo it's a lot easier than for LaTeX,
4684 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4685 % we need not redefine '\', '{' and '}'.
4687 % Inspired by LaTeX's verbatim command set [latex.ltx]
4688 %% Include LaTeX hack for completeness -- never know
4690 %% \catcode`|=0 \catcode`[=1
4691 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4692 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4693 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4699 % ignore everything up to the first ^^M, that's the newline at the end
4700 % of the @verbatim input line itself. Otherwise we get an extra blank
4701 % line in the output.
4702 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}%
4706 \def\Everbatim{\nonfillfinish\endgroup}%
4709 \advance\leftskip by -\defbodyindent
4710 \begingroup\setupverbatim\doverbatim
4713 % @verbatiminclude FILE - insert text of file in verbatim environment.
4715 % Allow normal characters that we make active in the argument (a file name).
4716 \def\verbatiminclude{%
4726 \parsearg\doverbatiminclude
4728 \def\setupverbatiminclude{%
4731 \advance\leftskip by -\defbodyindent
4732 \begingroup\setupverbatim
4735 \def\doverbatiminclude#1{%
4736 % Restore active chars for included file.
4739 \let\value=\expandablevalue
4741 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4747 % @copying ... @end copying.
4748 % Save the text away for @insertcopying later. Many commands won't be
4749 % allowed in this context, but that's ok.
4751 % We save the uninterpreted tokens, rather than creating a box.
4752 % Saving the text in a box would be much easier, but then all the
4753 % typesetting commands (@smallbook, font changes, etc.) have to be done
4754 % beforehand -- and a) we want @copying to be done first in the source
4755 % file; b) letting users define the frontmatter in as flexible order as
4756 % possible is very desirable.
4758 \def\copying{\begingroup
4759 % Define a command to swallow text until we reach `@end copying'.
4760 % \ is the escape char in this texinfo.tex file, so it is the
4761 % delimiter for the command; @ will be the escape char when we read
4762 % it, but that doesn't matter.
4763 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4765 % We must preserve ^^M's in the input file; see \insertcopying below.
4766 \catcode`\^^M = \active
4770 % What we do to finish off the copying text.
4772 \def\enddocopying{\endgroup\ignorespaces}
4774 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4775 % we need them to delimit commands such as `@end quotation', so they
4776 % must be active. On the other hand, we certainly don't want every
4777 % end-of-line to be a \par, as would happen with the normal active
4778 % definition of ^^M. On the third hand, two ^^M's in a row should still
4781 % Our approach is to make ^^M insert a space and a penalty1 normally;
4782 % then it can also check if \lastpenalty=1. If it does, then manually
4785 % This messes up the normal definitions of @c[omment], so we redefine
4786 % it. Similarly for @ignore. (These commands are used in the gcc
4787 % manual for man page generation.)
4789 % Seems pretty fragile, most line-oriented commands will presumably
4790 % fail, but for the limited use of getting the copying text (which
4791 % should be quite simple) inserted, we can hope it's ok.
4793 {\catcode`\^^M=\active %
4794 \gdef\insertcopying{\begingroup %
4795 \parindent = 0pt % looks wrong on title page
4797 \ifnum \lastpenalty=1 %
4804 % Fix @c[omment] for catcode 13 ^^M's.
4805 \def\c##1^^M{\ignorespaces}%
4808 % Don't bother jumping through all the hoops that \doignore does, it
4809 % would be very hard since the catcodes are already set.
4810 \long\def\ignore##1\end ignore{\ignorespaces}%
4819 % Allow user to change definition object font (\df) internally
4820 \def\setdeffont#1 {\csname DEF#1\endcsname}
4822 \newskip\defbodyindent \defbodyindent=.4in
4823 \newskip\defargsindent \defargsindent=50pt
4824 \newskip\deflastargmargin \deflastargmargin=18pt
4826 \newcount\parencount
4828 % We want ()&[] to print specially on the defun line.
4831 \catcode`\(=\active \catcode`\)=\active
4833 \catcode`\[=\active \catcode`\]=\active
4836 % Make control sequences which act like normal parenthesis chars.
4837 \let\lparen = ( \let\rparen = )
4839 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4841 % Be sure that we always have a definition for `(', etc. For example,
4842 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4843 % so TeX would otherwise complain about undefined control sequence.
4844 \global\let(=\lparen \global\let)=\rparen
4845 \global\let[=\lbrack \global\let]=\rbrack
4847 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4848 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4849 % This is used to turn on special parens
4850 % but make & act ordinary (given that it's active).
4851 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4853 % Definitions of (, ) and & used in args for functions.
4854 % This is the definition of ( outside of all parentheses.
4855 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4856 \global\advance\parencount by 1
4859 % This is the definition of ( when already inside a level of parens.
4860 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4862 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4863 % also in that case restore the outer-level definition of (.
4864 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4865 \global\advance \parencount by -1 }
4866 % If we encounter &foo, then turn on ()-hacking afterwards
4867 \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
4869 \gdef\normalparens{\boldbrax\let&=\ampnr}
4870 } % End of definition inside \activeparens
4871 %% These parens (in \boldbrax) actually are a little bolder than the
4872 %% contained text. This is especially needed for [ and ]
4873 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4874 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4876 \def\lbrb{{\bf\char`\[}}
4877 \def\rbrb{{\bf\char`\]}}
4879 % Active &'s sneak into the index arguments, so make sure it's defined.
4881 \catcode`& = \active
4882 \global\let& = \ampnr
4885 % \defname, which formats the name of the @def (not the args).
4886 % #1 is the function name.
4887 % #2 is the type of definition, such as "Function".
4890 % How we'll output the type name. Putting it in brackets helps
4891 % distinguish it from the body text that may end up on the next line
4896 \def\defnametype{[\rm #2]}%
4899 % Get the values of \leftskip and \rightskip as they were outside the @def...
4901 \advance\dimen2 by -\defbodyindent
4903 % Figure out values for the paragraph shape.
4904 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}%
4905 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4906 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations
4907 \parshape 2 0in \dimen0 \defargsindent \dimen1
4909 % Output arg 2 ("Function" or some such) but stuck inside a box of
4910 % width 0 so it does not interfere with linebreaking.
4913 {% Adjust \hsize to exclude the ambient margins,
4914 % so that \rightline will obey them.
4915 \advance \hsize by -\dimen2
4916 \dimen3 = 0pt % was -1.25pc
4917 \rlap{\rightline{\defnametype\kern\dimen3}}%
4920 % Allow all lines to be underfull without complaint:
4921 \tolerance=10000 \hbadness=10000
4922 \advance\leftskip by -\defbodyindent
4923 \exdentamount=\defbodyindent
4924 {\df #1}\enskip % output function name
4925 % \defunargs will be called next to output the arguments, if any.
4928 % Common pieces to start any @def...
4929 % #1 is the \E... control sequence to end the definition (which we define).
4930 % #2 is the \...x control sequence (which our caller defines).
4931 % #3 is the control sequence to process the header, such as \defunheader.
4933 \def\parsebodycommon#1#2#3{%
4935 % If there are two @def commands in a row, we'll have a \nobreak,
4936 % which is there to keep the function description together with its
4937 % header. But if there's nothing but headers, we want to allow a
4938 % break after all. Check for penalty 10002 (inserted by
4939 % \defargscommonending) instead of 10000, since the sectioning
4940 % commands insert a \penalty10000, and we don't want to allow a break
4941 % between a section heading and a defun.
4942 \ifnum\lastpenalty=10002 \penalty0 \fi
4945 % Define the \E... end token that this defining construct specifies
4946 % so that it will exit this group.
4947 \def#1{\endgraf\endgroup\medbreak}%
4950 \advance\leftskip by \defbodyindent
4951 \exdentamount=\defbodyindent
4954 % Common part of the \...x definitions.
4956 \def\defxbodycommon{%
4957 % As with \parsebodycommon above, allow line break if we have multiple
4958 % x headers in a row. It's not a great place, though.
4959 \ifnum\lastpenalty=10000 \penalty1000 \fi
4961 \begingroup\obeylines
4964 % Process body of @defun, @deffn, @defmac, etc.
4966 \def\defparsebody#1#2#3{%
4967 \parsebodycommon{#1}{#2}{#3}%
4968 \def#2{\defxbodycommon \activeparens \spacesplit#3}%
4969 \catcode\equalChar=\active
4970 \begingroup\obeylines\activeparens
4974 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
4975 % #4, delimited by the space, is the class name.
4977 \def\defmethparsebody#1#2#3#4 {%
4978 \parsebodycommon{#1}{#2}{#3}%
4979 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
4980 \begingroup\obeylines\activeparens
4981 % The \empty here prevents misinterpretation of a construct such as
4982 % @deffn {whatever} {Enharmonic comma}
4983 % See comments at \deftpparsebody, although in our case we don't have
4984 % to remove the \empty afterwards, since it is empty.
4985 \spacesplit{#3{#4}}\empty
4988 % Used for @deftypemethod and @deftypeivar.
4989 % #1, #2, #3 are the common arguments (see \defparsebody).
4990 % #4, delimited by a space, is the class name.
4991 % #5 is the method's return type.
4993 \def\deftypemethparsebody#1#2#3#4 #5 {%
4994 \parsebodycommon{#1}{#2}{#3}%
4995 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
4996 \begingroup\obeylines\activeparens
4997 \spacesplit{#3{#4}{#5}}%
5000 % Used for @deftypeop. The change from \deftypemethparsebody is an
5001 % extra argument at the beginning which is the `category', instead of it
5002 % being the hardwired string `Method' or `Instance Variable'. We have
5003 % to account for this both in the \...x definition and in parsing the
5004 % input at hand. Thus also need a control sequence (passed as #5) for
5005 % the \E... definition to assign the category name to.
5007 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
5008 \parsebodycommon{#1}{#2}{#3}%
5009 \def#2##1 ##2 ##3 {\def#4{##1}%
5010 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
5011 \begingroup\obeylines\activeparens
5012 \spacesplit{#3{#5}{#6}}%
5016 \def\defopparsebody #1#2#3#4#5 {%
5017 \parsebodycommon{#1}{#2}{#3}%
5018 \def#2##1 ##2 {\def#4{##1}%
5019 \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
5020 \begingroup\obeylines\activeparens
5021 \spacesplit{#3{#5}}%
5024 % These parsing functions are similar to the preceding ones
5025 % except that they do not make parens into active characters.
5026 % These are used for "variables" since they have no arguments.
5028 \def\defvarparsebody #1#2#3{%
5029 \parsebodycommon{#1}{#2}{#3}%
5030 \def#2{\defxbodycommon \spacesplit#3}%
5031 \catcode\equalChar=\active
5032 \begingroup\obeylines
5037 \def\defopvarparsebody #1#2#3#4#5 {%
5038 \parsebodycommon{#1}{#2}{#3}%
5039 \def#2##1 ##2 {\def#4{##1}%
5040 \defxbodycommon \spacesplit{#3{##2}}}%
5041 \begingroup\obeylines
5042 \spacesplit{#3{#5}}%
5045 \def\defvrparsebody#1#2#3#4 {%
5046 \parsebodycommon{#1}{#2}{#3}%
5047 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5048 \begingroup\obeylines
5049 \spacesplit{#3{#4}}%
5052 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5053 % type is just `struct', because we lose the braces in `{struct
5054 % termios}' when \spacesplit reads its undelimited argument. Sigh.
5055 % \let\deftpparsebody=\defvrparsebody
5057 % So, to get around this, we put \empty in with the type name. That
5058 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5059 % won't strip off the braces.
5061 \def\deftpparsebody #1#2#3#4 {%
5062 \parsebodycommon{#1}{#2}{#3}%
5063 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5064 \begingroup\obeylines
5065 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5068 % Fine, but then we have to eventually remove the \empty *and* the
5069 % braces (if any). That's what this does.
5071 \def\removeemptybraces\empty#1\relax{#1}
5073 % After \spacesplit has done its work, this is called -- #1 is the final
5074 % thing to call, #2 the type name (which starts with \empty), and #3
5075 % (which might be empty) the arguments.
5077 \def\parsetpheaderline#1#2#3{%
5078 #1{\removeemptybraces#2\relax}{#3}%
5081 % Split up #2 (the rest of the input line) at the first space token.
5082 % call #1 with two arguments:
5083 % the first is all of #2 before the space token,
5084 % the second is all of #2 after that space token.
5085 % If #2 contains no space token, all of it is passed as the first arg
5086 % and the second is passed as empty.
5089 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5090 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5100 % This is called to end the arguments processing for all the @def... commands.
5102 \def\defargscommonending{%
5103 \interlinepenalty = 10000
5104 \advance\rightskip by 0pt plus 1fil
5106 \nobreak\vskip -\parskip
5107 \penalty 10002 % signal to \parsebodycommon.
5110 % This expands the args and terminates the paragraph they comprise.
5112 \def\defunargs#1{\functionparens \sl
5113 % Expand, preventing hyphenation at `-' chars.
5114 % Note that groups don't affect changes in \hyphenchar.
5115 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5116 {\tensl\hyphenchar\font=0}%
5118 {\tensl\hyphenchar\font=45}%
5119 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
5120 \defargscommonending
5123 \def\deftypefunargs #1{%
5124 % Expand, preventing hyphenation at `-' chars.
5125 % Note that groups don't affect changes in \hyphenchar.
5126 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
5128 \tclose{#1}% avoid \code because of side effects on active chars
5129 \defargscommonending
5132 % Do complete processing of one @defun or @defunx line already parsed.
5134 % @deffn Command forward-char nchars
5136 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5138 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5139 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5140 \catcode\equalChar=\other % Turn off change made in \defparsebody
5143 % @defun == @deffn Function
5145 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5147 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5148 \begingroup\defname {#1}{\putwordDeffunc}%
5149 \defunargs {#2}\endgroup %
5150 \catcode\equalChar=\other % Turn off change made in \defparsebody
5153 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5155 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5157 % #1 is the data type. #2 is the name and args.
5158 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5159 % #1 is the data type, #2 the name, #3 the args.
5160 \def\deftypefunheaderx #1#2 #3\relax{%
5161 \doind {fn}{\code{#2}}% Make entry in function index
5162 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5163 \deftypefunargs {#3}\endgroup %
5164 \catcode\equalChar=\other % Turn off change made in \defparsebody
5167 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5169 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5171 % \defheaderxcond#1\relax$.$
5172 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5173 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5175 % #1 is the classification. #2 is the data type. #3 is the name and args.
5176 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5177 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5178 \def\deftypefnheaderx #1#2#3 #4\relax{%
5179 \doind {fn}{\code{#3}}% Make entry in function index
5181 \normalparens % notably, turn off `&' magic, which prevents
5182 % at least some C++ text from working
5183 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5184 \deftypefunargs {#4}\endgroup %
5185 \catcode\equalChar=\other % Turn off change made in \defparsebody
5188 % @defmac == @deffn Macro
5190 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5192 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5193 \begingroup\defname {#1}{\putwordDefmac}%
5194 \defunargs {#2}\endgroup %
5195 \catcode\equalChar=\other % Turn off change made in \defparsebody
5198 % @defspec == @deffn Special Form
5200 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5202 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5203 \begingroup\defname {#1}{\putwordDefspec}%
5204 \defunargs {#2}\endgroup %
5205 \catcode\equalChar=\other % Turn off change made in \defparsebody
5208 % @defop CATEGORY CLASS OPERATION ARG...
5210 \def\defop #1 {\def\defoptype{#1}%
5211 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5213 \def\defopheader#1#2#3{%
5214 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% function index entry
5216 \defname{#2}{\defoptype\ \putwordon\ #1}%
5221 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5223 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5224 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5227 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5228 \def\deftypeopheader#1#2#3#4{%
5229 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5231 \defname{\defheaderxcond#2\relax$.$#3}
5232 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5233 \deftypefunargs{#4}%
5237 % @deftypemethod CLASS TYPE METHOD ARG...
5239 \def\deftypemethod{%
5240 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5242 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5243 \def\deftypemethodheader#1#2#3#4{%
5244 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5246 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5247 \deftypefunargs{#4}%
5251 % @deftypeivar CLASS TYPE VARNAME
5254 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5256 % #1 is the class name, #2 the data type, #3 the variable name.
5257 \def\deftypeivarheader#1#2#3{%
5258 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5260 \defname{\defheaderxcond#2\relax$.$#3}
5261 {\putwordInstanceVariableof\ \code{#1}}%
5266 % @defmethod == @defop Method
5268 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5270 % #1 is the class name, #2 the method name, #3 the args.
5271 \def\defmethodheader#1#2#3{%
5272 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5274 \defname{#2}{\putwordMethodon\ \code{#1}}%
5279 % @defcv {Class Option} foo-class foo-flag
5281 \def\defcv #1 {\def\defcvtype{#1}%
5282 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5284 \def\defcvarheader #1#2#3{%
5285 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% variable index entry
5287 \defname{#2}{\defcvtype\ \putwordof\ #1}%
5292 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5294 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5296 \def\defivarheader#1#2#3{%
5297 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% entry in var index
5299 \defname{#2}{\putwordInstanceVariableof\ #1}%
5305 % First, define the processing that is wanted for arguments of @defvar.
5306 % This is actually simple: just print them in roman.
5307 % This must expand the args and terminate the paragraph they make up
5308 \def\defvarargs #1{\normalparens #1%
5309 \defargscommonending
5312 % @defvr Counter foo-count
5314 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5316 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5317 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5319 % @defvar == @defvr Variable
5321 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5323 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5324 \begingroup\defname {#1}{\putwordDefvar}%
5325 \defvarargs {#2}\endgroup %
5328 % @defopt == @defvr {User Option}
5330 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5332 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5333 \begingroup\defname {#1}{\putwordDefopt}%
5334 \defvarargs {#2}\endgroup %
5337 % @deftypevar int foobar
5339 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5341 % #1 is the data type. #2 is the name, perhaps followed by text that
5342 % is actually part of the data type, which should not be put into the index.
5343 \def\deftypevarheader #1#2{%
5344 \dovarind#2 \relax% Make entry in variables index
5345 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5346 \defargscommonending
5348 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5350 % @deftypevr {Global Flag} int enable
5352 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5354 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5355 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5356 \defargscommonending
5360 % Args are printed in bold, a slight difference from @defvar.
5362 \def\deftpargs #1{\bf \defvarargs{#1}}
5364 % @deftp Class window height width ...
5366 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5368 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5369 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5371 % These definitions are used if you use @defunx (etc.)
5372 % anywhere other than immediately after a @defun or @defunx.
5374 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5375 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5376 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5377 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5378 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5379 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5380 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5381 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5382 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5383 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5384 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5385 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5386 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5387 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5388 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5389 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5390 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5391 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5392 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5398 % To do this right we need a feature of e-TeX, \scantokens,
5399 % which we arrange to emulate with a temporary file in ordinary TeX.
5400 \ifx\eTeXversion\undefined
5401 \newwrite\macscribble
5403 \begingroup \newlinechar`\^^M
5404 % Undo catcode changes of \startcontents and \doprintindex
5405 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5406 % Append \endinput to make sure that TeX does not see the ending newline.
5407 \toks0={#1\endinput}%
5408 \immediate\openout\macscribble=\jobname.tmp
5409 \immediate\write\macscribble{\the\toks0}%
5410 \immediate\closeout\macscribble
5411 \let\xeatspaces\eatspaces
5417 \begingroup \newlinechar`\^^M
5418 % Undo catcode changes of \startcontents and \doprintindex
5419 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5420 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5423 \newcount\paramno % Count of parameters
5424 \newtoks\macname % Macro name
5425 \newif\ifrecursive % Is it recursive?
5426 \def\macrolist{} % List of all defined macros in the form
5427 % \do\macro1\do\macro2...
5430 % Thisdoes \let #1 = #2, except with \csnames.
5432 \expandafter\expandafter
5434 \expandafter\expandafter
5436 \csname#2\endcsname}
5438 % Trim leading and trailing spaces off a string.
5439 % Concepts from aro-bend problem 15 (see CTAN).
5441 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5442 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5443 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5445 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5448 % Trim a single trailing ^^M off a string.
5449 {\catcode`\^^M=\other \catcode`\Q=3%
5450 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5451 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5452 \gdef\eatcrb#1Q#2Q{#1}%
5455 % Macro bodies are absorbed as an argument in a context where
5456 % all characters are catcode 10, 11 or 12, except \ which is active
5457 % (as in normal texinfo). It is necessary to change the definition of \.
5459 % It's necessary to have hard CRs when the macro is executed. This is
5460 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5461 % body, and then making it the \newlinechar in \scanmacro.
5463 \def\macrobodyctxt{%
5474 \catcode`\^^M=\other
5488 % \mbodybackslash is the definition of \ in @macro bodies.
5489 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5490 % where N is the macro parameter number.
5491 % We define \csname macarg.\endcsname to be \realbackslash, so
5492 % \\ in macro replacement text gets you a backslash.
5494 {\catcode`@=0 @catcode`@\=@active
5495 @gdef@usembodybackslash{@let\=@mbodybackslash}
5496 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5498 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5500 \def\macro{\recursivefalse\parsearg\macroxxx}
5501 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5504 \getargs{#1}% now \macname is the macname and \argl the arglist
5505 \ifx\argl\empty % no arguments
5508 \expandafter\parsemargdef \argl;%
5510 \if1\csname ismacro.\the\macname\endcsname
5511 \message{Warning: redefining \the\macname}%
5513 \expandafter\ifx\csname \the\macname\endcsname \relax
5514 \else \errmessage{Macro name \the\macname\space already defined}\fi
5515 \global\cslet{macsave.\the\macname}{\the\macname}%
5516 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5517 % Add the macroname to \macrolist
5518 \toks0 = \expandafter{\macrolist\do}%
5519 \xdef\macrolist{\the\toks0
5520 \expandafter\noexpand\csname\the\macname\endcsname}%
5522 \begingroup \macrobodyctxt
5523 \ifrecursive \expandafter\parsermacbody
5524 \else \expandafter\parsemacbody
5527 \def\unmacro{\parsearg\dounmacro}
5529 \if1\csname ismacro.#1\endcsname
5530 \global\cslet{#1}{macsave.#1}%
5531 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5532 % Remove the macro name from \macrolist:
5534 \expandafter\let\csname#1\endcsname \relax
5536 \xdef\macrolist{\macrolist}%
5539 \errmessage{Macro #1 not defined}%
5543 % Called by \do from \dounmacro on each macro. The idea is to omit any
5544 % macro definitions that have been changed to \relax.
5550 \noexpand\do \noexpand #1%
5554 % This makes use of the obscure feature that if the last token of a
5555 % <parameter list> is #, then the preceding argument is delimited by
5556 % an opening brace, and that opening brace is not consumed.
5557 \def\getargs#1{\getargsxxx#1{}}
5558 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5559 \def\getmacname #1 #2\relax{\macname={#1}}
5560 \def\getmacargs#1{\def\argl{#1}}
5562 % Parse the optional {params} list. Set up \paramno and \paramlist
5563 % so \defmacro knows what to do. Define \macarg.blah for each blah
5564 % in the params list, to be ##N where N is the position in that list.
5565 % That gets used by \mbodybackslash (above).
5567 % We need to get `macro parameter char #' into several definitions.
5568 % The technique used is stolen from LaTeX: let \hash be something
5569 % unexpandable, insert that wherever you need a #, and then redefine
5570 % it to # just before using the token list produced.
5572 % The same technique is used to protect \eatspaces till just before
5573 % the macro is used.
5575 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5576 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5577 \def\parsemargdefxxx#1,{%
5578 \if#1;\let\next=\relax
5579 \else \let\next=\parsemargdefxxx
5580 \advance\paramno by 1%
5581 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5582 {\xeatspaces{\hash\the\paramno}}%
5583 \edef\paramlist{\paramlist\hash\the\paramno,}%
5586 % These two commands read recursive and nonrecursive macro bodies.
5587 % (They're different since rec and nonrec macros end differently.)
5589 \long\def\parsemacbody#1@end macro%
5590 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5591 \long\def\parsermacbody#1@end rmacro%
5592 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5594 % This defines the macro itself. There are six cases: recursive and
5595 % nonrecursive macros of zero, one, and many arguments.
5596 % Much magic with \expandafter here.
5597 % \xdef is used so that macro definitions will survive the file
5598 % they're defined in; @include reads the file inside a group.
5600 \let\hash=##% convert placeholders to macro parameter chars
5604 \expandafter\xdef\csname\the\macname\endcsname{%
5605 \noexpand\scanmacro{\temp}}%
5607 \expandafter\xdef\csname\the\macname\endcsname{%
5608 \bgroup\noexpand\macroargctxt
5609 \noexpand\braceorline
5610 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5611 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5612 \egroup\noexpand\scanmacro{\temp}}%
5614 \expandafter\xdef\csname\the\macname\endcsname{%
5615 \bgroup\noexpand\macroargctxt
5616 \noexpand\csname\the\macname xx\endcsname}%
5617 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5618 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5619 \expandafter\expandafter
5621 \expandafter\expandafter
5622 \csname\the\macname xxx\endcsname
5623 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5628 \expandafter\xdef\csname\the\macname\endcsname{%
5629 \noexpand\norecurse{\the\macname}%
5630 \noexpand\scanmacro{\temp}\egroup}%
5632 \expandafter\xdef\csname\the\macname\endcsname{%
5633 \bgroup\noexpand\macroargctxt
5634 \noexpand\braceorline
5635 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5636 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5638 \noexpand\norecurse{\the\macname}%
5639 \noexpand\scanmacro{\temp}\egroup}%
5641 \expandafter\xdef\csname\the\macname\endcsname{%
5642 \bgroup\noexpand\macroargctxt
5643 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5644 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5645 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5646 \expandafter\expandafter
5648 \expandafter\expandafter
5649 \csname\the\macname xxx\endcsname
5652 \noexpand\norecurse{\the\macname}%
5653 \noexpand\scanmacro{\temp}\egroup}%
5657 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5659 % \braceorline decides whether the next nonwhitespace character is a
5660 % {. If so it reads up to the closing }, if not, it reads the whole
5661 % line. Whatever was read is then fed to the next control sequence
5662 % as an argument (by \parsebrace or \parsearg)
5663 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5664 \def\braceorlinexxx{%
5665 \ifx\nchar\bgroup\else
5666 \expandafter\parsearg
5669 % We mant to disable all macros during \shipout so that they are not
5670 % expanded by \write.
5671 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5672 \edef\next{\macrolist}\expandafter\endgroup\next}
5676 % We need some trickery to remove the optional spaces around the equal
5677 % sign. Just make them active and then expand them all to nothing.
5678 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5679 \def\aliasxxx #1{\aliasyyy#1\relax}
5680 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5681 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5682 \expandafter\noexpand\csname#2\endcsname}%
5683 \expandafter\endgroup\next}
5686 \message{cross references,}
5691 \newif\ifhavexrefs % True if xref values are known.
5692 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5694 % @inforef is relatively simple.
5695 \def\inforef #1{\inforefzzz #1,,,,**}
5696 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5697 node \samp{\ignorespaces#1{}}}
5699 % @node's job is to define \lastnode.
5700 \def\node{\ENVcheck\parsearg\nodezzz}
5701 \def\nodezzz#1{\nodexxx #1,\finishnodeparse}
5702 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5704 \let\lastnode=\relax
5706 % The sectioning commands (@chapter, etc.) call these.
5708 \ifx\lastnode\relax\else
5709 \expandafter\expandafter\expandafter\setref{\lastnode}%
5710 {Ysectionnumberandtype}%
5711 \global\let\lastnode=\relax
5714 \def\unnumbnoderef{%
5715 \ifx\lastnode\relax\else
5716 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5717 \global\let\lastnode=\relax
5720 \def\appendixnoderef{%
5721 \ifx\lastnode\relax\else
5722 \expandafter\expandafter\expandafter\setref{\lastnode}%
5723 {Yappendixletterandtype}%
5724 \global\let\lastnode=\relax
5729 % @anchor{NAME} -- define xref target at arbitrary point.
5731 \newcount\savesfregister
5732 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5733 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5734 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5736 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5737 % anchor), namely NAME-title (the corresponding @chapter/etc. name),
5738 % NAME-pg (the page number), and NAME-snt (section number and type).
5739 % Called from \foonoderef.
5741 % We have to set \indexdummies so commands such as @code in a section
5742 % title aren't expanded. It would be nicer not to expand the titles in
5743 % the first place, but there's so many layers that that is hard to do.
5745 % Likewise, use \turnoffactive so that punctuation chars such as underscore
5746 % and backslash work in node names.
5753 \dosetq{#1-title}{Ytitle}%
5754 \dosetq{#1-pg}{Ypagenumber}%
5755 \dosetq{#1-snt}{#2}%
5758 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5759 % the node name, #2 the name of the Info cross-reference, #3 the printed
5760 % node name, #4 the name of the Info file, #5 the name of the printed
5761 % manual. All but the node name can be omitted.
5763 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5764 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5765 \def\ref#1{\xrefX[#1,,,,,,,]}
5766 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5768 \def\printedmanual{\ignorespaces #5}%
5769 \def\printednodename{\ignorespaces #3}%
5770 \setbox1=\hbox{\printedmanual}%
5771 \setbox0=\hbox{\printednodename}%
5773 % No printed node name was explicitly given.
5774 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5775 % Use the node name inside the square brackets.
5776 \def\printednodename{\ignorespaces #1}%
5778 % Use the actual chapter/section title appear inside
5779 % the square brackets. Use the real section title if we have it.
5781 % It is in another manual, so we don't have it.
5782 \def\printednodename{\ignorespaces #1}%
5785 % We know the real title if we have the xref values.
5786 \def\printednodename{\refx{#1-title}{}}%
5788 % Otherwise just copy the Info node name.
5789 \def\printednodename{\ignorespaces #1}%
5795 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5796 % insert empty discretionaries after hyphens, which means that it will
5797 % not find a line break at a hyphen in a node names. Since some manuals
5798 % are best written with fairly long node names, containing hyphens, this
5799 % is a loss. Therefore, we give the text of the node name again, so it
5800 % is as if TeX is seeing it for the first time.
5804 {\turnoffactive \otherbackslash
5805 \ifnum\filenamelength>0
5806 \startlink attr{/Border [0 0 0]}%
5807 goto file{\the\filename.pdf} name{#1}%
5809 \startlink attr{/Border [0 0 0]}%
5817 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5819 % _ (for example) has to be the character _ for the purposes of the
5820 % control sequence corresponding to the node, but it has to expand
5821 % into the usual \leavevmode...\vrule stuff for purposes of
5822 % printing. So we \turnoffactive for the \refx-snt, back on for the
5823 % printing, back off for the \refx-pg.
5824 {\turnoffactive \otherbackslash
5825 % Only output a following space if the -snt ref is nonempty; for
5826 % @unnumbered and @anchor, it won't be.
5827 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5828 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5830 % output the `[mynode]' via a macro.
5831 \xrefprintnodename\printednodename
5833 % But we always want a comma and a space:
5836 % output the `page 3'.
5837 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5842 % This macro is called from \xrefX for the `[nodename]' part of xref
5843 % output. It's a separate macro only so it can be changed more easily,
5844 % since not square brackets don't work in some documents. Particularly
5845 % one that Bob is working on :).
5847 \def\xrefprintnodename#1{[#1]}
5849 % \dosetq is called from \setref to do the actual \write (\iflinks).
5853 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5858 % \internalsetq{foo}{page} expands into
5859 % CHARACTERS @xrdef{foo}{...expansion of \page...}
5860 \def\internalsetq#1#2{@xrdef{#1}{\csname #2\endcsname}}
5862 % Things to be expanded by \internalsetq.
5864 \def\Ypagenumber{\folio}
5865 \def\Ytitle{\thissection}
5867 \def\Ysectionnumberandtype{%
5869 \putwordChapter@tie \the\chapno
5870 \else \ifnum\subsecno=0
5871 \putwordSection@tie \the\chapno.\the\secno
5872 \else \ifnum\subsubsecno=0
5873 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5875 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5879 \def\Yappendixletterandtype{%
5881 \putwordAppendix@tie @char\the\appendixno{}%
5882 \else \ifnum\subsecno=0
5883 \putwordSection@tie @char\the\appendixno.\the\secno
5884 \else \ifnum\subsubsecno=0
5885 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5888 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5892 % Use TeX 3.0's \inputlineno to get the line number, for better error
5893 % messages, but if we're using an old version of TeX, don't do anything.
5895 \ifx\inputlineno\thisisundefined
5896 \let\linenumber = \empty % Pre-3.0.
5898 \def\linenumber{\the\inputlineno:\space}
5901 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5902 % If its value is nonempty, SUFFIX is output afterward.
5908 \expandafter\global\expandafter\let\expandafter\thisrefX
5909 \csname X#1\endcsname
5912 % If not defined, say something at least.
5913 \angleleft un\-de\-fined\angleright
5916 \message{\linenumber Undefined cross reference `#1'.}%
5919 \global\warnedxrefstrue
5920 \message{Cross reference values unknown; you must run TeX again.}%
5925 % It's defined, so just use it.
5928 #2% Output the suffix in any case.
5931 % This is the macro invoked by entries in the aux file.
5933 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
5935 % Read the last existing aux file, if any. No error if none exists.
5936 \def\readauxfile{\begingroup
5937 \catcode`\^^@=\other
5938 \catcode`\^^A=\other
5939 \catcode`\^^B=\other
5940 \catcode`\^^C=\other
5941 \catcode`\^^D=\other
5942 \catcode`\^^E=\other
5943 \catcode`\^^F=\other
5944 \catcode`\^^G=\other
5945 \catcode`\^^H=\other
5946 \catcode`\^^K=\other
5947 \catcode`\^^L=\other
5948 \catcode`\^^N=\other
5949 \catcode`\^^P=\other
5950 \catcode`\^^Q=\other
5951 \catcode`\^^R=\other
5952 \catcode`\^^S=\other
5953 \catcode`\^^T=\other
5954 \catcode`\^^U=\other
5955 \catcode`\^^V=\other
5956 \catcode`\^^W=\other
5957 \catcode`\^^X=\other
5958 \catcode`\^^Z=\other
5959 \catcode`\^^[=\other
5960 \catcode`\^^\=\other
5961 \catcode`\^^]=\other
5962 \catcode`\^^^=\other
5963 \catcode`\^^_=\other
5964 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
5965 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5966 % supported in the main text, it doesn't seem desirable. Furthermore,
5967 % that is not enough: for node names that actually contain a ^
5968 % character, we would end up writing a line like this: 'xrdef {'hat
5969 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5970 % argument, and \hat is not an expandable control sequence. It could
5971 % all be worked out, but why? Either we support ^^ or we don't.
5973 % The other change necessary for this was to define \auxhat:
5974 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5975 % and then to call \auxhat in \setq.
5979 % Special characters. Should be turned off anyway, but...
5992 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5994 % Make the characters 128-255 be printing characters
5998 \catcode\count 1=\other
5999 \advance\count 1 by 1
6000 \ifnum \count 1<256 \loop \fi
6004 % Turn off \ as an escape so we do not lose on
6005 % entries which were dumped with control sequences in their names.
6006 % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^
6007 % Reference to such entries still does not work the way one would wish,
6008 % but at least they do not bomb out when the aux file is read in.
6011 % @ is our escape character in .aux files.
6016 \openin 1 \jobname.aux
6020 \global\havexrefstrue
6022 % Open the new aux file. TeX will close it automatically at exit.
6023 \openout\auxfile=\jobname.aux
6029 \newcount \footnoteno
6031 % The trailing space in the following definition for supereject is
6032 % vital for proper filling; pages come out unaligned when you do a
6033 % pagealignmacro call if that space before the closing brace is
6034 % removed. (Generally, numeric constants should always be followed by a
6035 % space to prevent strange expansion errors.)
6036 \def\supereject{\par\penalty -20000\footnoteno =0 }
6038 % @footnotestyle is meaningful for info output only.
6039 \let\footnotestyle=\comment
6041 \let\ptexfootnote=\footnote
6045 % Auto-number footnotes. Otherwise like plain.
6047 \let\indent=\ptexindent
6048 \global\advance\footnoteno by \@ne
6049 \edef\thisfootno{$^{\the\footnoteno}$}%
6051 % In case the footnote comes at the end of a sentence, preserve the
6052 % extra spacing after we do the footnote number.
6054 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6056 % Remove inadvertent blank space before typesetting the footnote number.
6062 % Don't bother with the trickery in plain.tex to not require the
6063 % footnote text as a parameter. Our footnotes don't need to be so general.
6065 % Oh yes, they do; otherwise, @ifset and anything else that uses
6066 % \parseargline fail inside footnotes because the tokens are fixed when
6067 % the footnote is read. --karl, 16nov96.
6069 % The start of the footnote looks usually like this:
6070 \gdef\startfootins{\insert\footins\bgroup}
6072 % ... but this macro is redefined inside @multitable.
6076 % We want to typeset this text as a normal paragraph, even if the
6077 % footnote reference occurs in (for example) a display environment.
6078 % So reset some parameters.
6080 \interlinepenalty\interfootnotelinepenalty
6081 \splittopskip\ht\strutbox % top baseline for broken footnotes
6082 \splitmaxdepth\dp\strutbox
6083 \floatingpenalty\@MM
6088 \parindent\defaultparindent
6092 % Because we use hanging indentation in footnotes, a @noindent appears
6093 % to exdent this text, so make it be a no-op. makeinfo does not use
6094 % hanging indentation so @noindent can still be needed within footnote
6095 % text after an @example or the like (not that this is good style).
6096 \let\noindent = \relax
6098 % Hang the footnote text off the number. Use \everypar in case the
6099 % footnote extends for more than one paragraph.
6100 \everypar = {\hang}%
6101 \textindent{\thisfootno}%
6103 % Don't crash into the line above the footnote text. Since this
6104 % expands into a box, it must come within the paragraph, lest it
6105 % provide a place where TeX can split the footnote.
6107 \futurelet\next\fo@t
6109 }%end \catcode `\@=11
6111 % @| inserts a changebar to the left of the current line. It should
6112 % surround any changed text. This approach does *not* work if the
6113 % change spans more than two lines of output. To handle that, we would
6114 % have adopt a much more difficult approach (putting marks into the main
6115 % vertical list for the beginning and end of each change).
6118 % \vadjust can only be used in horizontal mode.
6121 % Append this vertical mode material after the current line in the output.
6123 % We want to insert a rule with the height and depth of the current
6124 % leading; that is exactly what \strutbox is supposed to record.
6125 \vskip-\baselineskip
6127 % \vadjust-items are inserted at the left edge of the type. So
6128 % the \llap here moves out into the left-hand margin.
6131 % For a thicker or thinner bar, change the `1pt'.
6132 \vrule height\baselineskip width1pt
6134 % This is the space between the bar and the text.
6140 % For a final copy, take out the rectangles
6141 % that mark overfull boxes (in case you have decided
6142 % that the text looks ok even though it passes the margin).
6144 \def\finalout{\overfullrule=0pt}
6146 % @image. We use the macros from epsf.tex to support this.
6147 % If epsf.tex is not installed and @image is used, we complain.
6149 % Check for and read epsf.tex up front. If we read it only at @image
6150 % time, we might be inside a group, and then its definitions would get
6151 % undone and the next image would fail.
6152 \openin 1 = epsf.tex
6155 % Do not bother showing banner with epsf.tex v2.7k (available in
6156 % doc/epsf.tex and on ctan).
6157 \def\epsfannounce{\toks0 = }%
6161 % We will only complain once about lack of epsf.tex.
6162 \newif\ifwarnednoepsf
6163 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6164 work. It is also included in the Texinfo distribution, or you can get
6165 it from ftp://tug.org/tex/epsf.tex.}
6168 \ifx\epsfbox\undefined
6169 \ifwarnednoepsf \else
6170 \errhelp = \noepsfhelp
6171 \errmessage{epsf.tex not found, images will be ignored}%
6172 \global\warnednoepsftrue
6175 \imagexxx #1,,,,,\finish
6179 % Arguments to @image:
6180 % #1 is (mandatory) image filename; we tack on .eps extension.
6181 % #2 is (optional) width, #3 is (optional) height.
6182 % #4 is (ignored optional) html alt text.
6183 % #5 is (ignored optional) extension.
6184 % #6 is just the usual extra ignored arg for parsing this stuff.
6186 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6187 \catcode`\^^M = 5 % in case we're inside an example
6188 \normalturnoffactive % allow _ et al. in names
6189 % If the image is by itself, center it.
6193 % Usually we'll have text after the image which will insert
6194 % \parskip glue, so insert it here too to equalize the space
6196 \nobreak\vskip\parskip
6203 \dopdfimage{#1}{#2}{#3}%
6205 % \epsfbox itself resets \epsf?size at each figure.
6206 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6207 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6211 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6215 \message{localization,}
6218 % @documentlanguage is usually given very early, just after
6219 % @setfilename. If done too late, it may not override everything
6220 % properly. Single argument is the language abbreviation.
6221 % It would be nice if we could set up a hyphenation file here.
6223 \def\documentlanguage{\parsearg\dodocumentlanguage}
6224 \def\dodocumentlanguage#1{%
6225 \tex % read txi-??.tex file in plain TeX.
6226 % Read the file if it exists.
6227 \openin 1 txi-#1.tex
6229 \errhelp = \nolanghelp
6230 \errmessage{Cannot read language file txi-#1.tex}%
6233 \def\temp{\input txi-#1.tex }%
6238 \newhelp\nolanghelp{The given language definition file cannot be found or
6239 is empty. Maybe you need to install it? In the current directory
6240 should work if nowhere else does.}
6243 % @documentencoding should change something in TeX eventually, most
6244 % likely, but for now just recognize it.
6245 \let\documentencoding = \comment
6248 % Page size parameters.
6250 \newdimen\defaultparindent \defaultparindent = 15pt
6252 \chapheadingskip = 15pt plus 4pt minus 2pt
6253 \secheadingskip = 12pt plus 3pt minus 2pt
6254 \subsecheadingskip = 9pt plus 2pt minus 2pt
6256 % Prevent underfull vbox error messages.
6259 % Don't be so finicky about underfull hboxes, either.
6262 % Following George Bush, just get rid of widows and orphans.
6266 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6267 % using an old version of TeX, don't do anything. We want the amount of
6268 % stretch added to depend on the line length, hence the dependence on
6269 % \hsize. We call this whenever the paper size is set.
6271 \def\setemergencystretch{%
6272 \ifx\emergencystretch\thisisundefined
6273 % Allow us to assign to \emergencystretch anyway.
6274 \def\emergencystretch{\dimen0}%
6276 \emergencystretch = .15\hsize
6280 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6281 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6282 % physical page width.
6284 % We also call \setleading{\textleading}, so the caller should define
6285 % \textleading. The caller should also set \parskip.
6287 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6290 \splittopskip = \topskip
6293 \advance\vsize by \topskip
6294 \outervsize = \vsize
6295 \advance\outervsize by 2\topandbottommargin
6296 \pageheight = \vsize
6299 \outerhsize = \hsize
6300 \advance\outerhsize by 0.5in
6303 \normaloffset = #4\relax
6304 \bindingoffset = #5\relax
6307 \pdfpageheight #7\relax
6308 \pdfpagewidth #8\relax
6311 \setleading{\textleading}
6313 \parindent = \defaultparindent
6314 \setemergencystretch
6317 % @letterpaper (the default).
6318 \def\letterpaper{{\globaldefs = 1
6319 \parskip = 3pt plus 2pt minus 1pt
6320 \textleading = 13.2pt
6322 % If page is nothing but text, make it come out even.
6323 \internalpagesizes{46\baselineskip}{6in}%
6325 {\bindingoffset}{36pt}%
6329 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6330 \def\smallbook{{\globaldefs = 1
6331 \parskip = 2pt plus 1pt
6334 \internalpagesizes{7.5in}{5in}%
6336 {\bindingoffset}{16pt}%
6339 \lispnarrowing = 0.3in
6342 \contentsrightmargin = 0pt
6343 \defbodyindent = .5cm
6346 % Use @afourpaper to print on European A4 paper.
6347 \def\afourpaper{{\globaldefs = 1
6348 \parskip = 3pt plus 2pt minus 1pt
6349 \textleading = 13.2pt
6351 % Double-side printing via postscript on Laserjet 4050
6352 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6353 % To change the settings for a different printer or situation, adjust
6354 % \normaloffset until the front-side and back-side texts align. Then
6355 % do the same for \bindingoffset. You can set these for testing in
6356 % your texinfo source file like this:
6358 % \global\normaloffset = -6mm
6359 % \global\bindingoffset = 10mm
6361 \internalpagesizes{51\baselineskip}{160mm}
6362 {\voffset}{\hoffset}%
6363 {\bindingoffset}{44pt}%
6368 \contentsrightmargin = 0pt
6369 \defbodyindent = 5mm
6372 % Use @afivepaper to print on European A5 paper.
6373 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6374 % He also recommends making @example and @lisp be small.
6375 \def\afivepaper{{\globaldefs = 1
6376 \parskip = 2pt plus 1pt minus 0.1pt
6377 \textleading = 12.5pt
6379 \internalpagesizes{160mm}{120mm}%
6380 {\voffset}{\hoffset}%
6381 {\bindingoffset}{8pt}%
6384 \lispnarrowing = 0.2in
6387 \contentsrightmargin = 0pt
6388 \defbodyindent = 2mm
6392 % A specific text layout, 24x15cm overall, intended for A4 paper.
6393 \def\afourlatex{{\globaldefs = 1
6395 \internalpagesizes{237mm}{150mm}%
6397 {\bindingoffset}{7mm}%
6400 % Must explicitly reset to 0 because we call \afourpaper.
6404 % Use @afourwide to print on A4 paper in landscape format.
6405 \def\afourwide{{\globaldefs = 1
6407 \internalpagesizes{241mm}{165mm}%
6408 {\voffset}{-2.95mm}%
6409 {\bindingoffset}{7mm}%
6414 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6415 % Perhaps we should allow setting the margins, \topskip, \parskip,
6416 % and/or leading, also. Or perhaps we should compute them somehow.
6418 \def\pagesizes{\parsearg\pagesizesxxx}
6419 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6420 \def\pagesizesyyy#1,#2,#3\finish{{%
6421 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6424 \parskip = 3pt plus 2pt minus 1pt
6425 \setleading{\textleading}%
6428 \advance\dimen0 by \voffset
6431 \advance\dimen2 by \normaloffset
6433 \internalpagesizes{#1}{\hsize}%
6434 {\voffset}{\normaloffset}%
6435 {\bindingoffset}{44pt}%
6439 % Set default to letter.
6444 \message{and turning on texinfo input format.}
6446 % Define macros to output various characters with catcode for normal text.
6456 \def\normaldoublequote{"}
6459 \def\normalunderscore{_}
6460 \def\normalverticalbar{|}
6462 \def\normalgreater{>}
6464 \def\normaldollar{$}%$ font-lock fix
6466 % This macro is used to make a character print one way in ttfont
6467 % where it can probably just be output, and another way in other fonts,
6468 % where something hairier probably needs to be done.
6470 % #1 is what to print if we are indeed using \tt; #2 is what to print
6471 % otherwise. Since all the Computer Modern typewriter fonts have zero
6472 % interword stretch (and shrink), and it is reasonable to expect all
6473 % typewriter fonts to have this, we can check that font parameter.
6475 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6477 % Same as above, but check for italic font. Actually this also catches
6478 % non-italic slanted fonts since it is impossible to distinguish them from
6479 % italic fonts. But since this is only used by $ and it uses \sl anyway
6480 % this is not a problem.
6481 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6483 % Turn off all special characters except @
6484 % (and those which the user can use as if they were ordinary).
6485 % Most of these we simply print from the \tt font, but for some, we can
6486 % use math or other variants that look better in normal text.
6489 \def\activedoublequote{{\tt\char34}}
6490 \let"=\activedoublequote
6492 \def~{{\tt\char126}}
6498 \def_{\ifusingtt\normalunderscore\_}
6499 % Subroutine for the previous macro.
6500 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6503 \def|{{\tt\char124}}
6511 \def+{{\tt \char 43}}
6513 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6515 % Set up an active definition for =, but don't enable it most of the time.
6516 {\catcode`\==\active
6517 \global\def={{\tt \char 61}}}
6522 % If a .fmt file is being used, characters that might appear in a file
6523 % name cannot be active until we have parsed the command line.
6524 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6525 % \otherifyactive is called near the end of this file.
6526 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6530 % \rawbackslashxx outputs one backslash character in current font,
6532 \global\chardef\rawbackslashxx=`\\
6534 % \rawbackslash defines an active \ to do \rawbackslashxx.
6535 % \otherbackslash defines an active \ to be a literal `\' character with
6537 {\catcode`\\=\active
6538 @gdef@rawbackslash{@let\=@rawbackslashxx}
6539 @gdef@otherbackslash{@let\=@realbackslash}
6542 % \realbackslash is an actual character `\' with catcode other.
6543 {\catcode`\\=\other @gdef@realbackslash{\}}
6545 % \normalbackslash outputs one backslash in fixed width font.
6546 \def\normalbackslash{{\tt\rawbackslashxx}}
6550 % Used sometimes to turn off (effectively) the active characters
6551 % even after parsing them.
6552 @def@turnoffactive{%
6553 @let"=@normaldoublequote
6554 @let\=@realbackslash
6557 @let_=@normalunderscore
6558 @let|=@normalverticalbar
6560 @let>=@normalgreater
6562 @let$=@normaldollar %$ font-lock fix
6565 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6566 % the literal character `\'. (Thus, \ is not expandable when this is in
6569 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6571 % Make _ and + \other characters, temporarily.
6572 % This is canceled by @fixbackslash.
6575 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6576 % That is what \eatinput is for; after that, the `\' should revert to printing
6579 @gdef@eatinput input texinfo{@fixbackslash}
6580 @global@let\ = @eatinput
6582 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6583 % the first `\{ in the file would cause an error. This macro tries to fix
6584 % that, assuming it is called before the first `\' could plausibly occur.
6585 % Also back turn on active characters that might appear in the input
6586 % file name, in case not using a pre-dumped format.
6588 @gdef@fixbackslash{%
6589 @ifx\@eatinput @let\ = @normalbackslash @fi
6594 % Say @foo, not \foo, in error messages.
6597 % These look ok in all fonts, so just make them not special.
6598 @catcode`@& = @other
6599 @catcode`@# = @other
6600 @catcode`@% = @other
6602 @c Set initial fonts.
6608 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6609 @c page-delimiter: "^\\\\message"
6610 @c time-stamp-start: "def\\\\texinfoversion{"
6611 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6612 @c time-stamp-end: "}"