* doc/pic.ms: Improve documentation of absolute coordinates.
[s-roff.git] / doc / texinfo.tex
blobe161ac470025438c396d2df3bdd2e0a0a5848585
1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2003-02-11.06}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at
14 % your option) any later version.
16 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details.
21 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 % Boston, MA 02111-1307, USA.
26 % In other words, you are welcome to use, share and improve this program.
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html)
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org),
36 % and /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
40 % The texinfo.tex in any given Texinfo distribution could well be out
41 % of date, so if that's what you're using, please check.
43 % Send bug reports to bug-texinfo@gnu.org. Please include including a
44 % complete document in each bug report with which we can reproduce the
45 % problem. Patches are, of course, greatly appreciated.
47 % To process a Texinfo manual with TeX, it's most reliable to use the
48 % texi2dvi shell script that comes with the distribution. For a simple
49 % manual foo.texi, however, you can get away with this:
50 % tex foo.texi
51 % texindex foo.??
52 % tex foo.texi
53 % tex foo.texi
54 % dvips foo.dvi -o # or whatever; this makes foo.ps.
55 % The extra TeX runs get the cross-reference information correct.
56 % Sometimes one run after texindex suffices, and sometimes you need more
57 % than two; texi2dvi does it as many times as necessary.
59 % It is possible to adapt texinfo.tex for other languages, to some
60 % extent. You can get the existing language-specific files from the
61 % full Texinfo distribution.
63 \message{Loading texinfo [version \texinfoversion]:}
65 % If in a .fmt file, print the version number
66 % and turn on active characters that we couldn't do earlier because
67 % they might have appeared in the input file name.
68 \everyjob{\message{[Texinfo version \texinfoversion]}%
69 \catcode`+=\active \catcode`\_=\active}
71 \message{Basics,}
72 \chardef\other=12
74 % We never want plain's outer \+ definition in Texinfo.
75 % For @tex, we can use \tabalign.
76 \let\+ = \relax
78 % Save some parts of plain tex whose names we will redefine.
79 \let\ptexb=\b
80 \let\ptexbullet=\bullet
81 \let\ptexc=\c
82 \let\ptexcomma=\,
83 \let\ptexdot=\.
84 \let\ptexdots=\dots
85 \let\ptexend=\end
86 \let\ptexequiv=\equiv
87 \let\ptexexclam=\!
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexplus=+
94 \let\ptexrbrace=\}
95 \let\ptexstar=\*
96 \let\ptext=\t
98 % If this character appears in an error message or help string, it
99 % starts a new line in the output.
100 \newlinechar = `^^J
102 % Set up fixed words for English if not already set.
103 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
104 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
105 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
106 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
107 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
108 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
109 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
110 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
111 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
112 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
113 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
114 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
115 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
116 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
117 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
118 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
119 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
120 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
121 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
123 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
124 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
125 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
126 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
127 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
128 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
129 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
130 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
131 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
132 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
133 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
134 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
136 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
137 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
138 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
139 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
140 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
141 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
142 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi
144 % In some macros, we cannot use the `\? notation---the left quote is
145 % in some cases the escape char.
146 \chardef\colonChar = `\:
147 \chardef\commaChar = `\,
148 \chardef\dotChar = `\.
149 \chardef\equalChar = `\=
150 \chardef\exclamChar= `\!
151 \chardef\questChar = `\?
152 \chardef\semiChar = `\;
153 \chardef\spaceChar = `\ %
154 \chardef\underChar = `\_
156 % Ignore a token.
158 \def\gobble#1{}
160 % True if #1 is the empty string, i.e., called like `\ifempty{}'.
162 \def\ifempty#1{\ifemptyx #1\emptymarkA\emptymarkB}%
163 \def\ifemptyx#1#2\emptymarkB{\ifx #1\emptymarkA}%
165 % Hyphenation fixes.
166 \hyphenation{ap-pen-dix}
167 \hyphenation{mini-buf-fer mini-buf-fers}
168 \hyphenation{eshell}
169 \hyphenation{white-space}
171 % Margin to add to right of even pages, to left of odd pages.
172 \newdimen\bindingoffset
173 \newdimen\normaloffset
174 \newdimen\pagewidth \newdimen\pageheight
176 % Sometimes it is convenient to have everything in the transcript file
177 % and nothing on the terminal. We don't just call \tracingall here,
178 % since that produces some useless output on the terminal. We also make
179 % some effort to order the tracing commands to reduce output in the log
180 % file; cf. trace.sty in LaTeX.
182 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
183 \def\loggingall{%
184 \tracingstats2
185 \tracingpages1
186 \tracinglostchars2 % 2 gives us more in etex
187 \tracingparagraphs1
188 \tracingoutput1
189 \tracingmacros2
190 \tracingrestores1
191 \showboxbreadth\maxdimen \showboxdepth\maxdimen
192 \ifx\eTeXversion\undefined\else % etex gives us more logging
193 \tracingscantokens1
194 \tracingifs1
195 \tracinggroups1
196 \tracingnesting2
197 \tracingassigns1
199 \tracingcommands3 % 3 gives us more in etex
200 \errorcontextlines\maxdimen
203 % add check for \lastpenalty to plain's definitions. If the last thing
204 % we did was a \nobreak, we don't want to insert more space.
206 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
207 \removelastskip\penalty-50\smallskip\fi\fi}
208 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
209 \removelastskip\penalty-100\medskip\fi\fi}
210 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
211 \removelastskip\penalty-200\bigskip\fi\fi}
213 % For @cropmarks command.
214 % Do @cropmarks to get crop marks.
216 \newif\ifcropmarks
217 \let\cropmarks = \cropmarkstrue
219 % Dimensions to add cropmarks at corners.
220 % Added by P. A. MacKay, 12 Nov. 1986
222 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
223 \newdimen\cornerlong \cornerlong=1pc
224 \newdimen\cornerthick \cornerthick=.3pt
225 \newdimen\topandbottommargin \topandbottommargin=.75in
227 % Main output routine.
228 \chardef\PAGE = 255
229 \output = {\onepageout{\pagecontents\PAGE}}
231 \newbox\headlinebox
232 \newbox\footlinebox
234 % \onepageout takes a vbox as an argument. Note that \pagecontents
235 % does insertions, but you have to call it yourself.
236 \def\onepageout#1{%
237 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
239 \ifodd\pageno \advance\hoffset by \bindingoffset
240 \else \advance\hoffset by -\bindingoffset\fi
242 % Do this outside of the \shipout so @code etc. will be expanded in
243 % the headline as they should be, not taken literally (outputting ''code).
244 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
245 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
248 % Have to do this stuff outside the \shipout because we want it to
249 % take effect in \write's, yet the group defined by the \vbox ends
250 % before the \shipout runs.
252 \escapechar = `\\ % use backslash in output files.
253 \indexdummies % don't expand commands in the output.
254 \normalturnoffactive % \ in index entries must not stay \, e.g., if
255 % the page break happens to be in the middle of an example.
256 \shipout\vbox{%
257 % Do this early so pdf references go to the beginning of the page.
258 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
260 \ifcropmarks \vbox to \outervsize\bgroup
261 \hsize = \outerhsize
262 \vskip-\topandbottommargin
263 \vtop to0pt{%
264 \line{\ewtop\hfil\ewtop}%
265 \nointerlineskip
266 \line{%
267 \vbox{\moveleft\cornerthick\nstop}%
268 \hfill
269 \vbox{\moveright\cornerthick\nstop}%
271 \vss}%
272 \vskip\topandbottommargin
273 \line\bgroup
274 \hfil % center the page within the outer (page) hsize.
275 \ifodd\pageno\hskip\bindingoffset\fi
276 \vbox\bgroup
279 \unvbox\headlinebox
280 \pagebody{#1}%
281 \ifdim\ht\footlinebox > 0pt
282 % Only leave this space if the footline is nonempty.
283 % (We lessened \vsize for it in \oddfootingxxx.)
284 % The \baselineskip=24pt in plain's \makefootline has no effect.
285 \vskip 2\baselineskip
286 \unvbox\footlinebox
289 \ifcropmarks
290 \egroup % end of \vbox\bgroup
291 \hfil\egroup % end of (centering) \line\bgroup
292 \vskip\topandbottommargin plus1fill minus1fill
293 \boxmaxdepth = \cornerthick
294 \vbox to0pt{\vss
295 \line{%
296 \vbox{\moveleft\cornerthick\nsbot}%
297 \hfill
298 \vbox{\moveright\cornerthick\nsbot}%
300 \nointerlineskip
301 \line{\ewbot\hfil\ewbot}%
303 \egroup % \vbox from first cropmarks clause
305 }% end of \shipout\vbox
306 }% end of group with \normalturnoffactive
307 \advancepageno
308 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
311 \newinsert\margin \dimen\margin=\maxdimen
313 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
314 {\catcode`\@ =11
315 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
316 % marginal hacks, juha@viisa.uucp (Juha Takala)
317 \ifvoid\margin\else % marginal info is present
318 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
319 \dimen@=\dp#1 \unvbox#1
320 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
321 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
324 % Here are the rules for the cropmarks. Note that they are
325 % offset so that the space between them is truly \outerhsize or \outervsize
326 % (P. A. MacKay, 12 November, 1986)
328 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
329 \def\nstop{\vbox
330 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
331 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
332 \def\nsbot{\vbox
333 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
335 % Parse an argument, then pass it to #1. The argument is the rest of
336 % the input line (except we remove a trailing comment). #1 should be a
337 % macro which expects an ordinary undelimited TeX argument.
339 \def\parsearg#1{%
340 \let\next = #1%
341 \begingroup
342 \obeylines
343 \futurelet\temp\parseargx
346 % If the next token is an obeyed space (from an @example environment or
347 % the like), remove it and recurse. Otherwise, we're done.
348 \def\parseargx{%
349 % \obeyedspace is defined far below, after the definition of \sepspaces.
350 \ifx\obeyedspace\temp
351 \expandafter\parseargdiscardspace
352 \else
353 \expandafter\parseargline
357 % Remove a single space (as the delimiter token to the macro call).
358 {\obeyspaces %
359 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
361 {\obeylines %
362 \gdef\parseargline#1^^M{%
363 \endgroup % End of the group started in \parsearg.
365 % First remove any @c comment, then any @comment.
366 % Result of each macro is put in \toks0.
367 \argremovec #1\c\relax %
368 \expandafter\argremovecomment \the\toks0 \comment\relax %
370 % Call the caller's macro, saved as \next in \parsearg.
371 \expandafter\next\expandafter{\the\toks0}%
375 % Since all \c{,omment} does is throw away the argument, we can let TeX
376 % do that for us. The \relax here is matched by the \relax in the call
377 % in \parseargline; it could be more or less anything, its purpose is
378 % just to delimit the argument to the \c.
379 \def\argremovec#1\c#2\relax{\toks0 = {#1}}
380 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
382 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
383 % @end itemize @c foo
384 % will have two active spaces as part of the argument with the
385 % `itemize'. Here we remove all active spaces from #1, and assign the
386 % result to \toks0.
388 % This loses if there are any *other* active characters besides spaces
389 % in the argument -- _ ^ +, for example -- since they get expanded.
390 % Fortunately, Texinfo does not define any such commands. (If it ever
391 % does, the catcode of the characters in questionwill have to be changed
392 % here.) But this means we cannot call \removeactivespaces as part of
393 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
394 % that \parsearg gets might well have any character at all in it.
396 \def\removeactivespaces#1{%
397 \begingroup
398 \ignoreactivespaces
399 \edef\temp{#1}%
400 \global\toks0 = \expandafter{\temp}%
401 \endgroup
404 % Change the active space to expand to nothing.
406 \begingroup
407 \obeyspaces
408 \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
409 \endgroup
412 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
414 %% These are used to keep @begin/@end levels from running away
415 %% Call \inENV within environments (after a \begingroup)
416 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
417 \def\ENVcheck{%
418 \ifENV\errmessage{Still within an environment; press RETURN to continue}
419 \endgroup\fi} % This is not perfect, but it should reduce lossage
421 % @begin foo is the same as @foo, for now.
422 \newhelp\EMsimple{Press RETURN to continue.}
424 \outer\def\begin{\parsearg\beginxxx}
426 \def\beginxxx #1{%
427 \expandafter\ifx\csname #1\endcsname\relax
428 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
429 \csname #1\endcsname\fi}
431 % @end foo executes the definition of \Efoo.
433 \def\end{\parsearg\endxxx}
434 \def\endxxx #1{%
435 \removeactivespaces{#1}%
436 \edef\endthing{\the\toks0}%
438 \expandafter\ifx\csname E\endthing\endcsname\relax
439 \expandafter\ifx\csname \endthing\endcsname\relax
440 % There's no \foo, i.e., no ``environment'' foo.
441 \errhelp = \EMsimple
442 \errmessage{Undefined command `@end \endthing'}%
443 \else
444 \unmatchedenderror\endthing
446 \else
447 % Everything's ok; the right environment has been started.
448 \csname E\endthing\endcsname
452 % There is an environment #1, but it hasn't been started. Give an error.
454 \def\unmatchedenderror#1{%
455 \errhelp = \EMsimple
456 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
459 % Define the control sequence \E#1 to give an unmatched @end error.
461 \def\defineunmatchedend#1{%
462 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
466 %% Simple single-character @ commands
468 % @@ prints an @
469 % Kludge this until the fonts are right (grr).
470 \def\@{{\tt\char64}}
472 % This is turned off because it was never documented
473 % and you can use @w{...} around a quote to suppress ligatures.
474 %% Define @` and @' to be the same as ` and '
475 %% but suppressing ligatures.
476 %\def\`{{`}}
477 %\def\'{{'}}
479 % Used to generate quoted braces.
480 \def\mylbrace {{\tt\char123}}
481 \def\myrbrace {{\tt\char125}}
482 \let\{=\mylbrace
483 \let\}=\myrbrace
484 \begingroup
485 % Definitions to produce \{ and \} commands for indices,
486 % and @{ and @} for the aux file.
487 \catcode`\{ = \other \catcode`\} = \other
488 \catcode`\[ = 1 \catcode`\] = 2
489 \catcode`\! = 0 \catcode`\\ = \other
490 !gdef!lbracecmd[\{]%
491 !gdef!rbracecmd[\}]%
492 !gdef!lbraceatcmd[@{]%
493 !gdef!rbraceatcmd[@}]%
494 !endgroup
496 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
497 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
498 \let\, = \c
499 \let\dotaccent = \.
500 \def\ringaccent#1{{\accent23 #1}}
501 \let\tieaccent = \t
502 \let\ubaraccent = \b
503 \let\udotaccent = \d
505 % Other special characters: @questiondown @exclamdown
506 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
507 \def\questiondown{?`}
508 \def\exclamdown{!`}
510 % Dotless i and dotless j, used for accents.
511 \def\imacro{i}
512 \def\jmacro{j}
513 \def\dotless#1{%
514 \def\temp{#1}%
515 \ifx\temp\imacro \ptexi
516 \else\ifx\temp\jmacro \j
517 \else \errmessage{@dotless can be used only with i or j}%
518 \fi\fi
521 % Be sure we're in horizontal mode when doing a tie, since we make space
522 % equivalent to this in @example-like environments. Otherwise, a space
523 % at the beginning of a line will start with \penalty -- and
524 % since \penalty is valid in vertical mode, we'd end up putting the
525 % penalty on the vertical list instead of in the new paragraph.
526 {\catcode`@ = 11
527 % Avoid using \@M directly, because that causes trouble
528 % if the definition is written into an index file.
529 \global\let\tiepenalty = \@M
530 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
533 % @: forces normal size whitespace following.
534 \def\:{\spacefactor=1000 }
536 % @* forces a line break.
537 \def\*{\hfil\break\hbox{}\ignorespaces}
539 % @. is an end-of-sentence period.
540 \def\.{.\spacefactor=3000 }
542 % @! is an end-of-sentence bang.
543 \def\!{!\spacefactor=3000 }
545 % @? is an end-of-sentence query.
546 \def\?{?\spacefactor=3000 }
548 % @w prevents a word break. Without the \leavevmode, @w at the
549 % beginning of a paragraph, when TeX is still in vertical mode, would
550 % produce a whole line of output instead of starting the paragraph.
551 \def\w#1{\leavevmode\hbox{#1}}
553 % @group ... @end group forces ... to be all on one page, by enclosing
554 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
555 % to keep its height that of a normal line. According to the rules for
556 % \topskip (p.114 of the TeXbook), the glue inserted is
557 % max (\topskip - \ht (first item), 0). If that height is large,
558 % therefore, no glue is inserted, and the space between the headline and
559 % the text is small, which looks bad.
561 % Another complication is that the group might be very large. This can
562 % cause the glue on the previous page to be unduly stretched, because it
563 % does not have much material. In this case, it's better to add an
564 % explicit \vfill so that the extra space is at the bottom. The
565 % threshold for doing this is if the group is more than \vfilllimit
566 % percent of a page (\vfilllimit can be changed inside of @tex).
568 \newbox\groupbox
569 \def\vfilllimit{0.7}
571 \def\group{\begingroup
572 \ifnum\catcode13=\active \else
573 \errhelp = \groupinvalidhelp
574 \errmessage{@group invalid in context where filling is enabled}%
577 % The \vtop we start below produces a box with normal height and large
578 % depth; thus, TeX puts \baselineskip glue before it, and (when the
579 % next line of text is done) \lineskip glue after it. (See p.82 of
580 % the TeXbook.) Thus, space below is not quite equal to space
581 % above. But it's pretty close.
582 \def\Egroup{%
583 \egroup % End the \vtop.
584 % \dimen0 is the vertical size of the group's box.
585 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
586 % \dimen2 is how much space is left on the page (more or less).
587 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
588 % if the group doesn't fit on the current page, and it's a big big
589 % group, force a page break.
590 \ifdim \dimen0 > \dimen2
591 \ifdim \pagetotal < \vfilllimit\pageheight
592 \page
595 \copy\groupbox
596 \endgroup % End the \group.
599 \setbox\groupbox = \vtop\bgroup
600 % We have to put a strut on the last line in case the @group is in
601 % the midst of an example, rather than completely enclosing it.
602 % Otherwise, the interline space between the last line of the group
603 % and the first line afterwards is too small. But we can't put the
604 % strut in \Egroup, since there it would be on a line by itself.
605 % Hence this just inserts a strut at the beginning of each line.
606 \everypar = {\strut}%
608 % Since we have a strut on every line, we don't need any of TeX's
609 % normal interline spacing.
610 \offinterlineskip
612 % OK, but now we have to do something about blank
613 % lines in the input in @example-like environments, which normally
614 % just turn into \lisppar, which will insert no space now that we've
615 % turned off the interline space. Simplest is to make them be an
616 % empty paragraph.
617 \ifx\par\lisppar
618 \edef\par{\leavevmode \par}%
620 % Reset ^^M's definition to new definition of \par.
621 \obeylines
624 % Do @comment since we are called inside an environment such as
625 % @example, where each end-of-line in the input causes an
626 % end-of-line in the output. We don't want the end-of-line after
627 % the `@group' to put extra space in the output. Since @group
628 % should appear on a line by itself (according to the Texinfo
629 % manual), we don't worry about eating any user text.
630 \comment
633 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
634 % message, so this ends up printing `@group can only ...'.
636 \newhelp\groupinvalidhelp{%
637 group can only be used in environments such as @example,^^J%
638 where each line of input produces a line of output.}
640 % @need space-in-mils
641 % forces a page break if there is not space-in-mils remaining.
643 \newdimen\mil \mil=0.001in
645 \def\need{\parsearg\needx}
647 % Old definition--didn't work.
648 %\def\needx #1{\par %
649 %% This method tries to make TeX break the page naturally
650 %% if the depth of the box does not fit.
651 %{\baselineskip=0pt%
652 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
653 %\prevdepth=-1000pt
656 \def\needx#1{%
657 % Ensure vertical mode, so we don't make a big box in the middle of a
658 % paragraph.
659 \par
661 % If the @need value is less than one line space, it's useless.
662 \dimen0 = #1\mil
663 \dimen2 = \ht\strutbox
664 \advance\dimen2 by \dp\strutbox
665 \ifdim\dimen0 > \dimen2
667 % Do a \strut just to make the height of this box be normal, so the
668 % normal leading is inserted relative to the preceding line.
669 % And a page break here is fine.
670 \vtop to #1\mil{\strut\vfil}%
672 % TeX does not even consider page breaks if a penalty added to the
673 % main vertical list is 10000 or more. But in order to see if the
674 % empty box we just added fits on the page, we must make it consider
675 % page breaks. On the other hand, we don't want to actually break the
676 % page after the empty box. So we use a penalty of 9999.
678 % There is an extremely small chance that TeX will actually break the
679 % page at this \penalty, if there are no other feasible breakpoints in
680 % sight. (If the user is using lots of big @group commands, which
681 % almost-but-not-quite fill up a page, TeX will have a hard time doing
682 % good page breaking, for example.) However, I could not construct an
683 % example where a page broke at this \penalty; if it happens in a real
684 % document, then we can reconsider our strategy.
685 \penalty9999
687 % Back up by the size of the box, whether we did a page break or not.
688 \kern -#1\mil
690 % Do not allow a page break right after this kern.
691 \nobreak
695 % @br forces paragraph break
697 \let\br = \par
699 % @dots{} output an ellipsis using the current font.
700 % We do .5em per period so that it has the same spacing in a typewriter
701 % font as three actual period characters.
703 \def\dots{%
704 \leavevmode
705 \hbox to 1.5em{%
706 \hskip 0pt plus 0.25fil minus 0.25fil
707 .\hss.\hss.%
708 \hskip 0pt plus 0.5fil minus 0.5fil
712 % @enddots{} is an end-of-sentence ellipsis.
714 \def\enddots{%
715 \leavevmode
716 \hbox to 2em{%
717 \hskip 0pt plus 0.25fil minus 0.25fil
718 .\hss.\hss.\hss.%
719 \hskip 0pt plus 0.5fil minus 0.5fil
721 \spacefactor=3000
724 % @page forces the start of a new page.
726 \def\page{\par\vfill\supereject}
728 % @exdent text....
729 % outputs text on separate line in roman font, starting at standard page margin
731 % This records the amount of indent in the innermost environment.
732 % That's how much \exdent should take out.
733 \newskip\exdentamount
735 % This defn is used inside fill environments such as @defun.
736 \def\exdent{\parsearg\exdentyyy}
737 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
739 % This defn is used inside nofill environments such as @example.
740 \def\nofillexdent{\parsearg\nofillexdentyyy}
741 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
742 \leftline{\hskip\leftskip{\rm#1}}}}
744 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
745 % paragraph. For more general purposes, use the \margin insertion
746 % class. WHICH is `l' or `r'.
748 \newskip\inmarginspacing \inmarginspacing=1cm
749 \def\strutdepth{\dp\strutbox}
751 \def\doinmargin#1#2{\strut\vadjust{%
752 \nobreak
753 \kern-\strutdepth
754 \vtop to \strutdepth{%
755 \baselineskip=\strutdepth
756 \vss
757 % if you have multiple lines of stuff to put here, you'll need to
758 % make the vbox yourself of the appropriate size.
759 \ifx#1l%
760 \llap{\ignorespaces #2\hskip\inmarginspacing}%
761 \else
762 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
764 \null
767 \def\inleftmargin{\doinmargin l}
768 \def\inrightmargin{\doinmargin r}
770 % @inmargin{TEXT [, RIGHT-TEXT]}
771 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
772 % else use TEXT for both).
774 \def\inmargin#1{\parseinmargin #1,,\finish}
775 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
776 \setbox0 = \hbox{\ignorespaces #2}%
777 \ifdim\wd0 > 0pt
778 \def\lefttext{#1}% have both texts
779 \def\righttext{#2}%
780 \else
781 \def\lefttext{#1}% have only one text
782 \def\righttext{#1}%
785 \ifodd\pageno
786 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
787 \else
788 \def\temp{\inleftmargin\lefttext}%
790 \temp
793 % @include file insert text of that file as input.
794 % Allow normal characters that we make active in the argument (a file name).
795 \def\include{\begingroup
796 \catcode`\\=\other
797 \catcode`~=\other
798 \catcode`^=\other
799 \catcode`_=\other
800 \catcode`|=\other
801 \catcode`<=\other
802 \catcode`>=\other
803 \catcode`+=\other
804 \parsearg\includezzz}
805 % Restore active chars for included file.
806 \def\includezzz#1{\endgroup\begingroup
807 % Read the included file in a group so nested @include's work.
808 \def\thisfile{#1}%
809 \let\value=\expandablevalue
810 \input\thisfile
811 \endgroup}
813 \def\thisfile{}
815 % @center line
816 % outputs that line, centered.
818 \def\center{\parsearg\docenter}
819 \def\docenter#1{{%
820 \ifhmode \hfil\break \fi
821 \advance\hsize by -\leftskip
822 \advance\hsize by -\rightskip
823 \line{\hfil \ignorespaces#1\unskip \hfil}%
824 \ifhmode \break \fi
827 % @sp n outputs n lines of vertical space
829 \def\sp{\parsearg\spxxx}
830 \def\spxxx #1{\vskip #1\baselineskip}
832 % @comment ...line which is ignored...
833 % @c is the same as @comment
834 % @ignore ... @end ignore is another way to write a comment
836 \def\comment{\begingroup \catcode`\^^M=\other%
837 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
838 \commentxxx}
839 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
841 \let\c=\comment
843 % @paragraphindent NCHARS
844 % We'll use ems for NCHARS, close enough.
845 % We cannot implement @paragraphindent asis, though.
847 \def\asisword{asis} % no translation, these are keywords
848 \def\noneword{none}
850 \def\paragraphindent{\parsearg\doparagraphindent}
851 \def\doparagraphindent#1{%
852 \def\temp{#1}%
853 \ifx\temp\asisword
854 \else
855 \ifx\temp\noneword
856 \defaultparindent = 0pt
857 \else
858 \defaultparindent = #1em
861 \parindent = \defaultparindent
864 % @exampleindent NCHARS
865 % We'll use ems for NCHARS like @paragraphindent.
866 % It seems @exampleindent asis isn't necessary, but
867 % I preserve it to make it similar to @paragraphindent.
868 \def\exampleindent{\parsearg\doexampleindent}
869 \def\doexampleindent#1{%
870 \def\temp{#1}%
871 \ifx\temp\asisword
872 \else
873 \ifx\temp\noneword
874 \lispnarrowing = 0pt
875 \else
876 \lispnarrowing = #1em
881 % @asis just yields its argument. Used with @table, for example.
883 \def\asis#1{#1}
885 % @math outputs its argument in math mode.
886 % We don't use $'s directly in the definition of \math because we need
887 % to set catcodes according to plain TeX first, to allow for subscripts,
888 % superscripts, special math chars, etc.
890 \let\implicitmath = $%$ font-lock fix
892 % One complication: _ usually means subscripts, but it could also mean
893 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
894 % _ within @math be active (mathcode "8000), and distinguish by seeing
895 % if the current family is \slfam, which is what @var uses.
897 {\catcode\underChar = \active
898 \gdef\mathunderscore{%
899 \catcode\underChar=\active
900 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
903 % Another complication: we want \\ (and @\) to output a \ character.
904 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
905 % this is not advertised and we don't care. Texinfo does not
906 % otherwise define @\.
908 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
909 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
911 \def\math{%
912 \tex
913 \mathcode`\_="8000 \mathunderscore
914 \let\\ = \mathbackslash
915 \mathactive
916 \implicitmath\finishmath}
917 \def\finishmath#1{#1\implicitmath\Etex}
919 % Some active characters (such as <) are spaced differently in math.
920 % We have to reset their definitions in case the @math was an
921 % argument to a command which set the catcodes (such as @item or @section).
924 \catcode`^ = \active
925 \catcode`< = \active
926 \catcode`> = \active
927 \catcode`+ = \active
928 \gdef\mathactive{%
929 \let^ = \ptexhat
930 \let< = \ptexless
931 \let> = \ptexgtr
932 \let+ = \ptexplus
936 % @bullet and @minus need the same treatment as @math, just above.
937 \def\bullet{\implicitmath\ptexbullet\implicitmath}
938 \def\minus{\implicitmath-\implicitmath}
940 % @refill is a no-op.
941 \let\refill=\relax
943 % If working on a large document in chapters, it is convenient to
944 % be able to disable indexing, cross-referencing, and contents, for test runs.
945 % This is done with @novalidate (before @setfilename).
947 \newif\iflinks \linkstrue % by default we want the aux files.
948 \let\novalidate = \linksfalse
950 % @setfilename is done at the beginning of every texinfo file.
951 % So open here the files we need to have open while reading the input.
952 % This makes it possible to make a .fmt file for texinfo.
953 \def\setfilename{%
954 \iflinks
955 \readauxfile
956 \fi % \openindices needs to do some work in any case.
957 \openindices
958 \fixbackslash % Turn off hack to swallow `\input texinfo'.
959 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
961 % If texinfo.cnf is present on the system, read it.
962 % Useful for site-wide @afourpaper, etc.
963 % Just to be on the safe side, close the input stream before the \input.
964 \openin 1 texinfo.cnf
965 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi
966 \closein1
967 \temp
969 \comment % Ignore the actual filename.
972 % Called from \setfilename.
974 \def\openindices{%
975 \newindex{cp}%
976 \newcodeindex{fn}%
977 \newcodeindex{vr}%
978 \newcodeindex{tp}%
979 \newcodeindex{ky}%
980 \newcodeindex{pg}%
983 % @bye.
984 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
987 \message{pdf,}
988 % adobe `portable' document format
989 \newcount\tempnum
990 \newcount\lnkcount
991 \newtoks\filename
992 \newcount\filenamelength
993 \newcount\pgn
994 \newtoks\toksA
995 \newtoks\toksB
996 \newtoks\toksC
997 \newtoks\toksD
998 \newbox\boxA
999 \newcount\countA
1000 \newif\ifpdf
1001 \newif\ifpdfmakepagedest
1003 \ifx\pdfoutput\undefined
1004 \pdffalse
1005 \let\pdfmkdest = \gobble
1006 \let\pdfurl = \gobble
1007 \let\endlink = \relax
1008 \let\linkcolor = \relax
1009 \let\pdfmakeoutlines = \relax
1010 \else
1011 \pdftrue
1012 \pdfoutput = 1
1013 \input pdfcolor
1014 \def\dopdfimage#1#2#3{%
1015 \def\imagewidth{#2}%
1016 \def\imageheight{#3}%
1017 % without \immediate, pdftex seg faults when the same image is
1018 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1019 \ifnum\pdftexversion < 14
1020 \immediate\pdfimage
1021 \else
1022 \immediate\pdfximage
1024 \ifx\empty\imagewidth\else width \imagewidth \fi
1025 \ifx\empty\imageheight\else height \imageheight \fi
1026 \ifnum\pdftexversion<13
1027 #1.pdf%
1028 \else
1029 {#1.pdf}%
1031 \ifnum\pdftexversion < 14 \else
1032 \pdfrefximage \pdflastximage
1033 \fi}
1034 \def\pdfmkdest#1{{\normalturnoffactive \pdfdest name{#1} xyz}}
1035 \def\pdfmkpgn#1{#1}
1036 \let\linkcolor = \Blue % was Cyan, but that seems light?
1037 \def\endlink{\Black\pdfendlink}
1038 % Adding outlines to PDF; macros for calculating structure of outlines
1039 % come from Petr Olsak
1040 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1041 \else \csname#1\endcsname \fi}
1042 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1043 \advance\tempnum by1
1044 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1045 \def\pdfmakeoutlines{{%
1046 \openin 1 \jobname.toc
1047 \ifeof 1\else\begingroup
1048 \closein 1
1049 % Thanh's hack / proper braces in bookmarks
1050 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1051 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1053 \def\chapentry ##1##2##3{}
1054 \def\secentry ##1##2##3##4{\advancenumber{chap##2}}
1055 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}}
1056 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}}
1057 \let\appendixentry = \chapentry
1058 \let\unnumbchapentry = \chapentry
1059 \let\unnumbsecentry = \secentry
1060 \let\unnumbsubsecentry = \subsecentry
1061 \let\unnumbsubsubsecentry = \subsubsecentry
1062 \input \jobname.toc
1063 \def\chapentry ##1##2##3{%
1064 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}}
1065 \def\secentry ##1##2##3##4{%
1066 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}}
1067 \def\subsecentry ##1##2##3##4##5{%
1068 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}}
1069 \def\subsubsecentry ##1##2##3##4##5##6{%
1070 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}}
1071 \let\appendixentry = \chapentry
1072 \let\unnumbchapentry = \chapentry
1073 \let\unnumbsecentry = \secentry
1074 \let\unnumbsubsecentry = \subsecentry
1075 \let\unnumbsubsubsecentry = \subsubsecentry
1077 % Make special characters normal for writing to the pdf file.
1079 \indexnofonts
1080 \let\tt=\relax
1081 \turnoffactive
1082 \input \jobname.toc
1083 \endgroup\fi
1085 \def\makelinks #1,{%
1086 \def\params{#1}\def\E{END}%
1087 \ifx\params\E
1088 \let\nextmakelinks=\relax
1089 \else
1090 \let\nextmakelinks=\makelinks
1091 \ifnum\lnkcount>0,\fi
1092 \picknum{#1}%
1093 \startlink attr{/Border [0 0 0]}
1094 goto name{\pdfmkpgn{\the\pgn}}%
1095 \linkcolor #1%
1096 \advance\lnkcount by 1%
1097 \endlink
1099 \nextmakelinks
1101 \def\picknum#1{\expandafter\pn#1}
1102 \def\pn#1{%
1103 \def\p{#1}%
1104 \ifx\p\lbrace
1105 \let\nextpn=\ppn
1106 \else
1107 \let\nextpn=\ppnn
1108 \def\first{#1}
1110 \nextpn
1112 \def\ppn#1{\pgn=#1\gobble}
1113 \def\ppnn{\pgn=\first}
1114 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1115 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1116 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1117 \ifx\PP\D\let\nextsp\relax
1118 \else\let\nextsp\skipspaces
1119 \ifx\p\space\else\addtokens{\filename}{\PP}%
1120 \advance\filenamelength by 1
1123 \nextsp}
1124 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1125 \ifnum\pdftexversion < 14
1126 \let \startlink \pdfannotlink
1127 \else
1128 \let \startlink \pdfstartlink
1130 \def\pdfurl#1{%
1131 \begingroup
1132 \normalturnoffactive\def\@{@}%
1133 \let\value=\expandablevalue
1134 \leavevmode\Red
1135 \startlink attr{/Border [0 0 0]}%
1136 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1137 % #1
1138 \endgroup}
1139 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1140 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1141 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1142 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1143 \def\maketoks{%
1144 \expandafter\poptoks\the\toksA|ENDTOKS|
1145 \ifx\first0\adn0
1146 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1147 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1148 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1149 \else
1150 \ifnum0=\countA\else\makelink\fi
1151 \ifx\first.\let\next=\done\else
1152 \let\next=\maketoks
1153 \addtokens{\toksB}{\the\toksD}
1154 \ifx\first,\addtokens{\toksB}{\space}\fi
1156 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1157 \next}
1158 \def\makelink{\addtokens{\toksB}%
1159 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1160 \def\pdflink#1{%
1161 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1162 \linkcolor #1\endlink}
1163 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1164 \fi % \ifx\pdfoutput
1167 \message{fonts,}
1168 % Font-change commands.
1170 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1171 % So we set up a \sf analogous to plain's \rm, etc.
1172 \newfam\sffam
1173 \def\sf{\fam=\sffam \tensf}
1174 \let\li = \sf % Sometimes we call it \li, not \sf.
1176 % We don't need math for this one.
1177 \def\ttsl{\tenttsl}
1179 % Default leading.
1180 \newdimen\textleading \textleading = 13.2pt
1182 % Set the baselineskip to #1, and the lineskip and strut size
1183 % correspondingly. There is no deep meaning behind these magic numbers
1184 % used as factors; they just match (closely enough) what Knuth defined.
1186 \def\lineskipfactor{.08333}
1187 \def\strutheightpercent{.70833}
1188 \def\strutdepthpercent {.29167}
1190 \def\setleading#1{%
1191 \normalbaselineskip = #1\relax
1192 \normallineskip = \lineskipfactor\normalbaselineskip
1193 \normalbaselines
1194 \setbox\strutbox =\hbox{%
1195 \vrule width0pt height\strutheightpercent\baselineskip
1196 depth \strutdepthpercent \baselineskip
1200 % Set the font macro #1 to the font named #2, adding on the
1201 % specified font prefix (normally `cm').
1202 % #3 is the font's design size, #4 is a scale factor
1203 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1205 % Use cm as the default font prefix.
1206 % To specify the font prefix, you must define \fontprefix
1207 % before you read in texinfo.tex.
1208 \ifx\fontprefix\undefined
1209 \def\fontprefix{cm}
1211 % Support font families that don't use the same naming scheme as CM.
1212 \def\rmshape{r}
1213 \def\rmbshape{bx} %where the normal face is bold
1214 \def\bfshape{b}
1215 \def\bxshape{bx}
1216 \def\ttshape{tt}
1217 \def\ttbshape{tt}
1218 \def\ttslshape{sltt}
1219 \def\itshape{ti}
1220 \def\itbshape{bxti}
1221 \def\slshape{sl}
1222 \def\slbshape{bxsl}
1223 \def\sfshape{ss}
1224 \def\sfbshape{ss}
1225 \def\scshape{csc}
1226 \def\scbshape{csc}
1228 \newcount\mainmagstep
1229 \ifx\bigger\relax
1230 % not really supported.
1231 \mainmagstep=\magstep1
1232 \setfont\textrm\rmshape{12}{1000}
1233 \setfont\texttt\ttshape{12}{1000}
1234 \else
1235 \mainmagstep=\magstephalf
1236 \setfont\textrm\rmshape{10}{\mainmagstep}
1237 \setfont\texttt\ttshape{10}{\mainmagstep}
1239 % Instead of cmb10, you may want to use cmbx10.
1240 % cmbx10 is a prettier font on its own, but cmb10
1241 % looks better when embedded in a line with cmr10
1242 % (in Bob's opinion).
1243 \setfont\textbf\bfshape{10}{\mainmagstep}
1244 \setfont\textit\itshape{10}{\mainmagstep}
1245 \setfont\textsl\slshape{10}{\mainmagstep}
1246 \setfont\textsf\sfshape{10}{\mainmagstep}
1247 \setfont\textsc\scshape{10}{\mainmagstep}
1248 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1249 \font\texti=cmmi10 scaled \mainmagstep
1250 \font\textsy=cmsy10 scaled \mainmagstep
1252 % A few fonts for @defun, etc.
1253 \setfont\defbf\bxshape{10}{\magstep1} %was 1314
1254 \setfont\deftt\ttshape{10}{\magstep1}
1255 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
1257 % Fonts for indices, footnotes, small examples (9pt).
1258 \setfont\smallrm\rmshape{9}{1000}
1259 \setfont\smalltt\ttshape{9}{1000}
1260 \setfont\smallbf\bfshape{10}{900}
1261 \setfont\smallit\itshape{9}{1000}
1262 \setfont\smallsl\slshape{9}{1000}
1263 \setfont\smallsf\sfshape{9}{1000}
1264 \setfont\smallsc\scshape{10}{900}
1265 \setfont\smallttsl\ttslshape{10}{900}
1266 \font\smalli=cmmi9
1267 \font\smallsy=cmsy9
1269 % Fonts for small examples (8pt).
1270 \setfont\smallerrm\rmshape{8}{1000}
1271 \setfont\smallertt\ttshape{8}{1000}
1272 \setfont\smallerbf\bfshape{10}{800}
1273 \setfont\smallerit\itshape{8}{1000}
1274 \setfont\smallersl\slshape{8}{1000}
1275 \setfont\smallersf\sfshape{8}{1000}
1276 \setfont\smallersc\scshape{10}{800}
1277 \setfont\smallerttsl\ttslshape{10}{800}
1278 \font\smalleri=cmmi8
1279 \font\smallersy=cmsy8
1281 % Fonts for title page:
1282 \setfont\titlerm\rmbshape{12}{\magstep3}
1283 \setfont\titleit\itbshape{10}{\magstep4}
1284 \setfont\titlesl\slbshape{10}{\magstep4}
1285 \setfont\titlett\ttbshape{12}{\magstep3}
1286 \setfont\titlettsl\ttslshape{10}{\magstep4}
1287 \setfont\titlesf\sfbshape{17}{\magstep1}
1288 \let\titlebf=\titlerm
1289 \setfont\titlesc\scbshape{10}{\magstep4}
1290 \font\titlei=cmmi12 scaled \magstep3
1291 \font\titlesy=cmsy10 scaled \magstep4
1292 \def\authorrm{\secrm}
1293 \def\authortt{\sectt}
1295 % Chapter (and unnumbered) fonts (17.28pt).
1296 \setfont\chaprm\rmbshape{12}{\magstep2}
1297 \setfont\chapit\itbshape{10}{\magstep3}
1298 \setfont\chapsl\slbshape{10}{\magstep3}
1299 \setfont\chaptt\ttbshape{12}{\magstep2}
1300 \setfont\chapttsl\ttslshape{10}{\magstep3}
1301 \setfont\chapsf\sfbshape{17}{1000}
1302 \let\chapbf=\chaprm
1303 \setfont\chapsc\scbshape{10}{\magstep3}
1304 \font\chapi=cmmi12 scaled \magstep2
1305 \font\chapsy=cmsy10 scaled \magstep3
1307 % Section fonts (14.4pt).
1308 \setfont\secrm\rmbshape{12}{\magstep1}
1309 \setfont\secit\itbshape{10}{\magstep2}
1310 \setfont\secsl\slbshape{10}{\magstep2}
1311 \setfont\sectt\ttbshape{12}{\magstep1}
1312 \setfont\secttsl\ttslshape{10}{\magstep2}
1313 \setfont\secsf\sfbshape{12}{\magstep1}
1314 \let\secbf\secrm
1315 \setfont\secsc\scbshape{10}{\magstep2}
1316 \font\seci=cmmi12 scaled \magstep1
1317 \font\secsy=cmsy10 scaled \magstep2
1319 % Subsection fonts (13.15pt).
1320 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1321 \setfont\ssecit\itbshape{10}{1315}
1322 \setfont\ssecsl\slbshape{10}{1315}
1323 \setfont\ssectt\ttbshape{12}{\magstephalf}
1324 \setfont\ssecttsl\ttslshape{10}{1315}
1325 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1326 \let\ssecbf\ssecrm
1327 \setfont\ssecsc\scbshape{10}{\magstep1}
1328 \font\sseci=cmmi12 scaled \magstephalf
1329 \font\ssecsy=cmsy10 scaled 1315
1330 % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
1331 % but that is not a standard magnification.
1333 % In order for the font changes to affect most math symbols and letters,
1334 % we have to define the \textfont of the standard families. Since
1335 % texinfo doesn't allow for producing subscripts and superscripts except
1336 % in the main text, we don't bother to reset \scriptfont and
1337 % \scriptscriptfont (which would also require loading a lot more fonts).
1339 \def\resetmathfonts{%
1340 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1341 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1342 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1345 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1346 % of just \STYLE. We do this so that font changes will continue to work
1347 % in math mode, where it is the current \fam that is relevant in most
1348 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam
1349 % \tenbf}, for example. By redefining \tenbf, we obviate the need to
1350 % redefine \bf itself.
1351 \def\textfonts{%
1352 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1353 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1354 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl
1355 \resetmathfonts \setleading{\textleading}}
1356 \def\titlefonts{%
1357 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1358 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1359 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1360 \let\tenttsl=\titlettsl
1361 \resetmathfonts \setleading{25pt}}
1362 \def\titlefont#1{{\titlefonts\rm #1}}
1363 \def\chapfonts{%
1364 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1365 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1366 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1367 \resetmathfonts \setleading{19pt}}
1368 \def\secfonts{%
1369 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1370 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1371 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl
1372 \resetmathfonts \setleading{16pt}}
1373 \def\subsecfonts{%
1374 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1375 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1376 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl
1377 \resetmathfonts \setleading{15pt}}
1378 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf?
1379 \def\smallfonts{%
1380 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1381 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1382 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1383 \let\tenttsl=\smallttsl
1384 \resetmathfonts \setleading{10.5pt}}
1385 \def\smallerfonts{%
1386 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1387 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1388 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1389 \let\tenttsl=\smallerttsl
1390 \resetmathfonts \setleading{9.5pt}}
1392 % Set the fonts to use with the @small... environments.
1393 \let\smallexamplefonts = \smallfonts
1395 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1396 % can fit this many characters:
1397 % 8.5x11=86 smallbook=72 a4=90 a5=69
1398 % If we use \smallerfonts (8pt), then we can fit this many characters:
1399 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1400 % For me, subjectively, the few extra characters that fit aren't worth
1401 % the additional smallness of 8pt. So I'm making the default 9pt.
1403 % By the way, for comparison, here's what fits with @example (10pt):
1404 % 8.5x11=71 smallbook=60 a4=75 a5=58
1406 % I wish we used A4 paper on this side of the Atlantic.
1408 % --karl, 24jan03.
1411 % Set up the default fonts, so we can use them for creating boxes.
1413 \textfonts
1415 % Define these so they can be easily changed for other fonts.
1416 \def\angleleft{$\langle$}
1417 \def\angleright{$\rangle$}
1419 % Count depth in font-changes, for error checks
1420 \newcount\fontdepth \fontdepth=0
1422 % Fonts for short table of contents.
1423 \setfont\shortcontrm\rmshape{12}{1000}
1424 \setfont\shortcontbf\bxshape{12}{1000}
1425 \setfont\shortcontsl\slshape{12}{1000}
1426 \setfont\shortconttt\ttshape{12}{1000}
1428 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1429 %% serif) and @ii for TeX italic
1431 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1432 % unless the following character is such as not to need one.
1433 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1434 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1435 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1437 \let\i=\smartitalic
1438 \let\var=\smartslanted
1439 \let\dfn=\smartslanted
1440 \let\emph=\smartitalic
1441 \let\cite=\smartslanted
1443 \def\b#1{{\bf #1}}
1444 \let\strong=\b
1446 % We can't just use \exhyphenpenalty, because that only has effect at
1447 % the end of a paragraph. Restore normal hyphenation at the end of the
1448 % group within which \nohyphenation is presumably called.
1450 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1451 \def\restorehyphenation{\hyphenchar\font = `- }
1453 % Set sfcode to normal for the chars that usually have another value.
1454 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1455 % sometimes \x has an active definition that messes things up.
1457 \catcode`@=11
1458 \def\frenchspacing{%
1459 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1460 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1462 \catcode`@=\other
1464 \def\t#1{%
1465 {\tt \rawbackslash \frenchspacing #1}%
1466 \null
1468 \let\ttfont=\t
1469 \def\samp#1{`\tclose{#1}'\null}
1470 \setfont\keyrm\rmshape{8}{1000}
1471 \font\keysy=cmsy9
1472 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1473 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1474 \vbox{\hrule\kern-0.4pt
1475 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1476 \kern-0.4pt\hrule}%
1477 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1478 % The old definition, with no lozenge:
1479 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1480 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1482 % @file, @option are the same as @samp.
1483 \let\file=\samp
1484 \let\option=\samp
1486 % @code is a modification of @t,
1487 % which makes spaces the same size as normal in the surrounding text.
1488 \def\tclose#1{%
1490 % Change normal interword space to be same as for the current font.
1491 \spaceskip = \fontdimen2\font
1493 % Switch to typewriter.
1496 % But `\ ' produces the large typewriter interword space.
1497 \def\ {{\spaceskip = 0pt{} }}%
1499 % Turn off hyphenation.
1500 \nohyphenation
1502 \rawbackslash
1503 \frenchspacing
1506 \null
1509 % We *must* turn on hyphenation at `-' and `_' in \code.
1510 % Otherwise, it is too hard to avoid overfull hboxes
1511 % in the Emacs manual, the Library manual, etc.
1513 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1514 % both hyphenation at - and hyphenation within words.
1515 % We must therefore turn them both off (\tclose does that)
1516 % and arrange explicitly to hyphenate at a dash.
1517 % -- rms.
1519 \catcode`\-=\active
1520 \catcode`\_=\active
1522 \global\def\code{\begingroup
1523 \catcode`\-=\active \let-\codedash
1524 \catcode`\_=\active \let_\codeunder
1525 \codex
1528 % If we end up with any active - characters when handling the index,
1529 % just treat them as a normal -.
1530 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1533 \def\realdash{-}
1534 \def\codedash{-\discretionary{}{}{}}
1535 \def\codeunder{%
1536 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1537 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1538 % will therefore expand the active definition of _, which is us
1539 % (inside @code that is), therefore an endless loop.
1540 \ifusingtt{\ifmmode
1541 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1542 \else\normalunderscore \fi
1543 \discretionary{}{}{}}%
1544 {\_}%
1546 \def\codex #1{\tclose{#1}\endgroup}
1548 % @kbd is like @code, except that if the argument is just one @key command,
1549 % then @kbd has no effect.
1551 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1552 % `example' (@kbd uses ttsl only inside of @example and friends),
1553 % or `code' (@kbd uses normal tty font always).
1554 \def\kbdinputstyle{\parsearg\kbdinputstylexxx}
1555 \def\kbdinputstylexxx#1{%
1556 \def\arg{#1}%
1557 \ifx\arg\worddistinct
1558 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1559 \else\ifx\arg\wordexample
1560 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1561 \else\ifx\arg\wordcode
1562 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1563 \else
1564 \errhelp = \EMsimple
1565 \errmessage{Unknown @kbdinputstyle `\arg'}%
1566 \fi\fi\fi
1568 \def\worddistinct{distinct}
1569 \def\wordexample{example}
1570 \def\wordcode{code}
1572 % Default is `distinct.'
1573 \kbdinputstyle distinct
1575 \def\xkey{\key}
1576 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1577 \ifx\one\xkey\ifx\threex\three \key{#2}%
1578 \else{\tclose{\kbdfont\look}}\fi
1579 \else{\tclose{\kbdfont\look}}\fi}
1581 % For @url, @env, @command quotes seem unnecessary, so use \code.
1582 \let\url=\code
1583 \let\env=\code
1584 \let\command=\code
1586 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1587 % second argument specifying the text to display and an optional third
1588 % arg as text to display instead of (rather than in addition to) the url
1589 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1590 % a hypertex \special here.
1592 \def\uref#1{\douref #1,,,\finish}
1593 \def\douref#1,#2,#3,#4\finish{\begingroup
1594 \unsepspaces
1595 \pdfurl{#1}%
1596 \setbox0 = \hbox{\ignorespaces #3}%
1597 \ifdim\wd0 > 0pt
1598 \unhbox0 % third arg given, show only that
1599 \else
1600 \setbox0 = \hbox{\ignorespaces #2}%
1601 \ifdim\wd0 > 0pt
1602 \ifpdf
1603 \unhbox0 % PDF: 2nd arg given, show only it
1604 \else
1605 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1607 \else
1608 \code{#1}% only url given, so show it
1611 \endlink
1612 \endgroup}
1614 % rms does not like angle brackets --karl, 17may97.
1615 % So now @email is just like @uref, unless we are pdf.
1617 %\def\email#1{\angleleft{\tt #1}\angleright}
1618 \ifpdf
1619 \def\email#1{\doemail#1,,\finish}
1620 \def\doemail#1,#2,#3\finish{\begingroup
1621 \unsepspaces
1622 \pdfurl{mailto:#1}%
1623 \setbox0 = \hbox{\ignorespaces #2}%
1624 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1625 \endlink
1626 \endgroup}
1627 \else
1628 \let\email=\uref
1631 % Check if we are currently using a typewriter font. Since all the
1632 % Computer Modern typewriter fonts have zero interword stretch (and
1633 % shrink), and it is reasonable to expect all typewriter fonts to have
1634 % this property, we can check that font parameter.
1636 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1638 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1639 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1641 \def\dmn#1{\thinspace #1}
1643 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1645 % @l was never documented to mean ``switch to the Lisp font'',
1646 % and it is not used as such in any manual I can find. We need it for
1647 % Polish suppressed-l. --karl, 22sep96.
1648 %\def\l#1{{\li #1}\null}
1650 % Explicit font changes: @r, @sc, undocumented @ii.
1651 \def\r#1{{\rm #1}} % roman font
1652 \def\sc#1{{\smallcaps#1}} % smallcaps font
1653 \def\ii#1{{\it #1}} % italic font
1655 % @acronym downcases the argument and prints in smallcaps.
1656 \def\acronym#1{{\smallcaps \lowercase{#1}}}
1658 % @pounds{} is a sterling sign.
1659 \def\pounds{{\it\$}}
1661 % @registeredsymbol - R in a circle. For now, only works in text size;
1662 % we'd have to redo the font mechanism to change the \scriptstyle and
1663 % \scriptscriptstyle font sizes to make it look right in headings.
1664 % Adapted from the plain.tex definition of \copyright.
1666 \def\registeredsymbol{%
1667 $^{{\ooalign{\hfil\raise.07ex\hbox{$\scriptstyle\rm R$}\hfil\crcr\Orb}}%
1672 \message{page headings,}
1674 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1675 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1677 % First the title page. Must do @settitle before @titlepage.
1678 \newif\ifseenauthor
1679 \newif\iffinishedtitlepage
1681 % Do an implicit @contents or @shortcontents after @end titlepage if the
1682 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1684 \newif\ifsetcontentsaftertitlepage
1685 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1686 \newif\ifsetshortcontentsaftertitlepage
1687 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1689 \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1690 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1691 \endgroup\page\hbox{}\page}
1693 \def\titlepage{\begingroup \parindent=0pt \textfonts
1694 \let\subtitlerm=\tenrm
1695 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1697 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
1698 \let\tt=\authortt}%
1700 % Leave some space at the very top of the page.
1701 \vglue\titlepagetopglue
1703 % Now you can print the title using @title.
1704 \def\title{\parsearg\titlezzz}%
1705 \def\titlezzz##1{\leftline{\titlefonts\rm ##1}
1706 % print a rule at the page bottom also.
1707 \finishedtitlepagefalse
1708 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1709 % No rule at page bottom unless we print one at the top with @title.
1710 \finishedtitlepagetrue
1712 % Now you can put text using @subtitle.
1713 \def\subtitle{\parsearg\subtitlezzz}%
1714 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1716 % @author should come last, but may come many times.
1717 \def\author{\parsearg\authorzzz}%
1718 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1719 {\authorfont \leftline{##1}}}%
1721 % Most title ``pages'' are actually two pages long, with space
1722 % at the top of the second. We don't want the ragged left on the second.
1723 \let\oldpage = \page
1724 \def\page{%
1725 \iffinishedtitlepage\else
1726 \finishtitlepage
1728 \oldpage
1729 \let\page = \oldpage
1730 \hbox{}}%
1731 % \def\page{\oldpage \hbox{}}
1734 \def\Etitlepage{%
1735 \iffinishedtitlepage\else
1736 \finishtitlepage
1738 % It is important to do the page break before ending the group,
1739 % because the headline and footline are only empty inside the group.
1740 % If we use the new definition of \page, we always get a blank page
1741 % after the title page, which we certainly don't want.
1742 \oldpage
1743 \endgroup
1745 % Need this before the \...aftertitlepage checks so that if they are
1746 % in effect the toc pages will come out with page numbers.
1747 \HEADINGSon
1749 % If they want short, they certainly want long too.
1750 \ifsetshortcontentsaftertitlepage
1751 \shortcontents
1752 \contents
1753 \global\let\shortcontents = \relax
1754 \global\let\contents = \relax
1757 \ifsetcontentsaftertitlepage
1758 \contents
1759 \global\let\contents = \relax
1760 \global\let\shortcontents = \relax
1764 \def\finishtitlepage{%
1765 \vskip4pt \hrule height 2pt width \hsize
1766 \vskip\titlepagebottomglue
1767 \finishedtitlepagetrue
1770 %%% Set up page headings and footings.
1772 \let\thispage=\folio
1774 \newtoks\evenheadline % headline on even pages
1775 \newtoks\oddheadline % headline on odd pages
1776 \newtoks\evenfootline % footline on even pages
1777 \newtoks\oddfootline % footline on odd pages
1779 % Now make Tex use those variables
1780 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1781 \else \the\evenheadline \fi}}
1782 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1783 \else \the\evenfootline \fi}\HEADINGShook}
1784 \let\HEADINGShook=\relax
1786 % Commands to set those variables.
1787 % For example, this is what @headings on does
1788 % @evenheading @thistitle|@thispage|@thischapter
1789 % @oddheading @thischapter|@thispage|@thistitle
1790 % @evenfooting @thisfile||
1791 % @oddfooting ||@thisfile
1793 \def\evenheading{\parsearg\evenheadingxxx}
1794 \def\oddheading{\parsearg\oddheadingxxx}
1795 \def\everyheading{\parsearg\everyheadingxxx}
1797 \def\evenfooting{\parsearg\evenfootingxxx}
1798 \def\oddfooting{\parsearg\oddfootingxxx}
1799 \def\everyfooting{\parsearg\everyfootingxxx}
1801 {\catcode`\@=0 %
1803 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1804 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1805 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1807 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1808 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1809 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1811 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1813 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1814 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1815 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1817 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1818 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1819 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1821 % Leave some space for the footline. Hopefully ok to assume
1822 % @evenfooting will not be used by itself.
1823 \global\advance\pageheight by -\baselineskip
1824 \global\advance\vsize by -\baselineskip
1827 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1829 }% unbind the catcode of @.
1831 % @headings double turns headings on for double-sided printing.
1832 % @headings single turns headings on for single-sided printing.
1833 % @headings off turns them off.
1834 % @headings on same as @headings double, retained for compatibility.
1835 % @headings after turns on double-sided headings after this page.
1836 % @headings doubleafter turns on double-sided headings after this page.
1837 % @headings singleafter turns on single-sided headings after this page.
1838 % By default, they are off at the start of a document,
1839 % and turned `on' after @end titlepage.
1841 \def\headings #1 {\csname HEADINGS#1\endcsname}
1843 \def\HEADINGSoff{
1844 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1845 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1846 \HEADINGSoff
1847 % When we turn headings on, set the page number to 1.
1848 % For double-sided printing, put current file name in lower left corner,
1849 % chapter name on inside top of right hand pages, document
1850 % title on inside top of left hand pages, and page numbers on outside top
1851 % edge of all pages.
1852 \def\HEADINGSdouble{
1853 \global\pageno=1
1854 \global\evenfootline={\hfil}
1855 \global\oddfootline={\hfil}
1856 \global\evenheadline={\line{\folio\hfil\thistitle}}
1857 \global\oddheadline={\line{\thischapter\hfil\folio}}
1858 \global\let\contentsalignmacro = \chapoddpage
1860 \let\contentsalignmacro = \chappager
1862 % For single-sided printing, chapter title goes across top left of page,
1863 % page number on top right.
1864 \def\HEADINGSsingle{
1865 \global\pageno=1
1866 \global\evenfootline={\hfil}
1867 \global\oddfootline={\hfil}
1868 \global\evenheadline={\line{\thischapter\hfil\folio}}
1869 \global\oddheadline={\line{\thischapter\hfil\folio}}
1870 \global\let\contentsalignmacro = \chappager
1872 \def\HEADINGSon{\HEADINGSdouble}
1874 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1875 \let\HEADINGSdoubleafter=\HEADINGSafter
1876 \def\HEADINGSdoublex{%
1877 \global\evenfootline={\hfil}
1878 \global\oddfootline={\hfil}
1879 \global\evenheadline={\line{\folio\hfil\thistitle}}
1880 \global\oddheadline={\line{\thischapter\hfil\folio}}
1881 \global\let\contentsalignmacro = \chapoddpage
1884 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1885 \def\HEADINGSsinglex{%
1886 \global\evenfootline={\hfil}
1887 \global\oddfootline={\hfil}
1888 \global\evenheadline={\line{\thischapter\hfil\folio}}
1889 \global\oddheadline={\line{\thischapter\hfil\folio}}
1890 \global\let\contentsalignmacro = \chappager
1893 % Subroutines used in generating headings
1894 % This produces Day Month Year style of output.
1895 % Only define if not already defined, in case a txi-??.tex file has set
1896 % up a different format (e.g., txi-cs.tex does this).
1897 \ifx\today\undefined
1898 \def\today{%
1899 \number\day\space
1900 \ifcase\month
1901 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1902 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1903 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1905 \space\number\year}
1908 % @settitle line... specifies the title of the document, for headings.
1909 % It generates no output of its own.
1910 \def\thistitle{\putwordNoTitle}
1911 \def\settitle{\parsearg\settitlezzz}
1912 \def\settitlezzz #1{\gdef\thistitle{#1}}
1915 \message{tables,}
1916 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1918 % default indentation of table text
1919 \newdimen\tableindent \tableindent=.8in
1920 % default indentation of @itemize and @enumerate text
1921 \newdimen\itemindent \itemindent=.3in
1922 % margin between end of table item and start of table text.
1923 \newdimen\itemmargin \itemmargin=.1in
1925 % used internally for \itemindent minus \itemmargin
1926 \newdimen\itemmax
1928 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1929 % these defs.
1930 % They also define \itemindex
1931 % to index the item name in whatever manner is desired (perhaps none).
1933 \newif\ifitemxneedsnegativevskip
1935 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1937 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1938 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1940 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1941 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1943 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1944 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1946 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1947 \itemzzz {#1}}
1949 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1950 \itemzzz {#1}}
1952 \def\itemzzz #1{\begingroup %
1953 \advance\hsize by -\rightskip
1954 \advance\hsize by -\tableindent
1955 \setbox0=\hbox{\itemfont{#1}}%
1956 \itemindex{#1}%
1957 \nobreak % This prevents a break before @itemx.
1959 % If the item text does not fit in the space we have, put it on a line
1960 % by itself, and do not allow a page break either before or after that
1961 % line. We do not start a paragraph here because then if the next
1962 % command is, e.g., @kindex, the whatsit would get put into the
1963 % horizontal list on a line by itself, resulting in extra blank space.
1964 \ifdim \wd0>\itemmax
1966 % Make this a paragraph so we get the \parskip glue and wrapping,
1967 % but leave it ragged-right.
1968 \begingroup
1969 \advance\leftskip by-\tableindent
1970 \advance\hsize by\tableindent
1971 \advance\rightskip by0pt plus1fil
1972 \leavevmode\unhbox0\par
1973 \endgroup
1975 % We're going to be starting a paragraph, but we don't want the
1976 % \parskip glue -- logically it's part of the @item we just started.
1977 \nobreak \vskip-\parskip
1979 % Stop a page break at the \parskip glue coming up. (Unfortunately
1980 % we can't prevent a possible page break at the following
1981 % \baselineskip glue.) However, if what follows is an environment
1982 % such as @example, there will be no \parskip glue; then
1983 % the negative vskip we just would cause the example and the item to
1984 % crash together. So we use this bizarre value of 10001 as a signal
1985 % to \aboveenvbreak to insert \parskip glue after all.
1986 % (Possibly there are other commands that could be followed by
1987 % @example which need the same treatment, but not section titles; or
1988 % maybe section titles are the only special case and they should be
1989 % penalty 10001...)
1990 \penalty 10001
1991 \endgroup
1992 \itemxneedsnegativevskipfalse
1993 \else
1994 % The item text fits into the space. Start a paragraph, so that the
1995 % following text (if any) will end up on the same line.
1996 \noindent
1997 % Do this with kerns and \unhbox so that if there is a footnote in
1998 % the item text, it can migrate to the main vertical list and
1999 % eventually be printed.
2000 \nobreak\kern-\tableindent
2001 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2002 \unhbox0
2003 \nobreak\kern\dimen0
2004 \endgroup
2005 \itemxneedsnegativevskiptrue
2009 \def\item{\errmessage{@item while not in a table}}
2010 \def\itemx{\errmessage{@itemx while not in a table}}
2011 \def\kitem{\errmessage{@kitem while not in a table}}
2012 \def\kitemx{\errmessage{@kitemx while not in a table}}
2013 \def\xitem{\errmessage{@xitem while not in a table}}
2014 \def\xitemx{\errmessage{@xitemx while not in a table}}
2016 % Contains a kludge to get @end[description] to work.
2017 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
2019 % @table, @ftable, @vtable.
2020 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
2021 {\obeylines\obeyspaces%
2022 \gdef\tablex #1^^M{%
2023 \tabley\dontindex#1 \endtabley}}
2025 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
2026 {\obeylines\obeyspaces%
2027 \gdef\ftablex #1^^M{%
2028 \tabley\fnitemindex#1 \endtabley
2029 \def\Eftable{\endgraf\afterenvbreak\endgroup}%
2030 \let\Etable=\relax}}
2032 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
2033 {\obeylines\obeyspaces%
2034 \gdef\vtablex #1^^M{%
2035 \tabley\vritemindex#1 \endtabley
2036 \def\Evtable{\endgraf\afterenvbreak\endgroup}%
2037 \let\Etable=\relax}}
2039 \def\dontindex #1{}
2040 \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
2041 \def\vritemindex #1{\doind {vr}{\code{#1}}}%
2043 {\obeyspaces %
2044 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
2045 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
2047 \def\tablez #1#2#3#4#5#6{%
2048 \aboveenvbreak %
2049 \begingroup %
2050 \def\Edescription{\Etable}% Necessary kludge.
2051 \let\itemindex=#1%
2052 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
2053 \ifnum 0#4>0 \tableindent=#4\mil \fi %
2054 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
2055 \def\itemfont{#2}%
2056 \itemmax=\tableindent %
2057 \advance \itemmax by -\itemmargin %
2058 \advance \leftskip by \tableindent %
2059 \exdentamount=\tableindent
2060 \parindent = 0pt
2061 \parskip = \smallskipamount
2062 \ifdim \parskip=0pt \parskip=2pt \fi%
2063 \def\Etable{\endgraf\afterenvbreak\endgroup}%
2064 \let\item = \internalBitem %
2065 \let\itemx = \internalBitemx %
2066 \let\kitem = \internalBkitem %
2067 \let\kitemx = \internalBkitemx %
2068 \let\xitem = \internalBxitem %
2069 \let\xitemx = \internalBxitemx %
2072 % This is the counter used by @enumerate, which is really @itemize
2074 \newcount \itemno
2076 \def\itemize{\parsearg\itemizezzz}
2078 \def\itemizezzz #1{%
2079 \begingroup % ended by the @end itemize
2080 \itemizey {#1}{\Eitemize}
2083 \def\itemizey #1#2{%
2084 \aboveenvbreak %
2085 \itemmax=\itemindent %
2086 \advance \itemmax by -\itemmargin %
2087 \advance \leftskip by \itemindent %
2088 \exdentamount=\itemindent
2089 \parindent = 0pt %
2090 \parskip = \smallskipamount %
2091 \ifdim \parskip=0pt \parskip=2pt \fi%
2092 \def#2{\endgraf\afterenvbreak\endgroup}%
2093 \def\itemcontents{#1}%
2094 \let\item=\itemizeitem}
2096 % \splitoff TOKENS\endmark defines \first to be the first token in
2097 % TOKENS, and \rest to be the remainder.
2099 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2101 % Allow an optional argument of an uppercase letter, lowercase letter,
2102 % or number, to specify the first label in the enumerated list. No
2103 % argument is the same as `1'.
2105 \def\enumerate{\parsearg\enumeratezzz}
2106 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
2107 \def\enumeratey #1 #2\endenumeratey{%
2108 \begingroup % ended by the @end enumerate
2110 % If we were given no argument, pretend we were given `1'.
2111 \def\thearg{#1}%
2112 \ifx\thearg\empty \def\thearg{1}\fi
2114 % Detect if the argument is a single token. If so, it might be a
2115 % letter. Otherwise, the only valid thing it can be is a number.
2116 % (We will always have one token, because of the test we just made.
2117 % This is a good thing, since \splitoff doesn't work given nothing at
2118 % all -- the first parameter is undelimited.)
2119 \expandafter\splitoff\thearg\endmark
2120 \ifx\rest\empty
2121 % Only one token in the argument. It could still be anything.
2122 % A ``lowercase letter'' is one whose \lccode is nonzero.
2123 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2124 % not equal to itself.
2125 % Otherwise, we assume it's a number.
2127 % We need the \relax at the end of the \ifnum lines to stop TeX from
2128 % continuing to look for a <number>.
2130 \ifnum\lccode\expandafter`\thearg=0\relax
2131 \numericenumerate % a number (we hope)
2132 \else
2133 % It's a letter.
2134 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2135 \lowercaseenumerate % lowercase letter
2136 \else
2137 \uppercaseenumerate % uppercase letter
2140 \else
2141 % Multiple tokens in the argument. We hope it's a number.
2142 \numericenumerate
2146 % An @enumerate whose labels are integers. The starting integer is
2147 % given in \thearg.
2149 \def\numericenumerate{%
2150 \itemno = \thearg
2151 \startenumeration{\the\itemno}%
2154 % The starting (lowercase) letter is in \thearg.
2155 \def\lowercaseenumerate{%
2156 \itemno = \expandafter`\thearg
2157 \startenumeration{%
2158 % Be sure we're not beyond the end of the alphabet.
2159 \ifnum\itemno=0
2160 \errmessage{No more lowercase letters in @enumerate; get a bigger
2161 alphabet}%
2163 \char\lccode\itemno
2167 % The starting (uppercase) letter is in \thearg.
2168 \def\uppercaseenumerate{%
2169 \itemno = \expandafter`\thearg
2170 \startenumeration{%
2171 % Be sure we're not beyond the end of the alphabet.
2172 \ifnum\itemno=0
2173 \errmessage{No more uppercase letters in @enumerate; get a bigger
2174 alphabet}
2176 \char\uccode\itemno
2180 % Call itemizey, adding a period to the first argument and supplying the
2181 % common last two arguments. Also subtract one from the initial value in
2182 % \itemno, since @item increments \itemno.
2184 \def\startenumeration#1{%
2185 \advance\itemno by -1
2186 \itemizey{#1.}\Eenumerate\flushcr
2189 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2190 % to @enumerate.
2192 \def\alphaenumerate{\enumerate{a}}
2193 \def\capsenumerate{\enumerate{A}}
2194 \def\Ealphaenumerate{\Eenumerate}
2195 \def\Ecapsenumerate{\Eenumerate}
2197 % Definition of @item while inside @itemize.
2199 \def\itemizeitem{%
2200 \advance\itemno by 1
2201 {\let\par=\endgraf \smallbreak}%
2202 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2203 {\parskip=0in \hskip 0pt
2204 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2205 \vadjust{\penalty 1200}}%
2206 \flushcr}
2208 % @multitable macros
2209 % Amy Hendrickson, 8/18/94, 3/6/96
2211 % @multitable ... @end multitable will make as many columns as desired.
2212 % Contents of each column will wrap at width given in preamble. Width
2213 % can be specified either with sample text given in a template line,
2214 % or in percent of \hsize, the current width of text on page.
2216 % Table can continue over pages but will only break between lines.
2218 % To make preamble:
2220 % Either define widths of columns in terms of percent of \hsize:
2221 % @multitable @columnfractions .25 .3 .45
2222 % @item ...
2224 % Numbers following @columnfractions are the percent of the total
2225 % current hsize to be used for each column. You may use as many
2226 % columns as desired.
2229 % Or use a template:
2230 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2231 % @item ...
2232 % using the widest term desired in each column.
2234 % For those who want to use more than one line's worth of words in
2235 % the preamble, break the line within one argument and it
2236 % will parse correctly, i.e.,
2238 % @multitable {Column 1 template} {Column 2 template} {Column 3
2239 % template}
2240 % Not:
2241 % @multitable {Column 1 template} {Column 2 template}
2242 % {Column 3 template}
2244 % Each new table line starts with @item, each subsequent new column
2245 % starts with @tab. Empty columns may be produced by supplying @tab's
2246 % with nothing between them for as many times as empty columns are needed,
2247 % ie, @tab@tab@tab will produce two empty columns.
2249 % @item, @tab, @multitable or @end multitable do not need to be on their
2250 % own lines, but it will not hurt if they are.
2252 % Sample multitable:
2254 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2255 % @item first col stuff @tab second col stuff @tab third col
2256 % @item
2257 % first col stuff
2258 % @tab
2259 % second col stuff
2260 % @tab
2261 % third col
2262 % @item first col stuff @tab second col stuff
2263 % @tab Many paragraphs of text may be used in any column.
2265 % They will wrap at the width determined by the template.
2266 % @item@tab@tab This will be in third column.
2267 % @end multitable
2269 % Default dimensions may be reset by user.
2270 % @multitableparskip is vertical space between paragraphs in table.
2271 % @multitableparindent is paragraph indent in table.
2272 % @multitablecolmargin is horizontal space to be left between columns.
2273 % @multitablelinespace is space to leave between table items, baseline
2274 % to baseline.
2275 % 0pt means it depends on current normal line spacing.
2277 \newskip\multitableparskip
2278 \newskip\multitableparindent
2279 \newdimen\multitablecolspace
2280 \newskip\multitablelinespace
2281 \multitableparskip=0pt
2282 \multitableparindent=6pt
2283 \multitablecolspace=12pt
2284 \multitablelinespace=0pt
2286 % Macros used to set up halign preamble:
2288 \let\endsetuptable\relax
2289 \def\xendsetuptable{\endsetuptable}
2290 \let\columnfractions\relax
2291 \def\xcolumnfractions{\columnfractions}
2292 \newif\ifsetpercent
2294 % #1 is the part of the @columnfraction before the decimal point, which
2295 % is presumably either 0 or the empty string (but we don't check, we
2296 % just throw it away). #2 is the decimal part, which we use as the
2297 % percent of \hsize for this column.
2298 \def\pickupwholefraction#1.#2 {%
2299 \global\advance\colcount by 1
2300 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2301 \setuptable
2304 \newcount\colcount
2305 \def\setuptable#1{%
2306 \def\firstarg{#1}%
2307 \ifx\firstarg\xendsetuptable
2308 \let\go = \relax
2309 \else
2310 \ifx\firstarg\xcolumnfractions
2311 \global\setpercenttrue
2312 \else
2313 \ifsetpercent
2314 \let\go\pickupwholefraction
2315 \else
2316 \global\advance\colcount by 1
2317 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2318 % separator; typically that is always in the input, anyway.
2319 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2322 \ifx\go\pickupwholefraction
2323 % Put the argument back for the \pickupwholefraction call, so
2324 % we'll always have a period there to be parsed.
2325 \def\go{\pickupwholefraction#1}%
2326 \else
2327 \let\go = \setuptable
2328 \fi%
2333 % @multitable ... @end multitable definitions:
2335 \def\multitable{\parsearg\dotable}
2336 \def\dotable#1{\bgroup
2337 \vskip\parskip
2338 \let\item=\crcrwithfootnotes
2339 % A \tab used to include \hskip1sp. But then the space in a template
2340 % line is not enough. That is bad. So let's go back to just & until
2341 % we encounter the problem it was intended to solve again. --karl,
2342 % nathan@acm.org, 20apr99.
2343 \let\tab=&%
2344 \let\startfootins=\startsavedfootnote
2345 \tolerance=9500
2346 \hbadness=9500
2347 \setmultitablespacing
2348 \parskip=\multitableparskip
2349 \parindent=\multitableparindent
2350 \overfullrule=0pt
2351 \global\colcount=0
2352 \def\Emultitable{%
2353 \global\setpercentfalse
2354 \crcrwithfootnotes\crcr
2355 \egroup\egroup
2358 % To parse everything between @multitable and @item:
2359 \setuptable#1 \endsetuptable
2361 % \everycr will reset column counter, \colcount, at the end of
2362 % each line. Every column entry will cause \colcount to advance by one.
2363 % The table preamble
2364 % looks at the current \colcount to find the correct column width.
2365 \everycr{\noalign{%
2367 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2368 % Maybe so, but it also creates really weird page breaks when the table
2369 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2370 % manifests itself, so it can be fixed for real --karl.
2371 \global\colcount=0\relax}}%
2373 % This preamble sets up a generic column definition, which will
2374 % be used as many times as user calls for columns.
2375 % \vtop will set a single line and will also let text wrap and
2376 % continue for many paragraphs if desired.
2377 \halign\bgroup&\global\advance\colcount by 1\relax
2378 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname
2380 % In order to keep entries from bumping into each other
2381 % we will add a \leftskip of \multitablecolspace to all columns after
2382 % the first one.
2384 % If a template has been used, we will add \multitablecolspace
2385 % to the width of each template entry.
2387 % If the user has set preamble in terms of percent of \hsize we will
2388 % use that dimension as the width of the column, and the \leftskip
2389 % will keep entries from bumping into each other. Table will start at
2390 % left margin and final column will justify at right margin.
2392 % Make sure we don't inherit \rightskip from the outer environment.
2393 \rightskip=0pt
2394 \ifnum\colcount=1
2395 % The first column will be indented with the surrounding text.
2396 \advance\hsize by\leftskip
2397 \else
2398 \ifsetpercent \else
2399 % If user has not set preamble in terms of percent of \hsize
2400 % we will advance \hsize by \multitablecolspace.
2401 \advance\hsize by \multitablecolspace
2403 % In either case we will make \leftskip=\multitablecolspace:
2404 \leftskip=\multitablecolspace
2406 % Ignoring space at the beginning and end avoids an occasional spurious
2407 % blank line, when TeX decides to break the line at the space before the
2408 % box from the multistrut, so the strut ends up on a line by itself.
2409 % For example:
2410 % @multitable @columnfractions .11 .89
2411 % @item @code{#}
2412 % @tab Legal holiday which is valid in major parts of the whole country.
2413 % Is automatically provided with highlighting sequences respectively marking
2414 % characters.
2415 \noindent\ignorespaces##\unskip\multistrut}\cr
2418 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2419 % If so, do nothing. If not, give it an appropriate dimension based on
2420 % current baselineskip.
2421 \ifdim\multitablelinespace=0pt
2422 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2423 \global\advance\multitablelinespace by-\ht0
2424 %% strut to put in table in case some entry doesn't have descenders,
2425 %% to keep lines equally spaced
2426 \let\multistrut = \strut
2427 \else
2428 %% FIXME: what is \box0 supposed to be?
2429 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2430 width0pt\relax} \fi
2431 %% Test to see if parskip is larger than space between lines of
2432 %% table. If not, do nothing.
2433 %% If so, set to same dimension as multitablelinespace.
2434 \ifdim\multitableparskip>\multitablelinespace
2435 \global\multitableparskip=\multitablelinespace
2436 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2437 %% than skip between lines in the table.
2438 \fi%
2439 \ifdim\multitableparskip=0pt
2440 \global\multitableparskip=\multitablelinespace
2441 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2442 %% than skip between lines in the table.
2443 \fi}
2445 % In case a @footnote appears inside an alignment, save the footnote
2446 % text to a box and make the \insert when a row of the table is
2447 % finished. Otherwise, the insertion is lost, it never migrates to the
2448 % main vertical list. --kasal, 22jan03.
2450 \newbox\savedfootnotes
2452 % \dotable \let's \startfootins to this, so that \dofootnote will call
2453 % it instead of starting the insertion right away.
2454 \def\startsavedfootnote{%
2455 \global\setbox\savedfootnotes = \vbox\bgroup
2456 \unvbox\savedfootnotes
2458 \def\crcrwithfootnotes{%
2459 \crcr
2460 \ifvoid\savedfootnotes \else
2461 \noalign{\insert\footins{\box\savedfootnotes}}%
2465 \message{conditionals,}
2466 % Prevent errors for section commands.
2467 % Used in @ignore and in failing conditionals.
2468 \def\ignoresections{%
2469 \let\chapter=\relax
2470 \let\unnumbered=\relax
2471 \let\top=\relax
2472 \let\unnumberedsec=\relax
2473 \let\unnumberedsection=\relax
2474 \let\unnumberedsubsec=\relax
2475 \let\unnumberedsubsection=\relax
2476 \let\unnumberedsubsubsec=\relax
2477 \let\unnumberedsubsubsection=\relax
2478 \let\section=\relax
2479 \let\subsec=\relax
2480 \let\subsubsec=\relax
2481 \let\subsection=\relax
2482 \let\subsubsection=\relax
2483 \let\appendix=\relax
2484 \let\appendixsec=\relax
2485 \let\appendixsection=\relax
2486 \let\appendixsubsec=\relax
2487 \let\appendixsubsection=\relax
2488 \let\appendixsubsubsec=\relax
2489 \let\appendixsubsubsection=\relax
2490 \let\contents=\relax
2491 \let\smallbook=\relax
2492 \let\titlepage=\relax
2495 % Used in nested conditionals, where we have to parse the Texinfo source
2496 % and so want to turn off most commands, in case they are used
2497 % incorrectly.
2499 % We use \empty instead of \relax for the @def... commands, so that \end
2500 % doesn't throw an error. For instance:
2501 % @ignore
2502 % @deffn ...
2503 % @end deffn
2504 % @end ignore
2506 % The @end deffn is going to get expanded, because we're trying to allow
2507 % nested conditionals. But we don't want to expand the actual @deffn,
2508 % since it might be syntactically correct and intended to be ignored.
2509 % Since \end checks for \relax, using \empty does not cause an error.
2511 \def\ignoremorecommands{%
2512 \let\defcodeindex = \relax
2513 \let\defcv = \empty
2514 \let\defcvx = \empty
2515 \let\Edefcv = \empty
2516 \let\deffn = \empty
2517 \let\deffnx = \empty
2518 \let\Edeffn = \empty
2519 \let\defindex = \relax
2520 \let\defivar = \empty
2521 \let\defivarx = \empty
2522 \let\Edefivar = \empty
2523 \let\defmac = \empty
2524 \let\defmacx = \empty
2525 \let\Edefmac = \empty
2526 \let\defmethod = \empty
2527 \let\defmethodx = \empty
2528 \let\Edefmethod = \empty
2529 \let\defop = \empty
2530 \let\defopx = \empty
2531 \let\Edefop = \empty
2532 \let\defopt = \empty
2533 \let\defoptx = \empty
2534 \let\Edefopt = \empty
2535 \let\defspec = \empty
2536 \let\defspecx = \empty
2537 \let\Edefspec = \empty
2538 \let\deftp = \empty
2539 \let\deftpx = \empty
2540 \let\Edeftp = \empty
2541 \let\deftypefn = \empty
2542 \let\deftypefnx = \empty
2543 \let\Edeftypefn = \empty
2544 \let\deftypefun = \empty
2545 \let\deftypefunx = \empty
2546 \let\Edeftypefun = \empty
2547 \let\deftypeivar = \empty
2548 \let\deftypeivarx = \empty
2549 \let\Edeftypeivar = \empty
2550 \let\deftypemethod = \empty
2551 \let\deftypemethodx = \empty
2552 \let\Edeftypemethod = \empty
2553 \let\deftypeop = \empty
2554 \let\deftypeopx = \empty
2555 \let\Edeftypeop = \empty
2556 \let\deftypevar = \empty
2557 \let\deftypevarx = \empty
2558 \let\Edeftypevar = \empty
2559 \let\deftypevr = \empty
2560 \let\deftypevrx = \empty
2561 \let\Edeftypevr = \empty
2562 \let\defun = \empty
2563 \let\defunx = \empty
2564 \let\Edefun = \empty
2565 \let\defvar = \empty
2566 \let\defvarx = \empty
2567 \let\Edefvar = \empty
2568 \let\defvr = \empty
2569 \let\defvrx = \empty
2570 \let\Edefvr = \empty
2571 \let\clear = \relax
2572 \let\down = \relax
2573 \let\evenfooting = \relax
2574 \let\evenheading = \relax
2575 \let\everyfooting = \relax
2576 \let\everyheading = \relax
2577 \let\headings = \relax
2578 \let\include = \relax
2579 \let\item = \relax
2580 \let\lowersections = \relax
2581 \let\oddfooting = \relax
2582 \let\oddheading = \relax
2583 \let\printindex = \relax
2584 \let\pxref = \relax
2585 \let\raisesections = \relax
2586 \let\ref = \relax
2587 \let\set = \relax
2588 \let\setchapternewpage = \relax
2589 \let\setchapterstyle = \relax
2590 \let\settitle = \relax
2591 \let\up = \relax
2592 \let\verbatiminclude = \relax
2593 \let\xref = \relax
2596 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2598 \def\direntry{\doignore{direntry}}
2599 \def\documentdescriptionword{documentdescription}
2600 \def\documentdescription{\doignore{documentdescription}}
2601 \def\html{\doignore{html}}
2602 \def\ifhtml{\doignore{ifhtml}}
2603 \def\ifinfo{\doignore{ifinfo}}
2604 \def\ifnottex{\doignore{ifnottex}}
2605 \def\ifplaintext{\doignore{ifplaintext}}
2606 \def\ifxml{\doignore{ifxml}}
2607 \def\ignore{\doignore{ignore}}
2608 \def\menu{\doignore{menu}}
2609 \def\xml{\doignore{xml}}
2611 % @dircategory CATEGORY -- specify a category of the dir file
2612 % which this file should belong to. Ignore this in TeX.
2613 \let\dircategory = \comment
2615 % Ignore text until a line `@end #1'.
2617 \def\doignore#1{\begingroup
2618 % Don't complain about control sequences we have declared \outer.
2619 \ignoresections
2621 % Define a command to swallow text until we reach `@end #1'.
2622 % This @ is a catcode 12 token (that is the normal catcode of @ in
2623 % this texinfo.tex file). We change the catcode of @ below to match.
2624 \long\def\doignoretext##1@end #1{\enddoignore}%
2626 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2627 \catcode\spaceChar = 10
2629 % Ignore braces, too, so mismatched braces don't cause trouble.
2630 \catcode`\{ = 9
2631 \catcode`\} = 9
2633 % We must not have @c interpreted as a control sequence.
2634 \catcode`\@ = 12
2636 \def\ignoreword{#1}%
2637 \ifx\ignoreword\documentdescriptionword
2638 % The c kludge breaks documentdescription, since
2639 % `documentdescription' contains a `c'. Means not everything will
2640 % be ignored inside @documentdescription, but oh well...
2641 \else
2642 % Make the letter c a comment character so that the rest of the line
2643 % will be ignored. This way, the document can have (for example)
2644 % @c @end ifinfo
2645 % and the @end ifinfo will be properly ignored.
2646 % (We've just changed @ to catcode 12.)
2647 \catcode`\c = 14
2650 % And now expand the command defined above.
2651 \doignoretext
2654 % What we do to finish off ignored text.
2656 \def\enddoignore{\endgroup\ignorespaces}%
2658 \newif\ifwarnedobs\warnedobsfalse
2659 \def\obstexwarn{%
2660 \ifwarnedobs\relax\else
2661 % We need to warn folks that they may have trouble with TeX 3.0.
2662 % This uses \immediate\write16 rather than \message to get newlines.
2663 \immediate\write16{}
2664 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2665 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2666 \immediate\write16{If you are running another version of TeX, relax.}
2667 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2668 \immediate\write16{ Then upgrade your TeX installation if you can.}
2669 \immediate\write16{ (See ftp://ftp.gnu.org/non-gnu/TeX.README.)}
2670 \immediate\write16{If you are stuck with version 3.0, run the}
2671 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2672 \immediate\write16{ to use a workaround.}
2673 \immediate\write16{}
2674 \global\warnedobstrue
2678 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2679 % workaround (which requires the file ``dummy.tfm'' to be installed),
2680 % uncomment the following line:
2681 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2683 % Ignore text, except that we keep track of conditional commands for
2684 % purposes of nesting, up to an `@end #1' command.
2686 \def\nestedignore#1{%
2687 \obstexwarn
2688 % We must actually expand the ignored text to look for the @end
2689 % command, so that nested ignore constructs work. Thus, we put the
2690 % text into a \vbox and then do nothing with the result. To minimize
2691 % the chance of memory overflow, we follow the approach outlined on
2692 % page 401 of the TeXbook.
2694 \setbox0 = \vbox\bgroup
2695 % Don't complain about control sequences we have declared \outer.
2696 \ignoresections
2698 % Define `@end #1' to end the box, which will in turn undefine the
2699 % @end command again.
2700 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
2702 % We are going to be parsing Texinfo commands. Most cause no
2703 % trouble when they are used incorrectly, but some commands do
2704 % complicated argument parsing or otherwise get confused, so we
2705 % undefine them.
2707 % We can't do anything about stray @-signs, unfortunately;
2708 % they'll produce `undefined control sequence' errors.
2709 \ignoremorecommands
2711 % Set the current font to be \nullfont, a TeX primitive, and define
2712 % all the font commands to also use \nullfont. We don't use
2713 % dummy.tfm, as suggested in the TeXbook, because some sites
2714 % might not have that installed. Therefore, math mode will still
2715 % produce output, but that should be an extremely small amount of
2716 % stuff compared to the main input.
2718 \nullfont
2719 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont
2720 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont
2721 \let\tensf=\nullfont
2722 % Similarly for index fonts.
2723 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont
2724 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont
2725 \let\smallsf=\nullfont
2726 % Similarly for smallexample fonts.
2727 \let\smallerrm=\nullfont \let\smallerit=\nullfont \let\smallersl=\nullfont
2728 \let\smallerbf=\nullfont \let\smallertt=\nullfont \let\smallersc=\nullfont
2729 \let\smallersf=\nullfont
2731 % Don't complain when characters are missing from the fonts.
2732 \tracinglostchars = 0
2734 % Don't bother to do space factor calculations.
2735 \frenchspacing
2737 % Don't report underfull hboxes.
2738 \hbadness = 10000
2740 % Do minimal line-breaking.
2741 \pretolerance = 10000
2743 % Do not execute instructions in @tex.
2744 \def\tex{\doignore{tex}}%
2745 % Do not execute macro definitions.
2746 % `c' is a comment character, so the word `macro' will get cut off.
2747 \def\macro{\doignore{ma}}%
2750 % @set VAR sets the variable VAR to an empty value.
2751 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2753 % Since we want to separate VAR from REST-OF-LINE (which might be
2754 % empty), we can't just use \parsearg; we have to insert a space of our
2755 % own to delimit the rest of the line, and then take it out again if we
2756 % didn't need it. Make sure the catcode of space is correct to avoid
2757 % losing inside @example, for instance.
2759 \def\set{\begingroup\catcode` =10
2760 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2761 \parsearg\setxxx}
2762 \def\setxxx#1{\setyyy#1 \endsetyyy}
2763 \def\setyyy#1 #2\endsetyyy{%
2764 \def\temp{#2}%
2765 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
2766 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
2768 \endgroup
2770 % Can't use \xdef to pre-expand #2 and save some time, since \temp or
2771 % \next or other control sequences that we've defined might get us into
2772 % an infinite loop. Consider `@set foo @cite{bar}'.
2773 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}}
2775 % @clear VAR clears (i.e., unsets) the variable VAR.
2777 \def\clear{\parsearg\clearxxx}
2778 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
2780 % @value{foo} gets the text saved in variable foo.
2782 \catcode`\_ = \active
2784 % We might end up with active _ or - characters in the argument if
2785 % we're called from @code, as @code{@value{foo-bar_}}. So \let any
2786 % such active characters to their normal equivalents.
2787 \gdef\value{\begingroup
2788 \catcode`\-=\other \catcode`\_=\other
2789 \indexbreaks \let_\normalunderscore
2790 \valuexxx}
2792 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2794 % We have this subroutine so that we can handle at least some @value's
2795 % properly in indexes (we \let\value to this in \indexdummies). Ones
2796 % whose names contain - or _ still won't work, but we can't do anything
2797 % about that. The command has to be fully expandable (if the variable
2798 % is set), since the result winds up in the index file. This means that
2799 % if the variable's value contains other Texinfo commands, it's almost
2800 % certain it will fail (although perhaps we could fix that with
2801 % sufficient work to do a one-level expansion on the result, instead of
2802 % complete).
2804 \def\expandablevalue#1{%
2805 \expandafter\ifx\csname SET#1\endcsname\relax
2806 {[No value for ``#1'']}%
2807 \message{Variable `#1', used in @value, is not set.}%
2808 \else
2809 \csname SET#1\endcsname
2813 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2814 % with @set.
2816 \def\ifset{\parsearg\doifset}
2817 \def\doifset#1{%
2818 \expandafter\ifx\csname SET#1\endcsname\relax
2819 \let\next=\ifsetfail
2820 \else
2821 \let\next=\ifsetsucceed
2823 \next
2825 \def\ifsetsucceed{\conditionalsucceed{ifset}}
2826 \def\ifsetfail{\nestedignore{ifset}}
2827 \defineunmatchedend{ifset}
2829 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2830 % defined with @set, or has been undefined with @clear.
2832 \def\ifclear{\parsearg\doifclear}
2833 \def\doifclear#1{%
2834 \expandafter\ifx\csname SET#1\endcsname\relax
2835 \let\next=\ifclearsucceed
2836 \else
2837 \let\next=\ifclearfail
2839 \next
2841 \def\ifclearsucceed{\conditionalsucceed{ifclear}}
2842 \def\ifclearfail{\nestedignore{ifclear}}
2843 \defineunmatchedend{ifclear}
2845 % @iftex, @ifnothtml, @ifnotinfo, @ifnotplaintext always succeed; we
2846 % read the text following, through the first @end iftex (etc.). Make
2847 % `@end iftex' (etc.) valid only after an @iftex.
2849 \def\iftex{\conditionalsucceed{iftex}}
2850 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2851 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2852 \def\ifnotplaintext{\conditionalsucceed{ifnotplaintext}}
2853 \defineunmatchedend{iftex}
2854 \defineunmatchedend{ifnothtml}
2855 \defineunmatchedend{ifnotinfo}
2856 \defineunmatchedend{ifnotplaintext}
2858 % True conditional. Since \set globally defines its variables, we can
2859 % just start and end a group (to keep the @end definition undefined at
2860 % the outer level).
2862 \def\conditionalsucceed#1{\begingroup
2863 \expandafter\def\csname E#1\endcsname{\endgroup}%
2866 % @defininfoenclose.
2867 \let\definfoenclose=\comment
2870 \message{indexing,}
2871 % Index generation facilities
2873 % Define \newwrite to be identical to plain tex's \newwrite
2874 % except not \outer, so it can be used within \newindex.
2875 {\catcode`\@=11
2876 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2878 % \newindex {foo} defines an index named foo.
2879 % It automatically defines \fooindex such that
2880 % \fooindex ...rest of line... puts an entry in the index foo.
2881 % It also defines \fooindfile to be the number of the output channel for
2882 % the file that accumulates this index. The file's extension is foo.
2883 % The name of an index should be no more than 2 characters long
2884 % for the sake of vms.
2886 \def\newindex#1{%
2887 \iflinks
2888 \expandafter\newwrite \csname#1indfile\endcsname
2889 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2891 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2892 \noexpand\doindex{#1}}
2895 % @defindex foo == \newindex{foo}
2897 \def\defindex{\parsearg\newindex}
2899 % Define @defcodeindex, like @defindex except put all entries in @code.
2901 \def\defcodeindex{\parsearg\newcodeindex}
2903 \def\newcodeindex#1{%
2904 \iflinks
2905 \expandafter\newwrite \csname#1indfile\endcsname
2906 \openout \csname#1indfile\endcsname \jobname.#1
2908 \expandafter\xdef\csname#1index\endcsname{%
2909 \noexpand\docodeindex{#1}}%
2913 % @synindex foo bar makes index foo feed into index bar.
2914 % Do this instead of @defindex foo if you don't want it as a separate index.
2916 % @syncodeindex foo bar similar, but put all entries made for index foo
2917 % inside @code.
2919 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2920 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2922 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2923 % #3 the target index (bar).
2924 \def\dosynindex#1#2#3{%
2925 % Only do \closeout if we haven't already done it, else we'll end up
2926 % closing the target index.
2927 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2928 % The \closeout helps reduce unnecessary open files; the limit on the
2929 % Acorn RISC OS is a mere 16 files.
2930 \expandafter\closeout\csname#2indfile\endcsname
2931 \expandafter\let\csname\donesynindex#2\endcsname = 1
2933 % redefine \fooindfile:
2934 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2935 \expandafter\let\csname#2indfile\endcsname=\temp
2936 % redefine \fooindex:
2937 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2940 % Define \doindex, the driver for all \fooindex macros.
2941 % Argument #1 is generated by the calling \fooindex macro,
2942 % and it is "foo", the name of the index.
2944 % \doindex just uses \parsearg; it calls \doind for the actual work.
2945 % This is because \doind is more useful to call from other macros.
2947 % There is also \dosubind {index}{topic}{subtopic}
2948 % which makes an entry in a two-level index such as the operation index.
2950 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2951 \def\singleindexer #1{\doind{\indexname}{#1}}
2953 % like the previous two, but they put @code around the argument.
2954 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2955 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2957 % Take care of Texinfo commands that can appear in an index entry.
2958 % Since there are some commands we want to expand, and others we don't,
2959 % we have to laboriously prevent expansion for those that we don't.
2961 \def\indexdummies{%
2962 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2963 \def\ {\realbackslash\space }%
2964 % Need these in case \tex is in effect and \{ is a \delimiter again.
2965 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2966 % braces and backslashes are used only as delimiters.
2967 \let\{ = \mylbrace
2968 \let\} = \myrbrace
2970 % \definedummyword defines \#1 as \realbackslash #1\space, thus
2971 % effectively preventing its expansion. This is used only for control
2972 % words, not control letters, because the \space would be incorrect
2973 % for control characters, but is needed to separate the control word
2974 % from whatever follows.
2976 % For control letters, we have \definedummyletter, which omits the
2977 % space.
2979 % These can be used both for control words that take an argument and
2980 % those that do not. If it is followed by {arg} in the input, then
2981 % that will dutifully get written to the index (or wherever).
2983 \def\definedummyword##1{%
2984 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
2986 \def\definedummyletter##1{%
2987 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
2990 % Do the redefinitions.
2991 \commondummies
2994 % For the aux file, @ is the escape character. So we want to redefine
2995 % everything using @ instead of \realbackslash. When everything uses
2996 % @, this will be simpler.
2998 \def\atdummies{%
2999 \def\@{@@}%
3000 \def\ {@ }%
3001 \let\{ = \lbraceatcmd
3002 \let\} = \rbraceatcmd
3004 % (See comments in \indexdummies.)
3005 \def\definedummyword##1{%
3006 \expandafter\def\csname ##1\endcsname{@##1\space}%
3008 \def\definedummyletter##1{%
3009 \expandafter\def\csname ##1\endcsname{@##1}%
3012 % Do the redefinitions.
3013 \commondummies
3016 % Called from \indexdummies and \atdummies. \definedummyword and
3017 % \definedummyletter must be defined first.
3019 \def\commondummies{%
3021 \normalturnoffactive
3023 % Control letters and accents.
3024 \definedummyletter{_}%
3025 \definedummyletter{,}%
3026 \definedummyletter{"}%
3027 \definedummyletter{`}%
3028 \definedummyletter{'}%
3029 \definedummyletter{^}%
3030 \definedummyletter{~}%
3031 \definedummyletter{=}%
3032 \definedummyword{u}%
3033 \definedummyword{v}%
3034 \definedummyword{H}%
3035 \definedummyword{dotaccent}%
3036 \definedummyword{ringaccent}%
3037 \definedummyword{tieaccent}%
3038 \definedummyword{ubaraccent}%
3039 \definedummyword{udotaccent}%
3040 \definedummyword{dotless}%
3042 % Other non-English letters.
3043 \definedummyword{AA}%
3044 \definedummyword{AE}%
3045 \definedummyword{L}%
3046 \definedummyword{OE}%
3047 \definedummyword{O}%
3048 \definedummyword{aa}%
3049 \definedummyword{ae}%
3050 \definedummyword{l}%
3051 \definedummyword{oe}%
3052 \definedummyword{o}%
3053 \definedummyword{ss}%
3055 % Although these internal commands shouldn't show up, sometimes they do.
3056 \definedummyword{bf}%
3057 \definedummyword{gtr}%
3058 \definedummyword{hat}%
3059 \definedummyword{less}%
3060 \definedummyword{sf}%
3061 \definedummyword{sl}%
3062 \definedummyword{tclose}%
3063 \definedummyword{tt}%
3065 % Texinfo font commands.
3066 \definedummyword{b}%
3067 \definedummyword{i}%
3068 \definedummyword{r}%
3069 \definedummyword{sc}%
3070 \definedummyword{t}%
3072 \definedummyword{TeX}%
3073 \definedummyword{acronym}%
3074 \definedummyword{cite}%
3075 \definedummyword{code}%
3076 \definedummyword{command}%
3077 \definedummyword{dfn}%
3078 \definedummyword{dots}%
3079 \definedummyword{emph}%
3080 \definedummyword{env}%
3081 \definedummyword{file}%
3082 \definedummyword{kbd}%
3083 \definedummyword{key}%
3084 \definedummyword{math}%
3085 \definedummyword{option}%
3086 \definedummyword{samp}%
3087 \definedummyword{strong}%
3088 \definedummyword{uref}%
3089 \definedummyword{url}%
3090 \definedummyword{var}%
3091 \definedummyword{w}%
3093 % Assorted special characters.
3094 \definedummyword{bullet}%
3095 \definedummyword{copyright}%
3096 \definedummyword{dots}%
3097 \definedummyword{enddots}%
3098 \definedummyword{equiv}%
3099 \definedummyword{error}%
3100 \definedummyword{expansion}%
3101 \definedummyword{minus}%
3102 \definedummyword{pounds}%
3103 \definedummyword{point}%
3104 \definedummyword{print}%
3105 \definedummyword{result}%
3107 % Handle some cases of @value -- where the variable name does not
3108 % contain - or _, and the value does not contain any
3109 % (non-fully-expandable) commands.
3110 \let\value = \expandablevalue
3112 % Normal spaces, not active ones.
3113 \unsepspaces
3115 % No macro expansion.
3116 \turnoffmacros
3119 % If an index command is used in an @example environment, any spaces
3120 % therein should become regular spaces in the raw index file, not the
3121 % expansion of \tie (\leavevmode \penalty \@M \ ).
3122 {\obeyspaces
3123 \gdef\unsepspaces{\obeyspaces\let =\space}}
3126 % \indexnofonts is used when outputting the strings to sort the index
3127 % by, and when constructing control sequence names. It eliminates all
3128 % control sequences and just writes whatever the best ASCII sort string
3129 % would be for a given command (usually its argument).
3131 \def\indexdummytex{TeX}
3132 \def\indexdummydots{...}
3134 \def\indexnofonts{%
3135 \def\ { }%
3136 \def\@{@}%
3137 % how to handle braces?
3138 \def\_{\normalunderscore}%
3140 \let\,=\asis
3141 \let\"=\asis
3142 \let\`=\asis
3143 \let\'=\asis
3144 \let\^=\asis
3145 \let\~=\asis
3146 \let\==\asis
3147 \let\u=\asis
3148 \let\v=\asis
3149 \let\H=\asis
3150 \let\dotaccent=\asis
3151 \let\ringaccent=\asis
3152 \let\tieaccent=\asis
3153 \let\ubaraccent=\asis
3154 \let\udotaccent=\asis
3155 \let\dotless=\asis
3157 % Other non-English letters.
3158 \def\AA{AA}%
3159 \def\AE{AE}%
3160 \def\L{L}%
3161 \def\OE{OE}%
3162 \def\O{O}%
3163 \def\aa{aa}%
3164 \def\ae{ae}%
3165 \def\l{l}%
3166 \def\oe{oe}%
3167 \def\o{o}%
3168 \def\ss{ss}%
3169 \def\exclamdown{!}%
3170 \def\questiondown{?}%
3172 % Don't no-op \tt, since it isn't a user-level command
3173 % and is used in the definitions of the active chars like <, >, |, etc.
3174 % Likewise with the other plain tex font commands.
3175 %\let\tt=\asis
3177 % Texinfo font commands.
3178 \let\b=\asis
3179 \let\i=\asis
3180 \let\r=\asis
3181 \let\sc=\asis
3182 \let\t=\asis
3184 \let\TeX=\indexdummytex
3185 \let\acronym=\asis
3186 \let\cite=\asis
3187 \let\code=\asis
3188 \let\command=\asis
3189 \let\dfn=\asis
3190 \let\dots=\indexdummydots
3191 \let\emph=\asis
3192 \let\env=\asis
3193 \let\file=\asis
3194 \let\kbd=\asis
3195 \let\key=\asis
3196 \let\math=\asis
3197 \let\option=\asis
3198 \let\samp=\asis
3199 \let\strong=\asis
3200 \let\uref=\asis
3201 \let\url=\asis
3202 \let\var=\asis
3203 \let\w=\asis
3206 \let\indexbackslash=0 %overridden during \printindex.
3207 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3209 % For \ifx comparisons.
3210 \def\emptymacro{\empty}
3212 % Most index entries go through here, but \dosubind is the general case.
3214 \def\doind#1#2{\dosubind{#1}{#2}\empty}
3216 % Workhorse for all \fooindexes.
3217 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3218 % \empty if called from \doind, as we usually are. The main exception
3219 % is with defuns, which call us directly.
3221 \def\dosubind#1#2#3{%
3222 % Put the index entry in the margin if desired.
3223 \ifx\SETmarginindex\relax\else
3224 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}%
3227 \count255=\lastpenalty
3229 \indexdummies % Must do this here, since \bf, etc expand at this stage
3230 \escapechar=`\\
3232 \let\folio = 0% We will expand all macros now EXCEPT \folio.
3233 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
3234 % so it will be output as is; and it will print as backslash.
3236 % The main index entry text.
3237 \toks0 = {#2}%
3239 % If third arg is present, precede it with space in sort key.
3240 \def\thirdarg{#3}%
3241 \ifx\thirdarg\emptymacro \else
3242 % If the third (subentry) arg is present, add it to the index
3243 % line to write.
3244 \toks0 = \expandafter{\the\toks0 \space #3}%
3247 % Process the index entry with all font commands turned off, to
3248 % get the string to sort by.
3249 {\indexnofonts
3250 \edef\temp{\the\toks0}% need full expansion
3251 \xdef\indexsorttmp{\temp}%
3254 % Set up the complete index entry, with both the sort key and
3255 % the original text, including any font commands. We write
3256 % three arguments to \entry to the .?? file (four in the
3257 % subentry case), texindex reduces to two when writing the .??s
3258 % sorted result.
3259 \edef\temp{%
3260 \write\csname#1indfile\endcsname{%
3261 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
3264 % If a skip is the last thing on the list now, preserve it
3265 % by backing up by \lastskip, doing the \write, then inserting
3266 % the skip again. Otherwise, the whatsit generated by the
3267 % \write will make \lastskip zero. The result is that sequences
3268 % like this:
3269 % @end defun
3270 % @tindex whatever
3271 % @defun ...
3272 % will have extra space inserted, because the \medbreak in the
3273 % start of the @defun won't see the skip inserted by the @end of
3274 % the previous defun.
3276 % But don't do any of this if we're not in vertical mode. We
3277 % don't want to do a \vskip and prematurely end a paragraph.
3279 % Avoid page breaks due to these extra skips, too.
3281 \iflinks
3282 \ifvmode
3283 \skip0 = \lastskip
3284 \ifdim\lastskip = 0pt \else \nobreak\vskip-\skip0 \fi
3287 \temp % do the write
3289 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
3293 \penalty\count255
3297 % The index entry written in the file actually looks like
3298 % \entry {sortstring}{page}{topic}
3299 % or
3300 % \entry {sortstring}{page}{topic}{subtopic}
3301 % The texindex program reads in these files and writes files
3302 % containing these kinds of lines:
3303 % \initial {c}
3304 % before the first topic whose initial is c
3305 % \entry {topic}{pagelist}
3306 % for a topic that is used without subtopics
3307 % \primary {topic}
3308 % for the beginning of a topic that is used with subtopics
3309 % \secondary {subtopic}{pagelist}
3310 % for each subtopic.
3312 % Define the user-accessible indexing commands
3313 % @findex, @vindex, @kindex, @cindex.
3315 \def\findex {\fnindex}
3316 \def\kindex {\kyindex}
3317 \def\cindex {\cpindex}
3318 \def\vindex {\vrindex}
3319 \def\tindex {\tpindex}
3320 \def\pindex {\pgindex}
3322 \def\cindexsub {\begingroup\obeylines\cindexsub}
3323 {\obeylines %
3324 \gdef\cindexsub "#1" #2^^M{\endgroup %
3325 \dosubind{cp}{#2}{#1}}}
3327 % Define the macros used in formatting output of the sorted index material.
3329 % @printindex causes a particular index (the ??s file) to get printed.
3330 % It does not print any chapter heading (usually an @unnumbered).
3332 \def\printindex{\parsearg\doprintindex}
3333 \def\doprintindex#1{\begingroup
3334 \dobreak \chapheadingskip{10000}%
3336 \smallfonts \rm
3337 \tolerance = 9500
3338 \indexbreaks
3340 % See if the index file exists and is nonempty.
3341 % Change catcode of @ here so that if the index file contains
3342 % \initial {@}
3343 % as its first line, TeX doesn't complain about mismatched braces
3344 % (because it thinks @} is a control sequence).
3345 \catcode`\@ = 11
3346 \openin 1 \jobname.#1s
3347 \ifeof 1
3348 % \enddoublecolumns gets confused if there is no text in the index,
3349 % and it loses the chapter title and the aux file entries for the
3350 % index. The easiest way to prevent this problem is to make sure
3351 % there is some text.
3352 \putwordIndexNonexistent
3353 \else
3355 % If the index file exists but is empty, then \openin leaves \ifeof
3356 % false. We have to make TeX try to read something from the file, so
3357 % it can discover if there is anything in it.
3358 \read 1 to \temp
3359 \ifeof 1
3360 \putwordIndexIsEmpty
3361 \else
3362 % Index files are almost Texinfo source, but we use \ as the escape
3363 % character. It would be better to use @, but that's too big a change
3364 % to make right now.
3365 \def\indexbackslash{\rawbackslashxx}%
3366 \catcode`\\ = 0
3367 \escapechar = `\\
3368 \begindoublecolumns
3369 \input \jobname.#1s
3370 \enddoublecolumns
3373 \closein 1
3374 \endgroup}
3376 % These macros are used by the sorted index file itself.
3377 % Change them to control the appearance of the index.
3379 \def\initial#1{{%
3380 % Some minor font changes for the special characters.
3381 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3383 % Remove any glue we may have, we'll be inserting our own.
3384 \removelastskip
3386 % We like breaks before the index initials, so insert a bonus.
3387 \penalty -300
3389 % Typeset the initial. Making this add up to a whole number of
3390 % baselineskips increases the chance of the dots lining up from column
3391 % to column. It still won't often be perfect, because of the stretch
3392 % we need before each entry, but it's better.
3394 % No shrink because it confuses \balancecolumns.
3395 \vskip 1.67\baselineskip plus .5\baselineskip
3396 \leftline{\secbf #1}%
3397 \vskip .33\baselineskip plus .1\baselineskip
3399 % Do our best not to break after the initial.
3400 \nobreak
3403 % This typesets a paragraph consisting of #1, dot leaders, and then #2
3404 % flush to the right margin. It is used for index and table of contents
3405 % entries. The paragraph is indented by \leftskip.
3407 \def\entry#1#2{\begingroup
3409 % Start a new paragraph if necessary, so our assignments below can't
3410 % affect previous text.
3411 \par
3413 % Do not fill out the last line with white space.
3414 \parfillskip = 0in
3416 % No extra space above this paragraph.
3417 \parskip = 0in
3419 % Do not prefer a separate line ending with a hyphen to fewer lines.
3420 \finalhyphendemerits = 0
3422 % \hangindent is only relevant when the entry text and page number
3423 % don't both fit on one line. In that case, bob suggests starting the
3424 % dots pretty far over on the line. Unfortunately, a large
3425 % indentation looks wrong when the entry text itself is broken across
3426 % lines. So we use a small indentation and put up with long leaders.
3428 % \hangafter is reset to 1 (which is the value we want) at the start
3429 % of each paragraph, so we need not do anything with that.
3430 \hangindent = 2em
3432 % When the entry text needs to be broken, just fill out the first line
3433 % with blank space.
3434 \rightskip = 0pt plus1fil
3436 % A bit of stretch before each entry for the benefit of balancing columns.
3437 \vskip 0pt plus1pt
3439 % Start a ``paragraph'' for the index entry so the line breaking
3440 % parameters we've set above will have an effect.
3441 \noindent
3443 % Insert the text of the index entry. TeX will do line-breaking on it.
3445 % The following is kludged to not output a line of dots in the index if
3446 % there are no page numbers. The next person who breaks this will be
3447 % cursed by a Unix daemon.
3448 \def\tempa{{\rm }}%
3449 \def\tempb{#2}%
3450 \edef\tempc{\tempa}%
3451 \edef\tempd{\tempb}%
3452 \ifx\tempc\tempd\ \else%
3454 % If we must, put the page number on a line of its own, and fill out
3455 % this line with blank space. (The \hfil is overwhelmed with the
3456 % fill leaders glue in \indexdotfill if the page number does fit.)
3457 \hfil\penalty50
3458 \null\nobreak\indexdotfill % Have leaders before the page number.
3460 % The `\ ' here is removed by the implicit \unskip that TeX does as
3461 % part of (the primitive) \par. Without it, a spurious underfull
3462 % \hbox ensues.
3463 \ifpdf
3464 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3465 \else
3466 \ #2% The page number ends the paragraph.
3468 \fi%
3469 \par
3470 \endgroup}
3472 % Like \dotfill except takes at least 1 em.
3473 \def\indexdotfill{\cleaders
3474 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3476 \def\primary #1{\line{#1\hfil}}
3478 \newskip\secondaryindent \secondaryindent=0.5cm
3479 \def\secondary#1#2{{%
3480 \parfillskip=0in
3481 \parskip=0in
3482 \hangindent=1in
3483 \hangafter=1
3484 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3485 \ifpdf
3486 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3487 \else
3490 \par
3493 % Define two-column mode, which we use to typeset indexes.
3494 % Adapted from the TeXbook, page 416, which is to say,
3495 % the manmac.tex format used to print the TeXbook itself.
3496 \catcode`\@=11
3498 \newbox\partialpage
3499 \newdimen\doublecolumnhsize
3501 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3502 % Grab any single-column material above us.
3503 \output = {%
3505 % Here is a possibility not foreseen in manmac: if we accumulate a
3506 % whole lot of material, we might end up calling this \output
3507 % routine twice in a row (see the doublecol-lose test, which is
3508 % essentially a couple of indexes with @setchapternewpage off). In
3509 % that case we just ship out what is in \partialpage with the normal
3510 % output routine. Generally, \partialpage will be empty when this
3511 % runs and this will be a no-op. See the indexspread.tex test case.
3512 \ifvoid\partialpage \else
3513 \onepageout{\pagecontents\partialpage}%
3516 \global\setbox\partialpage = \vbox{%
3517 % Unvbox the main output page.
3518 \unvbox\PAGE
3519 \kern-\topskip \kern\baselineskip
3522 \eject % run that output routine to set \partialpage
3524 % Use the double-column output routine for subsequent pages.
3525 \output = {\doublecolumnout}%
3527 % Change the page size parameters. We could do this once outside this
3528 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3529 % format, but then we repeat the same computation. Repeating a couple
3530 % of assignments once per index is clearly meaningless for the
3531 % execution time, so we may as well do it in one place.
3533 % First we halve the line length, less a little for the gutter between
3534 % the columns. We compute the gutter based on the line length, so it
3535 % changes automatically with the paper format. The magic constant
3536 % below is chosen so that the gutter has the same value (well, +-<1pt)
3537 % as it did when we hard-coded it.
3539 % We put the result in a separate register, \doublecolumhsize, so we
3540 % can restore it in \pagesofar, after \hsize itself has (potentially)
3541 % been clobbered.
3543 \doublecolumnhsize = \hsize
3544 \advance\doublecolumnhsize by -.04154\hsize
3545 \divide\doublecolumnhsize by 2
3546 \hsize = \doublecolumnhsize
3548 % Double the \vsize as well. (We don't need a separate register here,
3549 % since nobody clobbers \vsize.)
3550 \vsize = 2\vsize
3553 % The double-column output routine for all double-column pages except
3554 % the last.
3556 \def\doublecolumnout{%
3557 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3558 % Get the available space for the double columns -- the normal
3559 % (undoubled) page height minus any material left over from the
3560 % previous page.
3561 \dimen@ = \vsize
3562 \divide\dimen@ by 2
3563 \advance\dimen@ by -\ht\partialpage
3565 % box0 will be the left-hand column, box2 the right.
3566 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3567 \onepageout\pagesofar
3568 \unvbox255
3569 \penalty\outputpenalty
3572 % Re-output the contents of the output page -- any previous material,
3573 % followed by the two boxes we just split, in box0 and box2.
3574 \def\pagesofar{%
3575 \unvbox\partialpage
3577 \hsize = \doublecolumnhsize
3578 \wd0=\hsize \wd2=\hsize
3579 \hbox to\pagewidth{\box0\hfil\box2}%
3582 % All done with double columns.
3583 \def\enddoublecolumns{%
3584 \output = {%
3585 % Split the last of the double-column material. Leave it on the
3586 % current page, no automatic page break.
3587 \balancecolumns
3589 % If we end up splitting too much material for the current page,
3590 % though, there will be another page break right after this \output
3591 % invocation ends. Having called \balancecolumns once, we do not
3592 % want to call it again. Therefore, reset \output to its normal
3593 % definition right away. (We hope \balancecolumns will never be
3594 % called on to balance too much material, but if it is, this makes
3595 % the output somewhat more palatable.)
3596 \global\output = {\onepageout{\pagecontents\PAGE}}%
3598 \eject
3599 \endgroup % started in \begindoublecolumns
3601 % \pagegoal was set to the doubled \vsize above, since we restarted
3602 % the current page. We're now back to normal single-column
3603 % typesetting, so reset \pagegoal to the normal \vsize (after the
3604 % \endgroup where \vsize got restored).
3605 \pagegoal = \vsize
3608 % Called at the end of the double column material.
3609 \def\balancecolumns{%
3610 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3611 \dimen@ = \ht0
3612 \advance\dimen@ by \topskip
3613 \advance\dimen@ by-\baselineskip
3614 \divide\dimen@ by 2 % target to split to
3615 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3616 \splittopskip = \topskip
3617 % Loop until we get a decent breakpoint.
3619 \vbadness = 10000
3620 \loop
3621 \global\setbox3 = \copy0
3622 \global\setbox1 = \vsplit3 to \dimen@
3623 \ifdim\ht3>\dimen@
3624 \global\advance\dimen@ by 1pt
3625 \repeat
3627 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3628 \setbox0=\vbox to\dimen@{\unvbox1}%
3629 \setbox2=\vbox to\dimen@{\unvbox3}%
3631 \pagesofar
3633 \catcode`\@ = \other
3636 \message{sectioning,}
3637 % Chapters, sections, etc.
3639 \newcount\chapno
3640 \newcount\secno \secno=0
3641 \newcount\subsecno \subsecno=0
3642 \newcount\subsubsecno \subsubsecno=0
3644 % This counter is funny since it counts through charcodes of letters A, B, ...
3645 \newcount\appendixno \appendixno = `\@
3646 % \def\appendixletter{\char\the\appendixno}
3647 % We do the following for the sake of pdftex, which needs the actual
3648 % letter in the expansion, not just typeset.
3649 \def\appendixletter{%
3650 \ifnum\appendixno=`A A%
3651 \else\ifnum\appendixno=`B B%
3652 \else\ifnum\appendixno=`C C%
3653 \else\ifnum\appendixno=`D D%
3654 \else\ifnum\appendixno=`E E%
3655 \else\ifnum\appendixno=`F F%
3656 \else\ifnum\appendixno=`G G%
3657 \else\ifnum\appendixno=`H H%
3658 \else\ifnum\appendixno=`I I%
3659 \else\ifnum\appendixno=`J J%
3660 \else\ifnum\appendixno=`K K%
3661 \else\ifnum\appendixno=`L L%
3662 \else\ifnum\appendixno=`M M%
3663 \else\ifnum\appendixno=`N N%
3664 \else\ifnum\appendixno=`O O%
3665 \else\ifnum\appendixno=`P P%
3666 \else\ifnum\appendixno=`Q Q%
3667 \else\ifnum\appendixno=`R R%
3668 \else\ifnum\appendixno=`S S%
3669 \else\ifnum\appendixno=`T T%
3670 \else\ifnum\appendixno=`U U%
3671 \else\ifnum\appendixno=`V V%
3672 \else\ifnum\appendixno=`W W%
3673 \else\ifnum\appendixno=`X X%
3674 \else\ifnum\appendixno=`Y Y%
3675 \else\ifnum\appendixno=`Z Z%
3676 % The \the is necessary, despite appearances, because \appendixletter is
3677 % expanded while writing the .toc file. \char\appendixno is not
3678 % expandable, thus it is written literally, thus all appendixes come out
3679 % with the same letter (or @) in the toc without it.
3680 \else\char\the\appendixno
3681 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3682 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3684 % Each @chapter defines this as the name of the chapter.
3685 % page headings and footings can use it. @section does likewise.
3686 \def\thischapter{}
3687 \def\thissection{}
3689 \newcount\absseclevel % used to calculate proper heading level
3690 \newcount\secbase\secbase=0 % @raise/lowersections modify this count
3692 % @raisesections: treat @section as chapter, @subsection as section, etc.
3693 \def\raisesections{\global\advance\secbase by -1}
3694 \let\up=\raisesections % original BFox name
3696 % @lowersections: treat @chapter as section, @section as subsection, etc.
3697 \def\lowersections{\global\advance\secbase by 1}
3698 \let\down=\lowersections % original BFox name
3700 % Choose a numbered-heading macro
3701 % #1 is heading level if unmodified by @raisesections or @lowersections
3702 % #2 is text for heading
3703 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3704 \ifcase\absseclevel
3705 \chapterzzz{#2}
3707 \seczzz{#2}
3709 \numberedsubseczzz{#2}
3711 \numberedsubsubseczzz{#2}
3712 \else
3713 \ifnum \absseclevel<0
3714 \chapterzzz{#2}
3715 \else
3716 \numberedsubsubseczzz{#2}
3721 % like \numhead, but chooses appendix heading levels
3722 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3723 \ifcase\absseclevel
3724 \appendixzzz{#2}
3726 \appendixsectionzzz{#2}
3728 \appendixsubseczzz{#2}
3730 \appendixsubsubseczzz{#2}
3731 \else
3732 \ifnum \absseclevel<0
3733 \appendixzzz{#2}
3734 \else
3735 \appendixsubsubseczzz{#2}
3740 % like \numhead, but chooses numberless heading levels
3741 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3742 \ifcase\absseclevel
3743 \unnumberedzzz{#2}
3745 \unnumberedseczzz{#2}
3747 \unnumberedsubseczzz{#2}
3749 \unnumberedsubsubseczzz{#2}
3750 \else
3751 \ifnum \absseclevel<0
3752 \unnumberedzzz{#2}
3753 \else
3754 \unnumberedsubsubseczzz{#2}
3759 % @chapter, @appendix, @unnumbered.
3760 \def\thischaptername{No Chapter Title}
3761 \outer\def\chapter{\parsearg\chapteryyy}
3762 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
3763 \def\chapterzzz #1{%
3764 \secno=0 \subsecno=0 \subsubsecno=0
3765 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}%
3766 \chapmacro {#1}{\the\chapno}%
3767 \gdef\thissection{#1}%
3768 \gdef\thischaptername{#1}%
3769 % We don't substitute the actual chapter name into \thischapter
3770 % because we don't want its macros evaluated now.
3771 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}%
3772 \writetocentry{chap}{#1}{{\the\chapno}}
3773 \donoderef
3774 \global\let\section = \numberedsec
3775 \global\let\subsection = \numberedsubsec
3776 \global\let\subsubsection = \numberedsubsubsec
3779 % we use \chapno to avoid indenting back
3780 \def\appendixbox#1{%
3781 \setbox0 = \hbox{\putwordAppendix{} \the\chapno}%
3782 \hbox to \wd0{#1\hss}}
3784 \outer\def\appendix{\parsearg\appendixyyy}
3785 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
3786 \def\appendixzzz #1{%
3787 \secno=0 \subsecno=0 \subsubsecno=0
3788 \global\advance \appendixno by 1
3789 \message{\putwordAppendix\space \appendixletter}%
3790 \chapmacro {#1}{\appendixbox{\putwordAppendix{} \appendixletter}}%
3791 \gdef\thissection{#1}%
3792 \gdef\thischaptername{#1}%
3793 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}%
3794 \writetocentry{appendix}{#1}{{\appendixletter}}
3795 \appendixnoderef
3796 \global\let\section = \appendixsec
3797 \global\let\subsection = \appendixsubsec
3798 \global\let\subsubsection = \appendixsubsubsec
3801 % @centerchap is like @unnumbered, but the heading is centered.
3802 \outer\def\centerchap{\parsearg\centerchapyyy}
3803 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}}
3805 % @top is like @unnumbered.
3806 \outer\def\top{\parsearg\unnumberedyyy}
3808 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3809 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3810 \def\unnumberedzzz #1{%
3811 \secno=0 \subsecno=0 \subsubsecno=0
3813 % This used to be simply \message{#1}, but TeX fully expands the
3814 % argument to \message. Therefore, if #1 contained @-commands, TeX
3815 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3816 % expanded @cite (which turns out to cause errors because \cite is meant
3817 % to be executed, not expanded).
3819 % Anyway, we don't want the fully-expanded definition of @cite to appear
3820 % as a result of the \message, we just want `@cite' itself. We use
3821 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3822 % simply yielding the contents of <toks register>. (We also do this for
3823 % the toc entries.)
3824 \toks0 = {#1}\message{(\the\toks0)}%
3826 \unnumbchapmacro {#1}%
3827 \gdef\thischapter{#1}\gdef\thissection{#1}%
3828 \writetocentry{unnumbchap}{#1}{{\the\chapno}}
3829 \unnumbnoderef
3830 \global\let\section = \unnumberedsec
3831 \global\let\subsection = \unnumberedsubsec
3832 \global\let\subsubsection = \unnumberedsubsubsec
3835 % Sections.
3836 \outer\def\numberedsec{\parsearg\secyyy}
3837 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
3838 \def\seczzz #1{%
3839 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3840 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
3841 \writetocentry{sec}{#1}{{\the\chapno}{\the\secno}}
3842 \donoderef
3843 \nobreak
3846 \outer\def\appendixsection{\parsearg\appendixsecyyy}
3847 \outer\def\appendixsec{\parsearg\appendixsecyyy}
3848 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
3849 \def\appendixsectionzzz #1{%
3850 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3851 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3852 \writetocentry{sec}{#1}{{\appendixletter}{\the\secno}}
3853 \appendixnoderef
3854 \nobreak
3857 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3858 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3859 \def\unnumberedseczzz #1{%
3860 \plainsecheading {#1}\gdef\thissection{#1}%
3861 \writetocentry{unnumbsec}{#1}{{\the\chapno}{\the\secno}}
3862 \unnumbnoderef
3863 \nobreak
3866 % Subsections.
3867 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
3868 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
3869 \def\numberedsubseczzz #1{%
3870 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3871 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
3872 \writetocentry{subsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3873 \donoderef
3874 \nobreak
3877 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
3878 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
3879 \def\appendixsubseczzz #1{%
3880 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
3881 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
3882 \writetocentry{subsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}}
3883 \appendixnoderef
3884 \nobreak
3887 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3888 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3889 \def\unnumberedsubseczzz #1{%
3890 \plainsubsecheading {#1}\gdef\thissection{#1}%
3891 \writetocentry{unnumbsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}}
3892 \unnumbnoderef
3893 \nobreak
3896 % Subsubsections.
3897 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
3898 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
3899 \def\numberedsubsubseczzz #1{%
3900 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3901 \subsubsecheading {#1}
3902 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3903 \writetocentry{subsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3904 \donoderef
3905 \nobreak
3908 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
3909 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
3910 \def\appendixsubsubseczzz #1{%
3911 \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
3912 \subsubsecheading {#1}
3913 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
3914 \writetocentry{subsubsec}{#1}{{\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3915 \appendixnoderef
3916 \nobreak
3919 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3920 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3921 \def\unnumberedsubsubseczzz #1{%
3922 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3923 \writetocentry{unnumbsubsubsec}{#1}{{\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}
3924 \unnumbnoderef
3925 \nobreak
3928 % These are variants which are not "outer", so they can appear in @ifinfo.
3929 % Actually, they should now be obsolete; ordinary section commands should work.
3930 \def\infotop{\parsearg\unnumberedzzz}
3931 \def\infounnumbered{\parsearg\unnumberedzzz}
3932 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3933 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3934 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3936 \def\infoappendix{\parsearg\appendixzzz}
3937 \def\infoappendixsec{\parsearg\appendixseczzz}
3938 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3939 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3941 \def\infochapter{\parsearg\chapterzzz}
3942 \def\infosection{\parsearg\sectionzzz}
3943 \def\infosubsection{\parsearg\subsectionzzz}
3944 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3946 % These macros control what the section commands do, according
3947 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3948 % Define them by default for a numbered chapter.
3949 \global\let\section = \numberedsec
3950 \global\let\subsection = \numberedsubsec
3951 \global\let\subsubsection = \numberedsubsubsec
3953 % Define @majorheading, @heading and @subheading
3955 % NOTE on use of \vbox for chapter headings, section headings, and such:
3956 % 1) We use \vbox rather than the earlier \line to permit
3957 % overlong headings to fold.
3958 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
3959 % heading is obnoxious; this forbids it.
3960 % 3) Likewise, headings look best if no \parindent is used, and
3961 % if justification is not attempted. Hence \raggedright.
3964 \def\majorheading{\parsearg\majorheadingzzz}
3965 \def\majorheadingzzz #1{%
3966 {\advance\chapheadingskip by 10pt \chapbreak }%
3967 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3968 \parindent=0pt\raggedright
3969 \rm #1\hfill}}\bigskip \par\penalty 200}
3971 \def\chapheading{\parsearg\chapheadingzzz}
3972 \def\chapheadingzzz #1{\chapbreak %
3973 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3974 \parindent=0pt\raggedright
3975 \rm #1\hfill}}\bigskip \par\penalty 200}
3977 % @heading, @subheading, @subsubheading.
3978 \def\heading{\parsearg\plainsecheading}
3979 \def\subheading{\parsearg\plainsubsecheading}
3980 \def\subsubheading{\parsearg\plainsubsubsecheading}
3982 % These macros generate a chapter, section, etc. heading only
3983 % (including whitespace, linebreaking, etc. around it),
3984 % given all the information in convenient, parsed form.
3986 %%% Args are the skip and penalty (usually negative)
3987 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3989 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3991 %%% Define plain chapter starts, and page on/off switching for it
3992 % Parameter controlling skip before chapter headings (if needed)
3994 \newskip\chapheadingskip
3996 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3997 \def\chappager{\par\vfill\supereject}
3998 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4000 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4002 \def\CHAPPAGoff{%
4003 \global\let\contentsalignmacro = \chappager
4004 \global\let\pchapsepmacro=\chapbreak
4005 \global\let\pagealignmacro=\chappager}
4007 \def\CHAPPAGon{%
4008 \global\let\contentsalignmacro = \chappager
4009 \global\let\pchapsepmacro=\chappager
4010 \global\let\pagealignmacro=\chappager
4011 \global\def\HEADINGSon{\HEADINGSsingle}}
4013 \def\CHAPPAGodd{
4014 \global\let\contentsalignmacro = \chapoddpage
4015 \global\let\pchapsepmacro=\chapoddpage
4016 \global\let\pagealignmacro=\chapoddpage
4017 \global\def\HEADINGSon{\HEADINGSdouble}}
4019 \CHAPPAGon
4021 \def\CHAPFplain{
4022 \global\let\chapmacro=\chfplain
4023 \global\let\unnumbchapmacro=\unnchfplain
4024 \global\let\centerchapmacro=\centerchfplain}
4026 % Plain chapter opening.
4027 % #1 is the text, #2 the chapter number or empty if unnumbered.
4028 \def\chfplain#1#2{%
4029 \pchapsepmacro
4031 \chapfonts \rm
4032 \def\chapnum{#2}%
4033 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}%
4034 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4035 \hangindent = \wd0 \centerparametersmaybe
4036 \unhbox0 #1\par}%
4038 \nobreak\bigskip % no page break after a chapter title
4039 \nobreak
4042 % Plain opening for unnumbered.
4043 \def\unnchfplain#1{\chfplain{#1}{}}
4045 % @centerchap -- centered and unnumbered.
4046 \let\centerparametersmaybe = \relax
4047 \def\centerchfplain#1{{%
4048 \def\centerparametersmaybe{%
4049 \advance\rightskip by 3\rightskip
4050 \leftskip = \rightskip
4051 \parfillskip = 0pt
4053 \chfplain{#1}{}%
4056 \CHAPFplain % The default
4058 \def\unnchfopen #1{%
4059 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4060 \parindent=0pt\raggedright
4061 \rm #1\hfill}}\bigskip \par\nobreak
4064 \def\chfopen #1#2{\chapoddpage {\chapfonts
4065 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4066 \par\penalty 5000 %
4069 \def\centerchfopen #1{%
4070 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4071 \parindent=0pt
4072 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4075 \def\CHAPFopen{
4076 \global\let\chapmacro=\chfopen
4077 \global\let\unnumbchapmacro=\unnchfopen
4078 \global\let\centerchapmacro=\centerchfopen}
4081 % Section titles.
4082 \newskip\secheadingskip
4083 \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
4084 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
4085 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
4087 % Subsection titles.
4088 \newskip \subsecheadingskip
4089 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
4090 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
4091 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
4093 % Subsubsection titles.
4094 \let\subsubsecheadingskip = \subsecheadingskip
4095 \let\subsubsecheadingbreak = \subsecheadingbreak
4096 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}}
4097 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}}
4100 % Print any size section title.
4102 % #1 is the section type (sec/subsec/subsubsec), #2 is the section
4103 % number (maybe empty), #3 the text.
4104 \def\sectionheading#1#2#3{%
4106 \expandafter\advance\csname #1headingskip\endcsname by \parskip
4107 \csname #1headingbreak\endcsname
4110 % Switch to the right set of fonts.
4111 \csname #1fonts\endcsname \rm
4113 % Only insert the separating space if we have a section number.
4114 \def\secnum{#2}%
4115 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
4117 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4118 \hangindent = \wd0 % zero if no section number
4119 \unhbox0 #3}%
4121 % Add extra space after the heading -- either a line space or a
4122 % paragraph space, whichever is more. (Some people like to set
4123 % \parskip to large values for some reason.) Don't allow stretch, though.
4124 \nobreak
4125 \ifdim\parskip>\normalbaselineskip
4126 \kern\parskip
4127 \else
4128 \kern\normalbaselineskip
4130 \nobreak
4134 \message{toc,}
4135 % Table of contents.
4136 \newwrite\tocfile
4138 % Write an entry to the toc file, opening it if necessary.
4139 % Called from @chapter, etc. We supply {\folio} at the end of the
4140 % argument, which will end up as the last argument to the \...entry macro.
4142 % Usage: \writetocentry{chap}{The Name of The Game}{{\the\chapno}}
4143 % We open the .toc file for writing here instead of at @setfilename (or
4144 % any other fixed time) so that @contents can be anywhere in the document.
4146 \newif\iftocfileopened
4147 \def\writetocentry#1#2#3{%
4148 \iftocfileopened\else
4149 \immediate\openout\tocfile = \jobname.toc
4150 \global\tocfileopenedtrue
4153 \iflinks
4154 \toks0 = {#2}%
4155 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}#3{\folio}}}%
4156 \temp
4159 % Tell \shipout to create a page destination if we're doing pdf, which
4160 % will be the target of the links in the table of contents. We can't
4161 % just do it on every page because the title pages are numbered 1 and
4162 % 2 (the page numbers aren't printed), and so are the first two pages
4163 % of the document. Thus, we'd have two destinations named `1', and
4164 % two named `2'.
4165 \ifpdf \pdfmakepagedesttrue \fi
4168 \newskip\contentsrightmargin \contentsrightmargin=1in
4169 \newcount\savepageno
4170 \newcount\lastnegativepageno \lastnegativepageno = -1
4172 % Finish up the main text and prepare to read what we've written
4173 % to \tocfile.
4175 \def\startcontents#1{%
4176 % If @setchapternewpage on, and @headings double, the contents should
4177 % start on an odd page, unlike chapters. Thus, we maintain
4178 % \contentsalignmacro in parallel with \pagealignmacro.
4179 % From: Torbjorn Granlund <tege@matematik.su.se>
4180 \contentsalignmacro
4181 \immediate\closeout\tocfile
4183 % Don't need to put `Contents' or `Short Contents' in the headline.
4184 % It is abundantly clear what they are.
4185 \unnumbchapmacro{#1}\def\thischapter{}%
4186 \savepageno = \pageno
4187 \begingroup % Set up to handle contents files properly.
4188 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4189 % We can't do this, because then an actual ^ in a section
4190 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4191 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4192 \raggedbottom % Worry more about breakpoints than the bottom.
4193 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4195 % Roman numerals for page numbers.
4196 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4200 % Normal (long) toc.
4201 \def\contents{%
4202 \startcontents{\putwordTOC}%
4203 \openin 1 \jobname.toc
4204 \ifeof 1 \else
4205 \closein 1
4206 \input \jobname.toc
4208 \vfill \eject
4209 \contentsalignmacro % in case @setchapternewpage odd is in effect
4210 \pdfmakeoutlines
4211 \endgroup
4212 \lastnegativepageno = \pageno
4213 \global\pageno = \savepageno
4216 % And just the chapters.
4217 \def\summarycontents{%
4218 \startcontents{\putwordShortTOC}%
4220 \let\chapentry = \shortchapentry
4221 \let\appendixentry = \shortappendixentry
4222 \let\unnumbchapentry = \shortunnumberedentry
4223 % We want a true roman here for the page numbers.
4224 \secfonts
4225 \let\rm=\shortcontrm \let\bf=\shortcontbf
4226 \let\sl=\shortcontsl \let\tt=\shortconttt
4228 \hyphenpenalty = 10000
4229 \advance\baselineskip by 1pt % Open it up a little.
4230 \def\secentry ##1##2##3##4{}
4231 \def\subsecentry ##1##2##3##4##5{}
4232 \def\subsubsecentry ##1##2##3##4##5##6{}
4233 \let\unnumbsecentry = \secentry
4234 \let\unnumbsubsecentry = \subsecentry
4235 \let\unnumbsubsubsecentry = \subsubsecentry
4236 \openin 1 \jobname.toc
4237 \ifeof 1 \else
4238 \closein 1
4239 \input \jobname.toc
4241 \vfill \eject
4242 \contentsalignmacro % in case @setchapternewpage odd is in effect
4243 \endgroup
4244 \lastnegativepageno = \pageno
4245 \global\pageno = \savepageno
4247 \let\shortcontents = \summarycontents
4249 \ifpdf
4250 \pdfcatalog{/PageMode /UseOutlines}%
4253 % These macros generate individual entries in the table of contents.
4254 % The first argument is the chapter or section name.
4255 % The last argument is the page number.
4256 % The arguments in between are the chapter number, section number, ...
4258 % Chapters, in the main contents.
4259 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
4261 % Chapters, in the short toc.
4262 % See comments in \dochapentry re vbox and related settings.
4263 \def\shortchapentry#1#2#3{%
4264 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}%
4267 % Appendices, in the main contents.
4268 \def\appendixentry#1#2#3{%
4269 \dochapentry{\appendixbox{\putwordAppendix{} #2}\labelspace#1}{#3}}
4271 % Appendices, in the short toc.
4272 \let\shortappendixentry = \shortchapentry
4274 % Typeset the label for a chapter or appendix for the short contents.
4275 % The arg is, e.g., `Appendix A' for an appendix, or `3' for a chapter.
4276 % We could simplify the code here by writing out an \appendixentry
4277 % command in the toc file for appendices, instead of using \chapentry
4278 % for both, but it doesn't seem worth it.
4280 \newdimen\shortappendixwidth
4282 \def\shortchaplabel#1{%
4283 % This space should be enough, since a single number is .5em, and the
4284 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4285 % But use \hss just in case.
4286 % (This space doesn't include the extra space that gets added after
4287 % the label; that gets put in by \shortchapentry above.)
4288 \dimen0 = 1em
4289 \hbox to \dimen0{#1\hss}%
4292 % Unnumbered chapters.
4293 \def\unnumbchapentry#1#2#3{\dochapentry{#1}{#3}}
4294 \def\shortunnumberedentry#1#2#3{\tocentry{#1}{\doshortpageno\bgroup#3\egroup}}
4296 % Sections.
4297 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
4298 \def\unnumbsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4300 % Subsections.
4301 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
4302 \def\unnumbsubsecentry#1#2#3#4#5{\dosubsecentry{#1}{#5}}
4304 % And subsubsections.
4305 \def\subsubsecentry#1#2#3#4#5#6{%
4306 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
4307 \def\unnumbsubsubsecentry#1#2#3#4#5#6{\dosubsubsecentry{#1}{#6}}
4309 % This parameter controls the indentation of the various levels.
4310 \newdimen\tocindent \tocindent = 3pc
4312 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4313 % page number.
4315 % If the toc has to be broken over pages, we want it to be at chapters
4316 % if at all possible; hence the \penalty.
4317 \def\dochapentry#1#2{%
4318 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4319 \begingroup
4320 \chapentryfonts
4321 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4322 \endgroup
4323 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4326 \def\dosecentry#1#2{\begingroup
4327 \secentryfonts \leftskip=\tocindent
4328 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4329 \endgroup}
4331 \def\dosubsecentry#1#2{\begingroup
4332 \subsecentryfonts \leftskip=2\tocindent
4333 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4334 \endgroup}
4336 \def\dosubsubsecentry#1#2{\begingroup
4337 \subsubsecentryfonts \leftskip=3\tocindent
4338 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4339 \endgroup}
4341 % Final typesetting of a toc entry; we use the same \entry macro as for
4342 % the index entries, but we want to suppress hyphenation here. (We
4343 % can't do that in the \entry macro, since index entries might consist
4344 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
4345 \def\tocentry#1#2{\begingroup
4346 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
4347 % Do not use \turnoffactive in these arguments. Since the toc is
4348 % typeset in cmr, characters such as _ would come out wrong; we
4349 % have to do the usual translation tricks.
4350 \entry{#1}{#2}%
4351 \endgroup}
4353 % Space between chapter (or whatever) number and the title.
4354 \def\labelspace{\hskip1em \relax}
4356 \def\dopageno#1{{\rm #1}}
4357 \def\doshortpageno#1{{\rm #1}}
4359 \def\chapentryfonts{\secfonts \rm}
4360 \def\secentryfonts{\textfonts}
4361 \let\subsecentryfonts = \textfonts
4362 \let\subsubsecentryfonts = \textfonts
4365 \message{environments,}
4366 % @foo ... @end foo.
4368 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4370 % Since these characters are used in examples, it should be an even number of
4371 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4373 \def\point{$\star$}
4374 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4375 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4376 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4377 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4379 % The @error{} command.
4380 % Adapted from the TeXbook's \boxit.
4382 \newbox\errorbox
4384 {\tentt \global\dimen0 = 3em}% Width of the box.
4385 \dimen2 = .55pt % Thickness of rules
4386 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4387 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4389 \global\setbox\errorbox=\hbox to \dimen0{\hfil
4390 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4391 \advance\hsize by -2\dimen2 % Rules.
4392 \vbox{
4393 \hrule height\dimen2
4394 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4395 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4396 \kern3pt\vrule width\dimen2}% Space to right.
4397 \hrule height\dimen2}
4398 \hfil}
4400 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4402 % @tex ... @end tex escapes into raw Tex temporarily.
4403 % One exception: @ is still an escape character, so that @end tex works.
4404 % But \@ or @@ will get a plain tex @ character.
4406 \def\tex{\begingroup
4407 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4408 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4409 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4410 \catcode `\%=14
4411 \catcode `\+=\other
4412 \catcode `\"=\other
4413 \catcode `\==\other
4414 \catcode `\|=\other
4415 \catcode `\<=\other
4416 \catcode `\>=\other
4417 \escapechar=`\\
4419 \let\b=\ptexb
4420 \let\bullet=\ptexbullet
4421 \let\c=\ptexc
4422 \let\,=\ptexcomma
4423 \let\.=\ptexdot
4424 \let\dots=\ptexdots
4425 \let\equiv=\ptexequiv
4426 \let\!=\ptexexclam
4427 \let\i=\ptexi
4428 \let\{=\ptexlbrace
4429 \let\+=\tabalign
4430 \let\}=\ptexrbrace
4431 \let\*=\ptexstar
4432 \let\t=\ptext
4434 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4435 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4436 \def\@{@}%
4437 \let\Etex=\endgroup}
4439 % Define @lisp ... @end lisp.
4440 % @lisp does a \begingroup so it can rebind things,
4441 % including the definition of @end lisp (which normally is erroneous).
4443 % Amount to narrow the margins by for @lisp.
4444 \newskip\lispnarrowing \lispnarrowing=0.4in
4446 % This is the definition that ^^M gets inside @lisp, @example, and other
4447 % such environments. \null is better than a space, since it doesn't
4448 % have any width.
4449 \def\lisppar{\null\endgraf}
4451 % Make each space character in the input produce a normal interword
4452 % space in the output. Don't allow a line break at this space, as this
4453 % is used only in environments like @example, where each line of input
4454 % should produce a line of output anyway.
4456 {\obeyspaces %
4457 \gdef\sepspaces{\obeyspaces\let =\tie}}
4459 % Define \obeyedspace to be our active space, whatever it is. This is
4460 % for use in \parsearg.
4461 {\sepspaces%
4462 \global\let\obeyedspace= }
4464 % This space is always present above and below environments.
4465 \newskip\envskipamount \envskipamount = 0pt
4467 % Make spacing and below environment symmetrical. We use \parskip here
4468 % to help in doing that, since in @example-like environments \parskip
4469 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4470 % start of the next paragraph will insert \parskip.
4472 \def\aboveenvbreak{{%
4473 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4474 \ifnum \lastpenalty=10000 \else
4475 \advance\envskipamount by \parskip
4476 \endgraf
4477 \ifdim\lastskip<\envskipamount
4478 \removelastskip
4479 % it's not a good place to break if the last penalty was \nobreak
4480 % or better ...
4481 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4482 \vskip\envskipamount
4487 \let\afterenvbreak = \aboveenvbreak
4489 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4490 \let\nonarrowing=\relax
4492 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4493 % environment contents.
4494 \font\circle=lcircle10
4495 \newdimen\circthick
4496 \newdimen\cartouter\newdimen\cartinner
4497 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4498 \circthick=\fontdimen8\circle
4500 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4501 \def\ctr{{\hskip 6pt\circle\char'010}}
4502 \def\cbl{{\circle\char'012\hskip -6pt}}
4503 \def\cbr{{\hskip 6pt\circle\char'011}}
4504 \def\carttop{\hbox to \cartouter{\hskip\lskip
4505 \ctl\leaders\hrule height\circthick\hfil\ctr
4506 \hskip\rskip}}
4507 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4508 \cbl\leaders\hrule height\circthick\hfil\cbr
4509 \hskip\rskip}}
4511 \newskip\lskip\newskip\rskip
4513 \def\cartouche{%
4514 \par % can't be in the midst of a paragraph.
4515 \begingroup
4516 \lskip=\leftskip \rskip=\rightskip
4517 \leftskip=0pt\rightskip=0pt %we want these *outside*.
4518 \cartinner=\hsize \advance\cartinner by-\lskip
4519 \advance\cartinner by-\rskip
4520 \cartouter=\hsize
4521 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4522 % side, and for 6pt waste from
4523 % each corner char, and rule thickness
4524 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4525 % Flag to tell @lisp, etc., not to narrow margin.
4526 \let\nonarrowing=\comment
4527 \vbox\bgroup
4528 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4529 \carttop
4530 \hbox\bgroup
4531 \hskip\lskip
4532 \vrule\kern3pt
4533 \vbox\bgroup
4534 \hsize=\cartinner
4535 \kern3pt
4536 \begingroup
4537 \baselineskip=\normbskip
4538 \lineskip=\normlskip
4539 \parskip=\normpskip
4540 \vskip -\parskip
4541 \def\Ecartouche{%
4542 \endgroup
4543 \kern3pt
4544 \egroup
4545 \kern3pt\vrule
4546 \hskip\rskip
4547 \egroup
4548 \cartbot
4549 \egroup
4550 \endgroup
4554 % This macro is called at the beginning of all the @example variants,
4555 % inside a group.
4556 \def\nonfillstart{%
4557 \aboveenvbreak
4558 \inENV % This group ends at the end of the body
4559 \hfuzz = 12pt % Don't be fussy
4560 \sepspaces % Make spaces be word-separators rather than space tokens.
4561 \let\par = \lisppar % don't ignore blank lines
4562 \obeylines % each line of input is a line of output
4563 \parskip = 0pt
4564 \parindent = 0pt
4565 \emergencystretch = 0pt % don't try to avoid overfull boxes
4566 % @cartouche defines \nonarrowing to inhibit narrowing
4567 % at next level down.
4568 \ifx\nonarrowing\relax
4569 \advance \leftskip by \lispnarrowing
4570 \exdentamount=\lispnarrowing
4571 \let\exdent=\nofillexdent
4572 \let\nonarrowing=\relax
4576 % Define the \E... control sequence only if we are inside the particular
4577 % environment, so the error checking in \end will work.
4579 % To end an @example-like environment, we first end the paragraph (via
4580 % \afterenvbreak's vertical glue), and then the group. That way we keep
4581 % the zero \parskip that the environments set -- \parskip glue will be
4582 % inserted at the beginning of the next paragraph in the document, after
4583 % the environment.
4585 \def\nonfillfinish{\afterenvbreak\endgroup}
4587 % @lisp: indented, narrowed, typewriter font.
4588 \def\lisp{\begingroup
4589 \nonfillstart
4590 \let\Elisp = \nonfillfinish
4592 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4593 \gobble % eat return
4596 % @example: Same as @lisp.
4597 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
4599 % @smallexample and @smalllisp: use smaller fonts.
4600 % Originally contributed by Pavel@xerox.
4601 \def\smalllisp{\begingroup
4602 \def\Esmalllisp{\nonfillfinish\endgroup}%
4603 \def\Esmallexample{\nonfillfinish\endgroup}%
4604 \smallexamplefonts
4605 \lisp
4607 \let\smallexample = \smalllisp
4610 % @display: same as @lisp except keep current font.
4612 \def\display{\begingroup
4613 \nonfillstart
4614 \let\Edisplay = \nonfillfinish
4615 \gobble
4618 % @smalldisplay: @display plus smaller fonts.
4620 \def\smalldisplay{\begingroup
4621 \def\Esmalldisplay{\nonfillfinish\endgroup}%
4622 \smallexamplefonts \rm
4623 \display
4626 % @format: same as @display except don't narrow margins.
4628 \def\format{\begingroup
4629 \let\nonarrowing = t
4630 \nonfillstart
4631 \let\Eformat = \nonfillfinish
4632 \gobble
4635 % @smallformat: @format plus smaller fonts.
4637 \def\smallformat{\begingroup
4638 \def\Esmallformat{\nonfillfinish\endgroup}%
4639 \smallexamplefonts \rm
4640 \format
4643 % @flushleft (same as @format).
4645 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4647 % @flushright.
4649 \def\flushright{\begingroup
4650 \let\nonarrowing = t
4651 \nonfillstart
4652 \let\Eflushright = \nonfillfinish
4653 \advance\leftskip by 0pt plus 1fill
4654 \gobble
4658 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4659 % and narrows the margins.
4661 \def\quotation{%
4662 \begingroup\inENV %This group ends at the end of the @quotation body
4663 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4664 \parindent=0pt
4665 % We have retained a nonzero parskip for the environment, since we're
4666 % doing normal filling. So to avoid extra space below the environment...
4667 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4669 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4670 \ifx\nonarrowing\relax
4671 \advance\leftskip by \lispnarrowing
4672 \advance\rightskip by \lispnarrowing
4673 \exdentamount = \lispnarrowing
4674 \let\nonarrowing = \relax
4679 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4680 % If we want to allow any <char> as delimiter,
4681 % we need the curly braces so that makeinfo sees the @verb command, eg:
4682 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4684 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4686 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4687 % active too. Otherwise, they get lost as the first character on a
4688 % verbatim line.
4689 \def\dospecials{%
4690 \do\ \do\\\do\{\do\}\do\$\do\&%
4691 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4692 \do\<\do\>\do\|\do\@\do+\do\"%
4695 % [Knuth] p. 380
4696 \def\uncatcodespecials{%
4697 \def\do##1{\catcode`##1=12}\dospecials}
4699 % [Knuth] pp. 380,381,391
4700 % Disable Spanish ligatures ?` and !` of \tt font
4701 \begingroup
4702 \catcode`\`=\active\gdef`{\relax\lq}
4703 \endgroup
4705 % Setup for the @verb command.
4707 % Eight spaces for a tab
4708 \begingroup
4709 \catcode`\^^I=\active
4710 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4711 \endgroup
4713 \def\setupverb{%
4714 \tt % easiest (and conventionally used) font for verbatim
4715 \def\par{\leavevmode\endgraf}%
4716 \catcode`\`=\active
4717 \tabeightspaces
4718 % Respect line breaks,
4719 % print special symbols as themselves, and
4720 % make each space count
4721 % must do in this order:
4722 \obeylines \uncatcodespecials \sepspaces
4725 % Setup for the @verbatim environment
4727 % Real tab expansion
4728 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4730 \def\starttabbox{\setbox0=\hbox\bgroup}
4731 \begingroup
4732 \catcode`\^^I=\active
4733 \gdef\tabexpand{%
4734 \catcode`\^^I=\active
4735 \def^^I{\leavevmode\egroup
4736 \dimen0=\wd0 % the width so far, or since the previous tab
4737 \divide\dimen0 by\tabw
4738 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4739 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4740 \wd0=\dimen0 \box0 \starttabbox
4743 \endgroup
4744 \def\setupverbatim{%
4745 % Easiest (and conventionally used) font for verbatim
4747 \def\par{\leavevmode\egroup\box0\endgraf}%
4748 \catcode`\`=\active
4749 \tabexpand
4750 % Respect line breaks,
4751 % print special symbols as themselves, and
4752 % make each space count
4753 % must do in this order:
4754 \obeylines \uncatcodespecials \sepspaces
4755 \everypar{\starttabbox}%
4758 % Do the @verb magic: verbatim text is quoted by unique
4759 % delimiter characters. Before first delimiter expect a
4760 % right brace, after last delimiter expect closing brace:
4762 % \def\doverb'{'<char>#1<char>'}'{#1}
4764 % [Knuth] p. 382; only eat outer {}
4765 \begingroup
4766 \catcode`[=1\catcode`]=2\catcode`\{=12\catcode`\}=12
4767 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4768 \endgroup
4770 \def\verb{\begingroup\setupverb\doverb}
4773 % Do the @verbatim magic: define the macro \doverbatim so that
4774 % the (first) argument ends when '@end verbatim' is reached, ie:
4776 % \def\doverbatim#1@end verbatim{#1}
4778 % For Texinfo it's a lot easier than for LaTeX,
4779 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4780 % we need not redefine '\', '{' and '}'.
4782 % Inspired by LaTeX's verbatim command set [latex.ltx]
4783 %% Include LaTeX hack for completeness -- never know
4784 %% \begingroup
4785 %% \catcode`|=0 \catcode`[=1
4786 %% \catcode`]=2\catcode`\{=12\catcode`\}=12\catcode`\ =\active
4787 %% \catcode`\\=12|gdef|doverbatim#1@end verbatim[
4788 %% #1|endgroup|def|Everbatim[]|end[verbatim]]
4789 %% |endgroup
4791 \begingroup
4792 \catcode`\ =\active
4793 \obeylines %
4794 % ignore everything up to the first ^^M, that's the newline at the end
4795 % of the @verbatim input line itself. Otherwise we get an extra blank
4796 % line in the output.
4797 \gdef\doverbatim#1^^M#2@end verbatim{#2\end{verbatim}}%
4798 \endgroup
4800 \def\verbatim{%
4801 \def\Everbatim{\nonfillfinish\endgroup}%
4802 \begingroup
4803 \nonfillstart
4804 \advance\leftskip by -\defbodyindent
4805 \begingroup\setupverbatim\doverbatim
4808 % @verbatiminclude FILE - insert text of file in verbatim environment.
4810 % Allow normal characters that we make active in the argument (a file name).
4811 \def\verbatiminclude{%
4812 \begingroup
4813 \catcode`\\=\other
4814 \catcode`~=\other
4815 \catcode`^=\other
4816 \catcode`_=\other
4817 \catcode`|=\other
4818 \catcode`<=\other
4819 \catcode`>=\other
4820 \catcode`+=\other
4821 \parsearg\doverbatiminclude
4823 \def\setupverbatiminclude{%
4824 \begingroup
4825 \nonfillstart
4826 \advance\leftskip by -\defbodyindent
4827 \begingroup\setupverbatim
4830 \def\doverbatiminclude#1{%
4831 % Restore active chars for included file.
4832 \endgroup
4833 \begingroup
4834 \let\value=\expandablevalue
4835 \def\thisfile{#1}%
4836 \expandafter\expandafter\setupverbatiminclude\input\thisfile
4837 \endgroup
4838 \nonfillfinish
4839 \endgroup
4842 % @copying ... @end copying.
4843 % Save the text away for @insertcopying later. Many commands won't be
4844 % allowed in this context, but that's ok.
4846 % We save the uninterpreted tokens, rather than creating a box.
4847 % Saving the text in a box would be much easier, but then all the
4848 % typesetting commands (@smallbook, font changes, etc.) have to be done
4849 % beforehand -- and a) we want @copying to be done first in the source
4850 % file; b) letting users define the frontmatter in as flexible order as
4851 % possible is very desirable.
4853 \def\copying{\begingroup
4854 % Define a command to swallow text until we reach `@end copying'.
4855 % \ is the escape char in this texinfo.tex file, so it is the
4856 % delimiter for the command; @ will be the escape char when we read
4857 % it, but that doesn't matter.
4858 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4860 % We must preserve ^^M's in the input file; see \insertcopying below.
4861 \catcode`\^^M = \active
4862 \docopying
4865 % What we do to finish off the copying text.
4867 \def\enddocopying{\endgroup\ignorespaces}
4869 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4870 % we need them to delimit commands such as `@end quotation', so they
4871 % must be active. On the other hand, we certainly don't want every
4872 % end-of-line to be a \par, as would happen with the normal active
4873 % definition of ^^M. On the third hand, two ^^M's in a row should still
4874 % generate a \par.
4876 % Our approach is to make ^^M insert a space and a penalty1 normally;
4877 % then it can also check if \lastpenalty=1. If it does, then manually
4878 % do \par.
4880 % This messes up the normal definitions of @c[omment], so we redefine
4881 % it. Similarly for @ignore. (These commands are used in the gcc
4882 % manual for man page generation.)
4884 % Seems pretty fragile, most line-oriented commands will presumably
4885 % fail, but for the limited use of getting the copying text (which
4886 % should be quite simple) inserted, we can hope it's ok.
4888 {\catcode`\^^M=\active %
4889 \gdef\insertcopying{\begingroup %
4890 \parindent = 0pt % looks wrong on title page
4891 \def^^M{%
4892 \ifnum \lastpenalty=1 %
4893 \par %
4894 \else %
4895 \space \penalty 1 %
4896 \fi %
4899 % Fix @c[omment] for catcode 13 ^^M's.
4900 \def\c##1^^M{\ignorespaces}%
4901 \let\comment = \c %
4903 % Don't bother jumping through all the hoops that \doignore does, it
4904 % would be very hard since the catcodes are already set.
4905 \long\def\ignore##1\end ignore{\ignorespaces}%
4907 \copyingtext %
4908 \endgroup}%
4911 \message{defuns,}
4912 % @defun etc.
4914 % Allow user to change definition object font (\df) internally
4915 \def\setdeffont#1 {\csname DEF#1\endcsname}
4917 \newskip\defbodyindent \defbodyindent=.4in
4918 \newskip\defargsindent \defargsindent=50pt
4919 \newskip\deflastargmargin \deflastargmargin=18pt
4921 \newcount\parencount
4923 % We want ()&[] to print specially on the defun line.
4925 \def\activeparens{%
4926 \catcode`\(=\active \catcode`\)=\active
4927 \catcode`\&=\active
4928 \catcode`\[=\active \catcode`\]=\active
4931 % Make control sequences which act like normal parenthesis chars.
4932 \let\lparen = ( \let\rparen = )
4934 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4936 % Be sure that we always have a definition for `(', etc. For example,
4937 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4938 % so TeX would otherwise complain about undefined control sequence.
4939 \global\let(=\lparen \global\let)=\rparen
4940 \global\let[=\lbrack \global\let]=\rbrack
4942 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
4943 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4944 % This is used to turn on special parens
4945 % but make & act ordinary (given that it's active).
4946 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr}
4948 % Definitions of (, ) and & used in args for functions.
4949 % This is the definition of ( outside of all parentheses.
4950 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested
4951 \global\advance\parencount by 1
4954 % This is the definition of ( when already inside a level of parens.
4955 \gdef\opnested{\char`\(\global\advance\parencount by 1 }
4957 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
4958 % also in that case restore the outer-level definition of (.
4959 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
4960 \global\advance \parencount by -1 }
4961 % If we encounter &foo, then turn on ()-hacking afterwards
4962 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ }
4964 \gdef\normalparens{\boldbrax\let&=\ampnr}
4965 } % End of definition inside \activeparens
4966 %% These parens (in \boldbrax) actually are a little bolder than the
4967 %% contained text. This is especially needed for [ and ]
4968 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 }
4969 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 }
4970 \let\ampnr = \&
4971 \def\lbrb{{\bf\char`\[}}
4972 \def\rbrb{{\bf\char`\]}}
4974 % Active &'s sneak into the index arguments, so make sure it's defined.
4976 \catcode`& = \active
4977 \global\let& = \ampnr
4980 % \defname, which formats the name of the @def (not the args).
4981 % #1 is the function name.
4982 % #2 is the type of definition, such as "Function".
4984 \def\defname#1#2{%
4985 % How we'll output the type name. Putting it in brackets helps
4986 % distinguish it from the body text that may end up on the next line
4987 % just below it.
4988 \ifempty{#2}%
4989 \def\defnametype{}%
4990 \else
4991 \def\defnametype{[\rm #2]}%
4994 % Get the values of \leftskip and \rightskip as they were outside the @def...
4995 \dimen2=\leftskip
4996 \advance\dimen2 by -\defbodyindent
4998 % Figure out values for the paragraph shape.
4999 \setbox0=\hbox{\hskip \deflastargmargin{\defnametype}}%
5000 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
5001 \dimen1=\hsize \advance \dimen1 by -\defargsindent % size for continuations
5002 \parshape 2 0in \dimen0 \defargsindent \dimen1
5004 % Output arg 2 ("Function" or some such) but stuck inside a box of
5005 % width 0 so it does not interfere with linebreaking.
5006 \noindent
5008 {% Adjust \hsize to exclude the ambient margins,
5009 % so that \rightline will obey them.
5010 \advance \hsize by -\dimen2
5011 \dimen3 = 0pt % was -1.25pc
5012 \rlap{\rightline{\defnametype\kern\dimen3}}%
5015 % Allow all lines to be underfull without complaint:
5016 \tolerance=10000 \hbadness=10000
5017 \advance\leftskip by -\defbodyindent
5018 \exdentamount=\defbodyindent
5019 {\df #1}\enskip % output function name
5020 % \defunargs will be called next to output the arguments, if any.
5023 % Common pieces to start any @def...
5024 % #1 is the \E... control sequence to end the definition (which we define).
5025 % #2 is the \...x control sequence (which our caller defines).
5026 % #3 is the control sequence to process the header, such as \defunheader.
5028 \def\parsebodycommon#1#2#3{%
5029 \begingroup\inENV
5030 % If there are two @def commands in a row, we'll have a \nobreak,
5031 % which is there to keep the function description together with its
5032 % header. But if there's nothing but headers, we want to allow a
5033 % break after all. Check for penalty 10002 (inserted by
5034 % \defargscommonending) instead of 10000, since the sectioning
5035 % commands insert a \penalty10000, and we don't want to allow a break
5036 % between a section heading and a defun.
5037 \ifnum\lastpenalty=10002 \penalty0 \fi
5038 \medbreak
5040 % Define the \E... end token that this defining construct specifies
5041 % so that it will exit this group.
5042 \def#1{\endgraf\endgroup\medbreak}%
5044 \parindent=0in
5045 \advance\leftskip by \defbodyindent
5046 \exdentamount=\defbodyindent
5049 % Common part of the \...x definitions.
5051 \def\defxbodycommon{%
5052 % As with \parsebodycommon above, allow line break if we have multiple
5053 % x headers in a row. It's not a great place, though.
5054 \ifnum\lastpenalty=10000 \penalty1000 \fi
5056 \begingroup\obeylines
5059 % Process body of @defun, @deffn, @defmac, etc.
5061 \def\defparsebody#1#2#3{%
5062 \parsebodycommon{#1}{#2}{#3}%
5063 \def#2{\defxbodycommon \activeparens \spacesplit#3}%
5064 \catcode\equalChar=\active
5065 \begingroup\obeylines\activeparens
5066 \spacesplit#3%
5069 % #1, #2, #3 are the common arguments (see \parsebodycommon above).
5070 % #4, delimited by the space, is the class name.
5072 \def\defmethparsebody#1#2#3#4 {%
5073 \parsebodycommon{#1}{#2}{#3}%
5074 \def#2##1 {\defxbodycommon \activeparens \spacesplit{#3{##1}}}%
5075 \begingroup\obeylines\activeparens
5076 % The \empty here prevents misinterpretation of a construct such as
5077 % @deffn {whatever} {Enharmonic comma}
5078 % See comments at \deftpparsebody, although in our case we don't have
5079 % to remove the \empty afterwards, since it is empty.
5080 \spacesplit{#3{#4}}\empty
5083 % Used for @deftypemethod and @deftypeivar.
5084 % #1, #2, #3 are the common arguments (see \defparsebody).
5085 % #4, delimited by a space, is the class name.
5086 % #5 is the method's return type.
5088 \def\deftypemethparsebody#1#2#3#4 #5 {%
5089 \parsebodycommon{#1}{#2}{#3}%
5090 \def#2##1 ##2 {\defxbodycommon \activeparens \spacesplit{#3{##1}{##2}}}%
5091 \begingroup\obeylines\activeparens
5092 \spacesplit{#3{#4}{#5}}%
5095 % Used for @deftypeop. The change from \deftypemethparsebody is an
5096 % extra argument at the beginning which is the `category', instead of it
5097 % being the hardwired string `Method' or `Instance Variable'. We have
5098 % to account for this both in the \...x definition and in parsing the
5099 % input at hand. Thus also need a control sequence (passed as #5) for
5100 % the \E... definition to assign the category name to.
5102 \def\deftypeopparsebody#1#2#3#4#5 #6 {%
5103 \parsebodycommon{#1}{#2}{#3}%
5104 \def#2##1 ##2 ##3 {\def#4{##1}%
5105 \defxbodycommon \activeparens \spacesplit{#3{##2}{##3}}}%
5106 \begingroup\obeylines\activeparens
5107 \spacesplit{#3{#5}{#6}}%
5110 % For @defop.
5111 \def\defopparsebody #1#2#3#4#5 {%
5112 \parsebodycommon{#1}{#2}{#3}%
5113 \def#2##1 ##2 {\def#4{##1}%
5114 \defxbodycommon \activeparens \spacesplit{#3{##2}}}%
5115 \begingroup\obeylines\activeparens
5116 \spacesplit{#3{#5}}%
5119 % These parsing functions are similar to the preceding ones
5120 % except that they do not make parens into active characters.
5121 % These are used for "variables" since they have no arguments.
5123 \def\defvarparsebody #1#2#3{%
5124 \parsebodycommon{#1}{#2}{#3}%
5125 \def#2{\defxbodycommon \spacesplit#3}%
5126 \catcode\equalChar=\active
5127 \begingroup\obeylines
5128 \spacesplit#3%
5131 % @defopvar.
5132 \def\defopvarparsebody #1#2#3#4#5 {%
5133 \parsebodycommon{#1}{#2}{#3}%
5134 \def#2##1 ##2 {\def#4{##1}%
5135 \defxbodycommon \spacesplit{#3{##2}}}%
5136 \begingroup\obeylines
5137 \spacesplit{#3{#5}}%
5140 \def\defvrparsebody#1#2#3#4 {%
5141 \parsebodycommon{#1}{#2}{#3}%
5142 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5143 \begingroup\obeylines
5144 \spacesplit{#3{#4}}%
5147 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
5148 % type is just `struct', because we lose the braces in `{struct
5149 % termios}' when \spacesplit reads its undelimited argument. Sigh.
5150 % \let\deftpparsebody=\defvrparsebody
5152 % So, to get around this, we put \empty in with the type name. That
5153 % way, TeX won't find exactly `{...}' as an undelimited argument, and
5154 % won't strip off the braces.
5156 \def\deftpparsebody #1#2#3#4 {%
5157 \parsebodycommon{#1}{#2}{#3}%
5158 \def#2##1 {\defxbodycommon \spacesplit{#3{##1}}}%
5159 \begingroup\obeylines
5160 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
5163 % Fine, but then we have to eventually remove the \empty *and* the
5164 % braces (if any). That's what this does.
5166 \def\removeemptybraces\empty#1\relax{#1}
5168 % After \spacesplit has done its work, this is called -- #1 is the final
5169 % thing to call, #2 the type name (which starts with \empty), and #3
5170 % (which might be empty) the arguments.
5172 \def\parsetpheaderline#1#2#3{%
5173 #1{\removeemptybraces#2\relax}{#3}%
5176 % Split up #2 (the rest of the input line) at the first space token.
5177 % call #1 with two arguments:
5178 % the first is all of #2 before the space token,
5179 % the second is all of #2 after that space token.
5180 % If #2 contains no space token, all of it is passed as the first arg
5181 % and the second is passed as empty.
5183 {\obeylines %
5184 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitx{#1}#2 \relax\spacesplitx}%
5185 \long\gdef\spacesplitx#1#2 #3#4\spacesplitx{%
5186 \ifx\relax #3%
5187 #1{#2}{}%
5188 \else %
5189 #1{#2}{#3#4}%
5190 \fi}%
5193 % Define @defun.
5195 % This is called to end the arguments processing for all the @def... commands.
5197 \def\defargscommonending{%
5198 \interlinepenalty = 10000
5199 \advance\rightskip by 0pt plus 1fil
5200 \endgraf
5201 \nobreak\vskip -\parskip
5202 \penalty 10002 % signal to \parsebodycommon.
5205 % This expands the args and terminates the paragraph they comprise.
5207 \def\defunargs#1{\functionparens \sl
5208 % Expand, preventing hyphenation at `-' chars.
5209 % Note that groups don't affect changes in \hyphenchar.
5210 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
5211 {\tensl\hyphenchar\font=0}%
5213 {\tensl\hyphenchar\font=45}%
5214 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
5215 \defargscommonending
5218 \def\deftypefunargs #1{%
5219 % Expand, preventing hyphenation at `-' chars.
5220 % Note that groups don't affect changes in \hyphenchar.
5221 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
5222 \boldbraxnoamp
5223 \tclose{#1}% avoid \code because of side effects on active chars
5224 \defargscommonending
5227 % Do complete processing of one @defun or @defunx line already parsed.
5229 % @deffn Command forward-char nchars
5231 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
5233 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
5234 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
5235 \catcode\equalChar=\other % Turn off change made in \defparsebody
5238 % @defun == @deffn Function
5240 \def\defun{\defparsebody\Edefun\defunx\defunheader}
5242 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5243 \begingroup\defname {#1}{\putwordDeffunc}%
5244 \defunargs {#2}\endgroup %
5245 \catcode\equalChar=\other % Turn off change made in \defparsebody
5248 % @deftypefun int foobar (int @var{foo}, float @var{bar})
5250 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
5252 % #1 is the data type. #2 is the name and args.
5253 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
5254 % #1 is the data type, #2 the name, #3 the args.
5255 \def\deftypefunheaderx #1#2 #3\relax{%
5256 \doind {fn}{\code{#2}}% Make entry in function index
5257 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypefun}%
5258 \deftypefunargs {#3}\endgroup %
5259 \catcode\equalChar=\other % Turn off change made in \defparsebody
5262 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
5264 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
5266 % \defheaderxcond#1\relax$.$
5267 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
5268 \def\defheaderxcond#1#2$.${\ifx#1\relax\else\code{#1#2} \fi}
5270 % #1 is the classification. #2 is the data type. #3 is the name and args.
5271 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
5272 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
5273 \def\deftypefnheaderx #1#2#3 #4\relax{%
5274 \doind {fn}{\code{#3}}% Make entry in function index
5275 \begingroup
5276 \normalparens % notably, turn off `&' magic, which prevents
5277 % at least some C++ text from working
5278 \defname {\defheaderxcond#2\relax$.$#3}{#1}%
5279 \deftypefunargs {#4}\endgroup %
5280 \catcode\equalChar=\other % Turn off change made in \defparsebody
5283 % @defmac == @deffn Macro
5285 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
5287 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5288 \begingroup\defname {#1}{\putwordDefmac}%
5289 \defunargs {#2}\endgroup %
5290 \catcode\equalChar=\other % Turn off change made in \defparsebody
5293 % @defspec == @deffn Special Form
5295 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
5297 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
5298 \begingroup\defname {#1}{\putwordDefspec}%
5299 \defunargs {#2}\endgroup %
5300 \catcode\equalChar=\other % Turn off change made in \defparsebody
5303 % @defop CATEGORY CLASS OPERATION ARG...
5305 \def\defop #1 {\def\defoptype{#1}%
5306 \defopparsebody\Edefop\defopx\defopheader\defoptype}
5308 \def\defopheader#1#2#3{%
5309 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% function index entry
5310 \begingroup
5311 \defname{#2}{\defoptype\ \putwordon\ #1}%
5312 \defunargs{#3}%
5313 \endgroup
5316 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
5318 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
5319 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
5320 \deftypeopcategory}
5322 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
5323 \def\deftypeopheader#1#2#3#4{%
5324 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5325 \begingroup
5326 \defname{\defheaderxcond#2\relax$.$#3}
5327 {\deftypeopcategory\ \putwordon\ \code{#1}}%
5328 \deftypefunargs{#4}%
5329 \endgroup
5332 % @deftypemethod CLASS TYPE METHOD ARG...
5334 \def\deftypemethod{%
5335 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
5337 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
5338 \def\deftypemethodheader#1#2#3#4{%
5339 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
5340 \begingroup
5341 \defname{\defheaderxcond#2\relax$.$#3}{\putwordMethodon\ \code{#1}}%
5342 \deftypefunargs{#4}%
5343 \endgroup
5346 % @deftypeivar CLASS TYPE VARNAME
5348 \def\deftypeivar{%
5349 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
5351 % #1 is the class name, #2 the data type, #3 the variable name.
5352 \def\deftypeivarheader#1#2#3{%
5353 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
5354 \begingroup
5355 \defname{\defheaderxcond#2\relax$.$#3}
5356 {\putwordInstanceVariableof\ \code{#1}}%
5357 \defvarargs{#3}%
5358 \endgroup
5361 % @defmethod == @defop Method
5363 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
5365 % #1 is the class name, #2 the method name, #3 the args.
5366 \def\defmethodheader#1#2#3{%
5367 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
5368 \begingroup
5369 \defname{#2}{\putwordMethodon\ \code{#1}}%
5370 \defunargs{#3}%
5371 \endgroup
5374 % @defcv {Class Option} foo-class foo-flag
5376 \def\defcv #1 {\def\defcvtype{#1}%
5377 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
5379 \def\defcvarheader #1#2#3{%
5380 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% variable index entry
5381 \begingroup
5382 \defname{#2}{\defcvtype\ \putwordof\ #1}%
5383 \defvarargs{#3}%
5384 \endgroup
5387 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
5389 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
5391 \def\defivarheader#1#2#3{%
5392 \dosubind{vr}{\code{#2}}{\putwordof\ \code{#1}}% entry in var index
5393 \begingroup
5394 \defname{#2}{\putwordInstanceVariableof\ #1}%
5395 \defvarargs{#3}%
5396 \endgroup
5399 % @defvar
5400 % First, define the processing that is wanted for arguments of @defvar.
5401 % This is actually simple: just print them in roman.
5402 % This must expand the args and terminate the paragraph they make up
5403 \def\defvarargs #1{\normalparens #1%
5404 \defargscommonending
5407 % @defvr Counter foo-count
5409 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
5411 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
5412 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
5414 % @defvar == @defvr Variable
5416 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
5418 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5419 \begingroup\defname {#1}{\putwordDefvar}%
5420 \defvarargs {#2}\endgroup %
5423 % @defopt == @defvr {User Option}
5425 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
5427 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
5428 \begingroup\defname {#1}{\putwordDefopt}%
5429 \defvarargs {#2}\endgroup %
5432 % @deftypevar int foobar
5434 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
5436 % #1 is the data type. #2 is the name, perhaps followed by text that
5437 % is actually part of the data type, which should not be put into the index.
5438 \def\deftypevarheader #1#2{%
5439 \dovarind#2 \relax% Make entry in variables index
5440 \begingroup\defname {\defheaderxcond#1\relax$.$#2}{\putwordDeftypevar}%
5441 \defargscommonending
5442 \endgroup}
5443 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
5445 % @deftypevr {Global Flag} int enable
5447 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
5449 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
5450 \begingroup\defname {\defheaderxcond#2\relax$.$#3}{#1}
5451 \defargscommonending
5452 \endgroup}
5454 % Now define @deftp
5455 % Args are printed in bold, a slight difference from @defvar.
5457 \def\deftpargs #1{\bf \defvarargs{#1}}
5459 % @deftp Class window height width ...
5461 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
5463 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
5464 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
5466 % These definitions are used if you use @defunx (etc.)
5467 % anywhere other than immediately after a @defun or @defunx.
5469 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
5470 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
5471 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
5472 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
5473 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
5474 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
5475 \def\defopx#1 {\errmessage{@defopx in invalid context}}
5476 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
5477 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
5478 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
5479 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
5480 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
5481 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
5482 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
5483 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
5484 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
5485 \def\defunx#1 {\errmessage{@defunx in invalid context}}
5486 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
5487 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
5490 \message{macros,}
5491 % @macro.
5493 % To do this right we need a feature of e-TeX, \scantokens,
5494 % which we arrange to emulate with a temporary file in ordinary TeX.
5495 \ifx\eTeXversion\undefined
5496 \newwrite\macscribble
5497 \def\scanmacro#1{%
5498 \begingroup \newlinechar`\^^M
5499 % Undo catcode changes of \startcontents and \doprintindex
5500 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5501 % Append \endinput to make sure that TeX does not see the ending newline.
5502 \toks0={#1\endinput}%
5503 \immediate\openout\macscribble=\jobname.tmp
5504 \immediate\write\macscribble{\the\toks0}%
5505 \immediate\closeout\macscribble
5506 \let\xeatspaces\eatspaces
5507 \input \jobname.tmp
5508 \endgroup
5510 \else
5511 \def\scanmacro#1{%
5512 \begingroup \newlinechar`\^^M
5513 % Undo catcode changes of \startcontents and \doprintindex
5514 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5515 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup}
5518 \newcount\paramno % Count of parameters
5519 \newtoks\macname % Macro name
5520 \newif\ifrecursive % Is it recursive?
5521 \def\macrolist{} % List of all defined macros in the form
5522 % \do\macro1\do\macro2...
5524 % Utility routines.
5525 % Thisdoes \let #1 = #2, except with \csnames.
5526 \def\cslet#1#2{%
5527 \expandafter\expandafter
5528 \expandafter\let
5529 \expandafter\expandafter
5530 \csname#1\endcsname
5531 \csname#2\endcsname}
5533 % Trim leading and trailing spaces off a string.
5534 % Concepts from aro-bend problem 15 (see CTAN).
5535 {\catcode`\@=11
5536 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5537 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5538 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5539 \def\unbrace#1{#1}
5540 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5543 % Trim a single trailing ^^M off a string.
5544 {\catcode`\^^M=\other \catcode`\Q=3%
5545 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5546 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5547 \gdef\eatcrb#1Q#2Q{#1}%
5550 % Macro bodies are absorbed as an argument in a context where
5551 % all characters are catcode 10, 11 or 12, except \ which is active
5552 % (as in normal texinfo). It is necessary to change the definition of \.
5554 % It's necessary to have hard CRs when the macro is executed. This is
5555 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5556 % body, and then making it the \newlinechar in \scanmacro.
5558 \def\macrobodyctxt{%
5559 \catcode`\~=\other
5560 \catcode`\^=\other
5561 \catcode`\_=\other
5562 \catcode`\|=\other
5563 \catcode`\<=\other
5564 \catcode`\>=\other
5565 \catcode`\+=\other
5566 \catcode`\{=\other
5567 \catcode`\}=\other
5568 \catcode`\@=\other
5569 \catcode`\^^M=\other
5570 \usembodybackslash}
5572 \def\macroargctxt{%
5573 \catcode`\~=\other
5574 \catcode`\^=\other
5575 \catcode`\_=\other
5576 \catcode`\|=\other
5577 \catcode`\<=\other
5578 \catcode`\>=\other
5579 \catcode`\+=\other
5580 \catcode`\@=\other
5581 \catcode`\\=\other}
5583 % \mbodybackslash is the definition of \ in @macro bodies.
5584 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5585 % where N is the macro parameter number.
5586 % We define \csname macarg.\endcsname to be \realbackslash, so
5587 % \\ in macro replacement text gets you a backslash.
5589 {\catcode`@=0 @catcode`@\=@active
5590 @gdef@usembodybackslash{@let\=@mbodybackslash}
5591 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5593 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5595 \def\macro{\recursivefalse\parsearg\macroxxx}
5596 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5598 \def\macroxxx#1{%
5599 \getargs{#1}% now \macname is the macname and \argl the arglist
5600 \ifx\argl\empty % no arguments
5601 \paramno=0%
5602 \else
5603 \expandafter\parsemargdef \argl;%
5605 \if1\csname ismacro.\the\macname\endcsname
5606 \message{Warning: redefining \the\macname}%
5607 \else
5608 \expandafter\ifx\csname \the\macname\endcsname \relax
5609 \else \errmessage{Macro name \the\macname\space already defined}\fi
5610 \global\cslet{macsave.\the\macname}{\the\macname}%
5611 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5612 % Add the macroname to \macrolist
5613 \toks0 = \expandafter{\macrolist\do}%
5614 \xdef\macrolist{\the\toks0
5615 \expandafter\noexpand\csname\the\macname\endcsname}%
5617 \begingroup \macrobodyctxt
5618 \ifrecursive \expandafter\parsermacbody
5619 \else \expandafter\parsemacbody
5620 \fi}
5622 \def\unmacro{\parsearg\dounmacro}
5623 \def\dounmacro#1{%
5624 \if1\csname ismacro.#1\endcsname
5625 \global\cslet{#1}{macsave.#1}%
5626 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5627 % Remove the macro name from \macrolist:
5628 \begingroup
5629 \expandafter\let\csname#1\endcsname \relax
5630 \let\do\unmacrodo
5631 \xdef\macrolist{\macrolist}%
5632 \endgroup
5633 \else
5634 \errmessage{Macro #1 not defined}%
5638 % Called by \do from \dounmacro on each macro. The idea is to omit any
5639 % macro definitions that have been changed to \relax.
5641 \def\unmacrodo#1{%
5642 \ifx#1\relax
5643 % remove this
5644 \else
5645 \noexpand\do \noexpand #1%
5649 % This makes use of the obscure feature that if the last token of a
5650 % <parameter list> is #, then the preceding argument is delimited by
5651 % an opening brace, and that opening brace is not consumed.
5652 \def\getargs#1{\getargsxxx#1{}}
5653 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5654 \def\getmacname #1 #2\relax{\macname={#1}}
5655 \def\getmacargs#1{\def\argl{#1}}
5657 % Parse the optional {params} list. Set up \paramno and \paramlist
5658 % so \defmacro knows what to do. Define \macarg.blah for each blah
5659 % in the params list, to be ##N where N is the position in that list.
5660 % That gets used by \mbodybackslash (above).
5662 % We need to get `macro parameter char #' into several definitions.
5663 % The technique used is stolen from LaTeX: let \hash be something
5664 % unexpandable, insert that wherever you need a #, and then redefine
5665 % it to # just before using the token list produced.
5667 % The same technique is used to protect \eatspaces till just before
5668 % the macro is used.
5670 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5671 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5672 \def\parsemargdefxxx#1,{%
5673 \if#1;\let\next=\relax
5674 \else \let\next=\parsemargdefxxx
5675 \advance\paramno by 1%
5676 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5677 {\xeatspaces{\hash\the\paramno}}%
5678 \edef\paramlist{\paramlist\hash\the\paramno,}%
5679 \fi\next}
5681 % These two commands read recursive and nonrecursive macro bodies.
5682 % (They're different since rec and nonrec macros end differently.)
5684 \long\def\parsemacbody#1@end macro%
5685 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5686 \long\def\parsermacbody#1@end rmacro%
5687 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5689 % This defines the macro itself. There are six cases: recursive and
5690 % nonrecursive macros of zero, one, and many arguments.
5691 % Much magic with \expandafter here.
5692 % \xdef is used so that macro definitions will survive the file
5693 % they're defined in; @include reads the file inside a group.
5694 \def\defmacro{%
5695 \let\hash=##% convert placeholders to macro parameter chars
5696 \ifrecursive
5697 \ifcase\paramno
5699 \expandafter\xdef\csname\the\macname\endcsname{%
5700 \noexpand\scanmacro{\temp}}%
5701 \or % 1
5702 \expandafter\xdef\csname\the\macname\endcsname{%
5703 \bgroup\noexpand\macroargctxt
5704 \noexpand\braceorline
5705 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5706 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5707 \egroup\noexpand\scanmacro{\temp}}%
5708 \else % many
5709 \expandafter\xdef\csname\the\macname\endcsname{%
5710 \bgroup\noexpand\macroargctxt
5711 \noexpand\csname\the\macname xx\endcsname}%
5712 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5713 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5714 \expandafter\expandafter
5715 \expandafter\xdef
5716 \expandafter\expandafter
5717 \csname\the\macname xxx\endcsname
5718 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5720 \else
5721 \ifcase\paramno
5723 \expandafter\xdef\csname\the\macname\endcsname{%
5724 \noexpand\norecurse{\the\macname}%
5725 \noexpand\scanmacro{\temp}\egroup}%
5726 \or % 1
5727 \expandafter\xdef\csname\the\macname\endcsname{%
5728 \bgroup\noexpand\macroargctxt
5729 \noexpand\braceorline
5730 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5731 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5732 \egroup
5733 \noexpand\norecurse{\the\macname}%
5734 \noexpand\scanmacro{\temp}\egroup}%
5735 \else % many
5736 \expandafter\xdef\csname\the\macname\endcsname{%
5737 \bgroup\noexpand\macroargctxt
5738 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5739 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5740 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5741 \expandafter\expandafter
5742 \expandafter\xdef
5743 \expandafter\expandafter
5744 \csname\the\macname xxx\endcsname
5745 \paramlist{%
5746 \egroup
5747 \noexpand\norecurse{\the\macname}%
5748 \noexpand\scanmacro{\temp}\egroup}%
5750 \fi}
5752 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5754 % \braceorline decides whether the next nonwhitespace character is a
5755 % {. If so it reads up to the closing }, if not, it reads the whole
5756 % line. Whatever was read is then fed to the next control sequence
5757 % as an argument (by \parsebrace or \parsearg)
5758 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5759 \def\braceorlinexxx{%
5760 \ifx\nchar\bgroup\else
5761 \expandafter\parsearg
5762 \fi \next}
5764 % We mant to disable all macros during \shipout so that they are not
5765 % expanded by \write.
5766 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5767 \edef\next{\macrolist}\expandafter\endgroup\next}
5770 % @alias.
5771 % We need some trickery to remove the optional spaces around the equal
5772 % sign. Just make them active and then expand them all to nothing.
5773 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx}
5774 \def\aliasxxx #1{\aliasyyy#1\relax}
5775 \def\aliasyyy #1=#2\relax{\ignoreactivespaces
5776 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=%
5777 \expandafter\noexpand\csname#2\endcsname}%
5778 \expandafter\endgroup\next}
5781 \message{cross references,}
5782 % @xref etc.
5784 \newwrite\auxfile
5786 \newif\ifhavexrefs % True if xref values are known.
5787 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5789 % @inforef is relatively simple.
5790 \def\inforef #1{\inforefzzz #1,,,,**}
5791 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5792 node \samp{\ignorespaces#1{}}}
5794 % @node's job is to define \lastnode.
5795 \def\node{\ENVcheck\parsearg\nodezzz}
5796 \def\nodezzz#1{\nodexxx [#1,]}
5797 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
5798 \let\nwnode=\node
5799 \let\lastnode=\relax
5801 % The sectioning commands (@chapter, etc.) call these.
5802 \def\donoderef{%
5803 \ifx\lastnode\relax\else
5804 \expandafter\expandafter\expandafter\setref{\lastnode}%
5805 {Ysectionnumberandtype}%
5806 \global\let\lastnode=\relax
5809 \def\unnumbnoderef{%
5810 \ifx\lastnode\relax\else
5811 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}%
5812 \global\let\lastnode=\relax
5815 \def\appendixnoderef{%
5816 \ifx\lastnode\relax\else
5817 \expandafter\expandafter\expandafter\setref{\lastnode}%
5818 {Yappendixletterandtype}%
5819 \global\let\lastnode=\relax
5824 % @anchor{NAME} -- define xref target at arbitrary point.
5826 \newcount\savesfregister
5827 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5828 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5829 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5831 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5832 % anchor), namely NAME-title (the corresponding @chapter/etc. name),
5833 % NAME-pg (the page number), and NAME-snt (section number and type).
5834 % Called from \foonoderef.
5836 % We have to set \indexdummies so commands such as @code in a section
5837 % title aren't expanded. It would be nicer not to expand the titles in
5838 % the first place, but there's so many layers that that is hard to do.
5840 % Likewise, use \turnoffactive so that punctuation chars such as underscore
5841 % and backslash work in node names.
5843 \def\setref#1#2{{%
5844 \atdummies
5845 \pdfmkdest{#1}%
5847 \turnoffactive
5848 \dosetq{#1-title}{Ytitle}%
5849 \dosetq{#1-pg}{Ypagenumber}%
5850 \dosetq{#1-snt}{#2}%
5853 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5854 % the node name, #2 the name of the Info cross-reference, #3 the printed
5855 % node name, #4 the name of the Info file, #5 the name of the printed
5856 % manual. All but the node name can be omitted.
5858 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5859 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5860 \def\ref#1{\xrefX[#1,,,,,,,]}
5861 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5862 \unsepspaces
5863 \def\printedmanual{\ignorespaces #5}%
5864 \def\printednodename{\ignorespaces #3}%
5865 \setbox1=\hbox{\printedmanual}%
5866 \setbox0=\hbox{\printednodename}%
5867 \ifdim \wd0 = 0pt
5868 % No printed node name was explicitly given.
5869 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5870 % Use the node name inside the square brackets.
5871 \def\printednodename{\ignorespaces #1}%
5872 \else
5873 % Use the actual chapter/section title appear inside
5874 % the square brackets. Use the real section title if we have it.
5875 \ifdim \wd1 > 0pt
5876 % It is in another manual, so we don't have it.
5877 \def\printednodename{\ignorespaces #1}%
5878 \else
5879 \ifhavexrefs
5880 % We know the real title if we have the xref values.
5881 \def\printednodename{\refx{#1-title}{}}%
5882 \else
5883 % Otherwise just copy the Info node name.
5884 \def\printednodename{\ignorespaces #1}%
5885 \fi%
5890 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5891 % insert empty discretionaries after hyphens, which means that it will
5892 % not find a line break at a hyphen in a node names. Since some manuals
5893 % are best written with fairly long node names, containing hyphens, this
5894 % is a loss. Therefore, we give the text of the node name again, so it
5895 % is as if TeX is seeing it for the first time.
5896 \ifpdf
5897 \leavevmode
5898 \getfilename{#4}%
5899 {\turnoffactive \otherbackslash
5900 \ifnum\filenamelength>0
5901 \startlink attr{/Border [0 0 0]}%
5902 goto file{\the\filename.pdf} name{#1}%
5903 \else
5904 \startlink attr{/Border [0 0 0]}%
5905 goto name{#1}%
5908 \linkcolor
5911 \ifdim \wd1 > 0pt
5912 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}%
5913 \else
5914 % _ (for example) has to be the character _ for the purposes of the
5915 % control sequence corresponding to the node, but it has to expand
5916 % into the usual \leavevmode...\vrule stuff for purposes of
5917 % printing. So we \turnoffactive for the \refx-snt, back on for the
5918 % printing, back off for the \refx-pg.
5919 {\turnoffactive \otherbackslash
5920 % Only output a following space if the -snt ref is nonempty; for
5921 % @unnumbered and @anchor, it won't be.
5922 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5923 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5925 % [mynode],
5926 [\printednodename],\space
5927 % page 3
5928 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5930 \endlink
5931 \endgroup}
5933 % \dosetq is called from \setref to do the actual \write (\iflinks).
5935 \def\dosetq#1#2{%
5936 {\let\folio=0%
5937 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}%
5938 \iflinks \next \fi
5942 % \internalsetq{foo}{page} expands into
5943 % CHARACTERS @xrdef{foo}{...expansion of \page...}
5944 \def\internalsetq#1#2{@xrdef{#1}{\csname #2\endcsname}}
5946 % Things to be expanded by \internalsetq.
5948 \def\Ypagenumber{\folio}
5949 \def\Ytitle{\thissection}
5950 \def\Ynothing{}
5951 \def\Ysectionnumberandtype{%
5952 \ifnum\secno=0
5953 \putwordChapter@tie \the\chapno
5954 \else \ifnum\subsecno=0
5955 \putwordSection@tie \the\chapno.\the\secno
5956 \else \ifnum\subsubsecno=0
5957 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5958 \else
5959 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5960 \fi\fi\fi
5963 \def\Yappendixletterandtype{%
5964 \ifnum\secno=0
5965 \putwordAppendix@tie @char\the\appendixno{}%
5966 \else \ifnum\subsecno=0
5967 \putwordSection@tie @char\the\appendixno.\the\secno
5968 \else \ifnum\subsubsecno=0
5969 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5970 \else
5971 \putwordSection@tie
5972 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5973 \fi\fi\fi
5976 % Use TeX 3.0's \inputlineno to get the line number, for better error
5977 % messages, but if we're using an old version of TeX, don't do anything.
5979 \ifx\inputlineno\thisisundefined
5980 \let\linenumber = \empty % Pre-3.0.
5981 \else
5982 \def\linenumber{\the\inputlineno:\space}
5985 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5986 % If its value is nonempty, SUFFIX is output afterward.
5988 \def\refx#1#2{%
5990 \indexnofonts
5991 \otherbackslash
5992 \expandafter\global\expandafter\let\expandafter\thisrefX
5993 \csname X#1\endcsname
5995 \ifx\thisrefX\relax
5996 % If not defined, say something at least.
5997 \angleleft un\-de\-fined\angleright
5998 \iflinks
5999 \ifhavexrefs
6000 \message{\linenumber Undefined cross reference `#1'.}%
6001 \else
6002 \ifwarnedxrefs\else
6003 \global\warnedxrefstrue
6004 \message{Cross reference values unknown; you must run TeX again.}%
6008 \else
6009 % It's defined, so just use it.
6010 \thisrefX
6012 #2% Output the suffix in any case.
6015 % This is the macro invoked by entries in the aux file.
6017 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
6019 % Read the last existing aux file, if any. No error if none exists.
6020 \def\readauxfile{\begingroup
6021 \catcode`\^^@=\other
6022 \catcode`\^^A=\other
6023 \catcode`\^^B=\other
6024 \catcode`\^^C=\other
6025 \catcode`\^^D=\other
6026 \catcode`\^^E=\other
6027 \catcode`\^^F=\other
6028 \catcode`\^^G=\other
6029 \catcode`\^^H=\other
6030 \catcode`\^^K=\other
6031 \catcode`\^^L=\other
6032 \catcode`\^^N=\other
6033 \catcode`\^^P=\other
6034 \catcode`\^^Q=\other
6035 \catcode`\^^R=\other
6036 \catcode`\^^S=\other
6037 \catcode`\^^T=\other
6038 \catcode`\^^U=\other
6039 \catcode`\^^V=\other
6040 \catcode`\^^W=\other
6041 \catcode`\^^X=\other
6042 \catcode`\^^Z=\other
6043 \catcode`\^^[=\other
6044 \catcode`\^^\=\other
6045 \catcode`\^^]=\other
6046 \catcode`\^^^=\other
6047 \catcode`\^^_=\other
6048 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6049 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6050 % supported in the main text, it doesn't seem desirable. Furthermore,
6051 % that is not enough: for node names that actually contain a ^
6052 % character, we would end up writing a line like this: 'xrdef {'hat
6053 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6054 % argument, and \hat is not an expandable control sequence. It could
6055 % all be worked out, but why? Either we support ^^ or we don't.
6057 % The other change necessary for this was to define \auxhat:
6058 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6059 % and then to call \auxhat in \setq.
6061 \catcode`\^=\other
6063 % Special characters. Should be turned off anyway, but...
6064 \catcode`\~=\other
6065 \catcode`\[=\other
6066 \catcode`\]=\other
6067 \catcode`\"=\other
6068 \catcode`\_=\other
6069 \catcode`\|=\other
6070 \catcode`\<=\other
6071 \catcode`\>=\other
6072 \catcode`\$=\other
6073 \catcode`\#=\other
6074 \catcode`\&=\other
6075 \catcode`\%=\other
6076 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6078 % Make the characters 128-255 be printing characters
6080 \count 1=128
6081 \def\loop{%
6082 \catcode\count 1=\other
6083 \advance\count 1 by 1
6084 \ifnum \count 1<256 \loop \fi
6088 % Turn off \ as an escape so we do not lose on
6089 % entries which were dumped with control sequences in their names.
6090 % For example, @xrdef{$\leq $-fun}{page ...} made by @defun ^^
6091 % Reference to such entries still does not work the way one would wish,
6092 % but at least they do not bomb out when the aux file is read in.
6093 \catcode`\\=\other
6095 % @ is our escape character in .aux files.
6096 \catcode`\{=1
6097 \catcode`\}=2
6098 \catcode`\@=0
6100 \openin 1 \jobname.aux
6101 \ifeof 1 \else
6102 \closein 1
6103 \input \jobname.aux
6104 \global\havexrefstrue
6105 \global\warnedobstrue
6107 % Open the new aux file. TeX will close it automatically at exit.
6108 \openout\auxfile=\jobname.aux
6109 \endgroup}
6112 % Footnotes.
6114 \newcount \footnoteno
6116 % The trailing space in the following definition for supereject is
6117 % vital for proper filling; pages come out unaligned when you do a
6118 % pagealignmacro call if that space before the closing brace is
6119 % removed. (Generally, numeric constants should always be followed by a
6120 % space to prevent strange expansion errors.)
6121 \def\supereject{\par\penalty -20000\footnoteno =0 }
6123 % @footnotestyle is meaningful for info output only.
6124 \let\footnotestyle=\comment
6126 \let\ptexfootnote=\footnote
6128 {\catcode `\@=11
6130 % Auto-number footnotes. Otherwise like plain.
6131 \gdef\footnote{%
6132 \global\advance\footnoteno by \@ne
6133 \edef\thisfootno{$^{\the\footnoteno}$}%
6135 % In case the footnote comes at the end of a sentence, preserve the
6136 % extra spacing after we do the footnote number.
6137 \let\@sf\empty
6138 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
6140 % Remove inadvertent blank space before typesetting the footnote number.
6141 \unskip
6142 \thisfootno\@sf
6143 \dofootnote
6146 % Don't bother with the trickery in plain.tex to not require the
6147 % footnote text as a parameter. Our footnotes don't need to be so general.
6149 % Oh yes, they do; otherwise, @ifset and anything else that uses
6150 % \parseargline fail inside footnotes because the tokens are fixed when
6151 % the footnote is read. --karl, 16nov96.
6153 % The start of the footnote looks usually like this:
6154 \gdef\startfootins{\insert\footins\bgroup}
6156 % ... but this macro is redefined inside @multitable.
6158 \gdef\dofootnote{%
6159 \startfootins
6160 % We want to typeset this text as a normal paragraph, even if the
6161 % footnote reference occurs in (for example) a display environment.
6162 % So reset some parameters.
6163 \hsize=\pagewidth
6164 \interlinepenalty\interfootnotelinepenalty
6165 \splittopskip\ht\strutbox % top baseline for broken footnotes
6166 \splitmaxdepth\dp\strutbox
6167 \floatingpenalty\@MM
6168 \leftskip\z@skip
6169 \rightskip\z@skip
6170 \spaceskip\z@skip
6171 \xspaceskip\z@skip
6172 \parindent\defaultparindent
6174 \smallfonts \rm
6176 % Because we use hanging indentation in footnotes, a @noindent appears
6177 % to exdent this text, so make it be a no-op. makeinfo does not use
6178 % hanging indentation so @noindent can still be needed within footnote
6179 % text after an @example or the like (not that this is good style).
6180 \let\noindent = \relax
6182 % Hang the footnote text off the number. Use \everypar in case the
6183 % footnote extends for more than one paragraph.
6184 \everypar = {\hang}%
6185 \textindent{\thisfootno}%
6187 % Don't crash into the line above the footnote text. Since this
6188 % expands into a box, it must come within the paragraph, lest it
6189 % provide a place where TeX can split the footnote.
6190 \footstrut
6191 \futurelet\next\fo@t
6193 }%end \catcode `\@=11
6195 % @| inserts a changebar to the left of the current line. It should
6196 % surround any changed text. This approach does *not* work if the
6197 % change spans more than two lines of output. To handle that, we would
6198 % have adopt a much more difficult approach (putting marks into the main
6199 % vertical list for the beginning and end of each change).
6201 \def\|{%
6202 % \vadjust can only be used in horizontal mode.
6203 \leavevmode
6205 % Append this vertical mode material after the current line in the output.
6206 \vadjust{%
6207 % We want to insert a rule with the height and depth of the current
6208 % leading; that is exactly what \strutbox is supposed to record.
6209 \vskip-\baselineskip
6211 % \vadjust-items are inserted at the left edge of the type. So
6212 % the \llap here moves out into the left-hand margin.
6213 \llap{%
6215 % For a thicker or thinner bar, change the `1pt'.
6216 \vrule height\baselineskip width1pt
6218 % This is the space between the bar and the text.
6219 \hskip 12pt
6224 % For a final copy, take out the rectangles
6225 % that mark overfull boxes (in case you have decided
6226 % that the text looks ok even though it passes the margin).
6228 \def\finalout{\overfullrule=0pt}
6230 % @image. We use the macros from epsf.tex to support this.
6231 % If epsf.tex is not installed and @image is used, we complain.
6233 % Check for and read epsf.tex up front. If we read it only at @image
6234 % time, we might be inside a group, and then its definitions would get
6235 % undone and the next image would fail.
6236 \openin 1 = epsf.tex
6237 \ifeof 1 \else
6238 \closein 1
6239 % Do not bother showing banner with epsf.tex v2.7k (available in
6240 % doc/epsf.tex and on ctan).
6241 \def\epsfannounce{\toks0 = }%
6242 \input epsf.tex
6245 % We will only complain once about lack of epsf.tex.
6246 \newif\ifwarnednoepsf
6247 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6248 work. It is also included in the Texinfo distribution, or you can get
6249 it from ftp://tug.org/tex/epsf.tex.}
6251 \def\image#1{%
6252 \ifx\epsfbox\undefined
6253 \ifwarnednoepsf \else
6254 \errhelp = \noepsfhelp
6255 \errmessage{epsf.tex not found, images will be ignored}%
6256 \global\warnednoepsftrue
6258 \else
6259 \imagexxx #1,,,,,\finish
6263 % Arguments to @image:
6264 % #1 is (mandatory) image filename; we tack on .eps extension.
6265 % #2 is (optional) width, #3 is (optional) height.
6266 % #4 is (ignored optional) html alt text.
6267 % #5 is (ignored optional) extension.
6268 % #6 is just the usual extra ignored arg for parsing this stuff.
6269 \newif\ifimagevmode
6270 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6271 \catcode`\^^M = 5 % in case we're inside an example
6272 \normalturnoffactive % allow _ et al. in names
6273 % If the image is by itself, center it.
6274 \ifvmode
6275 \imagevmodetrue
6276 \nobreak\bigskip
6277 % Usually we'll have text after the image which will insert
6278 % \parskip glue, so insert it here too to equalize the space
6279 % above and below.
6280 \nobreak\vskip\parskip
6281 \nobreak
6282 \line\bgroup\hss
6285 % Output the image.
6286 \ifpdf
6287 \dopdfimage{#1}{#2}{#3}%
6288 \else
6289 % \epsfbox itself resets \epsf?size at each figure.
6290 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6291 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6292 \epsfbox{#1.eps}%
6295 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6296 \endgroup}
6299 \message{localization,}
6300 % and i18n.
6302 % @documentlanguage is usually given very early, just after
6303 % @setfilename. If done too late, it may not override everything
6304 % properly. Single argument is the language abbreviation.
6305 % It would be nice if we could set up a hyphenation file here.
6307 \def\documentlanguage{\parsearg\dodocumentlanguage}
6308 \def\dodocumentlanguage#1{%
6309 \tex % read txi-??.tex file in plain TeX.
6310 % Read the file if it exists.
6311 \openin 1 txi-#1.tex
6312 \ifeof1
6313 \errhelp = \nolanghelp
6314 \errmessage{Cannot read language file txi-#1.tex}%
6315 \let\temp = \relax
6316 \else
6317 \def\temp{\input txi-#1.tex }%
6319 \temp
6320 \endgroup
6322 \newhelp\nolanghelp{The given language definition file cannot be found or
6323 is empty. Maybe you need to install it? In the current directory
6324 should work if nowhere else does.}
6327 % @documentencoding should change something in TeX eventually, most
6328 % likely, but for now just recognize it.
6329 \let\documentencoding = \comment
6332 % Page size parameters.
6334 \newdimen\defaultparindent \defaultparindent = 15pt
6336 \chapheadingskip = 15pt plus 4pt minus 2pt
6337 \secheadingskip = 12pt plus 3pt minus 2pt
6338 \subsecheadingskip = 9pt plus 2pt minus 2pt
6340 % Prevent underfull vbox error messages.
6341 \vbadness = 10000
6343 % Don't be so finicky about underfull hboxes, either.
6344 \hbadness = 2000
6346 % Following George Bush, just get rid of widows and orphans.
6347 \widowpenalty=10000
6348 \clubpenalty=10000
6350 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6351 % using an old version of TeX, don't do anything. We want the amount of
6352 % stretch added to depend on the line length, hence the dependence on
6353 % \hsize. We call this whenever the paper size is set.
6355 \def\setemergencystretch{%
6356 \ifx\emergencystretch\thisisundefined
6357 % Allow us to assign to \emergencystretch anyway.
6358 \def\emergencystretch{\dimen0}%
6359 \else
6360 \emergencystretch = .15\hsize
6364 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6365 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6366 % physical page width.
6368 % We also call \setleading{\textleading}, so the caller should define
6369 % \textleading. The caller should also set \parskip.
6371 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6372 \voffset = #3\relax
6373 \topskip = #6\relax
6374 \splittopskip = \topskip
6376 \vsize = #1\relax
6377 \advance\vsize by \topskip
6378 \outervsize = \vsize
6379 \advance\outervsize by 2\topandbottommargin
6380 \pageheight = \vsize
6382 \hsize = #2\relax
6383 \outerhsize = \hsize
6384 \advance\outerhsize by 0.5in
6385 \pagewidth = \hsize
6387 \normaloffset = #4\relax
6388 \bindingoffset = #5\relax
6390 \ifpdf
6391 \pdfpageheight #7\relax
6392 \pdfpagewidth #8\relax
6395 \setleading{\textleading}
6397 \parindent = \defaultparindent
6398 \setemergencystretch
6401 % @letterpaper (the default).
6402 \def\letterpaper{{\globaldefs = 1
6403 \parskip = 3pt plus 2pt minus 1pt
6404 \textleading = 13.2pt
6406 % If page is nothing but text, make it come out even.
6407 \internalpagesizes{46\baselineskip}{6in}%
6408 {\voffset}{.25in}%
6409 {\bindingoffset}{36pt}%
6410 {11in}{8.5in}%
6413 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6414 \def\smallbook{{\globaldefs = 1
6415 \parskip = 2pt plus 1pt
6416 \textleading = 12pt
6418 \internalpagesizes{7.5in}{5in}%
6419 {\voffset}{.25in}%
6420 {\bindingoffset}{16pt}%
6421 {9.25in}{7in}%
6423 \lispnarrowing = 0.3in
6424 \tolerance = 700
6425 \hfuzz = 1pt
6426 \contentsrightmargin = 0pt
6427 \defbodyindent = .5cm
6430 % Use @afourpaper to print on European A4 paper.
6431 \def\afourpaper{{\globaldefs = 1
6432 \parskip = 3pt plus 2pt minus 1pt
6433 \textleading = 13.2pt
6435 % Double-side printing via postscript on Laserjet 4050
6436 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6437 % To change the settings for a different printer or situation, adjust
6438 % \normaloffset until the front-side and back-side texts align. Then
6439 % do the same for \bindingoffset. You can set these for testing in
6440 % your texinfo source file like this:
6441 % @tex
6442 % \global\normaloffset = -6mm
6443 % \global\bindingoffset = 10mm
6444 % @end tex
6445 \internalpagesizes{51\baselineskip}{160mm}
6446 {\voffset}{\hoffset}%
6447 {\bindingoffset}{44pt}%
6448 {297mm}{210mm}%
6450 \tolerance = 700
6451 \hfuzz = 1pt
6452 \contentsrightmargin = 0pt
6453 \defbodyindent = 5mm
6456 % Use @afivepaper to print on European A5 paper.
6457 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6458 % He also recommends making @example and @lisp be small.
6459 \def\afivepaper{{\globaldefs = 1
6460 \parskip = 2pt plus 1pt minus 0.1pt
6461 \textleading = 12.5pt
6463 \internalpagesizes{160mm}{120mm}%
6464 {\voffset}{\hoffset}%
6465 {\bindingoffset}{8pt}%
6466 {210mm}{148mm}%
6468 \lispnarrowing = 0.2in
6469 \tolerance = 800
6470 \hfuzz = 1.2pt
6471 \contentsrightmargin = 0pt
6472 \defbodyindent = 2mm
6473 \tableindent = 12mm
6476 % A specific text layout, 24x15cm overall, intended for A4 paper.
6477 \def\afourlatex{{\globaldefs = 1
6478 \afourpaper
6479 \internalpagesizes{237mm}{150mm}%
6480 {\voffset}{4.6mm}%
6481 {\bindingoffset}{7mm}%
6482 {297mm}{210mm}%
6484 % Must explicitly reset to 0 because we call \afourpaper.
6485 \globaldefs = 0
6488 % Use @afourwide to print on A4 paper in landscape format.
6489 \def\afourwide{{\globaldefs = 1
6490 \afourpaper
6491 \internalpagesizes{241mm}{165mm}%
6492 {\voffset}{-2.95mm}%
6493 {\bindingoffset}{7mm}%
6494 {297mm}{210mm}%
6495 \globaldefs = 0
6498 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6499 % Perhaps we should allow setting the margins, \topskip, \parskip,
6500 % and/or leading, also. Or perhaps we should compute them somehow.
6502 \def\pagesizes{\parsearg\pagesizesxxx}
6503 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
6504 \def\pagesizesyyy#1,#2,#3\finish{{%
6505 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6506 \globaldefs = 1
6508 \parskip = 3pt plus 2pt minus 1pt
6509 \setleading{\textleading}%
6511 \dimen0 = #1
6512 \advance\dimen0 by \voffset
6514 \dimen2 = \hsize
6515 \advance\dimen2 by \normaloffset
6517 \internalpagesizes{#1}{\hsize}%
6518 {\voffset}{\normaloffset}%
6519 {\bindingoffset}{44pt}%
6520 {\dimen0}{\dimen2}%
6523 % Set default to letter.
6525 \letterpaper
6528 \message{and turning on texinfo input format.}
6530 % Define macros to output various characters with catcode for normal text.
6531 \catcode`\"=\other
6532 \catcode`\~=\other
6533 \catcode`\^=\other
6534 \catcode`\_=\other
6535 \catcode`\|=\other
6536 \catcode`\<=\other
6537 \catcode`\>=\other
6538 \catcode`\+=\other
6539 \catcode`\$=\other
6540 \def\normaldoublequote{"}
6541 \def\normaltilde{~}
6542 \def\normalcaret{^}
6543 \def\normalunderscore{_}
6544 \def\normalverticalbar{|}
6545 \def\normalless{<}
6546 \def\normalgreater{>}
6547 \def\normalplus{+}
6548 \def\normaldollar{$}%$ font-lock fix
6550 % This macro is used to make a character print one way in ttfont
6551 % where it can probably just be output, and another way in other fonts,
6552 % where something hairier probably needs to be done.
6554 % #1 is what to print if we are indeed using \tt; #2 is what to print
6555 % otherwise. Since all the Computer Modern typewriter fonts have zero
6556 % interword stretch (and shrink), and it is reasonable to expect all
6557 % typewriter fonts to have this, we can check that font parameter.
6559 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6561 % Same as above, but check for italic font. Actually this also catches
6562 % non-italic slanted fonts since it is impossible to distinguish them from
6563 % italic fonts. But since this is only used by $ and it uses \sl anyway
6564 % this is not a problem.
6565 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6567 % Turn off all special characters except @
6568 % (and those which the user can use as if they were ordinary).
6569 % Most of these we simply print from the \tt font, but for some, we can
6570 % use math or other variants that look better in normal text.
6572 \catcode`\"=\active
6573 \def\activedoublequote{{\tt\char34}}
6574 \let"=\activedoublequote
6575 \catcode`\~=\active
6576 \def~{{\tt\char126}}
6577 \chardef\hat=`\^
6578 \catcode`\^=\active
6579 \def^{{\tt \hat}}
6581 \catcode`\_=\active
6582 \def_{\ifusingtt\normalunderscore\_}
6583 % Subroutine for the previous macro.
6584 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6586 \catcode`\|=\active
6587 \def|{{\tt\char124}}
6588 \chardef \less=`\<
6589 \catcode`\<=\active
6590 \def<{{\tt \less}}
6591 \chardef \gtr=`\>
6592 \catcode`\>=\active
6593 \def>{{\tt \gtr}}
6594 \catcode`\+=\active
6595 \def+{{\tt \char 43}}
6596 \catcode`\$=\active
6597 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6599 % Set up an active definition for =, but don't enable it most of the time.
6600 {\catcode`\==\active
6601 \global\def={{\tt \char 61}}}
6603 \catcode`+=\active
6604 \catcode`\_=\active
6606 % If a .fmt file is being used, characters that might appear in a file
6607 % name cannot be active until we have parsed the command line.
6608 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6609 % \otherifyactive is called near the end of this file.
6610 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6612 \catcode`\@=0
6614 % \rawbackslashxx outputs one backslash character in current font,
6615 % as in \char`\\.
6616 \global\chardef\rawbackslashxx=`\\
6618 % \rawbackslash defines an active \ to do \rawbackslashxx.
6619 % \otherbackslash defines an active \ to be a literal `\' character with
6620 % catcode other.
6621 {\catcode`\\=\active
6622 @gdef@rawbackslash{@let\=@rawbackslashxx}
6623 @gdef@otherbackslash{@let\=@realbackslash}
6626 % \realbackslash is an actual character `\' with catcode other.
6627 {\catcode`\\=\other @gdef@realbackslash{\}}
6629 % \normalbackslash outputs one backslash in fixed width font.
6630 \def\normalbackslash{{\tt\rawbackslashxx}}
6632 \catcode`\\=\active
6634 % Used sometimes to turn off (effectively) the active characters
6635 % even after parsing them.
6636 @def@turnoffactive{%
6637 @let"=@normaldoublequote
6638 @let\=@realbackslash
6639 @let~=@normaltilde
6640 @let^=@normalcaret
6641 @let_=@normalunderscore
6642 @let|=@normalverticalbar
6643 @let<=@normalless
6644 @let>=@normalgreater
6645 @let+=@normalplus
6646 @let$=@normaldollar %$ font-lock fix
6649 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6650 % the literal character `\'. (Thus, \ is not expandable when this is in
6651 % effect.)
6653 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6655 % Make _ and + \other characters, temporarily.
6656 % This is canceled by @fixbackslash.
6657 @otherifyactive
6659 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6660 % That is what \eatinput is for; after that, the `\' should revert to printing
6661 % a backslash.
6663 @gdef@eatinput input texinfo{@fixbackslash}
6664 @global@let\ = @eatinput
6666 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6667 % the first `\{ in the file would cause an error. This macro tries to fix
6668 % that, assuming it is called before the first `\' could plausibly occur.
6669 % Also back turn on active characters that might appear in the input
6670 % file name, in case not using a pre-dumped format.
6672 @gdef@fixbackslash{%
6673 @ifx\@eatinput @let\ = @normalbackslash @fi
6674 @catcode`+=@active
6675 @catcode`@_=@active
6678 % Say @foo, not \foo, in error messages.
6679 @escapechar = `@@
6681 % These look ok in all fonts, so just make them not special.
6682 @catcode`@& = @other
6683 @catcode`@# = @other
6684 @catcode`@% = @other
6686 @c Set initial fonts.
6687 @textfonts
6691 @c Local variables:
6692 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6693 @c page-delimiter: "^\\\\message"
6694 @c time-stamp-start: "def\\\\texinfoversion{"
6695 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6696 @c time-stamp-end: "}"
6697 @c End: