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{2002-
06-
07.15}
8 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99,
9 % 2000, 01, 02 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.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://texinfo.org/texinfo/texinfo.tex
35 % ftp://tug.org/tex/texinfo.tex
36 % (and all CTAN mirrors, see http://www.ctan.org),
37 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
39 % The texinfo.tex in any given Texinfo distribution could well be out
40 % of date, so if that's what you're using, please check.
42 % Texinfo has a small home page at http://texinfo.org/ and also
43 % http://www.gnu.org/software/texinfo.
45 % Send bug reports to bug-texinfo@gnu.org. Please include including a
46 % complete document in each bug report with which we can reproduce the
47 % problem. Patches are, of course, greatly appreciated.
49 % To process a Texinfo manual with TeX, it's most reliable to use the
50 % texi2dvi shell script that comes with the distribution. For a simple
51 % manual foo.texi, however, you can get away with this:
56 % dvips foo.dvi -o # or whatever; this makes foo.ps.
57 % The extra TeX runs get the cross-reference information correct.
58 % Sometimes one run after texindex suffices, and sometimes you need more
59 % than two; texi2dvi does it as many times as necessary.
61 % It is possible to adapt texinfo.tex for other languages. You can get
62 % the existing language-specific files from the full Texinfo distribution.
64 \message{Loading texinfo
[version
\texinfoversion]:
}
66 % If in a .fmt file, print the version number
67 % and turn on active characters that we couldn't do earlier because
68 % they might have appeared in the input file name.
69 \everyjob{\message{[Texinfo version
\texinfoversion]}%
70 \catcode`+=
\active \catcode`
\_=
\active}
72 % Save some parts of plain tex whose names we will redefine.
74 \let\ptexbullet=
\bullet
88 % We never want plain's outer \+ definition in Texinfo.
89 % For @tex, we can use \tabalign.
95 % If this character appears in an error message or help string, it
96 % starts a new line in the output.
99 % Set up fixed words for English if not already set.
100 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
101 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
102 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
103 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
104 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
105 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
106 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
107 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
108 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
109 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
110 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
111 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
112 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
113 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
114 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
115 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
116 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
117 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
118 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
120 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
121 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
122 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
123 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
124 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
125 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
126 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
127 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
128 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
129 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
130 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
131 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
133 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
134 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
135 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
136 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
137 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable
}\fi
138 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
139 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function
}\fi
145 \hyphenation{ap-pen-dix
}
146 \hyphenation{mini-buf-fer mini-buf-fers
}
148 \hyphenation{white-space
}
150 % Margin to add to right of even pages, to left of odd pages.
151 \newdimen \bindingoffset
152 \newdimen \normaloffset
153 \newdimen\pagewidth \newdimen\pageheight
155 % Sometimes it is convenient to have everything in the transcript file
156 % and nothing on the terminal. We don't just call \tracingall here,
157 % since that produces some useless output on the terminal.
159 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
160 \ifx\eTeXversion\undefined
161 \def\loggingall{\tracingcommands2 \tracingstats2
162 \tracingpages1 \tracingoutput1 \tracinglostchars1
163 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
164 \showboxbreadth\maxdimen\showboxdepth\maxdimen
167 \def\loggingall{\tracingcommands3 \tracingstats2
168 \tracingpages1 \tracingoutput1 \tracinglostchars1
169 \tracingmacros2 \tracingparagraphs1 \tracingrestores1
170 \tracingscantokens1 \tracingassigns1 \tracingifs1
171 \tracinggroups1 \tracingnesting2
172 \showboxbreadth\maxdimen\showboxdepth\maxdimen
176 % add check for \lastpenalty to plain's definitions. If the last thing
177 % we did was a \nobreak, we don't want to insert more space.
179 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
180 \removelastskip\penalty-
50\smallskip\fi\fi}
181 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
182 \removelastskip\penalty-
100\medskip\fi\fi}
183 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
184 \removelastskip\penalty-
200\bigskip\fi\fi}
186 % For @cropmarks command.
187 % Do @cropmarks to get crop marks.
190 \let\cropmarks =
\cropmarkstrue
192 % Dimensions to add cropmarks at corners.
193 % Added by P. A. MacKay, 12 Nov. 1986
195 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
196 \newdimen\cornerlong \cornerlong=
1pc
197 \newdimen\cornerthick \cornerthick=
.3pt
198 \newdimen\topandbottommargin \topandbottommargin=
.75in
200 % Main output routine.
202 \output =
{\onepageout{\pagecontents\PAGE}}
207 % \onepageout takes a vbox as an argument. Note that \pagecontents
208 % does insertions, but you have to call it yourself.
210 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
212 \ifodd\pageno \advance\hoffset by
\bindingoffset
213 \else \advance\hoffset by -
\bindingoffset\fi
215 % Do this outside of the \shipout so @code etc. will be expanded in
216 % the headline as they should be, not taken literally (outputting ''code).
217 \setbox\headlinebox =
\vbox{\let\hsize=
\pagewidth \makeheadline}%
218 \setbox\footlinebox =
\vbox{\let\hsize=
\pagewidth \makefootline}%
221 % Have to do this stuff outside the \shipout because we want it to
222 % take effect in \write's, yet the group defined by the \vbox ends
223 % before the \shipout runs.
225 \escapechar = `\\
% use backslash in output files.
226 \indexdummies % don't expand commands in the output.
227 \normalturnoffactive % \ in index entries must not stay \, e.g., if
228 % the page break happens to be in the middle of an example.
230 % Do this early so pdf references go to the beginning of the page.
231 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
233 \ifcropmarks \vbox to
\outervsize\bgroup
235 \vskip-
\topandbottommargin
237 \line{\ewtop\hfil\ewtop}%
240 \vbox{\moveleft\cornerthick\nstop}%
242 \vbox{\moveright\cornerthick\nstop}%
245 \vskip\topandbottommargin
247 \hfil % center the page within the outer (page) hsize.
248 \ifodd\pageno\hskip\bindingoffset\fi
254 \ifdim\ht\footlinebox >
0pt
255 % Only leave this space if the footline is nonempty.
256 % (We lessened \vsize for it in \oddfootingxxx.)
257 % The \baselineskip=24pt in plain's \makefootline has no effect.
258 \vskip 2\baselineskip
263 \egroup % end of \vbox\bgroup
264 \hfil\egroup % end of (centering) \line\bgroup
265 \vskip\topandbottommargin plus1fill minus1fill
266 \boxmaxdepth =
\cornerthick
269 \vbox{\moveleft\cornerthick\nsbot}%
271 \vbox{\moveright\cornerthick\nsbot}%
274 \line{\ewbot\hfil\ewbot}%
276 \egroup % \vbox from first cropmarks clause
278 }% end of \shipout\vbox
279 }% end of group with \turnoffactive
281 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
284 \newinsert\margin \dimen\margin=
\maxdimen
286 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
288 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
289 % marginal hacks, juha@viisa.uucp (Juha Takala)
290 \ifvoid\margin\else % marginal info is present
291 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
292 \dimen@=
\dp#1 \unvbox#1
293 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
294 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
297 % Here are the rules for the cropmarks. Note that they are
298 % offset so that the space between them is truly \outerhsize or \outervsize
299 % (P. A. MacKay, 12 November, 1986)
301 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
303 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
304 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
306 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
308 % Parse an argument, then pass it to #1. The argument is the rest of
309 % the input line (except we remove a trailing comment). #1 should be a
310 % macro which expects an ordinary undelimited TeX argument.
316 \futurelet\temp\parseargx
319 % If the next token is an obeyed space (from an @example environment or
320 % the like), remove it and recurse. Otherwise, we're done.
322 % \obeyedspace is defined far below, after the definition of \sepspaces.
323 \ifx\obeyedspace\temp
324 \expandafter\parseargdiscardspace
326 \expandafter\parseargline
330 % Remove a single space (as the delimiter token to the macro call).
332 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
335 \gdef\parseargline#1^^M
{%
336 \endgroup % End of the group started in \parsearg.
338 % First remove any @c comment, then any @comment.
339 % Result of each macro is put in \toks0.
340 \argremovec #1\c\relax %
341 \expandafter\argremovecomment \the\toks0 \comment\relax %
343 % Call the caller's macro, saved as \next in \parsearg.
344 \expandafter\next\expandafter{\the\toks0}%
348 % Since all \c{,omment} does is throw away the argument, we can let TeX
349 % do that for us. The \relax here is matched by the \relax in the call
350 % in \parseargline; it could be more or less anything, its purpose is
351 % just to delimit the argument to the \c.
352 \def\argremovec#1\c#2\relax{\toks0 =
{#1}}
353 \def\argremovecomment#1\comment#2\relax{\toks0 =
{#1}}
355 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
356 % @end itemize @c foo
357 % will have two active spaces as part of the argument with the
358 % `itemize'. Here we remove all active spaces from #1, and assign the
361 % This loses if there are any *other* active characters besides spaces
362 % in the argument -- _ ^ +, for example -- since they get expanded.
363 % Fortunately, Texinfo does not define any such commands. (If it ever
364 % does, the catcode of the characters in questionwill have to be changed
365 % here.) But this means we cannot call \removeactivespaces as part of
366 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
367 % that \parsearg gets might well have any character at all in it.
369 \def\removeactivespaces#1{%
373 \global\toks0 =
\expandafter{\temp}%
377 % Change the active space to expand to nothing.
381 \gdef\ignoreactivespaces{\obeyspaces\let =
\empty}
385 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
387 %% These are used to keep @begin/@end levels from running away
388 %% Call \inENV within environments (after a \begingroup)
389 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
391 \ifENV\errmessage{Still within an environment; press RETURN to continue
}
392 \endgroup\fi} % This is not perfect, but it should reduce lossage
394 % @begin foo is the same as @foo, for now.
395 \newhelp\EMsimple{Press RETURN to continue.
}
397 \outer\def\begin{\parsearg\beginxxx}
400 \expandafter\ifx\csname #1\endcsname\relax
401 {\errhelp=
\EMsimple \errmessage{Undefined command @begin
#1}}\else
402 \csname #1\endcsname\fi}
404 % @end foo executes the definition of \Efoo.
406 \def\end{\parsearg\endxxx}
408 \removeactivespaces{#1}%
409 \edef\endthing{\the\toks0}%
411 \expandafter\ifx\csname E
\endthing\endcsname\relax
412 \expandafter\ifx\csname \endthing\endcsname\relax
413 % There's no \foo, i.e., no ``environment'' foo.
415 \errmessage{Undefined command `@end
\endthing'
}%
417 \unmatchedenderror\endthing
420 % Everything's ok; the right environment has been started.
421 \csname E
\endthing\endcsname
425 % There is an environment #1, but it hasn't been started. Give an error.
427 \def\unmatchedenderror#1{%
429 \errmessage{This `@end
#1' doesn't have a matching `@
#1'
}%
432 % Define the control sequence \E#1 to give an unmatched @end error.
434 \def\defineunmatchedend#1{%
435 \expandafter\def\csname E
#1\endcsname{\unmatchedenderror{#1}}%
439 % Single-spacing is done by various environments (specifically, in
440 % \nonfillstart and \quotations).
441 \newskip\singlespaceskip \singlespaceskip =
12.5pt
443 % Why was this kern here? It messes up equalizing space above and below
444 % environments. --karl, 6may93
445 %{\advance \baselineskip by -\singlespaceskip
446 %\kern \baselineskip}%
447 \setleading\singlespaceskip
450 %% Simple single-character @ commands
453 % Kludge this until the fonts are right (grr).
456 % This is turned off because it was never documented
457 % and you can use @w{...} around a quote to suppress ligatures.
458 %% Define @` and @' to be the same as ` and '
459 %% but suppressing ligatures.
463 % Used to generate quoted braces.
464 \def\mylbrace {{\tt\char123}}
465 \def\myrbrace {{\tt\char125}}
469 % Definitions to produce actual \{ & \} command in an index.
470 \catcode`\
{ =
12 \catcode`\
} =
12
471 \catcode`\
[ =
1 \catcode`\
] =
2
472 \catcode`\@ =
0 \catcode`\\ =
12
477 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
478 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H.
481 \def\ringaccent#1{{\accent23 #1}}
486 % Other special characters: @questiondown @exclamdown
487 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss.
488 \def\questiondown{?`
}
491 % Dotless i and dotless j, used for accents.
496 \ifx\temp\imacro \ptexi
497 \else\ifx\temp\jmacro \j
498 \else \errmessage{@dotless can be used only with i or j
}%
502 % Be sure we're in horizontal mode when doing a tie, since we make space
503 % equivalent to this in @example-like environments. Otherwise, a space
504 % at the beginning of a line will start with \penalty -- and
505 % since \penalty is valid in vertical mode, we'd end up putting the
506 % penalty on the vertical list instead of in the new paragraph.
508 % Avoid using \@M directly, because that causes trouble
509 % if the definition is written into an index file.
510 \global\let\tiepenalty = \@M
511 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
514 % @: forces normal size whitespace following.
515 \def\:
{\spacefactor=
1000 }
517 % @* forces a line break.
518 \def\*
{\hfil\break\hbox{}\ignorespaces}
520 % @. is an end-of-sentence period.
521 \def\.
{.
\spacefactor=
3000 }
523 % @! is an end-of-sentence bang.
524 \def\!
{!
\spacefactor=
3000 }
526 % @? is an end-of-sentence query.
527 \def\?
{?
\spacefactor=
3000 }
529 % @w prevents a word break. Without the \leavevmode, @w at the
530 % beginning of a paragraph, when TeX is still in vertical mode, would
531 % produce a whole line of output instead of starting the paragraph.
532 \def\w#1{\leavevmode\hbox{#1}}
534 % @group ... @end group forces ... to be all on one page, by enclosing
535 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
536 % to keep its height that of a normal line. According to the rules for
537 % \topskip (p.114 of the TeXbook), the glue inserted is
538 % max (\topskip - \ht (first item), 0). If that height is large,
539 % therefore, no glue is inserted, and the space between the headline and
540 % the text is small, which looks bad.
542 \def\group{\begingroup
543 \ifnum\catcode13=
\active \else
544 \errhelp =
\groupinvalidhelp
545 \errmessage{@group invalid in context where filling is enabled
}%
548 % The \vtop we start below produces a box with normal height and large
549 % depth; thus, TeX puts \baselineskip glue before it, and (when the
550 % next line of text is done) \lineskip glue after it. (See p.82 of
551 % the TeXbook.) Thus, space below is not quite equal to space
552 % above. But it's pretty close.
554 \egroup % End the \vtop.
555 \endgroup % End the \group.
559 % We have to put a strut on the last line in case the @group is in
560 % the midst of an example, rather than completely enclosing it.
561 % Otherwise, the interline space between the last line of the group
562 % and the first line afterwards is too small. But we can't put the
563 % strut in \Egroup, since there it would be on a line by itself.
564 % Hence this just inserts a strut at the beginning of each line.
565 \everypar =
{\strut}%
567 % Since we have a strut on every line, we don't need any of TeX's
568 % normal interline spacing.
571 % OK, but now we have to do something about blank
572 % lines in the input in @example-like environments, which normally
573 % just turn into \lisppar, which will insert no space now that we've
574 % turned off the interline space. Simplest is to make them be an
577 \edef\par{\leavevmode \par}%
579 % Reset ^^M's definition to new definition of \par.
583 % Do @comment since we are called inside an environment such as
584 % @example, where each end-of-line in the input causes an
585 % end-of-line in the output. We don't want the end-of-line after
586 % the `@group' to put extra space in the output. Since @group
587 % should appear on a line by itself (according to the Texinfo
588 % manual), we don't worry about eating any user text.
592 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
593 % message, so this ends up printing `@group can only ...'.
595 \newhelp\groupinvalidhelp{%
596 group can only be used in environments such as @example,^^J
%
597 where each line of input produces a line of output.
}
599 % @need space-in-mils
600 % forces a page break if there is not space-in-mils remaining.
602 \newdimen\mil \mil=
0.001in
604 \def\need{\parsearg\needx}
606 % Old definition--didn't work.
607 %\def\needx #1{\par %
608 %% This method tries to make TeX break the page naturally
609 %% if the depth of the box does not fit.
611 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
616 % Ensure vertical mode, so we don't make a big box in the middle of a
620 % If the @need value is less than one line space, it's useless.
622 \dimen2 =
\ht\strutbox
623 \advance\dimen2 by
\dp\strutbox
624 \ifdim\dimen0 >
\dimen2
626 % Do a \strut just to make the height of this box be normal, so the
627 % normal leading is inserted relative to the preceding line.
628 % And a page break here is fine.
629 \vtop to
#1\mil{\strut\vfil}%
631 % TeX does not even consider page breaks if a penalty added to the
632 % main vertical list is 10000 or more. But in order to see if the
633 % empty box we just added fits on the page, we must make it consider
634 % page breaks. On the other hand, we don't want to actually break the
635 % page after the empty box. So we use a penalty of 9999.
637 % There is an extremely small chance that TeX will actually break the
638 % page at this \penalty, if there are no other feasible breakpoints in
639 % sight. (If the user is using lots of big @group commands, which
640 % almost-but-not-quite fill up a page, TeX will have a hard time doing
641 % good page breaking, for example.) However, I could not construct an
642 % example where a page broke at this \penalty; if it happens in a real
643 % document, then we can reconsider our strategy.
646 % Back up by the size of the box, whether we did a page break or not.
649 % Do not allow a page break right after this kern.
654 % @br forces paragraph break
658 % @dots{} output an ellipsis using the current font.
659 % We do .5em per period so that it has the same spacing in a typewriter
660 % font as three actual period characters.
665 \hskip 0pt plus
0.25fil minus
0.25fil
667 \hskip 0pt plus
0.5fil minus
0.5fil
671 % @enddots{} is an end-of-sentence ellipsis.
676 \hskip 0pt plus
0.25fil minus
0.25fil
678 \hskip 0pt plus
0.5fil minus
0.5fil
684 % @page forces the start of a new page
686 \def\page{\par\vfill\supereject}
689 % outputs text on separate line in roman font, starting at standard page margin
691 % This records the amount of indent in the innermost environment.
692 % That's how much \exdent should take out.
693 \newskip\exdentamount
695 % This defn is used inside fill environments such as @defun.
696 \def\exdent{\parsearg\exdentyyy}
697 \def\exdentyyy #1{{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}}
699 % This defn is used inside nofill environments such as @example.
700 \def\nofillexdent{\parsearg\nofillexdentyyy}
701 \def\nofillexdentyyy #1{{\advance \leftskip by -
\exdentamount
702 \leftline{\hskip\leftskip{\rm#1}}}}
704 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
705 % paragraph. For more general purposes, use the \margin insertion
706 % class. WHICH is `l' or `r'.
708 \newskip\inmarginspacing \inmarginspacing=
1cm
709 \def\strutdepth{\dp\strutbox}
711 \def\doinmargin#1#2{\strut\vadjust{%
714 \vtop to
\strutdepth{%
715 \baselineskip=
\strutdepth
717 % if you have multiple lines of stuff to put here, you'll need to
718 % make the vbox yourself of the appropriate size.
720 \llap{\ignorespaces #2\hskip\inmarginspacing}%
722 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
727 \def\inleftmargin{\doinmargin l
}
728 \def\inrightmargin{\doinmargin r
}
730 % @inmargin{TEXT [, RIGHT-TEXT]}
731 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
732 % else use TEXT for both).
734 \def\inmargin#1{\parseinmargin #1,,
\finish}
735 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
736 \setbox0 =
\hbox{\ignorespaces #2}%
738 \def\lefttext{#1}% have both texts
741 \def\lefttext{#1}% have only one text
746 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
748 \def\temp{\inleftmargin\lefttext}%
753 % @include file insert text of that file as input.
754 % Allow normal characters that we make active in the argument (a file name).
755 \def\include{\begingroup
764 \parsearg\includezzz}
765 % Restore active chars for included file.
766 \def\includezzz#1{\endgroup\begingroup
767 % Read the included file in a group so nested @include's work.
774 % @center line outputs that line, centered
776 \def\center{\parsearg\centerzzz}
777 \def\centerzzz #1{{\advance\hsize by -
\leftskip
778 \advance\hsize by -
\rightskip
781 % @sp n outputs n lines of vertical space
783 \def\sp{\parsearg\spxxx}
784 \def\spxxx #1{\vskip #1\baselineskip}
786 % @comment ...line which is ignored...
787 % @c is the same as @comment
788 % @ignore ... @end ignore is another way to write a comment
790 \def\comment{\begingroup \catcode`\^^M=
\other%
791 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
793 {\catcode`\^^M=
\other \gdef\commentxxx#1^^M
{\endgroup}}
797 % @paragraphindent NCHARS
798 % We'll use ems for NCHARS, close enough.
799 % We cannot implement @paragraphindent asis, though.
801 \def\asisword{asis
} % no translation, these are keywords
804 \def\paragraphindent{\parsearg\doparagraphindent}
805 \def\doparagraphindent#1{%
810 \defaultparindent =
0pt
812 \defaultparindent =
#1em
815 \parindent =
\defaultparindent
818 % @exampleindent NCHARS
819 % We'll use ems for NCHARS like @paragraphindent.
820 % It seems @exampleindent asis isn't necessary, but
821 % I preserve it to make it similar to @paragraphindent.
822 \def\exampleindent{\parsearg\doexampleindent}
823 \def\doexampleindent#1{%
830 \lispnarrowing =
#1em
835 % @asis just yields its argument. Used with @table, for example.
839 % @math outputs its argument in math mode.
840 % We don't use $'s directly in the definition of \math because we need
841 % to set catcodes according to plain TeX first, to allow for subscripts,
842 % superscripts, special math chars, etc.
844 % @math does not do math typesetting in section titles, index
845 % entries, and other such contexts where the catcodes are set before
846 % @math gets a chance to work. This could perhaps be fixed, but for now
847 % at least we can have real math in the main text, where it's needed most.
849 \let\implicitmath = $
%$ font-lock fix
851 % One complication: _ usually means subscripts, but it could also mean
852 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
853 % _ within @math be active (mathcode "8000), and distinguish by seeing
854 % if the current family is \slfam, which is what @var uses.
856 {\catcode95 =
\active % 95 = _
857 \gdef\mathunderscore{%
859 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
862 % Another complication: we want \\ (and @\) to output a \ character.
863 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
864 % this is not advertised and we don't care. Texinfo does not
865 % otherwise define @\.
867 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
868 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
872 \mathcode`
\_="
8000 \mathunderscore
873 \let\\ =
\mathbackslash
874 \implicitmath\finishmath}
875 \def\finishmath#1{#1\implicitmath\Etex}
877 % @bullet and @minus need the same treatment as @math, just above.
878 \def\bullet{\implicitmath\ptexbullet\implicitmath}
879 \def\minus{\implicitmath-
\implicitmath}
881 % @refill is a no-op.
884 % If working on a large document in chapters, it is convenient to
885 % be able to disable indexing, cross-referencing, and contents, for test runs.
886 % This is done with @novalidate (before @setfilename).
888 \newif\iflinks \linkstrue % by default we want the aux files.
889 \let\novalidate =
\linksfalse
891 % @setfilename is done at the beginning of every texinfo file.
892 % So open here the files we need to have open while reading the input.
893 % This makes it possible to make a .fmt file for texinfo.
897 \fi % \openindices needs to do some work in any case.
899 \fixbackslash % Turn off hack to swallow `\input texinfo'.
900 \global\let\setfilename=
\comment % Ignore extra @setfilename cmds.
902 % If texinfo.cnf is present on the system, read it.
903 % Useful for site-wide @afourpaper, etc.
904 % Just to be on the safe side, close the input stream before the \input.
905 \openin 1 texinfo.cnf
906 \ifeof1 \let\temp=
\relax \else \def\temp{\input texinfo.cnf
}\fi
910 \comment % Ignore the actual filename.
913 % Called from \setfilename.
925 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
929 % adobe `portable' document format
933 \newcount\filenamelength
942 \newif\ifpdfmakepagedest
944 \ifx\pdfoutput\undefined
946 \let\pdfmkdest =
\gobble
947 \let\pdfurl =
\gobble
948 \let\endlink =
\relax
949 \let\linkcolor =
\relax
950 \let\pdfmakeoutlines =
\relax
955 \def\dopdfimage#1#2#3{%
957 \def\imageheight{#3}%
958 % without \immediate, pdftex seg faults when the same image is
959 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
960 \ifnum\pdftexversion <
14
965 \ifx\empty\imagewidth\else width
\imagewidth \fi
966 \ifx\empty\imageheight\else height
\imageheight \fi
967 \ifnum\pdftexversion<
13
972 \ifnum\pdftexversion <
14 \else
973 \pdfrefximage \pdflastximage
975 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name
{#1} xyz
}}
977 \let\linkcolor =
\Blue % was Cyan, but that seems light?
978 \def\endlink{\Black\pdfendlink}
979 % Adding outlines to PDF; macros for calculating structure of outlines
980 % come from Petr Olsak
981 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
982 \else \csname#1\endcsname \fi}
983 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
985 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
986 \def\pdfmakeoutlines{{%
987 \openin 1 \jobname.toc
988 \ifeof 1\else\begingroup
992 \let\_ =
\normalunderscore
993 % Thanh's hack / proper braces in bookmarks
994 \edef\mylbrace{\iftrue \string{\else}\fi}\let\
{=
\mylbrace
995 \edef\myrbrace{\iffalse{\else\string}\fi}\let\
}=
\myrbrace
997 \def\chapentry #
#1#
#2#
#3{}
998 \let\appendixentry =
\chapentry
999 \def\unnumbchapentry #
#1#
#2{}
1000 \def\secentry #
#1#
#2#
#3#
#4{\advancenumber{chap#
#2}}
1001 \def\unnumbsecentry #
#1#
#2#
#3{\advancenumber{chap#
#2}}
1002 \def\subsecentry #
#1#
#2#
#3#
#4#
#5{\advancenumber{sec#
#2.#
#3}}
1003 \def\unnumbsubsecentry #
#1#
#2#
#3#
#4{\advancenumber{sec#
#2.#
#3}}
1004 \def\subsubsecentry #
#1#
#2#
#3#
#4#
#5#
#6{\advancenumber{subsec#
#2.#
#3.#
#4}}
1005 \def\unnumbsubsubsecentry #
#1#
#2#
#3#
#4#
#5{\advancenumber{subsec#
#2.#
#3.#
#4}}
1007 \def\chapentry #
#1#
#2#
#3{%
1008 \pdfoutline goto name
{\pdfmkpgn{#
#3}}count-
\expnumber{chap#
#2}{#
#1}}
1009 \let\appendixentry =
\chapentry
1010 \def\unnumbchapentry #
#1#
#2{%
1011 \pdfoutline goto name
{\pdfmkpgn{#
#2}}{#
#1}}
1012 \def\secentry #
#1#
#2#
#3#
#4{%
1013 \pdfoutline goto name
{\pdfmkpgn{#
#4}}count-
\expnumber{sec#
#2.#
#3}{#
#1}}
1014 \def\unnumbsecentry #
#1#
#2#
#3{%
1015 \pdfoutline goto name
{\pdfmkpgn{#
#3}}{#
#1}}
1016 \def\subsecentry #
#1#
#2#
#3#
#4#
#5{%
1017 \pdfoutline goto name
{\pdfmkpgn{#
#5}}count-
\expnumber{subsec#
#2.#
#3.#
#4}{#
#1}}
1018 \def\unnumbsubsecentry #
#1#
#2#
#3#
#4{%
1019 \pdfoutline goto name
{\pdfmkpgn{#
#4}}{#
#1}}
1020 \def\subsubsecentry #
#1#
#2#
#3#
#4#
#5#
#6{%
1021 \pdfoutline goto name
{\pdfmkpgn{#
#6}}{#
#1}}
1022 \def\unnumbsubsubsecentry #
#1#
#2#
#3#
#4#
#5{%
1023 \pdfoutline goto name
{\pdfmkpgn{#
#5}}{#
#1}}
1027 \def\makelinks #1,
{%
1028 \def\params{#1}\def\E{END
}%
1030 \let\nextmakelinks=
\relax
1032 \let\nextmakelinks=
\makelinks
1033 \ifnum\lnkcount>
0,
\fi
1035 \startlink attr
{/Border
[0 0 0]}
1036 goto name
{\pdfmkpgn{\the\pgn}}%
1038 \advance\lnkcount by
1%
1043 \def\picknum#1{\expandafter\pn#1}
1054 \def\ppn#1{\pgn=
#1\gobble}
1055 \def\ppnn{\pgn=
\first}
1056 \def\pdfmklnk#1{\lnkcount=
0\makelinks #1,END,
}
1057 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1058 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1059 \ifx\PP\D\let\nextsp\relax
1060 \else\let\nextsp\skipspaces
1061 \ifx\p\space\else\addtokens{\filename}{\PP}%
1062 \advance\filenamelength by
1
1066 \def\getfilename#1{\filenamelength=
0\expandafter\skipspaces#1|
\relax}
1067 \ifnum\pdftexversion <
14
1068 \let \startlink \pdfannotlink
1070 \let \startlink \pdfstartlink
1074 \normalturnoffactive\def\@
{@
}%
1075 \let\value=
\expandablevalue
1077 \startlink attr
{/Border
[0 0 0]}%
1078 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1081 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1082 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1083 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1084 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1086 \expandafter\poptoks\the\toksA|ENDTOKS|
1088 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1089 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1090 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1092 \ifnum0=
\countA\else\makelink\fi
1093 \ifx\first.
\let\next=
\done\else
1095 \addtokens{\toksB}{\the\toksD}
1096 \ifx\first,
\addtokens{\toksB}{\space}\fi
1098 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1100 \def\makelink{\addtokens{\toksB}%
1101 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1103 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1104 \linkcolor #1\endlink}
1105 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1106 \fi % \ifx\pdfoutput
1110 % Font-change commands.
1112 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1113 % So we set up a \sf analogous to plain's \rm, etc.
1115 \def\sf{\fam=
\sffam \tensf}
1116 \let\li =
\sf % Sometimes we call it \li, not \sf.
1118 % We don't need math for this one.
1122 \newdimen\textleading \textleading =
13.2pt
1124 % Set the baselineskip to #1, and the lineskip and strut size
1125 % correspondingly. There is no deep meaning behind these magic numbers
1126 % used as factors; they just match (closely enough) what Knuth defined.
1128 \def\lineskipfactor{.08333}
1129 \def\strutheightpercent{.70833}
1130 \def\strutdepthpercent {.29167}
1133 \normalbaselineskip =
#1\relax
1134 \normallineskip =
\lineskipfactor\normalbaselineskip
1136 \setbox\strutbox =
\hbox{%
1137 \vrule width0pt height
\strutheightpercent\baselineskip
1138 depth
\strutdepthpercent \baselineskip
1142 % Set the font macro #1 to the font named #2, adding on the
1143 % specified font prefix (normally `cm').
1144 % #3 is the font's design size, #4 is a scale factor
1145 \def\setfont#1#2#3#4{\font#1=
\fontprefix#2#3 scaled
#4}
1147 % Use cm as the default font prefix.
1148 % To specify the font prefix, you must define \fontprefix
1149 % before you read in texinfo.tex.
1150 \ifx\fontprefix\undefined
1153 % Support font families that don't use the same naming scheme as CM.
1155 \def\rmbshape{bx
} %where the normal face is bold
1160 \def\ttslshape{sltt
}
1170 \newcount\mainmagstep
1172 % not really supported.
1173 \let\mainmagstep=
\magstep1
1174 \setfont\textrm\rmshape{12}{1000}
1175 \setfont\texttt\ttshape{12}{1000}
1177 % \mainmagstep=\magstephalf
1178 \mainmagstep=
\magstep1
1179 \setfont\textrm\rmshape{10}{\mainmagstep}
1180 \setfont\texttt\ttshape{10}{\mainmagstep}
1182 % Instead of cmb10, you many want to use cmbx10.
1183 % cmbx10 is a prettier font on its own, but cmb10
1184 % looks better when embedded in a line with cmr10.
1185 \setfont\textbf\bfshape{10}{\mainmagstep}
1186 \setfont\textit\itshape{10}{\mainmagstep}
1187 \setfont\textsl\slshape{10}{\mainmagstep}
1188 \setfont\textsf\sfshape{10}{\mainmagstep}
1189 \setfont\textsc\scshape{10}{\mainmagstep}
1190 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1191 \font\texti=cmmi10 scaled
\mainmagstep
1192 \font\textsy=cmsy10 scaled
\mainmagstep
1194 % A few fonts for @defun, etc.
1195 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1196 \setfont\deftt\ttshape{10}{\magstep1}
1197 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \bf}
1199 % Fonts for indices, footnotes, small examples (9pt).
1200 \setfont\smallrm\rmshape{9}{1000}
1201 \setfont\smalltt\ttshape{9}{1000}
1202 \setfont\smallbf\bfshape{10}{900}
1203 \setfont\smallit\itshape{9}{1000}
1204 \setfont\smallsl\slshape{9}{1000}
1205 \setfont\smallsf\sfshape{9}{1000}
1206 \setfont\smallsc\scshape{10}{900}
1207 \setfont\smallttsl\ttslshape{10}{900}
1211 % Fonts for small examples (8pt).
1212 \setfont\smallerrm\rmshape{8}{1000}
1213 \setfont\smallertt\ttshape{8}{1000}
1214 \setfont\smallerbf\bfshape{10}{800}
1215 \setfont\smallerit\itshape{8}{1000}
1216 \setfont\smallersl\slshape{8}{1000}
1217 \setfont\smallersf\sfshape{8}{1000}
1218 \setfont\smallersc\scshape{10}{800}
1219 \setfont\smallerttsl\ttslshape{10}{800}
1220 \font\smalleri=cmmi8
1221 \font\smallersy=cmsy8
1223 % Fonts for title page:
1224 \setfont\titlerm\rmbshape{12}{\magstep3}
1225 \setfont\titleit\itbshape{10}{\magstep4}
1226 \setfont\titlesl\slbshape{10}{\magstep4}
1227 \setfont\titlett\ttbshape{12}{\magstep3}
1228 \setfont\titlettsl\ttslshape{10}{\magstep4}
1229 \setfont\titlesf\sfbshape{17}{\magstep1}
1230 \let\titlebf=
\titlerm
1231 \setfont\titlesc\scbshape{10}{\magstep4}
1232 \font\titlei=cmmi12 scaled
\magstep3
1233 \font\titlesy=cmsy10 scaled
\magstep4
1234 \def\authorrm{\secrm}
1236 % Chapter (and unnumbered) fonts (17.28pt).
1237 \setfont\chaprm\rmbshape{12}{\magstep2}
1238 \setfont\chapit\itbshape{10}{\magstep3}
1239 \setfont\chapsl\slbshape{10}{\magstep3}
1240 \setfont\chaptt\ttbshape{12}{\magstep2}
1241 \setfont\chapttsl\ttslshape{10}{\magstep3}
1242 \setfont\chapsf\sfbshape{17}{1000}
1244 \setfont\chapsc\scbshape{10}{\magstep3}
1245 \font\chapi=cmmi12 scaled
\magstep2
1246 \font\chapsy=cmsy10 scaled
\magstep3
1248 % Section fonts (14.4pt).
1249 \setfont\secrm\rmbshape{12}{\magstep1}
1250 \setfont\secit\itbshape{10}{\magstep2}
1251 \setfont\secsl\slbshape{10}{\magstep2}
1252 \setfont\sectt\ttbshape{12}{\magstep1}
1253 \setfont\secttsl\ttslshape{10}{\magstep2}
1254 \setfont\secsf\sfbshape{12}{\magstep1}
1256 \setfont\secsc\scbshape{10}{\magstep2}
1257 \font\seci=cmmi12 scaled
\magstep1
1258 \font\secsy=cmsy10 scaled
\magstep2
1260 % Subsection fonts (13.15pt).
1261 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1262 \setfont\ssecit\itbshape{10}{1315}
1263 \setfont\ssecsl\slbshape{10}{1315}
1264 \setfont\ssectt\ttbshape{12}{\magstephalf}
1265 \setfont\ssecttsl\ttslshape{10}{1315}
1266 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1268 \setfont\ssecsc\scbshape{10}{\magstep1}
1269 \font\sseci=cmmi12 scaled
\magstephalf
1270 \font\ssecsy=cmsy10 scaled
1315
1271 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1272 % but that is not a standard magnification.
1274 % In order for the font changes to affect most math symbols and letters,
1275 % we have to define the \textfont of the standard families. Since
1276 % texinfo doesn't allow for producing subscripts and superscripts except
1277 % in the main text, we don't bother to reset \scriptfont and
1278 % \scriptscriptfont (which would also require loading a lot more fonts).
1280 \def\resetmathfonts{%
1281 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
1282 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
1283 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
1286 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1287 % of just \STYLE. We do this so that font changes will continue to work
1288 % in math mode, where it is the current \fam that is relevant in most
1289 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1290 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1291 % redefine \bf itself.
1293 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
1294 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
1295 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy \let\tenttsl=
\textttsl
1296 \resetmathfonts \setleading{\textleading}}
1298 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
1299 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
1300 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
1301 \let\tenttsl=
\titlettsl
1302 \resetmathfonts \setleading{25pt
}}
1303 \def\titlefont#1{{\titlefonts\rm #1}}
1305 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
1306 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
1307 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy \let\tenttsl=
\chapttsl
1308 \resetmathfonts \setleading{19pt
}}
1310 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
1311 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
1312 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy \let\tenttsl=
\secttsl
1313 \resetmathfonts \setleading{16pt
}}
1315 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
1316 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
1317 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy \let\tenttsl=
\ssecttsl
1318 \resetmathfonts \setleading{15pt
}}
1319 \let\subsubsecfonts =
\subsecfonts % Maybe make sssec fonts scaled magstephalf?
1321 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
1322 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
1323 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
1324 \let\tenttsl=
\smallttsl
1325 \resetmathfonts \setleading{10.5pt
}}
1327 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
1328 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
1329 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
1330 \let\tenttsl=
\smallerttsl
1331 \resetmathfonts \setleading{9.5pt
}}
1332 \let\smallexamplefonts =
\smallerfonts
1334 % Set up the default fonts, so we can use them for creating boxes.
1338 % Define these so they can be easily changed for other fonts.
1339 \def\angleleft{$
\langle$
}
1340 \def\angleright{$
\rangle$
}
1342 % Count depth in font-changes, for error checks
1343 \newcount\fontdepth \fontdepth=
0
1345 % Fonts for short table of contents.
1346 \setfont\shortcontrm\rmshape{12}{1000}
1347 \setfont\shortcontbf\bxshape{12}{1000}
1348 \setfont\shortcontsl\slshape{12}{1000}
1350 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1351 %% serif) and @ii for TeX italic
1353 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1354 % unless the following character is such as not to need one.
1355 \def\smartitalicx{\ifx\next,
\else\ifx\next-
\else\ifx\next.
\else\/
\fi\fi\fi}
1356 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx}
1357 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx}
1360 \let\var=
\smartslanted
1361 \let\dfn=
\smartslanted
1362 \let\emph=
\smartitalic
1363 \let\cite=
\smartslanted
1368 % We can't just use \exhyphenpenalty, because that only has effect at
1369 % the end of a paragraph. Restore normal hyphenation at the end of the
1370 % group within which \nohyphenation is presumably called.
1372 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
1373 \def\restorehyphenation{\hyphenchar\font = `-
}
1376 {\tt \rawbackslash \frenchspacing #1}%
1380 \def\samp#1{`
\tclose{#1}'
\null}
1381 \setfont\keyrm\rmshape{8}{1000}
1383 \def\key#1{{\keyrm\textfont2=
\keysy \leavevmode\hbox{%
1384 \raise0.4pt
\hbox{\angleleft}\kern-
.08em
\vtop{%
1385 \vbox{\hrule\kern-
0.4pt
1386 \hbox{\raise0.4pt
\hbox{\vphantom{\angleleft}}#1}}%
1388 \kern-
.06em
\raise0.4pt
\hbox{\angleright}}}}
1389 % The old definition, with no lozenge:
1390 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1391 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1393 % @file, @option are the same as @samp.
1397 % @code is a modification of @t,
1398 % which makes spaces the same size as normal in the surrounding text.
1401 % Change normal interword space to be same as for the current font.
1402 \spaceskip =
\fontdimen2\font
1404 % Switch to typewriter.
1407 % But `\ ' produces the large typewriter interword space.
1408 \def\
{{\spaceskip =
0pt
{} }}%
1410 % Turn off hyphenation.
1420 % We *must* turn on hyphenation at `-' and `_' in \code.
1421 % Otherwise, it is too hard to avoid overfull hboxes
1422 % in the Emacs manual, the Library manual, etc.
1424 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1425 % both hyphenation at - and hyphenation within words.
1426 % We must therefore turn them both off (\tclose does that)
1427 % and arrange explicitly to hyphenate at a dash.
1433 \global\def\code{\begingroup
1434 \catcode`\-=
\active \let-
\codedash
1435 \catcode`
\_=
\active \let_\codeunder
1439 % If we end up with any active - characters when handling the index,
1440 % just treat them as a normal -.
1441 \global\def\indexbreaks{\catcode`\-=
\active \let-
\realdash}
1445 \def\codedash{-
\discretionary{}{}{}}
1447 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1448 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1449 % will therefore expand the active definition of _, which is us
1450 % (inside @code that is), therefore an endless loop.
1452 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1453 \else\normalunderscore \fi
1454 \discretionary{}{}{}}%
1457 \def\codex #1{\tclose{#1}\endgroup}
1459 % @kbd is like @code, except that if the argument is just one @key command,
1460 % then @kbd has no effect.
1462 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1463 % `example' (@kbd uses ttsl only inside of @example and friends),
1464 % or `code' (@kbd uses normal tty font always).
1465 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1466 \def\kbdinputstylexxx#1{%
1468 \ifx\arg\worddistinct
1469 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1470 \else\ifx\arg\wordexample
1471 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1472 \else\ifx\arg\wordcode
1473 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1476 \def\worddistinct{distinct
}
1477 \def\wordexample{example
}
1480 % Default is kbdinputdistinct. (Too much of a hassle to call the macro,
1481 % the catcodes are wrong for parsearg to work.)
1482 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1485 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??
}%
1486 \ifx\one\xkey\ifx\threex\three \key{#2}%
1487 \else{\tclose{\kbdfont\look}}\fi
1488 \else{\tclose{\kbdfont\look}}\fi}
1490 % For @url, @env, @command quotes seem unnecessary, so use \code.
1495 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1496 % second argument specifying the text to display and an optional third
1497 % arg as text to display instead of (rather than in addition to) the url
1498 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1499 % a hypertex \special here.
1501 \def\uref#1{\douref #1,,,
\finish}
1502 \def\douref#1,
#2,
#3,
#4\finish{\begingroup
1505 \setbox0 =
\hbox{\ignorespaces #3}%
1507 \unhbox0 % third arg given, show only that
1509 \setbox0 =
\hbox{\ignorespaces #2}%
1512 \unhbox0 % PDF: 2nd arg given, show only it
1514 \unhbox0\ (
\code{#1})
% DVI: 2nd arg given, show both it and url
1517 \code{#1}% only url given, so show it
1523 % rms does not like angle brackets --karl, 17may97.
1524 % So now @email is just like @uref, unless we are pdf.
1526 %\def\email#1{\angleleft{\tt #1}\angleright}
1528 \def\email#1{\doemail#1,,
\finish}
1529 \def\doemail#1,
#2,
#3\finish{\begingroup
1532 \setbox0 =
\hbox{\ignorespaces #2}%
1533 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
1540 % Check if we are currently using a typewriter font. Since all the
1541 % Computer Modern typewriter fonts have zero interword stretch (and
1542 % shrink), and it is reasonable to expect all typewriter fonts to have
1543 % this property, we can check that font parameter.
1545 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
1547 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1548 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1550 \def\dmn#1{\thinspace #1}
1552 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??
\par}
1554 % @l was never documented to mean ``switch to the Lisp font'',
1555 % and it is not used as such in any manual I can find. We need it for
1556 % Polish suppressed-l. --karl, 22sep96.
1557 %\def\l#1{{\li #1}\null}
1559 % Explicit font changes: @r, @sc, undocumented @ii.
1560 \def\r#1{{\rm #1}} % roman font
1561 \def\sc#1{{\smallcaps#1}} % smallcaps font
1562 \def\ii#1{{\it #1}} % italic font
1564 % @acronym downcases the argument and prints in smallcaps.
1565 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1567 % @pounds{} is a sterling sign.
1568 \def\pounds{{\it\$
}}
1571 \message{page headings,
}
1573 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
1574 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
1576 % First the title page. Must do @settitle before @titlepage.
1578 \newif\iffinishedtitlepage
1580 % Do an implicit @contents or @shortcontents after @end titlepage if the
1581 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1583 \newif\ifsetcontentsaftertitlepage
1584 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
1585 \newif\ifsetshortcontentsaftertitlepage
1586 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
1588 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1589 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
1590 \endgroup\page\hbox{}\page}
1592 \def\titlepage{\begingroup \parindent=
0pt
\textfonts
1593 \let\subtitlerm=
\tenrm
1594 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}%
1596 \def\authorfont{\authorrm \normalbaselineskip =
16pt
\normalbaselines}%
1598 % Leave some space at the very top of the page.
1599 \vglue\titlepagetopglue
1601 % Now you can print the title using @title.
1602 \def\title{\parsearg\titlezzz}%
1603 \def\titlezzz#
#1{\leftline{\titlefonts\rm #
#1}
1604 % print a rule at the page bottom also.
1605 \finishedtitlepagefalse
1606 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt}%
1607 % No rule at page bottom unless we print one at the top with @title.
1608 \finishedtitlepagetrue
1610 % Now you can put text using @subtitle.
1611 \def\subtitle{\parsearg\subtitlezzz}%
1612 \def\subtitlezzz#
#1{{\subtitlefont \rightline{#
#1}}}%
1614 % @author should come last, but may come many times.
1615 \def\author{\parsearg\authorzzz}%
1616 \def\authorzzz#
#1{\ifseenauthor\else\vskip 0pt plus
1filll
\seenauthortrue\fi
1617 {\authorfont \leftline{#
#1}}}%
1619 % Most title ``pages'' are actually two pages long, with space
1620 % at the top of the second. We don't want the ragged left on the second.
1621 \let\oldpage =
\page
1623 \iffinishedtitlepage\else
1627 \let\page =
\oldpage
1629 % \def\page{\oldpage \hbox{}}
1633 \iffinishedtitlepage\else
1636 % It is important to do the page break before ending the group,
1637 % because the headline and footline are only empty inside the group.
1638 % If we use the new definition of \page, we always get a blank page
1639 % after the title page, which we certainly don't want.
1643 % Need this before the \...aftertitlepage checks so that if they are
1644 % in effect the toc pages will come out with page numbers.
1647 % If they want short, they certainly want long too.
1648 \ifsetshortcontentsaftertitlepage
1651 \global\let\shortcontents =
\relax
1652 \global\let\contents =
\relax
1655 \ifsetcontentsaftertitlepage
1657 \global\let\contents =
\relax
1658 \global\let\shortcontents =
\relax
1662 \def\finishtitlepage{%
1663 \vskip4pt \hrule height
2pt width
\hsize
1664 \vskip\titlepagebottomglue
1665 \finishedtitlepagetrue
1668 %%% Set up page headings and footings.
1670 \let\thispage=
\folio
1672 \newtoks\evenheadline % headline on even pages
1673 \newtoks\oddheadline % headline on odd pages
1674 \newtoks\evenfootline % footline on even pages
1675 \newtoks\oddfootline % footline on odd pages
1677 % Now make Tex use those variables
1678 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
1679 \else \the\evenheadline \fi}}
1680 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
1681 \else \the\evenfootline \fi}\HEADINGShook}
1682 \let\HEADINGShook=
\relax
1684 % Commands to set those variables.
1685 % For example, this is what @headings on does
1686 % @evenheading @thistitle|@thispage|@thischapter
1687 % @oddheading @thischapter|@thispage|@thistitle
1688 % @evenfooting @thisfile||
1689 % @oddfooting ||@thisfile
1691 \def\evenheading{\parsearg\evenheadingxxx}
1692 \def\oddheading{\parsearg\oddheadingxxx}
1693 \def\everyheading{\parsearg\everyheadingxxx}
1695 \def\evenfooting{\parsearg\evenfootingxxx}
1696 \def\oddfooting{\parsearg\oddfootingxxx}
1697 \def\everyfooting{\parsearg\everyfootingxxx}
1701 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|
\finish}
1702 \gdef\evenheadingyyy #1@|
#2@|
#3@|
#4\finish{%
1703 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1705 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|
\finish}
1706 \gdef\oddheadingyyy #1@|
#2@|
#3@|
#4\finish{%
1707 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1709 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1711 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|
\finish}
1712 \gdef\evenfootingyyy #1@|
#2@|
#3@|
#4\finish{%
1713 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1715 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|
\finish}
1716 \gdef\oddfootingyyy #1@|
#2@|
#3@|
#4\finish{%
1717 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1719 % Leave some space for the footline. Hopefully ok to assume
1720 % @evenfooting will not be used by itself.
1721 \global\advance\pageheight by -
\baselineskip
1722 \global\advance\vsize by -
\baselineskip
1725 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1727 }% unbind the catcode of @.
1729 % @headings double turns headings on for double-sided printing.
1730 % @headings single turns headings on for single-sided printing.
1731 % @headings off turns them off.
1732 % @headings on same as @headings double, retained for compatibility.
1733 % @headings after turns on double-sided headings after this page.
1734 % @headings doubleafter turns on double-sided headings after this page.
1735 % @headings singleafter turns on single-sided headings after this page.
1736 % By default, they are off at the start of a document,
1737 % and turned `on' after @end titlepage.
1739 \def\headings #1 {\csname HEADINGS
#1\endcsname}
1742 \global\evenheadline=
{\hfil} \global\evenfootline=
{\hfil}
1743 \global\oddheadline=
{\hfil} \global\oddfootline=
{\hfil}}
1745 % When we turn headings on, set the page number to 1.
1746 % For double-sided printing, put current file name in lower left corner,
1747 % chapter name on inside top of right hand pages, document
1748 % title on inside top of left hand pages, and page numbers on outside top
1749 % edge of all pages.
1750 \def\HEADINGSdouble{
1752 \global\evenfootline=
{\hfil}
1753 \global\oddfootline=
{\hfil}
1754 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
1755 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1756 \global\let\contentsalignmacro =
\chapoddpage
1758 \let\contentsalignmacro =
\chappager
1760 % For single-sided printing, chapter title goes across top left of page,
1761 % page number on top right.
1762 \def\HEADINGSsingle{
1764 \global\evenfootline=
{\hfil}
1765 \global\oddfootline=
{\hfil}
1766 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
1767 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1768 \global\let\contentsalignmacro =
\chappager
1770 \def\HEADINGSon{\HEADINGSdouble}
1772 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
1773 \let\HEADINGSdoubleafter=
\HEADINGSafter
1774 \def\HEADINGSdoublex{%
1775 \global\evenfootline=
{\hfil}
1776 \global\oddfootline=
{\hfil}
1777 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
1778 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1779 \global\let\contentsalignmacro =
\chapoddpage
1782 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
1783 \def\HEADINGSsinglex{%
1784 \global\evenfootline=
{\hfil}
1785 \global\oddfootline=
{\hfil}
1786 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
1787 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
1788 \global\let\contentsalignmacro =
\chappager
1791 % Subroutines used in generating headings
1792 % This produces Day Month Year style of output.
1793 % Only define if not already defined, in case a txi-??.tex file has set
1794 % up a different format (e.g., txi-cs.tex does this).
1795 \ifx\today\undefined
1799 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1800 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1801 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1806 % @settitle line... specifies the title of the document, for headings.
1807 % It generates no output of its own.
1808 \def\thistitle{\putwordNoTitle}
1809 \def\settitle{\parsearg\settitlezzz}
1810 \def\settitlezzz #1{\gdef\thistitle{#1}}
1814 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1816 % default indentation of table text
1817 \newdimen\tableindent \tableindent=
.8in
1818 % default indentation of @itemize and @enumerate text
1819 \newdimen\itemindent \itemindent=
.3in
1820 % margin between end of table item and start of table text.
1821 \newdimen\itemmargin \itemmargin=
.1in
1823 % used internally for \itemindent minus \itemmargin
1826 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1828 % They also define \itemindex
1829 % to index the item name in whatever manner is desired (perhaps none).
1831 \newif\ifitemxneedsnegativevskip
1833 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
1835 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1836 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1838 \def\internalBxitem "
#1"
{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1839 \def\internalBxitemx "
#1"
{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1841 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1842 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1844 \def\kitemzzz #1{\dosubind {kw
}{\code{#1}}{for
{\bf \lastfunction}}%
1847 \def\xitemzzz #1{\dosubind {kw
}{\code{#1}}{for
{\bf \xitemsubtopic}}%
1850 \def\itemzzz #1{\begingroup %
1851 \advance\hsize by -
\rightskip
1852 \advance\hsize by -
\tableindent
1853 \setbox0=
\hbox{\itemfont{#1}}%
1855 \nobreak % This prevents a break before @itemx.
1857 % If the item text does not fit in the space we have, put it on a line
1858 % by itself, and do not allow a page break either before or after that
1859 % line. We do not start a paragraph here because then if the next
1860 % command is, e.g., @kindex, the whatsit would get put into the
1861 % horizontal list on a line by itself, resulting in extra blank space.
1862 \ifdim \wd0>
\itemmax
1864 % Make this a paragraph so we get the \parskip glue and wrapping,
1865 % but leave it ragged-right.
1867 \advance\leftskip by-
\tableindent
1868 \advance\hsize by
\tableindent
1869 \advance\rightskip by0pt plus1fil
1870 \leavevmode\unhbox0\par
1873 % We're going to be starting a paragraph, but we don't want the
1874 % \parskip glue -- logically it's part of the @item we just started.
1875 \nobreak \vskip-
\parskip
1877 % Stop a page break at the \parskip glue coming up. Unfortunately
1878 % we can't prevent a possible page break at the following
1879 % \baselineskip glue.
1882 \itemxneedsnegativevskipfalse
1884 % The item text fits into the space. Start a paragraph, so that the
1885 % following text (if any) will end up on the same line.
1887 % Do this with kerns and \unhbox so that if there is a footnote in
1888 % the item text, it can migrate to the main vertical list and
1889 % eventually be printed.
1890 \nobreak\kern-
\tableindent
1891 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
1893 \nobreak\kern\dimen0
1895 \itemxneedsnegativevskiptrue
1899 \def\item{\errmessage{@item while not in a table
}}
1900 \def\itemx{\errmessage{@itemx while not in a table
}}
1901 \def\kitem{\errmessage{@kitem while not in a table
}}
1902 \def\kitemx{\errmessage{@kitemx while not in a table
}}
1903 \def\xitem{\errmessage{@xitem while not in a table
}}
1904 \def\xitemx{\errmessage{@xitemx while not in a table
}}
1906 % Contains a kludge to get @end[description] to work.
1907 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1909 % @table, @ftable, @vtable.
1910 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1911 {\obeylines\obeyspaces%
1912 \gdef\tablex #1^^M
{%
1913 \tabley\dontindex#1 \endtabley}}
1915 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1916 {\obeylines\obeyspaces%
1917 \gdef\ftablex #1^^M
{%
1918 \tabley\fnitemindex#1 \endtabley
1919 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1920 \let\Etable=
\relax}}
1922 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1923 {\obeylines\obeyspaces%
1924 \gdef\vtablex #1^^M
{%
1925 \tabley\vritemindex#1 \endtabley
1926 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1927 \let\Etable=
\relax}}
1930 \def\fnitemindex #1{\doind {fn
}{\code{#1}}}%
1931 \def\vritemindex #1{\doind {vr
}{\code{#1}}}%
1934 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1935 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1937 \def\tablez #1#2#3#4#5#6{%
1940 \def\Edescription{\Etable}% Necessary kludge.
1942 \ifnum 0#3>
0 \advance \leftskip by
#3\mil \fi %
1943 \ifnum 0#4>
0 \tableindent=
#4\mil \fi %
1944 \ifnum 0#5>
0 \advance \rightskip by
#5\mil \fi %
1946 \itemmax=
\tableindent %
1947 \advance \itemmax by -
\itemmargin %
1948 \advance \leftskip by
\tableindent %
1949 \exdentamount=
\tableindent
1951 \parskip =
\smallskipamount
1952 \ifdim \parskip=
0pt
\parskip=
2pt
\fi%
1953 \def\Etable{\endgraf\afterenvbreak\endgroup}%
1954 \let\item =
\internalBitem %
1955 \let\itemx =
\internalBitemx %
1956 \let\kitem =
\internalBkitem %
1957 \let\kitemx =
\internalBkitemx %
1958 \let\xitem =
\internalBxitem %
1959 \let\xitemx =
\internalBxitemx %
1962 % This is the counter used by @enumerate, which is really @itemize
1966 \def\itemize{\parsearg\itemizezzz}
1968 \def\itemizezzz #1{%
1969 \begingroup % ended by the @end itemize
1970 \itemizey {#1}{\Eitemize}
1973 \def\itemizey #1#2{%
1975 \itemmax=
\itemindent %
1976 \advance \itemmax by -
\itemmargin %
1977 \advance \leftskip by
\itemindent %
1978 \exdentamount=
\itemindent
1980 \parskip =
\smallskipamount %
1981 \ifdim \parskip=
0pt
\parskip=
2pt
\fi%
1982 \def#2{\endgraf\afterenvbreak\endgroup}%
1983 \def\itemcontents{#1}%
1984 \let\item=
\itemizeitem}
1986 % Set sfcode to normal for the chars that usually have another value.
1987 % These are `.?!:;,'
1988 \def\frenchspacing{\sfcode46=
1000 \sfcode63=
1000 \sfcode33=
1000
1989 \sfcode58=
1000 \sfcode59=
1000 \sfcode44=
1000 }
1991 % \splitoff TOKENS\endmark defines \first to be the first token in
1992 % TOKENS, and \rest to be the remainder.
1994 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1996 % Allow an optional argument of an uppercase letter, lowercase letter,
1997 % or number, to specify the first label in the enumerated list. No
1998 % argument is the same as `1'.
2000 \def\enumerate{\parsearg\enumeratezzz}
2001 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2002 \def\enumeratey #1 #2\endenumeratey{%
2003 \begingroup % ended by the @end enumerate
2005 % If we were given no argument, pretend we were given `1'.
2007 \ifx\thearg\empty \def\thearg{1}\fi
2009 % Detect if the argument is a single token. If so, it might be a
2010 % letter. Otherwise, the only valid thing it can be is a number.
2011 % (We will always have one token, because of the test we just made.
2012 % This is a good thing, since \splitoff doesn't work given nothing at
2013 % all -- the first parameter is undelimited.)
2014 \expandafter\splitoff\thearg\endmark
2016 % Only one token in the argument. It could still be anything.
2017 % A ``lowercase letter'' is one whose \lccode is nonzero.
2018 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2019 % not equal to itself.
2020 % Otherwise, we assume it's a number.
2022 % We need the \relax at the end of the \ifnum lines to stop TeX from
2023 % continuing to look for a <number>.
2025 \ifnum\lccode\expandafter`
\thearg=
0\relax
2026 \numericenumerate % a number (we hope)
2029 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
2030 \lowercaseenumerate % lowercase letter
2032 \uppercaseenumerate % uppercase letter
2036 % Multiple tokens in the argument. We hope it's a number.
2041 % An @enumerate whose labels are integers. The starting integer is
2044 \def\numericenumerate{%
2046 \startenumeration{\the\itemno}%
2049 % The starting (lowercase) letter is in \thearg.
2050 \def\lowercaseenumerate{%
2051 \itemno =
\expandafter`
\thearg
2053 % Be sure we're not beyond the end of the alphabet.
2055 \errmessage{No more lowercase letters in @enumerate; get a bigger
2062 % The starting (uppercase) letter is in \thearg.
2063 \def\uppercaseenumerate{%
2064 \itemno =
\expandafter`
\thearg
2066 % Be sure we're not beyond the end of the alphabet.
2068 \errmessage{No more uppercase letters in @enumerate; get a bigger
2075 % Call itemizey, adding a period to the first argument and supplying the
2076 % common last two arguments. Also subtract one from the initial value in
2077 % \itemno, since @item increments \itemno.
2079 \def\startenumeration#1{%
2080 \advance\itemno by -
1
2081 \itemizey{#1.
}\Eenumerate\flushcr
2084 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2087 \def\alphaenumerate{\enumerate{a
}}
2088 \def\capsenumerate{\enumerate{A
}}
2089 \def\Ealphaenumerate{\Eenumerate}
2090 \def\Ecapsenumerate{\Eenumerate}
2092 % Definition of @item while inside @itemize.
2095 \advance\itemno by
1
2096 {\let\par=
\endgraf \smallbreak}%
2097 \ifhmode \errmessage{In hmode at itemizeitem
}\fi
2098 {\parskip=
0in
\hskip 0pt
2099 \hbox to
0pt
{\hss \itemcontents\hskip \itemmargin}%
2100 \vadjust{\penalty 1200}}%
2103 % @multitable macros
2104 % Amy Hendrickson, 8/18/94, 3/6/96
2106 % @multitable ... @end multitable will make as many columns as desired.
2107 % Contents of each column will wrap at width given in preamble. Width
2108 % can be specified either with sample text given in a template line,
2109 % or in percent of \hsize, the current width of text on page.
2111 % Table can continue over pages but will only break between lines.
2115 % Either define widths of columns in terms of percent of \hsize:
2116 % @multitable @columnfractions .25 .3 .45
2119 % Numbers following @columnfractions are the percent of the total
2120 % current hsize to be used for each column. You may use as many
2121 % columns as desired.
2124 % Or use a template:
2125 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2127 % using the widest term desired in each column.
2129 % For those who want to use more than one line's worth of words in
2130 % the preamble, break the line within one argument and it
2131 % will parse correctly, i.e.,
2133 % @multitable {Column 1 template} {Column 2 template} {Column 3
2136 % @multitable {Column 1 template} {Column 2 template}
2137 % {Column 3 template}
2139 % Each new table line starts with @item, each subsequent new column
2140 % starts with @tab. Empty columns may be produced by supplying @tab's
2141 % with nothing between them for as many times as empty columns are needed,
2142 % ie, @tab@tab@tab will produce two empty columns.
2144 % @item, @tab, @multitable or @end multitable do not need to be on their
2145 % own lines, but it will not hurt if they are.
2147 % Sample multitable:
2149 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2150 % @item first col stuff @tab second col stuff @tab third col
2157 % @item first col stuff @tab second col stuff
2158 % @tab Many paragraphs of text may be used in any column.
2160 % They will wrap at the width determined by the template.
2161 % @item@tab@tab This will be in third column.
2164 % Default dimensions may be reset by user.
2165 % @multitableparskip is vertical space between paragraphs in table.
2166 % @multitableparindent is paragraph indent in table.
2167 % @multitablecolmargin is horizontal space to be left between columns.
2168 % @multitablelinespace is space to leave between table items, baseline
2170 % 0pt means it depends on current normal line spacing.
2172 \newskip\multitableparskip
2173 \newskip\multitableparindent
2174 \newdimen\multitablecolspace
2175 \newskip\multitablelinespace
2176 \multitableparskip=
0pt
2177 \multitableparindent=
6pt
2178 \multitablecolspace=
12pt
2179 \multitablelinespace=
0pt
2181 % Macros used to set up halign preamble:
2183 \let\endsetuptable\relax
2184 \def\xendsetuptable{\endsetuptable}
2185 \let\columnfractions\relax
2186 \def\xcolumnfractions{\columnfractions}
2189 % #1 is the part of the @columnfraction before the decimal point, which
2190 % is presumably either 0 or the empty string (but we don't check, we
2191 % just throw it away). #2 is the decimal part, which we use as the
2192 % percent of \hsize for this column.
2193 \def\pickupwholefraction#1.
#2 {%
2194 \global\advance\colcount by
1
2195 \expandafter\xdef\csname col
\the\colcount\endcsname{.
#2\hsize}%
2202 \ifx\firstarg\xendsetuptable
2205 \ifx\firstarg\xcolumnfractions
2206 \global\setpercenttrue
2209 \let\go\pickupwholefraction
2211 \global\advance\colcount by
1
2212 \setbox0=
\hbox{#1\unskip }% Add a normal word space as a separator;
2213 % typically that is always in the input, anyway.
2214 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
2217 \ifx\go\pickupwholefraction
2218 % Put the argument back for the \pickupwholefraction call, so
2219 % we'll always have a period there to be parsed.
2220 \def\go{\pickupwholefraction#1}%
2222 \let\go =
\setuptable
2228 % This used to have \hskip1sp. But then the space in a template line is
2229 % not enough. That is bad. So let's go back to just & until we
2230 % encounter the problem it was intended to solve again.
2231 % --karl, nathan@acm.org, 20apr99.
2234 % @multitable ... @end multitable definitions:
2236 \def\multitable{\parsearg\dotable}
2237 \def\dotable#1{\bgroup
2242 \setmultitablespacing
2243 \parskip=
\multitableparskip
2244 \parindent=
\multitableparindent
2247 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}%
2249 % To parse everything between @multitable and @item:
2250 \setuptable#1 \endsetuptable
2252 % \everycr will reset column counter, \colcount, at the end of
2253 % each line. Every column entry will cause \colcount to advance by one.
2254 % The table preamble
2255 % looks at the current \colcount to find the correct column width.
2258 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2259 % Maybe so, but it also creates really weird page breaks when the table
2260 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2261 % manifests itself, so it can be fixed for real --karl.
2262 \global\colcount=
0\relax}}%
2264 % This preamble sets up a generic column definition, which will
2265 % be used as many times as user calls for columns.
2266 % \vtop will set a single line and will also let text wrap and
2267 % continue for many paragraphs if desired.
2268 \halign\bgroup&
\global\advance\colcount by
1\relax
2269 \multistrut\vtop{\hsize=
\expandafter\csname col
\the\colcount\endcsname
2271 % In order to keep entries from bumping into each other
2272 % we will add a \leftskip of \multitablecolspace to all columns after
2275 % If a template has been used, we will add \multitablecolspace
2276 % to the width of each template entry.
2278 % If the user has set preamble in terms of percent of \hsize we will
2279 % use that dimension as the width of the column, and the \leftskip
2280 % will keep entries from bumping into each other. Table will start at
2281 % left margin and final column will justify at right margin.
2283 % Make sure we don't inherit \rightskip from the outer environment.
2286 % The first column will be indented with the surrounding text.
2287 \advance\hsize by
\leftskip
2290 % If user has not set preamble in terms of percent of \hsize
2291 % we will advance \hsize by \multitablecolspace.
2292 \advance\hsize by
\multitablecolspace
2294 % In either case we will make \leftskip=\multitablecolspace:
2295 \leftskip=
\multitablecolspace
2297 % Ignoring space at the beginning and end avoids an occasional spurious
2298 % blank line, when TeX decides to break the line at the space before the
2299 % box from the multistrut, so the strut ends up on a line by itself.
2301 % @multitable @columnfractions .11 .89
2303 % @tab Legal holiday which is valid in major parts of the whole country.
2304 % Is automatically provided with highlighting sequences respectively marking
2306 \noindent\ignorespaces##
\unskip\multistrut}\cr
2309 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2310 % If so, do nothing. If not, give it an appropriate dimension based on
2311 % current baselineskip.
2312 \ifdim\multitablelinespace=
0pt
2313 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
2314 \global\advance\multitablelinespace by-
\ht0
2315 %% strut to put in table in case some entry doesn't have descenders,
2316 %% to keep lines equally spaced
2317 \let\multistrut =
\strut
2319 %% FIXME: what is \box0 supposed to be?
2320 \gdef\multistrut{\vrule height
\multitablelinespace depth
\dp0
2322 %% Test to see if parskip is larger than space between lines of
2323 %% table. If not, do nothing.
2324 %% If so, set to same dimension as multitablelinespace.
2325 \ifdim\multitableparskip>
\multitablelinespace
2326 \global\multitableparskip=
\multitablelinespace
2327 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2328 %% than skip between lines in the table.
2330 \ifdim\multitableparskip=
0pt
2331 \global\multitableparskip=
\multitablelinespace
2332 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2333 %% than skip between lines in the table.
2337 \message{conditionals,
}
2338 % Prevent errors for section commands.
2339 % Used in @ignore and in failing conditionals.
2340 \def\ignoresections{%
2342 \let\unnumbered=
\relax
2344 \let\unnumberedsec=
\relax
2345 \let\unnumberedsection=
\relax
2346 \let\unnumberedsubsec=
\relax
2347 \let\unnumberedsubsection=
\relax
2348 \let\unnumberedsubsubsec=
\relax
2349 \let\unnumberedsubsubsection=
\relax
2352 \let\subsubsec=
\relax
2353 \let\subsection=
\relax
2354 \let\subsubsection=
\relax
2355 \let\appendix=
\relax
2356 \let\appendixsec=
\relax
2357 \let\appendixsection=
\relax
2358 \let\appendixsubsec=
\relax
2359 \let\appendixsubsection=
\relax
2360 \let\appendixsubsubsec=
\relax
2361 \let\appendixsubsubsection=
\relax
2362 \let\contents=
\relax
2363 \let\smallbook=
\relax
2364 \let\titlepage=
\relax
2367 % Used in nested conditionals, where we have to parse the Texinfo source
2368 % and so want to turn off most commands, in case they are used
2371 \def\ignoremorecommands{%
2372 \let\defcodeindex =
\relax
2375 \let\deffnx =
\relax
2376 \let\defindex =
\relax
2377 \let\defivar =
\relax
2378 \let\defmac =
\relax
2379 \let\defmethod =
\relax
2381 \let\defopt =
\relax
2382 \let\defspec =
\relax
2384 \let\deftypefn =
\relax
2385 \let\deftypefun =
\relax
2386 \let\deftypeivar =
\relax
2387 \let\deftypeop =
\relax
2388 \let\deftypevar =
\relax
2389 \let\deftypevr =
\relax
2391 \let\defvar =
\relax
2395 \let\printindex =
\relax
2397 \let\settitle =
\relax
2398 \let\setchapternewpage =
\relax
2399 \let\setchapterstyle =
\relax
2400 \let\everyheading =
\relax
2401 \let\evenheading =
\relax
2402 \let\oddheading =
\relax
2403 \let\everyfooting =
\relax
2404 \let\evenfooting =
\relax
2405 \let\oddfooting =
\relax
2406 \let\headings =
\relax
2407 \let\include =
\relax
2408 \let\lowersections =
\relax
2410 \let\raisesections =
\relax
2417 % Ignore @ignore, @ifhtml, @ifinfo, @ifplaintext, @ifnottex, @html, @menu,
2418 % @direntry, and @documentdescription.
2420 \def\ignore{\doignore{ignore
}}
2421 \def\ifhtml{\doignore{ifhtml
}}
2422 \def\ifinfo{\doignore{ifinfo
}}
2423 \def\ifplaintext{\doignore{ifplaintext
}}
2424 \def\ifnottex{\doignore{ifnottex
}}
2425 \def\html{\doignore{html
}}
2426 \def\menu{\doignore{menu
}}
2427 \def\direntry{\doignore{direntry
}}
2428 \def\documentdescription{\doignore{documentdescription
}}
2429 \def\documentdescriptionword{documentdescription
}
2431 % @dircategory CATEGORY -- specify a category of the dir file
2432 % which this file should belong to. Ignore this in TeX.
2433 \let\dircategory =
\comment
2435 % Ignore text until a line `@end #1'.
2437 \def\doignore#1{\begingroup
2438 % Don't complain about control sequences we have declared \outer.
2441 % Define a command to swallow text until we reach `@end #1'.
2442 % This @ is a catcode 12 token (that is the normal catcode of @ in
2443 % this texinfo.tex file). We change the catcode of @ below to match.
2444 \long\def\doignoretext#
#1@end
#1{\enddoignore}%
2446 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2449 % Ignore braces, too, so mismatched braces don't cause trouble.
2453 % We must not have @c interpreted as a control sequence.
2456 \def\ignoreword{#1}%
2457 \ifx\ignoreword\documentdescriptionword
2458 % The c kludge breaks documentdescription, since
2459 % `documentdescription' contains a `c'. Means not everything will
2460 % be ignored inside @documentdescription, but oh well...
2462 % Make the letter c a comment character so that the rest of the line
2463 % will be ignored. This way, the document can have (for example)
2465 % and the @end ifinfo will be properly ignored.
2466 % (We've just changed @ to catcode 12.)
2470 % And now expand the command defined above.
2474 % What we do to finish off ignored text.
2476 \def\enddoignore{\endgroup\ignorespaces}%
2478 \newif\ifwarnedobs\warnedobsfalse
2480 \ifwarnedobs\relax\else
2481 % We need to warn folks that they may have trouble with TeX 3.0.
2482 % This uses \immediate\write16 rather than \message to get newlines.
2483 \immediate\write16{}
2484 \immediate\write16{WARNING: for users of Unix TeX
3.0!
}
2485 \immediate\write16{This manual trips a bug in TeX version
3.0 (tex hangs).
}
2486 \immediate\write16{If you are running another version of TeX, relax.
}
2487 \immediate\write16{If you are running Unix TeX
3.0, kill this TeX process.
}
2488 \immediate\write16{ Then upgrade your TeX installation if you can.
}
2489 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)
}
2490 \immediate\write16{If you are stuck with version
3.0, run the
}
2491 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution
}
2492 \immediate\write16{ to use a workaround.
}
2493 \immediate\write16{}
2494 \global\warnedobstrue
2498 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2499 % workaround (which requires the file ``dummy.tfm'' to be installed),
2500 % uncomment the following line:
2501 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2503 % Ignore text, except that we keep track of conditional commands for
2504 % purposes of nesting, up to an `@end #1' command.
2506 \def\nestedignore#1{%
2508 % We must actually expand the ignored text to look for the @end
2509 % command, so that nested ignore constructs work. Thus, we put the
2510 % text into a \vbox and then do nothing with the result. To minimize
2511 % the change of memory overflow, we follow the approach outlined on
2512 % page 401 of the TeXbook: make the current font be a dummy font.
2514 \setbox0 =
\vbox\bgroup
2515 % Don't complain about control sequences we have declared \outer.
2518 % Define `@end #1' to end the box, which will in turn undefine the
2519 % @end command again.
2520 \expandafter\def\csname E
#1\endcsname{\egroup\ignorespaces}%
2522 % We are going to be parsing Texinfo commands. Most cause no
2523 % trouble when they are used incorrectly, but some commands do
2524 % complicated argument parsing or otherwise get confused, so we
2527 % We can't do anything about stray @-signs, unfortunately;
2528 % they'll produce `undefined control sequence' errors.
2531 % Set the current font to be \nullfont, a TeX primitive, and define
2532 % all the font commands to also use \nullfont. We don't use
2533 % dummy.tfm, as suggested in the TeXbook, because not all sites
2534 % might have that installed. Therefore, math mode will still
2535 % produce output, but that should be an extremely small amount of
2536 % stuff compared to the main input.
2539 \let\tenrm=
\nullfont \let\tenit=
\nullfont \let\tensl=
\nullfont
2540 \let\tenbf=
\nullfont \let\tentt=
\nullfont \let\smallcaps=
\nullfont
2541 \let\tensf=
\nullfont
2542 % Similarly for index fonts.
2543 \let\smallrm=
\nullfont \let\smallit=
\nullfont \let\smallsl=
\nullfont
2544 \let\smallbf=
\nullfont \let\smalltt=
\nullfont \let\smallsc=
\nullfont
2545 \let\smallsf=
\nullfont
2546 % Similarly for smallexample fonts.
2547 \let\smallerrm=
\nullfont \let\smallerit=
\nullfont \let\smallersl=
\nullfont
2548 \let\smallerbf=
\nullfont \let\smallertt=
\nullfont \let\smallersc=
\nullfont
2549 \let\smallersf=
\nullfont
2551 % Don't complain when characters are missing from the fonts.
2552 \tracinglostchars =
0
2554 % Don't bother to do space factor calculations.
2557 % Don't report underfull hboxes.
2560 % Do minimal line-breaking.
2561 \pretolerance =
10000
2563 % Do not execute instructions in @tex
2564 \def\tex{\doignore{tex
}}%
2565 % Do not execute macro definitions.
2566 % `c' is a comment character, so the word `macro' will get cut off.
2567 \def\macro{\doignore{ma
}}%
2570 % @set VAR sets the variable VAR to an empty value.
2571 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2573 % Since we want to separate VAR from REST-OF-LINE (which might be
2574 % empty), we can't just use \parsearg; we have to insert a space of our
2575 % own to delimit the rest of the line, and then take it out again if we
2576 % didn't need it. Make sure the catcode of space is correct to avoid
2577 % losing inside @example, for instance.
2579 \def\set{\begingroup\catcode` =
10
2580 \catcode`\-=
12 \catcode`
\_=
12 % Allow - and _ in VAR.
2582 \def\setxxx#1{\setyyy#1 \endsetyyy}
2583 \def\setyyy#1 #2\endsetyyy{%
2585 \ifx\temp\empty \global\expandafter\let\csname SET
#1\endcsname =
\empty
2586 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2590 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2591 % \next or other control sequences that we've defined might get us into
2592 % an infinite loop. Consider `@set foo @cite{bar}'.
2593 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET
#1\endcsname{#2}}
2595 % @clear VAR clears (i.e., unsets) the variable VAR.
2597 \def\clear{\parsearg\clearxxx}
2598 \def\clearxxx#1{\global\expandafter\let\csname SET
#1\endcsname=
\relax}
2600 % @value{foo} gets the text saved in variable foo.
2602 \catcode`
\_ =
\active
2604 % We might end up with active _ or - characters in the argument if
2605 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2606 % such active characters to their normal equivalents.
2607 \gdef\value{\begingroup
2608 \catcode`\-=
12 \catcode`
\_=
12
2609 \indexbreaks \let_\normalunderscore
2612 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2614 % We have this subroutine so that we can handle at least some @value's
2615 % properly in indexes (we \let\value to this in \indexdummies). Ones
2616 % whose names contain - or _ still won't work, but we can't do anything
2617 % about that. The command has to be fully expandable, since the result
2618 % winds up in the index file. This means that if the variable's value
2619 % contains other Texinfo commands, it's almost certain it will fail
2620 % (although perhaps we could fix that with sufficient work to do a
2621 % one-level expansion on the result, instead of complete).
2623 \def\expandablevalue#1{%
2624 \expandafter\ifx\csname SET
#1\endcsname\relax
2625 {[No value for ``
#1''
]}%
2627 \csname SET
#1\endcsname
2631 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2634 \def\ifset{\parsearg\ifsetxxx}
2636 \expandafter\ifx\csname SET
#1\endcsname\relax
2637 \expandafter\ifsetfail
2639 \expandafter\ifsetsucceed
2642 \def\ifsetsucceed{\conditionalsucceed{ifset
}}
2643 \def\ifsetfail{\nestedignore{ifset
}}
2644 \defineunmatchedend{ifset
}
2646 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2647 % defined with @set, or has been undefined with @clear.
2649 \def\ifclear{\parsearg\ifclearxxx}
2650 \def\ifclearxxx #1{%
2651 \expandafter\ifx\csname SET
#1\endcsname\relax
2652 \expandafter\ifclearsucceed
2654 \expandafter\ifclearfail
2657 \def\ifclearsucceed{\conditionalsucceed{ifclear
}}
2658 \def\ifclearfail{\nestedignore{ifclear
}}
2659 \defineunmatchedend{ifclear
}
2661 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2662 % read the text following, through the first @end iftex (etc.). Make
2663 % `@end iftex' (etc.) valid only after an @iftex.
2665 \def\iftex{\conditionalsucceed{iftex
}}
2666 \def\ifnothtml{\conditionalsucceed{ifnothtml
}}
2667 \def\ifnotinfo{\conditionalsucceed{ifnotinfo
}}
2668 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext
}}
2669 \defineunmatchedend{iftex
}
2670 \defineunmatchedend{ifnothtml
}
2671 \defineunmatchedend{ifnotinfo
}
2672 \defineunmatchedend{ifnotplaintext
}
2674 % We can't just want to start a group at @iftex (etc.) and end it at
2675 % @end iftex, since then @set commands inside the conditional have no
2676 % effect (they'd get reverted at the end of the group). So we must
2677 % define \Eiftex to redefine itself to be its previous value. (We can't
2678 % just define it to fail again with an ``unmatched end'' error, since
2679 % the @ifset might be nested.)
2681 \def\conditionalsucceed#1{%
2683 % Remember the current value of \E#1.
2684 \let\nece{prevE
#1} =
\nece{E
#1}%
2686 % At the `@end #1', redefine \E#1 to be its previous value.
2687 \def\nece{E
#1}{\let\nece{E
#1} =
\nece{prevE
#1}}%
2692 % We need to expand lots of \csname's, but we don't want to expand the
2693 % control sequences after we've constructed them.
2695 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2697 % @defininfoenclose.
2698 \let\definfoenclose=
\comment
2702 % Index generation facilities
2704 % Define \newwrite to be identical to plain tex's \newwrite
2705 % except not \outer, so it can be used within \newindex.
2707 \gdef\newwrite{\alloc@
7\write\chardef\sixt@@n
}}
2709 % \newindex {foo} defines an index named foo.
2710 % It automatically defines \fooindex such that
2711 % \fooindex ...rest of line... puts an entry in the index foo.
2712 % It also defines \fooindfile to be the number of the output channel for
2713 % the file that accumulates this index. The file's extension is foo.
2714 % The name of an index should be no more than 2 characters long
2715 % for the sake of vms.
2719 \expandafter\newwrite \csname#1indfile
\endcsname
2720 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
2722 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
2723 \noexpand\doindex{#1}}
2726 % @defindex foo == \newindex{foo}
2728 \def\defindex{\parsearg\newindex}
2730 % Define @defcodeindex, like @defindex except put all entries in @code.
2732 \def\defcodeindex{\parsearg\newcodeindex}
2734 \def\newcodeindex#1{%
2736 \expandafter\newwrite \csname#1indfile
\endcsname
2737 \openout \csname#1indfile
\endcsname \jobname.
#1
2739 \expandafter\xdef\csname#1index
\endcsname{%
2740 \noexpand\docodeindex{#1}}%
2744 % @synindex foo bar makes index foo feed into index bar.
2745 % Do this instead of @defindex foo if you don't want it as a separate index.
2747 % @syncodeindex foo bar similar, but put all entries made for index foo
2750 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2751 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2753 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2754 % #3 the target index (bar).
2755 \def\dosynindex#1#2#3{%
2756 % Only do \closeout if we haven't already done it, else we'll end up
2757 % closing the target index.
2758 \expandafter \ifx\csname donesynindex
#2\endcsname \undefined
2759 % The \closeout helps reduce unnecessary open files; the limit on the
2760 % Acorn RISC OS is a mere 16 files.
2761 \expandafter\closeout\csname#2indfile
\endcsname
2762 \expandafter\let\csname\donesynindex#2\endcsname =
1
2764 % redefine \fooindfile:
2765 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
2766 \expandafter\let\csname#2indfile
\endcsname=
\temp
2767 % redefine \fooindex:
2768 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
2771 % Define \doindex, the driver for all \fooindex macros.
2772 % Argument #1 is generated by the calling \fooindex macro,
2773 % and it is "foo", the name of the index.
2775 % \doindex just uses \parsearg; it calls \doind for the actual work.
2776 % This is because \doind is more useful to call from other macros.
2778 % There is also \dosubind {index}{topic}{subtopic}
2779 % which makes an entry in a two-level index such as the operation index.
2781 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2782 \def\singleindexer #1{\doind{\indexname}{#1}}
2784 % like the previous two, but they put @code around the argument.
2785 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2786 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2788 % Take care of texinfo commands likely to appear in an index entry.
2789 % (Must be a way to avoid doing expansion at all, and thus not have to
2790 % laboriously list every single command here.)
2794 \def\@
{@
}% change to @@ when we switch to @ as escape char in aux files.
2795 % Need these in case \tex is in effect and \{ is a \delimiter again.
2796 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2797 % braces and backslashes are used only as delimiters.
2800 \def\_{{\realbackslash _
}}%
2801 \normalturnoffactive
2803 % Take care of the plain tex accent commands.
2804 \def\,#
#1{\realbackslash ,
{#
#1}}%
2805 \def\"
{\realbackslash "
}%
2806 \def\`
{\realbackslash `
}%
2807 \def\'
{\realbackslash '
}%
2808 \def\^
{\realbackslash ^
}%
2809 \def\~
{\realbackslash ~
}%
2810 \def\=
{\realbackslash =
}%
2811 \def\b{\realbackslash b
}%
2812 \def\c{\realbackslash c
}%
2813 \def\d{\realbackslash d
}%
2814 \def\u{\realbackslash u
}%
2815 \def\v{\realbackslash v
}%
2816 \def\H{\realbackslash H
}%
2817 \def\dotless#
#1{\realbackslash dotless
{#
#1}}%
2818 % Take care of the plain tex special European modified letters.
2819 \def\AA{\realbackslash AA
}%
2820 \def\AE{\realbackslash AE
}%
2821 \def\L{\realbackslash L
}%
2822 \def\OE{\realbackslash OE
}%
2823 \def\O{\realbackslash O
}%
2824 \def\aa{\realbackslash aa
}%
2825 \def\ae{\realbackslash ae
}%
2826 \def\l{\realbackslash l
}%
2827 \def\oe{\realbackslash oe
}%
2828 \def\o{\realbackslash o
}%
2829 \def\ss{\realbackslash ss
}%
2831 % Although these internals commands shouldn't show up, sometimes they do.
2832 \def\bf{\realbackslash bf
}%
2833 \def\gtr{\realbackslash gtr
}%
2834 \def\hat{\realbackslash hat
}%
2835 \def\less{\realbackslash less
}%
2836 %\def\rm{\realbackslash rm }%
2837 \def\sf{\realbackslash sf
}%
2838 \def\sl{\realbackslash sl
}%
2839 \def\tclose#
#1{\realbackslash tclose
{#
#1}}%
2840 \def\tt{\realbackslash tt
}%
2842 \def\b#
#1{\realbackslash b
{#
#1}}%
2843 \def\i#
#1{\realbackslash i
{#
#1}}%
2844 \def\sc#
#1{\realbackslash sc
{#
#1}}%
2845 \def\t#
#1{\realbackslash t
{#
#1}}%
2846 \def\r#
#1{\realbackslash r
{#
#1}}%
2848 \def\TeX{\realbackslash TeX
}%
2849 \def\acronym#
#1{\realbackslash acronym
{#
#1}}%
2850 \def\cite#
#1{\realbackslash cite
{#
#1}}%
2851 \def\code#
#1{\realbackslash code
{#
#1}}%
2852 \def\command#
#1{\realbackslash command
{#
#1}}%
2853 \def\dfn#
#1{\realbackslash dfn
{#
#1}}%
2854 \def\dots{\realbackslash dots
}%
2855 \def\emph#
#1{\realbackslash emph
{#
#1}}%
2856 \def\env#
#1{\realbackslash env
{#
#1}}%
2857 \def\file#
#1{\realbackslash file
{#
#1}}%
2858 \def\kbd#
#1{\realbackslash kbd
{#
#1}}%
2859 \def\key#
#1{\realbackslash key
{#
#1}}%
2860 \def\math#
#1{\realbackslash math
{#
#1}}%
2861 \def\option#
#1{\realbackslash option
{#
#1}}%
2862 \def\samp#
#1{\realbackslash samp
{#
#1}}%
2863 \def\strong#
#1{\realbackslash strong
{#
#1}}%
2864 \def\uref#
#1{\realbackslash uref
{#
#1}}%
2865 \def\url#
#1{\realbackslash url
{#
#1}}%
2866 \def\var#
#1{\realbackslash var
{#
#1}}%
2867 \def\w{\realbackslash w
}%
2869 % These math commands don't seem likely to be used in index entries.
2870 \def\copyright{\realbackslash copyright
}%
2871 \def\equiv{\realbackslash equiv
}%
2872 \def\error{\realbackslash error
}%
2873 \def\expansion{\realbackslash expansion
}%
2874 \def\point{\realbackslash point
}%
2875 \def\print{\realbackslash print
}%
2876 \def\result{\realbackslash result
}%
2878 % Handle some cases of @value -- where the variable name does not
2879 % contain - or _, and the value does not contain any
2880 % (non-fully-expandable) commands.
2881 \let\value =
\expandablevalue
2884 % Turn off macro expansion
2888 % If an index command is used in an @example environment, any spaces
2889 % therein should become regular spaces in the raw index file, not the
2890 % expansion of \tie (\leavevmode \penalty \@M \ ).
2892 \gdef\unsepspaces{\obeyspaces\let =
\space}}
2894 % \indexnofonts no-ops all font-change commands.
2895 % This is used when outputting the strings to sort the index by.
2896 \def\indexdummyfont#1{#1}
2897 \def\indexdummytex{TeX
}
2898 \def\indexdummydots{...
}
2902 % how to handle braces?
2903 \def\_{\normalunderscore}%
2905 \let\,=
\indexdummyfont
2906 \let\"=
\indexdummyfont
2907 \let\`=
\indexdummyfont
2908 \let\'=
\indexdummyfont
2909 \let\^=
\indexdummyfont
2910 \let\~=
\indexdummyfont
2911 \let\==
\indexdummyfont
2912 \let\b=
\indexdummyfont
2913 \let\c=
\indexdummyfont
2914 \let\d=
\indexdummyfont
2915 \let\u=
\indexdummyfont
2916 \let\v=
\indexdummyfont
2917 \let\H=
\indexdummyfont
2918 \let\dotless=
\indexdummyfont
2919 % Take care of the plain tex special European modified letters.
2932 % Don't no-op \tt, since it isn't a user-level command
2933 % and is used in the definitions of the active chars like <, >, |, etc.
2934 % Likewise with the other plain tex font commands.
2935 %\let\tt=\indexdummyfont
2937 \let\b=
\indexdummyfont
2938 \let\i=
\indexdummyfont
2939 \let\r=
\indexdummyfont
2940 \let\sc=
\indexdummyfont
2941 \let\t=
\indexdummyfont
2943 \let\TeX=
\indexdummytex
2944 \let\acronym=
\indexdummyfont
2945 \let\cite=
\indexdummyfont
2946 \let\code=
\indexdummyfont
2947 \let\command=
\indexdummyfont
2948 \let\dfn=
\indexdummyfont
2949 \let\dots=
\indexdummydots
2950 \let\emph=
\indexdummyfont
2951 \let\env=
\indexdummyfont
2952 \let\file=
\indexdummyfont
2953 \let\kbd=
\indexdummyfont
2954 \let\key=
\indexdummyfont
2955 \let\math=
\indexdummyfont
2956 \let\option=
\indexdummyfont
2957 \let\samp=
\indexdummyfont
2958 \let\strong=
\indexdummyfont
2959 \let\uref=
\indexdummyfont
2960 \let\url=
\indexdummyfont
2961 \let\var=
\indexdummyfont
2962 \let\w=
\indexdummyfont
2965 % To define \realbackslash, we must make \ not be an escape.
2966 % We must first make another character (@) an escape
2967 % so we do not become unable to do a definition.
2969 {\catcode`\@=
0 \catcode`\\=
\other
2970 @gdef@realbackslash
{\
}}
2972 \let\indexbackslash=
0 %overridden during \printindex.
2973 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
2975 % For \ifx comparisons.
2976 \def\emptymacro{\empty}
2978 % Most index entries go through here, but \dosubind is the general case.
2980 \def\doind#1#2{\dosubind{#1}{#2}\empty}
2982 % Workhorse for all \fooindexes.
2983 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2984 % \empty if called from \doind, as we usually are. The main exception
2985 % is with defuns, which call us directly.
2987 \def\dosubind#1#2#3{%
2988 % Put the index entry in the margin if desired.
2989 \ifx\SETmarginindex\relax\else
2990 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
#2}}%
2993 \count255=
\lastpenalty
2995 \indexdummies % Must do this here, since \bf, etc expand at this stage
2998 \let\folio =
0% We will expand all macros now EXCEPT \folio.
2999 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3000 % so it will be output as is; and it will print as backslash.
3004 % If third arg is present, precede it with space in sort key.
3005 \ifx\thirdarg\emptymacro
3006 \let\subentry =
\empty
3011 % First process the index entry with all font commands turned
3012 % off to get the string to sort by.
3013 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
3015 % Now the real index entry with the fonts.
3018 % If the third (subentry) arg is present, add it to the index
3020 \ifx\thirdarg\emptymacro \else
3021 \toks0 =
\expandafter{\the\toks0{#3}}%
3024 % Set up the complete index entry, with both the sort key and
3025 % the original text, including any font commands. We write
3026 % three arguments to \entry to the .?? file (four in the
3027 % subentry case), texindex reduces to two when writing the .??s
3030 \write\csname#1indfile
\endcsname{%
3031 \realbackslash entry
{\indexsorttmp}{\folio}{\the\toks0}}%
3034 % If a skip is the last thing on the list now, preserve it
3035 % by backing up by \lastskip, doing the \write, then inserting
3036 % the skip again. Otherwise, the whatsit generated by the
3037 % \write will make \lastskip zero. The result is that sequences
3042 % will have extra space inserted, because the \medbreak in the
3043 % start of the @defun won't see the skip inserted by the @end of
3044 % the previous defun.
3046 % But don't do any of this if we're not in vertical mode. We
3047 % don't want to do a \vskip and prematurely end a paragraph.
3049 % Avoid page breaks due to these extra skips, too.
3054 \ifdim\lastskip =
0pt
\else \nobreak\vskip-
\lastskip \fi
3057 \temp % do the write
3060 \ifvmode \ifdim\skip0 =
0pt
\else \nobreak\vskip\skip0 \fi \fi
3068 % The index entry written in the file actually looks like
3069 % \entry {sortstring}{page}{topic}
3071 % \entry {sortstring}{page}{topic}{subtopic}
3072 % The texindex program reads in these files and writes files
3073 % containing these kinds of lines:
3075 % before the first topic whose initial is c
3076 % \entry {topic}{pagelist}
3077 % for a topic that is used without subtopics
3079 % for the beginning of a topic that is used with subtopics
3080 % \secondary {subtopic}{pagelist}
3081 % for each subtopic.
3083 % Define the user-accessible indexing commands
3084 % @findex, @vindex, @kindex, @cindex.
3086 \def\findex {\fnindex}
3087 \def\kindex {\kyindex}
3088 \def\cindex {\cpindex}
3089 \def\vindex {\vrindex}
3090 \def\tindex {\tpindex}
3091 \def\pindex {\pgindex}
3093 \def\cindexsub {\begingroup\obeylines\cindexsub}
3095 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
3096 \dosubind{cp
}{#2}{#1}}}
3098 % Define the macros used in formatting output of the sorted index material.
3100 % @printindex causes a particular index (the ??s file) to get printed.
3101 % It does not print any chapter heading (usually an @unnumbered).
3103 \def\printindex{\parsearg\doprintindex}
3104 \def\doprintindex#1{\begingroup
3105 \dobreak \chapheadingskip{10000}%
3111 % See if the index file exists and is nonempty.
3112 % Change catcode of @ here so that if the index file contains
3114 % as its first line, TeX doesn't complain about mismatched braces
3115 % (because it thinks @} is a control sequence).
3117 \openin 1 \jobname.
#1s
3119 % \enddoublecolumns gets confused if there is no text in the index,
3120 % and it loses the chapter title and the aux file entries for the
3121 % index. The easiest way to prevent this problem is to make sure
3122 % there is some text.
3123 \putwordIndexNonexistent
3126 % If the index file exists but is empty, then \openin leaves \ifeof
3127 % false. We have to make TeX try to read something from the file, so
3128 % it can discover if there is anything in it.
3131 \putwordIndexIsEmpty
3133 % Index files are almost Texinfo source, but we use \ as the escape
3134 % character. It would be better to use @, but that's too big a change
3135 % to make right now.
3136 \def\indexbackslash{\rawbackslashxx}%
3147 % These macros are used by the sorted index file itself.
3148 % Change them to control the appearance of the index.
3151 % Some minor font changes for the special characters.
3152 \let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
3154 % Remove any glue we may have, we'll be inserting our own.
3157 % We like breaks before the index initials, so insert a bonus.
3160 % Typeset the initial. Making this add up to a whole number of
3161 % baselineskips increases the chance of the dots lining up from column
3162 % to column. It still won't often be perfect, because of the stretch
3163 % we need before each entry, but it's better.
3165 % No shrink because it confuses \balancecolumns.
3166 \vskip 1.67\baselineskip plus
.5\baselineskip
3167 \leftline{\secbf #1}%
3168 \vskip .33\baselineskip plus
.1\baselineskip
3170 % Do our best not to break after the initial.
3174 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3175 % flush to the right margin. It is used for index and table of contents
3176 % entries. The paragraph is indented by \leftskip.
3178 \def\entry#1#2{\begingroup
3180 % Start a new paragraph if necessary, so our assignments below can't
3181 % affect previous text.
3184 % Do not fill out the last line with white space.
3187 % No extra space above this paragraph.
3190 % Do not prefer a separate line ending with a hyphen to fewer lines.
3191 \finalhyphendemerits =
0
3193 % \hangindent is only relevant when the entry text and page number
3194 % don't both fit on one line. In that case, bob suggests starting the
3195 % dots pretty far over on the line. Unfortunately, a large
3196 % indentation looks wrong when the entry text itself is broken across
3197 % lines. So we use a small indentation and put up with long leaders.
3199 % \hangafter is reset to 1 (which is the value we want) at the start
3200 % of each paragraph, so we need not do anything with that.
3203 % When the entry text needs to be broken, just fill out the first line
3205 \rightskip =
0pt plus1fil
3207 % A bit of stretch before each entry for the benefit of balancing columns.
3210 % Start a ``paragraph'' for the index entry so the line breaking
3211 % parameters we've set above will have an effect.
3214 % Insert the text of the index entry. TeX will do line-breaking on it.
3216 % The following is kludged to not output a line of dots in the index if
3217 % there are no page numbers. The next person who breaks this will be
3218 % cursed by a Unix daemon.
3221 \edef\tempc{\tempa}%
3222 \edef\tempd{\tempb}%
3223 \ifx\tempc\tempd\
\else%
3225 % If we must, put the page number on a line of its own, and fill out
3226 % this line with blank space. (The \hfil is overwhelmed with the
3227 % fill leaders glue in \indexdotfill if the page number does fit.)
3229 \null\nobreak\indexdotfill % Have leaders before the page number.
3231 % The `\ ' here is removed by the implicit \unskip that TeX does as
3232 % part of (the primitive) \par. Without it, a spurious underfull
3235 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
3237 \
#2% The page number ends the paragraph.
3243 % Like \dotfill except takes at least 1 em.
3244 \def\indexdotfill{\cleaders
3245 \hbox{$
\mathsurround=
0pt
\mkern1.5mu $
{\it .
}$
\mkern1.5mu$
}\hskip 1em plus
1fill
}
3247 \def\primary #1{\line{#1\hfil}}
3249 \newskip\secondaryindent \secondaryindent=
0.5cm
3250 \def\secondary#1#2{{%
3255 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3257 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
3264 % Define two-column mode, which we use to typeset indexes.
3265 % Adapted from the TeXbook, page 416, which is to say,
3266 % the manmac.tex format used to print the TeXbook itself.
3270 \newdimen\doublecolumnhsize
3272 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3273 % Grab any single-column material above us.
3276 % Here is a possibility not foreseen in manmac: if we accumulate a
3277 % whole lot of material, we might end up calling this \output
3278 % routine twice in a row (see the doublecol-lose test, which is
3279 % essentially a couple of indexes with @setchapternewpage off). In
3280 % that case we just ship out what is in \partialpage with the normal
3281 % output routine. Generally, \partialpage will be empty when this
3282 % runs and this will be a no-op. See the indexspread.tex test case.
3283 \ifvoid\partialpage \else
3284 \onepageout{\pagecontents\partialpage}%
3287 \global\setbox\partialpage =
\vbox{%
3288 % Unvbox the main output page.
3290 \kern-
\topskip \kern\baselineskip
3293 \eject % run that output routine to set \partialpage
3295 % Use the double-column output routine for subsequent pages.
3296 \output =
{\doublecolumnout}%
3298 % Change the page size parameters. We could do this once outside this
3299 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3300 % format, but then we repeat the same computation. Repeating a couple
3301 % of assignments once per index is clearly meaningless for the
3302 % execution time, so we may as well do it in one place.
3304 % First we halve the line length, less a little for the gutter between
3305 % the columns. We compute the gutter based on the line length, so it
3306 % changes automatically with the paper format. The magic constant
3307 % below is chosen so that the gutter has the same value (well, +-<1pt)
3308 % as it did when we hard-coded it.
3310 % We put the result in a separate register, \doublecolumhsize, so we
3311 % can restore it in \pagesofar, after \hsize itself has (potentially)
3314 \doublecolumnhsize =
\hsize
3315 \advance\doublecolumnhsize by -
.04154\hsize
3316 \divide\doublecolumnhsize by
2
3317 \hsize =
\doublecolumnhsize
3319 % Double the \vsize as well. (We don't need a separate register here,
3320 % since nobody clobbers \vsize.)
3324 % The double-column output routine for all double-column pages except
3327 \def\doublecolumnout{%
3328 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
3329 % Get the available space for the double columns -- the normal
3330 % (undoubled) page height minus any material left over from the
3334 \advance\dimen@ by -
\ht\partialpage
3336 % box0 will be the left-hand column, box2 the right.
3337 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
3338 \onepageout\pagesofar
3340 \penalty\outputpenalty
3343 % Re-output the contents of the output page -- any previous material,
3344 % followed by the two boxes we just split, in box0 and box2.
3348 \hsize =
\doublecolumnhsize
3349 \wd0=
\hsize \wd2=
\hsize
3350 \hbox to
\pagewidth{\box0\hfil\box2}%
3353 % All done with double columns.
3354 \def\enddoublecolumns{%
3356 % Split the last of the double-column material. Leave it on the
3357 % current page, no automatic page break.
3360 % If we end up splitting too much material for the current page,
3361 % though, there will be another page break right after this \output
3362 % invocation ends. Having called \balancecolumns once, we do not
3363 % want to call it again. Therefore, reset \output to its normal
3364 % definition right away. (We hope \balancecolumns will never be
3365 % called on to balance too much material, but if it is, this makes
3366 % the output somewhat more palatable.)
3367 \global\output =
{\onepageout{\pagecontents\PAGE}}%
3370 \endgroup % started in \begindoublecolumns
3372 % \pagegoal was set to the doubled \vsize above, since we restarted
3373 % the current page. We're now back to normal single-column
3374 % typesetting, so reset \pagegoal to the normal \vsize (after the
3375 % \endgroup where \vsize got restored).
3379 % Called at the end of the double column material.
3380 \def\balancecolumns{%
3381 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3383 \advance\dimen@ by
\topskip
3384 \advance\dimen@ by-
\baselineskip
3385 \divide\dimen@ by
2 % target to split to
3386 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3387 \splittopskip =
\topskip
3388 % Loop until we get a decent breakpoint.
3392 \global\setbox3 =
\copy0
3393 \global\setbox1 =
\vsplit3 to
\dimen@
3395 \global\advance\dimen@ by
1pt
3398 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3399 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
3400 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
3404 \catcode`\@ =
\other
3407 \message{sectioning,
}
3408 % Chapters, sections, etc.
3411 \newcount\secno \secno=
0
3412 \newcount\subsecno \subsecno=
0
3413 \newcount\subsubsecno \subsubsecno=
0
3415 % This counter is funny since it counts through charcodes of letters A, B, ...
3416 \newcount\appendixno \appendixno = `\@
3417 % \def\appendixletter{\char\the\appendixno}
3418 % We do the following for the sake of pdftex, which needs the actual
3419 % letter in the expansion, not just typeset.
3420 \def\appendixletter{%
3421 \ifnum\appendixno=`A A
%
3422 \else\ifnum\appendixno=`B B
%
3423 \else\ifnum\appendixno=`C C
%
3424 \else\ifnum\appendixno=`D D
%
3425 \else\ifnum\appendixno=`E E
%
3426 \else\ifnum\appendixno=`F F
%
3427 \else\ifnum\appendixno=`G G
%
3428 \else\ifnum\appendixno=`H H
%
3429 \else\ifnum\appendixno=`I I
%
3430 \else\ifnum\appendixno=`J J
%
3431 \else\ifnum\appendixno=`K K
%
3432 \else\ifnum\appendixno=`L L
%
3433 \else\ifnum\appendixno=`M M
%
3434 \else\ifnum\appendixno=`N N
%
3435 \else\ifnum\appendixno=`O O
%
3436 \else\ifnum\appendixno=`P P
%
3437 \else\ifnum\appendixno=`Q Q
%
3438 \else\ifnum\appendixno=`R R
%
3439 \else\ifnum\appendixno=`S S
%
3440 \else\ifnum\appendixno=`T T
%
3441 \else\ifnum\appendixno=`U U
%
3442 \else\ifnum\appendixno=`V V
%
3443 \else\ifnum\appendixno=`W W
%
3444 \else\ifnum\appendixno=`X X
%
3445 \else\ifnum\appendixno=`Y Y
%
3446 \else\ifnum\appendixno=`Z Z
%
3447 % The \the is necessary, despite appearances, because \appendixletter is
3448 % expanded while writing the .toc file. \char\appendixno is not
3449 % expandable, thus it is written literally, thus all appendixes come out
3450 % with the same letter (or @) in the toc without it.
3451 \else\char\the\appendixno
3452 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3453 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3455 % Each @chapter defines this as the name of the chapter.
3456 % page headings and footings can use it. @section does likewise.
3460 \newcount\absseclevel % used to calculate proper heading level
3461 \newcount\secbase\secbase=
0 % @raise/lowersections modify this count
3463 % @raisesections: treat @section as chapter, @subsection as section, etc.
3464 \def\raisesections{\global\advance\secbase by -
1}
3465 \let\up=
\raisesections % original BFox name
3467 % @lowersections: treat @chapter as section, @section as subsection, etc.
3468 \def\lowersections{\global\advance\secbase by
1}
3469 \let\down=
\lowersections % original BFox name
3471 % Choose a numbered-heading macro
3472 % #1 is heading level if unmodified by @raisesections or @lowersections
3473 % #2 is text for heading
3474 \def\numhead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
3480 \numberedsubseczzz{#2}
3482 \numberedsubsubseczzz{#2}
3484 \ifnum \absseclevel<
0
3487 \numberedsubsubseczzz{#2}
3492 % like \numhead, but chooses appendix heading levels
3493 \def\apphead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
3497 \appendixsectionzzz{#2}
3499 \appendixsubseczzz{#2}
3501 \appendixsubsubseczzz{#2}
3503 \ifnum \absseclevel<
0
3506 \appendixsubsubseczzz{#2}
3511 % like \numhead, but chooses numberless heading levels
3512 \def\unnmhead#1#2{\absseclevel=
\secbase\advance\absseclevel by
#1
3516 \unnumberedseczzz{#2}
3518 \unnumberedsubseczzz{#2}
3520 \unnumberedsubsubseczzz{#2}
3522 \ifnum \absseclevel<
0
3525 \unnumberedsubsubseczzz{#2}
3530 % @chapter, @appendix, @unnumbered.
3531 \def\thischaptername{No Chapter Title
}
3532 \outer\def\chapter{\parsearg\chapteryyy}
3533 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3534 \def\chapterzzz #1{%
3535 \secno=
0 \subsecno=
0 \subsubsecno=
0
3536 \global\advance \chapno by
1 \message{\putwordChapter\space \the\chapno}%
3537 \chapmacro {#1}{\the\chapno}%
3538 \gdef\thissection{#1}%
3539 \gdef\thischaptername{#1}%
3540 % We don't substitute the actual chapter name into \thischapter
3541 % because we don't want its macros evaluated now.
3542 \xdef\thischapter{\putwordChapter{} \the\chapno:
\noexpand\thischaptername}%
3544 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry
{\the\toks0}%
3548 \global\let\section =
\numberedsec
3549 \global\let\subsection =
\numberedsubsec
3550 \global\let\subsubsection =
\numberedsubsubsec
3553 \outer\def\appendix{\parsearg\appendixyyy}
3554 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3555 \def\appendixzzz #1{%
3556 \secno=
0 \subsecno=
0 \subsubsecno=
0
3557 \global\advance \appendixno by
1
3558 \message{\putwordAppendix\space \appendixletter}%
3559 \chapmacro {#1}{\putwordAppendix{} \appendixletter}%
3560 \gdef\thissection{#1}%
3561 \gdef\thischaptername{#1}%
3562 \xdef\thischapter{\putwordAppendix{} \appendixletter:
\noexpand\thischaptername}%
3564 \edef\temp{\noexpand\writetocentry{\realbackslash appendixentry
{\the\toks0}%
3565 {\appendixletter}}}%
3568 \global\let\section =
\appendixsec
3569 \global\let\subsection =
\appendixsubsec
3570 \global\let\subsubsection =
\appendixsubsubsec
3573 % @centerchap is like @unnumbered, but the heading is centered.
3574 \outer\def\centerchap{\parsearg\centerchapyyy}
3575 \def\centerchapyyy #1{{\let\unnumbchapmacro=
\centerchapmacro \unnumberedyyy{#1}}}
3577 % @top is like @unnumbered.
3578 \outer\def\top{\parsearg\unnumberedyyy}
3580 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3581 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3582 \def\unnumberedzzz #1{%
3583 \secno=
0 \subsecno=
0 \subsubsecno=
0
3585 % This used to be simply \message{#1}, but TeX fully expands the
3586 % argument to \message. Therefore, if #1 contained @-commands, TeX
3587 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3588 % expanded @cite (which turns out to cause errors because \cite is meant
3589 % to be executed, not expanded).
3591 % Anyway, we don't want the fully-expanded definition of @cite to appear
3592 % as a result of the \message, we just want `@cite' itself. We use
3593 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3594 % simply yielding the contents of <toks register>. (We also do this for
3596 \toks0 =
{#1}\message{(
\the\toks0)
}%
3598 \unnumbchapmacro {#1}%
3599 \gdef\thischapter{#1}\gdef\thissection{#1}%
3601 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry
{\the\toks0}}}%
3604 \global\let\section =
\unnumberedsec
3605 \global\let\subsection =
\unnumberedsubsec
3606 \global\let\subsubsection =
\unnumberedsubsubsec
3610 \outer\def\numberedsec{\parsearg\secyyy}
3611 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3613 \subsecno=
0 \subsubsecno=
0 \global\advance \secno by
1 %
3614 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3616 \edef\temp{\noexpand\writetocentry{\realbackslash secentry
{\the\toks0}%
3617 {\the\chapno}{\the\secno}}}%
3623 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3624 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3625 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3626 \def\appendixsectionzzz #1{%
3627 \subsecno=
0 \subsubsecno=
0 \global\advance \secno by
1 %
3628 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3630 \edef\temp{\noexpand\writetocentry{\realbackslash secentry
{\the\toks0}%
3631 {\appendixletter}{\the\secno}}}%
3637 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3638 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3639 \def\unnumberedseczzz #1{%
3640 \plainsecheading {#1}\gdef\thissection{#1}%
3642 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry
%
3643 {\the\toks0}{\the\chapno}}}%
3650 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3651 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3652 \def\numberedsubseczzz #1{%
3653 \gdef\thissection{#1}\subsubsecno=
0 \global\advance \subsecno by
1 %
3654 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3656 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry
{\the\toks0}%
3657 {\the\chapno}{\the\secno}{\the\subsecno}}}%
3663 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3664 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3665 \def\appendixsubseczzz #1{%
3666 \gdef\thissection{#1}\subsubsecno=
0 \global\advance \subsecno by
1 %
3667 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3669 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry
{\the\toks0}%
3670 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3676 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3677 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3678 \def\unnumberedsubseczzz #1{%
3679 \plainsubsecheading {#1}\gdef\thissection{#1}%
3681 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry
%
3682 {\the\toks0}{\the\chapno}{\the\secno}}}%
3689 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3690 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3691 \def\numberedsubsubseczzz #1{%
3692 \gdef\thissection{#1}\global\advance \subsubsecno by
1 %
3693 \subsubsecheading {#1}
3694 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3696 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry
{\the\toks0}%
3697 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3703 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3704 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3705 \def\appendixsubsubseczzz #1{%
3706 \gdef\thissection{#1}\global\advance \subsubsecno by
1 %
3707 \subsubsecheading {#1}
3708 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3710 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry
{\the\toks0}%
3711 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3717 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3718 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3719 \def\unnumberedsubsubseczzz #1{%
3720 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3722 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry
%
3723 {\the\toks0}{\the\chapno}{\the\secno}{\the\subsecno}}}%
3729 % These are variants which are not "outer", so they can appear in @ifinfo.
3730 % Actually, they should now be obsolete; ordinary section commands should work.
3731 \def\infotop{\parsearg\unnumberedzzz}
3732 \def\infounnumbered{\parsearg\unnumberedzzz}
3733 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3734 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3735 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3737 \def\infoappendix{\parsearg\appendixzzz}
3738 \def\infoappendixsec{\parsearg\appendixseczzz}
3739 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3740 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3742 \def\infochapter{\parsearg\chapterzzz}
3743 \def\infosection{\parsearg\sectionzzz}
3744 \def\infosubsection{\parsearg\subsectionzzz}
3745 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3747 % These macros control what the section commands do, according
3748 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3749 % Define them by default for a numbered chapter.
3750 \global\let\section =
\numberedsec
3751 \global\let\subsection =
\numberedsubsec
3752 \global\let\subsubsection =
\numberedsubsubsec
3754 % Define @majorheading, @heading and @subheading
3756 % NOTE on use of \vbox for chapter headings, section headings, and such:
3757 % 1) We use \vbox rather than the earlier \line to permit
3758 % overlong headings to fold.
3759 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3760 % heading is obnoxious; this forbids it.
3761 % 3) Likewise, headings look best if no \parindent is used, and
3762 % if justification is not attempted. Hence \raggedright.
3765 \def\majorheading{\parsearg\majorheadingzzz}
3766 \def\majorheadingzzz #1{%
3767 {\advance\chapheadingskip by
10pt
\chapbreak }%
3768 {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3769 \parindent=
0pt
\raggedright
3770 \rm #1\hfill}}\bigskip \par\penalty 200}
3772 \def\chapheading{\parsearg\chapheadingzzz}
3773 \def\chapheadingzzz #1{\chapbreak %
3774 {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3775 \parindent=
0pt
\raggedright
3776 \rm #1\hfill}}\bigskip \par\penalty 200}
3778 % @heading, @subheading, @subsubheading.
3779 \def\heading{\parsearg\plainsecheading}
3780 \def\subheading{\parsearg\plainsubsecheading}
3781 \def\subsubheading{\parsearg\plainsubsubsecheading}
3783 % These macros generate a chapter, section, etc. heading only
3784 % (including whitespace, linebreaking, etc. around it),
3785 % given all the information in convenient, parsed form.
3787 %%% Args are the skip and penalty (usually negative)
3788 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
3790 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
3792 %%% Define plain chapter starts, and page on/off switching for it
3793 % Parameter controlling skip before chapter headings (if needed)
3795 \newskip\chapheadingskip
3797 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
3798 \def\chappager{\par\vfill\supereject}
3799 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to
0pt
{} \chappager\fi}
3801 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
3804 \global\let\contentsalignmacro =
\chappager
3805 \global\let\pchapsepmacro=
\chapbreak
3806 \global\let\pagealignmacro=
\chappager}
3809 \global\let\contentsalignmacro =
\chappager
3810 \global\let\pchapsepmacro=
\chappager
3811 \global\let\pagealignmacro=
\chappager
3812 \global\def\HEADINGSon{\HEADINGSsingle}}
3815 \global\let\contentsalignmacro =
\chapoddpage
3816 \global\let\pchapsepmacro=
\chapoddpage
3817 \global\let\pagealignmacro=
\chapoddpage
3818 \global\def\HEADINGSon{\HEADINGSdouble}}
3823 \global\let\chapmacro=
\chfplain
3824 \global\let\unnumbchapmacro=
\unnchfplain
3825 \global\let\centerchapmacro=
\centerchfplain}
3827 % Plain chapter opening.
3828 % #1 is the text, #2 the chapter number or empty if unnumbered.
3834 \setbox0 =
\hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
3835 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
3836 \hangindent =
\wd0 \centerparametersmaybe
3839 \nobreak\bigskip % no page break after a chapter title
3843 % Plain opening for unnumbered.
3844 \def\unnchfplain#1{\chfplain{#1}{}}
3846 % @centerchap -- centered and unnumbered.
3847 \let\centerparametersmaybe =
\relax
3848 \def\centerchfplain#1{{%
3849 \def\centerparametersmaybe{%
3850 \advance\rightskip by
3\rightskip
3851 \leftskip =
\rightskip
3857 \CHAPFplain % The default
3859 \def\unnchfopen #1{%
3860 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3861 \parindent=
0pt
\raggedright
3862 \rm #1\hfill}}\bigskip \par\nobreak
3865 \def\chfopen #1#2{\chapoddpage {\chapfonts
3866 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
3870 \def\centerchfopen #1{%
3871 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
3873 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3877 \global\let\chapmacro=
\chfopen
3878 \global\let\unnumbchapmacro=
\unnchfopen
3879 \global\let\centerchapmacro=
\centerchfopen}
3883 \newskip\secheadingskip
3884 \def\secheadingbreak{\dobreak \secheadingskip {-
1000}}
3885 \def\secheading#1#2#3{\sectionheading{sec
}{#2.
#3}{#1}}
3886 \def\plainsecheading#1{\sectionheading{sec
}{}{#1}}
3888 % Subsection titles.
3889 \newskip \subsecheadingskip
3890 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-
500}}
3891 \def\subsecheading#1#2#3#4{\sectionheading{subsec
}{#2.
#3.
#4}{#1}}
3892 \def\plainsubsecheading#1{\sectionheading{subsec
}{}{#1}}
3894 % Subsubsection titles.
3895 \let\subsubsecheadingskip =
\subsecheadingskip
3896 \let\subsubsecheadingbreak =
\subsecheadingbreak
3897 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec
}{#2.
#3.
#4.
#5}{#1}}
3898 \def\plainsubsubsecheading#1{\sectionheading{subsubsec
}{}{#1}}
3901 % Print any size section title.
3903 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
3904 % number (maybe empty), #3 the text.
3905 \def\sectionheading#1#2#3{%
3907 \expandafter\advance\csname #1headingskip
\endcsname by
\parskip
3908 \csname #1headingbreak
\endcsname
3911 % Switch to the right set of fonts.
3912 \csname #1fonts
\endcsname \rm
3914 % Only insert the separating space if we have a section number.
3916 \setbox0 =
\hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3918 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
3919 \hangindent =
\wd0 % zero if no section number
3922 \ifdim\parskip<
10pt
\nobreak\kern10pt\nobreak\kern-
\parskip\fi \nobreak
3927 % Table of contents.
3930 % Write an entry to the toc file, opening it if necessary.
3931 % Called from @chapter, etc. We supply {\folio} at the end of the
3932 % argument, which will end up as the last argument to the \...entry macro.
3934 % We open the .toc file here instead of at @setfilename or any other
3935 % fixed time so that @contents can be put in the document anywhere.
3937 \newif\iftocfileopened
3938 \def\writetocentry#1{%
3939 \iftocfileopened\else
3940 \immediate\openout\tocfile =
\jobname.toc
3941 \global\tocfileopenedtrue
3943 \iflinks \write\tocfile{#1{\folio}}\fi
3945 % Tell \shipout to create a page destination if we're doing pdf, which
3946 % will be the target of the links in the table of contents. We can't
3947 % just do it on every page because the title pages are numbered 1 and
3948 % 2 (the page numbers aren't printed), and so are the first two pages
3949 % of the document. Thus, we'd have two destinations named `1', and
3951 \ifpdf \pdfmakepagedesttrue \fi
3954 \newskip\contentsrightmargin \contentsrightmargin=
1in
3955 \newcount\savepageno
3956 \newcount\lastnegativepageno \lastnegativepageno = -
1
3958 % Finish up the main text and prepare to read what we've written
3961 \def\startcontents#1{%
3962 % If @setchapternewpage on, and @headings double, the contents should
3963 % start on an odd page, unlike chapters. Thus, we maintain
3964 % \contentsalignmacro in parallel with \pagealignmacro.
3965 % From: Torbjorn Granlund <tege@matematik.su.se>
3967 \immediate\closeout\tocfile
3969 % Don't need to put `Contents' or `Short Contents' in the headline.
3970 % It is abundantly clear what they are.
3971 \unnumbchapmacro{#1}\def\thischapter{}%
3972 \savepageno =
\pageno
3973 \begingroup % Set up to handle contents files properly.
3974 \catcode`\\=
0 \catcode`\
{=
1 \catcode`\
}=
2 \catcode`\@=
11
3975 % We can't do this, because then an actual ^ in a section
3976 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
3977 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
3978 \raggedbottom % Worry more about breakpoints than the bottom.
3979 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
3981 % Roman numerals for page numbers.
3982 \ifnum \pageno>
0 \pageno =
\lastnegativepageno \fi
3986 % Normal (long) toc.
3988 \startcontents{\putwordTOC}%
3989 \openin 1 \jobname.toc
3995 \contentsalignmacro % in case @setchapternewpage odd is in effect
3998 \lastnegativepageno =
\pageno
3999 \pageno =
\savepageno
4002 % And just the chapters.
4003 \def\summarycontents{%
4004 \startcontents{\putwordShortTOC}%
4006 \let\chapentry =
\shortchapentry
4007 \let\appendixentry =
\shortappendixentry
4008 \let\unnumbchapentry =
\shortunnumberedentry
4009 % We want a true roman here for the page numbers.
4011 \let\rm=
\shortcontrm \let\bf=
\shortcontbf \let\sl=
\shortcontsl
4013 \hyphenpenalty =
10000
4014 \advance\baselineskip by
1pt
% Open it up a little.
4015 \def\secentry #
#1#
#2#
#3#
#4{}
4016 \def\unnumbsecentry #
#1#
#2#
#3{}
4017 \def\subsecentry #
#1#
#2#
#3#
#4#
#5{}
4018 \def\unnumbsubsecentry #
#1#
#2#
#3#
#4{}
4019 \def\subsubsecentry #
#1#
#2#
#3#
#4#
#5#
#6{}
4020 \def\unnumbsubsubsecentry #
#1#
#2#
#3#
#4#
#5{}
4021 \openin 1 \jobname.toc
4027 \contentsalignmacro % in case @setchapternewpage odd is in effect
4029 \lastnegativepageno =
\pageno
4030 \pageno =
\savepageno
4032 \let\shortcontents =
\summarycontents
4035 \pdfcatalog{/PageMode /UseOutlines
}%
4038 % These macros generate individual entries in the table of contents.
4039 % The first argument is the chapter or section name.
4040 % The last argument is the page number.
4041 % The arguments in between are the chapter number, section number, ...
4043 % Chapters, in the main contents.
4044 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4046 % Chapters, in the short toc.
4047 % See comments in \dochapentry re vbox and related settings.
4048 \def\shortchapentry#1#2#3{%
4049 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4052 % Appendices, in the main contents.
4053 \def\appendixentry#1#2#3{\dochapentry{\putwordAppendix{} #2\labelspace#1}{#3}}
4055 % Appendices, in the short toc.
4056 \let\shortappendixentry =
\shortchapentry
4058 % Typeset the label for a chapter or appendix for the short contents.
4059 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4060 % We could simplify the code here by writing out an \appendixentry
4061 % command in the toc file for appendices, instead of using \chapentry
4062 % for both, but it doesn't seem worth it.
4064 \newdimen\shortappendixwidth
4066 \def\shortchaplabel#1{%
4067 % This space should be enough, since a single number is .5em, and the
4068 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4069 % But use \hss just in case.
4070 % (This space doesn't include the extra space that gets added after
4071 % the label; that gets put in by \shortchapentry above.)
4073 \hbox to
\dimen0{#1\hss}%
4076 % Unnumbered chapters.
4077 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
4078 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
4081 \def\secentry#1#2#3#4{\dosecentry{#2.
#3\labelspace#1}{#4}}
4082 \def\unnumbsecentry#1#2#3{\dosecentry{#1}{#3}}
4085 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.
#3.
#4\labelspace#1}{#5}}
4086 \def\unnumbsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4088 % And subsubsections.
4089 \def\subsubsecentry#1#2#3#4#5#6{%
4090 \dosubsubsecentry{#2.
#3.
#4.
#5\labelspace#1}{#6}}
4091 \def\unnumbsubsubsecentry#1#2#3#4#5{\dosubsubsecentry{#1}{#5}}
4093 % This parameter controls the indentation of the various levels.
4094 \newdimen\tocindent \tocindent =
3pc
4096 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4099 % If the toc has to be broken over pages, we want it to be at chapters
4100 % if at all possible; hence the \penalty.
4101 \def\dochapentry#1#2{%
4102 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
4105 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4107 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
4110 \def\dosecentry#1#2{\begingroup
4111 \secentryfonts \leftskip=
\tocindent
4112 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4115 \def\dosubsecentry#1#2{\begingroup
4116 \subsecentryfonts \leftskip=
2\tocindent
4117 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4120 \def\dosubsubsecentry#1#2{\begingroup
4121 \subsubsecentryfonts \leftskip=
3\tocindent
4122 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4125 % Final typesetting of a toc entry; we use the same \entry macro as for
4126 % the index entries, but we want to suppress hyphenation here. (We
4127 % can't do that in the \entry macro, since index entries might consist
4128 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4129 \def\tocentry#1#2{\begingroup
4130 \vskip 0pt plus1pt
% allow a little stretch for the sake of nice page breaks
4131 % Do not use \turnoffactive in these arguments. Since the toc is
4132 % typeset in cmr, characters such as _ would come out wrong; we
4133 % have to do the usual translation tricks.
4137 % Space between chapter (or whatever) number and the title.
4138 \def\labelspace{\hskip1em \relax}
4140 \def\dopageno#1{{\rm #1}}
4141 \def\doshortpageno#1{{\rm #1}}
4143 \def\chapentryfonts{\secfonts \rm}
4144 \def\secentryfonts{\textfonts}
4145 \let\subsecentryfonts =
\textfonts
4146 \let\subsubsecentryfonts =
\textfonts
4149 \message{environments,
}
4150 % @foo ... @end foo.
4152 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4154 % Since these characters are used in examples, it should be an even number of
4155 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4158 \def\result{\leavevmode\raise.15ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
4159 \def\expansion{\leavevmode\raise.1ex
\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
4160 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
4161 \def\equiv{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
4163 % The @error{} command.
4164 % Adapted from the TeXbook's \boxit.
4168 {\tentt \global\dimen0 =
3em
}% Width of the box.
4169 \dimen2 =
.55pt
% Thickness of rules
4170 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4171 \setbox0 =
\hbox{\kern-
.75pt
\tensf error
\kern-
1.5pt
}
4173 \global\setbox\errorbox=
\hbox to
\dimen0{\hfil
4174 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
4175 \advance\hsize by -
2\dimen2 % Rules.
4177 \hrule height
\dimen2
4178 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
4179 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
4180 \kern3pt\vrule width
\dimen2}% Space to right.
4181 \hrule height
\dimen2}
4184 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
4186 % @tex ... @end tex escapes into raw Tex temporarily.
4187 % One exception: @ is still an escape character, so that @end tex works.
4188 % But \@ or @@ will get a plain tex @ character.
4190 \def\tex{\begingroup
4191 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
4192 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
4193 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
13 \let~=
\tie
4195 \catcode 43=
12 % plus
4204 \let\bullet=
\ptexbullet
4209 \let\equiv=
\ptexequiv
4218 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4219 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
4221 \let\Etex=
\endgroup}
4223 % Define @lisp ... @end lisp.
4224 % @lisp does a \begingroup so it can rebind things,
4225 % including the definition of @end lisp (which normally is erroneous).
4227 % Amount to narrow the margins by for @lisp.
4228 \newskip\lispnarrowing \lispnarrowing=
0.4in
4230 % This is the definition that ^^M gets inside @lisp, @example, and other
4231 % such environments. \null is better than a space, since it doesn't
4233 \def\lisppar{\null\endgraf}
4235 % Make each space character in the input produce a normal interword
4236 % space in the output. Don't allow a line break at this space, as this
4237 % is used only in environments like @example, where each line of input
4238 % should produce a line of output anyway.
4241 \gdef\sepspaces{\obeyspaces\let =
\tie}}
4243 % Define \obeyedspace to be our active space, whatever it is. This is
4244 % for use in \parsearg.
4246 \global\let\obeyedspace=
}
4248 % This space is always present above and below environments.
4249 \newskip\envskipamount \envskipamount =
0pt
4251 % Make spacing and below environment symmetrical. We use \parskip here
4252 % to help in doing that, since in @example-like environments \parskip
4253 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4254 % start of the next paragraph will insert \parskip
4256 \def\aboveenvbreak{{%
4257 \ifnum\lastpenalty <
10000
4258 \advance\envskipamount by
\parskip
4260 \ifdim\lastskip<
\envskipamount
4263 \vskip\envskipamount
4268 \let\afterenvbreak =
\aboveenvbreak
4270 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4271 \let\nonarrowing=
\relax
4273 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4274 % environment contents.
4275 \font\circle=lcircle10
4277 \newdimen\cartouter\newdimen\cartinner
4278 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4279 \circthick=
\fontdimen8\circle
4281 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
4282 \def\ctr{{\hskip 6pt
\circle\char'
010}}
4283 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
4284 \def\cbr{{\hskip 6pt
\circle\char'
011}}
4285 \def\carttop{\hbox to
\cartouter{\hskip\lskip
4286 \ctl\leaders\hrule height
\circthick\hfil\ctr
4288 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
4289 \cbl\leaders\hrule height
\circthick\hfil\cbr
4292 \newskip\lskip\newskip\rskip
4294 \long\def\cartouche{%
4296 \lskip=
\leftskip \rskip=
\rightskip
4297 \leftskip=
0pt
\rightskip=
0pt
%we want these *outside*.
4298 \cartinner=
\hsize \advance\cartinner by-
\lskip
4299 \advance\cartinner by-
\rskip
4301 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
4302 % side, and for 6pt waste from
4303 % each corner char, and rule thickness
4304 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
4305 % Flag to tell @lisp, etc., not to narrow margin.
4306 \let\nonarrowing=
\comment
4308 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
4317 \baselineskip=
\normbskip
4318 \lineskip=
\normlskip
4334 % This macro is called at the beginning of all the @example variants,
4338 \inENV % This group ends at the end of the body
4339 \hfuzz =
12pt
% Don't be fussy
4340 \sepspaces % Make spaces be word-separators rather than space tokens.
4342 \let\par =
\lisppar % don't ignore blank lines
4343 \obeylines % each line of input is a line of output
4346 \emergencystretch =
0pt
% don't try to avoid overfull boxes
4347 % @cartouche defines \nonarrowing to inhibit narrowing
4348 % at next level down.
4349 \ifx\nonarrowing\relax
4350 \advance \leftskip by
\lispnarrowing
4351 \exdentamount=
\lispnarrowing
4352 \let\exdent=
\nofillexdent
4353 \let\nonarrowing=
\relax
4357 % Define the \E... control sequence only if we are inside the particular
4358 % environment, so the error checking in \end will work.
4360 % To end an @example-like environment, we first end the paragraph (via
4361 % \afterenvbreak's vertical glue), and then the group. That way we keep
4362 % the zero \parskip that the environments set -- \parskip glue will be
4363 % inserted at the beginning of the next paragraph in the document, after
4366 \def\nonfillfinish{\afterenvbreak\endgroup}
4368 % @lisp: indented, narrowed, typewriter font.
4369 \def\lisp{\begingroup
4371 \let\Elisp =
\nonfillfinish
4373 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
4374 \gobble % eat return
4377 % @example: Same as @lisp.
4378 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4380 % @small... is usually equivalent to the non-small (@smallbook
4381 % redefines). We must call \example (or whatever) last in the
4382 % definition, since it reads the return following the @example (or
4383 % whatever) command.
4385 % This actually allows (for example) @end display inside an
4386 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4388 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4389 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4390 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4391 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4393 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4394 % Originally contributed by Pavel@xerox.
4395 \def\smalllispx{\begingroup
4396 \def\Esmalllisp{\nonfillfinish\endgroup}%
4397 \def\Esmallexample{\nonfillfinish\endgroup}%
4402 % @display: same as @lisp except keep current font.
4404 \def\display{\begingroup
4406 \let\Edisplay =
\nonfillfinish
4410 % @smalldisplay (when @smallbook): @display plus smaller fonts.
4412 \def\smalldisplayx{\begingroup
4413 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4414 \smallexamplefonts \rm
4418 % @format: same as @display except don't narrow margins.
4420 \def\format{\begingroup
4421 \let\nonarrowing = t
4423 \let\Eformat =
\nonfillfinish
4427 % @smallformat (when @smallbook): @format plus smaller fonts.
4429 \def\smallformatx{\begingroup
4430 \def\Esmallformat{\nonfillfinish\endgroup}%
4431 \smallexamplefonts \rm
4435 % @flushleft (same as @format).
4437 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4441 \def\flushright{\begingroup
4442 \let\nonarrowing = t
4444 \let\Eflushright =
\nonfillfinish
4445 \advance\leftskip by
0pt plus
1fill
4450 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4451 % and narrows the margins.
4454 \begingroup\inENV %This group ends at the end of the @quotation body
4455 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
4458 % We have retained a nonzero parskip for the environment, since we're
4459 % doing normal filling. So to avoid extra space below the environment...
4460 \def\Equotation{\parskip =
0pt
\nonfillfinish}%
4462 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4463 \ifx\nonarrowing\relax
4464 \advance\leftskip by
\lispnarrowing
4465 \advance\rightskip by
\lispnarrowing
4466 \exdentamount =
\lispnarrowing
4467 \let\nonarrowing =
\relax
4472 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4473 % If we want to allow any <char> as delimiter,
4474 % we need the curly braces so that makeinfo sees the @verb command, eg:
4475 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4477 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4479 % [Knuth] p. 344; only we need to do '@' too
4481 \do\
\do\\
\do\@
\do\
{\do\
}\do\$
\do\&
%
4482 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
}
4485 \def\uncatcodespecials{%
4486 \def\do#
#1{\catcode`#
#1=
12}\dospecials}
4488 % [Knuth] pp. 380,381,391
4489 % Disable Spanish ligatures ?` and !` of \tt font
4491 \catcode`\`=
\active\gdef`
{\relax\lq}
4494 % Setup for the @verb command.
4496 % Eight spaces for a tab
4498 \catcode`\^^I=
\active
4499 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
4503 \tt % easiest (and conventionally used) font for verbatim
4504 \def\par{\leavevmode\endgraf}%
4507 % Respect line breaks,
4508 % print special symbols as themselves, and
4509 % make each space count
4510 % must do in this order:
4511 \obeylines \uncatcodespecials \sepspaces
4514 % Setup for the @verbatim environment
4516 % Real tab expansion
4517 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
4519 \def\starttabbox{\setbox0=
\hbox\bgroup}
4521 \catcode`\^^I=
\active
4523 \catcode`\^^I=
\active
4524 \def^^I
{\leavevmode\egroup
4525 \dimen0=
\wd0 % the width so far, or since the previous tab
4526 \divide\dimen0 by
\tabw
4527 \multiply\dimen0 by
\tabw % compute previous multiple of \tabw
4528 \advance\dimen0 by
\tabw % advance to next multiple of \tabw
4529 \wd0=
\dimen0 \box0 \starttabbox
4533 \def\setupverbatim{%
4534 % Easiest (and conventionally used) font for verbatim
4536 \def\par{\leavevmode\egroup\box0\endgraf}%
4539 % Respect line breaks,
4540 % print special symbols as themselves, and
4541 % make each space count
4542 % must do in this order:
4543 \obeylines \uncatcodespecials \sepspaces
4544 \everypar{\starttabbox}%
4547 % Do the @verb magic: verbatim text is quoted by unique
4548 % delimiter characters. Before first delimiter expect a
4549 % right brace, after last delimiter expect closing brace:
4551 % \def\doverb'{'<char>#1<char>'}'{#1}
4553 % [Knuth] p. 382; only eat outer {}
4555 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
12\catcode`\
}=
12
4556 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
4559 \def\verb{\begingroup\setupverb\doverb}
4562 % Do the @verbatim magic: define the macro \doverbatim so that
4563 % the (first) argument ends when '@end verbatim' is reached, ie:
4565 % \def\doverbatim#1@end verbatim{#1}
4567 % For Texinfo it's a lot easier than for LaTeX,
4568 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4569 % we need not redefine '\', '{' and '}'
4571 % Inspired by LaTeX's verbatim command set [latex.ltx]
4572 %% Include LaTeX hack for completeness -- never know
4574 %% \catcode`|=0 \catcode`[=1
4575 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4576 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4577 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4581 \gdef\doverbatim#1@end verbatim
{#1\end{verbatim
}}
4585 \def\Everbatim{\nonfillfinish\endgroup}%
4588 \advance\leftskip by -
\defbodyindent
4589 \begingroup\setupverbatim\doverbatim
4592 % @verbatiminclude FILE - insert text of file in verbatim environment.
4594 % Allow normal characters that we make active in the argument (a file name).
4595 \def\verbatiminclude{%
4605 \parsearg\doverbatiminclude
4607 \def\setupverbatiminclude{%
4610 \advance\leftskip by -
\defbodyindent
4611 \begingroup\setupverbatim
4614 \def\doverbatiminclude#1{%
4615 % Restore active chars for included file.
4619 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4620 \endgroup\nonfillfinish\endgroup
4623 % @copying ... @end copying.
4624 % Save the text away for @insertcopying later.
4628 \def\copying{\begingroup
4629 \parindent =
0pt
% looks wrong on title page
4630 \def\Ecopying{\egroup\endgroup}%
4631 \global\setbox\copyingbox =
\vbox\bgroup
4636 \def\insertcopying{\unvcopy\copyingbox}
4642 % Allow user to change definition object font (\df) internally
4643 \def\setdeffont #1 {\csname DEF
#1\endcsname}
4645 \newskip\defbodyindent \defbodyindent=
.4in
4646 \newskip\defargsindent \defargsindent=
50pt
4647 \newskip\deftypemargin \deftypemargin=
12pt
4648 \newskip\deflastargmargin \deflastargmargin=
18pt
4650 \newcount\parencount
4651 % define \functionparens, which makes ( and ) and & do special things.
4652 % \functionparens affects the group it is contained in.
4654 \catcode`\(=
\active \catcode`\)=
\active \catcode`\&=
\active
4655 \catcode`\
[=
\active \catcode`\
]=
\active}
4657 % Make control sequences which act like normal parenthesis chars.
4658 \let\lparen = (
\let\rparen = )
4660 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4662 % Be sure that we always have a definition for `(', etc. For example,
4663 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4664 % so TeX would otherwise complain about undefined control sequence.
4665 \global\let(=
\lparen \global\let)=
\rparen
4666 \global\let[=
\lbrack \global\let]=
\rbrack
4668 \gdef\functionparens{\boldbrax\let&=
\amprm\parencount=
0 }
4669 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
4670 % This is used to turn on special parens
4671 % but make & act ordinary (given that it's active).
4672 \gdef\boldbraxnoamp{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb\let&=
\ampnr}
4674 % Definitions of (, ) and & used in args for functions.
4675 % This is the definition of ( outside of all parentheses.
4676 \gdef\oprm#1 {{\rm\char`\(
}#1 \bf \let(=
\opnested
4677 \global\advance\parencount by
1
4680 % This is the definition of ( when already inside a level of parens.
4681 \gdef\opnested{\char`\(
\global\advance\parencount by
1 }
4683 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4684 % also in that case restore the outer-level definition of (.
4685 \ifnum \parencount=
1 {\rm \char `\)
}\sl \let(=
\oprm \else \char `\)
\fi
4686 \global\advance \parencount by -
1 }
4687 % If we encounter &foo, then turn on ()-hacking afterwards
4688 \gdef\amprm#1 {{\rm\&
#1}\let(=
\oprm \let)=
\clrm\
}
4690 \gdef\normalparens{\boldbrax\let&=
\ampnr}
4691 } % End of definition inside \activeparens
4692 %% These parens (in \boldbrax) actually are a little bolder than the
4693 %% contained text. This is especially needed for [ and ]
4694 \def\opnr{{\sf\char`\(
}\global\advance\parencount by
1 }
4695 \def\clnr{{\sf\char`\)
}\global\advance\parencount by -
1 }
4697 \def\lbrb{{\bf\char`\
[}}
4698 \def\rbrb{{\bf\char`\
]}}
4700 % Active &'s sneak into the index arguments, so make sure it's defined.
4703 \global\let& =
\ampnr
4706 % First, defname, which formats the header line itself.
4707 % #1 should be the function name.
4708 % #2 should be the type of definition, such as "Function".
4711 % Get the values of \leftskip and \rightskip as they were
4712 % outside the @def...
4714 \advance\dimen2 by -
\defbodyindent
4716 \setbox0=
\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4717 \dimen0=
\hsize \advance \dimen0 by -
\wd0 % compute size for first line
4718 \dimen1=
\hsize \advance \dimen1 by -
\defargsindent %size for continuations
4719 \parshape 2 0in
\dimen0 \defargsindent \dimen1
4720 % Now output arg 2 ("Function" or some such)
4721 % ending at \deftypemargin from the right margin,
4722 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4723 {% Adjust \hsize to exclude the ambient margins,
4724 % so that \rightline will obey them.
4725 \advance \hsize by -
\dimen2
4726 \rlap{\rightline{{\rm #2}\hskip -
1.25pc
}}}%
4727 % Make all lines underfull and no complaints:
4728 \tolerance=
10000 \hbadness=
10000
4729 \advance\leftskip by -
\defbodyindent
4730 \exdentamount=
\defbodyindent
4731 {\df #1}\enskip % Generate function name
4734 % Actually process the body of a definition
4735 % #1 should be the terminating control sequence, such as \Edefun.
4736 % #2 should be the "another name" control sequence, such as \defunx.
4737 % #3 should be the control sequence that actually processes the header,
4738 % such as \defunheader.
4740 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4742 % Define the end token that this defining construct specifies
4743 % so that it will exit this group.
4744 \def#1{\endgraf\endgroup\medbreak}%
4745 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4747 \advance\leftskip by
\defbodyindent
4748 \exdentamount=
\defbodyindent
4750 \catcode 61=
\active % 61 is `='
4751 \obeylines\activeparens\spacesplit#3}
4753 % #1 is the \E... control sequence to end the definition (which we define).
4754 % #2 is the \...x control sequence for consecutive fns (which we define).
4755 % #3 is the control sequence to call to resume processing.
4756 % #4, delimited by the space, is the class name.
4758 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4760 % Define the end token that this defining construct specifies
4761 % so that it will exit this group.
4762 \def#1{\endgraf\endgroup\medbreak}%
4763 \def#2#
#1 {\begingroup\obeylines\activeparens\spacesplit{#3{#
#1}}}%
4765 \advance\leftskip by
\defbodyindent
4766 \exdentamount=
\defbodyindent
4767 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4769 % Used for @deftypemethod and @deftypeivar.
4770 % #1 is the \E... control sequence to end the definition (which we define).
4771 % #2 is the \...x control sequence for consecutive fns (which we define).
4772 % #3 is the control sequence to call to resume processing.
4773 % #4, delimited by a space, is the class name.
4774 % #5 is the method's return type.
4776 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4778 \def#1{\endgraf\endgroup\medbreak}%
4779 \def#2#
#1 #
#2 {\begingroup\obeylines\activeparens\spacesplit{#3{#
#1}{#
#2}}}%
4781 \advance\leftskip by
\defbodyindent
4782 \exdentamount=
\defbodyindent
4783 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4785 % Used for @deftypeop. The change from \deftypemethparsebody is an
4786 % extra argument at the beginning which is the `category', instead of it
4787 % being the hardwired string `Method' or `Instance Variable'. We have
4788 % to account for this both in the \...x definition and in parsing the
4789 % input at hand. Thus also need a control sequence (passed as #5) for
4790 % the \E... definition to assign the category name to.
4792 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4794 \def#1{\endgraf\endgroup\medbreak}%
4795 \def#2#
#1 #
#2 #
#3 {%
4797 \begingroup\obeylines\activeparens\spacesplit{#3{#
#2}{#
#3}}}%
4799 \advance\leftskip by
\defbodyindent
4800 \exdentamount=
\defbodyindent
4801 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4803 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4805 % Define the end token that this defining construct specifies
4806 % so that it will exit this group.
4807 \def#1{\endgraf\endgroup\medbreak}%
4808 \def#2#
#1 #
#2 {\def#4{#
#1}%
4809 \begingroup\obeylines\activeparens\spacesplit{#3{#
#2}}}%
4811 \advance\leftskip by
\defbodyindent
4812 \exdentamount=
\defbodyindent
4813 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4815 % These parsing functions are similar to the preceding ones
4816 % except that they do not make parens into active characters.
4817 % These are used for "variables" since they have no arguments.
4819 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4821 % Define the end token that this defining construct specifies
4822 % so that it will exit this group.
4823 \def#1{\endgraf\endgroup\medbreak}%
4824 \def#2{\begingroup\obeylines\spacesplit#3}%
4826 \advance\leftskip by
\defbodyindent
4827 \exdentamount=
\defbodyindent
4829 \catcode 61=
\active %
4830 \obeylines\spacesplit#3}
4832 % This is used for \def{tp,vr}parsebody. It could probably be used for
4833 % some of the others, too, with some judicious conditionals.
4835 \def\parsebodycommon#1#2#3{%
4838 % Define the end token that this defining construct specifies
4839 % so that it will exit this group.
4840 \def#1{\endgraf\endgroup\medbreak}%
4841 \def#2#
#1 {\begingroup\obeylines\spacesplit{#3{#
#1}}}%
4843 \advance\leftskip by
\defbodyindent
4844 \exdentamount=
\defbodyindent
4845 \begingroup\obeylines
4848 \def\defvrparsebody#1#2#3#4 {%
4849 \parsebodycommon{#1}{#2}{#3}%
4850 \spacesplit{#3{#4}}%
4853 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4854 % type is just `struct', because we lose the braces in `{struct
4855 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4856 % \let\deftpparsebody=\defvrparsebody
4858 % So, to get around this, we put \empty in with the type name. That
4859 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4860 % won't strip off the braces.
4862 \def\deftpparsebody #1#2#3#4 {%
4863 \parsebodycommon{#1}{#2}{#3}%
4864 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4867 % Fine, but then we have to eventually remove the \empty *and* the
4868 % braces (if any). That's what this does.
4870 \def\removeemptybraces\empty#1\relax{#1}
4872 % After \spacesplit has done its work, this is called -- #1 is the final
4873 % thing to call, #2 the type name (which starts with \empty), and #3
4874 % (which might be empty) the arguments.
4876 \def\parsetpheaderline#1#2#3{%
4877 #1{\removeemptybraces#2\relax}{#3}%
4880 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4882 % Define the end token that this defining construct specifies
4883 % so that it will exit this group.
4884 \def#1{\endgraf\endgroup\medbreak}%
4885 \def#2#
#1 #
#2 {\def#4{#
#1}%
4886 \begingroup\obeylines\spacesplit{#3{#
#2}}}%
4888 \advance\leftskip by
\defbodyindent
4889 \exdentamount=
\defbodyindent
4890 \begingroup\obeylines\spacesplit{#3{#5}}}
4892 % Split up #2 at the first space token.
4893 % call #1 with two arguments:
4894 % the first is all of #2 before the space token,
4895 % the second is all of #2 after that space token.
4896 % If #2 contains no space token, all of it is passed as the first arg
4897 % and the second is passed as empty.
4900 \gdef\spacesplit#1#2^^M
{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4901 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4903 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4905 % So much for the things common to all kinds of definitions.
4909 % First, define the processing that is wanted for arguments of \defun
4910 % Use this to expand the args and terminate the paragraph they make up
4912 \def\defunargs#1{\functionparens \sl
4913 % Expand, preventing hyphenation at `-' chars.
4914 % Note that groups don't affect changes in \hyphenchar.
4915 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4916 {\tensl\hyphenchar\font=
0}%
4918 {\tensl\hyphenchar\font=
45}%
4919 \ifnum\parencount=
0 \else \errmessage{Unbalanced parentheses in @def
}\fi%
4920 \interlinepenalty=
10000
4921 \advance\rightskip by
0pt plus
1fil
4922 \endgraf\nobreak\vskip -
\parskip\nobreak
4925 \def\deftypefunargs #1{%
4926 % Expand, preventing hyphenation at `-' chars.
4927 % Note that groups don't affect changes in \hyphenchar.
4928 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4930 \tclose{#1}% avoid \code because of side effects on active chars
4931 \interlinepenalty=
10000
4932 \advance\rightskip by
0pt plus
1fil
4933 \endgraf\nobreak\vskip -
\parskip\nobreak
4936 % Do complete processing of one @defun or @defunx line already parsed.
4938 % @deffn Command forward-char nchars
4940 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4942 \def\deffnheader #1#2#3{\doind {fn
}{\code{#2}}%
4943 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4944 \catcode 61=
\other % Turn off change made in \defparsebody
4947 % @defun == @deffn Function
4949 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4951 \def\defunheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
4952 \begingroup\defname {#1}{\putwordDeffunc}%
4953 \defunargs {#2}\endgroup %
4954 \catcode 61=
\other % Turn off change made in \defparsebody
4957 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4959 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4961 % #1 is the data type. #2 is the name and args.
4962 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4963 % #1 is the data type, #2 the name, #3 the args.
4964 \def\deftypefunheaderx #1#2 #3\relax{%
4965 \doind {fn
}{\code{#2}}% Make entry in function index
4966 \begingroup\defname {\defheaderxcond#1\relax$.$
#2}{\putwordDeftypefun}%
4967 \deftypefunargs {#3}\endgroup %
4968 \catcode 61=
\other % Turn off change made in \defparsebody
4971 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4973 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4975 % \defheaderxcond#1\relax$.$
4976 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4977 \def\defheaderxcond#1#2$.$
{\ifx#1\relax\else\code{#1#2} \fi}
4979 % #1 is the classification. #2 is the data type. #3 is the name and args.
4980 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4981 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4982 \def\deftypefnheaderx #1#2#3 #4\relax{%
4983 \doind {fn
}{\code{#3}}% Make entry in function index
4985 \normalparens % notably, turn off `&' magic, which prevents
4986 % at least some C++ text from working
4987 \defname {\defheaderxcond#2\relax$.$
#3}{#1}%
4988 \deftypefunargs {#4}\endgroup %
4989 \catcode 61=
\other % Turn off change made in \defparsebody
4992 % @defmac == @deffn Macro
4994 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4996 \def\defmacheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
4997 \begingroup\defname {#1}{\putwordDefmac}%
4998 \defunargs {#2}\endgroup %
4999 \catcode 61=
\other % Turn off change made in \defparsebody
5002 % @defspec == @deffn Special Form
5004 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5006 \def\defspecheader #1#2{\doind {fn
}{\code{#1}}% Make entry in function index
5007 \begingroup\defname {#1}{\putwordDefspec}%
5008 \defunargs {#2}\endgroup %
5009 \catcode 61=
\other % Turn off change made in \defparsebody
5012 % @defop CATEGORY CLASS OPERATION ARG...
5014 \def\defop #1 {\def\defoptype{#1}%
5015 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5017 \def\defopheader#1#2#3{%
5018 \dosubind {fn
}{\code{#2}}{\putwordon\
#1}% Make entry in function index
5019 \begingroup\defname {#2}{\defoptype\
\putwordon\
#1}%
5020 \defunargs {#3}\endgroup %
5023 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5025 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5026 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5029 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5030 \def\deftypeopheader#1#2#3#4{%
5031 \dosubind{fn
}{\code{#3}}{\putwordon\
\code{#1}}% entry in function index
5033 \defname{\defheaderxcond#2\relax$.$
#3}
5034 {\deftypeopcategory\
\putwordon\
\code{#1}}%
5035 \deftypefunargs{#4}%
5039 % @deftypemethod CLASS TYPE METHOD ARG...
5041 \def\deftypemethod{%
5042 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5044 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5045 \def\deftypemethodheader#1#2#3#4{%
5046 \dosubind{fn
}{\code{#3}}{\putwordon\
\code{#1}}% entry in function index
5048 \defname{\defheaderxcond#2\relax$.$
#3}{\putwordMethodon\
\code{#1}}%
5049 \deftypefunargs{#4}%
5053 % @deftypeivar CLASS TYPE VARNAME
5056 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5058 % #1 is the class name, #2 the data type, #3 the variable name.
5059 \def\deftypeivarheader#1#2#3{%
5060 \dosubind{vr
}{\code{#3}}{\putwordof\
\code{#1}}% entry in variable index
5062 \defname{\defheaderxcond#2\relax$.$
#3}
5063 {\putwordInstanceVariableof\
\code{#1}}%
5068 % @defmethod == @defop Method
5070 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5072 % #1 is the class name, #2 the method name, #3 the args.
5073 \def\defmethodheader#1#2#3{%
5074 \dosubind{fn
}{\code{#2}}{\putwordon\
\code{#1}}% entry in function index
5076 \defname{#2}{\putwordMethodon\
\code{#1}}%
5081 % @defcv {Class Option} foo-class foo-flag
5083 \def\defcv #1 {\def\defcvtype{#1}%
5084 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5086 \def\defcvarheader #1#2#3{%
5087 \dosubind {vr
}{\code{#2}}{\putwordof\
#1}% Make entry in var index
5088 \begingroup\defname {#2}{\defcvtype\
\putwordof\
#1}%
5089 \defvarargs {#3}\endgroup %
5092 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5094 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5096 \def\defivarheader#1#2#3{%
5097 \dosubind {vr
}{\code{#2}}{\putwordof\
#1}% entry in var index
5099 \defname{#2}{\putwordInstanceVariableof\
#1}%
5105 % First, define the processing that is wanted for arguments of @defvar.
5106 % This is actually simple: just print them in roman.
5107 % This must expand the args and terminate the paragraph they make up
5108 \def\defvarargs #1{\normalparens #1%
5109 \interlinepenalty=
10000
5110 \endgraf\nobreak\vskip -
\parskip\nobreak}
5112 % @defvr Counter foo-count
5114 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5116 \def\defvrheader #1#2#3{\doind {vr
}{\code{#2}}%
5117 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5119 % @defvar == @defvr Variable
5121 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5123 \def\defvarheader #1#2{\doind {vr
}{\code{#1}}% Make entry in var index
5124 \begingroup\defname {#1}{\putwordDefvar}%
5125 \defvarargs {#2}\endgroup %
5128 % @defopt == @defvr {User Option}
5130 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5132 \def\defoptheader #1#2{\doind {vr
}{\code{#1}}% Make entry in var index
5133 \begingroup\defname {#1}{\putwordDefopt}%
5134 \defvarargs {#2}\endgroup %
5137 % @deftypevar int foobar
5139 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5141 % #1 is the data type. #2 is the name, perhaps followed by text that
5142 % is actually part of the data type, which should not be put into the index.
5143 \def\deftypevarheader #1#2{%
5144 \dovarind#2 \relax% Make entry in variables index
5145 \begingroup\defname {\defheaderxcond#1\relax$.$
#2}{\putwordDeftypevar}%
5146 \interlinepenalty=
10000
5147 \endgraf\nobreak\vskip -
\parskip\nobreak
5149 \def\dovarind#1 #2\relax{\doind{vr
}{\code{#1}}}
5151 % @deftypevr {Global Flag} int enable
5153 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5155 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5156 \begingroup\defname {\defheaderxcond#2\relax$.$
#3}{#1}
5157 \interlinepenalty=
10000
5158 \endgraf\nobreak\vskip -
\parskip\nobreak
5162 % Args are printed in bold, a slight difference from @defvar.
5164 \def\deftpargs #1{\bf \defvarargs{#1}}
5166 % @deftp Class window height width ...
5168 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5170 \def\deftpheader #1#2#3{\doind {tp
}{\code{#2}}%
5171 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5173 % These definitions are used if you use @defunx (etc.)
5174 % anywhere other than immediately after a @defun or @defunx.
5176 \def\defcvx#1 {\errmessage{@defcvx in invalid context
}}
5177 \def\deffnx#1 {\errmessage{@deffnx in invalid context
}}
5178 \def\defivarx#1 {\errmessage{@defivarx in invalid context
}}
5179 \def\defmacx#1 {\errmessage{@defmacx in invalid context
}}
5180 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context
}}
5181 \def\defoptx #1 {\errmessage{@defoptx in invalid context
}}
5182 \def\defopx#1 {\errmessage{@defopx in invalid context
}}
5183 \def\defspecx#1 {\errmessage{@defspecx in invalid context
}}
5184 \def\deftpx#1 {\errmessage{@deftpx in invalid context
}}
5185 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context
}}
5186 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context
}}
5187 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context
}}
5188 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context
}}
5189 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context
}}
5190 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context
}}
5191 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context
}}
5192 \def\defunx#1 {\errmessage{@defunx in invalid context
}}
5193 \def\defvarx#1 {\errmessage{@defvarx in invalid context
}}
5194 \def\defvrx#1 {\errmessage{@defvrx in invalid context
}}
5200 % To do this right we need a feature of e-TeX, \scantokens,
5201 % which we arrange to emulate with a temporary file in ordinary TeX.
5202 \ifx\eTeXversion\undefined
5203 \newwrite\macscribble
5205 \begingroup \newlinechar`\^^M
5206 % Undo catcode changes of \startcontents and \doprintindex
5207 \catcode`\@=
0 \catcode`\\=
12 \escapechar=`\@
5208 % Append \endinput to make sure that TeX does not see the ending newline.
5209 \toks0=
{#1\endinput}%
5210 \immediate\openout\macscribble=
\jobname.tmp
5211 \immediate\write\macscribble{\the\toks0}%
5212 \immediate\closeout\macscribble
5213 \let\xeatspaces\eatspaces
5219 \begingroup \newlinechar`\^^M
5220 % Undo catcode changes of \startcontents and \doprintindex
5221 \catcode`\@=
0 \catcode`\\=
12 \escapechar=`\@
5222 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5225 \newcount\paramno % Count of parameters
5226 \newtoks\macname % Macro name
5227 \newif\ifrecursive % Is it recursive?
5228 \def\macrolist{} % List of all defined macros in the form
5229 % \do\macro1\do\macro2...
5232 % Thisdoes \let #1 = #2, except with \csnames.
5234 \expandafter\expandafter
5236 \expandafter\expandafter
5238 \csname#2\endcsname}
5240 % Trim leading and trailing spaces off a string.
5241 % Concepts from aro-bend problem 15 (see CTAN).
5243 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
5244 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
5245 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
5247 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
5250 % Trim a single trailing ^^M off a string.
5251 {\catcode`\^^M=
12\catcode`
\Q=
3%
5252 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
5253 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
5254 \gdef\eatcrb#1Q
#2Q
{#1}%
5257 % Macro bodies are absorbed as an argument in a context where
5258 % all characters are catcode 10, 11 or 12, except \ which is active
5259 % (as in normal texinfo). It is necessary to change the definition of \.
5261 % It's necessary to have hard CRs when the macro is executed. This is
5262 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5263 % body, and then making it the \newlinechar in \scanmacro.
5265 \def\macrobodyctxt{%
5290 % \mbodybackslash is the definition of \ in @macro bodies.
5291 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5292 % where N is the macro parameter number.
5293 % We define \csname macarg.\endcsname to be \realbackslash, so
5294 % \\ in macro replacement text gets you a backslash.
5296 {\catcode`@=
0 @catcode`@\=@active
5297 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
5298 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
5300 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
5302 \def\macro{\recursivefalse\parsearg\macroxxx}
5303 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5306 \getargs{#1}% now \macname is the macname and \argl the arglist
5307 \ifx\argl\empty % no arguments
5310 \expandafter\parsemargdef \argl;
%
5312 \if1\csname ismacro.
\the\macname\endcsname
5313 \message{Warning: redefining
\the\macname}%
5315 \expandafter\ifx\csname \the\macname\endcsname \relax
5316 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
5317 \global\cslet{macsave.
\the\macname}{\the\macname}%
5318 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
5319 % Add the macroname to \macrolist
5320 \toks0 =
\expandafter{\macrolist\do}%
5321 \xdef\macrolist{\the\toks0
5322 \expandafter\noexpand\csname\the\macname\endcsname}%
5324 \begingroup \macrobodyctxt
5325 \ifrecursive \expandafter\parsermacbody
5326 \else \expandafter\parsemacbody
5329 \def\unmacro{\parsearg\unmacroxxx}
5331 \if1\csname ismacro.
#1\endcsname
5332 \global\cslet{#1}{macsave.
#1}%
5333 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
5334 % Remove the macro name from \macrolist
5336 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}%
5342 \toks0 =
\expandafter{\newmacrolist\do}%
5343 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
5345 \def\newmacrolist{}%
5346 % Execute macro list to define \newmacrolist
5348 \global\let\macrolist\newmacrolist
5351 \errmessage{Macro
#1 not defined
}%
5355 % This makes use of the obscure feature that if the last token of a
5356 % <parameter list> is #, then the preceding argument is delimited by
5357 % an opening brace, and that opening brace is not consumed.
5358 \def\getargs#1{\getargsxxx#1{}}
5359 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
5360 \def\getmacname #1 #2\relax{\macname=
{#1}}
5361 \def\getmacargs#1{\def\argl{#1}}
5363 % Parse the optional {params} list. Set up \paramno and \paramlist
5364 % so \defmacro knows what to do. Define \macarg.blah for each blah
5365 % in the params list, to be ##N where N is the position in that list.
5366 % That gets used by \mbodybackslash (above).
5368 % We need to get `macro parameter char #' into several definitions.
5369 % The technique used is stolen from LaTeX: let \hash be something
5370 % unexpandable, insert that wherever you need a #, and then redefine
5371 % it to # just before using the token list produced.
5373 % The same technique is used to protect \eatspaces till just before
5374 % the macro is used.
5376 \def\parsemargdef#1;
{\paramno=
0\def\paramlist{}%
5377 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,
}
5378 \def\parsemargdefxxx#1,
{%
5379 \if#1;
\let\next=
\relax
5380 \else \let\next=
\parsemargdefxxx
5381 \advance\paramno by
1%
5382 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
5383 {\xeatspaces{\hash\the\paramno}}%
5384 \edef\paramlist{\paramlist\hash\the\paramno,
}%
5387 % These two commands read recursive and nonrecursive macro bodies.
5388 % (They're different since rec and nonrec macros end differently.)
5390 \long\def\parsemacbody#1@end macro
%
5391 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5392 \long\def\parsermacbody#1@end rmacro
%
5393 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5395 % This defines the macro itself. There are six cases: recursive and
5396 % nonrecursive macros of zero, one, and many arguments.
5397 % Much magic with \expandafter here.
5398 % \xdef is used so that macro definitions will survive the file
5399 % they're defined in; @include reads the file inside a group.
5401 \let\hash=##
% convert placeholders to macro parameter chars
5405 \expandafter\xdef\csname\the\macname\endcsname{%
5406 \noexpand\scanmacro{\temp}}%
5408 \expandafter\xdef\csname\the\macname\endcsname{%
5409 \bgroup\noexpand\macroargctxt
5410 \noexpand\braceorline
5411 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
5412 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
5413 \egroup\noexpand\scanmacro{\temp}}%
5415 \expandafter\xdef\csname\the\macname\endcsname{%
5416 \bgroup\noexpand\macroargctxt
5417 \noexpand\csname\the\macname xx
\endcsname}%
5418 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
5419 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
5420 \expandafter\expandafter
5422 \expandafter\expandafter
5423 \csname\the\macname xxx
\endcsname
5424 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5429 \expandafter\xdef\csname\the\macname\endcsname{%
5430 \noexpand\norecurse{\the\macname}%
5431 \noexpand\scanmacro{\temp}\egroup}%
5433 \expandafter\xdef\csname\the\macname\endcsname{%
5434 \bgroup\noexpand\macroargctxt
5435 \noexpand\braceorline
5436 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
5437 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
5439 \noexpand\norecurse{\the\macname}%
5440 \noexpand\scanmacro{\temp}\egroup}%
5442 \expandafter\xdef\csname\the\macname\endcsname{%
5443 \bgroup\noexpand\macroargctxt
5444 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
5445 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
5446 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
5447 \expandafter\expandafter
5449 \expandafter\expandafter
5450 \csname\the\macname xxx
\endcsname
5453 \noexpand\norecurse{\the\macname}%
5454 \noexpand\scanmacro{\temp}\egroup}%
5458 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
5460 % \braceorline decides whether the next nonwhitespace character is a
5461 % {. If so it reads up to the closing }, if not, it reads the whole
5462 % line. Whatever was read is then fed to the next control sequence
5463 % as an argument (by \parsebrace or \parsearg)
5464 \def\braceorline#1{\let\next=
#1\futurelet\nchar\braceorlinexxx}
5465 \def\braceorlinexxx{%
5466 \ifx\nchar\bgroup\else
5467 \expandafter\parsearg
5470 % We mant to disable all macros during \shipout so that they are not
5471 % expanded by \write.
5472 \def\turnoffmacros{\begingroup \def\do#
#1{\let\noexpand#
#1=
\relax}%
5473 \edef\next{\macrolist}\expandafter\endgroup\next}
5477 % We need some trickery to remove the optional spaces around the equal
5478 % sign. Just make them active and then expand them all to nothing.
5479 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5480 \def\aliasxxx #1{\aliasyyy#1\relax}
5481 \def\aliasyyy #1=
#2\relax{\ignoreactivespaces
5482 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=
%
5483 \expandafter\noexpand\csname#2\endcsname}%
5484 \expandafter\endgroup\next}
5487 \message{cross references,
}
5492 \newif\ifhavexrefs % True if xref values are known.
5493 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5495 % @inforef is relatively simple.
5496 \def\inforef #1{\inforefzzz #1,,,,**
}
5497 \def\inforefzzz #1,
#2,
#3,
#4**
{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5498 node
\samp{\ignorespaces#1{}}}
5500 % @node's job is to define \lastnode.
5501 \def\node{\ENVcheck\parsearg\nodezzz}
5502 \def\nodezzz#1{\nodexxx [#1,
]}
5503 \def\nodexxx[#1,
#2]{\gdef\lastnode{#1}}
5505 \let\lastnode=
\relax
5507 % The sectioning commands (@chapter, etc.) call these.
5509 \ifx\lastnode\relax\else
5510 \expandafter\expandafter\expandafter\setref{\lastnode}%
5511 {Ysectionnumberandtype
}%
5512 \global\let\lastnode=
\relax
5515 \def\unnumbnoderef{%
5516 \ifx\lastnode\relax\else
5517 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing
}%
5518 \global\let\lastnode=
\relax
5521 \def\appendixnoderef{%
5522 \ifx\lastnode\relax\else
5523 \expandafter\expandafter\expandafter\setref{\lastnode}%
5524 {Yappendixletterandtype
}%
5525 \global\let\lastnode=
\relax
5530 % @anchor{NAME} -- define xref target at arbitrary point.
5532 \newcount\savesfregister
5533 \gdef\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
5534 \gdef\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
5535 \gdef\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
5537 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5538 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5539 % to set \indexdummies so commands such as @code in a section title
5540 % aren't expanded. It would be nicer not to expand the titles in the
5541 % first place, but there's so many layers that that is hard to do.
5546 \dosetq{#1-title
}{Ytitle
}%
5547 \dosetq{#1-pg
}{Ypagenumber
}%
5548 \dosetq{#1-snt
}{#2}%
5551 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5552 % the node name, #2 the name of the Info cross-reference, #3 the printed
5553 % node name, #4 the name of the Info file, #5 the name of the printed
5554 % manual. All but the node name can be omitted.
5556 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
5557 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
5558 \def\ref#1{\xrefX[#1,,,,,,,
]}
5559 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
5561 \def\printedmanual{\ignorespaces #5}%
5562 \def\printednodename{\ignorespaces #3}%
5563 \setbox1=
\hbox{\printedmanual}%
5564 \setbox0=
\hbox{\printednodename}%
5566 % No printed node name was explicitly given.
5567 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname\relax
5568 % Use the node name inside the square brackets.
5569 \def\printednodename{\ignorespaces #1}%
5571 % Use the actual chapter/section title appear inside
5572 % the square brackets. Use the real section title if we have it.
5574 % It is in another manual, so we don't have it.
5575 \def\printednodename{\ignorespaces #1}%
5578 % We know the real title if we have the xref values.
5579 \def\printednodename{\refx{#1-title
}{}}%
5581 % Otherwise just copy the Info node name.
5582 \def\printednodename{\ignorespaces #1}%
5588 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5589 % insert empty discretionaries after hyphens, which means that it will
5590 % not find a line break at a hyphen in a node names. Since some manuals
5591 % are best written with fairly long node names, containing hyphens, this
5592 % is a loss. Therefore, we give the text of the node name again, so it
5593 % is as if TeX is seeing it for the first time.
5597 {\normalturnoffactive
5598 \ifnum\filenamelength>
0
5599 \startlink attr
{/Border
[0 0 0]}%
5600 goto file
{\the\filename.pdf
} name
{#1}%
5602 \startlink attr
{/Border
[0 0 0]}%
5610 \putwordsection{} ``
\printednodename''
\putwordin{} \cite{\printedmanual}%
5612 % _ (for example) has to be the character _ for the purposes of the
5613 % control sequence corresponding to the node, but it has to expand
5614 % into the usual \leavevmode...\vrule stuff for purposes of
5615 % printing. So we \turnoffactive for the \refx-snt, back on for the
5616 % printing, back off for the \refx-pg.
5617 {\normalturnoffactive
5618 % Only output a following space if the -snt ref is nonempty; for
5619 % @unnumbered and @anchor, it won't be.
5620 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
5621 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
5624 [\printednodename],
\space
5626 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
5631 % \dosetq is the interface for calls from other macros
5633 % Use \normalturnoffactive so that punctuation chars such as underscore
5634 % and backslash work in node names. (\turnoffactive doesn't do \.)
5637 \normalturnoffactive
5638 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5645 % \internalsetq {foo}{page} expands into
5646 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5647 % When the aux file is read, ' is the escape character
5649 \def\internalsetq #1#2{'xrdef
{#1}{\csname #2\endcsname}}
5651 % Things to be expanded by \internalsetq
5653 \def\Ypagenumber{\folio}
5655 \def\Ytitle{\thissection}
5659 \def\Ysectionnumberandtype{%
5660 \ifnum\secno=
0 \putwordChapter\xreftie\the\chapno %
5661 \else \ifnum \subsecno=
0 \putwordSection\xreftie\the\chapno.
\the\secno %
5662 \else \ifnum \subsubsecno=
0 %
5663 \putwordSection\xreftie\the\chapno.
\the\secno.
\the\subsecno %
5665 \putwordSection\xreftie\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno %
5668 \def\Yappendixletterandtype{%
5669 \ifnum\secno=
0 \putwordAppendix\xreftie'char
\the\appendixno{}%
5670 \else \ifnum \subsecno=
0 \putwordSection\xreftie'char
\the\appendixno.
\the\secno %
5671 \else \ifnum \subsubsecno=
0 %
5672 \putwordSection\xreftie'char
\the\appendixno.
\the\secno.
\the\subsecno %
5674 \putwordSection\xreftie'char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno %
5679 % Use TeX 3.0's \inputlineno to get the line number, for better error
5680 % messages, but if we're using an old version of TeX, don't do anything.
5682 \ifx\inputlineno\thisisundefined
5683 \let\linenumber =
\empty % Non-3.0.
5685 \def\linenumber{\the\inputlineno:
\space}
5688 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5689 % If its value is nonempty, SUFFIX is output afterward.
5692 \expandafter\ifx\csname X
#1\endcsname\relax
5693 % If not defined, say something at least.
5694 \angleleft un\-de\-fined
\angleright
5697 \message{\linenumber Undefined cross reference `
#1'.
}%
5700 \global\warnedxrefstrue
5701 \message{Cross reference values unknown; you must run TeX again.
}%
5706 % It's defined, so just use it.
5707 \csname X
#1\endcsname
5709 #2% Output the suffix in any case.
5712 % This is the macro invoked by entries in the aux file.
5714 \def\xrdef#1{\begingroup
5715 % Reenable \ as an escape while reading the second argument.
5717 \afterassignment\endgroup
5718 \expandafter\gdef\csname X
#1\endcsname
5721 % Read the last existing aux file, if any. No error if none exists.
5722 \def\readauxfile{\begingroup
5723 \catcode`\^^@=
\other
5724 \catcode`\^^A=
\other
5725 \catcode`\^^B=
\other
5726 \catcode`\^^C=
\other
5727 \catcode`\^^D=
\other
5728 \catcode`\^^E=
\other
5729 \catcode`\^^F=
\other
5730 \catcode`\^^G=
\other
5731 \catcode`\^^H=
\other
5732 \catcode`\^^K=
\other
5733 \catcode`\^^L=
\other
5734 \catcode`\^^N=
\other
5735 \catcode`\^^P=
\other
5736 \catcode`\^^Q=
\other
5737 \catcode`\^^R=
\other
5738 \catcode`\^^S=
\other
5739 \catcode`\^^T=
\other
5740 \catcode`\^^U=
\other
5741 \catcode`\^^V=
\other
5742 \catcode`\^^W=
\other
5743 \catcode`\^^X=
\other
5744 \catcode`\^^Z=
\other
5745 \catcode`\^^
[=
\other
5746 \catcode`\^^\=
\other
5747 \catcode`\^^
]=
\other
5748 \catcode`\^^^=
\other
5749 \catcode`\^^_=
\other
5752 % It was suggested to define this as 7, which would allow ^^e4 etc.
5753 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5754 % supported in the main text, it doesn't seem desirable. Furthermore,
5755 % that is not enough: for node names that actually contain a ^
5756 % character, we would end up writing a line like this: 'xrdef {'hat
5757 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5758 % argument, and \hat is not an expandable control sequence. It could
5759 % all be worked out, but why? Either we support ^^ or we don't.
5761 % The other change necessary for this was to define \auxhat:
5762 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5763 % and then to call \auxhat in \setq.
5776 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
5777 % Make the characters 128-255 be printing characters
5781 \catcode\count 1=
\other
5782 \advance\count 1 by
1
5783 \ifnum \count 1<
256 \loop \fi
5786 % The aux file uses ' as the escape (for now).
5787 % Turn off \ as an escape so we do not lose on
5788 % entries which were dumped with control sequences in their names.
5789 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5790 % Reference to such entries still does not work the way one would wish,
5791 % but at least they do not bomb out when the aux file is read in.
5798 \openin 1 \jobname.aux
5802 \global\havexrefstrue
5803 \global\warnedobstrue
5805 % Open the new aux file. TeX will close it automatically at exit.
5806 \openout\auxfile=
\jobname.aux
5812 \newcount \footnoteno
5814 % The trailing space in the following definition for supereject is
5815 % vital for proper filling; pages come out unaligned when you do a
5816 % pagealignmacro call if that space before the closing brace is
5817 % removed. (Generally, numeric constants should always be followed by a
5818 % space to prevent strange expansion errors.)
5819 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
5821 % @footnotestyle is meaningful for info output only.
5822 \let\footnotestyle=
\comment
5824 \let\ptexfootnote=
\footnote
5828 % Auto-number footnotes. Otherwise like plain.
5830 \global\advance\footnoteno by \@ne
5831 \edef\thisfootno{$^
{\the\footnoteno}$
}%
5833 % In case the footnote comes at the end of a sentence, preserve the
5834 % extra spacing after we do the footnote number.
5836 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\/
\fi
5838 % Remove inadvertent blank space before typesetting the footnote number.
5844 % Don't bother with the trickery in plain.tex to not require the
5845 % footnote text as a parameter. Our footnotes don't need to be so general.
5847 % Oh yes, they do; otherwise, @ifset and anything else that uses
5848 % \parseargline fail inside footnotes because the tokens are fixed when
5849 % the footnote is read. --karl, 16nov96.
5851 \long\gdef\footnotezzz{\insert\footins\bgroup
5852 % We want to typeset this text as a normal paragraph, even if the
5853 % footnote reference occurs in (for example) a display environment.
5854 % So reset some parameters.
5855 \interlinepenalty\interfootnotelinepenalty
5856 \splittopskip\ht\strutbox % top baseline for broken footnotes
5857 \splitmaxdepth\dp\strutbox
5858 \floatingpenalty\@MM
5863 \parindent\defaultparindent
5867 % Because we use hanging indentation in footnotes, a @noindent appears
5868 % to exdent this text, so make it be a no-op. makeinfo does not use
5869 % hanging indentation so @noindent can still be needed within footnote
5870 % text after an @example or the like (not that this is good style).
5871 \let\noindent =
\relax
5873 % Hang the footnote text off the number. Use \everypar in case the
5874 % footnote extends for more than one paragraph.
5875 \everypar =
{\hang}%
5876 \textindent{\thisfootno}%
5878 % Don't crash into the line above the footnote text. Since this
5879 % expands into a box, it must come within the paragraph, lest it
5880 % provide a place where TeX can split the footnote.
5882 \futurelet\next\fo@t
5884 \def\fo@t
{\ifcat\bgroup\noexpand\next \let\next\f@@t
5885 \else\let\next\f@t
\fi \next}
5886 \def\f@@t
{\bgroup\aftergroup\@foot
\let\next}
5887 \def\f@t
#1{#1\@foot
}
5888 \def\@foot
{\strut\par\egroup}
5890 }%end \catcode `\@=11
5892 % @| inserts a changebar to the left of the current line. It should
5893 % surround any changed text. This approach does *not* work if the
5894 % change spans more than two lines of output. To handle that, we would
5895 % have adopt a much more difficult approach (putting marks into the main
5896 % vertical list for the beginning and end of each change).
5899 % \vadjust can only be used in horizontal mode.
5902 % Append this vertical mode material after the current line in the output.
5904 % We want to insert a rule with the height and depth of the current
5905 % leading; that is exactly what \strutbox is supposed to record.
5906 \vskip-
\baselineskip
5908 % \vadjust-items are inserted at the left edge of the type. So
5909 % the \llap here moves out into the left-hand margin.
5912 % For a thicker or thinner bar, change the `1pt'.
5913 \vrule height
\baselineskip width1pt
5915 % This is the space between the bar and the text.
5921 % For a final copy, take out the rectangles
5922 % that mark overfull boxes (in case you have decided
5923 % that the text looks ok even though it passes the margin).
5925 \def\finalout{\overfullrule=
0pt
}
5927 % @image. We use the macros from epsf.tex to support this.
5928 % If epsf.tex is not installed and @image is used, we complain.
5930 % Check for and read epsf.tex up front. If we read it only at @image
5931 % time, we might be inside a group, and then its definitions would get
5932 % undone and the next image would fail.
5933 \openin 1 = epsf.tex
5936 % Do not bother showing banner with post-v2.7 epsf.tex (available in
5937 % doc/epsf.tex until it shows up on ctan).
5938 \def\epsfannounce{\toks0 =
}%
5942 % We will only complain once about lack of epsf.tex.
5943 \newif\ifwarnednoepsf
5944 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5945 work. It is also included in the Texinfo distribution, or you can get
5946 it from ftp://tug.org/tex/epsf.tex.
}
5949 \ifx\epsfbox\undefined
5950 \ifwarnednoepsf \else
5951 \errhelp =
\noepsfhelp
5952 \errmessage{epsf.tex not found, images will be ignored
}%
5953 \global\warnednoepsftrue
5956 \imagexxx #1,,,,,
\finish
5960 % Arguments to @image:
5961 % #1 is (mandatory) image filename; we tack on .eps extension.
5962 % #2 is (optional) width, #3 is (optional) height.
5963 % #4 is (ignored optional) html alt text.
5964 % #5 is (ignored optional) extension.
5965 % #6 is just the usual extra ignored arg for parsing this stuff.
5967 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
5968 \catcode`\^^M =
5 % in case we're inside an example
5969 \normalturnoffactive % allow _ et al. in names
5970 % If the image is by itself, center it.
5974 % Usually we'll have text after the image which will insert
5975 % \parskip glue, so insert it here too to equalize the space
5977 \nobreak\vskip\parskip
5984 \dopdfimage{#1}{#2}{#3}%
5986 % \epsfbox itself resets \epsf?size at each figure.
5987 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
5988 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
5992 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
5996 \message{localization,
}
5999 % @documentlanguage is usually given very early, just after
6000 % @setfilename. If done too late, it may not override everything
6001 % properly. Single argument is the language abbreviation.
6002 % It would be nice if we could set up a hyphenation file here.
6004 \def\documentlanguage{\parsearg\dodocumentlanguage}
6005 \def\dodocumentlanguage#1{%
6006 \tex % read txi-??.tex file in plain TeX.
6007 % Read the file if it exists.
6008 \openin 1 txi-
#1.tex
6010 \errhelp =
\nolanghelp
6011 \errmessage{Cannot read language file txi-
#1.tex
}%
6014 \def\temp{\input txi-
#1.tex
}%
6019 \newhelp\nolanghelp{The given language definition file cannot be found or
6020 is empty. Maybe you need to install it? In the current directory
6021 should work if nowhere else does.
}
6024 % @documentencoding should change something in TeX eventually, most
6025 % likely, but for now just recognize it.
6026 \let\documentencoding =
\comment
6029 % Page size parameters.
6031 \newdimen\defaultparindent \defaultparindent =
15pt
6033 \chapheadingskip =
15pt plus
4pt minus
2pt
6034 \secheadingskip =
12pt plus
3pt minus
2pt
6035 \subsecheadingskip =
9pt plus
2pt minus
2pt
6037 % Prevent underfull vbox error messages.
6040 % Don't be so finicky about underfull hboxes, either.
6043 % Following George Bush, just get rid of widows and orphans.
6047 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6048 % using an old version of TeX, don't do anything. We want the amount of
6049 % stretch added to depend on the line length, hence the dependence on
6050 % \hsize. We call this whenever the paper size is set.
6052 \def\setemergencystretch{%
6053 \ifx\emergencystretch\thisisundefined
6054 % Allow us to assign to \emergencystretch anyway.
6055 \def\emergencystretch{\dimen0}%
6057 \emergencystretch =
.15\hsize
6061 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6062 % 4) hoffset; 5) binding offset; 6) topskip. We also call
6063 % \setleading{\textleading}, so the caller should define \textleading.
6064 % The caller should also set \parskip.
6066 \def\internalpagesizes#1#2#3#4#5#6{%
6069 \splittopskip =
\topskip
6072 \advance\vsize by
\topskip
6073 \outervsize =
\vsize
6074 \advance\outervsize by
2\topandbottommargin
6075 \pageheight =
\vsize
6078 \outerhsize =
\hsize
6079 \advance\outerhsize by
0.5in
6082 \normaloffset =
#4\relax
6083 \bindingoffset =
#5\relax
6085 \setleading{\textleading}
6087 \parindent =
\defaultparindent
6088 \setemergencystretch
6091 % Use `small' versions.
6093 \def\smallenvironments{%
6094 \let\smalldisplay =
\smalldisplayx
6095 \let\smallexample =
\smalllispx
6096 \let\smallformat =
\smallformatx
6097 \let\smalllisp =
\smalllispx
6100 % @letterpaper (the default).
6101 \def\letterpaper{{\globaldefs =
1
6102 \parskip =
3pt plus
2pt minus
1pt
6103 \textleading =
13.2pt
6105 % If page is nothing but text, make it come out even.
6106 \internalpagesizes{46\baselineskip}{6in
}{\voffset}{.25in
}{\bindingoffset}{36pt
}%
6109 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6110 \def\smallbook{{\globaldefs =
1
6111 \parskip =
2pt plus
1pt
6114 \internalpagesizes{7.5in
}{5.in
}{\voffset}{.25in
}{\bindingoffset}{16pt
}%
6116 \lispnarrowing =
0.3in
6119 \contentsrightmargin =
0pt
6120 \deftypemargin =
0pt
6121 \defbodyindent =
.5cm
6125 % Use @afourpaper to print on European A4 paper.
6126 \def\afourpaper{{\globaldefs =
1
6127 \parskip =
3pt plus
2pt minus
1pt
6130 \internalpagesizes{53\baselineskip}{160mm
}{\voffset}{4mm
}{\bindingoffset}{44pt
}%
6136 % Use @afivepaper to print on European A5 paper.
6137 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6138 % He also recommends making @example and @lisp be small.
6139 \def\afivepaper{{\globaldefs =
1
6140 \parskip =
2pt plus
1pt minus
0.1pt
6141 \textleading =
12.5pt
6143 \internalpagesizes{166mm
}{120mm
}{\voffset}{-
8mm
}{\bindingoffset}{8pt
}%
6145 \lispnarrowing =
0.2in
6148 \contentsrightmargin =
0mm
6149 \deftypemargin =
0pt
6150 \defbodyindent =
2mm
6156 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin
6157 % 29mm, hence bottom margin 28mm, nominal side margin 3cm.
6158 \def\afourlatex{{\globaldefs =
1
6159 \textleading =
13.6pt
6162 \internalpagesizes{237mm
}{150mm
}{3.6mm
}{3.6mm
}{3mm
}{7mm
}%
6164 % Must explicitly reset to 0 because we call \afourpaper, apparently,
6165 % although this does not entirely make sense.
6169 % Use @afourwide to print on European A4 paper in wide format.
6172 \internalpagesizes{6.5in
}{9.5in
}{\hoffset}{\normaloffset}{\bindingoffset}{7mm
}%
6175 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6176 % Perhaps we should allow setting the margins, \topskip, \parskip,
6177 % and/or leading, also. Or perhaps we should compute them somehow.
6179 \def\pagesizes{\parsearg\pagesizesxxx}
6180 \def\pagesizesxxx#1{\pagesizesyyy #1,,
\finish}
6181 \def\pagesizesyyy#1,
#2,
#3\finish{{%
6182 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
6185 \parskip =
3pt plus
2pt minus
1pt
6186 \setleading{\textleading}%
6188 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt
}%
6191 % Set default to letter.
6196 \message{and turning on texinfo input format.
}
6198 % Define macros to output various characters with catcode for normal text.
6208 \def\normaldoublequote{"
}
6211 \def\normalunderscore{_
}
6212 \def\normalverticalbar{|
}
6214 \def\normalgreater{>
}
6216 \def\normaldollar{$
}%$ font-lock fix
6218 % This macro is used to make a character print one way in ttfont
6219 % where it can probably just be output, and another way in other fonts,
6220 % where something hairier probably needs to be done.
6222 % #1 is what to print if we are indeed using \tt; #2 is what to print
6223 % otherwise. Since all the Computer Modern typewriter fonts have zero
6224 % interword stretch (and shrink), and it is reasonable to expect all
6225 % typewriter fonts to have this, we can check that font parameter.
6227 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
6229 % Same as above, but check for italic font. Actually this also catches
6230 % non-italic slanted fonts since it is impossible to distinguish them from
6231 % italic fonts. But since this is only used by $ and it uses \sl anyway
6232 % this is not a problem.
6233 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
6235 % Turn off all special characters except @
6236 % (and those which the user can use as if they were ordinary).
6237 % Most of these we simply print from the \tt font, but for some, we can
6238 % use math or other variants that look better in normal text.
6241 \def\activedoublequote{{\tt\char34}}
6242 \let"=
\activedoublequote
6244 \def~
{{\tt\char126}}
6250 \def_{\ifusingtt\normalunderscore\_}
6251 % Subroutine for the previous macro.
6252 \def\_{\leavevmode \kern.06em
\vbox{\hrule width
.3em height
.1ex
}}
6255 \def|
{{\tt\char124}}
6263 \def+
{{\tt \char 43}}
6265 \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
6266 %\catcode 27=\active
6267 %\def^^[{$\diamondsuit$}
6269 % Set up an active definition for =, but don't enable it most of the time.
6270 {\catcode`\==
\active
6271 \global\def=
{{\tt \char 61}}}
6276 % If a .fmt file is being used, characters that might appear in a file
6277 % name cannot be active until we have parsed the command line.
6278 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6279 % \otherifyactive is called near the end of this file.
6280 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
6284 % \rawbackslashxx output one backslash character in current font
6285 \global\chardef\rawbackslashxx=`\\
6286 %{\catcode`\\=\other
6287 %@gdef@rawbackslashxx{\}}
6289 % \rawbackslash redefines \ as input to do \rawbackslashxx.
6290 {\catcode`\\=
\active
6291 @gdef@rawbackslash
{@let\=@rawbackslashxx
}}
6293 % \normalbackslash outputs one backslash in fixed width font.
6294 \def\normalbackslash{{\tt\rawbackslashxx}}
6296 % \catcode 17=0 % Define control-q
6299 % Used sometimes to turn off (effectively) the active characters
6300 % even after parsing them.
6301 @def@turnoffactive
{@let"=@normaldoublequote
6302 @let\=@realbackslash
6305 @let_=@normalunderscore
6306 @let|=@normalverticalbar
6308 @let>=@normalgreater
6310 @let$=@normaldollar
}%$ font-lock fix
6312 @def@normalturnoffactive
{@let"=@normaldoublequote
6313 @let\=@normalbackslash
6316 @let_=@normalunderscore
6317 @let|=@normalverticalbar
6319 @let>=@normalgreater
6321 @let$=@normaldollar
}%$ font-lock fix
6323 % Make _ and + \other characters, temporarily.
6324 % This is canceled by @fixbackslash.
6327 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6328 % That is what \eatinput is for; after that, the `\' should revert to printing
6331 @gdef@eatinput input texinfo
{@fixbackslash
}
6332 @global@let\ = @eatinput
6334 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6335 % the first `\{ in the file would cause an error. This macro tries to fix
6336 % that, assuming it is called before the first `\' could plausibly occur.
6337 % Also back turn on active characters that might appear in the input
6338 % file name, in case not using a pre-dumped format.
6340 @gdef@fixbackslash
{%
6341 @ifx\@eatinput @let\ = @normalbackslash @fi
6346 % Say @foo, not \foo, in error messages.
6349 % These look ok in all fonts, so just make them not special.
6350 @catcode`@& = @other
6351 @catcode`@# = @other
6352 @catcode`@
% = @other
6354 @c Set initial fonts.
6360 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6361 @c page-delimiter: "^\\\
\message"
6362 @c time-stamp-start: "def\\\
\texinfoversion{"
6363 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
6364 @c time-stamp-end: "
}"