(Pointer Shape): Node renamed from Pointer Shapes.
[emacs.git] / man / texinfo.tex
blobfcddd268999ab8a81de591dfbdc592b3353ed87f
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-05-07.15}
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 % Ignore a token.
162 \def\gobble#1{}
164 % The following is used inside several \edef's.
165 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
167 % Hyphenation fixes.
168 \hyphenation{
169 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
170 ap-pen-dix bit-map bit-maps
171 data-base data-bases eshell fall-ing half-way long-est man-u-script
172 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
173 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
174 spell-ing spell-ings
175 stand-alone strong-est time-stamp time-stamps which-ever white-space
176 wide-spread wrap-around
179 % Margin to add to right of even pages, to left of odd pages.
180 \newdimen\bindingoffset
181 \newdimen\normaloffset
182 \newdimen\pagewidth \newdimen\pageheight
184 % For a final copy, take out the rectangles
185 % that mark overfull boxes (in case you have decided
186 % that the text looks ok even though it passes the margin).
188 \def\finalout{\overfullrule=0pt}
190 % @| inserts a changebar to the left of the current line. It should
191 % surround any changed text. This approach does *not* work if the
192 % change spans more than two lines of output. To handle that, we would
193 % have adopt a much more difficult approach (putting marks into the main
194 % vertical list for the beginning and end of each change).
196 \def\|{%
197 % \vadjust can only be used in horizontal mode.
198 \leavevmode
200 % Append this vertical mode material after the current line in the output.
201 \vadjust{%
202 % We want to insert a rule with the height and depth of the current
203 % leading; that is exactly what \strutbox is supposed to record.
204 \vskip-\baselineskip
206 % \vadjust-items are inserted at the left edge of the type. So
207 % the \llap here moves out into the left-hand margin.
208 \llap{%
210 % For a thicker or thinner bar, change the `1pt'.
211 \vrule height\baselineskip width1pt
213 % This is the space between the bar and the text.
214 \hskip 12pt
219 % Sometimes it is convenient to have everything in the transcript file
220 % and nothing on the terminal. We don't just call \tracingall here,
221 % since that produces some useless output on the terminal. We also make
222 % some effort to order the tracing commands to reduce output in the log
223 % file; cf. trace.sty in LaTeX.
225 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
226 \def\loggingall{%
227 \tracingstats2
228 \tracingpages1
229 \tracinglostchars2 % 2 gives us more in etex
230 \tracingparagraphs1
231 \tracingoutput1
232 \tracingmacros2
233 \tracingrestores1
234 \showboxbreadth\maxdimen \showboxdepth\maxdimen
235 \ifx\eTeXversion\undefined\else % etex gives us more logging
236 \tracingscantokens1
237 \tracingifs1
238 \tracinggroups1
239 \tracingnesting2
240 \tracingassigns1
242 \tracingcommands3 % 3 gives us more in etex
243 \errorcontextlines16
246 % add check for \lastpenalty to plain's definitions. If the last thing
247 % we did was a \nobreak, we don't want to insert more space.
249 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
250 \removelastskip\penalty-50\smallskip\fi\fi}
251 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
252 \removelastskip\penalty-100\medskip\fi\fi}
253 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
254 \removelastskip\penalty-200\bigskip\fi\fi}
256 % For @cropmarks command.
257 % Do @cropmarks to get crop marks.
259 \newif\ifcropmarks
260 \let\cropmarks = \cropmarkstrue
262 % Dimensions to add cropmarks at corners.
263 % Added by P. A. MacKay, 12 Nov. 1986
265 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
266 \newdimen\cornerlong \cornerlong=1pc
267 \newdimen\cornerthick \cornerthick=.3pt
268 \newdimen\topandbottommargin \topandbottommargin=.75in
270 % Main output routine.
271 \chardef\PAGE = 255
272 \output = {\onepageout{\pagecontents\PAGE}}
274 \newbox\headlinebox
275 \newbox\footlinebox
277 % \onepageout takes a vbox as an argument. Note that \pagecontents
278 % does insertions, but you have to call it yourself.
279 \def\onepageout#1{%
280 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
282 \ifodd\pageno \advance\hoffset by \bindingoffset
283 \else \advance\hoffset by -\bindingoffset\fi
285 % Do this outside of the \shipout so @code etc. will be expanded in
286 % the headline as they should be, not taken literally (outputting ''code).
287 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
288 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
291 % Have to do this stuff outside the \shipout because we want it to
292 % take effect in \write's, yet the group defined by the \vbox ends
293 % before the \shipout runs.
295 \indexdummies % don't expand commands in the output.
296 \normalturnoffactive % \ in index entries must not stay \, e.g., if
297 % the page break happens to be in the middle of an example.
298 % We don't want .vr (or whatever) entries like this:
299 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
300 % "\acronym" won't work when it's read back in;
301 % it needs to be
302 % {\code {{\tt \backslashcurfont }acronym}
303 \shipout\vbox{%
304 % Do this early so pdf references go to the beginning of the page.
305 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
307 \ifcropmarks \vbox to \outervsize\bgroup
308 \hsize = \outerhsize
309 \vskip-\topandbottommargin
310 \vtop to0pt{%
311 \line{\ewtop\hfil\ewtop}%
312 \nointerlineskip
313 \line{%
314 \vbox{\moveleft\cornerthick\nstop}%
315 \hfill
316 \vbox{\moveright\cornerthick\nstop}%
318 \vss}%
319 \vskip\topandbottommargin
320 \line\bgroup
321 \hfil % center the page within the outer (page) hsize.
322 \ifodd\pageno\hskip\bindingoffset\fi
323 \vbox\bgroup
326 \unvbox\headlinebox
327 \pagebody{#1}%
328 \ifdim\ht\footlinebox > 0pt
329 % Only leave this space if the footline is nonempty.
330 % (We lessened \vsize for it in \oddfootingxxx.)
331 % The \baselineskip=24pt in plain's \makefootline has no effect.
332 \vskip 2\baselineskip
333 \unvbox\footlinebox
336 \ifcropmarks
337 \egroup % end of \vbox\bgroup
338 \hfil\egroup % end of (centering) \line\bgroup
339 \vskip\topandbottommargin plus1fill minus1fill
340 \boxmaxdepth = \cornerthick
341 \vbox to0pt{\vss
342 \line{%
343 \vbox{\moveleft\cornerthick\nsbot}%
344 \hfill
345 \vbox{\moveright\cornerthick\nsbot}%
347 \nointerlineskip
348 \line{\ewbot\hfil\ewbot}%
350 \egroup % \vbox from first cropmarks clause
352 }% end of \shipout\vbox
353 }% end of group with \indexdummies
354 \advancepageno
355 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
358 \newinsert\margin \dimen\margin=\maxdimen
360 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
361 {\catcode`\@ =11
362 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
363 % marginal hacks, juha@viisa.uucp (Juha Takala)
364 \ifvoid\margin\else % marginal info is present
365 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
366 \dimen@=\dp#1 \unvbox#1
367 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
368 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
371 % Here are the rules for the cropmarks. Note that they are
372 % offset so that the space between them is truly \outerhsize or \outervsize
373 % (P. A. MacKay, 12 November, 1986)
375 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
376 \def\nstop{\vbox
377 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
378 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
379 \def\nsbot{\vbox
380 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
382 % Parse an argument, then pass it to #1. The argument is the rest of
383 % the input line (except we remove a trailing comment). #1 should be a
384 % macro which expects an ordinary undelimited TeX argument.
386 \def\parsearg{\parseargusing{}}
387 \def\parseargusing#1#2{%
388 \def\argtorun{#2}%
389 \begingroup
390 \obeylines
391 \spaceisspace
393 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
396 {\obeylines %
397 \gdef\parseargline#1^^M{%
398 \endgroup % End of the group started in \parsearg.
399 \argremovecomment #1\comment\ArgTerm%
403 % First remove any @comment, then any @c comment.
404 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
405 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
407 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
409 % \argremovec might leave us with trailing space, e.g.,
410 % @end itemize @c foo
411 % This space token undergoes the same procedure and is eventually removed
412 % by \finishparsearg.
414 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
415 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
416 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
417 \def\temp{#3}%
418 \ifx\temp\empty
419 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
420 \let\temp\finishparsearg
421 \else
422 \let\temp\argcheckspaces
424 % Put the space token in:
425 \temp#1 #3\ArgTerm
428 % If a _delimited_ argument is enclosed in braces, they get stripped; so
429 % to get _exactly_ the rest of the line, we had to prevent such situation.
430 % We prepended an \empty token at the very beginning and we expand it now,
431 % just before passing the control to \argtorun.
432 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
433 % either the null string, or it ends with \^^M---thus there is no danger
434 % that a pair of braces would be stripped.
436 % But first, we have to remove the trailing space token.
438 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
440 % \parseargdef\foo{...}
441 % is roughly equivalent to
442 % \def\foo{\parsearg\Xfoo}
443 % \def\Xfoo#1{...}
445 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
446 % favourite TeX trick. --kasal, 16nov03
448 \def\parseargdef#1{%
449 \expandafter \doparseargdef \csname\string#1\endcsname #1%
451 \def\doparseargdef#1#2{%
452 \def#2{\parsearg#1}%
453 \def#1##1%
456 % Several utility definitions with active space:
458 \obeyspaces
459 \gdef\obeyedspace{ }
461 % Make each space character in the input produce a normal interword
462 % space in the output. Don't allow a line break at this space, as this
463 % is used only in environments like @example, where each line of input
464 % should produce a line of output anyway.
466 \gdef\sepspaces{\obeyspaces\let =\tie}
468 % If an index command is used in an @example environment, any spaces
469 % therein should become regular spaces in the raw index file, not the
470 % expansion of \tie (\leavevmode \penalty \@M \ ).
471 \gdef\unsepspaces{\let =\space}
475 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
477 % Define the framework for environments in texinfo.tex. It's used like this:
479 % \envdef\foo{...}
480 % \def\Efoo{...}
482 % It's the responsibility of \envdef to insert \begingroup before the
483 % actual body; @end closes the group after calling \Efoo. \envdef also
484 % defines \thisenv, so the current environment is known; @end checks
485 % whether the environment name matches. The \checkenv macro can also be
486 % used to check whether the current environment is the one expected.
488 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
489 % are not treated as enviroments; they don't open a group. (The
490 % implementation of @end takes care not to call \endgroup in this
491 % special case.)
494 % At runtime, environments start with this:
495 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
496 % initialize
497 \let\thisenv\empty
499 % ... but they get defined via ``\envdef\foo{...}'':
500 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
501 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
503 % Check whether we're in the right environment:
504 \def\checkenv#1{%
505 \def\temp{#1}%
506 \ifx\thisenv\temp
507 \else
508 \badenverr
512 % Evironment mismatch, #1 expected:
513 \def\badenverr{%
514 \errhelp = \EMsimple
515 \errmessage{This command can appear only \inenvironment\temp,
516 not \inenvironment\thisenv}%
518 \def\inenvironment#1{%
519 \ifx#1\empty
520 out of any environment%
521 \else
522 in environment \expandafter\string#1%
526 % @end foo executes the definition of \Efoo.
527 % But first, it executes a specialized version of \checkenv
529 \parseargdef\end{%
530 \if 1\csname iscond.#1\endcsname
531 \else
532 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
533 \expandafter\checkenv\csname#1\endcsname
534 \csname E#1\endcsname
535 \endgroup
539 \newhelp\EMsimple{Press RETURN to continue.}
542 %% Simple single-character @ commands
544 % @@ prints an @
545 % Kludge this until the fonts are right (grr).
546 \def\@{{\tt\char64}}
548 % This is turned off because it was never documented
549 % and you can use @w{...} around a quote to suppress ligatures.
550 %% Define @` and @' to be the same as ` and '
551 %% but suppressing ligatures.
552 %\def\`{{`}}
553 %\def\'{{'}}
555 % Used to generate quoted braces.
556 \def\mylbrace {{\tt\char123}}
557 \def\myrbrace {{\tt\char125}}
558 \let\{=\mylbrace
559 \let\}=\myrbrace
560 \begingroup
561 % Definitions to produce \{ and \} commands for indices,
562 % and @{ and @} for the aux/toc files.
563 \catcode`\{ = \other \catcode`\} = \other
564 \catcode`\[ = 1 \catcode`\] = 2
565 \catcode`\! = 0 \catcode`\\ = \other
566 !gdef!lbracecmd[\{]%
567 !gdef!rbracecmd[\}]%
568 !gdef!lbraceatcmd[@{]%
569 !gdef!rbraceatcmd[@}]%
570 !endgroup
572 % @comma{} to avoid , parsing problems.
573 \let\comma = ,
575 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
576 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
577 \let\, = \c
578 \let\dotaccent = \.
579 \def\ringaccent#1{{\accent23 #1}}
580 \let\tieaccent = \t
581 \let\ubaraccent = \b
582 \let\udotaccent = \d
584 % Other special characters: @questiondown @exclamdown @ordf @ordm
585 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
586 \def\questiondown{?`}
587 \def\exclamdown{!`}
588 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
589 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
591 % Dotless i and dotless j, used for accents.
592 \def\imacro{i}
593 \def\jmacro{j}
594 \def\dotless#1{%
595 \def\temp{#1}%
596 \ifx\temp\imacro \ptexi
597 \else\ifx\temp\jmacro \j
598 \else \errmessage{@dotless can be used only with i or j}%
599 \fi\fi
602 % The \TeX{} logo, as in plain, but resetting the spacing so that a
603 % period following counts as ending a sentence. (Idea found in latex.)
605 \edef\TeX{\TeX \spacefactor=1000 }
607 % @LaTeX{} logo. Not quite the same results as the definition in
608 % latex.ltx, since we use a different font for the raised A; it's most
609 % convenient for us to use an explicitly smaller font, rather than using
610 % the \scriptstyle font (since we don't reset \scriptstyle and
611 % \scriptscriptstyle).
613 \def\LaTeX{%
614 L\kern-.36em
615 {\setbox0=\hbox{T}%
616 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
617 \kern-.15em
618 \TeX
621 % Be sure we're in horizontal mode when doing a tie, since we make space
622 % equivalent to this in @example-like environments. Otherwise, a space
623 % at the beginning of a line will start with \penalty -- and
624 % since \penalty is valid in vertical mode, we'd end up putting the
625 % penalty on the vertical list instead of in the new paragraph.
626 {\catcode`@ = 11
627 % Avoid using \@M directly, because that causes trouble
628 % if the definition is written into an index file.
629 \global\let\tiepenalty = \@M
630 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
633 % @: forces normal size whitespace following.
634 \def\:{\spacefactor=1000 }
636 % @* forces a line break.
637 \def\*{\hfil\break\hbox{}\ignorespaces}
639 % @/ allows a line break.
640 \let\/=\allowbreak
642 % @. is an end-of-sentence period.
643 \def\.{.\spacefactor=\endofsentencespacefactor\space}
645 % @! is an end-of-sentence bang.
646 \def\!{!\spacefactor=\endofsentencespacefactor\space}
648 % @? is an end-of-sentence query.
649 \def\?{?\spacefactor=\endofsentencespacefactor\space}
651 % @frenchspacing on|off says whether to put extra space after punctuation.
653 \def\onword{on}
654 \def\offword{off}
656 \parseargdef\frenchspacing{%
657 \def\temp{#1}%
658 \ifx\temp\onword \plainfrenchspacing
659 \else\ifx\temp\offword \plainnonfrenchspacing
660 \else
661 \errhelp = \EMsimple
662 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
663 \fi\fi
666 % @w prevents a word break. Without the \leavevmode, @w at the
667 % beginning of a paragraph, when TeX is still in vertical mode, would
668 % produce a whole line of output instead of starting the paragraph.
669 \def\w#1{\leavevmode\hbox{#1}}
671 % @group ... @end group forces ... to be all on one page, by enclosing
672 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
673 % to keep its height that of a normal line. According to the rules for
674 % \topskip (p.114 of the TeXbook), the glue inserted is
675 % max (\topskip - \ht (first item), 0). If that height is large,
676 % therefore, no glue is inserted, and the space between the headline and
677 % the text is small, which looks bad.
679 % Another complication is that the group might be very large. This can
680 % cause the glue on the previous page to be unduly stretched, because it
681 % does not have much material. In this case, it's better to add an
682 % explicit \vfill so that the extra space is at the bottom. The
683 % threshold for doing this is if the group is more than \vfilllimit
684 % percent of a page (\vfilllimit can be changed inside of @tex).
686 \newbox\groupbox
687 \def\vfilllimit{0.7}
689 \envdef\group{%
690 \ifnum\catcode`\^^M=\active \else
691 \errhelp = \groupinvalidhelp
692 \errmessage{@group invalid in context where filling is enabled}%
694 \startsavinginserts
696 \setbox\groupbox = \vtop\bgroup
697 % Do @comment since we are called inside an environment such as
698 % @example, where each end-of-line in the input causes an
699 % end-of-line in the output. We don't want the end-of-line after
700 % the `@group' to put extra space in the output. Since @group
701 % should appear on a line by itself (according to the Texinfo
702 % manual), we don't worry about eating any user text.
703 \comment
706 % The \vtop produces a box with normal height and large depth; thus, TeX puts
707 % \baselineskip glue before it, and (when the next line of text is done)
708 % \lineskip glue after it. Thus, space below is not quite equal to space
709 % above. But it's pretty close.
710 \def\Egroup{%
711 % To get correct interline space between the last line of the group
712 % and the first line afterwards, we have to propagate \prevdepth.
713 \endgraf % Not \par, as it may have been set to \lisppar.
714 \global\dimen1 = \prevdepth
715 \egroup % End the \vtop.
716 % \dimen0 is the vertical size of the group's box.
717 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
718 % \dimen2 is how much space is left on the page (more or less).
719 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
720 % if the group doesn't fit on the current page, and it's a big big
721 % group, force a page break.
722 \ifdim \dimen0 > \dimen2
723 \ifdim \pagetotal < \vfilllimit\pageheight
724 \page
727 \box\groupbox
728 \prevdepth = \dimen1
729 \checkinserts
732 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
733 % message, so this ends up printing `@group can only ...'.
735 \newhelp\groupinvalidhelp{%
736 group can only be used in environments such as @example,^^J%
737 where each line of input produces a line of output.}
739 % @need space-in-mils
740 % forces a page break if there is not space-in-mils remaining.
742 \newdimen\mil \mil=0.001in
744 % Old definition--didn't work.
745 %\parseargdef\need{\par %
746 %% This method tries to make TeX break the page naturally
747 %% if the depth of the box does not fit.
748 %{\baselineskip=0pt%
749 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
750 %\prevdepth=-1000pt
753 \parseargdef\need{%
754 % Ensure vertical mode, so we don't make a big box in the middle of a
755 % paragraph.
756 \par
758 % If the @need value is less than one line space, it's useless.
759 \dimen0 = #1\mil
760 \dimen2 = \ht\strutbox
761 \advance\dimen2 by \dp\strutbox
762 \ifdim\dimen0 > \dimen2
764 % Do a \strut just to make the height of this box be normal, so the
765 % normal leading is inserted relative to the preceding line.
766 % And a page break here is fine.
767 \vtop to #1\mil{\strut\vfil}%
769 % TeX does not even consider page breaks if a penalty added to the
770 % main vertical list is 10000 or more. But in order to see if the
771 % empty box we just added fits on the page, we must make it consider
772 % page breaks. On the other hand, we don't want to actually break the
773 % page after the empty box. So we use a penalty of 9999.
775 % There is an extremely small chance that TeX will actually break the
776 % page at this \penalty, if there are no other feasible breakpoints in
777 % sight. (If the user is using lots of big @group commands, which
778 % almost-but-not-quite fill up a page, TeX will have a hard time doing
779 % good page breaking, for example.) However, I could not construct an
780 % example where a page broke at this \penalty; if it happens in a real
781 % document, then we can reconsider our strategy.
782 \penalty9999
784 % Back up by the size of the box, whether we did a page break or not.
785 \kern -#1\mil
787 % Do not allow a page break right after this kern.
788 \nobreak
792 % @br forces paragraph break (and is undocumented).
794 \let\br = \par
796 % @page forces the start of a new page.
798 \def\page{\par\vfill\supereject}
800 % @exdent text....
801 % outputs text on separate line in roman font, starting at standard page margin
803 % This records the amount of indent in the innermost environment.
804 % That's how much \exdent should take out.
805 \newskip\exdentamount
807 % This defn is used inside fill environments such as @defun.
808 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
810 % This defn is used inside nofill environments such as @example.
811 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
812 \leftline{\hskip\leftskip{\rm#1}}}}
814 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
815 % paragraph. For more general purposes, use the \margin insertion
816 % class. WHICH is `l' or `r'.
818 \newskip\inmarginspacing \inmarginspacing=1cm
819 \def\strutdepth{\dp\strutbox}
821 \def\doinmargin#1#2{\strut\vadjust{%
822 \nobreak
823 \kern-\strutdepth
824 \vtop to \strutdepth{%
825 \baselineskip=\strutdepth
826 \vss
827 % if you have multiple lines of stuff to put here, you'll need to
828 % make the vbox yourself of the appropriate size.
829 \ifx#1l%
830 \llap{\ignorespaces #2\hskip\inmarginspacing}%
831 \else
832 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
834 \null
837 \def\inleftmargin{\doinmargin l}
838 \def\inrightmargin{\doinmargin r}
840 % @inmargin{TEXT [, RIGHT-TEXT]}
841 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
842 % else use TEXT for both).
844 \def\inmargin#1{\parseinmargin #1,,\finish}
845 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
846 \setbox0 = \hbox{\ignorespaces #2}%
847 \ifdim\wd0 > 0pt
848 \def\lefttext{#1}% have both texts
849 \def\righttext{#2}%
850 \else
851 \def\lefttext{#1}% have only one text
852 \def\righttext{#1}%
855 \ifodd\pageno
856 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
857 \else
858 \def\temp{\inleftmargin\lefttext}%
860 \temp
863 % @include file insert text of that file as input.
865 \def\include{\parseargusing\filenamecatcodes\includezzz}
866 \def\includezzz#1{%
867 \pushthisfilestack
868 \def\thisfile{#1}%
870 \makevalueexpandable
871 \def\temp{\input #1 }%
872 \expandafter
873 }\temp
874 \popthisfilestack
876 \def\filenamecatcodes{%
877 \catcode`\\=\other
878 \catcode`~=\other
879 \catcode`^=\other
880 \catcode`_=\other
881 \catcode`|=\other
882 \catcode`<=\other
883 \catcode`>=\other
884 \catcode`+=\other
885 \catcode`-=\other
888 \def\pushthisfilestack{%
889 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
891 \def\pushthisfilestackX{%
892 \expandafter\pushthisfilestackY\thisfile\StackTerm
894 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
895 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
898 \def\popthisfilestack{\errthisfilestackempty}
899 \def\errthisfilestackempty{\errmessage{Internal error:
900 the stack of filenames is empty.}}
902 \def\thisfile{}
904 % @center line
905 % outputs that line, centered.
907 \parseargdef\center{%
908 \ifhmode
909 \let\next\centerH
910 \else
911 \let\next\centerV
913 \next{\hfil \ignorespaces#1\unskip \hfil}%
915 \def\centerH#1{%
917 \hfil\break
918 \advance\hsize by -\leftskip
919 \advance\hsize by -\rightskip
920 \line{#1}%
921 \break
924 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
926 % @sp n outputs n lines of vertical space
928 \parseargdef\sp{\vskip #1\baselineskip}
930 % @comment ...line which is ignored...
931 % @c is the same as @comment
932 % @ignore ... @end ignore is another way to write a comment
934 \def\comment{\begingroup \catcode`\^^M=\other%
935 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
936 \commentxxx}
937 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
939 \let\c=\comment
941 % @paragraphindent NCHARS
942 % We'll use ems for NCHARS, close enough.
943 % NCHARS can also be the word `asis' or `none'.
944 % We cannot feasibly implement @paragraphindent asis, though.
946 \def\asisword{asis} % no translation, these are keywords
947 \def\noneword{none}
949 \parseargdef\paragraphindent{%
950 \def\temp{#1}%
951 \ifx\temp\asisword
952 \else
953 \ifx\temp\noneword
954 \defaultparindent = 0pt
955 \else
956 \defaultparindent = #1em
959 \parindent = \defaultparindent
962 % @exampleindent NCHARS
963 % We'll use ems for NCHARS like @paragraphindent.
964 % It seems @exampleindent asis isn't necessary, but
965 % I preserve it to make it similar to @paragraphindent.
966 \parseargdef\exampleindent{%
967 \def\temp{#1}%
968 \ifx\temp\asisword
969 \else
970 \ifx\temp\noneword
971 \lispnarrowing = 0pt
972 \else
973 \lispnarrowing = #1em
978 % @firstparagraphindent WORD
979 % If WORD is `none', then suppress indentation of the first paragraph
980 % after a section heading. If WORD is `insert', then do indent at such
981 % paragraphs.
983 % The paragraph indentation is suppressed or not by calling
984 % \suppressfirstparagraphindent, which the sectioning commands do.
985 % We switch the definition of this back and forth according to WORD.
986 % By default, we suppress indentation.
988 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
989 \def\insertword{insert}
991 \parseargdef\firstparagraphindent{%
992 \def\temp{#1}%
993 \ifx\temp\noneword
994 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
995 \else\ifx\temp\insertword
996 \let\suppressfirstparagraphindent = \relax
997 \else
998 \errhelp = \EMsimple
999 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1000 \fi\fi
1003 % Here is how we actually suppress indentation. Redefine \everypar to
1004 % \kern backwards by \parindent, and then reset itself to empty.
1006 % We also make \indent itself not actually do anything until the next
1007 % paragraph.
1009 \gdef\dosuppressfirstparagraphindent{%
1010 \gdef\indent{%
1011 \restorefirstparagraphindent
1012 \indent
1014 \gdef\noindent{%
1015 \restorefirstparagraphindent
1016 \noindent
1018 \global\everypar = {%
1019 \kern -\parindent
1020 \restorefirstparagraphindent
1024 \gdef\restorefirstparagraphindent{%
1025 \global \let \indent = \ptexindent
1026 \global \let \noindent = \ptexnoindent
1027 \global \everypar = {}%
1031 % @asis just yields its argument. Used with @table, for example.
1033 \def\asis#1{#1}
1035 % @math outputs its argument in math mode.
1037 % One complication: _ usually means subscripts, but it could also mean
1038 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1039 % _ active, and distinguish by seeing if the current family is \slfam,
1040 % which is what @var uses.
1042 \catcode`\_ = \active
1043 \gdef\mathunderscore{%
1044 \catcode`\_=\active
1045 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1048 % Another complication: we want \\ (and @\) to output a \ character.
1049 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1050 % this is not advertised and we don't care. Texinfo does not
1051 % otherwise define @\.
1053 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1054 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1056 \def\math{%
1057 \tex
1058 \mathunderscore
1059 \let\\ = \mathbackslash
1060 \mathactive
1061 $\finishmath
1063 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1065 % Some active characters (such as <) are spaced differently in math.
1066 % We have to reset their definitions in case the @math was an argument
1067 % to a command which sets the catcodes (such as @item or @section).
1070 \catcode`^ = \active
1071 \catcode`< = \active
1072 \catcode`> = \active
1073 \catcode`+ = \active
1074 \gdef\mathactive{%
1075 \let^ = \ptexhat
1076 \let< = \ptexless
1077 \let> = \ptexgtr
1078 \let+ = \ptexplus
1082 % @bullet and @minus need the same treatment as @math, just above.
1083 \def\bullet{$\ptexbullet$}
1084 \def\minus{$-$}
1086 % @dots{} outputs an ellipsis using the current font.
1087 % We do .5em per period so that it has the same spacing in a typewriter
1088 % font as three actual period characters.
1090 \def\dots{%
1091 \leavevmode
1092 \hbox to 1.5em{%
1093 \hskip 0pt plus 0.25fil
1094 .\hfil.\hfil.%
1095 \hskip 0pt plus 0.5fil
1099 % @enddots{} is an end-of-sentence ellipsis.
1101 \def\enddots{%
1102 \dots
1103 \spacefactor=\endofsentencespacefactor
1106 % @comma{} is so commas can be inserted into text without messing up
1107 % Texinfo's parsing.
1109 \let\comma = ,
1111 % @refill is a no-op.
1112 \let\refill=\relax
1114 % If working on a large document in chapters, it is convenient to
1115 % be able to disable indexing, cross-referencing, and contents, for test runs.
1116 % This is done with @novalidate (before @setfilename).
1118 \newif\iflinks \linkstrue % by default we want the aux files.
1119 \let\novalidate = \linksfalse
1121 % @setfilename is done at the beginning of every texinfo file.
1122 % So open here the files we need to have open while reading the input.
1123 % This makes it possible to make a .fmt file for texinfo.
1124 \def\setfilename{%
1125 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1126 \iflinks
1127 \tryauxfile
1128 % Open the new aux file. TeX will close it automatically at exit.
1129 \immediate\openout\auxfile=\jobname.aux
1130 \fi % \openindices needs to do some work in any case.
1131 \openindices
1132 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1134 % If texinfo.cnf is present on the system, read it.
1135 % Useful for site-wide @afourpaper, etc.
1136 \openin 1 texinfo.cnf
1137 \ifeof 1 \else \input texinfo.cnf \fi
1138 \closein 1
1140 \comment % Ignore the actual filename.
1143 % Called from \setfilename.
1145 \def\openindices{%
1146 \newindex{cp}%
1147 \newcodeindex{fn}%
1148 \newcodeindex{vr}%
1149 \newcodeindex{tp}%
1150 \newcodeindex{ky}%
1151 \newcodeindex{pg}%
1154 % @bye.
1155 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1158 \message{pdf,}
1159 % adobe `portable' document format
1160 \newcount\tempnum
1161 \newcount\lnkcount
1162 \newtoks\filename
1163 \newcount\filenamelength
1164 \newcount\pgn
1165 \newtoks\toksA
1166 \newtoks\toksB
1167 \newtoks\toksC
1168 \newtoks\toksD
1169 \newbox\boxA
1170 \newcount\countA
1171 \newif\ifpdf
1172 \newif\ifpdfmakepagedest
1174 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1175 % can be set). So we test for \relax and 0 as well as \undefined,
1176 % borrowed from ifpdf.sty.
1177 \ifx\pdfoutput\undefined
1178 \else
1179 \ifx\pdfoutput\relax
1180 \else
1181 \ifcase\pdfoutput
1182 \else
1183 \pdftrue
1188 % PDF uses PostScript string constants for the names of xref targets,
1189 % for display in the outlines, and in other places. Thus, we have to
1190 % double any backslashes. Otherwise, a name like "\node" will be
1191 % interpreted as a newline (\n), followed by o, d, e. Not good.
1192 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1193 % (and related messages, the final outcome is that it is up to the TeX
1194 % user to double the backslashes and otherwise make the string valid, so
1195 % that's what we do).
1197 % double active backslashes.
1199 {\catcode`\@=0 \catcode`\\=\active
1200 @gdef@activebackslashdouble{%
1201 @catcode`@\=@active
1202 @let\=@doublebackslash}
1205 % To handle parens, we must adopt a different approach, since parens are
1206 % not active characters. hyperref.dtx (which has the same problem as
1207 % us) handles it with this amazing macro to replace tokens. I've
1208 % tinkered with it a little for texinfo, but it's definitely from there.
1210 % #1 is the tokens to replace.
1211 % #2 is the replacement.
1212 % #3 is the control sequence with the string.
1214 \def\HyPsdSubst#1#2#3{%
1215 \def\HyPsdReplace##1#1##2\END{%
1216 ##1%
1217 \ifx\\##2\\%
1218 \else
1220 \HyReturnAfterFi{%
1221 \HyPsdReplace##2\END
1225 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1227 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1229 % #1 is a control sequence in which to do the replacements.
1230 \def\backslashparens#1{%
1231 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1232 % \lastnode when called from \setref -> \pdfmkdest.
1233 \HyPsdSubst{(}{\realbackslash(}{#1}%
1234 \HyPsdSubst{)}{\realbackslash)}{#1}%
1237 \ifpdf
1238 \input pdfcolor
1239 \pdfcatalog{/PageMode /UseOutlines}%
1240 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1241 \def\dopdfimage#1#2#3{%
1242 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1243 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1244 % without \immediate, pdftex seg faults when the same image is
1245 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1246 \ifnum\pdftexversion < 14
1247 \immediate\pdfimage
1248 \else
1249 \immediate\pdfximage
1251 \ifdim \wd0 >0pt width \imagewidth \fi
1252 \ifdim \wd2 >0pt height \imageheight \fi
1253 \ifnum\pdftexversion<13
1254 #1.pdf%
1255 \else
1256 {#1.pdf}%
1258 \ifnum\pdftexversion < 14 \else
1259 \pdfrefximage \pdflastximage
1260 \fi}
1261 \def\pdfmkdest#1{{%
1262 % We have to set dummies so commands such as @code, and characters
1263 % such as \, aren't expanded when present in a section title.
1264 \atdummies
1265 \activebackslashdouble
1266 \def\pdfdestname{#1}%
1267 \backslashparens\pdfdestname
1268 \pdfdest name{\pdfdestname} xyz%
1271 % used to mark target names; must be expandable.
1272 \def\pdfmkpgn#1{#1}%
1274 \let\linkcolor = \Blue % was Cyan, but that seems light?
1275 \def\endlink{\Black\pdfendlink}
1276 % Adding outlines to PDF; macros for calculating structure of outlines
1277 % come from Petr Olsak
1278 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1279 \else \csname#1\endcsname \fi}
1280 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1281 \advance\tempnum by 1
1282 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1284 % #1 is the section text, which is what will be displayed in the
1285 % outline by the pdf viewer. #2 is the pdf expression for the number
1286 % of subentries (or empty, for subsubsections). #3 is the node text,
1287 % which might be empty if this toc entry had no corresponding node.
1288 % #4 is the page number
1290 \def\dopdfoutline#1#2#3#4{%
1291 % Generate a link to the node text if that exists; else, use the
1292 % page number. We could generate a destination for the section
1293 % text in the case where a section has no node, but it doesn't
1294 % seem worth the trouble, since most documents are normally structured.
1295 \def\pdfoutlinedest{#3}%
1296 \ifx\pdfoutlinedest\empty
1297 \def\pdfoutlinedest{#4}%
1298 \else
1299 % Doubled backslashes in the name.
1300 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1301 \backslashparens\pdfoutlinedest}%
1304 % Also double the backslashes in the display string.
1305 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1306 \backslashparens\pdfoutlinetext}%
1308 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1311 \def\pdfmakeoutlines{%
1312 \begingroup
1313 % Thanh's hack / proper braces in bookmarks
1314 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1315 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1317 % Read toc silently, to get counts of subentries for \pdfoutline.
1318 \def\numchapentry##1##2##3##4{%
1319 \def\thischapnum{##2}%
1320 \def\thissecnum{0}%
1321 \def\thissubsecnum{0}%
1323 \def\numsecentry##1##2##3##4{%
1324 \advancenumber{chap\thischapnum}%
1325 \def\thissecnum{##2}%
1326 \def\thissubsecnum{0}%
1328 \def\numsubsecentry##1##2##3##4{%
1329 \advancenumber{sec\thissecnum}%
1330 \def\thissubsecnum{##2}%
1332 \def\numsubsubsecentry##1##2##3##4{%
1333 \advancenumber{subsec\thissubsecnum}%
1335 \def\thischapnum{0}%
1336 \def\thissecnum{0}%
1337 \def\thissubsecnum{0}%
1339 % use \def rather than \let here because we redefine \chapentry et
1340 % al. a second time, below.
1341 \def\appentry{\numchapentry}%
1342 \def\appsecentry{\numsecentry}%
1343 \def\appsubsecentry{\numsubsecentry}%
1344 \def\appsubsubsecentry{\numsubsubsecentry}%
1345 \def\unnchapentry{\numchapentry}%
1346 \def\unnsecentry{\numsecentry}%
1347 \def\unnsubsecentry{\numsubsecentry}%
1348 \def\unnsubsubsecentry{\numsubsubsecentry}%
1349 \readdatafile{toc}%
1351 % Read toc second time, this time actually producing the outlines.
1352 % The `-' means take the \expnumber as the absolute number of
1353 % subentries, which we calculated on our first read of the .toc above.
1355 % We use the node names as the destinations.
1356 \def\numchapentry##1##2##3##4{%
1357 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1358 \def\numsecentry##1##2##3##4{%
1359 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1360 \def\numsubsecentry##1##2##3##4{%
1361 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1362 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1363 \dopdfoutline{##1}{}{##3}{##4}}%
1365 % PDF outlines are displayed using system fonts, instead of
1366 % document fonts. Therefore we cannot use special characters,
1367 % since the encoding is unknown. For example, the eogonek from
1368 % Latin 2 (0xea) gets translated to a | character. Info from
1369 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1371 % xx to do this right, we have to translate 8-bit characters to
1372 % their "best" equivalent, based on the @documentencoding. Right
1373 % now, I guess we'll just let the pdf reader have its way.
1374 \indexnofonts
1375 \setupdatafile
1376 \catcode`\\=\active \otherbackslash
1377 \input \jobname.toc
1378 \endgroup
1381 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1382 \ifx\PP\D\let\nextsp\relax
1383 \else\let\nextsp\skipspaces
1384 \ifx\p\space\else\addtokens{\filename}{\PP}%
1385 \advance\filenamelength by 1
1388 \nextsp}
1389 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1390 \ifnum\pdftexversion < 14
1391 \let \startlink \pdfannotlink
1392 \else
1393 \let \startlink \pdfstartlink
1395 % make a live url in pdf output.
1396 \def\pdfurl#1{%
1397 \begingroup
1398 % it seems we really need yet another set of dummies; have not
1399 % tried to figure out what each command should do in the context
1400 % of @url. for now, just make @/ a no-op, that's the only one
1401 % people have actually reported a problem with.
1403 \normalturnoffactive
1404 \def\@{@}%
1405 \let\/=\empty
1406 \makevalueexpandable
1407 \leavevmode\Red
1408 \startlink attr{/Border [0 0 0]}%
1409 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1410 \endgroup}
1411 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1412 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1413 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1414 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1415 \def\maketoks{%
1416 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1417 \ifx\first0\adn0
1418 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1419 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1420 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1421 \else
1422 \ifnum0=\countA\else\makelink\fi
1423 \ifx\first.\let\next=\done\else
1424 \let\next=\maketoks
1425 \addtokens{\toksB}{\the\toksD}
1426 \ifx\first,\addtokens{\toksB}{\space}\fi
1428 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1429 \next}
1430 \def\makelink{\addtokens{\toksB}%
1431 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1432 \def\pdflink#1{%
1433 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1434 \linkcolor #1\endlink}
1435 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1436 \else
1437 \let\pdfmkdest = \gobble
1438 \let\pdfurl = \gobble
1439 \let\endlink = \relax
1440 \let\linkcolor = \relax
1441 \let\pdfmakeoutlines = \relax
1442 \fi % \ifx\pdfoutput
1445 \message{fonts,}
1447 % Change the current font style to #1, remembering it in \curfontstyle.
1448 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1449 % italics, not bold italics.
1451 \def\setfontstyle#1{%
1452 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1453 \csname ten#1\endcsname % change the current font
1456 % Select #1 fonts with the current style.
1458 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1460 \def\rm{\fam=0 \setfontstyle{rm}}
1461 \def\it{\fam=\itfam \setfontstyle{it}}
1462 \def\sl{\fam=\slfam \setfontstyle{sl}}
1463 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1464 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1466 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1467 % So we set up a \sf.
1468 \newfam\sffam
1469 \def\sf{\fam=\sffam \setfontstyle{sf}}
1470 \let\li = \sf % Sometimes we call it \li, not \sf.
1472 % We don't need math for this font style.
1473 \def\ttsl{\setfontstyle{ttsl}}
1476 % Default leading.
1477 \newdimen\textleading \textleading = 13.2pt
1479 % Set the baselineskip to #1, and the lineskip and strut size
1480 % correspondingly. There is no deep meaning behind these magic numbers
1481 % used as factors; they just match (closely enough) what Knuth defined.
1483 \def\lineskipfactor{.08333}
1484 \def\strutheightpercent{.70833}
1485 \def\strutdepthpercent {.29167}
1487 \def\setleading#1{%
1488 \normalbaselineskip = #1\relax
1489 \normallineskip = \lineskipfactor\normalbaselineskip
1490 \normalbaselines
1491 \setbox\strutbox =\hbox{%
1492 \vrule width0pt height\strutheightpercent\baselineskip
1493 depth \strutdepthpercent \baselineskip
1498 % Set the font macro #1 to the font named #2, adding on the
1499 % specified font prefix (normally `cm').
1500 % #3 is the font's design size, #4 is a scale factor
1501 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1504 % Use cm as the default font prefix.
1505 % To specify the font prefix, you must define \fontprefix
1506 % before you read in texinfo.tex.
1507 \ifx\fontprefix\undefined
1508 \def\fontprefix{cm}
1510 % Support font families that don't use the same naming scheme as CM.
1511 \def\rmshape{r}
1512 \def\rmbshape{bx} %where the normal face is bold
1513 \def\bfshape{b}
1514 \def\bxshape{bx}
1515 \def\ttshape{tt}
1516 \def\ttbshape{tt}
1517 \def\ttslshape{sltt}
1518 \def\itshape{ti}
1519 \def\itbshape{bxti}
1520 \def\slshape{sl}
1521 \def\slbshape{bxsl}
1522 \def\sfshape{ss}
1523 \def\sfbshape{ss}
1524 \def\scshape{csc}
1525 \def\scbshape{csc}
1527 % Definitions for a main text size of 11pt. This is the default in
1528 % Texinfo.
1530 \def\definetextfontsizexi{
1531 % Text fonts (11.2pt, magstep1).
1532 \def\textnominalsize{11pt}
1533 \edef\mainmagstep{\magstephalf}
1534 \setfont\textrm\rmshape{10}{\mainmagstep}
1535 \setfont\texttt\ttshape{10}{\mainmagstep}
1536 \setfont\textbf\bfshape{10}{\mainmagstep}
1537 \setfont\textit\itshape{10}{\mainmagstep}
1538 \setfont\textsl\slshape{10}{\mainmagstep}
1539 \setfont\textsf\sfshape{10}{\mainmagstep}
1540 \setfont\textsc\scshape{10}{\mainmagstep}
1541 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1542 \font\texti=cmmi10 scaled \mainmagstep
1543 \font\textsy=cmsy10 scaled \mainmagstep
1545 % A few fonts for @defun names and args.
1546 \setfont\defbf\bfshape{10}{\magstep1}
1547 \setfont\deftt\ttshape{10}{\magstep1}
1548 \setfont\defttsl\ttslshape{10}{\magstep1}
1549 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1551 % Fonts for indices, footnotes, small examples (9pt).
1552 \def\smallnominalsize{9pt}
1553 \setfont\smallrm\rmshape{9}{1000}
1554 \setfont\smalltt\ttshape{9}{1000}
1555 \setfont\smallbf\bfshape{10}{900}
1556 \setfont\smallit\itshape{9}{1000}
1557 \setfont\smallsl\slshape{9}{1000}
1558 \setfont\smallsf\sfshape{9}{1000}
1559 \setfont\smallsc\scshape{10}{900}
1560 \setfont\smallttsl\ttslshape{10}{900}
1561 \font\smalli=cmmi9
1562 \font\smallsy=cmsy9
1564 % Fonts for small examples (8pt).
1565 \def\smallernominalsize{8pt}
1566 \setfont\smallerrm\rmshape{8}{1000}
1567 \setfont\smallertt\ttshape{8}{1000}
1568 \setfont\smallerbf\bfshape{10}{800}
1569 \setfont\smallerit\itshape{8}{1000}
1570 \setfont\smallersl\slshape{8}{1000}
1571 \setfont\smallersf\sfshape{8}{1000}
1572 \setfont\smallersc\scshape{10}{800}
1573 \setfont\smallerttsl\ttslshape{10}{800}
1574 \font\smalleri=cmmi8
1575 \font\smallersy=cmsy8
1577 % Fonts for title page (20.4pt):
1578 \def\titlenominalsize{20pt}
1579 \setfont\titlerm\rmbshape{12}{\magstep3}
1580 \setfont\titleit\itbshape{10}{\magstep4}
1581 \setfont\titlesl\slbshape{10}{\magstep4}
1582 \setfont\titlett\ttbshape{12}{\magstep3}
1583 \setfont\titlettsl\ttslshape{10}{\magstep4}
1584 \setfont\titlesf\sfbshape{17}{\magstep1}
1585 \let\titlebf=\titlerm
1586 \setfont\titlesc\scbshape{10}{\magstep4}
1587 \font\titlei=cmmi12 scaled \magstep3
1588 \font\titlesy=cmsy10 scaled \magstep4
1589 \def\authorrm{\secrm}
1590 \def\authortt{\sectt}
1592 % Chapter (and unnumbered) fonts (17.28pt).
1593 \def\chapnominalsize{17pt}
1594 \setfont\chaprm\rmbshape{12}{\magstep2}
1595 \setfont\chapit\itbshape{10}{\magstep3}
1596 \setfont\chapsl\slbshape{10}{\magstep3}
1597 \setfont\chaptt\ttbshape{12}{\magstep2}
1598 \setfont\chapttsl\ttslshape{10}{\magstep3}
1599 \setfont\chapsf\sfbshape{17}{1000}
1600 \let\chapbf=\chaprm
1601 \setfont\chapsc\scbshape{10}{\magstep3}
1602 \font\chapi=cmmi12 scaled \magstep2
1603 \font\chapsy=cmsy10 scaled \magstep3
1605 % Section fonts (14.4pt).
1606 \def\secnominalsize{14pt}
1607 \setfont\secrm\rmbshape{12}{\magstep1}
1608 \setfont\secit\itbshape{10}{\magstep2}
1609 \setfont\secsl\slbshape{10}{\magstep2}
1610 \setfont\sectt\ttbshape{12}{\magstep1}
1611 \setfont\secttsl\ttslshape{10}{\magstep2}
1612 \setfont\secsf\sfbshape{12}{\magstep1}
1613 \let\secbf\secrm
1614 \setfont\secsc\scbshape{10}{\magstep2}
1615 \font\seci=cmmi12 scaled \magstep1
1616 \font\secsy=cmsy10 scaled \magstep2
1618 % Subsection fonts (13.15pt).
1619 \def\ssecnominalsize{13pt}
1620 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1621 \setfont\ssecit\itbshape{10}{1315}
1622 \setfont\ssecsl\slbshape{10}{1315}
1623 \setfont\ssectt\ttbshape{12}{\magstephalf}
1624 \setfont\ssecttsl\ttslshape{10}{1315}
1625 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1626 \let\ssecbf\ssecrm
1627 \setfont\ssecsc\scbshape{10}{1315}
1628 \font\sseci=cmmi12 scaled \magstephalf
1629 \font\ssecsy=cmsy10 scaled 1315
1631 % Reduced fonts for @acro in text (10pt).
1632 \def\reducednominalsize{10pt}
1633 \setfont\reducedrm\rmshape{10}{1000}
1634 \setfont\reducedtt\ttshape{10}{1000}
1635 \setfont\reducedbf\bfshape{10}{1000}
1636 \setfont\reducedit\itshape{10}{1000}
1637 \setfont\reducedsl\slshape{10}{1000}
1638 \setfont\reducedsf\sfshape{10}{1000}
1639 \setfont\reducedsc\scshape{10}{1000}
1640 \setfont\reducedttsl\ttslshape{10}{1000}
1641 \font\reducedi=cmmi10
1642 \font\reducedsy=cmsy10
1644 % reset the current fonts
1645 \textfonts
1647 } % end of 11pt text font size definitions
1650 % Definitions to make the main text be 10pt Computer Modern, with
1651 % section, chapter, etc., sizes following suit. This is for the GNU
1652 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1653 % future. Used with @smallbook, which sets the leading to 12pt.
1655 \def\definetextfontsizex{%
1656 % Text fonts (10pt).
1657 \def\textnominalsize{10pt}
1658 \edef\mainmagstep{1000}
1659 \setfont\textrm\rmshape{10}{\mainmagstep}
1660 \setfont\texttt\ttshape{10}{\mainmagstep}
1661 \setfont\textbf\bfshape{10}{\mainmagstep}
1662 \setfont\textit\itshape{10}{\mainmagstep}
1663 \setfont\textsl\slshape{10}{\mainmagstep}
1664 \setfont\textsf\sfshape{10}{\mainmagstep}
1665 \setfont\textsc\scshape{10}{\mainmagstep}
1666 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1667 \font\texti=cmmi10 scaled \mainmagstep
1668 \font\textsy=cmsy10 scaled \mainmagstep
1670 % A few fonts for @defun names and args.
1671 \setfont\defbf\bfshape{10}{\magstephalf}
1672 \setfont\deftt\ttshape{10}{\magstephalf}
1673 \setfont\defttsl\ttslshape{10}{\magstephalf}
1674 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1676 % Fonts for indices, footnotes, small examples (9pt).
1677 \def\smallnominalsize{9pt}
1678 \setfont\smallrm\rmshape{9}{1000}
1679 \setfont\smalltt\ttshape{9}{1000}
1680 \setfont\smallbf\bfshape{10}{900}
1681 \setfont\smallit\itshape{9}{1000}
1682 \setfont\smallsl\slshape{9}{1000}
1683 \setfont\smallsf\sfshape{9}{1000}
1684 \setfont\smallsc\scshape{10}{900}
1685 \setfont\smallttsl\ttslshape{10}{900}
1686 \font\smalli=cmmi9
1687 \font\smallsy=cmsy9
1689 % Fonts for small examples (8pt).
1690 \def\smallernominalsize{8pt}
1691 \setfont\smallerrm\rmshape{8}{1000}
1692 \setfont\smallertt\ttshape{8}{1000}
1693 \setfont\smallerbf\bfshape{10}{800}
1694 \setfont\smallerit\itshape{8}{1000}
1695 \setfont\smallersl\slshape{8}{1000}
1696 \setfont\smallersf\sfshape{8}{1000}
1697 \setfont\smallersc\scshape{10}{800}
1698 \setfont\smallerttsl\ttslshape{10}{800}
1699 \font\smalleri=cmmi8
1700 \font\smallersy=cmsy8
1702 % Fonts for title page (20.4pt):
1703 \def\titlenominalsize{20pt}
1704 \setfont\titlerm\rmbshape{12}{\magstep3}
1705 \setfont\titleit\itbshape{10}{\magstep4}
1706 \setfont\titlesl\slbshape{10}{\magstep4}
1707 \setfont\titlett\ttbshape{12}{\magstep3}
1708 \setfont\titlettsl\ttslshape{10}{\magstep4}
1709 \setfont\titlesf\sfbshape{17}{\magstep1}
1710 \let\titlebf=\titlerm
1711 \setfont\titlesc\scbshape{10}{\magstep4}
1712 \font\titlei=cmmi12 scaled \magstep3
1713 \font\titlesy=cmsy10 scaled \magstep4
1714 \def\authorrm{\secrm}
1715 \def\authortt{\sectt}
1717 % Chapter fonts (14.4pt).
1718 \def\chapnominalsize{14pt}
1719 \setfont\chaprm\rmbshape{12}{\magstep1}
1720 \setfont\chapit\itbshape{10}{\magstep2}
1721 \setfont\chapsl\slbshape{10}{\magstep2}
1722 \setfont\chaptt\ttbshape{12}{\magstep1}
1723 \setfont\chapttsl\ttslshape{10}{\magstep2}
1724 \setfont\chapsf\sfbshape{12}{\magstep1}
1725 \let\chapbf\chaprm
1726 \setfont\chapsc\scbshape{10}{\magstep2}
1727 \font\chapi=cmmi12 scaled \magstep1
1728 \font\chapsy=cmsy10 scaled \magstep2
1730 % Section fonts (12pt).
1731 \def\secnominalsize{12pt}
1732 \setfont\secrm\rmbshape{12}{1000}
1733 \setfont\secit\itbshape{10}{\magstep1}
1734 \setfont\secsl\slbshape{10}{\magstep1}
1735 \setfont\sectt\ttbshape{12}{1000}
1736 \setfont\secttsl\ttslshape{10}{\magstep1}
1737 \setfont\secsf\sfbshape{12}{1000}
1738 \let\secbf\secrm
1739 \setfont\secsc\scbshape{10}{\magstep1}
1740 \font\seci=cmmi12
1741 \font\secsy=cmsy10 scaled \magstep1
1743 % Subsection fonts (10pt).
1744 \def\ssecnominalsize{10pt}
1745 \setfont\ssecrm\rmbshape{10}{1000}
1746 \setfont\ssecit\itbshape{10}{1000}
1747 \setfont\ssecsl\slbshape{10}{1000}
1748 \setfont\ssectt\ttbshape{10}{1000}
1749 \setfont\ssecttsl\ttslshape{10}{1000}
1750 \setfont\ssecsf\sfbshape{10}{1000}
1751 \let\ssecbf\ssecrm
1752 \setfont\ssecsc\scbshape{10}{1000}
1753 \font\sseci=cmmi10
1754 \font\ssecsy=cmsy10
1756 % Reduced fonts for @acro in text (9pt).
1757 \def\reducednominalsize{9pt}
1758 \setfont\reducedrm\rmshape{9}{1000}
1759 \setfont\reducedtt\ttshape{9}{1000}
1760 \setfont\reducedbf\bfshape{10}{900}
1761 \setfont\reducedit\itshape{9}{1000}
1762 \setfont\reducedsl\slshape{9}{1000}
1763 \setfont\reducedsf\sfshape{9}{1000}
1764 \setfont\reducedsc\scshape{10}{900}
1765 \setfont\reducedttsl\ttslshape{10}{900}
1766 \font\reducedi=cmmi9
1767 \font\reducedsy=cmsy9
1769 % reduce space between paragraphs
1770 \divide\parskip by 2
1772 % reset the current fonts
1773 \textfonts
1775 } % end of 10pt text font size definitions
1778 % We provide the user-level command
1779 % @fonttextsize 10
1780 % (or 11) to redefine the text font size. pt is assumed.
1782 \def\xword{10}
1783 \def\xiword{11}
1785 \parseargdef\fonttextsize{%
1786 \def\textsizearg{#1}%
1787 \wlog{doing @fonttextsize \textsizearg}%
1789 % Set \globaldefs so that documents can use this inside @tex, since
1790 % makeinfo 4.8 does not support it, but we need it nonetheless.
1792 \begingroup \globaldefs=1
1793 \ifx\textsizearg\xword \definetextfontsizex
1794 \else \ifx\textsizearg\xiword \definetextfontsizexi
1795 \else
1796 \errhelp=\EMsimple
1797 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1798 \fi\fi
1799 \endgroup
1803 % In order for the font changes to affect most math symbols and letters,
1804 % we have to define the \textfont of the standard families. Since
1805 % texinfo doesn't allow for producing subscripts and superscripts except
1806 % in the main text, we don't bother to reset \scriptfont and
1807 % \scriptscriptfont (which would also require loading a lot more fonts).
1809 \def\resetmathfonts{%
1810 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1811 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1812 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1815 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1816 % of just \STYLE. We do this because \STYLE needs to also set the
1817 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1818 % \tenSTYLE to set the current font.
1820 % Each font-changing command also sets the names \lsize (one size lower)
1821 % and \lllsize (three sizes lower). These relative commands are used in
1822 % the LaTeX logo and acronyms.
1824 % This all needs generalizing, badly.
1826 \def\textfonts{%
1827 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1828 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1829 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1830 \let\tenttsl=\textttsl
1831 \def\curfontsize{text}%
1832 \def\lsize{reduced}\def\lllsize{smaller}%
1833 \resetmathfonts \setleading{\textleading}}
1834 \def\titlefonts{%
1835 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1836 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1837 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1838 \let\tenttsl=\titlettsl
1839 \def\curfontsize{title}%
1840 \def\lsize{chap}\def\lllsize{subsec}%
1841 \resetmathfonts \setleading{25pt}}
1842 \def\titlefont#1{{\titlefonts\rm #1}}
1843 \def\chapfonts{%
1844 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1845 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1846 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1847 \let\tenttsl=\chapttsl
1848 \def\curfontsize{chap}%
1849 \def\lsize{sec}\def\lllsize{text}%
1850 \resetmathfonts \setleading{19pt}}
1851 \def\secfonts{%
1852 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1853 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1854 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1855 \let\tenttsl=\secttsl
1856 \def\curfontsize{sec}%
1857 \def\lsize{subsec}\def\lllsize{reduced}%
1858 \resetmathfonts \setleading{16pt}}
1859 \def\subsecfonts{%
1860 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1861 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1862 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1863 \let\tenttsl=\ssecttsl
1864 \def\curfontsize{ssec}%
1865 \def\lsize{text}\def\lllsize{small}%
1866 \resetmathfonts \setleading{15pt}}
1867 \let\subsubsecfonts = \subsecfonts
1868 \def\reducedfonts{%
1869 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1870 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1871 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1872 \let\tenttsl=\reducedttsl
1873 \def\curfontsize{reduced}%
1874 \def\lsize{small}\def\lllsize{smaller}%
1875 \resetmathfonts \setleading{10.5pt}}
1876 \def\smallfonts{%
1877 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1878 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1879 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1880 \let\tenttsl=\smallttsl
1881 \def\curfontsize{small}%
1882 \def\lsize{smaller}\def\lllsize{smaller}%
1883 \resetmathfonts \setleading{10.5pt}}
1884 \def\smallerfonts{%
1885 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1886 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1887 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1888 \let\tenttsl=\smallerttsl
1889 \def\curfontsize{smaller}%
1890 \def\lsize{smaller}\def\lllsize{smaller}%
1891 \resetmathfonts \setleading{9.5pt}}
1893 % Set the fonts to use with the @small... environments.
1894 \let\smallexamplefonts = \smallfonts
1896 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1897 % can fit this many characters:
1898 % 8.5x11=86 smallbook=72 a4=90 a5=69
1899 % If we use \scriptfonts (8pt), then we can fit this many characters:
1900 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1901 % For me, subjectively, the few extra characters that fit aren't worth
1902 % the additional smallness of 8pt. So I'm making the default 9pt.
1904 % By the way, for comparison, here's what fits with @example (10pt):
1905 % 8.5x11=71 smallbook=60 a4=75 a5=58
1907 % I wish the USA used A4 paper.
1908 % --karl, 24jan03.
1911 % Set up the default fonts, so we can use them for creating boxes.
1913 \definetextfontsizexi
1915 % Define these so they can be easily changed for other fonts.
1916 \def\angleleft{$\langle$}
1917 \def\angleright{$\rangle$}
1919 % Count depth in font-changes, for error checks
1920 \newcount\fontdepth \fontdepth=0
1922 % Fonts for short table of contents.
1923 \setfont\shortcontrm\rmshape{12}{1000}
1924 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1925 \setfont\shortcontsl\slshape{12}{1000}
1926 \setfont\shortconttt\ttshape{12}{1000}
1928 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1929 %% serif) and @ii for TeX italic
1931 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1932 % unless the following character is such as not to need one.
1933 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1934 \ptexslash\fi\fi\fi}
1935 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1936 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1938 % like \smartslanted except unconditionally uses \ttsl.
1939 % @var is set to this for defun arguments.
1940 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1942 % like \smartslanted except unconditionally use \sl. We never want
1943 % ttsl for book titles, do we?
1944 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1946 \let\i=\smartitalic
1947 \let\slanted=\smartslanted
1948 \let\var=\smartslanted
1949 \let\dfn=\smartslanted
1950 \let\emph=\smartitalic
1952 % @b, explicit bold.
1953 \def\b#1{{\bf #1}}
1954 \let\strong=\b
1956 % @sansserif, explicit sans.
1957 \def\sansserif#1{{\sf #1}}
1959 % We can't just use \exhyphenpenalty, because that only has effect at
1960 % the end of a paragraph. Restore normal hyphenation at the end of the
1961 % group within which \nohyphenation is presumably called.
1963 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1964 \def\restorehyphenation{\hyphenchar\font = `- }
1966 % Set sfcode to normal for the chars that usually have another value.
1967 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1968 % sometimes \x has an active definition that messes things up.
1970 \chardef\colonChar = `\:
1971 \chardef\commaChar = `\,
1972 \chardef\dotChar = `\.
1973 \chardef\exclamChar= `\!
1974 \chardef\questChar = `\?
1975 \chardef\semiChar = `\;
1977 \catcode`@=11
1978 \def\plainfrenchspacing{%
1979 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1980 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1981 \def\endofsentencespacefactor{1000}% for @. and friends
1983 \def\plainnonfrenchspacing{%
1984 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1985 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
1986 \def\endofsentencespacefactor{3000}% for @. and friends
1988 \catcode`@=\other
1989 \def\endofsentencespacefactor{3000}% default
1991 \def\t#1{%
1992 {\tt \rawbackslash \plainfrenchspacing #1}%
1993 \null
1995 \def\samp#1{`\tclose{#1}'\null}
1996 \setfont\keyrm\rmshape{8}{1000}
1997 \font\keysy=cmsy9
1998 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1999 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2000 \vbox{\hrule\kern-0.4pt
2001 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2002 \kern-0.4pt\hrule}%
2003 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2004 % The old definition, with no lozenge:
2005 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2006 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2008 % @file, @option are the same as @samp.
2009 \let\file=\samp
2010 \let\option=\samp
2012 % @code is a modification of @t,
2013 % which makes spaces the same size as normal in the surrounding text.
2014 \def\tclose#1{%
2016 % Change normal interword space to be same as for the current font.
2017 \spaceskip = \fontdimen2\font
2019 % Switch to typewriter.
2022 % But `\ ' produces the large typewriter interword space.
2023 \def\ {{\spaceskip = 0pt{} }}%
2025 % Turn off hyphenation.
2026 \nohyphenation
2028 \rawbackslash
2029 \plainfrenchspacing
2032 \null
2035 % We *must* turn on hyphenation at `-' and `_' in @code.
2036 % Otherwise, it is too hard to avoid overfull hboxes
2037 % in the Emacs manual, the Library manual, etc.
2039 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2040 % both hyphenation at - and hyphenation within words.
2041 % We must therefore turn them both off (\tclose does that)
2042 % and arrange explicitly to hyphenate at a dash.
2043 % -- rms.
2045 \catcode`\-=\active
2046 \catcode`\_=\active
2048 \global\def\code{\begingroup
2049 \catcode`\-=\active \catcode`\_=\active
2050 \ifallowcodebreaks
2051 \let-\codedash
2052 \let_\codeunder
2053 \else
2054 \let-\realdash
2055 \let_\realunder
2057 \codex
2061 \def\realdash{-}
2062 \def\codedash{-\discretionary{}{}{}}
2063 \def\codeunder{%
2064 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2065 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2066 % will therefore expand the active definition of _, which is us
2067 % (inside @code that is), therefore an endless loop.
2068 \ifusingtt{\ifmmode
2069 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2070 \else\normalunderscore \fi
2071 \discretionary{}{}{}}%
2072 {\_}%
2074 \def\codex #1{\tclose{#1}\endgroup}
2076 % An additional complication: the above will allow breaks after, e.g.,
2077 % each of the four underscores in __typeof__. This is undesirable in
2078 % some manuals, especially if they don't have long identifiers in
2079 % general. @allowcodebreaks provides a way to control this.
2081 \newif\ifallowcodebreaks \allowcodebreakstrue
2083 \def\keywordtrue{true}
2084 \def\keywordfalse{false}
2086 \parseargdef\allowcodebreaks{%
2087 \def\txiarg{#1}%
2088 \ifx\txiarg\keywordtrue
2089 \allowcodebreakstrue
2090 \else\ifx\txiarg\keywordfalse
2091 \allowcodebreaksfalse
2092 \else
2093 \errhelp = \EMsimple
2094 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2095 \fi\fi
2098 % @kbd is like @code, except that if the argument is just one @key command,
2099 % then @kbd has no effect.
2101 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2102 % `example' (@kbd uses ttsl only inside of @example and friends),
2103 % or `code' (@kbd uses normal tty font always).
2104 \parseargdef\kbdinputstyle{%
2105 \def\txiarg{#1}%
2106 \ifx\txiarg\worddistinct
2107 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2108 \else\ifx\txiarg\wordexample
2109 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2110 \else\ifx\txiarg\wordcode
2111 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2112 \else
2113 \errhelp = \EMsimple
2114 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2115 \fi\fi\fi
2117 \def\worddistinct{distinct}
2118 \def\wordexample{example}
2119 \def\wordcode{code}
2121 % Default is `distinct.'
2122 \kbdinputstyle distinct
2124 \def\xkey{\key}
2125 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2126 \ifx\one\xkey\ifx\threex\three \key{#2}%
2127 \else{\tclose{\kbdfont\look}}\fi
2128 \else{\tclose{\kbdfont\look}}\fi}
2130 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2131 \let\indicateurl=\code
2132 \let\env=\code
2133 \let\command=\code
2135 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2136 % second argument specifying the text to display and an optional third
2137 % arg as text to display instead of (rather than in addition to) the url
2138 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2139 % a hypertex \special here.
2141 \def\uref#1{\douref #1,,,\finish}
2142 \def\douref#1,#2,#3,#4\finish{\begingroup
2143 \unsepspaces
2144 \pdfurl{#1}%
2145 \setbox0 = \hbox{\ignorespaces #3}%
2146 \ifdim\wd0 > 0pt
2147 \unhbox0 % third arg given, show only that
2148 \else
2149 \setbox0 = \hbox{\ignorespaces #2}%
2150 \ifdim\wd0 > 0pt
2151 \ifpdf
2152 \unhbox0 % PDF: 2nd arg given, show only it
2153 \else
2154 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2156 \else
2157 \code{#1}% only url given, so show it
2160 \endlink
2161 \endgroup}
2163 % @url synonym for @uref, since that's how everyone uses it.
2165 \let\url=\uref
2167 % rms does not like angle brackets --karl, 17may97.
2168 % So now @email is just like @uref, unless we are pdf.
2170 %\def\email#1{\angleleft{\tt #1}\angleright}
2171 \ifpdf
2172 \def\email#1{\doemail#1,,\finish}
2173 \def\doemail#1,#2,#3\finish{\begingroup
2174 \unsepspaces
2175 \pdfurl{mailto:#1}%
2176 \setbox0 = \hbox{\ignorespaces #2}%
2177 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2178 \endlink
2179 \endgroup}
2180 \else
2181 \let\email=\uref
2184 % Check if we are currently using a typewriter font. Since all the
2185 % Computer Modern typewriter fonts have zero interword stretch (and
2186 % shrink), and it is reasonable to expect all typewriter fonts to have
2187 % this property, we can check that font parameter.
2189 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2191 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2192 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2194 \def\dmn#1{\thinspace #1}
2196 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2198 % @l was never documented to mean ``switch to the Lisp font'',
2199 % and it is not used as such in any manual I can find. We need it for
2200 % Polish suppressed-l. --karl, 22sep96.
2201 %\def\l#1{{\li #1}\null}
2203 % Explicit font changes: @r, @sc, undocumented @ii.
2204 \def\r#1{{\rm #1}} % roman font
2205 \def\sc#1{{\smallcaps#1}} % smallcaps font
2206 \def\ii#1{{\it #1}} % italic font
2208 % @acronym for "FBI", "NATO", and the like.
2209 % We print this one point size smaller, since it's intended for
2210 % all-uppercase.
2212 \def\acronym#1{\doacronym #1,,\finish}
2213 \def\doacronym#1,#2,#3\finish{%
2214 {\selectfonts\lsize #1}%
2215 \def\temp{#2}%
2216 \ifx\temp\empty \else
2217 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2221 % @abbr for "Comput. J." and the like.
2222 % No font change, but don't do end-of-sentence spacing.
2224 \def\abbr#1{\doabbr #1,,\finish}
2225 \def\doabbr#1,#2,#3\finish{%
2226 {\plainfrenchspacing #1}%
2227 \def\temp{#2}%
2228 \ifx\temp\empty \else
2229 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2233 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2235 \def\pounds{{\it\$}}
2237 % @euro{} comes from a separate font, depending on the current style.
2238 % We use the free feym* fonts from the eurosym package by Henrik
2239 % Theiling, which support regular, slanted, bold and bold slanted (and
2240 % "outlined" (blackboard board, sort of) versions, which we don't need).
2241 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2243 % Although only regular is the truly official Euro symbol, we ignore
2244 % that. The Euro is designed to be slightly taller than the regular
2245 % font height.
2247 % feymr - regular
2248 % feymo - slanted
2249 % feybr - bold
2250 % feybo - bold slanted
2252 % There is no good (free) typewriter version, to my knowledge.
2253 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2254 % Hmm.
2256 % Also doesn't work in math. Do we need to do math with euro symbols?
2257 % Hope not.
2260 \def\euro{{\eurofont e}}
2261 \def\eurofont{%
2262 % We set the font at each command, rather than predefining it in
2263 % \textfonts and the other font-switching commands, so that
2264 % installations which never need the symbol don't have to have the
2265 % font installed.
2267 % There is only one designed size (nominal 10pt), so we always scale
2268 % that to the current nominal size.
2270 % By the way, simply using "at 1em" works for cmr10 and the like, but
2271 % does not work for cmbx10 and other extended/shrunken fonts.
2273 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2275 \ifx\curfontstyle\bfstylename
2276 % bold:
2277 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2278 \else
2279 % regular:
2280 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2282 \thiseurofont
2285 % @registeredsymbol - R in a circle. The font for the R should really
2286 % be smaller yet, but lllsize is the best we can do for now.
2287 % Adapted from the plain.tex definition of \copyright.
2289 \def\registeredsymbol{%
2290 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2291 \hfil\crcr\Orb}}%
2295 % Laurent Siebenmann reports \Orb undefined with:
2296 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2297 % so we'll define it if necessary.
2299 \ifx\Orb\undefined
2300 \def\Orb{\mathhexbox20D}
2304 \message{page headings,}
2306 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2307 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2309 % First the title page. Must do @settitle before @titlepage.
2310 \newif\ifseenauthor
2311 \newif\iffinishedtitlepage
2313 % Do an implicit @contents or @shortcontents after @end titlepage if the
2314 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2316 \newif\ifsetcontentsaftertitlepage
2317 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2318 \newif\ifsetshortcontentsaftertitlepage
2319 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2321 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2322 \endgroup\page\hbox{}\page}
2324 \envdef\titlepage{%
2325 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2326 \begingroup
2327 \parindent=0pt \textfonts
2328 % Leave some space at the very top of the page.
2329 \vglue\titlepagetopglue
2330 % No rule at page bottom unless we print one at the top with @title.
2331 \finishedtitlepagetrue
2333 % Most title ``pages'' are actually two pages long, with space
2334 % at the top of the second. We don't want the ragged left on the second.
2335 \let\oldpage = \page
2336 \def\page{%
2337 \iffinishedtitlepage\else
2338 \finishtitlepage
2340 \let\page = \oldpage
2341 \page
2342 \null
2346 \def\Etitlepage{%
2347 \iffinishedtitlepage\else
2348 \finishtitlepage
2350 % It is important to do the page break before ending the group,
2351 % because the headline and footline are only empty inside the group.
2352 % If we use the new definition of \page, we always get a blank page
2353 % after the title page, which we certainly don't want.
2354 \oldpage
2355 \endgroup
2357 % Need this before the \...aftertitlepage checks so that if they are
2358 % in effect the toc pages will come out with page numbers.
2359 \HEADINGSon
2361 % If they want short, they certainly want long too.
2362 \ifsetshortcontentsaftertitlepage
2363 \shortcontents
2364 \contents
2365 \global\let\shortcontents = \relax
2366 \global\let\contents = \relax
2369 \ifsetcontentsaftertitlepage
2370 \contents
2371 \global\let\contents = \relax
2372 \global\let\shortcontents = \relax
2376 \def\finishtitlepage{%
2377 \vskip4pt \hrule height 2pt width \hsize
2378 \vskip\titlepagebottomglue
2379 \finishedtitlepagetrue
2382 %%% Macros to be used within @titlepage:
2384 \let\subtitlerm=\tenrm
2385 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2387 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2388 \let\tt=\authortt}
2390 \parseargdef\title{%
2391 \checkenv\titlepage
2392 \leftline{\titlefonts\rm #1}
2393 % print a rule at the page bottom also.
2394 \finishedtitlepagefalse
2395 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2398 \parseargdef\subtitle{%
2399 \checkenv\titlepage
2400 {\subtitlefont \rightline{#1}}%
2403 % @author should come last, but may come many times.
2404 % It can also be used inside @quotation.
2406 \parseargdef\author{%
2407 \def\temp{\quotation}%
2408 \ifx\thisenv\temp
2409 \def\quotationauthor{#1}% printed in \Equotation.
2410 \else
2411 \checkenv\titlepage
2412 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2413 {\authorfont \leftline{#1}}%
2418 %%% Set up page headings and footings.
2420 \let\thispage=\folio
2422 \newtoks\evenheadline % headline on even pages
2423 \newtoks\oddheadline % headline on odd pages
2424 \newtoks\evenfootline % footline on even pages
2425 \newtoks\oddfootline % footline on odd pages
2427 % Now make TeX use those variables
2428 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2429 \else \the\evenheadline \fi}}
2430 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2431 \else \the\evenfootline \fi}\HEADINGShook}
2432 \let\HEADINGShook=\relax
2434 % Commands to set those variables.
2435 % For example, this is what @headings on does
2436 % @evenheading @thistitle|@thispage|@thischapter
2437 % @oddheading @thischapter|@thispage|@thistitle
2438 % @evenfooting @thisfile||
2439 % @oddfooting ||@thisfile
2442 \def\evenheading{\parsearg\evenheadingxxx}
2443 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2444 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2445 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2447 \def\oddheading{\parsearg\oddheadingxxx}
2448 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2449 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2450 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2452 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2454 \def\evenfooting{\parsearg\evenfootingxxx}
2455 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2456 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2457 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2459 \def\oddfooting{\parsearg\oddfootingxxx}
2460 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2461 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2462 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2464 % Leave some space for the footline. Hopefully ok to assume
2465 % @evenfooting will not be used by itself.
2466 \global\advance\pageheight by -\baselineskip
2467 \global\advance\vsize by -\baselineskip
2470 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2473 % @headings double turns headings on for double-sided printing.
2474 % @headings single turns headings on for single-sided printing.
2475 % @headings off turns them off.
2476 % @headings on same as @headings double, retained for compatibility.
2477 % @headings after turns on double-sided headings after this page.
2478 % @headings doubleafter turns on double-sided headings after this page.
2479 % @headings singleafter turns on single-sided headings after this page.
2480 % By default, they are off at the start of a document,
2481 % and turned `on' after @end titlepage.
2483 \def\headings #1 {\csname HEADINGS#1\endcsname}
2485 \def\HEADINGSoff{%
2486 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2487 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2488 \HEADINGSoff
2489 % When we turn headings on, set the page number to 1.
2490 % For double-sided printing, put current file name in lower left corner,
2491 % chapter name on inside top of right hand pages, document
2492 % title on inside top of left hand pages, and page numbers on outside top
2493 % edge of all pages.
2494 \def\HEADINGSdouble{%
2495 \global\pageno=1
2496 \global\evenfootline={\hfil}
2497 \global\oddfootline={\hfil}
2498 \global\evenheadline={\line{\folio\hfil\thistitle}}
2499 \global\oddheadline={\line{\thischapter\hfil\folio}}
2500 \global\let\contentsalignmacro = \chapoddpage
2502 \let\contentsalignmacro = \chappager
2504 % For single-sided printing, chapter title goes across top left of page,
2505 % page number on top right.
2506 \def\HEADINGSsingle{%
2507 \global\pageno=1
2508 \global\evenfootline={\hfil}
2509 \global\oddfootline={\hfil}
2510 \global\evenheadline={\line{\thischapter\hfil\folio}}
2511 \global\oddheadline={\line{\thischapter\hfil\folio}}
2512 \global\let\contentsalignmacro = \chappager
2514 \def\HEADINGSon{\HEADINGSdouble}
2516 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2517 \let\HEADINGSdoubleafter=\HEADINGSafter
2518 \def\HEADINGSdoublex{%
2519 \global\evenfootline={\hfil}
2520 \global\oddfootline={\hfil}
2521 \global\evenheadline={\line{\folio\hfil\thistitle}}
2522 \global\oddheadline={\line{\thischapter\hfil\folio}}
2523 \global\let\contentsalignmacro = \chapoddpage
2526 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2527 \def\HEADINGSsinglex{%
2528 \global\evenfootline={\hfil}
2529 \global\oddfootline={\hfil}
2530 \global\evenheadline={\line{\thischapter\hfil\folio}}
2531 \global\oddheadline={\line{\thischapter\hfil\folio}}
2532 \global\let\contentsalignmacro = \chappager
2535 % Subroutines used in generating headings
2536 % This produces Day Month Year style of output.
2537 % Only define if not already defined, in case a txi-??.tex file has set
2538 % up a different format (e.g., txi-cs.tex does this).
2539 \ifx\today\undefined
2540 \def\today{%
2541 \number\day\space
2542 \ifcase\month
2543 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2544 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2545 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2547 \space\number\year}
2550 % @settitle line... specifies the title of the document, for headings.
2551 % It generates no output of its own.
2552 \def\thistitle{\putwordNoTitle}
2553 \def\settitle{\parsearg{\gdef\thistitle}}
2556 \message{tables,}
2557 % Tables -- @table, @ftable, @vtable, @item(x).
2559 % default indentation of table text
2560 \newdimen\tableindent \tableindent=.8in
2561 % default indentation of @itemize and @enumerate text
2562 \newdimen\itemindent \itemindent=.3in
2563 % margin between end of table item and start of table text.
2564 \newdimen\itemmargin \itemmargin=.1in
2566 % used internally for \itemindent minus \itemmargin
2567 \newdimen\itemmax
2569 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2570 % these defs.
2571 % They also define \itemindex
2572 % to index the item name in whatever manner is desired (perhaps none).
2574 \newif\ifitemxneedsnegativevskip
2576 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2578 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2579 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2581 \def\itemzzz #1{\begingroup %
2582 \advance\hsize by -\rightskip
2583 \advance\hsize by -\tableindent
2584 \setbox0=\hbox{\itemindicate{#1}}%
2585 \itemindex{#1}%
2586 \nobreak % This prevents a break before @itemx.
2588 % If the item text does not fit in the space we have, put it on a line
2589 % by itself, and do not allow a page break either before or after that
2590 % line. We do not start a paragraph here because then if the next
2591 % command is, e.g., @kindex, the whatsit would get put into the
2592 % horizontal list on a line by itself, resulting in extra blank space.
2593 \ifdim \wd0>\itemmax
2595 % Make this a paragraph so we get the \parskip glue and wrapping,
2596 % but leave it ragged-right.
2597 \begingroup
2598 \advance\leftskip by-\tableindent
2599 \advance\hsize by\tableindent
2600 \advance\rightskip by0pt plus1fil
2601 \leavevmode\unhbox0\par
2602 \endgroup
2604 % We're going to be starting a paragraph, but we don't want the
2605 % \parskip glue -- logically it's part of the @item we just started.
2606 \nobreak \vskip-\parskip
2608 % Stop a page break at the \parskip glue coming up. However, if
2609 % what follows is an environment such as @example, there will be no
2610 % \parskip glue; then the negative vskip we just inserted would
2611 % cause the example and the item to crash together. So we use this
2612 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2613 % \parskip glue after all. Section titles are handled this way also.
2615 \penalty 10001
2616 \endgroup
2617 \itemxneedsnegativevskipfalse
2618 \else
2619 % The item text fits into the space. Start a paragraph, so that the
2620 % following text (if any) will end up on the same line.
2621 \noindent
2622 % Do this with kerns and \unhbox so that if there is a footnote in
2623 % the item text, it can migrate to the main vertical list and
2624 % eventually be printed.
2625 \nobreak\kern-\tableindent
2626 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2627 \unhbox0
2628 \nobreak\kern\dimen0
2629 \endgroup
2630 \itemxneedsnegativevskiptrue
2634 \def\item{\errmessage{@item while not in a list environment}}
2635 \def\itemx{\errmessage{@itemx while not in a list environment}}
2637 % @table, @ftable, @vtable.
2638 \envdef\table{%
2639 \let\itemindex\gobble
2640 \tablecheck{table}%
2642 \envdef\ftable{%
2643 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2644 \tablecheck{ftable}%
2646 \envdef\vtable{%
2647 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2648 \tablecheck{vtable}%
2650 \def\tablecheck#1{%
2651 \ifnum \the\catcode`\^^M=\active
2652 \endgroup
2653 \errmessage{This command won't work in this context; perhaps the problem is
2654 that we are \inenvironment\thisenv}%
2655 \def\next{\doignore{#1}}%
2656 \else
2657 \let\next\tablex
2659 \next
2661 \def\tablex#1{%
2662 \def\itemindicate{#1}%
2663 \parsearg\tabley
2665 \def\tabley#1{%
2667 \makevalueexpandable
2668 \edef\temp{\noexpand\tablez #1\space\space\space}%
2669 \expandafter
2670 }\temp \endtablez
2672 \def\tablez #1 #2 #3 #4\endtablez{%
2673 \aboveenvbreak
2674 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2675 \ifnum 0#2>0 \tableindent=#2\mil \fi
2676 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2677 \itemmax=\tableindent
2678 \advance \itemmax by -\itemmargin
2679 \advance \leftskip by \tableindent
2680 \exdentamount=\tableindent
2681 \parindent = 0pt
2682 \parskip = \smallskipamount
2683 \ifdim \parskip=0pt \parskip=2pt \fi
2684 \let\item = \internalBitem
2685 \let\itemx = \internalBitemx
2687 \def\Etable{\endgraf\afterenvbreak}
2688 \let\Eftable\Etable
2689 \let\Evtable\Etable
2690 \let\Eitemize\Etable
2691 \let\Eenumerate\Etable
2693 % This is the counter used by @enumerate, which is really @itemize
2695 \newcount \itemno
2697 \envdef\itemize{\parsearg\doitemize}
2699 \def\doitemize#1{%
2700 \aboveenvbreak
2701 \itemmax=\itemindent
2702 \advance\itemmax by -\itemmargin
2703 \advance\leftskip by \itemindent
2704 \exdentamount=\itemindent
2705 \parindent=0pt
2706 \parskip=\smallskipamount
2707 \ifdim\parskip=0pt \parskip=2pt \fi
2708 \def\itemcontents{#1}%
2709 % @itemize with no arg is equivalent to @itemize @bullet.
2710 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2711 \let\item=\itemizeitem
2714 % Definition of @item while inside @itemize and @enumerate.
2716 \def\itemizeitem{%
2717 \advance\itemno by 1 % for enumerations
2718 {\let\par=\endgraf \smallbreak}% reasonable place to break
2720 % If the document has an @itemize directly after a section title, a
2721 % \nobreak will be last on the list, and \sectionheading will have
2722 % done a \vskip-\parskip. In that case, we don't want to zero
2723 % parskip, or the item text will crash with the heading. On the
2724 % other hand, when there is normal text preceding the item (as there
2725 % usually is), we do want to zero parskip, or there would be too much
2726 % space. In that case, we won't have a \nobreak before. At least
2727 % that's the theory.
2728 \ifnum\lastpenalty<10000 \parskip=0in \fi
2729 \noindent
2730 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2731 \vadjust{\penalty 1200}}% not good to break after first line of item.
2732 \flushcr
2735 % \splitoff TOKENS\endmark defines \first to be the first token in
2736 % TOKENS, and \rest to be the remainder.
2738 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2740 % Allow an optional argument of an uppercase letter, lowercase letter,
2741 % or number, to specify the first label in the enumerated list. No
2742 % argument is the same as `1'.
2744 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2745 \def\enumeratey #1 #2\endenumeratey{%
2746 % If we were given no argument, pretend we were given `1'.
2747 \def\thearg{#1}%
2748 \ifx\thearg\empty \def\thearg{1}\fi
2750 % Detect if the argument is a single token. If so, it might be a
2751 % letter. Otherwise, the only valid thing it can be is a number.
2752 % (We will always have one token, because of the test we just made.
2753 % This is a good thing, since \splitoff doesn't work given nothing at
2754 % all -- the first parameter is undelimited.)
2755 \expandafter\splitoff\thearg\endmark
2756 \ifx\rest\empty
2757 % Only one token in the argument. It could still be anything.
2758 % A ``lowercase letter'' is one whose \lccode is nonzero.
2759 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2760 % not equal to itself.
2761 % Otherwise, we assume it's a number.
2763 % We need the \relax at the end of the \ifnum lines to stop TeX from
2764 % continuing to look for a <number>.
2766 \ifnum\lccode\expandafter`\thearg=0\relax
2767 \numericenumerate % a number (we hope)
2768 \else
2769 % It's a letter.
2770 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2771 \lowercaseenumerate % lowercase letter
2772 \else
2773 \uppercaseenumerate % uppercase letter
2776 \else
2777 % Multiple tokens in the argument. We hope it's a number.
2778 \numericenumerate
2782 % An @enumerate whose labels are integers. The starting integer is
2783 % given in \thearg.
2785 \def\numericenumerate{%
2786 \itemno = \thearg
2787 \startenumeration{\the\itemno}%
2790 % The starting (lowercase) letter is in \thearg.
2791 \def\lowercaseenumerate{%
2792 \itemno = \expandafter`\thearg
2793 \startenumeration{%
2794 % Be sure we're not beyond the end of the alphabet.
2795 \ifnum\itemno=0
2796 \errmessage{No more lowercase letters in @enumerate; get a bigger
2797 alphabet}%
2799 \char\lccode\itemno
2803 % The starting (uppercase) letter is in \thearg.
2804 \def\uppercaseenumerate{%
2805 \itemno = \expandafter`\thearg
2806 \startenumeration{%
2807 % Be sure we're not beyond the end of the alphabet.
2808 \ifnum\itemno=0
2809 \errmessage{No more uppercase letters in @enumerate; get a bigger
2810 alphabet}
2812 \char\uccode\itemno
2816 % Call \doitemize, adding a period to the first argument and supplying the
2817 % common last two arguments. Also subtract one from the initial value in
2818 % \itemno, since @item increments \itemno.
2820 \def\startenumeration#1{%
2821 \advance\itemno by -1
2822 \doitemize{#1.}\flushcr
2825 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2826 % to @enumerate.
2828 \def\alphaenumerate{\enumerate{a}}
2829 \def\capsenumerate{\enumerate{A}}
2830 \def\Ealphaenumerate{\Eenumerate}
2831 \def\Ecapsenumerate{\Eenumerate}
2834 % @multitable macros
2835 % Amy Hendrickson, 8/18/94, 3/6/96
2837 % @multitable ... @end multitable will make as many columns as desired.
2838 % Contents of each column will wrap at width given in preamble. Width
2839 % can be specified either with sample text given in a template line,
2840 % or in percent of \hsize, the current width of text on page.
2842 % Table can continue over pages but will only break between lines.
2844 % To make preamble:
2846 % Either define widths of columns in terms of percent of \hsize:
2847 % @multitable @columnfractions .25 .3 .45
2848 % @item ...
2850 % Numbers following @columnfractions are the percent of the total
2851 % current hsize to be used for each column. You may use as many
2852 % columns as desired.
2855 % Or use a template:
2856 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2857 % @item ...
2858 % using the widest term desired in each column.
2860 % Each new table line starts with @item, each subsequent new column
2861 % starts with @tab. Empty columns may be produced by supplying @tab's
2862 % with nothing between them for as many times as empty columns are needed,
2863 % ie, @tab@tab@tab will produce two empty columns.
2865 % @item, @tab do not need to be on their own lines, but it will not hurt
2866 % if they are.
2868 % Sample multitable:
2870 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2871 % @item first col stuff @tab second col stuff @tab third col
2872 % @item
2873 % first col stuff
2874 % @tab
2875 % second col stuff
2876 % @tab
2877 % third col
2878 % @item first col stuff @tab second col stuff
2879 % @tab Many paragraphs of text may be used in any column.
2881 % They will wrap at the width determined by the template.
2882 % @item@tab@tab This will be in third column.
2883 % @end multitable
2885 % Default dimensions may be reset by user.
2886 % @multitableparskip is vertical space between paragraphs in table.
2887 % @multitableparindent is paragraph indent in table.
2888 % @multitablecolmargin is horizontal space to be left between columns.
2889 % @multitablelinespace is space to leave between table items, baseline
2890 % to baseline.
2891 % 0pt means it depends on current normal line spacing.
2893 \newskip\multitableparskip
2894 \newskip\multitableparindent
2895 \newdimen\multitablecolspace
2896 \newskip\multitablelinespace
2897 \multitableparskip=0pt
2898 \multitableparindent=6pt
2899 \multitablecolspace=12pt
2900 \multitablelinespace=0pt
2902 % Macros used to set up halign preamble:
2904 \let\endsetuptable\relax
2905 \def\xendsetuptable{\endsetuptable}
2906 \let\columnfractions\relax
2907 \def\xcolumnfractions{\columnfractions}
2908 \newif\ifsetpercent
2910 % #1 is the @columnfraction, usually a decimal number like .5, but might
2911 % be just 1. We just use it, whatever it is.
2913 \def\pickupwholefraction#1 {%
2914 \global\advance\colcount by 1
2915 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2916 \setuptable
2919 \newcount\colcount
2920 \def\setuptable#1{%
2921 \def\firstarg{#1}%
2922 \ifx\firstarg\xendsetuptable
2923 \let\go = \relax
2924 \else
2925 \ifx\firstarg\xcolumnfractions
2926 \global\setpercenttrue
2927 \else
2928 \ifsetpercent
2929 \let\go\pickupwholefraction
2930 \else
2931 \global\advance\colcount by 1
2932 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2933 % separator; typically that is always in the input, anyway.
2934 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2937 \ifx\go\pickupwholefraction
2938 % Put the argument back for the \pickupwholefraction call, so
2939 % we'll always have a period there to be parsed.
2940 \def\go{\pickupwholefraction#1}%
2941 \else
2942 \let\go = \setuptable
2943 \fi%
2948 % multitable-only commands.
2950 % @headitem starts a heading row, which we typeset in bold.
2951 % Assignments have to be global since we are inside the implicit group
2952 % of an alignment entry. Note that \everycr resets \everytab.
2953 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2955 % A \tab used to include \hskip1sp. But then the space in a template
2956 % line is not enough. That is bad. So let's go back to just `&' until
2957 % we encounter the problem it was intended to solve again.
2958 % --karl, nathan@acm.org, 20apr99.
2959 \def\tab{\checkenv\multitable &\the\everytab}%
2961 % @multitable ... @end multitable definitions:
2963 \newtoks\everytab % insert after every tab.
2965 \envdef\multitable{%
2966 \vskip\parskip
2967 \startsavinginserts
2969 % @item within a multitable starts a normal row.
2970 % We use \def instead of \let so that if one of the multitable entries
2971 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2972 % \endtemplate) expanding \doitemize.
2973 \def\item{\crcr}%
2975 \tolerance=9500
2976 \hbadness=9500
2977 \setmultitablespacing
2978 \parskip=\multitableparskip
2979 \parindent=\multitableparindent
2980 \overfullrule=0pt
2981 \global\colcount=0
2983 \everycr = {%
2984 \noalign{%
2985 \global\everytab={}%
2986 \global\colcount=0 % Reset the column counter.
2987 % Check for saved footnotes, etc.
2988 \checkinserts
2989 % Keeps underfull box messages off when table breaks over pages.
2990 %\filbreak
2991 % Maybe so, but it also creates really weird page breaks when the
2992 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2993 % problem manifests itself, so it can be fixed for real --karl.
2997 \parsearg\domultitable
2999 \def\domultitable#1{%
3000 % To parse everything between @multitable and @item:
3001 \setuptable#1 \endsetuptable
3003 % This preamble sets up a generic column definition, which will
3004 % be used as many times as user calls for columns.
3005 % \vtop will set a single line and will also let text wrap and
3006 % continue for many paragraphs if desired.
3007 \halign\bgroup &%
3008 \global\advance\colcount by 1
3009 \multistrut
3010 \vtop{%
3011 % Use the current \colcount to find the correct column width:
3012 \hsize=\expandafter\csname col\the\colcount\endcsname
3014 % In order to keep entries from bumping into each other
3015 % we will add a \leftskip of \multitablecolspace to all columns after
3016 % the first one.
3018 % If a template has been used, we will add \multitablecolspace
3019 % to the width of each template entry.
3021 % If the user has set preamble in terms of percent of \hsize we will
3022 % use that dimension as the width of the column, and the \leftskip
3023 % will keep entries from bumping into each other. Table will start at
3024 % left margin and final column will justify at right margin.
3026 % Make sure we don't inherit \rightskip from the outer environment.
3027 \rightskip=0pt
3028 \ifnum\colcount=1
3029 % The first column will be indented with the surrounding text.
3030 \advance\hsize by\leftskip
3031 \else
3032 \ifsetpercent \else
3033 % If user has not set preamble in terms of percent of \hsize
3034 % we will advance \hsize by \multitablecolspace.
3035 \advance\hsize by \multitablecolspace
3037 % In either case we will make \leftskip=\multitablecolspace:
3038 \leftskip=\multitablecolspace
3040 % Ignoring space at the beginning and end avoids an occasional spurious
3041 % blank line, when TeX decides to break the line at the space before the
3042 % box from the multistrut, so the strut ends up on a line by itself.
3043 % For example:
3044 % @multitable @columnfractions .11 .89
3045 % @item @code{#}
3046 % @tab Legal holiday which is valid in major parts of the whole country.
3047 % Is automatically provided with highlighting sequences respectively
3048 % marking characters.
3049 \noindent\ignorespaces##\unskip\multistrut
3050 }\cr
3052 \def\Emultitable{%
3053 \crcr
3054 \egroup % end the \halign
3055 \global\setpercentfalse
3058 \def\setmultitablespacing{%
3059 \def\multistrut{\strut}% just use the standard line spacing
3061 % Compute \multitablelinespace (if not defined by user) for use in
3062 % \multitableparskip calculation. We used define \multistrut based on
3063 % this, but (ironically) that caused the spacing to be off.
3064 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3065 \ifdim\multitablelinespace=0pt
3066 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3067 \global\advance\multitablelinespace by-\ht0
3069 %% Test to see if parskip is larger than space between lines of
3070 %% table. If not, do nothing.
3071 %% If so, set to same dimension as multitablelinespace.
3072 \ifdim\multitableparskip>\multitablelinespace
3073 \global\multitableparskip=\multitablelinespace
3074 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3075 %% than skip between lines in the table.
3076 \fi%
3077 \ifdim\multitableparskip=0pt
3078 \global\multitableparskip=\multitablelinespace
3079 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3080 %% than skip between lines in the table.
3081 \fi}
3084 \message{conditionals,}
3086 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3087 % @ifnotxml always succeed. They currently do nothing; we don't
3088 % attempt to check whether the conditionals are properly nested. But we
3089 % have to remember that they are conditionals, so that @end doesn't
3090 % attempt to close an environment group.
3092 \def\makecond#1{%
3093 \expandafter\let\csname #1\endcsname = \relax
3094 \expandafter\let\csname iscond.#1\endcsname = 1
3096 \makecond{iftex}
3097 \makecond{ifnotdocbook}
3098 \makecond{ifnothtml}
3099 \makecond{ifnotinfo}
3100 \makecond{ifnotplaintext}
3101 \makecond{ifnotxml}
3103 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3105 \def\direntry{\doignore{direntry}}
3106 \def\documentdescription{\doignore{documentdescription}}
3107 \def\docbook{\doignore{docbook}}
3108 \def\html{\doignore{html}}
3109 \def\ifdocbook{\doignore{ifdocbook}}
3110 \def\ifhtml{\doignore{ifhtml}}
3111 \def\ifinfo{\doignore{ifinfo}}
3112 \def\ifnottex{\doignore{ifnottex}}
3113 \def\ifplaintext{\doignore{ifplaintext}}
3114 \def\ifxml{\doignore{ifxml}}
3115 \def\ignore{\doignore{ignore}}
3116 \def\menu{\doignore{menu}}
3117 \def\xml{\doignore{xml}}
3119 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3121 % A count to remember the depth of nesting.
3122 \newcount\doignorecount
3124 \def\doignore#1{\begingroup
3125 % Scan in ``verbatim'' mode:
3126 \obeylines
3127 \catcode`\@ = \other
3128 \catcode`\{ = \other
3129 \catcode`\} = \other
3131 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3132 \spaceisspace
3134 % Count number of #1's that we've seen.
3135 \doignorecount = 0
3137 % Swallow text until we reach the matching `@end #1'.
3138 \dodoignore{#1}%
3141 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3142 \obeylines %
3144 \gdef\dodoignore#1{%
3145 % #1 contains the command name as a string, e.g., `ifinfo'.
3147 % Define a command to find the next `@end #1'.
3148 \long\def\doignoretext##1^^M@end #1{%
3149 \doignoretextyyy##1^^M@#1\_STOP_}%
3151 % And this command to find another #1 command, at the beginning of a
3152 % line. (Otherwise, we would consider a line `@c @ifset', for
3153 % example, to count as an @ifset for nesting.)
3154 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3156 % And now expand that command.
3157 \doignoretext ^^M%
3161 \def\doignoreyyy#1{%
3162 \def\temp{#1}%
3163 \ifx\temp\empty % Nothing found.
3164 \let\next\doignoretextzzz
3165 \else % Found a nested condition, ...
3166 \advance\doignorecount by 1
3167 \let\next\doignoretextyyy % ..., look for another.
3168 % If we're here, #1 ends with ^^M\ifinfo (for example).
3170 \next #1% the token \_STOP_ is present just after this macro.
3173 % We have to swallow the remaining "\_STOP_".
3175 \def\doignoretextzzz#1{%
3176 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3177 \let\next\enddoignore
3178 \else % Still inside a nested condition.
3179 \advance\doignorecount by -1
3180 \let\next\doignoretext % Look for the next @end.
3182 \next
3185 % Finish off ignored text.
3186 { \obeylines%
3187 % Ignore anything after the last `@end #1'; this matters in verbatim
3188 % environments, where otherwise the newline after an ignored conditional
3189 % would result in a blank line in the output.
3190 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3194 % @set VAR sets the variable VAR to an empty value.
3195 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3197 % Since we want to separate VAR from REST-OF-LINE (which might be
3198 % empty), we can't just use \parsearg; we have to insert a space of our
3199 % own to delimit the rest of the line, and then take it out again if we
3200 % didn't need it.
3201 % We rely on the fact that \parsearg sets \catcode`\ =10.
3203 \parseargdef\set{\setyyy#1 \endsetyyy}
3204 \def\setyyy#1 #2\endsetyyy{%
3206 \makevalueexpandable
3207 \def\temp{#2}%
3208 \edef\next{\gdef\makecsname{SET#1}}%
3209 \ifx\temp\empty
3210 \next{}%
3211 \else
3212 \setzzz#2\endsetzzz
3216 % Remove the trailing space \setxxx inserted.
3217 \def\setzzz#1 \endsetzzz{\next{#1}}
3219 % @clear VAR clears (i.e., unsets) the variable VAR.
3221 \parseargdef\clear{%
3223 \makevalueexpandable
3224 \global\expandafter\let\csname SET#1\endcsname=\relax
3228 % @value{foo} gets the text saved in variable foo.
3229 \def\value{\begingroup\makevalueexpandable\valuexxx}
3230 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3232 \catcode`\- = \active \catcode`\_ = \active
3234 \gdef\makevalueexpandable{%
3235 \let\value = \expandablevalue
3236 % We don't want these characters active, ...
3237 \catcode`\-=\other \catcode`\_=\other
3238 % ..., but we might end up with active ones in the argument if
3239 % we're called from @code, as @code{@value{foo-bar_}}, though.
3240 % So \let them to their normal equivalents.
3241 \let-\realdash \let_\normalunderscore
3245 % We have this subroutine so that we can handle at least some @value's
3246 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3247 % The command has to be fully expandable (if the variable is set), since
3248 % the result winds up in the index file. This means that if the
3249 % variable's value contains other Texinfo commands, it's almost certain
3250 % it will fail (although perhaps we could fix that with sufficient work
3251 % to do a one-level expansion on the result, instead of complete).
3253 \def\expandablevalue#1{%
3254 \expandafter\ifx\csname SET#1\endcsname\relax
3255 {[No value for ``#1'']}%
3256 \message{Variable `#1', used in @value, is not set.}%
3257 \else
3258 \csname SET#1\endcsname
3262 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3263 % with @set.
3265 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3267 \makecond{ifset}
3268 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3269 \def\doifset#1#2{%
3271 \makevalueexpandable
3272 \let\next=\empty
3273 \expandafter\ifx\csname SET#2\endcsname\relax
3274 #1% If not set, redefine \next.
3276 \expandafter
3277 }\next
3279 \def\ifsetfail{\doignore{ifset}}
3281 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3282 % defined with @set, or has been undefined with @clear.
3284 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3285 % above code: if the variable is not set, do nothing, if it is set,
3286 % then redefine \next to \ifclearfail.
3288 \makecond{ifclear}
3289 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3290 \def\ifclearfail{\doignore{ifclear}}
3292 % @dircategory CATEGORY -- specify a category of the dir file
3293 % which this file should belong to. Ignore this in TeX.
3294 \let\dircategory=\comment
3296 % @defininfoenclose.
3297 \let\definfoenclose=\comment
3300 \message{indexing,}
3301 % Index generation facilities
3303 % Define \newwrite to be identical to plain tex's \newwrite
3304 % except not \outer, so it can be used within macros and \if's.
3305 \edef\newwrite{\makecsname{ptexnewwrite}}
3307 % \newindex {foo} defines an index named foo.
3308 % It automatically defines \fooindex such that
3309 % \fooindex ...rest of line... puts an entry in the index foo.
3310 % It also defines \fooindfile to be the number of the output channel for
3311 % the file that accumulates this index. The file's extension is foo.
3312 % The name of an index should be no more than 2 characters long
3313 % for the sake of vms.
3315 \def\newindex#1{%
3316 \iflinks
3317 \expandafter\newwrite \csname#1indfile\endcsname
3318 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3320 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3321 \noexpand\doindex{#1}}
3324 % @defindex foo == \newindex{foo}
3326 \def\defindex{\parsearg\newindex}
3328 % Define @defcodeindex, like @defindex except put all entries in @code.
3330 \def\defcodeindex{\parsearg\newcodeindex}
3332 \def\newcodeindex#1{%
3333 \iflinks
3334 \expandafter\newwrite \csname#1indfile\endcsname
3335 \openout \csname#1indfile\endcsname \jobname.#1
3337 \expandafter\xdef\csname#1index\endcsname{%
3338 \noexpand\docodeindex{#1}}%
3342 % @synindex foo bar makes index foo feed into index bar.
3343 % Do this instead of @defindex foo if you don't want it as a separate index.
3345 % @syncodeindex foo bar similar, but put all entries made for index foo
3346 % inside @code.
3348 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3349 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3351 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3352 % #3 the target index (bar).
3353 \def\dosynindex#1#2#3{%
3354 % Only do \closeout if we haven't already done it, else we'll end up
3355 % closing the target index.
3356 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3357 % The \closeout helps reduce unnecessary open files; the limit on the
3358 % Acorn RISC OS is a mere 16 files.
3359 \expandafter\closeout\csname#2indfile\endcsname
3360 \expandafter\let\csname\donesynindex#2\endcsname = 1
3362 % redefine \fooindfile:
3363 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3364 \expandafter\let\csname#2indfile\endcsname=\temp
3365 % redefine \fooindex:
3366 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3369 % Define \doindex, the driver for all \fooindex macros.
3370 % Argument #1 is generated by the calling \fooindex macro,
3371 % and it is "foo", the name of the index.
3373 % \doindex just uses \parsearg; it calls \doind for the actual work.
3374 % This is because \doind is more useful to call from other macros.
3376 % There is also \dosubind {index}{topic}{subtopic}
3377 % which makes an entry in a two-level index such as the operation index.
3379 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3380 \def\singleindexer #1{\doind{\indexname}{#1}}
3382 % like the previous two, but they put @code around the argument.
3383 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3384 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3386 % Take care of Texinfo commands that can appear in an index entry.
3387 % Since there are some commands we want to expand, and others we don't,
3388 % we have to laboriously prevent expansion for those that we don't.
3390 \def\indexdummies{%
3391 \escapechar = `\\ % use backslash in output files.
3392 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3393 \def\ {\realbackslash\space }%
3394 % Need these in case \tex is in effect and \{ is a \delimiter again.
3395 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3396 % braces and backslashes are used only as delimiters.
3397 \let\{ = \mylbrace
3398 \let\} = \myrbrace
3400 % Do the redefinitions.
3401 \commondummies
3404 % For the aux and toc files, @ is the escape character. So we want to
3405 % redefine everything using @ as the escape character (instead of
3406 % \realbackslash, still used for index files). When everything uses @,
3407 % this will be simpler.
3409 \def\atdummies{%
3410 \def\@{@@}%
3411 \def\ {@ }%
3412 \let\{ = \lbraceatcmd
3413 \let\} = \rbraceatcmd
3415 % Do the redefinitions.
3416 \commondummies
3417 \otherbackslash
3420 % Called from \indexdummies and \atdummies.
3422 \def\commondummies{%
3424 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3425 % preventing its expansion. This is used only for control% words,
3426 % not control letters, because the \space would be incorrect for
3427 % control characters, but is needed to separate the control word
3428 % from whatever follows.
3430 % For control letters, we have \definedummyletter, which omits the
3431 % space.
3433 % These can be used both for control words that take an argument and
3434 % those that do not. If it is followed by {arg} in the input, then
3435 % that will dutifully get written to the index (or wherever).
3437 \def\definedummyword ##1{\def##1{\string##1\space}}%
3438 \def\definedummyletter##1{\def##1{\string##1}}%
3439 \let\definedummyaccent\definedummyletter
3441 \commondummiesnofonts
3443 \definedummyletter\_%
3445 % Non-English letters.
3446 \definedummyword\AA
3447 \definedummyword\AE
3448 \definedummyword\L
3449 \definedummyword\OE
3450 \definedummyword\O
3451 \definedummyword\aa
3452 \definedummyword\ae
3453 \definedummyword\l
3454 \definedummyword\oe
3455 \definedummyword\o
3456 \definedummyword\ss
3457 \definedummyword\exclamdown
3458 \definedummyword\questiondown
3459 \definedummyword\ordf
3460 \definedummyword\ordm
3462 % Although these internal commands shouldn't show up, sometimes they do.
3463 \definedummyword\bf
3464 \definedummyword\gtr
3465 \definedummyword\hat
3466 \definedummyword\less
3467 \definedummyword\sf
3468 \definedummyword\sl
3469 \definedummyword\tclose
3470 \definedummyword\tt
3472 \definedummyword\LaTeX
3473 \definedummyword\TeX
3475 % Assorted special characters.
3476 \definedummyword\bullet
3477 \definedummyword\comma
3478 \definedummyword\copyright
3479 \definedummyword\registeredsymbol
3480 \definedummyword\dots
3481 \definedummyword\enddots
3482 \definedummyword\equiv
3483 \definedummyword\error
3484 \definedummyword\euro
3485 \definedummyword\expansion
3486 \definedummyword\minus
3487 \definedummyword\pounds
3488 \definedummyword\point
3489 \definedummyword\print
3490 \definedummyword\result
3492 % We want to disable all macros so that they are not expanded by \write.
3493 \macrolist
3495 \normalturnoffactive
3497 % Handle some cases of @value -- where it does not contain any
3498 % (non-fully-expandable) commands.
3499 \makevalueexpandable
3502 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3504 \def\commondummiesnofonts{%
3505 % Control letters and accents.
3506 \definedummyletter\!%
3507 \definedummyaccent\"%
3508 \definedummyaccent\'%
3509 \definedummyletter\*%
3510 \definedummyaccent\,%
3511 \definedummyletter\.%
3512 \definedummyletter\/%
3513 \definedummyletter\:%
3514 \definedummyaccent\=%
3515 \definedummyletter\?%
3516 \definedummyaccent\^%
3517 \definedummyaccent\`%
3518 \definedummyaccent\~%
3519 \definedummyword\u
3520 \definedummyword\v
3521 \definedummyword\H
3522 \definedummyword\dotaccent
3523 \definedummyword\ringaccent
3524 \definedummyword\tieaccent
3525 \definedummyword\ubaraccent
3526 \definedummyword\udotaccent
3527 \definedummyword\dotless
3529 % Texinfo font commands.
3530 \definedummyword\b
3531 \definedummyword\i
3532 \definedummyword\r
3533 \definedummyword\sc
3534 \definedummyword\t
3536 % Commands that take arguments.
3537 \definedummyword\acronym
3538 \definedummyword\cite
3539 \definedummyword\code
3540 \definedummyword\command
3541 \definedummyword\dfn
3542 \definedummyword\emph
3543 \definedummyword\env
3544 \definedummyword\file
3545 \definedummyword\kbd
3546 \definedummyword\key
3547 \definedummyword\math
3548 \definedummyword\option
3549 \definedummyword\pxref
3550 \definedummyword\ref
3551 \definedummyword\samp
3552 \definedummyword\strong
3553 \definedummyword\tie
3554 \definedummyword\uref
3555 \definedummyword\url
3556 \definedummyword\var
3557 \definedummyword\verb
3558 \definedummyword\w
3559 \definedummyword\xref
3562 % \indexnofonts is used when outputting the strings to sort the index
3563 % by, and when constructing control sequence names. It eliminates all
3564 % control sequences and just writes whatever the best ASCII sort string
3565 % would be for a given command (usually its argument).
3567 \def\indexnofonts{%
3568 % Accent commands should become @asis.
3569 \def\definedummyaccent##1{\let##1\asis}%
3570 % We can just ignore other control letters.
3571 \def\definedummyletter##1{\let##1\empty}%
3572 % Hopefully, all control words can become @asis.
3573 \let\definedummyword\definedummyaccent
3575 \commondummiesnofonts
3577 % Don't no-op \tt, since it isn't a user-level command
3578 % and is used in the definitions of the active chars like <, >, |, etc.
3579 % Likewise with the other plain tex font commands.
3580 %\let\tt=\asis
3582 \def\ { }%
3583 \def\@{@}%
3584 % how to handle braces?
3585 \def\_{\normalunderscore}%
3587 % Non-English letters.
3588 \def\AA{AA}%
3589 \def\AE{AE}%
3590 \def\L{L}%
3591 \def\OE{OE}%
3592 \def\O{O}%
3593 \def\aa{aa}%
3594 \def\ae{ae}%
3595 \def\l{l}%
3596 \def\oe{oe}%
3597 \def\o{o}%
3598 \def\ss{ss}%
3599 \def\exclamdown{!}%
3600 \def\questiondown{?}%
3601 \def\ordf{a}%
3602 \def\ordm{o}%
3604 \def\LaTeX{LaTeX}%
3605 \def\TeX{TeX}%
3607 % Assorted special characters.
3608 % (The following {} will end up in the sort string, but that's ok.)
3609 \def\bullet{bullet}%
3610 \def\comma{,}%
3611 \def\copyright{copyright}%
3612 \def\registeredsymbol{R}%
3613 \def\dots{...}%
3614 \def\enddots{...}%
3615 \def\equiv{==}%
3616 \def\error{error}%
3617 \def\euro{euro}%
3618 \def\expansion{==>}%
3619 \def\minus{-}%
3620 \def\pounds{pounds}%
3621 \def\point{.}%
3622 \def\print{-|}%
3623 \def\result{=>}%
3625 % We need to get rid of all macros, leaving only the arguments (if present).
3626 % Of course this is not nearly correct, but it is the best we can do for now.
3627 % makeinfo does not expand macros in the argument to @deffn, which ends up
3628 % writing an index entry, and texindex isn't prepared for an index sort entry
3629 % that starts with \.
3631 % Since macro invocations are followed by braces, we can just redefine them
3632 % to take a single TeX argument. The case of a macro invocation that
3633 % goes to end-of-line is not handled.
3635 \macrolist
3638 \let\indexbackslash=0 %overridden during \printindex.
3639 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3641 % Most index entries go through here, but \dosubind is the general case.
3642 % #1 is the index name, #2 is the entry text.
3643 \def\doind#1#2{\dosubind{#1}{#2}{}}
3645 % Workhorse for all \fooindexes.
3646 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3647 % empty if called from \doind, as we usually are (the main exception
3648 % is with most defuns, which call us directly).
3650 \def\dosubind#1#2#3{%
3651 \iflinks
3653 % Store the main index entry text (including the third arg).
3654 \toks0 = {#2}%
3655 % If third arg is present, precede it with a space.
3656 \def\thirdarg{#3}%
3657 \ifx\thirdarg\empty \else
3658 \toks0 = \expandafter{\the\toks0 \space #3}%
3661 \edef\writeto{\csname#1indfile\endcsname}%
3663 \ifvmode
3664 \dosubindsanitize
3665 \else
3666 \dosubindwrite
3672 % Write the entry in \toks0 to the index file:
3674 \def\dosubindwrite{%
3675 % Put the index entry in the margin if desired.
3676 \ifx\SETmarginindex\relax\else
3677 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3680 % Remember, we are within a group.
3681 \indexdummies % Must do this here, since \bf, etc expand at this stage
3682 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3683 % so it will be output as is; and it will print as backslash.
3685 % Process the index entry with all font commands turned off, to
3686 % get the string to sort by.
3687 {\indexnofonts
3688 \edef\temp{\the\toks0}% need full expansion
3689 \xdef\indexsorttmp{\temp}%
3692 % Set up the complete index entry, with both the sort key and
3693 % the original text, including any font commands. We write
3694 % three arguments to \entry to the .?? file (four in the
3695 % subentry case), texindex reduces to two when writing the .??s
3696 % sorted result.
3697 \edef\temp{%
3698 \write\writeto{%
3699 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3701 \temp
3704 % Take care of unwanted page breaks:
3706 % If a skip is the last thing on the list now, preserve it
3707 % by backing up by \lastskip, doing the \write, then inserting
3708 % the skip again. Otherwise, the whatsit generated by the
3709 % \write will make \lastskip zero. The result is that sequences
3710 % like this:
3711 % @end defun
3712 % @tindex whatever
3713 % @defun ...
3714 % will have extra space inserted, because the \medbreak in the
3715 % start of the @defun won't see the skip inserted by the @end of
3716 % the previous defun.
3718 % But don't do any of this if we're not in vertical mode. We
3719 % don't want to do a \vskip and prematurely end a paragraph.
3721 % Avoid page breaks due to these extra skips, too.
3723 % But wait, there is a catch there:
3724 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3725 % sufficient for this purpose, as it ignores stretch and shrink parts
3726 % of the skip. The only way seems to be to check the textual
3727 % representation of the skip.
3729 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3730 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3732 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3734 % ..., ready, GO:
3736 \def\dosubindsanitize{%
3737 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3738 \skip0 = \lastskip
3739 \edef\lastskipmacro{\the\lastskip}%
3740 \count255 = \lastpenalty
3742 % If \lastskip is nonzero, that means the last item was a
3743 % skip. And since a skip is discardable, that means this
3744 % -\skip0 glue we're inserting is preceded by a
3745 % non-discardable item, therefore it is not a potential
3746 % breakpoint, therefore no \nobreak needed.
3747 \ifx\lastskipmacro\zeroskipmacro
3748 \else
3749 \vskip-\skip0
3752 \dosubindwrite
3754 \ifx\lastskipmacro\zeroskipmacro
3755 % If \lastskip was zero, perhaps the last item was a penalty, and
3756 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3757 % to re-insert the same penalty (values >10000 are used for various
3758 % signals); since we just inserted a non-discardable item, any
3759 % following glue (such as a \parskip) would be a breakpoint. For example:
3761 % @deffn deffn-whatever
3762 % @vindex index-whatever
3763 % Description.
3764 % would allow a break between the index-whatever whatsit
3765 % and the "Description." paragraph.
3766 \ifnum\count255>9999 \penalty\count255 \fi
3767 \else
3768 % On the other hand, if we had a nonzero \lastskip,
3769 % this make-up glue would be preceded by a non-discardable item
3770 % (the whatsit from the \write), so we must insert a \nobreak.
3771 \nobreak\vskip\skip0
3775 % The index entry written in the file actually looks like
3776 % \entry {sortstring}{page}{topic}
3777 % or
3778 % \entry {sortstring}{page}{topic}{subtopic}
3779 % The texindex program reads in these files and writes files
3780 % containing these kinds of lines:
3781 % \initial {c}
3782 % before the first topic whose initial is c
3783 % \entry {topic}{pagelist}
3784 % for a topic that is used without subtopics
3785 % \primary {topic}
3786 % for the beginning of a topic that is used with subtopics
3787 % \secondary {subtopic}{pagelist}
3788 % for each subtopic.
3790 % Define the user-accessible indexing commands
3791 % @findex, @vindex, @kindex, @cindex.
3793 \def\findex {\fnindex}
3794 \def\kindex {\kyindex}
3795 \def\cindex {\cpindex}
3796 \def\vindex {\vrindex}
3797 \def\tindex {\tpindex}
3798 \def\pindex {\pgindex}
3800 \def\cindexsub {\begingroup\obeylines\cindexsub}
3801 {\obeylines %
3802 \gdef\cindexsub "#1" #2^^M{\endgroup %
3803 \dosubind{cp}{#2}{#1}}}
3805 % Define the macros used in formatting output of the sorted index material.
3807 % @printindex causes a particular index (the ??s file) to get printed.
3808 % It does not print any chapter heading (usually an @unnumbered).
3810 \parseargdef\printindex{\begingroup
3811 \dobreak \chapheadingskip{10000}%
3813 \smallfonts \rm
3814 \tolerance = 9500
3815 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3817 % See if the index file exists and is nonempty.
3818 % Change catcode of @ here so that if the index file contains
3819 % \initial {@}
3820 % as its first line, TeX doesn't complain about mismatched braces
3821 % (because it thinks @} is a control sequence).
3822 \catcode`\@ = 11
3823 \openin 1 \jobname.#1s
3824 \ifeof 1
3825 % \enddoublecolumns gets confused if there is no text in the index,
3826 % and it loses the chapter title and the aux file entries for the
3827 % index. The easiest way to prevent this problem is to make sure
3828 % there is some text.
3829 \putwordIndexNonexistent
3830 \else
3832 % If the index file exists but is empty, then \openin leaves \ifeof
3833 % false. We have to make TeX try to read something from the file, so
3834 % it can discover if there is anything in it.
3835 \read 1 to \temp
3836 \ifeof 1
3837 \putwordIndexIsEmpty
3838 \else
3839 % Index files are almost Texinfo source, but we use \ as the escape
3840 % character. It would be better to use @, but that's too big a change
3841 % to make right now.
3842 \def\indexbackslash{\backslashcurfont}%
3843 \catcode`\\ = 0
3844 \escapechar = `\\
3845 \begindoublecolumns
3846 \input \jobname.#1s
3847 \enddoublecolumns
3850 \closein 1
3851 \endgroup}
3853 % These macros are used by the sorted index file itself.
3854 % Change them to control the appearance of the index.
3856 \def\initial#1{{%
3857 % Some minor font changes for the special characters.
3858 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3860 % Remove any glue we may have, we'll be inserting our own.
3861 \removelastskip
3863 % We like breaks before the index initials, so insert a bonus.
3864 \nobreak
3865 \vskip 0pt plus 3\baselineskip
3866 \penalty 0
3867 \vskip 0pt plus -3\baselineskip
3869 % Typeset the initial. Making this add up to a whole number of
3870 % baselineskips increases the chance of the dots lining up from column
3871 % to column. It still won't often be perfect, because of the stretch
3872 % we need before each entry, but it's better.
3874 % No shrink because it confuses \balancecolumns.
3875 \vskip 1.67\baselineskip plus .5\baselineskip
3876 \leftline{\secbf #1}%
3877 % Do our best not to break after the initial.
3878 \nobreak
3879 \vskip .33\baselineskip plus .1\baselineskip
3882 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3883 % then page number (#2) flushed to the right margin. It is used for index
3884 % and table of contents entries. The paragraph is indented by \leftskip.
3886 % A straightforward implementation would start like this:
3887 % \def\entry#1#2{...
3888 % But this frozes the catcodes in the argument, and can cause problems to
3889 % @code, which sets - active. This problem was fixed by a kludge---
3890 % ``-'' was active throughout whole index, but this isn't really right.
3892 % The right solution is to prevent \entry from swallowing the whole text.
3893 % --kasal, 21nov03
3894 \def\entry{%
3895 \begingroup
3897 % Start a new paragraph if necessary, so our assignments below can't
3898 % affect previous text.
3899 \par
3901 % Do not fill out the last line with white space.
3902 \parfillskip = 0in
3904 % No extra space above this paragraph.
3905 \parskip = 0in
3907 % Do not prefer a separate line ending with a hyphen to fewer lines.
3908 \finalhyphendemerits = 0
3910 % \hangindent is only relevant when the entry text and page number
3911 % don't both fit on one line. In that case, bob suggests starting the
3912 % dots pretty far over on the line. Unfortunately, a large
3913 % indentation looks wrong when the entry text itself is broken across
3914 % lines. So we use a small indentation and put up with long leaders.
3916 % \hangafter is reset to 1 (which is the value we want) at the start
3917 % of each paragraph, so we need not do anything with that.
3918 \hangindent = 2em
3920 % When the entry text needs to be broken, just fill out the first line
3921 % with blank space.
3922 \rightskip = 0pt plus1fil
3924 % A bit of stretch before each entry for the benefit of balancing
3925 % columns.
3926 \vskip 0pt plus1pt
3928 % Swallow the left brace of the text (first parameter):
3929 \afterassignment\doentry
3930 \let\temp =
3932 \def\doentry{%
3933 \bgroup % Instead of the swallowed brace.
3934 \noindent
3935 \aftergroup\finishentry
3936 % And now comes the text of the entry.
3938 \def\finishentry#1{%
3939 % #1 is the page number.
3941 % The following is kludged to not output a line of dots in the index if
3942 % there are no page numbers. The next person who breaks this will be
3943 % cursed by a Unix daemon.
3944 \def\tempa{{\rm }}%
3945 \def\tempb{#1}%
3946 \edef\tempc{\tempa}%
3947 \edef\tempd{\tempb}%
3948 \ifx\tempc\tempd
3950 \else
3952 % If we must, put the page number on a line of its own, and fill out
3953 % this line with blank space. (The \hfil is overwhelmed with the
3954 % fill leaders glue in \indexdotfill if the page number does fit.)
3955 \hfil\penalty50
3956 \null\nobreak\indexdotfill % Have leaders before the page number.
3958 % The `\ ' here is removed by the implicit \unskip that TeX does as
3959 % part of (the primitive) \par. Without it, a spurious underfull
3960 % \hbox ensues.
3961 \ifpdf
3962 \pdfgettoks#1.%
3963 \ \the\toksA
3964 \else
3965 \ #1%
3968 \par
3969 \endgroup
3972 % Like \dotfill except takes at least 1 em.
3973 \def\indexdotfill{\cleaders
3974 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3976 \def\primary #1{\line{#1\hfil}}
3978 \newskip\secondaryindent \secondaryindent=0.5cm
3979 \def\secondary#1#2{{%
3980 \parfillskip=0in
3981 \parskip=0in
3982 \hangindent=1in
3983 \hangafter=1
3984 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3985 \ifpdf
3986 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3987 \else
3990 \par
3993 % Define two-column mode, which we use to typeset indexes.
3994 % Adapted from the TeXbook, page 416, which is to say,
3995 % the manmac.tex format used to print the TeXbook itself.
3996 \catcode`\@=11
3998 \newbox\partialpage
3999 \newdimen\doublecolumnhsize
4001 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4002 % Grab any single-column material above us.
4003 \output = {%
4005 % Here is a possibility not foreseen in manmac: if we accumulate a
4006 % whole lot of material, we might end up calling this \output
4007 % routine twice in a row (see the doublecol-lose test, which is
4008 % essentially a couple of indexes with @setchapternewpage off). In
4009 % that case we just ship out what is in \partialpage with the normal
4010 % output routine. Generally, \partialpage will be empty when this
4011 % runs and this will be a no-op. See the indexspread.tex test case.
4012 \ifvoid\partialpage \else
4013 \onepageout{\pagecontents\partialpage}%
4016 \global\setbox\partialpage = \vbox{%
4017 % Unvbox the main output page.
4018 \unvbox\PAGE
4019 \kern-\topskip \kern\baselineskip
4022 \eject % run that output routine to set \partialpage
4024 % Use the double-column output routine for subsequent pages.
4025 \output = {\doublecolumnout}%
4027 % Change the page size parameters. We could do this once outside this
4028 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4029 % format, but then we repeat the same computation. Repeating a couple
4030 % of assignments once per index is clearly meaningless for the
4031 % execution time, so we may as well do it in one place.
4033 % First we halve the line length, less a little for the gutter between
4034 % the columns. We compute the gutter based on the line length, so it
4035 % changes automatically with the paper format. The magic constant
4036 % below is chosen so that the gutter has the same value (well, +-<1pt)
4037 % as it did when we hard-coded it.
4039 % We put the result in a separate register, \doublecolumhsize, so we
4040 % can restore it in \pagesofar, after \hsize itself has (potentially)
4041 % been clobbered.
4043 \doublecolumnhsize = \hsize
4044 \advance\doublecolumnhsize by -.04154\hsize
4045 \divide\doublecolumnhsize by 2
4046 \hsize = \doublecolumnhsize
4048 % Double the \vsize as well. (We don't need a separate register here,
4049 % since nobody clobbers \vsize.)
4050 \vsize = 2\vsize
4053 % The double-column output routine for all double-column pages except
4054 % the last.
4056 \def\doublecolumnout{%
4057 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4058 % Get the available space for the double columns -- the normal
4059 % (undoubled) page height minus any material left over from the
4060 % previous page.
4061 \dimen@ = \vsize
4062 \divide\dimen@ by 2
4063 \advance\dimen@ by -\ht\partialpage
4065 % box0 will be the left-hand column, box2 the right.
4066 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4067 \onepageout\pagesofar
4068 \unvbox255
4069 \penalty\outputpenalty
4072 % Re-output the contents of the output page -- any previous material,
4073 % followed by the two boxes we just split, in box0 and box2.
4074 \def\pagesofar{%
4075 \unvbox\partialpage
4077 \hsize = \doublecolumnhsize
4078 \wd0=\hsize \wd2=\hsize
4079 \hbox to\pagewidth{\box0\hfil\box2}%
4082 % All done with double columns.
4083 \def\enddoublecolumns{%
4084 \output = {%
4085 % Split the last of the double-column material. Leave it on the
4086 % current page, no automatic page break.
4087 \balancecolumns
4089 % If we end up splitting too much material for the current page,
4090 % though, there will be another page break right after this \output
4091 % invocation ends. Having called \balancecolumns once, we do not
4092 % want to call it again. Therefore, reset \output to its normal
4093 % definition right away. (We hope \balancecolumns will never be
4094 % called on to balance too much material, but if it is, this makes
4095 % the output somewhat more palatable.)
4096 \global\output = {\onepageout{\pagecontents\PAGE}}%
4098 \eject
4099 \endgroup % started in \begindoublecolumns
4101 % \pagegoal was set to the doubled \vsize above, since we restarted
4102 % the current page. We're now back to normal single-column
4103 % typesetting, so reset \pagegoal to the normal \vsize (after the
4104 % \endgroup where \vsize got restored).
4105 \pagegoal = \vsize
4108 % Called at the end of the double column material.
4109 \def\balancecolumns{%
4110 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4111 \dimen@ = \ht0
4112 \advance\dimen@ by \topskip
4113 \advance\dimen@ by-\baselineskip
4114 \divide\dimen@ by 2 % target to split to
4115 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4116 \splittopskip = \topskip
4117 % Loop until we get a decent breakpoint.
4119 \vbadness = 10000
4120 \loop
4121 \global\setbox3 = \copy0
4122 \global\setbox1 = \vsplit3 to \dimen@
4123 \ifdim\ht3>\dimen@
4124 \global\advance\dimen@ by 1pt
4125 \repeat
4127 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4128 \setbox0=\vbox to\dimen@{\unvbox1}%
4129 \setbox2=\vbox to\dimen@{\unvbox3}%
4131 \pagesofar
4133 \catcode`\@ = \other
4136 \message{sectioning,}
4137 % Chapters, sections, etc.
4139 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4140 % sections so that we can refer to them unambiguously in the pdf
4141 % outlines by their "section number". We avoid collisions with chapter
4142 % numbers by starting them at 10000. (If a document ever has 10000
4143 % chapters, we're in trouble anyway, I'm sure.)
4144 \newcount\unnumberedno \unnumberedno = 10000
4145 \newcount\chapno
4146 \newcount\secno \secno=0
4147 \newcount\subsecno \subsecno=0
4148 \newcount\subsubsecno \subsubsecno=0
4150 % This counter is funny since it counts through charcodes of letters A, B, ...
4151 \newcount\appendixno \appendixno = `\@
4153 % \def\appendixletter{\char\the\appendixno}
4154 % We do the following ugly conditional instead of the above simple
4155 % construct for the sake of pdftex, which needs the actual
4156 % letter in the expansion, not just typeset.
4158 \def\appendixletter{%
4159 \ifnum\appendixno=`A A%
4160 \else\ifnum\appendixno=`B B%
4161 \else\ifnum\appendixno=`C C%
4162 \else\ifnum\appendixno=`D D%
4163 \else\ifnum\appendixno=`E E%
4164 \else\ifnum\appendixno=`F F%
4165 \else\ifnum\appendixno=`G G%
4166 \else\ifnum\appendixno=`H H%
4167 \else\ifnum\appendixno=`I I%
4168 \else\ifnum\appendixno=`J J%
4169 \else\ifnum\appendixno=`K K%
4170 \else\ifnum\appendixno=`L L%
4171 \else\ifnum\appendixno=`M M%
4172 \else\ifnum\appendixno=`N N%
4173 \else\ifnum\appendixno=`O O%
4174 \else\ifnum\appendixno=`P P%
4175 \else\ifnum\appendixno=`Q Q%
4176 \else\ifnum\appendixno=`R R%
4177 \else\ifnum\appendixno=`S S%
4178 \else\ifnum\appendixno=`T T%
4179 \else\ifnum\appendixno=`U U%
4180 \else\ifnum\appendixno=`V V%
4181 \else\ifnum\appendixno=`W W%
4182 \else\ifnum\appendixno=`X X%
4183 \else\ifnum\appendixno=`Y Y%
4184 \else\ifnum\appendixno=`Z Z%
4185 % The \the is necessary, despite appearances, because \appendixletter is
4186 % expanded while writing the .toc file. \char\appendixno is not
4187 % expandable, thus it is written literally, thus all appendixes come out
4188 % with the same letter (or @) in the toc without it.
4189 \else\char\the\appendixno
4190 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4191 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4193 % Each @chapter defines this as the name of the chapter.
4194 % page headings and footings can use it. @section does likewise.
4195 % However, they are not reliable, because we don't use marks.
4196 \def\thischapter{}
4197 \def\thissection{}
4199 \newcount\absseclevel % used to calculate proper heading level
4200 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4202 % @raisesections: treat @section as chapter, @subsection as section, etc.
4203 \def\raisesections{\global\advance\secbase by -1}
4204 \let\up=\raisesections % original BFox name
4206 % @lowersections: treat @chapter as section, @section as subsection, etc.
4207 \def\lowersections{\global\advance\secbase by 1}
4208 \let\down=\lowersections % original BFox name
4210 % we only have subsub.
4211 \chardef\maxseclevel = 3
4213 % A numbered section within an unnumbered changes to unnumbered too.
4214 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4215 \chardef\unmlevel = \maxseclevel
4217 % Trace whether the current chapter is an appendix or not:
4218 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4219 \def\chapheadtype{N}
4221 % Choose a heading macro
4222 % #1 is heading type
4223 % #2 is heading level
4224 % #3 is text for heading
4225 \def\genhead#1#2#3{%
4226 % Compute the abs. sec. level:
4227 \absseclevel=#2
4228 \advance\absseclevel by \secbase
4229 % Make sure \absseclevel doesn't fall outside the range:
4230 \ifnum \absseclevel < 0
4231 \absseclevel = 0
4232 \else
4233 \ifnum \absseclevel > 3
4234 \absseclevel = 3
4237 % The heading type:
4238 \def\headtype{#1}%
4239 \if \headtype U%
4240 \ifnum \absseclevel < \unmlevel
4241 \chardef\unmlevel = \absseclevel
4243 \else
4244 % Check for appendix sections:
4245 \ifnum \absseclevel = 0
4246 \edef\chapheadtype{\headtype}%
4247 \else
4248 \if \headtype A\if \chapheadtype N%
4249 \errmessage{@appendix... within a non-appendix chapter}%
4250 \fi\fi
4252 % Check for numbered within unnumbered:
4253 \ifnum \absseclevel > \unmlevel
4254 \def\headtype{U}%
4255 \else
4256 \chardef\unmlevel = 3
4259 % Now print the heading:
4260 \if \headtype U%
4261 \ifcase\absseclevel
4262 \unnumberedzzz{#3}%
4263 \or \unnumberedseczzz{#3}%
4264 \or \unnumberedsubseczzz{#3}%
4265 \or \unnumberedsubsubseczzz{#3}%
4267 \else
4268 \if \headtype A%
4269 \ifcase\absseclevel
4270 \appendixzzz{#3}%
4271 \or \appendixsectionzzz{#3}%
4272 \or \appendixsubseczzz{#3}%
4273 \or \appendixsubsubseczzz{#3}%
4275 \else
4276 \ifcase\absseclevel
4277 \chapterzzz{#3}%
4278 \or \seczzz{#3}%
4279 \or \numberedsubseczzz{#3}%
4280 \or \numberedsubsubseczzz{#3}%
4284 \suppressfirstparagraphindent
4287 % an interface:
4288 \def\numhead{\genhead N}
4289 \def\apphead{\genhead A}
4290 \def\unnmhead{\genhead U}
4292 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4293 % all lower-level sectioning counters to zero.
4295 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4296 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4297 \let\chaplevelprefix = \empty
4299 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4300 \def\chapterzzz#1{%
4301 % section resetting is \global in case the chapter is in a group, such
4302 % as an @include file.
4303 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4304 \global\advance\chapno by 1
4306 % Used for \float.
4307 \gdef\chaplevelprefix{\the\chapno.}%
4308 \resetallfloatnos
4310 \message{\putwordChapter\space \the\chapno}%
4312 % Write the actual heading.
4313 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4315 % So @section and the like are numbered underneath this chapter.
4316 \global\let\section = \numberedsec
4317 \global\let\subsection = \numberedsubsec
4318 \global\let\subsubsection = \numberedsubsubsec
4321 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4322 \def\appendixzzz#1{%
4323 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4324 \global\advance\appendixno by 1
4325 \gdef\chaplevelprefix{\appendixletter.}%
4326 \resetallfloatnos
4328 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4329 \message{\appendixnum}%
4331 \chapmacro{#1}{Yappendix}{\appendixletter}%
4333 \global\let\section = \appendixsec
4334 \global\let\subsection = \appendixsubsec
4335 \global\let\subsubsection = \appendixsubsubsec
4338 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4339 \def\unnumberedzzz#1{%
4340 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4341 \global\advance\unnumberedno by 1
4343 % Since an unnumbered has no number, no prefix for figures.
4344 \global\let\chaplevelprefix = \empty
4345 \resetallfloatnos
4347 % This used to be simply \message{#1}, but TeX fully expands the
4348 % argument to \message. Therefore, if #1 contained @-commands, TeX
4349 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4350 % expanded @cite (which turns out to cause errors because \cite is meant
4351 % to be executed, not expanded).
4353 % Anyway, we don't want the fully-expanded definition of @cite to appear
4354 % as a result of the \message, we just want `@cite' itself. We use
4355 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4356 % simply yielding the contents of <toks register>. (We also do this for
4357 % the toc entries.)
4358 \toks0 = {#1}%
4359 \message{(\the\toks0)}%
4361 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4363 \global\let\section = \unnumberedsec
4364 \global\let\subsection = \unnumberedsubsec
4365 \global\let\subsubsection = \unnumberedsubsubsec
4368 % @centerchap is like @unnumbered, but the heading is centered.
4369 \outer\parseargdef\centerchap{%
4370 % Well, we could do the following in a group, but that would break
4371 % an assumption that \chapmacro is called at the outermost level.
4372 % Thus we are safer this way: --kasal, 24feb04
4373 \let\centerparametersmaybe = \centerparameters
4374 \unnmhead0{#1}%
4375 \let\centerparametersmaybe = \relax
4378 % @top is like @unnumbered.
4379 \let\top\unnumbered
4381 % Sections.
4382 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4383 \def\seczzz#1{%
4384 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4385 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4388 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4389 \def\appendixsectionzzz#1{%
4390 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4391 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4393 \let\appendixsec\appendixsection
4395 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4396 \def\unnumberedseczzz#1{%
4397 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4398 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4401 % Subsections.
4402 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4403 \def\numberedsubseczzz#1{%
4404 \global\subsubsecno=0 \global\advance\subsecno by 1
4405 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4408 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4409 \def\appendixsubseczzz#1{%
4410 \global\subsubsecno=0 \global\advance\subsecno by 1
4411 \sectionheading{#1}{subsec}{Yappendix}%
4412 {\appendixletter.\the\secno.\the\subsecno}%
4415 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4416 \def\unnumberedsubseczzz#1{%
4417 \global\subsubsecno=0 \global\advance\subsecno by 1
4418 \sectionheading{#1}{subsec}{Ynothing}%
4419 {\the\unnumberedno.\the\secno.\the\subsecno}%
4422 % Subsubsections.
4423 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4424 \def\numberedsubsubseczzz#1{%
4425 \global\advance\subsubsecno by 1
4426 \sectionheading{#1}{subsubsec}{Ynumbered}%
4427 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4430 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4431 \def\appendixsubsubseczzz#1{%
4432 \global\advance\subsubsecno by 1
4433 \sectionheading{#1}{subsubsec}{Yappendix}%
4434 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4437 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4438 \def\unnumberedsubsubseczzz#1{%
4439 \global\advance\subsubsecno by 1
4440 \sectionheading{#1}{subsubsec}{Ynothing}%
4441 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4444 % These macros control what the section commands do, according
4445 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4446 % Define them by default for a numbered chapter.
4447 \let\section = \numberedsec
4448 \let\subsection = \numberedsubsec
4449 \let\subsubsection = \numberedsubsubsec
4451 % Define @majorheading, @heading and @subheading
4453 % NOTE on use of \vbox for chapter headings, section headings, and such:
4454 % 1) We use \vbox rather than the earlier \line to permit
4455 % overlong headings to fold.
4456 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4457 % heading is obnoxious; this forbids it.
4458 % 3) Likewise, headings look best if no \parindent is used, and
4459 % if justification is not attempted. Hence \raggedright.
4462 \def\majorheading{%
4463 {\advance\chapheadingskip by 10pt \chapbreak }%
4464 \parsearg\chapheadingzzz
4467 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4468 \def\chapheadingzzz#1{%
4469 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4470 \parindent=0pt\raggedright
4471 \rm #1\hfill}}%
4472 \bigskip \par\penalty 200\relax
4473 \suppressfirstparagraphindent
4476 % @heading, @subheading, @subsubheading.
4477 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4478 \suppressfirstparagraphindent}
4479 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4480 \suppressfirstparagraphindent}
4481 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4482 \suppressfirstparagraphindent}
4484 % These macros generate a chapter, section, etc. heading only
4485 % (including whitespace, linebreaking, etc. around it),
4486 % given all the information in convenient, parsed form.
4488 %%% Args are the skip and penalty (usually negative)
4489 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4491 %%% Define plain chapter starts, and page on/off switching for it
4492 % Parameter controlling skip before chapter headings (if needed)
4494 \newskip\chapheadingskip
4496 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4497 \def\chappager{\par\vfill\supereject}
4498 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4500 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4502 \def\CHAPPAGoff{%
4503 \global\let\contentsalignmacro = \chappager
4504 \global\let\pchapsepmacro=\chapbreak
4505 \global\let\pagealignmacro=\chappager}
4507 \def\CHAPPAGon{%
4508 \global\let\contentsalignmacro = \chappager
4509 \global\let\pchapsepmacro=\chappager
4510 \global\let\pagealignmacro=\chappager
4511 \global\def\HEADINGSon{\HEADINGSsingle}}
4513 \def\CHAPPAGodd{%
4514 \global\let\contentsalignmacro = \chapoddpage
4515 \global\let\pchapsepmacro=\chapoddpage
4516 \global\let\pagealignmacro=\chapoddpage
4517 \global\def\HEADINGSon{\HEADINGSdouble}}
4519 \CHAPPAGon
4521 % Chapter opening.
4523 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4524 % Yappendix, Yomitfromtoc), #3 the chapter number.
4526 % To test against our argument.
4527 \def\Ynothingkeyword{Ynothing}
4528 \def\Yomitfromtockeyword{Yomitfromtoc}
4529 \def\Yappendixkeyword{Yappendix}
4531 \def\chapmacro#1#2#3{%
4532 \pchapsepmacro
4534 \chapfonts \rm
4536 % Have to define \thissection before calling \donoderef, because the
4537 % xref code eventually uses it. On the other hand, it has to be called
4538 % after \pchapsepmacro, or the headline will change too soon.
4539 \gdef\thissection{#1}%
4540 \gdef\thischaptername{#1}%
4542 % Only insert the separating space if we have a chapter/appendix
4543 % number, and don't print the unnumbered ``number''.
4544 \def\temptype{#2}%
4545 \ifx\temptype\Ynothingkeyword
4546 \setbox0 = \hbox{}%
4547 \def\toctype{unnchap}%
4548 \gdef\thischapter{#1}%
4549 \else\ifx\temptype\Yomitfromtockeyword
4550 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4551 \def\toctype{omit}%
4552 \gdef\thischapter{}%
4553 \else\ifx\temptype\Yappendixkeyword
4554 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4555 \def\toctype{app}%
4556 % We don't substitute the actual chapter name into \thischapter
4557 % because we don't want its macros evaluated now. And we don't
4558 % use \thissection because that changes with each section.
4560 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4561 \noexpand\thischaptername}%
4562 \else
4563 \setbox0 = \hbox{#3\enspace}%
4564 \def\toctype{numchap}%
4565 \xdef\thischapter{\putwordChapter{} \the\chapno:
4566 \noexpand\thischaptername}%
4567 \fi\fi\fi
4569 % Write the toc entry for this chapter. Must come before the
4570 % \donoderef, because we include the current node name in the toc
4571 % entry, and \donoderef resets it to empty.
4572 \writetocentry{\toctype}{#1}{#3}%
4574 % For pdftex, we have to write out the node definition (aka, make
4575 % the pdfdest) after any page break, but before the actual text has
4576 % been typeset. If the destination for the pdf outline is after the
4577 % text, then jumping from the outline may wind up with the text not
4578 % being visible, for instance under high magnification.
4579 \donoderef{#2}%
4581 % Typeset the actual heading.
4582 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4583 \hangindent=\wd0 \centerparametersmaybe
4584 \unhbox0 #1\par}%
4586 \nobreak\bigskip % no page break after a chapter title
4587 \nobreak
4590 % @centerchap -- centered and unnumbered.
4591 \let\centerparametersmaybe = \relax
4592 \def\centerparameters{%
4593 \advance\rightskip by 3\rightskip
4594 \leftskip = \rightskip
4595 \parfillskip = 0pt
4599 % I don't think this chapter style is supported any more, so I'm not
4600 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4602 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4604 \def\unnchfopen #1{%
4605 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4606 \parindent=0pt\raggedright
4607 \rm #1\hfill}}\bigskip \par\nobreak
4609 \def\chfopen #1#2{\chapoddpage {\chapfonts
4610 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4611 \par\penalty 5000 %
4613 \def\centerchfopen #1{%
4614 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4615 \parindent=0pt
4616 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4618 \def\CHAPFopen{%
4619 \global\let\chapmacro=\chfopen
4620 \global\let\centerchapmacro=\centerchfopen}
4623 % Section titles. These macros combine the section number parts and
4624 % call the generic \sectionheading to do the printing.
4626 \newskip\secheadingskip
4627 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4629 % Subsection titles.
4630 \newskip\subsecheadingskip
4631 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4633 % Subsubsection titles.
4634 \def\subsubsecheadingskip{\subsecheadingskip}
4635 \def\subsubsecheadingbreak{\subsecheadingbreak}
4638 % Print any size, any type, section title.
4640 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4641 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4642 % section number.
4644 \def\sectionheading#1#2#3#4{%
4646 % Switch to the right set of fonts.
4647 \csname #2fonts\endcsname \rm
4649 % Insert space above the heading.
4650 \csname #2headingbreak\endcsname
4652 % Only insert the space after the number if we have a section number.
4653 \def\sectionlevel{#2}%
4654 \def\temptype{#3}%
4656 \ifx\temptype\Ynothingkeyword
4657 \setbox0 = \hbox{}%
4658 \def\toctype{unn}%
4659 \gdef\thissection{#1}%
4660 \else\ifx\temptype\Yomitfromtockeyword
4661 % for @headings -- no section number, don't include in toc,
4662 % and don't redefine \thissection.
4663 \setbox0 = \hbox{}%
4664 \def\toctype{omit}%
4665 \let\sectionlevel=\empty
4666 \else\ifx\temptype\Yappendixkeyword
4667 \setbox0 = \hbox{#4\enspace}%
4668 \def\toctype{app}%
4669 \gdef\thissection{#1}%
4670 \else
4671 \setbox0 = \hbox{#4\enspace}%
4672 \def\toctype{num}%
4673 \gdef\thissection{#1}%
4674 \fi\fi\fi
4676 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4677 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4679 % Write the node reference (= pdf destination for pdftex).
4680 % Again, see comments in \chapmacro.
4681 \donoderef{#3}%
4683 % Interline glue will be inserted when the vbox is completed.
4684 % That glue will be a valid breakpoint for the page, since it'll be
4685 % preceded by a whatsit (usually from the \donoderef, or from the
4686 % \writetocentry if there was no node). We don't want to allow that
4687 % break, since then the whatsits could end up on page n while the
4688 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4689 \nobreak
4691 % Output the actual section heading.
4692 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4693 \hangindent=\wd0 % zero if no section number
4694 \unhbox0 #1}%
4696 % Add extra space after the heading -- half of whatever came above it.
4697 % Don't allow stretch, though.
4698 \kern .5 \csname #2headingskip\endcsname
4700 % Do not let the kern be a potential breakpoint, as it would be if it
4701 % was followed by glue.
4702 \nobreak
4704 % We'll almost certainly start a paragraph next, so don't let that
4705 % glue accumulate. (Not a breakpoint because it's preceded by a
4706 % discardable item.)
4707 \vskip-\parskip
4709 % This is purely so the last item on the list is a known \penalty >
4710 % 10000. This is so \startdefun can avoid allowing breakpoints after
4711 % section headings. Otherwise, it would insert a valid breakpoint between:
4713 % @section sec-whatever
4714 % @deffn def-whatever
4715 \penalty 10001
4719 \message{toc,}
4720 % Table of contents.
4721 \newwrite\tocfile
4723 % Write an entry to the toc file, opening it if necessary.
4724 % Called from @chapter, etc.
4726 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4727 % We append the current node name (if any) and page number as additional
4728 % arguments for the \{chap,sec,...}entry macros which will eventually
4729 % read this. The node name is used in the pdf outlines as the
4730 % destination to jump to.
4732 % We open the .toc file for writing here instead of at @setfilename (or
4733 % any other fixed time) so that @contents can be anywhere in the document.
4734 % But if #1 is `omit', then we don't do anything. This is used for the
4735 % table of contents chapter openings themselves.
4737 \newif\iftocfileopened
4738 \def\omitkeyword{omit}%
4740 \def\writetocentry#1#2#3{%
4741 \edef\writetoctype{#1}%
4742 \ifx\writetoctype\omitkeyword \else
4743 \iftocfileopened\else
4744 \immediate\openout\tocfile = \jobname.toc
4745 \global\tocfileopenedtrue
4748 \iflinks
4749 {\atdummies
4750 \edef\temp{%
4751 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4752 \temp
4757 % Tell \shipout to create a pdf destination on each page, if we're
4758 % writing pdf. These are used in the table of contents. We can't
4759 % just write one on every page because the title pages are numbered
4760 % 1 and 2 (the page numbers aren't printed), and so are the first
4761 % two pages of the document. Thus, we'd have two destinations named
4762 % `1', and two named `2'.
4763 \ifpdf \global\pdfmakepagedesttrue \fi
4767 % These characters do not print properly in the Computer Modern roman
4768 % fonts, so we must take special care. This is more or less redundant
4769 % with the Texinfo input format setup at the end of this file.
4771 \def\activecatcodes{%
4772 \catcode`\"=\active
4773 \catcode`\$=\active
4774 \catcode`\<=\active
4775 \catcode`\>=\active
4776 \catcode`\\=\active
4777 \catcode`\^=\active
4778 \catcode`\_=\active
4779 \catcode`\|=\active
4780 \catcode`\~=\active
4784 % Read the toc file, which is essentially Texinfo input.
4785 \def\readtocfile{%
4786 \setupdatafile
4787 \activecatcodes
4788 \input \jobname.toc
4791 \newskip\contentsrightmargin \contentsrightmargin=1in
4792 \newcount\savepageno
4793 \newcount\lastnegativepageno \lastnegativepageno = -1
4795 % Prepare to read what we've written to \tocfile.
4797 \def\startcontents#1{%
4798 % If @setchapternewpage on, and @headings double, the contents should
4799 % start on an odd page, unlike chapters. Thus, we maintain
4800 % \contentsalignmacro in parallel with \pagealignmacro.
4801 % From: Torbjorn Granlund <tege@matematik.su.se>
4802 \contentsalignmacro
4803 \immediate\closeout\tocfile
4805 % Don't need to put `Contents' or `Short Contents' in the headline.
4806 % It is abundantly clear what they are.
4807 \def\thischapter{}%
4808 \chapmacro{#1}{Yomitfromtoc}{}%
4810 \savepageno = \pageno
4811 \begingroup % Set up to handle contents files properly.
4812 \raggedbottom % Worry more about breakpoints than the bottom.
4813 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4815 % Roman numerals for page numbers.
4816 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4820 % Normal (long) toc.
4821 \def\contents{%
4822 \startcontents{\putwordTOC}%
4823 \openin 1 \jobname.toc
4824 \ifeof 1 \else
4825 \readtocfile
4827 \vfill \eject
4828 \contentsalignmacro % in case @setchapternewpage odd is in effect
4829 \ifeof 1 \else
4830 \pdfmakeoutlines
4832 \closein 1
4833 \endgroup
4834 \lastnegativepageno = \pageno
4835 \global\pageno = \savepageno
4838 % And just the chapters.
4839 \def\summarycontents{%
4840 \startcontents{\putwordShortTOC}%
4842 \let\numchapentry = \shortchapentry
4843 \let\appentry = \shortchapentry
4844 \let\unnchapentry = \shortunnchapentry
4845 % We want a true roman here for the page numbers.
4846 \secfonts
4847 \let\rm=\shortcontrm \let\bf=\shortcontbf
4848 \let\sl=\shortcontsl \let\tt=\shortconttt
4850 \hyphenpenalty = 10000
4851 \advance\baselineskip by 1pt % Open it up a little.
4852 \def\numsecentry##1##2##3##4{}
4853 \let\appsecentry = \numsecentry
4854 \let\unnsecentry = \numsecentry
4855 \let\numsubsecentry = \numsecentry
4856 \let\appsubsecentry = \numsecentry
4857 \let\unnsubsecentry = \numsecentry
4858 \let\numsubsubsecentry = \numsecentry
4859 \let\appsubsubsecentry = \numsecentry
4860 \let\unnsubsubsecentry = \numsecentry
4861 \openin 1 \jobname.toc
4862 \ifeof 1 \else
4863 \readtocfile
4865 \closein 1
4866 \vfill \eject
4867 \contentsalignmacro % in case @setchapternewpage odd is in effect
4868 \endgroup
4869 \lastnegativepageno = \pageno
4870 \global\pageno = \savepageno
4872 \let\shortcontents = \summarycontents
4874 % Typeset the label for a chapter or appendix for the short contents.
4875 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4877 \def\shortchaplabel#1{%
4878 % This space should be enough, since a single number is .5em, and the
4879 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4880 % But use \hss just in case.
4881 % (This space doesn't include the extra space that gets added after
4882 % the label; that gets put in by \shortchapentry above.)
4884 % We'd like to right-justify chapter numbers, but that looks strange
4885 % with appendix letters. And right-justifying numbers and
4886 % left-justifying letters looks strange when there is less than 10
4887 % chapters. Have to read the whole toc once to know how many chapters
4888 % there are before deciding ...
4889 \hbox to 1em{#1\hss}%
4892 % These macros generate individual entries in the table of contents.
4893 % The first argument is the chapter or section name.
4894 % The last argument is the page number.
4895 % The arguments in between are the chapter number, section number, ...
4897 % Chapters, in the main contents.
4898 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4900 % Chapters, in the short toc.
4901 % See comments in \dochapentry re vbox and related settings.
4902 \def\shortchapentry#1#2#3#4{%
4903 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4906 % Appendices, in the main contents.
4907 % Need the word Appendix, and a fixed-size box.
4909 \def\appendixbox#1{%
4910 % We use M since it's probably the widest letter.
4911 \setbox0 = \hbox{\putwordAppendix{} M}%
4912 \hbox to \wd0{\putwordAppendix{} #1\hss}}
4914 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4916 % Unnumbered chapters.
4917 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4918 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4920 % Sections.
4921 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4922 \let\appsecentry=\numsecentry
4923 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4925 % Subsections.
4926 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4927 \let\appsubsecentry=\numsubsecentry
4928 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4930 % And subsubsections.
4931 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4932 \let\appsubsubsecentry=\numsubsubsecentry
4933 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4935 % This parameter controls the indentation of the various levels.
4936 % Same as \defaultparindent.
4937 \newdimen\tocindent \tocindent = 15pt
4939 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4940 % page number.
4942 % If the toc has to be broken over pages, we want it to be at chapters
4943 % if at all possible; hence the \penalty.
4944 \def\dochapentry#1#2{%
4945 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
4946 \begingroup
4947 \chapentryfonts
4948 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4949 \endgroup
4950 \nobreak\vskip .25\baselineskip plus.1\baselineskip
4953 \def\dosecentry#1#2{\begingroup
4954 \secentryfonts \leftskip=\tocindent
4955 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4956 \endgroup}
4958 \def\dosubsecentry#1#2{\begingroup
4959 \subsecentryfonts \leftskip=2\tocindent
4960 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4961 \endgroup}
4963 \def\dosubsubsecentry#1#2{\begingroup
4964 \subsubsecentryfonts \leftskip=3\tocindent
4965 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4966 \endgroup}
4968 % We use the same \entry macro as for the index entries.
4969 \let\tocentry = \entry
4971 % Space between chapter (or whatever) number and the title.
4972 \def\labelspace{\hskip1em \relax}
4974 \def\dopageno#1{{\rm #1}}
4975 \def\doshortpageno#1{{\rm #1}}
4977 \def\chapentryfonts{\secfonts \rm}
4978 \def\secentryfonts{\textfonts}
4979 \def\subsecentryfonts{\textfonts}
4980 \def\subsubsecentryfonts{\textfonts}
4983 \message{environments,}
4984 % @foo ... @end foo.
4986 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4988 % Since these characters are used in examples, it should be an even number of
4989 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4991 \def\point{$\star$}
4992 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
4993 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
4994 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
4995 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
4997 % The @error{} command.
4998 % Adapted from the TeXbook's \boxit.
5000 \newbox\errorbox
5002 {\tentt \global\dimen0 = 3em}% Width of the box.
5003 \dimen2 = .55pt % Thickness of rules
5004 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5005 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
5007 \setbox\errorbox=\hbox to \dimen0{\hfil
5008 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5009 \advance\hsize by -2\dimen2 % Rules.
5010 \vbox{%
5011 \hrule height\dimen2
5012 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5013 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5014 \kern3pt\vrule width\dimen2}% Space to right.
5015 \hrule height\dimen2}
5016 \hfil}
5018 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5020 % @tex ... @end tex escapes into raw Tex temporarily.
5021 % One exception: @ is still an escape character, so that @end tex works.
5022 % But \@ or @@ will get a plain tex @ character.
5024 \envdef\tex{%
5025 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5026 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5027 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5028 \catcode `\%=14
5029 \catcode `\+=\other
5030 \catcode `\"=\other
5031 \catcode `\|=\other
5032 \catcode `\<=\other
5033 \catcode `\>=\other
5034 \escapechar=`\\
5036 \let\b=\ptexb
5037 \let\bullet=\ptexbullet
5038 \let\c=\ptexc
5039 \let\,=\ptexcomma
5040 \let\.=\ptexdot
5041 \let\dots=\ptexdots
5042 \let\equiv=\ptexequiv
5043 \let\!=\ptexexclam
5044 \let\i=\ptexi
5045 \let\indent=\ptexindent
5046 \let\noindent=\ptexnoindent
5047 \let\{=\ptexlbrace
5048 \let\+=\tabalign
5049 \let\}=\ptexrbrace
5050 \let\/=\ptexslash
5051 \let\*=\ptexstar
5052 \let\t=\ptext
5053 \let\frenchspacing=\plainfrenchspacing
5055 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5056 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5057 \def\@{@}%
5059 % There is no need to define \Etex.
5061 % Define @lisp ... @end lisp.
5062 % @lisp environment forms a group so it can rebind things,
5063 % including the definition of @end lisp (which normally is erroneous).
5065 % Amount to narrow the margins by for @lisp.
5066 \newskip\lispnarrowing \lispnarrowing=0.4in
5068 % This is the definition that ^^M gets inside @lisp, @example, and other
5069 % such environments. \null is better than a space, since it doesn't
5070 % have any width.
5071 \def\lisppar{\null\endgraf}
5073 % This space is always present above and below environments.
5074 \newskip\envskipamount \envskipamount = 0pt
5076 % Make spacing and below environment symmetrical. We use \parskip here
5077 % to help in doing that, since in @example-like environments \parskip
5078 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5079 % start of the next paragraph will insert \parskip.
5081 \def\aboveenvbreak{{%
5082 % =10000 instead of <10000 because of a special case in \itemzzz and
5083 % \sectionheading, q.v.
5084 \ifnum \lastpenalty=10000 \else
5085 \advance\envskipamount by \parskip
5086 \endgraf
5087 \ifdim\lastskip<\envskipamount
5088 \removelastskip
5089 % it's not a good place to break if the last penalty was \nobreak
5090 % or better ...
5091 \ifnum\lastpenalty<10000 \penalty-50 \fi
5092 \vskip\envskipamount
5097 \let\afterenvbreak = \aboveenvbreak
5099 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5100 % also clear it, so that its embedded environments do the narrowing again.
5101 \let\nonarrowing=\relax
5103 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5104 % environment contents.
5105 \font\circle=lcircle10
5106 \newdimen\circthick
5107 \newdimen\cartouter\newdimen\cartinner
5108 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5109 \circthick=\fontdimen8\circle
5111 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5112 \def\ctr{{\hskip 6pt\circle\char'010}}
5113 \def\cbl{{\circle\char'012\hskip -6pt}}
5114 \def\cbr{{\hskip 6pt\circle\char'011}}
5115 \def\carttop{\hbox to \cartouter{\hskip\lskip
5116 \ctl\leaders\hrule height\circthick\hfil\ctr
5117 \hskip\rskip}}
5118 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5119 \cbl\leaders\hrule height\circthick\hfil\cbr
5120 \hskip\rskip}}
5122 \newskip\lskip\newskip\rskip
5124 \envdef\cartouche{%
5125 \ifhmode\par\fi % can't be in the midst of a paragraph.
5126 \startsavinginserts
5127 \lskip=\leftskip \rskip=\rightskip
5128 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5129 \cartinner=\hsize \advance\cartinner by-\lskip
5130 \advance\cartinner by-\rskip
5131 \cartouter=\hsize
5132 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5133 % side, and for 6pt waste from
5134 % each corner char, and rule thickness
5135 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5136 % Flag to tell @lisp, etc., not to narrow margin.
5137 \let\nonarrowing = t%
5138 \vbox\bgroup
5139 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5140 \carttop
5141 \hbox\bgroup
5142 \hskip\lskip
5143 \vrule\kern3pt
5144 \vbox\bgroup
5145 \kern3pt
5146 \hsize=\cartinner
5147 \baselineskip=\normbskip
5148 \lineskip=\normlskip
5149 \parskip=\normpskip
5150 \vskip -\parskip
5151 \comment % For explanation, see the end of \def\group.
5153 \def\Ecartouche{%
5154 \ifhmode\par\fi
5155 \kern3pt
5156 \egroup
5157 \kern3pt\vrule
5158 \hskip\rskip
5159 \egroup
5160 \cartbot
5161 \egroup
5162 \checkinserts
5166 % This macro is called at the beginning of all the @example variants,
5167 % inside a group.
5168 \def\nonfillstart{%
5169 \aboveenvbreak
5170 \hfuzz = 12pt % Don't be fussy
5171 \sepspaces % Make spaces be word-separators rather than space tokens.
5172 \let\par = \lisppar % don't ignore blank lines
5173 \obeylines % each line of input is a line of output
5174 \parskip = 0pt
5175 \parindent = 0pt
5176 \emergencystretch = 0pt % don't try to avoid overfull boxes
5177 \ifx\nonarrowing\relax
5178 \advance \leftskip by \lispnarrowing
5179 \exdentamount=\lispnarrowing
5180 \else
5181 \let\nonarrowing = \relax
5183 \let\exdent=\nofillexdent
5186 % If you want all examples etc. small: @set dispenvsize small.
5187 % If you want even small examples the full size: @set dispenvsize nosmall.
5188 % This affects the following displayed environments:
5189 % @example, @display, @format, @lisp
5191 \def\smallword{small}
5192 \def\nosmallword{nosmall}
5193 \let\SETdispenvsize\relax
5194 \def\setnormaldispenv{%
5195 \ifx\SETdispenvsize\smallword
5196 \smallexamplefonts \rm
5199 \def\setsmalldispenv{%
5200 \ifx\SETdispenvsize\nosmallword
5201 \else
5202 \smallexamplefonts \rm
5206 % We often define two environments, @foo and @smallfoo.
5207 % Let's do it by one command:
5208 \def\makedispenv #1#2{
5209 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5210 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5211 \expandafter\let\csname E#1\endcsname \afterenvbreak
5212 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5215 % Define two synonyms:
5216 \def\maketwodispenvs #1#2#3{
5217 \makedispenv{#1}{#3}
5218 \makedispenv{#2}{#3}
5221 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5223 % @smallexample and @smalllisp: use smaller fonts.
5224 % Originally contributed by Pavel@xerox.
5226 \maketwodispenvs {lisp}{example}{%
5227 \nonfillstart
5229 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5230 \gobble % eat return
5233 % @display/@smalldisplay: same as @lisp except keep current font.
5235 \makedispenv {display}{%
5236 \nonfillstart
5237 \gobble
5240 % @format/@smallformat: same as @display except don't narrow margins.
5242 \makedispenv{format}{%
5243 \let\nonarrowing = t%
5244 \nonfillstart
5245 \gobble
5248 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5249 \envdef\flushleft{%
5250 \let\nonarrowing = t%
5251 \nonfillstart
5252 \gobble
5254 \let\Eflushleft = \afterenvbreak
5256 % @flushright.
5258 \envdef\flushright{%
5259 \let\nonarrowing = t%
5260 \nonfillstart
5261 \advance\leftskip by 0pt plus 1fill
5262 \gobble
5264 \let\Eflushright = \afterenvbreak
5267 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5268 % and narrows the margins. We keep \parskip nonzero in general, since
5269 % we're doing normal filling. So, when using \aboveenvbreak and
5270 % \afterenvbreak, temporarily make \parskip 0.
5272 \envdef\quotation{%
5273 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5274 \parindent=0pt
5276 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5277 \ifx\nonarrowing\relax
5278 \advance\leftskip by \lispnarrowing
5279 \advance\rightskip by \lispnarrowing
5280 \exdentamount = \lispnarrowing
5281 \else
5282 \let\nonarrowing = \relax
5284 \parsearg\quotationlabel
5287 % We have retained a nonzero parskip for the environment, since we're
5288 % doing normal filling.
5290 \def\Equotation{%
5291 \par
5292 \ifx\quotationauthor\undefined\else
5293 % indent a bit.
5294 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5296 {\parskip=0pt \afterenvbreak}%
5299 % If we're given an argument, typeset it in bold with a colon after.
5300 \def\quotationlabel#1{%
5301 \def\temp{#1}%
5302 \ifx\temp\empty \else
5303 {\bf #1: }%
5308 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5309 % If we want to allow any <char> as delimiter,
5310 % we need the curly braces so that makeinfo sees the @verb command, eg:
5311 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5313 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5315 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5316 % active too. Otherwise, they get lost as the first character on a
5317 % verbatim line.
5318 \def\dospecials{%
5319 \do\ \do\\\do\{\do\}\do\$\do\&%
5320 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5321 \do\<\do\>\do\|\do\@\do+\do\"%
5324 % [Knuth] p. 380
5325 \def\uncatcodespecials{%
5326 \def\do##1{\catcode`##1=\other}\dospecials}
5328 % [Knuth] pp. 380,381,391
5329 % Disable Spanish ligatures ?` and !` of \tt font
5330 \begingroup
5331 \catcode`\`=\active\gdef`{\relax\lq}
5332 \endgroup
5334 % Setup for the @verb command.
5336 % Eight spaces for a tab
5337 \begingroup
5338 \catcode`\^^I=\active
5339 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5340 \endgroup
5342 \def\setupverb{%
5343 \tt % easiest (and conventionally used) font for verbatim
5344 \def\par{\leavevmode\endgraf}%
5345 \catcode`\`=\active
5346 \tabeightspaces
5347 % Respect line breaks,
5348 % print special symbols as themselves, and
5349 % make each space count
5350 % must do in this order:
5351 \obeylines \uncatcodespecials \sepspaces
5354 % Setup for the @verbatim environment
5356 % Real tab expansion
5357 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5359 \def\starttabbox{\setbox0=\hbox\bgroup}
5360 \begingroup
5361 \catcode`\^^I=\active
5362 \gdef\tabexpand{%
5363 \catcode`\^^I=\active
5364 \def^^I{\leavevmode\egroup
5365 \dimen0=\wd0 % the width so far, or since the previous tab
5366 \divide\dimen0 by\tabw
5367 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5368 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5369 \wd0=\dimen0 \box0 \starttabbox
5372 \endgroup
5373 \def\setupverbatim{%
5374 \let\nonarrowing = t%
5375 \nonfillstart
5376 % Easiest (and conventionally used) font for verbatim
5378 \def\par{\leavevmode\egroup\box0\endgraf}%
5379 \catcode`\`=\active
5380 \tabexpand
5381 % Respect line breaks,
5382 % print special symbols as themselves, and
5383 % make each space count
5384 % must do in this order:
5385 \obeylines \uncatcodespecials \sepspaces
5386 \everypar{\starttabbox}%
5389 % Do the @verb magic: verbatim text is quoted by unique
5390 % delimiter characters. Before first delimiter expect a
5391 % right brace, after last delimiter expect closing brace:
5393 % \def\doverb'{'<char>#1<char>'}'{#1}
5395 % [Knuth] p. 382; only eat outer {}
5396 \begingroup
5397 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5398 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5399 \endgroup
5401 \def\verb{\begingroup\setupverb\doverb}
5404 % Do the @verbatim magic: define the macro \doverbatim so that
5405 % the (first) argument ends when '@end verbatim' is reached, ie:
5407 % \def\doverbatim#1@end verbatim{#1}
5409 % For Texinfo it's a lot easier than for LaTeX,
5410 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5411 % we need not redefine '\', '{' and '}'.
5413 % Inspired by LaTeX's verbatim command set [latex.ltx]
5415 \begingroup
5416 \catcode`\ =\active
5417 \obeylines %
5418 % ignore everything up to the first ^^M, that's the newline at the end
5419 % of the @verbatim input line itself. Otherwise we get an extra blank
5420 % line in the output.
5421 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5422 % We really want {...\end verbatim} in the body of the macro, but
5423 % without the active space; thus we have to use \xdef and \gobble.
5424 \endgroup
5426 \envdef\verbatim{%
5427 \setupverbatim\doverbatim
5429 \let\Everbatim = \afterenvbreak
5432 % @verbatiminclude FILE - insert text of file in verbatim environment.
5434 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5436 \def\doverbatiminclude#1{%
5438 \makevalueexpandable
5439 \setupverbatim
5440 \input #1
5441 \afterenvbreak
5445 % @copying ... @end copying.
5446 % Save the text away for @insertcopying later.
5448 % We save the uninterpreted tokens, rather than creating a box.
5449 % Saving the text in a box would be much easier, but then all the
5450 % typesetting commands (@smallbook, font changes, etc.) have to be done
5451 % beforehand -- and a) we want @copying to be done first in the source
5452 % file; b) letting users define the frontmatter in as flexible order as
5453 % possible is very desirable.
5455 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5456 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5458 \def\insertcopying{%
5459 \begingroup
5460 \parindent = 0pt % paragraph indentation looks wrong on title page
5461 \scanexp\copyingtext
5462 \endgroup
5465 \message{defuns,}
5466 % @defun etc.
5468 \newskip\defbodyindent \defbodyindent=.4in
5469 \newskip\defargsindent \defargsindent=50pt
5470 \newskip\deflastargmargin \deflastargmargin=18pt
5472 % Start the processing of @deffn:
5473 \def\startdefun{%
5474 \ifnum\lastpenalty<10000
5475 \medbreak
5476 \else
5477 % If there are two @def commands in a row, we'll have a \nobreak,
5478 % which is there to keep the function description together with its
5479 % header. But if there's nothing but headers, we need to allow a
5480 % break somewhere. Check specifically for penalty 10002, inserted
5481 % by \defargscommonending, instead of 10000, since the sectioning
5482 % commands also insert a nobreak penalty, and we don't want to allow
5483 % a break between a section heading and a defun.
5485 \ifnum\lastpenalty=10002 \penalty2000 \fi
5487 % Similarly, after a section heading, do not allow a break.
5488 % But do insert the glue.
5489 \medskip % preceded by discardable penalty, so not a breakpoint
5492 \parindent=0in
5493 \advance\leftskip by \defbodyindent
5494 \exdentamount=\defbodyindent
5497 \def\dodefunx#1{%
5498 % First, check whether we are in the right environment:
5499 \checkenv#1%
5501 % As above, allow line break if we have multiple x headers in a row.
5502 % It's not a great place, though.
5503 \ifnum\lastpenalty=10002 \penalty3000 \fi
5505 % And now, it's time to reuse the body of the original defun:
5506 \expandafter\gobbledefun#1%
5508 \def\gobbledefun#1\startdefun{}
5510 % \printdefunline \deffnheader{text}
5512 \def\printdefunline#1#2{%
5513 \begingroup
5514 % call \deffnheader:
5515 #1#2 \endheader
5516 % common ending:
5517 \interlinepenalty = 10000
5518 \advance\rightskip by 0pt plus 1fil
5519 \endgraf
5520 \nobreak\vskip -\parskip
5521 \penalty 10002 % signal to \startdefun and \dodefunx
5522 % Some of the @defun-type tags do not enable magic parentheses,
5523 % rendering the following check redundant. But we don't optimize.
5524 \checkparencounts
5525 \endgroup
5528 \def\Edefun{\endgraf\medbreak}
5530 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5531 % the only thing remainnig is to define \deffnheader.
5533 \def\makedefun#1{%
5534 \expandafter\let\csname E#1\endcsname = \Edefun
5535 \edef\temp{\noexpand\domakedefun
5536 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5537 \temp
5540 % \domakedefun \deffn \deffnx \deffnheader
5542 % Define \deffn and \deffnx, without parameters.
5543 % \deffnheader has to be defined explicitly.
5545 \def\domakedefun#1#2#3{%
5546 \envdef#1{%
5547 \startdefun
5548 \parseargusing\activeparens{\printdefunline#3}%
5550 \def#2{\dodefunx#1}%
5551 \def#3%
5554 %%% Untyped functions:
5556 % @deffn category name args
5557 \makedefun{deffn}{\deffngeneral{}}
5559 % @deffn category class name args
5560 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5562 % \defopon {category on}class name args
5563 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5565 % \deffngeneral {subind}category name args
5567 \def\deffngeneral#1#2 #3 #4\endheader{%
5568 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5569 \dosubind{fn}{\code{#3}}{#1}%
5570 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5573 %%% Typed functions:
5575 % @deftypefn category type name args
5576 \makedefun{deftypefn}{\deftypefngeneral{}}
5578 % @deftypeop category class type name args
5579 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5581 % \deftypeopon {category on}class type name args
5582 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5584 % \deftypefngeneral {subind}category type name args
5586 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5587 \dosubind{fn}{\code{#4}}{#1}%
5588 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5591 %%% Typed variables:
5593 % @deftypevr category type var args
5594 \makedefun{deftypevr}{\deftypecvgeneral{}}
5596 % @deftypecv category class type var args
5597 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5599 % \deftypecvof {category of}class type var args
5600 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5602 % \deftypecvgeneral {subind}category type var args
5604 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5605 \dosubind{vr}{\code{#4}}{#1}%
5606 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5609 %%% Untyped variables:
5611 % @defvr category var args
5612 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5614 % @defcv category class var args
5615 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5617 % \defcvof {category of}class var args
5618 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5620 %%% Type:
5621 % @deftp category name args
5622 \makedefun{deftp}#1 #2 #3\endheader{%
5623 \doind{tp}{\code{#2}}%
5624 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5627 % Remaining @defun-like shortcuts:
5628 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5629 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5630 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5631 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5632 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5633 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5634 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5635 \makedefun{defmethod}{\defopon\putwordMethodon}
5636 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5637 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5638 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5640 % \defname, which formats the name of the @def (not the args).
5641 % #1 is the category, such as "Function".
5642 % #2 is the return type, if any.
5643 % #3 is the function name.
5645 % We are followed by (but not passed) the arguments, if any.
5647 \def\defname#1#2#3{%
5648 % Get the values of \leftskip and \rightskip as they were outside the @def...
5649 \advance\leftskip by -\defbodyindent
5651 % How we'll format the type name. Putting it in brackets helps
5652 % distinguish it from the body text that may end up on the next line
5653 % just below it.
5654 \def\temp{#1}%
5655 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5657 % Figure out line sizes for the paragraph shape.
5658 % The first line needs space for \box0; but if \rightskip is nonzero,
5659 % we need only space for the part of \box0 which exceeds it:
5660 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5661 % The continuations:
5662 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5663 % (plain.tex says that \dimen1 should be used only as global.)
5664 \parshape 2 0in \dimen0 \defargsindent \dimen2
5666 % Put the type name to the right margin.
5667 \noindent
5668 \hbox to 0pt{%
5669 \hfil\box0 \kern-\hsize
5670 % \hsize has to be shortened this way:
5671 \kern\leftskip
5672 % Intentionally do not respect \rightskip, since we need the space.
5675 % Allow all lines to be underfull without complaint:
5676 \tolerance=10000 \hbadness=10000
5677 \exdentamount=\defbodyindent
5679 % defun fonts. We use typewriter by default (used to be bold) because:
5680 % . we're printing identifiers, they should be in tt in principle.
5681 % . in languages with many accents, such as Czech or French, it's
5682 % common to leave accents off identifiers. The result looks ok in
5683 % tt, but exceedingly strange in rm.
5684 % . we don't want -- and --- to be treated as ligatures.
5685 % . this still does not fix the ?` and !` ligatures, but so far no
5686 % one has made identifiers using them :).
5687 \df \tt
5688 \def\temp{#2}% return value type
5689 \ifx\temp\empty\else \tclose{\temp} \fi
5690 #3% output function name
5692 {\rm\enskip}% hskip 0.5 em of \tenrm
5694 \boldbrax
5695 % arguments will be output next, if any.
5698 % Print arguments in slanted roman (not ttsl), inconsistently with using
5699 % tt for the name. This is because literal text is sometimes needed in
5700 % the argument list (groff manual), and ttsl and tt are not very
5701 % distinguishable. Prevent hyphenation at `-' chars.
5703 \def\defunargs#1{%
5704 % use sl by default (not ttsl),
5705 % tt for the names.
5706 \df \sl \hyphenchar\font=0
5708 % On the other hand, if an argument has two dashes (for instance), we
5709 % want a way to get ttsl. Let's try @var for that.
5710 \let\var=\ttslanted
5712 \sl\hyphenchar\font=45
5715 % We want ()&[] to print specially on the defun line.
5717 \def\activeparens{%
5718 \catcode`\(=\active \catcode`\)=\active
5719 \catcode`\[=\active \catcode`\]=\active
5720 \catcode`\&=\active
5723 % Make control sequences which act like normal parenthesis chars.
5724 \let\lparen = ( \let\rparen = )
5726 % Be sure that we always have a definition for `(', etc. For example,
5727 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5728 % so TeX would otherwise complain about undefined control sequence.
5730 \activeparens
5731 \global\let(=\lparen \global\let)=\rparen
5732 \global\let[=\lbrack \global\let]=\rbrack
5733 \global\let& = \&
5735 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5736 \gdef\magicamp{\let&=\amprm}
5739 \newcount\parencount
5741 % If we encounter &foo, then turn on ()-hacking afterwards
5742 \newif\ifampseen
5743 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5745 \def\parenfont{%
5746 \ifampseen
5747 % At the first level, print parens in roman,
5748 % otherwise use the default font.
5749 \ifnum \parencount=1 \rm \fi
5750 \else
5751 % The \sf parens (in \boldbrax) actually are a little bolder than
5752 % the contained text. This is especially needed for [ and ] .
5756 \def\infirstlevel#1{%
5757 \ifampseen
5758 \ifnum\parencount=1
5763 \def\bfafterword#1 {#1 \bf}
5765 \def\opnr{%
5766 \global\advance\parencount by 1
5767 {\parenfont(}%
5768 \infirstlevel \bfafterword
5770 \def\clnr{%
5771 {\parenfont)}%
5772 \infirstlevel \sl
5773 \global\advance\parencount by -1
5776 \newcount\brackcount
5777 \def\lbrb{%
5778 \global\advance\brackcount by 1
5779 {\bf[}%
5781 \def\rbrb{%
5782 {\bf]}%
5783 \global\advance\brackcount by -1
5786 \def\checkparencounts{%
5787 \ifnum\parencount=0 \else \badparencount \fi
5788 \ifnum\brackcount=0 \else \badbrackcount \fi
5790 \def\badparencount{%
5791 \errmessage{Unbalanced parentheses in @def}%
5792 \global\parencount=0
5794 \def\badbrackcount{%
5795 \errmessage{Unbalanced square braces in @def}%
5796 \global\brackcount=0
5800 \message{macros,}
5801 % @macro.
5803 % To do this right we need a feature of e-TeX, \scantokens,
5804 % which we arrange to emulate with a temporary file in ordinary TeX.
5805 \ifx\eTeXversion\undefined
5806 \newwrite\macscribble
5807 \def\scantokens#1{%
5808 \toks0={#1}%
5809 \immediate\openout\macscribble=\jobname.tmp
5810 \immediate\write\macscribble{\the\toks0}%
5811 \immediate\closeout\macscribble
5812 \input \jobname.tmp
5816 \def\scanmacro#1{%
5817 \begingroup
5818 \newlinechar`\^^M
5819 \let\xeatspaces\eatspaces
5820 % Undo catcode changes of \startcontents and \doprintindex
5821 % When called from @insertcopying or (short)caption, we need active
5822 % backslash to get it printed correctly. Previously, we had
5823 % \catcode`\\=\other instead. We'll see whether a problem appears
5824 % with macro expansion. --kasal, 19aug04
5825 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5826 % ... and \example
5827 \spaceisspace
5829 % Append \endinput to make sure that TeX does not see the ending newline.
5831 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5832 % --kasal, 29nov03
5833 \scantokens{#1\endinput}%
5834 \endgroup
5837 \def\scanexp#1{%
5838 \edef\temp{\noexpand\scanmacro{#1}}%
5839 \temp
5842 \newcount\paramno % Count of parameters
5843 \newtoks\macname % Macro name
5844 \newif\ifrecursive % Is it recursive?
5846 % List of all defined macros in the form
5847 % \definedummyword\macro1\definedummyword\macro2...
5848 % Currently is also contains all @aliases; the list can be split
5849 % if there is a need.
5850 \def\macrolist{}
5852 % Add the macro to \macrolist
5853 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5854 \def\addtomacrolistxxx#1{%
5855 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5856 \xdef\macrolist{\the\toks0}%
5859 % Utility routines.
5860 % This does \let #1 = #2, with \csnames; that is,
5861 % \let \csname#1\endcsname = \csname#2\endcsname
5862 % (except of course we have to play expansion games).
5864 \def\cslet#1#2{%
5865 \expandafter\let
5866 \csname#1\expandafter\endcsname
5867 \csname#2\endcsname
5870 % Trim leading and trailing spaces off a string.
5871 % Concepts from aro-bend problem 15 (see CTAN).
5872 {\catcode`\@=11
5873 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
5874 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
5875 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
5876 \def\unbrace#1{#1}
5877 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
5880 % Trim a single trailing ^^M off a string.
5881 {\catcode`\^^M=\other \catcode`\Q=3%
5882 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
5883 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
5884 \gdef\eatcrb#1Q#2Q{#1}%
5887 % Macro bodies are absorbed as an argument in a context where
5888 % all characters are catcode 10, 11 or 12, except \ which is active
5889 % (as in normal texinfo). It is necessary to change the definition of \.
5891 % It's necessary to have hard CRs when the macro is executed. This is
5892 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5893 % body, and then making it the \newlinechar in \scanmacro.
5895 \def\scanctxt{%
5896 \catcode`\"=\other
5897 \catcode`\+=\other
5898 \catcode`\<=\other
5899 \catcode`\>=\other
5900 \catcode`\@=\other
5901 \catcode`\^=\other
5902 \catcode`\_=\other
5903 \catcode`\|=\other
5904 \catcode`\~=\other
5907 \def\scanargctxt{%
5908 \scanctxt
5909 \catcode`\\=\other
5910 \catcode`\^^M=\other
5913 \def\macrobodyctxt{%
5914 \scanctxt
5915 \catcode`\{=\other
5916 \catcode`\}=\other
5917 \catcode`\^^M=\other
5918 \usembodybackslash
5921 \def\macroargctxt{%
5922 \scanctxt
5923 \catcode`\\=\other
5926 % \mbodybackslash is the definition of \ in @macro bodies.
5927 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5928 % where N is the macro parameter number.
5929 % We define \csname macarg.\endcsname to be \realbackslash, so
5930 % \\ in macro replacement text gets you a backslash.
5932 {\catcode`@=0 @catcode`@\=@active
5933 @gdef@usembodybackslash{@let\=@mbodybackslash}
5934 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
5936 \expandafter\def\csname macarg.\endcsname{\realbackslash}
5938 \def\macro{\recursivefalse\parsearg\macroxxx}
5939 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5941 \def\macroxxx#1{%
5942 \getargs{#1}% now \macname is the macname and \argl the arglist
5943 \ifx\argl\empty % no arguments
5944 \paramno=0%
5945 \else
5946 \expandafter\parsemargdef \argl;%
5948 \if1\csname ismacro.\the\macname\endcsname
5949 \message{Warning: redefining \the\macname}%
5950 \else
5951 \expandafter\ifx\csname \the\macname\endcsname \relax
5952 \else \errmessage{Macro name \the\macname\space already defined}\fi
5953 \global\cslet{macsave.\the\macname}{\the\macname}%
5954 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
5955 \addtomacrolist{\the\macname}%
5957 \begingroup \macrobodyctxt
5958 \ifrecursive \expandafter\parsermacbody
5959 \else \expandafter\parsemacbody
5960 \fi}
5962 \parseargdef\unmacro{%
5963 \if1\csname ismacro.#1\endcsname
5964 \global\cslet{#1}{macsave.#1}%
5965 \global\expandafter\let \csname ismacro.#1\endcsname=0%
5966 % Remove the macro name from \macrolist:
5967 \begingroup
5968 \expandafter\let\csname#1\endcsname \relax
5969 \let\definedummyword\unmacrodo
5970 \xdef\macrolist{\macrolist}%
5971 \endgroup
5972 \else
5973 \errmessage{Macro #1 not defined}%
5977 % Called by \do from \dounmacro on each macro. The idea is to omit any
5978 % macro definitions that have been changed to \relax.
5980 \def\unmacrodo#1{%
5981 \ifx #1\relax
5982 % remove this
5983 \else
5984 \noexpand\definedummyword \noexpand#1%
5988 % This makes use of the obscure feature that if the last token of a
5989 % <parameter list> is #, then the preceding argument is delimited by
5990 % an opening brace, and that opening brace is not consumed.
5991 \def\getargs#1{\getargsxxx#1{}}
5992 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
5993 \def\getmacname #1 #2\relax{\macname={#1}}
5994 \def\getmacargs#1{\def\argl{#1}}
5996 % Parse the optional {params} list. Set up \paramno and \paramlist
5997 % so \defmacro knows what to do. Define \macarg.blah for each blah
5998 % in the params list, to be ##N where N is the position in that list.
5999 % That gets used by \mbodybackslash (above).
6001 % We need to get `macro parameter char #' into several definitions.
6002 % The technique used is stolen from LaTeX: let \hash be something
6003 % unexpandable, insert that wherever you need a #, and then redefine
6004 % it to # just before using the token list produced.
6006 % The same technique is used to protect \eatspaces till just before
6007 % the macro is used.
6009 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6010 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6011 \def\parsemargdefxxx#1,{%
6012 \if#1;\let\next=\relax
6013 \else \let\next=\parsemargdefxxx
6014 \advance\paramno by 1%
6015 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6016 {\xeatspaces{\hash\the\paramno}}%
6017 \edef\paramlist{\paramlist\hash\the\paramno,}%
6018 \fi\next}
6020 % These two commands read recursive and nonrecursive macro bodies.
6021 % (They're different since rec and nonrec macros end differently.)
6023 \long\def\parsemacbody#1@end macro%
6024 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6025 \long\def\parsermacbody#1@end rmacro%
6026 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6028 % This defines the macro itself. There are six cases: recursive and
6029 % nonrecursive macros of zero, one, and many arguments.
6030 % Much magic with \expandafter here.
6031 % \xdef is used so that macro definitions will survive the file
6032 % they're defined in; @include reads the file inside a group.
6033 \def\defmacro{%
6034 \let\hash=##% convert placeholders to macro parameter chars
6035 \ifrecursive
6036 \ifcase\paramno
6038 \expandafter\xdef\csname\the\macname\endcsname{%
6039 \noexpand\scanmacro{\temp}}%
6040 \or % 1
6041 \expandafter\xdef\csname\the\macname\endcsname{%
6042 \bgroup\noexpand\macroargctxt
6043 \noexpand\braceorline
6044 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6045 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6046 \egroup\noexpand\scanmacro{\temp}}%
6047 \else % many
6048 \expandafter\xdef\csname\the\macname\endcsname{%
6049 \bgroup\noexpand\macroargctxt
6050 \noexpand\csname\the\macname xx\endcsname}%
6051 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6052 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6053 \expandafter\expandafter
6054 \expandafter\xdef
6055 \expandafter\expandafter
6056 \csname\the\macname xxx\endcsname
6057 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6059 \else
6060 \ifcase\paramno
6062 \expandafter\xdef\csname\the\macname\endcsname{%
6063 \noexpand\norecurse{\the\macname}%
6064 \noexpand\scanmacro{\temp}\egroup}%
6065 \or % 1
6066 \expandafter\xdef\csname\the\macname\endcsname{%
6067 \bgroup\noexpand\macroargctxt
6068 \noexpand\braceorline
6069 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6070 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6071 \egroup
6072 \noexpand\norecurse{\the\macname}%
6073 \noexpand\scanmacro{\temp}\egroup}%
6074 \else % many
6075 \expandafter\xdef\csname\the\macname\endcsname{%
6076 \bgroup\noexpand\macroargctxt
6077 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6078 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6079 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6080 \expandafter\expandafter
6081 \expandafter\xdef
6082 \expandafter\expandafter
6083 \csname\the\macname xxx\endcsname
6084 \paramlist{%
6085 \egroup
6086 \noexpand\norecurse{\the\macname}%
6087 \noexpand\scanmacro{\temp}\egroup}%
6089 \fi}
6091 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6093 % \braceorline decides whether the next nonwhitespace character is a
6094 % {. If so it reads up to the closing }, if not, it reads the whole
6095 % line. Whatever was read is then fed to the next control sequence
6096 % as an argument (by \parsebrace or \parsearg)
6097 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6098 \def\braceorlinexxx{%
6099 \ifx\nchar\bgroup\else
6100 \expandafter\parsearg
6101 \fi \macnamexxx}
6104 % @alias.
6105 % We need some trickery to remove the optional spaces around the equal
6106 % sign. Just make them active and then expand them all to nothing.
6107 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6108 \def\aliasxxx #1{\aliasyyy#1\relax}
6109 \def\aliasyyy #1=#2\relax{%
6111 \expandafter\let\obeyedspace=\empty
6112 \addtomacrolist{#1}%
6113 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6115 \next
6119 \message{cross references,}
6121 \newwrite\auxfile
6123 \newif\ifhavexrefs % True if xref values are known.
6124 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6126 % @inforef is relatively simple.
6127 \def\inforef #1{\inforefzzz #1,,,,**}
6128 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6129 node \samp{\ignorespaces#1{}}}
6131 % @node's only job in TeX is to define \lastnode, which is used in
6132 % cross-references. The @node line might or might not have commas, and
6133 % might or might not have spaces before the first comma, like:
6134 % @node foo , bar , ...
6135 % We don't want such trailing spaces in the node name.
6137 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6139 % also remove a trailing comma, in case of something like this:
6140 % @node Help-Cross, , , Cross-refs
6141 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6142 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6144 \let\nwnode=\node
6145 \let\lastnode=\empty
6147 % Write a cross-reference definition for the current node. #1 is the
6148 % type (Ynumbered, Yappendix, Ynothing).
6150 \def\donoderef#1{%
6151 \ifx\lastnode\empty\else
6152 \setref{\lastnode}{#1}%
6153 \global\let\lastnode=\empty
6157 % @anchor{NAME} -- define xref target at arbitrary point.
6159 \newcount\savesfregister
6161 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6162 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6163 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6165 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6166 % anchor), which consists of three parts:
6167 % 1) NAME-title - the current sectioning name taken from \thissection,
6168 % or the anchor name.
6169 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6170 % empty for anchors.
6171 % 3) NAME-pg - the page number.
6173 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6174 % floats, there is an additional part, which is not written here:
6175 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6177 \def\setref#1#2{%
6178 \pdfmkdest{#1}%
6179 \iflinks
6181 \atdummies % preserve commands, but don't expand them
6182 \edef\writexrdef##1##2{%
6183 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6184 ##1}{##2}}% these are parameters of \writexrdef
6186 \toks0 = \expandafter{\thissection}%
6187 \immediate \writexrdef{title}{\the\toks0 }%
6188 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6189 \writexrdef{pg}{\folio}% will be written later, during \shipout
6194 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6195 % the node name, #2 the name of the Info cross-reference, #3 the printed
6196 % node name, #4 the name of the Info file, #5 the name of the printed
6197 % manual. All but the node name can be omitted.
6199 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6200 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6201 \def\ref#1{\xrefX[#1,,,,,,,]}
6202 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6203 \unsepspaces
6204 \def\printedmanual{\ignorespaces #5}%
6205 \def\printedrefname{\ignorespaces #3}%
6206 \setbox1=\hbox{\printedmanual\unskip}%
6207 \setbox0=\hbox{\printedrefname\unskip}%
6208 \ifdim \wd0 = 0pt
6209 % No printed node name was explicitly given.
6210 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6211 % Use the node name inside the square brackets.
6212 \def\printedrefname{\ignorespaces #1}%
6213 \else
6214 % Use the actual chapter/section title appear inside
6215 % the square brackets. Use the real section title if we have it.
6216 \ifdim \wd1 > 0pt
6217 % It is in another manual, so we don't have it.
6218 \def\printedrefname{\ignorespaces #1}%
6219 \else
6220 \ifhavexrefs
6221 % We know the real title if we have the xref values.
6222 \def\printedrefname{\refx{#1-title}{}}%
6223 \else
6224 % Otherwise just copy the Info node name.
6225 \def\printedrefname{\ignorespaces #1}%
6226 \fi%
6231 % Make link in pdf output.
6232 \ifpdf
6233 \leavevmode
6234 \getfilename{#4}%
6235 {\turnoffactive
6236 % See comments at \activebackslashdouble.
6237 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6238 \backslashparens\pdfxrefdest}%
6240 \ifnum\filenamelength>0
6241 \startlink attr{/Border [0 0 0]}%
6242 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6243 \else
6244 \startlink attr{/Border [0 0 0]}%
6245 goto name{\pdfmkpgn{\pdfxrefdest}}%
6248 \linkcolor
6251 % Float references are printed completely differently: "Figure 1.2"
6252 % instead of "[somenode], p.3". We distinguish them by the
6253 % LABEL-title being set to a magic string.
6255 % Have to otherify everything special to allow the \csname to
6256 % include an _ in the xref name, etc.
6257 \indexnofonts
6258 \turnoffactive
6259 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6260 \csname XR#1-title\endcsname
6262 \iffloat\Xthisreftitle
6263 % If the user specified the print name (third arg) to the ref,
6264 % print it instead of our usual "Figure 1.2".
6265 \ifdim\wd0 = 0pt
6266 \refx{#1-snt}{}%
6267 \else
6268 \printedrefname
6271 % if the user also gave the printed manual name (fifth arg), append
6272 % "in MANUALNAME".
6273 \ifdim \wd1 > 0pt
6274 \space \putwordin{} \cite{\printedmanual}%
6276 \else
6277 % node/anchor (non-float) references.
6279 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6280 % insert empty discretionaries after hyphens, which means that it will
6281 % not find a line break at a hyphen in a node names. Since some manuals
6282 % are best written with fairly long node names, containing hyphens, this
6283 % is a loss. Therefore, we give the text of the node name again, so it
6284 % is as if TeX is seeing it for the first time.
6285 \ifdim \wd1 > 0pt
6286 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6287 \else
6288 % _ (for example) has to be the character _ for the purposes of the
6289 % control sequence corresponding to the node, but it has to expand
6290 % into the usual \leavevmode...\vrule stuff for purposes of
6291 % printing. So we \turnoffactive for the \refx-snt, back on for the
6292 % printing, back off for the \refx-pg.
6293 {\turnoffactive
6294 % Only output a following space if the -snt ref is nonempty; for
6295 % @unnumbered and @anchor, it won't be.
6296 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6297 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6299 % output the `[mynode]' via a macro so it can be overridden.
6300 \xrefprintnodename\printedrefname
6302 % But we always want a comma and a space:
6303 ,\space
6305 % output the `page 3'.
6306 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6309 \endlink
6310 \endgroup}
6312 % This macro is called from \xrefX for the `[nodename]' part of xref
6313 % output. It's a separate macro only so it can be changed more easily,
6314 % since square brackets don't work well in some documents. Particularly
6315 % one that Bob is working on :).
6317 \def\xrefprintnodename#1{[#1]}
6319 % Things referred to by \setref.
6321 \def\Ynothing{}
6322 \def\Yomitfromtoc{}
6323 \def\Ynumbered{%
6324 \ifnum\secno=0
6325 \putwordChapter@tie \the\chapno
6326 \else \ifnum\subsecno=0
6327 \putwordSection@tie \the\chapno.\the\secno
6328 \else \ifnum\subsubsecno=0
6329 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6330 \else
6331 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6332 \fi\fi\fi
6334 \def\Yappendix{%
6335 \ifnum\secno=0
6336 \putwordAppendix@tie @char\the\appendixno{}%
6337 \else \ifnum\subsecno=0
6338 \putwordSection@tie @char\the\appendixno.\the\secno
6339 \else \ifnum\subsubsecno=0
6340 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6341 \else
6342 \putwordSection@tie
6343 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6344 \fi\fi\fi
6347 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6348 % If its value is nonempty, SUFFIX is output afterward.
6350 \def\refx#1#2{%
6352 \indexnofonts
6353 \otherbackslash
6354 \expandafter\global\expandafter\let\expandafter\thisrefX
6355 \csname XR#1\endcsname
6357 \ifx\thisrefX\relax
6358 % If not defined, say something at least.
6359 \angleleft un\-de\-fined\angleright
6360 \iflinks
6361 \ifhavexrefs
6362 \message{\linenumber Undefined cross reference `#1'.}%
6363 \else
6364 \ifwarnedxrefs\else
6365 \global\warnedxrefstrue
6366 \message{Cross reference values unknown; you must run TeX again.}%
6370 \else
6371 % It's defined, so just use it.
6372 \thisrefX
6374 #2% Output the suffix in any case.
6377 % This is the macro invoked by entries in the aux file. Usually it's
6378 % just a \def (we prepend XR to the control sequence name to avoid
6379 % collisions). But if this is a float type, we have more work to do.
6381 \def\xrdef#1#2{%
6382 \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value.
6384 % Was that xref control sequence that we just defined for a float?
6385 \expandafter\iffloat\csname XR#1\endcsname
6386 % it was a float, and we have the (safe) float type in \iffloattype.
6387 \expandafter\let\expandafter\floatlist
6388 \csname floatlist\iffloattype\endcsname
6390 % Is this the first time we've seen this float type?
6391 \expandafter\ifx\floatlist\relax
6392 \toks0 = {\do}% yes, so just \do
6393 \else
6394 % had it before, so preserve previous elements in list.
6395 \toks0 = \expandafter{\floatlist\do}%
6398 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6399 % for later use in \listoffloats.
6400 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}%
6404 % Read the last existing aux file, if any. No error if none exists.
6406 \def\tryauxfile{%
6407 \openin 1 \jobname.aux
6408 \ifeof 1 \else
6409 \readdatafile{aux}%
6410 \global\havexrefstrue
6412 \closein 1
6415 \def\setupdatafile{%
6416 \catcode`\^^@=\other
6417 \catcode`\^^A=\other
6418 \catcode`\^^B=\other
6419 \catcode`\^^C=\other
6420 \catcode`\^^D=\other
6421 \catcode`\^^E=\other
6422 \catcode`\^^F=\other
6423 \catcode`\^^G=\other
6424 \catcode`\^^H=\other
6425 \catcode`\^^K=\other
6426 \catcode`\^^L=\other
6427 \catcode`\^^N=\other
6428 \catcode`\^^P=\other
6429 \catcode`\^^Q=\other
6430 \catcode`\^^R=\other
6431 \catcode`\^^S=\other
6432 \catcode`\^^T=\other
6433 \catcode`\^^U=\other
6434 \catcode`\^^V=\other
6435 \catcode`\^^W=\other
6436 \catcode`\^^X=\other
6437 \catcode`\^^Z=\other
6438 \catcode`\^^[=\other
6439 \catcode`\^^\=\other
6440 \catcode`\^^]=\other
6441 \catcode`\^^^=\other
6442 \catcode`\^^_=\other
6443 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6444 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6445 % supported in the main text, it doesn't seem desirable. Furthermore,
6446 % that is not enough: for node names that actually contain a ^
6447 % character, we would end up writing a line like this: 'xrdef {'hat
6448 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6449 % argument, and \hat is not an expandable control sequence. It could
6450 % all be worked out, but why? Either we support ^^ or we don't.
6452 % The other change necessary for this was to define \auxhat:
6453 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6454 % and then to call \auxhat in \setq.
6456 \catcode`\^=\other
6458 % Special characters. Should be turned off anyway, but...
6459 \catcode`\~=\other
6460 \catcode`\[=\other
6461 \catcode`\]=\other
6462 \catcode`\"=\other
6463 \catcode`\_=\other
6464 \catcode`\|=\other
6465 \catcode`\<=\other
6466 \catcode`\>=\other
6467 \catcode`\$=\other
6468 \catcode`\#=\other
6469 \catcode`\&=\other
6470 \catcode`\%=\other
6471 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6473 % This is to support \ in node names and titles, since the \
6474 % characters end up in a \csname. It's easier than
6475 % leaving it active and making its active definition an actual \
6476 % character. What I don't understand is why it works in the *value*
6477 % of the xrdef. Seems like it should be a catcode12 \, and that
6478 % should not typeset properly. But it works, so I'm moving on for
6479 % now. --karl, 15jan04.
6480 \catcode`\\=\other
6482 % Make the characters 128-255 be printing characters.
6484 \count1=128
6485 \def\loop{%
6486 \catcode\count1=\other
6487 \advance\count1 by 1
6488 \ifnum \count1<256 \loop \fi
6492 % @ is our escape character in .aux files, and we need braces.
6493 \catcode`\{=1
6494 \catcode`\}=2
6495 \catcode`\@=0
6498 \def\readdatafile#1{%
6499 \begingroup
6500 \setupdatafile
6501 \input\jobname.#1
6502 \endgroup}
6504 \message{insertions,}
6505 % including footnotes.
6507 \newcount \footnoteno
6509 % The trailing space in the following definition for supereject is
6510 % vital for proper filling; pages come out unaligned when you do a
6511 % pagealignmacro call if that space before the closing brace is
6512 % removed. (Generally, numeric constants should always be followed by a
6513 % space to prevent strange expansion errors.)
6514 \def\supereject{\par\penalty -20000\footnoteno =0 }
6516 % @footnotestyle is meaningful for info output only.
6517 \let\footnotestyle=\comment
6519 {\catcode `\@=11
6521 % Auto-number footnotes. Otherwise like plain.
6522 \gdef\footnote{%
6523 \let\indent=\ptexindent
6524 \let\noindent=\ptexnoindent
6525 \global\advance\footnoteno by \@ne
6526 \edef\thisfootno{$^{\the\footnoteno}$}%
6528 % In case the footnote comes at the end of a sentence, preserve the
6529 % extra spacing after we do the footnote number.
6530 \let\@sf\empty
6531 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6533 % Remove inadvertent blank space before typesetting the footnote number.
6534 \unskip
6535 \thisfootno\@sf
6536 \dofootnote
6539 % Don't bother with the trickery in plain.tex to not require the
6540 % footnote text as a parameter. Our footnotes don't need to be so general.
6542 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6543 % \parseargline) fails inside footnotes because the tokens are fixed when
6544 % the footnote is read. --karl, 16nov96.
6546 \gdef\dofootnote{%
6547 \insert\footins\bgroup
6548 % We want to typeset this text as a normal paragraph, even if the
6549 % footnote reference occurs in (for example) a display environment.
6550 % So reset some parameters.
6551 \hsize=\pagewidth
6552 \interlinepenalty\interfootnotelinepenalty
6553 \splittopskip\ht\strutbox % top baseline for broken footnotes
6554 \splitmaxdepth\dp\strutbox
6555 \floatingpenalty\@MM
6556 \leftskip\z@skip
6557 \rightskip\z@skip
6558 \spaceskip\z@skip
6559 \xspaceskip\z@skip
6560 \parindent\defaultparindent
6562 \smallfonts \rm
6564 % Because we use hanging indentation in footnotes, a @noindent appears
6565 % to exdent this text, so make it be a no-op. makeinfo does not use
6566 % hanging indentation so @noindent can still be needed within footnote
6567 % text after an @example or the like (not that this is good style).
6568 \let\noindent = \relax
6570 % Hang the footnote text off the number. Use \everypar in case the
6571 % footnote extends for more than one paragraph.
6572 \everypar = {\hang}%
6573 \textindent{\thisfootno}%
6575 % Don't crash into the line above the footnote text. Since this
6576 % expands into a box, it must come within the paragraph, lest it
6577 % provide a place where TeX can split the footnote.
6578 \footstrut
6579 \futurelet\next\fo@t
6581 }%end \catcode `\@=11
6583 % In case a @footnote appears in a vbox, save the footnote text and create
6584 % the real \insert just after the vbox finished. Otherwise, the insertion
6585 % would be lost.
6586 % Similarily, if a @footnote appears inside an alignment, save the footnote
6587 % text to a box and make the \insert when a row of the table is finished.
6588 % And the same can be done for other insert classes. --kasal, 16nov03.
6590 % Replace the \insert primitive by a cheating macro.
6591 % Deeper inside, just make sure that the saved insertions are not spilled
6592 % out prematurely.
6594 \def\startsavinginserts{%
6595 \ifx \insert\ptexinsert
6596 \let\insert\saveinsert
6597 \else
6598 \let\checkinserts\relax
6602 % This \insert replacement works for both \insert\footins{foo} and
6603 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6605 \def\saveinsert#1{%
6606 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6607 \afterassignment\next
6608 % swallow the left brace
6609 \let\temp =
6611 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6612 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6614 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6616 \def\placesaveins#1{%
6617 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6618 {\box#1}%
6621 % eat @SAVE -- beware, all of them have catcode \other:
6623 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6624 \gdef\gobblesave @SAVE{}
6627 % initialization:
6628 \def\newsaveins #1{%
6629 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6630 \next
6632 \def\newsaveinsX #1{%
6633 \csname newbox\endcsname #1%
6634 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6635 \checksaveins #1}%
6638 % initialize:
6639 \let\checkinserts\empty
6640 \newsaveins\footins
6641 \newsaveins\margin
6644 % @image. We use the macros from epsf.tex to support this.
6645 % If epsf.tex is not installed and @image is used, we complain.
6647 % Check for and read epsf.tex up front. If we read it only at @image
6648 % time, we might be inside a group, and then its definitions would get
6649 % undone and the next image would fail.
6650 \openin 1 = epsf.tex
6651 \ifeof 1 \else
6652 % Do not bother showing banner with epsf.tex v2.7k (available in
6653 % doc/epsf.tex and on ctan).
6654 \def\epsfannounce{\toks0 = }%
6655 \input epsf.tex
6657 \closein 1
6659 % We will only complain once about lack of epsf.tex.
6660 \newif\ifwarnednoepsf
6661 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6662 work. It is also included in the Texinfo distribution, or you can get
6663 it from ftp://tug.org/tex/epsf.tex.}
6665 \def\image#1{%
6666 \ifx\epsfbox\undefined
6667 \ifwarnednoepsf \else
6668 \errhelp = \noepsfhelp
6669 \errmessage{epsf.tex not found, images will be ignored}%
6670 \global\warnednoepsftrue
6672 \else
6673 \imagexxx #1,,,,,\finish
6677 % Arguments to @image:
6678 % #1 is (mandatory) image filename; we tack on .eps extension.
6679 % #2 is (optional) width, #3 is (optional) height.
6680 % #4 is (ignored optional) html alt text.
6681 % #5 is (ignored optional) extension.
6682 % #6 is just the usual extra ignored arg for parsing this stuff.
6683 \newif\ifimagevmode
6684 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6685 \catcode`\^^M = 5 % in case we're inside an example
6686 \normalturnoffactive % allow _ et al. in names
6687 % If the image is by itself, center it.
6688 \ifvmode
6689 \imagevmodetrue
6690 \nobreak\bigskip
6691 % Usually we'll have text after the image which will insert
6692 % \parskip glue, so insert it here too to equalize the space
6693 % above and below.
6694 \nobreak\vskip\parskip
6695 \nobreak
6696 \line\bgroup
6699 % Output the image.
6700 \ifpdf
6701 \dopdfimage{#1}{#2}{#3}%
6702 \else
6703 % \epsfbox itself resets \epsf?size at each figure.
6704 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6705 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6706 \epsfbox{#1.eps}%
6709 \ifimagevmode \egroup \bigbreak \fi % space after the image
6710 \endgroup}
6713 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6714 % etc. We don't actually implement floating yet, we always include the
6715 % float "here". But it seemed the best name for the future.
6717 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6719 % There may be a space before second and/or third parameter; delete it.
6720 \def\eatcommaspace#1, {#1,}
6722 % #1 is the optional FLOATTYPE, the text label for this float, typically
6723 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6724 % this float will not be numbered and cannot be referred to.
6726 % #2 is the optional xref label. Also must be present for the float to
6727 % be referable.
6729 % #3 is the optional positioning argument; for now, it is ignored. It
6730 % will somehow specify the positions allowed to float to (here, top, bottom).
6732 % We keep a separate counter for each FLOATTYPE, which we reset at each
6733 % chapter-level command.
6734 \let\resetallfloatnos=\empty
6736 \def\dofloat#1,#2,#3,#4\finish{%
6737 \let\thiscaption=\empty
6738 \let\thisshortcaption=\empty
6740 % don't lose footnotes inside @float.
6742 % BEWARE: when the floats start float, we have to issue warning whenever an
6743 % insert appears inside a float which could possibly float. --kasal, 26may04
6745 \startsavinginserts
6747 % We can't be used inside a paragraph.
6748 \par
6750 \vtop\bgroup
6751 \def\floattype{#1}%
6752 \def\floatlabel{#2}%
6753 \def\floatloc{#3}% we do nothing with this yet.
6755 \ifx\floattype\empty
6756 \let\safefloattype=\empty
6757 \else
6759 % the floattype might have accents or other special characters,
6760 % but we need to use it in a control sequence name.
6761 \indexnofonts
6762 \turnoffactive
6763 \xdef\safefloattype{\floattype}%
6767 % If label is given but no type, we handle that as the empty type.
6768 \ifx\floatlabel\empty \else
6769 % We want each FLOATTYPE to be numbered separately (Figure 1,
6770 % Table 1, Figure 2, ...). (And if no label, no number.)
6772 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6773 \global\advance\floatno by 1
6776 % This magic value for \thissection is output by \setref as the
6777 % XREFLABEL-title value. \xrefX uses it to distinguish float
6778 % labels (which have a completely different output format) from
6779 % node and anchor labels. And \xrdef uses it to construct the
6780 % lists of floats.
6782 \edef\thissection{\floatmagic=\safefloattype}%
6783 \setref{\floatlabel}{Yfloat}%
6787 % start with \parskip glue, I guess.
6788 \vskip\parskip
6790 % Don't suppress indentation if a float happens to start a section.
6791 \restorefirstparagraphindent
6794 % we have these possibilities:
6795 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6796 % @float Foo,lbl & no caption: Foo 1.1
6797 % @float Foo & @caption{Cap}: Foo: Cap
6798 % @float Foo & no caption: Foo
6799 % @float ,lbl & Caption{Cap}: 1.1: Cap
6800 % @float ,lbl & no caption: 1.1
6801 % @float & @caption{Cap}: Cap
6802 % @float & no caption:
6804 \def\Efloat{%
6805 \let\floatident = \empty
6807 % In all cases, if we have a float type, it comes first.
6808 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6810 % If we have an xref label, the number comes next.
6811 \ifx\floatlabel\empty \else
6812 \ifx\floattype\empty \else % if also had float type, need tie first.
6813 \appendtomacro\floatident{\tie}%
6815 % the number.
6816 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6819 % Start the printed caption with what we've constructed in
6820 % \floatident, but keep it separate; we need \floatident again.
6821 \let\captionline = \floatident
6823 \ifx\thiscaption\empty \else
6824 \ifx\floatident\empty \else
6825 \appendtomacro\captionline{: }% had ident, so need a colon between
6828 % caption text.
6829 \appendtomacro\captionline{\scanexp\thiscaption}%
6832 % If we have anything to print, print it, with space before.
6833 % Eventually this needs to become an \insert.
6834 \ifx\captionline\empty \else
6835 \vskip.5\parskip
6836 \captionline
6838 % Space below caption.
6839 \vskip\parskip
6842 % If have an xref label, write the list of floats info. Do this
6843 % after the caption, to avoid chance of it being a breakpoint.
6844 \ifx\floatlabel\empty \else
6845 % Write the text that goes in the lof to the aux file as
6846 % \floatlabel-lof. Besides \floatident, we include the short
6847 % caption if specified, else the full caption if specified, else nothing.
6849 \atdummies
6851 % since we read the caption text in the macro world, where ^^M
6852 % is turned into a normal character, we have to scan it back, so
6853 % we don't write the literal three characters "^^M" into the aux file.
6854 \scanexp{%
6855 \xdef\noexpand\gtemp{%
6856 \ifx\thisshortcaption\empty
6857 \thiscaption
6858 \else
6859 \thisshortcaption
6863 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
6864 \ifx\gtemp\empty \else : \gtemp \fi}}%
6867 \egroup % end of \vtop
6869 % place the captured inserts
6871 % BEWARE: when the floats start floating, we have to issue warning
6872 % whenever an insert appears inside a float which could possibly
6873 % float. --kasal, 26may04
6875 \checkinserts
6878 % Append the tokens #2 to the definition of macro #1, not expanding either.
6880 \def\appendtomacro#1#2{%
6881 \expandafter\def\expandafter#1\expandafter{#1#2}%
6884 % @caption, @shortcaption
6886 \def\caption{\docaption\thiscaption}
6887 \def\shortcaption{\docaption\thisshortcaption}
6888 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
6889 \def\defcaption#1#2{\egroup \def#1{#2}}
6891 % The parameter is the control sequence identifying the counter we are
6892 % going to use. Create it if it doesn't exist and assign it to \floatno.
6893 \def\getfloatno#1{%
6894 \ifx#1\relax
6895 % Haven't seen this figure type before.
6896 \csname newcount\endcsname #1%
6898 % Remember to reset this floatno at the next chap.
6899 \expandafter\gdef\expandafter\resetallfloatnos
6900 \expandafter{\resetallfloatnos #1=0 }%
6902 \let\floatno#1%
6905 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6906 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6907 % first read the @float command.
6909 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
6911 % Magic string used for the XREFLABEL-title value, so \xrefX can
6912 % distinguish floats from other xref types.
6913 \def\floatmagic{!!float!!}
6915 % #1 is the control sequence we are passed; we expand into a conditional
6916 % which is true if #1 represents a float ref. That is, the magic
6917 % \thissection value which we \setref above.
6919 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
6921 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6922 % (safe) float type for this float. We set \iffloattype to #2.
6924 \def\doiffloat#1=#2=#3\finish{%
6925 \def\temp{#1}%
6926 \def\iffloattype{#2}%
6927 \ifx\temp\floatmagic
6930 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6932 \parseargdef\listoffloats{%
6933 \def\floattype{#1}% floattype
6935 % the floattype might have accents or other special characters,
6936 % but we need to use it in a control sequence name.
6937 \indexnofonts
6938 \turnoffactive
6939 \xdef\safefloattype{\floattype}%
6942 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6943 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
6944 \ifhavexrefs
6945 % if the user said @listoffloats foo but never @float foo.
6946 \message{\linenumber No `\safefloattype' floats to list.}%
6948 \else
6949 \begingroup
6950 \leftskip=\tocindent % indent these entries like a toc
6951 \let\do=\listoffloatsdo
6952 \csname floatlist\safefloattype\endcsname
6953 \endgroup
6957 % This is called on each entry in a list of floats. We're passed the
6958 % xref label, in the form LABEL-title, which is how we save it in the
6959 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6960 % has the text we're supposed to typeset here.
6962 % Figures without xref labels will not be included in the list (since
6963 % they won't appear in the aux file).
6965 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6966 \def\listoffloatsdoentry#1-title\finish{{%
6967 % Can't fully expand XR#1-lof because it can contain anything. Just
6968 % pass the control sequence. On the other hand, XR#1-pg is just the
6969 % page number, and we want to fully expand that so we can get a link
6970 % in pdf output.
6971 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
6973 % use the same \entry macro we use to generate the TOC and index.
6974 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
6975 \writeentry
6978 \message{localization,}
6979 % and i18n.
6981 % @documentlanguage is usually given very early, just after
6982 % @setfilename. If done too late, it may not override everything
6983 % properly. Single argument is the language abbreviation.
6984 % It would be nice if we could set up a hyphenation file here.
6986 \parseargdef\documentlanguage{%
6987 \tex % read txi-??.tex file in plain TeX.
6988 % Read the file if it exists.
6989 \openin 1 txi-#1.tex
6990 \ifeof 1
6991 \errhelp = \nolanghelp
6992 \errmessage{Cannot read language file txi-#1.tex}%
6993 \else
6994 \input txi-#1.tex
6996 \closein 1
6997 \endgroup
6999 \newhelp\nolanghelp{The given language definition file cannot be found or
7000 is empty. Maybe you need to install it? In the current directory
7001 should work if nowhere else does.}
7004 % @documentencoding should change something in TeX eventually, most
7005 % likely, but for now just recognize it.
7006 \let\documentencoding = \comment
7009 % Page size parameters.
7011 \newdimen\defaultparindent \defaultparindent = 15pt
7013 \chapheadingskip = 15pt plus 4pt minus 2pt
7014 \secheadingskip = 12pt plus 3pt minus 2pt
7015 \subsecheadingskip = 9pt plus 2pt minus 2pt
7017 % Prevent underfull vbox error messages.
7018 \vbadness = 10000
7020 % Don't be so finicky about underfull hboxes, either.
7021 \hbadness = 2000
7023 % Following George Bush, just get rid of widows and orphans.
7024 \widowpenalty=10000
7025 \clubpenalty=10000
7027 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7028 % using an old version of TeX, don't do anything. We want the amount of
7029 % stretch added to depend on the line length, hence the dependence on
7030 % \hsize. We call this whenever the paper size is set.
7032 \def\setemergencystretch{%
7033 \ifx\emergencystretch\thisisundefined
7034 % Allow us to assign to \emergencystretch anyway.
7035 \def\emergencystretch{\dimen0}%
7036 \else
7037 \emergencystretch = .15\hsize
7041 % Parameters in order: 1) textheight; 2) textwidth;
7042 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
7043 % 7) physical page height; 8) physical page width.
7045 % We also call \setleading{\textleading}, so the caller should define
7046 % \textleading. The caller should also set \parskip.
7048 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
7049 \voffset = #3\relax
7050 \topskip = #6\relax
7051 \splittopskip = \topskip
7053 \vsize = #1\relax
7054 \advance\vsize by \topskip
7055 \outervsize = \vsize
7056 \advance\outervsize by 2\topandbottommargin
7057 \pageheight = \vsize
7059 \hsize = #2\relax
7060 \outerhsize = \hsize
7061 \advance\outerhsize by 0.5in
7062 \pagewidth = \hsize
7064 \normaloffset = #4\relax
7065 \bindingoffset = #5\relax
7067 \ifpdf
7068 \pdfpageheight #7\relax
7069 \pdfpagewidth #8\relax
7072 \setleading{\textleading}
7074 \parindent = \defaultparindent
7075 \setemergencystretch
7078 % @letterpaper (the default).
7079 \def\letterpaper{{\globaldefs = 1
7080 \parskip = 3pt plus 2pt minus 1pt
7081 \textleading = 13.2pt
7083 % If page is nothing but text, make it come out even.
7084 \internalpagesizes{46\baselineskip}{6in}%
7085 {\voffset}{.25in}%
7086 {\bindingoffset}{36pt}%
7087 {11in}{8.5in}%
7090 % Use @smallbook to reset parameters for 7x9.25 trim size.
7091 \def\smallbook{{\globaldefs = 1
7092 \parskip = 2pt plus 1pt
7093 \textleading = 12pt
7095 \internalpagesizes{7.5in}{5in}%
7096 {\voffset}{.25in}%
7097 {\bindingoffset}{16pt}%
7098 {9.25in}{7in}%
7100 \lispnarrowing = 0.3in
7101 \tolerance = 700
7102 \hfuzz = 1pt
7103 \contentsrightmargin = 0pt
7104 \defbodyindent = .5cm
7107 % Use @smallerbook to reset parameters for 6x9 trim size.
7108 % (Just testing, parameters still in flux.)
7109 \def\smallerbook{{\globaldefs = 1
7110 \parskip = 1.5pt plus 1pt
7111 \textleading = 12pt
7113 \internalpagesizes{7.4in}{4.8in}%
7114 {-.2in}{-.4in}%
7115 {0pt}{14pt}%
7116 {9in}{6in}%
7118 \lispnarrowing = 0.25in
7119 \tolerance = 700
7120 \hfuzz = 1pt
7121 \contentsrightmargin = 0pt
7122 \defbodyindent = .4cm
7125 % Use @afourpaper to print on European A4 paper.
7126 \def\afourpaper{{\globaldefs = 1
7127 \parskip = 3pt plus 2pt minus 1pt
7128 \textleading = 13.2pt
7130 % Double-side printing via postscript on Laserjet 4050
7131 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7132 % To change the settings for a different printer or situation, adjust
7133 % \normaloffset until the front-side and back-side texts align. Then
7134 % do the same for \bindingoffset. You can set these for testing in
7135 % your texinfo source file like this:
7136 % @tex
7137 % \global\normaloffset = -6mm
7138 % \global\bindingoffset = 10mm
7139 % @end tex
7140 \internalpagesizes{51\baselineskip}{160mm}
7141 {\voffset}{\hoffset}%
7142 {\bindingoffset}{44pt}%
7143 {297mm}{210mm}%
7145 \tolerance = 700
7146 \hfuzz = 1pt
7147 \contentsrightmargin = 0pt
7148 \defbodyindent = 5mm
7151 % Use @afivepaper to print on European A5 paper.
7152 % From romildo@urano.iceb.ufop.br, 2 July 2000.
7153 % He also recommends making @example and @lisp be small.
7154 \def\afivepaper{{\globaldefs = 1
7155 \parskip = 2pt plus 1pt minus 0.1pt
7156 \textleading = 12.5pt
7158 \internalpagesizes{160mm}{120mm}%
7159 {\voffset}{\hoffset}%
7160 {\bindingoffset}{8pt}%
7161 {210mm}{148mm}%
7163 \lispnarrowing = 0.2in
7164 \tolerance = 800
7165 \hfuzz = 1.2pt
7166 \contentsrightmargin = 0pt
7167 \defbodyindent = 2mm
7168 \tableindent = 12mm
7171 % A specific text layout, 24x15cm overall, intended for A4 paper.
7172 \def\afourlatex{{\globaldefs = 1
7173 \afourpaper
7174 \internalpagesizes{237mm}{150mm}%
7175 {\voffset}{4.6mm}%
7176 {\bindingoffset}{7mm}%
7177 {297mm}{210mm}%
7179 % Must explicitly reset to 0 because we call \afourpaper.
7180 \globaldefs = 0
7183 % Use @afourwide to print on A4 paper in landscape format.
7184 \def\afourwide{{\globaldefs = 1
7185 \afourpaper
7186 \internalpagesizes{241mm}{165mm}%
7187 {\voffset}{-2.95mm}%
7188 {\bindingoffset}{7mm}%
7189 {297mm}{210mm}%
7190 \globaldefs = 0
7193 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7194 % Perhaps we should allow setting the margins, \topskip, \parskip,
7195 % and/or leading, also. Or perhaps we should compute them somehow.
7197 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7198 \def\pagesizesyyy#1,#2,#3\finish{{%
7199 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7200 \globaldefs = 1
7202 \parskip = 3pt plus 2pt minus 1pt
7203 \setleading{\textleading}%
7205 \dimen0 = #1
7206 \advance\dimen0 by \voffset
7208 \dimen2 = \hsize
7209 \advance\dimen2 by \normaloffset
7211 \internalpagesizes{#1}{\hsize}%
7212 {\voffset}{\normaloffset}%
7213 {\bindingoffset}{44pt}%
7214 {\dimen0}{\dimen2}%
7217 % Set default to letter.
7219 \letterpaper
7222 \message{and turning on texinfo input format.}
7224 % Define macros to output various characters with catcode for normal text.
7225 \catcode`\"=\other
7226 \catcode`\~=\other
7227 \catcode`\^=\other
7228 \catcode`\_=\other
7229 \catcode`\|=\other
7230 \catcode`\<=\other
7231 \catcode`\>=\other
7232 \catcode`\+=\other
7233 \catcode`\$=\other
7234 \def\normaldoublequote{"}
7235 \def\normaltilde{~}
7236 \def\normalcaret{^}
7237 \def\normalunderscore{_}
7238 \def\normalverticalbar{|}
7239 \def\normalless{<}
7240 \def\normalgreater{>}
7241 \def\normalplus{+}
7242 \def\normaldollar{$}%$ font-lock fix
7244 % This macro is used to make a character print one way in \tt
7245 % (where it can probably be output as-is), and another way in other fonts,
7246 % where something hairier probably needs to be done.
7248 % #1 is what to print if we are indeed using \tt; #2 is what to print
7249 % otherwise. Since all the Computer Modern typewriter fonts have zero
7250 % interword stretch (and shrink), and it is reasonable to expect all
7251 % typewriter fonts to have this, we can check that font parameter.
7253 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7255 % Same as above, but check for italic font. Actually this also catches
7256 % non-italic slanted fonts since it is impossible to distinguish them from
7257 % italic fonts. But since this is only used by $ and it uses \sl anyway
7258 % this is not a problem.
7259 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7261 % Turn off all special characters except @
7262 % (and those which the user can use as if they were ordinary).
7263 % Most of these we simply print from the \tt font, but for some, we can
7264 % use math or other variants that look better in normal text.
7266 \catcode`\"=\active
7267 \def\activedoublequote{{\tt\char34}}
7268 \let"=\activedoublequote
7269 \catcode`\~=\active
7270 \def~{{\tt\char126}}
7271 \chardef\hat=`\^
7272 \catcode`\^=\active
7273 \def^{{\tt \hat}}
7275 \catcode`\_=\active
7276 \def_{\ifusingtt\normalunderscore\_}
7277 \let\realunder=_
7278 % Subroutine for the previous macro.
7279 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7281 \catcode`\|=\active
7282 \def|{{\tt\char124}}
7283 \chardef \less=`\<
7284 \catcode`\<=\active
7285 \def<{{\tt \less}}
7286 \chardef \gtr=`\>
7287 \catcode`\>=\active
7288 \def>{{\tt \gtr}}
7289 \catcode`\+=\active
7290 \def+{{\tt \char 43}}
7291 \catcode`\$=\active
7292 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7294 % If a .fmt file is being used, characters that might appear in a file
7295 % name cannot be active until we have parsed the command line.
7296 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7297 % \otherifyactive is called near the end of this file.
7298 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7300 % Used sometimes to turn off (effectively) the active characters even after
7301 % parsing them.
7302 \def\turnoffactive{%
7303 \normalturnoffactive
7304 \otherbackslash
7307 \catcode`\@=0
7309 % \backslashcurfont outputs one backslash character in current font,
7310 % as in \char`\\.
7311 \global\chardef\backslashcurfont=`\\
7312 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7314 % \realbackslash is an actual character `\' with catcode other, and
7315 % \doublebackslash is two of them (for the pdf outlines).
7316 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7318 % In texinfo, backslash is an active character; it prints the backslash
7319 % in fixed width font.
7320 \catcode`\\=\active
7321 @def@normalbackslash{{@tt@backslashcurfont}}
7322 % On startup, @fixbackslash assigns:
7323 % @let \ = @normalbackslash
7325 % \rawbackslash defines an active \ to do \backslashcurfont.
7326 % \otherbackslash defines an active \ to be a literal `\' character with
7327 % catcode other.
7328 @gdef@rawbackslash{@let\=@backslashcurfont}
7329 @gdef@otherbackslash{@let\=@realbackslash}
7331 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7332 % the literal character `\'.
7334 @def@normalturnoffactive{%
7335 @let\=@normalbackslash
7336 @let"=@normaldoublequote
7337 @let~=@normaltilde
7338 @let^=@normalcaret
7339 @let_=@normalunderscore
7340 @let|=@normalverticalbar
7341 @let<=@normalless
7342 @let>=@normalgreater
7343 @let+=@normalplus
7344 @let$=@normaldollar %$ font-lock fix
7345 @unsepspaces
7348 % Make _ and + \other characters, temporarily.
7349 % This is canceled by @fixbackslash.
7350 @otherifyactive
7352 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7353 % That is what \eatinput is for; after that, the `\' should revert to printing
7354 % a backslash.
7356 @gdef@eatinput input texinfo{@fixbackslash}
7357 @global@let\ = @eatinput
7359 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7360 % the first `\' in the file would cause an error. This macro tries to fix
7361 % that, assuming it is called before the first `\' could plausibly occur.
7362 % Also turn back on active characters that might appear in the input
7363 % file name, in case not using a pre-dumped format.
7365 @gdef@fixbackslash{%
7366 @ifx\@eatinput @let\ = @normalbackslash @fi
7367 @catcode`+=@active
7368 @catcode`@_=@active
7371 % Say @foo, not \foo, in error messages.
7372 @escapechar = `@@
7374 % These look ok in all fonts, so just make them not special.
7375 @catcode`@& = @other
7376 @catcode`@# = @other
7377 @catcode`@% = @other
7380 @c Local variables:
7381 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7382 @c page-delimiter: "^\\\\message"
7383 @c time-stamp-start: "def\\\\texinfoversion{"
7384 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7385 @c time-stamp-end: "}"
7386 @c End:
7388 @c vim:sw=2:
7390 @ignore
7391 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
7392 @end ignore