fixed fonts
[cinelerra_cv/ct.git] / doc / texinfo.tex
blob5df52a61a1a235862731d495b260870f8a3cbbe8
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-12-23.12}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10 % Software Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING. If not, write
24 % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, USA.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 % ftp://tug.org/tex/texinfo.tex
35 % (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
46 % tex foo.texi
47 % texindex foo.??
48 % tex foo.texi
49 % tex foo.texi
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
70 \message{Basics,}
71 \chardef\other=12
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexrbrace=\}
99 \let\ptexslash=\/
100 \let\ptexstar=\*
101 \let\ptext=\t
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
105 \newlinechar = `^^J
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
112 \else
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\colonChar = `\:
162 \chardef\commaChar = `\,
163 \chardef\dashChar = `\-
164 \chardef\dotChar = `\.
165 \chardef\exclamChar= `\!
166 \chardef\lquoteChar= `\`
167 \chardef\questChar = `\?
168 \chardef\rquoteChar= `\'
169 \chardef\semiChar = `\;
170 \chardef\underChar = `\_
172 % Ignore a token.
174 \def\gobble#1{}
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
179 % Hyphenation fixes.
180 \hyphenation{
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 spell-ing spell-ings
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
191 % Margin to add to right of even pages, to left of odd pages.
192 \newdimen\bindingoffset
193 \newdimen\normaloffset
194 \newdimen\pagewidth \newdimen\pageheight
196 % For a final copy, take out the rectangles
197 % that mark overfull boxes (in case you have decided
198 % that the text looks ok even though it passes the margin).
200 \def\finalout{\overfullrule=0pt}
202 % @| inserts a changebar to the left of the current line. It should
203 % surround any changed text. This approach does *not* work if the
204 % change spans more than two lines of output. To handle that, we would
205 % have adopt a much more difficult approach (putting marks into the main
206 % vertical list for the beginning and end of each change).
208 \def\|{%
209 % \vadjust can only be used in horizontal mode.
210 \leavevmode
212 % Append this vertical mode material after the current line in the output.
213 \vadjust{%
214 % We want to insert a rule with the height and depth of the current
215 % leading; that is exactly what \strutbox is supposed to record.
216 \vskip-\baselineskip
218 % \vadjust-items are inserted at the left edge of the type. So
219 % the \llap here moves out into the left-hand margin.
220 \llap{%
222 % For a thicker or thinner bar, change the `1pt'.
223 \vrule height\baselineskip width1pt
225 % This is the space between the bar and the text.
226 \hskip 12pt
231 % Sometimes it is convenient to have everything in the transcript file
232 % and nothing on the terminal. We don't just call \tracingall here,
233 % since that produces some useless output on the terminal. We also make
234 % some effort to order the tracing commands to reduce output in the log
235 % file; cf. trace.sty in LaTeX.
237 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
238 \def\loggingall{%
239 \tracingstats2
240 \tracingpages1
241 \tracinglostchars2 % 2 gives us more in etex
242 \tracingparagraphs1
243 \tracingoutput1
244 \tracingmacros2
245 \tracingrestores1
246 \showboxbreadth\maxdimen \showboxdepth\maxdimen
247 \ifx\eTeXversion\undefined\else % etex gives us more logging
248 \tracingscantokens1
249 \tracingifs1
250 \tracinggroups1
251 \tracingnesting2
252 \tracingassigns1
254 \tracingcommands3 % 3 gives us more in etex
255 \errorcontextlines16
258 % add check for \lastpenalty to plain's definitions. If the last thing
259 % we did was a \nobreak, we don't want to insert more space.
261 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
262 \removelastskip\penalty-50\smallskip\fi\fi}
263 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
264 \removelastskip\penalty-100\medskip\fi\fi}
265 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
266 \removelastskip\penalty-200\bigskip\fi\fi}
268 % For @cropmarks command.
269 % Do @cropmarks to get crop marks.
271 \newif\ifcropmarks
272 \let\cropmarks = \cropmarkstrue
274 % Dimensions to add cropmarks at corners.
275 % Added by P. A. MacKay, 12 Nov. 1986
277 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
278 \newdimen\cornerlong \cornerlong=1pc
279 \newdimen\cornerthick \cornerthick=.3pt
280 \newdimen\topandbottommargin \topandbottommargin=.75in
282 % Main output routine.
283 \chardef\PAGE = 255
284 \output = {\onepageout{\pagecontents\PAGE}}
286 \newbox\headlinebox
287 \newbox\footlinebox
289 % \onepageout takes a vbox as an argument. Note that \pagecontents
290 % does insertions, but you have to call it yourself.
291 \def\onepageout#1{%
292 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
294 \ifodd\pageno \advance\hoffset by \bindingoffset
295 \else \advance\hoffset by -\bindingoffset\fi
297 % Do this outside of the \shipout so @code etc. will be expanded in
298 % the headline as they should be, not taken literally (outputting ''code).
299 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
300 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
303 % Have to do this stuff outside the \shipout because we want it to
304 % take effect in \write's, yet the group defined by the \vbox ends
305 % before the \shipout runs.
307 \indexdummies % don't expand commands in the output.
308 \normalturnoffactive % \ in index entries must not stay \, e.g., if
309 % the page break happens to be in the middle of an example.
310 % We don't want .vr (or whatever) entries like this:
311 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
312 % "\acronym" won't work when it's read back in;
313 % it needs to be
314 % {\code {{\tt \backslashcurfont }acronym}
315 \shipout\vbox{%
316 % Do this early so pdf references go to the beginning of the page.
317 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
319 \ifcropmarks \vbox to \outervsize\bgroup
320 \hsize = \outerhsize
321 \vskip-\topandbottommargin
322 \vtop to0pt{%
323 \line{\ewtop\hfil\ewtop}%
324 \nointerlineskip
325 \line{%
326 \vbox{\moveleft\cornerthick\nstop}%
327 \hfill
328 \vbox{\moveright\cornerthick\nstop}%
330 \vss}%
331 \vskip\topandbottommargin
332 \line\bgroup
333 \hfil % center the page within the outer (page) hsize.
334 \ifodd\pageno\hskip\bindingoffset\fi
335 \vbox\bgroup
338 \unvbox\headlinebox
339 \pagebody{#1}%
340 \ifdim\ht\footlinebox > 0pt
341 % Only leave this space if the footline is nonempty.
342 % (We lessened \vsize for it in \oddfootingyyy.)
343 % The \baselineskip=24pt in plain's \makefootline has no effect.
344 \vskip 24pt
345 \unvbox\footlinebox
348 \ifcropmarks
349 \egroup % end of \vbox\bgroup
350 \hfil\egroup % end of (centering) \line\bgroup
351 \vskip\topandbottommargin plus1fill minus1fill
352 \boxmaxdepth = \cornerthick
353 \vbox to0pt{\vss
354 \line{%
355 \vbox{\moveleft\cornerthick\nsbot}%
356 \hfill
357 \vbox{\moveright\cornerthick\nsbot}%
359 \nointerlineskip
360 \line{\ewbot\hfil\ewbot}%
362 \egroup % \vbox from first cropmarks clause
364 }% end of \shipout\vbox
365 }% end of group with \indexdummies
366 \advancepageno
367 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
370 \newinsert\margin \dimen\margin=\maxdimen
372 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
373 {\catcode`\@ =11
374 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
375 % marginal hacks, juha@viisa.uucp (Juha Takala)
376 \ifvoid\margin\else % marginal info is present
377 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
378 \dimen@=\dp#1 \unvbox#1
379 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
380 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
383 % Here are the rules for the cropmarks. Note that they are
384 % offset so that the space between them is truly \outerhsize or \outervsize
385 % (P. A. MacKay, 12 November, 1986)
387 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
388 \def\nstop{\vbox
389 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
390 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
391 \def\nsbot{\vbox
392 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
394 % Parse an argument, then pass it to #1. The argument is the rest of
395 % the input line (except we remove a trailing comment). #1 should be a
396 % macro which expects an ordinary undelimited TeX argument.
398 \def\parsearg{\parseargusing{}}
399 \def\parseargusing#1#2{%
400 \def\argtorun{#2}%
401 \begingroup
402 \obeylines
403 \spaceisspace
405 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
408 {\obeylines %
409 \gdef\parseargline#1^^M{%
410 \endgroup % End of the group started in \parsearg.
411 \argremovecomment #1\comment\ArgTerm%
415 % First remove any @comment, then any @c comment.
416 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
417 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
419 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
421 % \argremovec might leave us with trailing space, e.g.,
422 % @end itemize @c foo
423 % This space token undergoes the same procedure and is eventually removed
424 % by \finishparsearg.
426 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
427 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
428 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
429 \def\temp{#3}%
430 \ifx\temp\empty
431 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
432 \let\temp\finishparsearg
433 \else
434 \let\temp\argcheckspaces
436 % Put the space token in:
437 \temp#1 #3\ArgTerm
440 % If a _delimited_ argument is enclosed in braces, they get stripped; so
441 % to get _exactly_ the rest of the line, we had to prevent such situation.
442 % We prepended an \empty token at the very beginning and we expand it now,
443 % just before passing the control to \argtorun.
444 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
445 % either the null string, or it ends with \^^M---thus there is no danger
446 % that a pair of braces would be stripped.
448 % But first, we have to remove the trailing space token.
450 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
452 % \parseargdef\foo{...}
453 % is roughly equivalent to
454 % \def\foo{\parsearg\Xfoo}
455 % \def\Xfoo#1{...}
457 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
458 % favourite TeX trick. --kasal, 16nov03
460 \def\parseargdef#1{%
461 \expandafter \doparseargdef \csname\string#1\endcsname #1%
463 \def\doparseargdef#1#2{%
464 \def#2{\parsearg#1}%
465 \def#1##1%
468 % Several utility definitions with active space:
470 \obeyspaces
471 \gdef\obeyedspace{ }
473 % Make each space character in the input produce a normal interword
474 % space in the output. Don't allow a line break at this space, as this
475 % is used only in environments like @example, where each line of input
476 % should produce a line of output anyway.
478 \gdef\sepspaces{\obeyspaces\let =\tie}
480 % If an index command is used in an @example environment, any spaces
481 % therein should become regular spaces in the raw index file, not the
482 % expansion of \tie (\leavevmode \penalty \@M \ ).
483 \gdef\unsepspaces{\let =\space}
487 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
489 % Define the framework for environments in texinfo.tex. It's used like this:
491 % \envdef\foo{...}
492 % \def\Efoo{...}
494 % It's the responsibility of \envdef to insert \begingroup before the
495 % actual body; @end closes the group after calling \Efoo. \envdef also
496 % defines \thisenv, so the current environment is known; @end checks
497 % whether the environment name matches. The \checkenv macro can also be
498 % used to check whether the current environment is the one expected.
500 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
501 % are not treated as enviroments; they don't open a group. (The
502 % implementation of @end takes care not to call \endgroup in this
503 % special case.)
506 % At runtime, environments start with this:
507 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
508 % initialize
509 \let\thisenv\empty
511 % ... but they get defined via ``\envdef\foo{...}'':
512 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
513 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
515 % Check whether we're in the right environment:
516 \def\checkenv#1{%
517 \def\temp{#1}%
518 \ifx\thisenv\temp
519 \else
520 \badenverr
524 % Evironment mismatch, #1 expected:
525 \def\badenverr{%
526 \errhelp = \EMsimple
527 \errmessage{This command can appear only \inenvironment\temp,
528 not \inenvironment\thisenv}%
530 \def\inenvironment#1{%
531 \ifx#1\empty
532 out of any environment%
533 \else
534 in environment \expandafter\string#1%
538 % @end foo executes the definition of \Efoo.
539 % But first, it executes a specialized version of \checkenv
541 \parseargdef\end{%
542 \if 1\csname iscond.#1\endcsname
543 \else
544 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
545 \expandafter\checkenv\csname#1\endcsname
546 \csname E#1\endcsname
547 \endgroup
551 \newhelp\EMsimple{Press RETURN to continue.}
554 %% Simple single-character @ commands
556 % @@ prints an @
557 % Kludge this until the fonts are right (grr).
558 \def\@{{\tt\char64}}
560 % This is turned off because it was never documented
561 % and you can use @w{...} around a quote to suppress ligatures.
562 %% Define @` and @' to be the same as ` and '
563 %% but suppressing ligatures.
564 %\def\`{{`}}
565 %\def\'{{'}}
567 % Used to generate quoted braces.
568 \def\mylbrace {{\tt\char123}}
569 \def\myrbrace {{\tt\char125}}
570 \let\{=\mylbrace
571 \let\}=\myrbrace
572 \begingroup
573 % Definitions to produce \{ and \} commands for indices,
574 % and @{ and @} for the aux/toc files.
575 \catcode`\{ = \other \catcode`\} = \other
576 \catcode`\[ = 1 \catcode`\] = 2
577 \catcode`\! = 0 \catcode`\\ = \other
578 !gdef!lbracecmd[\{]%
579 !gdef!rbracecmd[\}]%
580 !gdef!lbraceatcmd[@{]%
581 !gdef!rbraceatcmd[@}]%
582 !endgroup
584 % @comma{} to avoid , parsing problems.
585 \let\comma = ,
587 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
588 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
589 \let\, = \c
590 \let\dotaccent = \.
591 \def\ringaccent#1{{\accent23 #1}}
592 \let\tieaccent = \t
593 \let\ubaraccent = \b
594 \let\udotaccent = \d
596 % Other special characters: @questiondown @exclamdown @ordf @ordm
597 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
598 \def\questiondown{?`}
599 \def\exclamdown{!`}
600 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
601 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
603 % Dotless i and dotless j, used for accents.
604 \def\imacro{i}
605 \def\jmacro{j}
606 \def\dotless#1{%
607 \def\temp{#1}%
608 \ifx\temp\imacro \ptexi
609 \else\ifx\temp\jmacro \j
610 \else \errmessage{@dotless can be used only with i or j}%
611 \fi\fi
614 % The \TeX{} logo, as in plain, but resetting the spacing so that a
615 % period following counts as ending a sentence. (Idea found in latex.)
617 \edef\TeX{\TeX \spacefactor=1000 }
619 % @LaTeX{} logo. Not quite the same results as the definition in
620 % latex.ltx, since we use a different font for the raised A; it's most
621 % convenient for us to use an explicitly smaller font, rather than using
622 % the \scriptstyle font (since we don't reset \scriptstyle and
623 % \scriptscriptstyle).
625 \def\LaTeX{%
626 L\kern-.36em
627 {\setbox0=\hbox{T}%
628 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
629 \kern-.15em
630 \TeX
633 % Be sure we're in horizontal mode when doing a tie, since we make space
634 % equivalent to this in @example-like environments. Otherwise, a space
635 % at the beginning of a line will start with \penalty -- and
636 % since \penalty is valid in vertical mode, we'd end up putting the
637 % penalty on the vertical list instead of in the new paragraph.
638 {\catcode`@ = 11
639 % Avoid using \@M directly, because that causes trouble
640 % if the definition is written into an index file.
641 \global\let\tiepenalty = \@M
642 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
645 % @: forces normal size whitespace following.
646 \def\:{\spacefactor=1000 }
648 % @* forces a line break.
649 \def\*{\hfil\break\hbox{}\ignorespaces}
651 % @/ allows a line break.
652 \let\/=\allowbreak
654 % @. is an end-of-sentence period.
655 \def\.{.\spacefactor=\endofsentencespacefactor\space}
657 % @! is an end-of-sentence bang.
658 \def\!{!\spacefactor=\endofsentencespacefactor\space}
660 % @? is an end-of-sentence query.
661 \def\?{?\spacefactor=\endofsentencespacefactor\space}
663 % @frenchspacing on|off says whether to put extra space after punctuation.
665 \def\onword{on}
666 \def\offword{off}
668 \parseargdef\frenchspacing{%
669 \def\temp{#1}%
670 \ifx\temp\onword \plainfrenchspacing
671 \else\ifx\temp\offword \plainnonfrenchspacing
672 \else
673 \errhelp = \EMsimple
674 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
675 \fi\fi
678 % @w prevents a word break. Without the \leavevmode, @w at the
679 % beginning of a paragraph, when TeX is still in vertical mode, would
680 % produce a whole line of output instead of starting the paragraph.
681 \def\w#1{\leavevmode\hbox{#1}}
683 % @group ... @end group forces ... to be all on one page, by enclosing
684 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
685 % to keep its height that of a normal line. According to the rules for
686 % \topskip (p.114 of the TeXbook), the glue inserted is
687 % max (\topskip - \ht (first item), 0). If that height is large,
688 % therefore, no glue is inserted, and the space between the headline and
689 % the text is small, which looks bad.
691 % Another complication is that the group might be very large. This can
692 % cause the glue on the previous page to be unduly stretched, because it
693 % does not have much material. In this case, it's better to add an
694 % explicit \vfill so that the extra space is at the bottom. The
695 % threshold for doing this is if the group is more than \vfilllimit
696 % percent of a page (\vfilllimit can be changed inside of @tex).
698 \newbox\groupbox
699 \def\vfilllimit{0.7}
701 \envdef\group{%
702 \ifnum\catcode`\^^M=\active \else
703 \errhelp = \groupinvalidhelp
704 \errmessage{@group invalid in context where filling is enabled}%
706 \startsavinginserts
708 \setbox\groupbox = \vtop\bgroup
709 % Do @comment since we are called inside an environment such as
710 % @example, where each end-of-line in the input causes an
711 % end-of-line in the output. We don't want the end-of-line after
712 % the `@group' to put extra space in the output. Since @group
713 % should appear on a line by itself (according to the Texinfo
714 % manual), we don't worry about eating any user text.
715 \comment
718 % The \vtop produces a box with normal height and large depth; thus, TeX puts
719 % \baselineskip glue before it, and (when the next line of text is done)
720 % \lineskip glue after it. Thus, space below is not quite equal to space
721 % above. But it's pretty close.
722 \def\Egroup{%
723 % To get correct interline space between the last line of the group
724 % and the first line afterwards, we have to propagate \prevdepth.
725 \endgraf % Not \par, as it may have been set to \lisppar.
726 \global\dimen1 = \prevdepth
727 \egroup % End the \vtop.
728 % \dimen0 is the vertical size of the group's box.
729 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
730 % \dimen2 is how much space is left on the page (more or less).
731 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
732 % if the group doesn't fit on the current page, and it's a big big
733 % group, force a page break.
734 \ifdim \dimen0 > \dimen2
735 \ifdim \pagetotal < \vfilllimit\pageheight
736 \page
739 \box\groupbox
740 \prevdepth = \dimen1
741 \checkinserts
744 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
745 % message, so this ends up printing `@group can only ...'.
747 \newhelp\groupinvalidhelp{%
748 group can only be used in environments such as @example,^^J%
749 where each line of input produces a line of output.}
751 % @need space-in-mils
752 % forces a page break if there is not space-in-mils remaining.
754 \newdimen\mil \mil=0.001in
756 % Old definition--didn't work.
757 %\parseargdef\need{\par %
758 %% This method tries to make TeX break the page naturally
759 %% if the depth of the box does not fit.
760 %{\baselineskip=0pt%
761 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
762 %\prevdepth=-1000pt
765 \parseargdef\need{%
766 % Ensure vertical mode, so we don't make a big box in the middle of a
767 % paragraph.
768 \par
770 % If the @need value is less than one line space, it's useless.
771 \dimen0 = #1\mil
772 \dimen2 = \ht\strutbox
773 \advance\dimen2 by \dp\strutbox
774 \ifdim\dimen0 > \dimen2
776 % Do a \strut just to make the height of this box be normal, so the
777 % normal leading is inserted relative to the preceding line.
778 % And a page break here is fine.
779 \vtop to #1\mil{\strut\vfil}%
781 % TeX does not even consider page breaks if a penalty added to the
782 % main vertical list is 10000 or more. But in order to see if the
783 % empty box we just added fits on the page, we must make it consider
784 % page breaks. On the other hand, we don't want to actually break the
785 % page after the empty box. So we use a penalty of 9999.
787 % There is an extremely small chance that TeX will actually break the
788 % page at this \penalty, if there are no other feasible breakpoints in
789 % sight. (If the user is using lots of big @group commands, which
790 % almost-but-not-quite fill up a page, TeX will have a hard time doing
791 % good page breaking, for example.) However, I could not construct an
792 % example where a page broke at this \penalty; if it happens in a real
793 % document, then we can reconsider our strategy.
794 \penalty9999
796 % Back up by the size of the box, whether we did a page break or not.
797 \kern -#1\mil
799 % Do not allow a page break right after this kern.
800 \nobreak
804 % @br forces paragraph break (and is undocumented).
806 \let\br = \par
808 % @page forces the start of a new page.
810 \def\page{\par\vfill\supereject}
812 % @exdent text....
813 % outputs text on separate line in roman font, starting at standard page margin
815 % This records the amount of indent in the innermost environment.
816 % That's how much \exdent should take out.
817 \newskip\exdentamount
819 % This defn is used inside fill environments such as @defun.
820 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
822 % This defn is used inside nofill environments such as @example.
823 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
824 \leftline{\hskip\leftskip{\rm#1}}}}
826 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
827 % paragraph. For more general purposes, use the \margin insertion
828 % class. WHICH is `l' or `r'.
830 \newskip\inmarginspacing \inmarginspacing=1cm
831 \def\strutdepth{\dp\strutbox}
833 \def\doinmargin#1#2{\strut\vadjust{%
834 \nobreak
835 \kern-\strutdepth
836 \vtop to \strutdepth{%
837 \baselineskip=\strutdepth
838 \vss
839 % if you have multiple lines of stuff to put here, you'll need to
840 % make the vbox yourself of the appropriate size.
841 \ifx#1l%
842 \llap{\ignorespaces #2\hskip\inmarginspacing}%
843 \else
844 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
846 \null
849 \def\inleftmargin{\doinmargin l}
850 \def\inrightmargin{\doinmargin r}
852 % @inmargin{TEXT [, RIGHT-TEXT]}
853 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
854 % else use TEXT for both).
856 \def\inmargin#1{\parseinmargin #1,,\finish}
857 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
858 \setbox0 = \hbox{\ignorespaces #2}%
859 \ifdim\wd0 > 0pt
860 \def\lefttext{#1}% have both texts
861 \def\righttext{#2}%
862 \else
863 \def\lefttext{#1}% have only one text
864 \def\righttext{#1}%
867 \ifodd\pageno
868 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
869 \else
870 \def\temp{\inleftmargin\lefttext}%
872 \temp
875 % @include file insert text of that file as input.
877 \def\include{\parseargusing\filenamecatcodes\includezzz}
878 \def\includezzz#1{%
879 \pushthisfilestack
880 \def\thisfile{#1}%
882 \makevalueexpandable
883 \def\temp{\input #1 }%
884 \expandafter
885 }\temp
886 \popthisfilestack
888 \def\filenamecatcodes{%
889 \catcode`\\=\other
890 \catcode`~=\other
891 \catcode`^=\other
892 \catcode`_=\other
893 \catcode`|=\other
894 \catcode`<=\other
895 \catcode`>=\other
896 \catcode`+=\other
897 \catcode`-=\other
900 \def\pushthisfilestack{%
901 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
903 \def\pushthisfilestackX{%
904 \expandafter\pushthisfilestackY\thisfile\StackTerm
906 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
907 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
910 \def\popthisfilestack{\errthisfilestackempty}
911 \def\errthisfilestackempty{\errmessage{Internal error:
912 the stack of filenames is empty.}}
914 \def\thisfile{}
916 % @center line
917 % outputs that line, centered.
919 \parseargdef\center{%
920 \ifhmode
921 \let\next\centerH
922 \else
923 \let\next\centerV
925 \next{\hfil \ignorespaces#1\unskip \hfil}%
927 \def\centerH#1{%
929 \hfil\break
930 \advance\hsize by -\leftskip
931 \advance\hsize by -\rightskip
932 \line{#1}%
933 \break
936 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
938 % @sp n outputs n lines of vertical space
940 \parseargdef\sp{\vskip #1\baselineskip}
942 % @comment ...line which is ignored...
943 % @c is the same as @comment
944 % @ignore ... @end ignore is another way to write a comment
946 \def\comment{\begingroup \catcode`\^^M=\other%
947 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
948 \commentxxx}
949 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
951 \let\c=\comment
953 % @paragraphindent NCHARS
954 % We'll use ems for NCHARS, close enough.
955 % NCHARS can also be the word `asis' or `none'.
956 % We cannot feasibly implement @paragraphindent asis, though.
958 \def\asisword{asis} % no translation, these are keywords
959 \def\noneword{none}
961 \parseargdef\paragraphindent{%
962 \def\temp{#1}%
963 \ifx\temp\asisword
964 \else
965 \ifx\temp\noneword
966 \defaultparindent = 0pt
967 \else
968 \defaultparindent = #1em
971 \parindent = \defaultparindent
974 % @exampleindent NCHARS
975 % We'll use ems for NCHARS like @paragraphindent.
976 % It seems @exampleindent asis isn't necessary, but
977 % I preserve it to make it similar to @paragraphindent.
978 \parseargdef\exampleindent{%
979 \def\temp{#1}%
980 \ifx\temp\asisword
981 \else
982 \ifx\temp\noneword
983 \lispnarrowing = 0pt
984 \else
985 \lispnarrowing = #1em
990 % @firstparagraphindent WORD
991 % If WORD is `none', then suppress indentation of the first paragraph
992 % after a section heading. If WORD is `insert', then do indent at such
993 % paragraphs.
995 % The paragraph indentation is suppressed or not by calling
996 % \suppressfirstparagraphindent, which the sectioning commands do.
997 % We switch the definition of this back and forth according to WORD.
998 % By default, we suppress indentation.
1000 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1001 \def\insertword{insert}
1003 \parseargdef\firstparagraphindent{%
1004 \def\temp{#1}%
1005 \ifx\temp\noneword
1006 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1007 \else\ifx\temp\insertword
1008 \let\suppressfirstparagraphindent = \relax
1009 \else
1010 \errhelp = \EMsimple
1011 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1012 \fi\fi
1015 % Here is how we actually suppress indentation. Redefine \everypar to
1016 % \kern backwards by \parindent, and then reset itself to empty.
1018 % We also make \indent itself not actually do anything until the next
1019 % paragraph.
1021 \gdef\dosuppressfirstparagraphindent{%
1022 \gdef\indent{%
1023 \restorefirstparagraphindent
1024 \indent
1026 \gdef\noindent{%
1027 \restorefirstparagraphindent
1028 \noindent
1030 \global\everypar = {%
1031 \kern -\parindent
1032 \restorefirstparagraphindent
1036 \gdef\restorefirstparagraphindent{%
1037 \global \let \indent = \ptexindent
1038 \global \let \noindent = \ptexnoindent
1039 \global \everypar = {}%
1043 % @asis just yields its argument. Used with @table, for example.
1045 \def\asis#1{#1}
1047 % @math outputs its argument in math mode.
1049 % One complication: _ usually means subscripts, but it could also mean
1050 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1051 % _ active, and distinguish by seeing if the current family is \slfam,
1052 % which is what @var uses.
1054 \catcode`\_ = \active
1055 \gdef\mathunderscore{%
1056 \catcode`\_=\active
1057 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1060 % Another complication: we want \\ (and @\) to output a \ character.
1061 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1062 % this is not advertised and we don't care. Texinfo does not
1063 % otherwise define @\.
1065 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1066 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1068 \def\math{%
1069 \tex
1070 \mathunderscore
1071 \let\\ = \mathbackslash
1072 \mathactive
1073 $\finishmath
1075 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1077 % Some active characters (such as <) are spaced differently in math.
1078 % We have to reset their definitions in case the @math was an argument
1079 % to a command which sets the catcodes (such as @item or @section).
1082 \catcode`^ = \active
1083 \catcode`< = \active
1084 \catcode`> = \active
1085 \catcode`+ = \active
1086 \gdef\mathactive{%
1087 \let^ = \ptexhat
1088 \let< = \ptexless
1089 \let> = \ptexgtr
1090 \let+ = \ptexplus
1094 % @bullet and @minus need the same treatment as @math, just above.
1095 \def\bullet{$\ptexbullet$}
1096 \def\minus{$-$}
1098 % @dots{} outputs an ellipsis using the current font.
1099 % We do .5em per period so that it has the same spacing in the cm
1100 % typewriter fonts as three actual period characters; on the other hand,
1101 % in other typewriter fonts three periods are wider than 1.5em. So do
1102 % whichever is larger.
1104 \def\dots{%
1105 \leavevmode
1106 \setbox0=\hbox{...}% get width of three periods
1107 \ifdim\wd0 > 1.5em
1108 \dimen0 = \wd0
1109 \else
1110 \dimen0 = 1.5em
1112 \hbox to \dimen0{%
1113 \hskip 0pt plus.25fil
1114 .\hskip 0pt plus1fil
1115 .\hskip 0pt plus1fil
1116 .\hskip 0pt plus.5fil
1120 % @enddots{} is an end-of-sentence ellipsis.
1122 \def\enddots{%
1123 \dots
1124 \spacefactor=\endofsentencespacefactor
1127 % @comma{} is so commas can be inserted into text without messing up
1128 % Texinfo's parsing.
1130 \let\comma = ,
1132 % @refill is a no-op.
1133 \let\refill=\relax
1135 % If working on a large document in chapters, it is convenient to
1136 % be able to disable indexing, cross-referencing, and contents, for test runs.
1137 % This is done with @novalidate (before @setfilename).
1139 \newif\iflinks \linkstrue % by default we want the aux files.
1140 \let\novalidate = \linksfalse
1142 % @setfilename is done at the beginning of every texinfo file.
1143 % So open here the files we need to have open while reading the input.
1144 % This makes it possible to make a .fmt file for texinfo.
1145 \def\setfilename{%
1146 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1147 \iflinks
1148 \tryauxfile
1149 % Open the new aux file. TeX will close it automatically at exit.
1150 \immediate\openout\auxfile=\jobname.aux
1151 \fi % \openindices needs to do some work in any case.
1152 \openindices
1153 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1155 % If texinfo.cnf is present on the system, read it.
1156 % Useful for site-wide @afourpaper, etc.
1157 \openin 1 texinfo.cnf
1158 \ifeof 1 \else \input texinfo.cnf \fi
1159 \closein 1
1161 \comment % Ignore the actual filename.
1164 % Called from \setfilename.
1166 \def\openindices{%
1167 \newindex{cp}%
1168 \newcodeindex{fn}%
1169 \newcodeindex{vr}%
1170 \newcodeindex{tp}%
1171 \newcodeindex{ky}%
1172 \newcodeindex{pg}%
1175 % @bye.
1176 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1179 \message{pdf,}
1180 % adobe `portable' document format
1181 \newcount\tempnum
1182 \newcount\lnkcount
1183 \newtoks\filename
1184 \newcount\filenamelength
1185 \newcount\pgn
1186 \newtoks\toksA
1187 \newtoks\toksB
1188 \newtoks\toksC
1189 \newtoks\toksD
1190 \newbox\boxA
1191 \newcount\countA
1192 \newif\ifpdf
1193 \newif\ifpdfmakepagedest
1195 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1196 % can be set). So we test for \relax and 0 as well as \undefined,
1197 % borrowed from ifpdf.sty.
1198 \ifx\pdfoutput\undefined
1199 \else
1200 \ifx\pdfoutput\relax
1201 \else
1202 \ifcase\pdfoutput
1203 \else
1204 \pdftrue
1209 % PDF uses PostScript string constants for the names of xref targets,
1210 % for display in the outlines, and in other places. Thus, we have to
1211 % double any backslashes. Otherwise, a name like "\node" will be
1212 % interpreted as a newline (\n), followed by o, d, e. Not good.
1213 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1214 % (and related messages, the final outcome is that it is up to the TeX
1215 % user to double the backslashes and otherwise make the string valid, so
1216 % that's what we do).
1218 % double active backslashes.
1220 {\catcode`\@=0 \catcode`\\=\active
1221 @gdef@activebackslashdouble{%
1222 @catcode`@\=@active
1223 @let\=@doublebackslash}
1226 % To handle parens, we must adopt a different approach, since parens are
1227 % not active characters. hyperref.dtx (which has the same problem as
1228 % us) handles it with this amazing macro to replace tokens. I've
1229 % tinkered with it a little for texinfo, but it's definitely from there.
1231 % #1 is the tokens to replace.
1232 % #2 is the replacement.
1233 % #3 is the control sequence with the string.
1235 \def\HyPsdSubst#1#2#3{%
1236 \def\HyPsdReplace##1#1##2\END{%
1237 ##1%
1238 \ifx\\##2\\%
1239 \else
1241 \HyReturnAfterFi{%
1242 \HyPsdReplace##2\END
1246 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1248 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1250 % #1 is a control sequence in which to do the replacements.
1251 \def\backslashparens#1{%
1252 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1253 % \lastnode when called from \setref -> \pdfmkdest.
1254 \HyPsdSubst{(}{\realbackslash(}{#1}%
1255 \HyPsdSubst{)}{\realbackslash)}{#1}%
1258 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1259 with PDF output, and none of those formats could be found. (.eps cannot
1260 be supported due to the design of the PDF format; use regular TeX (DVI
1261 output) for that.)}
1263 \ifpdf
1264 \input pdfcolor
1265 \pdfcatalog{/PageMode /UseOutlines}
1267 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1268 \def\dopdfimage#1#2#3{%
1269 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1270 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1272 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1273 % others). Let's try in that order.
1274 \let\pdfimgext=\empty
1275 \begingroup
1276 \openin 1 #1.png \ifeof 1
1277 \openin 1 #1.jpg \ifeof 1
1278 \openin 1 #1.jpeg \ifeof 1
1279 \openin 1 #1.JPG \ifeof 1
1280 \openin 1 #1.pdf \ifeof 1
1281 \errhelp = \nopdfimagehelp
1282 \errmessage{Could not find image file #1 for pdf}%
1283 \else \gdef\pdfimgext{pdf}%
1285 \else \gdef\pdfimgext{JPG}%
1287 \else \gdef\pdfimgext{jpeg}%
1289 \else \gdef\pdfimgext{jpg}%
1291 \else \gdef\pdfimgext{png}%
1293 \closein 1
1294 \endgroup
1296 % without \immediate, pdftex seg faults when the same image is
1297 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1298 \ifnum\pdftexversion < 14
1299 \immediate\pdfimage
1300 \else
1301 \immediate\pdfximage
1303 \ifdim \wd0 >0pt width \imagewidth \fi
1304 \ifdim \wd2 >0pt height \imageheight \fi
1305 \ifnum\pdftexversion<13
1306 #1.\pdfimgext
1307 \else
1308 {#1.\pdfimgext}%
1310 \ifnum\pdftexversion < 14 \else
1311 \pdfrefximage \pdflastximage
1312 \fi}
1314 \def\pdfmkdest#1{{%
1315 % We have to set dummies so commands such as @code, and characters
1316 % such as \, aren't expanded when present in a section title.
1317 \indexnofonts
1318 \turnoffactive
1319 \activebackslashdouble
1320 \def\pdfdestname{#1}%
1321 \backslashparens\pdfdestname
1322 \pdfdest name{\pdfdestname} xyz%
1325 % used to mark target names; must be expandable.
1326 \def\pdfmkpgn#1{#1}
1328 \let\linkcolor = \Blue % was Cyan, but that seems light?
1329 \def\endlink{\Black\pdfendlink}
1331 % Adding outlines to PDF; macros for calculating structure of outlines
1332 % come from Petr Olsak
1333 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1334 \else \csname#1\endcsname \fi}
1335 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1336 \advance\tempnum by 1
1337 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1339 % #1 is the section text, which is what will be displayed in the
1340 % outline by the pdf viewer. #2 is the pdf expression for the number
1341 % of subentries (or empty, for subsubsections). #3 is the node text,
1342 % which might be empty if this toc entry had no corresponding node.
1343 % #4 is the page number
1345 \def\dopdfoutline#1#2#3#4{%
1346 % Generate a link to the node text if that exists; else, use the
1347 % page number. We could generate a destination for the section
1348 % text in the case where a section has no node, but it doesn't
1349 % seem worth the trouble, since most documents are normally structured.
1350 \def\pdfoutlinedest{#3}%
1351 \ifx\pdfoutlinedest\empty
1352 \def\pdfoutlinedest{#4}%
1353 \else
1354 % Doubled backslashes in the name.
1355 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1356 \backslashparens\pdfoutlinedest}%
1359 % Also double the backslashes in the display string.
1360 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1361 \backslashparens\pdfoutlinetext}%
1363 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1366 \def\pdfmakeoutlines{%
1367 \begingroup
1368 % Thanh's hack / proper braces in bookmarks
1369 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1370 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1372 % Read toc silently, to get counts of subentries for \pdfoutline.
1373 \def\numchapentry##1##2##3##4{%
1374 \def\thischapnum{##2}%
1375 \def\thissecnum{0}%
1376 \def\thissubsecnum{0}%
1378 \def\numsecentry##1##2##3##4{%
1379 \advancenumber{chap\thischapnum}%
1380 \def\thissecnum{##2}%
1381 \def\thissubsecnum{0}%
1383 \def\numsubsecentry##1##2##3##4{%
1384 \advancenumber{sec\thissecnum}%
1385 \def\thissubsecnum{##2}%
1387 \def\numsubsubsecentry##1##2##3##4{%
1388 \advancenumber{subsec\thissubsecnum}%
1390 \def\thischapnum{0}%
1391 \def\thissecnum{0}%
1392 \def\thissubsecnum{0}%
1394 % use \def rather than \let here because we redefine \chapentry et
1395 % al. a second time, below.
1396 \def\appentry{\numchapentry}%
1397 \def\appsecentry{\numsecentry}%
1398 \def\appsubsecentry{\numsubsecentry}%
1399 \def\appsubsubsecentry{\numsubsubsecentry}%
1400 \def\unnchapentry{\numchapentry}%
1401 \def\unnsecentry{\numsecentry}%
1402 \def\unnsubsecentry{\numsubsecentry}%
1403 \def\unnsubsubsecentry{\numsubsubsecentry}%
1404 \readdatafile{toc}%
1406 % Read toc second time, this time actually producing the outlines.
1407 % The `-' means take the \expnumber as the absolute number of
1408 % subentries, which we calculated on our first read of the .toc above.
1410 % We use the node names as the destinations.
1411 \def\numchapentry##1##2##3##4{%
1412 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1413 \def\numsecentry##1##2##3##4{%
1414 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1415 \def\numsubsecentry##1##2##3##4{%
1416 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1417 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1418 \dopdfoutline{##1}{}{##3}{##4}}%
1420 % PDF outlines are displayed using system fonts, instead of
1421 % document fonts. Therefore we cannot use special characters,
1422 % since the encoding is unknown. For example, the eogonek from
1423 % Latin 2 (0xea) gets translated to a | character. Info from
1424 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1426 % xx to do this right, we have to translate 8-bit characters to
1427 % their "best" equivalent, based on the @documentencoding. Right
1428 % now, I guess we'll just let the pdf reader have its way.
1429 \indexnofonts
1430 \setupdatafile
1431 \catcode`\\=\active \otherbackslash
1432 \input \jobname.toc
1433 \endgroup
1436 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1437 \ifx\PP\D\let\nextsp\relax
1438 \else\let\nextsp\skipspaces
1439 \ifx\p\space\else\addtokens{\filename}{\PP}%
1440 \advance\filenamelength by 1
1443 \nextsp}
1444 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1445 \ifnum\pdftexversion < 14
1446 \let \startlink \pdfannotlink
1447 \else
1448 \let \startlink \pdfstartlink
1450 % make a live url in pdf output.
1451 \def\pdfurl#1{%
1452 \begingroup
1453 % it seems we really need yet another set of dummies; have not
1454 % tried to figure out what each command should do in the context
1455 % of @url. for now, just make @/ a no-op, that's the only one
1456 % people have actually reported a problem with.
1458 \normalturnoffactive
1459 \def\@{@}%
1460 \let\/=\empty
1461 \makevalueexpandable
1462 \leavevmode\Red
1463 \startlink attr{/Border [0 0 0]}%
1464 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1465 \endgroup}
1466 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1467 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1468 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1469 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1470 \def\maketoks{%
1471 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1472 \ifx\first0\adn0
1473 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1474 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1475 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1476 \else
1477 \ifnum0=\countA\else\makelink\fi
1478 \ifx\first.\let\next=\done\else
1479 \let\next=\maketoks
1480 \addtokens{\toksB}{\the\toksD}
1481 \ifx\first,\addtokens{\toksB}{\space}\fi
1483 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1484 \next}
1485 \def\makelink{\addtokens{\toksB}%
1486 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1487 \def\pdflink#1{%
1488 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1489 \linkcolor #1\endlink}
1490 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1491 \else
1492 \let\pdfmkdest = \gobble
1493 \let\pdfurl = \gobble
1494 \let\endlink = \relax
1495 \let\linkcolor = \relax
1496 \let\pdfmakeoutlines = \relax
1497 \fi % \ifx\pdfoutput
1500 \message{fonts,}
1502 % Change the current font style to #1, remembering it in \curfontstyle.
1503 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1504 % italics, not bold italics.
1506 \def\setfontstyle#1{%
1507 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1508 \csname ten#1\endcsname % change the current font
1511 % Select #1 fonts with the current style.
1513 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1515 \def\rm{\fam=0 \setfontstyle{rm}}
1516 \def\it{\fam=\itfam \setfontstyle{it}}
1517 \def\sl{\fam=\slfam \setfontstyle{sl}}
1518 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1519 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1521 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1522 % So we set up a \sf.
1523 \newfam\sffam
1524 \def\sf{\fam=\sffam \setfontstyle{sf}}
1525 \let\li = \sf % Sometimes we call it \li, not \sf.
1527 % We don't need math for this font style.
1528 \def\ttsl{\setfontstyle{ttsl}}
1531 % Default leading.
1532 \newdimen\textleading \textleading = 13.2pt
1534 % Set the baselineskip to #1, and the lineskip and strut size
1535 % correspondingly. There is no deep meaning behind these magic numbers
1536 % used as factors; they just match (closely enough) what Knuth defined.
1538 \def\lineskipfactor{.08333}
1539 \def\strutheightpercent{.70833}
1540 \def\strutdepthpercent {.29167}
1542 \def\setleading#1{%
1543 \normalbaselineskip = #1\relax
1544 \normallineskip = \lineskipfactor\normalbaselineskip
1545 \normalbaselines
1546 \setbox\strutbox =\hbox{%
1547 \vrule width0pt height\strutheightpercent\baselineskip
1548 depth \strutdepthpercent \baselineskip
1553 % Set the font macro #1 to the font named #2, adding on the
1554 % specified font prefix (normally `cm').
1555 % #3 is the font's design size, #4 is a scale factor
1556 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1559 % Use cm as the default font prefix.
1560 % To specify the font prefix, you must define \fontprefix
1561 % before you read in texinfo.tex.
1562 \ifx\fontprefix\undefined
1563 \def\fontprefix{cm}
1565 % Support font families that don't use the same naming scheme as CM.
1566 \def\rmshape{r}
1567 \def\rmbshape{bx} %where the normal face is bold
1568 \def\bfshape{b}
1569 \def\bxshape{bx}
1570 \def\ttshape{tt}
1571 \def\ttbshape{tt}
1572 \def\ttslshape{sltt}
1573 \def\itshape{ti}
1574 \def\itbshape{bxti}
1575 \def\slshape{sl}
1576 \def\slbshape{bxsl}
1577 \def\sfshape{ss}
1578 \def\sfbshape{ss}
1579 \def\scshape{csc}
1580 \def\scbshape{csc}
1582 % Definitions for a main text size of 11pt. This is the default in
1583 % Texinfo.
1585 \def\definetextfontsizexi{
1586 % Text fonts (11.2pt, magstep1).
1587 \def\textnominalsize{11pt}
1588 \edef\mainmagstep{\magstephalf}
1589 \setfont\textrm\rmshape{10}{\mainmagstep}
1590 \setfont\texttt\ttshape{10}{\mainmagstep}
1591 \setfont\textbf\bfshape{10}{\mainmagstep}
1592 \setfont\textit\itshape{10}{\mainmagstep}
1593 \setfont\textsl\slshape{10}{\mainmagstep}
1594 \setfont\textsf\sfshape{10}{\mainmagstep}
1595 \setfont\textsc\scshape{10}{\mainmagstep}
1596 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1597 \font\texti=cmmi10 scaled \mainmagstep
1598 \font\textsy=cmsy10 scaled \mainmagstep
1600 % A few fonts for @defun names and args.
1601 \setfont\defbf\bfshape{10}{\magstep1}
1602 \setfont\deftt\ttshape{10}{\magstep1}
1603 \setfont\defttsl\ttslshape{10}{\magstep1}
1604 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1606 % Fonts for indices, footnotes, small examples (9pt).
1607 \def\smallnominalsize{9pt}
1608 \setfont\smallrm\rmshape{9}{1000}
1609 \setfont\smalltt\ttshape{9}{1000}
1610 \setfont\smallbf\bfshape{10}{900}
1611 \setfont\smallit\itshape{9}{1000}
1612 \setfont\smallsl\slshape{9}{1000}
1613 \setfont\smallsf\sfshape{9}{1000}
1614 \setfont\smallsc\scshape{10}{900}
1615 \setfont\smallttsl\ttslshape{10}{900}
1616 \font\smalli=cmmi9
1617 \font\smallsy=cmsy9
1619 % Fonts for small examples (8pt).
1620 \def\smallernominalsize{8pt}
1621 \setfont\smallerrm\rmshape{8}{1000}
1622 \setfont\smallertt\ttshape{8}{1000}
1623 \setfont\smallerbf\bfshape{10}{800}
1624 \setfont\smallerit\itshape{8}{1000}
1625 \setfont\smallersl\slshape{8}{1000}
1626 \setfont\smallersf\sfshape{8}{1000}
1627 \setfont\smallersc\scshape{10}{800}
1628 \setfont\smallerttsl\ttslshape{10}{800}
1629 \font\smalleri=cmmi8
1630 \font\smallersy=cmsy8
1632 % Fonts for title page (20.4pt):
1633 \def\titlenominalsize{20pt}
1634 \setfont\titlerm\rmbshape{12}{\magstep3}
1635 \setfont\titleit\itbshape{10}{\magstep4}
1636 \setfont\titlesl\slbshape{10}{\magstep4}
1637 \setfont\titlett\ttbshape{12}{\magstep3}
1638 \setfont\titlettsl\ttslshape{10}{\magstep4}
1639 \setfont\titlesf\sfbshape{17}{\magstep1}
1640 \let\titlebf=\titlerm
1641 \setfont\titlesc\scbshape{10}{\magstep4}
1642 \font\titlei=cmmi12 scaled \magstep3
1643 \font\titlesy=cmsy10 scaled \magstep4
1644 \def\authorrm{\secrm}
1645 \def\authortt{\sectt}
1647 % Chapter (and unnumbered) fonts (17.28pt).
1648 \def\chapnominalsize{17pt}
1649 \setfont\chaprm\rmbshape{12}{\magstep2}
1650 \setfont\chapit\itbshape{10}{\magstep3}
1651 \setfont\chapsl\slbshape{10}{\magstep3}
1652 \setfont\chaptt\ttbshape{12}{\magstep2}
1653 \setfont\chapttsl\ttslshape{10}{\magstep3}
1654 \setfont\chapsf\sfbshape{17}{1000}
1655 \let\chapbf=\chaprm
1656 \setfont\chapsc\scbshape{10}{\magstep3}
1657 \font\chapi=cmmi12 scaled \magstep2
1658 \font\chapsy=cmsy10 scaled \magstep3
1660 % Section fonts (14.4pt).
1661 \def\secnominalsize{14pt}
1662 \setfont\secrm\rmbshape{12}{\magstep1}
1663 \setfont\secit\itbshape{10}{\magstep2}
1664 \setfont\secsl\slbshape{10}{\magstep2}
1665 \setfont\sectt\ttbshape{12}{\magstep1}
1666 \setfont\secttsl\ttslshape{10}{\magstep2}
1667 \setfont\secsf\sfbshape{12}{\magstep1}
1668 \let\secbf\secrm
1669 \setfont\secsc\scbshape{10}{\magstep2}
1670 \font\seci=cmmi12 scaled \magstep1
1671 \font\secsy=cmsy10 scaled \magstep2
1673 % Subsection fonts (13.15pt).
1674 \def\ssecnominalsize{13pt}
1675 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1676 \setfont\ssecit\itbshape{10}{1315}
1677 \setfont\ssecsl\slbshape{10}{1315}
1678 \setfont\ssectt\ttbshape{12}{\magstephalf}
1679 \setfont\ssecttsl\ttslshape{10}{1315}
1680 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1681 \let\ssecbf\ssecrm
1682 \setfont\ssecsc\scbshape{10}{1315}
1683 \font\sseci=cmmi12 scaled \magstephalf
1684 \font\ssecsy=cmsy10 scaled 1315
1686 % Reduced fonts for @acro in text (10pt).
1687 \def\reducednominalsize{10pt}
1688 \setfont\reducedrm\rmshape{10}{1000}
1689 \setfont\reducedtt\ttshape{10}{1000}
1690 \setfont\reducedbf\bfshape{10}{1000}
1691 \setfont\reducedit\itshape{10}{1000}
1692 \setfont\reducedsl\slshape{10}{1000}
1693 \setfont\reducedsf\sfshape{10}{1000}
1694 \setfont\reducedsc\scshape{10}{1000}
1695 \setfont\reducedttsl\ttslshape{10}{1000}
1696 \font\reducedi=cmmi10
1697 \font\reducedsy=cmsy10
1699 % reset the current fonts
1700 \textfonts
1702 } % end of 11pt text font size definitions
1705 % Definitions to make the main text be 10pt Computer Modern, with
1706 % section, chapter, etc., sizes following suit. This is for the GNU
1707 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1708 % future. Used with @smallbook, which sets the leading to 12pt.
1710 \def\definetextfontsizex{%
1711 % Text fonts (10pt).
1712 \def\textnominalsize{10pt}
1713 \edef\mainmagstep{1000}
1714 \setfont\textrm\rmshape{10}{\mainmagstep}
1715 \setfont\texttt\ttshape{10}{\mainmagstep}
1716 \setfont\textbf\bfshape{10}{\mainmagstep}
1717 \setfont\textit\itshape{10}{\mainmagstep}
1718 \setfont\textsl\slshape{10}{\mainmagstep}
1719 \setfont\textsf\sfshape{10}{\mainmagstep}
1720 \setfont\textsc\scshape{10}{\mainmagstep}
1721 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1722 \font\texti=cmmi10 scaled \mainmagstep
1723 \font\textsy=cmsy10 scaled \mainmagstep
1725 % A few fonts for @defun names and args.
1726 \setfont\defbf\bfshape{10}{\magstephalf}
1727 \setfont\deftt\ttshape{10}{\magstephalf}
1728 \setfont\defttsl\ttslshape{10}{\magstephalf}
1729 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1731 % Fonts for indices, footnotes, small examples (9pt).
1732 \def\smallnominalsize{9pt}
1733 \setfont\smallrm\rmshape{9}{1000}
1734 \setfont\smalltt\ttshape{9}{1000}
1735 \setfont\smallbf\bfshape{10}{900}
1736 \setfont\smallit\itshape{9}{1000}
1737 \setfont\smallsl\slshape{9}{1000}
1738 \setfont\smallsf\sfshape{9}{1000}
1739 \setfont\smallsc\scshape{10}{900}
1740 \setfont\smallttsl\ttslshape{10}{900}
1741 \font\smalli=cmmi9
1742 \font\smallsy=cmsy9
1744 % Fonts for small examples (8pt).
1745 \def\smallernominalsize{8pt}
1746 \setfont\smallerrm\rmshape{8}{1000}
1747 \setfont\smallertt\ttshape{8}{1000}
1748 \setfont\smallerbf\bfshape{10}{800}
1749 \setfont\smallerit\itshape{8}{1000}
1750 \setfont\smallersl\slshape{8}{1000}
1751 \setfont\smallersf\sfshape{8}{1000}
1752 \setfont\smallersc\scshape{10}{800}
1753 \setfont\smallerttsl\ttslshape{10}{800}
1754 \font\smalleri=cmmi8
1755 \font\smallersy=cmsy8
1757 % Fonts for title page (20.4pt):
1758 \def\titlenominalsize{20pt}
1759 \setfont\titlerm\rmbshape{12}{\magstep3}
1760 \setfont\titleit\itbshape{10}{\magstep4}
1761 \setfont\titlesl\slbshape{10}{\magstep4}
1762 \setfont\titlett\ttbshape{12}{\magstep3}
1763 \setfont\titlettsl\ttslshape{10}{\magstep4}
1764 \setfont\titlesf\sfbshape{17}{\magstep1}
1765 \let\titlebf=\titlerm
1766 \setfont\titlesc\scbshape{10}{\magstep4}
1767 \font\titlei=cmmi12 scaled \magstep3
1768 \font\titlesy=cmsy10 scaled \magstep4
1769 \def\authorrm{\secrm}
1770 \def\authortt{\sectt}
1772 % Chapter fonts (14.4pt).
1773 \def\chapnominalsize{14pt}
1774 \setfont\chaprm\rmbshape{12}{\magstep1}
1775 \setfont\chapit\itbshape{10}{\magstep2}
1776 \setfont\chapsl\slbshape{10}{\magstep2}
1777 \setfont\chaptt\ttbshape{12}{\magstep1}
1778 \setfont\chapttsl\ttslshape{10}{\magstep2}
1779 \setfont\chapsf\sfbshape{12}{\magstep1}
1780 \let\chapbf\chaprm
1781 \setfont\chapsc\scbshape{10}{\magstep2}
1782 \font\chapi=cmmi12 scaled \magstep1
1783 \font\chapsy=cmsy10 scaled \magstep2
1785 % Section fonts (12pt).
1786 \def\secnominalsize{12pt}
1787 \setfont\secrm\rmbshape{12}{1000}
1788 \setfont\secit\itbshape{10}{\magstep1}
1789 \setfont\secsl\slbshape{10}{\magstep1}
1790 \setfont\sectt\ttbshape{12}{1000}
1791 \setfont\secttsl\ttslshape{10}{\magstep1}
1792 \setfont\secsf\sfbshape{12}{1000}
1793 \let\secbf\secrm
1794 \setfont\secsc\scbshape{10}{\magstep1}
1795 \font\seci=cmmi12
1796 \font\secsy=cmsy10 scaled \magstep1
1798 % Subsection fonts (10pt).
1799 \def\ssecnominalsize{10pt}
1800 \setfont\ssecrm\rmbshape{10}{1000}
1801 \setfont\ssecit\itbshape{10}{1000}
1802 \setfont\ssecsl\slbshape{10}{1000}
1803 \setfont\ssectt\ttbshape{10}{1000}
1804 \setfont\ssecttsl\ttslshape{10}{1000}
1805 \setfont\ssecsf\sfbshape{10}{1000}
1806 \let\ssecbf\ssecrm
1807 \setfont\ssecsc\scbshape{10}{1000}
1808 \font\sseci=cmmi10
1809 \font\ssecsy=cmsy10
1811 % Reduced fonts for @acro in text (9pt).
1812 \def\reducednominalsize{9pt}
1813 \setfont\reducedrm\rmshape{9}{1000}
1814 \setfont\reducedtt\ttshape{9}{1000}
1815 \setfont\reducedbf\bfshape{10}{900}
1816 \setfont\reducedit\itshape{9}{1000}
1817 \setfont\reducedsl\slshape{9}{1000}
1818 \setfont\reducedsf\sfshape{9}{1000}
1819 \setfont\reducedsc\scshape{10}{900}
1820 \setfont\reducedttsl\ttslshape{10}{900}
1821 \font\reducedi=cmmi9
1822 \font\reducedsy=cmsy9
1824 % reduce space between paragraphs
1825 \divide\parskip by 2
1827 % reset the current fonts
1828 \textfonts
1830 } % end of 10pt text font size definitions
1833 % We provide the user-level command
1834 % @fonttextsize 10
1835 % (or 11) to redefine the text font size. pt is assumed.
1837 \def\xword{10}
1838 \def\xiword{11}
1840 \parseargdef\fonttextsize{%
1841 \def\textsizearg{#1}%
1842 \wlog{doing @fonttextsize \textsizearg}%
1844 % Set \globaldefs so that documents can use this inside @tex, since
1845 % makeinfo 4.8 does not support it, but we need it nonetheless.
1847 \begingroup \globaldefs=1
1848 \ifx\textsizearg\xword \definetextfontsizex
1849 \else \ifx\textsizearg\xiword \definetextfontsizexi
1850 \else
1851 \errhelp=\EMsimple
1852 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1853 \fi\fi
1854 \endgroup
1858 % In order for the font changes to affect most math symbols and letters,
1859 % we have to define the \textfont of the standard families. Since
1860 % texinfo doesn't allow for producing subscripts and superscripts except
1861 % in the main text, we don't bother to reset \scriptfont and
1862 % \scriptscriptfont (which would also require loading a lot more fonts).
1864 \def\resetmathfonts{%
1865 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1866 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1867 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1870 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1871 % of just \STYLE. We do this because \STYLE needs to also set the
1872 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1873 % \tenSTYLE to set the current font.
1875 % Each font-changing command also sets the names \lsize (one size lower)
1876 % and \lllsize (three sizes lower). These relative commands are used in
1877 % the LaTeX logo and acronyms.
1879 % This all needs generalizing, badly.
1881 \def\textfonts{%
1882 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1883 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1884 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1885 \let\tenttsl=\textttsl
1886 \def\curfontsize{text}%
1887 \def\lsize{reduced}\def\lllsize{smaller}%
1888 \resetmathfonts \setleading{\textleading}}
1889 \def\titlefonts{%
1890 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1891 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1892 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1893 \let\tenttsl=\titlettsl
1894 \def\curfontsize{title}%
1895 \def\lsize{chap}\def\lllsize{subsec}%
1896 \resetmathfonts \setleading{25pt}}
1897 \def\titlefont#1{{\titlefonts\rm #1}}
1898 \def\chapfonts{%
1899 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1900 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1901 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1902 \let\tenttsl=\chapttsl
1903 \def\curfontsize{chap}%
1904 \def\lsize{sec}\def\lllsize{text}%
1905 \resetmathfonts \setleading{19pt}}
1906 \def\secfonts{%
1907 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1908 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1909 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1910 \let\tenttsl=\secttsl
1911 \def\curfontsize{sec}%
1912 \def\lsize{subsec}\def\lllsize{reduced}%
1913 \resetmathfonts \setleading{16pt}}
1914 \def\subsecfonts{%
1915 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1916 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1917 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1918 \let\tenttsl=\ssecttsl
1919 \def\curfontsize{ssec}%
1920 \def\lsize{text}\def\lllsize{small}%
1921 \resetmathfonts \setleading{15pt}}
1922 \let\subsubsecfonts = \subsecfonts
1923 \def\reducedfonts{%
1924 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1925 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1926 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1927 \let\tenttsl=\reducedttsl
1928 \def\curfontsize{reduced}%
1929 \def\lsize{small}\def\lllsize{smaller}%
1930 \resetmathfonts \setleading{10.5pt}}
1931 \def\smallfonts{%
1932 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1933 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1934 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1935 \let\tenttsl=\smallttsl
1936 \def\curfontsize{small}%
1937 \def\lsize{smaller}\def\lllsize{smaller}%
1938 \resetmathfonts \setleading{10.5pt}}
1939 \def\smallerfonts{%
1940 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1941 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1942 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1943 \let\tenttsl=\smallerttsl
1944 \def\curfontsize{smaller}%
1945 \def\lsize{smaller}\def\lllsize{smaller}%
1946 \resetmathfonts \setleading{9.5pt}}
1948 % Set the fonts to use with the @small... environments.
1949 \let\smallexamplefonts = \smallfonts
1951 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1952 % can fit this many characters:
1953 % 8.5x11=86 smallbook=72 a4=90 a5=69
1954 % If we use \scriptfonts (8pt), then we can fit this many characters:
1955 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1956 % For me, subjectively, the few extra characters that fit aren't worth
1957 % the additional smallness of 8pt. So I'm making the default 9pt.
1959 % By the way, for comparison, here's what fits with @example (10pt):
1960 % 8.5x11=71 smallbook=60 a4=75 a5=58
1962 % I wish the USA used A4 paper.
1963 % --karl, 24jan03.
1966 % Set up the default fonts, so we can use them for creating boxes.
1968 \definetextfontsizexi
1970 % Define these so they can be easily changed for other fonts.
1971 \def\angleleft{$\langle$}
1972 \def\angleright{$\rangle$}
1974 % Count depth in font-changes, for error checks
1975 \newcount\fontdepth \fontdepth=0
1977 % Fonts for short table of contents.
1978 \setfont\shortcontrm\rmshape{12}{1000}
1979 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1980 \setfont\shortcontsl\slshape{12}{1000}
1981 \setfont\shortconttt\ttshape{12}{1000}
1983 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1984 %% serif) and @ii for TeX italic
1986 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1987 % unless the following character is such as not to need one.
1988 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1989 \ptexslash\fi\fi\fi}
1990 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1991 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1993 % like \smartslanted except unconditionally uses \ttsl.
1994 % @var is set to this for defun arguments.
1995 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1997 % like \smartslanted except unconditionally use \sl. We never want
1998 % ttsl for book titles, do we?
1999 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2001 \let\i=\smartitalic
2002 \let\slanted=\smartslanted
2003 \let\var=\smartslanted
2004 \let\dfn=\smartslanted
2005 \let\emph=\smartitalic
2007 % @b, explicit bold.
2008 \def\b#1{{\bf #1}}
2009 \let\strong=\b
2011 % @sansserif, explicit sans.
2012 \def\sansserif#1{{\sf #1}}
2014 % We can't just use \exhyphenpenalty, because that only has effect at
2015 % the end of a paragraph. Restore normal hyphenation at the end of the
2016 % group within which \nohyphenation is presumably called.
2018 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2019 \def\restorehyphenation{\hyphenchar\font = `- }
2021 % Set sfcode to normal for the chars that usually have another value.
2022 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2023 % sometimes \x has an active definition that messes things up.
2025 \catcode`@=11
2026 \def\plainfrenchspacing{%
2027 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2028 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2029 \def\endofsentencespacefactor{1000}% for @. and friends
2031 \def\plainnonfrenchspacing{%
2032 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2033 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2034 \def\endofsentencespacefactor{3000}% for @. and friends
2036 \catcode`@=\other
2037 \def\endofsentencespacefactor{3000}% default
2039 \def\t#1{%
2040 {\tt \rawbackslash \plainfrenchspacing #1}%
2041 \null
2043 \def\samp#1{`\tclose{#1}'\null}
2044 \setfont\keyrm\rmshape{8}{1000}
2045 \font\keysy=cmsy9
2046 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2047 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2048 \vbox{\hrule\kern-0.4pt
2049 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2050 \kern-0.4pt\hrule}%
2051 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2052 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2053 % The old definition, with no lozenge:
2054 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2055 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2057 % @file, @option are the same as @samp.
2058 \let\file=\samp
2059 \let\option=\samp
2061 % @code is a modification of @t,
2062 % which makes spaces the same size as normal in the surrounding text.
2063 \def\tclose#1{%
2065 % Change normal interword space to be same as for the current font.
2066 \spaceskip = \fontdimen2\font
2068 % Switch to typewriter.
2071 % But `\ ' produces the large typewriter interword space.
2072 \def\ {{\spaceskip = 0pt{} }}%
2074 % Turn off hyphenation.
2075 \nohyphenation
2077 \rawbackslash
2078 \plainfrenchspacing
2081 \null
2084 % We *must* turn on hyphenation at `-' and `_' in @code.
2085 % Otherwise, it is too hard to avoid overfull hboxes
2086 % in the Emacs manual, the Library manual, etc.
2088 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2089 % both hyphenation at - and hyphenation within words.
2090 % We must therefore turn them both off (\tclose does that)
2091 % and arrange explicitly to hyphenate at a dash.
2092 % -- rms.
2094 \catcode`\-=\active \catcode`\_=\active
2095 \catcode`\'=\active \catcode`\`=\active
2097 \global\def\code{\begingroup
2098 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2099 \let'\codequoteright \let`\codequoteleft
2101 \catcode\dashChar=\active \catcode\underChar=\active
2102 \ifallowcodebreaks
2103 \let-\codedash
2104 \let_\codeunder
2105 \else
2106 \let-\realdash
2107 \let_\realunder
2109 \codex
2113 \def\realdash{-}
2114 \def\codedash{-\discretionary{}{}{}}
2115 \def\codeunder{%
2116 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2117 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2118 % will therefore expand the active definition of _, which is us
2119 % (inside @code that is), therefore an endless loop.
2120 \ifusingtt{\ifmmode
2121 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2122 \else\normalunderscore \fi
2123 \discretionary{}{}{}}%
2124 {\_}%
2126 \def\codex #1{\tclose{#1}\endgroup}
2128 % An additional complication: the above will allow breaks after, e.g.,
2129 % each of the four underscores in __typeof__. This is undesirable in
2130 % some manuals, especially if they don't have long identifiers in
2131 % general. @allowcodebreaks provides a way to control this.
2133 \newif\ifallowcodebreaks \allowcodebreakstrue
2135 \def\keywordtrue{true}
2136 \def\keywordfalse{false}
2138 \parseargdef\allowcodebreaks{%
2139 \def\txiarg{#1}%
2140 \ifx\txiarg\keywordtrue
2141 \allowcodebreakstrue
2142 \else\ifx\txiarg\keywordfalse
2143 \allowcodebreaksfalse
2144 \else
2145 \errhelp = \EMsimple
2146 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2147 \fi\fi
2150 % @kbd is like @code, except that if the argument is just one @key command,
2151 % then @kbd has no effect.
2153 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2154 % `example' (@kbd uses ttsl only inside of @example and friends),
2155 % or `code' (@kbd uses normal tty font always).
2156 \parseargdef\kbdinputstyle{%
2157 \def\txiarg{#1}%
2158 \ifx\txiarg\worddistinct
2159 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2160 \else\ifx\txiarg\wordexample
2161 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2162 \else\ifx\txiarg\wordcode
2163 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2164 \else
2165 \errhelp = \EMsimple
2166 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2167 \fi\fi\fi
2169 \def\worddistinct{distinct}
2170 \def\wordexample{example}
2171 \def\wordcode{code}
2173 % Default is `distinct.'
2174 \kbdinputstyle distinct
2176 \def\xkey{\key}
2177 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2178 \ifx\one\xkey\ifx\threex\three \key{#2}%
2179 \else{\tclose{\kbdfont\look}}\fi
2180 \else{\tclose{\kbdfont\look}}\fi}
2182 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2183 \let\indicateurl=\code
2184 \let\env=\code
2185 \let\command=\code
2187 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2188 % second argument specifying the text to display and an optional third
2189 % arg as text to display instead of (rather than in addition to) the url
2190 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2191 % a hypertex \special here.
2193 \def\uref#1{\douref #1,,,\finish}
2194 \def\douref#1,#2,#3,#4\finish{\begingroup
2195 \unsepspaces
2196 \pdfurl{#1}%
2197 \setbox0 = \hbox{\ignorespaces #3}%
2198 \ifdim\wd0 > 0pt
2199 \unhbox0 % third arg given, show only that
2200 \else
2201 \setbox0 = \hbox{\ignorespaces #2}%
2202 \ifdim\wd0 > 0pt
2203 \ifpdf
2204 \unhbox0 % PDF: 2nd arg given, show only it
2205 \else
2206 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2208 \else
2209 \code{#1}% only url given, so show it
2212 \endlink
2213 \endgroup}
2215 % @url synonym for @uref, since that's how everyone uses it.
2217 \let\url=\uref
2219 % rms does not like angle brackets --karl, 17may97.
2220 % So now @email is just like @uref, unless we are pdf.
2222 %\def\email#1{\angleleft{\tt #1}\angleright}
2223 \ifpdf
2224 \def\email#1{\doemail#1,,\finish}
2225 \def\doemail#1,#2,#3\finish{\begingroup
2226 \unsepspaces
2227 \pdfurl{mailto:#1}%
2228 \setbox0 = \hbox{\ignorespaces #2}%
2229 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2230 \endlink
2231 \endgroup}
2232 \else
2233 \let\email=\uref
2236 % Check if we are currently using a typewriter font. Since all the
2237 % Computer Modern typewriter fonts have zero interword stretch (and
2238 % shrink), and it is reasonable to expect all typewriter fonts to have
2239 % this property, we can check that font parameter.
2241 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2243 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2244 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2246 \def\dmn#1{\thinspace #1}
2248 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2250 % @l was never documented to mean ``switch to the Lisp font'',
2251 % and it is not used as such in any manual I can find. We need it for
2252 % Polish suppressed-l. --karl, 22sep96.
2253 %\def\l#1{{\li #1}\null}
2255 % Explicit font changes: @r, @sc, undocumented @ii.
2256 \def\r#1{{\rm #1}} % roman font
2257 \def\sc#1{{\smallcaps#1}} % smallcaps font
2258 \def\ii#1{{\it #1}} % italic font
2260 % @acronym for "FBI", "NATO", and the like.
2261 % We print this one point size smaller, since it's intended for
2262 % all-uppercase.
2264 \def\acronym#1{\doacronym #1,,\finish}
2265 \def\doacronym#1,#2,#3\finish{%
2266 {\selectfonts\lsize #1}%
2267 \def\temp{#2}%
2268 \ifx\temp\empty \else
2269 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2273 % @abbr for "Comput. J." and the like.
2274 % No font change, but don't do end-of-sentence spacing.
2276 \def\abbr#1{\doabbr #1,,\finish}
2277 \def\doabbr#1,#2,#3\finish{%
2278 {\plainfrenchspacing #1}%
2279 \def\temp{#2}%
2280 \ifx\temp\empty \else
2281 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2285 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2287 \def\pounds{{\it\$}}
2289 % @euro{} comes from a separate font, depending on the current style.
2290 % We use the free feym* fonts from the eurosym package by Henrik
2291 % Theiling, which support regular, slanted, bold and bold slanted (and
2292 % "outlined" (blackboard board, sort of) versions, which we don't need).
2293 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2295 % Although only regular is the truly official Euro symbol, we ignore
2296 % that. The Euro is designed to be slightly taller than the regular
2297 % font height.
2299 % feymr - regular
2300 % feymo - slanted
2301 % feybr - bold
2302 % feybo - bold slanted
2304 % There is no good (free) typewriter version, to my knowledge.
2305 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2306 % Hmm.
2308 % Also doesn't work in math. Do we need to do math with euro symbols?
2309 % Hope not.
2312 \def\euro{{\eurofont e}}
2313 \def\eurofont{%
2314 % We set the font at each command, rather than predefining it in
2315 % \textfonts and the other font-switching commands, so that
2316 % installations which never need the symbol don't have to have the
2317 % font installed.
2319 % There is only one designed size (nominal 10pt), so we always scale
2320 % that to the current nominal size.
2322 % By the way, simply using "at 1em" works for cmr10 and the like, but
2323 % does not work for cmbx10 and other extended/shrunken fonts.
2325 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2327 \ifx\curfontstyle\bfstylename
2328 % bold:
2329 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2330 \else
2331 % regular:
2332 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2334 \thiseurofont
2337 % @registeredsymbol - R in a circle. The font for the R should really
2338 % be smaller yet, but lllsize is the best we can do for now.
2339 % Adapted from the plain.tex definition of \copyright.
2341 \def\registeredsymbol{%
2342 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2343 \hfil\crcr\Orb}}%
2347 % @textdegree - the normal degrees sign.
2349 \def\textdegree{$^\circ$}
2351 % Laurent Siebenmann reports \Orb undefined with:
2352 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2353 % so we'll define it if necessary.
2355 \ifx\Orb\undefined
2356 \def\Orb{\mathhexbox20D}
2360 \message{page headings,}
2362 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2363 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2365 % First the title page. Must do @settitle before @titlepage.
2366 \newif\ifseenauthor
2367 \newif\iffinishedtitlepage
2369 % Do an implicit @contents or @shortcontents after @end titlepage if the
2370 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2372 \newif\ifsetcontentsaftertitlepage
2373 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2374 \newif\ifsetshortcontentsaftertitlepage
2375 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2377 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2378 \endgroup\page\hbox{}\page}
2380 \envdef\titlepage{%
2381 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2382 \begingroup
2383 \parindent=0pt \textfonts
2384 % Leave some space at the very top of the page.
2385 \vglue\titlepagetopglue
2386 % No rule at page bottom unless we print one at the top with @title.
2387 \finishedtitlepagetrue
2389 % Most title ``pages'' are actually two pages long, with space
2390 % at the top of the second. We don't want the ragged left on the second.
2391 \let\oldpage = \page
2392 \def\page{%
2393 \iffinishedtitlepage\else
2394 \finishtitlepage
2396 \let\page = \oldpage
2397 \page
2398 \null
2402 \def\Etitlepage{%
2403 \iffinishedtitlepage\else
2404 \finishtitlepage
2406 % It is important to do the page break before ending the group,
2407 % because the headline and footline are only empty inside the group.
2408 % If we use the new definition of \page, we always get a blank page
2409 % after the title page, which we certainly don't want.
2410 \oldpage
2411 \endgroup
2413 % Need this before the \...aftertitlepage checks so that if they are
2414 % in effect the toc pages will come out with page numbers.
2415 \HEADINGSon
2417 % If they want short, they certainly want long too.
2418 \ifsetshortcontentsaftertitlepage
2419 \shortcontents
2420 \contents
2421 \global\let\shortcontents = \relax
2422 \global\let\contents = \relax
2425 \ifsetcontentsaftertitlepage
2426 \contents
2427 \global\let\contents = \relax
2428 \global\let\shortcontents = \relax
2432 \def\finishtitlepage{%
2433 \vskip4pt \hrule height 2pt width \hsize
2434 \vskip\titlepagebottomglue
2435 \finishedtitlepagetrue
2438 %%% Macros to be used within @titlepage:
2440 \let\subtitlerm=\tenrm
2441 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2443 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2444 \let\tt=\authortt}
2446 \parseargdef\title{%
2447 \checkenv\titlepage
2448 \leftline{\titlefonts\rm #1}
2449 % print a rule at the page bottom also.
2450 \finishedtitlepagefalse
2451 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2454 \parseargdef\subtitle{%
2455 \checkenv\titlepage
2456 {\subtitlefont \rightline{#1}}%
2459 % @author should come last, but may come many times.
2460 % It can also be used inside @quotation.
2462 \parseargdef\author{%
2463 \def\temp{\quotation}%
2464 \ifx\thisenv\temp
2465 \def\quotationauthor{#1}% printed in \Equotation.
2466 \else
2467 \checkenv\titlepage
2468 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2469 {\authorfont \leftline{#1}}%
2474 %%% Set up page headings and footings.
2476 \let\thispage=\folio
2478 \newtoks\evenheadline % headline on even pages
2479 \newtoks\oddheadline % headline on odd pages
2480 \newtoks\evenfootline % footline on even pages
2481 \newtoks\oddfootline % footline on odd pages
2483 % Now make TeX use those variables
2484 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2485 \else \the\evenheadline \fi}}
2486 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2487 \else \the\evenfootline \fi}\HEADINGShook}
2488 \let\HEADINGShook=\relax
2490 % Commands to set those variables.
2491 % For example, this is what @headings on does
2492 % @evenheading @thistitle|@thispage|@thischapter
2493 % @oddheading @thischapter|@thispage|@thistitle
2494 % @evenfooting @thisfile||
2495 % @oddfooting ||@thisfile
2498 \def\evenheading{\parsearg\evenheadingxxx}
2499 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2500 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2501 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2503 \def\oddheading{\parsearg\oddheadingxxx}
2504 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2505 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2506 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2508 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2510 \def\evenfooting{\parsearg\evenfootingxxx}
2511 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2512 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2513 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2515 \def\oddfooting{\parsearg\oddfootingxxx}
2516 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2517 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2518 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2520 % Leave some space for the footline. Hopefully ok to assume
2521 % @evenfooting will not be used by itself.
2522 \global\advance\pageheight by -12pt
2523 \global\advance\vsize by -12pt
2526 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2529 % @headings double turns headings on for double-sided printing.
2530 % @headings single turns headings on for single-sided printing.
2531 % @headings off turns them off.
2532 % @headings on same as @headings double, retained for compatibility.
2533 % @headings after turns on double-sided headings after this page.
2534 % @headings doubleafter turns on double-sided headings after this page.
2535 % @headings singleafter turns on single-sided headings after this page.
2536 % By default, they are off at the start of a document,
2537 % and turned `on' after @end titlepage.
2539 \def\headings #1 {\csname HEADINGS#1\endcsname}
2541 \def\HEADINGSoff{%
2542 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2543 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2544 \HEADINGSoff
2545 % When we turn headings on, set the page number to 1.
2546 % For double-sided printing, put current file name in lower left corner,
2547 % chapter name on inside top of right hand pages, document
2548 % title on inside top of left hand pages, and page numbers on outside top
2549 % edge of all pages.
2550 \def\HEADINGSdouble{%
2551 \global\pageno=1
2552 \global\evenfootline={\hfil}
2553 \global\oddfootline={\hfil}
2554 \global\evenheadline={\line{\folio\hfil\thistitle}}
2555 \global\oddheadline={\line{\thischapter\hfil\folio}}
2556 \global\let\contentsalignmacro = \chapoddpage
2558 \let\contentsalignmacro = \chappager
2560 % For single-sided printing, chapter title goes across top left of page,
2561 % page number on top right.
2562 \def\HEADINGSsingle{%
2563 \global\pageno=1
2564 \global\evenfootline={\hfil}
2565 \global\oddfootline={\hfil}
2566 \global\evenheadline={\line{\thischapter\hfil\folio}}
2567 \global\oddheadline={\line{\thischapter\hfil\folio}}
2568 \global\let\contentsalignmacro = \chappager
2570 \def\HEADINGSon{\HEADINGSdouble}
2572 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2573 \let\HEADINGSdoubleafter=\HEADINGSafter
2574 \def\HEADINGSdoublex{%
2575 \global\evenfootline={\hfil}
2576 \global\oddfootline={\hfil}
2577 \global\evenheadline={\line{\folio\hfil\thistitle}}
2578 \global\oddheadline={\line{\thischapter\hfil\folio}}
2579 \global\let\contentsalignmacro = \chapoddpage
2582 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2583 \def\HEADINGSsinglex{%
2584 \global\evenfootline={\hfil}
2585 \global\oddfootline={\hfil}
2586 \global\evenheadline={\line{\thischapter\hfil\folio}}
2587 \global\oddheadline={\line{\thischapter\hfil\folio}}
2588 \global\let\contentsalignmacro = \chappager
2591 % Subroutines used in generating headings
2592 % This produces Day Month Year style of output.
2593 % Only define if not already defined, in case a txi-??.tex file has set
2594 % up a different format (e.g., txi-cs.tex does this).
2595 \ifx\today\undefined
2596 \def\today{%
2597 \number\day\space
2598 \ifcase\month
2599 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2600 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2601 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2603 \space\number\year}
2606 % @settitle line... specifies the title of the document, for headings.
2607 % It generates no output of its own.
2608 \def\thistitle{\putwordNoTitle}
2609 \def\settitle{\parsearg{\gdef\thistitle}}
2612 \message{tables,}
2613 % Tables -- @table, @ftable, @vtable, @item(x).
2615 % default indentation of table text
2616 \newdimen\tableindent \tableindent=.8in
2617 % default indentation of @itemize and @enumerate text
2618 \newdimen\itemindent \itemindent=.3in
2619 % margin between end of table item and start of table text.
2620 \newdimen\itemmargin \itemmargin=.1in
2622 % used internally for \itemindent minus \itemmargin
2623 \newdimen\itemmax
2625 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2626 % these defs.
2627 % They also define \itemindex
2628 % to index the item name in whatever manner is desired (perhaps none).
2630 \newif\ifitemxneedsnegativevskip
2632 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2634 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2635 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2637 \def\itemzzz #1{\begingroup %
2638 \advance\hsize by -\rightskip
2639 \advance\hsize by -\tableindent
2640 \setbox0=\hbox{\itemindicate{#1}}%
2641 \itemindex{#1}%
2642 \nobreak % This prevents a break before @itemx.
2644 % If the item text does not fit in the space we have, put it on a line
2645 % by itself, and do not allow a page break either before or after that
2646 % line. We do not start a paragraph here because then if the next
2647 % command is, e.g., @kindex, the whatsit would get put into the
2648 % horizontal list on a line by itself, resulting in extra blank space.
2649 \ifdim \wd0>\itemmax
2651 % Make this a paragraph so we get the \parskip glue and wrapping,
2652 % but leave it ragged-right.
2653 \begingroup
2654 \advance\leftskip by-\tableindent
2655 \advance\hsize by\tableindent
2656 \advance\rightskip by0pt plus1fil
2657 \leavevmode\unhbox0\par
2658 \endgroup
2660 % We're going to be starting a paragraph, but we don't want the
2661 % \parskip glue -- logically it's part of the @item we just started.
2662 \nobreak \vskip-\parskip
2664 % Stop a page break at the \parskip glue coming up. However, if
2665 % what follows is an environment such as @example, there will be no
2666 % \parskip glue; then the negative vskip we just inserted would
2667 % cause the example and the item to crash together. So we use this
2668 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2669 % \parskip glue after all. Section titles are handled this way also.
2671 \penalty 10001
2672 \endgroup
2673 \itemxneedsnegativevskipfalse
2674 \else
2675 % The item text fits into the space. Start a paragraph, so that the
2676 % following text (if any) will end up on the same line.
2677 \noindent
2678 % Do this with kerns and \unhbox so that if there is a footnote in
2679 % the item text, it can migrate to the main vertical list and
2680 % eventually be printed.
2681 \nobreak\kern-\tableindent
2682 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2683 \unhbox0
2684 \nobreak\kern\dimen0
2685 \endgroup
2686 \itemxneedsnegativevskiptrue
2690 \def\item{\errmessage{@item while not in a list environment}}
2691 \def\itemx{\errmessage{@itemx while not in a list environment}}
2693 % @table, @ftable, @vtable.
2694 \envdef\table{%
2695 \let\itemindex\gobble
2696 \tablecheck{table}%
2698 \envdef\ftable{%
2699 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2700 \tablecheck{ftable}%
2702 \envdef\vtable{%
2703 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2704 \tablecheck{vtable}%
2706 \def\tablecheck#1{%
2707 \ifnum \the\catcode`\^^M=\active
2708 \endgroup
2709 \errmessage{This command won't work in this context; perhaps the problem is
2710 that we are \inenvironment\thisenv}%
2711 \def\next{\doignore{#1}}%
2712 \else
2713 \let\next\tablex
2715 \next
2717 \def\tablex#1{%
2718 \def\itemindicate{#1}%
2719 \parsearg\tabley
2721 \def\tabley#1{%
2723 \makevalueexpandable
2724 \edef\temp{\noexpand\tablez #1\space\space\space}%
2725 \expandafter
2726 }\temp \endtablez
2728 \def\tablez #1 #2 #3 #4\endtablez{%
2729 \aboveenvbreak
2730 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2731 \ifnum 0#2>0 \tableindent=#2\mil \fi
2732 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2733 \itemmax=\tableindent
2734 \advance \itemmax by -\itemmargin
2735 \advance \leftskip by \tableindent
2736 \exdentamount=\tableindent
2737 \parindent = 0pt
2738 \parskip = \smallskipamount
2739 \ifdim \parskip=0pt \parskip=2pt \fi
2740 \let\item = \internalBitem
2741 \let\itemx = \internalBitemx
2743 \def\Etable{\endgraf\afterenvbreak}
2744 \let\Eftable\Etable
2745 \let\Evtable\Etable
2746 \let\Eitemize\Etable
2747 \let\Eenumerate\Etable
2749 % This is the counter used by @enumerate, which is really @itemize
2751 \newcount \itemno
2753 \envdef\itemize{\parsearg\doitemize}
2755 \def\doitemize#1{%
2756 \aboveenvbreak
2757 \itemmax=\itemindent
2758 \advance\itemmax by -\itemmargin
2759 \advance\leftskip by \itemindent
2760 \exdentamount=\itemindent
2761 \parindent=0pt
2762 \parskip=\smallskipamount
2763 \ifdim\parskip=0pt \parskip=2pt \fi
2764 \def\itemcontents{#1}%
2765 % @itemize with no arg is equivalent to @itemize @bullet.
2766 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2767 \let\item=\itemizeitem
2770 % Definition of @item while inside @itemize and @enumerate.
2772 \def\itemizeitem{%
2773 \advance\itemno by 1 % for enumerations
2774 {\let\par=\endgraf \smallbreak}% reasonable place to break
2776 % If the document has an @itemize directly after a section title, a
2777 % \nobreak will be last on the list, and \sectionheading will have
2778 % done a \vskip-\parskip. In that case, we don't want to zero
2779 % parskip, or the item text will crash with the heading. On the
2780 % other hand, when there is normal text preceding the item (as there
2781 % usually is), we do want to zero parskip, or there would be too much
2782 % space. In that case, we won't have a \nobreak before. At least
2783 % that's the theory.
2784 \ifnum\lastpenalty<10000 \parskip=0in \fi
2785 \noindent
2786 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2787 \vadjust{\penalty 1200}}% not good to break after first line of item.
2788 \flushcr
2791 % \splitoff TOKENS\endmark defines \first to be the first token in
2792 % TOKENS, and \rest to be the remainder.
2794 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2796 % Allow an optional argument of an uppercase letter, lowercase letter,
2797 % or number, to specify the first label in the enumerated list. No
2798 % argument is the same as `1'.
2800 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2801 \def\enumeratey #1 #2\endenumeratey{%
2802 % If we were given no argument, pretend we were given `1'.
2803 \def\thearg{#1}%
2804 \ifx\thearg\empty \def\thearg{1}\fi
2806 % Detect if the argument is a single token. If so, it might be a
2807 % letter. Otherwise, the only valid thing it can be is a number.
2808 % (We will always have one token, because of the test we just made.
2809 % This is a good thing, since \splitoff doesn't work given nothing at
2810 % all -- the first parameter is undelimited.)
2811 \expandafter\splitoff\thearg\endmark
2812 \ifx\rest\empty
2813 % Only one token in the argument. It could still be anything.
2814 % A ``lowercase letter'' is one whose \lccode is nonzero.
2815 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2816 % not equal to itself.
2817 % Otherwise, we assume it's a number.
2819 % We need the \relax at the end of the \ifnum lines to stop TeX from
2820 % continuing to look for a <number>.
2822 \ifnum\lccode\expandafter`\thearg=0\relax
2823 \numericenumerate % a number (we hope)
2824 \else
2825 % It's a letter.
2826 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2827 \lowercaseenumerate % lowercase letter
2828 \else
2829 \uppercaseenumerate % uppercase letter
2832 \else
2833 % Multiple tokens in the argument. We hope it's a number.
2834 \numericenumerate
2838 % An @enumerate whose labels are integers. The starting integer is
2839 % given in \thearg.
2841 \def\numericenumerate{%
2842 \itemno = \thearg
2843 \startenumeration{\the\itemno}%
2846 % The starting (lowercase) letter is in \thearg.
2847 \def\lowercaseenumerate{%
2848 \itemno = \expandafter`\thearg
2849 \startenumeration{%
2850 % Be sure we're not beyond the end of the alphabet.
2851 \ifnum\itemno=0
2852 \errmessage{No more lowercase letters in @enumerate; get a bigger
2853 alphabet}%
2855 \char\lccode\itemno
2859 % The starting (uppercase) letter is in \thearg.
2860 \def\uppercaseenumerate{%
2861 \itemno = \expandafter`\thearg
2862 \startenumeration{%
2863 % Be sure we're not beyond the end of the alphabet.
2864 \ifnum\itemno=0
2865 \errmessage{No more uppercase letters in @enumerate; get a bigger
2866 alphabet}
2868 \char\uccode\itemno
2872 % Call \doitemize, adding a period to the first argument and supplying the
2873 % common last two arguments. Also subtract one from the initial value in
2874 % \itemno, since @item increments \itemno.
2876 \def\startenumeration#1{%
2877 \advance\itemno by -1
2878 \doitemize{#1.}\flushcr
2881 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2882 % to @enumerate.
2884 \def\alphaenumerate{\enumerate{a}}
2885 \def\capsenumerate{\enumerate{A}}
2886 \def\Ealphaenumerate{\Eenumerate}
2887 \def\Ecapsenumerate{\Eenumerate}
2890 % @multitable macros
2891 % Amy Hendrickson, 8/18/94, 3/6/96
2893 % @multitable ... @end multitable will make as many columns as desired.
2894 % Contents of each column will wrap at width given in preamble. Width
2895 % can be specified either with sample text given in a template line,
2896 % or in percent of \hsize, the current width of text on page.
2898 % Table can continue over pages but will only break between lines.
2900 % To make preamble:
2902 % Either define widths of columns in terms of percent of \hsize:
2903 % @multitable @columnfractions .25 .3 .45
2904 % @item ...
2906 % Numbers following @columnfractions are the percent of the total
2907 % current hsize to be used for each column. You may use as many
2908 % columns as desired.
2911 % Or use a template:
2912 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2913 % @item ...
2914 % using the widest term desired in each column.
2916 % Each new table line starts with @item, each subsequent new column
2917 % starts with @tab. Empty columns may be produced by supplying @tab's
2918 % with nothing between them for as many times as empty columns are needed,
2919 % ie, @tab@tab@tab will produce two empty columns.
2921 % @item, @tab do not need to be on their own lines, but it will not hurt
2922 % if they are.
2924 % Sample multitable:
2926 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2927 % @item first col stuff @tab second col stuff @tab third col
2928 % @item
2929 % first col stuff
2930 % @tab
2931 % second col stuff
2932 % @tab
2933 % third col
2934 % @item first col stuff @tab second col stuff
2935 % @tab Many paragraphs of text may be used in any column.
2937 % They will wrap at the width determined by the template.
2938 % @item@tab@tab This will be in third column.
2939 % @end multitable
2941 % Default dimensions may be reset by user.
2942 % @multitableparskip is vertical space between paragraphs in table.
2943 % @multitableparindent is paragraph indent in table.
2944 % @multitablecolmargin is horizontal space to be left between columns.
2945 % @multitablelinespace is space to leave between table items, baseline
2946 % to baseline.
2947 % 0pt means it depends on current normal line spacing.
2949 \newskip\multitableparskip
2950 \newskip\multitableparindent
2951 \newdimen\multitablecolspace
2952 \newskip\multitablelinespace
2953 \multitableparskip=0pt
2954 \multitableparindent=6pt
2955 \multitablecolspace=12pt
2956 \multitablelinespace=0pt
2958 % Macros used to set up halign preamble:
2960 \let\endsetuptable\relax
2961 \def\xendsetuptable{\endsetuptable}
2962 \let\columnfractions\relax
2963 \def\xcolumnfractions{\columnfractions}
2964 \newif\ifsetpercent
2966 % #1 is the @columnfraction, usually a decimal number like .5, but might
2967 % be just 1. We just use it, whatever it is.
2969 \def\pickupwholefraction#1 {%
2970 \global\advance\colcount by 1
2971 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2972 \setuptable
2975 \newcount\colcount
2976 \def\setuptable#1{%
2977 \def\firstarg{#1}%
2978 \ifx\firstarg\xendsetuptable
2979 \let\go = \relax
2980 \else
2981 \ifx\firstarg\xcolumnfractions
2982 \global\setpercenttrue
2983 \else
2984 \ifsetpercent
2985 \let\go\pickupwholefraction
2986 \else
2987 \global\advance\colcount by 1
2988 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2989 % separator; typically that is always in the input, anyway.
2990 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2993 \ifx\go\pickupwholefraction
2994 % Put the argument back for the \pickupwholefraction call, so
2995 % we'll always have a period there to be parsed.
2996 \def\go{\pickupwholefraction#1}%
2997 \else
2998 \let\go = \setuptable
2999 \fi%
3004 % multitable-only commands.
3006 % @headitem starts a heading row, which we typeset in bold.
3007 % Assignments have to be global since we are inside the implicit group
3008 % of an alignment entry. Note that \everycr resets \everytab.
3009 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3011 % A \tab used to include \hskip1sp. But then the space in a template
3012 % line is not enough. That is bad. So let's go back to just `&' until
3013 % we encounter the problem it was intended to solve again.
3014 % --karl, nathan@acm.org, 20apr99.
3015 \def\tab{\checkenv\multitable &\the\everytab}%
3017 % @multitable ... @end multitable definitions:
3019 \newtoks\everytab % insert after every tab.
3021 \envdef\multitable{%
3022 \vskip\parskip
3023 \startsavinginserts
3025 % @item within a multitable starts a normal row.
3026 % We use \def instead of \let so that if one of the multitable entries
3027 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3028 % \endtemplate) expanding \doitemize.
3029 \def\item{\crcr}%
3031 \tolerance=9500
3032 \hbadness=9500
3033 \setmultitablespacing
3034 \parskip=\multitableparskip
3035 \parindent=\multitableparindent
3036 \overfullrule=0pt
3037 \global\colcount=0
3039 \everycr = {%
3040 \noalign{%
3041 \global\everytab={}%
3042 \global\colcount=0 % Reset the column counter.
3043 % Check for saved footnotes, etc.
3044 \checkinserts
3045 % Keeps underfull box messages off when table breaks over pages.
3046 %\filbreak
3047 % Maybe so, but it also creates really weird page breaks when the
3048 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3049 % problem manifests itself, so it can be fixed for real --karl.
3053 \parsearg\domultitable
3055 \def\domultitable#1{%
3056 % To parse everything between @multitable and @item:
3057 \setuptable#1 \endsetuptable
3059 % This preamble sets up a generic column definition, which will
3060 % be used as many times as user calls for columns.
3061 % \vtop will set a single line and will also let text wrap and
3062 % continue for many paragraphs if desired.
3063 \halign\bgroup &%
3064 \global\advance\colcount by 1
3065 \multistrut
3066 \vtop{%
3067 % Use the current \colcount to find the correct column width:
3068 \hsize=\expandafter\csname col\the\colcount\endcsname
3070 % In order to keep entries from bumping into each other
3071 % we will add a \leftskip of \multitablecolspace to all columns after
3072 % the first one.
3074 % If a template has been used, we will add \multitablecolspace
3075 % to the width of each template entry.
3077 % If the user has set preamble in terms of percent of \hsize we will
3078 % use that dimension as the width of the column, and the \leftskip
3079 % will keep entries from bumping into each other. Table will start at
3080 % left margin and final column will justify at right margin.
3082 % Make sure we don't inherit \rightskip from the outer environment.
3083 \rightskip=0pt
3084 \ifnum\colcount=1
3085 % The first column will be indented with the surrounding text.
3086 \advance\hsize by\leftskip
3087 \else
3088 \ifsetpercent \else
3089 % If user has not set preamble in terms of percent of \hsize
3090 % we will advance \hsize by \multitablecolspace.
3091 \advance\hsize by \multitablecolspace
3093 % In either case we will make \leftskip=\multitablecolspace:
3094 \leftskip=\multitablecolspace
3096 % Ignoring space at the beginning and end avoids an occasional spurious
3097 % blank line, when TeX decides to break the line at the space before the
3098 % box from the multistrut, so the strut ends up on a line by itself.
3099 % For example:
3100 % @multitable @columnfractions .11 .89
3101 % @item @code{#}
3102 % @tab Legal holiday which is valid in major parts of the whole country.
3103 % Is automatically provided with highlighting sequences respectively
3104 % marking characters.
3105 \noindent\ignorespaces##\unskip\multistrut
3106 }\cr
3108 \def\Emultitable{%
3109 \crcr
3110 \egroup % end the \halign
3111 \global\setpercentfalse
3114 \def\setmultitablespacing{%
3115 \def\multistrut{\strut}% just use the standard line spacing
3117 % Compute \multitablelinespace (if not defined by user) for use in
3118 % \multitableparskip calculation. We used define \multistrut based on
3119 % this, but (ironically) that caused the spacing to be off.
3120 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3121 \ifdim\multitablelinespace=0pt
3122 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3123 \global\advance\multitablelinespace by-\ht0
3125 %% Test to see if parskip is larger than space between lines of
3126 %% table. If not, do nothing.
3127 %% If so, set to same dimension as multitablelinespace.
3128 \ifdim\multitableparskip>\multitablelinespace
3129 \global\multitableparskip=\multitablelinespace
3130 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3131 %% than skip between lines in the table.
3132 \fi%
3133 \ifdim\multitableparskip=0pt
3134 \global\multitableparskip=\multitablelinespace
3135 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3136 %% than skip between lines in the table.
3137 \fi}
3140 \message{conditionals,}
3142 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3143 % @ifnotxml always succeed. They currently do nothing; we don't
3144 % attempt to check whether the conditionals are properly nested. But we
3145 % have to remember that they are conditionals, so that @end doesn't
3146 % attempt to close an environment group.
3148 \def\makecond#1{%
3149 \expandafter\let\csname #1\endcsname = \relax
3150 \expandafter\let\csname iscond.#1\endcsname = 1
3152 \makecond{iftex}
3153 \makecond{ifnotdocbook}
3154 \makecond{ifnothtml}
3155 \makecond{ifnotinfo}
3156 \makecond{ifnotplaintext}
3157 \makecond{ifnotxml}
3159 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3161 \def\direntry{\doignore{direntry}}
3162 \def\documentdescription{\doignore{documentdescription}}
3163 \def\docbook{\doignore{docbook}}
3164 \def\html{\doignore{html}}
3165 \def\ifdocbook{\doignore{ifdocbook}}
3166 \def\ifhtml{\doignore{ifhtml}}
3167 \def\ifinfo{\doignore{ifinfo}}
3168 \def\ifnottex{\doignore{ifnottex}}
3169 \def\ifplaintext{\doignore{ifplaintext}}
3170 \def\ifxml{\doignore{ifxml}}
3171 \def\ignore{\doignore{ignore}}
3172 \def\menu{\doignore{menu}}
3173 \def\xml{\doignore{xml}}
3175 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3177 % A count to remember the depth of nesting.
3178 \newcount\doignorecount
3180 \def\doignore#1{\begingroup
3181 % Scan in ``verbatim'' mode:
3182 \obeylines
3183 \catcode`\@ = \other
3184 \catcode`\{ = \other
3185 \catcode`\} = \other
3187 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3188 \spaceisspace
3190 % Count number of #1's that we've seen.
3191 \doignorecount = 0
3193 % Swallow text until we reach the matching `@end #1'.
3194 \dodoignore{#1}%
3197 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3198 \obeylines %
3200 \gdef\dodoignore#1{%
3201 % #1 contains the command name as a string, e.g., `ifinfo'.
3203 % Define a command to find the next `@end #1'.
3204 \long\def\doignoretext##1^^M@end #1{%
3205 \doignoretextyyy##1^^M@#1\_STOP_}%
3207 % And this command to find another #1 command, at the beginning of a
3208 % line. (Otherwise, we would consider a line `@c @ifset', for
3209 % example, to count as an @ifset for nesting.)
3210 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3212 % And now expand that command.
3213 \doignoretext ^^M%
3217 \def\doignoreyyy#1{%
3218 \def\temp{#1}%
3219 \ifx\temp\empty % Nothing found.
3220 \let\next\doignoretextzzz
3221 \else % Found a nested condition, ...
3222 \advance\doignorecount by 1
3223 \let\next\doignoretextyyy % ..., look for another.
3224 % If we're here, #1 ends with ^^M\ifinfo (for example).
3226 \next #1% the token \_STOP_ is present just after this macro.
3229 % We have to swallow the remaining "\_STOP_".
3231 \def\doignoretextzzz#1{%
3232 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3233 \let\next\enddoignore
3234 \else % Still inside a nested condition.
3235 \advance\doignorecount by -1
3236 \let\next\doignoretext % Look for the next @end.
3238 \next
3241 % Finish off ignored text.
3242 { \obeylines%
3243 % Ignore anything after the last `@end #1'; this matters in verbatim
3244 % environments, where otherwise the newline after an ignored conditional
3245 % would result in a blank line in the output.
3246 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3250 % @set VAR sets the variable VAR to an empty value.
3251 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3253 % Since we want to separate VAR from REST-OF-LINE (which might be
3254 % empty), we can't just use \parsearg; we have to insert a space of our
3255 % own to delimit the rest of the line, and then take it out again if we
3256 % didn't need it.
3257 % We rely on the fact that \parsearg sets \catcode`\ =10.
3259 \parseargdef\set{\setyyy#1 \endsetyyy}
3260 \def\setyyy#1 #2\endsetyyy{%
3262 \makevalueexpandable
3263 \def\temp{#2}%
3264 \edef\next{\gdef\makecsname{SET#1}}%
3265 \ifx\temp\empty
3266 \next{}%
3267 \else
3268 \setzzz#2\endsetzzz
3272 % Remove the trailing space \setxxx inserted.
3273 \def\setzzz#1 \endsetzzz{\next{#1}}
3275 % @clear VAR clears (i.e., unsets) the variable VAR.
3277 \parseargdef\clear{%
3279 \makevalueexpandable
3280 \global\expandafter\let\csname SET#1\endcsname=\relax
3284 % @value{foo} gets the text saved in variable foo.
3285 \def\value{\begingroup\makevalueexpandable\valuexxx}
3286 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3288 \catcode`\- = \active \catcode`\_ = \active
3290 \gdef\makevalueexpandable{%
3291 \let\value = \expandablevalue
3292 % We don't want these characters active, ...
3293 \catcode`\-=\other \catcode`\_=\other
3294 % ..., but we might end up with active ones in the argument if
3295 % we're called from @code, as @code{@value{foo-bar_}}, though.
3296 % So \let them to their normal equivalents.
3297 \let-\realdash \let_\normalunderscore
3301 % We have this subroutine so that we can handle at least some @value's
3302 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3303 % The command has to be fully expandable (if the variable is set), since
3304 % the result winds up in the index file. This means that if the
3305 % variable's value contains other Texinfo commands, it's almost certain
3306 % it will fail (although perhaps we could fix that with sufficient work
3307 % to do a one-level expansion on the result, instead of complete).
3309 \def\expandablevalue#1{%
3310 \expandafter\ifx\csname SET#1\endcsname\relax
3311 {[No value for ``#1'']}%
3312 \message{Variable `#1', used in @value, is not set.}%
3313 \else
3314 \csname SET#1\endcsname
3318 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3319 % with @set.
3321 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3323 \makecond{ifset}
3324 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3325 \def\doifset#1#2{%
3327 \makevalueexpandable
3328 \let\next=\empty
3329 \expandafter\ifx\csname SET#2\endcsname\relax
3330 #1% If not set, redefine \next.
3332 \expandafter
3333 }\next
3335 \def\ifsetfail{\doignore{ifset}}
3337 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3338 % defined with @set, or has been undefined with @clear.
3340 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3341 % above code: if the variable is not set, do nothing, if it is set,
3342 % then redefine \next to \ifclearfail.
3344 \makecond{ifclear}
3345 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3346 \def\ifclearfail{\doignore{ifclear}}
3348 % @dircategory CATEGORY -- specify a category of the dir file
3349 % which this file should belong to. Ignore this in TeX.
3350 \let\dircategory=\comment
3352 % @defininfoenclose.
3353 \let\definfoenclose=\comment
3356 \message{indexing,}
3357 % Index generation facilities
3359 % Define \newwrite to be identical to plain tex's \newwrite
3360 % except not \outer, so it can be used within macros and \if's.
3361 \edef\newwrite{\makecsname{ptexnewwrite}}
3363 % \newindex {foo} defines an index named foo.
3364 % It automatically defines \fooindex such that
3365 % \fooindex ...rest of line... puts an entry in the index foo.
3366 % It also defines \fooindfile to be the number of the output channel for
3367 % the file that accumulates this index. The file's extension is foo.
3368 % The name of an index should be no more than 2 characters long
3369 % for the sake of vms.
3371 \def\newindex#1{%
3372 \iflinks
3373 \expandafter\newwrite \csname#1indfile\endcsname
3374 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3376 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3377 \noexpand\doindex{#1}}
3380 % @defindex foo == \newindex{foo}
3382 \def\defindex{\parsearg\newindex}
3384 % Define @defcodeindex, like @defindex except put all entries in @code.
3386 \def\defcodeindex{\parsearg\newcodeindex}
3388 \def\newcodeindex#1{%
3389 \iflinks
3390 \expandafter\newwrite \csname#1indfile\endcsname
3391 \openout \csname#1indfile\endcsname \jobname.#1
3393 \expandafter\xdef\csname#1index\endcsname{%
3394 \noexpand\docodeindex{#1}}%
3398 % @synindex foo bar makes index foo feed into index bar.
3399 % Do this instead of @defindex foo if you don't want it as a separate index.
3401 % @syncodeindex foo bar similar, but put all entries made for index foo
3402 % inside @code.
3404 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3405 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3407 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3408 % #3 the target index (bar).
3409 \def\dosynindex#1#2#3{%
3410 % Only do \closeout if we haven't already done it, else we'll end up
3411 % closing the target index.
3412 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3413 % The \closeout helps reduce unnecessary open files; the limit on the
3414 % Acorn RISC OS is a mere 16 files.
3415 \expandafter\closeout\csname#2indfile\endcsname
3416 \expandafter\let\csname\donesynindex#2\endcsname = 1
3418 % redefine \fooindfile:
3419 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3420 \expandafter\let\csname#2indfile\endcsname=\temp
3421 % redefine \fooindex:
3422 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3425 % Define \doindex, the driver for all \fooindex macros.
3426 % Argument #1 is generated by the calling \fooindex macro,
3427 % and it is "foo", the name of the index.
3429 % \doindex just uses \parsearg; it calls \doind for the actual work.
3430 % This is because \doind is more useful to call from other macros.
3432 % There is also \dosubind {index}{topic}{subtopic}
3433 % which makes an entry in a two-level index such as the operation index.
3435 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3436 \def\singleindexer #1{\doind{\indexname}{#1}}
3438 % like the previous two, but they put @code around the argument.
3439 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3440 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3442 % Take care of Texinfo commands that can appear in an index entry.
3443 % Since there are some commands we want to expand, and others we don't,
3444 % we have to laboriously prevent expansion for those that we don't.
3446 \def\indexdummies{%
3447 \escapechar = `\\ % use backslash in output files.
3448 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3449 \def\ {\realbackslash\space }%
3451 % Need these in case \tex is in effect and \{ is a \delimiter again.
3452 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3453 % braces and backslashes are used only as delimiters.
3454 \let\{ = \mylbrace
3455 \let\} = \myrbrace
3457 % I don't entirely understand this, but when an index entry is
3458 % generated from a macro call, the \endinput which \scanmacro inserts
3459 % causes processing to be prematurely terminated. This is,
3460 % apparently, because \indexsorttmp is fully expanded, and \endinput
3461 % is an expandable command. The redefinition below makes \endinput
3462 % disappear altogether for that purpose -- although logging shows that
3463 % processing continues to some further point. On the other hand, it
3464 % seems \endinput does not hurt in the printed index arg, since that
3465 % is still getting written without apparent harm.
3467 % Sample source (mac-idx3.tex, reported by Graham Percival to
3468 % help-texinfo, 22may06):
3469 % @macro funindex {WORD}
3470 % @findex xyz
3471 % @end macro
3472 % ...
3473 % @funindex commtest
3475 % The above is not enough to reproduce the bug, but it gives the flavor.
3477 % Sample whatsit resulting:
3478 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3480 % So:
3481 \let\endinput = \empty
3483 % Do the redefinitions.
3484 \commondummies
3487 % For the aux and toc files, @ is the escape character. So we want to
3488 % redefine everything using @ as the escape character (instead of
3489 % \realbackslash, still used for index files). When everything uses @,
3490 % this will be simpler.
3492 \def\atdummies{%
3493 \def\@{@@}%
3494 \def\ {@ }%
3495 \let\{ = \lbraceatcmd
3496 \let\} = \rbraceatcmd
3498 % Do the redefinitions.
3499 \commondummies
3500 \otherbackslash
3503 % Called from \indexdummies and \atdummies.
3505 \def\commondummies{%
3507 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3508 % preventing its expansion. This is used only for control% words,
3509 % not control letters, because the \space would be incorrect for
3510 % control characters, but is needed to separate the control word
3511 % from whatever follows.
3513 % For control letters, we have \definedummyletter, which omits the
3514 % space.
3516 % These can be used both for control words that take an argument and
3517 % those that do not. If it is followed by {arg} in the input, then
3518 % that will dutifully get written to the index (or wherever).
3520 \def\definedummyword ##1{\def##1{\string##1\space}}%
3521 \def\definedummyletter##1{\def##1{\string##1}}%
3522 \let\definedummyaccent\definedummyletter
3524 \commondummiesnofonts
3526 \definedummyletter\_%
3528 % Non-English letters.
3529 \definedummyword\AA
3530 \definedummyword\AE
3531 \definedummyword\L
3532 \definedummyword\OE
3533 \definedummyword\O
3534 \definedummyword\aa
3535 \definedummyword\ae
3536 \definedummyword\l
3537 \definedummyword\oe
3538 \definedummyword\o
3539 \definedummyword\ss
3540 \definedummyword\exclamdown
3541 \definedummyword\questiondown
3542 \definedummyword\ordf
3543 \definedummyword\ordm
3545 % Although these internal commands shouldn't show up, sometimes they do.
3546 \definedummyword\bf
3547 \definedummyword\gtr
3548 \definedummyword\hat
3549 \definedummyword\less
3550 \definedummyword\sf
3551 \definedummyword\sl
3552 \definedummyword\tclose
3553 \definedummyword\tt
3555 \definedummyword\LaTeX
3556 \definedummyword\TeX
3558 % Assorted special characters.
3559 \definedummyword\bullet
3560 \definedummyword\comma
3561 \definedummyword\copyright
3562 \definedummyword\registeredsymbol
3563 \definedummyword\dots
3564 \definedummyword\enddots
3565 \definedummyword\equiv
3566 \definedummyword\error
3567 \definedummyword\euro
3568 \definedummyword\expansion
3569 \definedummyword\minus
3570 \definedummyword\pounds
3571 \definedummyword\point
3572 \definedummyword\print
3573 \definedummyword\result
3574 \definedummyword\textdegree
3576 % We want to disable all macros so that they are not expanded by \write.
3577 \macrolist
3579 \normalturnoffactive
3581 % Handle some cases of @value -- where it does not contain any
3582 % (non-fully-expandable) commands.
3583 \makevalueexpandable
3586 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3588 \def\commondummiesnofonts{%
3589 % Control letters and accents.
3590 \definedummyletter\!%
3591 \definedummyaccent\"%
3592 \definedummyaccent\'%
3593 \definedummyletter\*%
3594 \definedummyaccent\,%
3595 \definedummyletter\.%
3596 \definedummyletter\/%
3597 \definedummyletter\:%
3598 \definedummyaccent\=%
3599 \definedummyletter\?%
3600 \definedummyaccent\^%
3601 \definedummyaccent\`%
3602 \definedummyaccent\~%
3603 \definedummyword\u
3604 \definedummyword\v
3605 \definedummyword\H
3606 \definedummyword\dotaccent
3607 \definedummyword\ringaccent
3608 \definedummyword\tieaccent
3609 \definedummyword\ubaraccent
3610 \definedummyword\udotaccent
3611 \definedummyword\dotless
3613 % Texinfo font commands.
3614 \definedummyword\b
3615 \definedummyword\i
3616 \definedummyword\r
3617 \definedummyword\sc
3618 \definedummyword\t
3620 % Commands that take arguments.
3621 \definedummyword\acronym
3622 \definedummyword\cite
3623 \definedummyword\code
3624 \definedummyword\command
3625 \definedummyword\dfn
3626 \definedummyword\emph
3627 \definedummyword\env
3628 \definedummyword\file
3629 \definedummyword\kbd
3630 \definedummyword\key
3631 \definedummyword\math
3632 \definedummyword\option
3633 \definedummyword\pxref
3634 \definedummyword\ref
3635 \definedummyword\samp
3636 \definedummyword\strong
3637 \definedummyword\tie
3638 \definedummyword\uref
3639 \definedummyword\url
3640 \definedummyword\var
3641 \definedummyword\verb
3642 \definedummyword\w
3643 \definedummyword\xref
3646 % \indexnofonts is used when outputting the strings to sort the index
3647 % by, and when constructing control sequence names. It eliminates all
3648 % control sequences and just writes whatever the best ASCII sort string
3649 % would be for a given command (usually its argument).
3651 \def\indexnofonts{%
3652 % Accent commands should become @asis.
3653 \def\definedummyaccent##1{\let##1\asis}%
3654 % We can just ignore other control letters.
3655 \def\definedummyletter##1{\let##1\empty}%
3656 % Hopefully, all control words can become @asis.
3657 \let\definedummyword\definedummyaccent
3659 \commondummiesnofonts
3661 % Don't no-op \tt, since it isn't a user-level command
3662 % and is used in the definitions of the active chars like <, >, |, etc.
3663 % Likewise with the other plain tex font commands.
3664 %\let\tt=\asis
3666 \def\ { }%
3667 \def\@{@}%
3668 % how to handle braces?
3669 \def\_{\normalunderscore}%
3671 % Non-English letters.
3672 \def\AA{AA}%
3673 \def\AE{AE}%
3674 \def\L{L}%
3675 \def\OE{OE}%
3676 \def\O{O}%
3677 \def\aa{aa}%
3678 \def\ae{ae}%
3679 \def\l{l}%
3680 \def\oe{oe}%
3681 \def\o{o}%
3682 \def\ss{ss}%
3683 \def\exclamdown{!}%
3684 \def\questiondown{?}%
3685 \def\ordf{a}%
3686 \def\ordm{o}%
3688 \def\LaTeX{LaTeX}%
3689 \def\TeX{TeX}%
3691 % Assorted special characters.
3692 % (The following {} will end up in the sort string, but that's ok.)
3693 \def\bullet{bullet}%
3694 \def\comma{,}%
3695 \def\copyright{copyright}%
3696 \def\registeredsymbol{R}%
3697 \def\dots{...}%
3698 \def\enddots{...}%
3699 \def\equiv{==}%
3700 \def\error{error}%
3701 \def\euro{euro}%
3702 \def\expansion{==>}%
3703 \def\minus{-}%
3704 \def\pounds{pounds}%
3705 \def\point{.}%
3706 \def\print{-|}%
3707 \def\result{=>}%
3708 \def\textdegree{degrees}%
3710 % We need to get rid of all macros, leaving only the arguments (if present).
3711 % Of course this is not nearly correct, but it is the best we can do for now.
3712 % makeinfo does not expand macros in the argument to @deffn, which ends up
3713 % writing an index entry, and texindex isn't prepared for an index sort entry
3714 % that starts with \.
3716 % Since macro invocations are followed by braces, we can just redefine them
3717 % to take a single TeX argument. The case of a macro invocation that
3718 % goes to end-of-line is not handled.
3720 \macrolist
3723 \let\indexbackslash=0 %overridden during \printindex.
3724 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3726 % Most index entries go through here, but \dosubind is the general case.
3727 % #1 is the index name, #2 is the entry text.
3728 \def\doind#1#2{\dosubind{#1}{#2}{}}
3730 % Workhorse for all \fooindexes.
3731 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3732 % empty if called from \doind, as we usually are (the main exception
3733 % is with most defuns, which call us directly).
3735 \def\dosubind#1#2#3{%
3736 \iflinks
3738 % Store the main index entry text (including the third arg).
3739 \toks0 = {#2}%
3740 % If third arg is present, precede it with a space.
3741 \def\thirdarg{#3}%
3742 \ifx\thirdarg\empty \else
3743 \toks0 = \expandafter{\the\toks0 \space #3}%
3746 \edef\writeto{\csname#1indfile\endcsname}%
3748 \ifvmode
3749 \dosubindsanitize
3750 \else
3751 \dosubindwrite
3757 % Write the entry in \toks0 to the index file:
3759 \def\dosubindwrite{%
3760 % Put the index entry in the margin if desired.
3761 \ifx\SETmarginindex\relax\else
3762 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3765 % Remember, we are within a group.
3766 \indexdummies % Must do this here, since \bf, etc expand at this stage
3767 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3768 % so it will be output as is; and it will print as backslash.
3770 % Process the index entry with all font commands turned off, to
3771 % get the string to sort by.
3772 {\indexnofonts
3773 \edef\temp{\the\toks0}% need full expansion
3774 \xdef\indexsorttmp{\temp}%
3777 % Set up the complete index entry, with both the sort key and
3778 % the original text, including any font commands. We write
3779 % three arguments to \entry to the .?? file (four in the
3780 % subentry case), texindex reduces to two when writing the .??s
3781 % sorted result.
3782 \edef\temp{%
3783 \write\writeto{%
3784 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3786 \temp
3789 % Take care of unwanted page breaks:
3791 % If a skip is the last thing on the list now, preserve it
3792 % by backing up by \lastskip, doing the \write, then inserting
3793 % the skip again. Otherwise, the whatsit generated by the
3794 % \write will make \lastskip zero. The result is that sequences
3795 % like this:
3796 % @end defun
3797 % @tindex whatever
3798 % @defun ...
3799 % will have extra space inserted, because the \medbreak in the
3800 % start of the @defun won't see the skip inserted by the @end of
3801 % the previous defun.
3803 % But don't do any of this if we're not in vertical mode. We
3804 % don't want to do a \vskip and prematurely end a paragraph.
3806 % Avoid page breaks due to these extra skips, too.
3808 % But wait, there is a catch there:
3809 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3810 % sufficient for this purpose, as it ignores stretch and shrink parts
3811 % of the skip. The only way seems to be to check the textual
3812 % representation of the skip.
3814 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3815 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3817 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3819 % ..., ready, GO:
3821 \def\dosubindsanitize{%
3822 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3823 \skip0 = \lastskip
3824 \edef\lastskipmacro{\the\lastskip}%
3825 \count255 = \lastpenalty
3827 % If \lastskip is nonzero, that means the last item was a
3828 % skip. And since a skip is discardable, that means this
3829 % -\skip0 glue we're inserting is preceded by a
3830 % non-discardable item, therefore it is not a potential
3831 % breakpoint, therefore no \nobreak needed.
3832 \ifx\lastskipmacro\zeroskipmacro
3833 \else
3834 \vskip-\skip0
3837 \dosubindwrite
3839 \ifx\lastskipmacro\zeroskipmacro
3840 % If \lastskip was zero, perhaps the last item was a penalty, and
3841 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3842 % to re-insert the same penalty (values >10000 are used for various
3843 % signals); since we just inserted a non-discardable item, any
3844 % following glue (such as a \parskip) would be a breakpoint. For example:
3846 % @deffn deffn-whatever
3847 % @vindex index-whatever
3848 % Description.
3849 % would allow a break between the index-whatever whatsit
3850 % and the "Description." paragraph.
3851 \ifnum\count255>9999 \penalty\count255 \fi
3852 \else
3853 % On the other hand, if we had a nonzero \lastskip,
3854 % this make-up glue would be preceded by a non-discardable item
3855 % (the whatsit from the \write), so we must insert a \nobreak.
3856 \nobreak\vskip\skip0
3860 % The index entry written in the file actually looks like
3861 % \entry {sortstring}{page}{topic}
3862 % or
3863 % \entry {sortstring}{page}{topic}{subtopic}
3864 % The texindex program reads in these files and writes files
3865 % containing these kinds of lines:
3866 % \initial {c}
3867 % before the first topic whose initial is c
3868 % \entry {topic}{pagelist}
3869 % for a topic that is used without subtopics
3870 % \primary {topic}
3871 % for the beginning of a topic that is used with subtopics
3872 % \secondary {subtopic}{pagelist}
3873 % for each subtopic.
3875 % Define the user-accessible indexing commands
3876 % @findex, @vindex, @kindex, @cindex.
3878 \def\findex {\fnindex}
3879 \def\kindex {\kyindex}
3880 \def\cindex {\cpindex}
3881 \def\vindex {\vrindex}
3882 \def\tindex {\tpindex}
3883 \def\pindex {\pgindex}
3885 \def\cindexsub {\begingroup\obeylines\cindexsub}
3886 {\obeylines %
3887 \gdef\cindexsub "#1" #2^^M{\endgroup %
3888 \dosubind{cp}{#2}{#1}}}
3890 % Define the macros used in formatting output of the sorted index material.
3892 % @printindex causes a particular index (the ??s file) to get printed.
3893 % It does not print any chapter heading (usually an @unnumbered).
3895 \parseargdef\printindex{\begingroup
3896 \dobreak \chapheadingskip{10000}%
3898 \smallfonts \rm
3899 \tolerance = 9500
3900 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3902 % See if the index file exists and is nonempty.
3903 % Change catcode of @ here so that if the index file contains
3904 % \initial {@}
3905 % as its first line, TeX doesn't complain about mismatched braces
3906 % (because it thinks @} is a control sequence).
3907 \catcode`\@ = 11
3908 \openin 1 \jobname.#1s
3909 \ifeof 1
3910 % \enddoublecolumns gets confused if there is no text in the index,
3911 % and it loses the chapter title and the aux file entries for the
3912 % index. The easiest way to prevent this problem is to make sure
3913 % there is some text.
3914 \putwordIndexNonexistent
3915 \else
3917 % If the index file exists but is empty, then \openin leaves \ifeof
3918 % false. We have to make TeX try to read something from the file, so
3919 % it can discover if there is anything in it.
3920 \read 1 to \temp
3921 \ifeof 1
3922 \putwordIndexIsEmpty
3923 \else
3924 % Index files are almost Texinfo source, but we use \ as the escape
3925 % character. It would be better to use @, but that's too big a change
3926 % to make right now.
3927 \def\indexbackslash{\backslashcurfont}%
3928 \catcode`\\ = 0
3929 \escapechar = `\\
3930 \begindoublecolumns
3931 \input \jobname.#1s
3932 \enddoublecolumns
3935 \closein 1
3936 \endgroup}
3938 % These macros are used by the sorted index file itself.
3939 % Change them to control the appearance of the index.
3941 \def\initial#1{{%
3942 % Some minor font changes for the special characters.
3943 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3945 % Remove any glue we may have, we'll be inserting our own.
3946 \removelastskip
3948 % We like breaks before the index initials, so insert a bonus.
3949 \nobreak
3950 \vskip 0pt plus 3\baselineskip
3951 \penalty 0
3952 \vskip 0pt plus -3\baselineskip
3954 % Typeset the initial. Making this add up to a whole number of
3955 % baselineskips increases the chance of the dots lining up from column
3956 % to column. It still won't often be perfect, because of the stretch
3957 % we need before each entry, but it's better.
3959 % No shrink because it confuses \balancecolumns.
3960 \vskip 1.67\baselineskip plus .5\baselineskip
3961 \leftline{\secbf #1}%
3962 % Do our best not to break after the initial.
3963 \nobreak
3964 \vskip .33\baselineskip plus .1\baselineskip
3967 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3968 % then page number (#2) flushed to the right margin. It is used for index
3969 % and table of contents entries. The paragraph is indented by \leftskip.
3971 % A straightforward implementation would start like this:
3972 % \def\entry#1#2{...
3973 % But this frozes the catcodes in the argument, and can cause problems to
3974 % @code, which sets - active. This problem was fixed by a kludge---
3975 % ``-'' was active throughout whole index, but this isn't really right.
3977 % The right solution is to prevent \entry from swallowing the whole text.
3978 % --kasal, 21nov03
3979 \def\entry{%
3980 \begingroup
3982 % Start a new paragraph if necessary, so our assignments below can't
3983 % affect previous text.
3984 \par
3986 % Do not fill out the last line with white space.
3987 \parfillskip = 0in
3989 % No extra space above this paragraph.
3990 \parskip = 0in
3992 % Do not prefer a separate line ending with a hyphen to fewer lines.
3993 \finalhyphendemerits = 0
3995 % \hangindent is only relevant when the entry text and page number
3996 % don't both fit on one line. In that case, bob suggests starting the
3997 % dots pretty far over on the line. Unfortunately, a large
3998 % indentation looks wrong when the entry text itself is broken across
3999 % lines. So we use a small indentation and put up with long leaders.
4001 % \hangafter is reset to 1 (which is the value we want) at the start
4002 % of each paragraph, so we need not do anything with that.
4003 \hangindent = 2em
4005 % When the entry text needs to be broken, just fill out the first line
4006 % with blank space.
4007 \rightskip = 0pt plus1fil
4009 % A bit of stretch before each entry for the benefit of balancing
4010 % columns.
4011 \vskip 0pt plus1pt
4013 % Swallow the left brace of the text (first parameter):
4014 \afterassignment\doentry
4015 \let\temp =
4017 \def\doentry{%
4018 \bgroup % Instead of the swallowed brace.
4019 \noindent
4020 \aftergroup\finishentry
4021 % And now comes the text of the entry.
4023 \def\finishentry#1{%
4024 % #1 is the page number.
4026 % The following is kludged to not output a line of dots in the index if
4027 % there are no page numbers. The next person who breaks this will be
4028 % cursed by a Unix daemon.
4029 \def\tempa{{\rm }}%
4030 \def\tempb{#1}%
4031 \edef\tempc{\tempa}%
4032 \edef\tempd{\tempb}%
4033 \ifx\tempc\tempd
4035 \else
4037 % If we must, put the page number on a line of its own, and fill out
4038 % this line with blank space. (The \hfil is overwhelmed with the
4039 % fill leaders glue in \indexdotfill if the page number does fit.)
4040 \hfil\penalty50
4041 \null\nobreak\indexdotfill % Have leaders before the page number.
4043 % The `\ ' here is removed by the implicit \unskip that TeX does as
4044 % part of (the primitive) \par. Without it, a spurious underfull
4045 % \hbox ensues.
4046 \ifpdf
4047 \pdfgettoks#1.%
4048 \ \the\toksA
4049 \else
4050 \ #1%
4053 \par
4054 \endgroup
4057 % Like plain.tex's \dotfill, except uses up at least 1 em.
4058 \def\indexdotfill{\cleaders
4059 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4061 \def\primary #1{\line{#1\hfil}}
4063 \newskip\secondaryindent \secondaryindent=0.5cm
4064 \def\secondary#1#2{{%
4065 \parfillskip=0in
4066 \parskip=0in
4067 \hangindent=1in
4068 \hangafter=1
4069 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4070 \ifpdf
4071 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4072 \else
4075 \par
4078 % Define two-column mode, which we use to typeset indexes.
4079 % Adapted from the TeXbook, page 416, which is to say,
4080 % the manmac.tex format used to print the TeXbook itself.
4081 \catcode`\@=11
4083 \newbox\partialpage
4084 \newdimen\doublecolumnhsize
4086 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4087 % Grab any single-column material above us.
4088 \output = {%
4090 % Here is a possibility not foreseen in manmac: if we accumulate a
4091 % whole lot of material, we might end up calling this \output
4092 % routine twice in a row (see the doublecol-lose test, which is
4093 % essentially a couple of indexes with @setchapternewpage off). In
4094 % that case we just ship out what is in \partialpage with the normal
4095 % output routine. Generally, \partialpage will be empty when this
4096 % runs and this will be a no-op. See the indexspread.tex test case.
4097 \ifvoid\partialpage \else
4098 \onepageout{\pagecontents\partialpage}%
4101 \global\setbox\partialpage = \vbox{%
4102 % Unvbox the main output page.
4103 \unvbox\PAGE
4104 \kern-\topskip \kern\baselineskip
4107 \eject % run that output routine to set \partialpage
4109 % Use the double-column output routine for subsequent pages.
4110 \output = {\doublecolumnout}%
4112 % Change the page size parameters. We could do this once outside this
4113 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4114 % format, but then we repeat the same computation. Repeating a couple
4115 % of assignments once per index is clearly meaningless for the
4116 % execution time, so we may as well do it in one place.
4118 % First we halve the line length, less a little for the gutter between
4119 % the columns. We compute the gutter based on the line length, so it
4120 % changes automatically with the paper format. The magic constant
4121 % below is chosen so that the gutter has the same value (well, +-<1pt)
4122 % as it did when we hard-coded it.
4124 % We put the result in a separate register, \doublecolumhsize, so we
4125 % can restore it in \pagesofar, after \hsize itself has (potentially)
4126 % been clobbered.
4128 \doublecolumnhsize = \hsize
4129 \advance\doublecolumnhsize by -.04154\hsize
4130 \divide\doublecolumnhsize by 2
4131 \hsize = \doublecolumnhsize
4133 % Double the \vsize as well. (We don't need a separate register here,
4134 % since nobody clobbers \vsize.)
4135 \vsize = 2\vsize
4138 % The double-column output routine for all double-column pages except
4139 % the last.
4141 \def\doublecolumnout{%
4142 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4143 % Get the available space for the double columns -- the normal
4144 % (undoubled) page height minus any material left over from the
4145 % previous page.
4146 \dimen@ = \vsize
4147 \divide\dimen@ by 2
4148 \advance\dimen@ by -\ht\partialpage
4150 % box0 will be the left-hand column, box2 the right.
4151 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4152 \onepageout\pagesofar
4153 \unvbox255
4154 \penalty\outputpenalty
4157 % Re-output the contents of the output page -- any previous material,
4158 % followed by the two boxes we just split, in box0 and box2.
4159 \def\pagesofar{%
4160 \unvbox\partialpage
4162 \hsize = \doublecolumnhsize
4163 \wd0=\hsize \wd2=\hsize
4164 \hbox to\pagewidth{\box0\hfil\box2}%
4167 % All done with double columns.
4168 \def\enddoublecolumns{%
4169 \output = {%
4170 % Split the last of the double-column material. Leave it on the
4171 % current page, no automatic page break.
4172 \balancecolumns
4174 % If we end up splitting too much material for the current page,
4175 % though, there will be another page break right after this \output
4176 % invocation ends. Having called \balancecolumns once, we do not
4177 % want to call it again. Therefore, reset \output to its normal
4178 % definition right away. (We hope \balancecolumns will never be
4179 % called on to balance too much material, but if it is, this makes
4180 % the output somewhat more palatable.)
4181 \global\output = {\onepageout{\pagecontents\PAGE}}%
4183 \eject
4184 \endgroup % started in \begindoublecolumns
4186 % \pagegoal was set to the doubled \vsize above, since we restarted
4187 % the current page. We're now back to normal single-column
4188 % typesetting, so reset \pagegoal to the normal \vsize (after the
4189 % \endgroup where \vsize got restored).
4190 \pagegoal = \vsize
4193 % Called at the end of the double column material.
4194 \def\balancecolumns{%
4195 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4196 \dimen@ = \ht0
4197 \advance\dimen@ by \topskip
4198 \advance\dimen@ by-\baselineskip
4199 \divide\dimen@ by 2 % target to split to
4200 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4201 \splittopskip = \topskip
4202 % Loop until we get a decent breakpoint.
4204 \vbadness = 10000
4205 \loop
4206 \global\setbox3 = \copy0
4207 \global\setbox1 = \vsplit3 to \dimen@
4208 \ifdim\ht3>\dimen@
4209 \global\advance\dimen@ by 1pt
4210 \repeat
4212 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4213 \setbox0=\vbox to\dimen@{\unvbox1}%
4214 \setbox2=\vbox to\dimen@{\unvbox3}%
4216 \pagesofar
4218 \catcode`\@ = \other
4221 \message{sectioning,}
4222 % Chapters, sections, etc.
4224 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4225 % sections so that we can refer to them unambiguously in the pdf
4226 % outlines by their "section number". We avoid collisions with chapter
4227 % numbers by starting them at 10000. (If a document ever has 10000
4228 % chapters, we're in trouble anyway, I'm sure.)
4229 \newcount\unnumberedno \unnumberedno = 10000
4230 \newcount\chapno
4231 \newcount\secno \secno=0
4232 \newcount\subsecno \subsecno=0
4233 \newcount\subsubsecno \subsubsecno=0
4235 % This counter is funny since it counts through charcodes of letters A, B, ...
4236 \newcount\appendixno \appendixno = `\@
4238 % \def\appendixletter{\char\the\appendixno}
4239 % We do the following ugly conditional instead of the above simple
4240 % construct for the sake of pdftex, which needs the actual
4241 % letter in the expansion, not just typeset.
4243 \def\appendixletter{%
4244 \ifnum\appendixno=`A A%
4245 \else\ifnum\appendixno=`B B%
4246 \else\ifnum\appendixno=`C C%
4247 \else\ifnum\appendixno=`D D%
4248 \else\ifnum\appendixno=`E E%
4249 \else\ifnum\appendixno=`F F%
4250 \else\ifnum\appendixno=`G G%
4251 \else\ifnum\appendixno=`H H%
4252 \else\ifnum\appendixno=`I I%
4253 \else\ifnum\appendixno=`J J%
4254 \else\ifnum\appendixno=`K K%
4255 \else\ifnum\appendixno=`L L%
4256 \else\ifnum\appendixno=`M M%
4257 \else\ifnum\appendixno=`N N%
4258 \else\ifnum\appendixno=`O O%
4259 \else\ifnum\appendixno=`P P%
4260 \else\ifnum\appendixno=`Q Q%
4261 \else\ifnum\appendixno=`R R%
4262 \else\ifnum\appendixno=`S S%
4263 \else\ifnum\appendixno=`T T%
4264 \else\ifnum\appendixno=`U U%
4265 \else\ifnum\appendixno=`V V%
4266 \else\ifnum\appendixno=`W W%
4267 \else\ifnum\appendixno=`X X%
4268 \else\ifnum\appendixno=`Y Y%
4269 \else\ifnum\appendixno=`Z Z%
4270 % The \the is necessary, despite appearances, because \appendixletter is
4271 % expanded while writing the .toc file. \char\appendixno is not
4272 % expandable, thus it is written literally, thus all appendixes come out
4273 % with the same letter (or @) in the toc without it.
4274 \else\char\the\appendixno
4275 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4276 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4278 % Each @chapter defines this as the name of the chapter.
4279 % page headings and footings can use it. @section does likewise.
4280 % However, they are not reliable, because we don't use marks.
4281 \def\thischapter{}
4282 \def\thissection{}
4284 \newcount\absseclevel % used to calculate proper heading level
4285 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4287 % @raisesections: treat @section as chapter, @subsection as section, etc.
4288 \def\raisesections{\global\advance\secbase by -1}
4289 \let\up=\raisesections % original BFox name
4291 % @lowersections: treat @chapter as section, @section as subsection, etc.
4292 \def\lowersections{\global\advance\secbase by 1}
4293 \let\down=\lowersections % original BFox name
4295 % we only have subsub.
4296 \chardef\maxseclevel = 3
4298 % A numbered section within an unnumbered changes to unnumbered too.
4299 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4300 \chardef\unmlevel = \maxseclevel
4302 % Trace whether the current chapter is an appendix or not:
4303 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4304 \def\chapheadtype{N}
4306 % Choose a heading macro
4307 % #1 is heading type
4308 % #2 is heading level
4309 % #3 is text for heading
4310 \def\genhead#1#2#3{%
4311 % Compute the abs. sec. level:
4312 \absseclevel=#2
4313 \advance\absseclevel by \secbase
4314 % Make sure \absseclevel doesn't fall outside the range:
4315 \ifnum \absseclevel < 0
4316 \absseclevel = 0
4317 \else
4318 \ifnum \absseclevel > 3
4319 \absseclevel = 3
4322 % The heading type:
4323 \def\headtype{#1}%
4324 \if \headtype U%
4325 \ifnum \absseclevel < \unmlevel
4326 \chardef\unmlevel = \absseclevel
4328 \else
4329 % Check for appendix sections:
4330 \ifnum \absseclevel = 0
4331 \edef\chapheadtype{\headtype}%
4332 \else
4333 \if \headtype A\if \chapheadtype N%
4334 \errmessage{@appendix... within a non-appendix chapter}%
4335 \fi\fi
4337 % Check for numbered within unnumbered:
4338 \ifnum \absseclevel > \unmlevel
4339 \def\headtype{U}%
4340 \else
4341 \chardef\unmlevel = 3
4344 % Now print the heading:
4345 \if \headtype U%
4346 \ifcase\absseclevel
4347 \unnumberedzzz{#3}%
4348 \or \unnumberedseczzz{#3}%
4349 \or \unnumberedsubseczzz{#3}%
4350 \or \unnumberedsubsubseczzz{#3}%
4352 \else
4353 \if \headtype A%
4354 \ifcase\absseclevel
4355 \appendixzzz{#3}%
4356 \or \appendixsectionzzz{#3}%
4357 \or \appendixsubseczzz{#3}%
4358 \or \appendixsubsubseczzz{#3}%
4360 \else
4361 \ifcase\absseclevel
4362 \chapterzzz{#3}%
4363 \or \seczzz{#3}%
4364 \or \numberedsubseczzz{#3}%
4365 \or \numberedsubsubseczzz{#3}%
4369 \suppressfirstparagraphindent
4372 % an interface:
4373 \def\numhead{\genhead N}
4374 \def\apphead{\genhead A}
4375 \def\unnmhead{\genhead U}
4377 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4378 % all lower-level sectioning counters to zero.
4380 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4381 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4382 \let\chaplevelprefix = \empty
4384 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4385 \def\chapterzzz#1{%
4386 % section resetting is \global in case the chapter is in a group, such
4387 % as an @include file.
4388 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4389 \global\advance\chapno by 1
4391 % Used for \float.
4392 \gdef\chaplevelprefix{\the\chapno.}%
4393 \resetallfloatnos
4395 \message{\putwordChapter\space \the\chapno}%
4397 % Write the actual heading.
4398 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4400 % So @section and the like are numbered underneath this chapter.
4401 \global\let\section = \numberedsec
4402 \global\let\subsection = \numberedsubsec
4403 \global\let\subsubsection = \numberedsubsubsec
4406 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4407 \def\appendixzzz#1{%
4408 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4409 \global\advance\appendixno by 1
4410 \gdef\chaplevelprefix{\appendixletter.}%
4411 \resetallfloatnos
4413 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4414 \message{\appendixnum}%
4416 \chapmacro{#1}{Yappendix}{\appendixletter}%
4418 \global\let\section = \appendixsec
4419 \global\let\subsection = \appendixsubsec
4420 \global\let\subsubsection = \appendixsubsubsec
4423 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4424 \def\unnumberedzzz#1{%
4425 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4426 \global\advance\unnumberedno by 1
4428 % Since an unnumbered has no number, no prefix for figures.
4429 \global\let\chaplevelprefix = \empty
4430 \resetallfloatnos
4432 % This used to be simply \message{#1}, but TeX fully expands the
4433 % argument to \message. Therefore, if #1 contained @-commands, TeX
4434 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4435 % expanded @cite (which turns out to cause errors because \cite is meant
4436 % to be executed, not expanded).
4438 % Anyway, we don't want the fully-expanded definition of @cite to appear
4439 % as a result of the \message, we just want `@cite' itself. We use
4440 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4441 % simply yielding the contents of <toks register>. (We also do this for
4442 % the toc entries.)
4443 \toks0 = {#1}%
4444 \message{(\the\toks0)}%
4446 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4448 \global\let\section = \unnumberedsec
4449 \global\let\subsection = \unnumberedsubsec
4450 \global\let\subsubsection = \unnumberedsubsubsec
4453 % @centerchap is like @unnumbered, but the heading is centered.
4454 \outer\parseargdef\centerchap{%
4455 % Well, we could do the following in a group, but that would break
4456 % an assumption that \chapmacro is called at the outermost level.
4457 % Thus we are safer this way: --kasal, 24feb04
4458 \let\centerparametersmaybe = \centerparameters
4459 \unnmhead0{#1}%
4460 \let\centerparametersmaybe = \relax
4463 % @top is like @unnumbered.
4464 \let\top\unnumbered
4466 % Sections.
4467 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4468 \def\seczzz#1{%
4469 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4470 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4473 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4474 \def\appendixsectionzzz#1{%
4475 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4476 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4478 \let\appendixsec\appendixsection
4480 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4481 \def\unnumberedseczzz#1{%
4482 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4483 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4486 % Subsections.
4487 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4488 \def\numberedsubseczzz#1{%
4489 \global\subsubsecno=0 \global\advance\subsecno by 1
4490 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4493 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4494 \def\appendixsubseczzz#1{%
4495 \global\subsubsecno=0 \global\advance\subsecno by 1
4496 \sectionheading{#1}{subsec}{Yappendix}%
4497 {\appendixletter.\the\secno.\the\subsecno}%
4500 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4501 \def\unnumberedsubseczzz#1{%
4502 \global\subsubsecno=0 \global\advance\subsecno by 1
4503 \sectionheading{#1}{subsec}{Ynothing}%
4504 {\the\unnumberedno.\the\secno.\the\subsecno}%
4507 % Subsubsections.
4508 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4509 \def\numberedsubsubseczzz#1{%
4510 \global\advance\subsubsecno by 1
4511 \sectionheading{#1}{subsubsec}{Ynumbered}%
4512 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4515 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4516 \def\appendixsubsubseczzz#1{%
4517 \global\advance\subsubsecno by 1
4518 \sectionheading{#1}{subsubsec}{Yappendix}%
4519 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4522 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4523 \def\unnumberedsubsubseczzz#1{%
4524 \global\advance\subsubsecno by 1
4525 \sectionheading{#1}{subsubsec}{Ynothing}%
4526 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4529 % These macros control what the section commands do, according
4530 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4531 % Define them by default for a numbered chapter.
4532 \let\section = \numberedsec
4533 \let\subsection = \numberedsubsec
4534 \let\subsubsection = \numberedsubsubsec
4536 % Define @majorheading, @heading and @subheading
4538 % NOTE on use of \vbox for chapter headings, section headings, and such:
4539 % 1) We use \vbox rather than the earlier \line to permit
4540 % overlong headings to fold.
4541 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4542 % heading is obnoxious; this forbids it.
4543 % 3) Likewise, headings look best if no \parindent is used, and
4544 % if justification is not attempted. Hence \raggedright.
4547 \def\majorheading{%
4548 {\advance\chapheadingskip by 10pt \chapbreak }%
4549 \parsearg\chapheadingzzz
4552 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4553 \def\chapheadingzzz#1{%
4554 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4555 \parindent=0pt\raggedright
4556 \rm #1\hfill}}%
4557 \bigskip \par\penalty 200\relax
4558 \suppressfirstparagraphindent
4561 % @heading, @subheading, @subsubheading.
4562 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4563 \suppressfirstparagraphindent}
4564 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4565 \suppressfirstparagraphindent}
4566 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4567 \suppressfirstparagraphindent}
4569 % These macros generate a chapter, section, etc. heading only
4570 % (including whitespace, linebreaking, etc. around it),
4571 % given all the information in convenient, parsed form.
4573 %%% Args are the skip and penalty (usually negative)
4574 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4576 %%% Define plain chapter starts, and page on/off switching for it
4577 % Parameter controlling skip before chapter headings (if needed)
4579 \newskip\chapheadingskip
4581 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4582 \def\chappager{\par\vfill\supereject}
4583 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4585 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4587 \def\CHAPPAGoff{%
4588 \global\let\contentsalignmacro = \chappager
4589 \global\let\pchapsepmacro=\chapbreak
4590 \global\let\pagealignmacro=\chappager}
4592 \def\CHAPPAGon{%
4593 \global\let\contentsalignmacro = \chappager
4594 \global\let\pchapsepmacro=\chappager
4595 \global\let\pagealignmacro=\chappager
4596 \global\def\HEADINGSon{\HEADINGSsingle}}
4598 \def\CHAPPAGodd{%
4599 \global\let\contentsalignmacro = \chapoddpage
4600 \global\let\pchapsepmacro=\chapoddpage
4601 \global\let\pagealignmacro=\chapoddpage
4602 \global\def\HEADINGSon{\HEADINGSdouble}}
4604 \CHAPPAGon
4606 % Chapter opening.
4608 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4609 % Yappendix, Yomitfromtoc), #3 the chapter number.
4611 % To test against our argument.
4612 \def\Ynothingkeyword{Ynothing}
4613 \def\Yomitfromtockeyword{Yomitfromtoc}
4614 \def\Yappendixkeyword{Yappendix}
4616 \def\chapmacro#1#2#3{%
4617 \pchapsepmacro
4619 \chapfonts \rm
4621 % Have to define \thissection before calling \donoderef, because the
4622 % xref code eventually uses it. On the other hand, it has to be called
4623 % after \pchapsepmacro, or the headline will change too soon.
4624 \gdef\thissection{#1}%
4625 \gdef\thischaptername{#1}%
4627 % Only insert the separating space if we have a chapter/appendix
4628 % number, and don't print the unnumbered ``number''.
4629 \def\temptype{#2}%
4630 \ifx\temptype\Ynothingkeyword
4631 \setbox0 = \hbox{}%
4632 \def\toctype{unnchap}%
4633 \gdef\thischapternum{}%
4634 \gdef\thischapter{#1}%
4635 \else\ifx\temptype\Yomitfromtockeyword
4636 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4637 \def\toctype{omit}%
4638 \gdef\thischapternum{}%
4639 \gdef\thischapter{}%
4640 \else\ifx\temptype\Yappendixkeyword
4641 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4642 \def\toctype{app}%
4643 \xdef\thischapternum{\appendixletter}%
4644 % We don't substitute the actual chapter name into \thischapter
4645 % because we don't want its macros evaluated now. And we don't
4646 % use \thissection because that changes with each section.
4648 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4649 \noexpand\thischaptername}%
4650 \else
4651 \setbox0 = \hbox{#3\enspace}%
4652 \def\toctype{numchap}%
4653 \xdef\thischapternum{\the\chapno}%
4654 \xdef\thischapter{\putwordChapter{} \the\chapno:
4655 \noexpand\thischaptername}%
4656 \fi\fi\fi
4658 % Write the toc entry for this chapter. Must come before the
4659 % \donoderef, because we include the current node name in the toc
4660 % entry, and \donoderef resets it to empty.
4661 \writetocentry{\toctype}{#1}{#3}%
4663 % For pdftex, we have to write out the node definition (aka, make
4664 % the pdfdest) after any page break, but before the actual text has
4665 % been typeset. If the destination for the pdf outline is after the
4666 % text, then jumping from the outline may wind up with the text not
4667 % being visible, for instance under high magnification.
4668 \donoderef{#2}%
4670 % Typeset the actual heading.
4671 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4672 \hangindent=\wd0 \centerparametersmaybe
4673 \unhbox0 #1\par}%
4675 \nobreak\bigskip % no page break after a chapter title
4676 \nobreak
4679 % @centerchap -- centered and unnumbered.
4680 \let\centerparametersmaybe = \relax
4681 \def\centerparameters{%
4682 \advance\rightskip by 3\rightskip
4683 \leftskip = \rightskip
4684 \parfillskip = 0pt
4688 % I don't think this chapter style is supported any more, so I'm not
4689 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4691 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4693 \def\unnchfopen #1{%
4694 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4695 \parindent=0pt\raggedright
4696 \rm #1\hfill}}\bigskip \par\nobreak
4698 \def\chfopen #1#2{\chapoddpage {\chapfonts
4699 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4700 \par\penalty 5000 %
4702 \def\centerchfopen #1{%
4703 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4704 \parindent=0pt
4705 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4707 \def\CHAPFopen{%
4708 \global\let\chapmacro=\chfopen
4709 \global\let\centerchapmacro=\centerchfopen}
4712 % Section titles. These macros combine the section number parts and
4713 % call the generic \sectionheading to do the printing.
4715 \newskip\secheadingskip
4716 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4718 % Subsection titles.
4719 \newskip\subsecheadingskip
4720 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4722 % Subsubsection titles.
4723 \def\subsubsecheadingskip{\subsecheadingskip}
4724 \def\subsubsecheadingbreak{\subsecheadingbreak}
4727 % Print any size, any type, section title.
4729 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4730 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4731 % section number.
4733 \def\sectionheading#1#2#3#4{%
4735 % Switch to the right set of fonts.
4736 \csname #2fonts\endcsname \rm
4738 % Insert space above the heading.
4739 \csname #2headingbreak\endcsname
4741 % Only insert the space after the number if we have a section number.
4742 \def\sectionlevel{#2}%
4743 \def\temptype{#3}%
4745 \ifx\temptype\Ynothingkeyword
4746 \setbox0 = \hbox{}%
4747 \def\toctype{unn}%
4748 \gdef\thissection{#1}%
4749 \else\ifx\temptype\Yomitfromtockeyword
4750 % for @headings -- no section number, don't include in toc,
4751 % and don't redefine \thissection.
4752 \setbox0 = \hbox{}%
4753 \def\toctype{omit}%
4754 \let\sectionlevel=\empty
4755 \else\ifx\temptype\Yappendixkeyword
4756 \setbox0 = \hbox{#4\enspace}%
4757 \def\toctype{app}%
4758 \gdef\thissection{#1}%
4759 \else
4760 \setbox0 = \hbox{#4\enspace}%
4761 \def\toctype{num}%
4762 \gdef\thissection{#1}%
4763 \fi\fi\fi
4765 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4766 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4768 % Write the node reference (= pdf destination for pdftex).
4769 % Again, see comments in \chapmacro.
4770 \donoderef{#3}%
4772 % Interline glue will be inserted when the vbox is completed.
4773 % That glue will be a valid breakpoint for the page, since it'll be
4774 % preceded by a whatsit (usually from the \donoderef, or from the
4775 % \writetocentry if there was no node). We don't want to allow that
4776 % break, since then the whatsits could end up on page n while the
4777 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4778 \nobreak
4780 % Output the actual section heading.
4781 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4782 \hangindent=\wd0 % zero if no section number
4783 \unhbox0 #1}%
4785 % Add extra space after the heading -- half of whatever came above it.
4786 % Don't allow stretch, though.
4787 \kern .5 \csname #2headingskip\endcsname
4789 % Do not let the kern be a potential breakpoint, as it would be if it
4790 % was followed by glue.
4791 \nobreak
4793 % We'll almost certainly start a paragraph next, so don't let that
4794 % glue accumulate. (Not a breakpoint because it's preceded by a
4795 % discardable item.)
4796 \vskip-\parskip
4798 % This is purely so the last item on the list is a known \penalty >
4799 % 10000. This is so \startdefun can avoid allowing breakpoints after
4800 % section headings. Otherwise, it would insert a valid breakpoint between:
4802 % @section sec-whatever
4803 % @deffn def-whatever
4804 \penalty 10001
4808 \message{toc,}
4809 % Table of contents.
4810 \newwrite\tocfile
4812 % Write an entry to the toc file, opening it if necessary.
4813 % Called from @chapter, etc.
4815 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4816 % We append the current node name (if any) and page number as additional
4817 % arguments for the \{chap,sec,...}entry macros which will eventually
4818 % read this. The node name is used in the pdf outlines as the
4819 % destination to jump to.
4821 % We open the .toc file for writing here instead of at @setfilename (or
4822 % any other fixed time) so that @contents can be anywhere in the document.
4823 % But if #1 is `omit', then we don't do anything. This is used for the
4824 % table of contents chapter openings themselves.
4826 \newif\iftocfileopened
4827 \def\omitkeyword{omit}%
4829 \def\writetocentry#1#2#3{%
4830 \edef\writetoctype{#1}%
4831 \ifx\writetoctype\omitkeyword \else
4832 \iftocfileopened\else
4833 \immediate\openout\tocfile = \jobname.toc
4834 \global\tocfileopenedtrue
4837 \iflinks
4838 {\atdummies
4839 \edef\temp{%
4840 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4841 \temp
4846 % Tell \shipout to create a pdf destination on each page, if we're
4847 % writing pdf. These are used in the table of contents. We can't
4848 % just write one on every page because the title pages are numbered
4849 % 1 and 2 (the page numbers aren't printed), and so are the first
4850 % two pages of the document. Thus, we'd have two destinations named
4851 % `1', and two named `2'.
4852 \ifpdf \global\pdfmakepagedesttrue \fi
4856 % These characters do not print properly in the Computer Modern roman
4857 % fonts, so we must take special care. This is more or less redundant
4858 % with the Texinfo input format setup at the end of this file.
4860 \def\activecatcodes{%
4861 \catcode`\"=\active
4862 \catcode`\$=\active
4863 \catcode`\<=\active
4864 \catcode`\>=\active
4865 \catcode`\\=\active
4866 \catcode`\^=\active
4867 \catcode`\_=\active
4868 \catcode`\|=\active
4869 \catcode`\~=\active
4873 % Read the toc file, which is essentially Texinfo input.
4874 \def\readtocfile{%
4875 \setupdatafile
4876 \activecatcodes
4877 \input \jobname.toc
4880 \newskip\contentsrightmargin \contentsrightmargin=1in
4881 \newcount\savepageno
4882 \newcount\lastnegativepageno \lastnegativepageno = -1
4884 % Prepare to read what we've written to \tocfile.
4886 \def\startcontents#1{%
4887 % If @setchapternewpage on, and @headings double, the contents should
4888 % start on an odd page, unlike chapters. Thus, we maintain
4889 % \contentsalignmacro in parallel with \pagealignmacro.
4890 % From: Torbjorn Granlund <tege@matematik.su.se>
4891 \contentsalignmacro
4892 \immediate\closeout\tocfile
4894 % Don't need to put `Contents' or `Short Contents' in the headline.
4895 % It is abundantly clear what they are.
4896 \def\thischapter{}%
4897 \chapmacro{#1}{Yomitfromtoc}{}%
4899 \savepageno = \pageno
4900 \begingroup % Set up to handle contents files properly.
4901 \raggedbottom % Worry more about breakpoints than the bottom.
4902 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4904 % Roman numerals for page numbers.
4905 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4909 % Normal (long) toc.
4910 \def\contents{%
4911 \startcontents{\putwordTOC}%
4912 \openin 1 \jobname.toc
4913 \ifeof 1 \else
4914 \readtocfile
4916 \vfill \eject
4917 \contentsalignmacro % in case @setchapternewpage odd is in effect
4918 \ifeof 1 \else
4919 \pdfmakeoutlines
4921 \closein 1
4922 \endgroup
4923 \lastnegativepageno = \pageno
4924 \global\pageno = \savepageno
4927 % And just the chapters.
4928 \def\summarycontents{%
4929 \startcontents{\putwordShortTOC}%
4931 \let\numchapentry = \shortchapentry
4932 \let\appentry = \shortchapentry
4933 \let\unnchapentry = \shortunnchapentry
4934 % We want a true roman here for the page numbers.
4935 \secfonts
4936 \let\rm=\shortcontrm \let\bf=\shortcontbf
4937 \let\sl=\shortcontsl \let\tt=\shortconttt
4939 \hyphenpenalty = 10000
4940 \advance\baselineskip by 1pt % Open it up a little.
4941 \def\numsecentry##1##2##3##4{}
4942 \let\appsecentry = \numsecentry
4943 \let\unnsecentry = \numsecentry
4944 \let\numsubsecentry = \numsecentry
4945 \let\appsubsecentry = \numsecentry
4946 \let\unnsubsecentry = \numsecentry
4947 \let\numsubsubsecentry = \numsecentry
4948 \let\appsubsubsecentry = \numsecentry
4949 \let\unnsubsubsecentry = \numsecentry
4950 \openin 1 \jobname.toc
4951 \ifeof 1 \else
4952 \readtocfile
4954 \closein 1
4955 \vfill \eject
4956 \contentsalignmacro % in case @setchapternewpage odd is in effect
4957 \endgroup
4958 \lastnegativepageno = \pageno
4959 \global\pageno = \savepageno
4961 \let\shortcontents = \summarycontents
4963 % Typeset the label for a chapter or appendix for the short contents.
4964 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4966 \def\shortchaplabel#1{%
4967 % This space should be enough, since a single number is .5em, and the
4968 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4969 % But use \hss just in case.
4970 % (This space doesn't include the extra space that gets added after
4971 % the label; that gets put in by \shortchapentry above.)
4973 % We'd like to right-justify chapter numbers, but that looks strange
4974 % with appendix letters. And right-justifying numbers and
4975 % left-justifying letters looks strange when there is less than 10
4976 % chapters. Have to read the whole toc once to know how many chapters
4977 % there are before deciding ...
4978 \hbox to 1em{#1\hss}%
4981 % These macros generate individual entries in the table of contents.
4982 % The first argument is the chapter or section name.
4983 % The last argument is the page number.
4984 % The arguments in between are the chapter number, section number, ...
4986 % Chapters, in the main contents.
4987 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4989 % Chapters, in the short toc.
4990 % See comments in \dochapentry re vbox and related settings.
4991 \def\shortchapentry#1#2#3#4{%
4992 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4995 % Appendices, in the main contents.
4996 % Need the word Appendix, and a fixed-size box.
4998 \def\appendixbox#1{%
4999 % We use M since it's probably the widest letter.
5000 \setbox0 = \hbox{\putwordAppendix{} M}%
5001 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5003 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5005 % Unnumbered chapters.
5006 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5007 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5009 % Sections.
5010 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5011 \let\appsecentry=\numsecentry
5012 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5014 % Subsections.
5015 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5016 \let\appsubsecentry=\numsubsecentry
5017 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5019 % And subsubsections.
5020 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5021 \let\appsubsubsecentry=\numsubsubsecentry
5022 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5024 % This parameter controls the indentation of the various levels.
5025 % Same as \defaultparindent.
5026 \newdimen\tocindent \tocindent = 15pt
5028 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5029 % page number.
5031 % If the toc has to be broken over pages, we want it to be at chapters
5032 % if at all possible; hence the \penalty.
5033 \def\dochapentry#1#2{%
5034 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5035 \begingroup
5036 \chapentryfonts
5037 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5038 \endgroup
5039 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5042 \def\dosecentry#1#2{\begingroup
5043 \secentryfonts \leftskip=\tocindent
5044 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5045 \endgroup}
5047 \def\dosubsecentry#1#2{\begingroup
5048 \subsecentryfonts \leftskip=2\tocindent
5049 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5050 \endgroup}
5052 \def\dosubsubsecentry#1#2{\begingroup
5053 \subsubsecentryfonts \leftskip=3\tocindent
5054 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5055 \endgroup}
5057 % We use the same \entry macro as for the index entries.
5058 \let\tocentry = \entry
5060 % Space between chapter (or whatever) number and the title.
5061 \def\labelspace{\hskip1em \relax}
5063 \def\dopageno#1{{\rm #1}}
5064 \def\doshortpageno#1{{\rm #1}}
5066 \def\chapentryfonts{\secfonts \rm}
5067 \def\secentryfonts{\textfonts}
5068 \def\subsecentryfonts{\textfonts}
5069 \def\subsubsecentryfonts{\textfonts}
5072 \message{environments,}
5073 % @foo ... @end foo.
5075 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5077 % Since these characters are used in examples, it should be an even number of
5078 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5080 \def\point{$\star$}
5081 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5082 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5083 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5084 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5086 % The @error{} command.
5087 % Adapted from the TeXbook's \boxit.
5089 \newbox\errorbox
5091 {\tentt \global\dimen0 = 3em}% Width of the box.
5092 \dimen2 = .55pt % Thickness of rules
5093 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5094 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5096 \setbox\errorbox=\hbox to \dimen0{\hfil
5097 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5098 \advance\hsize by -2\dimen2 % Rules.
5099 \vbox{%
5100 \hrule height\dimen2
5101 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5102 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5103 \kern3pt\vrule width\dimen2}% Space to right.
5104 \hrule height\dimen2}
5105 \hfil}
5107 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5109 % @tex ... @end tex escapes into raw Tex temporarily.
5110 % One exception: @ is still an escape character, so that @end tex works.
5111 % But \@ or @@ will get a plain tex @ character.
5113 \envdef\tex{%
5114 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5115 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5116 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5117 \catcode `\%=14
5118 \catcode `\+=\other
5119 \catcode `\"=\other
5120 \catcode `\|=\other
5121 \catcode `\<=\other
5122 \catcode `\>=\other
5123 \escapechar=`\\
5125 \let\b=\ptexb
5126 \let\bullet=\ptexbullet
5127 \let\c=\ptexc
5128 \let\,=\ptexcomma
5129 \let\.=\ptexdot
5130 \let\dots=\ptexdots
5131 \let\equiv=\ptexequiv
5132 \let\!=\ptexexclam
5133 \let\i=\ptexi
5134 \let\indent=\ptexindent
5135 \let\noindent=\ptexnoindent
5136 \let\{=\ptexlbrace
5137 \let\+=\tabalign
5138 \let\}=\ptexrbrace
5139 \let\/=\ptexslash
5140 \let\*=\ptexstar
5141 \let\t=\ptext
5142 \let\frenchspacing=\plainfrenchspacing
5144 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5145 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5146 \def\@{@}%
5148 % There is no need to define \Etex.
5150 % Define @lisp ... @end lisp.
5151 % @lisp environment forms a group so it can rebind things,
5152 % including the definition of @end lisp (which normally is erroneous).
5154 % Amount to narrow the margins by for @lisp.
5155 \newskip\lispnarrowing \lispnarrowing=0.4in
5157 % This is the definition that ^^M gets inside @lisp, @example, and other
5158 % such environments. \null is better than a space, since it doesn't
5159 % have any width.
5160 \def\lisppar{\null\endgraf}
5162 % This space is always present above and below environments.
5163 \newskip\envskipamount \envskipamount = 0pt
5165 % Make spacing and below environment symmetrical. We use \parskip here
5166 % to help in doing that, since in @example-like environments \parskip
5167 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5168 % start of the next paragraph will insert \parskip.
5170 \def\aboveenvbreak{{%
5171 % =10000 instead of <10000 because of a special case in \itemzzz and
5172 % \sectionheading, q.v.
5173 \ifnum \lastpenalty=10000 \else
5174 \advance\envskipamount by \parskip
5175 \endgraf
5176 \ifdim\lastskip<\envskipamount
5177 \removelastskip
5178 % it's not a good place to break if the last penalty was \nobreak
5179 % or better ...
5180 \ifnum\lastpenalty<10000 \penalty-50 \fi
5181 \vskip\envskipamount
5186 \let\afterenvbreak = \aboveenvbreak
5188 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5189 % also clear it, so that its embedded environments do the narrowing again.
5190 \let\nonarrowing=\relax
5192 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5193 % environment contents.
5194 \font\circle=lcircle10
5195 \newdimen\circthick
5196 \newdimen\cartouter\newdimen\cartinner
5197 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5198 \circthick=\fontdimen8\circle
5200 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5201 \def\ctr{{\hskip 6pt\circle\char'010}}
5202 \def\cbl{{\circle\char'012\hskip -6pt}}
5203 \def\cbr{{\hskip 6pt\circle\char'011}}
5204 \def\carttop{\hbox to \cartouter{\hskip\lskip
5205 \ctl\leaders\hrule height\circthick\hfil\ctr
5206 \hskip\rskip}}
5207 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5208 \cbl\leaders\hrule height\circthick\hfil\cbr
5209 \hskip\rskip}}
5211 \newskip\lskip\newskip\rskip
5213 \envdef\cartouche{%
5214 \ifhmode\par\fi % can't be in the midst of a paragraph.
5215 \startsavinginserts
5216 \lskip=\leftskip \rskip=\rightskip
5217 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5218 \cartinner=\hsize \advance\cartinner by-\lskip
5219 \advance\cartinner by-\rskip
5220 \cartouter=\hsize
5221 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5222 % side, and for 6pt waste from
5223 % each corner char, and rule thickness
5224 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5225 % Flag to tell @lisp, etc., not to narrow margin.
5226 \let\nonarrowing = t%
5227 \vbox\bgroup
5228 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5229 \carttop
5230 \hbox\bgroup
5231 \hskip\lskip
5232 \vrule\kern3pt
5233 \vbox\bgroup
5234 \kern3pt
5235 \hsize=\cartinner
5236 \baselineskip=\normbskip
5237 \lineskip=\normlskip
5238 \parskip=\normpskip
5239 \vskip -\parskip
5240 \comment % For explanation, see the end of \def\group.
5242 \def\Ecartouche{%
5243 \ifhmode\par\fi
5244 \kern3pt
5245 \egroup
5246 \kern3pt\vrule
5247 \hskip\rskip
5248 \egroup
5249 \cartbot
5250 \egroup
5251 \checkinserts
5255 % This macro is called at the beginning of all the @example variants,
5256 % inside a group.
5257 \def\nonfillstart{%
5258 \aboveenvbreak
5259 \hfuzz = 12pt % Don't be fussy
5260 \sepspaces % Make spaces be word-separators rather than space tokens.
5261 \let\par = \lisppar % don't ignore blank lines
5262 \obeylines % each line of input is a line of output
5263 \parskip = 0pt
5264 \parindent = 0pt
5265 \emergencystretch = 0pt % don't try to avoid overfull boxes
5266 \ifx\nonarrowing\relax
5267 \advance \leftskip by \lispnarrowing
5268 \exdentamount=\lispnarrowing
5269 \else
5270 \let\nonarrowing = \relax
5272 \let\exdent=\nofillexdent
5275 % If you want all examples etc. small: @set dispenvsize small.
5276 % If you want even small examples the full size: @set dispenvsize nosmall.
5277 % This affects the following displayed environments:
5278 % @example, @display, @format, @lisp
5280 \def\smallword{small}
5281 \def\nosmallword{nosmall}
5282 \let\SETdispenvsize\relax
5283 \def\setnormaldispenv{%
5284 \ifx\SETdispenvsize\smallword
5285 % end paragraph for sake of leading, in case document has no blank
5286 % line. This is redundant with what happens in \aboveenvbreak, but
5287 % we need to do it before changing the fonts, and it's inconvenient
5288 % to change the fonts afterward.
5289 \ifnum \lastpenalty=10000 \else \endgraf \fi
5290 \smallexamplefonts \rm
5293 \def\setsmalldispenv{%
5294 \ifx\SETdispenvsize\nosmallword
5295 \else
5296 \ifnum \lastpenalty=10000 \else \endgraf \fi
5297 \smallexamplefonts \rm
5301 % We often define two environments, @foo and @smallfoo.
5302 % Let's do it by one command:
5303 \def\makedispenv #1#2{
5304 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5305 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5306 \expandafter\let\csname E#1\endcsname \afterenvbreak
5307 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5310 % Define two synonyms:
5311 \def\maketwodispenvs #1#2#3{
5312 \makedispenv{#1}{#3}
5313 \makedispenv{#2}{#3}
5316 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5318 % @smallexample and @smalllisp: use smaller fonts.
5319 % Originally contributed by Pavel@xerox.
5321 \maketwodispenvs {lisp}{example}{%
5322 \nonfillstart
5323 \tt\quoteexpand
5324 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5325 \gobble % eat return
5327 % @display/@smalldisplay: same as @lisp except keep current font.
5329 \makedispenv {display}{%
5330 \nonfillstart
5331 \gobble
5334 % @format/@smallformat: same as @display except don't narrow margins.
5336 \makedispenv{format}{%
5337 \let\nonarrowing = t%
5338 \nonfillstart
5339 \gobble
5342 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5343 \envdef\flushleft{%
5344 \let\nonarrowing = t%
5345 \nonfillstart
5346 \gobble
5348 \let\Eflushleft = \afterenvbreak
5350 % @flushright.
5352 \envdef\flushright{%
5353 \let\nonarrowing = t%
5354 \nonfillstart
5355 \advance\leftskip by 0pt plus 1fill
5356 \gobble
5358 \let\Eflushright = \afterenvbreak
5361 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5362 % and narrows the margins. We keep \parskip nonzero in general, since
5363 % we're doing normal filling. So, when using \aboveenvbreak and
5364 % \afterenvbreak, temporarily make \parskip 0.
5366 \envdef\quotation{%
5367 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5368 \parindent=0pt
5370 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5371 \ifx\nonarrowing\relax
5372 \advance\leftskip by \lispnarrowing
5373 \advance\rightskip by \lispnarrowing
5374 \exdentamount = \lispnarrowing
5375 \else
5376 \let\nonarrowing = \relax
5378 \parsearg\quotationlabel
5381 % We have retained a nonzero parskip for the environment, since we're
5382 % doing normal filling.
5384 \def\Equotation{%
5385 \par
5386 \ifx\quotationauthor\undefined\else
5387 % indent a bit.
5388 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5390 {\parskip=0pt \afterenvbreak}%
5393 % If we're given an argument, typeset it in bold with a colon after.
5394 \def\quotationlabel#1{%
5395 \def\temp{#1}%
5396 \ifx\temp\empty \else
5397 {\bf #1: }%
5402 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5403 % If we want to allow any <char> as delimiter,
5404 % we need the curly braces so that makeinfo sees the @verb command, eg:
5405 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5407 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5409 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5410 % active too. Otherwise, they get lost as the first character on a
5411 % verbatim line.
5412 \def\dospecials{%
5413 \do\ \do\\\do\{\do\}\do\$\do\&%
5414 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5415 \do\<\do\>\do\|\do\@\do+\do\"%
5418 % [Knuth] p. 380
5419 \def\uncatcodespecials{%
5420 \def\do##1{\catcode`##1=\other}\dospecials}
5422 % [Knuth] pp. 380,381,391
5423 % Disable Spanish ligatures ?` and !` of \tt font
5424 \begingroup
5425 \catcode`\`=\active\gdef`{\relax\lq}
5426 \endgroup
5428 % Setup for the @verb command.
5430 % Eight spaces for a tab
5431 \begingroup
5432 \catcode`\^^I=\active
5433 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5434 \endgroup
5436 \def\setupverb{%
5437 \tt % easiest (and conventionally used) font for verbatim
5438 \def\par{\leavevmode\endgraf}%
5439 \catcode`\`=\active
5440 \tabeightspaces
5441 % Respect line breaks,
5442 % print special symbols as themselves, and
5443 % make each space count
5444 % must do in this order:
5445 \obeylines \uncatcodespecials \sepspaces
5448 % Setup for the @verbatim environment
5450 % Real tab expansion
5451 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5453 \def\starttabbox{\setbox0=\hbox\bgroup}
5455 % Allow an option to not replace quotes with a regular directed right
5456 % quote/apostrophe (char 0x27), but instead use the undirected quote
5457 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5458 % the default, but it works for pasting with more pdf viewers (at least
5459 % evince), the lilypond developers report. xpdf does work with the
5460 % regular 0x27.
5462 \def\codequoteright{%
5463 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5465 \else
5466 \char'15
5470 % and a similar option for the left quote char vs. a grave accent.
5471 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5472 % the code environments to do likewise.
5474 \def\codequoteleft{%
5475 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5477 \else
5478 \char'22
5482 \begingroup
5483 \catcode`\^^I=\active
5484 \gdef\tabexpand{%
5485 \catcode`\^^I=\active
5486 \def^^I{\leavevmode\egroup
5487 \dimen0=\wd0 % the width so far, or since the previous tab
5488 \divide\dimen0 by\tabw
5489 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5490 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5491 \wd0=\dimen0 \box0 \starttabbox
5494 \catcode`\'=\active
5495 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
5497 \catcode`\`=\active
5498 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
5500 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
5501 \endgroup
5503 % start the verbatim environment.
5504 \def\setupverbatim{%
5505 \let\nonarrowing = t%
5506 \nonfillstart
5507 % Easiest (and conventionally used) font for verbatim
5509 \def\par{\leavevmode\egroup\box0\endgraf}%
5510 \catcode`\`=\active
5511 \tabexpand
5512 \quoteexpand
5513 % Respect line breaks,
5514 % print special symbols as themselves, and
5515 % make each space count
5516 % must do in this order:
5517 \obeylines \uncatcodespecials \sepspaces
5518 \everypar{\starttabbox}%
5521 % Do the @verb magic: verbatim text is quoted by unique
5522 % delimiter characters. Before first delimiter expect a
5523 % right brace, after last delimiter expect closing brace:
5525 % \def\doverb'{'<char>#1<char>'}'{#1}
5527 % [Knuth] p. 382; only eat outer {}
5528 \begingroup
5529 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5530 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5531 \endgroup
5533 \def\verb{\begingroup\setupverb\doverb}
5536 % Do the @verbatim magic: define the macro \doverbatim so that
5537 % the (first) argument ends when '@end verbatim' is reached, ie:
5539 % \def\doverbatim#1@end verbatim{#1}
5541 % For Texinfo it's a lot easier than for LaTeX,
5542 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5543 % we need not redefine '\', '{' and '}'.
5545 % Inspired by LaTeX's verbatim command set [latex.ltx]
5547 \begingroup
5548 \catcode`\ =\active
5549 \obeylines %
5550 % ignore everything up to the first ^^M, that's the newline at the end
5551 % of the @verbatim input line itself. Otherwise we get an extra blank
5552 % line in the output.
5553 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5554 % We really want {...\end verbatim} in the body of the macro, but
5555 % without the active space; thus we have to use \xdef and \gobble.
5556 \endgroup
5558 \envdef\verbatim{%
5559 \setupverbatim\doverbatim
5561 \let\Everbatim = \afterenvbreak
5564 % @verbatiminclude FILE - insert text of file in verbatim environment.
5566 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5568 \def\doverbatiminclude#1{%
5570 \makevalueexpandable
5571 \setupverbatim
5572 \input #1
5573 \afterenvbreak
5577 % @copying ... @end copying.
5578 % Save the text away for @insertcopying later.
5580 % We save the uninterpreted tokens, rather than creating a box.
5581 % Saving the text in a box would be much easier, but then all the
5582 % typesetting commands (@smallbook, font changes, etc.) have to be done
5583 % beforehand -- and a) we want @copying to be done first in the source
5584 % file; b) letting users define the frontmatter in as flexible order as
5585 % possible is very desirable.
5587 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5588 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5590 \def\insertcopying{%
5591 \begingroup
5592 \parindent = 0pt % paragraph indentation looks wrong on title page
5593 \scanexp\copyingtext
5594 \endgroup
5597 \message{defuns,}
5598 % @defun etc.
5600 \newskip\defbodyindent \defbodyindent=.4in
5601 \newskip\defargsindent \defargsindent=50pt
5602 \newskip\deflastargmargin \deflastargmargin=18pt
5604 % Start the processing of @deffn:
5605 \def\startdefun{%
5606 \ifnum\lastpenalty<10000
5607 \medbreak
5608 \else
5609 % If there are two @def commands in a row, we'll have a \nobreak,
5610 % which is there to keep the function description together with its
5611 % header. But if there's nothing but headers, we need to allow a
5612 % break somewhere. Check specifically for penalty 10002, inserted
5613 % by \defargscommonending, instead of 10000, since the sectioning
5614 % commands also insert a nobreak penalty, and we don't want to allow
5615 % a break between a section heading and a defun.
5617 \ifnum\lastpenalty=10002 \penalty2000 \fi
5619 % Similarly, after a section heading, do not allow a break.
5620 % But do insert the glue.
5621 \medskip % preceded by discardable penalty, so not a breakpoint
5624 \parindent=0in
5625 \advance\leftskip by \defbodyindent
5626 \exdentamount=\defbodyindent
5629 \def\dodefunx#1{%
5630 % First, check whether we are in the right environment:
5631 \checkenv#1%
5633 % As above, allow line break if we have multiple x headers in a row.
5634 % It's not a great place, though.
5635 \ifnum\lastpenalty=10002 \penalty3000 \fi
5637 % And now, it's time to reuse the body of the original defun:
5638 \expandafter\gobbledefun#1%
5640 \def\gobbledefun#1\startdefun{}
5642 % \printdefunline \deffnheader{text}
5644 \def\printdefunline#1#2{%
5645 \begingroup
5646 % call \deffnheader:
5647 #1#2 \endheader
5648 % common ending:
5649 \interlinepenalty = 10000
5650 \advance\rightskip by 0pt plus 1fil
5651 \endgraf
5652 \nobreak\vskip -\parskip
5653 \penalty 10002 % signal to \startdefun and \dodefunx
5654 % Some of the @defun-type tags do not enable magic parentheses,
5655 % rendering the following check redundant. But we don't optimize.
5656 \checkparencounts
5657 \endgroup
5660 \def\Edefun{\endgraf\medbreak}
5662 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5663 % the only thing remainnig is to define \deffnheader.
5665 \def\makedefun#1{%
5666 \expandafter\let\csname E#1\endcsname = \Edefun
5667 \edef\temp{\noexpand\domakedefun
5668 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5669 \temp
5672 % \domakedefun \deffn \deffnx \deffnheader
5674 % Define \deffn and \deffnx, without parameters.
5675 % \deffnheader has to be defined explicitly.
5677 \def\domakedefun#1#2#3{%
5678 \envdef#1{%
5679 \startdefun
5680 \parseargusing\activeparens{\printdefunline#3}%
5682 \def#2{\dodefunx#1}%
5683 \def#3%
5686 %%% Untyped functions:
5688 % @deffn category name args
5689 \makedefun{deffn}{\deffngeneral{}}
5691 % @deffn category class name args
5692 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5694 % \defopon {category on}class name args
5695 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5697 % \deffngeneral {subind}category name args
5699 \def\deffngeneral#1#2 #3 #4\endheader{%
5700 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5701 \dosubind{fn}{\code{#3}}{#1}%
5702 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5705 %%% Typed functions:
5707 % @deftypefn category type name args
5708 \makedefun{deftypefn}{\deftypefngeneral{}}
5710 % @deftypeop category class type name args
5711 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5713 % \deftypeopon {category on}class type name args
5714 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5716 % \deftypefngeneral {subind}category type name args
5718 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5719 \dosubind{fn}{\code{#4}}{#1}%
5720 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5723 %%% Typed variables:
5725 % @deftypevr category type var args
5726 \makedefun{deftypevr}{\deftypecvgeneral{}}
5728 % @deftypecv category class type var args
5729 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5731 % \deftypecvof {category of}class type var args
5732 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5734 % \deftypecvgeneral {subind}category type var args
5736 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5737 \dosubind{vr}{\code{#4}}{#1}%
5738 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5741 %%% Untyped variables:
5743 % @defvr category var args
5744 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5746 % @defcv category class var args
5747 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5749 % \defcvof {category of}class var args
5750 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5752 %%% Type:
5753 % @deftp category name args
5754 \makedefun{deftp}#1 #2 #3\endheader{%
5755 \doind{tp}{\code{#2}}%
5756 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5759 % Remaining @defun-like shortcuts:
5760 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5761 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5762 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5763 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5764 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5765 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5766 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5767 \makedefun{defmethod}{\defopon\putwordMethodon}
5768 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5769 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5770 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5772 % \defname, which formats the name of the @def (not the args).
5773 % #1 is the category, such as "Function".
5774 % #2 is the return type, if any.
5775 % #3 is the function name.
5777 % We are followed by (but not passed) the arguments, if any.
5779 \def\defname#1#2#3{%
5780 % Get the values of \leftskip and \rightskip as they were outside the @def...
5781 \advance\leftskip by -\defbodyindent
5783 % How we'll format the type name. Putting it in brackets helps
5784 % distinguish it from the body text that may end up on the next line
5785 % just below it.
5786 \def\temp{#1}%
5787 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5789 % Figure out line sizes for the paragraph shape.
5790 % The first line needs space for \box0; but if \rightskip is nonzero,
5791 % we need only space for the part of \box0 which exceeds it:
5792 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5793 % The continuations:
5794 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5795 % (plain.tex says that \dimen1 should be used only as global.)
5796 \parshape 2 0in \dimen0 \defargsindent \dimen2
5798 % Put the type name to the right margin.
5799 \noindent
5800 \hbox to 0pt{%
5801 \hfil\box0 \kern-\hsize
5802 % \hsize has to be shortened this way:
5803 \kern\leftskip
5804 % Intentionally do not respect \rightskip, since we need the space.
5807 % Allow all lines to be underfull without complaint:
5808 \tolerance=10000 \hbadness=10000
5809 \exdentamount=\defbodyindent
5811 % defun fonts. We use typewriter by default (used to be bold) because:
5812 % . we're printing identifiers, they should be in tt in principle.
5813 % . in languages with many accents, such as Czech or French, it's
5814 % common to leave accents off identifiers. The result looks ok in
5815 % tt, but exceedingly strange in rm.
5816 % . we don't want -- and --- to be treated as ligatures.
5817 % . this still does not fix the ?` and !` ligatures, but so far no
5818 % one has made identifiers using them :).
5819 \df \tt
5820 \def\temp{#2}% return value type
5821 \ifx\temp\empty\else \tclose{\temp} \fi
5822 #3% output function name
5824 {\rm\enskip}% hskip 0.5 em of \tenrm
5826 \boldbrax
5827 % arguments will be output next, if any.
5830 % Print arguments in slanted roman (not ttsl), inconsistently with using
5831 % tt for the name. This is because literal text is sometimes needed in
5832 % the argument list (groff manual), and ttsl and tt are not very
5833 % distinguishable. Prevent hyphenation at `-' chars.
5835 \def\defunargs#1{%
5836 % use sl by default (not ttsl),
5837 % tt for the names.
5838 \df \sl \hyphenchar\font=0
5840 % On the other hand, if an argument has two dashes (for instance), we
5841 % want a way to get ttsl. Let's try @var for that.
5842 \let\var=\ttslanted
5844 \sl\hyphenchar\font=45
5847 % We want ()&[] to print specially on the defun line.
5849 \def\activeparens{%
5850 \catcode`\(=\active \catcode`\)=\active
5851 \catcode`\[=\active \catcode`\]=\active
5852 \catcode`\&=\active
5855 % Make control sequences which act like normal parenthesis chars.
5856 \let\lparen = ( \let\rparen = )
5858 % Be sure that we always have a definition for `(', etc. For example,
5859 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5860 % so TeX would otherwise complain about undefined control sequence.
5862 \activeparens
5863 \global\let(=\lparen \global\let)=\rparen
5864 \global\let[=\lbrack \global\let]=\rbrack
5865 \global\let& = \&
5867 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5868 \gdef\magicamp{\let&=\amprm}
5871 \newcount\parencount
5873 % If we encounter &foo, then turn on ()-hacking afterwards
5874 \newif\ifampseen
5875 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
5877 \def\parenfont{%
5878 \ifampseen
5879 % At the first level, print parens in roman,
5880 % otherwise use the default font.
5881 \ifnum \parencount=1 \rm \fi
5882 \else
5883 % The \sf parens (in \boldbrax) actually are a little bolder than
5884 % the contained text. This is especially needed for [ and ] .
5888 \def\infirstlevel#1{%
5889 \ifampseen
5890 \ifnum\parencount=1
5895 \def\bfafterword#1 {#1 \bf}
5897 \def\opnr{%
5898 \global\advance\parencount by 1
5899 {\parenfont(}%
5900 \infirstlevel \bfafterword
5902 \def\clnr{%
5903 {\parenfont)}%
5904 \infirstlevel \sl
5905 \global\advance\parencount by -1
5908 \newcount\brackcount
5909 \def\lbrb{%
5910 \global\advance\brackcount by 1
5911 {\bf[}%
5913 \def\rbrb{%
5914 {\bf]}%
5915 \global\advance\brackcount by -1
5918 \def\checkparencounts{%
5919 \ifnum\parencount=0 \else \badparencount \fi
5920 \ifnum\brackcount=0 \else \badbrackcount \fi
5922 \def\badparencount{%
5923 \errmessage{Unbalanced parentheses in @def}%
5924 \global\parencount=0
5926 \def\badbrackcount{%
5927 \errmessage{Unbalanced square braces in @def}%
5928 \global\brackcount=0
5932 \message{macros,}
5933 % @macro.
5935 % To do this right we need a feature of e-TeX, \scantokens,
5936 % which we arrange to emulate with a temporary file in ordinary TeX.
5937 \ifx\eTeXversion\undefined
5938 \newwrite\macscribble
5939 \def\scantokens#1{%
5940 \toks0={#1}%
5941 \immediate\openout\macscribble=\jobname.tmp
5942 \immediate\write\macscribble{\the\toks0}%
5943 \immediate\closeout\macscribble
5944 \input \jobname.tmp
5948 \def\scanmacro#1{%
5949 \begingroup
5950 \newlinechar`\^^M
5951 \let\xeatspaces\eatspaces
5952 % Undo catcode changes of \startcontents and \doprintindex
5953 % When called from @insertcopying or (short)caption, we need active
5954 % backslash to get it printed correctly. Previously, we had
5955 % \catcode`\\=\other instead. We'll see whether a problem appears
5956 % with macro expansion. --kasal, 19aug04
5957 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5958 % ... and \example
5959 \spaceisspace
5961 % Append \endinput to make sure that TeX does not see the ending newline.
5962 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5963 % --kasal, 29nov03
5964 \scantokens{#1\endinput}%
5965 \endgroup
5968 \def\scanexp#1{%
5969 \edef\temp{\noexpand\scanmacro{#1}}%
5970 \temp
5973 \newcount\paramno % Count of parameters
5974 \newtoks\macname % Macro name
5975 \newif\ifrecursive % Is it recursive?
5977 % List of all defined macros in the form
5978 % \definedummyword\macro1\definedummyword\macro2...
5979 % Currently is also contains all @aliases; the list can be split
5980 % if there is a need.
5981 \def\macrolist{}
5983 % Add the macro to \macrolist
5984 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
5985 \def\addtomacrolistxxx#1{%
5986 \toks0 = \expandafter{\macrolist\definedummyword#1}%
5987 \xdef\macrolist{\the\toks0}%
5990 % Utility routines.
5991 % This does \let #1 = #2, with \csnames; that is,
5992 % \let \csname#1\endcsname = \csname#2\endcsname
5993 % (except of course we have to play expansion games).
5995 \def\cslet#1#2{%
5996 \expandafter\let
5997 \csname#1\expandafter\endcsname
5998 \csname#2\endcsname
6001 % Trim leading and trailing spaces off a string.
6002 % Concepts from aro-bend problem 15 (see CTAN).
6003 {\catcode`\@=11
6004 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6005 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6006 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6007 \def\unbrace#1{#1}
6008 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6011 % Trim a single trailing ^^M off a string.
6012 {\catcode`\^^M=\other \catcode`\Q=3%
6013 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6014 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6015 \gdef\eatcrb#1Q#2Q{#1}%
6018 % Macro bodies are absorbed as an argument in a context where
6019 % all characters are catcode 10, 11 or 12, except \ which is active
6020 % (as in normal texinfo). It is necessary to change the definition of \.
6022 % It's necessary to have hard CRs when the macro is executed. This is
6023 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6024 % body, and then making it the \newlinechar in \scanmacro.
6026 \def\scanctxt{%
6027 \catcode`\"=\other
6028 \catcode`\+=\other
6029 \catcode`\<=\other
6030 \catcode`\>=\other
6031 \catcode`\@=\other
6032 \catcode`\^=\other
6033 \catcode`\_=\other
6034 \catcode`\|=\other
6035 \catcode`\~=\other
6038 \def\scanargctxt{%
6039 \scanctxt
6040 \catcode`\\=\other
6041 \catcode`\^^M=\other
6044 \def\macrobodyctxt{%
6045 \scanctxt
6046 \catcode`\{=\other
6047 \catcode`\}=\other
6048 \catcode`\^^M=\other
6049 \usembodybackslash
6052 \def\macroargctxt{%
6053 \scanctxt
6054 \catcode`\\=\other
6057 % \mbodybackslash is the definition of \ in @macro bodies.
6058 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6059 % where N is the macro parameter number.
6060 % We define \csname macarg.\endcsname to be \realbackslash, so
6061 % \\ in macro replacement text gets you a backslash.
6063 {\catcode`@=0 @catcode`@\=@active
6064 @gdef@usembodybackslash{@let\=@mbodybackslash}
6065 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6067 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6069 \def\macro{\recursivefalse\parsearg\macroxxx}
6070 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6072 \def\macroxxx#1{%
6073 \getargs{#1}% now \macname is the macname and \argl the arglist
6074 \ifx\argl\empty % no arguments
6075 \paramno=0%
6076 \else
6077 \expandafter\parsemargdef \argl;%
6079 \if1\csname ismacro.\the\macname\endcsname
6080 \message{Warning: redefining \the\macname}%
6081 \else
6082 \expandafter\ifx\csname \the\macname\endcsname \relax
6083 \else \errmessage{Macro name \the\macname\space already defined}\fi
6084 \global\cslet{macsave.\the\macname}{\the\macname}%
6085 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6086 \addtomacrolist{\the\macname}%
6088 \begingroup \macrobodyctxt
6089 \ifrecursive \expandafter\parsermacbody
6090 \else \expandafter\parsemacbody
6091 \fi}
6093 \parseargdef\unmacro{%
6094 \if1\csname ismacro.#1\endcsname
6095 \global\cslet{#1}{macsave.#1}%
6096 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6097 % Remove the macro name from \macrolist:
6098 \begingroup
6099 \expandafter\let\csname#1\endcsname \relax
6100 \let\definedummyword\unmacrodo
6101 \xdef\macrolist{\macrolist}%
6102 \endgroup
6103 \else
6104 \errmessage{Macro #1 not defined}%
6108 % Called by \do from \dounmacro on each macro. The idea is to omit any
6109 % macro definitions that have been changed to \relax.
6111 \def\unmacrodo#1{%
6112 \ifx #1\relax
6113 % remove this
6114 \else
6115 \noexpand\definedummyword \noexpand#1%
6119 % This makes use of the obscure feature that if the last token of a
6120 % <parameter list> is #, then the preceding argument is delimited by
6121 % an opening brace, and that opening brace is not consumed.
6122 \def\getargs#1{\getargsxxx#1{}}
6123 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6124 \def\getmacname #1 #2\relax{\macname={#1}}
6125 \def\getmacargs#1{\def\argl{#1}}
6127 % Parse the optional {params} list. Set up \paramno and \paramlist
6128 % so \defmacro knows what to do. Define \macarg.blah for each blah
6129 % in the params list, to be ##N where N is the position in that list.
6130 % That gets used by \mbodybackslash (above).
6132 % We need to get `macro parameter char #' into several definitions.
6133 % The technique used is stolen from LaTeX: let \hash be something
6134 % unexpandable, insert that wherever you need a #, and then redefine
6135 % it to # just before using the token list produced.
6137 % The same technique is used to protect \eatspaces till just before
6138 % the macro is used.
6140 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6141 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6142 \def\parsemargdefxxx#1,{%
6143 \if#1;\let\next=\relax
6144 \else \let\next=\parsemargdefxxx
6145 \advance\paramno by 1%
6146 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6147 {\xeatspaces{\hash\the\paramno}}%
6148 \edef\paramlist{\paramlist\hash\the\paramno,}%
6149 \fi\next}
6151 % These two commands read recursive and nonrecursive macro bodies.
6152 % (They're different since rec and nonrec macros end differently.)
6154 \long\def\parsemacbody#1@end macro%
6155 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6156 \long\def\parsermacbody#1@end rmacro%
6157 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6159 % This defines the macro itself. There are six cases: recursive and
6160 % nonrecursive macros of zero, one, and many arguments.
6161 % Much magic with \expandafter here.
6162 % \xdef is used so that macro definitions will survive the file
6163 % they're defined in; @include reads the file inside a group.
6164 \def\defmacro{%
6165 \let\hash=##% convert placeholders to macro parameter chars
6166 \ifrecursive
6167 \ifcase\paramno
6169 \expandafter\xdef\csname\the\macname\endcsname{%
6170 \noexpand\scanmacro{\temp}}%
6171 \or % 1
6172 \expandafter\xdef\csname\the\macname\endcsname{%
6173 \bgroup\noexpand\macroargctxt
6174 \noexpand\braceorline
6175 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6176 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6177 \egroup\noexpand\scanmacro{\temp}}%
6178 \else % many
6179 \expandafter\xdef\csname\the\macname\endcsname{%
6180 \bgroup\noexpand\macroargctxt
6181 \noexpand\csname\the\macname xx\endcsname}%
6182 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6183 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6184 \expandafter\expandafter
6185 \expandafter\xdef
6186 \expandafter\expandafter
6187 \csname\the\macname xxx\endcsname
6188 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6190 \else
6191 \ifcase\paramno
6193 \expandafter\xdef\csname\the\macname\endcsname{%
6194 \noexpand\norecurse{\the\macname}%
6195 \noexpand\scanmacro{\temp}\egroup}%
6196 \or % 1
6197 \expandafter\xdef\csname\the\macname\endcsname{%
6198 \bgroup\noexpand\macroargctxt
6199 \noexpand\braceorline
6200 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6201 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6202 \egroup
6203 \noexpand\norecurse{\the\macname}%
6204 \noexpand\scanmacro{\temp}\egroup}%
6205 \else % many
6206 \expandafter\xdef\csname\the\macname\endcsname{%
6207 \bgroup\noexpand\macroargctxt
6208 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6209 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6210 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6211 \expandafter\expandafter
6212 \expandafter\xdef
6213 \expandafter\expandafter
6214 \csname\the\macname xxx\endcsname
6215 \paramlist{%
6216 \egroup
6217 \noexpand\norecurse{\the\macname}%
6218 \noexpand\scanmacro{\temp}\egroup}%
6220 \fi}
6222 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6224 % \braceorline decides whether the next nonwhitespace character is a
6225 % {. If so it reads up to the closing }, if not, it reads the whole
6226 % line. Whatever was read is then fed to the next control sequence
6227 % as an argument (by \parsebrace or \parsearg)
6228 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6229 \def\braceorlinexxx{%
6230 \ifx\nchar\bgroup\else
6231 \expandafter\parsearg
6232 \fi \macnamexxx}
6235 % @alias.
6236 % We need some trickery to remove the optional spaces around the equal
6237 % sign. Just make them active and then expand them all to nothing.
6238 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6239 \def\aliasxxx #1{\aliasyyy#1\relax}
6240 \def\aliasyyy #1=#2\relax{%
6242 \expandafter\let\obeyedspace=\empty
6243 \addtomacrolist{#1}%
6244 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6246 \next
6250 \message{cross references,}
6252 \newwrite\auxfile
6254 \newif\ifhavexrefs % True if xref values are known.
6255 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6257 % @inforef is relatively simple.
6258 \def\inforef #1{\inforefzzz #1,,,,**}
6259 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6260 node \samp{\ignorespaces#1{}}}
6262 % @node's only job in TeX is to define \lastnode, which is used in
6263 % cross-references. The @node line might or might not have commas, and
6264 % might or might not have spaces before the first comma, like:
6265 % @node foo , bar , ...
6266 % We don't want such trailing spaces in the node name.
6268 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6270 % also remove a trailing comma, in case of something like this:
6271 % @node Help-Cross, , , Cross-refs
6272 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6273 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6275 \let\nwnode=\node
6276 \let\lastnode=\empty
6278 % Write a cross-reference definition for the current node. #1 is the
6279 % type (Ynumbered, Yappendix, Ynothing).
6281 \def\donoderef#1{%
6282 \ifx\lastnode\empty\else
6283 \setref{\lastnode}{#1}%
6284 \global\let\lastnode=\empty
6288 % @anchor{NAME} -- define xref target at arbitrary point.
6290 \newcount\savesfregister
6292 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6293 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6294 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6296 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6297 % anchor), which consists of three parts:
6298 % 1) NAME-title - the current sectioning name taken from \thissection,
6299 % or the anchor name.
6300 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6301 % empty for anchors.
6302 % 3) NAME-pg - the page number.
6304 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6305 % floats, there is an additional part, which is not written here:
6306 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6308 \def\setref#1#2{%
6309 \pdfmkdest{#1}%
6310 \iflinks
6312 \atdummies % preserve commands, but don't expand them
6313 \edef\writexrdef##1##2{%
6314 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6315 ##1}{##2}}% these are parameters of \writexrdef
6317 \toks0 = \expandafter{\thissection}%
6318 \immediate \writexrdef{title}{\the\toks0 }%
6319 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6320 \writexrdef{pg}{\folio}% will be written later, during \shipout
6325 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6326 % the node name, #2 the name of the Info cross-reference, #3 the printed
6327 % node name, #4 the name of the Info file, #5 the name of the printed
6328 % manual. All but the node name can be omitted.
6330 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6331 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6332 \def\ref#1{\xrefX[#1,,,,,,,]}
6333 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6334 \unsepspaces
6335 \def\printedmanual{\ignorespaces #5}%
6336 \def\printedrefname{\ignorespaces #3}%
6337 \setbox1=\hbox{\printedmanual\unskip}%
6338 \setbox0=\hbox{\printedrefname\unskip}%
6339 \ifdim \wd0 = 0pt
6340 % No printed node name was explicitly given.
6341 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6342 % Use the node name inside the square brackets.
6343 \def\printedrefname{\ignorespaces #1}%
6344 \else
6345 % Use the actual chapter/section title appear inside
6346 % the square brackets. Use the real section title if we have it.
6347 \ifdim \wd1 > 0pt
6348 % It is in another manual, so we don't have it.
6349 \def\printedrefname{\ignorespaces #1}%
6350 \else
6351 \ifhavexrefs
6352 % We know the real title if we have the xref values.
6353 \def\printedrefname{\refx{#1-title}{}}%
6354 \else
6355 % Otherwise just copy the Info node name.
6356 \def\printedrefname{\ignorespaces #1}%
6357 \fi%
6362 % Make link in pdf output.
6363 \ifpdf
6364 \leavevmode
6365 \getfilename{#4}%
6366 {\indexnofonts
6367 \turnoffactive
6368 % See comments at \activebackslashdouble.
6369 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6370 \backslashparens\pdfxrefdest}%
6372 \ifnum\filenamelength>0
6373 \startlink attr{/Border [0 0 0]}%
6374 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6375 \else
6376 \startlink attr{/Border [0 0 0]}%
6377 goto name{\pdfmkpgn{\pdfxrefdest}}%
6380 \linkcolor
6383 % Float references are printed completely differently: "Figure 1.2"
6384 % instead of "[somenode], p.3". We distinguish them by the
6385 % LABEL-title being set to a magic string.
6387 % Have to otherify everything special to allow the \csname to
6388 % include an _ in the xref name, etc.
6389 \indexnofonts
6390 \turnoffactive
6391 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6392 \csname XR#1-title\endcsname
6394 \iffloat\Xthisreftitle
6395 % If the user specified the print name (third arg) to the ref,
6396 % print it instead of our usual "Figure 1.2".
6397 \ifdim\wd0 = 0pt
6398 \refx{#1-snt}{}%
6399 \else
6400 \printedrefname
6403 % if the user also gave the printed manual name (fifth arg), append
6404 % "in MANUALNAME".
6405 \ifdim \wd1 > 0pt
6406 \space \putwordin{} \cite{\printedmanual}%
6408 \else
6409 % node/anchor (non-float) references.
6411 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6412 % insert empty discretionaries after hyphens, which means that it will
6413 % not find a line break at a hyphen in a node names. Since some manuals
6414 % are best written with fairly long node names, containing hyphens, this
6415 % is a loss. Therefore, we give the text of the node name again, so it
6416 % is as if TeX is seeing it for the first time.
6417 \ifdim \wd1 > 0pt
6418 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6419 \else
6420 % _ (for example) has to be the character _ for the purposes of the
6421 % control sequence corresponding to the node, but it has to expand
6422 % into the usual \leavevmode...\vrule stuff for purposes of
6423 % printing. So we \turnoffactive for the \refx-snt, back on for the
6424 % printing, back off for the \refx-pg.
6425 {\turnoffactive
6426 % Only output a following space if the -snt ref is nonempty; for
6427 % @unnumbered and @anchor, it won't be.
6428 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6429 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6431 % output the `[mynode]' via a macro so it can be overridden.
6432 \xrefprintnodename\printedrefname
6434 % But we always want a comma and a space:
6435 ,\space
6437 % output the `page 3'.
6438 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6441 \endlink
6442 \endgroup}
6444 % This macro is called from \xrefX for the `[nodename]' part of xref
6445 % output. It's a separate macro only so it can be changed more easily,
6446 % since square brackets don't work well in some documents. Particularly
6447 % one that Bob is working on :).
6449 \def\xrefprintnodename#1{[#1]}
6451 % Things referred to by \setref.
6453 \def\Ynothing{}
6454 \def\Yomitfromtoc{}
6455 \def\Ynumbered{%
6456 \ifnum\secno=0
6457 \putwordChapter@tie \the\chapno
6458 \else \ifnum\subsecno=0
6459 \putwordSection@tie \the\chapno.\the\secno
6460 \else \ifnum\subsubsecno=0
6461 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6462 \else
6463 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6464 \fi\fi\fi
6466 \def\Yappendix{%
6467 \ifnum\secno=0
6468 \putwordAppendix@tie @char\the\appendixno{}%
6469 \else \ifnum\subsecno=0
6470 \putwordSection@tie @char\the\appendixno.\the\secno
6471 \else \ifnum\subsubsecno=0
6472 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6473 \else
6474 \putwordSection@tie
6475 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6476 \fi\fi\fi
6479 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6480 % If its value is nonempty, SUFFIX is output afterward.
6482 \def\refx#1#2{%
6484 \indexnofonts
6485 \otherbackslash
6486 \expandafter\global\expandafter\let\expandafter\thisrefX
6487 \csname XR#1\endcsname
6489 \ifx\thisrefX\relax
6490 % If not defined, say something at least.
6491 \angleleft un\-de\-fined\angleright
6492 \iflinks
6493 \ifhavexrefs
6494 \message{\linenumber Undefined cross reference `#1'.}%
6495 \else
6496 \ifwarnedxrefs\else
6497 \global\warnedxrefstrue
6498 \message{Cross reference values unknown; you must run TeX again.}%
6502 \else
6503 % It's defined, so just use it.
6504 \thisrefX
6506 #2% Output the suffix in any case.
6509 % This is the macro invoked by entries in the aux file. Usually it's
6510 % just a \def (we prepend XR to the control sequence name to avoid
6511 % collisions). But if this is a float type, we have more work to do.
6513 \def\xrdef#1#2{%
6514 {% The node name might contain 8-bit characters, which in our current
6515 % implementation are changed to commands like @'e. Don't let these
6516 % mess up the control sequence name.
6517 \indexnofonts
6518 \turnoffactive
6519 \xdef\safexrefname{#1}%
6522 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
6524 % Was that xref control sequence that we just defined for a float?
6525 \expandafter\iffloat\csname XR\safexrefname\endcsname
6526 % it was a float, and we have the (safe) float type in \iffloattype.
6527 \expandafter\let\expandafter\floatlist
6528 \csname floatlist\iffloattype\endcsname
6530 % Is this the first time we've seen this float type?
6531 \expandafter\ifx\floatlist\relax
6532 \toks0 = {\do}% yes, so just \do
6533 \else
6534 % had it before, so preserve previous elements in list.
6535 \toks0 = \expandafter{\floatlist\do}%
6538 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6539 % for later use in \listoffloats.
6540 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
6541 {\safexrefname}}%
6545 % Read the last existing aux file, if any. No error if none exists.
6547 \def\tryauxfile{%
6548 \openin 1 \jobname.aux
6549 \ifeof 1 \else
6550 \readdatafile{aux}%
6551 \global\havexrefstrue
6553 \closein 1
6556 \def\setupdatafile{%
6557 \catcode`\^^@=\other
6558 \catcode`\^^A=\other
6559 \catcode`\^^B=\other
6560 \catcode`\^^C=\other
6561 \catcode`\^^D=\other
6562 \catcode`\^^E=\other
6563 \catcode`\^^F=\other
6564 \catcode`\^^G=\other
6565 \catcode`\^^H=\other
6566 \catcode`\^^K=\other
6567 \catcode`\^^L=\other
6568 \catcode`\^^N=\other
6569 \catcode`\^^P=\other
6570 \catcode`\^^Q=\other
6571 \catcode`\^^R=\other
6572 \catcode`\^^S=\other
6573 \catcode`\^^T=\other
6574 \catcode`\^^U=\other
6575 \catcode`\^^V=\other
6576 \catcode`\^^W=\other
6577 \catcode`\^^X=\other
6578 \catcode`\^^Z=\other
6579 \catcode`\^^[=\other
6580 \catcode`\^^\=\other
6581 \catcode`\^^]=\other
6582 \catcode`\^^^=\other
6583 \catcode`\^^_=\other
6584 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6585 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6586 % supported in the main text, it doesn't seem desirable. Furthermore,
6587 % that is not enough: for node names that actually contain a ^
6588 % character, we would end up writing a line like this: 'xrdef {'hat
6589 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6590 % argument, and \hat is not an expandable control sequence. It could
6591 % all be worked out, but why? Either we support ^^ or we don't.
6593 % The other change necessary for this was to define \auxhat:
6594 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6595 % and then to call \auxhat in \setq.
6597 \catcode`\^=\other
6599 % Special characters. Should be turned off anyway, but...
6600 \catcode`\~=\other
6601 \catcode`\[=\other
6602 \catcode`\]=\other
6603 \catcode`\"=\other
6604 \catcode`\_=\other
6605 \catcode`\|=\other
6606 \catcode`\<=\other
6607 \catcode`\>=\other
6608 \catcode`\$=\other
6609 \catcode`\#=\other
6610 \catcode`\&=\other
6611 \catcode`\%=\other
6612 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6614 % This is to support \ in node names and titles, since the \
6615 % characters end up in a \csname. It's easier than
6616 % leaving it active and making its active definition an actual \
6617 % character. What I don't understand is why it works in the *value*
6618 % of the xrdef. Seems like it should be a catcode12 \, and that
6619 % should not typeset properly. But it works, so I'm moving on for
6620 % now. --karl, 15jan04.
6621 \catcode`\\=\other
6623 % Make the characters 128-255 be printing characters.
6625 \count1=128
6626 \def\loop{%
6627 \catcode\count1=\other
6628 \advance\count1 by 1
6629 \ifnum \count1<256 \loop \fi
6633 % @ is our escape character in .aux files, and we need braces.
6634 \catcode`\{=1
6635 \catcode`\}=2
6636 \catcode`\@=0
6639 \def\readdatafile#1{%
6640 \begingroup
6641 \setupdatafile
6642 \input\jobname.#1
6643 \endgroup}
6645 \message{insertions,}
6646 % including footnotes.
6648 \newcount \footnoteno
6650 % The trailing space in the following definition for supereject is
6651 % vital for proper filling; pages come out unaligned when you do a
6652 % pagealignmacro call if that space before the closing brace is
6653 % removed. (Generally, numeric constants should always be followed by a
6654 % space to prevent strange expansion errors.)
6655 \def\supereject{\par\penalty -20000\footnoteno =0 }
6657 % @footnotestyle is meaningful for info output only.
6658 \let\footnotestyle=\comment
6660 {\catcode `\@=11
6662 % Auto-number footnotes. Otherwise like plain.
6663 \gdef\footnote{%
6664 \let\indent=\ptexindent
6665 \let\noindent=\ptexnoindent
6666 \global\advance\footnoteno by \@ne
6667 \edef\thisfootno{$^{\the\footnoteno}$}%
6669 % In case the footnote comes at the end of a sentence, preserve the
6670 % extra spacing after we do the footnote number.
6671 \let\@sf\empty
6672 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6674 % Remove inadvertent blank space before typesetting the footnote number.
6675 \unskip
6676 \thisfootno\@sf
6677 \dofootnote
6680 % Don't bother with the trickery in plain.tex to not require the
6681 % footnote text as a parameter. Our footnotes don't need to be so general.
6683 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6684 % \parseargline) fails inside footnotes because the tokens are fixed when
6685 % the footnote is read. --karl, 16nov96.
6687 \gdef\dofootnote{%
6688 \insert\footins\bgroup
6689 % We want to typeset this text as a normal paragraph, even if the
6690 % footnote reference occurs in (for example) a display environment.
6691 % So reset some parameters.
6692 \hsize=\pagewidth
6693 \interlinepenalty\interfootnotelinepenalty
6694 \splittopskip\ht\strutbox % top baseline for broken footnotes
6695 \splitmaxdepth\dp\strutbox
6696 \floatingpenalty\@MM
6697 \leftskip\z@skip
6698 \rightskip\z@skip
6699 \spaceskip\z@skip
6700 \xspaceskip\z@skip
6701 \parindent\defaultparindent
6703 \smallfonts \rm
6705 % Because we use hanging indentation in footnotes, a @noindent appears
6706 % to exdent this text, so make it be a no-op. makeinfo does not use
6707 % hanging indentation so @noindent can still be needed within footnote
6708 % text after an @example or the like (not that this is good style).
6709 \let\noindent = \relax
6711 % Hang the footnote text off the number. Use \everypar in case the
6712 % footnote extends for more than one paragraph.
6713 \everypar = {\hang}%
6714 \textindent{\thisfootno}%
6716 % Don't crash into the line above the footnote text. Since this
6717 % expands into a box, it must come within the paragraph, lest it
6718 % provide a place where TeX can split the footnote.
6719 \footstrut
6720 \futurelet\next\fo@t
6722 }%end \catcode `\@=11
6724 % In case a @footnote appears in a vbox, save the footnote text and create
6725 % the real \insert just after the vbox finished. Otherwise, the insertion
6726 % would be lost.
6727 % Similarily, if a @footnote appears inside an alignment, save the footnote
6728 % text to a box and make the \insert when a row of the table is finished.
6729 % And the same can be done for other insert classes. --kasal, 16nov03.
6731 % Replace the \insert primitive by a cheating macro.
6732 % Deeper inside, just make sure that the saved insertions are not spilled
6733 % out prematurely.
6735 \def\startsavinginserts{%
6736 \ifx \insert\ptexinsert
6737 \let\insert\saveinsert
6738 \else
6739 \let\checkinserts\relax
6743 % This \insert replacement works for both \insert\footins{foo} and
6744 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6746 \def\saveinsert#1{%
6747 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6748 \afterassignment\next
6749 % swallow the left brace
6750 \let\temp =
6752 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6753 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6755 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6757 \def\placesaveins#1{%
6758 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6759 {\box#1}%
6762 % eat @SAVE -- beware, all of them have catcode \other:
6764 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6765 \gdef\gobblesave @SAVE{}
6768 % initialization:
6769 \def\newsaveins #1{%
6770 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6771 \next
6773 \def\newsaveinsX #1{%
6774 \csname newbox\endcsname #1%
6775 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6776 \checksaveins #1}%
6779 % initialize:
6780 \let\checkinserts\empty
6781 \newsaveins\footins
6782 \newsaveins\margin
6785 % @image. We use the macros from epsf.tex to support this.
6786 % If epsf.tex is not installed and @image is used, we complain.
6788 % Check for and read epsf.tex up front. If we read it only at @image
6789 % time, we might be inside a group, and then its definitions would get
6790 % undone and the next image would fail.
6791 \openin 1 = epsf.tex
6792 \ifeof 1 \else
6793 % Do not bother showing banner with epsf.tex v2.7k (available in
6794 % doc/epsf.tex and on ctan).
6795 \def\epsfannounce{\toks0 = }%
6796 \input epsf.tex
6798 \closein 1
6800 % We will only complain once about lack of epsf.tex.
6801 \newif\ifwarnednoepsf
6802 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6803 work. It is also included in the Texinfo distribution, or you can get
6804 it from ftp://tug.org/tex/epsf.tex.}
6806 \def\image#1{%
6807 \ifx\epsfbox\undefined
6808 \ifwarnednoepsf \else
6809 \errhelp = \noepsfhelp
6810 \errmessage{epsf.tex not found, images will be ignored}%
6811 \global\warnednoepsftrue
6813 \else
6814 \imagexxx #1,,,,,\finish
6818 % Arguments to @image:
6819 % #1 is (mandatory) image filename; we tack on .eps extension.
6820 % #2 is (optional) width, #3 is (optional) height.
6821 % #4 is (ignored optional) html alt text.
6822 % #5 is (ignored optional) extension.
6823 % #6 is just the usual extra ignored arg for parsing this stuff.
6824 \newif\ifimagevmode
6825 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6826 \catcode`\^^M = 5 % in case we're inside an example
6827 \normalturnoffactive % allow _ et al. in names
6828 % If the image is by itself, center it.
6829 \ifvmode
6830 \imagevmodetrue
6831 \nobreak\bigskip
6832 % Usually we'll have text after the image which will insert
6833 % \parskip glue, so insert it here too to equalize the space
6834 % above and below.
6835 \nobreak\vskip\parskip
6836 \nobreak
6837 \line\bgroup
6840 % Output the image.
6841 \ifpdf
6842 \dopdfimage{#1}{#2}{#3}%
6843 \else
6844 % \epsfbox itself resets \epsf?size at each figure.
6845 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6846 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6847 \epsfbox{#1.eps}%
6850 \ifimagevmode \egroup \bigbreak \fi % space after the image
6851 \endgroup}
6854 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6855 % etc. We don't actually implement floating yet, we always include the
6856 % float "here". But it seemed the best name for the future.
6858 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6860 % There may be a space before second and/or third parameter; delete it.
6861 \def\eatcommaspace#1, {#1,}
6863 % #1 is the optional FLOATTYPE, the text label for this float, typically
6864 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6865 % this float will not be numbered and cannot be referred to.
6867 % #2 is the optional xref label. Also must be present for the float to
6868 % be referable.
6870 % #3 is the optional positioning argument; for now, it is ignored. It
6871 % will somehow specify the positions allowed to float to (here, top, bottom).
6873 % We keep a separate counter for each FLOATTYPE, which we reset at each
6874 % chapter-level command.
6875 \let\resetallfloatnos=\empty
6877 \def\dofloat#1,#2,#3,#4\finish{%
6878 \let\thiscaption=\empty
6879 \let\thisshortcaption=\empty
6881 % don't lose footnotes inside @float.
6883 % BEWARE: when the floats start float, we have to issue warning whenever an
6884 % insert appears inside a float which could possibly float. --kasal, 26may04
6886 \startsavinginserts
6888 % We can't be used inside a paragraph.
6889 \par
6891 \vtop\bgroup
6892 \def\floattype{#1}%
6893 \def\floatlabel{#2}%
6894 \def\floatloc{#3}% we do nothing with this yet.
6896 \ifx\floattype\empty
6897 \let\safefloattype=\empty
6898 \else
6900 % the floattype might have accents or other special characters,
6901 % but we need to use it in a control sequence name.
6902 \indexnofonts
6903 \turnoffactive
6904 \xdef\safefloattype{\floattype}%
6908 % If label is given but no type, we handle that as the empty type.
6909 \ifx\floatlabel\empty \else
6910 % We want each FLOATTYPE to be numbered separately (Figure 1,
6911 % Table 1, Figure 2, ...). (And if no label, no number.)
6913 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6914 \global\advance\floatno by 1
6917 % This magic value for \thissection is output by \setref as the
6918 % XREFLABEL-title value. \xrefX uses it to distinguish float
6919 % labels (which have a completely different output format) from
6920 % node and anchor labels. And \xrdef uses it to construct the
6921 % lists of floats.
6923 \edef\thissection{\floatmagic=\safefloattype}%
6924 \setref{\floatlabel}{Yfloat}%
6928 % start with \parskip glue, I guess.
6929 \vskip\parskip
6931 % Don't suppress indentation if a float happens to start a section.
6932 \restorefirstparagraphindent
6935 % we have these possibilities:
6936 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6937 % @float Foo,lbl & no caption: Foo 1.1
6938 % @float Foo & @caption{Cap}: Foo: Cap
6939 % @float Foo & no caption: Foo
6940 % @float ,lbl & Caption{Cap}: 1.1: Cap
6941 % @float ,lbl & no caption: 1.1
6942 % @float & @caption{Cap}: Cap
6943 % @float & no caption:
6945 \def\Efloat{%
6946 \let\floatident = \empty
6948 % In all cases, if we have a float type, it comes first.
6949 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6951 % If we have an xref label, the number comes next.
6952 \ifx\floatlabel\empty \else
6953 \ifx\floattype\empty \else % if also had float type, need tie first.
6954 \appendtomacro\floatident{\tie}%
6956 % the number.
6957 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6960 % Start the printed caption with what we've constructed in
6961 % \floatident, but keep it separate; we need \floatident again.
6962 \let\captionline = \floatident
6964 \ifx\thiscaption\empty \else
6965 \ifx\floatident\empty \else
6966 \appendtomacro\captionline{: }% had ident, so need a colon between
6969 % caption text.
6970 \appendtomacro\captionline{\scanexp\thiscaption}%
6973 % If we have anything to print, print it, with space before.
6974 % Eventually this needs to become an \insert.
6975 \ifx\captionline\empty \else
6976 \vskip.5\parskip
6977 \captionline
6979 % Space below caption.
6980 \vskip\parskip
6983 % If have an xref label, write the list of floats info. Do this
6984 % after the caption, to avoid chance of it being a breakpoint.
6985 \ifx\floatlabel\empty \else
6986 % Write the text that goes in the lof to the aux file as
6987 % \floatlabel-lof. Besides \floatident, we include the short
6988 % caption if specified, else the full caption if specified, else nothing.
6990 \atdummies
6992 % since we read the caption text in the macro world, where ^^M
6993 % is turned into a normal character, we have to scan it back, so
6994 % we don't write the literal three characters "^^M" into the aux file.
6995 \scanexp{%
6996 \xdef\noexpand\gtemp{%
6997 \ifx\thisshortcaption\empty
6998 \thiscaption
6999 \else
7000 \thisshortcaption
7004 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7005 \ifx\gtemp\empty \else : \gtemp \fi}}%
7008 \egroup % end of \vtop
7010 % place the captured inserts
7012 % BEWARE: when the floats start floating, we have to issue warning
7013 % whenever an insert appears inside a float which could possibly
7014 % float. --kasal, 26may04
7016 \checkinserts
7019 % Append the tokens #2 to the definition of macro #1, not expanding either.
7021 \def\appendtomacro#1#2{%
7022 \expandafter\def\expandafter#1\expandafter{#1#2}%
7025 % @caption, @shortcaption
7027 \def\caption{\docaption\thiscaption}
7028 \def\shortcaption{\docaption\thisshortcaption}
7029 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7030 \def\defcaption#1#2{\egroup \def#1{#2}}
7032 % The parameter is the control sequence identifying the counter we are
7033 % going to use. Create it if it doesn't exist and assign it to \floatno.
7034 \def\getfloatno#1{%
7035 \ifx#1\relax
7036 % Haven't seen this figure type before.
7037 \csname newcount\endcsname #1%
7039 % Remember to reset this floatno at the next chap.
7040 \expandafter\gdef\expandafter\resetallfloatnos
7041 \expandafter{\resetallfloatnos #1=0 }%
7043 \let\floatno#1%
7046 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7047 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7048 % first read the @float command.
7050 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7052 % Magic string used for the XREFLABEL-title value, so \xrefX can
7053 % distinguish floats from other xref types.
7054 \def\floatmagic{!!float!!}
7056 % #1 is the control sequence we are passed; we expand into a conditional
7057 % which is true if #1 represents a float ref. That is, the magic
7058 % \thissection value which we \setref above.
7060 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7062 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7063 % (safe) float type for this float. We set \iffloattype to #2.
7065 \def\doiffloat#1=#2=#3\finish{%
7066 \def\temp{#1}%
7067 \def\iffloattype{#2}%
7068 \ifx\temp\floatmagic
7071 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7073 \parseargdef\listoffloats{%
7074 \def\floattype{#1}% floattype
7076 % the floattype might have accents or other special characters,
7077 % but we need to use it in a control sequence name.
7078 \indexnofonts
7079 \turnoffactive
7080 \xdef\safefloattype{\floattype}%
7083 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7084 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7085 \ifhavexrefs
7086 % if the user said @listoffloats foo but never @float foo.
7087 \message{\linenumber No `\safefloattype' floats to list.}%
7089 \else
7090 \begingroup
7091 \leftskip=\tocindent % indent these entries like a toc
7092 \let\do=\listoffloatsdo
7093 \csname floatlist\safefloattype\endcsname
7094 \endgroup
7098 % This is called on each entry in a list of floats. We're passed the
7099 % xref label, in the form LABEL-title, which is how we save it in the
7100 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7101 % has the text we're supposed to typeset here.
7103 % Figures without xref labels will not be included in the list (since
7104 % they won't appear in the aux file).
7106 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7107 \def\listoffloatsdoentry#1-title\finish{{%
7108 % Can't fully expand XR#1-lof because it can contain anything. Just
7109 % pass the control sequence. On the other hand, XR#1-pg is just the
7110 % page number, and we want to fully expand that so we can get a link
7111 % in pdf output.
7112 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7114 % use the same \entry macro we use to generate the TOC and index.
7115 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7116 \writeentry
7119 \message{localization,}
7120 % and i18n.
7122 % @documentlanguage is usually given very early, just after
7123 % @setfilename. If done too late, it may not override everything
7124 % properly. Single argument is the language abbreviation.
7125 % It would be nice if we could set up a hyphenation file here.
7127 \parseargdef\documentlanguage{%
7128 \tex % read txi-??.tex file in plain TeX.
7129 % Read the file if it exists.
7130 \openin 1 txi-#1.tex
7131 \ifeof 1
7132 \errhelp = \nolanghelp
7133 \errmessage{Cannot read language file txi-#1.tex}%
7134 \else
7135 \input txi-#1.tex
7137 \closein 1
7138 \endgroup
7140 \newhelp\nolanghelp{The given language definition file cannot be found or
7141 is empty. Maybe you need to install it? In the current directory
7142 should work if nowhere else does.}
7144 % Set the catcode of characters 128 through 255 to the specified number.
7146 \def\setnonasciicharscatcode#1{
7147 \count255=128
7148 \loop\ifnum\count255<256
7149 \global\catcode\count255=#1
7150 \advance\count255 by 1
7151 \repeat
7154 % @documentencoding sets the definition of non-ASCII characters
7155 % according to the specified encoding.
7157 \parseargdef\documentencoding{%
7158 % Encoding being declared for the document.
7159 \def\declaredencoding{\csname #1.enc\endcsname}%
7161 % Supported encodings: names converted to tokens in order to be able
7162 % to compare them with \ifx.
7163 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7164 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7165 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7166 \def\ascii{\csname US-ASCII.enc\endcsname}%
7168 \ifx \declaredencoding \ascii
7169 \asciichardefs
7171 \else \ifx \declaredencoding \lattwo
7172 \setnonasciicharscatcode\active
7173 \lattwochardefs
7175 \else \ifx \declaredencoding \latone
7176 \setnonasciicharscatcode\active
7177 \latonechardefs
7179 \else \ifx \declaredencoding \latnine
7180 \setnonasciicharscatcode\active
7181 \latninechardefs
7183 \else
7184 \message{Unknown document encoding #1, ignoring.}%
7186 \fi % latnine
7187 \fi % latone
7188 \fi % lattwo
7189 \fi % ascii
7192 % A message to be logged when using a character that isn't available
7193 % the default font encoding (OT1).
7195 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7197 % Take account of \c (plain) vs. \, (Texinfo) difference.
7198 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7200 % First, make active non-ASCII characters in order for them to be
7201 % correctly categorized when TeX reads the replacement text of
7202 % macros containing the character definitions.
7203 \setnonasciicharscatcode\active
7205 % Latin1 (ISO-8859-1) character definitions.
7206 \def\latonechardefs{%
7207 \gdef^^a0{~}
7208 \gdef^^a1{\exclamdown}
7209 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7210 \gdef^^a3{{\pounds}}
7211 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7212 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7213 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7214 \gdef^^a7{\S}
7215 \gdef^^a8{\"{}}
7216 \gdef^^a9{\copyright}
7217 \gdef^^aa{\ordf}
7218 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7219 \gdef^^ac{$\lnot$}
7220 \gdef^^ad{\-}
7221 \gdef^^ae{\registeredsymbol}
7222 \gdef^^af{\={}}
7224 \gdef^^b0{\textdegree}
7225 \gdef^^b1{$\pm$}
7226 \gdef^^b2{$^2$}
7227 \gdef^^b3{$^3$}
7228 \gdef^^b4{\'{}}
7229 \gdef^^b5{$\mu$}
7230 \gdef^^b6{\P}
7232 \gdef^^b7{$^.$}
7233 \gdef^^b8{\cedilla\ }
7234 \gdef^^b9{$^1$}
7235 \gdef^^ba{\ordm}
7237 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7238 \gdef^^bc{$1\over4$}
7239 \gdef^^bd{$1\over2$}
7240 \gdef^^be{$3\over4$}
7241 \gdef^^bf{\questiondown}
7243 \gdef^^c0{\`A}
7244 \gdef^^c1{\'A}
7245 \gdef^^c2{\^A}
7246 \gdef^^c3{\~A}
7247 \gdef^^c4{\"A}
7248 \gdef^^c5{\ringaccent A}
7249 \gdef^^c6{\AE}
7250 \gdef^^c7{\cedilla C}
7251 \gdef^^c8{\`E}
7252 \gdef^^c9{\'E}
7253 \gdef^^ca{\^E}
7254 \gdef^^cb{\"E}
7255 \gdef^^cc{\`I}
7256 \gdef^^cd{\'I}
7257 \gdef^^ce{\^I}
7258 \gdef^^cf{\"I}
7260 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7261 \gdef^^d1{\~N}
7262 \gdef^^d2{\`O}
7263 \gdef^^d3{\'O}
7264 \gdef^^d4{\^O}
7265 \gdef^^d5{\~O}
7266 \gdef^^d6{\"O}
7267 \gdef^^d7{$\times$}
7268 \gdef^^d8{\O}
7269 \gdef^^d9{\`U}
7270 \gdef^^da{\'U}
7271 \gdef^^db{\^U}
7272 \gdef^^dc{\"U}
7273 \gdef^^dd{\'Y}
7274 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7275 \gdef^^df{\ss}
7277 \gdef^^e0{\`a}
7278 \gdef^^e1{\'a}
7279 \gdef^^e2{\^a}
7280 \gdef^^e3{\~a}
7281 \gdef^^e4{\"a}
7282 \gdef^^e5{\ringaccent a}
7283 \gdef^^e6{\ae}
7284 \gdef^^e7{\cedilla c}
7285 \gdef^^e8{\`e}
7286 \gdef^^e9{\'e}
7287 \gdef^^ea{\^e}
7288 \gdef^^eb{\"e}
7289 \gdef^^ec{\`{\dotless i}}
7290 \gdef^^ed{\'{\dotless i}}
7291 \gdef^^ee{\^{\dotless i}}
7292 \gdef^^ef{\"{\dotless i}}
7294 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7295 \gdef^^f1{\~n}
7296 \gdef^^f2{\`o}
7297 \gdef^^f3{\'o}
7298 \gdef^^f4{\^o}
7299 \gdef^^f5{\~o}
7300 \gdef^^f6{\"o}
7301 \gdef^^f7{$\div$}
7302 \gdef^^f8{\o}
7303 \gdef^^f9{\`u}
7304 \gdef^^fa{\'u}
7305 \gdef^^fb{\^u}
7306 \gdef^^fc{\"u}
7307 \gdef^^fd{\'y}
7308 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7309 \gdef^^ff{\"y}
7312 % Latin9 (ISO-8859-15) encoding character definitions.
7313 \def\latninechardefs{%
7314 % Encoding is almost identical to Latin1.
7315 \latonechardefs
7317 \gdef^^a4{\euro}
7318 \gdef^^a6{\v S}
7319 \gdef^^a8{\v s}
7320 \gdef^^b4{\v Z}
7321 \gdef^^b8{\v z}
7322 \gdef^^bc{\OE}
7323 \gdef^^bd{\oe}
7324 \gdef^^be{\"Y}
7327 % Latin2 (ISO-8859-2) character definitions.
7328 \def\lattwochardefs{%
7329 \gdef^^a0{~}
7330 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7331 \gdef^^a2{\u{}}
7332 \gdef^^a3{\L}
7333 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7334 \gdef^^a5{\v L}
7335 \gdef^^a6{\'S}
7336 \gdef^^a7{\S}
7337 \gdef^^a8{\"{}}
7338 \gdef^^a9{\v S}
7339 \gdef^^aa{\cedilla S}
7340 \gdef^^ab{\v T}
7341 \gdef^^ac{\'Z}
7342 \gdef^^ad{\-}
7343 \gdef^^ae{\v Z}
7344 \gdef^^af{\dotaccent Z}
7346 \gdef^^b0{\textdegree}
7347 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7348 \gdef^^b2{\missingcharmsg{OGONEK}}
7349 \gdef^^b3{\l}
7350 \gdef^^b4{\'{}}
7351 \gdef^^b5{\v l}
7352 \gdef^^b6{\'s}
7353 \gdef^^b7{\v{}}
7354 \gdef^^b8{\cedilla\ }
7355 \gdef^^b9{\v s}
7356 \gdef^^ba{\cedilla s}
7357 \gdef^^bb{\v t}
7358 \gdef^^bc{\'z}
7359 \gdef^^bd{\H{}}
7360 \gdef^^be{\v z}
7361 \gdef^^bf{\dotaccent z}
7363 \gdef^^c0{\'R}
7364 \gdef^^c1{\'A}
7365 \gdef^^c2{\^A}
7366 \gdef^^c3{\u A}
7367 \gdef^^c4{\"A}
7368 \gdef^^c5{\'L}
7369 \gdef^^c6{\'C}
7370 \gdef^^c7{\cedilla C}
7371 \gdef^^c8{\v C}
7372 \gdef^^c9{\'E}
7373 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
7374 \gdef^^cb{\"E}
7375 \gdef^^cc{\v E}
7376 \gdef^^cd{\'I}
7377 \gdef^^ce{\^I}
7378 \gdef^^cf{\v D}
7380 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
7381 \gdef^^d1{\'N}
7382 \gdef^^d2{\v N}
7383 \gdef^^d3{\'O}
7384 \gdef^^d4{\^O}
7385 \gdef^^d5{\H O}
7386 \gdef^^d6{\"O}
7387 \gdef^^d7{$\times$}
7388 \gdef^^d8{\v R}
7389 \gdef^^d9{\ringaccent U}
7390 \gdef^^da{\'U}
7391 \gdef^^db{\H U}
7392 \gdef^^dc{\"U}
7393 \gdef^^dd{\'Y}
7394 \gdef^^de{\cedilla T}
7395 \gdef^^df{\ss}
7397 \gdef^^e0{\'r}
7398 \gdef^^e1{\'a}
7399 \gdef^^e2{\^a}
7400 \gdef^^e3{\u a}
7401 \gdef^^e4{\"a}
7402 \gdef^^e5{\'l}
7403 \gdef^^e6{\'c}
7404 \gdef^^e7{\cedilla c}
7405 \gdef^^e8{\v c}
7406 \gdef^^e9{\'e}
7407 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
7408 \gdef^^eb{\"e}
7409 \gdef^^ec{\v e}
7410 \gdef^^ed{\'\i}
7411 \gdef^^ee{\^\i}
7412 \gdef^^ef{\v d}
7414 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
7415 \gdef^^f1{\'n}
7416 \gdef^^f2{\v n}
7417 \gdef^^f3{\'o}
7418 \gdef^^f4{\^o}
7419 \gdef^^f5{\H o}
7420 \gdef^^f6{\"o}
7421 \gdef^^f7{$\div$}
7422 \gdef^^f8{\v r}
7423 \gdef^^f9{\ringaccent u}
7424 \gdef^^fa{\'u}
7425 \gdef^^fb{\H u}
7426 \gdef^^fc{\"u}
7427 \gdef^^fd{\'y}
7428 \gdef^^fe{\cedilla t}
7429 \gdef^^ff{\dotaccent{}}
7432 % US-ASCII character definitions.
7433 \def\asciichardefs{% nothing need be done
7434 \relax
7437 % Make non-ASCII characters printable again for compatibility with
7438 % existing Texinfo documents that may use them, even without declaring a
7439 % document encoding.
7441 \setnonasciicharscatcode \other
7443 % Page size parameters.
7445 \newdimen\defaultparindent \defaultparindent = 15pt
7447 \chapheadingskip = 15pt plus 4pt minus 2pt
7448 \secheadingskip = 12pt plus 3pt minus 2pt
7449 \subsecheadingskip = 9pt plus 2pt minus 2pt
7451 % Prevent underfull vbox error messages.
7452 \vbadness = 10000
7454 % Don't be so finicky about underfull hboxes, either.
7455 \hbadness = 2000
7457 % Following George Bush, just get rid of widows and orphans.
7458 \widowpenalty=10000
7459 \clubpenalty=10000
7461 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7462 % using an old version of TeX, don't do anything. We want the amount of
7463 % stretch added to depend on the line length, hence the dependence on
7464 % \hsize. We call this whenever the paper size is set.
7466 \def\setemergencystretch{%
7467 \ifx\emergencystretch\thisisundefined
7468 % Allow us to assign to \emergencystretch anyway.
7469 \def\emergencystretch{\dimen0}%
7470 \else
7471 \emergencystretch = .15\hsize
7475 % Parameters in order: 1) textheight; 2) textwidth;
7476 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
7477 % 7) physical page height; 8) physical page width.
7479 % We also call \setleading{\textleading}, so the caller should define
7480 % \textleading. The caller should also set \parskip.
7482 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
7483 \voffset = #3\relax
7484 \topskip = #6\relax
7485 \splittopskip = \topskip
7487 \vsize = #1\relax
7488 \advance\vsize by \topskip
7489 \outervsize = \vsize
7490 \advance\outervsize by 2\topandbottommargin
7491 \pageheight = \vsize
7493 \hsize = #2\relax
7494 \outerhsize = \hsize
7495 \advance\outerhsize by 0.5in
7496 \pagewidth = \hsize
7498 \normaloffset = #4\relax
7499 \bindingoffset = #5\relax
7501 \ifpdf
7502 \pdfpageheight #7\relax
7503 \pdfpagewidth #8\relax
7506 \setleading{\textleading}
7508 \parindent = \defaultparindent
7509 \setemergencystretch
7512 % @letterpaper (the default).
7513 \def\letterpaper{{\globaldefs = 1
7514 \parskip = 3pt plus 2pt minus 1pt
7515 \textleading = 13.2pt
7517 % If page is nothing but text, make it come out even.
7518 \internalpagesizes{46\baselineskip}{6in}%
7519 {\voffset}{.25in}%
7520 {\bindingoffset}{36pt}%
7521 {11in}{8.5in}%
7524 % Use @smallbook to reset parameters for 7x9.25 trim size.
7525 \def\smallbook{{\globaldefs = 1
7526 \parskip = 2pt plus 1pt
7527 \textleading = 12pt
7529 \internalpagesizes{7.5in}{5in}%
7530 {\voffset}{.25in}%
7531 {\bindingoffset}{16pt}%
7532 {9.25in}{7in}%
7534 \lispnarrowing = 0.3in
7535 \tolerance = 700
7536 \hfuzz = 1pt
7537 \contentsrightmargin = 0pt
7538 \defbodyindent = .5cm
7541 % Use @smallerbook to reset parameters for 6x9 trim size.
7542 % (Just testing, parameters still in flux.)
7543 \def\smallerbook{{\globaldefs = 1
7544 \parskip = 1.5pt plus 1pt
7545 \textleading = 12pt
7547 \internalpagesizes{7.4in}{4.8in}%
7548 {-.2in}{-.4in}%
7549 {0pt}{14pt}%
7550 {9in}{6in}%
7552 \lispnarrowing = 0.25in
7553 \tolerance = 700
7554 \hfuzz = 1pt
7555 \contentsrightmargin = 0pt
7556 \defbodyindent = .4cm
7559 % Use @afourpaper to print on European A4 paper.
7560 \def\afourpaper{{\globaldefs = 1
7561 \parskip = 3pt plus 2pt minus 1pt
7562 \textleading = 13.2pt
7564 % Double-side printing via postscript on Laserjet 4050
7565 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
7566 % To change the settings for a different printer or situation, adjust
7567 % \normaloffset until the front-side and back-side texts align. Then
7568 % do the same for \bindingoffset. You can set these for testing in
7569 % your texinfo source file like this:
7570 % @tex
7571 % \global\normaloffset = -6mm
7572 % \global\bindingoffset = 10mm
7573 % @end tex
7574 \internalpagesizes{51\baselineskip}{160mm}
7575 {\voffset}{\hoffset}%
7576 {\bindingoffset}{44pt}%
7577 {297mm}{210mm}%
7579 \tolerance = 700
7580 \hfuzz = 1pt
7581 \contentsrightmargin = 0pt
7582 \defbodyindent = 5mm
7585 % Use @afivepaper to print on European A5 paper.
7586 % From romildo@urano.iceb.ufop.br, 2 July 2000.
7587 % He also recommends making @example and @lisp be small.
7588 \def\afivepaper{{\globaldefs = 1
7589 \parskip = 2pt plus 1pt minus 0.1pt
7590 \textleading = 12.5pt
7592 \internalpagesizes{160mm}{120mm}%
7593 {\voffset}{\hoffset}%
7594 {\bindingoffset}{8pt}%
7595 {210mm}{148mm}%
7597 \lispnarrowing = 0.2in
7598 \tolerance = 800
7599 \hfuzz = 1.2pt
7600 \contentsrightmargin = 0pt
7601 \defbodyindent = 2mm
7602 \tableindent = 12mm
7605 % A specific text layout, 24x15cm overall, intended for A4 paper.
7606 \def\afourlatex{{\globaldefs = 1
7607 \afourpaper
7608 \internalpagesizes{237mm}{150mm}%
7609 {\voffset}{4.6mm}%
7610 {\bindingoffset}{7mm}%
7611 {297mm}{210mm}%
7613 % Must explicitly reset to 0 because we call \afourpaper.
7614 \globaldefs = 0
7617 % Use @afourwide to print on A4 paper in landscape format.
7618 \def\afourwide{{\globaldefs = 1
7619 \afourpaper
7620 \internalpagesizes{241mm}{165mm}%
7621 {\voffset}{-2.95mm}%
7622 {\bindingoffset}{7mm}%
7623 {297mm}{210mm}%
7624 \globaldefs = 0
7627 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
7628 % Perhaps we should allow setting the margins, \topskip, \parskip,
7629 % and/or leading, also. Or perhaps we should compute them somehow.
7631 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
7632 \def\pagesizesyyy#1,#2,#3\finish{{%
7633 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
7634 \globaldefs = 1
7636 \parskip = 3pt plus 2pt minus 1pt
7637 \setleading{\textleading}%
7639 \dimen0 = #1
7640 \advance\dimen0 by \voffset
7642 \dimen2 = \hsize
7643 \advance\dimen2 by \normaloffset
7645 \internalpagesizes{#1}{\hsize}%
7646 {\voffset}{\normaloffset}%
7647 {\bindingoffset}{44pt}%
7648 {\dimen0}{\dimen2}%
7651 % Set default to letter.
7653 \letterpaper
7656 \message{and turning on texinfo input format.}
7658 % Define macros to output various characters with catcode for normal text.
7659 \catcode`\"=\other
7660 \catcode`\~=\other
7661 \catcode`\^=\other
7662 \catcode`\_=\other
7663 \catcode`\|=\other
7664 \catcode`\<=\other
7665 \catcode`\>=\other
7666 \catcode`\+=\other
7667 \catcode`\$=\other
7668 \def\normaldoublequote{"}
7669 \def\normaltilde{~}
7670 \def\normalcaret{^}
7671 \def\normalunderscore{_}
7672 \def\normalverticalbar{|}
7673 \def\normalless{<}
7674 \def\normalgreater{>}
7675 \def\normalplus{+}
7676 \def\normaldollar{$}%$ font-lock fix
7678 % This macro is used to make a character print one way in \tt
7679 % (where it can probably be output as-is), and another way in other fonts,
7680 % where something hairier probably needs to be done.
7682 % #1 is what to print if we are indeed using \tt; #2 is what to print
7683 % otherwise. Since all the Computer Modern typewriter fonts have zero
7684 % interword stretch (and shrink), and it is reasonable to expect all
7685 % typewriter fonts to have this, we can check that font parameter.
7687 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
7689 % Same as above, but check for italic font. Actually this also catches
7690 % non-italic slanted fonts since it is impossible to distinguish them from
7691 % italic fonts. But since this is only used by $ and it uses \sl anyway
7692 % this is not a problem.
7693 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
7695 % Turn off all special characters except @
7696 % (and those which the user can use as if they were ordinary).
7697 % Most of these we simply print from the \tt font, but for some, we can
7698 % use math or other variants that look better in normal text.
7700 \catcode`\"=\active
7701 \def\activedoublequote{{\tt\char34}}
7702 \let"=\activedoublequote
7703 \catcode`\~=\active
7704 \def~{{\tt\char126}}
7705 \chardef\hat=`\^
7706 \catcode`\^=\active
7707 \def^{{\tt \hat}}
7709 \catcode`\_=\active
7710 \def_{\ifusingtt\normalunderscore\_}
7711 \let\realunder=_
7712 % Subroutine for the previous macro.
7713 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
7715 \catcode`\|=\active
7716 \def|{{\tt\char124}}
7717 \chardef \less=`\<
7718 \catcode`\<=\active
7719 \def<{{\tt \less}}
7720 \chardef \gtr=`\>
7721 \catcode`\>=\active
7722 \def>{{\tt \gtr}}
7723 \catcode`\+=\active
7724 \def+{{\tt \char 43}}
7725 \catcode`\$=\active
7726 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
7728 % If a .fmt file is being used, characters that might appear in a file
7729 % name cannot be active until we have parsed the command line.
7730 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
7731 % \otherifyactive is called near the end of this file.
7732 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
7734 % Used sometimes to turn off (effectively) the active characters even after
7735 % parsing them.
7736 \def\turnoffactive{%
7737 \normalturnoffactive
7738 \otherbackslash
7741 \catcode`\@=0
7743 % \backslashcurfont outputs one backslash character in current font,
7744 % as in \char`\\.
7745 \global\chardef\backslashcurfont=`\\
7746 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
7748 % \realbackslash is an actual character `\' with catcode other, and
7749 % \doublebackslash is two of them (for the pdf outlines).
7750 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
7752 % In texinfo, backslash is an active character; it prints the backslash
7753 % in fixed width font.
7754 \catcode`\\=\active
7755 @def@normalbackslash{{@tt@backslashcurfont}}
7756 % On startup, @fixbackslash assigns:
7757 % @let \ = @normalbackslash
7759 % \rawbackslash defines an active \ to do \backslashcurfont.
7760 % \otherbackslash defines an active \ to be a literal `\' character with
7761 % catcode other.
7762 @gdef@rawbackslash{@let\=@backslashcurfont}
7763 @gdef@otherbackslash{@let\=@realbackslash}
7765 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
7766 % the literal character `\'.
7768 @def@normalturnoffactive{%
7769 @let\=@normalbackslash
7770 @let"=@normaldoublequote
7771 @let~=@normaltilde
7772 @let^=@normalcaret
7773 @let_=@normalunderscore
7774 @let|=@normalverticalbar
7775 @let<=@normalless
7776 @let>=@normalgreater
7777 @let+=@normalplus
7778 @let$=@normaldollar %$ font-lock fix
7779 @unsepspaces
7782 % Make _ and + \other characters, temporarily.
7783 % This is canceled by @fixbackslash.
7784 @otherifyactive
7786 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
7787 % That is what \eatinput is for; after that, the `\' should revert to printing
7788 % a backslash.
7790 @gdef@eatinput input texinfo{@fixbackslash}
7791 @global@let\ = @eatinput
7793 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
7794 % the first `\' in the file would cause an error. This macro tries to fix
7795 % that, assuming it is called before the first `\' could plausibly occur.
7796 % Also turn back on active characters that might appear in the input
7797 % file name, in case not using a pre-dumped format.
7799 @gdef@fixbackslash{%
7800 @ifx\@eatinput @let\ = @normalbackslash @fi
7801 @catcode`+=@active
7802 @catcode`@_=@active
7805 % Say @foo, not \foo, in error messages.
7806 @escapechar = `@@
7808 % These look ok in all fonts, so just make them not special.
7809 @catcode`@& = @other
7810 @catcode`@# = @other
7811 @catcode`@% = @other
7814 @c Local variables:
7815 @c eval: (add-hook 'write-file-hooks 'time-stamp)
7816 @c page-delimiter: "^\\\\message"
7817 @c time-stamp-start: "def\\\\texinfoversion{"
7818 @c time-stamp-format: "%:y-%02m-%02d.%02H"
7819 @c time-stamp-end: "}"
7820 @c End:
7822 @c vim:sw=2:
7824 @ignore
7825 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
7826 @end ignore