did make dist
[findutils.git] / doc / texinfo.tex
blobab95370db4971ed1ec432d0629d452511ae446e8
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{2006-10-15.13}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10 % Software Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 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., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, 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\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexrbrace=\}
99 \let\ptexslash=\/
100 \let\ptexstar=\*
101 \let\ptext=\t
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
105 \newlinechar = `^^J
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
112 \else
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\colonChar = `\:
162 \chardef\commaChar = `\,
163 \chardef\dashChar = `\-
164 \chardef\dotChar = `\.
165 \chardef\exclamChar= `\!
166 \chardef\lquoteChar= `\`
167 \chardef\questChar = `\?
168 \chardef\rquoteChar= `\'
169 \chardef\semiChar = `\;
170 \chardef\underChar = `\_
172 % Ignore a token.
174 \def\gobble#1{}
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
179 % Hyphenation fixes.
180 \hyphenation{
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 spell-ing spell-ings
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
191 % Margin to add to right of even pages, to left of odd pages.
192 \newdimen\bindingoffset
193 \newdimen\normaloffset
194 \newdimen\pagewidth \newdimen\pageheight
196 % For a final copy, take out the rectangles
197 % that mark overfull boxes (in case you have decided
198 % that the text looks ok even though it passes the margin).
200 \def\finalout{\overfullrule=0pt}
202 % @| inserts a changebar to the left of the current line. It should
203 % surround any changed text. This approach does *not* work if the
204 % change spans more than two lines of output. To handle that, we would
205 % have adopt a much more difficult approach (putting marks into the main
206 % vertical list for the beginning and end of each change).
208 \def\|{%
209 % \vadjust can only be used in horizontal mode.
210 \leavevmode
212 % Append this vertical mode material after the current line in the output.
213 \vadjust{%
214 % We want to insert a rule with the height and depth of the current
215 % leading; that is exactly what \strutbox is supposed to record.
216 \vskip-\baselineskip
218 % \vadjust-items are inserted at the left edge of the type. So
219 % the \llap here moves out into the left-hand margin.
220 \llap{%
222 % For a thicker or thinner bar, change the `1pt'.
223 \vrule height\baselineskip width1pt
225 % This is the space between the bar and the text.
226 \hskip 12pt
231 % Sometimes it is convenient to have everything in the transcript file
232 % and nothing on the terminal. We don't just call \tracingall here,
233 % since that produces some useless output on the terminal. We also make
234 % some effort to order the tracing commands to reduce output in the log
235 % file; cf. trace.sty in LaTeX.
237 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
238 \def\loggingall{%
239 \tracingstats2
240 \tracingpages1
241 \tracinglostchars2 % 2 gives us more in etex
242 \tracingparagraphs1
243 \tracingoutput1
244 \tracingmacros2
245 \tracingrestores1
246 \showboxbreadth\maxdimen \showboxdepth\maxdimen
247 \ifx\eTeXversion\undefined\else % etex gives us more logging
248 \tracingscantokens1
249 \tracingifs1
250 \tracinggroups1
251 \tracingnesting2
252 \tracingassigns1
254 \tracingcommands3 % 3 gives us more in etex
255 \errorcontextlines16
258 % add check for \lastpenalty to plain's definitions. If the last thing
259 % we did was a \nobreak, we don't want to insert more space.
261 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
262 \removelastskip\penalty-50\smallskip\fi\fi}
263 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
264 \removelastskip\penalty-100\medskip\fi\fi}
265 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
266 \removelastskip\penalty-200\bigskip\fi\fi}
268 % For @cropmarks command.
269 % Do @cropmarks to get crop marks.
271 \newif\ifcropmarks
272 \let\cropmarks = \cropmarkstrue
274 % Dimensions to add cropmarks at corners.
275 % Added by P. A. MacKay, 12 Nov. 1986
277 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
278 \newdimen\cornerlong \cornerlong=1pc
279 \newdimen\cornerthick \cornerthick=.3pt
280 \newdimen\topandbottommargin \topandbottommargin=.75in
282 % Main output routine.
283 \chardef\PAGE = 255
284 \output = {\onepageout{\pagecontents\PAGE}}
286 \newbox\headlinebox
287 \newbox\footlinebox
289 % \onepageout takes a vbox as an argument. Note that \pagecontents
290 % does insertions, but you have to call it yourself.
291 \def\onepageout#1{%
292 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
294 \ifodd\pageno \advance\hoffset by \bindingoffset
295 \else \advance\hoffset by -\bindingoffset\fi
297 % Do this outside of the \shipout so @code etc. will be expanded in
298 % the headline as they should be, not taken literally (outputting ''code).
299 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
300 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
303 % Have to do this stuff outside the \shipout because we want it to
304 % take effect in \write's, yet the group defined by the \vbox ends
305 % before the \shipout runs.
307 \indexdummies % don't expand commands in the output.
308 \normalturnoffactive % \ in index entries must not stay \, e.g., if
309 % the page break happens to be in the middle of an example.
310 % We don't want .vr (or whatever) entries like this:
311 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
312 % "\acronym" won't work when it's read back in;
313 % it needs to be
314 % {\code {{\tt \backslashcurfont }acronym}
315 \shipout\vbox{%
316 % Do this early so pdf references go to the beginning of the page.
317 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
319 \ifcropmarks \vbox to \outervsize\bgroup
320 \hsize = \outerhsize
321 \vskip-\topandbottommargin
322 \vtop to0pt{%
323 \line{\ewtop\hfil\ewtop}%
324 \nointerlineskip
325 \line{%
326 \vbox{\moveleft\cornerthick\nstop}%
327 \hfill
328 \vbox{\moveright\cornerthick\nstop}%
330 \vss}%
331 \vskip\topandbottommargin
332 \line\bgroup
333 \hfil % center the page within the outer (page) hsize.
334 \ifodd\pageno\hskip\bindingoffset\fi
335 \vbox\bgroup
338 \unvbox\headlinebox
339 \pagebody{#1}%
340 \ifdim\ht\footlinebox > 0pt
341 % Only leave this space if the footline is nonempty.
342 % (We lessened \vsize for it in \oddfootingyyy.)
343 % The \baselineskip=24pt in plain's \makefootline has no effect.
344 \vskip 24pt
345 \unvbox\footlinebox
348 \ifcropmarks
349 \egroup % end of \vbox\bgroup
350 \hfil\egroup % end of (centering) \line\bgroup
351 \vskip\topandbottommargin plus1fill minus1fill
352 \boxmaxdepth = \cornerthick
353 \vbox to0pt{\vss
354 \line{%
355 \vbox{\moveleft\cornerthick\nsbot}%
356 \hfill
357 \vbox{\moveright\cornerthick\nsbot}%
359 \nointerlineskip
360 \line{\ewbot\hfil\ewbot}%
362 \egroup % \vbox from first cropmarks clause
364 }% end of \shipout\vbox
365 }% end of group with \indexdummies
366 \advancepageno
367 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
370 \newinsert\margin \dimen\margin=\maxdimen
372 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
373 {\catcode`\@ =11
374 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
375 % marginal hacks, juha@viisa.uucp (Juha Takala)
376 \ifvoid\margin\else % marginal info is present
377 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
378 \dimen@=\dp#1 \unvbox#1
379 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
380 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
383 % Here are the rules for the cropmarks. Note that they are
384 % offset so that the space between them is truly \outerhsize or \outervsize
385 % (P. A. MacKay, 12 November, 1986)
387 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
388 \def\nstop{\vbox
389 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
390 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
391 \def\nsbot{\vbox
392 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
394 % Parse an argument, then pass it to #1. The argument is the rest of
395 % the input line (except we remove a trailing comment). #1 should be a
396 % macro which expects an ordinary undelimited TeX argument.
398 \def\parsearg{\parseargusing{}}
399 \def\parseargusing#1#2{%
400 \def\argtorun{#2}%
401 \begingroup
402 \obeylines
403 \spaceisspace
405 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
408 {\obeylines %
409 \gdef\parseargline#1^^M{%
410 \endgroup % End of the group started in \parsearg.
411 \argremovecomment #1\comment\ArgTerm%
415 % First remove any @comment, then any @c comment.
416 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
417 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
419 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
421 % \argremovec might leave us with trailing space, e.g.,
422 % @end itemize @c foo
423 % This space token undergoes the same procedure and is eventually removed
424 % by \finishparsearg.
426 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
427 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
428 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
429 \def\temp{#3}%
430 \ifx\temp\empty
431 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
432 \let\temp\finishparsearg
433 \else
434 \let\temp\argcheckspaces
436 % Put the space token in:
437 \temp#1 #3\ArgTerm
440 % If a _delimited_ argument is enclosed in braces, they get stripped; so
441 % to get _exactly_ the rest of the line, we had to prevent such situation.
442 % We prepended an \empty token at the very beginning and we expand it now,
443 % just before passing the control to \argtorun.
444 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
445 % either the null string, or it ends with \^^M---thus there is no danger
446 % that a pair of braces would be stripped.
448 % But first, we have to remove the trailing space token.
450 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
452 % \parseargdef\foo{...}
453 % is roughly equivalent to
454 % \def\foo{\parsearg\Xfoo}
455 % \def\Xfoo#1{...}
457 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
458 % favourite TeX trick. --kasal, 16nov03
460 \def\parseargdef#1{%
461 \expandafter \doparseargdef \csname\string#1\endcsname #1%
463 \def\doparseargdef#1#2{%
464 \def#2{\parsearg#1}%
465 \def#1##1%
468 % Several utility definitions with active space:
470 \obeyspaces
471 \gdef\obeyedspace{ }
473 % Make each space character in the input produce a normal interword
474 % space in the output. Don't allow a line break at this space, as this
475 % is used only in environments like @example, where each line of input
476 % should produce a line of output anyway.
478 \gdef\sepspaces{\obeyspaces\let =\tie}
480 % If an index command is used in an @example environment, any spaces
481 % therein should become regular spaces in the raw index file, not the
482 % expansion of \tie (\leavevmode \penalty \@M \ ).
483 \gdef\unsepspaces{\let =\space}
487 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
489 % Define the framework for environments in texinfo.tex. It's used like this:
491 % \envdef\foo{...}
492 % \def\Efoo{...}
494 % It's the responsibility of \envdef to insert \begingroup before the
495 % actual body; @end closes the group after calling \Efoo. \envdef also
496 % defines \thisenv, so the current environment is known; @end checks
497 % whether the environment name matches. The \checkenv macro can also be
498 % used to check whether the current environment is the one expected.
500 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
501 % are not treated as enviroments; they don't open a group. (The
502 % implementation of @end takes care not to call \endgroup in this
503 % special case.)
506 % At runtime, environments start with this:
507 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
508 % initialize
509 \let\thisenv\empty
511 % ... but they get defined via ``\envdef\foo{...}'':
512 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
513 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
515 % Check whether we're in the right environment:
516 \def\checkenv#1{%
517 \def\temp{#1}%
518 \ifx\thisenv\temp
519 \else
520 \badenverr
524 % Evironment mismatch, #1 expected:
525 \def\badenverr{%
526 \errhelp = \EMsimple
527 \errmessage{This command can appear only \inenvironment\temp,
528 not \inenvironment\thisenv}%
530 \def\inenvironment#1{%
531 \ifx#1\empty
532 out of any environment%
533 \else
534 in environment \expandafter\string#1%
538 % @end foo executes the definition of \Efoo.
539 % But first, it executes a specialized version of \checkenv
541 \parseargdef\end{%
542 \if 1\csname iscond.#1\endcsname
543 \else
544 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
545 \expandafter\checkenv\csname#1\endcsname
546 \csname E#1\endcsname
547 \endgroup
551 \newhelp\EMsimple{Press RETURN to continue.}
554 %% Simple single-character @ commands
556 % @@ prints an @
557 % Kludge this until the fonts are right (grr).
558 \def\@{{\tt\char64}}
560 % This is turned off because it was never documented
561 % and you can use @w{...} around a quote to suppress ligatures.
562 %% Define @` and @' to be the same as ` and '
563 %% but suppressing ligatures.
564 %\def\`{{`}}
565 %\def\'{{'}}
567 % Used to generate quoted braces.
568 \def\mylbrace {{\tt\char123}}
569 \def\myrbrace {{\tt\char125}}
570 \let\{=\mylbrace
571 \let\}=\myrbrace
572 \begingroup
573 % Definitions to produce \{ and \} commands for indices,
574 % and @{ and @} for the aux/toc files.
575 \catcode`\{ = \other \catcode`\} = \other
576 \catcode`\[ = 1 \catcode`\] = 2
577 \catcode`\! = 0 \catcode`\\ = \other
578 !gdef!lbracecmd[\{]%
579 !gdef!rbracecmd[\}]%
580 !gdef!lbraceatcmd[@{]%
581 !gdef!rbraceatcmd[@}]%
582 !endgroup
584 % @comma{} to avoid , parsing problems.
585 \let\comma = ,
587 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
588 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
589 \let\, = \c
590 \let\dotaccent = \.
591 \def\ringaccent#1{{\accent23 #1}}
592 \let\tieaccent = \t
593 \let\ubaraccent = \b
594 \let\udotaccent = \d
596 % Other special characters: @questiondown @exclamdown @ordf @ordm
597 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
598 \def\questiondown{?`}
599 \def\exclamdown{!`}
600 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
601 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
603 % Dotless i and dotless j, used for accents.
604 \def\imacro{i}
605 \def\jmacro{j}
606 \def\dotless#1{%
607 \def\temp{#1}%
608 \ifx\temp\imacro \ptexi
609 \else\ifx\temp\jmacro \j
610 \else \errmessage{@dotless can be used only with i or j}%
611 \fi\fi
614 % The \TeX{} logo, as in plain, but resetting the spacing so that a
615 % period following counts as ending a sentence. (Idea found in latex.)
617 \edef\TeX{\TeX \spacefactor=1000 }
619 % @LaTeX{} logo. Not quite the same results as the definition in
620 % latex.ltx, since we use a different font for the raised A; it's most
621 % convenient for us to use an explicitly smaller font, rather than using
622 % the \scriptstyle font (since we don't reset \scriptstyle and
623 % \scriptscriptstyle).
625 \def\LaTeX{%
626 L\kern-.36em
627 {\setbox0=\hbox{T}%
628 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
629 \kern-.15em
630 \TeX
633 % Be sure we're in horizontal mode when doing a tie, since we make space
634 % equivalent to this in @example-like environments. Otherwise, a space
635 % at the beginning of a line will start with \penalty -- and
636 % since \penalty is valid in vertical mode, we'd end up putting the
637 % penalty on the vertical list instead of in the new paragraph.
638 {\catcode`@ = 11
639 % Avoid using \@M directly, because that causes trouble
640 % if the definition is written into an index file.
641 \global\let\tiepenalty = \@M
642 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
645 % @: forces normal size whitespace following.
646 \def\:{\spacefactor=1000 }
648 % @* forces a line break.
649 \def\*{\hfil\break\hbox{}\ignorespaces}
651 % @/ allows a line break.
652 \let\/=\allowbreak
654 % @. is an end-of-sentence period.
655 \def\.{.\spacefactor=\endofsentencespacefactor\space}
657 % @! is an end-of-sentence bang.
658 \def\!{!\spacefactor=\endofsentencespacefactor\space}
660 % @? is an end-of-sentence query.
661 \def\?{?\spacefactor=\endofsentencespacefactor\space}
663 % @frenchspacing on|off says whether to put extra space after punctuation.
665 \def\onword{on}
666 \def\offword{off}
668 \parseargdef\frenchspacing{%
669 \def\temp{#1}%
670 \ifx\temp\onword \plainfrenchspacing
671 \else\ifx\temp\offword \plainnonfrenchspacing
672 \else
673 \errhelp = \EMsimple
674 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
675 \fi\fi
678 % @w prevents a word break. Without the \leavevmode, @w at the
679 % beginning of a paragraph, when TeX is still in vertical mode, would
680 % produce a whole line of output instead of starting the paragraph.
681 \def\w#1{\leavevmode\hbox{#1}}
683 % @group ... @end group forces ... to be all on one page, by enclosing
684 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
685 % to keep its height that of a normal line. According to the rules for
686 % \topskip (p.114 of the TeXbook), the glue inserted is
687 % max (\topskip - \ht (first item), 0). If that height is large,
688 % therefore, no glue is inserted, and the space between the headline and
689 % the text is small, which looks bad.
691 % Another complication is that the group might be very large. This can
692 % cause the glue on the previous page to be unduly stretched, because it
693 % does not have much material. In this case, it's better to add an
694 % explicit \vfill so that the extra space is at the bottom. The
695 % threshold for doing this is if the group is more than \vfilllimit
696 % percent of a page (\vfilllimit can be changed inside of @tex).
698 \newbox\groupbox
699 \def\vfilllimit{0.7}
701 \envdef\group{%
702 \ifnum\catcode`\^^M=\active \else
703 \errhelp = \groupinvalidhelp
704 \errmessage{@group invalid in context where filling is enabled}%
706 \startsavinginserts
708 \setbox\groupbox = \vtop\bgroup
709 % Do @comment since we are called inside an environment such as
710 % @example, where each end-of-line in the input causes an
711 % end-of-line in the output. We don't want the end-of-line after
712 % the `@group' to put extra space in the output. Since @group
713 % should appear on a line by itself (according to the Texinfo
714 % manual), we don't worry about eating any user text.
715 \comment
718 % The \vtop produces a box with normal height and large depth; thus, TeX puts
719 % \baselineskip glue before it, and (when the next line of text is done)
720 % \lineskip glue after it. Thus, space below is not quite equal to space
721 % above. But it's pretty close.
722 \def\Egroup{%
723 % To get correct interline space between the last line of the group
724 % and the first line afterwards, we have to propagate \prevdepth.
725 \endgraf % Not \par, as it may have been set to \lisppar.
726 \global\dimen1 = \prevdepth
727 \egroup % End the \vtop.
728 % \dimen0 is the vertical size of the group's box.
729 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
730 % \dimen2 is how much space is left on the page (more or less).
731 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
732 % if the group doesn't fit on the current page, and it's a big big
733 % group, force a page break.
734 \ifdim \dimen0 > \dimen2
735 \ifdim \pagetotal < \vfilllimit\pageheight
736 \page
739 \box\groupbox
740 \prevdepth = \dimen1
741 \checkinserts
744 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
745 % message, so this ends up printing `@group can only ...'.
747 \newhelp\groupinvalidhelp{%
748 group can only be used in environments such as @example,^^J%
749 where each line of input produces a line of output.}
751 % @need space-in-mils
752 % forces a page break if there is not space-in-mils remaining.
754 \newdimen\mil \mil=0.001in
756 % Old definition--didn't work.
757 %\parseargdef\need{\par %
758 %% This method tries to make TeX break the page naturally
759 %% if the depth of the box does not fit.
760 %{\baselineskip=0pt%
761 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
762 %\prevdepth=-1000pt
765 \parseargdef\need{%
766 % Ensure vertical mode, so we don't make a big box in the middle of a
767 % paragraph.
768 \par
770 % If the @need value is less than one line space, it's useless.
771 \dimen0 = #1\mil
772 \dimen2 = \ht\strutbox
773 \advance\dimen2 by \dp\strutbox
774 \ifdim\dimen0 > \dimen2
776 % Do a \strut just to make the height of this box be normal, so the
777 % normal leading is inserted relative to the preceding line.
778 % And a page break here is fine.
779 \vtop to #1\mil{\strut\vfil}%
781 % TeX does not even consider page breaks if a penalty added to the
782 % main vertical list is 10000 or more. But in order to see if the
783 % empty box we just added fits on the page, we must make it consider
784 % page breaks. On the other hand, we don't want to actually break the
785 % page after the empty box. So we use a penalty of 9999.
787 % There is an extremely small chance that TeX will actually break the
788 % page at this \penalty, if there are no other feasible breakpoints in
789 % sight. (If the user is using lots of big @group commands, which
790 % almost-but-not-quite fill up a page, TeX will have a hard time doing
791 % good page breaking, for example.) However, I could not construct an
792 % example where a page broke at this \penalty; if it happens in a real
793 % document, then we can reconsider our strategy.
794 \penalty9999
796 % Back up by the size of the box, whether we did a page break or not.
797 \kern -#1\mil
799 % Do not allow a page break right after this kern.
800 \nobreak
804 % @br forces paragraph break (and is undocumented).
806 \let\br = \par
808 % @page forces the start of a new page.
810 \def\page{\par\vfill\supereject}
812 % @exdent text....
813 % outputs text on separate line in roman font, starting at standard page margin
815 % This records the amount of indent in the innermost environment.
816 % That's how much \exdent should take out.
817 \newskip\exdentamount
819 % This defn is used inside fill environments such as @defun.
820 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
822 % This defn is used inside nofill environments such as @example.
823 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
824 \leftline{\hskip\leftskip{\rm#1}}}}
826 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
827 % paragraph. For more general purposes, use the \margin insertion
828 % class. WHICH is `l' or `r'.
830 \newskip\inmarginspacing \inmarginspacing=1cm
831 \def\strutdepth{\dp\strutbox}
833 \def\doinmargin#1#2{\strut\vadjust{%
834 \nobreak
835 \kern-\strutdepth
836 \vtop to \strutdepth{%
837 \baselineskip=\strutdepth
838 \vss
839 % if you have multiple lines of stuff to put here, you'll need to
840 % make the vbox yourself of the appropriate size.
841 \ifx#1l%
842 \llap{\ignorespaces #2\hskip\inmarginspacing}%
843 \else
844 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
846 \null
849 \def\inleftmargin{\doinmargin l}
850 \def\inrightmargin{\doinmargin r}
852 % @inmargin{TEXT [, RIGHT-TEXT]}
853 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
854 % else use TEXT for both).
856 \def\inmargin#1{\parseinmargin #1,,\finish}
857 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
858 \setbox0 = \hbox{\ignorespaces #2}%
859 \ifdim\wd0 > 0pt
860 \def\lefttext{#1}% have both texts
861 \def\righttext{#2}%
862 \else
863 \def\lefttext{#1}% have only one text
864 \def\righttext{#1}%
867 \ifodd\pageno
868 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
869 \else
870 \def\temp{\inleftmargin\lefttext}%
872 \temp
875 % @include file insert text of that file as input.
877 \def\include{\parseargusing\filenamecatcodes\includezzz}
878 \def\includezzz#1{%
879 \pushthisfilestack
880 \def\thisfile{#1}%
882 \makevalueexpandable
883 \def\temp{\input #1 }%
884 \expandafter
885 }\temp
886 \popthisfilestack
888 \def\filenamecatcodes{%
889 \catcode`\\=\other
890 \catcode`~=\other
891 \catcode`^=\other
892 \catcode`_=\other
893 \catcode`|=\other
894 \catcode`<=\other
895 \catcode`>=\other
896 \catcode`+=\other
897 \catcode`-=\other
900 \def\pushthisfilestack{%
901 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
903 \def\pushthisfilestackX{%
904 \expandafter\pushthisfilestackY\thisfile\StackTerm
906 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
907 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
910 \def\popthisfilestack{\errthisfilestackempty}
911 \def\errthisfilestackempty{\errmessage{Internal error:
912 the stack of filenames is empty.}}
914 \def\thisfile{}
916 % @center line
917 % outputs that line, centered.
919 \parseargdef\center{%
920 \ifhmode
921 \let\next\centerH
922 \else
923 \let\next\centerV
925 \next{\hfil \ignorespaces#1\unskip \hfil}%
927 \def\centerH#1{%
929 \hfil\break
930 \advance\hsize by -\leftskip
931 \advance\hsize by -\rightskip
932 \line{#1}%
933 \break
936 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
938 % @sp n outputs n lines of vertical space
940 \parseargdef\sp{\vskip #1\baselineskip}
942 % @comment ...line which is ignored...
943 % @c is the same as @comment
944 % @ignore ... @end ignore is another way to write a comment
946 \def\comment{\begingroup \catcode`\^^M=\other%
947 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
948 \commentxxx}
949 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
951 \let\c=\comment
953 % @paragraphindent NCHARS
954 % We'll use ems for NCHARS, close enough.
955 % NCHARS can also be the word `asis' or `none'.
956 % We cannot feasibly implement @paragraphindent asis, though.
958 \def\asisword{asis} % no translation, these are keywords
959 \def\noneword{none}
961 \parseargdef\paragraphindent{%
962 \def\temp{#1}%
963 \ifx\temp\asisword
964 \else
965 \ifx\temp\noneword
966 \defaultparindent = 0pt
967 \else
968 \defaultparindent = #1em
971 \parindent = \defaultparindent
974 % @exampleindent NCHARS
975 % We'll use ems for NCHARS like @paragraphindent.
976 % It seems @exampleindent asis isn't necessary, but
977 % I preserve it to make it similar to @paragraphindent.
978 \parseargdef\exampleindent{%
979 \def\temp{#1}%
980 \ifx\temp\asisword
981 \else
982 \ifx\temp\noneword
983 \lispnarrowing = 0pt
984 \else
985 \lispnarrowing = #1em
990 % @firstparagraphindent WORD
991 % If WORD is `none', then suppress indentation of the first paragraph
992 % after a section heading. If WORD is `insert', then do indent at such
993 % paragraphs.
995 % The paragraph indentation is suppressed or not by calling
996 % \suppressfirstparagraphindent, which the sectioning commands do.
997 % We switch the definition of this back and forth according to WORD.
998 % By default, we suppress indentation.
1000 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1001 \def\insertword{insert}
1003 \parseargdef\firstparagraphindent{%
1004 \def\temp{#1}%
1005 \ifx\temp\noneword
1006 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1007 \else\ifx\temp\insertword
1008 \let\suppressfirstparagraphindent = \relax
1009 \else
1010 \errhelp = \EMsimple
1011 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1012 \fi\fi
1015 % Here is how we actually suppress indentation. Redefine \everypar to
1016 % \kern backwards by \parindent, and then reset itself to empty.
1018 % We also make \indent itself not actually do anything until the next
1019 % paragraph.
1021 \gdef\dosuppressfirstparagraphindent{%
1022 \gdef\indent{%
1023 \restorefirstparagraphindent
1024 \indent
1026 \gdef\noindent{%
1027 \restorefirstparagraphindent
1028 \noindent
1030 \global\everypar = {%
1031 \kern -\parindent
1032 \restorefirstparagraphindent
1036 \gdef\restorefirstparagraphindent{%
1037 \global \let \indent = \ptexindent
1038 \global \let \noindent = \ptexnoindent
1039 \global \everypar = {}%
1043 % @asis just yields its argument. Used with @table, for example.
1045 \def\asis#1{#1}
1047 % @math outputs its argument in math mode.
1049 % One complication: _ usually means subscripts, but it could also mean
1050 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1051 % _ active, and distinguish by seeing if the current family is \slfam,
1052 % which is what @var uses.
1054 \catcode`\_ = \active
1055 \gdef\mathunderscore{%
1056 \catcode`\_=\active
1057 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1060 % Another complication: we want \\ (and @\) to output a \ character.
1061 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1062 % this is not advertised and we don't care. Texinfo does not
1063 % otherwise define @\.
1065 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1066 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1068 \def\math{%
1069 \tex
1070 \mathunderscore
1071 \let\\ = \mathbackslash
1072 \mathactive
1073 $\finishmath
1075 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1077 % Some active characters (such as <) are spaced differently in math.
1078 % We have to reset their definitions in case the @math was an argument
1079 % to a command which sets the catcodes (such as @item or @section).
1082 \catcode`^ = \active
1083 \catcode`< = \active
1084 \catcode`> = \active
1085 \catcode`+ = \active
1086 \gdef\mathactive{%
1087 \let^ = \ptexhat
1088 \let< = \ptexless
1089 \let> = \ptexgtr
1090 \let+ = \ptexplus
1094 % @bullet and @minus need the same treatment as @math, just above.
1095 \def\bullet{$\ptexbullet$}
1096 \def\minus{$-$}
1098 % @dots{} outputs an ellipsis using the current font.
1099 % We do .5em per period so that it has the same spacing in the cm
1100 % typewriter fonts as three actual period characters; on the other hand,
1101 % in other typewriter fonts three periods are wider than 1.5em. So do
1102 % whichever is larger.
1104 \def\dots{%
1105 \leavevmode
1106 \setbox0=\hbox{...}% get width of three periods
1107 \ifdim\wd0 > 1.5em
1108 \dimen0 = \wd0
1109 \else
1110 \dimen0 = 1.5em
1112 \hbox to \dimen0{%
1113 \hskip 0pt plus.25fil
1114 .\hskip 0pt plus1fil
1115 .\hskip 0pt plus1fil
1116 .\hskip 0pt plus.5fil
1120 % @enddots{} is an end-of-sentence ellipsis.
1122 \def\enddots{%
1123 \dots
1124 \spacefactor=\endofsentencespacefactor
1127 % @comma{} is so commas can be inserted into text without messing up
1128 % Texinfo's parsing.
1130 \let\comma = ,
1132 % @refill is a no-op.
1133 \let\refill=\relax
1135 % If working on a large document in chapters, it is convenient to
1136 % be able to disable indexing, cross-referencing, and contents, for test runs.
1137 % This is done with @novalidate (before @setfilename).
1139 \newif\iflinks \linkstrue % by default we want the aux files.
1140 \let\novalidate = \linksfalse
1142 % @setfilename is done at the beginning of every texinfo file.
1143 % So open here the files we need to have open while reading the input.
1144 % This makes it possible to make a .fmt file for texinfo.
1145 \def\setfilename{%
1146 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1147 \iflinks
1148 \tryauxfile
1149 % Open the new aux file. TeX will close it automatically at exit.
1150 \immediate\openout\auxfile=\jobname.aux
1151 \fi % \openindices needs to do some work in any case.
1152 \openindices
1153 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1155 % If texinfo.cnf is present on the system, read it.
1156 % Useful for site-wide @afourpaper, etc.
1157 \openin 1 texinfo.cnf
1158 \ifeof 1 \else \input texinfo.cnf \fi
1159 \closein 1
1161 \comment % Ignore the actual filename.
1164 % Called from \setfilename.
1166 \def\openindices{%
1167 \newindex{cp}%
1168 \newcodeindex{fn}%
1169 \newcodeindex{vr}%
1170 \newcodeindex{tp}%
1171 \newcodeindex{ky}%
1172 \newcodeindex{pg}%
1175 % @bye.
1176 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1179 \message{pdf,}
1180 % adobe `portable' document format
1181 \newcount\tempnum
1182 \newcount\lnkcount
1183 \newtoks\filename
1184 \newcount\filenamelength
1185 \newcount\pgn
1186 \newtoks\toksA
1187 \newtoks\toksB
1188 \newtoks\toksC
1189 \newtoks\toksD
1190 \newbox\boxA
1191 \newcount\countA
1192 \newif\ifpdf
1193 \newif\ifpdfmakepagedest
1195 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1196 % can be set). So we test for \relax and 0 as well as \undefined,
1197 % borrowed from ifpdf.sty.
1198 \ifx\pdfoutput\undefined
1199 \else
1200 \ifx\pdfoutput\relax
1201 \else
1202 \ifcase\pdfoutput
1203 \else
1204 \pdftrue
1209 % PDF uses PostScript string constants for the names of xref targets,
1210 % for display in the outlines, and in other places. Thus, we have to
1211 % double any backslashes. Otherwise, a name like "\node" will be
1212 % interpreted as a newline (\n), followed by o, d, e. Not good.
1213 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1214 % (and related messages, the final outcome is that it is up to the TeX
1215 % user to double the backslashes and otherwise make the string valid, so
1216 % that's what we do).
1218 % double active backslashes.
1220 {\catcode`\@=0 \catcode`\\=\active
1221 @gdef@activebackslashdouble{%
1222 @catcode`@\=@active
1223 @let\=@doublebackslash}
1226 % To handle parens, we must adopt a different approach, since parens are
1227 % not active characters. hyperref.dtx (which has the same problem as
1228 % us) handles it with this amazing macro to replace tokens. I've
1229 % tinkered with it a little for texinfo, but it's definitely from there.
1231 % #1 is the tokens to replace.
1232 % #2 is the replacement.
1233 % #3 is the control sequence with the string.
1235 \def\HyPsdSubst#1#2#3{%
1236 \def\HyPsdReplace##1#1##2\END{%
1237 ##1%
1238 \ifx\\##2\\%
1239 \else
1241 \HyReturnAfterFi{%
1242 \HyPsdReplace##2\END
1246 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1248 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1250 % #1 is a control sequence in which to do the replacements.
1251 \def\backslashparens#1{%
1252 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1253 % \lastnode when called from \setref -> \pdfmkdest.
1254 \HyPsdSubst{(}{\realbackslash(}{#1}%
1255 \HyPsdSubst{)}{\realbackslash)}{#1}%
1258 \ifpdf
1259 \input pdfcolor
1260 \pdfcatalog{/PageMode /UseOutlines}%
1261 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1262 \def\dopdfimage#1#2#3{%
1263 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1264 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1265 % without \immediate, pdftex seg faults when the same image is
1266 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1267 \ifnum\pdftexversion < 14
1268 \immediate\pdfimage
1269 \else
1270 \immediate\pdfximage
1272 \ifdim \wd0 >0pt width \imagewidth \fi
1273 \ifdim \wd2 >0pt height \imageheight \fi
1274 \ifnum\pdftexversion<13
1275 #1.pdf%
1276 \else
1277 {#1.pdf}%
1279 \ifnum\pdftexversion < 14 \else
1280 \pdfrefximage \pdflastximage
1281 \fi}
1282 \def\pdfmkdest#1{{%
1283 % We have to set dummies so commands such as @code, and characters
1284 % such as \, aren't expanded when present in a section title.
1285 \atdummies
1286 \activebackslashdouble
1287 \def\pdfdestname{#1}%
1288 \backslashparens\pdfdestname
1289 \pdfdest name{\pdfdestname} xyz%
1292 % used to mark target names; must be expandable.
1293 \def\pdfmkpgn#1{#1}%
1295 \let\linkcolor = \Blue % was Cyan, but that seems light?
1296 \def\endlink{\Black\pdfendlink}
1297 % Adding outlines to PDF; macros for calculating structure of outlines
1298 % come from Petr Olsak
1299 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1300 \else \csname#1\endcsname \fi}
1301 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1302 \advance\tempnum by 1
1303 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1305 % #1 is the section text, which is what will be displayed in the
1306 % outline by the pdf viewer. #2 is the pdf expression for the number
1307 % of subentries (or empty, for subsubsections). #3 is the node text,
1308 % which might be empty if this toc entry had no corresponding node.
1309 % #4 is the page number
1311 \def\dopdfoutline#1#2#3#4{%
1312 % Generate a link to the node text if that exists; else, use the
1313 % page number. We could generate a destination for the section
1314 % text in the case where a section has no node, but it doesn't
1315 % seem worth the trouble, since most documents are normally structured.
1316 \def\pdfoutlinedest{#3}%
1317 \ifx\pdfoutlinedest\empty
1318 \def\pdfoutlinedest{#4}%
1319 \else
1320 % Doubled backslashes in the name.
1321 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1322 \backslashparens\pdfoutlinedest}%
1325 % Also double the backslashes in the display string.
1326 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1327 \backslashparens\pdfoutlinetext}%
1329 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1332 \def\pdfmakeoutlines{%
1333 \begingroup
1334 % Thanh's hack / proper braces in bookmarks
1335 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1336 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1338 % Read toc silently, to get counts of subentries for \pdfoutline.
1339 \def\numchapentry##1##2##3##4{%
1340 \def\thischapnum{##2}%
1341 \def\thissecnum{0}%
1342 \def\thissubsecnum{0}%
1344 \def\numsecentry##1##2##3##4{%
1345 \advancenumber{chap\thischapnum}%
1346 \def\thissecnum{##2}%
1347 \def\thissubsecnum{0}%
1349 \def\numsubsecentry##1##2##3##4{%
1350 \advancenumber{sec\thissecnum}%
1351 \def\thissubsecnum{##2}%
1353 \def\numsubsubsecentry##1##2##3##4{%
1354 \advancenumber{subsec\thissubsecnum}%
1356 \def\thischapnum{0}%
1357 \def\thissecnum{0}%
1358 \def\thissubsecnum{0}%
1360 % use \def rather than \let here because we redefine \chapentry et
1361 % al. a second time, below.
1362 \def\appentry{\numchapentry}%
1363 \def\appsecentry{\numsecentry}%
1364 \def\appsubsecentry{\numsubsecentry}%
1365 \def\appsubsubsecentry{\numsubsubsecentry}%
1366 \def\unnchapentry{\numchapentry}%
1367 \def\unnsecentry{\numsecentry}%
1368 \def\unnsubsecentry{\numsubsecentry}%
1369 \def\unnsubsubsecentry{\numsubsubsecentry}%
1370 \readdatafile{toc}%
1372 % Read toc second time, this time actually producing the outlines.
1373 % The `-' means take the \expnumber as the absolute number of
1374 % subentries, which we calculated on our first read of the .toc above.
1376 % We use the node names as the destinations.
1377 \def\numchapentry##1##2##3##4{%
1378 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1379 \def\numsecentry##1##2##3##4{%
1380 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1381 \def\numsubsecentry##1##2##3##4{%
1382 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1383 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1384 \dopdfoutline{##1}{}{##3}{##4}}%
1386 % PDF outlines are displayed using system fonts, instead of
1387 % document fonts. Therefore we cannot use special characters,
1388 % since the encoding is unknown. For example, the eogonek from
1389 % Latin 2 (0xea) gets translated to a | character. Info from
1390 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1392 % xx to do this right, we have to translate 8-bit characters to
1393 % their "best" equivalent, based on the @documentencoding. Right
1394 % now, I guess we'll just let the pdf reader have its way.
1395 \indexnofonts
1396 \setupdatafile
1397 \catcode`\\=\active \otherbackslash
1398 \input \jobname.toc
1399 \endgroup
1402 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1403 \ifx\PP\D\let\nextsp\relax
1404 \else\let\nextsp\skipspaces
1405 \ifx\p\space\else\addtokens{\filename}{\PP}%
1406 \advance\filenamelength by 1
1409 \nextsp}
1410 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1411 \ifnum\pdftexversion < 14
1412 \let \startlink \pdfannotlink
1413 \else
1414 \let \startlink \pdfstartlink
1416 % make a live url in pdf output.
1417 \def\pdfurl#1{%
1418 \begingroup
1419 % it seems we really need yet another set of dummies; have not
1420 % tried to figure out what each command should do in the context
1421 % of @url. for now, just make @/ a no-op, that's the only one
1422 % people have actually reported a problem with.
1424 \normalturnoffactive
1425 \def\@{@}%
1426 \let\/=\empty
1427 \makevalueexpandable
1428 \leavevmode\Red
1429 \startlink attr{/Border [0 0 0]}%
1430 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1431 \endgroup}
1432 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1433 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1434 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1435 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1436 \def\maketoks{%
1437 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1438 \ifx\first0\adn0
1439 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1440 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1441 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1442 \else
1443 \ifnum0=\countA\else\makelink\fi
1444 \ifx\first.\let\next=\done\else
1445 \let\next=\maketoks
1446 \addtokens{\toksB}{\the\toksD}
1447 \ifx\first,\addtokens{\toksB}{\space}\fi
1449 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1450 \next}
1451 \def\makelink{\addtokens{\toksB}%
1452 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1453 \def\pdflink#1{%
1454 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1455 \linkcolor #1\endlink}
1456 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1457 \else
1458 \let\pdfmkdest = \gobble
1459 \let\pdfurl = \gobble
1460 \let\endlink = \relax
1461 \let\linkcolor = \relax
1462 \let\pdfmakeoutlines = \relax
1463 \fi % \ifx\pdfoutput
1466 \message{fonts,}
1468 % Change the current font style to #1, remembering it in \curfontstyle.
1469 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1470 % italics, not bold italics.
1472 \def\setfontstyle#1{%
1473 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1474 \csname ten#1\endcsname % change the current font
1477 % Select #1 fonts with the current style.
1479 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1481 \def\rm{\fam=0 \setfontstyle{rm}}
1482 \def\it{\fam=\itfam \setfontstyle{it}}
1483 \def\sl{\fam=\slfam \setfontstyle{sl}}
1484 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1485 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1487 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1488 % So we set up a \sf.
1489 \newfam\sffam
1490 \def\sf{\fam=\sffam \setfontstyle{sf}}
1491 \let\li = \sf % Sometimes we call it \li, not \sf.
1493 % We don't need math for this font style.
1494 \def\ttsl{\setfontstyle{ttsl}}
1497 % Default leading.
1498 \newdimen\textleading \textleading = 13.2pt
1500 % Set the baselineskip to #1, and the lineskip and strut size
1501 % correspondingly. There is no deep meaning behind these magic numbers
1502 % used as factors; they just match (closely enough) what Knuth defined.
1504 \def\lineskipfactor{.08333}
1505 \def\strutheightpercent{.70833}
1506 \def\strutdepthpercent {.29167}
1508 \def\setleading#1{%
1509 \normalbaselineskip = #1\relax
1510 \normallineskip = \lineskipfactor\normalbaselineskip
1511 \normalbaselines
1512 \setbox\strutbox =\hbox{%
1513 \vrule width0pt height\strutheightpercent\baselineskip
1514 depth \strutdepthpercent \baselineskip
1519 % Set the font macro #1 to the font named #2, adding on the
1520 % specified font prefix (normally `cm').
1521 % #3 is the font's design size, #4 is a scale factor
1522 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1525 % Use cm as the default font prefix.
1526 % To specify the font prefix, you must define \fontprefix
1527 % before you read in texinfo.tex.
1528 \ifx\fontprefix\undefined
1529 \def\fontprefix{cm}
1531 % Support font families that don't use the same naming scheme as CM.
1532 \def\rmshape{r}
1533 \def\rmbshape{bx} %where the normal face is bold
1534 \def\bfshape{b}
1535 \def\bxshape{bx}
1536 \def\ttshape{tt}
1537 \def\ttbshape{tt}
1538 \def\ttslshape{sltt}
1539 \def\itshape{ti}
1540 \def\itbshape{bxti}
1541 \def\slshape{sl}
1542 \def\slbshape{bxsl}
1543 \def\sfshape{ss}
1544 \def\sfbshape{ss}
1545 \def\scshape{csc}
1546 \def\scbshape{csc}
1548 % Definitions for a main text size of 11pt. This is the default in
1549 % Texinfo.
1551 \def\definetextfontsizexi{
1552 % Text fonts (11.2pt, magstep1).
1553 \def\textnominalsize{11pt}
1554 \edef\mainmagstep{\magstephalf}
1555 \setfont\textrm\rmshape{10}{\mainmagstep}
1556 \setfont\texttt\ttshape{10}{\mainmagstep}
1557 \setfont\textbf\bfshape{10}{\mainmagstep}
1558 \setfont\textit\itshape{10}{\mainmagstep}
1559 \setfont\textsl\slshape{10}{\mainmagstep}
1560 \setfont\textsf\sfshape{10}{\mainmagstep}
1561 \setfont\textsc\scshape{10}{\mainmagstep}
1562 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1563 \font\texti=cmmi10 scaled \mainmagstep
1564 \font\textsy=cmsy10 scaled \mainmagstep
1566 % A few fonts for @defun names and args.
1567 \setfont\defbf\bfshape{10}{\magstep1}
1568 \setfont\deftt\ttshape{10}{\magstep1}
1569 \setfont\defttsl\ttslshape{10}{\magstep1}
1570 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1572 % Fonts for indices, footnotes, small examples (9pt).
1573 \def\smallnominalsize{9pt}
1574 \setfont\smallrm\rmshape{9}{1000}
1575 \setfont\smalltt\ttshape{9}{1000}
1576 \setfont\smallbf\bfshape{10}{900}
1577 \setfont\smallit\itshape{9}{1000}
1578 \setfont\smallsl\slshape{9}{1000}
1579 \setfont\smallsf\sfshape{9}{1000}
1580 \setfont\smallsc\scshape{10}{900}
1581 \setfont\smallttsl\ttslshape{10}{900}
1582 \font\smalli=cmmi9
1583 \font\smallsy=cmsy9
1585 % Fonts for small examples (8pt).
1586 \def\smallernominalsize{8pt}
1587 \setfont\smallerrm\rmshape{8}{1000}
1588 \setfont\smallertt\ttshape{8}{1000}
1589 \setfont\smallerbf\bfshape{10}{800}
1590 \setfont\smallerit\itshape{8}{1000}
1591 \setfont\smallersl\slshape{8}{1000}
1592 \setfont\smallersf\sfshape{8}{1000}
1593 \setfont\smallersc\scshape{10}{800}
1594 \setfont\smallerttsl\ttslshape{10}{800}
1595 \font\smalleri=cmmi8
1596 \font\smallersy=cmsy8
1598 % Fonts for title page (20.4pt):
1599 \def\titlenominalsize{20pt}
1600 \setfont\titlerm\rmbshape{12}{\magstep3}
1601 \setfont\titleit\itbshape{10}{\magstep4}
1602 \setfont\titlesl\slbshape{10}{\magstep4}
1603 \setfont\titlett\ttbshape{12}{\magstep3}
1604 \setfont\titlettsl\ttslshape{10}{\magstep4}
1605 \setfont\titlesf\sfbshape{17}{\magstep1}
1606 \let\titlebf=\titlerm
1607 \setfont\titlesc\scbshape{10}{\magstep4}
1608 \font\titlei=cmmi12 scaled \magstep3
1609 \font\titlesy=cmsy10 scaled \magstep4
1610 \def\authorrm{\secrm}
1611 \def\authortt{\sectt}
1613 % Chapter (and unnumbered) fonts (17.28pt).
1614 \def\chapnominalsize{17pt}
1615 \setfont\chaprm\rmbshape{12}{\magstep2}
1616 \setfont\chapit\itbshape{10}{\magstep3}
1617 \setfont\chapsl\slbshape{10}{\magstep3}
1618 \setfont\chaptt\ttbshape{12}{\magstep2}
1619 \setfont\chapttsl\ttslshape{10}{\magstep3}
1620 \setfont\chapsf\sfbshape{17}{1000}
1621 \let\chapbf=\chaprm
1622 \setfont\chapsc\scbshape{10}{\magstep3}
1623 \font\chapi=cmmi12 scaled \magstep2
1624 \font\chapsy=cmsy10 scaled \magstep3
1626 % Section fonts (14.4pt).
1627 \def\secnominalsize{14pt}
1628 \setfont\secrm\rmbshape{12}{\magstep1}
1629 \setfont\secit\itbshape{10}{\magstep2}
1630 \setfont\secsl\slbshape{10}{\magstep2}
1631 \setfont\sectt\ttbshape{12}{\magstep1}
1632 \setfont\secttsl\ttslshape{10}{\magstep2}
1633 \setfont\secsf\sfbshape{12}{\magstep1}
1634 \let\secbf\secrm
1635 \setfont\secsc\scbshape{10}{\magstep2}
1636 \font\seci=cmmi12 scaled \magstep1
1637 \font\secsy=cmsy10 scaled \magstep2
1639 % Subsection fonts (13.15pt).
1640 \def\ssecnominalsize{13pt}
1641 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1642 \setfont\ssecit\itbshape{10}{1315}
1643 \setfont\ssecsl\slbshape{10}{1315}
1644 \setfont\ssectt\ttbshape{12}{\magstephalf}
1645 \setfont\ssecttsl\ttslshape{10}{1315}
1646 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1647 \let\ssecbf\ssecrm
1648 \setfont\ssecsc\scbshape{10}{1315}
1649 \font\sseci=cmmi12 scaled \magstephalf
1650 \font\ssecsy=cmsy10 scaled 1315
1652 % Reduced fonts for @acro in text (10pt).
1653 \def\reducednominalsize{10pt}
1654 \setfont\reducedrm\rmshape{10}{1000}
1655 \setfont\reducedtt\ttshape{10}{1000}
1656 \setfont\reducedbf\bfshape{10}{1000}
1657 \setfont\reducedit\itshape{10}{1000}
1658 \setfont\reducedsl\slshape{10}{1000}
1659 \setfont\reducedsf\sfshape{10}{1000}
1660 \setfont\reducedsc\scshape{10}{1000}
1661 \setfont\reducedttsl\ttslshape{10}{1000}
1662 \font\reducedi=cmmi10
1663 \font\reducedsy=cmsy10
1665 % reset the current fonts
1666 \textfonts
1668 } % end of 11pt text font size definitions
1671 % Definitions to make the main text be 10pt Computer Modern, with
1672 % section, chapter, etc., sizes following suit. This is for the GNU
1673 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1674 % future. Used with @smallbook, which sets the leading to 12pt.
1676 \def\definetextfontsizex{%
1677 % Text fonts (10pt).
1678 \def\textnominalsize{10pt}
1679 \edef\mainmagstep{1000}
1680 \setfont\textrm\rmshape{10}{\mainmagstep}
1681 \setfont\texttt\ttshape{10}{\mainmagstep}
1682 \setfont\textbf\bfshape{10}{\mainmagstep}
1683 \setfont\textit\itshape{10}{\mainmagstep}
1684 \setfont\textsl\slshape{10}{\mainmagstep}
1685 \setfont\textsf\sfshape{10}{\mainmagstep}
1686 \setfont\textsc\scshape{10}{\mainmagstep}
1687 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1688 \font\texti=cmmi10 scaled \mainmagstep
1689 \font\textsy=cmsy10 scaled \mainmagstep
1691 % A few fonts for @defun names and args.
1692 \setfont\defbf\bfshape{10}{\magstephalf}
1693 \setfont\deftt\ttshape{10}{\magstephalf}
1694 \setfont\defttsl\ttslshape{10}{\magstephalf}
1695 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1697 % Fonts for indices, footnotes, small examples (9pt).
1698 \def\smallnominalsize{9pt}
1699 \setfont\smallrm\rmshape{9}{1000}
1700 \setfont\smalltt\ttshape{9}{1000}
1701 \setfont\smallbf\bfshape{10}{900}
1702 \setfont\smallit\itshape{9}{1000}
1703 \setfont\smallsl\slshape{9}{1000}
1704 \setfont\smallsf\sfshape{9}{1000}
1705 \setfont\smallsc\scshape{10}{900}
1706 \setfont\smallttsl\ttslshape{10}{900}
1707 \font\smalli=cmmi9
1708 \font\smallsy=cmsy9
1710 % Fonts for small examples (8pt).
1711 \def\smallernominalsize{8pt}
1712 \setfont\smallerrm\rmshape{8}{1000}
1713 \setfont\smallertt\ttshape{8}{1000}
1714 \setfont\smallerbf\bfshape{10}{800}
1715 \setfont\smallerit\itshape{8}{1000}
1716 \setfont\smallersl\slshape{8}{1000}
1717 \setfont\smallersf\sfshape{8}{1000}
1718 \setfont\smallersc\scshape{10}{800}
1719 \setfont\smallerttsl\ttslshape{10}{800}
1720 \font\smalleri=cmmi8
1721 \font\smallersy=cmsy8
1723 % Fonts for title page (20.4pt):
1724 \def\titlenominalsize{20pt}
1725 \setfont\titlerm\rmbshape{12}{\magstep3}
1726 \setfont\titleit\itbshape{10}{\magstep4}
1727 \setfont\titlesl\slbshape{10}{\magstep4}
1728 \setfont\titlett\ttbshape{12}{\magstep3}
1729 \setfont\titlettsl\ttslshape{10}{\magstep4}
1730 \setfont\titlesf\sfbshape{17}{\magstep1}
1731 \let\titlebf=\titlerm
1732 \setfont\titlesc\scbshape{10}{\magstep4}
1733 \font\titlei=cmmi12 scaled \magstep3
1734 \font\titlesy=cmsy10 scaled \magstep4
1735 \def\authorrm{\secrm}
1736 \def\authortt{\sectt}
1738 % Chapter fonts (14.4pt).
1739 \def\chapnominalsize{14pt}
1740 \setfont\chaprm\rmbshape{12}{\magstep1}
1741 \setfont\chapit\itbshape{10}{\magstep2}
1742 \setfont\chapsl\slbshape{10}{\magstep2}
1743 \setfont\chaptt\ttbshape{12}{\magstep1}
1744 \setfont\chapttsl\ttslshape{10}{\magstep2}
1745 \setfont\chapsf\sfbshape{12}{\magstep1}
1746 \let\chapbf\chaprm
1747 \setfont\chapsc\scbshape{10}{\magstep2}
1748 \font\chapi=cmmi12 scaled \magstep1
1749 \font\chapsy=cmsy10 scaled \magstep2
1751 % Section fonts (12pt).
1752 \def\secnominalsize{12pt}
1753 \setfont\secrm\rmbshape{12}{1000}
1754 \setfont\secit\itbshape{10}{\magstep1}
1755 \setfont\secsl\slbshape{10}{\magstep1}
1756 \setfont\sectt\ttbshape{12}{1000}
1757 \setfont\secttsl\ttslshape{10}{\magstep1}
1758 \setfont\secsf\sfbshape{12}{1000}
1759 \let\secbf\secrm
1760 \setfont\secsc\scbshape{10}{\magstep1}
1761 \font\seci=cmmi12
1762 \font\secsy=cmsy10 scaled \magstep1
1764 % Subsection fonts (10pt).
1765 \def\ssecnominalsize{10pt}
1766 \setfont\ssecrm\rmbshape{10}{1000}
1767 \setfont\ssecit\itbshape{10}{1000}
1768 \setfont\ssecsl\slbshape{10}{1000}
1769 \setfont\ssectt\ttbshape{10}{1000}
1770 \setfont\ssecttsl\ttslshape{10}{1000}
1771 \setfont\ssecsf\sfbshape{10}{1000}
1772 \let\ssecbf\ssecrm
1773 \setfont\ssecsc\scbshape{10}{1000}
1774 \font\sseci=cmmi10
1775 \font\ssecsy=cmsy10
1777 % Reduced fonts for @acro in text (9pt).
1778 \def\reducednominalsize{9pt}
1779 \setfont\reducedrm\rmshape{9}{1000}
1780 \setfont\reducedtt\ttshape{9}{1000}
1781 \setfont\reducedbf\bfshape{10}{900}
1782 \setfont\reducedit\itshape{9}{1000}
1783 \setfont\reducedsl\slshape{9}{1000}
1784 \setfont\reducedsf\sfshape{9}{1000}
1785 \setfont\reducedsc\scshape{10}{900}
1786 \setfont\reducedttsl\ttslshape{10}{900}
1787 \font\reducedi=cmmi9
1788 \font\reducedsy=cmsy9
1790 % reduce space between paragraphs
1791 \divide\parskip by 2
1793 % reset the current fonts
1794 \textfonts
1796 } % end of 10pt text font size definitions
1799 % We provide the user-level command
1800 % @fonttextsize 10
1801 % (or 11) to redefine the text font size. pt is assumed.
1803 \def\xword{10}
1804 \def\xiword{11}
1806 \parseargdef\fonttextsize{%
1807 \def\textsizearg{#1}%
1808 \wlog{doing @fonttextsize \textsizearg}%
1810 % Set \globaldefs so that documents can use this inside @tex, since
1811 % makeinfo 4.8 does not support it, but we need it nonetheless.
1813 \begingroup \globaldefs=1
1814 \ifx\textsizearg\xword \definetextfontsizex
1815 \else \ifx\textsizearg\xiword \definetextfontsizexi
1816 \else
1817 \errhelp=\EMsimple
1818 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1819 \fi\fi
1820 \endgroup
1824 % In order for the font changes to affect most math symbols and letters,
1825 % we have to define the \textfont of the standard families. Since
1826 % texinfo doesn't allow for producing subscripts and superscripts except
1827 % in the main text, we don't bother to reset \scriptfont and
1828 % \scriptscriptfont (which would also require loading a lot more fonts).
1830 \def\resetmathfonts{%
1831 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1832 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1833 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1836 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1837 % of just \STYLE. We do this because \STYLE needs to also set the
1838 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1839 % \tenSTYLE to set the current font.
1841 % Each font-changing command also sets the names \lsize (one size lower)
1842 % and \lllsize (three sizes lower). These relative commands are used in
1843 % the LaTeX logo and acronyms.
1845 % This all needs generalizing, badly.
1847 \def\textfonts{%
1848 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1849 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1850 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1851 \let\tenttsl=\textttsl
1852 \def\curfontsize{text}%
1853 \def\lsize{reduced}\def\lllsize{smaller}%
1854 \resetmathfonts \setleading{\textleading}}
1855 \def\titlefonts{%
1856 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1857 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1858 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1859 \let\tenttsl=\titlettsl
1860 \def\curfontsize{title}%
1861 \def\lsize{chap}\def\lllsize{subsec}%
1862 \resetmathfonts \setleading{25pt}}
1863 \def\titlefont#1{{\titlefonts\rm #1}}
1864 \def\chapfonts{%
1865 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1866 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1867 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1868 \let\tenttsl=\chapttsl
1869 \def\curfontsize{chap}%
1870 \def\lsize{sec}\def\lllsize{text}%
1871 \resetmathfonts \setleading{19pt}}
1872 \def\secfonts{%
1873 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1874 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1875 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1876 \let\tenttsl=\secttsl
1877 \def\curfontsize{sec}%
1878 \def\lsize{subsec}\def\lllsize{reduced}%
1879 \resetmathfonts \setleading{16pt}}
1880 \def\subsecfonts{%
1881 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1882 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1883 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1884 \let\tenttsl=\ssecttsl
1885 \def\curfontsize{ssec}%
1886 \def\lsize{text}\def\lllsize{small}%
1887 \resetmathfonts \setleading{15pt}}
1888 \let\subsubsecfonts = \subsecfonts
1889 \def\reducedfonts{%
1890 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1891 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1892 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1893 \let\tenttsl=\reducedttsl
1894 \def\curfontsize{reduced}%
1895 \def\lsize{small}\def\lllsize{smaller}%
1896 \resetmathfonts \setleading{10.5pt}}
1897 \def\smallfonts{%
1898 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1899 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1900 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1901 \let\tenttsl=\smallttsl
1902 \def\curfontsize{small}%
1903 \def\lsize{smaller}\def\lllsize{smaller}%
1904 \resetmathfonts \setleading{10.5pt}}
1905 \def\smallerfonts{%
1906 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1907 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1908 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1909 \let\tenttsl=\smallerttsl
1910 \def\curfontsize{smaller}%
1911 \def\lsize{smaller}\def\lllsize{smaller}%
1912 \resetmathfonts \setleading{9.5pt}}
1914 % Set the fonts to use with the @small... environments.
1915 \let\smallexamplefonts = \smallfonts
1917 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1918 % can fit this many characters:
1919 % 8.5x11=86 smallbook=72 a4=90 a5=69
1920 % If we use \scriptfonts (8pt), then we can fit this many characters:
1921 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1922 % For me, subjectively, the few extra characters that fit aren't worth
1923 % the additional smallness of 8pt. So I'm making the default 9pt.
1925 % By the way, for comparison, here's what fits with @example (10pt):
1926 % 8.5x11=71 smallbook=60 a4=75 a5=58
1928 % I wish the USA used A4 paper.
1929 % --karl, 24jan03.
1932 % Set up the default fonts, so we can use them for creating boxes.
1934 \definetextfontsizexi
1936 % Define these so they can be easily changed for other fonts.
1937 \def\angleleft{$\langle$}
1938 \def\angleright{$\rangle$}
1940 % Count depth in font-changes, for error checks
1941 \newcount\fontdepth \fontdepth=0
1943 % Fonts for short table of contents.
1944 \setfont\shortcontrm\rmshape{12}{1000}
1945 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1946 \setfont\shortcontsl\slshape{12}{1000}
1947 \setfont\shortconttt\ttshape{12}{1000}
1949 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1950 %% serif) and @ii for TeX italic
1952 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1953 % unless the following character is such as not to need one.
1954 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1955 \ptexslash\fi\fi\fi}
1956 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1957 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1959 % like \smartslanted except unconditionally uses \ttsl.
1960 % @var is set to this for defun arguments.
1961 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1963 % like \smartslanted except unconditionally use \sl. We never want
1964 % ttsl for book titles, do we?
1965 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1967 \let\i=\smartitalic
1968 \let\slanted=\smartslanted
1969 \let\var=\smartslanted
1970 \let\dfn=\smartslanted
1971 \let\emph=\smartitalic
1973 % @b, explicit bold.
1974 \def\b#1{{\bf #1}}
1975 \let\strong=\b
1977 % @sansserif, explicit sans.
1978 \def\sansserif#1{{\sf #1}}
1980 % We can't just use \exhyphenpenalty, because that only has effect at
1981 % the end of a paragraph. Restore normal hyphenation at the end of the
1982 % group within which \nohyphenation is presumably called.
1984 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1985 \def\restorehyphenation{\hyphenchar\font = `- }
1987 % Set sfcode to normal for the chars that usually have another value.
1988 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1989 % sometimes \x has an active definition that messes things up.
1991 \catcode`@=11
1992 \def\plainfrenchspacing{%
1993 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1994 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1995 \def\endofsentencespacefactor{1000}% for @. and friends
1997 \def\plainnonfrenchspacing{%
1998 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1999 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2000 \def\endofsentencespacefactor{3000}% for @. and friends
2002 \catcode`@=\other
2003 \def\endofsentencespacefactor{3000}% default
2005 \def\t#1{%
2006 {\tt \rawbackslash \plainfrenchspacing #1}%
2007 \null
2009 \def\samp#1{`\tclose{#1}'\null}
2010 \setfont\keyrm\rmshape{8}{1000}
2011 \font\keysy=cmsy9
2012 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2013 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2014 \vbox{\hrule\kern-0.4pt
2015 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2016 \kern-0.4pt\hrule}%
2017 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2018 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2019 % The old definition, with no lozenge:
2020 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2021 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2023 % @file, @option are the same as @samp.
2024 \let\file=\samp
2025 \let\option=\samp
2027 % @code is a modification of @t,
2028 % which makes spaces the same size as normal in the surrounding text.
2029 \def\tclose#1{%
2031 % Change normal interword space to be same as for the current font.
2032 \spaceskip = \fontdimen2\font
2034 % Switch to typewriter.
2037 % But `\ ' produces the large typewriter interword space.
2038 \def\ {{\spaceskip = 0pt{} }}%
2040 % Turn off hyphenation.
2041 \nohyphenation
2043 \rawbackslash
2044 \plainfrenchspacing
2047 \null
2050 % We *must* turn on hyphenation at `-' and `_' in @code.
2051 % Otherwise, it is too hard to avoid overfull hboxes
2052 % in the Emacs manual, the Library manual, etc.
2054 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2055 % both hyphenation at - and hyphenation within words.
2056 % We must therefore turn them both off (\tclose does that)
2057 % and arrange explicitly to hyphenate at a dash.
2058 % -- rms.
2060 \catcode`\-=\active \catcode`\_=\active
2061 \catcode`\'=\active \catcode`\`=\active
2063 \global\def\code{\begingroup
2064 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2065 \let'\codequoteright \let`\codequoteleft
2067 \catcode\dashChar=\active \catcode\underChar=\active
2068 \ifallowcodebreaks
2069 \let-\codedash
2070 \let_\codeunder
2071 \else
2072 \let-\realdash
2073 \let_\realunder
2075 \codex
2079 \def\realdash{-}
2080 \def\codedash{-\discretionary{}{}{}}
2081 \def\codeunder{%
2082 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2083 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2084 % will therefore expand the active definition of _, which is us
2085 % (inside @code that is), therefore an endless loop.
2086 \ifusingtt{\ifmmode
2087 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2088 \else\normalunderscore \fi
2089 \discretionary{}{}{}}%
2090 {\_}%
2092 \def\codex #1{\tclose{#1}\endgroup}
2094 % An additional complication: the above will allow breaks after, e.g.,
2095 % each of the four underscores in __typeof__. This is undesirable in
2096 % some manuals, especially if they don't have long identifiers in
2097 % general. @allowcodebreaks provides a way to control this.
2099 \newif\ifallowcodebreaks \allowcodebreakstrue
2101 \def\keywordtrue{true}
2102 \def\keywordfalse{false}
2104 \parseargdef\allowcodebreaks{%
2105 \def\txiarg{#1}%
2106 \ifx\txiarg\keywordtrue
2107 \allowcodebreakstrue
2108 \else\ifx\txiarg\keywordfalse
2109 \allowcodebreaksfalse
2110 \else
2111 \errhelp = \EMsimple
2112 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2113 \fi\fi
2116 % @kbd is like @code, except that if the argument is just one @key command,
2117 % then @kbd has no effect.
2119 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2120 % `example' (@kbd uses ttsl only inside of @example and friends),
2121 % or `code' (@kbd uses normal tty font always).
2122 \parseargdef\kbdinputstyle{%
2123 \def\txiarg{#1}%
2124 \ifx\txiarg\worddistinct
2125 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2126 \else\ifx\txiarg\wordexample
2127 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2128 \else\ifx\txiarg\wordcode
2129 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2130 \else
2131 \errhelp = \EMsimple
2132 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2133 \fi\fi\fi
2135 \def\worddistinct{distinct}
2136 \def\wordexample{example}
2137 \def\wordcode{code}
2139 % Default is `distinct.'
2140 \kbdinputstyle distinct
2142 \def\xkey{\key}
2143 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2144 \ifx\one\xkey\ifx\threex\three \key{#2}%
2145 \else{\tclose{\kbdfont\look}}\fi
2146 \else{\tclose{\kbdfont\look}}\fi}
2148 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2149 \let\indicateurl=\code
2150 \let\env=\code
2151 \let\command=\code
2153 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2154 % second argument specifying the text to display and an optional third
2155 % arg as text to display instead of (rather than in addition to) the url
2156 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2157 % a hypertex \special here.
2159 \def\uref#1{\douref #1,,,\finish}
2160 \def\douref#1,#2,#3,#4\finish{\begingroup
2161 \unsepspaces
2162 \pdfurl{#1}%
2163 \setbox0 = \hbox{\ignorespaces #3}%
2164 \ifdim\wd0 > 0pt
2165 \unhbox0 % third arg given, show only that
2166 \else
2167 \setbox0 = \hbox{\ignorespaces #2}%
2168 \ifdim\wd0 > 0pt
2169 \ifpdf
2170 \unhbox0 % PDF: 2nd arg given, show only it
2171 \else
2172 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2174 \else
2175 \code{#1}% only url given, so show it
2178 \endlink
2179 \endgroup}
2181 % @url synonym for @uref, since that's how everyone uses it.
2183 \let\url=\uref
2185 % rms does not like angle brackets --karl, 17may97.
2186 % So now @email is just like @uref, unless we are pdf.
2188 %\def\email#1{\angleleft{\tt #1}\angleright}
2189 \ifpdf
2190 \def\email#1{\doemail#1,,\finish}
2191 \def\doemail#1,#2,#3\finish{\begingroup
2192 \unsepspaces
2193 \pdfurl{mailto:#1}%
2194 \setbox0 = \hbox{\ignorespaces #2}%
2195 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2196 \endlink
2197 \endgroup}
2198 \else
2199 \let\email=\uref
2202 % Check if we are currently using a typewriter font. Since all the
2203 % Computer Modern typewriter fonts have zero interword stretch (and
2204 % shrink), and it is reasonable to expect all typewriter fonts to have
2205 % this property, we can check that font parameter.
2207 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2209 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2210 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2212 \def\dmn#1{\thinspace #1}
2214 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2216 % @l was never documented to mean ``switch to the Lisp font'',
2217 % and it is not used as such in any manual I can find. We need it for
2218 % Polish suppressed-l. --karl, 22sep96.
2219 %\def\l#1{{\li #1}\null}
2221 % Explicit font changes: @r, @sc, undocumented @ii.
2222 \def\r#1{{\rm #1}} % roman font
2223 \def\sc#1{{\smallcaps#1}} % smallcaps font
2224 \def\ii#1{{\it #1}} % italic font
2226 % @acronym for "FBI", "NATO", and the like.
2227 % We print this one point size smaller, since it's intended for
2228 % all-uppercase.
2230 \def\acronym#1{\doacronym #1,,\finish}
2231 \def\doacronym#1,#2,#3\finish{%
2232 {\selectfonts\lsize #1}%
2233 \def\temp{#2}%
2234 \ifx\temp\empty \else
2235 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2239 % @abbr for "Comput. J." and the like.
2240 % No font change, but don't do end-of-sentence spacing.
2242 \def\abbr#1{\doabbr #1,,\finish}
2243 \def\doabbr#1,#2,#3\finish{%
2244 {\plainfrenchspacing #1}%
2245 \def\temp{#2}%
2246 \ifx\temp\empty \else
2247 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2251 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2253 \def\pounds{{\it\$}}
2255 % @euro{} comes from a separate font, depending on the current style.
2256 % We use the free feym* fonts from the eurosym package by Henrik
2257 % Theiling, which support regular, slanted, bold and bold slanted (and
2258 % "outlined" (blackboard board, sort of) versions, which we don't need).
2259 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2261 % Although only regular is the truly official Euro symbol, we ignore
2262 % that. The Euro is designed to be slightly taller than the regular
2263 % font height.
2265 % feymr - regular
2266 % feymo - slanted
2267 % feybr - bold
2268 % feybo - bold slanted
2270 % There is no good (free) typewriter version, to my knowledge.
2271 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2272 % Hmm.
2274 % Also doesn't work in math. Do we need to do math with euro symbols?
2275 % Hope not.
2278 \def\euro{{\eurofont e}}
2279 \def\eurofont{%
2280 % We set the font at each command, rather than predefining it in
2281 % \textfonts and the other font-switching commands, so that
2282 % installations which never need the symbol don't have to have the
2283 % font installed.
2285 % There is only one designed size (nominal 10pt), so we always scale
2286 % that to the current nominal size.
2288 % By the way, simply using "at 1em" works for cmr10 and the like, but
2289 % does not work for cmbx10 and other extended/shrunken fonts.
2291 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2293 \ifx\curfontstyle\bfstylename
2294 % bold:
2295 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2296 \else
2297 % regular:
2298 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2300 \thiseurofont
2303 % @registeredsymbol - R in a circle. The font for the R should really
2304 % be smaller yet, but lllsize is the best we can do for now.
2305 % Adapted from the plain.tex definition of \copyright.
2307 \def\registeredsymbol{%
2308 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2309 \hfil\crcr\Orb}}%
2313 % @textdegree - the normal degrees sign.
2315 \def\textdegree{$^\circ$}
2317 % Laurent Siebenmann reports \Orb undefined with:
2318 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2319 % so we'll define it if necessary.
2321 \ifx\Orb\undefined
2322 \def\Orb{\mathhexbox20D}
2326 \message{page headings,}
2328 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2329 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2331 % First the title page. Must do @settitle before @titlepage.
2332 \newif\ifseenauthor
2333 \newif\iffinishedtitlepage
2335 % Do an implicit @contents or @shortcontents after @end titlepage if the
2336 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2338 \newif\ifsetcontentsaftertitlepage
2339 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2340 \newif\ifsetshortcontentsaftertitlepage
2341 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2343 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2344 \endgroup\page\hbox{}\page}
2346 \envdef\titlepage{%
2347 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2348 \begingroup
2349 \parindent=0pt \textfonts
2350 % Leave some space at the very top of the page.
2351 \vglue\titlepagetopglue
2352 % No rule at page bottom unless we print one at the top with @title.
2353 \finishedtitlepagetrue
2355 % Most title ``pages'' are actually two pages long, with space
2356 % at the top of the second. We don't want the ragged left on the second.
2357 \let\oldpage = \page
2358 \def\page{%
2359 \iffinishedtitlepage\else
2360 \finishtitlepage
2362 \let\page = \oldpage
2363 \page
2364 \null
2368 \def\Etitlepage{%
2369 \iffinishedtitlepage\else
2370 \finishtitlepage
2372 % It is important to do the page break before ending the group,
2373 % because the headline and footline are only empty inside the group.
2374 % If we use the new definition of \page, we always get a blank page
2375 % after the title page, which we certainly don't want.
2376 \oldpage
2377 \endgroup
2379 % Need this before the \...aftertitlepage checks so that if they are
2380 % in effect the toc pages will come out with page numbers.
2381 \HEADINGSon
2383 % If they want short, they certainly want long too.
2384 \ifsetshortcontentsaftertitlepage
2385 \shortcontents
2386 \contents
2387 \global\let\shortcontents = \relax
2388 \global\let\contents = \relax
2391 \ifsetcontentsaftertitlepage
2392 \contents
2393 \global\let\contents = \relax
2394 \global\let\shortcontents = \relax
2398 \def\finishtitlepage{%
2399 \vskip4pt \hrule height 2pt width \hsize
2400 \vskip\titlepagebottomglue
2401 \finishedtitlepagetrue
2404 %%% Macros to be used within @titlepage:
2406 \let\subtitlerm=\tenrm
2407 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2409 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2410 \let\tt=\authortt}
2412 \parseargdef\title{%
2413 \checkenv\titlepage
2414 \leftline{\titlefonts\rm #1}
2415 % print a rule at the page bottom also.
2416 \finishedtitlepagefalse
2417 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2420 \parseargdef\subtitle{%
2421 \checkenv\titlepage
2422 {\subtitlefont \rightline{#1}}%
2425 % @author should come last, but may come many times.
2426 % It can also be used inside @quotation.
2428 \parseargdef\author{%
2429 \def\temp{\quotation}%
2430 \ifx\thisenv\temp
2431 \def\quotationauthor{#1}% printed in \Equotation.
2432 \else
2433 \checkenv\titlepage
2434 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2435 {\authorfont \leftline{#1}}%
2440 %%% Set up page headings and footings.
2442 \let\thispage=\folio
2444 \newtoks\evenheadline % headline on even pages
2445 \newtoks\oddheadline % headline on odd pages
2446 \newtoks\evenfootline % footline on even pages
2447 \newtoks\oddfootline % footline on odd pages
2449 % Now make TeX use those variables
2450 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2451 \else \the\evenheadline \fi}}
2452 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2453 \else \the\evenfootline \fi}\HEADINGShook}
2454 \let\HEADINGShook=\relax
2456 % Commands to set those variables.
2457 % For example, this is what @headings on does
2458 % @evenheading @thistitle|@thispage|@thischapter
2459 % @oddheading @thischapter|@thispage|@thistitle
2460 % @evenfooting @thisfile||
2461 % @oddfooting ||@thisfile
2464 \def\evenheading{\parsearg\evenheadingxxx}
2465 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2466 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2467 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2469 \def\oddheading{\parsearg\oddheadingxxx}
2470 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2471 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2472 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2474 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2476 \def\evenfooting{\parsearg\evenfootingxxx}
2477 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2478 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2479 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2481 \def\oddfooting{\parsearg\oddfootingxxx}
2482 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2483 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2484 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2486 % Leave some space for the footline. Hopefully ok to assume
2487 % @evenfooting will not be used by itself.
2488 \global\advance\pageheight by -12pt
2489 \global\advance\vsize by -12pt
2492 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2495 % @headings double turns headings on for double-sided printing.
2496 % @headings single turns headings on for single-sided printing.
2497 % @headings off turns them off.
2498 % @headings on same as @headings double, retained for compatibility.
2499 % @headings after turns on double-sided headings after this page.
2500 % @headings doubleafter turns on double-sided headings after this page.
2501 % @headings singleafter turns on single-sided headings after this page.
2502 % By default, they are off at the start of a document,
2503 % and turned `on' after @end titlepage.
2505 \def\headings #1 {\csname HEADINGS#1\endcsname}
2507 \def\HEADINGSoff{%
2508 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2509 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2510 \HEADINGSoff
2511 % When we turn headings on, set the page number to 1.
2512 % For double-sided printing, put current file name in lower left corner,
2513 % chapter name on inside top of right hand pages, document
2514 % title on inside top of left hand pages, and page numbers on outside top
2515 % edge of all pages.
2516 \def\HEADINGSdouble{%
2517 \global\pageno=1
2518 \global\evenfootline={\hfil}
2519 \global\oddfootline={\hfil}
2520 \global\evenheadline={\line{\folio\hfil\thistitle}}
2521 \global\oddheadline={\line{\thischapter\hfil\folio}}
2522 \global\let\contentsalignmacro = \chapoddpage
2524 \let\contentsalignmacro = \chappager
2526 % For single-sided printing, chapter title goes across top left of page,
2527 % page number on top right.
2528 \def\HEADINGSsingle{%
2529 \global\pageno=1
2530 \global\evenfootline={\hfil}
2531 \global\oddfootline={\hfil}
2532 \global\evenheadline={\line{\thischapter\hfil\folio}}
2533 \global\oddheadline={\line{\thischapter\hfil\folio}}
2534 \global\let\contentsalignmacro = \chappager
2536 \def\HEADINGSon{\HEADINGSdouble}
2538 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2539 \let\HEADINGSdoubleafter=\HEADINGSafter
2540 \def\HEADINGSdoublex{%
2541 \global\evenfootline={\hfil}
2542 \global\oddfootline={\hfil}
2543 \global\evenheadline={\line{\folio\hfil\thistitle}}
2544 \global\oddheadline={\line{\thischapter\hfil\folio}}
2545 \global\let\contentsalignmacro = \chapoddpage
2548 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2549 \def\HEADINGSsinglex{%
2550 \global\evenfootline={\hfil}
2551 \global\oddfootline={\hfil}
2552 \global\evenheadline={\line{\thischapter\hfil\folio}}
2553 \global\oddheadline={\line{\thischapter\hfil\folio}}
2554 \global\let\contentsalignmacro = \chappager
2557 % Subroutines used in generating headings
2558 % This produces Day Month Year style of output.
2559 % Only define if not already defined, in case a txi-??.tex file has set
2560 % up a different format (e.g., txi-cs.tex does this).
2561 \ifx\today\undefined
2562 \def\today{%
2563 \number\day\space
2564 \ifcase\month
2565 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2566 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2567 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2569 \space\number\year}
2572 % @settitle line... specifies the title of the document, for headings.
2573 % It generates no output of its own.
2574 \def\thistitle{\putwordNoTitle}
2575 \def\settitle{\parsearg{\gdef\thistitle}}
2578 \message{tables,}
2579 % Tables -- @table, @ftable, @vtable, @item(x).
2581 % default indentation of table text
2582 \newdimen\tableindent \tableindent=.8in
2583 % default indentation of @itemize and @enumerate text
2584 \newdimen\itemindent \itemindent=.3in
2585 % margin between end of table item and start of table text.
2586 \newdimen\itemmargin \itemmargin=.1in
2588 % used internally for \itemindent minus \itemmargin
2589 \newdimen\itemmax
2591 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2592 % these defs.
2593 % They also define \itemindex
2594 % to index the item name in whatever manner is desired (perhaps none).
2596 \newif\ifitemxneedsnegativevskip
2598 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2600 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2601 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2603 \def\itemzzz #1{\begingroup %
2604 \advance\hsize by -\rightskip
2605 \advance\hsize by -\tableindent
2606 \setbox0=\hbox{\itemindicate{#1}}%
2607 \itemindex{#1}%
2608 \nobreak % This prevents a break before @itemx.
2610 % If the item text does not fit in the space we have, put it on a line
2611 % by itself, and do not allow a page break either before or after that
2612 % line. We do not start a paragraph here because then if the next
2613 % command is, e.g., @kindex, the whatsit would get put into the
2614 % horizontal list on a line by itself, resulting in extra blank space.
2615 \ifdim \wd0>\itemmax
2617 % Make this a paragraph so we get the \parskip glue and wrapping,
2618 % but leave it ragged-right.
2619 \begingroup
2620 \advance\leftskip by-\tableindent
2621 \advance\hsize by\tableindent
2622 \advance\rightskip by0pt plus1fil
2623 \leavevmode\unhbox0\par
2624 \endgroup
2626 % We're going to be starting a paragraph, but we don't want the
2627 % \parskip glue -- logically it's part of the @item we just started.
2628 \nobreak \vskip-\parskip
2630 % Stop a page break at the \parskip glue coming up. However, if
2631 % what follows is an environment such as @example, there will be no
2632 % \parskip glue; then the negative vskip we just inserted would
2633 % cause the example and the item to crash together. So we use this
2634 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2635 % \parskip glue after all. Section titles are handled this way also.
2637 \penalty 10001
2638 \endgroup
2639 \itemxneedsnegativevskipfalse
2640 \else
2641 % The item text fits into the space. Start a paragraph, so that the
2642 % following text (if any) will end up on the same line.
2643 \noindent
2644 % Do this with kerns and \unhbox so that if there is a footnote in
2645 % the item text, it can migrate to the main vertical list and
2646 % eventually be printed.
2647 \nobreak\kern-\tableindent
2648 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2649 \unhbox0
2650 \nobreak\kern\dimen0
2651 \endgroup
2652 \itemxneedsnegativevskiptrue
2656 \def\item{\errmessage{@item while not in a list environment}}
2657 \def\itemx{\errmessage{@itemx while not in a list environment}}
2659 % @table, @ftable, @vtable.
2660 \envdef\table{%
2661 \let\itemindex\gobble
2662 \tablecheck{table}%
2664 \envdef\ftable{%
2665 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2666 \tablecheck{ftable}%
2668 \envdef\vtable{%
2669 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2670 \tablecheck{vtable}%
2672 \def\tablecheck#1{%
2673 \ifnum \the\catcode`\^^M=\active
2674 \endgroup
2675 \errmessage{This command won't work in this context; perhaps the problem is
2676 that we are \inenvironment\thisenv}%
2677 \def\next{\doignore{#1}}%
2678 \else
2679 \let\next\tablex
2681 \next
2683 \def\tablex#1{%
2684 \def\itemindicate{#1}%
2685 \parsearg\tabley
2687 \def\tabley#1{%
2689 \makevalueexpandable
2690 \edef\temp{\noexpand\tablez #1\space\space\space}%
2691 \expandafter
2692 }\temp \endtablez
2694 \def\tablez #1 #2 #3 #4\endtablez{%
2695 \aboveenvbreak
2696 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2697 \ifnum 0#2>0 \tableindent=#2\mil \fi
2698 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2699 \itemmax=\tableindent
2700 \advance \itemmax by -\itemmargin
2701 \advance \leftskip by \tableindent
2702 \exdentamount=\tableindent
2703 \parindent = 0pt
2704 \parskip = \smallskipamount
2705 \ifdim \parskip=0pt \parskip=2pt \fi
2706 \let\item = \internalBitem
2707 \let\itemx = \internalBitemx
2709 \def\Etable{\endgraf\afterenvbreak}
2710 \let\Eftable\Etable
2711 \let\Evtable\Etable
2712 \let\Eitemize\Etable
2713 \let\Eenumerate\Etable
2715 % This is the counter used by @enumerate, which is really @itemize
2717 \newcount \itemno
2719 \envdef\itemize{\parsearg\doitemize}
2721 \def\doitemize#1{%
2722 \aboveenvbreak
2723 \itemmax=\itemindent
2724 \advance\itemmax by -\itemmargin
2725 \advance\leftskip by \itemindent
2726 \exdentamount=\itemindent
2727 \parindent=0pt
2728 \parskip=\smallskipamount
2729 \ifdim\parskip=0pt \parskip=2pt \fi
2730 \def\itemcontents{#1}%
2731 % @itemize with no arg is equivalent to @itemize @bullet.
2732 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2733 \let\item=\itemizeitem
2736 % Definition of @item while inside @itemize and @enumerate.
2738 \def\itemizeitem{%
2739 \advance\itemno by 1 % for enumerations
2740 {\let\par=\endgraf \smallbreak}% reasonable place to break
2742 % If the document has an @itemize directly after a section title, a
2743 % \nobreak will be last on the list, and \sectionheading will have
2744 % done a \vskip-\parskip. In that case, we don't want to zero
2745 % parskip, or the item text will crash with the heading. On the
2746 % other hand, when there is normal text preceding the item (as there
2747 % usually is), we do want to zero parskip, or there would be too much
2748 % space. In that case, we won't have a \nobreak before. At least
2749 % that's the theory.
2750 \ifnum\lastpenalty<10000 \parskip=0in \fi
2751 \noindent
2752 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2753 \vadjust{\penalty 1200}}% not good to break after first line of item.
2754 \flushcr
2757 % \splitoff TOKENS\endmark defines \first to be the first token in
2758 % TOKENS, and \rest to be the remainder.
2760 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2762 % Allow an optional argument of an uppercase letter, lowercase letter,
2763 % or number, to specify the first label in the enumerated list. No
2764 % argument is the same as `1'.
2766 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2767 \def\enumeratey #1 #2\endenumeratey{%
2768 % If we were given no argument, pretend we were given `1'.
2769 \def\thearg{#1}%
2770 \ifx\thearg\empty \def\thearg{1}\fi
2772 % Detect if the argument is a single token. If so, it might be a
2773 % letter. Otherwise, the only valid thing it can be is a number.
2774 % (We will always have one token, because of the test we just made.
2775 % This is a good thing, since \splitoff doesn't work given nothing at
2776 % all -- the first parameter is undelimited.)
2777 \expandafter\splitoff\thearg\endmark
2778 \ifx\rest\empty
2779 % Only one token in the argument. It could still be anything.
2780 % A ``lowercase letter'' is one whose \lccode is nonzero.
2781 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2782 % not equal to itself.
2783 % Otherwise, we assume it's a number.
2785 % We need the \relax at the end of the \ifnum lines to stop TeX from
2786 % continuing to look for a <number>.
2788 \ifnum\lccode\expandafter`\thearg=0\relax
2789 \numericenumerate % a number (we hope)
2790 \else
2791 % It's a letter.
2792 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2793 \lowercaseenumerate % lowercase letter
2794 \else
2795 \uppercaseenumerate % uppercase letter
2798 \else
2799 % Multiple tokens in the argument. We hope it's a number.
2800 \numericenumerate
2804 % An @enumerate whose labels are integers. The starting integer is
2805 % given in \thearg.
2807 \def\numericenumerate{%
2808 \itemno = \thearg
2809 \startenumeration{\the\itemno}%
2812 % The starting (lowercase) letter is in \thearg.
2813 \def\lowercaseenumerate{%
2814 \itemno = \expandafter`\thearg
2815 \startenumeration{%
2816 % Be sure we're not beyond the end of the alphabet.
2817 \ifnum\itemno=0
2818 \errmessage{No more lowercase letters in @enumerate; get a bigger
2819 alphabet}%
2821 \char\lccode\itemno
2825 % The starting (uppercase) letter is in \thearg.
2826 \def\uppercaseenumerate{%
2827 \itemno = \expandafter`\thearg
2828 \startenumeration{%
2829 % Be sure we're not beyond the end of the alphabet.
2830 \ifnum\itemno=0
2831 \errmessage{No more uppercase letters in @enumerate; get a bigger
2832 alphabet}
2834 \char\uccode\itemno
2838 % Call \doitemize, adding a period to the first argument and supplying the
2839 % common last two arguments. Also subtract one from the initial value in
2840 % \itemno, since @item increments \itemno.
2842 \def\startenumeration#1{%
2843 \advance\itemno by -1
2844 \doitemize{#1.}\flushcr
2847 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2848 % to @enumerate.
2850 \def\alphaenumerate{\enumerate{a}}
2851 \def\capsenumerate{\enumerate{A}}
2852 \def\Ealphaenumerate{\Eenumerate}
2853 \def\Ecapsenumerate{\Eenumerate}
2856 % @multitable macros
2857 % Amy Hendrickson, 8/18/94, 3/6/96
2859 % @multitable ... @end multitable will make as many columns as desired.
2860 % Contents of each column will wrap at width given in preamble. Width
2861 % can be specified either with sample text given in a template line,
2862 % or in percent of \hsize, the current width of text on page.
2864 % Table can continue over pages but will only break between lines.
2866 % To make preamble:
2868 % Either define widths of columns in terms of percent of \hsize:
2869 % @multitable @columnfractions .25 .3 .45
2870 % @item ...
2872 % Numbers following @columnfractions are the percent of the total
2873 % current hsize to be used for each column. You may use as many
2874 % columns as desired.
2877 % Or use a template:
2878 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2879 % @item ...
2880 % using the widest term desired in each column.
2882 % Each new table line starts with @item, each subsequent new column
2883 % starts with @tab. Empty columns may be produced by supplying @tab's
2884 % with nothing between them for as many times as empty columns are needed,
2885 % ie, @tab@tab@tab will produce two empty columns.
2887 % @item, @tab do not need to be on their own lines, but it will not hurt
2888 % if they are.
2890 % Sample multitable:
2892 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2893 % @item first col stuff @tab second col stuff @tab third col
2894 % @item
2895 % first col stuff
2896 % @tab
2897 % second col stuff
2898 % @tab
2899 % third col
2900 % @item first col stuff @tab second col stuff
2901 % @tab Many paragraphs of text may be used in any column.
2903 % They will wrap at the width determined by the template.
2904 % @item@tab@tab This will be in third column.
2905 % @end multitable
2907 % Default dimensions may be reset by user.
2908 % @multitableparskip is vertical space between paragraphs in table.
2909 % @multitableparindent is paragraph indent in table.
2910 % @multitablecolmargin is horizontal space to be left between columns.
2911 % @multitablelinespace is space to leave between table items, baseline
2912 % to baseline.
2913 % 0pt means it depends on current normal line spacing.
2915 \newskip\multitableparskip
2916 \newskip\multitableparindent
2917 \newdimen\multitablecolspace
2918 \newskip\multitablelinespace
2919 \multitableparskip=0pt
2920 \multitableparindent=6pt
2921 \multitablecolspace=12pt
2922 \multitablelinespace=0pt
2924 % Macros used to set up halign preamble:
2926 \let\endsetuptable\relax
2927 \def\xendsetuptable{\endsetuptable}
2928 \let\columnfractions\relax
2929 \def\xcolumnfractions{\columnfractions}
2930 \newif\ifsetpercent
2932 % #1 is the @columnfraction, usually a decimal number like .5, but might
2933 % be just 1. We just use it, whatever it is.
2935 \def\pickupwholefraction#1 {%
2936 \global\advance\colcount by 1
2937 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2938 \setuptable
2941 \newcount\colcount
2942 \def\setuptable#1{%
2943 \def\firstarg{#1}%
2944 \ifx\firstarg\xendsetuptable
2945 \let\go = \relax
2946 \else
2947 \ifx\firstarg\xcolumnfractions
2948 \global\setpercenttrue
2949 \else
2950 \ifsetpercent
2951 \let\go\pickupwholefraction
2952 \else
2953 \global\advance\colcount by 1
2954 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2955 % separator; typically that is always in the input, anyway.
2956 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2959 \ifx\go\pickupwholefraction
2960 % Put the argument back for the \pickupwholefraction call, so
2961 % we'll always have a period there to be parsed.
2962 \def\go{\pickupwholefraction#1}%
2963 \else
2964 \let\go = \setuptable
2965 \fi%
2970 % multitable-only commands.
2972 % @headitem starts a heading row, which we typeset in bold.
2973 % Assignments have to be global since we are inside the implicit group
2974 % of an alignment entry. Note that \everycr resets \everytab.
2975 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2977 % A \tab used to include \hskip1sp. But then the space in a template
2978 % line is not enough. That is bad. So let's go back to just `&' until
2979 % we encounter the problem it was intended to solve again.
2980 % --karl, nathan@acm.org, 20apr99.
2981 \def\tab{\checkenv\multitable &\the\everytab}%
2983 % @multitable ... @end multitable definitions:
2985 \newtoks\everytab % insert after every tab.
2987 \envdef\multitable{%
2988 \vskip\parskip
2989 \startsavinginserts
2991 % @item within a multitable starts a normal row.
2992 % We use \def instead of \let so that if one of the multitable entries
2993 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2994 % \endtemplate) expanding \doitemize.
2995 \def\item{\crcr}%
2997 \tolerance=9500
2998 \hbadness=9500
2999 \setmultitablespacing
3000 \parskip=\multitableparskip
3001 \parindent=\multitableparindent
3002 \overfullrule=0pt
3003 \global\colcount=0
3005 \everycr = {%
3006 \noalign{%
3007 \global\everytab={}%
3008 \global\colcount=0 % Reset the column counter.
3009 % Check for saved footnotes, etc.
3010 \checkinserts
3011 % Keeps underfull box messages off when table breaks over pages.
3012 %\filbreak
3013 % Maybe so, but it also creates really weird page breaks when the
3014 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3015 % problem manifests itself, so it can be fixed for real --karl.
3019 \parsearg\domultitable
3021 \def\domultitable#1{%
3022 % To parse everything between @multitable and @item:
3023 \setuptable#1 \endsetuptable
3025 % This preamble sets up a generic column definition, which will
3026 % be used as many times as user calls for columns.
3027 % \vtop will set a single line and will also let text wrap and
3028 % continue for many paragraphs if desired.
3029 \halign\bgroup &%
3030 \global\advance\colcount by 1
3031 \multistrut
3032 \vtop{%
3033 % Use the current \colcount to find the correct column width:
3034 \hsize=\expandafter\csname col\the\colcount\endcsname
3036 % In order to keep entries from bumping into each other
3037 % we will add a \leftskip of \multitablecolspace to all columns after
3038 % the first one.
3040 % If a template has been used, we will add \multitablecolspace
3041 % to the width of each template entry.
3043 % If the user has set preamble in terms of percent of \hsize we will
3044 % use that dimension as the width of the column, and the \leftskip
3045 % will keep entries from bumping into each other. Table will start at
3046 % left margin and final column will justify at right margin.
3048 % Make sure we don't inherit \rightskip from the outer environment.
3049 \rightskip=0pt
3050 \ifnum\colcount=1
3051 % The first column will be indented with the surrounding text.
3052 \advance\hsize by\leftskip
3053 \else
3054 \ifsetpercent \else
3055 % If user has not set preamble in terms of percent of \hsize
3056 % we will advance \hsize by \multitablecolspace.
3057 \advance\hsize by \multitablecolspace
3059 % In either case we will make \leftskip=\multitablecolspace:
3060 \leftskip=\multitablecolspace
3062 % Ignoring space at the beginning and end avoids an occasional spurious
3063 % blank line, when TeX decides to break the line at the space before the
3064 % box from the multistrut, so the strut ends up on a line by itself.
3065 % For example:
3066 % @multitable @columnfractions .11 .89
3067 % @item @code{#}
3068 % @tab Legal holiday which is valid in major parts of the whole country.
3069 % Is automatically provided with highlighting sequences respectively
3070 % marking characters.
3071 \noindent\ignorespaces##\unskip\multistrut
3072 }\cr
3074 \def\Emultitable{%
3075 \crcr
3076 \egroup % end the \halign
3077 \global\setpercentfalse
3080 \def\setmultitablespacing{%
3081 \def\multistrut{\strut}% just use the standard line spacing
3083 % Compute \multitablelinespace (if not defined by user) for use in
3084 % \multitableparskip calculation. We used define \multistrut based on
3085 % this, but (ironically) that caused the spacing to be off.
3086 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3087 \ifdim\multitablelinespace=0pt
3088 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3089 \global\advance\multitablelinespace by-\ht0
3091 %% Test to see if parskip is larger than space between lines of
3092 %% table. If not, do nothing.
3093 %% If so, set to same dimension as multitablelinespace.
3094 \ifdim\multitableparskip>\multitablelinespace
3095 \global\multitableparskip=\multitablelinespace
3096 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3097 %% than skip between lines in the table.
3098 \fi%
3099 \ifdim\multitableparskip=0pt
3100 \global\multitableparskip=\multitablelinespace
3101 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3102 %% than skip between lines in the table.
3103 \fi}
3106 \message{conditionals,}
3108 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3109 % @ifnotxml always succeed. They currently do nothing; we don't
3110 % attempt to check whether the conditionals are properly nested. But we
3111 % have to remember that they are conditionals, so that @end doesn't
3112 % attempt to close an environment group.
3114 \def\makecond#1{%
3115 \expandafter\let\csname #1\endcsname = \relax
3116 \expandafter\let\csname iscond.#1\endcsname = 1
3118 \makecond{iftex}
3119 \makecond{ifnotdocbook}
3120 \makecond{ifnothtml}
3121 \makecond{ifnotinfo}
3122 \makecond{ifnotplaintext}
3123 \makecond{ifnotxml}
3125 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3127 \def\direntry{\doignore{direntry}}
3128 \def\documentdescription{\doignore{documentdescription}}
3129 \def\docbook{\doignore{docbook}}
3130 \def\html{\doignore{html}}
3131 \def\ifdocbook{\doignore{ifdocbook}}
3132 \def\ifhtml{\doignore{ifhtml}}
3133 \def\ifinfo{\doignore{ifinfo}}
3134 \def\ifnottex{\doignore{ifnottex}}
3135 \def\ifplaintext{\doignore{ifplaintext}}
3136 \def\ifxml{\doignore{ifxml}}
3137 \def\ignore{\doignore{ignore}}
3138 \def\menu{\doignore{menu}}
3139 \def\xml{\doignore{xml}}
3141 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3143 % A count to remember the depth of nesting.
3144 \newcount\doignorecount
3146 \def\doignore#1{\begingroup
3147 % Scan in ``verbatim'' mode:
3148 \obeylines
3149 \catcode`\@ = \other
3150 \catcode`\{ = \other
3151 \catcode`\} = \other
3153 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3154 \spaceisspace
3156 % Count number of #1's that we've seen.
3157 \doignorecount = 0
3159 % Swallow text until we reach the matching `@end #1'.
3160 \dodoignore{#1}%
3163 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3164 \obeylines %
3166 \gdef\dodoignore#1{%
3167 % #1 contains the command name as a string, e.g., `ifinfo'.
3169 % Define a command to find the next `@end #1'.
3170 \long\def\doignoretext##1^^M@end #1{%
3171 \doignoretextyyy##1^^M@#1\_STOP_}%
3173 % And this command to find another #1 command, at the beginning of a
3174 % line. (Otherwise, we would consider a line `@c @ifset', for
3175 % example, to count as an @ifset for nesting.)
3176 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3178 % And now expand that command.
3179 \doignoretext ^^M%
3183 \def\doignoreyyy#1{%
3184 \def\temp{#1}%
3185 \ifx\temp\empty % Nothing found.
3186 \let\next\doignoretextzzz
3187 \else % Found a nested condition, ...
3188 \advance\doignorecount by 1
3189 \let\next\doignoretextyyy % ..., look for another.
3190 % If we're here, #1 ends with ^^M\ifinfo (for example).
3192 \next #1% the token \_STOP_ is present just after this macro.
3195 % We have to swallow the remaining "\_STOP_".
3197 \def\doignoretextzzz#1{%
3198 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3199 \let\next\enddoignore
3200 \else % Still inside a nested condition.
3201 \advance\doignorecount by -1
3202 \let\next\doignoretext % Look for the next @end.
3204 \next
3207 % Finish off ignored text.
3208 { \obeylines%
3209 % Ignore anything after the last `@end #1'; this matters in verbatim
3210 % environments, where otherwise the newline after an ignored conditional
3211 % would result in a blank line in the output.
3212 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3216 % @set VAR sets the variable VAR to an empty value.
3217 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3219 % Since we want to separate VAR from REST-OF-LINE (which might be
3220 % empty), we can't just use \parsearg; we have to insert a space of our
3221 % own to delimit the rest of the line, and then take it out again if we
3222 % didn't need it.
3223 % We rely on the fact that \parsearg sets \catcode`\ =10.
3225 \parseargdef\set{\setyyy#1 \endsetyyy}
3226 \def\setyyy#1 #2\endsetyyy{%
3228 \makevalueexpandable
3229 \def\temp{#2}%
3230 \edef\next{\gdef\makecsname{SET#1}}%
3231 \ifx\temp\empty
3232 \next{}%
3233 \else
3234 \setzzz#2\endsetzzz
3238 % Remove the trailing space \setxxx inserted.
3239 \def\setzzz#1 \endsetzzz{\next{#1}}
3241 % @clear VAR clears (i.e., unsets) the variable VAR.
3243 \parseargdef\clear{%
3245 \makevalueexpandable
3246 \global\expandafter\let\csname SET#1\endcsname=\relax
3250 % @value{foo} gets the text saved in variable foo.
3251 \def\value{\begingroup\makevalueexpandable\valuexxx}
3252 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3254 \catcode`\- = \active \catcode`\_ = \active
3256 \gdef\makevalueexpandable{%
3257 \let\value = \expandablevalue
3258 % We don't want these characters active, ...
3259 \catcode`\-=\other \catcode`\_=\other
3260 % ..., but we might end up with active ones in the argument if
3261 % we're called from @code, as @code{@value{foo-bar_}}, though.
3262 % So \let them to their normal equivalents.
3263 \let-\realdash \let_\normalunderscore
3267 % We have this subroutine so that we can handle at least some @value's
3268 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3269 % The command has to be fully expandable (if the variable is set), since
3270 % the result winds up in the index file. This means that if the
3271 % variable's value contains other Texinfo commands, it's almost certain
3272 % it will fail (although perhaps we could fix that with sufficient work
3273 % to do a one-level expansion on the result, instead of complete).
3275 \def\expandablevalue#1{%
3276 \expandafter\ifx\csname SET#1\endcsname\relax
3277 {[No value for ``#1'']}%
3278 \message{Variable `#1', used in @value, is not set.}%
3279 \else
3280 \csname SET#1\endcsname
3284 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3285 % with @set.
3287 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3289 \makecond{ifset}
3290 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3291 \def\doifset#1#2{%
3293 \makevalueexpandable
3294 \let\next=\empty
3295 \expandafter\ifx\csname SET#2\endcsname\relax
3296 #1% If not set, redefine \next.
3298 \expandafter
3299 }\next
3301 \def\ifsetfail{\doignore{ifset}}
3303 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3304 % defined with @set, or has been undefined with @clear.
3306 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3307 % above code: if the variable is not set, do nothing, if it is set,
3308 % then redefine \next to \ifclearfail.
3310 \makecond{ifclear}
3311 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3312 \def\ifclearfail{\doignore{ifclear}}
3314 % @dircategory CATEGORY -- specify a category of the dir file
3315 % which this file should belong to. Ignore this in TeX.
3316 \let\dircategory=\comment
3318 % @defininfoenclose.
3319 \let\definfoenclose=\comment
3322 \message{indexing,}
3323 % Index generation facilities
3325 % Define \newwrite to be identical to plain tex's \newwrite
3326 % except not \outer, so it can be used within macros and \if's.
3327 \edef\newwrite{\makecsname{ptexnewwrite}}
3329 % \newindex {foo} defines an index named foo.
3330 % It automatically defines \fooindex such that
3331 % \fooindex ...rest of line... puts an entry in the index foo.
3332 % It also defines \fooindfile to be the number of the output channel for
3333 % the file that accumulates this index. The file's extension is foo.
3334 % The name of an index should be no more than 2 characters long
3335 % for the sake of vms.
3337 \def\newindex#1{%
3338 \iflinks
3339 \expandafter\newwrite \csname#1indfile\endcsname
3340 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3342 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3343 \noexpand\doindex{#1}}
3346 % @defindex foo == \newindex{foo}
3348 \def\defindex{\parsearg\newindex}
3350 % Define @defcodeindex, like @defindex except put all entries in @code.
3352 \def\defcodeindex{\parsearg\newcodeindex}
3354 \def\newcodeindex#1{%
3355 \iflinks
3356 \expandafter\newwrite \csname#1indfile\endcsname
3357 \openout \csname#1indfile\endcsname \jobname.#1
3359 \expandafter\xdef\csname#1index\endcsname{%
3360 \noexpand\docodeindex{#1}}%
3364 % @synindex foo bar makes index foo feed into index bar.
3365 % Do this instead of @defindex foo if you don't want it as a separate index.
3367 % @syncodeindex foo bar similar, but put all entries made for index foo
3368 % inside @code.
3370 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3371 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3373 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3374 % #3 the target index (bar).
3375 \def\dosynindex#1#2#3{%
3376 % Only do \closeout if we haven't already done it, else we'll end up
3377 % closing the target index.
3378 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3379 % The \closeout helps reduce unnecessary open files; the limit on the
3380 % Acorn RISC OS is a mere 16 files.
3381 \expandafter\closeout\csname#2indfile\endcsname
3382 \expandafter\let\csname\donesynindex#2\endcsname = 1
3384 % redefine \fooindfile:
3385 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3386 \expandafter\let\csname#2indfile\endcsname=\temp
3387 % redefine \fooindex:
3388 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3391 % Define \doindex, the driver for all \fooindex macros.
3392 % Argument #1 is generated by the calling \fooindex macro,
3393 % and it is "foo", the name of the index.
3395 % \doindex just uses \parsearg; it calls \doind for the actual work.
3396 % This is because \doind is more useful to call from other macros.
3398 % There is also \dosubind {index}{topic}{subtopic}
3399 % which makes an entry in a two-level index such as the operation index.
3401 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3402 \def\singleindexer #1{\doind{\indexname}{#1}}
3404 % like the previous two, but they put @code around the argument.
3405 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3406 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3408 % Take care of Texinfo commands that can appear in an index entry.
3409 % Since there are some commands we want to expand, and others we don't,
3410 % we have to laboriously prevent expansion for those that we don't.
3412 \def\indexdummies{%
3413 \escapechar = `\\ % use backslash in output files.
3414 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3415 \def\ {\realbackslash\space }%
3417 % Need these in case \tex is in effect and \{ is a \delimiter again.
3418 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3419 % braces and backslashes are used only as delimiters.
3420 \let\{ = \mylbrace
3421 \let\} = \myrbrace
3423 % I don't entirely understand this, but when an index entry is
3424 % generated from a macro call, the \endinput which \scanmacro inserts
3425 % causes processing to be prematurely terminated. This is,
3426 % apparently, because \indexsorttmp is fully expanded, and \endinput
3427 % is an expandable command. The redefinition below makes \endinput
3428 % disappear altogether for that purpose -- although logging shows that
3429 % processing continues to some further point. On the other hand, it
3430 % seems \endinput does not hurt in the printed index arg, since that
3431 % is still getting written without apparent harm.
3433 % Sample source (mac-idx3.tex, reported by Graham Percival to
3434 % help-texinfo, 22may06):
3435 % @macro funindex {WORD}
3436 % @findex xyz
3437 % @end macro
3438 % ...
3439 % @funindex commtest
3441 % The above is not enough to reproduce the bug, but it gives the flavor.
3443 % Sample whatsit resulting:
3444 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3446 % So:
3447 \let\endinput = \empty
3449 % Do the redefinitions.
3450 \commondummies
3453 % For the aux and toc files, @ is the escape character. So we want to
3454 % redefine everything using @ as the escape character (instead of
3455 % \realbackslash, still used for index files). When everything uses @,
3456 % this will be simpler.
3458 \def\atdummies{%
3459 \def\@{@@}%
3460 \def\ {@ }%
3461 \let\{ = \lbraceatcmd
3462 \let\} = \rbraceatcmd
3464 % Do the redefinitions.
3465 \commondummies
3466 \otherbackslash
3469 % Called from \indexdummies and \atdummies.
3471 \def\commondummies{%
3473 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3474 % preventing its expansion. This is used only for control% words,
3475 % not control letters, because the \space would be incorrect for
3476 % control characters, but is needed to separate the control word
3477 % from whatever follows.
3479 % For control letters, we have \definedummyletter, which omits the
3480 % space.
3482 % These can be used both for control words that take an argument and
3483 % those that do not. If it is followed by {arg} in the input, then
3484 % that will dutifully get written to the index (or wherever).
3486 \def\definedummyword ##1{\def##1{\string##1\space}}%
3487 \def\definedummyletter##1{\def##1{\string##1}}%
3488 \let\definedummyaccent\definedummyletter
3490 \commondummiesnofonts
3492 \definedummyletter\_%
3494 % Non-English letters.
3495 \definedummyword\AA
3496 \definedummyword\AE
3497 \definedummyword\L
3498 \definedummyword\OE
3499 \definedummyword\O
3500 \definedummyword\aa
3501 \definedummyword\ae
3502 \definedummyword\l
3503 \definedummyword\oe
3504 \definedummyword\o
3505 \definedummyword\ss
3506 \definedummyword\exclamdown
3507 \definedummyword\questiondown
3508 \definedummyword\ordf
3509 \definedummyword\ordm
3511 % Although these internal commands shouldn't show up, sometimes they do.
3512 \definedummyword\bf
3513 \definedummyword\gtr
3514 \definedummyword\hat
3515 \definedummyword\less
3516 \definedummyword\sf
3517 \definedummyword\sl
3518 \definedummyword\tclose
3519 \definedummyword\tt
3521 \definedummyword\LaTeX
3522 \definedummyword\TeX
3524 % Assorted special characters.
3525 \definedummyword\bullet
3526 \definedummyword\comma
3527 \definedummyword\copyright
3528 \definedummyword\registeredsymbol
3529 \definedummyword\dots
3530 \definedummyword\enddots
3531 \definedummyword\equiv
3532 \definedummyword\error
3533 \definedummyword\euro
3534 \definedummyword\expansion
3535 \definedummyword\minus
3536 \definedummyword\pounds
3537 \definedummyword\point
3538 \definedummyword\print
3539 \definedummyword\result
3540 \definedummyword\textdegree
3542 % We want to disable all macros so that they are not expanded by \write.
3543 \macrolist
3545 \normalturnoffactive
3547 % Handle some cases of @value -- where it does not contain any
3548 % (non-fully-expandable) commands.
3549 \makevalueexpandable
3552 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3554 \def\commondummiesnofonts{%
3555 % Control letters and accents.
3556 \definedummyletter\!%
3557 \definedummyaccent\"%
3558 \definedummyaccent\'%
3559 \definedummyletter\*%
3560 \definedummyaccent\,%
3561 \definedummyletter\.%
3562 \definedummyletter\/%
3563 \definedummyletter\:%
3564 \definedummyaccent\=%
3565 \definedummyletter\?%
3566 \definedummyaccent\^%
3567 \definedummyaccent\`%
3568 \definedummyaccent\~%
3569 \definedummyword\u
3570 \definedummyword\v
3571 \definedummyword\H
3572 \definedummyword\dotaccent
3573 \definedummyword\ringaccent
3574 \definedummyword\tieaccent
3575 \definedummyword\ubaraccent
3576 \definedummyword\udotaccent
3577 \definedummyword\dotless
3579 % Texinfo font commands.
3580 \definedummyword\b
3581 \definedummyword\i
3582 \definedummyword\r
3583 \definedummyword\sc
3584 \definedummyword\t
3586 % Commands that take arguments.
3587 \definedummyword\acronym
3588 \definedummyword\cite
3589 \definedummyword\code
3590 \definedummyword\command
3591 \definedummyword\dfn
3592 \definedummyword\emph
3593 \definedummyword\env
3594 \definedummyword\file
3595 \definedummyword\kbd
3596 \definedummyword\key
3597 \definedummyword\math
3598 \definedummyword\option
3599 \definedummyword\pxref
3600 \definedummyword\ref
3601 \definedummyword\samp
3602 \definedummyword\strong
3603 \definedummyword\tie
3604 \definedummyword\uref
3605 \definedummyword\url
3606 \definedummyword\var
3607 \definedummyword\verb
3608 \definedummyword\w
3609 \definedummyword\xref
3612 % \indexnofonts is used when outputting the strings to sort the index
3613 % by, and when constructing control sequence names. It eliminates all
3614 % control sequences and just writes whatever the best ASCII sort string
3615 % would be for a given command (usually its argument).
3617 \def\indexnofonts{%
3618 % Accent commands should become @asis.
3619 \def\definedummyaccent##1{\let##1\asis}%
3620 % We can just ignore other control letters.
3621 \def\definedummyletter##1{\let##1\empty}%
3622 % Hopefully, all control words can become @asis.
3623 \let\definedummyword\definedummyaccent
3625 \commondummiesnofonts
3627 % Don't no-op \tt, since it isn't a user-level command
3628 % and is used in the definitions of the active chars like <, >, |, etc.
3629 % Likewise with the other plain tex font commands.
3630 %\let\tt=\asis
3632 \def\ { }%
3633 \def\@{@}%
3634 % how to handle braces?
3635 \def\_{\normalunderscore}%
3637 % Non-English letters.
3638 \def\AA{AA}%
3639 \def\AE{AE}%
3640 \def\L{L}%
3641 \def\OE{OE}%
3642 \def\O{O}%
3643 \def\aa{aa}%
3644 \def\ae{ae}%
3645 \def\l{l}%
3646 \def\oe{oe}%
3647 \def\o{o}%
3648 \def\ss{ss}%
3649 \def\exclamdown{!}%
3650 \def\questiondown{?}%
3651 \def\ordf{a}%
3652 \def\ordm{o}%
3654 \def\LaTeX{LaTeX}%
3655 \def\TeX{TeX}%
3657 % Assorted special characters.
3658 % (The following {} will end up in the sort string, but that's ok.)
3659 \def\bullet{bullet}%
3660 \def\comma{,}%
3661 \def\copyright{copyright}%
3662 \def\registeredsymbol{R}%
3663 \def\dots{...}%
3664 \def\enddots{...}%
3665 \def\equiv{==}%
3666 \def\error{error}%
3667 \def\euro{euro}%
3668 \def\expansion{==>}%
3669 \def\minus{-}%
3670 \def\pounds{pounds}%
3671 \def\point{.}%
3672 \def\print{-|}%
3673 \def\result{=>}%
3674 \def\textdegree{degrees}%
3676 % We need to get rid of all macros, leaving only the arguments (if present).
3677 % Of course this is not nearly correct, but it is the best we can do for now.
3678 % makeinfo does not expand macros in the argument to @deffn, which ends up
3679 % writing an index entry, and texindex isn't prepared for an index sort entry
3680 % that starts with \.
3682 % Since macro invocations are followed by braces, we can just redefine them
3683 % to take a single TeX argument. The case of a macro invocation that
3684 % goes to end-of-line is not handled.
3686 \macrolist
3689 \let\indexbackslash=0 %overridden during \printindex.
3690 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3692 % Most index entries go through here, but \dosubind is the general case.
3693 % #1 is the index name, #2 is the entry text.
3694 \def\doind#1#2{\dosubind{#1}{#2}{}}
3696 % Workhorse for all \fooindexes.
3697 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3698 % empty if called from \doind, as we usually are (the main exception
3699 % is with most defuns, which call us directly).
3701 \def\dosubind#1#2#3{%
3702 \iflinks
3704 % Store the main index entry text (including the third arg).
3705 \toks0 = {#2}%
3706 % If third arg is present, precede it with a space.
3707 \def\thirdarg{#3}%
3708 \ifx\thirdarg\empty \else
3709 \toks0 = \expandafter{\the\toks0 \space #3}%
3712 \edef\writeto{\csname#1indfile\endcsname}%
3714 \ifvmode
3715 \dosubindsanitize
3716 \else
3717 \dosubindwrite
3723 % Write the entry in \toks0 to the index file:
3725 \def\dosubindwrite{%
3726 % Put the index entry in the margin if desired.
3727 \ifx\SETmarginindex\relax\else
3728 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3731 % Remember, we are within a group.
3732 \indexdummies % Must do this here, since \bf, etc expand at this stage
3733 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3734 % so it will be output as is; and it will print as backslash.
3736 % Process the index entry with all font commands turned off, to
3737 % get the string to sort by.
3738 {\indexnofonts
3739 \edef\temp{\the\toks0}% need full expansion
3740 \xdef\indexsorttmp{\temp}%
3743 % Set up the complete index entry, with both the sort key and
3744 % the original text, including any font commands. We write
3745 % three arguments to \entry to the .?? file (four in the
3746 % subentry case), texindex reduces to two when writing the .??s
3747 % sorted result.
3748 \edef\temp{%
3749 \write\writeto{%
3750 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3752 \temp
3755 % Take care of unwanted page breaks:
3757 % If a skip is the last thing on the list now, preserve it
3758 % by backing up by \lastskip, doing the \write, then inserting
3759 % the skip again. Otherwise, the whatsit generated by the
3760 % \write will make \lastskip zero. The result is that sequences
3761 % like this:
3762 % @end defun
3763 % @tindex whatever
3764 % @defun ...
3765 % will have extra space inserted, because the \medbreak in the
3766 % start of the @defun won't see the skip inserted by the @end of
3767 % the previous defun.
3769 % But don't do any of this if we're not in vertical mode. We
3770 % don't want to do a \vskip and prematurely end a paragraph.
3772 % Avoid page breaks due to these extra skips, too.
3774 % But wait, there is a catch there:
3775 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3776 % sufficient for this purpose, as it ignores stretch and shrink parts
3777 % of the skip. The only way seems to be to check the textual
3778 % representation of the skip.
3780 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3781 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3783 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3785 % ..., ready, GO:
3787 \def\dosubindsanitize{%
3788 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3789 \skip0 = \lastskip
3790 \edef\lastskipmacro{\the\lastskip}%
3791 \count255 = \lastpenalty
3793 % If \lastskip is nonzero, that means the last item was a
3794 % skip. And since a skip is discardable, that means this
3795 % -\skip0 glue we're inserting is preceded by a
3796 % non-discardable item, therefore it is not a potential
3797 % breakpoint, therefore no \nobreak needed.
3798 \ifx\lastskipmacro\zeroskipmacro
3799 \else
3800 \vskip-\skip0
3803 \dosubindwrite
3805 \ifx\lastskipmacro\zeroskipmacro
3806 % If \lastskip was zero, perhaps the last item was a penalty, and
3807 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3808 % to re-insert the same penalty (values >10000 are used for various
3809 % signals); since we just inserted a non-discardable item, any
3810 % following glue (such as a \parskip) would be a breakpoint. For example:
3812 % @deffn deffn-whatever
3813 % @vindex index-whatever
3814 % Description.
3815 % would allow a break between the index-whatever whatsit
3816 % and the "Description." paragraph.
3817 \ifnum\count255>9999 \penalty\count255 \fi
3818 \else
3819 % On the other hand, if we had a nonzero \lastskip,
3820 % this make-up glue would be preceded by a non-discardable item
3821 % (the whatsit from the \write), so we must insert a \nobreak.
3822 \nobreak\vskip\skip0
3826 % The index entry written in the file actually looks like
3827 % \entry {sortstring}{page}{topic}
3828 % or
3829 % \entry {sortstring}{page}{topic}{subtopic}
3830 % The texindex program reads in these files and writes files
3831 % containing these kinds of lines:
3832 % \initial {c}
3833 % before the first topic whose initial is c
3834 % \entry {topic}{pagelist}
3835 % for a topic that is used without subtopics
3836 % \primary {topic}
3837 % for the beginning of a topic that is used with subtopics
3838 % \secondary {subtopic}{pagelist}
3839 % for each subtopic.
3841 % Define the user-accessible indexing commands
3842 % @findex, @vindex, @kindex, @cindex.
3844 \def\findex {\fnindex}
3845 \def\kindex {\kyindex}
3846 \def\cindex {\cpindex}
3847 \def\vindex {\vrindex}
3848 \def\tindex {\tpindex}
3849 \def\pindex {\pgindex}
3851 \def\cindexsub {\begingroup\obeylines\cindexsub}
3852 {\obeylines %
3853 \gdef\cindexsub "#1" #2^^M{\endgroup %
3854 \dosubind{cp}{#2}{#1}}}
3856 % Define the macros used in formatting output of the sorted index material.
3858 % @printindex causes a particular index (the ??s file) to get printed.
3859 % It does not print any chapter heading (usually an @unnumbered).
3861 \parseargdef\printindex{\begingroup
3862 \dobreak \chapheadingskip{10000}%
3864 \smallfonts \rm
3865 \tolerance = 9500
3866 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3868 % See if the index file exists and is nonempty.
3869 % Change catcode of @ here so that if the index file contains
3870 % \initial {@}
3871 % as its first line, TeX doesn't complain about mismatched braces
3872 % (because it thinks @} is a control sequence).
3873 \catcode`\@ = 11
3874 \openin 1 \jobname.#1s
3875 \ifeof 1
3876 % \enddoublecolumns gets confused if there is no text in the index,
3877 % and it loses the chapter title and the aux file entries for the
3878 % index. The easiest way to prevent this problem is to make sure
3879 % there is some text.
3880 \putwordIndexNonexistent
3881 \else
3883 % If the index file exists but is empty, then \openin leaves \ifeof
3884 % false. We have to make TeX try to read something from the file, so
3885 % it can discover if there is anything in it.
3886 \read 1 to \temp
3887 \ifeof 1
3888 \putwordIndexIsEmpty
3889 \else
3890 % Index files are almost Texinfo source, but we use \ as the escape
3891 % character. It would be better to use @, but that's too big a change
3892 % to make right now.
3893 \def\indexbackslash{\backslashcurfont}%
3894 \catcode`\\ = 0
3895 \escapechar = `\\
3896 \begindoublecolumns
3897 \input \jobname.#1s
3898 \enddoublecolumns
3901 \closein 1
3902 \endgroup}
3904 % These macros are used by the sorted index file itself.
3905 % Change them to control the appearance of the index.
3907 \def\initial#1{{%
3908 % Some minor font changes for the special characters.
3909 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3911 % Remove any glue we may have, we'll be inserting our own.
3912 \removelastskip
3914 % We like breaks before the index initials, so insert a bonus.
3915 \nobreak
3916 \vskip 0pt plus 3\baselineskip
3917 \penalty 0
3918 \vskip 0pt plus -3\baselineskip
3920 % Typeset the initial. Making this add up to a whole number of
3921 % baselineskips increases the chance of the dots lining up from column
3922 % to column. It still won't often be perfect, because of the stretch
3923 % we need before each entry, but it's better.
3925 % No shrink because it confuses \balancecolumns.
3926 \vskip 1.67\baselineskip plus .5\baselineskip
3927 \leftline{\secbf #1}%
3928 % Do our best not to break after the initial.
3929 \nobreak
3930 \vskip .33\baselineskip plus .1\baselineskip
3933 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3934 % then page number (#2) flushed to the right margin. It is used for index
3935 % and table of contents entries. The paragraph is indented by \leftskip.
3937 % A straightforward implementation would start like this:
3938 % \def\entry#1#2{...
3939 % But this frozes the catcodes in the argument, and can cause problems to
3940 % @code, which sets - active. This problem was fixed by a kludge---
3941 % ``-'' was active throughout whole index, but this isn't really right.
3943 % The right solution is to prevent \entry from swallowing the whole text.
3944 % --kasal, 21nov03
3945 \def\entry{%
3946 \begingroup
3948 % Start a new paragraph if necessary, so our assignments below can't
3949 % affect previous text.
3950 \par
3952 % Do not fill out the last line with white space.
3953 \parfillskip = 0in
3955 % No extra space above this paragraph.
3956 \parskip = 0in
3958 % Do not prefer a separate line ending with a hyphen to fewer lines.
3959 \finalhyphendemerits = 0
3961 % \hangindent is only relevant when the entry text and page number
3962 % don't both fit on one line. In that case, bob suggests starting the
3963 % dots pretty far over on the line. Unfortunately, a large
3964 % indentation looks wrong when the entry text itself is broken across
3965 % lines. So we use a small indentation and put up with long leaders.
3967 % \hangafter is reset to 1 (which is the value we want) at the start
3968 % of each paragraph, so we need not do anything with that.
3969 \hangindent = 2em
3971 % When the entry text needs to be broken, just fill out the first line
3972 % with blank space.
3973 \rightskip = 0pt plus1fil
3975 % A bit of stretch before each entry for the benefit of balancing
3976 % columns.
3977 \vskip 0pt plus1pt
3979 % Swallow the left brace of the text (first parameter):
3980 \afterassignment\doentry
3981 \let\temp =
3983 \def\doentry{%
3984 \bgroup % Instead of the swallowed brace.
3985 \noindent
3986 \aftergroup\finishentry
3987 % And now comes the text of the entry.
3989 \def\finishentry#1{%
3990 % #1 is the page number.
3992 % The following is kludged to not output a line of dots in the index if
3993 % there are no page numbers. The next person who breaks this will be
3994 % cursed by a Unix daemon.
3995 \def\tempa{{\rm }}%
3996 \def\tempb{#1}%
3997 \edef\tempc{\tempa}%
3998 \edef\tempd{\tempb}%
3999 \ifx\tempc\tempd
4001 \else
4003 % If we must, put the page number on a line of its own, and fill out
4004 % this line with blank space. (The \hfil is overwhelmed with the
4005 % fill leaders glue in \indexdotfill if the page number does fit.)
4006 \hfil\penalty50
4007 \null\nobreak\indexdotfill % Have leaders before the page number.
4009 % The `\ ' here is removed by the implicit \unskip that TeX does as
4010 % part of (the primitive) \par. Without it, a spurious underfull
4011 % \hbox ensues.
4012 \ifpdf
4013 \pdfgettoks#1.%
4014 \ \the\toksA
4015 \else
4016 \ #1%
4019 \par
4020 \endgroup
4023 % Like plain.tex's \dotfill, except uses up at least 1 em.
4024 \def\indexdotfill{\cleaders
4025 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4027 \def\primary #1{\line{#1\hfil}}
4029 \newskip\secondaryindent \secondaryindent=0.5cm
4030 \def\secondary#1#2{{%
4031 \parfillskip=0in
4032 \parskip=0in
4033 \hangindent=1in
4034 \hangafter=1
4035 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4036 \ifpdf
4037 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4038 \else
4041 \par
4044 % Define two-column mode, which we use to typeset indexes.
4045 % Adapted from the TeXbook, page 416, which is to say,
4046 % the manmac.tex format used to print the TeXbook itself.
4047 \catcode`\@=11
4049 \newbox\partialpage
4050 \newdimen\doublecolumnhsize
4052 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4053 % Grab any single-column material above us.
4054 \output = {%
4056 % Here is a possibility not foreseen in manmac: if we accumulate a
4057 % whole lot of material, we might end up calling this \output
4058 % routine twice in a row (see the doublecol-lose test, which is
4059 % essentially a couple of indexes with @setchapternewpage off). In
4060 % that case we just ship out what is in \partialpage with the normal
4061 % output routine. Generally, \partialpage will be empty when this
4062 % runs and this will be a no-op. See the indexspread.tex test case.
4063 \ifvoid\partialpage \else
4064 \onepageout{\pagecontents\partialpage}%
4067 \global\setbox\partialpage = \vbox{%
4068 % Unvbox the main output page.
4069 \unvbox\PAGE
4070 \kern-\topskip \kern\baselineskip
4073 \eject % run that output routine to set \partialpage
4075 % Use the double-column output routine for subsequent pages.
4076 \output = {\doublecolumnout}%
4078 % Change the page size parameters. We could do this once outside this
4079 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4080 % format, but then we repeat the same computation. Repeating a couple
4081 % of assignments once per index is clearly meaningless for the
4082 % execution time, so we may as well do it in one place.
4084 % First we halve the line length, less a little for the gutter between
4085 % the columns. We compute the gutter based on the line length, so it
4086 % changes automatically with the paper format. The magic constant
4087 % below is chosen so that the gutter has the same value (well, +-<1pt)
4088 % as it did when we hard-coded it.
4090 % We put the result in a separate register, \doublecolumhsize, so we
4091 % can restore it in \pagesofar, after \hsize itself has (potentially)
4092 % been clobbered.
4094 \doublecolumnhsize = \hsize
4095 \advance\doublecolumnhsize by -.04154\hsize
4096 \divide\doublecolumnhsize by 2
4097 \hsize = \doublecolumnhsize
4099 % Double the \vsize as well. (We don't need a separate register here,
4100 % since nobody clobbers \vsize.)
4101 \vsize = 2\vsize
4104 % The double-column output routine for all double-column pages except
4105 % the last.
4107 \def\doublecolumnout{%
4108 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4109 % Get the available space for the double columns -- the normal
4110 % (undoubled) page height minus any material left over from the
4111 % previous page.
4112 \dimen@ = \vsize
4113 \divide\dimen@ by 2
4114 \advance\dimen@ by -\ht\partialpage
4116 % box0 will be the left-hand column, box2 the right.
4117 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4118 \onepageout\pagesofar
4119 \unvbox255
4120 \penalty\outputpenalty
4123 % Re-output the contents of the output page -- any previous material,
4124 % followed by the two boxes we just split, in box0 and box2.
4125 \def\pagesofar{%
4126 \unvbox\partialpage
4128 \hsize = \doublecolumnhsize
4129 \wd0=\hsize \wd2=\hsize
4130 \hbox to\pagewidth{\box0\hfil\box2}%
4133 % All done with double columns.
4134 \def\enddoublecolumns{%
4135 \output = {%
4136 % Split the last of the double-column material. Leave it on the
4137 % current page, no automatic page break.
4138 \balancecolumns
4140 % If we end up splitting too much material for the current page,
4141 % though, there will be another page break right after this \output
4142 % invocation ends. Having called \balancecolumns once, we do not
4143 % want to call it again. Therefore, reset \output to its normal
4144 % definition right away. (We hope \balancecolumns will never be
4145 % called on to balance too much material, but if it is, this makes
4146 % the output somewhat more palatable.)
4147 \global\output = {\onepageout{\pagecontents\PAGE}}%
4149 \eject
4150 \endgroup % started in \begindoublecolumns
4152 % \pagegoal was set to the doubled \vsize above, since we restarted
4153 % the current page. We're now back to normal single-column
4154 % typesetting, so reset \pagegoal to the normal \vsize (after the
4155 % \endgroup where \vsize got restored).
4156 \pagegoal = \vsize
4159 % Called at the end of the double column material.
4160 \def\balancecolumns{%
4161 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4162 \dimen@ = \ht0
4163 \advance\dimen@ by \topskip
4164 \advance\dimen@ by-\baselineskip
4165 \divide\dimen@ by 2 % target to split to
4166 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4167 \splittopskip = \topskip
4168 % Loop until we get a decent breakpoint.
4170 \vbadness = 10000
4171 \loop
4172 \global\setbox3 = \copy0
4173 \global\setbox1 = \vsplit3 to \dimen@
4174 \ifdim\ht3>\dimen@
4175 \global\advance\dimen@ by 1pt
4176 \repeat
4178 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4179 \setbox0=\vbox to\dimen@{\unvbox1}%
4180 \setbox2=\vbox to\dimen@{\unvbox3}%
4182 \pagesofar
4184 \catcode`\@ = \other
4187 \message{sectioning,}
4188 % Chapters, sections, etc.
4190 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4191 % sections so that we can refer to them unambiguously in the pdf
4192 % outlines by their "section number". We avoid collisions with chapter
4193 % numbers by starting them at 10000. (If a document ever has 10000
4194 % chapters, we're in trouble anyway, I'm sure.)
4195 \newcount\unnumberedno \unnumberedno = 10000
4196 \newcount\chapno
4197 \newcount\secno \secno=0
4198 \newcount\subsecno \subsecno=0
4199 \newcount\subsubsecno \subsubsecno=0
4201 % This counter is funny since it counts through charcodes of letters A, B, ...
4202 \newcount\appendixno \appendixno = `\@
4204 % \def\appendixletter{\char\the\appendixno}
4205 % We do the following ugly conditional instead of the above simple
4206 % construct for the sake of pdftex, which needs the actual
4207 % letter in the expansion, not just typeset.
4209 \def\appendixletter{%
4210 \ifnum\appendixno=`A A%
4211 \else\ifnum\appendixno=`B B%
4212 \else\ifnum\appendixno=`C C%
4213 \else\ifnum\appendixno=`D D%
4214 \else\ifnum\appendixno=`E E%
4215 \else\ifnum\appendixno=`F F%
4216 \else\ifnum\appendixno=`G G%
4217 \else\ifnum\appendixno=`H H%
4218 \else\ifnum\appendixno=`I I%
4219 \else\ifnum\appendixno=`J J%
4220 \else\ifnum\appendixno=`K K%
4221 \else\ifnum\appendixno=`L L%
4222 \else\ifnum\appendixno=`M M%
4223 \else\ifnum\appendixno=`N N%
4224 \else\ifnum\appendixno=`O O%
4225 \else\ifnum\appendixno=`P P%
4226 \else\ifnum\appendixno=`Q Q%
4227 \else\ifnum\appendixno=`R R%
4228 \else\ifnum\appendixno=`S S%
4229 \else\ifnum\appendixno=`T T%
4230 \else\ifnum\appendixno=`U U%
4231 \else\ifnum\appendixno=`V V%
4232 \else\ifnum\appendixno=`W W%
4233 \else\ifnum\appendixno=`X X%
4234 \else\ifnum\appendixno=`Y Y%
4235 \else\ifnum\appendixno=`Z Z%
4236 % The \the is necessary, despite appearances, because \appendixletter is
4237 % expanded while writing the .toc file. \char\appendixno is not
4238 % expandable, thus it is written literally, thus all appendixes come out
4239 % with the same letter (or @) in the toc without it.
4240 \else\char\the\appendixno
4241 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4242 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4244 % Each @chapter defines this as the name of the chapter.
4245 % page headings and footings can use it. @section does likewise.
4246 % However, they are not reliable, because we don't use marks.
4247 \def\thischapter{}
4248 \def\thissection{}
4250 \newcount\absseclevel % used to calculate proper heading level
4251 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4253 % @raisesections: treat @section as chapter, @subsection as section, etc.
4254 \def\raisesections{\global\advance\secbase by -1}
4255 \let\up=\raisesections % original BFox name
4257 % @lowersections: treat @chapter as section, @section as subsection, etc.
4258 \def\lowersections{\global\advance\secbase by 1}
4259 \let\down=\lowersections % original BFox name
4261 % we only have subsub.
4262 \chardef\maxseclevel = 3
4264 % A numbered section within an unnumbered changes to unnumbered too.
4265 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4266 \chardef\unmlevel = \maxseclevel
4268 % Trace whether the current chapter is an appendix or not:
4269 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4270 \def\chapheadtype{N}
4272 % Choose a heading macro
4273 % #1 is heading type
4274 % #2 is heading level
4275 % #3 is text for heading
4276 \def\genhead#1#2#3{%
4277 % Compute the abs. sec. level:
4278 \absseclevel=#2
4279 \advance\absseclevel by \secbase
4280 % Make sure \absseclevel doesn't fall outside the range:
4281 \ifnum \absseclevel < 0
4282 \absseclevel = 0
4283 \else
4284 \ifnum \absseclevel > 3
4285 \absseclevel = 3
4288 % The heading type:
4289 \def\headtype{#1}%
4290 \if \headtype U%
4291 \ifnum \absseclevel < \unmlevel
4292 \chardef\unmlevel = \absseclevel
4294 \else
4295 % Check for appendix sections:
4296 \ifnum \absseclevel = 0
4297 \edef\chapheadtype{\headtype}%
4298 \else
4299 \if \headtype A\if \chapheadtype N%
4300 \errmessage{@appendix... within a non-appendix chapter}%
4301 \fi\fi
4303 % Check for numbered within unnumbered:
4304 \ifnum \absseclevel > \unmlevel
4305 \def\headtype{U}%
4306 \else
4307 \chardef\unmlevel = 3
4310 % Now print the heading:
4311 \if \headtype U%
4312 \ifcase\absseclevel
4313 \unnumberedzzz{#3}%
4314 \or \unnumberedseczzz{#3}%
4315 \or \unnumberedsubseczzz{#3}%
4316 \or \unnumberedsubsubseczzz{#3}%
4318 \else
4319 \if \headtype A%
4320 \ifcase\absseclevel
4321 \appendixzzz{#3}%
4322 \or \appendixsectionzzz{#3}%
4323 \or \appendixsubseczzz{#3}%
4324 \or \appendixsubsubseczzz{#3}%
4326 \else
4327 \ifcase\absseclevel
4328 \chapterzzz{#3}%
4329 \or \seczzz{#3}%
4330 \or \numberedsubseczzz{#3}%
4331 \or \numberedsubsubseczzz{#3}%
4335 \suppressfirstparagraphindent
4338 % an interface:
4339 \def\numhead{\genhead N}
4340 \def\apphead{\genhead A}
4341 \def\unnmhead{\genhead U}
4343 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4344 % all lower-level sectioning counters to zero.
4346 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4347 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4348 \let\chaplevelprefix = \empty
4350 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4351 \def\chapterzzz#1{%
4352 % section resetting is \global in case the chapter is in a group, such
4353 % as an @include file.
4354 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4355 \global\advance\chapno by 1
4357 % Used for \float.
4358 \gdef\chaplevelprefix{\the\chapno.}%
4359 \resetallfloatnos
4361 \message{\putwordChapter\space \the\chapno}%
4363 % Write the actual heading.
4364 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4366 % So @section and the like are numbered underneath this chapter.
4367 \global\let\section = \numberedsec
4368 \global\let\subsection = \numberedsubsec
4369 \global\let\subsubsection = \numberedsubsubsec
4372 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4373 \def\appendixzzz#1{%
4374 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4375 \global\advance\appendixno by 1
4376 \gdef\chaplevelprefix{\appendixletter.}%
4377 \resetallfloatnos
4379 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4380 \message{\appendixnum}%
4382 \chapmacro{#1}{Yappendix}{\appendixletter}%
4384 \global\let\section = \appendixsec
4385 \global\let\subsection = \appendixsubsec
4386 \global\let\subsubsection = \appendixsubsubsec
4389 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4390 \def\unnumberedzzz#1{%
4391 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4392 \global\advance\unnumberedno by 1
4394 % Since an unnumbered has no number, no prefix for figures.
4395 \global\let\chaplevelprefix = \empty
4396 \resetallfloatnos
4398 % This used to be simply \message{#1}, but TeX fully expands the
4399 % argument to \message. Therefore, if #1 contained @-commands, TeX
4400 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4401 % expanded @cite (which turns out to cause errors because \cite is meant
4402 % to be executed, not expanded).
4404 % Anyway, we don't want the fully-expanded definition of @cite to appear
4405 % as a result of the \message, we just want `@cite' itself. We use
4406 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4407 % simply yielding the contents of <toks register>. (We also do this for
4408 % the toc entries.)
4409 \toks0 = {#1}%
4410 \message{(\the\toks0)}%
4412 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4414 \global\let\section = \unnumberedsec
4415 \global\let\subsection = \unnumberedsubsec
4416 \global\let\subsubsection = \unnumberedsubsubsec
4419 % @centerchap is like @unnumbered, but the heading is centered.
4420 \outer\parseargdef\centerchap{%
4421 % Well, we could do the following in a group, but that would break
4422 % an assumption that \chapmacro is called at the outermost level.
4423 % Thus we are safer this way: --kasal, 24feb04
4424 \let\centerparametersmaybe = \centerparameters
4425 \unnmhead0{#1}%
4426 \let\centerparametersmaybe = \relax
4429 % @top is like @unnumbered.
4430 \let\top\unnumbered
4432 % Sections.
4433 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4434 \def\seczzz#1{%
4435 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4436 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4439 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4440 \def\appendixsectionzzz#1{%
4441 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4442 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4444 \let\appendixsec\appendixsection
4446 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4447 \def\unnumberedseczzz#1{%
4448 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4449 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4452 % Subsections.
4453 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4454 \def\numberedsubseczzz#1{%
4455 \global\subsubsecno=0 \global\advance\subsecno by 1
4456 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4459 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4460 \def\appendixsubseczzz#1{%
4461 \global\subsubsecno=0 \global\advance\subsecno by 1
4462 \sectionheading{#1}{subsec}{Yappendix}%
4463 {\appendixletter.\the\secno.\the\subsecno}%
4466 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4467 \def\unnumberedsubseczzz#1{%
4468 \global\subsubsecno=0 \global\advance\subsecno by 1
4469 \sectionheading{#1}{subsec}{Ynothing}%
4470 {\the\unnumberedno.\the\secno.\the\subsecno}%
4473 % Subsubsections.
4474 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4475 \def\numberedsubsubseczzz#1{%
4476 \global\advance\subsubsecno by 1
4477 \sectionheading{#1}{subsubsec}{Ynumbered}%
4478 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4481 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4482 \def\appendixsubsubseczzz#1{%
4483 \global\advance\subsubsecno by 1
4484 \sectionheading{#1}{subsubsec}{Yappendix}%
4485 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4488 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4489 \def\unnumberedsubsubseczzz#1{%
4490 \global\advance\subsubsecno by 1
4491 \sectionheading{#1}{subsubsec}{Ynothing}%
4492 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4495 % These macros control what the section commands do, according
4496 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4497 % Define them by default for a numbered chapter.
4498 \let\section = \numberedsec
4499 \let\subsection = \numberedsubsec
4500 \let\subsubsection = \numberedsubsubsec
4502 % Define @majorheading, @heading and @subheading
4504 % NOTE on use of \vbox for chapter headings, section headings, and such:
4505 % 1) We use \vbox rather than the earlier \line to permit
4506 % overlong headings to fold.
4507 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4508 % heading is obnoxious; this forbids it.
4509 % 3) Likewise, headings look best if no \parindent is used, and
4510 % if justification is not attempted. Hence \raggedright.
4513 \def\majorheading{%
4514 {\advance\chapheadingskip by 10pt \chapbreak }%
4515 \parsearg\chapheadingzzz
4518 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4519 \def\chapheadingzzz#1{%
4520 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4521 \parindent=0pt\raggedright
4522 \rm #1\hfill}}%
4523 \bigskip \par\penalty 200\relax
4524 \suppressfirstparagraphindent
4527 % @heading, @subheading, @subsubheading.
4528 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4529 \suppressfirstparagraphindent}
4530 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4531 \suppressfirstparagraphindent}
4532 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4533 \suppressfirstparagraphindent}
4535 % These macros generate a chapter, section, etc. heading only
4536 % (including whitespace, linebreaking, etc. around it),
4537 % given all the information in convenient, parsed form.
4539 %%% Args are the skip and penalty (usually negative)
4540 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4542 %%% Define plain chapter starts, and page on/off switching for it
4543 % Parameter controlling skip before chapter headings (if needed)
4545 \newskip\chapheadingskip
4547 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4548 \def\chappager{\par\vfill\supereject}
4549 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4551 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4553 \def\CHAPPAGoff{%
4554 \global\let\contentsalignmacro = \chappager
4555 \global\let\pchapsepmacro=\chapbreak
4556 \global\let\pagealignmacro=\chappager}
4558 \def\CHAPPAGon{%
4559 \global\let\contentsalignmacro = \chappager
4560 \global\let\pchapsepmacro=\chappager
4561 \global\let\pagealignmacro=\chappager
4562 \global\def\HEADINGSon{\HEADINGSsingle}}
4564 \def\CHAPPAGodd{%
4565 \global\let\contentsalignmacro = \chapoddpage
4566 \global\let\pchapsepmacro=\chapoddpage
4567 \global\let\pagealignmacro=\chapoddpage
4568 \global\def\HEADINGSon{\HEADINGSdouble}}
4570 \CHAPPAGon
4572 % Chapter opening.
4574 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4575 % Yappendix, Yomitfromtoc), #3 the chapter number.
4577 % To test against our argument.
4578 \def\Ynothingkeyword{Ynothing}
4579 \def\Yomitfromtockeyword{Yomitfromtoc}
4580 \def\Yappendixkeyword{Yappendix}
4582 \def\chapmacro#1#2#3{%
4583 \pchapsepmacro
4585 \chapfonts \rm
4587 % Have to define \thissection before calling \donoderef, because the
4588 % xref code eventually uses it. On the other hand, it has to be called
4589 % after \pchapsepmacro, or the headline will change too soon.
4590 \gdef\thissection{#1}%
4591 \gdef\thischaptername{#1}%
4593 % Only insert the separating space if we have a chapter/appendix
4594 % number, and don't print the unnumbered ``number''.
4595 \def\temptype{#2}%
4596 \ifx\temptype\Ynothingkeyword
4597 \setbox0 = \hbox{}%
4598 \def\toctype{unnchap}%
4599 \gdef\thischapternum{}%
4600 \gdef\thischapter{#1}%
4601 \else\ifx\temptype\Yomitfromtockeyword
4602 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4603 \def\toctype{omit}%
4604 \gdef\thischapternum{}%
4605 \gdef\thischapter{}%
4606 \else\ifx\temptype\Yappendixkeyword
4607 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4608 \def\toctype{app}%
4609 \xdef\thischapternum{\appendixletter}%
4610 % We don't substitute the actual chapter name into \thischapter
4611 % because we don't want its macros evaluated now. And we don't
4612 % use \thissection because that changes with each section.
4614 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4615 \noexpand\thischaptername}%
4616 \else
4617 \setbox0 = \hbox{#3\enspace}%
4618 \def\toctype{numchap}%
4619 \xdef\thischapternum{\the\chapno}%
4620 \xdef\thischapter{\putwordChapter{} \the\chapno:
4621 \noexpand\thischaptername}%
4622 \fi\fi\fi
4624 % Write the toc entry for this chapter. Must come before the
4625 % \donoderef, because we include the current node name in the toc
4626 % entry, and \donoderef resets it to empty.
4627 \writetocentry{\toctype}{#1}{#3}%
4629 % For pdftex, we have to write out the node definition (aka, make
4630 % the pdfdest) after any page break, but before the actual text has
4631 % been typeset. If the destination for the pdf outline is after the
4632 % text, then jumping from the outline may wind up with the text not
4633 % being visible, for instance under high magnification.
4634 \donoderef{#2}%
4636 % Typeset the actual heading.
4637 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4638 \hangindent=\wd0 \centerparametersmaybe
4639 \unhbox0 #1\par}%
4641 \nobreak\bigskip % no page break after a chapter title
4642 \nobreak
4645 % @centerchap -- centered and unnumbered.
4646 \let\centerparametersmaybe = \relax
4647 \def\centerparameters{%
4648 \advance\rightskip by 3\rightskip
4649 \leftskip = \rightskip
4650 \parfillskip = 0pt
4654 % I don't think this chapter style is supported any more, so I'm not
4655 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4657 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4659 \def\unnchfopen #1{%
4660 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4661 \parindent=0pt\raggedright
4662 \rm #1\hfill}}\bigskip \par\nobreak
4664 \def\chfopen #1#2{\chapoddpage {\chapfonts
4665 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4666 \par\penalty 5000 %
4668 \def\centerchfopen #1{%
4669 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4670 \parindent=0pt
4671 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4673 \def\CHAPFopen{%
4674 \global\let\chapmacro=\chfopen
4675 \global\let\centerchapmacro=\centerchfopen}
4678 % Section titles. These macros combine the section number parts and
4679 % call the generic \sectionheading to do the printing.
4681 \newskip\secheadingskip
4682 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4684 % Subsection titles.
4685 \newskip\subsecheadingskip
4686 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4688 % Subsubsection titles.
4689 \def\subsubsecheadingskip{\subsecheadingskip}
4690 \def\subsubsecheadingbreak{\subsecheadingbreak}
4693 % Print any size, any type, section title.
4695 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4696 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4697 % section number.
4699 \def\sectionheading#1#2#3#4{%
4701 % Switch to the right set of fonts.
4702 \csname #2fonts\endcsname \rm
4704 % Insert space above the heading.
4705 \csname #2headingbreak\endcsname
4707 % Only insert the space after the number if we have a section number.
4708 \def\sectionlevel{#2}%
4709 \def\temptype{#3}%
4711 \ifx\temptype\Ynothingkeyword
4712 \setbox0 = \hbox{}%
4713 \def\toctype{unn}%
4714 \gdef\thissection{#1}%
4715 \else\ifx\temptype\Yomitfromtockeyword
4716 % for @headings -- no section number, don't include in toc,
4717 % and don't redefine \thissection.
4718 \setbox0 = \hbox{}%
4719 \def\toctype{omit}%
4720 \let\sectionlevel=\empty
4721 \else\ifx\temptype\Yappendixkeyword
4722 \setbox0 = \hbox{#4\enspace}%
4723 \def\toctype{app}%
4724 \gdef\thissection{#1}%
4725 \else
4726 \setbox0 = \hbox{#4\enspace}%
4727 \def\toctype{num}%
4728 \gdef\thissection{#1}%
4729 \fi\fi\fi
4731 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4732 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4734 % Write the node reference (= pdf destination for pdftex).
4735 % Again, see comments in \chapmacro.
4736 \donoderef{#3}%
4738 % Interline glue will be inserted when the vbox is completed.
4739 % That glue will be a valid breakpoint for the page, since it'll be
4740 % preceded by a whatsit (usually from the \donoderef, or from the
4741 % \writetocentry if there was no node). We don't want to allow that
4742 % break, since then the whatsits could end up on page n while the
4743 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4744 \nobreak
4746 % Output the actual section heading.
4747 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4748 \hangindent=\wd0 % zero if no section number
4749 \unhbox0 #1}%
4751 % Add extra space after the heading -- half of whatever came above it.
4752 % Don't allow stretch, though.
4753 \kern .5 \csname #2headingskip\endcsname
4755 % Do not let the kern be a potential breakpoint, as it would be if it
4756 % was followed by glue.
4757 \nobreak
4759 % We'll almost certainly start a paragraph next, so don't let that
4760 % glue accumulate. (Not a breakpoint because it's preceded by a
4761 % discardable item.)
4762 \vskip-\parskip
4764 % This is purely so the last item on the list is a known \penalty >
4765 % 10000. This is so \startdefun can avoid allowing breakpoints after
4766 % section headings. Otherwise, it would insert a valid breakpoint between:
4768 % @section sec-whatever
4769 % @deffn def-whatever
4770 \penalty 10001
4774 \message{toc,}
4775 % Table of contents.
4776 \newwrite\tocfile
4778 % Write an entry to the toc file, opening it if necessary.
4779 % Called from @chapter, etc.
4781 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4782 % We append the current node name (if any) and page number as additional
4783 % arguments for the \{chap,sec,...}entry macros which will eventually
4784 % read this. The node name is used in the pdf outlines as the
4785 % destination to jump to.
4787 % We open the .toc file for writing here instead of at @setfilename (or
4788 % any other fixed time) so that @contents can be anywhere in the document.
4789 % But if #1 is `omit', then we don't do anything. This is used for the
4790 % table of contents chapter openings themselves.
4792 \newif\iftocfileopened
4793 \def\omitkeyword{omit}%
4795 \def\writetocentry#1#2#3{%
4796 \edef\writetoctype{#1}%
4797 \ifx\writetoctype\omitkeyword \else
4798 \iftocfileopened\else
4799 \immediate\openout\tocfile = \jobname.toc
4800 \global\tocfileopenedtrue
4803 \iflinks
4804 {\atdummies
4805 \edef\temp{%
4806 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4807 \temp
4812 % Tell \shipout to create a pdf destination on each page, if we're
4813 % writing pdf. These are used in the table of contents. We can't
4814 % just write one on every page because the title pages are numbered
4815 % 1 and 2 (the page numbers aren't printed), and so are the first
4816 % two pages of the document. Thus, we'd have two destinations named
4817 % `1', and two named `2'.
4818 \ifpdf \global\pdfmakepagedesttrue \fi
4822 % These characters do not print properly in the Computer Modern roman
4823 % fonts, so we must take special care. This is more or less redundant
4824 % with the Texinfo input format setup at the end of this file.
4826 \def\activecatcodes{%
4827 \catcode`\"=\active
4828 \catcode`\$=\active
4829 \catcode`\<=\active
4830 \catcode`\>=\active
4831 \catcode`\\=\active
4832 \catcode`\^=\active
4833 \catcode`\_=\active
4834 \catcode`\|=\active
4835 \catcode`\~=\active
4839 % Read the toc file, which is essentially Texinfo input.
4840 \def\readtocfile{%
4841 \setupdatafile
4842 \activecatcodes
4843 \input \jobname.toc
4846 \newskip\contentsrightmargin \contentsrightmargin=1in
4847 \newcount\savepageno
4848 \newcount\lastnegativepageno \lastnegativepageno = -1
4850 % Prepare to read what we've written to \tocfile.
4852 \def\startcontents#1{%
4853 % If @setchapternewpage on, and @headings double, the contents should
4854 % start on an odd page, unlike chapters. Thus, we maintain
4855 % \contentsalignmacro in parallel with \pagealignmacro.
4856 % From: Torbjorn Granlund <tege@matematik.su.se>
4857 \contentsalignmacro
4858 \immediate\closeout\tocfile
4860 % Don't need to put `Contents' or `Short Contents' in the headline.
4861 % It is abundantly clear what they are.
4862 \def\thischapter{}%
4863 \chapmacro{#1}{Yomitfromtoc}{}%
4865 \savepageno = \pageno
4866 \begingroup % Set up to handle contents files properly.
4867 \raggedbottom % Worry more about breakpoints than the bottom.
4868 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4870 % Roman numerals for page numbers.
4871 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4875 % Normal (long) toc.
4876 \def\contents{%
4877 \startcontents{\putwordTOC}%
4878 \openin 1 \jobname.toc
4879 \ifeof 1 \else
4880 \readtocfile
4882 \vfill \eject
4883 \contentsalignmacro % in case @setchapternewpage odd is in effect
4884 \ifeof 1 \else
4885 \pdfmakeoutlines
4887 \closein 1
4888 \endgroup
4889 \lastnegativepageno = \pageno
4890 \global\pageno = \savepageno
4893 % And just the chapters.
4894 \def\summarycontents{%
4895 \startcontents{\putwordShortTOC}%
4897 \let\numchapentry = \shortchapentry
4898 \let\appentry = \shortchapentry
4899 \let\unnchapentry = \shortunnchapentry
4900 % We want a true roman here for the page numbers.
4901 \secfonts
4902 \let\rm=\shortcontrm \let\bf=\shortcontbf
4903 \let\sl=\shortcontsl \let\tt=\shortconttt
4905 \hyphenpenalty = 10000
4906 \advance\baselineskip by 1pt % Open it up a little.
4907 \def\numsecentry##1##2##3##4{}
4908 \let\appsecentry = \numsecentry
4909 \let\unnsecentry = \numsecentry
4910 \let\numsubsecentry = \numsecentry
4911 \let\appsubsecentry = \numsecentry
4912 \let\unnsubsecentry = \numsecentry
4913 \let\numsubsubsecentry = \numsecentry
4914 \let\appsubsubsecentry = \numsecentry
4915 \let\unnsubsubsecentry = \numsecentry
4916 \openin 1 \jobname.toc
4917 \ifeof 1 \else
4918 \readtocfile
4920 \closein 1
4921 \vfill \eject
4922 \contentsalignmacro % in case @setchapternewpage odd is in effect
4923 \endgroup
4924 \lastnegativepageno = \pageno
4925 \global\pageno = \savepageno
4927 \let\shortcontents = \summarycontents
4929 % Typeset the label for a chapter or appendix for the short contents.
4930 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4932 \def\shortchaplabel#1{%
4933 % This space should be enough, since a single number is .5em, and the
4934 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4935 % But use \hss just in case.
4936 % (This space doesn't include the extra space that gets added after
4937 % the label; that gets put in by \shortchapentry above.)
4939 % We'd like to right-justify chapter numbers, but that looks strange
4940 % with appendix letters. And right-justifying numbers and
4941 % left-justifying letters looks strange when there is less than 10
4942 % chapters. Have to read the whole toc once to know how many chapters
4943 % there are before deciding ...
4944 \hbox to 1em{#1\hss}%
4947 % These macros generate individual entries in the table of contents.
4948 % The first argument is the chapter or section name.
4949 % The last argument is the page number.
4950 % The arguments in between are the chapter number, section number, ...
4952 % Chapters, in the main contents.
4953 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4955 % Chapters, in the short toc.
4956 % See comments in \dochapentry re vbox and related settings.
4957 \def\shortchapentry#1#2#3#4{%
4958 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4961 % Appendices, in the main contents.
4962 % Need the word Appendix, and a fixed-size box.
4964 \def\appendixbox#1{%
4965 % We use M since it's probably the widest letter.
4966 \setbox0 = \hbox{\putwordAppendix{} M}%
4967 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4969 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4971 % Unnumbered chapters.
4972 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4973 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4975 % Sections.
4976 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4977 \let\appsecentry=\numsecentry
4978 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4980 % Subsections.
4981 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4982 \let\appsubsecentry=\numsubsecentry
4983 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4985 % And subsubsections.
4986 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4987 \let\appsubsubsecentry=\numsubsubsecentry
4988 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4990 % This parameter controls the indentation of the various levels.
4991 % Same as \defaultparindent.
4992 \newdimen\tocindent \tocindent = 15pt
4994 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4995 % page number.
4997 % If the toc has to be broken over pages, we want it to be at chapters
4998 % if at all possible; hence the \penalty.
4999 \def\dochapentry#1#2{%
5000 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5001 \begingroup
5002 \chapentryfonts
5003 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5004 \endgroup
5005 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5008 \def\dosecentry#1#2{\begingroup
5009 \secentryfonts \leftskip=\tocindent
5010 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5011 \endgroup}
5013 \def\dosubsecentry#1#2{\begingroup
5014 \subsecentryfonts \leftskip=2\tocindent
5015 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5016 \endgroup}
5018 \def\dosubsubsecentry#1#2{\begingroup
5019 \subsubsecentryfonts \leftskip=3\tocindent
5020 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5021 \endgroup}
5023 % We use the same \entry macro as for the index entries.
5024 \let\tocentry = \entry
5026 % Space between chapter (or whatever) number and the title.
5027 \def\labelspace{\hskip1em \relax}
5029 \def\dopageno#1{{\rm #1}}
5030 \def\doshortpageno#1{{\rm #1}}
5032 \def\chapentryfonts{\secfonts \rm}
5033 \def\secentryfonts{\textfonts}
5034 \def\subsecentryfonts{\textfonts}
5035 \def\subsubsecentryfonts{\textfonts}
5038 \message{environments,}
5039 % @foo ... @end foo.
5041 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5043 % Since these characters are used in examples, it should be an even number of
5044 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5046 \def\point{$\star$}
5047 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5048 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5049 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5050 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5052 % The @error{} command.
5053 % Adapted from the TeXbook's \boxit.
5055 \newbox\errorbox
5057 {\tentt \global\dimen0 = 3em}% Width of the box.
5058 \dimen2 = .55pt % Thickness of rules
5059 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5060 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5062 \setbox\errorbox=\hbox to \dimen0{\hfil
5063 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5064 \advance\hsize by -2\dimen2 % Rules.
5065 \vbox{%
5066 \hrule height\dimen2
5067 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5068 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5069 \kern3pt\vrule width\dimen2}% Space to right.
5070 \hrule height\dimen2}
5071 \hfil}
5073 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5075 % @tex ... @end tex escapes into raw Tex temporarily.
5076 % One exception: @ is still an escape character, so that @end tex works.
5077 % But \@ or @@ will get a plain tex @ character.
5079 \envdef\tex{%
5080 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5081 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5082 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5083 \catcode `\%=14
5084 \catcode `\+=\other
5085 \catcode `\"=\other
5086 \catcode `\|=\other
5087 \catcode `\<=\other
5088 \catcode `\>=\other
5089 \escapechar=`\\
5091 \let\b=\ptexb
5092 \let\bullet=\ptexbullet
5093 \let\c=\ptexc
5094 \let\,=\ptexcomma
5095 \let\.=\ptexdot
5096 \let\dots=\ptexdots
5097 \let\equiv=\ptexequiv
5098 \let\!=\ptexexclam
5099 \let\i=\ptexi
5100 \let\indent=\ptexindent
5101 \let\noindent=\ptexnoindent
5102 \let\{=\ptexlbrace
5103 \let\+=\tabalign
5104 \let\}=\ptexrbrace
5105 \let\/=\ptexslash
5106 \let\*=\ptexstar
5107 \let\t=\ptext
5108 \let\frenchspacing=\plainfrenchspacing
5110 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5111 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5112 \def\@{@}%
5114 % There is no need to define \Etex.
5116 % Define @lisp ... @end lisp.
5117 % @lisp environment forms a group so it can rebind things,
5118 % including the definition of @end lisp (which normally is erroneous).
5120 % Amount to narrow the margins by for @lisp.
5121 \newskip\lispnarrowing \lispnarrowing=0.4in
5123 % This is the definition that ^^M gets inside @lisp, @example, and other
5124 % such environments. \null is better than a space, since it doesn't
5125 % have any width.
5126 \def\lisppar{\null\endgraf}
5128 % This space is always present above and below environments.
5129 \newskip\envskipamount \envskipamount = 0pt
5131 % Make spacing and below environment symmetrical. We use \parskip here
5132 % to help in doing that, since in @example-like environments \parskip
5133 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5134 % start of the next paragraph will insert \parskip.
5136 \def\aboveenvbreak{{%
5137 % =10000 instead of <10000 because of a special case in \itemzzz and
5138 % \sectionheading, q.v.
5139 \ifnum \lastpenalty=10000 \else
5140 \advance\envskipamount by \parskip
5141 \endgraf
5142 \ifdim\lastskip<\envskipamount
5143 \removelastskip
5144 % it's not a good place to break if the last penalty was \nobreak
5145 % or better ...
5146 \ifnum\lastpenalty<10000 \penalty-50 \fi
5147 \vskip\envskipamount
5152 \let\afterenvbreak = \aboveenvbreak
5154 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5155 % also clear it, so that its embedded environments do the narrowing again.
5156 \let\nonarrowing=\relax
5158 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5159 % environment contents.
5160 \font\circle=lcircle10
5161 \newdimen\circthick
5162 \newdimen\cartouter\newdimen\cartinner
5163 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5164 \circthick=\fontdimen8\circle
5166 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5167 \def\ctr{{\hskip 6pt\circle\char'010}}
5168 \def\cbl{{\circle\char'012\hskip -6pt}}
5169 \def\cbr{{\hskip 6pt\circle\char'011}}
5170 \def\carttop{\hbox to \cartouter{\hskip\lskip
5171 \ctl\leaders\hrule height\circthick\hfil\ctr
5172 \hskip\rskip}}
5173 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5174 \cbl\leaders\hrule height\circthick\hfil\cbr
5175 \hskip\rskip}}
5177 \newskip\lskip\newskip\rskip
5179 \envdef\cartouche{%
5180 \ifhmode\par\fi % can't be in the midst of a paragraph.
5181 \startsavinginserts
5182 \lskip=\leftskip \rskip=\rightskip
5183 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5184 \cartinner=\hsize \advance\cartinner by-\lskip
5185 \advance\cartinner by-\rskip
5186 \cartouter=\hsize
5187 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5188 % side, and for 6pt waste from
5189 % each corner char, and rule thickness
5190 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5191 % Flag to tell @lisp, etc., not to narrow margin.
5192 \let\nonarrowing = t%
5193 \vbox\bgroup
5194 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5195 \carttop
5196 \hbox\bgroup
5197 \hskip\lskip
5198 \vrule\kern3pt
5199 \vbox\bgroup
5200 \kern3pt
5201 \hsize=\cartinner
5202 \baselineskip=\normbskip
5203 \lineskip=\normlskip
5204 \parskip=\normpskip
5205 \vskip -\parskip
5206 \comment % For explanation, see the end of \def\group.
5208 \def\Ecartouche{%
5209 \ifhmode\par\fi
5210 \kern3pt
5211 \egroup
5212 \kern3pt\vrule
5213 \hskip\rskip
5214 \egroup
5215 \cartbot
5216 \egroup
5217 \checkinserts
5221 % This macro is called at the beginning of all the @example variants,
5222 % inside a group.
5223 \def\nonfillstart{%
5224 \aboveenvbreak
5225 \hfuzz = 12pt % Don't be fussy
5226 \sepspaces % Make spaces be word-separators rather than space tokens.
5227 \let\par = \lisppar % don't ignore blank lines
5228 \obeylines % each line of input is a line of output
5229 \parskip = 0pt
5230 \parindent = 0pt
5231 \emergencystretch = 0pt % don't try to avoid overfull boxes
5232 \ifx\nonarrowing\relax
5233 \advance \leftskip by \lispnarrowing
5234 \exdentamount=\lispnarrowing
5235 \else
5236 \let\nonarrowing = \relax
5238 \let\exdent=\nofillexdent
5241 % If you want all examples etc. small: @set dispenvsize small.
5242 % If you want even small examples the full size: @set dispenvsize nosmall.
5243 % This affects the following displayed environments:
5244 % @example, @display, @format, @lisp
5246 \def\smallword{small}
5247 \def\nosmallword{nosmall}
5248 \let\SETdispenvsize\relax
5249 \def\setnormaldispenv{%
5250 \ifx\SETdispenvsize\smallword
5251 \smallexamplefonts \rm
5254 \def\setsmalldispenv{%
5255 \ifx\SETdispenvsize\nosmallword
5256 \else
5257 \smallexamplefonts \rm
5261 % We often define two environments, @foo and @smallfoo.
5262 % Let's do it by one command:
5263 \def\makedispenv #1#2{
5264 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5265 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5266 \expandafter\let\csname E#1\endcsname \afterenvbreak
5267 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5270 % Define two synonyms:
5271 \def\maketwodispenvs #1#2#3{
5272 \makedispenv{#1}{#3}
5273 \makedispenv{#2}{#3}
5276 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5278 % @smallexample and @smalllisp: use smaller fonts.
5279 % Originally contributed by Pavel@xerox.
5281 \maketwodispenvs {lisp}{example}{%
5282 \nonfillstart
5283 \tt\quoteexpand
5284 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5285 \gobble % eat return
5287 % @display/@smalldisplay: same as @lisp except keep current font.
5289 \makedispenv {display}{%
5290 \nonfillstart
5291 \gobble
5294 % @format/@smallformat: same as @display except don't narrow margins.
5296 \makedispenv{format}{%
5297 \let\nonarrowing = t%
5298 \nonfillstart
5299 \gobble
5302 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5303 \envdef\flushleft{%
5304 \let\nonarrowing = t%
5305 \nonfillstart
5306 \gobble
5308 \let\Eflushleft = \afterenvbreak
5310 % @flushright.
5312 \envdef\flushright{%
5313 \let\nonarrowing = t%
5314 \nonfillstart
5315 \advance\leftskip by 0pt plus 1fill
5316 \gobble
5318 \let\Eflushright = \afterenvbreak
5321 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5322 % and narrows the margins. We keep \parskip nonzero in general, since
5323 % we're doing normal filling. So, when using \aboveenvbreak and
5324 % \afterenvbreak, temporarily make \parskip 0.
5326 \envdef\quotation{%
5327 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5328 \parindent=0pt
5330 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5331 \ifx\nonarrowing\relax
5332 \advance\leftskip by \lispnarrowing
5333 \advance\rightskip by \lispnarrowing
5334 \exdentamount = \lispnarrowing
5335 \else
5336 \let\nonarrowing = \relax
5338 \parsearg\quotationlabel
5341 % We have retained a nonzero parskip for the environment, since we're
5342 % doing normal filling.
5344 \def\Equotation{%
5345 \par
5346 \ifx\quotationauthor\undefined\else
5347 % indent a bit.
5348 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5350 {\parskip=0pt \afterenvbreak}%
5353 % If we're given an argument, typeset it in bold with a colon after.
5354 \def\quotationlabel#1{%
5355 \def\temp{#1}%
5356 \ifx\temp\empty \else
5357 {\bf #1: }%
5362 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5363 % If we want to allow any <char> as delimiter,
5364 % we need the curly braces so that makeinfo sees the @verb command, eg:
5365 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5367 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5369 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5370 % active too. Otherwise, they get lost as the first character on a
5371 % verbatim line.
5372 \def\dospecials{%
5373 \do\ \do\\\do\{\do\}\do\$\do\&%
5374 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5375 \do\<\do\>\do\|\do\@\do+\do\"%
5378 % [Knuth] p. 380
5379 \def\uncatcodespecials{%
5380 \def\do##1{\catcode`##1=\other}\dospecials}
5382 % [Knuth] pp. 380,381,391
5383 % Disable Spanish ligatures ?` and !` of \tt font
5384 \begingroup
5385 \catcode`\`=\active\gdef`{\relax\lq}
5386 \endgroup
5388 % Setup for the @verb command.
5390 % Eight spaces for a tab
5391 \begingroup
5392 \catcode`\^^I=\active
5393 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5394 \endgroup
5396 \def\setupverb{%
5397 \tt % easiest (and conventionally used) font for verbatim
5398 \def\par{\leavevmode\endgraf}%
5399 \catcode`\`=\active
5400 \tabeightspaces
5401 % Respect line breaks,
5402 % print special symbols as themselves, and
5403 % make each space count
5404 % must do in this order:
5405 \obeylines \uncatcodespecials \sepspaces
5408 % Setup for the @verbatim environment
5410 % Real tab expansion
5411 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5413 \def\starttabbox{\setbox0=\hbox\bgroup}
5415 % Allow an option to not replace quotes with a regular directed right
5416 % quote/apostrophe (char 0x27), but instead use the undirected quote
5417 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5418 % the default, but it works for pasting with more pdf viewers (at least
5419 % evince), the lilypond developers report. xpdf does work with the
5420 % regular 0x27.
5422 \def\codequoteright{%
5423 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5425 \else
5426 \char'15
5430 % and a similar option for the left quote char vs. a grave accent.
5431 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5432 % the code environments to do likewise.
5434 \def\codequoteleft{%
5435 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5437 \else
5438 \char'22
5442 \begingroup
5443 \catcode`\^^I=\active
5444 \gdef\tabexpand{%
5445 \catcode`\^^I=\active
5446 \def^^I{\leavevmode\egroup
5447 \dimen0=\wd0 % the width so far, or since the previous tab
5448 \divide\dimen0 by\tabw
5449 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5450 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5451 \wd0=\dimen0 \box0 \starttabbox
5454 \catcode`\'=\active
5455 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
5457 \catcode`\`=\active
5458 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
5460 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
5461 \endgroup
5463 % start the verbatim environment.
5464 \def\setupverbatim{%
5465 \let\nonarrowing = t%
5466 \nonfillstart
5467 % Easiest (and conventionally used) font for verbatim
5469 \def\par{\leavevmode\egroup\box0\endgraf}%
5470 \catcode`\`=\active
5471 \tabexpand
5472 \quoteexpand
5473 % Respect line breaks,
5474 % print special symbols as themselves, and
5475 % make each space count
5476 % must do in this order:
5477 \obeylines \uncatcodespecials \sepspaces
5478 \everypar{\starttabbox}%
5481 % Do the @verb magic: verbatim text is quoted by unique
5482 % delimiter characters. Before first delimiter expect a
5483 % right brace, after last delimiter expect closing brace:
5485 % \def\doverb'{'<char>#1<char>'}'{#1}
5487 % [Knuth] p. 382; only eat outer {}
5488 \begingroup
5489 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5490 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5491 \endgroup
5493 \def\verb{\begingroup\setupverb\doverb}
5496 % Do the @verbatim magic: define the macro \doverbatim so that
5497 % the (first) argument ends when '@end verbatim' is reached, ie:
5499 % \def\doverbatim#1@end verbatim{#1}
5501 % For Texinfo it's a lot easier than for LaTeX,
5502 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5503 % we need not redefine '\', '{' and '}'.
5505 % Inspired by LaTeX's verbatim command set [latex.ltx]
5507 \begingroup
5508 \catcode`\ =\active
5509 \obeylines %
5510 % ignore everything up to the first ^^M, that's the newline at the end
5511 % of the @verbatim input line itself. Otherwise we get an extra blank
5512 % line in the output.
5513 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5514 % We really want {...\end verbatim} in the body of the macro, but
5515 % without the active space; thus we have to use \xdef and \gobble.
5516 \endgroup
5518 \envdef\verbatim{%
5519 \setupverbatim\doverbatim
5521 \let\Everbatim = \afterenvbreak
5524 % @verbatiminclude FILE - insert text of file in verbatim environment.
5526 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5528 \def\doverbatiminclude#1{%
5530 \makevalueexpandable
5531 \setupverbatim
5532 \input #1
5533 \afterenvbreak
5537 % @copying ... @end copying.
5538 % Save the text away for @insertcopying later.
5540 % We save the uninterpreted tokens, rather than creating a box.
5541 % Saving the text in a box would be much easier, but then all the
5542 % typesetting commands (@smallbook, font changes, etc.) have to be done
5543 % beforehand -- and a) we want @copying to be done first in the source
5544 % file; b) letting users define the frontmatter in as flexible order as
5545 % possible is very desirable.
5547 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5548 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5550 \def\insertcopying{%
5551 \begingroup
5552 \parindent = 0pt % paragraph indentation looks wrong on title page
5553 \scanexp\copyingtext
5554 \endgroup
5557 \message{defuns,}
5558 % @defun etc.
5560 \newskip\defbodyindent \defbodyindent=.4in
5561 \newskip\defargsindent \defargsindent=50pt
5562 \newskip\deflastargmargin \deflastargmargin=18pt
5564 % Start the processing of @deffn:
5565 \def\startdefun{%
5566 \ifnum\lastpenalty<10000
5567 \medbreak
5568 \else
5569 % If there are two @def commands in a row, we'll have a \nobreak,
5570 % which is there to keep the function description together with its
5571 % header. But if there's nothing but headers, we need to allow a
5572 % break somewhere. Check specifically for penalty 10002, inserted
5573 % by \defargscommonending, instead of 10000, since the sectioning
5574 % commands also insert a nobreak penalty, and we don't want to allow
5575 % a break between a section heading and a defun.
5577 \ifnum\lastpenalty=10002 \penalty2000 \fi
5579 % Similarly, after a section heading, do not allow a break.
5580 % But do insert the glue.
5581 \medskip % preceded by discardable penalty, so not a breakpoint
5584 \parindent=0in
5585 \advance\leftskip by \defbodyindent
5586 \exdentamount=\defbodyindent
5589 \def\dodefunx#1{%
5590 % First, check whether we are in the right environment:
5591 \checkenv#1%
5593 % As above, allow line break if we have multiple x headers in a row.
5594 % It's not a great place, though.
5595 \ifnum\lastpenalty=10002 \penalty3000 \fi
5597 % And now, it's time to reuse the body of the original defun:
5598 \expandafter\gobbledefun#1%
5600 \def\gobbledefun#1\startdefun{}
5602 % \printdefunline \deffnheader{text}
5604 \def\printdefunline#1#2{%
5605 \begingroup
5606 % call \deffnheader:
5607 #1#2 \endheader
5608 % common ending:
5609 \interlinepenalty = 10000
5610 \advance\rightskip by 0pt plus 1fil
5611 \endgraf
5612 \nobreak\vskip -\parskip
5613 \penalty 10002 % signal to \startdefun and \dodefunx
5614 % Some of the @defun-type tags do not enable magic parentheses,
5615 % rendering the following check redundant. But we don't optimize.
5616 \checkparencounts
5617 \endgroup
5620 \def\Edefun{\endgraf\medbreak}
5622 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5623 % the only thing remainnig is to define \deffnheader.
5625 \def\makedefun#1{%
5626 \expandafter\let\csname E#1\endcsname = \Edefun
5627 \edef\temp{\noexpand\domakedefun
5628 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5629 \temp
5632 % \domakedefun \deffn \deffnx \deffnheader
5634 % Define \deffn and \deffnx, without parameters.
5635 % \deffnheader has to be defined explicitly.
5637 \def\domakedefun#1#2#3{%
5638 \envdef#1{%
5639 \startdefun
5640 \parseargusing\activeparens{\printdefunline#3}%
5642 \def#2{\dodefunx#1}%
5643 \def#3%
5646 %%% Untyped functions:
5648 % @deffn category name args
5649 \makedefun{deffn}{\deffngeneral{}}
5651 % @deffn category class name args
5652 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5654 % \defopon {category on}class name args
5655 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5657 % \deffngeneral {subind}category name args
5659 \def\deffngeneral#1#2 #3 #4\endheader{%
5660 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5661 \dosubind{fn}{\code{#3}}{#1}%
5662 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5665 %%% Typed functions:
5667 % @deftypefn category type name args
5668 \makedefun{deftypefn}{\deftypefngeneral{}}
5670 % @deftypeop category class type name args
5671 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5673 % \deftypeopon {category on}class type name args
5674 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5676 % \deftypefngeneral {subind}category type name args
5678 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5679 \dosubind{fn}{\code{#4}}{#1}%
5680 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5683 %%% Typed variables:
5685 % @deftypevr category type var args
5686 \makedefun{deftypevr}{\deftypecvgeneral{}}
5688 % @deftypecv category class type var args
5689 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5691 % \deftypecvof {category of}class type var args
5692 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5694 % \deftypecvgeneral {subind}category type var args
5696 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5697 \dosubind{vr}{\code{#4}}{#1}%
5698 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5701 %%% Untyped variables:
5703 % @defvr category var args
5704 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5706 % @defcv category class var args
5707 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5709 % \defcvof {category of}class var args
5710 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5712 %%% Type:
5713 % @deftp category name args
5714 \makedefun{deftp}#1 #2 #3\endheader{%
5715 \doind{tp}{\code{#2}}%
5716 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5719 % Remaining @defun-like shortcuts:
5720 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5721 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5722 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5723 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5724 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5725 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5726 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5727 \makedefun{defmethod}{\defopon\putwordMethodon}
5728 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5729 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5730 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5732 % \defname, which formats the name of the @def (not the args).
5733 % #1 is the category, such as "Function".
5734 % #2 is the return type, if any.
5735 % #3 is the function name.
5737 % We are followed by (but not passed) the arguments, if any.
5739 \def\defname#1#2#3{%
5740 % Get the values of \leftskip and \rightskip as they were outside the @def...
5741 \advance\leftskip by -\defbodyindent
5743 % How we'll format the type name. Putting it in brackets helps
5744 % distinguish it from the body text that may end up on the next line
5745 % just below it.
5746 \def\temp{#1}%
5747 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5749 % Figure out line sizes for the paragraph shape.
5750 % The first line needs space for \box0; but if \rightskip is nonzero,
5751 % we need only space for the part of \box0 which exceeds it:
5752 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5753 % The continuations:
5754 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5755 % (plain.tex says that \dimen1 should be used only as global.)
5756 \parshape 2 0in \dimen0 \defargsindent \dimen2
5758 % Put the type name to the right margin.
5759 \noindent
5760 \hbox to 0pt{%
5761 \hfil\box0 \kern-\hsize
5762 % \hsize has to be shortened this way:
5763 \kern\leftskip
5764 % Intentionally do not respect \rightskip, since we need the space.
5767 % Allow all lines to be underfull without complaint:
5768 \tolerance=10000 \hbadness=10000
5769 \exdentamount=\defbodyindent
5771 % defun fonts. We use typewriter by default (used to be bold) because:
5772 % . we're printing identifiers, they should be in tt in principle.
5773 % . in languages with many accents, such as Czech or French, it's
5774 % common to leave accents off identifiers. The result looks ok in
5775 % tt, but exceedingly strange in rm.
5776 % . we don't want -- and --- to be treated as ligatures.
5777 % . this still does not fix the ?` and !` ligatures, but so far no
5778 % one has made identifiers using them :).
5779 \df \tt
5780 \def\temp{#2}% return value type
5781 \ifx\temp\empty\else \tclose{\temp} \fi
5782 #3% output function name
5784 {\rm\enskip}% hskip 0.5 em of \tenrm
5786 \boldbrax
5787 % arguments will be output next, if any.
5790 % Print arguments in slanted roman (not ttsl), inconsistently with using
5791 % tt for the name. This is because literal text is sometimes needed in
5792 % the argument list (groff manual), and ttsl and tt are not very
5793 % distinguishable. Prevent hyphenation at `-' chars.
5795 \def\defunargs#1{%
5796 % use sl by default (not ttsl),
5797 % tt for the names.
5798 \df \sl \hyphenchar\font=0
5800 % On the other hand, if an argument has two dashes (for instance), we
5801 % want a way to get ttsl. Let's try @var for that.
5802 \let\var=\ttslanted
5804 \sl\hyphenchar\font=45
5807 % We want ()&[] to print specially on the defun line.
5809 \def\activeparens{%
5810 \catcode`\(=\active \catcode`\)=\active
5811 \catcode`\[=\active \catcode`\]=\active
5812 \catcode`\&=\active
5815 % Make control sequences which act like normal parenthesis chars.
5816 \let\lparen = ( \let\rparen = )
5818 % Be sure that we always have a definition for `(', etc. For example,
5819 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5820 % so TeX would otherwise complain about undefined control sequence.
5822 \activeparens
5823 \global\let(=\lparen \global\let)=\rparen
5824 \global\let[=\lbrack \global\let]=\rbrack
5825 \global\let& = \&
5827 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5828 \gdef\magicamp{\let&=\amprm}
5831 \newcount\parencount
5833 % If we encounter &foo, then turn on ()-hacking afterwards
5834 \newif\ifampseen
5835 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5837 \def\parenfont{%
5838 \ifampseen
5839 % At the first level, print parens in roman,
5840 % otherwise use the default font.
5841 \ifnum \parencount=1 \rm \fi
5842 \else
5843 % The \sf parens (in \boldbrax) actually are a little bolder than
5844 % the contained text. This is especially needed for [ and ] .
5848 \def\infirstlevel#1{%
5849 \ifampseen
5850 \ifnum\parencount=1
5855 \def\bfafterword#1 {#1 \bf}
5857 \def\opnr{%
5858 \global\advance\parencount by 1
5859 {\parenfont(}%
5860 \infirstlevel \bfafterword
5862 \def\clnr{%
5863 {\parenfont)}%
5864 \infirstlevel \sl
5865 \global\advance\parencount by -1
5868 \newcount\brackcount
5869 \def\lbrb{%
5870 \global\advance\brackcount by 1
5871 {\bf[}%
5873 \def\rbrb{%
5874 {\bf]}%
5875 \global\advance\brackcount by -1
5878 \def\checkparencounts{%
5879 \ifnum\parencount=0 \else \badparencount \fi
5880 \ifnum\brackcount=0 \else \badbrackcount \fi
5882 \def\badparencount{%
5883 \errmessage{Unbalanced parentheses in @def}%
5884 \global\parencount=0
5886 \def\badbrackcount{%
5887 \errmessage{Unbalanced square braces in @def}%
5888 \global\brackcount=0
5892 \message{macros,}
5893 % @macro.
5895 % To do this right we need a feature of e-TeX, \scantokens,
5896 % which we arrange to emulate with a temporary file in ordinary TeX.
5897 \ifx\eTeXversion\undefined
5898 \newwrite\macscribble
5899 \def\scantokens#1{%
5900 \toks0={#1}%
5901 \immediate\openout\macscribble=\jobname.tmp
5902 \immediate\write\macscribble{\the\toks0}%
5903 \immediate\closeout\macscribble
5904 \input \jobname.tmp
5908 \def\scanmacro#1{%
5909 \begingroup
5910 \newlinechar`\^^M
5911 \let\xeatspaces\eatspaces
5912 % Undo catcode changes of \startcontents and \doprintindex
5913 % When called from @insertcopying or (short)caption, we need active
5914 % backslash to get it printed correctly. Previously, we had
5915 % \catcode`\\=\other instead. We'll see whether a problem appears
5916 % with macro expansion. --kasal, 19aug04
5917 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5918 % ... and \example
5919 \spaceisspace
5921 % Append \endinput to make sure that TeX does not see the ending newline.
5922 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5923 % --kasal, 29nov03
5924 \scantokens{#1\endinput}%
5925 \endgroup
5928 \def\scanexp#1{%
5929 \edef\temp{\noexpand\scanmacro{#1}}%
5930 \temp
5933 \newcount\paramno % Count of parameters
5934 \newtoks\macname % Macro name
5935 \newif\ifrecursive % Is it recursive?
5937 % List of all defined macros in the form
5938 % \definedummyword\macro1\definedummyword\macro2...
5939 % Currently is also contains all @aliases; the list can be split
5940 % if there is a need.
5941 \def\macrolist{}
5943 % Add the macro to \macrolist
5944 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5945 \def\addtomacrolistxxx#1{%
5946 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5947 \xdef\macrolist{\the\toks0}%
5950 % Utility routines.
5951 % This does \let #1 = #2, with \csnames; that is,
5952 % \let \csname#1\endcsname = \csname#2\endcsname
5953 % (except of course we have to play expansion games).
5955 \def\cslet#1#2{%
5956 \expandafter\let
5957 \csname#1\expandafter\endcsname
5958 \csname#2\endcsname
5961 % Trim leading and trailing spaces off a string.
5962 % Concepts from aro-bend problem 15 (see CTAN).
5963 {\catcode`\@=11
5964 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5965 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5966 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5967 \def\unbrace#1{#1}
5968 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5971 % Trim a single trailing ^^M off a string.
5972 {\catcode`\^^M=\other \catcode`\Q=3%
5973 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5974 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5975 \gdef\eatcrb#1Q#2Q{#1}%
5978 % Macro bodies are absorbed as an argument in a context where
5979 % all characters are catcode 10, 11 or 12, except \ which is active
5980 % (as in normal texinfo). It is necessary to change the definition of \.
5982 % It's necessary to have hard CRs when the macro is executed. This is
5983 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5984 % body, and then making it the \newlinechar in \scanmacro.
5986 \def\scanctxt{%
5987 \catcode`\"=\other
5988 \catcode`\+=\other
5989 \catcode`\<=\other
5990 \catcode`\>=\other
5991 \catcode`\@=\other
5992 \catcode`\^=\other
5993 \catcode`\_=\other
5994 \catcode`\|=\other
5995 \catcode`\~=\other
5998 \def\scanargctxt{%
5999 \scanctxt
6000 \catcode`\\=\other
6001 \catcode`\^^M=\other
6004 \def\macrobodyctxt{%
6005 \scanctxt
6006 \catcode`\{=\other
6007 \catcode`\}=\other
6008 \catcode`\^^M=\other
6009 \usembodybackslash
6012 \def\macroargctxt{%
6013 \scanctxt
6014 \catcode`\\=\other
6017 % \mbodybackslash is the definition of \ in @macro bodies.
6018 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6019 % where N is the macro parameter number.
6020 % We define \csname macarg.\endcsname to be \realbackslash, so
6021 % \\ in macro replacement text gets you a backslash.
6023 {\catcode`@=0 @catcode`@\=@active
6024 @gdef@usembodybackslash{@let\=@mbodybackslash}
6025 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6027 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6029 \def\macro{\recursivefalse\parsearg\macroxxx}
6030 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6032 \def\macroxxx#1{%
6033 \getargs{#1}% now \macname is the macname and \argl the arglist
6034 \ifx\argl\empty % no arguments
6035 \paramno=0%
6036 \else
6037 \expandafter\parsemargdef \argl;%
6039 \if1\csname ismacro.\the\macname\endcsname
6040 \message{Warning: redefining \the\macname}%
6041 \else
6042 \expandafter\ifx\csname \the\macname\endcsname \relax
6043 \else \errmessage{Macro name \the\macname\space already defined}\fi
6044 \global\cslet{macsave.\the\macname}{\the\macname}%
6045 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6046 \addtomacrolist{\the\macname}%
6048 \begingroup \macrobodyctxt
6049 \ifrecursive \expandafter\parsermacbody
6050 \else \expandafter\parsemacbody
6051 \fi}
6053 \parseargdef\unmacro{%
6054 \if1\csname ismacro.#1\endcsname
6055 \global\cslet{#1}{macsave.#1}%
6056 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6057 % Remove the macro name from \macrolist:
6058 \begingroup
6059 \expandafter\let\csname#1\endcsname \relax
6060 \let\definedummyword\unmacrodo
6061 \xdef\macrolist{\macrolist}%
6062 \endgroup
6063 \else
6064 \errmessage{Macro #1 not defined}%
6068 % Called by \do from \dounmacro on each macro. The idea is to omit any
6069 % macro definitions that have been changed to \relax.
6071 \def\unmacrodo#1{%
6072 \ifx #1\relax
6073 % remove this
6074 \else
6075 \noexpand\definedummyword \noexpand#1%
6079 % This makes use of the obscure feature that if the last token of a
6080 % <parameter list> is #, then the preceding argument is delimited by
6081 % an opening brace, and that opening brace is not consumed.
6082 \def\getargs#1{\getargsxxx#1{}}
6083 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6084 \def\getmacname #1 #2\relax{\macname={#1}}
6085 \def\getmacargs#1{\def\argl{#1}}
6087 % Parse the optional {params} list. Set up \paramno and \paramlist
6088 % so \defmacro knows what to do. Define \macarg.blah for each blah
6089 % in the params list, to be ##N where N is the position in that list.
6090 % That gets used by \mbodybackslash (above).
6092 % We need to get `macro parameter char #' into several definitions.
6093 % The technique used is stolen from LaTeX: let \hash be something
6094 % unexpandable, insert that wherever you need a #, and then redefine
6095 % it to # just before using the token list produced.
6097 % The same technique is used to protect \eatspaces till just before
6098 % the macro is used.
6100 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6101 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6102 \def\parsemargdefxxx#1,{%
6103 \if#1;\let\next=\relax
6104 \else \let\next=\parsemargdefxxx
6105 \advance\paramno by 1%
6106 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6107 {\xeatspaces{\hash\the\paramno}}%
6108 \edef\paramlist{\paramlist\hash\the\paramno,}%
6109 \fi\next}
6111 % These two commands read recursive and nonrecursive macro bodies.
6112 % (They're different since rec and nonrec macros end differently.)
6114 \long\def\parsemacbody#1@end macro%
6115 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6116 \long\def\parsermacbody#1@end rmacro%
6117 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6119 % This defines the macro itself. There are six cases: recursive and
6120 % nonrecursive macros of zero, one, and many arguments.
6121 % Much magic with \expandafter here.
6122 % \xdef is used so that macro definitions will survive the file
6123 % they're defined in; @include reads the file inside a group.
6124 \def\defmacro{%
6125 \let\hash=##% convert placeholders to macro parameter chars
6126 \ifrecursive
6127 \ifcase\paramno
6129 \expandafter\xdef\csname\the\macname\endcsname{%
6130 \noexpand\scanmacro{\temp}}%
6131 \or % 1
6132 \expandafter\xdef\csname\the\macname\endcsname{%
6133 \bgroup\noexpand\macroargctxt
6134 \noexpand\braceorline
6135 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6136 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6137 \egroup\noexpand\scanmacro{\temp}}%
6138 \else % many
6139 \expandafter\xdef\csname\the\macname\endcsname{%
6140 \bgroup\noexpand\macroargctxt
6141 \noexpand\csname\the\macname xx\endcsname}%
6142 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6143 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6144 \expandafter\expandafter
6145 \expandafter\xdef
6146 \expandafter\expandafter
6147 \csname\the\macname xxx\endcsname
6148 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6150 \else
6151 \ifcase\paramno
6153 \expandafter\xdef\csname\the\macname\endcsname{%
6154 \noexpand\norecurse{\the\macname}%
6155 \noexpand\scanmacro{\temp}\egroup}%
6156 \or % 1
6157 \expandafter\xdef\csname\the\macname\endcsname{%
6158 \bgroup\noexpand\macroargctxt
6159 \noexpand\braceorline
6160 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6161 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6162 \egroup
6163 \noexpand\norecurse{\the\macname}%
6164 \noexpand\scanmacro{\temp}\egroup}%
6165 \else % many
6166 \expandafter\xdef\csname\the\macname\endcsname{%
6167 \bgroup\noexpand\macroargctxt
6168 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6169 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6170 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6171 \expandafter\expandafter
6172 \expandafter\xdef
6173 \expandafter\expandafter
6174 \csname\the\macname xxx\endcsname
6175 \paramlist{%
6176 \egroup
6177 \noexpand\norecurse{\the\macname}%
6178 \noexpand\scanmacro{\temp}\egroup}%
6180 \fi}
6182 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6184 % \braceorline decides whether the next nonwhitespace character is a
6185 % {. If so it reads up to the closing }, if not, it reads the whole
6186 % line. Whatever was read is then fed to the next control sequence
6187 % as an argument (by \parsebrace or \parsearg)
6188 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6189 \def\braceorlinexxx{%
6190 \ifx\nchar\bgroup\else
6191 \expandafter\parsearg
6192 \fi \macnamexxx}
6195 % @alias.
6196 % We need some trickery to remove the optional spaces around the equal
6197 % sign. Just make them active and then expand them all to nothing.
6198 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6199 \def\aliasxxx #1{\aliasyyy#1\relax}
6200 \def\aliasyyy #1=#2\relax{%
6202 \expandafter\let\obeyedspace=\empty
6203 \addtomacrolist{#1}%
6204 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6206 \next
6210 \message{cross references,}
6212 \newwrite\auxfile
6214 \newif\ifhavexrefs % True if xref values are known.
6215 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6217 % @inforef is relatively simple.
6218 \def\inforef #1{\inforefzzz #1,,,,**}
6219 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6220 node \samp{\ignorespaces#1{}}}
6222 % @node's only job in TeX is to define \lastnode, which is used in
6223 % cross-references. The @node line might or might not have commas, and
6224 % might or might not have spaces before the first comma, like:
6225 % @node foo , bar , ...
6226 % We don't want such trailing spaces in the node name.
6228 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6230 % also remove a trailing comma, in case of something like this:
6231 % @node Help-Cross, , , Cross-refs
6232 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6233 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6235 \let\nwnode=\node
6236 \let\lastnode=\empty
6238 % Write a cross-reference definition for the current node. #1 is the
6239 % type (Ynumbered, Yappendix, Ynothing).
6241 \def\donoderef#1{%
6242 \ifx\lastnode\empty\else
6243 \setref{\lastnode}{#1}%
6244 \global\let\lastnode=\empty
6248 % @anchor{NAME} -- define xref target at arbitrary point.
6250 \newcount\savesfregister
6252 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6253 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6254 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6256 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6257 % anchor), which consists of three parts:
6258 % 1) NAME-title - the current sectioning name taken from \thissection,
6259 % or the anchor name.
6260 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6261 % empty for anchors.
6262 % 3) NAME-pg - the page number.
6264 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6265 % floats, there is an additional part, which is not written here:
6266 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6268 \def\setref#1#2{%
6269 \pdfmkdest{#1}%
6270 \iflinks
6272 \atdummies % preserve commands, but don't expand them
6273 \edef\writexrdef##1##2{%
6274 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6275 ##1}{##2}}% these are parameters of \writexrdef
6277 \toks0 = \expandafter{\thissection}%
6278 \immediate \writexrdef{title}{\the\toks0 }%
6279 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6280 \writexrdef{pg}{\folio}% will be written later, during \shipout
6285 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6286 % the node name, #2 the name of the Info cross-reference, #3 the printed
6287 % node name, #4 the name of the Info file, #5 the name of the printed
6288 % manual. All but the node name can be omitted.
6290 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6291 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6292 \def\ref#1{\xrefX[#1,,,,,,,]}
6293 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6294 \unsepspaces
6295 \def\printedmanual{\ignorespaces #5}%
6296 \def\printedrefname{\ignorespaces #3}%
6297 \setbox1=\hbox{\printedmanual\unskip}%
6298 \setbox0=\hbox{\printedrefname\unskip}%
6299 \ifdim \wd0 = 0pt
6300 % No printed node name was explicitly given.
6301 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6302 % Use the node name inside the square brackets.
6303 \def\printedrefname{\ignorespaces #1}%
6304 \else
6305 % Use the actual chapter/section title appear inside
6306 % the square brackets. Use the real section title if we have it.
6307 \ifdim \wd1 > 0pt
6308 % It is in another manual, so we don't have it.
6309 \def\printedrefname{\ignorespaces #1}%
6310 \else
6311 \ifhavexrefs
6312 % We know the real title if we have the xref values.
6313 \def\printedrefname{\refx{#1-title}{}}%
6314 \else
6315 % Otherwise just copy the Info node name.
6316 \def\printedrefname{\ignorespaces #1}%
6317 \fi%
6322 % Make link in pdf output.
6323 \ifpdf
6324 \leavevmode
6325 \getfilename{#4}%
6326 {\turnoffactive
6327 % See comments at \activebackslashdouble.
6328 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6329 \backslashparens\pdfxrefdest}%
6331 \ifnum\filenamelength>0
6332 \startlink attr{/Border [0 0 0]}%
6333 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6334 \else
6335 \startlink attr{/Border [0 0 0]}%
6336 goto name{\pdfmkpgn{\pdfxrefdest}}%
6339 \linkcolor
6342 % Float references are printed completely differently: "Figure 1.2"
6343 % instead of "[somenode], p.3". We distinguish them by the
6344 % LABEL-title being set to a magic string.
6346 % Have to otherify everything special to allow the \csname to
6347 % include an _ in the xref name, etc.
6348 \indexnofonts
6349 \turnoffactive
6350 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6351 \csname XR#1-title\endcsname
6353 \iffloat\Xthisreftitle
6354 % If the user specified the print name (third arg) to the ref,
6355 % print it instead of our usual "Figure 1.2".
6356 \ifdim\wd0 = 0pt
6357 \refx{#1-snt}{}%
6358 \else
6359 \printedrefname
6362 % if the user also gave the printed manual name (fifth arg), append
6363 % "in MANUALNAME".
6364 \ifdim \wd1 > 0pt
6365 \space \putwordin{} \cite{\printedmanual}%
6367 \else
6368 % node/anchor (non-float) references.
6370 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6371 % insert empty discretionaries after hyphens, which means that it will
6372 % not find a line break at a hyphen in a node names. Since some manuals
6373 % are best written with fairly long node names, containing hyphens, this
6374 % is a loss. Therefore, we give the text of the node name again, so it
6375 % is as if TeX is seeing it for the first time.
6376 \ifdim \wd1 > 0pt
6377 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6378 \else
6379 % _ (for example) has to be the character _ for the purposes of the
6380 % control sequence corresponding to the node, but it has to expand
6381 % into the usual \leavevmode...\vrule stuff for purposes of
6382 % printing. So we \turnoffactive for the \refx-snt, back on for the
6383 % printing, back off for the \refx-pg.
6384 {\turnoffactive
6385 % Only output a following space if the -snt ref is nonempty; for
6386 % @unnumbered and @anchor, it won't be.
6387 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6388 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6390 % output the `[mynode]' via a macro so it can be overridden.
6391 \xrefprintnodename\printedrefname
6393 % But we always want a comma and a space:
6394 ,\space
6396 % output the `page 3'.
6397 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6400 \endlink
6401 \endgroup}
6403 % This macro is called from \xrefX for the `[nodename]' part of xref
6404 % output. It's a separate macro only so it can be changed more easily,
6405 % since square brackets don't work well in some documents. Particularly
6406 % one that Bob is working on :).
6408 \def\xrefprintnodename#1{[#1]}
6410 % Things referred to by \setref.
6412 \def\Ynothing{}
6413 \def\Yomitfromtoc{}
6414 \def\Ynumbered{%
6415 \ifnum\secno=0
6416 \putwordChapter@tie \the\chapno
6417 \else \ifnum\subsecno=0
6418 \putwordSection@tie \the\chapno.\the\secno
6419 \else \ifnum\subsubsecno=0
6420 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6421 \else
6422 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6423 \fi\fi\fi
6425 \def\Yappendix{%
6426 \ifnum\secno=0
6427 \putwordAppendix@tie @char\the\appendixno{}%
6428 \else \ifnum\subsecno=0
6429 \putwordSection@tie @char\the\appendixno.\the\secno
6430 \else \ifnum\subsubsecno=0
6431 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6432 \else
6433 \putwordSection@tie
6434 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6435 \fi\fi\fi
6438 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6439 % If its value is nonempty, SUFFIX is output afterward.
6441 \def\refx#1#2{%
6443 \indexnofonts
6444 \otherbackslash
6445 \expandafter\global\expandafter\let\expandafter\thisrefX
6446 \csname XR#1\endcsname
6448 \ifx\thisrefX\relax
6449 % If not defined, say something at least.
6450 \angleleft un\-de\-fined\angleright
6451 \iflinks
6452 \ifhavexrefs
6453 \message{\linenumber Undefined cross reference `#1'.}%
6454 \else
6455 \ifwarnedxrefs\else
6456 \global\warnedxrefstrue
6457 \message{Cross reference values unknown; you must run TeX again.}%
6461 \else
6462 % It's defined, so just use it.
6463 \thisrefX
6465 #2% Output the suffix in any case.
6468 % This is the macro invoked by entries in the aux file. Usually it's
6469 % just a \def (we prepend XR to the control sequence name to avoid
6470 % collisions). But if this is a float type, we have more work to do.
6472 \def\xrdef#1#2{%
6473 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6475 % Was that xref control sequence that we just defined for a float?
6476 \expandafter\iffloat\csname XR#1\endcsname
6477 % it was a float, and we have the (safe) float type in \iffloattype.
6478 \expandafter\let\expandafter\floatlist
6479 \csname floatlist\iffloattype\endcsname
6481 % Is this the first time we've seen this float type?
6482 \expandafter\ifx\floatlist\relax
6483 \toks0 = {\do}% yes, so just \do
6484 \else
6485 % had it before, so preserve previous elements in list.
6486 \toks0 = \expandafter{\floatlist\do}%
6489 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6490 % for later use in \listoffloats.
6491 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6495 % Read the last existing aux file, if any. No error if none exists.
6497 \def\tryauxfile{%
6498 \openin 1 \jobname.aux
6499 \ifeof 1 \else
6500 \readdatafile{aux}%
6501 \global\havexrefstrue
6503 \closein 1
6506 \def\setupdatafile{%
6507 \catcode`\^^@=\other
6508 \catcode`\^^A=\other
6509 \catcode`\^^B=\other
6510 \catcode`\^^C=\other
6511 \catcode`\^^D=\other
6512 \catcode`\^^E=\other
6513 \catcode`\^^F=\other
6514 \catcode`\^^G=\other
6515 \catcode`\^^H=\other
6516 \catcode`\^^K=\other
6517 \catcode`\^^L=\other
6518 \catcode`\^^N=\other
6519 \catcode`\^^P=\other
6520 \catcode`\^^Q=\other
6521 \catcode`\^^R=\other
6522 \catcode`\^^S=\other
6523 \catcode`\^^T=\other
6524 \catcode`\^^U=\other
6525 \catcode`\^^V=\other
6526 \catcode`\^^W=\other
6527 \catcode`\^^X=\other
6528 \catcode`\^^Z=\other
6529 \catcode`\^^[=\other
6530 \catcode`\^^\=\other
6531 \catcode`\^^]=\other
6532 \catcode`\^^^=\other
6533 \catcode`\^^_=\other
6534 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6535 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6536 % supported in the main text, it doesn't seem desirable. Furthermore,
6537 % that is not enough: for node names that actually contain a ^
6538 % character, we would end up writing a line like this: 'xrdef {'hat
6539 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6540 % argument, and \hat is not an expandable control sequence. It could
6541 % all be worked out, but why? Either we support ^^ or we don't.
6543 % The other change necessary for this was to define \auxhat:
6544 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6545 % and then to call \auxhat in \setq.
6547 \catcode`\^=\other
6549 % Special characters. Should be turned off anyway, but...
6550 \catcode`\~=\other
6551 \catcode`\[=\other
6552 \catcode`\]=\other
6553 \catcode`\"=\other
6554 \catcode`\_=\other
6555 \catcode`\|=\other
6556 \catcode`\<=\other
6557 \catcode`\>=\other
6558 \catcode`\$=\other
6559 \catcode`\#=\other
6560 \catcode`\&=\other
6561 \catcode`\%=\other
6562 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6564 % This is to support \ in node names and titles, since the \
6565 % characters end up in a \csname. It's easier than
6566 % leaving it active and making its active definition an actual \
6567 % character. What I don't understand is why it works in the *value*
6568 % of the xrdef. Seems like it should be a catcode12 \, and that
6569 % should not typeset properly. But it works, so I'm moving on for
6570 % now. --karl, 15jan04.
6571 \catcode`\\=\other
6573 % Make the characters 128-255 be printing characters.
6575 \count1=128
6576 \def\loop{%
6577 \catcode\count1=\other
6578 \advance\count1 by 1
6579 \ifnum \count1<256 \loop \fi
6583 % @ is our escape character in .aux files, and we need braces.
6584 \catcode`\{=1
6585 \catcode`\}=2
6586 \catcode`\@=0
6589 \def\readdatafile#1{%
6590 \begingroup
6591 \setupdatafile
6592 \input\jobname.#1
6593 \endgroup}
6595 \message{insertions,}
6596 % including footnotes.
6598 \newcount \footnoteno
6600 % The trailing space in the following definition for supereject is
6601 % vital for proper filling; pages come out unaligned when you do a
6602 % pagealignmacro call if that space before the closing brace is
6603 % removed. (Generally, numeric constants should always be followed by a
6604 % space to prevent strange expansion errors.)
6605 \def\supereject{\par\penalty -20000\footnoteno =0 }
6607 % @footnotestyle is meaningful for info output only.
6608 \let\footnotestyle=\comment
6610 {\catcode `\@=11
6612 % Auto-number footnotes. Otherwise like plain.
6613 \gdef\footnote{%
6614 \let\indent=\ptexindent
6615 \let\noindent=\ptexnoindent
6616 \global\advance\footnoteno by \@ne
6617 \edef\thisfootno{$^{\the\footnoteno}$}%
6619 % In case the footnote comes at the end of a sentence, preserve the
6620 % extra spacing after we do the footnote number.
6621 \let\@sf\empty
6622 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6624 % Remove inadvertent blank space before typesetting the footnote number.
6625 \unskip
6626 \thisfootno\@sf
6627 \dofootnote
6630 % Don't bother with the trickery in plain.tex to not require the
6631 % footnote text as a parameter. Our footnotes don't need to be so general.
6633 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6634 % \parseargline) fails inside footnotes because the tokens are fixed when
6635 % the footnote is read. --karl, 16nov96.
6637 \gdef\dofootnote{%
6638 \insert\footins\bgroup
6639 % We want to typeset this text as a normal paragraph, even if the
6640 % footnote reference occurs in (for example) a display environment.
6641 % So reset some parameters.
6642 \hsize=\pagewidth
6643 \interlinepenalty\interfootnotelinepenalty
6644 \splittopskip\ht\strutbox % top baseline for broken footnotes
6645 \splitmaxdepth\dp\strutbox
6646 \floatingpenalty\@MM
6647 \leftskip\z@skip
6648 \rightskip\z@skip
6649 \spaceskip\z@skip
6650 \xspaceskip\z@skip
6651 \parindent\defaultparindent
6653 \smallfonts \rm
6655 % Because we use hanging indentation in footnotes, a @noindent appears
6656 % to exdent this text, so make it be a no-op. makeinfo does not use
6657 % hanging indentation so @noindent can still be needed within footnote
6658 % text after an @example or the like (not that this is good style).
6659 \let\noindent = \relax
6661 % Hang the footnote text off the number. Use \everypar in case the
6662 % footnote extends for more than one paragraph.
6663 \everypar = {\hang}%
6664 \textindent{\thisfootno}%
6666 % Don't crash into the line above the footnote text. Since this
6667 % expands into a box, it must come within the paragraph, lest it
6668 % provide a place where TeX can split the footnote.
6669 \footstrut
6670 \futurelet\next\fo@t
6672 }%end \catcode `\@=11
6674 % In case a @footnote appears in a vbox, save the footnote text and create
6675 % the real \insert just after the vbox finished. Otherwise, the insertion
6676 % would be lost.
6677 % Similarily, if a @footnote appears inside an alignment, save the footnote
6678 % text to a box and make the \insert when a row of the table is finished.
6679 % And the same can be done for other insert classes. --kasal, 16nov03.
6681 % Replace the \insert primitive by a cheating macro.
6682 % Deeper inside, just make sure that the saved insertions are not spilled
6683 % out prematurely.
6685 \def\startsavinginserts{%
6686 \ifx \insert\ptexinsert
6687 \let\insert\saveinsert
6688 \else
6689 \let\checkinserts\relax
6693 % This \insert replacement works for both \insert\footins{foo} and
6694 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6696 \def\saveinsert#1{%
6697 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6698 \afterassignment\next
6699 % swallow the left brace
6700 \let\temp =
6702 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6703 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6705 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6707 \def\placesaveins#1{%
6708 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6709 {\box#1}%
6712 % eat @SAVE -- beware, all of them have catcode \other:
6714 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6715 \gdef\gobblesave @SAVE{}
6718 % initialization:
6719 \def\newsaveins #1{%
6720 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6721 \next
6723 \def\newsaveinsX #1{%
6724 \csname newbox\endcsname #1%
6725 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6726 \checksaveins #1}%
6729 % initialize:
6730 \let\checkinserts\empty
6731 \newsaveins\footins
6732 \newsaveins\margin
6735 % @image. We use the macros from epsf.tex to support this.
6736 % If epsf.tex is not installed and @image is used, we complain.
6738 % Check for and read epsf.tex up front. If we read it only at @image
6739 % time, we might be inside a group, and then its definitions would get
6740 % undone and the next image would fail.
6741 \openin 1 = epsf.tex
6742 \ifeof 1 \else
6743 % Do not bother showing banner with epsf.tex v2.7k (available in
6744 % doc/epsf.tex and on ctan).
6745 \def\epsfannounce{\toks0 = }%
6746 \input epsf.tex
6748 \closein 1
6750 % We will only complain once about lack of epsf.tex.
6751 \newif\ifwarnednoepsf
6752 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6753 work. It is also included in the Texinfo distribution, or you can get
6754 it from ftp://tug.org/tex/epsf.tex.}
6756 \def\image#1{%
6757 \ifx\epsfbox\undefined
6758 \ifwarnednoepsf \else
6759 \errhelp = \noepsfhelp
6760 \errmessage{epsf.tex not found, images will be ignored}%
6761 \global\warnednoepsftrue
6763 \else
6764 \imagexxx #1,,,,,\finish
6768 % Arguments to @image:
6769 % #1 is (mandatory) image filename; we tack on .eps extension.
6770 % #2 is (optional) width, #3 is (optional) height.
6771 % #4 is (ignored optional) html alt text.
6772 % #5 is (ignored optional) extension.
6773 % #6 is just the usual extra ignored arg for parsing this stuff.
6774 \newif\ifimagevmode
6775 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6776 \catcode`\^^M = 5 % in case we're inside an example
6777 \normalturnoffactive % allow _ et al. in names
6778 % If the image is by itself, center it.
6779 \ifvmode
6780 \imagevmodetrue
6781 \nobreak\bigskip
6782 % Usually we'll have text after the image which will insert
6783 % \parskip glue, so insert it here too to equalize the space
6784 % above and below.
6785 \nobreak\vskip\parskip
6786 \nobreak
6787 \line\bgroup
6790 % Output the image.
6791 \ifpdf
6792 \dopdfimage{#1}{#2}{#3}%
6793 \else
6794 % \epsfbox itself resets \epsf?size at each figure.
6795 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6796 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6797 \epsfbox{#1.eps}%
6800 \ifimagevmode \egroup \bigbreak \fi % space after the image
6801 \endgroup}
6804 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6805 % etc. We don't actually implement floating yet, we always include the
6806 % float "here". But it seemed the best name for the future.
6808 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6810 % There may be a space before second and/or third parameter; delete it.
6811 \def\eatcommaspace#1, {#1,}
6813 % #1 is the optional FLOATTYPE, the text label for this float, typically
6814 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6815 % this float will not be numbered and cannot be referred to.
6817 % #2 is the optional xref label. Also must be present for the float to
6818 % be referable.
6820 % #3 is the optional positioning argument; for now, it is ignored. It
6821 % will somehow specify the positions allowed to float to (here, top, bottom).
6823 % We keep a separate counter for each FLOATTYPE, which we reset at each
6824 % chapter-level command.
6825 \let\resetallfloatnos=\empty
6827 \def\dofloat#1,#2,#3,#4\finish{%
6828 \let\thiscaption=\empty
6829 \let\thisshortcaption=\empty
6831 % don't lose footnotes inside @float.
6833 % BEWARE: when the floats start float, we have to issue warning whenever an
6834 % insert appears inside a float which could possibly float. --kasal, 26may04
6836 \startsavinginserts
6838 % We can't be used inside a paragraph.
6839 \par
6841 \vtop\bgroup
6842 \def\floattype{#1}%
6843 \def\floatlabel{#2}%
6844 \def\floatloc{#3}% we do nothing with this yet.
6846 \ifx\floattype\empty
6847 \let\safefloattype=\empty
6848 \else
6850 % the floattype might have accents or other special characters,
6851 % but we need to use it in a control sequence name.
6852 \indexnofonts
6853 \turnoffactive
6854 \xdef\safefloattype{\floattype}%
6858 % If label is given but no type, we handle that as the empty type.
6859 \ifx\floatlabel\empty \else
6860 % We want each FLOATTYPE to be numbered separately (Figure 1,
6861 % Table 1, Figure 2, ...). (And if no label, no number.)
6863 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6864 \global\advance\floatno by 1
6867 % This magic value for \thissection is output by \setref as the
6868 % XREFLABEL-title value. \xrefX uses it to distinguish float
6869 % labels (which have a completely different output format) from
6870 % node and anchor labels. And \xrdef uses it to construct the
6871 % lists of floats.
6873 \edef\thissection{\floatmagic=\safefloattype}%
6874 \setref{\floatlabel}{Yfloat}%
6878 % start with \parskip glue, I guess.
6879 \vskip\parskip
6881 % Don't suppress indentation if a float happens to start a section.
6882 \restorefirstparagraphindent
6885 % we have these possibilities:
6886 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6887 % @float Foo,lbl & no caption: Foo 1.1
6888 % @float Foo & @caption{Cap}: Foo: Cap
6889 % @float Foo & no caption: Foo
6890 % @float ,lbl & Caption{Cap}: 1.1: Cap
6891 % @float ,lbl & no caption: 1.1
6892 % @float & @caption{Cap}: Cap
6893 % @float & no caption:
6895 \def\Efloat{%
6896 \let\floatident = \empty
6898 % In all cases, if we have a float type, it comes first.
6899 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6901 % If we have an xref label, the number comes next.
6902 \ifx\floatlabel\empty \else
6903 \ifx\floattype\empty \else % if also had float type, need tie first.
6904 \appendtomacro\floatident{\tie}%
6906 % the number.
6907 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6910 % Start the printed caption with what we've constructed in
6911 % \floatident, but keep it separate; we need \floatident again.
6912 \let\captionline = \floatident
6914 \ifx\thiscaption\empty \else
6915 \ifx\floatident\empty \else
6916 \appendtomacro\captionline{: }% had ident, so need a colon between
6919 % caption text.
6920 \appendtomacro\captionline{\scanexp\thiscaption}%
6923 % If we have anything to print, print it, with space before.
6924 % Eventually this needs to become an \insert.
6925 \ifx\captionline\empty \else
6926 \vskip.5\parskip
6927 \captionline
6929 % Space below caption.
6930 \vskip\parskip
6933 % If have an xref label, write the list of floats info. Do this
6934 % after the caption, to avoid chance of it being a breakpoint.
6935 \ifx\floatlabel\empty \else
6936 % Write the text that goes in the lof to the aux file as
6937 % \floatlabel-lof. Besides \floatident, we include the short
6938 % caption if specified, else the full caption if specified, else nothing.
6940 \atdummies
6942 % since we read the caption text in the macro world, where ^^M
6943 % is turned into a normal character, we have to scan it back, so
6944 % we don't write the literal three characters "^^M" into the aux file.
6945 \scanexp{%
6946 \xdef\noexpand\gtemp{%
6947 \ifx\thisshortcaption\empty
6948 \thiscaption
6949 \else
6950 \thisshortcaption
6954 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6955 \ifx\gtemp\empty \else : \gtemp \fi}}%
6958 \egroup % end of \vtop
6960 % place the captured inserts
6962 % BEWARE: when the floats start floating, we have to issue warning
6963 % whenever an insert appears inside a float which could possibly
6964 % float. --kasal, 26may04
6966 \checkinserts
6969 % Append the tokens #2 to the definition of macro #1, not expanding either.
6971 \def\appendtomacro#1#2{%
6972 \expandafter\def\expandafter#1\expandafter{#1#2}%
6975 % @caption, @shortcaption
6977 \def\caption{\docaption\thiscaption}
6978 \def\shortcaption{\docaption\thisshortcaption}
6979 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6980 \def\defcaption#1#2{\egroup \def#1{#2}}
6982 % The parameter is the control sequence identifying the counter we are
6983 % going to use. Create it if it doesn't exist and assign it to \floatno.
6984 \def\getfloatno#1{%
6985 \ifx#1\relax
6986 % Haven't seen this figure type before.
6987 \csname newcount\endcsname #1%
6989 % Remember to reset this floatno at the next chap.
6990 \expandafter\gdef\expandafter\resetallfloatnos
6991 \expandafter{\resetallfloatnos #1=0 }%
6993 \let\floatno#1%
6996 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6997 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6998 % first read the @float command.
7000 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7002 % Magic string used for the XREFLABEL-title value, so \xrefX can
7003 % distinguish floats from other xref types.
7004 \def\floatmagic{!!float!!}
7006 % #1 is the control sequence we are passed; we expand into a conditional
7007 % which is true if #1 represents a float ref. That is, the magic
7008 % \thissection value which we \setref above.
7010 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7012 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7013 % (safe) float type for this float. We set \iffloattype to #2.
7015 \def\doiffloat#1=#2=#3\finish{%
7016 \def\temp{#1}%
7017 \def\iffloattype{#2}%
7018 \ifx\temp\floatmagic
7021 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7023 \parseargdef\listoffloats{%
7024 \def\floattype{#1}% floattype
7026 % the floattype might have accents or other special characters,
7027 % but we need to use it in a control sequence name.
7028 \indexnofonts
7029 \turnoffactive
7030 \xdef\safefloattype{\floattype}%
7033 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7034 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7035 \ifhavexrefs
7036 % if the user said @listoffloats foo but never @float foo.
7037 \message{\linenumber No `\safefloattype' floats to list.}%
7039 \else
7040 \begingroup
7041 \leftskip=\tocindent % indent these entries like a toc
7042 \let\do=\listoffloatsdo
7043 \csname floatlist\safefloattype\endcsname
7044 \endgroup
7048 % This is called on each entry in a list of floats. We're passed the
7049 % xref label, in the form LABEL-title, which is how we save it in the
7050 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7051 % has the text we're supposed to typeset here.
7053 % Figures without xref labels will not be included in the list (since
7054 % they won't appear in the aux file).
7056 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7057 \def\listoffloatsdoentry#1-title\finish{{%
7058 % Can't fully expand XR#1-lof because it can contain anything. Just
7059 % pass the control sequence. On the other hand, XR#1-pg is just the
7060 % page number, and we want to fully expand that so we can get a link
7061 % in pdf output.
7062 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7064 % use the same \entry macro we use to generate the TOC and index.
7065 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7066 \writeentry
7069 \message{localization,}
7070 % and i18n.
7072 % @documentlanguage is usually given very early, just after
7073 % @setfilename. If done too late, it may not override everything
7074 % properly. Single argument is the language abbreviation.
7075 % It would be nice if we could set up a hyphenation file here.
7077 \parseargdef\documentlanguage{%
7078 \tex % read txi-??.tex file in plain TeX.
7079 % Read the file if it exists.
7080 \openin 1 txi-#1.tex
7081 \ifeof 1
7082 \errhelp = \nolanghelp
7083 \errmessage{Cannot read language file txi-#1.tex}%
7084 \else
7085 \input txi-#1.tex
7087 \closein 1
7088 \endgroup
7090 \newhelp\nolanghelp{The given language definition file cannot be found or
7091 is empty. Maybe you need to install it? In the current directory
7092 should work if nowhere else does.}
7095 % @documentencoding should change something in TeX eventually, most
7096 % likely, but for now just recognize it.
7097 \let\documentencoding = \comment
7100 % Page size parameters.
7102 \newdimen\defaultparindent \defaultparindent = 15pt
7104 \chapheadingskip = 15pt plus 4pt minus 2pt
7105 \secheadingskip = 12pt plus 3pt minus 2pt
7106 \subsecheadingskip = 9pt plus 2pt minus 2pt
7108 % Prevent underfull vbox error messages.
7109 \vbadness = 10000
7111 % Don't be so finicky about underfull hboxes, either.
7112 \hbadness = 2000
7114 % Following George Bush, just get rid of widows and orphans.
7115 \widowpenalty=10000
7116 \clubpenalty=10000
7118 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7119 % using an old version of TeX, don't do anything. We want the amount of
7120 % stretch added to depend on the line length, hence the dependence on
7121 % \hsize. We call this whenever the paper size is set.
7123 \def\setemergencystretch{%
7124 \ifx\emergencystretch\thisisundefined
7125 % Allow us to assign to \emergencystretch anyway.
7126 \def\emergencystretch{\dimen0}%
7127 \else
7128 \emergencystretch = .15\hsize
7132 % Parameters in order: 1) textheight; 2) textwidth;
7133 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
7134 % 7) physical page height; 8) physical page width.
7136 % We also call \setleading{\textleading}, so the caller should define
7137 % \textleading. The caller should also set \parskip.
7139 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
7140 \voffset = #3\relax
7141 \topskip = #6\relax
7142 \splittopskip = \topskip
7144 \vsize = #1\relax
7145 \advance\vsize by \topskip
7146 \outervsize = \vsize
7147 \advance\outervsize by 2\topandbottommargin
7148 \pageheight = \vsize
7150 \hsize = #2\relax
7151 \outerhsize = \hsize
7152 \advance\outerhsize by 0.5in
7153 \pagewidth = \hsize
7155 \normaloffset = #4\relax
7156 \bindingoffset = #5\relax
7158 \ifpdf
7159 \pdfpageheight #7\relax
7160 \pdfpagewidth #8\relax
7163 \setleading{\textleading}
7165 \parindent = \defaultparindent
7166 \setemergencystretch
7169 % @letterpaper (the default).
7170 \def\letterpaper{{\globaldefs = 1
7171 \parskip = 3pt plus 2pt minus 1pt
7172 \textleading = 13.2pt
7174 % If page is nothing but text, make it come out even.
7175 \internalpagesizes{46\baselineskip}{6in}%
7176 {\voffset}{.25in}%
7177 {\bindingoffset}{36pt}%
7178 {11in}{8.5in}%
7181 % Use @smallbook to reset parameters for 7x9.25 trim size.
7182 \def\smallbook{{\globaldefs = 1
7183 \parskip = 2pt plus 1pt
7184 \textleading = 12pt
7186 \internalpagesizes{7.5in}{5in}%
7187 {\voffset}{.25in}%
7188 {\bindingoffset}{16pt}%
7189 {9.25in}{7in}%
7191 \lispnarrowing = 0.3in
7192 \tolerance = 700
7193 \hfuzz = 1pt
7194 \contentsrightmargin = 0pt
7195 \defbodyindent = .5cm
7198 % Use @smallerbook to reset parameters for 6x9 trim size.
7199 % (Just testing, parameters still in flux.)
7200 \def\smallerbook{{\globaldefs = 1
7201 \parskip = 1.5pt plus 1pt
7202 \textleading = 12pt
7204 \internalpagesizes{7.4in}{4.8in}%
7205 {-.2in}{-.4in}%
7206 {0pt}{14pt}%
7207 {9in}{6in}%
7209 \lispnarrowing = 0.25in
7210 \tolerance = 700
7211 \hfuzz = 1pt
7212 \contentsrightmargin = 0pt
7213 \defbodyindent = .4cm
7216 % Use @afourpaper to print on European A4 paper.
7217 \def\afourpaper{{\globaldefs = 1
7218 \parskip = 3pt plus 2pt minus 1pt
7219 \textleading = 13.2pt
7221 % Double-side printing via postscript on Laserjet 4050
7222 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7223 % To change the settings for a different printer or situation, adjust
7224 % \normaloffset until the front-side and back-side texts align. Then
7225 % do the same for \bindingoffset. You can set these for testing in
7226 % your texinfo source file like this:
7227 % @tex
7228 % \global\normaloffset = -6mm
7229 % \global\bindingoffset = 10mm
7230 % @end tex
7231 \internalpagesizes{51\baselineskip}{160mm}
7232 {\voffset}{\hoffset}%
7233 {\bindingoffset}{44pt}%
7234 {297mm}{210mm}%
7236 \tolerance = 700
7237 \hfuzz = 1pt
7238 \contentsrightmargin = 0pt
7239 \defbodyindent = 5mm
7242 % Use @afivepaper to print on European A5 paper.
7243 % From romildo@urano.iceb.ufop.br, 2 July 2000.
7244 % He also recommends making @example and @lisp be small.
7245 \def\afivepaper{{\globaldefs = 1
7246 \parskip = 2pt plus 1pt minus 0.1pt
7247 \textleading = 12.5pt
7249 \internalpagesizes{160mm}{120mm}%
7250 {\voffset}{\hoffset}%
7251 {\bindingoffset}{8pt}%
7252 {210mm}{148mm}%
7254 \lispnarrowing = 0.2in
7255 \tolerance = 800
7256 \hfuzz = 1.2pt
7257 \contentsrightmargin = 0pt
7258 \defbodyindent = 2mm
7259 \tableindent = 12mm
7262 % A specific text layout, 24x15cm overall, intended for A4 paper.
7263 \def\afourlatex{{\globaldefs = 1
7264 \afourpaper
7265 \internalpagesizes{237mm}{150mm}%
7266 {\voffset}{4.6mm}%
7267 {\bindingoffset}{7mm}%
7268 {297mm}{210mm}%
7270 % Must explicitly reset to 0 because we call \afourpaper.
7271 \globaldefs = 0
7274 % Use @afourwide to print on A4 paper in landscape format.
7275 \def\afourwide{{\globaldefs = 1
7276 \afourpaper
7277 \internalpagesizes{241mm}{165mm}%
7278 {\voffset}{-2.95mm}%
7279 {\bindingoffset}{7mm}%
7280 {297mm}{210mm}%
7281 \globaldefs = 0
7284 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7285 % Perhaps we should allow setting the margins, \topskip, \parskip,
7286 % and/or leading, also. Or perhaps we should compute them somehow.
7288 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7289 \def\pagesizesyyy#1,#2,#3\finish{{%
7290 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7291 \globaldefs = 1
7293 \parskip = 3pt plus 2pt minus 1pt
7294 \setleading{\textleading}%
7296 \dimen0 = #1
7297 \advance\dimen0 by \voffset
7299 \dimen2 = \hsize
7300 \advance\dimen2 by \normaloffset
7302 \internalpagesizes{#1}{\hsize}%
7303 {\voffset}{\normaloffset}%
7304 {\bindingoffset}{44pt}%
7305 {\dimen0}{\dimen2}%
7308 % Set default to letter.
7310 \letterpaper
7313 \message{and turning on texinfo input format.}
7315 % Define macros to output various characters with catcode for normal text.
7316 \catcode`\"=\other
7317 \catcode`\~=\other
7318 \catcode`\^=\other
7319 \catcode`\_=\other
7320 \catcode`\|=\other
7321 \catcode`\<=\other
7322 \catcode`\>=\other
7323 \catcode`\+=\other
7324 \catcode`\$=\other
7325 \def\normaldoublequote{"}
7326 \def\normaltilde{~}
7327 \def\normalcaret{^}
7328 \def\normalunderscore{_}
7329 \def\normalverticalbar{|}
7330 \def\normalless{<}
7331 \def\normalgreater{>}
7332 \def\normalplus{+}
7333 \def\normaldollar{$}%$ font-lock fix
7335 % This macro is used to make a character print one way in \tt
7336 % (where it can probably be output as-is), and another way in other fonts,
7337 % where something hairier probably needs to be done.
7339 % #1 is what to print if we are indeed using \tt; #2 is what to print
7340 % otherwise. Since all the Computer Modern typewriter fonts have zero
7341 % interword stretch (and shrink), and it is reasonable to expect all
7342 % typewriter fonts to have this, we can check that font parameter.
7344 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7346 % Same as above, but check for italic font. Actually this also catches
7347 % non-italic slanted fonts since it is impossible to distinguish them from
7348 % italic fonts. But since this is only used by $ and it uses \sl anyway
7349 % this is not a problem.
7350 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7352 % Turn off all special characters except @
7353 % (and those which the user can use as if they were ordinary).
7354 % Most of these we simply print from the \tt font, but for some, we can
7355 % use math or other variants that look better in normal text.
7357 \catcode`\"=\active
7358 \def\activedoublequote{{\tt\char34}}
7359 \let"=\activedoublequote
7360 \catcode`\~=\active
7361 \def~{{\tt\char126}}
7362 \chardef\hat=`\^
7363 \catcode`\^=\active
7364 \def^{{\tt \hat}}
7366 \catcode`\_=\active
7367 \def_{\ifusingtt\normalunderscore\_}
7368 \let\realunder=_
7369 % Subroutine for the previous macro.
7370 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7372 \catcode`\|=\active
7373 \def|{{\tt\char124}}
7374 \chardef \less=`\<
7375 \catcode`\<=\active
7376 \def<{{\tt \less}}
7377 \chardef \gtr=`\>
7378 \catcode`\>=\active
7379 \def>{{\tt \gtr}}
7380 \catcode`\+=\active
7381 \def+{{\tt \char 43}}
7382 \catcode`\$=\active
7383 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7385 % If a .fmt file is being used, characters that might appear in a file
7386 % name cannot be active until we have parsed the command line.
7387 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7388 % \otherifyactive is called near the end of this file.
7389 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7391 % Used sometimes to turn off (effectively) the active characters even after
7392 % parsing them.
7393 \def\turnoffactive{%
7394 \normalturnoffactive
7395 \otherbackslash
7398 \catcode`\@=0
7400 % \backslashcurfont outputs one backslash character in current font,
7401 % as in \char`\\.
7402 \global\chardef\backslashcurfont=`\\
7403 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7405 % \realbackslash is an actual character `\' with catcode other, and
7406 % \doublebackslash is two of them (for the pdf outlines).
7407 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7409 % In texinfo, backslash is an active character; it prints the backslash
7410 % in fixed width font.
7411 \catcode`\\=\active
7412 @def@normalbackslash{{@tt@backslashcurfont}}
7413 % On startup, @fixbackslash assigns:
7414 % @let \ = @normalbackslash
7416 % \rawbackslash defines an active \ to do \backslashcurfont.
7417 % \otherbackslash defines an active \ to be a literal `\' character with
7418 % catcode other.
7419 @gdef@rawbackslash{@let\=@backslashcurfont}
7420 @gdef@otherbackslash{@let\=@realbackslash}
7422 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7423 % the literal character `\'.
7425 @def@normalturnoffactive{%
7426 @let\=@normalbackslash
7427 @let"=@normaldoublequote
7428 @let~=@normaltilde
7429 @let^=@normalcaret
7430 @let_=@normalunderscore
7431 @let|=@normalverticalbar
7432 @let<=@normalless
7433 @let>=@normalgreater
7434 @let+=@normalplus
7435 @let$=@normaldollar %$ font-lock fix
7436 @unsepspaces
7439 % Make _ and + \other characters, temporarily.
7440 % This is canceled by @fixbackslash.
7441 @otherifyactive
7443 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7444 % That is what \eatinput is for; after that, the `\' should revert to printing
7445 % a backslash.
7447 @gdef@eatinput input texinfo{@fixbackslash}
7448 @global@let\ = @eatinput
7450 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7451 % the first `\' in the file would cause an error. This macro tries to fix
7452 % that, assuming it is called before the first `\' could plausibly occur.
7453 % Also turn back on active characters that might appear in the input
7454 % file name, in case not using a pre-dumped format.
7456 @gdef@fixbackslash{%
7457 @ifx\@eatinput @let\ = @normalbackslash @fi
7458 @catcode`+=@active
7459 @catcode`@_=@active
7462 % Say @foo, not \foo, in error messages.
7463 @escapechar = `@@
7465 % These look ok in all fonts, so just make them not special.
7466 @catcode`@& = @other
7467 @catcode`@# = @other
7468 @catcode`@% = @other
7471 @c Local variables:
7472 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7473 @c page-delimiter: "^\\\\message"
7474 @c time-stamp-start: "def\\\\texinfoversion{"
7475 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7476 @c time-stamp-end: "}"
7477 @c End:
7479 @c vim:sw=2:
7481 @ignore
7482 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
7483 @end ignore