Windows installer: update Gnuplot
[maxima.git] / interfaces / emacs / imaxima / texinfo.tex
blobd4477d1e5149792cd83dc3af2c38e31f1c3d5171
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{2004-01-05.16}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
10 % Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 % Boston, MA 02111-1307, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
46 % tex foo.texi
47 % texindex foo.??
48 % tex foo.texi
49 % tex foo.texi
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
70 \message{Basics,}
71 \chardef\other=12
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexnoindent=\noindent
93 \let\ptexinsert=\insert
94 \let\ptexlbrace=\{
95 \let\ptexless=<
96 \let\ptexplus=+
97 \let\ptexrbrace=\}
98 \let\ptexslash=\/
99 \let\ptexstar=\*
100 \let\ptext=\t
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
111 \else
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % In some macros, we cannot use the `\? notation---the left quote is
156 % in some cases the escape char.
157 \chardef\colonChar = `\:
158 \chardef\commaChar = `\,
159 \chardef\dotChar = `\.
160 \chardef\exclamChar= `\!
161 \chardef\questChar = `\?
162 \chardef\semiChar = `\;
163 \chardef\underChar = `\_
165 \chardef\spaceChar = `\ %
166 \chardef\spacecat = 10
167 \def\spaceisspace{\catcode\spaceChar=\spacecat}
169 % Ignore a token.
171 \def\gobble#1{}
173 % The following is used inside several \edef's.
174 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
176 % Hyphenation fixes.
177 \hyphenation{ap-pen-dix}
178 \hyphenation{eshell}
179 \hyphenation{mini-buf-fer mini-buf-fers}
180 \hyphenation{time-stamp}
181 \hyphenation{white-space}
183 % Margin to add to right of even pages, to left of odd pages.
184 \newdimen\bindingoffset
185 \newdimen\normaloffset
186 \newdimen\pagewidth \newdimen\pageheight
188 % For a final copy, take out the rectangles
189 % that mark overfull boxes (in case you have decided
190 % that the text looks ok even though it passes the margin).
192 \def\finalout{\overfullrule=0pt}
194 % @| inserts a changebar to the left of the current line. It should
195 % surround any changed text. This approach does *not* work if the
196 % change spans more than two lines of output. To handle that, we would
197 % have adopt a much more difficult approach (putting marks into the main
198 % vertical list for the beginning and end of each change).
200 \def\|{%
201 % \vadjust can only be used in horizontal mode.
202 \leavevmode
204 % Append this vertical mode material after the current line in the output.
205 \vadjust{%
206 % We want to insert a rule with the height and depth of the current
207 % leading; that is exactly what \strutbox is supposed to record.
208 \vskip-\baselineskip
210 % \vadjust-items are inserted at the left edge of the type. So
211 % the \llap here moves out into the left-hand margin.
212 \llap{%
214 % For a thicker or thinner bar, change the `1pt'.
215 \vrule height\baselineskip width1pt
217 % This is the space between the bar and the text.
218 \hskip 12pt
223 % Sometimes it is convenient to have everything in the transcript file
224 % and nothing on the terminal. We don't just call \tracingall here,
225 % since that produces some useless output on the terminal. We also make
226 % some effort to order the tracing commands to reduce output in the log
227 % file; cf. trace.sty in LaTeX.
229 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
230 \def\loggingall{%
231 \tracingstats2
232 \tracingpages1
233 \tracinglostchars2 % 2 gives us more in etex
234 \tracingparagraphs1
235 \tracingoutput1
236 \tracingmacros2
237 \tracingrestores1
238 \showboxbreadth\maxdimen \showboxdepth\maxdimen
239 \ifx\eTeXversion\undefined\else % etex gives us more logging
240 \tracingscantokens1
241 \tracingifs1
242 \tracinggroups1
243 \tracingnesting2
244 \tracingassigns1
246 \tracingcommands3 % 3 gives us more in etex
247 \errorcontextlines16
250 % add check for \lastpenalty to plain's definitions. If the last thing
251 % we did was a \nobreak, we don't want to insert more space.
253 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
254 \removelastskip\penalty-50\smallskip\fi\fi}
255 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
256 \removelastskip\penalty-100\medskip\fi\fi}
257 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
258 \removelastskip\penalty-200\bigskip\fi\fi}
260 % For @cropmarks command.
261 % Do @cropmarks to get crop marks.
263 \newif\ifcropmarks
264 \let\cropmarks = \cropmarkstrue
266 % Dimensions to add cropmarks at corners.
267 % Added by P. A. MacKay, 12 Nov. 1986
269 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
270 \newdimen\cornerlong \cornerlong=1pc
271 \newdimen\cornerthick \cornerthick=.3pt
272 \newdimen\topandbottommargin \topandbottommargin=.75in
274 % Main output routine.
275 \chardef\PAGE = 255
276 \output = {\onepageout{\pagecontents\PAGE}}
278 \newbox\headlinebox
279 \newbox\footlinebox
281 % \onepageout takes a vbox as an argument. Note that \pagecontents
282 % does insertions, but you have to call it yourself.
283 \def\onepageout#1{%
284 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
286 \ifodd\pageno \advance\hoffset by \bindingoffset
287 \else \advance\hoffset by -\bindingoffset\fi
289 % Do this outside of the \shipout so @code etc. will be expanded in
290 % the headline as they should be, not taken literally (outputting ''code).
291 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
292 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
295 % Have to do this stuff outside the \shipout because we want it to
296 % take effect in \write's, yet the group defined by the \vbox ends
297 % before the \shipout runs.
299 \escapechar = `\\ % use backslash in output files.
300 \indexdummies % don't expand commands in the output.
301 \normalturnoffactive % \ in index entries must not stay \, e.g., if
302 % the page break happens to be in the middle of an example.
303 \shipout\vbox{%
304 % Do this early so pdf references go to the beginning of the page.
305 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
307 \ifcropmarks \vbox to \outervsize\bgroup
308 \hsize = \outerhsize
309 \vskip-\topandbottommargin
310 \vtop to0pt{%
311 \line{\ewtop\hfil\ewtop}%
312 \nointerlineskip
313 \line{%
314 \vbox{\moveleft\cornerthick\nstop}%
315 \hfill
316 \vbox{\moveright\cornerthick\nstop}%
318 \vss}%
319 \vskip\topandbottommargin
320 \line\bgroup
321 \hfil % center the page within the outer (page) hsize.
322 \ifodd\pageno\hskip\bindingoffset\fi
323 \vbox\bgroup
326 \unvbox\headlinebox
327 \pagebody{#1}%
328 \ifdim\ht\footlinebox > 0pt
329 % Only leave this space if the footline is nonempty.
330 % (We lessened \vsize for it in \oddfootingxxx.)
331 % The \baselineskip=24pt in plain's \makefootline has no effect.
332 \vskip 2\baselineskip
333 \unvbox\footlinebox
336 \ifcropmarks
337 \egroup % end of \vbox\bgroup
338 \hfil\egroup % end of (centering) \line\bgroup
339 \vskip\topandbottommargin plus1fill minus1fill
340 \boxmaxdepth = \cornerthick
341 \vbox to0pt{\vss
342 \line{%
343 \vbox{\moveleft\cornerthick\nsbot}%
344 \hfill
345 \vbox{\moveright\cornerthick\nsbot}%
347 \nointerlineskip
348 \line{\ewbot\hfil\ewbot}%
350 \egroup % \vbox from first cropmarks clause
352 }% end of \shipout\vbox
353 }% end of group with \normalturnoffactive
354 \advancepageno
355 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 \newinsert\margin \dimen\margin=\maxdimen
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
361 {\catcode`\@ =11
362 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363 % marginal hacks, juha@viisa.uucp (Juha Takala)
364 \ifvoid\margin\else % marginal info is present
365 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366 \dimen@=\dp#1 \unvbox#1
367 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 % Here are the rules for the cropmarks. Note that they are
372 % offset so that the space between them is truly \outerhsize or \outervsize
373 % (P. A. MacKay, 12 November, 1986)
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
376 \def\nstop{\vbox
377 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
379 \def\nsbot{\vbox
380 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
382 % Parse an argument, then pass it to #1. The argument is the rest of
383 % the input line (except we remove a trailing comment). #1 should be a
384 % macro which expects an ordinary undelimited TeX argument.
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
388 \def\next{#2}%
389 \begingroup
390 \obeylines
391 \spaceisspace
393 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
396 {\obeylines %
397 \gdef\parseargline#1^^M{%
398 \endgroup % End of the group started in \parsearg.
399 \argremovecomment #1\comment\ArgTerm%
403 % First remove any @comment, then any @c comment.
404 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
407 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
409 % \argremovec might leave us with trailing space, e.g.,
410 % @end itemize @c foo
411 % This space token undergoes the same procedure and is eventually removed
412 % by \finishparsearg.
414 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
417 \def\temp{#3}%
418 \ifx\temp\empty
419 % We cannot use \next here, as it holds the macro to run;
420 % thus we reuse \temp.
421 \let\temp\finishparsearg
422 \else
423 \let\temp\argcheckspaces
425 % Put the space token in:
426 \temp#1 #3\ArgTerm
429 % If a _delimited_ argument is enclosed in braces, they get stripped; so
430 % to get _exactly_ the rest of the line, we had to prevent such situation.
431 % We prepended an \empty token at the very beginning and we expand it now,
432 % just before passing the control to \next.
433 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
434 % either the null string, or it ends with \^^M---thus there is no danger
435 % that a pair of braces would be stripped.
437 % But first, we have to remove the trailing space token.
439 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
441 % \parseargdef\foo{...}
442 % is roughly equivalent to
443 % \def\foo{\parsearg\Xfoo}
444 % \def\Xfoo#1{...}
446 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
447 % favourite TeX trick. --kasal, 16nov03
449 \def\parseargdef#1{%
450 \expandafter \doparseargdef \csname\string#1\endcsname #1%
452 \def\doparseargdef#1#2{%
453 \def#2{\parsearg#1}%
454 \def#1##1%
457 % Several utility definitions with active space:
459 \obeyspaces
460 \gdef\obeyedspace{ }
462 % Make each space character in the input produce a normal interword
463 % space in the output. Don't allow a line break at this space, as this
464 % is used only in environments like @example, where each line of input
465 % should produce a line of output anyway.
467 \gdef\sepspaces{\obeyspaces\let =\tie}
469 % If an index command is used in an @example environment, any spaces
470 % therein should become regular spaces in the raw index file, not the
471 % expansion of \tie (\leavevmode \penalty \@M \ ).
472 \gdef\unsepspaces{\let =\space}
476 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
478 % Define the framework for environments in texinfo.tex. It's used like this:
480 % \envdef\foo{...}
481 % \def\Efoo{...}
483 % It's the responsibility of \envdef to insert \begingroup before the
484 % actual body; @end closes the group after calling \Efoo. \envdef also
485 % defines \thisenv, so the current environment is known; @end checks
486 % whether the environment name matches. The \checkenv macro can also be
487 % used to check whether the current environment is the one expected.
489 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
490 % are not treated as environments; they don't open a group. (The
491 % implementation of @end takes care not to call \endgroup in this
492 % special case.)
495 % At runtime, environments start with this:
496 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
497 % initialize
498 \let\thisenv\empty
500 % ... but they get defined via ``\envdef\foo{...}'':
501 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
502 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
504 % Check whether we're in the right environment:
505 \def\checkenv#1{%
506 \def\temp{#1}%
507 \ifx\thisenv\temp
508 \else
509 \badenverr
513 % Evironment mismatch, #1 expected:
514 \def\badenverr{%
515 \errhelp = \EMsimple
516 \errmessage{This command can appear only \inenvironment\temp,
517 not \inenvironment\thisenv}%
519 \def\inenvironment#1{%
520 \ifx#1\empty
521 out of any environment%
522 \else
523 in environment \expandafter\string#1%
527 % @end foo executes the definition of \Efoo.
528 % But first, it executes a specialized version of \checkenv
530 \parseargdef\end{%
531 \if 1\csname iscond.#1\endcsname
532 \else
533 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
534 \expandafter\checkenv\csname#1\endcsname
535 \csname E#1\endcsname
536 \endgroup
540 \newhelp\EMsimple{Press RETURN to continue.}
543 %% Simple single-character @ commands
545 % @@ prints an @
546 % Kludge this until the fonts are right (grr).
547 \def\@{{\tt\char64}}
549 % This is turned off because it was never documented
550 % and you can use @w{...} around a quote to suppress ligatures.
551 %% Define @` and @' to be the same as ` and '
552 %% but suppressing ligatures.
553 %\def\`{{`}}
554 %\def\'{{'}}
556 % Used to generate quoted braces.
557 \def\mylbrace {{\tt\char123}}
558 \def\myrbrace {{\tt\char125}}
559 \let\{=\mylbrace
560 \let\}=\myrbrace
561 \begingroup
562 % Definitions to produce \{ and \} commands for indices,
563 % and @{ and @} for the aux file.
564 \catcode`\{ = \other \catcode`\} = \other
565 \catcode`\[ = 1 \catcode`\] = 2
566 \catcode`\! = 0 \catcode`\\ = \other
567 !gdef!lbracecmd[\{]%
568 !gdef!rbracecmd[\}]%
569 !gdef!lbraceatcmd[@{]%
570 !gdef!rbraceatcmd[@}]%
571 !endgroup
573 % @comma{} to avoid , parsing problems.
574 \let\comma = ,
576 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
577 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
578 \let\, = \c
579 \let\dotaccent = \.
580 \def\ringaccent#1{{\accent23 #1}}
581 \let\tieaccent = \t
582 \let\ubaraccent = \b
583 \let\udotaccent = \d
585 % Other special characters: @questiondown @exclamdown @ordf @ordm
586 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
587 \def\questiondown{?`}
588 \def\exclamdown{!`}
589 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
590 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
592 % Dotless i and dotless j, used for accents.
593 \def\imacro{i}
594 \def\jmacro{j}
595 \def\dotless#1{%
596 \def\temp{#1}%
597 \ifx\temp\imacro \ptexi
598 \else\ifx\temp\jmacro \j
599 \else \errmessage{@dotless can be used only with i or j}%
600 \fi\fi
603 % The \TeX{} logo, as in plain, but resetting the spacing so that a
604 % period following counts as ending a sentence. (Idea found in latex.)
606 \def\TeX{T\kern-.1667em\lower.5ex\hbox{E}\kern-.125emX\spacefactor=3000 }
608 % @LaTeX{} logo. Not quite the same results as the definition in
609 % latex.ltx, since we use a different font for the raised A; it's most
610 % convenient for us to use an explicitly smaller font, rather than using
611 % the \scriptstyle font (since we don't reset \scriptstyle and
612 % \scriptscriptstyle).
614 \def\LaTeX{%
615 L\kern-.36em
616 {\setbox0=\hbox{T}%
617 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
618 \kern-.15em
619 \TeX
622 % Be sure we're in horizontal mode when doing a tie, since we make space
623 % equivalent to this in @example-like environments. Otherwise, a space
624 % at the beginning of a line will start with \penalty -- and
625 % since \penalty is valid in vertical mode, we'd end up putting the
626 % penalty on the vertical list instead of in the new paragraph.
627 {\catcode`@ = 11
628 % Avoid using \@M directly, because that causes trouble
629 % if the definition is written into an index file.
630 \global\let\tiepenalty = \@M
631 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
634 % @: forces normal size whitespace following.
635 \def\:{\spacefactor=1000 }
637 % @* forces a line break.
638 \def\*{\hfil\break\hbox{}\ignorespaces}
640 % @/ allows a line break.
641 \let\/=\allowbreak
643 % @. is an end-of-sentence period.
644 \def\.{.\spacefactor=3000 }
646 % @! is an end-of-sentence bang.
647 \def\!{!\spacefactor=3000 }
649 % @? is an end-of-sentence query.
650 \def\?{?\spacefactor=3000 }
652 % @w prevents a word break. Without the \leavevmode, @w at the
653 % beginning of a paragraph, when TeX is still in vertical mode, would
654 % produce a whole line of output instead of starting the paragraph.
655 \def\w#1{\leavevmode\hbox{#1}}
657 % @group ... @end group forces ... to be all on one page, by enclosing
658 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
659 % to keep its height that of a normal line. According to the rules for
660 % \topskip (p.114 of the TeXbook), the glue inserted is
661 % max (\topskip - \ht (first item), 0). If that height is large,
662 % therefore, no glue is inserted, and the space between the headline and
663 % the text is small, which looks bad.
665 % Another complication is that the group might be very large. This can
666 % cause the glue on the previous page to be unduly stretched, because it
667 % does not have much material. In this case, it's better to add an
668 % explicit \vfill so that the extra space is at the bottom. The
669 % threshold for doing this is if the group is more than \vfilllimit
670 % percent of a page (\vfilllimit can be changed inside of @tex).
672 \newbox\groupbox
673 \def\vfilllimit{0.7}
675 \envdef\group{%
676 \ifnum\catcode`\^^M=\active \else
677 \errhelp = \groupinvalidhelp
678 \errmessage{@group invalid in context where filling is enabled}%
680 \startsavinginserts
682 \setbox\groupbox = \vtop\bgroup
683 % Do @comment since we are called inside an environment such as
684 % @example, where each end-of-line in the input causes an
685 % end-of-line in the output. We don't want the end-of-line after
686 % the `@group' to put extra space in the output. Since @group
687 % should appear on a line by itself (according to the Texinfo
688 % manual), we don't worry about eating any user text.
689 \comment
692 % The \vtop produces a box with normal height and large depth; thus, TeX puts
693 % \baselineskip glue before it, and (when the next line of text is done)
694 % \lineskip glue after it. Thus, space below is not quite equal to space
695 % above. But it's pretty close.
696 \def\Egroup{%
697 % To get correct interline space between the last line of the group
698 % and the first line afterwards, we have to propagate \prevdepth.
699 \endgraf % Not \par, as it may have been set to \lisppar.
700 \global\dimen1 = \prevdepth
701 \egroup % End the \vtop.
702 % \dimen0 is the vertical size of the group's box.
703 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
704 % \dimen2 is how much space is left on the page (more or less).
705 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
706 % if the group doesn't fit on the current page, and it's a big big
707 % group, force a page break.
708 \ifdim \dimen0 > \dimen2
709 \ifdim \pagetotal < \vfilllimit\pageheight
710 \page
713 \box\groupbox
714 \prevdepth = \dimen1
715 \checkinserts
718 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
719 % message, so this ends up printing `@group can only ...'.
721 \newhelp\groupinvalidhelp{%
722 group can only be used in environments such as @example,^^J%
723 where each line of input produces a line of output.}
725 % @need space-in-mils
726 % forces a page break if there is not space-in-mils remaining.
728 \newdimen\mil \mil=0.001in
730 % Old definition--didn't work.
731 %\parseargdef\need{\par %
732 %% This method tries to make TeX break the page naturally
733 %% if the depth of the box does not fit.
734 %{\baselineskip=0pt%
735 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
736 %\prevdepth=-1000pt
739 \parseargdef\need{%
740 % Ensure vertical mode, so we don't make a big box in the middle of a
741 % paragraph.
742 \par
744 % If the @need value is less than one line space, it's useless.
745 \dimen0 = #1\mil
746 \dimen2 = \ht\strutbox
747 \advance\dimen2 by \dp\strutbox
748 \ifdim\dimen0 > \dimen2
750 % Do a \strut just to make the height of this box be normal, so the
751 % normal leading is inserted relative to the preceding line.
752 % And a page break here is fine.
753 \vtop to #1\mil{\strut\vfil}%
755 % TeX does not even consider page breaks if a penalty added to the
756 % main vertical list is 10000 or more. But in order to see if the
757 % empty box we just added fits on the page, we must make it consider
758 % page breaks. On the other hand, we don't want to actually break the
759 % page after the empty box. So we use a penalty of 9999.
761 % There is an extremely small chance that TeX will actually break the
762 % page at this \penalty, if there are no other feasible breakpoints in
763 % sight. (If the user is using lots of big @group commands, which
764 % almost-but-not-quite fill up a page, TeX will have a hard time doing
765 % good page breaking, for example.) However, I could not construct an
766 % example where a page broke at this \penalty; if it happens in a real
767 % document, then we can reconsider our strategy.
768 \penalty9999
770 % Back up by the size of the box, whether we did a page break or not.
771 \kern -#1\mil
773 % Do not allow a page break right after this kern.
774 \nobreak
778 % @br forces paragraph break (and is undocumented).
780 \let\br = \par
782 % @page forces the start of a new page.
784 \def\page{\par\vfill\supereject}
786 % @exdent text....
787 % outputs text on separate line in roman font, starting at standard page margin
789 % This records the amount of indent in the innermost environment.
790 % That's how much \exdent should take out.
791 \newskip\exdentamount
793 % This defn is used inside fill environments such as @defun.
794 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
796 % This defn is used inside nofill environments such as @example.
797 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
798 \leftline{\hskip\leftskip{\rm#1}}}}
800 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
801 % paragraph. For more general purposes, use the \margin insertion
802 % class. WHICH is `l' or `r'.
804 \newskip\inmarginspacing \inmarginspacing=1cm
805 \def\strutdepth{\dp\strutbox}
807 \def\doinmargin#1#2{\strut\vadjust{%
808 \nobreak
809 \kern-\strutdepth
810 \vtop to \strutdepth{%
811 \baselineskip=\strutdepth
812 \vss
813 % if you have multiple lines of stuff to put here, you'll need to
814 % make the vbox yourself of the appropriate size.
815 \ifx#1l%
816 \llap{\ignorespaces #2\hskip\inmarginspacing}%
817 \else
818 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
820 \null
823 \def\inleftmargin{\doinmargin l}
824 \def\inrightmargin{\doinmargin r}
826 % @inmargin{TEXT [, RIGHT-TEXT]}
827 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
828 % else use TEXT for both).
830 \def\inmargin#1{\parseinmargin #1,,\finish}
831 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
832 \setbox0 = \hbox{\ignorespaces #2}%
833 \ifdim\wd0 > 0pt
834 \def\lefttext{#1}% have both texts
835 \def\righttext{#2}%
836 \else
837 \def\lefttext{#1}% have only one text
838 \def\righttext{#1}%
841 \ifodd\pageno
842 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
843 \else
844 \def\temp{\inleftmargin\lefttext}%
846 \temp
849 % @include file insert text of that file as input.
851 \def\include{\parseargusing\filenamecatcodes\includezzz}
852 \def\includezzz#1{%
853 \pushthisfilestack
854 \def\thisfile{#1}%
856 \makevalueexpandable
857 \def\temp{\input #1 }%
858 \expandafter
859 }\temp
860 \popthisfilestack
862 \def\filenamecatcodes{%
863 \catcode`\\=\other
864 \catcode`~=\other
865 \catcode`^=\other
866 \catcode`_=\other
867 \catcode`|=\other
868 \catcode`<=\other
869 \catcode`>=\other
870 \catcode`+=\other
871 \catcode`-=\other
874 \def\pushthisfilestack{%
875 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
877 \def\pushthisfilestackX{%
878 \expandafter\pushthisfilestackY\thisfile\StackTerm
880 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
881 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
884 \def\popthisfilestack{\errthisfilestackempty}
885 \def\errthisfilestackempty{\errmessage{Internal error:
886 the stack of filenames is empty.}}
888 \def\thisfile{}
890 % @center line
891 % outputs that line, centered.
893 \parseargdef\center{%
894 \ifhmode
895 \let\next\centerH
896 \else
897 \let\next\centerV
899 \next{\hfil \ignorespaces#1\unskip \hfil}%
901 \def\centerH#1{%
903 \hfil\break
904 \advance\hsize by -\leftskip
905 \advance\hsize by -\rightskip
906 \line{#1}%
907 \break
910 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
912 % @sp n outputs n lines of vertical space
914 \parseargdef\sp{\vskip #1\baselineskip}
916 % @comment ...line which is ignored...
917 % @c is the same as @comment
918 % @ignore ... @end ignore is another way to write a comment
920 \def\comment{\begingroup \catcode`\^^M=\other%
921 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
922 \commentxxx}
923 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
925 \let\c=\comment
927 % @paragraphindent NCHARS
928 % We'll use ems for NCHARS, close enough.
929 % NCHARS can also be the word `asis' or `none'.
930 % We cannot feasibly implement @paragraphindent asis, though.
932 \def\asisword{asis} % no translation, these are keywords
933 \def\noneword{none}
935 \parseargdef\paragraphindent{%
936 \def\temp{#1}%
937 \ifx\temp\asisword
938 \else
939 \ifx\temp\noneword
940 \defaultparindent = 0pt
941 \else
942 \defaultparindent = #1em
945 \parindent = \defaultparindent
948 % @exampleindent NCHARS
949 % We'll use ems for NCHARS like @paragraphindent.
950 % It seems @exampleindent asis isn't necessary, but
951 % I preserve it to make it similar to @paragraphindent.
952 \parseargdef\exampleindent{%
953 \def\temp{#1}%
954 \ifx\temp\asisword
955 \else
956 \ifx\temp\noneword
957 \lispnarrowing = 0pt
958 \else
959 \lispnarrowing = #1em
964 % @firstparagraphindent WORD
965 % If WORD is `none', then suppress indentation of the first paragraph
966 % after a section heading. If WORD is `insert', then do indent at such
967 % paragraphs.
969 % The paragraph indentation is suppressed or not by calling
970 % \suppressfirstparagraphindent, which the sectioning commands do.
971 % We switch the definition of this back and forth according to WORD.
972 % By default, we suppress indentation.
974 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
975 \newdimen\currentparindent
977 \def\insertword{insert}
979 \parseargdef\firstparagraphindent{%
980 \def\temp{#1}%
981 \ifx\temp\noneword
982 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
983 \else\ifx\temp\insertword
984 \let\suppressfirstparagraphindent = \relax
985 \else
986 \errhelp = \EMsimple
987 \errmessage{Unknown @firstparagraphindent option `\temp'}%
988 \fi\fi
991 % Here is how we actually suppress indentation. Redefine \everypar to
992 % \kern backwards by \parindent, and then reset itself to empty.
994 % We also make \indent itself not actually do anything until the next
995 % paragraph.
997 \gdef\dosuppressfirstparagraphindent{%
998 \gdef\indent{%
999 \restorefirstparagraphindent
1000 \indent
1002 \gdef\noindent{%
1003 \restorefirstparagraphindent
1004 \noindent
1006 \global\everypar = {%
1007 \kern -\parindent
1008 \restorefirstparagraphindent
1012 \gdef\restorefirstparagraphindent{%
1013 \global \let \indent = \ptexindent
1014 \global \let \noindent = \ptexnoindent
1015 \global \everypar = {}%
1019 % @asis just yields its argument. Used with @table, for example.
1021 \def\asis#1{#1}
1023 % @math outputs its argument in math mode.
1025 % One complication: _ usually means subscripts, but it could also mean
1026 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1027 % _ active, and distinguish by seeing if the current family is \slfam,
1028 % which is what @var uses.
1030 \catcode\underChar = \active
1031 \gdef\mathunderscore{%
1032 \catcode\underChar=\active
1033 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1036 % Another complication: we want \\ (and @\) to output a \ character.
1037 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1038 % this is not advertised and we don't care. Texinfo does not
1039 % otherwise define @\.
1041 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1042 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1044 \def\math{%
1045 \tex
1046 \mathunderscore
1047 \let\\ = \mathbackslash
1048 \mathactive
1049 $\finishmath
1051 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1053 % Some active characters (such as <) are spaced differently in math.
1054 % We have to reset their definitions in case the @math was an argument
1055 % to a command which sets the catcodes (such as @item or @section).
1058 \catcode`^ = \active
1059 \catcode`< = \active
1060 \catcode`> = \active
1061 \catcode`+ = \active
1062 \gdef\mathactive{%
1063 \let^ = \ptexhat
1064 \let< = \ptexless
1065 \let> = \ptexgtr
1066 \let+ = \ptexplus
1070 % @bullet and @minus need the same treatment as @math, just above.
1071 \def\bullet{$\ptexbullet$}
1072 \def\minus{$-$}
1074 % @dots{} outputs an ellipsis using the current font.
1075 % We do .5em per period so that it has the same spacing in a typewriter
1076 % font as three actual period characters.
1078 \def\dots{%
1079 \leavevmode
1080 \hbox to 1.5em{%
1081 \hskip 0pt plus 0.25fil
1082 .\hfil.\hfil.%
1083 \hskip 0pt plus 0.5fil
1087 % @enddots{} is an end-of-sentence ellipsis.
1089 \def\enddots{%
1090 \dots
1091 \spacefactor=3000
1094 % @comma{} is so commas can be inserted into text without messing up
1095 % Texinfo's parsing.
1097 \let\comma = ,
1099 % @refill is a no-op.
1100 \let\refill=\relax
1102 % If working on a large document in chapters, it is convenient to
1103 % be able to disable indexing, cross-referencing, and contents, for test runs.
1104 % This is done with @novalidate (before @setfilename).
1106 \newif\iflinks \linkstrue % by default we want the aux files.
1107 \let\novalidate = \linksfalse
1109 % @setfilename is done at the beginning of every texinfo file.
1110 % So open here the files we need to have open while reading the input.
1111 % This makes it possible to make a .fmt file for texinfo.
1112 \def\setfilename{%
1113 \iflinks
1114 \tryauxfile
1115 % Open the new aux file. TeX will close it automatically at exit.
1116 \immediate\openout\auxfile=\jobname.aux
1117 \fi % \openindices needs to do some work in any case.
1118 \openindices
1119 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1120 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
1122 % If texinfo.cnf is present on the system, read it.
1123 % Useful for site-wide @afourpaper, etc.
1124 \openin 1 texinfo.cnf
1125 \ifeof 1 \else \input texinfo.cnf \fi
1126 \closein 1
1128 \comment % Ignore the actual filename.
1131 % Called from \setfilename.
1133 \def\openindices{%
1134 \newindex{cp}%
1135 \newcodeindex{fn}%
1136 \newcodeindex{vr}%
1137 \newcodeindex{tp}%
1138 \newcodeindex{ky}%
1139 \newcodeindex{pg}%
1142 % @bye.
1143 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1146 \message{pdf,}
1147 % adobe `portable' document format
1148 \newcount\tempnum
1149 \newcount\lnkcount
1150 \newtoks\filename
1151 \newcount\filenamelength
1152 \newcount\pgn
1153 \newtoks\toksA
1154 \newtoks\toksB
1155 \newtoks\toksC
1156 \newtoks\toksD
1157 \newbox\boxA
1158 \newcount\countA
1159 \newif\ifpdf
1160 \newif\ifpdfmakepagedest
1162 \ifx\pdfoutput\undefined
1163 \pdffalse
1164 \let\pdfmkdest = \gobble
1165 \let\pdfurl = \gobble
1166 \let\endlink = \relax
1167 \let\linkcolor = \relax
1168 \let\pdfmakeoutlines = \relax
1169 \else
1170 \pdftrue
1171 \pdfoutput = 1
1172 \input pdfcolor
1173 \pdfcatalog{/PageMode /UseOutlines}%
1174 \def\dopdfimage#1#2#3{%
1175 \def\imagewidth{#2}%
1176 \def\imageheight{#3}%
1177 % without \immediate, pdftex seg faults when the same image is
1178 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1179 \ifnum\pdftexversion < 14
1180 \immediate\pdfimage
1181 \else
1182 \immediate\pdfximage
1184 \ifx\empty\imagewidth\else width \imagewidth \fi
1185 \ifx\empty\imageheight\else height \imageheight \fi
1186 \ifnum\pdftexversion<13
1187 #1.pdf%
1188 \else
1189 {#1.pdf}%
1191 \ifnum\pdftexversion < 14 \else
1192 \pdfrefximage \pdflastximage
1193 \fi}
1194 \def\pdfmkdest#1{{%
1195 % We have to set dummies so commands such as @code in a section title
1196 % aren't expanded.
1197 \atdummies
1198 \normalturnoffactive
1199 \pdfdest name{#1} xyz%
1201 \def\pdfmkpgn#1{#1}
1202 \let\linkcolor = \Blue % was Cyan, but that seems light?
1203 \def\endlink{\Black\pdfendlink}
1204 % Adding outlines to PDF; macros for calculating structure of outlines
1205 % come from Petr Olsak
1206 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1207 \else \csname#1\endcsname \fi}
1208 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1209 \advance\tempnum by 1
1210 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1212 % #1 is the section text. #2 is the pdf expression for the number
1213 % of subentries (or empty, for subsubsections). #3 is the node
1214 % text, which might be empty if this toc entry had no
1215 % corresponding node. #4 is the page number.
1217 \def\dopdfoutline#1#2#3#4{%
1218 % Generate a link to the node text if that exists; else, use the
1219 % page number. We could generate a destination for the section
1220 % text in the case where a section has no node, but it doesn't
1221 % seem worthwhile, since most documents are normally structured.
1222 \def\pdfoutlinedest{#3}%
1223 \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1225 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1228 \def\pdfmakeoutlines{%
1229 \begingroup
1230 % Thanh's hack / proper braces in bookmarks
1231 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1232 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1234 % Read toc silently, to get counts of subentries for \pdfoutline.
1235 \def\numchapentry##1##2##3##4{%
1236 \def\thischapnum{##2}%
1237 \let\thissecnum\empty
1238 \let\thissubsecnum\empty
1240 \def\numsecentry##1##2##3##4{%
1241 \advancenumber{chap\thischapnum}%
1242 \def\thissecnum{##2}%
1243 \let\thissubsecnum\empty
1245 \def\numsubsecentry##1##2##3##4{%
1246 \advancenumber{sec\thissecnum}%
1247 \def\thissubsecnum{##2}%
1249 \def\numsubsubsecentry##1##2##3##4{%
1250 \advancenumber{subsec\thissubsecnum}%
1252 \let\thischapnum\empty
1253 \let\thissecnum\empty
1254 \let\thissubsecnum\empty
1256 % use \def rather than \let here because we redefine \chapentry et
1257 % al. a second time, below.
1258 \def\appentry{\numchapentry}%
1259 \def\appsecentry{\numsecentry}%
1260 \def\appsubsecentry{\numsubsecentry}%
1261 \def\appsubsubsecentry{\numsubsubsecentry}%
1262 \def\unnchapentry{\numchapentry}%
1263 \def\unnsecentry{\numsecentry}%
1264 \def\unnsubsecentry{\numsubsecentry}%
1265 \def\unnsubsubsecentry{\numsubsubsecentry}%
1266 \input \jobname.toc
1268 % Read toc second time, this time actually producing the outlines.
1269 % The `-' means take the \expnumber as the absolute number of
1270 % subentries, which we calculated on our first read of the .toc above.
1272 % We use the node names as the destinations.
1273 \def\numchapentry##1##2##3##4{%
1274 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1275 \def\numsecentry##1##2##3##4{%
1276 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1277 \def\numsubsecentry##1##2##3##4{%
1278 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1279 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1280 \dopdfoutline{##1}{}{##3}{##4}}%
1282 % Make special characters normal for writing to the pdf file.
1283 \indexnofonts
1284 \turnoffactive
1285 \input \jobname.toc
1286 \endgroup
1289 \def\makelinks #1,{%
1290 \def\params{#1}\def\E{END}%
1291 \ifx\params\E
1292 \let\nextmakelinks=\relax
1293 \else
1294 \let\nextmakelinks=\makelinks
1295 \ifnum\lnkcount>0,\fi
1296 \picknum{#1}%
1297 \startlink attr{/Border [0 0 0]}
1298 goto name{\pdfmkpgn{\the\pgn}}%
1299 \linkcolor #1%
1300 \advance\lnkcount by 1%
1301 \endlink
1303 \nextmakelinks
1305 \def\picknum#1{\expandafter\pn#1}
1306 \def\pn#1{%
1307 \def\p{#1}%
1308 \ifx\p\lbrace
1309 \let\nextpn=\ppn
1310 \else
1311 \let\nextpn=\ppnn
1312 \def\first{#1}
1314 \nextpn
1316 \def\ppn#1{\pgn=#1\gobble}
1317 \def\ppnn{\pgn=\first}
1318 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
1319 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1320 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1321 \ifx\PP\D\let\nextsp\relax
1322 \else\let\nextsp\skipspaces
1323 \ifx\p\space\else\addtokens{\filename}{\PP}%
1324 \advance\filenamelength by 1
1327 \nextsp}
1328 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1329 \ifnum\pdftexversion < 14
1330 \let \startlink \pdfannotlink
1331 \else
1332 \let \startlink \pdfstartlink
1334 \def\pdfurl#1{%
1335 \begingroup
1336 \normalturnoffactive\def\@{@}%
1337 \makevalueexpandable
1338 \leavevmode\Red
1339 \startlink attr{/Border [0 0 0]}%
1340 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1341 % #1
1342 \endgroup}
1343 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1344 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1345 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1346 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1347 \def\maketoks{%
1348 \expandafter\poptoks\the\toksA|ENDTOKS|
1349 \ifx\first0\adn0
1350 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1351 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1352 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1353 \else
1354 \ifnum0=\countA\else\makelink\fi
1355 \ifx\first.\let\next=\done\else
1356 \let\next=\maketoks
1357 \addtokens{\toksB}{\the\toksD}
1358 \ifx\first,\addtokens{\toksB}{\space}\fi
1360 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1361 \next}
1362 \def\makelink{\addtokens{\toksB}%
1363 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1364 \def\pdflink#1{%
1365 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1366 \linkcolor #1\endlink}
1367 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1368 \fi % \ifx\pdfoutput
1371 \message{fonts,}
1373 % Change the current font style to #1, remembering it in \curfontstyle.
1374 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1375 % italics, not bold italics.
1377 \def\setfontstyle#1{%
1378 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1379 \csname ten#1\endcsname % change the current font
1382 % Select #1 fonts with the current style.
1384 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1386 \def\rm{\fam=0 \setfontstyle{rm}}
1387 \def\it{\fam=\itfam \setfontstyle{it}}
1388 \def\sl{\fam=\slfam \setfontstyle{sl}}
1389 \def\bf{\fam=\bffam \setfontstyle{bf}}
1390 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1392 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1393 % So we set up a \sf.
1394 \newfam\sffam
1395 \def\sf{\fam=\sffam \setfontstyle{sf}}
1396 \let\li = \sf % Sometimes we call it \li, not \sf.
1398 % We don't need math for this font style.
1399 \def\ttsl{\setfontstyle{ttsl}}
1401 % Default leading.
1402 \newdimen\textleading \textleading = 13.2pt
1404 % Set the baselineskip to #1, and the lineskip and strut size
1405 % correspondingly. There is no deep meaning behind these magic numbers
1406 % used as factors; they just match (closely enough) what Knuth defined.
1408 \def\lineskipfactor{.08333}
1409 \def\strutheightpercent{.70833}
1410 \def\strutdepthpercent {.29167}
1412 \def\setleading#1{%
1413 \normalbaselineskip = #1\relax
1414 \normallineskip = \lineskipfactor\normalbaselineskip
1415 \normalbaselines
1416 \setbox\strutbox =\hbox{%
1417 \vrule width0pt height\strutheightpercent\baselineskip
1418 depth \strutdepthpercent \baselineskip
1422 % Set the font macro #1 to the font named #2, adding on the
1423 % specified font prefix (normally `cm').
1424 % #3 is the font's design size, #4 is a scale factor
1425 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1427 % Use cm as the default font prefix.
1428 % To specify the font prefix, you must define \fontprefix
1429 % before you read in texinfo.tex.
1430 \ifx\fontprefix\undefined
1431 \def\fontprefix{cm}
1433 % Support font families that don't use the same naming scheme as CM.
1434 \def\rmshape{r}
1435 \def\rmbshape{bx} %where the normal face is bold
1436 \def\bfshape{b}
1437 \def\bxshape{bx}
1438 \def\ttshape{tt}
1439 \def\ttbshape{tt}
1440 \def\ttslshape{sltt}
1441 \def\itshape{ti}
1442 \def\itbshape{bxti}
1443 \def\slshape{sl}
1444 \def\slbshape{bxsl}
1445 \def\sfshape{ss}
1446 \def\sfbshape{ss}
1447 \def\scshape{csc}
1448 \def\scbshape{csc}
1450 % Text fonts (11.2pt, magstep1).
1451 \newcount\mainmagstep
1452 \ifx\bigger\relax
1453 % not really supported.
1454 \mainmagstep=\magstep1
1455 \setfont\textrm\rmshape{12}{1000}
1456 \setfont\texttt\ttshape{12}{1000}
1457 \else
1458 \mainmagstep=\magstephalf
1459 \setfont\textrm\rmshape{10}{\mainmagstep}
1460 \setfont\texttt\ttshape{10}{\mainmagstep}
1462 \setfont\textbf\bfshape{10}{\mainmagstep}
1463 \setfont\textit\itshape{10}{\mainmagstep}
1464 \setfont\textsl\slshape{10}{\mainmagstep}
1465 \setfont\textsf\sfshape{10}{\mainmagstep}
1466 \setfont\textsc\scshape{10}{\mainmagstep}
1467 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1468 \font\texti=cmmi10 scaled \mainmagstep
1469 \font\textsy=cmsy10 scaled \mainmagstep
1471 % A few fonts for @defun names and args.
1472 \setfont\defbf\bfshape{10}{\magstep1}
1473 \setfont\deftt\ttshape{10}{\magstep1}
1474 \setfont\defttsl\ttslshape{10}{\magstep1}
1475 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1477 % Fonts for indices, footnotes, small examples (9pt).
1478 \setfont\smallrm\rmshape{9}{1000}
1479 \setfont\smalltt\ttshape{9}{1000}
1480 \setfont\smallbf\bfshape{10}{900}
1481 \setfont\smallit\itshape{9}{1000}
1482 \setfont\smallsl\slshape{9}{1000}
1483 \setfont\smallsf\sfshape{9}{1000}
1484 \setfont\smallsc\scshape{10}{900}
1485 \setfont\smallttsl\ttslshape{10}{900}
1486 \font\smalli=cmmi9
1487 \font\smallsy=cmsy9
1489 % Fonts for small examples (8pt).
1490 \setfont\smallerrm\rmshape{8}{1000}
1491 \setfont\smallertt\ttshape{8}{1000}
1492 \setfont\smallerbf\bfshape{10}{800}
1493 \setfont\smallerit\itshape{8}{1000}
1494 \setfont\smallersl\slshape{8}{1000}
1495 \setfont\smallersf\sfshape{8}{1000}
1496 \setfont\smallersc\scshape{10}{800}
1497 \setfont\smallerttsl\ttslshape{10}{800}
1498 \font\smalleri=cmmi8
1499 \font\smallersy=cmsy8
1501 % Fonts for title page (20.4pt):
1502 \setfont\titlerm\rmbshape{12}{\magstep3}
1503 \setfont\titleit\itbshape{10}{\magstep4}
1504 \setfont\titlesl\slbshape{10}{\magstep4}
1505 \setfont\titlett\ttbshape{12}{\magstep3}
1506 \setfont\titlettsl\ttslshape{10}{\magstep4}
1507 \setfont\titlesf\sfbshape{17}{\magstep1}
1508 \let\titlebf=\titlerm
1509 \setfont\titlesc\scbshape{10}{\magstep4}
1510 \font\titlei=cmmi12 scaled \magstep3
1511 \font\titlesy=cmsy10 scaled \magstep4
1512 \def\authorrm{\secrm}
1513 \def\authortt{\sectt}
1515 % Chapter (and unnumbered) fonts (17.28pt).
1516 \setfont\chaprm\rmbshape{12}{\magstep2}
1517 \setfont\chapit\itbshape{10}{\magstep3}
1518 \setfont\chapsl\slbshape{10}{\magstep3}
1519 \setfont\chaptt\ttbshape{12}{\magstep2}
1520 \setfont\chapttsl\ttslshape{10}{\magstep3}
1521 \setfont\chapsf\sfbshape{17}{1000}
1522 \let\chapbf=\chaprm
1523 \setfont\chapsc\scbshape{10}{\magstep3}
1524 \font\chapi=cmmi12 scaled \magstep2
1525 \font\chapsy=cmsy10 scaled \magstep3
1527 % Section fonts (14.4pt).
1528 \setfont\secrm\rmbshape{12}{\magstep1}
1529 \setfont\secit\itbshape{10}{\magstep2}
1530 \setfont\secsl\slbshape{10}{\magstep2}
1531 \setfont\sectt\ttbshape{12}{\magstep1}
1532 \setfont\secttsl\ttslshape{10}{\magstep2}
1533 \setfont\secsf\sfbshape{12}{\magstep1}
1534 \let\secbf\secrm
1535 \setfont\secsc\scbshape{10}{\magstep2}
1536 \font\seci=cmmi12 scaled \magstep1
1537 \font\secsy=cmsy10 scaled \magstep2
1539 % Subsection fonts (13.15pt).
1540 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1541 \setfont\ssecit\itbshape{10}{1315}
1542 \setfont\ssecsl\slbshape{10}{1315}
1543 \setfont\ssectt\ttbshape{12}{\magstephalf}
1544 \setfont\ssecttsl\ttslshape{10}{1315}
1545 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1546 \let\ssecbf\ssecrm
1547 \setfont\ssecsc\scbshape{10}{1315}
1548 \font\sseci=cmmi12 scaled \magstephalf
1549 \font\ssecsy=cmsy10 scaled 1315
1551 % Reduced fonts for @acro in text (10pt).
1552 \setfont\reducedrm\rmshape{10}{1000}
1553 \setfont\reducedtt\ttshape{10}{1000}
1554 \setfont\reducedbf\bfshape{10}{1000}
1555 \setfont\reducedit\itshape{10}{1000}
1556 \setfont\reducedsl\slshape{10}{1000}
1557 \setfont\reducedsf\sfshape{10}{1000}
1558 \setfont\reducedsc\scshape{10}{1000}
1559 \setfont\reducedttsl\ttslshape{10}{1000}
1560 \font\reducedi=cmmi10
1561 \font\reducedsy=cmsy10
1563 % In order for the font changes to affect most math symbols and letters,
1564 % we have to define the \textfont of the standard families. Since
1565 % texinfo doesn't allow for producing subscripts and superscripts except
1566 % in the main text, we don't bother to reset \scriptfont and
1567 % \scriptscriptfont (which would also require loading a lot more fonts).
1569 \def\resetmathfonts{%
1570 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1571 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1572 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1575 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1576 % of just \STYLE. We do this because \STYLE needs to also set the
1577 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1578 % \tenSTYLE to set the current font.
1580 % Each font-changing command also sets the names \lsize (one size lower)
1581 % and \lllsize (three sizes lower). These relative commands are used in
1582 % the LaTeX logo and acronyms.
1584 % This all needs generalizing, badly.
1586 \def\textfonts{%
1587 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1588 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1589 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1590 \let\tenttsl=\textttsl
1591 \def\lsize{reduced}\def\lllsize{smaller}%
1592 \resetmathfonts \setleading{\textleading}}
1593 \def\titlefonts{%
1594 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1595 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1596 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1597 \let\tenttsl=\titlettsl
1598 \def\lsize{chap}\def\lllsize{subsec}%
1599 \resetmathfonts \setleading{25pt}}
1600 \def\titlefont#1{{\titlefonts\rm #1}}
1601 \def\chapfonts{%
1602 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1603 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1604 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl
1605 \def\lsize{sec}\def\lllsize{text}%
1606 \resetmathfonts \setleading{19pt}}
1607 \def\secfonts{%
1608 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1609 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1610 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1611 \let\tenttsl=\secttsl
1612 \def\lsize{subsec}\def\lllsize{reduced}%
1613 \resetmathfonts \setleading{16pt}}
1614 \def\subsecfonts{%
1615 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1616 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1617 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1618 \let\tenttsl=\ssecttsl
1619 \def\lsize{text}\def\lllsize{small}%
1620 \resetmathfonts \setleading{15pt}}
1621 \let\subsubsecfonts = \subsecfonts
1622 \def\reducedfonts{%
1623 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1624 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1625 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1626 \let\tenttsl=\reducedttsl
1627 \def\lsize{small}\def\lllsize{smaller}%
1628 \resetmathfonts \setleading{10.5pt}}
1629 \def\smallfonts{%
1630 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1631 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1632 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1633 \let\tenttsl=\smallttsl
1634 \def\lsize{smaller}\def\lllsize{smaller}%
1635 \resetmathfonts \setleading{10.5pt}}
1636 \def\smallerfonts{%
1637 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1638 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1639 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1640 \let\tenttsl=\smallerttsl
1641 \def\lsize{smaller}\def\lllsize{smaller}%
1642 \resetmathfonts \setleading{9.5pt}}
1644 % Set the fonts to use with the @small... environments.
1645 \let\smallexamplefonts = \smallfonts
1647 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1648 % can fit this many characters:
1649 % 8.5x11=86 smallbook=72 a4=90 a5=69
1650 % If we use \scriptfonts (8pt), then we can fit this many characters:
1651 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1652 % For me, subjectively, the few extra characters that fit aren't worth
1653 % the additional smallness of 8pt. So I'm making the default 9pt.
1655 % By the way, for comparison, here's what fits with @example (10pt):
1656 % 8.5x11=71 smallbook=60 a4=75 a5=58
1658 % I wish the USA used A4 paper.
1659 % --karl, 24jan03.
1662 % Set up the default fonts, so we can use them for creating boxes.
1664 \textfonts \rm
1666 % Define these so they can be easily changed for other fonts.
1667 \def\angleleft{$\langle$}
1668 \def\angleright{$\rangle$}
1670 % Count depth in font-changes, for error checks
1671 \newcount\fontdepth \fontdepth=0
1673 % Fonts for short table of contents.
1674 \setfont\shortcontrm\rmshape{12}{1000}
1675 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1676 \setfont\shortcontsl\slshape{12}{1000}
1677 \setfont\shortconttt\ttshape{12}{1000}
1679 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1680 %% serif) and @ii for TeX italic
1682 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1683 % unless the following character is such as not to need one.
1684 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1685 \ptexslash\fi\fi\fi}
1686 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1687 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1689 % like \smartslanted except unconditionally uses \ttsl.
1690 % @var is set to this for defun arguments.
1691 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1693 % like \smartslanted except unconditionally use \sl. We never want
1694 % ttsl for book titles, do we?
1695 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1697 \let\i=\smartitalic
1698 \let\var=\smartslanted
1699 \let\dfn=\smartslanted
1700 \let\emph=\smartitalic
1702 \def\b#1{{\bf #1}}
1703 \let\strong=\b
1705 % We can't just use \exhyphenpenalty, because that only has effect at
1706 % the end of a paragraph. Restore normal hyphenation at the end of the
1707 % group within which \nohyphenation is presumably called.
1709 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1710 \def\restorehyphenation{\hyphenchar\font = `- }
1712 % Set sfcode to normal for the chars that usually have another value.
1713 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1714 % sometimes \x has an active definition that messes things up.
1716 \catcode`@=11
1717 \def\frenchspacing{%
1718 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1719 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1721 \catcode`@=\other
1723 \def\t#1{%
1724 {\tt \rawbackslash \frenchspacing #1}%
1725 \null
1727 \def\samp#1{`\tclose{#1}'\null}
1728 \setfont\keyrm\rmshape{8}{1000}
1729 \font\keysy=cmsy9
1730 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1731 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1732 \vbox{\hrule\kern-0.4pt
1733 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1734 \kern-0.4pt\hrule}%
1735 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
1736 % The old definition, with no lozenge:
1737 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1738 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1740 % @file, @option are the same as @samp.
1741 \let\file=\samp
1742 \let\option=\samp
1744 % @code is a modification of @t,
1745 % which makes spaces the same size as normal in the surrounding text.
1746 \def\tclose#1{%
1748 % Change normal interword space to be same as for the current font.
1749 \spaceskip = \fontdimen2\font
1751 % Switch to typewriter.
1754 % But `\ ' produces the large typewriter interword space.
1755 \def\ {{\spaceskip = 0pt{} }}%
1757 % Turn off hyphenation.
1758 \nohyphenation
1760 \rawbackslash
1761 \frenchspacing
1764 \null
1767 % We *must* turn on hyphenation at `-' and `_' in @code.
1768 % Otherwise, it is too hard to avoid overfull hboxes
1769 % in the Emacs manual, the Library manual, etc.
1771 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1772 % both hyphenation at - and hyphenation within words.
1773 % We must therefore turn them both off (\tclose does that)
1774 % and arrange explicitly to hyphenate at a dash.
1775 % -- rms.
1777 \catcode`\-=\active
1778 \catcode`\_=\active
1780 \global\def\code{\begingroup
1781 \catcode`\-=\active \let-\codedash
1782 \catcode`\_=\active \let_\codeunder
1783 \codex
1787 \def\realdash{-}
1788 \def\codedash{-\discretionary{}{}{}}
1789 \def\codeunder{%
1790 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1791 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1792 % will therefore expand the active definition of _, which is us
1793 % (inside @code that is), therefore an endless loop.
1794 \ifusingtt{\ifmmode
1795 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1796 \else\normalunderscore \fi
1797 \discretionary{}{}{}}%
1798 {\_}%
1800 \def\codex #1{\tclose{#1}\endgroup}
1802 % @kbd is like @code, except that if the argument is just one @key command,
1803 % then @kbd has no effect.
1805 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1806 % `example' (@kbd uses ttsl only inside of @example and friends),
1807 % or `code' (@kbd uses normal tty font always).
1808 \parseargdef\kbdinputstyle{%
1809 \def\arg{#1}%
1810 \ifx\arg\worddistinct
1811 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1812 \else\ifx\arg\wordexample
1813 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1814 \else\ifx\arg\wordcode
1815 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1816 \else
1817 \errhelp = \EMsimple
1818 \errmessage{Unknown @kbdinputstyle option `\arg'}%
1819 \fi\fi\fi
1821 \def\worddistinct{distinct}
1822 \def\wordexample{example}
1823 \def\wordcode{code}
1825 % Default is `distinct.'
1826 \kbdinputstyle distinct
1828 \def\xkey{\key}
1829 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1830 \ifx\one\xkey\ifx\threex\three \key{#2}%
1831 \else{\tclose{\kbdfont\look}}\fi
1832 \else{\tclose{\kbdfont\look}}\fi}
1834 % For @url, @env, @command quotes seem unnecessary, so use \code.
1835 \let\url=\code
1836 \let\env=\code
1837 \let\command=\code
1839 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1840 % second argument specifying the text to display and an optional third
1841 % arg as text to display instead of (rather than in addition to) the url
1842 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1843 % a hypertex \special here.
1845 \def\uref#1{\douref #1,,,\finish}
1846 \def\douref#1,#2,#3,#4\finish{\begingroup
1847 \unsepspaces
1848 \pdfurl{#1}%
1849 \setbox0 = \hbox{\ignorespaces #3}%
1850 \ifdim\wd0 > 0pt
1851 \unhbox0 % third arg given, show only that
1852 \else
1853 \setbox0 = \hbox{\ignorespaces #2}%
1854 \ifdim\wd0 > 0pt
1855 \ifpdf
1856 \unhbox0 % PDF: 2nd arg given, show only it
1857 \else
1858 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
1860 \else
1861 \code{#1}% only url given, so show it
1864 \endlink
1865 \endgroup}
1867 % rms does not like angle brackets --karl, 17may97.
1868 % So now @email is just like @uref, unless we are pdf.
1870 %\def\email#1{\angleleft{\tt #1}\angleright}
1871 \ifpdf
1872 \def\email#1{\doemail#1,,\finish}
1873 \def\doemail#1,#2,#3\finish{\begingroup
1874 \unsepspaces
1875 \pdfurl{mailto:#1}%
1876 \setbox0 = \hbox{\ignorespaces #2}%
1877 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
1878 \endlink
1879 \endgroup}
1880 \else
1881 \let\email=\uref
1884 % Check if we are currently using a typewriter font. Since all the
1885 % Computer Modern typewriter fonts have zero interword stretch (and
1886 % shrink), and it is reasonable to expect all typewriter fonts to have
1887 % this property, we can check that font parameter.
1889 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
1891 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1892 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1894 \def\dmn#1{\thinspace #1}
1896 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1898 % @l was never documented to mean ``switch to the Lisp font'',
1899 % and it is not used as such in any manual I can find. We need it for
1900 % Polish suppressed-l. --karl, 22sep96.
1901 %\def\l#1{{\li #1}\null}
1903 % Explicit font changes: @r, @sc, undocumented @ii.
1904 \def\r#1{{\rm #1}} % roman font
1905 \def\sc#1{{\smallcaps#1}} % smallcaps font
1906 \def\ii#1{{\it #1}} % italic font
1908 \def\acronym#1{\doacronym #1,,\finish}
1909 \def\doacronym#1,#2,#3\finish{%
1910 {\selectfonts\lsize #1}%
1911 \def\temp{#2}%
1912 \ifx\temp\empty \else
1913 \space ({\unsepspaces \ignorespaces \temp \unskip})%
1917 % @pounds{} is a sterling sign, which is in the CM italic font.
1919 \def\pounds{{\it\$}}
1921 % @registeredsymbol - R in a circle. The font for the R should really
1922 % be smaller yet, but lllsize is the best we can do for now.
1923 % Adapted from the plain.tex definition of \copyright.
1925 \def\registeredsymbol{%
1926 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
1927 \hfil\crcr\Orb}}%
1932 \message{page headings,}
1934 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1935 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1937 % First the title page. Must do @settitle before @titlepage.
1938 \newif\ifseenauthor
1939 \newif\iffinishedtitlepage
1941 % Do an implicit @contents or @shortcontents after @end titlepage if the
1942 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1944 \newif\ifsetcontentsaftertitlepage
1945 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1946 \newif\ifsetshortcontentsaftertitlepage
1947 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1949 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1950 \endgroup\page\hbox{}\page}
1952 \envdef\titlepage{%
1953 % Open one extra group, as we want to close it in the middle of \Etitlepage.
1954 \begingroup
1955 \parindent=0pt \textfonts
1956 % Leave some space at the very top of the page.
1957 \vglue\titlepagetopglue
1958 % No rule at page bottom unless we print one at the top with @title.
1959 \finishedtitlepagetrue
1961 % Most title ``pages'' are actually two pages long, with space
1962 % at the top of the second. We don't want the ragged left on the second.
1963 \let\oldpage = \page
1964 \def\page{%
1965 \iffinishedtitlepage\else
1966 \finishtitlepage
1968 \let\page = \oldpage
1969 \page
1970 \null
1974 \def\Etitlepage{%
1975 \iffinishedtitlepage\else
1976 \finishtitlepage
1978 % It is important to do the page break before ending the group,
1979 % because the headline and footline are only empty inside the group.
1980 % If we use the new definition of \page, we always get a blank page
1981 % after the title page, which we certainly don't want.
1982 \oldpage
1983 \endgroup
1985 % Need this before the \...aftertitlepage checks so that if they are
1986 % in effect the toc pages will come out with page numbers.
1987 \HEADINGSon
1989 % If they want short, they certainly want long too.
1990 \ifsetshortcontentsaftertitlepage
1991 \shortcontents
1992 \contents
1993 \global\let\shortcontents = \relax
1994 \global\let\contents = \relax
1997 \ifsetcontentsaftertitlepage
1998 \contents
1999 \global\let\contents = \relax
2000 \global\let\shortcontents = \relax
2004 \def\finishtitlepage{%
2005 \vskip4pt \hrule height 2pt width \hsize
2006 \vskip\titlepagebottomglue
2007 \finishedtitlepagetrue
2010 %%% Macros to be used within @titlepage:
2012 \let\subtitlerm=\tenrm
2013 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2015 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2016 \let\tt=\authortt}
2018 \parseargdef\title{%
2019 \checkenv\titlepage
2020 \leftline{\titlefonts\rm #1}
2021 % print a rule at the page bottom also.
2022 \finishedtitlepagefalse
2023 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2026 \parseargdef\subtitle{%
2027 \checkenv\titlepage
2028 {\subtitlefont \rightline{#1}}%
2031 % @author should come last, but may come many times.
2032 \parseargdef\author{%
2033 \def\temp{\quotation}%
2034 \ifx\thisenv\temp
2035 This edition of the manual is dedicated to Karl Berry who should
2036 really make affiliations work.
2037 \else
2038 \checkenv\titlepage
2039 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2040 {\authorfont \leftline{#1}}%
2045 %%% Set up page headings and footings.
2047 \let\thispage=\folio
2049 \newtoks\evenheadline % headline on even pages
2050 \newtoks\oddheadline % headline on odd pages
2051 \newtoks\evenfootline % footline on even pages
2052 \newtoks\oddfootline % footline on odd pages
2054 % Now make TeX use those variables
2055 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2056 \else \the\evenheadline \fi}}
2057 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2058 \else \the\evenfootline \fi}\HEADINGShook}
2059 \let\HEADINGShook=\relax
2061 % Commands to set those variables.
2062 % For example, this is what @headings on does
2063 % @evenheading @thistitle|@thispage|@thischapter
2064 % @oddheading @thischapter|@thispage|@thistitle
2065 % @evenfooting @thisfile||
2066 % @oddfooting ||@thisfile
2069 \def\evenheading{\parsearg\evenheadingxxx}
2070 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2071 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2072 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2074 \def\oddheading{\parsearg\oddheadingxxx}
2075 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2076 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2077 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2079 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2081 \def\evenfooting{\parsearg\evenfootingxxx}
2082 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2083 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2084 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2086 \def\oddfooting{\parsearg\oddfootingxxx}
2087 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2088 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2089 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2091 % Leave some space for the footline. Hopefully ok to assume
2092 % @evenfooting will not be used by itself.
2093 \global\advance\pageheight by -\baselineskip
2094 \global\advance\vsize by -\baselineskip
2097 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2100 % @headings double turns headings on for double-sided printing.
2101 % @headings single turns headings on for single-sided printing.
2102 % @headings off turns them off.
2103 % @headings on same as @headings double, retained for compatibility.
2104 % @headings after turns on double-sided headings after this page.
2105 % @headings doubleafter turns on double-sided headings after this page.
2106 % @headings singleafter turns on single-sided headings after this page.
2107 % By default, they are off at the start of a document,
2108 % and turned `on' after @end titlepage.
2110 \def\headings #1 {\csname HEADINGS#1\endcsname}
2112 \def\HEADINGSoff{%
2113 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2114 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2115 \HEADINGSoff
2116 % When we turn headings on, set the page number to 1.
2117 % For double-sided printing, put current file name in lower left corner,
2118 % chapter name on inside top of right hand pages, document
2119 % title on inside top of left hand pages, and page numbers on outside top
2120 % edge of all pages.
2121 \def\HEADINGSdouble{%
2122 \global\pageno=1
2123 \global\evenfootline={\hfil}
2124 \global\oddfootline={\hfil}
2125 \global\evenheadline={\line{\folio\hfil\thistitle}}
2126 \global\oddheadline={\line{\thischapter\hfil\folio}}
2127 \global\let\contentsalignmacro = \chapoddpage
2129 \let\contentsalignmacro = \chappager
2131 % For single-sided printing, chapter title goes across top left of page,
2132 % page number on top right.
2133 \def\HEADINGSsingle{%
2134 \global\pageno=1
2135 \global\evenfootline={\hfil}
2136 \global\oddfootline={\hfil}
2137 \global\evenheadline={\line{\thischapter\hfil\folio}}
2138 \global\oddheadline={\line{\thischapter\hfil\folio}}
2139 \global\let\contentsalignmacro = \chappager
2141 \def\HEADINGSon{\HEADINGSdouble}
2143 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2144 \let\HEADINGSdoubleafter=\HEADINGSafter
2145 \def\HEADINGSdoublex{%
2146 \global\evenfootline={\hfil}
2147 \global\oddfootline={\hfil}
2148 \global\evenheadline={\line{\folio\hfil\thistitle}}
2149 \global\oddheadline={\line{\thischapter\hfil\folio}}
2150 \global\let\contentsalignmacro = \chapoddpage
2153 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2154 \def\HEADINGSsinglex{%
2155 \global\evenfootline={\hfil}
2156 \global\oddfootline={\hfil}
2157 \global\evenheadline={\line{\thischapter\hfil\folio}}
2158 \global\oddheadline={\line{\thischapter\hfil\folio}}
2159 \global\let\contentsalignmacro = \chappager
2162 % Subroutines used in generating headings
2163 % This produces Day Month Year style of output.
2164 % Only define if not already defined, in case a txi-??.tex file has set
2165 % up a different format (e.g., txi-cs.tex does this).
2166 \ifx\today\undefined
2167 \def\today{%
2168 \number\day\space
2169 \ifcase\month
2170 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2171 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2172 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2174 \space\number\year}
2177 % @settitle line... specifies the title of the document, for headings.
2178 % It generates no output of its own.
2179 \def\thistitle{\putwordNoTitle}
2180 \def\settitle{\parsearg{\gdef\thistitle}}
2183 \message{tables,}
2184 % Tables -- @table, @ftable, @vtable, @item(x).
2186 % default indentation of table text
2187 \newdimen\tableindent \tableindent=.8in
2188 % default indentation of @itemize and @enumerate text
2189 \newdimen\itemindent \itemindent=.3in
2190 % margin between end of table item and start of table text.
2191 \newdimen\itemmargin \itemmargin=.1in
2193 % used internally for \itemindent minus \itemmargin
2194 \newdimen\itemmax
2196 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2197 % these defs.
2198 % They also define \itemindex
2199 % to index the item name in whatever manner is desired (perhaps none).
2201 \newif\ifitemxneedsnegativevskip
2203 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2205 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2206 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2208 \def\itemzzz #1{\begingroup %
2209 \advance\hsize by -\rightskip
2210 \advance\hsize by -\tableindent
2211 \setbox0=\hbox{\itemindicate{#1}}%
2212 \itemindex{#1}%
2213 \nobreak % This prevents a break before @itemx.
2215 % If the item text does not fit in the space we have, put it on a line
2216 % by itself, and do not allow a page break either before or after that
2217 % line. We do not start a paragraph here because then if the next
2218 % command is, e.g., @kindex, the whatsit would get put into the
2219 % horizontal list on a line by itself, resulting in extra blank space.
2220 \ifdim \wd0>\itemmax
2222 % Make this a paragraph so we get the \parskip glue and wrapping,
2223 % but leave it ragged-right.
2224 \begingroup
2225 \advance\leftskip by-\tableindent
2226 \advance\hsize by\tableindent
2227 \advance\rightskip by0pt plus1fil
2228 \leavevmode\unhbox0\par
2229 \endgroup
2231 % We're going to be starting a paragraph, but we don't want the
2232 % \parskip glue -- logically it's part of the @item we just started.
2233 \nobreak \vskip-\parskip
2235 % Stop a page break at the \parskip glue coming up. (Unfortunately
2236 % we can't prevent a possible page break at the following
2237 % \baselineskip glue.) However, if what follows is an environment
2238 % such as @example, there will be no \parskip glue; then
2239 % the negative vskip we just would cause the example and the item to
2240 % crash together. So we use this bizarre value of 10001 as a signal
2241 % to \aboveenvbreak to insert \parskip glue after all.
2242 % (Possibly there are other commands that could be followed by
2243 % @example which need the same treatment, but not section titles; or
2244 % maybe section titles are the only special case and they should be
2245 % penalty 10001...)
2246 \penalty 10001
2247 \endgroup
2248 \itemxneedsnegativevskipfalse
2249 \else
2250 % The item text fits into the space. Start a paragraph, so that the
2251 % following text (if any) will end up on the same line.
2252 \noindent
2253 % Do this with kerns and \unhbox so that if there is a footnote in
2254 % the item text, it can migrate to the main vertical list and
2255 % eventually be printed.
2256 \nobreak\kern-\tableindent
2257 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2258 \unhbox0
2259 \nobreak\kern\dimen0
2260 \endgroup
2261 \itemxneedsnegativevskiptrue
2265 \def\item{\errmessage{@item while not in a list environment}}
2266 \def\itemx{\errmessage{@itemx while not in a list environment}}
2268 % @table, @ftable, @vtable.
2269 \envdef\table{%
2270 \let\itemindex\gobble
2271 \tablex
2273 \envdef\ftable{%
2274 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2275 \tablex
2277 \envdef\vtable{%
2278 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2279 \tablex
2281 \def\tablex#1{%
2282 \def\itemindicate{#1}%
2283 \parsearg\tabley
2285 \def\tabley#1{%
2287 \makevalueexpandable
2288 \edef\temp{\noexpand\tablez #1\space\space\space}%
2289 \expandafter
2290 }\temp \endtablez
2292 \def\tablez #1 #2 #3 #4\endtablez{%
2293 \aboveenvbreak
2294 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2295 \ifnum 0#2>0 \tableindent=#2\mil \fi
2296 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2297 \itemmax=\tableindent
2298 \advance \itemmax by -\itemmargin
2299 \advance \leftskip by \tableindent
2300 \exdentamount=\tableindent
2301 \parindent = 0pt
2302 \parskip = \smallskipamount
2303 \ifdim \parskip=0pt \parskip=2pt \fi
2304 \let\item = \internalBitem
2305 \let\itemx = \internalBitemx
2307 \def\Etable{\endgraf\afterenvbreak}
2308 \let\Eftable\Etable
2309 \let\Evtable\Etable
2310 \let\Eitemize\Etable
2311 \let\Eenumerate\Etable
2313 % This is the counter used by @enumerate, which is really @itemize
2315 \newcount \itemno
2317 \envdef\itemize{%
2318 \parsearg\itemizey
2321 \def\itemizey#1{%
2322 \aboveenvbreak
2323 \itemmax=\itemindent
2324 \advance\itemmax by -\itemmargin
2325 \advance\leftskip by \itemindent
2326 \exdentamount=\itemindent
2327 \parindent=0pt
2328 \parskip=\smallskipamount
2329 \ifdim\parskip=0pt \parskip=2pt \fi
2330 \def\itemcontents{#1}%
2331 % @itemize with no arg is equivalent to @itemize @bullet.
2332 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2333 \let\item=\itemizeitem
2336 % \splitoff TOKENS\endmark defines \first to be the first token in
2337 % TOKENS, and \rest to be the remainder.
2339 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2341 % Allow an optional argument of an uppercase letter, lowercase letter,
2342 % or number, to specify the first label in the enumerated list. No
2343 % argument is the same as `1'.
2345 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2346 \def\enumeratey #1 #2\endenumeratey{%
2347 % If we were given no argument, pretend we were given `1'.
2348 \def\thearg{#1}%
2349 \ifx\thearg\empty \def\thearg{1}\fi
2351 % Detect if the argument is a single token. If so, it might be a
2352 % letter. Otherwise, the only valid thing it can be is a number.
2353 % (We will always have one token, because of the test we just made.
2354 % This is a good thing, since \splitoff doesn't work given nothing at
2355 % all -- the first parameter is undelimited.)
2356 \expandafter\splitoff\thearg\endmark
2357 \ifx\rest\empty
2358 % Only one token in the argument. It could still be anything.
2359 % A ``lowercase letter'' is one whose \lccode is nonzero.
2360 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2361 % not equal to itself.
2362 % Otherwise, we assume it's a number.
2364 % We need the \relax at the end of the \ifnum lines to stop TeX from
2365 % continuing to look for a <number>.
2367 \ifnum\lccode\expandafter`\thearg=0\relax
2368 \numericenumerate % a number (we hope)
2369 \else
2370 % It's a letter.
2371 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2372 \lowercaseenumerate % lowercase letter
2373 \else
2374 \uppercaseenumerate % uppercase letter
2377 \else
2378 % Multiple tokens in the argument. We hope it's a number.
2379 \numericenumerate
2383 % An @enumerate whose labels are integers. The starting integer is
2384 % given in \thearg.
2386 \def\numericenumerate{%
2387 \itemno = \thearg
2388 \startenumeration{\the\itemno}%
2391 % The starting (lowercase) letter is in \thearg.
2392 \def\lowercaseenumerate{%
2393 \itemno = \expandafter`\thearg
2394 \startenumeration{%
2395 % Be sure we're not beyond the end of the alphabet.
2396 \ifnum\itemno=0
2397 \errmessage{No more lowercase letters in @enumerate; get a bigger
2398 alphabet}%
2400 \char\lccode\itemno
2404 % The starting (uppercase) letter is in \thearg.
2405 \def\uppercaseenumerate{%
2406 \itemno = \expandafter`\thearg
2407 \startenumeration{%
2408 % Be sure we're not beyond the end of the alphabet.
2409 \ifnum\itemno=0
2410 \errmessage{No more uppercase letters in @enumerate; get a bigger
2411 alphabet}
2413 \char\uccode\itemno
2417 % Call itemizey, adding a period to the first argument and supplying the
2418 % common last two arguments. Also subtract one from the initial value in
2419 % \itemno, since @item increments \itemno.
2421 \def\startenumeration#1{%
2422 \advance\itemno by -1
2423 \itemizey{#1.}\flushcr
2426 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2427 % to @enumerate.
2429 \def\alphaenumerate{\enumerate{a}}
2430 \def\capsenumerate{\enumerate{A}}
2431 \def\Ealphaenumerate{\Eenumerate}
2432 \def\Ecapsenumerate{\Eenumerate}
2434 % Definition of @item while inside @itemize.
2436 \def\itemizeitem{%
2437 \advance\itemno by 1
2438 {\let\par=\endgraf \smallbreak}%
2439 \ifhmode \errmessage{In hmode at itemizeitem}\fi
2440 {\parskip=0in \hskip 0pt
2441 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
2442 \vadjust{\penalty 1200}}%
2443 \flushcr}
2445 % @multitable macros
2446 % Amy Hendrickson, 8/18/94, 3/6/96
2448 % @multitable ... @end multitable will make as many columns as desired.
2449 % Contents of each column will wrap at width given in preamble. Width
2450 % can be specified either with sample text given in a template line,
2451 % or in percent of \hsize, the current width of text on page.
2453 % Table can continue over pages but will only break between lines.
2455 % To make preamble:
2457 % Either define widths of columns in terms of percent of \hsize:
2458 % @multitable @columnfractions .25 .3 .45
2459 % @item ...
2461 % Numbers following @columnfractions are the percent of the total
2462 % current hsize to be used for each column. You may use as many
2463 % columns as desired.
2466 % Or use a template:
2467 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2468 % @item ...
2469 % using the widest term desired in each column.
2471 % Each new table line starts with @item, each subsequent new column
2472 % starts with @tab. Empty columns may be produced by supplying @tab's
2473 % with nothing between them for as many times as empty columns are needed,
2474 % ie, @tab@tab@tab will produce two empty columns.
2476 % @item, @tab do not need to be on their own lines, but it will not hurt
2477 % if they are.
2479 % Sample multitable:
2481 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2482 % @item first col stuff @tab second col stuff @tab third col
2483 % @item
2484 % first col stuff
2485 % @tab
2486 % second col stuff
2487 % @tab
2488 % third col
2489 % @item first col stuff @tab second col stuff
2490 % @tab Many paragraphs of text may be used in any column.
2492 % They will wrap at the width determined by the template.
2493 % @item@tab@tab This will be in third column.
2494 % @end multitable
2496 % Default dimensions may be reset by user.
2497 % @multitableparskip is vertical space between paragraphs in table.
2498 % @multitableparindent is paragraph indent in table.
2499 % @multitablecolmargin is horizontal space to be left between columns.
2500 % @multitablelinespace is space to leave between table items, baseline
2501 % to baseline.
2502 % 0pt means it depends on current normal line spacing.
2504 \newskip\multitableparskip
2505 \newskip\multitableparindent
2506 \newdimen\multitablecolspace
2507 \newskip\multitablelinespace
2508 \multitableparskip=0pt
2509 \multitableparindent=6pt
2510 \multitablecolspace=12pt
2511 \multitablelinespace=0pt
2513 % Macros used to set up halign preamble:
2515 \let\endsetuptable\relax
2516 \def\xendsetuptable{\endsetuptable}
2517 \let\columnfractions\relax
2518 \def\xcolumnfractions{\columnfractions}
2519 \newif\ifsetpercent
2521 % #1 is the part of the @columnfraction before the decimal point, which
2522 % is presumably either 0 or the empty string (but we don't check, we
2523 % just throw it away). #2 is the decimal part, which we use as the
2524 % percent of \hsize for this column.
2525 \def\pickupwholefraction#1.#2 {%
2526 \global\advance\colcount by 1
2527 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}%
2528 \setuptable
2531 \newcount\colcount
2532 \def\setuptable#1{%
2533 \def\firstarg{#1}%
2534 \ifx\firstarg\xendsetuptable
2535 \let\go = \relax
2536 \else
2537 \ifx\firstarg\xcolumnfractions
2538 \global\setpercenttrue
2539 \else
2540 \ifsetpercent
2541 \let\go\pickupwholefraction
2542 \else
2543 \global\advance\colcount by 1
2544 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2545 % separator; typically that is always in the input, anyway.
2546 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2549 \ifx\go\pickupwholefraction
2550 % Put the argument back for the \pickupwholefraction call, so
2551 % we'll always have a period there to be parsed.
2552 \def\go{\pickupwholefraction#1}%
2553 \else
2554 \let\go = \setuptable
2555 \fi%
2560 % multitable-only commands.
2562 % @headitem starts a heading row, which we typeset in bold.
2563 % Assignments have to be global since we are inside the implicit group
2564 % of an alignment entry. Note that \everycr resets \everytab.
2565 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2567 % A \tab used to include \hskip1sp. But then the space in a template
2568 % line is not enough. That is bad. So let's go back to just `&' until
2569 % we encounter the problem it was intended to solve again.
2570 % --karl, nathan@acm.org, 20apr99.
2571 \def\tab{\checkenv\multitable &\the\everytab}%
2573 % @multitable ... @end multitable definitions:
2575 \newtoks\everytab % insert after every tab.
2577 \envdef\multitable{%
2578 \vskip\parskip
2579 \startsavinginserts
2581 % @item within a multitable starts a normal row.
2582 \let\item\crcr
2584 \tolerance=9500
2585 \hbadness=9500
2586 \setmultitablespacing
2587 \parskip=\multitableparskip
2588 \parindent=\multitableparindent
2589 \overfullrule=0pt
2590 \global\colcount=0
2592 \everycr = {%
2593 \noalign{%
2594 \global\everytab={}%
2595 \global\colcount=0 % Reset the column counter.
2596 % Check for saved footnotes, etc.
2597 \checkinserts
2598 % Keeps underfull box messages off when table breaks over pages.
2599 %\filbreak
2600 % Maybe so, but it also creates really weird page breaks when the
2601 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2602 % problem manifests itself, so it can be fixed for real --karl.
2606 \parsearg\domultitable
2608 \def\domultitable#1{%
2609 % To parse everything between @multitable and @item:
2610 \setuptable#1 \endsetuptable
2612 % This preamble sets up a generic column definition, which will
2613 % be used as many times as user calls for columns.
2614 % \vtop will set a single line and will also let text wrap and
2615 % continue for many paragraphs if desired.
2616 \halign\bgroup &%
2617 \global\advance\colcount by 1
2618 \multistrut
2619 \vtop{%
2620 % Use the current \colcount to find the correct column width:
2621 \hsize=\expandafter\csname col\the\colcount\endcsname
2623 % In order to keep entries from bumping into each other
2624 % we will add a \leftskip of \multitablecolspace to all columns after
2625 % the first one.
2627 % If a template has been used, we will add \multitablecolspace
2628 % to the width of each template entry.
2630 % If the user has set preamble in terms of percent of \hsize we will
2631 % use that dimension as the width of the column, and the \leftskip
2632 % will keep entries from bumping into each other. Table will start at
2633 % left margin and final column will justify at right margin.
2635 % Make sure we don't inherit \rightskip from the outer environment.
2636 \rightskip=0pt
2637 \ifnum\colcount=1
2638 % The first column will be indented with the surrounding text.
2639 \advance\hsize by\leftskip
2640 \else
2641 \ifsetpercent \else
2642 % If user has not set preamble in terms of percent of \hsize
2643 % we will advance \hsize by \multitablecolspace.
2644 \advance\hsize by \multitablecolspace
2646 % In either case we will make \leftskip=\multitablecolspace:
2647 \leftskip=\multitablecolspace
2649 % Ignoring space at the beginning and end avoids an occasional spurious
2650 % blank line, when TeX decides to break the line at the space before the
2651 % box from the multistrut, so the strut ends up on a line by itself.
2652 % For example:
2653 % @multitable @columnfractions .11 .89
2654 % @item @code{#}
2655 % @tab Legal holiday which is valid in major parts of the whole country.
2656 % Is automatically provided with highlighting sequences respectively
2657 % marking characters.
2658 \noindent\ignorespaces##\unskip\multistrut
2659 }\cr
2661 \def\Emultitable{%
2662 \crcr
2663 \egroup % end the \halign
2664 \global\setpercentfalse
2667 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2668 % If so, do nothing. If not, give it an appropriate dimension based on
2669 % current baselineskip.
2670 \ifdim\multitablelinespace=0pt
2671 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2672 \global\advance\multitablelinespace by-\ht0
2673 %% strut to put in table in case some entry doesn't have descenders,
2674 %% to keep lines equally spaced
2675 \let\multistrut = \strut
2676 \else
2677 %% FIXME: what is \box0 supposed to be?
2678 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2679 width0pt\relax} \fi
2680 %% Test to see if parskip is larger than space between lines of
2681 %% table. If not, do nothing.
2682 %% If so, set to same dimension as multitablelinespace.
2683 \ifdim\multitableparskip>\multitablelinespace
2684 \global\multitableparskip=\multitablelinespace
2685 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2686 %% than skip between lines in the table.
2687 \fi%
2688 \ifdim\multitableparskip=0pt
2689 \global\multitableparskip=\multitablelinespace
2690 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
2691 %% than skip between lines in the table.
2692 \fi}
2695 \message{conditionals,}
2697 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2698 % @ifnotxml always succeed. They currently do nothing; we don't
2699 % attempt to check whether the conditionals are properly nested. But we
2700 % have to remember that they are conditionals, so that @end doesn't
2701 % attempt to close an environment group.
2703 \def\makecond#1{%
2704 \expandafter\let\csname #1\endcsname = \relax
2705 \expandafter\let\csname iscond.#1\endcsname = 1
2707 \makecond{iftex}
2708 \makecond{ifnotdocbook}
2709 \makecond{ifnothtml}
2710 \makecond{ifnotinfo}
2711 \makecond{ifnotplaintext}
2712 \makecond{ifnotxml}
2714 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2716 \def\direntry{\doignore{direntry}}
2717 \def\documentdescription{\doignore{documentdescription}}
2718 \def\docbook{\doignore{docbook}}
2719 \def\html{\doignore{html}}
2720 \def\ifdocbook{\doignore{ifdocbook}}
2721 \def\ifhtml{\doignore{ifhtml}}
2722 \def\ifinfo{\doignore{ifinfo}}
2723 \def\ifnottex{\doignore{ifnottex}}
2724 \def\ifplaintext{\doignore{ifplaintext}}
2725 \def\ifxml{\doignore{ifxml}}
2726 \def\ignore{\doignore{ignore}}
2727 \def\menu{\doignore{menu}}
2728 \def\xml{\doignore{xml}}
2730 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2732 % A count to remember the depth of nesting.
2733 \newcount\doignorecount
2735 \def\doignore#1{\begingroup
2736 % Scan in ``verbatim'' mode:
2737 \catcode`\@ = \other
2738 \catcode`\{ = \other
2739 \catcode`\} = \other
2741 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2742 \spaceisspace
2744 % Count number of #1's that we've seen.
2745 \doignorecount = 0
2747 % Swallow text until we reach the matching `@end #1'.
2748 \dodoignore {#1}%
2751 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2752 \obeylines %
2754 \gdef\dodoignore#1{%
2755 % #1 contains the string `ifinfo'.
2757 % Define a command to find the next `@end #1', which must be on a line
2758 % by itself.
2759 \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}%
2760 % And this command to find another #1 command, at the beginning of a
2761 % line. (Otherwise, we would consider a line `@c @ifset', for
2762 % example, to count as an @ifset for nesting.)
2763 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2765 % And now expand that command.
2766 \obeylines %
2767 \doignoretext ^^M%
2771 \def\doignoreyyy#1{%
2772 \def\temp{#1}%
2773 \ifx\temp\empty % Nothing found.
2774 \let\next\doignoretextzzz
2775 \else % Found a nested condition, ...
2776 \advance\doignorecount by 1
2777 \let\next\doignoretextyyy % ..., look for another.
2778 % If we're here, #1 ends with ^^M\ifinfo (for example).
2780 \next #1% the token \_STOP_ is present just after this macro.
2783 % We have to swallow the remaining "\_STOP_".
2785 \def\doignoretextzzz#1{%
2786 \ifnum\doignorecount = 0 % We have just found the outermost @end.
2787 \let\next\enddoignore
2788 \else % Still inside a nested condition.
2789 \advance\doignorecount by -1
2790 \let\next\doignoretext % Look for the next @end.
2792 \next
2795 % Finish off ignored text.
2796 \def\enddoignore{\endgroup\ignorespaces}
2799 % @set VAR sets the variable VAR to an empty value.
2800 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2802 % Since we want to separate VAR from REST-OF-LINE (which might be
2803 % empty), we can't just use \parsearg; we have to insert a space of our
2804 % own to delimit the rest of the line, and then take it out again if we
2805 % didn't need it.
2806 % We rely on the fact that \parsearg sets \catcode`\ =10.
2808 \parseargdef\set{\setyyy#1 \endsetyyy}
2809 \def\setyyy#1 #2\endsetyyy{%
2811 \makevalueexpandable
2812 \def\temp{#2}%
2813 \edef\next{\gdef\makecsname{SET#1}}%
2814 \ifx\temp\empty
2815 \next{}%
2816 \else
2817 \setzzz#2\endsetzzz
2821 % Remove the trailing space \setxxx inserted.
2822 \def\setzzz#1 \endsetzzz{\next{#1}}
2824 % @clear VAR clears (i.e., unsets) the variable VAR.
2826 \parseargdef\clear{%
2828 \makevalueexpandable
2829 \global\expandafter\let\csname SET#1\endcsname=\relax
2833 % @value{foo} gets the text saved in variable foo.
2834 \def\value{\begingroup\makevalueexpandable\valuexxx}
2835 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2837 \catcode`\- = \active \catcode`\_ = \active
2839 \gdef\makevalueexpandable{%
2840 \let\value = \expandablevalue
2841 % We don't want these characters active, ...
2842 \catcode`\-=\other \catcode`\_=\other
2843 % ..., but we might end up with active ones in the argument if
2844 % we're called from @code, as @code{@value{foo-bar_}}, though.
2845 % So \let them to their normal equivalents.
2846 \let-\realdash \let_\normalunderscore
2850 % We have this subroutine so that we can handle at least some @value's
2851 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2852 % The command has to be fully expandable (if the variable is set), since
2853 % the result winds up in the index file. This means that if the
2854 % variable's value contains other Texinfo commands, it's almost certain
2855 % it will fail (although perhaps we could fix that with sufficient work
2856 % to do a one-level expansion on the result, instead of complete).
2858 \def\expandablevalue#1{%
2859 \expandafter\ifx\csname SET#1\endcsname\relax
2860 {[No value for ``#1'']}%
2861 \message{Variable `#1', used in @value, is not set.}%
2862 \else
2863 \csname SET#1\endcsname
2867 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2868 % with @set.
2870 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2872 \makecond{ifset}
2873 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2874 \def\doifset#1#2{%
2876 \makevalueexpandable
2877 \let\next=\empty
2878 \expandafter\ifx\csname SET#2\endcsname\relax
2879 #1% If not set, redefine \next.
2881 \expandafter
2882 }\next
2884 \def\ifsetfail{\doignore{ifset}}
2886 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2887 % defined with @set, or has been undefined with @clear.
2889 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2890 % above code: if the variable is not set, do nothing, if it is set,
2891 % then redefine \next to \ifclearfail.
2893 \makecond{ifclear}
2894 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2895 \def\ifclearfail{\doignore{ifclear}}
2897 % @dircategory CATEGORY -- specify a category of the dir file
2898 % which this file should belong to. Ignore this in TeX.
2899 \let\dircategory=\comment
2901 % @defininfoenclose.
2902 \let\definfoenclose=\comment
2905 \message{indexing,}
2906 % Index generation facilities
2908 % Define \newwrite to be identical to plain tex's \newwrite
2909 % except not \outer, so it can be used within \newindex.
2910 {\catcode`\@=11
2911 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2913 % \newindex {foo} defines an index named foo.
2914 % It automatically defines \fooindex such that
2915 % \fooindex ...rest of line... puts an entry in the index foo.
2916 % It also defines \fooindfile to be the number of the output channel for
2917 % the file that accumulates this index. The file's extension is foo.
2918 % The name of an index should be no more than 2 characters long
2919 % for the sake of vms.
2921 \def\newindex#1{%
2922 \iflinks
2923 \expandafter\newwrite \csname#1indfile\endcsname
2924 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
2926 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2927 \noexpand\doindex{#1}}
2930 % @defindex foo == \newindex{foo}
2932 \def\defindex{\parsearg\newindex}
2934 % Define @defcodeindex, like @defindex except put all entries in @code.
2936 \def\defcodeindex{\parsearg\newcodeindex}
2938 \def\newcodeindex#1{%
2939 \iflinks
2940 \expandafter\newwrite \csname#1indfile\endcsname
2941 \openout \csname#1indfile\endcsname \jobname.#1
2943 \expandafter\xdef\csname#1index\endcsname{%
2944 \noexpand\docodeindex{#1}}%
2948 % @synindex foo bar makes index foo feed into index bar.
2949 % Do this instead of @defindex foo if you don't want it as a separate index.
2951 % @syncodeindex foo bar similar, but put all entries made for index foo
2952 % inside @code.
2954 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2955 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2957 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2958 % #3 the target index (bar).
2959 \def\dosynindex#1#2#3{%
2960 % Only do \closeout if we haven't already done it, else we'll end up
2961 % closing the target index.
2962 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
2963 % The \closeout helps reduce unnecessary open files; the limit on the
2964 % Acorn RISC OS is a mere 16 files.
2965 \expandafter\closeout\csname#2indfile\endcsname
2966 \expandafter\let\csname\donesynindex#2\endcsname = 1
2968 % redefine \fooindfile:
2969 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
2970 \expandafter\let\csname#2indfile\endcsname=\temp
2971 % redefine \fooindex:
2972 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2975 % Define \doindex, the driver for all \fooindex macros.
2976 % Argument #1 is generated by the calling \fooindex macro,
2977 % and it is "foo", the name of the index.
2979 % \doindex just uses \parsearg; it calls \doind for the actual work.
2980 % This is because \doind is more useful to call from other macros.
2982 % There is also \dosubind {index}{topic}{subtopic}
2983 % which makes an entry in a two-level index such as the operation index.
2985 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
2986 \def\singleindexer #1{\doind{\indexname}{#1}}
2988 % like the previous two, but they put @code around the argument.
2989 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2990 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2992 % Take care of Texinfo commands that can appear in an index entry.
2993 % Since there are some commands we want to expand, and others we don't,
2994 % we have to laboriously prevent expansion for those that we don't.
2996 \def\indexdummies{%
2997 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2998 \def\ {\realbackslash\space }%
2999 % Need these in case \tex is in effect and \{ is a \delimiter again.
3000 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3001 % braces and backslashes are used only as delimiters.
3002 \let\{ = \mylbrace
3003 \let\} = \myrbrace
3005 % \definedummyword defines \#1 as \realbackslash #1\space, thus
3006 % effectively preventing its expansion. This is used only for control
3007 % words, not control letters, because the \space would be incorrect
3008 % for control characters, but is needed to separate the control word
3009 % from whatever follows.
3011 % For control letters, we have \definedummyletter, which omits the
3012 % space.
3014 % These can be used both for control words that take an argument and
3015 % those that do not. If it is followed by {arg} in the input, then
3016 % that will dutifully get written to the index (or wherever).
3018 \def\definedummyword##1{%
3019 \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}%
3021 \def\definedummyletter##1{%
3022 \expandafter\def\csname ##1\endcsname{\realbackslash ##1}%
3025 % Do the redefinitions.
3026 \commondummies
3029 % For the aux file, @ is the escape character. So we want to redefine
3030 % everything using @ instead of \realbackslash. When everything uses
3031 % @, this will be simpler.
3033 \def\atdummies{%
3034 \def\@{@@}%
3035 \def\ {@ }%
3036 \let\{ = \lbraceatcmd
3037 \let\} = \rbraceatcmd
3039 % (See comments in \indexdummies.)
3040 \def\definedummyword##1{%
3041 \expandafter\def\csname ##1\endcsname{@##1\space}%
3043 \def\definedummyletter##1{%
3044 \expandafter\def\csname ##1\endcsname{@##1}%
3047 % Do the redefinitions.
3048 \commondummies
3051 % Called from \indexdummies and \atdummies. \definedummyword and
3052 % \definedummyletter must be defined first.
3054 \def\commondummies{%
3056 \normalturnoffactive
3058 \commondummiesnofonts
3060 \definedummyletter{_}%
3062 % Non-English letters.
3063 \definedummyword{AA}%
3064 \definedummyword{AE}%
3065 \definedummyword{L}%
3066 \definedummyword{OE}%
3067 \definedummyword{O}%
3068 \definedummyword{aa}%
3069 \definedummyword{ae}%
3070 \definedummyword{l}%
3071 \definedummyword{oe}%
3072 \definedummyword{o}%
3073 \definedummyword{ss}%
3074 \definedummyword{exclamdown}%
3075 \definedummyword{questiondown}%
3076 \definedummyword{ordm}%
3077 \definedummyword{ordf}%
3079 % Although these internal commands shouldn't show up, sometimes they do.
3080 \definedummyword{bf}%
3081 \definedummyword{gtr}%
3082 \definedummyword{hat}%
3083 \definedummyword{less}%
3084 \definedummyword{sf}%
3085 \definedummyword{sl}%
3086 \definedummyword{tclose}%
3087 \definedummyword{tt}%
3089 \definedummyword{LaTeX}%
3090 \definedummyword{TeX}%
3091 \definedummyword{dots}%
3093 % Assorted special characters.
3094 \definedummyword{bullet}%
3095 \definedummyword{copyright}%
3096 \definedummyword{registeredsymbol}%
3097 \definedummyword{dots}%
3098 \definedummyword{enddots}%
3099 \definedummyword{equiv}%
3100 \definedummyword{error}%
3101 \definedummyword{expansion}%
3102 \definedummyword{minus}%
3103 \definedummyword{pounds}%
3104 \definedummyword{point}%
3105 \definedummyword{print}%
3106 \definedummyword{result}%
3108 % Handle some cases of @value -- where it does not contain any
3109 % (non-fully-expandable) commands.
3110 \makevalueexpandable
3112 % Normal spaces, not active ones.
3113 \unsepspaces
3115 % No macro expansion.
3116 \turnoffmacros
3119 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3121 % Better have this without active chars.
3123 \catcode`\~=\other
3124 \gdef\commondummiesnofonts{%
3125 % Control letters and accents.
3126 \definedummyletter{,}%
3127 \definedummyletter{"}%
3128 \definedummyletter{`}%
3129 \definedummyletter{'}%
3130 \definedummyletter{^}%
3131 \definedummyletter{~}%
3132 \definedummyletter{=}%
3133 \definedummyword{u}%
3134 \definedummyword{v}%
3135 \definedummyword{H}%
3136 \definedummyword{dotaccent}%
3137 \definedummyword{ringaccent}%
3138 \definedummyword{tieaccent}%
3139 \definedummyword{ubaraccent}%
3140 \definedummyword{udotaccent}%
3141 \definedummyword{dotless}%
3143 % Texinfo font commands.
3144 \definedummyword{b}%
3145 \definedummyword{i}%
3146 \definedummyword{r}%
3147 \definedummyword{sc}%
3148 \definedummyword{t}%
3150 \definedummyword{acronym}%
3151 \definedummyword{cite}%
3152 \definedummyword{code}%
3153 \definedummyword{command}%
3154 \definedummyword{dfn}%
3155 \definedummyword{emph}%
3156 \definedummyword{env}%
3157 \definedummyword{file}%
3158 \definedummyword{kbd}%
3159 \definedummyword{key}%
3160 \definedummyword{math}%
3161 \definedummyword{option}%
3162 \definedummyword{samp}%
3163 \definedummyword{strong}%
3164 \definedummyword{uref}%
3165 \definedummyword{url}%
3166 \definedummyword{var}%
3167 \definedummyword{verb}%
3168 \definedummyword{w}%
3172 % \indexnofonts is used when outputting the strings to sort the index
3173 % by, and when constructing control sequence names. It eliminates all
3174 % control sequences and just writes whatever the best ASCII sort string
3175 % would be for a given command (usually its argument).
3177 \def\indexnofonts{%
3178 \def\definedummyword##1{%
3179 \expandafter\let\csname ##1\endcsname\asis
3181 \let\definedummyletter=\definedummyword
3183 \commondummiesnofonts
3185 % Don't no-op \tt, since it isn't a user-level command
3186 % and is used in the definitions of the active chars like <, >, |, etc.
3187 % Likewise with the other plain tex font commands.
3188 %\let\tt=\asis
3190 \def\ { }%
3191 \def\@{@}%
3192 % how to handle braces?
3193 \def\_{\normalunderscore}%
3195 % Non-English letters.
3196 \def\AA{AA}%
3197 \def\AE{AE}%
3198 \def\L{L}%
3199 \def\OE{OE}%
3200 \def\O{O}%
3201 \def\aa{aa}%
3202 \def\ae{ae}%
3203 \def\l{l}%
3204 \def\oe{oe}%
3205 \def\o{o}%
3206 \def\ss{ss}%
3207 \def\exclamdown{!}%
3208 \def\questiondown{?}%
3209 \def\ordf{a}%
3210 \def\ordm{o}%
3212 \def\LaTeX{LaTeX}%
3213 \def\TeX{TeX}%
3214 \def\dots{...}%
3217 \let\indexbackslash=0 %overridden during \printindex.
3218 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3220 % Most index entries go through here, but \dosubind is the general case.
3221 % #1 is the index name, #2 is the entry text.
3222 \def\doind#1#2{\dosubind{#1}{#2}{}}
3224 % Workhorse for all \fooindexes.
3225 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3226 % empty if called from \doind, as we usually are (the main exception
3227 % is with most defuns, which call us directly).
3229 \def\dosubind#1#2#3{%
3230 \iflinks
3232 % Store the main index entry text (including the third arg).
3233 \toks0 = {#2}%
3234 % If third arg is present, precede it with a space.
3235 \def\thirdarg{#3}%
3236 \ifx\thirdarg\empty \else
3237 \toks0 = \expandafter{\the\toks0 \space #3}%
3240 \edef\writeto{\csname#1indfile\endcsname}%
3242 \ifvmode
3243 \dosubindsanitize
3244 \else
3245 \dosubindwrite
3251 % Write the entry in \toks0 to the index file:
3253 \def\dosubindwrite{%
3254 % Put the index entry in the margin if desired.
3255 \ifx\SETmarginindex\relax\else
3256 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3259 % Remember, we are within a group.
3260 \indexdummies % Must do this here, since \bf, etc expand at this stage
3261 \escapechar=`\\
3262 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3263 % so it will be output as is; and it will print as backslash.
3265 % Process the index entry with all font commands turned off, to
3266 % get the string to sort by.
3267 {\indexnofonts
3268 \edef\temp{\the\toks0}% need full expansion
3269 \xdef\indexsorttmp{\temp}%
3272 % Set up the complete index entry, with both the sort key and
3273 % the original text, including any font commands. We write
3274 % three arguments to \entry to the .?? file (four in the
3275 % subentry case), texindex reduces to two when writing the .??s
3276 % sorted result.
3277 \edef\temp{%
3278 \write\writeto{%
3279 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3281 \temp
3284 % Take care of unwanted page breaks:
3286 % If a skip is the last thing on the list now, preserve it
3287 % by backing up by \lastskip, doing the \write, then inserting
3288 % the skip again. Otherwise, the whatsit generated by the
3289 % \write will make \lastskip zero. The result is that sequences
3290 % like this:
3291 % @end defun
3292 % @tindex whatever
3293 % @defun ...
3294 % will have extra space inserted, because the \medbreak in the
3295 % start of the @defun won't see the skip inserted by the @end of
3296 % the previous defun.
3298 % But don't do any of this if we're not in vertical mode. We
3299 % don't want to do a \vskip and prematurely end a paragraph.
3301 % Avoid page breaks due to these extra skips, too.
3303 % But wait, there is a catch there:
3304 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3305 % sufficient for this purpose, as it ignores stretch and shrink parts
3306 % of the skip. The only way seems to be to check the textual
3307 % representation of the skip.
3309 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3310 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3312 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3314 % ..., ready, GO:
3316 \def\dosubindsanitize{%
3317 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3318 \skip0 = \lastskip
3319 \edef\lastskipmacro{\the\lastskip}%
3320 \count255 = \lastpenalty
3322 % If \lastskip is nonzero, that means the last item was a
3323 % skip. And since a skip is discardable, that means this
3324 % -\skip0 glue we're inserting is preceded by a
3325 % non-discardable item, therefore it is not a potential
3326 % breakpoint, therefore no \nobreak needed.
3327 \ifx\lastskipmacro\zeroskipmacro
3328 \else
3329 \vskip-\skip0
3332 \dosubindwrite
3334 \ifx\lastskipmacro\zeroskipmacro
3335 % if \lastskip was zero, perhaps the last item was a
3336 % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3337 % In that case, we want to re-insert the penalty; since we
3338 % just inserted a non-discardable item, any following glue
3339 % (such as a \parskip) would be a breakpoint. For example:
3340 % @deffn deffn-whatever
3341 % @vindex index-whatever
3342 % Description.
3343 % would allow a break between the index-whatever whatsit
3344 % and the "Description." paragraph.
3345 \ifnum\count255>9999 \nobreak \fi
3346 \else
3347 % On the other hand, if we had a nonzero \lastskip,
3348 % this make-up glue would be preceded by a non-discardable item
3349 % (the whatsit from the \write), so we must insert a \nobreak.
3350 \nobreak\vskip\skip0
3354 % The index entry written in the file actually looks like
3355 % \entry {sortstring}{page}{topic}
3356 % or
3357 % \entry {sortstring}{page}{topic}{subtopic}
3358 % The texindex program reads in these files and writes files
3359 % containing these kinds of lines:
3360 % \initial {c}
3361 % before the first topic whose initial is c
3362 % \entry {topic}{pagelist}
3363 % for a topic that is used without subtopics
3364 % \primary {topic}
3365 % for the beginning of a topic that is used with subtopics
3366 % \secondary {subtopic}{pagelist}
3367 % for each subtopic.
3369 % Define the user-accessible indexing commands
3370 % @findex, @vindex, @kindex, @cindex.
3372 \def\findex {\fnindex}
3373 \def\kindex {\kyindex}
3374 \def\cindex {\cpindex}
3375 \def\vindex {\vrindex}
3376 \def\tindex {\tpindex}
3377 \def\pindex {\pgindex}
3379 \def\cindexsub {\begingroup\obeylines\cindexsub}
3380 {\obeylines %
3381 \gdef\cindexsub "#1" #2^^M{\endgroup %
3382 \dosubind{cp}{#2}{#1}}}
3384 % Define the macros used in formatting output of the sorted index material.
3386 % @printindex causes a particular index (the ??s file) to get printed.
3387 % It does not print any chapter heading (usually an @unnumbered).
3389 \parseargdef\printindex{\begingroup
3390 \dobreak \chapheadingskip{10000}%
3392 \smallfonts \rm
3393 \tolerance = 9500
3394 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3396 % See if the index file exists and is nonempty.
3397 % Change catcode of @ here so that if the index file contains
3398 % \initial {@}
3399 % as its first line, TeX doesn't complain about mismatched braces
3400 % (because it thinks @} is a control sequence).
3401 \catcode`\@ = 11
3402 \openin 1 \jobname.#1s
3403 \ifeof 1
3404 % \enddoublecolumns gets confused if there is no text in the index,
3405 % and it loses the chapter title and the aux file entries for the
3406 % index. The easiest way to prevent this problem is to make sure
3407 % there is some text.
3408 \putwordIndexNonexistent
3409 \else
3411 % If the index file exists but is empty, then \openin leaves \ifeof
3412 % false. We have to make TeX try to read something from the file, so
3413 % it can discover if there is anything in it.
3414 \read 1 to \temp
3415 \ifeof 1
3416 \putwordIndexIsEmpty
3417 \else
3418 % Index files are almost Texinfo source, but we use \ as the escape
3419 % character. It would be better to use @, but that's too big a change
3420 % to make right now.
3421 \def\indexbackslash{\backslashcurfont}%
3422 \catcode`\\ = 0
3423 \escapechar = `\\
3424 \begindoublecolumns
3425 \input \jobname.#1s
3426 \enddoublecolumns
3429 \closein 1
3430 \endgroup}
3432 % These macros are used by the sorted index file itself.
3433 % Change them to control the appearance of the index.
3435 \def\initial#1{{%
3436 % Some minor font changes for the special characters.
3437 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3439 % Remove any glue we may have, we'll be inserting our own.
3440 \removelastskip
3442 % We like breaks before the index initials, so insert a bonus.
3443 \penalty -300
3445 % Typeset the initial. Making this add up to a whole number of
3446 % baselineskips increases the chance of the dots lining up from column
3447 % to column. It still won't often be perfect, because of the stretch
3448 % we need before each entry, but it's better.
3450 % No shrink because it confuses \balancecolumns.
3451 \vskip 1.67\baselineskip plus .5\baselineskip
3452 \leftline{\secbf #1}%
3453 \vskip .33\baselineskip plus .1\baselineskip
3455 % Do our best not to break after the initial.
3456 \nobreak
3459 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3460 % then page number (#2) flushed to the right margin. It is used for index
3461 % and table of contents entries. The paragraph is indented by \leftskip.
3463 % A straigtforward implementation would start like this:
3464 % \def\entry#1#2{...
3465 % But this frozes the catcodes in the argument, and can cause problems to
3466 % @code, which set's active ``-''. This problem was fixed by a kludge---
3467 % ``-'' was active throughout whole index, but this isn't what we really
3468 % want.
3469 % The right solution is to prevent \entry from swallowing the whole text.
3470 % --kasal, 21nov03
3471 \def\entry{%
3472 \begingroup
3474 % Start a new paragraph if necessary, so our assignments below can't
3475 % affect previous text.
3476 \par
3478 % Do not fill out the last line with white space.
3479 \parfillskip = 0in
3481 % No extra space above this paragraph.
3482 \parskip = 0in
3484 % Do not prefer a separate line ending with a hyphen to fewer lines.
3485 \finalhyphendemerits = 0
3487 % \hangindent is only relevant when the entry text and page number
3488 % don't both fit on one line. In that case, bob suggests starting the
3489 % dots pretty far over on the line. Unfortunately, a large
3490 % indentation looks wrong when the entry text itself is broken across
3491 % lines. So we use a small indentation and put up with long leaders.
3493 % \hangafter is reset to 1 (which is the value we want) at the start
3494 % of each paragraph, so we need not do anything with that.
3495 \hangindent = 2em
3497 % When the entry text needs to be broken, just fill out the first line
3498 % with blank space.
3499 \rightskip = 0pt plus1fil
3501 % A bit of stretch before each entry for the benefit of balancing
3502 % columns.
3503 \vskip 0pt plus1pt
3505 % Swallow the left brace of the text (first parameter):
3506 \afterassignment\doentry
3507 \let\temp =
3509 \def\doentry{%
3510 \bgroup % Instead of the swallowed brace.
3511 \noindent
3512 \aftergroup\finishentry
3513 % And now comes the text of the entry.
3515 \def\finishentry#1{%
3516 % #1 is the page number.
3518 % The following is kludged to not output a line of dots in the index if
3519 % there are no page numbers. The next person who breaks this will be
3520 % cursed by a Unix daemon.
3521 \def\tempa{{\rm }}%
3522 \def\tempb{#1}%
3523 \edef\tempc{\tempa}%
3524 \edef\tempd{\tempb}%
3525 \ifx\tempc\tempd
3527 \else
3529 % If we must, put the page number on a line of its own, and fill out
3530 % this line with blank space. (The \hfil is overwhelmed with the
3531 % fill leaders glue in \indexdotfill if the page number does fit.)
3532 \hfil\penalty50
3533 \null\nobreak\indexdotfill % Have leaders before the page number.
3535 % The `\ ' here is removed by the implicit \unskip that TeX does as
3536 % part of (the primitive) \par. Without it, a spurious underfull
3537 % \hbox ensues.
3538 \ifpdf
3539 \pdfgettoks#1.\ \the\toksA
3540 \else
3541 \ #1%
3544 \par
3545 \endgroup
3548 % Like \dotfill except takes at least 1 em.
3549 \def\indexdotfill{\cleaders
3550 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3552 \def\primary #1{\line{#1\hfil}}
3554 \newskip\secondaryindent \secondaryindent=0.5cm
3555 \def\secondary#1#2{{%
3556 \parfillskip=0in
3557 \parskip=0in
3558 \hangindent=1in
3559 \hangafter=1
3560 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3561 \ifpdf
3562 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3563 \else
3566 \par
3569 % Define two-column mode, which we use to typeset indexes.
3570 % Adapted from the TeXbook, page 416, which is to say,
3571 % the manmac.tex format used to print the TeXbook itself.
3572 \catcode`\@=11
3574 \newbox\partialpage
3575 \newdimen\doublecolumnhsize
3577 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3578 % Grab any single-column material above us.
3579 \output = {%
3581 % Here is a possibility not foreseen in manmac: if we accumulate a
3582 % whole lot of material, we might end up calling this \output
3583 % routine twice in a row (see the doublecol-lose test, which is
3584 % essentially a couple of indexes with @setchapternewpage off). In
3585 % that case we just ship out what is in \partialpage with the normal
3586 % output routine. Generally, \partialpage will be empty when this
3587 % runs and this will be a no-op. See the indexspread.tex test case.
3588 \ifvoid\partialpage \else
3589 \onepageout{\pagecontents\partialpage}%
3592 \global\setbox\partialpage = \vbox{%
3593 % Unvbox the main output page.
3594 \unvbox\PAGE
3595 \kern-\topskip \kern\baselineskip
3598 \eject % run that output routine to set \partialpage
3600 % Use the double-column output routine for subsequent pages.
3601 \output = {\doublecolumnout}%
3603 % Change the page size parameters. We could do this once outside this
3604 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3605 % format, but then we repeat the same computation. Repeating a couple
3606 % of assignments once per index is clearly meaningless for the
3607 % execution time, so we may as well do it in one place.
3609 % First we halve the line length, less a little for the gutter between
3610 % the columns. We compute the gutter based on the line length, so it
3611 % changes automatically with the paper format. The magic constant
3612 % below is chosen so that the gutter has the same value (well, +-<1pt)
3613 % as it did when we hard-coded it.
3615 % We put the result in a separate register, \doublecolumhsize, so we
3616 % can restore it in \pagesofar, after \hsize itself has (potentially)
3617 % been clobbered.
3619 \doublecolumnhsize = \hsize
3620 \advance\doublecolumnhsize by -.04154\hsize
3621 \divide\doublecolumnhsize by 2
3622 \hsize = \doublecolumnhsize
3624 % Double the \vsize as well. (We don't need a separate register here,
3625 % since nobody clobbers \vsize.)
3626 \vsize = 2\vsize
3629 % The double-column output routine for all double-column pages except
3630 % the last.
3632 \def\doublecolumnout{%
3633 \splittopskip=\topskip \splitmaxdepth=\maxdepth
3634 % Get the available space for the double columns -- the normal
3635 % (undoubled) page height minus any material left over from the
3636 % previous page.
3637 \dimen@ = \vsize
3638 \divide\dimen@ by 2
3639 \advance\dimen@ by -\ht\partialpage
3641 % box0 will be the left-hand column, box2 the right.
3642 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3643 \onepageout\pagesofar
3644 \unvbox255
3645 \penalty\outputpenalty
3648 % Re-output the contents of the output page -- any previous material,
3649 % followed by the two boxes we just split, in box0 and box2.
3650 \def\pagesofar{%
3651 \unvbox\partialpage
3653 \hsize = \doublecolumnhsize
3654 \wd0=\hsize \wd2=\hsize
3655 \hbox to\pagewidth{\box0\hfil\box2}%
3658 % All done with double columns.
3659 \def\enddoublecolumns{%
3660 \output = {%
3661 % Split the last of the double-column material. Leave it on the
3662 % current page, no automatic page break.
3663 \balancecolumns
3665 % If we end up splitting too much material for the current page,
3666 % though, there will be another page break right after this \output
3667 % invocation ends. Having called \balancecolumns once, we do not
3668 % want to call it again. Therefore, reset \output to its normal
3669 % definition right away. (We hope \balancecolumns will never be
3670 % called on to balance too much material, but if it is, this makes
3671 % the output somewhat more palatable.)
3672 \global\output = {\onepageout{\pagecontents\PAGE}}%
3674 \eject
3675 \endgroup % started in \begindoublecolumns
3677 % \pagegoal was set to the doubled \vsize above, since we restarted
3678 % the current page. We're now back to normal single-column
3679 % typesetting, so reset \pagegoal to the normal \vsize (after the
3680 % \endgroup where \vsize got restored).
3681 \pagegoal = \vsize
3684 % Called at the end of the double column material.
3685 \def\balancecolumns{%
3686 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3687 \dimen@ = \ht0
3688 \advance\dimen@ by \topskip
3689 \advance\dimen@ by-\baselineskip
3690 \divide\dimen@ by 2 % target to split to
3691 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3692 \splittopskip = \topskip
3693 % Loop until we get a decent breakpoint.
3695 \vbadness = 10000
3696 \loop
3697 \global\setbox3 = \copy0
3698 \global\setbox1 = \vsplit3 to \dimen@
3699 \ifdim\ht3>\dimen@
3700 \global\advance\dimen@ by 1pt
3701 \repeat
3703 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3704 \setbox0=\vbox to\dimen@{\unvbox1}%
3705 \setbox2=\vbox to\dimen@{\unvbox3}%
3707 \pagesofar
3709 \catcode`\@ = \other
3712 \message{sectioning,}
3713 % Chapters, sections, etc.
3715 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3716 % sections so that we can refer to them unambiguously in the pdf
3717 % outlines by their "section number". We avoid collisions with chapter
3718 % numbers by starting them at 10000. (If a document ever has 10000
3719 % chapters, we're in trouble anyway, I'm sure.)
3720 \newcount\unnumberedno \unnumberedno = 10000
3721 \newcount\chapno
3722 \newcount\secno \secno=0
3723 \newcount\subsecno \subsecno=0
3724 \newcount\subsubsecno \subsubsecno=0
3726 % This counter is funny since it counts through charcodes of letters A, B, ...
3727 \newcount\appendixno \appendixno = `\@
3729 % \def\appendixletter{\char\the\appendixno}
3730 % We do the following ugly conditional instead of the above simple
3731 % construct for the sake of pdftex, which needs the actual
3732 % letter in the expansion, not just typeset.
3734 \def\appendixletter{%
3735 \ifnum\appendixno=`A A%
3736 \else\ifnum\appendixno=`B B%
3737 \else\ifnum\appendixno=`C C%
3738 \else\ifnum\appendixno=`D D%
3739 \else\ifnum\appendixno=`E E%
3740 \else\ifnum\appendixno=`F F%
3741 \else\ifnum\appendixno=`G G%
3742 \else\ifnum\appendixno=`H H%
3743 \else\ifnum\appendixno=`I I%
3744 \else\ifnum\appendixno=`J J%
3745 \else\ifnum\appendixno=`K K%
3746 \else\ifnum\appendixno=`L L%
3747 \else\ifnum\appendixno=`M M%
3748 \else\ifnum\appendixno=`N N%
3749 \else\ifnum\appendixno=`O O%
3750 \else\ifnum\appendixno=`P P%
3751 \else\ifnum\appendixno=`Q Q%
3752 \else\ifnum\appendixno=`R R%
3753 \else\ifnum\appendixno=`S S%
3754 \else\ifnum\appendixno=`T T%
3755 \else\ifnum\appendixno=`U U%
3756 \else\ifnum\appendixno=`V V%
3757 \else\ifnum\appendixno=`W W%
3758 \else\ifnum\appendixno=`X X%
3759 \else\ifnum\appendixno=`Y Y%
3760 \else\ifnum\appendixno=`Z Z%
3761 % The \the is necessary, despite appearances, because \appendixletter is
3762 % expanded while writing the .toc file. \char\appendixno is not
3763 % expandable, thus it is written literally, thus all appendixes come out
3764 % with the same letter (or @) in the toc without it.
3765 \else\char\the\appendixno
3766 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3767 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3769 % Each @chapter defines this as the name of the chapter.
3770 % page headings and footings can use it. @section does likewise.
3771 % However, they are not reliable, because we don't use marks.
3772 \def\thischapter{}
3773 \def\thissection{}
3775 \newcount\absseclevel % used to calculate proper heading level
3776 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3778 % @raisesections: treat @section as chapter, @subsection as section, etc.
3779 \def\raisesections{\global\advance\secbase by -1}
3780 \let\up=\raisesections % original BFox name
3782 % @lowersections: treat @chapter as section, @section as subsection, etc.
3783 \def\lowersections{\global\advance\secbase by 1}
3784 \let\down=\lowersections % original BFox name
3786 % Choose a numbered-heading macro
3787 % #1 is heading level if unmodified by @raisesections or @lowersections
3788 % #2 is text for heading
3789 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3790 \ifcase\absseclevel
3791 \chapterzzz{#2}%
3792 \or \seczzz{#2}%
3793 \or \numberedsubseczzz{#2}%
3794 \or \numberedsubsubseczzz{#2}%
3795 \else
3796 \ifnum \absseclevel<0 \chapterzzz{#2}%
3797 \else \numberedsubsubseczzz{#2}%
3800 \suppressfirstparagraphindent
3803 % like \numhead, but chooses appendix heading levels
3804 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3805 \ifcase\absseclevel
3806 \appendixzzz{#2}%
3807 \or \appendixsectionzzz{#2}%
3808 \or \appendixsubseczzz{#2}%
3809 \or \appendixsubsubseczzz{#2}%
3810 \else
3811 \ifnum \absseclevel<0 \appendixzzz{#2}%
3812 \else \appendixsubsubseczzz{#2}%
3815 \suppressfirstparagraphindent
3818 % like \numhead, but chooses numberless heading levels
3819 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
3820 \ifcase\absseclevel
3821 \unnumberedzzz{#2}%
3822 \or \unnumberedseczzz{#2}%
3823 \or \unnumberedsubseczzz{#2}%
3824 \or \unnumberedsubsubseczzz{#2}%
3825 \else
3826 \ifnum \absseclevel<0 \unnumberedzzz{#2}%
3827 \else \unnumberedsubsubseczzz{#2}%
3830 \suppressfirstparagraphindent
3833 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
3834 % all lower-level sectioning counters to zero.
3836 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3837 % (e.g., figures), q.v. By default (before any chapter), that is empty.
3838 \let\chaplevelprefix = \empty
3840 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3841 \def\chapterzzz#1{%
3842 % section resetting is \global in case the chapter is in a group, such
3843 % as an @include file.
3844 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3845 \global\advance\chapno by 1
3847 % Used for \float.
3848 \gdef\chaplevelprefix{\the\chapno.}%
3849 \resetallfloatnos
3851 \message{\putwordChapter\space \the\chapno}%
3853 % Write the actual heading.
3854 \chapmacro{#1}{Ynumbered}{\the\chapno}%
3856 % So @section and the like are numbered underneath this chapter.
3857 \global\let\section = \numberedsec
3858 \global\let\subsection = \numberedsubsec
3859 \global\let\subsubsection = \numberedsubsubsec
3862 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3863 \def\appendixzzz#1{%
3864 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3865 \global\advance\appendixno by 1
3866 \gdef\chaplevelprefix{\appendixletter.}%
3867 \resetallfloatnos
3869 \def\appendixnum{\putwordAppendix\space \appendixletter}%
3870 \message{\appendixnum}%
3872 \chapmacro{#1}{Yappendix}{\appendixletter}%
3874 \global\let\section = \appendixsec
3875 \global\let\subsection = \appendixsubsec
3876 \global\let\subsubsection = \appendixsubsubsec
3879 % @centerchap is like @unnumbered, but the heading is centered.
3880 \outer\parseargdef\centerchap{{\unnumberedyyy{#1}}}
3882 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3883 \def\unnumberedzzz#1{%
3884 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3885 \global\advance\unnumberedno by 1
3887 % Since an unnumbered has no number, no prefix for figures.
3888 \global\let\chaplevelprefix = \empty
3889 \resetallfloatnos
3891 % This used to be simply \message{#1}, but TeX fully expands the
3892 % argument to \message. Therefore, if #1 contained @-commands, TeX
3893 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3894 % expanded @cite (which turns out to cause errors because \cite is meant
3895 % to be executed, not expanded).
3897 % Anyway, we don't want the fully-expanded definition of @cite to appear
3898 % as a result of the \message, we just want `@cite' itself. We use
3899 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3900 % simply yielding the contents of <toks register>. (We also do this for
3901 % the toc entries.)
3902 \toks0 = {#1}%
3903 \message{(\the\toks0)}%
3905 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
3907 \global\let\section = \unnumberedsec
3908 \global\let\subsection = \unnumberedsubsec
3909 \global\let\subsubsection = \unnumberedsubsubsec
3912 % @top is like @unnumbered.
3913 \let\top\unnumbered
3915 % Sections.
3916 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
3917 \def\seczzz#1{%
3918 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3919 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3922 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
3923 \def\appendixsectionzzz#1{%
3924 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3925 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3927 \let\appendixsec\appendixsection
3929 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
3930 \def\unnumberedseczzz#1{%
3931 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3932 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3935 % Subsections.
3936 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
3937 \def\numberedsubseczzz#1{%
3938 \global\subsubsecno=0 \global\advance\subsecno by 1
3939 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3942 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
3943 \def\appendixsubseczzz#1{%
3944 \global\subsubsecno=0 \global\advance\subsecno by 1
3945 \sectionheading{#1}{subsec}{Yappendix}%
3946 {\appendixletter.\the\secno.\the\subsecno}%
3949 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3950 \def\unnumberedsubseczzz#1{%
3951 \global\subsubsecno=0 \global\advance\subsecno by 1
3952 \sectionheading{#1}{subsec}{Ynothing}%
3953 {\the\unnumberedno.\the\secno.\the\subsecno}%
3956 % Subsubsections.
3957 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
3958 \def\numberedsubsubseczzz#1{%
3959 \global\advance\subsubsecno by 1
3960 \sectionheading{#1}{subsubsec}{Ynumbered}%
3961 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
3964 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
3965 \def\appendixsubsubseczzz#1{%
3966 \global\advance\subsubsecno by 1
3967 \sectionheading{#1}{subsubsec}{Yappendix}%
3968 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
3971 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3972 \def\unnumberedsubsubseczzz#1{%
3973 \global\advance\subsubsecno by 1
3974 \sectionheading{#1}{subsubsec}{Ynothing}%
3975 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
3978 % These are variants which are not "outer", so they can appear in @ifinfo.
3979 % Actually, they are now be obsolete; ordinary section commands should work.
3980 \def\infotop{\parsearg\unnumberedzzz}
3981 \def\infounnumbered{\parsearg\unnumberedzzz}
3982 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3983 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3984 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3986 \def\infoappendix{\parsearg\appendixzzz}
3987 \def\infoappendixsec{\parsearg\appendixseczzz}
3988 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3989 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3991 \def\infochapter{\parsearg\chapterzzz}
3992 \def\infosection{\parsearg\sectionzzz}
3993 \def\infosubsection{\parsearg\subsectionzzz}
3994 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3996 % These macros control what the section commands do, according
3997 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3998 % Define them by default for a numbered chapter.
3999 \let\section = \numberedsec
4000 \let\subsection = \numberedsubsec
4001 \let\subsubsection = \numberedsubsubsec
4003 % Define @majorheading, @heading and @subheading
4005 % NOTE on use of \vbox for chapter headings, section headings, and such:
4006 % 1) We use \vbox rather than the earlier \line to permit
4007 % overlong headings to fold.
4008 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4009 % heading is obnoxious; this forbids it.
4010 % 3) Likewise, headings look best if no \parindent is used, and
4011 % if justification is not attempted. Hence \raggedright.
4014 \def\majorheading{%
4015 {\advance\chapheadingskip by 10pt \chapbreak }%
4016 \parsearg\chapheadingzzz
4019 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4020 \def\chapheadingzzz#1{%
4021 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4022 \parindent=0pt\raggedright
4023 \rm #1\hfill}}%
4024 \bigskip \par\penalty 200\relax
4025 \suppressfirstparagraphindent
4028 % @heading, @subheading, @subsubheading.
4029 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4030 \suppressfirstparagraphindent}
4031 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4032 \suppressfirstparagraphindent}
4033 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4034 \suppressfirstparagraphindent}
4036 % These macros generate a chapter, section, etc. heading only
4037 % (including whitespace, linebreaking, etc. around it),
4038 % given all the information in convenient, parsed form.
4040 %%% Args are the skip and penalty (usually negative)
4041 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4043 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4045 %%% Define plain chapter starts, and page on/off switching for it
4046 % Parameter controlling skip before chapter headings (if needed)
4048 \newskip\chapheadingskip
4050 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4051 \def\chappager{\par\vfill\supereject}
4052 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4054 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4056 \def\CHAPPAGoff{%
4057 \global\let\contentsalignmacro = \chappager
4058 \global\let\pchapsepmacro=\chapbreak
4059 \global\let\pagealignmacro=\chappager}
4061 \def\CHAPPAGon{%
4062 \global\let\contentsalignmacro = \chappager
4063 \global\let\pchapsepmacro=\chappager
4064 \global\let\pagealignmacro=\chappager
4065 \global\def\HEADINGSon{\HEADINGSsingle}}
4067 \def\CHAPPAGodd{%
4068 \global\let\contentsalignmacro = \chapoddpage
4069 \global\let\pchapsepmacro=\chapoddpage
4070 \global\let\pagealignmacro=\chapoddpage
4071 \global\def\HEADINGSon{\HEADINGSdouble}}
4073 \CHAPPAGon
4075 \def\CHAPFplain{%
4076 \global\let\chapmacro=\chfplain
4077 \global\let\centerchapmacro=\centerchfplain}
4079 % Normal chapter opening.
4081 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4082 % Yappendix, Yomitfromtoc), #3 the chapter number.
4084 % To test against our argument.
4085 \def\Ynothingkeyword{Ynothing}
4086 \def\Yomitfromtockeyword{Yomitfromtoc}
4087 \def\Yappendixkeyword{Yappendix}
4089 \def\chfplain#1#2#3{%
4090 \pchapsepmacro
4092 \chapfonts \rm
4094 % Have to define \thissection before calling \donoderef, because the
4095 % xref code eventually uses it. On the other hand, it has to be called
4096 % after \pchapsepmacro, or the headline will change too soon.
4097 \gdef\thissection{#1}%
4098 \gdef\thischaptername{#1}%
4100 % Only insert the separating space if we have a chapter/appendix
4101 % number, and don't print the unnumbered ``number''.
4102 \def\temptype{#2}%
4103 \ifx\temptype\Ynothingkeyword
4104 \setbox0 = \hbox{}%
4105 \def\toctype{unnchap}%
4106 \def\thischapter{#1}%
4107 \else\ifx\temptype\Yomitfromtockeyword
4108 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4109 \def\toctype{omit}%
4110 \xdef\thischapter{}%
4111 \else\ifx\temptype\Yappendixkeyword
4112 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4113 \def\toctype{app}%
4114 % We don't substitute the actual chapter name into \thischapter
4115 % because we don't want its macros evaluated now. And we don't
4116 % use \thissection because that changes with each section.
4118 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4119 \noexpand\thischaptername}%
4120 \else
4121 \setbox0 = \hbox{#3\enspace}%
4122 \def\toctype{numchap}%
4123 \xdef\thischapter{\putwordChapter{} \the\chapno:
4124 \noexpand\thischaptername}%
4125 \fi\fi\fi
4127 % Write the toc entry for this chapter. Must come before the
4128 % \donoderef, because we include the current node name in the toc
4129 % entry, and \donoderef resets it to empty.
4130 \writetocentry{\toctype}{#1}{#3}%
4132 % For pdftex, we have to write out the node definition (aka, make
4133 % the pdfdest) after any page break, but before the actual text has
4134 % been typeset. If the destination for the pdf outline is after the
4135 % text, then jumping from the outline may wind up with the text not
4136 % being visible, for instance under high magnification.
4137 \donoderef{#2}%
4139 % Typeset the actual heading.
4140 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4141 \hangindent=\wd0 \centerparametersmaybe
4142 \unhbox0 #1\par}%
4144 \nobreak\bigskip % no page break after a chapter title
4145 \nobreak
4148 % @centerchap -- centered and unnumbered.
4149 \let\centerparametersmaybe = \relax
4150 \def\centerchfplain#1{{%
4151 \def\centerparametersmaybe{%
4152 \advance\rightskip by 3\rightskip
4153 \leftskip = \rightskip
4154 \parfillskip = 0pt
4156 \chfplain{#1}{Ynothing}{}%
4159 \CHAPFplain % The default
4161 % I don't think this chapter style is supported any more, so I'm not
4162 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4164 \def\unnchfopen #1{%
4165 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4166 \parindent=0pt\raggedright
4167 \rm #1\hfill}}\bigskip \par\nobreak
4170 \def\chfopen #1#2{\chapoddpage {\chapfonts
4171 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4172 \par\penalty 5000 %
4175 \def\centerchfopen #1{%
4176 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4177 \parindent=0pt
4178 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4181 \def\CHAPFopen{%
4182 \global\let\chapmacro=\chfopen
4183 \global\let\centerchapmacro=\centerchfopen}
4186 % Section titles. These macros combine the section number parts and
4187 % call the generic \sectionheading to do the printing.
4189 \newskip\secheadingskip
4190 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4192 % Subsection titles.
4193 \newskip\subsecheadingskip
4194 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4196 % Subsubsection titles.
4197 \def\subsubsecheadingskip{\subsecheadingskip}
4198 \def\subsubsecheadingbreak{\subsecheadingbreak}
4201 % Print any size, any type, section title.
4203 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4204 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4205 % section number.
4207 \def\sectionheading#1#2#3#4{%
4209 % Switch to the right set of fonts.
4210 \csname #2fonts\endcsname \rm
4212 % Insert space above the heading.
4213 \csname #2headingbreak\endcsname
4215 % Only insert the space after the number if we have a section number.
4216 \def\sectionlevel{#2}%
4217 \def\temptype{#3}%
4219 \ifx\temptype\Ynothingkeyword
4220 \setbox0 = \hbox{}%
4221 \def\toctype{unn}%
4222 \gdef\thissection{#1}%
4223 \else\ifx\temptype\Yomitfromtockeyword
4224 % for @headings -- no section number, don't include in toc,
4225 % and don't redefine \thissection.
4226 \setbox0 = \hbox{}%
4227 \def\toctype{omit}%
4228 \let\sectionlevel=\empty
4229 \else\ifx\temptype\Yappendixkeyword
4230 \setbox0 = \hbox{#4\enspace}%
4231 \def\toctype{app}%
4232 \gdef\thissection{#1}%
4233 \else
4234 \setbox0 = \hbox{#4\enspace}%
4235 \def\toctype{num}%
4236 \gdef\thissection{#1}%
4237 \fi\fi\fi
4239 % Write the toc entry (before \donoderef). See comments in \chfplain.
4240 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4242 % Write the node reference (= pdf destination for pdftex).
4243 % Again, see comments in \chfplain.
4244 \donoderef{#3}%
4246 % Output the actual section heading.
4247 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4248 \hangindent=\wd0 % zero if no section number
4249 \unhbox0 #1}%
4251 % Add extra space after the heading -- half of whatever came above it.
4252 % Don't allow stretch, though.
4253 \kern .5 \csname #2headingskip\endcsname
4255 % Do not let the kern be a potential breakpoint, as it would be if it
4256 % was followed by glue.
4257 \nobreak
4259 % We'll almost certainly start a paragraph next, so don't let that
4260 % glue accumulate. (Not a breakpoint because it's preceded by a
4261 % discardable item.)
4262 \vskip-\parskip
4264 % This \nobreak is purely so the last item on the list is a \penalty
4265 % of 10000. This is so other code, for instance \parsebodycommon, can
4266 % check for and avoid allowing breakpoints. Otherwise, it would
4267 % insert a valid breakpoint between:
4268 % @section sec-whatever
4269 % @deffn def-whatever
4270 \nobreak
4274 \message{toc,}
4275 % Table of contents.
4276 \newwrite\tocfile
4278 % Write an entry to the toc file, opening it if necessary.
4279 % Called from @chapter, etc.
4281 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4282 % We append the current node name (if any) and page number as additional
4283 % arguments for the \{chap,sec,...}entry macros which will eventually
4284 % read this. The node name is used in the pdf outlines as the
4285 % destination to jump to.
4287 % We open the .toc file for writing here instead of at @setfilename (or
4288 % any other fixed time) so that @contents can be anywhere in the document.
4289 % But if #1 is `omit', then we don't do anything. This is used for the
4290 % table of contents chapter openings themselves.
4292 \newif\iftocfileopened
4293 \def\omitkeyword{omit}%
4295 \def\writetocentry#1#2#3{%
4296 \edef\writetoctype{#1}%
4297 \ifx\writetoctype\omitkeyword \else
4298 \iftocfileopened\else
4299 \immediate\openout\tocfile = \jobname.toc
4300 \global\tocfileopenedtrue
4303 \iflinks
4304 \toks0 = {#2}%
4305 \toks2 = \expandafter{\lastnode}%
4306 \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}%
4307 {\the\toks2}{\noexpand\folio}}}%
4308 \temp
4312 % Tell \shipout to create a pdf destination on each page, if we're
4313 % writing pdf. These are used in the table of contents. We can't
4314 % just write one on every page because the title pages are numbered
4315 % 1 and 2 (the page numbers aren't printed), and so are the first
4316 % two pages of the document. Thus, we'd have two destinations named
4317 % `1', and two named `2'.
4318 \ifpdf \global\pdfmakepagedesttrue \fi
4321 \newskip\contentsrightmargin \contentsrightmargin=1in
4322 \newcount\savepageno
4323 \newcount\lastnegativepageno \lastnegativepageno = -1
4325 % Prepare to read what we've written to \tocfile.
4327 \def\startcontents#1{%
4328 % If @setchapternewpage on, and @headings double, the contents should
4329 % start on an odd page, unlike chapters. Thus, we maintain
4330 % \contentsalignmacro in parallel with \pagealignmacro.
4331 % From: Torbjorn Granlund <tege@matematik.su.se>
4332 \contentsalignmacro
4333 \immediate\closeout\tocfile
4335 % Don't need to put `Contents' or `Short Contents' in the headline.
4336 % It is abundantly clear what they are.
4337 \def\thischapter{}%
4338 \chapmacro{#1}{Yomitfromtoc}{}%
4340 \savepageno = \pageno
4341 \begingroup % Set up to handle contents files properly.
4342 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
4343 % We can't do this, because then an actual ^ in a section
4344 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4345 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4346 \raggedbottom % Worry more about breakpoints than the bottom.
4347 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4349 % Roman numerals for page numbers.
4350 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4354 % Normal (long) toc.
4355 \def\contents{%
4356 \startcontents{\putwordTOC}%
4357 \openin 1 \jobname.toc
4358 \ifeof 1 \else
4359 \input \jobname.toc
4361 \vfill \eject
4362 \contentsalignmacro % in case @setchapternewpage odd is in effect
4363 \ifeof 1 \else
4364 \pdfmakeoutlines
4366 \closein 1
4367 \endgroup
4368 \lastnegativepageno = \pageno
4369 \global\pageno = \savepageno
4372 % And just the chapters.
4373 \def\summarycontents{%
4374 \startcontents{\putwordShortTOC}%
4376 \let\numchapentry = \shortchapentry
4377 \let\appentry = \shortchapentry
4378 \let\unnchapentry = \shortunnchapentry
4379 % We want a true roman here for the page numbers.
4380 \secfonts
4381 \let\rm=\shortcontrm \let\bf=\shortcontbf
4382 \let\sl=\shortcontsl \let\tt=\shortconttt
4384 \hyphenpenalty = 10000
4385 \advance\baselineskip by 1pt % Open it up a little.
4386 \def\numsecentry##1##2##3##4{}
4387 \let\appsecentry = \numsecentry
4388 \let\unnsecentry = \numsecentry
4389 \let\numsubsecentry = \numsecentry
4390 \let\appsubsecentry = \numsecentry
4391 \let\unnsubsecentry = \numsecentry
4392 \let\numsubsubsecentry = \numsecentry
4393 \let\appsubsubsecentry = \numsecentry
4394 \let\unnsubsubsecentry = \numsecentry
4395 \openin 1 \jobname.toc
4396 \ifeof 1 \else
4397 \input \jobname.toc
4399 \closein 1
4400 \vfill \eject
4401 \contentsalignmacro % in case @setchapternewpage odd is in effect
4402 \endgroup
4403 \lastnegativepageno = \pageno
4404 \global\pageno = \savepageno
4406 \let\shortcontents = \summarycontents
4408 % Typeset the label for a chapter or appendix for the short contents.
4409 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4411 \def\shortchaplabel#1{%
4412 % This space should be enough, since a single number is .5em, and the
4413 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4414 % But use \hss just in case.
4415 % (This space doesn't include the extra space that gets added after
4416 % the label; that gets put in by \shortchapentry above.)
4418 % We'd like to right-justify chapter numbers, but that looks strange
4419 % with appendix letters. And right-justifying numbers and
4420 % left-justifying letters looks strange when there is less than 10
4421 % chapters. Have to read the whole toc once to know how many chapters
4422 % there are before deciding ...
4423 \hbox to 1em{#1\hss}%
4426 % These macros generate individual entries in the table of contents.
4427 % The first argument is the chapter or section name.
4428 % The last argument is the page number.
4429 % The arguments in between are the chapter number, section number, ...
4431 % Chapters, in the main contents.
4432 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4434 % Chapters, in the short toc.
4435 % See comments in \dochapentry re vbox and related settings.
4436 \def\shortchapentry#1#2#3#4{%
4437 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4440 % Appendices, in the main contents.
4441 % Need the word Appendix, and a fixed-size box.
4443 \def\appendixbox#1{%
4444 % We use M since it's probably the widest letter.
4445 \setbox0 = \hbox{\putwordAppendix{} M}%
4446 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4448 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4450 % Unnumbered chapters.
4451 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4452 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4454 % Sections.
4455 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4456 \let\appsecentry=\numsecentry
4457 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4459 % Subsections.
4460 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4461 \let\appsubsecentry=\numsubsecentry
4462 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4464 % And subsubsections.
4465 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4466 \let\appsubsubsecentry=\numsubsubsecentry
4467 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4469 % This parameter controls the indentation of the various levels.
4470 \newdimen\tocindent \tocindent = 2pc
4472 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4473 % page number.
4475 % If the toc has to be broken over pages, we want it to be at chapters
4476 % if at all possible; hence the \penalty.
4477 \def\dochapentry#1#2{%
4478 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4479 \begingroup
4480 \chapentryfonts
4481 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4482 \endgroup
4483 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4486 \def\dosecentry#1#2{\begingroup
4487 \secentryfonts \leftskip=\tocindent
4488 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4489 \endgroup}
4491 \def\dosubsecentry#1#2{\begingroup
4492 \subsecentryfonts \leftskip=2\tocindent
4493 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4494 \endgroup}
4496 \def\dosubsubsecentry#1#2{\begingroup
4497 \subsubsecentryfonts \leftskip=3\tocindent
4498 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4499 \endgroup}
4501 % We use the same \entry macro as for the index entries.
4502 \let\tocentry = \entry
4504 % Space between chapter (or whatever) number and the title.
4505 \def\labelspace{\hskip1em \relax}
4507 \def\dopageno#1{{\rm #1}}
4508 \def\doshortpageno#1{{\rm #1}}
4510 \def\chapentryfonts{\secfonts \rm}
4511 \def\secentryfonts{\textfonts}
4512 \def\subsecentryfonts{\textfonts}
4513 \def\subsubsecentryfonts{\textfonts}
4516 \message{environments,}
4517 % @foo ... @end foo.
4519 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4521 % Since these characters are used in examples, it should be an even number of
4522 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4524 \def\point{$\star$}
4525 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4526 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4527 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4528 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4530 % The @error{} command.
4531 % Adapted from the TeXbook's \boxit.
4533 \newbox\errorbox
4535 {\tentt \global\dimen0 = 3em}% Width of the box.
4536 \dimen2 = .55pt % Thickness of rules
4537 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4538 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
4540 \setbox\errorbox=\hbox to \dimen0{\hfil
4541 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4542 \advance\hsize by -2\dimen2 % Rules.
4543 \vbox{%
4544 \hrule height\dimen2
4545 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4546 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4547 \kern3pt\vrule width\dimen2}% Space to right.
4548 \hrule height\dimen2}
4549 \hfil}
4551 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4553 % @tex ... @end tex escapes into raw Tex temporarily.
4554 % One exception: @ is still an escape character, so that @end tex works.
4555 % But \@ or @@ will get a plain tex @ character.
4557 \envdef\tex{%
4558 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4559 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4560 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4561 \catcode `\%=14
4562 \catcode `\+=\other
4563 \catcode `\"=\other
4564 \catcode `\|=\other
4565 \catcode `\<=\other
4566 \catcode `\>=\other
4567 \escapechar=`\\
4569 \let\b=\ptexb
4570 \let\bullet=\ptexbullet
4571 \let\c=\ptexc
4572 \let\,=\ptexcomma
4573 \let\.=\ptexdot
4574 \let\dots=\ptexdots
4575 \let\equiv=\ptexequiv
4576 \let\!=\ptexexclam
4577 \let\i=\ptexi
4578 \let\indent=\ptexindent
4579 \let\noindent=\ptexnoindent
4580 \let\{=\ptexlbrace
4581 \let\+=\tabalign
4582 \let\}=\ptexrbrace
4583 \let\/=\ptexslash
4584 \let\*=\ptexstar
4585 \let\t=\ptext
4587 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4588 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4589 \def\@{@}%
4591 % There is no need to define \Etex.
4593 % Define @lisp ... @end lisp.
4594 % @lisp environment forms a group so it can rebind things,
4595 % including the definition of @end lisp (which normally is erroneous).
4597 % Amount to narrow the margins by for @lisp.
4598 \newskip\lispnarrowing \lispnarrowing=0.4in
4600 % This is the definition that ^^M gets inside @lisp, @example, and other
4601 % such environments. \null is better than a space, since it doesn't
4602 % have any width.
4603 \def\lisppar{\null\endgraf}
4605 % This space is always present above and below environments.
4606 \newskip\envskipamount \envskipamount = 0pt
4608 % Make spacing and below environment symmetrical. We use \parskip here
4609 % to help in doing that, since in @example-like environments \parskip
4610 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4611 % start of the next paragraph will insert \parskip.
4613 \def\aboveenvbreak{{%
4614 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4615 \ifnum \lastpenalty=10000 \else
4616 \advance\envskipamount by \parskip
4617 \endgraf
4618 \ifdim\lastskip<\envskipamount
4619 \removelastskip
4620 % it's not a good place to break if the last penalty was \nobreak
4621 % or better ...
4622 \ifnum\lastpenalty>10000 \else \penalty-50 \fi
4623 \vskip\envskipamount
4628 \let\afterenvbreak = \aboveenvbreak
4630 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4631 \let\nonarrowing=\relax
4633 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4634 % environment contents.
4635 \font\circle=lcircle10
4636 \newdimen\circthick
4637 \newdimen\cartouter\newdimen\cartinner
4638 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4639 \circthick=\fontdimen8\circle
4641 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
4642 \def\ctr{{\hskip 6pt\circle\char'010}}
4643 \def\cbl{{\circle\char'012\hskip -6pt}}
4644 \def\cbr{{\hskip 6pt\circle\char'011}}
4645 \def\carttop{\hbox to \cartouter{\hskip\lskip
4646 \ctl\leaders\hrule height\circthick\hfil\ctr
4647 \hskip\rskip}}
4648 \def\cartbot{\hbox to \cartouter{\hskip\lskip
4649 \cbl\leaders\hrule height\circthick\hfil\cbr
4650 \hskip\rskip}}
4652 \newskip\lskip\newskip\rskip
4654 \envdef\cartouche{%
4655 \ifhmode\par\fi % can't be in the midst of a paragraph.
4656 \startsavinginserts
4657 \lskip=\leftskip \rskip=\rightskip
4658 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4659 \cartinner=\hsize \advance\cartinner by-\lskip
4660 \advance\cartinner by-\rskip
4661 \cartouter=\hsize
4662 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4663 % side, and for 6pt waste from
4664 % each corner char, and rule thickness
4665 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4666 % Flag to tell @lisp, etc., not to narrow margin.
4667 \let\nonarrowing=\comment
4668 \vbox\bgroup
4669 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4670 \carttop
4671 \hbox\bgroup
4672 \hskip\lskip
4673 \vrule\kern3pt
4674 \vbox\bgroup
4675 \kern3pt
4676 \hsize=\cartinner
4677 \baselineskip=\normbskip
4678 \lineskip=\normlskip
4679 \parskip=\normpskip
4680 \vskip -\parskip
4681 \comment % For explanation, see the end of \def\group.
4683 \def\Ecartouche{%
4684 \ifhmode\par\fi
4685 \kern3pt
4686 \egroup
4687 \kern3pt\vrule
4688 \hskip\rskip
4689 \egroup
4690 \cartbot
4691 \egroup
4692 \checkinserts
4696 % This macro is called at the beginning of all the @example variants,
4697 % inside a group.
4698 \def\nonfillstart{%
4699 \aboveenvbreak
4700 \hfuzz = 12pt % Don't be fussy
4701 \sepspaces % Make spaces be word-separators rather than space tokens.
4702 \let\par = \lisppar % don't ignore blank lines
4703 \obeylines % each line of input is a line of output
4704 \parskip = 0pt
4705 \parindent = 0pt
4706 \emergencystretch = 0pt % don't try to avoid overfull boxes
4707 % @cartouche defines \nonarrowing to inhibit narrowing
4708 % at next level down.
4709 \ifx\nonarrowing\relax
4710 \advance \leftskip by \lispnarrowing
4711 \exdentamount=\lispnarrowing
4713 \let\exdent=\nofillexdent
4716 % If you want all examples etc. small: @set dispenvsize small.
4717 % If you want even small examples the full size: @set dispenvsize nosmall.
4718 % This affects the following displayed environments:
4719 % @example, @display, @format, @lisp
4721 \def\smallword{small}
4722 \def\nosmallword{nosmall}
4723 \let\SETdispenvsize\relax
4724 \def\setnormaldispenv{%
4725 \ifx\SETdispenvsize\smallword
4726 \smallexamplefonts \rm
4729 \def\setsmalldispenv{%
4730 \ifx\SETdispenvsize\nosmallword
4731 \else
4732 \smallexamplefonts \rm
4736 % We often define two environments, @foo and @smallfoo.
4737 % Let's do it by one command:
4738 \def\makedispenv #1#2{
4739 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4740 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
4741 \expandafter\let\csname E#1\endcsname \afterenvbreak
4742 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
4745 % Define two synonyms:
4746 \def\maketwodispenvs #1#2#3{
4747 \makedispenv{#1}{#3}
4748 \makedispenv{#2}{#3}
4751 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4753 % @smallexample and @smalllisp: use smaller fonts.
4754 % Originally contributed by Pavel@xerox.
4756 \maketwodispenvs {lisp}{example}{%
4757 \nonfillstart
4759 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4760 \gobble % eat return
4763 % @display/@smalldisplay: same as @lisp except keep current font.
4765 \makedispenv {display}{%
4766 \nonfillstart
4767 \gobble
4770 % @format/@smallformat: same as @display except don't narrow margins.
4772 \makedispenv{format}{%
4773 \let\nonarrowing = t%
4774 \nonfillstart
4775 \gobble
4778 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4779 \envdef\flushleft{%
4780 \let\nonarrowing = t%
4781 \nonfillstart
4782 \gobble
4784 \let\Eflushleft = \afterenvbreak
4786 % @flushright.
4788 \envdef\flushright{%
4789 \let\nonarrowing = t%
4790 \nonfillstart
4791 \advance\leftskip by 0pt plus 1fill
4792 \gobble
4794 \let\Eflushright = \afterenvbreak
4797 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4798 % and narrows the margins.
4800 \envdef\quotation{%
4801 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4802 \parindent=0pt
4804 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4805 \ifx\nonarrowing\relax
4806 \advance\leftskip by \lispnarrowing
4807 \advance\rightskip by \lispnarrowing
4808 \exdentamount = \lispnarrowing
4809 \let\nonarrowing = \relax
4811 \parsearg\quotationlabel
4814 % We have retained a nonzero parskip for the environment, since we're
4815 % doing normal filling. So to avoid extra space below the environment...
4816 \def\Equotation{\parskip = 0pt \afterenvbreak}
4818 % If we're given an argument, typeset it in bold with a colon after.
4819 \def\quotationlabel#1{%
4820 \def\temp{#1}%
4821 \ifx\temp\empty \else
4822 {\bf #1: }%
4827 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4828 % If we want to allow any <char> as delimiter,
4829 % we need the curly braces so that makeinfo sees the @verb command, eg:
4830 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4832 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4834 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4835 % active too. Otherwise, they get lost as the first character on a
4836 % verbatim line.
4837 \def\dospecials{%
4838 \do\ \do\\\do\{\do\}\do\$\do\&%
4839 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
4840 \do\<\do\>\do\|\do\@\do+\do\"%
4843 % [Knuth] p. 380
4844 \def\uncatcodespecials{%
4845 \def\do##1{\catcode`##1=\other}\dospecials}
4847 % [Knuth] pp. 380,381,391
4848 % Disable Spanish ligatures ?` and !` of \tt font
4849 \begingroup
4850 \catcode`\`=\active\gdef`{\relax\lq}
4851 \endgroup
4853 % Setup for the @verb command.
4855 % Eight spaces for a tab
4856 \begingroup
4857 \catcode`\^^I=\active
4858 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
4859 \endgroup
4861 \def\setupverb{%
4862 \tt % easiest (and conventionally used) font for verbatim
4863 \def\par{\leavevmode\endgraf}%
4864 \catcode`\`=\active
4865 \tabeightspaces
4866 % Respect line breaks,
4867 % print special symbols as themselves, and
4868 % make each space count
4869 % must do in this order:
4870 \obeylines \uncatcodespecials \sepspaces
4873 % Setup for the @verbatim environment
4875 % Real tab expansion
4876 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
4878 \def\starttabbox{\setbox0=\hbox\bgroup}
4879 \begingroup
4880 \catcode`\^^I=\active
4881 \gdef\tabexpand{%
4882 \catcode`\^^I=\active
4883 \def^^I{\leavevmode\egroup
4884 \dimen0=\wd0 % the width so far, or since the previous tab
4885 \divide\dimen0 by\tabw
4886 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
4887 \advance\dimen0 by\tabw % advance to next multiple of \tabw
4888 \wd0=\dimen0 \box0 \starttabbox
4891 \endgroup
4892 \def\setupverbatim{%
4893 \nonfillstart
4894 \advance\leftskip by -\defbodyindent
4895 % Easiest (and conventionally used) font for verbatim
4897 \def\par{\leavevmode\egroup\box0\endgraf}%
4898 \catcode`\`=\active
4899 \tabexpand
4900 % Respect line breaks,
4901 % print special symbols as themselves, and
4902 % make each space count
4903 % must do in this order:
4904 \obeylines \uncatcodespecials \sepspaces
4905 \everypar{\starttabbox}%
4908 % Do the @verb magic: verbatim text is quoted by unique
4909 % delimiter characters. Before first delimiter expect a
4910 % right brace, after last delimiter expect closing brace:
4912 % \def\doverb'{'<char>#1<char>'}'{#1}
4914 % [Knuth] p. 382; only eat outer {}
4915 \begingroup
4916 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
4917 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
4918 \endgroup
4920 \def\verb{\begingroup\setupverb\doverb}
4923 % Do the @verbatim magic: define the macro \doverbatim so that
4924 % the (first) argument ends when '@end verbatim' is reached, ie:
4926 % \def\doverbatim#1@end verbatim{#1}
4928 % For Texinfo it's a lot easier than for LaTeX,
4929 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
4930 % we need not redefine '\', '{' and '}'.
4932 % Inspired by LaTeX's verbatim command set [latex.ltx]
4934 \begingroup
4935 \catcode`\ =\active
4936 \obeylines %
4937 % ignore everything up to the first ^^M, that's the newline at the end
4938 % of the @verbatim input line itself. Otherwise we get an extra blank
4939 % line in the output.
4940 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
4941 % We really want {...\end verbatim} in the body of the macro, but
4942 % without the active space; thus we have to use \xdef and \gobble.
4943 \endgroup
4945 \envdef\verbatim{%
4946 \setupverbatim\doverbatim
4948 \let\Everbatim = \afterenvbreak
4951 % @verbatiminclude FILE - insert text of file in verbatim environment.
4953 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
4955 \def\doverbatiminclude#1{%
4957 \makevalueexpandable
4958 \setupverbatim
4959 \input #1
4960 \afterenvbreak
4964 % @copying ... @end copying.
4965 % Save the text away for @insertcopying later. Many commands won't be
4966 % allowed in this context, but that's ok.
4968 % We save the uninterpreted tokens, rather than creating a box.
4969 % Saving the text in a box would be much easier, but then all the
4970 % typesetting commands (@smallbook, font changes, etc.) have to be done
4971 % beforehand -- and a) we want @copying to be done first in the source
4972 % file; b) letting users define the frontmatter in as flexible order as
4973 % possible is very desirable.
4975 \def\copying{\begingroup
4976 % Define a command to swallow text until we reach `@end copying'.
4977 % \ is the escape char in this texinfo.tex file, so it is the
4978 % delimiter for the command; @ will be the escape char when we read
4979 % it, but that doesn't matter.
4980 \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}%
4982 % We must preserve ^^M's in the input file; see \insertcopying below.
4983 \catcode`\^^M = \active
4984 \docopying
4987 % What we do to finish off the copying text.
4989 \def\enddocopying{\endgroup\ignorespaces}
4991 % @insertcopying. Here we must play games with ^^M's. On the one hand,
4992 % we need them to delimit commands such as `@end quotation', so they
4993 % must be active. On the other hand, we certainly don't want every
4994 % end-of-line to be a \par, as would happen with the normal active
4995 % definition of ^^M. On the third hand, two ^^M's in a row should still
4996 % generate a \par.
4998 % Our approach is to make ^^M insert a space and a penalty1 normally;
4999 % then it can also check if \lastpenalty=1. If it does, then manually
5000 % do \par.
5002 % This messes up the normal definitions of @c[omment], so we redefine
5003 % it. Similarly for @ignore. (These commands are used in the gcc
5004 % manual for man page generation.)
5006 % Seems pretty fragile, most line-oriented commands will presumably
5007 % fail, but for the limited use of getting the copying text (which
5008 % should be quite simple) inserted, we can hope it's ok.
5010 {\catcode`\^^M=\active %
5011 \gdef\insertcopying{\begingroup %
5012 \parindent = 0pt % looks wrong on title page
5013 \def^^M{%
5014 \ifnum \lastpenalty=1 %
5015 \par %
5016 \else %
5017 \space \penalty 1 %
5018 \fi %
5021 % Fix @c[omment] for catcode 13 ^^M's.
5022 \def\c##1^^M{\ignorespaces}%
5023 \let\comment = \c %
5025 % Don't bother jumping through all the hoops that \doignore does, it
5026 % would be very hard since the catcodes are already set.
5027 \long\def\ignore##1\end ignore{\ignorespaces}%
5029 \copyingtext %
5030 \endgroup}%
5033 \message{defuns,}
5034 % @defun etc.
5036 \newskip\defbodyindent \defbodyindent=.4in
5037 \newskip\defargsindent \defargsindent=50pt
5038 \newskip\deflastargmargin \deflastargmargin=18pt
5040 % Start the processing of @deffn:
5041 \def\startdefun{%
5042 \ifnum\lastpenalty<10000
5043 \medbreak
5044 \else
5045 % If there are two @def commands in a row, we'll have a \nobreak,
5046 % which is there to keep the function description together with its
5047 % header. But if there's nothing but headers, we need to allow a
5048 % break somewhere. Check for penalty 10002 (inserted by
5049 % \defargscommonending) instead of 10000, since the sectioning
5050 % commands insert a \penalty10000, and we don't want to allow a break
5051 % between a section heading and a defun.
5052 \ifnum\lastpenalty=10002 \penalty2000 \fi
5054 % Similarly, after a section heading, do not allow a break.
5055 % But do insert the glue.
5056 \medskip % preceded by discardable penalty, so not a breakpoint
5059 \parindent=0in
5060 \advance\leftskip by \defbodyindent
5061 \exdentamount=\defbodyindent
5064 \def\dodefunx#1{%
5065 % First, check whether we are in the right environment:
5066 \checkenv#1%
5068 % As above, allow line break if we have multiple x headers in a row.
5069 % It's not a great place, though.
5070 \ifnum\lastpenalty=10002 \penalty3000 \fi
5072 % And now, it's time to reuse the body of the original defun:
5073 \expandafter\gobbledefun#1%
5075 \def\gobbledefun#1\startdefun{}
5077 % \printdefunline \deffnheader{text}
5079 \def\printdefunline#1#2{%
5080 \begingroup
5081 % call \deffnheader:
5082 #1#2 \endheader
5083 % common ending:
5084 \interlinepenalty = 10000
5085 \advance\rightskip by 0pt plus 1fil
5086 \endgraf
5087 \nobreak\vskip -\parskip
5088 \penalty 10002 % signal to \startdefun and \dodefunx
5089 % Some of the @defun-type tags do not enable magic parentheses,
5090 % rendering the following check redundant. But we don't optimize.
5091 \checkparencounts
5092 \endgroup
5095 \def\Edefun{\endgraf\medbreak}
5097 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5098 % the only thing remainnig is to define \deffnheader.
5100 \def\makedefun#1{%
5101 \expandafter\let\csname E#1\endcsname = \Edefun
5102 \edef\temp{\noexpand\domakedefun
5103 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5104 \temp
5107 % \domakedefun \deffn \deffnx \deffnheader
5109 % Define \deffn and \deffnx, without parameters.
5110 % \deffnheader has to be defined explicitly.
5112 \def\domakedefun#1#2#3{%
5113 \envdef#1{%
5114 \startdefun
5115 \parseargusing\activeparens{\printdefunline#3}%
5117 \def#2{\dodefunx#1}%
5118 \def#3%
5121 %%% Untyped functions:
5123 % @deffn category name args
5124 \makedefun{deffn}{\deffngeneral{}}
5126 % @deffn category class name args
5127 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5129 % \defopon {category on}class name args
5130 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5132 % \deffngeneral {subind}category name args
5134 \def\deffngeneral#1#2 #3 #4\endheader{%
5135 % Remember that \dosubin{fn}{xxx}{} is equivalent to \doind{fn}{xxx}.
5136 \dosubind{fn}{\code{#3}}{#1}%
5137 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5140 %%% Typed functions:
5142 % @deftypefn category type name args
5143 \makedefun{deftypefn}{\deftypefngeneral{}}
5145 % @deftypeop category class type name args
5146 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5148 % \deftypeopon {category on}class type name args
5149 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5151 % \deftypefngeneral {subind}category type name args
5153 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5154 \dosubind{fn}{\code{#4}}{#1}%
5155 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5158 %%% Typed variables:
5160 % @deftypevr category type var args
5161 \makedefun{deftypevr}{\deftypecvgeneral{}}
5163 % @deftypecv category class type var args
5164 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5166 % \deftypecvof {category of}class type var args
5167 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5169 % \deftypecvgeneral {subind}category type var args
5171 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5172 \dosubind{vr}{\code{#4}}{#1}%
5173 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5176 %%% Untyped variables:
5178 % @defvr category var args
5179 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5181 % @defcv category class var args
5182 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5184 % \defcvof {category of}class var args
5185 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5187 %%% Type:
5188 % @deftp category name args
5189 \makedefun{deftp}#1 #2 #3\endheader{%
5190 \doind{tp}{\code{#2}}%
5191 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5194 % Remaining @defun-like shortcuts:
5195 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5196 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5197 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5198 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5199 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5200 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5201 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5202 \makedefun{defmethod}{\defopon\putwordMethodon}
5203 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5204 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5205 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5207 % \defname, which formats the name of the @def (not the args).
5208 % #1 is the category, such as "Function".
5209 % #2 is the return type, if any.
5210 % #3 is the function name.
5212 % We are followed by (but not passed) the arguments, if any.
5214 \def\defname#1#2#3{%
5215 % Get the values of \leftskip and \rightskip as they were outside the @def...
5216 \advance\leftskip by -\defbodyindent
5218 % How we'll format the type name. Putting it in brackets helps
5219 % distinguish it from the body text that may end up on the next line
5220 % just below it.
5221 \def\temp{#1}%
5222 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5224 % Figure out line sizes for the paragraph shape.
5225 % The first line needs space for \box0; but if \rightskip is nonzero,
5226 % we need only space for the part of \box0 which exceeds it:
5227 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5228 % The continuations:
5229 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5230 % (plain.tex says that \dimen1 should be used only as global.)
5231 \parshape 2 0in \dimen0 \defargsindent \dimen2
5233 % Put the type name to the right margin.
5234 \noindent
5235 \hbox to 0pt{%
5236 \hfil\box0 \kern-\hsize
5237 % \hsize has to be shortened this way:
5238 \kern\leftskip
5239 % Intentionally do not respect \rightskip, since we need the space.
5242 % Allow all lines to be underfull without complaint:
5243 \tolerance=10000 \hbadness=10000
5244 \exdentamount=\defbodyindent
5246 % defun fonts. We use typewriter by default (used to be bold) because:
5247 % . we're printing identifiers, they should be in tt in principle.
5248 % . in languages with many accents, such as Czech or French, it's
5249 % common to leave accents off identifiers. The result looks ok in
5250 % tt, but exceedingly strange in rm.
5251 % . we don't want -- and --- to be treated as ligatures.
5252 % . this still does not fix the ?` and !` ligatures, but so far no
5253 % one has made identifiers using them :).
5254 \df \tt
5255 \def\temp{#2}% return value type
5256 \ifx\temp\empty\else \tclose{\temp} \fi
5257 #3% output function name
5259 {\rm\enskip}% hskip 0.5 em of \tenrm
5261 \boldbrax
5262 % arguments will be output next, if any.
5265 % Print arguments in slanted typewriter, prevent hyphenation at `-' chars.
5267 \def\defunargs#1{%
5268 % use sl by default (not ttsl), inconsistently with using tt for the
5269 % name. This is because literal text is sometimes needed in the
5270 % argument list (groff manual), and ttsl and tt are not very
5271 % distinguishable.
5272 % tt for the names.
5273 \df \sl \hyphenchar\font=0
5274 % On the other hand, if an argument has two dashes (for instance), we
5275 % want a way to get ttsl. Let's try @var for that.
5276 \let\var=\ttslanted
5278 \sl\hyphenchar\font=45
5281 % We want ()&[] to print specially on the defun line.
5283 \def\activeparens{%
5284 \catcode`\(=\active \catcode`\)=\active
5285 \catcode`\[=\active \catcode`\]=\active
5286 \catcode`\&=\active
5289 % Make control sequences which act like normal parenthesis chars.
5290 \let\lparen = ( \let\rparen = )
5292 % Be sure that we always have a definition for `(', etc. For example,
5293 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5294 % so TeX would otherwise complain about undefined control sequence.
5296 \activeparens
5297 \global\let(=\lparen \global\let)=\rparen
5298 \global\let[=\lbrack \global\let]=\rbrack
5299 \global\let& = \&
5301 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5302 \gdef\magicamp{\let&=\amprm}
5305 \newcount\parencount
5307 % If we encounter &foo, then turn on ()-hacking afterwards
5308 \newif\ifampseen
5309 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5311 \def\parenfont{%
5312 \ifampseen
5313 % At the first level, print parens in roman,
5314 % otherwise use the default font.
5315 \ifnum \parencount=1 \rm \fi
5316 \else
5317 % The \sf parens (in \boldbrax) actually are a little bolder than
5318 % the contained text. This is especially needed for [ and ] .
5322 \def\infirstlevel#1{%
5323 \ifampseen
5324 \ifnum\parencount=1
5329 \def\bfafterword#1 {#1 \bf}
5331 \def\opnr{%
5332 \global\advance\parencount by 1
5333 {\parenfont(}%
5334 \infirstlevel \bfafterword
5336 \def\clnr{%
5337 {\parenfont)}%
5338 \infirstlevel \sl
5339 \global\advance\parencount by -1
5342 \newcount\brackcount
5343 \def\lbrb{%
5344 \global\advance\brackcount by 1
5345 {\bf[}%
5347 \def\rbrb{%
5348 {\bf]}%
5349 \global\advance\brackcount by -1
5352 \def\checkparencounts{%
5353 \ifnum\parencount=0 \else \badparencount \fi
5354 \ifnum\brackcount=0 \else \badbrackcount \fi
5356 \def\badparencount{%
5357 \errmessage{Unbalanced parentheses in @def}%
5358 \global\parencount=0
5360 \def\badbrackcount{%
5361 \errmessage{Unbalanced square braces in @def}%
5362 \global\brackcount=0
5366 \message{macros,}
5367 % @macro.
5369 % To do this right we need a feature of e-TeX, \scantokens,
5370 % which we arrange to emulate with a temporary file in ordinary TeX.
5371 \ifx\eTeXversion\undefined
5372 \newwrite\macscribble
5373 \def\scantokens#1{%
5374 \toks0={#1\endinput}%
5375 \immediate\openout\macscribble=\jobname.tmp
5376 \immediate\write\macscribble{\the\toks0}%
5377 \immediate\closeout\macscribble
5378 \input \jobname.tmp
5382 \def\scanmacro#1{%
5383 \begingroup
5384 \newlinechar`\^^M
5385 \let\xeatspaces\eatspaces
5386 % Undo catcode changes of \startcontents and \doprintindex
5387 \catcode`\@=0 \catcode`\\=\other \escapechar=`\@
5388 % ... and \example
5389 \spaceisspace
5391 % Append \endinput to make sure that TeX does not see the ending newline.
5393 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5394 % --kasal, 29nov03
5395 \scantokens{#1\endinput}%
5396 \endgroup
5399 \newcount\paramno % Count of parameters
5400 \newtoks\macname % Macro name
5401 \newif\ifrecursive % Is it recursive?
5402 \def\macrolist{} % List of all defined macros in the form
5403 % \do\macro1\do\macro2...
5405 % Utility routines.
5406 % This does \let #1 = #2, except with \csnames.
5407 \def\cslet#1#2{%
5408 \expandafter\expandafter
5409 \expandafter\let
5410 \expandafter\expandafter
5411 \csname#1\endcsname
5412 \csname#2\endcsname}
5414 % Trim leading and trailing spaces off a string.
5415 % Concepts from aro-bend problem 15 (see CTAN).
5416 {\catcode`\@=11
5417 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5418 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5419 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5420 \def\unbrace#1{#1}
5421 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5424 % Trim a single trailing ^^M off a string.
5425 {\catcode`\^^M=\other \catcode`\Q=3%
5426 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5427 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5428 \gdef\eatcrb#1Q#2Q{#1}%
5431 % Macro bodies are absorbed as an argument in a context where
5432 % all characters are catcode 10, 11 or 12, except \ which is active
5433 % (as in normal texinfo). It is necessary to change the definition of \.
5435 % It's necessary to have hard CRs when the macro is executed. This is
5436 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5437 % body, and then making it the \newlinechar in \scanmacro.
5439 \def\macrobodyctxt{%
5440 \catcode`\~=\other
5441 \catcode`\^=\other
5442 \catcode`\_=\other
5443 \catcode`\|=\other
5444 \catcode`\<=\other
5445 \catcode`\>=\other
5446 \catcode`\+=\other
5447 \catcode`\{=\other
5448 \catcode`\}=\other
5449 \catcode`\@=\other
5450 \catcode`\^^M=\other
5451 \usembodybackslash}
5453 \def\macroargctxt{%
5454 \catcode`\~=\other
5455 \catcode`\^=\other
5456 \catcode`\_=\other
5457 \catcode`\|=\other
5458 \catcode`\<=\other
5459 \catcode`\>=\other
5460 \catcode`\+=\other
5461 \catcode`\@=\other
5462 \catcode`\\=\other}
5464 % \mbodybackslash is the definition of \ in @macro bodies.
5465 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5466 % where N is the macro parameter number.
5467 % We define \csname macarg.\endcsname to be \realbackslash, so
5468 % \\ in macro replacement text gets you a backslash.
5470 {\catcode`@=0 @catcode`@\=@active
5471 @gdef@usembodybackslash{@let\=@mbodybackslash}
5472 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5474 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5476 \def\macro{\recursivefalse\parsearg\macroxxx}
5477 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5479 \def\macroxxx#1{%
5480 \getargs{#1}% now \macname is the macname and \argl the arglist
5481 \ifx\argl\empty % no arguments
5482 \paramno=0%
5483 \else
5484 \expandafter\parsemargdef \argl;%
5486 \if1\csname ismacro.\the\macname\endcsname
5487 \message{Warning: redefining \the\macname}%
5488 \else
5489 \expandafter\ifx\csname \the\macname\endcsname \relax
5490 \else \errmessage{Macro name \the\macname\space already defined}\fi
5491 \global\cslet{macsave.\the\macname}{\the\macname}%
5492 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5493 % Add the macroname to \macrolist
5494 \toks0 = \expandafter{\macrolist\do}%
5495 \xdef\macrolist{\the\toks0
5496 \expandafter\noexpand\csname\the\macname\endcsname}%
5498 \begingroup \macrobodyctxt
5499 \ifrecursive \expandafter\parsermacbody
5500 \else \expandafter\parsemacbody
5501 \fi}
5503 \parseargdef\unmacro{%
5504 \if1\csname ismacro.#1\endcsname
5505 \global\cslet{#1}{macsave.#1}%
5506 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5507 % Remove the macro name from \macrolist:
5508 \begingroup
5509 \expandafter\let\csname#1\endcsname \relax
5510 \let\do\unmacrodo
5511 \xdef\macrolist{\macrolist}%
5512 \endgroup
5513 \else
5514 \errmessage{Macro #1 not defined}%
5518 % Called by \do from \dounmacro on each macro. The idea is to omit any
5519 % macro definitions that have been changed to \relax.
5521 \def\unmacrodo#1{%
5522 \ifx#1\relax
5523 % remove this
5524 \else
5525 \noexpand\do \noexpand #1%
5529 % This makes use of the obscure feature that if the last token of a
5530 % <parameter list> is #, then the preceding argument is delimited by
5531 % an opening brace, and that opening brace is not consumed.
5532 \def\getargs#1{\getargsxxx#1{}}
5533 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5534 \def\getmacname #1 #2\relax{\macname={#1}}
5535 \def\getmacargs#1{\def\argl{#1}}
5537 % Parse the optional {params} list. Set up \paramno and \paramlist
5538 % so \defmacro knows what to do. Define \macarg.blah for each blah
5539 % in the params list, to be ##N where N is the position in that list.
5540 % That gets used by \mbodybackslash (above).
5542 % We need to get `macro parameter char #' into several definitions.
5543 % The technique used is stolen from LaTeX: let \hash be something
5544 % unexpandable, insert that wherever you need a #, and then redefine
5545 % it to # just before using the token list produced.
5547 % The same technique is used to protect \eatspaces till just before
5548 % the macro is used.
5550 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
5551 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
5552 \def\parsemargdefxxx#1,{%
5553 \if#1;\let\next=\relax
5554 \else \let\next=\parsemargdefxxx
5555 \advance\paramno by 1%
5556 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
5557 {\xeatspaces{\hash\the\paramno}}%
5558 \edef\paramlist{\paramlist\hash\the\paramno,}%
5559 \fi\next}
5561 % These two commands read recursive and nonrecursive macro bodies.
5562 % (They're different since rec and nonrec macros end differently.)
5564 \long\def\parsemacbody#1@end macro%
5565 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5566 \long\def\parsermacbody#1@end rmacro%
5567 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5569 % This defines the macro itself. There are six cases: recursive and
5570 % nonrecursive macros of zero, one, and many arguments.
5571 % Much magic with \expandafter here.
5572 % \xdef is used so that macro definitions will survive the file
5573 % they're defined in; @include reads the file inside a group.
5574 \def\defmacro{%
5575 \let\hash=##% convert placeholders to macro parameter chars
5576 \ifrecursive
5577 \ifcase\paramno
5579 \expandafter\xdef\csname\the\macname\endcsname{%
5580 \noexpand\scanmacro{\temp}}%
5581 \or % 1
5582 \expandafter\xdef\csname\the\macname\endcsname{%
5583 \bgroup\noexpand\macroargctxt
5584 \noexpand\braceorline
5585 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5586 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5587 \egroup\noexpand\scanmacro{\temp}}%
5588 \else % many
5589 \expandafter\xdef\csname\the\macname\endcsname{%
5590 \bgroup\noexpand\macroargctxt
5591 \noexpand\csname\the\macname xx\endcsname}%
5592 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5593 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5594 \expandafter\expandafter
5595 \expandafter\xdef
5596 \expandafter\expandafter
5597 \csname\the\macname xxx\endcsname
5598 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5600 \else
5601 \ifcase\paramno
5603 \expandafter\xdef\csname\the\macname\endcsname{%
5604 \noexpand\norecurse{\the\macname}%
5605 \noexpand\scanmacro{\temp}\egroup}%
5606 \or % 1
5607 \expandafter\xdef\csname\the\macname\endcsname{%
5608 \bgroup\noexpand\macroargctxt
5609 \noexpand\braceorline
5610 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
5611 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
5612 \egroup
5613 \noexpand\norecurse{\the\macname}%
5614 \noexpand\scanmacro{\temp}\egroup}%
5615 \else % many
5616 \expandafter\xdef\csname\the\macname\endcsname{%
5617 \bgroup\noexpand\macroargctxt
5618 \expandafter\noexpand\csname\the\macname xx\endcsname}%
5619 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
5620 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
5621 \expandafter\expandafter
5622 \expandafter\xdef
5623 \expandafter\expandafter
5624 \csname\the\macname xxx\endcsname
5625 \paramlist{%
5626 \egroup
5627 \noexpand\norecurse{\the\macname}%
5628 \noexpand\scanmacro{\temp}\egroup}%
5630 \fi}
5632 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
5634 % \braceorline decides whether the next nonwhitespace character is a
5635 % {. If so it reads up to the closing }, if not, it reads the whole
5636 % line. Whatever was read is then fed to the next control sequence
5637 % as an argument (by \parsebrace or \parsearg)
5638 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx}
5639 \def\braceorlinexxx{%
5640 \ifx\nchar\bgroup\else
5641 \expandafter\parsearg
5642 \fi \next}
5644 % We mant to disable all macros during \shipout so that they are not
5645 % expanded by \write.
5646 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5647 \edef\next{\macrolist}\expandafter\endgroup\next}
5650 % @alias.
5651 % We need some trickery to remove the optional spaces around the equal
5652 % sign. Just make them active and then expand them all to nothing.
5653 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5654 \def\aliasxxx #1{\aliasyyy#1\relax}
5655 \def\aliasyyy #1=#2\relax{%
5657 \expandafter\let\obeyedspace=\empty
5658 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
5660 \next
5664 \message{cross references,}
5666 \newwrite\auxfile
5668 \newif\ifhavexrefs % True if xref values are known.
5669 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5671 % @inforef is relatively simple.
5672 \def\inforef #1{\inforefzzz #1,,,,**}
5673 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5674 node \samp{\ignorespaces#1{}}}
5676 % @node's only job in TeX is to define \lastnode, which is used in
5677 % cross-references.
5678 \parseargdef\node{\checkenv{}\nodexxx #1,\finishnodeparse}
5679 \def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}}
5680 \let\nwnode=\node
5681 \let\lastnode=\empty
5683 % Write a cross-reference definition for the current node. #1 is the
5684 % type (Ynumbered, Yappendix, Ynothing).
5686 \def\donoderef#1{%
5687 \ifx\lastnode\empty\else
5688 \setref{\lastnode}{#1}%
5689 \global\let\lastnode=\empty
5693 % @anchor{NAME} -- define xref target at arbitrary point.
5695 \newcount\savesfregister
5697 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5698 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5699 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5701 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5702 % anchor), which consists of three parts:
5703 % 1) NAME-title - the current sectioning name, taken from \thissection;
5704 % 2) NAME-snt - section number and type, defined as the SNT arg;
5705 % 3) NAME-pg - the page number.
5706 % This is called from \donoderef, \anchor, and \dofloat.
5708 % We take care not to fully expand the title, since it may contain
5709 % arbitrary macros.
5711 % Use \turnoffactive so that punctuation chars such as underscore
5712 % and backslash work in node names.
5714 \def\setref#1#2{%
5715 \pdfmkdest{#1}%
5716 \iflinks
5718 \atdummies % preserve commands, but don't expand them
5719 \turnoffactive
5720 \otherbackslash
5721 \edef\writexrdef##1##2{%
5722 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
5723 ##1}{##2}}% these are parameters of \writexrdef
5725 \toks0 = \expandafter{\thissection}%
5726 \immediate \writexrdef{title}{\the\toks0 }%
5727 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
5728 \writexrdef{pg}{\folio}% will be written later, during \shipout
5733 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5734 % the node name, #2 the name of the Info cross-reference, #3 the printed
5735 % node name, #4 the name of the Info file, #5 the name of the printed
5736 % manual. All but the node name can be omitted.
5738 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
5739 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5740 \def\ref#1{\xrefX[#1,,,,,,,]}
5741 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5742 \unsepspaces
5743 \def\printedmanual{\ignorespaces #5}%
5744 \def\printedrefname{\ignorespaces #3}%
5745 \setbox1=\hbox{\printedmanual\unskip}%
5746 \setbox0=\hbox{\printedrefname\unskip}%
5747 \ifdim \wd0 = 0pt
5748 % No printed node name was explicitly given.
5749 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5750 % Use the node name inside the square brackets.
5751 \def\printedrefname{\ignorespaces #1}%
5752 \else
5753 % Use the actual chapter/section title appear inside
5754 % the square brackets. Use the real section title if we have it.
5755 \ifdim \wd1 > 0pt
5756 % It is in another manual, so we don't have it.
5757 \def\printedrefname{\ignorespaces #1}%
5758 \else
5759 \ifhavexrefs
5760 % We know the real title if we have the xref values.
5761 \def\printedrefname{\refx{#1-title}{}}%
5762 \else
5763 % Otherwise just copy the Info node name.
5764 \def\printedrefname{\ignorespaces #1}%
5765 \fi%
5770 % Make link in pdf output.
5771 \ifpdf
5772 \leavevmode
5773 \getfilename{#4}%
5774 {\turnoffactive \otherbackslash
5775 \ifnum\filenamelength>0
5776 \startlink attr{/Border [0 0 0]}%
5777 goto file{\the\filename.pdf} name{#1}%
5778 \else
5779 \startlink attr{/Border [0 0 0]}%
5780 goto name{\pdfmkpgn{#1}}%
5783 \linkcolor
5786 % Float references are printed completely differently: "Figure 1.2"
5787 % instead of "[somenode], p.3". We distinguish them by the
5788 % LABEL-title being set to a magic string.
5790 % Have to otherify everything special to allow the \csname to
5791 % include an _ in the xref name, etc.
5792 \indexnofonts
5793 \turnoffactive
5794 \otherbackslash
5795 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5796 \csname X#1-title\endcsname
5798 \ifx \Xthisreftitle \floatmagic
5799 % If the user specified the print name (third arg) to the ref,
5800 % print it instead of our usual "Figure 1.2".
5801 \ifdim\wd0 = 0pt
5802 \refx{#1-snt}%
5803 \else
5804 \printedrefname
5807 % if the user also gave the printed manual name (fifth arg), append
5808 % "in MANUALNAME".
5809 \ifdim \wd1 > 0pt
5810 \space \putwordin{} \cite{\printedmanual}%
5812 \else
5813 % node/anchor (non-float) references.
5815 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5816 % insert empty discretionaries after hyphens, which means that it will
5817 % not find a line break at a hyphen in a node names. Since some manuals
5818 % are best written with fairly long node names, containing hyphens, this
5819 % is a loss. Therefore, we give the text of the node name again, so it
5820 % is as if TeX is seeing it for the first time.
5821 \ifdim \wd1 > 0pt
5822 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
5823 \else
5824 % _ (for example) has to be the character _ for the purposes of the
5825 % control sequence corresponding to the node, but it has to expand
5826 % into the usual \leavevmode...\vrule stuff for purposes of
5827 % printing. So we \turnoffactive for the \refx-snt, back on for the
5828 % printing, back off for the \refx-pg.
5829 {\turnoffactive \otherbackslash
5830 % Only output a following space if the -snt ref is nonempty; for
5831 % @unnumbered and @anchor, it won't be.
5832 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
5833 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
5835 % output the `[mynode]' via a macro so it can be overridden.
5836 \xrefprintnodename\printedrefname
5838 % But we always want a comma and a space:
5839 ,\space
5841 % output the `page 3'.
5842 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}%
5845 \endlink
5846 \endgroup}
5848 % This macro is called from \xrefX for the `[nodename]' part of xref
5849 % output. It's a separate macro only so it can be changed more easily,
5850 % since square brackets don't work well in some documents. Particularly
5851 % one that Bob is working on :).
5853 \def\xrefprintnodename#1{[#1]}
5855 % Things referred to by \setref.
5857 \def\Ynothing{}
5858 \def\Yomitfromtoc{}
5859 \def\Ynumbered{%
5860 \ifnum\secno=0
5861 \putwordChapter@tie \the\chapno
5862 \else \ifnum\subsecno=0
5863 \putwordSection@tie \the\chapno.\the\secno
5864 \else \ifnum\subsubsecno=0
5865 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5866 \else
5867 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5868 \fi\fi\fi
5870 \def\Yappendix{%
5871 \ifnum\secno=0
5872 \putwordAppendix@tie @char\the\appendixno{}%
5873 \else \ifnum\subsecno=0
5874 \putwordSection@tie @char\the\appendixno.\the\secno
5875 \else \ifnum\subsubsecno=0
5876 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5877 \else
5878 \putwordSection@tie
5879 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5880 \fi\fi\fi
5883 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5884 % If its value is nonempty, SUFFIX is output afterward.
5886 \def\refx#1#2{%
5888 \indexnofonts
5889 \otherbackslash
5890 \expandafter\global\expandafter\let\expandafter\thisrefX
5891 \csname X#1\endcsname
5893 \ifx\thisrefX\relax
5894 % If not defined, say something at least.
5895 \angleleft un\-de\-fined\angleright
5896 \iflinks
5897 \ifhavexrefs
5898 \message{\linenumber Undefined cross reference `#1'.}%
5899 \else
5900 \ifwarnedxrefs\else
5901 \global\warnedxrefstrue
5902 \message{Cross reference values unknown; you must run TeX again.}%
5906 \else
5907 % It's defined, so just use it.
5908 \thisrefX
5910 #2% Output the suffix in any case.
5913 % This is the macro invoked by entries in the aux file.
5915 \def\xrdef#1{\expandafter\gdef\csname X#1\endcsname}
5917 % Read the last existing aux file, if any. No error if none exists.
5919 \def\tryauxfile{%
5920 \openin 1 \jobname.aux
5921 \ifeof 1 \else
5922 \readauxfile
5923 \global\havexrefstrue
5925 \closein 1
5928 \def\readauxfile{\begingroup
5929 \catcode`\^^@=\other
5930 \catcode`\^^A=\other
5931 \catcode`\^^B=\other
5932 \catcode`\^^C=\other
5933 \catcode`\^^D=\other
5934 \catcode`\^^E=\other
5935 \catcode`\^^F=\other
5936 \catcode`\^^G=\other
5937 \catcode`\^^H=\other
5938 \catcode`\^^K=\other
5939 \catcode`\^^L=\other
5940 \catcode`\^^N=\other
5941 \catcode`\^^P=\other
5942 \catcode`\^^Q=\other
5943 \catcode`\^^R=\other
5944 \catcode`\^^S=\other
5945 \catcode`\^^T=\other
5946 \catcode`\^^U=\other
5947 \catcode`\^^V=\other
5948 \catcode`\^^W=\other
5949 \catcode`\^^X=\other
5950 \catcode`\^^Z=\other
5951 \catcode`\^^[=\other
5952 \catcode`\^^\=\other
5953 \catcode`\^^]=\other
5954 \catcode`\^^^=\other
5955 \catcode`\^^_=\other
5956 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
5957 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5958 % supported in the main text, it doesn't seem desirable. Furthermore,
5959 % that is not enough: for node names that actually contain a ^
5960 % character, we would end up writing a line like this: 'xrdef {'hat
5961 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5962 % argument, and \hat is not an expandable control sequence. It could
5963 % all be worked out, but why? Either we support ^^ or we don't.
5965 % The other change necessary for this was to define \auxhat:
5966 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5967 % and then to call \auxhat in \setq.
5969 \catcode`\^=\other
5971 % Special characters. Should be turned off anyway, but...
5972 \catcode`\~=\other
5973 \catcode`\[=\other
5974 \catcode`\]=\other
5975 \catcode`\"=\other
5976 \catcode`\_=\other
5977 \catcode`\|=\other
5978 \catcode`\<=\other
5979 \catcode`\>=\other
5980 \catcode`\$=\other
5981 \catcode`\#=\other
5982 \catcode`\&=\other
5983 \catcode`\%=\other
5984 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5986 % Make the characters 128-255 be printing characters
5988 \count 1=128
5989 \def\loop{%
5990 \catcode\count 1=\other
5991 \advance\count 1 by 1
5992 \ifnum \count 1<256 \loop \fi
5996 % @ is our escape character in .aux files.
5997 \catcode`\{=1
5998 \catcode`\}=2
5999 \catcode`\@=0
6001 \input \jobname.aux
6002 \endgroup}
6005 \message{insertions,}
6006 % including footnotes.
6008 \newcount \footnoteno
6010 % The trailing space in the following definition for supereject is
6011 % vital for proper filling; pages come out unaligned when you do a
6012 % pagealignmacro call if that space before the closing brace is
6013 % removed. (Generally, numeric constants should always be followed by a
6014 % space to prevent strange expansion errors.)
6015 \def\supereject{\par\penalty -20000\footnoteno =0 }
6017 % @footnotestyle is meaningful for info output only.
6018 \let\footnotestyle=\comment
6020 {\catcode `\@=11
6022 % Auto-number footnotes. Otherwise like plain.
6023 \gdef\footnote{%
6024 \let\indent=\ptexindent
6025 \let\noindent=\ptexnoindent
6026 \global\advance\footnoteno by \@ne
6027 \edef\thisfootno{$^{\the\footnoteno}$}%
6029 % In case the footnote comes at the end of a sentence, preserve the
6030 % extra spacing after we do the footnote number.
6031 \let\@sf\empty
6032 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6034 % Remove inadvertent blank space before typesetting the footnote number.
6035 \unskip
6036 \thisfootno\@sf
6037 \dofootnote
6040 % Don't bother with the trickery in plain.tex to not require the
6041 % footnote text as a parameter. Our footnotes don't need to be so general.
6043 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6044 % \parseargline) fails inside footnotes because the tokens are fixed when
6045 % the footnote is read. --karl, 16nov96.
6047 \gdef\dofootnote{%
6048 \insert\footins\bgroup
6049 % We want to typeset this text as a normal paragraph, even if the
6050 % footnote reference occurs in (for example) a display environment.
6051 % So reset some parameters.
6052 \hsize=\pagewidth
6053 \interlinepenalty\interfootnotelinepenalty
6054 \splittopskip\ht\strutbox % top baseline for broken footnotes
6055 \splitmaxdepth\dp\strutbox
6056 \floatingpenalty\@MM
6057 \leftskip\z@skip
6058 \rightskip\z@skip
6059 \spaceskip\z@skip
6060 \xspaceskip\z@skip
6061 \parindent\defaultparindent
6063 \smallfonts \rm
6065 % Because we use hanging indentation in footnotes, a @noindent appears
6066 % to exdent this text, so make it be a no-op. makeinfo does not use
6067 % hanging indentation so @noindent can still be needed within footnote
6068 % text after an @example or the like (not that this is good style).
6069 \let\noindent = \relax
6071 % Hang the footnote text off the number. Use \everypar in case the
6072 % footnote extends for more than one paragraph.
6073 \everypar = {\hang}%
6074 \textindent{\thisfootno}%
6076 % Don't crash into the line above the footnote text. Since this
6077 % expands into a box, it must come within the paragraph, lest it
6078 % provide a place where TeX can split the footnote.
6079 \footstrut
6080 \futurelet\next\fo@t
6082 }%end \catcode `\@=11
6084 % In case a @footnote appears in a vbox, save the footnote text and create
6085 % the real \insert just after the vbox finished. Otherwise, the insertion
6086 % would be lost.
6087 % Similarly, if a @footnote appears inside an alignment, save the footnote
6088 % text to a box and make the \insert when a row of the table is finished.
6089 % And the same can be done for other insert classes. --kasal, 16nov03.
6091 % Replace the \insert primitive by a cheating macro.
6092 % Deeper inside, just make sure that the saved insertions are not spilled
6093 % out prematurely.
6095 \def\startsavinginserts{%
6096 \ifx \insert\ptexinsert
6097 \let\insert\saveinsert
6098 \else
6099 \let\checkinserts\relax
6103 % This \insert replacements works for both \insert\footins{foo} and
6104 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6106 \def\saveinsert#1{%
6107 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6108 \afterassignment\next
6109 % swallow the left brace
6110 \let\temp =
6112 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6113 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6115 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6117 \def\placesaveins#1{%
6118 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6119 {\box#1}%
6122 % eat @SAVE -- beware, all of them have catcode \other:
6124 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6125 \gdef\gobblesave @SAVE{}
6128 % initialization:
6129 \def\newsaveins #1{%
6130 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6131 \next
6133 \def\newsaveinsX #1{%
6134 \csname newbox\endcsname #1%
6135 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6136 \checksaveins #1}%
6139 % initialize:
6140 \let\checkinserts\empty
6141 \newsaveins\footins
6142 \newsaveins\margin
6145 % @image. We use the macros from epsf.tex to support this.
6146 % If epsf.tex is not installed and @image is used, we complain.
6148 % Check for and read epsf.tex up front. If we read it only at @image
6149 % time, we might be inside a group, and then its definitions would get
6150 % undone and the next image would fail.
6151 \openin 1 = epsf.tex
6152 \ifeof 1 \else
6153 % Do not bother showing banner with epsf.tex v2.7k (available in
6154 % doc/epsf.tex and on ctan).
6155 \def\epsfannounce{\toks0 = }%
6156 \input epsf.tex
6158 \closein 1
6160 % We will only complain once about lack of epsf.tex.
6161 \newif\ifwarnednoepsf
6162 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6163 work. It is also included in the Texinfo distribution, or you can get
6164 it from ftp://tug.org/tex/epsf.tex.}
6166 \def\image#1{%
6167 \ifx\epsfbox\undefined
6168 \ifwarnednoepsf \else
6169 \errhelp = \noepsfhelp
6170 \errmessage{epsf.tex not found, images will be ignored}%
6171 \global\warnednoepsftrue
6173 \else
6174 \imagexxx #1,,,,,\finish
6178 % Arguments to @image:
6179 % #1 is (mandatory) image filename; we tack on .eps extension.
6180 % #2 is (optional) width, #3 is (optional) height.
6181 % #4 is (ignored optional) html alt text.
6182 % #5 is (ignored optional) extension.
6183 % #6 is just the usual extra ignored arg for parsing this stuff.
6184 \newif\ifimagevmode
6185 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6186 \catcode`\^^M = 5 % in case we're inside an example
6187 \normalturnoffactive % allow _ et al. in names
6188 % If the image is by itself, center it.
6189 \ifvmode
6190 \imagevmodetrue
6191 \nobreak\bigskip
6192 % Usually we'll have text after the image which will insert
6193 % \parskip glue, so insert it here too to equalize the space
6194 % above and below.
6195 \nobreak\vskip\parskip
6196 \nobreak
6197 \line\bgroup\hss
6200 % Output the image.
6201 \ifpdf
6202 \dopdfimage{#1}{#2}{#3}%
6203 \else
6204 % \epsfbox itself resets \epsf?size at each figure.
6205 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6206 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6207 \epsfbox{#1.eps}%
6210 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6211 \endgroup}
6214 % @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc.
6215 % We don't actually implement floating yet, we just plop the float "here".
6216 % But it seemed the best name for the future.
6218 \envparseargdef\float{\dofloat #1,,,\finish}
6220 % #1 is the optional FLOATTYPE, the text label for this float, typically
6221 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6222 % this float will not be numbered and cannot be referred to.
6224 % #2 is the optional xref label. Also must be present for the float to
6225 % be referable.
6227 % #3 is the optional positioning argument; for now, it is ignored. It
6228 % will somehow specify the positions allowed to float to (here, top, bottom).
6230 % We keep a separate counter for each FLOATTYPE, which we reset at each
6231 % chapter-level command.
6232 \let\resetallfloatnos=\empty
6234 \def\dofloat#1,#2,#3,#4\finish{%
6235 % don't lose footnotes inside @float.
6236 \startsavinginserts
6238 \vtop\bgroup
6239 \def\floattype{#1}%
6240 \def\floatlabel{#2}%
6241 \def\floatloc{#3}% we do nothing with this yet.
6242 % xx should we indent the whole thing? center it?
6244 \ifx\floattype\empty \else
6246 % the floattype might have accents or other special characters,
6247 % but we need to use it in a control sequence name.
6248 \indexnofonts
6249 \turnoffactive
6250 \xdef\safefloattype{\floattype}%
6252 % We want each FLOATTYPE to be numbered separately (Figure 1,
6253 % Table 1, Figure 2, ...).
6255 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6256 \global\advance\floatno by 1
6258 \ifx\floatlabel\empty \else
6260 % This magic value for \thissection is output by \setref as the
6261 % XREFLABEL-title value. \xrefX uses it to distinguish float
6262 % labels (which have a completely different output format) from
6263 % node and anchor labels.
6265 \let\thissection=\floatmagic
6266 \setref{\floatlabel}{Yfloat}%
6272 % we have four possibilities:
6273 % @float Foo & @caption{Cap}: Foo 1.1: Cap
6274 % @float Foo & no caption: Foo 1.1
6275 % @float & @caption{Cap}: Cap
6276 % @float & no caption:
6278 \def\Efloat{%
6279 \let\printedsomething = \empty
6281 \ifx\floattype\empty \else
6282 \vskip.5\parskip % space above caption
6284 % Print the float number preceded by the chapter-level number
6285 % (empty in the case of unnumbered). Although there are other
6286 % styles of float numbering, we hardwire this one.
6287 \floattype\space\chaplevelprefix\the\floatno
6288 \let\printedsomething = t%
6291 \ifx\thiscaption\empty \else
6292 \ifx\printedsomething\empty
6293 \vskip.5\parskip % space above caption
6294 \else
6295 :\space % had a number, so print a colon before the caption.
6298 % Print caption text.
6299 \thiscaption
6300 \let\printedsomething = t%
6303 % Space below caption, if we printed anything.
6304 \ifx\printedsomething\empty \else \vskip\parskip \fi
6306 \egroup % end of \vtop
6307 \checkinserts
6310 \def\caption#1{\checkenv\float \def\thiscaption{#1}}
6311 \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
6312 \let\thiscaption=\empty
6313 \let\thisshortcaption=\empty
6315 % The parameter is the control sequence identifying the counter we are
6316 % going to use. Create it if it doesn't exist and assign it to \floatno.
6317 \def\getfloatno#1{%
6318 \ifx#1\relax
6319 % Haven't seen this figure type before.
6320 \csname newcount\endcsname #1%
6322 % Remember to reset this floatno at the next chap.
6323 \expandafter\gdef\expandafter\resetallfloatnos
6324 \expandafter{\resetallfloatnos #1=0 }%
6326 \let\floatno#1%
6329 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6330 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6331 % first read the @float command.
6333 \def\Yfloat{\floattype @tie{}\chaplevelprefix\the\floatno}%
6335 % Magic string used for the XREFLABEL-title value, so \xrefX can
6336 % distinguish floats from other xref types.
6337 \def\floatmagic{!!float!!}
6339 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6340 \parseargdef\listoffloats{%xx
6344 \message{localization,}
6345 % and i18n.
6347 % @documentlanguage is usually given very early, just after
6348 % @setfilename. If done too late, it may not override everything
6349 % properly. Single argument is the language abbreviation.
6350 % It would be nice if we could set up a hyphenation file here.
6352 \parseargdef\documentlanguage{%
6353 \tex % read txi-??.tex file in plain TeX.
6354 % Read the file if it exists.
6355 \openin 1 txi-#1.tex
6356 \ifeof 1
6357 \errhelp = \nolanghelp
6358 \errmessage{Cannot read language file txi-#1.tex}%
6359 \else
6360 \input txi-#1.tex
6362 \closein 1
6363 \endgroup
6365 \newhelp\nolanghelp{The given language definition file cannot be found or
6366 is empty. Maybe you need to install it? In the current directory
6367 should work if nowhere else does.}
6370 % @documentencoding should change something in TeX eventually, most
6371 % likely, but for now just recognize it.
6372 \let\documentencoding = \comment
6375 % Page size parameters.
6377 \newdimen\defaultparindent \defaultparindent = 15pt
6379 \chapheadingskip = 15pt plus 4pt minus 2pt
6380 \secheadingskip = 12pt plus 3pt minus 2pt
6381 \subsecheadingskip = 9pt plus 2pt minus 2pt
6383 % Prevent underfull vbox error messages.
6384 \vbadness = 10000
6386 % Don't be so finicky about underfull hboxes, either.
6387 \hbadness = 2000
6389 % Following George Bush, just get rid of widows and orphans.
6390 \widowpenalty=10000
6391 \clubpenalty=10000
6393 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6394 % using an old version of TeX, don't do anything. We want the amount of
6395 % stretch added to depend on the line length, hence the dependence on
6396 % \hsize. We call this whenever the paper size is set.
6398 \def\setemergencystretch{%
6399 \ifx\emergencystretch\thisisundefined
6400 % Allow us to assign to \emergencystretch anyway.
6401 \def\emergencystretch{\dimen0}%
6402 \else
6403 \emergencystretch = .15\hsize
6407 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6408 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6409 % physical page width.
6411 % We also call \setleading{\textleading}, so the caller should define
6412 % \textleading. The caller should also set \parskip.
6414 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6415 \voffset = #3\relax
6416 \topskip = #6\relax
6417 \splittopskip = \topskip
6419 \vsize = #1\relax
6420 \advance\vsize by \topskip
6421 \outervsize = \vsize
6422 \advance\outervsize by 2\topandbottommargin
6423 \pageheight = \vsize
6425 \hsize = #2\relax
6426 \outerhsize = \hsize
6427 \advance\outerhsize by 0.5in
6428 \pagewidth = \hsize
6430 \normaloffset = #4\relax
6431 \bindingoffset = #5\relax
6433 \ifpdf
6434 \pdfpageheight #7\relax
6435 \pdfpagewidth #8\relax
6438 \setleading{\textleading}
6440 \parindent = \defaultparindent
6441 \setemergencystretch
6444 % @letterpaper (the default).
6445 \def\letterpaper{{\globaldefs = 1
6446 \parskip = 3pt plus 2pt minus 1pt
6447 \textleading = 13.2pt
6449 % If page is nothing but text, make it come out even.
6450 \internalpagesizes{46\baselineskip}{6in}%
6451 {\voffset}{.25in}%
6452 {\bindingoffset}{36pt}%
6453 {11in}{8.5in}%
6456 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6457 \def\smallbook{{\globaldefs = 1
6458 \parskip = 2pt plus 1pt
6459 \textleading = 12pt
6461 \internalpagesizes{7.5in}{5in}%
6462 {\voffset}{.25in}%
6463 {\bindingoffset}{16pt}%
6464 {9.25in}{7in}%
6466 \lispnarrowing = 0.3in
6467 \tolerance = 700
6468 \hfuzz = 1pt
6469 \contentsrightmargin = 0pt
6470 \defbodyindent = .5cm
6473 % Use @afourpaper to print on European A4 paper.
6474 \def\afourpaper{{\globaldefs = 1
6475 \parskip = 3pt plus 2pt minus 1pt
6476 \textleading = 13.2pt
6478 % Double-side printing via postscript on Laserjet 4050
6479 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6480 % To change the settings for a different printer or situation, adjust
6481 % \normaloffset until the front-side and back-side texts align. Then
6482 % do the same for \bindingoffset. You can set these for testing in
6483 % your texinfo source file like this:
6484 % @tex
6485 % \global\normaloffset = -6mm
6486 % \global\bindingoffset = 10mm
6487 % @end tex
6488 \internalpagesizes{51\baselineskip}{160mm}
6489 {\voffset}{\hoffset}%
6490 {\bindingoffset}{44pt}%
6491 {297mm}{210mm}%
6493 \tolerance = 700
6494 \hfuzz = 1pt
6495 \contentsrightmargin = 0pt
6496 \defbodyindent = 5mm
6499 % Use @afivepaper to print on European A5 paper.
6500 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6501 % He also recommends making @example and @lisp be small.
6502 \def\afivepaper{{\globaldefs = 1
6503 \parskip = 2pt plus 1pt minus 0.1pt
6504 \textleading = 12.5pt
6506 \internalpagesizes{160mm}{120mm}%
6507 {\voffset}{\hoffset}%
6508 {\bindingoffset}{8pt}%
6509 {210mm}{148mm}%
6511 \lispnarrowing = 0.2in
6512 \tolerance = 800
6513 \hfuzz = 1.2pt
6514 \contentsrightmargin = 0pt
6515 \defbodyindent = 2mm
6516 \tableindent = 12mm
6519 % A specific text layout, 24x15cm overall, intended for A4 paper.
6520 \def\afourlatex{{\globaldefs = 1
6521 \afourpaper
6522 \internalpagesizes{237mm}{150mm}%
6523 {\voffset}{4.6mm}%
6524 {\bindingoffset}{7mm}%
6525 {297mm}{210mm}%
6527 % Must explicitly reset to 0 because we call \afourpaper.
6528 \globaldefs = 0
6531 % Use @afourwide to print on A4 paper in landscape format.
6532 \def\afourwide{{\globaldefs = 1
6533 \afourpaper
6534 \internalpagesizes{241mm}{165mm}%
6535 {\voffset}{-2.95mm}%
6536 {\bindingoffset}{7mm}%
6537 {297mm}{210mm}%
6538 \globaldefs = 0
6541 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6542 % Perhaps we should allow setting the margins, \topskip, \parskip,
6543 % and/or leading, also. Or perhaps we should compute them somehow.
6545 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
6546 \def\pagesizesyyy#1,#2,#3\finish{{%
6547 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
6548 \globaldefs = 1
6550 \parskip = 3pt plus 2pt minus 1pt
6551 \setleading{\textleading}%
6553 \dimen0 = #1
6554 \advance\dimen0 by \voffset
6556 \dimen2 = \hsize
6557 \advance\dimen2 by \normaloffset
6559 \internalpagesizes{#1}{\hsize}%
6560 {\voffset}{\normaloffset}%
6561 {\bindingoffset}{44pt}%
6562 {\dimen0}{\dimen2}%
6565 % Set default to letter.
6567 \letterpaper
6570 \message{and turning on texinfo input format.}
6572 % Define macros to output various characters with catcode for normal text.
6573 \catcode`\"=\other
6574 \catcode`\~=\other
6575 \catcode`\^=\other
6576 \catcode`\_=\other
6577 \catcode`\|=\other
6578 \catcode`\<=\other
6579 \catcode`\>=\other
6580 \catcode`\+=\other
6581 \catcode`\$=\other
6582 \def\normaldoublequote{"}
6583 \def\normaltilde{~}
6584 \def\normalcaret{^}
6585 \def\normalunderscore{_}
6586 \def\normalverticalbar{|}
6587 \def\normalless{<}
6588 \def\normalgreater{>}
6589 \def\normalplus{+}
6590 \def\normaldollar{$}%$ font-lock fix
6592 % This macro is used to make a character print one way in \tt
6593 % (where it can probably be output as-is), and another way in other fonts,
6594 % where something hairier probably needs to be done.
6596 % #1 is what to print if we are indeed using \tt; #2 is what to print
6597 % otherwise. Since all the Computer Modern typewriter fonts have zero
6598 % interword stretch (and shrink), and it is reasonable to expect all
6599 % typewriter fonts to have this, we can check that font parameter.
6601 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
6603 % Same as above, but check for italic font. Actually this also catches
6604 % non-italic slanted fonts since it is impossible to distinguish them from
6605 % italic fonts. But since this is only used by $ and it uses \sl anyway
6606 % this is not a problem.
6607 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
6609 % Turn off all special characters except @
6610 % (and those which the user can use as if they were ordinary).
6611 % Most of these we simply print from the \tt font, but for some, we can
6612 % use math or other variants that look better in normal text.
6614 \catcode`\"=\active
6615 \def\activedoublequote{{\tt\char34}}
6616 \let"=\activedoublequote
6617 \catcode`\~=\active
6618 \def~{{\tt\char126}}
6619 \chardef\hat=`\^
6620 \catcode`\^=\active
6621 \def^{{\tt \hat}}
6623 \catcode`\_=\active
6624 \def_{\ifusingtt\normalunderscore\_}
6625 % Subroutine for the previous macro.
6626 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
6628 \catcode`\|=\active
6629 \def|{{\tt\char124}}
6630 \chardef \less=`\<
6631 \catcode`\<=\active
6632 \def<{{\tt \less}}
6633 \chardef \gtr=`\>
6634 \catcode`\>=\active
6635 \def>{{\tt \gtr}}
6636 \catcode`\+=\active
6637 \def+{{\tt \char 43}}
6638 \catcode`\$=\active
6639 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
6641 % If a .fmt file is being used, characters that might appear in a file
6642 % name cannot be active until we have parsed the command line.
6643 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6644 % \otherifyactive is called near the end of this file.
6645 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
6647 \catcode`\@=0
6649 % \backslashcurfont outputs one backslash character in current font,
6650 % as in \char`\\.
6651 \global\chardef\backslashcurfont=`\\
6653 % \rawbackslash defines an active \ to do \backslashcurfont.
6654 % \otherbackslash defines an active \ to be a literal `\' character with
6655 % catcode other.
6656 {\catcode`\\=\active
6657 @gdef@rawbackslash{@let\=@backslashcurfont}
6658 @gdef@otherbackslash{@let\=@realbackslash}
6661 % \realbackslash is an actual character `\' with catcode other.
6662 {\catcode`\\=\other @gdef@realbackslash{\}}
6664 % \normalbackslash outputs one backslash in fixed width font.
6665 \def\normalbackslash{{\tt\backslashcurfont}}
6667 \catcode`\\=\active
6669 % Used sometimes to turn off (effectively) the active characters
6670 % even after parsing them.
6671 @def@turnoffactive{%
6672 @let"=@normaldoublequote
6673 @let\=@realbackslash
6674 @let~=@normaltilde
6675 @let^=@normalcaret
6676 @let_=@normalunderscore
6677 @let|=@normalverticalbar
6678 @let<=@normalless
6679 @let>=@normalgreater
6680 @let+=@normalplus
6681 @let$=@normaldollar %$ font-lock fix
6682 @unsepspaces
6685 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6686 % the literal character `\'. (Thus, \ is not expandable when this is in
6687 % effect.)
6689 @def@normalturnoffactive{@turnoffactive @let\=@normalbackslash}
6691 % Make _ and + \other characters, temporarily.
6692 % This is canceled by @fixbackslash.
6693 @otherifyactive
6695 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6696 % That is what \eatinput is for; after that, the `\' should revert to printing
6697 % a backslash.
6699 @gdef@eatinput input texinfo{@fixbackslash}
6700 @global@let\ = @eatinput
6702 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6703 % the first `\{ in the file would cause an error. This macro tries to fix
6704 % that, assuming it is called before the first `\' could plausibly occur.
6705 % Also back turn on active characters that might appear in the input
6706 % file name, in case not using a pre-dumped format.
6708 @gdef@fixbackslash{%
6709 @ifx\@eatinput @let\ = @normalbackslash @fi
6710 @catcode`+=@active
6711 @catcode`@_=@active
6714 % Say @foo, not \foo, in error messages.
6715 @escapechar = `@@
6717 % These look ok in all fonts, so just make them not special.
6718 @catcode`@& = @other
6719 @catcode`@# = @other
6720 @catcode`@% = @other
6723 @c Local variables:
6724 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6725 @c page-delimiter: "^\\\\message"
6726 @c time-stamp-start: "def\\\\texinfoversion{"
6727 @c time-stamp-format: "%:y-%02m-%02d.%02H"
6728 @c time-stamp-end: "}"
6729 @c End:
6731 @c vim:sw=2:
6733 @ignore
6734 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
6735 @end ignore